1 /* $Id: index.h,v 1.128 2004-12-08 14:02:36 adam Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
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
27 #include <idzebra/version.h>
32 #include <sys/times.h>
36 #include <idzebra/dict.h>
37 #include <idzebra/isams.h>
38 #include <idzebra/isamc.h>
39 #include <idzebra/isamb.h>
41 #include <idzebra/recgrs.h>
43 #include <idzebra/api.h>
50 #define ISAM_DEFAULT "b"
54 #define IT_MAX_WORD 256
56 #define IT_KEY_LEVEL_MAX 4
59 zint mem[IT_KEY_LEVEL_MAX];
62 enum dirsKind { dirs_dir, dirs_file };
77 void getFnameTmp (Res res, char *fname, int no);
79 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
80 struct dirs_info *dirs_fopen (Dict dict, const char *path);
81 struct dirs_entry *dirs_read (struct dirs_info *p);
82 struct dirs_entry *dirs_last (struct dirs_info *p);
83 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
84 void dirs_rmdir (struct dirs_info *p, const char *src);
85 void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
86 void dirs_del (struct dirs_info *p, const char *src);
87 void dirs_free (struct dirs_info **pp);
89 struct dir_entry *dir_open (const char *rep, const char *base,
91 void dir_sort (struct dir_entry *e);
92 void dir_free (struct dir_entry **e_p);
94 void repositoryUpdate (ZebraHandle zh, const char *path);
95 void repositoryAdd (ZebraHandle zh, const char *path);
96 void repositoryDelete (ZebraHandle zh, const char *path);
97 void repositoryShow (ZebraHandle zh, const char *path);
99 int key_open (ZebraHandle zh, int mem);
100 int key_close (ZebraHandle zh);
101 int key_compare (const void *p1, const void *p2);
102 void key_init(struct it_key *k);
103 char *key_print_it (const void *p, char *buf);
104 zint key_get_seq (const void *p);
105 int key_compare_it (const void *p1, const void *p2);
106 int key_qsort_compare (const void *p1, const void *p2);
107 void key_logdump (int mask, const void *p);
108 void key_logdump_txt (int logmask, const void *p, const char *txt);
109 void inv_prstat (ZebraHandle zh);
110 void inv_compact (BFiles bfs);
111 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
112 ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
113 ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
114 int merge_sort (char **buf, int from, int to);
115 int key_SU_code (int ch, char *out);
117 #define FNAME_DICT "dict"
118 #define FNAME_ISAM "isam"
119 #define FNAME_ISAMC "isamc"
120 #define FNAME_ISAMS "isams"
121 #define FNAME_ISAMH "isamh"
122 #define FNAME_ISAMD "isamd"
123 #define FNAME_CONFIG "zebra.cfg"
125 #define GMATCH_DICT "gmatch"
126 #define FMATCH_DICT "fmatch"
128 struct strtab *strtab_mk (void);
129 int strtab_src (struct strtab *t, const char *name, void ***infop);
130 void strtab_del (struct strtab *t,
131 void (*func)(const char *name, void *info, void *data),
133 int index_char_cvt (int c);
134 int index_word_prefix (char *string, int attset_ordinal,
135 int local_attribute, const char *databaseName);
138 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
139 void zebraIndexUnlock (ZebraHandle zh);
140 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
141 int zebraIndexWait (ZebraHandle zh, int commitPhase);
143 #define FNAME_MAIN_LOCK "zebraidx.LCK"
144 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
145 #define FNAME_ORG_LOCK "zebraorg.LCK"
146 #define FNAME_TOUCH_TIME "zebraidx.time"
148 typedef struct zebra_lock_info *ZebraLockHandle;
149 ZebraLockHandle zebra_lock_create(const char *dir,
150 const char *file, int excl_flag);
151 void zebra_lock_destroy (ZebraLockHandle h);
152 int zebra_lock (ZebraLockHandle h);
153 int zebra_lock_nb (ZebraLockHandle h);
154 int zebra_unlock (ZebraLockHandle h);
155 int zebra_lock_fd (ZebraLockHandle h);
156 void zebra_lock_prefix (Res res, char *dst);
157 char *zebra_mk_fname (const char *dir, const char *name);
159 int zebra_lock_w (ZebraLockHandle h);
160 int zebra_lock_r (ZebraLockHandle h);
162 void zebra_load_atts (data1_handle dh, Res res);
164 int key_SU_decode (int *ch, const unsigned char *out);
165 int key_SU_encode (int ch, char *out);
167 #define ENCODE_BUFLEN 768
169 int sysno; /* previously written values for delta-compress */
172 int prevsys; /* buffer for skipping insert/delete pairs */
175 int keylen; /* tells if we have an unwritten key in buf, and how long*/
177 char buf[ENCODE_BUFLEN];
180 void encode_key_init (struct encode_info *i);
181 char *encode_key_int (int d, char *bp);
182 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
183 void encode_key_flush (struct encode_info *i, FILE *outf);
185 typedef struct zebra_set *ZebraSet;
187 typedef struct zebra_rank_class {
188 struct rank_control *control;
191 struct zebra_rank_class *next;
207 struct zebra_register {
216 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
217 time_t registerChange;
220 ZebraExplainInfo zei;
222 char *server_path_prefix;
224 ZebraMaps zebra_maps;
225 ZebraRankClass rank_classes;
230 int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
234 struct sortKeys sortKeys;
236 struct sortKey *sortKeys;
245 struct zebra_service {
249 struct zebra_session *sessions;
250 struct zebra_register *regs;
251 Zebra_mutex_cond session_lock;
253 const char *path_root;
254 RecTypeClass record_classes;
259 struct zebra_session {
260 struct zebra_session *next;
261 struct zebra_service *service;
262 struct zebra_register *reg;
264 char *xadmin_databaseName;
271 ZebraLockHandle lock_normal;
272 ZebraLockHandle lock_shadow;
290 zint records_inserted;
291 zint records_updated;
292 zint records_deleted;
293 zint records_processed;
294 char *record_encoding;
296 yaz_iconv_t iconv_to_utf8;
297 yaz_iconv_t iconv_from_utf8;
301 const char *m_record_id;
302 const char *m_record_type;
305 int m_explain_database;
307 int m_file_verbose_limit;
310 struct rank_control {
312 void *(*create)(ZebraHandle zh);
313 void (*destroy)(struct zebra_register *reg, void *class_handle);
314 void *(*begin)(struct zebra_register *reg,
315 void *class_handle, RSET rset, NMEM nmem,
316 TERMID *terms, int numterms);
317 /* ### Could add parameters to begin:
318 * char *index; // author, title, etc.
319 * int dbsize; // number of records in database
320 * int rssize; // number of records in result set (estimate?)
322 void (*end)(struct zebra_register *reg, void *set_handle);
323 int (*calc)(void *set_handle, zint sysno);
324 void (*add)(void *set_handle, int seqno, TERMID term);
327 struct term_set_entry {
329 struct term_set_entry *next;
332 struct term_set_list {
333 struct term_set_entry *first;
334 struct term_set_entry *last;
337 RSET rpn_search (ZebraHandle zh, NMEM mem, NMEM rset_nmem,
338 Z_RPNQuery *rpn, int num_bases, char **basenames,
339 const char *setname, ZebraSet sset);
342 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
343 oid_value attributeset,
344 int num_bases, char **basenames,
345 int *position, int *num_entries, ZebraScanEntry **list,
346 int *is_partial, RSET limit_set, int return_zero);
348 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
349 const char *term, int length_term, const char *flags,
350 int preserve_position, int term_type, NMEM rset_nmem,
351 const struct key_control *kctrl, int scope);
353 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
354 const char *db, int set,
355 int use, const char *term);
356 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
357 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
358 ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
359 int num_bases, char **basenames,
360 const char *setname);
361 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
362 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
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, NMEM nmem);
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,
393 extern struct rank_control *rank1_class;
394 extern struct rank_control *rankzv_class;
395 extern struct rank_control *rankliv_class;
397 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score, ODR stream,
398 oid_value input_format, Z_RecordComposition *comp,
399 oid_value *output_format, char **rec_bufp,
400 int *rec_lenp, char **basenamep,
403 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
405 void zebra_index_merge (ZebraHandle zh);
407 int buffer_extract_record (ZebraHandle zh,
408 const char *buf, size_t buf_size,
411 const char *recordType,
413 const char *match_criteria,
419 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
420 const char *buf, size_t buf_size,
421 const char *databaseName, int delete_flag,
422 int test_mode, int *sysno,
423 int store_keys, int store_data,
424 const char *match_criteria);
426 void extract_flushWriteKeys (ZebraHandle zh, int final);
428 struct zebra_fetch_control {
431 off_t record_int_pos;
432 const char *record_int_buf;
437 int zebra_record_ext_read (void *fh, char *buf, size_t count);
438 off_t zebra_record_ext_seek (void *fh, off_t offset);
439 off_t zebra_record_ext_tell (void *fh);
440 off_t zebra_record_int_seek (void *fh, off_t offset);
441 off_t zebra_record_int_tell (void *fh);
442 int zebra_record_int_read (void *fh, char *buf, size_t count);
443 void zebra_record_int_end (void *fh, off_t offset);
445 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
446 int cmd, struct recKeys *reckeys);
447 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
448 int cmd, struct sortKeys *skp);
449 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
450 void extract_token_add (RecWord *p);
451 int explain_extract (void *handle, Record rec, data1_node *n);
453 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
456 int zebra_begin_read (ZebraHandle zh);
457 int zebra_end_read (ZebraHandle zh);
459 int zebra_file_stat (const char *file_name, struct stat *buf,
462 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
464 void *iscz1_start ();
465 void iscz1_reset (void *vp);
466 void iscz1_stop (void *p);
467 void iscz1_decode (void *vp, char **dst, const char **src);
468 void iscz1_encode (void *vp, char **dst, const char **src);
470 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
471 int compact_flag, Res res);