summaryrefslogtreecommitdiffstats
path: root/src/H5Bprivate.h
blob: dfc29a03195fd3137d77ac2e582d09081cc68514 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*-------------------------------------------------------------------------
 * Copyright (C) 1997   National Center for Supercomputing Applications.
 *                      All rights reserved.
 *
 *-------------------------------------------------------------------------
 *
 * Created:             H5Bprivate.h
 *                      Jul 10 1997
 *                      Robb Matzke <matzke@llnl.gov>
 *
 * Purpose:             Private non-prototype header.
 *
 * Modifications:       
 *
 *-------------------------------------------------------------------------
 */
#ifndef _H5Bprivate_H
#define _H5Bprivate_H
#include <H5Bpublic.h>          /*API prototypes                  */

/* Private headers needed by this file */
#include <H5private.h>
#include <H5Fprivate.h>

/*
 * Feature: Define this constant if you want to check B-tree consistency
 *          after each B-tree operation.  Note that this slows down the
 *          library considerably! Debugging the B-tree depends on assert()
 *          being enabled.
 */
#ifdef NDEBUG
#  undef H5B_DEBUG
#endif

#define H5B_MAGIC       "TREE"  /*tree node magic number          */
#define H5B_SIZEOF_MAGIC 4      /*size of magic number                    */

#define H5B_SIZEOF_HDR(F)                                                     \
   (H5B_SIZEOF_MAGIC +          /*magic number                          */    \
    4 +                         /*type, level, num entries              */    \
    2*H5F_SIZEOF_ADDR(F))       /*left and right sibling addresses        */

#define H5B_K(F,TYPE)           /*K value given file and Btree subclass */    \
   ((F)->shared->create_parms.btree_k[(TYPE)->id])

typedef enum H5B_ins_t {
    H5B_INS_ERROR = -1,         /*error return value                    */
    H5B_INS_NOOP = 0,           /*insert made no changes                */
    H5B_INS_LEFT = 1,           /*insert new node to left of cur node   */
    H5B_INS_RIGHT = 2,          /*insert new node to right of cur node  */
    H5B_INS_CHANGE = 3,         /*change child address for cur node     */
    H5B_INS_FIRST = 4           /*insert first node in (sub)tree        */
} H5B_ins_t;

typedef enum H5B_subid_t {
    H5B_SNODE_ID = 0,           /*B-tree is for symbol table nodes      */
    H5B_ISTORE_ID = 1           /*B-tree is for indexed object storage  */
} H5B_subid_t;

/*
 * Each class of object that can be pointed to by a B-link tree has a
 * variable of this type that contains class variables and methods.  Each
 * tree has a K (1/2 rank) value on a per-file basis.  The file_create_parms
 * has an array of K values indexed by the `id' class field below.  The
 * array is initialized with the HDF5_BTREE_K_DEFAULT macro.
 */
struct H5B_t;                   /*forward decl */
typedef struct H5B_class_t {
    H5B_subid_t             id; /*id as found in file                   */
    size_t                  sizeof_nkey;        /*size of native (memory) key           */
    size_t                  (*get_sizeof_rkey) (H5F_t *, const void *);         /*raw key size   */
    herr_t                  (*new) (H5F_t *, H5B_ins_t, void *, void *, void *, haddr_t *);
    intn                    (*cmp2) (H5F_t *, void *, void *, void *);  /*compare 2 keys     */
    intn                    (*cmp3) (H5F_t *, void *, void *, void *);  /*compare 3 keys     */
    herr_t                  (*found) (H5F_t *, const haddr_t *, const void *, void *, const void *);
    H5B_ins_t               (*insert) (H5F_t *, const haddr_t *, void *, hbool_t *, void *, void *,
                                       void *, hbool_t *, haddr_t *);   /*insert new data   */
    hbool_t                 follow_min;         /*min insert uses min leaf, not new()   */
    hbool_t                 follow_max;         /*max insert uses max leaf, not new()   */
    herr_t                  (*list) (H5F_t *, const haddr_t *, void *);         /*walk leaf nodes */
    herr_t                  (*decode) (H5F_t *, struct H5B_t *, uint8 *, void *);
    herr_t                  (*encode) (H5F_t *, struct H5B_t *, uint8 *, void *);
} H5B_class_t;

/*
 * The B-tree node as stored in memory...
 */
typedef struct H5B_key_t {
    hbool_t                 dirty;      /*native key is more recent than raw key */
    uint8                  *rkey;       /*ptr into node->page for raw key       */
    void                   *nkey;       /*null or ptr into node->native for key */
} H5B_key_t;

typedef struct H5B_t {
    const H5B_class_t      *type;       /*type of tree                          */
    size_t                  sizeof_rkey;        /*size of raw (disk) key                */
    hbool_t                 dirty;      /*something in the tree is dirty        */
    intn                    ndirty;     /*num child ptrs to emit                */
    intn                    level;      /*node level                            */
    haddr_t                 left;       /*address of left sibling               */
    haddr_t                 right;      /*address of right sibling              */
    intn                    nchildren;  /*number of child pointers              */
    uint8                  *page;       /*disk page                             */
    uint8                  *native;     /*array of keys in native format        */
    H5B_key_t              *key;        /*2k+1 key entries                      */
    haddr_t                *child;      /*2k child pointers                     */
} H5B_t;

/*
 * Library prototypes.
 */
herr_t                  H5B_debug(H5F_t *f, const haddr_t *addr, FILE * stream, intn indent,
                         intn fwidth, const H5B_class_t *type, void *udata);
herr_t                  H5B_create(H5F_t *f, const H5B_class_t *type, void *udata, haddr_t *);
herr_t                  H5B_find(H5F_t *f, const H5B_class_t *type, const haddr_t *addr,
                                 void *udata);
herr_t                  H5B_insert(H5F_t *f, const H5B_class_t *type, const haddr_t *addr,
                                   void *udata);
herr_t                  H5B_list(H5F_t *f, const H5B_class_t *type, const haddr_t *addr,
                                 void *udata);

#endif