← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/log.h

  • Committer: Brian Aker
  • Date: 2008-10-29 13:46:43 UTC
  • Revision ID: brian@tangent.org-20081029134643-z6jcwjvyruhk2vlu
Updates for ignore file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/log.h
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 Sun Microsystems
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 *  This program is distributed in the hope that it will be useful,
 
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *  GNU General Public License for more details.
 
14
 *
 
15
 *  You should have received a copy of the GNU General Public License
 
16
 *  along with this program; if not, write to the Free Software
 
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 */
 
19
 
 
20
#ifndef DRIZZLE_SERVER_LOG_H
 
21
#define DRIZZLE_SERVER_LOG_H
 
22
 
 
23
#include <mysys/iocache.h>
 
24
 
 
25
class Relay_log_info;
 
26
 
 
27
class Format_description_log_event;
 
28
 
 
29
/*
 
30
  Transaction Coordinator log - a base abstract class
 
31
  for two different implementations
 
32
*/
 
33
class TC_LOG
 
34
{
 
35
  public:
 
36
  int using_heuristic_recover();
 
37
  TC_LOG() {}
 
38
  virtual ~TC_LOG() {}
 
39
 
 
40
  virtual int open(const char *opt_name)=0;
 
41
  virtual void close()=0;
 
42
  virtual int log_xid(Session *session, my_xid xid)=0;
 
43
  virtual void unlog(ulong cookie, my_xid xid)=0;
 
44
};
 
45
 
 
46
class TC_LOG_DUMMY: public TC_LOG // use it to disable the logging
 
47
{
 
48
public:
 
49
  TC_LOG_DUMMY() {}
 
50
  int open(const char *opt_name __attribute__((unused)))
 
51
  { return 0; }
 
52
  void close(void)                          { }
 
53
  int log_xid(Session *session __attribute__((unused)),
 
54
              my_xid xid __attribute__((unused)))         { return 1; }
 
55
  void unlog(ulong cookie __attribute__((unused)),
 
56
             my_xid xid __attribute__((unused)))  { }
 
57
};
 
58
 
 
59
#ifdef HAVE_MMAP
 
60
class TC_LOG_MMAP: public TC_LOG
 
61
{
 
62
  public:                // only to keep Sun Forte on sol9x86 happy
 
63
  typedef enum {
 
64
    POOL,                 // page is in pool
 
65
    ERROR,                // last sync failed
 
66
    DIRTY                 // new xids added since last sync
 
67
  } PAGE_STATE;
 
68
 
 
69
  private:
 
70
  typedef struct st_page {
 
71
    struct st_page *next; // page a linked in a fifo queue
 
72
    my_xid *start, *end;  // usable area of a page
 
73
    my_xid *ptr;          // next xid will be written here
 
74
    int size, free;       // max and current number of free xid slots on the page
 
75
    int waiters;          // number of waiters on condition
 
76
    PAGE_STATE state;     // see above
 
77
    pthread_mutex_t lock; // to access page data or control structure
 
78
    pthread_cond_t  cond; // to wait for a sync
 
79
  } PAGE;
 
80
 
 
81
  char logname[FN_REFLEN];
 
82
  File fd;
 
83
  my_off_t file_length;
 
84
  uint32_t npages, inited;
 
85
  unsigned char *data;
 
86
  struct st_page *pages, *syncing, *active, *pool, *pool_last;
 
87
  /*
 
88
    note that, e.g. LOCK_active is only used to protect
 
89
    'active' pointer, to protect the content of the active page
 
90
    one has to use active->lock.
 
91
    Same for LOCK_pool and LOCK_sync
 
92
  */
 
93
  pthread_mutex_t LOCK_active, LOCK_pool, LOCK_sync;
 
94
  pthread_cond_t COND_pool, COND_active;
 
95
 
 
96
  public:
 
97
  TC_LOG_MMAP(): inited(0) {}
 
98
  int open(const char *opt_name);
 
99
  void close();
 
100
  int log_xid(Session *session, my_xid xid);
 
101
  void unlog(ulong cookie, my_xid xid);
 
102
  int recover();
 
103
 
 
104
  private:
 
105
  void get_active_from_pool();
 
106
  int sync();
 
107
  int overflow();
 
108
};
 
