default_pager_backing_store_info

Server Interface - Return information about a backing storage object.

SYNOPSIS

#include< default_pager/mach/default_pager_types.h>

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_INFO

Statistical 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.

RELATED INFORMATION

Functions: default_pager_backing_store_create, default_pager_backing_store_delete.

Data Structures: backing_store_basic_info.