log_event.h 115 KB
Newer Older
1
/* Copyright (C) 2000-2006 MySQL AB
2

bk@work.mysql.com's avatar
bk@work.mysql.com committed
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.
6

bk@work.mysql.com's avatar
bk@work.mysql.com committed
7 8 9 10
   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.
11

bk@work.mysql.com's avatar
bk@work.mysql.com committed
12 13 14 15
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

16 17 18 19 20
/**
  @addtogroup Replication
  @{

  @file
21 22 23 24
  
  @brief Binary log event definitions.  This includes generic code
  common to all types of log events, as well as specific code for each
  type of log event.
25 26
*/

bk@work.mysql.com's avatar
bk@work.mysql.com committed
27

28 29
#ifndef _log_event_h
#define _log_event_h
bk@work.mysql.com's avatar
bk@work.mysql.com committed
30

31
#if defined(USE_PRAGMA_INTERFACE) && !defined(MYSQL_CLIENT)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
32 33 34
#pragma interface			/* gcc class implementation */
#endif

35
#include <my_bitmap.h>
36
#include "rpl_constants.h"
37 38 39 40 41 42 43 44

#ifdef MYSQL_CLIENT
#include "rpl_utility.h"
#include "hash.h"
#include "rpl_tblmap.h"
#include "rpl_tblmap.cc"
#endif

45 46 47 48
#ifndef MYSQL_CLIENT
#include "rpl_record.h"
#include "rpl_reporting.h"
#endif
49

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/**
   Either assert or return an error.

   In debug build, the condition will be checked, but in non-debug
   builds, the error code given will be returned instead.

   @param COND   Condition to check
   @param ERRNO  Error number to return in non-debug builds
*/
#ifdef DBUG_OFF
#define ASSERT_OR_RETURN_ERROR(COND, ERRNO) \
  do { if (!(COND)) return ERRNO; } while (0)
#else
#define ASSERT_OR_RETURN_ERROR(COND, ERRNO) \
  DBUG_ASSERT(COND)
#endif

bk@work.mysql.com's avatar
bk@work.mysql.com committed
67 68 69 70
#define LOG_READ_EOF    -1
#define LOG_READ_BOGUS  -2
#define LOG_READ_IO     -3
#define LOG_READ_MEM    -5
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
71
#define LOG_READ_TRUNC  -6
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
72
#define LOG_READ_TOO_LARGE -7
bk@work.mysql.com's avatar
bk@work.mysql.com committed
73 74

#define LOG_EVENT_OFFSET 4
75 76

/*
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
   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 ?
99

100 101
   - Query and Load (Create or Execute) events may have a more precise
     timestamp (with microseconds), number of matched/affected/warnings rows
102 103
   and fields of session variables: SQL_MODE,
   FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, SQL_AUTO_IS_NULL, the collations and
104
   charsets, the PASSWORD() version (old/new/...).
105 106
*/
#define BINLOG_VERSION    4
107

108 109 110
/*
 We could have used SERVER_VERSION_LENGTH, but this introduces an
 obscure dependency - if somebody decided to change SERVER_VERSION_LENGTH
111
 this would break the replication protocol
112 113 114
*/
#define ST_SERVER_VER_LEN 50

115 116 117 118 119
/*
  These are flags and structs to handle all the LOAD DATA INFILE options (LINES
  TERMINATED etc).
*/

120 121 122 123 124 125
/*
  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).
*/
126 127 128 129
#define DUMPFILE_FLAG		0x1
#define OPT_ENCLOSED_FLAG	0x2
#define REPLACE_FLAG		0x4
#define IGNORE_FLAG		0x8
130

131 132 133 134 135
#define FIELD_TERM_EMPTY	0x1
#define ENCLOSED_EMPTY		0x2
#define LINE_TERM_EMPTY		0x4
#define LINE_START_EMPTY	0x8
#define ESCAPED_EMPTY		0x10
136

137 138 139 140 141
/*****************************************************************************

  old_sql_ex struct

 ****************************************************************************/
142
struct old_sql_ex
143 144 145 146 147 148 149 150 151
{
  char field_term;
  char enclosed;
  char line_term;
  char line_start;
  char escaped;
  char opt_flags;
  char empty_flags;
};
152

153 154
#define NUM_LOAD_DELIM_STRS 5

155 156 157 158 159
/*****************************************************************************

  sql_ex_info struct

 ****************************************************************************/
160
struct sql_ex_info
161
{
162
  sql_ex_info() {}                            /* Remove gcc warning */
163 164 165 166 167
  const char* field_term;
  const char* enclosed;
  const char* line_term;
  const char* line_start;
  const char* escaped;
168 169
  int cached_new_format;
  uint8 field_term_len,enclosed_len,line_term_len,line_start_len, escaped_len;
170
  char opt_flags;
171
  char empty_flags;
172

173
  // store in new format even if old is possible
174
  void force_new_format() { cached_new_format = 1;}
175 176 177 178 179 180
  int data_size()
  {
    return (new_format() ?
	    field_term_len + enclosed_len + line_term_len +
	    line_start_len + escaped_len + 6 : 7);
  }
181
  bool write_data(IO_CACHE* file);
182
  const char* init(const char* buf, const char* buf_end, bool use_new_format);
183 184 185 186 187 188 189 190 191
  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)));
  }
};
192

193 194 195 196 197 198 199 200 201 202 203 204
/*****************************************************************************

  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.

205 206 207 208 209 210
  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).
211

212
 ****************************************************************************/
213

214 215
#define LOG_EVENT_HEADER_LEN 19     /* the fixed header length */
#define OLD_HEADER_LEN       13     /* the fixed header length in 3.23 */
216
/*
217 218 219 220 221 222
   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.
*/
223 224
#define LOG_EVENT_MINIMAL_HEADER_LEN 19

225
/* event-specific post-header sizes */
226 227 228
// 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.
229
#define QUERY_HEADER_LEN     (QUERY_HEADER_MINIMAL_LEN + 2)
230
#define LOAD_HEADER_LEN      (4 + 4 + 4 + 1 +1 + 4)
231 232
#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)
233 234 235 236
#define CREATE_FILE_HEADER_LEN 4
#define APPEND_BLOCK_HEADER_LEN 4
#define EXEC_LOAD_HEADER_LEN   4
#define DELETE_FILE_HEADER_LEN 4
237
#define FORMAT_DESCRIPTION_HEADER_LEN (START_V3_HEADER_LEN+1+LOG_EVENT_TYPES)
238 239
#define ROWS_HEADER_LEN        8
#define TABLE_MAP_HEADER_LEN   8
240 241
#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)
242
#define INCIDENT_HEADER_LEN    2
243 244
/* 
  Max number of possible extra bytes in a replication event compared to a
245 246
  packet (i.e. a query) sent from client to master;
  First, an auxiliary log_event status vars estimation:
247
*/
248 249 250 251 252 253 254 255 256 257 258 259
#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)
260

261 262 263 264
/* 
   Event header offsets; 
   these point to places inside the fixed header.
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
265

266
#define EVENT_TYPE_OFFSET    4
267 268
#define SERVER_ID_OFFSET     5
#define EVENT_LEN_OFFSET     9
269
#define LOG_POS_OFFSET       13
270 271
#define FLAGS_OFFSET         17

272
/* start event post-header (for v3 and v4) */
273 274 275 276

#define ST_BINLOG_VER_OFFSET  0
#define ST_SERVER_VER_OFFSET  2
#define ST_CREATED_OFFSET     (ST_SERVER_VER_OFFSET + ST_SERVER_VER_LEN)
277
#define ST_COMMON_HEADER_LEN_OFFSET (ST_CREATED_OFFSET + 4)
278

279
/* slave event post-header (this event is never written) */
280

281 282 283
#define SL_MASTER_PORT_OFFSET   8
#define SL_MASTER_POS_OFFSET    0
#define SL_MASTER_HOST_OFFSET   10
284 285 286

/* query event post-header */

287 288 289 290
#define Q_THREAD_ID_OFFSET	0
#define Q_EXEC_TIME_OFFSET	4
#define Q_DB_LEN_OFFSET		8
#define Q_ERR_CODE_OFFSET	9
291
#define Q_STATUS_VARS_LEN_OFFSET 11
292
#define Q_DATA_OFFSET		QUERY_HEADER_LEN
293 294 295
/* these are codes, not offsets; not more than 256 values (1 byte). */
#define Q_FLAGS2_CODE           0
#define Q_SQL_MODE_CODE         1
296 297
/*
  Q_CATALOG_CODE is catalog with end zero stored; it is used only by MySQL
298 299
  5.0.x where 0<=x<=3. We have to keep it to be able to replicate these
  old masters.
300
*/
301
#define Q_CATALOG_CODE          2
302
#define Q_AUTO_INCREMENT	3
303
#define Q_CHARSET_CODE          4
304
#define Q_TIME_ZONE_CODE        5
305 306 307 308 309 310 311 312
/*
  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
313

314 315
#define Q_LC_TIME_NAMES_CODE    7

316
#define Q_CHARSET_DATABASE_CODE 8
317 318 319 320 321
/* Intvar event post-header */

#define I_TYPE_OFFSET        0
#define I_VAL_OFFSET         1

nick@mysql.com's avatar
nick@mysql.com committed
322 323 324 325 326
/* Rand event post-header */

#define RAND_SEED1_OFFSET 0
#define RAND_SEED2_OFFSET 8

327 328 329 330 331 332 333 334
/* 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

335 336 337 338 339
/* Load event post-header */

#define L_THREAD_ID_OFFSET   0
#define L_EXEC_TIME_OFFSET   4
#define L_SKIP_LINES_OFFSET  8
340 341
#define L_TBL_LEN_OFFSET     12
#define L_DB_LEN_OFFSET      13
342
#define L_NUM_FIELDS_OFFSET  14
343
#define L_SQL_EX_OFFSET      18
344
#define L_DATA_OFFSET        LOAD_HEADER_LEN
345

346 347 348 349
/* Rotate event post-header */

#define R_POS_OFFSET       0
#define R_IDENT_OFFSET     8
350

351 352 353
/* CF to DF handle LOAD DATA INFILE */

/* CF = "Create File" */
354 355 356
#define CF_FILE_ID_OFFSET  0
#define CF_DATA_OFFSET     CREATE_FILE_HEADER_LEN

357
/* AB = "Append Block" */
358 359 360
#define AB_FILE_ID_OFFSET  0
#define AB_DATA_OFFSET     APPEND_BLOCK_HEADER_LEN

361
/* EL = "Execute Load" */
362 363
#define EL_FILE_ID_OFFSET  0

364
/* DF = "Delete File" */
365
#define DF_FILE_ID_OFFSET  0
366

367 368 369 370 371 372 373 374
/* TM = "Table Map" */
#define TM_MAPID_OFFSET    0
#define TM_FLAGS_OFFSET    6

/* RW = "RoWs" */
#define RW_MAPID_OFFSET    0
#define RW_FLAGS_OFFSET    6

375 376 377 378 379 380
/* 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

381
/* 4 bytes which all binlogs should begin with */
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
382
#define BINLOG_MAGIC        "\xfe\x62\x69\x6e"
383

384 385 386 387 388 389 390 391
/*
  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
392
  replacing flag when reading a Rotate event.
393 394 395
  I keep the defines here just to remember what they were.
*/
#ifdef TO_BE_REMOVED
396
#define LOG_EVENT_TIME_F            0x1
397
#define LOG_EVENT_FORCED_ROTATE_F   0x2
398
#endif
399 400

/*
401 402 403 404 405 406 407 408
   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).

409 410 411 412 413 414 415 416
   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.
417 418 419

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

422 423
#define LOG_EVENT_BINLOG_IN_USE_F       0x1

424 425 426 427 428 429 430
/**
  @def LOG_EVENT_THREAD_SPECIFIC_F

  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).
431
*/
432
#define LOG_EVENT_THREAD_SPECIFIC_F 0x4
433

434 435 436
/**
  @def LOG_EVENT_SUPPRESS_USE_F

437 438 439 440 441 442 443 444 445 446 447 448
  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

449 450 451 452 453 454
/*
  The table map version internal to the log should be increased after
  the event has been written to the binary log.
 */
#define LOG_EVENT_UPDATE_TABLE_MAP_VERSION_F 0x10

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
/**
  @def OPTIONS_WRITTEN_TO_BIN_LOG

  OPTIONS_WRITTEN_TO_BIN_LOG are the bits of thd->options which must
  be written to the binlog. OPTIONS_WRITTEN_TO_BIN_LOG 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.

  I (Guilhem) have read through every option's usage, and it looks
  like 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.
  OPTION_BIG_SELECTS is not needed (the slave thread runs with
  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).
475
*/
476 477 478
#define OPTIONS_WRITTEN_TO_BIN_LOG \
  (OPTION_AUTO_IS_NULL | OPTION_NO_FOREIGN_KEY_CHECKS |  \
   OPTION_RELAXED_UNIQUE_CHECKS | OPTION_NOT_AUTOCOMMIT)
479

480 481 482
/* Shouldn't be defined before */
#define EXPECTED_OPTIONS \
  ((ULL(1) << 14) | (ULL(1) << 26) | (ULL(1) << 27) | (ULL(1) << 19))
483

484
#if OPTIONS_WRITTEN_TO_BIN_LOG != EXPECTED_OPTIONS
serg@serg.mylan's avatar
serg@serg.mylan committed
485 486
#error OPTIONS_WRITTEN_TO_BIN_LOG must NOT change their values!
#endif
487
#undef EXPECTED_OPTIONS         /* You shouldn't use this one */
serg@serg.mylan's avatar
serg@serg.mylan committed
488

489 490 491 492 493
/**
  @enum Log_event_type

  Enumeration type for the different types of log events.
*/
494 495
enum Log_event_type
{
496 497
  /*
    Every time you update this enum (when you add a type), you have to
498
    fix Format_description_log_event::Format_description_log_event().
499
  */
500 501 502 503 504 505 506 507 508 509 510
  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,
511
  DELETE_FILE_EVENT= 11,
512
  /*
513 514 515
    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)
516
  */
517
  NEW_LOAD_EVENT= 12,
518 519 520 521 522 523
  RAND_EVENT= 13,
  USER_VAR_EVENT= 14,
  FORMAT_DESCRIPTION_EVENT= 15,
  XID_EVENT= 16,
  BEGIN_LOAD_QUERY_EVENT= 17,
  EXECUTE_LOAD_QUERY_EVENT= 18,
524

525
  TABLE_MAP_EVENT = 19,
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