109
#else
 
110
#define TC_LOG_MMAP TC_LOG_DUMMY
 
111
#endif
 
112
 
 
113
extern TC_LOG *tc_log;
 
114
extern TC_LOG_MMAP tc_log_mmap;
 
115
extern TC_LOG_DUMMY tc_log_dummy;
 
116
 
 
117
/* log info errors */
 
118
#define LOG_INFO_EOF -1
 
119
#define LOG_INFO_IO  -2
 
120
#define LOG_INFO_INVALID -3
 
121
#define LOG_INFO_SEEK -4
 
122
#define LOG_INFO_MEM -6
 
123
#define LOG_INFO_FATAL -7
 
124
#define LOG_INFO_IN_USE -8
 
125
#define LOG_INFO_EMFILE -9
 
126
 
 
127
 
 
128
/* bitmap to SQL_LOG::close() */
 
129
#define LOG_CLOSE_INDEX         1
 
130
#define LOG_CLOSE_TO_BE_OPENED  2
 
131
#define LOG_CLOSE_STOP_EVENT    4
 
132
 
 
133
class Relay_log_info;
 
134
 
 
135
typedef struct st_log_info
 
136
{
 
137
  char log_file_name[FN_REFLEN];
 
138
  my_off_t index_file_offset, index_file_start_offset;
 
139
  my_off_t pos;
 
140
  bool fatal; // if the purge happens to give us a negative offset
 
141
  pthread_mutex_t lock;
 
142
  st_log_info()
 
143
    : index_file_offset(0), index_file_start_offset(0),
 
144
      pos(0), fatal(0)
 
145
    {
 
146
      log_file_name[0] = '\0';
 
147
      pthread_mutex_init(&lock, MY_MUTEX_INIT_FAST);
 
148
    }
 
149
  ~st_log_info() { pthread_mutex_destroy(&lock);}
 
150
} LOG_INFO;
 
151
 
 
152
/*
 
153
  Currently we have only 3 kinds of logging functions: old-fashioned
 
154
  logs, stdout and csv logging routines.
 
155
*/
 
156
#define MAX_LOG_HANDLERS_NUM 3
 
157
 
 
158
/* log event handler flags */
 
159
#define LOG_NONE       1
 
160
#define LOG_FILE       2
 
161
 
 
162
class Log_event;
 
163
class Rows_log_event;
 
164
 
 
165
enum enum_log_type { LOG_UNKNOWN, LOG_NORMAL, LOG_BIN };
 
166
enum enum_log_state { LOG_OPENED, LOG_CLOSED, LOG_TO_BE_OPENED };
 
167
 
 
168
/*
 
169
  TODO use mmap instead of IO_CACHE for binlog
 
170
  (mmap+fsync is two times faster than write+fsync)
 
171
*/
 
172
 
 
173
class DRIZZLE_LOG
 
174
{
 
175
public:
 
176
  DRIZZLE_LOG();
 
177
  void init_pthread_objects();
 
178
  void cleanup();
 
179
  bool open(const char *log_name,
 
180
            enum_log_type log_type,
 
181
            const char *new_name,
 
182
            enum cache_type io_cache_type_arg);
 
183
  void init(enum_log_type log_type_arg,
 
184
            enum cache_type io_cache_type_arg);
 
185
  void close(uint32_t exiting);
 
186
  inline bool is_open() { return log_state != LOG_CLOSED; }
 
187
  const char *generate_name(const char *log_name, const char *suffix,
 
188
                            bool strip_ext, char *buff);
 
189
  int generate_new_name(char *new_name, const char *log_name);
 
190
 protected:
 
191
  /* LOCK_log is inited by init_pthread_objects() */
 
192
  pthread_mutex_t LOCK_log;
 
193
  char *name;
 
194
  char log_file_name[FN_REFLEN];
 
195
  char time_buff[20], db[NAME_LEN + 1];
 
196
  bool write_error, inited;
 
197
  IO_CACHE log_file;
 
198
  enum_log_type log_type;
 
199
  volatile enum_log_state log_state;
 
200
  enum cache_type io_cache_type;
 
201
  friend class Log_event;
 
202
};
 
