summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/src/include/schema.h
blob: a945c895182d258898e273ea36b5613af74ff435 (plain)
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
/*-
 * Copyright (c) 2014-2019 MongoDB, Inc.
 * Copyright (c) 2008-2014 WiredTiger, Inc.
 *	All rights reserved.
 *
 * See the file LICENSE for redistribution information.
 */

/* Character constants for projection plans */
#define WT_PROJ_KEY 'k'   /* Go to key in cursor <arg> */
#define WT_PROJ_NEXT 'n'  /* Process the next item (<arg> repeats) */
#define WT_PROJ_REUSE 'r' /* Reuse the previous item (<arg> repeats) */
#define WT_PROJ_SKIP 's'  /* Skip a column in the cursor (<arg> repeats) */
#define WT_PROJ_VALUE 'v' /* Go to the value in cursor <arg> */

struct __wt_colgroup {
    const char *name;   /* Logical name */
    const char *source; /* Underlying data source */
    const char *config; /* Configuration string */

    WT_CONFIG_ITEM colconf; /* List of columns from config */
};

struct __wt_index {
    const char *name;   /* Logical name */
    const char *source; /* Underlying data source */
    const char *config; /* Configuration string */

    WT_CONFIG_ITEM colconf; /* List of columns from config */

    WT_COLLATOR *collator; /* Custom collator */
    int collator_owned;    /* Collator is owned by this index */

    WT_EXTRACTOR *extractor; /* Custom key extractor */
    int extractor_owned;     /* Extractor is owned by this index */

    const char *key_format; /* Key format */
    const char *key_plan;   /* Key projection plan */
    const char *value_plan; /* Value projection plan */

    const char *idxkey_format; /* Index key format (hides primary) */
    const char *exkey_format;  /* Key format for custom extractors */

/* AUTOMATIC FLAG VALUE GENERATION START */
#define WT_INDEX_IMMUTABLE 0x1u
    /* AUTOMATIC FLAG VALUE GENERATION STOP */
    uint32_t flags; /* Index configuration flags */
};

/*
 * WT_TABLE --
 *	Handle for a logical table.  A table consists of one or more column
 *	groups, each of which holds some set of columns all sharing a primary
 *	key; and zero or more indices, each of which holds some set of columns
 *	in an index key that can be used to reconstruct the primary key.
 */
struct __wt_table {
    WT_DATA_HANDLE iface;

    const char *plan;
    const char *key_format, *value_format;

    WT_CONFIG_ITEM cgconf, colconf;

    WT_COLGROUP **cgroups;
    WT_INDEX **indices;
    size_t idx_alloc;

    bool cg_complete, idx_complete, is_simple;
    u_int ncolgroups, nindices, nkey_columns;
};

/*
 * Tables without explicit column groups have a single default column group containing all of the
 * columns.
 */
#define WT_COLGROUPS(t) WT_MAX((t)->ncolgroups, 1)

/* Helpers for the locked state of the handle list and table locks. */
#define WT_SESSION_LOCKED_HANDLE_LIST \
    (WT_SESSION_LOCKED_HANDLE_LIST_READ | WT_SESSION_LOCKED_HANDLE_LIST_WRITE)
#define WT_SESSION_LOCKED_TABLE (WT_SESSION_LOCKED_TABLE_READ | WT_SESSION_LOCKED_TABLE_WRITE)
#define WT_SESSION_LOCKED_HOTBACKUP \
    (WT_SESSION_LOCKED_HOTBACKUP_READ | WT_SESSION_LOCKED_HOTBACKUP_WRITE)

/*
 * WT_WITH_LOCK_WAIT --
 *	Wait for a lock, perform an operation, drop the lock.
 */
#define WT_WITH_LOCK_WAIT(session, lock, flag, op) \
    do {                                           \
        if (F_ISSET(session, (flag))) {            \
            op;                                    \
        } else {                                   \
            __wt_spin_lock_track(session, lock);   \
            F_SET(session, (flag));                \
            op;                                    \
            F_CLR(session, (flag));                \
            __wt_spin_unlock(session, lock);       \
        }                                          \
    } while (0)

