log_event.h 51.6 KB
Newer Older
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1
/* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
2

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

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

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


18 19
#ifndef _log_event_h
#define _log_event_h
bk@work.mysql.com's avatar
bk@work.mysql.com committed
20

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

bk@work.mysql.com's avatar
bk@work.mysql.com committed
25 26 27 28 29 30 31 32
#if defined(__GNUC__) && !defined(MYSQL_CLIENT)
#pragma interface			/* gcc class implementation */
#endif

#define LOG_READ_EOF    -1
#define LOG_READ_BOGUS  -2
#define LOG_READ_IO     -3
#define LOG_READ_MEM    -5
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
33
#define LOG_READ_TRUNC  -6
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
34
#define LOG_READ_TOO_LARGE -7
bk@work.mysql.com's avatar
bk@work.mysql.com committed
35 36

#define LOG_EVENT_OFFSET 4
37 38

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

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

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

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

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

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

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

  old_sql_ex struct

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

115 116
#define NUM_LOAD_DELIM_STRS 5

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

  sql_ex_info struct

 ****************************************************************************/
122
struct sql_ex_info
123 124 125 126 127 128 129 130
{
  char* field_term;
  char* enclosed;
  char* line_term;
  char* line_start;
  char* escaped;
  int cached_new_format;
  uint8 field_term_len,enclosed_len,line_term_len,line_start_len, escaped_len;
131
  char opt_flags;
132
  char empty_flags;
133

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

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

  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.

166 167 168 169 170 171
  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).
172

173
 ****************************************************************************/
174

175 176
#define LOG_EVENT_HEADER_LEN 19     /* the fixed header length */
#define OLD_HEADER_LEN       13     /* the fixed header length in 3.23 */
177
/*
178 179 180 181 182 183
   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.
*/
184 185
#define LOG_EVENT_MINIMAL_HEADER_LEN 19

186
/* event-specific post-header sizes */
187 188 189
// 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.
190
#define QUERY_HEADER_LEN     (QUERY_HEADER_MINIMAL_LEN + 2)
191
#define LOAD_HEADER_LEN      (4 + 4 + 4 + 1 +1 + 4)
192 193
#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)
194 195 196 197
#define CREATE_FILE_HEADER_LEN 4
#define APPEND_BLOCK_HEADER_LEN 4
#define EXEC_LOAD_HEADER_LEN   4
#define DELETE_FILE_HEADER_LEN 4
198
#define FORMAT_DESCRIPTION_HEADER_LEN (START_V3_HEADER_LEN+1+LOG_EVENT_TYPES)
199 200
#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)
201

202 203
/*
   Event header offsets;
204 205
   these point to places inside the fixed header.
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
206

207
#define EVENT_TYPE_OFFSET    4
208 209
#define SERVER_ID_OFFSET     5
#define EVENT_LEN_OFFSET     9
210
#define LOG_POS_OFFSET       13
211 212
#define FLAGS_OFFSET         17

213
/* start event post-header (for v3 and v4) */
214 215 216 217

#define ST_BINLOG_VER_OFFSET  0
#define ST_SERVER_VER_OFFSET  2
#define ST_CREATED_OFFSET     (ST_SERVER_VER_OFFSET + ST_SERVER_VER_LEN)
218
#define ST_COMMON_HEADER_LEN_OFFSET (ST_CREATED_OFFSET + 4)
219

220
/* slave event post-header (this event is never written) */
221

222 223 224
#define SL_MASTER_PORT_OFFSET   8
#define SL_MASTER_POS_OFFSET    0
#define SL_MASTER_HOST_OFFSET   10
225 226 227

/* query event post-header */

228 229 230 231
#define Q_THREAD_ID_OFFSET	0
#define Q_EXEC_TIME_OFFSET	4
#define Q_DB_LEN_OFFSET		8
#define Q_ERR_CODE_OFFSET	9
232
#define Q_STATUS_VARS_LEN_OFFSET 11
233
#define Q_DATA_OFFSET		QUERY_HEADER_LEN
234 235 236 237
/* these are codes, not offsets; not more than 256 values (1 byte). */
#define Q_FLAGS2_CODE           0
#define Q_SQL_MODE_CODE         1
#define Q_CATALOG_CODE          2
238
#define Q_AUTO_INCREMENT	3
239
#define Q_CHARSET_CODE          4
240
#define Q_TIME_ZONE_CODE        5
241 242 243 244 245 246

/* Intvar event post-header */

#define I_TYPE_OFFSET        0
#define I_VAL_OFFSET         1

nick@mysql.com's avatar
nick@mysql.com committed
247 248 249 250 251
/* Rand event post-header */

#define RAND_SEED1_OFFSET 0
#define RAND_SEED2_OFFSET 8

252 253 254 255 256 257 258 259
/* 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

260 261 262 263 264
/* Load event post-header */

#define L_THREAD_ID_OFFSET   0
#define L_EXEC_TIME_OFFSET   4
#define L_SKIP_LINES_OFFSET  8
265 266
#define L_TBL_LEN_OFFSET     12
#define L_DB_LEN_OFFSET      13
267
#define L_NUM_FIELDS_OFFSET  14
268
#define L_SQL_EX_OFFSET      18
269
#define L_DATA_OFFSET        LOAD_HEADER_LEN
270

271 272 273 274
/* Rotate event post-header */

#define R_POS_OFFSET       0
#define R_IDENT_OFFSET     8
275

276 277 278
/* CF to DF handle LOAD DATA INFILE */

