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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- */
// vim: ft=cpp:expandtab:ts=8:sw=4:softtabstop=4:
#ident "$Id$"
/*======
This file is part of PerconaFT.
Copyright (c) 2006, 2015, Percona and/or its affiliates. All rights reserved.
PerconaFT is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2,
as published by the Free Software Foundation.
PerconaFT 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 PerconaFT. If not, see <http://www.gnu.org/licenses/>.
----------------------------------------
PerconaFT is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License, version 3,
as published by the Free Software Foundation.
PerconaFT 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with PerconaFT. If not, see <http://www.gnu.org/licenses/>.
======= */
#ident "Copyright (c) 2006, 2015, Percona and/or its affiliates. All rights reserved."
#pragma once
#include <ft/comparator.h>
#include "treenode.h"
#include "keyrange.h"
namespace toku {
// A concurrent_tree stores non-overlapping ranges.
// Access to disjoint parts of the tree usually occurs concurrently.
class concurrent_tree {
public:
// A locked_keyrange gives you exclusive access to read and write
// operations that occur on any keys in that range. You only have
// the right to operate on keys in that range or keys that were read
// from the keyrange using iterate()
//
// Access model:
// - user prepares a locked keyrange. all threads serialize behind prepare().
// - user breaks the serialzation point by acquiring a range, or releasing.
// - one thread operates on a certain locked_keyrange object at a time.
// - when the thread is finished, it releases
class locked_keyrange {
public:
// effect: prepare to acquire a locked keyrange over the given
// concurrent_tree, preventing other threads from preparing
// until this thread either does acquire() or release().
// note: operations performed on a prepared keyrange are equivalent
// to ones performed on an acquired keyrange over -inf, +inf.
// rationale: this provides the user with a serialization point for descending
// or modifying the the tree. it also proives a convenient way of
// doing serializable operations on the tree.
// There are two valid sequences of calls:
// - prepare, acquire, [operations], release
// - prepare, [operations],release
void prepare(concurrent_tree *tree);
// requires: the locked keyrange was prepare()'d
// effect: acquire a locked keyrange over the given concurrent_tree.
// the locked keyrange represents the range of keys overlapped
// by the given range
void acquire(const keyrange &range);
// effect: releases a locked keyrange and the mutex it holds
void release(void);
// effect: iterate over each range this locked_keyrange represents,
// calling function->fn() on each node's keyrange and txnid
// until there are no more or the function returns false
template <class F>
void iterate(F *function) const;
// inserts the given range into the tree, with an associated txnid.
// requires: range does not overlap with anything in this locked_keyrange
// rationale: caller is responsible for only inserting unique ranges
void insert(const keyrange &range, TXNID txnid);
// effect: removes the given range from the tree
// requires: range exists exactly in this locked_keyrange
// rationale: caller is responsible for only removing existing ranges
void remove(const keyrange &range);
// effect: removes all of the keys represented by this locked keyrange
// rationale: we'd like a fast way to empty out a tree
void remove_all(void);
private:
// the concurrent tree this locked keyrange is for
concurrent_tree *m_tree;
// the range of keys this locked keyrange represents
keyrange m_range;
// the subtree under which all overlapping ranges exist
treenode *m_subtree;
friend class concurrent_tree_unit_test;
};
// effect: initialize the tree to an empty state
void create(const comparator *cmp);
// effect: destroy the tree.
// requires: tree is empty
void destroy(void);
// returns: true iff the tree is empty
bool is_empty(void);
// returns: the memory overhead of a single insertion into the tree
static uint64_t get_insertion_memory_overhead(void);
private:
// the root needs to always exist so there's a lock to grab
// even if the tree is empty. that's why we store a treenode
// here and not a pointer to one.
treenode m_root;
friend class concurrent_tree_unit_test;
};
// include the implementation here so we can use templated member
// functions in locked_keyrange, which are expanded and defined in the
// compilation unit that includes "concurrent_tree.h". if we didn't
// include the source here, then there would be problems with multiple
// definitions of the tree functions
#include "concurrent_tree.cc"
} /* namespace toku */
|