  /*
    These event numbers were used for 5.1.0 to 5.1.15 and are
    therefore obsolete.
   */
  PRE_GA_WRITE_ROWS_EVENT = 20,
  PRE_GA_UPDATE_ROWS_EVENT = 21,
  PRE_GA_DELETE_ROWS_EVENT = 22,

  /*
    These event numbers are used from 5.1.16 and forward
   */
  WRITE_ROWS_EVENT = 23,
  UPDATE_ROWS_EVENT = 24,
  DELETE_ROWS_EVENT = 25,
541

542 543 544
  /*
    Something out of the ordinary happened on the master
   */
mats@romeo.(none)'s avatar
mats@romeo.(none) committed
545
  INCIDENT_EVENT= 26,
546

547
  /*
548
    Add new events here - right above this comment!
549
    Existing events (except ENUM_END_EVENT) should never change their numbers
550 551
  */

552
  ENUM_END_EVENT /* end marker */
553 554
};

555
/*
556 557 558 559 560 561
   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)

562 563 564 565 566
enum Int_event_type
{
  INVALID_INT_EVENT = 0, LAST_INSERT_ID_EVENT = 1, INSERT_ID_EVENT = 2
};

bk@work.mysql.com's avatar
bk@work.mysql.com committed
567 568 569

#ifndef MYSQL_CLIENT
class String;
570
class MYSQL_BIN_LOG;
571
class THD;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
572 573
#endif

574
class Format_description_log_event;
575
class Relay_log_info;
576

577
#ifdef MYSQL_CLIENT
578 579 580 581 582
enum enum_base64_output_mode {
  BASE64_OUTPUT_NEVER= 0,
  BASE64_OUTPUT_AUTO= 1,
  BASE64_OUTPUT_ALWAYS= 2,
  BASE64_OUTPUT_UNSPEC= 3,
583
  BASE64_OUTPUT_DECODE_ROWS= 4,
584 585 586 587
  /* insert new output modes here */
  BASE64_OUTPUT_MODE_COUNT
};

588
/*
lars@mysql.com's avatar
lars@mysql.com committed
589 590
  A structure for mysqlbinlog to know how to print events

591 592 593 594 595 596 597 598
  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.
599
*/
600
typedef struct st_print_event_info
601
{
602 603
  /*
    Settings for database, sql_mode etc that comes from the last event
604 605 606
    that was printed.  We cache these so that we don't have to print
    them if they are unchanged.
  */
607 608 609 610 611
  // 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;
monty@mysql.com's avatar
monty@mysql.com committed
612
  ulong sql_mode;		/* must be same as THD.variables.sql_mode */
613
  ulong auto_increment_increment, auto_increment_offset;
614 615
  bool charset_inited;
  char charset[6]; // 3 variables, each of them storable in 2 bytes
616
  char time_zone_str[MAX_TIME_ZONE_NAME_LENGTH];
617
  uint lc_time_names_number;
618
  uint charset_database_number;
619 620 621 622
  uint thread_id;
  bool thread_id_printed;

  st_print_event_info();
lars@mysql.com's avatar
lars@mysql.com committed
623

624
  ~st_print_event_info() {
625 626
    close_cached_file(&head_cache);
    close_cached_file(&body_cache);
627
  }
628 629
  bool init_ok() /* tells if construction was successful */
    { return my_b_inited(&head_cache) && my_b_inited(&body_cache); }
630 631


lars@mysql.com's avatar
lars@mysql.com committed
632 633
  /* Settings on how to print the events */
  bool short_form;
634 635 636 637 638 639 640 641
  enum_base64_output_mode base64_output_mode;
  /*
    This is set whenever a Format_description_event is printed.
    Later, when an event is printed in base64, this flag is tested: if
    no Format_description_event has been seen, it is unsafe to print
    the base64 event, so an error message is generated.
  */
  bool printed_fd_event;
lars@mysql.com's avatar
lars@mysql.com committed
642 643
  my_off_t hexdump_from;
  uint8 common_header_len;
644
  char delimiter[16];
lars@mysql.com's avatar
lars@mysql.com committed
645

646 647 648 649 650
#ifdef MYSQL_CLIENT
  uint verbose;
  table_mapping m_table_map;
#endif

651 652 653 654 655 656 657
  /*
     These two caches are used by the row-based replication events to
     collect the header information and the main body of the events
     making up a statement.
   */
  IO_CACHE head_cache;
  IO_CACHE body_cache;
658
} PRINT_EVENT_INFO;
659 660 661
#endif


662 663
/**
  @class Log_event
664 665

  This is the abstract base class for binary log events.
666 667 668
  
  @section Log_event_binary_format Binary Format

669
  Any @c Log_event saved on disk consists of the following three
670 671
  components.

672 673 674
  - Common-Header
  - Post-Header
  - Body
675

676 677
  The Common-Header, documented in the table @ref Table_common_header
  "below", always has the same form and length within one version of
678 679 680 681 682 683
  MySQL.  Each event type specifies a format and length of the
  Post-Header.  The length of the Common-Header is the same for all
  events of the same type.  The Body may be of different format and
  length even for different events of the same type.  The binary
  formats of Post-Header and Body are documented separately in each
  subclass.  The binary format of Common-Header is as follows.
684 685 686 687 688 689

  <table>
  <caption>Common-Header</caption>

  <tr>
    <th>Name</th>
690
    <th>Format</th>
691 692 693 694 695 696
    <th>Description</th>
  </tr>

  <tr>
    <td>timestamp</td>
    <td>4 byte unsigned integer</td>
697
    <td>The time when the query started, in seconds since 1970.
698 699 700 701 702 703 704 705 706 707
    </td>
  </tr>

  <tr>
    <td>type</td>
    <td>1 byte enumeration</td>
    <td>See enum #Log_event_type.</td>
  </tr>

  <tr>
708 709
    <td>server_id</td>
    <td>4 byte unsigned integer</td>
710 711 712 713 714
    <td>Server ID of the server that created the event.</td>
  </tr>

  <tr>
    <td>total_size</td>
715
    <td>4 byte unsigned integer</td>
716 717 718 719 720 721 722
    <td>The total size of this event, in bytes.  In other words, this
    is the sum of the sizes of Common-Header, Post-Header, and Body.
    </td>
  </tr>

  <tr>
    <td>master_position</td>
723
    <td>4 byte unsigned integer</td>
724
    <td>The position of the next event in the master binary log, in
725 726 727 728
    bytes from the beginning of the file.  In a binlog that is not a
    relay log, this is just the position of the next event, in bytes
    from the beginning of the file.  In a relay log, this is
    the position of the next event in the master's binlog.
729 730 731 732 733 734 735 736 737 738 739 740 741
    </td>
  </tr>

  <tr>
    <td>flags</td>
    <td>2 byte bitfield</td>
    <td>See Log_event::flags.</td>
  </tr>
  </table>

  Summing up the numbers above, we see that the total size of the
  common header is 19 bytes.

742 743 744 745 746 747 748 749 750 751
  @subsection Log_event_format_of_atomic_primitives Format of Atomic Primitives

  - All numbers, whether they are 16-, 24-, 32-, or 64-bit numbers,
  are stored in little endian, i.e., the least significant byte first,
  unless otherwise specified.

  @anchor packed_integer
  - Some events use a special format for efficient representation of
  unsigned integers, called Packed Integer.  A Packed Integer has the
  capacity of storing up to 8-byte integers, while small integers
752 753
  still can use 1, 3, or 4 bytes.  The value of the first byte
  determines how to read the number, according to the following table:
754 755 756 757 758 759 760 761 762 763 764

  <table>
  <caption>Format of Packed Integer</caption>

  <tr>
    <th>First byte</th>
    <th>Format</th>
  </tr>

  <tr>
    <td>0-250</td>
765
    <td>The first byte is the number (in the range 0-250), and no more
766 767 768 769 770 771 772 773
    bytes are used.</td>
  </tr>

  <tr>
    <td>252</td>
    <td>Two more bytes are used.  The number is in the range
    251-0xffff.</td>
  </tr>
774

775 776 777 778 779
  <tr>
    <td>253</td>
    <td>Three more bytes are used.  The number is in the range
    0xffff-0xffffff.</td>
  </tr>
780

781 782 783 784 785 786 787 788 789 790
  <tr>
    <td>254</td>
    <td>Eight more bytes are used.  The number is in the range
    0xffffff-0xffffffffffffffff.</td>
  </tr>

  </table>

  - Strings are stored in various formats.  The format of each string
  is documented separately.
791
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
792 793 794
class Log_event
{
public:
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
  /**
     Enumeration of what kinds of skipping (and non-skipping) that can
     occur when the slave executes an event.

     @see shall_skip
     @see do_shall_skip
   */
  enum enum_skip_reason {
    /**
       Don't skip event.
    */
    EVENT_SKIP_NOT,

    /**
       Skip event by ignoring it.

       This means that the slave skip counter will not be changed.
    */
    EVENT_SKIP_IGNORE,

    /**
       Skip event and decrease skip counter.
    */
    EVENT_SKIP_COUNT
  };


822 823 824 825 826 827 828
  /*
    The following type definition is to be used whenever data is placed 
    and manipulated in a common buffer. Use this typedef for buffers
    that contain data containing binary and character data.
  */
  typedef unsigned char Byte;

829
  /*
830 831 832 833 834 835 836 837
    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.
838
  */
839
  my_off_t log_pos;
840
  /*
841 842 843
     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.
  */
844
  char *temp_buf;
845
  /*
846 847 848 849 850 851
    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).
852
  */
853
  time_t when;
854
  /* The number of seconds the query took to run on the master. */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
855
  ulong exec_time;
856 857 858
  /* Number of bytes written by write() function */
  ulong data_written;

859
  /*
860 861
    The master's server id (is preserved in the relay log; used to
    prevent from infinite loops in circular replication).
862
  */
863
  uint32 server_id;
864

865 866
  /**
    Some 16 flags. See the definitions above for LOG_EVENT_TIME_F,
867 868
    LOG_EVENT_FORCED_ROTATE_F, LOG_EVENT_THREAD_SPECIFIC_F, and
    LOG_EVENT_SUPPRESS_USE_F for notes.
869
  */
870
  uint16 flags;
871

872
  bool cache_stmt;
873

874 875 876 877 878 879
  /**
    A storage to cache the global system variable's value.
    Handling of a separate event will be governed its member.
  */
  ulong slave_exec_mode;

880
#ifndef MYSQL_CLIENT
881
  THD* thd;
882

883
  Log_event();
884
  Log_event(THD* thd_arg, uint16 flags_arg, bool cache_stmt);
885
  /*
886 887 888 889 890 891 892 893 894
    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.
895
  */
896 897
  static Log_event* read_log_event(IO_CACHE* file,
				   pthread_mutex_t* log_lock,
898 899
                                   const Format_description_log_event
                                   *description_event);
900 901
  static int read_log_event(IO_CACHE* file, String* packet,
			    pthread_mutex_t* log_lock);
902
  /*
903 904 905
    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.
906
  */
907
  static void init_show_field_list(List<Item>* field_list);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
908
#ifdef HAVE_REPLICATION
hf@deer.mysql.r18.ru's avatar
hf@deer.mysql.r18.ru committed
909
  int net_send(Protocol *protocol, const char* log_name, my_off_t pos);
910

911 912 913 914
  /*
    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().
  */
915

hf@deer.mysql.r18.ru's avatar
hf@deer.mysql.r18.ru committed
916
  virtual void pack_info(Protocol *protocol);
917

hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
918
#endif /* HAVE_REPLICATION */
919 920 921 922 923
  virtual const char* get_db()
  {
    return thd ? thd->db : 0;
  }
#else
924
  Log_event() : temp_buf(0) {}
925
    /* avoid having to link mysqlbinlog against libpthread */
926
  static Log_event* read_log_event(IO_CACHE* file,
927 928
                                   const Format_description_log_event
                                   *description_event);
929
  /* print*() functions are used by mysqlbinlog */
930
  virtual void print(FILE* file, PRINT_EVENT_INFO* print_event_info) = 0;
931 932 933 934 935
  void print_timestamp(IO_CACHE* file, time_t *ts = 0);
  void print_header(IO_CACHE* file, PRINT_EVENT_INFO* print_event_info,
                    bool is_more);
  void print_base64(IO_CACHE* file, PRINT_EVENT_INFO* print_event_info,
                    bool is_more);
936
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
937

938 939 940 941
  static void *operator new(size_t size)
  {
    return (void*) my_malloc((uint)size, MYF(MY_WME|MY_FAE));
  }
942

943 944
  static void operator delete(void *ptr, size_t size)
  {
945
    my_free((uchar*) ptr, MYF(MY_WME|MY_ALLOW_ZERO_PTR));
946
  }
947

948 949 950 951
  /* Placement version of the above operators */
  static void *operator new(size_t, void* ptr) { return ptr; }
  static void operator delete(void*, void*) { }

952
#ifndef MYSQL_CLIENT
953 954 955 956 957 958 959 960
  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)
961
  { return 0; }
962
  virtual bool write_data_body(IO_CACHE* file __attribute__((unused)))
963
  { return 0; }
964
  inline time_t get_time()
965 966 967
  {
    THD *tmp_thd;
    if (when)
968
      return when;
969 970 971 972 973 974
    if (thd)
      return thd->start_time;
    if ((tmp_thd= current_thd))
      return tmp_thd->start_time;
    return my_time(0);
  }
975
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
976
  virtual Log_event_type get_type_code() = 0;
977
  virtual bool is_valid() const = 0;
978
  virtual bool is_artificial_event() { return 0; }
979
  inline bool get_cache_stmt() const { return cache_stmt; }
980 981
  Log_event(const char* buf, const Format_description_log_event
            *description_event);
982 983 984
  virtual ~Log_event() { free_temp_buf();}
  void register_temp_buf(char* buf) { temp_buf = buf; }
  void free_temp_buf()
985 986
  {
    if (temp_buf)
987
    {
988 989
      my_free(temp_buf, MYF(0));
      temp_buf = 0;
990
    }
991
  }
992 993 994 995
  /*
    Get event length for simple events. For complicated events the length
    is calculated during write()
  */
996
  virtual int get_data_size() { return 0;}
997 998 999
  static Log_event* read_log_event(const char* buf, uint event_len,
				   const char **error,
                                   const Format_description_log_event
1000
                                   *description_event);
