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