/*
 * WT_WITH_LOCK_NOWAIT --
 *	Acquire a lock if available, perform an operation, drop the lock.
 */
#define WT_WITH_LOCK_NOWAIT(session, ret, lock, flag, op)                   \
    do {                                                                    \
        (ret) = 0;                                                          \
        if (F_ISSET(session, (flag))) {                                     \
            op;                                                             \
        } else if (((ret) = __wt_spin_trylock_track(session, lock)) == 0) { \
            F_SET(session, (flag));                                         \
            op;                                                             \
            F_CLR(session, (flag));                                         \
            __wt_spin_unlock(session, lock);                                \
        }                                                                   \
    } while (0)

/*
 * WT_WITH_CHECKPOINT_LOCK, WT_WITH_CHECKPOINT_LOCK_NOWAIT --
 *	Acquire the checkpoint lock, perform an operation, drop the lock.
 */
#define WT_WITH_CHECKPOINT_LOCK(session, op) \
    WT_WITH_LOCK_WAIT(session, &S2C(session)->checkpoint_lock, WT_SESSION_LOCKED_CHECKPOINT, op)
#define WT_WITH_CHECKPOINT_LOCK_NOWAIT(session, ret, op) \
    WT_WITH_LOCK_NOWAIT(                                 \
      session, ret, &S2C(session)->checkpoint_lock, WT_SESSION_LOCKED_CHECKPOINT, op)

/*
 * WT_WITH_HANDLE_LIST_READ_LOCK --
 *	Acquire the data handle list lock in shared mode, perform an operation,
 *	drop the lock. The handle list lock is a read-write lock so the
 *	implementation is different to the other lock macros.
 *
 *	Note: always waits because some operations need the handle list lock to
 *	discard handles, and we only expect it to be held across short
 *	operations.
 */
#define WT_WITH_HANDLE_LIST_READ_LOCK(session, op)                 \
    do {                                                           \
        if (F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST)) {     \
            op;                                                    \
        } else {                                                   \
            __wt_readlock(session, &S2C(session)->dhandle_lock);   \
            F_SET(session, WT_SESSION_LOCKED_HANDLE_LIST_READ);    \
            op;                                                    \
            F_CLR(session, WT_SESSION_LOCKED_HANDLE_LIST_READ);    \
            __wt_readunlock(session, &S2C(session)->dhandle_lock); \
        }                                                          \
    } while (0)

/*
 * WT_WITH_HANDLE_LIST_WRITE_LOCK --
 *	Acquire the data handle list lock in exclusive mode, perform an
 *	operation, drop the lock. The handle list lock is a read-write lock so
 *	the implementation is different to the other lock macros.
 */
#define WT_WITH_HANDLE_LIST_WRITE_LOCK(session, op)                                    \
    do {                                                                               \
        if (F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST_WRITE)) {                   \
            op;                                                                        \
        } else {                                                                       \
            WT_ASSERT(session, !F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST_READ)); \
            __wt_writelock(session, &S2C(session)->dhandle_lock);                      \
            F_SET(session, WT_SESSION_LOCKED_HANDLE_LIST_WRITE);                       \
            op;                                                                        \
            F_CLR(session, WT_SESSION_LOCKED_HANDLE_LIST_WRITE);                       \
            __wt_writeunlock(session, &S2C(session)->dhandle_lock);                    \
        }                                                                              \
    } while (0)

/*
 * WT_WITH_METADATA_LOCK --
 *	Acquire the metadata lock, perform an operation, drop the lock.
 */
#define WT_WITH_METADATA_LOCK(session, op) \
    WT_WITH_LOCK_WAIT(session, &S2C(session)->metadata_lock, WT_SESSION_LOCKED_METADATA, op)

