← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/base.h

Cleanup around SAFEMALLOC

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/base.h
1
 
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
 
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
 
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems
5
 
 *
6
 
 *  This program is free software; you can redistribute it and/or modify
7
 
 *  it under the terms of the GNU General Public License as published by
8
 
 *  the Free Software Foundation; version 2 of the License.
9
 
 *
10
 
 *  This program is distributed in the hope that it will be useful,
11
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
 *  GNU General Public License for more details.
14
 
 *
15
 
 *  You should have received a copy of the GNU General Public License
16
 
 *  along with this program; if not, write to the Free Software
17
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
 
 */
 
1
/* Copyright (C) 2000 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 */
19
15
 
20
16
/* This file includes constants used with all databases */
21
17
 
22
 
/**
23
 
 * @TODO Name this file something better and split it out if necessary.
 
18
/** 
 
19
 * @TODO Name this file something better and split it out if necessary.  
 
20
 * base.h isn't descriptive, especially compared to global.h 
24
21
 *
25
22
 * @TODO Convert HA_XXX defines into enums and/or bitmaps
26
23
 */
27
24
 
28
 
#ifndef DRIZZLED_BASE_H
29
 
#define DRIZZLED_BASE_H
30
 
 
31
 
namespace drizzled
32
 
{
 
25
#ifndef DRIZZLE_SERVER_BASE_H
 
26
#define DRIZZLE_SERVER_BASE_H
 
27
 
 
28
#ifndef stdin                           /* Included first in handler */
 
29
#define CHSIZE_USED
 
30
#include <drizzled/global.h>
 
31
#include <mysys/my_dir.h>               /* This includes types */
 
32
#include <mysys/my_sys.h>
 
33
#include <mystrings/m_string.h>
 
34
#include <errno.h>
 
35
 
 
36
#ifndef EOVERFLOW
 
37
#define EOVERFLOW 84
 
38
#endif
 
39
 
 
40
#endif  /* stdin */
 
41
#include <mysys/my_list.h>
33
42
 
34
43
/* The following is bits in the flag parameter to ha_open() */
35
44
 
37
46
#define HA_OPEN_WAIT_IF_LOCKED          1
38
47
#define HA_OPEN_IGNORE_IF_LOCKED        2
39
48
#define HA_OPEN_TMP_TABLE               4       /* Table is a temp table */
 
49
#define HA_OPEN_DELAY_KEY_WRITE         8       /* Don't update index  */
 
50
#define HA_OPEN_ABORT_IF_CRASHED        16
 
51
#define HA_OPEN_FOR_REPAIR              32      /* open even if crashed */
 
52
#define HA_OPEN_FROM_SQL_LAYER          64
 
53
#define HA_OPEN_MMAP                    128     /* open memory mapped */
 
54
#define HA_OPEN_COPY                    256     /* Open copy (for repair) */
40
55
/* Internal temp table, used for temporary results */
41
56
#define HA_OPEN_INTERNAL_TABLE          512
42
57
 
82
97
enum ha_key_alg {
83
98
  HA_KEY_ALG_UNDEF=     0,              /* Not specified (old file) */
84
99
  HA_KEY_ALG_BTREE=     1,              /* B-tree, default one          */
85
 
  HA_KEY_ALG_HASH=      3               /* HASH keys (HEAP tables) */
 
100
  HA_KEY_ALG_RTREE=     2,              /* R-tree, for spatial searches */
 
101
  HA_KEY_ALG_HASH=      3,              /* HASH keys (HEAP tables) */
 
102
  HA_KEY_ALG_FULLTEXT=  4               /* FULLTEXT (MyISAM tables) */
86
103
};
87
104
 
88
105
        /* Index and table build methods */
89
106
 
90
 
enum ha_build_method {
91
 
  HA_BUILD_DEFAULT,
 
107
enum ha_build_method { 
 
108
  HA_BUILD_DEFAULT, 
92
109
  HA_BUILD_ONLINE,
93
 
  HA_BUILD_OFFLINE
 
110
  HA_BUILD_OFFLINE 
94
111
};
95
112
 
96
113
        /* The following is parameter to ha_extra() */
133
150
  HA_EXTRA_CHANGE_KEY_TO_UNIQUE,
134
151
  HA_EXTRA_CHANGE_KEY_TO_DUP,
135
152
  /*
136
 
    When using HA_EXTRA_KEYREAD, overwrite only key member fields and keep
 
153
    When using HA_EXTRA_KEYREAD, overwrite only key member fields and keep 
137
154
    other fields intact. When this is off (by default) InnoDB will use memcpy
138
155
    to overwrite entire row.
139
156
  */
140
157
  HA_EXTRA_KEYREAD_PRESERVE_FIELDS,
 
158
  HA_EXTRA_MMAP,
141
159
  /*
142
160
    Ignore if the a tuple is not found, continue processing the
143
161
    transaction and ignore that 'row'.  Needed for idempotency
158
176
  HA_EXTRA_WRITE_CANNOT_REPLACE,
159
177
  /*
160
178
    Inform handler that delete_row()/update_row() cannot batch deletes/updates
161
 
    and should perform them immediately. This may be needed when table has
 
179
    and should perform them immediately. This may be needed when table has 
162
180
    AFTER DELETE/UPDATE triggers which access to subject table.
163
181
    These flags are reset by the handler::extra(HA_EXTRA_RESET) call.
164
182
  */
173
191
  HA_EXTRA_PREPARE_FOR_RENAME
174
192
};
175
193
 
 
194
/* Compatible option, to be deleted in 6.0 */
 
195
#define HA_EXTRA_PREPARE_FOR_DELETE HA_EXTRA_PREPARE_FOR_DROP
 
196
 
176
197
        /* The following is parameter to ha_panic() */
177
198
 
178
199
enum ha_panic_function {
187
208
  HA_KEYTYPE_END=0,
188
209
  HA_KEYTYPE_TEXT=1,                    /* Key is sorted as letters */
189
210
  HA_KEYTYPE_BINARY=2,                  /* Key is sorted as unsigned chars */
 
211
  HA_KEYTYPE_SHORT_INT=3,
190
212
  HA_KEYTYPE_LONG_INT=4,
 
213
  HA_KEYTYPE_FLOAT=5,
191
214
  HA_KEYTYPE_DOUBLE=6,
 
215
  HA_KEYTYPE_NUM=7,                     /* Not packed num with pre-space */
 
216
  HA_KEYTYPE_USHORT_INT=8,
192
217
  HA_KEYTYPE_ULONG_INT=9,
193
218
  HA_KEYTYPE_LONGLONG=10,
194
219
  HA_KEYTYPE_ULONGLONG=11,
 
220
  HA_KEYTYPE_INT24=12,
195
221
  HA_KEYTYPE_UINT24=13,
 
222
  HA_KEYTYPE_INT8=14,
196
223
  /* Varchar (0-255 bytes) with length packed with 1 byte */
197
224
  HA_KEYTYPE_VARTEXT1=15,               /* Key is sorted as letters */
198
225
  HA_KEYTYPE_VARBINARY1=16,             /* Key is sorted as unsigned chars */
199
226
  /* Varchar (0-65535 bytes) with length packed with 2 bytes */
200
227
  HA_KEYTYPE_VARTEXT2=17,               /* Key is sorted as letters */
201
 
  HA_KEYTYPE_VARBINARY2=18              /* Key is sorted as unsigned chars */
 
228
  HA_KEYTYPE_VARBINARY2=18,             /* Key is sorted as unsigned chars */
 
229
  HA_KEYTYPE_BIT=19
202
230
};
203
231
 
 
232
#define HA_MAX_KEYTYPE  31              /* Must be log2-1 */
 
233
 
204
234
        /* These flags kan be OR:ed to key-flag */
205
235
 
206
236
#define HA_NOSAME                1      /* Set if not dupplicated records */
211
241
#define HA_NULL_ARE_EQUAL       2048    /* NULL in key are cmp as equal */
212
242
#define HA_GENERATED_KEY        8192    /* Automaticly generated key */
213
243
 
 
244
        /* The combination of the above can be used for key type comparison. */
 
245
#define HA_KEYFLAG_MASK (HA_NOSAME | HA_PACK_KEY | HA_AUTO_KEY | \
 
246
                         HA_BINARY_PACK_KEY | HA_UNIQUE_CHECK | \
 
247
                         HA_NULL_ARE_EQUAL | HA_GENERATED_KEY)
 
