← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/transaction_log/module.cc

Merge in Stewart's FK work

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/transaction_log/module.cc
1
1
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
3
 *
4
 
 *  Copyright (C) 2008-2009 Sun Microsystems, Inc.
5
 
 *  Copyright (C) 2010 Jay Pipes <jaypipes@gmail.com>
 
4
 *  Copyright (C) 2008-2009 Sun Microsystems
 
5
 *  Copyright (c) 2010 Jay Pipes <jaypipes@gmail.com>
6
6
 *
7
7
 *  Authors:
8
8
 *
30
30
 * registration.
31
31
 */
32
32
 
33
 
#include <config.h>
 
33
#include "config.h"
34
34
 
35
35
#include "transaction_log.h"
36
36
#include "transaction_log_applier.h"
38
38
#include "data_dictionary_schema.h"
39
39
#include "print_transaction_message.h"
40
40
#include "hexdump_transaction_message.h"
41
 
 
42
 
#include <errno.h>
 
41
#include "background_worker.h"
43
42
 
44
43
#include <drizzled/plugin/plugin.h>
45
44
#include <drizzled/session.h>
 
45
#include <drizzled/set_var.h>
46
46
#include <drizzled/gettext.h>
47
47
#include <boost/program_options.hpp>
48
48
#include <drizzled/module/option_map.h>
51
51
using namespace std;
52
52
using namespace drizzled;
53
53
 
54
 
/**
55
 
 * The name of the main transaction log file on disk.  With no prefix,
56
 
 * this goes into Drizzle's $datadir.
57
 
 */
58
 
static const char DEFAULT_LOG_FILE_PATH[]= "transaction.log"; /* In datadir... */
59
54
/** 
60
55
 * Transaction Log plugin system variable - Is the log enabled? Only used on init().  
 
56
 * The enable() and disable() methods of the TransactionLog class control online
 
57
 * disabling.
61
58
 */
62
59
static bool sysvar_transaction_log_enabled= false;
63
 
 
64
60
/** Transaction Log plugin system variable - The path to the log file used */
65
 
static string sysvar_transaction_log_file;
66
 
 
 
61
static char* sysvar_transaction_log_file= NULL;
67
62
/** 
68
63
 * Transaction Log plugin system variable - A debugging variable to assist 
69
64
 * in truncating the log file. 
70
65
 */
71
66
static bool sysvar_transaction_log_truncate_debug= false;
 
67
/**
 
68
 * The name of the main transaction log file on disk.  With no prefix,
 
69
 * this goes into Drizzle's $datadir.
 
70
 */
 
71
static const char DEFAULT_LOG_FILE_PATH[]= "transaction.log"; /* In datadir... */
72
72
/** 
73
73
 * Transaction Log plugin system variable - Should we write a CRC32 checksum for 
74
74
 * each written Transaction message?
78
78
 * Numeric option controlling the sync/flush behaviour of the transaction
79
79
 * log.  Options are:
80
80
 *
81
 
 * TransactionLog::FLUSH_FREQUENCY_OS == 0            ... let OS do sync'ing
82
 
 * TransactionLog::FLUSH_FREQUENCY_EVERY_WRITE == 1   ... sync on every write
83
 
 * TransactionLog::FLUSH_FREQUENCY_EVERY_SECOND == 2  ... sync at most once a second
 
81
 * TransactionLog::SYNC_METHOD_OS == 0            ... let OS do sync'ing
 
82
 * TransactionLog::SYNC_METHOD_EVERY_WRITE == 1   ... sync on every write
 
83
 * TransactionLog::SYNC_METHOD_EVERY_SECOND == 2  ... sync at most once a second
84
84
 */
85
 
typedef constrained_check<uint32_t, 2, 0> flush_constraint;
86
 
static flush_constraint sysvar_transaction_log_flush_frequency;
 
