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

<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