rvm.h File Reference

#include <sys/time.h>
#include <sys/param.h>

Include dependency graph for rvm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	rvm_offset_t
struct	rvm_tid_t
struct	rvm_options_t
struct	rvm_region_t

Macros
#define	RVM_VERSION   "RVM Interface Version 1.3 7 Mar 1994"
#define	RVM_VERSION_MAX   128 /* 128 char maximum version str length */
#define	TRUE   1
#define	FALSE   0
#define	RVM_SUCCESS   0 /* success return code */
#define	rvm_first_code   199 /* internal use only */
#define	RVM_EINIT   200 /* RVM not initialized */
#define	RVM_EINTERNAL   201 /* internal error, see rvm_errmsg */
#define	RVM_EIO   202 /* I/O error, see errno */
#define	RVM_ELOG   204 /* invalid log device */
#define	RVM_ELOG_VERSION_SKEW   205 /* RVM log format version skew */
#define	RVM_EMODE   206 /* invalid transaction begin/end mode */
#define	RVM_ENAME_TOO_LONG   207 /* device name longer than 1023 chars */
#define	RVM_ENO_MEMORY   208 /* heap exhausted */
#define	RVM_ENOT_MAPPED   209 /* designated region not mapped */
#define	RVM_EOFFSET   210 /* invalid segment offset */
#define	RVM_EOPTIONS   211 /* invalid options record or pointer */
#define	RVM_EOVERLAP   212 /* region overlaps existing seg mapping */
#define	RVM_EPAGER   213 /* invalid external pager */
#define	RVM_ERANGE   214 /* invalid virtual memory address */
#define	RVM_EREGION   215 /* invalid region descriptor or pointer */
#define	RVM_EREGION_DEF   216 /* invalid region definition descriptor */
#define	RVM_ESRC   217 /* invalid address range for new values */
#define	RVM_ESTATISTICS   218 /* invalid statistics record */
#define	RVM_ESTAT_VERSION_SKEW   219 /* RVM statistics format version skew */
#define	RVM_ETERMINATED   220 /* terminated by error already reported */
#define	RVM_ETHREADS   221 /* illegal C Thread library */
#define	RVM_ETID   222 /* invalid transaction identifier or ptr */
#define	RVM_ETOO_BIG   223 /* internal resouces exceeded */
#define	RVM_EUNCOMMIT   224 /* uncommitted transaction(s) pending */
#define	RVM_EVERSION_SKEW   225 /* RVM library version skew */
#define	RVM_EVM_OVERLAP   226 /* region overlaps existing vm mapping */
#define	rvm_last_code   227 /* internal use only */
#define	RVM_MK_OFFSET(x, y)   rvm_mk_offset((rvm_length_t)(x), (rvm_length_t)(y))
#define	RVM_OFFSET_INITIALIZER(x, y)   { (x), (y) }
#define	RVM_ZERO_OFFSET(x)   (x) = RVM_MK_OFFSET(0, 0)
#define	RVM_OFFSET_TO_LENGTH(x)   ((x).low)
#define	RVM_OFFSET_HIGH_BITS_TO_LENGTH(x)   ((x).high)
#define	RVM_LENGTH_TO_OFFSET(x)   RVM_MK_OFFSET(0, (x))
#define	RVM_ADD_OFFSETS(x, y)   rvm_add_offsets(&(x), &(y))
#define	RVM_ADD_LENGTH_TO_OFFSET(x, y)   rvm_add_length_to_offset(&(x), (y))
#define	RVM_ADD_LENGTH_TO_ADDR(length, vmaddr)    ((char *)((rvm_length_t)(length) + (rvm_length_t)(vmaddr)))
#define	RVM_SUB_OFFSETS(x, y)   rvm_sub_offsets(&(x), &(y))
#define	RVM_SUB_LENGTH_FROM_OFFSET(x, y)   rvm_sub_length_from_offset(&(x), (y))
#define	RVM_SUB_LENGTH_FROM_ADDR(vmaddr, length)    ((char *)((rvm_length_t)(vmaddr) - (rvm_length_t)(length)))
#define	RVM_OFFSET_LSS(x, y)    (((x).high < (y).high) || ((((x).high == (y).high) && ((x).low < (y).low))))
#define	RVM_OFFSET_GTR(x, y)    (((x).high > (y).high) || ((((x).high == (y).high) && ((x).low > (y).low))))
#define	RVM_OFFSET_LEQ(x, y)   (!RVM_OFFSET_GTR((x), (y)))
#define	RVM_OFFSET_GEQ(x, y)   (!RVM_OFFSET_LSS((x), (y)))
#define	RVM_OFFSET_EQL(x, y)   (((x).high == (y).high) && ((x).low == (y).low))
#define	RVM_OFFSET_EQL_ZERO(x)   (((x).high == 0) && ((x).low == 0))
#define	RVM_PAGE_SIZE   rvm_page_size()
#define	RVM_ROUND_LENGTH_UP_TO_PAGE_SIZE(x)
#define	RVM_ROUND_LENGTH_DOWN_TO_PAGE_SIZE(x)    ((rvm_length_t)((rvm_length_t)(x) & rvm_page_mask()))
#define	RVM_ROUND_ADDR_UP_TO_PAGE_SIZE(x)    ((char *)(((rvm_length_t)(x) + rvm_page_size() - 1) & rvm_page_mask()))
#define	RVM_ROUND_ADDR_DOWN_TO_PAGE_SIZE(x)    ((char *)((rvm_length_t)(x) & rvm_page_mask()))
#define	RVM_ROUND_OFFSET_UP_TO_PAGE_SIZE(x)   rvm_rnd_offset_up_to_page(&(x))
#define	RVM_ROUND_OFFSET_DOWN_TO_PAGE_SIZE(x)   rvm_rnd_offset_dn_to_page(&(x))
#define	TRUNCATE   50 /* 50% default truncation threshold */
#define	RECOVERY_BUF_LEN   (256 * 1024) /* default recovery buffer length */
#define	MIN_RECOVERY_BUF_LEN   (64 * 1024) /* minimum recovery buffer length */
#define	FLUSH_BUF_LEN   (256 * 1024) /* default flush buffer length */
#define	MIN_FLUSH_BUF_LEN   (64 * 1024) /* minimum flush buffer length */
#define	MAX_READ_LEN   (512 * 1024) /* default maximum single read length */
#define	RVM_COALESCE_RANGES    1 /* coalesce adjacent or shadowed ranges within a transaction */
#define	RVM_COALESCE_TRANS    2 /* coalesce adjacent or shadowed ranges within no_flush transactions */
#define	RVM_ALL_OPTIMIZATIONS   (RVM_COALESCE_RANGES | RVM_COALESCE_TRANS)
#define	RVM_MAP_PRIVATE   8 /* Use private mapping, if available */
#define	RVM_INIT(options)   rvm_initialize(RVM_VERSION, (options))

