← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/transaction_log/module.cc

  • Committer: Brian Aker
  • Date: 2010-11-22 00:16:44 UTC
  • mto: (1945.2.1 quick)
  • mto: This revision was merged to the branch mainline in revision 1947.
  • Revision ID: brian@tangent.org-20101122001644-pi6jv0d65e82xn38
Merge in lock refactor, this just encapsulates.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/transaction_log/module.cc
40
40
#include "hexdump_transaction_message.h"
41
41
#include "background_worker.h"
42
42
 
 
43
#include <errno.h>
 
44
 
43
45
#include <drizzled/plugin/plugin.h>
44
46
#include <drizzled/session.h>
45
 
#include <drizzled/set_var.h>
46
47
#include <drizzled/gettext.h>
 
48
#include <boost/program_options.hpp>
 
49
#include <drizzled/module/option_map.h>
47
50
 
 
51
namespace po= boost::program_options;
48
52
using namespace std;
49
53
using namespace drizzled;
50
54
 
 
55
/**
 
56
 * The name of the main transaction log file on disk.  With no prefix,
 
57
 * this goes into Drizzle's $datadir.
 
58
 */
 
59
static const char DEFAULT_LOG_FILE_PATH[]= "transaction.log"; /* In datadir... */
51
60
/** 
52
61
 * Transaction Log plugin system variable - Is the log enabled? Only used on init().  
53
 
 * The enable() and disable() methods of the TransactionLog class control online
54
 
 * disabling.
55
62
 */
56
63
static bool sysvar_transaction_log_enabled= false;
 
64
 
57
65
/** Transaction Log plugin system variable - The path to the log file used */
58
 
static char* sysvar_transaction_log_file= NULL;
 
66
static string sysvar_transaction_log_file;
 
67
 
59
68
/** 
60
69
 * Transaction Log plugin system variable - A debugging variable to assist 
61
70
 * in truncating the log file. 
62
71
 */
63
72
static bool sysvar_transaction_log_truncate_debug= false;
64
 
static const char DEFAULT_LOG_FILE_PATH[]= "transaction.log"; /* In datadir... */
65
73
/** 
66
74
 * Transaction Log plugin system variable - Should we write a CRC32 checksum for 
67
75
 * each written Transaction message?
71
79
 * Numeric option controlling the sync/flush behaviour of the transaction
72
80
 * log.  Options are:
73
81
 *
74
 
 * TransactionLog::SYNC_METHOD_OS == 0            ... let OS do sync'ing
75
 
 * TransactionLog::SYNC_METHOD_EVERY_WRITE == 1   ... sync on every write
76
 
 * TransactionLog::SYNC_METHOD_EVERY_SECOND == 2  ... sync at most once a second
77
 
 */
78
 
static uint32_t sysvar_transaction_log_sync_method= 0;
 
82
 * TransactionLog::FLUSH_FREQUENCY_OS == 0            ... let OS do sync'ing
 
83
 * TransactionLog::FLUSH_FREQUENCY_EVERY_WRITE == 1   ... sync on every write
 
84
 * TransactionLog::FLUSH_FREQUENCY_EVERY_SECOND == 2  ... sync at most once a second
 
85
 */
 
86
typedef constrained_check<int, 2, 0> flush_constraint;
 
87
static flush_constraint sysvar_transaction_log_flush_frequency;
 
88
/**
 
89
 * Transaction Log plugin system variable - Number of slots to create
 
90
 * for managing write buffers
 
91
 */
 
92
typedef constrained_check<uint32_t, 8192, 4> write_buffers_constraint;
 
93
static write_buffers_constraint sysvar_transaction_log_num_write_buffers;
 
94
/**
 
95
 * Transaction Log plugin system variable - The name of the replicator plugin
 
96
 * to pair the transaction log's applier with.  Defaults to "default"
 
97
 */
 
98
static const char DEFAULT_USE_REPLICATOR[]= "default";
 
