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

<h2>memory_object_data_initialize</h2>\r<hr>\r<p>\r<strong>Server Interface</strong> - Request that the default pager record initialization information for specified memory object.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   memory_object_data_initialize</strong>\r                <strong>(memory_object_t</strong>                  <var>memory_object</var>,\r                 <strong>memory_object_control_t</strong>         <var>memory_control</var>,\r                 <strong>vm_offset_t</strong>                             <var>offset</var>,\r                 <strong>pointer_t</strong>                                 <var>data</var><strong>);</strong>\r\r\r<strong>kern_return_t   seqnos_memory_object_data_initialize</strong>\r                <strong>(memory_object_t</strong>                  <var>memory_object</var>,\r                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,\r                 <strong>memory_object_control_t</strong>         <var>memory_control</var>,\r                 <strong>vm_offset_t</strong>                             <var>offset</var>,\r                 <strong>pointer_t</strong>                                 <var>data</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>memory_object</var> \r<dd>\r[in abstract-memory-object (receive) right]\rThe abstract memory\robject port that represents the memory object data, as supplied by the\rkernel in a <strong>memory_object_create</strong> call.\r<p>\r<dt> <var>seqno</var> \r<dd>\r[in scalar]\rThe sequence number of this message relative to the abstract \rmemory object port.\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 for a response by the memory manager.  If the memory\robject has been supplied to more than one kernel, this parameter\ridentifies the kernel that is making the call.\r<p>\r<dt> <var>offset</var> \r<dd>\r[in scalar]\rThe offset within the memory object.\r<p>\r<dt> <var>data</var> \r<dd>\r[in pointer to dynamic array of bytes]\rThe data that has been modified \rwhile cached in physical memory.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rA <strong>memory_object_data_initialize</strong> function is called\ras the result of a kernel \rmessage providing the default memory manager with initial data for a\rkernel-created memory object.  If the memory manager already\rhas supplied data (by a previous <strong>memory_object_data_initialize</strong> or \r<strong>memory_object_data_return</strong>), it \rshould ignore this call.  Otherwise, the call behaves the same as the\r<strong>memory_object_data_return</strong> call.\r<p>\rThe kernel makes this call only to the default memory manager and only on\rtemporary memory objects that it has created with \r<strong>memory_object_create</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="memory_object_create.html"><strong>memory_object_create</strong></a>,\r<a href="memory_object_data_return.html"><strong>memory_object_data_return</strong></a>,\r<a href="MO_default_server.html"><strong>memory_object_default_server</strong></a>,\r<a href="SMO_default_server.html"><strong>seqnos_memory_object_default_server</strong></a>.\r