← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin.h

  • Committer: Monty Taylor
  • Date: 2010-06-26 03:52:47 UTC
  • mfrom: (1637.1.5 staging)
  • Revision ID: mordred@inaugust.com-20100626035247-i0iq4sd6wqzfisyy
Merged in staging changes: Mark's syslog patch and vijay's program_options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin.h
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 Sun Microsystems, Inc.
 
4
 *  Copyright (C) 2008 Sun Microsystems
5
5
 *
6
6
 *  This program is free software; you can redistribute it and/or modify
7
7
 *  it under the terms of the GNU General Public License as published by
20
20
#ifndef DRIZZLED_PLUGIN_H
21
21
#define DRIZZLED_PLUGIN_H
22
22
 
23
 
#include <boost/program_options.hpp>
24
 
#include <boost/filesystem.hpp>
25
 
 
26
23
#include "drizzled/module/manifest.h"
27
24
#include "drizzled/module/module.h"
28
25
#include "drizzled/plugin/version.h"
30
27
#include "drizzled/definitions.h"
31
28
 
32
29
#include "drizzled/lex_string.h"
33
 
#include "drizzled/sys_var.h"
34
30
#include "drizzled/xid.h"
35
 
 
36
 
#include "drizzled/visibility.h"
 
31
#include <boost/program_options.hpp>
37
32
 