Typedefs
typedef int	rvm_return_t
typedef unsigned long	rvm_length_t

Enumerations
enum	rvm_bool_t { rvm_false = 0 , rvm_true = 1 }
enum	rvm_struct_id_t {   rvm_first_struct_id = 39 , rvm_region_id , rvm_options_id , rvm_tid_id ,   rvm_statistics_id , rvm_last_struct_id }
enum	rvm_mode_t {   rvm_first_mode = 139 , restore , no_restore , flush ,   no_flush , rvm_last_mode }

Functions
char *	rvm_return (rvm_return_t code)
char *	rvm_mode (rvm_mode_t mode)
char *	rvm_type (rvm_struct_id_t id)
rvm_tid_t *	rvm_malloc_tid (void)
void	rvm_init_tid (rvm_tid_t *tid)
rvm_tid_t *	rvm_copy_tid (rvm_tid_t *tid)
void	rvm_free_tid (rvm_tid_t *tid)
rvm_options_t *	rvm_malloc_options (void)
void	rvm_init_options (rvm_options_t *options)
rvm_options_t *	rvm_copy_options (rvm_options_t *options)
void	rvm_free_options (rvm_options_t *options)
rvm_region_t *	rvm_malloc_region (void)
void	rvm_init_region (rvm_region_t *region)
rvm_region_t *	rvm_copy_region (rvm_region_t *region)
void	rvm_free_region (rvm_region_t *region)
rvm_return_t	rvm_initialize (const char *version, rvm_options_t *opts)
rvm_return_t	rvm_terminate (void)
rvm_return_t	rvm_map (rvm_region_t *region, rvm_options_t *options)
rvm_return_t	rvm_unmap (rvm_region_t *region)
rvm_return_t	rvm_set_options (rvm_options_t *options)
rvm_return_t	rvm_query (rvm_options_t *options, rvm_region_t *region)
rvm_return_t	rvm_begin_transaction (rvm_tid_t *tid, rvm_mode_t mode)
rvm_return_t	rvm_set_range (rvm_tid_t *tid, void *dest, rvm_length_t length)
rvm_return_t	rvm_modify_bytes (rvm_tid_t *tid, void *dest, const void *src, rvm_length_t length)
rvm_return_t	rvm_abort_transaction (rvm_tid_t *tid)
rvm_return_t	rvm_end_transaction (rvm_tid_t *tid, rvm_mode_t mode)
rvm_return_t	rvm_flush (void)
rvm_return_t	rvm_truncate (void)
rvm_return_t	rvm_create_log (rvm_options_t *rvm_options, rvm_offset_t *log_len, long mode)
rvm_offset_t	rvm_mk_offset (rvm_length_t x, rvm_length_t y)
rvm_offset_t	rvm_add_offsets (rvm_offset_t *x, rvm_offset_t *y)
rvm_offset_t	rvm_add_length_to_offset (rvm_offset_t *offset, rvm_length_t length)
rvm_offset_t	rvm_sub_offsets (rvm_offset_t *x, rvm_offset_t *y)
rvm_offset_t	rvm_sub_length_from_offset (rvm_offset_t *offset, rvm_length_t length)
rvm_length_t	rvm_page_size ()
rvm_length_t	rvm_page_mask ()
rvm_offset_t	rvm_rnd_offset_up_to_page (rvm_offset_t *x)
rvm_offset_t	rvm_rnd_offset_dn_to_page (rvm_offset_t *x)

