blob: 5acfe38c5be26cc02f352f5b896866e8e37ef877 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Internal interface definitions for SQLite.
13**
drh75897232000-05-29 14:26:00 +000014*/
danielk1977e3026632004-06-22 11:29:02 +000015#ifndef _SQLITEINT_H_
16#define _SQLITEINT_H_
drh71674ce2007-10-23 15:51:26 +000017
mlcreechbd0ae112008-03-06 09:16:24 +000018/*
drh2210dcc2009-08-12 11:45:40 +000019** These #defines should enable >2GB file support on POSIX if the
20** underlying operating system supports it. If the OS lacks
21** large file support, or if the OS is windows, these should be no-ops.
22**
23** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
24** system #includes. Hence, this block of code must be the very first
25** code in all source files.
26**
27** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
28** on the compiler command line. This is necessary if you are compiling
29** on a recent machine (ex: Red Hat 7.2) but you want your code to work
30** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
31** without this option, LFS is enable. But LFS does not exist in the kernel
32** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
33** portability you should omit LFS.
34**
35** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
36*/
37#ifndef SQLITE_DISABLE_LFS
38# define _LARGE_FILE 1
39# ifndef _FILE_OFFSET_BITS
40# define _FILE_OFFSET_BITS 64
41# endif
42# define _LARGEFILE_SOURCE 1
43#endif
44
45/*
mlcreech1e12d432008-05-07 02:42:01 +000046** Include the configuration header output by 'configure' if we're using the
47** autoconf-based build
mlcreechbd0ae112008-03-06 09:16:24 +000048*/
mlcreech1e12d432008-05-07 02:42:01 +000049#ifdef _HAVE_SQLITE_CONFIG_H
mlcreech98dc4b12008-03-06 16:28:58 +000050#include "config.h"
mlcreech1e12d432008-05-07 02:42:01 +000051#endif
52
drhbb4957f2008-03-20 14:03:29 +000053#include "sqliteLimit.h"
mlcreech98dc4b12008-03-06 16:28:58 +000054
drhe2965822008-04-10 16:47:41 +000055/* Disable nuisance warnings on Borland compilers */
56#if defined(__BORLANDC__)
57#pragma warn -rch /* unreachable code */
58#pragma warn -ccc /* Condition is always true or false */
59#pragma warn -aus /* Assigned value is never used */
60#pragma warn -csu /* Comparing signed and unsigned */
shane467bcf32008-11-24 20:01:32 +000061#pragma warn -spa /* Suspicious pointer arithmetic */
drhe2965822008-04-10 16:47:41 +000062#endif
63
mlcreech98dc4b12008-03-06 16:28:58 +000064/* Needed for various definitions... */
drh60323412008-07-31 17:35:45 +000065#ifndef _GNU_SOURCE
66# define _GNU_SOURCE
67#endif
mlcreech98dc4b12008-03-06 16:28:58 +000068
dan881bd792013-03-11 13:37:52 +000069#if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
70# define _BSD_SOURCE
71#endif
72
mlcreech98dc4b12008-03-06 16:28:58 +000073/*
drh06af7632008-04-28 12:54:15 +000074** Include standard header files as necessary
75*/
76#ifdef HAVE_STDINT_H
77#include <stdint.h>
78#endif
79#ifdef HAVE_INTTYPES_H
80#include <inttypes.h>
81#endif
82
drha2460e02010-01-14 00:39:26 +000083/*
drhc05a9a82010-03-04 16:12:34 +000084** The following macros are used to cast pointers to integers and
85** integers to pointers. The way you do this varies from one compiler
86** to the next, so we have developed the following set of #if statements
87** to generate appropriate macros for a wide range of compilers.
drh875e9e72009-05-16 17:38:21 +000088**
drhc05a9a82010-03-04 16:12:34 +000089** The correct "ANSI" way to do this is to use the intptr_t type.
90** Unfortunately, that typedef is not available on all compilers, or
91** if it is available, it requires an #include of specific headers
drhc92271c2010-03-10 14:06:35 +000092** that vary from one machine to the next.
drh875e9e72009-05-16 17:38:21 +000093**
94** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on
95** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)).
drh5e49edc2009-05-18 13:34:37 +000096** So we have to define the macros in different ways depending on the
drh875e9e72009-05-16 17:38:21 +000097** compiler.
98*/
drhc05a9a82010-03-04 16:12:34 +000099#if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */
100# define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X))
101# define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X))
102#elif !defined(__GNUC__) /* Works for compilers other than LLVM */
103# define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
104# define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
105#elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */
106# define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X))
107# define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X))
108#else /* Generates a warning - but it always works */
109# define SQLITE_INT_TO_PTR(X) ((void*)(X))
110# define SQLITE_PTR_TO_INT(X) ((int)(X))
drh875e9e72009-05-16 17:38:21 +0000111#endif
drhb6dbc002007-11-27 02:38:00 +0000112
drhe5e7a902007-10-01 17:47:00 +0000113/*
drh38c67c32010-09-08 02:30:27 +0000114** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
115** 0 means mutexes are permanently disable and the library is never
116** threadsafe. 1 means the library is serialized which is the highest
drhf7b54962013-05-28 12:11:54 +0000117** level of threadsafety. 2 means the library is multithreaded - multiple
drh38c67c32010-09-08 02:30:27 +0000118** threads can use SQLite as long as no two threads try to use the same
119** database connection at the same time.
120**
drhe5e7a902007-10-01 17:47:00 +0000121** Older versions of SQLite used an optional THREADSAFE macro.
drh38c67c32010-09-08 02:30:27 +0000122** We support that for legacy.
drhe5e7a902007-10-01 17:47:00 +0000123*/
124#if !defined(SQLITE_THREADSAFE)
drhd16d0bc2013-04-16 18:24:34 +0000125# if defined(THREADSAFE)
126# define SQLITE_THREADSAFE THREADSAFE
127# else
128# define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
129# endif
drhe5e7a902007-10-01 17:47:00 +0000130#endif
131
drh67080612007-10-01 14:30:14 +0000132/*
drhcb15f352011-12-23 01:04:17 +0000133** Powersafe overwrite is on by default. But can be turned off using
134** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
135*/
136#ifndef SQLITE_POWERSAFE_OVERWRITE
137# define SQLITE_POWERSAFE_OVERWRITE 1
138#endif
139
140/*
danielk19770a732f52008-09-04 17:17:38 +0000141** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1.
142** It determines whether or not the features related to
shane467bcf32008-11-24 20:01:32 +0000143** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can
danielk19770a732f52008-09-04 17:17:38 +0000144** be overridden at runtime using the sqlite3_config() API.
145*/
146#if !defined(SQLITE_DEFAULT_MEMSTATUS)
147# define SQLITE_DEFAULT_MEMSTATUS 1
148#endif
149
150/*
drh0d180202008-02-14 23:26:56 +0000151** Exactly one of the following macros must be defined in order to
152** specify which memory allocation subsystem to use.
153**
154** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
mistachkin1b186a92011-08-24 16:13:57 +0000155** SQLITE_WIN32_MALLOC // Use Win32 native heap API
drhd1b0afc2012-06-21 14:25:17 +0000156** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails
drh0d180202008-02-14 23:26:56 +0000157** SQLITE_MEMDEBUG // Debugging version of system malloc()
drha2460e02010-01-14 00:39:26 +0000158**
mistachkin753c5442011-08-25 02:02:25 +0000159** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
160** assert() macro is enabled, each call into the Win32 native heap subsystem
161** will cause HeapValidate to be called. If heap validation should fail, an
162** assertion will be triggered.
163**
drh0d180202008-02-14 23:26:56 +0000164** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
165** the default.
166*/
drhd1b0afc2012-06-21 14:25:17 +0000167#if defined(SQLITE_SYSTEM_MALLOC) \
168 + defined(SQLITE_WIN32_MALLOC) \
169 + defined(SQLITE_ZERO_MALLOC) \
170 + defined(SQLITE_MEMDEBUG)>1
171# error "Two or more of the following compile-time configuration options\
mistachkin20b1ff02012-06-21 15:12:30 +0000172 are defined but at most one is allowed:\
drhd1b0afc2012-06-21 14:25:17 +0000173 SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
174 SQLITE_ZERO_MALLOC"
drh0d180202008-02-14 23:26:56 +0000175#endif
drhd1b0afc2012-06-21 14:25:17 +0000176#if defined(SQLITE_SYSTEM_MALLOC) \
177 + defined(SQLITE_WIN32_MALLOC) \
178 + defined(SQLITE_ZERO_MALLOC) \
179 + defined(SQLITE_MEMDEBUG)==0
drh0d180202008-02-14 23:26:56 +0000180# define SQLITE_SYSTEM_MALLOC 1
181#endif
182
183/*
drh8a1e5942009-04-28 15:43:45 +0000184** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
drheee4c8c2008-02-18 22:24:57 +0000185** sizes of memory allocations below this value where possible.
186*/
drh8a1e5942009-04-28 15:43:45 +0000187#if !defined(SQLITE_MALLOC_SOFT_LIMIT)
drheee4c8c2008-02-18 22:24:57 +0000188# define SQLITE_MALLOC_SOFT_LIMIT 1024
189#endif
190
191/*
drh67080612007-10-01 14:30:14 +0000192** We need to define _XOPEN_SOURCE as follows in order to enable
drh40b521f2013-05-24 12:47:26 +0000193** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
194** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
195** it.
drh67080612007-10-01 14:30:14 +0000196*/
drh40b521f2013-05-24 12:47:26 +0000197#if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
198# define _XOPEN_SOURCE 600
drh67080612007-10-01 14:30:14 +0000199#endif
danielk1977e3026632004-06-22 11:29:02 +0000200
drh7d10d5a2008-08-20 16:35:10 +0000201/*
drh1b28b892012-05-29 19:25:20 +0000202** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that
203** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true,
204** make it true by defining or undefining NDEBUG.
205**
drh443dbcf2013-07-29 15:54:06 +0000206** Setting NDEBUG makes the code smaller and faster by disabling the
207** assert() statements in the code. So we want the default action
drh1b28b892012-05-29 19:25:20 +0000208** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
209** is set. Thus NDEBUG becomes an opt-in rather than an opt-out
drh4b529d92005-09-13 00:00:00 +0000210** feature.
211*/
danielk1977771151b2006-01-17 13:21:40 +0000212#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +0000213# define NDEBUG 1
214#endif
drh1b28b892012-05-29 19:25:20 +0000215#if defined(NDEBUG) && defined(SQLITE_DEBUG)
216# undef NDEBUG
217#endif
drh4b529d92005-09-13 00:00:00 +0000218
drh64022502009-01-09 14:11:04 +0000219/*
drh47c3b3e2009-01-10 16:15:20 +0000220** The testcase() macro is used to aid in coverage testing. When
221** doing coverage testing, the condition inside the argument to
222** testcase() must be evaluated both true and false in order to
223** get full branch coverage. The testcase() macro is inserted
224** to help ensure adequate test coverage in places where simple
225** condition/decision coverage is inadequate. For example, testcase()
226** can be used to make sure boundary values are tested. For
227** bitmask tests, testcase() can be used to make sure each bit
228** is significant and used at least once. On switch statements
229** where multiple cases go to the same block of code, testcase()
230** can insure that all cases are evaluated.
231**
drh47c3b3e2009-01-10 16:15:20 +0000232*/
233#ifdef SQLITE_COVERAGE_TEST
234 void sqlite3Coverage(int);
235# define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
drh47c3b3e2009-01-10 16:15:20 +0000236#else
237# define testcase(X)
drh8f941bc2009-01-14 23:03:40 +0000238#endif
239
240/*
241** The TESTONLY macro is used to enclose variable declarations or
242** other bits of code that are needed to support the arguments
243** within testcase() and assert() macros.
244*/
245#if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
246# define TESTONLY(X) X
247#else
drh47c3b3e2009-01-10 16:15:20 +0000248# define TESTONLY(X)
249#endif
250
251/*
drh61495262009-04-22 15:32:59 +0000252** Sometimes we need a small amount of code such as a variable initialization
253** to setup for a later assert() statement. We do not want this code to
254** appear when assert() is disabled. The following macro is therefore
255** used to contain that setup code. The "VVA" acronym stands for
256** "Verification, Validation, and Accreditation". In other words, the
257** code within VVA_ONLY() will only run during verification processes.
258*/
259#ifndef NDEBUG
260# define VVA_ONLY(X) X
261#else
262# define VVA_ONLY(X)
263#endif
264
265/*
drh47c3b3e2009-01-10 16:15:20 +0000266** The ALWAYS and NEVER macros surround boolean expressions which
267** are intended to always be true or false, respectively. Such
268** expressions could be omitted from the code completely. But they
269** are included in a few cases in order to enhance the resilience
270** of SQLite to unexpected behavior - to make the code "self-healing"
271** or "ductile" rather than being "brittle" and crashing at the first
272** hint of unplanned behavior.
273**
274** In other words, ALWAYS and NEVER are added for defensive code.
275**
276** When doing coverage testing ALWAYS and NEVER are hard-coded to
drh443dbcf2013-07-29 15:54:06 +0000277** be true and false so that the unreachable code they specify will
drh47c3b3e2009-01-10 16:15:20 +0000278** not be counted as untested code.
279*/
280#if defined(SQLITE_COVERAGE_TEST)
281# define ALWAYS(X) (1)
282# define NEVER(X) (0)
283#elif !defined(NDEBUG)
drh2de80f42009-06-24 10:26:32 +0000284# define ALWAYS(X) ((X)?1:(assert(0),0))
285# define NEVER(X) ((X)?(assert(0),1):0)
drh47c3b3e2009-01-10 16:15:20 +0000286#else
287# define ALWAYS(X) (X)
288# define NEVER(X) (X)
289#endif
290
291/*
drh3e8e7ec2010-07-07 13:43:19 +0000292** Return true (non-zero) if the input is a integer that is too large
293** to fit in 32-bits. This macro is used inside of various testcase()
294** macros to verify that we have tested SQLite for large-file support.
295*/
danb31a6af2010-07-14 06:20:26 +0000296#define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0)
drh3e8e7ec2010-07-07 13:43:19 +0000297
298/*
drh47c3b3e2009-01-10 16:15:20 +0000299** The macro unlikely() is a hint that surrounds a boolean
300** expression that is usually false. Macro likely() surrounds
drh443dbcf2013-07-29 15:54:06 +0000301** a boolean expression that is usually true. These hints could,
302** in theory, be used by the compiler to generate better code, but
303** currently they are just comments for human readers.
drh47c3b3e2009-01-10 16:15:20 +0000304*/
drh443dbcf2013-07-29 15:54:06 +0000305#define likely(X) (X)
306#define unlikely(X) (X)
drh47c3b3e2009-01-10 16:15:20 +0000307
drh1d482dd2004-05-31 18:23:07 +0000308#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +0000309#include "hash.h"
drh75897232000-05-29 14:26:00 +0000310#include "parse.h"
drh75897232000-05-29 14:26:00 +0000311#include <stdio.h>
312#include <stdlib.h>
313#include <string.h>
314#include <assert.h>
drh52370e22005-01-21 21:31:40 +0000315#include <stddef.h>
drh75897232000-05-29 14:26:00 +0000316
drh967e8b72000-06-21 13:59:10 +0000317/*
drhb37df7b2005-10-13 02:09:49 +0000318** If compiling for a processor that lacks floating point support,
319** substitute integer for floating-point
320*/
321#ifdef SQLITE_OMIT_FLOATING_POINT
322# define double sqlite_int64
drh8b307fb2010-04-06 15:57:05 +0000323# define float sqlite_int64
drhb37df7b2005-10-13 02:09:49 +0000324# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +0000325# ifndef SQLITE_BIG_DBL
drhcdaca552009-08-20 13:45:07 +0000326# define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
drhd1167392006-01-23 13:00:35 +0000327# endif
drhb37df7b2005-10-13 02:09:49 +0000328# define SQLITE_OMIT_DATETIME_FUNCS 1
329# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +0000330# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drh0b3bf922009-06-15 20:45:34 +0000331# undef SQLITE_HAVE_ISNAN
drhb37df7b2005-10-13 02:09:49 +0000332#endif
drhd1167392006-01-23 13:00:35 +0000333#ifndef SQLITE_BIG_DBL
334# define SQLITE_BIG_DBL (1e99)
335#endif
drhb37df7b2005-10-13 02:09:49 +0000336
337/*
danielk197753c0f742005-03-29 03:10:59 +0000338** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
339** afterward. Having this macro allows us to cause the C compiler
340** to omit code used by TEMP tables without messy #ifndef statements.
341*/
342#ifdef SQLITE_OMIT_TEMPDB
343#define OMIT_TEMPDB 1
344#else
345#define OMIT_TEMPDB 0
346#endif
347
348/*
drhd946db02005-12-29 19:23:06 +0000349** The "file format" number is an integer that is incremented whenever
350** the VDBE-level file format changes. The following macros define the
351** the default file format for new databases and the maximum file format
352** that the library can read.
353*/
354#define SQLITE_MAX_FILE_FORMAT 4
355#ifndef SQLITE_DEFAULT_FILE_FORMAT
drhbf3f5f82011-11-07 13:05:23 +0000356# define SQLITE_DEFAULT_FILE_FORMAT 4
drhd946db02005-12-29 19:23:06 +0000357#endif
358
drha2460e02010-01-14 00:39:26 +0000359/*
360** Determine whether triggers are recursive by default. This can be
361** changed at run-time using a pragma.
362*/
dan5bde73c2009-09-01 17:11:07 +0000363#ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
364# define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
365#endif
366
drhd946db02005-12-29 19:23:06 +0000367/*
danielk1977b06a0b62008-06-26 10:54:12 +0000368** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
drh49766d62005-01-08 18:42:28 +0000369** on the command-line
370*/
danielk1977b06a0b62008-06-26 10:54:12 +0000371#ifndef SQLITE_TEMP_STORE
372# define SQLITE_TEMP_STORE 1
drhd16d0bc2013-04-16 18:24:34 +0000373# define SQLITE_TEMP_STORE_xc 1 /* Exclude from ctime.c */
drh49766d62005-01-08 18:42:28 +0000374#endif
375
376/*
drhf1974842004-11-05 03:56:00 +0000377** GCC does not define the offsetof() macro so we'll have to do it
378** ourselves.
379*/
380#ifndef offsetof
381#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
382#endif
383
384/*
drhe1e2e9a2013-06-13 15:16:53 +0000385** Macros to compute minimum and maximum of two numbers.
386*/
387#define MIN(A,B) ((A)<(B)?(A):(B))
388#define MAX(A,B) ((A)>(B)?(A):(B))
389
390/*
drh9b8f4472006-04-04 01:54:55 +0000391** Check to see if this machine uses EBCDIC. (Yes, believe it or
392** not, there are still machines out there that use EBCDIC.)
393*/
394#if 'A' == '\301'
395# define SQLITE_EBCDIC 1
396#else
397# define SQLITE_ASCII 1
398#endif
399
400/*
drh5a2c2c22001-11-21 02:21:11 +0000401** Integers of known sizes. These typedefs might change for architectures
402** where the sizes very. Preprocessor macros are available so that the
403** types can be conveniently redefined at compile-type. Like this:
404**
405** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000406*/
drh5a2c2c22001-11-21 02:21:11 +0000407#ifndef UINT32_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000408# ifdef HAVE_UINT32_T
409# define UINT32_TYPE uint32_t
410# else
411# define UINT32_TYPE unsigned int
412# endif
drh5a2c2c22001-11-21 02:21:11 +0000413#endif
414#ifndef UINT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000415# ifdef HAVE_UINT16_T
416# define UINT16_TYPE uint16_t
417# else
418# define UINT16_TYPE unsigned short int
419# endif
drh5a2c2c22001-11-21 02:21:11 +0000420#endif
drh939a16d2004-07-15 13:37:22 +0000421#ifndef INT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000422# ifdef HAVE_INT16_T
423# define INT16_TYPE int16_t
424# else
425# define INT16_TYPE short int
426# endif
drh939a16d2004-07-15 13:37:22 +0000427#endif
drh5a2c2c22001-11-21 02:21:11 +0000428#ifndef UINT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000429# ifdef HAVE_UINT8_T
430# define UINT8_TYPE uint8_t
431# else
432# define UINT8_TYPE unsigned char
433# endif
drh5a2c2c22001-11-21 02:21:11 +0000434#endif
drh905793e2004-02-21 13:31:09 +0000435#ifndef INT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000436# ifdef HAVE_INT8_T
437# define INT8_TYPE int8_t
438# else
439# define INT8_TYPE signed char
440# endif
drh905793e2004-02-21 13:31:09 +0000441#endif
drhefad9992004-06-22 12:13:55 +0000442#ifndef LONGDOUBLE_TYPE
443# define LONGDOUBLE_TYPE long double
444#endif
drhefad9992004-06-22 12:13:55 +0000445typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000446typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000447typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
448typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000449typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000450typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh70a8ca32008-08-21 18:49:27 +0000451typedef INT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000452
453/*
drh35cd6432009-06-05 14:17:21 +0000454** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
455** that can be stored in a u32 without loss of data. The value
456** is 0x00000000ffffffff. But because of quirks of some compilers, we
457** have to specify the value in the less intuitive manner shown:
458*/
459#define SQLITE_MAX_U32 ((((u64)1)<<32)-1)
460
461/*
drhfaacf172011-08-12 01:51:45 +0000462** The datatype used to store estimates of the number of rows in a
463** table or index. This is an unsigned integer type. For 99.9% of
464** the world, a 32-bit integer is sufficient. But a 64-bit integer
465** can be used at compile-time if desired.
466*/
467#ifdef SQLITE_64BIT_STATS
468 typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */
469#else
470 typedef u32 tRowcnt; /* 32-bit is the default */
471#endif
472
473/*
drhbbd42a62004-05-22 17:41:58 +0000474** Macros to determine whether the machine is big or little endian,
475** evaluated at runtime.
476*/
drh46c99e02007-08-27 23:26:59 +0000477#ifdef SQLITE_AMALGAMATION
drhb3190c12008-12-08 21:37:14 +0000478const int sqlite3one = 1;
drh46c99e02007-08-27 23:26:59 +0000479#else
drhbbd42a62004-05-22 17:41:58 +0000480extern const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000481#endif
drh189077f2008-10-11 18:11:21 +0000482#if defined(i386) || defined(__i386__) || defined(_M_IX86)\
483 || defined(__x86_64) || defined(__x86_64__)
drh38def052007-03-31 15:27:59 +0000484# define SQLITE_BIGENDIAN 0
485# define SQLITE_LITTLEENDIAN 1
486# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
487#else
488# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
489# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
490# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
491#endif
drhbbd42a62004-05-22 17:41:58 +0000492
493/*
drh0f050352008-05-09 18:03:13 +0000494** Constants for the largest and smallest possible 64-bit signed integers.
495** These macros are designed to work correctly on both 32-bit and 64-bit
496** compilers.
497*/
498#define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
499#define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
500
danielk1977be229652009-03-20 14:18:51 +0000501/*
502** Round up a number to the next larger multiple of 8. This is used
503** to force 8-byte alignment on 64-bit architectures.
504*/
danielk1977bc739712009-03-23 04:33:32 +0000505#define ROUND8(x) (((x)+7)&~7)
506
507/*
508** Round down to the nearest multiple of 8
509*/
510#define ROUNDDOWN8(x) ((x)&~7)
danielk1977be229652009-03-20 14:18:51 +0000511
drh0f050352008-05-09 18:03:13 +0000512/*
drh8e14c592009-12-04 23:10:12 +0000513** Assert that the pointer X is aligned to an 8-byte boundary. This
514** macro is used only within assert() to verify that the code gets
515** all alignment restrictions correct.
516**
517** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
518** underlying malloc() implemention might return us 4-byte aligned
519** pointers. In that case, only verify 4-byte alignment.
drhea598cb2009-04-05 12:22:08 +0000520*/
drh8e14c592009-12-04 23:10:12 +0000521#ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
522# define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0)
523#else
524# define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0)
525#endif
drhea598cb2009-04-05 12:22:08 +0000526
drh188d4882013-04-08 20:47:49 +0000527/*
drh9b4c59f2013-04-15 17:03:42 +0000528** Disable MMAP on platforms where it is known to not work
drh188d4882013-04-08 20:47:49 +0000529*/
530#if defined(__OpenBSD__) || defined(__QNXNTO__)
drh9b4c59f2013-04-15 17:03:42 +0000531# undef SQLITE_MAX_MMAP_SIZE
532# define SQLITE_MAX_MMAP_SIZE 0
drh188d4882013-04-08 20:47:49 +0000533#endif
534
drh9b4c59f2013-04-15 17:03:42 +0000535/*
536** Default maximum size of memory used by memory-mapped I/O in the VFS
537*/
538#ifdef __APPLE__
539# include <TargetConditionals.h>
540# if TARGET_OS_IPHONE
541# undef SQLITE_MAX_MMAP_SIZE
542# define SQLITE_MAX_MMAP_SIZE 0
543# endif
544#endif
545#ifndef SQLITE_MAX_MMAP_SIZE
546# if defined(__linux__) \
547 || defined(_WIN32) \
548 || (defined(__APPLE__) && defined(__MACH__)) \
549 || defined(__sun)
drh2bba8c22013-04-26 12:08:29 +0000550# define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */
drh9b4c59f2013-04-15 17:03:42 +0000551# else
552# define SQLITE_MAX_MMAP_SIZE 0
553# endif
drhd16d0bc2013-04-16 18:24:34 +0000554# define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */
drh9b4c59f2013-04-15 17:03:42 +0000555#endif
556
557/*
558** The default MMAP_SIZE is zero on all platforms. Or, even if a larger
559** default MMAP_SIZE is specified at compile-time, make sure that it does
560** not exceed the maximum mmap size.
561*/
562#ifndef SQLITE_DEFAULT_MMAP_SIZE
563# define SQLITE_DEFAULT_MMAP_SIZE 0
drhd16d0bc2013-04-16 18:24:34 +0000564# define SQLITE_DEFAULT_MMAP_SIZE_xc 1 /* Exclude from ctime.c */
drh9b4c59f2013-04-15 17:03:42 +0000565#endif
566#if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
567# undef SQLITE_DEFAULT_MMAP_SIZE
568# define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
569#endif
drhe7b347072009-06-01 18:18:20 +0000570
drhea598cb2009-04-05 12:22:08 +0000571/*
drh1435a9a2013-08-27 23:15:44 +0000572** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
573** Priority is given to SQLITE_ENABLE_STAT4. If either are defined, also
574** define SQLITE_ENABLE_STAT3_OR_STAT4
575*/
576#ifdef SQLITE_ENABLE_STAT4
577# undef SQLITE_ENABLE_STAT3
578# define SQLITE_ENABLE_STAT3_OR_STAT4 1
579#elif SQLITE_ENABLE_STAT3
580# define SQLITE_ENABLE_STAT3_OR_STAT4 1
581#elif SQLITE_ENABLE_STAT3_OR_STAT4
582# undef SQLITE_ENABLE_STAT3_OR_STAT4
583#endif
584
585/*
drh90f5ecb2004-07-22 01:19:35 +0000586** An instance of the following structure is used to store the busy-handler
587** callback for a given sqlite handle.
588**
589** The sqlite.busyHandler member of the sqlite struct contains the busy
590** callback for the database handle. Each pager opened via the sqlite
591** handle is passed a pointer to sqlite.busyHandler. The busy-handler
592** callback is currently invoked only from within pager.c.
593*/
594typedef struct BusyHandler BusyHandler;
595struct BusyHandler {
596 int (*xFunc)(void *,int); /* The busy callback */
597 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000598 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000599};
600
601/*
drh75897232000-05-29 14:26:00 +0000602** Name of the master database table. The master database table
603** is a special table that holds the names and attributes of all
604** user tables and indices.
605*/
drhe0bc4042002-06-25 01:09:11 +0000606#define MASTER_NAME "sqlite_master"
607#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000608
609/*
danielk19778e150812004-05-10 01:17:37 +0000610** The root-page of the master database table.
611*/
612#define MASTER_ROOT 1
613
614/*
drhed6c8672003-01-12 18:02:16 +0000615** The name of the schema table.
616*/
danielk197753c0f742005-03-29 03:10:59 +0000617#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000618
619/*
drh75897232000-05-29 14:26:00 +0000620** A convenience macro that returns the number of elements in
621** an array.
622*/
danielk197723432972008-11-17 16:42:00 +0000623#define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
drh75897232000-05-29 14:26:00 +0000624
625/*
drh7a5bcc02013-01-16 17:08:58 +0000626** Determine if the argument is a power of two
627*/
628#define IsPowerOfTwo(X) (((X)&((X)-1))==0)
629
630/*
drh633e6d52008-07-28 19:34:53 +0000631** The following value as a destructor means to use sqlite3DbFree().
drhaa538a52012-01-19 16:57:16 +0000632** The sqlite3DbFree() routine requires two parameters instead of the
633** one parameter that destructors normally want. So we have to introduce
634** this magic value that the code knows to handle differently. Any
635** pointer will work here as long as it is distinct from SQLITE_STATIC
636** and SQLITE_TRANSIENT.
drh633e6d52008-07-28 19:34:53 +0000637*/
drhaa538a52012-01-19 16:57:16 +0000638#define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3MallocSize)
drh633e6d52008-07-28 19:34:53 +0000639
drh78f82d12008-09-02 00:52:52 +0000640/*
641** When SQLITE_OMIT_WSD is defined, it means that the target platform does
642** not support Writable Static Data (WSD) such as global and static variables.
643** All variables must either be on the stack or dynamically allocated from
644** the heap. When WSD is unsupported, the variable declarations scattered
645** throughout the SQLite code must become constants instead. The SQLITE_WSD
646** macro is used for this purpose. And instead of referencing the variable
647** directly, we use its constant as a key to lookup the run-time allocated
648** buffer that holds real variable. The constant is also the initializer
649** for the run-time allocated buffer.
650**
shane2479de32008-11-10 18:05:35 +0000651** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
drh78f82d12008-09-02 00:52:52 +0000652** macros become no-ops and have zero performance impact.
653*/
danielk1977075c23a2008-09-01 18:34:20 +0000654#ifdef SQLITE_OMIT_WSD
655 #define SQLITE_WSD const
656 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
657 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
drhd1d38482008-10-07 23:46:38 +0000658 int sqlite3_wsd_init(int N, int J);
659 void *sqlite3_wsd_find(void *K, int L);
danielk1977075c23a2008-09-01 18:34:20 +0000660#else
661 #define SQLITE_WSD
662 #define GLOBAL(t,v) v
663 #define sqlite3GlobalConfig sqlite3Config
664#endif
665
danielk1977f3d3c272008-11-19 16:52:44 +0000666/*
667** The following macros are used to suppress compiler warnings and to
668** make it clear to human readers when a function parameter is deliberately
669** left unused within the body of a function. This usually happens when
670** a function is called via a function pointer. For example the
671** implementation of an SQL aggregate step callback may not use the
672** parameter indicating the number of arguments passed to the aggregate,
673** if it knows that this is enforced elsewhere.
674**
675** When a function parameter is not used at all within the body of a function,
676** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
677** However, these macros may also be used to suppress warnings related to
678** parameters that may or may not be used depending on compilation options.
679** For example those parameters only used in assert() statements. In these
680** cases the parameters are named as per the usual conventions.
681*/
danielk197762c14b32008-11-19 09:05:26 +0000682#define UNUSED_PARAMETER(x) (void)(x)
danielk1977f3d3c272008-11-19 16:52:44 +0000683#define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
danielk197762c14b32008-11-19 09:05:26 +0000684
drh633e6d52008-07-28 19:34:53 +0000685/*
drh75897232000-05-29 14:26:00 +0000686** Forward references to structures
687*/
drh13449892005-09-07 21:22:45 +0000688typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000689typedef struct AuthContext AuthContext;
drh0b9f50d2009-06-23 20:28:53 +0000690typedef struct AutoincInfo AutoincInfo;
drhf5e7bb52008-02-18 14:47:33 +0000691typedef struct Bitvec Bitvec;
drhfe05af82005-07-21 03:14:59 +0000692typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000693typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000694typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000695typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000696typedef struct Expr Expr;
697typedef struct ExprList ExprList;
drhb7916a72009-05-27 10:31:29 +0000698typedef struct ExprSpan ExprSpan;
drhc2eef3b2002-08-31 18:53:06 +0000699typedef struct FKey FKey;
dand2199f02010-08-27 17:48:52 +0000700typedef struct FuncDestructor FuncDestructor;
drhfe05af82005-07-21 03:14:59 +0000701typedef struct FuncDef FuncDef;
drh70a8ca32008-08-21 18:49:27 +0000702typedef struct FuncDefHash FuncDefHash;
drhfe05af82005-07-21 03:14:59 +0000703typedef struct IdList IdList;
704typedef struct Index Index;
dan02fa4692009-08-17 17:06:58 +0000705typedef struct IndexSample IndexSample;
danielk19778d059842004-05-12 11:24:02 +0000706typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000707typedef struct KeyInfo KeyInfo;
drh633e6d52008-07-28 19:34:53 +0000708typedef struct Lookaside Lookaside;
709typedef struct LookasideSlot LookasideSlot;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000710typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000711typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000712typedef struct Parse Parse;
drha2460e02010-01-14 00:39:26 +0000713typedef struct RowSet RowSet;
danielk1977fd7f0452008-12-17 17:30:26 +0000714typedef struct Savepoint Savepoint;
drhfe05af82005-07-21 03:14:59 +0000715typedef struct Select Select;
drh634d81d2012-09-20 15:41:31 +0000716typedef struct SelectDest SelectDest;
drhfe05af82005-07-21 03:14:59 +0000717typedef struct SrcList SrcList;
drhade86482007-11-28 22:36:40 +0000718typedef struct StrAccum StrAccum;
drhfe05af82005-07-21 03:14:59 +0000719typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000720typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000721typedef struct Token Token;
drha2460e02010-01-14 00:39:26 +0000722typedef struct Trigger Trigger;
dan2832ad42009-08-31 15:27:27 +0000723typedef struct TriggerPrg TriggerPrg;
drhfe05af82005-07-21 03:14:59 +0000724typedef struct TriggerStep TriggerStep;
drhe63d9992008-08-13 19:11:48 +0000725typedef struct UnpackedRecord UnpackedRecord;
danielk1977595a5232009-07-24 17:58:53 +0000726typedef struct VTable VTable;
danb061d052011-04-25 18:49:57 +0000727typedef struct VtabCtx VtabCtx;
drh7d10d5a2008-08-20 16:35:10 +0000728typedef struct Walker Walker;
drhfe05af82005-07-21 03:14:59 +0000729typedef struct WhereInfo WhereInfo;
drhd3d39e92004-05-20 22:16:29 +0000730
danielk19772dca4ac2008-01-03 11:50:29 +0000731/*
732** Defer sourcing vdbe.h and btree.h until after the "u8" and
733** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
734** pointer types (i.e. FuncDef) defined above.
735*/
736#include "btree.h"
737#include "vdbe.h"
738#include "pager.h"
danielk19778c0a7912008-08-20 14:49:23 +0000739#include "pcache.h"
danielk19772dca4ac2008-01-03 11:50:29 +0000740
danielk19771cc5ed82007-05-16 17:28:43 +0000741#include "os.h"
drhc7ce76a2007-08-30 14:10:30 +0000742#include "mutex.h"
danielk19771cc5ed82007-05-16 17:28:43 +0000743
drheee4c8c2008-02-18 22:24:57 +0000744
drh001bbcb2003-03-19 03:14:00 +0000745/*
746** Each database file to be accessed by the system is an instance
747** of the following structure. There are normally two of these structures
748** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000749** aDb[1] is the database file used to hold temporary tables. Additional
750** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000751*/
752struct Db {
753 char *zName; /* Name of this database */
754 Btree *pBt; /* The B*Tree structure for this database file */
shane467bcf32008-11-24 20:01:32 +0000755 u8 safety_level; /* How aggressive at syncing data to disk */
danielk1977e501b892006-01-09 06:29:47 +0000756 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000757};
758
759/*
760** An instance of the following structure stores a database schema.
drh21206082011-04-04 18:22:02 +0000761**
762** Most Schema objects are associated with a Btree. The exception is
763** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
764** In shared cache mode, a single Schema object can be shared by multiple
765** Btrees that refer to the same underlying BtShared object.
766**
767** Schema objects are automatically deallocated when the last Btree that
768** references them is destroyed. The TEMP Schema is manually freed by
769** sqlite3_close().
770*
771** A thread must be holding a mutex on the corresponding Btree in order
772** to access Schema content. This implies that the thread must also be
773** holding a mutex on the sqlite3 connection pointer that owns the Btree.
drh55a09592011-06-07 18:31:14 +0000774** For a TEMP Schema, only the connection mutex is required.
danielk1977da184232006-01-05 11:34:32 +0000775*/
danielk1977e501b892006-01-09 06:29:47 +0000776struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000777 int schema_cookie; /* Database schema version number for this file */
drhc2a75552011-03-18 21:55:46 +0000778 int iGeneration; /* Generation counter. Incremented with each change */
drhd24cc422003-03-27 12:51:24 +0000779 Hash tblHash; /* All tables indexed by name */
780 Hash idxHash; /* All (named) indices indexed by name */
781 Hash trigHash; /* All triggers indexed by name */
dan1da40a32009-09-19 17:00:31 +0000782 Hash fkeyHash; /* All foreign keys by referenced table name */
drh4794f732004-11-05 17:17:50 +0000783 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000784 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000785 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000786 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000787 int cache_size; /* Number of pages to use in the cache */
drh001bbcb2003-03-19 03:14:00 +0000788};
drh75897232000-05-29 14:26:00 +0000789
790/*
drh8bf8dc92003-05-17 17:35:10 +0000791** These macros can be used to test, set, or clear bits in the
drha2460e02010-01-14 00:39:26 +0000792** Db.pSchema->flags field.
drh8bf8dc92003-05-17 17:35:10 +0000793*/
danielk1977da184232006-01-05 11:34:32 +0000794#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
795#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
796#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
797#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000798
799/*
drha2460e02010-01-14 00:39:26 +0000800** Allowed values for the DB.pSchema->flags field.
drh8bf8dc92003-05-17 17:35:10 +0000801**
drh8bf8dc92003-05-17 17:35:10 +0000802** The DB_SchemaLoaded flag is set after the database schema has been
803** read into internal hash tables.
804**
805** DB_UnresetViews means that one or more views have column names that
806** have been filled out. If the schema changes, these column names might
807** changes and so the view will need to be reset.
808*/
drh124b27e2004-06-19 16:06:10 +0000809#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
810#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000811#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000812
drhcaa639f2008-03-20 00:32:20 +0000813/*
814** The number of different kinds of things that can be limited
815** using the sqlite3_limit() interface.
816*/
drh417168a2009-09-07 18:14:02 +0000817#define SQLITE_N_LIMIT (SQLITE_LIMIT_TRIGGER_DEPTH+1)
drh8bf8dc92003-05-17 17:35:10 +0000818
819/*
drh633e6d52008-07-28 19:34:53 +0000820** Lookaside malloc is a set of fixed-size buffers that can be used
shane467bcf32008-11-24 20:01:32 +0000821** to satisfy small transient memory allocation requests for objects
drh633e6d52008-07-28 19:34:53 +0000822** associated with a particular database connection. The use of
823** lookaside malloc provides a significant performance enhancement
824** (approx 10%) by avoiding numerous malloc/free requests while parsing
825** SQL statements.
826**
827** The Lookaside structure holds configuration information about the
828** lookaside malloc subsystem. Each available memory allocation in
829** the lookaside subsystem is stored on a linked list of LookasideSlot
830** objects.
drhd9da78a2009-03-24 15:08:09 +0000831**
832** Lookaside allocations are only allowed for objects that are associated
833** with a particular database connection. Hence, schema information cannot
834** be stored in lookaside because in shared cache mode the schema information
835** is shared by multiple database connections. Therefore, while parsing
836** schema information, the Lookaside.bEnabled flag is cleared so that
837** lookaside allocations are not used to construct the schema objects.
drh633e6d52008-07-28 19:34:53 +0000838*/
839struct Lookaside {
840 u16 sz; /* Size of each buffer in bytes */
drhd9da78a2009-03-24 15:08:09 +0000841 u8 bEnabled; /* False to disable new lookaside allocations */
drhe9d1c722008-08-04 20:13:26 +0000842 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
drh633e6d52008-07-28 19:34:53 +0000843 int nOut; /* Number of buffers currently checked out */
844 int mxOut; /* Highwater mark for nOut */
drh0b12e7f2010-12-20 15:51:58 +0000845 int anStat[3]; /* 0: hits. 1: size misses. 2: full misses */
drh7d10d5a2008-08-20 16:35:10 +0000846 LookasideSlot *pFree; /* List of available buffers */
drh633e6d52008-07-28 19:34:53 +0000847 void *pStart; /* First byte of available memory space */
848 void *pEnd; /* First byte past end of available space */
849};
850struct LookasideSlot {
851 LookasideSlot *pNext; /* Next buffer in the list of free buffers */
852};
853
854/*
drh70a8ca32008-08-21 18:49:27 +0000855** A hash table for function definitions.
856**
857** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
858** Collisions are on the FuncDef.pHash chain.
859*/
860struct FuncDefHash {
861 FuncDef *a[23]; /* Hash table for functions */
862};
863
864/*
drha2460e02010-01-14 00:39:26 +0000865** Each database connection is an instance of the following structure.
drh75897232000-05-29 14:26:00 +0000866*/
drh9bb575f2004-09-06 17:24:11 +0000867struct sqlite3 {
drh90f6a5b2007-08-15 13:04:54 +0000868 sqlite3_vfs *pVfs; /* OS Interface */
drha4510172012-02-02 15:50:17 +0000869 struct Vdbe *pVdbe; /* List of active virtual machines */
870 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
871 sqlite3_mutex *mutex; /* Connection mutex */
drh001bbcb2003-03-19 03:14:00 +0000872 Db *aDb; /* All backends */
drha4510172012-02-02 15:50:17 +0000873 int nDb; /* Number of backends currently in use */
shane467bcf32008-11-24 20:01:32 +0000874 int flags; /* Miscellaneous flags. See below */
drha4510172012-02-02 15:50:17 +0000875 i64 lastRowid; /* ROWID of most recent insert (see above) */
drh9b4c59f2013-04-15 17:03:42 +0000876 i64 szMmap; /* Default mmap_size setting */
drh522c26f2011-05-07 14:40:29 +0000877 unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
drhfcd35c72005-05-21 02:48:08 +0000878 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000879 int errMask; /* & result codes with this before returning */
drha5759672012-10-30 14:39:12 +0000880 u16 dbOptFlags; /* Flags to enable/disable optimizations */
drhfcd35c72005-05-21 02:48:08 +0000881 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000882 u8 temp_store; /* 1: file 2: memory 0: default */
drh17435752007-08-16 04:30:38 +0000883 u8 mallocFailed; /* True if we have seen a malloc failure */
drh3b020132008-04-17 17:02:01 +0000884 u8 dfltLockMode; /* Default locking-mode for attached dbs */
drh98757152008-01-09 23:04:12 +0000885 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
drha7564662010-02-22 19:32:31 +0000886 u8 suppressErr; /* Do not issue error messages if true */
danb061d052011-04-25 18:49:57 +0000887 u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */
drha4510172012-02-02 15:50:17 +0000888 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
danielk1977f653d782008-03-20 11:04:21 +0000889 int nextPagesize; /* Pagesize after VACUUM if >0 */
danielk197764202cf2008-11-17 15:31:47 +0000890 u32 magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000891 int nChange; /* Value returned by sqlite3_changes() */
892 int nTotalChange; /* Value returned by sqlite3_total_changes() */
drhcaa639f2008-03-20 00:32:20 +0000893 int aLimit[SQLITE_N_LIMIT]; /* Limits */
danielk1977b28af712004-06-21 06:50:26 +0000894 struct sqlite3InitInfo { /* Information used during initialization */
danielk1977b28af712004-06-21 06:50:26 +0000895 int newTnum; /* Rootpage of table being initialized */
drha4510172012-02-02 15:50:17 +0000896 u8 iDb; /* Which db file is being initialized */
danielk1977b28af712004-06-21 06:50:26 +0000897 u8 busy; /* TRUE if currently initializing */
drh3d5f74b2009-08-06 17:43:31 +0000898 u8 orphanTrigger; /* Last statement is orphaned TEMP trigger */
drh1d85d932004-02-14 23:05:52 +0000899 } init;
drh1713afb2013-06-28 01:24:57 +0000900 int nVdbeActive; /* Number of VDBEs currently running */
901 int nVdbeRead; /* Number of active VDBEs that read or write */
902 int nVdbeWrite; /* Number of active VDBEs that read and write */
903 int nVdbeExec; /* Number of nested calls to VdbeExec() */
drha4510172012-02-02 15:50:17 +0000904 int nExtension; /* Number of loaded extensions */
905 void **aExtension; /* Array of shared library handles */
drh19e2d372005-08-29 23:00:03 +0000906 void (*xTrace)(void*,const char*); /* Trace function */
907 void *pTraceArg; /* Argument to the trace function */
908 void (*xProfile)(void*,const char*,u64); /* Profiling function */
909 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000910 void *pCommitArg; /* Argument to xCommitCallback() */
911 int (*xCommitCallback)(void*); /* Invoked at every commit. */
912 void *pRollbackArg; /* Argument to xRollbackCallback() */
913 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000914 void *pUpdateArg;
915 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
dan5cf53532010-05-01 16:40:20 +0000916#ifndef SQLITE_OMIT_WAL
drh7ed91f22010-04-29 22:34:07 +0000917 int (*xWalCallback)(void *, sqlite3 *, const char *, int);
918 void *pWalArg;
dan5cf53532010-05-01 16:40:20 +0000919#endif
drhfcd35c72005-05-21 02:48:08 +0000920 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
921 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
922 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000923 sqlite3_value *pErr; /* Most recent error message */
drh881feaa2006-07-26 01:39:30 +0000924 union {
drh39001e72008-09-12 16:03:47 +0000925 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
drh881feaa2006-07-26 01:39:30 +0000926 double notUsed1; /* Spacer */
927 } u1;
drh633e6d52008-07-28 19:34:53 +0000928 Lookaside lookaside; /* Lookaside malloc configuration */
drhed6c8672003-01-12 18:02:16 +0000929#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000930 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
931 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000932 void *pAuthArg; /* 1st argument to the access auth function */
933#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000934#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
935 int (*xProgress)(void *); /* The progress callback */
936 void *pProgressArg; /* Argument to the progress callback */
drh8f8c65f2013-07-10 18:14:29 +0000937 unsigned nProgressOps; /* Number of opcodes for progress callback */
danielk1977348bb5d2003-10-18 09:37:26 +0000938#endif
drhb9bb7c12006-06-11 23:41:55 +0000939#ifndef SQLITE_OMIT_VIRTUALTABLE
drha4510172012-02-02 15:50:17 +0000940 int nVTrans; /* Allocated size of aVTrans */
drhb9bb7c12006-06-11 23:41:55 +0000941 Hash aModule; /* populated by sqlite3_create_module() */
danb061d052011-04-25 18:49:57 +0000942 VtabCtx *pVtabCtx; /* Context for active vtab connect/create */
danielk1977595a5232009-07-24 17:58:53 +0000943 VTable **aVTrans; /* Virtual tables with open transactions */
danielk1977595a5232009-07-24 17:58:53 +0000944 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */
danielk19776b456a22005-03-21 04:04:02 +0000945#endif
drh70a8ca32008-08-21 18:49:27 +0000946 FuncDefHash aFunc; /* Hash table of connection functions */
drhfcd35c72005-05-21 02:48:08 +0000947 Hash aCollSeq; /* All collating sequences */
948 BusyHandler busyHandler; /* Busy callback */
949 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk1977fd7f0452008-12-17 17:30:26 +0000950 Savepoint *pSavepoint; /* List of active savepoints */
drha4510172012-02-02 15:50:17 +0000951 int busyTimeout; /* Busy handler timeout, in msec */
danielk1977fd7f0452008-12-17 17:30:26 +0000952 int nSavepoint; /* Number of non-transaction savepoints */
danielk1977bd434552009-03-18 10:33:00 +0000953 int nStatement; /* Number of nested statement-transactions */
dan1da40a32009-09-19 17:00:31 +0000954 i64 nDeferredCons; /* Net deferred constraints this transaction. */
drh648e2642013-07-11 15:03:32 +0000955 i64 nDeferredImmCons; /* Net deferred immediate constraints */
dand46def72010-07-24 11:28:28 +0000956 int *pnBytesFreed; /* If not NULL, increment this in DbFree() */
danielk1977404ca072009-03-16 13:19:36 +0000957
958#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
959 /* The following variables are all protected by the STATIC_MASTER
960 ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
drh65a73ba2009-04-07 22:06:57 +0000961 **
962 ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
963 ** unlock so that it can proceed.
964 **
965 ** When X.pBlockingConnection==Y, that means that something that X tried
966 ** tried to do recently failed with an SQLITE_LOCKED error due to locks
967 ** held by Y.
danielk1977404ca072009-03-16 13:19:36 +0000968 */
969 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
970 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */
971 void *pUnlockArg; /* Argument to xUnlockNotify */
972 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */
973 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */
974#endif
drh75897232000-05-29 14:26:00 +0000975};
976
drh03b808a2006-03-13 15:06:05 +0000977/*
978** A macro to discover the encoding of a database.
979*/
danielk197714db2662006-01-09 16:12:04 +0000980#define ENC(db) ((db)->aDb[0].pSchema->enc)
981
drh75897232000-05-29 14:26:00 +0000982/*
drh07096f62009-12-22 23:52:32 +0000983** Possible values for the sqlite3.flags.
drh75897232000-05-29 14:26:00 +0000984*/
drh7e5418e2012-09-27 15:05:54 +0000985#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
986#define SQLITE_InternChanges 0x00000002 /* Uncommitted Hash table changes */
drh40c39412013-08-16 20:42:20 +0000987#define SQLITE_FullFSync 0x00000004 /* Use full fsync on the backend */
988#define SQLITE_CkptFullFSync 0x00000008 /* Use full fsync for checkpoint */
989#define SQLITE_CacheSpill 0x00000010 /* OK to spill pager cache */
990#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
991#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
992#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000993 /* DELETE, or UPDATE and return */
994 /* the count using a callback. */
drh40c39412013-08-16 20:42:20 +0000995#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000996 /* result set is empty */
drh40c39412013-08-16 20:42:20 +0000997#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
998#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
999#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
1000#define SQLITE_VdbeAddopTrace 0x00001000 /* Trace sqlite3VdbeAddOp() calls */
1001#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
1002#define SQLITE_ReadUncommitted 0x0004000 /* For shared-cache mode */
1003#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
1004#define SQLITE_RecoveryMode 0x00010000 /* Ignore schema errors */
1005#define SQLITE_ReverseOrder 0x00020000 /* Reverse unordered SELECTs */
1006#define SQLITE_RecTriggers 0x00040000 /* Enable recursive triggers */
1007#define SQLITE_ForeignKeys 0x00080000 /* Enforce foreign key constraints */
1008#define SQLITE_AutoIndex 0x00100000 /* Enable automatic indexes */
1009#define SQLITE_PreferBuiltin 0x00200000 /* Preference to built-in funcs */
1010#define SQLITE_LoadExtension 0x00400000 /* Enable load_extension */
1011#define SQLITE_EnableTrigger 0x00800000 /* True to enable triggers */
1012#define SQLITE_DeferFKs 0x01000000 /* Defer all FK constraints */
1013#define SQLITE_QueryOnly 0x02000000 /* Disable database changes */
drhb1eaa712013-07-11 15:22:31 +00001014
drh07096f62009-12-22 23:52:32 +00001015
1016/*
drh7e5418e2012-09-27 15:05:54 +00001017** Bits of the sqlite3.dbOptFlags field that are used by the
1018** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
1019** selectively disable various optimizations.
drh07096f62009-12-22 23:52:32 +00001020*/
drh7e5418e2012-09-27 15:05:54 +00001021#define SQLITE_QueryFlattener 0x0001 /* Query flattening */
1022#define SQLITE_ColumnCache 0x0002 /* Column cache */
1023#define SQLITE_GroupByOrder 0x0004 /* GROUPBY cover of ORDERBY */
1024#define SQLITE_FactorOutConst 0x0008 /* Constant factoring */
1025#define SQLITE_IdxRealAsInt 0x0010 /* Store REAL as INT in indices */
1026#define SQLITE_DistinctOpt 0x0020 /* DISTINCT using indexes */
1027#define SQLITE_CoverIdxScan 0x0040 /* Covering index scans */
drha9e3fc02012-09-27 23:27:23 +00001028#define SQLITE_OrderByIdxJoin 0x0080 /* ORDER BY of joins via index */
drha5759672012-10-30 14:39:12 +00001029#define SQLITE_SubqCoroutine 0x0100 /* Evaluate subqueries as coroutines */
drheb5bc922013-01-17 16:43:33 +00001030#define SQLITE_Transitive 0x0200 /* Transitive constraints */
drh1031bd92013-06-22 15:44:26 +00001031#define SQLITE_OmitNoopJoin 0x0400 /* Omit unused tables in joins */
drh40aa9362013-06-28 17:29:25 +00001032#define SQLITE_Stat3 0x0800 /* Use the SQLITE_STAT3 table */
drhadd5ce32013-09-07 00:29:06 +00001033#define SQLITE_AdjustOutEst 0x1000 /* Adjust output estimates using WHERE */
drha5759672012-10-30 14:39:12 +00001034#define SQLITE_AllOpts 0xffff /* All optimizations */
drh7e5418e2012-09-27 15:05:54 +00001035
1036/*
1037** Macros for testing whether or not optimizations are enabled or disabled.
1038*/
1039#ifndef SQLITE_OMIT_BUILTIN_TEST
1040#define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0)
1041#define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0)
1042#else
1043#define OptimizationDisabled(db, mask) 0
1044#define OptimizationEnabled(db, mask) 1
1045#endif
danielk197734c68fb2007-03-14 15:37:04 +00001046
drh58b95762000-06-02 01:17:37 +00001047/*
drh247be432002-05-10 05:44:55 +00001048** Possible values for the sqlite.magic field.
1049** The numbers are obtained at random and have no special meaning, other
1050** than being distinct from one another.
1051*/
1052#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
1053#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
drh7e8b8482008-01-23 03:03:05 +00001054#define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
drh247be432002-05-10 05:44:55 +00001055#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
1056#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
drh4245c402012-06-02 14:32:21 +00001057#define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */
drh247be432002-05-10 05:44:55 +00001058
1059/*
drh0bce8352002-02-28 00:41:10 +00001060** Each SQL function is defined by an instance of the following
1061** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +00001062** hash table. When multiple functions have the same name, the hash table
1063** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +00001064*/
drh0bce8352002-02-28 00:41:10 +00001065struct FuncDef {
drhe82f5d02008-10-07 19:53:14 +00001066 i16 nArg; /* Number of arguments. -1 means unlimited */
drhd36e1042013-09-06 13:10:12 +00001067 u16 funcFlags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +00001068 void *pUserData; /* User data parameter */
1069 FuncDef *pNext; /* Next function with same name */
1070 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
1071 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
shane467bcf32008-11-24 20:01:32 +00001072 void (*xFinalize)(sqlite3_context*); /* Aggregate finalizer */
danielk19778c0a7912008-08-20 14:49:23 +00001073 char *zName; /* SQL name of the function. */
drh70a8ca32008-08-21 18:49:27 +00001074 FuncDef *pHash; /* Next with a different name but the same hash */
dand2199f02010-08-27 17:48:52 +00001075 FuncDestructor *pDestructor; /* Reference counted destructor function */
1076};
1077
1078/*
1079** This structure encapsulates a user-function destructor callback (as
1080** configured using create_function_v2()) and a reference counter. When
1081** create_function_v2() is called to create a function with a destructor,
1082** a single object of this type is allocated. FuncDestructor.nRef is set to
1083** the number of FuncDef objects created (either 1 or 3, depending on whether
1084** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
1085** member of each of the new FuncDef objects is set to point to the allocated
1086** FuncDestructor.
1087**
1088** Thereafter, when one of the FuncDef objects is deleted, the reference
1089** count on this object is decremented. When it reaches 0, the destructor
1090** is invoked and the FuncDestructor structure freed.
1091*/
1092struct FuncDestructor {
1093 int nRef;
1094 void (*xDestroy)(void *);
1095 void *pUserData;
drh8e0a2f92002-02-23 23:45:45 +00001096};
drh28037572000-08-02 13:47:41 +00001097
1098/*
drha748fdc2012-03-28 01:34:47 +00001099** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF
1100** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. There
1101** are assert() statements in the code to verify this.
drh7d10d5a2008-08-20 16:35:10 +00001102*/
drhd36e1042013-09-06 13:10:12 +00001103#define SQLITE_FUNC_ENCMASK 0x003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
1104#define SQLITE_FUNC_LIKE 0x004 /* Candidate for the LIKE optimization */
1105#define SQLITE_FUNC_CASE 0x008 /* Case-sensitive LIKE-type function */
1106#define SQLITE_FUNC_EPHEM 0x010 /* Ephemeral. Delete with VDBE */
1107#define SQLITE_FUNC_NEEDCOLL 0x020 /* sqlite3GetFuncCollSeq() might be called */
1108#define SQLITE_FUNC_LENGTH 0x040 /* Built-in length() function */
1109#define SQLITE_FUNC_TYPEOF 0x080 /* Built-in typeof() function */
1110#define SQLITE_FUNC_COUNT 0x100 /* Built-in count(*) aggregate */
1111#define SQLITE_FUNC_COALESCE 0x200 /* Built-in coalesce() or ifnull() */
1112#define SQLITE_FUNC_UNLIKELY 0x400 /* Built-in unlikely() function */
drh7d10d5a2008-08-20 16:35:10 +00001113
1114/*
drh777c5382008-08-21 20:21:34 +00001115** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1116** used to create the initializers for the FuncDef structures.
1117**
1118** FUNCTION(zName, nArg, iArg, bNC, xFunc)
1119** Used to create a scalar function definition of a function zName
1120** implemented by C function xFunc that accepts nArg arguments. The
1121** value passed as iArg is cast to a (void*) and made available
1122** as the user-data (sqlite3_user_data()) for the function. If
drhf7bca572009-05-30 14:16:31 +00001123** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
drh777c5382008-08-21 20:21:34 +00001124**
1125** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
1126** Used to create an aggregate function definition implemented by
1127** the C functions xStep and xFinal. The first four parameters
1128** are interpreted in the same way as the first 4 parameters to
1129** FUNCTION().
1130**
1131** LIKEFUNC(zName, nArg, pArg, flags)
1132** Used to create a scalar function definition of a function zName
1133** that accepts nArg arguments and is implemented by a call to C
1134** function likeFunc. Argument pArg is cast to a (void *) and made
1135** available as the function user-data (sqlite3_user_data()). The
1136** FuncDef.flags variable is set to the value passed as the flags
1137** parameter.
1138*/
1139#define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
drhd36e1042013-09-06 13:10:12 +00001140 {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
drha748fdc2012-03-28 01:34:47 +00001141 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0}
1142#define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
drhd36e1042013-09-06 13:10:12 +00001143 {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
drh6ac78a02010-09-28 14:26:36 +00001144 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0}
drh21717ed2008-10-13 15:35:08 +00001145#define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
drhd36e1042013-09-06 13:10:12 +00001146 {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
drh6ac78a02010-09-28 14:26:36 +00001147 pArg, 0, xFunc, 0, 0, #zName, 0, 0}
drh777c5382008-08-21 20:21:34 +00001148#define LIKEFUNC(zName, nArg, arg, flags) \
drhd36e1042013-09-06 13:10:12 +00001149 {nArg, SQLITE_UTF8|flags, (void *)arg, 0, likeFunc, 0, 0, #zName, 0, 0}
drh777c5382008-08-21 20:21:34 +00001150#define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
drhd36e1042013-09-06 13:10:12 +00001151 {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
drh6ac78a02010-09-28 14:26:36 +00001152 SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0,0}
drh777c5382008-08-21 20:21:34 +00001153
danielk1977fd7f0452008-12-17 17:30:26 +00001154/*
1155** All current savepoints are stored in a linked list starting at
1156** sqlite3.pSavepoint. The first element in the list is the most recently
1157** opened savepoint. Savepoints are added to the list by the vdbe
1158** OP_Savepoint instruction.
1159*/
1160struct Savepoint {
1161 char *zName; /* Savepoint name (nul-terminated) */
drhfcb9f7a2009-10-13 19:19:23 +00001162 i64 nDeferredCons; /* Number of deferred fk violations */
drh648e2642013-07-11 15:03:32 +00001163 i64 nDeferredImmCons; /* Number of deferred imm fk. */
danielk1977fd7f0452008-12-17 17:30:26 +00001164 Savepoint *pNext; /* Parent savepoint (if any) */
1165};
1166
1167/*
1168** The following are used as the second parameter to sqlite3Savepoint(),
1169** and as the P1 argument to the OP_Savepoint instruction.
1170*/
1171#define SAVEPOINT_BEGIN 0
1172#define SAVEPOINT_RELEASE 1
1173#define SAVEPOINT_ROLLBACK 2
1174
drh777c5382008-08-21 20:21:34 +00001175
1176/*
danielk1977d1ab1ba2006-06-15 04:28:13 +00001177** Each SQLite module (virtual table definition) is defined by an
1178** instance of the following structure, stored in the sqlite3.aModule
1179** hash table.
1180*/
1181struct Module {
1182 const sqlite3_module *pModule; /* Callback pointers */
1183 const char *zName; /* Name passed to create_module() */
1184 void *pAux; /* pAux passed to create_module() */
danielk1977832a58a2007-06-22 15:21:15 +00001185 void (*xDestroy)(void *); /* Module destructor function */
danielk1977d1ab1ba2006-06-15 04:28:13 +00001186};
1187
1188/*
drh967e8b72000-06-21 13:59:10 +00001189** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +00001190** of this structure.
1191*/
1192struct Column {
drh967e8b72000-06-21 13:59:10 +00001193 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +00001194 Expr *pDflt; /* Default value of this column */
drhb7916a72009-05-27 10:31:29 +00001195 char *zDflt; /* Original text of the default value */
drh382c0242001-10-06 16:33:02 +00001196 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +00001197 char *zColl; /* Collating sequence. If NULL, use the default */
drha371ace2012-09-13 14:22:47 +00001198 u8 notNull; /* An OE_ code for handling a NOT NULL constraint */
danielk1977a37cdde2004-05-16 11:15:36 +00001199 char affinity; /* One of the SQLITE_AFF_... values */
drhfdaac672013-10-04 15:30:21 +00001200 u8 szEst; /* Estimated size of this column. INT==1 */
1201 u8 colFlags; /* Boolean properties. See COLFLAG_ defines below */
drh7020f652000-06-03 18:06:52 +00001202};
1203
drha371ace2012-09-13 14:22:47 +00001204/* Allowed values for Column.colFlags:
1205*/
1206#define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */
1207#define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */
1208
drh7020f652000-06-03 18:06:52 +00001209/*
drha9fd84b2004-05-18 23:21:35 +00001210** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +00001211** structure. Conceptually, a collating sequence consists of a name and
1212** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +00001213**
drhe6f1e762012-12-06 01:03:15 +00001214** If CollSeq.xCmp is NULL, it means that the
danielk19770202b292004-06-09 09:55:16 +00001215** collating sequence is undefined. Indices built on an undefined
1216** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +00001217*/
1218struct CollSeq {
danielk1977a9808b32007-05-07 09:32:45 +00001219 char *zName; /* Name of the collating sequence, UTF-8 encoded */
1220 u8 enc; /* Text encoding handled by xCmp() */
danielk1977a9808b32007-05-07 09:32:45 +00001221 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +00001222 int (*xCmp)(void*,int, const void*, int, const void*);
danielk1977a9808b32007-05-07 09:32:45 +00001223 void (*xDel)(void*); /* Destructor for pUser */
drha9fd84b2004-05-18 23:21:35 +00001224};
1225
1226/*
drhd3d39e92004-05-20 22:16:29 +00001227** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +00001228*/
drh8e2ca022002-06-17 17:07:19 +00001229#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +00001230#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +00001231
1232/*
danielk1977a37cdde2004-05-16 11:15:36 +00001233** Column affinity types.
drh8a512562005-11-14 22:29:05 +00001234**
1235** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
1236** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
drh7d10d5a2008-08-20 16:35:10 +00001237** the speed a little by numbering the values consecutively.
drh8a512562005-11-14 22:29:05 +00001238**
1239** But rather than start with 0 or 1, we begin with 'a'. That way,
1240** when multiple affinity types are concatenated into a string and
drh66a51672008-01-03 00:01:23 +00001241** used as the P4 operand, they will be more readable.
drh8a512562005-11-14 22:29:05 +00001242**
1243** Note also that the numeric types are grouped together so that testing
1244** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +00001245*/
drh8a512562005-11-14 22:29:05 +00001246#define SQLITE_AFF_TEXT 'a'
1247#define SQLITE_AFF_NONE 'b'
1248#define SQLITE_AFF_NUMERIC 'c'
1249#define SQLITE_AFF_INTEGER 'd'
1250#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +00001251
drh8a512562005-11-14 22:29:05 +00001252#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +00001253
1254/*
drh35573352008-01-08 23:54:25 +00001255** The SQLITE_AFF_MASK values masks off the significant bits of an
1256** affinity value.
1257*/
1258#define SQLITE_AFF_MASK 0x67
1259
1260/*
1261** Additional bit values that can be ORed with an affinity without
1262** changing the affinity.
1263*/
1264#define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */
drh93a960a2008-07-10 00:32:42 +00001265#define SQLITE_STOREP2 0x10 /* Store result in reg[P2] rather than jump */
drh6a2fe092009-09-23 02:29:36 +00001266#define SQLITE_NULLEQ 0x80 /* NULL=NULL */
drh35573352008-01-08 23:54:25 +00001267
1268/*
danielk1977595a5232009-07-24 17:58:53 +00001269** An object of this type is created for each virtual table present in
1270** the database schema.
1271**
1272** If the database schema is shared, then there is one instance of this
1273** structure for each database connection (sqlite3*) that uses the shared
1274** schema. This is because each database connection requires its own unique
1275** instance of the sqlite3_vtab* handle used to access the virtual table
1276** implementation. sqlite3_vtab* handles can not be shared between
1277** database connections, even when the rest of the in-memory database
1278** schema is shared, as the implementation often stores the database
1279** connection handle passed to it via the xConnect() or xCreate() method
1280** during initialization internally. This database connection handle may
drh9bbc2e22011-04-04 20:40:22 +00001281** then be used by the virtual table implementation to access real tables
danielk1977595a5232009-07-24 17:58:53 +00001282** within the database. So that they appear as part of the callers
1283** transaction, these accesses need to be made via the same database
1284** connection as that used to execute SQL operations on the virtual table.
1285**
1286** All VTable objects that correspond to a single table in a shared
1287** database schema are initially stored in a linked-list pointed to by
1288** the Table.pVTable member variable of the corresponding Table object.
1289** When an sqlite3_prepare() operation is required to access the virtual
1290** table, it searches the list for the VTable that corresponds to the
1291** database connection doing the preparing so as to use the correct
1292** sqlite3_vtab* handle in the compiled query.
1293**
1294** When an in-memory Table object is deleted (for example when the
1295** schema is being reloaded for some reason), the VTable objects are not
1296** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
1297** immediately. Instead, they are moved from the Table.pVTable list to
1298** another linked list headed by the sqlite3.pDisconnect member of the
1299** corresponding sqlite3 structure. They are then deleted/xDisconnected
1300** next time a statement is prepared using said sqlite3*. This is done
1301** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
1302** Refer to comments above function sqlite3VtabUnlockList() for an
1303** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
1304** list without holding the corresponding sqlite3.mutex mutex.
1305**
1306** The memory for objects of this type is always allocated by
1307** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
1308** the first argument.
1309*/
1310struct VTable {
1311 sqlite3 *db; /* Database connection associated with this table */
1312 Module *pMod; /* Pointer to module implementation */
1313 sqlite3_vtab *pVtab; /* Pointer to vtab instance */
1314 int nRef; /* Number of pointers to this structure */
danb061d052011-04-25 18:49:57 +00001315 u8 bConstraint; /* True if constraints are supported */
drhaddd8f82011-05-25 15:54:09 +00001316 int iSavepoint; /* Depth of the SAVEPOINT stack */
danielk1977595a5232009-07-24 17:58:53 +00001317 VTable *pNext; /* Next in linked list (see above) */
1318};
1319
1320/*
drh22f70c32002-02-18 01:17:00 +00001321** Each SQL table is represented in memory by an instance of the
1322** following structure.
1323**
drhd24cc422003-03-27 12:51:24 +00001324** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +00001325** CREATE TABLE statement is stored, but case is not significant for
1326** comparisons.
1327**
drhd24cc422003-03-27 12:51:24 +00001328** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +00001329** pointer to an array of Column structures, one for each column.
1330**
drhd24cc422003-03-27 12:51:24 +00001331** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
1332** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +00001333** that the datatype of the PRIMARY KEY must be INTEGER for this field to
1334** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
1335** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drh7d10d5a2008-08-20 16:35:10 +00001336** is generated for each row of the table. TF_HasPrimaryKey is set if
drh22f70c32002-02-18 01:17:00 +00001337** the table has any PRIMARY KEY, INTEGER or otherwise.
1338**
drhd24cc422003-03-27 12:51:24 +00001339** Table.tnum is the page number for the root BTree page of the table in the
1340** database file. If Table.iDb is the index of the database table backend
1341** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drh7d10d5a2008-08-20 16:35:10 +00001342** holds temporary tables and indices. If TF_Ephemeral is set
1343** then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +00001344** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +00001345** refers VDBE cursor number that holds the table open, not to the root
1346** page number. Transient tables are used to hold the results of a
1347** sub-query that appears instead of a real table name in the FROM clause
1348** of a SELECT statement.
drh75897232000-05-29 14:26:00 +00001349*/
1350struct Table {
drh7d10d5a2008-08-20 16:35:10 +00001351 char *zName; /* Name of the table or view */
drh7d10d5a2008-08-20 16:35:10 +00001352 Column *aCol; /* Information about each column */
1353 Index *pIndex; /* List of SQL indexes on this table. */
drh7d10d5a2008-08-20 16:35:10 +00001354 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drh7d10d5a2008-08-20 16:35:10 +00001355 FKey *pFKey; /* Linked list of all foreign keys in this table */
1356 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +00001357#ifndef SQLITE_OMIT_CHECK
drh2938f922012-03-07 19:13:29 +00001358 ExprList *pCheck; /* All CHECK constraints */
drhffe07b22005-11-03 00:41:17 +00001359#endif
drhd815f172012-09-13 14:42:43 +00001360 tRowcnt nRowEst; /* Estimated rows in table - from sqlite_stat1 table */
1361 int tnum; /* Root BTree node for this table (see note above) */
1362 i16 iPKey; /* If not negative, use aCol[iPKey] as the primary key */
1363 i16 nCol; /* Number of columns in this table */
1364 u16 nRef; /* Number of pointers to this Table */
1365 u8 tabFlags; /* Mask of TF_* values */
1366 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
danielk197719a8e7e2005-03-17 05:03:38 +00001367#ifndef SQLITE_OMIT_ALTERTABLE
drh7d10d5a2008-08-20 16:35:10 +00001368 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
danielk197719a8e7e2005-03-17 05:03:38 +00001369#endif
drhe09daa92006-06-10 13:29:31 +00001370#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7d10d5a2008-08-20 16:35:10 +00001371 int nModuleArg; /* Number of arguments to the module */
1372 char **azModuleArg; /* Text of all module args. [0] is module name */
drhd815f172012-09-13 14:42:43 +00001373 VTable *pVTable; /* List of VTable objects. */
drhe09daa92006-06-10 13:29:31 +00001374#endif
danielk19772f886d12009-02-28 10:47:41 +00001375 Trigger *pTrigger; /* List of triggers stored in pSchema */
drh7d10d5a2008-08-20 16:35:10 +00001376 Schema *pSchema; /* Schema that contains this table */
drh588a9a12008-09-01 15:52:10 +00001377 Table *pNextZombie; /* Next on the Parse.pZombieTab list */
drh75897232000-05-29 14:26:00 +00001378};
1379
1380/*
drh7d10d5a2008-08-20 16:35:10 +00001381** Allowed values for Tabe.tabFlags.
1382*/
1383#define TF_Readonly 0x01 /* Read-only system table */
shane467bcf32008-11-24 20:01:32 +00001384#define TF_Ephemeral 0x02 /* An ephemeral table */
drh7d10d5a2008-08-20 16:35:10 +00001385#define TF_HasPrimaryKey 0x04 /* Table has a primary key */
1386#define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */
1387#define TF_Virtual 0x10 /* Is a virtual table */
drh7d10d5a2008-08-20 16:35:10 +00001388
1389
1390/*
drh4cbdda92006-06-14 19:00:20 +00001391** Test to see whether or not a table is a virtual table. This is
1392** done as a macro so that it will be optimized out when virtual
1393** table support is omitted from the build.
1394*/
1395#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7d10d5a2008-08-20 16:35:10 +00001396# define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0)
drha371ace2012-09-13 14:22:47 +00001397# define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
drh4cbdda92006-06-14 19:00:20 +00001398#else
danielk1977034ca142007-06-26 10:38:54 +00001399# define IsVirtual(X) 0
1400# define IsHiddenColumn(X) 0
drh4cbdda92006-06-14 19:00:20 +00001401#endif
1402
1403/*
drhc2eef3b2002-08-31 18:53:06 +00001404** Each foreign key constraint is an instance of the following structure.
1405**
1406** A foreign key is associated with two tables. The "from" table is
1407** the table that contains the REFERENCES clause that creates the foreign
1408** key. The "to" table is the table that is named in the REFERENCES clause.
1409** Consider this example:
1410**
1411** CREATE TABLE ex1(
1412** a INTEGER PRIMARY KEY,
1413** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1414** );
1415**
1416** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1417**
1418** Each REFERENCES clause generates an instance of the following structure
1419** which is attached to the from-table. The to-table need not exist when
drhe61922a2009-05-02 13:29:37 +00001420** the from-table is created. The existence of the to-table is not checked.
drhc2eef3b2002-08-31 18:53:06 +00001421*/
1422struct FKey {
drh1f638ce2009-09-24 13:48:10 +00001423 Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */
drhc2eef3b2002-08-31 18:53:06 +00001424 FKey *pNextFrom; /* Next foreign key in pFrom */
drh1f638ce2009-09-24 13:48:10 +00001425 char *zTo; /* Name of table that the key points to (aka: Parent) */
dan1da40a32009-09-19 17:00:31 +00001426 FKey *pNextTo; /* Next foreign key on table named zTo */
1427 FKey *pPrevTo; /* Previous foreign key on table named zTo */
drhc2eef3b2002-08-31 18:53:06 +00001428 int nCol; /* Number of columns in this key */
drh4c429832009-10-12 22:30:49 +00001429 /* EV: R-30323-21917 */
drhc2eef3b2002-08-31 18:53:06 +00001430 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
dan8099ce62009-09-23 08:43:35 +00001431 u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */
1432 Trigger *apTrigger[2]; /* Triggers for aAction[] actions */
drhe61922a2009-05-02 13:29:37 +00001433 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
1434 int iFrom; /* Index of column in pFrom */
1435 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
1436 } aCol[1]; /* One entry for each of nCol column s */
drhc2eef3b2002-08-31 18:53:06 +00001437};
1438
1439/*
danielk1977aaa40c12007-09-21 04:28:16 +00001440** SQLite supports many different ways to resolve a constraint
drh22f70c32002-02-18 01:17:00 +00001441** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +00001442** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +00001443** to be rolled back. ABORT processing means the operation in process
1444** fails and any prior changes from that one operation are backed out,
1445** but the transaction is not rolled back. FAIL processing means that
1446** the operation in progress stops and returns an error code. But prior
1447** changes due to the same operation are not backed out and no rollback
1448** occurs. IGNORE means that the particular row that caused the constraint
1449** error is not inserted or updated. Processing continues and no error
1450** is returned. REPLACE means that preexisting database rows that caused
1451** a UNIQUE constraint violation are removed so that the new insert or
1452** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +00001453**
1454** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1455** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1456** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
1457** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
1458** referenced table row is propagated into the row that holds the
1459** foreign key.
drh1c928532002-01-31 15:54:21 +00001460**
drh968af522003-02-11 14:55:40 +00001461** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +00001462** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +00001463*/
drh1c928532002-01-31 15:54:21 +00001464#define OE_None 0 /* There is no constraint to check */
1465#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
1466#define OE_Abort 2 /* Back out changes but do no rollback transaction */
1467#define OE_Fail 3 /* Stop the operation but leave all prior changes */
1468#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
1469#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +00001470
1471#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1472#define OE_SetNull 7 /* Set the foreign key value to NULL */
1473#define OE_SetDflt 8 /* Set the foreign key value to its default */
1474#define OE_Cascade 9 /* Cascade the changes */
1475
drhc28c4e52013-10-03 19:21:41 +00001476#define OE_Default 10 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +00001477
drhd3d39e92004-05-20 22:16:29 +00001478
1479/*
1480** An instance of the following structure is passed as the first
1481** argument to sqlite3VdbeKeyCompare and is used to control the
1482** comparison of the two index keys.
drh323df792013-08-05 19:11:29 +00001483**
1484** Note that aSortOrder[] and aColl[] have nField+1 slots. There
1485** are nField slots for the columns of an index then one extra slot
1486** for the rowid at the end.
drhd3d39e92004-05-20 22:16:29 +00001487*/
1488struct KeyInfo {
drhb21c8cd2007-08-21 19:33:56 +00001489 sqlite3 *db; /* The database connection */
drh9b8d0272010-08-09 15:44:21 +00001490 u8 enc; /* Text encoding - one of the SQLITE_UTF* values */
drh323df792013-08-05 19:11:29 +00001491 u16 nField; /* Maximum index for aColl[] and aSortOrder[] */
1492 u8 *aSortOrder; /* Sort order for each column. */
drhd3d39e92004-05-20 22:16:29 +00001493 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
1494};
1495
drh9cfcf5d2002-01-29 18:41:24 +00001496/*
drhe63d9992008-08-13 19:11:48 +00001497** An instance of the following structure holds information about a
1498** single index record that has already been parsed out into individual
1499** values.
1500**
1501** A record is an object that contains one or more fields of data.
1502** Records are used to store the content of a table row and to store
1503** the key of an index. A blob encoding of a record is created by
shane467bcf32008-11-24 20:01:32 +00001504** the OP_MakeRecord opcode of the VDBE and is disassembled by the
drhe63d9992008-08-13 19:11:48 +00001505** OP_Column opcode.
1506**
1507** This structure holds a record that has already been disassembled
shane467bcf32008-11-24 20:01:32 +00001508** into its constituent fields.
drhe63d9992008-08-13 19:11:48 +00001509*/
1510struct UnpackedRecord {
1511 KeyInfo *pKeyInfo; /* Collation and sort-order information */
1512 u16 nField; /* Number of entries in apMem[] */
drh76a3aca2011-11-29 15:04:12 +00001513 u8 flags; /* Boolean settings. UNPACKED_... below */
danielk1977de630352009-05-04 11:42:29 +00001514 i64 rowid; /* Used by UNPACKED_PREFIX_SEARCH */
drhe63d9992008-08-13 19:11:48 +00001515 Mem *aMem; /* Values */
1516};
1517
1518/*
1519** Allowed values of UnpackedRecord.flags
1520*/
drh76a3aca2011-11-29 15:04:12 +00001521#define UNPACKED_INCRKEY 0x01 /* Make this key an epsilon larger */
1522#define UNPACKED_PREFIX_MATCH 0x02 /* A prefix match is considered OK */
1523#define UNPACKED_PREFIX_SEARCH 0x04 /* Ignore final (rowid) field */
drhe63d9992008-08-13 19:11:48 +00001524
1525/*
drh66b89c82000-11-28 20:47:17 +00001526** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +00001527** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +00001528**
1529** The columns of the table that are to be indexed are described
1530** by the aiColumn[] field of this structure. For example, suppose
1531** we have the following table and index:
1532**
1533** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1534** CREATE INDEX Ex2 ON Ex1(c3,c1);
1535**
1536** In the Table structure describing Ex1, nCol==3 because there are
1537** three columns in the table. In the Index structure describing
1538** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1539** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
1540** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1541** The second column to be indexed (c1) has an index of 0 in
1542** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +00001543**
1544** The Index.onError field determines whether or not the indexed columns
1545** must be unique and what to do if they are not. When Index.onError=OE_None,
1546** it means this is not a unique index. Otherwise it is a unique index
1547** and the value of Index.onError indicate the which conflict resolution
1548** algorithm to employ whenever an attempt is made to insert a non-unique
1549** element.
drh75897232000-05-29 14:26:00 +00001550*/
1551struct Index {
drhb376dae2013-01-01 14:01:28 +00001552 char *zName; /* Name of this index */
1553 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
1554 tRowcnt *aiRowEst; /* From ANALYZE: Est. rows selected by each column */
1555 Table *pTable; /* The SQL table being indexed */
1556 char *zColAff; /* String defining the affinity of each column */
1557 Index *pNext; /* The next index associated with the same table */
1558 Schema *pSchema; /* Schema containing this index */
1559 u8 *aSortOrder; /* for each column: True==DESC, False==ASC */
1560 char **azColl; /* Array of collation sequence names for index */
drh1fe05372013-07-31 18:12:26 +00001561 Expr *pPartIdxWhere; /* WHERE clause for partial indices */
drhb376dae2013-01-01 14:01:28 +00001562 int tnum; /* DB Page containing root of this index */
1563 u16 nColumn; /* Number of columns in table used by this index */
drhc28c4e52013-10-03 19:21:41 +00001564 u8 iScanRatio; /* Scan rate relative to the main table */
1565 unsigned onError:4; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drhb376dae2013-01-01 14:01:28 +00001566 unsigned autoIndex:2; /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */
1567 unsigned bUnordered:1; /* Use this index for == or IN queries only */
drh7699d1c2013-06-04 12:42:29 +00001568 unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */
drh1435a9a2013-08-27 23:15:44 +00001569#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh2b9cf662011-09-22 20:52:56 +00001570 int nSample; /* Number of elements in aSample[] */
dan8ad169a2013-08-12 20:14:04 +00001571 int nSampleCol; /* Size of IndexSample.anEq[] and so on */
daneea568d2013-08-07 19:46:15 +00001572 tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */
drhfaacf172011-08-12 01:51:45 +00001573 IndexSample *aSample; /* Samples of the left-most key */
1574#endif
dan02fa4692009-08-17 17:06:58 +00001575};
1576
1577/*
drh74e7c8f2011-10-21 19:06:32 +00001578** Each sample stored in the sqlite_stat3 table is represented in memory
1579** using a structure of this type. See documentation at the top of the
1580** analyze.c source file for additional information.
dan02fa4692009-08-17 17:06:58 +00001581*/
1582struct IndexSample {
danf52bb8d2013-08-03 20:24:58 +00001583 void *p; /* Pointer to sampled record */
1584 int n; /* Size of record in bytes */
1585 tRowcnt *anEq; /* Est. number of rows where the key equals this sample */
1586 tRowcnt *anLt; /* Est. number of rows where key is less than this sample */
1587 tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */
drh75897232000-05-29 14:26:00 +00001588};
1589
1590/*
1591** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +00001592** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +00001593**
1594** Note if Token.z==0 then Token.dyn and Token.n are undefined and
shane467bcf32008-11-24 20:01:32 +00001595** may contain random values. Do not make any assumptions about Token.dyn
drh4efc4752004-01-16 15:55:37 +00001596** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +00001597*/
1598struct Token {
drhb7916a72009-05-27 10:31:29 +00001599 const char *z; /* Text of the token. Not NULL-terminated! */
1600 unsigned int n; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +00001601};
1602
1603/*
drh13449892005-09-07 21:22:45 +00001604** An instance of this structure contains information needed to generate
1605** code for a SELECT that contains aggregate functions.
1606**
1607** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
1608** pointer to this structure. The Expr.iColumn field is the index in
1609** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
1610** code for that node.
1611**
1612** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
1613** original Select structure that describes the SELECT statement. These
1614** fields do not need to be freed when deallocating the AggInfo structure.
1615*/
1616struct AggInfo {
1617 u8 directMode; /* Direct rendering mode means take data directly
1618 ** from source tables rather than from accumulators */
1619 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
1620 ** than the source table */
1621 int sortingIdx; /* Cursor number of the sorting index */
dan5134d132011-09-02 10:31:11 +00001622 int sortingIdxPTab; /* Cursor number of pseudo-table */
drh13449892005-09-07 21:22:45 +00001623 int nSortingColumn; /* Number of columns in the sorting index */
drha4510172012-02-02 15:50:17 +00001624 ExprList *pGroupBy; /* The group by clause */
drh13449892005-09-07 21:22:45 +00001625 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +00001626 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +00001627 int iTable; /* Cursor number of the source table */
1628 int iColumn; /* Column number within the source table */
1629 int iSorterColumn; /* Column number in the sorting index */
1630 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +00001631 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +00001632 } *aCol;
1633 int nColumn; /* Number of used entries in aCol[] */
drh13449892005-09-07 21:22:45 +00001634 int nAccumulator; /* Number of columns that show through to the output.
1635 ** Additional columns are used only as parameters to
1636 ** aggregate functions */
1637 struct AggInfo_func { /* For each aggregate function */
1638 Expr *pExpr; /* Expression encoding the function */
1639 FuncDef *pFunc; /* The aggregate function implementation */
1640 int iMem; /* Memory location that acts as accumulator */
shane467bcf32008-11-24 20:01:32 +00001641 int iDistinct; /* Ephemeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +00001642 } *aFunc;
1643 int nFunc; /* Number of entries in aFunc[] */
drh13449892005-09-07 21:22:45 +00001644};
1645
1646/*
drh8677d302009-11-04 13:17:14 +00001647** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
1648** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater
1649** than 32767 we have to make it 32-bit. 16-bit is preferred because
1650** it uses less memory in the Expr object, which is a big memory user
1651** in systems with lots of prepared statements. And few applications
1652** need more than about 10 or 20 variables. But some extreme users want
1653** to have prepared statements with over 32767 variables, and for them
1654** the option is available (at compile-time).
1655*/
1656#if SQLITE_MAX_VARIABLE_NUMBER<=32767
drh481aa742009-11-05 18:46:02 +00001657typedef i16 ynVar;
drh8677d302009-11-04 13:17:14 +00001658#else
1659typedef int ynVar;
1660#endif
1661
1662/*
drh75897232000-05-29 14:26:00 +00001663** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +00001664** of this structure.
1665**
danielk19776ab3a2e2009-02-19 14:39:25 +00001666** Expr.op is the opcode. The integer parser token codes are reused
1667** as opcodes here. For example, the parser defines TK_GE to be an integer
1668** code representing the ">=" operator. This same integer code is reused
drh22f70c32002-02-18 01:17:00 +00001669** to represent the greater-than-or-equal-to operator in the expression
1670** tree.
1671**
danielk19776ab3a2e2009-02-19 14:39:25 +00001672** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
1673** or TK_STRING), then Expr.token contains the text of the SQL literal. If
1674** the expression is a variable (TK_VARIABLE), then Expr.token contains the
1675** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
1676** then Expr.token contains the name of the function.
drh22f70c32002-02-18 01:17:00 +00001677**
danielk19776ab3a2e2009-02-19 14:39:25 +00001678** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
1679** binary operator. Either or both may be NULL.
1680**
1681** Expr.x.pList is a list of arguments if the expression is an SQL function,
1682** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
1683** Expr.x.pSelect is used if the expression is a sub-select or an expression of
1684** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
1685** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
1686** valid.
drh22f70c32002-02-18 01:17:00 +00001687**
1688** An expression of the form ID or ID.ID refers to a column in a table.
1689** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
1690** the integer cursor number of a VDBE cursor pointing to that table and
1691** Expr.iColumn is the column number for the specific column. If the
1692** expression is used as a result in an aggregate SELECT, then the
1693** value is also stored in the Expr.iAgg column in the aggregate so that
1694** it can be accessed after all aggregates are computed.
1695**
danielk19776ab3a2e2009-02-19 14:39:25 +00001696** If the expression is an unbound variable marker (a question mark
1697** character '?' in the original SQL) then the Expr.iTable holds the index
1698** number for that variable.
drh22f70c32002-02-18 01:17:00 +00001699**
drh1398ad32005-01-19 23:24:50 +00001700** If the expression is a subquery then Expr.iColumn holds an integer
1701** register number containing the result of the subquery. If the
1702** subquery gives a constant result, then iTable is -1. If the subquery
1703** gives a different answer at different times during statement processing
1704** then iTable is the address of a subroutine that computes the subquery.
1705**
danielk1977aee18ef2005-03-09 12:26:50 +00001706** If the Expr is of type OP_Column, and the table it is selecting from
1707** is a disk table or the "old.*" pseudo-table, then pTab points to the
1708** corresponding table definition.
danielk19776ab3a2e2009-02-19 14:39:25 +00001709**
1710** ALLOCATION NOTES:
1711**
drh12ffee82009-04-08 13:51:51 +00001712** Expr objects can use a lot of memory space in database schema. To
1713** help reduce memory requirements, sometimes an Expr object will be
1714** truncated. And to reduce the number of memory allocations, sometimes
1715** two or more Expr objects will be stored in a single memory allocation,
drh33e619f2009-05-28 01:00:55 +00001716** together with Expr.zToken strings.
danielk19776ab3a2e2009-02-19 14:39:25 +00001717**
drhb7916a72009-05-27 10:31:29 +00001718** If the EP_Reduced and EP_TokenOnly flags are set when
drh12ffee82009-04-08 13:51:51 +00001719** an Expr object is truncated. When EP_Reduced is set, then all
1720** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
1721** are contained within the same memory allocation. Note, however, that
1722** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
1723** allocated, regardless of whether or not EP_Reduced is set.
drh75897232000-05-29 14:26:00 +00001724*/
1725struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001726 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001727 char affinity; /* The affinity of the column or 0 if not a column */
drhc5cd1242013-09-12 16:50:49 +00001728 u32 flags; /* Various flags. EP_* See below */
drh33e619f2009-05-28 01:00:55 +00001729 union {
1730 char *zToken; /* Token value. Zero terminated and dequoted */
drhd50ffc42011-03-08 02:38:28 +00001731 int iValue; /* Non-negative integer value if EP_IntValue */
drh33e619f2009-05-28 01:00:55 +00001732 } u;
danielk19776ab3a2e2009-02-19 14:39:25 +00001733
1734 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
1735 ** space is allocated for the fields below this point. An attempt to
1736 ** access them will result in a segfault or malfunction.
1737 *********************************************************************/
1738
danielk19776ab3a2e2009-02-19 14:39:25 +00001739 Expr *pLeft; /* Left subnode */
1740 Expr *pRight; /* Right subnode */
1741 union {
drhc5cd1242013-09-12 16:50:49 +00001742 ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
1743 Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */
danielk19776ab3a2e2009-02-19 14:39:25 +00001744 } x;
danielk19776ab3a2e2009-02-19 14:39:25 +00001745
1746 /* If the EP_Reduced flag is set in the Expr.flags mask, then no
1747 ** space is allocated for the fields below this point. An attempt to
1748 ** access them will result in a segfault or malfunction.
1749 *********************************************************************/
1750
drh6ec65492012-09-13 19:59:09 +00001751#if SQLITE_MAX_EXPR_DEPTH>0
1752 int nHeight; /* Height of the tree headed by this node */
1753#endif
drhb7916a72009-05-27 10:31:29 +00001754 int iTable; /* TK_COLUMN: cursor number of table holding column
dan2832ad42009-08-31 15:27:27 +00001755 ** TK_REGISTER: register number
drhcca9f3d2013-09-06 15:23:29 +00001756 ** TK_TRIGGER: 1 -> new, 0 -> old
drha4c3c872013-09-12 17:29:25 +00001757 ** EP_Unlikely: 1000 times likelihood */
drh8677d302009-11-04 13:17:14 +00001758 ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid.
dan937d0de2009-10-15 18:35:38 +00001759 ** TK_VARIABLE: variable number (always >= 1). */
drhb7916a72009-05-27 10:31:29 +00001760 i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
1761 i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drh030796d2012-08-23 16:18:10 +00001762 u8 op2; /* TK_REGISTER: original value of Expr.op
1763 ** TK_COLUMN: the value of p5 for OP_Column
1764 ** TK_AGG_FUNCTION: nesting depth */
drh13449892005-09-07 21:22:45 +00001765 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
drh7d10d5a2008-08-20 16:35:10 +00001766 Table *pTab; /* Table for TK_COLUMN expressions. */
drh75897232000-05-29 14:26:00 +00001767};
1768
1769/*
drh1f162302002-10-27 19:35:33 +00001770** The following are the meanings of bits in the Expr.flags field.
1771*/
drhc5cd1242013-09-12 16:50:49 +00001772#define EP_FromJoin 0x000001 /* Originated in ON or USING clause of a join */
1773#define EP_Agg 0x000002 /* Contains one or more aggregate functions */
1774#define EP_Resolved 0x000004 /* IDs have been resolved to COLUMNs */
1775#define EP_Error 0x000008 /* Expression contains one or more errors */
1776#define EP_Distinct 0x000010 /* Aggregate function with DISTINCT keyword */
1777#define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
1778#define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
1779#define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
1780#define EP_Collate 0x000100 /* Tree contains a TK_COLLATE opeartor */
1781#define EP_FixedDest 0x000200 /* Result needed in a specific register */
1782#define EP_IntValue 0x000400 /* Integer value contained in u.iValue */
1783#define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
drha4c3c872013-09-12 17:29:25 +00001784#define EP_Skip 0x001000 /* COLLATE, AS, or UNLIKELY */
drhc5cd1242013-09-12 16:50:49 +00001785#define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
1786#define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
1787#define EP_Static 0x008000 /* Held in memory not obtained from malloc() */
1788#define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */
drhebb6a652013-09-12 23:42:22 +00001789#define EP_NoReduce 0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
drha4c3c872013-09-12 17:29:25 +00001790#define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */
drh33e619f2009-05-28 01:00:55 +00001791
1792/*
drh1f162302002-10-27 19:35:33 +00001793** These macros can be used to test, set, or clear bits in the
1794** Expr.flags field.
1795*/
drhc5cd1242013-09-12 16:50:49 +00001796#define ExprHasProperty(E,P) (((E)->flags&(P))!=0)
1797#define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P))
drh1f162302002-10-27 19:35:33 +00001798#define ExprSetProperty(E,P) (E)->flags|=(P)
1799#define ExprClearProperty(E,P) (E)->flags&=~(P)
1800
drhebb6a652013-09-12 23:42:22 +00001801/* The ExprSetVVAProperty() macro is used for Verification, Validation,
1802** and Accreditation only. It works like ExprSetProperty() during VVA
1803** processes but is a no-op for delivery.
1804*/
1805#ifdef SQLITE_DEBUG
1806# define ExprSetVVAProperty(E,P) (E)->flags|=(P)
1807#else
1808# define ExprSetVVAProperty(E,P)
1809#endif
1810
drh1f162302002-10-27 19:35:33 +00001811/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001812** Macros to determine the number of bytes required by a normal Expr
1813** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
1814** and an Expr struct with the EP_TokenOnly flag set.
1815*/
drh12ffee82009-04-08 13:51:51 +00001816#define EXPR_FULLSIZE sizeof(Expr) /* Full size */
1817#define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */
drhb7916a72009-05-27 10:31:29 +00001818#define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */
danielk19776ab3a2e2009-02-19 14:39:25 +00001819
1820/*
1821** Flags passed to the sqlite3ExprDup() function. See the header comment
1822** above sqlite3ExprDup() for details.
1823*/
drh12ffee82009-04-08 13:51:51 +00001824#define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */
danielk19776ab3a2e2009-02-19 14:39:25 +00001825
1826/*
drh75897232000-05-29 14:26:00 +00001827** A list of expressions. Each expression may optionally have a
1828** name. An expr/name combination can be used in several ways, such
1829** as the list of "expr AS ID" fields following a "SELECT" or in the
1830** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001831** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001832** field is not used.
drh0dde4732012-12-19 13:41:03 +00001833**
1834** By default the Expr.zSpan field holds a human-readable description of
1835** the expression that is used in the generation of error messages and
1836** column labels. In this case, Expr.zSpan is typically the text of a
1837** column expression as it exists in a SELECT statement. However, if
1838** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
drh3e3f1a52013-01-03 00:45:56 +00001839** of the result column in the form: DATABASE.TABLE.COLUMN. This later
1840** form is used for name resolution with nested FROM clauses.
drh75897232000-05-29 14:26:00 +00001841*/
1842struct ExprList {
1843 int nExpr; /* Number of expressions on the list */
drh9d2985c2005-09-08 01:58:42 +00001844 int iECursor; /* VDBE Cursor associated with this ExprList */
drhd872bb12012-02-02 01:58:08 +00001845 struct ExprList_item { /* For each expression in the list */
drh0dde4732012-12-19 13:41:03 +00001846 Expr *pExpr; /* The list of expressions */
1847 char *zName; /* Token associated with this expression */
1848 char *zSpan; /* Original text of the expression */
1849 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1850 unsigned done :1; /* A flag to indicate when processing is finished */
drh3e3f1a52013-01-03 00:45:56 +00001851 unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
drh0dde4732012-12-19 13:41:03 +00001852 u16 iOrderByCol; /* For ORDER BY, column number in result set */
1853 u16 iAlias; /* Index into Parse.aAlias[] for zName */
drhd872bb12012-02-02 01:58:08 +00001854 } *a; /* Alloc a power of two greater or equal to nExpr */
drh75897232000-05-29 14:26:00 +00001855};
1856
1857/*
drhb7916a72009-05-27 10:31:29 +00001858** An instance of this structure is used by the parser to record both
1859** the parse tree for an expression and the span of input text for an
1860** expression.
1861*/
1862struct ExprSpan {
1863 Expr *pExpr; /* The expression parse tree */
1864 const char *zStart; /* First character of input text */
1865 const char *zEnd; /* One character past the end of input text */
1866};
1867
1868/*
drhad3cab52002-05-24 02:04:32 +00001869** An instance of this structure can hold a simple list of identifiers,
1870** such as the list "a,b,c" in the following statements:
1871**
1872** INSERT INTO t(a,b,c) VALUES ...;
1873** CREATE INDEX idx ON t(a,b,c);
1874** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1875**
1876** The IdList.a.idx field is used when the IdList represents the list of
1877** column names after a table name in an INSERT statement. In the statement
1878**
1879** INSERT INTO t(a,b,c) ...
1880**
1881** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001882*/
1883struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001884 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001885 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001886 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001887 } *a;
drh13449892005-09-07 21:22:45 +00001888 int nId; /* Number of identifiers on the list */
drhad3cab52002-05-24 02:04:32 +00001889};
1890
1891/*
drh51669862004-12-18 18:40:26 +00001892** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001893**
1894** Changing this from a 64-bit to a 32-bit type limits the number of
1895** tables in a join to 32 instead of 64. But it also reduces the size
1896** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001897*/
drhca83ac52007-02-01 01:40:44 +00001898typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001899
1900/*
danielk197700e13612008-11-17 19:18:54 +00001901** The number of bits in a Bitmask. "BMS" means "BitMask Size".
1902*/
1903#define BMS ((int)(sizeof(Bitmask)*8))
1904
1905/*
drh7699d1c2013-06-04 12:42:29 +00001906** A bit in a Bitmask
1907*/
1908#define MASKBIT(n) (((Bitmask)1)<<(n))
1909
1910/*
drhad3cab52002-05-24 02:04:32 +00001911** The following structure describes the FROM clause of a SELECT statement.
1912** Each table or subquery in the FROM clause is a separate element of
1913** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001914**
1915** With the addition of multiple database support, the following structure
1916** can also be used to describe a particular table such as the table that
1917** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1918** such a table must be a simple name: ID. But in SQLite, the table can
1919** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001920**
1921** The jointype starts out showing the join type between the current table
1922** and the next table on the list. The parser builds the list this way.
1923** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1924** jointype expresses the join between the table and the previous table.
drh2a6a7ee2010-04-07 14:33:07 +00001925**
1926** In the colUsed field, the high-order bit (bit 63) is set if the table
1927** contains more than 63 columns and the 64-th or later column is used.
drhad3cab52002-05-24 02:04:32 +00001928*/
1929struct SrcList {
drh23f98da2013-05-21 15:52:07 +00001930 u8 nSrc; /* Number of tables or subqueries in the FROM clause */
1931 u8 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001932 struct SrcList_item {
dan41fb5cd2012-10-04 19:33:00 +00001933 Schema *pSchema; /* Schema to which this item is fixed */
drh113088e2003-03-20 01:16:58 +00001934 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001935 char *zName; /* Name of the table */
1936 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001937 Table *pTab; /* An SQL table corresponding to zName */
1938 Select *pSelect; /* A SELECT statement used in place of a table name */
drh5b6a9ed2011-09-15 23:58:14 +00001939 int addrFillSub; /* Address of subroutine to manifest a subquery */
1940 int regReturn; /* Register holding return address of addrFillSub */
drhc49de5d2007-01-19 01:06:01 +00001941 u8 jointype; /* Type of join between this able and the previous */
drh21172c42012-10-30 00:29:07 +00001942 unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */
1943 unsigned isCorrelated :1; /* True if sub-query is correlated */
1944 unsigned viaCoroutine :1; /* Implemented as a co-routine */
dance7e1892010-12-01 19:00:48 +00001945#ifndef SQLITE_OMIT_EXPLAIN
1946 u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */
1947#endif
drhe68fbe72007-02-13 12:49:24 +00001948 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001949 Expr *pOn; /* The ON clause of a join */
1950 IdList *pUsing; /* The USING clause of a join */
danielk1977cd38d522009-01-02 17:33:46 +00001951 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */
danielk197785574e32008-10-06 05:32:18 +00001952 char *zIndex; /* Identifier from "INDEXED BY <zIndex>" clause */
1953 Index *pIndex; /* Index structure corresponding to zIndex, if any */
drh113088e2003-03-20 01:16:58 +00001954 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001955};
1956
1957/*
drh01f3f252002-05-24 16:14:15 +00001958** Permitted values of the SrcList.a.jointype field
1959*/
1960#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001961#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1962#define JT_NATURAL 0x0004 /* True for a "natural" join */
1963#define JT_LEFT 0x0008 /* Left outer join */
1964#define JT_RIGHT 0x0010 /* Right outer join */
1965#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1966#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001967
drh111a6a72008-12-21 03:51:16 +00001968
1969/*
drh336a5302009-04-24 15:46:21 +00001970** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
1971** and the WhereInfo.wctrlFlags member.
drh08c88eb2008-04-10 13:33:18 +00001972*/
drh6df2acd2008-12-28 16:55:25 +00001973#define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
1974#define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
1975#define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
1976#define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
drh336a5302009-04-24 15:46:21 +00001977#define WHERE_DUPLICATES_OK 0x0008 /* Ok to return a row more than once */
drh9ef61f42011-10-07 14:40:59 +00001978#define WHERE_OMIT_OPEN_CLOSE 0x0010 /* Table cursors are already open */
1979#define WHERE_FORCE_TABLE 0x0020 /* Do not use an index-only search */
1980#define WHERE_ONETABLE_ONLY 0x0040 /* Only code the 1st table in pTabList */
1981#define WHERE_AND_ONLY 0x0080 /* Don't use indices for OR terms */
drh319f6772013-05-14 15:31:07 +00001982#define WHERE_GROUPBY 0x0100 /* pOrderBy is really a GROUP BY */
drh4f402f22013-06-11 18:59:38 +00001983#define WHERE_DISTINCTBY 0x0200 /* pOrderby is really a DISTINCT clause */
drh6457a352013-06-21 00:35:37 +00001984#define WHERE_WANT_DISTINCT 0x0400 /* All output needs to be distinct */
danielk1977a9d1ccb2008-01-05 17:39:29 +00001985
drh4f402f22013-06-11 18:59:38 +00001986/* Allowed return values from sqlite3WhereIsDistinct()
1987*/
drhe8e4af72012-09-21 00:04:28 +00001988#define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */
1989#define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */
1990#define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */
1991#define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */
dan38cc40c2011-06-30 20:17:15 +00001992
drh75897232000-05-29 14:26:00 +00001993/*
danielk1977b3bce662005-01-29 08:32:43 +00001994** A NameContext defines a context in which to resolve table and column
1995** names. The context consists of a list of tables (the pSrcList) field and
1996** a list of named expression (pEList). The named expression list may
1997** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1998** to the table being operated on by INSERT, UPDATE, or DELETE. The
1999** pEList corresponds to the result set of a SELECT and is NULL for
2000** other statements.
2001**
2002** NameContexts can be nested. When resolving names, the inner-most
2003** context is searched first. If no match is found, the next outer
2004** context is checked. If there is still no match, the next context
2005** is checked. This process continues until either a match is found
2006** or all contexts are check. When a match is found, the nRef member of
2007** the context containing the match is incremented.
2008**
2009** Each subquery gets a new NameContext. The pNext field points to the
2010** NameContext in the parent query. Thus the process of scanning the
2011** NameContext list corresponds to searching through successively outer
2012** subqueries looking for a match.
2013*/
2014struct NameContext {
2015 Parse *pParse; /* The parser */
2016 SrcList *pSrcList; /* One or more tables used to resolve names */
drh26080d92013-08-15 14:27:42 +00002017 ExprList *pEList; /* Optional list of result-set columns */
drh13449892005-09-07 21:22:45 +00002018 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00002019 NameContext *pNext; /* Next outer name context. NULL for outermost */
drha51009b2012-05-21 19:11:25 +00002020 int nRef; /* Number of names resolved by this context */
2021 int nErr; /* Number of errors encountered while resolving names */
2022 u8 ncFlags; /* Zero or more NC_* flags defined below */
danielk1977b3bce662005-01-29 08:32:43 +00002023};
2024
2025/*
drha51009b2012-05-21 19:11:25 +00002026** Allowed values for the NameContext, ncFlags field.
2027*/
2028#define NC_AllowAgg 0x01 /* Aggregate functions are allowed here */
2029#define NC_HasAgg 0x02 /* One or more aggregate functions seen */
2030#define NC_IsCheck 0x04 /* True if resolving names in a CHECK constraint */
drh3a8c4be2012-05-21 20:13:39 +00002031#define NC_InAggFunc 0x08 /* True if analyzing arguments to an agg func */
drhe35463b2013-08-15 20:24:27 +00002032#define NC_PartIdx 0x10 /* True if resolving a partial index WHERE */
drha51009b2012-05-21 19:11:25 +00002033
2034/*
drh9bb61fe2000-06-05 16:01:39 +00002035** An instance of the following structure contains all information
2036** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00002037**
drhd11d3822002-06-21 23:01:49 +00002038** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
2039** If there is a LIMIT clause, the parser sets nLimit to the value of the
2040** limit and nOffset to the value of the offset (or 0 if there is not
2041** offset). But later on, nLimit and nOffset become the memory locations
2042** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00002043**
drhb9bb7c12006-06-11 23:41:55 +00002044** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00002045** These addresses must be stored so that we can go back and fill in
drh66a51672008-01-03 00:01:23 +00002046** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
drh0342b1f2005-09-01 03:07:44 +00002047** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00002048** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00002049** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00002050** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
drh2c797332012-09-20 14:26:22 +00002051** for the result set. The KeyInfo for addrOpenEphm[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00002052** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00002053*/
2054struct Select {
drh9bb61fe2000-06-05 16:01:39 +00002055 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00002056 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
drh7d10d5a2008-08-20 16:35:10 +00002057 u16 selFlags; /* Various SF_* values */
drha4510172012-02-02 15:50:17 +00002058 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
2059 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drhc63367e2013-06-10 20:46:50 +00002060 u64 nSelectRow; /* Estimated number of result rows */
drhad3cab52002-05-24 02:04:32 +00002061 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00002062 Expr *pWhere; /* The WHERE clause */
2063 ExprList *pGroupBy; /* The GROUP BY clause */
2064 Expr *pHaving; /* The HAVING clause */
2065 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00002066 Select *pPrior; /* Prior select in a compound select statement */
drh1e281292007-12-13 03:45:07 +00002067 Select *pNext; /* Next select to the left in a compound */
drh0342b1f2005-09-01 03:07:44 +00002068 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00002069 Expr *pLimit; /* LIMIT expression. NULL means not used. */
2070 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh9bb61fe2000-06-05 16:01:39 +00002071};
2072
2073/*
drh7d10d5a2008-08-20 16:35:10 +00002074** Allowed values for Select.selFlags. The "SF" prefix stands for
2075** "Select Flag".
2076*/
drh21172c42012-10-30 00:29:07 +00002077#define SF_Distinct 0x0001 /* Output should be DISTINCT */
2078#define SF_Resolved 0x0002 /* Identifiers have been resolved */
2079#define SF_Aggregate 0x0004 /* Contains aggregate functions */
2080#define SF_UsesEphemeral 0x0008 /* Uses the OpenEphemeral opcode */
2081#define SF_Expanded 0x0010 /* sqlite3SelectExpand() called on this */
2082#define SF_HasTypeInfo 0x0020 /* FROM subqueries have Table metadata */
2083#define SF_UseSorter 0x0040 /* Sort using a sorter */
2084#define SF_Values 0x0080 /* Synthesized from VALUES clause */
2085#define SF_Materialize 0x0100 /* Force materialization of views */
drh832ee3d2012-12-18 19:36:11 +00002086#define SF_NestedFrom 0x0200 /* Part of a parenthesized FROM clause */
drhd58d3272013-08-05 22:05:02 +00002087#define SF_MaybeConvert 0x0400 /* Need convertCompoundSelectToSubquery() */
drh7d10d5a2008-08-20 16:35:10 +00002088
2089
2090/*
2091** The results of a select can be distributed in several ways. The
2092** "SRT" prefix means "SELECT Result Type".
drhfef52082000-06-06 01:50:43 +00002093*/
drh13449892005-09-07 21:22:45 +00002094#define SRT_Union 1 /* Store result as keys in an index */
2095#define SRT_Except 2 /* Remove result from a UNION index */
danielk19779ed1dfa2008-01-02 17:11:14 +00002096#define SRT_Exists 3 /* Store 1 if the result is not empty */
2097#define SRT_Discard 4 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00002098
drh13449892005-09-07 21:22:45 +00002099/* The ORDER BY clause is ignored for all of the above */
danielk19776c8c8ce2008-01-02 16:27:09 +00002100#define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
drh13449892005-09-07 21:22:45 +00002101
drh7d10d5a2008-08-20 16:35:10 +00002102#define SRT_Output 5 /* Output each row of result */
danielk19779ed1dfa2008-01-02 17:11:14 +00002103#define SRT_Mem 6 /* Store result in a memory cell */
danielk19770cdc0222008-06-26 18:04:03 +00002104#define SRT_Set 7 /* Store results as keys in an index */
danielk19779ed1dfa2008-01-02 17:11:14 +00002105#define SRT_Table 8 /* Store result as data with an automatic rowid */
2106#define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */
drhe00ee6e2008-06-20 15:24:01 +00002107#define SRT_Coroutine 10 /* Generate a single row of result */
drh22827922000-06-06 17:27:05 +00002108
2109/*
drh634d81d2012-09-20 15:41:31 +00002110** An instance of this object describes where to put of the results of
2111** a SELECT statement.
danielk19776c8c8ce2008-01-02 16:27:09 +00002112*/
danielk19776c8c8ce2008-01-02 16:27:09 +00002113struct SelectDest {
drh634d81d2012-09-20 15:41:31 +00002114 u8 eDest; /* How to dispose of the results. On of SRT_* above. */
2115 char affSdst; /* Affinity used when eDest==SRT_Set */
drh2b596da2012-07-23 21:43:19 +00002116 int iSDParm; /* A parameter used by the eDest disposal method */
2117 int iSdst; /* Base register where results are written */
2118 int nSdst; /* Number of registers allocated */
danielk19776c8c8ce2008-01-02 16:27:09 +00002119};
2120
2121/*
drh0b9f50d2009-06-23 20:28:53 +00002122** During code generation of statements that do inserts into AUTOINCREMENT
2123** tables, the following information is attached to the Table.u.autoInc.p
2124** pointer of each autoincrement table to record some side information that
2125** the code generator needs. We have to keep per-table autoincrement
2126** information in case inserts are down within triggers. Triggers do not
2127** normally coordinate their activities, but we do need to coordinate the
2128** loading and saving of autoincrement information.
2129*/
2130struct AutoincInfo {
2131 AutoincInfo *pNext; /* Next info block in a list of them all */
2132 Table *pTab; /* Table this info block refers to */
2133 int iDb; /* Index in sqlite3.aDb[] of database holding pTab */
2134 int regCtr; /* Memory register holding the rowid counter */
2135};
2136
2137/*
drhceea3322009-04-23 13:22:42 +00002138** Size of the column cache
2139*/
2140#ifndef SQLITE_N_COLCACHE
2141# define SQLITE_N_COLCACHE 10
2142#endif
2143
dan2832ad42009-08-31 15:27:27 +00002144/*
2145** At least one instance of the following structure is created for each
2146** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
2147** statement. All such objects are stored in the linked list headed at
2148** Parse.pTriggerPrg and deleted once statement compilation has been
2149** completed.
2150**
2151** A Vdbe sub-program that implements the body and WHEN clause of trigger
2152** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
2153** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
2154** The Parse.pTriggerPrg list never contains two entries with the same
2155** values for both pTrigger and orconf.
dan65a7cd12009-09-01 12:16:01 +00002156**
danbb5f1682009-11-27 12:12:34 +00002157** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
dan65a7cd12009-09-01 12:16:01 +00002158** accessed (or set to 0 for triggers fired as a result of INSERT
danbb5f1682009-11-27 12:12:34 +00002159** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
2160** a mask of new.* columns used by the program.
dan2832ad42009-08-31 15:27:27 +00002161*/
2162struct TriggerPrg {
2163 Trigger *pTrigger; /* Trigger this program was coded from */
dan2832ad42009-08-31 15:27:27 +00002164 TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */
drha4510172012-02-02 15:50:17 +00002165 SubProgram *pProgram; /* Program implementing pTrigger/orconf */
2166 int orconf; /* Default ON CONFLICT policy */
2167 u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */
dan165921a2009-08-28 18:53:45 +00002168};
2169
drh64123582011-04-02 20:01:02 +00002170/*
2171** The yDbMask datatype for the bitmask of all attached databases.
2172*/
drh01c7dc82011-03-23 18:22:34 +00002173#if SQLITE_MAX_ATTACHED>30
drh64123582011-04-02 20:01:02 +00002174 typedef sqlite3_uint64 yDbMask;
drh01c7dc82011-03-23 18:22:34 +00002175#else
drh64123582011-04-02 20:01:02 +00002176 typedef unsigned int yDbMask;
drh01c7dc82011-03-23 18:22:34 +00002177#endif
2178
drhceea3322009-04-23 13:22:42 +00002179/*
drhf57b3392001-10-08 13:22:32 +00002180** An SQL parser context. A copy of this structure is passed through
2181** the parser and down into all the parser action routine in order to
2182** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00002183**
2184** The structure is divided into two parts. When the parser and code
2185** generate call themselves recursively, the first part of the structure
2186** is constant but the second part is reset at the beginning and end of
2187** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00002188**
2189** The nTableLock and aTableLock variables are only used if the shared-cache
2190** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
2191** used to store the set of table-locks required by the statement being
2192** compiled. Function sqlite3TableLock() is used to add entries to the
2193** list.
drh75897232000-05-29 14:26:00 +00002194*/
2195struct Parse {
drh9bb575f2004-09-06 17:24:11 +00002196 sqlite3 *db; /* The main database structure */
drh75897232000-05-29 14:26:00 +00002197 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00002198 Vdbe *pVdbe; /* An engine for executing database bytecode */
drha4510172012-02-02 15:50:17 +00002199 int rc; /* Return code from execution */
drh836faa42003-01-11 13:30:57 +00002200 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drha6ecd332004-06-10 00:29:09 +00002201 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00002202 u8 nested; /* Number of nested calls to the parser/code generator */
drh892d3172008-01-10 03:46:36 +00002203 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
drh2dcef112008-01-12 19:03:48 +00002204 u8 nTempInUse; /* Number of aTempReg[] currently checked out */
drha4510172012-02-02 15:50:17 +00002205 u8 nColCache; /* Number of entries in aColCache[] */
2206 u8 iColCache; /* Next entry in aColCache[] to replace */
2207 u8 isMultiWrite; /* True if statement may modify/insert multiple rows */
2208 u8 mayAbort; /* True if statement may throw an ABORT exception */
drhd58d3272013-08-05 22:05:02 +00002209 u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */
drh892d3172008-01-10 03:46:36 +00002210 int aTempReg[8]; /* Holding area for temporary registers */
2211 int nRangeReg; /* Size of the temporary register block */
2212 int iRangeReg; /* First register in temporary register block */
drh75897232000-05-29 14:26:00 +00002213 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00002214 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00002215 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00002216 int nSet; /* Number of sets used so far */
dan1d8cb212011-12-09 13:24:16 +00002217 int nOnce; /* Number of OP_Once instructions so far */
drhaa9b8962008-01-08 02:57:55 +00002218 int ckBase; /* Base register of data during check constraints */
drhb2b9d3d2013-08-01 01:14:43 +00002219 int iPartIdxTab; /* Table corresponding to a partial index */
drhceea3322009-04-23 13:22:42 +00002220 int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
2221 int iCacheCnt; /* Counter used to generate aColCache[].lru values */
drh2f7794c2008-04-01 03:27:39 +00002222 struct yColCache {
drhe55cbd72008-03-31 23:48:03 +00002223 int iTable; /* Table cursor number */
2224 int iColumn; /* Table column number */
drhceea3322009-04-23 13:22:42 +00002225 u8 tempReg; /* iReg is a temp register that needs to be freed */
2226 int iLevel; /* Nesting level */
2227 int iReg; /* Reg with value of this column. 0 means none. */
2228 int lru; /* Least recently used entry has the smallest value */
2229 } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */
drh64123582011-04-02 20:01:02 +00002230 yDbMask writeMask; /* Start a write transaction on these databases */
2231 yDbMask cookieMask; /* Bitmask of schema verified databases */
drhfcd35c72005-05-21 02:48:08 +00002232 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
drhc797d4d2007-05-08 01:08:49 +00002233 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */
drha4510172012-02-02 15:50:17 +00002234 int regRowid; /* Register holding rowid of CREATE TABLE entry */
2235 int regRoot; /* Register holding root page number for new objects */
2236 int nMaxArg; /* Max args passed to user function by sub-program */
drh2938f922012-03-07 19:13:29 +00002237 Token constraintName;/* Name of the constraint currently being parsed */
danielk1977c00da102006-01-07 13:21:04 +00002238#ifndef SQLITE_OMIT_SHARED_CACHE
2239 int nTableLock; /* Number of locks in aTableLock */
2240 TableLock *aTableLock; /* Required table locks for shared-cache mode */
2241#endif
drh0b9f50d2009-06-23 20:28:53 +00002242 AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */
drhf1974842004-11-05 03:56:00 +00002243
dan165921a2009-08-28 18:53:45 +00002244 /* Information used while coding trigger programs. */
dan65a7cd12009-09-01 12:16:01 +00002245 Parse *pToplevel; /* Parse structure for main program (or NULL) */
dan165921a2009-08-28 18:53:45 +00002246 Table *pTriggerTab; /* Table triggers are being coded for */
drh4f402f22013-06-11 18:59:38 +00002247 u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */
dan65a7cd12009-09-01 12:16:01 +00002248 u32 oldmask; /* Mask of old.* columns referenced */
danbb5f1682009-11-27 12:12:34 +00002249 u32 newmask; /* Mask of new.* columns referenced */
dan65a7cd12009-09-01 12:16:01 +00002250 u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */
2251 u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */
dand66c8302009-09-28 14:49:01 +00002252 u8 disableTriggers; /* True to disable triggers */
dan165921a2009-08-28 18:53:45 +00002253
drhf1974842004-11-05 03:56:00 +00002254 /* Above is constant between recursions. Below is reset before and after
2255 ** each recursion */
2256
drha4510172012-02-02 15:50:17 +00002257 int nVar; /* Number of '?' variables seen in the SQL so far */
2258 int nzVar; /* Number of available slots in azVar[] */
2259 u8 explain; /* True if the EXPLAIN flag is found on the query */
2260#ifndef SQLITE_OMIT_VIRTUALTABLE
2261 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
2262 int nVtabLock; /* Number of virtual tables to lock */
2263#endif
2264 int nAlias; /* Number of aliased result set columns */
2265 int nHeight; /* Expression tree height of current sub-select */
2266#ifndef SQLITE_OMIT_EXPLAIN
2267 int iSelectId; /* ID of current select for EXPLAIN output */
2268 int iNextSelectId; /* Next available select ID for EXPLAIN output */
2269#endif
2270 char **azVar; /* Pointers to names of parameters */
2271 Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */
2272 int *aAlias; /* Register used to hold aliased result */
2273 const char *zTail; /* All SQL text past the last semicolon parsed */
2274 Table *pNewTable; /* A table being constructed by CREATE TABLE */
drhf1974842004-11-05 03:56:00 +00002275 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
drhf1974842004-11-05 03:56:00 +00002276 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drha4510172012-02-02 15:50:17 +00002277 Token sNameToken; /* Token with unqualified schema object name */
2278 Token sLastToken; /* The last token parsed */
drhb9bb7c12006-06-11 23:41:55 +00002279#ifndef SQLITE_OMIT_VIRTUALTABLE
drha4510172012-02-02 15:50:17 +00002280 Token sArg; /* Complete text of a module argument */
2281 Table **apVtabLock; /* Pointer to virtual tables needing locking */
drhb9bb7c12006-06-11 23:41:55 +00002282#endif
drha4510172012-02-02 15:50:17 +00002283 Table *pZombieTab; /* List of Table objects to delete after code gen */
2284 TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */
drh75897232000-05-29 14:26:00 +00002285};
2286
drha4510172012-02-02 15:50:17 +00002287/*
2288** Return true if currently inside an sqlite3_declare_vtab() call.
2289*/
danielk19777e6ebfb2006-06-12 11:24:37 +00002290#ifdef SQLITE_OMIT_VIRTUALTABLE
2291 #define IN_DECLARE_VTAB 0
2292#else
2293 #define IN_DECLARE_VTAB (pParse->declareVtab)
2294#endif
2295
danielk1977d99bc932002-05-16 00:13:12 +00002296/*
drh85e20962003-04-25 17:52:11 +00002297** An instance of the following structure can be declared on a stack and used
2298** to save the Parse.zAuthContext value so that it can be restored later.
2299*/
2300struct AuthContext {
2301 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
2302 Parse *pParse; /* The Parse structure */
2303};
2304
2305/*
drha748fdc2012-03-28 01:34:47 +00002306** Bitfield flags for P5 value in various opcodes.
rdcb0c374f2004-02-20 22:53:38 +00002307*/
drh3e9ca092009-09-08 01:14:48 +00002308#define OPFLAG_NCHANGE 0x01 /* Set to update db->nChange */
2309#define OPFLAG_LASTROWID 0x02 /* Set to update db->lastRowid */
2310#define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */
2311#define OPFLAG_APPEND 0x08 /* This is likely to be an append */
2312#define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */
2313#define OPFLAG_CLEARCACHE 0x20 /* Clear pseudo-table cache in OP_Column */
drha748fdc2012-03-28 01:34:47 +00002314#define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */
2315#define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */
dan428c2182012-08-06 18:50:11 +00002316#define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */
2317#define OPFLAG_P2ISREG 0x02 /* P2 to OP_Open** is a register number */
drh953f7612012-12-07 22:18:54 +00002318#define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */
rdcb0c374f2004-02-20 22:53:38 +00002319
2320/*
danielk1977d99bc932002-05-16 00:13:12 +00002321 * Each trigger present in the database schema is stored as an instance of
2322 * struct Trigger.
2323 *
2324 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00002325 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00002326 * database). This allows Trigger structures to be retrieved by name.
2327 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00002328 * pNext member of struct Trigger. A pointer to the first element of the
2329 * linked list is stored as the "pTrigger" member of the associated
2330 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00002331 *
drhad3cab52002-05-24 02:04:32 +00002332 * The "step_list" member points to the first element of a linked list
2333 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00002334 */
danielk1977c3f9bad2002-05-15 08:30:12 +00002335struct Trigger {
dan165921a2009-08-28 18:53:45 +00002336 char *zName; /* The name of the trigger */
drhdc379452002-05-15 12:45:43 +00002337 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00002338 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00002339 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
shane467bcf32008-11-24 20:01:32 +00002340 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
drhdc379452002-05-15 12:45:43 +00002341 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00002342 the <column-list> is stored here */
danielk1977e501b892006-01-09 06:29:47 +00002343 Schema *pSchema; /* Schema containing the trigger */
2344 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00002345 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00002346 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00002347};
2348
danielk1977d99bc932002-05-16 00:13:12 +00002349/*
drhdca76842004-12-07 14:06:13 +00002350** A trigger is either a BEFORE or an AFTER trigger. The following constants
2351** determine which.
2352**
2353** If there are multiple triggers, you might of some BEFORE and some AFTER.
2354** In that cases, the constants below can be ORed together.
2355*/
2356#define TRIGGER_BEFORE 1
2357#define TRIGGER_AFTER 2
2358
2359/*
danielk1977d99bc932002-05-16 00:13:12 +00002360 * An instance of struct TriggerStep is used to store a single SQL statement
2361 * that is a part of a trigger-program.
2362 *
2363 * Instances of struct TriggerStep are stored in a singly linked list (linked
2364 * using the "pNext" member) referenced by the "step_list" member of the
2365 * associated struct Trigger instance. The first element of the linked list is
2366 * the first step of the trigger-program.
2367 *
2368 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
2369 * "SELECT" statement. The meanings of the other members is determined by the
2370 * value of "op" as follows:
2371 *
2372 * (op == TK_INSERT)
2373 * orconf -> stores the ON CONFLICT algorithm
2374 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
2375 * this stores a pointer to the SELECT statement. Otherwise NULL.
drhb7916a72009-05-27 10:31:29 +00002376 * target -> A token holding the quoted name of the table to insert into.
danielk1977d99bc932002-05-16 00:13:12 +00002377 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
2378 * this stores values to be inserted. Otherwise NULL.
2379 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00002380 * statement, then this stores the column-names to be
2381 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00002382 *
2383 * (op == TK_DELETE)
drhb7916a72009-05-27 10:31:29 +00002384 * target -> A token holding the quoted name of the table to delete from.
danielk1977d99bc932002-05-16 00:13:12 +00002385 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
2386 * Otherwise NULL.
2387 *
2388 * (op == TK_UPDATE)
drhb7916a72009-05-27 10:31:29 +00002389 * target -> A token holding the quoted name of the table to update rows of.
danielk1977d99bc932002-05-16 00:13:12 +00002390 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
2391 * Otherwise NULL.
2392 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00002393 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00002394 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00002395 *
2396 */
2397struct TriggerStep {
drhb1819a02009-07-03 15:37:27 +00002398 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
2399 u8 orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00002400 Trigger *pTrig; /* The trigger that this step is a part of */
drhb1819a02009-07-03 15:37:27 +00002401 Select *pSelect; /* SELECT statment or RHS of INSERT INTO .. SELECT ... */
2402 Token target; /* Target table for DELETE, UPDATE, INSERT */
2403 Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */
2404 ExprList *pExprList; /* SET clause for UPDATE. VALUES clause for INSERT */
2405 IdList *pIdList; /* Column names for INSERT */
drh187e4c62006-02-27 22:22:27 +00002406 TriggerStep *pNext; /* Next in the link-list */
2407 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00002408};
2409
2410/*
drhf26e09c2003-05-31 16:21:12 +00002411** The following structure contains information used by the sqliteFix...
2412** routines as they walk the parse tree to make database references
2413** explicit.
2414*/
2415typedef struct DbFixer DbFixer;
2416struct DbFixer {
2417 Parse *pParse; /* The parsing context. Error messages written here */
dan41fb5cd2012-10-04 19:33:00 +00002418 Schema *pSchema; /* Fix items to this schema */
dan46539d72013-10-03 12:29:38 +00002419 int bVarOnly; /* Check for variable references only */
drhf26e09c2003-05-31 16:21:12 +00002420 const char *zDb; /* Make sure all objects are contained in this database */
2421 const char *zType; /* Type of the container - used for error messages */
2422 const Token *pName; /* Name of the container - used for error messages */
2423};
2424
2425/*
drhade86482007-11-28 22:36:40 +00002426** An objected used to accumulate the text of a string where we
2427** do not necessarily know how big the string will be in the end.
2428*/
2429struct StrAccum {
drh633e6d52008-07-28 19:34:53 +00002430 sqlite3 *db; /* Optional database for lookaside. Can be NULL */
2431 char *zBase; /* A base allocation. Not from malloc. */
2432 char *zText; /* The string collected so far */
2433 int nChar; /* Length of the string so far */
2434 int nAlloc; /* Amount of space allocated in zText */
drhbb4957f2008-03-20 14:03:29 +00002435 int mxAlloc; /* Maximum allowed string length */
drhb9755982010-07-24 16:34:37 +00002436 u8 useMalloc; /* 0: none, 1: sqlite3DbMalloc, 2: sqlite3_malloc */
drhb49bc862013-08-21 21:12:10 +00002437 u8 accError; /* STRACCUM_NOMEM or STRACCUM_TOOBIG */
drhade86482007-11-28 22:36:40 +00002438};
drhb49bc862013-08-21 21:12:10 +00002439#define STRACCUM_NOMEM 1
2440#define STRACCUM_TOOBIG 2
drhade86482007-11-28 22:36:40 +00002441
2442/*
drh234c39d2004-07-24 03:30:47 +00002443** A pointer to this structure is used to communicate information
2444** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
2445*/
2446typedef struct {
drh9bb575f2004-09-06 17:24:11 +00002447 sqlite3 *db; /* The database being initialized */
drh234c39d2004-07-24 03:30:47 +00002448 char **pzErrMsg; /* Error message stored here */
drha4510172012-02-02 15:50:17 +00002449 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh15ca1df2006-07-26 13:43:30 +00002450 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00002451} InitData;
2452
drhb6c29892004-11-22 19:12:19 +00002453/*
drh40257ff2008-06-13 18:24:27 +00002454** Structure containing global configuration data for the SQLite library.
drh33589792008-06-18 13:27:46 +00002455**
2456** This structure also contains some state information.
drh40257ff2008-06-13 18:24:27 +00002457*/
2458struct Sqlite3Config {
drhfec00ea2008-06-14 16:56:21 +00002459 int bMemstat; /* True to enable memory status */
2460 int bCoreMutex; /* True to enable core mutexing */
2461 int bFullMutex; /* True to enable full mutexing */
dancd74b612011-04-22 19:37:32 +00002462 int bOpenUri; /* True to interpret filenames as URIs */
drhde9a7b82012-09-17 20:44:46 +00002463 int bUseCis; /* Use covering indices for full-scans */
drh0a687d12008-07-08 14:52:07 +00002464 int mxStrlen; /* Maximum string length */
drh633e6d52008-07-28 19:34:53 +00002465 int szLookaside; /* Default lookaside buffer size */
2466 int nLookaside; /* Default lookaside buffer count */
drhfec00ea2008-06-14 16:56:21 +00002467 sqlite3_mem_methods m; /* Low-level memory allocation interface */
danielk19776d2ab0e2008-06-17 17:21:18 +00002468 sqlite3_mutex_methods mutex; /* Low-level mutex interface */
dan22e21ff2011-11-08 20:08:44 +00002469 sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */
drh40257ff2008-06-13 18:24:27 +00002470 void *pHeap; /* Heap storage space */
drh33589792008-06-18 13:27:46 +00002471 int nHeap; /* Size of pHeap[] */
2472 int mnReq, mxReq; /* Min and max heap requests sizes */
drh9b4c59f2013-04-15 17:03:42 +00002473 sqlite3_int64 szMmap; /* mmap() space per open file */
2474 sqlite3_int64 mxMmap; /* Maximum value for szMmap */
drh33589792008-06-18 13:27:46 +00002475 void *pScratch; /* Scratch memory */
2476 int szScratch; /* Size of each scratch buffer */
2477 int nScratch; /* Number of scratch buffers */
2478 void *pPage; /* Page cache memory */
2479 int szPage; /* Size of each page in pPage[] */
2480 int nPage; /* Number of pages in pPage[] */
drh1875f7a2008-12-08 18:19:17 +00002481 int mxParserStack; /* maximum depth of the parser stack */
2482 int sharedCacheEnabled; /* true if shared-cache mode enabled */
2483 /* The above might be initialized to non-zero. The following need to always
2484 ** initially be zero, however. */
danielk197771bc31c2008-06-26 08:29:34 +00002485 int isInit; /* True after initialization has finished */
danielk1977502b4e02008-09-02 14:07:24 +00002486 int inProgress; /* True while initialization in progress */
dane1ab2192009-08-17 15:16:19 +00002487 int isMutexInit; /* True after mutexes are initialized */
danielk197771bc31c2008-06-26 08:29:34 +00002488 int isMallocInit; /* True after malloc is initialized */
dane1ab2192009-08-17 15:16:19 +00002489 int isPCacheInit; /* True after malloc is initialized */
danielk197771bc31c2008-06-26 08:29:34 +00002490 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
drh93ed56d2008-08-12 15:21:11 +00002491 int nRefInitMutex; /* Number of users of pInitMutex */
drh3f280702010-02-18 18:45:09 +00002492 void (*xLog)(void*,int,const char*); /* Function for logging */
2493 void *pLogArg; /* First argument to xLog() */
danc17d6962011-06-21 12:47:30 +00002494 int bLocaltimeFault; /* True to fail localtime() calls */
danac455932012-11-26 19:50:41 +00002495#ifdef SQLITE_ENABLE_SQLLOG
2496 void(*xSqllog)(void*,sqlite3*,const char*, int);
2497 void *pSqllogArg;
2498#endif
drh40257ff2008-06-13 18:24:27 +00002499};
2500
2501/*
drh7d10d5a2008-08-20 16:35:10 +00002502** Context pointer passed down through the tree-walk.
2503*/
2504struct Walker {
2505 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
2506 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
2507 Parse *pParse; /* Parser context. */
drh030796d2012-08-23 16:18:10 +00002508 int walkerDepth; /* Number of subqueries */
drhaa87f9a2013-04-25 00:57:10 +00002509 u8 bSelectDepthFirst; /* Do subqueries first */
drh7d10d5a2008-08-20 16:35:10 +00002510 union { /* Extra data for callback */
2511 NameContext *pNC; /* Naming context */
2512 int i; /* Integer value */
drh374fdce2012-04-17 16:38:53 +00002513 SrcList *pSrcList; /* FROM clause */
drh030796d2012-08-23 16:18:10 +00002514 struct SrcCount *pSrcCount; /* Counting column references */
drh7d10d5a2008-08-20 16:35:10 +00002515 } u;
2516};
2517
2518/* Forward declarations */
2519int sqlite3WalkExpr(Walker*, Expr*);
2520int sqlite3WalkExprList(Walker*, ExprList*);
2521int sqlite3WalkSelect(Walker*, Select*);
2522int sqlite3WalkSelectExpr(Walker*, Select*);
2523int sqlite3WalkSelectFrom(Walker*, Select*);
2524
2525/*
2526** Return code from the parse-tree walking primitives and their
2527** callbacks.
2528*/
drh2bf90f12008-12-09 13:04:29 +00002529#define WRC_Continue 0 /* Continue down into children */
2530#define WRC_Prune 1 /* Omit children but continue walking siblings */
2531#define WRC_Abort 2 /* Abandon the tree walk */
drh7d10d5a2008-08-20 16:35:10 +00002532
2533/*
drh66150952007-07-23 19:12:41 +00002534** Assuming zIn points to the first byte of a UTF-8 character,
2535** advance zIn to point to the first byte of the next UTF-8 character.
drh4a919112007-05-15 11:55:09 +00002536*/
drh4a919112007-05-15 11:55:09 +00002537#define SQLITE_SKIP_UTF8(zIn) { \
2538 if( (*(zIn++))>=0xc0 ){ \
2539 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
2540 } \
2541}
2542
drh4a919112007-05-15 11:55:09 +00002543/*
drh9978c972010-02-23 17:36:32 +00002544** The SQLITE_*_BKPT macros are substitutes for the error codes with
2545** the same name but without the _BKPT suffix. These macros invoke
2546** routines that report the line-number on which the error originated
2547** using sqlite3_log(). The routines also provide a convenient place
2548** to set a debugger breakpoint.
drh49285702005-09-17 15:20:26 +00002549*/
drh9978c972010-02-23 17:36:32 +00002550int sqlite3CorruptError(int);
2551int sqlite3MisuseError(int);
2552int sqlite3CantopenError(int);
2553#define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
2554#define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
2555#define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
2556
drh49285702005-09-17 15:20:26 +00002557
2558/*
drhb4a1fed2010-02-03 19:55:13 +00002559** FTS4 is really an extension for FTS3. It is enabled using the
2560** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also all
2561** the SQLITE_ENABLE_FTS4 macro to serve as an alisse for SQLITE_ENABLE_FTS3.
2562*/
2563#if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
2564# define SQLITE_ENABLE_FTS3
2565#endif
2566
2567/*
drh79f02ce2009-05-07 14:11:52 +00002568** The ctype.h header is needed for non-ASCII systems. It is also
2569** needed by FTS3 when FTS3 is included in the amalgamation.
2570*/
2571#if !defined(SQLITE_ASCII) || \
2572 (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
2573# include <ctype.h>
2574#endif
2575
2576/*
danielk197778ca0e72009-01-20 16:53:39 +00002577** The following macros mimic the standard library functions toupper(),
2578** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
2579** sqlite versions only work for ASCII characters, regardless of locale.
2580*/
2581#ifdef SQLITE_ASCII
2582# define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
2583# define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
drhdc86e2b2009-01-24 11:30:42 +00002584# define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
2585# define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
danielk197778ca0e72009-01-20 16:53:39 +00002586# define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
2587# define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
2588# define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)])
2589#else
danielk197778ca0e72009-01-20 16:53:39 +00002590# define sqlite3Toupper(x) toupper((unsigned char)(x))
2591# define sqlite3Isspace(x) isspace((unsigned char)(x))
2592# define sqlite3Isalnum(x) isalnum((unsigned char)(x))
drhdc86e2b2009-01-24 11:30:42 +00002593# define sqlite3Isalpha(x) isalpha((unsigned char)(x))
danielk197778ca0e72009-01-20 16:53:39 +00002594# define sqlite3Isdigit(x) isdigit((unsigned char)(x))
2595# define sqlite3Isxdigit(x) isxdigit((unsigned char)(x))
2596# define sqlite3Tolower(x) tolower((unsigned char)(x))
2597#endif
2598
2599/*
drh75897232000-05-29 14:26:00 +00002600** Internal function prototypes
2601*/
drh3fa97302012-02-22 16:58:36 +00002602#define sqlite3StrICmp sqlite3_stricmp
drhea678832008-12-10 19:26:22 +00002603int sqlite3Strlen30(const char*);
danielk1977ee0484c2009-07-28 16:44:26 +00002604#define sqlite3StrNICmp sqlite3_strnicmp
danielk19772e588c72005-12-09 14:25:08 +00002605
drh40257ff2008-06-13 18:24:27 +00002606int sqlite3MallocInit(void);
drhfec00ea2008-06-14 16:56:21 +00002607void sqlite3MallocEnd(void);
2608void *sqlite3Malloc(int);
2609void *sqlite3MallocZero(int);
2610void *sqlite3DbMallocZero(sqlite3*, int);
2611void *sqlite3DbMallocRaw(sqlite3*, int);
drh17435752007-08-16 04:30:38 +00002612char *sqlite3DbStrDup(sqlite3*,const char*);
2613char *sqlite3DbStrNDup(sqlite3*,const char*, int);
drhfec00ea2008-06-14 16:56:21 +00002614void *sqlite3Realloc(void*, int);
drh97c8ec32007-08-27 21:49:34 +00002615void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
danielk1977a1644fd2007-08-29 12:31:25 +00002616void *sqlite3DbRealloc(sqlite3 *, void *, int);
drh633e6d52008-07-28 19:34:53 +00002617void sqlite3DbFree(sqlite3*, void*);
2618int sqlite3MallocSize(void*);
2619int sqlite3DbMallocSize(sqlite3*, void*);
drhfacf0302008-06-17 15:12:00 +00002620void *sqlite3ScratchMalloc(int);
2621void sqlite3ScratchFree(void*);
2622void *sqlite3PageMalloc(int);
2623void sqlite3PageFree(void*);
drhfec00ea2008-06-14 16:56:21 +00002624void sqlite3MemSetDefault(void);
danielk1977171bfed2008-06-23 09:50:50 +00002625void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
drh50d1b5f2010-08-27 12:21:06 +00002626int sqlite3HeapNearlyFull(void);
danielk19772e588c72005-12-09 14:25:08 +00002627
drhe7b347072009-06-01 18:18:20 +00002628/*
2629** On systems with ample stack space and that support alloca(), make
2630** use of alloca() to obtain space for large automatic objects. By default,
2631** obtain space from malloc().
2632**
2633** The alloca() routine never returns NULL. This will cause code paths
2634** that deal with sqlite3StackAlloc() failures to be unreachable.
2635*/
2636#ifdef SQLITE_USE_ALLOCA
2637# define sqlite3StackAllocRaw(D,N) alloca(N)
2638# define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N)
2639# define sqlite3StackFree(D,P)
2640#else
2641# define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N)
2642# define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N)
2643# define sqlite3StackFree(D,P) sqlite3DbFree(D,P)
2644#endif
2645
danielk1977f3d3c272008-11-19 16:52:44 +00002646#ifdef SQLITE_ENABLE_MEMSYS3
2647const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
2648#endif
2649#ifdef SQLITE_ENABLE_MEMSYS5
2650const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
2651#endif
2652
2653
drh18472fa2008-10-07 15:25:48 +00002654#ifndef SQLITE_MUTEX_OMIT
dan558814f2010-06-02 05:53:53 +00002655 sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
2656 sqlite3_mutex_methods const *sqlite3NoopMutex(void);
drh65bbf292008-06-19 01:03:17 +00002657 sqlite3_mutex *sqlite3MutexAlloc(int);
2658 int sqlite3MutexInit(void);
2659 int sqlite3MutexEnd(void);
2660#endif
danielk19776d2ab0e2008-06-17 17:21:18 +00002661
drhf7141992008-06-19 00:16:08 +00002662int sqlite3StatusValue(int);
2663void sqlite3StatusAdd(int, int);
2664void sqlite3StatusSet(int, int);
2665
drh85c8f292010-01-13 17:39:53 +00002666#ifndef SQLITE_OMIT_FLOATING_POINT
2667 int sqlite3IsNaN(double);
2668#else
2669# define sqlite3IsNaN(X) 0
2670#endif
drh0de3ae92008-04-28 16:55:26 +00002671
drhf089aa42008-07-08 19:34:06 +00002672void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
drhc7bc4fd2009-11-25 18:03:42 +00002673#ifndef SQLITE_OMIT_TRACE
2674void sqlite3XPrintf(StrAccum*, const char*, ...);
2675#endif
drh17435752007-08-16 04:30:38 +00002676char *sqlite3MPrintf(sqlite3*,const char*, ...);
2677char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
drh633e6d52008-07-28 19:34:53 +00002678char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
drh87cc3b32007-05-08 21:45:27 +00002679#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
2680 void sqlite3DebugPrintf(const char*, ...);
drhd919fe12007-12-11 19:34:44 +00002681#endif
2682#if defined(SQLITE_TEST)
drhe8f52c52008-07-12 14:52:20 +00002683 void *sqlite3TestTextToPtr(const char*);
drh87cc3b32007-05-08 21:45:27 +00002684#endif
drh7e02e5e2011-12-06 19:44:51 +00002685
2686/* Output formatting for SQLITE_TESTCTRL_EXPLAIN */
drh678a9aa2011-12-10 15:55:01 +00002687#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh7e02e5e2011-12-06 19:44:51 +00002688 void sqlite3ExplainBegin(Vdbe*);
2689 void sqlite3ExplainPrintf(Vdbe*, const char*, ...);
2690 void sqlite3ExplainNL(Vdbe*);
2691 void sqlite3ExplainPush(Vdbe*);
2692 void sqlite3ExplainPop(Vdbe*);
2693 void sqlite3ExplainFinish(Vdbe*);
2694 void sqlite3ExplainSelect(Vdbe*, Select*);
2695 void sqlite3ExplainExpr(Vdbe*, Expr*);
2696 void sqlite3ExplainExprList(Vdbe*, ExprList*);
2697 const char *sqlite3VdbeExplanation(Vdbe*);
2698#else
2699# define sqlite3ExplainBegin(X)
2700# define sqlite3ExplainSelect(A,B)
2701# define sqlite3ExplainExpr(A,B)
2702# define sqlite3ExplainExprList(A,B)
2703# define sqlite3ExplainFinish(X)
2704# define sqlite3VdbeExplanation(X) 0
2705#endif
2706
2707
drhf089aa42008-07-08 19:34:06 +00002708void sqlite3SetString(char **, sqlite3*, const char*, ...);
danielk19774adee202004-05-08 08:23:19 +00002709void sqlite3ErrorMsg(Parse*, const char*, ...);
drh24fb6272009-05-01 21:13:36 +00002710int sqlite3Dequote(char*);
drh2646da72005-12-09 20:02:05 +00002711int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00002712int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00002713void sqlite3FinishCoding(Parse*);
drh892d3172008-01-10 03:46:36 +00002714int sqlite3GetTempReg(Parse*);
2715void sqlite3ReleaseTempReg(Parse*,int);
2716int sqlite3GetTempRange(Parse*,int);
2717void sqlite3ReleaseTempRange(Parse*,int,int);
drhcdc69552011-12-06 13:24:59 +00002718void sqlite3ClearTempRegCache(Parse*);
drhb7916a72009-05-27 10:31:29 +00002719Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
2720Expr *sqlite3Expr(sqlite3*,int,const char*);
2721void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
drh17435752007-08-16 04:30:38 +00002722Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
danielk19771e536952007-08-16 10:09:01 +00002723Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
drh17435752007-08-16 04:30:38 +00002724Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00002725void sqlite3ExprAssignVarNumber(Parse*, Expr*);
drh633e6d52008-07-28 19:34:53 +00002726void sqlite3ExprDelete(sqlite3*, Expr*);
drhb7916a72009-05-27 10:31:29 +00002727ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
2728void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
2729void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*);
drh633e6d52008-07-28 19:34:53 +00002730void sqlite3ExprListDelete(sqlite3*, ExprList*);
drh9bb575f2004-09-06 17:24:11 +00002731int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00002732int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00002733void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh81028a42012-05-15 18:28:27 +00002734void sqlite3ResetAllSchemasOfConnection(sqlite3*);
2735void sqlite3ResetOneSchema(sqlite3*,int);
2736void sqlite3CollapseDatabaseArray(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00002737void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00002738void sqlite3CommitInternalChanges(sqlite3*);
drh7d10d5a2008-08-20 16:35:10 +00002739Table *sqlite3ResultSetOfSelect(Parse*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00002740void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00002741void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00002742void sqlite3AddColumn(Parse*,Token*);
2743void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00002744void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00002745void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00002746void sqlite3AddColumnType(Parse*,Token*);
drhb7916a72009-05-27 10:31:29 +00002747void sqlite3AddDefaultValue(Parse*,ExprSpan*);
danielk197739002502007-11-12 09:50:26 +00002748void sqlite3AddCollateType(Parse*, Token*);
danielk197719a8e7e2005-03-17 05:03:38 +00002749void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drh522c26f2011-05-07 14:40:29 +00002750int sqlite3ParseUri(const char*,const char*,unsigned int*,
2751 sqlite3_vfs**,char**,char **);
drh421377e2012-03-15 21:28:54 +00002752Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
dan1d8cb212011-12-09 13:24:16 +00002753int sqlite3CodeOnce(Parse *);
drhb7f91642004-10-31 02:22:47 +00002754
drhf5e7bb52008-02-18 14:47:33 +00002755Bitvec *sqlite3BitvecCreate(u32);
2756int sqlite3BitvecTest(Bitvec*, u32);
2757int sqlite3BitvecSet(Bitvec*, u32);
drhe98c9042009-06-02 21:31:38 +00002758void sqlite3BitvecClear(Bitvec*, u32, void*);
drhf5e7bb52008-02-18 14:47:33 +00002759void sqlite3BitvecDestroy(Bitvec*);
danielk1977bea2a942009-01-20 17:06:27 +00002760u32 sqlite3BitvecSize(Bitvec*);
drh3088d592008-03-21 16:45:47 +00002761int sqlite3BitvecBuiltinTest(int,int*);
drhf5e7bb52008-02-18 14:47:33 +00002762
drh3d4501e2008-12-04 20:40:10 +00002763RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
2764void sqlite3RowSetClear(RowSet*);
2765void sqlite3RowSetInsert(RowSet*, i64);
drh733bf1b2009-04-22 00:47:00 +00002766int sqlite3RowSetTest(RowSet*, u8 iBatch, i64);
drh3d4501e2008-12-04 20:40:10 +00002767int sqlite3RowSetNext(RowSet*, i64*);
2768
drhfdd48a72006-09-11 23:45:48 +00002769void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00002770
2771#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00002772 int sqlite3ViewGetColumnNames(Parse*,Table*);
2773#else
2774# define sqlite3ViewGetColumnNames(A,B) 0
2775#endif
2776
drha0733842005-12-29 01:11:36 +00002777void sqlite3DropTable(Parse*, SrcList*, int, int);
drhfaacf172011-08-12 01:51:45 +00002778void sqlite3CodeDropTable(Parse*, Table*, int, int);
dan1feeaed2010-07-23 15:41:47 +00002779void sqlite3DeleteTable(sqlite3*, Table*);
drh0b9f50d2009-06-23 20:28:53 +00002780#ifndef SQLITE_OMIT_AUTOINCREMENT
2781 void sqlite3AutoincrementBegin(Parse *pParse);
2782 void sqlite3AutoincrementEnd(Parse *pParse);
2783#else
2784# define sqlite3AutoincrementBegin(X)
2785# define sqlite3AutoincrementEnd(X)
2786#endif
drh5f085262012-09-15 13:29:23 +00002787int sqlite3CodeCoroutine(Parse*, Select*, SelectDest*);
danielk19774adee202004-05-08 08:23:19 +00002788void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh6c535152012-02-02 03:38:30 +00002789void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
drh17435752007-08-16 04:30:38 +00002790IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
danielk19774adee202004-05-08 08:23:19 +00002791int sqlite3IdListIndex(IdList*,const char*);
drha78c22c2008-11-11 18:28:58 +00002792SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
drh17435752007-08-16 04:30:38 +00002793SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
danielk1977b1c685b2008-10-06 16:18:39 +00002794SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
danielk197785574e32008-10-06 05:32:18 +00002795 Token*, Select*, Expr*, IdList*);
danielk1977b1c685b2008-10-06 16:18:39 +00002796void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
2797int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
drh61dfc312006-12-16 16:25:15 +00002798void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002799void sqlite3SrcListAssignCursors(Parse*, SrcList*);
drh633e6d52008-07-28 19:34:53 +00002800void sqlite3IdListDelete(sqlite3*, IdList*);
2801void sqlite3SrcListDelete(sqlite3*, SrcList*);
dan1da40a32009-09-19 17:00:31 +00002802Index *sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh8a9789b2013-08-01 03:36:59 +00002803 Expr*, int, int);
drh4d91a702006-01-04 15:54:36 +00002804void sqlite3DropIndex(Parse*, SrcList*, int);
drh7d10d5a2008-08-20 16:35:10 +00002805int sqlite3Select(Parse*, Select*, SelectDest*);
drh17435752007-08-16 04:30:38 +00002806Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
drh832ee3d2012-12-18 19:36:11 +00002807 Expr*,ExprList*,u16,Expr*,Expr*);
drh633e6d52008-07-28 19:34:53 +00002808void sqlite3SelectDelete(sqlite3*, Select*);
danielk19774adee202004-05-08 08:23:19 +00002809Table *sqlite3SrcListLookup(Parse*, SrcList*);
2810int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00002811void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
shane273f6192008-10-10 04:34:16 +00002812#if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
drh4bde3702013-02-19 18:34:12 +00002813Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*);
shane4281bd42008-10-07 05:27:11 +00002814#endif
danielk19774adee202004-05-08 08:23:19 +00002815void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
2816void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drh46ec5b62012-09-24 15:30:54 +00002817WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
danielk19774adee202004-05-08 08:23:19 +00002818void sqlite3WhereEnd(WhereInfo*);
drhc63367e2013-06-10 20:46:50 +00002819u64 sqlite3WhereOutputRowCount(WhereInfo*);
drh6f328482013-06-05 23:39:34 +00002820int sqlite3WhereIsDistinct(WhereInfo*);
2821int sqlite3WhereIsOrdered(WhereInfo*);
2822int sqlite3WhereContinueLabel(WhereInfo*);
2823int sqlite3WhereBreakLabel(WhereInfo*);
2824int sqlite3WhereOkOnePass(WhereInfo*);
drha748fdc2012-03-28 01:34:47 +00002825int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
drh5c092e82010-05-14 19:24:02 +00002826void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
drhb21e7c72008-06-22 12:37:57 +00002827void sqlite3ExprCodeMove(Parse*, int, int, int);
drhceea3322009-04-23 13:22:42 +00002828void sqlite3ExprCacheStore(Parse*, int, int, int);
2829void sqlite3ExprCachePush(Parse*);
2830void sqlite3ExprCachePop(Parse*, int);
drhf49f3522009-12-30 14:12:38 +00002831void sqlite3ExprCacheRemove(Parse*, int, int);
drhceea3322009-04-23 13:22:42 +00002832void sqlite3ExprCacheClear(Parse*);
drhda250ea2008-04-01 05:07:14 +00002833void sqlite3ExprCacheAffinityChange(Parse*, int, int);
drh389a1ad2008-01-03 23:44:53 +00002834int sqlite3ExprCode(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00002835int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
drh678ccce2008-03-31 18:19:54 +00002836int sqlite3ExprCodeTarget(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00002837int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
drh678ccce2008-03-31 18:19:54 +00002838void sqlite3ExprCodeConstants(Parse*, Expr*);
drh191b54c2008-04-15 12:14:21 +00002839int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
danielk19774adee202004-05-08 08:23:19 +00002840void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
2841void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh9bb575f2004-09-06 17:24:11 +00002842Table *sqlite3FindTable(sqlite3*,const char*, const char*);
drhca424112008-01-25 15:04:48 +00002843Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
dan41fb5cd2012-10-04 19:33:00 +00002844Table *sqlite3LocateTableItem(Parse*,int isView,struct SrcList_item *);
drh9bb575f2004-09-06 17:24:11 +00002845Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
2846void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
2847void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00002848void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00002849int sqlite3RunVacuum(char**, sqlite3*);
drh17435752007-08-16 04:30:38 +00002850char *sqlite3NameFromToken(sqlite3*, Token*);
drh619a1302013-08-01 13:04:46 +00002851int sqlite3ExprCompare(Expr*, Expr*, int);
2852int sqlite3ExprListCompare(ExprList*, ExprList*, int);
drh4bd5f732013-07-31 23:22:39 +00002853int sqlite3ExprImpliesExpr(Expr*, Expr*, int);
drhd2b3e232008-01-23 14:51:49 +00002854void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2855void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
drh030796d2012-08-23 16:18:10 +00002856int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002857Vdbe *sqlite3GetVdbe(Parse*);
drh2fa18682008-03-19 14:15:34 +00002858void sqlite3PrngSaveState(void);
2859void sqlite3PrngRestoreState(void);
2860void sqlite3PrngResetState(void);
drh0f198a72012-02-13 16:43:16 +00002861void sqlite3RollbackAll(sqlite3*,int);
danielk19774adee202004-05-08 08:23:19 +00002862void sqlite3CodeVerifySchema(Parse*, int);
dan57966752011-04-09 17:32:58 +00002863void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
drh684917c2004-10-05 02:41:42 +00002864void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00002865void sqlite3CommitTransaction(Parse*);
2866void sqlite3RollbackTransaction(Parse*);
danielk1977fd7f0452008-12-17 17:30:26 +00002867void sqlite3Savepoint(Parse*, int, Token*);
2868void sqlite3CloseSavepoints(sqlite3 *);
drh4245c402012-06-02 14:32:21 +00002869void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00002870int sqlite3ExprIsConstant(Expr*);
drh0a168372007-06-08 00:20:47 +00002871int sqlite3ExprIsConstantNotJoin(Expr*);
drheb55bd22005-06-30 17:04:21 +00002872int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00002873int sqlite3ExprIsInteger(Expr*, int*);
drh039fc322009-11-17 18:31:47 +00002874int sqlite3ExprCanBeNull(const Expr*);
drh2f2855b2009-11-18 01:25:26 +00002875void sqlite3ExprCodeIsNullJump(Vdbe*, const Expr*, int, int);
drh039fc322009-11-17 18:31:47 +00002876int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
danielk19774adee202004-05-08 08:23:19 +00002877int sqlite3IsRowid(const char*);
dan2283d462009-09-08 15:55:15 +00002878void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int, Trigger *, int);
drh2d401ab2008-01-10 23:50:11 +00002879void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
drhb2b9d3d2013-08-01 01:14:43 +00002880int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*);
drh04adf412008-01-08 18:57:50 +00002881void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
danielk1977de630352009-05-04 11:42:29 +00002882 int*,int,int,int,int,int*);
dan2832ad42009-08-31 15:27:27 +00002883void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*, int, int, int);
drhaa9b8962008-01-08 02:57:55 +00002884int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00002885void sqlite3BeginWriteOperation(Parse*, int, int);
drhff738bc2009-09-24 00:09:58 +00002886void sqlite3MultiWrite(Parse*);
2887void sqlite3MayAbort(Parse*);
drhd91c1a12013-02-09 13:58:25 +00002888void sqlite3HaltConstraint(Parse*, int, int, char*, int);
danielk19776ab3a2e2009-02-19 14:39:25 +00002889Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
danielk19776ab3a2e2009-02-19 14:39:25 +00002890ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
2891SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
drh17435752007-08-16 04:30:38 +00002892IdList *sqlite3IdListDup(sqlite3*,IdList*);
danielk19776ab3a2e2009-02-19 14:39:25 +00002893Select *sqlite3SelectDup(sqlite3*,Select*,int);
drh70a8ca32008-08-21 18:49:27 +00002894void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
drh89d5d6a2012-04-07 00:09:21 +00002895FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,u8);
drh9bb575f2004-09-06 17:24:11 +00002896void sqlite3RegisterBuiltinFunctions(sqlite3*);
drh777c5382008-08-21 20:21:34 +00002897void sqlite3RegisterDateTimeFunctions(void);
drh70a8ca32008-08-21 18:49:27 +00002898void sqlite3RegisterGlobalFunctions(void);
drh7e8b8482008-01-23 03:03:05 +00002899int sqlite3SafetyCheckOk(sqlite3*);
2900int sqlite3SafetyCheckSickOrOk(sqlite3*);
drh9cbf3422008-01-17 16:22:13 +00002901void sqlite3ChangeCookie(Parse*, int);
shanefa4e62f2008-09-01 21:59:42 +00002902
2903#if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
drh2a5d8252008-08-22 12:30:52 +00002904void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
shanefa4e62f2008-09-01 21:59:42 +00002905#endif
drhb7f91642004-10-31 02:22:47 +00002906
2907#ifndef SQLITE_OMIT_TRIGGER
2908 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00002909 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00002910 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00002911 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00002912 void sqlite3DropTriggerPtr(Parse*, Trigger*);
danielk19772f886d12009-02-28 10:47:41 +00002913 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
2914 Trigger *sqlite3TriggerList(Parse *, Table *);
dan165921a2009-08-28 18:53:45 +00002915 void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
dan94d7f502009-09-24 09:05:49 +00002916 int, int, int);
dan1da40a32009-09-19 17:00:31 +00002917 void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
drhb7f91642004-10-31 02:22:47 +00002918 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
drh633e6d52008-07-28 19:34:53 +00002919 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
drh17435752007-08-16 04:30:38 +00002920 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
2921 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
shane5eff7cf2009-08-10 03:57:58 +00002922 ExprList*,Select*,u8);
2923 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8);
drh17435752007-08-16 04:30:38 +00002924 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
drh633e6d52008-07-28 19:34:53 +00002925 void sqlite3DeleteTrigger(sqlite3*, Trigger*);
drhb7f91642004-10-31 02:22:47 +00002926 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
danbb5f1682009-11-27 12:12:34 +00002927 u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
dan65a7cd12009-09-01 12:16:01 +00002928# define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
drhb7f91642004-10-31 02:22:47 +00002929#else
danielk197762c14b32008-11-19 09:05:26 +00002930# define sqlite3TriggersExist(B,C,D,E,F) 0
drh633e6d52008-07-28 19:34:53 +00002931# define sqlite3DeleteTrigger(A,B)
drhcdd536f2006-03-17 00:04:03 +00002932# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00002933# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
dan94d7f502009-09-24 09:05:49 +00002934# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
dan75cbd982009-09-21 16:06:03 +00002935# define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
danielk19772943c372009-04-07 14:14:22 +00002936# define sqlite3TriggerList(X, Y) 0
dan65a7cd12009-09-01 12:16:01 +00002937# define sqlite3ParseToplevel(p) p
danbb5f1682009-11-27 12:12:34 +00002938# define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
drhb7f91642004-10-31 02:22:47 +00002939#endif
2940
danielk19774adee202004-05-08 08:23:19 +00002941int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00002942void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00002943void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00002944#ifndef SQLITE_OMIT_AUTHORIZATION
drh728b5772007-09-18 15:55:07 +00002945 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002946 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
2947 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
2948 void sqlite3AuthContextPop(AuthContext*);
dan02470b22009-10-03 07:04:11 +00002949 int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
drhed6c8672003-01-12 18:02:16 +00002950#else
danielk1977b5258c32007-10-04 18:11:15 +00002951# define sqlite3AuthRead(a,b,c,d)
danielk19774adee202004-05-08 08:23:19 +00002952# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
2953# define sqlite3AuthContextPush(a,b,c)
2954# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00002955#endif
danielk1977f744bb52005-12-06 17:19:11 +00002956void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2957void sqlite3Detach(Parse*, Expr*);
drhd100f692013-10-03 15:39:44 +00002958void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
danielk19774adee202004-05-08 08:23:19 +00002959int sqlite3FixSrcList(DbFixer*, SrcList*);
2960int sqlite3FixSelect(DbFixer*, Select*);
2961int sqlite3FixExpr(DbFixer*, Expr*);
2962int sqlite3FixExprList(DbFixer*, ExprList*);
2963int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh9339da12010-09-30 00:50:49 +00002964int sqlite3AtoF(const char *z, double*, int, u8);
drhfec19aa2004-05-19 20:41:03 +00002965int sqlite3GetInt32(const char *, int*);
drh60ac3f42010-11-23 18:59:27 +00002966int sqlite3Atoi(const char*);
drhee858132007-05-08 20:37:38 +00002967int sqlite3Utf16ByteLen(const void *pData, int nChar);
2968int sqlite3Utf8CharLen(const char *pData, int nByte);
drh42610962012-09-17 18:56:32 +00002969u32 sqlite3Utf8Read(const u8**);
shane3f8d5cf2008-04-24 19:15:09 +00002970
2971/*
2972** Routines to read and write variable-length integers. These used to
2973** be defined locally, but now we use the varint routines in the util.c
shane952856a2008-04-28 17:41:30 +00002974** file. Code should use the MACRO forms below, as the Varint32 versions
2975** are coded to assume the single byte case is already handled (which
2976** the MACRO form does).
shane3f8d5cf2008-04-24 19:15:09 +00002977*/
drh35b5a332008-04-05 18:41:42 +00002978int sqlite3PutVarint(unsigned char*, u64);
2979int sqlite3PutVarint32(unsigned char*, u32);
drh1bd10f82008-12-10 21:19:56 +00002980u8 sqlite3GetVarint(const unsigned char *, u64 *);
2981u8 sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00002982int sqlite3VarintLen(u64 v);
shane3f8d5cf2008-04-24 19:15:09 +00002983
2984/*
2985** The header of a record consists of a sequence variable-length integers.
2986** These integers are almost always small and are encoded as a single byte.
2987** The following macros take advantage this fact to provide a fast encode
2988** and decode of the integers in a record header. It is faster for the common
2989** case where the integer is a single byte. It is a little slower when the
2990** integer is two or more bytes. But overall it is faster.
2991**
2992** The following expressions are equivalent:
2993**
2994** x = sqlite3GetVarint32( A, &B );
2995** x = sqlite3PutVarint32( A, B );
2996**
2997** x = getVarint32( A, B );
2998** x = putVarint32( A, B );
2999**
3000*/
drh4bde3702013-02-19 18:34:12 +00003001#define getVarint32(A,B) \
3002 (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
3003#define putVarint32(A,B) \
3004 (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
3005 sqlite3PutVarint32((A),(B)))
shane3f8d5cf2008-04-24 19:15:09 +00003006#define getVarint sqlite3GetVarint
3007#define putVarint sqlite3PutVarint
3008
3009
dan69f8bb92009-08-13 19:21:16 +00003010const char *sqlite3IndexAffinityStr(Vdbe *, Index *);
danielk1977a37cdde2004-05-16 11:15:36 +00003011void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00003012char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00003013int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00003014char sqlite3ExprAffinity(Expr *pExpr);
drh9339da12010-09-30 00:50:49 +00003015int sqlite3Atoi64(const char*, i64*, int, u8);
drh9bb575f2004-09-06 17:24:11 +00003016void sqlite3Error(sqlite3*, int, const char*,...);
drhca48c902008-01-18 14:08:24 +00003017void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
dancd74b612011-04-22 19:37:32 +00003018u8 sqlite3HexToInt(int h);
danielk1977ef2cb632004-05-29 02:37:19 +00003019int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
mistachkindd08ca02013-04-30 07:58:15 +00003020
3021#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST) || \
3022 defined(SQLITE_DEBUG_OS_TRACE)
mistachkinf2c1c992013-04-28 01:44:43 +00003023const char *sqlite3ErrName(int);
mistachkindd08ca02013-04-30 07:58:15 +00003024#endif
3025
danielk1977f20b21c2004-05-31 23:56:42 +00003026const char *sqlite3ErrStr(int);
danielk19778a414492004-06-29 08:59:35 +00003027int sqlite3ReadSchema(Parse *pParse);
drhc4a64fa2009-05-11 20:53:28 +00003028CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
3029CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
danielk19777cedc8d2004-06-10 10:50:08 +00003030CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh0a8a4062012-12-07 18:38:16 +00003031Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, Token*);
3032Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
3033Expr *sqlite3ExprSkipCollate(Expr*);
danielk19777cedc8d2004-06-10 10:50:08 +00003034int sqlite3CheckCollSeq(Parse *, CollSeq *);
danielk1977d8123362004-06-12 09:25:12 +00003035int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00003036void sqlite3VdbeSetChanges(sqlite3 *, int);
drh158b9cb2011-03-05 20:59:46 +00003037int sqlite3AddInt64(i64*,i64);
3038int sqlite3SubInt64(i64*,i64);
3039int sqlite3MulInt64(i64*,i64);
drhd50ffc42011-03-08 02:38:28 +00003040int sqlite3AbsInt32(int);
drh81cc5162011-05-17 20:36:21 +00003041#ifdef SQLITE_ENABLE_8_3_NAMES
3042void sqlite3FileSuffix3(const char*, char*);
3043#else
3044# define sqlite3FileSuffix3(X,Y)
3045#endif
drh38d9c612012-01-31 14:24:47 +00003046u8 sqlite3GetBoolean(const char *z,int);
danielk19774e6af132004-06-10 14:01:08 +00003047
drhb21c8cd2007-08-21 19:33:56 +00003048const void *sqlite3ValueText(sqlite3_value*, u8);
3049int sqlite3ValueBytes(sqlite3_value*, u8);
3050void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
danielk19771e536952007-08-16 10:09:01 +00003051 void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00003052void sqlite3ValueFree(sqlite3_value*);
danielk19771e536952007-08-16 10:09:01 +00003053sqlite3_value *sqlite3ValueNew(sqlite3 *);
danb7dca7d2010-03-05 16:32:12 +00003054char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
danielk19771e536952007-08-16 10:09:01 +00003055int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
drhb21c8cd2007-08-21 19:33:56 +00003056void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh46c99e02007-08-27 23:26:59 +00003057#ifndef SQLITE_AMALGAMATION
drha6c2ed92009-11-14 23:22:23 +00003058extern const unsigned char sqlite3OpcodeProperty[];
drh4e5ffc52004-08-31 00:52:37 +00003059extern const unsigned char sqlite3UpperToLower[];
danielk197778ca0e72009-01-20 16:53:39 +00003060extern const unsigned char sqlite3CtypeMap[];
drh094430e2010-07-14 18:24:06 +00003061extern const Token sqlite3IntTokens[];
danielk1977075c23a2008-09-01 18:34:20 +00003062extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
3063extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions;
drhf83dc1e2010-06-03 12:09:52 +00003064#ifndef SQLITE_OMIT_WSD
drhddb68e12009-02-05 16:53:43 +00003065extern int sqlite3PendingByte;
drh46c99e02007-08-27 23:26:59 +00003066#endif
drhf83dc1e2010-06-03 12:09:52 +00003067#endif
drhcdf011d2011-04-04 21:25:28 +00003068void sqlite3RootPageMoved(sqlite3*, int, int, int);
drh4343fea2004-11-05 23:46:15 +00003069void sqlite3Reindex(Parse*, Token*, Token*);
drh545f5872010-04-24 14:02:59 +00003070void sqlite3AlterFunctions(void);
danielk19779fd2a9a2004-11-12 13:42:30 +00003071void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
3072int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00003073void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00003074void sqlite3ExpirePreparedStatements(sqlite3*);
drh1450bc62009-10-30 13:25:56 +00003075int sqlite3CodeSubselect(Parse *, Expr *, int, int);
drh7d10d5a2008-08-20 16:35:10 +00003076void sqlite3SelectPrep(Parse*, Select*, NameContext*);
drh3e3f1a52013-01-03 00:45:56 +00003077int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
drh7d10d5a2008-08-20 16:35:10 +00003078int sqlite3ResolveExprNames(NameContext*, Expr*);
drh7d10d5a2008-08-20 16:35:10 +00003079void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
drh3780be12013-07-31 19:05:22 +00003080void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
drh7d10d5a2008-08-20 16:35:10 +00003081int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
danielk1977c7538b52009-07-27 10:05:04 +00003082void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
danielk197719a8e7e2005-03-17 05:03:38 +00003083void sqlite3AlterFinishAddColumn(Parse *, Token *);
3084void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
drh79e72a52012-10-05 14:43:40 +00003085CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
drhfdaac672013-10-04 15:30:21 +00003086char sqlite3AffinityType(const char*, u8*);
drh9f18e8a2005-07-08 12:13:04 +00003087void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00003088int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00003089int sqlite3FindDb(sqlite3*, Token*);
danielk197704103022009-02-03 16:51:24 +00003090int sqlite3FindDbName(sqlite3 *, const char *);
drhcf1be452007-05-12 12:08:51 +00003091int sqlite3AnalysisLoad(sqlite3*,int iDB);
dand46def72010-07-24 11:28:28 +00003092void sqlite3DeleteIndexSamples(sqlite3*,Index*);
drh51147ba2005-07-23 22:59:55 +00003093void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00003094void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00003095int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
drhfdd6e852005-12-16 01:06:16 +00003096void sqlite3MinimumFileFormat(Parse*, int, int);
drhb6ee6602011-04-04 13:40:53 +00003097void sqlite3SchemaClear(void *);
danielk19771e536952007-08-16 10:09:01 +00003098Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
danielk1977e501b892006-01-09 06:29:47 +00003099int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
drh323df792013-08-05 19:11:29 +00003100KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int);
danielk1977b3bf5562006-01-10 17:58:23 +00003101KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00003102int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
3103 void (*)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00003104 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
3105 FuncDestructor *pDestructor
3106);
danielk197754f01982006-01-18 15:25:17 +00003107int sqlite3ApiExit(sqlite3 *db, int);
danielk1977ddfb2f02006-02-17 12:25:14 +00003108int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00003109
drhf089aa42008-07-08 19:34:06 +00003110void sqlite3StrAccumInit(StrAccum*, char*, int, int);
drhade86482007-11-28 22:36:40 +00003111void sqlite3StrAccumAppend(StrAccum*,const char*,int);
drh7e02e5e2011-12-06 19:44:51 +00003112void sqlite3AppendSpace(StrAccum*,int);
drhade86482007-11-28 22:36:40 +00003113char *sqlite3StrAccumFinish(StrAccum*);
3114void sqlite3StrAccumReset(StrAccum*);
drh1013c932008-01-06 00:25:21 +00003115void sqlite3SelectDestInit(SelectDest*,int,int);
danf7b0b0a2009-10-19 15:52:32 +00003116Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
danielk19771e536952007-08-16 10:09:01 +00003117
danielk197704103022009-02-03 16:51:24 +00003118void sqlite3BackupRestart(sqlite3_backup *);
3119void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
3120
drh1435a9a2013-08-27 23:15:44 +00003121#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00003122void sqlite3AnalyzeFunctions(void);
dan87cd9322013-08-07 15:52:41 +00003123int sqlite3Stat4ProbeSetValue(Parse*,Index*,UnpackedRecord**,Expr*,u8,int,int*);
dan7a419232013-08-06 20:01:43 +00003124void sqlite3Stat4ProbeFree(UnpackedRecord*);
drh9fecc542013-08-27 20:16:48 +00003125#endif
dan7a419232013-08-06 20:01:43 +00003126
drh95bdbbb2007-07-23 19:31:16 +00003127/*
3128** The interface to the LEMON-generated parser
3129*/
3130void *sqlite3ParserAlloc(void*(*)(size_t));
3131void sqlite3ParserFree(void*, void(*)(void*));
3132void sqlite3Parser(void*, int, Token, Parse*);
drhec424a52008-07-25 15:39:03 +00003133#ifdef YYTRACKMAXSTACKDEPTH
3134 int sqlite3ParserStackPeak(void*);
3135#endif
drh95bdbbb2007-07-23 19:31:16 +00003136
drh7aaa8782009-05-20 02:40:45 +00003137void sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00003138#ifndef SQLITE_OMIT_LOAD_EXTENSION
3139 void sqlite3CloseExtensions(sqlite3*);
3140#else
3141# define sqlite3CloseExtensions(X)
3142#endif
danielk1977e3026632004-06-22 11:29:02 +00003143
danielk1977c00da102006-01-07 13:21:04 +00003144#ifndef SQLITE_OMIT_SHARED_CACHE
3145 void sqlite3TableLock(Parse *, int, int, u8, const char *);
3146#else
3147 #define sqlite3TableLock(v,w,x,y,z)
3148#endif
3149
drh53c14022007-05-10 17:23:11 +00003150#ifdef SQLITE_TEST
3151 int sqlite3Utf8To8(unsigned char*);
3152#endif
3153
drhb9bb7c12006-06-11 23:41:55 +00003154#ifdef SQLITE_OMIT_VIRTUALTABLE
danielk1977595a5232009-07-24 17:58:53 +00003155# define sqlite3VtabClear(Y)
danielk19779dbee7d2008-08-02 15:32:39 +00003156# define sqlite3VtabSync(X,Y) SQLITE_OK
danielk1977f9e7dda2006-06-16 16:08:53 +00003157# define sqlite3VtabRollback(X)
3158# define sqlite3VtabCommit(X)
danielk1977093e0f62008-11-13 18:00:14 +00003159# define sqlite3VtabInSync(db) 0
danielk1977595a5232009-07-24 17:58:53 +00003160# define sqlite3VtabLock(X)
3161# define sqlite3VtabUnlock(X)
3162# define sqlite3VtabUnlockList(X)
dana311b802011-04-26 19:21:34 +00003163# define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
drhc3c8dac2011-10-12 19:04:07 +00003164# define sqlite3GetVTable(X,Y) ((VTable*)0)
drhb9bb7c12006-06-11 23:41:55 +00003165#else
dan1feeaed2010-07-23 15:41:47 +00003166 void sqlite3VtabClear(sqlite3 *db, Table*);
danbba02a92012-05-15 17:15:34 +00003167 void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
dan016f7812013-08-21 17:35:48 +00003168 int sqlite3VtabSync(sqlite3 *db, Vdbe*);
danielk1977f9e7dda2006-06-16 16:08:53 +00003169 int sqlite3VtabRollback(sqlite3 *db);
3170 int sqlite3VtabCommit(sqlite3 *db);
danielk1977595a5232009-07-24 17:58:53 +00003171 void sqlite3VtabLock(VTable *);
3172 void sqlite3VtabUnlock(VTable *);
3173 void sqlite3VtabUnlockList(sqlite3*);
dana311b802011-04-26 19:21:34 +00003174 int sqlite3VtabSavepoint(sqlite3 *, int, int);
dan016f7812013-08-21 17:35:48 +00003175 void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
drhc3c8dac2011-10-12 19:04:07 +00003176 VTable *sqlite3GetVTable(sqlite3*, Table*);
danielk1977093e0f62008-11-13 18:00:14 +00003177# define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
drhb9bb7c12006-06-11 23:41:55 +00003178#endif
drh4f3dd152008-04-28 18:46:43 +00003179void sqlite3VtabMakeWritable(Parse*,Table*);
drhb421b892012-01-28 19:41:53 +00003180void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
drhb9bb7c12006-06-11 23:41:55 +00003181void sqlite3VtabFinishParse(Parse*, Token*);
3182void sqlite3VtabArgInit(Parse*);
3183void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00003184int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00003185int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00003186int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977595a5232009-07-24 17:58:53 +00003187int sqlite3VtabBegin(sqlite3 *, VTable *);
danielk19771e536952007-08-16 10:09:01 +00003188FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00003189void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
drh95a7b3e2013-09-16 12:57:19 +00003190sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
drh5f18a222009-11-26 14:01:53 +00003191int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
shane4a27a282008-09-04 04:32:49 +00003192int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
drhb900aaf2006-11-09 00:24:53 +00003193int sqlite3Reprepare(Vdbe*);
drhb1a6c3c2008-03-20 16:30:17 +00003194void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
drh0a0e1312007-08-07 17:04:59 +00003195CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
drh1c514142009-04-30 12:25:10 +00003196int sqlite3TempInMemory(const sqlite3*);
dan28e53862010-04-21 06:19:12 +00003197const char *sqlite3JournalModename(int);
dan06a2d822012-10-10 09:46:29 +00003198#ifndef SQLITE_OMIT_WAL
3199 int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
3200 int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
3201#endif
danielk1977d8293352009-04-30 09:10:37 +00003202
dan75cbd982009-09-21 16:06:03 +00003203/* Declarations for functions in fkey.c. All of these are replaced by
3204** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
3205** key functionality is available. If OMIT_TRIGGER is defined but
3206** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
3207** this case foreign keys are parsed, but no other functionality is
3208** provided (enforcement of FK constraints requires the triggers sub-system).
3209*/
3210#if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
dan8ff2d952013-09-05 18:40:29 +00003211 void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
dand66c8302009-09-28 14:49:01 +00003212 void sqlite3FkDropTable(Parse*, SrcList *, Table*);
dan8ff2d952013-09-05 18:40:29 +00003213 void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
dane7a94d82009-10-01 16:09:04 +00003214 int sqlite3FkRequired(Parse*, Table*, int*, int);
3215 u32 sqlite3FkOldmask(Parse*, Table*);
dan432cc5b2009-09-26 17:51:48 +00003216 FKey *sqlite3FkReferences(Table *);
dan1da40a32009-09-19 17:00:31 +00003217#else
dan8ff2d952013-09-05 18:40:29 +00003218 #define sqlite3FkActions(a,b,c,d,e,f)
dane7a94d82009-10-01 16:09:04 +00003219 #define sqlite3FkCheck(a,b,c,d)
dand66c8302009-09-28 14:49:01 +00003220 #define sqlite3FkDropTable(a,b,c)
dan8ff2d952013-09-05 18:40:29 +00003221 #define sqlite3FkOldmask(a,b) 0
3222 #define sqlite3FkRequired(a,b,c,d,e,f) 0
dan1da40a32009-09-19 17:00:31 +00003223#endif
dan75cbd982009-09-21 16:06:03 +00003224#ifndef SQLITE_OMIT_FOREIGN_KEY
dan1feeaed2010-07-23 15:41:47 +00003225 void sqlite3FkDelete(sqlite3 *, Table*);
drh6c5b9152012-12-17 16:46:37 +00003226 int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
dan75cbd982009-09-21 16:06:03 +00003227#else
dan1feeaed2010-07-23 15:41:47 +00003228 #define sqlite3FkDelete(a,b)
drh6c5b9152012-12-17 16:46:37 +00003229 #define sqlite3FkLocateIndex(a,b,c,d,e)
dan75cbd982009-09-21 16:06:03 +00003230#endif
3231
drh643167f2008-01-22 21:30:53 +00003232
3233/*
3234** Available fault injectors. Should be numbered beginning with 0.
3235*/
3236#define SQLITE_FAULTINJECTOR_MALLOC 0
drh7e8b8482008-01-23 03:03:05 +00003237#define SQLITE_FAULTINJECTOR_COUNT 1
drh643167f2008-01-22 21:30:53 +00003238
3239/*
danielk1977ef05f2d2008-06-20 11:05:37 +00003240** The interface to the code in fault.c used for identifying "benign"
3241** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
3242** is not defined.
drh643167f2008-01-22 21:30:53 +00003243*/
drh3088d592008-03-21 16:45:47 +00003244#ifndef SQLITE_OMIT_BUILTIN_TEST
danielk19772d1d86f2008-06-20 14:59:51 +00003245 void sqlite3BeginBenignMalloc(void);
3246 void sqlite3EndBenignMalloc(void);
drh643167f2008-01-22 21:30:53 +00003247#else
danielk19772d1d86f2008-06-20 14:59:51 +00003248 #define sqlite3BeginBenignMalloc()
danielk1977867d05a2008-06-23 14:03:45 +00003249 #define sqlite3EndBenignMalloc()
drh643167f2008-01-22 21:30:53 +00003250#endif
drh643167f2008-01-22 21:30:53 +00003251
danielk19779a96b662007-11-29 17:05:18 +00003252#define IN_INDEX_ROWID 1
3253#define IN_INDEX_EPH 2
drh1ccce442013-03-12 20:38:51 +00003254#define IN_INDEX_INDEX_ASC 3
3255#define IN_INDEX_INDEX_DESC 4
danielk19770cdc0222008-06-26 18:04:03 +00003256int sqlite3FindInIndex(Parse *, Expr *, int*);
danielk19779a96b662007-11-29 17:05:18 +00003257
danielk1977c7b60172007-08-22 11:22:03 +00003258#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3259 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
3260 int sqlite3JournalSize(sqlite3_vfs *);
danielk1977f55b8992007-08-24 08:15:53 +00003261 int sqlite3JournalCreate(sqlite3_file *);
dan3de0f182012-12-05 10:01:35 +00003262 int sqlite3JournalExists(sqlite3_file *p);
danielk1977c7b60172007-08-22 11:22:03 +00003263#else
3264 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
dan3de0f182012-12-05 10:01:35 +00003265 #define sqlite3JournalExists(p) 1
danielk1977c7b60172007-08-22 11:22:03 +00003266#endif
3267
danielk1977b3175382008-10-17 18:51:52 +00003268void sqlite3MemJournalOpen(sqlite3_file *);
drh3a5990a2008-12-20 02:14:39 +00003269int sqlite3MemJournalSize(void);
danielk1977b3175382008-10-17 18:51:52 +00003270int sqlite3IsMemJournal(sqlite3_file *);
3271
drh0224d262008-05-28 13:49:34 +00003272#if SQLITE_MAX_EXPR_DEPTH>0
danielk19774b5255a2008-06-05 16:47:39 +00003273 void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
danielk1977fc976062007-05-10 10:46:56 +00003274 int sqlite3SelectExprHeight(Select *);
drh7d10d5a2008-08-20 16:35:10 +00003275 int sqlite3ExprCheckHeight(Parse*, int);
danielk1977fc976062007-05-10 10:46:56 +00003276#else
danielk19774b5255a2008-06-05 16:47:39 +00003277 #define sqlite3ExprSetHeight(x,y)
drh0224d262008-05-28 13:49:34 +00003278 #define sqlite3SelectExprHeight(x) 0
drh7d10d5a2008-08-20 16:35:10 +00003279 #define sqlite3ExprCheckHeight(x,y)
danielk1977fc976062007-05-10 10:46:56 +00003280#endif
3281
drha3152892007-05-05 11:48:52 +00003282u32 sqlite3Get4byte(const u8*);
drha3152892007-05-05 11:48:52 +00003283void sqlite3Put4byte(u8*, u32);
3284
danielk1977404ca072009-03-16 13:19:36 +00003285#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
3286 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
3287 void sqlite3ConnectionUnlocked(sqlite3 *db);
3288 void sqlite3ConnectionClosed(sqlite3 *db);
3289#else
3290 #define sqlite3ConnectionBlocked(x,y)
3291 #define sqlite3ConnectionUnlocked(x)
3292 #define sqlite3ConnectionClosed(x)
3293#endif
3294
drh6e736832007-05-11 12:30:03 +00003295#ifdef SQLITE_DEBUG
3296 void sqlite3ParserTrace(FILE*, char *);
3297#endif
3298
drhb0603412007-02-28 04:47:26 +00003299/*
3300** If the SQLITE_ENABLE IOTRACE exists then the global variable
mlcreech3a00f902008-03-04 17:45:01 +00003301** sqlite3IoTrace is a pointer to a printf-like routine used to
drhb0603412007-02-28 04:47:26 +00003302** print I/O tracing messages.
3303*/
3304#ifdef SQLITE_ENABLE_IOTRACE
mlcreech3a00f902008-03-04 17:45:01 +00003305# define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
danielk1977b4622b62007-03-02 06:24:19 +00003306 void sqlite3VdbeIOTraceSql(Vdbe*);
drhe265b082008-05-01 17:03:49 +00003307SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
drhb0603412007-02-28 04:47:26 +00003308#else
3309# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00003310# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00003311#endif
drhb0603412007-02-28 04:47:26 +00003312
drh107b56e2010-03-12 16:32:53 +00003313/*
3314** These routines are available for the mem2.c debugging memory allocator
3315** only. They are used to verify that different "types" of memory
3316** allocations are properly tracked by the system.
3317**
3318** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
3319** the MEMTYPE_* macros defined below. The type must be a bitmask with
3320** a single bit set.
3321**
3322** sqlite3MemdebugHasType() returns true if any of the bits in its second
3323** argument match the type set by the previous sqlite3MemdebugSetType().
3324** sqlite3MemdebugHasType() is intended for use inside assert() statements.
drh107b56e2010-03-12 16:32:53 +00003325**
drh174b9a12010-07-26 11:07:20 +00003326** sqlite3MemdebugNoType() returns true if none of the bits in its second
3327** argument match the type set by the previous sqlite3MemdebugSetType().
drh107b56e2010-03-12 16:32:53 +00003328**
3329** Perhaps the most important point is the difference between MEMTYPE_HEAP
drh174b9a12010-07-26 11:07:20 +00003330** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means
3331** it might have been allocated by lookaside, except the allocation was
3332** too large or lookaside was already full. It is important to verify
3333** that allocations that might have been satisfied by lookaside are not
3334** passed back to non-lookaside free() routines. Asserts such as the
3335** example above are placed on the non-lookaside free() routines to verify
3336** this constraint.
drh107b56e2010-03-12 16:32:53 +00003337**
3338** All of this is no-op for a production build. It only comes into
3339** play when the SQLITE_MEMDEBUG compile-time option is used.
3340*/
3341#ifdef SQLITE_MEMDEBUG
3342 void sqlite3MemdebugSetType(void*,u8);
3343 int sqlite3MemdebugHasType(void*,u8);
drh174b9a12010-07-26 11:07:20 +00003344 int sqlite3MemdebugNoType(void*,u8);
drh107b56e2010-03-12 16:32:53 +00003345#else
3346# define sqlite3MemdebugSetType(X,Y) /* no-op */
3347# define sqlite3MemdebugHasType(X,Y) 1
drh174b9a12010-07-26 11:07:20 +00003348# define sqlite3MemdebugNoType(X,Y) 1
danielk1977e3026632004-06-22 11:29:02 +00003349#endif
drh174b9a12010-07-26 11:07:20 +00003350#define MEMTYPE_HEAP 0x01 /* General heap allocations */
3351#define MEMTYPE_LOOKASIDE 0x02 /* Might have been lookaside memory */
3352#define MEMTYPE_SCRATCH 0x04 /* Scratch allocations */
3353#define MEMTYPE_PCACHE 0x08 /* Page cache allocations */
3354#define MEMTYPE_DB 0x10 /* Uses sqlite3DbMalloc, not sqlite_malloc */
drh107b56e2010-03-12 16:32:53 +00003355
3356#endif /* _SQLITEINT_H_ */