203
 
 
204
class DRIZZLE_BIN_LOG: public TC_LOG, private DRIZZLE_LOG
 
205
{
 
206
 private:
 
207
  /* LOCK_log and LOCK_index are inited by init_pthread_objects() */
 
208
  pthread_mutex_t LOCK_index;
 
209
  pthread_mutex_t LOCK_prep_xids;
 
210
  pthread_cond_t  COND_prep_xids;
 
211
  pthread_cond_t update_cond;
 
212
  uint64_t bytes_written;
 
213
  IO_CACHE index_file;
 
214
  char index_file_name[FN_REFLEN];
 
215
  /*
 
216
     The max size before rotation (usable only if log_type == LOG_BIN: binary
 
217
     logs and relay logs).
 
218
     For a binlog, max_size should be max_binlog_size.
 
219
     For a relay log, it should be max_relay_log_size if this is non-zero,
 
220
     max_binlog_size otherwise.
 
221
     max_size is set in init(), and dynamically changed (when one does SET
 
222
     GLOBAL MAX_BINLOG_SIZE|MAX_RELAY_LOG_SIZE) by fix_max_binlog_size and
 
223
     fix_max_relay_log_size).
 
224
  */
 
225
  ulong max_size;
 
226
  long prepared_xids; /* for tc log - number of xids to remember */
 
227
  // current file sequence number for load data infile binary logging
 
228
  uint32_t file_id;
 
229
  uint32_t open_count;                          // For replication
 
230
  int readers_count;
 
231
  bool need_start_event;
 
232
  /*
 
233
    no_auto_events means we don't want any of these automatic events :
 
234
    Start/Rotate/Stop. That is, in 4.x when we rotate a relay log, we don't
 
235
    want a Rotate_log event to be written to the relay log. When we start a
 
236
    relay log etc. So in 4.x this is 1 for relay logs, 0 for binlogs.
 
237
    In 5.0 it's 0 for relay logs too!
 
238
  */
 
239
  bool no_auto_events;
 
240
 
 
241
  uint64_t m_table_map_version;
 
242
 
 
243
  int write_to_file(IO_CACHE *cache);
 
244
  /*
 
245
    This is used to start writing to a new log file. The difference from
 
246
    new_file() is locking. new_file_without_locking() does not acquire
 
247
    LOCK_log.
 
248
  */
 
249
  void new_file_without_locking();
 
250
  void new_file_impl(bool need_lock);
 
251
 
 
252
public:
 
253
  DRIZZLE_LOG::generate_name;
 
254
  DRIZZLE_LOG::is_open;
 
255
  /*
 
256
    These describe the log's format. This is used only for relay logs.
 
257
    _for_exec is used by the SQL thread, _for_queue by the I/O thread. It's
 
258
    necessary to have 2 distinct objects, because the I/O thread may be reading
 
259
    events in a different format from what the SQL thread is reading (consider
 
260
    the case of a master which has been upgraded from 5.0 to 5.1 without doing
 
261
    RESET MASTER, or from 4.x to 5.0).
 
262
  */
 
263
  Format_description_log_event *description_event_for_exec,
 
264
    *description_event_for_queue;
 
265
 
 
266
  DRIZZLE_BIN_LOG();
 
267
  /*
 
268
    note that there's no destructor ~DRIZZLE_BIN_LOG() !
 
269
    The reason is that we don't want it to be automatically called
 
270
    on exit() - but only during the correct shutdown process
 
271
  */
 
272
 
 
273
  int open(const char *opt_name);
 
274
  void close();
 
275
  int log_xid(Session *session, my_xid xid);
 
276
  void unlog(ulong cookie, my_xid xid);
 
277
  int recover(IO_CACHE *log, Format_description_log_event *fdle);
 
278
  bool is_table_mapped(Table *table) const
 
279
  {
 
280
    return table->s->table_map_version == table_map_version();
 
281
  }
 
282
 
 
283
  uint64_t table_map_version() const { return m_table_map_version; }
 
284
  void update_table_map_version() { ++m_table_map_version; }
 
285
 
 
286
  int flush_and_set_pending_rows_event(Session *session, Rows_log_event* event);
 
287
 
 
288
  void reset_bytes_written()
 
289
  {
 
290
    bytes_written = 0;
 
291
  }
 
292
  void harvest_bytes_written(uint64_t* counter)
 
293
  {
 
294
    (*counter)+=bytes_written;
 
295
    bytes_written=0;
 
296
    return;
 
297
  }
 
298
  void set_max_size(ulong max_size_arg);
 
299
  void signal_update();
 
300
  void wait_for_update_relay_log(Session* session);
 
301
  int  wait_for_update_bin_log(Session* session, const struct timespec * timeout);
 
302
  void set_need_start_event() { need_start_event = 1; }
 
303
  void init(bool no_auto_events_arg, ulong max_size);
 
304
  void init_pthread_objects();
 
305
  void cleanup();
 
306
  bool open(const char *log_name,
 
307
            enum_log_type log_type,
 
308
            const char *new_name,
 
309
            enum cache_type io_cache_type_arg,
 
310
            bool no_auto_events_arg, ulong max_size,
 
311
            bool null_created);
 
312
  bool open_index_file(const char *index_file_name_arg,
 
313
                       const char *log_name);
 
314
  /* Use this to start writing a new log file */
 
315
  void new_file();
 
316
 
 
317
  bool write(Log_event* event_info); // binary log write
 
318
  bool write(Session *session, IO_CACHE *cache, Log_event *commit_event);
 
319
 
 
320
  int  write_cache(IO_CACHE *cache, bool lock_log, bool flush_and_sync);
 
321
 
 
322
  void start_union_events(Session *session, query_id_t query_id_param);
 
323
  void stop_union_events(Session *session);
 
324
  bool is_query_in_union(Session *session, query_id_t query_id_param);
 
325
 
 
326
  /*
 
327
    v stands for vector
 
328
    invoked as appendv(buf1,len1,buf2,len2,...,bufn,lenn,0)
 
329
  */
 
330
  bool appendv(const char* buf,uint32_t len,...);
 
331
  bool append(Log_event* ev);
 
332
 
 
333
  void make_log_name(char* buf, const char* log_ident);
 
334
  bool is_active(const char* log_file_name);
 
335
  int update_log_index(LOG_INFO* linfo, bool need_update_threads);
 
336
  void rotate_and_purge(uint32_t flags);
 
337
  bool flush_and_sync();
 
338
  int purge_logs(const char *to_log, bool included,
 
339
                 bool need_mutex, bool need_update_threads,
 
340
                 uint64_t *decrease_log_space);
 
341
  int purge_logs_before_date(time_t purge_time);
 
342
  int purge_first_log(Relay_log_info* rli, bool included);
 
343
  bool reset_logs(Session* session);
 
344
  void close(uint32_t exiting);
 
345
 
 
346
  // iterating through the log index file
 
347
  int find_log_pos(LOG_INFO* linfo, const char* log_name,
 
348
                   bool need_mutex);
 
349
  int find_next_log(LOG_INFO* linfo, bool need_mutex);
 
350
  int get_current_log(LOG_INFO* linfo);
 
351
  int raw_get_current_log(LOG_INFO* linfo);
 
352
  uint32_t next_file_id();
 
353
  inline char* get_index_fname() { return index_file_name;}
 
354
  inline char* get_log_fname() { return log_file_name; }
 
355
  inline char* get_name() { return name; }
 
356
  inline pthread_mutex_t* get_log_lock() { return &LOCK_log; }
 
357
  inline IO_CACHE* get_log_file() { return &log_file; }
 
358
 
 
359
  inline void lock_index() { pthread_mutex_lock(&LOCK_index);}
 
360
  inline void unlock_index() { pthread_mutex_unlock(&LOCK_index);}
 
361
  inline IO_CACHE *get_index_file() { return &index_file;}
 
362
  inline uint32_t get_open_count() { return open_count; }
 
363
};
 
