Remove SYNC
[idzebra-moved-to-github.git] / index / recindxp.h
1 /*
2  * Copyright (C) 1994-2000, Index Data
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: recindxp.h,v $
7  * Revision 1.10  2001-10-15 19:53:43  adam
8  * POSIX thread updates. First work on term sets.
9  *
10  * Revision 1.9  2000/12/05 10:01:44  adam
11  * Fixed bug regarding user-defined attribute sets.
12  *
13  * Revision 1.8  2000/04/05 09:49:35  adam
14  * On Unix, zebra/z'mbol uses automake.
15  *
16  * Revision 1.7  1999/07/06 12:28:04  adam
17  * Updated record index structure. Format includes version ID. Compression
18  * algorithm ID is stored for each record block.
19  *
20  * Revision 1.6  1999/05/26 07:49:13  adam
21  * C++ compilation.
22  *
23  * Revision 1.5  1999/02/02 14:51:05  adam
24  * Updated WIN32 code specific sections. Changed header.
25  *
26  * Revision 1.4  1998/03/05 08:45:12  adam
27  * New result set model and modular ranking system. Moved towards
28  * descent server API. System information stored as "SGML" records.
29  *
30  * Revision 1.3  1995/12/11 11:45:55  adam
31  * Removed commented code.
32  *
33  * Revision 1.2  1995/12/11  09:12:51  adam
34  * The rec_get function returns NULL if record doesn't exist - will
35  * happen in the server if the result set records have been deleted since
36  * the creation of the set (i.e. the search).
37  * The server saves a result temporarily if it is 'volatile', i.e. the
38  * set is register dependent.
39  *
40  * Revision 1.1  1995/12/06  12:41:25  adam
41  * New command 'stat' for the index program.
42  * Filenames can be read from stdin by specifying '-'.
43  * Bug fix/enhancement of the transformation from terms to regular
44  * expressons in the search engine.
45  *
46  */
47
48 #include "recindex.h"
49
50 #include <bfile.h>
51
52 YAZ_BEGIN_CDECL
53
54 #define REC_BLOCK_TYPES 2
55 #define REC_HEAD_MAGIC "recindex"
56 #define REC_VERSION 3
57
58 struct records_info {
59     int rw;
60     int compression_method;
61
62     char *index_fname;
63     BFile index_BFile;
64
65     char *data_fname[REC_BLOCK_TYPES];
66     BFile data_BFile[REC_BLOCK_TYPES];
67
68     char *tmp_buf;
69     int tmp_size;
70
71     struct record_cache_entry *record_cache;
72     int cache_size;
73     int cache_cur;
74     int cache_max;
75
76     Zebra_mutex mutex;
77
78     struct records_head {
79         char magic[8];
80         char version[4];
81         int block_size[REC_BLOCK_TYPES];
82         int block_free[REC_BLOCK_TYPES];
83         int block_last[REC_BLOCK_TYPES];
84         int block_used[REC_BLOCK_TYPES];
85         int block_move[REC_BLOCK_TYPES];
86
87         int total_bytes;
88         int index_last;
89         int index_free;
90         int no_records;
91
92     } head;
93 };
94
95 enum recordCacheFlag { recordFlagNop, recordFlagWrite, recordFlagNew,
96                        recordFlagDelete };
97
98 struct record_cache_entry {
99     Record rec;
100     enum recordCacheFlag flag;
101 };
102
103 struct record_index_entry {
104     int next;         /* first block of record info / next free entry */
105     int size;         /* size of record or 0 if free entry */
106 };
107
108 YAZ_END_CDECL