1001 1002 1003 1004 1005 1006 1007
  /**
    Returns the human readable name of the given event type.
  */
  static const char* get_type_str(Log_event_type type);
  /**
    Returns the human readable name of this event's type.
  */
1008
  const char* get_type_str();
1009

1010 1011
  /* Return start of query time or current time */

1012
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
public:

  /**
     Apply the event to the database.

     This function represents the public interface for applying an
     event.

     @see do_apply_event
   */
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
1023
  int apply_event(Relay_log_info const *rli)
1024
  {
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
    return do_apply_event(rli);
  }


  /**
     Update the relay log position.

     This function represents the public interface for "stepping over"
     the event and will update the relay log information.

     @see do_update_pos
   */
1037
  int update_pos(Relay_log_info *rli)
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
  {
    return do_update_pos(rli);
  }

  /**
     Decide if the event shall be skipped, and the reason for skipping
     it.

     @see do_shall_skip
   */
1048
  enum_skip_reason shall_skip(Relay_log_info *rli)
1049 1050 1051 1052 1053
  {
    return do_shall_skip(rli);
  }

protected:
1054

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
  /**
     Helper function to ignore an event w.r.t. the slave skip counter.

     This function can be used inside do_shall_skip() for functions
     that cannot end a group. If the slave skip counter is 1 when
     seeing such an event, the event shall be ignored, the counter
     left intact, and processing continue with the next event.

     A typical usage is:
     @code
     enum_skip_reason do_shall_skip(Relay_log_info *rli) {
       return continue_group(rli);
     }
     @endcode

     @return Skip reason
   */
  enum_skip_reason continue_group(Relay_log_info *rli);

1074 1075 1076 1077 1078
  /**
    Primitive to apply an event to the database.

    This is where the change to the database is made.

1079 1080 1081 1082 1083
    @note The primitive is protected instead of private, since there
    is a hierarchy of actions to be performed in some cases.

    @see Format_description_log_event::do_apply_event()

1084 1085 1086 1087 1088
    @param rli Pointer to relay log info structure

    @retval 0     Event applied successfully
    @retval errno Error code if event application failed
  */
1089
  virtual int do_apply_event(Relay_log_info const *rli)
1090 1091 1092 1093
  {
    return 0;                /* Default implementation does nothing */
  }

1094 1095

  /**
1096 1097 1098 1099 1100 1101
     Advance relay log coordinates.

     This function is called to advance the relay log coordinates to
     just after the event.  It is essential that both the relay log
     coordinate and the group log position is updated correctly, since
     this function is used also for skipping events.
1102

1103 1104 1105 1106 1107 1108 1109
     Normally, each implementation of do_update_pos() shall:

     - Update the event position to refer to the position just after
       the event.

     - Update the group log position to refer to the position just
       after the event <em>if the event is last in a group</em>
1110 1111 1112 1113

     @param rli Pointer to relay log info structure

     @retval 0     Coordinates changed successfully
1114 1115 1116
     @retval errno Error code if advancing failed (usually just
                   1). Observe that handler errors are returned by the
                   do_apply_event() function, and not by this one.
1117
   */
1118
  virtual int do_update_pos(Relay_log_info *rli);
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149


  /**
     Decide if this event shall be skipped or not and the reason for
     skipping it.

     The default implementation decide that the event shall be skipped
     if either:

     - the server id of the event is the same as the server id of the
       server and <code>rli->replicate_same_server_id</code> is true,
       or

     - if <code>rli->slave_skip_counter</code> is greater than zero.

     @see do_apply_event
     @see do_update_pos

     @retval Log_event::EVENT_SKIP_NOT
     The event shall not be skipped and should be applied.

     @retval Log_event::EVENT_SKIP_IGNORE
     The event shall be skipped by just ignoring it, i.e., the slave
     skip counter shall not be changed. This happends if, for example,
     the originating server id of the event is the same as the server
     id of the slave.

     @retval Log_event::EVENT_SKIP_COUNT
     The event shall be skipped because the slave skip counter was
     non-zero. The caller shall decrease the counter by one.
   */
1150
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
1151
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1152 1153
};

1154

1155
/*
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
   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.
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1167

1168 1169 1170
/**
  @class Query_log_event
   
1171 1172
  A @c Query_log_event is created for each query that modifies the
  database, unless the query is logged row-based.
1173 1174 1175

  @section Query_log_event_binary_format Binary format

1176 1177 1178 1179
  See @ref Log_event_binary_format "Binary format for log events" for
  a general discussion and introduction to the binary format of binlog
  events.

1180 1181 1182 1183 1184 1185 1186
  The Post-Header has five components:

  <table>
  <caption>Post-Header for Query_log_event</caption>

  <tr>
    <th>Name</th>
1187
    <th>Format</th>
1188 1189 1190 1191 1192 1193
    <th>Description</th>
  </tr>

  <tr>
    <td>slave_proxy_id</td>
    <td>4 byte unsigned integer</td>
1194 1195 1196 1197 1198 1199
    <td>An integer identifying the client thread that issued the
    query.  The id is unique per server.  (Note, however, that two
    threads on different servers may have the same slave_proxy_id.)
    This is used when a client thread creates a temporary table local
    to the client.  The slave_proxy_id is used to distinguish
    temporary tables that belong to different clients.
1200 1201 1202 1203 1204
    </td>
  </tr>

  <tr>
    <td>exec_time</td>
1205 1206 1207
    <td>4 byte unsigned integer</td>
    <td>The time from when the query started to when it was logged in
    the binlog, in seconds.</td>
1208 1209 1210 1211 1212
  </tr>

  <tr>
    <td>db_len</td>
    <td>1 byte integer</td>
1213
    <td>The length of the name of the currently selected database.</td>
1214 1215 1216 1217
  </tr>

  <tr>
    <td>error_code</td>
1218
    <td>2 byte unsigned integer</td>
1219 1220
    <td>Error code generated by the master.  If the master fails, the
    slave will fail with the same error code, except for the error
1221
    codes ER_DB_CREATE_EXISTS == 1007 and ER_DB_DROP_EXISTS == 1008.
1222 1223 1224 1225 1226
    </td>
  </tr>

  <tr>
    <td>status_vars_len</td>
1227
    <td>2 byte unsigned integer</td>
1228
    <td>The length of the status_vars block of the Body, in bytes. See
1229
    @ref query_log_event_status_vars "below".
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
    </td>
  </tr>
  </table>

  The Body has the following components:

  <table>
  <caption>Body for Query_log_event</caption>

  <tr>
    <th>Name</th>
1241
    <th>Format</th>
1242 1243 1244 1245
    <th>Description</th>
  </tr>

  <tr>
1246 1247
    <td>@anchor query_log_event_status_vars status_vars</td>
    <td>status_vars_len bytes</td>
1248 1249 1250
    <td>Zero or more status variables.  Each status variable consists
    of one byte identifying the variable stored, followed by the value
    of the variable.  The possible variables are listed separately in
1251 1252 1253
    the table @ref Table_query_log_event_status_vars "below".  MySQL
    always writes events in the order defined below; however, it is
    capable of reading them in any order.  </td>
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
  </tr>

  <tr>
    <td>db</td>
    <td>db_len+1</td>
    <td>The currently selected database, as a null-terminated string.

    (The trailing zero is redundant since the length is already known;
    it is db_len from Post-Header.)
    </td>
  </tr>

  <tr>
    <td>query</td>
    <td>variable length string without trailing zero, extending to the
    end of the event (determined by the length field of the
    Common-Header)
    </td>
    <td>The SQL query.</td>
  </tr>
  </table>

  The following table lists the status variables that may appear in
  the status_vars field.

1279
  @anchor Table_query_log_event_status_vars
1280 1281 1282 1283 1284
  <table>
  <caption>Status variables for Query_log_event</caption>

  <tr>
    <th>Status variable</th>
1285 1286
    <th>1 byte identifier</th>
    <th>Format</th>
1287 1288 1289 1290 1291 1292 1293
    <th>Description</th>
  </tr>

  <tr>
    <td>flags2</td>
    <td>Q_FLAGS2_CODE == 0</td>
    <td>4 byte bitfield</td>
1294 1295 1296 1297 1298 1299 1300
    <td>The flags in @c thd->options, binary AND-ed with @c
    OPTIONS_WRITTEN_TO_BIN_LOG.  The @c thd->options bitfield contains
    options for "SELECT".  @c OPTIONS_WRITTEN identifies those options
    that need to be written to the binlog (not all do).  Specifically,
    @c OPTIONS_WRITTEN_TO_BIN_LOG equals (@c OPTION_AUTO_IS_NULL | @c
    OPTION_NO_FOREIGN_KEY_CHECKS | @c OPTION_RELAXED_UNIQUE_CHECKS |
    @c OPTION_NOT_AUTOCOMMIT), or 0x0c084000 in hex.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313

    These flags correspond to the SQL variables SQL_AUTO_IS_NULL,
    FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, and AUTOCOMMIT, documented in
    the "SET Syntax" section of the MySQL Manual.

    This field is always written to the binlog in version >= 5.0, and
    never written in version < 5.0.
    </td>
  </tr>

  <tr>
    <td>sql_mode</td>
    <td>Q_SQL_MODE_CODE == 1</td>
1314 1315
    <td>8 byte bitfield</td>
    <td>The @c sql_mode variable.  See the section "SQL Modes" in the
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
    MySQL manual, and see mysql_priv.h for a list of the possible
    flags. Currently (2007-10-04), the following flags are available:
    <pre>
    MODE_REAL_AS_FLOAT==0x1
    MODE_PIPES_AS_CONCAT==0x2
    MODE_ANSI_QUOTES==0x4
    MODE_IGNORE_SPACE==0x8
    MODE_NOT_USED==0x10
    MODE_ONLY_FULL_GROUP_BY==0x20
    MODE_NO_UNSIGNED_SUBTRACTION==0x40
    MODE_NO_DIR_IN_CREATE==0x80
    MODE_POSTGRESQL==0x100
    MODE_ORACLE==0x200
    MODE_MSSQL==0x400
    MODE_DB2==0x800
    MODE_MAXDB==0x1000
    MODE_NO_KEY_OPTIONS==0x2000
    MODE_NO_TABLE_OPTIONS==0x4000
    MODE_NO_FIELD_OPTIONS==0x8000
    MODE_MYSQL323==0x10000
    MODE_MYSQL323==0x20000
    MODE_MYSQL40==0x40000
    MODE_ANSI==0x80000
    MODE_NO_AUTO_VALUE_ON_ZERO==0x100000
    MODE_NO_BACKSLASH_ESCAPES==0x200000
    MODE_STRICT_TRANS_TABLES==0x400000
    MODE_STRICT_ALL_TABLES==0x800000
    MODE_NO_ZERO_IN_DATE==0x1000000
    MODE_NO_ZERO_DATE==0x2000000
    MODE_INVALID_DATES==0x4000000
    MODE_ERROR_FOR_DIVISION_BY_ZERO==0x8000000
    MODE_TRADITIONAL==0x10000000
    MODE_NO_AUTO_CREATE_USER==0x20000000
    MODE_HIGH_NOT_PRECEDENCE==0x40000000
    MODE_PAD_CHAR_TO_FULL_LENGTH==0x80000000
    </pre>
    All these flags are replicated from the server.  However, all
1353 1354 1355 1356
    flags except @c MODE_NO_DIR_IN_CREATE are honored by the slave;
    the slave always preserves its old value of @c
    MODE_NO_DIR_IN_CREATE.  For a rationale, see comment in
    @c Query_log_event::do_apply_event in @c log_event.cc.
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369

    This field is always written to the binlog.
    </td>
  </tr>

  <tr>
    <td>catalog</td>
    <td>Q_CATALOG_NZ_CODE == 6</td>
    <td>Variable-length string: the length in bytes (1 byte) followed
    by the characters (at most 255 bytes)
    </td>
    <td>Stores the client's current catalog.  Every database belongs
    to a catalog, the same way that every table belongs to a
1370
    database.  Currently, there is only one catalog, "std".
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385

    This field is written if the length of the catalog is > 0;
    otherwise it is not written.
    </td>
  </tr>

  <tr>
    <td>auto_increment</td>
    <td>Q_AUTO_INCREMENT == 3</td>
    <td>two 2 byte unsigned integers, totally 2+2=4 bytes</td>

    <td>The two variables auto_increment_increment and
    auto_increment_offset, in that order.  For more information, see
    "System variables" in the MySQL manual.

1386
    This field is written if auto_increment > 1.  Otherwise, it is not
1387 1388 1389 1390 1391 1392 1393
    written.
    </td>
  </tr>

  <tr>
    <td>charset</td>
    <td>Q_CHARSET_CODE == 4</td>
1394
    <td>three 2 byte unsigned integers, totally 2+2+2=6 bytes</td>
1395 1396
    <td>The three variables character_set_client,
    collation_connection, and collation_server, in that order.
1397
    character_set_client is a code identifying the character set and
1398
    collation used by the client to encode the query.
1399
    collation_connection identifies the character set and collation
1400
    that the master converts the query to when it receives it; this is
1401
    useful when comparing literal strings.  collation_server is the
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
    default character set and collation used when a new database is
    created.

    See also "Connection Character Sets and Collations" in the MySQL
    5.1 manual.

    All three variables are codes identifying a (character set,
    collation) pair.  To see which codes map to which pairs, run the
    query "SELECT id, character_set_name, collation_name FROM
    COLLATIONS".

1413
    Cf. Q_CHARSET_DATABASE_CODE below.
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438

    This field is always written.
    </td>
  </tr>

  <tr>
    <td>time_zone</td>
    <td>Q_TIME_ZONE_CODE == 5</td>
    <td>Variable-length string: the length in bytes (1 byte) followed
    by the characters (at most 255 bytes).
    <td>The time_zone of the master.

    See also "System Variables" and "MySQL Server Time Zone Support"
    in the MySQL manual.

    This field is written if the length of the time zone string is >
    0; otherwise, it is not written.
    </td>
  </tr>

  <tr>
    <td>lc_time_names_number</td>
    <td>Q_LC_TIME_NAMES_CODE == 7</td>
    <td>2 byte integer</td>
    <td>A code identifying a table of month and day names.  The
1439
    mapping from codes to languages is defined in @c sql_locale.cc.
1440

1441
    This field is written if it is not 0, i.e., if the locale is not
1442 1443 1444 1445 1446 1447
    en_US.
    </td>
  </tr>

  <tr>
    <td>charset_database_number</td>
1448
    <td>Q_CHARSET_DATABASE_CODE == 8</td>
1449 1450 1451
    <td>2 byte integer</td>

    <td>The value of the collation_database system variable (in the
1452
    source code stored in @c thd->variables.collation_database), which
1453 1454 1455
    holds the code for a (character set, collation) pair as described
    above (see Q_CHARSET_CODE).

1456 1457 1458 1459
    collation_database was used in old versions (???WHEN).  Its value
    was loaded when issuing a "use db" query and could be changed by
    issuing a "SET collation_database=xxx" query.  It used to affect
    the "LOAD DATA INFILE" and "CREATE TABLE" commands.
1460 1461 1462

    In newer versions, "CREATE TABLE" has been changed to take the
    character set from the database of the created table, rather than
1463 1464 1465 1466 1467
    the character set of the current database.  This makes a
    difference when creating a table in another database than the
    current one.  "LOAD DATA INFILE" has not yet changed to do this,
    but there are plans to eventually do it, and to make
    collation_database read-only.
1468 1469 1470 1471 1472 1473 1474 1475

    This field is written if it is not 0.
    </td>
  </tr>
  </table>

  @subsection Query_log_event_notes_on_previous_versions Notes on Previous Versions

1476
  * Status vars were introduced in version 5.0.  To read earlier
1477 1478
  versions correctly, check the length of the Post-Header.

1479
  * The status variable Q_CATALOG_CODE == 2 existed in MySQL 5.0.x,
1480 1481 1482 1483 1484 1485
  where 0<=x<=3.  It was identical to Q_CATALOG_CODE, except that the
  string had a trailing '\0'.  The '\0' was removed in 5.0.4 since it
  was redundant (the string length is stored before the string).  The
  Q_CATALOG_CODE will never be written by a new master, but can still
  be understood by a new slave.

1486
  * See Q_CHARSET_DATABASE_CODE in the table above.
1487

1488
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1489 1490 1491
class Query_log_event: public Log_event
{
protected:
1492
  Log_event::Byte* data_buf;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1493 1494
public:
  const char* query;
1495
  const char* catalog;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1496
  const char* db;
1497 1498 1499 1500 1501 1502
  /*
    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;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
1503
  uint32 db_len;
1504
  uint16 error_code;
1505
  ulong thread_id;
1506
  /*
1507 1508
    For events created by Query_log_event::do_apply_event (and
    Load_log_event::do_apply_event()) we need the *original* thread
1509 1510
    id, to be able to log the event with the original (=master's)
    thread id (fix for BUG#1686).
guilhem@mysql.com's avatar
guilhem@mysql.com committed
1511 1512
  */
  ulong slave_proxy_id;
