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