log_event.h 53.9 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
unknown's avatar
unknown committed
2

unknown's avatar
unknown 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.
unknown's avatar
unknown committed
7

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

unknown's avatar
unknown committed
13 14 15 16 17
   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 */


18 19
#ifndef _log_event_h
#define _log_event_h
unknown's avatar
unknown committed
20

21 22 23 24
#ifdef __EMX__
#undef write  // remove pthread.h macro definition, conflict with write() class member
#endif

25
#if defined(USE_PRAGMA_INTERFACE) && !defined(MYSQL_CLIENT)
unknown's avatar
unknown committed
26 27 28 29 30 31 32
#pragma interface			/* gcc class implementation */
#endif

#define LOG_READ_EOF    -1
#define LOG_READ_BOGUS  -2
#define LOG_READ_IO     -3
#define LOG_READ_MEM    -5
unknown's avatar
unknown committed
33
#define LOG_READ_TRUNC  -6
unknown's avatar
unknown committed
34
#define LOG_READ_TOO_LARGE -7
unknown's avatar
unknown committed
35 36

#define LOG_EVENT_OFFSET 4
unknown's avatar
unknown committed
37 38

/*
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
   3 is MySQL 4.x; 4 is MySQL 5.0.0.
   Compared to version 3, version 4 has:
   - a different Start_log_event, which includes info about the binary log
   (sizes of headers); this info is included for better compatibility if the
   master's MySQL version is different from the slave's.
   - all events have a unique ID (the triplet (server_id, timestamp at server
   start, other) to be sure an event is not executed more than once in a
   multimaster setup, example:
                M1
              /   \
             v     v
             M2    M3
             \     /
              v   v
                S
   if a query is run on M1, it will arrive twice on S, so we need that S
   remembers the last unique ID it has processed, to compare and know if the
   event should be skipped or not. Example of ID: we already have the server id
   (4 bytes), plus:
   timestamp_when_the_master_started (4 bytes), a counter (a sequence number
   which increments every time we write an event to the binlog) (3 bytes).
   Q: how do we handle when the counter is overflowed and restarts from 0 ?
unknown's avatar
unknown committed
61

62
   - Query and Load (Create or Execute) events may have a more precise timestamp
unknown's avatar
unknown committed
63
   (with microseconds), number of matched/affected/warnings rows
64 65
   and fields of session variables: SQL_MODE,
   FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, SQL_AUTO_IS_NULL, the collations and
unknown's avatar
unknown committed
66
   charsets, the PASSWORD() version (old/new/...).
67 68
*/
#define BINLOG_VERSION    4
69

70 71 72
/*
 We could have used SERVER_VERSION_LENGTH, but this introduces an
 obscure dependency - if somebody decided to change SERVER_VERSION_LENGTH
73
 this would break the replication protocol
74 75 76
*/
#define ST_SERVER_VER_LEN 50

77 78 79 80 81
/*
  These are flags and structs to handle all the LOAD DATA INFILE options (LINES
  TERMINATED etc).
*/

82 83 84 85 86 87
/*
  These are flags and structs to handle all the LOAD DATA INFILE options (LINES
  TERMINATED etc).
  DUMPFILE_FLAG is probably useless (DUMPFILE is a clause of SELECT, not of LOAD
  DATA).
*/
88 89 90 91
#define DUMPFILE_FLAG		0x1
#define OPT_ENCLOSED_FLAG	0x2
#define REPLACE_FLAG		0x4
#define IGNORE_FLAG		0x8
92

93 94 95 96 97
#define FIELD_TERM_EMPTY	0x1
#define ENCLOSED_EMPTY		0x2
#define LINE_TERM_EMPTY		0x4
#define LINE_START_EMPTY	0x8
#define ESCAPED_EMPTY		0x10
98

99 100 101 102 103
/*****************************************************************************

  old_sql_ex struct

 ****************************************************************************/
104
struct old_sql_ex
105 106 107 108 109 110 111 112 113
{
  char field_term;
  char enclosed;
  char line_term;
  char line_start;
  char escaped;
  char opt_flags;
  char empty_flags;
};
114

unknown's avatar
unknown committed
115 116
#define NUM_LOAD_DELIM_STRS 5

117 118 119 120 121
/*****************************************************************************

  sql_ex_info struct

 ****************************************************************************/
122
struct sql_ex_info
123
{
124
  sql_ex_info() {}                            /* Remove gcc warning */
125 126 127 128 129 130 131
  char* field_term;
  char* enclosed;
  char* line_term;
  char* line_start;
  char* escaped;
  int cached_new_format;
  uint8 field_term_len,enclosed_len,line_term_len,line_start_len, escaped_len;
unknown's avatar
unknown committed
132
  char opt_flags;
133
  char empty_flags;
unknown's avatar
unknown committed
134

135
  // store in new format even if old is possible
unknown's avatar
unknown committed
136
  void force_new_format() { cached_new_format = 1;}
137 138 139 140 141 142
  int data_size()
  {
    return (new_format() ?
	    field_term_len + enclosed_len + line_term_len +
	    line_start_len + escaped_len + 6 : 7);
  }
143
  bool write_data(IO_CACHE* file);
144 145 146 147 148 149 150 151 152 153
  char* init(char* buf,char* buf_end,bool use_new_format);
  bool new_format()
  {
    return ((cached_new_format != -1) ? cached_new_format :
	    (cached_new_format=(field_term_len > 1 ||
				enclosed_len > 1 ||
				line_term_len > 1 || line_start_len > 1 ||
				escaped_len > 1)));
  }
};
154

155 156 157 158 159 160 161 162 163 164 165 166
/*****************************************************************************

  MySQL Binary Log

  This log consists of events.  Each event has a fixed-length header,
  possibly followed by a variable length data body.

  The data body consists of an optional fixed length segment (post-header)
  and  an optional variable length segment.

  See the #defines below for the format specifics.

unknown's avatar
unknown committed
167 168 169 170 171 172
  The events which really update data are Query_log_event,
  Execute_load_query_log_event and old Load_log_event and
  Execute_load_log_event events (Execute_load_query is used together with
  Begin_load_query and Append_block events to replicate LOAD DATA INFILE.
  Create_file/Append_block/Execute_load (which includes Load_log_event)
  were used to replicate LOAD DATA before the 5.0.3).
173

174
 ****************************************************************************/
175

176 177
#define LOG_EVENT_HEADER_LEN 19     /* the fixed header length */
#define OLD_HEADER_LEN       13     /* the fixed header length in 3.23 */
unknown's avatar
unknown committed
178
/*
179 180 181 182 183 184
   Fixed header length, where 4.x and 5.0 agree. That is, 5.0 may have a longer
   header (it will for sure when we have the unique event's ID), but at least
   the first 19 bytes are the same in 4.x and 5.0. So when we have the unique
   event's ID, LOG_EVENT_HEADER_LEN will be something like 26, but
   LOG_EVENT_MINIMAL_HEADER_LEN will remain 19.
*/
unknown's avatar
unknown committed
185 186
#define LOG_EVENT_MINIMAL_HEADER_LEN 19

187
/* event-specific post-header sizes */
188 189 190
// where 3.23, 4.x and 5.0 agree
#define QUERY_HEADER_MINIMAL_LEN     (4 + 4 + 1 + 2)
// where 5.0 differs: 2 for len of N-bytes vars.
unknown's avatar
unknown committed
191
#define QUERY_HEADER_LEN     (QUERY_HEADER_MINIMAL_LEN + 2)
192
#define LOAD_HEADER_LEN      (4 + 4 + 4 + 1 +1 + 4)
193 194
#define START_V3_HEADER_LEN     (2 + ST_SERVER_VER_LEN + 4)
#define ROTATE_HEADER_LEN    8 // this is FROZEN (the Rotate post-header is frozen)
195 196 197 198
#define CREATE_FILE_HEADER_LEN 4
#define APPEND_BLOCK_HEADER_LEN 4
#define EXEC_LOAD_HEADER_LEN   4
#define DELETE_FILE_HEADER_LEN 4
199
#define FORMAT_DESCRIPTION_HEADER_LEN (START_V3_HEADER_LEN+1+LOG_EVENT_TYPES)
unknown's avatar
unknown committed
200 201
#define EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN (4 + 4 + 4 + 1)
#define EXECUTE_LOAD_QUERY_HEADER_LEN  (QUERY_HEADER_LEN + EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN)
202

203 204
/* 
  Max number of possible extra bytes in a replication event compared to a
205 206
  packet (i.e. a query) sent from client to master;
  First, an auxiliary log_event status vars estimation:
207
*/
208 209 210 211 212 213 214 215 216 217 218 219
#define MAX_SIZE_LOG_EVENT_STATUS (4 /* flags2 */   + \
                                   8 /* sql mode */ + \
                                   1 + 1 + 255 /* catalog */ + \
                                   4 /* autoinc */ + \
                                   6 /* charset */ + \
                                   MAX_TIME_ZONE_NAME_LENGTH)
