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