1513 1514

  /*
1515 1516
    Binlog format 3 and 4 start to differ (as far as class members are
    concerned) from here.
1517
  */
1518

1519
  uint catalog_len;			// <= 255 char; 0 means uninited
1520

1521 1522
  /*
    We want to be able to store a variable number of N-bit status vars:
1523 1524 1525
    (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.
1526 1527 1528 1529 1530
    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
1531 1532
    '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:
1533
    flags2 - sql_mode - catalog - autoinc - charset
1534 1535 1536 1537 1538 1539 1540 1541
    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;
1542

1543 1544 1545
  /*
    '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
1546
    (OPTIONS_WRITTEN_TO_BIN_LOG).
1547 1548 1549 1550 1551
    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).
  */
1552
  bool flags2_inited;
1553
  bool sql_mode_inited;
1554
  bool charset_inited;
1555 1556

  uint32 flags2;
1557
  /* In connections sql_mode is 32 bits now but will be 64 bits soon */
monty@mysql.com's avatar
monty@mysql.com committed
1558
  ulong sql_mode;
1559
  ulong auto_increment_increment, auto_increment_offset;
1560
  char charset[6];
1561 1562
  uint time_zone_len; /* 0 means uninited */
  const char *time_zone_str;
1563
  uint lc_time_names_number; /* 0 means en_US */
1564
  uint charset_database_number;
1565

1566
#ifndef MYSQL_CLIENT
1567

1568
  Query_log_event(THD* thd_arg, const char* query_arg, ulong query_length,
1569 1570
                  bool using_trans, bool suppress_use,
                  THD::killed_state killed_err_arg= THD::KILLED_NO_VALUE);
1571
  const char* get_db() { return db; }
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1572
#ifdef HAVE_REPLICATION
1573
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1574
#endif /* HAVE_REPLICATION */
1575
#else
1576
  void print_query_header(IO_CACHE* file, PRINT_EVENT_INFO* print_event_info);
1577
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1578 1579
#endif

1580
  Query_log_event();
1581
  Query_log_event(const char* buf, uint event_len,
1582 1583
                  const Format_description_log_event *description_event,
                  Log_event_type event_type);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1584 1585 1586
  ~Query_log_event()
  {
    if (data_buf)
1587
      my_free((uchar*) data_buf, MYF(0));
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1588 1589
  }
  Log_event_type get_type_code() { return QUERY_EVENT; }
1590
#ifndef MYSQL_CLIENT
1591
  bool write(IO_CACHE* file);
1592 1593
  virtual bool write_post_header_for_derived(IO_CACHE* file) { return FALSE; }
#endif
1594
  bool is_valid() const { return query != 0; }
1595 1596 1597 1598 1599 1600 1601

  /*
    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. */
1602 1603 1604

public:        /* !!! Public in this patch to allow old usage */
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1605
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
1606 1607
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
1608

1609
  int do_apply_event(Relay_log_info const *rli,
1610 1611 1612
                       const char *query_arg,
                       uint32 q_len_arg);
#endif /* HAVE_REPLICATION */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1613 1614
};

1615

hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1616
#ifdef HAVE_REPLICATION
1617

1618 1619
/**
  @class Slave_log_event
1620

1621
  Note that this class is currently not used at all; no code writes a
1622
  @c Slave_log_event (though some code in @c repl_failsafe.cc reads @c
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
  Slave_log_event).  So it's not a problem if this code is not
  maintained.

  @section Slave_log_event_binary_format Binary Format

  This event type has no Post-Header. The Body has the following
  four components.

  <table>
  <caption>Body for Slave_log_event</caption>

  <tr>
    <th>Name</th>
1636
    <th>Format</th>
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
    <th>Description</th>
  </tr>

  <tr>
    <td>master_pos</td>
    <td>8 byte integer</td>
    <td>???TODO
    </td>
  </tr>

  <tr>
    <td>master_port</td>
    <td>2 byte integer</td>
    <td>???TODO</td>
  </tr>

  <tr>
    <td>master_host</td>
    <td>null-terminated string</td>
    <td>???TODO</td>
  </tr>

  <tr>
    <td>master_log</td>
    <td>null-terminated string</td>
    <td>???TODO</td>
  </tr>
  </table>
*/
1666 1667 1668 1669 1670 1671
class Slave_log_event: public Log_event
{
protected:
  char* mem_pool;
  void init_from_mem_pool(int data_size);
public:
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1672
  my_off_t master_pos;
1673 1674
  char* master_host;
  char* master_log;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1675
  int master_host_len;
1676
  int master_log_len;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1677
  uint16 master_port;
1678

1679
#ifndef MYSQL_CLIENT
1680
  Slave_log_event(THD* thd_arg, Relay_log_info* rli);
1681
  void pack_info(Protocol* protocol);
1682
#else
1683
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
1684
#endif
1685

1686
  Slave_log_event(const char* buf, uint event_len);
1687 1688
  ~Slave_log_event();
  int get_data_size();
1689
  bool is_valid() const { return master_host != 0; }
1690
  Log_event_type get_type_code() { return SLAVE_EVENT; }
1691
#ifndef MYSQL_CLIENT
1692
  bool write(IO_CACHE* file);
1693
#endif
1694 1695 1696

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1697
  virtual int do_apply_event(Relay_log_info const* rli);
1698
#endif
1699 1700
};

hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1701
#endif /* HAVE_REPLICATION */
1702

1703

1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
/**
  @class Load_log_event

  This log event corresponds to a "LOAD DATA INFILE" SQL query on the
  following form:

  @verbatim
   (1)    USE db;
   (2)    LOAD DATA [LOCAL] INFILE 'file_name'
   (3)    [REPLACE | IGNORE]
   (4)    INTO TABLE 'table_name'
   (5)    [FIELDS
   (6)      [TERMINATED BY 'field_term']
   (7)      [[OPTIONALLY] ENCLOSED BY 'enclosed']
   (8)      [ESCAPED BY 'escaped']
   (9)    ]
  (10)    [LINES
  (11)      [TERMINATED BY 'line_term']
  (12)      [LINES STARTING BY 'line_start']
  (13)    ]
  (14)    [IGNORE skip_lines LINES]
  (15)    (field_1, field_2, ..., field_n)@endverbatim

  @section Load_log_event_binary_format Binary Format

  The Post-Header consists of the following six components.

  <table>
  <caption>Post-Header for Load_log_event</caption>

  <tr>
    <th>Name</th>
1736
    <th>Format</th>
1737 1738 1739 1740 1741 1742
    <th>Description</th>
  </tr>

  <tr>
    <td>slave_proxy_id</td>
    <td>4 byte unsigned integer</td>
1743 1744 1745 1746 1747 1748
    <td>An integer identifying the client thread that issued the
    query.  The id is unique per server.  (Note, however, that two
    threads on different servers may have the same slave_proxy_id.)
    This is used when a client thread creates a temporary table local
    to the client.  The slave_proxy_id is used to distinguish
    temporary tables that belong to different clients.
1749 1750 1751 1752 1753 1754
    </td>
  </tr>

  <tr>
    <td>exec_time</td>
    <td>4 byte unsigned integer</td>
1755 1756
    <td>The time from when the query started to when it was logged in
    the binlog, in seconds.</td>
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
  </tr>

  <tr>
    <td>skip_lines</td>
    <td>4 byte unsigned integer</td>
    <td>The number on line (14) above, if present, or 0 if line (14)
    is left out.
    </td>
  </tr>

  <tr>
    <td>table_name_len</td>
    <td>1 byte unsigned integer</td>
    <td>The length of 'table_name' on line (4) above.</td>
  </tr>

  <tr>
    <td>db_len</td>
    <td>1 byte unsigned integer</td>
    <td>The length of 'db' on line (1) above.</td>
  </tr>

  <tr>
    <td>num_fields</td>
    <td>4 byte unsigned integer</td>
    <td>The number n of fields on line (15) above.</td>
  </tr>
  </table>    

  The Body contains the following components.

  <table>
  <caption>Body of Load_log_event</caption>

  <tr>
    <th>Name</th>
1793
    <th>Format</th>
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
    <th>Description</th>
  </tr>

  <tr>
    <td>sql_ex</td>
    <td>variable length</td>

    <td>Describes the part of the query on lines (3) and
    (5)&ndash;(13) above.  More precisely, it stores the five strings
    (on lines) field_term (6), enclosed (7), escaped (8), line_term
    (11), and line_start (12); as well as a bitfield indicating the
    presence of the keywords REPLACE (3), IGNORE (3), and OPTIONALLY
    (7).

    The data is stored in one of two formats, called "old" and "new".
    The type field of Common-Header determines which of these two
    formats is used: type LOAD_EVENT means that the old format is
    used, and type NEW_LOAD_EVENT means that the new format is used.
    When MySQL writes a Load_log_event, it uses the new format if at
    least one of the five strings is two or more bytes long.
    Otherwise (i.e., if all strings are 0 or 1 bytes long), the old
    format is used.

    The new and old format differ in the way the five strings are
    stored.

    <ul>
    <li> In the new format, the strings are stored in the order
    field_term, enclosed, escaped, line_term, line_start. Each string
    consists of a length (1 byte), followed by a sequence of
    characters (0-255 bytes).  Finally, a boolean combination of the
    following flags is stored in 1 byte: REPLACE_FLAG==0x4,
    IGNORE_FLAG==0x8, and OPT_ENCLOSED_FLAG==0x2.  If a flag is set,
    it indicates the presence of the corresponding keyword in the SQL
    query.

    <li> In the old format, we know that each string has length 0 or
    1.  Therefore, only the first byte of each string is stored.  The
    order of the strings is the same as in the new format.  These five
1833
    bytes are followed by the same 1 byte bitfield as in the new
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
    format.  Finally, a 1 byte bitfield called empty_flags is stored.
    The low 5 bits of empty_flags indicate which of the five strings
    have length 0.  For each of the following flags that is set, the
    corresponding string has length 0; for the flags that are not set,
    the string has length 1: FIELD_TERM_EMPTY==0x1,
    ENCLOSED_EMPTY==0x2, LINE_TERM_EMPTY==0x4, LINE_START_EMPTY==0x8,
    ESCAPED_EMPTY==0x10.
    </ul>

    Thus, the size of the new format is 6 bytes + the sum of the sizes
    of the five strings.  The size of the old format is always 7
    bytes.
    </td>
  </tr>

  <tr>
    <td>field_lens</td>
1851
    <td>num_fields 1 byte unsigned integers</td>
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
    <td>An array of num_fields integers representing the length of
    each field in the query.  (num_fields is from the Post-Header).
    </td>
  </tr>

  <tr>
    <td>fields</td>
    <td>num_fields null-terminated strings</td>
    <td>An array of num_fields null-terminated strings, each
    representing a field in the query.  (The trailing zero is
    redundant, since the length are stored in the num_fields array.)
    The total length of all strings equals to the sum of all
    field_lens, plus num_fields bytes for all the trailing zeros.
    </td>
  </tr>

  <tr>
    <td>table_name</td>
    <td>null-terminated string of length table_len+1 bytes</td>
    <td>The 'table_name' from the query, as a null-terminated string.
    (The trailing zero is actually redundant since the table_len is
    known from Post-Header.)
    </td>
  </tr>

  <tr>
    <td>db</td>
    <td>null-terminated string of length db_len+1 bytes</td>
    <td>The 'db' from the query, as a null-terminated string.
    (The trailing zero is actually redundant since the db_len is known
    from Post-Header.)
    </td>
  </tr>

  <tr>
    <td>file_name</td>
    <td>variable length string without trailing zero, extending to the
    end of the event (determined by the length field of the
    Common-Header)
    </td>
    <td>The 'file_name' from the query.
    </td>
  </tr>

  </table>

  @subsection Load_log_event_notes_on_previous_versions Notes on Previous Versions
1899

1900 1901
  This event type is understood by current versions, but only
  generated by MySQL 3.23 and earlier.
1902
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1903 1904
class Load_log_event: public Log_event
{
1905 1906 1907 1908
private:
  uint get_query_buffer_length();
  void print_query(bool need_db, char *buf, char **end,
                   char **fn_start, char **fn_end);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1909
protected:
1910
  int copy_log_event(const char *buf, ulong event_len,
1911 1912
                     int body_offset,
                     const Format_description_log_event* description_event);
1913

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1914
public:
1915
  ulong thread_id;
guilhem@mysql.com's avatar
guilhem@mysql.com committed
1916
  ulong slave_proxy_id;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
1917
  uint32 table_name_len;
1918 1919 1920 1921 1922
  /*
    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).
  */
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
1923 1924 1925
  uint32 db_len;
  uint32 fname_len;
  uint32 num_fields;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1926 1927
  const char* fields;
  const uchar* field_lens;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
