xref: /xnu-10002.41.9/osfmk/man/DP_backing_store_create.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>default_pager_backing_store_create</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Server Interface</strong> - Create a backing storage object.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>#include&lt mach/default_pager_object.h&gt</strong>
8*699cd480SApple OSS Distributions
9*699cd480SApple OSS Distributions<strong>kern_return_t   default_pager_backing_store_create</strong>
10*699cd480SApple OSS Distributions                <strong>(mach_port_t</strong>                              <var>pager</var>,
11*699cd480SApple OSS Distributions                 <strong>int</strong>                                   <var>priority</var>,
12*699cd480SApple OSS Distributions                 <strong>int</strong>                                     <var>clsize</var>,
13*699cd480SApple OSS Distributions                 <strong>mach_port_t</strong>                      <var>backing_store</var><strong>);</strong>
14*699cd480SApple OSS Distributions</pre>
15*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
16*699cd480SApple OSS Distributions<dl>
17*699cd480SApple OSS Distributions<p>
18*699cd480SApple OSS Distributions<dt> <var>pager</var>
19*699cd480SApple OSS Distributions<dd>
20*699cd480SApple OSS Distributions[in default pager (receive) right] The default pager service port.
21*699cd480SApple OSS Distributions<p>
22*699cd480SApple OSS Distributions<dt> <var>priority</var>
23*699cd480SApple OSS Distributions<dd>
24*699cd480SApple OSS Distributions[in scalar] The scheduling priority for the backing store service
25*699cd480SApple OSS Distributionsthread(s).
26*699cd480SApple OSS Distributions<p>
27*699cd480SApple OSS Distributions<dt> <var>clsize</var>
28*699cd480SApple OSS Distributions<dd>
29*699cd480SApple OSS Distributions[in scalar] The preferred cluster size (in bytes) for the backing
30*699cd480SApple OSS Distributionsstore object.
31*699cd480SApple OSS Distributions<p>
32*699cd480SApple OSS Distributions<dt> <var>backing_store</var>
33*699cd480SApple OSS Distributions<dd>
34*699cd480SApple OSS Distributions[out backing store (receive) right] The port used to manipulate the
35*699cd480SApple OSS Distributionscreated backing store.
36*699cd480SApple OSS Distributions</dl>
37*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
38*699cd480SApple OSS Distributions<p>
39*699cd480SApple OSS DistributionsThe <strong>default_pager_backing_store_create</strong> function is called to create a
40*699cd480SApple OSS Distributionsnew backing storage object. The kernel does not make this call itself
41*699cd480SApple OSS Distributions(which is why it can be a synchronous call); this request is only
42*699cd480SApple OSS Distributionsissued by tasks (privileged) holding the default pager service port.
43*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
44*699cd480SApple OSS Distributions<dl>
45*699cd480SApple OSS Distributions<p>
46*699cd480SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
47*699cd480SApple OSS Distributions<dd>
48*699cd480SApple OSS DistributionsThe default pager does not support this operation.
49*699cd480SApple OSS Distributions<p>
50*699cd480SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong>
51*699cd480SApple OSS Distributions<dd>
52*699cd480SApple OSS DistributionsThe pager port does not represent a valid default pager.
53*699cd480SApple OSS Distributions<p>
54*699cd480SApple OSS Distributions<dt> <strong>KERN_SUCCESS</strong>
55*699cd480SApple OSS Distributions<dd>
56*699cd480SApple OSS DistributionsThe operation was successful.
57*699cd480SApple OSS Distributions</dl>
58*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
59*699cd480SApple OSS Distributions<p>
60*699cd480SApple OSS DistributionsFunctions:
61*699cd480SApple OSS Distributions<a href="DP_backing_store_delete.html"><strong>default_pager_backing_store_delete</strong></a>,
62*699cd480SApple OSS Distributions<a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>.
63