38
33
namespace drizzled
39
34
{
48
43
 
49
44
 
50
45
class sys_var;
 
46
typedef drizzle_lex_string LEX_STRING;
51
47
struct option;
52
48
 
53
 
extern boost::filesystem::path plugin_dir;
 
49
extern char *opt_plugin_add;
 
50
extern char *opt_plugin_remove;
 
51
extern char *opt_plugin_load;
 
52
extern char *opt_plugin_dir_ptr;
 
53
extern char opt_plugin_dir[FN_REFLEN];
54
54
 
55
55
namespace plugin { class StorageEngine; }
56
56
 
64
64
#define PANDORA_CPP_NAME(x) _drizzled_ ## x ## _plugin_
65
65
#define PANDORA_PLUGIN_NAME(x) PANDORA_CPP_NAME(x)
66
66
#define DRIZZLE_DECLARE_PLUGIN \
67
 
  DRIZZLED_API ::drizzled::module::Manifest PANDORA_PLUGIN_NAME(PANDORA_MODULE_NAME)= 
 
67
  ::drizzled::module::Manifest PANDORA_PLUGIN_NAME(PANDORA_MODULE_NAME)= 
68
68
 
69
69
 
70
70
#define DRIZZLE_DECLARE_PLUGIN_END
71
 
#define DRIZZLE_PLUGIN(init,system,options) \
 
71
#define DRIZZLE_PLUGIN(init,system) \
72
72
  DRIZZLE_DECLARE_PLUGIN \
73
73
  { \
74
74
    DRIZZLE_VERSION_ID, \
77
77
    STRINGIFY_ARG(PANDORA_MODULE_AUTHOR), \
78
78
    STRINGIFY_ARG(PANDORA_MODULE_TITLE), \
79
79
    PANDORA_MODULE_LICENSE, \
80
 
    init, \
81
 
    STRINGIFY_ARG(PANDORA_MODULE_DEPENDENCIES), \
82
 
    options \
 
80
    init, system, NULL \
83
81
  } 
84
82
 
85
83
 
86
84
/*
 
85
  declarations for SHOW STATUS support in plugins
 
86
*/
 
87
enum enum_mysql_show_type
 
88
{
 
89
  SHOW_UNDEF, SHOW_BOOL, SHOW_INT, SHOW_LONG,
 
90
  SHOW_LONGLONG, SHOW_CHAR, SHOW_CHAR_PTR,
 
91
  SHOW_FUNC, SHOW_KEY_CACHE_LONG, SHOW_KEY_CACHE_LONGLONG,
 
92
  SHOW_LONG_STATUS, SHOW_DOUBLE_STATUS,
 
93
  SHOW_MY_BOOL, SHOW_HA_ROWS, SHOW_SYS, SHOW_INT_NOFLUSH,
 
94
  SHOW_LONGLONG_STATUS, SHOW_DOUBLE, SHOW_SIZE
 
95
};
 
96
 
 
97
struct drizzle_show_var {
 
98
  const char *name;
 
99
  char *value;
 
100
  enum enum_mysql_show_type type;
 
101
};
 
102
 
 
103
typedef enum enum_mysql_show_type SHOW_TYPE;
 
104
 
 
105
 
 
106
#define SHOW_VAR_FUNC_BUFF_SIZE 1024
 
107
typedef int (*mysql_show_var_func)(drizzle_show_var *, char *);
 
108
 
 
109
struct st_show_var_func_container {
 
110
  mysql_show_var_func func;
 
111
};
 
112
/*
87
113
  declarations for server variables and command line options
88
114
*/
89
115
 
108
134
 
109
135
/*
110
136
  SYNOPSIS
111
 
    (*var_check_func)()
 
137
    (*mysql_var_check_func)()
112
138
      session               thread handle
113
139
      var               dynamic variable being altered
114
140
      save              pointer to temporary storage
125
151
  automatically at the end of the statement.
126
152
*/
127
153
 
128
 
typedef int (*var_check_func)(Session *session,
 
154
typedef int (*mysql_var_check_func)(Session *session,
129
155
                                    drizzle_sys_var *var,
130
156
                                    void *save, drizzle_value *value);
131
157
 
132
158
/*
133
159
  SYNOPSIS
134
 
    (*var_update_func)()
 
160
    (*mysql_var_update_func)()
135
161
      session               thread handle
136
162
      var               dynamic variable being altered
137
163
      var_ptr           pointer to dynamic variable
143
169
   and persist it in the provided pointer to the dynamic variable.
144
170
   For example, strings may require memory to be allocated.
145
171
*/
146
 
typedef void (*var_update_func)(Session *session,
 
172
typedef void (*mysql_var_update_func)(Session *session,
147
173
                                      drizzle_sys_var *var,
148
174
                                      void *var_ptr, const void *save);
149
175
 
150
176
 
 
177
/* the following declarations are for internal use only */
 
178
 
 
179
 
 
180
#define PLUGIN_VAR_MASK \
 
181
        (PLUGIN_VAR_READONLY | PLUGIN_VAR_NOSYSVAR | \
 
182
         PLUGIN_VAR_NOCMDOPT | PLUGIN_VAR_NOCMDARG | \
 
183
         PLUGIN_VAR_OPCMDARG | PLUGIN_VAR_RQCMDARG | PLUGIN_VAR_MEMALLOC)
 
184
 
 
185
#define DRIZZLE_PLUGIN_VAR_HEADER \
 
186
  int flags;                    \
 
187
  const char *name;             \
 
188
  const char *comment;          \
 
189
  mysql_var_check_func check;   \
 
190
  mysql_var_update_func update
 
191
 
 
192
#define DRIZZLE_SYSVAR_NAME(name) mysql_sysvar_ ## name
 
193
#define DRIZZLE_SYSVAR(name) \
 
194
  ((drizzle_sys_var *)(&(DRIZZLE_SYSVAR_NAME(name))))
 
195
 
 
196
/*
 
197
  for global variables, the value pointer is the first
 
198
  element after the header, the default value is the second.
 
199
  for thread variables, the value offset is the first
 
200
  element after the header, the default value is the second.
 
201
*/
 
202
 
 
203
 
 
204
#define DECLARE_DRIZZLE_SYSVAR_BASIC(name, type) struct { \
 
205
  DRIZZLE_PLUGIN_VAR_HEADER;      \
 
206
  type *value;                  \
 
207
  const type def_val;           \
 
208
} DRIZZLE_SYSVAR_NAME(name)
 
209
 
 
210
#define DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, type) struct { \
 
211
  DRIZZLE_PLUGIN_VAR_HEADER;      \
 
212
  type *value; type def_val;    \
 
213
  type min_val; type max_val;   \
 
214
  type blk_sz;                  \
 
215
} DRIZZLE_SYSVAR_NAME(name)
 
216
 
 
217
#define DECLARE_SessionVAR_FUNC(type) \
 
218
  type *(*resolve)(Session *session, int offset)
 
219
 
 
220
#define DECLARE_DRIZZLE_SessionVAR_BASIC(name, type) struct { \
 
221
  DRIZZLE_PLUGIN_VAR_HEADER;      \
 
222
  int offset;                   \
 
223
  const type def_val;           \
 
224
  DECLARE_SessionVAR_FUNC(type);    \
 
225
} DRIZZLE_SYSVAR_NAME(name)
 
