osfmk/man/MO_data_initialize.html

   1 <h2>memory_object_data_initialize</h2>
   2 <hr>
   3 <p>
   4 <strong>Server Interface</strong> - Request that the default pager record initialization information for specified memory object.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   memory_object_data_initialize</strong>
   8                 <strong>(memory_object_t</strong>                  <var>memory_object</var>,
   9                  <strong>memory_object_control_t</strong>         <var>memory_control</var>,
  10                  <strong>vm_offset_t</strong>                             <var>offset</var>,
  11                  <strong>pointer_t</strong>                                 <var>data</var><strong>);</strong>
  12
  13
  14 <strong>kern_return_t   seqnos_memory_object_data_initialize</strong>
  15                 <strong>(memory_object_t</strong>                  <var>memory_object</var>,
  16                  <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,
  17                  <strong>memory_object_control_t</strong>         <var>memory_control</var>,
  18                  <strong>vm_offset_t</strong>                             <var>offset</var>,
  19                  <strong>pointer_t</strong>                                 <var>data</var><strong>);</strong>
  20 </pre>
  21 <h3>PARAMETERS</h3>
  22 <dl>
  23 <p>
  24 <dt> <var>memory_object</var>
  25 <dd>
  26 [in abstract-memory-object (receive) right]
  27 The abstract memory
  28 object port that represents the memory object data, as supplied by the
  29 kernel in a <strong>memory_object_create</strong> call.
  30 <p>
  31 <dt> <var>seqno</var>
  32 <dd>
  33 [in scalar]
  34 The sequence number of this message relative to the abstract
  35 memory object port.
  36 <p>
  37 <dt> <var>memory_control</var>
  38 <dd>
  39 [in memory-cache-control send right]
  40 The memory cache control port
  41 to be used for a response by the memory manager.  If the memory
  42 object has been supplied to more than one kernel, this parameter
  43 identifies the kernel that is making the call.
  44 <p>
  45 <dt> <var>offset</var>
  46 <dd>
  47 [in scalar]
  48 The offset within the memory object.
  49 <p>
  50 <dt> <var>data</var>
  51 <dd>
  52 [in pointer to dynamic array of bytes]
  53 The data that has been modified
  54 while cached in physical memory.
  55 </dl>
  56 <h3>DESCRIPTION</h3>
  57 <p>
  58 A <strong>memory_object_data_initialize</strong> function is called
  59 as the result of a kernel
  60 message providing the default memory manager with initial data for a
  61 kernel-created memory object.  If the memory manager already
  62 has supplied data (by a previous <strong>memory_object_data_initialize</strong> or
  63 <strong>memory_object_data_return</strong>), it
  64 should ignore this call.  Otherwise, the call behaves the same as the
  65 <strong>memory_object_data_return</strong> call.
  66 <p>
  67 The kernel makes this call only to the default memory manager and only on
  68 temporary memory objects that it has created with
  69 <strong>memory_object_create</strong>.
  70 <h3>RETURN VALUES</h3>
  71 <p>
  72 Only generic errors apply.
  73 <h3>RELATED INFORMATION</h3>
  74 <p>
  75 Functions:
  76 <a href="memory_object_create.html"><strong>memory_object_create</strong></a>,
  77 <a href="memory_object_data_return.html"><strong>memory_object_data_return</strong></a>,
  78 <a href="MO_default_server.html"><strong>memory_object_default_server</strong></a>,
  79 <a href="SMO_default_server.html"><strong>seqnos_memory_object_default_server</strong></a>.