index/zserver.h

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