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