kvtree.h

Go to the documentation of this file.

/* Several lines are reproduced from queue.h, under the following license */
 
/*
 * Copyright (c) 1991, 1993
 *  The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *  @(#)queue.h 8.5 (Berkeley) 8/20/94
 */
#ifndef KVTREE_H
#define KVTREE_H
 
#include <stdarg.h>
#include <sys/types.h>
 
/* enable C++ codes to include this header directly */
#ifdef __cplusplus
extern "C" {
#endif
 
#define KVTREE_VERSION "1.3.0"
#define KVTREE_SUCCESS (0)
#define KVTREE_MAX_FILENAME (1024)
 
#define KVTREE_PRINT_TREE   (1)
#define KVTREE_PRINT_KEYVAL (2)
 
/********************************************************/
#define KVTREE_SORT_ASCENDING  (0)
#define KVTREE_SORT_DESCENDING (1)
 
/********************************************************/
 
struct kvtree_elem_struct;
 
// the following 3 lines reproduced from queue.h
struct kvtree_struct{
  struct kvtree_elem_struct *lh_first;
};
 
struct kvtree_elem_struct {
  char* key;
  struct kvtree_struct* hash;
  // the following 4 lines reproduced from queue.h
  struct{
    struct kvtree_elem_struct *le_next; /* next element */
    struct kvtree_elem_struct **le_prev; /* address of previos next element */
  } pointers;
};
 
typedef struct kvtree_struct      kvtree;
typedef struct kvtree_elem_struct kvtree_elem;
 
/********************************************************/
 
kvtree* kvtree_new(void);
 
int kvtree_delete(kvtree** ptr_hash);
 
/********************************************************/
 
int kvtree_size(const kvtree* hash);
 
kvtree* kvtree_get(const kvtree* hash, const char* key);
 
kvtree* kvtree_set(kvtree* hash, const char* key, kvtree* hash_value);
 
kvtree* kvtree_extract(kvtree* hash, const char* key);
 
int kvtree_unset(kvtree* hash, const char* key);
 
int kvtree_unset_all(kvtree* hash);
 
int kvtree_merge(kvtree* hash1, const kvtree* hash2);
 
kvtree* kvtree_setf(kvtree* hash, kvtree* hash_value, const char* format, ...);
 
kvtree* kvtree_getf(const kvtree* hash, const char* format, ...);
 
int kvtree_sort(kvtree* hash, int direction);
 
int kvtree_sort_int(kvtree* hash, int direction);
 
int kvtree_list_int(const kvtree* hash, int* num, int** list);
 
/********************************************************/
 
kvtree* kvtree_set_kv(kvtree* hash, const char* key, const char* val);
 
kvtree* kvtree_set_kv_int(kvtree* hash, const char* key, int val);
 
kvtree* kvtree_get_kv(const kvtree* hash, const char* key, const char* val);
 
kvtree* kvtree_get_kv_int(const kvtree* hash, const char* key, int val);
 
int kvtree_unset_kv(kvtree* hash, const char* key, const char* val);
 
int kvtree_unset_kv_int(kvtree* hash, const char* key, int val);
 
/********************************************************/
 
kvtree_elem* kvtree_elem_first(const kvtree* hash);
 
kvtree_elem* kvtree_elem_next(const kvtree_elem* elem);
 
char* kvtree_elem_key(const kvtree_elem* elem);
 
int kvtree_elem_key_int(const kvtree_elem* elem);
 
kvtree* kvtree_elem_hash(const kvtree_elem* elem);
 
kvtree_elem* kvtree_elem_get(const kvtree* hash, const char* key);
 
char* kvtree_elem_get_first_val(const kvtree* hash, const char* key);
 
kvtree_elem* kvtree_elem_extract(kvtree* hash, const char* key);
 
kvtree_elem* kvtree_elem_extract_int(kvtree* hash, int key);
 
kvtree_elem* kvtree_elem_extract_by_addr(kvtree* hash, kvtree_elem* elem);
 
char* kvtree_get_val(const kvtree* hash, const char* key);
 
/********************************************************/
 
size_t kvtree_pack_size(const kvtree* hash);
 
size_t kvtree_pack(char* buf, const kvtree* hash);
 
size_t kvtree_unpack(const char* buf, kvtree* hash);
 
/********************************************************/
 
int kvtree_write_persist(void** ptr_buf, size_t* ptr_size, const kvtree* hash);
 
ssize_t kvtree_write_fd(const char* file, int fd, const kvtree* hash);
 
ssize_t kvtree_read_fd(const char* file, int fd, kvtree* hash);
 
int kvtree_write_file(const char* file, const kvtree* hash);
 
int kvtree_read_file(const char* file, kvtree* hash);
 
int kvtree_read_with_lock(const char* file, kvtree* hash);
 
int kvtree_write_with_lock(const char* file, kvtree* hash);
 
int kvtree_lock_open_read(const char* file, int* fd, kvtree* hash);
 
int kvtree_write_close_unlock(const char* file, int* fd, const kvtree* hash);
 
int kvtree_write_to_gather(const char* prefix, kvtree* data, int ranks);
 
/* Read a scatter/gather file and all of its subfiles into a single kvtree */
int kvtree_read_scatter_single(const char* prefix, kvtree* data);
 
/********************************************************/
 
int kvtree_print(const kvtree* hash, int indent);
 
int kvtree_print_mode(const kvtree* hash, int indent, int mode);
 
int kvtree_log(const kvtree* hash, int log_level, int indent);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif