xnu-4903.221.2.tar.gz

[apple/xnu.git] / osfmk / man / MO_SY_completed.html

diff --git a/osfmk/man/MO_SY_completed.html b/osfmk/man/MO_SY_completed.html
old mode 100755 (executable)
new mode 100644 (file)
index da58283..83c8669
--- a/osfmk/man/MO_SY_completed.html
+++ b/osfmk/man/MO_SY_completed.html
@@ -1 +1,50 @@
-<h2>memory_object_synchronize_completed</h2>\r<hr>\r<p>\r<strong>Function</strong> - Inform the kernel that synchronized data has been processed.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   memory_object_synchronize_completed </strong>\r                <strong>(memory_object_control_t</strong>         <var>memory_control</var>,\r                 <strong>vm_offset_t</strong>                             <var>offset</var>,\r                 <strong>vm_offset_t</strong>                             <var>length</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>memory_control</var> \r<dd>\r[in memory-cache-control send right]\rThe memory cache control port \rto be used by the memory manager for cache management requests. \rThis port is provided by the kernel in a <strong>memory_object_init</strong> call.\r<p>\r<dt> <var>offset</var> \r<dd>\r[in scalar]\rThe offset within the memory object, in bytes.\r<p>\r<dt> <var>length</var> \r<dd>\r[in scalar]\rThe amount of data processed.  The number must be an\rintegral number of memory object pages.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>memory_object_synchronize_completed</strong> function informs the kernel \rthat previously synchronized data (<strong>memory_object_synchronize</strong>) \rhas been queued or placed on backing storage.  This reply causes the issuing\rclient to return from its <strong>vm_msync</strong> call.  The offset and length\rmust match that of the corresponding <strong>memory_object_synchronize</strong> \rcall.  There may be multiple synchronize requests \rfor a given memory object outstanding but they will not overlap.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="memory_object_data_return.html"><strong>memory_object_data_return</strong></a>,\r<a href="memory_object_synchronize.html"><strong>memory_object_synchronize</strong></a>,\r<a href="vm_msync.html"><strong>vm_msync</strong></a>.\r
\ No newline at end of file
+<h2>memory_object_synchronize_completed</h2>
+<hr>
+<p>
+<strong>Function</strong> - Inform the kernel that synchronized data has been processed.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   memory_object_synchronize_completed </strong>
+                <strong>(memory_object_control_t</strong>         <var>memory_control</var>,
+                 <strong>vm_offset_t</strong>                             <var>offset</var>,
+                 <strong>vm_offset_t</strong>                             <var>length</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>memory_control</var> 
+<dd>
+[in memory-cache-control send right]
+The memory cache control port 
+to be used by the memory manager for cache management requests. 
+This port is provided by the kernel in a <strong>memory_object_init</strong> call.
+<p>
+<dt> <var>offset</var> 
+<dd>
+[in scalar]
+The offset within the memory object, in bytes.
+<p>
+<dt> <var>length</var> 
+<dd>
+[in scalar]
+The amount of data processed.  The number must be an
+integral number of memory object pages.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>memory_object_synchronize_completed</strong> function informs the kernel 
+that previously synchronized data (<strong>memory_object_synchronize</strong>) 
+has been queued or placed on backing storage.  This reply causes the issuing
+client to return from its <strong>vm_msync</strong> call.  The offset and length
+must match that of the corresponding <strong>memory_object_synchronize</strong> 
+call.  There may be multiple synchronize requests 
+for a given memory object outstanding but they will not overlap.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="memory_object_data_return.html"><strong>memory_object_data_return</strong></a>,
+<a href="memory_object_synchronize.html"><strong>memory_object_synchronize</strong></a>,
+<a href="vm_msync.html"><strong>vm_msync</strong></a>.