xref: /onnv-gate/usr/src/lib/libpool/common/pool_kernel_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 2003 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	_POOL_KERNEL_IMPL_H
28*0Sstevel@tonic-gate #define	_POOL_KERNEL_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 /*
37*0Sstevel@tonic-gate  * This file contains the definitions of types and supporting
38*0Sstevel@tonic-gate  * functions to implement the libpool kernel specific data
39*0Sstevel@tonic-gate  * manipulation facility.
40*0Sstevel@tonic-gate  *
41*0Sstevel@tonic-gate  * For more information on the libpool generic data manipulation
42*0Sstevel@tonic-gate  * facility, look at pool_impl.h.
43*0Sstevel@tonic-gate  *
44*0Sstevel@tonic-gate  * The central types for the generic data representation/storage
45*0Sstevel@tonic-gate  * facility are here enhanced to provide additional kernel specific
46*0Sstevel@tonic-gate  * information.
47*0Sstevel@tonic-gate  */
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate /*
50*0Sstevel@tonic-gate  * pool_knl_elem_t is the kernel specific representation of the
51*0Sstevel@tonic-gate  * pool_elem_t structure.
52*0Sstevel@tonic-gate  */
53*0Sstevel@tonic-gate typedef struct pool_knl_elem {
54*0Sstevel@tonic-gate 	/*
55*0Sstevel@tonic-gate 	 * Common to pool_elem_t
56*0Sstevel@tonic-gate 	 */
57*0Sstevel@tonic-gate 	pool_elem_t pke_elem;
58*0Sstevel@tonic-gate 	void *pke_pad1;
59*0Sstevel@tonic-gate 	void *pke_pad2;
60*0Sstevel@tonic-gate 	/*
61*0Sstevel@tonic-gate 	 * Common to pool_knl_elem_t
62*0Sstevel@tonic-gate 	 */
63*0Sstevel@tonic-gate 	nvlist_t *pke_properties;			/* Properties nvlist */
64*0Sstevel@tonic-gate 	struct pool_knl_elem *pke_parent;		/* Element parent */
65*0Sstevel@tonic-gate 	uint64_t pke_ltime;				/* Library timestamp */
66*0Sstevel@tonic-gate } pool_knl_elem_t;
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate typedef pool_knl_elem_t pool_knl_system_t;
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate typedef struct pool_knl_resource {
71*0Sstevel@tonic-gate 	/*
72*0Sstevel@tonic-gate 	 * Common to pool_elem_t
73*0Sstevel@tonic-gate 	 */
74*0Sstevel@tonic-gate 	pool_elem_t pke_elem;
75*0Sstevel@tonic-gate 	/*
76*0Sstevel@tonic-gate 	 * Specific to pool_resource_t
77*0Sstevel@tonic-gate 	 */
78*0Sstevel@tonic-gate 	int (*pr_is_system)(const pool_resource_t *);
79*0Sstevel@tonic-gate 	int (*pr_can_associate)(const pool_resource_t *);
80*0Sstevel@tonic-gate 	/*
81*0Sstevel@tonic-gate 	 * Common to pool_knl_elem_t
82*0Sstevel@tonic-gate 	 */
83*0Sstevel@tonic-gate 	nvlist_t *pke_properties;			/* Properties nvlist */
84*0Sstevel@tonic-gate 	struct pool_knl_elem *pke_parent;		/* Element parent */
85*0Sstevel@tonic-gate 	uint64_t pke_ltime;				/* Library timestamp */
86*0Sstevel@tonic-gate } pool_knl_resource_t;
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate typedef pool_knl_elem_t pool_knl_component_t;
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate typedef struct pool_knl_pool {
91*0Sstevel@tonic-gate 	/*
92*0Sstevel@tonic-gate 	 * Common to pool_elem_t
93*0Sstevel@tonic-gate 	 */
94*0Sstevel@tonic-gate 	pool_elem_t pke_elem;
95*0Sstevel@tonic-gate 	/*
96*0Sstevel@tonic-gate 	 * Specific to pool_t
97*0Sstevel@tonic-gate 	 */
98*0Sstevel@tonic-gate 	int (*pp_associate)(pool_t *, const pool_resource_t *);
99*0Sstevel@tonic-gate 	int (*pp_dissociate)(pool_t *, const pool_resource_t *);
100*0Sstevel@tonic-gate 	/*
101*0Sstevel@tonic-gate 	 * Common to pool_knl_elem_t
102*0Sstevel@tonic-gate 	 */
103*0Sstevel@tonic-gate 	nvlist_t *pke_properties;			/* Properties nvlist */
104*0Sstevel@tonic-gate 	struct pool_knl_elem *pke_parent;		/* Element parent */
105*0Sstevel@tonic-gate 	uint64_t pke_ltime;				/* Library timestamp */
106*0Sstevel@tonic-gate 	/*
107*0Sstevel@tonic-gate 	 * Specific to pool_knl_pool_t
108*0Sstevel@tonic-gate 	 */
109*0Sstevel@tonic-gate 	pool_knl_resource_t *pkp_assoc[4];		/* Pool resources */
110*0Sstevel@tonic-gate } pool_knl_pool_t;
111*0Sstevel@tonic-gate 
112*0Sstevel@tonic-gate /*
113*0Sstevel@tonic-gate  * pool_knl_result_set_t is the kernel specific representation of the
114*0Sstevel@tonic-gate  * pool_result_set_t structure.
115*0Sstevel@tonic-gate  *
116*0Sstevel@tonic-gate  */
117*0Sstevel@tonic-gate typedef struct pool_knl_result_set {
118*0Sstevel@tonic-gate 	const pool_conf_t *prs_conf;			/* Configuration */
119*0Sstevel@tonic-gate 	int prs_active;					/* Query active? */
120*0Sstevel@tonic-gate 	int prs_index;					/* Result Index */
121*0Sstevel@tonic-gate 	pool_elem_t *(*prs_next)(pool_result_set_t *);
122*0Sstevel@tonic-gate 	pool_elem_t *(*prs_prev)(pool_result_set_t *);
123*0Sstevel@tonic-gate 	pool_elem_t *(*prs_first)(pool_result_set_t *);
124*0Sstevel@tonic-gate 	pool_elem_t *(*prs_last)(pool_result_set_t *);
125*0Sstevel@tonic-gate 	int (*prs_set_index)(pool_result_set_t *, int);
126*0Sstevel@tonic-gate 	int (*prs_get_index)(pool_result_set_t *);
127*0Sstevel@tonic-gate 	int (*prs_close)(pool_result_set_t *);
128*0Sstevel@tonic-gate 	int (*prs_count)(pool_result_set_t *);
129*0Sstevel@tonic-gate 	/*
130*0Sstevel@tonic-gate 	 * End of common part
131*0Sstevel@tonic-gate 	 */
132*0Sstevel@tonic-gate 	pool_knl_elem_t **pkr_list;			/* Result members */
133*0Sstevel@tonic-gate 	int pkr_count;					/* Result set count */
134*0Sstevel@tonic-gate 	int pkr_size;					/* Result set size */
135*0Sstevel@tonic-gate } pool_knl_result_set_t;
136*0Sstevel@tonic-gate 
137*0Sstevel@tonic-gate /*
138*0Sstevel@tonic-gate  * pool_knl_connection_t is the kernel specific representation of the
139*0Sstevel@tonic-gate  * pool_connection_t structure.
140*0Sstevel@tonic-gate  *
141*0Sstevel@tonic-gate  */
142*0Sstevel@tonic-gate typedef struct pool_knl_connection {
143*0Sstevel@tonic-gate 	const char *pc_name;				/* Provider name */
144*0Sstevel@tonic-gate 	int pc_store_type;				/* Datastore type */
145*0Sstevel@tonic-gate 	int pc_oflags;					/* Open flags */
146*0Sstevel@tonic-gate 	int (*pc_close)(pool_conf_t *);
147*0Sstevel@tonic-gate 	int (*pc_validate)(const pool_conf_t *, pool_valid_level_t);
148*0Sstevel@tonic-gate 	int (*pc_commit)(pool_conf_t *);
149*0Sstevel@tonic-gate 	int (*pc_export)(const pool_conf_t *, const char *,
150*0Sstevel@tonic-gate 	    pool_export_format_t);
151*0Sstevel@tonic-gate 	int (*pc_rollback)(pool_conf_t *);
152*0Sstevel@tonic-gate 	pool_result_set_t *(*pc_exec_query)(const pool_conf_t *,
153*0Sstevel@tonic-gate 	    const pool_elem_t *, const char *,
154*0Sstevel@tonic-gate 	    pool_elem_class_t, pool_value_t **);
155*0Sstevel@tonic-gate 	pool_elem_t *(*pc_elem_create)(pool_conf_t *, pool_elem_class_t,
156*0Sstevel@tonic-gate 	    pool_resource_elem_class_t, pool_component_elem_class_t);
157*0Sstevel@tonic-gate 	int (*pc_remove)(pool_conf_t *);
158*0Sstevel@tonic-gate 	int (*pc_res_xfer)(pool_resource_t *, pool_resource_t *, uint64_t);
159*0Sstevel@tonic-gate 	int (*pc_res_xxfer)(pool_resource_t *, pool_resource_t *,
160*0Sstevel@tonic-gate 	    pool_component_t **);
161*0Sstevel@tonic-gate 	char *(*pc_get_binding)(pool_conf_t *, pid_t);
162*0Sstevel@tonic-gate 	int (*pc_set_binding)(pool_conf_t *, const char *, idtype_t, id_t);
163*0Sstevel@tonic-gate 	char *(*pc_get_resource_binding)(pool_conf_t *,
164*0Sstevel@tonic-gate 	    pool_resource_elem_class_t, pid_t);
165*0Sstevel@tonic-gate 	/*
166*0Sstevel@tonic-gate 	 * End of common part
167*0Sstevel@tonic-gate 	 */
168*0Sstevel@tonic-gate 	int pkc_fd;					/* Pool device */
169*0Sstevel@tonic-gate 	dict_hdl_t *pkc_elements;			/* Elements */
170*0Sstevel@tonic-gate #if DEBUG
171*0Sstevel@tonic-gate 	dict_hdl_t *pkc_leaks;				/* Elements */
172*0Sstevel@tonic-gate #endif	/* DEBUG */
173*0Sstevel@tonic-gate 	log_t *pkc_log;					/* Transaction log */
174*0Sstevel@tonic-gate 	hrtime_t pkc_ltime;				/* Snap updated */
175*0Sstevel@tonic-gate 	hrtime_t pkc_lotime;				/* Snap last updated */
176*0Sstevel@tonic-gate } pool_knl_connection_t;
177*0Sstevel@tonic-gate 
178*0Sstevel@tonic-gate #ifdef	__cplusplus
179*0Sstevel@tonic-gate }
180*0Sstevel@tonic-gate #endif
181*0Sstevel@tonic-gate 
182*0Sstevel@tonic-gate #endif	/* _POOL_KERNEL_IMPL_H */
183