1 /* $Id: index.h,v 1.85 2002-08-02 19:26:55 adam Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
35 #include <sys/times.h>
48 #define ISAM_DEFAULT "c"
49 #include <yaz/data1.h>
61 #define IT_MAX_WORD 256
62 #define IT_KEY_HAVE_SEQNO 1
63 #define IT_KEY_HAVE_FIELD 0
72 enum dirsKind { dirs_dir, dirs_file };
87 void getFnameTmp (Res res, char *fname, int no);
89 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
90 struct dirs_info *dirs_fopen (Dict dict, const char *path);
91 struct dirs_entry *dirs_read (struct dirs_info *p);
92 struct dirs_entry *dirs_last (struct dirs_info *p);
93 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
94 void dirs_rmdir (struct dirs_info *p, const char *src);
95 void dirs_add (struct dirs_info *p, const char *src, int sysno, time_t mtime);
96 void dirs_del (struct dirs_info *p, const char *src);
97 void dirs_free (struct dirs_info **pp);
99 struct dir_entry *dir_open (const char *rep, const char *base);
100 void dir_sort (struct dir_entry *e);
101 void dir_free (struct dir_entry **e_p);
103 void repositoryUpdate (ZebraHandle zh);
104 void repositoryAdd (ZebraHandle zh);
105 void repositoryDelete (ZebraHandle zh);
106 void repositoryShow (ZebraHandle zh);
108 int key_open (ZebraHandle zh, int mem);
109 int key_close (ZebraHandle zh);
110 int key_compare (const void *p1, const void *p2);
111 char *key_print_it (const void *p, char *buf);
112 int key_get_pos (const void *p);
113 int key_compare_it (const void *p1, const void *p2);
114 int key_qsort_compare (const void *p1, const void *p2);
115 void key_logdump (int mask, const void *p);
116 void inv_prstat (ZebraHandle zh);
117 void inv_compact (BFiles bfs);
118 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
119 ISAMS_M key_isams_m (Res res, ISAMS_M me);
120 ISAMC_M key_isamc_m (Res res, ISAMC_M me);
121 ISAMD_M key_isamd_m (Res res, ISAMD_M me);
122 int merge_sort (char **buf, int from, int to);
123 int key_SU_code (int ch, char *out);
125 #define FNAME_DICT "dict"
126 #define FNAME_ISAM "isam"
127 #define FNAME_ISAMC "isamc"
128 #define FNAME_ISAMS "isams"
129 #define FNAME_ISAMH "isamh"
130 #define FNAME_ISAMD "isamd"
131 #define FNAME_CONFIG "zebra.cfg"
133 #define GMATCH_DICT "gmatch"
134 #define FMATCH_DICT "fmatch"
136 struct strtab *strtab_mk (void);
137 int strtab_src (struct strtab *t, const char *name, void ***infop);
138 void strtab_del (struct strtab *t,
139 void (*func)(const char *name, void *info, void *data),
141 int index_char_cvt (int c);
142 int index_word_prefix (char *string, int attset_ordinal,
143 int local_attribute, const char *databaseName);
146 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
147 void zebraIndexUnlock (ZebraHandle zh);
148 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
149 int zebraIndexWait (ZebraHandle zh, int commitPhase);
151 #define FNAME_MAIN_LOCK "zebraidx.LCK"
152 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
153 #define FNAME_ORG_LOCK "zebraorg.LCK"
154 #define FNAME_TOUCH_TIME "zebraidx.time"
156 typedef struct zebra_lock_info *ZebraLockHandle;
157 ZebraLockHandle zebra_lock_create(const char *dir,
158 const char *file, int excl_flag);
159 void zebra_lock_destroy (ZebraLockHandle h);
160 int zebra_lock (ZebraLockHandle h);
161 int zebra_lock_nb (ZebraLockHandle h);
162 int zebra_unlock (ZebraLockHandle h);
163 int zebra_lock_fd (ZebraLockHandle h);
164 void zebra_lock_prefix (Res res, char *dst);
165 char *zebra_mk_fname (const char *dir, const char *name);
167 int zebra_lock_w (ZebraLockHandle h);
168 int zebra_lock_r (ZebraLockHandle h);
170 void zebra_load_atts (data1_handle dh, Res res);
172 int key_SU_decode (int *ch, const unsigned char *out);
173 int key_SU_encode (int ch, char *out);
175 // extern Res common_resource;
184 void encode_key_init (struct encode_info *i);
185 char *encode_key_int (int d, char *bp);
186 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
195 typedef struct zebra_set *ZebraSet;
197 typedef struct zebra_rank_class {
198 struct rank_control *control;
201 struct zebra_rank_class *next;
218 struct sortKey *next;
221 struct zebra_register {
232 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
233 time_t registerChange;
236 ZebraExplainInfo zei;
238 char *server_path_prefix;
240 ZebraMaps zebra_maps;
241 ZebraRankClass rank_classes;
246 int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
251 struct sortKey *sortKeys;
260 struct zebra_service {
264 struct zebra_session *sessions;
265 struct zebra_register *regs;
266 Zebra_mutex_cond session_lock;
272 struct zebra_session {
273 struct zebra_session *next;
274 struct zebra_service *service;
275 struct zebra_register *reg;
277 char *admin_databaseName;
284 ZebraLockHandle lock_normal;
285 ZebraLockHandle lock_shadow;
298 struct recordGroup rGroup;
301 int records_inserted;
304 int records_processed;
305 char *record_encoding;
307 iconv_t iconv_to_utf8;
308 iconv_t iconv_from_utf8;
312 struct rank_control {
314 void *(*create)(struct zebra_register *reg);
315 void (*destroy)(struct zebra_register *reg, void *class_handle);
316 void *(*begin)(struct zebra_register *reg, void *class_handle, RSET rset);
317 void (*end)(struct zebra_register *reg, void *set_handle);
318 int (*calc)(void *set_handle, int sysno);
319 void (*add)(void *set_handle, int seqno, int term_index);
322 struct term_set_entry {
324 struct term_set_entry *next;
327 struct term_set_list {
328 struct term_set_entry *first;
329 struct term_set_entry *last;
332 RSET rpn_search (ZebraHandle zh, NMEM mem,
333 Z_RPNQuery *rpn, int num_bases, char **basenames,
334 const char *setname, ZebraSet sset);
337 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
338 oid_value attributeset,
339 int num_bases, char **basenames,
340 int *position, int *num_entries, ZebraScanEntry **list,
343 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
344 const char *term, int length_term, const char *flags,
345 int preserve_position, int term_type);
347 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
348 const char *db, int set,
349 int use, const char *term);
350 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
351 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
352 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode,
353 Z_RPNQuery *rpn, int num_bases,
354 char **basenames, const char *setname);
355 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
356 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
360 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
361 int num, int *positions);
362 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
364 void resultSetSort (ZebraHandle zh, NMEM nmem,
365 int num_input_setnames, const char **input_setnames,
366 const char *output_setname,
367 Z_SortKeySpecList *sort_sequence, int *sort_status);
368 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
369 ZebraSet sset, RSET rset,
370 Z_SortKeySpecList *sort_sequence, int *sort_status);
371 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
372 void resultSetInvalidate (ZebraHandle zh);
374 int zebra_server_lock_init (ZebraService zh);
375 int zebra_server_lock_destroy (ZebraService zh);
376 int zebra_server_lock (ZebraService zh, int lockCommit);
377 void zebra_server_unlock (ZebraService zh, int commitPhase);
378 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
380 typedef struct attent
383 data1_local_attribute *local_attributes;
386 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
387 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
388 void zebraRankDestroy (struct zebra_register *reg);
390 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
392 extern struct rank_control *rank1_class;
394 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
395 oid_value input_format, Z_RecordComposition *comp,
396 oid_value *output_format, char **rec_bufp,
397 int *rec_lenp, char **basenamep);
399 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
400 void zebra_index_merge (ZebraHandle zh);
403 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
404 const char *buf, size_t buf_size,
405 const char *databaseName, int delete_flag,
406 int test_mode, int *sysno,
407 int store_keys, int store_data,
408 const char *match_criteria);
410 void extract_flushWriteKeys (ZebraHandle zh);
412 struct zebra_fetch_control {
415 off_t record_int_pos;
416 const char *record_int_buf;
421 int zebra_record_ext_read (void *fh, char *buf, size_t count);
422 off_t zebra_record_ext_seek (void *fh, off_t offset);
423 off_t zebra_record_ext_tell (void *fh);
424 off_t zebra_record_int_seek (void *fh, off_t offset);
425 off_t zebra_record_int_tell (void *fh);
426 int zebra_record_int_read (void *fh, char *buf, size_t count);
427 void zebra_record_int_end (void *fh, off_t offset);
429 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
430 int cmd, struct recKeys *reckeys);
431 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
432 int cmd, struct sortKey **skp);
433 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
434 void extract_token_add (RecWord *p);
435 int explain_extract (void *handle, Record rec, data1_node *n);
437 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
438 const struct recordGroup *rGroup, int deleteFlag);
440 int zebra_begin_read (ZebraHandle zh);
441 void zebra_end_read (ZebraHandle zh);