#define MAX_LOG_EVENT_HEADER   ( /* in order of Query_log_event::write */ \
  LOG_EVENT_HEADER_LEN + /* write_header */ \
  QUERY_HEADER_LEN     + /* write_data */   \
  EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN + /*write_post_header_for_derived */ \
  MAX_SIZE_LOG_EVENT_STATUS + /* status */ \
  NAME_LEN + 1)
220

221 222 223 224
/* 
   Event header offsets; 
   these point to places inside the fixed header.
*/
unknown's avatar
unknown committed
225

226
#define EVENT_TYPE_OFFSET    4
227 228
#define SERVER_ID_OFFSET     5
#define EVENT_LEN_OFFSET     9
229
#define LOG_POS_OFFSET       13
230 231
#define FLAGS_OFFSET         17

232
/* start event post-header (for v3 and v4) */
233 234 235 236

#define ST_BINLOG_VER_OFFSET  0
#define ST_SERVER_VER_OFFSET  2
#define ST_CREATED_OFFSET     (ST_SERVER_VER_OFFSET + ST_SERVER_VER_LEN)
237
#define ST_COMMON_HEADER_LEN_OFFSET (ST_CREATED_OFFSET + 4)
238

239
/* slave event post-header (this event is never written) */
240

unknown's avatar
unknown committed
241 242 243
#define SL_MASTER_PORT_OFFSET   8
#define SL_MASTER_POS_OFFSET    0
#define SL_MASTER_HOST_OFFSET   10
244 245 246

/* query event post-header */

247 248 249 250
#define Q_THREAD_ID_OFFSET	0
#define Q_EXEC_TIME_OFFSET	4
#define Q_DB_LEN_OFFSET		8
#define Q_ERR_CODE_OFFSET	9
251
#define Q_STATUS_VARS_LEN_OFFSET 11
252
#define Q_DATA_OFFSET		QUERY_HEADER_LEN
253 254 255
/* these are codes, not offsets; not more than 256 values (1 byte). */
#define Q_FLAGS2_CODE           0
#define Q_SQL_MODE_CODE         1
256 257
/*
  Q_CATALOG_CODE is catalog with end zero stored; it is used only by MySQL
258 259
  5.0.x where 0<=x<=3. We have to keep it to be able to replicate these
  old masters.
260
*/
261
#define Q_CATALOG_CODE          2
262
#define Q_AUTO_INCREMENT	3
263
#define Q_CHARSET_CODE          4
264
#define Q_TIME_ZONE_CODE        5
265 266 267 268 269 270 271 272
/*
  Q_CATALOG_NZ_CODE is catalog withOUT end zero stored; it is used by MySQL
  5.0.x where x>=4. Saves one byte in every Query_log_event in binlog,
  compared to Q_CATALOG_CODE. The reason we didn't simply re-use
  Q_CATALOG_CODE is that then a 5.0.3 slave of this 5.0.x (x>=4) master would
  crash (segfault etc) because it would expect a 0 when there is none.
*/
#define Q_CATALOG_NZ_CODE       6
273 274 275 276 277 278

/* Intvar event post-header */

#define I_TYPE_OFFSET        0
#define I_VAL_OFFSET         1

unknown's avatar
unknown committed
279 280 281 282 283
/* Rand event post-header */

#define RAND_SEED1_OFFSET 0
#define RAND_SEED2_OFFSET 8

unknown's avatar
unknown committed
284 285 286 287 288 289 290 291
/* User_var event post-header */

#define UV_VAL_LEN_SIZE        4
#define UV_VAL_IS_NULL         1
#define UV_VAL_TYPE_SIZE       1
#define UV_NAME_LEN_SIZE       4
#define UV_CHARSET_NUMBER_SIZE 4

292 293 294 295 296
/* Load event post-header */

#define L_THREAD_ID_OFFSET   0
#define L_EXEC_TIME_OFFSET   4
#define L_SKIP_LINES_OFFSET  8
unknown's avatar
unknown committed
297 298
#define L_TBL_LEN_OFFSET     12
#define L_DB_LEN_OFFSET      13
299
#define L_NUM_FIELDS_OFFSET  14
300
#define L_SQL_EX_OFFSET      18
301
#define L_DATA_OFFSET        LOAD_HEADER_LEN
302

303 304 305 306
/* Rotate event post-header */

#define R_POS_OFFSET       0
#define R_IDENT_OFFSET     8
307

308 309 310
/* CF to DF handle LOAD DATA INFILE */

/* CF = "Create File" */
311 312 313
#define CF_FILE_ID_OFFSET  0
#define CF_DATA_OFFSET     CREATE_FILE_HEADER_LEN

314
/* AB = "Append Block" */
315 316 317
#define AB_FILE_ID_OFFSET  0
#define AB_DATA_OFFSET     APPEND_BLOCK_HEADER_LEN

318
/* EL = "Execute Load" */
319 320
#define EL_FILE_ID_OFFSET  0

321
/* DF = "Delete File" */
322
#define DF_FILE_ID_OFFSET  0
323

unknown's avatar
unknown committed
324 325 326 327 328 329
/* ELQ = "Execute Load Query" */
#define ELQ_FILE_ID_OFFSET QUERY_HEADER_LEN
#define ELQ_FN_POS_START_OFFSET ELQ_FILE_ID_OFFSET + 4
#define ELQ_FN_POS_END_OFFSET ELQ_FILE_ID_OFFSET + 8
#define ELQ_DUP_HANDLING_OFFSET ELQ_FILE_ID_OFFSET + 12

330
/* 4 bytes which all binlogs should begin with */
unknown's avatar
unknown committed
331
#define BINLOG_MAGIC        "\xfe\x62\x69\x6e"
332

333 334 335 336 337 338 339 340
/*
  The 2 flags below were useless :
  - the first one was never set
  - the second one was set in all Rotate events on the master, but not used for
  anything useful.
  So they are now removed and their place may later be reused for other
  flags. Then one must remember that Rotate events in 4.x have
  LOG_EVENT_FORCED_ROTATE_F set, so one should not rely on the value of the
unknown's avatar
unknown committed
341
  replacing flag when reading a Rotate event.
342 343 344
  I keep the defines here just to remember what they were.
*/
#ifdef TO_BE_REMOVED
unknown's avatar
unknown committed
345
#define LOG_EVENT_TIME_F            0x1
unknown's avatar
unknown committed
346
#define LOG_EVENT_FORCED_ROTATE_F   0x2
347
#endif
348 349

/*
350 351 352 353 354 355 356 357
   This flag only makes sense for Format_description_log_event. It is set
   when the event is written, and *reset* when a binlog file is
   closed (yes, it's the only case when MySQL modifies already written
   part of binlog).  Thus it is a reliable indicator that binlog was
   closed correctly.  (Stop_log_event is not enough, there's always a
   small chance that mysqld crashes in the middle of insert and end of
   the binlog would look like a Stop_log_event).

358 359 360 361 362 363 364 365
   This flag is used to detect a restart after a crash, and to provide
   "unbreakable" binlog. The problem is that on a crash storage engines
   rollback automatically, while binlog does not.  To solve this we use this
   flag and automatically append ROLLBACK to every non-closed binlog (append
   virtually, on reading, file itself is not changed). If this flag is found,
   mysqlbinlog simply prints "ROLLBACK" Replication master does not abort on
   binlog corruption, but takes it as EOF, and replication slave forces a
   rollback in this case.
366 367 368

   Note, that old binlogs does not have this flag set, so we get a
   a backward-compatible behaviour.
369 370
*/

371 372
#define LOG_EVENT_BINLOG_IN_USE_F       0x1

unknown's avatar
unknown committed
373
/*
374 375 376 377 378
   If the query depends on the thread (for example: TEMPORARY TABLE).
   Currently this is used by mysqlbinlog to know it must print
   SET @@PSEUDO_THREAD_ID=xx; before the query (it would not hurt to print it
   for every query but this would be slow).
*/
unknown's avatar
unknown committed
379
#define LOG_EVENT_THREAD_SPECIFIC_F 0x4
380

381 382 383 384 385 386 387 388 389 390 391 392 393
/*
  Suppress the generation of 'USE' statements before the actual
  statement. This flag should be set for any events that does not need
  the current database set to function correctly. Most notable cases
  are 'CREATE DATABASE' and 'DROP DATABASE'.

  This flags should only be used in exceptional circumstances, since
  it introduce a significant change in behaviour regarding the
  replication logic together with the flags --binlog-do-db and
  --replicated-do-db.
 */
#define LOG_EVENT_SUPPRESS_USE_F    0x8

