2
Copyright (C) Brian Aker
3
Copyright (C) 2000,2004 MySQL AB
5
This program is free software; you can redistribute it and/or modify
6
it under the terms of the GNU General Public License as published by
7
the Free Software Foundation; version 2 of the License.
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public License for more details.
14
You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
18
/* This file should be included when using heap_database_functions */
19
/* Author: Michael Widenius */
21
#ifndef PLUGIN_MEMORY_HEAP_H
22
#define PLUGIN_MEMORY_HEAP_H
24
#include <drizzled/base.h>
25
#include <drizzled/common.h>
26
#include "drizzled/internal/my_pthread.h"
27
#include <drizzled/thr_lock.h>
29
#include <plugin/myisam/my_handler.h>
30
#include "drizzled/tree.h"
34
/* defines used by heap-funktions */
36
#define HP_MAX_LEVELS 4 /* 128^5 records is enough */
37
#define HP_PTRS_IN_NOD 128
39
/* struct used with heap_funktions */
41
typedef struct st_heapinfo /* Struct from heap_info */
43
uint32_t records; /* Records in database */
44
uint32_t deleted; /* Deleted records in database */
47
uint64_t index_length;
48
uint32_t reclength; /* Length of one record */
50
uint64_t auto_increment;
66
/* Structs used by heap-database-handler */
68
typedef struct st_heap_ptrs
70
unsigned char *blocks[HP_PTRS_IN_NOD]; /* pointers to HP_PTRS or records */
75
/* Number of unused slots in *last_blocks HP_PTRS block (0 for 0th level) */
76
uint32_t free_ptrs_in_block;
79
Maximum number of records that can be 'contained' inside of each element
80
of last_blocks array. For level 0 - 1, for level 1 - HP_PTRS_IN_NOD, for
81
level 2 - HP_PTRS_IN_NOD^2 and so forth.
83
uint32_t records_under_level;
86
Ptr to last allocated HP_PTRS (or records buffer for level 0) on this
92
free_ptrs_in_block(0),
93
records_under_level(0),
100
Heap table records and hash index entries are stored in HP_BLOCKs.
101
HP_BLOCK is used as a 'growable array' of fixed-size records. Size of record
103
The internal representation is as follows:
104
HP_BLOCK is a hierarchical structure of 'blocks'.
105
A block at level 0 is an array records_in_block records.
106
A block at higher level is an HP_PTRS structure with pointers to blocks at
108
At the highest level there is one top block. It is stored in HP_BLOCK::root.
110
See hp_find_block for a description of how record pointer is obtained from
115
typedef struct st_heap_block
117
HP_PTRS *root; /* Top-level block */
118
struct st_level_info level_info[HP_MAX_LEVELS+1];
119
uint32_t levels; /* number of used levels */
120
uint32_t records_in_block; /* Records in one heap-block */
121
uint32_t recbuffer; /* Length of one saved record */
122
uint32_t last_allocated; /* number of records there is allocated space for */
134
struct st_heap_info; /* For referense */
136
typedef struct st_hp_keydef /* Key definition with open */
138
uint32_t flag; /* HA_NOSAME | HA_NULL_PART_KEY */
139
uint32_t keysegs; /* Number of key-segment */
140
uint32_t length; /* Length of key (automatic) */
142
HP_BLOCK block; /* Where keys are saved */
144
Number of buckets used in hash table. Used only to provide
145
#records estimates for heap key scans.
147
drizzled::ha_rows hash_buckets;
150
typedef struct st_heap_dataspace /* control data for data space */
153
uint32_t chunk_count; /* Total chunks ever allocated in this dataspace */
154
uint32_t del_chunk_count; /* Deleted chunks count */
155
unsigned char *del_link; /* Link to last deleted chunk */
156
uint32_t chunk_length; /* Total length of one chunk */
157
uint32_t chunk_dataspace_length; /* Length of payload that will be placed into one chunk */
158
uint32_t offset_status; /* Offset of the status flag relative to the chunk start */
159
uint32_t offset_link; /* Offset of the linking pointer relative to the chunk start */
160
uint64_t total_data_length; /* Total size allocated within this data space */
162
st_heap_dataspace() :
167
chunk_dataspace_length(0),
176
typedef struct st_heap_share
179
HP_DATASPACE recordspace; /* Describes "block", which contains actual records */
181
uint32_t min_records,max_records; /* Params to open */
182
uint64_t index_length,max_table_size;
183
uint32_t key_stat_version; /* version to indicate insert/delete */
184
uint32_t records; /* Actual record (row) count */
185
uint32_t blength; /* used_chunk_count rounded up to 2^n */
186
uint32_t fixed_data_length; /* Length of record's fixed part, which contains keys and always fits into the first chunk */
187
uint32_t fixed_column_count; /* Number of columns stored in fixed_data_length */
189
uint32_t keys,max_key_length;
190
uint32_t column_count;
191
uint32_t currently_disabled_keys; /* saved value from "keys" when disabled */
195
std::string name; /* Name of "memory-file" */
196
bool delete_on_close;
198
uint32_t auto_key_type; /* real type of the auto key segment */
199
uint64_t auto_increment;
210
fixed_data_length(0),
211
fixed_column_count(0),
216
currently_disabled_keys(0),
226
struct st_hp_hash_info;
228
typedef struct st_heap_info
239
void setShare(HP_SHARE *s_arg)
244
unsigned char *current_ptr;
245
struct st_hp_hash_info *current_hash_ptr;
246
uint32_t current_record,next_block;
248
int mode; /* Mode of file (READONLY..) */
249
uint32_t opt_flag,update;
250
std::vector <unsigned char> lastkey; /* Last used key with rkey */
251
enum drizzled::ha_rkey_function last_find_flag;
252
uint32_t lastkey_len;
253
drizzled::THR_LOCK_DATA lock;
257
typedef struct st_heap_create_info
259
uint32_t auto_key; /* keynr [1 - maxkey] for auto key */
260
uint32_t auto_key_type;
261
uint32_t max_chunk_size;
262
uint64_t max_table_size;
263
uint64_t auto_increment;
264
bool with_auto_increment;
268
/* Prototypes for heap-functions */
270
extern HP_INFO *heap_open(const char *name, int mode);
271
extern HP_INFO *heap_open_from_share(HP_SHARE *share, int mode);
272
extern HP_INFO *heap_open_from_share_and_register(HP_SHARE *share, int mode);
273
extern int heap_close(HP_INFO *info);
274
extern int heap_write(HP_INFO *info,const unsigned char *record);
275
extern int heap_update(HP_INFO *info,const unsigned char *old_record,const unsigned char *new_record);
276
extern int heap_rrnd(HP_INFO *info,unsigned char *buf,unsigned char *pos);
277
extern int heap_scan_init(HP_INFO *info);
278
extern int heap_scan(register HP_INFO *info, unsigned char *record);
279
extern int heap_delete(HP_INFO *info,const unsigned char *buff);
280
extern int heap_info(HP_INFO *info,HEAPINFO *x,int flag);
281
extern int heap_create(const char *name, uint32_t keys, HP_KEYDEF *keydef,
283
uint32_t key_part_size,
284
uint32_t reclength, uint32_t keys_memory_size,
285
uint32_t max_records, uint32_t min_records,
286
HP_CREATE_INFO *create_info, HP_SHARE **share);
288
extern int heap_delete_table(const char *name);
289
extern int heap_extra(HP_INFO *info,enum drizzled::ha_extra_function function);
290
extern int heap_reset(HP_INFO *info);
291
extern int heap_rename(const char *old_name,const char *new_name);
292
extern int heap_panic(enum drizzled::ha_panic_function flag);
293
extern int heap_rsame(HP_INFO *info,unsigned char *record,int inx);
294
extern int heap_rnext(HP_INFO *info,unsigned char *record);
295
extern int heap_rprev(HP_INFO *info,unsigned char *record);
296
extern int heap_rfirst(HP_INFO *info,unsigned char *record,int inx);
297
extern int heap_rlast(HP_INFO *info,unsigned char *record,int inx);
298
extern void heap_clear(HP_INFO *info);
299
extern int heap_disable_indexes(HP_INFO *info);
300
extern int heap_enable_indexes(HP_INFO *info);
301
extern int heap_indexes_are_disabled(HP_INFO *info);
302
extern void heap_update_auto_increment(HP_INFO *info, const unsigned char *record);
303
int hp_panic(enum drizzled::ha_panic_function flag);
304
int heap_rkey(HP_INFO *info, unsigned char *record, int inx, const unsigned char *key,
305
drizzled::key_part_map keypart_map,
306
enum drizzled::ha_rkey_function find_flag);
307
extern unsigned char * heap_find(HP_INFO *info,int inx,const unsigned char *key);
308
extern unsigned char *heap_position(HP_INFO *info);
310
/* The following is for programs that uses the old HEAP interface where
311
pointer to rows where a long instead of a (unsigned char*).
314
typedef unsigned char *HEAP_PTR;
316
#endif /* PLUGIN_MEMORY_HEAP_H */