248
 
214
249
#define HA_KEY_HAS_PART_KEY_SEG 65536   /* Key contains partial segments */
215
250
 
216
251
        /* Automatic bits in key-flag */
219
254
#define HA_VAR_LENGTH_KEY        8
220
255
#define HA_NULL_PART_KEY         64
221
256
#define HA_USES_COMMENT          4096
222
 
#define HA_USES_BLOCK_SIZE       ((uint32_t) 32768)
 
257
#define HA_USES_BLOCK_SIZE       ((uint) 32768)
223
258
#define HA_SORT_ALLOWS_SAME      512    /* Intern bit when sorting records */
224
259
 
225
260
        /* These flags can be added to key-seg-flag */
243
278
#define HA_OPTION_PACK_RECORD           1
244
279
#define HA_OPTION_PACK_KEYS             2
245
280
#define HA_OPTION_COMPRESS_RECORD       4
 
281
#define HA_OPTION_LONG_BLOB_PTR         8 /* new ISAM format */
246
282
#define HA_OPTION_TMP_TABLE             16
 
283
#define HA_OPTION_CHECKSUM              32
 
284
#define HA_OPTION_DELAY_KEY_WRITE       64
247
285
#define HA_OPTION_NO_PACK_KEYS          128  /* Reserved for MySQL */
248
 
