1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/* Copyright (c) 2019-2020, Codership Oy. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file This unit defines simple "transactional storage engine" interface
*/
#ifndef NODE_STORE_H
#define NODE_STORE_H
#include "options.h"
#include "../../wsrep_api.h"
typedef struct node_store node_store_t;
/**
* open a store and optionally assocoate a file with it */
extern node_store_t*
node_store_open(const struct node_options* opts);
/**
* close store and deallocate associated resources */
extern void
node_store_close(node_store_t* store);
/**
* initialize store with a state */
extern int
node_store_init_state(node_store_t* store, const void* state, size_t state_len);
/**
* Return a pointer to state snapshot that is guaranteed to be unchanged
* until node_store_release_state() is called.
*
* @param[out] state pointer to state snapshot
* @param[out] state_len soze of state snapshot
*/
extern int
node_store_acquire_state(node_store_t* store,
const void** state, size_t* state_len);
/**
* release state */
extern void
node_store_release_state(node_store_t* store);
/**
* inform store about new membership */
extern int
node_store_update_membership(node_store_t* store, const wsrep_view_info_t* v);
/**
* get the current GTID (last committed) */
extern void
node_store_gtid(node_store_t* store, wsrep_gtid_t* gtid);
/**
* execute and prepare local transaction in store and return its key and write
* set.
*
* This operation allocates resources that must be freed with either
* node_store_commit() or node_store_rollback()
*
* @param[in] wsrep provider handle
* @param[out] ws_handle reference to the resulting write set in the provider
*/
extern int
node_store_execute(node_store_t* store,
wsrep_t* wsrep,
wsrep_ws_handle_t* ws_handle);
/**
* apply and prepare foreign write set received from replication
*
* This operation allocates resources that must be freed with either
* node_store_commit() or node_store_rollback()
*
* @param[out] trx_id locally unique transaction ID
* @param[in] ws foreign transaction write set
*/
extern int
node_store_apply(node_store_t* store,
wsrep_trx_id_t* trx_id,
const wsrep_buf_t* ws);
/**
* commit prepared transaction identified by trx_id */
extern void
node_store_commit(node_store_t* store,
wsrep_trx_id_t trx_id,
const wsrep_gtid_t* ws_gtid);
/**
* rollback prepared transaction identified by trx_id */
extern void
node_store_rollback(node_store_t* store,
wsrep_trx_id_t trx_id);
/**
* update storage GTID for transactions that had to be skipped/rolled back */
extern void
node_store_update_gtid(node_store_t* store,
const wsrep_gtid_t* ws_gtid);
/**
* @return the number of store read view snapshot check failures at commit time.
* (should be zero if provider implements assign_read_view() call) */
extern long
node_store_read_view_failures(node_store_t* store);
#endif /* NODE_STORE_H */
|
