Back to Darwin Xnu

DP Backing Store Info

osfmk/man/DP_backing_store_info.html

latest2.0 KB
Original Source

default_pager_backing_store_info


Server Interface - Return information about a backing storage object.

SYNOPSIS

**#include&lt default\_pager/mach/default\_pager\_types.h&gt**** kern\_return\_t default\_pager\_backing\_store\_info****(mach\_port\_t**backing\_store, **backing\_store\_flavor\_t** flavor, **backing\_store\_info\_t** info, **mach\_msg\_type\_number\_t** size**);**

PARAMETERS

backing_store[in backing store (receive) right] The backing store port for which information is desired.

flavor[in scalar] The type of information to be returned. Valid values are:

BACKING_STORE_BASIC_INFOStatistical and space used/available information. It includes the priority and cluster size that was provided in the default_pager_backing_store_create call.

info[pointer to in structure] The data structure that will be filled in with the information provided for the requested flavor.

size[pointer to in/out scalar] On input, the maximum size of the info data structure; on output, the actual size of the returned data.

DESCRIPTION

The default_pager_backing_store_info function is called to obtain information about a backing storage object created by default_pager_backing_store_create. The kernel does not make this call itself (which is why it can be a synchronous call); this request is only issued by tasks holding the backing store port, created with default_pager_backing_store_create , for a default memory manager.

RETURN VALUES

KERN_FAILURE The default pager does not support this operation.

KERN_INVALID_ARGUMENT The backing_store port does not represent a valid backing store, flavor is not valid, or size is not the size for the requested flavor.

KERN_SUCCESS The operation was successful.

Functions: default_pager_backing_store_create, default_pager_backing_store_delete.

Data Structures: backing_store_basic_info.