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