226
 
 
227
#define DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, type) struct { \
 
228
  DRIZZLE_PLUGIN_VAR_HEADER;      \
 
229
  int offset;                   \
 
230
  type def_val; type min_val;   \
 
231
  type max_val; type blk_sz;    \
 
232
  DECLARE_SessionVAR_FUNC(type);    \
 
233
} DRIZZLE_SYSVAR_NAME(name)
 
234
 
 
235
#define DECLARE_DRIZZLE_SessionVAR_TYPELIB(name, type) struct { \
 
236
  DRIZZLE_PLUGIN_VAR_HEADER;      \
 
237
  int offset;                   \
 
238
  type def_val;                 \
 
239
  DECLARE_SessionVAR_FUNC(type);    \
 
240
  TYPELIB *typelib;             \
 
241
} DRIZZLE_SYSVAR_NAME(name)
 
242
 
 
243
 
 
244
/*
 
245
  the following declarations are for use by plugin implementors
 
246
*/
 
247
 
 
248
#define DRIZZLE_SYSVAR_BOOL(name, varname, opt, comment, check, update, def) \
 
249
DECLARE_DRIZZLE_SYSVAR_BASIC(name, bool) = { \
 
250
  PLUGIN_VAR_BOOL | ((opt) & PLUGIN_VAR_MASK), \
 
251
  #name, comment, check, update, &varname, def}
 
252
 
 
253
#define DRIZZLE_SYSVAR_STR(name, varname, opt, comment, check, update, def) \
 
254
DECLARE_DRIZZLE_SYSVAR_BASIC(name, char *) = { \
 
255
  PLUGIN_VAR_STR | ((opt) & PLUGIN_VAR_MASK), \
 
256
  #name, comment, check, update, &varname, def}
 
257
 
 
258
#define DRIZZLE_SYSVAR_INT(name, varname, opt, comment, check, update, def, min, max, blk) \
 
259
DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, int) = { \
 
260
  PLUGIN_VAR_INT | ((opt) & PLUGIN_VAR_MASK), \
 
261
  #name, comment, check, update, &varname, def, min, max, blk }
 
262
 
 
263
#define DRIZZLE_SYSVAR_UINT(name, varname, opt, comment, check, update, def, min, max, blk) \
 
264
DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, unsigned int) = { \
 
265
  PLUGIN_VAR_INT | PLUGIN_VAR_UNSIGNED | ((opt) & PLUGIN_VAR_MASK), \
 
266
  #name, comment, check, update, &varname, def, min, max, blk }
 
267
 
 
268
#define DRIZZLE_SYSVAR_LONG(name, varname, opt, comment, check, update, def, min, max, blk) \
 
269
DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, long) = { \
 
270
  PLUGIN_VAR_LONG | ((opt) & PLUGIN_VAR_MASK), \
 
271
  #name, comment, check, update, &varname, def, min, max, blk }
 
272
 
 
273
#define DRIZZLE_SYSVAR_ULONG(name, varname, opt, comment, check, update, def, min, max, blk) \
 
274
DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, unsigned long) = { \
 
275
  PLUGIN_VAR_LONG | PLUGIN_VAR_UNSIGNED | ((opt) & PLUGIN_VAR_MASK), \
 
276
  #name, comment, check, update, &varname, def, min, max, blk }
 
277
 
 
278
#define DRIZZLE_SYSVAR_LONGLONG(name, varname, opt, comment, check, update, def, min, max, blk) \
 
279
DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, int64_t) = { \
 
280
  PLUGIN_VAR_LONGLONG | ((opt) & PLUGIN_VAR_MASK), \
 
281
  #name, comment, check, update, &varname, def, min, max, blk }
 
282
 
 
283
#define DRIZZLE_SYSVAR_ULONGLONG(name, varname, opt, comment, check, update, def, min, max, blk) \
 
284
DECLARE_DRIZZLE_SYSVAR_SIMPLE(name, uint64_t) = { \
 
285
  PLUGIN_VAR_LONGLONG | PLUGIN_VAR_UNSIGNED | ((opt) & PLUGIN_VAR_MASK), \
 
286
  #name, comment, check, update, &varname, def, min, max, blk }
 
287
 
 
288
#define DRIZZLE_SessionVAR_BOOL(name, opt, comment, check, update, def) \
 
289
DECLARE_DRIZZLE_SessionVAR_BASIC(name, char) = { \
 
290
  PLUGIN_VAR_BOOL | PLUGIN_VAR_SessionLOCAL | ((opt) & PLUGIN_VAR_MASK), \
 
291
  #name, comment, check, update, -1, def, NULL}
 
292
 
 
293
#define DRIZZLE_SessionVAR_STR(name, opt, comment, check, update, def) \
 
294
DECLARE_DRIZZLE_SessionVAR_BASIC(name, char *) = { \
 
295
  PLUGIN_VAR_STR | PLUGIN_VAR_SessionLOCAL | ((opt) & PLUGIN_VAR_MASK), \
 
296
  #name, comment, check, update, -1, def, NULL}
 
297
 
 
298
#define DRIZZLE_SessionVAR_INT(name, opt, comment, check, update, def, min, max, blk) \
 
299
DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, int) = { \
 
300
  PLUGIN_VAR_INT | PLUGIN_VAR_SessionLOCAL | ((opt) & PLUGIN_VAR_MASK), \
 
301
  #name, comment, check, update, -1, def, min, max, blk, NULL }
 
302
 
 
303
#define DRIZZLE_SessionVAR_UINT(name, opt, comment, check, update, def, min, max, blk) \
 
304
DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, unsigned int) = { \
 
305
  PLUGIN_VAR_INT | PLUGIN_VAR_SessionLOCAL | PLUGIN_VAR_UNSIGNED | ((opt) & PLUGIN_VAR_MASK), \
 
306
  #name, comment, check, update, -1, def, min, max, blk, NULL }
 
307
 
 
308
#define DRIZZLE_SessionVAR_LONG(name, opt, comment, check, update, def, min, max, blk) \
 
309
DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, long) = { \
 
310
  PLUGIN_VAR_LONG | PLUGIN_VAR_SessionLOCAL | ((opt) & PLUGIN_VAR_MASK), \
 
311
  #name, comment, check, update, -1, def, min, max, blk, NULL }
 
312
 
 
313
#define DRIZZLE_SessionVAR_ULONG(name, opt, comment, check, update, def, min, max, blk) \
 
314
DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, unsigned long) = { \
 
315
  PLUGIN_VAR_LONG | PLUGIN_VAR_SessionLOCAL | PLUGIN_VAR_UNSIGNED | ((opt) & PLUGIN_VAR_MASK), \
 
316
  #name, comment, check, update, -1, def, min, max, blk, NULL }
 
317
 
 
318
#define DRIZZLE_SessionVAR_LONGLONG(name, opt, comment, check, update, def, min, max, blk) \
 
319
DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, int64_t) = { \
 
320
  PLUGIN_VAR_LONGLONG | PLUGIN_VAR_SessionLOCAL | ((opt) & PLUGIN_VAR_MASK), \
 
321
  #name, comment, check, update, -1, def, min, max, blk, NULL }
 
322
 
 
323
#define DRIZZLE_SessionVAR_ULONGLONG(name, opt, comment, check, update, def, min, max, blk) \
 
324
DECLARE_DRIZZLE_SessionVAR_SIMPLE(name, uint64_t) = { \
 
325
  PLUGIN_VAR_LONGLONG | PLUGIN_VAR_SessionLOCAL | PLUGIN_VAR_UNSIGNED | ((opt) & PLUGIN_VAR_MASK), \
 
326
  #name, comment, check, update, -1, def, min, max, blk, NULL }
 
327
 
 
328
/* accessor macros */
 
329
 
 
330
#define SYSVAR(name) \
 
331
  (*(DRIZZLE_SYSVAR_NAME(name).value))
 
332
 
 
333
/* when session == null, result points to global value */
 
334
#define SessionVAR(session, name) \
 
335
  (*(DRIZZLE_SYSVAR_NAME(name).resolve(session, DRIZZLE_SYSVAR_NAME(name).offset)))
 
336
 
 
337
 
 
338
/*************************************************************************
 
339
  drizzle_value struct for reading values from mysqld.
 
340
  Used by server variables framework to parse user-provided values.
 
341
  Will be used for arguments when implementing UDFs.
 
342
 
 
343
  Note that val_str() returns a string in temporary memory
 
344
  that will be freed at the end of statement. Copy the string
 
345
  if you need it to persist.
 
346
*/
 
347
 
 
348
#define DRIZZLE_VALUE_TYPE_STRING 0
 
349
#define DRIZZLE_VALUE_TYPE_REAL   1
 
350
#define DRIZZLE_VALUE_TYPE_INT    2
151
351
 
152
352
/*
153
353
  skeleton of a plugin variable - portion of structure common to all.
154
354
*/
155
355
struct drizzle_sys_var
156
356
{
 
357
  DRIZZLE_PLUGIN_VAR_HEADER;
157
358
};
158
359
 
159
360
void plugin_opt_set_limits(option *options, const drizzle_sys_var *opt);
172
373
*/
173
374
 
174
375
extern bool plugin_init(module::Registry &registry,
 
376
                        int *argc, char **argv,
 
377
                        bool skip_init,
175
378
                        boost::program_options::options_description &long_options);
176
 
extern bool plugin_finalize(module::Registry &registry);
177
 
extern void plugin_startup_window(module::Registry &registry, drizzled::Session &session);
178
 
extern void my_print_help_inc_plugins(option *options);
 
379
extern void my_print_help_inc_plugins(option *options,
 
380
                                      boost::program_options::options_description &long_options);
179
381
extern bool plugin_is_ready(const LEX_STRING *name, int type);
180
382
extern void plugin_sessionvar_init(Session *session);
181
383
extern void plugin_sessionvar_cleanup(Session *session);
 
384
extern sys_var *intern_find_sys_var(const char *str, uint32_t, bool no_error);
182
385
 
183
386
int session_in_lock_tables(const Session *session);
184
 
DRIZZLED_API int64_t session_test_options(const Session *session, int64_t test_options);
185
 
void compose_plugin_add(std::vector<std::string> options);
186
 
void compose_plugin_remove(std::vector<std::string> options);
187
 
void notify_plugin_load(std::string in_plugin_load);
 
387
int session_tablespace_op(const Session *session);
 
388
void set_session_proc_info(Session *session, const char *info);
 
389
const char *get_session_proc_info(Session *session);
 
390
int64_t session_test_options(const Session *session, int64_t test_options);
 
391
int session_sql_command(const Session *session);
 
392
int session_tx_isolation(const Session *session);
 
393
 
188
394
 
189
395
 
190
396
/**
199
405
  @retval -1    error
200
406
  @retval >= 0  a file handle that can be passed to dup or internal::my_close
201
407
*/
202
 
DRIZZLED_API int tmpfile(const char *prefix);
 
408
int mysql_tmpfile(const char *prefix);
 
409
 
 
410
/**
 
411
  Check the killed state of a connection
 
412
 
 
413
  @details
 
414
  In MySQL support for the KILL statement is cooperative. The KILL
 
415
  statement only sets a "killed" flag. This function returns the value
 
416
  of that flag.  A thread should check it often, especially inside
 
417
  time-consuming loops, and gracefully abort the operation if it is
 
418
  non-zero.
 
419
 
 
420
  @param session  user thread connection handle
 
421
  @retval 0  the connection is active
 
422
  @retval 1  the connection has been killed
 
423
*/
 
424
int session_killed(const Session *session);
 
425
 
 
426
 
 
427
const charset_info_st *session_charset(Session *session);
 
428
 
 
429
/**
 
430
  Invalidate the query cache for a given table.
 
431
 
 
432
  @param session         user thread connection handle
 
433
  @param key         databasename\\0tablename\\0
 
434
  @param key_length  length of key in bytes, including the NUL bytes
 
435
  @param using_trx   flag: TRUE if using transactions, FALSE otherwise
 
436
*/
 
437
void mysql_query_cache_invalidate4(Session *session,
 
438
                                   const char *key, unsigned int key_length,
 
439
                                   int using_trx);
203
440
 
204
441
} /* namespace drizzled */
205
442