Work on new API. Locking system re-implemented
[idzebra-moved-to-github.git] / index / zserver.h
index be38062..77c7db6 100644 (file)
 /*
- * Copyright (C) 1994-2000, Index Data 
+ * Copyright (C) 1994-2002, Index Data 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
- * $Log: zserver.h,v $
- * Revision 1.47  2000-03-20 19:08:36  adam
- * Added remote record import using Z39.50 extended services and Segment
- * Requests.
- *
- * Revision 1.46  2000/03/15 15:00:31  adam
- * First work on threaded version.
- *
- * Revision 1.45  1999/11/30 13:48:04  adam
- * Improved installation. Updated for inclusion of YAZ header files.
- *
- * Revision 1.44  1999/11/04 15:00:45  adam
- * Implemented delete result set(s).
- *
- * Revision 1.43  1999/07/14 10:59:27  adam
- * Changed functions isc_getmethod, isams_getmethod.
- * Improved fatal error handling (such as missing EXPLAIN schema).
- *
- * Revision 1.42  1999/05/26 07:49:13  adam
- * C++ compilation.
- *
- * Revision 1.41  1999/05/12 13:08:06  adam
- * First version of ISAMS.
- *
- * Revision 1.40  1998/11/16 16:03:45  adam
- * Moved loggin utilities to Yaz. Was implemented in file zlogs.c.
- *
- * Revision 1.39  1998/10/16 08:14:35  adam
- * Updated record control system.
- *
- * Revision 1.38  1998/09/22 10:03:44  adam
- * Changed result sets to be persistent in the sense that they can
- * be re-searched if needed.
- * Fixed memory leak in rsm_or.
- *
- * Revision 1.37  1998/09/02 13:53:22  adam
- * Extra parameter decode added to search routines to implement
- * persistent queries.
- *
- * Revision 1.36  1998/06/24 12:16:16  adam
- * Support for relations on text operands. Open range support in
- * DFA module (i.e. [-j], [g-]).
- *
- * Revision 1.35  1998/06/23 15:33:35  adam
- * Added feature to specify sort criteria in query (type 7 specifies
- * sort flags).
- *
- * Revision 1.34  1998/06/22 11:36:50  adam
- * Added authentication check facility to zebra.
- *
- * Revision 1.33  1998/06/12 12:22:14  adam
- * Work on Zebra API.
- *
- * Revision 1.32  1998/05/27 16:57:47  adam
- * Zebra returns surrogate diagnostic for single records when
- * appropriate.
- *
- * Revision 1.31  1998/05/20 10:12:23  adam
- * Implemented automatic EXPLAIN database maintenance.
- * Modified Zebra to work with ASN.1 compiled version of YAZ.
- *
- * Revision 1.30  1998/03/05 08:45:13  adam
- * New result set model and modular ranking system. Moved towards
- * descent server API. System information stored as "SGML" records.
- *
- * Revision 1.29  1998/02/10 12:03:06  adam
- * Implemented Sort.
- *
- * Revision 1.28  1998/01/29 13:40:11  adam
- * Better logging for scan service.
- *
- * Revision 1.27  1997/10/27 14:33:06  adam
- * Moved towards generic character mapping depending on "structure"
- * field in abstract syntax file. Fixed a few memory leaks. Fixed
- * bug with negative integers when doing searches with relational
- * operators.
- *
- * Revision 1.26  1997/09/29 12:41:35  adam
- * Fixed bug regarding USE_TIMES var.
- *
- * Revision 1.25  1997/09/29 09:08:36  adam
- * Revised locking system to be thread safe for the server.
- *
- * Revision 1.24  1997/09/17 12:19:19  adam
- * Zebra version corresponds to YAZ version 1.4.
- * Changed Zebra server so that it doesn't depend on global common_resource.
- *
- * Revision 1.23  1996/12/23 15:30:46  adam
- * Work on truncation.
- * Bug fix: result sets weren't deleted after server shut down.
- *
- * Revision 1.22  1996/11/04 14:07:49  adam
- * Moved truncation code to trunc.c.
- *
- * Revision 1.21  1996/10/29 14:09:58  adam
- * Use of cisam system - enabled if setting isamc is 1.
- *
- * Revision 1.20  1996/06/04 10:19:02  adam
- * Minor changes - removed include of ctype.h.
- *
- * Revision 1.19  1996/05/14  11:34:01  adam
- * Scan support in multiple registers/databases.
- *
- * Revision 1.18  1996/05/14  06:16:50  adam
- * Compact use/set bytes used in search service.
- *
- * Revision 1.17  1995/12/08 16:22:57  adam
- * Work on update while servers are running. Three lock files introduced.
- * The servers reload their registers when necessary, but they don't
- * reestablish result sets yet.
- *
- * Revision 1.16  1995/12/07  17:38:48  adam
- * Work locking mechanisms for concurrent updates/commit.
- *
- * Revision 1.15  1995/11/21  15:29:13  adam
- * Config file 'base' read by default by both indexer and server.
- *
- * Revision 1.14  1995/11/16  17:00:57  adam
- * Better logging of rpn query.
- *
- * Revision 1.13  1995/11/16  15:34:56  adam
- * Uses new record management system in both indexer and server.
- *
- * Revision 1.12  1995/10/27  14:00:12  adam
- * Implemented detection of database availability.
- *
- * Revision 1.11  1995/10/17  18:02:12  adam
- * New feature: databases. Implemented as prefix to words in dictionary.
- *
- * Revision 1.10  1995/10/09  16:18:38  adam
- * Function dict_lookup_grep got extra client data parameter.
- *
- * Revision 1.9  1995/10/06  14:38:01  adam
- * New result set method: r_score.
- * Local no (sysno) and score is transferred to retrieveCtrl.
- *
- * Revision 1.8  1995/10/06  13:52:06  adam
- * Bug fixes. Handler may abort further scanning.
- *
- * Revision 1.7  1995/10/06  10:43:57  adam
- * Scan added. 'occurrences' in scan entries not set yet.
- *
- * Revision 1.6  1995/09/28  09:19:48  adam
- * xfree/xmalloc used everywhere.
- * Extract/retrieve method seems to work for text records.
- *
- * Revision 1.5  1995/09/27  16:17:32  adam
- * More work on retrieve.
- *
- * Revision 1.4  1995/09/14  11:53:28  adam
- * First work on regular expressions/truncations.
- *
- * Revision 1.3  1995/09/08  08:53:23  adam
- * Record buffer maintained in server_info.
- *
- * Revision 1.2  1995/09/06  16:11:19  adam
- * Option: only one word key per file.
- *
- * Revision 1.1  1995/09/05  15:28:40  adam
- * More work on search engine.
- *
+ * $Id: zserver.h,v 1.52 2002-02-20 17:30:01 adam Exp $
  */
 
 #if HAVE_SYS_TIMES_H
 #include <sys/times.h>
 #endif
 