/* CF = "Create File" */
279 280 281
#define CF_FILE_ID_OFFSET  0
#define CF_DATA_OFFSET     CREATE_FILE_HEADER_LEN

282
/* AB = "Append Block" */
283 284 285
#define AB_FILE_ID_OFFSET  0
#define AB_DATA_OFFSET     APPEND_BLOCK_HEADER_LEN

286
/* EL = "Execute Load" */
287 288
#define EL_FILE_ID_OFFSET  0

289
/* DF = "Delete File" */
290
#define DF_FILE_ID_OFFSET  0
291

292 293 294 295 296 297
/* 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

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

301 302 303 304 305 306 307 308
/*
  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
309
  replacing flag when reading a Rotate event.
310 311 312
  I keep the defines here just to remember what they were.
*/
#ifdef TO_BE_REMOVED
313
#define LOG_EVENT_TIME_F            0x1
314
#define LOG_EVENT_FORCED_ROTATE_F   0x2
315
#endif
316 317

/*
318 319 320 321 322 323 324 325
   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).

326 327 328 329 330 331 332 333
   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.
334 335 336

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

339 340
#define LOG_EVENT_BINLOG_IN_USE_F       0x1

341
/*
342 343 344 345 346
   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).
*/
347
#define LOG_EVENT_THREAD_SPECIFIC_F 0x4
348

349 350 351 352 353 354 355 356 357 358 359 360 361
/*
  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

362
/*
363 364 365 366 367 368 369
   OPTIONS_WRITTEN_TO_BIN_LOG are the bits of thd->options which must be
   written to the binlog. OPTIONS_WRITTEN_TO_BINLOG could be written
   into the Format_description_log_event, so that if later we don't want
   to replicate a variable we did replicate, or the contrary, it's
   doable. But it should not be too hard to decide once for all of what
   we replicate and what we don't, among the fixed 32 bits of
   thd->options.
370
   I (Guilhem) have read through every option's usage, and it looks like
371 372 373 374
   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.
375
   OPTION_BIG_SELECTS is not needed (the slave thread runs with
376 377 378
   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).
379
*/
380 381 382
#define OPTIONS_WRITTEN_TO_BIN_LOG (OPTION_AUTO_IS_NULL | \
OPTION_NO_FOREIGN_KEY_CHECKS | OPTION_RELAXED_UNIQUE_CHECKS)

383 384
enum Log_event_type
{
385 386
  /*
    Every time you update this enum (when you add a type), you have to
387
    fix Format_description_log_event::Format_description_log_event().
388 389 390 391 392
  */
  UNKNOWN_EVENT= 0, START_EVENT_V3, QUERY_EVENT, STOP_EVENT, ROTATE_EVENT,
  INTVAR_EVENT, LOAD_EVENT, SLAVE_EVENT, CREATE_FILE_EVENT,
  APPEND_BLOCK_EVENT, EXEC_LOAD_EVENT, DELETE_FILE_EVENT,
  /*
393 394 395
    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)
396
  */
397
  NEW_LOAD_EVENT,
398
  RAND_EVENT, USER_VAR_EVENT,
399
  FORMAT_DESCRIPTION_EVENT,
400
  XID_EVENT,
401 402
  BEGIN_LOAD_QUERY_EVENT,
  EXECUTE_LOAD_QUERY_EVENT,
403 404 405 406 407 408

  /*
    add new events here - right above this comment!
    existing events should never change their numbers
  */

409
  ENUM_END_EVENT /* end marker */
410 411
};

412
/*
413 414 415 416 417 418
   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)

419 420 421 422 423
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
424 425 426

#ifndef MYSQL_CLIENT
class String;
427 428
class MYSQL_LOG;
class THD;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
429 430
#endif

431 432
class Format_description_log_event;

433
struct st_relay_log_info;
434

435 436 437 438 439 440 441 442 443 444 445 446 447
#ifdef MYSQL_CLIENT
/*
  A structure for mysqlbinlog to remember the last db, flags2, sql_mode etc; it
  is passed to events' print() methods, so that they print only the necessary
  USE and SET commands.
*/
typedef struct st_last_event_info
{
  // 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
448
  ulong sql_mode;		/* must be same as THD.variables.sql_mode */
449
  ulong auto_increment_increment, auto_increment_offset;
450 451
  bool charset_inited;
  char charset[6]; // 3 variables, each of them storable in 2 bytes
452
  char time_zone_str[MAX_TIME_ZONE_NAME_LENGTH];
453
  st_last_event_info()
454 455
    :flags2_inited(0), sql_mode_inited(0),
     auto_increment_increment(1),auto_increment_offset(1), charset_inited(0)
456
    {
457 458 459 460 461 462 463
      /*
        Currently we only use static LAST_EVENT_INFO objects, so zeroed at
        program's startup, but these explicit bzero() is for the day someone
        creates dynamic instances.
      */
      bzero(db, sizeof(db));
      bzero(charset, sizeof(charset));
464
      bzero(time_zone_str, sizeof(time_zone_str));
465 466 467 468 469
    }
} LAST_EVENT_INFO;
#endif


470 471 472 473 474 475 476
/*****************************************************************************

  Log_event class

  This is the abstract base class for binary log events.

 ****************************************************************************/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
477 478 479
class Log_event
{
public:
480
  /*
481 482 483 484 485 486 487 488
    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.
489
  */
490
  my_off_t log_pos;
491
  /*
492 493 494
     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.
  */
495
  char *temp_buf;
496
  /*
497 498 499 500 501 502
    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).
503
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
504
  time_t when;
505
  /* The number of seconds the query took to run on the master. */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
506
  ulong exec_time;
507 508 509
  /* Number of bytes written by write() function */
  ulong data_written;

510
  /*
511 512
    The master's server id (is preserved in the relay log; used to
    prevent from infinite loops in circular replication).
513
  */
514
  uint32 server_id;
515 516

