1 /* $Id: index.h,v 1.180 2006-10-29 17:20:01 adam Exp $
2 Copyright (C) 1995-2006
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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <idzebra/version.h>
29 #include <idzebra/util.h>
30 #include <idzebra/flock.h>
34 #include <sys/times.h>
38 #include <idzebra/dict.h>
39 #include <idzebra/isams.h>
40 #include <idzebra/isamc.h>
41 #include <idzebra/isamb.h>
43 #include <idzebra/recgrs.h>
45 #include <idzebra/api.h>
53 #define ISAM_DEFAULT "b"
57 #define IT_MAX_WORD 256
59 #define IT_KEY_LEVEL_MAX 5
62 zint mem[IT_KEY_LEVEL_MAX];
65 enum dirsKind { dirs_dir, dirs_file };
80 void getFnameTmp (Res res, char *fname, int no);
82 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
83 struct dirs_info *dirs_fopen (Dict dict, const char *path, int rw);
84 struct dirs_entry *dirs_read (struct dirs_info *p);
85 struct dirs_entry *dirs_last (struct dirs_info *p);
86 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
87 void dirs_rmdir (struct dirs_info *p, const char *src);
88 void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
89 void dirs_del (struct dirs_info *p, const char *src);
90 void dirs_free (struct dirs_info **pp);
92 struct dir_entry *dir_open (const char *rep, const char *base,
94 void dir_sort (struct dir_entry *e);
95 void dir_free (struct dir_entry **e_p);
97 void repositoryUpdate (ZebraHandle zh, const char *path);
98 void repositoryAdd (ZebraHandle zh, const char *path);
99 void repositoryDelete (ZebraHandle zh, const char *path);
100 void repositoryShow (ZebraHandle zh, const char *path);
102 int key_open (ZebraHandle zh, int mem);
103 int key_close (ZebraHandle zh);
104 int key_compare (const void *p1, const void *p2);
105 void key_init(struct it_key *k);
106 char *key_print_it (const void *p, char *buf);
107 zint key_get_seq (const void *p);
108 zint key_get_segment (const void *p);
109 int key_compare_it (const void *p1, const void *p2);
110 int key_qsort_compare (const void *p1, const void *p2);
111 void key_logdump (int mask, const void *p);
112 void key_logdump_txt (int logmask, const void *p, const char *txt);
113 void inv_prstat (ZebraHandle zh);
114 void inv_compact (BFiles bfs);
115 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
116 ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
117 ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
118 int merge_sort (char **buf, int from, int to);
119 int key_SU_code (int ch, char *out);
121 #define FNAME_DICT "dict"
122 #define FNAME_ISAM "isam"
123 #define FNAME_ISAMC "isamc"
124 #define FNAME_ISAMS "isams"
125 #define FNAME_ISAMH "isamh"
126 #define FNAME_ISAMD "isamd"
127 #define FNAME_CONFIG "zebra.cfg"
129 #define GMATCH_DICT "gmatch"
130 #define FMATCH_DICT "fmatch%d"
132 struct strtab *strtab_mk (void);
133 int strtab_src (struct strtab *t, const char *name, void ***infop);
134 void strtab_del (struct strtab *t,
135 void (*func)(const char *name, void *info, void *data),
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 void zebra_lock_prefix (Res res, char *dst);
145 #define FNAME_MAIN_LOCK "zebraidx.LCK"
146 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
147 #define FNAME_ORG_LOCK "zebraorg.LCK"
148 #define FNAME_TOUCH_TIME "zebraidx.time"
150 int key_SU_decode (int *ch, const unsigned char *out);
151 int key_SU_encode (int ch, char *out);
153 typedef struct zebra_set *ZebraSet;
155 typedef struct zebra_rank_class {
156 struct rank_control *control;
159 struct zebra_rank_class *next;
164 struct zebra_register {
173 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
174 time_t registerChange;
177 ZebraExplainInfo zei;
179 char *server_path_prefix;
181 ZebraMaps zebra_maps;
182 ZebraRankClass rank_classes;
188 zebra_rec_keys_t keys;
189 zebra_rec_keys_t sortKeys;
197 struct zebra_service {
200 struct zebra_session *sessions;
201 struct zebra_register *regs;
202 Zebra_mutex_cond session_lock;
205 const char *path_root;
206 RecTypeClass record_classes;
211 struct zebra_session {
212 struct zebra_session *next;
213 struct zebra_service *service;
214 struct zebra_register *reg;
216 char *xadmin_databaseName;
224 ZebraLockHandle lock_normal;
225 ZebraLockHandle lock_shadow;
246 int m_segment_indexing;
248 zint records_inserted;
249 zint records_updated;
250 zint records_deleted;
251 zint records_processed;
252 char *record_encoding;
254 yaz_iconv_t iconv_to_utf8;
255 yaz_iconv_t iconv_from_utf8;
259 const char *m_record_id;
260 const char *m_record_type;
263 int m_explain_database;
265 int m_file_verbose_limit;
267 void *store_data_buf;
268 size_t store_data_size;
271 struct zebra_limit *m_limit;
275 struct term_set_entry {
277 struct term_set_entry *next;
280 struct term_set_list {
281 struct term_set_entry *first;
282 struct term_set_entry *last;
286 void zebra_limit_destroy(struct zebra_limit *zl);
287 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
288 void zebra_limit_for_rset(struct zebra_limit *zl,
289 int (**filter_func)(const void *buf, void *data),
290 void (**filter_destroy)(void *data),
293 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
295 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
296 oid_value attributeSet,
297 NMEM stream, NMEM rset_nmem,
298 Z_SortKeySpecList *sort_sequence,
299 int num_bases, char **basenames,
302 ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
303 oid_value attributeset,
304 int num_bases, char **basenames,
305 int *position, int *num_entries, ZebraScanEntry **list,
306 int *is_partial, RSET limit_set);
308 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
309 const char *term, int length_term, const char *flags,
310 int preserve_position, int term_type, NMEM rset_nmem,
311 struct rset_key_control *kctrl, int scope,
312 struct ord_list *ol, int reg_type,
313 zint hits_limit, const char *term_ref_id);
315 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
316 const char *db, const char *index_name,
318 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
319 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
320 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
321 int num_bases, char **basenames,
322 const char *setname);
323 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
324 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
326 ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
327 int num_input_setnames, const char **input_setnames,
328 const char *output_setname,
329 Z_SortKeySpecList *sort_sequence, int *sort_status);
330 ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
331 ZebraSet sset, RSET rset,
332 Z_SortKeySpecList *sort_sequence,
334 ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
336 void resultSetInvalidate (ZebraHandle zh);
338 int zebra_server_lock_init (ZebraService zh);
339 int zebra_server_lock_destroy (ZebraService zh);
340 int zebra_server_lock (ZebraService zh, int lockCommit);
341 void zebra_server_unlock (ZebraService zh, int commitPhase);
342 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
344 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score,
345 zebra_snippets *hit_snippet, ODR stream,
346 oid_value input_format, Z_RecordComposition *comp,
347 oid_value *output_format, char **rec_bufp,
348 int *rec_lenp, char **basenamep,
351 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
353 void zebra_index_merge (ZebraHandle zh);
355 ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
356 const char *buf, size_t buf_size,
359 const char *recordType,
361 const char *match_criteria,
366 ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
367 struct ZebraRecStream *stream,
370 const char *recordType,
372 const char *match_criteria,
377 void *recTypeClientData);
380 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
381 const char *buf, size_t buf_size,
382 const char *databaseName, int delete_flag,
383 int test_mode, int *sysno,
384 int store_keys, int store_data,
385 const char *match_criteria);
387 void extract_flushWriteKeys (ZebraHandle zh, int final);
389 YAZ_EXPORT void zebra_create_stream_mem(struct ZebraRecStream *stream,
390 const char *buf, size_t sz);
391 YAZ_EXPORT void zebra_create_stream_fd(struct ZebraRecStream *stream,
392 int fd, off_t start_offset);
393 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
395 ZEBRA_RES zebra_snippets_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys,
396 zebra_snippets *snippets);
397 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
398 zint sysno, zebra_snippets *snippets);
400 ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n);
402 ZEBRA_RES zebra_extract_file(ZebraHandle zh, SYSNO *sysno, const char *fname,
405 ZEBRA_RES zebra_begin_read (ZebraHandle zh);
406 ZEBRA_RES zebra_end_read (ZebraHandle zh);
408 int zebra_file_stat (const char *file_name, struct stat *buf,
411 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
413 void *iscz1_start (void);
414 void iscz1_reset (void *vp);
415 void iscz1_stop (void *p);
416 void iscz1_decode (void *vp, char **dst, const char **src);
417 void iscz1_encode (void *vp, char **dst, const char **src);
419 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
420 int compact_flag, Res res);
422 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
423 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
425 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
426 char **dst, const char *src);
428 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
430 void zebra_term_untrans(ZebraHandle zh, int reg_type,
431 char *dst, const char *src);
433 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
434 Z_AttributesPlusTerm *zapt,
436 const char *xpath_use,
437 oid_value curAttributeSet,
440 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
441 Z_AttributeList *attr_list,
442 zinfo_index_category_t cat,
444 oid_value curAttributeSet,
447 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
448 Z_SortAttributes *sortAttributes,
452 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
453 ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
454 ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
455 ZEBRA_RES zebra_remove_file_match(ZebraHandle zh);
458 struct rpn_char_map_info
464 void rpn_char_map_prepare(struct zebra_register *reg, int reg_type,
465 struct rpn_char_map_info *map_info);
467 ZEBRA_RES zapt_term_to_utf8(ZebraHandle zh, Z_AttributesPlusTerm *zapt,
471 #define FIRST_IN_FIELD_STR "\001^"
472 #define FIRST_IN_FIELD_CHAR 1
473 #define FIRST_IN_FIELD_LEN 2
481 * indent-tabs-mode: nil
483 * vim: shiftwidth=4 tabstop=8 expandtab