1*5c2921b0SApple OSS Distributions<h2>default_pager_add_segment</h2> 2*5c2921b0SApple OSS Distributions<hr> 3*5c2921b0SApple OSS Distributions<p> 4*5c2921b0SApple OSS Distributions<strong>Server Interface</strong> - Add additional backing storage for a default pager. 5*5c2921b0SApple OSS Distributions<h3>SYNOPSIS</h3> 6*5c2921b0SApple OSS Distributions<pre> 7*5c2921b0SApple OSS Distributions<strong>#include< mach/default_pager_object.h></strong> 8*5c2921b0SApple OSS Distributions 9*5c2921b0SApple OSS Distributions<strong>kern_return_t default_pager_add_segment</strong> 10*5c2921b0SApple OSS Distributions <strong>(mach_port_t</strong> <var>backing_store</var>, 11*5c2921b0SApple OSS Distributions <strong>mach_port_t</strong> <var>device</var>, 12*5c2921b0SApple OSS Distributions <strong>recnum_t</strong> <var>offset</var>, 13*5c2921b0SApple OSS Distributions <strong>recnum_t</strong> <var>count</var>, 14*5c2921b0SApple OSS Distributions <strong>int</strong> <var>record_size</var><strong>);</strong> 15*5c2921b0SApple OSS Distributions</pre> 16*5c2921b0SApple OSS Distributions<h3>PARAMETERS</h3> 17*5c2921b0SApple OSS Distributions<dl> 18*5c2921b0SApple OSS Distributions<p> 19*5c2921b0SApple OSS Distributions<dt> <var>backing_store</var> 20*5c2921b0SApple OSS Distributions<dd> 21*5c2921b0SApple OSS Distributions[in backing store (receive) right] The backing store port. 22*5c2921b0SApple OSS Distributions<p> 23*5c2921b0SApple OSS Distributions<dt> <var>device</var> 24*5c2921b0SApple OSS Distributions<dd> 25*5c2921b0SApple OSS Distributions[in device port] The port for the device containing the backing storage 26*5c2921b0SApple OSS Distributionspartition. 27*5c2921b0SApple OSS Distributions<p> 28*5c2921b0SApple OSS Distributions<dt> <var>offset</var> 29*5c2921b0SApple OSS Distributions<dd> 30*5c2921b0SApple OSS Distributions[in scalar] The offset, in <var>record_size units</var>, to the beginning of the 31*5c2921b0SApple OSS Distributionsbacking storage on the device. 32*5c2921b0SApple OSS Distributions<p> 33*5c2921b0SApple OSS Distributions<dt> <var>count</var> 34*5c2921b0SApple OSS Distributions<dd> 35*5c2921b0SApple OSS Distributions[in scalar] The number of <var>record_size</var> units 36*5c2921b0SApple OSS Distributionsin the partition/segment. 37*5c2921b0SApple OSS Distributions<p> 38*5c2921b0SApple OSS Distributions<dt> <var>record_size</var> 39*5c2921b0SApple OSS Distributions<dd> 40*5c2921b0SApple OSS Distributions[in scalar] The size, in bytes, of the storage device record. 41*5c2921b0SApple OSS Distributions</dl> 42*5c2921b0SApple OSS Distributions<h3>DESCRIPTION</h3> 43*5c2921b0SApple OSS Distributions<p> 44*5c2921b0SApple OSS DistributionsThe <strong>default_pager_add_segment</strong> function is called to add a partition to 45*5c2921b0SApple OSS Distributionsa default pager's backing storage (i.e. expand the amount of backing 46*5c2921b0SApple OSS Distributionsstorage available to a memory manager). The kernel does not make 47*5c2921b0SApple OSS Distributionsthis call itself (which is why it can be a synchronous call); this 48*5c2921b0SApple OSS Distributionsrequest is only issued by tasks holding the backing store port, 49*5c2921b0SApple OSS Distributionscreated with <strong>default_pager_backing_store_create</strong>, for a default memory 50*5c2921b0SApple OSS Distributionsmanager. 51*5c2921b0SApple OSS DistributionsThe result is that the pager may use count records on device starting 52*5c2921b0SApple OSS Distributionsat offset for paging, and each record is record_size bytes in length 53*5c2921b0SApple OSS Distributions(note that the device_* calls are, or can be, record oriented). 54*5c2921b0SApple OSS Distributions<h3>RETURN VALUES</h3> 55*5c2921b0SApple OSS Distributions<dl> 56*5c2921b0SApple OSS Distributions<p> 57*5c2921b0SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong> 58*5c2921b0SApple OSS Distributions<dd> 59*5c2921b0SApple OSS DistributionsThe default pager does not support this operation. 60*5c2921b0SApple OSS Distributions<p> 61*5c2921b0SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong> 62*5c2921b0SApple OSS Distributions<dd> 63*5c2921b0SApple OSS DistributionsThe <var>backing_store</var> port does not represent a valid backing store or the 64*5c2921b0SApple OSS Distributionsspecified segment overlaps an existing partition. 65*5c2921b0SApple OSS Distributions<p> 66*5c2921b0SApple OSS Distributions<dt> <strong>KERN_RESOURCE_SHORTAGE</strong> 67*5c2921b0SApple OSS Distributions<dd> 68*5c2921b0SApple OSS DistributionsThe default pager is unable to allocate internal resources 69*5c2921b0SApple OSS Distributions to manage the new backing storage. 70*5c2921b0SApple OSS Distributions<p> 71*5c2921b0SApple OSS Distributions<dt> <strong>KERN_SUCCESS</strong> 72*5c2921b0SApple OSS Distributions<dd> 73*5c2921b0SApple OSS DistributionsThe operation was successful. 74*5c2921b0SApple OSS Distributions</dl> 75*5c2921b0SApple OSS Distributions<h3>RELATED INFORMATION</h3> 76*5c2921b0SApple OSS Distributions<p> 77*5c2921b0SApple OSS DistributionsFunctions: 78*5c2921b0SApple OSS Distributions<a href="DP_backing_store_create.html"><strong>default_pager_backing_store_create</strong></a>, 79*5c2921b0SApple OSS Distributions<a href="DP_backing_store_delete.html"><strong>default_pager_backing_store_delete</strong></a>, 80*5c2921b0SApple OSS Distributions<a href="DP_backing_store_info.html"><strong>default_pager_backing_store_info</strong></a>. 81