/*
 * WT_WITH_SCHEMA_LOCK, WT_WITH_SCHEMA_LOCK_NOWAIT --
 *	Acquire the schema lock, perform an operation, drop the lock.
 *	Check that we are not already holding some other lock: the schema lock
 *	must be taken first.
 */
#define WT_WITH_SCHEMA_LOCK(session, op)                                                      \
    do {                                                                                      \
        WT_ASSERT(session, F_ISSET(session, WT_SESSION_LOCKED_SCHEMA) ||                      \
            !F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST | WT_SESSION_NO_SCHEMA_LOCK |     \
                               WT_SESSION_LOCKED_TABLE));                                     \
        WT_WITH_LOCK_WAIT(session, &S2C(session)->schema_lock, WT_SESSION_LOCKED_SCHEMA, op); \
    } while (0)
#define WT_WITH_SCHEMA_LOCK_NOWAIT(session, ret, op)                                      \
    do {                                                                                  \
        WT_ASSERT(session, F_ISSET(session, WT_SESSION_LOCKED_SCHEMA) ||                  \
            !F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST | WT_SESSION_NO_SCHEMA_LOCK | \
                               WT_SESSION_LOCKED_TABLE));                                 \
        WT_WITH_LOCK_NOWAIT(                                                              \
          session, ret, &S2C(session)->schema_lock, WT_SESSION_LOCKED_SCHEMA, op);        \
    } while (0)

/*
 * WT_WITH_TABLE_READ_LOCK, WT_WITH_TABLE_WRITE_LOCK,
 * WT_WITH_TABLE_WRITE_LOCK_NOWAIT --
 *	Acquire the table lock, perform an operation, drop the lock.
 *	The table lock is a read-write lock so the implementation is different
 *	to most other lock macros.
 *
 *	Note: readlock always waits because some operations need the table lock
 *	to discard handles, and we only expect it to be held across short
 *	operations.
 */
#define WT_WITH_TABLE_READ_LOCK(session, op)                                      \
    do {                                                                          \
        if (F_ISSET(session, WT_SESSION_LOCKED_TABLE)) {                          \
            op;                                                                   \
        } else {                                                                  \
            WT_ASSERT(session, !F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST)); \
            __wt_readlock(session, &S2C(session)->table_lock);                    \
            F_SET(session, WT_SESSION_LOCKED_TABLE_READ);                         \
            op;                                                                   \
            F_CLR(session, WT_SESSION_LOCKED_TABLE_READ);                         \
            __wt_readunlock(session, &S2C(session)->table_lock);                  \
        }                                                                         \
    } while (0)

#define WT_WITH_TABLE_WRITE_LOCK(session, op)                                                   \
    do {                                                                                        \
        if (F_ISSET(session, WT_SESSION_LOCKED_TABLE_WRITE)) {                                  \
            op;                                                                                 \
        } else {                                                                                \
            WT_ASSERT(session,                                                                  \
              !F_ISSET(session, WT_SESSION_LOCKED_TABLE_READ | WT_SESSION_LOCKED_HANDLE_LIST)); \
            __wt_writelock(session, &S2C(session)->table_lock);                                 \
            F_SET(session, WT_SESSION_LOCKED_TABLE_WRITE);                                      \
            op;                                                                                 \
            F_CLR(session, WT_SESSION_LOCKED_TABLE_WRITE);                                      \
            __wt_writeunlock(session, &S2C(session)->table_lock);                               \
        }                                                                                       \
    } while (0)
#define WT_WITH_TABLE_WRITE_LOCK_NOWAIT(session, ret, op)                                     \
    do {                                                                                      \
        WT_ASSERT(session, F_ISSET(session, WT_SESSION_LOCKED_TABLE_WRITE) ||                 \
            !F_ISSET(session, WT_SESSION_LOCKED_TABLE_READ | WT_SESSION_LOCKED_HANDLE_LIST)); \
        if (F_ISSET(session, WT_SESSION_LOCKED_TABLE_WRITE)) {                                \
            op;                                                                               \
        } else if (((ret) = __wt_try_writelock(session, &S2C(session)->table_lock)) == 0) {   \
            F_SET(session, WT_SESSION_LOCKED_TABLE_WRITE);                                    \
            op;                                                                               \
            F_CLR(session, WT_SESSION_LOCKED_TABLE_WRITE);                                    \
            __wt_writeunlock(session, &S2C(session)->table_lock);                             \
        }                                                                                     \
    } while (0)

