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