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