exec/objdb.h

   1 /*
   2  * Copyright (c) 2006 MontaVista Software, Inc.
   3  *
   4  * All rights reserved.
   5  *
   6  * Author: Steven Dake (sdake@mvista.com)
   7  *
   8  * This software licensed under BSD license, the text of which follows:
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  *
  13  * - Redistributions of source code must retain the above copyright notice,
  14  *   this list of conditions and the following disclaimer.
  15  * - Redistributions in binary form must reproduce the above copyright notice,
  16  *   this list of conditions and the following disclaimer in the documentation
  17  *   and/or other materials provided with the distribution.
  18  * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19  *   contributors may be used to endorse or promote products derived from this
  20  *   software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32  * THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef OBJDB_H_DEFINED
  36 #define OBJDB_H_DEFINED
  37
  38 #define OBJECT_PARENT_HANDLE 0
  39
  40 #include <stdio.h>
  41
  42 struct object_valid {
  43         char *object_name;
  44         int object_len;
  45 };
  46
  47 struct object_key_valid {
  48         char *key_name;
  49         int key_len;
  50         int (*validate_callback) (void *key, int key_len, void *value, int value_len);
  51 };
  52
  53 struct objdb_iface_ver0 {
  54         int (*objdb_init) (void);
  55
  56         int (*object_create) (
  57                 unsigned int parent_object_handle,
  58                 unsigned int *object_handle,
  59                 void *object_name,
  60                 unsigned int object_name_len);
  61
  62         int (*object_priv_set) (
  63                 unsigned int object_handle,
  64                 void *priv);
  65
  66         int (*object_key_create) (
  67                 unsigned int object_handle,
  68                 void *key_name,
  69                 int key_len,
  70                 void *value,
  71                 int value_len);
  72
  73         int (*object_destroy) (
  74                 unsigned int object_handle);
  75
  76         int (*object_valid_set) (
  77                 unsigned int object_handle,
  78                 struct object_valid *object_valid_list,
  79                 unsigned int object_valid_list_entries);
  80
  81         int (*object_key_valid_set) (
  82                 unsigned int object_handle,
  83                 struct object_key_valid *object_key_valid_list,
  84                 unsigned int object_key_valid_list_entries);
  85
  86         int (*object_find_reset) (
  87                 unsigned int parent_object_handle);
  88
  89         int (*object_find) (
  90                 unsigned int parent_object_handle,
  91                 void *object_name,
  92                 int object_name_len,
  93                 unsigned int *object_handle);
  94
  95         int (*object_key_get) (
  96                 unsigned int object_handle,
  97                 void *key_name,
  98                 int key_len,
  99                 void **value,
 100                 int *value_len);
 101
 102         int (*object_priv_get) (
 103                 unsigned int jobject_handle,
 104                 void **priv);
 105
 106         int (*object_key_replace) (
 107                 unsigned int object_handle,
 108                 void *key_name,
 109                 int key_len,
 110                 void *old_value,
 111                 int old_value_len,
 112                 void *new_value,
 113                 int new_value_len);
 114
 115         int (*object_key_delete) (
 116                 unsigned int object_handle,
 117                 void *key_name,
 118                 int key_len,
 119                 void *value,
 120                 int value_len);
 121
 122         int (*object_iter_reset) (
 123                 unsigned int parent_object_handle);
 124
 125         int (*object_iter) (
 126                 unsigned int parent_object_handle,
 127                 void **object_name,
 128                 int *name_len,
 129                 unsigned int *object_handle);
 130
 131         int (*object_key_iter_reset) (
 132                 unsigned int object_handle);
 133
 134         int (*object_key_iter) (
 135                 unsigned int parent_object_handle,
 136                 void **key_name,
 137                 int *key_len,
 138                 void **value,
 139                 int *value_len);
 140
 141         int (*object_parent_get) (
 142                 unsigned int object_handle,
 143                 unsigned int *parent_handle);
 144
 145         int (*object_dump) (
 146                 unsigned int object_handle,
 147                 FILE *file);
 148
 149         int (*object_find_from) (
 150                 unsigned int parent_object_handle,
 151                 unsigned int start_pos,
 152                 void *object_name,
 153                 int object_name_len,
 154                 unsigned int *object_handle,
 155                 unsigned int *next_pos);
 156
 157         int (*object_iter_from) (
 158                 unsigned int parent_object_handle,
 159                 unsigned int start_pos,
 160                 void **object_name,
 161                 int *name_len,
 162                 unsigned int *object_handle);
 163
 164         int (*object_key_iter_from) (
 165                 unsigned int parent_object_handle,
 166                 unsigned int start_pos,
 167                 void **key_name,
 168                 int *key_len,
 169                 void **value,
 170                 int *value_len);
 171
 172         int (*object_write_config) (char **error_string);
 173 };
 174
 175 #endif /* OBJDB_H_DEFINED */