api_handle.h

Go to the documentation of this file.

/*
 * Copyright 2008 Search Solution Corporation
 * Copyright 2016 CUBRID Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

/*
 * api_handle.h -
 */

#ifndef _API_HANDLE_H_
#define _API_HANDLE_H_

#include "config.h"

typedef UINT64 BIND_HANDLE;
typedef struct bh_interface_s BH_INTERFACE;
typedef struct bh_bind_s BH_BIND;
typedef void (*bh_destroyf) (BH_BIND * bind);
typedef int (*bh_mapf) (BH_INTERFACE * ifs, BH_BIND * bind, void *arg);
typedef struct bh_provider_s bh_provider;

typedef enum
{
  BH_ROOT_TYPE_STATIC_HASH_64 = 0,
  BH_ROOT_TYPE_STATIC_HASH_128 = 1,
  BH_ROOT_TYPE_STATIC_HASH_1024 = 2,
  BH_ROOT_TYPE_EXTENDIBLE_HASH = 3, /* not implemented */
  BH_ROOT_TYPE_RB_TREE = 4  /* not implemented */
} BH_ROOT_TYPE;

/*
 * basic bind structure corresponding a handle.
 * user struct should extend (first member) this structure
 */
struct bh_bind_s
{
  bh_destroyf dtor;     /* user supplied */
  void *bptr;           /* back pointer. DO NOT TOUCH THIS */
};

/*
 * abstract structure that provides functionality related with
 * handle management.
 */
struct bh_interface_s
{
  int (*alloc_handle) (BH_INTERFACE * ifs, BH_BIND * bind, BIND_HANDLE * bh);
  int (*destroy_handle) (BH_INTERFACE * ifs, BIND_HANDLE bh);
  int (*lookup) (BH_INTERFACE * ifs, BIND_HANDLE bh, BH_BIND ** bind);
  int (*bind_to_handle) (BH_INTERFACE * ifs, BH_BIND * bind, BIND_HANDLE * bh);
  int (*bind_get_parent) (BH_INTERFACE * ifs, BH_BIND * bind, BH_BIND ** pbind);
  int (*bind_prune) (BH_INTERFACE * ifs, BH_BIND * bind);
  int (*bind_graft) (BH_INTERFACE * ifs, BH_BIND * bind, BH_BIND * on_bind);
  int (*bind_get_first_child) (BH_INTERFACE * ifs, BH_BIND * bind, BH_BIND ** pchild);
  int (*bind_get_next_sibling) (BH_INTERFACE * ifs, BH_BIND * bind, BH_BIND ** psibling);
  int (*bind_map) (BH_INTERFACE * ifs, BH_BIND * bind, bh_mapf mf, void *arg);
  void (*destroy) (BH_INTERFACE * ifs);
};


/*
 * next handle value provider
 */
struct bh_provider_s
{
  int (*next_handle) (bh_provider * p, BIND_HANDLE * rv);
};

/*
 * Exported functions.
 *
 * A user first acquire root id using bh_root_acquire() and get
 * BH_INTERFACE by calling bh_root_lock().
 * BH_INTERFACE is MT safe until the root id is unlocked by calling
 * bh_root_unlock()
 */
extern int bh_root_acquire (int *rid, BH_ROOT_TYPE rt);
extern int bh_root_release (int rid);
extern int bh_root_lock (int rid, BH_INTERFACE ** ifs);
extern int bh_root_unlock (int rid);
extern int bh_get_rid (BIND_HANDLE bh, int *rid);
extern int create_handle_context (bh_provider * prov, BH_ROOT_TYPE rt, BH_INTERFACE ** ifs);
#endif /* _API_HANDLE_H_ */