blob: f2833180da389b9103688ee2a2fb105e3eb29b8e [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**
danielk1977bd434552009-03-18 10:33:00 +000014** @(#) $Id: sqliteInt.h,v 1.843 2009/03/18 10:33:01 danielk1977 Exp $
drh75897232000-05-29 14:26:00 +000015*/
danielk1977e3026632004-06-22 11:29:02 +000016#ifndef _SQLITEINT_H_
17#define _SQLITEINT_H_
drh71674ce2007-10-23 15:51:26 +000018
mlcreechbd0ae112008-03-06 09:16:24 +000019/*
mlcreech1e12d432008-05-07 02:42:01 +000020** Include the configuration header output by 'configure' if we're using the
21** autoconf-based build
mlcreechbd0ae112008-03-06 09:16:24 +000022*/
mlcreech1e12d432008-05-07 02:42:01 +000023#ifdef _HAVE_SQLITE_CONFIG_H
mlcreech98dc4b12008-03-06 16:28:58 +000024#include "config.h"
mlcreech1e12d432008-05-07 02:42:01 +000025#endif
26
drhbb4957f2008-03-20 14:03:29 +000027#include "sqliteLimit.h"
mlcreech98dc4b12008-03-06 16:28:58 +000028
drhe2965822008-04-10 16:47:41 +000029/* Disable nuisance warnings on Borland compilers */
30#if defined(__BORLANDC__)
31#pragma warn -rch /* unreachable code */
32#pragma warn -ccc /* Condition is always true or false */
33#pragma warn -aus /* Assigned value is never used */
34#pragma warn -csu /* Comparing signed and unsigned */
shane467bcf32008-11-24 20:01:32 +000035#pragma warn -spa /* Suspicious pointer arithmetic */
drhe2965822008-04-10 16:47:41 +000036#endif
37
mlcreech98dc4b12008-03-06 16:28:58 +000038/* Needed for various definitions... */
drh60323412008-07-31 17:35:45 +000039#ifndef _GNU_SOURCE
40# define _GNU_SOURCE
41#endif
mlcreech98dc4b12008-03-06 16:28:58 +000042
43/*
drh06af7632008-04-28 12:54:15 +000044** Include standard header files as necessary
45*/
46#ifdef HAVE_STDINT_H
47#include <stdint.h>
48#endif
49#ifdef HAVE_INTTYPES_H
50#include <inttypes.h>
51#endif
52
53/*
shane1fc41292008-07-08 22:28:48 +000054 * This macro is used to "hide" some ugliness in casting an int
55 * value to a ptr value under the MSVC 64-bit compiler. Casting
56 * non 64-bit values to ptr types results in a "hard" error with
57 * the MSVC 64-bit compiler which this attempts to avoid.
58 *
59 * A simple compiler pragma or casting sequence could not be found
60 * to correct this in all situations, so this macro was introduced.
61 *
62 * It could be argued that the intptr_t type could be used in this
63 * case, but that type is not available on all compilers, or
64 * requires the #include of specific headers which differs between
65 * platforms.
66 */
67#define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
68#define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
drhb6dbc002007-11-27 02:38:00 +000069
70/*
shane467bcf32008-11-24 20:01:32 +000071** These #defines should enable >2GB file support on POSIX if the
drh71674ce2007-10-23 15:51:26 +000072** underlying operating system supports it. If the OS lacks
73** large file support, or if the OS is windows, these should be no-ops.
74**
75** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
76** system #includes. Hence, this block of code must be the very first
77** code in all source files.
78**
79** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
80** on the compiler command line. This is necessary if you are compiling
shane467bcf32008-11-24 20:01:32 +000081** on a recent machine (ex: Red Hat 7.2) but you want your code to work
82** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
drh71674ce2007-10-23 15:51:26 +000083** without this option, LFS is enable. But LFS does not exist in the kernel
shane467bcf32008-11-24 20:01:32 +000084** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
drh71674ce2007-10-23 15:51:26 +000085** portability you should omit LFS.
86**
shane467bcf32008-11-24 20:01:32 +000087** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
drh71674ce2007-10-23 15:51:26 +000088*/
89#ifndef SQLITE_DISABLE_LFS
90# define _LARGE_FILE 1
91# ifndef _FILE_OFFSET_BITS
92# define _FILE_OFFSET_BITS 64
93# endif
94# define _LARGEFILE_SOURCE 1
95#endif
96
97
drhe5e7a902007-10-01 17:47:00 +000098/*
99** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
100** Older versions of SQLite used an optional THREADSAFE macro.
101** We support that for legacy
102*/
103#if !defined(SQLITE_THREADSAFE)
104#if defined(THREADSAFE)
105# define SQLITE_THREADSAFE THREADSAFE
106#else
107# define SQLITE_THREADSAFE 1
108#endif
109#endif
110
drh67080612007-10-01 14:30:14 +0000111/*
danielk19770a732f52008-09-04 17:17:38 +0000112** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1.
113** It determines whether or not the features related to
shane467bcf32008-11-24 20:01:32 +0000114** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can
danielk19770a732f52008-09-04 17:17:38 +0000115** be overridden at runtime using the sqlite3_config() API.
116*/
117#if !defined(SQLITE_DEFAULT_MEMSTATUS)
118# define SQLITE_DEFAULT_MEMSTATUS 1
119#endif
120
121/*
drh0d180202008-02-14 23:26:56 +0000122** Exactly one of the following macros must be defined in order to
123** specify which memory allocation subsystem to use.
124**
125** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
126** SQLITE_MEMDEBUG // Debugging version of system malloc()
127** SQLITE_MEMORY_SIZE // internal allocator #1
128** SQLITE_MMAP_HEAP_SIZE // internal mmap() allocator
129** SQLITE_POW2_MEMORY_SIZE // internal power-of-two allocator
130**
131** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
132** the default.
133*/
134#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
135 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
136 defined(SQLITE_POW2_MEMORY_SIZE)>1
137# error "At most one of the following compile-time configuration options\
138 is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
139 SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
140#endif
141#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
142 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
143 defined(SQLITE_POW2_MEMORY_SIZE)==0
144# define SQLITE_SYSTEM_MALLOC 1
145#endif
146
147/*
drheee4c8c2008-02-18 22:24:57 +0000148** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
149** sizes of memory allocations below this value where possible.
150*/
151#if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
152# define SQLITE_MALLOC_SOFT_LIMIT 1024
153#endif
154
155/*
drh67080612007-10-01 14:30:14 +0000156** We need to define _XOPEN_SOURCE as follows in order to enable
shane467bcf32008-11-24 20:01:32 +0000157** recursive mutexes on most Unix systems. But Mac OS X is different.
drh67080612007-10-01 14:30:14 +0000158** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
159** so it is omitted there. See ticket #2673.
drhe5e7a902007-10-01 17:47:00 +0000160**
161** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
162** implemented on some systems. So we avoid defining it at all
163** if it is already defined or if it is unneeded because we are
164** not doing a threadsafe build. Ticket #2681.
drh9e0ebbf2007-10-23 15:59:18 +0000165**
166** See also ticket #2741.
drh67080612007-10-01 14:30:14 +0000167*/
aswiftee99b902008-01-28 22:09:23 +0000168#if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
drh67080612007-10-01 14:30:14 +0000169# define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */
170#endif
danielk1977e3026632004-06-22 11:29:02 +0000171
drh7d10d5a2008-08-20 16:35:10 +0000172/*
173** The TCL headers are only needed when compiling the TCL bindings.
174*/
drh4f0c5872007-03-26 22:05:01 +0000175#if defined(SQLITE_TCL) || defined(TCLSH)
176# include <tcl.h>
drh824d7c12006-01-06 12:03:19 +0000177#endif
178
179/*
drh4b529d92005-09-13 00:00:00 +0000180** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +0000181** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +0000182** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
183** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
184** feature.
185*/
danielk1977771151b2006-01-17 13:21:40 +0000186#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +0000187# define NDEBUG 1
188#endif
189
drh64022502009-01-09 14:11:04 +0000190/*
drh47c3b3e2009-01-10 16:15:20 +0000191** The testcase() macro is used to aid in coverage testing. When
192** doing coverage testing, the condition inside the argument to
193** testcase() must be evaluated both true and false in order to
194** get full branch coverage. The testcase() macro is inserted
195** to help ensure adequate test coverage in places where simple
196** condition/decision coverage is inadequate. For example, testcase()
197** can be used to make sure boundary values are tested. For
198** bitmask tests, testcase() can be used to make sure each bit
199** is significant and used at least once. On switch statements
200** where multiple cases go to the same block of code, testcase()
201** can insure that all cases are evaluated.
202**
drh47c3b3e2009-01-10 16:15:20 +0000203*/
204#ifdef SQLITE_COVERAGE_TEST
205 void sqlite3Coverage(int);
206# define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
drh47c3b3e2009-01-10 16:15:20 +0000207#else
208# define testcase(X)
drh8f941bc2009-01-14 23:03:40 +0000209#endif
210
211/*
212** The TESTONLY macro is used to enclose variable declarations or
213** other bits of code that are needed to support the arguments
214** within testcase() and assert() macros.
215*/
216#if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
217# define TESTONLY(X) X
218#else
drh47c3b3e2009-01-10 16:15:20 +0000219# define TESTONLY(X)
220#endif
221
222/*
223** The ALWAYS and NEVER macros surround boolean expressions which
224** are intended to always be true or false, respectively. Such
225** expressions could be omitted from the code completely. But they
226** are included in a few cases in order to enhance the resilience
227** of SQLite to unexpected behavior - to make the code "self-healing"
228** or "ductile" rather than being "brittle" and crashing at the first
229** hint of unplanned behavior.
230**
231** In other words, ALWAYS and NEVER are added for defensive code.
232**
233** When doing coverage testing ALWAYS and NEVER are hard-coded to
234** be true and false so that the unreachable code then specify will
235** not be counted as untested code.
236*/
237#if defined(SQLITE_COVERAGE_TEST)
238# define ALWAYS(X) (1)
239# define NEVER(X) (0)
240#elif !defined(NDEBUG)
241 int sqlite3Assert(void);
242# define ALWAYS(X) ((X)?1:sqlite3Assert())
243# define NEVER(X) ((X)?sqlite3Assert():0)
244#else
245# define ALWAYS(X) (X)
246# define NEVER(X) (X)
247#endif
248
249/*
250** The macro unlikely() is a hint that surrounds a boolean
251** expression that is usually false. Macro likely() surrounds
252** a boolean expression that is usually true. GCC is able to
253** use these hints to generate better code, sometimes.
254*/
255#if defined(__GNUC__) && 0
256# define likely(X) __builtin_expect((X),1)
257# define unlikely(X) __builtin_expect((X),0)
258#else
259# define likely(X) !!(X)
260# define unlikely(X) !!(X)
261#endif
262
263/*
drh64022502009-01-09 14:11:04 +0000264** Sometimes we need a small amount of code such as a variable initialization
265** to setup for a later assert() statement. We do not want this code to
266** appear when assert() is disabled. The following macro is therefore
267** used to contain that setup code. The "VVA" acronym stands for
268** "Verification, Validation, and Accreditation". In other words, the
269** code within VVA_ONLY() will only run during verification processes.
270*/
271#ifndef NDEBUG
272# define VVA_ONLY(X) X
273#else
274# define VVA_ONLY(X)
275#endif
276
drh1d482dd2004-05-31 18:23:07 +0000277#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +0000278#include "hash.h"
drh75897232000-05-29 14:26:00 +0000279#include "parse.h"
drh75897232000-05-29 14:26:00 +0000280#include <stdio.h>
281#include <stdlib.h>
282#include <string.h>
283#include <assert.h>
drh52370e22005-01-21 21:31:40 +0000284#include <stddef.h>
drh75897232000-05-29 14:26:00 +0000285
drh967e8b72000-06-21 13:59:10 +0000286/*
drhb37df7b2005-10-13 02:09:49 +0000287** If compiling for a processor that lacks floating point support,
288** substitute integer for floating-point
289*/
290#ifdef SQLITE_OMIT_FLOATING_POINT
291# define double sqlite_int64
292# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +0000293# ifndef SQLITE_BIG_DBL
294# define SQLITE_BIG_DBL (0x7fffffffffffffff)
295# endif
drhb37df7b2005-10-13 02:09:49 +0000296# define SQLITE_OMIT_DATETIME_FUNCS 1
297# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +0000298# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhb37df7b2005-10-13 02:09:49 +0000299#endif
drhd1167392006-01-23 13:00:35 +0000300#ifndef SQLITE_BIG_DBL
301# define SQLITE_BIG_DBL (1e99)
302#endif
drhb37df7b2005-10-13 02:09:49 +0000303
304/*
danielk197753c0f742005-03-29 03:10:59 +0000305** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
306** afterward. Having this macro allows us to cause the C compiler
307** to omit code used by TEMP tables without messy #ifndef statements.
308*/
309#ifdef SQLITE_OMIT_TEMPDB
310#define OMIT_TEMPDB 1
311#else
312#define OMIT_TEMPDB 0
313#endif
314
315/*
drh0bd1f4e2002-06-06 18:54:39 +0000316** If the following macro is set to 1, then NULL values are considered
drh0bd1f4e2002-06-06 18:54:39 +0000317** distinct when determining whether or not two entries are the same
318** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
319** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
320** is the way things are suppose to work.
321**
322** If the following macro is set to 0, the NULLs are indistinct for
323** a UNIQUE index. In this mode, you can only have a single NULL entry
324** for a column declared UNIQUE. This is the way Informix and SQL Server
325** work.
326*/
327#define NULL_DISTINCT_FOR_UNIQUE 1
328
329/*
drhd946db02005-12-29 19:23:06 +0000330** The "file format" number is an integer that is incremented whenever
331** the VDBE-level file format changes. The following macros define the
332** the default file format for new databases and the maximum file format
333** that the library can read.
334*/
335#define SQLITE_MAX_FILE_FORMAT 4
336#ifndef SQLITE_DEFAULT_FILE_FORMAT
drh76fe8032006-07-11 14:17:51 +0000337# define SQLITE_DEFAULT_FILE_FORMAT 1
drhd946db02005-12-29 19:23:06 +0000338#endif
339
340/*
danielk1977b06a0b62008-06-26 10:54:12 +0000341** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
drh49766d62005-01-08 18:42:28 +0000342** on the command-line
343*/
danielk1977b06a0b62008-06-26 10:54:12 +0000344#ifndef SQLITE_TEMP_STORE
345# define SQLITE_TEMP_STORE 1
drh49766d62005-01-08 18:42:28 +0000346#endif
347
348/*
drhf1974842004-11-05 03:56:00 +0000349** GCC does not define the offsetof() macro so we'll have to do it
350** ourselves.
351*/
352#ifndef offsetof
353#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
354#endif
355
356/*
drh9b8f4472006-04-04 01:54:55 +0000357** Check to see if this machine uses EBCDIC. (Yes, believe it or
358** not, there are still machines out there that use EBCDIC.)
359*/
360#if 'A' == '\301'
361# define SQLITE_EBCDIC 1
362#else
363# define SQLITE_ASCII 1
364#endif
365
366/*
drh5a2c2c22001-11-21 02:21:11 +0000367** Integers of known sizes. These typedefs might change for architectures
368** where the sizes very. Preprocessor macros are available so that the
369** types can be conveniently redefined at compile-type. Like this:
370**
371** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000372*/
drh5a2c2c22001-11-21 02:21:11 +0000373#ifndef UINT32_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000374# ifdef HAVE_UINT32_T
375# define UINT32_TYPE uint32_t
376# else
377# define UINT32_TYPE unsigned int
378# endif
drh5a2c2c22001-11-21 02:21:11 +0000379#endif
380#ifndef UINT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000381# ifdef HAVE_UINT16_T
382# define UINT16_TYPE uint16_t
383# else
384# define UINT16_TYPE unsigned short int
385# endif
drh5a2c2c22001-11-21 02:21:11 +0000386#endif
drh939a16d2004-07-15 13:37:22 +0000387#ifndef INT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000388# ifdef HAVE_INT16_T
389# define INT16_TYPE int16_t
390# else
391# define INT16_TYPE short int
392# endif
drh939a16d2004-07-15 13:37:22 +0000393#endif
drh5a2c2c22001-11-21 02:21:11 +0000394#ifndef UINT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000395# ifdef HAVE_UINT8_T
396# define UINT8_TYPE uint8_t
397# else
398# define UINT8_TYPE unsigned char
399# endif
drh5a2c2c22001-11-21 02:21:11 +0000400#endif
drh905793e2004-02-21 13:31:09 +0000401#ifndef INT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000402# ifdef HAVE_INT8_T
403# define INT8_TYPE int8_t
404# else
405# define INT8_TYPE signed char
406# endif
drh905793e2004-02-21 13:31:09 +0000407#endif
drhefad9992004-06-22 12:13:55 +0000408#ifndef LONGDOUBLE_TYPE
409# define LONGDOUBLE_TYPE long double
410#endif
drhefad9992004-06-22 12:13:55 +0000411typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000412typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000413typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
414typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000415typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000416typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh70a8ca32008-08-21 18:49:27 +0000417typedef INT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000418
419/*
drhbbd42a62004-05-22 17:41:58 +0000420** Macros to determine whether the machine is big or little endian,
421** evaluated at runtime.
422*/
drh46c99e02007-08-27 23:26:59 +0000423#ifdef SQLITE_AMALGAMATION
drhb3190c12008-12-08 21:37:14 +0000424const int sqlite3one = 1;
drh46c99e02007-08-27 23:26:59 +0000425#else
drhbbd42a62004-05-22 17:41:58 +0000426extern const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000427#endif
drh189077f2008-10-11 18:11:21 +0000428#if defined(i386) || defined(__i386__) || defined(_M_IX86)\
429 || defined(__x86_64) || defined(__x86_64__)
drh38def052007-03-31 15:27:59 +0000430# define SQLITE_BIGENDIAN 0
431# define SQLITE_LITTLEENDIAN 1
432# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
433#else
434# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
435# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
436# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
437#endif
drhbbd42a62004-05-22 17:41:58 +0000438
439/*
drh0f050352008-05-09 18:03:13 +0000440** Constants for the largest and smallest possible 64-bit signed integers.
441** These macros are designed to work correctly on both 32-bit and 64-bit
442** compilers.
443*/
444#define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
445#define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
446
447/*
drh90f5ecb2004-07-22 01:19:35 +0000448** An instance of the following structure is used to store the busy-handler
449** callback for a given sqlite handle.
450**
451** The sqlite.busyHandler member of the sqlite struct contains the busy
452** callback for the database handle. Each pager opened via the sqlite
453** handle is passed a pointer to sqlite.busyHandler. The busy-handler
454** callback is currently invoked only from within pager.c.
455*/
456typedef struct BusyHandler BusyHandler;
457struct BusyHandler {
458 int (*xFunc)(void *,int); /* The busy callback */
459 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000460 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000461};
462
463/*
drh75897232000-05-29 14:26:00 +0000464** Name of the master database table. The master database table
465** is a special table that holds the names and attributes of all
466** user tables and indices.
467*/
drhe0bc4042002-06-25 01:09:11 +0000468#define MASTER_NAME "sqlite_master"
469#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000470
471/*
danielk19778e150812004-05-10 01:17:37 +0000472** The root-page of the master database table.
473*/
474#define MASTER_ROOT 1
475
476/*
drhed6c8672003-01-12 18:02:16 +0000477** The name of the schema table.
478*/
danielk197753c0f742005-03-29 03:10:59 +0000479#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000480
481/*
drh75897232000-05-29 14:26:00 +0000482** A convenience macro that returns the number of elements in
483** an array.
484*/
danielk197723432972008-11-17 16:42:00 +0000485#define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
drh75897232000-05-29 14:26:00 +0000486
487/*
drh633e6d52008-07-28 19:34:53 +0000488** The following value as a destructor means to use sqlite3DbFree().
489** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT.
490*/
491#define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3DbFree)
492
drh78f82d12008-09-02 00:52:52 +0000493/*
494** When SQLITE_OMIT_WSD is defined, it means that the target platform does
495** not support Writable Static Data (WSD) such as global and static variables.
496** All variables must either be on the stack or dynamically allocated from
497** the heap. When WSD is unsupported, the variable declarations scattered
498** throughout the SQLite code must become constants instead. The SQLITE_WSD
499** macro is used for this purpose. And instead of referencing the variable
500** directly, we use its constant as a key to lookup the run-time allocated
501** buffer that holds real variable. The constant is also the initializer
502** for the run-time allocated buffer.
503**
shane2479de32008-11-10 18:05:35 +0000504** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
drh78f82d12008-09-02 00:52:52 +0000505** macros become no-ops and have zero performance impact.
506*/
danielk1977075c23a2008-09-01 18:34:20 +0000507#ifdef SQLITE_OMIT_WSD
508 #define SQLITE_WSD const
509 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
510 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
drhd1d38482008-10-07 23:46:38 +0000511 int sqlite3_wsd_init(int N, int J);
512 void *sqlite3_wsd_find(void *K, int L);
danielk1977075c23a2008-09-01 18:34:20 +0000513#else
514 #define SQLITE_WSD
515 #define GLOBAL(t,v) v
516 #define sqlite3GlobalConfig sqlite3Config
517#endif
518
danielk1977f3d3c272008-11-19 16:52:44 +0000519/*
520** The following macros are used to suppress compiler warnings and to
521** make it clear to human readers when a function parameter is deliberately
522** left unused within the body of a function. This usually happens when
523** a function is called via a function pointer. For example the
524** implementation of an SQL aggregate step callback may not use the
525** parameter indicating the number of arguments passed to the aggregate,
526** if it knows that this is enforced elsewhere.
527**
528** When a function parameter is not used at all within the body of a function,
529** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
530** However, these macros may also be used to suppress warnings related to
531** parameters that may or may not be used depending on compilation options.
532** For example those parameters only used in assert() statements. In these
533** cases the parameters are named as per the usual conventions.
534*/
danielk197762c14b32008-11-19 09:05:26 +0000535#define UNUSED_PARAMETER(x) (void)(x)
danielk1977f3d3c272008-11-19 16:52:44 +0000536#define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
danielk197762c14b32008-11-19 09:05:26 +0000537
drh633e6d52008-07-28 19:34:53 +0000538/*
drh75897232000-05-29 14:26:00 +0000539** Forward references to structures
540*/
drh13449892005-09-07 21:22:45 +0000541typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000542typedef struct AuthContext AuthContext;
drhf5e7bb52008-02-18 14:47:33 +0000543typedef struct Bitvec Bitvec;
drh3d4501e2008-12-04 20:40:10 +0000544typedef struct RowSet RowSet;
drhfe05af82005-07-21 03:14:59 +0000545typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000546typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000547typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000548typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000549typedef struct Expr Expr;
550typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000551typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000552typedef struct FuncDef FuncDef;
drh70a8ca32008-08-21 18:49:27 +0000553typedef struct FuncDefHash FuncDefHash;
drhfe05af82005-07-21 03:14:59 +0000554typedef struct IdList IdList;
555typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000556typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000557typedef struct KeyInfo KeyInfo;
drh633e6d52008-07-28 19:34:53 +0000558typedef struct Lookaside Lookaside;
559typedef struct LookasideSlot LookasideSlot;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000560typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000561typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000562typedef struct Parse Parse;
danielk1977fd7f0452008-12-17 17:30:26 +0000563typedef struct Savepoint Savepoint;
drhfe05af82005-07-21 03:14:59 +0000564typedef struct Select Select;
565typedef struct SrcList SrcList;
drhade86482007-11-28 22:36:40 +0000566typedef struct StrAccum StrAccum;
drhfe05af82005-07-21 03:14:59 +0000567typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000568typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000569typedef struct Token Token;
570typedef struct TriggerStack TriggerStack;
571typedef struct TriggerStep TriggerStep;
572typedef struct Trigger Trigger;
drhe63d9992008-08-13 19:11:48 +0000573typedef struct UnpackedRecord UnpackedRecord;
drh7d10d5a2008-08-20 16:35:10 +0000574typedef struct Walker Walker;
drh111a6a72008-12-21 03:51:16 +0000575typedef struct WherePlan WherePlan;
drhfe05af82005-07-21 03:14:59 +0000576typedef struct WhereInfo WhereInfo;
577typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000578
danielk19772dca4ac2008-01-03 11:50:29 +0000579/*
580** Defer sourcing vdbe.h and btree.h until after the "u8" and
581** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
582** pointer types (i.e. FuncDef) defined above.
583*/
584#include "btree.h"
585#include "vdbe.h"
586#include "pager.h"
danielk19778c0a7912008-08-20 14:49:23 +0000587#include "pcache.h"
danielk19772dca4ac2008-01-03 11:50:29 +0000588
danielk19771cc5ed82007-05-16 17:28:43 +0000589#include "os.h"
drhc7ce76a2007-08-30 14:10:30 +0000590#include "mutex.h"
danielk19771cc5ed82007-05-16 17:28:43 +0000591
drheee4c8c2008-02-18 22:24:57 +0000592
drh001bbcb2003-03-19 03:14:00 +0000593/*
594** Each database file to be accessed by the system is an instance
595** of the following structure. There are normally two of these structures
596** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000597** aDb[1] is the database file used to hold temporary tables. Additional
598** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000599*/
600struct Db {
601 char *zName; /* Name of this database */
602 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000603 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
shane467bcf32008-11-24 20:01:32 +0000604 u8 safety_level; /* How aggressive at syncing data to disk */
danielk1977da184232006-01-05 11:34:32 +0000605 void *pAux; /* Auxiliary data. Usually NULL */
606 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000607 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000608};
609
610/*
611** An instance of the following structure stores a database schema.
danielk1977a04a34f2007-04-16 15:06:25 +0000612**
613** If there are no virtual tables configured in this schema, the
614** Schema.db variable is set to NULL. After the first virtual table
615** has been added, it is set to point to the database connection
616** used to create the connection. Once a virtual table has been
617** added to the Schema structure and the Schema.db variable populated,
618** only that database connection may use the Schema to prepare
619** statements.
danielk1977da184232006-01-05 11:34:32 +0000620*/
danielk1977e501b892006-01-09 06:29:47 +0000621struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000622 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000623 Hash tblHash; /* All tables indexed by name */
624 Hash idxHash; /* All (named) indices indexed by name */
625 Hash trigHash; /* All triggers indexed by name */
626 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000627 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000628 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000629 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000630 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000631 int cache_size; /* Number of pages to use in the cache */
danielk1977a04a34f2007-04-16 15:06:25 +0000632#ifndef SQLITE_OMIT_VIRTUALTABLE
633 sqlite3 *db; /* "Owner" connection. See comment above */
634#endif
drh001bbcb2003-03-19 03:14:00 +0000635};
drh75897232000-05-29 14:26:00 +0000636
637/*
drh8bf8dc92003-05-17 17:35:10 +0000638** These macros can be used to test, set, or clear bits in the
639** Db.flags field.
640*/
danielk1977da184232006-01-05 11:34:32 +0000641#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
642#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
643#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
644#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000645
646/*
647** Allowed values for the DB.flags field.
648**
drh8bf8dc92003-05-17 17:35:10 +0000649** The DB_SchemaLoaded flag is set after the database schema has been
650** read into internal hash tables.
651**
652** DB_UnresetViews means that one or more views have column names that
653** have been filled out. If the schema changes, these column names might
654** changes and so the view will need to be reset.
655*/
drh124b27e2004-06-19 16:06:10 +0000656#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
657#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000658#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000659
drhcaa639f2008-03-20 00:32:20 +0000660/*
661** The number of different kinds of things that can be limited
662** using the sqlite3_limit() interface.
663*/
664#define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
drh8bf8dc92003-05-17 17:35:10 +0000665
666/*
drh633e6d52008-07-28 19:34:53 +0000667** Lookaside malloc is a set of fixed-size buffers that can be used
shane467bcf32008-11-24 20:01:32 +0000668** to satisfy small transient memory allocation requests for objects
drh633e6d52008-07-28 19:34:53 +0000669** associated with a particular database connection. The use of
670** lookaside malloc provides a significant performance enhancement
671** (approx 10%) by avoiding numerous malloc/free requests while parsing
672** SQL statements.
673**
674** The Lookaside structure holds configuration information about the
675** lookaside malloc subsystem. Each available memory allocation in
676** the lookaside subsystem is stored on a linked list of LookasideSlot
677** objects.
678*/
679struct Lookaside {
680 u16 sz; /* Size of each buffer in bytes */
681 u8 bEnabled; /* True if use lookaside. False to ignore it */
drhe9d1c722008-08-04 20:13:26 +0000682 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
drh633e6d52008-07-28 19:34:53 +0000683 int nOut; /* Number of buffers currently checked out */
684 int mxOut; /* Highwater mark for nOut */
drh7d10d5a2008-08-20 16:35:10 +0000685 LookasideSlot *pFree; /* List of available buffers */
drh633e6d52008-07-28 19:34:53 +0000686 void *pStart; /* First byte of available memory space */
687 void *pEnd; /* First byte past end of available space */
688};
689struct LookasideSlot {
690 LookasideSlot *pNext; /* Next buffer in the list of free buffers */
691};
692
693/*
drh70a8ca32008-08-21 18:49:27 +0000694** A hash table for function definitions.
695**
696** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
697** Collisions are on the FuncDef.pHash chain.
698*/
699struct FuncDefHash {
700 FuncDef *a[23]; /* Hash table for functions */
701};
702
703/*
drhc9b84a12002-06-20 11:36:48 +0000704** Each database is an instance of the following structure.
705**
rdcb0c374f2004-02-20 22:53:38 +0000706** The sqlite.lastRowid records the last insert rowid generated by an
707** insert statement. Inserts on views do not affect its value. Each
708** trigger has its own context, so that lastRowid can be updated inside
709** triggers as usual. The previous value will be restored once the trigger
710** exits. Upon entering a before or instead of trigger, lastRowid is no
711** longer (since after version 2.8.12) reset to -1.
712**
713** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000714** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000715** The sqlite.lsChange represents the number of changes made by the last
716** insert, update, or delete statement. It remains constant throughout the
717** length of a statement and is then updated by OP_SetCounts. It keeps a
718** context stack just like lastRowid so that the count of changes
719** within a trigger is not seen outside the trigger. Changes to views do not
720** affect the value of lsChange.
721** The sqlite.csChange keeps track of the number of current changes (since
722** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000723**
724** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
725** store the most recent error code and, if applicable, string. The
726** internal function sqlite3Error() is used to set these variables
727** consistently.
drh75897232000-05-29 14:26:00 +0000728*/
drh9bb575f2004-09-06 17:24:11 +0000729struct sqlite3 {
drh90f6a5b2007-08-15 13:04:54 +0000730 sqlite3_vfs *pVfs; /* OS Interface */
drh001bbcb2003-03-19 03:14:00 +0000731 int nDb; /* Number of backends currently in use */
732 Db *aDb; /* All backends */
shane467bcf32008-11-24 20:01:32 +0000733 int flags; /* Miscellaneous flags. See below */
drh33f4e022007-09-03 15:19:34 +0000734 int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
drhfcd35c72005-05-21 02:48:08 +0000735 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000736 int errMask; /* & result codes with this before returning */
drhfcd35c72005-05-21 02:48:08 +0000737 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000738 u8 temp_store; /* 1: file 2: memory 0: default */
drh17435752007-08-16 04:30:38 +0000739 u8 mallocFailed; /* True if we have seen a malloc failure */
drh3b020132008-04-17 17:02:01 +0000740 u8 dfltLockMode; /* Default locking-mode for attached dbs */
741 u8 dfltJournalMode; /* Default journal mode for attached dbs */
drh98757152008-01-09 23:04:12 +0000742 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
danielk1977f653d782008-03-20 11:04:21 +0000743 int nextPagesize; /* Pagesize after VACUUM if >0 */
drh5e00f6c2001-09-13 13:46:56 +0000744 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000745 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000746 i64 lastRowid; /* ROWID of most recent insert (see above) */
747 i64 priorNewRowid; /* Last randomly generated ROWID */
danielk197764202cf2008-11-17 15:31:47 +0000748 u32 magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000749 int nChange; /* Value returned by sqlite3_changes() */
750 int nTotalChange; /* Value returned by sqlite3_total_changes() */
drhd677b3d2007-08-20 22:48:41 +0000751 sqlite3_mutex *mutex; /* Connection mutex */
drhcaa639f2008-03-20 00:32:20 +0000752 int aLimit[SQLITE_N_LIMIT]; /* Limits */
danielk1977b28af712004-06-21 06:50:26 +0000753 struct sqlite3InitInfo { /* Information used during initialization */
754 int iDb; /* When back is being initialized */
755 int newTnum; /* Rootpage of table being initialized */
756 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000757 } init;
drhf1952c52006-06-08 15:48:00 +0000758 int nExtension; /* Number of loaded extensions */
shane467bcf32008-11-24 20:01:32 +0000759 void **aExtension; /* Array of shared library handles */
drh326dce72003-01-29 14:06:07 +0000760 struct Vdbe *pVdbe; /* List of active virtual machines */
shane467bcf32008-11-24 20:01:32 +0000761 int activeVdbeCnt; /* Number of VDBEs currently executing */
drhad4a4b82008-11-05 16:37:34 +0000762 int writeVdbeCnt; /* Number of active VDBEs that are writing */
drh19e2d372005-08-29 23:00:03 +0000763 void (*xTrace)(void*,const char*); /* Trace function */
764 void *pTraceArg; /* Argument to the trace function */
765 void (*xProfile)(void*,const char*,u64); /* Profiling function */
766 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000767 void *pCommitArg; /* Argument to xCommitCallback() */
768 int (*xCommitCallback)(void*); /* Invoked at every commit. */
769 void *pRollbackArg; /* Argument to xRollbackCallback() */
770 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000771 void *pUpdateArg;
772 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000773 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
774 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
775 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000776 sqlite3_value *pErr; /* Most recent error message */
777 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
778 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drh881feaa2006-07-26 01:39:30 +0000779 union {
drh39001e72008-09-12 16:03:47 +0000780 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
drh881feaa2006-07-26 01:39:30 +0000781 double notUsed1; /* Spacer */
782 } u1;
drh633e6d52008-07-28 19:34:53 +0000783 Lookaside lookaside; /* Lookaside malloc configuration */
drhed6c8672003-01-12 18:02:16 +0000784#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000785 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
786 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000787 void *pAuthArg; /* 1st argument to the access auth function */
788#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000789#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
790 int (*xProgress)(void *); /* The progress callback */
791 void *pProgressArg; /* Argument to the progress callback */
792 int nProgressOps; /* Number of opcodes for progress callback */
793#endif
drhb9bb7c12006-06-11 23:41:55 +0000794#ifndef SQLITE_OMIT_VIRTUALTABLE
795 Hash aModule; /* populated by sqlite3_create_module() */
danielk19777e6ebfb2006-06-12 11:24:37 +0000796 Table *pVTab; /* vtab with active Connect/Create method */
danielk1977f9e7dda2006-06-16 16:08:53 +0000797 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */
798 int nVTrans; /* Allocated size of aVTrans */
danielk19776b456a22005-03-21 04:04:02 +0000799#endif
drh70a8ca32008-08-21 18:49:27 +0000800 FuncDefHash aFunc; /* Hash table of connection functions */
drhfcd35c72005-05-21 02:48:08 +0000801 Hash aCollSeq; /* All collating sequences */
802 BusyHandler busyHandler; /* Busy callback */
drhb9bb7c12006-06-11 23:41:55 +0000803 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000804 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000805#ifdef SQLITE_SSE
806 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
807#endif
danielk1977fd7f0452008-12-17 17:30:26 +0000808 Savepoint *pSavepoint; /* List of active savepoints */
809 int nSavepoint; /* Number of non-transaction savepoints */
danielk1977bd434552009-03-18 10:33:00 +0000810 int nStatement; /* Number of nested statement-transactions */
danielk1977fd7f0452008-12-17 17:30:26 +0000811 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
danielk1977404ca072009-03-16 13:19:36 +0000812
813#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
814 /* The following variables are all protected by the STATIC_MASTER
815 ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
816 */
817 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
818 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */
819 void *pUnlockArg; /* Argument to xUnlockNotify */
820 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */
821 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */
822#endif
drh75897232000-05-29 14:26:00 +0000823};
824
drh03b808a2006-03-13 15:06:05 +0000825/*
826** A macro to discover the encoding of a database.
827*/
danielk197714db2662006-01-09 16:12:04 +0000828#define ENC(db) ((db)->aDb[0].pSchema->enc)
829
drh75897232000-05-29 14:26:00 +0000830/*
drh8bf8dc92003-05-17 17:35:10 +0000831** Possible values for the sqlite.flags and or Db.flags fields.
832**
833** On sqlite.flags, the SQLITE_InTrans value means that we have
834** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
835** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000836*/
drh5e00f6c2001-09-13 13:46:56 +0000837#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000838#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
839#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000840#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000841#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
842#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000843 /* DELETE, or UPDATE and return */
844 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000845#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000846 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000847#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
848#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000849#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000850#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
851 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000852#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
drhc2e87a32006-06-27 15:16:14 +0000853#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000854#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drhac530b12006-02-11 01:25:50 +0000855#define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */
drhc2e87a32006-06-27 15:16:14 +0000856#define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */
drh58b95762000-06-02 01:17:37 +0000857
danielk197734c68fb2007-03-14 15:37:04 +0000858#define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */
drh4a50aac2007-08-23 02:47:53 +0000859#define SQLITE_SharedCache 0x00080000 /* Cache sharing is enabled */
860#define SQLITE_Vtab 0x00100000 /* There exists a virtual table */
drh853799a2009-01-03 14:04:38 +0000861#define SQLITE_CommitBusy 0x00200000 /* In the process of committing */
drh699b3d42009-02-23 16:52:07 +0000862#define SQLITE_ReverseOrder 0x00400000 /* Reverse unordered SELECTs */
danielk197734c68fb2007-03-14 15:37:04 +0000863
drh58b95762000-06-02 01:17:37 +0000864/*
drh247be432002-05-10 05:44:55 +0000865** Possible values for the sqlite.magic field.
866** The numbers are obtained at random and have no special meaning, other
867** than being distinct from one another.
868*/
869#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
870#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
drh7e8b8482008-01-23 03:03:05 +0000871#define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
drh247be432002-05-10 05:44:55 +0000872#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
873#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
874
875/*
drh0bce8352002-02-28 00:41:10 +0000876** Each SQL function is defined by an instance of the following
877** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000878** hash table. When multiple functions have the same name, the hash table
879** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000880*/
drh0bce8352002-02-28 00:41:10 +0000881struct FuncDef {
drhe82f5d02008-10-07 19:53:14 +0000882 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000883 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000884 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000885 void *pUserData; /* User data parameter */
886 FuncDef *pNext; /* Next function with same name */
887 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
888 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
shane467bcf32008-11-24 20:01:32 +0000889 void (*xFinalize)(sqlite3_context*); /* Aggregate finalizer */
danielk19778c0a7912008-08-20 14:49:23 +0000890 char *zName; /* SQL name of the function. */
drh70a8ca32008-08-21 18:49:27 +0000891 FuncDef *pHash; /* Next with a different name but the same hash */
drh8e0a2f92002-02-23 23:45:45 +0000892};
drh28037572000-08-02 13:47:41 +0000893
894/*
drh7d10d5a2008-08-20 16:35:10 +0000895** Possible values for FuncDef.flags
896*/
drhe82f5d02008-10-07 19:53:14 +0000897#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
898#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
shane467bcf32008-11-24 20:01:32 +0000899#define SQLITE_FUNC_EPHEM 0x04 /* Ephemeral. Delete with VDBE */
drhe82f5d02008-10-07 19:53:14 +0000900#define SQLITE_FUNC_NEEDCOLL 0x08 /* sqlite3GetFuncCollSeq() might be called */
drhd1fa7bc2009-01-10 13:24:50 +0000901#define SQLITE_FUNC_PRIVATE 0x10 /* Allowed for internal use only */
danielk1977a5533162009-02-24 10:01:51 +0000902#define SQLITE_FUNC_COUNT 0x20 /* Built-in count(*) aggregate */
drh7d10d5a2008-08-20 16:35:10 +0000903
904/*
drh777c5382008-08-21 20:21:34 +0000905** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
906** used to create the initializers for the FuncDef structures.
907**
908** FUNCTION(zName, nArg, iArg, bNC, xFunc)
909** Used to create a scalar function definition of a function zName
910** implemented by C function xFunc that accepts nArg arguments. The
911** value passed as iArg is cast to a (void*) and made available
912** as the user-data (sqlite3_user_data()) for the function. If
913** argument bNC is true, then the FuncDef.needCollate flag is set.
914**
915** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
916** Used to create an aggregate function definition implemented by
917** the C functions xStep and xFinal. The first four parameters
918** are interpreted in the same way as the first 4 parameters to
919** FUNCTION().
920**
921** LIKEFUNC(zName, nArg, pArg, flags)
922** Used to create a scalar function definition of a function zName
923** that accepts nArg arguments and is implemented by a call to C
924** function likeFunc. Argument pArg is cast to a (void *) and made
925** available as the function user-data (sqlite3_user_data()). The
926** FuncDef.flags variable is set to the value passed as the flags
927** parameter.
928*/
929#define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
danielk1977cdcfe952008-11-18 07:27:24 +0000930 {nArg, SQLITE_UTF8, bNC*8, SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0}
drh21717ed2008-10-13 15:35:08 +0000931#define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
danielk1977cdcfe952008-11-18 07:27:24 +0000932 {nArg, SQLITE_UTF8, bNC*8, pArg, 0, xFunc, 0, 0, #zName, 0}
drh777c5382008-08-21 20:21:34 +0000933#define LIKEFUNC(zName, nArg, arg, flags) \
danielk1977cdcfe952008-11-18 07:27:24 +0000934 {nArg, SQLITE_UTF8, flags, (void *)arg, 0, likeFunc, 0, 0, #zName, 0}
drh777c5382008-08-21 20:21:34 +0000935#define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
danielk1977cdcfe952008-11-18 07:27:24 +0000936 {nArg, SQLITE_UTF8, nc*8, SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0}
drh777c5382008-08-21 20:21:34 +0000937
danielk1977fd7f0452008-12-17 17:30:26 +0000938/*
939** All current savepoints are stored in a linked list starting at
940** sqlite3.pSavepoint. The first element in the list is the most recently
941** opened savepoint. Savepoints are added to the list by the vdbe
942** OP_Savepoint instruction.
943*/
944struct Savepoint {
945 char *zName; /* Savepoint name (nul-terminated) */
946 Savepoint *pNext; /* Parent savepoint (if any) */
947};
948
949/*
950** The following are used as the second parameter to sqlite3Savepoint(),
951** and as the P1 argument to the OP_Savepoint instruction.
952*/
953#define SAVEPOINT_BEGIN 0
954#define SAVEPOINT_RELEASE 1
955#define SAVEPOINT_ROLLBACK 2
956
drh777c5382008-08-21 20:21:34 +0000957
958/*
danielk1977d1ab1ba2006-06-15 04:28:13 +0000959** Each SQLite module (virtual table definition) is defined by an
960** instance of the following structure, stored in the sqlite3.aModule
961** hash table.
962*/
963struct Module {
964 const sqlite3_module *pModule; /* Callback pointers */
965 const char *zName; /* Name passed to create_module() */
966 void *pAux; /* pAux passed to create_module() */
danielk1977832a58a2007-06-22 15:21:15 +0000967 void (*xDestroy)(void *); /* Module destructor function */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000968};
969
970/*
drh967e8b72000-06-21 13:59:10 +0000971** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000972** of this structure.
973*/
974struct Column {
drh967e8b72000-06-21 13:59:10 +0000975 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000976 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000977 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000978 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000979 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000980 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000981 char affinity; /* One of the SQLITE_AFF_... values */
danielk1977034ca142007-06-26 10:38:54 +0000982#ifndef SQLITE_OMIT_VIRTUALTABLE
983 u8 isHidden; /* True if this column is 'hidden' */
984#endif
drh7020f652000-06-03 18:06:52 +0000985};
986
987/*
drha9fd84b2004-05-18 23:21:35 +0000988** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000989** structure. Conceptually, a collating sequence consists of a name and
990** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000991**
shane467bcf32008-11-24 20:01:32 +0000992** There may two separate implementations of the collation function, one
danielk19770202b292004-06-09 09:55:16 +0000993** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
994** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
995** native byte order. When a collation sequence is invoked, SQLite selects
996** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000997** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000998**
999** The CollSeq.pUser member variable is an extra parameter that passed in
1000** as the first argument to the UTF-8 comparison function, xCmp.
1001** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
1002** xCmp16.
1003**
1004** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
1005** collating sequence is undefined. Indices built on an undefined
1006** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +00001007*/
1008struct CollSeq {
danielk1977a9808b32007-05-07 09:32:45 +00001009 char *zName; /* Name of the collating sequence, UTF-8 encoded */
1010 u8 enc; /* Text encoding handled by xCmp() */
1011 u8 type; /* One of the SQLITE_COLL_... values below */
1012 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +00001013 int (*xCmp)(void*,int, const void*, int, const void*);
danielk1977a9808b32007-05-07 09:32:45 +00001014 void (*xDel)(void*); /* Destructor for pUser */
drha9fd84b2004-05-18 23:21:35 +00001015};
1016
1017/*
drh7d10d5a2008-08-20 16:35:10 +00001018** Allowed values of CollSeq.type:
drhd64fe2f2005-08-28 17:00:23 +00001019*/
1020#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
1021#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
1022#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
1023#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
1024
1025/*
drhd3d39e92004-05-20 22:16:29 +00001026** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +00001027*/
drh8e2ca022002-06-17 17:07:19 +00001028#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +00001029#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +00001030
1031/*
danielk1977a37cdde2004-05-16 11:15:36 +00001032** Column affinity types.
drh8a512562005-11-14 22:29:05 +00001033**
1034** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
1035** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
drh7d10d5a2008-08-20 16:35:10 +00001036** the speed a little by numbering the values consecutively.
drh8a512562005-11-14 22:29:05 +00001037**
1038** But rather than start with 0 or 1, we begin with 'a'. That way,
1039** when multiple affinity types are concatenated into a string and
drh66a51672008-01-03 00:01:23 +00001040** used as the P4 operand, they will be more readable.
drh8a512562005-11-14 22:29:05 +00001041**
1042** Note also that the numeric types are grouped together so that testing
1043** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +00001044*/
drh8a512562005-11-14 22:29:05 +00001045#define SQLITE_AFF_TEXT 'a'
1046#define SQLITE_AFF_NONE 'b'
1047#define SQLITE_AFF_NUMERIC 'c'
1048#define SQLITE_AFF_INTEGER 'd'
1049#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +00001050
drh8a512562005-11-14 22:29:05 +00001051#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +00001052
1053/*
drh35573352008-01-08 23:54:25 +00001054** The SQLITE_AFF_MASK values masks off the significant bits of an
1055** affinity value.
1056*/
1057#define SQLITE_AFF_MASK 0x67
1058
1059/*
1060** Additional bit values that can be ORed with an affinity without
1061** changing the affinity.
1062*/
1063#define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */
drh93a960a2008-07-10 00:32:42 +00001064#define SQLITE_STOREP2 0x10 /* Store result in reg[P2] rather than jump */
drh35573352008-01-08 23:54:25 +00001065
1066/*
drh22f70c32002-02-18 01:17:00 +00001067** Each SQL table is represented in memory by an instance of the
1068** following structure.
1069**
drhd24cc422003-03-27 12:51:24 +00001070** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +00001071** CREATE TABLE statement is stored, but case is not significant for
1072** comparisons.
1073**
drhd24cc422003-03-27 12:51:24 +00001074** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +00001075** pointer to an array of Column structures, one for each column.
1076**
drhd24cc422003-03-27 12:51:24 +00001077** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
1078** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +00001079** that the datatype of the PRIMARY KEY must be INTEGER for this field to
1080** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
1081** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drh7d10d5a2008-08-20 16:35:10 +00001082** is generated for each row of the table. TF_HasPrimaryKey is set if
drh22f70c32002-02-18 01:17:00 +00001083** the table has any PRIMARY KEY, INTEGER or otherwise.
1084**
drhd24cc422003-03-27 12:51:24 +00001085** Table.tnum is the page number for the root BTree page of the table in the
1086** database file. If Table.iDb is the index of the database table backend
1087** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drh7d10d5a2008-08-20 16:35:10 +00001088** holds temporary tables and indices. If TF_Ephemeral is set
1089** then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +00001090** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +00001091** refers VDBE cursor number that holds the table open, not to the root
1092** page number. Transient tables are used to hold the results of a
1093** sub-query that appears instead of a real table name in the FROM clause
1094** of a SELECT statement.
drh75897232000-05-29 14:26:00 +00001095*/
1096struct Table {
drh7d10d5a2008-08-20 16:35:10 +00001097 sqlite3 *db; /* Associated database connection. Might be NULL. */
1098 char *zName; /* Name of the table or view */
1099 int iPKey; /* If not negative, use aCol[iPKey] as the primary key */
1100 int nCol; /* Number of columns in this table */
1101 Column *aCol; /* Information about each column */
1102 Index *pIndex; /* List of SQL indexes on this table. */
1103 int tnum; /* Root BTree node for this table (see note above) */
1104 Select *pSelect; /* NULL for tables. Points to definition if a view. */
1105 u16 nRef; /* Number of pointers to this Table */
1106 u8 tabFlags; /* Mask of TF_* values */
1107 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
drh7d10d5a2008-08-20 16:35:10 +00001108 FKey *pFKey; /* Linked list of all foreign keys in this table */
1109 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +00001110#ifndef SQLITE_OMIT_CHECK
drh7d10d5a2008-08-20 16:35:10 +00001111 Expr *pCheck; /* The AND of all CHECK constraints */
drhffe07b22005-11-03 00:41:17 +00001112#endif
danielk197719a8e7e2005-03-17 05:03:38 +00001113#ifndef SQLITE_OMIT_ALTERTABLE
drh7d10d5a2008-08-20 16:35:10 +00001114 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
danielk197719a8e7e2005-03-17 05:03:38 +00001115#endif
drhe09daa92006-06-10 13:29:31 +00001116#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7d10d5a2008-08-20 16:35:10 +00001117 Module *pMod; /* Pointer to the implementation of the module */
1118 sqlite3_vtab *pVtab; /* Pointer to the module instance */
1119 int nModuleArg; /* Number of arguments to the module */
1120 char **azModuleArg; /* Text of all module args. [0] is module name */
drhe09daa92006-06-10 13:29:31 +00001121#endif
danielk19772f886d12009-02-28 10:47:41 +00001122 Trigger *pTrigger; /* List of triggers stored in pSchema */
drh7d10d5a2008-08-20 16:35:10 +00001123 Schema *pSchema; /* Schema that contains this table */
drh588a9a12008-09-01 15:52:10 +00001124 Table *pNextZombie; /* Next on the Parse.pZombieTab list */
drh75897232000-05-29 14:26:00 +00001125};
1126
1127/*
drh7d10d5a2008-08-20 16:35:10 +00001128** Allowed values for Tabe.tabFlags.
1129*/
1130#define TF_Readonly 0x01 /* Read-only system table */
shane467bcf32008-11-24 20:01:32 +00001131#define TF_Ephemeral 0x02 /* An ephemeral table */
drh7d10d5a2008-08-20 16:35:10 +00001132#define TF_HasPrimaryKey 0x04 /* Table has a primary key */
1133#define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */
1134#define TF_Virtual 0x10 /* Is a virtual table */
1135#define TF_NeedMetadata 0x20 /* aCol[].zType and aCol[].pColl missing */
1136
1137
1138
1139/*
drh4cbdda92006-06-14 19:00:20 +00001140** Test to see whether or not a table is a virtual table. This is
1141** done as a macro so that it will be optimized out when virtual
1142** table support is omitted from the build.
1143*/
1144#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7d10d5a2008-08-20 16:35:10 +00001145# define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0)
danielk1977034ca142007-06-26 10:38:54 +00001146# define IsHiddenColumn(X) ((X)->isHidden)
drh4cbdda92006-06-14 19:00:20 +00001147#else
danielk1977034ca142007-06-26 10:38:54 +00001148# define IsVirtual(X) 0
1149# define IsHiddenColumn(X) 0
drh4cbdda92006-06-14 19:00:20 +00001150#endif
1151
1152/*
drhc2eef3b2002-08-31 18:53:06 +00001153** Each foreign key constraint is an instance of the following structure.
1154**
1155** A foreign key is associated with two tables. The "from" table is
1156** the table that contains the REFERENCES clause that creates the foreign
1157** key. The "to" table is the table that is named in the REFERENCES clause.
1158** Consider this example:
1159**
1160** CREATE TABLE ex1(
1161** a INTEGER PRIMARY KEY,
1162** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1163** );
1164**
1165** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1166**
1167** Each REFERENCES clause generates an instance of the following structure
1168** which is attached to the from-table. The to-table need not exist when
shane467bcf32008-11-24 20:01:32 +00001169** the from-table is created. The existence of the to-table is not checked
drhc2eef3b2002-08-31 18:53:06 +00001170** until an attempt is made to insert data into the from-table.
1171**
drhea1ba172003-04-20 00:00:23 +00001172** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +00001173** given the name of a to-table. For each to-table, all foreign keys
1174** associated with that table are on a linked list using the FKey.pNextTo
1175** field.
1176*/
1177struct FKey {
shane467bcf32008-11-24 20:01:32 +00001178 Table *pFrom; /* The table that contains the REFERENCES clause */
drhc2eef3b2002-08-31 18:53:06 +00001179 FKey *pNextFrom; /* Next foreign key in pFrom */
1180 char *zTo; /* Name of table that the key points to */
1181 FKey *pNextTo; /* Next foreign key that points to zTo */
1182 int nCol; /* Number of columns in this key */
1183 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
1184 int iFrom; /* Index of column in pFrom */
1185 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
1186 } *aCol; /* One entry for each of nCol column s */
1187 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
1188 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
1189 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
1190 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
1191};
1192
1193/*
danielk1977aaa40c12007-09-21 04:28:16 +00001194** SQLite supports many different ways to resolve a constraint
drh22f70c32002-02-18 01:17:00 +00001195** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +00001196** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +00001197** to be rolled back. ABORT processing means the operation in process
1198** fails and any prior changes from that one operation are backed out,
1199** but the transaction is not rolled back. FAIL processing means that
1200** the operation in progress stops and returns an error code. But prior
1201** changes due to the same operation are not backed out and no rollback
1202** occurs. IGNORE means that the particular row that caused the constraint
1203** error is not inserted or updated. Processing continues and no error
1204** is returned. REPLACE means that preexisting database rows that caused
1205** a UNIQUE constraint violation are removed so that the new insert or
1206** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +00001207**
1208** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1209** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1210** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
1211** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
1212** referenced table row is propagated into the row that holds the
1213** foreign key.
drh1c928532002-01-31 15:54:21 +00001214**
drh968af522003-02-11 14:55:40 +00001215** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +00001216** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +00001217*/
drh1c928532002-01-31 15:54:21 +00001218#define OE_None 0 /* There is no constraint to check */
1219#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
1220#define OE_Abort 2 /* Back out changes but do no rollback transaction */
1221#define OE_Fail 3 /* Stop the operation but leave all prior changes */
1222#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
1223#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +00001224
1225#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1226#define OE_SetNull 7 /* Set the foreign key value to NULL */
1227#define OE_SetDflt 8 /* Set the foreign key value to its default */
1228#define OE_Cascade 9 /* Cascade the changes */
1229
1230#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +00001231
drhd3d39e92004-05-20 22:16:29 +00001232
1233/*
1234** An instance of the following structure is passed as the first
1235** argument to sqlite3VdbeKeyCompare and is used to control the
1236** comparison of the two index keys.
drhd3d39e92004-05-20 22:16:29 +00001237*/
1238struct KeyInfo {
drhb21c8cd2007-08-21 19:33:56 +00001239 sqlite3 *db; /* The database connection */
danielk1977b1bc9532004-05-22 03:05:33 +00001240 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhe63d9992008-08-13 19:11:48 +00001241 u16 nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +00001242 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +00001243 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
1244};
1245
drh9cfcf5d2002-01-29 18:41:24 +00001246/*
drhe63d9992008-08-13 19:11:48 +00001247** An instance of the following structure holds information about a
1248** single index record that has already been parsed out into individual
1249** values.
1250**
1251** A record is an object that contains one or more fields of data.
1252** Records are used to store the content of a table row and to store
1253** the key of an index. A blob encoding of a record is created by
shane467bcf32008-11-24 20:01:32 +00001254** the OP_MakeRecord opcode of the VDBE and is disassembled by the
drhe63d9992008-08-13 19:11:48 +00001255** OP_Column opcode.
1256**
1257** This structure holds a record that has already been disassembled
shane467bcf32008-11-24 20:01:32 +00001258** into its constituent fields.
drhe63d9992008-08-13 19:11:48 +00001259*/
1260struct UnpackedRecord {
1261 KeyInfo *pKeyInfo; /* Collation and sort-order information */
1262 u16 nField; /* Number of entries in apMem[] */
1263 u16 flags; /* Boolean settings. UNPACKED_... below */
1264 Mem *aMem; /* Values */
1265};
1266
1267/*
1268** Allowed values of UnpackedRecord.flags
1269*/
1270#define UNPACKED_NEED_FREE 0x0001 /* Memory is from sqlite3Malloc() */
1271#define UNPACKED_NEED_DESTROY 0x0002 /* apMem[]s should all be destroyed */
1272#define UNPACKED_IGNORE_ROWID 0x0004 /* Ignore trailing rowid on key1 */
1273#define UNPACKED_INCRKEY 0x0008 /* Make this key an epsilon larger */
1274#define UNPACKED_PREFIX_MATCH 0x0010 /* A prefix match is considered OK */
1275
1276/*
drh66b89c82000-11-28 20:47:17 +00001277** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +00001278** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +00001279**
1280** The columns of the table that are to be indexed are described
1281** by the aiColumn[] field of this structure. For example, suppose
1282** we have the following table and index:
1283**
1284** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1285** CREATE INDEX Ex2 ON Ex1(c3,c1);
1286**
1287** In the Table structure describing Ex1, nCol==3 because there are
1288** three columns in the table. In the Index structure describing
1289** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1290** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
1291** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1292** The second column to be indexed (c1) has an index of 0 in
1293** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +00001294**
1295** The Index.onError field determines whether or not the indexed columns
1296** must be unique and what to do if they are not. When Index.onError=OE_None,
1297** it means this is not a unique index. Otherwise it is a unique index
1298** and the value of Index.onError indicate the which conflict resolution
1299** algorithm to employ whenever an attempt is made to insert a non-unique
1300** element.
drh75897232000-05-29 14:26:00 +00001301*/
1302struct Index {
drh967e8b72000-06-21 13:59:10 +00001303 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +00001304 int nColumn; /* Number of columns in the table used by this index */
1305 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +00001306 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +00001307 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +00001308 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +00001309 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +00001310 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +00001311 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +00001312 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +00001313 Schema *pSchema; /* Schema containing this index */
1314 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
1315 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +00001316};
1317
1318/*
1319** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +00001320** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +00001321**
1322** Note if Token.z==0 then Token.dyn and Token.n are undefined and
shane467bcf32008-11-24 20:01:32 +00001323** may contain random values. Do not make any assumptions about Token.dyn
drh4efc4752004-01-16 15:55:37 +00001324** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +00001325*/
1326struct Token {
drh4c755c02004-08-08 20:22:17 +00001327 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
1328 unsigned dyn : 1; /* True for malloced memory, false for static */
1329 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +00001330};
1331
1332/*
drh13449892005-09-07 21:22:45 +00001333** An instance of this structure contains information needed to generate
1334** code for a SELECT that contains aggregate functions.
1335**
1336** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
1337** pointer to this structure. The Expr.iColumn field is the index in
1338** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
1339** code for that node.
1340**
1341** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
1342** original Select structure that describes the SELECT statement. These
1343** fields do not need to be freed when deallocating the AggInfo structure.
1344*/
1345struct AggInfo {
1346 u8 directMode; /* Direct rendering mode means take data directly
1347 ** from source tables rather than from accumulators */
1348 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
1349 ** than the source table */
1350 int sortingIdx; /* Cursor number of the sorting index */
1351 ExprList *pGroupBy; /* The group by clause */
1352 int nSortingColumn; /* Number of columns in the sorting index */
1353 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +00001354 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +00001355 int iTable; /* Cursor number of the source table */
1356 int iColumn; /* Column number within the source table */
1357 int iSorterColumn; /* Column number in the sorting index */
1358 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +00001359 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +00001360 } *aCol;
1361 int nColumn; /* Number of used entries in aCol[] */
1362 int nColumnAlloc; /* Number of slots allocated for aCol[] */
1363 int nAccumulator; /* Number of columns that show through to the output.
1364 ** Additional columns are used only as parameters to
1365 ** aggregate functions */
1366 struct AggInfo_func { /* For each aggregate function */
1367 Expr *pExpr; /* Expression encoding the function */
1368 FuncDef *pFunc; /* The aggregate function implementation */
1369 int iMem; /* Memory location that acts as accumulator */
shane467bcf32008-11-24 20:01:32 +00001370 int iDistinct; /* Ephemeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +00001371 } *aFunc;
1372 int nFunc; /* Number of entries in aFunc[] */
1373 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
1374};
1375
1376/*
drh75897232000-05-29 14:26:00 +00001377** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +00001378** of this structure.
1379**
danielk19776ab3a2e2009-02-19 14:39:25 +00001380** Expr.op is the opcode. The integer parser token codes are reused
1381** as opcodes here. For example, the parser defines TK_GE to be an integer
1382** code representing the ">=" operator. This same integer code is reused
drh22f70c32002-02-18 01:17:00 +00001383** to represent the greater-than-or-equal-to operator in the expression
1384** tree.
1385**
danielk19776ab3a2e2009-02-19 14:39:25 +00001386** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
1387** or TK_STRING), then Expr.token contains the text of the SQL literal. If
1388** the expression is a variable (TK_VARIABLE), then Expr.token contains the
1389** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
1390** then Expr.token contains the name of the function.
drh22f70c32002-02-18 01:17:00 +00001391**
danielk19776ab3a2e2009-02-19 14:39:25 +00001392** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
1393** binary operator. Either or both may be NULL.
1394**
1395** Expr.x.pList is a list of arguments if the expression is an SQL function,
1396** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
1397** Expr.x.pSelect is used if the expression is a sub-select or an expression of
1398** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
1399** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
1400** valid.
drh22f70c32002-02-18 01:17:00 +00001401**
1402** An expression of the form ID or ID.ID refers to a column in a table.
1403** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
1404** the integer cursor number of a VDBE cursor pointing to that table and
1405** Expr.iColumn is the column number for the specific column. If the
1406** expression is used as a result in an aggregate SELECT, then the
1407** value is also stored in the Expr.iAgg column in the aggregate so that
1408** it can be accessed after all aggregates are computed.
1409**
danielk19776ab3a2e2009-02-19 14:39:25 +00001410** If the expression is an unbound variable marker (a question mark
1411** character '?' in the original SQL) then the Expr.iTable holds the index
1412** number for that variable.
drh22f70c32002-02-18 01:17:00 +00001413**
drh1398ad32005-01-19 23:24:50 +00001414** If the expression is a subquery then Expr.iColumn holds an integer
1415** register number containing the result of the subquery. If the
1416** subquery gives a constant result, then iTable is -1. If the subquery
1417** gives a different answer at different times during statement processing
1418** then iTable is the address of a subroutine that computes the subquery.
1419**
danielk1977aee18ef2005-03-09 12:26:50 +00001420** If the Expr is of type OP_Column, and the table it is selecting from
1421** is a disk table or the "old.*" pseudo-table, then pTab points to the
1422** corresponding table definition.
danielk19776ab3a2e2009-02-19 14:39:25 +00001423**
1424** ALLOCATION NOTES:
1425**
1426** Expr structures may be stored as part of the in-memory database schema,
1427** for example as part of trigger, view or table definitions. In this case,
1428** the amount of memory consumed by complex expressions may be significant.
1429** For this reason, less than sizeof(Expr) bytes may be allocated for some
1430** Expr structs stored as part of the in-memory database schema.
1431**
1432** If the EP_Reduced flag is set in Expr.flags, then only EXPR_REDUCEDSIZE
1433** bytes of space are allocated for the expression structure. This is enough
1434** space to store all fields up to and including the "Token span;" field.
1435**
1436** If the EP_TokenOnly flag is set in Expr.flags, then only EXPR_TOKENONLYSIZE
1437** bytes of space are allocated for the expression structure. This is enough
1438** space to store all fields up to and including the "Token token;" field.
drh75897232000-05-29 14:26:00 +00001439*/
1440struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001441 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001442 char affinity; /* The affinity of the column or 0 if not a column */
drh6a03a1c2006-07-08 18:34:59 +00001443 u16 flags; /* Various flags. See below */
drh75897232000-05-29 14:26:00 +00001444 Token token; /* An operand token */
danielk19776ab3a2e2009-02-19 14:39:25 +00001445
1446 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
1447 ** space is allocated for the fields below this point. An attempt to
1448 ** access them will result in a segfault or malfunction.
1449 *********************************************************************/
1450
drh6977fea2002-10-22 23:38:04 +00001451 Token span; /* Complete text of the expression */
danielk19776ab3a2e2009-02-19 14:39:25 +00001452
1453 /* If the EP_SpanOnly flag is set in the Expr.flags mask, then no
1454 ** space is allocated for the fields below this point. An attempt to
1455 ** access them will result in a segfault or malfunction.
1456 *********************************************************************/
1457
1458 Expr *pLeft; /* Left subnode */
1459 Expr *pRight; /* Right subnode */
1460 union {
1461 ExprList *pList; /* Function arguments or in "<expr> IN (<expr-list)" */
1462 Select *pSelect; /* Used for sub-selects and "<expr> IN (<select>)" */
1463 } x;
1464 CollSeq *pColl; /* The collation type of the column or 0 */
1465
1466 /* If the EP_Reduced flag is set in the Expr.flags mask, then no
1467 ** space is allocated for the fields below this point. An attempt to
1468 ** access them will result in a segfault or malfunction.
1469 *********************************************************************/
1470
drh967e8b72000-06-21 13:59:10 +00001471 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +00001472 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +00001473 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1474 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +00001475 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drh7d10d5a2008-08-20 16:35:10 +00001476 Table *pTab; /* Table for TK_COLUMN expressions. */
drh0224d262008-05-28 13:49:34 +00001477#if SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001478 int nHeight; /* Height of the tree headed by this node */
1479#endif
drh75897232000-05-29 14:26:00 +00001480};
1481
1482/*
drh1f162302002-10-27 19:35:33 +00001483** The following are the meanings of bits in the Expr.flags field.
1484*/
drh678ccce2008-03-31 18:19:54 +00001485#define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */
1486#define EP_Agg 0x0002 /* Contains one or more aggregate functions */
1487#define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */
1488#define EP_Error 0x0008 /* Expression contains one or more errors */
1489#define EP_Distinct 0x0010 /* Aggregate function with DISTINCT keyword */
1490#define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */
1491#define EP_Dequoted 0x0040 /* True if the string has been dequoted */
1492#define EP_InfixFunc 0x0080 /* True for an infix function: LIKE, GLOB, etc */
1493#define EP_ExpCollate 0x0100 /* Collating sequence specified explicitly */
drhda250ea2008-04-01 05:07:14 +00001494#define EP_AnyAff 0x0200 /* Can take a cached column of any affinity */
drh47de9552008-04-01 18:04:11 +00001495#define EP_FixedDest 0x0400 /* Result needed in a specific register */
drh92b01d52008-06-24 00:32:35 +00001496#define EP_IntValue 0x0800 /* Integer value contained in iTable */
danielk19776ab3a2e2009-02-19 14:39:25 +00001497#define EP_xIsSelect 0x1000 /* x.pSelect is valid (otherwise x.pList is) */
1498
1499#define EP_Reduced 0x2000 /* Expr struct is EXPR_REDUCEDSIZE bytes only */
1500#define EP_TokenOnly 0x4000 /* Expr struct is EXPR_TOKENONLYSIZE bytes only */
1501#define EP_SpanOnly 0x8000 /* Expr struct is EXPR_SPANONLYSIZE bytes only */
1502
drh1f162302002-10-27 19:35:33 +00001503/*
1504** These macros can be used to test, set, or clear bits in the
1505** Expr.flags field.
1506*/
1507#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1508#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1509#define ExprSetProperty(E,P) (E)->flags|=(P)
1510#define ExprClearProperty(E,P) (E)->flags&=~(P)
1511
1512/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001513** Macros to determine the number of bytes required by a normal Expr
1514** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
1515** and an Expr struct with the EP_TokenOnly flag set.
1516*/
1517#define EXPR_FULLSIZE sizeof(Expr)
shanece6fa172009-03-02 17:18:48 +00001518#define EXPR_REDUCEDSIZE offsetof(Expr,iTable)
1519#define EXPR_TOKENONLYSIZE offsetof(Expr,span)
1520#define EXPR_SPANONLYSIZE offsetof(Expr,pLeft)
danielk19776ab3a2e2009-02-19 14:39:25 +00001521
1522/*
1523** Flags passed to the sqlite3ExprDup() function. See the header comment
1524** above sqlite3ExprDup() for details.
1525*/
danielk197721822c52009-03-17 17:48:59 +00001526#define EXPRDUP_REDUCE 0x0001
1527#define EXPRDUP_SPAN 0x0002
1528#define EXPRDUP_DISTINCTSPAN 0x0004
danielk19776ab3a2e2009-02-19 14:39:25 +00001529
1530/*
drh75897232000-05-29 14:26:00 +00001531** A list of expressions. Each expression may optionally have a
1532** name. An expr/name combination can be used in several ways, such
1533** as the list of "expr AS ID" fields following a "SELECT" or in the
1534** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001535** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001536** field is not used.
1537*/
1538struct ExprList {
1539 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001540 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001541 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001542 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001543 Expr *pExpr; /* The list of expressions */
1544 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001545 u8 sortOrder; /* 1 for DESC or 0 for ASC */
drh8e2ca022002-06-17 17:07:19 +00001546 u8 done; /* A flag to indicate when processing is finished */
drh7d10d5a2008-08-20 16:35:10 +00001547 u16 iCol; /* For ORDER BY, column number in result set */
drh8b213892008-08-29 02:14:02 +00001548 u16 iAlias; /* Index into Parse.aAlias[] for zName */
drh75897232000-05-29 14:26:00 +00001549 } *a; /* One entry for each expression */
1550};
1551
1552/*
drhad3cab52002-05-24 02:04:32 +00001553** An instance of this structure can hold a simple list of identifiers,
1554** such as the list "a,b,c" in the following statements:
1555**
1556** INSERT INTO t(a,b,c) VALUES ...;
1557** CREATE INDEX idx ON t(a,b,c);
1558** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1559**
1560** The IdList.a.idx field is used when the IdList represents the list of
1561** column names after a table name in an INSERT statement. In the statement
1562**
1563** INSERT INTO t(a,b,c) ...
1564**
1565** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001566*/
1567struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001568 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001569 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001570 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001571 } *a;
drh13449892005-09-07 21:22:45 +00001572 int nId; /* Number of identifiers on the list */
1573 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001574};
1575
1576/*
drh51669862004-12-18 18:40:26 +00001577** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001578**
1579** Changing this from a 64-bit to a 32-bit type limits the number of
1580** tables in a join to 32 instead of 64. But it also reduces the size
1581** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001582*/
drhca83ac52007-02-01 01:40:44 +00001583typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001584
1585/*
danielk197700e13612008-11-17 19:18:54 +00001586** The number of bits in a Bitmask. "BMS" means "BitMask Size".
1587*/
1588#define BMS ((int)(sizeof(Bitmask)*8))
1589
1590/*
drhad3cab52002-05-24 02:04:32 +00001591** The following structure describes the FROM clause of a SELECT statement.
1592** Each table or subquery in the FROM clause is a separate element of
1593** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001594**
1595** With the addition of multiple database support, the following structure
1596** can also be used to describe a particular table such as the table that
1597** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1598** such a table must be a simple name: ID. But in SQLite, the table can
1599** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001600**
1601** The jointype starts out showing the join type between the current table
1602** and the next table on the list. The parser builds the list this way.
1603** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1604** jointype expresses the join between the table and the previous table.
drhad3cab52002-05-24 02:04:32 +00001605*/
1606struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001607 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1608 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001609 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001610 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001611 char *zName; /* Name of the table */
1612 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001613 Table *pTab; /* An SQL table corresponding to zName */
1614 Select *pSelect; /* A SELECT statement used in place of a table name */
danielk19771787cca2006-02-10 07:07:14 +00001615 u8 isPopulated; /* Temporary table associated with SELECT is populated */
drhc49de5d2007-01-19 01:06:01 +00001616 u8 jointype; /* Type of join between this able and the previous */
drhdd5f5a62008-12-23 13:35:23 +00001617 u8 notIndexed; /* True if there is a NOT INDEXED clause */
drhe68fbe72007-02-13 12:49:24 +00001618 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001619 Expr *pOn; /* The ON clause of a join */
1620 IdList *pUsing; /* The USING clause of a join */
danielk1977cd38d522009-01-02 17:33:46 +00001621 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */
danielk197785574e32008-10-06 05:32:18 +00001622 char *zIndex; /* Identifier from "INDEXED BY <zIndex>" clause */
1623 Index *pIndex; /* Index structure corresponding to zIndex, if any */
drh113088e2003-03-20 01:16:58 +00001624 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001625};
1626
1627/*
drh01f3f252002-05-24 16:14:15 +00001628** Permitted values of the SrcList.a.jointype field
1629*/
1630#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001631#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1632#define JT_NATURAL 0x0004 /* True for a "natural" join */
1633#define JT_LEFT 0x0008 /* Left outer join */
1634#define JT_RIGHT 0x0010 /* Right outer join */
1635#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1636#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001637
drh111a6a72008-12-21 03:51:16 +00001638
1639/*
1640** A WherePlan object holds information that describes a lookup
1641** strategy.
1642**
1643** This object is intended to be opaque outside of the where.c module.
1644** It is included here only so that that compiler will know how big it
1645** is. None of the fields in this object should be used outside of
1646** the where.c module.
1647**
1648** Within the union, pIdx is only used when wsFlags&WHERE_INDEXED is true.
1649** pTerm is only used when wsFlags&WHERE_MULTI_OR is true. And pVtabIdx
1650** is only used when wsFlags&WHERE_VIRTUALTABLE is true. It is never the
1651** case that more than one of these conditions is true.
1652*/
1653struct WherePlan {
1654 u32 wsFlags; /* WHERE_* flags that describe the strategy */
1655 u32 nEq; /* Number of == constraints */
1656 union {
1657 Index *pIdx; /* Index when WHERE_INDEXED is true */
1658 struct WhereTerm *pTerm; /* WHERE clause term for OR-search */
1659 sqlite3_index_info *pVtabIdx; /* Virtual table index to use */
1660 } u;
1661};
1662
drh01f3f252002-05-24 16:14:15 +00001663/*
drh6b563442001-11-07 16:48:26 +00001664** For each nested loop in a WHERE clause implementation, the WhereInfo
1665** structure contains a single instance of this structure. This structure
1666** is intended to be private the the where.c module and should not be
1667** access or modified by other modules.
drh6d209d82006-06-27 01:54:26 +00001668**
drh111a6a72008-12-21 03:51:16 +00001669** The pIdxInfo field is used to help pick the best index on a
1670** virtual table. The pIdxInfo pointer contains indexing
drh6d209d82006-06-27 01:54:26 +00001671** information for the i-th table in the FROM clause before reordering.
1672** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
drh111a6a72008-12-21 03:51:16 +00001673** All other information in the i-th WhereLevel object for the i-th table
1674** after FROM clause ordering.
drh6b563442001-11-07 16:48:26 +00001675*/
1676struct WhereLevel {
drh111a6a72008-12-21 03:51:16 +00001677 WherePlan plan; /* query plan for this element of the FROM clause */
drh29dda4a2005-07-21 18:23:20 +00001678 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
drh29dda4a2005-07-21 18:23:20 +00001679 int iTabCur; /* The VDBE cursor used to access the table */
shane467bcf32008-11-24 20:01:32 +00001680 int iIdxCur; /* The VDBE cursor used to access pIdx */
drhb3190c12008-12-08 21:37:14 +00001681 int addrBrk; /* Jump here to break out of the loop */
1682 int addrNxt; /* Jump here to start the next IN combination */
1683 int addrCont; /* Jump here to continue with the next loop cycle */
1684 int addrFirst; /* First instruction of interior of the loop */
drh700a2262008-12-17 19:22:15 +00001685 u8 iFrom; /* Which entry in the FROM clause */
drh111a6a72008-12-21 03:51:16 +00001686 u8 op, p5; /* Opcode and P5 of the opcode that ends the loop */
1687 int p1, p2; /* Operands of the opcode used to ends the loop */
1688 union { /* Information that depends on plan.wsFlags */
1689 struct {
1690 int nIn; /* Number of entries in aInLoop[] */
1691 struct InLoop {
1692 int iCur; /* The VDBE cursor used by this IN operator */
1693 int addrInTop; /* Top of the IN loop */
1694 } *aInLoop; /* Information about each nested IN operator */
1695 } in; /* Used when plan.wsFlags&WHERE_IN_ABLE */
drh111a6a72008-12-21 03:51:16 +00001696 } u;
drh6d209d82006-06-27 01:54:26 +00001697
1698 /* The following field is really not part of the current level. But
drh111a6a72008-12-21 03:51:16 +00001699 ** we need a place to cache virtual table index information for each
1700 ** virtual table in the FROM clause and the WhereLevel structure is
1701 ** a convenient place since there is one WhereLevel for each FROM clause
1702 ** element.
drh6d209d82006-06-27 01:54:26 +00001703 */
1704 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */
drh6b563442001-11-07 16:48:26 +00001705};
1706
drh08c88eb2008-04-10 13:33:18 +00001707/*
drh165be382008-12-05 02:36:33 +00001708** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin().
drh08c88eb2008-04-10 13:33:18 +00001709*/
drh6df2acd2008-12-28 16:55:25 +00001710#define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
1711#define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
1712#define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
1713#define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
1714#define WHERE_FILL_ROWSET 0x0008 /* Save results in a RowSet object */
1715#define WHERE_OMIT_OPEN 0x0010 /* Table cursor are already open */
1716#define WHERE_OMIT_CLOSE 0x0020 /* Omit close of table & index cursors */
danielk1977a9d1ccb2008-01-05 17:39:29 +00001717
drh6b563442001-11-07 16:48:26 +00001718/*
drh75897232000-05-29 14:26:00 +00001719** The WHERE clause processing routine has two halves. The
1720** first part does the start of the WHERE loop and the second
1721** half does the tail of the WHERE loop. An instance of
1722** this structure is returned by the first half and passed
1723** into the second half to give some continuity.
1724*/
1725struct WhereInfo {
drh08c88eb2008-04-10 13:33:18 +00001726 Parse *pParse; /* Parsing and code generating context */
drh6df2acd2008-12-28 16:55:25 +00001727 u16 wctrlFlags; /* Flags originally passed to sqlite3WhereBegin() */
drh08c88eb2008-04-10 13:33:18 +00001728 u8 okOnePass; /* Ok to use one-pass algorithm for UPDATE or DELETE */
drh23d04d52008-12-23 23:56:22 +00001729 int regRowSet; /* Store rowids in this rowset if >=0 */
drh111a6a72008-12-21 03:51:16 +00001730 SrcList *pTabList; /* List of tables in the join */
1731 int iTop; /* The very beginning of the WHERE loop */
1732 int iContinue; /* Jump here to continue with next record */
1733 int iBreak; /* Jump here to break out of the loop */
1734 int nLevel; /* Number of nested loop */
1735 struct WhereClause *pWC; /* Decomposition of the WHERE clause */
drh111a6a72008-12-21 03:51:16 +00001736 WhereLevel a[1]; /* Information about each nest loop in WHERE */
drh75897232000-05-29 14:26:00 +00001737};
1738
1739/*
danielk1977b3bce662005-01-29 08:32:43 +00001740** A NameContext defines a context in which to resolve table and column
1741** names. The context consists of a list of tables (the pSrcList) field and
1742** a list of named expression (pEList). The named expression list may
1743** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1744** to the table being operated on by INSERT, UPDATE, or DELETE. The
1745** pEList corresponds to the result set of a SELECT and is NULL for
1746** other statements.
1747**
1748** NameContexts can be nested. When resolving names, the inner-most
1749** context is searched first. If no match is found, the next outer
1750** context is checked. If there is still no match, the next context
1751** is checked. This process continues until either a match is found
1752** or all contexts are check. When a match is found, the nRef member of
1753** the context containing the match is incremented.
1754**
1755** Each subquery gets a new NameContext. The pNext field points to the
1756** NameContext in the parent query. Thus the process of scanning the
1757** NameContext list corresponds to searching through successively outer
1758** subqueries looking for a match.
1759*/
1760struct NameContext {
1761 Parse *pParse; /* The parser */
1762 SrcList *pSrcList; /* One or more tables used to resolve names */
1763 ExprList *pEList; /* Optional list of named expressions */
1764 int nRef; /* Number of names resolved by this context */
1765 int nErr; /* Number of errors encountered while resolving names */
1766 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001767 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001768 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001769 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001770 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001771 NameContext *pNext; /* Next outer name context. NULL for outermost */
1772};
1773
1774/*
drh9bb61fe2000-06-05 16:01:39 +00001775** An instance of the following structure contains all information
1776** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001777**
drhd11d3822002-06-21 23:01:49 +00001778** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1779** If there is a LIMIT clause, the parser sets nLimit to the value of the
1780** limit and nOffset to the value of the offset (or 0 if there is not
1781** offset). But later on, nLimit and nOffset become the memory locations
1782** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001783**
drhb9bb7c12006-06-11 23:41:55 +00001784** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00001785** These addresses must be stored so that we can go back and fill in
drh66a51672008-01-03 00:01:23 +00001786** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
drh0342b1f2005-09-01 03:07:44 +00001787** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00001788** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00001789** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00001790** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1791** for the result set. The KeyInfo for addrOpenTran[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00001792** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001793*/
1794struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001795 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001796 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
drh6c1426f2007-04-12 03:54:38 +00001797 char affinity; /* MakeRecord with this affinity for SRT_Set */
drh7d10d5a2008-08-20 16:35:10 +00001798 u16 selFlags; /* Various SF_* values */
drhad3cab52002-05-24 02:04:32 +00001799 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001800 Expr *pWhere; /* The WHERE clause */
1801 ExprList *pGroupBy; /* The GROUP BY clause */
1802 Expr *pHaving; /* The HAVING clause */
1803 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001804 Select *pPrior; /* Prior select in a compound select statement */
drh1e281292007-12-13 03:45:07 +00001805 Select *pNext; /* Next select to the left in a compound */
drh0342b1f2005-09-01 03:07:44 +00001806 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001807 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1808 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001809 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drhb9bb7c12006-06-11 23:41:55 +00001810 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001811};
1812
1813/*
drh7d10d5a2008-08-20 16:35:10 +00001814** Allowed values for Select.selFlags. The "SF" prefix stands for
1815** "Select Flag".
1816*/
1817#define SF_Distinct 0x0001 /* Output should be DISTINCT */
1818#define SF_Resolved 0x0002 /* Identifiers have been resolved */
1819#define SF_Aggregate 0x0004 /* Contains aggregate functions */
1820#define SF_UsesEphemeral 0x0008 /* Uses the OpenEphemeral opcode */
1821#define SF_Expanded 0x0010 /* sqlite3SelectExpand() called on this */
1822#define SF_HasTypeInfo 0x0020 /* FROM subqueries have Table metadata */
1823
1824
1825/*
1826** The results of a select can be distributed in several ways. The
1827** "SRT" prefix means "SELECT Result Type".
drhfef52082000-06-06 01:50:43 +00001828*/
drh13449892005-09-07 21:22:45 +00001829#define SRT_Union 1 /* Store result as keys in an index */
1830#define SRT_Except 2 /* Remove result from a UNION index */
danielk19779ed1dfa2008-01-02 17:11:14 +00001831#define SRT_Exists 3 /* Store 1 if the result is not empty */
1832#define SRT_Discard 4 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001833
drh13449892005-09-07 21:22:45 +00001834/* The ORDER BY clause is ignored for all of the above */
danielk19776c8c8ce2008-01-02 16:27:09 +00001835#define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
drh13449892005-09-07 21:22:45 +00001836
drh7d10d5a2008-08-20 16:35:10 +00001837#define SRT_Output 5 /* Output each row of result */
danielk19779ed1dfa2008-01-02 17:11:14 +00001838#define SRT_Mem 6 /* Store result in a memory cell */
danielk19770cdc0222008-06-26 18:04:03 +00001839#define SRT_Set 7 /* Store results as keys in an index */
danielk19779ed1dfa2008-01-02 17:11:14 +00001840#define SRT_Table 8 /* Store result as data with an automatic rowid */
1841#define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */
drhe00ee6e2008-06-20 15:24:01 +00001842#define SRT_Coroutine 10 /* Generate a single row of result */
drh22827922000-06-06 17:27:05 +00001843
1844/*
shane467bcf32008-11-24 20:01:32 +00001845** A structure used to customize the behavior of sqlite3Select(). See
danielk19776c8c8ce2008-01-02 16:27:09 +00001846** comments above sqlite3Select() for details.
1847*/
1848typedef struct SelectDest SelectDest;
1849struct SelectDest {
drh477df4b2008-01-05 18:48:24 +00001850 u8 eDest; /* How to dispose of the results */
1851 u8 affinity; /* Affinity used when eDest==SRT_Set */
danielk19776c8c8ce2008-01-02 16:27:09 +00001852 int iParm; /* A parameter used by the eDest disposal method */
drh1013c932008-01-06 00:25:21 +00001853 int iMem; /* Base register where results are written */
drhad27e762008-03-26 12:46:23 +00001854 int nMem; /* Number of registers allocated */
danielk19776c8c8ce2008-01-02 16:27:09 +00001855};
1856
1857/*
drhf57b3392001-10-08 13:22:32 +00001858** An SQL parser context. A copy of this structure is passed through
1859** the parser and down into all the parser action routine in order to
1860** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001861**
1862** The structure is divided into two parts. When the parser and code
1863** generate call themselves recursively, the first part of the structure
1864** is constant but the second part is reset at the beginning and end of
1865** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001866**
1867** The nTableLock and aTableLock variables are only used if the shared-cache
1868** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1869** used to store the set of table-locks required by the statement being
1870** compiled. Function sqlite3TableLock() is used to add entries to the
1871** list.
drh75897232000-05-29 14:26:00 +00001872*/
1873struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001874 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001875 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001876 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001877 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001878 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001879 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001880 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001881 u8 nested; /* Number of nested calls to the parser/code generator */
drh7e326c02007-05-15 16:51:37 +00001882 u8 parseError; /* True after a parsing error. Ticket #1794 */
drh892d3172008-01-10 03:46:36 +00001883 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
drh2dcef112008-01-12 19:03:48 +00001884 u8 nTempInUse; /* Number of aTempReg[] currently checked out */
drh892d3172008-01-10 03:46:36 +00001885 int aTempReg[8]; /* Holding area for temporary registers */
1886 int nRangeReg; /* Size of the temporary register block */
1887 int iRangeReg; /* First register in temporary register block */
drh75897232000-05-29 14:26:00 +00001888 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001889 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001890 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001891 int nSet; /* Number of sets used so far */
drhaa9b8962008-01-08 02:57:55 +00001892 int ckBase; /* Base register of data during check constraints */
drhe55cbd72008-03-31 23:48:03 +00001893 int disableColCache; /* True to disable adding to column cache */
1894 int nColCache; /* Number of entries in the column cache */
1895 int iColCache; /* Next entry of the cache to replace */
drh2f7794c2008-04-01 03:27:39 +00001896 struct yColCache {
drhe55cbd72008-03-31 23:48:03 +00001897 int iTable; /* Table cursor number */
1898 int iColumn; /* Table column number */
drhda250ea2008-04-01 05:07:14 +00001899 char affChange; /* True if this register has had an affinity change */
drhe55cbd72008-03-31 23:48:03 +00001900 int iReg; /* Register holding value of this column */
1901 } aColCache[10]; /* One for each valid column cache entry */
drh80242052004-06-09 00:48:12 +00001902 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001903 u32 cookieMask; /* Bitmask of schema verified databases */
1904 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
drhc797d4d2007-05-08 01:08:49 +00001905 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001906#ifndef SQLITE_OMIT_SHARED_CACHE
1907 int nTableLock; /* Number of locks in aTableLock */
1908 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1909#endif
danielk1977cac336a2008-03-08 06:16:29 +00001910 int regRowid; /* Register holding rowid of CREATE TABLE entry */
1911 int regRoot; /* Register holding root page number for new objects */
drhf1974842004-11-05 03:56:00 +00001912
1913 /* Above is constant between recursions. Below is reset before and after
1914 ** each recursion */
1915
1916 int nVar; /* Number of '?' variables seen in the SQL so far */
1917 int nVarExpr; /* Number of used slots in apVarExpr[] */
1918 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1919 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
drh8b213892008-08-29 02:14:02 +00001920 int nAlias; /* Number of aliased result set columns */
drh555f8de2008-12-08 13:42:36 +00001921 int nAliasAlloc; /* Number of allocated slots for aAlias[] */
drh8b213892008-08-29 02:14:02 +00001922 int *aAlias; /* Register used to hold aliased result */
drhf1974842004-11-05 03:56:00 +00001923 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001924 Token sErrToken; /* The token at which the error occurred */
1925 Token sNameToken; /* Token with unqualified schema object name */
1926 Token sLastToken; /* The last token parsed */
1927 const char *zSql; /* All SQL text */
1928 const char *zTail; /* All SQL text past the last semicolon parsed */
1929 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1930 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1931 TriggerStack *trigStack; /* Trigger actions being coded */
1932 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drhb9bb7c12006-06-11 23:41:55 +00001933#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk197733b39332006-06-24 08:51:05 +00001934 Token sArg; /* Complete text of a module argument */
danielk1977f9e7dda2006-06-16 16:08:53 +00001935 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
drh4f3dd152008-04-28 18:46:43 +00001936 int nVtabLock; /* Number of virtual tables to lock */
1937 Table **apVtabLock; /* Pointer to virtual tables needing locking */
drhb9bb7c12006-06-11 23:41:55 +00001938#endif
danielk1977fc976062007-05-10 10:46:56 +00001939 int nHeight; /* Expression tree height of current sub-select */
drh588a9a12008-09-01 15:52:10 +00001940 Table *pZombieTab; /* List of Table objects to delete after code gen */
drh75897232000-05-29 14:26:00 +00001941};
1942
danielk19777e6ebfb2006-06-12 11:24:37 +00001943#ifdef SQLITE_OMIT_VIRTUALTABLE
1944 #define IN_DECLARE_VTAB 0
1945#else
1946 #define IN_DECLARE_VTAB (pParse->declareVtab)
1947#endif
1948
danielk1977d99bc932002-05-16 00:13:12 +00001949/*
drh85e20962003-04-25 17:52:11 +00001950** An instance of the following structure can be declared on a stack and used
1951** to save the Parse.zAuthContext value so that it can be restored later.
1952*/
1953struct AuthContext {
1954 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1955 Parse *pParse; /* The Parse structure */
1956};
1957
1958/*
drhf0863fe2005-06-12 21:35:51 +00001959** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001960*/
1961#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1962#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001963#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
drhe4d90812007-03-29 05:51:49 +00001964#define OPFLAG_APPEND 8 /* This is likely to be an append */
rdcb0c374f2004-02-20 22:53:38 +00001965
1966/*
danielk1977d99bc932002-05-16 00:13:12 +00001967 * Each trigger present in the database schema is stored as an instance of
1968 * struct Trigger.
1969 *
1970 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001971 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001972 * database). This allows Trigger structures to be retrieved by name.
1973 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001974 * pNext member of struct Trigger. A pointer to the first element of the
1975 * linked list is stored as the "pTrigger" member of the associated
1976 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001977 *
drhad3cab52002-05-24 02:04:32 +00001978 * The "step_list" member points to the first element of a linked list
1979 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001980 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001981struct Trigger {
drhdc379452002-05-15 12:45:43 +00001982 char *name; /* The name of the trigger */
1983 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001984 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001985 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
shane467bcf32008-11-24 20:01:32 +00001986 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
drhdc379452002-05-15 12:45:43 +00001987 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001988 the <column-list> is stored here */
drh4312db52003-06-03 01:47:11 +00001989 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001990 Schema *pSchema; /* Schema containing the trigger */
1991 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001992 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001993 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001994};
1995
danielk1977d99bc932002-05-16 00:13:12 +00001996/*
drhdca76842004-12-07 14:06:13 +00001997** A trigger is either a BEFORE or an AFTER trigger. The following constants
1998** determine which.
1999**
2000** If there are multiple triggers, you might of some BEFORE and some AFTER.
2001** In that cases, the constants below can be ORed together.
2002*/
2003#define TRIGGER_BEFORE 1
2004#define TRIGGER_AFTER 2
2005
2006/*
danielk1977d99bc932002-05-16 00:13:12 +00002007 * An instance of struct TriggerStep is used to store a single SQL statement
2008 * that is a part of a trigger-program.
2009 *
2010 * Instances of struct TriggerStep are stored in a singly linked list (linked
2011 * using the "pNext" member) referenced by the "step_list" member of the
2012 * associated struct Trigger instance. The first element of the linked list is
2013 * the first step of the trigger-program.
2014 *
2015 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
2016 * "SELECT" statement. The meanings of the other members is determined by the
2017 * value of "op" as follows:
2018 *
2019 * (op == TK_INSERT)
2020 * orconf -> stores the ON CONFLICT algorithm
2021 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
2022 * this stores a pointer to the SELECT statement. Otherwise NULL.
2023 * target -> A token holding the name of the table to insert into.
2024 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
2025 * this stores values to be inserted. Otherwise NULL.
2026 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00002027 * statement, then this stores the column-names to be
2028 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00002029 *
2030 * (op == TK_DELETE)
2031 * target -> A token holding the name of the table to delete from.
2032 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
2033 * Otherwise NULL.
2034 *
2035 * (op == TK_UPDATE)
2036 * target -> A token holding the name of the table to update rows of.
2037 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
2038 * Otherwise NULL.
2039 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00002040 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00002041 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00002042 *
2043 */
2044struct TriggerStep {
2045 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
2046 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00002047 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00002048
danielk1977d99bc932002-05-16 00:13:12 +00002049 Select *pSelect; /* Valid for SELECT and sometimes
drhfd131da2007-08-07 17:13:03 +00002050 INSERT steps (when pExprList == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00002051 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
2052 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
2053 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
drhfd131da2007-08-07 17:13:03 +00002054 INSERT steps (when pSelect == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00002055 IdList *pIdList; /* Valid for INSERT statements only */
drh187e4c62006-02-27 22:22:27 +00002056 TriggerStep *pNext; /* Next in the link-list */
2057 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00002058};
2059
2060/*
2061 * An instance of struct TriggerStack stores information required during code
2062 * generation of a single trigger program. While the trigger program is being
2063 * coded, its associated TriggerStack instance is pointed to by the
2064 * "pTriggerStack" member of the Parse structure.
2065 *
2066 * The pTab member points to the table that triggers are being coded on. The
2067 * newIdx member contains the index of the vdbe cursor that points at the temp
2068 * table that stores the new.* references. If new.* references are not valid
2069 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
2070 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
2071 *
2072 * The ON CONFLICT policy to be used for the trigger program steps is stored
2073 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
2074 * specified for individual triggers steps is used.
2075 *
2076 * struct TriggerStack has a "pNext" member, to allow linked lists to be
2077 * constructed. When coding nested triggers (triggers fired by other triggers)
2078 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
2079 * pointer. Once the nested trigger has been coded, the pNext value is restored
2080 * to the pTriggerStack member of the Parse stucture and coding of the parent
2081 * trigger continues.
2082 *
2083 * Before a nested trigger is coded, the linked list pointed to by the
2084 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
2085 * recursively. If this condition is detected, the nested trigger is not coded.
2086 */
2087struct TriggerStack {
2088 Table *pTab; /* Table that triggers are currently being coded on */
2089 int newIdx; /* Index of vdbe cursor to "new" temp table */
2090 int oldIdx; /* Index of vdbe cursor to "old" temp table */
danielk19778f2c54e2008-01-01 19:02:09 +00002091 u32 newColMask;
2092 u32 oldColMask;
danielk1977d99bc932002-05-16 00:13:12 +00002093 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00002094 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00002095 Trigger *pTrigger; /* The trigger currently being coded */
2096 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00002097};
2098
2099/*
drhf26e09c2003-05-31 16:21:12 +00002100** The following structure contains information used by the sqliteFix...
2101** routines as they walk the parse tree to make database references
2102** explicit.
2103*/
2104typedef struct DbFixer DbFixer;
2105struct DbFixer {
2106 Parse *pParse; /* The parsing context. Error messages written here */
2107 const char *zDb; /* Make sure all objects are contained in this database */
2108 const char *zType; /* Type of the container - used for error messages */
2109 const Token *pName; /* Name of the container - used for error messages */
2110};
2111
2112/*
drhade86482007-11-28 22:36:40 +00002113** An objected used to accumulate the text of a string where we
2114** do not necessarily know how big the string will be in the end.
2115*/
2116struct StrAccum {
drh633e6d52008-07-28 19:34:53 +00002117 sqlite3 *db; /* Optional database for lookaside. Can be NULL */
2118 char *zBase; /* A base allocation. Not from malloc. */
2119 char *zText; /* The string collected so far */
2120 int nChar; /* Length of the string so far */
2121 int nAlloc; /* Amount of space allocated in zText */
drhbb4957f2008-03-20 14:03:29 +00002122 int mxAlloc; /* Maximum allowed string length */
drhade86482007-11-28 22:36:40 +00002123 u8 mallocFailed; /* Becomes true if any memory allocation fails */
shane467bcf32008-11-24 20:01:32 +00002124 u8 useMalloc; /* True if zText is enlargeable using realloc */
drhade86482007-11-28 22:36:40 +00002125 u8 tooBig; /* Becomes true if string size exceeds limits */
2126};
2127
2128/*
drh234c39d2004-07-24 03:30:47 +00002129** A pointer to this structure is used to communicate information
2130** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
2131*/
2132typedef struct {
drh9bb575f2004-09-06 17:24:11 +00002133 sqlite3 *db; /* The database being initialized */
drhece3c722006-09-23 20:36:01 +00002134 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh234c39d2004-07-24 03:30:47 +00002135 char **pzErrMsg; /* Error message stored here */
drh15ca1df2006-07-26 13:43:30 +00002136 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00002137} InitData;
2138
drhb6c29892004-11-22 19:12:19 +00002139/*
drh40257ff2008-06-13 18:24:27 +00002140** Structure containing global configuration data for the SQLite library.
drh33589792008-06-18 13:27:46 +00002141**
2142** This structure also contains some state information.
drh40257ff2008-06-13 18:24:27 +00002143*/
2144struct Sqlite3Config {
drhfec00ea2008-06-14 16:56:21 +00002145 int bMemstat; /* True to enable memory status */
2146 int bCoreMutex; /* True to enable core mutexing */
2147 int bFullMutex; /* True to enable full mutexing */
drh0a687d12008-07-08 14:52:07 +00002148 int mxStrlen; /* Maximum string length */
drh633e6d52008-07-28 19:34:53 +00002149 int szLookaside; /* Default lookaside buffer size */
2150 int nLookaside; /* Default lookaside buffer count */
drhfec00ea2008-06-14 16:56:21 +00002151 sqlite3_mem_methods m; /* Low-level memory allocation interface */
danielk19776d2ab0e2008-06-17 17:21:18 +00002152 sqlite3_mutex_methods mutex; /* Low-level mutex interface */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002153 sqlite3_pcache_methods pcache; /* Low-level page-cache interface */
drh40257ff2008-06-13 18:24:27 +00002154 void *pHeap; /* Heap storage space */
drh33589792008-06-18 13:27:46 +00002155 int nHeap; /* Size of pHeap[] */
2156 int mnReq, mxReq; /* Min and max heap requests sizes */
2157 void *pScratch; /* Scratch memory */
2158 int szScratch; /* Size of each scratch buffer */
2159 int nScratch; /* Number of scratch buffers */
2160 void *pPage; /* Page cache memory */
2161 int szPage; /* Size of each page in pPage[] */
2162 int nPage; /* Number of pages in pPage[] */
drh1875f7a2008-12-08 18:19:17 +00002163 int mxParserStack; /* maximum depth of the parser stack */
2164 int sharedCacheEnabled; /* true if shared-cache mode enabled */
2165 /* The above might be initialized to non-zero. The following need to always
2166 ** initially be zero, however. */
danielk197771bc31c2008-06-26 08:29:34 +00002167 int isInit; /* True after initialization has finished */
danielk1977502b4e02008-09-02 14:07:24 +00002168 int inProgress; /* True while initialization in progress */
danielk197771bc31c2008-06-26 08:29:34 +00002169 int isMallocInit; /* True after malloc is initialized */
2170 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
drh93ed56d2008-08-12 15:21:11 +00002171 int nRefInitMutex; /* Number of users of pInitMutex */
drh40257ff2008-06-13 18:24:27 +00002172};
2173
2174/*
drh7d10d5a2008-08-20 16:35:10 +00002175** Context pointer passed down through the tree-walk.
2176*/
2177struct Walker {
2178 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
2179 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
2180 Parse *pParse; /* Parser context. */
2181 union { /* Extra data for callback */
2182 NameContext *pNC; /* Naming context */
2183 int i; /* Integer value */
2184 } u;
2185};
2186
2187/* Forward declarations */
2188int sqlite3WalkExpr(Walker*, Expr*);
2189int sqlite3WalkExprList(Walker*, ExprList*);
2190int sqlite3WalkSelect(Walker*, Select*);
2191int sqlite3WalkSelectExpr(Walker*, Select*);
2192int sqlite3WalkSelectFrom(Walker*, Select*);
2193
2194/*
2195** Return code from the parse-tree walking primitives and their
2196** callbacks.
2197*/
drh2bf90f12008-12-09 13:04:29 +00002198#define WRC_Continue 0 /* Continue down into children */
2199#define WRC_Prune 1 /* Omit children but continue walking siblings */
2200#define WRC_Abort 2 /* Abandon the tree walk */
drh7d10d5a2008-08-20 16:35:10 +00002201
2202/*
drh66150952007-07-23 19:12:41 +00002203** Assuming zIn points to the first byte of a UTF-8 character,
2204** advance zIn to point to the first byte of the next UTF-8 character.
drh4a919112007-05-15 11:55:09 +00002205*/
drh4a919112007-05-15 11:55:09 +00002206#define SQLITE_SKIP_UTF8(zIn) { \
2207 if( (*(zIn++))>=0xc0 ){ \
2208 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
2209 } \
2210}
2211
drh4a919112007-05-15 11:55:09 +00002212/*
drh49285702005-09-17 15:20:26 +00002213** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
2214** builds) or a function call (for debugging). If it is a function call,
2215** it allows the operator to set a breakpoint at the spot where database
2216** corruption is first detected.
2217*/
2218#ifdef SQLITE_DEBUG
drh6e736832007-05-11 12:30:03 +00002219 int sqlite3Corrupt(void);
drh49285702005-09-17 15:20:26 +00002220# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
2221#else
2222# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
2223#endif
2224
2225/*
danielk197778ca0e72009-01-20 16:53:39 +00002226** The following macros mimic the standard library functions toupper(),
2227** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
2228** sqlite versions only work for ASCII characters, regardless of locale.
2229*/
2230#ifdef SQLITE_ASCII
2231# define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
2232# define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
drhdc86e2b2009-01-24 11:30:42 +00002233# define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
2234# define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
danielk197778ca0e72009-01-20 16:53:39 +00002235# define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
2236# define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
2237# define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)])
2238#else
2239# include <ctype.h>
2240# define sqlite3Toupper(x) toupper((unsigned char)(x))
2241# define sqlite3Isspace(x) isspace((unsigned char)(x))
2242# define sqlite3Isalnum(x) isalnum((unsigned char)(x))
drhdc86e2b2009-01-24 11:30:42 +00002243# define sqlite3Isalpha(x) isalpha((unsigned char)(x))
danielk197778ca0e72009-01-20 16:53:39 +00002244# define sqlite3Isdigit(x) isdigit((unsigned char)(x))
2245# define sqlite3Isxdigit(x) isxdigit((unsigned char)(x))
2246# define sqlite3Tolower(x) tolower((unsigned char)(x))
2247#endif
2248
2249/*
drh75897232000-05-29 14:26:00 +00002250** Internal function prototypes
2251*/
danielk19774adee202004-05-08 08:23:19 +00002252int sqlite3StrICmp(const char *, const char *);
2253int sqlite3StrNICmp(const char *, const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00002254int sqlite3IsNumber(const char*, int*, u8);
drh0a687d12008-07-08 14:52:07 +00002255int sqlite3Strlen(sqlite3*, const char*);
drhea678832008-12-10 19:26:22 +00002256int sqlite3Strlen30(const char*);
danielk19772e588c72005-12-09 14:25:08 +00002257
drh40257ff2008-06-13 18:24:27 +00002258int sqlite3MallocInit(void);
drhfec00ea2008-06-14 16:56:21 +00002259void sqlite3MallocEnd(void);
2260void *sqlite3Malloc(int);
2261void *sqlite3MallocZero(int);
2262void *sqlite3DbMallocZero(sqlite3*, int);
2263void *sqlite3DbMallocRaw(sqlite3*, int);
drh17435752007-08-16 04:30:38 +00002264char *sqlite3DbStrDup(sqlite3*,const char*);
2265char *sqlite3DbStrNDup(sqlite3*,const char*, int);
drhfec00ea2008-06-14 16:56:21 +00002266void *sqlite3Realloc(void*, int);
drh97c8ec32007-08-27 21:49:34 +00002267void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
danielk1977a1644fd2007-08-29 12:31:25 +00002268void *sqlite3DbRealloc(sqlite3 *, void *, int);
drh633e6d52008-07-28 19:34:53 +00002269void sqlite3DbFree(sqlite3*, void*);
2270int sqlite3MallocSize(void*);
2271int sqlite3DbMallocSize(sqlite3*, void*);
drhfacf0302008-06-17 15:12:00 +00002272void *sqlite3ScratchMalloc(int);
2273void sqlite3ScratchFree(void*);
2274void *sqlite3PageMalloc(int);
2275void sqlite3PageFree(void*);
drhfec00ea2008-06-14 16:56:21 +00002276void sqlite3MemSetDefault(void);
danielk1977171bfed2008-06-23 09:50:50 +00002277void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
shane4a27a282008-09-04 04:32:49 +00002278int sqlite3MemoryAlarm(void (*)(void*, sqlite3_int64, int), void*, sqlite3_int64);
danielk19772e588c72005-12-09 14:25:08 +00002279
danielk1977f3d3c272008-11-19 16:52:44 +00002280#ifdef SQLITE_ENABLE_MEMSYS3
2281const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
2282#endif
2283#ifdef SQLITE_ENABLE_MEMSYS5
2284const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
2285#endif
2286
2287
drh18472fa2008-10-07 15:25:48 +00002288#ifndef SQLITE_MUTEX_OMIT
drh65bbf292008-06-19 01:03:17 +00002289 sqlite3_mutex_methods *sqlite3DefaultMutex(void);
2290 sqlite3_mutex *sqlite3MutexAlloc(int);
2291 int sqlite3MutexInit(void);
2292 int sqlite3MutexEnd(void);
2293#endif
danielk19776d2ab0e2008-06-17 17:21:18 +00002294
drhf7141992008-06-19 00:16:08 +00002295int sqlite3StatusValue(int);
2296void sqlite3StatusAdd(int, int);
2297void sqlite3StatusSet(int, int);
2298
drh0de3ae92008-04-28 16:55:26 +00002299int sqlite3IsNaN(double);
2300
drhf089aa42008-07-08 19:34:06 +00002301void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
drh17435752007-08-16 04:30:38 +00002302char *sqlite3MPrintf(sqlite3*,const char*, ...);
2303char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
drh633e6d52008-07-28 19:34:53 +00002304char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
drh87cc3b32007-05-08 21:45:27 +00002305#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
2306 void sqlite3DebugPrintf(const char*, ...);
drhd919fe12007-12-11 19:34:44 +00002307#endif
2308#if defined(SQLITE_TEST)
drhe8f52c52008-07-12 14:52:20 +00002309 void *sqlite3TestTextToPtr(const char*);
drh87cc3b32007-05-08 21:45:27 +00002310#endif
drhf089aa42008-07-08 19:34:06 +00002311void sqlite3SetString(char **, sqlite3*, const char*, ...);
danielk19774adee202004-05-08 08:23:19 +00002312void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00002313void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00002314void sqlite3Dequote(char*);
drh17435752007-08-16 04:30:38 +00002315void sqlite3DequoteExpr(sqlite3*, Expr*);
drh2646da72005-12-09 20:02:05 +00002316int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00002317int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00002318void sqlite3FinishCoding(Parse*);
drh892d3172008-01-10 03:46:36 +00002319int sqlite3GetTempReg(Parse*);
2320void sqlite3ReleaseTempReg(Parse*,int);
2321int sqlite3GetTempRange(Parse*,int);
2322void sqlite3ReleaseTempRange(Parse*,int,int);
danielk1977a1644fd2007-08-29 12:31:25 +00002323Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
drh17435752007-08-16 04:30:38 +00002324Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00002325Expr *sqlite3RegisterExpr(Parse*,Token*);
danielk19771e536952007-08-16 10:09:01 +00002326Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00002327void sqlite3ExprSpan(Expr*,Token*,Token*);
drh17435752007-08-16 04:30:38 +00002328Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00002329void sqlite3ExprAssignVarNumber(Parse*, Expr*);
drh10fe8402008-10-11 16:47:35 +00002330void sqlite3ExprClear(sqlite3*, Expr*);
drh633e6d52008-07-28 19:34:53 +00002331void sqlite3ExprDelete(sqlite3*, Expr*);
drh17435752007-08-16 04:30:38 +00002332ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
drh633e6d52008-07-28 19:34:53 +00002333void sqlite3ExprListDelete(sqlite3*, ExprList*);
drh9bb575f2004-09-06 17:24:11 +00002334int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00002335int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00002336void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00002337void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00002338void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00002339void sqlite3CommitInternalChanges(sqlite3*);
drh7d10d5a2008-08-20 16:35:10 +00002340Table *sqlite3ResultSetOfSelect(Parse*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00002341void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00002342void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00002343void sqlite3AddColumn(Parse*,Token*);
2344void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00002345void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00002346void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00002347void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00002348void sqlite3AddDefaultValue(Parse*,Expr*);
danielk197739002502007-11-12 09:50:26 +00002349void sqlite3AddCollateType(Parse*, Token*);
danielk197719a8e7e2005-03-17 05:03:38 +00002350void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00002351
drhf5e7bb52008-02-18 14:47:33 +00002352Bitvec *sqlite3BitvecCreate(u32);
2353int sqlite3BitvecTest(Bitvec*, u32);
2354int sqlite3BitvecSet(Bitvec*, u32);
2355void sqlite3BitvecClear(Bitvec*, u32);
2356void sqlite3BitvecDestroy(Bitvec*);
danielk1977bea2a942009-01-20 17:06:27 +00002357u32 sqlite3BitvecSize(Bitvec*);
drh3088d592008-03-21 16:45:47 +00002358int sqlite3BitvecBuiltinTest(int,int*);
drhf5e7bb52008-02-18 14:47:33 +00002359
drh3d4501e2008-12-04 20:40:10 +00002360RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
2361void sqlite3RowSetClear(RowSet*);
2362void sqlite3RowSetInsert(RowSet*, i64);
2363int sqlite3RowSetNext(RowSet*, i64*);
2364
drhfdd48a72006-09-11 23:45:48 +00002365void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00002366
2367#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00002368 int sqlite3ViewGetColumnNames(Parse*,Table*);
2369#else
2370# define sqlite3ViewGetColumnNames(A,B) 0
2371#endif
2372
drha0733842005-12-29 01:11:36 +00002373void sqlite3DropTable(Parse*, SrcList*, int, int);
danielk1977a04a34f2007-04-16 15:06:25 +00002374void sqlite3DeleteTable(Table*);
danielk19774adee202004-05-08 08:23:19 +00002375void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh17435752007-08-16 04:30:38 +00002376void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
2377IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
danielk19774adee202004-05-08 08:23:19 +00002378int sqlite3IdListIndex(IdList*,const char*);
drha78c22c2008-11-11 18:28:58 +00002379SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
drh17435752007-08-16 04:30:38 +00002380SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
danielk1977b1c685b2008-10-06 16:18:39 +00002381SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
danielk197785574e32008-10-06 05:32:18 +00002382 Token*, Select*, Expr*, IdList*);
danielk1977b1c685b2008-10-06 16:18:39 +00002383void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
2384int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
drh61dfc312006-12-16 16:25:15 +00002385void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002386void sqlite3SrcListAssignCursors(Parse*, SrcList*);
drh633e6d52008-07-28 19:34:53 +00002387void sqlite3IdListDelete(sqlite3*, IdList*);
2388void sqlite3SrcListDelete(sqlite3*, SrcList*);
danielk19770202b292004-06-09 09:55:16 +00002389void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00002390 Token*, int, int);
2391void sqlite3DropIndex(Parse*, SrcList*, int);
drh7d10d5a2008-08-20 16:35:10 +00002392int sqlite3Select(Parse*, Select*, SelectDest*);
drh17435752007-08-16 04:30:38 +00002393Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
2394 Expr*,ExprList*,int,Expr*,Expr*);
drh633e6d52008-07-28 19:34:53 +00002395void sqlite3SelectDelete(sqlite3*, Select*);
danielk19774adee202004-05-08 08:23:19 +00002396Table *sqlite3SrcListLookup(Parse*, SrcList*);
2397int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00002398void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
shane273f6192008-10-10 04:34:16 +00002399#if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
shane49ffdbf2008-10-10 18:25:45 +00002400Expr *sqlite3LimitWhere(Parse *, SrcList *, Expr *, ExprList *, Expr *, Expr *, char *);
shane4281bd42008-10-07 05:27:11 +00002401#endif
danielk19774adee202004-05-08 08:23:19 +00002402void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
2403void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drh23d04d52008-12-23 23:56:22 +00002404WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8, int);
danielk19774adee202004-05-08 08:23:19 +00002405void sqlite3WhereEnd(WhereInfo*);
drhda250ea2008-04-01 05:07:14 +00002406int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
drhb21e7c72008-06-22 12:37:57 +00002407void sqlite3ExprCodeMove(Parse*, int, int, int);
drh92b01d52008-06-24 00:32:35 +00002408void sqlite3ExprCodeCopy(Parse*, int, int, int);
drhe55cbd72008-03-31 23:48:03 +00002409void sqlite3ExprClearColumnCache(Parse*, int);
drhda250ea2008-04-01 05:07:14 +00002410void sqlite3ExprCacheAffinityChange(Parse*, int, int);
drhd1fa7bc2009-01-10 13:24:50 +00002411void sqlite3ExprWritableRegister(Parse*,int);
drh191b54c2008-04-15 12:14:21 +00002412void sqlite3ExprHardCopy(Parse*,int,int);
drh389a1ad2008-01-03 23:44:53 +00002413int sqlite3ExprCode(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00002414int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
drh678ccce2008-03-31 18:19:54 +00002415int sqlite3ExprCodeTarget(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00002416int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
drh678ccce2008-03-31 18:19:54 +00002417void sqlite3ExprCodeConstants(Parse*, Expr*);
drh191b54c2008-04-15 12:14:21 +00002418int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
danielk19774adee202004-05-08 08:23:19 +00002419void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
2420void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh9bb575f2004-09-06 17:24:11 +00002421Table *sqlite3FindTable(sqlite3*,const char*, const char*);
drhca424112008-01-25 15:04:48 +00002422Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00002423Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
2424void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
2425void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00002426void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00002427int sqlite3RunVacuum(char**, sqlite3*);
drh17435752007-08-16 04:30:38 +00002428char *sqlite3NameFromToken(sqlite3*, Token*);
danielk19774adee202004-05-08 08:23:19 +00002429int sqlite3ExprCompare(Expr*, Expr*);
drhd2b3e232008-01-23 14:51:49 +00002430void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2431void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00002432Vdbe *sqlite3GetVdbe(Parse*);
danielk19771e536952007-08-16 10:09:01 +00002433Expr *sqlite3CreateIdExpr(Parse *, const char*);
drh2fa18682008-03-19 14:15:34 +00002434void sqlite3PrngSaveState(void);
2435void sqlite3PrngRestoreState(void);
2436void sqlite3PrngResetState(void);
drh9bb575f2004-09-06 17:24:11 +00002437void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00002438void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00002439void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00002440void sqlite3CommitTransaction(Parse*);
2441void sqlite3RollbackTransaction(Parse*);
danielk1977fd7f0452008-12-17 17:30:26 +00002442void sqlite3Savepoint(Parse*, int, Token*);
2443void sqlite3CloseSavepoints(sqlite3 *);
danielk19774adee202004-05-08 08:23:19 +00002444int sqlite3ExprIsConstant(Expr*);
drh0a168372007-06-08 00:20:47 +00002445int sqlite3ExprIsConstantNotJoin(Expr*);
drheb55bd22005-06-30 17:04:21 +00002446int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00002447int sqlite3ExprIsInteger(Expr*, int*);
2448int sqlite3IsRowid(const char*);
drh2d401ab2008-01-10 23:50:11 +00002449void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
2450void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
drhe14006d2008-03-25 17:23:32 +00002451int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
drh04adf412008-01-08 18:57:50 +00002452void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
2453 int*,int,int,int,int);
danielk197762c14b32008-11-19 09:05:26 +00002454void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*, int, int, int);
drhaa9b8962008-01-08 02:57:55 +00002455int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00002456void sqlite3BeginWriteOperation(Parse*, int, int);
danielk19776ab3a2e2009-02-19 14:39:25 +00002457Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
drh17435752007-08-16 04:30:38 +00002458void sqlite3TokenCopy(sqlite3*,Token*, Token*);
danielk19776ab3a2e2009-02-19 14:39:25 +00002459ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
2460SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
drh17435752007-08-16 04:30:38 +00002461IdList *sqlite3IdListDup(sqlite3*,IdList*);
danielk19776ab3a2e2009-02-19 14:39:25 +00002462Select *sqlite3SelectDup(sqlite3*,Select*,int);
drh70a8ca32008-08-21 18:49:27 +00002463void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
drh9bb575f2004-09-06 17:24:11 +00002464FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
2465void sqlite3RegisterBuiltinFunctions(sqlite3*);
drh777c5382008-08-21 20:21:34 +00002466void sqlite3RegisterDateTimeFunctions(void);
drh70a8ca32008-08-21 18:49:27 +00002467void sqlite3RegisterGlobalFunctions(void);
drh7e8b8482008-01-23 03:03:05 +00002468#ifdef SQLITE_DEBUG
2469 int sqlite3SafetyOn(sqlite3*);
2470 int sqlite3SafetyOff(sqlite3*);
2471#else
2472# define sqlite3SafetyOn(A) 0
2473# define sqlite3SafetyOff(A) 0
2474#endif
2475int sqlite3SafetyCheckOk(sqlite3*);
2476int sqlite3SafetyCheckSickOrOk(sqlite3*);
drh9cbf3422008-01-17 16:22:13 +00002477void sqlite3ChangeCookie(Parse*, int);
shanefa4e62f2008-09-01 21:59:42 +00002478
2479#if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
drh2a5d8252008-08-22 12:30:52 +00002480void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
shanefa4e62f2008-09-01 21:59:42 +00002481#endif
drhb7f91642004-10-31 02:22:47 +00002482
2483#ifndef SQLITE_OMIT_TRIGGER
2484 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00002485 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00002486 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00002487 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00002488 void sqlite3DropTriggerPtr(Parse*, Trigger*);
danielk19772f886d12009-02-28 10:47:41 +00002489 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
2490 Trigger *sqlite3TriggerList(Parse *, Table *);
2491 int sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
2492 int, int, int, int, u32*, u32*);
drhb7f91642004-10-31 02:22:47 +00002493 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
drh633e6d52008-07-28 19:34:53 +00002494 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
drh17435752007-08-16 04:30:38 +00002495 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
2496 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
2497 ExprList*,Select*,int);
2498 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
2499 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
drh633e6d52008-07-28 19:34:53 +00002500 void sqlite3DeleteTrigger(sqlite3*, Trigger*);
drhb7f91642004-10-31 02:22:47 +00002501 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
2502#else
danielk197762c14b32008-11-19 09:05:26 +00002503# define sqlite3TriggersExist(B,C,D,E,F) 0
drh633e6d52008-07-28 19:34:53 +00002504# define sqlite3DeleteTrigger(A,B)
drhcdd536f2006-03-17 00:04:03 +00002505# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00002506# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
danielk19772f886d12009-02-28 10:47:41 +00002507# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K,L) 0
drhb7f91642004-10-31 02:22:47 +00002508#endif
2509
danielk19774adee202004-05-08 08:23:19 +00002510int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00002511void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00002512void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00002513#ifndef SQLITE_OMIT_AUTHORIZATION
drh728b5772007-09-18 15:55:07 +00002514 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002515 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
2516 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
2517 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00002518#else
danielk1977b5258c32007-10-04 18:11:15 +00002519# define sqlite3AuthRead(a,b,c,d)
danielk19774adee202004-05-08 08:23:19 +00002520# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
2521# define sqlite3AuthContextPush(a,b,c)
2522# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00002523#endif
danielk1977f744bb52005-12-06 17:19:11 +00002524void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2525void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00002526int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh33f4e022007-09-03 15:19:34 +00002527 int omitJournal, int nCache, int flags, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00002528int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
2529int sqlite3FixSrcList(DbFixer*, SrcList*);
2530int sqlite3FixSelect(DbFixer*, Select*);
2531int sqlite3FixExpr(DbFixer*, Expr*);
2532int sqlite3FixExprList(DbFixer*, ExprList*);
2533int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00002534int sqlite3AtoF(const char *z, double*);
drhfec19aa2004-05-19 20:41:03 +00002535int sqlite3GetInt32(const char *, int*);
drh598f1342007-10-23 15:39:45 +00002536int sqlite3FitsIn64Bits(const char *, int);
drhee858132007-05-08 20:37:38 +00002537int sqlite3Utf16ByteLen(const void *pData, int nChar);
2538int sqlite3Utf8CharLen(const char *pData, int nByte);
drh66150952007-07-23 19:12:41 +00002539int sqlite3Utf8Read(const u8*, const u8*, const u8**);
shane3f8d5cf2008-04-24 19:15:09 +00002540
2541/*
2542** Routines to read and write variable-length integers. These used to
2543** be defined locally, but now we use the varint routines in the util.c
shane952856a2008-04-28 17:41:30 +00002544** file. Code should use the MACRO forms below, as the Varint32 versions
2545** are coded to assume the single byte case is already handled (which
2546** the MACRO form does).
shane3f8d5cf2008-04-24 19:15:09 +00002547*/
drh35b5a332008-04-05 18:41:42 +00002548int sqlite3PutVarint(unsigned char*, u64);
2549int sqlite3PutVarint32(unsigned char*, u32);
drh1bd10f82008-12-10 21:19:56 +00002550u8 sqlite3GetVarint(const unsigned char *, u64 *);
2551u8 sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00002552int sqlite3VarintLen(u64 v);
shane3f8d5cf2008-04-24 19:15:09 +00002553
2554/*
2555** The header of a record consists of a sequence variable-length integers.
2556** These integers are almost always small and are encoded as a single byte.
2557** The following macros take advantage this fact to provide a fast encode
2558** and decode of the integers in a record header. It is faster for the common
2559** case where the integer is a single byte. It is a little slower when the
2560** integer is two or more bytes. But overall it is faster.
2561**
2562** The following expressions are equivalent:
2563**
2564** x = sqlite3GetVarint32( A, &B );
2565** x = sqlite3PutVarint32( A, B );
2566**
2567** x = getVarint32( A, B );
2568** x = putVarint32( A, B );
2569**
2570*/
drh1bd10f82008-12-10 21:19:56 +00002571#define getVarint32(A,B) (u8)((*(A)<(u8)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), (u32 *)&(B)))
2572#define putVarint32(A,B) (u8)(((u32)(B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
shane3f8d5cf2008-04-24 19:15:09 +00002573#define getVarint sqlite3GetVarint
2574#define putVarint sqlite3PutVarint
2575
2576
danielk1977a37cdde2004-05-16 11:15:36 +00002577void sqlite3IndexAffinityStr(Vdbe *, Index *);
2578void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00002579char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00002580int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00002581char sqlite3ExprAffinity(Expr *pExpr);
drhb6a9ece2007-06-26 00:37:27 +00002582int sqlite3Atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00002583void sqlite3Error(sqlite3*, int, const char*,...);
drhca48c902008-01-18 14:08:24 +00002584void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
danielk1977ef2cb632004-05-29 02:37:19 +00002585int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00002586const char *sqlite3ErrStr(int);
danielk19778a414492004-06-29 08:59:35 +00002587int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00002588CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00002589CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00002590CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh8b4c40d2007-02-01 23:02:45 +00002591Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
danielk19777cedc8d2004-06-10 10:50:08 +00002592int sqlite3CheckCollSeq(Parse *, CollSeq *);
danielk1977d8123362004-06-12 09:25:12 +00002593int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00002594void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk19774e6af132004-06-10 14:01:08 +00002595
drhb21c8cd2007-08-21 19:33:56 +00002596const void *sqlite3ValueText(sqlite3_value*, u8);
2597int sqlite3ValueBytes(sqlite3_value*, u8);
2598void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
danielk19771e536952007-08-16 10:09:01 +00002599 void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00002600void sqlite3ValueFree(sqlite3_value*);
danielk19771e536952007-08-16 10:09:01 +00002601sqlite3_value *sqlite3ValueNew(sqlite3 *);
2602char *sqlite3Utf16to8(sqlite3 *, const void*, int);
2603int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
drhb21c8cd2007-08-21 19:33:56 +00002604void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh46c99e02007-08-27 23:26:59 +00002605#ifndef SQLITE_AMALGAMATION
drh4e5ffc52004-08-31 00:52:37 +00002606extern const unsigned char sqlite3UpperToLower[];
danielk197778ca0e72009-01-20 16:53:39 +00002607extern const unsigned char sqlite3CtypeMap[];
danielk1977075c23a2008-09-01 18:34:20 +00002608extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
2609extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions;
drhddb68e12009-02-05 16:53:43 +00002610extern int sqlite3PendingByte;
drh46c99e02007-08-27 23:26:59 +00002611#endif
danielk1977a0bf2652004-11-04 14:30:04 +00002612void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00002613void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00002614void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00002615void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
2616int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00002617void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00002618void sqlite3ExpirePreparedStatements(sqlite3*);
danielk197741a05b72008-10-02 13:50:55 +00002619void sqlite3CodeSubselect(Parse *, Expr *, int, int);
drh7d10d5a2008-08-20 16:35:10 +00002620void sqlite3SelectPrep(Parse*, Select*, NameContext*);
2621int sqlite3ResolveExprNames(NameContext*, Expr*);
drh7d10d5a2008-08-20 16:35:10 +00002622void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
2623int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
danielk1977aee18ef2005-03-09 12:26:50 +00002624void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00002625void sqlite3AlterFinishAddColumn(Parse *, Token *);
2626void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
danielk19774dade032005-05-25 10:45:10 +00002627CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00002628char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00002629void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00002630int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00002631int sqlite3FindDb(sqlite3*, Token*);
danielk197704103022009-02-03 16:51:24 +00002632int sqlite3FindDbName(sqlite3 *, const char *);
drhcf1be452007-05-12 12:08:51 +00002633int sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00002634void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00002635void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00002636int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
drhfdd6e852005-12-16 01:06:16 +00002637void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00002638void sqlite3SchemaFree(void *);
danielk19771e536952007-08-16 10:09:01 +00002639Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
danielk1977e501b892006-01-09 06:29:47 +00002640int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00002641KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00002642int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2643 void (*)(sqlite3_context*,int,sqlite3_value **),
2644 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
danielk197754f01982006-01-18 15:25:17 +00002645int sqlite3ApiExit(sqlite3 *db, int);
danielk1977ddfb2f02006-02-17 12:25:14 +00002646int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00002647
drhf089aa42008-07-08 19:34:06 +00002648void sqlite3StrAccumInit(StrAccum*, char*, int, int);
drhade86482007-11-28 22:36:40 +00002649void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2650char *sqlite3StrAccumFinish(StrAccum*);
2651void sqlite3StrAccumReset(StrAccum*);
drh1013c932008-01-06 00:25:21 +00002652void sqlite3SelectDestInit(SelectDest*,int,int);
danielk19771e536952007-08-16 10:09:01 +00002653
danielk197704103022009-02-03 16:51:24 +00002654void sqlite3BackupRestart(sqlite3_backup *);
2655void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
2656
drh95bdbbb2007-07-23 19:31:16 +00002657/*
2658** The interface to the LEMON-generated parser
2659*/
2660void *sqlite3ParserAlloc(void*(*)(size_t));
2661void sqlite3ParserFree(void*, void(*)(void*));
2662void sqlite3Parser(void*, int, Token, Parse*);
drhec424a52008-07-25 15:39:03 +00002663#ifdef YYTRACKMAXSTACKDEPTH
2664 int sqlite3ParserStackPeak(void*);
2665#endif
drh95bdbbb2007-07-23 19:31:16 +00002666
drhcaa639f2008-03-20 00:32:20 +00002667int sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00002668#ifndef SQLITE_OMIT_LOAD_EXTENSION
2669 void sqlite3CloseExtensions(sqlite3*);
2670#else
2671# define sqlite3CloseExtensions(X)
2672#endif
danielk1977e3026632004-06-22 11:29:02 +00002673
danielk1977c00da102006-01-07 13:21:04 +00002674#ifndef SQLITE_OMIT_SHARED_CACHE
2675 void sqlite3TableLock(Parse *, int, int, u8, const char *);
2676#else
2677 #define sqlite3TableLock(v,w,x,y,z)
2678#endif
2679
drh53c14022007-05-10 17:23:11 +00002680#ifdef SQLITE_TEST
2681 int sqlite3Utf8To8(unsigned char*);
2682#endif
2683
drhb9bb7c12006-06-11 23:41:55 +00002684#ifdef SQLITE_OMIT_VIRTUALTABLE
2685# define sqlite3VtabClear(X)
danielk19779dbee7d2008-08-02 15:32:39 +00002686# define sqlite3VtabSync(X,Y) SQLITE_OK
danielk1977f9e7dda2006-06-16 16:08:53 +00002687# define sqlite3VtabRollback(X)
2688# define sqlite3VtabCommit(X)
danielk1977093e0f62008-11-13 18:00:14 +00002689# define sqlite3VtabInSync(db) 0
drhb9bb7c12006-06-11 23:41:55 +00002690#else
drh707205d2006-06-17 10:44:42 +00002691 void sqlite3VtabClear(Table*);
danielk19773e3a84d2008-08-01 17:37:40 +00002692 int sqlite3VtabSync(sqlite3 *db, char **);
danielk1977f9e7dda2006-06-16 16:08:53 +00002693 int sqlite3VtabRollback(sqlite3 *db);
2694 int sqlite3VtabCommit(sqlite3 *db);
danielk1977093e0f62008-11-13 18:00:14 +00002695# define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
drhb9bb7c12006-06-11 23:41:55 +00002696#endif
drh4f3dd152008-04-28 18:46:43 +00002697void sqlite3VtabMakeWritable(Parse*,Table*);
drh189d4af2006-09-02 20:57:52 +00002698void sqlite3VtabLock(sqlite3_vtab*);
danielk1977a04a34f2007-04-16 15:06:25 +00002699void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
drhb9bb7c12006-06-11 23:41:55 +00002700void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2701void sqlite3VtabFinishParse(Parse*, Token*);
2702void sqlite3VtabArgInit(Parse*);
2703void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00002704int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00002705int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00002706int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977f9e7dda2006-06-16 16:08:53 +00002707int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
danielk19771e536952007-08-16 10:09:01 +00002708FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00002709void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
shane4a27a282008-09-04 04:32:49 +00002710int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
drhb900aaf2006-11-09 00:24:53 +00002711int sqlite3Reprepare(Vdbe*);
drhb1a6c3c2008-03-20 16:30:17 +00002712void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
drh0a0e1312007-08-07 17:04:59 +00002713CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
drhb9bb7c12006-06-11 23:41:55 +00002714
drh643167f2008-01-22 21:30:53 +00002715
2716/*
2717** Available fault injectors. Should be numbered beginning with 0.
2718*/
2719#define SQLITE_FAULTINJECTOR_MALLOC 0
drh7e8b8482008-01-23 03:03:05 +00002720#define SQLITE_FAULTINJECTOR_COUNT 1
drh643167f2008-01-22 21:30:53 +00002721
2722/*
danielk1977ef05f2d2008-06-20 11:05:37 +00002723** The interface to the code in fault.c used for identifying "benign"
2724** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
2725** is not defined.
drh643167f2008-01-22 21:30:53 +00002726*/
drh3088d592008-03-21 16:45:47 +00002727#ifndef SQLITE_OMIT_BUILTIN_TEST
danielk19772d1d86f2008-06-20 14:59:51 +00002728 void sqlite3BeginBenignMalloc(void);
2729 void sqlite3EndBenignMalloc(void);
drh643167f2008-01-22 21:30:53 +00002730#else
danielk19772d1d86f2008-06-20 14:59:51 +00002731 #define sqlite3BeginBenignMalloc()
danielk1977867d05a2008-06-23 14:03:45 +00002732 #define sqlite3EndBenignMalloc()
drh643167f2008-01-22 21:30:53 +00002733#endif
drh643167f2008-01-22 21:30:53 +00002734
danielk19779a96b662007-11-29 17:05:18 +00002735#define IN_INDEX_ROWID 1
2736#define IN_INDEX_EPH 2
2737#define IN_INDEX_INDEX 3
danielk19770cdc0222008-06-26 18:04:03 +00002738int sqlite3FindInIndex(Parse *, Expr *, int*);
danielk19779a96b662007-11-29 17:05:18 +00002739
danielk1977c7b60172007-08-22 11:22:03 +00002740#ifdef SQLITE_ENABLE_ATOMIC_WRITE
2741 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2742 int sqlite3JournalSize(sqlite3_vfs *);
danielk1977f55b8992007-08-24 08:15:53 +00002743 int sqlite3JournalCreate(sqlite3_file *);
danielk1977c7b60172007-08-22 11:22:03 +00002744#else
2745 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2746#endif
2747
danielk1977b3175382008-10-17 18:51:52 +00002748void sqlite3MemJournalOpen(sqlite3_file *);
drh3a5990a2008-12-20 02:14:39 +00002749int sqlite3MemJournalSize(void);
danielk1977b3175382008-10-17 18:51:52 +00002750int sqlite3IsMemJournal(sqlite3_file *);
2751
drh0224d262008-05-28 13:49:34 +00002752#if SQLITE_MAX_EXPR_DEPTH>0
danielk19774b5255a2008-06-05 16:47:39 +00002753 void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
danielk1977fc976062007-05-10 10:46:56 +00002754 int sqlite3SelectExprHeight(Select *);
drh7d10d5a2008-08-20 16:35:10 +00002755 int sqlite3ExprCheckHeight(Parse*, int);
danielk1977fc976062007-05-10 10:46:56 +00002756#else
danielk19774b5255a2008-06-05 16:47:39 +00002757 #define sqlite3ExprSetHeight(x,y)
drh0224d262008-05-28 13:49:34 +00002758 #define sqlite3SelectExprHeight(x) 0
drh7d10d5a2008-08-20 16:35:10 +00002759 #define sqlite3ExprCheckHeight(x,y)
danielk1977fc976062007-05-10 10:46:56 +00002760#endif
2761
drha3152892007-05-05 11:48:52 +00002762u32 sqlite3Get4byte(const u8*);
drha3152892007-05-05 11:48:52 +00002763void sqlite3Put4byte(u8*, u32);
2764
danielk1977404ca072009-03-16 13:19:36 +00002765#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
2766 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
2767 void sqlite3ConnectionUnlocked(sqlite3 *db);
2768 void sqlite3ConnectionClosed(sqlite3 *db);
2769#else
2770 #define sqlite3ConnectionBlocked(x,y)
2771 #define sqlite3ConnectionUnlocked(x)
2772 #define sqlite3ConnectionClosed(x)
2773#endif
2774
2775
danielk1977fd9a0a42005-05-24 12:01:00 +00002776#ifdef SQLITE_SSE
2777#include "sseInt.h"
2778#endif
2779
drh6e736832007-05-11 12:30:03 +00002780#ifdef SQLITE_DEBUG
2781 void sqlite3ParserTrace(FILE*, char *);
2782#endif
2783
drhb0603412007-02-28 04:47:26 +00002784/*
2785** If the SQLITE_ENABLE IOTRACE exists then the global variable
mlcreech3a00f902008-03-04 17:45:01 +00002786** sqlite3IoTrace is a pointer to a printf-like routine used to
drhb0603412007-02-28 04:47:26 +00002787** print I/O tracing messages.
2788*/
2789#ifdef SQLITE_ENABLE_IOTRACE
mlcreech3a00f902008-03-04 17:45:01 +00002790# define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
danielk1977b4622b62007-03-02 06:24:19 +00002791 void sqlite3VdbeIOTraceSql(Vdbe*);
drhe265b082008-05-01 17:03:49 +00002792SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
drhb0603412007-02-28 04:47:26 +00002793#else
2794# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00002795# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00002796#endif
drhb0603412007-02-28 04:47:26 +00002797
danielk1977e3026632004-06-22 11:29:02 +00002798#endif