xref: /xnu-11215.61.5/osfmk/man/DP_object_create.html (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions<h2>default_pager_object_create</h2>
2*4f1223e8SApple OSS Distributions<hr>
3*4f1223e8SApple OSS Distributions<p>
4*4f1223e8SApple OSS Distributions<strong>Server Interface</strong> - Initialize a non-persistent memory object suitable for sharing between tasks.
5*4f1223e8SApple OSS Distributions<h3>SYNOPSIS</h3>
6*4f1223e8SApple OSS Distributions<pre>
7*4f1223e8SApple OSS Distributions<strong>kern_return_t   default_pager_object_create</strong>
8*4f1223e8SApple OSS Distributions                <strong>(mach_port_t</strong>                              <var>pager</var>,
9*4f1223e8SApple OSS Distributions                 <strong>memory_object_t</strong>                 <var>*memory_object</var>,
10*4f1223e8SApple OSS Distributions                 <strong>vm_size_t</strong>                          <var>object_size</var><strong>);</strong>
11*4f1223e8SApple OSS Distributions
12*4f1223e8SApple OSS Distributions
13*4f1223e8SApple OSS Distributions<strong>kern_return_t   seqnos_default_pager_object_create</strong>
14*4f1223e8SApple OSS Distributions                <strong>(mach_port_t</strong>                              <var>pager</var>,
15*4f1223e8SApple OSS Distributions                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,
16*4f1223e8SApple OSS Distributions                 <strong>memory_object_t</strong>                 <var>*memory_object</var>,
17*4f1223e8SApple OSS Distributions                 <strong>vm_size_t</strong>                          <var>object_size</var><strong>);</strong>
18*4f1223e8SApple OSS Distributions</pre>
19*4f1223e8SApple OSS Distributions<h3>PARAMETERS</h3>
20*4f1223e8SApple OSS Distributions<dl>
21*4f1223e8SApple OSS Distributions<p>
22*4f1223e8SApple OSS Distributions<dt> <var>pager</var>
23*4f1223e8SApple OSS Distributions<dd>
24*4f1223e8SApple OSS Distributions[in default-pager (receive) right]
25*4f1223e8SApple OSS DistributionsThe default memory manager service
26*4f1223e8SApple OSS Distributionsport.
27*4f1223e8SApple OSS Distributions<p>
28*4f1223e8SApple OSS Distributions<dt> <var>seqno</var>
29*4f1223e8SApple OSS Distributions<dd>
30*4f1223e8SApple OSS Distributions[in scalar]
31*4f1223e8SApple OSS DistributionsThe sequence number of this message relative to the <var>pager</var>
32*4f1223e8SApple OSS Distributionsport.
33*4f1223e8SApple OSS Distributions<p>
34*4f1223e8SApple OSS Distributions<dt> <var>memory_object</var>
35*4f1223e8SApple OSS Distributions<dd>
36*4f1223e8SApple OSS Distributions[out memory-object send right]
37*4f1223e8SApple OSS DistributionsA memory object port (with full access) for the memory object.
38*4f1223e8SApple OSS Distributions<p>
39*4f1223e8SApple OSS Distributions<dt> <var>object_size</var>
40*4f1223e8SApple OSS Distributions<dd>
41*4f1223e8SApple OSS Distributions[in scalar]
42*4f1223e8SApple OSS DistributionsThe maximum size for the memory object.
43*4f1223e8SApple OSS Distributions</dl>
44*4f1223e8SApple OSS Distributions<h3>DESCRIPTION</h3>
45*4f1223e8SApple OSS Distributions<p>
46*4f1223e8SApple OSS DistributionsA <strong>default_pager_object_create</strong> function is called as
47*4f1223e8SApple OSS Distributionsthe result of a message
48*4f1223e8SApple OSS Distributionsrequesting that the default memory manager create and return a (shared) memory
49*4f1223e8SApple OSS Distributionsobject which is suitable for use with <strong>vm_map</strong>.  This memory object has
50*4f1223e8SApple OSS Distributionsthe same properties as does a memory object provided by
51*4f1223e8SApple OSS Distributions<strong>vm_allocate</strong>: its initial
52*4f1223e8SApple OSS Distributionscontents are zero and the backing contents are temporary in that they do not
53*4f1223e8SApple OSS Distributionspersist after the memory object is destroyed.  The memory object
54*4f1223e8SApple OSS Distributionsis suitable for use
55*4f1223e8SApple OSS Distributionsas non-permanent shared memory.  The kernel does not make this call itself
56*4f1223e8SApple OSS Distributions(which is why it can be a synchronous call); this request is only issued by
57*4f1223e8SApple OSS Distributions(privileged) tasks holding the default memory manager port.
58*4f1223e8SApple OSS DistributionsThis call should be
59*4f1223e8SApple OSS Distributionscontrasted with the kernel's <strong>memory_object_create</strong> message, in which
60*4f1223e8SApple OSS Distributionsthe memory cache object is already created and the identity of the abstract
61*4f1223e8SApple OSS Distributionsmemory object is made known to the default manager.
62*4f1223e8SApple OSS Distributions<h3>RETURN VALUES</h3>
63*4f1223e8SApple OSS Distributions<p>
64*4f1223e8SApple OSS DistributionsOnly generic errors apply.
65*4f1223e8SApple OSS Distributions<h3>RELATED INFORMATION</h3>
66*4f1223e8SApple OSS Distributions<p>
67*4f1223e8SApple OSS DistributionsFunctions:
68*4f1223e8SApple OSS Distributions<a href="vm_map.html"><strong>vm_map</strong></a>,
69*4f1223e8SApple OSS Distributions<a href="HD_memory_manager.html"><strong>host_default_memory_manager</strong></a>,
70*4f1223e8SApple OSS Distributions<a href="memory_object_create.html"><strong>memory_object_create</strong></a>,
71*4f1223e8SApple OSS Distributions<a href="MO_default_server.html"><strong>memory_object_default_server</strong></a>,
72*4f1223e8SApple OSS Distributions<a href="SMO_default_server.html"><strong>seqnos_memory_object_default_server</strong></a>.
73