16643b691205590755dd812b65a5f1e7b6ffde1f
[idzebra-moved-to-github.git] / dict / dict-p.h
1 /* This file is part of the Zebra server.
2    Copyright (C) 1994-2010 Index Data
3
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
18 */
19
20 #ifndef DICT_P_H
21 #define DICT_P_H
22
23 #include <yaz/log.h>
24 #include <yaz/xmalloc.h>
25 #include <idzebra/dict.h>
26
27 YAZ_BEGIN_CDECL
28
29 #define DICT_MAGIC "dict01"
30
31 #define DICT_DEFAULT_PAGESIZE 4096
32
33 typedef unsigned char Dict_char;
34 typedef unsigned Dict_ptr;
35
36 struct Dict_head {
37     char magic_str[8];
38     int page_size;
39     int compact_flag;
40     Dict_ptr root, last, freelist;
41 };
42
43 struct Dict_file_block
44 {
45     struct Dict_file_block *h_next, **h_prev;
46     struct Dict_file_block *lru_next, *lru_prev;
47     void *data;
48     int dirty;
49     int no;
50     int nbytes;
51 };
52
53 typedef struct Dict_file_struct
54 {
55     int cache;
56     BFile bf;
57     
58     struct Dict_file_block *all_blocks;
59     struct Dict_file_block *free_list;
60     struct Dict_file_block **hash_array;
61     
62     struct Dict_file_block *lru_back, *lru_front;
63     int hash_size;
64     void *all_data;
65     
66     int  block_size;
67     int  hits;
68     int  misses;
69     int  compact_flag;
70 } *Dict_BFile;
71
72 struct Dict_struct {
73     int rw;
74     Dict_BFile dbf;
75     const char **(*grep_cmap)(void *vp, const char **from, int len);
76     void *grep_cmap_data;
77     /** number of split page operations, since dict_open */
78     zint no_split;
79     /** number of insert operations, since dict_open */
80     zint no_insert;
81     /** number of lookup operations, since dict_open */
82     zint no_lookup;
83     struct Dict_head head;
84 };
85
86 int        dict_bf_readp (Dict_BFile bf, int no, void **bufp);
87 int        dict_bf_newp (Dict_BFile bf, int no, void **bufp, int nbytes);
88 int        dict_bf_touch (Dict_BFile bf, int no);
89 void       dict_bf_flush_blocks (Dict_BFile bf, int no_to_flush);
90 Dict_BFile dict_bf_open (BFiles bfs, const char *name, int block_size,
91                          int cache, int rw);
92 int        dict_bf_close (Dict_BFile dbf);
93 void       dict_bf_compact (Dict_BFile dbf);
94
95 int dict_strcmp (const Dict_char *s1, const Dict_char *s2);
96
97 int dict_strncmp (const Dict_char *s1, const Dict_char *s2, size_t n);
98
99 int dict_strlen (const Dict_char *s);
100
101
102 #define DICT_EOS        0
103 #define DICT_type(x)    0[(Dict_ptr*) x]
104 #define DICT_backptr(x) 1[(Dict_ptr*) x]
105 #define DICT_bsize(x)   2[(short*)((char*)(x)+2*sizeof(Dict_ptr))]
106 #define DICT_nodir(x)   0[(short*)((char*)(x)+2*sizeof(Dict_ptr))]
107 #define DICT_size(x)    1[(short*)((char*)(x)+2*sizeof(Dict_ptr))]
108 #define DICT_infoffset  (2*sizeof(Dict_ptr)+3*sizeof(short))
109 #define DICT_xxxxpagesize(x) ((x)->head.page_size)
110
111 #define DICT_to_str(x)  sizeof(Dict_info)+sizeof(Dict_ptr)
112
113 /*
114    type            type of page
115    backptr         pointer to parent
116    nextptr         pointer to next page (if any)
117    nodir           no of words
118    size            size of strings,info,ptr entries
119
120    dir[0..nodir-1]
121    ptr,info,string
122  */
123      
124 YAZ_END_CDECL
125
126 #endif
127 /*
128  * Local variables:
129  * c-basic-offset: 4
130  * c-file-style: "Stroustrup"
131  * indent-tabs-mode: nil
132  * End:
133  * vim: shiftwidth=4 tabstop=8 expandtab
134  */
135