unknown's avatar
unknown committed
394
/*
395 396 397 398 399 400 401
   OPTIONS_WRITTEN_TO_BIN_LOG are the bits of thd->options which must be
   written to the binlog. OPTIONS_WRITTEN_TO_BINLOG could be written
   into the Format_description_log_event, so that if later we don't want
   to replicate a variable we did replicate, or the contrary, it's
   doable. But it should not be too hard to decide once for all of what
   we replicate and what we don't, among the fixed 32 bits of
   thd->options.
402
   I (Guilhem) have read through every option's usage, and it looks like
403 404 405 406
   OPTION_AUTO_IS_NULL and OPTION_NO_FOREIGN_KEYS are the only ones
   which alter how the query modifies the table. It's good to replicate
   OPTION_RELAXED_UNIQUE_CHECKS too because otherwise, the slave may
   insert data slower than the master, in InnoDB.
407
   OPTION_BIG_SELECTS is not needed (the slave thread runs with
408 409 410
   max_join_size=HA_POS_ERROR) and OPTION_BIG_TABLES is not needed
   either, as the manual says (because a too big in-memory temp table is
   automatically written to disk).
unknown's avatar
unknown committed
411
*/
412 413 414
#define OPTIONS_WRITTEN_TO_BIN_LOG (OPTION_AUTO_IS_NULL | \
OPTION_NO_FOREIGN_KEY_CHECKS | OPTION_RELAXED_UNIQUE_CHECKS)

unknown's avatar
unknown committed
415 416 417 418
#if OPTIONS_WRITTEN_TO_BIN_LOG != ((1L << 14) | (1L << 26) | (1L << 27))
#error OPTIONS_WRITTEN_TO_BIN_LOG must NOT change their values!
#endif

419 420
enum Log_event_type
{
421 422
  /*
    Every time you update this enum (when you add a type), you have to
unknown's avatar
unknown committed
423
    fix Format_description_log_event::Format_description_log_event().
424
  */
unknown's avatar
unknown committed
425 426 427 428 429 430 431 432 433 434 435
  UNKNOWN_EVENT= 0,
  START_EVENT_V3= 1,
  QUERY_EVENT= 2,
  STOP_EVENT= 3,
  ROTATE_EVENT= 4,
  INTVAR_EVENT= 5,
  LOAD_EVENT= 6,
  SLAVE_EVENT= 7,
  CREATE_FILE_EVENT= 8,
  APPEND_BLOCK_EVENT= 9,
  EXEC_LOAD_EVENT= 10,
436
  DELETE_FILE_EVENT= 11,
437
  /*
unknown's avatar
unknown committed
438 439 440
    NEW_LOAD_EVENT is like LOAD_EVENT except that it has a longer
    sql_ex, allowing multibyte TERMINATED BY etc; both types share the
    same class (Load_log_event)
441
  */
442
  NEW_LOAD_EVENT= 12,
unknown's avatar
unknown committed
443 444 445 446 447 448
  RAND_EVENT= 13,
  USER_VAR_EVENT= 14,
  FORMAT_DESCRIPTION_EVENT= 15,
  XID_EVENT= 16,
  BEGIN_LOAD_QUERY_EVENT= 17,
  EXECUTE_LOAD_QUERY_EVENT= 18,
unknown's avatar
unknown committed
449 450

  /*
unknown's avatar
unknown committed
451
    Add new events here - right above this comment!
unknown's avatar
unknown committed
452
    Existing events (except ENUM_END_EVENT) should never change their numbers
unknown's avatar
unknown committed
453 454
  */

unknown's avatar
unknown committed
455
  ENUM_END_EVENT /* end marker */
456 457
};

unknown's avatar
unknown committed
458
/*
459 460 461 462 463 464
   The number of types we handle in Format_description_log_event (UNKNOWN_EVENT
   is not to be handled, it does not exist in binlogs, it does not have a
   format).
*/
#define LOG_EVENT_TYPES (ENUM_END_EVENT-1)

465 466 467 468 469
enum Int_event_type
{
  INVALID_INT_EVENT = 0, LAST_INSERT_ID_EVENT = 1, INSERT_ID_EVENT = 2
};

unknown's avatar
unknown committed
470 471 472

#ifndef MYSQL_CLIENT
class String;
473 474
class MYSQL_LOG;
class THD;
unknown's avatar
unknown committed
475 476
#endif

477 478
class Format_description_log_event;

479
struct st_relay_log_info;
480

481 482
#ifdef MYSQL_CLIENT
/*
unknown's avatar
unknown committed
483 484
  A structure for mysqlbinlog to know how to print events

unknown's avatar
unknown committed
485 486 487 488 489 490 491 492
  This structure is passed to the event's print() methods,

  There are two types of settings stored here:
  1. Last db, flags2, sql_mode etc comes from the last printed event.
     They are stored so that only the necessary USE and SET commands
     are printed.
  2. Other information on how to print the events, e.g. short_form,
     hexdump_from.  These are not dependent on the last event.
493
*/
unknown's avatar
unknown committed
494
typedef struct st_print_event_info
495
{
unknown's avatar
unknown committed
496 497 498 499
  /*
    Settings for database, sql_mode etc that comes from the last event
    that was printed.
   */
500 501 502 503 504
  // TODO: have the last catalog here ??
  char db[FN_REFLEN+1]; // TODO: make this a LEX_STRING when thd->db is
  bool flags2_inited;
  uint32 flags2;
  bool sql_mode_inited;
unknown's avatar
unknown committed
505
  ulong sql_mode;		/* must be same as THD.variables.sql_mode */
506
  ulong auto_increment_increment, auto_increment_offset;
507 508
  bool charset_inited;
  char charset[6]; // 3 variables, each of them storable in 2 bytes
509
  char time_zone_str[MAX_TIME_ZONE_NAME_LENGTH];
unknown's avatar
unknown committed
510
  st_print_event_info()
511 512
    :flags2_inited(0), sql_mode_inited(0),
     auto_increment_increment(1),auto_increment_offset(1), charset_inited(0)
513
    {
514
      /*
unknown's avatar
unknown committed
515
        Currently we only use static PRINT_EVENT_INFO objects, so zeroed at
516 517 518 519 520
        program's startup, but these explicit bzero() is for the day someone
        creates dynamic instances.
      */
      bzero(db, sizeof(db));
      bzero(charset, sizeof(charset));
521
      bzero(time_zone_str, sizeof(time_zone_str));
522
      strcpy(delimiter, ";");
523
    }
unknown's avatar
unknown committed
524 525 526 527 528

  /* Settings on how to print the events */
  bool short_form;
  my_off_t hexdump_from;
  uint8 common_header_len;
529
  char delimiter[16];
unknown's avatar
unknown committed
530

unknown's avatar
unknown committed
531
} PRINT_EVENT_INFO;
532 533 534
#endif


535 536 537 538 539 540 541
/*****************************************************************************

  Log_event class

  This is the abstract base class for binary log events.

 ****************************************************************************/
unknown's avatar
unknown committed
542 543 544
class Log_event
{
public:
unknown's avatar
unknown committed
545
  /*
546 547 548 549 550 551 552 553
    The offset in the log where this event originally appeared (it is
    preserved in relay logs, making SHOW SLAVE STATUS able to print
    coordinates of the event in the master's binlog). Note: when a
    transaction is written by the master to its binlog (wrapped in
    BEGIN/COMMIT) the log_pos of all the queries it contains is the
    one of the BEGIN (this way, when one does SHOW SLAVE STATUS it
    sees the offset of the BEGIN, which is logical as rollback may
    occur), except the COMMIT query which has its real offset.
554
  */
555
  my_off_t log_pos;
unknown's avatar
unknown committed
556
  /*
557 558 559
     A temp buffer for read_log_event; it is later analysed according to the
     event's type, and its content is distributed in the event-specific fields.
  */
unknown's avatar
unknown committed
560
  char *temp_buf;
561
  /*
562 563 564 565 566 567
    Timestamp on the master(for debugging and replication of
    NOW()/TIMESTAMP).  It is important for queries and LOAD DATA
    INFILE. This is set at the event's creation time, except for Query
    and Load (et al.) events where this is set at the query's
    execution time, which guarantees good replication (otherwise, we
    could have a query and its event with different timestamps).
568
  */
unknown's avatar
unknown committed
569
  time_t when;
570
  /* The number of seconds the query took to run on the master. */
unknown's avatar
unknown committed
571
  ulong exec_time;
572 573 574
  /* Number of bytes written by write() function */
  ulong data_written;

unknown's avatar
unknown committed
575
  /*
576 577
    The master's server id (is preserved in the relay log; used to
    prevent from infinite loops in circular replication).
578
  */
579
  uint32 server_id;
580 581

