]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/man/MO_data_initialize.html
xnu-4903.221.2.tar.gz
[apple/xnu.git] / osfmk / man / MO_data_initialize.html
old mode 100755 (executable)
new mode 100644 (file)
index e391ae7..d92bf9c
@@ -1 +1,79 @@
-<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
\ No newline at end of file
+<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>.