364
 
 
365
class Log_event_handler
 
366
{
 
367
public:
 
368
  Log_event_handler() {}
 
369
  virtual bool init()= 0;
 
370
  virtual void cleanup()= 0;
 
371
 
 
372
  virtual bool log_error(enum loglevel level, const char *format,
 
373
                         va_list args)= 0;
 
374
  virtual ~Log_event_handler() {}
 
375
};
 
376
 
 
377
 
 
378
/* Class which manages slow, general and error log event handlers */
 
379
class LOGGER
 
380
{
 
381
  rw_lock_t LOCK_logger;
 
382
  /* flag to check whether logger mutex is initialized */
 
383
  uint32_t inited;
 
384
 
 
385
  /* NULL-terminated arrays of log handlers */
 
386
  Log_event_handler *error_log_handler_list[MAX_LOG_HANDLERS_NUM + 1];
 
387
 
 
388
public:
 
389
 
 
390
  LOGGER() : inited(0)
 
391
  {}
 
392
  void lock_shared() { rw_rdlock(&LOCK_logger); }
 
393
  void lock_exclusive() { rw_wrlock(&LOCK_logger); }
 
394
  void unlock() { rw_unlock(&LOCK_logger); }
 
395
  bool log_command(Session *session, enum enum_server_command command);
 
396
 
 
397
  /*
 
398
    We want to initialize all log mutexes as soon as possible,
 
399
    but we cannot do it in constructor, as safe_mutex relies on
 
400
    initialization, performed by MY_INIT(). This why this is done in
 
401
    this function.
 
402
  */
 
403
  void init_base();
 
404
  bool flush_logs(Session *session);
 
405
  /* Perform basic logger cleanup. this will leave e.g. error log open. */
 
406
  void cleanup_base();
 
407
  /* Free memory. Nothing could be logged after this function is called */
 
408
  void cleanup_end();
 
409
  bool error_log_print(enum loglevel level, const char *format,
 
410
                      va_list args);
 
411
  /* we use this function to setup all enabled log event handlers */
 
412
  int set_handlers(uint32_t error_log_printer);
 
413
  void init_error_log(uint32_t error_log_printer);
 
414
};
 