99
static string sysvar_transaction_log_use_replicator;
79
100
 
80
101
/** DATA_DICTIONARY views */
81
102
static TransactionLogTool *transaction_log_tool;
93
114
extern plugin::Create_function<PrintTransactionMessageFunction> *print_transaction_message_func_factory;
94
115
extern plugin::Create_function<HexdumpTransactionMessageFunction> *hexdump_transaction_message_func_factory;
95
116
 
96
 
static int init(drizzled::plugin::Context &context)
97
 
{
 
117
TransactionLog::~TransactionLog()
 
118
{
 
119
  /* Clear up any resources we've consumed */
 
120
  if (log_file != -1)
 
121
  {
 
122
    (void) close(log_file);
 
123
  }
 
124
}
 
125
 
 
126
static void set_truncate_debug(Session *, sql_var_t)
 
127
{
 
128
  if (transaction_log)
 
129
  {
 
130
    if (sysvar_transaction_log_truncate_debug)
 
131
    {
 
132
      transaction_log->truncate();
 
133
      transaction_log_index->clear();
 
134
      sysvar_transaction_log_truncate_debug= false;
 
135
    }
 
136
  }
 
137
}
 
138
 
 
139
static int init(drizzled::module::Context &context)
 
140
{
 
141
  context.registerVariable(new sys_var_bool_ptr_readonly("enable",
 
142
                                                         &sysvar_transaction_log_enabled));
 
143
  context.registerVariable(new sys_var_bool_ptr("truncate-debug",
 
144
                                                &sysvar_transaction_log_truncate_debug,
 
145
                                                set_truncate_debug));
 
146
 
 
147
  context.registerVariable(new sys_var_const_string("file",
 
148
                                                    sysvar_transaction_log_file));
 
149
  context.registerVariable(new sys_var_const_string("use-replicator",
 
150
                                                    sysvar_transaction_log_use_replicator));
 
151
  context.registerVariable(new sys_var_bool_ptr_readonly("enable-checksum",
 
152
                                                         &sysvar_transaction_log_checksum_enabled));
 
153
  context.registerVariable(new sys_var_constrained_value_readonly<int>("flush-frequency", sysvar_transaction_log_flush_frequency));
 
154
 
 
155
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("num-write-buffers",
 
156
                                                                            sysvar_transaction_log_num_write_buffers));
 
157
 
 
158
 
98
159
  /* Create and initialize the transaction log itself */
99
160
  if (sysvar_transaction_log_enabled)
100
161
  {
101
 
    transaction_log= new (nothrow) TransactionLog(string(sysvar_transaction_log_file),
102
 
                                                  sysvar_transaction_log_sync_method);
 
162
  
 
163
    transaction_log= new (nothrow) TransactionLog(sysvar_transaction_log_file,
 
164
                                                  static_cast<int>(sysvar_transaction_log_flush_frequency),
 
165
                                                  sysvar_transaction_log_checksum_enabled);
103
166
 
104
167
    if (transaction_log == NULL)
105
168
    {
 
169
      char errmsg[STRERROR_MAX];
 
170
      strerror_r(errno, errmsg, sizeof(errmsg));
106
171
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLog instance.  Got error: %s\n"), 
107
 
                    strerror(errno));
 
172
                    errmsg);
108
173
      return 1;
109
174
    }
110
175
    else
117
182
        return 1;
118
183
      }
119
184
    }
 
185
 
 
186
    /* Create and initialize the transaction log index */
 
187
    transaction_log_index= new (nothrow) TransactionLogIndex(*transaction_log);
 
188
    if (transaction_log_index == NULL)
 
189
    {
 
190
      char errmsg[STRERROR_MAX];
 
191
      strerror_r(errno, errmsg, sizeof(errmsg));
 
192
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLogIndex instance.  Got error: %s\n"), 
 
193
                    errmsg);
 
194
      return 1;
 