1928
  uint32 field_block_len;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1929 1930 1931 1932

  const char* table_name;
  const char* db;
  const char* fname;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
1933
  uint32 skip_lines;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1934
  sql_ex_info sql_ex;
1935
  bool local_fname;
1936

1937 1938
  /* fname doesn't point to memory inside Log_event::temp_buf  */
  void set_fname_outside_temp_buf(const char *afname, uint alen)
1939 1940 1941
  {
    fname= afname;
    fname_len= alen;
1942
    local_fname= TRUE;
1943
  }
1944 1945
  /* fname doesn't point to memory inside Log_event::temp_buf  */
  int  check_fname_outside_temp_buf()
1946
  {
1947
    return local_fname;
1948
  }
1949

1950
#ifndef MYSQL_CLIENT
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1951 1952
  String field_lens_buf;
  String fields_buf;
1953

1954
  Load_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
1955
		 const char* table_name_arg,
1956
		 List<Item>& fields_arg, enum enum_duplicates handle_dup, bool ignore,
1957
		 bool using_trans);
1958 1959
  void set_fields(const char* db, List<Item> &fields_arg,
                  Name_resolution_context *context);
1960
  const char* get_db() { return db; }
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1961
#ifdef HAVE_REPLICATION
hf@deer.mysql.r18.ru's avatar
hf@deer.mysql.r18.ru committed
1962
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1963
#endif /* HAVE_REPLICATION */
1964
#else
1965
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
1966
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info, bool commented);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1967 1968
#endif

1969 1970 1971 1972 1973 1974 1975
  /*
    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,
1976
                 const Format_description_log_event* description_event);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1977
  ~Load_log_event()
1978
  {}
1979 1980 1981 1982
  Log_event_type get_type_code()
  {
    return sql_ex.new_format() ? NEW_LOAD_EVENT: LOAD_EVENT;
  }
1983
#ifndef MYSQL_CLIENT
1984 1985
  bool write_data_header(IO_CACHE* file);
  bool write_data_body(IO_CACHE* file);
1986
#endif
1987
  bool is_valid() const { return table_name != 0; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1988 1989
  int get_data_size()
  {
1990 1991
    return (table_name_len + db_len + 2 + fname_len
	    + LOAD_HEADER_LEN
1992
	    + sql_ex.data_size() + field_block_len + num_fields);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1993
  }
1994 1995 1996

public:        /* !!! Public in this patch to allow old usage */
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1997
  virtual int do_apply_event(Relay_log_info const* rli)
1998
  {
1999
    return do_apply_event(thd->slave_net,rli,0);
2000 2001
  }

2002
  int do_apply_event(NET *net, Relay_log_info const *rli,
2003
                     bool use_rli_only_for_errors);
2004
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2005 2006
};

2007
extern char server_version[SERVER_VERSION_LENGTH];
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2008

2009 2010
/**
  @class Start_log_event_v3
2011

2012 2013
  Start_log_event_v3 is the Start_log_event of binlog format 3 (MySQL 3.23 and
  4.x).
2014 2015 2016 2017 2018 2019 2020

  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' Common-Header/Post-Header
  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).
2021

2022 2023
  @section Start_log_event_v3_binary_format Binary Format
*/
2024
class Start_log_event_v3: public Log_event
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2025 2026
{
public:
2027
  /*
2028 2029 2030 2031 2032
    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
2033 2034
    >=4.0.14 slaves to know whether they must drop stale temporary
    tables and whether they should abort unfinished transaction.
2035 2036 2037 2038 2039 2040 2041 2042

    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:
2043 2044 2045 2046 2047
     - 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.
2048
  */
2049
  time_t created;
2050
  uint16 binlog_version;
2051
  char server_version[ST_SERVER_VER_LEN];
2052 2053 2054 2055 2056 2057
  /*
    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;
2058 2059 2060 2061 2062
  /*
    We set this to 1 if we don't want to have the created time in the log,
    which is the case when we rollover to a new log.
  */
  bool dont_set_created;
2063 2064

#ifndef MYSQL_CLIENT
2065
  Start_log_event_v3();
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2066
#ifdef HAVE_REPLICATION
2067
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2068
#endif /* HAVE_REPLICATION */
2069
#else
2070
  Start_log_event_v3() {}
2071
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2072
#endif
2073

2074 2075 2076 2077
  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;}
2078
#ifndef MYSQL_CLIENT
2079
  bool write(IO_CACHE* file);
2080
#endif
2081
  bool is_valid() const { return 1; }
2082 2083
  int get_data_size()
  {
2084 2085
    return START_V3_HEADER_LEN; //no variable-sized part
  }
2086
  virtual bool is_artificial_event() { return artificial_event; }
2087

2088
protected:
2089
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2090 2091
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info*)
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
  {
    /*
      Events from ourself should be skipped, but they should not
      decrease the slave skip counter.
     */
    if (this->server_id == ::server_id)
      return Log_event::EVENT_SKIP_IGNORE;
    else
      return Log_event::EVENT_SKIP_NOT;
  }
2102
#endif
2103 2104
};

2105

2106 2107 2108 2109 2110 2111 2112 2113
/**
  @class Format_description_log_event

  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).

  @section Format_description_log_event_binary_format Binary Format
2114 2115 2116 2117 2118
*/

class Format_description_log_event: public Start_log_event_v3
{
public:
2119
  /*
2120 2121 2122 2123 2124 2125 2126 2127 2128
     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;
guilhem@gbichot3.local's avatar
guilhem@gbichot3.local committed
2129
  uchar server_version_split[3];
2130
  const uint8 *event_type_permutation;
2131 2132 2133

  Format_description_log_event(uint8 binlog_ver, const char* server_ver=0);
  Format_description_log_event(const char* buf, uint event_len,
2134 2135
                               const Format_description_log_event
                               *description_event);
2136 2137 2138 2139
  ~Format_description_log_event()
  {
    my_free((uchar*)post_header_len, MYF(MY_ALLOW_ZERO_PTR));
  }
2140
  Log_event_type get_type_code() { return FORMAT_DESCRIPTION_EVENT;}
2141
#ifndef MYSQL_CLIENT
2142
  bool write(IO_CACHE* file);
2143
#endif
2144
  bool is_valid() const
2145
  {
2146 2147 2148
    return ((common_header_len >= ((binlog_version==1) ? OLD_HEADER_LEN :
                                   LOG_EVENT_MINIMAL_HEADER_LEN)) &&
            (post_header_len != NULL));
2149 2150 2151 2152 2153 2154 2155 2156 2157
  }
  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;
2158
  }
2159

guilhem@gbichot3.local's avatar
guilhem@gbichot3.local committed
2160
  void calc_server_version_split();
2161

2162
protected:
2163
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2164 2165 2166
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2167
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2168 2169
};

2170

2171 2172
/**
  @class Intvar_log_event
2173

2174 2175 2176
  An Intvar_log_event will be created just before a Query_log_event,
  if the query uses one of the variables LAST_INSERT_ID or INSERT_ID.
  Each Intvar_log_event holds the value of one of these variables.
2177

2178
  @section Intvar_log_event_binary_format Binary Format
2179

2180 2181 2182 2183 2184 2185 2186
  The Post-Header has two components:

  <table>
  <caption>Post-Header for Intvar_log_event</caption>

  <tr>
    <th>Name</th>
2187
    <th>Format</th>
2188 2189 2190 2191
    <th>Description</th>
  </tr>

  <tr>
2192
    <td>type</td>
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
    <td>1 byte enumeration</td>
    <td>One byte identifying the type of variable stored.  Currently,
    two identifiers are supported:  LAST_INSERT_ID_EVENT==1 and
    INSERT_ID_EVENT==2.
    </td>
  </tr>

  <tr>
    <td>value</td>
    <td>8 byte unsigned integer</td>
    <td>The value of the variable.</td>
  </tr>

  </table>
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2208 2209 2210 2211 2212
class Intvar_log_event: public Log_event
{
public:
  ulonglong val;
  uchar type;
2213

2214
#ifndef MYSQL_CLIENT
2215
  Intvar_log_event(THD* thd_arg,uchar type_arg, ulonglong val_arg)
2216
    :Log_event(thd_arg,0,0),val(val_arg),type(type_arg)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2217
  {}
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2218
#ifdef HAVE_REPLICATION
2219
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2220
#endif /* HAVE_REPLICATION */
2221
#else
2222
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2223
#endif
2224

2225 2226
  Intvar_log_event(const char* buf,
                   const Format_description_log_event *description_event);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2227 2228
  ~Intvar_log_event() {}
  Log_event_type get_type_code() { return INTVAR_EVENT;}
2229
  const char* get_var_type_name();
2230
  int get_data_size() { return  9; /* sizeof(type) + sizeof(val) */;}
2231
#ifndef MYSQL_CLIENT
2232
  bool write(IO_CACHE* file);
2233
#endif
2234
  bool is_valid() const { return 1; }
2235 2236 2237

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2238 2239 2240
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2241
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2242 2243
};

2244

2245 2246
/**
  @class Rand_log_event
2247

2248
  Logs random seed used by the next RAND(), and by PASSWORD() in 4.1.0.
2249 2250 2251
  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).
2252

2253 2254 2255
  The state of the random number generation consists of 128 bits,
  which are stored internally as two 64-bit numbers.

2256 2257 2258 2259
  @section Rand_log_event_binary_format Binary Format  
  This event type has no Post-Header. The Body of this event type has
  two components:

2260 2261
  <table>
  <caption>Post-Header for Intvar_log_event</caption>
2262

2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
  <tr>
    <th>Name</th>
    <th>Format</th>
    <th>Description</th>
  </tr>

  <tr>
    <td>seed1</td>
    <td>8 byte unsigned integer</td>
    <td>64 bit random seed1.</td>
  </tr>

  <tr>
    <td>seed2</td>
    <td>8 byte unsigned integer</td>
    <td>64 bit random seed2.</td>
  </tr>
  </table>
2281
*/
2282

nick@mysql.com's avatar
nick@mysql.com committed
2283 2284 2285 2286 2287 2288 2289 2290
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)
2291
    :Log_event(thd_arg,0,0),seed1(seed1_arg),seed2(seed2_arg)
nick@mysql.com's avatar
nick@mysql.com committed
2292
  {}
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2293
#ifdef HAVE_REPLICATION
2294
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2295
#endif /* HAVE_REPLICATION */
nick@mysql.com's avatar
nick@mysql.com committed
2296
#else
2297
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
nick@mysql.com's avatar
nick@mysql.com committed
2298 2299
#endif

2300 2301
  Rand_log_event(const char* buf,
                 const Format_description_log_event *description_event);
nick@mysql.com's avatar
nick@mysql.com committed
2302 2303
  ~Rand_log_event() {}
  Log_event_type get_type_code() { return RAND_EVENT;}
2304
  int get_data_size() { return 16; /* sizeof(ulonglong) * 2*/ }
2305
#ifndef MYSQL_CLIENT
2306
  bool write(IO_CACHE* file);
2307
#endif
2308
  bool is_valid() const { return 1; }
2309 2310 2311

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2312 2313 2314
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2315
#endif
nick@mysql.com's avatar
nick@mysql.com committed
2316 2317
};

2318 2319
/**
  @class Xid_log_event
2320 2321 2322 2323

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

2324 2325
  @section Xid_log_event_binary_format Binary Format  
*/
2326
#ifdef MYSQL_CLIENT
2327
typedef ulonglong my_xid; // this line is the same as in handler.h
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
#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);
#endif /* HAVE_REPLICATION */
#else
2341
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2342 2343
#endif

2344 2345
  Xid_log_event(const char* buf,
                const Format_description_log_event *description_event);
2346 2347 2348
  ~Xid_log_event() {}
  Log_event_type get_type_code() { return XID_EVENT;}
  int get_data_size() { return sizeof(xid); }
2349
#ifndef MYSQL_CLIENT
2350
  bool write(IO_CACHE* file);
2351
#endif
2352
  bool is_valid() const { return 1; }
2353 2354 2355

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2356
  virtual int do_apply_event(Relay_log_info const *rli);
2357
  enum_skip_reason do_shall_skip(Relay_log_info *rli);
2358
#endif
2359
};
2360

2361 2362
/**
  @class User_var_log_event
2363

2364 2365 2366
  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.

2367 2368
  @section User_var_log_event_binary_format Binary Format  
*/
2369

2370 2371 2372 2373 2374 2375 2376 2377 2378
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;
2379
  bool is_null;
2380 2381 2382 2383 2384 2385 2386 2387 2388
#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);
#else
2389
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2390 2391
#endif

2392 2393
  User_var_log_event(const char* buf,
                     const Format_description_log_event *description_event);
2394 2395
  ~User_var_log_event() {}
  Log_event_type get_type_code() { return USER_VAR_EVENT;}
2396
#ifndef MYSQL_CLIENT
2397
  bool write(IO_CACHE* file);
2398
#endif
2399
  bool is_valid() const { return 1; }
2400 2401 2402

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2403 2404 2405
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2406
#endif
2407
};
2408

2409