  /*
517 518 519
    Some 16 flags. Look above for LOG_EVENT_TIME_F,
    LOG_EVENT_FORCED_ROTATE_F, LOG_EVENT_THREAD_SPECIFIC_F, and
    LOG_EVENT_SUPPRESS_USE_F for notes.
520
  */
521
  uint16 flags;
522

523
  bool cache_stmt;
524

525
#ifndef MYSQL_CLIENT
526
  THD* thd;
527

528
  Log_event();
529
  Log_event(THD* thd_arg, uint16 flags_arg, bool cache_stmt);
530
  /*
531 532 533 534 535 536 537 538 539
    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.
540
  */
541 542
  static Log_event* read_log_event(IO_CACHE* file,
				   pthread_mutex_t* log_lock,
543
                                   const Format_description_log_event *description_event);
544 545
  static int read_log_event(IO_CACHE* file, String* packet,
			    pthread_mutex_t* log_lock);
546
  /*
547 548 549
    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.
550
  */
551
  static void init_show_field_list(List<Item>* field_list);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
552
#ifdef HAVE_REPLICATION
hf@deer.mysql.r18.ru's avatar
hf@deer.mysql.r18.ru committed
553
  int net_send(Protocol *protocol, const char* log_name, my_off_t pos);
554 555 556 557
  /*
    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().
  */
hf@deer.mysql.r18.ru's avatar
hf@deer.mysql.r18.ru committed
558
  virtual void pack_info(Protocol *protocol);
559 560 561 562
  /*
    The SQL slave thread calls exec_event() to execute the event; this is where
    the slave's data is modified.
  */
563
  virtual int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
564
#endif /* HAVE_REPLICATION */
565 566 567 568 569
  virtual const char* get_db()
  {
    return thd ? thd->db : 0;
  }
#else
570
  Log_event() : temp_buf(0) {}
571
    /* avoid having to link mysqlbinlog against libpthread */
572 573
  static Log_event* read_log_event(IO_CACHE* file,
                                   const Format_description_log_event *description_event);
574
  /* print*() functions are used by mysqlbinlog */
575
  virtual void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0) = 0;
576 577
  void print_timestamp(FILE* file, time_t *ts = 0);
  void print_header(FILE* file);
578
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
579

580 581 582 583 584 585
  static void *operator new(size_t size)
  {
    return (void*) my_malloc((uint)size, MYF(MY_WME|MY_FAE));
  }
  static void operator delete(void *ptr, size_t size)
  {
586
    my_free((gptr) ptr, MYF(MY_WME|MY_ALLOW_ZERO_PTR));
587
  }
588

589
#ifndef MYSQL_CLIENT
590 591 592 593 594 595 596 597
  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)
598
  { return 0; }
599
  virtual bool write_data_body(IO_CACHE* file __attribute__((unused)))
600
  { return 0; }
601
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
602
  virtual Log_event_type get_type_code() = 0;
603
  virtual bool is_valid() const = 0;
604
  virtual bool is_artificial_event() { return 0; }
605
  inline bool get_cache_stmt() { return cache_stmt; }
606
  Log_event(const char* buf, const Format_description_log_event* description_event);
607 608 609
  virtual ~Log_event() { free_temp_buf();}
  void register_temp_buf(char* buf) { temp_buf = buf; }
  void free_temp_buf()
610 611
  {
    if (temp_buf)
612
    {
613 614
      my_free(temp_buf, MYF(0));
      temp_buf = 0;
615
    }
616
  }
617 618 619 620
  /*
    Get event length for simple events. For complicated events the length
    is calculated during write()
  */
621
  virtual int get_data_size() { return 0;}
622 623 624
  static Log_event* read_log_event(const char* buf, uint event_len,
				   const char **error,
                                   const Format_description_log_event
625
                                   *description_event);
626
  /* returns the human readable name of the event's type */
627
  const char* get_type_str();
bk@work.mysql.com's avatar
bk@work.mysql.com committed
628 629
};

630
/*
631 632 633 634 635 636 637 638 639 640 641
   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
642

643 644 645 646 647 648 649
/*****************************************************************************

  Query Log Event class

  Logs SQL queries

 ****************************************************************************/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
650 651 652 653 654 655
class Query_log_event: public Log_event
{
protected:
  char* data_buf;
public:
  const char* query;
656
  const char* catalog;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
657
  const char* db;
658 659 660 661 662 663
  /*
    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
664
  uint32 db_len;
665
  uint16 error_code;
666
  ulong thread_id;
667
  /*
668 669 670 671
    For events created by Query_log_event::exec_event (and
    Load_log_event::exec_event()) we need the *original* thread id, to be able
    to log the event with the original (=master's) thread id (fix for
    BUG#1686).
guilhem@mysql.com's avatar
guilhem@mysql.com committed
672 673
  */
  ulong slave_proxy_id;
674 675

