Merge sqlite-release(3.42.0) into prerelease-integration
[sqlcipher.git] / src / sqliteInt.h
blobaeb5e071350220d21b97efc411831d08b4940802
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.
11 *************************************************************************
12 ** Internal interface definitions for SQLite.
15 #ifndef SQLITEINT_H
16 #define SQLITEINT_H
18 /* Special Comments:
20 ** Some comments have special meaning to the tools that measure test
21 ** coverage:
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.
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.
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.
36 ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread
37 ** that would be harmless and undetectable
38 ** if it did occur.
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.
46 ** Make sure the Tcl calling convention macro is defined. This macro is
47 ** only used by test code and Tcl integration code.
49 #ifndef SQLITE_TCLAPI
50 # define SQLITE_TCLAPI
51 #endif
54 ** Include the header file used to customize the compiler options for MSVC.
55 ** This should be done first so that it can successfully prevent spurious
56 ** compiler warnings due to subsequent content in this file and other files
57 ** that are included by this file.
59 #include "msvc.h"
62 ** Special setup for VxWorks
64 #include "vxworks.h"
67 ** These #defines should enable >2GB file support on POSIX if the
68 ** underlying operating system supports it. If the OS lacks
69 ** large file support, or if the OS is windows, these should be no-ops.
71 ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
72 ** system #includes. Hence, this block of code must be the very first
73 ** code in all source files.
75 ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
76 ** on the compiler command line. This is necessary if you are compiling
77 ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
78 ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
79 ** without this option, LFS is enable. But LFS does not exist in the kernel
80 ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
81 ** portability you should omit LFS.
83 ** The previous paragraph was written in 2005. (This paragraph is written
84 ** on 2008-11-28.) These days, all Linux kernels support large files, so
85 ** you should probably leave LFS enabled. But some embedded platforms might
86 ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
88 ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
90 #ifndef SQLITE_DISABLE_LFS
91 # define _LARGE_FILE 1
92 # ifndef _FILE_OFFSET_BITS
93 # define _FILE_OFFSET_BITS 64
94 # endif
95 # define _LARGEFILE_SOURCE 1
96 #endif
98 /* The GCC_VERSION and MSVC_VERSION macros are used to
99 ** conditionally include optimizations for each of these compilers. A
100 ** value of 0 means that compiler is not being used. The
101 ** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific
102 ** optimizations, and hence set all compiler macros to 0
104 ** There was once also a CLANG_VERSION macro. However, we learn that the
105 ** version numbers in clang are for "marketing" only and are inconsistent
106 ** and unreliable. Fortunately, all versions of clang also recognize the
107 ** gcc version numbers and have reasonable settings for gcc version numbers,
108 ** so the GCC_VERSION macro will be set to a correct non-zero value even
109 ** when compiling with clang.
111 #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC)
112 # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
113 #else
114 # define GCC_VERSION 0
115 #endif
116 #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC)
117 # define MSVC_VERSION _MSC_VER
118 #else
119 # define MSVC_VERSION 0
120 #endif
123 ** Some C99 functions in "math.h" are only present for MSVC when its version
124 ** is associated with Visual Studio 2013 or higher.
126 #ifndef SQLITE_HAVE_C99_MATH_FUNCS
127 # if MSVC_VERSION==0 || MSVC_VERSION>=1800
128 # define SQLITE_HAVE_C99_MATH_FUNCS (1)
129 # else
130 # define SQLITE_HAVE_C99_MATH_FUNCS (0)
131 # endif
132 #endif
134 /* Needed for various definitions... */
135 #if defined(__GNUC__) && !defined(_GNU_SOURCE)
136 # define _GNU_SOURCE
137 #endif
139 #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
140 # define _BSD_SOURCE
141 #endif
144 ** Macro to disable warnings about missing "break" at the end of a "case".
146 #if GCC_VERSION>=7000000
147 # define deliberate_fall_through __attribute__((fallthrough));
148 #else
149 # define deliberate_fall_through
150 #endif
153 ** For MinGW, check to see if we can include the header file containing its
154 ** version information, among other things. Normally, this internal MinGW
155 ** header file would [only] be included automatically by other MinGW header
156 ** files; however, the contained version information is now required by this
157 ** header file to work around binary compatibility issues (see below) and
158 ** this is the only known way to reliably obtain it. This entire #if block
159 ** would be completely unnecessary if there was any other way of detecting
160 ** MinGW via their preprocessor (e.g. if they customized their GCC to define
161 ** some MinGW-specific macros). When compiling for MinGW, either the
162 ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
163 ** defined; otherwise, detection of conditions specific to MinGW will be
164 ** disabled.
166 #if defined(_HAVE_MINGW_H)
167 # include "mingw.h"
168 #elif defined(_HAVE__MINGW_H)
169 # include "_mingw.h"
170 #endif
173 ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
174 ** define is required to maintain binary compatibility with the MSVC runtime
175 ** library in use (e.g. for Windows XP).
177 #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
178 defined(_WIN32) && !defined(_WIN64) && \
179 defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
180 defined(__MSVCRT__)
181 # define _USE_32BIT_TIME_T
182 #endif
184 /* Optionally #include a user-defined header, whereby compilation options
185 ** may be set prior to where they take effect, but after platform setup.
186 ** If SQLITE_CUSTOM_INCLUDE=? is defined, its value names the #include
187 ** file.
189 #ifdef SQLITE_CUSTOM_INCLUDE
190 # define INC_STRINGIFY_(f) #f
191 # define INC_STRINGIFY(f) INC_STRINGIFY_(f)
192 # include INC_STRINGIFY(SQLITE_CUSTOM_INCLUDE)
193 #endif
195 /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear
196 ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for
197 ** MinGW.
199 #include "sqlite3.h"
202 ** Reuse the STATIC_LRU for mutex access to sqlite3_temp_directory.
204 #define SQLITE_MUTEX_STATIC_TEMPDIR SQLITE_MUTEX_STATIC_VFS1
207 ** Include the configuration header output by 'configure' if we're using the
208 ** autoconf-based build
210 #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H)
211 #include "sqlite_cfg.h"
212 #define SQLITECONFIG_H 1
213 #endif
215 #include "sqliteLimit.h"
217 /* Disable nuisance warnings on Borland compilers */
218 #if defined(__BORLANDC__)
219 #pragma warn -rch /* unreachable code */
220 #pragma warn -ccc /* Condition is always true or false */
221 #pragma warn -aus /* Assigned value is never used */
222 #pragma warn -csu /* Comparing signed and unsigned */
223 #pragma warn -spa /* Suspicious pointer arithmetic */
224 #endif
227 ** A few places in the code require atomic load/store of aligned
228 ** integer values.
230 #ifndef __has_extension
231 # define __has_extension(x) 0 /* compatibility with non-clang compilers */
232 #endif
233 #if GCC_VERSION>=4007000 || __has_extension(c_atomic)
234 # define SQLITE_ATOMIC_INTRINSICS 1
235 # define AtomicLoad(PTR) __atomic_load_n((PTR),__ATOMIC_RELAXED)
236 # define AtomicStore(PTR,VAL) __atomic_store_n((PTR),(VAL),__ATOMIC_RELAXED)
237 #else
238 # define SQLITE_ATOMIC_INTRINSICS 0
239 # define AtomicLoad(PTR) (*(PTR))
240 # define AtomicStore(PTR,VAL) (*(PTR) = (VAL))
241 #endif
244 ** Include standard header files as necessary
246 #ifdef HAVE_STDINT_H
247 #include <stdint.h>
248 #endif
249 #ifdef HAVE_INTTYPES_H
250 #include <inttypes.h>
251 #endif
254 ** The following macros are used to cast pointers to integers and
255 ** integers to pointers. The way you do this varies from one compiler
256 ** to the next, so we have developed the following set of #if statements
257 ** to generate appropriate macros for a wide range of compilers.
259 ** The correct "ANSI" way to do this is to use the intptr_t type.
260 ** Unfortunately, that typedef is not available on all compilers, or
261 ** if it is available, it requires an #include of specific headers
262 ** that vary from one machine to the next.
264 ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on
265 ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)).
266 ** So we have to define the macros in different ways depending on the
267 ** compiler.
269 #if defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */
270 # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X))
271 # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X))
272 #elif defined(__PTRDIFF_TYPE__) /* This case should work for GCC */
273 # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X))
274 # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X))
275 #elif !defined(__GNUC__) /* Works for compilers other than LLVM */
276 # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
277 # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
278 #else /* Generates a warning - but it always works */
279 # define SQLITE_INT_TO_PTR(X) ((void*)(X))
280 # define SQLITE_PTR_TO_INT(X) ((int)(X))
281 #endif
284 ** Macros to hint to the compiler that a function should or should not be
285 ** inlined.
287 #if defined(__GNUC__)
288 # define SQLITE_NOINLINE __attribute__((noinline))
289 # define SQLITE_INLINE __attribute__((always_inline)) inline
290 #elif defined(_MSC_VER) && _MSC_VER>=1310
291 # define SQLITE_NOINLINE __declspec(noinline)
292 # define SQLITE_INLINE __forceinline
293 #else
294 # define SQLITE_NOINLINE
295 # define SQLITE_INLINE
296 #endif
297 #if defined(SQLITE_COVERAGE_TEST) || defined(__STRICT_ANSI__)
298 # undef SQLITE_INLINE
299 # define SQLITE_INLINE
300 #endif
303 ** Make sure that the compiler intrinsics we desire are enabled when
304 ** compiling with an appropriate version of MSVC unless prevented by
305 ** the SQLITE_DISABLE_INTRINSIC define.
307 #if !defined(SQLITE_DISABLE_INTRINSIC)
308 # if defined(_MSC_VER) && _MSC_VER>=1400
309 # if !defined(_WIN32_WCE)
310 # include <intrin.h>
311 # pragma intrinsic(_byteswap_ushort)
312 # pragma intrinsic(_byteswap_ulong)
313 # pragma intrinsic(_byteswap_uint64)
314 # pragma intrinsic(_ReadWriteBarrier)
315 # else
316 # include <cmnintrin.h>
317 # endif
318 # endif
319 #endif
322 ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
323 ** 0 means mutexes are permanently disable and the library is never
324 ** threadsafe. 1 means the library is serialized which is the highest
325 ** level of threadsafety. 2 means the library is multithreaded - multiple
326 ** threads can use SQLite as long as no two threads try to use the same
327 ** database connection at the same time.
329 ** Older versions of SQLite used an optional THREADSAFE macro.
330 ** We support that for legacy.
332 ** To ensure that the correct value of "THREADSAFE" is reported when querying
333 ** for compile-time options at runtime (e.g. "PRAGMA compile_options"), this
334 ** logic is partially replicated in ctime.c. If it is updated here, it should
335 ** also be updated there.
337 #if !defined(SQLITE_THREADSAFE)
338 # if defined(THREADSAFE)
339 # define SQLITE_THREADSAFE THREADSAFE
340 # else
341 # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
342 # endif
343 #endif
346 ** Powersafe overwrite is on by default. But can be turned off using
347 ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
349 #ifndef SQLITE_POWERSAFE_OVERWRITE
350 # define SQLITE_POWERSAFE_OVERWRITE 1
351 #endif
354 ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
355 ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
356 ** which case memory allocation statistics are disabled by default.
358 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
359 # define SQLITE_DEFAULT_MEMSTATUS 1
360 #endif
363 ** Exactly one of the following macros must be defined in order to
364 ** specify which memory allocation subsystem to use.
366 ** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
367 ** SQLITE_WIN32_MALLOC // Use Win32 native heap API
368 ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails
369 ** SQLITE_MEMDEBUG // Debugging version of system malloc()
371 ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
372 ** assert() macro is enabled, each call into the Win32 native heap subsystem
373 ** will cause HeapValidate to be called. If heap validation should fail, an
374 ** assertion will be triggered.
376 ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
377 ** the default.
379 #if defined(SQLITE_SYSTEM_MALLOC) \
380 + defined(SQLITE_WIN32_MALLOC) \
381 + defined(SQLITE_ZERO_MALLOC) \
382 + defined(SQLITE_MEMDEBUG)>1
383 # error "Two or more of the following compile-time configuration options\
384 are defined but at most one is allowed:\
385 SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
386 SQLITE_ZERO_MALLOC"
387 #endif
388 #if defined(SQLITE_SYSTEM_MALLOC) \
389 + defined(SQLITE_WIN32_MALLOC) \
390 + defined(SQLITE_ZERO_MALLOC) \
391 + defined(SQLITE_MEMDEBUG)==0
392 # define SQLITE_SYSTEM_MALLOC 1
393 #endif
396 ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
397 ** sizes of memory allocations below this value where possible.
399 #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
400 # define SQLITE_MALLOC_SOFT_LIMIT 1024
401 #endif
404 ** We need to define _XOPEN_SOURCE as follows in order to enable
405 ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
406 ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
407 ** it.
409 #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
410 # define _XOPEN_SOURCE 600
411 #endif
414 ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that
415 ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true,
416 ** make it true by defining or undefining NDEBUG.
418 ** Setting NDEBUG makes the code smaller and faster by disabling the
419 ** assert() statements in the code. So we want the default action
420 ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
421 ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out
422 ** feature.
424 #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
425 # define NDEBUG 1
426 #endif
427 #if defined(NDEBUG) && defined(SQLITE_DEBUG)
428 # undef NDEBUG
429 #endif
432 ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
434 #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
435 # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
436 #endif
439 ** The testcase() macro is used to aid in coverage testing. When
440 ** doing coverage testing, the condition inside the argument to
441 ** testcase() must be evaluated both true and false in order to
442 ** get full branch coverage. The testcase() macro is inserted
443 ** to help ensure adequate test coverage in places where simple
444 ** condition/decision coverage is inadequate. For example, testcase()
445 ** can be used to make sure boundary values are tested. For
446 ** bitmask tests, testcase() can be used to make sure each bit
447 ** is significant and used at least once. On switch statements
448 ** where multiple cases go to the same block of code, testcase()
449 ** can insure that all cases are evaluated.
451 #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_DEBUG)
452 # ifndef SQLITE_AMALGAMATION
453 extern unsigned int sqlite3CoverageCounter;
454 # endif
455 # define testcase(X) if( X ){ sqlite3CoverageCounter += (unsigned)__LINE__; }
456 #else
457 # define testcase(X)
458 #endif
461 ** The TESTONLY macro is used to enclose variable declarations or
462 ** other bits of code that are needed to support the arguments
463 ** within testcase() and assert() macros.
465 #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
466 # define TESTONLY(X) X
467 #else
468 # define TESTONLY(X)
469 #endif
472 ** Sometimes we need a small amount of code such as a variable initialization
473 ** to setup for a later assert() statement. We do not want this code to
474 ** appear when assert() is disabled. The following macro is therefore
475 ** used to contain that setup code. The "VVA" acronym stands for
476 ** "Verification, Validation, and Accreditation". In other words, the
477 ** code within VVA_ONLY() will only run during verification processes.
479 #ifndef NDEBUG
480 # define VVA_ONLY(X) X
481 #else
482 # define VVA_ONLY(X)
483 #endif
486 ** Disable ALWAYS() and NEVER() (make them pass-throughs) for coverage
487 ** and mutation testing
489 #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST)
490 # define SQLITE_OMIT_AUXILIARY_SAFETY_CHECKS 1
491 #endif
494 ** The ALWAYS and NEVER macros surround boolean expressions which
495 ** are intended to always be true or false, respectively. Such
496 ** expressions could be omitted from the code completely. But they
497 ** are included in a few cases in order to enhance the resilience
498 ** of SQLite to unexpected behavior - to make the code "self-healing"
499 ** or "ductile" rather than being "brittle" and crashing at the first
500 ** hint of unplanned behavior.
502 ** In other words, ALWAYS and NEVER are added for defensive code.
504 ** When doing coverage testing ALWAYS and NEVER are hard-coded to
505 ** be true and false so that the unreachable code they specify will
506 ** not be counted as untested code.
508 #if defined(SQLITE_OMIT_AUXILIARY_SAFETY_CHECKS)
509 # define ALWAYS(X) (1)
510 # define NEVER(X) (0)
511 #elif !defined(NDEBUG)
512 # define ALWAYS(X) ((X)?1:(assert(0),0))
513 # define NEVER(X) ((X)?(assert(0),1):0)
514 #else
515 # define ALWAYS(X) (X)
516 # define NEVER(X) (X)
517 #endif
520 ** Some conditionals are optimizations only. In other words, if the
521 ** conditionals are replaced with a constant 1 (true) or 0 (false) then
522 ** the correct answer is still obtained, though perhaps not as quickly.
524 ** The following macros mark these optimizations conditionals.
526 #if defined(SQLITE_MUTATION_TEST)
527 # define OK_IF_ALWAYS_TRUE(X) (1)
528 # define OK_IF_ALWAYS_FALSE(X) (0)
529 #else
530 # define OK_IF_ALWAYS_TRUE(X) (X)
531 # define OK_IF_ALWAYS_FALSE(X) (X)
532 #endif
535 ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is
536 ** defined. We need to defend against those failures when testing with
537 ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches
538 ** during a normal build. The following macro can be used to disable tests
539 ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set.
541 #if defined(SQLITE_TEST_REALLOC_STRESS)
542 # define ONLY_IF_REALLOC_STRESS(X) (X)
543 #elif !defined(NDEBUG)
544 # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0)
545 #else
546 # define ONLY_IF_REALLOC_STRESS(X) (0)
547 #endif
550 ** Declarations used for tracing the operating system interfaces.
552 #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
553 (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
554 extern int sqlite3OSTrace;
555 # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X
556 # define SQLITE_HAVE_OS_TRACE
557 #else
558 # define OSTRACE(X)
559 # undef SQLITE_HAVE_OS_TRACE
560 #endif
563 ** Is the sqlite3ErrName() function needed in the build? Currently,
564 ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
565 ** OSTRACE is enabled), and by several "test*.c" files (which are
566 ** compiled using SQLITE_TEST).
568 #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
569 (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
570 # define SQLITE_NEED_ERR_NAME
571 #else
572 # undef SQLITE_NEED_ERR_NAME
573 #endif
576 ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN
578 #ifdef SQLITE_OMIT_EXPLAIN
579 # undef SQLITE_ENABLE_EXPLAIN_COMMENTS
580 #endif
583 ** SQLITE_OMIT_VIRTUALTABLE implies SQLITE_OMIT_ALTERTABLE
585 #if defined(SQLITE_OMIT_VIRTUALTABLE) && !defined(SQLITE_OMIT_ALTERTABLE)
586 # define SQLITE_OMIT_ALTERTABLE
587 #endif
590 ** Return true (non-zero) if the input is an integer that is too large
591 ** to fit in 32-bits. This macro is used inside of various testcase()
592 ** macros to verify that we have tested SQLite for large-file support.
594 #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0)
597 ** The macro unlikely() is a hint that surrounds a boolean
598 ** expression that is usually false. Macro likely() surrounds
599 ** a boolean expression that is usually true. These hints could,
600 ** in theory, be used by the compiler to generate better code, but
601 ** currently they are just comments for human readers.
603 #define likely(X) (X)
604 #define unlikely(X) (X)
606 #include "hash.h"
607 #include "parse.h"
608 #include <stdio.h>
609 #include <stdlib.h>
610 #include <string.h>
611 #include <assert.h>
612 #include <stddef.h>
615 ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY.
616 ** This allows better measurements of where memcpy() is used when running
617 ** cachegrind. But this macro version of memcpy() is very slow so it
618 ** should not be used in production. This is a performance measurement
619 ** hack only.
621 #ifdef SQLITE_INLINE_MEMCPY
622 # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\
623 int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);}
624 #endif
627 ** If compiling for a processor that lacks floating point support,
628 ** substitute integer for floating-point
630 #ifdef SQLITE_OMIT_FLOATING_POINT
631 # define double sqlite_int64
632 # define float sqlite_int64
633 # define LONGDOUBLE_TYPE sqlite_int64
634 # ifndef SQLITE_BIG_DBL
635 # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
636 # endif
637 # define SQLITE_OMIT_DATETIME_FUNCS 1
638 # define SQLITE_OMIT_TRACE 1
639 # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
640 # undef SQLITE_HAVE_ISNAN
641 #endif
642 #ifndef SQLITE_BIG_DBL
643 # define SQLITE_BIG_DBL (1e99)
644 #endif
647 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
648 ** afterward. Having this macro allows us to cause the C compiler
649 ** to omit code used by TEMP tables without messy #ifndef statements.
651 #ifdef SQLITE_OMIT_TEMPDB
652 #define OMIT_TEMPDB 1
653 #else
654 #define OMIT_TEMPDB 0
655 #endif
658 ** The "file format" number is an integer that is incremented whenever
659 ** the VDBE-level file format changes. The following macros define the
660 ** the default file format for new databases and the maximum file format
661 ** that the library can read.
663 #define SQLITE_MAX_FILE_FORMAT 4
664 #ifndef SQLITE_DEFAULT_FILE_FORMAT
665 # define SQLITE_DEFAULT_FILE_FORMAT 4
666 #endif
669 ** Determine whether triggers are recursive by default. This can be
670 ** changed at run-time using a pragma.
672 #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
673 # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
674 #endif
677 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
678 ** on the command-line
680 #ifndef SQLITE_TEMP_STORE
681 # define SQLITE_TEMP_STORE 1
682 #endif
685 ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
686 ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
687 ** to zero.
689 #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
690 # undef SQLITE_MAX_WORKER_THREADS
691 # define SQLITE_MAX_WORKER_THREADS 0
692 #endif
693 #ifndef SQLITE_MAX_WORKER_THREADS
694 # define SQLITE_MAX_WORKER_THREADS 8
695 #endif
696 #ifndef SQLITE_DEFAULT_WORKER_THREADS
697 # define SQLITE_DEFAULT_WORKER_THREADS 0
698 #endif
699 #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
700 # undef SQLITE_MAX_WORKER_THREADS
701 # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
702 #endif
705 ** The default initial allocation for the pagecache when using separate
706 ** pagecaches for each database connection. A positive number is the
707 ** number of pages. A negative number N translations means that a buffer
708 ** of -1024*N bytes is allocated and used for as many pages as it will hold.
710 ** The default value of "20" was chosen to minimize the run-time of the
711 ** speedtest1 test program with options: --shrink-memory --reprepare
713 #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
714 # define SQLITE_DEFAULT_PCACHE_INITSZ 20
715 #endif
718 ** Default value for the SQLITE_CONFIG_SORTERREF_SIZE option.
720 #ifndef SQLITE_DEFAULT_SORTERREF_SIZE
721 # define SQLITE_DEFAULT_SORTERREF_SIZE 0x7fffffff
722 #endif
725 ** The compile-time options SQLITE_MMAP_READWRITE and
726 ** SQLITE_ENABLE_BATCH_ATOMIC_WRITE are not compatible with one another.
727 ** You must choose one or the other (or neither) but not both.
729 #if defined(SQLITE_MMAP_READWRITE) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
730 #error Cannot use both SQLITE_MMAP_READWRITE and SQLITE_ENABLE_BATCH_ATOMIC_WRITE
731 #endif
734 ** GCC does not define the offsetof() macro so we'll have to do it
735 ** ourselves.
737 #ifndef offsetof
738 #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
739 #endif
742 ** Macros to compute minimum and maximum of two numbers.
744 #ifndef MIN
745 # define MIN(A,B) ((A)<(B)?(A):(B))
746 #endif
747 #ifndef MAX
748 # define MAX(A,B) ((A)>(B)?(A):(B))
749 #endif
752 ** Swap two objects of type TYPE.
754 #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
757 ** Check to see if this machine uses EBCDIC. (Yes, believe it or
758 ** not, there are still machines out there that use EBCDIC.)
760 #if 'A' == '\301'
761 # define SQLITE_EBCDIC 1
762 #else
763 # define SQLITE_ASCII 1
764 #endif
767 ** Integers of known sizes. These typedefs might change for architectures
768 ** where the sizes very. Preprocessor macros are available so that the
769 ** types can be conveniently redefined at compile-type. Like this:
771 ** cc '-DUINTPTR_TYPE=long long int' ...
773 #ifndef UINT32_TYPE
774 # ifdef HAVE_UINT32_T
775 # define UINT32_TYPE uint32_t
776 # else
777 # define UINT32_TYPE unsigned int
778 # endif
779 #endif
780 #ifndef UINT16_TYPE
781 # ifdef HAVE_UINT16_T
782 # define UINT16_TYPE uint16_t
783 # else
784 # define UINT16_TYPE unsigned short int
785 # endif
786 #endif
787 #ifndef INT16_TYPE
788 # ifdef HAVE_INT16_T
789 # define INT16_TYPE int16_t
790 # else
791 # define INT16_TYPE short int
792 # endif
793 #endif
794 #ifndef UINT8_TYPE
795 # ifdef HAVE_UINT8_T
796 # define UINT8_TYPE uint8_t
797 # else
798 # define UINT8_TYPE unsigned char
799 # endif
800 #endif
801 #ifndef INT8_TYPE
802 # ifdef HAVE_INT8_T
803 # define INT8_TYPE int8_t
804 # else
805 # define INT8_TYPE signed char
806 # endif
807 #endif
808 #ifndef LONGDOUBLE_TYPE
809 # define LONGDOUBLE_TYPE long double
810 #endif
811 typedef sqlite_int64 i64; /* 8-byte signed integer */
812 typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
813 typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
814 typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
815 typedef INT16_TYPE i16; /* 2-byte signed integer */
816 typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
817 typedef INT8_TYPE i8; /* 1-byte signed integer */
820 ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
821 ** that can be stored in a u32 without loss of data. The value
822 ** is 0x00000000ffffffff. But because of quirks of some compilers, we
823 ** have to specify the value in the less intuitive manner shown:
825 #define SQLITE_MAX_U32 ((((u64)1)<<32)-1)
828 ** The datatype used to store estimates of the number of rows in a
829 ** table or index.
831 typedef u64 tRowcnt;
834 ** Estimated quantities used for query planning are stored as 16-bit
835 ** logarithms. For quantity X, the value stored is 10*log2(X). This
836 ** gives a possible range of values of approximately 1.0e986 to 1e-986.
837 ** But the allowed values are "grainy". Not every value is representable.
838 ** For example, quantities 16 and 17 are both represented by a LogEst
839 ** of 40. However, since LogEst quantities are suppose to be estimates,
840 ** not exact values, this imprecision is not a problem.
842 ** "LogEst" is short for "Logarithmic Estimate".
844 ** Examples:
845 ** 1 -> 0 20 -> 43 10000 -> 132
846 ** 2 -> 10 25 -> 46 25000 -> 146
847 ** 3 -> 16 100 -> 66 1000000 -> 199
848 ** 4 -> 20 1000 -> 99 1048576 -> 200
849 ** 10 -> 33 1024 -> 100 4294967296 -> 320
851 ** The LogEst can be negative to indicate fractional values.
852 ** Examples:
854 ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40
856 typedef INT16_TYPE LogEst;
859 ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
861 #ifndef SQLITE_PTRSIZE
862 # if defined(__SIZEOF_POINTER__)
863 # define SQLITE_PTRSIZE __SIZEOF_POINTER__
864 # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \
865 defined(_M_ARM) || defined(__arm__) || defined(__x86) || \
866 (defined(__APPLE__) && defined(__POWERPC__)) || \
867 (defined(__TOS_AIX__) && !defined(__64BIT__))
868 # define SQLITE_PTRSIZE 4
869 # else
870 # define SQLITE_PTRSIZE 8
871 # endif
872 #endif
874 /* The uptr type is an unsigned integer large enough to hold a pointer
876 #if defined(HAVE_STDINT_H)
877 typedef uintptr_t uptr;
878 #elif SQLITE_PTRSIZE==4
879 typedef u32 uptr;
880 #else
881 typedef u64 uptr;
882 #endif
885 ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to
886 ** something between S (inclusive) and E (exclusive).
888 ** In other words, S is a buffer and E is a pointer to the first byte after
889 ** the end of buffer S. This macro returns true if P points to something
890 ** contained within the buffer S.
892 #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E)))
896 ** Macros to determine whether the machine is big or little endian,
897 ** and whether or not that determination is run-time or compile-time.
899 ** For best performance, an attempt is made to guess at the byte-order
900 ** using C-preprocessor macros. If that is unsuccessful, or if
901 ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined
902 ** at run-time.
904 #ifndef SQLITE_BYTEORDER
905 # if defined(i386) || defined(__i386__) || defined(_M_IX86) || \
906 defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \
907 defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \
908 defined(__ARMEL__) || defined(__AARCH64EL__) || defined(_M_ARM64)
909 # define SQLITE_BYTEORDER 1234
910 # elif defined(sparc) || defined(__ppc__) || \
911 defined(__ARMEB__) || defined(__AARCH64EB__)
912 # define SQLITE_BYTEORDER 4321
913 # else
914 # define SQLITE_BYTEORDER 0
915 # endif
916 #endif
917 #if SQLITE_BYTEORDER==4321
918 # define SQLITE_BIGENDIAN 1
919 # define SQLITE_LITTLEENDIAN 0
920 # define SQLITE_UTF16NATIVE SQLITE_UTF16BE
921 #elif SQLITE_BYTEORDER==1234
922 # define SQLITE_BIGENDIAN 0
923 # define SQLITE_LITTLEENDIAN 1
924 # define SQLITE_UTF16NATIVE SQLITE_UTF16LE
925 #else
926 # ifdef SQLITE_AMALGAMATION
927 const int sqlite3one = 1;
928 # else
929 extern const int sqlite3one;
930 # endif
931 # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
932 # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
933 # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
934 #endif
937 ** Constants for the largest and smallest possible 64-bit signed integers.
938 ** These macros are designed to work correctly on both 32-bit and 64-bit
939 ** compilers.
941 #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
942 #define LARGEST_UINT64 (0xffffffff|(((u64)0xffffffff)<<32))
943 #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
946 ** Round up a number to the next larger multiple of 8. This is used
947 ** to force 8-byte alignment on 64-bit architectures.
949 ** ROUND8() always does the rounding, for any argument.
951 ** ROUND8P() assumes that the argument is already an integer number of
952 ** pointers in size, and so it is a no-op on systems where the pointer
953 ** size is 8.
955 #define ROUND8(x) (((x)+7)&~7)
956 #if SQLITE_PTRSIZE==8
957 # define ROUND8P(x) (x)
958 #else
959 # define ROUND8P(x) (((x)+7)&~7)
960 #endif
963 ** Round down to the nearest multiple of 8
965 #define ROUNDDOWN8(x) ((x)&~7)
968 ** Assert that the pointer X is aligned to an 8-byte boundary. This
969 ** macro is used only within assert() to verify that the code gets
970 ** all alignment restrictions correct.
972 ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
973 ** underlying malloc() implementation might return us 4-byte aligned
974 ** pointers. In that case, only verify 4-byte alignment.
976 #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
977 # define EIGHT_BYTE_ALIGNMENT(X) ((((uptr)(X) - (uptr)0)&3)==0)
978 #else
979 # define EIGHT_BYTE_ALIGNMENT(X) ((((uptr)(X) - (uptr)0)&7)==0)
980 #endif
983 ** Disable MMAP on platforms where it is known to not work
985 #if defined(__OpenBSD__) || defined(__QNXNTO__)
986 # undef SQLITE_MAX_MMAP_SIZE
987 # define SQLITE_MAX_MMAP_SIZE 0
988 #endif
991 ** Default maximum size of memory used by memory-mapped I/O in the VFS
993 #ifdef __APPLE__
994 # include <TargetConditionals.h>
995 #endif
996 #ifndef SQLITE_MAX_MMAP_SIZE
997 # if defined(__linux__) \
998 || defined(_WIN32) \
999 || (defined(__APPLE__) && defined(__MACH__)) \
1000 || defined(__sun) \
1001 || defined(__FreeBSD__) \
1002 || defined(__DragonFly__)
1003 # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */
1004 # else
1005 # define SQLITE_MAX_MMAP_SIZE 0
1006 # endif
1007 #endif
1010 ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger
1011 ** default MMAP_SIZE is specified at compile-time, make sure that it does
1012 ** not exceed the maximum mmap size.
1014 #ifndef SQLITE_DEFAULT_MMAP_SIZE
1015 # define SQLITE_DEFAULT_MMAP_SIZE 0
1016 #endif
1017 #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
1018 # undef SQLITE_DEFAULT_MMAP_SIZE
1019 # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
1020 #endif
1023 ** TREETRACE_ENABLED will be either 1 or 0 depending on whether or not
1024 ** the Abstract Syntax Tree tracing logic is turned on.
1026 #if !defined(SQLITE_AMALGAMATION)
1027 extern u32 sqlite3TreeTrace;
1028 #endif
1029 #if defined(SQLITE_DEBUG) \
1030 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_SELECTTRACE) \
1031 || defined(SQLITE_ENABLE_TREETRACE))
1032 # define TREETRACE_ENABLED 1
1033 # define TREETRACE(K,P,S,X) \
1034 if(sqlite3TreeTrace&(K)) \
1035 sqlite3DebugPrintf("%u/%d/%p: ",(S)->selId,(P)->addrExplain,(S)),\
1036 sqlite3DebugPrintf X
1037 #else
1038 # define TREETRACE(K,P,S,X)
1039 # define TREETRACE_ENABLED 0
1040 #endif
1042 /* TREETRACE flag meanings:
1044 ** 0x00000001 Beginning and end of SELECT processing
1045 ** 0x00000002 WHERE clause processing
1046 ** 0x00000004 Query flattener
1047 ** 0x00000008 Result-set wildcard expansion
1048 ** 0x00000010 Query name resolution
1049 ** 0x00000020 Aggregate analysis
1050 ** 0x00000040 Window functions
1051 ** 0x00000080 Generated column names
1052 ** 0x00000100 Move HAVING terms into WHERE
1053 ** 0x00000200 Count-of-view optimization
1054 ** 0x00000400 Compound SELECT processing
1055 ** 0x00000800 Drop superfluous ORDER BY
1056 ** 0x00001000 LEFT JOIN simplifies to JOIN
1057 ** 0x00002000 Constant propagation
1058 ** 0x00004000 Push-down optimization
1059 ** 0x00008000 After all FROM-clause analysis
1060 ** 0x00010000 Beginning of DELETE/INSERT/UPDATE processing
1061 ** 0x00020000 Transform DISTINCT into GROUP BY
1062 ** 0x00040000 SELECT tree dump after all code has been generated
1066 ** Macros for "wheretrace"
1068 extern u32 sqlite3WhereTrace;
1069 #if defined(SQLITE_DEBUG) \
1070 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
1071 # define WHERETRACE(K,X) if(sqlite3WhereTrace&(K)) sqlite3DebugPrintf X
1072 # define WHERETRACE_ENABLED 1
1073 #else
1074 # define WHERETRACE(K,X)
1075 #endif
1078 ** Bits for the sqlite3WhereTrace mask:
1080 ** (---any--) Top-level block structure
1081 ** 0x-------F High-level debug messages
1082 ** 0x----FFF- More detail
1083 ** 0xFFFF---- Low-level debug messages
1085 ** 0x00000001 Code generation
1086 ** 0x00000002 Solver
1087 ** 0x00000004 Solver costs
1088 ** 0x00000008 WhereLoop inserts
1090 ** 0x00000010 Display sqlite3_index_info xBestIndex calls
1091 ** 0x00000020 Range an equality scan metrics
1092 ** 0x00000040 IN operator decisions
1093 ** 0x00000080 WhereLoop cost adjustements
1094 ** 0x00000100
1095 ** 0x00000200 Covering index decisions
1096 ** 0x00000400 OR optimization
1097 ** 0x00000800 Index scanner
1098 ** 0x00001000 More details associated with code generation
1099 ** 0x00002000
1100 ** 0x00004000 Show all WHERE terms at key points
1101 ** 0x00008000 Show the full SELECT statement at key places
1103 ** 0x00010000 Show more detail when printing WHERE terms
1104 ** 0x00020000 Show WHERE terms returned from whereScanNext()
1109 ** An instance of the following structure is used to store the busy-handler
1110 ** callback for a given sqlite handle.
1112 ** The sqlite.busyHandler member of the sqlite struct contains the busy
1113 ** callback for the database handle. Each pager opened via the sqlite
1114 ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
1115 ** callback is currently invoked only from within pager.c.
1117 typedef struct BusyHandler BusyHandler;
1118 struct BusyHandler {
1119 int (*xBusyHandler)(void *,int); /* The busy callback */
1120 void *pBusyArg; /* First arg to busy callback */
1121 int nBusy; /* Incremented with each busy call */
1125 ** Name of table that holds the database schema.
1127 ** The PREFERRED names are used whereever possible. But LEGACY is also
1128 ** used for backwards compatibility.
1130 ** 1. Queries can use either the PREFERRED or the LEGACY names
1131 ** 2. The sqlite3_set_authorizer() callback uses the LEGACY name
1132 ** 3. The PRAGMA table_list statement uses the PREFERRED name
1134 ** The LEGACY names are stored in the internal symbol hash table
1135 ** in support of (2). Names are translated using sqlite3PreferredTableName()
1136 ** for (3). The sqlite3FindTable() function takes care of translating
1137 ** names for (1).
1139 ** Note that "sqlite_temp_schema" can also be called "temp.sqlite_schema".
1141 #define LEGACY_SCHEMA_TABLE "sqlite_master"
1142 #define LEGACY_TEMP_SCHEMA_TABLE "sqlite_temp_master"
1143 #define PREFERRED_SCHEMA_TABLE "sqlite_schema"
1144 #define PREFERRED_TEMP_SCHEMA_TABLE "sqlite_temp_schema"
1148 ** The root-page of the schema table.
1150 #define SCHEMA_ROOT 1
1153 ** The name of the schema table. The name is different for TEMP.
1155 #define SCHEMA_TABLE(x) \
1156 ((!OMIT_TEMPDB)&&(x==1)?LEGACY_TEMP_SCHEMA_TABLE:LEGACY_SCHEMA_TABLE)
1159 ** A convenience macro that returns the number of elements in
1160 ** an array.
1162 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
1165 ** Determine if the argument is a power of two
1167 #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
1170 ** The following value as a destructor means to use sqlite3DbFree().
1171 ** The sqlite3DbFree() routine requires two parameters instead of the
1172 ** one parameter that destructors normally want. So we have to introduce
1173 ** this magic value that the code knows to handle differently. Any
1174 ** pointer will work here as long as it is distinct from SQLITE_STATIC
1175 ** and SQLITE_TRANSIENT.
1177 #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3OomClear)
1180 ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
1181 ** not support Writable Static Data (WSD) such as global and static variables.
1182 ** All variables must either be on the stack or dynamically allocated from
1183 ** the heap. When WSD is unsupported, the variable declarations scattered
1184 ** throughout the SQLite code must become constants instead. The SQLITE_WSD
1185 ** macro is used for this purpose. And instead of referencing the variable
1186 ** directly, we use its constant as a key to lookup the run-time allocated
1187 ** buffer that holds real variable. The constant is also the initializer
1188 ** for the run-time allocated buffer.
1190 ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
1191 ** macros become no-ops and have zero performance impact.
1193 #ifdef SQLITE_OMIT_WSD
1194 #define SQLITE_WSD const
1195 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
1196 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
1197 int sqlite3_wsd_init(int N, int J);
1198 void *sqlite3_wsd_find(void *K, int L);
1199 #else
1200 #define SQLITE_WSD
1201 #define GLOBAL(t,v) v
1202 #define sqlite3GlobalConfig sqlite3Config
1203 #endif
1206 ** The following macros are used to suppress compiler warnings and to
1207 ** make it clear to human readers when a function parameter is deliberately
1208 ** left unused within the body of a function. This usually happens when
1209 ** a function is called via a function pointer. For example the
1210 ** implementation of an SQL aggregate step callback may not use the
1211 ** parameter indicating the number of arguments passed to the aggregate,
1212 ** if it knows that this is enforced elsewhere.
1214 ** When a function parameter is not used at all within the body of a function,
1215 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
1216 ** However, these macros may also be used to suppress warnings related to
1217 ** parameters that may or may not be used depending on compilation options.
1218 ** For example those parameters only used in assert() statements. In these
1219 ** cases the parameters are named as per the usual conventions.
1221 #define UNUSED_PARAMETER(x) (void)(x)
1222 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
1225 ** Forward references to structures
1227 typedef struct AggInfo AggInfo;
1228 typedef struct AuthContext AuthContext;
1229 typedef struct AutoincInfo AutoincInfo;
1230 typedef struct Bitvec Bitvec;
1231 typedef struct CollSeq CollSeq;
1232 typedef struct Column Column;
1233 typedef struct Cte Cte;
1234 typedef struct CteUse CteUse;
1235 typedef struct Db Db;
1236 typedef struct DbFixer DbFixer;
1237 typedef struct Schema Schema;
1238 typedef struct Expr Expr;
1239 typedef struct ExprList ExprList;
1240 typedef struct FKey FKey;
1241 typedef struct FuncDestructor FuncDestructor;
1242 typedef struct FuncDef FuncDef;
1243 typedef struct FuncDefHash FuncDefHash;
1244 typedef struct IdList IdList;
1245 typedef struct Index Index;
1246 typedef struct IndexedExpr IndexedExpr;
1247 typedef struct IndexSample IndexSample;
1248 typedef struct KeyClass KeyClass;
1249 typedef struct KeyInfo KeyInfo;
1250 typedef struct Lookaside Lookaside;
1251 typedef struct LookasideSlot LookasideSlot;
1252 typedef struct Module Module;
1253 typedef struct NameContext NameContext;
1254 typedef struct OnOrUsing OnOrUsing;
1255 typedef struct Parse Parse;
1256 typedef struct ParseCleanup ParseCleanup;
1257 typedef struct PreUpdate PreUpdate;
1258 typedef struct PrintfArguments PrintfArguments;
1259 typedef struct RenameToken RenameToken;
1260 typedef struct Returning Returning;
1261 typedef struct RowSet RowSet;
1262 typedef struct Savepoint Savepoint;
1263 typedef struct Select Select;
1264 typedef struct SQLiteThread SQLiteThread;
1265 typedef struct SelectDest SelectDest;
1266 typedef struct SrcItem SrcItem;
1267 typedef struct SrcList SrcList;
1268 typedef struct sqlite3_str StrAccum; /* Internal alias for sqlite3_str */
1269 typedef struct Table Table;
1270 typedef struct TableLock TableLock;
1271 typedef struct Token Token;
1272 typedef struct TreeView TreeView;
1273 typedef struct Trigger Trigger;
1274 typedef struct TriggerPrg TriggerPrg;
1275 typedef struct TriggerStep TriggerStep;
1276 typedef struct UnpackedRecord UnpackedRecord;
1277 typedef struct Upsert Upsert;
1278 typedef struct VTable VTable;
1279 typedef struct VtabCtx VtabCtx;
1280 typedef struct Walker Walker;
1281 typedef struct WhereInfo WhereInfo;
1282 typedef struct Window Window;
1283 typedef struct With With;
1287 ** The bitmask datatype defined below is used for various optimizations.
1289 ** Changing this from a 64-bit to a 32-bit type limits the number of
1290 ** tables in a join to 32 instead of 64. But it also reduces the size
1291 ** of the library by 738 bytes on ix86.
1293 #ifdef SQLITE_BITMASK_TYPE
1294 typedef SQLITE_BITMASK_TYPE Bitmask;
1295 #else
1296 typedef u64 Bitmask;
1297 #endif
1300 ** The number of bits in a Bitmask. "BMS" means "BitMask Size".
1302 #define BMS ((int)(sizeof(Bitmask)*8))
1305 ** A bit in a Bitmask
1307 #define MASKBIT(n) (((Bitmask)1)<<(n))
1308 #define MASKBIT64(n) (((u64)1)<<(n))
1309 #define MASKBIT32(n) (((unsigned int)1)<<(n))
1310 #define SMASKBIT32(n) ((n)<=31?((unsigned int)1)<<(n):0)
1311 #define ALLBITS ((Bitmask)-1)
1312 #define TOPBIT (((Bitmask)1)<<(BMS-1))
1314 /* A VList object records a mapping between parameters/variables/wildcards
1315 ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer
1316 ** variable number associated with that parameter. See the format description
1317 ** on the sqlite3VListAdd() routine for more information. A VList is really
1318 ** just an array of integers.
1320 typedef int VList;
1323 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
1324 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
1325 ** pointer types (i.e. FuncDef) defined above.
1327 #include "os.h"
1328 #include "pager.h"
1329 #include "btree.h"
1330 #include "vdbe.h"
1331 #include "pcache.h"
1332 #include "mutex.h"
1334 /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default
1335 ** synchronous setting to EXTRA. It is no longer supported.
1337 #ifdef SQLITE_EXTRA_DURABLE
1338 # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE
1339 # define SQLITE_DEFAULT_SYNCHRONOUS 3
1340 #endif
1343 ** Default synchronous levels.
1345 ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ
1346 ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1.
1348 ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS
1349 ** OFF 1 0
1350 ** NORMAL 2 1
1351 ** FULL 3 2
1352 ** EXTRA 4 3
1354 ** The "PRAGMA synchronous" statement also uses the zero-based numbers.
1355 ** In other words, the zero-based numbers are used for all external interfaces
1356 ** and the one-based values are used internally.
1358 #ifndef SQLITE_DEFAULT_SYNCHRONOUS
1359 # define SQLITE_DEFAULT_SYNCHRONOUS 2
1360 #endif
1361 #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS
1362 # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS
1363 #endif
1366 ** Each database file to be accessed by the system is an instance
1367 ** of the following structure. There are normally two of these structures
1368 ** in the sqlite.aDb[] array. aDb[0] is the main database file and
1369 ** aDb[1] is the database file used to hold temporary tables. Additional
1370 ** databases may be attached.
1372 struct Db {
1373 char *zDbSName; /* Name of this database. (schema name, not filename) */
1374 Btree *pBt; /* The B*Tree structure for this database file */
1375 u8 safety_level; /* How aggressive at syncing data to disk */
1376 u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */
1377 Schema *pSchema; /* Pointer to database schema (possibly shared) */
1381 ** An instance of the following structure stores a database schema.
1383 ** Most Schema objects are associated with a Btree. The exception is
1384 ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
1385 ** In shared cache mode, a single Schema object can be shared by multiple
1386 ** Btrees that refer to the same underlying BtShared object.
1388 ** Schema objects are automatically deallocated when the last Btree that
1389 ** references them is destroyed. The TEMP Schema is manually freed by
1390 ** sqlite3_close().
1392 ** A thread must be holding a mutex on the corresponding Btree in order
1393 ** to access Schema content. This implies that the thread must also be
1394 ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
1395 ** For a TEMP Schema, only the connection mutex is required.
1397 struct Schema {
1398 int schema_cookie; /* Database schema version number for this file */
1399 int iGeneration; /* Generation counter. Incremented with each change */
1400 Hash tblHash; /* All tables indexed by name */
1401 Hash idxHash; /* All (named) indices indexed by name */
1402 Hash trigHash; /* All triggers indexed by name */
1403 Hash fkeyHash; /* All foreign keys by referenced table name */
1404 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
1405 u8 file_format; /* Schema format version for this file */
1406 u8 enc; /* Text encoding used by this database */
1407 u16 schemaFlags; /* Flags associated with this schema */
1408 int cache_size; /* Number of pages to use in the cache */
1412 ** These macros can be used to test, set, or clear bits in the
1413 ** Db.pSchema->flags field.
1415 #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
1416 #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
1417 #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P)
1418 #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P)
1421 ** Allowed values for the DB.pSchema->flags field.
1423 ** The DB_SchemaLoaded flag is set after the database schema has been
1424 ** read into internal hash tables.
1426 ** DB_UnresetViews means that one or more views have column names that
1427 ** have been filled out. If the schema changes, these column names might
1428 ** changes and so the view will need to be reset.
1430 #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
1431 #define DB_UnresetViews 0x0002 /* Some views have defined column names */
1432 #define DB_ResetWanted 0x0008 /* Reset the schema when nSchemaLock==0 */
1435 ** The number of different kinds of things that can be limited
1436 ** using the sqlite3_limit() interface.
1438 #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
1441 ** Lookaside malloc is a set of fixed-size buffers that can be used
1442 ** to satisfy small transient memory allocation requests for objects
1443 ** associated with a particular database connection. The use of
1444 ** lookaside malloc provides a significant performance enhancement
1445 ** (approx 10%) by avoiding numerous malloc/free requests while parsing
1446 ** SQL statements.
1448 ** The Lookaside structure holds configuration information about the
1449 ** lookaside malloc subsystem. Each available memory allocation in
1450 ** the lookaside subsystem is stored on a linked list of LookasideSlot
1451 ** objects.
1453 ** Lookaside allocations are only allowed for objects that are associated
1454 ** with a particular database connection. Hence, schema information cannot
1455 ** be stored in lookaside because in shared cache mode the schema information
1456 ** is shared by multiple database connections. Therefore, while parsing
1457 ** schema information, the Lookaside.bEnabled flag is cleared so that
1458 ** lookaside allocations are not used to construct the schema objects.
1460 ** New lookaside allocations are only allowed if bDisable==0. When
1461 ** bDisable is greater than zero, sz is set to zero which effectively
1462 ** disables lookaside without adding a new test for the bDisable flag
1463 ** in a performance-critical path. sz should be set by to szTrue whenever
1464 ** bDisable changes back to zero.
1466 ** Lookaside buffers are initially held on the pInit list. As they are
1467 ** used and freed, they are added back to the pFree list. New allocations
1468 ** come off of pFree first, then pInit as a fallback. This dual-list
1469 ** allows use to compute a high-water mark - the maximum number of allocations
1470 ** outstanding at any point in the past - by subtracting the number of
1471 ** allocations on the pInit list from the total number of allocations.
1473 ** Enhancement on 2019-12-12: Two-size-lookaside
1474 ** The default lookaside configuration is 100 slots of 1200 bytes each.
1475 ** The larger slot sizes are important for performance, but they waste
1476 ** a lot of space, as most lookaside allocations are less than 128 bytes.
1477 ** The two-size-lookaside enhancement breaks up the lookaside allocation
1478 ** into two pools: One of 128-byte slots and the other of the default size
1479 ** (1200-byte) slots. Allocations are filled from the small-pool first,
1480 ** failing over to the full-size pool if that does not work. Thus more
1481 ** lookaside slots are available while also using less memory.
1482 ** This enhancement can be omitted by compiling with
1483 ** SQLITE_OMIT_TWOSIZE_LOOKASIDE.
1485 struct Lookaside {
1486 u32 bDisable; /* Only operate the lookaside when zero */
1487 u16 sz; /* Size of each buffer in bytes */
1488 u16 szTrue; /* True value of sz, even if disabled */
1489 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
1490 u32 nSlot; /* Number of lookaside slots allocated */
1491 u32 anStat[3]; /* 0: hits. 1: size misses. 2: full misses */
1492 LookasideSlot *pInit; /* List of buffers not previously used */
1493 LookasideSlot *pFree; /* List of available buffers */
1494 #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
1495 LookasideSlot *pSmallInit; /* List of small buffers not prediously used */
1496 LookasideSlot *pSmallFree; /* List of available small buffers */
1497 void *pMiddle; /* First byte past end of full-size buffers and
1498 ** the first byte of LOOKASIDE_SMALL buffers */
1499 #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
1500 void *pStart; /* First byte of available memory space */
1501 void *pEnd; /* First byte past end of available space */
1502 void *pTrueEnd; /* True value of pEnd, when db->pnBytesFreed!=0 */
1504 struct LookasideSlot {
1505 LookasideSlot *pNext; /* Next buffer in the list of free buffers */
1508 #define DisableLookaside db->lookaside.bDisable++;db->lookaside.sz=0
1509 #define EnableLookaside db->lookaside.bDisable--;\
1510 db->lookaside.sz=db->lookaside.bDisable?0:db->lookaside.szTrue
1512 /* Size of the smaller allocations in two-size lookside */
1513 #ifdef SQLITE_OMIT_TWOSIZE_LOOKASIDE
1514 # define LOOKASIDE_SMALL 0
1515 #else
1516 # define LOOKASIDE_SMALL 128
1517 #endif
1520 ** A hash table for built-in function definitions. (Application-defined
1521 ** functions use a regular table table from hash.h.)
1523 ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
1524 ** Collisions are on the FuncDef.u.pHash chain. Use the SQLITE_FUNC_HASH()
1525 ** macro to compute a hash on the function name.
1527 #define SQLITE_FUNC_HASH_SZ 23
1528 struct FuncDefHash {
1529 FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */
1531 #define SQLITE_FUNC_HASH(C,L) (((C)+(L))%SQLITE_FUNC_HASH_SZ)
1533 #ifdef SQLITE_USER_AUTHENTICATION
1535 ** Information held in the "sqlite3" database connection object and used
1536 ** to manage user authentication.
1538 typedef struct sqlite3_userauth sqlite3_userauth;
1539 struct sqlite3_userauth {
1540 u8 authLevel; /* Current authentication level */
1541 int nAuthPW; /* Size of the zAuthPW in bytes */
1542 char *zAuthPW; /* Password used to authenticate */
1543 char *zAuthUser; /* User name used to authenticate */
1546 /* Allowed values for sqlite3_userauth.authLevel */
1547 #define UAUTH_Unknown 0 /* Authentication not yet checked */
1548 #define UAUTH_Fail 1 /* User authentication failed */
1549 #define UAUTH_User 2 /* Authenticated as a normal user */
1550 #define UAUTH_Admin 3 /* Authenticated as an administrator */
1552 /* Functions used only by user authorization logic */
1553 int sqlite3UserAuthTable(const char*);
1554 int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
1555 void sqlite3UserAuthInit(sqlite3*);
1556 void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
1558 #endif /* SQLITE_USER_AUTHENTICATION */
1561 ** typedef for the authorization callback function.
1563 #ifdef SQLITE_USER_AUTHENTICATION
1564 typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
1565 const char*, const char*);
1566 #else
1567 typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
1568 const char*);
1569 #endif
1571 #ifndef SQLITE_OMIT_DEPRECATED
1572 /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing
1573 ** in the style of sqlite3_trace()
1575 #define SQLITE_TRACE_LEGACY 0x40 /* Use the legacy xTrace */
1576 #define SQLITE_TRACE_XPROFILE 0x80 /* Use the legacy xProfile */
1577 #else
1578 #define SQLITE_TRACE_LEGACY 0
1579 #define SQLITE_TRACE_XPROFILE 0
1580 #endif /* SQLITE_OMIT_DEPRECATED */
1581 #define SQLITE_TRACE_NONLEGACY_MASK 0x0f /* Normal flags */
1584 ** Maximum number of sqlite3.aDb[] entries. This is the number of attached
1585 ** databases plus 2 for "main" and "temp".
1587 #define SQLITE_MAX_DB (SQLITE_MAX_ATTACHED+2)
1590 ** Each database connection is an instance of the following structure.
1592 struct sqlite3 {
1593 sqlite3_vfs *pVfs; /* OS Interface */
1594 struct Vdbe *pVdbe; /* List of active virtual machines */
1595 CollSeq *pDfltColl; /* BINARY collseq for the database encoding */
1596 sqlite3_mutex *mutex; /* Connection mutex */
1597 Db *aDb; /* All backends */
1598 int nDb; /* Number of backends currently in use */
1599 u32 mDbFlags; /* flags recording internal state */
1600 u64 flags; /* flags settable by pragmas. See below */
1601 i64 lastRowid; /* ROWID of most recent insert (see above) */
1602 i64 szMmap; /* Default mmap_size setting */
1603 u32 nSchemaLock; /* Do not reset the schema when non-zero */
1604 unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
1605 int errCode; /* Most recent error code (SQLITE_*) */
1606 int errByteOffset; /* Byte offset of error in SQL statement */
1607 int errMask; /* & result codes with this before returning */
1608 int iSysErrno; /* Errno value from last system error */
1609 u32 dbOptFlags; /* Flags to enable/disable optimizations */
1610 u8 enc; /* Text encoding */
1611 u8 autoCommit; /* The auto-commit flag. */
1612 u8 temp_store; /* 1: file 2: memory 0: default */
1613 u8 mallocFailed; /* True if we have seen a malloc failure */
1614 u8 bBenignMalloc; /* Do not require OOMs if true */
1615 u8 dfltLockMode; /* Default locking-mode for attached dbs */
1616 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
1617 u8 suppressErr; /* Do not issue error messages if true */
1618 u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */
1619 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
1620 u8 mTrace; /* zero or more SQLITE_TRACE flags */
1621 u8 noSharedCache; /* True if no shared-cache backends */
1622 u8 nSqlExec; /* Number of pending OP_SqlExec opcodes */
1623 u8 eOpenState; /* Current condition of the connection */
1624 int nextPagesize; /* Pagesize after VACUUM if >0 */
1625 i64 nChange; /* Value returned by sqlite3_changes() */
1626 i64 nTotalChange; /* Value returned by sqlite3_total_changes() */
1627 int aLimit[SQLITE_N_LIMIT]; /* Limits */
1628 int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */
1629 struct sqlite3InitInfo { /* Information used during initialization */
1630 Pgno newTnum; /* Rootpage of table being initialized */
1631 u8 iDb; /* Which db file is being initialized */
1632 u8 busy; /* TRUE if currently initializing */
1633 unsigned orphanTrigger : 1; /* Last statement is orphaned TEMP trigger */
1634 unsigned imposterTable : 1; /* Building an imposter table */
1635 unsigned reopenMemdb : 1; /* ATTACH is really a reopen using MemDB */
1636 const char **azInit; /* "type", "name", and "tbl_name" columns */
1637 } init;
1638 int nVdbeActive; /* Number of VDBEs currently running */
1639 int nVdbeRead; /* Number of active VDBEs that read or write */
1640 int nVdbeWrite; /* Number of active VDBEs that read and write */
1641 int nVdbeExec; /* Number of nested calls to VdbeExec() */
1642 int nVDestroy; /* Number of active OP_VDestroy operations */
1643 int nExtension; /* Number of loaded extensions */
1644 void **aExtension; /* Array of shared library handles */
1645 union {
1646 void (*xLegacy)(void*,const char*); /* mTrace==SQLITE_TRACE_LEGACY */
1647 int (*xV2)(u32,void*,void*,void*); /* All other mTrace values */
1648 } trace;
1649 void *pTraceArg; /* Argument to the trace function */
1650 #ifndef SQLITE_OMIT_DEPRECATED
1651 void (*xProfile)(void*,const char*,u64); /* Profiling function */
1652 void *pProfileArg; /* Argument to profile function */
1653 #endif
1654 void *pCommitArg; /* Argument to xCommitCallback() */
1655 int (*xCommitCallback)(void*); /* Invoked at every commit. */
1656 void *pRollbackArg; /* Argument to xRollbackCallback() */
1657 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
1658 void *pUpdateArg;
1659 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
1660 void *pAutovacPagesArg; /* Client argument to autovac_pages */
1661 void (*xAutovacDestr)(void*); /* Destructor for pAutovacPAgesArg */
1662 unsigned int (*xAutovacPages)(void*,const char*,u32,u32,u32);
1663 Parse *pParse; /* Current parse */
1664 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1665 void *pPreUpdateArg; /* First argument to xPreUpdateCallback */
1666 void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */
1667 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64
1669 PreUpdate *pPreUpdate; /* Context for active pre-update callback */
1670 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
1671 #ifndef SQLITE_OMIT_WAL
1672 int (*xWalCallback)(void *, sqlite3 *, const char *, int);
1673 void *pWalArg;
1674 #endif
1675 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
1676 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
1677 void *pCollNeededArg;
1678 sqlite3_value *pErr; /* Most recent error message */
1679 union {
1680 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
1681 double notUsed1; /* Spacer */
1682 } u1;
1683 Lookaside lookaside; /* Lookaside malloc configuration */
1684 #ifndef SQLITE_OMIT_AUTHORIZATION
1685 sqlite3_xauth xAuth; /* Access authorization function */
1686 void *pAuthArg; /* 1st argument to the access auth function */
1687 #endif
1688 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1689 int (*xProgress)(void *); /* The progress callback */
1690 void *pProgressArg; /* Argument to the progress callback */
1691 unsigned nProgressOps; /* Number of opcodes for progress callback */
1692 #endif
1693 #ifndef SQLITE_OMIT_VIRTUALTABLE
1694 int nVTrans; /* Allocated size of aVTrans */
1695 Hash aModule; /* populated by sqlite3_create_module() */
1696 VtabCtx *pVtabCtx; /* Context for active vtab connect/create */
1697 VTable **aVTrans; /* Virtual tables with open transactions */
1698 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */
1699 #endif
1700 Hash aFunc; /* Hash table of connection functions */
1701 Hash aCollSeq; /* All collating sequences */
1702 BusyHandler busyHandler; /* Busy callback */
1703 Db aDbStatic[2]; /* Static space for the 2 default backends */
1704 Savepoint *pSavepoint; /* List of active savepoints */
1705 int nAnalysisLimit; /* Number of index rows to ANALYZE */
1706 int busyTimeout; /* Busy handler timeout, in msec */
1707 int nSavepoint; /* Number of non-transaction savepoints */
1708 int nStatement; /* Number of nested statement-transactions */
1709 i64 nDeferredCons; /* Net deferred constraints this transaction. */
1710 i64 nDeferredImmCons; /* Net deferred immediate constraints */
1711 int *pnBytesFreed; /* If not NULL, increment this in DbFree() */
1712 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
1713 /* The following variables are all protected by the STATIC_MAIN
1714 ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
1716 ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
1717 ** unlock so that it can proceed.
1719 ** When X.pBlockingConnection==Y, that means that something that X tried
1720 ** tried to do recently failed with an SQLITE_LOCKED error due to locks
1721 ** held by Y.
1723 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
1724 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */
1725 void *pUnlockArg; /* Argument to xUnlockNotify */
1726 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */
1727 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */
1728 #endif
1729 #ifdef SQLITE_USER_AUTHENTICATION
1730 sqlite3_userauth auth; /* User authentication information */
1731 #endif
1735 ** A macro to discover the encoding of a database.
1737 #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
1738 #define ENC(db) ((db)->enc)
1741 ** A u64 constant where the lower 32 bits are all zeros. Only the
1742 ** upper 32 bits are included in the argument. Necessary because some
1743 ** C-compilers still do not accept LL integer literals.
1745 #define HI(X) ((u64)(X)<<32)
1748 ** Possible values for the sqlite3.flags.
1750 ** Value constraints (enforced via assert()):
1751 ** SQLITE_FullFSync == PAGER_FULLFSYNC
1752 ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC
1753 ** SQLITE_CacheSpill == PAGER_CACHE_SPILL
1755 #define SQLITE_WriteSchema 0x00000001 /* OK to update SQLITE_SCHEMA */
1756 #define SQLITE_LegacyFileFmt 0x00000002 /* Create new databases in format 1 */
1757 #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */
1758 #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */
1759 #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */
1760 #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */
1761 #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
1762 #define SQLITE_TrustedSchema 0x00000080 /* Allow unsafe functions and
1763 ** vtabs in the schema definition */
1764 #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
1765 /* result set is empty */
1766 #define SQLITE_IgnoreChecks 0x00000200 /* Do not enforce check constraints */
1767 #define SQLITE_StmtScanStatus 0x00000400 /* Enable stmt_scanstats() counters */
1768 #define SQLITE_NoCkptOnClose 0x00000800 /* No checkpoint on close()/DETACH */
1769 #define SQLITE_ReverseOrder 0x00001000 /* Reverse unordered SELECTs */
1770 #define SQLITE_RecTriggers 0x00002000 /* Enable recursive triggers */
1771 #define SQLITE_ForeignKeys 0x00004000 /* Enforce foreign key constraints */
1772 #define SQLITE_AutoIndex 0x00008000 /* Enable automatic indexes */
1773 #define SQLITE_LoadExtension 0x00010000 /* Enable load_extension */
1774 #define SQLITE_LoadExtFunc 0x00020000 /* Enable load_extension() SQL func */
1775 #define SQLITE_EnableTrigger 0x00040000 /* True to enable triggers */
1776 #define SQLITE_DeferFKs 0x00080000 /* Defer all FK constraints */
1777 #define SQLITE_QueryOnly 0x00100000 /* Disable database changes */
1778 #define SQLITE_CellSizeCk 0x00200000 /* Check btree cell sizes on load */
1779 #define SQLITE_Fts3Tokenizer 0x00400000 /* Enable fts3_tokenizer(2) */
1780 #define SQLITE_EnableQPSG 0x00800000 /* Query Planner Stability Guarantee*/
1781 #define SQLITE_TriggerEQP 0x01000000 /* Show trigger EXPLAIN QUERY PLAN */
1782 #define SQLITE_ResetDatabase 0x02000000 /* Reset the database */
1783 #define SQLITE_LegacyAlter 0x04000000 /* Legacy ALTER TABLE behaviour */
1784 #define SQLITE_NoSchemaError 0x08000000 /* Do not report schema parse errors*/
1785 #define SQLITE_Defensive 0x10000000 /* Input SQL is likely hostile */
1786 #define SQLITE_DqsDDL 0x20000000 /* dbl-quoted strings allowed in DDL*/
1787 #define SQLITE_DqsDML 0x40000000 /* dbl-quoted strings allowed in DML*/
1788 #define SQLITE_EnableView 0x80000000 /* Enable the use of views */
1789 #define SQLITE_CountRows HI(0x00001) /* Count rows changed by INSERT, */
1790 /* DELETE, or UPDATE and return */
1791 /* the count using a callback. */
1792 #define SQLITE_CorruptRdOnly HI(0x00002) /* Prohibit writes due to error */
1793 #define SQLITE_ReadUncommit HI(0x00004) /* READ UNCOMMITTED in shared-cache */
1795 /* Flags used only if debugging */
1796 #ifdef SQLITE_DEBUG
1797 #define SQLITE_SqlTrace HI(0x0100000) /* Debug print SQL as it executes */
1798 #define SQLITE_VdbeListing HI(0x0200000) /* Debug listings of VDBE progs */
1799 #define SQLITE_VdbeTrace HI(0x0400000) /* True to trace VDBE execution */
1800 #define SQLITE_VdbeAddopTrace HI(0x0800000) /* Trace sqlite3VdbeAddOp() calls */
1801 #define SQLITE_VdbeEQP HI(0x1000000) /* Debug EXPLAIN QUERY PLAN */
1802 #define SQLITE_ParserTrace HI(0x2000000) /* PRAGMA parser_trace=ON */
1803 #endif
1806 ** Allowed values for sqlite3.mDbFlags
1808 #define DBFLAG_SchemaChange 0x0001 /* Uncommitted Hash table changes */
1809 #define DBFLAG_PreferBuiltin 0x0002 /* Preference to built-in funcs */
1810 #define DBFLAG_Vacuum 0x0004 /* Currently in a VACUUM */
1811 #define DBFLAG_VacuumInto 0x0008 /* Currently running VACUUM INTO */
1812 #define DBFLAG_SchemaKnownOk 0x0010 /* Schema is known to be valid */
1813 #define DBFLAG_InternalFunc 0x0020 /* Allow use of internal functions */
1814 #define DBFLAG_EncodingFixed 0x0040 /* No longer possible to change enc. */
1817 ** Bits of the sqlite3.dbOptFlags field that are used by the
1818 ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
1819 ** selectively disable various optimizations.
1821 #define SQLITE_QueryFlattener 0x00000001 /* Query flattening */
1822 #define SQLITE_WindowFunc 0x00000002 /* Use xInverse for window functions */
1823 #define SQLITE_GroupByOrder 0x00000004 /* GROUPBY cover of ORDERBY */
1824 #define SQLITE_FactorOutConst 0x00000008 /* Constant factoring */
1825 #define SQLITE_DistinctOpt 0x00000010 /* DISTINCT using indexes */
1826 #define SQLITE_CoverIdxScan 0x00000020 /* Covering index scans */
1827 #define SQLITE_OrderByIdxJoin 0x00000040 /* ORDER BY of joins via index */
1828 #define SQLITE_Transitive 0x00000080 /* Transitive constraints */
1829 #define SQLITE_OmitNoopJoin 0x00000100 /* Omit unused tables in joins */
1830 #define SQLITE_CountOfView 0x00000200 /* The count-of-view optimization */
1831 #define SQLITE_CursorHints 0x00000400 /* Add OP_CursorHint opcodes */
1832 #define SQLITE_Stat4 0x00000800 /* Use STAT4 data */
1833 /* TH3 expects this value ^^^^^^^^^^ to be 0x0000800. Don't change it */
1834 #define SQLITE_PushDown 0x00001000 /* The push-down optimization */
1835 #define SQLITE_SimplifyJoin 0x00002000 /* Convert LEFT JOIN to JOIN */
1836 #define SQLITE_SkipScan 0x00004000 /* Skip-scans */
1837 #define SQLITE_PropagateConst 0x00008000 /* The constant propagation opt */
1838 #define SQLITE_MinMaxOpt 0x00010000 /* The min/max optimization */
1839 #define SQLITE_SeekScan 0x00020000 /* The OP_SeekScan optimization */
1840 #define SQLITE_OmitOrderBy 0x00040000 /* Omit pointless ORDER BY */
1841 /* TH3 expects this value ^^^^^^^^^^ to be 0x40000. Coordinate any change */
1842 #define SQLITE_BloomFilter 0x00080000 /* Use a Bloom filter on searches */
1843 #define SQLITE_BloomPulldown 0x00100000 /* Run Bloom filters early */
1844 #define SQLITE_BalancedMerge 0x00200000 /* Balance multi-way merges */
1845 #define SQLITE_ReleaseReg 0x00400000 /* Use OP_ReleaseReg for testing */
1846 #define SQLITE_FlttnUnionAll 0x00800000 /* Disable the UNION ALL flattener */
1847 /* TH3 expects this value ^^^^^^^^^^ See flatten04.test */
1848 #define SQLITE_IndexedExpr 0x01000000 /* Pull exprs from index when able */
1849 #define SQLITE_Coroutines 0x02000000 /* Co-routines for subqueries */
1850 #define SQLITE_NullUnusedCols 0x04000000 /* NULL unused columns in subqueries */
1851 #define SQLITE_AllOpts 0xffffffff /* All optimizations */
1854 ** Macros for testing whether or not optimizations are enabled or disabled.
1856 #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0)
1857 #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0)
1860 ** Return true if it OK to factor constant expressions into the initialization
1861 ** code. The argument is a Parse object for the code generator.
1863 #define ConstFactorOk(P) ((P)->okConstFactor)
1865 /* Possible values for the sqlite3.eOpenState field.
1866 ** The numbers are randomly selected such that a minimum of three bits must
1867 ** change to convert any number to another or to zero
1869 #define SQLITE_STATE_OPEN 0x76 /* Database is open */
1870 #define SQLITE_STATE_CLOSED 0xce /* Database is closed */
1871 #define SQLITE_STATE_SICK 0xba /* Error and awaiting close */
1872 #define SQLITE_STATE_BUSY 0x6d /* Database currently in use */
1873 #define SQLITE_STATE_ERROR 0xd5 /* An SQLITE_MISUSE error occurred */
1874 #define SQLITE_STATE_ZOMBIE 0xa7 /* Close with last statement close */
1877 ** Each SQL function is defined by an instance of the following
1878 ** structure. For global built-in functions (ex: substr(), max(), count())
1879 ** a pointer to this structure is held in the sqlite3BuiltinFunctions object.
1880 ** For per-connection application-defined functions, a pointer to this
1881 ** structure is held in the db->aHash hash table.
1883 ** The u.pHash field is used by the global built-ins. The u.pDestructor
1884 ** field is used by per-connection app-def functions.
1886 struct FuncDef {
1887 i8 nArg; /* Number of arguments. -1 means unlimited */
1888 u32 funcFlags; /* Some combination of SQLITE_FUNC_* */
1889 void *pUserData; /* User data parameter */
1890 FuncDef *pNext; /* Next function with same name */
1891 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */
1892 void (*xFinalize)(sqlite3_context*); /* Agg finalizer */
1893 void (*xValue)(sqlite3_context*); /* Current agg value */
1894 void (*xInverse)(sqlite3_context*,int,sqlite3_value**); /* inverse agg-step */
1895 const char *zName; /* SQL name of the function. */
1896 union {
1897 FuncDef *pHash; /* Next with a different name but the same hash */
1898 FuncDestructor *pDestructor; /* Reference counted destructor function */
1899 } u; /* pHash if SQLITE_FUNC_BUILTIN, pDestructor otherwise */
1903 ** This structure encapsulates a user-function destructor callback (as
1904 ** configured using create_function_v2()) and a reference counter. When
1905 ** create_function_v2() is called to create a function with a destructor,
1906 ** a single object of this type is allocated. FuncDestructor.nRef is set to
1907 ** the number of FuncDef objects created (either 1 or 3, depending on whether
1908 ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
1909 ** member of each of the new FuncDef objects is set to point to the allocated
1910 ** FuncDestructor.
1912 ** Thereafter, when one of the FuncDef objects is deleted, the reference
1913 ** count on this object is decremented. When it reaches 0, the destructor
1914 ** is invoked and the FuncDestructor structure freed.
1916 struct FuncDestructor {
1917 int nRef;
1918 void (*xDestroy)(void *);
1919 void *pUserData;
1923 ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF
1924 ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And
1925 ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There
1926 ** are assert() statements in the code to verify this.
1928 ** Value constraints (enforced via assert()):
1929 ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg
1930 ** SQLITE_FUNC_ANYORDER == NC_OrderAgg == SF_OrderByReqd
1931 ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG
1932 ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG
1933 ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API
1934 ** SQLITE_FUNC_DIRECT == SQLITE_DIRECTONLY from the API
1935 ** SQLITE_FUNC_UNSAFE == SQLITE_INNOCUOUS -- opposite meanings!!!
1936 ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API
1938 ** Note that even though SQLITE_FUNC_UNSAFE and SQLITE_INNOCUOUS have the
1939 ** same bit value, their meanings are inverted. SQLITE_FUNC_UNSAFE is
1940 ** used internally and if set means tha the function has side effects.
1941 ** SQLITE_INNOCUOUS is used by application code and means "not unsafe".
1942 ** See multiple instances of tag-20230109-1.
1944 #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
1945 #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */
1946 #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */
1947 #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */
1948 #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/
1949 #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */
1950 #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */
1951 #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */
1952 /* 0x0200 -- available for reuse */
1953 #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */
1954 #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */
1955 #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */
1956 #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a
1957 ** single query - might change over time */
1958 #define SQLITE_FUNC_TEST 0x4000 /* Built-in testing functions */
1959 /* 0x8000 -- available for reuse */
1960 #define SQLITE_FUNC_WINDOW 0x00010000 /* Built-in window-only function */
1961 #define SQLITE_FUNC_INTERNAL 0x00040000 /* For use by NestedParse() only */
1962 #define SQLITE_FUNC_DIRECT 0x00080000 /* Not for use in TRIGGERs or VIEWs */
1963 #define SQLITE_FUNC_SUBTYPE 0x00100000 /* Result likely to have sub-type */
1964 #define SQLITE_FUNC_UNSAFE 0x00200000 /* Function has side effects */
1965 #define SQLITE_FUNC_INLINE 0x00400000 /* Functions implemented in-line */
1966 #define SQLITE_FUNC_BUILTIN 0x00800000 /* This is a built-in function */
1967 #define SQLITE_FUNC_ANYORDER 0x08000000 /* count/min/max aggregate */
1969 /* Identifier numbers for each in-line function */
1970 #define INLINEFUNC_coalesce 0
1971 #define INLINEFUNC_implies_nonnull_row 1
1972 #define INLINEFUNC_expr_implies_expr 2
1973 #define INLINEFUNC_expr_compare 3
1974 #define INLINEFUNC_affinity 4
1975 #define INLINEFUNC_iif 5
1976 #define INLINEFUNC_sqlite_offset 6
1977 #define INLINEFUNC_unlikely 99 /* Default case */
1980 ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1981 ** used to create the initializers for the FuncDef structures.
1983 ** FUNCTION(zName, nArg, iArg, bNC, xFunc)
1984 ** Used to create a scalar function definition of a function zName
1985 ** implemented by C function xFunc that accepts nArg arguments. The
1986 ** value passed as iArg is cast to a (void*) and made available
1987 ** as the user-data (sqlite3_user_data()) for the function. If
1988 ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
1990 ** VFUNCTION(zName, nArg, iArg, bNC, xFunc)
1991 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
1993 ** SFUNCTION(zName, nArg, iArg, bNC, xFunc)
1994 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
1995 ** adds the SQLITE_DIRECTONLY flag.
1997 ** INLINE_FUNC(zName, nArg, iFuncId, mFlags)
1998 ** zName is the name of a function that is implemented by in-line
1999 ** byte code rather than by the usual callbacks. The iFuncId
2000 ** parameter determines the function id. The mFlags parameter is
2001 ** optional SQLITE_FUNC_ flags for this function.
2003 ** TEST_FUNC(zName, nArg, iFuncId, mFlags)
2004 ** zName is the name of a test-only function implemented by in-line
2005 ** byte code rather than by the usual callbacks. The iFuncId
2006 ** parameter determines the function id. The mFlags parameter is
2007 ** optional SQLITE_FUNC_ flags for this function.
2009 ** DFUNCTION(zName, nArg, iArg, bNC, xFunc)
2010 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
2011 ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions
2012 ** and functions like sqlite_version() that can change, but not during
2013 ** a single query. The iArg is ignored. The user-data is always set
2014 ** to a NULL pointer. The bNC parameter is not used.
2016 ** MFUNCTION(zName, nArg, xPtr, xFunc)
2017 ** For math-library functions. xPtr is an arbitrary pointer.
2019 ** PURE_DATE(zName, nArg, iArg, bNC, xFunc)
2020 ** Used for "pure" date/time functions, this macro is like DFUNCTION
2021 ** except that it does set the SQLITE_FUNC_CONSTANT flags. iArg is
2022 ** ignored and the user-data for these functions is set to an
2023 ** arbitrary non-NULL pointer. The bNC parameter is not used.
2025 ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
2026 ** Used to create an aggregate function definition implemented by
2027 ** the C functions xStep and xFinal. The first four parameters
2028 ** are interpreted in the same way as the first 4 parameters to
2029 ** FUNCTION().
2031 ** WAGGREGATE(zName, nArg, iArg, xStep, xFinal, xValue, xInverse)
2032 ** Used to create an aggregate function definition implemented by
2033 ** the C functions xStep and xFinal. The first four parameters
2034 ** are interpreted in the same way as the first 4 parameters to
2035 ** FUNCTION().
2037 ** LIKEFUNC(zName, nArg, pArg, flags)
2038 ** Used to create a scalar function definition of a function zName
2039 ** that accepts nArg arguments and is implemented by a call to C
2040 ** function likeFunc. Argument pArg is cast to a (void *) and made
2041 ** available as the function user-data (sqlite3_user_data()). The
2042 ** FuncDef.flags variable is set to the value passed as the flags
2043 ** parameter.
2045 #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
2046 {nArg, SQLITE_FUNC_BUILTIN|\
2047 SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
2048 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
2049 #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
2050 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
2051 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
2052 #define SFUNCTION(zName, nArg, iArg, bNC, xFunc) \
2053 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_UTF8|SQLITE_DIRECTONLY|SQLITE_FUNC_UNSAFE, \
2054 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
2055 #define MFUNCTION(zName, nArg, xPtr, xFunc) \
2056 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_FUNC_CONSTANT|SQLITE_UTF8, \
2057 xPtr, 0, xFunc, 0, 0, 0, #zName, {0} }
2058 #define JFUNCTION(zName, nArg, iArg, xFunc) \
2059 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_DETERMINISTIC|\
2060 SQLITE_FUNC_CONSTANT|SQLITE_UTF8, \
2061 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
2062 #define INLINE_FUNC(zName, nArg, iArg, mFlags) \
2063 {nArg, SQLITE_FUNC_BUILTIN|\
2064 SQLITE_UTF8|SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \
2065 SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} }
2066 #define TEST_FUNC(zName, nArg, iArg, mFlags) \
2067 {nArg, SQLITE_FUNC_BUILTIN|\
2068 SQLITE_UTF8|SQLITE_FUNC_INTERNAL|SQLITE_FUNC_TEST| \
2069 SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \
2070 SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} }
2071 #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \
2072 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_FUNC_SLOCHNG|SQLITE_UTF8, \
2073 0, 0, xFunc, 0, 0, 0, #zName, {0} }
2074 #define PURE_DATE(zName, nArg, iArg, bNC, xFunc) \
2075 {nArg, SQLITE_FUNC_BUILTIN|\
2076 SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \
2077 (void*)&sqlite3Config, 0, xFunc, 0, 0, 0, #zName, {0} }
2078 #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
2079 {nArg, SQLITE_FUNC_BUILTIN|\
2080 SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
2081 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
2082 #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
2083 {nArg, SQLITE_FUNC_BUILTIN|\
2084 SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
2085 pArg, 0, xFunc, 0, 0, 0, #zName, }
2086 #define LIKEFUNC(zName, nArg, arg, flags) \
2087 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
2088 (void *)arg, 0, likeFunc, 0, 0, 0, #zName, {0} }
2089 #define WAGGREGATE(zName, nArg, arg, nc, xStep, xFinal, xValue, xInverse, f) \
2090 {nArg, SQLITE_FUNC_BUILTIN|SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|f, \
2091 SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xValue,xInverse,#zName, {0}}
2092 #define INTERNAL_FUNCTION(zName, nArg, xFunc) \
2093 {nArg, SQLITE_FUNC_BUILTIN|\
2094 SQLITE_FUNC_INTERNAL|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \
2095 0, 0, xFunc, 0, 0, 0, #zName, {0} }
2099 ** All current savepoints are stored in a linked list starting at
2100 ** sqlite3.pSavepoint. The first element in the list is the most recently
2101 ** opened savepoint. Savepoints are added to the list by the vdbe
2102 ** OP_Savepoint instruction.
2104 struct Savepoint {
2105 char *zName; /* Savepoint name (nul-terminated) */
2106 i64 nDeferredCons; /* Number of deferred fk violations */
2107 i64 nDeferredImmCons; /* Number of deferred imm fk. */
2108 Savepoint *pNext; /* Parent savepoint (if any) */
2112 ** The following are used as the second parameter to sqlite3Savepoint(),
2113 ** and as the P1 argument to the OP_Savepoint instruction.
2115 #define SAVEPOINT_BEGIN 0
2116 #define SAVEPOINT_RELEASE 1
2117 #define SAVEPOINT_ROLLBACK 2
2121 ** Each SQLite module (virtual table definition) is defined by an
2122 ** instance of the following structure, stored in the sqlite3.aModule
2123 ** hash table.
2125 struct Module {
2126 const sqlite3_module *pModule; /* Callback pointers */
2127 const char *zName; /* Name passed to create_module() */
2128 int nRefModule; /* Number of pointers to this object */
2129 void *pAux; /* pAux passed to create_module() */
2130 void (*xDestroy)(void *); /* Module destructor function */
2131 Table *pEpoTab; /* Eponymous table for this module */
2135 ** Information about each column of an SQL table is held in an instance
2136 ** of the Column structure, in the Table.aCol[] array.
2138 ** Definitions:
2140 ** "table column index" This is the index of the column in the
2141 ** Table.aCol[] array, and also the index of
2142 ** the column in the original CREATE TABLE stmt.
2144 ** "storage column index" This is the index of the column in the
2145 ** record BLOB generated by the OP_MakeRecord
2146 ** opcode. The storage column index is less than
2147 ** or equal to the table column index. It is
2148 ** equal if and only if there are no VIRTUAL
2149 ** columns to the left.
2151 ** Notes on zCnName:
2152 ** The zCnName field stores the name of the column, the datatype of the
2153 ** column, and the collating sequence for the column, in that order, all in
2154 ** a single allocation. Each string is 0x00 terminated. The datatype
2155 ** is only included if the COLFLAG_HASTYPE bit of colFlags is set and the
2156 ** collating sequence name is only included if the COLFLAG_HASCOLL bit is
2157 ** set.
2159 struct Column {
2160 char *zCnName; /* Name of this column */
2161 unsigned notNull :4; /* An OE_ code for handling a NOT NULL constraint */
2162 unsigned eCType :4; /* One of the standard types */
2163 char affinity; /* One of the SQLITE_AFF_... values */
2164 u8 szEst; /* Est size of value in this column. sizeof(INT)==1 */
2165 u8 hName; /* Column name hash for faster lookup */
2166 u16 iDflt; /* 1-based index of DEFAULT. 0 means "none" */
2167 u16 colFlags; /* Boolean properties. See COLFLAG_ defines below */
2170 /* Allowed values for Column.eCType.
2172 ** Values must match entries in the global constant arrays
2173 ** sqlite3StdTypeLen[] and sqlite3StdType[]. Each value is one more
2174 ** than the offset into these arrays for the corresponding name.
2175 ** Adjust the SQLITE_N_STDTYPE value if adding or removing entries.
2177 #define COLTYPE_CUSTOM 0 /* Type appended to zName */
2178 #define COLTYPE_ANY 1
2179 #define COLTYPE_BLOB 2
2180 #define COLTYPE_INT 3
2181 #define COLTYPE_INTEGER 4
2182 #define COLTYPE_REAL 5
2183 #define COLTYPE_TEXT 6
2184 #define SQLITE_N_STDTYPE 6 /* Number of standard types */
2186 /* Allowed values for Column.colFlags.
2188 ** Constraints:
2189 ** TF_HasVirtual == COLFLAG_VIRTUAL
2190 ** TF_HasStored == COLFLAG_STORED
2191 ** TF_HasHidden == COLFLAG_HIDDEN
2193 #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */
2194 #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */
2195 #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */
2196 #define COLFLAG_UNIQUE 0x0008 /* Column def contains "UNIQUE" or "PK" */
2197 #define COLFLAG_SORTERREF 0x0010 /* Use sorter-refs with this column */
2198 #define COLFLAG_VIRTUAL 0x0020 /* GENERATED ALWAYS AS ... VIRTUAL */
2199 #define COLFLAG_STORED 0x0040 /* GENERATED ALWAYS AS ... STORED */
2200 #define COLFLAG_NOTAVAIL 0x0080 /* STORED column not yet calculated */
2201 #define COLFLAG_BUSY 0x0100 /* Blocks recursion on GENERATED columns */
2202 #define COLFLAG_HASCOLL 0x0200 /* Has collating sequence name in zCnName */
2203 #define COLFLAG_NOEXPAND 0x0400 /* Omit this column when expanding "*" */
2204 #define COLFLAG_GENERATED 0x0060 /* Combo: _STORED, _VIRTUAL */
2205 #define COLFLAG_NOINSERT 0x0062 /* Combo: _HIDDEN, _STORED, _VIRTUAL */
2208 ** A "Collating Sequence" is defined by an instance of the following
2209 ** structure. Conceptually, a collating sequence consists of a name and
2210 ** a comparison routine that defines the order of that sequence.
2212 ** If CollSeq.xCmp is NULL, it means that the
2213 ** collating sequence is undefined. Indices built on an undefined
2214 ** collating sequence may not be read or written.
2216 struct CollSeq {
2217 char *zName; /* Name of the collating sequence, UTF-8 encoded */
2218 u8 enc; /* Text encoding handled by xCmp() */
2219 void *pUser; /* First argument to xCmp() */
2220 int (*xCmp)(void*,int, const void*, int, const void*);
2221 void (*xDel)(void*); /* Destructor for pUser */
2225 ** A sort order can be either ASC or DESC.
2227 #define SQLITE_SO_ASC 0 /* Sort in ascending order */
2228 #define SQLITE_SO_DESC 1 /* Sort in ascending order */
2229 #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */
2232 ** Column affinity types.
2234 ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
2235 ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
2236 ** the speed a little by numbering the values consecutively.
2238 ** But rather than start with 0 or 1, we begin with 'A'. That way,
2239 ** when multiple affinity types are concatenated into a string and
2240 ** used as the P4 operand, they will be more readable.
2242 ** Note also that the numeric types are grouped together so that testing
2243 ** for a numeric type is a single comparison. And the BLOB type is first.
2245 #define SQLITE_AFF_NONE 0x40 /* '@' */
2246 #define SQLITE_AFF_BLOB 0x41 /* 'A' */
2247 #define SQLITE_AFF_TEXT 0x42 /* 'B' */
2248 #define SQLITE_AFF_NUMERIC 0x43 /* 'C' */
2249 #define SQLITE_AFF_INTEGER 0x44 /* 'D' */
2250 #define SQLITE_AFF_REAL 0x45 /* 'E' */
2251 #define SQLITE_AFF_FLEXNUM 0x46 /* 'F' */
2253 #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
2256 ** The SQLITE_AFF_MASK values masks off the significant bits of an
2257 ** affinity value.
2259 #define SQLITE_AFF_MASK 0x47
2262 ** Additional bit values that can be ORed with an affinity without
2263 ** changing the affinity.
2265 ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
2266 ** It causes an assert() to fire if either operand to a comparison
2267 ** operator is NULL. It is added to certain comparison operators to
2268 ** prove that the operands are always NOT NULL.
2270 #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */
2271 #define SQLITE_NULLEQ 0x80 /* NULL=NULL */
2272 #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */
2275 ** An object of this type is created for each virtual table present in
2276 ** the database schema.
2278 ** If the database schema is shared, then there is one instance of this
2279 ** structure for each database connection (sqlite3*) that uses the shared
2280 ** schema. This is because each database connection requires its own unique
2281 ** instance of the sqlite3_vtab* handle used to access the virtual table
2282 ** implementation. sqlite3_vtab* handles can not be shared between
2283 ** database connections, even when the rest of the in-memory database
2284 ** schema is shared, as the implementation often stores the database
2285 ** connection handle passed to it via the xConnect() or xCreate() method
2286 ** during initialization internally. This database connection handle may
2287 ** then be used by the virtual table implementation to access real tables
2288 ** within the database. So that they appear as part of the callers
2289 ** transaction, these accesses need to be made via the same database
2290 ** connection as that used to execute SQL operations on the virtual table.
2292 ** All VTable objects that correspond to a single table in a shared
2293 ** database schema are initially stored in a linked-list pointed to by
2294 ** the Table.pVTable member variable of the corresponding Table object.
2295 ** When an sqlite3_prepare() operation is required to access the virtual
2296 ** table, it searches the list for the VTable that corresponds to the
2297 ** database connection doing the preparing so as to use the correct
2298 ** sqlite3_vtab* handle in the compiled query.
2300 ** When an in-memory Table object is deleted (for example when the
2301 ** schema is being reloaded for some reason), the VTable objects are not
2302 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
2303 ** immediately. Instead, they are moved from the Table.pVTable list to
2304 ** another linked list headed by the sqlite3.pDisconnect member of the
2305 ** corresponding sqlite3 structure. They are then deleted/xDisconnected
2306 ** next time a statement is prepared using said sqlite3*. This is done
2307 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
2308 ** Refer to comments above function sqlite3VtabUnlockList() for an
2309 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
2310 ** list without holding the corresponding sqlite3.mutex mutex.
2312 ** The memory for objects of this type is always allocated by
2313 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
2314 ** the first argument.
2316 struct VTable {
2317 sqlite3 *db; /* Database connection associated with this table */
2318 Module *pMod; /* Pointer to module implementation */
2319 sqlite3_vtab *pVtab; /* Pointer to vtab instance */
2320 int nRef; /* Number of pointers to this structure */
2321 u8 bConstraint; /* True if constraints are supported */
2322 u8 bAllSchemas; /* True if might use any attached schema */
2323 u8 eVtabRisk; /* Riskiness of allowing hacker access */
2324 int iSavepoint; /* Depth of the SAVEPOINT stack */
2325 VTable *pNext; /* Next in linked list (see above) */
2328 /* Allowed values for VTable.eVtabRisk
2330 #define SQLITE_VTABRISK_Low 0
2331 #define SQLITE_VTABRISK_Normal 1
2332 #define SQLITE_VTABRISK_High 2
2335 ** The schema for each SQL table, virtual table, and view is represented
2336 ** in memory by an instance of the following structure.
2338 struct Table {
2339 char *zName; /* Name of the table or view */
2340 Column *aCol; /* Information about each column */
2341 Index *pIndex; /* List of SQL indexes on this table. */
2342 char *zColAff; /* String defining the affinity of each column */
2343 ExprList *pCheck; /* All CHECK constraints */
2344 /* ... also used as column name list in a VIEW */
2345 Pgno tnum; /* Root BTree page for this table */
2346 u32 nTabRef; /* Number of pointers to this Table */
2347 u32 tabFlags; /* Mask of TF_* values */
2348 i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */
2349 i16 nCol; /* Number of columns in this table */
2350 i16 nNVCol; /* Number of columns that are not VIRTUAL */
2351 LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */
2352 LogEst szTabRow; /* Estimated size of each table row in bytes */
2353 #ifdef SQLITE_ENABLE_COSTMULT
2354 LogEst costMult; /* Cost multiplier for using this table */
2355 #endif
2356 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
2357 u8 eTabType; /* 0: normal, 1: virtual, 2: view */
2358 union {
2359 struct { /* Used by ordinary tables: */
2360 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
2361 FKey *pFKey; /* Linked list of all foreign keys in this table */
2362 ExprList *pDfltList; /* DEFAULT clauses on various columns.
2363 ** Or the AS clause for generated columns. */
2364 } tab;
2365 struct { /* Used by views: */
2366 Select *pSelect; /* View definition */
2367 } view;
2368 struct { /* Used by virtual tables only: */
2369 int nArg; /* Number of arguments to the module */
2370 char **azArg; /* 0: module 1: schema 2: vtab name 3...: args */
2371 VTable *p; /* List of VTable objects. */
2372 } vtab;
2373 } u;
2374 Trigger *pTrigger; /* List of triggers on this object */
2375 Schema *pSchema; /* Schema that contains this table */
2379 ** Allowed values for Table.tabFlags.
2381 ** TF_OOOHidden applies to tables or view that have hidden columns that are
2382 ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING
2383 ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden,
2384 ** the TF_OOOHidden attribute would apply in this case. Such tables require
2385 ** special handling during INSERT processing. The "OOO" means "Out Of Order".
2387 ** Constraints:
2389 ** TF_HasVirtual == COLFLAG_VIRTUAL
2390 ** TF_HasStored == COLFLAG_STORED
2391 ** TF_HasHidden == COLFLAG_HIDDEN
2393 #define TF_Readonly 0x00000001 /* Read-only system table */
2394 #define TF_HasHidden 0x00000002 /* Has one or more hidden columns */
2395 #define TF_HasPrimaryKey 0x00000004 /* Table has a primary key */
2396 #define TF_Autoincrement 0x00000008 /* Integer primary key is autoincrement */
2397 #define TF_HasStat1 0x00000010 /* nRowLogEst set from sqlite_stat1 */
2398 #define TF_HasVirtual 0x00000020 /* Has one or more VIRTUAL columns */
2399 #define TF_HasStored 0x00000040 /* Has one or more STORED columns */
2400 #define TF_HasGenerated 0x00000060 /* Combo: HasVirtual + HasStored */
2401 #define TF_WithoutRowid 0x00000080 /* No rowid. PRIMARY KEY is the key */
2402 #define TF_StatsUsed 0x00000100 /* Query planner decisions affected by
2403 ** Index.aiRowLogEst[] values */
2404 #define TF_NoVisibleRowid 0x00000200 /* No user-visible "rowid" column */
2405 #define TF_OOOHidden 0x00000400 /* Out-of-Order hidden columns */
2406 #define TF_HasNotNull 0x00000800 /* Contains NOT NULL constraints */
2407 #define TF_Shadow 0x00001000 /* True for a shadow table */
2408 #define TF_HasStat4 0x00002000 /* STAT4 info available for this table */
2409 #define TF_Ephemeral 0x00004000 /* An ephemeral table */
2410 #define TF_Eponymous 0x00008000 /* An eponymous virtual table */
2411 #define TF_Strict 0x00010000 /* STRICT mode */
2414 ** Allowed values for Table.eTabType
2416 #define TABTYP_NORM 0 /* Ordinary table */
2417 #define TABTYP_VTAB 1 /* Virtual table */
2418 #define TABTYP_VIEW 2 /* A view */
2420 #define IsView(X) ((X)->eTabType==TABTYP_VIEW)
2421 #define IsOrdinaryTable(X) ((X)->eTabType==TABTYP_NORM)
2424 ** Test to see whether or not a table is a virtual table. This is
2425 ** done as a macro so that it will be optimized out when virtual
2426 ** table support is omitted from the build.
2428 #ifndef SQLITE_OMIT_VIRTUALTABLE
2429 # define IsVirtual(X) ((X)->eTabType==TABTYP_VTAB)
2430 # define ExprIsVtab(X) \
2431 ((X)->op==TK_COLUMN && (X)->y.pTab->eTabType==TABTYP_VTAB)
2432 #else
2433 # define IsVirtual(X) 0
2434 # define ExprIsVtab(X) 0
2435 #endif
2438 ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn()
2439 ** only works for non-virtual tables (ordinary tables and views) and is
2440 ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The
2441 ** IsHiddenColumn() macro is general purpose.
2443 #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS)
2444 # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
2445 # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
2446 #elif !defined(SQLITE_OMIT_VIRTUALTABLE)
2447 # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
2448 # define IsOrdinaryHiddenColumn(X) 0
2449 #else
2450 # define IsHiddenColumn(X) 0
2451 # define IsOrdinaryHiddenColumn(X) 0
2452 #endif
2455 /* Does the table have a rowid */
2456 #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0)
2457 #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
2460 ** Each foreign key constraint is an instance of the following structure.
2462 ** A foreign key is associated with two tables. The "from" table is
2463 ** the table that contains the REFERENCES clause that creates the foreign
2464 ** key. The "to" table is the table that is named in the REFERENCES clause.
2465 ** Consider this example:
2467 ** CREATE TABLE ex1(
2468 ** a INTEGER PRIMARY KEY,
2469 ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
2470 ** );
2472 ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
2473 ** Equivalent names:
2475 ** from-table == child-table
2476 ** to-table == parent-table
2478 ** Each REFERENCES clause generates an instance of the following structure
2479 ** which is attached to the from-table. The to-table need not exist when
2480 ** the from-table is created. The existence of the to-table is not checked.
2482 ** The list of all parents for child Table X is held at X.pFKey.
2484 ** A list of all children for a table named Z (which might not even exist)
2485 ** is held in Schema.fkeyHash with a hash key of Z.
2487 struct FKey {
2488 Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */
2489 FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */
2490 char *zTo; /* Name of table that the key points to (aka: Parent) */
2491 FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */
2492 FKey *pPrevTo; /* Previous with the same zTo */
2493 int nCol; /* Number of columns in this key */
2494 /* EV: R-30323-21917 */
2495 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
2496 u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */
2497 Trigger *apTrigger[2];/* Triggers for aAction[] actions */
2498 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
2499 int iFrom; /* Index of column in pFrom */
2500 char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */
2501 } aCol[1]; /* One entry for each of nCol columns */
2505 ** SQLite supports many different ways to resolve a constraint
2506 ** error. ROLLBACK processing means that a constraint violation
2507 ** causes the operation in process to fail and for the current transaction
2508 ** to be rolled back. ABORT processing means the operation in process
2509 ** fails and any prior changes from that one operation are backed out,
2510 ** but the transaction is not rolled back. FAIL processing means that
2511 ** the operation in progress stops and returns an error code. But prior
2512 ** changes due to the same operation are not backed out and no rollback
2513 ** occurs. IGNORE means that the particular row that caused the constraint
2514 ** error is not inserted or updated. Processing continues and no error
2515 ** is returned. REPLACE means that preexisting database rows that caused
2516 ** a UNIQUE constraint violation are removed so that the new insert or
2517 ** update can proceed. Processing continues and no error is reported.
2518 ** UPDATE applies to insert operations only and means that the insert
2519 ** is omitted and the DO UPDATE clause of an upsert is run instead.
2521 ** RESTRICT, SETNULL, SETDFLT, and CASCADE actions apply only to foreign keys.
2522 ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
2523 ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
2524 ** key is set to NULL. SETDFLT means that the foreign key is set
2525 ** to its default value. CASCADE means that a DELETE or UPDATE of the
2526 ** referenced table row is propagated into the row that holds the
2527 ** foreign key.
2529 ** The OE_Default value is a place holder that means to use whatever
2530 ** conflict resolution algorthm is required from context.
2532 ** The following symbolic values are used to record which type
2533 ** of conflict resolution action to take.
2535 #define OE_None 0 /* There is no constraint to check */
2536 #define OE_Rollback 1 /* Fail the operation and rollback the transaction */
2537 #define OE_Abort 2 /* Back out changes but do no rollback transaction */
2538 #define OE_Fail 3 /* Stop the operation but leave all prior changes */
2539 #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
2540 #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
2541 #define OE_Update 6 /* Process as a DO UPDATE in an upsert */
2542 #define OE_Restrict 7 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
2543 #define OE_SetNull 8 /* Set the foreign key value to NULL */
2544 #define OE_SetDflt 9 /* Set the foreign key value to its default */
2545 #define OE_Cascade 10 /* Cascade the changes */
2546 #define OE_Default 11 /* Do whatever the default action is */
2550 ** An instance of the following structure is passed as the first
2551 ** argument to sqlite3VdbeKeyCompare and is used to control the
2552 ** comparison of the two index keys.
2554 ** Note that aSortOrder[] and aColl[] have nField+1 slots. There
2555 ** are nField slots for the columns of an index then one extra slot
2556 ** for the rowid at the end.
2558 struct KeyInfo {
2559 u32 nRef; /* Number of references to this KeyInfo object */
2560 u8 enc; /* Text encoding - one of the SQLITE_UTF* values */
2561 u16 nKeyField; /* Number of key columns in the index */
2562 u16 nAllField; /* Total columns, including key plus others */
2563 sqlite3 *db; /* The database connection */
2564 u8 *aSortFlags; /* Sort order for each column. */
2565 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
2569 ** Allowed bit values for entries in the KeyInfo.aSortFlags[] array.
2571 #define KEYINFO_ORDER_DESC 0x01 /* DESC sort order */
2572 #define KEYINFO_ORDER_BIGNULL 0x02 /* NULL is larger than any other value */
2575 ** This object holds a record which has been parsed out into individual
2576 ** fields, for the purposes of doing a comparison.
2578 ** A record is an object that contains one or more fields of data.
2579 ** Records are used to store the content of a table row and to store
2580 ** the key of an index. A blob encoding of a record is created by
2581 ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
2582 ** OP_Column opcode.
2584 ** An instance of this object serves as a "key" for doing a search on
2585 ** an index b+tree. The goal of the search is to find the entry that
2586 ** is closed to the key described by this object. This object might hold
2587 ** just a prefix of the key. The number of fields is given by
2588 ** pKeyInfo->nField.
2590 ** The r1 and r2 fields are the values to return if this key is less than
2591 ** or greater than a key in the btree, respectively. These are normally
2592 ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree
2593 ** is in DESC order.
2595 ** The key comparison functions actually return default_rc when they find
2596 ** an equals comparison. default_rc can be -1, 0, or +1. If there are
2597 ** multiple entries in the b-tree with the same key (when only looking
2598 ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to
2599 ** cause the search to find the last match, or +1 to cause the search to
2600 ** find the first match.
2602 ** The key comparison functions will set eqSeen to true if they ever
2603 ** get and equal results when comparing this structure to a b-tree record.
2604 ** When default_rc!=0, the search might end up on the record immediately
2605 ** before the first match or immediately after the last match. The
2606 ** eqSeen field will indicate whether or not an exact match exists in the
2607 ** b-tree.
2609 struct UnpackedRecord {
2610 KeyInfo *pKeyInfo; /* Collation and sort-order information */
2611 Mem *aMem; /* Values */
2612 union {
2613 char *z; /* Cache of aMem[0].z for vdbeRecordCompareString() */
2614 i64 i; /* Cache of aMem[0].u.i for vdbeRecordCompareInt() */
2615 } u;
2616 int n; /* Cache of aMem[0].n used by vdbeRecordCompareString() */
2617 u16 nField; /* Number of entries in apMem[] */
2618 i8 default_rc; /* Comparison result if keys are equal */
2619 u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
2620 i8 r1; /* Value to return if (lhs < rhs) */
2621 i8 r2; /* Value to return if (lhs > rhs) */
2622 u8 eqSeen; /* True if an equality comparison has been seen */
2627 ** Each SQL index is represented in memory by an
2628 ** instance of the following structure.
2630 ** The columns of the table that are to be indexed are described
2631 ** by the aiColumn[] field of this structure. For example, suppose
2632 ** we have the following table and index:
2634 ** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
2635 ** CREATE INDEX Ex2 ON Ex1(c3,c1);
2637 ** In the Table structure describing Ex1, nCol==3 because there are
2638 ** three columns in the table. In the Index structure describing
2639 ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
2640 ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
2641 ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
2642 ** The second column to be indexed (c1) has an index of 0 in
2643 ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
2645 ** The Index.onError field determines whether or not the indexed columns
2646 ** must be unique and what to do if they are not. When Index.onError=OE_None,
2647 ** it means this is not a unique index. Otherwise it is a unique index
2648 ** and the value of Index.onError indicates which conflict resolution
2649 ** algorithm to employ when an attempt is made to insert a non-unique
2650 ** element.
2652 ** The colNotIdxed bitmask is used in combination with SrcItem.colUsed
2653 ** for a fast test to see if an index can serve as a covering index.
2654 ** colNotIdxed has a 1 bit for every column of the original table that
2655 ** is *not* available in the index. Thus the expression
2656 ** "colUsed & colNotIdxed" will be non-zero if the index is not a
2657 ** covering index. The most significant bit of of colNotIdxed will always
2658 ** be true (note-20221022-a). If a column beyond the 63rd column of the
2659 ** table is used, the "colUsed & colNotIdxed" test will always be non-zero
2660 ** and we have to assume either that the index is not covering, or use
2661 ** an alternative (slower) algorithm to determine whether or not
2662 ** the index is covering.
2664 ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
2665 ** generate VDBE code (as opposed to parsing one read from an sqlite_schema
2666 ** table as part of parsing an existing database schema), transient instances
2667 ** of this structure may be created. In this case the Index.tnum variable is
2668 ** used to store the address of a VDBE instruction, not a database page
2669 ** number (it cannot - the database page is not allocated until the VDBE
2670 ** program is executed). See convertToWithoutRowidTable() for details.
2672 struct Index {
2673 char *zName; /* Name of this index */
2674 i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */
2675 LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */
2676 Table *pTable; /* The SQL table being indexed */
2677 char *zColAff; /* String defining the affinity of each column */
2678 Index *pNext; /* The next index associated with the same table */
2679 Schema *pSchema; /* Schema containing this index */
2680 u8 *aSortOrder; /* for each column: True==DESC, False==ASC */
2681 const char **azColl; /* Array of collation sequence names for index */
2682 Expr *pPartIdxWhere; /* WHERE clause for partial indices */
2683 ExprList *aColExpr; /* Column expressions */
2684 Pgno tnum; /* DB Page containing root of this index */
2685 LogEst szIdxRow; /* Estimated average row size in bytes */
2686 u16 nKeyCol; /* Number of columns forming the key */
2687 u16 nColumn; /* Number of columns stored in the index */
2688 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
2689 unsigned idxType:2; /* 0:Normal 1:UNIQUE, 2:PRIMARY KEY, 3:IPK */
2690 unsigned bUnordered:1; /* Use this index for == or IN queries only */
2691 unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */
2692 unsigned isResized:1; /* True if resizeIndexObject() has been called */
2693 unsigned isCovering:1; /* True if this is a covering index */
2694 unsigned noSkipScan:1; /* Do not try to use skip-scan if true */
2695 unsigned hasStat1:1; /* aiRowLogEst values come from sqlite_stat1 */
2696 unsigned bNoQuery:1; /* Do not use this index to optimize queries */
2697 unsigned bAscKeyBug:1; /* True if the bba7b69f9849b5bf bug applies */
2698 unsigned bHasVCol:1; /* Index references one or more VIRTUAL columns */
2699 unsigned bHasExpr:1; /* Index contains an expression, either a literal
2700 ** expression, or a reference to a VIRTUAL column */
2701 #ifdef SQLITE_ENABLE_STAT4
2702 int nSample; /* Number of elements in aSample[] */
2703 int mxSample; /* Number of slots allocated to aSample[] */
2704 int nSampleCol; /* Size of IndexSample.anEq[] and so on */
2705 tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */
2706 IndexSample *aSample; /* Samples of the left-most key */
2707 tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */
2708 tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */
2709 #endif
2710 Bitmask colNotIdxed; /* Unindexed columns in pTab */
2714 ** Allowed values for Index.idxType
2716 #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */
2717 #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */
2718 #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */
2719 #define SQLITE_IDXTYPE_IPK 3 /* INTEGER PRIMARY KEY index */
2721 /* Return true if index X is a PRIMARY KEY index */
2722 #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
2724 /* Return true if index X is a UNIQUE index */
2725 #define IsUniqueIndex(X) ((X)->onError!=OE_None)
2727 /* The Index.aiColumn[] values are normally positive integer. But
2728 ** there are some negative values that have special meaning:
2730 #define XN_ROWID (-1) /* Indexed column is the rowid */
2731 #define XN_EXPR (-2) /* Indexed column is an expression */
2734 ** Each sample stored in the sqlite_stat4 table is represented in memory
2735 ** using a structure of this type. See documentation at the top of the
2736 ** analyze.c source file for additional information.
2738 struct IndexSample {
2739 void *p; /* Pointer to sampled record */
2740 int n; /* Size of record in bytes */
2741 tRowcnt *anEq; /* Est. number of rows where the key equals this sample */
2742 tRowcnt *anLt; /* Est. number of rows where key is less than this sample */
2743 tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */
2747 ** Possible values to use within the flags argument to sqlite3GetToken().
2749 #define SQLITE_TOKEN_QUOTED 0x1 /* Token is a quoted identifier. */
2750 #define SQLITE_TOKEN_KEYWORD 0x2 /* Token is a keyword. */
2753 ** Each token coming out of the lexer is an instance of
2754 ** this structure. Tokens are also used as part of an expression.
2756 ** The memory that "z" points to is owned by other objects. Take care
2757 ** that the owner of the "z" string does not deallocate the string before
2758 ** the Token goes out of scope! Very often, the "z" points to some place
2759 ** in the middle of the Parse.zSql text. But it might also point to a
2760 ** static string.
2762 struct Token {
2763 const char *z; /* Text of the token. Not NULL-terminated! */
2764 unsigned int n; /* Number of characters in this token */
2768 ** An instance of this structure contains information needed to generate
2769 ** code for a SELECT that contains aggregate functions.
2771 ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
2772 ** pointer to this structure. The Expr.iAgg field is the index in
2773 ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
2774 ** code for that node.
2776 ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
2777 ** original Select structure that describes the SELECT statement. These
2778 ** fields do not need to be freed when deallocating the AggInfo structure.
2780 struct AggInfo {
2781 u8 directMode; /* Direct rendering mode means take data directly
2782 ** from source tables rather than from accumulators */
2783 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
2784 ** than the source table */
2785 u16 nSortingColumn; /* Number of columns in the sorting index */
2786 int sortingIdx; /* Cursor number of the sorting index */
2787 int sortingIdxPTab; /* Cursor number of pseudo-table */
2788 int iFirstReg; /* First register in range for aCol[] and aFunc[] */
2789 ExprList *pGroupBy; /* The group by clause */
2790 struct AggInfo_col { /* For each column used in source tables */
2791 Table *pTab; /* Source table */
2792 Expr *pCExpr; /* The original expression */
2793 int iTable; /* Cursor number of the source table */
2794 i16 iColumn; /* Column number within the source table */
2795 i16 iSorterColumn; /* Column number in the sorting index */
2796 } *aCol;
2797 int nColumn; /* Number of used entries in aCol[] */
2798 int nAccumulator; /* Number of columns that show through to the output.
2799 ** Additional columns are used only as parameters to
2800 ** aggregate functions */
2801 struct AggInfo_func { /* For each aggregate function */
2802 Expr *pFExpr; /* Expression encoding the function */
2803 FuncDef *pFunc; /* The aggregate function implementation */
2804 int iDistinct; /* Ephemeral table used to enforce DISTINCT */
2805 int iDistAddr; /* Address of OP_OpenEphemeral */
2806 } *aFunc;
2807 int nFunc; /* Number of entries in aFunc[] */
2808 u32 selId; /* Select to which this AggInfo belongs */
2809 #ifdef SQLITE_DEBUG
2810 Select *pSelect; /* SELECT statement that this AggInfo supports */
2811 #endif
2815 ** Macros to compute aCol[] and aFunc[] register numbers.
2817 ** These macros should not be used prior to the call to
2818 ** assignAggregateRegisters() that computes the value of pAggInfo->iFirstReg.
2819 ** The assert()s that are part of this macro verify that constraint.
2821 #define AggInfoColumnReg(A,I) (assert((A)->iFirstReg),(A)->iFirstReg+(I))
2822 #define AggInfoFuncReg(A,I) \
2823 (assert((A)->iFirstReg),(A)->iFirstReg+(A)->nColumn+(I))
2826 ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
2827 ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater
2828 ** than 32767 we have to make it 32-bit. 16-bit is preferred because
2829 ** it uses less memory in the Expr object, which is a big memory user
2830 ** in systems with lots of prepared statements. And few applications
2831 ** need more than about 10 or 20 variables. But some extreme users want
2832 ** to have prepared statements with over 32766 variables, and for them
2833 ** the option is available (at compile-time).
2835 #if SQLITE_MAX_VARIABLE_NUMBER<32767
2836 typedef i16 ynVar;
2837 #else
2838 typedef int ynVar;
2839 #endif
2842 ** Each node of an expression in the parse tree is an instance
2843 ** of this structure.
2845 ** Expr.op is the opcode. The integer parser token codes are reused
2846 ** as opcodes here. For example, the parser defines TK_GE to be an integer
2847 ** code representing the ">=" operator. This same integer code is reused
2848 ** to represent the greater-than-or-equal-to operator in the expression
2849 ** tree.
2851 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
2852 ** or TK_STRING), then Expr.u.zToken contains the text of the SQL literal. If
2853 ** the expression is a variable (TK_VARIABLE), then Expr.u.zToken contains the
2854 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
2855 ** then Expr.u.zToken contains the name of the function.
2857 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
2858 ** binary operator. Either or both may be NULL.
2860 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
2861 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
2862 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
2863 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
2864 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
2865 ** valid.
2867 ** An expression of the form ID or ID.ID refers to a column in a table.
2868 ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
2869 ** the integer cursor number of a VDBE cursor pointing to that table and
2870 ** Expr.iColumn is the column number for the specific column. If the
2871 ** expression is used as a result in an aggregate SELECT, then the
2872 ** value is also stored in the Expr.iAgg column in the aggregate so that
2873 ** it can be accessed after all aggregates are computed.
2875 ** If the expression is an unbound variable marker (a question mark
2876 ** character '?' in the original SQL) then the Expr.iTable holds the index
2877 ** number for that variable.
2879 ** If the expression is a subquery then Expr.iColumn holds an integer
2880 ** register number containing the result of the subquery. If the
2881 ** subquery gives a constant result, then iTable is -1. If the subquery
2882 ** gives a different answer at different times during statement processing
2883 ** then iTable is the address of a subroutine that computes the subquery.
2885 ** If the Expr is of type OP_Column, and the table it is selecting from
2886 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
2887 ** corresponding table definition.
2889 ** ALLOCATION NOTES:
2891 ** Expr objects can use a lot of memory space in database schema. To
2892 ** help reduce memory requirements, sometimes an Expr object will be
2893 ** truncated. And to reduce the number of memory allocations, sometimes
2894 ** two or more Expr objects will be stored in a single memory allocation,
2895 ** together with Expr.u.zToken strings.
2897 ** If the EP_Reduced and EP_TokenOnly flags are set when
2898 ** an Expr object is truncated. When EP_Reduced is set, then all
2899 ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
2900 ** are contained within the same memory allocation. Note, however, that
2901 ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
2902 ** allocated, regardless of whether or not EP_Reduced is set.
2904 struct Expr {
2905 u8 op; /* Operation performed by this node */
2906 char affExpr; /* affinity, or RAISE type */
2907 u8 op2; /* TK_REGISTER/TK_TRUTH: original value of Expr.op
2908 ** TK_COLUMN: the value of p5 for OP_Column
2909 ** TK_AGG_FUNCTION: nesting depth
2910 ** TK_FUNCTION: NC_SelfRef flag if needs OP_PureFunc */
2911 #ifdef SQLITE_DEBUG
2912 u8 vvaFlags; /* Verification flags. */
2913 #endif
2914 u32 flags; /* Various flags. EP_* See below */
2915 union {
2916 char *zToken; /* Token value. Zero terminated and dequoted */
2917 int iValue; /* Non-negative integer value if EP_IntValue */
2918 } u;
2920 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
2921 ** space is allocated for the fields below this point. An attempt to
2922 ** access them will result in a segfault or malfunction.
2923 *********************************************************************/
2925 Expr *pLeft; /* Left subnode */
2926 Expr *pRight; /* Right subnode */
2927 union {
2928 ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
2929 Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */
2930 } x;
2932 /* If the EP_Reduced flag is set in the Expr.flags mask, then no
2933 ** space is allocated for the fields below this point. An attempt to
2934 ** access them will result in a segfault or malfunction.
2935 *********************************************************************/
2937 #if SQLITE_MAX_EXPR_DEPTH>0
2938 int nHeight; /* Height of the tree headed by this node */
2939 #endif
2940 int iTable; /* TK_COLUMN: cursor number of table holding column
2941 ** TK_REGISTER: register number
2942 ** TK_TRIGGER: 1 -> new, 0 -> old
2943 ** EP_Unlikely: 134217728 times likelihood
2944 ** TK_IN: ephemerial table holding RHS
2945 ** TK_SELECT_COLUMN: Number of columns on the LHS
2946 ** TK_SELECT: 1st register of result vector */
2947 ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid.
2948 ** TK_VARIABLE: variable number (always >= 1).
2949 ** TK_SELECT_COLUMN: column of the result vector */
2950 i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
2951 union {
2952 int iJoin; /* If EP_OuterON or EP_InnerON, the right table */
2953 int iOfst; /* else: start of token from start of statement */
2954 } w;
2955 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
2956 union {
2957 Table *pTab; /* TK_COLUMN: Table containing column. Can be NULL
2958 ** for a column of an index on an expression */
2959 Window *pWin; /* EP_WinFunc: Window/Filter defn for a function */
2960 struct { /* TK_IN, TK_SELECT, and TK_EXISTS */
2961 int iAddr; /* Subroutine entry address */
2962 int regReturn; /* Register used to hold return address */
2963 } sub;
2964 } y;
2967 /* The following are the meanings of bits in the Expr.flags field.
2968 ** Value restrictions:
2970 ** EP_Agg == NC_HasAgg == SF_HasAgg
2971 ** EP_Win == NC_HasWin
2973 #define EP_OuterON 0x000001 /* Originates in ON/USING clause of outer join */
2974 #define EP_InnerON 0x000002 /* Originates in ON/USING of an inner join */
2975 #define EP_Distinct 0x000004 /* Aggregate function with DISTINCT keyword */
2976 #define EP_HasFunc 0x000008 /* Contains one or more functions of any kind */
2977 #define EP_Agg 0x000010 /* Contains one or more aggregate functions */
2978 #define EP_FixedCol 0x000020 /* TK_Column with a known fixed value */
2979 #define EP_VarSelect 0x000040 /* pSelect is correlated, not constant */
2980 #define EP_DblQuoted 0x000080 /* token.z was originally in "..." */
2981 #define EP_InfixFunc 0x000100 /* True for an infix function: LIKE, GLOB, etc */
2982 #define EP_Collate 0x000200 /* Tree contains a TK_COLLATE operator */
2983 #define EP_Commuted 0x000400 /* Comparison operator has been commuted */
2984 #define EP_IntValue 0x000800 /* Integer value contained in u.iValue */
2985 #define EP_xIsSelect 0x001000 /* x.pSelect is valid (otherwise x.pList is) */
2986 #define EP_Skip 0x002000 /* Operator does not contribute to affinity */
2987 #define EP_Reduced 0x004000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
2988 #define EP_Win 0x008000 /* Contains window functions */
2989 #define EP_TokenOnly 0x010000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
2990 /* 0x020000 // Available for reuse */
2991 #define EP_IfNullRow 0x040000 /* The TK_IF_NULL_ROW opcode */
2992 #define EP_Unlikely 0x080000 /* unlikely() or likelihood() function */
2993 #define EP_ConstFunc 0x100000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */
2994 #define EP_CanBeNull 0x200000 /* Can be null despite NOT NULL constraint */
2995 #define EP_Subquery 0x400000 /* Tree contains a TK_SELECT operator */
2996 #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */
2997 #define EP_WinFunc 0x1000000 /* TK_FUNCTION with Expr.y.pWin set */
2998 #define EP_Subrtn 0x2000000 /* Uses Expr.y.sub. TK_IN, _SELECT, or _EXISTS */
2999 #define EP_Quoted 0x4000000 /* TK_ID was originally quoted */
3000 #define EP_Static 0x8000000 /* Held in memory not obtained from malloc() */
3001 #define EP_IsTrue 0x10000000 /* Always has boolean value of TRUE */
3002 #define EP_IsFalse 0x20000000 /* Always has boolean value of FALSE */
3003 #define EP_FromDDL 0x40000000 /* Originates from sqlite_schema */
3004 /* 0x80000000 // Available */
3006 /* The EP_Propagate mask is a set of properties that automatically propagate
3007 ** upwards into parent nodes.
3009 #define EP_Propagate (EP_Collate|EP_Subquery|EP_HasFunc)
3011 /* Macros can be used to test, set, or clear bits in the
3012 ** Expr.flags field.
3014 #define ExprHasProperty(E,P) (((E)->flags&(P))!=0)
3015 #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P))
3016 #define ExprSetProperty(E,P) (E)->flags|=(P)
3017 #define ExprClearProperty(E,P) (E)->flags&=~(P)
3018 #define ExprAlwaysTrue(E) (((E)->flags&(EP_OuterON|EP_IsTrue))==EP_IsTrue)
3019 #define ExprAlwaysFalse(E) (((E)->flags&(EP_OuterON|EP_IsFalse))==EP_IsFalse)
3021 /* Macros used to ensure that the correct members of unions are accessed
3022 ** in Expr.
3024 #define ExprUseUToken(E) (((E)->flags&EP_IntValue)==0)
3025 #define ExprUseUValue(E) (((E)->flags&EP_IntValue)!=0)
3026 #define ExprUseXList(E) (((E)->flags&EP_xIsSelect)==0)
3027 #define ExprUseXSelect(E) (((E)->flags&EP_xIsSelect)!=0)
3028 #define ExprUseYTab(E) (((E)->flags&(EP_WinFunc|EP_Subrtn))==0)
3029 #define ExprUseYWin(E) (((E)->flags&EP_WinFunc)!=0)
3030 #define ExprUseYSub(E) (((E)->flags&EP_Subrtn)!=0)
3032 /* Flags for use with Expr.vvaFlags
3034 #define EP_NoReduce 0x01 /* Cannot EXPRDUP_REDUCE this Expr */
3035 #define EP_Immutable 0x02 /* Do not change this Expr node */
3037 /* The ExprSetVVAProperty() macro is used for Verification, Validation,
3038 ** and Accreditation only. It works like ExprSetProperty() during VVA
3039 ** processes but is a no-op for delivery.
3041 #ifdef SQLITE_DEBUG
3042 # define ExprSetVVAProperty(E,P) (E)->vvaFlags|=(P)
3043 # define ExprHasVVAProperty(E,P) (((E)->vvaFlags&(P))!=0)
3044 # define ExprClearVVAProperties(E) (E)->vvaFlags = 0
3045 #else
3046 # define ExprSetVVAProperty(E,P)
3047 # define ExprHasVVAProperty(E,P) 0
3048 # define ExprClearVVAProperties(E)
3049 #endif
3052 ** Macros to determine the number of bytes required by a normal Expr
3053 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
3054 ** and an Expr struct with the EP_TokenOnly flag set.
3056 #define EXPR_FULLSIZE sizeof(Expr) /* Full size */
3057 #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */
3058 #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */
3061 ** Flags passed to the sqlite3ExprDup() function. See the header comment
3062 ** above sqlite3ExprDup() for details.
3064 #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */
3067 ** True if the expression passed as an argument was a function with
3068 ** an OVER() clause (a window function).
3070 #ifdef SQLITE_OMIT_WINDOWFUNC
3071 # define IsWindowFunc(p) 0
3072 #else
3073 # define IsWindowFunc(p) ( \
3074 ExprHasProperty((p), EP_WinFunc) && p->y.pWin->eFrmType!=TK_FILTER \
3076 #endif
3079 ** A list of expressions. Each expression may optionally have a
3080 ** name. An expr/name combination can be used in several ways, such
3081 ** as the list of "expr AS ID" fields following a "SELECT" or in the
3082 ** list of "ID = expr" items in an UPDATE. A list of expressions can
3083 ** also be used as the argument to a function, in which case the a.zName
3084 ** field is not used.
3086 ** In order to try to keep memory usage down, the Expr.a.zEName field
3087 ** is used for multiple purposes:
3089 ** eEName Usage
3090 ** ---------- -------------------------
3091 ** ENAME_NAME (1) the AS of result set column
3092 ** (2) COLUMN= of an UPDATE
3094 ** ENAME_TAB DB.TABLE.NAME used to resolve names
3095 ** of subqueries
3097 ** ENAME_SPAN Text of the original result set
3098 ** expression.
3100 struct ExprList {
3101 int nExpr; /* Number of expressions on the list */
3102 int nAlloc; /* Number of a[] slots allocated */
3103 struct ExprList_item { /* For each expression in the list */
3104 Expr *pExpr; /* The parse tree for this expression */
3105 char *zEName; /* Token associated with this expression */
3106 struct {
3107 u8 sortFlags; /* Mask of KEYINFO_ORDER_* flags */
3108 unsigned eEName :2; /* Meaning of zEName */
3109 unsigned done :1; /* Indicates when processing is finished */
3110 unsigned reusable :1; /* Constant expression is reusable */
3111 unsigned bSorterRef :1; /* Defer evaluation until after sorting */
3112 unsigned bNulls :1; /* True if explicit "NULLS FIRST/LAST" */
3113 unsigned bUsed :1; /* This column used in a SF_NestedFrom subquery */
3114 unsigned bUsingTerm:1; /* Term from the USING clause of a NestedFrom */
3115 unsigned bNoExpand: 1; /* Term is an auxiliary in NestedFrom and should
3116 ** not be expanded by "*" in parent queries */
3117 } fg;
3118 union {
3119 struct { /* Used by any ExprList other than Parse.pConsExpr */
3120 u16 iOrderByCol; /* For ORDER BY, column number in result set */
3121 u16 iAlias; /* Index into Parse.aAlias[] for zName */
3122 } x;
3123 int iConstExprReg; /* Register in which Expr value is cached. Used only
3124 ** by Parse.pConstExpr */
3125 } u;
3126 } a[1]; /* One slot for each expression in the list */
3130 ** Allowed values for Expr.a.eEName
3132 #define ENAME_NAME 0 /* The AS clause of a result set */
3133 #define ENAME_SPAN 1 /* Complete text of the result set expression */
3134 #define ENAME_TAB 2 /* "DB.TABLE.NAME" for the result set */
3137 ** An instance of this structure can hold a simple list of identifiers,
3138 ** such as the list "a,b,c" in the following statements:
3140 ** INSERT INTO t(a,b,c) VALUES ...;
3141 ** CREATE INDEX idx ON t(a,b,c);
3142 ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
3144 ** The IdList.a.idx field is used when the IdList represents the list of
3145 ** column names after a table name in an INSERT statement. In the statement
3147 ** INSERT INTO t(a,b,c) ...
3149 ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
3151 struct IdList {
3152 int nId; /* Number of identifiers on the list */
3153 u8 eU4; /* Which element of a.u4 is valid */
3154 struct IdList_item {
3155 char *zName; /* Name of the identifier */
3156 union {
3157 int idx; /* Index in some Table.aCol[] of a column named zName */
3158 Expr *pExpr; /* Expr to implement a USING variable -- NOT USED */
3159 } u4;
3160 } a[1];
3164 ** Allowed values for IdList.eType, which determines which value of the a.u4
3165 ** is valid.
3167 #define EU4_NONE 0 /* Does not use IdList.a.u4 */
3168 #define EU4_IDX 1 /* Uses IdList.a.u4.idx */
3169 #define EU4_EXPR 2 /* Uses IdList.a.u4.pExpr -- NOT CURRENTLY USED */
3172 ** The SrcItem object represents a single term in the FROM clause of a query.
3173 ** The SrcList object is mostly an array of SrcItems.
3175 ** The jointype starts out showing the join type between the current table
3176 ** and the next table on the list. The parser builds the list this way.
3177 ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
3178 ** jointype expresses the join between the table and the previous table.
3180 ** In the colUsed field, the high-order bit (bit 63) is set if the table
3181 ** contains more than 63 columns and the 64-th or later column is used.
3183 ** Union member validity:
3185 ** u1.zIndexedBy fg.isIndexedBy && !fg.isTabFunc
3186 ** u1.pFuncArg fg.isTabFunc && !fg.isIndexedBy
3187 ** u2.pIBIndex fg.isIndexedBy && !fg.isCte
3188 ** u2.pCteUse fg.isCte && !fg.isIndexedBy
3190 struct SrcItem {
3191 Schema *pSchema; /* Schema to which this item is fixed */
3192 char *zDatabase; /* Name of database holding this table */
3193 char *zName; /* Name of the table */
3194 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
3195 Table *pTab; /* An SQL table corresponding to zName */
3196 Select *pSelect; /* A SELECT statement used in place of a table name */
3197 int addrFillSub; /* Address of subroutine to manifest a subquery */
3198 int regReturn; /* Register holding return address of addrFillSub */
3199 int regResult; /* Registers holding results of a co-routine */
3200 struct {
3201 u8 jointype; /* Type of join between this table and the previous */
3202 unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */
3203 unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */
3204 unsigned isTabFunc :1; /* True if table-valued-function syntax */
3205 unsigned isCorrelated :1; /* True if sub-query is correlated */
3206 unsigned isMaterialized:1; /* This is a materialized view */
3207 unsigned viaCoroutine :1; /* Implemented as a co-routine */
3208 unsigned isRecursive :1; /* True for recursive reference in WITH */
3209 unsigned fromDDL :1; /* Comes from sqlite_schema */
3210 unsigned isCte :1; /* This is a CTE */
3211 unsigned notCte :1; /* This item may not match a CTE */
3212 unsigned isUsing :1; /* u3.pUsing is valid */
3213 unsigned isOn :1; /* u3.pOn was once valid and non-NULL */
3214 unsigned isSynthUsing :1; /* u3.pUsing is synthensized from NATURAL */
3215 unsigned isNestedFrom :1; /* pSelect is a SF_NestedFrom subquery */
3216 } fg;
3217 int iCursor; /* The VDBE cursor number used to access this table */
3218 union {
3219 Expr *pOn; /* fg.isUsing==0 => The ON clause of a join */
3220 IdList *pUsing; /* fg.isUsing==1 => The USING clause of a join */
3221 } u3;
3222 Bitmask colUsed; /* Bit N set if column N used. Details above for N>62 */
3223 union {
3224 char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */
3225 ExprList *pFuncArg; /* Arguments to table-valued-function */
3226 } u1;
3227 union {
3228 Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */
3229 CteUse *pCteUse; /* CTE Usage info when fg.isCte is true */
3230 } u2;
3234 ** The OnOrUsing object represents either an ON clause or a USING clause.
3235 ** It can never be both at the same time, but it can be neither.
3237 struct OnOrUsing {
3238 Expr *pOn; /* The ON clause of a join */
3239 IdList *pUsing; /* The USING clause of a join */
3243 ** This object represents one or more tables that are the source of
3244 ** content for an SQL statement. For example, a single SrcList object
3245 ** is used to hold the FROM clause of a SELECT statement. SrcList also
3246 ** represents the target tables for DELETE, INSERT, and UPDATE statements.
3249 struct SrcList {
3250 int nSrc; /* Number of tables or subqueries in the FROM clause */
3251 u32 nAlloc; /* Number of entries allocated in a[] below */
3252 SrcItem a[1]; /* One entry for each identifier on the list */
3256 ** Permitted values of the SrcList.a.jointype field
3258 #define JT_INNER 0x01 /* Any kind of inner or cross join */
3259 #define JT_CROSS 0x02 /* Explicit use of the CROSS keyword */
3260 #define JT_NATURAL 0x04 /* True for a "natural" join */
3261 #define JT_LEFT 0x08 /* Left outer join */
3262 #define JT_RIGHT 0x10 /* Right outer join */
3263 #define JT_OUTER 0x20 /* The "OUTER" keyword is present */
3264 #define JT_LTORJ 0x40 /* One of the LEFT operands of a RIGHT JOIN
3265 ** Mnemonic: Left Table Of Right Join */
3266 #define JT_ERROR 0x80 /* unknown or unsupported join type */
3269 ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
3270 ** and the WhereInfo.wctrlFlags member.
3272 ** Value constraints (enforced via assert()):
3273 ** WHERE_USE_LIMIT == SF_FixedLimit
3275 #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
3276 #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
3277 #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
3278 #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
3279 #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */
3280 #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */
3281 #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of
3282 ** the OR optimization */
3283 #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */
3284 #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */
3285 #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */
3286 #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */
3287 #define WHERE_AGG_DISTINCT 0x0400 /* Query is "SELECT agg(DISTINCT ...)" */
3288 #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */
3289 #define WHERE_RIGHT_JOIN 0x1000 /* Processing a RIGHT JOIN */
3290 /* 0x2000 not currently used */
3291 #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */
3292 /* 0x8000 not currently used */
3294 /* Allowed return values from sqlite3WhereIsDistinct()
3296 #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */
3297 #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */
3298 #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */
3299 #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */
3302 ** A NameContext defines a context in which to resolve table and column
3303 ** names. The context consists of a list of tables (the pSrcList) field and
3304 ** a list of named expression (pEList). The named expression list may
3305 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
3306 ** to the table being operated on by INSERT, UPDATE, or DELETE. The
3307 ** pEList corresponds to the result set of a SELECT and is NULL for
3308 ** other statements.
3310 ** NameContexts can be nested. When resolving names, the inner-most
3311 ** context is searched first. If no match is found, the next outer
3312 ** context is checked. If there is still no match, the next context
3313 ** is checked. This process continues until either a match is found
3314 ** or all contexts are check. When a match is found, the nRef member of
3315 ** the context containing the match is incremented.
3317 ** Each subquery gets a new NameContext. The pNext field points to the
3318 ** NameContext in the parent query. Thus the process of scanning the
3319 ** NameContext list corresponds to searching through successively outer
3320 ** subqueries looking for a match.
3322 struct NameContext {
3323 Parse *pParse; /* The parser */
3324 SrcList *pSrcList; /* One or more tables used to resolve names */
3325 union {
3326 ExprList *pEList; /* Optional list of result-set columns */
3327 AggInfo *pAggInfo; /* Information about aggregates at this level */
3328 Upsert *pUpsert; /* ON CONFLICT clause information from an upsert */
3329 int iBaseReg; /* For TK_REGISTER when parsing RETURNING */
3330 } uNC;
3331 NameContext *pNext; /* Next outer name context. NULL for outermost */
3332 int nRef; /* Number of names resolved by this context */
3333 int nNcErr; /* Number of errors encountered while resolving names */
3334 int ncFlags; /* Zero or more NC_* flags defined below */
3335 Select *pWinSelect; /* SELECT statement for any window functions */
3339 ** Allowed values for the NameContext, ncFlags field.
3341 ** Value constraints (all checked via assert()):
3342 ** NC_HasAgg == SF_HasAgg == EP_Agg
3343 ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX
3344 ** NC_OrderAgg == SF_OrderByReqd == SQLITE_FUNC_ANYORDER
3345 ** NC_HasWin == EP_Win
3348 #define NC_AllowAgg 0x000001 /* Aggregate functions are allowed here */
3349 #define NC_PartIdx 0x000002 /* True if resolving a partial index WHERE */
3350 #define NC_IsCheck 0x000004 /* True if resolving a CHECK constraint */
3351 #define NC_GenCol 0x000008 /* True for a GENERATED ALWAYS AS clause */
3352 #define NC_HasAgg 0x000010 /* One or more aggregate functions seen */
3353 #define NC_IdxExpr 0x000020 /* True if resolving columns of CREATE INDEX */
3354 #define NC_SelfRef 0x00002e /* Combo: PartIdx, isCheck, GenCol, and IdxExpr */
3355 #define NC_Subquery 0x000040 /* A subquery has been seen */
3356 #define NC_UEList 0x000080 /* True if uNC.pEList is used */
3357 #define NC_UAggInfo 0x000100 /* True if uNC.pAggInfo is used */
3358 #define NC_UUpsert 0x000200 /* True if uNC.pUpsert is used */
3359 #define NC_UBaseReg 0x000400 /* True if uNC.iBaseReg is used */
3360 #define NC_MinMaxAgg 0x001000 /* min/max aggregates seen. See note above */
3361 #define NC_Complex 0x002000 /* True if a function or subquery seen */
3362 #define NC_AllowWin 0x004000 /* Window functions are allowed here */
3363 #define NC_HasWin 0x008000 /* One or more window functions seen */
3364 #define NC_IsDDL 0x010000 /* Resolving names in a CREATE statement */
3365 #define NC_InAggFunc 0x020000 /* True if analyzing arguments to an agg func */
3366 #define NC_FromDDL 0x040000 /* SQL text comes from sqlite_schema */
3367 #define NC_NoSelect 0x080000 /* Do not descend into sub-selects */
3368 #define NC_OrderAgg 0x8000000 /* Has an aggregate other than count/min/max */
3371 ** An instance of the following object describes a single ON CONFLICT
3372 ** clause in an upsert.
3374 ** The pUpsertTarget field is only set if the ON CONFLICT clause includes
3375 ** conflict-target clause. (In "ON CONFLICT(a,b)" the "(a,b)" is the
3376 ** conflict-target clause.) The pUpsertTargetWhere is the optional
3377 ** WHERE clause used to identify partial unique indexes.
3379 ** pUpsertSet is the list of column=expr terms of the UPDATE statement.
3380 ** The pUpsertSet field is NULL for a ON CONFLICT DO NOTHING. The
3381 ** pUpsertWhere is the WHERE clause for the UPDATE and is NULL if the
3382 ** WHERE clause is omitted.
3384 struct Upsert {
3385 ExprList *pUpsertTarget; /* Optional description of conflict target */
3386 Expr *pUpsertTargetWhere; /* WHERE clause for partial index targets */
3387 ExprList *pUpsertSet; /* The SET clause from an ON CONFLICT UPDATE */
3388 Expr *pUpsertWhere; /* WHERE clause for the ON CONFLICT UPDATE */
3389 Upsert *pNextUpsert; /* Next ON CONFLICT clause in the list */
3390 u8 isDoUpdate; /* True for DO UPDATE. False for DO NOTHING */
3391 /* Above this point is the parse tree for the ON CONFLICT clauses.
3392 ** The next group of fields stores intermediate data. */
3393 void *pToFree; /* Free memory when deleting the Upsert object */
3394 /* All fields above are owned by the Upsert object and must be freed
3395 ** when the Upsert is destroyed. The fields below are used to transfer
3396 ** information from the INSERT processing down into the UPDATE processing
3397 ** while generating code. The fields below are owned by the INSERT
3398 ** statement and will be freed by INSERT processing. */
3399 Index *pUpsertIdx; /* UNIQUE constraint specified by pUpsertTarget */
3400 SrcList *pUpsertSrc; /* Table to be updated */
3401 int regData; /* First register holding array of VALUES */
3402 int iDataCur; /* Index of the data cursor */
3403 int iIdxCur; /* Index of the first index cursor */
3407 ** An instance of the following structure contains all information
3408 ** needed to generate code for a single SELECT statement.
3410 ** See the header comment on the computeLimitRegisters() routine for a
3411 ** detailed description of the meaning of the iLimit and iOffset fields.
3413 ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
3414 ** These addresses must be stored so that we can go back and fill in
3415 ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
3416 ** the number of columns in P2 can be computed at the same time
3417 ** as the OP_OpenEphm instruction is coded because not
3418 ** enough information about the compound query is known at that point.
3419 ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
3420 ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating
3421 ** sequences for the ORDER BY clause.
3423 struct Select {
3424 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
3425 LogEst nSelectRow; /* Estimated number of result rows */
3426 u32 selFlags; /* Various SF_* values */
3427 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
3428 u32 selId; /* Unique identifier number for this SELECT */
3429 int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */
3430 ExprList *pEList; /* The fields of the result */
3431 SrcList *pSrc; /* The FROM clause */
3432 Expr *pWhere; /* The WHERE clause */
3433 ExprList *pGroupBy; /* The GROUP BY clause */
3434 Expr *pHaving; /* The HAVING clause */
3435 ExprList *pOrderBy; /* The ORDER BY clause */
3436 Select *pPrior; /* Prior select in a compound select statement */
3437 Select *pNext; /* Next select to the left in a compound */
3438 Expr *pLimit; /* LIMIT expression. NULL means not used. */
3439 With *pWith; /* WITH clause attached to this select. Or NULL. */
3440 #ifndef SQLITE_OMIT_WINDOWFUNC
3441 Window *pWin; /* List of window functions */
3442 Window *pWinDefn; /* List of named window definitions */
3443 #endif
3447 ** Allowed values for Select.selFlags. The "SF" prefix stands for
3448 ** "Select Flag".
3450 ** Value constraints (all checked via assert())
3451 ** SF_HasAgg == NC_HasAgg
3452 ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX
3453 ** SF_OrderByReqd == NC_OrderAgg == SQLITE_FUNC_ANYORDER
3454 ** SF_FixedLimit == WHERE_USE_LIMIT
3456 #define SF_Distinct 0x0000001 /* Output should be DISTINCT */
3457 #define SF_All 0x0000002 /* Includes the ALL keyword */
3458 #define SF_Resolved 0x0000004 /* Identifiers have been resolved */
3459 #define SF_Aggregate 0x0000008 /* Contains agg functions or a GROUP BY */
3460 #define SF_HasAgg 0x0000010 /* Contains aggregate functions */
3461 #define SF_UsesEphemeral 0x0000020 /* Uses the OpenEphemeral opcode */
3462 #define SF_Expanded 0x0000040 /* sqlite3SelectExpand() called on this */
3463 #define SF_HasTypeInfo 0x0000080 /* FROM subqueries have Table metadata */
3464 #define SF_Compound 0x0000100 /* Part of a compound query */
3465 #define SF_Values 0x0000200 /* Synthesized from VALUES clause */
3466 #define SF_MultiValue 0x0000400 /* Single VALUES term with multiple rows */
3467 #define SF_NestedFrom 0x0000800 /* Part of a parenthesized FROM clause */
3468 #define SF_MinMaxAgg 0x0001000 /* Aggregate containing min() or max() */
3469 #define SF_Recursive 0x0002000 /* The recursive part of a recursive CTE */
3470 #define SF_FixedLimit 0x0004000 /* nSelectRow set by a constant LIMIT */
3471 #define SF_MaybeConvert 0x0008000 /* Need convertCompoundSelectToSubquery() */
3472 #define SF_Converted 0x0010000 /* By convertCompoundSelectToSubquery() */
3473 #define SF_IncludeHidden 0x0020000 /* Include hidden columns in output */
3474 #define SF_ComplexResult 0x0040000 /* Result contains subquery or function */
3475 #define SF_WhereBegin 0x0080000 /* Really a WhereBegin() call. Debug Only */
3476 #define SF_WinRewrite 0x0100000 /* Window function rewrite accomplished */
3477 #define SF_View 0x0200000 /* SELECT statement is a view */
3478 #define SF_NoopOrderBy 0x0400000 /* ORDER BY is ignored for this query */
3479 #define SF_UFSrcCheck 0x0800000 /* Check pSrc as required by UPDATE...FROM */
3480 #define SF_PushDown 0x1000000 /* SELECT has be modified by push-down opt */
3481 #define SF_MultiPart 0x2000000 /* Has multiple incompatible PARTITIONs */
3482 #define SF_CopyCte 0x4000000 /* SELECT statement is a copy of a CTE */
3483 #define SF_OrderByReqd 0x8000000 /* The ORDER BY clause may not be omitted */
3484 #define SF_UpdateFrom 0x10000000 /* Query originates with UPDATE FROM */
3486 /* True if S exists and has SF_NestedFrom */
3487 #define IsNestedFrom(S) ((S)!=0 && ((S)->selFlags&SF_NestedFrom)!=0)
3490 ** The results of a SELECT can be distributed in several ways, as defined
3491 ** by one of the following macros. The "SRT" prefix means "SELECT Result
3492 ** Type".
3494 ** SRT_Union Store results as a key in a temporary index
3495 ** identified by pDest->iSDParm.
3497 ** SRT_Except Remove results from the temporary index pDest->iSDParm.
3499 ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result
3500 ** set is not empty.
3502 ** SRT_Discard Throw the results away. This is used by SELECT
3503 ** statements within triggers whose only purpose is
3504 ** the side-effects of functions.
3506 ** SRT_Output Generate a row of output (using the OP_ResultRow
3507 ** opcode) for each row in the result set.
3509 ** SRT_Mem Only valid if the result is a single column.
3510 ** Store the first column of the first result row
3511 ** in register pDest->iSDParm then abandon the rest
3512 ** of the query. This destination implies "LIMIT 1".
3514 ** SRT_Set The result must be a single column. Store each
3515 ** row of result as the key in table pDest->iSDParm.
3516 ** Apply the affinity pDest->affSdst before storing
3517 ** results. Used to implement "IN (SELECT ...)".
3519 ** SRT_EphemTab Create an temporary table pDest->iSDParm and store
3520 ** the result there. The cursor is left open after
3521 ** returning. This is like SRT_Table except that
3522 ** this destination uses OP_OpenEphemeral to create
3523 ** the table first.
3525 ** SRT_Coroutine Generate a co-routine that returns a new row of
3526 ** results each time it is invoked. The entry point
3527 ** of the co-routine is stored in register pDest->iSDParm
3528 ** and the result row is stored in pDest->nDest registers
3529 ** starting with pDest->iSdst.
3531 ** SRT_Table Store results in temporary table pDest->iSDParm.
3532 ** SRT_Fifo This is like SRT_EphemTab except that the table
3533 ** is assumed to already be open. SRT_Fifo has
3534 ** the additional property of being able to ignore
3535 ** the ORDER BY clause.
3537 ** SRT_DistFifo Store results in a temporary table pDest->iSDParm.
3538 ** But also use temporary table pDest->iSDParm+1 as
3539 ** a record of all prior results and ignore any duplicate
3540 ** rows. Name means: "Distinct Fifo".
3542 ** SRT_Queue Store results in priority queue pDest->iSDParm (really
3543 ** an index). Append a sequence number so that all entries
3544 ** are distinct.
3546 ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if
3547 ** the same record has never been stored before. The
3548 ** index at pDest->iSDParm+1 hold all prior stores.
3550 ** SRT_Upfrom Store results in the temporary table already opened by
3551 ** pDest->iSDParm. If (pDest->iSDParm<0), then the temp
3552 ** table is an intkey table - in this case the first
3553 ** column returned by the SELECT is used as the integer
3554 ** key. If (pDest->iSDParm>0), then the table is an index
3555 ** table. (pDest->iSDParm) is the number of key columns in
3556 ** each index record in this case.
3558 #define SRT_Union 1 /* Store result as keys in an index */
3559 #define SRT_Except 2 /* Remove result from a UNION index */
3560 #define SRT_Exists 3 /* Store 1 if the result is not empty */
3561 #define SRT_Discard 4 /* Do not save the results anywhere */
3562 #define SRT_DistFifo 5 /* Like SRT_Fifo, but unique results only */
3563 #define SRT_DistQueue 6 /* Like SRT_Queue, but unique results only */
3565 /* The DISTINCT clause is ignored for all of the above. Not that
3566 ** IgnorableDistinct() implies IgnorableOrderby() */
3567 #define IgnorableDistinct(X) ((X->eDest)<=SRT_DistQueue)
3569 #define SRT_Queue 7 /* Store result in an queue */
3570 #define SRT_Fifo 8 /* Store result as data with an automatic rowid */
3572 /* The ORDER BY clause is ignored for all of the above */
3573 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Fifo)
3575 #define SRT_Output 9 /* Output each row of result */
3576 #define SRT_Mem 10 /* Store result in a memory cell */
3577 #define SRT_Set 11 /* Store results as keys in an index */
3578 #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */
3579 #define SRT_Coroutine 13 /* Generate a single row of result */
3580 #define SRT_Table 14 /* Store result as data with an automatic rowid */
3581 #define SRT_Upfrom 15 /* Store result as data with rowid */
3584 ** An instance of this object describes where to put of the results of
3585 ** a SELECT statement.
3587 struct SelectDest {
3588 u8 eDest; /* How to dispose of the results. One of SRT_* above. */
3589 int iSDParm; /* A parameter used by the eDest disposal method */
3590 int iSDParm2; /* A second parameter for the eDest disposal method */
3591 int iSdst; /* Base register where results are written */
3592 int nSdst; /* Number of registers allocated */
3593 char *zAffSdst; /* Affinity used for SRT_Set */
3594 ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */
3598 ** During code generation of statements that do inserts into AUTOINCREMENT
3599 ** tables, the following information is attached to the Table.u.autoInc.p
3600 ** pointer of each autoincrement table to record some side information that
3601 ** the code generator needs. We have to keep per-table autoincrement
3602 ** information in case inserts are done within triggers. Triggers do not
3603 ** normally coordinate their activities, but we do need to coordinate the
3604 ** loading and saving of autoincrement information.
3606 struct AutoincInfo {
3607 AutoincInfo *pNext; /* Next info block in a list of them all */
3608 Table *pTab; /* Table this info block refers to */
3609 int iDb; /* Index in sqlite3.aDb[] of database holding pTab */
3610 int regCtr; /* Memory register holding the rowid counter */
3614 ** At least one instance of the following structure is created for each
3615 ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
3616 ** statement. All such objects are stored in the linked list headed at
3617 ** Parse.pTriggerPrg and deleted once statement compilation has been
3618 ** completed.
3620 ** A Vdbe sub-program that implements the body and WHEN clause of trigger
3621 ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
3622 ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
3623 ** The Parse.pTriggerPrg list never contains two entries with the same
3624 ** values for both pTrigger and orconf.
3626 ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
3627 ** accessed (or set to 0 for triggers fired as a result of INSERT
3628 ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
3629 ** a mask of new.* columns used by the program.
3631 struct TriggerPrg {
3632 Trigger *pTrigger; /* Trigger this program was coded from */
3633 TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */
3634 SubProgram *pProgram; /* Program implementing pTrigger/orconf */
3635 int orconf; /* Default ON CONFLICT policy */
3636 u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */
3640 ** The yDbMask datatype for the bitmask of all attached databases.
3642 #if SQLITE_MAX_ATTACHED>30
3643 typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
3644 # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0)
3645 # define DbMaskZero(M) memset((M),0,sizeof(M))
3646 # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7))
3647 # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M)
3648 # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0)
3649 #else
3650 typedef unsigned int yDbMask;
3651 # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0)
3652 # define DbMaskZero(M) ((M)=0)
3653 # define DbMaskSet(M,I) ((M)|=(((yDbMask)1)<<(I)))
3654 # define DbMaskAllZero(M) ((M)==0)
3655 # define DbMaskNonZero(M) ((M)!=0)
3656 #endif
3659 ** For each index X that has as one of its arguments either an expression
3660 ** or the name of a virtual generated column, and if X is in scope such that
3661 ** the value of the expression can simply be read from the index, then
3662 ** there is an instance of this object on the Parse.pIdxExpr list.
3664 ** During code generation, while generating code to evaluate expressions,
3665 ** this list is consulted and if a matching expression is found, the value
3666 ** is read from the index rather than being recomputed.
3668 struct IndexedExpr {
3669 Expr *pExpr; /* The expression contained in the index */
3670 int iDataCur; /* The data cursor associated with the index */
3671 int iIdxCur; /* The index cursor */
3672 int iIdxCol; /* The index column that contains value of pExpr */
3673 u8 bMaybeNullRow; /* True if we need an OP_IfNullRow check */
3674 u8 aff; /* Affinity of the pExpr expression */
3675 IndexedExpr *pIENext; /* Next in a list of all indexed expressions */
3676 #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
3677 const char *zIdxName; /* Name of index, used only for bytecode comments */
3678 #endif
3682 ** An instance of the ParseCleanup object specifies an operation that
3683 ** should be performed after parsing to deallocation resources obtained
3684 ** during the parse and which are no longer needed.
3686 struct ParseCleanup {
3687 ParseCleanup *pNext; /* Next cleanup task */
3688 void *pPtr; /* Pointer to object to deallocate */
3689 void (*xCleanup)(sqlite3*,void*); /* Deallocation routine */
3693 ** An SQL parser context. A copy of this structure is passed through
3694 ** the parser and down into all the parser action routine in order to
3695 ** carry around information that is global to the entire parse.
3697 ** The structure is divided into two parts. When the parser and code
3698 ** generate call themselves recursively, the first part of the structure
3699 ** is constant but the second part is reset at the beginning and end of
3700 ** each recursion.
3702 ** The nTableLock and aTableLock variables are only used if the shared-cache
3703 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
3704 ** used to store the set of table-locks required by the statement being
3705 ** compiled. Function sqlite3TableLock() is used to add entries to the
3706 ** list.
3708 struct Parse {
3709 sqlite3 *db; /* The main database structure */
3710 char *zErrMsg; /* An error message */
3711 Vdbe *pVdbe; /* An engine for executing database bytecode */
3712 int rc; /* Return code from execution */
3713 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
3714 u8 checkSchema; /* Causes schema cookie check after an error */
3715 u8 nested; /* Number of nested calls to the parser/code generator */
3716 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
3717 u8 isMultiWrite; /* True if statement may modify/insert multiple rows */
3718 u8 mayAbort; /* True if statement may throw an ABORT exception */
3719 u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */
3720 u8 okConstFactor; /* OK to factor out constants */
3721 u8 disableLookaside; /* Number of times lookaside has been disabled */
3722 u8 prepFlags; /* SQLITE_PREPARE_* flags */
3723 u8 withinRJSubrtn; /* Nesting level for RIGHT JOIN body subroutines */
3724 #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
3725 u8 earlyCleanup; /* OOM inside sqlite3ParserAddCleanup() */
3726 #endif
3727 #ifdef SQLITE_DEBUG
3728 u8 ifNotExists; /* Might be true if IF NOT EXISTS. Assert()s only */
3729 #endif
3730 int nRangeReg; /* Size of the temporary register block */
3731 int iRangeReg; /* First register in temporary register block */
3732 int nErr; /* Number of errors seen */
3733 int nTab; /* Number of previously allocated VDBE cursors */
3734 int nMem; /* Number of memory cells used so far */
3735 int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */
3736 int iSelfTab; /* Table associated with an index on expr, or negative
3737 ** of the base register during check-constraint eval */
3738 int nLabel; /* The *negative* of the number of labels used */
3739 int nLabelAlloc; /* Number of slots in aLabel */
3740 int *aLabel; /* Space to hold the labels */
3741 ExprList *pConstExpr;/* Constant expressions */
3742 IndexedExpr *pIdxEpr;/* List of expressions used by active indexes */
3743 Token constraintName;/* Name of the constraint currently being parsed */
3744 yDbMask writeMask; /* Start a write transaction on these databases */
3745 yDbMask cookieMask; /* Bitmask of schema verified databases */
3746 int regRowid; /* Register holding rowid of CREATE TABLE entry */
3747 int regRoot; /* Register holding root page number for new objects */
3748 int nMaxArg; /* Max args passed to user function by sub-program */
3749 int nSelect; /* Number of SELECT stmts. Counter for Select.selId */
3750 #ifndef SQLITE_OMIT_SHARED_CACHE
3751 int nTableLock; /* Number of locks in aTableLock */
3752 TableLock *aTableLock; /* Required table locks for shared-cache mode */
3753 #endif
3754 AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */
3755 Parse *pToplevel; /* Parse structure for main program (or NULL) */
3756 Table *pTriggerTab; /* Table triggers are being coded for */
3757 TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */
3758 ParseCleanup *pCleanup; /* List of cleanup operations to run after parse */
3759 union {
3760 int addrCrTab; /* Address of OP_CreateBtree on CREATE TABLE */
3761 Returning *pReturning; /* The RETURNING clause */
3762 } u1;
3763 u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */
3764 u32 oldmask; /* Mask of old.* columns referenced */
3765 u32 newmask; /* Mask of new.* columns referenced */
3766 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
3767 u32 nProgressSteps; /* xProgress steps taken during sqlite3_prepare() */
3768 #endif
3769 u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */
3770 u8 bReturning; /* Coding a RETURNING trigger */
3771 u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */
3772 u8 disableTriggers; /* True to disable triggers */
3774 /**************************************************************************
3775 ** Fields above must be initialized to zero. The fields that follow,
3776 ** down to the beginning of the recursive section, do not need to be
3777 ** initialized as they will be set before being used. The boundary is
3778 ** determined by offsetof(Parse,aTempReg).
3779 **************************************************************************/
3781 int aTempReg[8]; /* Holding area for temporary registers */
3782 Parse *pOuterParse; /* Outer Parse object when nested */
3783 Token sNameToken; /* Token with unqualified schema object name */
3785 /************************************************************************
3786 ** Above is constant between recursions. Below is reset before and after
3787 ** each recursion. The boundary between these two regions is determined
3788 ** using offsetof(Parse,sLastToken) so the sLastToken field must be the
3789 ** first field in the recursive region.
3790 ************************************************************************/
3792 Token sLastToken; /* The last token parsed */
3793 ynVar nVar; /* Number of '?' variables seen in the SQL so far */
3794 u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */
3795 u8 explain; /* True if the EXPLAIN flag is found on the query */
3796 u8 eParseMode; /* PARSE_MODE_XXX constant */
3797 #ifndef SQLITE_OMIT_VIRTUALTABLE
3798 int nVtabLock; /* Number of virtual tables to lock */
3799 #endif
3800 int nHeight; /* Expression tree height of current sub-select */
3801 #ifndef SQLITE_OMIT_EXPLAIN
3802 int addrExplain; /* Address of current OP_Explain opcode */
3803 #endif
3804 VList *pVList; /* Mapping between variable names and numbers */
3805 Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */
3806 const char *zTail; /* All SQL text past the last semicolon parsed */
3807 Table *pNewTable; /* A table being constructed by CREATE TABLE */
3808 Index *pNewIndex; /* An index being constructed by CREATE INDEX.
3809 ** Also used to hold redundant UNIQUE constraints
3810 ** during a RENAME COLUMN */
3811 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
3812 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
3813 #ifndef SQLITE_OMIT_VIRTUALTABLE
3814 Token sArg; /* Complete text of a module argument */
3815 Table **apVtabLock; /* Pointer to virtual tables needing locking */
3816 #endif
3817 With *pWith; /* Current WITH clause, or NULL */
3818 #ifndef SQLITE_OMIT_ALTERTABLE
3819 RenameToken *pRename; /* Tokens subject to renaming by ALTER TABLE */
3820 #endif
3823 /* Allowed values for Parse.eParseMode
3825 #define PARSE_MODE_NORMAL 0
3826 #define PARSE_MODE_DECLARE_VTAB 1
3827 #define PARSE_MODE_RENAME 2
3828 #define PARSE_MODE_UNMAP 3
3831 ** Sizes and pointers of various parts of the Parse object.
3833 #define PARSE_HDR(X) (((char*)(X))+offsetof(Parse,zErrMsg))
3834 #define PARSE_HDR_SZ (offsetof(Parse,aTempReg)-offsetof(Parse,zErrMsg)) /* Recursive part w/o aColCache*/
3835 #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken) /* Recursive part */
3836 #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */
3837 #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */
3840 ** Return true if currently inside an sqlite3_declare_vtab() call.
3842 #ifdef SQLITE_OMIT_VIRTUALTABLE
3843 #define IN_DECLARE_VTAB 0
3844 #else
3845 #define IN_DECLARE_VTAB (pParse->eParseMode==PARSE_MODE_DECLARE_VTAB)
3846 #endif
3848 #if defined(SQLITE_OMIT_ALTERTABLE)
3849 #define IN_RENAME_OBJECT 0
3850 #else
3851 #define IN_RENAME_OBJECT (pParse->eParseMode>=PARSE_MODE_RENAME)
3852 #endif
3854 #if defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_OMIT_ALTERTABLE)
3855 #define IN_SPECIAL_PARSE 0
3856 #else
3857 #define IN_SPECIAL_PARSE (pParse->eParseMode!=PARSE_MODE_NORMAL)
3858 #endif
3861 ** An instance of the following structure can be declared on a stack and used
3862 ** to save the Parse.zAuthContext value so that it can be restored later.
3864 struct AuthContext {
3865 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
3866 Parse *pParse; /* The Parse structure */
3870 ** Bitfield flags for P5 value in various opcodes.
3872 ** Value constraints (enforced via assert()):
3873 ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH
3874 ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF
3875 ** OPFLAG_BULKCSR == BTREE_BULKLOAD
3876 ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ
3877 ** OPFLAG_FORDELETE == BTREE_FORDELETE
3878 ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION
3879 ** OPFLAG_AUXDELETE == BTREE_AUXDELETE
3881 #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */
3882 /* Also used in P2 (not P5) of OP_Delete */
3883 #define OPFLAG_NOCHNG 0x01 /* OP_VColumn nochange for UPDATE */
3884 #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */
3885 #define OPFLAG_LASTROWID 0x20 /* Set to update db->lastRowid */
3886 #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */
3887 #define OPFLAG_APPEND 0x08 /* This is likely to be an append */
3888 #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */
3889 #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */
3890 #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */
3891 #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */
3892 #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */
3893 #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */
3894 #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */
3895 #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */
3896 #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */
3897 #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete/Insert: save cursor pos */
3898 #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */
3899 #define OPFLAG_NOCHNG_MAGIC 0x6d /* OP_MakeRecord: serialtype 10 is ok */
3900 #define OPFLAG_PREFORMAT 0x80 /* OP_Insert uses preformatted cell */
3903 ** Each trigger present in the database schema is stored as an instance of
3904 ** struct Trigger.
3906 ** Pointers to instances of struct Trigger are stored in two ways.
3907 ** 1. In the "trigHash" hash table (part of the sqlite3* that represents the
3908 ** database). This allows Trigger structures to be retrieved by name.
3909 ** 2. All triggers associated with a single table form a linked list, using the
3910 ** pNext member of struct Trigger. A pointer to the first element of the
3911 ** linked list is stored as the "pTrigger" member of the associated
3912 ** struct Table.
3914 ** The "step_list" member points to the first element of a linked list
3915 ** containing the SQL statements specified as the trigger program.
3917 struct Trigger {
3918 char *zName; /* The name of the trigger */
3919 char *table; /* The table or view to which the trigger applies */
3920 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
3921 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
3922 u8 bReturning; /* This trigger implements a RETURNING clause */
3923 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
3924 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
3925 the <column-list> is stored here */
3926 Schema *pSchema; /* Schema containing the trigger */
3927 Schema *pTabSchema; /* Schema containing the table */
3928 TriggerStep *step_list; /* Link list of trigger program steps */
3929 Trigger *pNext; /* Next trigger associated with the table */
3933 ** A trigger is either a BEFORE or an AFTER trigger. The following constants
3934 ** determine which.
3936 ** If there are multiple triggers, you might of some BEFORE and some AFTER.
3937 ** In that cases, the constants below can be ORed together.
3939 #define TRIGGER_BEFORE 1
3940 #define TRIGGER_AFTER 2
3943 ** An instance of struct TriggerStep is used to store a single SQL statement
3944 ** that is a part of a trigger-program.
3946 ** Instances of struct TriggerStep are stored in a singly linked list (linked
3947 ** using the "pNext" member) referenced by the "step_list" member of the
3948 ** associated struct Trigger instance. The first element of the linked list is
3949 ** the first step of the trigger-program.
3951 ** The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
3952 ** "SELECT" statement. The meanings of the other members is determined by the
3953 ** value of "op" as follows:
3955 ** (op == TK_INSERT)
3956 ** orconf -> stores the ON CONFLICT algorithm
3957 ** pSelect -> The content to be inserted - either a SELECT statement or
3958 ** a VALUES clause.
3959 ** zTarget -> Dequoted name of the table to insert into.
3960 ** pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
3961 ** statement, then this stores the column-names to be
3962 ** inserted into.
3963 ** pUpsert -> The ON CONFLICT clauses for an Upsert
3965 ** (op == TK_DELETE)
3966 ** zTarget -> Dequoted name of the table to delete from.
3967 ** pWhere -> The WHERE clause of the DELETE statement if one is specified.
3968 ** Otherwise NULL.
3970 ** (op == TK_UPDATE)
3971 ** zTarget -> Dequoted name of the table to update.
3972 ** pWhere -> The WHERE clause of the UPDATE statement if one is specified.
3973 ** Otherwise NULL.
3974 ** pExprList -> A list of the columns to update and the expressions to update
3975 ** them to. See sqlite3Update() documentation of "pChanges"
3976 ** argument.
3978 ** (op == TK_SELECT)
3979 ** pSelect -> The SELECT statement
3981 ** (op == TK_RETURNING)
3982 ** pExprList -> The list of expressions that follow the RETURNING keyword.
3985 struct TriggerStep {
3986 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT,
3987 ** or TK_RETURNING */
3988 u8 orconf; /* OE_Rollback etc. */
3989 Trigger *pTrig; /* The trigger that this step is a part of */
3990 Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */
3991 char *zTarget; /* Target table for DELETE, UPDATE, INSERT */
3992 SrcList *pFrom; /* FROM clause for UPDATE statement (if any) */
3993 Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */
3994 ExprList *pExprList; /* SET clause for UPDATE, or RETURNING clause */
3995 IdList *pIdList; /* Column names for INSERT */
3996 Upsert *pUpsert; /* Upsert clauses on an INSERT */
3997 char *zSpan; /* Original SQL text of this command */
3998 TriggerStep *pNext; /* Next in the link-list */
3999 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
4003 ** Information about a RETURNING clause
4005 struct Returning {
4006 Parse *pParse; /* The parse that includes the RETURNING clause */
4007 ExprList *pReturnEL; /* List of expressions to return */
4008 Trigger retTrig; /* The transient trigger that implements RETURNING */
4009 TriggerStep retTStep; /* The trigger step */
4010 int iRetCur; /* Transient table holding RETURNING results */
4011 int nRetCol; /* Number of in pReturnEL after expansion */
4012 int iRetReg; /* Register array for holding a row of RETURNING */
4016 ** An objected used to accumulate the text of a string where we
4017 ** do not necessarily know how big the string will be in the end.
4019 struct sqlite3_str {
4020 sqlite3 *db; /* Optional database for lookaside. Can be NULL */
4021 char *zText; /* The string collected so far */
4022 u32 nAlloc; /* Amount of space allocated in zText */
4023 u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */
4024 u32 nChar; /* Length of the string so far */
4025 u8 accError; /* SQLITE_NOMEM or SQLITE_TOOBIG */
4026 u8 printfFlags; /* SQLITE_PRINTF flags below */
4028 #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */
4029 #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */
4030 #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */
4032 #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0)
4036 ** A pointer to this structure is used to communicate information
4037 ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
4039 typedef struct {
4040 sqlite3 *db; /* The database being initialized */
4041 char **pzErrMsg; /* Error message stored here */
4042 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
4043 int rc; /* Result code stored here */
4044 u32 mInitFlags; /* Flags controlling error messages */
4045 u32 nInitRow; /* Number of rows processed */
4046 Pgno mxPage; /* Maximum page number. 0 for no limit. */
4047 } InitData;
4050 ** Allowed values for mInitFlags
4052 #define INITFLAG_AlterMask 0x0003 /* Types of ALTER */
4053 #define INITFLAG_AlterRename 0x0001 /* Reparse after a RENAME */
4054 #define INITFLAG_AlterDrop 0x0002 /* Reparse after a DROP COLUMN */
4055 #define INITFLAG_AlterAdd 0x0003 /* Reparse after an ADD COLUMN */
4057 /* Tuning parameters are set using SQLITE_TESTCTRL_TUNE and are controlled
4058 ** on debug-builds of the CLI using ".testctrl tune ID VALUE". Tuning
4059 ** parameters are for temporary use during development, to help find
4060 ** optimial values for parameters in the query planner. The should not
4061 ** be used on trunk check-ins. They are a temporary mechanism available
4062 ** for transient development builds only.
4064 ** Tuning parameters are numbered starting with 1.
4066 #define SQLITE_NTUNE 6 /* Should be zero for all trunk check-ins */
4067 #ifdef SQLITE_DEBUG
4068 # define Tuning(X) (sqlite3Config.aTune[(X)-1])
4069 #else
4070 # define Tuning(X) 0
4071 #endif
4074 ** Structure containing global configuration data for the SQLite library.
4076 ** This structure also contains some state information.
4078 struct Sqlite3Config {
4079 int bMemstat; /* True to enable memory status */
4080 u8 bCoreMutex; /* True to enable core mutexing */
4081 u8 bFullMutex; /* True to enable full mutexing */
4082 u8 bOpenUri; /* True to interpret filenames as URIs */
4083 u8 bUseCis; /* Use covering indices for full-scans */
4084 u8 bSmallMalloc; /* Avoid large memory allocations if true */
4085 u8 bExtraSchemaChecks; /* Verify type,name,tbl_name in schema */
4086 int mxStrlen; /* Maximum string length */
4087 int neverCorrupt; /* Database is always well-formed */
4088 int szLookaside; /* Default lookaside buffer size */
4089 int nLookaside; /* Default lookaside buffer count */
4090 int nStmtSpill; /* Stmt-journal spill-to-disk threshold */
4091 sqlite3_mem_methods m; /* Low-level memory allocation interface */
4092 sqlite3_mutex_methods mutex; /* Low-level mutex interface */
4093 sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */
4094 void *pHeap; /* Heap storage space */
4095 int nHeap; /* Size of pHeap[] */
4096 int mnReq, mxReq; /* Min and max heap requests sizes */
4097 sqlite3_int64 szMmap; /* mmap() space per open file */
4098 sqlite3_int64 mxMmap; /* Maximum value for szMmap */
4099 void *pPage; /* Page cache memory */
4100 int szPage; /* Size of each page in pPage[] */
4101 int nPage; /* Number of pages in pPage[] */
4102 int mxParserStack; /* maximum depth of the parser stack */
4103 int sharedCacheEnabled; /* true if shared-cache mode enabled */
4104 u32 szPma; /* Maximum Sorter PMA size */
4105 /* The above might be initialized to non-zero. The following need to always
4106 ** initially be zero, however. */
4107 int isInit; /* True after initialization has finished */
4108 int inProgress; /* True while initialization in progress */
4109 int isMutexInit; /* True after mutexes are initialized */
4110 int isMallocInit; /* True after malloc is initialized */
4111 int isPCacheInit; /* True after malloc is initialized */
4112 int nRefInitMutex; /* Number of users of pInitMutex */
4113 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
4114 void (*xLog)(void*,int,const char*); /* Function for logging */
4115 void *pLogArg; /* First argument to xLog() */
4116 #ifdef SQLITE_ENABLE_SQLLOG
4117 void(*xSqllog)(void*,sqlite3*,const char*, int);
4118 void *pSqllogArg;
4119 #endif
4120 #ifdef SQLITE_VDBE_COVERAGE
4121 /* The following callback (if not NULL) is invoked on every VDBE branch
4122 ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
4124 void (*xVdbeBranch)(void*,unsigned iSrcLine,u8 eThis,u8 eMx); /* Callback */
4125 void *pVdbeBranchArg; /* 1st argument */
4126 #endif
4127 #ifndef SQLITE_OMIT_DESERIALIZE
4128 sqlite3_int64 mxMemdbSize; /* Default max memdb size */
4129 #endif
4130 #ifndef SQLITE_UNTESTABLE
4131 int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */
4132 #endif
4133 int bLocaltimeFault; /* True to fail localtime() calls */
4134 int (*xAltLocaltime)(const void*,void*); /* Alternative localtime() routine */
4135 int iOnceResetThreshold; /* When to reset OP_Once counters */
4136 u32 szSorterRef; /* Min size in bytes to use sorter-refs */
4137 unsigned int iPrngSeed; /* Alternative fixed seed for the PRNG */
4138 /* vvvv--- must be last ---vvv */
4139 #ifdef SQLITE_DEBUG
4140 sqlite3_int64 aTune[SQLITE_NTUNE]; /* Tuning parameters */
4141 #endif
4145 ** This macro is used inside of assert() statements to indicate that
4146 ** the assert is only valid on a well-formed database. Instead of:
4148 ** assert( X );
4150 ** One writes:
4152 ** assert( X || CORRUPT_DB );
4154 ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate
4155 ** that the database is definitely corrupt, only that it might be corrupt.
4156 ** For most test cases, CORRUPT_DB is set to false using a special
4157 ** sqlite3_test_control(). This enables assert() statements to prove
4158 ** things that are always true for well-formed databases.
4160 #define CORRUPT_DB (sqlite3Config.neverCorrupt==0)
4163 ** Context pointer passed down through the tree-walk.
4165 struct Walker {
4166 Parse *pParse; /* Parser context. */
4167 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
4168 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
4169 void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
4170 int walkerDepth; /* Number of subqueries */
4171 u16 eCode; /* A small processing code */
4172 union { /* Extra data for callback */
4173 NameContext *pNC; /* Naming context */
4174 int n; /* A counter */
4175 int iCur; /* A cursor number */
4176 SrcList *pSrcList; /* FROM clause */
4177 struct CCurHint *pCCurHint; /* Used by codeCursorHint() */
4178 struct RefSrcList *pRefSrcList; /* sqlite3ReferencesSrcList() */
4179 int *aiCol; /* array of column indexes */
4180 struct IdxCover *pIdxCover; /* Check for index coverage */
4181 ExprList *pGroupBy; /* GROUP BY clause */
4182 Select *pSelect; /* HAVING to WHERE clause ctx */
4183 struct WindowRewrite *pRewrite; /* Window rewrite context */
4184 struct WhereConst *pConst; /* WHERE clause constants */
4185 struct RenameCtx *pRename; /* RENAME COLUMN context */
4186 struct Table *pTab; /* Table of generated column */
4187 struct CoveringIndexCheck *pCovIdxCk; /* Check for covering index */
4188 SrcItem *pSrcItem; /* A single FROM clause item */
4189 DbFixer *pFix; /* See sqlite3FixSelect() */
4190 Mem *aMem; /* See sqlite3BtreeCursorHint() */
4191 } u;
4195 ** The following structure contains information used by the sqliteFix...
4196 ** routines as they walk the parse tree to make database references
4197 ** explicit.
4199 struct DbFixer {
4200 Parse *pParse; /* The parsing context. Error messages written here */
4201 Walker w; /* Walker object */
4202 Schema *pSchema; /* Fix items to this schema */
4203 u8 bTemp; /* True for TEMP schema entries */
4204 const char *zDb; /* Make sure all objects are contained in this database */
4205 const char *zType; /* Type of the container - used for error messages */
4206 const Token *pName; /* Name of the container - used for error messages */
4209 /* Forward declarations */
4210 int sqlite3WalkExpr(Walker*, Expr*);
4211 int sqlite3WalkExprList(Walker*, ExprList*);
4212 int sqlite3WalkSelect(Walker*, Select*);
4213 int sqlite3WalkSelectExpr(Walker*, Select*);
4214 int sqlite3WalkSelectFrom(Walker*, Select*);
4215 int sqlite3ExprWalkNoop(Walker*, Expr*);
4216 int sqlite3SelectWalkNoop(Walker*, Select*);
4217 int sqlite3SelectWalkFail(Walker*, Select*);
4218 int sqlite3WalkerDepthIncrease(Walker*,Select*);
4219 void sqlite3WalkerDepthDecrease(Walker*,Select*);
4220 void sqlite3WalkWinDefnDummyCallback(Walker*,Select*);
4222 #ifdef SQLITE_DEBUG
4223 void sqlite3SelectWalkAssert2(Walker*, Select*);
4224 #endif
4226 #ifndef SQLITE_OMIT_CTE
4227 void sqlite3SelectPopWith(Walker*, Select*);
4228 #else
4229 # define sqlite3SelectPopWith 0
4230 #endif
4233 ** Return code from the parse-tree walking primitives and their
4234 ** callbacks.
4236 #define WRC_Continue 0 /* Continue down into children */
4237 #define WRC_Prune 1 /* Omit children but continue walking siblings */
4238 #define WRC_Abort 2 /* Abandon the tree walk */
4241 ** A single common table expression
4243 struct Cte {
4244 char *zName; /* Name of this CTE */
4245 ExprList *pCols; /* List of explicit column names, or NULL */
4246 Select *pSelect; /* The definition of this CTE */
4247 const char *zCteErr; /* Error message for circular references */
4248 CteUse *pUse; /* Usage information for this CTE */
4249 u8 eM10d; /* The MATERIALIZED flag */
4253 ** Allowed values for the materialized flag (eM10d):
4255 #define M10d_Yes 0 /* AS MATERIALIZED */
4256 #define M10d_Any 1 /* Not specified. Query planner's choice */
4257 #define M10d_No 2 /* AS NOT MATERIALIZED */
4260 ** An instance of the With object represents a WITH clause containing
4261 ** one or more CTEs (common table expressions).
4263 struct With {
4264 int nCte; /* Number of CTEs in the WITH clause */
4265 int bView; /* Belongs to the outermost Select of a view */
4266 With *pOuter; /* Containing WITH clause, or NULL */
4267 Cte a[1]; /* For each CTE in the WITH clause.... */
4271 ** The Cte object is not guaranteed to persist for the entire duration
4272 ** of code generation. (The query flattener or other parser tree
4273 ** edits might delete it.) The following object records information
4274 ** about each Common Table Expression that must be preserved for the
4275 ** duration of the parse.
4277 ** The CteUse objects are freed using sqlite3ParserAddCleanup() rather
4278 ** than sqlite3SelectDelete(), which is what enables them to persist
4279 ** until the end of code generation.
4281 struct CteUse {
4282 int nUse; /* Number of users of this CTE */
4283 int addrM9e; /* Start of subroutine to compute materialization */
4284 int regRtn; /* Return address register for addrM9e subroutine */
4285 int iCur; /* Ephemeral table holding the materialization */
4286 LogEst nRowEst; /* Estimated number of rows in the table */
4287 u8 eM10d; /* The MATERIALIZED flag */
4291 #ifdef SQLITE_DEBUG
4293 ** An instance of the TreeView object is used for printing the content of
4294 ** data structures on sqlite3DebugPrintf() using a tree-like view.
4296 struct TreeView {
4297 int iLevel; /* Which level of the tree we are on */
4298 u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */
4300 #endif /* SQLITE_DEBUG */
4303 ** This object is used in various ways, most (but not all) related to window
4304 ** functions.
4306 ** (1) A single instance of this structure is attached to the
4307 ** the Expr.y.pWin field for each window function in an expression tree.
4308 ** This object holds the information contained in the OVER clause,
4309 ** plus additional fields used during code generation.
4311 ** (2) All window functions in a single SELECT form a linked-list
4312 ** attached to Select.pWin. The Window.pFunc and Window.pExpr
4313 ** fields point back to the expression that is the window function.
4315 ** (3) The terms of the WINDOW clause of a SELECT are instances of this
4316 ** object on a linked list attached to Select.pWinDefn.
4318 ** (4) For an aggregate function with a FILTER clause, an instance
4319 ** of this object is stored in Expr.y.pWin with eFrmType set to
4320 ** TK_FILTER. In this case the only field used is Window.pFilter.
4322 ** The uses (1) and (2) are really the same Window object that just happens
4323 ** to be accessible in two different ways. Use case (3) are separate objects.
4325 struct Window {
4326 char *zName; /* Name of window (may be NULL) */
4327 char *zBase; /* Name of base window for chaining (may be NULL) */
4328 ExprList *pPartition; /* PARTITION BY clause */
4329 ExprList *pOrderBy; /* ORDER BY clause */
4330 u8 eFrmType; /* TK_RANGE, TK_GROUPS, TK_ROWS, or 0 */
4331 u8 eStart; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */
4332 u8 eEnd; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */
4333 u8 bImplicitFrame; /* True if frame was implicitly specified */
4334 u8 eExclude; /* TK_NO, TK_CURRENT, TK_TIES, TK_GROUP, or 0 */
4335 Expr *pStart; /* Expression for "<expr> PRECEDING" */
4336 Expr *pEnd; /* Expression for "<expr> FOLLOWING" */
4337 Window **ppThis; /* Pointer to this object in Select.pWin list */
4338 Window *pNextWin; /* Next window function belonging to this SELECT */
4339 Expr *pFilter; /* The FILTER expression */
4340 FuncDef *pWFunc; /* The function */
4341 int iEphCsr; /* Partition buffer or Peer buffer */
4342 int regAccum; /* Accumulator */
4343 int regResult; /* Interim result */
4344 int csrApp; /* Function cursor (used by min/max) */
4345 int regApp; /* Function register (also used by min/max) */
4346 int regPart; /* Array of registers for PARTITION BY values */
4347 Expr *pOwner; /* Expression object this window is attached to */
4348 int nBufferCol; /* Number of columns in buffer table */
4349 int iArgCol; /* Offset of first argument for this function */
4350 int regOne; /* Register containing constant value 1 */
4351 int regStartRowid;
4352 int regEndRowid;
4353 u8 bExprArgs; /* Defer evaluation of window function arguments
4354 ** due to the SQLITE_SUBTYPE flag */
4357 #ifndef SQLITE_OMIT_WINDOWFUNC
4358 void sqlite3WindowDelete(sqlite3*, Window*);
4359 void sqlite3WindowUnlinkFromSelect(Window*);
4360 void sqlite3WindowListDelete(sqlite3 *db, Window *p);
4361 Window *sqlite3WindowAlloc(Parse*, int, int, Expr*, int , Expr*, u8);
4362 void sqlite3WindowAttach(Parse*, Expr*, Window*);
4363 void sqlite3WindowLink(Select *pSel, Window *pWin);
4364 int sqlite3WindowCompare(const Parse*, const Window*, const Window*, int);
4365 void sqlite3WindowCodeInit(Parse*, Select*);
4366 void sqlite3WindowCodeStep(Parse*, Select*, WhereInfo*, int, int);
4367 int sqlite3WindowRewrite(Parse*, Select*);
4368 void sqlite3WindowUpdate(Parse*, Window*, Window*, FuncDef*);
4369 Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p);
4370 Window *sqlite3WindowListDup(sqlite3 *db, Window *p);
4371 void sqlite3WindowFunctions(void);
4372 void sqlite3WindowChain(Parse*, Window*, Window*);
4373 Window *sqlite3WindowAssemble(Parse*, Window*, ExprList*, ExprList*, Token*);
4374 #else
4375 # define sqlite3WindowDelete(a,b)
4376 # define sqlite3WindowFunctions()
4377 # define sqlite3WindowAttach(a,b,c)
4378 #endif
4381 ** Assuming zIn points to the first byte of a UTF-8 character,
4382 ** advance zIn to point to the first byte of the next UTF-8 character.
4384 #define SQLITE_SKIP_UTF8(zIn) { \
4385 if( (*(zIn++))>=0xc0 ){ \
4386 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
4391 ** The SQLITE_*_BKPT macros are substitutes for the error codes with
4392 ** the same name but without the _BKPT suffix. These macros invoke
4393 ** routines that report the line-number on which the error originated
4394 ** using sqlite3_log(). The routines also provide a convenient place
4395 ** to set a debugger breakpoint.
4397 int sqlite3ReportError(int iErr, int lineno, const char *zType);
4398 int sqlite3CorruptError(int);
4399 int sqlite3MisuseError(int);
4400 int sqlite3CantopenError(int);
4401 #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
4402 #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
4403 #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
4404 #ifdef SQLITE_DEBUG
4405 int sqlite3NomemError(int);
4406 int sqlite3IoerrnomemError(int);
4407 # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__)
4408 # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__)
4409 #else
4410 # define SQLITE_NOMEM_BKPT SQLITE_NOMEM
4411 # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM
4412 #endif
4413 #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO)
4414 int sqlite3CorruptPgnoError(int,Pgno);
4415 # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptPgnoError(__LINE__,(P))
4416 #else
4417 # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptError(__LINE__)
4418 #endif
4421 ** FTS3 and FTS4 both require virtual table support
4423 #if defined(SQLITE_OMIT_VIRTUALTABLE)
4424 # undef SQLITE_ENABLE_FTS3
4425 # undef SQLITE_ENABLE_FTS4
4426 #endif
4429 ** FTS4 is really an extension for FTS3. It is enabled using the
4430 ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call
4431 ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
4433 #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
4434 # define SQLITE_ENABLE_FTS3 1
4435 #endif
4438 ** The ctype.h header is needed for non-ASCII systems. It is also
4439 ** needed by FTS3 when FTS3 is included in the amalgamation.
4441 #if !defined(SQLITE_ASCII) || \
4442 (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
4443 # include <ctype.h>
4444 #endif
4447 ** The following macros mimic the standard library functions toupper(),
4448 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
4449 ** sqlite versions only work for ASCII characters, regardless of locale.
4451 #ifdef SQLITE_ASCII
4452 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
4453 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
4454 # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
4455 # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
4456 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
4457 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
4458 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)])
4459 # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80)
4460 # define sqlite3JsonId1(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x42)
4461 # define sqlite3JsonId2(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x46)
4462 #else
4463 # define sqlite3Toupper(x) toupper((unsigned char)(x))
4464 # define sqlite3Isspace(x) isspace((unsigned char)(x))
4465 # define sqlite3Isalnum(x) isalnum((unsigned char)(x))
4466 # define sqlite3Isalpha(x) isalpha((unsigned char)(x))
4467 # define sqlite3Isdigit(x) isdigit((unsigned char)(x))
4468 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x))
4469 # define sqlite3Tolower(x) tolower((unsigned char)(x))
4470 # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`')
4471 # define sqlite3JsonId1(x) (sqlite3IsIdChar(x)&&(x)<'0')
4472 # define sqlite3JsonId2(x) sqlite3IsIdChar(x)
4473 #endif
4474 int sqlite3IsIdChar(u8);
4477 ** Internal function prototypes
4479 int sqlite3StrICmp(const char*,const char*);
4480 int sqlite3Strlen30(const char*);
4481 #define sqlite3Strlen30NN(C) (strlen(C)&0x3fffffff)
4482 char *sqlite3ColumnType(Column*,char*);
4483 #define sqlite3StrNICmp sqlite3_strnicmp
4485 int sqlite3MallocInit(void);
4486 void sqlite3MallocEnd(void);
4487 void *sqlite3Malloc(u64);
4488 void *sqlite3MallocZero(u64);
4489 void *sqlite3DbMallocZero(sqlite3*, u64);
4490 void *sqlite3DbMallocRaw(sqlite3*, u64);
4491 void *sqlite3DbMallocRawNN(sqlite3*, u64);
4492 char *sqlite3DbStrDup(sqlite3*,const char*);
4493 char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
4494 char *sqlite3DbSpanDup(sqlite3*,const char*,const char*);
4495 void *sqlite3Realloc(void*, u64);
4496 void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
4497 void *sqlite3DbRealloc(sqlite3 *, void *, u64);
4498 void sqlite3DbFree(sqlite3*, void*);
4499 void sqlite3DbFreeNN(sqlite3*, void*);
4500 void sqlite3DbNNFreeNN(sqlite3*, void*);
4501 int sqlite3MallocSize(const void*);
4502 int sqlite3DbMallocSize(sqlite3*, const void*);
4503 void *sqlite3PageMalloc(int);
4504 void sqlite3PageFree(void*);
4505 void sqlite3MemSetDefault(void);
4506 #ifndef SQLITE_UNTESTABLE
4507 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
4508 #endif
4509 int sqlite3HeapNearlyFull(void);
4512 ** On systems with ample stack space and that support alloca(), make
4513 ** use of alloca() to obtain space for large automatic objects. By default,
4514 ** obtain space from malloc().
4516 ** The alloca() routine never returns NULL. This will cause code paths
4517 ** that deal with sqlite3StackAlloc() failures to be unreachable.
4519 #ifdef SQLITE_USE_ALLOCA
4520 # define sqlite3StackAllocRaw(D,N) alloca(N)
4521 # define sqlite3StackAllocRawNN(D,N) alloca(N)
4522 # define sqlite3StackFree(D,P)
4523 # define sqlite3StackFreeNN(D,P)
4524 #else
4525 # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N)
4526 # define sqlite3StackAllocRawNN(D,N) sqlite3DbMallocRawNN(D,N)
4527 # define sqlite3StackFree(D,P) sqlite3DbFree(D,P)
4528 # define sqlite3StackFreeNN(D,P) sqlite3DbFreeNN(D,P)
4529 #endif
4531 /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they
4532 ** are, disable MEMSYS3
4534 #ifdef SQLITE_ENABLE_MEMSYS5
4535 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
4536 #undef SQLITE_ENABLE_MEMSYS3
4537 #endif
4538 #ifdef SQLITE_ENABLE_MEMSYS3
4539 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
4540 #endif
4543 #ifndef SQLITE_MUTEX_OMIT
4544 sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
4545 sqlite3_mutex_methods const *sqlite3NoopMutex(void);
4546 sqlite3_mutex *sqlite3MutexAlloc(int);
4547 int sqlite3MutexInit(void);
4548 int sqlite3MutexEnd(void);
4549 #endif
4550 #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP)
4551 void sqlite3MemoryBarrier(void);
4552 #else
4553 # define sqlite3MemoryBarrier()
4554 #endif
4556 sqlite3_int64 sqlite3StatusValue(int);
4557 void sqlite3StatusUp(int, int);
4558 void sqlite3StatusDown(int, int);
4559 void sqlite3StatusHighwater(int, int);
4560 int sqlite3LookasideUsed(sqlite3*,int*);
4562 /* Access to mutexes used by sqlite3_status() */
4563 sqlite3_mutex *sqlite3Pcache1Mutex(void);
4564 sqlite3_mutex *sqlite3MallocMutex(void);
4566 #if defined(SQLITE_ENABLE_MULTITHREADED_CHECKS) && !defined(SQLITE_MUTEX_OMIT)
4567 void sqlite3MutexWarnOnContention(sqlite3_mutex*);
4568 #else
4569 # define sqlite3MutexWarnOnContention(x)
4570 #endif
4572 #ifndef SQLITE_OMIT_FLOATING_POINT
4573 # define EXP754 (((u64)0x7ff)<<52)
4574 # define MAN754 ((((u64)1)<<52)-1)
4575 # define IsNaN(X) (((X)&EXP754)==EXP754 && ((X)&MAN754)!=0)
4576 int sqlite3IsNaN(double);
4577 #else
4578 # define IsNaN(X) 0
4579 # define sqlite3IsNaN(X) 0
4580 #endif
4583 ** An instance of the following structure holds information about SQL
4584 ** functions arguments that are the parameters to the printf() function.
4586 struct PrintfArguments {
4587 int nArg; /* Total number of arguments */
4588 int nUsed; /* Number of arguments used so far */
4589 sqlite3_value **apArg; /* The argument values */
4592 char *sqlite3MPrintf(sqlite3*,const char*, ...);
4593 char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
4594 #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
4595 void sqlite3DebugPrintf(const char*, ...);
4596 #endif
4597 #if defined(SQLITE_TEST)
4598 void *sqlite3TestTextToPtr(const char*);
4599 #endif
4601 #if defined(SQLITE_DEBUG)
4602 void sqlite3TreeViewLine(TreeView*, const char *zFormat, ...);
4603 void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
4604 void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*);
4605 void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
4606 void sqlite3TreeViewBareIdList(TreeView*, const IdList*, const char*);
4607 void sqlite3TreeViewIdList(TreeView*, const IdList*, u8, const char*);
4608 void sqlite3TreeViewColumnList(TreeView*, const Column*, int, u8);
4609 void sqlite3TreeViewSrcList(TreeView*, const SrcList*);
4610 void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
4611 void sqlite3TreeViewWith(TreeView*, const With*, u8);
4612 void sqlite3TreeViewUpsert(TreeView*, const Upsert*, u8);
4613 #if TREETRACE_ENABLED
4614 void sqlite3TreeViewDelete(const With*, const SrcList*, const Expr*,
4615 const ExprList*,const Expr*, const Trigger*);
4616 void sqlite3TreeViewInsert(const With*, const SrcList*,
4617 const IdList*, const Select*, const ExprList*,
4618 int, const Upsert*, const Trigger*);
4619 void sqlite3TreeViewUpdate(const With*, const SrcList*, const ExprList*,
4620 const Expr*, int, const ExprList*, const Expr*,
4621 const Upsert*, const Trigger*);
4622 #endif
4623 #ifndef SQLITE_OMIT_TRIGGER
4624 void sqlite3TreeViewTriggerStep(TreeView*, const TriggerStep*, u8, u8);
4625 void sqlite3TreeViewTrigger(TreeView*, const Trigger*, u8, u8);
4626 #endif
4627 #ifndef SQLITE_OMIT_WINDOWFUNC
4628 void sqlite3TreeViewWindow(TreeView*, const Window*, u8);
4629 void sqlite3TreeViewWinFunc(TreeView*, const Window*, u8);
4630 #endif
4631 void sqlite3ShowExpr(const Expr*);
4632 void sqlite3ShowExprList(const ExprList*);
4633 void sqlite3ShowIdList(const IdList*);
4634 void sqlite3ShowSrcList(const SrcList*);
4635 void sqlite3ShowSelect(const Select*);
4636 void sqlite3ShowWith(const With*);
4637 void sqlite3ShowUpsert(const Upsert*);
4638 #ifndef SQLITE_OMIT_TRIGGER
4639 void sqlite3ShowTriggerStep(const TriggerStep*);
4640 void sqlite3ShowTriggerStepList(const TriggerStep*);
4641 void sqlite3ShowTrigger(const Trigger*);
4642 void sqlite3ShowTriggerList(const Trigger*);
4643 #endif
4644 #ifndef SQLITE_OMIT_WINDOWFUNC
4645 void sqlite3ShowWindow(const Window*);
4646 void sqlite3ShowWinFunc(const Window*);
4647 #endif
4648 #endif
4650 void sqlite3SetString(char **, sqlite3*, const char*);
4651 void sqlite3ProgressCheck(Parse*);
4652 void sqlite3ErrorMsg(Parse*, const char*, ...);
4653 int sqlite3ErrorToParser(sqlite3*,int);
4654 void sqlite3Dequote(char*);
4655 void sqlite3DequoteExpr(Expr*);
4656 void sqlite3DequoteToken(Token*);
4657 void sqlite3TokenInit(Token*,char*);
4658 int sqlite3KeywordCode(const unsigned char*, int);
4659 int sqlite3RunParser(Parse*, const char*);
4660 void sqlite3FinishCoding(Parse*);
4661 int sqlite3GetTempReg(Parse*);
4662 void sqlite3ReleaseTempReg(Parse*,int);
4663 int sqlite3GetTempRange(Parse*,int);
4664 void sqlite3ReleaseTempRange(Parse*,int,int);
4665 void sqlite3ClearTempRegCache(Parse*);
4666 void sqlite3TouchRegister(Parse*,int);
4667 #if defined(SQLITE_ENABLE_STAT4) || defined(SQLITE_DEBUG)
4668 int sqlite3FirstAvailableRegister(Parse*,int);
4669 #endif
4670 #ifdef SQLITE_DEBUG
4671 int sqlite3NoTempsInRange(Parse*,int,int);
4672 #endif
4673 Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
4674 Expr *sqlite3Expr(sqlite3*,int,const char*);
4675 void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
4676 Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*);
4677 void sqlite3PExprAddSelect(Parse*, Expr*, Select*);
4678 Expr *sqlite3ExprAnd(Parse*,Expr*, Expr*);
4679 Expr *sqlite3ExprSimplifiedAndOr(Expr*);
4680 Expr *sqlite3ExprFunction(Parse*,ExprList*, const Token*, int);
4681 void sqlite3ExprFunctionUsable(Parse*,const Expr*,const FuncDef*);
4682 void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32);
4683 void sqlite3ExprDelete(sqlite3*, Expr*);
4684 void sqlite3ExprDeferredDelete(Parse*, Expr*);
4685 void sqlite3ExprUnmapAndDelete(Parse*, Expr*);
4686 ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
4687 ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*);
4688 Select *sqlite3ExprListToValues(Parse*, int, ExprList*);
4689 void sqlite3ExprListSetSortOrder(ExprList*,int,int);
4690 void sqlite3ExprListSetName(Parse*,ExprList*,const Token*,int);
4691 void sqlite3ExprListSetSpan(Parse*,ExprList*,const char*,const char*);
4692 void sqlite3ExprListDelete(sqlite3*, ExprList*);
4693 u32 sqlite3ExprListFlags(const ExprList*);
4694 int sqlite3IndexHasDuplicateRootPage(Index*);
4695 int sqlite3Init(sqlite3*, char**);
4696 int sqlite3InitCallback(void*, int, char**, char**);
4697 int sqlite3InitOne(sqlite3*, int, char**, u32);
4698 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
4699 #ifndef SQLITE_OMIT_VIRTUALTABLE
4700 Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName);
4701 #endif
4702 void sqlite3ResetAllSchemasOfConnection(sqlite3*);
4703 void sqlite3ResetOneSchema(sqlite3*,int);
4704 void sqlite3CollapseDatabaseArray(sqlite3*);
4705 void sqlite3CommitInternalChanges(sqlite3*);
4706 void sqlite3ColumnSetExpr(Parse*,Table*,Column*,Expr*);
4707 Expr *sqlite3ColumnExpr(Table*,Column*);
4708 void sqlite3ColumnSetColl(sqlite3*,Column*,const char*zColl);
4709 const char *sqlite3ColumnColl(Column*);
4710 void sqlite3DeleteColumnNames(sqlite3*,Table*);
4711 void sqlite3GenerateColumnNames(Parse *pParse, Select *pSelect);
4712 int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**);
4713 void sqlite3SubqueryColumnTypes(Parse*,Table*,Select*,char);
4714 Table *sqlite3ResultSetOfSelect(Parse*,Select*,char);
4715 void sqlite3OpenSchemaTable(Parse *, int);
4716 Index *sqlite3PrimaryKeyIndex(Table*);
4717 i16 sqlite3TableColumnToIndex(Index*, i16);
4718 #ifdef SQLITE_OMIT_GENERATED_COLUMNS
4719 # define sqlite3TableColumnToStorage(T,X) (X) /* No-op pass-through */
4720 # define sqlite3StorageColumnToTable(T,X) (X) /* No-op pass-through */
4721 #else
4722 i16 sqlite3TableColumnToStorage(Table*, i16);
4723 i16 sqlite3StorageColumnToTable(Table*, i16);
4724 #endif
4725 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
4726 #if SQLITE_ENABLE_HIDDEN_COLUMNS
4727 void sqlite3ColumnPropertiesFromName(Table*, Column*);
4728 #else
4729 # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */
4730 #endif
4731 void sqlite3AddColumn(Parse*,Token,Token);
4732 void sqlite3AddNotNull(Parse*, int);
4733 void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
4734 void sqlite3AddCheckConstraint(Parse*, Expr*, const char*, const char*);
4735 void sqlite3AddDefaultValue(Parse*,Expr*,const char*,const char*);
4736 void sqlite3AddCollateType(Parse*, Token*);
4737 void sqlite3AddGenerated(Parse*,Expr*,Token*);
4738 void sqlite3EndTable(Parse*,Token*,Token*,u32,Select*);
4739 void sqlite3AddReturning(Parse*,ExprList*);
4740 int sqlite3ParseUri(const char*,const char*,unsigned int*,
4741 sqlite3_vfs**,char**,char **);
4742 /* BEGIN SQLCIPHER */
4743 #ifdef SQLITE_HAS_CODEC
4744 int sqlite3CodecQueryParameters(sqlite3*,const char*,const char*);
4745 #else
4746 # define sqlite3CodecQueryParameters(A,B,C) 0
4747 #endif
4748 /* END SQLCIPHER */
4749 Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
4751 #ifdef SQLITE_UNTESTABLE
4752 # define sqlite3FaultSim(X) SQLITE_OK
4753 #else
4754 int sqlite3FaultSim(int);
4755 #endif
4757 Bitvec *sqlite3BitvecCreate(u32);
4758 int sqlite3BitvecTest(Bitvec*, u32);
4759 int sqlite3BitvecTestNotNull(Bitvec*, u32);
4760 int sqlite3BitvecSet(Bitvec*, u32);
4761 void sqlite3BitvecClear(Bitvec*, u32, void*);
4762 void sqlite3BitvecDestroy(Bitvec*);
4763 u32 sqlite3BitvecSize(Bitvec*);
4764 #ifndef SQLITE_UNTESTABLE
4765 int sqlite3BitvecBuiltinTest(int,int*);
4766 #endif
4768 RowSet *sqlite3RowSetInit(sqlite3*);
4769 void sqlite3RowSetDelete(void*);
4770 void sqlite3RowSetClear(void*);
4771 void sqlite3RowSetInsert(RowSet*, i64);
4772 int sqlite3RowSetTest(RowSet*, int iBatch, i64);
4773 int sqlite3RowSetNext(RowSet*, i64*);
4775 void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int);
4777 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
4778 int sqlite3ViewGetColumnNames(Parse*,Table*);
4779 #else
4780 # define sqlite3ViewGetColumnNames(A,B) 0
4781 #endif
4783 #if SQLITE_MAX_ATTACHED>30
4784 int sqlite3DbMaskAllZero(yDbMask);
4785 #endif
4786 void sqlite3DropTable(Parse*, SrcList*, int, int);
4787 void sqlite3CodeDropTable(Parse*, Table*, int, int);
4788 void sqlite3DeleteTable(sqlite3*, Table*);
4789 void sqlite3FreeIndex(sqlite3*, Index*);
4790 #ifndef SQLITE_OMIT_AUTOINCREMENT
4791 void sqlite3AutoincrementBegin(Parse *pParse);
4792 void sqlite3AutoincrementEnd(Parse *pParse);
4793 #else
4794 # define sqlite3AutoincrementBegin(X)
4795 # define sqlite3AutoincrementEnd(X)
4796 #endif
4797 void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int, Upsert*);
4798 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
4799 void sqlite3ComputeGeneratedColumns(Parse*, int, Table*);
4800 #endif
4801 void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
4802 IdList *sqlite3IdListAppend(Parse*, IdList*, Token*);
4803 int sqlite3IdListIndex(IdList*,const char*);
4804 SrcList *sqlite3SrcListEnlarge(Parse*, SrcList*, int, int);
4805 SrcList *sqlite3SrcListAppendList(Parse *pParse, SrcList *p1, SrcList *p2);
4806 SrcList *sqlite3SrcListAppend(Parse*, SrcList*, Token*, Token*);
4807 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
4808 Token*, Select*, OnOrUsing*);
4809 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
4810 void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*);
4811 int sqlite3IndexedByLookup(Parse *, SrcItem *);
4812 void sqlite3SrcListShiftJoinType(Parse*,SrcList*);
4813 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
4814 void sqlite3IdListDelete(sqlite3*, IdList*);
4815 void sqlite3ClearOnOrUsing(sqlite3*, OnOrUsing*);
4816 void sqlite3SrcListDelete(sqlite3*, SrcList*);
4817 Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
4818 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
4819 Expr*, int, int, u8);
4820 void sqlite3DropIndex(Parse*, SrcList*, int);
4821 int sqlite3Select(Parse*, Select*, SelectDest*);
4822 Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
4823 Expr*,ExprList*,u32,Expr*);
4824 void sqlite3SelectDelete(sqlite3*, Select*);
4825 Table *sqlite3SrcListLookup(Parse*, SrcList*);
4826 int sqlite3IsReadOnly(Parse*, Table*, Trigger*);
4827 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
4828 #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
4829 Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,char*);
4830 #endif
4831 void sqlite3CodeChangeCount(Vdbe*,int,const char*);
4832 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*, ExprList*, Expr*);
4833 void sqlite3Update(Parse*, SrcList*, ExprList*,Expr*,int,ExprList*,Expr*,
4834 Upsert*);
4835 WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,
4836 ExprList*,Select*,u16,int);
4837 void sqlite3WhereEnd(WhereInfo*);
4838 LogEst sqlite3WhereOutputRowCount(WhereInfo*);
4839 int sqlite3WhereIsDistinct(WhereInfo*);
4840 int sqlite3WhereIsOrdered(WhereInfo*);
4841 int sqlite3WhereOrderByLimitOptLabel(WhereInfo*);
4842 void sqlite3WhereMinMaxOptEarlyOut(Vdbe*,WhereInfo*);
4843 int sqlite3WhereIsSorted(WhereInfo*);
4844 int sqlite3WhereContinueLabel(WhereInfo*);
4845 int sqlite3WhereBreakLabel(WhereInfo*);
4846 int sqlite3WhereOkOnePass(WhereInfo*, int*);
4847 #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */
4848 #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */
4849 #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */
4850 int sqlite3WhereUsesDeferredSeek(WhereInfo*);
4851 void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int);
4852 int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
4853 void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
4854 void sqlite3ExprCodeMove(Parse*, int, int, int);
4855 void sqlite3ExprCode(Parse*, Expr*, int);
4856 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
4857 void sqlite3ExprCodeGeneratedColumn(Parse*, Table*, Column*, int);
4858 #endif
4859 void sqlite3ExprCodeCopy(Parse*, Expr*, int);
4860 void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
4861 int sqlite3ExprCodeRunJustOnce(Parse*, Expr*, int);
4862 int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
4863 int sqlite3ExprCodeTarget(Parse*, Expr*, int);
4864 int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8);
4865 #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */
4866 #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */
4867 #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */
4868 #define SQLITE_ECEL_OMITREF 0x08 /* Omit if ExprList.u.x.iOrderByCol */
4869 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
4870 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
4871 void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
4872 Table *sqlite3FindTable(sqlite3*,const char*, const char*);
4873 #define LOCATE_VIEW 0x01
4874 #define LOCATE_NOERR 0x02
4875 Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*);
4876 const char *sqlite3PreferredTableName(const char*);
4877 Table *sqlite3LocateTableItem(Parse*,u32 flags,SrcItem *);
4878 Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
4879 void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
4880 void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
4881 void sqlite3Vacuum(Parse*,Token*,Expr*);
4882 int sqlite3RunVacuum(char**, sqlite3*, int, sqlite3_value*);
4883 char *sqlite3NameFromToken(sqlite3*, const Token*);
4884 int sqlite3ExprCompare(const Parse*,const Expr*,const Expr*, int);
4885 int sqlite3ExprCompareSkip(Expr*,Expr*,int);
4886 int sqlite3ExprListCompare(const ExprList*,const ExprList*, int);
4887 int sqlite3ExprImpliesExpr(const Parse*,const Expr*,const Expr*, int);
4888 int sqlite3ExprImpliesNonNullRow(Expr*,int);
4889 void sqlite3AggInfoPersistWalkerInit(Walker*,Parse*);
4890 void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
4891 void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
4892 int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx);
4893 int sqlite3ReferencesSrcList(Parse*, Expr*, SrcList*);
4894 Vdbe *sqlite3GetVdbe(Parse*);
4895 #ifndef SQLITE_UNTESTABLE
4896 void sqlite3PrngSaveState(void);
4897 void sqlite3PrngRestoreState(void);
4898 #endif
4899 void sqlite3RollbackAll(sqlite3*,int);
4900 void sqlite3CodeVerifySchema(Parse*, int);
4901 void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
4902 void sqlite3BeginTransaction(Parse*, int);
4903 void sqlite3EndTransaction(Parse*,int);
4904 void sqlite3Savepoint(Parse*, int, Token*);
4905 void sqlite3CloseSavepoints(sqlite3 *);
4906 void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
4907 u32 sqlite3IsTrueOrFalse(const char*);
4908 int sqlite3ExprIdToTrueFalse(Expr*);
4909 int sqlite3ExprTruthValue(const Expr*);
4910 int sqlite3ExprIsConstant(Expr*);
4911 int sqlite3ExprIsConstantNotJoin(Expr*);
4912 int sqlite3ExprIsConstantOrFunction(Expr*, u8);
4913 int sqlite3ExprIsConstantOrGroupBy(Parse*, Expr*, ExprList*);
4914 int sqlite3ExprIsTableConstant(Expr*,int);
4915 int sqlite3ExprIsSingleTableConstraint(Expr*,const SrcList*,int);
4916 #ifdef SQLITE_ENABLE_CURSOR_HINTS
4917 int sqlite3ExprContainsSubquery(Expr*);
4918 #endif
4919 int sqlite3ExprIsInteger(const Expr*, int*);
4920 int sqlite3ExprCanBeNull(const Expr*);
4921 int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
4922 int sqlite3IsRowid(const char*);
4923 void sqlite3GenerateRowDelete(
4924 Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int);
4925 void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int);
4926 int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
4927 void sqlite3ResolvePartIdxLabel(Parse*,int);
4928 int sqlite3ExprReferencesUpdatedColumn(Expr*,int*,int);
4929 void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
4930 u8,u8,int,int*,int*,Upsert*);
4931 #ifdef SQLITE_ENABLE_NULL_TRIM
4932 void sqlite3SetMakeRecordP5(Vdbe*,Table*);
4933 #else
4934 # define sqlite3SetMakeRecordP5(A,B)
4935 #endif
4936 void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
4937 int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*);
4938 void sqlite3BeginWriteOperation(Parse*, int, int);
4939 void sqlite3MultiWrite(Parse*);
4940 void sqlite3MayAbort(Parse*);
4941 void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
4942 void sqlite3UniqueConstraint(Parse*, int, Index*);
4943 void sqlite3RowidConstraint(Parse*, int, Table*);
4944 Expr *sqlite3ExprDup(sqlite3*,const Expr*,int);
4945 ExprList *sqlite3ExprListDup(sqlite3*,const ExprList*,int);
4946 SrcList *sqlite3SrcListDup(sqlite3*,const SrcList*,int);
4947 IdList *sqlite3IdListDup(sqlite3*,const IdList*);
4948 Select *sqlite3SelectDup(sqlite3*,const Select*,int);
4949 FuncDef *sqlite3FunctionSearch(int,const char*);
4950 void sqlite3InsertBuiltinFuncs(FuncDef*,int);
4951 FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8);
4952 void sqlite3QuoteValue(StrAccum*,sqlite3_value*);
4953 void sqlite3RegisterBuiltinFunctions(void);
4954 void sqlite3RegisterDateTimeFunctions(void);
4955 void sqlite3RegisterJsonFunctions(void);
4956 void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*);
4957 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && !defined(SQLITE_OMIT_JSON)
4958 int sqlite3JsonTableFunctions(sqlite3*);
4959 #endif
4960 int sqlite3SafetyCheckOk(sqlite3*);
4961 int sqlite3SafetyCheckSickOrOk(sqlite3*);
4962 void sqlite3ChangeCookie(Parse*, int);
4963 With *sqlite3WithDup(sqlite3 *db, With *p);
4965 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
4966 void sqlite3MaterializeView(Parse*, Table*, Expr*, ExprList*,Expr*,int);
4967 #endif
4969 #ifndef SQLITE_OMIT_TRIGGER
4970 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
4971 Expr*,int, int);
4972 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
4973 void sqlite3DropTrigger(Parse*, SrcList*, int);
4974 void sqlite3DropTriggerPtr(Parse*, Trigger*);
4975 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
4976 Trigger *sqlite3TriggerList(Parse *, Table *);
4977 void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
4978 int, int, int);
4979 void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
4980 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
4981 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
4982 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*,
4983 const char*,const char*);
4984 TriggerStep *sqlite3TriggerInsertStep(Parse*,Token*, IdList*,
4985 Select*,u8,Upsert*,
4986 const char*,const char*);
4987 TriggerStep *sqlite3TriggerUpdateStep(Parse*,Token*,SrcList*,ExprList*,
4988 Expr*, u8, const char*,const char*);
4989 TriggerStep *sqlite3TriggerDeleteStep(Parse*,Token*, Expr*,
4990 const char*,const char*);
4991 void sqlite3DeleteTrigger(sqlite3*, Trigger*);
4992 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
4993 u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
4994 SrcList *sqlite3TriggerStepSrc(Parse*, TriggerStep*);
4995 # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
4996 # define sqlite3IsToplevel(p) ((p)->pToplevel==0)
4997 #else
4998 # define sqlite3TriggersExist(B,C,D,E,F) 0
4999 # define sqlite3DeleteTrigger(A,B)
5000 # define sqlite3DropTriggerPtr(A,B)
5001 # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
5002 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
5003 # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
5004 # define sqlite3TriggerList(X, Y) 0
5005 # define sqlite3ParseToplevel(p) p
5006 # define sqlite3IsToplevel(p) 1
5007 # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
5008 # define sqlite3TriggerStepSrc(A,B) 0
5009 #endif
5011 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
5012 int sqlite3ColumnIndex(Table *pTab, const char *zCol);
5013 void sqlite3SrcItemColumnUsed(SrcItem*,int);
5014 void sqlite3SetJoinExpr(Expr*,int,u32);
5015 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
5016 void sqlite3DeferForeignKey(Parse*, int);
5017 #ifndef SQLITE_OMIT_AUTHORIZATION
5018 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
5019 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
5020 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
5021 void sqlite3AuthContextPop(AuthContext*);
5022 int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
5023 #else
5024 # define sqlite3AuthRead(a,b,c,d)
5025 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
5026 # define sqlite3AuthContextPush(a,b,c)
5027 # define sqlite3AuthContextPop(a) ((void)(a))
5028 #endif
5029 int sqlite3DbIsNamed(sqlite3 *db, int iDb, const char *zName);
5030 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
5031 void sqlite3Detach(Parse*, Expr*);
5032 void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
5033 int sqlite3FixSrcList(DbFixer*, SrcList*);
5034 int sqlite3FixSelect(DbFixer*, Select*);
5035 int sqlite3FixExpr(DbFixer*, Expr*);
5036 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
5037 int sqlite3RealSameAsInt(double,sqlite3_int64);
5038 i64 sqlite3RealToI64(double);
5039 int sqlite3Int64ToText(i64,char*);
5040 int sqlite3AtoF(const char *z, double*, int, u8);
5041 int sqlite3GetInt32(const char *, int*);
5042 int sqlite3GetUInt32(const char*, u32*);
5043 int sqlite3Atoi(const char*);
5044 #ifndef SQLITE_OMIT_UTF16
5045 int sqlite3Utf16ByteLen(const void *pData, int nChar);
5046 #endif
5047 int sqlite3Utf8CharLen(const char *pData, int nByte);
5048 u32 sqlite3Utf8Read(const u8**);
5049 LogEst sqlite3LogEst(u64);
5050 LogEst sqlite3LogEstAdd(LogEst,LogEst);
5051 LogEst sqlite3LogEstFromDouble(double);
5052 u64 sqlite3LogEstToInt(LogEst);
5053 VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int);
5054 const char *sqlite3VListNumToName(VList*,int);
5055 int sqlite3VListNameToNum(VList*,const char*,int);
5058 ** Routines to read and write variable-length integers. These used to
5059 ** be defined locally, but now we use the varint routines in the util.c
5060 ** file.
5062 int sqlite3PutVarint(unsigned char*, u64);
5063 u8 sqlite3GetVarint(const unsigned char *, u64 *);
5064 u8 sqlite3GetVarint32(const unsigned char *, u32 *);
5065 int sqlite3VarintLen(u64 v);
5068 ** The common case is for a varint to be a single byte. They following
5069 ** macros handle the common case without a procedure call, but then call
5070 ** the procedure for larger varints.
5072 #define getVarint32(A,B) \
5073 (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
5074 #define getVarint32NR(A,B) \
5075 B=(u32)*(A);if(B>=0x80)sqlite3GetVarint32((A),(u32*)&(B))
5076 #define putVarint32(A,B) \
5077 (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
5078 sqlite3PutVarint((A),(B)))
5079 #define getVarint sqlite3GetVarint
5080 #define putVarint sqlite3PutVarint
5083 const char *sqlite3IndexAffinityStr(sqlite3*, Index*);
5084 char *sqlite3TableAffinityStr(sqlite3*,const Table*);
5085 void sqlite3TableAffinity(Vdbe*, Table*, int);
5086 char sqlite3CompareAffinity(const Expr *pExpr, char aff2);
5087 int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity);
5088 char sqlite3TableColumnAffinity(const Table*,int);
5089 char sqlite3ExprAffinity(const Expr *pExpr);
5090 int sqlite3ExprDataType(const Expr *pExpr);
5091 int sqlite3Atoi64(const char*, i64*, int, u8);
5092 int sqlite3DecOrHexToI64(const char*, i64*);
5093 void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
5094 void sqlite3Error(sqlite3*,int);
5095 void sqlite3ErrorClear(sqlite3*);
5096 void sqlite3SystemError(sqlite3*,int);
5097 void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
5098 u8 sqlite3HexToInt(int h);
5099 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
5101 #if defined(SQLITE_NEED_ERR_NAME)
5102 const char *sqlite3ErrName(int);
5103 #endif
5105 #ifndef SQLITE_OMIT_DESERIALIZE
5106 int sqlite3MemdbInit(void);
5107 int sqlite3IsMemdb(const sqlite3_vfs*);
5108 #else
5109 # define sqlite3IsMemdb(X) 0
5110 #endif
5112 const char *sqlite3ErrStr(int);
5113 int sqlite3ReadSchema(Parse *pParse);
5114 CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
5115 int sqlite3IsBinary(const CollSeq*);
5116 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
5117 void sqlite3SetTextEncoding(sqlite3 *db, u8);
5118 CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr);
5119 CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr);
5120 int sqlite3ExprCollSeqMatch(Parse*,const Expr*,const Expr*);
5121 Expr *sqlite3ExprAddCollateToken(const Parse *pParse, Expr*, const Token*, int);
5122 Expr *sqlite3ExprAddCollateString(const Parse*,Expr*,const char*);
5123 Expr *sqlite3ExprSkipCollate(Expr*);
5124 Expr *sqlite3ExprSkipCollateAndLikely(Expr*);
5125 int sqlite3CheckCollSeq(Parse *, CollSeq *);
5126 int sqlite3WritableSchema(sqlite3*);
5127 int sqlite3CheckObjectName(Parse*, const char*,const char*,const char*);
5128 void sqlite3VdbeSetChanges(sqlite3 *, i64);
5129 int sqlite3AddInt64(i64*,i64);
5130 int sqlite3SubInt64(i64*,i64);
5131 int sqlite3MulInt64(i64*,i64);
5132 int sqlite3AbsInt32(int);
5133 #ifdef SQLITE_ENABLE_8_3_NAMES
5134 void sqlite3FileSuffix3(const char*, char*);
5135 #else
5136 # define sqlite3FileSuffix3(X,Y)
5137 #endif
5138 u8 sqlite3GetBoolean(const char *z,u8);
5140 const void *sqlite3ValueText(sqlite3_value*, u8);
5141 int sqlite3ValueBytes(sqlite3_value*, u8);
5142 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
5143 void(*)(void*));
5144 void sqlite3ValueSetNull(sqlite3_value*);
5145 void sqlite3ValueFree(sqlite3_value*);
5146 #ifndef SQLITE_UNTESTABLE
5147 void sqlite3ResultIntReal(sqlite3_context*);
5148 #endif
5149 sqlite3_value *sqlite3ValueNew(sqlite3 *);
5150 #ifndef SQLITE_OMIT_UTF16
5151 char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
5152 #endif
5153 int sqlite3ValueFromExpr(sqlite3 *, const Expr *, u8, u8, sqlite3_value **);
5154 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
5155 #ifndef SQLITE_AMALGAMATION
5156 extern const unsigned char sqlite3OpcodeProperty[];
5157 extern const char sqlite3StrBINARY[];
5158 extern const unsigned char sqlite3StdTypeLen[];
5159 extern const char sqlite3StdTypeAffinity[];
5160 extern const char *sqlite3StdType[];
5161 extern const unsigned char sqlite3UpperToLower[];
5162 extern const unsigned char *sqlite3aLTb;
5163 extern const unsigned char *sqlite3aEQb;
5164 extern const unsigned char *sqlite3aGTb;
5165 extern const unsigned char sqlite3CtypeMap[];
5166 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
5167 extern FuncDefHash sqlite3BuiltinFunctions;
5168 #ifndef SQLITE_OMIT_WSD
5169 extern int sqlite3PendingByte;
5170 #endif
5171 #endif /* SQLITE_AMALGAMATION */
5172 #ifdef VDBE_PROFILE
5173 extern sqlite3_uint64 sqlite3NProfileCnt;
5174 #endif
5175 void sqlite3RootPageMoved(sqlite3*, int, Pgno, Pgno);
5176 void sqlite3Reindex(Parse*, Token*, Token*);
5177 void sqlite3AlterFunctions(void);
5178 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
5179 void sqlite3AlterRenameColumn(Parse*, SrcList*, Token*, Token*);
5180 int sqlite3GetToken(const unsigned char *, int *);
5181 void sqlite3NestedParse(Parse*, const char*, ...);
5182 void sqlite3ExpirePreparedStatements(sqlite3*, int);
5183 void sqlite3CodeRhsOfIN(Parse*, Expr*, int);
5184 int sqlite3CodeSubselect(Parse*, Expr*);
5185 void sqlite3SelectPrep(Parse*, Select*, NameContext*);
5186 int sqlite3ExpandSubquery(Parse*, SrcItem*);
5187 void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
5188 int sqlite3MatchEName(
5189 const struct ExprList_item*,
5190 const char*,
5191 const char*,
5192 const char*
5194 Bitmask sqlite3ExprColUsed(Expr*);
5195 u8 sqlite3StrIHash(const char*);
5196 int sqlite3ResolveExprNames(NameContext*, Expr*);
5197 int sqlite3ResolveExprListNames(NameContext*, ExprList*);
5198 void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
5199 int sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
5200 int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
5201 void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
5202 void sqlite3AlterFinishAddColumn(Parse *, Token *);
5203 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
5204 void sqlite3AlterDropColumn(Parse*, SrcList*, const Token*);
5205 const void *sqlite3RenameTokenMap(Parse*, const void*, const Token*);
5206 void sqlite3RenameTokenRemap(Parse*, const void *pTo, const void *pFrom);
5207 void sqlite3RenameExprUnmap(Parse*, Expr*);
5208 void sqlite3RenameExprlistUnmap(Parse*, ExprList*);
5209 CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
5210 char sqlite3AffinityType(const char*, Column*);
5211 void sqlite3Analyze(Parse*, Token*, Token*);
5212 int sqlite3InvokeBusyHandler(BusyHandler*);
5213 int sqlite3FindDb(sqlite3*, Token*);
5214 int sqlite3FindDbName(sqlite3 *, const char *);
5215 int sqlite3AnalysisLoad(sqlite3*,int iDB);
5216 void sqlite3DeleteIndexSamples(sqlite3*,Index*);
5217 void sqlite3DefaultRowEst(Index*);
5218 void sqlite3RegisterLikeFunctions(sqlite3*, int);
5219 int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
5220 void sqlite3SchemaClear(void *);
5221 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
5222 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
5223 KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
5224 void sqlite3KeyInfoUnref(KeyInfo*);
5225 KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
5226 KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
5227 KeyInfo *sqlite3KeyInfoFromExprList(Parse*, ExprList*, int, int);
5228 const char *sqlite3SelectOpName(int);
5229 int sqlite3HasExplicitNulls(Parse*, ExprList*);
5231 #ifdef SQLITE_DEBUG
5232 int sqlite3KeyInfoIsWriteable(KeyInfo*);
5233 #endif
5234 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
5235 void (*)(sqlite3_context*,int,sqlite3_value **),
5236 void (*)(sqlite3_context*,int,sqlite3_value **),
5237 void (*)(sqlite3_context*),
5238 void (*)(sqlite3_context*),
5239 void (*)(sqlite3_context*,int,sqlite3_value **),
5240 FuncDestructor *pDestructor
5242 void sqlite3NoopDestructor(void*);
5243 void *sqlite3OomFault(sqlite3*);
5244 void sqlite3OomClear(sqlite3*);
5245 int sqlite3ApiExit(sqlite3 *db, int);
5246 int sqlite3OpenTempDatabase(Parse *);
5248 void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
5249 int sqlite3StrAccumEnlarge(StrAccum*, i64);
5250 char *sqlite3StrAccumFinish(StrAccum*);
5251 void sqlite3StrAccumSetError(StrAccum*, u8);
5252 void sqlite3ResultStrAccum(sqlite3_context*,StrAccum*);
5253 void sqlite3SelectDestInit(SelectDest*,int,int);
5254 Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
5255 void sqlite3RecordErrorByteOffset(sqlite3*,const char*);
5256 void sqlite3RecordErrorOffsetOfExpr(sqlite3*,const Expr*);
5258 void sqlite3BackupRestart(sqlite3_backup *);
5259 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
5261 #ifndef SQLITE_OMIT_SUBQUERY
5262 int sqlite3ExprCheckIN(Parse*, Expr*);
5263 #else
5264 # define sqlite3ExprCheckIN(x,y) SQLITE_OK
5265 #endif
5267 #ifdef SQLITE_ENABLE_STAT4
5268 int sqlite3Stat4ProbeSetValue(
5269 Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*);
5270 int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
5271 void sqlite3Stat4ProbeFree(UnpackedRecord*);
5272 int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
5273 char sqlite3IndexColumnAffinity(sqlite3*, Index*, int);
5274 #endif
5277 ** The interface to the LEMON-generated parser
5279 #ifndef SQLITE_AMALGAMATION
5280 void *sqlite3ParserAlloc(void*(*)(u64), Parse*);
5281 void sqlite3ParserFree(void*, void(*)(void*));
5282 #endif
5283 void sqlite3Parser(void*, int, Token);
5284 int sqlite3ParserFallback(int);
5285 #ifdef YYTRACKMAXSTACKDEPTH
5286 int sqlite3ParserStackPeak(void*);
5287 #endif
5289 void sqlite3AutoLoadExtensions(sqlite3*);
5290 #ifndef SQLITE_OMIT_LOAD_EXTENSION
5291 void sqlite3CloseExtensions(sqlite3*);
5292 #else
5293 # define sqlite3CloseExtensions(X)
5294 #endif
5296 #ifndef SQLITE_OMIT_SHARED_CACHE
5297 void sqlite3TableLock(Parse *, int, Pgno, u8, const char *);
5298 #else
5299 #define sqlite3TableLock(v,w,x,y,z)
5300 #endif
5302 #ifdef SQLITE_TEST
5303 int sqlite3Utf8To8(unsigned char*);
5304 #endif
5306 #ifdef SQLITE_OMIT_VIRTUALTABLE
5307 # define sqlite3VtabClear(D,T)
5308 # define sqlite3VtabSync(X,Y) SQLITE_OK
5309 # define sqlite3VtabRollback(X)
5310 # define sqlite3VtabCommit(X)
5311 # define sqlite3VtabInSync(db) 0
5312 # define sqlite3VtabLock(X)
5313 # define sqlite3VtabUnlock(X)
5314 # define sqlite3VtabModuleUnref(D,X)
5315 # define sqlite3VtabUnlockList(X)
5316 # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
5317 # define sqlite3GetVTable(X,Y) ((VTable*)0)
5318 #else
5319 void sqlite3VtabClear(sqlite3 *db, Table*);
5320 void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
5321 int sqlite3VtabSync(sqlite3 *db, Vdbe*);
5322 int sqlite3VtabRollback(sqlite3 *db);
5323 int sqlite3VtabCommit(sqlite3 *db);
5324 void sqlite3VtabLock(VTable *);
5325 void sqlite3VtabUnlock(VTable *);
5326 void sqlite3VtabModuleUnref(sqlite3*,Module*);
5327 void sqlite3VtabUnlockList(sqlite3*);
5328 int sqlite3VtabSavepoint(sqlite3 *, int, int);
5329 void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
5330 VTable *sqlite3GetVTable(sqlite3*, Table*);
5331 Module *sqlite3VtabCreateModule(
5332 sqlite3*,
5333 const char*,
5334 const sqlite3_module*,
5335 void*,
5336 void(*)(void*)
5338 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
5339 #endif
5340 int sqlite3ReadOnlyShadowTables(sqlite3 *db);
5341 #ifndef SQLITE_OMIT_VIRTUALTABLE
5342 int sqlite3ShadowTableName(sqlite3 *db, const char *zName);
5343 int sqlite3IsShadowTableOf(sqlite3*,Table*,const char*);
5344 void sqlite3MarkAllShadowTablesOf(sqlite3*, Table*);
5345 #else
5346 # define sqlite3ShadowTableName(A,B) 0
5347 # define sqlite3IsShadowTableOf(A,B,C) 0
5348 # define sqlite3MarkAllShadowTablesOf(A,B)
5349 #endif
5350 int sqlite3VtabEponymousTableInit(Parse*,Module*);
5351 void sqlite3VtabEponymousTableClear(sqlite3*,Module*);
5352 void sqlite3VtabMakeWritable(Parse*,Table*);
5353 void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
5354 void sqlite3VtabFinishParse(Parse*, Token*);
5355 void sqlite3VtabArgInit(Parse*);
5356 void sqlite3VtabArgExtend(Parse*, Token*);
5357 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
5358 int sqlite3VtabCallConnect(Parse*, Table*);
5359 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
5360 int sqlite3VtabBegin(sqlite3 *, VTable *);
5362 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
5363 void sqlite3VtabUsesAllSchemas(Parse*);
5364 sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
5365 int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
5366 int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
5367 void sqlite3ParseObjectInit(Parse*,sqlite3*);
5368 void sqlite3ParseObjectReset(Parse*);
5369 void *sqlite3ParserAddCleanup(Parse*,void(*)(sqlite3*,void*),void*);
5370 #ifdef SQLITE_ENABLE_NORMALIZE
5371 char *sqlite3Normalize(Vdbe*, const char*);
5372 #endif
5373 int sqlite3Reprepare(Vdbe*);
5374 void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
5375 CollSeq *sqlite3ExprCompareCollSeq(Parse*,const Expr*);
5376 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, const Expr*, const Expr*);
5377 int sqlite3TempInMemory(const sqlite3*);
5378 const char *sqlite3JournalModename(int);
5379 #ifndef SQLITE_OMIT_WAL
5380 int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
5381 int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
5382 #endif
5383 #ifndef SQLITE_OMIT_CTE
5384 Cte *sqlite3CteNew(Parse*,Token*,ExprList*,Select*,u8);
5385 void sqlite3CteDelete(sqlite3*,Cte*);
5386 With *sqlite3WithAdd(Parse*,With*,Cte*);
5387 void sqlite3WithDelete(sqlite3*,With*);
5388 With *sqlite3WithPush(Parse*, With*, u8);
5389 #else
5390 # define sqlite3CteNew(P,T,E,S) ((void*)0)
5391 # define sqlite3CteDelete(D,C)
5392 # define sqlite3CteWithAdd(P,W,C) ((void*)0)
5393 # define sqlite3WithDelete(x,y)
5394 # define sqlite3WithPush(x,y,z) ((void*)0)
5395 #endif
5396 #ifndef SQLITE_OMIT_UPSERT
5397 Upsert *sqlite3UpsertNew(sqlite3*,ExprList*,Expr*,ExprList*,Expr*,Upsert*);
5398 void sqlite3UpsertDelete(sqlite3*,Upsert*);
5399 Upsert *sqlite3UpsertDup(sqlite3*,Upsert*);
5400 int sqlite3UpsertAnalyzeTarget(Parse*,SrcList*,Upsert*);
5401 void sqlite3UpsertDoUpdate(Parse*,Upsert*,Table*,Index*,int);
5402 Upsert *sqlite3UpsertOfIndex(Upsert*,Index*);
5403 int sqlite3UpsertNextIsIPK(Upsert*);
5404 #else
5405 #define sqlite3UpsertNew(u,v,w,x,y,z) ((Upsert*)0)
5406 #define sqlite3UpsertDelete(x,y)
5407 #define sqlite3UpsertDup(x,y) ((Upsert*)0)
5408 #define sqlite3UpsertOfIndex(x,y) ((Upsert*)0)
5409 #define sqlite3UpsertNextIsIPK(x) 0
5410 #endif
5413 /* Declarations for functions in fkey.c. All of these are replaced by
5414 ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
5415 ** key functionality is available. If OMIT_TRIGGER is defined but
5416 ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
5417 ** this case foreign keys are parsed, but no other functionality is
5418 ** provided (enforcement of FK constraints requires the triggers sub-system).
5420 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
5421 void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
5422 void sqlite3FkDropTable(Parse*, SrcList *, Table*);
5423 void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
5424 int sqlite3FkRequired(Parse*, Table*, int*, int);
5425 u32 sqlite3FkOldmask(Parse*, Table*);
5426 FKey *sqlite3FkReferences(Table *);
5427 void sqlite3FkClearTriggerCache(sqlite3*,int);
5428 #else
5429 #define sqlite3FkActions(a,b,c,d,e,f)
5430 #define sqlite3FkCheck(a,b,c,d,e,f)
5431 #define sqlite3FkDropTable(a,b,c)
5432 #define sqlite3FkOldmask(a,b) 0
5433 #define sqlite3FkRequired(a,b,c,d) 0
5434 #define sqlite3FkReferences(a) 0
5435 #define sqlite3FkClearTriggerCache(a,b)
5436 #endif
5437 #ifndef SQLITE_OMIT_FOREIGN_KEY
5438 void sqlite3FkDelete(sqlite3 *, Table*);
5439 int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
5440 #else
5441 #define sqlite3FkDelete(a,b)
5442 #define sqlite3FkLocateIndex(a,b,c,d,e)
5443 #endif
5447 ** Available fault injectors. Should be numbered beginning with 0.
5449 #define SQLITE_FAULTINJECTOR_MALLOC 0
5450 #define SQLITE_FAULTINJECTOR_COUNT 1
5453 ** The interface to the code in fault.c used for identifying "benign"
5454 ** malloc failures. This is only present if SQLITE_UNTESTABLE
5455 ** is not defined.
5457 #ifndef SQLITE_UNTESTABLE
5458 void sqlite3BeginBenignMalloc(void);
5459 void sqlite3EndBenignMalloc(void);
5460 #else
5461 #define sqlite3BeginBenignMalloc()
5462 #define sqlite3EndBenignMalloc()
5463 #endif
5466 ** Allowed return values from sqlite3FindInIndex()
5468 #define IN_INDEX_ROWID 1 /* Search the rowid of the table */
5469 #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */
5470 #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */
5471 #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */
5472 #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */
5474 ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
5476 #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */
5477 #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */
5478 #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */
5479 int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*, int*);
5481 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
5482 int sqlite3JournalSize(sqlite3_vfs *);
5483 #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
5484 || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
5485 int sqlite3JournalCreate(sqlite3_file *);
5486 #endif
5488 int sqlite3JournalIsInMemory(sqlite3_file *p);
5489 void sqlite3MemJournalOpen(sqlite3_file *);
5491 void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
5492 #if SQLITE_MAX_EXPR_DEPTH>0
5493 int sqlite3SelectExprHeight(const Select *);
5494 int sqlite3ExprCheckHeight(Parse*, int);
5495 #else
5496 #define sqlite3SelectExprHeight(x) 0
5497 #define sqlite3ExprCheckHeight(x,y)
5498 #endif
5500 u32 sqlite3Get4byte(const u8*);
5501 void sqlite3Put4byte(u8*, u32);
5503 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
5504 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
5505 void sqlite3ConnectionUnlocked(sqlite3 *db);
5506 void sqlite3ConnectionClosed(sqlite3 *db);
5507 #else
5508 #define sqlite3ConnectionBlocked(x,y)
5509 #define sqlite3ConnectionUnlocked(x)
5510 #define sqlite3ConnectionClosed(x)
5511 #endif
5513 #ifdef SQLITE_DEBUG
5514 void sqlite3ParserTrace(FILE*, char *);
5515 #endif
5516 #if defined(YYCOVERAGE)
5517 int sqlite3ParserCoverage(FILE*);
5518 #endif
5521 ** If the SQLITE_ENABLE IOTRACE exists then the global variable
5522 ** sqlite3IoTrace is a pointer to a printf-like routine used to
5523 ** print I/O tracing messages.
5525 #ifdef SQLITE_ENABLE_IOTRACE
5526 # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
5527 void sqlite3VdbeIOTraceSql(Vdbe*);
5528 SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
5529 #else
5530 # define IOTRACE(A)
5531 # define sqlite3VdbeIOTraceSql(X)
5532 #endif
5535 ** These routines are available for the mem2.c debugging memory allocator
5536 ** only. They are used to verify that different "types" of memory
5537 ** allocations are properly tracked by the system.
5539 ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
5540 ** the MEMTYPE_* macros defined below. The type must be a bitmask with
5541 ** a single bit set.
5543 ** sqlite3MemdebugHasType() returns true if any of the bits in its second
5544 ** argument match the type set by the previous sqlite3MemdebugSetType().
5545 ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
5547 ** sqlite3MemdebugNoType() returns true if none of the bits in its second
5548 ** argument match the type set by the previous sqlite3MemdebugSetType().
5550 ** Perhaps the most important point is the difference between MEMTYPE_HEAP
5551 ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means
5552 ** it might have been allocated by lookaside, except the allocation was
5553 ** too large or lookaside was already full. It is important to verify
5554 ** that allocations that might have been satisfied by lookaside are not
5555 ** passed back to non-lookaside free() routines. Asserts such as the
5556 ** example above are placed on the non-lookaside free() routines to verify
5557 ** this constraint.
5559 ** All of this is no-op for a production build. It only comes into
5560 ** play when the SQLITE_MEMDEBUG compile-time option is used.
5562 #ifdef SQLITE_MEMDEBUG
5563 void sqlite3MemdebugSetType(void*,u8);
5564 int sqlite3MemdebugHasType(const void*,u8);
5565 int sqlite3MemdebugNoType(const void*,u8);
5566 #else
5567 # define sqlite3MemdebugSetType(X,Y) /* no-op */
5568 # define sqlite3MemdebugHasType(X,Y) 1
5569 # define sqlite3MemdebugNoType(X,Y) 1
5570 #endif
5571 #define MEMTYPE_HEAP 0x01 /* General heap allocations */
5572 #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */
5573 #define MEMTYPE_PCACHE 0x04 /* Page cache allocations */
5576 ** Threading interface
5578 #if SQLITE_MAX_WORKER_THREADS>0
5579 int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
5580 int sqlite3ThreadJoin(SQLiteThread*, void**);
5581 #endif
5583 #if defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST)
5584 int sqlite3DbpageRegister(sqlite3*);
5585 #endif
5586 #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
5587 int sqlite3DbstatRegister(sqlite3*);
5588 #endif
5590 int sqlite3ExprVectorSize(const Expr *pExpr);
5591 int sqlite3ExprIsVector(const Expr *pExpr);
5592 Expr *sqlite3VectorFieldSubexpr(Expr*, int);
5593 Expr *sqlite3ExprForVectorField(Parse*,Expr*,int,int);
5594 void sqlite3VectorErrorMsg(Parse*, Expr*);
5596 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
5597 const char **sqlite3CompileOptions(int *pnOpt);
5598 #endif
5600 #if SQLITE_OS_UNIX && defined(SQLITE_OS_KV_OPTIONAL)
5601 int sqlite3KvvfsInit(void);
5602 #endif
5604 #if defined(VDBE_PROFILE) \
5605 || defined(SQLITE_PERFORMANCE_TRACE) \
5606 || defined(SQLITE_ENABLE_STMT_SCANSTATUS)
5607 sqlite3_uint64 sqlite3Hwtime(void);
5608 #endif
5610 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
5611 # define IS_STMT_SCANSTATUS(db) (db->flags & SQLITE_StmtScanStatus)
5612 #else
5613 # define IS_STMT_SCANSTATUS(db) 0
5614 #endif
5616 #endif /* SQLITEINT_H */