include/isam.h

   1 /*
   2  * Copyright (C) 1994, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: isam.h,v $
   7  * Revision 1.9  1994-09-28 16:58:26  quinn
   8  * Small mod.
   9  *
  10  * Revision 1.8  1994/09/28  12:56:09  quinn
  11  * Added access functions (ISPT)
  12  *
  13  * Revision 1.7  1994/09/28  11:56:13  quinn
  14  * Removed const from input to is_merge
  15  *
  16  * Revision 1.6  1994/09/28  11:29:28  quinn
  17  * Added cmp parameter.
  18  *
  19  * Revision 1.5  1994/09/27  20:03:36  quinn
  20  * Seems relatively bug-free.
  21  *
  22  * Revision 1.4  1994/09/26  17:05:54  quinn
  23  * Trivial.
  24  *
  25  * Revision 1.3  1994/09/26  16:08:42  quinn
  26  * Most of the functionality in place.
  27  *
  28  * Revision 1.2  1994/09/14  13:10:35  quinn
  29  * Small changes
  30  *
  31  * Revision 1.1  1994/09/12  08:02:07  quinn
  32  * Not functional yet
  33  *
  34  */
  35
  36 #ifndef ISAM_H
  37 #define ISAM_H
  38
  39 #include <bfile.h>
  40
  41 #include "../isam/memory.h"
  42 #include "../isam/physical.h"
  43
  44 #define IS_MAX_BLOCKTYPES 4
  45 #define IS_MAX_RECORD 512
  46 #define IS_DEF_REPACK_PERCENT "30" /* how much relative change before repack */
  47
  48 typedef unsigned int SYSNO; /* should be somewhere else */
  49
  50 /*
  51  * Description of a blocktype (part of an isam file)
  52  */
  53 typedef struct isam_blocktype
  54 {
  55     BFile bf;                    /* blocked file */
  56     int blocksize;
  57     int first_block;             /* position of first data block */
  58     int max_keys_block;          /* max num of keys per block */
  59     int max_keys_block0;         /* max num of keys in first block */
  60     int nice_keys_block;         /* nice number of keys per block */
  61     int max_keys;                /* max number of keys per table */
  62     int freelist;                /* first free block */
  63     int top;                     /* first unused block */
  64     int index;                   /* placeholder. Always 0. */
  65     char *dbuf;                  /* buffer for use in I/O operations */
  66 } isam_blocktype;
  67
  68 /*
  69  * Handle to an open isam complex.
  70  */
  71 typedef struct isam_struct
  72 {
  73     isam_blocktype types[IS_MAX_BLOCKTYPES]; /* block_types used in this file */
  74     int num_types;                /* number of block types used */
  75     int writeflag;
  76     int keysize;                  /* size of the keys (records) used */
  77     int repack;                   /* how many percent to grow before repack */
  78     int (*cmp)(const void *k1, const void *k2); /* compare function */
  79 } isam_struct;
  80
  81 typedef struct ispt_struct
  82 {
  83     struct is_mtable tab;
  84     struct ispt_struct *next;      /* freelist */
  85 } ispt_struct, *ISPT;
  86
  87 #define is_type(x) ((x) & 3)      /* type part of position */
  88 #define is_block(x) ((x) >> 2)     /* block # part of position */
  89
  90 #define is_keysize(is) ((is)->keysize)
  91
  92 /*
  93  * Public Prototypes.
  94  *******************************************************************
  95  */
  96
  97 /*
  98  * Open isam file.
  99  */
 100 ISAM is_open(const char *name, int (*cmp)(const void *p1, const void *p2),
 101     int writeflag);
 102
 103 /*
 104  * Close isam file.
 105  */
 106 int is_close(ISAM is);
 107
 108 /*
 109  * Locate a table of keys in an isam file. The ISPT is an individual
 110  * position marker for that table.
 111  */
 112 ISPT is_position(ISAM is, ISAM_P pos);
 113
 114 /*
 115  * Release ISPT.
 116  */
 117 void is_pt_free(ISPT ip);
 118
 119 /*
 120  * Read a key from a table.
 121  */
 122 int is_readkey(ISPT ip, void *buf);
 123
 124 int is_writekey(ISPT ip, const void *buf);
 125
 126 int is_numkeys(ISPT ip);
 127
 128 void is_rewind(ISPT ip);
 129
 130 ISAM_P is_merge(ISAM is, ISAM_P pos, int num, char *data);
 131
 132 #endif