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