415
 
 
416
enum enum_binlog_format {
 
417
  /*
 
418
    statement-based except for cases where only row-based can work (UUID()
 
419
    etc):
 
420
  */
 
421
  BINLOG_FORMAT_MIXED= 0,
 
422
  BINLOG_FORMAT_STMT= 1, // statement-based
 
423
  BINLOG_FORMAT_ROW= 2, // row_based
 
424
/*
 
425
  This value is last, after the end of binlog_format_typelib: it has no
 
426
  corresponding cell in this typelib. We use this value to be able to know if
 
427
  the user has explicitely specified a binlog format at startup or not.
 
428
*/
 
429
  BINLOG_FORMAT_UNSPEC= 3
 
430
};
 
431
extern TYPELIB binlog_format_typelib;
 
432
 
 
433
int vprint_msg_to_log(enum loglevel level, const char *format, va_list args);
 
434
void sql_print_error(const char *format, ...) __attribute__((format(printf, 1, 2)));
 
435
void sql_print_warning(const char *format, ...) __attribute__((format(printf, 1, 2)));
 
436
void sql_print_information(const char *format, ...)
 
437
  __attribute__((format(printf, 1, 2)));
 
438
typedef void (*sql_print_message_func)(const char *format, ...)
 
439
  __attribute__((format(printf, 1, 2)));
 
440
extern sql_print_message_func sql_print_message_handlers[];
 
441
 
 
442
int error_log_print(enum loglevel level, const char *format,
 
443
                    va_list args);
 
444
 
 
445
#endif /* DRIZZLE_SERVER_LOG_H */