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