1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008 Sun Microsystems
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.
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.
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
23
* Mostly constants and some macros/functions used by the server
26
#ifndef DRIZZLED_DEFINITIONS_H
27
#define DRIZZLED_DEFINITIONS_H
29
#include <drizzled/enum.h>
38
/* Global value for how we extend our temporary directory */
39
#define GLOBAL_TEMPORARY_EXT ".temporary"
41
/* These paths are converted to other systems (WIN95) before use */
43
#define LANGUAGE "english/"
44
#define TEMP_PREFIX "MY"
45
#define LOG_PREFIX "ML"
47
#define ER(X) ::drizzled::error_message((X))
49
/* buffer size for strerror_r() */
50
#define STRERROR_MAX 256
52
/* extra 4+4 bytes for slave tmp tables */
53
#define MAX_DBKEY_LENGTH (NAME_LEN*2+1+1+4+4)
54
#define MAX_ALIAS_NAME 256
55
#define MAX_FIELD_NAME 34 /* Max colum name length +2 */
56
#define MAX_SYS_VAR_LENGTH 32
57
#define MAX_INDEXES 64
58
#define MAX_KEY MAX_INDEXES /* Max used keys */
59
#define MAX_REF_PARTS 16 /* Max parts used as ref */
60
#define MAX_KEY_LENGTH 4096 /* max possible key */
61
#define MAX_KEY_LENGTH_DECIMAL_WIDTH 4 /* strlen("4096") */
63
#define MAX_REFLENGTH 8 /* Max length for record ref */
65
#define MAX_REFLENGTH 4 /* Max length for record ref */
67
#define MAX_HOSTNAME 61 /* len+1 in mysql.user */
69
#define MAX_MBWIDTH 4 /* Max multibyte sequence */
70
#define MAX_FIELD_CHARLENGTH 255
71
#define MAX_FIELD_VARCHARLENGTH 65535
72
#define CONVERT_IF_BIGGER_TO_BLOB 512 /* Used for CREATE ... SELECT */
74
/* Max column width +1 */
75
#define MAX_FIELD_WIDTH (MAX_FIELD_CHARLENGTH*MAX_MBWIDTH+1)
77
#define MAX_DATETIME_COMPRESSED_WIDTH 14 /* YYYYMMDDHHMMSS */
79
#define MAX_TABLES (sizeof(table_map)*8-3) /* Max tables in join */
80
#define PARAM_TABLE_BIT (((table_map) 1) << (sizeof(table_map)*8-3))
81
#define OUTER_REF_TABLE_BIT (((table_map) 1) << (sizeof(table_map)*8-2))
82
#define RAND_TABLE_BIT (((table_map) 1) << (sizeof(table_map)*8-1))
83
#define PSEUDO_TABLE_BITS (PARAM_TABLE_BIT | OUTER_REF_TABLE_BIT | \
85
#define MAX_FIELDS 4096 /* Historical limit from MySQL FRM. */
87
#define MAX_SELECT_NESTING (sizeof(nesting_map)*8-1)
89
#define MAX_SORT_MEMORY (2048*1024-MALLOC_OVERHEAD)
90
#define MIN_SORT_MEMORY (32*1024-MALLOC_OVERHEAD)
92
#define DEFAULT_ERROR_COUNT 64
93
#define EXTRA_RECORDS 10 /* Extra records in sort */
94
#define NAMES_SEP_CHAR '\377' /* Char to sep. names */
96
#define READ_RECORD_BUFFER (uint32_t) (IO_SIZE*8) /* Pointer_buffer_size */
97
#define DISK_BUFFER_SIZE (uint32_t) (IO_SIZE*16) /* Size of diskbuffer */
99
#define ME_ERROR (ME_BELL+ME_OLDWIN+ME_NOREFRESH)
100
#define MYF_RW MYF(MY_WME+MY_NABP) /* Vid my_read & my_write */
103
Minimum length pattern before Turbo Boyer-Moore is used
104
for SELECT "text" LIKE "%pattern%", excluding the two
105
wildcards in class Item_func_like.
107
#define MIN_TURBOBM_PATTERN_LEN 3
110
Defines for binary logging.
111
Do not decrease the value of BIN_LOG_HEADER_SIZE.
112
Do not even increase it before checking code.
115
#define BIN_LOG_HEADER_SIZE 4
117
/* Below are #defines that used to be in mysql_priv.h */
118
/***************************************************************************
119
Configuration parameters
120
****************************************************************************/
121
#define MAX_FIELDS_BEFORE_HASH 32
122
#define USER_VARS_HASH_SIZE 16
123
#define TABLE_OPEN_CACHE_MIN 64
124
#define TABLE_OPEN_CACHE_DEFAULT 1024
127
Value of 9236 discovered through binary search 2006-09-26 on Ubuntu Dapper
128
Drake, libc6 2.3.6-0ubuntu2, Linux kernel 2.6.15-27-686, on x86. (Added
129
100 bytes as reasonable buffer against growth and other environments'
132
Feel free to raise this by the smallest amount you can to get the
133
"execution_constants" test to pass.
135
#define STACK_MIN_SIZE 12000 ///< Abort if less stack during eval.
137
#define STACK_MIN_SIZE_FOR_OPEN 1024*80
138
#define STACK_BUFF_ALLOC 352 ///< For stack overrun checks
140
#define QUERY_ALLOC_BLOCK_SIZE 8192
141
#define QUERY_ALLOC_PREALLOC_SIZE 8192
142
#define RANGE_ALLOC_BLOCK_SIZE 4096
143
#define TABLE_ALLOC_BLOCK_SIZE 1024
144
#define WARN_ALLOC_BLOCK_SIZE 2048
145
#define WARN_ALLOC_PREALLOC_SIZE 1024
148
The following parameters is to decide when to use an extra cache to
149
optimise seeks when reading a big table in sorted order
151
#define MIN_FILE_LENGTH_TO_USE_ROW_CACHE (10L*1024*1024)
152
#define MIN_ROWS_TO_USE_TABLE_CACHE 100
155
The following is used to decide if MySQL should use table scanning
156
instead of reading with keys. The number says how many evaluation of the
157
WHERE clause is comparable to reading one extra row from a table.
159
#define TIME_FOR_COMPARE 5 // 5 compares == one read
162
Number of comparisons of table rowids equivalent to reading one row from a
165
#define TIME_FOR_COMPARE_ROWID (TIME_FOR_COMPARE*2)
168
For sequential disk seeks the cost formula is:
169
DISK_SEEK_BASE_COST + DISK_SEEK_PROP_COST * #blocks_to_skip
171
The cost of average seek
172
DISK_SEEK_BASE_COST + DISK_SEEK_PROP_COST*BLOCKS_IN_AVG_SEEK =1.0.
174
#define DISK_SEEK_BASE_COST ((double)0.9)
176
#define BLOCKS_IN_AVG_SEEK 128
178
#define DISK_SEEK_PROP_COST ((double)0.1/BLOCKS_IN_AVG_SEEK)
182
Number of rows in a reference table when refereed through a not unique key.
183
This value is only used when we don't know anything about the key
186
#define MATCHING_ROWS_IN_OTHER_TABLE 10
188
/** Don't pack string keys shorter than this (if PACK_KEYS=1 isn't used). */
189
#define KEY_DEFAULT_PACK_LENGTH 8
191
/** Characters shown for the command in 'show processlist'. */
192
#define PROCESS_LIST_WIDTH 100
194
#define PRECISION_FOR_DOUBLE 53
195
#define PRECISION_FOR_FLOAT 24
197
/* The following can also be changed from the command line */
198
#define DEFAULT_CONCURRENCY 10
199
#define FLUSH_TIME 0 /**< Don't flush tables */
200
#define MAX_CONNECT_ERRORS 10 ///< errors before disabling host
202
/* Bits from testflag */
205
TEST_PRINT_CACHED_TABLES= 1,
208
TEST_KEEP_TMP_TABLES,
209
TEST_READCHECK, /**< Force use of readcheck */
211
TEST_CORE_ON_SIGNAL, /**< Give core if signal */
213
TEST_SIGINT, /**< Allow sigint on threads */
214
TEST_SYNCHRONIZATION /**< get server to do sleep in some places */
217
/* Bits for different SQL modes modes (including ANSI mode) */
218
#define MODE_NO_ZERO_DATE (2)
219
#define MODE_INVALID_DATES (MODE_NO_ZERO_DATE*2)
221
#define MY_CHARSET_BIN_MB_MAXLEN 1
224
static const uint32_t UNCACHEABLE_DEPENDENT= 1;
225
static const uint32_t UNCACHEABLE_RAND= 2;
226
static const uint32_t UNCACHEABLE_SIDEEFFECT= 3;
227
/// forcing to save JOIN for explain
228
static const uint32_t UNCACHEABLE_EXPLAIN= 4;
229
/** Don't evaluate subqueries in prepare even if they're not correlated */
230
static const uint32_t UNCACHEABLE_PREPARE= 5;
231
/* For uncorrelated SELECT in an UNION with some correlated SELECTs */
232
static const uint32_t UNCACHEABLE_UNITED= 6;
234
/* Used to check GROUP BY list in the MODE_ONLY_FULL_GROUP_BY mode */
235
#define UNDEF_POS (-1)
237
/* Options to add_table_to_list() */
238
static const uint32_t TL_OPTION_UPDATING= 0;
239
static const uint32_t TL_OPTION_FORCE_INDEX= 1;
240
static const uint32_t TL_OPTION_IGNORE_LEAVES= 2;
241
static const uint32_t TL_OPTION_ALIAS= 3;
242
static const uint32_t NUM_OF_TABLE_OPTIONS= 4;
244
/* Some portable defines */
246
#define portable_sizeof_char_ptr 8
248
#define TMP_FILE_PREFIX "#sql" /**< Prefix for tmp tables */
249
#define TMP_FILE_PREFIX_LENGTH 4
251
/* Flags for calc_week() function. */
252
#define WEEK_MONDAY_FIRST 1
254
#define WEEK_FIRST_WEEKDAY 4
256
/* used in date and time conversions */
257
/* Daynumber from year 0 to 9999-12-31 */
258
#define MAX_DAY_NUMBER 3652424L
260
#define STRING_BUFFER_USUAL_SIZE 80
262
typedef void *range_seq_t;
264
enum ha_stat_type { HA_ENGINE_STATUS, HA_ENGINE_LOGS, HA_ENGINE_MUTEX };
265
// the following is for checking tables
267
#define HA_ADMIN_ALREADY_DONE 1
268
#define HA_ADMIN_OK 0
269
#define HA_ADMIN_NOT_IMPLEMENTED -1
270
#define HA_ADMIN_FAILED -2
271
#define HA_ADMIN_CORRUPT -3
272
#define HA_ADMIN_INTERNAL_ERROR -4
273
#define HA_ADMIN_INVALID -5
274
#define HA_ADMIN_REJECT -6
276
/* bits in index_flags(index_number) for what you can do with index */
277
#define HA_READ_NEXT 1 /* TODO really use this flag */
278
#define HA_READ_PREV 2 /* supports ::index_prev */
279
#define HA_READ_ORDER 4 /* index_next/prev follow sort order */
280
#define HA_READ_RANGE 8 /* can find all records in a range */
281
#define HA_ONLY_WHOLE_INDEX 16 /* Can't use part key searches */
282
#define HA_KEYREAD_ONLY 64 /* Support HA_EXTRA_KEYREAD */
284
Index scan will not return records in rowid order. Not guaranteed to be
285
set for unordered (e.g. HASH) indexes.
287
#define HA_KEY_SCAN_NOT_ROR 128
289
/* operations for disable/enable indexes */
290
#define HA_KEY_SWITCH_NONUNIQ 0
291
#define HA_KEY_SWITCH_ALL 1
292
#define HA_KEY_SWITCH_NONUNIQ_SAVE 2
293
#define HA_KEY_SWITCH_ALL_SAVE 3
296
Note: the following includes binlog and closing 0.
297
so: innodb + bdb + ndb + binlog + myisam + myisammrg + archive +
298
example + csv + heap + blackhole + federated + 0
299
(yes, the sum is deliberately inaccurate)
300
TODO remove the limit, use dynarrays
305
Parameters for open() (in register form->filestat)
306
HA_GET_INFO does an implicit HA_ABORT_IF_LOCKED
309
#define HA_OPEN_KEYFILE 1
310
#define HA_OPEN_RNDFILE 2
311
#define HA_GET_INDEX 4
312
#define HA_GET_INFO 8 /* do a ha_info() after open */
313
#define HA_READ_ONLY 16 /* File opened as readonly */
314
/* Try readonly if can't open with read and write */
315
#define HA_TRY_READ_ONLY 32
316
#define HA_WAIT_IF_LOCKED 64 /* Wait if locked on open */
317
#define HA_ABORT_IF_LOCKED 128 /* skip if locked on open.*/
318
#define HA_BLOCK_LOCK 256 /* unlock when reading some records */
319
#define HA_OPEN_TEMPORARY 512
321
/* For transactional LOCK Table. handler::lock_table() */
322
#define HA_LOCK_IN_SHARE_MODE F_RDLCK
323
#define HA_LOCK_IN_EXCLUSIVE_MODE F_WRLCK
325
/* Some key definitions */
326
#define HA_KEY_NULL_LENGTH 1
327
#define HA_KEY_BLOB_LENGTH 2
329
#define HA_MAX_REC_LENGTH 65535
331
/* Options of START TRANSACTION statement (and later of SET TRANSACTION stmt) */
332
enum start_transaction_option_t
334
START_TRANS_NO_OPTIONS,
335
START_TRANS_OPT_WITH_CONS_SNAPSHOT
338
/* Flags for method is_fatal_error */
339
#define HA_CHECK_DUP_KEY 1
340
#define HA_CHECK_DUP_UNIQUE 2
341
#define HA_CHECK_DUP (HA_CHECK_DUP_KEY + HA_CHECK_DUP_UNIQUE)
344
/* Bits in used_fields */
345
#define HA_CREATE_USED_AUTO (1L << 0)
346
#define HA_CREATE_USED_CHARSET (1L << 8)
347
#define HA_CREATE_USED_DEFAULT_CHARSET (1L << 9)
348
#define HA_CREATE_USED_ROW_FORMAT (1L << 15)
351
The below two are not used (and not handled) in this milestone of this WL
352
entry because there seems to be no use for them at this stage of
355
#define HA_MRR_SINGLE_POINT 1
356
#define HA_MRR_FIXED_KEY 2
359
Indicates that RANGE_SEQ_IF::next(&range) doesn't need to fill in the
362
#define HA_MRR_NO_ASSOCIATION 4
365
The MRR user will provide ranges in key order, and MRR implementation
366
must return rows in key order.
368
#define HA_MRR_SORTED 8
370
/* MRR implementation doesn't have to retrieve full records */
371
#define HA_MRR_INDEX_ONLY 16
374
The passed memory buffer is of maximum possible size, the caller can't
375
assume larger buffer.
377
#define HA_MRR_LIMITS 32
381
Flag set <=> default MRR implementation is used
382
(The choice is made by **_info[_const]() function which may set this
383
flag. SQL layer remembers the flag value and then passes it to
384
multi_read_range_init().
386
#define HA_MRR_USE_DEFAULT_IMPL 64
389
#define MYF(v) (static_cast<drizzled::myf>(v))
392
"Declared Type Collation"
393
A combination of collation and its derivation.
395
Flags for collation aggregation modes:
396
MY_COLL_ALLOW_SUPERSET_CONV - allow conversion to a superset
397
MY_COLL_ALLOW_COERCIBLE_CONV - allow conversion of a coercible value
399
MY_COLL_ALLOW_CONV - allow any kind of conversion
400
(combination of the above two)
401
MY_COLL_DISALLOW_NONE - don't allow return DERIVATION_NONE
402
(e.g. when aggregating for comparison)
403
MY_COLL_CMP_CONV - combination of MY_COLL_ALLOW_CONV
404
and MY_COLL_DISALLOW_NONE
407
#define MY_COLL_ALLOW_SUPERSET_CONV 1
408
#define MY_COLL_ALLOW_COERCIBLE_CONV 2
409
#define MY_COLL_ALLOW_CONV 3
410
#define MY_COLL_DISALLOW_NONE 4
411
#define MY_COLL_CMP_CONV 7
413
inline static void clear_timestamp_auto_bits(enum timestamp_auto_set_type &_target_,
414
const enum timestamp_auto_set_type _bits_)
416
_target_= (enum timestamp_auto_set_type)((int)(_target_) & ~_bits_);
420
* The following are for the interface with the .frm file
423
#define FIELDFLAG_PACK_SHIFT 3
424
#define FIELDFLAG_MAX_DEC 31
427
// FIXME: T will just be drizzled::Field::utype, but that would
428
// require including field.h. Moving the function elsewhere might be a
429
// better idea. Leaving it for restructuring.
430
template <typename T>
431
T MTYP_TYPENR(const T& type)
433
return static_cast<T>(type & 127);
436
#define MTYP_TYPENR(type) (type & 127) /* Remove bits from type */
439
inline static uint32_t f_settype(const enum enum_field_types x)
441
return (uint32_t(x) << FIELDFLAG_PACK_SHIFT);
445
template <class T> void set_if_bigger(T &a, const T &b)
451
template <class T> void set_if_smaller(T &a, const T &b)
458
#define set_if_bigger(a,b) do { \
459
const typeof(a) _a = (a); \
460
const typeof(b) _b = (b); \
461
(void) (&_a == &_b); \
462
if ((a) < (b)) (a)=(b); \
464
#define set_if_smaller(a,b) do { \
465
const typeof(a) _a = (a); \
466
const typeof(b) _b = (b); \
467
(void) (&_a == &_b); \
468
if ((a) > (b)) (a)=(b); \
472
#define set_if_bigger(a,b) do { if ((a) < (b)) (a)=(b); } while(0)
473
#define set_if_smaller(a,b) do { if ((a) > (b)) (a)=(b); } while(0)
478
#define array_elements(a) \
479
((sizeof(a) / sizeof(*(a))) / \
480
static_cast<size_t>(!(sizeof(a) % sizeof(*(a)))))
483
/* Some types that is different between systems */
486
#define FN_LIBCHAR '/'
487
#define FN_ROOTDIR "/"
489
#define MY_NFILE 64 /* This is only used to save filenames */
490
#ifndef OS_FILE_LIMIT
491
#define OS_FILE_LIMIT 65535
495
How much overhead does malloc have. The code often allocates
496
something like 1024-MALLOC_OVERHEAD bytes
498
#define MALLOC_OVERHEAD 8
500
/* get memory in huncs */
501
static const uint32_t ONCE_ALLOC_INIT= 4096;
502
/* Typical record cash */
503
static const uint32_t RECORD_CACHE_SIZE= 64*1024;
506
/* Some things that this system doesn't have */
508
/* Some defines of functions for portability */
510
#ifndef uint64_t2double
511
#define uint64_t2double(A) ((double) (uint64_t) (A))
515
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
517
#define ulong_to_double(X) ((double) (ulong) (X))
519
/* From limits.h instead */
521
#define DBL_MIN 4.94065645841246544e-324
524
#define DBL_MAX 1.79769313486231470e+308
528
/* Define missing math constants. */
530
#define M_PI 3.14159265358979323846
533
#define M_E 2.7182818284590452354
536
#define M_LN2 0.69314718055994530942
540
Max size that must be added to a so that we know Size to make
543
#define MY_ALIGN(A,L) (((A) + (L) - 1) & ~((L) - 1))
544
#define ALIGN_SIZE(A) MY_ALIGN((A),sizeof(double))
545
/* Size to make adressable obj. */
546
#define ALIGN_PTR(A, t) ((t*) MY_ALIGN((A),sizeof(t)))
547
/* Offset of field f in structure t */
548
#define OFFSET(t, f) ((size_t)(char *)&((t *)0)->f)
550
#define ADD_TO_PTR(ptr,size,type) (type) (reinterpret_cast<const unsigned char*>(ptr)+size)
551
#define PTR_BYTE_DIFF(A,B) (ptrdiff_t) (reinterpret_cast<const unsigned char*>(A) - reinterpret_cast<const unsigned char*>(B))
553
#define ADD_TO_PTR(ptr,size,type) (type) ((unsigned char*) (ptr)+size)
554
#define PTR_BYTE_DIFF(A,B) (ptrdiff_t) ((unsigned char*) (A) - (unsigned char*) (B))
557
#define MY_DIV_UP(A, B) (((A) + (B) - 1) / (B))
558
#define MY_ALIGNED_BYTE_ARRAY(N, S, T) T N[MY_DIV_UP(S, sizeof(T))]
560
/* Typdefs for easyier portability */
563
#if defined(SIZEOF_OFF_T)
564
# if (SIZEOF_OFF_T == 8)
565
# define OFF_T_MAX (INT64_MAX)
567
# define OFF_T_MAX (INT32_MAX)
571
#define MY_FILEPOS_ERROR -1
573
#define DRIZZLE_SERVER
575
/* Length of decimal number represented by INT32. */
576
#define MY_INT32_NUM_DECIMAL_DIGITS 11
578
/* Length of decimal number represented by INT64. */
579
#define MY_INT64_NUM_DECIMAL_DIGITS 21
582
Io buffer size; Must be a power of 2 and
583
a multiple of 512. May be
584
smaller what the disk page size. This influences the speed of the
585
isam btree library. eg to big to slow.
588
/* Max file name len */
590
/* Max length of extension (part of FN_LEN) */
592
/* Max length of full path-name */
593
#define FN_REFLEN 512
594
/* File extension character */
595
#define FN_EXTCHAR '.'
596
/* ~ is used as abbrev for home dir */
597
#define FN_HOMELIB '~'
598
/* ./ is used as abbrev for current dir */
599
#define FN_CURLIB '.'
600
/* Parent directory; Must be a string */
601
#define FN_PARENTDIR ".."
603
/* Quote argument (before cpp) */
605
# define QUOTE_ARG(x) #x
607
/* Quote argument, (after cpp) */
608
#ifndef STRINGIFY_ARG
609
# define STRINGIFY_ARG(x) QUOTE_ARG(x)
613
* The macros below are borrowed from include/linux/compiler.h in the
614
* Linux kernel. Use them to indicate the likelyhood of the truthfulness
615
* of a condition. This serves two purposes - newer versions of gcc will be
616
* able to optimize for branch predication, which could yield siginficant
617
* performance gains in frequently executed sections of the code, and the
618
* other reason to use them is for documentation
620
#if !defined(__GNUC__)
621
#define __builtin_expect(x, expected_value) (x)
624
#define likely(x) __builtin_expect((x),1)
625
#define unlikely(x) __builtin_expect((x),0)
629
Only Linux is known to need an explicit sync of the directory to make sure a
630
file creation/deletion/renaming in(from,to) this directory durable.
632
#ifdef TARGET_OS_LINUX
633
#define NEED_EXPLICIT_SYNC_DIR 1
636
/* We need to turn off _DTRACE_VERSION if we're not going to use dtrace */
637
#if !defined(HAVE_DTRACE)
638
# undef _DTRACE_VERSION
639
# define _DTRACE_VERSION 0
642
typedef uint64_t table_map; /* Used for table bits in join */
643
typedef uint32_t nesting_map; /* Used for flags of nesting constructs */
645
} /* namespace drizzled */
647
#endif /* DRIZZLED_DEFINITIONS_H */