  /*
582 583 584
    Some 16 flags. Look above for LOG_EVENT_TIME_F,
    LOG_EVENT_FORCED_ROTATE_F, LOG_EVENT_THREAD_SPECIFIC_F, and
    LOG_EVENT_SUPPRESS_USE_F for notes.
585
  */
586
  uint16 flags;
587

588
  bool cache_stmt;
589

590
#ifndef MYSQL_CLIENT
591
  THD* thd;
592

593
  Log_event();
594
  Log_event(THD* thd_arg, uint16 flags_arg, bool cache_stmt);
595
  /*
596 597 598 599 600 601 602 603 604
    read_log_event() functions read an event from a binlog or relay
    log; used by SHOW BINLOG EVENTS, the binlog_dump thread on the
    master (reads master's binlog), the slave IO thread (reads the
    event sent by binlog_dump), the slave SQL thread (reads the event
    from the relay log).  If mutex is 0, the read will proceed without
    mutex.  We need the description_event to be able to parse the
    event (to know the post-header's size); in fact in read_log_event
    we detect the event's type, then call the specific event's
    constructor and pass description_event as an argument.
605
  */
606 607
  static Log_event* read_log_event(IO_CACHE* file,
				   pthread_mutex_t* log_lock,
608
                                   const Format_description_log_event *description_event);
609 610
  static int read_log_event(IO_CACHE* file, String* packet,
			    pthread_mutex_t* log_lock);
611
  /*
612 613 614
    init_show_field_list() prepares the column names and types for the
    output of SHOW BINLOG EVENTS; it is used only by SHOW BINLOG
    EVENTS.
615
  */
616
  static void init_show_field_list(List<Item>* field_list);
unknown's avatar
SCRUM  
unknown committed
617
#ifdef HAVE_REPLICATION
unknown's avatar
unknown committed
618
  int net_send(Protocol *protocol, const char* log_name, my_off_t pos);
619 620 621 622
  /*
    pack_info() is used by SHOW BINLOG EVENTS; as print() it prepares and sends
    a string to display to the user, so it resembles print().
  */
unknown's avatar
unknown committed
623
  virtual void pack_info(Protocol *protocol);
624 625 626 627
  /*
    The SQL slave thread calls exec_event() to execute the event; this is where
    the slave's data is modified.
  */
628
  virtual int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
629
#endif /* HAVE_REPLICATION */
630 631 632 633 634
  virtual const char* get_db()
  {
    return thd ? thd->db : 0;
  }
#else
635
  Log_event() : temp_buf(0) {}
636
    /* avoid having to link mysqlbinlog against libpthread */
637 638
  static Log_event* read_log_event(IO_CACHE* file,
                                   const Format_description_log_event *description_event);
639
  /* print*() functions are used by mysqlbinlog */
unknown's avatar
unknown committed
640
  virtual void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0) = 0;
641
  void print_timestamp(FILE* file, time_t *ts = 0);
unknown's avatar
unknown committed
642
  void print_header(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
643
#endif
unknown's avatar
unknown committed
644

645 646 647 648 649 650
  static void *operator new(size_t size)
  {
    return (void*) my_malloc((uint)size, MYF(MY_WME|MY_FAE));
  }
  static void operator delete(void *ptr, size_t size)
  {
651
    my_free((gptr) ptr, MYF(MY_WME|MY_ALLOW_ZERO_PTR));
652
  }
unknown's avatar
unknown committed
653

654
#ifndef MYSQL_CLIENT
655 656 657 658 659 660 661 662
  bool write_header(IO_CACHE* file, ulong data_length);
  virtual bool write(IO_CACHE* file)
  {
    return (write_header(file, get_data_size()) ||
            write_data_header(file) ||
            write_data_body(file));
  }
  virtual bool write_data_header(IO_CACHE* file)
663
  { return 0; }
664
  virtual bool write_data_body(IO_CACHE* file __attribute__((unused)))
665
  { return 0; }
666
#endif
unknown's avatar
unknown committed
667
  virtual Log_event_type get_type_code() = 0;
unknown's avatar
unknown committed
668
  virtual bool is_valid() const = 0;
669
  virtual bool is_artificial_event() { return 0; }
670
  inline bool get_cache_stmt() { return cache_stmt; }
671
  Log_event(const char* buf, const Format_description_log_event* description_event);
672 673 674
  virtual ~Log_event() { free_temp_buf();}
  void register_temp_buf(char* buf) { temp_buf = buf; }
  void free_temp_buf()
675 676
  {
    if (temp_buf)
677
    {
678 679
      my_free(temp_buf, MYF(0));
      temp_buf = 0;
680
    }
681
  }
682 683 684 685
  /*
    Get event length for simple events. For complicated events the length
    is calculated during write()
  */
686
  virtual int get_data_size() { return 0;}
687 688 689
  static Log_event* read_log_event(const char* buf, uint event_len,
				   const char **error,
                                   const Format_description_log_event
unknown's avatar
unknown committed
690
                                   *description_event);
691
  /* returns the human readable name of the event's type */
unknown's avatar
unknown committed
692
  const char* get_type_str();
unknown's avatar
unknown committed
693 694
};

unknown's avatar
unknown committed
695
/*
696 697 698 699 700 701 702 703 704 705 706
   One class for each type of event.
   Two constructors for each class:
   - one to create the event for logging (when the server acts as a master),
   called after an update to the database is done,
   which accepts parameters like the query, the database, the options for LOAD
   DATA INFILE...
   - one to create the event from a packet (when the server acts as a slave),
   called before reproducing the update, which accepts parameters (like a
   buffer). Used to read from the master, from the relay log, and in
   mysqlbinlog. This constructor must be format-tolerant.
*/
unknown's avatar
unknown committed
707

708 709 710 711 712 713 714
/*****************************************************************************

  Query Log Event class

  Logs SQL queries

 ****************************************************************************/
unknown's avatar
unknown committed
715 716 717 718 719 720
class Query_log_event: public Log_event
{
protected:
  char* data_buf;
public:
  const char* query;
721
  const char* catalog;
unknown's avatar
unknown committed
722
  const char* db;
723 724 725 726 727 728
  /*
    If we already know the length of the query string
    we pass it with q_len, so we would not have to call strlen()
    otherwise, set it to 0, in which case, we compute it with strlen()
  */
  uint32 q_len;
unknown's avatar
unknown committed
729
  uint32 db_len;
730
  uint16 error_code;
731
  ulong thread_id;
unknown's avatar
unknown committed
732
  /*
733 734 735 736
    For events created by Query_log_event::exec_event (and
    Load_log_event::exec_event()) we need the *original* thread id, to be able
    to log the event with the original (=master's) thread id (fix for
    BUG#1686).
unknown's avatar
unknown committed
737 738
  */
  ulong slave_proxy_id;
unknown's avatar
unknown committed
739 740

  /*
741 742
    Binlog format 3 and 4 start to differ (as far as class members are
    concerned) from here.
743
  */
unknown's avatar
unknown committed
744

745
  uint catalog_len;			// <= 255 char; 0 means uninited
unknown's avatar
unknown committed
746

747 748
  /*
    We want to be able to store a variable number of N-bit status vars:
749 750 751
    (generally N=32; but N=64 for SQL_MODE) a user may want to log the number
    of affected rows (for debugging) while another does not want to lose 4
    bytes in this.
752 753 754 755 756
    The storage on disk is the following:
    status_vars_len is part of the post-header,
    status_vars are in the variable-length part, after the post-header, before
    the db & query.
    status_vars on disk is a sequence of pairs (code, value) where 'code' means
757 758
    'sql_mode', 'affected' etc. Sometimes 'value' must be a short string, so
    its first byte is its length. For now the order of status vars is:
759
    flags2 - sql_mode - catalog - autoinc - charset
760 761 762 763 764 765 766 767
    We should add the same thing to Load_log_event, but in fact
    LOAD DATA INFILE is going to be logged with a new type of event (logging of
    the plain text query), so Load_log_event would be frozen, so no need. The
    new way of logging LOAD DATA INFILE would use a derived class of
    Query_log_event, so automatically benefit from the work already done for
    status variables in Query_log_event.
 */
  uint16 status_vars_len;
unknown's avatar
unknown committed
768

769 770 771 772 773 774 775 776 777
  /*
    'flags2' is a second set of flags (on top of those in Log_event), for
    session variables. These are thd->options which is & against a mask
    (OPTIONS_WRITTEN_TO_BINLOG).
    flags2_inited helps make a difference between flags2==0 (3.23 or 4.x
    master, we don't know flags2, so use the slave server's global options) and
    flags2==0 (5.0 master, we know this has a meaning of flags all down which
    must influence the query).
  */
unknown's avatar
unknown committed
778
  bool flags2_inited;
779
  bool sql_mode_inited;
780
  bool charset_inited;
unknown's avatar
unknown committed
781 782

