man-pages/man3/memcpy.3.html
2021-03-31 01:06:50 +01:00

165 lines
4.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of MEMCPY</TITLE>
</HEAD><BODY>
<H1>MEMCPY</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
memcpy - copy memory area
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/string.h">string.h</A>&gt;</B>
<B>void *memcpy(void *</B><I>dest</I><B>, const void *</B><I>src</I><B>, size_t </B><I>n</I><B>);</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>memcpy</B>()
function copies <I>n</I> bytes from memory area
<I>src</I> to memory area <I>dest</I>.
The memory areas must not overlap.
Use
<B><A HREF="/cgi-bin/man/man2html?3+memmove">memmove</A></B>(3)
if the memory areas do overlap.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
The
<B>memcpy</B>()
function returns a pointer to <I>dest</I>.
<A NAME="lbAF">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>memcpy</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAG">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
<A NAME="lbAH">&nbsp;</A>
<H2>NOTES</H2>
Failure to observe the requirement that the memory areas
do not overlap has been the source of significant bugs.
(POSIX and the C standards are explicit that employing
<B>memcpy</B>()
with overlapping areas produces undefined behavior.)
Most notably, in glibc 2.13
a performance optimization of
<B>memcpy</B>()
on some platforms (including x86-64) included changing the order
in which bytes were copied from
<I>src</I>
to
<I>dest</I>.
<P>
This change revealed breakages in a number of applications that performed
copying with overlapping areas.
Under the previous implementation,
the order in which the bytes were copied had fortuitously hidden the bug,
which was revealed when the copying order was reversed.
In glibc 2.14,
a versioned symbol was added so that old binaries
(i.e., those linked against glibc versions earlier than 2.14)
employed a
<B>memcpy</B>()
implementation that safely handles the overlapping buffers case
(by providing an &quot;older&quot;
<B>memcpy</B>()
implementation that was aliased to
<B><A HREF="/cgi-bin/man/man2html?3+memmove">memmove</A></B>(3)).
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+bcopy">bcopy</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+bstring">bstring</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+memccpy">memccpy</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+memmove">memmove</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+mempcpy">mempcpy</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strcpy">strcpy</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strncpy">strncpy</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+wmemcpy">wmemcpy</A></B>(3)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
<DT id="7"><A HREF="#lbAH">NOTES</A><DD>
<DT id="8"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="9"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:48 GMT, March 31, 2021
</BODY>
</HTML>