Add support for the llvm.memmove intrinsic.
authorChris Lattner <sabre@nondot.org>
Thu, 12 Feb 2004 18:10:10 +0000 (18:10 +0000)
committerChris Lattner <sabre@nondot.org>
Thu, 12 Feb 2004 18:10:10 +0000 (18:10 +0000)
Patch graciously contributed by Reid Spencer!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@11354 91177308-0d34-0410-b5e6-96231b3b80d8

docs/LangRef.html
include/llvm/Intrinsics.h

index 7b03c45511f059f31ec3046593f81b529d24b6f1..20436ede7e2e6b441198ef3b462a8368d380af20 100644 (file)
@@ -98,6 +98,7 @@
       <li><a href="#int_libc">Standard C Library Intrinsics</a>
         <ol>
           <li><a href="#i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a></li>
+          <li><a href="#i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a></li>
         </ol>
       </li>
       <li><a href="#int_debugger">Debugger intrinsics</a>
@@ -1790,6 +1791,52 @@ be set to 0 or 1.
 </div>
 
 
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
+  <a name="i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
+</div>
+
+<div class="doc_text">
+
+<h5>Syntax:</h5>
+<pre>
+  call void (sbyte*, sbyte*, uint, uint)* %llvm.memmove(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
+                                                       uint &lt;len&gt;, uint &lt;align&gt;)
+</pre>
+
+<h5>Overview:</h5>
+
+<p>
+The '<tt>llvm.memmove</tt>' intrinsic moves a block of memory from the source
+location to the destination location. It is similar to the '<tt>llvm.memcpy</tt>' 
+intrinsic but allows the two memory locations to overlap.
+</p>
+
+<p>
+Note that, unlike the standard libc function, the <tt>llvm.memmove</tt> intrinsic
+does not return a value, and takes an extra alignment argument.
+</p>
+
+<h5>Arguments:</h5>
+
+<p>
+The first argument is a pointer to the destination, the second is a pointer to
+the source.  The third argument is an (arbitrarily sized) integer argument
+specifying the number of bytes to copy, and the fourth argument is the alignment
+of the source and destination locations.
+</p>
+
+<h5>Semantics:</h5>
+
+<p>
+The '<tt>llvm.memmove</tt>' intrinsic copies a block of memory from the source
+location to the destination location, which may overlap.  It
+copies "len" bytes of memory over.  If the argument is known to be aligned to
+some boundary, this can be specified as the fourth argument, otherwise it should
+be set to 0 or 1.
+</p>
+</div>
+
 
 <!-- ======================================================================= -->
 <div class="doc_subsection">
index 098d5d4abd2fde79cb98055c44490b892305586b..125105dd303966651c657d4f6e7b5765eef8888f 100644 (file)
@@ -45,7 +45,9 @@ namespace Intrinsic {
     dbg_declare,      // Declare a local object
 
     // Standard libc functions...
-    memcpy,
+    memcpy,         // Used to copy non-overlapping memory blocks
+    memmove,        // Used to copy overlapping memory blocks
+
 
     // Standard libm functions...