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