85
static uint32_t sysvar_transaction_log_sync_method= 0;
87
86
/**
88
87
 * Transaction Log plugin system variable - Number of slots to create
89
88
 * for managing write buffers
90
89
 */
91
 
typedef constrained_check<uint32_t, 8192, 4> write_buffers_constraint;
92
 
static write_buffers_constraint sysvar_transaction_log_num_write_buffers;
 
90
static uint32_t sysvar_transaction_log_num_write_buffers= 8;
93
91
/**
94
92
 * Transaction Log plugin system variable - The name of the replicator plugin
95
93
 * to pair the transaction log's applier with.  Defaults to "default"
96
94
 */
 
95
static char *sysvar_transaction_log_use_replicator= NULL;
97
96
static const char DEFAULT_USE_REPLICATOR[]= "default";
98
 
static string sysvar_transaction_log_use_replicator;
99
97
 
100
98
/** DATA_DICTIONARY views */
101
99
static TransactionLogTool *transaction_log_tool;
113
111
extern plugin::Create_function<PrintTransactionMessageFunction> *print_transaction_message_func_factory;
114
112
extern plugin::Create_function<HexdumpTransactionMessageFunction> *hexdump_transaction_message_func_factory;
115
113
 
116
 
TransactionLog::~TransactionLog()
117
 
{
118
 
  /* Clear up any resources we've consumed */
119
 
  if (log_file != -1)
120
 
  {
121
 
    (void) close(log_file);
122
 
  }
123
 
}
124
 
 
125
 
static void set_truncate_debug(Session *, sql_var_t)
126
 
{
127
 
  if (transaction_log)
128
 
  {
129
 
    if (sysvar_transaction_log_truncate_debug)
130
 
    {
131
 
      transaction_log->truncate();
132
 
      transaction_log_index->clear();
133
 
      sysvar_transaction_log_truncate_debug= false;
134
 
    }
135
 
  }
136
 
}
137
 
 
138
114
static int init(drizzled::module::Context &context)
139
115
{
140
 
  context.registerVariable(new sys_var_bool_ptr_readonly("enable",
141
 
                                                         &sysvar_transaction_log_enabled));
142
 
  context.registerVariable(new sys_var_bool_ptr("truncate-debug",
143
 
                                                &sysvar_transaction_log_truncate_debug,
144
 
                                                set_truncate_debug));
145
 
 
146
 
  context.registerVariable(new sys_var_const_string("file",
147
 
                                                    sysvar_transaction_log_file));
148
 
  context.registerVariable(new sys_var_const_string("use-replicator",
149
 
                                                    sysvar_transaction_log_use_replicator));
150
 
  context.registerVariable(new sys_var_bool_ptr_readonly("enable-checksum",
151
 
                                                         &sysvar_transaction_log_checksum_enabled));
152
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("flush-frequency", sysvar_transaction_log_flush_frequency));
153
 
 
154
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("num-write-buffers",
155
 
                                                                            sysvar_transaction_log_num_write_buffers));
156
 
 
 
116
  const module::option_map &vm= context.getOptions();
 
117
 
 
118
  if (vm.count("sync-method"))
 
119
  {
 
120
    if (sysvar_transaction_log_sync_method > 2)
 
121
    {
 
122
      errmsg_printf(ERRMSG_LVL_ERROR, _("Invalid value for sync-method\n"));
 
123
      exit(-1);
 
124
    }
 
125
  }
 
126
 
 
127
  if (vm.count("num-write-buffers"))
 
128
  {
 
129
    if (sysvar_transaction_log_num_write_buffers < 4 || sysvar_transaction_log_num_write_buffers > 8192)
 
130
    {
 
131
      errmsg_printf(ERRMSG_LVL_ERROR, _("Invalid value for num-write-buffers\n"));
 
132
      exit(-1);
 
133
    }
 
134
  }
 
135
 
 
136
  if (vm.count("file"))
 
137
  {
 
138
    sysvar_transaction_log_file= strdup(vm["file"].as<string>().c_str());
 
139
  }
 
