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