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