/
DatabaseSnapshot.h
347 lines (285 loc) · 7.31 KB
/
DatabaseSnapshot.h
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/*
* The contents of this file are subject to the Initial
* Developer's Public License Version 1.0 (the "License");
* you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
* http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_idpl.
*
* Software distributed under the License is distributed AS IS,
* WITHOUT WARRANTY OF ANY KIND, either express or implied.
* See the License for the specific language governing rights
* and limitations under the License.
*
* The Original Code was created by Dmitry Yemanov
* for the Firebird Open Source RDBMS project.
*
* Copyright (c) 2006 Dmitry Yemanov <dimitr@users.sf.net>
* and all contributors signed below.
*
* All Rights Reserved.
* Contributor(s): ______________________________________.
*/
#ifndef JRD_DATABASE_SNAPSHOT_H
#define JRD_DATABASE_SNAPSHOT_H
#include "../common/classes/array.h"
#include "../common/classes/init.h"
#include "../jrd/isc_s_proto.h"
namespace Jrd {
// forward declarations
class jrd_rel;
class RecordBuffer;
class RuntimeStatistics;
class DatabaseSnapshot
{
enum ValueType {VALUE_GLOBAL_ID, VALUE_INTEGER, VALUE_TIMESTAMP, VALUE_STRING};
struct DumpField
{
USHORT id;
ValueType type;
USHORT length;
void* data;
};
class DumpRecord
{
public:
DumpRecord() : offset(0), sizeLimit(0)
{}
explicit DumpRecord(int rel_id)
{
reset(rel_id);
}
void reset(int rel_id)
{
offset = 0;
sizeLimit = sizeof(buffer);
fb_assert(rel_id > 0 && rel_id <= int(MAX_UCHAR));
buffer[offset++] = (UCHAR) rel_id;
}
void assign(USHORT length, const UCHAR* ptr)
{
// CVC: While length is USHORT, this assertion is redundant.
// fb_assert(length <= MAX_FORMAT_SIZE); // commented - AP - avoid gcc warning
offset = 0;
sizeLimit = length;
memcpy(buffer, ptr, length);
}
ULONG getLength() const
{
return offset;
}
const UCHAR* getData() const
{
return buffer;
}
void storeGlobalId(int field_id, SINT64 value)
{
storeField(field_id, VALUE_GLOBAL_ID, sizeof(SINT64), &value);
}
void storeInteger(int field_id, SINT64 value)
{
storeField(field_id, VALUE_INTEGER, sizeof(SINT64), &value);
}
void storeTimestamp(int field_id, const Firebird::TimeStamp& value)
{
if (!value.isEmpty())
{
storeField(field_id, VALUE_TIMESTAMP, sizeof(ISC_TIMESTAMP), &value.value());
}
}
void storeString(int field_id, const Firebird::string& value)
{
if (value.length())
{
storeField(field_id, VALUE_STRING, value.length(), value.c_str());
}
}
void storeString(int field_id, const Firebird::PathName& value)
{
if (value.length())
{
storeField(field_id, VALUE_STRING, value.length(), value.c_str());
}
}
void storeString(int field_id, const Firebird::MetaName& value)
{
if (value.length())
{
storeField(field_id, VALUE_STRING, value.length(), value.c_str());
}
}
int getRelationId()
{
fb_assert(!offset);
return (ULONG) buffer[offset++];
}
bool getField(DumpField& field)
{
fb_assert(offset);
if (offset < sizeLimit)
{
field.id = (USHORT) buffer[offset++];
field.type = (ValueType) buffer[offset++];
fb_assert(field.type >= VALUE_GLOBAL_ID && field.type <= VALUE_STRING);
memcpy(&field.length, buffer + offset, sizeof(USHORT));
offset += sizeof(USHORT);
field.data = buffer + offset;
offset += field.length;
return true;
}
return false;
}
private:
void storeField(int field_id, ValueType type, size_t length, const void* value)
{
const size_t delta = sizeof(UCHAR) + sizeof(UCHAR) + sizeof(USHORT) + length;
if (offset + delta > sizeLimit)
{
fb_assert(false);
return;
}
UCHAR* ptr = buffer + offset;
fb_assert(field_id <= int(MAX_UCHAR));
*ptr++ = (UCHAR) field_id;
*ptr++ = (UCHAR) type;
const USHORT adjusted_length = (USHORT) length;
memcpy(ptr, &adjusted_length, sizeof(adjusted_length));
ptr += sizeof(USHORT);
memcpy(ptr, value, length);
offset += (ULONG) delta;
}
UCHAR buffer[MAX_FORMAT_SIZE];
ULONG offset;
ULONG sizeLimit;
};
struct RelationData
{
int rel_id;
RecordBuffer* data;
};
public:
class SnapshotHeader : public MemoryHeader
{
public:
ULONG used;
ULONG allocated;
};
class SharedData : public SharedMemory<SnapshotHeader>
{
static const ULONG MONITOR_VERSION = 3;
static const ULONG DEFAULT_SIZE = 1048576;
typedef SnapshotHeader Header;
struct Element
{
SLONG processId;
SLONG localId;
ULONG length;
};
static ULONG alignOffset(ULONG absoluteOffset);
public:
explicit SharedData(const Database*);
~SharedData();
bool initialize(bool);
void mutexBug(int osErrorCode, const char* text);
void acquire();
void release();
UCHAR* read(MemoryPool&, ULONG&);
ULONG setup();
void write(ULONG, ULONG, const void*);
void cleanup();
private:
// copying is prohibited
SharedData(const SharedData&);
SharedData& operator =(const SharedData&);
void ensureSpace(ULONG);
const SLONG process_id;
const SLONG local_id;
};
private:
class DumpGuard
{
public:
explicit DumpGuard(SharedData* ptr)
: data(ptr)
{
data->acquire();
}
~DumpGuard()
{
data->release();
}
private:
DumpGuard(const DumpGuard&);
DumpGuard& operator=(const DumpGuard&);
SharedData* const data;
};
class Writer
{
public:
explicit Writer(SharedData* data)
: dump(data)
{
fb_assert(dump);
offset = dump->setup();
fb_assert(offset);
}
void putRecord(const DumpRecord& record)
{
const USHORT length = (USHORT) record.getLength();
dump->write(offset, sizeof(USHORT), &length);
dump->write(offset, length, record.getData());
}
private:
SharedData* dump;
ULONG offset;
};
class Reader
{
public:
Reader(ULONG length, UCHAR* ptr)
: sizeLimit(length), buffer(ptr), offset(0)
{}
bool getRecord(DumpRecord& record)
{
if (offset < sizeLimit)
{
USHORT length;
memcpy(&length, buffer + offset, sizeof(USHORT));
offset += sizeof(USHORT);
record.assign(length, buffer + offset);
offset += length;
return true;
}
return false;
}
private:
ULONG sizeLimit;
const UCHAR* buffer;
ULONG offset;
};
public:
~DatabaseSnapshot();
RecordBuffer* getData(const jrd_rel*) const;
static DatabaseSnapshot* create(thread_db*);
static int blockingAst(void*);
protected:
DatabaseSnapshot(thread_db*, MemoryPool&);
private:
RecordBuffer* allocBuffer(thread_db*, MemoryPool&, int);
void clearRecord(Record*);
void putField(thread_db*, Record*, const DumpField&, int&, bool = false);
static void dumpData(thread_db*);
static SINT64 getGlobalId(int);
static void putDatabase(const Database*, Writer&, int);
static bool putAttachment(thread_db*, const Attachment*, Writer&, int);
static void putTransaction(const jrd_tra*, Writer&, int);
static void putRequest(const jrd_req*, Writer&, int);
static void putCall(const jrd_req*, Writer&, int);
static void putStatistics(const RuntimeStatistics&, Writer&, int, int);
static void putContextVars(const Firebird::StringMap&, Writer&, int, bool);
static void putMemoryUsage(const Firebird::MemoryStats&, Writer&, int, int);
Firebird::Array<RelationData> snapshot;
Firebird::GenericMap<Firebird::Pair<Firebird::NonPooled<SINT64, SLONG> > > idMap;
int idCounter;
};
} // namespace
#endif // JRD_DATABASE_SNAPSHOT_H