2410 2411
/**
  @class Stop_log_event
2412

2413
  @section Stop_log_event_binary_format Binary Format
2414

2415 2416 2417
  The Post-Header and Body for this event type are empty; it only has
  the Common-Header.
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2418 2419 2420
class Stop_log_event: public Log_event
{
public:
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
2421
#ifndef MYSQL_CLIENT
2422
  Stop_log_event() :Log_event()
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2423
  {}
2424
#else
2425
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2426
#endif
2427

2428 2429
  Stop_log_event(const char* buf,
                 const Format_description_log_event *description_event):
2430
    Log_event(buf, description_event)
2431
  {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2432 2433
  ~Stop_log_event() {}
  Log_event_type get_type_code() { return STOP_EVENT;}
2434
  bool is_valid() const { return 1; }
2435 2436 2437

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2438 2439
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli)
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449
  {
    /*
      Events from ourself should be skipped, but they should not
      decrease the slave skip counter.
     */
    if (this->server_id == ::server_id)
      return Log_event::EVENT_SKIP_IGNORE;
    else
      return Log_event::EVENT_SKIP_NOT;
  }
2450
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2451 2452
};

2453 2454
/**
  @class Rotate_log_event
2455

2456
  This will be deprecated when we move to using sequence ids.
2457

2458 2459 2460 2461 2462 2463 2464 2465 2466
  @section Rotate_log_event_binary_format Binary Format

  The Post-Header has one component:

  <table>
  <caption>Post-Header for Rotate_log_event</caption>

  <tr>
    <th>Name</th>
2467
    <th>Format</th>
2468 2469 2470 2471
    <th>Description</th>
  </tr>

  <tr>
2472
    <td>position</td>
2473
    <td>8 byte integer</td>
2474
    <td>The position within the binlog to rotate to.</td>
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485
  </tr>

  </table>

  The Body has one component:

  <table>
  <caption>Body for Rotate_log_event</caption>

  <tr>
    <th>Name</th>
2486
    <th>Format</th>
2487 2488 2489 2490
    <th>Description</th>
  </tr>

  <tr>
2491
    <td>new_log</td>
2492 2493 2494 2495
    <td>variable length string without trailing zero, extending to the
    end of the event (determined by the length field of the
    Common-Header)
    </td>
2496
    <td>Name of the binlog to rotate to.</td>
2497 2498 2499 2500
  </tr>

  </table>
*/
2501

bk@work.mysql.com's avatar
bk@work.mysql.com committed
2502 2503 2504
class Rotate_log_event: public Log_event
{
public:
2505 2506 2507
  enum {
    DUP_NAME= 2 // if constructor should dup the string argument
  };
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2508
  const char* new_log_ident;
2509
  ulonglong pos;
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2510
  uint ident_len;
2511
  uint flags;
2512
#ifndef MYSQL_CLIENT
2513
  Rotate_log_event(const char* new_log_ident_arg,
2514 2515
		   uint ident_len_arg,
		   ulonglong pos_arg, uint flags);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2516
#ifdef HAVE_REPLICATION
2517
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2518
#endif /* HAVE_REPLICATION */
2519
#else
2520
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2521 2522
#endif

2523 2524
  Rotate_log_event(const char* buf, uint event_len,
                   const Format_description_log_event* description_event);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2525 2526
  ~Rotate_log_event()
  {
2527
    if (flags & DUP_NAME)
2528
      my_free((uchar*) new_log_ident, MYF(MY_ALLOW_ZERO_PTR));
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2529 2530
  }
  Log_event_type get_type_code() { return ROTATE_EVENT;}
2531
  int get_data_size() { return  ident_len + ROTATE_HEADER_LEN;}
2532
  bool is_valid() const { return new_log_ident != 0; }
2533
#ifndef MYSQL_CLIENT
2534
  bool write(IO_CACHE* file);
2535
#endif
2536 2537 2538

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2539 2540
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2541
#endif
2542 2543
};

2544

2545 2546
/* the classes below are for the new LOAD DATA INFILE logging */

2547 2548 2549 2550 2551
/**
  @class Create_file_log_event

  @section Create_file_log_event_binary_format Binary Format
*/
2552

2553
class Create_file_log_event: public Load_log_event
2554
{
2555
protected:
2556 2557 2558 2559 2560
  /*
    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
  */
2561
  bool fake_base;
2562
public:
2563
  uchar* block;
2564
  const char *event_buf;
2565 2566
  uint block_len;
  uint file_id;
2567
  bool inited_from_old;
2568

2569 2570
#ifndef MYSQL_CLIENT
  Create_file_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
2571 2572
			const char* table_name_arg,
			List<Item>& fields_arg,
2573
			enum enum_duplicates handle_dup, bool ignore,
2574
			uchar* block_arg, uint block_len_arg,
2575
			bool using_trans);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2576
#ifdef HAVE_REPLICATION
2577
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2578
#endif /* HAVE_REPLICATION */
2579
#else
2580
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2581 2582
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
             bool enable_local);
2583 2584
#endif

2585 2586
  Create_file_log_event(const char* buf, uint event_len,
                        const Format_description_log_event* description_event);
2587 2588 2589 2590
  ~Create_file_log_event()
  {
    my_free((char*) event_buf, MYF(MY_ALLOW_ZERO_PTR));
  }
2591 2592

  Log_event_type get_type_code()
2593
  {
2594 2595 2596 2597 2598 2599 2600 2601
    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);
  }
2602
  bool is_valid() const { return inited_from_old || block != 0; }
2603
#ifndef MYSQL_CLIENT
2604 2605
  bool write_data_header(IO_CACHE* file);
  bool write_data_body(IO_CACHE* file);
2606 2607 2608 2609
  /*
    Cut out Create_file extentions and
    write it as Load event - used on the slave
  */
2610
  bool write_base(IO_CACHE* file);
2611
#endif
2612 2613 2614

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2615
  virtual int do_apply_event(Relay_log_info const *rli);
2616
#endif
2617 2618
};

2619

2620 2621
/**
  @class Append_block_log_event
2622

2623 2624
  @section Append_block_log_event_binary_format Binary Format
*/
2625

2626 2627 2628
class Append_block_log_event: public Log_event
{
public:
2629
  uchar* block;
2630 2631
  uint block_len;
  uint file_id;
2632
  /*
2633 2634 2635 2636 2637 2638 2639 2640 2641
    '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.
2642 2643 2644
  */
  const char* db;

2645
#ifndef MYSQL_CLIENT
2646
  Append_block_log_event(THD* thd, const char* db_arg, uchar* block_arg,
2647
			 uint block_len_arg, bool using_trans);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2648
#ifdef HAVE_REPLICATION
2649
  void pack_info(Protocol* protocol);
2650
  virtual int get_create_or_append() const;
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2651
#endif /* HAVE_REPLICATION */
2652
#else
2653
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2654
#endif
2655 2656

  Append_block_log_event(const char* buf, uint event_len,
2657 2658
                         const Format_description_log_event
                         *description_event);
2659
  ~Append_block_log_event() {}
2660 2661
  Log_event_type get_type_code() { return APPEND_BLOCK_EVENT;}
  int get_data_size() { return  block_len + APPEND_BLOCK_HEADER_LEN ;}
2662
  bool is_valid() const { return block != 0; }
2663
#ifndef MYSQL_CLIENT
2664
  bool write(IO_CACHE* file);
2665
  const char* get_db() { return db; }
2666
#endif
2667 2668 2669

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2670
  virtual int do_apply_event(Relay_log_info const *rli);
2671
#endif
2672 2673
};

2674

2675 2676
/**
  @class Delete_file_log_event
2677

2678 2679
  @section Delete_file_log_event_binary_format Binary Format
*/
2680

2681 2682 2683 2684
class Delete_file_log_event: public Log_event
{
public:
  uint file_id;
2685
  const char* db; /* see comment in Append_block_log_event */
2686

2687
#ifndef MYSQL_CLIENT
2688
  Delete_file_log_event(THD* thd, const char* db_arg, bool using_trans);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2689
#ifdef HAVE_REPLICATION
2690
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2691
#endif /* HAVE_REPLICATION */
2692
#else
2693
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2694 2695
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
             bool enable_local);
2696 2697
#endif

2698 2699
  Delete_file_log_event(const char* buf, uint event_len,
                        const Format_description_log_event* description_event);
2700
  ~Delete_file_log_event() {}
2701 2702
  Log_event_type get_type_code() { return DELETE_FILE_EVENT;}
  int get_data_size() { return DELETE_FILE_HEADER_LEN ;}
2703
  bool is_valid() const { return file_id != 0; }
2704
#ifndef MYSQL_CLIENT
2705
  bool write(IO_CACHE* file);
2706
  const char* get_db() { return db; }
2707
#endif
2708 2709 2710

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2711
  virtual int do_apply_event(Relay_log_info const *rli);
2712
#endif
2713 2714
};

2715

2716 2717
/**
  @class Execute_load_log_event
2718

2719 2720
  @section Delete_file_log_event_binary_format Binary Format
*/
2721

2722 2723 2724 2725
class Execute_load_log_event: public Log_event
{
public:
  uint file_id;
2726
  const char* db; /* see comment in Append_block_log_event */
2727

2728
#ifndef MYSQL_CLIENT
2729
  Execute_load_log_event(THD* thd, const char* db_arg, bool using_trans);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2730
#ifdef HAVE_REPLICATION
2731
  void pack_info(Protocol* protocol);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
2732
#endif /* HAVE_REPLICATION */
2733
#else
2734
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2735 2736 2737
#endif

  Execute_load_log_event(const char* buf, uint event_len,
2738 2739
                         const Format_description_log_event
                         *description_event);
2740
  ~Execute_load_log_event() {}
2741 2742
  Log_event_type get_type_code() { return EXEC_LOAD_EVENT;}
  int get_data_size() { return  EXEC_LOAD_HEADER_LEN ;}
2743
  bool is_valid() const { return file_id != 0; }
2744
#ifndef MYSQL_CLIENT
2745
  bool write(IO_CACHE* file);
2746
  const char* get_db() { return db; }
2747
#endif
2748 2749 2750

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2751
  virtual int do_apply_event(Relay_log_info const *rli);
2752
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
2753 2754
};

2755

2756 2757
/**
  @class Begin_load_query_log_event
2758 2759 2760 2761 2762

  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.

2763 2764
  @section Begin_load_query_log_event_binary_format Binary Format
*/
2765 2766 2767 2768 2769
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,
2770
                             uchar* block_arg, uint block_len_arg,
2771 2772 2773
                             bool using_trans);
#ifdef HAVE_REPLICATION
  Begin_load_query_log_event(THD* thd);
2774
  int get_create_or_append() const;
2775 2776 2777
#endif /* HAVE_REPLICATION */
#endif
  Begin_load_query_log_event(const char* buf, uint event_len,
2778 2779
                             const Format_description_log_event
                             *description_event);
2780 2781
  ~Begin_load_query_log_event() {}
  Log_event_type get_type_code() { return BEGIN_LOAD_QUERY_EVENT; }
2782 2783 2784 2785
private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
#endif
2786 2787 2788 2789 2790 2791 2792 2793 2794
};


/*
  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 };

2795 2796
/**
  @class Execute_load_query_log_event
2797 2798 2799 2800 2801

  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.

2802 2803
  @section Execute_load_query_log_event_binary_format Binary Format
*/
2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820
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,
2821 2822 2823 2824 2825 2826
                               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,
                               THD::killed_state
                               killed_err_arg= THD::KILLED_NO_VALUE);
2827 2828 2829 2830
#ifdef HAVE_REPLICATION
  void pack_info(Protocol* protocol);
#endif /* HAVE_REPLICATION */
#else
2831
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2832
  /* Prints the query as LOAD DATA LOCAL and with rewritten filename */
2833
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
lars@mysql.com's avatar
lars@mysql.com committed
2834
	     const char *local_fname);
2835 2836
#endif
  Execute_load_query_log_event(const char* buf, uint event_len,
2837 2838
                               const Format_description_log_event
                               *description_event);
2839 2840 2841 2842 2843 2844
  ~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();
2845
#ifndef MYSQL_CLIENT
2846
  bool write_post_header_for_derived(IO_CACHE* file);
2847
#endif
2848 2849 2850

private:
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2851
  virtual int do_apply_event(Relay_log_info const *rli);
2852 2853
#endif
};
2854 2855


2856
#ifdef MYSQL_CLIENT
2857 2858 2859 2860 2861
/**
  @class Unknown_log_event

  @section Unknown_log_event_binary_format Binary Format
*/
2862 2863 2864
class Unknown_log_event: public Log_event
{
public:
2865 2866 2867 2868 2869
  /*
    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).
  */
2870 2871
  Unknown_log_event(const char* buf,
                    const Format_description_log_event *description_event):
2872
    Log_event(buf, description_event)
2873 2874
  {}
  ~Unknown_log_event() {}
2875
  void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2876
  Log_event_type get_type_code() { return UNKNOWN_EVENT;}
2877
  bool is_valid() const { return 1; }
2878
};
2879
#endif
2880
char *str_to_hex(char *to, const char *from, uint len);
2881