Macro Definition Documentation

FALSE

#define FALSE   0

FLUSH_BUF_LEN

#define FLUSH_BUF_LEN   (256 * 1024) /* default flush buffer length */

MAX_READ_LEN

#define MAX_READ_LEN   (512 * 1024) /* default maximum single read length */

MIN_FLUSH_BUF_LEN

#define MIN_FLUSH_BUF_LEN   (64 * 1024) /* minimum flush buffer length */

MIN_RECOVERY_BUF_LEN

#define MIN_RECOVERY_BUF_LEN   (64 * 1024) /* minimum recovery buffer length */

RECOVERY_BUF_LEN

#define RECOVERY_BUF_LEN   (256 * 1024) /* default recovery buffer length */

RVM_ADD_LENGTH_TO_ADDR

#define RVM_ADD_LENGTH_TO_ADDR	(		length,
			vmaddr
	)		((char *)((rvm_length_t)(length) + (rvm_length_t)(vmaddr)))

RVM_ADD_LENGTH_TO_OFFSET

#define RVM_ADD_LENGTH_TO_OFFSET	(		x,
			y
	)		rvm_add_length_to_offset(&(x), (y))

RVM_ADD_OFFSETS

#define RVM_ADD_OFFSETS	(		x,
			y
	)		rvm_add_offsets(&(x), &(y))

RVM_ALL_OPTIMIZATIONS

#define RVM_ALL_OPTIMIZATIONS   (RVM_COALESCE_RANGES | RVM_COALESCE_TRANS)

RVM_COALESCE_RANGES

#define RVM_COALESCE_RANGES    1 /* coalesce adjacent or shadowed ranges within a transaction */

RVM_COALESCE_TRANS

#define RVM_COALESCE_TRANS    2 /* coalesce adjacent or shadowed ranges within no_flush transactions */

RVM_EINIT

#define RVM_EINIT   200 /* RVM not initialized */

RVM_EINTERNAL

#define RVM_EINTERNAL   201 /* internal error, see rvm_errmsg */

RVM_EIO

#define RVM_EIO   202 /* I/O error, see errno */

RVM_ELOG