  uint32 flags2;
783
  /* In connections sql_mode is 32 bits now but will be 64 bits soon */
unknown's avatar
unknown committed
784
  ulong sql_mode;
785
  ulong auto_increment_increment, auto_increment_offset;
786
  char charset[6];
787 788
  uint time_zone_len; /* 0 means uninited */
  const char *time_zone_str;
unknown's avatar
unknown committed
789

790
#ifndef MYSQL_CLIENT
791

792
  Query_log_event(THD* thd_arg, const char* query_arg, ulong query_length,
793
		  bool using_trans, bool suppress_use);
794
  const char* get_db() { return db; }
unknown's avatar
SCRUM  
unknown committed
795
#ifdef HAVE_REPLICATION
796
  void pack_info(Protocol* protocol);
797
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
unknown committed
798 799
  int exec_event(struct st_relay_log_info* rli, const char *query_arg,
                 uint32 q_len_arg);
unknown's avatar
SCRUM  
unknown committed
800
#endif /* HAVE_REPLICATION */
801
#else
unknown's avatar
unknown committed
802 803
  void print_query_header(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
804 805
#endif

806
  Query_log_event();
807
  Query_log_event(const char* buf, uint event_len,
unknown's avatar
unknown committed
808 809
                  const Format_description_log_event *description_event,
                  Log_event_type event_type);
unknown's avatar
unknown committed
810 811 812
  ~Query_log_event()
  {
    if (data_buf)
813
      my_free((gptr) data_buf, MYF(0));
unknown's avatar
unknown committed
814 815
  }
  Log_event_type get_type_code() { return QUERY_EVENT; }
816
#ifndef MYSQL_CLIENT
817
  bool write(IO_CACHE* file);
818 819
  virtual bool write_post_header_for_derived(IO_CACHE* file) { return FALSE; }
#endif
unknown's avatar
unknown committed
820
  bool is_valid() const { return query != 0; }
unknown's avatar
unknown committed
821 822 823 824 825 826 827

  /*
    Returns number of bytes additionaly written to post header by derived
    events (so far it is only Execute_load_query event).
  */
  virtual ulong get_post_header_size_for_derived() { return 0; }
  /* Writes derived event-specific part of post header. */
unknown's avatar
unknown committed
828 829
};

830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

/*****************************************************************************

  Muted Query Log Event class

  Pretends to Log SQL queries, but doesn't actually do so.

 ****************************************************************************/
class Muted_query_log_event: public Query_log_event
{
public:
#ifndef MYSQL_CLIENT
  Muted_query_log_event();

  bool write(IO_CACHE* file) { return(false); };
  virtual bool write_post_header_for_derived(IO_CACHE* file) { return FALSE; }
#endif
};


unknown's avatar
SCRUM  
unknown committed
850
#ifdef HAVE_REPLICATION
851

852 853 854
/*****************************************************************************

  Slave Log Event class
855 856
  Note that this class is currently not used at all; no code writes a
  Slave_log_event (though some code in repl_failsafe.cc reads Slave_log_event).
857
  So it's not a problem if this code is not maintained.
858 859

 ****************************************************************************/
860 861 862 863 864 865
class Slave_log_event: public Log_event
{
protected:
  char* mem_pool;
  void init_from_mem_pool(int data_size);
public:
unknown's avatar
unknown committed
866
  my_off_t master_pos;
867 868
  char* master_host;
  char* master_log;
unknown's avatar
unknown committed
869
  int master_host_len;
870
  int master_log_len;
unknown's avatar
unknown committed
871
  uint16 master_port;
872

unknown's avatar
unknown committed
873
#ifndef MYSQL_CLIENT
874
  Slave_log_event(THD* thd_arg, struct st_relay_log_info* rli);
875
  void pack_info(Protocol* protocol);
876
  int exec_event(struct st_relay_log_info* rli);
877
#else
unknown's avatar
unknown committed
878
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
879
#endif
880

881
  Slave_log_event(const char* buf, uint event_len);
882 883
  ~Slave_log_event();
  int get_data_size();
unknown's avatar
unknown committed
884
  bool is_valid() const { return master_host != 0; }
885
  Log_event_type get_type_code() { return SLAVE_EVENT; }
886
#ifndef MYSQL_CLIENT
887
  bool write(IO_CACHE* file);
888
#endif
889 890
};

unknown's avatar
SCRUM  
unknown committed
891
#endif /* HAVE_REPLICATION */
892

893 894 895 896 897 898

/*****************************************************************************

  Load Log Event class

 ****************************************************************************/
unknown's avatar
unknown committed
899 900
class Load_log_event: public Log_event
{
unknown's avatar
unknown committed
901 902 903 904
private:
  uint get_query_buffer_length();
  void print_query(bool need_db, char *buf, char **end,
                   char **fn_start, char **fn_end);
unknown's avatar
unknown committed
905
protected:
unknown's avatar
unknown committed
906
  int copy_log_event(const char *buf, ulong event_len,
907
                     int body_offset, const Format_description_log_event* description_event);
908

unknown's avatar
unknown committed
909
public:
910
  ulong thread_id;
unknown's avatar
unknown committed
911
  ulong slave_proxy_id;
unknown's avatar
unknown committed
912
  uint32 table_name_len;
913 914 915 916 917
  /*
    No need to have a catalog, as these events can only come from 4.x.
    TODO: this may become false if Dmitri pushes his new LOAD DATA INFILE in
    5.0 only (not in 4.x).
  */
unknown's avatar
unknown committed
918 919 920
  uint32 db_len;
  uint32 fname_len;
  uint32 num_fields;
unknown's avatar
unknown committed
921 922
  const char* fields;
  const uchar* field_lens;
unknown's avatar
unknown committed
923
  uint32 field_block_len;
unknown's avatar
unknown committed
924 925 926 927

  const char* table_name;
  const char* db;
  const char* fname;
unknown's avatar
unknown committed
928
  uint32 skip_lines;
unknown's avatar
unknown committed
929
  sql_ex_info sql_ex;
930
  bool local_fname;
931

932 933
  /* fname doesn't point to memory inside Log_event::temp_buf  */
  void set_fname_outside_temp_buf(const char *afname, uint alen)
unknown's avatar
unknown committed
934 935 936
  {
    fname= afname;
    fname_len= alen;
unknown's avatar
unknown committed
937
    local_fname= TRUE;
unknown's avatar
unknown committed
938
  }
939 940
  /* fname doesn't point to memory inside Log_event::temp_buf  */
  int  check_fname_outside_temp_buf()
unknown's avatar
unknown committed
941
  {
942
    return local_fname;
unknown's avatar
unknown committed
943
  }
944

945
#ifndef MYSQL_CLIENT
unknown's avatar
unknown committed
946 947
  String field_lens_buf;
  String fields_buf;
unknown's avatar
unknown committed
948

949
  Load_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
950
		 const char* table_name_arg,
951
		 List<Item>& fields_arg, enum enum_duplicates handle_dup, bool ignore,
952
		 bool using_trans);
953 954
  void set_fields(const char* db, List<Item> &fields_arg,
                  Name_resolution_context *context);
955
  const char* get_db() { return db; }
unknown's avatar
SCRUM  
unknown committed
956
#ifdef HAVE_REPLICATION
unknown's avatar
unknown committed
957
  void pack_info(Protocol* protocol);
958
  int exec_event(struct st_relay_log_info* rli)
959
  {
960
    return exec_event(thd->slave_net,rli,0);
961
  }
unknown's avatar
unknown committed
962
  int exec_event(NET* net, struct st_relay_log_info* rli,
963
		 bool use_rli_only_for_errors);
unknown's avatar
SCRUM  
unknown committed
964
#endif /* HAVE_REPLICATION */
965
#else
unknown's avatar
unknown committed
966 967
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info = 0);
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info, bool commented);
unknown's avatar
unknown committed
968 969
#endif

970 971 972 973 974 975 976
  /*
    Note that for all the events related to LOAD DATA (Load_log_event,
    Create_file/Append/Exec/Delete, we pass description_event; however as
    logging of LOAD DATA is going to be changed in 4.1 or 5.0, this is only used
    for the common_header_len (post_header_len will not be changed).
  */
  Load_log_event(const char* buf, uint event_len,
unknown's avatar
unknown committed
977
                 const Format_description_log_event* description_event);
unknown's avatar
unknown committed
978
  ~Load_log_event()
979
  {}
980 981 982 983
  Log_event_type get_type_code()
  {
    return sql_ex.new_format() ? NEW_LOAD_EVENT: LOAD_EVENT;
  }
984
#ifndef MYSQL_CLIENT
985 986
  bool write_data_header(IO_CACHE* file);
  bool write_data_body(IO_CACHE* file);
987
#endif
unknown's avatar
unknown committed
988
  bool is_valid() const { return table_name != 0; }
unknown's avatar
unknown committed
989 990
  int get_data_size()
  {
991 992
    return (table_name_len + db_len + 2 + fname_len
	    + LOAD_HEADER_LEN
993
	    + sql_ex.data_size() + field_block_len + num_fields);
unknown's avatar
unknown committed
994 995 996
  }
};

unknown's avatar
unknown committed
997
extern char server_version[SERVER_VERSION_LENGTH];
unknown's avatar
unknown committed
998

999 1000
/*****************************************************************************

1001
  Start Log Event_v3 class
1002

1003 1004 1005 1006 1007 1008 1009
  Start_log_event_v3 is the Start_log_event of binlog format 3 (MySQL 3.23 and
  4.x).
  Format_description_log_event derives from Start_log_event_v3; it is the
  Start_log_event of binlog format 4 (MySQL 5.0), that is, the event that
  describes the other events' header/postheader lengths. This event is sent by
  MySQL 5.0 whenever it starts sending a new binlog if the requested position
  is >4 (otherwise if ==4 the event will be sent naturally).
unknown's avatar
unknown committed
1010

1011
 ****************************************************************************/
1012

