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