2882 2883
/**
  @class Table_map_log_event
2884

2885 2886 2887 2888
  In row-based mode, every row operation event is preceded by a
  Table_map_log_event which maps a table definition to a number.  The
  table definition consists of database name, table name, and column
  definitions.
2889

2890
  @section Table_map_log_event_binary_format Binary Format
2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194

  The Post-Header has the following components:

  <table>
  <caption>Post-Header for Table_map_log_event</caption>

  <tr>
    <th>Name</th>
    <th>Format</th>
    <th>Description</th>
  </tr>

  <tr>
    <td>table_id</td>
    <td>6 bytes unsigned integer</td>
    <td>The number that identifies the table.</td>
  </tr>

  <tr>
    <td>flags</td>
    <td>2 byte bitfield</td>
    <td>Reserved for future use; currently always 0.</td>
  </tr>

  </table>

  The Body has the following components:

  <table>
  <caption>Body for Table_map_log_event</caption>

  <tr>
    <th>Name</th>
    <th>Format</th>
    <th>Description</th>
  </tr>

  <tr>
    <td>database_name</td>
    <td>one byte string length, followed by null-terminated string</td>
    <td>The name of the database in which the table resides.  The name
    is represented as a one byte unsigned integer representing the
    number of bytes in the name, followed by length bytes containing
    the database name, followed by a terminating 0 byte.  (Note the
    redundancy in the representation of the length.)  </td>
  </tr>

  <tr>
    <td>table_name</td>
    <td>one byte string length, followed by null-terminated string</td>
    <td>The name of the table, encoded the same way as the database
    name above.</td>
  </tr>

  <tr>
    <td>column_count</td>
    <td>@ref packed_integer "Packed Integer"</td>
    <td>The number of columns in the table, represented as a packed
    variable-length integer.</td>
  </tr>

  <tr>
    <td>column_type</td>
    <td>List of column_count 1 byte enumeration values</td>
    <td>The type of each column in the table, listed from left to
    right.  Each byte is mapped to a column type according to the
    enumeration type enum_field_types defined in mysql_com.h.  The
    mapping of types to numbers is listed in the table @ref
    Table_table_map_log_event_column_types "below" (along with
    description of the associated metadata field).  </td>
  </tr>

  <tr>
    <td>metadata_length</td>
    <td>@ref packed_integer "Packed Integer"</td>
    <td>The length of the following metadata block</td>
  </tr>

  <tr>
    <td>metadata</td>
    <td>list of metadata for each column</td>
    <td>For each column from left to right, a chunk of data who's
    length and semantics depends on the type of the column.  The
    length and semantics for the metadata for each column are listed
    in the table @ref Table_table_map_log_event_column_types
    "below".</td>
  </tr>

  <tr>
    <td>null_bits</td>
    <td>column_count bits, rounded up to nearest byte</td>
    <td>For each column, a bit indicating whether data in the column
    can be NULL or not.  The number of bytes needed for this is
    int((column_count+7)/8).  The flag for the first column from the
    left is in the least-significant bit of the first byte, the second
    is in the second least significant bit of the first byte, the
    ninth is in the least significant bit of the second byte, and so
    on.  </td>
  </tr>

  </table>

  The table below lists all column types, along with the numerical
  identifier for it and the size and interpretation of meta-data used
  to describe the type.

  @anchor Table_table_map_log_event_column_types
  <table>
  <caption>Table_map_log_event column types: numerical identifier and
  metadata</caption>
  <tr>
    <th>Name</th>
    <th>Identifier</th>
    <th>Size of metadata in bytes</th>
    <th>Description of metadata</th>
  </tr>

  <tr>
    <td>MYSQL_TYPE_DECIMAL</td><td>0</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_TINY</td><td>1</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_SHORT</td><td>2</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_LONG</td><td>3</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_FLOAT</td><td>4</td>
    <td>1 byte</td>
    <td>1 byte unsigned integer, representing the "pack_length", which
    is equal to sizeof(float) on the server from which the event
    originates.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_DOUBLE</td><td>5</td>
    <td>1 byte</td>
    <td>1 byte unsigned integer, representing the "pack_length", which
    is equal to sizeof(double) on the server from which the event
    originates.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_NULL</td><td>6</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_TIMESTAMP</td><td>7</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_LONGLONG</td><td>8</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_INT24</td><td>9</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_DATE</td><td>10</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_TIME</td><td>11</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_DATETIME</td><td>12</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_YEAR</td><td>13</td>
    <td>0</td>
    <td>No column metadata.</td>
  </tr>

  <tr>
    <td><i>MYSQL_TYPE_NEWDATE</i></td><td><i>14</i></td>
    <td>&ndash;</td>
    <td><i>This enumeration value is only used internally and cannot
    exist in a binlog.</i></td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_VARCHAR</td><td>15</td>
    <td>2 bytes</td>
    <td>2 byte unsigned integer representing the maximum length of
    the string.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_BIT</td><td>16</td>
    <td>2 bytes</td>
    <td>A 1 byte unsigned int representing the length in bits of the
    bitfield (0 to 64), followed by a 1 byte unsigned int
    representing the number of bytes occupied by the bitfield.  The
    number of bytes is either int((length+7)/8) or int(length/8).</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_NEWDECIMAL</td><td>246</td>
    <td>2 bytes</td>
    <td>A 1 byte unsigned int representing the precision, followed
    by a 1 byte unsigned int representing the number of decimals.</td>
  </tr>

  <tr>
    <td><i>MYSQL_TYPE_ENUM</i></td><td><i>247</i></td>
    <td>&ndash;</td>
    <td><i>This enumeration value is only used internally and cannot
    exist in a binlog.</i></td>
  </tr>

  <tr>
    <td><i>MYSQL_TYPE_SET</i></td><td><i>248</i></td>
    <td>&ndash;</td>
    <td><i>This enumeration value is only used internally and cannot
    exist in a binlog.</i></td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_TINY_BLOB</td><td>249</td>
    <td>&ndash;</td>
    <td><i>This enumeration value is only used internally and cannot
    exist in a binlog.</i></td>
  </tr>

  <tr>
    <td><i>MYSQL_TYPE_MEDIUM_BLOB</i></td><td><i>250</i></td>
    <td>&ndash;</td>
    <td><i>This enumeration value is only used internally and cannot
    exist in a binlog.</i></td>
  </tr>

  <tr>
    <td><i>MYSQL_TYPE_LONG_BLOB</i></td><td><i>251</i></td>
    <td>&ndash;</td>
    <td><i>This enumeration value is only used internally and cannot
    exist in a binlog.</i></td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_BLOB</td><td>252</td>
    <td>1 byte</td>
    <td>The pack length, i.e., the number of bytes needed to represent
    the length of the blob: 1, 2, 3, or 4.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_VAR_STRING</td><td>253</td>
    <td>2 bytes</td>
    <td>This is used to store both strings and enumeration values.
    The first byte is a enumeration value storing the <i>real
    type</i>, which may be either MYSQL_TYPE_VAR_STRING or
    MYSQL_TYPE_ENUM.  The second byte is a 1 byte unsigned integer
    representing the field size, i.e., the number of bytes needed to
    store the length of the string.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_STRING</td><td>254</td>
    <td>2 bytes</td>
    <td>The first byte is always MYSQL_TYPE_VAR_STRING (i.e., 253).
    The second byte is the field size, i.e., the number of bytes in
    the representation of size of the string: 3 or 4.</td>
  </tr>

  <tr>
    <td>MYSQL_TYPE_GEOMETRY</td><td>255</td>
    <td>1 byte</td>
    <td>The pack length, i.e., the number of bytes needed to represent
    the length of the geometry: 1, 2, 3, or 4.</td>
  </tr>

  </table>
3195
*/
3196 3197 3198 3199 3200 3201 3202 3203 3204
class Table_map_log_event : public Log_event
{
public:
  /* Constants */
  enum
  {
    TYPE_CODE = TABLE_MAP_EVENT
  };

3205 3206 3207
  /**
     Enumeration of the errors that can be returned.
   */
3208 3209
  enum enum_error
  {
3210 3211 3212 3213 3214 3215
    ERR_OPEN_FAILURE = -1,               /**< Failure to open table */
    ERR_OK = 0,                                 /**< No error */
    ERR_TABLE_LIMIT_EXCEEDED = 1,      /**< No more room for tables */
    ERR_OUT_OF_MEM = 2,                         /**< Out of memory */
    ERR_BAD_TABLE_DEF = 3,     /**< Table definition does not match */
    ERR_RBR_TO_SBR = 4  /**< daisy-chanining RBR to SBR not allowed */
3216 3217 3218 3219 3220 3221
  };

  enum enum_flag
  {
    /* 
       Nothing here right now, but the flags support is there in
3222 3223 3224
       preparation for changes that are coming.  Need to add a
       constant to make it compile under HP-UX: aCC does not like
       empty enumerations.
3225
    */
3226
    ENUM_FLAG_COUNT
3227 3228 3229 3230 3231 3232 3233
  };

  typedef uint16 flag_set;

  /* Special constants representing sets of flags */
  enum 
  {
mats@mysql.com's avatar
mats@mysql.com committed
3234
    TM_NO_FLAGS = 0U
3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
  };

  void set_flags(flag_set flag) { m_flags |= flag; }
  void clear_flags(flag_set flag) { m_flags &= ~flag; }
  flag_set get_flags(flag_set flag) const { return m_flags & flag; }

#ifndef MYSQL_CLIENT
  Table_map_log_event(THD *thd, TABLE *tbl, ulong tid, 
		      bool is_transactional, uint16 flags);
#endif
#ifdef HAVE_REPLICATION
  Table_map_log_event(const char *buf, uint event_len, 
                      const Format_description_log_event *description_event);
#endif

  ~Table_map_log_event();

3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262
#ifdef MYSQL_CLIENT
  table_def *create_table_def()
  {
    return new table_def(m_coltype, m_colcnt, m_field_metadata,
                         m_field_metadata_size, m_null_bits);
  }
  ulong get_table_id() const        { return m_table_id; }
  const char *get_table_name() const { return m_tblnam; }
  const char *get_db_name() const    { return m_dbnam; }
#endif

3263
  virtual Log_event_type get_type_code() { return TABLE_MAP_EVENT; }
3264
  virtual bool is_valid() const { return m_memory != NULL; /* we check malloc */ }
3265 3266 3267

  virtual int get_data_size() { return m_data_size; } 
#ifndef MYSQL_CLIENT
3268
  virtual int save_field_metadata();
3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283
  virtual bool write_data_header(IO_CACHE *file);
  virtual bool write_data_body(IO_CACHE *file);
  virtual const char *get_db() { return m_dbnam; }
#endif

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
  virtual void pack_info(Protocol *protocol);
#endif

#ifdef MYSQL_CLIENT
  virtual void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
#endif


private:
3284
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3285 3286 3287
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
3288 3289
#endif

3290
#ifndef MYSQL_CLIENT
3291
  TABLE         *m_table;
3292 3293
#endif
  char const    *m_dbnam;
3294
  size_t         m_dblen;
3295
  char const    *m_tblnam;
3296
  size_t         m_tbllen;
3297
  ulong          m_colcnt;
3298
  uchar         *m_coltype;
3299

3300
  uchar         *m_memory;
3301 3302 3303
  ulong          m_table_id;
  flag_set       m_flags;

3304
  size_t         m_data_size;
3305 3306 3307

  uchar          *m_field_metadata;        // buffer for field metadata
  /*
3308
    The size of field metadata buffer set by calling save_field_metadata()
3309 3310 3311 3312
  */
  ulong          m_field_metadata_size;   
  uchar         *m_null_bits;
  uchar         *m_meta_memory;
3313 3314 3315
};


3316 3317
/**
  @class Rows_log_event
3318

3319
 Common base class for all row-containing log events.
3320 3321 3322 3323 3324 3325 3326

 RESPONSIBILITIES

   Encode the common parts of all events containing rows, which are:
   - Write data header and data body to an IO_CACHE.
   - Provide an interface for adding an individual row to the event.

3327 3328
  @section Rows_log_event_binary_format Binary Format
*/
3329

3330

3331 3332 3333
class Rows_log_event : public Log_event
{
public:
3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346
  /**
     Enumeration of the errors that can be returned.
   */
  enum enum_error
  {
    ERR_OPEN_FAILURE = -1,               /**< Failure to open table */
    ERR_OK = 0,                                 /**< No error */
    ERR_TABLE_LIMIT_EXCEEDED = 1,      /**< No more room for tables */
    ERR_OUT_OF_MEM = 2,                         /**< Out of memory */
    ERR_BAD_TABLE_DEF = 3,     /**< Table definition does not match */
    ERR_RBR_TO_SBR = 4  /**< daisy-chanining RBR to SBR not allowed */
  };

3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362
  /*
    These definitions allow you to combine the flags into an
    appropriate flag set using the normal bitwise operators.  The
    implicit conversion from an enum-constant to an integer is
    accepted by the compiler, which is then used to set the real set
    of flags.
  */
  enum enum_flag
  {
    /* Last event of a statement */
    STMT_END_F = (1U << 0),

    /* Value of the OPTION_NO_FOREIGN_KEY_CHECKS flag in thd->options */
    NO_FOREIGN_KEY_CHECKS_F = (1U << 1),

    /* Value of the OPTION_RELAXED_UNIQUE_CHECKS flag in thd->options */
3363 3364 3365 3366 3367 3368 3369
    RELAXED_UNIQUE_CHECKS_F = (1U << 2),

    /** 
      Indicates that rows in this event are complete, that is contain
      values for all columns of the table.
     */
    COMPLETE_ROWS_F = (1U << 3)
3370 3371 3372 3373 3374 3375 3376
  };

  typedef uint16 flag_set;

  /* Special constants representing sets of flags */
  enum 
  {
3377
      RLE_NO_FLAGS = 0U
3378 3379 3380 3381
  };

  virtual ~Rows_log_event();

3382 3383 3384
  void set_flags(flag_set flags_arg) { m_flags |= flags_arg; }
  void clear_flags(flag_set flags_arg) { m_flags &= ~flags_arg; }
  flag_set get_flags(flag_set flags_arg) const { return m_flags & flags_arg; }
3385 3386 3387 3388 3389 3390 3391 3392

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
  virtual void pack_info(Protocol *protocol);
#endif

#ifdef MYSQL_CLIENT
  /* not for direct call, each derived has its own ::print() */
  virtual void print(FILE *file, PRINT_EVENT_INFO *print_event_info)= 0;
3393 3394 3395 3396 3397 3398
  void print_verbose(IO_CACHE *file,
                     PRINT_EVENT_INFO *print_event_info);
  size_t print_verbose_one_row(IO_CACHE *file, table_def *td,
                               PRINT_EVENT_INFO *print_event_info,
                               MY_BITMAP *cols_bitmap,
                               const uchar *ptr, const uchar *prefix);
3399 3400 3401
#endif

#ifndef MYSQL_CLIENT
3402
  int add_row_data(uchar *data, size_t length)
3403 3404 3405 3406 3407 3408
  {
    return do_add_row_data(data,length); 
  }
#endif

  /* Member functions to implement superclass interface */
3409
  virtual int get_data_size();
3410 3411

