xref: /onnv-gate/usr/src/cmd/lvm/metassist/xml/xml_convert.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 _XML_CONVERT_H
28*0Sstevel@tonic-gate #define	_XML_CONVERT_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 <libxml/parser.h>
37*0Sstevel@tonic-gate #include "volume_request.h"
38*0Sstevel@tonic-gate #include "volume_defaults.h"
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate /* The location of the volume-request.dtd */
41*0Sstevel@tonic-gate #define	VOLUME_REQUEST_DTD_LOC	"/usr/share/lib/xml/dtd/volume-request.dtd"
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate /* The location of the volume-request-defaults.dtd */
44*0Sstevel@tonic-gate #define	VOLUME_DEFAULTS_DTD_LOC	"/usr/share/lib/xml/dtd/volume-defaults.dtd"
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate /* The location of the volume-config.dtd */
47*0Sstevel@tonic-gate #define	VOLUME_CONFIG_DTD_LOC	"/usr/share/lib/xml/dtd/volume-config.dtd"
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate /* Location of the volume-command.xsl file */
50*0Sstevel@tonic-gate #define	VOLUME_COMMAND_XSL_LOC	"/usr/share/lib/xml/style/volume-command.xsl"
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * Valid values for attributes
54*0Sstevel@tonic-gate  */
55*0Sstevel@tonic-gate #define	VALID_ATTR_TRUE			"TRUE"
56*0Sstevel@tonic-gate #define	VALID_ATTR_FALSE		"FALSE"
57*0Sstevel@tonic-gate #define	VALID_MIRROR_READ_GEOMETRIC	"GEOMETRIC"
58*0Sstevel@tonic-gate #define	VALID_MIRROR_READ_FIRST		"FIRST"
59*0Sstevel@tonic-gate #define	VALID_MIRROR_READ_ROUNDROBIN	"ROUNDROBIN"
60*0Sstevel@tonic-gate #define	VALID_MIRROR_WRITE_SERIAL	"SERIAL"
61*0Sstevel@tonic-gate #define	VALID_MIRROR_WRITE_PARALLEL	"PARALLEL"
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate /*
64*0Sstevel@tonic-gate  * Standard units
65*0Sstevel@tonic-gate  */
66*0Sstevel@tonic-gate #define	UNIT_BLOCKS	"BLOCKS"
67*0Sstevel@tonic-gate #define	UNIT_KILOBYTES	"KB"
68*0Sstevel@tonic-gate #define	UNIT_MEGABYTES	"MB"
69*0Sstevel@tonic-gate #define	UNIT_GIGABYTES	"GB"
70*0Sstevel@tonic-gate #define	UNIT_TERABYTES	"TB"
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate /*
73*0Sstevel@tonic-gate  * Initialize the XML parser, setting defaults across all XML
74*0Sstevel@tonic-gate  * routines.
75*0Sstevel@tonic-gate  */
76*0Sstevel@tonic-gate extern void init_xml();
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate /*
79*0Sstevel@tonic-gate  * Clean up any remaining structures before exiting.
80*0Sstevel@tonic-gate  */
81*0Sstevel@tonic-gate extern void cleanup_xml();
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate /*
84*0Sstevel@tonic-gate  * Converts a volume-request XML document into a request_t.
85*0Sstevel@tonic-gate  *
86*0Sstevel@tonic-gate  * @param       doc
87*0Sstevel@tonic-gate  *		an existing volume-request XML document
88*0Sstevel@tonic-gate  *
89*0Sstevel@tonic-gate  * @param       request
90*0Sstevel@tonic-gate  *		RETURN: a new request_t which must be freed via
91*0Sstevel@tonic-gate  *		free_request
92*0Sstevel@tonic-gate  *
93*0Sstevel@tonic-gate  * @return      0 on success, non-zero otherwise.
94*0Sstevel@tonic-gate  */
95*0Sstevel@tonic-gate extern int xml_to_request(xmlDocPtr doc, request_t **request);
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * Converts a volume-defaults XML document into a defaults_t.
99*0Sstevel@tonic-gate  *
100*0Sstevel@tonic-gate  * @param       doc
101*0Sstevel@tonic-gate  *		an existing volume-defaults XML document
102*0Sstevel@tonic-gate  *
103*0Sstevel@tonic-gate  * @param       defaults
104*0Sstevel@tonic-gate  *		RETURN: a new defaults_t which must be freed via
105*0Sstevel@tonic-gate  *		free_defaults
106*0Sstevel@tonic-gate  *
107*0Sstevel@tonic-gate  * @return      0 on success, non-zero otherwise.
108*0Sstevel@tonic-gate  */
109*0Sstevel@tonic-gate extern int xml_to_defaults(xmlDocPtr doc, defaults_t **defaults);
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate /*
112*0Sstevel@tonic-gate  * Converts a volume-config XML document into a devconfig_t.
113*0Sstevel@tonic-gate  *
114*0Sstevel@tonic-gate  * @param       doc
115*0Sstevel@tonic-gate  *		an existing volume-config XML document
116*0Sstevel@tonic-gate  *
117*0Sstevel@tonic-gate  * @param       config
118*0Sstevel@tonic-gate  *		RETURN: a new devconfig_t which must be freed via
119*0Sstevel@tonic-gate  *		free_devconfig
120*0Sstevel@tonic-gate  *
121*0Sstevel@tonic-gate  * @return      0 on success, non-zero otherwise.
122*0Sstevel@tonic-gate  */
123*0Sstevel@tonic-gate extern int xml_to_config(xmlDocPtr doc, devconfig_t **config);
124*0Sstevel@tonic-gate 
125*0Sstevel@tonic-gate /*
126*0Sstevel@tonic-gate  * Converts a devconfig_t into a volume-config XML document.
127*0Sstevel@tonic-gate  *
128*0Sstevel@tonic-gate  * @param       config
129*0Sstevel@tonic-gate  *		an existing devconfig_t representing a volume
130*0Sstevel@tonic-gate  *		configuration.
131*0Sstevel@tonic-gate  *
132*0Sstevel@tonic-gate  * @param       doc
133*0Sstevel@tonic-gate  *		RETURN: a new volume-config XML document which must be
134*0Sstevel@tonic-gate  *		freed via xmlFreeDoc
135*0Sstevel@tonic-gate  *
136*0Sstevel@tonic-gate  * @return      0 on success, non-zero otherwise.
137*0Sstevel@tonic-gate  */
138*0Sstevel@tonic-gate extern int config_to_xml(devconfig_t *config, xmlDocPtr *doc);
139*0Sstevel@tonic-gate 
140*0Sstevel@tonic-gate /*
141*0Sstevel@tonic-gate  * Converts a volume-config XML document into a Bourne shell script.
142*0Sstevel@tonic-gate  *
143*0Sstevel@tonic-gate  * @param       doc
144*0Sstevel@tonic-gate  *		an existing volume-config XML document
145*0Sstevel@tonic-gate  *
146*0Sstevel@tonic-gate  * @param       commands
147*0Sstevel@tonic-gate  *		RETURN: a new char* which must be freed
148*0Sstevel@tonic-gate  *
149*0Sstevel@tonic-gate  * @return      0 on success, non-zero otherwise.
150*0Sstevel@tonic-gate  */
151*0Sstevel@tonic-gate extern int xml_to_commands(xmlDocPtr doc, char **commands);
152*0Sstevel@tonic-gate 
153*0Sstevel@tonic-gate #ifdef __cplusplus
154*0Sstevel@tonic-gate }
155*0Sstevel@tonic-gate #endif
156*0Sstevel@tonic-gate 
157*0Sstevel@tonic-gate #endif /* _XML_CONVERT_H */
158