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