lib/base/heimbase.h

   1 /*
   2  * Copyright (c) 2010 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Portions Copyright (c) 2010 Apple Inc. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the Institute nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #ifndef HEIM_BASE_H
  37 #define HEIM_BASE_H 1
  38
  39 #include <sys/types.h>
  40 #include <krb5-types.h>
  41 #include <stdarg.h>
  42 #ifdef HAVE_STDBOOL_H
  43 #include <stdbool.h>
  44 #else
  45 #ifndef false
  46 #define false 0
  47 #endif
  48 #ifndef true
  49 #define true 1
  50 #endif
  51 #endif
  52
  53 #define HEIM_BASE_API_VERSION 20130210
  54
  55 typedef void * heim_object_t;
  56 typedef unsigned int heim_tid_t;
  57 typedef heim_object_t heim_bool_t;
  58 typedef heim_object_t heim_null_t;
  59 #define HEIM_BASE_ONCE_INIT 0
  60 typedef long heim_base_once_t; /* XXX arch dependant */
  61
  62 #if !defined(__has_extension)
  63 #define __has_extension(x) 0
  64 #endif
  65
  66 #define HEIM_REQUIRE_GNUC(m,n,p) \
  67     (((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__) >= \
  68      (((m) * 10000) + ((n) * 100) + (p)))
  69
  70
  71 #if __has_extension(__builtin_expect) || HEIM_REQUIRE_GNUC(3,0,0)
  72 #define heim_builtin_expect(_op,_res) __builtin_expect(_op,_res)
  73 #else
  74 #define heim_builtin_expect(_op,_res) (_op)
  75 #endif
  76
  77
  78 void *  heim_retain(heim_object_t);
  79 void    heim_release(heim_object_t);
  80
  81 void    heim_show(heim_object_t);
  82
  83 typedef void (*heim_type_dealloc)(void *);
  84
  85 void *
  86 heim_alloc(size_t size, const char *name, heim_type_dealloc dealloc);
  87
  88 heim_tid_t
  89 heim_get_tid(heim_object_t object);
  90
  91 int
  92 heim_cmp(heim_object_t a, heim_object_t b);
  93
  94 unsigned long
  95 heim_get_hash(heim_object_t ptr);
  96
  97 void
  98 heim_base_once_f(heim_base_once_t *, void *, void (*)(void *));
  99
 100 void
 101 heim_abort(const char *fmt, ...)
 102     HEIMDAL_NORETURN_ATTRIBUTE
 103     HEIMDAL_PRINTF_ATTRIBUTE((printf, 1, 2));
 104
 105 void
 106 heim_abortv(const char *fmt, va_list ap)
 107     HEIMDAL_NORETURN_ATTRIBUTE
 108     HEIMDAL_PRINTF_ATTRIBUTE((printf, 1, 0));
 109
 110 #define heim_assert(e,t) \
 111     (heim_builtin_expect(!(e), 0) ? heim_abort(t ":" #e) : (void)0)
 112
 113 /*
 114  *
 115  */
 116
 117 heim_null_t
 118 heim_null_create(void);
 119
 120 heim_bool_t
 121 heim_bool_create(int);
 122
 123 int
 124 heim_bool_val(heim_bool_t);
 125
 126 /*
 127  * Array
 128  */
 129
 130 typedef struct heim_array_data *heim_array_t;
 131
 132 heim_array_t heim_array_create(void);
 133 heim_tid_t heim_array_get_type_id(void);
 134
 135 typedef void (*heim_array_iterator_f_t)(heim_object_t, void *, int *);
 136 typedef int (*heim_array_filter_f_t)(heim_object_t, void *);
 137
 138 int     heim_array_append_value(heim_array_t, heim_object_t);
 139 int     heim_array_insert_value(heim_array_t, size_t idx, heim_object_t);
 140 void    heim_array_iterate_f(heim_array_t, void *, heim_array_iterator_f_t);
 141 void    heim_array_iterate_reverse_f(heim_array_t, void *, heim_array_iterator_f_t);
 142 #ifdef __BLOCKS__
 143 void    heim_array_iterate(heim_array_t, void (^)(heim_object_t, int *));
 144 void    heim_array_iterate_reverse(heim_array_t, void (^)(heim_object_t, int *));
 145 #endif
 146 size_t  heim_array_get_length(heim_array_t);
 147 heim_object_t
 148         heim_array_get_value(heim_array_t, size_t);
 149 heim_object_t
 150         heim_array_copy_value(heim_array_t, size_t);
 151 void    heim_array_set_value(heim_array_t, size_t, heim_object_t);
 152 void    heim_array_delete_value(heim_array_t, size_t);
 153 void    heim_array_filter_f(heim_array_t, void *, heim_array_filter_f_t);
 154 #ifdef __BLOCKS__
 155 void    heim_array_filter(heim_array_t, int (^)(heim_object_t));
 156 #endif
 157
 158 /*
 159  * Dict
 160  */
 161
 162 typedef struct heim_dict_data *heim_dict_t;
 163
 164 heim_dict_t heim_dict_create(size_t size);
 165 heim_tid_t heim_dict_get_type_id(void);
 166
 167 typedef void (*heim_dict_iterator_f_t)(heim_object_t, heim_object_t, void *);
 168
 169 int     heim_dict_set_value(heim_dict_t, heim_object_t, heim_object_t);
 170 void    heim_dict_iterate_f(heim_dict_t, void *, heim_dict_iterator_f_t);
 171 #ifdef __BLOCKS__
 172 void    heim_dict_iterate(heim_dict_t, void (^)(heim_object_t, heim_object_t));
 173 #endif
 174
 175 heim_object_t
 176         heim_dict_get_value(heim_dict_t, heim_object_t);
 177 heim_object_t
 178         heim_dict_copy_value(heim_dict_t, heim_object_t);
 179 void    heim_dict_delete_key(heim_dict_t, heim_object_t);
 180
 181 /*
 182  * String
 183  */
 184
 185 typedef struct heim_string_data *heim_string_t;
 186 typedef void (*heim_string_free_f_t)(void *);
 187
 188 heim_string_t heim_string_create(const char *);
 189 heim_string_t heim_string_ref_create(const char *, heim_string_free_f_t);
 190 heim_string_t heim_string_create_with_bytes(const void *, size_t);
 191 heim_string_t heim_string_ref_create_with_bytes(const void *, size_t,
 192                                                 heim_string_free_f_t);
 193 heim_string_t heim_string_create_with_format(const char *, ...);
 194 heim_tid_t heim_string_get_type_id(void);
 195 const char * heim_string_get_utf8(heim_string_t);
 196
 197 #define HSTR(_str) (__heim_string_constant("" _str ""))
 198 heim_string_t __heim_string_constant(const char *);
 199
 200 /*
 201  * Errors
 202  */
 203
 204 typedef struct heim_error * heim_error_t;
 205
 206 heim_error_t heim_error_create_enomem(void);
 207
 208 heim_error_t    heim_error_create(int, const char *, ...)
 209     HEIMDAL_PRINTF_ATTRIBUTE((printf, 2, 3));
 210
 211 void            heim_error_create_opt(heim_error_t *error, int error_code, const char *fmt, ...)
 212     HEIMDAL_PRINTF_ATTRIBUTE((printf, 3, 4));
 213
 214 heim_error_t    heim_error_createv(int, const char *, va_list)
 215     HEIMDAL_PRINTF_ATTRIBUTE((printf, 2, 0));
 216
 217 heim_string_t heim_error_copy_string(heim_error_t);
 218 int heim_error_get_code(heim_error_t);
 219
 220 heim_error_t heim_error_append(heim_error_t, heim_error_t);
 221
 222 /*
 223  * Path
 224  */
 225
 226 heim_object_t heim_path_get(heim_object_t ptr, heim_error_t *error, ...);
 227 heim_object_t heim_path_copy(heim_object_t ptr, heim_error_t *error, ...);
 228 heim_object_t heim_path_vget(heim_object_t ptr, heim_error_t *error,
 229                              va_list ap);
 230 heim_object_t heim_path_vcopy(heim_object_t ptr, heim_error_t *error,
 231                                   va_list ap);
 232
 233 int heim_path_vcreate(heim_object_t ptr, size_t size, heim_object_t leaf,
 234                       heim_error_t *error, va_list ap);
 235 int heim_path_create(heim_object_t ptr, size_t size, heim_object_t leaf,
 236                      heim_error_t *error, ...);
 237
 238 void heim_path_vdelete(heim_object_t ptr, heim_error_t *error, va_list ap);
 239 void heim_path_delete(heim_object_t ptr, heim_error_t *error, ...);
 240
 241 /*
 242  * Data (octet strings)
 243  */
 244
 245 #ifndef __HEIM_BASE_DATA__
 246 #define __HEIM_BASE_DATA__
 247 struct heim_base_data {
 248     size_t length;
 249     void *data;
 250 };
 251 typedef struct heim_base_data heim_octet_string;
 252 #endif
 253
 254 typedef struct heim_base_data * heim_data_t;
 255 typedef void (*heim_data_free_f_t)(void *);
 256
 257 heim_data_t     heim_data_create(const void *, size_t);
 258 heim_data_t     heim_data_ref_create(const void *, size_t, heim_data_free_f_t);
 259 heim_tid_t      heim_data_get_type_id(void);
 260 const heim_octet_string *
 261                 heim_data_get_data(heim_data_t);
 262 const void *    heim_data_get_ptr(heim_data_t);
 263 size_t          heim_data_get_length(heim_data_t);
 264
 265 /*
 266  * DB
 267  */
 268
 269 typedef struct heim_db_data *heim_db_t;
 270
 271 typedef void (*heim_db_iterator_f_t)(heim_data_t, heim_data_t, void *);
 272
 273 typedef int (*heim_db_plug_open_f_t)(void *, const char *, const char *,
 274                                      heim_dict_t, void **, heim_error_t *);
 275 typedef int (*heim_db_plug_clone_f_t)(void *, void **, heim_error_t *);
 276 typedef int (*heim_db_plug_close_f_t)(void *, heim_error_t *);
 277 typedef int (*heim_db_plug_lock_f_t)(void *, int, heim_error_t *);
 278 typedef int (*heim_db_plug_unlock_f_t)(void *, heim_error_t *);
 279 typedef int (*heim_db_plug_sync_f_t)(void *, heim_error_t *);
 280 typedef int (*heim_db_plug_begin_f_t)(void *, int, heim_error_t *);
 281 typedef int (*heim_db_plug_commit_f_t)(void *, heim_error_t *);
 282 typedef int (*heim_db_plug_rollback_f_t)(void *, heim_error_t *);
 283 typedef heim_data_t (*heim_db_plug_copy_value_f_t)(void *, heim_string_t,
 284                                                    heim_data_t,
 285                                                    heim_error_t *);
 286 typedef int (*heim_db_plug_set_value_f_t)(void *, heim_string_t, heim_data_t,
 287                                           heim_data_t, heim_error_t *);
 288 typedef int (*heim_db_plug_del_key_f_t)(void *, heim_string_t, heim_data_t,
 289                                         heim_error_t *);
 290 typedef void (*heim_db_plug_iter_f_t)(void *, heim_string_t, void *,
 291                                       heim_db_iterator_f_t, heim_error_t *);
 292
 293 struct heim_db_type {
 294     int                         version;
 295     heim_db_plug_open_f_t       openf;
 296     heim_db_plug_clone_f_t      clonef;
 297     heim_db_plug_close_f_t      closef;
 298     heim_db_plug_lock_f_t       lockf;
 299     heim_db_plug_unlock_f_t     unlockf;
 300     heim_db_plug_sync_f_t       syncf;
 301     heim_db_plug_begin_f_t      beginf;
 302     heim_db_plug_commit_f_t     commitf;
 303     heim_db_plug_rollback_f_t   rollbackf;
 304     heim_db_plug_copy_value_f_t copyf;
 305     heim_db_plug_set_value_f_t  setf;
 306     heim_db_plug_del_key_f_t    delf;
 307     heim_db_plug_iter_f_t       iterf;
 308 };
 309
 310 extern struct heim_db_type heim_sorted_text_file_dbtype;
 311
 312 #define HEIM_DB_TYPE_VERSION_01 1
 313
 314 int heim_db_register(const char *dbtype,
 315                      void *data,
 316                      struct heim_db_type *plugin);
 317
 318 heim_db_t heim_db_create(const char *dbtype, const char *dbname,
 319                          heim_dict_t options, heim_error_t *error);
 320 heim_db_t heim_db_clone(heim_db_t, heim_error_t *);
 321 int heim_db_begin(heim_db_t, int, heim_error_t *);
 322 int heim_db_commit(heim_db_t, heim_error_t *);
 323 int heim_db_rollback(heim_db_t, heim_error_t *);
 324 heim_tid_t heim_db_get_type_id(void);
 325
 326 int     heim_db_set_value(heim_db_t, heim_string_t, heim_data_t, heim_data_t,
 327                           heim_error_t *);
 328 heim_data_t heim_db_copy_value(heim_db_t, heim_string_t, heim_data_t,
 329                                heim_error_t *);
 330 int     heim_db_delete_key(heim_db_t, heim_string_t, heim_data_t,
 331                            heim_error_t *);
 332 void    heim_db_iterate_f(heim_db_t, heim_string_t, void *,
 333                           heim_db_iterator_f_t, heim_error_t *);
 334 #ifdef __BLOCKS__
 335 void    heim_db_iterate(heim_db_t, heim_string_t,
 336                         void (^)(heim_data_t, heim_data_t), heim_error_t *);
 337 #endif
 338
 339
 340 /*
 341  * Number
 342  */
 343
 344 typedef struct heim_number_data *heim_number_t;
 345
 346 heim_number_t heim_number_create(int);
 347 heim_tid_t heim_number_get_type_id(void);
 348 int heim_number_get_int(heim_number_t);
 349
 350 /*
 351  *
 352  */
 353
 354 typedef struct heim_auto_release * heim_auto_release_t;
 355
 356 heim_auto_release_t heim_auto_release_create(void);
 357 void heim_auto_release_drain(heim_auto_release_t);
 358 heim_object_t heim_auto_release(heim_object_t);
 359
 360 /*
 361  * JSON
 362  */
 363 typedef enum heim_json_flags {
 364         HEIM_JSON_F_NO_C_NULL = 1,
 365         HEIM_JSON_F_STRICT_STRINGS = 2,
 366         HEIM_JSON_F_NO_DATA = 4,
 367         HEIM_JSON_F_NO_DATA_DICT = 8,
 368         HEIM_JSON_F_STRICT_DICT = 16,
 369         HEIM_JSON_F_STRICT = 31,
 370         HEIM_JSON_F_CNULL2JSNULL = 32,
 371         HEIM_JSON_F_TRY_DECODE_DATA = 64,
 372         HEIM_JSON_F_ONE_LINE = 128
 373 } heim_json_flags_t;
 374
 375 heim_object_t heim_json_create(const char *, size_t, heim_json_flags_t,
 376                                heim_error_t *);
 377 heim_object_t heim_json_create_with_bytes(const void *, size_t, size_t,
 378                                           heim_json_flags_t,
 379                                           heim_error_t *);
 380 heim_string_t heim_json_copy_serialize(heim_object_t, heim_json_flags_t,
 381                                        heim_error_t *);
 382
 383
 384 /*
 385  * Debug
 386  */
 387
 388 heim_string_t
 389 heim_description(heim_object_t ptr);
 390
 391 /*
 392  * Binary search.
 393  *
 394  * Note: these are private until integrated into the heimbase object system.
 395  */
 396 typedef struct bsearch_file_handle *bsearch_file_handle;
 397 int _bsearch_text(const char *buf, size_t buf_sz, const char *key,
 398                    char **value, size_t *location, size_t *loops);
 399 int _bsearch_file_open(const char *fname, size_t max_sz, size_t page_sz,
 400                         bsearch_file_handle *bfh, size_t *reads);
 401 int _bsearch_file(bsearch_file_handle bfh, const char *key, char **value,
 402                    size_t *location, size_t *loops, size_t *reads);
 403 void _bsearch_file_info(bsearch_file_handle bfh, size_t *page_sz,
 404                          size_t *max_sz, int *blockwise);
 405 void _bsearch_file_close(bsearch_file_handle *bfh);
 406
 407 #endif /* HEIM_BASE_H */