195
    }
 
196
    else
 
197
    {
 
198
      /* Check to see if the index was not created properly */
 
199
      if (transaction_log_index->hasError())
 
200
      {
 
201
        errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to initialize the Transaction Log Index.  Got error: %s\n"), 
 
202
                      transaction_log_index->getErrorMessage().c_str());
 
203
        return 1;
 
204
      }
 
205
    }
 
206
 
120
207
    /* Create the applier plugin and register it */
121
208
    transaction_log_applier= new (nothrow) TransactionLogApplier("transaction_log_applier",
122
 
                                                                 *transaction_log, 
123
 
                                                                 sysvar_transaction_log_checksum_enabled);
 
209
                                                                 transaction_log, 
 
210
                                                                 transaction_log_index, 
 
211
                                                                 static_cast<uint32_t>(sysvar_transaction_log_num_write_buffers));
124
212
    if (transaction_log_applier == NULL)
125
213
    {
 
214
      char errmsg[STRERROR_MAX];
 
215
      strerror_r(errno, errmsg, sizeof(errmsg));
126
216
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLogApplier instance.  Got error: %s\n"), 
127
 
                    strerror(errno));
 
217
                    errmsg);
128
218
      return 1;
129
219
    }
130
220
    context.add(transaction_log_applier);
 
221
    ReplicationServices &replication_services= ReplicationServices::singleton();
 
222
    replication_services.attachApplier(transaction_log_applier,
 
223
                                       sysvar_transaction_log_use_replicator);
131
224
 
132
225
    /* Setup DATA_DICTIONARY views */
133
226
 
147
240
      new plugin::Create_function<HexdumpTransactionMessageFunction>("hexdump_transaction_message");
148
241
    context.add(hexdump_transaction_message_func_factory);
149
242
 
150
 
    /* Create and initialize the transaction log index */
151
 
    transaction_log_index= new (nothrow) TransactionLogIndex(*transaction_log);
152
 
    if (transaction_log_index == NULL)
153
 
    {
154
 
      errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to allocate the TransactionLogIndex instance.  Got error: %s\n"), 
155
 
                    strerror(errno));
156
 
      return 1;
157
 
    }
158
 
    else
159
 
    {
160
 
      /* Check to see if the index was not created properly */
161
 
      if (transaction_log_index->hasError())
162
 
      {
163
 
        errmsg_printf(ERRMSG_LVL_ERROR, _("Failed to initialize the Transaction Log Index.  Got error: %s\n"), 
164
 
                      transaction_log_index->getErrorMessage().c_str());
165
 
        return 1;
166
 
      }
167
 
    }
168
 
 
169
243
    /* 
170
244
     * Setup the background worker thread which maintains
171
245
     * summary information about the transaction log.
177
251
}
178
252
 
179
253
 
180
 
static void set_truncate_debug(Session *,
181
 
                               drizzle_sys_var *, 
182
 
                               void *, 
183
 
                               const void *save)
 
254
static void init_options(drizzled::module::option_context &context)
184
255
{
185
 
  /* 
186
 
   * The const void * save comes directly from the check function, 
187
 
   * which should simply return the result from the set statement. 
188
 
   */
189
 
  if (transaction_log)
190
 
  {
191
 
    if (*(bool *)save != false)
192
 
    {
193
 
      transaction_log->truncate();
194
 
      transaction_log_index->clear();
195
 
    }
196
 
  }
 
256
  context("truncate-debug",
 
257
          po::value<bool>(&sysvar_transaction_log_truncate_debug)->default_value(false)->zero_tokens(),
 
258
          N_("DEBUGGING - Truncate transaction log"));
 
259
  context("enable-checksum",
 
260
          po::value<bool>(&sysvar_transaction_log_checksum_enabled)->default_value(false)->zero_tokens(),
 
261
          N_("Enable CRC32 Checksumming of each written transaction log entry"));  
 
