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.29  1998-02-10 12:03:06  adam
   8  * Implemented Sort.
   9  *
  10  * Revision 1.28  1998/01/29 13:40:11  adam
  11  * Better logging for scan service.
  12  *
  13  * Revision 1.27  1997/10/27 14:33:06  adam
  14  * Moved towards generic character mapping depending on "structure"
  15  * field in abstract syntax file. Fixed a few memory leaks. Fixed
  16  * bug with negative integers when doing searches with relational
  17  * operators.
  18  *
  19  * Revision 1.26  1997/09/29 12:41:35  adam
  20  * Fixed bug regarding USE_TIMES var.
  21  *
  22  * Revision 1.25  1997/09/29 09:08:36  adam
  23  * Revised locking system to be thread safe for the server.
  24  *
  25  * Revision 1.24  1997/09/17 12:19:19  adam
  26  * Zebra version corresponds to YAZ version 1.4.
  27  * Changed Zebra server so that it doesn't depend on global common_resource.
  28  *
  29  * Revision 1.23  1996/12/23 15:30:46  adam
  30  * Work on truncation.
  31  * Bug fix: result sets weren't deleted after server shut down.
  32  *
  33  * Revision 1.22  1996/11/04 14:07:49  adam
  34  * Moved truncation code to trunc.c.
  35  *
  36  * Revision 1.21  1996/10/29 14:09:58  adam
  37  * Use of cisam system - enabled if setting isamc is 1.
  38  *
  39  * Revision 1.20  1996/06/04 10:19:02  adam
  40  * Minor changes - removed include of ctype.h.
  41  *
  42  * Revision 1.19  1996/05/14  11:34:01  adam
  43  * Scan support in multiple registers/databases.
  44  *
  45  * Revision 1.18  1996/05/14  06:16:50  adam
  46  * Compact use/set bytes used in search service.
  47  *
  48  * Revision 1.17  1995/12/08 16:22:57  adam
  49  * Work on update while servers are running. Three lock files introduced.
  50  * The servers reload their registers when necessary, but they don't
  51  * reestablish result sets yet.
  52  *
  53  * Revision 1.16  1995/12/07  17:38:48  adam
  54  * Work locking mechanisms for concurrent updates/commit.
  55  *
  56  * Revision 1.15  1995/11/21  15:29:13  adam
  57  * Config file 'base' read by default by both indexer and server.
  58  *
  59  * Revision 1.14  1995/11/16  17:00:57  adam
  60  * Better logging of rpn query.
  61  *
  62  * Revision 1.13  1995/11/16  15:34:56  adam
  63  * Uses new record management system in both indexer and server.
  64  *
  65  * Revision 1.12  1995/10/27  14:00:12  adam
  66  * Implemented detection of database availability.
  67  *
  68  * Revision 1.11  1995/10/17  18:02:12  adam
  69  * New feature: databases. Implemented as prefix to words in dictionary.
  70  *
  71  * Revision 1.10  1995/10/09  16:18:38  adam
  72  * Function dict_lookup_grep got extra client data parameter.
  73  *
  74  * Revision 1.9  1995/10/06  14:38:01  adam
  75  * New result set method: r_score.
  76  * Local no (sysno) and score is transferred to retrieveCtrl.
  77  *
  78  * Revision 1.8  1995/10/06  13:52:06  adam
  79  * Bug fixes. Handler may abort further scanning.
  80  *
  81  * Revision 1.7  1995/10/06  10:43:57  adam
  82  * Scan added. 'occurrences' in scan entries not set yet.
  83  *
  84  * Revision 1.6  1995/09/28  09:19:48  adam
  85  * xfree/xmalloc used everywhere.
  86  * Extract/retrieve method seems to work for text records.
  87  *
  88  * Revision 1.5  1995/09/27  16:17:32  adam
  89  * More work on retrieve.
  90  *
  91  * Revision 1.4  1995/09/14  11:53:28  adam
  92  * First work on regular expressions/truncations.
  93  *
  94  * Revision 1.3  1995/09/08  08:53:23  adam
  95  * Record buffer maintained in server_info.
  96  *
  97  * Revision 1.2  1995/09/06  16:11:19  adam
  98  * Option: only one word key per file.
  99  *
 100  * Revision 1.1  1995/09/05  15:28:40  adam
 101  * More work on search engine.
 102  *
 103  */
 104
 105
 106 #ifndef USE_TIMES
 107 #ifdef __linux__
 108 #define USE_TIMES 1
 109 #else
 110 #define USE_TIMES 0
 111 #endif
 112 #endif
 113
 114 #if USE_TIMES
 115 #include <sys/times.h>
 116 #endif
 117
 118 #include <backend.h>
 119 #include <rset.h>
 120
 121 #include <sortidx.h>
 122 #include "index.h"
 123 #include "zinfo.h"
 124
 125 typedef struct {
 126     int sysno;
 127     int score;
 128 } ZServerSetSysno;
 129
 130 typedef struct ZServerSet_ {
 131     char *name;
 132     RSET rset;
 133     int size;
 134     struct zset_sort_info *sort_info;
 135     struct ZServerSet_ *next;
 136 } ZServerSet;
 137
 138 typedef struct {
 139     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 140     time_t registerChange;
 141     ZServerSet *sets;
 142     Dict dict;
 143     SortIdx sortIdx;
 144     ISAM isam;
 145     ISAMC isamc;
 146     Records records;
 147     int errCode;
 148     char *errString;
 149     ZebTargetInfo *zti;
 150     data1_handle dh;
 151     data1_attset *registered_sets;
 152     BFiles bfs;
 153     Res res;
 154
 155     ZebraLockHandle server_lock_cmt;
 156     ZebraLockHandle server_lock_org;
 157     char *server_path_prefix;
 158 #if USE_TIMES
 159     struct tms tms1;
 160     struct tms tms2;
 161 #endif
 162     ZebraMaps zebra_maps;
 163 } ZServerInfo;
 164
 165 int rpn_search (ZServerInfo *zi, ODR stream,
 166                 Z_RPNQuery *rpn, int num_bases, char **basenames,
 167                 const char *setname, int *hits);
 168
 169 int rpn_scan (ZServerInfo *zi, ODR stream, Z_AttributesPlusTerm *zapt,
 170               oid_value attributeset,
 171               int num_bases, char **basenames,
 172               int *position, int *num_entries, struct scan_entry **list,
 173               int *status);
 174
 175 RSET rset_trunc (ZServerInfo *zi, ISAM_P *isam_p, int no);
 176
 177 ZServerSet *resultSetAdd (ZServerInfo *zi, const char *name,
 178                           int ov, RSET rset);
 179 ZServerSet *resultSetGet (ZServerInfo *zi, const char *name);
 180 void resultSetDestroy (ZServerInfo *zi);
 181
 182 ZServerSetSysno *resultSetSysnoGet (ZServerInfo *zi, const char *name,
 183                                     int num, int *positions);
 184 void resultSetSysnoDel (ZServerInfo *zi, ZServerSetSysno *records, int num);
 185
 186 int resultSetSort (ZServerInfo *zi, bend_sort_rr *rr);
 187
 188 void zlog_rpn (Z_RPNQuery *rpn);
 189 void zlog_scan (Z_AttributesPlusTerm *zapt, oid_value ast);
 190
 191 int zebra_server_lock_init (ZServerInfo *zi);
 192 int zebra_server_lock_destroy (ZServerInfo *zi);
 193 int zebra_server_lock (ZServerInfo *zi, int lockCommit);
 194 void zebra_server_unlock (ZServerInfo *zi, int commitPhase);
 195 int zebra_server_lock_get_state (ZServerInfo *zi, time_t *timep);
 196
 197 typedef struct attent
 198 {
 199     int attset_ordinal;
 200     data1_local_attribute *local_attributes;
 201 } attent;
 202
 203 int att_getentbyatt(ZServerInfo *zi, attent *res, oid_value set, int att);