1*7c478bd9Sstevel@tonic-gate /* 2*7c478bd9Sstevel@tonic-gate * CDDL HEADER START 3*7c478bd9Sstevel@tonic-gate * 4*7c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*7c478bd9Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only 6*7c478bd9Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance 7*7c478bd9Sstevel@tonic-gate * with the License. 8*7c478bd9Sstevel@tonic-gate * 9*7c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*7c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 11*7c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 12*7c478bd9Sstevel@tonic-gate * and limitations under the License. 13*7c478bd9Sstevel@tonic-gate * 14*7c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 15*7c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*7c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 17*7c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 18*7c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 19*7c478bd9Sstevel@tonic-gate * 20*7c478bd9Sstevel@tonic-gate * CDDL HEADER END 21*7c478bd9Sstevel@tonic-gate */ 22*7c478bd9Sstevel@tonic-gate /* 23*7c478bd9Sstevel@tonic-gate * Copyright 2003 Sun Microsystems, Inc. All rights reserved. 24*7c478bd9Sstevel@tonic-gate * Use is subject to license terms. 25*7c478bd9Sstevel@tonic-gate */ 26*7c478bd9Sstevel@tonic-gate 27*7c478bd9Sstevel@tonic-gate #ifndef _XML_CONVERT_H 28*7c478bd9Sstevel@tonic-gate #define _XML_CONVERT_H 29*7c478bd9Sstevel@tonic-gate 30*7c478bd9Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 31*7c478bd9Sstevel@tonic-gate 32*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 33*7c478bd9Sstevel@tonic-gate extern "C" { 34*7c478bd9Sstevel@tonic-gate #endif 35*7c478bd9Sstevel@tonic-gate 36*7c478bd9Sstevel@tonic-gate #include <libxml/parser.h> 37*7c478bd9Sstevel@tonic-gate #include "volume_request.h" 38*7c478bd9Sstevel@tonic-gate #include "volume_defaults.h" 39*7c478bd9Sstevel@tonic-gate 40*7c478bd9Sstevel@tonic-gate /* The location of the volume-request.dtd */ 41*7c478bd9Sstevel@tonic-gate #define VOLUME_REQUEST_DTD_LOC "/usr/share/lib/xml/dtd/volume-request.dtd" 42*7c478bd9Sstevel@tonic-gate 43*7c478bd9Sstevel@tonic-gate /* The location of the volume-request-defaults.dtd */ 44*7c478bd9Sstevel@tonic-gate #define VOLUME_DEFAULTS_DTD_LOC "/usr/share/lib/xml/dtd/volume-defaults.dtd" 45*7c478bd9Sstevel@tonic-gate 46*7c478bd9Sstevel@tonic-gate /* The location of the volume-config.dtd */ 47*7c478bd9Sstevel@tonic-gate #define VOLUME_CONFIG_DTD_LOC "/usr/share/lib/xml/dtd/volume-config.dtd" 48*7c478bd9Sstevel@tonic-gate 49*7c478bd9Sstevel@tonic-gate /* Location of the volume-command.xsl file */ 50*7c478bd9Sstevel@tonic-gate #define VOLUME_COMMAND_XSL_LOC "/usr/share/lib/xml/style/volume-command.xsl" 51*7c478bd9Sstevel@tonic-gate 52*7c478bd9Sstevel@tonic-gate /* 53*7c478bd9Sstevel@tonic-gate * Valid values for attributes 54*7c478bd9Sstevel@tonic-gate */ 55*7c478bd9Sstevel@tonic-gate #define VALID_ATTR_TRUE "TRUE" 56*7c478bd9Sstevel@tonic-gate #define VALID_ATTR_FALSE "FALSE" 57*7c478bd9Sstevel@tonic-gate #define VALID_MIRROR_READ_GEOMETRIC "GEOMETRIC" 58*7c478bd9Sstevel@tonic-gate #define VALID_MIRROR_READ_FIRST "FIRST" 59*7c478bd9Sstevel@tonic-gate #define VALID_MIRROR_READ_ROUNDROBIN "ROUNDROBIN" 60*7c478bd9Sstevel@tonic-gate #define VALID_MIRROR_WRITE_SERIAL "SERIAL" 61*7c478bd9Sstevel@tonic-gate #define VALID_MIRROR_WRITE_PARALLEL "PARALLEL" 62*7c478bd9Sstevel@tonic-gate 63*7c478bd9Sstevel@tonic-gate /* 64*7c478bd9Sstevel@tonic-gate * Standard units 65*7c478bd9Sstevel@tonic-gate */ 66*7c478bd9Sstevel@tonic-gate #define UNIT_BLOCKS "BLOCKS" 67*7c478bd9Sstevel@tonic-gate #define UNIT_KILOBYTES "KB" 68*7c478bd9Sstevel@tonic-gate #define UNIT_MEGABYTES "MB" 69*7c478bd9Sstevel@tonic-gate #define UNIT_GIGABYTES "GB" 70*7c478bd9Sstevel@tonic-gate #define UNIT_TERABYTES "TB" 71*7c478bd9Sstevel@tonic-gate 72*7c478bd9Sstevel@tonic-gate /* 73*7c478bd9Sstevel@tonic-gate * Initialize the XML parser, setting defaults across all XML 74*7c478bd9Sstevel@tonic-gate * routines. 75*7c478bd9Sstevel@tonic-gate */ 76*7c478bd9Sstevel@tonic-gate extern void init_xml(); 77*7c478bd9Sstevel@tonic-gate 78*7c478bd9Sstevel@tonic-gate /* 79*7c478bd9Sstevel@tonic-gate * Clean up any remaining structures before exiting. 80*7c478bd9Sstevel@tonic-gate */ 81*7c478bd9Sstevel@tonic-gate extern void cleanup_xml(); 82*7c478bd9Sstevel@tonic-gate 83*7c478bd9Sstevel@tonic-gate /* 84*7c478bd9Sstevel@tonic-gate * Converts a volume-request XML document into a request_t. 85*7c478bd9Sstevel@tonic-gate * 86*7c478bd9Sstevel@tonic-gate * @param doc 87*7c478bd9Sstevel@tonic-gate * an existing volume-request XML document 88*7c478bd9Sstevel@tonic-gate * 89*7c478bd9Sstevel@tonic-gate * @param request 90*7c478bd9Sstevel@tonic-gate * RETURN: a new request_t which must be freed via 91*7c478bd9Sstevel@tonic-gate * free_request 92*7c478bd9Sstevel@tonic-gate * 93*7c478bd9Sstevel@tonic-gate * @return 0 on success, non-zero otherwise. 94*7c478bd9Sstevel@tonic-gate */ 95*7c478bd9Sstevel@tonic-gate extern int xml_to_request(xmlDocPtr doc, request_t **request); 96*7c478bd9Sstevel@tonic-gate 97*7c478bd9Sstevel@tonic-gate /* 98*7c478bd9Sstevel@tonic-gate * Converts a volume-defaults XML document into a defaults_t. 99*7c478bd9Sstevel@tonic-gate * 100*7c478bd9Sstevel@tonic-gate * @param doc 101*7c478bd9Sstevel@tonic-gate * an existing volume-defaults XML document 102*7c478bd9Sstevel@tonic-gate * 103*7c478bd9Sstevel@tonic-gate * @param defaults 104*7c478bd9Sstevel@tonic-gate * RETURN: a new defaults_t which must be freed via 105*7c478bd9Sstevel@tonic-gate * free_defaults 106*7c478bd9Sstevel@tonic-gate * 107*7c478bd9Sstevel@tonic-gate * @return 0 on success, non-zero otherwise. 108*7c478bd9Sstevel@tonic-gate */ 109*7c478bd9Sstevel@tonic-gate extern int xml_to_defaults(xmlDocPtr doc, defaults_t **defaults); 110*7c478bd9Sstevel@tonic-gate 111*7c478bd9Sstevel@tonic-gate /* 112*7c478bd9Sstevel@tonic-gate * Converts a volume-config XML document into a devconfig_t. 113*7c478bd9Sstevel@tonic-gate * 114*7c478bd9Sstevel@tonic-gate * @param doc 115*7c478bd9Sstevel@tonic-gate * an existing volume-config XML document 116*7c478bd9Sstevel@tonic-gate * 117*7c478bd9Sstevel@tonic-gate * @param config 118*7c478bd9Sstevel@tonic-gate * RETURN: a new devconfig_t which must be freed via 119*7c478bd9Sstevel@tonic-gate * free_devconfig 120*7c478bd9Sstevel@tonic-gate * 121*7c478bd9Sstevel@tonic-gate * @return 0 on success, non-zero otherwise. 122*7c478bd9Sstevel@tonic-gate */ 123*7c478bd9Sstevel@tonic-gate extern int xml_to_config(xmlDocPtr doc, devconfig_t **config); 124*7c478bd9Sstevel@tonic-gate 125*7c478bd9Sstevel@tonic-gate /* 126*7c478bd9Sstevel@tonic-gate * Converts a devconfig_t into a volume-config XML document. 127*7c478bd9Sstevel@tonic-gate * 128*7c478bd9Sstevel@tonic-gate * @param config 129*7c478bd9Sstevel@tonic-gate * an existing devconfig_t representing a volume 130*7c478bd9Sstevel@tonic-gate * configuration. 131*7c478bd9Sstevel@tonic-gate * 132*7c478bd9Sstevel@tonic-gate * @param doc 133*7c478bd9Sstevel@tonic-gate * RETURN: a new volume-config XML document which must be 134*7c478bd9Sstevel@tonic-gate * freed via xmlFreeDoc 135*7c478bd9Sstevel@tonic-gate * 136*7c478bd9Sstevel@tonic-gate * @return 0 on success, non-zero otherwise. 137*7c478bd9Sstevel@tonic-gate */ 138*7c478bd9Sstevel@tonic-gate extern int config_to_xml(devconfig_t *config, xmlDocPtr *doc); 139*7c478bd9Sstevel@tonic-gate 140*7c478bd9Sstevel@tonic-gate /* 141*7c478bd9Sstevel@tonic-gate * Converts a volume-config XML document into a Bourne shell script. 142*7c478bd9Sstevel@tonic-gate * 143*7c478bd9Sstevel@tonic-gate * @param doc 144*7c478bd9Sstevel@tonic-gate * an existing volume-config XML document 145*7c478bd9Sstevel@tonic-gate * 146*7c478bd9Sstevel@tonic-gate * @param commands 147*7c478bd9Sstevel@tonic-gate * RETURN: a new char* which must be freed 148*7c478bd9Sstevel@tonic-gate * 149*7c478bd9Sstevel@tonic-gate * @return 0 on success, non-zero otherwise. 150*7c478bd9Sstevel@tonic-gate */ 151*7c478bd9Sstevel@tonic-gate extern int xml_to_commands(xmlDocPtr doc, char **commands); 152*7c478bd9Sstevel@tonic-gate 153*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 154*7c478bd9Sstevel@tonic-gate } 155*7c478bd9Sstevel@tonic-gate #endif 156*7c478bd9Sstevel@tonic-gate 157*7c478bd9Sstevel@tonic-gate #endif /* _XML_CONVERT_H */ 158