140
 
 
141
  else
 
142
  {
 
143
    sysvar_transaction_log_file= strdup(DEFAULT_LOG_FILE_PATH);
 
144
  }
 
145
 
 
146
  if (vm.count("use-replicator"))
 
147
  {
 
148
    sysvar_transaction_log_use_replicator= strdup(vm["use-replicator"].as<string>().c_str());
 
149
  }
 
150
 
 
151
  else
 
152
  {
 
153
    sysvar_transaction_log_use_replicator= strdup(DEFAULT_USE_REPLICATOR);
 
154
  }
157
155
 
158
156
  /* Create and initialize the transaction log itself */
159
157
  if (sysvar_transaction_log_enabled)
160
158
  {
161
 
  
162
 
    transaction_log= new (nothrow) TransactionLog(sysvar_transaction_log_file,
163
 
                                                  static_cast<int>(sysvar_transaction_log_flush_frequency),
 
159
    transaction_log= new (nothrow) TransactionLog(string(sysvar_transaction_log_file),
 
160
                                                  sysvar_transaction_log_sync_method,
164
161
                                                  sysvar_transaction_log_checksum_enabled);
165
162
 
166
163
    if (transaction_log == NULL)
167
164
    {
168
 
      sql_perror(_("Failed to allocate the TransactionLog instance"), sysvar_transaction_log_file);
 
165
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLog instance.  Got error: %s\n"), 
 
166
                    strerror(errno));
169
167
      return 1;
170
168
    }
171
169
    else
173
171
      /* Check to see if the log was not created properly */
174
172
      if (transaction_log->hasError())
175
173
      {
176
 
        errmsg_printf(error::ERROR, _("Failed to initialize the Transaction Log.  Got error: %s\n"), 
 
174
        errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to initialize the Transaction Log.  Got error: %s\n"), 
177
175
                      transaction_log->getErrorMessage().c_str());
178
176
        return 1;
179
177
      }
183
181
    transaction_log_index= new (nothrow) TransactionLogIndex(*transaction_log);
184
182
    if (transaction_log_index == NULL)
185
183
    {
186
 
      sql_perror(_("Failed to allocate the TransactionLogIndex instance"), sysvar_transaction_log_file);
 
184
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLogIndex instance.  Got error: %s\n"), 
 
185
                    strerror(errno));
187
186
      return 1;
188
187
    }
189
188
    else
191
190
      /* Check to see if the index was not created properly */
192
191
      if (transaction_log_index->hasError())
193
192
      {
194
 
        errmsg_printf(error::ERROR, _("Failed to initialize the Transaction Log Index.  Got error: %s\n"), 
 
193
        errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to initialize the Transaction Log Index.  Got error: %s\n"), 
195
194
                      transaction_log_index->getErrorMessage().c_str());
196
195
        return 1;
197
196
      }
201
200
    transaction_log_applier= new (nothrow) TransactionLogApplier("transaction_log_applier",
202
201
                                                                 transaction_log, 
203
202
                                                                 transaction_log_index, 
204
 
                                                                 static_cast<uint32_t>(sysvar_transaction_log_num_write_buffers));
 
203
                                                                 sysvar_transaction_log_num_write_buffers);
205
204
    if (transaction_log_applier == NULL)
206
205
    {
207
 
      sql_perror(_("Failed to allocate the TransactionLogApplier instance"), sysvar_transaction_log_file);
 
206
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLogApplier instance.  Got error: %s\n"), 
 
207
                    strerror(errno));
208
208
      return 1;
209
209
    }
210
210
    context.add(transaction_log_applier);
211
211
    ReplicationServices &replication_services= ReplicationServices::singleton();
212
 
    replication_services.attachApplier(transaction_log_applier,
213
 
                                       sysvar_transaction_log_use_replicator);
 
212
    string replicator_name(sysvar_transaction_log_use_replicator);
 
