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