xref: /illumos-gate/usr/src/uts/common/sys/mdesc.h (revision 2d6eb4a5)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_MDESC_H_
#define	_MDESC_H_

#include <sys/types.h>

#ifdef __cplusplus
extern "C" {
#endif


/*
 * Each logical domain is detailed via a (Virtual) Machine Description
 * available to each guest Operating System courtesy of a
 * Hypervisor service.
 */



#ifdef	_ASM
#define	U8(_s)	_s
#define	U16(_s)	_s
#define	U32(_s)	_s
#define	U64(_s)	_s
#else
#define	U8(_s)	((uint8_t)(_s))
#define	U16(_s)	((uint16_t)(_s))
#define	U32(_s)	((uint32_t)(_s))
#define	U64(_s)	((uint64_t)(_s))
#endif





	/* the version this library understands */

#define	MD_HEADER_VERS_OFF	0x0
#define	MD_HEADER_NODE_OFF	0x4
#define	MD_HEADER_NAME_OFF	0x8
#define	MD_HEADER_DATA_OFF	0xc

#define	MD_HEADER_SIZE	0x10

#define	MD_TRANSPORT_VERSION	U32(0x10000)

#define	MD_ELEMENT_SIZE	0x10

#define	MDE_ILLEGAL_IDX		U64(-1)

#define	MDET_LIST_END	U8(0x0)
#define	MDET_NULL	U8(' ')
#define	MDET_NODE	U8('N')
#define	MDET_NODE_END	U8('E')
#define	MDET_PROP_ARC	U8('a')
#define	MDET_PROP_VAL	U8('v')
#define	MDET_PROP_STR	U8('s')
#define	MDET_PROP_DAT	U8('d')


#ifndef _ASM	/* { */

/*
 * Opaque handles for use in external interfaces
 */

typedef void			*md_t;

typedef uint64_t		mde_cookie_t;
#define	MDE_INVAL_ELEM_COOKIE	((mde_cookie_t)-1)

typedef	uint32_t		mde_str_cookie_t;
#define	MDE_INVAL_STR_COOKIE	((mde_str_cookie_t)-1)

typedef uint64_t		md_diff_cookie_t;
#define	MD_INVAL_DIFF_COOKIE	((md_diff_cookie_t)-1)

#define	MDESC_INVAL_GEN		(0)

/*
 * External structure for MD diff interface
 */
typedef struct {
	uint8_t		type;		/* property type */
	char		*namep;		/* property name */
} md_prop_match_t;


/*
 * Walk callback function return codes
 */
#define	MDE_WALK_ERROR	-1	/* Terminate walk with error */
#define	MDE_WALK_NEXT	0	/* Continue to next node */
#define	MDE_WALK_DONE	1	/* Terminate walk with success */

/*
 * The function prototype for a walker callback function.
 * The machine description session, parent node, current node,
 * and private data are given to the callback.
 *
 * The parent node is given to the callback to provide context
 * on how the walker arrived at this location.  While the node
 * may have many parents, it will be visited only once, this
 * provides context on how the walker arrived at the node.
 *
 * Input		Description
 * -------------------	----------------------------------------
 * md_t *		Pointer to md session
 * mde_cookie_t		Index of parent node to provide context
 * mde_cookie_t		The current node in the walk
 * void *		Private data for the walking function
 */
typedef int md_walk_fn_t(md_t *, mde_cookie_t, mde_cookie_t, void *);


/*
 * External Interface
 */

extern md_t		*md_init_intern(uint64_t *,
				void *(*allocp)(size_t),
				void (*freep)(void *, size_t));

extern int		md_fini(md_t *);

extern int		md_node_count(md_t *);

extern mde_str_cookie_t md_find_name(md_t *, char *namep);

extern mde_cookie_t	md_root_node(md_t *);

extern uint64_t		md_get_gen(md_t *);

extern size_t		md_get_bin_size(md_t *);

extern int		md_scan_dag(md_t *,
				mde_cookie_t,
				mde_str_cookie_t,
				mde_str_cookie_t,
				mde_cookie_t *);

extern int		md_walk_dag(md_t *,
				mde_cookie_t,
				mde_str_cookie_t,
				mde_str_cookie_t,
				md_walk_fn_t,
				void *);

extern int		md_get_prop_val(md_t *,
				mde_cookie_t,
				char *,
				uint64_t *);

extern int		md_get_prop_str(md_t *,
				mde_cookie_t,
				char *,
				char **);

extern int		md_get_prop_data(md_t *,
				mde_cookie_t,
				char *,
				uint8_t **,
				int *);

extern int		md_get_prop_arcs(md_t *,
				mde_cookie_t,
				char *,
				mde_cookie_t *,
				size_t);


extern md_diff_cookie_t	md_diff_init(md_t *,
				mde_cookie_t,
				md_t *,
				mde_cookie_t,
				char *,
				md_prop_match_t *);

extern int		md_diff_added(md_diff_cookie_t,
				mde_cookie_t **);

extern int		md_diff_removed(md_diff_cookie_t,
				mde_cookie_t **);

extern int		md_diff_matched(md_diff_cookie_t,
				mde_cookie_t **,
				mde_cookie_t **);

extern int		md_diff_fini(md_diff_cookie_t);


#endif	/* } _ASM */



/*
 * ioctl info for mdesc device
 */

#define	MDESCIOC	('m' << 24 | 'd' << 16 | 'd' << 8)

#define	MDESCIOCGSZ	(MDESCIOC | 1)   /* Get quote buffer size */
#define	MDESCIOCSSZ	(MDESCIOC | 2)   /* Set new quote buffer size */
#define	MDESCIOCDISCARD	(MDESCIOC | 3)   /* Discard quotes and reset */

#ifdef __cplusplus
}
#endif

#endif	/* _MDESC_H_ */