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