my_sys.h 40.7 KB
Newer Older
1
/* Copyright (C) 2000-2003 MySQL AB
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
2 3 4

   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
5
   the Free Software Foundation; version 2 of the License.
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
6 7

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

   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
15 16 17

#ifndef _my_sys_h
#define _my_sys_h
18
C_MODE_START
bk@work.mysql.com's avatar
bk@work.mysql.com committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

#ifdef HAVE_AIOWAIT
#include <sys/asynch.h>			/* Used by record-cache */
typedef struct my_aio_result {
  aio_result_t result;
  int	       pending;
} my_aio_result;
#endif

#ifndef THREAD
extern int NEAR my_errno;		/* Last error in mysys */
#else
#include <my_pthread.h>
#endif

#include <m_ctype.h>                    /* for CHARSET_INFO */
35
#include <stdarg.h>
36
#include <typelib.h>
bk@work.mysql.com's avatar
bk@work.mysql.com committed
37 38 39 40 41

#define MYSYS_PROGRAM_USES_CURSES()  { error_handler_hook = my_message_curses;	mysys_uses_curses=1; }
#define MYSYS_PROGRAM_DONT_USE_CURSES()  { error_handler_hook = my_message_no_curses; mysys_uses_curses=0;}
#define MY_INIT(name);		{ my_progname= name; my_init(); }

Marc Alff's avatar
Marc Alff committed
42 43 44 45 46 47 48 49 50 51 52
/**
  Max length of an error message generated by mysys utilities.
  Some mysys functions produce error messages. These mostly go
  to stderr.
  This constant defines the size of the buffer used to format
  the message. It should be kept in sync with MYSQL_ERRMSG_SIZE,
  since sometimes mysys errors are stored in the server diagnostics
  area, and we would like to avoid unexpected truncation.
*/
#define MYSYS_ERRMSG_SIZE   (512)

53
#define MY_FILE_ERROR	((size_t) -1)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
54 55 56 57 58 59 60 61

	/* General bitmaps for my_func's */
#define MY_FFNF		1	/* Fatal if file not found */
#define MY_FNABP	2	/* Fatal if not all bytes read/writen */
#define MY_NABP		4	/* Error if not all bytes read/writen */
#define MY_FAE		8	/* Fatal if any error */
#define MY_WME		16	/* Write message on error */
#define MY_WAIT_IF_FULL 32	/* Wait and try again if disk full error */
62
#define MY_IGNORE_BADFD 32      /* my_sync: ignore 'bad descriptor' errors */
63
#define MY_SYNC_DIR     8192    /* my_create/delete/rename: sync directory */
64 65 66
#define MY_RAID         64      /* Support for RAID */
#define MY_FULL_IO     512      /* For my_read - loop intil I/O is complete */
#define MY_DONT_CHECK_FILESIZE 128 /* Option to init_io_cache() */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
67 68
#define MY_LINK_WARNING 32	/* my_redel() gives warning if links */
#define MY_COPYTIME	64	/* my_redel() copys time */
69 70
#define MY_DELETE_OLD	256	/* my_create_with_symlink() */
#define MY_RESOLVE_LINK 128	/* my_realpath(); Only resolve links */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
71
#define MY_HOLD_ORIGINAL_MODES 128  /* my_copy() holds to file modes */
72
#define MY_REDEL_MAKE_BACKUP 256
bk@work.mysql.com's avatar
bk@work.mysql.com committed
73 74 75 76 77 78
#define MY_SEEK_NOT_DONE 32	/* my_lock may have to do a seek */
#define MY_DONT_WAIT	64	/* my_lock() don't wait if can't lock */
#define MY_ZEROFILL	32	/* my_malloc(), fill array with zero */
#define MY_ALLOW_ZERO_PTR 64	/* my_realloc() ; zero ptr -> malloc */
#define MY_FREE_ON_ERROR 128	/* my_realloc() ; Free old ptr on error */
#define MY_HOLD_ON_ERROR 256	/* my_realloc() ; Return old ptr on error */
79
#define MY_DONT_OVERWRITE_FILE 1024	/* my_copy: Don't overwrite file */
80
#define MY_THREADSAFE 2048      /* my_seek(): lock fd mutex */
81
#define MY_SYNC       4096      /* my_copy(): sync dst file */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
82 83 84

#define MY_CHECK_ERROR	1	/* Params to my_end; Check open-close */
#define MY_GIVE_INFO	2	/* Give time info about process*/
85
#define MY_DONT_FREE_DBUG 4     /* Do not call DBUG_END() in my_end() */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
86

87 88 89 90
#define MY_REMOVE_NONE    0     /* Params for modify_defaults_file */
#define MY_REMOVE_OPTION  1
#define MY_REMOVE_SECTION 2

bk@work.mysql.com's avatar
bk@work.mysql.com committed
91 92 93 94 95 96 97 98 99 100 101 102
#define ME_HIGHBYTE	8	/* Shift for colours */
#define ME_NOCUR	1	/* Don't use curses message */
#define ME_OLDWIN	2	/* Use old window */
#define ME_BELL		4	/* Ring bell then printing message */
#define ME_HOLDTANG	8	/* Don't delete last keys */
#define ME_WAITTOT	16	/* Wait for errtime secs of for a action */
#define ME_WAITTANG	32	/* Wait for a user action  */
#define ME_NOREFRESH	64	/* Dont refresh screen */
#define ME_NOINPUT	128	/* Dont use the input libary */
#define ME_COLOUR1	((1 << ME_HIGHBYTE))	/* Possibly error-colours */
#define ME_COLOUR2	((2 << ME_HIGHBYTE))
#define ME_COLOUR3	((3 << ME_HIGHBYTE))
103
#define ME_FATALERROR   1024    /* Fatal statement error */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
104

105 106 107 108 109 110 111 112 113
	/* Bits in last argument to fn_format */
#define MY_REPLACE_DIR		1	/* replace dir in name with 'dir' */
#define MY_REPLACE_EXT		2	/* replace extension with 'ext' */
#define MY_UNPACK_FILENAME	4	/* Unpack name (~ -> home) */
#define MY_PACK_FILENAME	8	/* Pack name (home -> ~) */
#define MY_RESOLVE_SYMLINKS	16	/* Resolve all symbolic links */
#define MY_RETURN_REAL_PATH	32	/* return full path for file */
#define MY_SAFE_PATH		64	/* Return NULL if too long path */
#define MY_RELATIVE_PATH	128	/* name is relative to 'dir' */
114 115
#define MY_APPEND_EXT           256     /* add 'ext' as additional extension*/

116

bk@work.mysql.com's avatar
bk@work.mysql.com committed
117 118 119 120 121 122 123 124 125
	/* My seek flags */
#define MY_SEEK_SET	0
#define MY_SEEK_CUR	1
#define MY_SEEK_END	2

	/* Some constants */
#define MY_WAIT_FOR_USER_TO_FIX_PANIC	60	/* in seconds */
#define MY_WAIT_GIVE_USER_A_MESSAGE	10	/* Every 10 times of prev */
#define MIN_COMPRESS_LENGTH		50	/* Don't compress small bl. */
126
#define DFLT_INIT_HITS  3
bk@work.mysql.com's avatar
bk@work.mysql.com committed
127

