Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(213)

Side by Side Diff: third_party/sqlite/sqlite-src-3170000/src/sqliteInt.h

Issue 2747283002: [sql] Import reference version of SQLite 3.17.. (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
6 **
7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** Internal interface definitions for SQLite.
13 **
14 */
15 #ifndef SQLITEINT_H
16 #define SQLITEINT_H
17
18 /* Special Comments:
19 **
20 ** Some comments have special meaning to the tools that measure test
21 ** coverage:
22 **
23 ** NO_TEST - The branches on this line are not
24 ** measured by branch coverage. This is
25 ** used on lines of code that actually
26 ** implement parts of coverage testing.
27 **
28 ** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false
29 ** and the correct answer is still obtained,
30 ** though perhaps more slowly.
31 **
32 ** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true
33 ** and the correct answer is still obtained,
34 ** though perhaps more slowly.
35 **
36 ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread
37 ** that would be harmless and undetectable
38 ** if it did occur.
39 **
40 ** In all cases, the special comment must be enclosed in the usual
41 ** slash-asterisk...asterisk-slash comment marks, with no spaces between the
42 ** asterisks and the comment text.
43 */
44
45 /*
46 ** Make sure the Tcl calling convention macro is defined. This macro is
47 ** only used by test code and Tcl integration code.
48 */
49 #ifndef SQLITE_TCLAPI
50 # define SQLITE_TCLAPI
51 #endif
52
53 /*
54 ** Make sure that rand_s() is available on Windows systems with MSVC 2005
55 ** or higher.
56 */
57 #if defined(_MSC_VER) && _MSC_VER>=1400
58 # define _CRT_RAND_S
59 #endif
60
61 /*
62 ** Include the header file used to customize the compiler options for MSVC.
63 ** This should be done first so that it can successfully prevent spurious
64 ** compiler warnings due to subsequent content in this file and other files
65 ** that are included by this file.
66 */
67 #include "msvc.h"
68
69 /*
70 ** Special setup for VxWorks
71 */
72 #include "vxworks.h"
73
74 /*
75 ** These #defines should enable >2GB file support on POSIX if the
76 ** underlying operating system supports it. If the OS lacks
77 ** large file support, or if the OS is windows, these should be no-ops.
78 **
79 ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
80 ** system #includes. Hence, this block of code must be the very first
81 ** code in all source files.
82 **
83 ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
84 ** on the compiler command line. This is necessary if you are compiling
85 ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
86 ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
87 ** without this option, LFS is enable. But LFS does not exist in the kernel
88 ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
89 ** portability you should omit LFS.
90 **
91 ** The previous paragraph was written in 2005. (This paragraph is written
92 ** on 2008-11-28.) These days, all Linux kernels support large files, so
93 ** you should probably leave LFS enabled. But some embedded platforms might
94 ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
95 **
96 ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
97 */
98 #ifndef SQLITE_DISABLE_LFS
99 # define _LARGE_FILE 1
100 # ifndef _FILE_OFFSET_BITS
101 # define _FILE_OFFSET_BITS 64
102 # endif
103 # define _LARGEFILE_SOURCE 1
104 #endif
105
106 /* The GCC_VERSION, CLANG_VERSION, and MSVC_VERSION macros are used to
107 ** conditionally include optimizations for each of these compilers. A
108 ** value of 0 means that compiler is not being used. The
109 ** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific
110 ** optimizations, and hence set all compiler macros to 0
111 */
112 #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC)
113 # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
114 #else
115 # define GCC_VERSION 0
116 #endif
117 #if defined(__clang__) && !defined(_WIN32) && !defined(SQLITE_DISABLE_INTRINSIC)
118 # define CLANG_VERSION \
119 (__clang_major__*1000000+__clang_minor__*1000+__clang_patchlevel__)
120 #else
121 # define CLANG_VERSION 0
122 #endif
123 #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC)
124 # define MSVC_VERSION _MSC_VER
125 #else
126 # define MSVC_VERSION 0
127 #endif
128
129 /* Needed for various definitions... */
130 #if defined(__GNUC__) && !defined(_GNU_SOURCE)
131 # define _GNU_SOURCE
132 #endif
133
134 #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
135 # define _BSD_SOURCE
136 #endif
137
138 /*
139 ** For MinGW, check to see if we can include the header file containing its
140 ** version information, among other things. Normally, this internal MinGW
141 ** header file would [only] be included automatically by other MinGW header
142 ** files; however, the contained version information is now required by this
143 ** header file to work around binary compatibility issues (see below) and
144 ** this is the only known way to reliably obtain it. This entire #if block
145 ** would be completely unnecessary if there was any other way of detecting
146 ** MinGW via their preprocessor (e.g. if they customized their GCC to define
147 ** some MinGW-specific macros). When compiling for MinGW, either the
148 ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
149 ** defined; otherwise, detection of conditions specific to MinGW will be
150 ** disabled.
151 */
152 #if defined(_HAVE_MINGW_H)
153 # include "mingw.h"
154 #elif defined(_HAVE__MINGW_H)
155 # include "_mingw.h"
156 #endif
157
158 /*
159 ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
160 ** define is required to maintain binary compatibility with the MSVC runtime
161 ** library in use (e.g. for Windows XP).
162 */
163 #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
164 defined(_WIN32) && !defined(_WIN64) && \
165 defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
166 defined(__MSVCRT__)
167 # define _USE_32BIT_TIME_T
168 #endif
169
170 /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear
171 ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for
172 ** MinGW.
173 */
174 #include "sqlite3.h"
175
176 /*
177 ** Include the configuration header output by 'configure' if we're using the
178 ** autoconf-based build
179 */
180 #ifdef _HAVE_SQLITE_CONFIG_H
181 #include "config.h"
182 #endif
183
184 #include "sqliteLimit.h"
185
186 /* Disable nuisance warnings on Borland compilers */
187 #if defined(__BORLANDC__)
188 #pragma warn -rch /* unreachable code */
189 #pragma warn -ccc /* Condition is always true or false */
190 #pragma warn -aus /* Assigned value is never used */
191 #pragma warn -csu /* Comparing signed and unsigned */
192 #pragma warn -spa /* Suspicious pointer arithmetic */
193 #endif
194
195 /*
196 ** Include standard header files as necessary
197 */
198 #ifdef HAVE_STDINT_H
199 #include <stdint.h>
200 #endif
201 #ifdef HAVE_INTTYPES_H
202 #include <inttypes.h>
203 #endif
204
205 /*
206 ** The following macros are used to cast pointers to integers and
207 ** integers to pointers. The way you do this varies from one compiler
208 ** to the next, so we have developed the following set of #if statements
209 ** to generate appropriate macros for a wide range of compilers.
210 **
211 ** The correct "ANSI" way to do this is to use the intptr_t type.
212 ** Unfortunately, that typedef is not available on all compilers, or
213 ** if it is available, it requires an #include of specific headers
214 ** that vary from one machine to the next.
215 **
216 ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on
217 ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)).
218 ** So we have to define the macros in different ways depending on the
219 ** compiler.
220 */
221 #if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */
222 # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X))
223 # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X))
224 #elif !defined(__GNUC__) /* Works for compilers other than LLVM */
225 # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
226 # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
227 #elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */
228 # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X))
229 # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X))
230 #else /* Generates a warning - but it always works */
231 # define SQLITE_INT_TO_PTR(X) ((void*)(X))
232 # define SQLITE_PTR_TO_INT(X) ((int)(X))
233 #endif
234
235 /*
236 ** A macro to hint to the compiler that a function should not be
237 ** inlined.
238 */
239 #if defined(__GNUC__)
240 # define SQLITE_NOINLINE __attribute__((noinline))
241 #elif defined(_MSC_VER) && _MSC_VER>=1310
242 # define SQLITE_NOINLINE __declspec(noinline)
243 #else
244 # define SQLITE_NOINLINE
245 #endif
246
247 /*
248 ** Make sure that the compiler intrinsics we desire are enabled when
249 ** compiling with an appropriate version of MSVC unless prevented by
250 ** the SQLITE_DISABLE_INTRINSIC define.
251 */
252 #if !defined(SQLITE_DISABLE_INTRINSIC)
253 # if defined(_MSC_VER) && _MSC_VER>=1400
254 # if !defined(_WIN32_WCE)
255 # include <intrin.h>
256 # pragma intrinsic(_byteswap_ushort)
257 # pragma intrinsic(_byteswap_ulong)
258 # pragma intrinsic(_byteswap_uint64)
259 # pragma intrinsic(_ReadWriteBarrier)
260 # else
261 # include <cmnintrin.h>
262 # endif
263 # endif
264 #endif
265
266 /*
267 ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
268 ** 0 means mutexes are permanently disable and the library is never
269 ** threadsafe. 1 means the library is serialized which is the highest
270 ** level of threadsafety. 2 means the library is multithreaded - multiple
271 ** threads can use SQLite as long as no two threads try to use the same
272 ** database connection at the same time.
273 **
274 ** Older versions of SQLite used an optional THREADSAFE macro.
275 ** We support that for legacy.
276 */
277 #if !defined(SQLITE_THREADSAFE)
278 # if defined(THREADSAFE)
279 # define SQLITE_THREADSAFE THREADSAFE
280 # else
281 # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
282 # endif
283 #endif
284
285 /*
286 ** Powersafe overwrite is on by default. But can be turned off using
287 ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
288 */
289 #ifndef SQLITE_POWERSAFE_OVERWRITE
290 # define SQLITE_POWERSAFE_OVERWRITE 1
291 #endif
292
293 /*
294 ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
295 ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
296 ** which case memory allocation statistics are disabled by default.
297 */
298 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
299 # define SQLITE_DEFAULT_MEMSTATUS 1
300 #endif
301
302 /*
303 ** Exactly one of the following macros must be defined in order to
304 ** specify which memory allocation subsystem to use.
305 **
306 ** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
307 ** SQLITE_WIN32_MALLOC // Use Win32 native heap API
308 ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails
309 ** SQLITE_MEMDEBUG // Debugging version of system malloc()
310 **
311 ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
312 ** assert() macro is enabled, each call into the Win32 native heap subsystem
313 ** will cause HeapValidate to be called. If heap validation should fail, an
314 ** assertion will be triggered.
315 **
316 ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
317 ** the default.
318 */
319 #if defined(SQLITE_SYSTEM_MALLOC) \
320 + defined(SQLITE_WIN32_MALLOC) \
321 + defined(SQLITE_ZERO_MALLOC) \
322 + defined(SQLITE_MEMDEBUG)>1
323 # error "Two or more of the following compile-time configuration options\
324 are defined but at most one is allowed:\
325 SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
326 SQLITE_ZERO_MALLOC"
327 #endif
328 #if defined(SQLITE_SYSTEM_MALLOC) \
329 + defined(SQLITE_WIN32_MALLOC) \
330 + defined(SQLITE_ZERO_MALLOC) \
331 + defined(SQLITE_MEMDEBUG)==0
332 # define SQLITE_SYSTEM_MALLOC 1
333 #endif
334
335 /*
336 ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
337 ** sizes of memory allocations below this value where possible.
338 */
339 #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
340 # define SQLITE_MALLOC_SOFT_LIMIT 1024
341 #endif
342
343 /*
344 ** We need to define _XOPEN_SOURCE as follows in order to enable
345 ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
346 ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
347 ** it.
348 */
349 #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
350 # define _XOPEN_SOURCE 600
351 #endif
352
353 /*
354 ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that
355 ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true,
356 ** make it true by defining or undefining NDEBUG.
357 **
358 ** Setting NDEBUG makes the code smaller and faster by disabling the
359 ** assert() statements in the code. So we want the default action
360 ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
361 ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out
362 ** feature.
363 */
364 #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
365 # define NDEBUG 1
366 #endif
367 #if defined(NDEBUG) && defined(SQLITE_DEBUG)
368 # undef NDEBUG
369 #endif
370
371 /*
372 ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
373 */
374 #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
375 # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
376 #endif
377
378 /*
379 ** The testcase() macro is used to aid in coverage testing. When
380 ** doing coverage testing, the condition inside the argument to
381 ** testcase() must be evaluated both true and false in order to
382 ** get full branch coverage. The testcase() macro is inserted
383 ** to help ensure adequate test coverage in places where simple
384 ** condition/decision coverage is inadequate. For example, testcase()
385 ** can be used to make sure boundary values are tested. For
386 ** bitmask tests, testcase() can be used to make sure each bit
387 ** is significant and used at least once. On switch statements
388 ** where multiple cases go to the same block of code, testcase()
389 ** can insure that all cases are evaluated.
390 **
391 */
392 #ifdef SQLITE_COVERAGE_TEST
393 void sqlite3Coverage(int);
394 # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
395 #else
396 # define testcase(X)
397 #endif
398
399 /*
400 ** The TESTONLY macro is used to enclose variable declarations or
401 ** other bits of code that are needed to support the arguments
402 ** within testcase() and assert() macros.
403 */
404 #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
405 # define TESTONLY(X) X
406 #else
407 # define TESTONLY(X)
408 #endif
409
410 /*
411 ** Sometimes we need a small amount of code such as a variable initialization
412 ** to setup for a later assert() statement. We do not want this code to
413 ** appear when assert() is disabled. The following macro is therefore
414 ** used to contain that setup code. The "VVA" acronym stands for
415 ** "Verification, Validation, and Accreditation". In other words, the
416 ** code within VVA_ONLY() will only run during verification processes.
417 */
418 #ifndef NDEBUG
419 # define VVA_ONLY(X) X
420 #else
421 # define VVA_ONLY(X)
422 #endif
423
424 /*
425 ** The ALWAYS and NEVER macros surround boolean expressions which
426 ** are intended to always be true or false, respectively. Such
427 ** expressions could be omitted from the code completely. But they
428 ** are included in a few cases in order to enhance the resilience
429 ** of SQLite to unexpected behavior - to make the code "self-healing"
430 ** or "ductile" rather than being "brittle" and crashing at the first
431 ** hint of unplanned behavior.
432 **
433 ** In other words, ALWAYS and NEVER are added for defensive code.
434 **
435 ** When doing coverage testing ALWAYS and NEVER are hard-coded to
436 ** be true and false so that the unreachable code they specify will
437 ** not be counted as untested code.
438 */
439 #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST)
440 # define ALWAYS(X) (1)
441 # define NEVER(X) (0)
442 #elif !defined(NDEBUG)
443 # define ALWAYS(X) ((X)?1:(assert(0),0))
444 # define NEVER(X) ((X)?(assert(0),1):0)
445 #else
446 # define ALWAYS(X) (X)
447 # define NEVER(X) (X)
448 #endif
449
450 /*
451 ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is
452 ** defined. We need to defend against those failures when testing with
453 ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches
454 ** during a normal build. The following macro can be used to disable tests
455 ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set.
456 */
457 #if defined(SQLITE_TEST_REALLOC_STRESS)
458 # define ONLY_IF_REALLOC_STRESS(X) (X)
459 #elif !defined(NDEBUG)
460 # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0)
461 #else
462 # define ONLY_IF_REALLOC_STRESS(X) (0)
463 #endif
464
465 /*
466 ** Declarations used for tracing the operating system interfaces.
467 */
468 #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
469 (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
470 extern int sqlite3OSTrace;
471 # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X
472 # define SQLITE_HAVE_OS_TRACE
473 #else
474 # define OSTRACE(X)
475 # undef SQLITE_HAVE_OS_TRACE
476 #endif
477
478 /*
479 ** Is the sqlite3ErrName() function needed in the build? Currently,
480 ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
481 ** OSTRACE is enabled), and by several "test*.c" files (which are
482 ** compiled using SQLITE_TEST).
483 */
484 #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
485 (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
486 # define SQLITE_NEED_ERR_NAME
487 #else
488 # undef SQLITE_NEED_ERR_NAME
489 #endif
490
491 /*
492 ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN
493 */
494 #ifdef SQLITE_OMIT_EXPLAIN
495 # undef SQLITE_ENABLE_EXPLAIN_COMMENTS
496 #endif
497
498 /*
499 ** Return true (non-zero) if the input is an integer that is too large
500 ** to fit in 32-bits. This macro is used inside of various testcase()
501 ** macros to verify that we have tested SQLite for large-file support.
502 */
503 #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0)
504
505 /*
506 ** The macro unlikely() is a hint that surrounds a boolean
507 ** expression that is usually false. Macro likely() surrounds
508 ** a boolean expression that is usually true. These hints could,
509 ** in theory, be used by the compiler to generate better code, but
510 ** currently they are just comments for human readers.
511 */
512 #define likely(X) (X)
513 #define unlikely(X) (X)
514
515 #include "hash.h"
516 #include "parse.h"
517 #include <stdio.h>
518 #include <stdlib.h>
519 #include <string.h>
520 #include <assert.h>
521 #include <stddef.h>
522
523 /*
524 ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY.
525 ** This allows better measurements of where memcpy() is used when running
526 ** cachegrind. But this macro version of memcpy() is very slow so it
527 ** should not be used in production. This is a performance measurement
528 ** hack only.
529 */
530 #ifdef SQLITE_INLINE_MEMCPY
531 # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\
532 int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);}
533 #endif
534
535 /*
536 ** If compiling for a processor that lacks floating point support,
537 ** substitute integer for floating-point
538 */
539 #ifdef SQLITE_OMIT_FLOATING_POINT
540 # define double sqlite_int64
541 # define float sqlite_int64
542 # define LONGDOUBLE_TYPE sqlite_int64
543 # ifndef SQLITE_BIG_DBL
544 # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
545 # endif
546 # define SQLITE_OMIT_DATETIME_FUNCS 1
547 # define SQLITE_OMIT_TRACE 1
548 # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
549 # undef SQLITE_HAVE_ISNAN
550 #endif
551 #ifndef SQLITE_BIG_DBL
552 # define SQLITE_BIG_DBL (1e99)
553 #endif
554
555 /*
556 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
557 ** afterward. Having this macro allows us to cause the C compiler
558 ** to omit code used by TEMP tables without messy #ifndef statements.
559 */
560 #ifdef SQLITE_OMIT_TEMPDB
561 #define OMIT_TEMPDB 1
562 #else
563 #define OMIT_TEMPDB 0
564 #endif
565
566 /*
567 ** The "file format" number is an integer that is incremented whenever
568 ** the VDBE-level file format changes. The following macros define the
569 ** the default file format for new databases and the maximum file format
570 ** that the library can read.
571 */
572 #define SQLITE_MAX_FILE_FORMAT 4
573 #ifndef SQLITE_DEFAULT_FILE_FORMAT
574 # define SQLITE_DEFAULT_FILE_FORMAT 4
575 #endif
576
577 /*
578 ** Determine whether triggers are recursive by default. This can be
579 ** changed at run-time using a pragma.
580 */
581 #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
582 # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
583 #endif
584
585 /*
586 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
587 ** on the command-line
588 */
589 #ifndef SQLITE_TEMP_STORE
590 # define SQLITE_TEMP_STORE 1
591 # define SQLITE_TEMP_STORE_xc 1 /* Exclude from ctime.c */
592 #endif
593
594 /*
595 ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
596 ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
597 ** to zero.
598 */
599 #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
600 # undef SQLITE_MAX_WORKER_THREADS
601 # define SQLITE_MAX_WORKER_THREADS 0
602 #endif
603 #ifndef SQLITE_MAX_WORKER_THREADS
604 # define SQLITE_MAX_WORKER_THREADS 8
605 #endif
606 #ifndef SQLITE_DEFAULT_WORKER_THREADS
607 # define SQLITE_DEFAULT_WORKER_THREADS 0
608 #endif
609 #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
610 # undef SQLITE_MAX_WORKER_THREADS
611 # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
612 #endif
613
614 /*
615 ** The default initial allocation for the pagecache when using separate
616 ** pagecaches for each database connection. A positive number is the
617 ** number of pages. A negative number N translations means that a buffer
618 ** of -1024*N bytes is allocated and used for as many pages as it will hold.
619 **
620 ** The default value of "20" was choosen to minimize the run-time of the
621 ** speedtest1 test program with options: --shrink-memory --reprepare
622 */
623 #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
624 # define SQLITE_DEFAULT_PCACHE_INITSZ 20
625 #endif
626
627 /*
628 ** GCC does not define the offsetof() macro so we'll have to do it
629 ** ourselves.
630 */
631 #ifndef offsetof
632 #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
633 #endif
634
635 /*
636 ** Macros to compute minimum and maximum of two numbers.
637 */
638 #ifndef MIN
639 # define MIN(A,B) ((A)<(B)?(A):(B))
640 #endif
641 #ifndef MAX
642 # define MAX(A,B) ((A)>(B)?(A):(B))
643 #endif
644
645 /*
646 ** Swap two objects of type TYPE.
647 */
648 #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
649
650 /*
651 ** Check to see if this machine uses EBCDIC. (Yes, believe it or
652 ** not, there are still machines out there that use EBCDIC.)
653 */
654 #if 'A' == '\301'
655 # define SQLITE_EBCDIC 1
656 #else
657 # define SQLITE_ASCII 1
658 #endif
659
660 /*
661 ** Integers of known sizes. These typedefs might change for architectures
662 ** where the sizes very. Preprocessor macros are available so that the
663 ** types can be conveniently redefined at compile-type. Like this:
664 **
665 ** cc '-DUINTPTR_TYPE=long long int' ...
666 */
667 #ifndef UINT32_TYPE
668 # ifdef HAVE_UINT32_T
669 # define UINT32_TYPE uint32_t
670 # else
671 # define UINT32_TYPE unsigned int
672 # endif
673 #endif
674 #ifndef UINT16_TYPE
675 # ifdef HAVE_UINT16_T
676 # define UINT16_TYPE uint16_t
677 # else
678 # define UINT16_TYPE unsigned short int
679 # endif
680 #endif
681 #ifndef INT16_TYPE
682 # ifdef HAVE_INT16_T
683 # define INT16_TYPE int16_t
684 # else
685 # define INT16_TYPE short int
686 # endif
687 #endif
688 #ifndef UINT8_TYPE
689 # ifdef HAVE_UINT8_T
690 # define UINT8_TYPE uint8_t
691 # else
692 # define UINT8_TYPE unsigned char
693 # endif
694 #endif
695 #ifndef INT8_TYPE
696 # ifdef HAVE_INT8_T
697 # define INT8_TYPE int8_t
698 # else
699 # define INT8_TYPE signed char
700 # endif
701 #endif
702 #ifndef LONGDOUBLE_TYPE
703 # define LONGDOUBLE_TYPE long double
704 #endif
705 typedef sqlite_int64 i64; /* 8-byte signed integer */
706 typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
707 typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
708 typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
709 typedef INT16_TYPE i16; /* 2-byte signed integer */
710 typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
711 typedef INT8_TYPE i8; /* 1-byte signed integer */
712
713 /*
714 ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
715 ** that can be stored in a u32 without loss of data. The value
716 ** is 0x00000000ffffffff. But because of quirks of some compilers, we
717 ** have to specify the value in the less intuitive manner shown:
718 */
719 #define SQLITE_MAX_U32 ((((u64)1)<<32)-1)
720
721 /*
722 ** The datatype used to store estimates of the number of rows in a
723 ** table or index. This is an unsigned integer type. For 99.9% of
724 ** the world, a 32-bit integer is sufficient. But a 64-bit integer
725 ** can be used at compile-time if desired.
726 */
727 #ifdef SQLITE_64BIT_STATS
728 typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */
729 #else
730 typedef u32 tRowcnt; /* 32-bit is the default */
731 #endif
732
733 /*
734 ** Estimated quantities used for query planning are stored as 16-bit
735 ** logarithms. For quantity X, the value stored is 10*log2(X). This
736 ** gives a possible range of values of approximately 1.0e986 to 1e-986.
737 ** But the allowed values are "grainy". Not every value is representable.
738 ** For example, quantities 16 and 17 are both represented by a LogEst
739 ** of 40. However, since LogEst quantities are suppose to be estimates,
740 ** not exact values, this imprecision is not a problem.
741 **
742 ** "LogEst" is short for "Logarithmic Estimate".
743 **
744 ** Examples:
745 ** 1 -> 0 20 -> 43 10000 -> 132
746 ** 2 -> 10 25 -> 46 25000 -> 146
747 ** 3 -> 16 100 -> 66 1000000 -> 199
748 ** 4 -> 20 1000 -> 99 1048576 -> 200
749 ** 10 -> 33 1024 -> 100 4294967296 -> 320
750 **
751 ** The LogEst can be negative to indicate fractional values.
752 ** Examples:
753 **
754 ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40
755 */
756 typedef INT16_TYPE LogEst;
757
758 /*
759 ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
760 */
761 #ifndef SQLITE_PTRSIZE
762 # if defined(__SIZEOF_POINTER__)
763 # define SQLITE_PTRSIZE __SIZEOF_POINTER__
764 # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \
765 defined(_M_ARM) || defined(__arm__) || defined(__x86)
766 # define SQLITE_PTRSIZE 4
767 # else
768 # define SQLITE_PTRSIZE 8
769 # endif
770 #endif
771
772 /* The uptr type is an unsigned integer large enough to hold a pointer
773 */
774 #if defined(HAVE_STDINT_H)
775 typedef uintptr_t uptr;
776 #elif SQLITE_PTRSIZE==4
777 typedef u32 uptr;
778 #else
779 typedef u64 uptr;
780 #endif
781
782 /*
783 ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to
784 ** something between S (inclusive) and E (exclusive).
785 **
786 ** In other words, S is a buffer and E is a pointer to the first byte after
787 ** the end of buffer S. This macro returns true if P points to something
788 ** contained within the buffer S.
789 */
790 #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E)))
791
792
793 /*
794 ** Macros to determine whether the machine is big or little endian,
795 ** and whether or not that determination is run-time or compile-time.
796 **
797 ** For best performance, an attempt is made to guess at the byte-order
798 ** using C-preprocessor macros. If that is unsuccessful, or if
799 ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined
800 ** at run-time.
801 */
802 #ifndef SQLITE_BYTEORDER
803 # if defined(i386) || defined(__i386__) || defined(_M_IX86) || \
804 defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \
805 defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \
806 defined(__arm__)
807 # define SQLITE_BYTEORDER 1234
808 # elif defined(sparc) || defined(__ppc__)
809 # define SQLITE_BYTEORDER 4321
810 # else
811 # define SQLITE_BYTEORDER 0
812 # endif
813 #endif
814 #if SQLITE_BYTEORDER==4321
815 # define SQLITE_BIGENDIAN 1
816 # define SQLITE_LITTLEENDIAN 0
817 # define SQLITE_UTF16NATIVE SQLITE_UTF16BE
818 #elif SQLITE_BYTEORDER==1234
819 # define SQLITE_BIGENDIAN 0
820 # define SQLITE_LITTLEENDIAN 1
821 # define SQLITE_UTF16NATIVE SQLITE_UTF16LE
822 #else
823 # ifdef SQLITE_AMALGAMATION
824 const int sqlite3one = 1;
825 # else
826 extern const int sqlite3one;
827 # endif
828 # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
829 # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
830 # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
831 #endif
832
833 /*
834 ** Constants for the largest and smallest possible 64-bit signed integers.
835 ** These macros are designed to work correctly on both 32-bit and 64-bit
836 ** compilers.
837 */
838 #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
839 #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
840
841 /*
842 ** Round up a number to the next larger multiple of 8. This is used
843 ** to force 8-byte alignment on 64-bit architectures.
844 */
845 #define ROUND8(x) (((x)+7)&~7)
846
847 /*
848 ** Round down to the nearest multiple of 8
849 */
850 #define ROUNDDOWN8(x) ((x)&~7)
851
852 /*
853 ** Assert that the pointer X is aligned to an 8-byte boundary. This
854 ** macro is used only within assert() to verify that the code gets
855 ** all alignment restrictions correct.
856 **
857 ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
858 ** underlying malloc() implementation might return us 4-byte aligned
859 ** pointers. In that case, only verify 4-byte alignment.
860 */
861 #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
862 # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0)
863 #else
864 # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0)
865 #endif
866
867 /*
868 ** Disable MMAP on platforms where it is known to not work
869 */
870 #if defined(__OpenBSD__) || defined(__QNXNTO__)
871 # undef SQLITE_MAX_MMAP_SIZE
872 # define SQLITE_MAX_MMAP_SIZE 0
873 #endif
874
875 /*
876 ** Default maximum size of memory used by memory-mapped I/O in the VFS
877 */
878 #ifdef __APPLE__
879 # include <TargetConditionals.h>
880 #endif
881 #ifndef SQLITE_MAX_MMAP_SIZE
882 # if defined(__linux__) \
883 || defined(_WIN32) \
884 || (defined(__APPLE__) && defined(__MACH__)) \
885 || defined(__sun) \
886 || defined(__FreeBSD__) \
887 || defined(__DragonFly__)
888 # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */
889 # else
890 # define SQLITE_MAX_MMAP_SIZE 0
891 # endif
892 # define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */
893 #endif
894
895 /*
896 ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger
897 ** default MMAP_SIZE is specified at compile-time, make sure that it does
898 ** not exceed the maximum mmap size.
899 */
900 #ifndef SQLITE_DEFAULT_MMAP_SIZE
901 # define SQLITE_DEFAULT_MMAP_SIZE 0
902 # define SQLITE_DEFAULT_MMAP_SIZE_xc 1 /* Exclude from ctime.c */
903 #endif
904 #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
905 # undef SQLITE_DEFAULT_MMAP_SIZE
906 # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
907 #endif
908
909 /*
910 ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
911 ** Priority is given to SQLITE_ENABLE_STAT4. If either are defined, also
912 ** define SQLITE_ENABLE_STAT3_OR_STAT4
913 */
914 #ifdef SQLITE_ENABLE_STAT4
915 # undef SQLITE_ENABLE_STAT3
916 # define SQLITE_ENABLE_STAT3_OR_STAT4 1
917 #elif SQLITE_ENABLE_STAT3
918 # define SQLITE_ENABLE_STAT3_OR_STAT4 1
919 #elif SQLITE_ENABLE_STAT3_OR_STAT4
920 # undef SQLITE_ENABLE_STAT3_OR_STAT4
921 #endif
922
923 /*
924 ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not
925 ** the Select query generator tracing logic is turned on.
926 */
927 #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_SELECTTRACE)
928 # define SELECTTRACE_ENABLED 1
929 #else
930 # define SELECTTRACE_ENABLED 0
931 #endif
932
933 /*
934 ** An instance of the following structure is used to store the busy-handler
935 ** callback for a given sqlite handle.
936 **
937 ** The sqlite.busyHandler member of the sqlite struct contains the busy
938 ** callback for the database handle. Each pager opened via the sqlite
939 ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
940 ** callback is currently invoked only from within pager.c.
941 */
942 typedef struct BusyHandler BusyHandler;
943 struct BusyHandler {
944 int (*xFunc)(void *,int); /* The busy callback */
945 void *pArg; /* First arg to busy callback */
946 int nBusy; /* Incremented with each busy call */
947 };
948
949 /*
950 ** Name of the master database table. The master database table
951 ** is a special table that holds the names and attributes of all
952 ** user tables and indices.
953 */
954 #define MASTER_NAME "sqlite_master"
955 #define TEMP_MASTER_NAME "sqlite_temp_master"
956
957 /*
958 ** The root-page of the master database table.
959 */
960 #define MASTER_ROOT 1
961
962 /*
963 ** The name of the schema table.
964 */
965 #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
966
967 /*
968 ** A convenience macro that returns the number of elements in
969 ** an array.
970 */
971 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
972
973 /*
974 ** Determine if the argument is a power of two
975 */
976 #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
977
978 /*
979 ** The following value as a destructor means to use sqlite3DbFree().
980 ** The sqlite3DbFree() routine requires two parameters instead of the
981 ** one parameter that destructors normally want. So we have to introduce
982 ** this magic value that the code knows to handle differently. Any
983 ** pointer will work here as long as it is distinct from SQLITE_STATIC
984 ** and SQLITE_TRANSIENT.
985 */
986 #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3MallocSize)
987
988 /*
989 ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
990 ** not support Writable Static Data (WSD) such as global and static variables.
991 ** All variables must either be on the stack or dynamically allocated from
992 ** the heap. When WSD is unsupported, the variable declarations scattered
993 ** throughout the SQLite code must become constants instead. The SQLITE_WSD
994 ** macro is used for this purpose. And instead of referencing the variable
995 ** directly, we use its constant as a key to lookup the run-time allocated
996 ** buffer that holds real variable. The constant is also the initializer
997 ** for the run-time allocated buffer.
998 **
999 ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
1000 ** macros become no-ops and have zero performance impact.
1001 */
1002 #ifdef SQLITE_OMIT_WSD
1003 #define SQLITE_WSD const
1004 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
1005 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
1006 int sqlite3_wsd_init(int N, int J);
1007 void *sqlite3_wsd_find(void *K, int L);
1008 #else
1009 #define SQLITE_WSD
1010 #define GLOBAL(t,v) v
1011 #define sqlite3GlobalConfig sqlite3Config
1012 #endif
1013
1014 /*
1015 ** The following macros are used to suppress compiler warnings and to
1016 ** make it clear to human readers when a function parameter is deliberately
1017 ** left unused within the body of a function. This usually happens when
1018 ** a function is called via a function pointer. For example the
1019 ** implementation of an SQL aggregate step callback may not use the
1020 ** parameter indicating the number of arguments passed to the aggregate,
1021 ** if it knows that this is enforced elsewhere.
1022 **
1023 ** When a function parameter is not used at all within the body of a function,
1024 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
1025 ** However, these macros may also be used to suppress warnings related to
1026 ** parameters that may or may not be used depending on compilation options.
1027 ** For example those parameters only used in assert() statements. In these
1028 ** cases the parameters are named as per the usual conventions.
1029 */
1030 #define UNUSED_PARAMETER(x) (void)(x)
1031 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
1032
1033 /*
1034 ** Forward references to structures
1035 */
1036 typedef struct AggInfo AggInfo;
1037 typedef struct AuthContext AuthContext;
1038 typedef struct AutoincInfo AutoincInfo;
1039 typedef struct Bitvec Bitvec;
1040 typedef struct CollSeq CollSeq;
1041 typedef struct Column Column;
1042 typedef struct Db Db;
1043 typedef struct Schema Schema;
1044 typedef struct Expr Expr;
1045 typedef struct ExprList ExprList;
1046 typedef struct ExprSpan ExprSpan;
1047 typedef struct FKey FKey;
1048 typedef struct FuncDestructor FuncDestructor;
1049 typedef struct FuncDef FuncDef;
1050 typedef struct FuncDefHash FuncDefHash;
1051 typedef struct IdList IdList;
1052 typedef struct Index Index;
1053 typedef struct IndexSample IndexSample;
1054 typedef struct KeyClass KeyClass;
1055 typedef struct KeyInfo KeyInfo;
1056 typedef struct Lookaside Lookaside;
1057 typedef struct LookasideSlot LookasideSlot;
1058 typedef struct Module Module;
1059 typedef struct NameContext NameContext;
1060 typedef struct Parse Parse;
1061 typedef struct PreUpdate PreUpdate;
1062 typedef struct PrintfArguments PrintfArguments;
1063 typedef struct RowSet RowSet;
1064 typedef struct Savepoint Savepoint;
1065 typedef struct Select Select;
1066 typedef struct SQLiteThread SQLiteThread;
1067 typedef struct SelectDest SelectDest;
1068 typedef struct SrcList SrcList;
1069 typedef struct StrAccum StrAccum;
1070 typedef struct Table Table;
1071 typedef struct TableLock TableLock;
1072 typedef struct Token Token;
1073 typedef struct TreeView TreeView;
1074 typedef struct Trigger Trigger;
1075 typedef struct TriggerPrg TriggerPrg;
1076 typedef struct TriggerStep TriggerStep;
1077 typedef struct UnpackedRecord UnpackedRecord;
1078 typedef struct VTable VTable;
1079 typedef struct VtabCtx VtabCtx;
1080 typedef struct Walker Walker;
1081 typedef struct WhereInfo WhereInfo;
1082 typedef struct With With;
1083
1084 /* A VList object records a mapping between parameters/variables/wildcards
1085 ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer
1086 ** variable number associated with that parameter. See the format description
1087 ** on the sqlite3VListAdd() routine for more information. A VList is really
1088 ** just an array of integers.
1089 */
1090 typedef int VList;
1091
1092 /*
1093 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
1094 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
1095 ** pointer types (i.e. FuncDef) defined above.
1096 */
1097 #include "btree.h"
1098 #include "vdbe.h"
1099 #include "pager.h"
1100 #include "pcache.h"
1101 #include "os.h"
1102 #include "mutex.h"
1103
1104 /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default
1105 ** synchronous setting to EXTRA. It is no longer supported.
1106 */
1107 #ifdef SQLITE_EXTRA_DURABLE
1108 # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE
1109 # define SQLITE_DEFAULT_SYNCHRONOUS 3
1110 #endif
1111
1112 /*
1113 ** Default synchronous levels.
1114 **
1115 ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ
1116 ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1.
1117 **
1118 ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS
1119 ** OFF 1 0
1120 ** NORMAL 2 1
1121 ** FULL 3 2
1122 ** EXTRA 4 3
1123 **
1124 ** The "PRAGMA synchronous" statement also uses the zero-based numbers.
1125 ** In other words, the zero-based numbers are used for all external interfaces
1126 ** and the one-based values are used internally.
1127 */
1128 #ifndef SQLITE_DEFAULT_SYNCHRONOUS
1129 # define SQLITE_DEFAULT_SYNCHRONOUS (PAGER_SYNCHRONOUS_FULL-1)
1130 #endif
1131 #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS
1132 # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS
1133 #endif
1134
1135 /*
1136 ** Each database file to be accessed by the system is an instance
1137 ** of the following structure. There are normally two of these structures
1138 ** in the sqlite.aDb[] array. aDb[0] is the main database file and
1139 ** aDb[1] is the database file used to hold temporary tables. Additional
1140 ** databases may be attached.
1141 */
1142 struct Db {
1143 char *zDbSName; /* Name of this database. (schema name, not filename) */
1144 Btree *pBt; /* The B*Tree structure for this database file */
1145 u8 safety_level; /* How aggressive at syncing data to disk */
1146 u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */
1147 Schema *pSchema; /* Pointer to database schema (possibly shared) */
1148 };
1149
1150 /*
1151 ** An instance of the following structure stores a database schema.
1152 **
1153 ** Most Schema objects are associated with a Btree. The exception is
1154 ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
1155 ** In shared cache mode, a single Schema object can be shared by multiple
1156 ** Btrees that refer to the same underlying BtShared object.
1157 **
1158 ** Schema objects are automatically deallocated when the last Btree that
1159 ** references them is destroyed. The TEMP Schema is manually freed by
1160 ** sqlite3_close().
1161 *
1162 ** A thread must be holding a mutex on the corresponding Btree in order
1163 ** to access Schema content. This implies that the thread must also be
1164 ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
1165 ** For a TEMP Schema, only the connection mutex is required.
1166 */
1167 struct Schema {
1168 int schema_cookie; /* Database schema version number for this file */
1169 int iGeneration; /* Generation counter. Incremented with each change */
1170 Hash tblHash; /* All tables indexed by name */
1171 Hash idxHash; /* All (named) indices indexed by name */
1172 Hash trigHash; /* All triggers indexed by name */
1173 Hash fkeyHash; /* All foreign keys by referenced table name */
1174 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
1175 u8 file_format; /* Schema format version for this file */
1176 u8 enc; /* Text encoding used by this database */
1177 u16 schemaFlags; /* Flags associated with this schema */
1178 int cache_size; /* Number of pages to use in the cache */
1179 };
1180
1181 /*
1182 ** These macros can be used to test, set, or clear bits in the
1183 ** Db.pSchema->flags field.
1184 */
1185 #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
1186 #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
1187 #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P)
1188 #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P)
1189
1190 /*
1191 ** Allowed values for the DB.pSchema->flags field.
1192 **
1193 ** The DB_SchemaLoaded flag is set after the database schema has been
1194 ** read into internal hash tables.
1195 **
1196 ** DB_UnresetViews means that one or more views have column names that
1197 ** have been filled out. If the schema changes, these column names might
1198 ** changes and so the view will need to be reset.
1199 */
1200 #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
1201 #define DB_UnresetViews 0x0002 /* Some views have defined column names */
1202 #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
1203
1204 /*
1205 ** The number of different kinds of things that can be limited
1206 ** using the sqlite3_limit() interface.
1207 */
1208 #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
1209
1210 /*
1211 ** Lookaside malloc is a set of fixed-size buffers that can be used
1212 ** to satisfy small transient memory allocation requests for objects
1213 ** associated with a particular database connection. The use of
1214 ** lookaside malloc provides a significant performance enhancement
1215 ** (approx 10%) by avoiding numerous malloc/free requests while parsing
1216 ** SQL statements.
1217 **
1218 ** The Lookaside structure holds configuration information about the
1219 ** lookaside malloc subsystem. Each available memory allocation in
1220 ** the lookaside subsystem is stored on a linked list of LookasideSlot
1221 ** objects.
1222 **
1223 ** Lookaside allocations are only allowed for objects that are associated
1224 ** with a particular database connection. Hence, schema information cannot
1225 ** be stored in lookaside because in shared cache mode the schema information
1226 ** is shared by multiple database connections. Therefore, while parsing
1227 ** schema information, the Lookaside.bEnabled flag is cleared so that
1228 ** lookaside allocations are not used to construct the schema objects.
1229 */
1230 struct Lookaside {
1231 u32 bDisable; /* Only operate the lookaside when zero */
1232 u16 sz; /* Size of each buffer in bytes */
1233 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
1234 int nOut; /* Number of buffers currently checked out */
1235 int mxOut; /* Highwater mark for nOut */
1236 int anStat[3]; /* 0: hits. 1: size misses. 2: full misses */
1237 LookasideSlot *pFree; /* List of available buffers */
1238 void *pStart; /* First byte of available memory space */
1239 void *pEnd; /* First byte past end of available space */
1240 };
1241 struct LookasideSlot {
1242 LookasideSlot *pNext; /* Next buffer in the list of free buffers */
1243 };
1244
1245 /*
1246 ** A hash table for built-in function definitions. (Application-defined
1247 ** functions use a regular table table from hash.h.)
1248 **
1249 ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
1250 ** Collisions are on the FuncDef.u.pHash chain.
1251 */
1252 #define SQLITE_FUNC_HASH_SZ 23
1253 struct FuncDefHash {
1254 FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */
1255 };
1256
1257 #ifdef SQLITE_USER_AUTHENTICATION
1258 /*
1259 ** Information held in the "sqlite3" database connection object and used
1260 ** to manage user authentication.
1261 */
1262 typedef struct sqlite3_userauth sqlite3_userauth;
1263 struct sqlite3_userauth {
1264 u8 authLevel; /* Current authentication level */
1265 int nAuthPW; /* Size of the zAuthPW in bytes */
1266 char *zAuthPW; /* Password used to authenticate */
1267 char *zAuthUser; /* User name used to authenticate */
1268 };
1269
1270 /* Allowed values for sqlite3_userauth.authLevel */
1271 #define UAUTH_Unknown 0 /* Authentication not yet checked */
1272 #define UAUTH_Fail 1 /* User authentication failed */
1273 #define UAUTH_User 2 /* Authenticated as a normal user */
1274 #define UAUTH_Admin 3 /* Authenticated as an administrator */
1275
1276 /* Functions used only by user authorization logic */
1277 int sqlite3UserAuthTable(const char*);
1278 int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
1279 void sqlite3UserAuthInit(sqlite3*);
1280 void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
1281
1282 #endif /* SQLITE_USER_AUTHENTICATION */
1283
1284 /*
1285 ** typedef for the authorization callback function.
1286 */
1287 #ifdef SQLITE_USER_AUTHENTICATION
1288 typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
1289 const char*, const char*);
1290 #else
1291 typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
1292 const char*);
1293 #endif
1294
1295 #ifndef SQLITE_OMIT_DEPRECATED
1296 /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing
1297 ** in the style of sqlite3_trace()
1298 */
1299 #define SQLITE_TRACE_LEGACY 0x80
1300 #else
1301 #define SQLITE_TRACE_LEGACY 0
1302 #endif /* SQLITE_OMIT_DEPRECATED */
1303
1304
1305 /*
1306 ** Each database connection is an instance of the following structure.
1307 */
1308 struct sqlite3 {
1309 sqlite3_vfs *pVfs; /* OS Interface */
1310 struct Vdbe *pVdbe; /* List of active virtual machines */
1311 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
1312 sqlite3_mutex *mutex; /* Connection mutex */
1313 Db *aDb; /* All backends */
1314 int nDb; /* Number of backends currently in use */
1315 int flags; /* Miscellaneous flags. See below */
1316 i64 lastRowid; /* ROWID of most recent insert (see above) */
1317 i64 szMmap; /* Default mmap_size setting */
1318 unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
1319 int errCode; /* Most recent error code (SQLITE_*) */
1320 int errMask; /* & result codes with this before returning */
1321 int iSysErrno; /* Errno value from last system error */
1322 u16 dbOptFlags; /* Flags to enable/disable optimizations */
1323 u8 enc; /* Text encoding */
1324 u8 autoCommit; /* The auto-commit flag. */
1325 u8 temp_store; /* 1: file 2: memory 0: default */
1326 u8 mallocFailed; /* True if we have seen a malloc failure */
1327 u8 bBenignMalloc; /* Do not require OOMs if true */
1328 u8 dfltLockMode; /* Default locking-mode for attached dbs */
1329 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
1330 u8 suppressErr; /* Do not issue error messages if true */
1331 u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */
1332 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
1333 u8 mTrace; /* zero or more SQLITE_TRACE flags */
1334 u8 skipBtreeMutex; /* True if no shared-cache backends */
1335 int nextPagesize; /* Pagesize after VACUUM if >0 */
1336 u32 magic; /* Magic number for detect library misuse */
1337 int nChange; /* Value returned by sqlite3_changes() */
1338 int nTotalChange; /* Value returned by sqlite3_total_changes() */
1339 int aLimit[SQLITE_N_LIMIT]; /* Limits */
1340 int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */
1341 struct sqlite3InitInfo { /* Information used during initialization */
1342 int newTnum; /* Rootpage of table being initialized */
1343 u8 iDb; /* Which db file is being initialized */
1344 u8 busy; /* TRUE if currently initializing */
1345 u8 orphanTrigger; /* Last statement is orphaned TEMP trigger */
1346 u8 imposterTable; /* Building an imposter table */
1347 } init;
1348 int nVdbeActive; /* Number of VDBEs currently running */
1349 int nVdbeRead; /* Number of active VDBEs that read or write */
1350 int nVdbeWrite; /* Number of active VDBEs that read and write */
1351 int nVdbeExec; /* Number of nested calls to VdbeExec() */
1352 int nVDestroy; /* Number of active OP_VDestroy operations */
1353 int nExtension; /* Number of loaded extensions */
1354 void **aExtension; /* Array of shared library handles */
1355 int (*xTrace)(u32,void*,void*,void*); /* Trace function */
1356 void *pTraceArg; /* Argument to the trace function */
1357 void (*xProfile)(void*,const char*,u64); /* Profiling function */
1358 void *pProfileArg; /* Argument to profile function */
1359 void *pCommitArg; /* Argument to xCommitCallback() */
1360 int (*xCommitCallback)(void*); /* Invoked at every commit. */
1361 void *pRollbackArg; /* Argument to xRollbackCallback() */
1362 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
1363 void *pUpdateArg;
1364 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
1365 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1366 void *pPreUpdateArg; /* First argument to xPreUpdateCallback */
1367 void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */
1368 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64
1369 );
1370 PreUpdate *pPreUpdate; /* Context for active pre-update callback */
1371 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
1372 #ifndef SQLITE_OMIT_WAL
1373 int (*xWalCallback)(void *, sqlite3 *, const char *, int);
1374 void *pWalArg;
1375 #endif
1376 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
1377 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
1378 void *pCollNeededArg;
1379 sqlite3_value *pErr; /* Most recent error message */
1380 union {
1381 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
1382 double notUsed1; /* Spacer */
1383 } u1;
1384 Lookaside lookaside; /* Lookaside malloc configuration */
1385 #ifndef SQLITE_OMIT_AUTHORIZATION
1386 sqlite3_xauth xAuth; /* Access authorization function */
1387 void *pAuthArg; /* 1st argument to the access auth function */
1388 #endif
1389 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1390 int (*xProgress)(void *); /* The progress callback */
1391 void *pProgressArg; /* Argument to the progress callback */
1392 unsigned nProgressOps; /* Number of opcodes for progress callback */
1393 #endif
1394 #ifndef SQLITE_OMIT_VIRTUALTABLE
1395 int nVTrans; /* Allocated size of aVTrans */
1396 Hash aModule; /* populated by sqlite3_create_module() */
1397 VtabCtx *pVtabCtx; /* Context for active vtab connect/create */
1398 VTable **aVTrans; /* Virtual tables with open transactions */
1399 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */
1400 #endif
1401 Hash aFunc; /* Hash table of connection functions */
1402 Hash aCollSeq; /* All collating sequences */
1403 BusyHandler busyHandler; /* Busy callback */
1404 Db aDbStatic[2]; /* Static space for the 2 default backends */
1405 Savepoint *pSavepoint; /* List of active savepoints */
1406 int busyTimeout; /* Busy handler timeout, in msec */
1407 int nSavepoint; /* Number of non-transaction savepoints */
1408 int nStatement; /* Number of nested statement-transactions */
1409 i64 nDeferredCons; /* Net deferred constraints this transaction. */
1410 i64 nDeferredImmCons; /* Net deferred immediate constraints */
1411 int *pnBytesFreed; /* If not NULL, increment this in DbFree() */
1412 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
1413 /* The following variables are all protected by the STATIC_MASTER
1414 ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
1415 **
1416 ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
1417 ** unlock so that it can proceed.
1418 **
1419 ** When X.pBlockingConnection==Y, that means that something that X tried
1420 ** tried to do recently failed with an SQLITE_LOCKED error due to locks
1421 ** held by Y.
1422 */
1423 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
1424 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */
1425 void *pUnlockArg; /* Argument to xUnlockNotify */
1426 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */
1427 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */
1428 #endif
1429 #ifdef SQLITE_USER_AUTHENTICATION
1430 sqlite3_userauth auth; /* User authentication information */
1431 #endif
1432 };
1433
1434 /*
1435 ** A macro to discover the encoding of a database.
1436 */
1437 #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
1438 #define ENC(db) ((db)->enc)
1439
1440 /*
1441 ** Possible values for the sqlite3.flags.
1442 **
1443 ** Value constraints (enforced via assert()):
1444 ** SQLITE_FullFSync == PAGER_FULLFSYNC
1445 ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC
1446 ** SQLITE_CacheSpill == PAGER_CACHE_SPILL
1447 */
1448 #define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
1449 #define SQLITE_InternChanges 0x00000002 /* Uncommitted Hash table changes */
1450 #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */
1451 #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */
1452 #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */
1453 #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */
1454 #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
1455 #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
1456 /* DELETE, or UPDATE and return */
1457 /* the count using a callback. */
1458 #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
1459 /* result set is empty */
1460 #define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
1461 #define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
1462 #define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
1463 #define SQLITE_VdbeAddopTrace 0x00001000 /* Trace sqlite3VdbeAddOp() calls */
1464 #define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
1465 #define SQLITE_ReadUncommitted 0x0004000 /* For shared-cache mode */
1466 #define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
1467 #define SQLITE_RecoveryMode 0x00010000 /* Ignore schema errors */
1468 #define SQLITE_ReverseOrder 0x00020000 /* Reverse unordered SELECTs */
1469 #define SQLITE_RecTriggers 0x00040000 /* Enable recursive triggers */
1470 #define SQLITE_ForeignKeys 0x00080000 /* Enforce foreign key constraints */
1471 #define SQLITE_AutoIndex 0x00100000 /* Enable automatic indexes */
1472 #define SQLITE_PreferBuiltin 0x00200000 /* Preference to built-in funcs */
1473 #define SQLITE_LoadExtension 0x00400000 /* Enable load_extension */
1474 #define SQLITE_LoadExtFunc 0x00800000 /* Enable load_extension() SQL func */
1475 #define SQLITE_EnableTrigger 0x01000000 /* True to enable triggers */
1476 #define SQLITE_DeferFKs 0x02000000 /* Defer all FK constraints */
1477 #define SQLITE_QueryOnly 0x04000000 /* Disable database changes */
1478 #define SQLITE_VdbeEQP 0x08000000 /* Debug EXPLAIN QUERY PLAN */
1479 #define SQLITE_Vacuum 0x10000000 /* Currently in a VACUUM */
1480 #define SQLITE_CellSizeCk 0x20000000 /* Check btree cell sizes on load */
1481 #define SQLITE_Fts3Tokenizer 0x40000000 /* Enable fts3_tokenizer(2) */
1482 #define SQLITE_NoCkptOnClose 0x80000000 /* No checkpoint on close()/DETACH */
1483
1484
1485 /*
1486 ** Bits of the sqlite3.dbOptFlags field that are used by the
1487 ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
1488 ** selectively disable various optimizations.
1489 */
1490 #define SQLITE_QueryFlattener 0x0001 /* Query flattening */
1491 #define SQLITE_ColumnCache 0x0002 /* Column cache */
1492 #define SQLITE_GroupByOrder 0x0004 /* GROUPBY cover of ORDERBY */
1493 #define SQLITE_FactorOutConst 0x0008 /* Constant factoring */
1494 /* not used 0x0010 // Was: SQLITE_IdxRealAsInt */
1495 #define SQLITE_DistinctOpt 0x0020 /* DISTINCT using indexes */
1496 #define SQLITE_CoverIdxScan 0x0040 /* Covering index scans */
1497 #define SQLITE_OrderByIdxJoin 0x0080 /* ORDER BY of joins via index */
1498 #define SQLITE_SubqCoroutine 0x0100 /* Evaluate subqueries as coroutines */
1499 #define SQLITE_Transitive 0x0200 /* Transitive constraints */
1500 #define SQLITE_OmitNoopJoin 0x0400 /* Omit unused tables in joins */
1501 #define SQLITE_Stat34 0x0800 /* Use STAT3 or STAT4 data */
1502 #define SQLITE_CursorHints 0x2000 /* Add OP_CursorHint opcodes */
1503 #define SQLITE_AllOpts 0xffff /* All optimizations */
1504
1505 /*
1506 ** Macros for testing whether or not optimizations are enabled or disabled.
1507 */
1508 #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0)
1509 #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0)
1510
1511 /*
1512 ** Return true if it OK to factor constant expressions into the initialization
1513 ** code. The argument is a Parse object for the code generator.
1514 */
1515 #define ConstFactorOk(P) ((P)->okConstFactor)
1516
1517 /*
1518 ** Possible values for the sqlite.magic field.
1519 ** The numbers are obtained at random and have no special meaning, other
1520 ** than being distinct from one another.
1521 */
1522 #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
1523 #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
1524 #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
1525 #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
1526 #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
1527 #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */
1528
1529 /*
1530 ** Each SQL function is defined by an instance of the following
1531 ** structure. For global built-in functions (ex: substr(), max(), count())
1532 ** a pointer to this structure is held in the sqlite3BuiltinFunctions object.
1533 ** For per-connection application-defined functions, a pointer to this
1534 ** structure is held in the db->aHash hash table.
1535 **
1536 ** The u.pHash field is used by the global built-ins. The u.pDestructor
1537 ** field is used by per-connection app-def functions.
1538 */
1539 struct FuncDef {
1540 i8 nArg; /* Number of arguments. -1 means unlimited */
1541 u16 funcFlags; /* Some combination of SQLITE_FUNC_* */
1542 void *pUserData; /* User data parameter */
1543 FuncDef *pNext; /* Next function with same name */
1544 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */
1545 void (*xFinalize)(sqlite3_context*); /* Agg finalizer */
1546 const char *zName; /* SQL name of the function. */
1547 union {
1548 FuncDef *pHash; /* Next with a different name but the same hash */
1549 FuncDestructor *pDestructor; /* Reference counted destructor function */
1550 } u;
1551 };
1552
1553 /*
1554 ** This structure encapsulates a user-function destructor callback (as
1555 ** configured using create_function_v2()) and a reference counter. When
1556 ** create_function_v2() is called to create a function with a destructor,
1557 ** a single object of this type is allocated. FuncDestructor.nRef is set to
1558 ** the number of FuncDef objects created (either 1 or 3, depending on whether
1559 ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
1560 ** member of each of the new FuncDef objects is set to point to the allocated
1561 ** FuncDestructor.
1562 **
1563 ** Thereafter, when one of the FuncDef objects is deleted, the reference
1564 ** count on this object is decremented. When it reaches 0, the destructor
1565 ** is invoked and the FuncDestructor structure freed.
1566 */
1567 struct FuncDestructor {
1568 int nRef;
1569 void (*xDestroy)(void *);
1570 void *pUserData;
1571 };
1572
1573 /*
1574 ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF
1575 ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And
1576 ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There
1577 ** are assert() statements in the code to verify this.
1578 **
1579 ** Value constraints (enforced via assert()):
1580 ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg
1581 ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG
1582 ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG
1583 ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API
1584 ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API
1585 */
1586 #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
1587 #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */
1588 #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */
1589 #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */
1590 #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/
1591 #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */
1592 #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */
1593 #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */
1594 #define SQLITE_FUNC_COALESCE 0x0200 /* Built-in coalesce() or ifnull() */
1595 #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */
1596 #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */
1597 #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */
1598 #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a
1599 ** single query - might change over time */
1600 #define SQLITE_FUNC_AFFINITY 0x4000 /* Built-in affinity() function */
1601
1602 /*
1603 ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1604 ** used to create the initializers for the FuncDef structures.
1605 **
1606 ** FUNCTION(zName, nArg, iArg, bNC, xFunc)
1607 ** Used to create a scalar function definition of a function zName
1608 ** implemented by C function xFunc that accepts nArg arguments. The
1609 ** value passed as iArg is cast to a (void*) and made available
1610 ** as the user-data (sqlite3_user_data()) for the function. If
1611 ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
1612 **
1613 ** VFUNCTION(zName, nArg, iArg, bNC, xFunc)
1614 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
1615 **
1616 ** DFUNCTION(zName, nArg, iArg, bNC, xFunc)
1617 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
1618 ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions
1619 ** and functions like sqlite_version() that can change, but not during
1620 ** a single query.
1621 **
1622 ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
1623 ** Used to create an aggregate function definition implemented by
1624 ** the C functions xStep and xFinal. The first four parameters
1625 ** are interpreted in the same way as the first 4 parameters to
1626 ** FUNCTION().
1627 **
1628 ** LIKEFUNC(zName, nArg, pArg, flags)
1629 ** Used to create a scalar function definition of a function zName
1630 ** that accepts nArg arguments and is implemented by a call to C
1631 ** function likeFunc. Argument pArg is cast to a (void *) and made
1632 ** available as the function user-data (sqlite3_user_data()). The
1633 ** FuncDef.flags variable is set to the value passed as the flags
1634 ** parameter.
1635 */
1636 #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
1637 {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
1638 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
1639 #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
1640 {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
1641 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
1642 #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \
1643 {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
1644 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
1645 #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
1646 {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
1647 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
1648 #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
1649 {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
1650 pArg, 0, xFunc, 0, #zName, }
1651 #define LIKEFUNC(zName, nArg, arg, flags) \
1652 {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
1653 (void *)arg, 0, likeFunc, 0, #zName, {0} }
1654 #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
1655 {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
1656 SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
1657 #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \
1658 {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
1659 SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
1660
1661 /*
1662 ** All current savepoints are stored in a linked list starting at
1663 ** sqlite3.pSavepoint. The first element in the list is the most recently
1664 ** opened savepoint. Savepoints are added to the list by the vdbe
1665 ** OP_Savepoint instruction.
1666 */
1667 struct Savepoint {
1668 char *zName; /* Savepoint name (nul-terminated) */
1669 i64 nDeferredCons; /* Number of deferred fk violations */
1670 i64 nDeferredImmCons; /* Number of deferred imm fk. */
1671 Savepoint *pNext; /* Parent savepoint (if any) */
1672 };
1673
1674 /*
1675 ** The following are used as the second parameter to sqlite3Savepoint(),
1676 ** and as the P1 argument to the OP_Savepoint instruction.
1677 */
1678 #define SAVEPOINT_BEGIN 0
1679 #define SAVEPOINT_RELEASE 1
1680 #define SAVEPOINT_ROLLBACK 2
1681
1682
1683 /*
1684 ** Each SQLite module (virtual table definition) is defined by an
1685 ** instance of the following structure, stored in the sqlite3.aModule
1686 ** hash table.
1687 */
1688 struct Module {
1689 const sqlite3_module *pModule; /* Callback pointers */
1690 const char *zName; /* Name passed to create_module() */
1691 void *pAux; /* pAux passed to create_module() */
1692 void (*xDestroy)(void *); /* Module destructor function */
1693 Table *pEpoTab; /* Eponymous table for this module */
1694 };
1695
1696 /*
1697 ** information about each column of an SQL table is held in an instance
1698 ** of this structure.
1699 */
1700 struct Column {
1701 char *zName; /* Name of this column, \000, then the type */
1702 Expr *pDflt; /* Default value of this column */
1703 char *zColl; /* Collating sequence. If NULL, use the default */
1704 u8 notNull; /* An OE_ code for handling a NOT NULL constraint */
1705 char affinity; /* One of the SQLITE_AFF_... values */
1706 u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */
1707 u8 colFlags; /* Boolean properties. See COLFLAG_ defines below */
1708 };
1709
1710 /* Allowed values for Column.colFlags:
1711 */
1712 #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */
1713 #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */
1714 #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */
1715
1716 /*
1717 ** A "Collating Sequence" is defined by an instance of the following
1718 ** structure. Conceptually, a collating sequence consists of a name and
1719 ** a comparison routine that defines the order of that sequence.
1720 **
1721 ** If CollSeq.xCmp is NULL, it means that the
1722 ** collating sequence is undefined. Indices built on an undefined
1723 ** collating sequence may not be read or written.
1724 */
1725 struct CollSeq {
1726 char *zName; /* Name of the collating sequence, UTF-8 encoded */
1727 u8 enc; /* Text encoding handled by xCmp() */
1728 void *pUser; /* First argument to xCmp() */
1729 int (*xCmp)(void*,int, const void*, int, const void*);
1730 void (*xDel)(void*); /* Destructor for pUser */
1731 };
1732
1733 /*
1734 ** A sort order can be either ASC or DESC.
1735 */
1736 #define SQLITE_SO_ASC 0 /* Sort in ascending order */
1737 #define SQLITE_SO_DESC 1 /* Sort in ascending order */
1738 #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */
1739
1740 /*
1741 ** Column affinity types.
1742 **
1743 ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
1744 ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
1745 ** the speed a little by numbering the values consecutively.
1746 **
1747 ** But rather than start with 0 or 1, we begin with 'A'. That way,
1748 ** when multiple affinity types are concatenated into a string and
1749 ** used as the P4 operand, they will be more readable.
1750 **
1751 ** Note also that the numeric types are grouped together so that testing
1752 ** for a numeric type is a single comparison. And the BLOB type is first.
1753 */
1754 #define SQLITE_AFF_BLOB 'A'
1755 #define SQLITE_AFF_TEXT 'B'
1756 #define SQLITE_AFF_NUMERIC 'C'
1757 #define SQLITE_AFF_INTEGER 'D'
1758 #define SQLITE_AFF_REAL 'E'
1759
1760 #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
1761
1762 /*
1763 ** The SQLITE_AFF_MASK values masks off the significant bits of an
1764 ** affinity value.
1765 */
1766 #define SQLITE_AFF_MASK 0x47
1767
1768 /*
1769 ** Additional bit values that can be ORed with an affinity without
1770 ** changing the affinity.
1771 **
1772 ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
1773 ** It causes an assert() to fire if either operand to a comparison
1774 ** operator is NULL. It is added to certain comparison operators to
1775 ** prove that the operands are always NOT NULL.
1776 */
1777 #define SQLITE_KEEPNULL 0x08 /* Used by vector == or <> */
1778 #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */
1779 #define SQLITE_STOREP2 0x20 /* Store result in reg[P2] rather than jump */
1780 #define SQLITE_NULLEQ 0x80 /* NULL=NULL */
1781 #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */
1782
1783 /*
1784 ** An object of this type is created for each virtual table present in
1785 ** the database schema.
1786 **
1787 ** If the database schema is shared, then there is one instance of this
1788 ** structure for each database connection (sqlite3*) that uses the shared
1789 ** schema. This is because each database connection requires its own unique
1790 ** instance of the sqlite3_vtab* handle used to access the virtual table
1791 ** implementation. sqlite3_vtab* handles can not be shared between
1792 ** database connections, even when the rest of the in-memory database
1793 ** schema is shared, as the implementation often stores the database
1794 ** connection handle passed to it via the xConnect() or xCreate() method
1795 ** during initialization internally. This database connection handle may
1796 ** then be used by the virtual table implementation to access real tables
1797 ** within the database. So that they appear as part of the callers
1798 ** transaction, these accesses need to be made via the same database
1799 ** connection as that used to execute SQL operations on the virtual table.
1800 **
1801 ** All VTable objects that correspond to a single table in a shared
1802 ** database schema are initially stored in a linked-list pointed to by
1803 ** the Table.pVTable member variable of the corresponding Table object.
1804 ** When an sqlite3_prepare() operation is required to access the virtual
1805 ** table, it searches the list for the VTable that corresponds to the
1806 ** database connection doing the preparing so as to use the correct
1807 ** sqlite3_vtab* handle in the compiled query.
1808 **
1809 ** When an in-memory Table object is deleted (for example when the
1810 ** schema is being reloaded for some reason), the VTable objects are not
1811 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
1812 ** immediately. Instead, they are moved from the Table.pVTable list to
1813 ** another linked list headed by the sqlite3.pDisconnect member of the
1814 ** corresponding sqlite3 structure. They are then deleted/xDisconnected
1815 ** next time a statement is prepared using said sqlite3*. This is done
1816 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
1817 ** Refer to comments above function sqlite3VtabUnlockList() for an
1818 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
1819 ** list without holding the corresponding sqlite3.mutex mutex.
1820 **
1821 ** The memory for objects of this type is always allocated by
1822 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
1823 ** the first argument.
1824 */
1825 struct VTable {
1826 sqlite3 *db; /* Database connection associated with this table */
1827 Module *pMod; /* Pointer to module implementation */
1828 sqlite3_vtab *pVtab; /* Pointer to vtab instance */
1829 int nRef; /* Number of pointers to this structure */
1830 u8 bConstraint; /* True if constraints are supported */
1831 int iSavepoint; /* Depth of the SAVEPOINT stack */
1832 VTable *pNext; /* Next in linked list (see above) */
1833 };
1834
1835 /*
1836 ** The schema for each SQL table and view is represented in memory
1837 ** by an instance of the following structure.
1838 */
1839 struct Table {
1840 char *zName; /* Name of the table or view */
1841 Column *aCol; /* Information about each column */
1842 Index *pIndex; /* List of SQL indexes on this table. */
1843 Select *pSelect; /* NULL for tables. Points to definition if a view. */
1844 FKey *pFKey; /* Linked list of all foreign keys in this table */
1845 char *zColAff; /* String defining the affinity of each column */
1846 ExprList *pCheck; /* All CHECK constraints */
1847 /* ... also used as column name list in a VIEW */
1848 int tnum; /* Root BTree page for this table */
1849 u32 nTabRef; /* Number of pointers to this Table */
1850 i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */
1851 i16 nCol; /* Number of columns in this table */
1852 LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */
1853 LogEst szTabRow; /* Estimated size of each table row in bytes */
1854 #ifdef SQLITE_ENABLE_COSTMULT
1855 LogEst costMult; /* Cost multiplier for using this table */
1856 #endif
1857 u8 tabFlags; /* Mask of TF_* values */
1858 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
1859 #ifndef SQLITE_OMIT_ALTERTABLE
1860 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
1861 #endif
1862 #ifndef SQLITE_OMIT_VIRTUALTABLE
1863 int nModuleArg; /* Number of arguments to the module */
1864 char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */
1865 VTable *pVTable; /* List of VTable objects. */
1866 #endif
1867 Trigger *pTrigger; /* List of triggers stored in pSchema */
1868 Schema *pSchema; /* Schema that contains this table */
1869 Table *pNextZombie; /* Next on the Parse.pZombieTab list */
1870 };
1871
1872 /*
1873 ** Allowed values for Table.tabFlags.
1874 **
1875 ** TF_OOOHidden applies to tables or view that have hidden columns that are
1876 ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING
1877 ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden,
1878 ** the TF_OOOHidden attribute would apply in this case. Such tables require
1879 ** special handling during INSERT processing.
1880 */
1881 #define TF_Readonly 0x01 /* Read-only system table */
1882 #define TF_Ephemeral 0x02 /* An ephemeral table */
1883 #define TF_HasPrimaryKey 0x04 /* Table has a primary key */
1884 #define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */
1885 #define TF_Virtual 0x10 /* Is a virtual table */
1886 #define TF_WithoutRowid 0x20 /* No rowid. PRIMARY KEY is the key */
1887 #define TF_NoVisibleRowid 0x40 /* No user-visible "rowid" column */
1888 #define TF_OOOHidden 0x80 /* Out-of-Order hidden columns */
1889
1890
1891 /*
1892 ** Test to see whether or not a table is a virtual table. This is
1893 ** done as a macro so that it will be optimized out when virtual
1894 ** table support is omitted from the build.
1895 */
1896 #ifndef SQLITE_OMIT_VIRTUALTABLE
1897 # define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0)
1898 #else
1899 # define IsVirtual(X) 0
1900 #endif
1901
1902 /*
1903 ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn()
1904 ** only works for non-virtual tables (ordinary tables and views) and is
1905 ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The
1906 ** IsHiddenColumn() macro is general purpose.
1907 */
1908 #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS)
1909 # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
1910 # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
1911 #elif !defined(SQLITE_OMIT_VIRTUALTABLE)
1912 # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
1913 # define IsOrdinaryHiddenColumn(X) 0
1914 #else
1915 # define IsHiddenColumn(X) 0
1916 # define IsOrdinaryHiddenColumn(X) 0
1917 #endif
1918
1919
1920 /* Does the table have a rowid */
1921 #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0)
1922 #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
1923
1924 /*
1925 ** Each foreign key constraint is an instance of the following structure.
1926 **
1927 ** A foreign key is associated with two tables. The "from" table is
1928 ** the table that contains the REFERENCES clause that creates the foreign
1929 ** key. The "to" table is the table that is named in the REFERENCES clause.
1930 ** Consider this example:
1931 **
1932 ** CREATE TABLE ex1(
1933 ** a INTEGER PRIMARY KEY,
1934 ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1935 ** );
1936 **
1937 ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1938 ** Equivalent names:
1939 **
1940 ** from-table == child-table
1941 ** to-table == parent-table
1942 **
1943 ** Each REFERENCES clause generates an instance of the following structure
1944 ** which is attached to the from-table. The to-table need not exist when
1945 ** the from-table is created. The existence of the to-table is not checked.
1946 **
1947 ** The list of all parents for child Table X is held at X.pFKey.
1948 **
1949 ** A list of all children for a table named Z (which might not even exist)
1950 ** is held in Schema.fkeyHash with a hash key of Z.
1951 */
1952 struct FKey {
1953 Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */
1954 FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */
1955 char *zTo; /* Name of table that the key points to (aka: Parent) */
1956 FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */
1957 FKey *pPrevTo; /* Previous with the same zTo */
1958 int nCol; /* Number of columns in this key */
1959 /* EV: R-30323-21917 */
1960 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
1961 u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */
1962 Trigger *apTrigger[2];/* Triggers for aAction[] actions */
1963 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
1964 int iFrom; /* Index of column in pFrom */
1965 char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */
1966 } aCol[1]; /* One entry for each of nCol columns */
1967 };
1968
1969 /*
1970 ** SQLite supports many different ways to resolve a constraint
1971 ** error. ROLLBACK processing means that a constraint violation
1972 ** causes the operation in process to fail and for the current transaction
1973 ** to be rolled back. ABORT processing means the operation in process
1974 ** fails and any prior changes from that one operation are backed out,
1975 ** but the transaction is not rolled back. FAIL processing means that
1976 ** the operation in progress stops and returns an error code. But prior
1977 ** changes due to the same operation are not backed out and no rollback
1978 ** occurs. IGNORE means that the particular row that caused the constraint
1979 ** error is not inserted or updated. Processing continues and no error
1980 ** is returned. REPLACE means that preexisting database rows that caused
1981 ** a UNIQUE constraint violation are removed so that the new insert or
1982 ** update can proceed. Processing continues and no error is reported.
1983 **
1984 ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1985 ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1986 ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
1987 ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
1988 ** referenced table row is propagated into the row that holds the
1989 ** foreign key.
1990 **
1991 ** The following symbolic values are used to record which type
1992 ** of action to take.
1993 */
1994 #define OE_None 0 /* There is no constraint to check */
1995 #define OE_Rollback 1 /* Fail the operation and rollback the transaction */
1996 #define OE_Abort 2 /* Back out changes but do no rollback transaction */
1997 #define OE_Fail 3 /* Stop the operation but leave all prior changes */
1998 #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
1999 #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
2000
2001 #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
2002 #define OE_SetNull 7 /* Set the foreign key value to NULL */
2003 #define OE_SetDflt 8 /* Set the foreign key value to its default */
2004 #define OE_Cascade 9 /* Cascade the changes */
2005
2006 #define OE_Default 10 /* Do whatever the default action is */
2007
2008
2009 /*
2010 ** An instance of the following structure is passed as the first
2011 ** argument to sqlite3VdbeKeyCompare and is used to control the
2012 ** comparison of the two index keys.
2013 **
2014 ** Note that aSortOrder[] and aColl[] have nField+1 slots. There
2015 ** are nField slots for the columns of an index then one extra slot
2016 ** for the rowid at the end.
2017 */
2018 struct KeyInfo {
2019 u32 nRef; /* Number of references to this KeyInfo object */
2020 u8 enc; /* Text encoding - one of the SQLITE_UTF* values */
2021 u16 nField; /* Number of key columns in the index */
2022 u16 nXField; /* Number of columns beyond the key columns */
2023 sqlite3 *db; /* The database connection */
2024 u8 *aSortOrder; /* Sort order for each column. */
2025 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
2026 };
2027
2028 /*
2029 ** This object holds a record which has been parsed out into individual
2030 ** fields, for the purposes of doing a comparison.
2031 **
2032 ** A record is an object that contains one or more fields of data.
2033 ** Records are used to store the content of a table row and to store
2034 ** the key of an index. A blob encoding of a record is created by
2035 ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
2036 ** OP_Column opcode.
2037 **
2038 ** An instance of this object serves as a "key" for doing a search on
2039 ** an index b+tree. The goal of the search is to find the entry that
2040 ** is closed to the key described by this object. This object might hold
2041 ** just a prefix of the key. The number of fields is given by
2042 ** pKeyInfo->nField.
2043 **
2044 ** The r1 and r2 fields are the values to return if this key is less than
2045 ** or greater than a key in the btree, respectively. These are normally
2046 ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree
2047 ** is in DESC order.
2048 **
2049 ** The key comparison functions actually return default_rc when they find
2050 ** an equals comparison. default_rc can be -1, 0, or +1. If there are
2051 ** multiple entries in the b-tree with the same key (when only looking
2052 ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to
2053 ** cause the search to find the last match, or +1 to cause the search to
2054 ** find the first match.
2055 **
2056 ** The key comparison functions will set eqSeen to true if they ever
2057 ** get and equal results when comparing this structure to a b-tree record.
2058 ** When default_rc!=0, the search might end up on the record immediately
2059 ** before the first match or immediately after the last match. The
2060 ** eqSeen field will indicate whether or not an exact match exists in the
2061 ** b-tree.
2062 */
2063 struct UnpackedRecord {
2064 KeyInfo *pKeyInfo; /* Collation and sort-order information */
2065 Mem *aMem; /* Values */
2066 u16 nField; /* Number of entries in apMem[] */
2067 i8 default_rc; /* Comparison result if keys are equal */
2068 u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
2069 i8 r1; /* Value to return if (lhs > rhs) */
2070 i8 r2; /* Value to return if (rhs < lhs) */
2071 u8 eqSeen; /* True if an equality comparison has been seen */
2072 };
2073
2074
2075 /*
2076 ** Each SQL index is represented in memory by an
2077 ** instance of the following structure.
2078 **
2079 ** The columns of the table that are to be indexed are described
2080 ** by the aiColumn[] field of this structure. For example, suppose
2081 ** we have the following table and index:
2082 **
2083 ** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
2084 ** CREATE INDEX Ex2 ON Ex1(c3,c1);
2085 **
2086 ** In the Table structure describing Ex1, nCol==3 because there are
2087 ** three columns in the table. In the Index structure describing
2088 ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
2089 ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
2090 ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
2091 ** The second column to be indexed (c1) has an index of 0 in
2092 ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
2093 **
2094 ** The Index.onError field determines whether or not the indexed columns
2095 ** must be unique and what to do if they are not. When Index.onError=OE_None,
2096 ** it means this is not a unique index. Otherwise it is a unique index
2097 ** and the value of Index.onError indicate the which conflict resolution
2098 ** algorithm to employ whenever an attempt is made to insert a non-unique
2099 ** element.
2100 **
2101 ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
2102 ** generate VDBE code (as opposed to parsing one read from an sqlite_master
2103 ** table as part of parsing an existing database schema), transient instances
2104 ** of this structure may be created. In this case the Index.tnum variable is
2105 ** used to store the address of a VDBE instruction, not a database page
2106 ** number (it cannot - the database page is not allocated until the VDBE
2107 ** program is executed). See convertToWithoutRowidTable() for details.
2108 */
2109 struct Index {
2110 char *zName; /* Name of this index */
2111 i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */
2112 LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */
2113 Table *pTable; /* The SQL table being indexed */
2114 char *zColAff; /* String defining the affinity of each column */
2115 Index *pNext; /* The next index associated with the same table */
2116 Schema *pSchema; /* Schema containing this index */
2117 u8 *aSortOrder; /* for each column: True==DESC, False==ASC */
2118 const char **azColl; /* Array of collation sequence names for index */
2119 Expr *pPartIdxWhere; /* WHERE clause for partial indices */
2120 ExprList *aColExpr; /* Column expressions */
2121 int tnum; /* DB Page containing root of this index */
2122 LogEst szIdxRow; /* Estimated average row size in bytes */
2123 u16 nKeyCol; /* Number of columns forming the key */
2124 u16 nColumn; /* Number of columns stored in the index */
2125 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
2126 unsigned idxType:2; /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */
2127 unsigned bUnordered:1; /* Use this index for == or IN queries only */
2128 unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */
2129 unsigned isResized:1; /* True if resizeIndexObject() has been called */
2130 unsigned isCovering:1; /* True if this is a covering index */
2131 unsigned noSkipScan:1; /* Do not try to use skip-scan if true */
2132 #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
2133 int nSample; /* Number of elements in aSample[] */
2134 int nSampleCol; /* Size of IndexSample.anEq[] and so on */
2135 tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */
2136 IndexSample *aSample; /* Samples of the left-most key */
2137 tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */
2138 tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */
2139 #endif
2140 };
2141
2142 /*
2143 ** Allowed values for Index.idxType
2144 */
2145 #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */
2146 #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */
2147 #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */
2148
2149 /* Return true if index X is a PRIMARY KEY index */
2150 #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
2151
2152 /* Return true if index X is a UNIQUE index */
2153 #define IsUniqueIndex(X) ((X)->onError!=OE_None)
2154
2155 /* The Index.aiColumn[] values are normally positive integer. But
2156 ** there are some negative values that have special meaning:
2157 */
2158 #define XN_ROWID (-1) /* Indexed column is the rowid */
2159 #define XN_EXPR (-2) /* Indexed column is an expression */
2160
2161 /*
2162 ** Each sample stored in the sqlite_stat3 table is represented in memory
2163 ** using a structure of this type. See documentation at the top of the
2164 ** analyze.c source file for additional information.
2165 */
2166 struct IndexSample {
2167 void *p; /* Pointer to sampled record */
2168 int n; /* Size of record in bytes */
2169 tRowcnt *anEq; /* Est. number of rows where the key equals this sample */
2170 tRowcnt *anLt; /* Est. number of rows where key is less than this sample */
2171 tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */
2172 };
2173
2174 /*
2175 ** Each token coming out of the lexer is an instance of
2176 ** this structure. Tokens are also used as part of an expression.
2177 **
2178 ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
2179 ** may contain random values. Do not make any assumptions about Token.dyn
2180 ** and Token.n when Token.z==0.
2181 */
2182 struct Token {
2183 const char *z; /* Text of the token. Not NULL-terminated! */
2184 unsigned int n; /* Number of characters in this token */
2185 };
2186
2187 /*
2188 ** An instance of this structure contains information needed to generate
2189 ** code for a SELECT that contains aggregate functions.
2190 **
2191 ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
2192 ** pointer to this structure. The Expr.iColumn field is the index in
2193 ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
2194 ** code for that node.
2195 **
2196 ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
2197 ** original Select structure that describes the SELECT statement. These
2198 ** fields do not need to be freed when deallocating the AggInfo structure.
2199 */
2200 struct AggInfo {
2201 u8 directMode; /* Direct rendering mode means take data directly
2202 ** from source tables rather than from accumulators */
2203 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
2204 ** than the source table */
2205 int sortingIdx; /* Cursor number of the sorting index */
2206 int sortingIdxPTab; /* Cursor number of pseudo-table */
2207 int nSortingColumn; /* Number of columns in the sorting index */
2208 int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */
2209 ExprList *pGroupBy; /* The group by clause */
2210 struct AggInfo_col { /* For each column used in source tables */
2211 Table *pTab; /* Source table */
2212 int iTable; /* Cursor number of the source table */
2213 int iColumn; /* Column number within the source table */
2214 int iSorterColumn; /* Column number in the sorting index */
2215 int iMem; /* Memory location that acts as accumulator */
2216 Expr *pExpr; /* The original expression */
2217 } *aCol;
2218 int nColumn; /* Number of used entries in aCol[] */
2219 int nAccumulator; /* Number of columns that show through to the output.
2220 ** Additional columns are used only as parameters to
2221 ** aggregate functions */
2222 struct AggInfo_func { /* For each aggregate function */
2223 Expr *pExpr; /* Expression encoding the function */
2224 FuncDef *pFunc; /* The aggregate function implementation */
2225 int iMem; /* Memory location that acts as accumulator */
2226 int iDistinct; /* Ephemeral table used to enforce DISTINCT */
2227 } *aFunc;
2228 int nFunc; /* Number of entries in aFunc[] */
2229 };
2230
2231 /*
2232 ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
2233 ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater
2234 ** than 32767 we have to make it 32-bit. 16-bit is preferred because
2235 ** it uses less memory in the Expr object, which is a big memory user
2236 ** in systems with lots of prepared statements. And few applications
2237 ** need more than about 10 or 20 variables. But some extreme users want
2238 ** to have prepared statements with over 32767 variables, and for them
2239 ** the option is available (at compile-time).
2240 */
2241 #if SQLITE_MAX_VARIABLE_NUMBER<=32767
2242 typedef i16 ynVar;
2243 #else
2244 typedef int ynVar;
2245 #endif
2246
2247 /*
2248 ** Each node of an expression in the parse tree is an instance
2249 ** of this structure.
2250 **
2251 ** Expr.op is the opcode. The integer parser token codes are reused
2252 ** as opcodes here. For example, the parser defines TK_GE to be an integer
2253 ** code representing the ">=" operator. This same integer code is reused
2254 ** to represent the greater-than-or-equal-to operator in the expression
2255 ** tree.
2256 **
2257 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
2258 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
2259 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
2260 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
2261 ** then Expr.token contains the name of the function.
2262 **
2263 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
2264 ** binary operator. Either or both may be NULL.
2265 **
2266 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
2267 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
2268 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
2269 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
2270 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
2271 ** valid.
2272 **
2273 ** An expression of the form ID or ID.ID refers to a column in a table.
2274 ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
2275 ** the integer cursor number of a VDBE cursor pointing to that table and
2276 ** Expr.iColumn is the column number for the specific column. If the
2277 ** expression is used as a result in an aggregate SELECT, then the
2278 ** value is also stored in the Expr.iAgg column in the aggregate so that
2279 ** it can be accessed after all aggregates are computed.
2280 **
2281 ** If the expression is an unbound variable marker (a question mark
2282 ** character '?' in the original SQL) then the Expr.iTable holds the index
2283 ** number for that variable.
2284 **
2285 ** If the expression is a subquery then Expr.iColumn holds an integer
2286 ** register number containing the result of the subquery. If the
2287 ** subquery gives a constant result, then iTable is -1. If the subquery
2288 ** gives a different answer at different times during statement processing
2289 ** then iTable is the address of a subroutine that computes the subquery.
2290 **
2291 ** If the Expr is of type OP_Column, and the table it is selecting from
2292 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
2293 ** corresponding table definition.
2294 **
2295 ** ALLOCATION NOTES:
2296 **
2297 ** Expr objects can use a lot of memory space in database schema. To
2298 ** help reduce memory requirements, sometimes an Expr object will be
2299 ** truncated. And to reduce the number of memory allocations, sometimes
2300 ** two or more Expr objects will be stored in a single memory allocation,
2301 ** together with Expr.zToken strings.
2302 **
2303 ** If the EP_Reduced and EP_TokenOnly flags are set when
2304 ** an Expr object is truncated. When EP_Reduced is set, then all
2305 ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
2306 ** are contained within the same memory allocation. Note, however, that
2307 ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
2308 ** allocated, regardless of whether or not EP_Reduced is set.
2309 */
2310 struct Expr {
2311 u8 op; /* Operation performed by this node */
2312 char affinity; /* The affinity of the column or 0 if not a column */
2313 u32 flags; /* Various flags. EP_* See below */
2314 union {
2315 char *zToken; /* Token value. Zero terminated and dequoted */
2316 int iValue; /* Non-negative integer value if EP_IntValue */
2317 } u;
2318
2319 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
2320 ** space is allocated for the fields below this point. An attempt to
2321 ** access them will result in a segfault or malfunction.
2322 *********************************************************************/
2323
2324 Expr *pLeft; /* Left subnode */
2325 Expr *pRight; /* Right subnode */
2326 union {
2327 ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
2328 Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */
2329 } x;
2330
2331 /* If the EP_Reduced flag is set in the Expr.flags mask, then no
2332 ** space is allocated for the fields below this point. An attempt to
2333 ** access them will result in a segfault or malfunction.
2334 *********************************************************************/
2335
2336 #if SQLITE_MAX_EXPR_DEPTH>0
2337 int nHeight; /* Height of the tree headed by this node */
2338 #endif
2339 int iTable; /* TK_COLUMN: cursor number of table holding column
2340 ** TK_REGISTER: register number
2341 ** TK_TRIGGER: 1 -> new, 0 -> old
2342 ** EP_Unlikely: 134217728 times likelihood
2343 ** TK_SELECT: 1st register of result vector */
2344 ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid.
2345 ** TK_VARIABLE: variable number (always >= 1).
2346 ** TK_SELECT_COLUMN: column of the result vector */
2347 i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
2348 i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */
2349 u8 op2; /* TK_REGISTER: original value of Expr.op
2350 ** TK_COLUMN: the value of p5 for OP_Column
2351 ** TK_AGG_FUNCTION: nesting depth */
2352 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
2353 Table *pTab; /* Table for TK_COLUMN expressions. */
2354 };
2355
2356 /*
2357 ** The following are the meanings of bits in the Expr.flags field.
2358 */
2359 #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */
2360 #define EP_Agg 0x000002 /* Contains one or more aggregate functions */
2361 #define EP_Resolved 0x000004 /* IDs have been resolved to COLUMNs */
2362 #define EP_Error 0x000008 /* Expression contains one or more errors */
2363 #define EP_Distinct 0x000010 /* Aggregate function with DISTINCT keyword */
2364 #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
2365 #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
2366 #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
2367 #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */
2368 #define EP_Generic 0x000200 /* Ignore COLLATE or affinity on this tree */
2369 #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */
2370 #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
2371 #define EP_Skip 0x001000 /* COLLATE, AS, or UNLIKELY */
2372 #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
2373 #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
2374 #define EP_Static 0x008000 /* Held in memory not obtained from malloc() */
2375 #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */
2376 #define EP_NoReduce 0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
2377 #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */
2378 #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */
2379 #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */
2380 #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */
2381 #define EP_Alias 0x400000 /* Is an alias for a result set column */
2382 #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */
2383
2384 /*
2385 ** Combinations of two or more EP_* flags
2386 */
2387 #define EP_Propagate (EP_Collate|EP_Subquery) /* Propagate these bits up tree */
2388
2389 /*
2390 ** These macros can be used to test, set, or clear bits in the
2391 ** Expr.flags field.
2392 */
2393 #define ExprHasProperty(E,P) (((E)->flags&(P))!=0)
2394 #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P))
2395 #define ExprSetProperty(E,P) (E)->flags|=(P)
2396 #define ExprClearProperty(E,P) (E)->flags&=~(P)
2397
2398 /* The ExprSetVVAProperty() macro is used for Verification, Validation,
2399 ** and Accreditation only. It works like ExprSetProperty() during VVA
2400 ** processes but is a no-op for delivery.
2401 */
2402 #ifdef SQLITE_DEBUG
2403 # define ExprSetVVAProperty(E,P) (E)->flags|=(P)
2404 #else
2405 # define ExprSetVVAProperty(E,P)
2406 #endif
2407
2408 /*
2409 ** Macros to determine the number of bytes required by a normal Expr
2410 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
2411 ** and an Expr struct with the EP_TokenOnly flag set.
2412 */
2413 #define EXPR_FULLSIZE sizeof(Expr) /* Full size */
2414 #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */
2415 #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */
2416
2417 /*
2418 ** Flags passed to the sqlite3ExprDup() function. See the header comment
2419 ** above sqlite3ExprDup() for details.
2420 */
2421 #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */
2422
2423 /*
2424 ** A list of expressions. Each expression may optionally have a
2425 ** name. An expr/name combination can be used in several ways, such
2426 ** as the list of "expr AS ID" fields following a "SELECT" or in the
2427 ** list of "ID = expr" items in an UPDATE. A list of expressions can
2428 ** also be used as the argument to a function, in which case the a.zName
2429 ** field is not used.
2430 **
2431 ** By default the Expr.zSpan field holds a human-readable description of
2432 ** the expression that is used in the generation of error messages and
2433 ** column labels. In this case, Expr.zSpan is typically the text of a
2434 ** column expression as it exists in a SELECT statement. However, if
2435 ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
2436 ** of the result column in the form: DATABASE.TABLE.COLUMN. This later
2437 ** form is used for name resolution with nested FROM clauses.
2438 */
2439 struct ExprList {
2440 int nExpr; /* Number of expressions on the list */
2441 struct ExprList_item { /* For each expression in the list */
2442 Expr *pExpr; /* The list of expressions */
2443 char *zName; /* Token associated with this expression */
2444 char *zSpan; /* Original text of the expression */
2445 u8 sortOrder; /* 1 for DESC or 0 for ASC */
2446 unsigned done :1; /* A flag to indicate when processing is finished */
2447 unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
2448 unsigned reusable :1; /* Constant expression is reusable */
2449 union {
2450 struct {
2451 u16 iOrderByCol; /* For ORDER BY, column number in result set */
2452 u16 iAlias; /* Index into Parse.aAlias[] for zName */
2453 } x;
2454 int iConstExprReg; /* Register in which Expr value is cached */
2455 } u;
2456 } *a; /* Alloc a power of two greater or equal to nExpr */
2457 };
2458
2459 /*
2460 ** An instance of this structure is used by the parser to record both
2461 ** the parse tree for an expression and the span of input text for an
2462 ** expression.
2463 */
2464 struct ExprSpan {
2465 Expr *pExpr; /* The expression parse tree */
2466 const char *zStart; /* First character of input text */
2467 const char *zEnd; /* One character past the end of input text */
2468 };
2469
2470 /*
2471 ** An instance of this structure can hold a simple list of identifiers,
2472 ** such as the list "a,b,c" in the following statements:
2473 **
2474 ** INSERT INTO t(a,b,c) VALUES ...;
2475 ** CREATE INDEX idx ON t(a,b,c);
2476 ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
2477 **
2478 ** The IdList.a.idx field is used when the IdList represents the list of
2479 ** column names after a table name in an INSERT statement. In the statement
2480 **
2481 ** INSERT INTO t(a,b,c) ...
2482 **
2483 ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
2484 */
2485 struct IdList {
2486 struct IdList_item {
2487 char *zName; /* Name of the identifier */
2488 int idx; /* Index in some Table.aCol[] of a column named zName */
2489 } *a;
2490 int nId; /* Number of identifiers on the list */
2491 };
2492
2493 /*
2494 ** The bitmask datatype defined below is used for various optimizations.
2495 **
2496 ** Changing this from a 64-bit to a 32-bit type limits the number of
2497 ** tables in a join to 32 instead of 64. But it also reduces the size
2498 ** of the library by 738 bytes on ix86.
2499 */
2500 #ifdef SQLITE_BITMASK_TYPE
2501 typedef SQLITE_BITMASK_TYPE Bitmask;
2502 #else
2503 typedef u64 Bitmask;
2504 #endif
2505
2506 /*
2507 ** The number of bits in a Bitmask. "BMS" means "BitMask Size".
2508 */
2509 #define BMS ((int)(sizeof(Bitmask)*8))
2510
2511 /*
2512 ** A bit in a Bitmask
2513 */
2514 #define MASKBIT(n) (((Bitmask)1)<<(n))
2515 #define MASKBIT32(n) (((unsigned int)1)<<(n))
2516 #define ALLBITS ((Bitmask)-1)
2517
2518 /*
2519 ** The following structure describes the FROM clause of a SELECT statement.
2520 ** Each table or subquery in the FROM clause is a separate element of
2521 ** the SrcList.a[] array.
2522 **
2523 ** With the addition of multiple database support, the following structure
2524 ** can also be used to describe a particular table such as the table that
2525 ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
2526 ** such a table must be a simple name: ID. But in SQLite, the table can
2527 ** now be identified by a database name, a dot, then the table name: ID.ID.
2528 **
2529 ** The jointype starts out showing the join type between the current table
2530 ** and the next table on the list. The parser builds the list this way.
2531 ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
2532 ** jointype expresses the join between the table and the previous table.
2533 **
2534 ** In the colUsed field, the high-order bit (bit 63) is set if the table
2535 ** contains more than 63 columns and the 64-th or later column is used.
2536 */
2537 struct SrcList {
2538 int nSrc; /* Number of tables or subqueries in the FROM clause */
2539 u32 nAlloc; /* Number of entries allocated in a[] below */
2540 struct SrcList_item {
2541 Schema *pSchema; /* Schema to which this item is fixed */
2542 char *zDatabase; /* Name of database holding this table */
2543 char *zName; /* Name of the table */
2544 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
2545 Table *pTab; /* An SQL table corresponding to zName */
2546 Select *pSelect; /* A SELECT statement used in place of a table name */
2547 int addrFillSub; /* Address of subroutine to manifest a subquery */
2548 int regReturn; /* Register holding return address of addrFillSub */
2549 int regResult; /* Registers holding results of a co-routine */
2550 struct {
2551 u8 jointype; /* Type of join between this table and the previous */
2552 unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */
2553 unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */
2554 unsigned isTabFunc :1; /* True if table-valued-function syntax */
2555 unsigned isCorrelated :1; /* True if sub-query is correlated */
2556 unsigned viaCoroutine :1; /* Implemented as a co-routine */
2557 unsigned isRecursive :1; /* True for recursive reference in WITH */
2558 } fg;
2559 #ifndef SQLITE_OMIT_EXPLAIN
2560 u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */
2561 #endif
2562 int iCursor; /* The VDBE cursor number used to access this table */
2563 Expr *pOn; /* The ON clause of a join */
2564 IdList *pUsing; /* The USING clause of a join */
2565 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */
2566 union {
2567 char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */
2568 ExprList *pFuncArg; /* Arguments to table-valued-function */
2569 } u1;
2570 Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */
2571 } a[1]; /* One entry for each identifier on the list */
2572 };
2573
2574 /*
2575 ** Permitted values of the SrcList.a.jointype field
2576 */
2577 #define JT_INNER 0x0001 /* Any kind of inner or cross join */
2578 #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
2579 #define JT_NATURAL 0x0004 /* True for a "natural" join */
2580 #define JT_LEFT 0x0008 /* Left outer join */
2581 #define JT_RIGHT 0x0010 /* Right outer join */
2582 #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
2583 #define JT_ERROR 0x0040 /* unknown or unsupported join type */
2584
2585
2586 /*
2587 ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
2588 ** and the WhereInfo.wctrlFlags member.
2589 **
2590 ** Value constraints (enforced via assert()):
2591 ** WHERE_USE_LIMIT == SF_FixedLimit
2592 */
2593 #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
2594 #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
2595 #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
2596 #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
2597 #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */
2598 #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */
2599 #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of
2600 ** the OR optimization */
2601 #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */
2602 #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */
2603 #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */
2604 #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */
2605 #define WHERE_SEEK_TABLE 0x0400 /* Do not defer seeks on main table */
2606 #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */
2607 #define WHERE_SEEK_UNIQ_TABLE 0x1000 /* Do not defer seeks if unique */
2608 /* 0x2000 not currently used */
2609 #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */
2610 /* 0x8000 not currently used */
2611
2612 /* Allowed return values from sqlite3WhereIsDistinct()
2613 */
2614 #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */
2615 #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */
2616 #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */
2617 #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */
2618
2619 /*
2620 ** A NameContext defines a context in which to resolve table and column
2621 ** names. The context consists of a list of tables (the pSrcList) field and
2622 ** a list of named expression (pEList). The named expression list may
2623 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
2624 ** to the table being operated on by INSERT, UPDATE, or DELETE. The
2625 ** pEList corresponds to the result set of a SELECT and is NULL for
2626 ** other statements.
2627 **
2628 ** NameContexts can be nested. When resolving names, the inner-most
2629 ** context is searched first. If no match is found, the next outer
2630 ** context is checked. If there is still no match, the next context
2631 ** is checked. This process continues until either a match is found
2632 ** or all contexts are check. When a match is found, the nRef member of
2633 ** the context containing the match is incremented.
2634 **
2635 ** Each subquery gets a new NameContext. The pNext field points to the
2636 ** NameContext in the parent query. Thus the process of scanning the
2637 ** NameContext list corresponds to searching through successively outer
2638 ** subqueries looking for a match.
2639 */
2640 struct NameContext {
2641 Parse *pParse; /* The parser */
2642 SrcList *pSrcList; /* One or more tables used to resolve names */
2643 ExprList *pEList; /* Optional list of result-set columns */
2644 AggInfo *pAggInfo; /* Information about aggregates at this level */
2645 NameContext *pNext; /* Next outer name context. NULL for outermost */
2646 int nRef; /* Number of names resolved by this context */
2647 int nErr; /* Number of errors encountered while resolving names */
2648 u16 ncFlags; /* Zero or more NC_* flags defined below */
2649 };
2650
2651 /*
2652 ** Allowed values for the NameContext, ncFlags field.
2653 **
2654 ** Value constraints (all checked via assert()):
2655 ** NC_HasAgg == SF_HasAgg
2656 ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX
2657 **
2658 */
2659 #define NC_AllowAgg 0x0001 /* Aggregate functions are allowed here */
2660 #define NC_PartIdx 0x0002 /* True if resolving a partial index WHERE */
2661 #define NC_IsCheck 0x0004 /* True if resolving names in a CHECK constraint */
2662 #define NC_InAggFunc 0x0008 /* True if analyzing arguments to an agg func */
2663 #define NC_HasAgg 0x0010 /* One or more aggregate functions seen */
2664 #define NC_IdxExpr 0x0020 /* True if resolving columns of CREATE INDEX */
2665 #define NC_VarSelect 0x0040 /* A correlated subquery has been seen */
2666 #define NC_MinMaxAgg 0x1000 /* min/max aggregates seen. See note above */
2667
2668 /*
2669 ** An instance of the following structure contains all information
2670 ** needed to generate code for a single SELECT statement.
2671 **
2672 ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
2673 ** If there is a LIMIT clause, the parser sets nLimit to the value of the
2674 ** limit and nOffset to the value of the offset (or 0 if there is not
2675 ** offset). But later on, nLimit and nOffset become the memory locations
2676 ** in the VDBE that record the limit and offset counters.
2677 **
2678 ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
2679 ** These addresses must be stored so that we can go back and fill in
2680 ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
2681 ** the number of columns in P2 can be computed at the same time
2682 ** as the OP_OpenEphm instruction is coded because not
2683 ** enough information about the compound query is known at that point.
2684 ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
2685 ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating
2686 ** sequences for the ORDER BY clause.
2687 */
2688 struct Select {
2689 ExprList *pEList; /* The fields of the result */
2690 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
2691 LogEst nSelectRow; /* Estimated number of result rows */
2692 u32 selFlags; /* Various SF_* values */
2693 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
2694 #if SELECTTRACE_ENABLED
2695 char zSelName[12]; /* Symbolic name of this SELECT use for debugging */
2696 #endif
2697 int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */
2698 SrcList *pSrc; /* The FROM clause */
2699 Expr *pWhere; /* The WHERE clause */
2700 ExprList *pGroupBy; /* The GROUP BY clause */
2701 Expr *pHaving; /* The HAVING clause */
2702 ExprList *pOrderBy; /* The ORDER BY clause */
2703 Select *pPrior; /* Prior select in a compound select statement */
2704 Select *pNext; /* Next select to the left in a compound */
2705 Expr *pLimit; /* LIMIT expression. NULL means not used. */
2706 Expr *pOffset; /* OFFSET expression. NULL means not used. */
2707 With *pWith; /* WITH clause attached to this select. Or NULL. */
2708 };
2709
2710 /*
2711 ** Allowed values for Select.selFlags. The "SF" prefix stands for
2712 ** "Select Flag".
2713 **
2714 ** Value constraints (all checked via assert())
2715 ** SF_HasAgg == NC_HasAgg
2716 ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX
2717 ** SF_FixedLimit == WHERE_USE_LIMIT
2718 */
2719 #define SF_Distinct 0x00001 /* Output should be DISTINCT */
2720 #define SF_All 0x00002 /* Includes the ALL keyword */
2721 #define SF_Resolved 0x00004 /* Identifiers have been resolved */
2722 #define SF_Aggregate 0x00008 /* Contains agg functions or a GROUP BY */
2723 #define SF_HasAgg 0x00010 /* Contains aggregate functions */
2724 #define SF_UsesEphemeral 0x00020 /* Uses the OpenEphemeral opcode */
2725 #define SF_Expanded 0x00040 /* sqlite3SelectExpand() called on this */
2726 #define SF_HasTypeInfo 0x00080 /* FROM subqueries have Table metadata */
2727 #define SF_Compound 0x00100 /* Part of a compound query */
2728 #define SF_Values 0x00200 /* Synthesized from VALUES clause */
2729 #define SF_MultiValue 0x00400 /* Single VALUES term with multiple rows */
2730 #define SF_NestedFrom 0x00800 /* Part of a parenthesized FROM clause */
2731 #define SF_MinMaxAgg 0x01000 /* Aggregate containing min() or max() */
2732 #define SF_Recursive 0x02000 /* The recursive part of a recursive CTE */
2733 #define SF_FixedLimit 0x04000 /* nSelectRow set by a constant LIMIT */
2734 #define SF_MaybeConvert 0x08000 /* Need convertCompoundSelectToSubquery() */
2735 #define SF_Converted 0x10000 /* By convertCompoundSelectToSubquery() */
2736 #define SF_IncludeHidden 0x20000 /* Include hidden columns in output */
2737
2738
2739 /*
2740 ** The results of a SELECT can be distributed in several ways, as defined
2741 ** by one of the following macros. The "SRT" prefix means "SELECT Result
2742 ** Type".
2743 **
2744 ** SRT_Union Store results as a key in a temporary index
2745 ** identified by pDest->iSDParm.
2746 **
2747 ** SRT_Except Remove results from the temporary index pDest->iSDParm.
2748 **
2749 ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result
2750 ** set is not empty.
2751 **
2752 ** SRT_Discard Throw the results away. This is used by SELECT
2753 ** statements within triggers whose only purpose is
2754 ** the side-effects of functions.
2755 **
2756 ** All of the above are free to ignore their ORDER BY clause. Those that
2757 ** follow must honor the ORDER BY clause.
2758 **
2759 ** SRT_Output Generate a row of output (using the OP_ResultRow
2760 ** opcode) for each row in the result set.
2761 **
2762 ** SRT_Mem Only valid if the result is a single column.
2763 ** Store the first column of the first result row
2764 ** in register pDest->iSDParm then abandon the rest
2765 ** of the query. This destination implies "LIMIT 1".
2766 **
2767 ** SRT_Set The result must be a single column. Store each
2768 ** row of result as the key in table pDest->iSDParm.
2769 ** Apply the affinity pDest->affSdst before storing
2770 ** results. Used to implement "IN (SELECT ...)".
2771 **
2772 ** SRT_EphemTab Create an temporary table pDest->iSDParm and store
2773 ** the result there. The cursor is left open after
2774 ** returning. This is like SRT_Table except that
2775 ** this destination uses OP_OpenEphemeral to create
2776 ** the table first.
2777 **
2778 ** SRT_Coroutine Generate a co-routine that returns a new row of
2779 ** results each time it is invoked. The entry point
2780 ** of the co-routine is stored in register pDest->iSDParm
2781 ** and the result row is stored in pDest->nDest registers
2782 ** starting with pDest->iSdst.
2783 **
2784 ** SRT_Table Store results in temporary table pDest->iSDParm.
2785 ** SRT_Fifo This is like SRT_EphemTab except that the table
2786 ** is assumed to already be open. SRT_Fifo has
2787 ** the additional property of being able to ignore
2788 ** the ORDER BY clause.
2789 **
2790 ** SRT_DistFifo Store results in a temporary table pDest->iSDParm.
2791 ** But also use temporary table pDest->iSDParm+1 as
2792 ** a record of all prior results and ignore any duplicate
2793 ** rows. Name means: "Distinct Fifo".
2794 **
2795 ** SRT_Queue Store results in priority queue pDest->iSDParm (really
2796 ** an index). Append a sequence number so that all entries
2797 ** are distinct.
2798 **
2799 ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if
2800 ** the same record has never been stored before. The
2801 ** index at pDest->iSDParm+1 hold all prior stores.
2802 */
2803 #define SRT_Union 1 /* Store result as keys in an index */
2804 #define SRT_Except 2 /* Remove result from a UNION index */
2805 #define SRT_Exists 3 /* Store 1 if the result is not empty */
2806 #define SRT_Discard 4 /* Do not save the results anywhere */
2807 #define SRT_Fifo 5 /* Store result as data with an automatic rowid */
2808 #define SRT_DistFifo 6 /* Like SRT_Fifo, but unique results only */
2809 #define SRT_Queue 7 /* Store result in an queue */
2810 #define SRT_DistQueue 8 /* Like SRT_Queue, but unique results only */
2811
2812 /* The ORDER BY clause is ignored for all of the above */
2813 #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue)
2814
2815 #define SRT_Output 9 /* Output each row of result */
2816 #define SRT_Mem 10 /* Store result in a memory cell */
2817 #define SRT_Set 11 /* Store results as keys in an index */
2818 #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */
2819 #define SRT_Coroutine 13 /* Generate a single row of result */
2820 #define SRT_Table 14 /* Store result as data with an automatic rowid */
2821
2822 /*
2823 ** An instance of this object describes where to put of the results of
2824 ** a SELECT statement.
2825 */
2826 struct SelectDest {
2827 u8 eDest; /* How to dispose of the results. On of SRT_* above. */
2828 char *zAffSdst; /* Affinity used when eDest==SRT_Set */
2829 int iSDParm; /* A parameter used by the eDest disposal method */
2830 int iSdst; /* Base register where results are written */
2831 int nSdst; /* Number of registers allocated */
2832 ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */
2833 };
2834
2835 /*
2836 ** During code generation of statements that do inserts into AUTOINCREMENT
2837 ** tables, the following information is attached to the Table.u.autoInc.p
2838 ** pointer of each autoincrement table to record some side information that
2839 ** the code generator needs. We have to keep per-table autoincrement
2840 ** information in case inserts are done within triggers. Triggers do not
2841 ** normally coordinate their activities, but we do need to coordinate the
2842 ** loading and saving of autoincrement information.
2843 */
2844 struct AutoincInfo {
2845 AutoincInfo *pNext; /* Next info block in a list of them all */
2846 Table *pTab; /* Table this info block refers to */
2847 int iDb; /* Index in sqlite3.aDb[] of database holding pTab */
2848 int regCtr; /* Memory register holding the rowid counter */
2849 };
2850
2851 /*
2852 ** Size of the column cache
2853 */
2854 #ifndef SQLITE_N_COLCACHE
2855 # define SQLITE_N_COLCACHE 10
2856 #endif
2857
2858 /*
2859 ** At least one instance of the following structure is created for each
2860 ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
2861 ** statement. All such objects are stored in the linked list headed at
2862 ** Parse.pTriggerPrg and deleted once statement compilation has been
2863 ** completed.
2864 **
2865 ** A Vdbe sub-program that implements the body and WHEN clause of trigger
2866 ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
2867 ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
2868 ** The Parse.pTriggerPrg list never contains two entries with the same
2869 ** values for both pTrigger and orconf.
2870 **
2871 ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
2872 ** accessed (or set to 0 for triggers fired as a result of INSERT
2873 ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
2874 ** a mask of new.* columns used by the program.
2875 */
2876 struct TriggerPrg {
2877 Trigger *pTrigger; /* Trigger this program was coded from */
2878 TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */
2879 SubProgram *pProgram; /* Program implementing pTrigger/orconf */
2880 int orconf; /* Default ON CONFLICT policy */
2881 u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */
2882 };
2883
2884 /*
2885 ** The yDbMask datatype for the bitmask of all attached databases.
2886 */
2887 #if SQLITE_MAX_ATTACHED>30
2888 typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
2889 # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0)
2890 # define DbMaskZero(M) memset((M),0,sizeof(M))
2891 # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7))
2892 # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M)
2893 # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0)
2894 #else
2895 typedef unsigned int yDbMask;
2896 # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0)
2897 # define DbMaskZero(M) (M)=0
2898 # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I))
2899 # define DbMaskAllZero(M) (M)==0
2900 # define DbMaskNonZero(M) (M)!=0
2901 #endif
2902
2903 /*
2904 ** An SQL parser context. A copy of this structure is passed through
2905 ** the parser and down into all the parser action routine in order to
2906 ** carry around information that is global to the entire parse.
2907 **
2908 ** The structure is divided into two parts. When the parser and code
2909 ** generate call themselves recursively, the first part of the structure
2910 ** is constant but the second part is reset at the beginning and end of
2911 ** each recursion.
2912 **
2913 ** The nTableLock and aTableLock variables are only used if the shared-cache
2914 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
2915 ** used to store the set of table-locks required by the statement being
2916 ** compiled. Function sqlite3TableLock() is used to add entries to the
2917 ** list.
2918 */
2919 struct Parse {
2920 sqlite3 *db; /* The main database structure */
2921 char *zErrMsg; /* An error message */
2922 Vdbe *pVdbe; /* An engine for executing database bytecode */
2923 int rc; /* Return code from execution */
2924 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
2925 u8 checkSchema; /* Causes schema cookie check after an error */
2926 u8 nested; /* Number of nested calls to the parser/code generator */
2927 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
2928 u8 isMultiWrite; /* True if statement may modify/insert multiple rows */
2929 u8 mayAbort; /* True if statement may throw an ABORT exception */
2930 u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */
2931 u8 okConstFactor; /* OK to factor out constants */
2932 u8 disableLookaside; /* Number of times lookaside has been disabled */
2933 u8 nColCache; /* Number of entries in aColCache[] */
2934 int nRangeReg; /* Size of the temporary register block */
2935 int iRangeReg; /* First register in temporary register block */
2936 int nErr; /* Number of errors seen */
2937 int nTab; /* Number of previously allocated VDBE cursors */
2938 int nMem; /* Number of memory cells used so far */
2939 int nOpAlloc; /* Number of slots allocated for Vdbe.aOp[] */
2940 int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */
2941 int ckBase; /* Base register of data during check constraints */
2942 int iSelfTab; /* Table of an index whose exprs are being coded */
2943 int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
2944 int iCacheCnt; /* Counter used to generate aColCache[].lru values */
2945 int nLabel; /* Number of labels used */
2946 int *aLabel; /* Space to hold the labels */
2947 ExprList *pConstExpr;/* Constant expressions */
2948 Token constraintName;/* Name of the constraint currently being parsed */
2949 yDbMask writeMask; /* Start a write transaction on these databases */
2950 yDbMask cookieMask; /* Bitmask of schema verified databases */
2951 int regRowid; /* Register holding rowid of CREATE TABLE entry */
2952 int regRoot; /* Register holding root page number for new objects */
2953 int nMaxArg; /* Max args passed to user function by sub-program */
2954 #if SELECTTRACE_ENABLED
2955 int nSelect; /* Number of SELECT statements seen */
2956 int nSelectIndent; /* How far to indent SELECTTRACE() output */
2957 #endif
2958 #ifndef SQLITE_OMIT_SHARED_CACHE
2959 int nTableLock; /* Number of locks in aTableLock */
2960 TableLock *aTableLock; /* Required table locks for shared-cache mode */
2961 #endif
2962 AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */
2963 Parse *pToplevel; /* Parse structure for main program (or NULL) */
2964 Table *pTriggerTab; /* Table triggers are being coded for */
2965 int addrCrTab; /* Address of OP_CreateTable opcode on CREATE TABLE */
2966 u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */
2967 u32 oldmask; /* Mask of old.* columns referenced */
2968 u32 newmask; /* Mask of new.* columns referenced */
2969 u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */
2970 u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */
2971 u8 disableTriggers; /* True to disable triggers */
2972
2973 /**************************************************************************
2974 ** Fields above must be initialized to zero. The fields that follow,
2975 ** down to the beginning of the recursive section, do not need to be
2976 ** initialized as they will be set before being used. The boundary is
2977 ** determined by offsetof(Parse,aColCache).
2978 **************************************************************************/
2979
2980 struct yColCache {
2981 int iTable; /* Table cursor number */
2982 i16 iColumn; /* Table column number */
2983 u8 tempReg; /* iReg is a temp register that needs to be freed */
2984 int iLevel; /* Nesting level */
2985 int iReg; /* Reg with value of this column. 0 means none. */
2986 int lru; /* Least recently used entry has the smallest value */
2987 } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */
2988 int aTempReg[8]; /* Holding area for temporary registers */
2989 Token sNameToken; /* Token with unqualified schema object name */
2990
2991 /************************************************************************
2992 ** Above is constant between recursions. Below is reset before and after
2993 ** each recursion. The boundary between these two regions is determined
2994 ** using offsetof(Parse,sLastToken) so the sLastToken field must be the
2995 ** first field in the recursive region.
2996 ************************************************************************/
2997
2998 Token sLastToken; /* The last token parsed */
2999 ynVar nVar; /* Number of '?' variables seen in the SQL so far */
3000 u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */
3001 u8 explain; /* True if the EXPLAIN flag is found on the query */
3002 #ifndef SQLITE_OMIT_VIRTUALTABLE
3003 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
3004 int nVtabLock; /* Number of virtual tables to lock */
3005 #endif
3006 int nHeight; /* Expression tree height of current sub-select */
3007 #ifndef SQLITE_OMIT_EXPLAIN
3008 int iSelectId; /* ID of current select for EXPLAIN output */
3009 int iNextSelectId; /* Next available select ID for EXPLAIN output */
3010 #endif
3011 VList *pVList; /* Mapping between variable names and numbers */
3012 Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */
3013 const char *zTail; /* All SQL text past the last semicolon parsed */
3014 Table *pNewTable; /* A table being constructed by CREATE TABLE */
3015 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
3016 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
3017 #ifndef SQLITE_OMIT_VIRTUALTABLE
3018 Token sArg; /* Complete text of a module argument */
3019 Table **apVtabLock; /* Pointer to virtual tables needing locking */
3020 #endif
3021 Table *pZombieTab; /* List of Table objects to delete after code gen */
3022 TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */
3023 With *pWith; /* Current WITH clause, or NULL */
3024 With *pWithToFree; /* Free this WITH object at the end of the parse */
3025 };
3026
3027 /*
3028 ** Sizes and pointers of various parts of the Parse object.
3029 */
3030 #define PARSE_HDR_SZ offsetof(Parse,aColCache) /* Recursive part w/o aColCache*/
3031 #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken) /* Recursive part */
3032 #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */
3033 #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */
3034
3035 /*
3036 ** Return true if currently inside an sqlite3_declare_vtab() call.
3037 */
3038 #ifdef SQLITE_OMIT_VIRTUALTABLE
3039 #define IN_DECLARE_VTAB 0
3040 #else
3041 #define IN_DECLARE_VTAB (pParse->declareVtab)
3042 #endif
3043
3044 /*
3045 ** An instance of the following structure can be declared on a stack and used
3046 ** to save the Parse.zAuthContext value so that it can be restored later.
3047 */
3048 struct AuthContext {
3049 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
3050 Parse *pParse; /* The Parse structure */
3051 };
3052
3053 /*
3054 ** Bitfield flags for P5 value in various opcodes.
3055 **
3056 ** Value constraints (enforced via assert()):
3057 ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH
3058 ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF
3059 ** OPFLAG_BULKCSR == BTREE_BULKLOAD
3060 ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ
3061 ** OPFLAG_FORDELETE == BTREE_FORDELETE
3062 ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION
3063 ** OPFLAG_AUXDELETE == BTREE_AUXDELETE
3064 */
3065 #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */
3066 /* Also used in P2 (not P5) of OP_Delete */
3067 #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */
3068 #define OPFLAG_LASTROWID 0x20 /* Set to update db->lastRowid */
3069 #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */
3070 #define OPFLAG_APPEND 0x08 /* This is likely to be an append */
3071 #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */
3072 #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */
3073 #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */
3074 #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */
3075 #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */
3076 #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */
3077 #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */
3078 #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */
3079 #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */
3080 #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete/Insert: save cursor pos */
3081 #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */
3082
3083 /*
3084 * Each trigger present in the database schema is stored as an instance of
3085 * struct Trigger.
3086 *
3087 * Pointers to instances of struct Trigger are stored in two ways.
3088 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
3089 * database). This allows Trigger structures to be retrieved by name.
3090 * 2. All triggers associated with a single table form a linked list, using the
3091 * pNext member of struct Trigger. A pointer to the first element of the
3092 * linked list is stored as the "pTrigger" member of the associated
3093 * struct Table.
3094 *
3095 * The "step_list" member points to the first element of a linked list
3096 * containing the SQL statements specified as the trigger program.
3097 */
3098 struct Trigger {
3099 char *zName; /* The name of the trigger */
3100 char *table; /* The table or view to which the trigger applies */
3101 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
3102 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
3103 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
3104 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
3105 the <column-list> is stored here */
3106 Schema *pSchema; /* Schema containing the trigger */
3107 Schema *pTabSchema; /* Schema containing the table */
3108 TriggerStep *step_list; /* Link list of trigger program steps */
3109 Trigger *pNext; /* Next trigger associated with the table */
3110 };
3111
3112 /*
3113 ** A trigger is either a BEFORE or an AFTER trigger. The following constants
3114 ** determine which.
3115 **
3116 ** If there are multiple triggers, you might of some BEFORE and some AFTER.
3117 ** In that cases, the constants below can be ORed together.
3118 */
3119 #define TRIGGER_BEFORE 1
3120 #define TRIGGER_AFTER 2
3121
3122 /*
3123 * An instance of struct TriggerStep is used to store a single SQL statement
3124 * that is a part of a trigger-program.
3125 *
3126 * Instances of struct TriggerStep are stored in a singly linked list (linked
3127 * using the "pNext" member) referenced by the "step_list" member of the
3128 * associated struct Trigger instance. The first element of the linked list is
3129 * the first step of the trigger-program.
3130 *
3131 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
3132 * "SELECT" statement. The meanings of the other members is determined by the
3133 * value of "op" as follows:
3134 *
3135 * (op == TK_INSERT)
3136 * orconf -> stores the ON CONFLICT algorithm
3137 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
3138 * this stores a pointer to the SELECT statement. Otherwise NULL.
3139 * zTarget -> Dequoted name of the table to insert into.
3140 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
3141 * this stores values to be inserted. Otherwise NULL.
3142 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
3143 * statement, then this stores the column-names to be
3144 * inserted into.
3145 *
3146 * (op == TK_DELETE)
3147 * zTarget -> Dequoted name of the table to delete from.
3148 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
3149 * Otherwise NULL.
3150 *
3151 * (op == TK_UPDATE)
3152 * zTarget -> Dequoted name of the table to update.
3153 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
3154 * Otherwise NULL.
3155 * pExprList -> A list of the columns to update and the expressions to update
3156 * them to. See sqlite3Update() documentation of "pChanges"
3157 * argument.
3158 *
3159 */
3160 struct TriggerStep {
3161 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
3162 u8 orconf; /* OE_Rollback etc. */
3163 Trigger *pTrig; /* The trigger that this step is a part of */
3164 Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */
3165 char *zTarget; /* Target table for DELETE, UPDATE, INSERT */
3166 Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */
3167 ExprList *pExprList; /* SET clause for UPDATE. */
3168 IdList *pIdList; /* Column names for INSERT */
3169 TriggerStep *pNext; /* Next in the link-list */
3170 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
3171 };
3172
3173 /*
3174 ** The following structure contains information used by the sqliteFix...
3175 ** routines as they walk the parse tree to make database references
3176 ** explicit.
3177 */
3178 typedef struct DbFixer DbFixer;
3179 struct DbFixer {
3180 Parse *pParse; /* The parsing context. Error messages written here */
3181 Schema *pSchema; /* Fix items to this schema */
3182 int bVarOnly; /* Check for variable references only */
3183 const char *zDb; /* Make sure all objects are contained in this database */
3184 const char *zType; /* Type of the container - used for error messages */
3185 const Token *pName; /* Name of the container - used for error messages */
3186 };
3187
3188 /*
3189 ** An objected used to accumulate the text of a string where we
3190 ** do not necessarily know how big the string will be in the end.
3191 */
3192 struct StrAccum {
3193 sqlite3 *db; /* Optional database for lookaside. Can be NULL */
3194 char *zBase; /* A base allocation. Not from malloc. */
3195 char *zText; /* The string collected so far */
3196 u32 nChar; /* Length of the string so far */
3197 u32 nAlloc; /* Amount of space allocated in zText */
3198 u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */
3199 u8 accError; /* STRACCUM_NOMEM or STRACCUM_TOOBIG */
3200 u8 printfFlags; /* SQLITE_PRINTF flags below */
3201 };
3202 #define STRACCUM_NOMEM 1
3203 #define STRACCUM_TOOBIG 2
3204 #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */
3205 #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */
3206 #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */
3207
3208 #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0)
3209
3210
3211 /*
3212 ** A pointer to this structure is used to communicate information
3213 ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
3214 */
3215 typedef struct {
3216 sqlite3 *db; /* The database being initialized */
3217 char **pzErrMsg; /* Error message stored here */
3218 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
3219 int rc; /* Result code stored here */
3220 } InitData;
3221
3222 /*
3223 ** Structure containing global configuration data for the SQLite library.
3224 **
3225 ** This structure also contains some state information.
3226 */
3227 struct Sqlite3Config {
3228 int bMemstat; /* True to enable memory status */
3229 int bCoreMutex; /* True to enable core mutexing */
3230 int bFullMutex; /* True to enable full mutexing */
3231 int bOpenUri; /* True to interpret filenames as URIs */
3232 int bUseCis; /* Use covering indices for full-scans */
3233 int mxStrlen; /* Maximum string length */
3234 int neverCorrupt; /* Database is always well-formed */
3235 int szLookaside; /* Default lookaside buffer size */
3236 int nLookaside; /* Default lookaside buffer count */
3237 int nStmtSpill; /* Stmt-journal spill-to-disk threshold */
3238 sqlite3_mem_methods m; /* Low-level memory allocation interface */
3239 sqlite3_mutex_methods mutex; /* Low-level mutex interface */
3240 sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */
3241 void *pHeap; /* Heap storage space */
3242 int nHeap; /* Size of pHeap[] */
3243 int mnReq, mxReq; /* Min and max heap requests sizes */
3244 sqlite3_int64 szMmap; /* mmap() space per open file */
3245 sqlite3_int64 mxMmap; /* Maximum value for szMmap */
3246 void *pScratch; /* Scratch memory */
3247 int szScratch; /* Size of each scratch buffer */
3248 int nScratch; /* Number of scratch buffers */
3249 void *pPage; /* Page cache memory */
3250 int szPage; /* Size of each page in pPage[] */
3251 int nPage; /* Number of pages in pPage[] */
3252 int mxParserStack; /* maximum depth of the parser stack */
3253 int sharedCacheEnabled; /* true if shared-cache mode enabled */
3254 u32 szPma; /* Maximum Sorter PMA size */
3255 /* The above might be initialized to non-zero. The following need to always
3256 ** initially be zero, however. */
3257 int isInit; /* True after initialization has finished */
3258 int inProgress; /* True while initialization in progress */
3259 int isMutexInit; /* True after mutexes are initialized */
3260 int isMallocInit; /* True after malloc is initialized */
3261 int isPCacheInit; /* True after malloc is initialized */
3262 int nRefInitMutex; /* Number of users of pInitMutex */
3263 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
3264 void (*xLog)(void*,int,const char*); /* Function for logging */
3265 void *pLogArg; /* First argument to xLog() */
3266 #ifdef SQLITE_ENABLE_SQLLOG
3267 void(*xSqllog)(void*,sqlite3*,const char*, int);
3268 void *pSqllogArg;
3269 #endif
3270 #ifdef SQLITE_VDBE_COVERAGE
3271 /* The following callback (if not NULL) is invoked on every VDBE branch
3272 ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
3273 */
3274 void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx); /* Callback */
3275 void *pVdbeBranchArg; /* 1st argument */
3276 #endif
3277 #ifndef SQLITE_UNTESTABLE
3278 int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */
3279 #endif
3280 int bLocaltimeFault; /* True to fail localtime() calls */
3281 int iOnceResetThreshold; /* When to reset OP_Once counters */
3282 };
3283
3284 /*
3285 ** This macro is used inside of assert() statements to indicate that
3286 ** the assert is only valid on a well-formed database. Instead of:
3287 **
3288 ** assert( X );
3289 **
3290 ** One writes:
3291 **
3292 ** assert( X || CORRUPT_DB );
3293 **
3294 ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate
3295 ** that the database is definitely corrupt, only that it might be corrupt.
3296 ** For most test cases, CORRUPT_DB is set to false using a special
3297 ** sqlite3_test_control(). This enables assert() statements to prove
3298 ** things that are always true for well-formed databases.
3299 */
3300 #define CORRUPT_DB (sqlite3Config.neverCorrupt==0)
3301
3302 /*
3303 ** Context pointer passed down through the tree-walk.
3304 */
3305 struct Walker {
3306 Parse *pParse; /* Parser context. */
3307 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
3308 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
3309 void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
3310 int walkerDepth; /* Number of subqueries */
3311 u8 eCode; /* A small processing code */
3312 union { /* Extra data for callback */
3313 NameContext *pNC; /* Naming context */
3314 int n; /* A counter */
3315 int iCur; /* A cursor number */
3316 SrcList *pSrcList; /* FROM clause */
3317 struct SrcCount *pSrcCount; /* Counting column references */
3318 struct CCurHint *pCCurHint; /* Used by codeCursorHint() */
3319 int *aiCol; /* array of column indexes */
3320 struct IdxCover *pIdxCover; /* Check for index coverage */
3321 } u;
3322 };
3323
3324 /* Forward declarations */
3325 int sqlite3WalkExpr(Walker*, Expr*);
3326 int sqlite3WalkExprList(Walker*, ExprList*);
3327 int sqlite3WalkSelect(Walker*, Select*);
3328 int sqlite3WalkSelectExpr(Walker*, Select*);
3329 int sqlite3WalkSelectFrom(Walker*, Select*);
3330 int sqlite3ExprWalkNoop(Walker*, Expr*);
3331
3332 /*
3333 ** Return code from the parse-tree walking primitives and their
3334 ** callbacks.
3335 */
3336 #define WRC_Continue 0 /* Continue down into children */
3337 #define WRC_Prune 1 /* Omit children but continue walking siblings */
3338 #define WRC_Abort 2 /* Abandon the tree walk */
3339
3340 /*
3341 ** An instance of this structure represents a set of one or more CTEs
3342 ** (common table expressions) created by a single WITH clause.
3343 */
3344 struct With {
3345 int nCte; /* Number of CTEs in the WITH clause */
3346 With *pOuter; /* Containing WITH clause, or NULL */
3347 struct Cte { /* For each CTE in the WITH clause.... */
3348 char *zName; /* Name of this CTE */
3349 ExprList *pCols; /* List of explicit column names, or NULL */
3350 Select *pSelect; /* The definition of this CTE */
3351 const char *zCteErr; /* Error message for circular references */
3352 } a[1];
3353 };
3354
3355 #ifdef SQLITE_DEBUG
3356 /*
3357 ** An instance of the TreeView object is used for printing the content of
3358 ** data structures on sqlite3DebugPrintf() using a tree-like view.
3359 */
3360 struct TreeView {
3361 int iLevel; /* Which level of the tree we are on */
3362 u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */
3363 };
3364 #endif /* SQLITE_DEBUG */
3365
3366 /*
3367 ** Assuming zIn points to the first byte of a UTF-8 character,
3368 ** advance zIn to point to the first byte of the next UTF-8 character.
3369 */
3370 #define SQLITE_SKIP_UTF8(zIn) { \
3371 if( (*(zIn++))>=0xc0 ){ \
3372 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
3373 } \
3374 }
3375
3376 /*
3377 ** The SQLITE_*_BKPT macros are substitutes for the error codes with
3378 ** the same name but without the _BKPT suffix. These macros invoke
3379 ** routines that report the line-number on which the error originated
3380 ** using sqlite3_log(). The routines also provide a convenient place
3381 ** to set a debugger breakpoint.
3382 */
3383 int sqlite3CorruptError(int);
3384 int sqlite3MisuseError(int);
3385 int sqlite3CantopenError(int);
3386 #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
3387 #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
3388 #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
3389 #ifdef SQLITE_DEBUG
3390 int sqlite3NomemError(int);
3391 int sqlite3IoerrnomemError(int);
3392 # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__)
3393 # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__)
3394 #else
3395 # define SQLITE_NOMEM_BKPT SQLITE_NOMEM
3396 # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM
3397 #endif
3398
3399 /*
3400 ** FTS3 and FTS4 both require virtual table support
3401 */
3402 #if defined(SQLITE_OMIT_VIRTUALTABLE)
3403 # undef SQLITE_ENABLE_FTS3
3404 # undef SQLITE_ENABLE_FTS4
3405 #endif
3406
3407 /*
3408 ** FTS4 is really an extension for FTS3. It is enabled using the
3409 ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call
3410 ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
3411 */
3412 #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
3413 # define SQLITE_ENABLE_FTS3 1
3414 #endif
3415
3416 /*
3417 ** The ctype.h header is needed for non-ASCII systems. It is also
3418 ** needed by FTS3 when FTS3 is included in the amalgamation.
3419 */
3420 #if !defined(SQLITE_ASCII) || \
3421 (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
3422 # include <ctype.h>
3423 #endif
3424
3425 /*
3426 ** The following macros mimic the standard library functions toupper(),
3427 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
3428 ** sqlite versions only work for ASCII characters, regardless of locale.
3429 */
3430 #ifdef SQLITE_ASCII
3431 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
3432 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
3433 # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
3434 # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
3435 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
3436 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
3437 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)])
3438 # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80)
3439 #else
3440 # define sqlite3Toupper(x) toupper((unsigned char)(x))
3441 # define sqlite3Isspace(x) isspace((unsigned char)(x))
3442 # define sqlite3Isalnum(x) isalnum((unsigned char)(x))
3443 # define sqlite3Isalpha(x) isalpha((unsigned char)(x))
3444 # define sqlite3Isdigit(x) isdigit((unsigned char)(x))
3445 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x))
3446 # define sqlite3Tolower(x) tolower((unsigned char)(x))
3447 # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`')
3448 #endif
3449 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
3450 int sqlite3IsIdChar(u8);
3451 #endif
3452
3453 /*
3454 ** Internal function prototypes
3455 */
3456 int sqlite3StrICmp(const char*,const char*);
3457 int sqlite3Strlen30(const char*);
3458 char *sqlite3ColumnType(Column*,char*);
3459 #define sqlite3StrNICmp sqlite3_strnicmp
3460
3461 int sqlite3MallocInit(void);
3462 void sqlite3MallocEnd(void);
3463 void *sqlite3Malloc(u64);
3464 void *sqlite3MallocZero(u64);
3465 void *sqlite3DbMallocZero(sqlite3*, u64);
3466 void *sqlite3DbMallocRaw(sqlite3*, u64);
3467 void *sqlite3DbMallocRawNN(sqlite3*, u64);
3468 char *sqlite3DbStrDup(sqlite3*,const char*);
3469 char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
3470 void *sqlite3Realloc(void*, u64);
3471 void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
3472 void *sqlite3DbRealloc(sqlite3 *, void *, u64);
3473 void sqlite3DbFree(sqlite3*, void*);
3474 int sqlite3MallocSize(void*);
3475 int sqlite3DbMallocSize(sqlite3*, void*);
3476 void *sqlite3ScratchMalloc(int);
3477 void sqlite3ScratchFree(void*);
3478 void *sqlite3PageMalloc(int);
3479 void sqlite3PageFree(void*);
3480 void sqlite3MemSetDefault(void);
3481 #ifndef SQLITE_UNTESTABLE
3482 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
3483 #endif
3484 int sqlite3HeapNearlyFull(void);
3485
3486 /*
3487 ** On systems with ample stack space and that support alloca(), make
3488 ** use of alloca() to obtain space for large automatic objects. By default,
3489 ** obtain space from malloc().
3490 **
3491 ** The alloca() routine never returns NULL. This will cause code paths
3492 ** that deal with sqlite3StackAlloc() failures to be unreachable.
3493 */
3494 #ifdef SQLITE_USE_ALLOCA
3495 # define sqlite3StackAllocRaw(D,N) alloca(N)
3496 # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N)
3497 # define sqlite3StackFree(D,P)
3498 #else
3499 # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N)
3500 # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N)
3501 # define sqlite3StackFree(D,P) sqlite3DbFree(D,P)
3502 #endif
3503
3504 /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they
3505 ** are, disable MEMSYS3
3506 */
3507 #ifdef SQLITE_ENABLE_MEMSYS5
3508 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
3509 #undef SQLITE_ENABLE_MEMSYS3
3510 #endif
3511 #ifdef SQLITE_ENABLE_MEMSYS3
3512 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
3513 #endif
3514
3515
3516 #ifndef SQLITE_MUTEX_OMIT
3517 sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
3518 sqlite3_mutex_methods const *sqlite3NoopMutex(void);
3519 sqlite3_mutex *sqlite3MutexAlloc(int);
3520 int sqlite3MutexInit(void);
3521 int sqlite3MutexEnd(void);
3522 #endif
3523 #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP)
3524 void sqlite3MemoryBarrier(void);
3525 #else
3526 # define sqlite3MemoryBarrier()
3527 #endif
3528
3529 sqlite3_int64 sqlite3StatusValue(int);
3530 void sqlite3StatusUp(int, int);
3531 void sqlite3StatusDown(int, int);
3532 void sqlite3StatusHighwater(int, int);
3533
3534 /* Access to mutexes used by sqlite3_status() */
3535 sqlite3_mutex *sqlite3Pcache1Mutex(void);
3536 sqlite3_mutex *sqlite3MallocMutex(void);
3537
3538 #ifndef SQLITE_OMIT_FLOATING_POINT
3539 int sqlite3IsNaN(double);
3540 #else
3541 # define sqlite3IsNaN(X) 0
3542 #endif
3543
3544 /*
3545 ** An instance of the following structure holds information about SQL
3546 ** functions arguments that are the parameters to the printf() function.
3547 */
3548 struct PrintfArguments {
3549 int nArg; /* Total number of arguments */
3550 int nUsed; /* Number of arguments used so far */
3551 sqlite3_value **apArg; /* The argument values */
3552 };
3553
3554 void sqlite3VXPrintf(StrAccum*, const char*, va_list);
3555 void sqlite3XPrintf(StrAccum*, const char*, ...);
3556 char *sqlite3MPrintf(sqlite3*,const char*, ...);
3557 char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
3558 #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
3559 void sqlite3DebugPrintf(const char*, ...);
3560 #endif
3561 #if defined(SQLITE_TEST)
3562 void *sqlite3TestTextToPtr(const char*);
3563 #endif
3564
3565 #if defined(SQLITE_DEBUG)
3566 void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
3567 void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*);
3568 void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
3569 void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
3570 void sqlite3TreeViewWith(TreeView*, const With*, u8);
3571 #endif
3572
3573
3574 void sqlite3SetString(char **, sqlite3*, const char*);
3575 void sqlite3ErrorMsg(Parse*, const char*, ...);
3576 void sqlite3Dequote(char*);
3577 void sqlite3TokenInit(Token*,char*);
3578 int sqlite3KeywordCode(const unsigned char*, int);
3579 int sqlite3RunParser(Parse*, const char*, char **);
3580 void sqlite3FinishCoding(Parse*);
3581 int sqlite3GetTempReg(Parse*);
3582 void sqlite3ReleaseTempReg(Parse*,int);
3583 int sqlite3GetTempRange(Parse*,int);
3584 void sqlite3ReleaseTempRange(Parse*,int,int);
3585 void sqlite3ClearTempRegCache(Parse*);
3586 #ifdef SQLITE_DEBUG
3587 int sqlite3NoTempsInRange(Parse*,int,int);
3588 #endif
3589 Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
3590 Expr *sqlite3Expr(sqlite3*,int,const char*);
3591 void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
3592 Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*);
3593 void sqlite3PExprAddSelect(Parse*, Expr*, Select*);
3594 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
3595 Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
3596 void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32);
3597 void sqlite3ExprDelete(sqlite3*, Expr*);
3598 ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
3599 ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*);
3600 void sqlite3ExprListSetSortOrder(ExprList*,int);
3601 void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
3602 void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*);
3603 void sqlite3ExprListDelete(sqlite3*, ExprList*);
3604 u32 sqlite3ExprListFlags(const ExprList*);
3605 int sqlite3Init(sqlite3*, char**);
3606 int sqlite3InitCallback(void*, int, char**, char**);
3607 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
3608 #ifndef SQLITE_OMIT_VIRTUALTABLE
3609 Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName);
3610 #endif
3611 void sqlite3ResetAllSchemasOfConnection(sqlite3*);
3612 void sqlite3ResetOneSchema(sqlite3*,int);
3613 void sqlite3CollapseDatabaseArray(sqlite3*);
3614 void sqlite3CommitInternalChanges(sqlite3*);
3615 void sqlite3DeleteColumnNames(sqlite3*,Table*);
3616 int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**);
3617 void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*);
3618 Table *sqlite3ResultSetOfSelect(Parse*,Select*);
3619 void sqlite3OpenMasterTable(Parse *, int);
3620 Index *sqlite3PrimaryKeyIndex(Table*);
3621 i16 sqlite3ColumnOfIndex(Index*, i16);
3622 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
3623 #if SQLITE_ENABLE_HIDDEN_COLUMNS
3624 void sqlite3ColumnPropertiesFromName(Table*, Column*);
3625 #else
3626 # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */
3627 #endif
3628 void sqlite3AddColumn(Parse*,Token*,Token*);
3629 void sqlite3AddNotNull(Parse*, int);
3630 void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
3631 void sqlite3AddCheckConstraint(Parse*, Expr*);
3632 void sqlite3AddDefaultValue(Parse*,ExprSpan*);
3633 void sqlite3AddCollateType(Parse*, Token*);
3634 void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*);
3635 int sqlite3ParseUri(const char*,const char*,unsigned int*,
3636 sqlite3_vfs**,char**,char **);
3637 Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
3638
3639 #ifdef SQLITE_UNTESTABLE
3640 # define sqlite3FaultSim(X) SQLITE_OK
3641 #else
3642 int sqlite3FaultSim(int);
3643 #endif
3644
3645 Bitvec *sqlite3BitvecCreate(u32);
3646 int sqlite3BitvecTest(Bitvec*, u32);
3647 int sqlite3BitvecTestNotNull(Bitvec*, u32);
3648 int sqlite3BitvecSet(Bitvec*, u32);
3649 void sqlite3BitvecClear(Bitvec*, u32, void*);
3650 void sqlite3BitvecDestroy(Bitvec*);
3651 u32 sqlite3BitvecSize(Bitvec*);
3652 #ifndef SQLITE_UNTESTABLE
3653 int sqlite3BitvecBuiltinTest(int,int*);
3654 #endif
3655
3656 RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
3657 void sqlite3RowSetClear(RowSet*);
3658 void sqlite3RowSetInsert(RowSet*, i64);
3659 int sqlite3RowSetTest(RowSet*, int iBatch, i64);
3660 int sqlite3RowSetNext(RowSet*, i64*);
3661
3662 void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int);
3663
3664 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
3665 int sqlite3ViewGetColumnNames(Parse*,Table*);
3666 #else
3667 # define sqlite3ViewGetColumnNames(A,B) 0
3668 #endif
3669
3670 #if SQLITE_MAX_ATTACHED>30
3671 int sqlite3DbMaskAllZero(yDbMask);
3672 #endif
3673 void sqlite3DropTable(Parse*, SrcList*, int, int);
3674 void sqlite3CodeDropTable(Parse*, Table*, int, int);
3675 void sqlite3DeleteTable(sqlite3*, Table*);
3676 #ifndef SQLITE_OMIT_AUTOINCREMENT
3677 void sqlite3AutoincrementBegin(Parse *pParse);
3678 void sqlite3AutoincrementEnd(Parse *pParse);
3679 #else
3680 # define sqlite3AutoincrementBegin(X)
3681 # define sqlite3AutoincrementEnd(X)
3682 #endif
3683 void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int);
3684 void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
3685 IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
3686 int sqlite3IdListIndex(IdList*,const char*);
3687 SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
3688 SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
3689 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
3690 Token*, Select*, Expr*, IdList*);
3691 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
3692 void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*);
3693 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
3694 void sqlite3SrcListShiftJoinType(SrcList*);
3695 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
3696 void sqlite3IdListDelete(sqlite3*, IdList*);
3697 void sqlite3SrcListDelete(sqlite3*, SrcList*);
3698 Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
3699 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
3700 Expr*, int, int, u8);
3701 void sqlite3DropIndex(Parse*, SrcList*, int);
3702 int sqlite3Select(Parse*, Select*, SelectDest*);
3703 Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
3704 Expr*,ExprList*,u32,Expr*,Expr*);
3705 void sqlite3SelectDelete(sqlite3*, Select*);
3706 Table *sqlite3SrcListLookup(Parse*, SrcList*);
3707 int sqlite3IsReadOnly(Parse*, Table*, int);
3708 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
3709 #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
3710 Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*);
3711 #endif
3712 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
3713 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
3714 WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
3715 void sqlite3WhereEnd(WhereInfo*);
3716 LogEst sqlite3WhereOutputRowCount(WhereInfo*);
3717 int sqlite3WhereIsDistinct(WhereInfo*);
3718 int sqlite3WhereIsOrdered(WhereInfo*);
3719 int sqlite3WhereOrderedInnerLoop(WhereInfo*);
3720 int sqlite3WhereIsSorted(WhereInfo*);
3721 int sqlite3WhereContinueLabel(WhereInfo*);
3722 int sqlite3WhereBreakLabel(WhereInfo*);
3723 int sqlite3WhereOkOnePass(WhereInfo*, int*);
3724 #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */
3725 #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */
3726 #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */
3727 void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int);
3728 int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
3729 void sqlite3ExprCodeGetColumnToReg(Parse*, Table*, int, int, int);
3730 void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
3731 void sqlite3ExprCodeMove(Parse*, int, int, int);
3732 void sqlite3ExprCacheStore(Parse*, int, int, int);
3733 void sqlite3ExprCachePush(Parse*);
3734 void sqlite3ExprCachePop(Parse*);
3735 void sqlite3ExprCacheRemove(Parse*, int, int);
3736 void sqlite3ExprCacheClear(Parse*);
3737 void sqlite3ExprCacheAffinityChange(Parse*, int, int);
3738 void sqlite3ExprCode(Parse*, Expr*, int);
3739 void sqlite3ExprCodeCopy(Parse*, Expr*, int);
3740 void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
3741 int sqlite3ExprCodeAtInit(Parse*, Expr*, int);
3742 int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
3743 int sqlite3ExprCodeTarget(Parse*, Expr*, int);
3744 void sqlite3ExprCodeAndCache(Parse*, Expr*, int);
3745 int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8);
3746 #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */
3747 #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */
3748 #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */
3749 #define SQLITE_ECEL_OMITREF 0x08 /* Omit if ExprList.u.x.iOrderByCol */
3750 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
3751 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
3752 void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
3753 Table *sqlite3FindTable(sqlite3*,const char*, const char*);
3754 #define LOCATE_VIEW 0x01
3755 #define LOCATE_NOERR 0x02
3756 Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*);
3757 Table *sqlite3LocateTableItem(Parse*,u32 flags,struct SrcList_item *);
3758 Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
3759 void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
3760 void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
3761 void sqlite3Vacuum(Parse*,Token*);
3762 int sqlite3RunVacuum(char**, sqlite3*, int);
3763 char *sqlite3NameFromToken(sqlite3*, Token*);
3764 int sqlite3ExprCompare(Expr*, Expr*, int);
3765 int sqlite3ExprListCompare(ExprList*, ExprList*, int);
3766 int sqlite3ExprImpliesExpr(Expr*, Expr*, int);
3767 void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
3768 void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
3769 int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx);
3770 int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
3771 Vdbe *sqlite3GetVdbe(Parse*);
3772 #ifndef SQLITE_UNTESTABLE
3773 void sqlite3PrngSaveState(void);
3774 void sqlite3PrngRestoreState(void);
3775 #endif
3776 void sqlite3RollbackAll(sqlite3*,int);
3777 void sqlite3CodeVerifySchema(Parse*, int);
3778 void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
3779 void sqlite3BeginTransaction(Parse*, int);
3780 void sqlite3CommitTransaction(Parse*);
3781 void sqlite3RollbackTransaction(Parse*);
3782 void sqlite3Savepoint(Parse*, int, Token*);
3783 void sqlite3CloseSavepoints(sqlite3 *);
3784 void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
3785 int sqlite3ExprIsConstant(Expr*);
3786 int sqlite3ExprIsConstantNotJoin(Expr*);
3787 int sqlite3ExprIsConstantOrFunction(Expr*, u8);
3788 int sqlite3ExprIsTableConstant(Expr*,int);
3789 #ifdef SQLITE_ENABLE_CURSOR_HINTS
3790 int sqlite3ExprContainsSubquery(Expr*);
3791 #endif
3792 int sqlite3ExprIsInteger(Expr*, int*);
3793 int sqlite3ExprCanBeNull(const Expr*);
3794 int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
3795 int sqlite3IsRowid(const char*);
3796 void sqlite3GenerateRowDelete(
3797 Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int);
3798 void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int);
3799 int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
3800 void sqlite3ResolvePartIdxLabel(Parse*,int);
3801 void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
3802 u8,u8,int,int*,int*);
3803 #ifdef SQLITE_ENABLE_NULL_TRIM
3804 void sqlite3SetMakeRecordP5(Vdbe*,Table*);
3805 #else
3806 # define sqlite3SetMakeRecordP5(A,B)
3807 #endif
3808 void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
3809 int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*);
3810 void sqlite3BeginWriteOperation(Parse*, int, int);
3811 void sqlite3MultiWrite(Parse*);
3812 void sqlite3MayAbort(Parse*);
3813 void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
3814 void sqlite3UniqueConstraint(Parse*, int, Index*);
3815 void sqlite3RowidConstraint(Parse*, int, Table*);
3816 Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
3817 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
3818 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
3819 IdList *sqlite3IdListDup(sqlite3*,IdList*);
3820 Select *sqlite3SelectDup(sqlite3*,Select*,int);
3821 #if SELECTTRACE_ENABLED
3822 void sqlite3SelectSetName(Select*,const char*);
3823 #else
3824 # define sqlite3SelectSetName(A,B)
3825 #endif
3826 void sqlite3InsertBuiltinFuncs(FuncDef*,int);
3827 FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8);
3828 void sqlite3RegisterBuiltinFunctions(void);
3829 void sqlite3RegisterDateTimeFunctions(void);
3830 void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*);
3831 int sqlite3SafetyCheckOk(sqlite3*);
3832 int sqlite3SafetyCheckSickOrOk(sqlite3*);
3833 void sqlite3ChangeCookie(Parse*, int);
3834
3835 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
3836 void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
3837 #endif
3838
3839 #ifndef SQLITE_OMIT_TRIGGER
3840 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
3841 Expr*,int, int);
3842 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
3843 void sqlite3DropTrigger(Parse*, SrcList*, int);
3844 void sqlite3DropTriggerPtr(Parse*, Trigger*);
3845 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
3846 Trigger *sqlite3TriggerList(Parse *, Table *);
3847 void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
3848 int, int, int);
3849 void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
3850 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
3851 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
3852 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
3853 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
3854 Select*,u8);
3855 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8);
3856 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
3857 void sqlite3DeleteTrigger(sqlite3*, Trigger*);
3858 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
3859 u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
3860 # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
3861 # define sqlite3IsToplevel(p) ((p)->pToplevel==0)
3862 #else
3863 # define sqlite3TriggersExist(B,C,D,E,F) 0
3864 # define sqlite3DeleteTrigger(A,B)
3865 # define sqlite3DropTriggerPtr(A,B)
3866 # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
3867 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
3868 # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
3869 # define sqlite3TriggerList(X, Y) 0
3870 # define sqlite3ParseToplevel(p) p
3871 # define sqlite3IsToplevel(p) 1
3872 # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
3873 #endif
3874
3875 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
3876 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
3877 void sqlite3DeferForeignKey(Parse*, int);
3878 #ifndef SQLITE_OMIT_AUTHORIZATION
3879 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
3880 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
3881 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
3882 void sqlite3AuthContextPop(AuthContext*);
3883 int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
3884 #else
3885 # define sqlite3AuthRead(a,b,c,d)
3886 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
3887 # define sqlite3AuthContextPush(a,b,c)
3888 # define sqlite3AuthContextPop(a) ((void)(a))
3889 #endif
3890 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
3891 void sqlite3Detach(Parse*, Expr*);
3892 void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
3893 int sqlite3FixSrcList(DbFixer*, SrcList*);
3894 int sqlite3FixSelect(DbFixer*, Select*);
3895 int sqlite3FixExpr(DbFixer*, Expr*);
3896 int sqlite3FixExprList(DbFixer*, ExprList*);
3897 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
3898 int sqlite3AtoF(const char *z, double*, int, u8);
3899 int sqlite3GetInt32(const char *, int*);
3900 int sqlite3Atoi(const char*);
3901 int sqlite3Utf16ByteLen(const void *pData, int nChar);
3902 int sqlite3Utf8CharLen(const char *pData, int nByte);
3903 u32 sqlite3Utf8Read(const u8**);
3904 LogEst sqlite3LogEst(u64);
3905 LogEst sqlite3LogEstAdd(LogEst,LogEst);
3906 #ifndef SQLITE_OMIT_VIRTUALTABLE
3907 LogEst sqlite3LogEstFromDouble(double);
3908 #endif
3909 #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
3910 defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
3911 defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
3912 u64 sqlite3LogEstToInt(LogEst);
3913 #endif
3914 VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int);
3915 const char *sqlite3VListNumToName(VList*,int);
3916 int sqlite3VListNameToNum(VList*,const char*,int);
3917
3918 /*
3919 ** Routines to read and write variable-length integers. These used to
3920 ** be defined locally, but now we use the varint routines in the util.c
3921 ** file.
3922 */
3923 int sqlite3PutVarint(unsigned char*, u64);
3924 u8 sqlite3GetVarint(const unsigned char *, u64 *);
3925 u8 sqlite3GetVarint32(const unsigned char *, u32 *);
3926 int sqlite3VarintLen(u64 v);
3927
3928 /*
3929 ** The common case is for a varint to be a single byte. They following
3930 ** macros handle the common case without a procedure call, but then call
3931 ** the procedure for larger varints.
3932 */
3933 #define getVarint32(A,B) \
3934 (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
3935 #define putVarint32(A,B) \
3936 (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
3937 sqlite3PutVarint((A),(B)))
3938 #define getVarint sqlite3GetVarint
3939 #define putVarint sqlite3PutVarint
3940
3941
3942 const char *sqlite3IndexAffinityStr(sqlite3*, Index*);
3943 void sqlite3TableAffinity(Vdbe*, Table*, int);
3944 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
3945 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
3946 char sqlite3TableColumnAffinity(Table*,int);
3947 char sqlite3ExprAffinity(Expr *pExpr);
3948 int sqlite3Atoi64(const char*, i64*, int, u8);
3949 int sqlite3DecOrHexToI64(const char*, i64*);
3950 void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
3951 void sqlite3Error(sqlite3*,int);
3952 void sqlite3SystemError(sqlite3*,int);
3953 void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
3954 u8 sqlite3HexToInt(int h);
3955 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
3956
3957 #if defined(SQLITE_NEED_ERR_NAME)
3958 const char *sqlite3ErrName(int);
3959 #endif
3960
3961 const char *sqlite3ErrStr(int);
3962 int sqlite3ReadSchema(Parse *pParse);
3963 CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
3964 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
3965 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
3966 Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int);
3967 Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
3968 Expr *sqlite3ExprSkipCollate(Expr*);
3969 int sqlite3CheckCollSeq(Parse *, CollSeq *);
3970 int sqlite3CheckObjectName(Parse *, const char *);
3971 void sqlite3VdbeSetChanges(sqlite3 *, int);
3972 int sqlite3AddInt64(i64*,i64);
3973 int sqlite3SubInt64(i64*,i64);
3974 int sqlite3MulInt64(i64*,i64);
3975 int sqlite3AbsInt32(int);
3976 #ifdef SQLITE_ENABLE_8_3_NAMES
3977 void sqlite3FileSuffix3(const char*, char*);
3978 #else
3979 # define sqlite3FileSuffix3(X,Y)
3980 #endif
3981 u8 sqlite3GetBoolean(const char *z,u8);
3982
3983 const void *sqlite3ValueText(sqlite3_value*, u8);
3984 int sqlite3ValueBytes(sqlite3_value*, u8);
3985 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
3986 void(*)(void*));
3987 void sqlite3ValueSetNull(sqlite3_value*);
3988 void sqlite3ValueFree(sqlite3_value*);
3989 sqlite3_value *sqlite3ValueNew(sqlite3 *);
3990 char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
3991 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
3992 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
3993 #ifndef SQLITE_AMALGAMATION
3994 extern const unsigned char sqlite3OpcodeProperty[];
3995 extern const char sqlite3StrBINARY[];
3996 extern const unsigned char sqlite3UpperToLower[];
3997 extern const unsigned char sqlite3CtypeMap[];
3998 extern const Token sqlite3IntTokens[];
3999 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
4000 extern FuncDefHash sqlite3BuiltinFunctions;
4001 #ifndef SQLITE_OMIT_WSD
4002 extern int sqlite3PendingByte;
4003 #endif
4004 #endif
4005 void sqlite3RootPageMoved(sqlite3*, int, int, int);
4006 void sqlite3Reindex(Parse*, Token*, Token*);
4007 void sqlite3AlterFunctions(void);
4008 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
4009 int sqlite3GetToken(const unsigned char *, int *);
4010 void sqlite3NestedParse(Parse*, const char*, ...);
4011 void sqlite3ExpirePreparedStatements(sqlite3*);
4012 int sqlite3CodeSubselect(Parse*, Expr *, int, int);
4013 void sqlite3SelectPrep(Parse*, Select*, NameContext*);
4014 void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
4015 int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
4016 int sqlite3ResolveExprNames(NameContext*, Expr*);
4017 int sqlite3ResolveExprListNames(NameContext*, ExprList*);
4018 void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
4019 void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
4020 int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
4021 void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
4022 void sqlite3AlterFinishAddColumn(Parse *, Token *);
4023 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
4024 CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
4025 char sqlite3AffinityType(const char*, u8*);
4026 void sqlite3Analyze(Parse*, Token*, Token*);
4027 int sqlite3InvokeBusyHandler(BusyHandler*);
4028 int sqlite3FindDb(sqlite3*, Token*);
4029 int sqlite3FindDbName(sqlite3 *, const char *);
4030 int sqlite3AnalysisLoad(sqlite3*,int iDB);
4031 void sqlite3DeleteIndexSamples(sqlite3*,Index*);
4032 void sqlite3DefaultRowEst(Index*);
4033 void sqlite3RegisterLikeFunctions(sqlite3*, int);
4034 int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
4035 void sqlite3SchemaClear(void *);
4036 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
4037 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
4038 KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
4039 void sqlite3KeyInfoUnref(KeyInfo*);
4040 KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
4041 KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
4042 #ifdef SQLITE_DEBUG
4043 int sqlite3KeyInfoIsWriteable(KeyInfo*);
4044 #endif
4045 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
4046 void (*)(sqlite3_context*,int,sqlite3_value **),
4047 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
4048 FuncDestructor *pDestructor
4049 );
4050 void sqlite3OomFault(sqlite3*);
4051 void sqlite3OomClear(sqlite3*);
4052 int sqlite3ApiExit(sqlite3 *db, int);
4053 int sqlite3OpenTempDatabase(Parse *);
4054
4055 void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
4056 void sqlite3StrAccumAppend(StrAccum*,const char*,int);
4057 void sqlite3StrAccumAppendAll(StrAccum*,const char*);
4058 void sqlite3AppendChar(StrAccum*,int,char);
4059 char *sqlite3StrAccumFinish(StrAccum*);
4060 void sqlite3StrAccumReset(StrAccum*);
4061 void sqlite3SelectDestInit(SelectDest*,int,int);
4062 Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
4063
4064 void sqlite3BackupRestart(sqlite3_backup *);
4065 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
4066
4067 #ifndef SQLITE_OMIT_SUBQUERY
4068 int sqlite3ExprCheckIN(Parse*, Expr*);
4069 #else
4070 # define sqlite3ExprCheckIN(x,y) SQLITE_OK
4071 #endif
4072
4073 #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
4074 void sqlite3AnalyzeFunctions(void);
4075 int sqlite3Stat4ProbeSetValue(
4076 Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*);
4077 int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
4078 void sqlite3Stat4ProbeFree(UnpackedRecord*);
4079 int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
4080 char sqlite3IndexColumnAffinity(sqlite3*, Index*, int);
4081 #endif
4082
4083 /*
4084 ** The interface to the LEMON-generated parser
4085 */
4086 #ifndef SQLITE_AMALGAMATION
4087 void *sqlite3ParserAlloc(void*(*)(u64));
4088 void sqlite3ParserFree(void*, void(*)(void*));
4089 #endif
4090 void sqlite3Parser(void*, int, Token, Parse*);
4091 #ifdef YYTRACKMAXSTACKDEPTH
4092 int sqlite3ParserStackPeak(void*);
4093 #endif
4094
4095 void sqlite3AutoLoadExtensions(sqlite3*);
4096 #ifndef SQLITE_OMIT_LOAD_EXTENSION
4097 void sqlite3CloseExtensions(sqlite3*);
4098 #else
4099 # define sqlite3CloseExtensions(X)
4100 #endif
4101
4102 #ifndef SQLITE_OMIT_SHARED_CACHE
4103 void sqlite3TableLock(Parse *, int, int, u8, const char *);
4104 #else
4105 #define sqlite3TableLock(v,w,x,y,z)
4106 #endif
4107
4108 #ifdef SQLITE_TEST
4109 int sqlite3Utf8To8(unsigned char*);
4110 #endif
4111
4112 #ifdef SQLITE_OMIT_VIRTUALTABLE
4113 # define sqlite3VtabClear(Y)
4114 # define sqlite3VtabSync(X,Y) SQLITE_OK
4115 # define sqlite3VtabRollback(X)
4116 # define sqlite3VtabCommit(X)
4117 # define sqlite3VtabInSync(db) 0
4118 # define sqlite3VtabLock(X)
4119 # define sqlite3VtabUnlock(X)
4120 # define sqlite3VtabUnlockList(X)
4121 # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
4122 # define sqlite3GetVTable(X,Y) ((VTable*)0)
4123 #else
4124 void sqlite3VtabClear(sqlite3 *db, Table*);
4125 void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
4126 int sqlite3VtabSync(sqlite3 *db, Vdbe*);
4127 int sqlite3VtabRollback(sqlite3 *db);
4128 int sqlite3VtabCommit(sqlite3 *db);
4129 void sqlite3VtabLock(VTable *);
4130 void sqlite3VtabUnlock(VTable *);
4131 void sqlite3VtabUnlockList(sqlite3*);
4132 int sqlite3VtabSavepoint(sqlite3 *, int, int);
4133 void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
4134 VTable *sqlite3GetVTable(sqlite3*, Table*);
4135 Module *sqlite3VtabCreateModule(
4136 sqlite3*,
4137 const char*,
4138 const sqlite3_module*,
4139 void*,
4140 void(*)(void*)
4141 );
4142 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
4143 #endif
4144 int sqlite3VtabEponymousTableInit(Parse*,Module*);
4145 void sqlite3VtabEponymousTableClear(sqlite3*,Module*);
4146 void sqlite3VtabMakeWritable(Parse*,Table*);
4147 void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
4148 void sqlite3VtabFinishParse(Parse*, Token*);
4149 void sqlite3VtabArgInit(Parse*);
4150 void sqlite3VtabArgExtend(Parse*, Token*);
4151 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
4152 int sqlite3VtabCallConnect(Parse*, Table*);
4153 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
4154 int sqlite3VtabBegin(sqlite3 *, VTable *);
4155 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
4156 void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
4157 sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
4158 int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
4159 int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
4160 void sqlite3ParserReset(Parse*);
4161 int sqlite3Reprepare(Vdbe*);
4162 void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
4163 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
4164 int sqlite3TempInMemory(const sqlite3*);
4165 const char *sqlite3JournalModename(int);
4166 #ifndef SQLITE_OMIT_WAL
4167 int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
4168 int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
4169 #endif
4170 #ifndef SQLITE_OMIT_CTE
4171 With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*);
4172 void sqlite3WithDelete(sqlite3*,With*);
4173 void sqlite3WithPush(Parse*, With*, u8);
4174 #else
4175 #define sqlite3WithPush(x,y,z)
4176 #define sqlite3WithDelete(x,y)
4177 #endif
4178
4179 /* Declarations for functions in fkey.c. All of these are replaced by
4180 ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
4181 ** key functionality is available. If OMIT_TRIGGER is defined but
4182 ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
4183 ** this case foreign keys are parsed, but no other functionality is
4184 ** provided (enforcement of FK constraints requires the triggers sub-system).
4185 */
4186 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
4187 void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
4188 void sqlite3FkDropTable(Parse*, SrcList *, Table*);
4189 void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
4190 int sqlite3FkRequired(Parse*, Table*, int*, int);
4191 u32 sqlite3FkOldmask(Parse*, Table*);
4192 FKey *sqlite3FkReferences(Table *);
4193 #else
4194 #define sqlite3FkActions(a,b,c,d,e,f)
4195 #define sqlite3FkCheck(a,b,c,d,e,f)
4196 #define sqlite3FkDropTable(a,b,c)
4197 #define sqlite3FkOldmask(a,b) 0
4198 #define sqlite3FkRequired(a,b,c,d) 0
4199 #define sqlite3FkReferences(a) 0
4200 #endif
4201 #ifndef SQLITE_OMIT_FOREIGN_KEY
4202 void sqlite3FkDelete(sqlite3 *, Table*);
4203 int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
4204 #else
4205 #define sqlite3FkDelete(a,b)
4206 #define sqlite3FkLocateIndex(a,b,c,d,e)
4207 #endif
4208
4209
4210 /*
4211 ** Available fault injectors. Should be numbered beginning with 0.
4212 */
4213 #define SQLITE_FAULTINJECTOR_MALLOC 0
4214 #define SQLITE_FAULTINJECTOR_COUNT 1
4215
4216 /*
4217 ** The interface to the code in fault.c used for identifying "benign"
4218 ** malloc failures. This is only present if SQLITE_UNTESTABLE
4219 ** is not defined.
4220 */
4221 #ifndef SQLITE_UNTESTABLE
4222 void sqlite3BeginBenignMalloc(void);
4223 void sqlite3EndBenignMalloc(void);
4224 #else
4225 #define sqlite3BeginBenignMalloc()
4226 #define sqlite3EndBenignMalloc()
4227 #endif
4228
4229 /*
4230 ** Allowed return values from sqlite3FindInIndex()
4231 */
4232 #define IN_INDEX_ROWID 1 /* Search the rowid of the table */
4233 #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */
4234 #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */
4235 #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */
4236 #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */
4237 /*
4238 ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
4239 */
4240 #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */
4241 #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */
4242 #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */
4243 int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*);
4244
4245 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
4246 int sqlite3JournalSize(sqlite3_vfs *);
4247 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
4248 int sqlite3JournalCreate(sqlite3_file *);
4249 #endif
4250
4251 int sqlite3JournalIsInMemory(sqlite3_file *p);
4252 void sqlite3MemJournalOpen(sqlite3_file *);
4253
4254 void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
4255 #if SQLITE_MAX_EXPR_DEPTH>0
4256 int sqlite3SelectExprHeight(Select *);
4257 int sqlite3ExprCheckHeight(Parse*, int);
4258 #else
4259 #define sqlite3SelectExprHeight(x) 0
4260 #define sqlite3ExprCheckHeight(x,y)
4261 #endif
4262
4263 u32 sqlite3Get4byte(const u8*);
4264 void sqlite3Put4byte(u8*, u32);
4265
4266 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
4267 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
4268 void sqlite3ConnectionUnlocked(sqlite3 *db);
4269 void sqlite3ConnectionClosed(sqlite3 *db);
4270 #else
4271 #define sqlite3ConnectionBlocked(x,y)
4272 #define sqlite3ConnectionUnlocked(x)
4273 #define sqlite3ConnectionClosed(x)
4274 #endif
4275
4276 #ifdef SQLITE_DEBUG
4277 void sqlite3ParserTrace(FILE*, char *);
4278 #endif
4279
4280 /*
4281 ** If the SQLITE_ENABLE IOTRACE exists then the global variable
4282 ** sqlite3IoTrace is a pointer to a printf-like routine used to
4283 ** print I/O tracing messages.
4284 */
4285 #ifdef SQLITE_ENABLE_IOTRACE
4286 # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
4287 void sqlite3VdbeIOTraceSql(Vdbe*);
4288 SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
4289 #else
4290 # define IOTRACE(A)
4291 # define sqlite3VdbeIOTraceSql(X)
4292 #endif
4293
4294 /*
4295 ** These routines are available for the mem2.c debugging memory allocator
4296 ** only. They are used to verify that different "types" of memory
4297 ** allocations are properly tracked by the system.
4298 **
4299 ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
4300 ** the MEMTYPE_* macros defined below. The type must be a bitmask with
4301 ** a single bit set.
4302 **
4303 ** sqlite3MemdebugHasType() returns true if any of the bits in its second
4304 ** argument match the type set by the previous sqlite3MemdebugSetType().
4305 ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
4306 **
4307 ** sqlite3MemdebugNoType() returns true if none of the bits in its second
4308 ** argument match the type set by the previous sqlite3MemdebugSetType().
4309 **
4310 ** Perhaps the most important point is the difference between MEMTYPE_HEAP
4311 ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means
4312 ** it might have been allocated by lookaside, except the allocation was
4313 ** too large or lookaside was already full. It is important to verify
4314 ** that allocations that might have been satisfied by lookaside are not
4315 ** passed back to non-lookaside free() routines. Asserts such as the
4316 ** example above are placed on the non-lookaside free() routines to verify
4317 ** this constraint.
4318 **
4319 ** All of this is no-op for a production build. It only comes into
4320 ** play when the SQLITE_MEMDEBUG compile-time option is used.
4321 */
4322 #ifdef SQLITE_MEMDEBUG
4323 void sqlite3MemdebugSetType(void*,u8);
4324 int sqlite3MemdebugHasType(void*,u8);
4325 int sqlite3MemdebugNoType(void*,u8);
4326 #else
4327 # define sqlite3MemdebugSetType(X,Y) /* no-op */
4328 # define sqlite3MemdebugHasType(X,Y) 1
4329 # define sqlite3MemdebugNoType(X,Y) 1
4330 #endif
4331 #define MEMTYPE_HEAP 0x01 /* General heap allocations */
4332 #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */
4333 #define MEMTYPE_SCRATCH 0x04 /* Scratch allocations */
4334 #define MEMTYPE_PCACHE 0x08 /* Page cache allocations */
4335
4336 /*
4337 ** Threading interface
4338 */
4339 #if SQLITE_MAX_WORKER_THREADS>0
4340 int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
4341 int sqlite3ThreadJoin(SQLiteThread*, void**);
4342 #endif
4343
4344 #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
4345 int sqlite3DbstatRegister(sqlite3*);
4346 #endif
4347
4348 int sqlite3ExprVectorSize(Expr *pExpr);
4349 int sqlite3ExprIsVector(Expr *pExpr);
4350 Expr *sqlite3VectorFieldSubexpr(Expr*, int);
4351 Expr *sqlite3ExprForVectorField(Parse*,Expr*,int);
4352 void sqlite3VectorErrorMsg(Parse*, Expr*);
4353
4354 #endif /* SQLITEINT_H */
OLDNEW
« no previous file with comments | « third_party/sqlite/sqlite-src-3170000/src/sqlite3ext.h ('k') | third_party/sqlite/sqlite-src-3170000/src/sqliteLimit.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698