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