213
    replication_services.attachApplier(transaction_log_applier, replicator_name);
214
214
 
215
215
    /* Setup DATA_DICTIONARY views */
216
216
 
229
229
    hexdump_transaction_message_func_factory=
230
230
      new plugin::Create_function<HexdumpTransactionMessageFunction>("hexdump_transaction_message");
231
231
    context.add(hexdump_transaction_message_func_factory);
 
232
 
 
233
    /* 
 
234
     * Setup the background worker thread which maintains
 
235
     * summary information about the transaction log.
 
236
     */
 
237
    if (initTransactionLogBackgroundWorker())
 
238
      return 1; /* Error message output handled in function above */
232
239
  }
233
240
  return 0;
234
241
}
235
242
 
236
243
 
 
244
static void set_truncate_debug(Session *,
 
245
                               drizzle_sys_var *, 
 
246
                               void *, 
 
247
                               const void *save)
 
248
{
 
249
  /* 
 
250
   * The const void * save comes directly from the check function, 
 
251
   * which should simply return the result from the set statement. 
 
252
   */
 
253
  if (transaction_log)
 
254
  {
 
255
    if (*(bool *)save != false)
 
256
    {
 
257
      transaction_log->truncate();
 
258
      transaction_log_index->clear();
 
259
    }
 
260
  }
 
261
}
 
262
 
 
263
static DRIZZLE_SYSVAR_BOOL(enable,
 
264
                           sysvar_transaction_log_enabled,
 
265
                           PLUGIN_VAR_NOCMDARG,
 
266
                           N_("Enable transaction log"),
 
267
                           NULL, /* check func */
 
268
                           NULL, /* update func */
 
269
                           false /* default */);
 
270
 
 
271
static DRIZZLE_SYSVAR_BOOL(truncate_debug,
 
272
                           sysvar_transaction_log_truncate_debug,
 
273
                           PLUGIN_VAR_NOCMDARG,
 
274
                           N_("DEBUGGING - Truncate transaction log"),
 
275
                           NULL, /* check func */
 
276
                           set_truncate_debug, /* update func */
 
277
                           false /* default */);
 
278
 
 
279
static DRIZZLE_SYSVAR_STR(file,
 
280
                          sysvar_transaction_log_file,
 
281
                          PLUGIN_VAR_READONLY,
 
282
                          N_("Path to the file to use for transaction log"),
 
283
                          NULL, /* check func */
 
284
                          NULL, /* update func*/
 
285
                          DEFAULT_LOG_FILE_PATH /* default */);
 
286
 
 
287
static DRIZZLE_SYSVAR_STR(use_replicator,
 
288
                          sysvar_transaction_log_use_replicator,
 
289
                          PLUGIN_VAR_READONLY,
 
290
                          N_("Name of the replicator plugin to use (default='default_replicator')"),
 
291
                          NULL, /* check func */
 
292
                          NULL, /* update func*/
 
293
                          DEFAULT_USE_REPLICATOR /* default */);
 
294
 
 
295
static DRIZZLE_SYSVAR_BOOL(enable_checksum,
 
296
                           sysvar_transaction_log_checksum_enabled,
 
297
                           PLUGIN_VAR_NOCMDARG,
 
298
                           N_("Enable CRC32 Checksumming of each written transaction log entry"),
 
299
                           NULL, /* check func */
 
300
                           NULL, /* update func */
 
301
                           false /* default */);
 
302
 
 
303
static DRIZZLE_SYSVAR_UINT(sync_method,
 
304
                           sysvar_transaction_log_sync_method,
 
305
                           PLUGIN_VAR_OPCMDARG,
 
306
                           N_("0 == rely on operating system to sync log file (default), "
 
307
                              "1 == sync file at each transaction write, "
 
308
                              "2 == sync log file once per second"),
 
309
                           NULL, /* check func */
 
310
                           NULL, /* update func */
 
311
                           0, /* default */
 
312
                           0,
 
313
                           2,
 
314
                           0);
 