#define RVM_ELOG   204 /* invalid log device */

RVM_ELOG_VERSION_SKEW

#define RVM_ELOG_VERSION_SKEW   205 /* RVM log format version skew */

RVM_EMODE

#define RVM_EMODE   206 /* invalid transaction begin/end mode */

RVM_ENAME_TOO_LONG

#define RVM_ENAME_TOO_LONG   207 /* device name longer than 1023 chars */

RVM_ENO_MEMORY

#define RVM_ENO_MEMORY   208 /* heap exhausted */

RVM_ENOT_MAPPED

#define RVM_ENOT_MAPPED   209 /* designated region not mapped */

RVM_EOFFSET

#define RVM_EOFFSET   210 /* invalid segment offset */

RVM_EOPTIONS

#define RVM_EOPTIONS   211 /* invalid options record or pointer */

RVM_EOVERLAP

#define RVM_EOVERLAP   212 /* region overlaps existing seg mapping */

RVM_EPAGER

#define RVM_EPAGER   213 /* invalid external pager */

RVM_ERANGE

#define RVM_ERANGE   214 /* invalid virtual memory address */

RVM_EREGION

#define RVM_EREGION   215 /* invalid region descriptor or pointer */

RVM_EREGION_DEF

#define RVM_EREGION_DEF   216 /* invalid region definition descriptor */

RVM_ESRC

#define RVM_ESRC   217 /* invalid address range for new values */

RVM_ESTAT_VERSION_SKEW

#define RVM_ESTAT_VERSION_SKEW   219 /* RVM statistics format version skew */

RVM_ESTATISTICS

#define RVM_ESTATISTICS   218 /* invalid statistics record */

RVM_ETERMINATED

#define RVM_ETERMINATED   220 /* terminated by error already reported */

RVM_ETHREADS

#define RVM_ETHREADS   221 /* illegal C Thread library */

RVM_ETID

#define RVM_ETID   222 /* invalid transaction identifier or ptr */

RVM_ETOO_BIG

#define RVM_ETOO_BIG   223 /* internal resouces exceeded */

RVM_EUNCOMMIT

#define RVM_EUNCOMMIT   224 /* uncommitted transaction(s) pending */

RVM_EVERSION_SKEW

#define RVM_EVERSION_SKEW   225 /* RVM library version skew */

RVM_EVM_OVERLAP

#define RVM_EVM_OVERLAP   226 /* region overlaps existing vm mapping */

rvm_first_code

#define rvm_first_code   199 /* internal use only */

RVM_INIT

#define RVM_INIT

(

options

)

rvm_initialize(RVM_VERSION, (options))

rvm_last_code

#define rvm_last_code   227 /* internal use only */

RVM_LENGTH_TO_OFFSET

#define RVM_LENGTH_TO_OFFSET

(

x

)

RVM_MK_OFFSET(0, (x))

RVM_MAP_PRIVATE

#define RVM_MAP_PRIVATE   8 /* Use private mapping, if available */

RVM_MK_OFFSET

#define RVM_MK_OFFSET	(		x,
			y
	)		rvm_mk_offset((rvm_length_t)(x), (rvm_length_t)(y))

RVM_OFFSET_EQL

#define RVM_OFFSET_EQL	(		x,
			y
	)		(((x).high == (y).high) && ((x).low == (y).low))

RVM_OFFSET_EQL_ZERO

#define RVM_OFFSET_EQL_ZERO

(

x

)

(((x).high == 0) && ((x).low == 0))

RVM_OFFSET_GEQ

#define RVM_OFFSET_GEQ	(		x,
			y
	)		(!RVM_OFFSET_LSS((x), (y)))

RVM_OFFSET_GTR

#define RVM_OFFSET_GTR	(		x,
			y
	)		(((x).high > (y).high) || ((((x).high == (y).high) && ((x).low > (y).low))))

RVM_OFFSET_HIGH_BITS_TO_LENGTH

#define RVM_OFFSET_HIGH_BITS_TO_LENGTH

(

x

)

((x).high)

RVM_OFFSET_INITIALIZER

#define RVM_OFFSET_INITIALIZER	(		x,
			y
	)		{ (x), (y) }