  /*
676 677
    Binlog format 3 and 4 start to differ (as far as class members are
    concerned) from here.
678
  */
679

680
  uint catalog_len;			// <= 255 char; 0 means uninited
681

682 683
  /*
    We want to be able to store a variable number of N-bit status vars:
684 685 686
    (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.
687 688 689 690 691
    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
692 693
    '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:
694
    flags2 - sql_mode - catalog - autoinc - charset
695 696 697 698 699 700 701 702
    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;
703

704 705 706 707 708 709 710 711 712
  /*
    'flags2' is a second set of flags (on top of those in Log_event), for
    session variables. These are thd->options which is & against a mask
    (OPTIONS_WRITTEN_TO_BINLOG).
    flags2_inited helps make a difference between flags2==0 (3.23 or 4.x
    master, we don't know flags2, so use the slave server's global options) and
    flags2==0 (5.0 master, we know this has a meaning of flags all down which
    must influence the query).
  */
713
  bool flags2_inited;
714
  bool sql_mode_inited;
715
  bool charset_inited;
716 717

  uint32 flags2;
718
  /* In connections sql_mode is 32 bits now but will be 64 bits soon */
monty@mysql.com's avatar
monty@mysql.com committed
719
  ulong sql_mode;
720
  ulong auto_increment_increment, auto_increment_offset;
721
  char charset[6];
722 723
  uint time_zone_len; /* 0 means uninited */
  const char *time_zone_str;
724

725
#ifndef MYSQL_CLIENT
726

727
  Query_log_event(THD* thd_arg, const char* query_arg, ulong query_length,
728
		  bool using_trans, bool suppress_use);
729
  const char* get_db() { return db; }
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
730
#ifdef HAVE_REPLICATION
731
  void pack_info(Protocol* protocol);
732
  int exec_event(struct st_relay_log_info* rli);
733 734
  int exec_event(struct st_relay_log_info* rli, const char *query_arg,
                 uint32 q_len_arg);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
735
#endif /* HAVE_REPLICATION */
736
#else
737
  void print_query_header(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
738
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
739 740
#endif

741
  Query_log_event(const char* buf, uint event_len,
742 743
                  const Format_description_log_event *description_event,
                  Log_event_type event_type);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
744 745 746
  ~Query_log_event()
  {
    if (data_buf)
747
      my_free((gptr) data_buf, MYF(0));
bk@work.mysql.com's avatar
bk@work.mysql.com committed
748 749
  }
  Log_event_type get_type_code() { return QUERY_EVENT; }
750
#ifndef MYSQL_CLIENT
751
  bool write(IO_CACHE* file);
752 753
  virtual bool write_post_header_for_derived(IO_CACHE* file) { return FALSE; }
#endif
754
  bool is_valid() const { return query != 0; }
755 756 757 758 759 760 761

  /*
    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. */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
762 763
};

hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
764
#ifdef HAVE_REPLICATION
765

766 767 768
/*****************************************************************************

  Slave Log Event class
769 770
  Note that this class is currently not used at all; no code writes a
  Slave_log_event (though some code in repl_failsafe.cc reads Slave_log_event).
771
  So it's not a problem if this code is not maintained.
772 773

 ****************************************************************************/
774 775 776 777 778 779
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
780
  my_off_t master_pos;
781 782
  char* master_host;
  char* master_log;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
783
  int master_host_len;
784
  int master_log_len;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
785
  uint16 master_port;
786

787
#ifndef MYSQL_CLIENT
788
  Slave_log_event(THD* thd_arg, struct st_relay_log_info* rli);
789
  void pack_info(Protocol* protocol);
790
  int exec_event(struct st_relay_log_info* rli);
791
#else
792
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
793
#endif
794

795
  Slave_log_event(const char* buf, uint event_len);
796 797
  ~Slave_log_event();
  int get_data_size();
798
  bool is_valid() const { return master_host != 0; }
799
  Log_event_type get_type_code() { return SLAVE_EVENT; }
800
#ifndef MYSQL_CLIENT
801
  bool write(IO_CACHE* file);
802
#endif
803 804
};

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

807 808 809 810 811 812

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

  Load Log Event class

 ****************************************************************************/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
813 814
class Load_log_event: public Log_event
{
815 816 817 818
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
819
protected:
820
  int copy_log_event(const char *buf, ulong event_len,
821
                     int body_offset, const Format_description_log_event* description_event);
822

bk@work.mysql.com's avatar
bk@work.mysql.com committed
823
public:
824
  ulong thread_id;
guilhem@mysql.com's avatar
guilhem@mysql.com committed
825
  ulong slave_proxy_id;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
826
  uint32 table_name_len;
827 828 829 830 831
  /*
    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
832 833 834
  uint32 db_len;
  uint32 fname_len;
  uint32 num_fields;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
835 836
  const char* fields;
  const uchar* field_lens;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
837
  uint32 field_block_len;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
838 839 840 841

  const char* table_name;
  const char* db;
  const char* fname;
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
842
  uint32 skip_lines;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
843
  sql_ex_info sql_ex;
844
  bool local_fname;
845

846 847
  /* fname doesn't point to memory inside Log_event::temp_buf  */
  void set_fname_outside_temp_buf(const char *afname, uint alen)
848 849 850
  {
    fname= afname;
    fname_len= alen;
851
    local_fname= TRUE;
852
  }
853 854
  /* fname doesn't point to memory inside Log_event::temp_buf  */
  int  check_fname_outside_temp_buf()
855
  {
856
    return local_fname;
857
  }
858

859
#ifndef MYSQL_CLIENT
bk@work.mysql.com's avatar
bk@work.mysql.com committed
860 861
  String field_lens_buf;
  String fields_buf;
862

863
  Load_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
864
		 const char* table_name_arg,
865
		 List<Item>& fields_arg, enum enum_duplicates handle_dup, bool ignore,
866
		 bool using_trans);
