← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/transaction_services.h

Merge Stewart.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/transaction_services.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.
5
 
 *  Copyright (C) 2010 Jay Pipes <jaypipes@gmail.com>
 
4
 *  Copyright (C) 2008 Sun Microsystems
6
5
 *
7
6
 *  This program is free software; you can redistribute it and/or modify
8
7
 *  it under the terms of the GNU General Public License as published by
25
24
#ifndef DRIZZLED_TRANSACTION_SERVICES_H
26
25
#define DRIZZLED_TRANSACTION_SERVICES_H
27
26
 
28
 
#include <drizzled/atomics.h>
29
 
#include <drizzled/message/transaction.pb.h>
30
 
#include <drizzled/identifier/table.h>
31
 
#include <drizzled/message/schema.h>
32
 
#include <drizzled/session.h>
33
 
 
34
 
#include "drizzled/visibility.h"
35
 
 
36
27
namespace drizzled
37
28
{
38
29
 
39
30
/* some forward declarations needed */
40
31
namespace plugin
41
32
{
42
 
  class MonitoredInTransaction;
43
 
  class XaResourceManager;
44
 
  class XaStorageEngine;
45
33
  class TransactionalStorageEngine;
46
34
}
47
35
 
48
36
class Session;
49
37
class NamedSavepoint;
50
 
class Field;
51
38
 
52
39
/**
53
40
 * This is a class which manages the XA transaction processing
54
41
 * in the server
55
42
 */
56
 
class DRIZZLED_API TransactionServices
 
43
class TransactionServices
57
44
{
58
45
public:
59
 
  static const size_t DEFAULT_RECORD_SIZE= 100;
60
 
  
61
 
  TransactionServices();
 
46
  /**
 
47
   * Constructor
 
48
   */
 
49
  TransactionServices() {}
62
50
 
63
51
  /**
64
52
   * Singleton method
69
57
    static TransactionServices transaction_services;
70
58
    return transaction_services;
71
59
  }
72
 
 
73
 
  /**
74
 
   * Returns true if the transaction manager should construct
75
 
   * Transaction and Statement messages, false otherwise.
76
 
   */
77
 
  bool shouldConstructMessages();
78
 
 
79
 
  /**
80
 
   * Finalizes a Statement message and sets the Session's statement
81
 
   * message to NULL.
82
 
   *
83
 
   * @param statement The statement to initialize
84
 
   * @param session The Session object processing this statement
85
 
   */
86
 
  void finalizeStatementMessage(message::Statement &statement,
87
 
                                Session::reference session);
88
 
 
89
 
  /**
90
 
   * Creates a new InsertRecord GPB message and pushes it to
91
 
   * replicators.
92
 
   *
93
 
   * @param session Session object which has inserted a record
94
 
   * @param table Table object containing insert information
95
 
   *
96
 
   * Grr, returning "true" here on error because of the cursor
97
 
   * reversed bool return crap...fix that.
98
 
   */
99
 
  bool insertRecord(Session::reference session, Table &in_table);
100
 
 
101
 
  /**
102
 
   * Creates a new UpdateRecord GPB message and pushes it to
103
 
   * replicators.
104
 
   *
105
 
   * @param session Session object which has updated a record
106
 
   * @param table Table object containing update information
107
 
   * @param old_record Pointer to the raw bytes representing the old record/row
108
 
   * @param new_record Pointer to the raw bytes representing the new record/row 
109
 
   */
110
 
  void updateRecord(Session::reference session, 
111
 
                    Table &table, 
112
 
                    const unsigned char *old_record, 
113
 
                    const unsigned char *new_record);
114
 
 
115
 
  /**
116
 
   * Creates a new DeleteRecord GPB message and pushes it to
117
 
   * replicators.
118
 
   *
119
 
   * @param session Session object which has deleted a record
120
 
   * @param table Table object containing delete information
121
 
   * @param use_update_record If true, uses the values from the update row instead
122
 
   */
123
 
  void deleteRecord(Session::reference session,
124
 
                    Table &table,
125
 
                    bool use_update_record= false);
126
 
 
127
 
  /**
128
 
   * Creates a CreateSchema Statement GPB message and adds it
129
 
   * to the Session's active Transaction GPB message for pushing
130
 
   * out to the replicator streams.
131
 
   *
132
 
   * @param[in] session Session object which issued the statement
133
 
   * @param[in] schema message::Schema message describing new schema
134
 
   */
135
 
  void createSchema(Session::reference session, const message::Schema &schema);
136
 
 
137
 
  /**
138
 
   * Creates a DropSchema Statement GPB message and adds it
139
 
   * to the Session's active Transaction GPB message for pushing
140
 
   * out to the replicator streams.
141
 
   *
142
 
   * @param[in] session Session object which issued the statement
143
 
   * @param[in] identifier Identifier for the schema to drop
144
 
   */
145
 
  void dropSchema(Session::reference session,
146
 
                  identifier::Schema::const_reference identifier);
147
 
 
148
 
  /**
149
 
   * Creates an AlterSchema Statement GPB message and adds it
150
 
   * to the Session's active Transaction GPB message for pushing
151
 
   * out to the replicator streams.
152
 
   *
153
 
   * @param[in] session Session object which issued the statement
154
 
   * @param[in] old_schema Original schema definition
155
 
   * @param[in] new_schema New schema definition
156
 
   */
157
 
  void alterSchema(Session::reference session,
158
 
                   const message::schema::shared_ptr &old_schema,
159
 
                   const message::Schema &new_schema);
160
 
 
161
 
  /**
162
 
   * Creates a CreateTable Statement GPB message and adds it
163
 
   * to the Session's active Transaction GPB message for pushing
164
 
   * out to the replicator streams.
165
 
   *
166
 
   * @param[in] session Session object which issued the statement
167
 
   * @param[in] table message::Table message describing new schema
168
 
   */
169
 
  void createTable(Session::reference session, const message::Table &table);
170
 
 
171
 
  /**
172
 
   * Creates a DropTable Statement GPB message and adds it
173
 
   * to the Session's active Transaction GPB message for pushing
174
 
   * out to the replicator streams.
175
 
   *
176
 
   * @param[in] session Session object which issued the statement
177
 
   * @param[in] table Identifier for the table being dropped
178
 
   * @param[in] if_exists Did the user specify an IF EXISTS clause?
179
 
   */
180
 
  void dropTable(Session::reference session,
181
 
                 const identifier::Table &table,
182
 
                 bool if_exists);
183
 
 
184
 
  /**
185
 
   * Creates a TruncateTable Statement GPB message and adds it
186
 
   * to the Session's active Transaction GPB message for pushing
187
 
   * out to the replicator streams.
188
 
   *
189
 
   * @param[in] session Session object which issued the statement
190
 
   * @param[in] table The Table being truncated
191
 
   */
192
 
  void truncateTable(Session::reference session, Table &table);
193
 
 
194
 
  /**
195
 
   * Creates a new RawSql GPB message and pushes it to 
196
 
   * replicators.
197
 
   *
198
 
   * @TODO With a real data dictionary, this really shouldn't
199
 
   * be needed.  CREATE TABLE would map to insertRecord call
200
 
   * on the I_S, etc.  Not sure what to do with administrative
201
 
   * commands like CHECK TABLE, though..
202
 
   *
203
 
   * @param session Session object which issued the statement
204
 
   * @param query Query string
205
 
   */
206
 
  void rawStatement(Session::reference session, const std::string &query);
207
 
 
208
60
  /* transactions: interface to plugin::StorageEngine functions */
209
 
  int rollbackTransaction(Session::reference session, bool all);
210
 
 
211
 
  /**
212
 
   * Commit the current transaction.
213
 
   *
214
 
   * @retval 0 ok
215
 
   * @retval 1 transaction was rolled back
216
 
   * @retval 2 error during commit, data may be inconsistent
217
 
   *
218
 
   * @todo
219
 
   * Since we don't support nested statement transactions in 5.0,
220
 
   * we can't commit or rollback stmt transactions while we are inside
221
 
   * stored functions or triggers. So we simply do nothing now.
222
 
   * This should be fixed in later ( >= 5.1) releases.
223
 
   */
224
 
  int commitTransaction(Session::reference session, bool all);
225
 
 
226
 
  /**
227
 
   * This is used to commit or rollback a single statement depending on
228
 
   * the value of error.
229
 
   *
230
 
   * @note
231
 
   * Note that if the autocommit is on, then the following call inside
232
 
   * InnoDB will commit or rollback the whole transaction (= the statement). The
233
 
   * autocommit mechanism built into InnoDB is based on counting locks, but if
234
 
   * the user has used LOCK TABLES then that mechanism does not know to do the
235
 
   * commit.
236
 
   */
237
 
  int autocommitOrRollback(Session::reference session, int error);
 
61
  int ha_commit_one_phase(Session *session, bool all);
 
62
  int ha_rollback_trans(Session *session, bool all);
 
63
 
 
64
  /* transactions: these functions never call plugin::StorageEngine functions directly */
 
65
  int ha_commit_trans(Session *session, bool all);
 
66
  int ha_autocommit_or_rollback(Session *session, int error);
238
67
 
239
68
  /* savepoints */
240
 
  int rollbackToSavepoint(Session::reference session, NamedSavepoint &sv);
241
 
  int setSavepoint(Session::reference session, NamedSavepoint &sv);
242
 
  int releaseSavepoint(Session::reference session, NamedSavepoint &sv);
243
 
 
244
 
  /**
245
 
   * Marks a storage engine as participating in a statement
246
 
   * transaction.
247
 
   *
248
 
   * @note
249
 
   * 
250
 
   * This method is idempotent
251
 
   *
252
 
   * @todo
253
 
   *
254
 
   * This method should not be called more than once per resource
255
 
   * per statement, and therefore should not need to be idempotent.
256
 
   * Put in assert()s to test this.
257
 
   *
258
 
   * @param[in] session Session object
259
 
   * @param[in] monitored Descriptor for the resource which will be participating
260
 
   * @param[in] engine Pointer to the TransactionalStorageEngine resource
261
 
   */
262
 
  void registerResourceForStatement(Session::reference session,
263
 
                                    plugin::MonitoredInTransaction *monitored,
264
 
                                    plugin::TransactionalStorageEngine *engine);
265
 
 
266
 
  /**
267
 
   * Marks an XA storage engine as participating in a statement
268
 
   * transaction.
269
 
   *
270
 
   * @note
271
 
   * 
272
 
   * This method is idempotent
273
 
   *
274
 
   * @todo
275
 
   *
276
 
   * This method should not be called more than once per resource
277
 
   * per statement, and therefore should not need to be idempotent.
278
 
   * Put in assert()s to test this.
279
 
   *
280
 
   * @param[in] session Session object
281
 
   * @param[in] monitored Descriptor for the resource which will be participating
282
 
   * @param[in] engine Pointer to the TransactionalStorageEngine resource
283
 
   * @param[in] resource_manager Pointer to the XaResourceManager resource manager
284
 
   */
285
 
  void registerResourceForStatement(Session::reference session,
286
 
                                    plugin::MonitoredInTransaction *monitored,
287
 
                                    plugin::TransactionalStorageEngine *engine,
288
 
                                    plugin::XaResourceManager *resource_manager);
289
 
 
290
 
  /**
291
 
   * Registers a resource manager in the "normal" transaction.
292
 
   *
293
 
   * @note
294
 
   *
295
 
   * This method is idempotent and must be idempotent
296
 
   * because it can be called both by the above 
297
 
   * TransactionServices::registerResourceForStatement(),
298
 
   * which occurs at the beginning of each SQL statement,
299
 
   * and also manually when a BEGIN WORK/START TRANSACTION
300
 
   * statement is executed. If the latter case (BEGIN WORK)
301
 
   * is called, then subsequent contained statement transactions
302
 
   * will call this method as well.
303
 
   *
304
 
   * @note
305
 
   *
306
 
   * This method checks to see if the supplied resource
307
 
   * is also registered in the statement transaction, and
308
 
   * if not, registers the resource in the statement
309
 
   * transaction.  This happens ONLY when the user has
310
 
   * called BEGIN WORK/START TRANSACTION, which is the only
311
 
   * time when this method is called except from the
312
 
   * TransactionServices::registerResourceForStatement method.
313
 
   */
314
 
  void registerResourceForTransaction(Session::reference session,
315
 
                                      plugin::MonitoredInTransaction *monitored,
316
 
                                      plugin::TransactionalStorageEngine *engine);
317
 
 
318
 
  void registerResourceForTransaction(Session::reference session,
319
 
                                      plugin::MonitoredInTransaction *monitored,
320
 
                                      plugin::TransactionalStorageEngine *engine,
321
 
                                      plugin::XaResourceManager *resource_manager);
322
 
 
323
 
  void allocateNewTransactionId();
324
 
 
325
 
  /**************
326
 
   * Events API
327
 
   **************/
328
 
 
329
 
  /**
330
 
   * Send server startup event.
331
 
   *
332
 
   * @param session Session object
333
 
   *
334
 
   * @retval true Success
335
 
   * @retval false Failure
336
 
   */
337
 
  bool sendStartupEvent(Session::reference session);
338
 
 
339
 
  /**
340
 
   * Send server shutdown event.
341
 
   *
342
 
   * @param session Session object
343
 
   *
344
 
   * @retval true Success
345
 
   * @retval false Failure
346
 
   */
347
 
  bool sendShutdownEvent(Session::reference session);
348
 
 
349
 
private:
350
 
 
351
 
  /**
352
 
   * Method which returns the active Transaction message
353
 
   * for the supplied Session.  If one is not found, a new Transaction
354
 
   * message is allocated, initialized, and returned. It is possible that
355
 
   * we may want to NOT increment the transaction id for a new Transaction
356
 
   * object (e.g., splitting up Transactions into smaller chunks). The
357
 
   * should_inc_trx_id flag controls if we do this.
358
 
   *
359
 
   * @param session The Session object processing the transaction
360
 
   * @param should_inc_trx_id If true, increments the transaction id for a new trx
361
 
   */
362
 
  message::Transaction *getActiveTransactionMessage(Session::reference session,
363
 
                                                    bool should_inc_trx_id= true);
364
 
 
365
 
  /** 
366
 
   * Method which attaches a transaction context
367
 
   * the supplied transaction based on the supplied Session's
368
 
   * transaction information.  This method also ensure the
369
 
   * transaction message is attached properly to the Session object
370
 
   *
371
 
   * @param transaction The transaction message to initialize
372
 
   * @param session The Session object processing this transaction
373
 
   * @param should_inc_trx_id If true, increments the transaction id for a new trx
374
 
   */
375
 
  void initTransactionMessage(message::Transaction &transaction,
376
 
                              Session::reference session,
377
 
                              bool should_inc_trx_id);
378
 
  
379
 
  /**
380
 
   * Helper method which initializes a Statement message
381
 
   *
382
 
   * @param statement The statement to initialize
383
 
   * @param type The type of the statement
384
 
   * @param session The Session object processing this statement
385
 
   */
386
 
  void initStatementMessage(message::Statement &statement,
387
 
                            message::Statement::Type type,
388
 
                            Session::const_reference session);
389
 
 
390
 
  /** 
391
 
   * Helper method which finalizes data members for the 
392
 
   * supplied transaction's context.
393
 
   *
394
 
   * @param transaction The transaction message to finalize 
395
 
   * @param session The Session object processing this transaction
396
 
   */
397
 
  void finalizeTransactionMessage(message::Transaction &transaction,
398
 
                                  Session::const_reference session);
399
 
 
400
 
  /**
401
 
   * Helper method which deletes transaction memory and
402
 
   * unsets Session's transaction and statement messages.
403
 
   */
404
 
  void cleanupTransactionMessage(message::Transaction *transaction,
405
 
                                 Session::reference session);
406
 
  
407
 
  /** Helper method which returns an initialized Statement message for methods
408
 
   * doing insertion of data.
409
 
   *
410
 
   * @param[in] session Session object doing the processing
411
 
   * @param[in] table Table object being inserted into
412
 
   * @param[out] next_segment_id The next Statement segment id to be used
413
 
   */
414
 
  message::Statement &getInsertStatement(Session::reference session,
415
 
                                         Table &table,
416
 
                                         uint32_t *next_segment_id);
417
 
  
418
 
  /**
419
 
   * Helper method which initializes the header message for
420
 
   * insert operations.
421
 
   *
422
 
   * @param[in,out] statement Statement message container to modify
423
 
   * @param[in] session Session object doing the processing
424
 
   * @param[in] table Table object being inserted into
425
 
   */
426
 
  void setInsertHeader(message::Statement &statement,
427
 
                       Session::const_reference session,
428
 
                       Table &table);
429
 
  /**
430
 
   * Helper method which returns an initialized Statement
431
 
   * message for methods doing updates of data.
432
 
   *
433
 
   * @param[in] session Session object doing the processing
434
 
   * @param[in] table Table object being updated
435
 
   * @param[in] old_record Pointer to the old data in the record
436
 
   * @param[in] new_record Pointer to the new data in the record
437
 
   * @param[out] next_segment_id The next Statement segment id to be used
438
 
   */
439
 
  message::Statement &getUpdateStatement(Session::reference session,
440
 
                                         Table &table,
441
 
                                         const unsigned char *old_record, 
442
 
                                         const unsigned char *new_record,
443
 
                                         uint32_t *next_segment_id);
444
 
  /**
445
 
   * Helper method which initializes the header message for
446
 
   * update operations.
447
 
   *
448
 
   * @param[in,out] statement Statement message container to modify
449
 
   * @param[in] session Session object doing the processing
450
 
   * @param[in] table Table object being updated
451
 
   * @param[in] old_record Pointer to the old data in the record
452
 
   * @param[in] new_record Pointer to the new data in the record
453
 
   */
454
 
  void setUpdateHeader(message::Statement &statement,
455
 
                       Session::const_reference session,
456
 
                       Table &table,
457
 
                       const unsigned char *old_record, 
458
 
                       const unsigned char *new_record);
459
 
 
460
 
  /**
461
 
   * Helper method which returns an initialized Statement
462
 
   * message for methods doing deletion of data.
463
 
   *
464
 
   * @param[in] session Session object doing the processing
465
 
   * @param[in] table Table object being deleted from
466
 
   * @param[out] next_segment_id The next Statement segment id to be used
467
 
   */
468
 
  message::Statement &getDeleteStatement(Session::reference session,
469
 
                                         Table &table,
470
 
                                         uint32_t *next_segment_id);
471
 
  
472
 
  /**
473
 
   * Helper method which initializes the header message for
474
 
   * insert operations.
475
 
   *
476
 
   * @param[in,out] statement Statement message container to modify
477
 
   * @param[in] session Session object doing the processing
478
 
   * @param[in] table Table object being deleted from
479
 
   */
480
 
  void setDeleteHeader(message::Statement &statement,
481
 
                       Session::const_reference session,
482
 
                       Table &table);
483
 
 
484
 
  /** 
485
 
   * Commits a normal transaction (see above) and pushes the transaction
486
 
   * message out to the replicators.
487
 
   *
488
 
   * @param session Session object committing the transaction
489
 
   */
490
 
  int commitTransactionMessage(Session::reference session);
491
 
 
492
 
  /** 
493
 
   * Marks the current active transaction message as being rolled back and
494
 
   * pushes the transaction message out to replicators.
495
 
   *
496
 
   * @param session Session object committing the transaction
497
 
   */
498
 
  void rollbackTransactionMessage(Session::reference session);
499
 
 
500
 
  /**
501
 
   * Rolls back the current statement, deleting the last Statement out of
502
 
   * the current Transaction message.
503
 
   *
504
 
   * @param session Session object committing the transaction
505
 
   *
506
 
   * @note This depends on having clear statement boundaries (i.e., one
507
 
   * Statement message per actual SQL statement).
508
 
   */
509
 
  void rollbackStatementMessage(Session::reference session);
510
 
 
511
 
  /**
512
 
   * Checks if a field has been updated 
513
 
   *
514
 
   * @param current_field Pointer to the field to check if it is updated 
515
 
   * @param table Table object containing update information
516
 
   * @param old_record Pointer to the raw bytes representing the old record/row
517
 
   * @param new_record Pointer to the raw bytes representing the new record/row
518
 
   */
519
 
  bool isFieldUpdated(Field *current_field,
520
 
                      Table &table,
521
 
                      const unsigned char *old_record,
522
 
                      const unsigned char *new_record);
523
 
 
524
 
  /**
525
 
   * Create a Transaction that contains event information and send it off.
526
 
   *
527
 
   * This differs from other uses of Transaction in that we don't use the
528
 
   * message associated with Session. We create a totally new message and
529
 
   * use it.
530
 
   *
531
 
   * @param session Session object
532
 
   * @param event Event message to send
533
 
   *
534
 
   * @note Used by the public Events API.
535
 
   *
536
 
   * @returns Non-zero on error
537
 
   */
538
 
  int sendEvent(Session::reference session, const message::Event &event);
539
 
 
540
 
  /**
541
 
   * Makes a given Transaction message segmented.
542
 
   *
543
 
   * The given Transaction message will have its segment information set
544
 
   * appropriately and a new Transaction message, containing the same
545
 
   * transaction ID as the supplied Transaction, and is created.
546
 
   *
547
 
   * @param session Session object
548
 
   * @param transaction Transaction message to segment.
549
 
   *
550
 
   * @returns Returns a pointer to a new Transaction message ready for use.
551
 
   */
552
 
  message::Transaction *segmentTransactionMessage(Session::reference session,
553
 
                                                  message::Transaction *transaction);
554
 
 
555
 
  int commitPhaseOne(Session::reference session, bool all);
556
 
 
557
 
  uint64_t getCurrentTransactionId(Session::reference session);
558
 
 
559
 
  plugin::XaStorageEngine *xa_storage_engine;
 
69
  int ha_rollback_to_savepoint(Session *session, NamedSavepoint &sv);
 
70
  int ha_savepoint(Session *session, NamedSavepoint &sv);
 
71
  int ha_release_savepoint(Session *session, NamedSavepoint &sv);
 
72
  bool mysql_xa_recover(Session *session);
 
73
 
 
74
  /* these are called by storage engines */
 
75
  void trans_register_ha(Session *session, bool all, plugin::TransactionalStorageEngine *engine);
560
76
};
561
77
 
562
78
} /* namespace drizzled */