262
  context("enable",
 
263
          po::value<bool>(&sysvar_transaction_log_enabled)->default_value(false)->zero_tokens(),
 
264
          N_("Enable transaction log"));
 
265
  context("file",
 
266
          po::value<string>(&sysvar_transaction_log_file)->default_value(DEFAULT_LOG_FILE_PATH),
 
267
          N_("Path to the file to use for transaction log"));
 
268
  context("use-replicator",
 
269
          po::value<string>(&sysvar_transaction_log_use_replicator)->default_value(DEFAULT_USE_REPLICATOR),
 
270
          N_("Name of the replicator plugin to use (default='default_replicator')")); 
 
271
  context("flush-frequency",
 
272
          po::value<flush_constraint>(&sysvar_transaction_log_flush_frequency)->default_value(0),
 
273
          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"));
 
274
  context("num-write-buffers",
 
275
          po::value<write_buffers_constraint>(&sysvar_transaction_log_num_write_buffers)->default_value(8),
 
276
          N_("Number of slots for in-memory write buffers (default=8)."));
197
277
}
198
278
 
199
 
static DRIZZLE_SYSVAR_BOOL(enable,
200
 
                           sysvar_transaction_log_enabled,
201
 
                           PLUGIN_VAR_NOCMDARG,
202
 
                           N_("Enable transaction log"),
203
 
                           NULL, /* check func */
204
 
                           NULL, /* update func */
205
 
                           false /* default */);
206
 
 
207
 
static DRIZZLE_SYSVAR_BOOL(truncate_debug,
208
 
                           sysvar_transaction_log_truncate_debug,
209
 
                           PLUGIN_VAR_NOCMDARG,
210
 
                           N_("DEBUGGING - Truncate transaction log"),
211
 
                           NULL, /* check func */
212
 
                           set_truncate_debug, /* update func */
213
 
                           false /* default */);
214
 
 
215
 
static DRIZZLE_SYSVAR_STR(log_file,
216
 
                          sysvar_transaction_log_file,
217
 
                          PLUGIN_VAR_READONLY,
218
 
                          N_("Path to the file to use for transaction log"),
219
 
                          NULL, /* check func */
220
 
                          NULL, /* update func*/
221
 
                          DEFAULT_LOG_FILE_PATH /* default */);
222
 
 
223
 
static DRIZZLE_SYSVAR_BOOL(enable_checksum,
224
 
                           sysvar_transaction_log_checksum_enabled,
225
 
                           PLUGIN_VAR_NOCMDARG,
226
 
                           N_("Enable CRC32 Checksumming of each written transaction log entry"),
227
 
                           NULL, /* check func */
228
 
                           NULL, /* update func */
229
 
                           false /* default */);
230
 
 
231
 
static DRIZZLE_SYSVAR_UINT(sync_method,
232
 
                           sysvar_transaction_log_sync_method,
233
 
                           PLUGIN_VAR_OPCMDARG,
234
 
                           N_("0 == rely on operating system to sync log file (default), "
235
 
                              "1 == sync file at each transaction write, "
236
 
                              "2 == sync log file once per second"),
237
 
                           NULL, /* check func */
238
 
                           NULL, /* update func */
239
 
                           0, /* default */
240
 
                           0,
241
 
                           2,
242
 
                           0);
243
 
 
244
 
static drizzle_sys_var* sys_variables[]= {
245
 
  DRIZZLE_SYSVAR(enable),
246
 
  DRIZZLE_SYSVAR(truncate_debug),
247
 
  DRIZZLE_SYSVAR(log_file),
248
 
  DRIZZLE_SYSVAR(enable_checksum),
249
 
  DRIZZLE_SYSVAR(sync_method),
250
 
  NULL
251
 
};
252
 
 
253
 
DRIZZLE_PLUGIN(init, sys_variables);
 
279
DRIZZLE_PLUGIN(init, NULL, init_options);