#define HA_OPTION_TEMP_COMPRESS_RECORD  ((uint32_t) 16384)      /* set by isamchk */
249
 
#define HA_OPTION_READ_ONLY_DATA        ((uint32_t) 32768)      /* Set by isamchk */
 
286
#define HA_OPTION_CREATE_FROM_ENGINE    256
 
287
#define HA_OPTION_RELIES_ON_SQL_LAYER   512
 
288
#define HA_OPTION_NULL_FIELDS           1024
 
289
#define HA_OPTION_PAGE_CHECKSUM         2048
 
290
#define HA_OPTION_TEMP_COMPRESS_RECORD  ((uint) 16384)  /* set by isamchk */
 
291
#define HA_OPTION_READ_ONLY_DATA        ((uint) 32768)  /* Set by isamchk */
250
292
 
251
293
        /* Bits in flag to create() */
252
294
 
253
295
#define HA_DONT_TOUCH_DATA      1       /* Don't empty datafile (isamchk) */
254
296
#define HA_PACK_RECORD          2       /* Request packed record format */
255
297
#define HA_CREATE_TMP_TABLE     4
 
298
#define HA_CREATE_CHECKSUM      8
256
299
#define HA_CREATE_KEEP_FILES    16      /* don't overwrite .MYD and MYI */
 
300
#define HA_CREATE_PAGE_CHECKSUM 32
 
301
#define HA_CREATE_DELAY_KEY_WRITE 64
 
302
#define HA_CREATE_RELIES_ON_SQL_LAYER 128
257
303
 
258
304
/*
259
305
  The following flags (OR-ed) are passed to handler::info() method.
301
347
/*
302
348
  Errorcodes given by handler functions
303
349
 
304
 
  optimizer::sum_query() assumes these codes are > 1
 
350
  opt_sum_query() assumes these codes are > 1
305
351
  Do not add error numbers before HA_ERR_FIRST.
306
352
  If necessary to add lower numbers, change HA_ERR_FIRST accordingly.
307
353
*/
386
432
 
387
433
        /* Other constants */
388
434
 
389
 
typedef unsigned long key_part_map;
 
435
#define HA_NAMELEN 64                   /* Max length of saved filename */
 
436
#define NO_SUCH_KEY (~(uint)0)          /* used as a key no. */
 
437
 
 
438
typedef ulong key_part_map;
390
439
#define HA_WHOLE_KEY  (~(key_part_map)0)
391
440
 
392
441
        /* Intern constants in databases */
406
455
#define MBR_WITHIN      2048
407
456
#define MBR_DISJOINT    4096
408
457
#define MBR_EQUAL       8192
 
458
#define MBR_DATA        16384
409
459
#define SEARCH_NULL_ARE_EQUAL 32768     /* NULL in keys are equal */
410
460
#define SEARCH_NULL_ARE_NOT_EQUAL 65536 /* NULL in keys are not equal */
411
461
 
