index/zserver.h

   1 /*
   2  * Copyright (C) 1994-2002, Index Data
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Id: zserver.h,v 1.54 2002-03-27 07:53:13 adam Exp $
   7  */
   8
   9 #if HAVE_SYS_TIMES_H
  10 #include <sys/times.h>
  11 #endif
  12
  13 #include <yaz/backend.h>
  14 #include <rset.h>
  15
  16 #include <sortidx.h>
  17 #include <passwddb.h>
  18 #include "index.h"
  19 #include "zebraapi.h"
  20 #include "zinfo.h"
  21
  22 YAZ_BEGIN_CDECL
  23
  24 typedef struct {
  25     char *term;
  26     char *db;
  27     int sysno;
  28     int score;
  29 } *ZebraPosSet;
  30
  31 typedef struct zebra_set *ZebraSet;
  32
  33 typedef struct zebra_rank_class {
  34     struct rank_control *control;
  35     int init_flag;
  36     void *class_handle;
  37     struct zebra_rank_class *next;
  38 } *ZebraRankClass;
  39
  40 struct zebra_service {
  41     char *configName;
  42     struct zebra_session *sessions;
  43     ISAMS isams;
  44 #if ZMBOL
  45     ISAM isam;
  46     ISAMC isamc;
  47     ISAMD isamd;
  48 #endif
  49     Dict dict;
  50     Dict matchDict;
  51     SortIdx sortIdx;
  52     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
  53     time_t registerChange;
  54     BFiles bfs;
  55     Records records;
  56     ZebraExplainInfo zei;
  57     Res res;
  58     ZebraLockHandle server_lock_cmt;
  59     ZebraLockHandle server_lock_org;
  60
  61     char *server_path_prefix;
  62     data1_handle dh;
  63     ZebraMaps zebra_maps;
  64     ZebraRankClass rank_classes;
  65     RecTypes recTypes;
  66     Passwd_db passwd_db;
  67     Zebra_mutex_cond session_lock;
  68     int seqno;
  69     int last_val;
  70     int stop_flag;
  71     int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
  72 };
  73
  74 struct recKeys {
  75     int buf_used;
  76     int buf_max;
  77     char *buf;
  78     char prevAttrSet;
  79     short prevAttrUse;
  80     int prevSeqNo;
  81 };
  82
  83 struct sortKey {
  84     char *string;
  85     int length;
  86     int attrSet;
  87     int attrUse;
  88     struct sortKey *next;
  89 };
  90
  91 struct zebra_session {
  92     struct zebra_session *next;
  93     struct zebra_service *service;
  94
  95     struct recKeys keys;
  96     struct sortKey *sortKeys;
  97
  98     char **key_buf;
  99     size_t ptr_top;
 100     size_t ptr_i;
 101     size_t key_buf_used;
 102     int key_file_no;
 103     char *admin_databaseName;
 104
 105     ZebraLockHandle lock_normal;
 106     ZebraLockHandle lock_shadow;
 107
 108     int trans_no;
 109     int destroyed;
 110     ZebraSet sets;
 111     int errCode;
 112     int hits;
 113     char *errString;
 114 #if HAVE_SYS_TIMES_H
 115     struct tms tms1;
 116     struct tms tms2;
 117 #endif
 118     struct recordGroup rGroup;
 119 };
 120
 121 struct rank_control {
 122     char *name;
 123     void *(*create)(ZebraService zh);
 124     void (*destroy)(ZebraService zh, void *class_handle);
 125     void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
 126     void (*end)(ZebraHandle zh, void *set_handle);
 127     int (*calc)(void *set_handle, int sysno);
 128     void (*add)(void *set_handle, int seqno, int term_index);
 129 };
 130
 131 struct term_set_entry {
 132     char *term;
 133     struct term_set_entry *next;
 134 };
 135
 136 struct term_set_list {
 137     struct term_set_entry *first;
 138     struct term_set_entry *last;
 139 };
 140
 141 RSET rpn_search (ZebraHandle zh, NMEM mem,
 142                  Z_RPNQuery *rpn, int num_bases, char **basenames,
 143                  const char *setname, ZebraSet sset);
 144
 145
 146 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 147                oid_value attributeset,
 148                int num_bases, char **basenames,
 149                int *position, int *num_entries, ZebraScanEntry **list,
 150                int *is_partial);
 151
 152 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
 153                  const char *term, int length_term, const char *flags);
 154
 155 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
 156                        const char *db, int set,
 157                        int use, const char *term);
 158 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 159 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 160 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode,
 161                           Z_RPNQuery *rpn, int num_bases, char **basenames,
 162                           const char *setname);
 163 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
 164 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
 165                        int *statuses);
 166
 167 const char *zebra_resultSetTerms (ZebraHandle zh, const char *setname,
 168                                   int no, int *count, int *no_max);
 169
 170 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
 171                                int num, int *positions);
 172 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
 173
 174 void resultSetSort (ZebraHandle zh, NMEM nmem,
 175                     int num_input_setnames, const char **input_setnames,
 176                     const char *output_setname,
 177                     Z_SortKeySpecList *sort_sequence, int *sort_status);
 178 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 179                           ZebraSet sset, RSET rset,
 180                           Z_SortKeySpecList *sort_sequence, int *sort_status);
 181 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
 182 void resultSetInvalidate (ZebraHandle zh);
 183
 184 void zebra_sort (ZebraHandle zh, ODR stream,
 185                  int num_input_setnames, const char **input_setnames,
 186                  const char *output_setname, Z_SortKeySpecList *sort_sequence,
 187                  int *sort_status);
 188
 189 int zebra_server_lock_init (ZebraService zh);
 190 int zebra_server_lock_destroy (ZebraService zh);
 191 int zebra_server_lock (ZebraService zh, int lockCommit);
 192 void zebra_server_unlock (ZebraService zh, int commitPhase);
 193 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
 194
 195 typedef struct attent
 196 {
 197     int attset_ordinal;
 198     data1_local_attribute *local_attributes;
 199 } attent;
 200
 201 void zebraRankInstall (ZebraService zh, struct rank_control *ctrl);
 202 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 203 void zebraRankDestroy (ZebraService zh);
 204
 205 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
 206
 207 extern struct rank_control *rank1_class;
 208
 209 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
 210                         oid_value input_format, Z_RecordComposition *comp,
 211                         oid_value *output_format, char **rec_bufp,
 212                         int *rec_lenp, char **basenamep);
 213
 214 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 215 void zebra_index_merge (ZebraHandle zh);
 216
 217
 218 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
 219                         const char *buf, size_t buf_size,
 220                         const char *databaseName, int delete_flag,
 221                         int test_mode, int *sysno,
 222                         int store_keys, int store_data,
 223                         const char *match_criteria);
 224
 225 void extract_flushWriteKeys (ZebraHandle zh);
 226
 227 struct zebra_fetch_control {
 228     off_t offset_end;
 229     off_t record_offset;
 230     off_t record_int_pos;
 231     const char *record_int_buf;
 232     int record_int_len;
 233     int fd;
 234 };
 235
 236 int zebra_record_ext_read (void *fh, char *buf, size_t count);
 237 off_t zebra_record_ext_seek (void *fh, off_t offset);
 238 off_t zebra_record_ext_tell (void *fh);
 239 off_t zebra_record_int_seek (void *fh, off_t offset);
 240 off_t zebra_record_int_tell (void *fh);
 241 int zebra_record_int_read (void *fh, char *buf, size_t count);
 242 void zebra_record_int_end (void *fh, off_t offset);
 243
 244 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
 245                               int cmd, struct recKeys *reckeys);
 246 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
 247                             int cmd, struct sortKey **skp);
 248 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
 249 void extract_token_add (RecWord *p);
 250 int explain_extract (void *handle, Record rec, data1_node *n);
 251
 252 YAZ_END_CDECL