xref: /onnv-gate/usr/src/cmd/lvm/metassist/common/volume_request.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	_VOLUME_REQUEST_H
28*0Sstevel@tonic-gate #define	_VOLUME_REQUEST_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 #include "volume_devconfig.h"
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate /*
39*0Sstevel@tonic-gate  * request_t - struct to hold a layout request
40*0Sstevel@tonic-gate  */
41*0Sstevel@tonic-gate typedef struct request {
42*0Sstevel@tonic-gate 	/*
43*0Sstevel@tonic-gate 	 * The devconfig_t representing the disk set at the top of the
44*0Sstevel@tonic-gate 	 * request hierarchy.  This hierarchy represents the requested
45*0Sstevel@tonic-gate 	 * volume configuration, as read from the volume-request.
46*0Sstevel@tonic-gate 	 */
47*0Sstevel@tonic-gate 	devconfig_t *diskset_req;
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate 	/*
50*0Sstevel@tonic-gate 	 * The devconfig_t representing the disk set at the top of the
51*0Sstevel@tonic-gate 	 * resulting proposed volume hierarchy.  This hierarchy
52*0Sstevel@tonic-gate 	 * represents the volume configuration proposed by the layout
53*0Sstevel@tonic-gate 	 * engine.  This configuration will eventually be converted to
54*0Sstevel@tonic-gate 	 * a volume-spec.
55*0Sstevel@tonic-gate 	 */
56*0Sstevel@tonic-gate 	devconfig_t *diskset_config;
57*0Sstevel@tonic-gate } request_t;
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate /*
60*0Sstevel@tonic-gate  * Constructor: Create a request_t struct. This request_t must be
61*0Sstevel@tonic-gate  * freed.
62*0Sstevel@tonic-gate  *
63*0Sstevel@tonic-gate  * @param       request
64*0Sstevel@tonic-gate  *              RETURN: a pointer to a new request_t
65*0Sstevel@tonic-gate  *
66*0Sstevel@tonic-gate  * @return      0
67*0Sstevel@tonic-gate  *              if successful
68*0Sstevel@tonic-gate  *
69*0Sstevel@tonic-gate  * @return      non-zero
70*0Sstevel@tonic-gate  *              if an error occurred.  Use get_error_string() to
71*0Sstevel@tonic-gate  *              retrieve the associated error message.
72*0Sstevel@tonic-gate  */
73*0Sstevel@tonic-gate extern int new_request(request_t **request);
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate /*
76*0Sstevel@tonic-gate  * Free memory (recursively) allocated to a request_t struct
77*0Sstevel@tonic-gate  *
78*0Sstevel@tonic-gate  * @param       arg
79*0Sstevel@tonic-gate  *              pointer to the request_t struct to free
80*0Sstevel@tonic-gate  */
81*0Sstevel@tonic-gate extern void free_request(void *arg);
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate /*
84*0Sstevel@tonic-gate  * Set the disk set at the top of the request hierarchy
85*0Sstevel@tonic-gate  *
86*0Sstevel@tonic-gate  * @param       request
87*0Sstevel@tonic-gate  *              The request_t representing the request to modify
88*0Sstevel@tonic-gate  *
89*0Sstevel@tonic-gate  * @param       diskset
90*0Sstevel@tonic-gate  *              The devconfig_t representing the toplevel (disk set)
91*0Sstevel@tonic-gate  *              device in the volume request hierarchy
92*0Sstevel@tonic-gate  */
93*0Sstevel@tonic-gate extern void request_set_diskset_req(request_t *request, devconfig_t *diskset);
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate /*
96*0Sstevel@tonic-gate  * Get the disk set at the top of the request hierarchy
97*0Sstevel@tonic-gate  *
98*0Sstevel@tonic-gate  * @param       request
99*0Sstevel@tonic-gate  *              The request_t representing the request to examine
100*0Sstevel@tonic-gate  *
101*0Sstevel@tonic-gate  * @return      The devconfig_t representing the toplevel (disk set)
102*0Sstevel@tonic-gate  *              device in the volume request hierarchy
103*0Sstevel@tonic-gate  */
104*0Sstevel@tonic-gate extern devconfig_t *request_get_diskset_req(request_t *request);
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate /*
107*0Sstevel@tonic-gate  * Set/get the disk set at the top of the proposed volume hierarchy
108*0Sstevel@tonic-gate  *
109*0Sstevel@tonic-gate  * @param       request
110*0Sstevel@tonic-gate  *              The request_t representing the request to modify
111*0Sstevel@tonic-gate  *
112*0Sstevel@tonic-gate  * @param       diskset
113*0Sstevel@tonic-gate  *              The devconfig_t representing the toplevel (disk set)
114*0Sstevel@tonic-gate  *              device in the proposed volume hierarchy
115*0Sstevel@tonic-gate  */
116*0Sstevel@tonic-gate extern void request_set_diskset_config(
117*0Sstevel@tonic-gate 	request_t *request, devconfig_t *diskset);
118*0Sstevel@tonic-gate 
119*0Sstevel@tonic-gate /*
120*0Sstevel@tonic-gate  * Get the disk set at the top of the request hierarchy
121*0Sstevel@tonic-gate  *
122*0Sstevel@tonic-gate  * @param       request
123*0Sstevel@tonic-gate  *              The request_t representing the request to examine
124*0Sstevel@tonic-gate  *
125*0Sstevel@tonic-gate  * @return      The devconfig_t representing the toplevel (disk set)
126*0Sstevel@tonic-gate  *              device in the proposed volume hierarchy
127*0Sstevel@tonic-gate  */
128*0Sstevel@tonic-gate extern devconfig_t *request_get_diskset_config(request_t *request);
129*0Sstevel@tonic-gate 
130*0Sstevel@tonic-gate #ifdef __cplusplus
131*0Sstevel@tonic-gate }
132*0Sstevel@tonic-gate #endif
133*0Sstevel@tonic-gate 
134*0Sstevel@tonic-gate #endif /* _VOLUME_REQUEST_H */
135