1013
class Start_log_event_v3: public Log_event
unknown's avatar
unknown committed
1014 1015
{
public:
unknown's avatar
unknown committed
1016
  /*
1017 1018 1019 1020 1021
    If this event is at the start of the first binary log since server
    startup 'created' should be the timestamp when the event (and the
    binary log) was created.  In the other case (i.e. this event is at
    the start of a binary log created by FLUSH LOGS or automatic
    rotation), 'created' should be 0.  This "trick" is used by MySQL
1022 1023
    >=4.0.14 slaves to know whether they must drop stale temporary
    tables and whether they should abort unfinished transaction.
1024 1025 1026 1027 1028 1029 1030 1031

    Note that when 'created'!=0, it is always equal to the event's
    timestamp; indeed Start_log_event is written only in log.cc where
    the first constructor below is called, in which 'created' is set
    to 'when'.  So in fact 'created' is a useless variable. When it is
    0 we can read the actual value from timestamp ('when') and when it
    is non-zero we can read the same value from timestamp
    ('when'). Conclusion:
1032 1033 1034 1035 1036
     - we use timestamp to print when the binlog was created.
     - we use 'created' only to know if this is a first binlog or not.
     In 3.23.57 we did not pay attention to this identity, so mysqlbinlog in
     3.23.57 does not print 'created the_date' if created was zero. This is now
     fixed.
1037
  */
1038
  time_t created;
1039
  uint16 binlog_version;
1040
  char server_version[ST_SERVER_VER_LEN];
1041 1042 1043 1044 1045 1046
  /*
    artifical_event is 1 in the case where this is a generated event that
    should not case any cleanup actions. We handle this in the log by
    setting log_event == 0 (for now).
  */
  bool artificial_event;
1047 1048

#ifndef MYSQL_CLIENT
1049
  Start_log_event_v3();
unknown's avatar
SCRUM  
unknown committed
1050
#ifdef HAVE_REPLICATION
1051
  void pack_info(Protocol* protocol);
1052
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1053
#endif /* HAVE_REPLICATION */
1054
#else
1055
  Start_log_event_v3() {}
unknown's avatar
unknown committed
1056
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1057
#endif
1058

1059 1060 1061 1062
  Start_log_event_v3(const char* buf,
                     const Format_description_log_event* description_event);
  ~Start_log_event_v3() {}
  Log_event_type get_type_code() { return START_EVENT_V3;}
1063
#ifndef MYSQL_CLIENT
1064
  bool write(IO_CACHE* file);
1065
#endif
unknown's avatar
unknown committed
1066
  bool is_valid() const { return 1; }
1067 1068
  int get_data_size()
  {
1069 1070
    return START_V3_HEADER_LEN; //no variable-sized part
  }
1071
  virtual bool is_artificial_event() { return artificial_event; }
1072 1073
};

1074

unknown's avatar
unknown committed
1075
/*
1076 1077 1078 1079 1080 1081 1082 1083
   For binlog version 4.
   This event is saved by threads which read it, as they need it for future
   use (to decode the ordinary events).
*/

class Format_description_log_event: public Start_log_event_v3
{
public:
unknown's avatar
unknown committed
1084
  /*
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
     The size of the fixed header which _all_ events have
     (for binlogs written by this version, this is equal to
     LOG_EVENT_HEADER_LEN), except FORMAT_DESCRIPTION_EVENT and ROTATE_EVENT
     (those have a header of size LOG_EVENT_MINIMAL_HEADER_LEN).
  */
  uint8 common_header_len;
  uint8 number_of_event_types;
  /* The list of post-headers' lengthes */
  uint8 *post_header_len;

  Format_description_log_event(uint8 binlog_ver, const char* server_ver=0);

#ifndef MYSQL_CLIENT
#ifdef HAVE_REPLICATION
  int exec_event(struct st_relay_log_info* rli);
#endif /* HAVE_REPLICATION */
unknown's avatar
unknown committed
1101 1102
#endif

1103 1104 1105 1106
  Format_description_log_event(const char* buf, uint event_len,
                               const Format_description_log_event* description_event);
  ~Format_description_log_event() { my_free((gptr)post_header_len, MYF(0)); }
  Log_event_type get_type_code() { return FORMAT_DESCRIPTION_EVENT;}
1107
#ifndef MYSQL_CLIENT
1108
  bool write(IO_CACHE* file);
1109
#endif
unknown's avatar
unknown committed
1110
  bool is_valid() const
1111
  {
1112 1113 1114
    return ((common_header_len >= ((binlog_version==1) ? OLD_HEADER_LEN :
                                   LOG_EVENT_MINIMAL_HEADER_LEN)) &&
            (post_header_len != NULL));
1115 1116 1117 1118 1119 1120 1121 1122 1123
  }
  int get_data_size()
  {
    /*
      The vector of post-header lengths is considered as part of the
      post-header, because in a given version it never changes (contrary to the
      query in a Query_log_event).
    */
    return FORMAT_DESCRIPTION_HEADER_LEN;
1124
  }
unknown's avatar
unknown committed
1125 1126
};

1127

1128 1129 1130 1131 1132 1133 1134
/*****************************************************************************

  Intvar Log Event class

  Logs special variables such as auto_increment values

 ****************************************************************************/
1135

unknown's avatar
unknown committed
1136 1137 1138 1139 1140
class Intvar_log_event: public Log_event
{
public:
  ulonglong val;
  uchar type;
1141

unknown's avatar
unknown committed
1142
#ifndef MYSQL_CLIENT
1143
  Intvar_log_event(THD* thd_arg,uchar type_arg, ulonglong val_arg)
1144
    :Log_event(thd_arg,0,0),val(val_arg),type(type_arg)
unknown's avatar
unknown committed
1145
  {}
unknown's avatar
SCRUM  
unknown committed
1146
#ifdef HAVE_REPLICATION
1147
  void pack_info(Protocol* protocol);
1148
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1149
#endif /* HAVE_REPLICATION */
1150
#else
unknown's avatar
unknown committed
1151
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1152
#endif
1153

1154
  Intvar_log_event(const char* buf, const Format_description_log_event* description_event);
unknown's avatar
unknown committed
1155 1156
  ~Intvar_log_event() {}
  Log_event_type get_type_code() { return INTVAR_EVENT;}
unknown's avatar
unknown committed
1157
  const char* get_var_type_name();
1158
  int get_data_size() { return  9; /* sizeof(type) + sizeof(val) */;}
1159
#ifndef MYSQL_CLIENT
1160
  bool write(IO_CACHE* file);
1161
#endif
unknown's avatar
unknown committed
1162
  bool is_valid() const { return 1; }
unknown's avatar
unknown committed
1163 1164
};

1165

unknown's avatar
unknown committed
1166
/*****************************************************************************
1167 1168 1169

  Rand Log Event class

unknown's avatar
unknown committed
1170
  Logs random seed used by the next RAND(), and by PASSWORD() in 4.1.0.
1171 1172 1173
  4.1.1 does not need it (it's repeatable again) so this event needn't be
  written in 4.1.1 for PASSWORD() (but the fact that it is written is just a
  waste, it does not cause bugs).
1174

unknown's avatar
unknown committed
1175
 ****************************************************************************/
1176

unknown's avatar
unknown committed
1177 1178 1179 1180 1181 1182 1183 1184
class Rand_log_event: public Log_event
{
 public:
  ulonglong seed1;
  ulonglong seed2;

#ifndef MYSQL_CLIENT
  Rand_log_event(THD* thd_arg, ulonglong seed1_arg, ulonglong seed2_arg)
1185
    :Log_event(thd_arg,0,0),seed1(seed1_arg),seed2(seed2_arg)
unknown's avatar
unknown committed
1186
  {}
unknown's avatar
SCRUM  
unknown committed
1187
#ifdef HAVE_REPLICATION
1188
  void pack_info(Protocol* protocol);
unknown's avatar
unknown committed
1189
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1190
#endif /* HAVE_REPLICATION */
unknown's avatar
unknown committed
1191
#else
unknown's avatar
unknown committed
1192
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1193 1194
#endif

1195
  Rand_log_event(const char* buf, const Format_description_log_event* description_event);
unknown's avatar
unknown committed
1196 1197
  ~Rand_log_event() {}
  Log_event_type get_type_code() { return RAND_EVENT;}
1198
  int get_data_size() { return 16; /* sizeof(ulonglong) * 2*/ }
1199
#ifndef MYSQL_CLIENT
1200
  bool write(IO_CACHE* file);
1201
#endif
unknown's avatar
unknown committed
1202
  bool is_valid() const { return 1; }
unknown's avatar
unknown committed
1203 1204
};

1205 1206 1207 1208 1209 1210 1211 1212 1213
/*****************************************************************************

  Xid Log Event class

  Logs xid of the transaction-to-be-committed in the 2pc protocol.
  Has no meaning in replication, slaves ignore it.

 ****************************************************************************/
#ifdef MYSQL_CLIENT
1214
typedef ulonglong my_xid; // this line is the same as in handler.h
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
#endif

