← Back to branch summary

~ubuntu-branches/ubuntu/trusty/drizzle/trusty

« back to all changes in this revision

Viewing changes to plugin/heap/heap.h

  • Committer: Bazaar Package Importer
  • Author(s): Monty Taylor
  • Date: 2010-10-02 14:17:48 UTC
  • mfrom: (1.1.1 upstream)
  • mto: (2.1.17 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20101002141748-m6vbfbfjhrw1153e
Tags: 2010.09.1802-1
* New upstream release.
* Removed pid-file argument hack.
* Updated GPL-2 address to be new address.
* Directly copy in drizzledump.1 since debian doesn't have sphinx 1.0 yet.
* Link to jquery from libjs-jquery. Add it as a depend.
* Add drizzled.8 symlink to the install files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/heap/heap.h
1
 
/* Copyright (C) 2000,2004 MySQL AB
2
 
 
3
 
   This program is free software; you can redistribute it and/or modify
4
 
   it under the terms of the GNU General Public License as published by
5
 
   the Free Software Foundation; version 2 of the License.
6
 
 
7
 
   This program is distributed in the hope that it will be useful,
8
 
   but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 
   GNU General Public License for more details.
11
 
 
12
 
   You should have received a copy of the GNU General Public License
13
 
   along with this program; if not, write to the Free Software
14
 
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
15
 
 
16
 
/* This file should be included when using heap_database_functions */
17
 
/* Author: Michael Widenius */
18
 
 
19
 
#ifndef PLUGIN_HEAP_HEAP_H
20
 
#define PLUGIN_HEAP_HEAP_H
21
 
 
22
 
#include <drizzled/base.h>
23
 
#include <drizzled/common.h>
24
 
#include "drizzled/internal/my_pthread.h"
25
 
#include <drizzled/thr_lock.h>
26
 
 
27
 
#include <plugin/myisam/my_handler.h>
28
 
#include "drizzled/my_tree.h"
29
 
 
30
 
        /* defines used by heap-funktions */
31
 
 
32
 
#define HP_MAX_LEVELS   4               /* 128^5 records is enough */
33
 
#define HP_PTRS_IN_NOD  128
34
 
 
35
 
        /* struct used with heap_funktions */
36
 
 
37
 
typedef struct st_heapinfo              /* Struct from heap_info */
38
 
{
39
 
  uint32_t records;                     /* Records in database */
40
 
  uint32_t deleted;                     /* Deleted records in database */
41
 
  uint32_t max_records;
42
 
  uint64_t data_length;
43
 
  uint64_t index_length;
44
 
  uint32_t reclength;                   /* Length of one record */
45
 
  int errkey;
46
 
  uint64_t auto_increment;
47
 
} HEAPINFO;
48
 
 
49
 
 
50
 
        /* Structs used by heap-database-handler */
51
 
 
52
 
typedef struct st_heap_ptrs
53
 
{
54
 
  unsigned char *blocks[HP_PTRS_IN_NOD];                /* pointers to HP_PTRS or records */
55
 
} HP_PTRS;
56
 
 
57
 
struct st_level_info
58
 
{
59
 
  /* Number of unused slots in *last_blocks HP_PTRS block (0 for 0th level) */
60
 
  uint32_t free_ptrs_in_block;
61
 
 
62
 
  /*
63
 
    Maximum number of records that can be 'contained' inside of each element
64
 
    of last_blocks array. For level 0 - 1, for level 1 - HP_PTRS_IN_NOD, for
65
 
    level 2 - HP_PTRS_IN_NOD^2 and so forth.
66
 
  */
67
 
  uint32_t records_under_level;
68
 
 
69
 
  /*
70
 
    Ptr to last allocated HP_PTRS (or records buffer for level 0) on this
71
 
    level.
72
 
  */
73
 
  HP_PTRS *last_blocks;
74
 
};
75
 
 
76
 
 
77
 
/*
78
 
  Heap table records and hash index entries are stored in HP_BLOCKs.
79
 
  HP_BLOCK is used as a 'growable array' of fixed-size records. Size of record
80
 
  is recbuffer bytes.
81
 
  The internal representation is as follows:
82
 
  HP_BLOCK is a hierarchical structure of 'blocks'.
83
 
  A block at level 0 is an array records_in_block records.
84
 
  A block at higher level is an HP_PTRS structure with pointers to blocks at
85
 
  lower levels.
86
 
  At the highest level there is one top block. It is stored in HP_BLOCK::root.
87
 
 
88
 
  See hp_find_block for a description of how record pointer is obtained from
89
 
  its index.
90
 
  See hp_get_new_block
91
 
*/
92
 
 
93
 
typedef struct st_heap_block
94
 
{
95
 
  HP_PTRS *root;                        /* Top-level block */
96
 
  struct st_level_info level_info[HP_MAX_LEVELS+1];
97
 
  uint32_t levels;                          /* number of used levels */
98
 
  uint32_t records_in_block;            /* Records in one heap-block */
99
 
  uint32_t recbuffer;                   /* Length of one saved record */
100
 
  uint32_t last_allocated; /* number of records there is allocated space for */
101
 
} HP_BLOCK;
102
 
 
103
 
struct st_heap_info;                    /* For referense */
104
 
 
105
 
typedef struct st_hp_keydef             /* Key definition with open */
106
 
{
107
 
  uint32_t flag;                                /* HA_NOSAME | HA_NULL_PART_KEY */
108
 
  uint32_t keysegs;                             /* Number of key-segment */
109
 
  uint32_t length;                              /* Length of key (automatic) */
110
 
  uint8_t algorithm;                    /* HASH / BTREE */
111
 
  HA_KEYSEG *seg;
112
 
  HP_BLOCK block;                       /* Where keys are saved */
113
 
  /*
114
 
    Number of buckets used in hash table. Used only to provide
115
 
    #records estimates for heap key scans.
116
 
  */
117
 
  drizzled::ha_rows hash_buckets;
118
 
  drizzled::TREE rb_tree;
119
 
  int (*write_key)(struct st_heap_info *info, struct st_hp_keydef *keyinfo,
120
 
                   const unsigned char *record, unsigned char *recpos);
121
 
  int (*delete_key)(struct st_heap_info *info, struct st_hp_keydef *keyinfo,
122
 
                   const unsigned char *record, unsigned char *recpos, int flag);
123
 
  uint32_t (*get_key_length)(struct st_hp_keydef *keydef, const unsigned char *key);
124
 
} HP_KEYDEF;
125
 
 
126
 
typedef struct st_heap_columndef              /* column information */
127
 
{
128
 
  int16_t  type;                                /* en_fieldtype */
129
 
  uint32_t length;                      /* length of field */
130
 
  uint32_t offset;                      /* Offset to position in row */
131
 
  uint8_t  null_bit;                    /* If column may be 0 */
132
 
  uint16_t null_pos;                    /* position for null marker */
133
 
  uint8_t  length_bytes;  /* length of the size, 1 o 2 bytes */
134
 
} HP_COLUMNDEF;
135
 
 
136
 
typedef struct st_heap_dataspace   /* control data for data space */
137
 
{
138
 
  HP_BLOCK block;
139
 
  uint32_t chunk_count;             /* Total chunks ever allocated in this dataspace */
140
 
  uint32_t del_chunk_count;         /* Deleted chunks count */
141
 
  unsigned char *del_link;               /* Link to last deleted chunk */
142
 
  uint32_t chunk_length;            /* Total length of one chunk */
143
 
  uint32_t chunk_dataspace_length;  /* Length of payload that will be placed into one chunk */
144
 
  uint32_t offset_status;           /* Offset of the status flag relative to the chunk start */
145
 
  uint32_t offset_link;             /* Offset of the linking pointer relative to the chunk start */
146
 
  uint32_t is_variable_size;          /* Test whether records have variable size and so "next" pointer */
147
 
  uint64_t total_data_length;  /* Total size allocated within this data space */
148
 
} HP_DATASPACE;
149
 
 
150
 
 
151
 
typedef struct st_heap_share
152
 
{
153
 
  HP_KEYDEF  *keydef;
154
 
  HP_COLUMNDEF *column_defs;
155
 
  HP_DATASPACE recordspace;  /* Describes "block", which contains actual records */
156
 
 
157
 
  uint32_t min_records,max_records;     /* Params to open */
158
 
  uint64_t index_length,max_table_size;
159
 
  uint32_t key_stat_version;                /* version to indicate insert/delete */
160
 
  uint32_t records;             /* Actual record (row) count */
161
 
  uint32_t blength;                                     /* used_chunk_count rounded up to 2^n */
162
 
  uint32_t fixed_data_length;     /* Length of record's fixed part, which contains keys and always fits into the first chunk */
163
 
  uint32_t fixed_column_count;  /* Number of columns stored in fixed_data_length */
164
 
  uint32_t changed;
165
 
  uint32_t keys,max_key_length;
166
 
  uint32_t column_count;
167
 
  uint32_t currently_disabled_keys;    /* saved value from "keys" when disabled */
168
 
  uint32_t open_count;
169
 
 
170
 
 
171
 
  char * name;                  /* Name of "memory-file" */
172
 
  drizzled::THR_LOCK lock;
173
 
  pthread_mutex_t intern_lock;          /* Locking for use with _locking */
174
 
  bool delete_on_close;
175
 
  uint32_t auto_key;
176
 
  uint32_t auto_key_type;                       /* real type of the auto key segment */
177
 
  uint64_t auto_increment;
178
 
} HP_SHARE;
179
 
 
180
 
struct st_hp_hash_info;
181
 
 
182
 
typedef struct st_heap_info
183
 
{
184
 
  HP_SHARE *s;
185
 
  unsigned char *current_ptr;
186
 
  struct st_hp_hash_info *current_hash_ptr;
187
 
  uint32_t current_record,next_block;
188
 
  int lastinx,errkey;
189
 
  int  mode;                            /* Mode of file (READONLY..) */
190
 
  uint32_t opt_flag,update;
191
 
  unsigned char *lastkey;                       /* Last used key with rkey */
192
 
  unsigned char *recbuf;                         /* Record buffer for rb-tree keys */
193
 
  enum drizzled::ha_rkey_function last_find_flag;
194
 
  drizzled::TREE_ELEMENT *parents[drizzled::MAX_TREE_HEIGHT+1];
195
 
  drizzled::TREE_ELEMENT **last_pos;
196
 
  uint32_t lastkey_len;
197
 
  bool implicit_emptied;
198
 
  drizzled::THR_LOCK_DATA lock;
199
 
} HP_INFO;
200
 
 
201
 
 
202
 
typedef struct st_heap_create_info
203
 
{
204
 
  uint32_t auto_key;                        /* keynr [1 - maxkey] for auto key */
205
 
  uint32_t auto_key_type;
206
 
  uint32_t max_chunk_size;
207
 
  uint32_t is_dynamic;
208
 
  uint64_t max_table_size;
209
 
  uint64_t auto_increment;
210
 
  bool with_auto_increment;
211
 
  bool internal_table;
212
 
} HP_CREATE_INFO;
213
 
 
214
 
        /* Prototypes for heap-functions */
215
 
 
216
 
extern HP_INFO *heap_open(const char *name, int mode);
217
 
extern HP_INFO *heap_open_from_share(HP_SHARE *share, int mode);
218
 
extern HP_INFO *heap_open_from_share_and_register(HP_SHARE *share, int mode);
219
 
extern int heap_close(HP_INFO *info);
220
 
extern int heap_write(HP_INFO *info,const unsigned char *record);
221
 
extern int heap_update(HP_INFO *info,const unsigned char *old_record,const unsigned char *new_record);
222
 
extern int heap_rrnd(HP_INFO *info,unsigned char *buf,unsigned char *pos);
223
 
extern int heap_scan_init(HP_INFO *info);
224
 
extern int heap_scan(register HP_INFO *info, unsigned char *record);
225
 
extern int heap_delete(HP_INFO *info,const unsigned char *buff);
226
 
extern int heap_info(HP_INFO *info,HEAPINFO *x,int flag);
227
 
extern int heap_create(const char *name, uint32_t keys, HP_KEYDEF *keydef,
228
 
           uint32_t columns, HP_COLUMNDEF *columndef,
229
 
           uint32_t max_key_fieldnr, uint32_t key_part_size,
230
 
           uint32_t reclength, uint32_t keys_memory_size,
231
 
           uint32_t max_records, uint32_t min_records,
232
 
           HP_CREATE_INFO *create_info, HP_SHARE **share);
233
 
 
234
 
extern int heap_delete_table(const char *name);
235
 
extern void heap_drop_table(HP_INFO *info);
236
 
extern int heap_extra(HP_INFO *info,enum drizzled::ha_extra_function function);
237
 
extern int heap_reset(HP_INFO *info);
238
 
extern int heap_rename(const char *old_name,const char *new_name);
239
 
extern int heap_panic(enum drizzled::ha_panic_function flag);
240
 
extern int heap_rsame(HP_INFO *info,unsigned char *record,int inx);
241
 
extern int heap_rnext(HP_INFO *info,unsigned char *record);
242
 
extern int heap_rprev(HP_INFO *info,unsigned char *record);
243
 
extern int heap_rfirst(HP_INFO *info,unsigned char *record,int inx);
244
 
extern int heap_rlast(HP_INFO *info,unsigned char *record,int inx);
245
 
extern void heap_clear(HP_INFO *info);
246
 
extern int heap_disable_indexes(HP_INFO *info);
247
 
extern int heap_enable_indexes(HP_INFO *info);
248
 
extern int heap_indexes_are_disabled(HP_INFO *info);
249
 
extern void heap_update_auto_increment(HP_INFO *info, const unsigned char *record);
250
 
drizzled::ha_rows hp_rb_records_in_range(HP_INFO *info,
251
 
                                         int inx, drizzled::key_range *min_key,
252
 
                                         drizzled::key_range *max_key);
253
 
int hp_panic(enum drizzled::ha_panic_function flag);
254
 
int heap_rkey(HP_INFO *info, unsigned char *record, int inx, const unsigned char *key,
255
 
              drizzled::key_part_map keypart_map,
256
 
              enum drizzled::ha_rkey_function find_flag);
257
 
extern unsigned char * heap_find(HP_INFO *info,int inx,const unsigned char *key);
258
 
extern int heap_check_heap(HP_INFO *info, bool print_status);
259
 
extern unsigned char *heap_position(HP_INFO *info);
260
 
 
261
 
/* The following is for programs that uses the old HEAP interface where
262
 
   pointer to rows where a long instead of a (unsigned char*).
263
 
*/
264
 
 
265
 
typedef unsigned char *HEAP_PTR;
266
 
 
267
 
#endif /* PLUGIN_HEAP_HEAP_H */