RVM_OFFSET_LEQ

#define RVM_OFFSET_LEQ	(		x,
			y
	)		(!RVM_OFFSET_GTR((x), (y)))

RVM_OFFSET_LSS

#define RVM_OFFSET_LSS	(		x,
			y
	)		(((x).high < (y).high) || ((((x).high == (y).high) && ((x).low < (y).low))))

RVM_OFFSET_TO_LENGTH

#define RVM_OFFSET_TO_LENGTH

(

x

)

((x).low)

RVM_PAGE_SIZE

#define RVM_PAGE_SIZE   rvm_page_size()

RVM_ROUND_ADDR_DOWN_TO_PAGE_SIZE

#define RVM_ROUND_ADDR_DOWN_TO_PAGE_SIZE

(

x

)

((char *)((rvm_length_t)(x) & rvm_page_mask()))

RVM_ROUND_ADDR_UP_TO_PAGE_SIZE

#define RVM_ROUND_ADDR_UP_TO_PAGE_SIZE

(

x

)

((char *)(((rvm_length_t)(x) + rvm_page_size() - 1) & rvm_page_mask()))

RVM_ROUND_LENGTH_DOWN_TO_PAGE_SIZE

#define RVM_ROUND_LENGTH_DOWN_TO_PAGE_SIZE

(

x

)

((rvm_length_t)((rvm_length_t)(x) & rvm_page_mask()))

RVM_ROUND_LENGTH_UP_TO_PAGE_SIZE

#define RVM_ROUND_LENGTH_UP_TO_PAGE_SIZE

(

x

)

Value:

    ((rvm_length_t)(((rvm_length_t)(x) + rvm_page_size() - 1) & \
                    rvm_page_mask()))

RVM_ROUND_OFFSET_DOWN_TO_PAGE_SIZE

#define RVM_ROUND_OFFSET_DOWN_TO_PAGE_SIZE

(

x

)

rvm_rnd_offset_dn_to_page(&(x))

RVM_ROUND_OFFSET_UP_TO_PAGE_SIZE

#define RVM_ROUND_OFFSET_UP_TO_PAGE_SIZE

(

x

)

rvm_rnd_offset_up_to_page(&(x))

RVM_SUB_LENGTH_FROM_ADDR

#define RVM_SUB_LENGTH_FROM_ADDR	(		vmaddr,
			length
	)		((char *)((rvm_length_t)(vmaddr) - (rvm_length_t)(length)))

RVM_SUB_LENGTH_FROM_OFFSET

#define RVM_SUB_LENGTH_FROM_OFFSET	(		x,
			y
	)		rvm_sub_length_from_offset(&(x), (y))

RVM_SUB_OFFSETS

#define RVM_SUB_OFFSETS	(		x,
			y
	)		rvm_sub_offsets(&(x), &(y))

RVM_SUCCESS

#define RVM_SUCCESS   0 /* success return code */

RVM_VERSION

#define RVM_VERSION   "RVM Interface Version 1.3 7 Mar 1994"

RVM_VERSION_MAX

#define RVM_VERSION_MAX   128 /* 128 char maximum version str length */

RVM_ZERO_OFFSET

#define RVM_ZERO_OFFSET

(

x

)

(x) = RVM_MK_OFFSET(0, 0)

TRUE

#define TRUE   1

TRUNCATE

#define TRUNCATE   50 /* 50% default truncation threshold */

Typedef Documentation

rvm_length_t

typedef unsigned long rvm_length_t

rvm_return_t

typedef int rvm_return_t

Enumeration Type Documentation

rvm_bool_t

enum rvm_bool_t

Enumerator
rvm_false
rvm_true

rvm_mode_t

enum rvm_mode_t

Enumerator
rvm_first_mode
restore
no_restore
flush
no_flush
rvm_last_mode

rvm_struct_id_t

enum rvm_struct_id_t

Enumerator
rvm_first_struct_id
rvm_region_id
rvm_options_id
rvm_tid_id
rvm_statistics_id
rvm_last_struct_id

Function Documentation

rvm_abort_transaction()

rvm_return_t rvm_abort_transaction

(

rvm_tid_t *

tid

)

rvm_add_length_to_offset()

