index/zserver.h

   1 /*
   2  * Copyright (C) 1994-1998, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: zserver.h,v $
   7  * Revision 1.30  1998-03-05 08:45:13  adam
   8  * New result set model and modular ranking system. Moved towards
   9  * descent server API. System information stored as "SGML" records.
  10  *
  11  * Revision 1.29  1998/02/10 12:03:06  adam
  12  * Implemented Sort.
  13  *
  14  * Revision 1.28  1998/01/29 13:40:11  adam
  15  * Better logging for scan service.
  16  *
  17  * Revision 1.27  1997/10/27 14:33:06  adam
  18  * Moved towards generic character mapping depending on "structure"
  19  * field in abstract syntax file. Fixed a few memory leaks. Fixed
  20  * bug with negative integers when doing searches with relational
  21  * operators.
  22  *
  23  * Revision 1.26  1997/09/29 12:41:35  adam
  24  * Fixed bug regarding USE_TIMES var.
  25  *
  26  * Revision 1.25  1997/09/29 09:08:36  adam
  27  * Revised locking system to be thread safe for the server.
  28  *
  29  * Revision 1.24  1997/09/17 12:19:19  adam
  30  * Zebra version corresponds to YAZ version 1.4.
  31  * Changed Zebra server so that it doesn't depend on global common_resource.
  32  *
  33  * Revision 1.23  1996/12/23 15:30:46  adam
  34  * Work on truncation.
  35  * Bug fix: result sets weren't deleted after server shut down.
  36  *
  37  * Revision 1.22  1996/11/04 14:07:49  adam
  38  * Moved truncation code to trunc.c.
  39  *
  40  * Revision 1.21  1996/10/29 14:09:58  adam
  41  * Use of cisam system - enabled if setting isamc is 1.
  42  *
  43  * Revision 1.20  1996/06/04 10:19:02  adam
  44  * Minor changes - removed include of ctype.h.
  45  *
  46  * Revision 1.19  1996/05/14  11:34:01  adam
  47  * Scan support in multiple registers/databases.
  48  *
  49  * Revision 1.18  1996/05/14  06:16:50  adam
  50  * Compact use/set bytes used in search service.
  51  *
  52  * Revision 1.17  1995/12/08 16:22:57  adam
  53  * Work on update while servers are running. Three lock files introduced.
  54  * The servers reload their registers when necessary, but they don't
  55  * reestablish result sets yet.
  56  *
  57  * Revision 1.16  1995/12/07  17:38:48  adam
  58  * Work locking mechanisms for concurrent updates/commit.
  59  *
  60  * Revision 1.15  1995/11/21  15:29:13  adam
  61  * Config file 'base' read by default by both indexer and server.
  62  *
  63  * Revision 1.14  1995/11/16  17:00:57  adam
  64  * Better logging of rpn query.
  65  *
  66  * Revision 1.13  1995/11/16  15:34:56  adam
  67  * Uses new record management system in both indexer and server.
  68  *
  69  * Revision 1.12  1995/10/27  14:00:12  adam
  70  * Implemented detection of database availability.
  71  *
  72  * Revision 1.11  1995/10/17  18:02:12  adam
  73  * New feature: databases. Implemented as prefix to words in dictionary.
  74  *
  75  * Revision 1.10  1995/10/09  16:18:38  adam
  76  * Function dict_lookup_grep got extra client data parameter.
  77  *
  78  * Revision 1.9  1995/10/06  14:38:01  adam
  79  * New result set method: r_score.
  80  * Local no (sysno) and score is transferred to retrieveCtrl.
  81  *
  82  * Revision 1.8  1995/10/06  13:52:06  adam
  83  * Bug fixes. Handler may abort further scanning.
  84  *
  85  * Revision 1.7  1995/10/06  10:43:57  adam
  86  * Scan added. 'occurrences' in scan entries not set yet.
  87  *
  88  * Revision 1.6  1995/09/28  09:19:48  adam
  89  * xfree/xmalloc used everywhere.
  90  * Extract/retrieve method seems to work for text records.
  91  *
  92  * Revision 1.5  1995/09/27  16:17:32  adam
  93  * More work on retrieve.
  94  *
  95  * Revision 1.4  1995/09/14  11:53:28  adam
  96  * First work on regular expressions/truncations.
  97  *
  98  * Revision 1.3  1995/09/08  08:53:23  adam
  99  * Record buffer maintained in server_info.
 100  *
 101  * Revision 1.2  1995/09/06  16:11:19  adam
 102  * Option: only one word key per file.
 103  *
 104  * Revision 1.1  1995/09/05  15:28:40  adam
 105  * More work on search engine.
 106  *
 107  */
 108
 109
 110 #ifndef USE_TIMES
 111 #ifdef __linux__
 112 #define USE_TIMES 1
 113 #else
 114 #define USE_TIMES 0
 115 #endif
 116 #endif
 117
 118 #if USE_TIMES
 119 #include <sys/times.h>
 120 #endif
 121
 122 #include <backend.h>
 123 #include <rset.h>
 124
 125 #include <sortidx.h>
 126 #include "index.h"
 127 #include "zinfo.h"
 128
 129 typedef struct {
 130     int sysno;
 131     int score;
 132 } *ZebraPosSet;
 133
 134 typedef struct zebra_set *ZebraSet;
 135
 136 typedef struct zebra_rank_class {
 137     struct rank_control *control;
 138     int init_flag;
 139     void *class_handle;
 140     struct zebra_rank_class *next;
 141 } *ZebraRankClass;
 142
 143 struct zebra_info {
 144     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 145     time_t registerChange;
 146     ZebraSet sets;
 147     Dict dict;
 148     SortIdx sortIdx;
 149     ISAM isam;
 150     ISAMC isamc;
 151     Records records;
 152     int errCode;
 153     int hits;
 154     char *errString;
 155     ZebraExplainInfo zei;
 156     data1_handle dh;
 157     data1_attset *registered_sets;
 158     BFiles bfs;
 159     Res res;
 160
 161     ZebraLockHandle server_lock_cmt;
 162     ZebraLockHandle server_lock_org;
 163     char *server_path_prefix;
 164 #if USE_TIMES
 165     struct tms tms1;
 166     struct tms tms2;
 167 #endif
 168     ZebraMaps zebra_maps;
 169     ZebraRankClass rank_classes;
 170 };
 171
 172 typedef struct zebra_info *ZebraHandle;
 173
 174 struct rank_control {
 175     char *name;
 176     void *(*create)(ZebraHandle zh);
 177     void (*destroy)(ZebraHandle zh, void *class_handle);
 178     void *(*begin)(ZebraHandle zh, void *class_handle, RSET rset);
 179     void (*end)(ZebraHandle zh, void *set_handle);
 180     int (*calc)(void *set_handle, int sysno);
 181     void (*add)(void *set_handle, int seqno, int term_index);
 182 };
 183
 184 void rpn_search (ZebraHandle zh, ODR stream,
 185                  Z_RPNQuery *rpn, int num_bases, char **basenames,
 186                  const char *setname);
 187
 188
 189 typedef struct {
 190     int occurrences;
 191     char *term;
 192 } ZebraScanEntry;
 193
 194 void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 195                oid_value attributeset,
 196                int num_bases, char **basenames,
 197                int *position, int *num_entries, ZebraScanEntry **list,
 198                int *is_partial);
 199
 200 RSET rset_trunc (ZebraHandle zh, ISAM_P *isam_p, int no,
 201                  const char *term, int length_term, const char *flags);
 202
 203 ZebraSet resultSetAdd (ZebraHandle zh, const char *name,
 204                           int ov, RSET rset, int *hits);
 205 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 206 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
 207 void resultSetDestroy (ZebraHandle zh);
 208
 209 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
 210                                int num, int *positions);
 211 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num);
 212
 213 void resultSetSort (ZebraHandle zh, ODR stream,
 214                     int num_input_setnames, char **input_setnames,
 215                     char *output_setname, Z_SortKeySpecList *sort_sequence,
 216                     int *sort_status);
 217
 218 void zebra_sort (ZebraHandle zh, ODR stream,
 219                  int num_input_setnames, char **input_setnames,
 220                  char *output_setname, Z_SortKeySpecList *sort_sequence,
 221                  int *sort_status);
 222
 223 void zlog_rpn (Z_RPNQuery *rpn);
 224 void zlog_scan (Z_AttributesPlusTerm *zapt, oid_value ast);
 225
 226 int zebra_server_lock_init (ZebraHandle zh);
 227 int zebra_server_lock_destroy (ZebraHandle zh);
 228 int zebra_server_lock (ZebraHandle zh, int lockCommit);
 229 void zebra_server_unlock (ZebraHandle zh, int commitPhase);
 230 int zebra_server_lock_get_state (ZebraHandle zh, time_t *timep);
 231
 232 typedef struct attent
 233 {
 234     int attset_ordinal;
 235     data1_local_attribute *local_attributes;
 236 } attent;
 237
 238 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl);
 239 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 240 void zebraRankDestroy (ZebraHandle zh);
 241
 242 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att);
 243
 244 extern struct rank_control *rank1_class;
 245
 246 ZebraHandle zebra_open (const char *host, const char *configName);
 247 void zebra_search_rpn (ZebraHandle zh, ODR stream,
 248                        Z_RPNQuery *query, int num_bases, char **basenames,
 249                        const char *setname);
 250
 251 typedef struct {
 252     int position;
 253     char *buf;
 254     int len;
 255     oid_value format;
 256     char *base;
 257 } ZebraRetrievalRecord;
 258
 259 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
 260                              const char *setname, Z_RecordComposition *comp,
 261                              oid_value input_format,
 262                              int num_recs, ZebraRetrievalRecord *recs);
 263
 264 int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
 265                         oid_value input_format, Z_RecordComposition *comp,
 266                         oid_value *output_format, char **rec_bufp,
 267                         int *rec_lenp, char **basenamep);
 268
 269 void zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 270                  oid_value attributeset,
 271                  int num_bases, char **basenames,
 272                  int *position, int *num_entries, ZebraScanEntry **list,
 273                  int *is_partial);
 274
 275 void zebra_close (ZebraHandle zh);
 276