315
 
 
316
static DRIZZLE_SYSVAR_UINT(num_write_buffers,
 
317
                           sysvar_transaction_log_num_write_buffers,
 
318
                           PLUGIN_VAR_OPCMDARG,
 
319
                           N_("Number of slots for in-memory write buffers (default=8)."),
 
320
                           NULL, /* check func */
 
321
                           NULL, /* update func */
 
322
                           8, /* default */
 
323
                           4,
 
324
                           8192,
 
325
                           0);
 
326
 
237
327
static void init_options(drizzled::module::option_context &context)
238
328
{
239
329
  context("truncate-debug",
240
330
          po::value<bool>(&sysvar_transaction_log_truncate_debug)->default_value(false)->zero_tokens(),
241
 
          _("DEBUGGING - Truncate transaction log"));
 
331
          N_("DEBUGGING - Truncate transaction log"));
242
332
  context("enable-checksum",
243
333
          po::value<bool>(&sysvar_transaction_log_checksum_enabled)->default_value(false)->zero_tokens(),
244
 
          _("Enable CRC32 Checksumming of each written transaction log entry"));  
 
334
          N_("Enable CRC32 Checksumming of each written transaction log entry"));  
245
335
  context("enable",
246
336
          po::value<bool>(&sysvar_transaction_log_enabled)->default_value(false)->zero_tokens(),
247
 
          _("Enable transaction log"));
 
337
          N_("Enable transaction log"));
248
338
  context("file",
249
 
          po::value<string>(&sysvar_transaction_log_file)->default_value(DEFAULT_LOG_FILE_PATH),
250
 
          _("Path to the file to use for transaction log"));
 
339
          po::value<string>(),
 
340
          N_("Path to the file to use for transaction log"));
251
341
  context("use-replicator",
252
 
          po::value<string>(&sysvar_transaction_log_use_replicator)->default_value(DEFAULT_USE_REPLICATOR),
253
 
          _("Name of the replicator plugin to use (default='default_replicator')")); 
254
 
  context("flush-frequency",
255
 
          po::value<flush_constraint>(&sysvar_transaction_log_flush_frequency)->default_value(0),
256
 
          _("0 == rely on operating system to sync log file (default), 1 == sync file at each transaction write, 2 == sync log file once per second"));
 
342
          po::value<string>(),
 
343
          N_("Name of the replicator plugin to use (default='default_replicator')")); 
 
344
  context("sync-method",
 
345
          po::value<uint32_t>(&sysvar_transaction_log_sync_method)->default_value(0),
 
346
          N_("0 == rely on operating system to sync log file (default), 1 == sync file at each transaction write, 2 == sync log file once per second"));
257
347
  context("num-write-buffers",
258
 
          po::value<write_buffers_constraint>(&sysvar_transaction_log_num_write_buffers)->default_value(8),
259
 
          _("Number of slots for in-memory write buffers (default=8)."));
 
348
          po::value<uint32_t>(&sysvar_transaction_log_num_write_buffers)->default_value(8),
 
349
          N_("Number of slots for in-memory write buffers (default=8)."));
260
350
}
261
351
 
262
 
DRIZZLE_PLUGIN(init, NULL, init_options);
 
352
static drizzle_sys_var* sys_variables[]= {
 
353
  DRIZZLE_SYSVAR(enable),
 
354
  DRIZZLE_SYSVAR(truncate_debug),
 
355
  DRIZZLE_SYSVAR(file),
 
356
  DRIZZLE_SYSVAR(enable_checksum),
 
357
  DRIZZLE_SYSVAR(sync_method),
 
358
  DRIZZLE_SYSVAR(num_write_buffers),
 
359
  DRIZZLE_SYSVAR(use_replicator),
 
360
  NULL
 
361
};
 
362
 
 
363
DRIZZLE_PLUGIN(init, sys_variables, init_options);