/*
 * WT_WITH_HOTBACKUP_READ_LOCK --
 *	Acquire the hot backup read lock and perform an operation provided that
 *	there is no hot backup in progress.  The skipp parameter can be used to
 *	check whether the operation got skipped or not.
 */
#define WT_WITH_HOTBACKUP_READ_LOCK(session, op, skipp)         \
    do {                                                        \
        WT_CONNECTION_IMPL *__conn = S2C(session);              \
        if ((skipp) != (bool *)NULL)                            \
            *(bool *)(skipp) = true;                            \
        if (F_ISSET(session, WT_SESSION_LOCKED_HOTBACKUP)) {    \
            if (!__conn->hot_backup) {                          \
                if ((skipp) != (bool *)NULL)                    \
                    *(bool *)(skipp) = false;                   \
                op;                                             \
            }                                                   \
        } else {                                                \
            __wt_readlock(session, &__conn->hot_backup_lock);   \
            F_SET(session, WT_SESSION_LOCKED_HOTBACKUP_READ);   \
            if (!__conn->hot_backup) {                          \
                if ((skipp) != (bool *)NULL)                    \
                    *(bool *)(skipp) = false;                   \
                op;                                             \
            }                                                   \
            F_CLR(session, WT_SESSION_LOCKED_HOTBACKUP_READ);   \
            __wt_readunlock(session, &__conn->hot_backup_lock); \
        }                                                       \
    } while (0)

/*
 * WT_WITH_HOTBACKUP_WRITE_LOCK --
 *	Acquire the hot backup write lock and perform an operation.
 */
#define WT_WITH_HOTBACKUP_WRITE_LOCK(session, op)                                    \
    do {                                                                             \
        WT_CONNECTION_IMPL *__conn = S2C(session);                                   \
        if (F_ISSET(session, WT_SESSION_LOCKED_HOTBACKUP_WRITE)) {                   \
            op;                                                                      \
        } else {                                                                     \
            WT_ASSERT(session, !F_ISSET(session, WT_SESSION_LOCKED_HOTBACKUP_READ)); \
            __wt_writelock(session, &__conn->hot_backup_lock);                       \
            F_SET(session, WT_SESSION_LOCKED_HOTBACKUP_WRITE);                       \
            op;                                                                      \
            F_CLR(session, WT_SESSION_LOCKED_HOTBACKUP_WRITE);                       \
            __wt_writeunlock(session, &__conn->hot_backup_lock);                     \
        }                                                                            \
    } while (0)

/*
 * WT_WITH_HOTBACKUP_READ_LOCK_UNCOND --
 *	Acquire the hot backup read lock and perform an operation
 *	unconditionally.  This is a specialized macro for a few isolated cases.
 *	Code that wishes to acquire the read lock should default to using
 *	WT_WITH_HOTBACKUP_READ_LOCK which checks that there is no hot backup in
 *	progress.
 */
#define WT_WITH_HOTBACKUP_READ_LOCK_UNCOND(session, op)         \
    do {                                                        \
        WT_CONNECTION_IMPL *__conn = S2C(session);              \
        if (F_ISSET(session, WT_SESSION_LOCKED_HOTBACKUP)) {    \
            op;                                                 \
        } else {                                                \
            __wt_readlock(session, &__conn->hot_backup_lock);   \
            F_SET(session, WT_SESSION_LOCKED_HOTBACKUP_READ);   \
            op;                                                 \
            F_CLR(session, WT_SESSION_LOCKED_HOTBACKUP_READ);   \
            __wt_readunlock(session, &__conn->hot_backup_lock); \
        }                                                       \
    } while (0)

