index/index.h

   1 /* $Id: index.h,v 1.87 2002-09-03 11:44:54 adam Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
   3    Index Data Aps
   4
   5 This file is part of the Zebra server.
   6
   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
  10 version.
  11
  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
  15 for more details.
  16
  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
  20 02111-1307, USA.
  21 */
  22
  23
  24
  25 #ifndef INDEX_H
  26 #define INDEX_H
  27
  28 #include <time.h>
  29 #include <zebraver.h>
  30 #include <zebrautl.h>
  31 #include <zebramap.h>
  32 #include <sortidx.h>
  33
  34 #if HAVE_SYS_TIMES_H
  35 #include <sys/times.h>
  36 #endif
  37 #include <sys/stat.h>
  38
  39 #include <dict.h>
  40 #include <isams.h>
  41 #include <isam.h>
  42 #include <isamc.h>
  43 #include <isamd.h>
  44 #include <isamb.h>
  45 #define ISAM_DEFAULT "c"
  46 #include <yaz/data1.h>
  47 #include <recctrl.h>
  48 #include "recindex.h"
  49 #include "zebraapi.h"
  50 #include "zinfo.h"
  51 #include <passwddb.h>
  52 #include <rset.h>
  53
  54 YAZ_BEGIN_CDECL
  55
  56 #define SU_SCHEME 1
  57
  58 #define IT_MAX_WORD 256
  59 #define IT_KEY_HAVE_SEQNO 1
  60 #define IT_KEY_HAVE_FIELD 0
  61
  62 typedef int SYSNO;
  63
  64 struct it_key {
  65     int  sysno;
  66     int  seqno;
  67 };
  68
  69 enum dirsKind { dirs_dir, dirs_file };
  70
  71 struct dir_entry {
  72     enum dirsKind kind;
  73     char *name;
  74     time_t mtime;
  75 };
  76
  77 struct dirs_entry {
  78     enum dirsKind kind;
  79     char path[256];
  80     SYSNO sysno;
  81     time_t mtime;
  82 };
  83
  84 void getFnameTmp (Res res, char *fname, int no);
  85
  86 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
  87 struct dirs_info *dirs_fopen (Dict dict, const char *path);
  88 struct dirs_entry *dirs_read (struct dirs_info *p);
  89 struct dirs_entry *dirs_last (struct dirs_info *p);
  90 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
  91 void dirs_rmdir (struct dirs_info *p, const char *src);
  92 void dirs_add (struct dirs_info *p, const char *src, int sysno, time_t mtime);
  93 void dirs_del (struct dirs_info *p, const char *src);
  94 void dirs_free (struct dirs_info **pp);
  95
  96 struct dir_entry *dir_open (const char *rep, const char *base,
  97                             int follow_links);
  98 void dir_sort (struct dir_entry *e);
  99 void dir_free (struct dir_entry **e_p);
 100
 101 void repositoryUpdate (ZebraHandle zh);
 102 void repositoryAdd (ZebraHandle zh);
 103 void repositoryDelete (ZebraHandle zh);
 104 void repositoryShow (ZebraHandle zh);
 105
 106 int key_open (ZebraHandle zh, int mem);
 107 int key_close (ZebraHandle zh);
 108 int key_compare (const void *p1, const void *p2);
 109 char *key_print_it (const void *p, char *buf);
 110 int key_get_pos (const void *p);
 111 int key_compare_it (const void *p1, const void *p2);
 112 int key_qsort_compare (const void *p1, const void *p2);
 113 void key_logdump (int mask, const void *p);
 114 void inv_prstat (ZebraHandle zh);
 115 void inv_compact (BFiles bfs);
 116 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
 117 ISAMS_M key_isams_m (Res res, ISAMS_M me);
 118 ISAMC_M key_isamc_m (Res res, ISAMC_M me);
 119 ISAMD_M key_isamd_m (Res res, ISAMD_M me);
 120 int merge_sort (char **buf, int from, int to);
 121 int key_SU_code (int ch, char *out);
 122
 123 #define FNAME_DICT "dict"
 124 #define FNAME_ISAM "isam"
 125 #define FNAME_ISAMC "isamc"
 126 #define FNAME_ISAMS "isams"
 127 #define FNAME_ISAMH "isamh"
 128 #define FNAME_ISAMD "isamd"
 129 #define FNAME_CONFIG "zebra.cfg"
 130
 131 #define GMATCH_DICT "gmatch"
 132 #define FMATCH_DICT "fmatch"
 133
 134 struct strtab *strtab_mk (void);
 135 int strtab_src (struct strtab *t, const char *name, void ***infop);
 136 void strtab_del (struct strtab *t,
 137                  void (*func)(const char *name, void *info, void *data),
 138                  void *data);
 139 int index_char_cvt (int c);
 140 int index_word_prefix (char *string, int attset_ordinal,
 141                        int local_attribute, const char *databaseName);
 142
 143
 144 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
 145 void zebraIndexUnlock (ZebraHandle zh);
 146 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
 147 int zebraIndexWait (ZebraHandle zh, int commitPhase);
 148
 149 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
 150 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
 151 #define FNAME_ORG_LOCK    "zebraorg.LCK"
 152 #define FNAME_TOUCH_TIME  "zebraidx.time"
 153
 154 typedef struct zebra_lock_info *ZebraLockHandle;
 155 ZebraLockHandle zebra_lock_create(const char *dir,
 156                                   const char *file, int excl_flag);
 157 void zebra_lock_destroy (ZebraLockHandle h);
 158 int zebra_lock (ZebraLockHandle h);
 159 int zebra_lock_nb (ZebraLockHandle h);
 160 int zebra_unlock (ZebraLockHandle h);
 161 int zebra_lock_fd (ZebraLockHandle h);
 162 void zebra_lock_prefix (Res res, char *dst);
 163 char *zebra_mk_fname (const char *dir, const char *name);
 164
 165 int zebra_lock_w (ZebraLockHandle h);
 166 int zebra_lock_r (ZebraLockHandle h);
 167
 168 void zebra_load_atts (data1_handle dh, Res res);
 169
 170 int key_SU_decode (int *ch, const unsigned char *out);
 171 int key_SU_encode (int ch, char *out);
 172
 173 // extern Res common_resource;
 174
 175 struct encode_info {
 176     int  sysno;
 177     int  seqno;
 178     int  cmd;
 179     char buf[768];
 180 };
 181
 182 void encode_key_init (struct encode_info *i);
 183 char *encode_key_int (int d, char *bp);
 184 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
 185
 186 typedef struct {
 187     char *term;
 188     char *db;
 189     int sysno;
 190     int score;
 191 } *ZebraPosSet;
 192
 193 typedef struct zebra_set *ZebraSet;
 194
 195 typedef struct zebra_rank_class {
 196     struct rank_control *control;
 197     int init_flag;
 198     void *class_handle;
 199     struct zebra_rank_class *next;
 200 } *ZebraRankClass;
 201
 202 struct recKeys {
 203     int buf_used;
 204     int buf_max;
 205     char *buf;
 206     char prevAttrSet;
 207     short prevAttrUse;
 208     int prevSeqNo;
 209 };
 210
 211 struct sortKey {
 212     char *string;
 213     int length;
 214     int attrSet;
 215     int attrUse;
 216     struct sortKey *next;
 217 };
 218
 219 struct zebra_register {
 220     char *name;
 221
 222     ISAMS isams;
 223     ISAM isam;
 224     ISAMC isamc;
 225     ISAMD isamd;
 226     ISAMB isamb;
 227     Dict dict;
 228     Dict matchDict;
 229     SortIdx sortIdx;
 230     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 231     time_t registerChange;
 232     BFiles bfs;
 233     Records records;
 234     ZebraExplainInfo zei;
 235
 236     char *server_path_prefix;
 237     data1_handle dh;
 238     ZebraMaps zebra_maps;
 239     ZebraRankClass rank_classes;
 240     RecTypes recTypes;
 241     int seqno;
 242     int last_val;
 243     int stop_flag;
 244     int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
 245
 246
 247
 248     struct recKeys keys;
 249     struct sortKey *sortKeys;
 250
 251     char **key_buf;
 252     size_t ptr_top;
 253     size_t ptr_i;
 254     size_t key_buf_used;
 255     int key_file_no;
 256 };
 257
 258 struct zebra_service {
 259     int stop_flag;
 260     Res global_res;
 261     char *configName;
 262     struct zebra_session *sessions;
 263     struct zebra_register *regs;
 264     Zebra_mutex_cond session_lock;
 265     Passwd_db passwd_db;
 266     char *path_root;
 267 };
 268
 269
 270 struct zebra_session {
 271     struct zebra_session *next;
 272     struct zebra_service *service;
 273     struct zebra_register *reg;
 274
 275     char *admin_databaseName;
 276
 277     char **basenames;
 278     int num_basenames;
 279     char *reg_name;
 280     char *path_reg;
 281
 282     ZebraLockHandle lock_normal;
 283     ZebraLockHandle lock_shadow;
 284
 285     int trans_no;
 286     int destroyed;
 287     ZebraSet sets;
 288     Res res;
 289     int errCode;
 290     int hits;
 291     char *errString;
 292 #if HAVE_SYS_TIMES_H
 293     struct tms tms1;
 294     struct tms tms2;
 295 #endif
 296     struct recordGroup rGroup;
 297     int  shadow_enable;
 298
 299     int records_inserted;
 300     int records_updated;
 301     int records_deleted;
 302     int records_processed;
 303     char *record_encoding;
 304
 305     yaz_iconv_t iconv_to_utf8;
 306     yaz_iconv_t iconv_from_utf8;
 307 };
 308
 309 struct rank_control {
 310     char *name;
 311     void *(*create)(struct zebra_register *reg);
 312     void (*destroy)(struct zebra_register *reg, void *class_handle);
 313     void *(*begin)(struct zebra_register *reg, void *class_handle, RSET rset);
 314     void (*end)(struct zebra_register *reg, void *set_handle);
 315     int (*calc)(void *set_handle, int sysno);
 316     void (*add)(void *set_handle, int seqno, int term_index);
 317 };
 318
 319 struct term_set_entry {
 320     char *term;
 321     struct term_set_entry *next;
 322 };
 323
 324 struct term_set_list {
 325     struct term_set_entry *first;
 326     struct term_set_entry *last;
 327 };
 328
 329 RSET rpn_search (ZebraHandle zh, NMEM mem,
 330                  Z_RPNQuery *rpn, int num_bases, char **basenames,
 331                  const char *setname, ZebraSet sset);
 332
 333
 334 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 335                oid_value attributeset,
 336                int num_bases, char **basenames,
 337                int *position, int *num_entries, ZebraScanEntry **list,
 338                int *is_partial);
 339
 340 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
 341                  const char *term, int length_term, const char *flags,
 342                  int preserve_position, int term_type);
 343
 344 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
 345                        const char *db, int set,
 346                        int use, const char *term);
 347 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 348 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 349 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode,
 350                           Z_RPNQuery *rpn, int num_bases,
 351                           char **basenames, const char *setname);
 352 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
 353 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
 354                        int *statuses);
 355
 356
 357 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
 358                                int num, int *positions);
 359 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
 360
 361 void resultSetSort (ZebraHandle zh, NMEM nmem,
 362                     int num_input_setnames, const char **input_setnames,
 363                     const char *output_setname,
 364                     Z_SortKeySpecList *sort_sequence, int *sort_status);
 365 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 366                           ZebraSet sset, RSET rset,
 367                           Z_SortKeySpecList *sort_sequence, int *sort_status);
 368 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
 369 void resultSetInvalidate (ZebraHandle zh);
 370
 371 int zebra_server_lock_init (ZebraService zh);
 372 int zebra_server_lock_destroy (ZebraService zh);
 373 int zebra_server_lock (ZebraService zh, int lockCommit);
 374 void zebra_server_unlock (ZebraService zh, int commitPhase);
 375 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
 376
 377 typedef struct attent
 378 {
 379     int attset_ordinal;
 380     data1_local_attribute *local_attributes;
 381 } attent;
 382
 383 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
 384 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 385 void zebraRankDestroy (struct zebra_register *reg);
 386
 387 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
 388
 389 extern struct rank_control *rank1_class;
 390
 391 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
 392                         oid_value input_format, Z_RecordComposition *comp,
 393                         oid_value *output_format, char **rec_bufp,
 394                         int *rec_lenp, char **basenamep);
 395
 396 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 397 void zebra_index_merge (ZebraHandle zh);
 398
 399
 400 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
 401                         const char *buf, size_t buf_size,
 402                         const char *databaseName, int delete_flag,
 403                         int test_mode, int *sysno,
 404                         int store_keys, int store_data,
 405                         const char *match_criteria);
 406
 407 void extract_flushWriteKeys (ZebraHandle zh);
 408
 409 struct zebra_fetch_control {
 410     off_t offset_end;
 411     off_t record_offset;
 412     off_t record_int_pos;
 413     const char *record_int_buf;
 414     int record_int_len;
 415     int fd;
 416 };
 417
 418 int zebra_record_ext_read (void *fh, char *buf, size_t count);
 419 off_t zebra_record_ext_seek (void *fh, off_t offset);
 420 off_t zebra_record_ext_tell (void *fh);
 421 off_t zebra_record_int_seek (void *fh, off_t offset);
 422 off_t zebra_record_int_tell (void *fh);
 423 int zebra_record_int_read (void *fh, char *buf, size_t count);
 424 void zebra_record_int_end (void *fh, off_t offset);
 425
 426 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
 427                               int cmd, struct recKeys *reckeys);
 428 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
 429                             int cmd, struct sortKey **skp);
 430 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
 431 void extract_token_add (RecWord *p);
 432 int explain_extract (void *handle, Record rec, data1_node *n);
 433
 434 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
 435                  const struct recordGroup *rGroup, int deleteFlag);
 436
 437 int zebra_begin_read (ZebraHandle zh);
 438 void zebra_end_read (ZebraHandle zh);
 439
 440 int zebra_file_stat (const char *file_name, struct stat *buf,
 441                      int follow_links);
 442
 443 YAZ_END_CDECL
 444
 445 #endif