1 /* $Id: index.h,v 1.116 2004-08-31 14:43:41 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];
78 int (*key_compare) (const void *p1, const void *p2);
79 void (*key_logdump_txt) (int logmask, const void *p, const char *txt);
80 /* FIXME - decode and encode, and lots of other stuff */
83 enum dirsKind { dirs_dir, dirs_file };
98 void getFnameTmp (Res res, char *fname, int no);
100 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
101 struct dirs_info *dirs_fopen (Dict dict, const char *path);
102 struct dirs_entry *dirs_read (struct dirs_info *p);
103 struct dirs_entry *dirs_last (struct dirs_info *p);
104 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
105 void dirs_rmdir (struct dirs_info *p, const char *src);
106 void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
107 void dirs_del (struct dirs_info *p, const char *src);
108 void dirs_free (struct dirs_info **pp);
110 struct dir_entry *dir_open (const char *rep, const char *base,
112 void dir_sort (struct dir_entry *e);
113 void dir_free (struct dir_entry **e_p);
115 void repositoryUpdate (ZebraHandle zh, const char *path);
116 void repositoryAdd (ZebraHandle zh, const char *path);
117 void repositoryDelete (ZebraHandle zh, const char *path);
118 void repositoryShow (ZebraHandle zh, const char *path);
120 int key_open (ZebraHandle zh, int mem);
121 int key_close (ZebraHandle zh);
122 int key_compare (const void *p1, const void *p2);
123 void key_init(struct it_key *k);
124 char *key_print_it (const void *p, char *buf);
125 int key_get_seq (const void *p);
126 int key_compare_it (const void *p1, const void *p2);
127 int key_qsort_compare (const void *p1, const void *p2);
128 void key_logdump (int mask, const void *p);
129 void key_logdump_txt (int logmask, const void *p, const char *txt);
130 void inv_prstat (ZebraHandle zh);
131 void inv_compact (BFiles bfs);
132 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
133 ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
134 ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
135 int merge_sort (char **buf, int from, int to);
136 int key_SU_code (int ch, char *out);
138 #define FNAME_DICT "dict"
139 #define FNAME_ISAM "isam"
140 #define FNAME_ISAMC "isamc"
141 #define FNAME_ISAMS "isams"
142 #define FNAME_ISAMH "isamh"
143 #define FNAME_ISAMD "isamd"
144 #define FNAME_CONFIG "zebra.cfg"
146 #define GMATCH_DICT "gmatch"
147 #define FMATCH_DICT "fmatch"
149 struct strtab *strtab_mk (void);
150 int strtab_src (struct strtab *t, const char *name, void ***infop);
151 void strtab_del (struct strtab *t,
152 void (*func)(const char *name, void *info, void *data),
154 int index_char_cvt (int c);
155 int index_word_prefix (char *string, int attset_ordinal,
156 int local_attribute, const char *databaseName);
159 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
160 void zebraIndexUnlock (ZebraHandle zh);
161 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
162 int zebraIndexWait (ZebraHandle zh, int commitPhase);
164 #define FNAME_MAIN_LOCK "zebraidx.LCK"
165 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
166 #define FNAME_ORG_LOCK "zebraorg.LCK"
167 #define FNAME_TOUCH_TIME "zebraidx.time"
169 typedef struct zebra_lock_info *ZebraLockHandle;
170 ZebraLockHandle zebra_lock_create(const char *dir,
171 const char *file, int excl_flag);
172 void zebra_lock_destroy (ZebraLockHandle h);
173 int zebra_lock (ZebraLockHandle h);
174 int zebra_lock_nb (ZebraLockHandle h);
175 int zebra_unlock (ZebraLockHandle h);
176 int zebra_lock_fd (ZebraLockHandle h);
177 void zebra_lock_prefix (Res res, char *dst);
178 char *zebra_mk_fname (const char *dir, const char *name);
180 int zebra_lock_w (ZebraLockHandle h);
181 int zebra_lock_r (ZebraLockHandle h);
183 void zebra_load_atts (data1_handle dh, Res res);
185 int key_SU_decode (int *ch, const unsigned char *out);
186 int key_SU_encode (int ch, char *out);
188 #define ENCODE_BUFLEN 768
190 int sysno; /* previously written values for delta-compress */
193 int prevsys; /* buffer for skipping insert/delete pairs */
196 int keylen; /* tells if we have an unwritten key in buf, and how long*/
200 char buf[ENCODE_BUFLEN];
203 void encode_key_init (struct encode_info *i);
204 char *encode_key_int (int d, char *bp);
205 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
206 void encode_key_flush (struct encode_info *i, FILE *outf);
215 typedef struct zebra_set *ZebraSet;
217 typedef struct zebra_rank_class {
218 struct rank_control *control;
221 struct zebra_rank_class *next;
243 struct zebra_register {
252 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
253 time_t registerChange;
256 ZebraExplainInfo zei;
258 char *server_path_prefix;
260 ZebraMaps zebra_maps;
261 ZebraRankClass rank_classes;
266 int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
270 struct sortKeys sortKeys;
272 struct sortKey *sortKeys;
281 struct zebra_service {
285 struct zebra_session *sessions;
286 struct zebra_register *regs;
287 Zebra_mutex_cond session_lock;
289 const char *path_root;
293 struct zebra_session {
294 struct zebra_session *next;
295 struct zebra_service *service;
296 struct zebra_register *reg;
298 char *xadmin_databaseName;
305 ZebraLockHandle lock_normal;
306 ZebraLockHandle lock_shadow;
324 zint records_inserted;
325 zint records_updated;
326 zint records_deleted;
327 zint records_processed;
328 char *record_encoding;
330 yaz_iconv_t iconv_to_utf8;
331 yaz_iconv_t iconv_from_utf8;
335 const char *m_record_id;
336 const char *m_record_type;
339 int m_explain_database;
341 int m_file_verbose_limit;
344 struct rank_control {
346 void *(*create)(ZebraHandle zh);
347 void (*destroy)(struct zebra_register *reg, void *class_handle);
348 void *(*begin)(struct zebra_register *reg, void *class_handle, RSET rset);
349 /* ### Could add parameters to begin:
350 * char *index; // author, title, etc.
351 * int dbsize; // number of records in database
352 * int rssize; // number of records in result set (estimate?)
354 void (*end)(struct zebra_register *reg, void *set_handle);
355 int (*calc)(void *set_handle, zint sysno);
356 void (*add)(void *set_handle, int seqno, int term_index);
359 struct term_set_entry {
361 struct term_set_entry *next;
364 struct term_set_list {
365 struct term_set_entry *first;
366 struct term_set_entry *last;
369 RSET rpn_search (ZebraHandle zh, NMEM mem, NMEM rset_nmem,
370 Z_RPNQuery *rpn, int num_bases, char **basenames,
371 const char *setname, ZebraSet sset);
374 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
375 oid_value attributeset,
376 int num_bases, char **basenames,
377 int *position, int *num_entries, ZebraScanEntry **list,
378 int *is_partial, RSET limit_set, int return_zero);
380 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
381 const char *term, int length_term, const char *flags,
382 int preserve_position, int term_type, NMEM rset_nmem);
384 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
385 const char *db, int set,
386 int use, const char *term);
387 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
388 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
389 ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
390 int num_bases, char **basenames,
391 const char *setname);
392 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
393 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
397 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
398 int num, int *positions);
399 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
401 void resultSetSort (ZebraHandle zh, NMEM nmem,
402 int num_input_setnames, const char **input_setnames,
403 const char *output_setname,
404 Z_SortKeySpecList *sort_sequence, int *sort_status);
405 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
406 ZebraSet sset, RSET rset,
407 Z_SortKeySpecList *sort_sequence, int *sort_status);
408 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
409 void resultSetInvalidate (ZebraHandle zh);
411 int zebra_server_lock_init (ZebraService zh);
412 int zebra_server_lock_destroy (ZebraService zh);
413 int zebra_server_lock (ZebraService zh, int lockCommit);
414 void zebra_server_unlock (ZebraService zh, int commitPhase);
415 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
417 typedef struct attent
420 data1_local_attribute *local_attributes;
423 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
424 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
425 void zebraRankDestroy (struct zebra_register *reg);
427 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att,
430 extern struct rank_control *rank1_class;
431 extern struct rank_control *rankzv_class;
432 extern struct rank_control *rankliv_class;
434 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score, ODR stream,
435 oid_value input_format, Z_RecordComposition *comp,
436 oid_value *output_format, char **rec_bufp,
437 int *rec_lenp, char **basenamep);
439 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
441 void zebra_index_merge (ZebraHandle zh);
443 int buffer_extract_record (ZebraHandle zh,
444 const char *buf, size_t buf_size,
447 const char *recordType,
449 const char *match_criteria,
455 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
456 const char *buf, size_t buf_size,
457 const char *databaseName, int delete_flag,
458 int test_mode, int *sysno,
459 int store_keys, int store_data,
460 const char *match_criteria);
462 void extract_flushWriteKeys (ZebraHandle zh, int final);
464 struct zebra_fetch_control {
467 off_t record_int_pos;
468 const char *record_int_buf;
473 int zebra_record_ext_read (void *fh, char *buf, size_t count);
474 off_t zebra_record_ext_seek (void *fh, off_t offset);
475 off_t zebra_record_ext_tell (void *fh);
476 off_t zebra_record_int_seek (void *fh, off_t offset);
477 off_t zebra_record_int_tell (void *fh);
478 int zebra_record_int_read (void *fh, char *buf, size_t count);
479 void zebra_record_int_end (void *fh, off_t offset);
481 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
482 int cmd, struct recKeys *reckeys);
483 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
484 int cmd, struct sortKeys *skp);
485 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
486 void extract_token_add (RecWord *p);
487 int explain_extract (void *handle, Record rec, data1_node *n);
489 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
492 int zebra_begin_read (ZebraHandle zh);
493 int zebra_end_read (ZebraHandle zh);
495 int zebra_file_stat (const char *file_name, struct stat *buf,
498 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
500 void *iscz1_start ();
501 void iscz1_reset (void *vp);
502 void iscz1_stop (void *p);
503 void iscz1_decode (void *vp, char **dst, const char **src);
504 void iscz1_encode (void *vp, char **dst, const char **src);