Home | History | Annotate | Download | only in common
      1  0  stevel /*
      2  0  stevel  * CDDL HEADER START
      3  0  stevel  *
      4  0  stevel  * The contents of this file are subject to the terms of the
      5  0  stevel  * Common Development and Distribution License, Version 1.0 only
      6  0  stevel  * (the "License").  You may not use this file except in compliance
      7  0  stevel  * with the License.
      8  0  stevel  *
      9  0  stevel  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
     10  0  stevel  * or http://www.opensolaris.org/os/licensing.
     11  0  stevel  * See the License for the specific language governing permissions
     12  0  stevel  * and limitations under the License.
     13  0  stevel  *
     14  0  stevel  * When distributing Covered Code, include this CDDL HEADER in each
     15  0  stevel  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     16  0  stevel  * If applicable, add the following below this CDDL HEADER, with the
     17  0  stevel  * fields enclosed by brackets "[]" replaced with your own identifying
     18  0  stevel  * information: Portions Copyright [yyyy] [name of copyright owner]
     19  0  stevel  *
     20  0  stevel  * CDDL HEADER END
     21  0  stevel  */
     22  0  stevel /*
     23  0  stevel  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
     24  0  stevel  * Use is subject to license terms.
     25  0  stevel  */
     26  0  stevel 
     27  0  stevel #ifndef	_POOL_XML_IMPL_H
     28  0  stevel #define	_POOL_XML_IMPL_H
     29  0  stevel 
     30  0  stevel #pragma ident	"%Z%%M%	%I%	%E% SMI"
     31  0  stevel 
     32  0  stevel #ifdef	__cplusplus
     33  0  stevel extern "C" {
     34  0  stevel #endif
     35  0  stevel 
     36  0  stevel /*
     37  0  stevel  * This file contains the definitions of types and supporting
     38  0  stevel  * functions to implement the libpool XML specific data manipulation
     39  0  stevel  * facility.
     40  0  stevel  *
     41  0  stevel  * For more information on the libpool generic data manipulation
     42  0  stevel  * facility, look at pool_impl.h.
     43  0  stevel  *
     44  0  stevel  * The central types for the generic data representation/storage
     45  0  stevel  * facility are here enhanced to provide additional XML specific
     46  0  stevel  * information.
     47  0  stevel  */
     48  0  stevel 
     49  0  stevel /*
     50  0  stevel  * pool_xml_elem_t is the XML (to be precise, libxml - although this
     51  0  stevel  * could be easily ported to an alternative C-API xml library)
     52  0  stevel  * specific representation of the pool_elem_t structure.
     53  0  stevel  *
     54  0  stevel  * The pxe_node pointer is a pointer to an XML element which
     55  0  stevel  * represents the element in the XML document
     56  0  stevel  */
     57  0  stevel typedef struct pool_xml_elem {
     58  0  stevel 	/*
     59  0  stevel 	 * Common to pool_elem_t
     60  0  stevel 	 */
     61  0  stevel 	pool_elem_t pxe_elem;
     62  0  stevel 	void *pxe_pad1;
     63  0  stevel 	void *pxe_pad2;
     64  0  stevel 	/*
     65  0  stevel 	 * Common to pool_xml_elem_t
     66  0  stevel 	 */
     67  0  stevel 	xmlNodePtr pxe_node;				/* XML Element */
     68  0  stevel } pool_xml_elem_t;
     69  0  stevel 
     70  0  stevel typedef pool_xml_elem_t pool_xml_system_t;
     71  0  stevel 
     72  0  stevel typedef struct pool_xml_resource  {
     73  0  stevel 	/*
     74  0  stevel 	 * Common to pool_elem_t
     75  0  stevel 	 */
     76  0  stevel 	pool_elem_t pxe_elem;
     77  0  stevel 	/*
     78  0  stevel 	 * Specific to pool_resource_t
     79  0  stevel 	 */
     80  0  stevel 	int (*pr_is_system)(const pool_resource_t *);
     81  0  stevel 	int (*pr_can_associate)(const pool_resource_t *);
     82  0  stevel 	/*
     83  0  stevel 	 * Common to pool_xml_elem_t
     84  0  stevel 	 */
     85  0  stevel 	xmlNodePtr pxe_node;				/* XML Element */
     86  0  stevel } pool_xml_resource_t;
     87  0  stevel 
     88  0  stevel typedef struct pool_xml_pool {
     89  0  stevel 	/*
     90  0  stevel 	 * Common to pool_elem_t
     91  0  stevel 	 */
     92  0  stevel 	pool_elem_t pxe_elem;
     93  0  stevel 	/*
     94  0  stevel 	 * Specific to pool_t
     95  0  stevel 	 */
     96  0  stevel 	int (*pp_associate)(pool_t *, const pool_resource_t *);
     97  0  stevel 	int (*pp_dissociate)(pool_t *, const pool_resource_t *);
     98  0  stevel 	/*
     99  0  stevel 	 * Common to pool_xml_elem_t
    100  0  stevel 	 */
    101  0  stevel 	xmlNodePtr pxe_node;				/* XML Element */
    102  0  stevel } pool_xml_pool_t;
    103  0  stevel 
    104  0  stevel typedef pool_xml_elem_t pool_xml_component_t;
    105  0  stevel 
    106  0  stevel /*
    107  0  stevel  * pool_xml_result_set_t is the XML (to be precise, libxml - although
    108  0  stevel  * this could be easily ported to an alternative C-API xml library)
    109  0  stevel  * specific representation of the pool_result_set_t structure.
    110  0  stevel  *
    111  0  stevel  * The pxr_ctx member is a pointer to an XML XPath Context which
    112  0  stevel  * represents the context in which this result set is valid. AN
    113  0  stevel  * alternative way of thinking about this is to envisage the context
    114  0  stevel  * as the root of the search which is used to build the result set.
    115  0  stevel  *
    116  0  stevel  * The pxr_path member is a pointer to the compiled XPath statement
    117  0  stevel  * used to generate this result set.
    118  0  stevel  *
    119  0  stevel  * The prs_index member is a cursor into the result set and is used by
    120  0  stevel  * the various result set functions to determine which result set
    121  0  stevel  * member to access.
    122  0  stevel  *
    123  0  stevel  */
    124  0  stevel typedef struct pool_xml_result_set {
    125  0  stevel 	const pool_conf_t *prs_conf;			/* Configuration */
    126  0  stevel 	int prs_active;					/* Query active? */
    127  0  stevel 	int prs_index;					/* Result Index */
    128  0  stevel 	pool_elem_t *(*prs_next)(pool_result_set_t *);
    129  0  stevel 	pool_elem_t *(*prs_prev)(pool_result_set_t *);
    130  0  stevel 	pool_elem_t *(*prs_first)(pool_result_set_t *);
    131  0  stevel 	pool_elem_t *(*prs_last)(pool_result_set_t *);
    132  0  stevel 	int (*prs_set_index)(pool_result_set_t *, int);
    133  0  stevel 	int (*prs_get_index)(pool_result_set_t *);
    134  0  stevel 	int (*prs_close)(pool_result_set_t *);
    135  0  stevel 	int (*prs_count)(pool_result_set_t *);
    136  0  stevel 	/*
    137  0  stevel 	 * End of common part
    138  0  stevel 	 */
    139  0  stevel 	xmlXPathContextPtr pxr_ctx;			/* Result Context */
    140  0  stevel 	xmlXPathObjectPtr pxr_path;			/* Result Path Object */
    141  0  stevel } pool_xml_result_set_t;
    142  0  stevel 
    143  0  stevel /*
    144  0  stevel  * pool_xml_connection_t is the XML (to be precise, libxml - although
    145  0  stevel  * this could be easily ported to an alternative C-API xml library)
    146  0  stevel  * specific representation of the pool_result_set_t structure.
    147  0  stevel  *
    148  0  stevel  * The pxc_doc member is a pointer to an XML document structure which
    149  0  stevel  * contains information about the XML document which acts as the data
    150  0  stevel  * store for this connection.
    151  0  stevel  *
    152  0  stevel  * The pxc_file member is a FILE pointer to the data file used to
    153  0  stevel  * store the XML document.
    154  0  stevel  *
    155  0  stevel  * The pxc_oflags member is the OR'd list of options specified when
    156  0  stevel  * opening this connection.
    157  0  stevel  *
    158  0  stevel  * The pxc_cleanup member is a boolean flag indicating whether a
    159  0  stevel  * configuration has a backup which needs to be cleaned up. This is
    160  0  stevel  * used as a means of providing resilient configuration changes in the
    161  0  stevel  * face of potential failure.
    162  0  stevel  *
    163  0  stevel  */
    164  0  stevel typedef struct pool_xml_connection {
    165  0  stevel 	const char *pc_name;				/* Provider name */
    166  0  stevel 	int pc_store_type;				/* Datastore type */
    167  0  stevel 	int pc_oflags;					/* Open flags */
    168  0  stevel 	int (*pc_close)(pool_conf_t *);
    169  0  stevel 	int (*pc_validate)(const pool_conf_t *, pool_valid_level_t);
    170  0  stevel 	int (*pc_commit)(pool_conf_t *);
    171  0  stevel 	int (*pc_export)(const pool_conf_t *, const char *,
    172  0  stevel 	    pool_export_format_t);
    173  0  stevel 	int (*pc_rollback)(pool_conf_t *);
    174  0  stevel 	pool_result_set_t *(*pc_exec_query)(const pool_conf_t *,
    175  0  stevel 	    const pool_elem_t *, const char *,
    176  0  stevel 	    pool_elem_class_t, pool_value_t **);
    177  0  stevel 	pool_elem_t *(*pc_elem_create)(pool_conf_t *, pool_elem_class_t,
    178  0  stevel 	    pool_resource_elem_class_t, pool_component_elem_class_t);
    179  0  stevel 	int (*pc_remove)(pool_conf_t *);
    180  0  stevel 	int (*pc_res_xfer)(pool_resource_t *, pool_resource_t *, uint64_t);
    181  0  stevel 	int (*pc_res_xxfer)(pool_resource_t *, pool_resource_t *,
    182  0  stevel 	    pool_component_t **);
    183  0  stevel 	char *(*pc_get_binding)(pool_conf_t *, pid_t);
    184  0  stevel 	int (*pc_set_binding)(pool_conf_t *, const char *, idtype_t, id_t);
    185  0  stevel 	char *(*pc_get_resource_binding)(pool_conf_t *,
    186  0  stevel 	    pool_resource_elem_class_t, pid_t);
    187  0  stevel 	/*
    188  0  stevel 	 * End of common part
    189  0  stevel 	 */
    190  0  stevel 	xmlDocPtr pxc_doc;				/* XML document */
    191  0  stevel 	FILE *pxc_file;					/* XML File */
    192  0  stevel } pool_xml_connection_t;
    193  0  stevel 
    194  0  stevel #ifdef	__cplusplus
    195  0  stevel }
    196  0  stevel #endif
    197  0  stevel 
    198  0  stevel #endif	/* _POOL_XML_IMPL_H */
    199