1 /* $Id: index.h,v 1.119 2004-09-09 10:08:04 heikki 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>
33 #include <sys/times.h>
44 #include <idzebra/api.h>
51 #define ISAM_DEFAULT "b"
55 #define IT_MAX_WORD 256
64 #define IT_KEY_LEVEL_MAX 4
67 zint mem[IT_KEY_LEVEL_MAX];
77 enum dirsKind { dirs_dir, dirs_file };
92 void getFnameTmp (Res res, char *fname, int no);
94 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
95 struct dirs_info *dirs_fopen (Dict dict, const char *path);
96 struct dirs_entry *dirs_read (struct dirs_info *p);
97 struct dirs_entry *dirs_last (struct dirs_info *p);
98 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
99 void dirs_rmdir (struct dirs_info *p, const char *src);
100 void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
101 void dirs_del (struct dirs_info *p, const char *src);
102 void dirs_free (struct dirs_info **pp);
104 struct dir_entry *dir_open (const char *rep, const char *base,
106 void dir_sort (struct dir_entry *e);
107 void dir_free (struct dir_entry **e_p);
109 void repositoryUpdate (ZebraHandle zh, const char *path);
110 void repositoryAdd (ZebraHandle zh, const char *path);
111 void repositoryDelete (ZebraHandle zh, const char *path);
112 void repositoryShow (ZebraHandle zh, const char *path);
114 int key_open (ZebraHandle zh, int mem);
115 int key_close (ZebraHandle zh);
116 int key_compare (const void *p1, const void *p2);
117 void key_init(struct it_key *k);
118 char *key_print_it (const void *p, char *buf);
119 zint key_get_seq (const void *p);
120 int key_compare_it (const void *p1, const void *p2);
121 int key_qsort_compare (const void *p1, const void *p2);
122 void key_logdump (int mask, const void *p);
123 void key_logdump_txt (int logmask, const void *p, const char *txt);
124 void inv_prstat (ZebraHandle zh);
125 void inv_compact (BFiles bfs);
126 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
127 ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
128 ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
129 int merge_sort (char **buf, int from, int to);
130 int key_SU_code (int ch, char *out);
132 #define FNAME_DICT "dict"
133 #define FNAME_ISAM "isam"
134 #define FNAME_ISAMC "isamc"
135 #define FNAME_ISAMS "isams"
136 #define FNAME_ISAMH "isamh"
137 #define FNAME_ISAMD "isamd"
138 #define FNAME_CONFIG "zebra.cfg"
140 #define GMATCH_DICT "gmatch"
141 #define FMATCH_DICT "fmatch"
143 struct strtab *strtab_mk (void);
144 int strtab_src (struct strtab *t, const char *name, void ***infop);
145 void strtab_del (struct strtab *t,
146 void (*func)(const char *name, void *info, void *data),
148 int index_char_cvt (int c);
149 int index_word_prefix (char *string, int attset_ordinal,
150 int local_attribute, const char *databaseName);
153 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
154 void zebraIndexUnlock (ZebraHandle zh);
155 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
156 int zebraIndexWait (ZebraHandle zh, int commitPhase);
158 #define FNAME_MAIN_LOCK "zebraidx.LCK"
159 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
160 #define FNAME_ORG_LOCK "zebraorg.LCK"
161 #define FNAME_TOUCH_TIME "zebraidx.time"
163 typedef struct zebra_lock_info *ZebraLockHandle;
164 ZebraLockHandle zebra_lock_create(const char *dir,
165 const char *file, int excl_flag);
166 void zebra_lock_destroy (ZebraLockHandle h);
167 int zebra_lock (ZebraLockHandle h);
168 int zebra_lock_nb (ZebraLockHandle h);
169 int zebra_unlock (ZebraLockHandle h);
170 int zebra_lock_fd (ZebraLockHandle h);
171 void zebra_lock_prefix (Res res, char *dst);
172 char *zebra_mk_fname (const char *dir, const char *name);
174 int zebra_lock_w (ZebraLockHandle h);
175 int zebra_lock_r (ZebraLockHandle h);
177 void zebra_load_atts (data1_handle dh, Res res);
179 int key_SU_decode (int *ch, const unsigned char *out);
180 int key_SU_encode (int ch, char *out);
182 #define ENCODE_BUFLEN 768
184 int sysno; /* previously written values for delta-compress */
187 int prevsys; /* buffer for skipping insert/delete pairs */
190 int keylen; /* tells if we have an unwritten key in buf, and how long*/
194 char buf[ENCODE_BUFLEN];
197 void encode_key_init (struct encode_info *i);
198 char *encode_key_int (int d, char *bp);
199 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
200 void encode_key_flush (struct encode_info *i, FILE *outf);
209 typedef struct zebra_set *ZebraSet;
211 typedef struct zebra_rank_class {
212 struct rank_control *control;
215 struct zebra_rank_class *next;
237 struct zebra_register {
246 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
247 time_t registerChange;
250 ZebraExplainInfo zei;
252 char *server_path_prefix;
254 ZebraMaps zebra_maps;
255 ZebraRankClass rank_classes;
260 int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
264 struct sortKeys sortKeys;
266 struct sortKey *sortKeys;
275 struct zebra_service {
279 struct zebra_session *sessions;
280 struct zebra_register *regs;
281 Zebra_mutex_cond session_lock;
283 const char *path_root;
287 struct zebra_session {
288 struct zebra_session *next;
289 struct zebra_service *service;
290 struct zebra_register *reg;
292 char *xadmin_databaseName;
299 ZebraLockHandle lock_normal;
300 ZebraLockHandle lock_shadow;
318 zint records_inserted;
319 zint records_updated;
320 zint records_deleted;
321 zint records_processed;
322 char *record_encoding;
324 yaz_iconv_t iconv_to_utf8;
325 yaz_iconv_t iconv_from_utf8;
329 const char *m_record_id;
330 const char *m_record_type;
333 int m_explain_database;
335 int m_file_verbose_limit;
338 struct rank_control {
340 void *(*create)(ZebraHandle zh);
341 void (*destroy)(struct zebra_register *reg, void *class_handle);
342 void *(*begin)(struct zebra_register *reg, void *class_handle, RSET rset);
343 /* ### Could add parameters to begin:
344 * char *index; // author, title, etc.
345 * int dbsize; // number of records in database
346 * int rssize; // number of records in result set (estimate?)
348 void (*end)(struct zebra_register *reg, void *set_handle);
349 int (*calc)(void *set_handle, zint sysno);
350 void (*add)(void *set_handle, int seqno, int term_index);
353 struct term_set_entry {
355 struct term_set_entry *next;
358 struct term_set_list {
359 struct term_set_entry *first;
360 struct term_set_entry *last;
363 RSET rpn_search (ZebraHandle zh, NMEM mem, NMEM rset_nmem,
364 Z_RPNQuery *rpn, int num_bases, char **basenames,
365 const char *setname, ZebraSet sset);
368 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
369 oid_value attributeset,
370 int num_bases, char **basenames,
371 int *position, int *num_entries, ZebraScanEntry **list,
372 int *is_partial, RSET limit_set, int return_zero);
374 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
375 const char *term, int length_term, const char *flags,
376 int preserve_position, int term_type, NMEM rset_nmem,
377 const struct key_control *kctrl, int scope);
379 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
380 const char *db, int set,
381 int use, const char *term);
382 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
383 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
384 ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
385 int num_bases, char **basenames,
386 const char *setname);
387 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
388 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
392 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
393 int num, int *positions);
394 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
396 void resultSetSort (ZebraHandle zh, NMEM nmem,
397 int num_input_setnames, const char **input_setnames,
398 const char *output_setname,
399 Z_SortKeySpecList *sort_sequence, int *sort_status);
400 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
401 ZebraSet sset, RSET rset,
402 Z_SortKeySpecList *sort_sequence, int *sort_status);
403 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
404 void resultSetInvalidate (ZebraHandle zh);
406 int zebra_server_lock_init (ZebraService zh);
407 int zebra_server_lock_destroy (ZebraService zh);
408 int zebra_server_lock (ZebraService zh, int lockCommit);
409 void zebra_server_unlock (ZebraService zh, int commitPhase);
410 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
412 typedef struct attent
415 data1_local_attribute *local_attributes;
418 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
419 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
420 void zebraRankDestroy (struct zebra_register *reg);
422 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att,
425 extern struct rank_control *rank1_class;
426 extern struct rank_control *rankzv_class;
427 extern struct rank_control *rankliv_class;
429 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score, ODR stream,
430 oid_value input_format, Z_RecordComposition *comp,
431 oid_value *output_format, char **rec_bufp,
432 int *rec_lenp, char **basenamep);
434 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
436 void zebra_index_merge (ZebraHandle zh);
438 int buffer_extract_record (ZebraHandle zh,
439 const char *buf, size_t buf_size,
442 const char *recordType,
444 const char *match_criteria,
450 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
451 const char *buf, size_t buf_size,
452 const char *databaseName, int delete_flag,
453 int test_mode, int *sysno,
454 int store_keys, int store_data,
455 const char *match_criteria);
457 void extract_flushWriteKeys (ZebraHandle zh, int final);
459 struct zebra_fetch_control {
462 off_t record_int_pos;
463 const char *record_int_buf;
468 int zebra_record_ext_read (void *fh, char *buf, size_t count);
469 off_t zebra_record_ext_seek (void *fh, off_t offset);
470 off_t zebra_record_ext_tell (void *fh);
471 off_t zebra_record_int_seek (void *fh, off_t offset);
472 off_t zebra_record_int_tell (void *fh);
473 int zebra_record_int_read (void *fh, char *buf, size_t count);
474 void zebra_record_int_end (void *fh, off_t offset);
476 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
477 int cmd, struct recKeys *reckeys);
478 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
479 int cmd, struct sortKeys *skp);
480 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
481 void extract_token_add (RecWord *p);
482 int explain_extract (void *handle, Record rec, data1_node *n);
484 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
487 int zebra_begin_read (ZebraHandle zh);
488 int zebra_end_read (ZebraHandle zh);
490 int zebra_file_stat (const char *file_name, struct stat *buf,
493 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
495 void *iscz1_start ();
496 void iscz1_reset (void *vp);
497 void iscz1_stop (void *p);
498 void iscz1_decode (void *vp, char **dst, const char **src);
499 void iscz1_encode (void *vp, char **dst, const char **src);
501 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
502 int compact_flag, Res res);