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