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