/*
 * WT_WITHOUT_LOCKS --
 *	Drop the handle, table and/or schema locks, perform an operation,
 *	re-acquire the lock(s).
 */
#define WT_WITHOUT_LOCKS(session, op)                                                       \
    do {                                                                                    \
        WT_CONNECTION_IMPL *__conn = S2C(session);                                          \
        bool __checkpoint_locked = F_ISSET(session, WT_SESSION_LOCKED_CHECKPOINT);          \
        bool __handle_read_locked = F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST_READ);   \
        bool __handle_write_locked = F_ISSET(session, WT_SESSION_LOCKED_HANDLE_LIST_WRITE); \
        bool __table_read_locked = F_ISSET(session, WT_SESSION_LOCKED_TABLE_READ);          \
        bool __table_write_locked = F_ISSET(session, WT_SESSION_LOCKED_TABLE_WRITE);        \
        bool __schema_locked = F_ISSET(session, WT_SESSION_LOCKED_SCHEMA);                  \
        if (__handle_read_locked) {                                                         \
            F_CLR(session, WT_SESSION_LOCKED_HANDLE_LIST_READ);                             \
            __wt_readunlock(session, &__conn->dhandle_lock);                                \
        }                                                                                   \
        if (__handle_write_locked) {                                                        \
            F_CLR(session, WT_SESSION_LOCKED_HANDLE_LIST_WRITE);                            \
            __wt_writeunlock(session, &__conn->dhandle_lock);                               \
        }                                                                                   \
        if (__table_read_locked) {                                                          \
            F_CLR(session, WT_SESSION_LOCKED_TABLE_READ);                                   \
            __wt_readunlock(session, &__conn->table_lock);                                  \
        }                                                                                   \
        if (__table_write_locked) {                                                         \
            F_CLR(session, WT_SESSION_LOCKED_TABLE_WRITE);                                  \
            __wt_writeunlock(session, &__conn->table_lock);                                 \
        }                                                                                   \
        if (__schema_locked) {                                                              \
            F_CLR(session, WT_SESSION_LOCKED_SCHEMA);                                       \
            __wt_spin_unlock(session, &__conn->schema_lock);                                \
        }                                                                                   \
        if (__checkpoint_locked) {                                                          \
            F_CLR(session, WT_SESSION_LOCKED_CHECKPOINT);                                   \
            __wt_spin_unlock(session, &__conn->checkpoint_lock);                            \
        }                                                                                   \
        __wt_yield();                                                                       \
        op;                                                                                 \
        __wt_yield();                                                                       \
        if (__checkpoint_locked) {                                                          \
            __wt_spin_lock(session, &__conn->checkpoint_lock);                              \
            F_SET(session, WT_SESSION_LOCKED_CHECKPOINT);                                   \
        }                                                                                   \
        if (__schema_locked) {                                                              \
            __wt_spin_lock(session, &__conn->schema_lock);                                  \
            F_SET(session, WT_SESSION_LOCKED_SCHEMA);                                       \
        }                                                                                   \
        if (__table_read_locked) {                                                          \
            __wt_readlock(session, &__conn->table_lock);                                    \
            F_SET(session, WT_SESSION_LOCKED_TABLE_READ);                                   \
        }                                                                                   \
        if (__table_write_locked) {                                                         \
            __wt_writelock(session, &__conn->table_lock);                                   \
            F_SET(session, WT_SESSION_LOCKED_TABLE_WRITE);                                  \
        }                                                                                   \
        if (__handle_read_locked) {                                                         \
            __wt_readlock(session, &__conn->dhandle_lock);                                  \
            F_SET(session, WT_SESSION_LOCKED_HANDLE_LIST_READ);                             \
        }                                                                                   \
        if (__handle_write_locked) {                                                        \
            __wt_writelock(session, &__conn->dhandle_lock);                                 \
            F_SET(session, WT_SESSION_LOCKED_HANDLE_LIST_WRITE);                            \
        }                                                                                   \
    } while (0)