lars@mysql.com's avatar
lars@mysql.com committed
867
  void set_fields(const char* db, List<Item> &fields_arg);
868
  const char* get_db() { return db; }
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
869
#ifdef HAVE_REPLICATION
hf@deer.mysql.r18.ru's avatar
hf@deer.mysql.r18.ru committed
870
  void pack_info(Protocol* protocol);
871
  int exec_event(struct st_relay_log_info* rli)
872
  {
873
    return exec_event(thd->slave_net,rli,0);
874
  }
875
  int exec_event(NET* net, struct st_relay_log_info* rli,
876
		 bool use_rli_only_for_errors);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
877
#endif /* HAVE_REPLICATION */
878
#else
879 880
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info = 0);
  void print(FILE* file, bool short_form, LAST_EVENT_INFO* last_event_info, bool commented);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
881 882
#endif

883 884 885 886 887 888 889
  /*
    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,
890
                 const Format_description_log_event* description_event);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
891
  ~Load_log_event()
892
  {}
893 894 895 896
  Log_event_type get_type_code()
  {
    return sql_ex.new_format() ? NEW_LOAD_EVENT: LOAD_EVENT;
  }
897
#ifndef MYSQL_CLIENT
898 899
  bool write_data_header(IO_CACHE* file);
  bool write_data_body(IO_CACHE* file);
900
#endif
901
  bool is_valid() const { return table_name != 0; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
902 903
  int get_data_size()
  {
904 905
    return (table_name_len + db_len + 2 + fname_len
	    + LOAD_HEADER_LEN
906
	    + sql_ex.data_size() + field_block_len + num_fields);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
907 908 909
  }
};

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

912 913
/*****************************************************************************

914
  Start Log Event_v3 class
915

916 917 918 919 920 921 922
  Start_log_event_v3 is the Start_log_event of binlog format 3 (MySQL 3.23 and
  4.x).
  Format_description_log_event derives from Start_log_event_v3; it is the
  Start_log_event of binlog format 4 (MySQL 5.0), that is, the event that
  describes the other events' header/postheader lengths. This event is sent by
  MySQL 5.0 whenever it starts sending a new binlog if the requested position
  is >4 (otherwise if ==4 the event will be sent naturally).
923

924
 ****************************************************************************/
925

926
class Start_log_event_v3: public Log_event
bk@work.mysql.com's avatar
bk@work.mysql.com committed
927 928
{
public:
929
  /*
930 931 932 933 934
    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
935 936
    >=4.0.14 slaves to know whether they must drop stale temporary
    tables and whether they should abort unfinished transaction.
937 938 939 940 941 942 943 944

    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:
945 946 947 948 949
     - 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.
950
  */
951
  time_t created;
952
  uint16 binlog_version;
953
  char server_version[ST_SERVER_VER_LEN];
954 955 956 957 958 959
  /*
    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;
960 961

#ifndef MYSQL_CLIENT
962
  Start_log_event_v3();
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
963
#ifdef HAVE_REPLICATION
964
  void pack_info(Protocol* protocol);
965
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
966
#endif /* HAVE_REPLICATION */
967
#else
968 969
  Start_log_event_v3() {}
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
970
#endif
971

972 973 974 975
  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;}
976
#ifndef MYSQL_CLIENT
977
  bool write(IO_CACHE* file);
978
#endif
979
  bool is_valid() const { return 1; }
980 981
  int get_data_size()
  {
982 983
    return START_V3_HEADER_LEN; //no variable-sized part
  }
984
  virtual bool is_artificial_event() { return artificial_event; }
985 986
};

987

988
/*
989 990 991 992 993 994 995 996
   For binlog version 4.
   This event is saved by threads which read it, as they need it for future
   use (to decode the ordinary events).
*/

class Format_description_log_event: public Start_log_event_v3
{
public:
997
  /*
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
     The size of the fixed header which _all_ events have
     (for binlogs written by this version, this is equal to
     LOG_EVENT_HEADER_LEN), except FORMAT_DESCRIPTION_EVENT and ROTATE_EVENT
     (those have a header of size LOG_EVENT_MINIMAL_HEADER_LEN).
  */
  uint8 common_header_len;
  uint8 number_of_event_types;
  /* The list of post-headers' lengthes */
  uint8 *post_header_len;

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

#ifndef MYSQL_CLIENT
#ifdef HAVE_REPLICATION
  int exec_event(struct st_relay_log_info* rli);
#endif /* HAVE_REPLICATION */
1014 1015
#endif

1016 1017 1018 1019
  Format_description_log_event(const char* buf, uint event_len,
                               const Format_description_log_event* description_event);
  ~Format_description_log_event() { my_free((gptr)post_header_len, MYF(0)); }
  Log_event_type get_type_code() { return FORMAT_DESCRIPTION_EVENT;}
1020
#ifndef MYSQL_CLIENT
1021
  bool write(IO_CACHE* file);
1022
#endif
1023
  bool is_valid() const
1024
  {
1025 1026 1027
    return ((common_header_len >= ((binlog_version==1) ? OLD_HEADER_LEN :
                                   LOG_EVENT_MINIMAL_HEADER_LEN)) &&
            (post_header_len != NULL));
1028 1029 1030 1031 1032 1033 1034 1035 1036
  }
  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;
1037
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1038 1039
};

1040

1041 1042 1043 1044 1045 1046 1047
/*****************************************************************************

  Intvar Log Event class

  Logs special variables such as auto_increment values

 ****************************************************************************/