class Xid_log_event: public Log_event
{
 public:
   my_xid xid;

#ifndef MYSQL_CLIENT
  Xid_log_event(THD* thd_arg, my_xid x): Log_event(thd_arg,0,0), xid(x) {}
#ifdef HAVE_REPLICATION
  void pack_info(Protocol* protocol);
  int exec_event(struct st_relay_log_info* rli);
#endif /* HAVE_REPLICATION */
#else
unknown's avatar
unknown committed
1229
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
1230 1231 1232 1233 1234 1235
#endif

  Xid_log_event(const char* buf, const Format_description_log_event* description_event);
  ~Xid_log_event() {}
  Log_event_type get_type_code() { return XID_EVENT;}
  int get_data_size() { return sizeof(xid); }
1236
#ifndef MYSQL_CLIENT
1237
  bool write(IO_CACHE* file);
1238
#endif
1239 1240
  bool is_valid() const { return 1; }
};
1241

unknown's avatar
unknown committed
1242 1243 1244 1245
/*****************************************************************************

  User var Log Event class

1246 1247 1248
  Every time a query uses the value of a user variable, a User_var_log_event is
  written before the Query_log_event, to set the user variable.

unknown's avatar
unknown committed
1249
 ****************************************************************************/
1250

unknown's avatar
unknown committed
1251 1252 1253 1254 1255 1256 1257 1258 1259
class User_var_log_event: public Log_event
{
public:
  char *name;
  uint name_len;
  char *val;
  ulong val_len;
  Item_result type;
  uint charset_number;
1260
  bool is_null;
unknown's avatar
unknown committed
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
#ifndef MYSQL_CLIENT
  User_var_log_event(THD* thd_arg, char *name_arg, uint name_len_arg,
                     char *val_arg, ulong val_len_arg, Item_result type_arg,
		     uint charset_number_arg)
    :Log_event(), name(name_arg), name_len(name_len_arg), val(val_arg),
    val_len(val_len_arg), type(type_arg), charset_number(charset_number_arg)
    { is_null= !val; }
  void pack_info(Protocol* protocol);
  int exec_event(struct st_relay_log_info* rli);
#else
unknown's avatar
unknown committed
1271
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1272 1273
#endif

1274
  User_var_log_event(const char* buf, const Format_description_log_event* description_event);
unknown's avatar
unknown committed
1275 1276
  ~User_var_log_event() {}
  Log_event_type get_type_code() { return USER_VAR_EVENT;}
1277
#ifndef MYSQL_CLIENT
1278
  bool write(IO_CACHE* file);
1279
#endif
unknown's avatar
unknown committed
1280
  bool is_valid() const { return 1; }
unknown's avatar
unknown committed
1281
};
1282

1283

1284 1285 1286 1287 1288
/*****************************************************************************

  Stop Log Event class

 ****************************************************************************/
unknown's avatar
unknown committed
1289 1290 1291
class Stop_log_event: public Log_event
{
public:
unknown's avatar
unknown committed
1292
#ifndef MYSQL_CLIENT
1293
  Stop_log_event() :Log_event()
unknown's avatar
unknown committed
1294
  {}
1295 1296
  int exec_event(struct st_relay_log_info* rli);
#else
unknown's avatar
unknown committed
1297
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1298
#endif
1299

1300 1301
  Stop_log_event(const char* buf, const Format_description_log_event* description_event):
    Log_event(buf, description_event)
1302
  {}
unknown's avatar
unknown committed
1303 1304
  ~Stop_log_event() {}
  Log_event_type get_type_code() { return STOP_EVENT;}
unknown's avatar
unknown committed
1305
  bool is_valid() const { return 1; }
unknown's avatar
unknown committed
1306 1307
};

1308 1309 1310 1311
/*****************************************************************************

  Rotate Log Event class

1312
  This will be deprecated when we move to using sequence ids.
1313 1314

 ****************************************************************************/
1315

unknown's avatar
unknown committed
1316 1317 1318
class Rotate_log_event: public Log_event
{
public:
1319 1320 1321
  enum {
    DUP_NAME= 2 // if constructor should dup the string argument
  };
unknown's avatar
unknown committed
1322
  const char* new_log_ident;
1323
  ulonglong pos;
unknown's avatar
unknown committed
1324
  uint ident_len;
1325
  uint flags;
unknown's avatar
unknown committed
1326
#ifndef MYSQL_CLIENT
1327
  Rotate_log_event(THD* thd_arg, const char* new_log_ident_arg,
1328 1329
		   uint ident_len_arg,
		   ulonglong pos_arg, uint flags);
unknown's avatar
SCRUM  
unknown committed
1330
#ifdef HAVE_REPLICATION
1331
  void pack_info(Protocol* protocol);
1332
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1333
#endif /* HAVE_REPLICATION */
1334
#else
unknown's avatar
unknown committed
1335
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
1336 1337
#endif

1338 1339
  Rotate_log_event(const char* buf, uint event_len,
                   const Format_description_log_event* description_event);
unknown's avatar
unknown committed
1340 1341
  ~Rotate_log_event()
  {
1342 1343
    if (flags & DUP_NAME)
      my_free((gptr) new_log_ident, MYF(MY_ALLOW_ZERO_PTR));
unknown's avatar
unknown committed
1344 1345
  }
  Log_event_type get_type_code() { return ROTATE_EVENT;}
1346
  int get_data_size() { return  ident_len + ROTATE_HEADER_LEN;}
unknown's avatar
unknown committed
1347
  bool is_valid() const { return new_log_ident != 0; }
1348
#ifndef MYSQL_CLIENT
1349
  bool write(IO_CACHE* file);
1350
#endif
1351 1352
};

1353

1354 1355
/* the classes below are for the new LOAD DATA INFILE logging */

1356 1357 1358
/*****************************************************************************
  Create File Log Event class
 ****************************************************************************/
1359

1360
class Create_file_log_event: public Load_log_event
1361
{
1362
protected:
1363 1364 1365 1366 1367
  /*
    Pretend we are Load event, so we can write out just
    our Load part - used on the slave when writing event out to
    SQL_LOAD-*.info file
  */
unknown's avatar
unknown committed
1368
  bool fake_base;
1369 1370
public:
  char* block;
1371
  const char *event_buf;
1372 1373
  uint block_len;
  uint file_id;
unknown's avatar
unknown committed
1374
  bool inited_from_old;
1375

1376 1377
#ifndef MYSQL_CLIENT
  Create_file_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
1378 1379
			const char* table_name_arg,
			List<Item>& fields_arg,
1380
			enum enum_duplicates handle_dup, bool ignore,
1381 1382
			char* block_arg, uint block_len_arg,
			bool using_trans);
unknown's avatar
SCRUM  
unknown committed
1383
#ifdef HAVE_REPLICATION
1384
  void pack_info(Protocol* protocol);
1385
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1386
#endif /* HAVE_REPLICATION */
1387
#else
unknown's avatar
unknown committed
1388 1389
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info, bool enable_local);
unknown's avatar
unknown committed
1390 1391
#endif

1392 1393
  Create_file_log_event(const char* buf, uint event_len,
                        const Format_description_log_event* description_event);
1394 1395 1396 1397
  ~Create_file_log_event()
  {
    my_free((char*) event_buf, MYF(MY_ALLOW_ZERO_PTR));
  }
1398 1399

  Log_event_type get_type_code()
1400
  {
1401 1402 1403 1404 1405 1406 1407 1408
    return fake_base ? Load_log_event::get_type_code() : CREATE_FILE_EVENT;
  }
  int get_data_size()
  {
    return (fake_base ? Load_log_event::get_data_size() :
	    Load_log_event::get_data_size() +
	    4 + 1 + block_len);
  }
unknown's avatar
unknown committed
1409
  bool is_valid() const { return inited_from_old || block != 0; }
1410
#ifndef MYSQL_CLIENT
1411 1412
  bool write_data_header(IO_CACHE* file);
  bool write_data_body(IO_CACHE* file);
1413 1414 1415 1416
  /*
    Cut out Create_file extentions and
    write it as Load event - used on the slave
  */
1417
  bool write_base(IO_CACHE* file);
1418
#endif
1419 1420
};

1421

1422 1423 1424 1425 1426
/*****************************************************************************

  Append Block Log Event class

 ****************************************************************************/
1427