128 129
	/* root_alloc flags */
#define MY_KEEP_PREALLOC	1
130
#define MY_MARK_BLOCKS_FREE     2  /* move used to free list and reuse them */
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
131

132 133 134
	/* Internal error numbers (for assembler functions) */
#define MY_ERRNO_EDOM		33
#define MY_ERRNO_ERANGE		34
bk@work.mysql.com's avatar
bk@work.mysql.com committed
135

136 137 138 139 140 141 142
	/* Bits for get_date timeflag */
#define GETDATE_DATE_TIME	1
#define GETDATE_SHORT_DATE	2
#define GETDATE_HHMMSSTIME	4
#define GETDATE_GMT		8
#define GETDATE_FIXEDLENGTH	16

143
	/* defines when allocating data */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
144
#ifdef SAFEMALLOC
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
145 146 147
#define my_malloc(SZ,FLAG) _mymalloc((SZ), __FILE__, __LINE__, FLAG )
#define my_malloc_ci(SZ,FLAG) _mymalloc((SZ), sFile, uLine, FLAG )
#define my_realloc(PTR,SZ,FLAG) _myrealloc((PTR), (SZ), __FILE__, __LINE__, FLAG )
bk@work.mysql.com's avatar
bk@work.mysql.com committed
148
#define my_checkmalloc() _sanity( __FILE__, __LINE__ )
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
149 150 151
#define my_free(PTR,FLAG) _myfree((PTR), __FILE__, __LINE__,FLAG)
#define my_memdup(A,B,C) _my_memdup((A),(B), __FILE__,__LINE__,C)
#define my_strdup(A,C) _my_strdup((A), __FILE__,__LINE__,C)
152
#define my_strndup(A,B,C) _my_strndup((A),(B),__FILE__,__LINE__,C)
153
#define TRASH(A,B) bfill(A, B, 0x8F)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
154 155 156
#define QUICK_SAFEMALLOC sf_malloc_quick=1
#define NORMAL_SAFEMALLOC sf_malloc_quick=0
extern uint sf_malloc_prehunc,sf_malloc_endhunc,sf_malloc_quick;
157
extern ulonglong sf_malloc_mem_limit;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
158

159 160 161
#define CALLER_INFO_PROTO   , const char *sFile, uint uLine
#define CALLER_INFO         , __FILE__, __LINE__
#define ORIG_CALLER_INFO    , sFile, uLine
bk@work.mysql.com's avatar
bk@work.mysql.com committed
162
#else
163
#define my_checkmalloc()
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
164
#undef TERMINATE
165
#define TERMINATE(A,B) {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
166 167
#define QUICK_SAFEMALLOC
#define NORMAL_SAFEMALLOC
168
extern void *my_malloc(size_t Size,myf MyFlags);
169
#define my_malloc_ci(SZ,FLAG) my_malloc( SZ, FLAG )
170 171 172
extern void *my_realloc(void *oldpoint, size_t Size, myf MyFlags);
extern void my_no_flags_free(void *ptr);
extern void *my_memdup(const void *from,size_t length,myf MyFlags);
173
extern char *my_strdup(const char *from,myf MyFlags);
174
extern char *my_strndup(const char *from, size_t length,
175
				   myf MyFlags);
176 177
/* we do use FG (as a no-op) in below so that a typo on FG is caught */
#define my_free(PTR,FG) ((void)FG,my_no_flags_free(PTR))
178 179 180
#define CALLER_INFO_PROTO   /* nothing */
#define CALLER_INFO         /* nothing */
#define ORIG_CALLER_INFO    /* nothing */
181
#define TRASH(A,B) /* nothing */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
182
#endif
183

184 185 186 187 188 189 190 191 192 193
#if defined(ENABLED_DEBUG_SYNC)
extern void (*debug_sync_C_callback_ptr)(const char *, size_t);
#define DEBUG_SYNC_C(_sync_point_name_) do {                            \
    if (debug_sync_C_callback_ptr != NULL)                              \
      (*debug_sync_C_callback_ptr)(STRING_WITH_LEN(_sync_point_name_)); } \
  while(0)
#else
#define DEBUG_SYNC_C(_sync_point_name_)
#endif /* defined(ENABLED_DEBUG_SYNC) */

194 195
#ifdef HAVE_LARGE_PAGES
extern uint my_get_large_page_size(void);
196 197
extern uchar * my_large_malloc(size_t size, myf my_flags);
extern void my_large_free(uchar * ptr, myf my_flags);
198 199 200 201 202 203
#else
#define my_get_large_page_size() (0)
#define my_large_malloc(A,B) my_malloc_lock((A),(B))
#define my_large_free(A,B) my_free_lock((A),(B))
#endif /* HAVE_LARGE_PAGES */

bk@work.mysql.com's avatar
bk@work.mysql.com committed
204
#ifdef HAVE_ALLOCA
205
#if defined(_AIX) && !defined(__GNUC__) && !defined(_AIX43)
206
#pragma alloca
207
#endif /* _AIX */
208 209
#if defined(__MWERKS__)
#undef alloca
210
#define alloca _alloca
211
#endif /* __MWERKS__ */
212
#if defined(__GNUC__) && !defined(HAVE_ALLOCA_H) && ! defined(alloca)
213 214
#define alloca __builtin_alloca
#endif /* GNUC */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
215 216 217 218 219 220
#define my_alloca(SZ) alloca((size_t) (SZ))
#define my_afree(PTR) {}
#else
#define my_alloca(SZ) my_malloc(SZ,MYF(0))
#define my_afree(PTR) my_free(PTR,MYF(MY_WME))
#endif /* HAVE_ALLOCA */
221

222
#ifndef errno				/* did we already get it? */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
223 224 225 226 227
#ifdef HAVE_ERRNO_AS_DEFINE
#include <errno.h>			/* errno is a define */
#else
extern int errno;			/* declare errno */
#endif
228
#endif					/* #ifndef errno */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
229
extern char *home_dir;			/* Home directory for user */
230
extern const char *my_progname;		/* program-name (printed in errors) */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
231
extern char NEAR curr_dir[];		/* Current directory for user */
Marc Alff's avatar
Marc Alff committed
232 233
extern void (*error_handler_hook)(uint my_err, const char *str,myf MyFlags);
extern void (*fatal_error_handler_hook)(uint my_err, const char *str,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
234
				       myf MyFlags);
235
extern uint my_file_limit;
236
extern ulong my_thread_stack_size;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
237

238 239 240 241 242
#ifdef HAVE_LARGE_PAGES
extern my_bool my_use_large_pages;
extern uint    my_large_page_size;
#endif

bk@work.mysql.com's avatar
bk@work.mysql.com committed
243
/* charsets */
244
#define MY_ALL_CHARSETS_SIZE 2048
245
extern MYSQL_PLUGIN_IMPORT CHARSET_INFO *default_charset_info;
246
extern MYSQL_PLUGIN_IMPORT CHARSET_INFO *all_charsets[MY_ALL_CHARSETS_SIZE];
247 248
extern CHARSET_INFO compiled_charsets[];