412
462
        /* bits in opt_flag */
 
463
#define QUICK_USED      1
413
464
#define READ_CACHE_USED 2
414
465
#define READ_CHECK_USED 4
415
466
#define KEY_READ_USED   8
423
474
#define HA_STATE_DELETED        8
424
475
#define HA_STATE_NEXT_FOUND     16      /* Next found record (record before) */
425
476
#define HA_STATE_PREV_FOUND     32      /* Prev found record (record after) */
 
477
#define HA_STATE_NO_KEY         64      /* Last read didn't find record */
426
478
#define HA_STATE_KEY_CHANGED    128
427
479
#define HA_STATE_WRITE_AT_END   256     /* set in _ps_find_writepos */
 
480
#define HA_STATE_BUFF_SAVED     512     /* If current keybuff is info->buff */
428
481
#define HA_STATE_ROW_CHANGED    1024    /* To invalide ROW cache */
429
482
#define HA_STATE_EXTEND_BLOCK   2048
430
483
#define HA_STATE_RNEXT_SAME     4096    /* rnext_same occupied lastkey2 */
455
508
/* X > key, i.e. not including the right endpoint */
456
509
#define NEAR_MAX        8
457
510
 
458
 
/*
459
 
  This flag means that index is a unique index, and the interval is
 
511
/* 
 
512
  This flag means that index is a unique index, and the interval is 
460
513
  equivalent to "AND(keypart_i = const_i)", where all of const_i are not NULLs.
461
514
*/
462
515
#define UNIQUE_RANGE    16
463
516
 
464
 
/*
465
 
  This flag means that the interval is equivalent to
466
 
  "AND(keypart_i = const_i)", where not all key parts may be used but all of
 
517
/* 
 
518
  This flag means that the interval is equivalent to 
 
519
  "AND(keypart_i = const_i)", where not all key parts may be used but all of 
467
520
  const_i are not NULLs.
468
521
*/
469
522
#define EQ_RANGE        32
470
523
 
471
524
/*
472
525
  This flag has the same meaning as UNIQUE_RANGE, except that for at least
473
 
  one keypart the condition is "keypart IS NULL".
 
526
  one keypart the condition is "keypart IS NULL". 
474
527
*/
475
528
#define NULL_RANGE      64
476
529
 
477
530
typedef struct st_key_range
478
531
{
479
 
  const unsigned char *key;
480
 
  uint32_t length;
 
532
  const uchar *key;
 
533
  uint length;
 
534
  key_part_map keypart_map;
481
535
  enum ha_rkey_function flag;
482
 
  key_part_map keypart_map;
483
536
} key_range;
484
537
 
485
538
typedef struct st_key_multi_range
487
540
  key_range start_key;
488
541
  key_range end_key;
489
542
  char  *ptr;                 /* Free to use by caller (ptr to row etc) */
490
 
  uint32_t  range_flag;           /* key range flags see above */
 
543
  uint  range_flag;           /* key range flags see above */
491
544
} KEY_MULTI_RANGE;
492
545
 
493
546
 
495
548
typedef uint64_t        ha_rows;
496
549
#define rows2double(A)  uint64_t2double(A)
497
550
 
498
 
#define HA_POS_ERROR    (~ (::drizzled::ha_rows) 0)
499
 
#define HA_OFFSET_ERROR (~ (::drizzled::internal::my_off_t) 0)
 
551
#define HA_POS_ERROR    (~ (ha_rows) 0)
 
552
#define HA_OFFSET_ERROR (~ (my_off_t) 0)
500
553
 
501
554
#if SIZEOF_OFF_T == 4
502
555
#define MAX_FILE_SIZE   INT32_MAX
506
559
 
507
560
#define HA_VARCHAR_PACKLENGTH(field_length) ((field_length) < 256 ? 1 :2)
508
561
 
509
 
 
510
 
} /* namespace drizzled */
511
 
 
512
 
#endif /* DRIZZLED_BASE_H */
 
562
/* invalidator function reference for Query Cache */
 
563
typedef void (* invalidator_by_filename)(const char * filename);
 
564
 
 
565
#endif /* DRIZZLE_SERVER_BASE_H */