1428 1429 1430 1431 1432 1433
class Append_block_log_event: public Log_event
{
public:
  char* block;
  uint block_len;
  uint file_id;
unknown's avatar
unknown committed
1434
  /*
1435 1436 1437 1438 1439 1440 1441 1442 1443
    'db' is filled when the event is created in mysql_load() (the
    event needs to have a 'db' member to be well filtered by
    binlog-*-db rules). 'db' is not written to the binlog (it's not
    used by Append_block_log_event::write()), so it can't be read in
    the Append_block_log_event(const char* buf, int event_len)
    constructor.  In other words, 'db' is used only for filtering by
    binlog-*-db rules.  Create_file_log_event is different: it's 'db'
    (which is inherited from Load_log_event) is written to the binlog
    and can be re-read.
unknown's avatar
unknown committed
1444 1445 1446
  */
  const char* db;

1447
#ifndef MYSQL_CLIENT
unknown's avatar
unknown committed
1448
  Append_block_log_event(THD* thd, const char* db_arg, char* block_arg,
1449
			 uint block_len_arg, bool using_trans);
unknown's avatar
SCRUM  
unknown committed
1450
#ifdef HAVE_REPLICATION
1451
  int exec_event(struct st_relay_log_info* rli);
1452
  void pack_info(Protocol* protocol);
1453
  virtual int get_create_or_append() const;
unknown's avatar
SCRUM  
unknown committed
1454
#endif /* HAVE_REPLICATION */
1455
#else
unknown's avatar
unknown committed
1456
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
1457
#endif
unknown's avatar
unknown committed
1458 1459

  Append_block_log_event(const char* buf, uint event_len,
1460
                         const Format_description_log_event* description_event);
1461
  ~Append_block_log_event() {}
1462 1463
  Log_event_type get_type_code() { return APPEND_BLOCK_EVENT;}
  int get_data_size() { return  block_len + APPEND_BLOCK_HEADER_LEN ;}
unknown's avatar
unknown committed
1464
  bool is_valid() const { return block != 0; }
1465
#ifndef MYSQL_CLIENT
1466
  bool write(IO_CACHE* file);
1467
#endif
unknown's avatar
unknown committed
1468
  const char* get_db() { return db; }
1469 1470
};

1471

1472
/*****************************************************************************
1473

1474 1475 1476
  Delete File Log Event class

 ****************************************************************************/
1477

1478 1479 1480 1481
class Delete_file_log_event: public Log_event
{
public:
  uint file_id;
unknown's avatar
unknown committed
1482
  const char* db; /* see comment in Append_block_log_event */
unknown's avatar
unknown committed
1483

1484
#ifndef MYSQL_CLIENT
unknown's avatar
unknown committed
1485
  Delete_file_log_event(THD* thd, const char* db_arg, bool using_trans);
unknown's avatar
SCRUM  
unknown committed
1486
#ifdef HAVE_REPLICATION
1487
  void pack_info(Protocol* protocol);
1488
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1489
#endif /* HAVE_REPLICATION */
1490
#else
unknown's avatar
unknown committed
1491 1492
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info, bool enable_local);
unknown's avatar
unknown committed
1493 1494
#endif

1495 1496
  Delete_file_log_event(const char* buf, uint event_len,
                        const Format_description_log_event* description_event);
1497
  ~Delete_file_log_event() {}
1498 1499
  Log_event_type get_type_code() { return DELETE_FILE_EVENT;}
  int get_data_size() { return DELETE_FILE_HEADER_LEN ;}
unknown's avatar
unknown committed
1500
  bool is_valid() const { return file_id != 0; }
1501
#ifndef MYSQL_CLIENT
1502
  bool write(IO_CACHE* file);
1503
#endif
unknown's avatar
unknown committed
1504
  const char* get_db() { return db; }
1505 1506
};

1507

1508 1509 1510 1511 1512
/*****************************************************************************

  Execute Load Log Event class

 ****************************************************************************/
1513

1514 1515 1516 1517
class Execute_load_log_event: public Log_event
{
public:
  uint file_id;
unknown's avatar
unknown committed
1518
  const char* db; /* see comment in Append_block_log_event */
unknown's avatar
unknown committed
1519

1520
#ifndef MYSQL_CLIENT
unknown's avatar
unknown committed
1521
  Execute_load_log_event(THD* thd, const char* db_arg, bool using_trans);
unknown's avatar
SCRUM  
unknown committed
1522
#ifdef HAVE_REPLICATION
1523
  void pack_info(Protocol* protocol);
1524
  int exec_event(struct st_relay_log_info* rli);
unknown's avatar
SCRUM  
unknown committed
1525
#endif /* HAVE_REPLICATION */
1526
#else
unknown's avatar
unknown committed
1527
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1528 1529 1530
#endif

  Execute_load_log_event(const char* buf, uint event_len,
1531
                         const Format_description_log_event* description_event);
1532
  ~Execute_load_log_event() {}
1533 1534
  Log_event_type get_type_code() { return EXEC_LOAD_EVENT;}
  int get_data_size() { return  EXEC_LOAD_HEADER_LEN ;}
unknown's avatar
unknown committed
1535
  bool is_valid() const { return file_id != 0; }
1536
#ifndef MYSQL_CLIENT
1537
  bool write(IO_CACHE* file);
1538
#endif
unknown's avatar
unknown committed
1539
  const char* get_db() { return db; }
unknown's avatar
unknown committed
1540 1541
};

1542

unknown's avatar
unknown committed
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
/***************************************************************************

  Begin load query Log Event class

  Event for the first block of file to be loaded, its only difference from
  Append_block event is that this event creates or truncates existing file
  before writing data.

****************************************************************************/
class Begin_load_query_log_event: public Append_block_log_event
{
public:
#ifndef MYSQL_CLIENT
  Begin_load_query_log_event(THD* thd_arg, const char *db_arg,
                             char* block_arg, uint block_len_arg,
                             bool using_trans);
#ifdef HAVE_REPLICATION
  Begin_load_query_log_event(THD* thd);
1561
  int get_create_or_append() const;
unknown's avatar
unknown committed
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
#endif /* HAVE_REPLICATION */
#endif
  Begin_load_query_log_event(const char* buf, uint event_len,
                             const Format_description_log_event* description_event);
  ~Begin_load_query_log_event() {}
  Log_event_type get_type_code() { return BEGIN_LOAD_QUERY_EVENT; }
};


/*
  Elements of this enum describe how LOAD DATA handles duplicates.
*/
enum enum_load_dup_handling { LOAD_DUP_ERROR= 0, LOAD_DUP_IGNORE,
                              LOAD_DUP_REPLACE };

/****************************************************************************

  Execute load query Log Event class

  Event responsible for LOAD DATA execution, it similar to Query_log_event
  but before executing the query it substitutes original filename in LOAD DATA
  query with name of temporary file.

****************************************************************************/
class Execute_load_query_log_event: public Query_log_event
{
public:
  uint file_id;       // file_id of temporary file
  uint fn_pos_start;  // pointer to the part of the query that should
                      // be substituted
  uint fn_pos_end;    // pointer to the end of this part of query
  /*
    We have to store type of duplicate handling explicitly, because
    for LOAD DATA it also depends on LOCAL option. And this part
    of query will be rewritten during replication so this information
    may be lost...
  */
  enum_load_dup_handling dup_handling;

#ifndef MYSQL_CLIENT
  Execute_load_query_log_event(THD* thd, const char* query_arg,
                       ulong query_length, uint fn_pos_start_arg,
                       uint fn_pos_end_arg,
                       enum_load_dup_handling dup_handling_arg,
                       bool using_trans, bool suppress_use);
#ifdef HAVE_REPLICATION
  void pack_info(Protocol* protocol);
  int exec_event(struct st_relay_log_info* rli);
#endif /* HAVE_REPLICATION */
#else
unknown's avatar
unknown committed
1612
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
unknown's avatar
unknown committed
1613
  /* Prints the query as LOAD DATA LOCAL and with rewritten filename */
unknown's avatar
unknown committed
1614
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
unknown's avatar
unknown committed
1615
	     const char *local_fname);
unknown's avatar
unknown committed
1616 1617 1618 1619 1620 1621 1622 1623 1624
#endif
  Execute_load_query_log_event(const char* buf, uint event_len,
                               const Format_description_log_event *description_event);
  ~Execute_load_query_log_event() {}

  Log_event_type get_type_code() { return EXECUTE_LOAD_QUERY_EVENT; }
  bool is_valid() const { return Query_log_event::is_valid() && file_id != 0; }

  ulong get_post_header_size_for_derived();
1625
#ifndef MYSQL_CLIENT
unknown's avatar
unknown committed
1626
  bool write_post_header_for_derived(IO_CACHE* file);
1627
#endif
unknown's avatar
unknown committed
1628 1629 1630
 };


1631 1632 1633 1634
#ifdef MYSQL_CLIENT
class Unknown_log_event: public Log_event
{
public:
1635 1636 1637 1638 1639 1640 1641
  /*
    Even if this is an unknown event, we still pass description_event to
    Log_event's ctor, this way we can extract maximum information from the
    event's header (the unique ID for example).
  */
  Unknown_log_event(const char* buf, const Format_description_log_event* description_event):
    Log_event(buf, description_event)
1642 1643
  {}
  ~Unknown_log_event() {}
unknown's avatar
unknown committed
1644
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info= 0);
1645
  Log_event_type get_type_code() { return UNKNOWN_EVENT;}
unknown's avatar
unknown committed
1646
  bool is_valid() const { return 1; }
1647
};
unknown's avatar
unknown committed
1648
#endif
1649
char *str_to_hex(char *to, const char *from, uint len);
1650
#endif /* _log_event_h */