249
/* statistics */
250
extern ulong	my_file_opened,my_stream_opened, my_tmp_file_created;
251
extern ulong    my_file_total_opened;
252
extern uint	mysys_usage_id;
253
extern my_bool	my_init_done;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
254 255 256 257 258 259 260

					/* Point to current my_message() */
extern void (*my_sigtstp_cleanup)(void),
					/* Executed before jump to shell */
	    (*my_sigtstp_restart)(void),
	    (*my_abort_hook)(int);
					/* Executed when comming from shell */
261 262
extern MYSQL_PLUGIN_IMPORT int NEAR my_umask;		/* Default creation mask  */
extern int NEAR my_umask_dir,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
263 264 265 266
	   NEAR my_recived_signals,	/* Signals we have got */
	   NEAR my_safe_to_handle_signal, /* Set when allowed to SIGTSTP */
	   NEAR my_dont_interrupt;	/* call remember_intr when set */
extern my_bool NEAR mysys_uses_curses, my_use_symdir;
267
extern size_t sf_malloc_cur_memory, sf_malloc_max_memory;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
268 269 270

extern ulong	my_default_record_cache_size;
extern my_bool NEAR my_disable_locking,NEAR my_disable_async_io,
271
               NEAR my_disable_flush_key_blocks, NEAR my_disable_symlinks;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
272 273
extern char	wild_many,wild_one,wild_prefix;
extern const char *charsets_dir;
274 275 276 277
/* from default.c */
extern char *my_defaults_extra_file;
extern const char *my_defaults_group_suffix;
extern const char *my_defaults_file;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
278

279 280
extern my_bool timed_mutexes;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
281 282 283 284
typedef struct wild_file_pack	/* Struct to hold info when selecting files */
{
  uint		wilds;		/* How many wildcards */
  uint		not_pos;	/* Start of not-theese-files */
285
  char *	*wild;		/* Pointer to wildcards */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
286 287
} WF_PACK;

288 289 290 291 292 293
enum loglevel {
   ERROR_LEVEL,
   WARNING_LEVEL,
   INFORMATION_LEVEL
};

294 295
enum cache_type
{
296
  TYPE_NOT_SET= 0, READ_CACHE, WRITE_CACHE,
297 298 299 300 301
  SEQ_READ_APPEND		/* sequential read or append */,
  READ_FIFO, READ_NET,WRITE_NET};