rvm_offset_t rvm_add_length_to_offset	(	rvm_offset_t *	offset,
		rvm_length_t	length
	)

rvm_add_offsets()

rvm_offset_t rvm_add_offsets	(	rvm_offset_t *	x,
		rvm_offset_t *	y
	)

rvm_begin_transaction()

rvm_return_t rvm_begin_transaction	(	rvm_tid_t *	tid,
		rvm_mode_t	mode
	)

rvm_copy_options()

rvm_options_t * rvm_copy_options

(

rvm_options_t *

options

)

rvm_copy_region()

rvm_region_t * rvm_copy_region

(

rvm_region_t *

region

)

rvm_copy_tid()

rvm_tid_t * rvm_copy_tid

(

rvm_tid_t *

tid

)

rvm_create_log()

rvm_return_t rvm_create_log	(	rvm_options_t *	rvm_options,
		rvm_offset_t *	log_len,
		long	mode
	)

rvm_end_transaction()

rvm_return_t rvm_end_transaction	(	rvm_tid_t *	tid,
		rvm_mode_t	mode
	)

rvm_flush()

rvm_return_t rvm_flush

(

void

)

rvm_free_options()

void rvm_free_options

(

rvm_options_t *

options

)

rvm_free_region()

void rvm_free_region

(

rvm_region_t *

region

)

rvm_free_tid()

void rvm_free_tid

(

rvm_tid_t *

tid

)

rvm_init_options()

void rvm_init_options

(

rvm_options_t *

options

)

rvm_init_region()

void rvm_init_region

(

rvm_region_t *

region

)

rvm_init_tid()

void rvm_init_tid

(

rvm_tid_t *

tid

)

rvm_initialize()

rvm_return_t rvm_initialize	(	const char *	version,
		rvm_options_t *	opts
	)

rvm_malloc_options()

rvm_options_t * rvm_malloc_options

(

void

)

rvm_malloc_region()

rvm_region_t * rvm_malloc_region

(

void

)

rvm_malloc_tid()

rvm_tid_t * rvm_malloc_tid

(

void

)

rvm_map()

rvm_return_t rvm_map	(	rvm_region_t *	region,
		rvm_options_t *	options
	)

rvm_mk_offset()

rvm_offset_t rvm_mk_offset	(	rvm_length_t	x,
		rvm_length_t	y
	)

rvm_mode()

char * rvm_mode

(

rvm_mode_t

mode

)

rvm_modify_bytes()

rvm_return_t rvm_modify_bytes	(	rvm_tid_t *	tid,
		void *	dest,
		const void *	src,
		rvm_length_t	length
	)

rvm_page_mask()

rvm_length_t rvm_page_mask

(

)

rvm_page_size()

rvm_length_t rvm_page_size

(

)

rvm_query()

rvm_return_t rvm_query	(	rvm_options_t *	options,
		rvm_region_t *	region
	)

rvm_return()

char * rvm_return

(

rvm_return_t

code

)

rvm_rnd_offset_dn_to_page()

rvm_offset_t rvm_rnd_offset_dn_to_page

(

rvm_offset_t *

x

)

rvm_rnd_offset_up_to_page()

rvm_offset_t rvm_rnd_offset_up_to_page

(

rvm_offset_t *

x

)

rvm_set_options()

rvm_return_t rvm_set_options

(

rvm_options_t *

options

)

rvm_set_range()

rvm_return_t rvm_set_range	(	rvm_tid_t *	tid,
		void *	dest,
		rvm_length_t	length
	)

rvm_sub_length_from_offset()

rvm_offset_t rvm_sub_length_from_offset	(	rvm_offset_t *	offset,
		rvm_length_t	length
	)

rvm_sub_offsets()

rvm_offset_t rvm_sub_offsets	(	rvm_offset_t *	x,
		rvm_offset_t *	y
	)

rvm_terminate()

rvm_return_t rvm_terminate

(

void

)

rvm_truncate()

rvm_return_t rvm_truncate

(

void

)

rvm_type()

char * rvm_type

(

rvm_struct_id_t

id

)

rvm_unmap()

rvm_return_t rvm_unmap

(

rvm_region_t *

region

)