xref: /onnv-gate/usr/src/uts/common/sys/mdesc_impl.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_MDESC_IMPL_H_
28*0Sstevel@tonic-gate #define	_MDESC_IMPL_H_
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef __cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #define	LIBMD_MAGIC	0x4d61636844657363	/* MachDesc */
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate #ifndef _ASM
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate 	/*
41*0Sstevel@tonic-gate 	 * Internal definitions
42*0Sstevel@tonic-gate 	 */
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate /*
46*0Sstevel@tonic-gate  * Each MD has the following header to
47*0Sstevel@tonic-gate  * provide information about each section of the MD.
48*0Sstevel@tonic-gate  *
49*0Sstevel@tonic-gate  * There are 3 sections:
50*0Sstevel@tonic-gate  * The description list, the name table and the data block.
51*0Sstevel@tonic-gate  *
52*0Sstevel@tonic-gate  * All values are stored in network byte order.
53*0Sstevel@tonic-gate  *
54*0Sstevel@tonic-gate  * Elements in the first (description list) section are defined by their
55*0Sstevel@tonic-gate  * index location within the node block. An index is simply the byte offset
56*0Sstevel@tonic-gate  * within the block / element size (16bytes). All elements are refered to
57*0Sstevel@tonic-gate  * by their index, to avoid bugs related to alignment etc.
58*0Sstevel@tonic-gate  *
59*0Sstevel@tonic-gate  * The name_len field holds the storage length of an ASCII name, NOT the strlen.
60*0Sstevel@tonic-gate  * The header fields are written in network
61*0Sstevel@tonic-gate  * byte order.
62*0Sstevel@tonic-gate  */
63*0Sstevel@tonic-gate 
64*0Sstevel@tonic-gate struct md_header_s {
65*0Sstevel@tonic-gate 	uint32_t	transport_version;
66*0Sstevel@tonic-gate 	uint32_t	node_blk_sz;	/* size in bytes of the node block */
67*0Sstevel@tonic-gate 	uint32_t	name_blk_sz;	/* size in bytes of the name block */
68*0Sstevel@tonic-gate 	uint32_t	data_blk_sz;	/* size in bytes of the data block */
69*0Sstevel@tonic-gate };
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate typedef struct md_header_s md_header_t;
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate 
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate #if defined(_BIG_ENDIAN) && !defined(lint)
76*0Sstevel@tonic-gate #define	mdtoh8(x)	((uint8_t)(x))
77*0Sstevel@tonic-gate #define	mdtoh16(x)	((uint16_t)(x))
78*0Sstevel@tonic-gate #define	mdtoh32(x)	((uint32_t)(x))
79*0Sstevel@tonic-gate #define	mdtoh64(x)	((uint64_t)(x))
80*0Sstevel@tonic-gate #define	htomd8(x)	(x)
81*0Sstevel@tonic-gate #define	htomd16(x)	(x)
82*0Sstevel@tonic-gate #define	htomd32(x)	(x)
83*0Sstevel@tonic-gate #define	htomd64(x)	(x)
84*0Sstevel@tonic-gate #else
85*0Sstevel@tonic-gate #define	mdtoh8(x)	((uint8_t)(x))
86*0Sstevel@tonic-gate extern	uint16_t	mdtoh16(uint16_t);
87*0Sstevel@tonic-gate extern	uint32_t	mdtoh32(uint32_t);
88*0Sstevel@tonic-gate extern	uint64_t	mdtoh64(uint64_t);
89*0Sstevel@tonic-gate #define	htomd8(x)	((uint8_t)(x))
90*0Sstevel@tonic-gate extern	uint16_t	htomd16(uint16_t);
91*0Sstevel@tonic-gate extern	uint32_t	htomd32(uint32_t);
92*0Sstevel@tonic-gate extern	uint64_t	htomd64(uint64_t);
93*0Sstevel@tonic-gate #endif
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate 
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate struct MD_ELEMENT {
98*0Sstevel@tonic-gate 	uint8_t		tag;
99*0Sstevel@tonic-gate 	uint8_t		name_len;
100*0Sstevel@tonic-gate 	uint16_t	_reserved;
101*0Sstevel@tonic-gate 	uint32_t	name_offset;	/* mde_str_cookie_t */
102*0Sstevel@tonic-gate 	union {
103*0Sstevel@tonic-gate 		struct {
104*0Sstevel@tonic-gate 			uint32_t	len;
105*0Sstevel@tonic-gate 			uint32_t	offset;
106*0Sstevel@tonic-gate 		} prop_data;			/* for PROP_DATA and PROP_STR */
107*0Sstevel@tonic-gate 		uint64_t	prop_val;	/* for PROP_VAL */
108*0Sstevel@tonic-gate 		uint64_t	prop_idx;	/* for PROP_ARC and NODE */
109*0Sstevel@tonic-gate 	} d;
110*0Sstevel@tonic-gate };
111*0Sstevel@tonic-gate 
112*0Sstevel@tonic-gate typedef struct MD_ELEMENT md_element_t;
113*0Sstevel@tonic-gate 
114*0Sstevel@tonic-gate struct MACHINE_DESCRIPTION {
115*0Sstevel@tonic-gate 	caddr_t		caddr;
116*0Sstevel@tonic-gate 
117*0Sstevel@tonic-gate 	void		*(*allocp)(size_t);
118*0Sstevel@tonic-gate 	void		(*freep)(void*);
119*0Sstevel@tonic-gate 
120*0Sstevel@tonic-gate 	md_header_t	*headerp;
121*0Sstevel@tonic-gate 	md_element_t	*mdep;
122*0Sstevel@tonic-gate 	char		*namep;
123*0Sstevel@tonic-gate 	uint8_t		*datap;
124*0Sstevel@tonic-gate 
125*0Sstevel@tonic-gate 	int		node_blk_size;
126*0Sstevel@tonic-gate 	int		name_blk_size;
127*0Sstevel@tonic-gate 	int		data_blk_size;
128*0Sstevel@tonic-gate 
129*0Sstevel@tonic-gate 	int		element_count;
130*0Sstevel@tonic-gate 	int		node_count;
131*0Sstevel@tonic-gate 
132*0Sstevel@tonic-gate 	mde_cookie_t	root_node;
133*0Sstevel@tonic-gate 
134*0Sstevel@tonic-gate 	int		size;
135*0Sstevel@tonic-gate 
136*0Sstevel@tonic-gate 	uint64_t	md_magic;
137*0Sstevel@tonic-gate };
138*0Sstevel@tonic-gate 
139*0Sstevel@tonic-gate typedef struct MACHINE_DESCRIPTION md_impl_t;
140*0Sstevel@tonic-gate 
141*0Sstevel@tonic-gate #define	MDE_TAG(_p)			mdtoh8((_p)->tag)
142*0Sstevel@tonic-gate #define	MDE_NAME(_p)			mdtoh32((_p)->name_offset)
143*0Sstevel@tonic-gate #define	MDE_NAME_LEN(_p)		mdtoh32((_p)->name_len)
144*0Sstevel@tonic-gate #define	MDE_PROP_DATA_OFFSET(_p)	mdtoh32((_p)->d.prop_data.offset)
145*0Sstevel@tonic-gate #define	MDE_PROP_DATA_LEN(_p)		mdtoh32((_p)->d.prop_data.len)
146*0Sstevel@tonic-gate #define	MDE_PROP_VALUE(_p)		mdtoh64((_p)->d.prop_val)
147*0Sstevel@tonic-gate #define	MDE_PROP_INDEX(_p)		mdtoh64((_p)->d.prop_idx)
148*0Sstevel@tonic-gate 
149*0Sstevel@tonic-gate extern mde_str_cookie_t md_ident_name_str(char *);
150*0Sstevel@tonic-gate 
151*0Sstevel@tonic-gate extern mde_cookie_t	md_find_node_prop(md_impl_t *,
152*0Sstevel@tonic-gate 				mde_cookie_t,
153*0Sstevel@tonic-gate 				mde_str_cookie_t,
154*0Sstevel@tonic-gate 				int);
155*0Sstevel@tonic-gate 
156*0Sstevel@tonic-gate #endif	/* _ASM */
157*0Sstevel@tonic-gate 
158*0Sstevel@tonic-gate #ifdef __cplusplus
159*0Sstevel@tonic-gate }
160*0Sstevel@tonic-gate #endif
161*0Sstevel@tonic-gate 
162*0Sstevel@tonic-gate #endif	/* _MDESC_IMPL_H_ */
163