-#if HAVE_PTHREADS_H
-#include <pthreads.h>
-#endif
-
 #include <yaz/backend.h>
 #include <rset.h>
 
 YAZ_BEGIN_CDECL
 
 typedef struct {
+    char *term;
+    char *db;
     int sysno;
     int score;
 } *ZebraPosSet;
@@ -209,6 +47,7 @@ struct zebra_service {
     ISAMD isamd;
 #endif
     Dict dict;
+    Dict matchDict;
     SortIdx sortIdx;
     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
     time_t registerChange;
@@ -218,11 +57,8 @@ struct zebra_service {
     Res res;
     ZebraLockHandle server_lock_cmt;
     ZebraLockHandle server_lock_org;
+
     char *server_path_prefix;
-#if HAVE_SYS_TIMES_H
-    struct tms tms1;
-    struct tms tms2;    
-#endif
     data1_handle dh;
     ZebraMaps zebra_maps;
     ZebraRankClass rank_classes;
@@ -230,7 +66,7 @@ struct zebra_service {
     Passwd_db passwd_db;
     Zebra_mutex_cond session_lock;
     int stop_flag;
-    int active;
+    int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
 };
 
 struct recKeys {
@@ -262,12 +98,24 @@ struct zebra_session {
     size_t ptr_i;
     size_t key_buf_used;
     int key_file_no;
+    char *admin_databaseName;
 
+    ZebraLockHandle lock_normal;
+    ZebraLockHandle lock_shadow;
+
+    int trans_no;
+    int seqno;
+    int last_val;
     int destroyed;
     ZebraSet sets;
     int errCode;
     int hits;
     char *errString;
+#if HAVE_SYS_TIMES_H
+    struct tms tms1;
+    struct tms tms2;    
+#endif
+    struct recordGroup rGroup;
 };
 
 struct rank_control {
@@ -280,6 +128,16 @@ struct rank_control {
     void (*add)(void *set_handle, int seqno, int term_index);
 };
 
+struct term_set_entry {
+    char *term;
+    struct term_set_entry *next;
+};
+
+struct term_set_list {
+    struct term_set_entry *first;
+    struct term_set_entry *last;
+};
+
 RSET rpn_search (ZebraHandle zh, NMEM mem,
                 Z_RPNQuery *rpn, int num_bases, char **basenames, 
                 const char *setname, ZebraSet sset);
@@ -294,9 +152,13 @@ void rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 RSET rset_trunc (ZebraHandle zh, ISAMS_P *isam_p, int no,
                 const char *term, int length_term, const char *flags);
 
+void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
+                      const char *db, int set,
+                      int use, const char *term);
 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
-ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode,                                         Z_RPNQuery *rpn, int num_bases, char **basenames,
+ZebraSet resultSetAddRPN (ZebraHandle zh, ODR stream, ODR decode,
+                          Z_RPNQuery *rpn, int num_bases, char **basenames,
                           const char *setname);
 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId);
 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
@@ -314,6 +176,7 @@ void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
                          ZebraSet sset, RSET rset,
                          Z_SortKeySpecList *sort_sequence, int *sort_status);
 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset);
+void resultSetInvalidate (ZebraHandle zh);
 
 void zebra_sort (ZebraHandle zh, ODR stream,
                 int num_input_setnames, const char **input_setnames,
@@ -349,10 +212,19 @@ void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 void zebra_index_merge (ZebraHandle zh);
 
 
+int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
+                        const char *buf, size_t buf_size,
+                        const char *databaseName, int delete_flag,
+                        int test_mode, int *sysno,
+                        int store_keys, int store_data,
+                        const char *match_criteria);
+
+void extract_flushWriteKeys (ZebraHandle zh);
+
 struct zebra_fetch_control {
-    int offset_end;
-    int record_offset;
-    int record_int_pos;
+    off_t offset_end;
+    off_t record_offset;
+    off_t record_int_pos;
     const char *record_int_buf;
     int record_int_len;
     int fd;
@@ -366,4 +238,12 @@ off_t zebra_record_int_tell (void *fh);
 int zebra_record_int_read (void *fh, char *buf, size_t count);
 void zebra_record_int_end (void *fh, off_t offset);
 
+void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
+                              int cmd, struct recKeys *reckeys);
+void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
+                            int cmd, struct sortKey **skp);
+void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
+void extract_token_add (RecWord *p);
+int explain_extract (void *handle, Record rec, data1_node *n);
+
 YAZ_END_CDECL