myisam.h 15.3 KB
Newer Older
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1
/* Copyright (C) 2000 MySQL AB
2

monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
3 4 5 6
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
7

monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
8
   This program is distributed in the hope that it will be useful,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
9
   but WITHOUT ANY WARRANTY; without even the implied warranty of
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
10 11
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
12

monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
13 14 15
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

/* This file should be included when using myisam_funktions */

#ifndef _myisam_h
#define _myisam_h
#ifdef	__cplusplus
extern "C" {
#endif

#ifndef _my_base_h
#include <my_base.h>
#endif
#ifndef _m_ctype_h
#include <m_ctype.h>
#endif
31
#include "my_handler.h"
bk@work.mysql.com's avatar
bk@work.mysql.com committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45

	/* defines used by myisam-funktions */

/* The following defines can be increased if necessary */
#define MI_MAX_KEY	32		/* Max allowed keys */
#define MI_MAX_KEY_SEG	16		/* Max segments for key */
#define MI_MAX_KEY_LENGTH 500

#define MI_MAX_KEY_BUFF  (MI_MAX_KEY_LENGTH+MI_MAX_KEY_SEG*6+8+8)
#define MI_MAX_POSSIBLE_KEY_BUFF (1024+6+6)	/* For myisam_chk */
#define MI_MAX_POSSIBLE_KEY	64		/* For myisam_chk */
#define MI_MAX_MSG_BUF      1024 /* used in CHECK TABLE, REPAIR TABLE */
#define MI_NAME_IEXT	".MYI"
#define MI_NAME_DEXT	".MYD"
46
/* Max extra space to use when sorting keys */
47
#define MI_MAX_TEMP_LENGTH	256*1024L*1024L
bk@work.mysql.com's avatar
bk@work.mysql.com committed
48

49 50 51 52 53
/* Possible values for myisam_block_size (must be power of 2) */
#define MI_KEY_BLOCK_LENGTH	1024	/* default key block length */
#define MI_MIN_KEY_BLOCK_LENGTH	1024	/* Min key block length */
#define MI_MAX_KEY_BLOCK_LENGTH	16384

bk@work.mysql.com's avatar
bk@work.mysql.com committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
#define mi_portable_sizeof_char_ptr 8

	/* Param to/from mi_info */

typedef struct st_mi_isaminfo		/* Struct from h_info */
{
  ha_rows records;			/* Records in database */
  ha_rows deleted;			/* Deleted records in database */
  my_off_t recpos;			/* Pos for last used record */
  my_off_t newrecpos;			/* Pos if we write new record */
  my_off_t dupp_key_pos;		/* Position to record with dupp key */
  my_off_t data_file_length,		/* Length of data file */
           max_data_file_length,
           index_file_length,
           max_index_file_length,
           delete_length;
  ulong reclength;			/* Recordlength */
  ulong mean_reclength;			/* Mean recordlength (if packed) */
  ulonglong auto_increment;
  ulonglong key_map;			/* Which keys are used */
74
  char  *data_file_name, *index_file_name;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
75
  uint  keys;				/* Number of keys in use */
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
76
  uint	options;			/* HA_OPTION_... used */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  int	errkey,				/* With key was dupplicated on err */
	sortkey;			/* clustered by this key */
  File	filenr;				/* (uniq) filenr for datafile */
  time_t create_time;			/* When table was created */
  time_t check_time;
  time_t update_time;
  uint  reflength;
  ulong record_offset;
  ulong *rec_per_key;			/* for sql optimizing */
  uint raid_type,raid_chunks;
  ulong raid_chunksize;
} MI_ISAMINFO;


typedef struct st_mi_create_info
{
93
  char *index_file_name, *data_file_name;	/* If using symlinks */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
94 95 96 97 98 99 100 101
  ha_rows max_rows;
  ha_rows reloc_rows;
  ulonglong auto_increment;
  ulonglong data_file_length;
  uint raid_type,raid_chunks;
  ulong raid_chunksize;
  uint old_options;
  uint8 language;
102
  my_bool with_auto_increment;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
103 104 105 106 107 108 109 110 111 112 113 114
} MI_CREATE_INFO;

struct st_myisam_info;			/* For referense */
typedef struct st_myisam_info MI_INFO;

struct st_mi_s_param;

typedef struct st_mi_keydef		/* Key definition with open & info */
{
  uint16 keysegs;			/* Number of key-segment */
  uint16 flag;				/* NOSAME, PACK_USED */

115
  uint8  key_alg;			/* BTREE, RTREE */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
116 117 118 119 120 121 122 123
  uint16 block_length;			/* Length of keyblock (auto) */
  uint16 underflow_block_length;	/* When to execute underflow */
  uint16 keylength;			/* Tot length of keyparts (auto) */
  uint16 minlength;			/* min length of (packed) key (auto) */
  uint16 maxlength;			/* max length of (packed) key (auto) */
  uint16 block_size;			/* block_size (auto) */
  uint32 version;			/* For concurrent read/write */

124
  HA_KEYSEG *seg,*end;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
125 126 127 128 129 130 131 132 133 134 135
  int (*bin_search)(struct st_myisam_info *info,struct st_mi_keydef *keyinfo,
		    uchar *page,uchar *key,
		    uint key_len,uint comp_flag,uchar * *ret_pos,
		    uchar *buff, my_bool *was_last_key);
  uint (*get_key)(struct st_mi_keydef *keyinfo,uint nod_flag,uchar * *page,
		  uchar *key);
  int (*pack_key)(struct st_mi_keydef *keyinfo,uint nod_flag,uchar *next_key,
		  uchar *org_key, uchar *prev_key, uchar *key,
		  struct st_mi_s_param *s_temp);
  void (*store_key)(struct st_mi_keydef *keyinfo, uchar *key_pos,
		    struct st_mi_s_param *s_temp);
136 137
  int (*ck_insert)(struct st_myisam_info *inf, uint k_nr, uchar *k, uint klen);
  int (*ck_delete)(struct st_myisam_info *inf, uint k_nr, uchar *k, uint klen);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
138 139 140 141 142 143 144 145 146 147
} MI_KEYDEF;


#define MI_UNIQUE_HASH_LENGTH	4

typedef struct st_unique_def		/* Segment definition of unique */
{
  uint16 keysegs;			/* Number of key-segment */
  uchar key;				/* Mapped to which key */
  uint8 null_are_equal;
148
  HA_KEYSEG *seg,*end;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
149 150 151 152 153 154 155 156 157 158 159 160
} MI_UNIQUEDEF;

typedef struct st_mi_decode_tree	/* Decode huff-table */
{
  uint16 *table;
  uint	 quick_table_bits;
  byte	 *intervalls;
} MI_DECODE_TREE;


struct st_mi_bit_buff;

161 162 163 164 165
/*
  Note that null markers should always be first in a row !
  When creating a column, one should only specify:
  type, length, null_bit and null_pos
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

typedef struct st_columndef		/* column information */
{
  int16  type;				/* en_fieldtype */
  uint16 length;			/* length of field */
  uint32 offset;			/* Offset to position in row */
  uint8  null_bit;			/* If column may be 0 */
  uint16 null_pos;			/* position for null marker */

#ifndef NOT_PACKED_DATABASES
  void (*unpack)(struct st_columndef *rec,struct st_mi_bit_buff *buff,
		 uchar *start,uchar *end);
  enum en_fieldtype base_type;
  uint space_length_bits,pack_type;
  MI_DECODE_TREE *huff_tree;
#endif
} MI_COLUMNDEF;

monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
184
/* invalidator function reference for Query Cache */
185
typedef void (* invalidator_by_filename)(const char * filename);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
186 187 188

extern my_string myisam_log_filename;		/* Name of logfile */
extern uint myisam_block_size;
189
extern my_bool myisam_flush,myisam_delay_key_write,myisam_single_user;
190 191
extern my_bool myisam_concurrent_insert;
extern my_off_t myisam_max_temp_length,myisam_max_extra_temp_length;
192
extern ulong myisam_bulk_insert_tree_size;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

	/* Prototypes for myisam-functions */

extern int mi_close(struct st_myisam_info *file);
extern int mi_delete(struct st_myisam_info *file,const byte *buff);
extern struct st_myisam_info *mi_open(const char *name,int mode,
				      uint wait_if_locked);
extern int mi_panic(enum ha_panic_function function);
extern int mi_rfirst(struct st_myisam_info *file,byte *buf,int inx);
extern int mi_rkey(struct st_myisam_info *file,byte *buf,int inx,
		   const byte *key,
		   uint key_len, enum ha_rkey_function search_flag);
extern int mi_rlast(struct st_myisam_info *file,byte *buf,int inx);
extern int mi_rnext(struct st_myisam_info *file,byte *buf,int inx);
extern int mi_rnext_same(struct st_myisam_info *info, byte *buf);
extern int mi_rprev(struct st_myisam_info *file,byte *buf,int inx);
extern int mi_rrnd(struct st_myisam_info *file,byte *buf, my_off_t pos);
extern int mi_scan_init(struct st_myisam_info *file);
extern int mi_scan(struct st_myisam_info *file,byte *buf);
extern int mi_rsame(struct st_myisam_info *file,byte *record,int inx);
extern int mi_rsame_with_pos(struct st_myisam_info *file,byte *record,
			     int inx, my_off_t pos);
extern int mi_update(struct st_myisam_info *file,const byte *old,
		     byte *new_record);
extern int mi_write(struct st_myisam_info *file,byte *buff);
extern my_off_t mi_position(struct st_myisam_info *file);
extern int mi_status(struct st_myisam_info *info, MI_ISAMINFO *x, uint flag);
extern int mi_lock_database(struct st_myisam_info *file,int lock_type);
extern int mi_create(const char *name,uint keys,MI_KEYDEF *keydef,
222
		     uint columns, MI_COLUMNDEF *columndef,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
223 224 225 226 227
		     uint uniques, MI_UNIQUEDEF *uniquedef,
		     MI_CREATE_INFO *create_info, uint flags);
extern int mi_delete_table(const char *name);
extern int mi_rename(const char *from, const char *to);
extern int mi_extra(struct st_myisam_info *file,
228 229
		    enum ha_extra_function function,
		    void *extra_arg);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
230 231 232 233 234 235 236 237 238 239 240 241 242
extern ha_rows mi_records_in_range(struct st_myisam_info *info,int inx,
				   const byte *start_key,uint start_key_len,
				   enum ha_rkey_function start_search_flag,
				   const byte *end_key,uint end_key_len,
				   enum ha_rkey_function end_search_flag);
extern int mi_log(int activate_log);
extern int mi_is_changed(struct st_myisam_info *info);
extern int mi_delete_all_rows(struct st_myisam_info *info);
extern ulong _mi_calc_blob_length(uint length , const byte *pos);
extern uint mi_get_pointer_length(ulonglong file_length, uint def);

/* this is used to pass to mysql_myisamchk_table -- by Sasha Pachev */

243 244
#define   MYISAMCHK_REPAIR 1  /* equivalent to myisamchk -r */
#define   MYISAMCHK_VERIFY 2  /* Verify, run repair if failure */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
245

246 247
/*
  Definitions needed for myisamchk.c
bk@work.mysql.com's avatar
bk@work.mysql.com committed
248

249
  Entries marked as "QQ to be removed" are NOT used to
250 251 252
  pass check/repair options to mi_check.c. They are used
  internally by myisamchk.c or/and ha_myisam.cc and should NOT
  be stored together with other flags. They should be removed
253
  from the following list to make addition of new flags possible.
254
*/
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
255

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
#define T_AUTO_INC              1
#define T_AUTO_REPAIR           2              /* QQ to be removed */
#define T_BACKUP_DATA           4
#define T_CALC_CHECKSUM         8
#define T_CHECK                 16             /* QQ to be removed */
#define T_CHECK_ONLY_CHANGED    32             /* QQ to be removed */
#define T_CREATE_MISSING_KEYS   64
#define T_DESCRIPT              128
#define T_DONT_CHECK_CHECKSUM   256
#define T_EXTEND                512
#define T_FAST                  (1L << 10)     /* QQ to be removed */
#define T_FORCE_CREATE          (1L << 11)     /* QQ to be removed */
#define T_FORCE_UNIQUENESS      (1L << 12)
#define T_INFO                  (1L << 13)
#define T_MEDIUM                (1L << 14)
#define T_QUICK                 (1L << 15)     /* QQ to be removed */
#define T_READONLY              (1L << 16)     /* QQ to be removed */
#define T_REP                   (1L << 17)
#define T_REP_BY_SORT           (1L << 18)     /* QQ to be removed */
#define T_REP_PARALLEL          (1L << 19)     /* QQ to be removed */
#define T_RETRY_WITHOUT_QUICK   (1L << 20)
#define T_SAFE_REPAIR           (1L << 21)
#define T_SILENT                (1L << 22)
#define T_SORT_INDEX            (1L << 23)     /* QQ to be removed */
#define T_SORT_RECORDS          (1L << 24)     /* QQ to be removed */
#define T_STATISTICS            (1L << 25)
#define T_UNPACK                (1L << 26)
#define T_UPDATE_STATE          (1L << 27)
#define T_VERBOSE               (1L << 28)
#define T_VERY_SILENT           (1L << 29)
#define T_WAIT_FOREVER          (1L << 30)
287
#define T_WRITE_LOOP            ((ulong) 1L << 31)
288 289

#define T_REP_ANY               (T_REP | T_REP_BY_SORT | T_REP_PARALLEL)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
290

291 292 293 294
/*
  Flags used by myisamchk.c or/and ha_myisam.cc that are NOT passed
  to mi_check.c follows:
*/
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
295 296 297

#define TT_USEFRM               1

bk@work.mysql.com's avatar
bk@work.mysql.com committed
298 299
#define O_NEW_INDEX	1		/* Bits set in out_flag */
#define O_NEW_DATA	2
300
#define O_DATA_LOST	4
bk@work.mysql.com's avatar
bk@work.mysql.com committed
301 302 303

/* these struct is used by my_check to tell it what to do */

304 305
typedef struct st_sort_key_blocks		/* Used when sorting */
{
bk@work.mysql.com's avatar
bk@work.mysql.com committed
306 307 308 309 310 311 312 313 314
  uchar *buff,*end_pos;
  uchar lastkey[MI_MAX_POSSIBLE_KEY_BUFF];
  uint last_length;
  int inited;
} SORT_KEY_BLOCKS;


typedef struct st_mi_check_param
{
315 316 317 318 319 320 321 322
  ulonglong auto_increment_value;
  ulonglong max_data_file_length;
  ulonglong keys_in_use;
  my_off_t search_after_block;
  my_off_t new_file_pos,key_file_blocks;
  my_off_t keydata,totaldata,key_blocks,start_check_pos;
  ha_rows total_records,total_deleted;
  ha_checksum record_checksum,glob_crc;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
323 324
  ulong	use_buffers,read_buffer_length,write_buffer_length,
	sort_buffer_length,sort_key_blocks;
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
325
  uint out_flag,warning_printed,error_printed,verbose;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
326
  uint opt_sort_key,total_files,max_level;
327
  uint testflag;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
328 329
  uint8 language;
  my_bool using_global_keycache, opt_lock_memory, opt_follow_links;
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
330
  my_bool retry_repair, force_sort, calc_checksum;
331 332
  char temp_filename[FN_REFLEN],*isam_file_name;
  MY_TMPDIR *tmpdir;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
333 334 335 336 337 338
  int tmpfile_createflag;
  myf myf_rw;
  IO_CACHE read_cache;
  ulonglong unique_count[MI_MAX_KEY_SEG+1];
  ha_checksum key_crc[MI_MAX_POSSIBLE_KEY];
  ulong rec_per_key_part[MI_MAX_KEY_SEG*MI_MAX_POSSIBLE_KEY];
339 340 341
  void *thd;
  char *db_name,*table_name;
  char *op_name;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
342 343
} MI_CHECK;

344 345 346 347 348 349
typedef struct st_sort_ft_buf
{
  uchar *buf, *end;
  int   count;
  uchar lastkey[MI_MAX_KEY_BUFF];
} SORT_FT_BUF;
350

serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
351
typedef struct st_sort_info
352
{
353
  my_off_t filelength,dupp,buff_length;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
354
  ha_rows max_records;
355
  uint current_key, total_keys;
356
  myf myf_rw;
357 358 359 360 361
  enum data_file_type new_data_file_type;
  MI_INFO *info;
  MI_CHECK *param;
  char *buff;
  SORT_KEY_BLOCKS *key_block,*key_block_end;
362 363
  SORT_FT_BUF *ft_buf;
  /* sync things */
364
  uint got_error, threads_running;
365
#ifdef THREAD
366 367
  pthread_mutex_t mutex;
  pthread_cond_t  cond;
368
#endif
369 370
} SORT_INFO;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
371 372
/* functions in mi_check */
void myisamchk_init(MI_CHECK *param);
373
int chk_status(MI_CHECK *param, MI_INFO *info);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
374 375 376 377 378 379 380 381 382
int chk_del(MI_CHECK *param, register MI_INFO *info, uint test_flag);
int chk_size(MI_CHECK *param, MI_INFO *info);
int chk_key(MI_CHECK *param, MI_INFO *info);
int chk_data_link(MI_CHECK *param, MI_INFO *info,int extend);
int mi_repair(MI_CHECK *param, register MI_INFO *info,
	      my_string name, int rep_quick);
int mi_sort_index(MI_CHECK *param, register MI_INFO *info, my_string name);
int mi_repair_by_sort(MI_CHECK *param, register MI_INFO *info,
		      const char * name, int rep_quick);
383 384
int mi_repair_parallel(MI_CHECK *param, register MI_INFO *info,
		      const char * name, int rep_quick);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
385
int change_to_newfile(const char * filename, const char * old_ext,
386 387
		      const char * new_ext, uint raid_chunks,
		      myf myflags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
388 389 390 391
int lock_file(MI_CHECK *param, File file, my_off_t start, int lock_type,
	      const char *filetype, const char *filename);
void lock_memory(MI_CHECK *param);
int flush_blocks(MI_CHECK *param, File file);
392 393
void update_auto_increment_key(MI_CHECK *param, MI_INFO *info,
			       my_bool repair);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
394
int update_state_info(MI_CHECK *param, MI_INFO *info,uint update);
395 396
void update_key_parts(MI_KEYDEF *keyinfo, ulong *rec_per_key_part,
			     ulonglong *unique, ulonglong records);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
397 398 399 400
int filecopy(MI_CHECK *param, File to,File from,my_off_t start,
	     my_off_t length, const char *type);
int movepoint(MI_INFO *info,byte *record,my_off_t oldpos,
	      my_off_t newpos, uint prot_key);
401
int write_data_suffix(SORT_INFO *sort_info, my_bool fix_datafile);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
402 403
int test_if_almost_full(MI_INFO *info);
int recreate_table(MI_CHECK *param, MI_INFO **org_info, char *filename);
404
void mi_disable_non_unique_index(MI_INFO *info, ha_rows rows);
405 406
my_bool mi_test_if_sort_rep(MI_INFO *info, ha_rows rows, ulonglong key_map,
			    my_bool force);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
407

408 409 410
int mi_init_bulk_insert(MI_INFO *info, ulong cache_size, ha_rows rows);
void mi_flush_bulk_insert(MI_INFO *info, uint inx);
void mi_end_bulk_insert(MI_INFO *info);
igor@rurik.mysql.com's avatar
igor@rurik.mysql.com committed
411 412 413
int mi_assign_to_keycache(MI_INFO *info, ulonglong key_map, 
                          KEY_CACHE_VAR *key_cache, 
                          pthread_mutex_t *assign_lock);
igor@rurik.mysql.com's avatar
igor@rurik.mysql.com committed
414
int mi_preload(MI_INFO *info, ulonglong key_map, my_bool ignore_leaves);
415

bk@work.mysql.com's avatar
bk@work.mysql.com committed
416 417 418 419
#ifdef	__cplusplus
}
#endif
#endif