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 #include <stdbool.h>
  43
  44 #define HEIM_BASE_API_VERSION 20130210
  45
  46 typedef void * heim_object_t;
  47 typedef unsigned int heim_tid_t;
  48 typedef heim_object_t heim_bool_t;
  49 typedef heim_object_t heim_null_t;
  50 #define HEIM_BASE_ONCE_INIT 0
  51 typedef long heim_base_once_t; /* XXX arch dependant */
  52
  53 #if !defined(__has_extension)
  54 #define __has_extension(x) 0
  55 #endif
  56
  57 #define HEIM_REQUIRE_GNUC(m,n,p) \
  58     (((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__) >= \
  59      (((m) * 10000) + ((n) * 100) + (p)))
  60
  61
  62 #if __has_extension(__builtin_expect) || HEIM_REQUIRE_GNUC(3,0,0)
  63 #define heim_builtin_expect(_op,_res) __builtin_expect(_op,_res)
  64 #else
  65 #define heim_builtin_expect(_op,_res) (_op)
  66 #endif
  67
  68
  69 void *  heim_retain(heim_object_t);
  70 void    heim_release(heim_object_t);
  71
  72 void    heim_show(heim_object_t);
  73
  74 typedef void (*heim_type_dealloc)(void *);
  75
  76 void *
  77 heim_alloc(size_t size, const char *name, heim_type_dealloc dealloc);
  78
  79 heim_tid_t
  80 heim_get_tid(heim_object_t object);
  81
  82 int
  83 heim_cmp(heim_object_t a, heim_object_t b);
  84
  85 unsigned long
  86 heim_get_hash(heim_object_t ptr);
  87
  88 void
  89 heim_base_once_f(heim_base_once_t *, void *, void (*)(void *));
  90
  91 void
  92 heim_abort(const char *fmt, ...)
  93     HEIMDAL_NORETURN_ATTRIBUTE
  94     HEIMDAL_PRINTF_ATTRIBUTE((printf, 1, 2));
  95
  96 void
  97 heim_abortv(const char *fmt, va_list ap)
  98     HEIMDAL_NORETURN_ATTRIBUTE
  99     HEIMDAL_PRINTF_ATTRIBUTE((printf, 1, 0));
 100
 101 #define heim_assert(e,t) \
 102     (heim_builtin_expect(!(e), 0) ? heim_abort(t ":" #e) : (void)0)
 103
 104 /*
 105  *
 106  */
 107
 108 heim_null_t
 109 heim_null_create(void);
 110
 111 heim_bool_t
 112 heim_bool_create(int);
 113
 114 int
 115 heim_bool_val(heim_bool_t);
 116
 117 /*
 118  * Array
 119  */
 120
 121 typedef struct heim_array_data *heim_array_t;
 122
 123 heim_array_t heim_array_create(void);
 124 heim_tid_t heim_array_get_type_id(void);
 125
 126 typedef void (*heim_array_iterator_f_t)(heim_object_t, void *, int *);
 127 typedef int (*heim_array_filter_f_t)(heim_object_t, void *);
 128
 129 int     heim_array_append_value(heim_array_t, heim_object_t);
 130 int     heim_array_insert_value(heim_array_t, size_t idx, heim_object_t);
 131 void    heim_array_iterate_f(heim_array_t, void *, heim_array_iterator_f_t);
 132 void    heim_array_iterate_reverse_f(heim_array_t, void *, heim_array_iterator_f_t);
 133 #ifdef __BLOCKS__
 134 void    heim_array_iterate(heim_array_t, void (^)(heim_object_t, int *));
 135 void    heim_array_iterate_reverse(heim_array_t, void (^)(heim_object_t, int *));
 136 #endif
 137 size_t  heim_array_get_length(heim_array_t);
 138 heim_object_t
 139         heim_array_get_value(heim_array_t, size_t);
 140 heim_object_t
 141         heim_array_copy_value(heim_array_t, size_t);
 142 void    heim_array_set_value(heim_array_t, size_t, heim_object_t);
 143 void    heim_array_delete_value(heim_array_t, size_t);
 144 void    heim_array_filter_f(heim_array_t, void *, heim_array_filter_f_t);
 145 #ifdef __BLOCKS__
 146 void    heim_array_filter(heim_array_t, int (^)(heim_object_t));
 147 #endif
 148
 149 /*
 150  * Dict
 151  */
 152
 153 typedef struct heim_dict_data *heim_dict_t;
 154
 155 heim_dict_t heim_dict_create(size_t size);
 156 heim_tid_t heim_dict_get_type_id(void);
 157
 158 typedef void (*heim_dict_iterator_f_t)(heim_object_t, heim_object_t, void *);
 159
 160 int     heim_dict_set_value(heim_dict_t, heim_object_t, heim_object_t);
 161 void    heim_dict_iterate_f(heim_dict_t, void *, heim_dict_iterator_f_t);
 162 #ifdef __BLOCKS__
 163 void    heim_dict_iterate(heim_dict_t, void (^)(heim_object_t, heim_object_t));
 164 #endif
 165
 166 heim_object_t
 167         heim_dict_get_value(heim_dict_t, heim_object_t);
 168 heim_object_t
 169         heim_dict_copy_value(heim_dict_t, heim_object_t);
 170 void    heim_dict_delete_key(heim_dict_t, heim_object_t);
 171
 172 /*
 173  * String
 174  */
 175
 176 typedef struct heim_string_data *heim_string_t;
 177 typedef void (*heim_string_free_f_t)(void *);
 178
 179 heim_string_t heim_string_create(const char *);
 180 heim_string_t heim_string_ref_create(const char *, heim_string_free_f_t);
 181 heim_string_t heim_string_create_with_bytes(const void *, size_t);
 182 heim_string_t heim_string_ref_create_with_bytes(const void *, size_t,
 183                                                 heim_string_free_f_t);
 184 heim_string_t heim_string_create_with_format(const char *, ...);
 185 heim_tid_t heim_string_get_type_id(void);
 186 const char * heim_string_get_utf8(heim_string_t);
 187
 188 #define HSTR(_str) (__heim_string_constant("" _str ""))
 189 heim_string_t __heim_string_constant(const char *);
 190
 191 /*
 192  * Errors
 193  */
 194
 195 typedef struct heim_error * heim_error_t;
 196
 197 heim_error_t heim_error_create_enomem(void);
 198
 199 heim_error_t    heim_error_create(int, const char *, ...)
 200     HEIMDAL_PRINTF_ATTRIBUTE((printf, 2, 3));
 201
 202 void            heim_error_create_opt(heim_error_t *error, int error_code, const char *fmt, ...)
 203     HEIMDAL_PRINTF_ATTRIBUTE((printf, 3, 4));
 204
 205 heim_error_t    heim_error_createv(int, const char *, va_list)
 206     HEIMDAL_PRINTF_ATTRIBUTE((printf, 2, 0));
 207
 208 heim_string_t heim_error_copy_string(heim_error_t);
 209 int heim_error_get_code(heim_error_t);
 210
 211 heim_error_t heim_error_append(heim_error_t, heim_error_t);
 212
 213 /*
 214  * Path
 215  */
 216
 217 heim_object_t heim_path_get(heim_object_t ptr, heim_error_t *error, ...);
 218 heim_object_t heim_path_copy(heim_object_t ptr, heim_error_t *error, ...);
 219 heim_object_t heim_path_vget(heim_object_t ptr, heim_error_t *error,
 220                              va_list ap);
 221 heim_object_t heim_path_vcopy(heim_object_t ptr, heim_error_t *error,
 222                                   va_list ap);
 223
 224 int heim_path_vcreate(heim_object_t ptr, size_t size, heim_object_t leaf,
 225                       heim_error_t *error, va_list ap);
 226 int heim_path_create(heim_object_t ptr, size_t size, heim_object_t leaf,
 227                      heim_error_t *error, ...);
 228
 229 void heim_path_vdelete(heim_object_t ptr, heim_error_t *error, va_list ap);
 230 void heim_path_delete(heim_object_t ptr, heim_error_t *error, ...);
 231
 232 /*
 233  * Data (octet strings)
 234  */
 235
 236 #ifndef __HEIM_OCTET_STRING__
 237 #define __HEIM_OCTET_STRING__
 238 typedef struct heim_octet_string {
 239     size_t length;
 240     void *data;
 241 } heim_octet_string;
 242 #endif
 243
 244 typedef struct heim_data * heim_data_t;
 245 typedef void (*heim_data_free_f_t)(void *);
 246
 247 heim_data_t     heim_data_create(const void *, size_t);
 248 heim_data_t     heim_data_ref_create(const void *, size_t, heim_data_free_f_t);
 249 heim_tid_t      heim_data_get_type_id(void);
 250 const heim_octet_string *
 251                 heim_data_get_data(heim_data_t);
 252 const void *    heim_data_get_ptr(heim_data_t);
 253 size_t          heim_data_get_length(heim_data_t);
 254
 255 /*
 256  * DB
 257  */
 258
 259 typedef struct heim_db_data *heim_db_t;
 260
 261 typedef void (*heim_db_iterator_f_t)(heim_data_t, heim_data_t, void *);
 262
 263 typedef int (*heim_db_plug_open_f_t)(void *, const char *, const char *,
 264                                      heim_dict_t, void **, heim_error_t *);
 265 typedef int (*heim_db_plug_clone_f_t)(void *, void **, heim_error_t *);
 266 typedef int (*heim_db_plug_close_f_t)(void *, heim_error_t *);
 267 typedef int (*heim_db_plug_lock_f_t)(void *, int, heim_error_t *);
 268 typedef int (*heim_db_plug_unlock_f_t)(void *, heim_error_t *);
 269 typedef int (*heim_db_plug_sync_f_t)(void *, heim_error_t *);
 270 typedef int (*heim_db_plug_begin_f_t)(void *, int, heim_error_t *);
 271 typedef int (*heim_db_plug_commit_f_t)(void *, heim_error_t *);
 272 typedef int (*heim_db_plug_rollback_f_t)(void *, heim_error_t *);
 273 typedef heim_data_t (*heim_db_plug_copy_value_f_t)(void *, heim_string_t,
 274                                                    heim_data_t,
 275                                                    heim_error_t *);
 276 typedef int (*heim_db_plug_set_value_f_t)(void *, heim_string_t, heim_data_t,
 277                                           heim_data_t, heim_error_t *);
 278 typedef int (*heim_db_plug_del_key_f_t)(void *, heim_string_t, heim_data_t,
 279                                         heim_error_t *);
 280 typedef void (*heim_db_plug_iter_f_t)(void *, heim_string_t, void *,
 281                                       heim_db_iterator_f_t, heim_error_t *);
 282
 283 struct heim_db_type {
 284     int                         version;
 285     heim_db_plug_open_f_t       openf;
 286     heim_db_plug_clone_f_t      clonef;
 287     heim_db_plug_close_f_t      closef;
 288     heim_db_plug_lock_f_t       lockf;
 289     heim_db_plug_unlock_f_t     unlockf;
 290     heim_db_plug_sync_f_t       syncf;
 291     heim_db_plug_begin_f_t      beginf;
 292     heim_db_plug_commit_f_t     commitf;
 293     heim_db_plug_rollback_f_t   rollbackf;
 294     heim_db_plug_copy_value_f_t copyf;
 295     heim_db_plug_set_value_f_t  setf;
 296     heim_db_plug_del_key_f_t    delf;
 297     heim_db_plug_iter_f_t       iterf;
 298 };
 299
 300 extern struct heim_db_type heim_sorted_text_file_dbtype;
 301
 302 #define HEIM_DB_TYPE_VERSION_01 1
 303
 304 int heim_db_register(const char *dbtype,
 305                      void *data,
 306                      struct heim_db_type *plugin);
 307
 308 heim_db_t heim_db_create(const char *dbtype, const char *dbname,
 309                          heim_dict_t options, heim_error_t *error);
 310 heim_db_t heim_db_clone(heim_db_t, heim_error_t *);
 311 int heim_db_begin(heim_db_t, int, heim_error_t *);
 312 int heim_db_commit(heim_db_t, heim_error_t *);
 313 int heim_db_rollback(heim_db_t, heim_error_t *);
 314 heim_tid_t heim_db_get_type_id(void);
 315
 316 int     heim_db_set_value(heim_db_t, heim_string_t, heim_data_t, heim_data_t,
 317                           heim_error_t *);
 318 heim_data_t heim_db_copy_value(heim_db_t, heim_string_t, heim_data_t,
 319                                heim_error_t *);
 320 int     heim_db_delete_key(heim_db_t, heim_string_t, heim_data_t,
 321                            heim_error_t *);
 322 void    heim_db_iterate_f(heim_db_t, heim_string_t, void *,
 323                           heim_db_iterator_f_t, heim_error_t *);
 324 #ifdef __BLOCKS__
 325 void    heim_db_iterate(heim_db_t, heim_string_t,
 326                         void (^)(heim_data_t, heim_data_t), heim_error_t *);
 327 #endif
 328
 329
 330 /*
 331  * Number
 332  */
 333
 334 typedef struct heim_number_data *heim_number_t;
 335
 336 heim_number_t heim_number_create(int);
 337 heim_tid_t heim_number_get_type_id(void);
 338 int heim_number_get_int(heim_number_t);
 339
 340 /*
 341  *
 342  */
 343
 344 typedef struct heim_auto_release * heim_auto_release_t;
 345
 346 heim_auto_release_t heim_auto_release_create(void);
 347 void heim_auto_release_drain(heim_auto_release_t);
 348 heim_object_t heim_auto_release(heim_object_t);
 349
 350 /*
 351  * JSON
 352  */
 353 typedef enum heim_json_flags {
 354         HEIM_JSON_F_NO_C_NULL = 1,
 355         HEIM_JSON_F_STRICT_STRINGS = 2,
 356         HEIM_JSON_F_NO_DATA = 4,
 357         HEIM_JSON_F_NO_DATA_DICT = 8,
 358         HEIM_JSON_F_STRICT_DICT = 16,
 359         HEIM_JSON_F_STRICT = 31,
 360         HEIM_JSON_F_CNULL2JSNULL = 32,
 361         HEIM_JSON_F_TRY_DECODE_DATA = 64,
 362         HEIM_JSON_F_ONE_LINE = 128
 363 } heim_json_flags_t;
 364
 365 heim_object_t heim_json_create(const char *, size_t, heim_json_flags_t,
 366                                heim_error_t *);
 367 heim_object_t heim_json_create_with_bytes(const void *, size_t, size_t,
 368                                           heim_json_flags_t,
 369                                           heim_error_t *);
 370 heim_string_t heim_copy_serialize(heim_object_t, heim_json_flags_t,
 371                                   heim_error_t *);
 372
 373
 374 /*
 375  * Debug
 376  */
 377
 378 heim_string_t
 379 heim_description(heim_object_t ptr);
 380
 381 /*
 382  * Binary search.
 383  *
 384  * Note: these are private until integrated into the heimbase object system.
 385  */
 386 typedef struct bsearch_file_handle *bsearch_file_handle;
 387 int _bsearch_text(const char *buf, size_t buf_sz, const char *key,
 388                    char **value, size_t *location, size_t *loops);
 389 int _bsearch_file_open(const char *fname, size_t max_sz, size_t page_sz,
 390                         bsearch_file_handle *bfh, size_t *reads);
 391 int _bsearch_file(bsearch_file_handle bfh, const char *key, char **value,
 392                    size_t *location, size_t *loops, size_t *reads);
 393 void _bsearch_file_info(bsearch_file_handle bfh, size_t *page_sz,
 394                          size_t *max_sz, int *blockwise);
 395 void _bsearch_file_close(bsearch_file_handle *bfh);
 396
 397 #endif /* HEIM_BASE_H */