xnu-2422.1.72.tar.gz

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

<h2>memory_object_data_initialize</h2>
<hr>
<p>
<strong>Server Interface</strong> - Request that the default pager record initialization information for specified memory object.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   memory_object_data_initialize</strong>
                <strong>(memory_object_t</strong>                  <var>memory_object</var>,
                 <strong>memory_object_control_t</strong>         <var>memory_control</var>,
                 <strong>vm_offset_t</strong>                             <var>offset</var>,
                 <strong>pointer_t</strong>                                 <var>data</var><strong>);</strong>


<strong>kern_return_t   seqnos_memory_object_data_initialize</strong>
                <strong>(memory_object_t</strong>                  <var>memory_object</var>,
                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,
                 <strong>memory_object_control_t</strong>         <var>memory_control</var>,
                 <strong>vm_offset_t</strong>                             <var>offset</var>,
                 <strong>pointer_t</strong>                                 <var>data</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>memory_object</var> 
<dd>
[in abstract-memory-object (receive) right]
The abstract memory
object port that represents the memory object data, as supplied by the
kernel in a <strong>memory_object_create</strong> call.
<p>
<dt> <var>seqno</var> 
<dd>
[in scalar]
The sequence number of this message relative to the abstract 
memory object port.
<p>
<dt> <var>memory_control</var> 
<dd>
[in memory-cache-control send right]
The memory cache control port 
to be used for a response by the memory manager.  If the memory
object has been supplied to more than one kernel, this parameter
identifies the kernel that is making the call.
<p>
<dt> <var>offset</var> 
<dd>
[in scalar]
The offset within the memory object.
<p>
<dt> <var>data</var> 
<dd>
[in pointer to dynamic array of bytes]
The data that has been modified 
while cached in physical memory.
</dl>
<h3>DESCRIPTION</h3>
<p>
A <strong>memory_object_data_initialize</strong> function is called
as the result of a kernel 
message providing the default memory manager with initial data for a
kernel-created memory object.  If the memory manager already
has supplied data (by a previous <strong>memory_object_data_initialize</strong> or 
<strong>memory_object_data_return</strong>), it 
should ignore this call.  Otherwise, the call behaves the same as the
<strong>memory_object_data_return</strong> call.
<p>
The kernel makes this call only to the default memory manager and only on
temporary memory objects that it has created with 
<strong>memory_object_create</strong>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="memory_object_create.html"><strong>memory_object_create</strong></a>,
<a href="memory_object_data_return.html"><strong>memory_object_data_return</strong></a>,
<a href="MO_default_server.html"><strong>memory_object_default_server</strong></a>,
<a href="SMO_default_server.html"><strong>seqnos_memory_object_default_server</strong></a>.