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