  MY_BITMAP const *get_cols() const { return &m_cols; }
3412
  size_t get_width() const          { return m_width; }
3413 3414 3415 3416 3417 3418 3419
  ulong get_table_id() const        { return m_table_id; }

#ifndef MYSQL_CLIENT
  virtual bool write_data_header(IO_CACHE *file);
  virtual bool write_data_body(IO_CACHE *file);
  virtual const char *get_db() { return m_table->s->db.str; }
#endif
3420 3421 3422 3423 3424 3425
  /*
    Check that malloc() succeeded in allocating memory for the rows
    buffer and the COLS vector. Checking that an Update_rows_log_event
    is valid is done in the Update_rows_log_event::is_valid()
    function.
  */
3426 3427 3428 3429 3430
  virtual bool is_valid() const
  {
    return m_rows_buf && m_cols.bitmap;
  }

3431
  uint     m_row_count;         /* The number of rows added to the event */
3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445

protected:
  /* 
     The constructors are protected since you're supposed to inherit
     this class, not create instances of this class.
  */
#ifndef MYSQL_CLIENT
  Rows_log_event(THD*, TABLE*, ulong table_id, 
		 MY_BITMAP const *cols, bool is_transactional);
#endif
  Rows_log_event(const char *row_data, uint event_len, 
		 Log_event_type event_type,
		 const Format_description_log_event *description_event);

3446 3447 3448 3449
#ifdef MYSQL_CLIENT
  void print_helper(FILE *, PRINT_EVENT_INFO *, char const *const name);
#endif

3450
#ifndef MYSQL_CLIENT
3451
  virtual int do_add_row_data(uchar *data, size_t length);
3452 3453 3454 3455 3456 3457 3458 3459
#endif

#ifndef MYSQL_CLIENT
  TABLE *m_table;		/* The table the rows belong to */
#endif
  ulong       m_table_id;	/* Table ID */
  MY_BITMAP   m_cols;		/* Bitmap denoting columns available */
  ulong       m_width;          /* The width of the columns bitmap */
3460 3461 3462 3463 3464 3465 3466 3467 3468
  /*
    Bitmap for columns available in the after image, if present. These
    fields are only available for Update_rows events. Observe that the
    width of both the before image COLS vector and the after image
    COLS vector is the same: the number of columns of the table on the
    master.
  */
  MY_BITMAP   m_cols_ai;

3469
  ulong       m_master_reclength; /* Length of record on master side */
3470

3471
  /* Bit buffers in the same memory as the class */
3472
  uint32    m_bitbuf[128/(sizeof(uint32)*8)];
3473
  uint32    m_bitbuf_ai[128/(sizeof(uint32)*8)];
3474

3475 3476 3477
  uchar    *m_rows_buf;		/* The rows in packed format */
  uchar    *m_rows_cur;		/* One-after the end of the data */
  uchar    *m_rows_end;		/* One-after the end of the allocated space */
3478 3479

  flag_set m_flags;		/* Flags for row-level events */
3480 3481 3482 3483

  /* helper functions */

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
3484 3485 3486 3487 3488 3489
  const uchar *m_curr_row;     /* Start of the row being processed */
  const uchar *m_curr_row_end; /* One-after the end of the current row */
  uchar    *m_key;      /* Buffer to keep key value during searches */

  int find_row(const Relay_log_info *const);
  int write_row(const Relay_log_info *const, const bool);
3490 3491

  // Unpack the current row into m_table->record[0]
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
3492
  int unpack_current_row(const Relay_log_info *const rli)
3493 3494
  { 
    DBUG_ASSERT(m_table);
3495 3496 3497
    ASSERT_OR_RETURN_ERROR(m_curr_row < m_rows_end, HA_ERR_CORRUPT_EVENT);
    int const result= ::unpack_row(rli, m_table, m_width, m_curr_row, &m_cols,
                                   &m_curr_row_end, &m_master_reclength);
3498 3499
    if (m_curr_row_end > m_rows_end)
      my_error(ER_SLAVE_CORRUPT_EVENT, MYF(0));
3500 3501
    ASSERT_OR_RETURN_ERROR(m_curr_row_end <= m_rows_end, HA_ERR_CORRUPT_EVENT);
    return result;
3502 3503
  }
#endif
3504 3505 3506 3507

private:

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3508 3509 3510
  virtual int do_apply_event(Relay_log_info const *rli);
  virtual int do_update_pos(Relay_log_info *rli);
  virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
3511

3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527
  /*
    Primitive to prepare for a sequence of row executions.

    DESCRIPTION

      Before doing a sequence of do_prepare_row() and do_exec_row()
      calls, this member function should be called to prepare for the
      entire sequence. Typically, this member function will allocate
      space for any buffers that are needed for the two member
      functions mentioned above.

    RETURN VALUE

      The member function will return 0 if all went OK, or a non-zero
      error code otherwise.
  */
3528 3529
  virtual 
  int do_before_row_operations(const Slave_reporting_capability *const log) = 0;
3530 3531 3532 3533 3534 3535 3536 3537 3538

  /*
    Primitive to clean up after a sequence of row executions.

    DESCRIPTION
    
      After doing a sequence of do_prepare_row() and do_exec_row(),
      this member function should be called to clean up and release
      any allocated buffers.
3539 3540 3541 3542
      
      The error argument, if non-zero, indicates an error which happened during
      row processing before this function was called. In this case, even if 
      function is successful, it should return the error code given in the argument.
3543
  */
3544 3545 3546
  virtual 
  int do_after_row_operations(const Slave_reporting_capability *const log,
                              int error) = 0;
3547 3548 3549 3550 3551 3552

  /*
    Primitive to do the actual execution necessary for a row.

    DESCRIPTION
      The member function will do the actual execution needed to handle a row.
3553 3554 3555
      The row is located at m_curr_row. When the function returns, 
      m_curr_row_end should point at the next row (one byte after the end
      of the current row).    
3556 3557 3558 3559 3560

    RETURN VALUE
      0 if execution succeeded, 1 if execution failed.
      
  */
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
3561
  virtual int do_exec_row(const Relay_log_info *const rli) = 0;
3562 3563
#endif /* !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION) */

3564 3565
  friend class Old_rows_log_event;
};
3566

3567 3568
/**
  @class Write_rows_log_event
3569 3570 3571 3572 3573

  Log row insertions and updates. The event contain several
  insert/update rows for a table. Note that each event contains only
  rows for one table.

3574 3575
  @section Write_rows_log_event_binary_format Binary Format
*/
3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592
class Write_rows_log_event : public Rows_log_event
{
public:
  enum 
  {
    /* Support interface to THD::binlog_prepare_pending_rows_event */
    TYPE_CODE = WRITE_ROWS_EVENT
  };

#if !defined(MYSQL_CLIENT)
  Write_rows_log_event(THD*, TABLE*, ulong table_id, 
		       MY_BITMAP const *cols, bool is_transactional);
#endif
#ifdef HAVE_REPLICATION
  Write_rows_log_event(const char *buf, uint event_len, 
                       const Format_description_log_event *description_event);
#endif
3593
#if !defined(MYSQL_CLIENT) 
3594 3595 3596 3597
  static bool binlog_row_logging_function(THD *thd, TABLE *table,
                                          bool is_transactional,
                                          MY_BITMAP *cols,
                                          uint fields,
3598
                                          const uchar *before_record
3599
                                          __attribute__((unused)),
3600
                                          const uchar *after_record)
3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614
  {
    return thd->binlog_write_row(table, is_transactional,
                                 cols, fields, after_record);
  }
#endif

private:
  virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }

#ifdef MYSQL_CLIENT
  void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
#endif

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3615 3616
  virtual int do_before_row_operations(const Slave_reporting_capability *const);
  virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
3617
  virtual int do_exec_row(const Relay_log_info *const);
3618 3619 3620 3621
#endif
};


3622 3623
/**
  @class Update_rows_log_event
3624 3625 3626 3627 3628 3629 3630 3631

  Log row updates with a before image. The event contain several
  update rows for a table. Note that each event contains only rows for
  one table.

  Also note that the row data consists of pairs of row data: one row
  for the old data and one row for the new data.

3632 3633
  @section Update_rows_log_event_binary_format Binary Format
*/
3634 3635 3636 3637 3638 3639 3640 3641 3642 3643
class Update_rows_log_event : public Rows_log_event
{
public:
  enum 
  {
    /* Support interface to THD::binlog_prepare_pending_rows_event */
    TYPE_CODE = UPDATE_ROWS_EVENT
  };

#ifndef MYSQL_CLIENT
3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
  Update_rows_log_event(THD*, TABLE*, ulong table_id,
			MY_BITMAP const *cols_bi,
			MY_BITMAP const *cols_ai,
                        bool is_transactional);

  Update_rows_log_event(THD*, TABLE*, ulong table_id,
			MY_BITMAP const *cols,
                        bool is_transactional);

  void init(MY_BITMAP const *cols);
3654 3655
#endif

3656 3657
  virtual ~Update_rows_log_event();

3658 3659 3660 3661 3662
#ifdef HAVE_REPLICATION
  Update_rows_log_event(const char *buf, uint event_len, 
			const Format_description_log_event *description_event);
#endif

3663
#if !defined(MYSQL_CLIENT) 
3664 3665 3666 3667
  static bool binlog_row_logging_function(THD *thd, TABLE *table,
                                          bool is_transactional,
                                          MY_BITMAP *cols,
                                          uint fields,
3668 3669
                                          const uchar *before_record,
                                          const uchar *after_record)
3670 3671 3672 3673 3674 3675
  {
    return thd->binlog_update_row(table, is_transactional,
                                  cols, fields, before_record, after_record);
  }
#endif

3676 3677 3678 3679 3680
  virtual bool is_valid() const
  {
    return Rows_log_event::is_valid() && m_cols_ai.bitmap;
  }

3681
protected:
3682 3683 3684 3685 3686 3687 3688
  virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }

#ifdef MYSQL_CLIENT
  void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
#endif

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3689 3690
  virtual int do_before_row_operations(const Slave_reporting_capability *const);
  virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
3691
  virtual int do_exec_row(const Relay_log_info *const);
3692 3693 3694
#endif /* !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION) */
};

3695 3696
/**
  @class Delete_rows_log_event
3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712

  Log row deletions. The event contain several delete rows for a
  table. Note that each event contains only rows for one table.

  RESPONSIBILITIES

    - Act as a container for rows that has been deleted on the master
      and should be deleted on the slave. 

  COLLABORATION

    Row_writer
      Create the event and add rows to the event.
    Row_reader
      Extract the rows from the event.

3713 3714
  @section Delete_rows_log_event_binary_format Binary Format
*/
3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731
class Delete_rows_log_event : public Rows_log_event
{
public:
  enum 
  {
    /* Support interface to THD::binlog_prepare_pending_rows_event */
    TYPE_CODE = DELETE_ROWS_EVENT
  };

#ifndef MYSQL_CLIENT
  Delete_rows_log_event(THD*, TABLE*, ulong, 
			MY_BITMAP const *cols, bool is_transactional);
#endif
#ifdef HAVE_REPLICATION
  Delete_rows_log_event(const char *buf, uint event_len, 
			const Format_description_log_event *description_event);
#endif
3732
#if !defined(MYSQL_CLIENT) 
3733 3734 3735 3736
  static bool binlog_row_logging_function(THD *thd, TABLE *table,
                                          bool is_transactional,
                                          MY_BITMAP *cols,
                                          uint fields,
3737 3738
                                          const uchar *before_record,
                                          const uchar *after_record
3739 3740 3741 3742 3743 3744 3745
                                          __attribute__((unused)))
  {
    return thd->binlog_delete_row(table, is_transactional,
                                  cols, fields, before_record);
  }
#endif
  
3746
protected:
3747 3748 3749 3750 3751 3752 3753
  virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }

#ifdef MYSQL_CLIENT
  void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
#endif

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3754 3755
  virtual int do_before_row_operations(const Slave_reporting_capability *const);
  virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
rafal@quant.(none)'s avatar
rafal@quant.(none) committed
3756
  virtual int do_exec_row(const Relay_log_info *const);
3757 3758 3759
#endif
};

3760

3761 3762
#include "log_event_old.h"

3763
/**
3764 3765
  @class Incident_log_event

3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776
   Class representing an incident, an occurance out of the ordinary,
   that happened on the master.

   The event is used to inform the slave that something out of the
   ordinary happened on the master that might cause the database to be
   in an inconsistent state.

   <table id="IncidentFormat">
   <caption>Incident event format</caption>
   <tr>
     <th>Symbol</th>
3777
     <th>Format</th>
3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
     <th>Description</th>
   </tr>
   <tr>
     <td>INCIDENT</td>
     <td align="right">2</td>
     <td>Incident number as an unsigned integer</td>
   </tr>
   <tr>
     <td>MSGLEN</td>
     <td align="right">1</td>
     <td>Message length as an unsigned integer</td>
   </tr>
   <tr>
     <td>MESSAGE</td>
     <td align="right">MSGLEN</td>
     <td>The message, if present. Not null terminated.</td>
   </tr>
   </table>
3796 3797 3798

  @section Delete_rows_log_event_binary_format Binary Format
*/
3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835
class Incident_log_event : public Log_event {
public:
#ifndef MYSQL_CLIENT
  Incident_log_event(THD *thd_arg, Incident incident)
    : Log_event(thd_arg, 0, FALSE), m_incident(incident)
  {
    DBUG_ENTER("Incident_log_event::Incident_log_event");
    DBUG_PRINT("enter", ("m_incident: %d", m_incident));
    m_message.str= NULL;                    /* Just as a precaution */
    m_message.length= 0;
    DBUG_VOID_RETURN;
  }

  Incident_log_event(THD *thd_arg, Incident incident, LEX_STRING const msg)
    : Log_event(thd_arg, 0, FALSE), m_incident(incident)
  {
    DBUG_ENTER("Incident_log_event::Incident_log_event");
    DBUG_PRINT("enter", ("m_incident: %d", m_incident));
    m_message= msg;
    DBUG_VOID_RETURN;
  }
#endif

#ifndef MYSQL_CLIENT
  void pack_info(Protocol*);
#endif

  Incident_log_event(const char *buf, uint event_len,
                     const Format_description_log_event *descr_event);

  virtual ~Incident_log_event();

#ifdef MYSQL_CLIENT
  virtual void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
#endif

#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3836
  virtual int do_apply_event(Relay_log_info const *rli);
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855
#endif

  virtual bool write_data_header(IO_CACHE *file);
  virtual bool write_data_body(IO_CACHE *file);

  virtual Log_event_type get_type_code() { return INCIDENT_EVENT; }

  virtual bool is_valid() const { return 1; }
  virtual int get_data_size() {
    return INCIDENT_HEADER_LEN + 1 + m_message.length;
  }

private:
  const char *description() const;

  Incident m_incident;
  LEX_STRING m_message;
};

3856 3857 3858 3859 3860 3861 3862 3863
static inline bool copy_event_cache_to_file_and_reinit(IO_CACHE *cache,
                                                       FILE *file)
{
  return         
    my_b_copy_to_file(cache, file) ||
    reinit_io_cache(cache, WRITE_CACHE, 0, FALSE, TRUE);
}

3864 3865 3866 3867
/**
  @} (end of group Replication)
*/

3868
#endif /* _log_event_h */