1048

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1049 1050 1051 1052 1053
class Intvar_log_event: public Log_event
{
public:
  ulonglong val;
  uchar type;
1054

1055
#ifndef MYSQL_CLIENT
1056
  Intvar_log_event(THD* thd_arg,uchar type_arg, ulonglong val_arg)
1057
    :Log_event(thd_arg,0,0),val(val_arg),type(type_arg)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1058
  {}
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1059
#ifdef HAVE_REPLICATION
1060
  void pack_info(Protocol* protocol);
1061
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1062
#endif /* HAVE_REPLICATION */
1063
#else
1064
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
1065
#endif
1066

1067
  Intvar_log_event(const char* buf, const Format_description_log_event* description_event);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1068 1069
  ~Intvar_log_event() {}
  Log_event_type get_type_code() { return INTVAR_EVENT;}
1070
  const char* get_var_type_name();
1071
  int get_data_size() { return  9; /* sizeof(type) + sizeof(val) */;}
1072
#ifndef MYSQL_CLIENT
1073
  bool write(IO_CACHE* file);
1074
#endif
1075
  bool is_valid() const { return 1; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1076 1077
};

1078

nick@mysql.com's avatar
nick@mysql.com committed
1079
/*****************************************************************************
1080 1081 1082

  Rand Log Event class

1083
  Logs random seed used by the next RAND(), and by PASSWORD() in 4.1.0.
1084 1085 1086
  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).
1087

nick@mysql.com's avatar
nick@mysql.com committed
1088
 ****************************************************************************/
1089

nick@mysql.com's avatar
nick@mysql.com committed
1090 1091 1092 1093 1094 1095 1096 1097
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)
1098
    :Log_event(thd_arg,0,0),seed1(seed1_arg),seed2(seed2_arg)
nick@mysql.com's avatar
nick@mysql.com committed
1099
  {}
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1100
#ifdef HAVE_REPLICATION
1101
  void pack_info(Protocol* protocol);
nick@mysql.com's avatar
nick@mysql.com committed
1102
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1103
#endif /* HAVE_REPLICATION */
nick@mysql.com's avatar
nick@mysql.com committed
1104
#else
1105
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
nick@mysql.com's avatar
nick@mysql.com committed
1106 1107
#endif

1108
  Rand_log_event(const char* buf, const Format_description_log_event* description_event);
nick@mysql.com's avatar
nick@mysql.com committed
1109 1110
  ~Rand_log_event() {}
  Log_event_type get_type_code() { return RAND_EVENT;}
1111
  int get_data_size() { return 16; /* sizeof(ulonglong) * 2*/ }
1112
#ifndef MYSQL_CLIENT
1113
  bool write(IO_CACHE* file);
1114
#endif
1115
  bool is_valid() const { return 1; }
nick@mysql.com's avatar
nick@mysql.com committed
1116 1117
};

1118 1119 1120 1121 1122 1123 1124 1125 1126
/*****************************************************************************

  Xid Log Event class

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

 ****************************************************************************/
#ifdef MYSQL_CLIENT
1127
typedef ulonglong my_xid; // this line is the same as in handler.h
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
#endif

class Xid_log_event: public Log_event
{
 public:
   my_xid xid;

#ifndef MYSQL_CLIENT
  Xid_log_event(THD* thd_arg, my_xid x): Log_event(thd_arg,0,0), xid(x) {}
#ifdef HAVE_REPLICATION
  void pack_info(Protocol* protocol);
  int exec_event(struct st_relay_log_info* rli);
#endif /* HAVE_REPLICATION */
#else
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
#endif

  Xid_log_event(const char* buf, const Format_description_log_event* description_event);
  ~Xid_log_event() {}
  Log_event_type get_type_code() { return XID_EVENT;}
  int get_data_size() { return sizeof(xid); }
1149
#ifndef MYSQL_CLIENT
1150
  bool write(IO_CACHE* file);
1151
#endif
1152 1153
  bool is_valid() const { return 1; }
};
1154

1155 1156 1157 1158
/*****************************************************************************

  User var Log Event class

1159 1160 1161
  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.

1162 1163 1164
  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.

1165
 ****************************************************************************/
1166

1167 1168 1169 1170 1171 1172 1173 1174 1175
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;
1176
  bool is_null;
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
#ifndef MYSQL_CLIENT
  User_var_log_event(THD* thd_arg, char *name_arg, uint name_len_arg,
                     char *val_arg, ulong val_len_arg, Item_result type_arg,
		     uint charset_number_arg)
    :Log_event(), name(name_arg), name_len(name_len_arg), val(val_arg),
    val_len(val_len_arg), type(type_arg), charset_number(charset_number_arg)
    { is_null= !val; }
  void pack_info(Protocol* protocol);
  int exec_event(struct st_relay_log_info* rli);
#else
1187
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
1188 1189
#endif

1190
  User_var_log_event(const char* buf, const Format_description_log_event* description_event);
1191 1192
  ~User_var_log_event() {}
  Log_event_type get_type_code() { return USER_VAR_EVENT;}
1193
#ifndef MYSQL_CLIENT
1194
  bool write(IO_CACHE* file);
1195
#endif
1196
  bool is_valid() const { return 1; }
1197
};
1198

1199

1200 1201 1202 1203 1204
/*****************************************************************************

  Stop Log Event class

 ****************************************************************************/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1205 1206 1207