enum flush_type
{
302 303 304 305 306 307 308 309
  FLUSH_KEEP,           /* flush block and keep it in the cache */
  FLUSH_RELEASE,        /* flush block and remove it from the cache */
  FLUSH_IGNORE_CHANGED, /* remove block from the cache */
  /*
    As my_disable_flush_pagecache_blocks is always 0, the following option
    is strictly equivalent to FLUSH_KEEP
  */
  FLUSH_FORCE_WRITE
310
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
311 312 313 314 315 316 317

typedef struct st_record_cache	/* Used when cacheing records */
{
  File file;
  int	rc_seek,error,inited;
  uint	rc_length,read_length,reclength;
  my_off_t rc_record_pos,end_of_file;
318
  uchar *rc_buff,*rc_buff2,*rc_pos,*rc_end,*rc_request_pos;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
319 320 321 322 323 324 325
#ifdef HAVE_AIOWAIT
  int	use_async_io;
  my_aio_result aio_result;
#endif
  enum cache_type type;
} RECORD_CACHE;

326 327 328 329 330
enum file_type
{
  UNOPEN = 0, FILE_BY_OPEN, FILE_BY_CREATE, STREAM_BY_FOPEN, STREAM_BY_FDOPEN,
  FILE_BY_MKSTEMP, FILE_BY_DUP
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
331

332
struct st_my_file_info
bk@work.mysql.com's avatar
bk@work.mysql.com committed
333
{
334 335 336 337 338 339 340
  char  *name;
#ifdef _WIN32
  HANDLE fhandle;   /* win32 file handle */
  int    oflag;     /* open flags, e.g O_APPEND */
#endif
  enum   file_type	type;
#if defined(THREAD) && !defined(HAVE_PREAD) && !defined(_WIN32)
341 342
  pthread_mutex_t	mutex;
#endif
343 344 345
};

extern struct st_my_file_info *my_file_info;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
346

347 348
typedef struct st_dynamic_array
{
349
  uchar *buffer;
350 351 352 353 354
  uint elements,max_element;
  uint alloc_increment;
  uint size_of_element;
} DYNAMIC_ARRAY;

355 356
typedef struct st_my_tmpdir
{
357
  DYNAMIC_ARRAY full_list;
358 359 360 361 362 363
  char **list;
  uint cur, max;
#ifdef THREAD
  pthread_mutex_t mutex;
#endif
} MY_TMPDIR;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
364

365 366
typedef struct st_dynamic_string
{
bk@work.mysql.com's avatar
bk@work.mysql.com committed
367
  char *str;
368
  size_t length,max_length,alloc_increment;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
369 370
} DYNAMIC_STRING;

371 372
struct st_io_cache;
typedef int (*IO_CACHE_CALLBACK)(struct st_io_cache*);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
373

374 375 376
#ifdef THREAD
typedef struct st_io_cache_share
{
377 378 379 380 381 382 383
  pthread_mutex_t       mutex;           /* To sync on reads into buffer. */
  pthread_cond_t        cond;            /* To wait for signals. */
  pthread_cond_t        cond_writer;     /* For a synchronized writer. */
  /* Offset in file corresponding to the first byte of buffer. */
  my_off_t              pos_in_file;
  /* If a synchronized write cache is the source of the data. */
  struct st_io_cache    *source_cache;
384 385
  uchar                 *buffer;         /* The read buffer. */
  uchar                 *read_end;       /* Behind last valid byte of buffer. */
386 387 388
  int                   running_threads; /* threads not in lock. */
  int                   total_threads;   /* threads sharing the cache. */
  int                   error;           /* Last error. */
389
#ifdef NOT_YET_IMPLEMENTED
390 391 392 393 394
  /* whether the structure should be free'd */
  my_bool alloced;
#endif
} IO_CACHE_SHARE;
#endif
395

bk@work.mysql.com's avatar
bk@work.mysql.com committed
396 397
typedef struct st_io_cache		/* Used when cacheing files */
{
398
  /* Offset in file corresponding to the first byte of uchar* buffer. */
399 400 401 402 403
  my_off_t pos_in_file;
  /*
    The offset of end of file for READ_CACHE and WRITE_CACHE.
    For SEQ_READ_APPEND it the maximum of the actual end of file and
    the position represented by read_end.
404
  */
405 406
  my_off_t end_of_file;
  /* Points to current read position in the buffer */
407
  uchar	*read_pos;
408
  /* the non-inclusive boundary in the buffer for the currently valid read */
409 410
  uchar  *read_end;
  uchar  *buffer;				/* The read buffer */
411
  /* Used in ASYNC_IO */
412
  uchar  *request_pos;
413 414

  /* Only used in WRITE caches and in SEQ_READ_APPEND to buffer writes */
415
  uchar  *write_buffer;
416 417 418
  /*
    Only used in SEQ_READ_APPEND, and points to the current read position
    in the write buffer. Note that reads in SEQ_READ_APPEND caches can
419 420
    happen from both read buffer (uchar* buffer) and write buffer
    (uchar* write_buffer).
421
  */
422
  uchar *append_read_pos;
423
  /* Points to current write position in the write buffer */
424
  uchar *write_pos;
425
  /* The non-inclusive boundary of the valid write area */
426
  uchar *write_end;
427 428 429 430 431 432

  /*
    Current_pos and current_end are convenience variables used by
    my_b_tell() and other routines that need to know the current offset
    current_pos points to &write_pos, and current_end to &write_end in a
    WRITE_CACHE, and &read_pos and &read_end respectively otherwise
433
  */
434
  uchar  **current_pos, **current_end;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
435
#ifdef THREAD
436 437 438 439
  /*
    The lock is for append buffer used in SEQ_READ_APPEND cache
    need mutex copying from append buffer to read buffer.
  */
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
440
  pthread_mutex_t append_buffer_lock;
441 442 443 444 445 446 447
  /*
    The following is used when several threads are reading the
    same file in parallel. They are synchronized on disk
    accesses reading the cached part of the file asynchronously.
    It should be set to NULL to disable the feature.  Only
    READ_CACHE mode is supported.
  */
448
  IO_CACHE_SHARE *share;
449
#endif
450 451 452 453 454 455 456
  /*
    A caller will use my_b_read() macro to read from the cache
    if the data is already in cache, it will be simply copied with
    memcpy() and internal variables will be accordinging updated with
    no functions invoked. However, if the data is not fully in the cache,
    my_b_read() will call read_function to fetch the data. read_function
    must never be invoked directly.
457
  */
458
  int (*read_function)(struct st_io_cache *,uchar *,size_t);
459 460 461
  /*
    Same idea as in the case of read_function, except my_b_write() needs to
    be replaced with my_b_append() for a SEQ_READ_APPEND cache
462
  */
463
  int (*write_function)(struct st_io_cache *,const uchar *,size_t);
464 465 466 467
  /*
    Specifies the type of the cache. Depending on the type of the cache
    certain operations might not be available and yield unpredicatable
    results. Details to be documented later
468
  */
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
469
  enum cache_type type;
470 471 472 473 474 475
  /*
    Callbacks when the actual read I/O happens. These were added and
    are currently used for binary logging of LOAD DATA INFILE - when a
    block is read from the file, we create a block create/append event, and
    when IO_CACHE is closed, we create an end event. These functions could,
    of course be used for other things
476
  */
477 478
  IO_CACHE_CALLBACK pre_read;
  IO_CACHE_CALLBACK post_read;
479
  IO_CACHE_CALLBACK pre_close;
480 481 482 483 484
  /*
    Counts the number of times, when we were forced to use disk. We use it to
    increase the binlog_cache_disk_use status variable.
  */
  ulong disk_writes;
485
  void* arg;				/* for use by pre/post_read */
486 487
  char *file_name;			/* if used with 'open_cached_file' */
  char *dir,*prefix;
488
  File file; /* file descriptor */
489 490 491 492 493 494
  /*
    seek_not_done is set by my_b_seek() to inform the upcoming read/write
    operation that a seek needs to be preformed prior to the actual I/O
    error is 0 if the cache operation was successful, -1 if there was a
    "hard" error, and the actual number of I/O-ed bytes if the read/write was
    partial.
495
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
496
  int	seek_not_done,error;
497
  /* buffer_length is memory size allocated for buffer or write_buffer */
498
  size_t	buffer_length;
499
  /* read_length is the same as buffer_length except when we use async io */
500
  size_t  read_length;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
501
  myf	myflags;			/* Flags used to my_read/my_write */
502
  /*
503 504 505 506 507
    alloced_buffer is 1 if the buffer was allocated by init_io_cache() and
    0 if it was supplied by the user.
    Currently READ_NET is the only one that will use a buffer allocated
    somewhere else
  */
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
508
  my_bool alloced_buffer;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
509
#ifdef HAVE_AIOWAIT
510 511 512
  /*
    As inidicated by ifdef, this is for async I/O, which is not currently
    used (because it's not reliable on all systems)
513
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
  uint inited;
  my_off_t aio_read_pos;
  my_aio_result aio_result;
#endif
} IO_CACHE;

typedef int (*qsort2_cmp)(const void *, const void *, const void *);

	/* defines for mf_iocache */

	/* Test if buffer is inited */
#define my_b_clear(info) (info)->buffer=0
#define my_b_inited(info) (info)->buffer
#define my_b_EOF INT_MIN

#define my_b_read(info,Buffer,Count) \
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
530 531 532
  ((info)->read_pos + (Count) <= (info)->read_end ?\
   (memcpy(Buffer,(info)->read_pos,(size_t) (Count)), \
    ((info)->read_pos+=(Count)),0) :\
bk@work.mysql.com's avatar
bk@work.mysql.com committed
533 534
   (*(info)->read_function)((info),Buffer,Count))

535 536 537 538
#define my_b_write(info,Buffer,Count) \
 ((info)->write_pos + (Count) <=(info)->write_end ?\
  (memcpy((info)->write_pos, (Buffer), (size_t)(Count)),\
   ((info)->write_pos+=(Count)),0) : \
539
   (*(info)->write_function)((info),(uchar *)(Buffer),(Count)))
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
540

bk@work.mysql.com's avatar
bk@work.mysql.com committed
541
#define my_b_get(info) \
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
542 543
  ((info)->read_pos != (info)->read_end ?\
   ((info)->read_pos++, (int) (uchar) (info)->read_pos[-1]) :\
bk@work.mysql.com's avatar
bk@work.mysql.com committed
544 545 546 547
   _my_b_get(info))

	/* my_b_write_byte dosn't have any err-check */
#define my_b_write_byte(info,chr) \
548 549 550
  (((info)->write_pos < (info)->write_end) ?\
   ((*(info)->write_pos++)=(chr)) :\
   (_my_b_write(info,0,0) , ((*(info)->write_pos++)=(chr))))
bk@work.mysql.com's avatar
bk@work.mysql.com committed
551 552

#define my_b_fill_cache(info) \
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
553
  (((info)->read_end=(info)->read_pos),(*(info)->read_function)(info,0,0))
554

bk@work.mysql.com's avatar
bk@work.mysql.com committed
555
#define my_b_tell(info) ((info)->pos_in_file + \
556
			 (size_t) (*(info)->current_pos - (info)->request_pos))
557

558 559 560 561 562
#define my_b_get_buffer_start(info) (info)->request_pos 
#define my_b_get_bytes_in_buffer(info) (char*) (info)->read_end -   \
  (char*) my_b_get_buffer_start(info)
#define my_b_get_pos_in_file(info) (info)->pos_in_file

563
/* tell write offset in the SEQ_APPEND cache */
564
int      my_b_copy_to_file(IO_CACHE *cache, FILE *file);
565
my_off_t my_b_append_tell(IO_CACHE* info);
566
my_off_t my_b_safe_tell(IO_CACHE* info); /* picks the correct tell() */
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
567

568
#define my_b_bytes_in_cache(info) (size_t) (*(info)->current_end - \
monty@bitch.mysql.fi's avatar
monty@bitch.mysql.fi committed
569
					  *(info)->current_pos)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
570

serg@serg.mylan's avatar
serg@serg.mylan committed
571 572
typedef uint32 ha_checksum;

573 574
/* Define the type of function to be passed to process_default_option_files */
typedef int (*Process_option_func)(void *ctx, const char *group_name,
575
                                   const char *option);
576

577
#include <my_alloc.h>
bk@work.mysql.com's avatar
bk@work.mysql.com committed
578

579

bk@work.mysql.com's avatar
bk@work.mysql.com committed
580 581 582 583 584
	/* Prototypes for mysys and my_func functions */

extern int my_copy(const char *from,const char *to,myf MyFlags);
extern int my_append(const char *from,const char *to,myf MyFlags);
extern int my_delete(const char *name,myf MyFlags);
585
extern int my_getwd(char * buf,size_t size,myf MyFlags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
586 587
extern int my_setwd(const char *dir,myf MyFlags);
extern int my_lock(File fd,int op,my_off_t start, my_off_t length,myf MyFlags);
588
extern void *my_once_alloc(size_t Size,myf MyFlags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
589
extern void my_once_free(void);
590
extern char *my_once_strdup(const char *src,myf myflags);
591
extern void *my_once_memdup(const void *src, size_t len, myf myflags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
592
extern File my_open(const char *FileName,int Flags,myf MyFlags);
593 594 595
extern File my_register_filename(File fd, const char *FileName,
				 enum file_type type_of_file,
				 uint error_message_number, myf MyFlags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
596
extern File my_create(const char *FileName,int CreateFlags,
597
		      int AccessFlags, myf MyFlags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
598
extern int my_close(File Filedes,myf MyFlags);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
599
extern File my_dup(File file, myf MyFlags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
600
extern int my_mkdir(const char *dir, int Flags, myf MyFlags);
601
extern int my_readlink(char *to, const char *filename, myf MyFlags);
602
extern int my_is_symlink(const char *filename);
603 604 605 606
extern int my_realpath(char *to, const char *filename, myf MyFlags);
extern File my_create_with_symlink(const char *linkname, const char *filename,
				   int createflags, int access_flags,
				   myf MyFlags);
607 608
extern int my_delete_with_symlink(const char *name, myf MyFlags);
extern int my_rename_with_symlink(const char *from,const char *to,myf MyFlags);
609
extern int my_symlink(const char *content, const char *linkname, myf MyFlags);
610 611
extern size_t my_read(File Filedes,uchar *Buffer,size_t Count,myf MyFlags);
extern size_t my_pread(File Filedes,uchar *Buffer,size_t Count,my_off_t offset,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
612 613 614 615
		     myf MyFlags);
extern int my_rename(const char *from,const char *to,myf MyFlags);
extern my_off_t my_seek(File fd,my_off_t pos,int whence,myf MyFlags);
extern my_off_t my_tell(File fd,myf MyFlags);
616
extern size_t my_write(File Filedes,const uchar *Buffer,size_t Count,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
617
		     myf MyFlags);
618
extern size_t my_pwrite(File Filedes,const uchar *Buffer,size_t Count,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
619
		      my_off_t offset,myf MyFlags);
620 621
extern size_t my_fread(FILE *stream,uchar *Buffer,size_t Count,myf MyFlags);
extern size_t my_fwrite(FILE *stream,const uchar *Buffer,size_t Count,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
622 623 624
		      myf MyFlags);
extern my_off_t my_fseek(FILE *stream,my_off_t pos,int whence,myf MyFlags);
extern my_off_t my_ftell(FILE *stream,myf MyFlags);
625 626 627
extern void *_mymalloc(size_t uSize,const char *sFile,
                       uint uLine, myf MyFlag);
extern void *_myrealloc(void *pPtr,size_t uSize,const char *sFile,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
628
		       uint uLine, myf MyFlag);
629 630 631 632 633 634 635 636 637 638
extern void * my_multi_malloc _VARARGS((myf MyFlags, ...));
extern void _myfree(void *pPtr,const char *sFile,uint uLine, myf MyFlag);
extern int _sanity(const char *sFile, uint uLine);
extern void *_my_memdup(const void *from, size_t length,
                        const char *sFile, uint uLine,myf MyFlag);
extern char * _my_strdup(const char *from, const char *sFile, uint uLine,
                         myf MyFlag);
extern char *_my_strndup(const char *from, size_t length,
                         const char *sFile, uint uLine,
                         myf MyFlag);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
639

cmiller@zippy.(none)'s avatar
cmiller@zippy.(none) committed
640 641
/* implemented in my_memmem.c */
extern void *my_memmem(const void *haystack, size_t haystacklen,
642
                       const void *needle, size_t needlelen);
cmiller@zippy.(none)'s avatar
cmiller@zippy.(none) committed
643 644


645 646
#ifdef _WIN32
extern int      my_access(const char *path, int amode);
647 648 649
#else
#define my_access access
#endif
650

monty@mysql.com's avatar
monty@mysql.com committed
651
extern int check_if_legal_filename(const char *path);
652
extern int check_if_legal_tablename(const char *path);
653

Vladislav Vaintroub's avatar
Vladislav Vaintroub committed
654
#ifdef _WIN32
655 656 657 658 659 660
extern int nt_share_delete(const char *name,myf MyFlags);
#define my_delete_allow_opened(fname,flags)  nt_share_delete((fname),(flags))
#else
#define my_delete_allow_opened(fname,flags)  my_delete((fname),(flags))
#endif

661 662 663 664 665 666 667
#ifdef _WIN32
/* Windows-only functions (CRT equivalents)*/
extern File     my_sopen(const char *path, int oflag, int shflag, int pmode);
extern HANDLE   my_get_osfhandle(File fd);
extern void     my_osmaperr(unsigned long last_error);
#endif

bk@work.mysql.com's avatar
bk@work.mysql.com committed
668
#ifndef TERMINATE
669
extern void TERMINATE(FILE *file, uint flag);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
670 671
#endif
extern void init_glob_errs(void);
672
extern const char** get_global_errmsgs();
673
extern void wait_for_free_space(const char *filename, int errors);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
674
extern FILE *my_fopen(const char *FileName,int Flags,myf MyFlags);
675
extern FILE *my_fdopen(File Filedes,const char *name, int Flags,myf MyFlags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
676
extern int my_fclose(FILE *fd,myf MyFlags);
677
extern File my_fileno(FILE *fd);
678
extern int my_chsize(File fd,my_off_t newlength, int filler, myf MyFlags);
679
extern int my_sync(File fd, myf my_flags);
680 681
extern int my_sync_dir(const char *dir_name, myf my_flags);
extern int my_sync_dir_by_file(const char *file_name, myf my_flags);
Marc Alff's avatar
Marc Alff committed
682 683 684 685
extern void my_error _VARARGS((int nr,myf MyFlags, ...));
extern void my_printf_error _VARARGS((uint my_err, const char *format,
                                     myf MyFlags, ...))
                                     ATTRIBUTE_FORMAT(printf, 2, 4);
686 687
extern void my_printv_error(uint error, const char *format, myf MyFlags,
                            va_list ap);
688 689
extern int my_error_register(const char** (*get_errmsgs) (),
                             int first, int last);
690
extern const char **my_error_unregister(int first, int last);
Marc Alff's avatar
Marc Alff committed
691 692 693
extern void my_message(uint my_err, const char *str,myf MyFlags);
extern void my_message_no_curses(uint my_err, const char *str,myf MyFlags);
extern void my_message_curses(uint my_err, const char *str,myf MyFlags);
694
extern my_bool my_init(void);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
695 696 697
extern void my_end(int infoflag);
extern int my_redel(const char *from, const char *to, int MyFlags);
extern int my_copystat(const char *from, const char *to, int MyFlags);
698
extern char * my_filename(File fd);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
699

700
#ifndef THREAD
bk@work.mysql.com's avatar
bk@work.mysql.com committed
701 702
extern void dont_break(void);
extern void allow_break(void);
703 704 705 706 707
#else
#define dont_break()
#define allow_break()
#endif

monty@mysql.com's avatar
monty@mysql.com committed
708
#ifdef EXTRA_DEBUG
monty@mysql.com's avatar
monty@mysql.com committed
709
void my_print_open_files(void);
monty@mysql.com's avatar
monty@mysql.com committed
710 711 712 713
#else
#define my_print_open_files()
#endif

714 715 716 717
extern my_bool init_tmpdir(MY_TMPDIR *tmpdir, const char *pathlist);
extern char *my_tmpdir(MY_TMPDIR *tmpdir);
extern void free_tmpdir(MY_TMPDIR *tmpdir);

bk@work.mysql.com's avatar
bk@work.mysql.com committed
718
extern void my_remember_signal(int signal_number,sig_handler (*func)(int));
719
extern size_t dirname_part(char * to,const char *name, size_t *to_res_length);
720
extern size_t dirname_length(const char *name);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
721 722
#define base_name(A) (A+dirname_length(A))
extern int test_if_hard_path(const char *dir_name);
723
extern my_bool has_path(const char *name);
724
extern char *convert_dirname(char *to, const char *from, const char *from_end);
725 726 727 728
extern void to_unix_path(char * name);
extern char * fn_ext(const char *name);
extern char * fn_same(char * toname,const char *name,int flag);
extern char * fn_format(char * to,const char *name,const char *dir,
729
			   const char *form, uint flag);
730 731
extern size_t strlength(const char *str);
extern void pack_dirname(char * to,const char *from);
732
extern size_t normalize_dirname(char * to, const char *from);
733 734 735 736 737 738 739 740
extern size_t unpack_dirname(char * to,const char *from);
extern size_t cleanup_dirname(char * to,const char *from);
extern size_t system_filename(char * to,const char *from);
extern size_t unpack_filename(char * to,const char *from);
extern char * intern_filename(char * to,const char *from);
extern char * directory_file_name(char * dst, const char *src);
extern int pack_filename(char * to, const char *name, size_t max_length);
extern char * my_path(char * to,const char *progname,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
741
			 const char *own_pathname_part);
742
extern char * my_load_path(char * to, const char *path,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
743
			      const char *own_path_prefix);
monty@mysql.com's avatar
monty@mysql.com committed
744 745
extern int wild_compare(const char *str,const char *wildstr,
                        pbool str_is_pattern);
746
extern WF_PACK *wf_comp(char * str);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
747 748
extern int wf_test(struct wild_file_pack *wf_pack,const char *name);
extern void wf_end(struct wild_file_pack *buffer);
749 750
extern my_bool array_append_string_unique(const char *str,
                                          const char **array, size_t size);
751 752
extern void get_date(char * to,int timeflag,time_t use_time);
extern void soundex(CHARSET_INFO *, char * out_pntr, char * in_pntr,
monty@mysql.com's avatar
monty@mysql.com committed
753
                    pbool remove_garbage);
754 755
extern int init_record_cache(RECORD_CACHE *info,size_t cachesize,File file,
			     size_t reclength,enum cache_type type,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
756
			     pbool use_async_io);
757
extern int read_cache_record(RECORD_CACHE *info,uchar *to);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
758 759
extern int end_record_cache(RECORD_CACHE *info);
extern int write_cache_record(RECORD_CACHE *info,my_off_t filepos,
760
			      const uchar *record,size_t length);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
761 762 763 764
extern int flush_write_cache(RECORD_CACHE *info);
extern long my_clock(void);
extern sig_handler sigtstp_handler(int signal_number);
extern void handle_recived_signals(void);
765

bk@work.mysql.com's avatar
bk@work.mysql.com committed
766
extern sig_handler my_set_alarm_variable(int signo);
767
extern void my_string_ptr_sort(uchar *base,uint items,size_t size);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
768
extern void radixsort_for_str_ptr(uchar* base[], uint number_of_elements,
769
				  size_t size_of_element,uchar *buffer[]);
770 771 772 773
extern qsort_t my_qsort(void *base_ptr, size_t total_elems, size_t size,
                        qsort_cmp cmp);
extern qsort_t my_qsort2(void *base_ptr, size_t total_elems, size_t size,
                         qsort2_cmp cmp, void *cmp_argument);
774 775 776 777
extern qsort2_cmp get_ptr_compare(size_t);
void my_store_ptr(uchar *buff, size_t pack_length, my_off_t pos);
my_off_t my_get_ptr(uchar *ptr, size_t pack_length);
extern int init_io_cache(IO_CACHE *info,File file,size_t cachesize,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
778 779 780 781 782
			 enum cache_type type,my_off_t seek_offset,
			 pbool use_async_io, myf cache_myflags);
extern my_bool reinit_io_cache(IO_CACHE *info,enum cache_type type,
			       my_off_t seek_offset,pbool use_async_io,
			       pbool clear_cache);
783
extern void setup_io_cache(IO_CACHE* info);
784
extern int _my_b_read(IO_CACHE *info,uchar *Buffer,size_t Count);
785
#ifdef THREAD
786
extern int _my_b_read_r(IO_CACHE *info,uchar *Buffer,size_t Count);
787 788
extern void init_io_cache_share(IO_CACHE *read_cache, IO_CACHE_SHARE *cshare,
                                IO_CACHE *write_cache, uint num_threads);
789
extern void remove_io_thread(IO_CACHE *info);
790
#endif
791 792
extern int _my_b_seq_read(IO_CACHE *info,uchar *Buffer,size_t Count);
extern int _my_b_net_read(IO_CACHE *info,uchar *Buffer,size_t Count);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
793
extern int _my_b_get(IO_CACHE *info);
794 795 796 797
extern int _my_b_async_read(IO_CACHE *info,uchar *Buffer,size_t Count);
extern int _my_b_write(IO_CACHE *info,const uchar *Buffer,size_t Count);
extern int my_b_append(IO_CACHE *info,const uchar *Buffer,size_t Count);
extern int my_b_safe_write(IO_CACHE *info,const uchar *Buffer,size_t Count);
798

799 800
extern int my_block_write(IO_CACHE *info, const uchar *Buffer,
			  size_t Count, my_off_t pos);
801
extern int my_b_flush_io_cache(IO_CACHE *info, int need_append_buffer_lock);
802

803
#define flush_io_cache(info) my_b_flush_io_cache((info),1)
804

bk@work.mysql.com's avatar
bk@work.mysql.com committed
805
extern int end_io_cache(IO_CACHE *info);
806
extern size_t my_b_fill(IO_CACHE *info);
807
extern void my_b_seek(IO_CACHE *info,my_off_t pos);
808
extern size_t my_b_gets(IO_CACHE *info, char *to, size_t max_length);
809
extern my_off_t my_b_filelength(IO_CACHE *info);
810 811
extern size_t my_b_printf(IO_CACHE *info, const char* fmt, ...);
extern size_t my_b_vprintf(IO_CACHE *info, const char* fmt, va_list ap);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
812
extern my_bool open_cached_file(IO_CACHE *cache,const char *dir,
813
				 const char *prefix, size_t cache_size,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
814 815 816
				 myf cache_myflags);
extern my_bool real_open_cached_file(IO_CACHE *cache);
extern void close_cached_file(IO_CACHE *cache);
817 818
File create_temp_file(char *to, const char *dir, const char *pfx,
		      int mode, myf MyFlags);
antony@ppcg5.local's avatar
antony@ppcg5.local committed
819 820 821 822 823 824 825 826 827
#define my_init_dynamic_array(A,B,C,D) init_dynamic_array2(A,B,NULL,C,D CALLER_INFO)
#define my_init_dynamic_array_ci(A,B,C,D) init_dynamic_array2(A,B,NULL,C,D ORIG_CALLER_INFO)
#define my_init_dynamic_array2(A,B,C,D,E) init_dynamic_array2(A,B,C,D,E CALLER_INFO)
#define my_init_dynamic_array2_ci(A,B,C,D,E) init_dynamic_array2(A,B,C,D,E ORIG_CALLER_INFO)
extern my_bool init_dynamic_array2(DYNAMIC_ARRAY *array,uint element_size,
                                   void *init_buffer, uint init_alloc, 
                                   uint alloc_increment
                                   CALLER_INFO_PROTO);
/* init_dynamic_array() function is deprecated */
828
extern my_bool init_dynamic_array(DYNAMIC_ARRAY *array,uint element_size,
829 830
                                  uint init_alloc,uint alloc_increment
                                  CALLER_INFO_PROTO);
831 832 833 834
extern my_bool insert_dynamic(DYNAMIC_ARRAY *array,uchar * element);
extern uchar *alloc_dynamic(DYNAMIC_ARRAY *array);
extern uchar *pop_dynamic(DYNAMIC_ARRAY*);
extern my_bool set_dynamic(DYNAMIC_ARRAY *array,uchar * element,uint array_index);
835
extern my_bool allocate_dynamic(DYNAMIC_ARRAY *array, uint max_elements);
836
extern void get_dynamic(DYNAMIC_ARRAY *array,uchar * element,uint array_index);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
837 838 839
extern void delete_dynamic(DYNAMIC_ARRAY *array);
extern void delete_dynamic_element(DYNAMIC_ARRAY *array, uint array_index);
extern void freeze_size(DYNAMIC_ARRAY *array);
840
extern int  get_index_dynamic(DYNAMIC_ARRAY *array, uchar * element);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
841 842
#define dynamic_array_ptr(array,array_index) ((array)->buffer+(array_index)*(array)->size_of_element)
#define dynamic_element(array,array_index,type) ((type)((array)->buffer) +(array_index))
serg@serg.mylan's avatar
serg@serg.mylan committed
843
#define push_dynamic(A,B) insert_dynamic((A),(B))
844
#define reset_dynamic(array) ((array)->elements= 0)
845
#define sort_dynamic(A,cmp) my_qsort((A)->buffer, (A)->elements, (A)->size_of_element, (cmp))
bk@work.mysql.com's avatar
bk@work.mysql.com committed
846 847

extern my_bool init_dynamic_string(DYNAMIC_STRING *str, const char *init_str,
848
				   size_t init_alloc,size_t alloc_increment);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
849
extern my_bool dynstr_append(DYNAMIC_STRING *str, const char *append);
850
my_bool dynstr_append_mem(DYNAMIC_STRING *str, const char *append,
851
			  size_t length);
852 853
extern my_bool dynstr_append_os_quoted(DYNAMIC_STRING *str, const char *append,
                                       ...);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
854
extern my_bool dynstr_set(DYNAMIC_STRING *str, const char *init_str);
855 856
extern my_bool dynstr_realloc(DYNAMIC_STRING *str, size_t additional_size);
extern my_bool dynstr_trunc(DYNAMIC_STRING *str, size_t n);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
857 858
extern void dynstr_free(DYNAMIC_STRING *str);
#ifdef HAVE_MLOCK
859 860
extern void *my_malloc_lock(size_t length,myf flags);
extern void my_free_lock(void *ptr,myf flags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
861 862 863 864
#else
#define my_malloc_lock(A,B) my_malloc((A),(B))
#define my_free_lock(A,B) my_free((A),(B))
#endif
monty@donna.mysql.com's avatar
monty@donna.mysql.com committed
865
#define alloc_root_inited(A) ((A)->min_malloc != 0)
866
#define ALLOC_ROOT_MIN_BLOCK_SIZE (MALLOC_OVERHEAD + sizeof(USED_MEM) + 8)
867
#define clear_alloc_root(A) do { (A)->free= (A)->used= (A)->pre_alloc= 0; (A)->min_malloc=0;} while(0)
868 869 870 871
extern void init_alloc_root(MEM_ROOT *mem_root, size_t block_size,
			    size_t pre_alloc_size);
extern void *alloc_root(MEM_ROOT *mem_root, size_t Size);
extern void *multi_alloc_root(MEM_ROOT *mem_root, ...);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
872 873
extern void free_root(MEM_ROOT *root, myf MyFLAGS);
extern void set_prealloc_root(MEM_ROOT *root, char *ptr);
874 875
extern void reset_root_defaults(MEM_ROOT *mem_root, size_t block_size,
                                size_t prealloc_size);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
876
extern char *strdup_root(MEM_ROOT *root,const char *str);
877 878
extern char *strmake_root(MEM_ROOT *root,const char *str,size_t len);
extern void *memdup_root(MEM_ROOT *root,const void *str, size_t len);
monty@mishka.local's avatar
monty@mishka.local committed
879 880 881
extern int get_defaults_options(int argc, char **argv,
                                char **defaults, char **extra_defaults,
                                char **group_suffix);
882
extern const char *args_separator;
883 884
extern int my_load_defaults(const char *conf_file, const char **groups,
                            int *argc, char ***argv, const char ***);
885
extern int load_defaults(const char *conf_file, const char **groups,
886
                         int *argc, char ***argv);
887 888 889
extern int modify_defaults_file(const char *file_location, const char *option,
                                const char *option_value,
                                const char *section_name, int remove_option);
890 891
extern int my_search_option_files(const char *conf_file, int *argc,
                                  char ***argv, uint *args_used,
892 893
                                  Process_option_func func, void *func_ctx,
                                  const char **default_directories);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
894
extern void free_defaults(char **argv);
895
extern void my_print_default_files(const char *conf_file);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
896
extern void print_defaults(const char *conf_file, const char **groups);
897 898 899 900
extern my_bool my_compress(uchar *, size_t *, size_t *);
extern my_bool my_uncompress(uchar *, size_t , size_t *);
extern uchar *my_compress_alloc(const uchar *packet, size_t *len,
                                size_t *complen);
901
extern int packfrm(uchar *, size_t, uchar **, size_t *);
902 903 904 905
extern int unpackfrm(uchar **, size_t *, const uchar *);

extern ha_checksum my_checksum(ha_checksum crc, const uchar *mem,
                               size_t count);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
906
extern void my_sleep(ulong m_seconds);
907
extern ulong crc32(ulong crc, const uchar *buf, uint len);
908 909 910
extern uint my_set_max_open_files(uint files);
void my_free_open_file_info(void);

911
extern time_t my_time(myf flags);
serg@serg.mylan's avatar
serg@serg.mylan committed
912
extern ulonglong my_getsystime(void);
913 914 915
extern ulonglong my_micro_time();
extern ulonglong my_micro_time_and_time(time_t *time_arg);
time_t my_time_possible_from_micro(ulonglong microtime);
serg@serg.mylan's avatar
serg@serg.mylan committed
916 917
extern my_bool my_gethwaddr(uchar *to);
extern int my_getncpus();
918

serg@serg.mylan's avatar
serg@serg.mylan committed
919
#ifdef HAVE_SYS_MMAN_H
920 921 922 923 924
#include <sys/mman.h>

#ifndef MAP_NOSYNC
#define MAP_NOSYNC      0
#endif
925
#ifndef MAP_NORESERVE
926 927
#define MAP_NORESERVE 0         /* For irix and AIX */
#endif
928

vtkachenko@quadxeon.mysql.com's avatar
vtkachenko@quadxeon.mysql.com committed
929 930 931
#ifdef HAVE_MMAP64
#define my_mmap(a,b,c,d,e,f)    mmap64(a,b,c,d,e,f)
#else
932
#define my_mmap(a,b,c,d,e,f)    mmap(a,b,c,d,e,f)
vtkachenko@quadxeon.mysql.com's avatar
vtkachenko@quadxeon.mysql.com committed
933
#endif
serg@serg.mylan's avatar
serg@serg.mylan committed
934
#define my_munmap(a,b)          munmap((a),(b))
935 936 937 938 939

#else
/* not a complete set of mmap() flags, but only those that nesessary */
#define PROT_READ        1
#define PROT_WRITE       2
kent@mysql.com's avatar
kent@mysql.com committed
940
#define MAP_NORESERVE    0
serg@serg.mylan's avatar
serg@serg.mylan committed
941
#define MAP_SHARED       0x0001
942
#define MAP_PRIVATE      0x0002
serg@serg.mylan's avatar
serg@serg.mylan committed
943
#define MAP_NOSYNC       0x0800
944 945
#define MAP_FAILED       ((void *)-1)
#define MS_SYNC          0x0000
946 947

#ifndef __NETWARE__
serg@serg.mylan's avatar
serg@serg.mylan committed
948
#define HAVE_MMAP
949
#endif
950 951 952 953 954

void *my_mmap(void *, size_t, int, int, int, my_off_t);
int my_munmap(void *, size_t);
#endif

955 956 957 958 959 960 961
/* my_getpagesize */
#ifdef HAVE_GETPAGESIZE
#define my_getpagesize()        getpagesize()
#else
int my_getpagesize(void);
#endif

962 963
int my_msync(int, void *, size_t, int);

964 965 966 967 968 969 970 971 972
/* character sets */
extern uint get_charset_number(const char *cs_name, uint cs_flags);
extern uint get_collation_number(const char *name);
extern const char *get_charset_name(uint cs_number);

extern CHARSET_INFO *get_charset(uint cs_number, myf flags);
extern CHARSET_INFO *get_charset_by_name(const char *cs_name, myf flags);
extern CHARSET_INFO *get_charset_by_csname(const char *cs_name,
					   uint cs_flags, myf my_flags);
973

974 975 976 977 978 979
extern my_bool resolve_charset(const char *cs_name,
                               CHARSET_INFO *default_cs,
                               CHARSET_INFO **cs);
extern my_bool resolve_collation(const char *cl_name,
                                 CHARSET_INFO *default_cl,
                                 CHARSET_INFO **cl);
980

981 982 983 984 985
extern void free_charsets(void);
extern char *get_charsets_dir(char *buf);
extern my_bool my_charset_same(CHARSET_INFO *cs1, CHARSET_INFO *cs2);
extern my_bool init_compiled_charsets(myf flags);
extern void add_compiled_collation(CHARSET_INFO *cs);
986 987 988
extern size_t escape_string_for_mysql(CHARSET_INFO *charset_info,
                                      char *to, size_t to_length,
                                      const char *from, size_t length);
989 990 991 992 993
#ifdef __WIN__
#define BACKSLASH_MBTAIL
/* File system character set */
extern CHARSET_INFO *fs_character_set(void);
#endif
994 995 996
extern size_t escape_quotes_for_mysql(CHARSET_INFO *charset_info,
                                      char *to, size_t to_length,
                                      const char *from, size_t length);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
997

998 999 1000 1001
extern void thd_increment_bytes_sent(ulong length);
extern void thd_increment_bytes_received(ulong length);
extern void thd_increment_net_big_packet_count(ulong length);

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1002 1003
#ifdef __WIN__
extern my_bool have_tcpip;		/* Is set if tcpip is used */
1004 1005 1006 1007 1008 1009 1010 1011

/* implemented in my_windac.c */

int my_security_attr_create(SECURITY_ATTRIBUTES **psa, const char **perror,
                            DWORD owner_rights, DWORD everybody_rights);

void my_security_attr_free(SECURITY_ATTRIBUTES *sa);

1012
/* implemented in my_conio.c */
1013
char* my_cgets(char *string, size_t clen, size_t* plen);
1014

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1015
#endif
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1016 1017 1018 1019
#ifdef __NETWARE__
void netware_reg_user(const char *ip, const char *user,
		      const char *application);
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1020

1021
C_MODE_END
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1022
#endif /* _my_sys_h */