class Stop_log_event: public Log_event
{
public:
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
1208
#ifndef MYSQL_CLIENT
1209
  Stop_log_event() :Log_event()
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1210
  {}
1211 1212
  int exec_event(struct st_relay_log_info* rli);
#else
1213
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
1214
#endif
1215

1216 1217
  Stop_log_event(const char* buf, const Format_description_log_event* description_event):
    Log_event(buf, description_event)
1218
  {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1219 1220
  ~Stop_log_event() {}
  Log_event_type get_type_code() { return STOP_EVENT;}
1221
  bool is_valid() const { return 1; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1222 1223
};

1224 1225 1226 1227
/*****************************************************************************

  Rotate Log Event class

1228
  This will be deprecated when we move to using sequence ids.
1229 1230

 ****************************************************************************/
1231

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1232 1233 1234 1235
class Rotate_log_event: public Log_event
{
public:
  const char* new_log_ident;
1236
  ulonglong pos;
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1237
  uint ident_len;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1238
  bool alloced;
1239
#ifndef MYSQL_CLIENT
1240
  Rotate_log_event(THD* thd_arg, const char* new_log_ident_arg,
1241 1242
		   uint ident_len_arg = 0,
		   ulonglong pos_arg = LOG_EVENT_OFFSET)
1243
    :Log_event(), new_log_ident(new_log_ident_arg),
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1244 1245
    pos(pos_arg),ident_len(ident_len_arg ? ident_len_arg :
			   (uint) strlen(new_log_ident_arg)), alloced(0)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1246
  {}
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1247
#ifdef HAVE_REPLICATION
1248
  void pack_info(Protocol* protocol);
1249
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1250
#endif /* HAVE_REPLICATION */
1251
#else
1252
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
1253 1254
#endif

1255 1256
  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
1257 1258 1259 1260 1261 1262
  ~Rotate_log_event()
  {
    if (alloced)
      my_free((gptr) new_log_ident, MYF(0));
  }
  Log_event_type get_type_code() { return ROTATE_EVENT;}
1263
  int get_data_size() { return  ident_len + ROTATE_HEADER_LEN;}
1264
  bool is_valid() const { return new_log_ident != 0; }
1265
#ifndef MYSQL_CLIENT
1266
  bool write(IO_CACHE* file);
1267
#endif
1268 1269
};

1270

1271 1272
/* the classes below are for the new LOAD DATA INFILE logging */

1273 1274 1275
/*****************************************************************************
  Create File Log Event class
 ****************************************************************************/
1276

1277
class Create_file_log_event: public Load_log_event
1278
{
1279
protected:
1280 1281 1282 1283 1284
  /*
    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
  */
1285
  bool fake_base;
1286 1287
public:
  char* block;
1288
  const char *event_buf;
1289 1290
  uint block_len;
  uint file_id;
1291
  bool inited_from_old;
1292

1293 1294
#ifndef MYSQL_CLIENT
  Create_file_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
1295 1296
			const char* table_name_arg,
			List<Item>& fields_arg,
1297
			enum enum_duplicates handle_dup, bool ignore,
1298 1299
			char* block_arg, uint block_len_arg,
			bool using_trans);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1300
#ifdef HAVE_REPLICATION
1301
  void pack_info(Protocol* protocol);
1302
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1303
#endif /* HAVE_REPLICATION */
1304
#else
1305 1306
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
  void print(FILE* file, bool short_form, LAST_EVENT_INFO* last_event_info, bool enable_local);
1307 1308
#endif

1309 1310
  Create_file_log_event(const char* buf, uint event_len,
                        const Format_description_log_event* description_event);
1311 1312 1313 1314
  ~Create_file_log_event()
  {
    my_free((char*) event_buf, MYF(MY_ALLOW_ZERO_PTR));
  }
1315 1316

  Log_event_type get_type_code()
1317
  {
1318 1319 1320 1321 1322 1323 1324 1325
    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);
  }
1326
  bool is_valid() const { return inited_from_old || block != 0; }
1327
#ifndef MYSQL_CLIENT
1328 1329
  bool write_data_header(IO_CACHE* file);
  bool write_data_body(IO_CACHE* file);
1330 1331 1332 1333
  /*
    Cut out Create_file extentions and
    write it as Load event - used on the slave
  */
1334
  bool write_base(IO_CACHE* file);
1335
#endif
1336 1337
};

1338

1339 1340 1341 1342 1343
/*****************************************************************************

  Append Block Log Event class

 ****************************************************************************/
1344

1345 1346 1347 1348 1349 1350
class Append_block_log_event: public Log_event
{
public:
  char* block;
  uint block_len;
  uint file_id;
1351
  /*
1352 1353 1354 1355 1356 1357 1358 1359 1360
    '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.
1361 1362 1363
  */
  const char* db;

1364
#ifndef MYSQL_CLIENT
1365
  Append_block_log_event(THD* thd, const char* db_arg, char* block_arg,
1366
			 uint block_len_arg, bool using_trans);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1367
#ifdef HAVE_REPLICATION
1368
  int exec_event(struct st_relay_log_info* rli);
1369
  void pack_info(Protocol* protocol);
1370
  virtual int get_open_mode() const;
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1371
#endif /* HAVE_REPLICATION */
1372
#else
1373
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
1374
#endif
1375 1376

  Append_block_log_event(const char* buf, uint event_len,
1377
                         const Format_description_log_event* description_event);
1378
  ~Append_block_log_event() {}
1379 1380
  Log_event_type get_type_code() { return APPEND_BLOCK_EVENT;}
  int get_data_size() { return  block_len + APPEND_BLOCK_HEADER_LEN ;}
1381
  bool is_valid() const { return block != 0; }
1382
#ifndef MYSQL_CLIENT
1383
  bool write(IO_CACHE* file);
1384
#endif
1385
  const char* get_db() { return db; }
1386 1387
};

1388

1389
/*****************************************************************************
1390

1391 1392 1393
  Delete File Log Event class

 ****************************************************************************/
1394

1395 1396 1397 1398
class Delete_file_log_event: public Log_event
{
public:
  uint file_id;
1399
  const char* db; /* see comment in Append_block_log_event */
1400

1401
#ifndef MYSQL_CLIENT
1402
  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
1403
#ifdef HAVE_REPLICATION
1404
  void pack_info(Protocol* protocol);
1405
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1406
#endif /* HAVE_REPLICATION */
1407
#else
1408 1409
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
  void print(FILE* file, bool short_form, LAST_EVENT_INFO* last_event_info, bool enable_local);
1410 1411
#endif

1412 1413
  Delete_file_log_event(const char* buf, uint event_len,
                        const Format_description_log_event* description_event);
1414
  ~Delete_file_log_event() {}
1415 1416
  Log_event_type get_type_code() { return DELETE_FILE_EVENT;}
  int get_data_size() { return DELETE_FILE_HEADER_LEN ;}
1417
  bool is_valid() const { return file_id != 0; }
1418
#ifndef MYSQL_CLIENT
1419
  bool write(IO_CACHE* file);
1420
#endif
1421
  const char* get_db() { return db; }
1422 1423
};

1424

1425 1426 1427 1428 1429
/*****************************************************************************

  Execute Load Log Event class

 ****************************************************************************/
1430

1431 1432 1433 1434
class Execute_load_log_event: public Log_event
{
public:
  uint file_id;
1435
  const char* db; /* see comment in Append_block_log_event */
1436

1437
#ifndef MYSQL_CLIENT
1438
  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
1439
#ifdef HAVE_REPLICATION
1440
  void pack_info(Protocol* protocol);
1441
  int exec_event(struct st_relay_log_info* rli);
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
1442
#endif /* HAVE_REPLICATION */
1443
#else
1444
  void print(FILE* file, bool short_form = 0, LAST_EVENT_INFO* last_event_info= 0);
1445 1446 1447
#endif

  Execute_load_log_event(const char* buf, uint event_len,
1448
                         const Format_description_log_event* description_event);
1449
  ~Execute_load_log_event() {}
1450 1451
  Log_event_type get_type_code() { return EXEC_LOAD_EVENT;}
  int get_data_size() { return  EXEC_LOAD_HEADER_LEN ;}
1452
  bool is_valid() const { return file_id != 0; }
1453
#ifndef MYSQL_CLIENT
1454
  bool write(IO_CACHE* file);
1455
#endif
1456
  const char* get_db() { return db; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1457 1458
};

1459

1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
/***************************************************************************

  Begin load query Log Event class

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

****************************************************************************/
class Begin_load_query_log_event: public Append_block_log_event
{
public:
#ifndef MYSQL_CLIENT
  Begin_load_query_log_event(THD* thd_arg, const char *db_arg,
                             char* block_arg, uint block_len_arg,
                             bool using_trans);
#ifdef HAVE_REPLICATION
  Begin_load_query_log_event(THD* thd);
  int get_open_mode() const;
#endif /* HAVE_REPLICATION */
#endif
  Begin_load_query_log_event(const char* buf, uint event_len,
                             const Format_description_log_event* description_event);
  ~Begin_load_query_log_event() {}
  Log_event_type get_type_code() { return BEGIN_LOAD_QUERY_EVENT; }
};


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

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

  Execute load query Log Event class

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

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

#ifndef MYSQL_CLIENT
  Execute_load_query_log_event(THD* thd, const char* query_arg,
                       ulong query_length, uint fn_pos_start_arg,
                       uint fn_pos_end_arg,
                       enum_load_dup_handling dup_handling_arg,
                       bool using_trans, bool suppress_use);
#ifdef HAVE_REPLICATION
  void pack_info(Protocol* protocol);
  int exec_event(struct st_relay_log_info* rli);
#endif /* HAVE_REPLICATION */
#else
  void print(FILE* file, bool short_form = 0,
             LAST_EVENT_INFO* last_event_info= 0);
  /* Prints the query as LOAD DATA LOCAL and with rewritten filename */
  void print(FILE* file, bool short_form, LAST_EVENT_INFO* last_event_info,
             const char *local_fname);
#endif
  Execute_load_query_log_event(const char* buf, uint event_len,
                               const Format_description_log_event *description_event);
  ~Execute_load_query_log_event() {}

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

  ulong get_post_header_size_for_derived();
1543
#ifndef MYSQL_CLIENT
1544
  bool write_post_header_for_derived(IO_CACHE* file);
1545
#endif
1546 1547 1548
 };


1549 1550 1551 1552
#ifdef MYSQL_CLIENT
class Unknown_log_event: public Log_event
{
public:
1553 1554 1555 1556 1557 1558 1559
  /*
    Even if this is an unknown event, we still pass description_event to
    Log_event's ctor, this way we can extract maximum information from the
    event's header (the unique ID for example).
  */
  Unknown_log_event(const char* buf, const Format_description_log_event* description_event):
    Log_event(buf, description_event)
1560 1561
  {}
  ~Unknown_log_event() {}
1562
  void print(FILE* file, bool short_form= 0, LAST_EVENT_INFO* last_event_info= 0);
1563
  Log_event_type get_type_code() { return UNKNOWN_EVENT;}
1564
  bool is_valid() const { return 1; }
1565
};
1566
#endif
1567

1568
#endif /* _log_event_h */