blob: a1f9250696f1abb9ca4dea86e7693e0ce3bacb26 [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**
drhd1fa7bc2009-01-10 13:24:50 +000014** @(#) $Id: sqliteInt.h,v 1.822 2009/01/10 13:24:51 drh 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/*
drhc5499be2008-04-01 15:06:33 +000054** A macro used to aid in coverage testing. When doing coverage
55** testing, the condition inside the argument must be evaluated
56** both true and false in order to get full branch coverage.
57** This macro can be inserted to ensure adequate test coverage
58** in places where simple condition/decision coverage is inadequate.
59*/
60#ifdef SQLITE_COVERAGE_TEST
61 void sqlite3Coverage(int);
62# define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
drh7539b6b2009-01-02 21:39:39 +000063# define TESTONLY(X) X
drhc5499be2008-04-01 15:06:33 +000064#else
65# define testcase(X)
drh7539b6b2009-01-02 21:39:39 +000066# define TESTONLY(X)
drhc5499be2008-04-01 15:06:33 +000067#endif
68
drh22c24032008-07-09 13:28:53 +000069/*
drh34004ce2008-07-11 16:15:17 +000070** The ALWAYS and NEVER macros surround boolean expressions which
71** are intended to always be true or false, respectively. Such
72** expressions could be omitted from the code completely. But they
73** are included in a few cases in order to enhance the resilience
74** of SQLite to unexpected behavior - to make the code "self-healing"
75** or "ductile" rather than being "brittle" and crashing at the first
76** hint of unplanned behavior.
drh22c24032008-07-09 13:28:53 +000077**
drh34004ce2008-07-11 16:15:17 +000078** When doing coverage testing ALWAYS and NEVER are hard-coded to
79** be true and false so that the unreachable code then specify will
80** not be counted as untested code.
drh22c24032008-07-09 13:28:53 +000081*/
82#ifdef SQLITE_COVERAGE_TEST
drh34004ce2008-07-11 16:15:17 +000083# define ALWAYS(X) (1)
84# define NEVER(X) (0)
drh22c24032008-07-09 13:28:53 +000085#else
drh34004ce2008-07-11 16:15:17 +000086# define ALWAYS(X) (X)
87# define NEVER(X) (X)
drh22c24032008-07-09 13:28:53 +000088#endif
mlcreech98dc4b12008-03-06 16:28:58 +000089
drh71674ce2007-10-23 15:51:26 +000090/*
drhb6dbc002007-11-27 02:38:00 +000091** The macro unlikely() is a hint that surrounds a boolean
92** expression that is usually false. Macro likely() surrounds
93** a boolean expression that is usually true. GCC is able to
94** use these hints to generate better code, sometimes.
95*/
drh4bbf4642008-01-30 16:14:23 +000096#if defined(__GNUC__) && 0
drhb6dbc002007-11-27 02:38:00 +000097# define likely(X) __builtin_expect((X),1)
98# define unlikely(X) __builtin_expect((X),0)
99#else
100# define likely(X) !!(X)
101# define unlikely(X) !!(X)
102#endif
103
shane1fc41292008-07-08 22:28:48 +0000104/*
105 * This macro is used to "hide" some ugliness in casting an int
106 * value to a ptr value under the MSVC 64-bit compiler. Casting
107 * non 64-bit values to ptr types results in a "hard" error with
108 * the MSVC 64-bit compiler which this attempts to avoid.
109 *
110 * A simple compiler pragma or casting sequence could not be found
111 * to correct this in all situations, so this macro was introduced.
112 *
113 * It could be argued that the intptr_t type could be used in this
114 * case, but that type is not available on all compilers, or
115 * requires the #include of specific headers which differs between
116 * platforms.
117 */
118#define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
119#define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
drhb6dbc002007-11-27 02:38:00 +0000120
121/*
shane467bcf32008-11-24 20:01:32 +0000122** These #defines should enable >2GB file support on POSIX if the
drh71674ce2007-10-23 15:51:26 +0000123** underlying operating system supports it. If the OS lacks
124** large file support, or if the OS is windows, these should be no-ops.
125**
126** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
127** system #includes. Hence, this block of code must be the very first
128** code in all source files.
129**
130** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
131** on the compiler command line. This is necessary if you are compiling
shane467bcf32008-11-24 20:01:32 +0000132** on a recent machine (ex: Red Hat 7.2) but you want your code to work
133** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
drh71674ce2007-10-23 15:51:26 +0000134** without this option, LFS is enable. But LFS does not exist in the kernel
shane467bcf32008-11-24 20:01:32 +0000135** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
drh71674ce2007-10-23 15:51:26 +0000136** portability you should omit LFS.
137**
shane467bcf32008-11-24 20:01:32 +0000138** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
drh71674ce2007-10-23 15:51:26 +0000139*/
140#ifndef SQLITE_DISABLE_LFS
141# define _LARGE_FILE 1
142# ifndef _FILE_OFFSET_BITS
143# define _FILE_OFFSET_BITS 64
144# endif
145# define _LARGEFILE_SOURCE 1
146#endif
147
148
drhe5e7a902007-10-01 17:47:00 +0000149/*
150** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
151** Older versions of SQLite used an optional THREADSAFE macro.
152** We support that for legacy
153*/
154#if !defined(SQLITE_THREADSAFE)
155#if defined(THREADSAFE)
156# define SQLITE_THREADSAFE THREADSAFE
157#else
158# define SQLITE_THREADSAFE 1
159#endif
160#endif
161
drh67080612007-10-01 14:30:14 +0000162/*
danielk19770a732f52008-09-04 17:17:38 +0000163** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1.
164** It determines whether or not the features related to
shane467bcf32008-11-24 20:01:32 +0000165** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can
danielk19770a732f52008-09-04 17:17:38 +0000166** be overridden at runtime using the sqlite3_config() API.
167*/
168#if !defined(SQLITE_DEFAULT_MEMSTATUS)
169# define SQLITE_DEFAULT_MEMSTATUS 1
170#endif
171
172/*
drh0d180202008-02-14 23:26:56 +0000173** Exactly one of the following macros must be defined in order to
174** specify which memory allocation subsystem to use.
175**
176** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
177** SQLITE_MEMDEBUG // Debugging version of system malloc()
178** SQLITE_MEMORY_SIZE // internal allocator #1
179** SQLITE_MMAP_HEAP_SIZE // internal mmap() allocator
180** SQLITE_POW2_MEMORY_SIZE // internal power-of-two allocator
181**
182** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
183** the default.
184*/
185#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
186 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
187 defined(SQLITE_POW2_MEMORY_SIZE)>1
188# error "At most one of the following compile-time configuration options\
189 is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
190 SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
191#endif
192#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
193 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
194 defined(SQLITE_POW2_MEMORY_SIZE)==0
195# define SQLITE_SYSTEM_MALLOC 1
196#endif
197
198/*
drheee4c8c2008-02-18 22:24:57 +0000199** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
200** sizes of memory allocations below this value where possible.
201*/
202#if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
203# define SQLITE_MALLOC_SOFT_LIMIT 1024
204#endif
205
206/*
drh67080612007-10-01 14:30:14 +0000207** We need to define _XOPEN_SOURCE as follows in order to enable
shane467bcf32008-11-24 20:01:32 +0000208** recursive mutexes on most Unix systems. But Mac OS X is different.
drh67080612007-10-01 14:30:14 +0000209** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
210** so it is omitted there. See ticket #2673.
drhe5e7a902007-10-01 17:47:00 +0000211**
212** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
213** implemented on some systems. So we avoid defining it at all
214** if it is already defined or if it is unneeded because we are
215** not doing a threadsafe build. Ticket #2681.
drh9e0ebbf2007-10-23 15:59:18 +0000216**
217** See also ticket #2741.
drh67080612007-10-01 14:30:14 +0000218*/
aswiftee99b902008-01-28 22:09:23 +0000219#if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
drh67080612007-10-01 14:30:14 +0000220# define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */
221#endif
danielk1977e3026632004-06-22 11:29:02 +0000222
drh7d10d5a2008-08-20 16:35:10 +0000223/*
224** The TCL headers are only needed when compiling the TCL bindings.
225*/
drh4f0c5872007-03-26 22:05:01 +0000226#if defined(SQLITE_TCL) || defined(TCLSH)
227# include <tcl.h>
drh824d7c12006-01-06 12:03:19 +0000228#endif
229
230/*
drh4b529d92005-09-13 00:00:00 +0000231** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +0000232** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +0000233** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
234** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
235** feature.
236*/
danielk1977771151b2006-01-17 13:21:40 +0000237#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +0000238# define NDEBUG 1
239#endif
240
drh64022502009-01-09 14:11:04 +0000241/*
242** Sometimes we need a small amount of code such as a variable initialization
243** to setup for a later assert() statement. We do not want this code to
244** appear when assert() is disabled. The following macro is therefore
245** used to contain that setup code. The "VVA" acronym stands for
246** "Verification, Validation, and Accreditation". In other words, the
247** code within VVA_ONLY() will only run during verification processes.
248*/
249#ifndef NDEBUG
250# define VVA_ONLY(X) X
251#else
252# define VVA_ONLY(X)
253#endif
254
drh1d482dd2004-05-31 18:23:07 +0000255#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +0000256#include "hash.h"
drh75897232000-05-29 14:26:00 +0000257#include "parse.h"
drh75897232000-05-29 14:26:00 +0000258#include <stdio.h>
259#include <stdlib.h>
260#include <string.h>
261#include <assert.h>
drh52370e22005-01-21 21:31:40 +0000262#include <stddef.h>
drh75897232000-05-29 14:26:00 +0000263
drh967e8b72000-06-21 13:59:10 +0000264/*
drhb37df7b2005-10-13 02:09:49 +0000265** If compiling for a processor that lacks floating point support,
266** substitute integer for floating-point
267*/
268#ifdef SQLITE_OMIT_FLOATING_POINT
269# define double sqlite_int64
270# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +0000271# ifndef SQLITE_BIG_DBL
272# define SQLITE_BIG_DBL (0x7fffffffffffffff)
273# endif
drhb37df7b2005-10-13 02:09:49 +0000274# define SQLITE_OMIT_DATETIME_FUNCS 1
275# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +0000276# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhb37df7b2005-10-13 02:09:49 +0000277#endif
drhd1167392006-01-23 13:00:35 +0000278#ifndef SQLITE_BIG_DBL
279# define SQLITE_BIG_DBL (1e99)
280#endif
drhb37df7b2005-10-13 02:09:49 +0000281
282/*
danielk197753c0f742005-03-29 03:10:59 +0000283** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
284** afterward. Having this macro allows us to cause the C compiler
285** to omit code used by TEMP tables without messy #ifndef statements.
286*/
287#ifdef SQLITE_OMIT_TEMPDB
288#define OMIT_TEMPDB 1
289#else
290#define OMIT_TEMPDB 0
291#endif
292
293/*
drh0bd1f4e2002-06-06 18:54:39 +0000294** If the following macro is set to 1, then NULL values are considered
drh0bd1f4e2002-06-06 18:54:39 +0000295** distinct when determining whether or not two entries are the same
296** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
297** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
298** is the way things are suppose to work.
299**
300** If the following macro is set to 0, the NULLs are indistinct for
301** a UNIQUE index. In this mode, you can only have a single NULL entry
302** for a column declared UNIQUE. This is the way Informix and SQL Server
303** work.
304*/
305#define NULL_DISTINCT_FOR_UNIQUE 1
306
307/*
drhd946db02005-12-29 19:23:06 +0000308** The "file format" number is an integer that is incremented whenever
309** the VDBE-level file format changes. The following macros define the
310** the default file format for new databases and the maximum file format
311** that the library can read.
312*/
313#define SQLITE_MAX_FILE_FORMAT 4
314#ifndef SQLITE_DEFAULT_FILE_FORMAT
drh76fe8032006-07-11 14:17:51 +0000315# define SQLITE_DEFAULT_FILE_FORMAT 1
drhd946db02005-12-29 19:23:06 +0000316#endif
317
318/*
danielk1977b06a0b62008-06-26 10:54:12 +0000319** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
drh49766d62005-01-08 18:42:28 +0000320** on the command-line
321*/
danielk1977b06a0b62008-06-26 10:54:12 +0000322#ifndef SQLITE_TEMP_STORE
323# define SQLITE_TEMP_STORE 1
drh49766d62005-01-08 18:42:28 +0000324#endif
325
326/*
drhf1974842004-11-05 03:56:00 +0000327** GCC does not define the offsetof() macro so we'll have to do it
328** ourselves.
329*/
330#ifndef offsetof
331#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
332#endif
333
334/*
drh9b8f4472006-04-04 01:54:55 +0000335** Check to see if this machine uses EBCDIC. (Yes, believe it or
336** not, there are still machines out there that use EBCDIC.)
337*/
338#if 'A' == '\301'
339# define SQLITE_EBCDIC 1
340#else
341# define SQLITE_ASCII 1
342#endif
343
344/*
drh5a2c2c22001-11-21 02:21:11 +0000345** Integers of known sizes. These typedefs might change for architectures
346** where the sizes very. Preprocessor macros are available so that the
347** types can be conveniently redefined at compile-type. Like this:
348**
349** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000350*/
drh5a2c2c22001-11-21 02:21:11 +0000351#ifndef UINT32_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000352# ifdef HAVE_UINT32_T
353# define UINT32_TYPE uint32_t
354# else
355# define UINT32_TYPE unsigned int
356# endif
drh5a2c2c22001-11-21 02:21:11 +0000357#endif
358#ifndef UINT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000359# ifdef HAVE_UINT16_T
360# define UINT16_TYPE uint16_t
361# else
362# define UINT16_TYPE unsigned short int
363# endif
drh5a2c2c22001-11-21 02:21:11 +0000364#endif
drh939a16d2004-07-15 13:37:22 +0000365#ifndef INT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000366# ifdef HAVE_INT16_T
367# define INT16_TYPE int16_t
368# else
369# define INT16_TYPE short int
370# endif
drh939a16d2004-07-15 13:37:22 +0000371#endif
drh5a2c2c22001-11-21 02:21:11 +0000372#ifndef UINT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000373# ifdef HAVE_UINT8_T
374# define UINT8_TYPE uint8_t
375# else
376# define UINT8_TYPE unsigned char
377# endif
drh5a2c2c22001-11-21 02:21:11 +0000378#endif
drh905793e2004-02-21 13:31:09 +0000379#ifndef INT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000380# ifdef HAVE_INT8_T
381# define INT8_TYPE int8_t
382# else
383# define INT8_TYPE signed char
384# endif
drh905793e2004-02-21 13:31:09 +0000385#endif
drhefad9992004-06-22 12:13:55 +0000386#ifndef LONGDOUBLE_TYPE
387# define LONGDOUBLE_TYPE long double
388#endif
drhefad9992004-06-22 12:13:55 +0000389typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000390typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000391typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
392typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000393typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000394typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh70a8ca32008-08-21 18:49:27 +0000395typedef INT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000396
397/*
drhbbd42a62004-05-22 17:41:58 +0000398** Macros to determine whether the machine is big or little endian,
399** evaluated at runtime.
400*/
drh46c99e02007-08-27 23:26:59 +0000401#ifdef SQLITE_AMALGAMATION
drhb3190c12008-12-08 21:37:14 +0000402const int sqlite3one = 1;
drh46c99e02007-08-27 23:26:59 +0000403#else
drhbbd42a62004-05-22 17:41:58 +0000404extern const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000405#endif
drh189077f2008-10-11 18:11:21 +0000406#if defined(i386) || defined(__i386__) || defined(_M_IX86)\
407 || defined(__x86_64) || defined(__x86_64__)
drh38def052007-03-31 15:27:59 +0000408# define SQLITE_BIGENDIAN 0
409# define SQLITE_LITTLEENDIAN 1
410# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
411#else
412# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
413# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
414# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
415#endif
drhbbd42a62004-05-22 17:41:58 +0000416
417/*
drh0f050352008-05-09 18:03:13 +0000418** Constants for the largest and smallest possible 64-bit signed integers.
419** These macros are designed to work correctly on both 32-bit and 64-bit
420** compilers.
421*/
422#define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
423#define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
424
425/*
drh90f5ecb2004-07-22 01:19:35 +0000426** An instance of the following structure is used to store the busy-handler
427** callback for a given sqlite handle.
428**
429** The sqlite.busyHandler member of the sqlite struct contains the busy
430** callback for the database handle. Each pager opened via the sqlite
431** handle is passed a pointer to sqlite.busyHandler. The busy-handler
432** callback is currently invoked only from within pager.c.
433*/
434typedef struct BusyHandler BusyHandler;
435struct BusyHandler {
436 int (*xFunc)(void *,int); /* The busy callback */
437 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000438 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000439};
440
441/*
drh75897232000-05-29 14:26:00 +0000442** Name of the master database table. The master database table
443** is a special table that holds the names and attributes of all
444** user tables and indices.
445*/
drhe0bc4042002-06-25 01:09:11 +0000446#define MASTER_NAME "sqlite_master"
447#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000448
449/*
danielk19778e150812004-05-10 01:17:37 +0000450** The root-page of the master database table.
451*/
452#define MASTER_ROOT 1
453
454/*
drhed6c8672003-01-12 18:02:16 +0000455** The name of the schema table.
456*/
danielk197753c0f742005-03-29 03:10:59 +0000457#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000458
459/*
drh75897232000-05-29 14:26:00 +0000460** A convenience macro that returns the number of elements in
461** an array.
462*/
danielk197723432972008-11-17 16:42:00 +0000463#define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
drh75897232000-05-29 14:26:00 +0000464
465/*
drh633e6d52008-07-28 19:34:53 +0000466** The following value as a destructor means to use sqlite3DbFree().
467** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT.
468*/
469#define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3DbFree)
470
drh78f82d12008-09-02 00:52:52 +0000471/*
472** When SQLITE_OMIT_WSD is defined, it means that the target platform does
473** not support Writable Static Data (WSD) such as global and static variables.
474** All variables must either be on the stack or dynamically allocated from
475** the heap. When WSD is unsupported, the variable declarations scattered
476** throughout the SQLite code must become constants instead. The SQLITE_WSD
477** macro is used for this purpose. And instead of referencing the variable
478** directly, we use its constant as a key to lookup the run-time allocated
479** buffer that holds real variable. The constant is also the initializer
480** for the run-time allocated buffer.
481**
shane2479de32008-11-10 18:05:35 +0000482** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
drh78f82d12008-09-02 00:52:52 +0000483** macros become no-ops and have zero performance impact.
484*/
danielk1977075c23a2008-09-01 18:34:20 +0000485#ifdef SQLITE_OMIT_WSD
486 #define SQLITE_WSD const
487 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
488 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
drhd1d38482008-10-07 23:46:38 +0000489 int sqlite3_wsd_init(int N, int J);
490 void *sqlite3_wsd_find(void *K, int L);
danielk1977075c23a2008-09-01 18:34:20 +0000491#else
492 #define SQLITE_WSD
493 #define GLOBAL(t,v) v
494 #define sqlite3GlobalConfig sqlite3Config
495#endif
496
danielk1977f3d3c272008-11-19 16:52:44 +0000497/*
498** The following macros are used to suppress compiler warnings and to
499** make it clear to human readers when a function parameter is deliberately
500** left unused within the body of a function. This usually happens when
501** a function is called via a function pointer. For example the
502** implementation of an SQL aggregate step callback may not use the
503** parameter indicating the number of arguments passed to the aggregate,
504** if it knows that this is enforced elsewhere.
505**
506** When a function parameter is not used at all within the body of a function,
507** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
508** However, these macros may also be used to suppress warnings related to
509** parameters that may or may not be used depending on compilation options.
510** For example those parameters only used in assert() statements. In these
511** cases the parameters are named as per the usual conventions.
512*/
danielk197762c14b32008-11-19 09:05:26 +0000513#define UNUSED_PARAMETER(x) (void)(x)
danielk1977f3d3c272008-11-19 16:52:44 +0000514#define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
danielk197762c14b32008-11-19 09:05:26 +0000515
drh633e6d52008-07-28 19:34:53 +0000516/*
drh75897232000-05-29 14:26:00 +0000517** Forward references to structures
518*/
drh13449892005-09-07 21:22:45 +0000519typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000520typedef struct AuthContext AuthContext;
drhf5e7bb52008-02-18 14:47:33 +0000521typedef struct Bitvec Bitvec;
drh3d4501e2008-12-04 20:40:10 +0000522typedef struct RowSet RowSet;
drhfe05af82005-07-21 03:14:59 +0000523typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000524typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000525typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000526typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000527typedef struct Expr Expr;
528typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000529typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000530typedef struct FuncDef FuncDef;
drh70a8ca32008-08-21 18:49:27 +0000531typedef struct FuncDefHash FuncDefHash;
drhfe05af82005-07-21 03:14:59 +0000532typedef struct IdList IdList;
533typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000534typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000535typedef struct KeyInfo KeyInfo;
drh633e6d52008-07-28 19:34:53 +0000536typedef struct Lookaside Lookaside;
537typedef struct LookasideSlot LookasideSlot;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000538typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000539typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000540typedef struct Parse Parse;
danielk1977fd7f0452008-12-17 17:30:26 +0000541typedef struct Savepoint Savepoint;
drhfe05af82005-07-21 03:14:59 +0000542typedef struct Select Select;
543typedef struct SrcList SrcList;
drhade86482007-11-28 22:36:40 +0000544typedef struct StrAccum StrAccum;
drhfe05af82005-07-21 03:14:59 +0000545typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000546typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000547typedef struct Token Token;
548typedef struct TriggerStack TriggerStack;
549typedef struct TriggerStep TriggerStep;
550typedef struct Trigger Trigger;
drhe63d9992008-08-13 19:11:48 +0000551typedef struct UnpackedRecord UnpackedRecord;
drh7d10d5a2008-08-20 16:35:10 +0000552typedef struct Walker Walker;
drh111a6a72008-12-21 03:51:16 +0000553typedef struct WherePlan WherePlan;
drhfe05af82005-07-21 03:14:59 +0000554typedef struct WhereInfo WhereInfo;
555typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000556
danielk19772dca4ac2008-01-03 11:50:29 +0000557/*
558** Defer sourcing vdbe.h and btree.h until after the "u8" and
559** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
560** pointer types (i.e. FuncDef) defined above.
561*/
562#include "btree.h"
563#include "vdbe.h"
564#include "pager.h"
danielk19778c0a7912008-08-20 14:49:23 +0000565#include "pcache.h"
danielk19772dca4ac2008-01-03 11:50:29 +0000566
danielk19771cc5ed82007-05-16 17:28:43 +0000567#include "os.h"
drhc7ce76a2007-08-30 14:10:30 +0000568#include "mutex.h"
danielk19771cc5ed82007-05-16 17:28:43 +0000569
drheee4c8c2008-02-18 22:24:57 +0000570
drh001bbcb2003-03-19 03:14:00 +0000571/*
572** Each database file to be accessed by the system is an instance
573** of the following structure. There are normally two of these structures
574** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000575** aDb[1] is the database file used to hold temporary tables. Additional
576** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000577*/
578struct Db {
579 char *zName; /* Name of this database */
580 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000581 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
shane467bcf32008-11-24 20:01:32 +0000582 u8 safety_level; /* How aggressive at syncing data to disk */
danielk1977da184232006-01-05 11:34:32 +0000583 void *pAux; /* Auxiliary data. Usually NULL */
584 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000585 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000586};
587
588/*
589** An instance of the following structure stores a database schema.
danielk1977a04a34f2007-04-16 15:06:25 +0000590**
591** If there are no virtual tables configured in this schema, the
592** Schema.db variable is set to NULL. After the first virtual table
593** has been added, it is set to point to the database connection
594** used to create the connection. Once a virtual table has been
595** added to the Schema structure and the Schema.db variable populated,
596** only that database connection may use the Schema to prepare
597** statements.
danielk1977da184232006-01-05 11:34:32 +0000598*/
danielk1977e501b892006-01-09 06:29:47 +0000599struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000600 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000601 Hash tblHash; /* All tables indexed by name */
602 Hash idxHash; /* All (named) indices indexed by name */
603 Hash trigHash; /* All triggers indexed by name */
604 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000605 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000606 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000607 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000608 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000609 int cache_size; /* Number of pages to use in the cache */
danielk1977a04a34f2007-04-16 15:06:25 +0000610#ifndef SQLITE_OMIT_VIRTUALTABLE
611 sqlite3 *db; /* "Owner" connection. See comment above */
612#endif
drh001bbcb2003-03-19 03:14:00 +0000613};
drh75897232000-05-29 14:26:00 +0000614
615/*
drh8bf8dc92003-05-17 17:35:10 +0000616** These macros can be used to test, set, or clear bits in the
617** Db.flags field.
618*/
danielk1977da184232006-01-05 11:34:32 +0000619#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
620#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
621#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
622#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000623
624/*
625** Allowed values for the DB.flags field.
626**
drh8bf8dc92003-05-17 17:35:10 +0000627** The DB_SchemaLoaded flag is set after the database schema has been
628** read into internal hash tables.
629**
630** DB_UnresetViews means that one or more views have column names that
631** have been filled out. If the schema changes, these column names might
632** changes and so the view will need to be reset.
633*/
drh124b27e2004-06-19 16:06:10 +0000634#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
635#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000636#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000637
drhcaa639f2008-03-20 00:32:20 +0000638/*
639** The number of different kinds of things that can be limited
640** using the sqlite3_limit() interface.
641*/
642#define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
drh8bf8dc92003-05-17 17:35:10 +0000643
644/*
drh633e6d52008-07-28 19:34:53 +0000645** Lookaside malloc is a set of fixed-size buffers that can be used
shane467bcf32008-11-24 20:01:32 +0000646** to satisfy small transient memory allocation requests for objects
drh633e6d52008-07-28 19:34:53 +0000647** associated with a particular database connection. The use of
648** lookaside malloc provides a significant performance enhancement
649** (approx 10%) by avoiding numerous malloc/free requests while parsing
650** SQL statements.
651**
652** The Lookaside structure holds configuration information about the
653** lookaside malloc subsystem. Each available memory allocation in
654** the lookaside subsystem is stored on a linked list of LookasideSlot
655** objects.
656*/
657struct Lookaside {
658 u16 sz; /* Size of each buffer in bytes */
659 u8 bEnabled; /* True if use lookaside. False to ignore it */
drhe9d1c722008-08-04 20:13:26 +0000660 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
drh633e6d52008-07-28 19:34:53 +0000661 int nOut; /* Number of buffers currently checked out */
662 int mxOut; /* Highwater mark for nOut */
drh7d10d5a2008-08-20 16:35:10 +0000663 LookasideSlot *pFree; /* List of available buffers */
drh633e6d52008-07-28 19:34:53 +0000664 void *pStart; /* First byte of available memory space */
665 void *pEnd; /* First byte past end of available space */
666};
667struct LookasideSlot {
668 LookasideSlot *pNext; /* Next buffer in the list of free buffers */
669};
670
671/*
drh70a8ca32008-08-21 18:49:27 +0000672** A hash table for function definitions.
673**
674** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
675** Collisions are on the FuncDef.pHash chain.
676*/
677struct FuncDefHash {
678 FuncDef *a[23]; /* Hash table for functions */
679};
680
681/*
drhc9b84a12002-06-20 11:36:48 +0000682** Each database is an instance of the following structure.
683**
rdcb0c374f2004-02-20 22:53:38 +0000684** The sqlite.lastRowid records the last insert rowid generated by an
685** insert statement. Inserts on views do not affect its value. Each
686** trigger has its own context, so that lastRowid can be updated inside
687** triggers as usual. The previous value will be restored once the trigger
688** exits. Upon entering a before or instead of trigger, lastRowid is no
689** longer (since after version 2.8.12) reset to -1.
690**
691** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000692** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000693** The sqlite.lsChange represents the number of changes made by the last
694** insert, update, or delete statement. It remains constant throughout the
695** length of a statement and is then updated by OP_SetCounts. It keeps a
696** context stack just like lastRowid so that the count of changes
697** within a trigger is not seen outside the trigger. Changes to views do not
698** affect the value of lsChange.
699** The sqlite.csChange keeps track of the number of current changes (since
700** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000701**
702** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
703** store the most recent error code and, if applicable, string. The
704** internal function sqlite3Error() is used to set these variables
705** consistently.
drh75897232000-05-29 14:26:00 +0000706*/
drh9bb575f2004-09-06 17:24:11 +0000707struct sqlite3 {
drh90f6a5b2007-08-15 13:04:54 +0000708 sqlite3_vfs *pVfs; /* OS Interface */
drh001bbcb2003-03-19 03:14:00 +0000709 int nDb; /* Number of backends currently in use */
710 Db *aDb; /* All backends */
shane467bcf32008-11-24 20:01:32 +0000711 int flags; /* Miscellaneous flags. See below */
drh33f4e022007-09-03 15:19:34 +0000712 int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
drhfcd35c72005-05-21 02:48:08 +0000713 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000714 int errMask; /* & result codes with this before returning */
drhfcd35c72005-05-21 02:48:08 +0000715 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000716 u8 temp_store; /* 1: file 2: memory 0: default */
drh17435752007-08-16 04:30:38 +0000717 u8 mallocFailed; /* True if we have seen a malloc failure */
drh3b020132008-04-17 17:02:01 +0000718 u8 dfltLockMode; /* Default locking-mode for attached dbs */
719 u8 dfltJournalMode; /* Default journal mode for attached dbs */
drh98757152008-01-09 23:04:12 +0000720 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
danielk1977f653d782008-03-20 11:04:21 +0000721 int nextPagesize; /* Pagesize after VACUUM if >0 */
drh5e00f6c2001-09-13 13:46:56 +0000722 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000723 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000724 i64 lastRowid; /* ROWID of most recent insert (see above) */
725 i64 priorNewRowid; /* Last randomly generated ROWID */
danielk197764202cf2008-11-17 15:31:47 +0000726 u32 magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000727 int nChange; /* Value returned by sqlite3_changes() */
728 int nTotalChange; /* Value returned by sqlite3_total_changes() */
drhd677b3d2007-08-20 22:48:41 +0000729 sqlite3_mutex *mutex; /* Connection mutex */
drhcaa639f2008-03-20 00:32:20 +0000730 int aLimit[SQLITE_N_LIMIT]; /* Limits */
danielk1977b28af712004-06-21 06:50:26 +0000731 struct sqlite3InitInfo { /* Information used during initialization */
732 int iDb; /* When back is being initialized */
733 int newTnum; /* Rootpage of table being initialized */
734 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000735 } init;
drhf1952c52006-06-08 15:48:00 +0000736 int nExtension; /* Number of loaded extensions */
shane467bcf32008-11-24 20:01:32 +0000737 void **aExtension; /* Array of shared library handles */
drh326dce72003-01-29 14:06:07 +0000738 struct Vdbe *pVdbe; /* List of active virtual machines */
shane467bcf32008-11-24 20:01:32 +0000739 int activeVdbeCnt; /* Number of VDBEs currently executing */
drhad4a4b82008-11-05 16:37:34 +0000740 int writeVdbeCnt; /* Number of active VDBEs that are writing */
drh19e2d372005-08-29 23:00:03 +0000741 void (*xTrace)(void*,const char*); /* Trace function */
742 void *pTraceArg; /* Argument to the trace function */
743 void (*xProfile)(void*,const char*,u64); /* Profiling function */
744 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000745 void *pCommitArg; /* Argument to xCommitCallback() */
746 int (*xCommitCallback)(void*); /* Invoked at every commit. */
747 void *pRollbackArg; /* Argument to xRollbackCallback() */
748 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000749 void *pUpdateArg;
750 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000751 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
752 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
753 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000754 sqlite3_value *pErr; /* Most recent error message */
755 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
756 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drh881feaa2006-07-26 01:39:30 +0000757 union {
drh39001e72008-09-12 16:03:47 +0000758 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
drh881feaa2006-07-26 01:39:30 +0000759 double notUsed1; /* Spacer */
760 } u1;
drh633e6d52008-07-28 19:34:53 +0000761 Lookaside lookaside; /* Lookaside malloc configuration */
drhed6c8672003-01-12 18:02:16 +0000762#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000763 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
764 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000765 void *pAuthArg; /* 1st argument to the access auth function */
766#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000767#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
768 int (*xProgress)(void *); /* The progress callback */
769 void *pProgressArg; /* Argument to the progress callback */
770 int nProgressOps; /* Number of opcodes for progress callback */
771#endif
drhb9bb7c12006-06-11 23:41:55 +0000772#ifndef SQLITE_OMIT_VIRTUALTABLE
773 Hash aModule; /* populated by sqlite3_create_module() */
danielk19777e6ebfb2006-06-12 11:24:37 +0000774 Table *pVTab; /* vtab with active Connect/Create method */
danielk1977f9e7dda2006-06-16 16:08:53 +0000775 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */
776 int nVTrans; /* Allocated size of aVTrans */
danielk19776b456a22005-03-21 04:04:02 +0000777#endif
drh70a8ca32008-08-21 18:49:27 +0000778 FuncDefHash aFunc; /* Hash table of connection functions */
drhfcd35c72005-05-21 02:48:08 +0000779 Hash aCollSeq; /* All collating sequences */
780 BusyHandler busyHandler; /* Busy callback */
drhb9bb7c12006-06-11 23:41:55 +0000781 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000782 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000783#ifdef SQLITE_SSE
784 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
785#endif
danielk1977fd7f0452008-12-17 17:30:26 +0000786 Savepoint *pSavepoint; /* List of active savepoints */
787 int nSavepoint; /* Number of non-transaction savepoints */
788 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
drh75897232000-05-29 14:26:00 +0000789};
790
drh03b808a2006-03-13 15:06:05 +0000791/*
792** A macro to discover the encoding of a database.
793*/
danielk197714db2662006-01-09 16:12:04 +0000794#define ENC(db) ((db)->aDb[0].pSchema->enc)
795
drh75897232000-05-29 14:26:00 +0000796/*
drh8bf8dc92003-05-17 17:35:10 +0000797** Possible values for the sqlite.flags and or Db.flags fields.
798**
799** On sqlite.flags, the SQLITE_InTrans value means that we have
800** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
801** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000802*/
drh5e00f6c2001-09-13 13:46:56 +0000803#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000804#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
805#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000806#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000807#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
808#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000809 /* DELETE, or UPDATE and return */
810 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000811#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000812 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000813#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
814#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000815#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000816#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
817 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000818#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
drhc2e87a32006-06-27 15:16:14 +0000819#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000820#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drhac530b12006-02-11 01:25:50 +0000821#define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */
drhc2e87a32006-06-27 15:16:14 +0000822#define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */
drh58b95762000-06-02 01:17:37 +0000823
danielk197734c68fb2007-03-14 15:37:04 +0000824#define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */
drh4a50aac2007-08-23 02:47:53 +0000825#define SQLITE_SharedCache 0x00080000 /* Cache sharing is enabled */
826#define SQLITE_Vtab 0x00100000 /* There exists a virtual table */
drh853799a2009-01-03 14:04:38 +0000827#define SQLITE_CommitBusy 0x00200000 /* In the process of committing */
danielk197734c68fb2007-03-14 15:37:04 +0000828
drh58b95762000-06-02 01:17:37 +0000829/*
drh247be432002-05-10 05:44:55 +0000830** Possible values for the sqlite.magic field.
831** The numbers are obtained at random and have no special meaning, other
832** than being distinct from one another.
833*/
834#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
835#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
drh7e8b8482008-01-23 03:03:05 +0000836#define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
drh247be432002-05-10 05:44:55 +0000837#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
838#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
839
840/*
drh0bce8352002-02-28 00:41:10 +0000841** Each SQL function is defined by an instance of the following
842** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000843** hash table. When multiple functions have the same name, the hash table
844** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000845*/
drh0bce8352002-02-28 00:41:10 +0000846struct FuncDef {
drhe82f5d02008-10-07 19:53:14 +0000847 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000848 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000849 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000850 void *pUserData; /* User data parameter */
851 FuncDef *pNext; /* Next function with same name */
852 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
853 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
shane467bcf32008-11-24 20:01:32 +0000854 void (*xFinalize)(sqlite3_context*); /* Aggregate finalizer */
danielk19778c0a7912008-08-20 14:49:23 +0000855 char *zName; /* SQL name of the function. */
drh70a8ca32008-08-21 18:49:27 +0000856 FuncDef *pHash; /* Next with a different name but the same hash */
drh8e0a2f92002-02-23 23:45:45 +0000857};
drh28037572000-08-02 13:47:41 +0000858
859/*
drh7d10d5a2008-08-20 16:35:10 +0000860** Possible values for FuncDef.flags
861*/
drhe82f5d02008-10-07 19:53:14 +0000862#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
863#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
shane467bcf32008-11-24 20:01:32 +0000864#define SQLITE_FUNC_EPHEM 0x04 /* Ephemeral. Delete with VDBE */
drhe82f5d02008-10-07 19:53:14 +0000865#define SQLITE_FUNC_NEEDCOLL 0x08 /* sqlite3GetFuncCollSeq() might be called */
drhd1fa7bc2009-01-10 13:24:50 +0000866#define SQLITE_FUNC_PRIVATE 0x10 /* Allowed for internal use only */
drh7d10d5a2008-08-20 16:35:10 +0000867
868/*
drh777c5382008-08-21 20:21:34 +0000869** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
870** used to create the initializers for the FuncDef structures.
871**
872** FUNCTION(zName, nArg, iArg, bNC, xFunc)
873** Used to create a scalar function definition of a function zName
874** implemented by C function xFunc that accepts nArg arguments. The
875** value passed as iArg is cast to a (void*) and made available
876** as the user-data (sqlite3_user_data()) for the function. If
877** argument bNC is true, then the FuncDef.needCollate flag is set.
878**
879** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
880** Used to create an aggregate function definition implemented by
881** the C functions xStep and xFinal. The first four parameters
882** are interpreted in the same way as the first 4 parameters to
883** FUNCTION().
884**
885** LIKEFUNC(zName, nArg, pArg, flags)
886** Used to create a scalar function definition of a function zName
887** that accepts nArg arguments and is implemented by a call to C
888** function likeFunc. Argument pArg is cast to a (void *) and made
889** available as the function user-data (sqlite3_user_data()). The
890** FuncDef.flags variable is set to the value passed as the flags
891** parameter.
892*/
893#define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
danielk1977cdcfe952008-11-18 07:27:24 +0000894 {nArg, SQLITE_UTF8, bNC*8, SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0}
drh21717ed2008-10-13 15:35:08 +0000895#define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
danielk1977cdcfe952008-11-18 07:27:24 +0000896 {nArg, SQLITE_UTF8, bNC*8, pArg, 0, xFunc, 0, 0, #zName, 0}
drh777c5382008-08-21 20:21:34 +0000897#define LIKEFUNC(zName, nArg, arg, flags) \
danielk1977cdcfe952008-11-18 07:27:24 +0000898 {nArg, SQLITE_UTF8, flags, (void *)arg, 0, likeFunc, 0, 0, #zName, 0}
drh777c5382008-08-21 20:21:34 +0000899#define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
danielk1977cdcfe952008-11-18 07:27:24 +0000900 {nArg, SQLITE_UTF8, nc*8, SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0}
drh777c5382008-08-21 20:21:34 +0000901
danielk1977fd7f0452008-12-17 17:30:26 +0000902/*
903** All current savepoints are stored in a linked list starting at
904** sqlite3.pSavepoint. The first element in the list is the most recently
905** opened savepoint. Savepoints are added to the list by the vdbe
906** OP_Savepoint instruction.
907*/
908struct Savepoint {
909 char *zName; /* Savepoint name (nul-terminated) */
910 Savepoint *pNext; /* Parent savepoint (if any) */
911};
912
913/*
914** The following are used as the second parameter to sqlite3Savepoint(),
915** and as the P1 argument to the OP_Savepoint instruction.
916*/
917#define SAVEPOINT_BEGIN 0
918#define SAVEPOINT_RELEASE 1
919#define SAVEPOINT_ROLLBACK 2
920
drh777c5382008-08-21 20:21:34 +0000921
922/*
danielk1977d1ab1ba2006-06-15 04:28:13 +0000923** Each SQLite module (virtual table definition) is defined by an
924** instance of the following structure, stored in the sqlite3.aModule
925** hash table.
926*/
927struct Module {
928 const sqlite3_module *pModule; /* Callback pointers */
929 const char *zName; /* Name passed to create_module() */
930 void *pAux; /* pAux passed to create_module() */
danielk1977832a58a2007-06-22 15:21:15 +0000931 void (*xDestroy)(void *); /* Module destructor function */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000932};
933
934/*
drh967e8b72000-06-21 13:59:10 +0000935** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000936** of this structure.
937*/
938struct Column {
drh967e8b72000-06-21 13:59:10 +0000939 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000940 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000941 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000942 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000943 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000944 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000945 char affinity; /* One of the SQLITE_AFF_... values */
danielk1977034ca142007-06-26 10:38:54 +0000946#ifndef SQLITE_OMIT_VIRTUALTABLE
947 u8 isHidden; /* True if this column is 'hidden' */
948#endif
drh7020f652000-06-03 18:06:52 +0000949};
950
951/*
drha9fd84b2004-05-18 23:21:35 +0000952** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000953** structure. Conceptually, a collating sequence consists of a name and
954** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000955**
shane467bcf32008-11-24 20:01:32 +0000956** There may two separate implementations of the collation function, one
danielk19770202b292004-06-09 09:55:16 +0000957** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
958** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
959** native byte order. When a collation sequence is invoked, SQLite selects
960** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000961** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000962**
963** The CollSeq.pUser member variable is an extra parameter that passed in
964** as the first argument to the UTF-8 comparison function, xCmp.
965** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
966** xCmp16.
967**
968** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
969** collating sequence is undefined. Indices built on an undefined
970** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000971*/
972struct CollSeq {
danielk1977a9808b32007-05-07 09:32:45 +0000973 char *zName; /* Name of the collating sequence, UTF-8 encoded */
974 u8 enc; /* Text encoding handled by xCmp() */
975 u8 type; /* One of the SQLITE_COLL_... values below */
976 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000977 int (*xCmp)(void*,int, const void*, int, const void*);
danielk1977a9808b32007-05-07 09:32:45 +0000978 void (*xDel)(void*); /* Destructor for pUser */
drha9fd84b2004-05-18 23:21:35 +0000979};
980
981/*
drh7d10d5a2008-08-20 16:35:10 +0000982** Allowed values of CollSeq.type:
drhd64fe2f2005-08-28 17:00:23 +0000983*/
984#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
985#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
986#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
987#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
988
989/*
drhd3d39e92004-05-20 22:16:29 +0000990** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000991*/
drh8e2ca022002-06-17 17:07:19 +0000992#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000993#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000994
995/*
danielk1977a37cdde2004-05-16 11:15:36 +0000996** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000997**
998** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
999** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
drh7d10d5a2008-08-20 16:35:10 +00001000** the speed a little by numbering the values consecutively.
drh8a512562005-11-14 22:29:05 +00001001**
1002** But rather than start with 0 or 1, we begin with 'a'. That way,
1003** when multiple affinity types are concatenated into a string and
drh66a51672008-01-03 00:01:23 +00001004** used as the P4 operand, they will be more readable.
drh8a512562005-11-14 22:29:05 +00001005**
1006** Note also that the numeric types are grouped together so that testing
1007** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +00001008*/
drh8a512562005-11-14 22:29:05 +00001009#define SQLITE_AFF_TEXT 'a'
1010#define SQLITE_AFF_NONE 'b'
1011#define SQLITE_AFF_NUMERIC 'c'
1012#define SQLITE_AFF_INTEGER 'd'
1013#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +00001014
drh8a512562005-11-14 22:29:05 +00001015#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +00001016
1017/*
drh35573352008-01-08 23:54:25 +00001018** The SQLITE_AFF_MASK values masks off the significant bits of an
1019** affinity value.
1020*/
1021#define SQLITE_AFF_MASK 0x67
1022
1023/*
1024** Additional bit values that can be ORed with an affinity without
1025** changing the affinity.
1026*/
1027#define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */
drh93a960a2008-07-10 00:32:42 +00001028#define SQLITE_STOREP2 0x10 /* Store result in reg[P2] rather than jump */
drh35573352008-01-08 23:54:25 +00001029
1030/*
drh22f70c32002-02-18 01:17:00 +00001031** Each SQL table is represented in memory by an instance of the
1032** following structure.
1033**
drhd24cc422003-03-27 12:51:24 +00001034** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +00001035** CREATE TABLE statement is stored, but case is not significant for
1036** comparisons.
1037**
drhd24cc422003-03-27 12:51:24 +00001038** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +00001039** pointer to an array of Column structures, one for each column.
1040**
drhd24cc422003-03-27 12:51:24 +00001041** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
1042** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +00001043** that the datatype of the PRIMARY KEY must be INTEGER for this field to
1044** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
1045** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drh7d10d5a2008-08-20 16:35:10 +00001046** is generated for each row of the table. TF_HasPrimaryKey is set if
drh22f70c32002-02-18 01:17:00 +00001047** the table has any PRIMARY KEY, INTEGER or otherwise.
1048**
drhd24cc422003-03-27 12:51:24 +00001049** Table.tnum is the page number for the root BTree page of the table in the
1050** database file. If Table.iDb is the index of the database table backend
1051** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drh7d10d5a2008-08-20 16:35:10 +00001052** holds temporary tables and indices. If TF_Ephemeral is set
1053** then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +00001054** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +00001055** refers VDBE cursor number that holds the table open, not to the root
1056** page number. Transient tables are used to hold the results of a
1057** sub-query that appears instead of a real table name in the FROM clause
1058** of a SELECT statement.
drh75897232000-05-29 14:26:00 +00001059*/
1060struct Table {
drh7d10d5a2008-08-20 16:35:10 +00001061 sqlite3 *db; /* Associated database connection. Might be NULL. */
1062 char *zName; /* Name of the table or view */
1063 int iPKey; /* If not negative, use aCol[iPKey] as the primary key */
1064 int nCol; /* Number of columns in this table */
1065 Column *aCol; /* Information about each column */
1066 Index *pIndex; /* List of SQL indexes on this table. */
1067 int tnum; /* Root BTree node for this table (see note above) */
1068 Select *pSelect; /* NULL for tables. Points to definition if a view. */
1069 u16 nRef; /* Number of pointers to this Table */
1070 u8 tabFlags; /* Mask of TF_* values */
1071 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
1072 Trigger *pTrigger; /* List of SQL triggers on this table */
1073 FKey *pFKey; /* Linked list of all foreign keys in this table */
1074 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +00001075#ifndef SQLITE_OMIT_CHECK
drh7d10d5a2008-08-20 16:35:10 +00001076 Expr *pCheck; /* The AND of all CHECK constraints */
drhffe07b22005-11-03 00:41:17 +00001077#endif
danielk197719a8e7e2005-03-17 05:03:38 +00001078#ifndef SQLITE_OMIT_ALTERTABLE
drh7d10d5a2008-08-20 16:35:10 +00001079 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
danielk197719a8e7e2005-03-17 05:03:38 +00001080#endif
drhe09daa92006-06-10 13:29:31 +00001081#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7d10d5a2008-08-20 16:35:10 +00001082 Module *pMod; /* Pointer to the implementation of the module */
1083 sqlite3_vtab *pVtab; /* Pointer to the module instance */
1084 int nModuleArg; /* Number of arguments to the module */
1085 char **azModuleArg; /* Text of all module args. [0] is module name */
drhe09daa92006-06-10 13:29:31 +00001086#endif
drh7d10d5a2008-08-20 16:35:10 +00001087 Schema *pSchema; /* Schema that contains this table */
drh588a9a12008-09-01 15:52:10 +00001088 Table *pNextZombie; /* Next on the Parse.pZombieTab list */
drh75897232000-05-29 14:26:00 +00001089};
1090
1091/*
drh7d10d5a2008-08-20 16:35:10 +00001092** Allowed values for Tabe.tabFlags.
1093*/
1094#define TF_Readonly 0x01 /* Read-only system table */
shane467bcf32008-11-24 20:01:32 +00001095#define TF_Ephemeral 0x02 /* An ephemeral table */
drh7d10d5a2008-08-20 16:35:10 +00001096#define TF_HasPrimaryKey 0x04 /* Table has a primary key */
1097#define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */
1098#define TF_Virtual 0x10 /* Is a virtual table */
1099#define TF_NeedMetadata 0x20 /* aCol[].zType and aCol[].pColl missing */
1100
1101
1102
1103/*
drh4cbdda92006-06-14 19:00:20 +00001104** Test to see whether or not a table is a virtual table. This is
1105** done as a macro so that it will be optimized out when virtual
1106** table support is omitted from the build.
1107*/
1108#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7d10d5a2008-08-20 16:35:10 +00001109# define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0)
danielk1977034ca142007-06-26 10:38:54 +00001110# define IsHiddenColumn(X) ((X)->isHidden)
drh4cbdda92006-06-14 19:00:20 +00001111#else
danielk1977034ca142007-06-26 10:38:54 +00001112# define IsVirtual(X) 0
1113# define IsHiddenColumn(X) 0
drh4cbdda92006-06-14 19:00:20 +00001114#endif
1115
1116/*
drhc2eef3b2002-08-31 18:53:06 +00001117** Each foreign key constraint is an instance of the following structure.
1118**
1119** A foreign key is associated with two tables. The "from" table is
1120** the table that contains the REFERENCES clause that creates the foreign
1121** key. The "to" table is the table that is named in the REFERENCES clause.
1122** Consider this example:
1123**
1124** CREATE TABLE ex1(
1125** a INTEGER PRIMARY KEY,
1126** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1127** );
1128**
1129** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1130**
1131** Each REFERENCES clause generates an instance of the following structure
1132** which is attached to the from-table. The to-table need not exist when
shane467bcf32008-11-24 20:01:32 +00001133** the from-table is created. The existence of the to-table is not checked
drhc2eef3b2002-08-31 18:53:06 +00001134** until an attempt is made to insert data into the from-table.
1135**
drhea1ba172003-04-20 00:00:23 +00001136** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +00001137** given the name of a to-table. For each to-table, all foreign keys
1138** associated with that table are on a linked list using the FKey.pNextTo
1139** field.
1140*/
1141struct FKey {
shane467bcf32008-11-24 20:01:32 +00001142 Table *pFrom; /* The table that contains the REFERENCES clause */
drhc2eef3b2002-08-31 18:53:06 +00001143 FKey *pNextFrom; /* Next foreign key in pFrom */
1144 char *zTo; /* Name of table that the key points to */
1145 FKey *pNextTo; /* Next foreign key that points to zTo */
1146 int nCol; /* Number of columns in this key */
1147 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
1148 int iFrom; /* Index of column in pFrom */
1149 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
1150 } *aCol; /* One entry for each of nCol column s */
1151 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
1152 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
1153 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
1154 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
1155};
1156
1157/*
danielk1977aaa40c12007-09-21 04:28:16 +00001158** SQLite supports many different ways to resolve a constraint
drh22f70c32002-02-18 01:17:00 +00001159** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +00001160** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +00001161** to be rolled back. ABORT processing means the operation in process
1162** fails and any prior changes from that one operation are backed out,
1163** but the transaction is not rolled back. FAIL processing means that
1164** the operation in progress stops and returns an error code. But prior
1165** changes due to the same operation are not backed out and no rollback
1166** occurs. IGNORE means that the particular row that caused the constraint
1167** error is not inserted or updated. Processing continues and no error
1168** is returned. REPLACE means that preexisting database rows that caused
1169** a UNIQUE constraint violation are removed so that the new insert or
1170** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +00001171**
1172** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1173** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1174** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
1175** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
1176** referenced table row is propagated into the row that holds the
1177** foreign key.
drh1c928532002-01-31 15:54:21 +00001178**
drh968af522003-02-11 14:55:40 +00001179** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +00001180** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +00001181*/
drh1c928532002-01-31 15:54:21 +00001182#define OE_None 0 /* There is no constraint to check */
1183#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
1184#define OE_Abort 2 /* Back out changes but do no rollback transaction */
1185#define OE_Fail 3 /* Stop the operation but leave all prior changes */
1186#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
1187#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +00001188
1189#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1190#define OE_SetNull 7 /* Set the foreign key value to NULL */
1191#define OE_SetDflt 8 /* Set the foreign key value to its default */
1192#define OE_Cascade 9 /* Cascade the changes */
1193
1194#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +00001195
drhd3d39e92004-05-20 22:16:29 +00001196
1197/*
1198** An instance of the following structure is passed as the first
1199** argument to sqlite3VdbeKeyCompare and is used to control the
1200** comparison of the two index keys.
drhd3d39e92004-05-20 22:16:29 +00001201*/
1202struct KeyInfo {
drhb21c8cd2007-08-21 19:33:56 +00001203 sqlite3 *db; /* The database connection */
danielk1977b1bc9532004-05-22 03:05:33 +00001204 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhe63d9992008-08-13 19:11:48 +00001205 u16 nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +00001206 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +00001207 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
1208};
1209
drh9cfcf5d2002-01-29 18:41:24 +00001210/*
drhe63d9992008-08-13 19:11:48 +00001211** An instance of the following structure holds information about a
1212** single index record that has already been parsed out into individual
1213** values.
1214**
1215** A record is an object that contains one or more fields of data.
1216** Records are used to store the content of a table row and to store
1217** the key of an index. A blob encoding of a record is created by
shane467bcf32008-11-24 20:01:32 +00001218** the OP_MakeRecord opcode of the VDBE and is disassembled by the
drhe63d9992008-08-13 19:11:48 +00001219** OP_Column opcode.
1220**
1221** This structure holds a record that has already been disassembled
shane467bcf32008-11-24 20:01:32 +00001222** into its constituent fields.
drhe63d9992008-08-13 19:11:48 +00001223*/
1224struct UnpackedRecord {
1225 KeyInfo *pKeyInfo; /* Collation and sort-order information */
1226 u16 nField; /* Number of entries in apMem[] */
1227 u16 flags; /* Boolean settings. UNPACKED_... below */
1228 Mem *aMem; /* Values */
1229};
1230
1231/*
1232** Allowed values of UnpackedRecord.flags
1233*/
1234#define UNPACKED_NEED_FREE 0x0001 /* Memory is from sqlite3Malloc() */
1235#define UNPACKED_NEED_DESTROY 0x0002 /* apMem[]s should all be destroyed */
1236#define UNPACKED_IGNORE_ROWID 0x0004 /* Ignore trailing rowid on key1 */
1237#define UNPACKED_INCRKEY 0x0008 /* Make this key an epsilon larger */
1238#define UNPACKED_PREFIX_MATCH 0x0010 /* A prefix match is considered OK */
1239
1240/*
drh66b89c82000-11-28 20:47:17 +00001241** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +00001242** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +00001243**
1244** The columns of the table that are to be indexed are described
1245** by the aiColumn[] field of this structure. For example, suppose
1246** we have the following table and index:
1247**
1248** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1249** CREATE INDEX Ex2 ON Ex1(c3,c1);
1250**
1251** In the Table structure describing Ex1, nCol==3 because there are
1252** three columns in the table. In the Index structure describing
1253** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1254** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
1255** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1256** The second column to be indexed (c1) has an index of 0 in
1257** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +00001258**
1259** The Index.onError field determines whether or not the indexed columns
1260** must be unique and what to do if they are not. When Index.onError=OE_None,
1261** it means this is not a unique index. Otherwise it is a unique index
1262** and the value of Index.onError indicate the which conflict resolution
1263** algorithm to employ whenever an attempt is made to insert a non-unique
1264** element.
drh75897232000-05-29 14:26:00 +00001265*/
1266struct Index {
drh967e8b72000-06-21 13:59:10 +00001267 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +00001268 int nColumn; /* Number of columns in the table used by this index */
1269 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +00001270 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +00001271 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +00001272 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +00001273 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +00001274 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +00001275 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +00001276 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +00001277 Schema *pSchema; /* Schema containing this index */
1278 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
1279 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +00001280};
1281
1282/*
1283** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +00001284** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +00001285**
1286** Note if Token.z==0 then Token.dyn and Token.n are undefined and
shane467bcf32008-11-24 20:01:32 +00001287** may contain random values. Do not make any assumptions about Token.dyn
drh4efc4752004-01-16 15:55:37 +00001288** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +00001289*/
1290struct Token {
drh4c755c02004-08-08 20:22:17 +00001291 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
1292 unsigned dyn : 1; /* True for malloced memory, false for static */
1293 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +00001294};
1295
1296/*
drh13449892005-09-07 21:22:45 +00001297** An instance of this structure contains information needed to generate
1298** code for a SELECT that contains aggregate functions.
1299**
1300** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
1301** pointer to this structure. The Expr.iColumn field is the index in
1302** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
1303** code for that node.
1304**
1305** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
1306** original Select structure that describes the SELECT statement. These
1307** fields do not need to be freed when deallocating the AggInfo structure.
1308*/
1309struct AggInfo {
1310 u8 directMode; /* Direct rendering mode means take data directly
1311 ** from source tables rather than from accumulators */
1312 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
1313 ** than the source table */
1314 int sortingIdx; /* Cursor number of the sorting index */
1315 ExprList *pGroupBy; /* The group by clause */
1316 int nSortingColumn; /* Number of columns in the sorting index */
1317 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +00001318 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +00001319 int iTable; /* Cursor number of the source table */
1320 int iColumn; /* Column number within the source table */
1321 int iSorterColumn; /* Column number in the sorting index */
1322 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +00001323 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +00001324 } *aCol;
1325 int nColumn; /* Number of used entries in aCol[] */
1326 int nColumnAlloc; /* Number of slots allocated for aCol[] */
1327 int nAccumulator; /* Number of columns that show through to the output.
1328 ** Additional columns are used only as parameters to
1329 ** aggregate functions */
1330 struct AggInfo_func { /* For each aggregate function */
1331 Expr *pExpr; /* Expression encoding the function */
1332 FuncDef *pFunc; /* The aggregate function implementation */
1333 int iMem; /* Memory location that acts as accumulator */
shane467bcf32008-11-24 20:01:32 +00001334 int iDistinct; /* Ephemeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +00001335 } *aFunc;
1336 int nFunc; /* Number of entries in aFunc[] */
1337 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
1338};
1339
1340/*
drh75897232000-05-29 14:26:00 +00001341** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +00001342** of this structure.
1343**
1344** Expr.op is the opcode. The integer parser token codes are reused
1345** as opcodes here. For example, the parser defines TK_GE to be an integer
1346** code representing the ">=" operator. This same integer code is reused
1347** to represent the greater-than-or-equal-to operator in the expression
1348** tree.
1349**
1350** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
1351** of argument if the expression is a function.
1352**
drh4b59ab52002-08-24 18:24:51 +00001353** Expr.token is the operator token for this node. For some expressions
1354** that have subexpressions, Expr.token can be the complete text that gave
1355** rise to the Expr. In the latter case, the token is marked as being
1356** a compound token.
drh22f70c32002-02-18 01:17:00 +00001357**
1358** An expression of the form ID or ID.ID refers to a column in a table.
1359** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
1360** the integer cursor number of a VDBE cursor pointing to that table and
1361** Expr.iColumn is the column number for the specific column. If the
1362** expression is used as a result in an aggregate SELECT, then the
1363** value is also stored in the Expr.iAgg column in the aggregate so that
1364** it can be accessed after all aggregates are computed.
1365**
1366** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +00001367** representing which function. If the expression is an unbound variable
1368** marker (a question mark character '?' in the original SQL) then the
1369** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +00001370**
drh1398ad32005-01-19 23:24:50 +00001371** If the expression is a subquery then Expr.iColumn holds an integer
1372** register number containing the result of the subquery. If the
1373** subquery gives a constant result, then iTable is -1. If the subquery
1374** gives a different answer at different times during statement processing
1375** then iTable is the address of a subroutine that computes the subquery.
1376**
drh22f70c32002-02-18 01:17:00 +00001377** The Expr.pSelect field points to a SELECT statement. The SELECT might
1378** be the right operand of an IN operator. Or, if a scalar SELECT appears
1379** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
1380** operand.
danielk1977aee18ef2005-03-09 12:26:50 +00001381**
1382** If the Expr is of type OP_Column, and the table it is selecting from
1383** is a disk table or the "old.*" pseudo-table, then pTab points to the
1384** corresponding table definition.
drh75897232000-05-29 14:26:00 +00001385*/
1386struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001387 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001388 char affinity; /* The affinity of the column or 0 if not a column */
drh6a03a1c2006-07-08 18:34:59 +00001389 u16 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +00001390 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +00001391 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +00001392 ExprList *pList; /* A list of expressions used as function arguments
1393 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +00001394 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +00001395 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +00001396 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +00001397 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +00001398 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1399 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +00001400 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +00001401 Select *pSelect; /* When the expression is a sub-select. Also the
1402 ** right side of "<expr> IN (<select>)" */
drh7d10d5a2008-08-20 16:35:10 +00001403 Table *pTab; /* Table for TK_COLUMN expressions. */
drh0224d262008-05-28 13:49:34 +00001404#if SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001405 int nHeight; /* Height of the tree headed by this node */
1406#endif
drh75897232000-05-29 14:26:00 +00001407};
1408
1409/*
drh1f162302002-10-27 19:35:33 +00001410** The following are the meanings of bits in the Expr.flags field.
1411*/
drh678ccce2008-03-31 18:19:54 +00001412#define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */
1413#define EP_Agg 0x0002 /* Contains one or more aggregate functions */
1414#define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */
1415#define EP_Error 0x0008 /* Expression contains one or more errors */
1416#define EP_Distinct 0x0010 /* Aggregate function with DISTINCT keyword */
1417#define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */
1418#define EP_Dequoted 0x0040 /* True if the string has been dequoted */
1419#define EP_InfixFunc 0x0080 /* True for an infix function: LIKE, GLOB, etc */
1420#define EP_ExpCollate 0x0100 /* Collating sequence specified explicitly */
drhda250ea2008-04-01 05:07:14 +00001421#define EP_AnyAff 0x0200 /* Can take a cached column of any affinity */
drh47de9552008-04-01 18:04:11 +00001422#define EP_FixedDest 0x0400 /* Result needed in a specific register */
drh92b01d52008-06-24 00:32:35 +00001423#define EP_IntValue 0x0800 /* Integer value contained in iTable */
drh1f162302002-10-27 19:35:33 +00001424/*
1425** These macros can be used to test, set, or clear bits in the
1426** Expr.flags field.
1427*/
1428#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1429#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1430#define ExprSetProperty(E,P) (E)->flags|=(P)
1431#define ExprClearProperty(E,P) (E)->flags&=~(P)
1432
1433/*
drh75897232000-05-29 14:26:00 +00001434** A list of expressions. Each expression may optionally have a
1435** name. An expr/name combination can be used in several ways, such
1436** as the list of "expr AS ID" fields following a "SELECT" or in the
1437** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001438** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001439** field is not used.
1440*/
1441struct ExprList {
1442 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001443 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001444 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001445 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001446 Expr *pExpr; /* The list of expressions */
1447 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001448 u8 sortOrder; /* 1 for DESC or 0 for ASC */
drh8e2ca022002-06-17 17:07:19 +00001449 u8 done; /* A flag to indicate when processing is finished */
drh7d10d5a2008-08-20 16:35:10 +00001450 u16 iCol; /* For ORDER BY, column number in result set */
drh8b213892008-08-29 02:14:02 +00001451 u16 iAlias; /* Index into Parse.aAlias[] for zName */
drh75897232000-05-29 14:26:00 +00001452 } *a; /* One entry for each expression */
1453};
1454
1455/*
drhad3cab52002-05-24 02:04:32 +00001456** An instance of this structure can hold a simple list of identifiers,
1457** such as the list "a,b,c" in the following statements:
1458**
1459** INSERT INTO t(a,b,c) VALUES ...;
1460** CREATE INDEX idx ON t(a,b,c);
1461** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1462**
1463** The IdList.a.idx field is used when the IdList represents the list of
1464** column names after a table name in an INSERT statement. In the statement
1465**
1466** INSERT INTO t(a,b,c) ...
1467**
1468** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001469*/
1470struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001471 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001472 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001473 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001474 } *a;
drh13449892005-09-07 21:22:45 +00001475 int nId; /* Number of identifiers on the list */
1476 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001477};
1478
1479/*
drh51669862004-12-18 18:40:26 +00001480** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001481**
1482** Changing this from a 64-bit to a 32-bit type limits the number of
1483** tables in a join to 32 instead of 64. But it also reduces the size
1484** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001485*/
drhca83ac52007-02-01 01:40:44 +00001486typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001487
1488/*
danielk197700e13612008-11-17 19:18:54 +00001489** The number of bits in a Bitmask. "BMS" means "BitMask Size".
1490*/
1491#define BMS ((int)(sizeof(Bitmask)*8))
1492
1493/*
drhad3cab52002-05-24 02:04:32 +00001494** The following structure describes the FROM clause of a SELECT statement.
1495** Each table or subquery in the FROM clause is a separate element of
1496** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001497**
1498** With the addition of multiple database support, the following structure
1499** can also be used to describe a particular table such as the table that
1500** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1501** such a table must be a simple name: ID. But in SQLite, the table can
1502** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001503**
1504** The jointype starts out showing the join type between the current table
1505** and the next table on the list. The parser builds the list this way.
1506** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1507** jointype expresses the join between the table and the previous table.
drhad3cab52002-05-24 02:04:32 +00001508*/
1509struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001510 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1511 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001512 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001513 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001514 char *zName; /* Name of the table */
1515 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001516 Table *pTab; /* An SQL table corresponding to zName */
1517 Select *pSelect; /* A SELECT statement used in place of a table name */
danielk19771787cca2006-02-10 07:07:14 +00001518 u8 isPopulated; /* Temporary table associated with SELECT is populated */
drhc49de5d2007-01-19 01:06:01 +00001519 u8 jointype; /* Type of join between this able and the previous */
drhdd5f5a62008-12-23 13:35:23 +00001520 u8 notIndexed; /* True if there is a NOT INDEXED clause */
drhe68fbe72007-02-13 12:49:24 +00001521 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001522 Expr *pOn; /* The ON clause of a join */
1523 IdList *pUsing; /* The USING clause of a join */
danielk1977cd38d522009-01-02 17:33:46 +00001524 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */
danielk197785574e32008-10-06 05:32:18 +00001525 char *zIndex; /* Identifier from "INDEXED BY <zIndex>" clause */
1526 Index *pIndex; /* Index structure corresponding to zIndex, if any */
drh113088e2003-03-20 01:16:58 +00001527 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001528};
1529
1530/*
drh01f3f252002-05-24 16:14:15 +00001531** Permitted values of the SrcList.a.jointype field
1532*/
1533#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001534#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1535#define JT_NATURAL 0x0004 /* True for a "natural" join */
1536#define JT_LEFT 0x0008 /* Left outer join */
1537#define JT_RIGHT 0x0010 /* Right outer join */
1538#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1539#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001540
drh111a6a72008-12-21 03:51:16 +00001541
1542/*
1543** A WherePlan object holds information that describes a lookup
1544** strategy.
1545**
1546** This object is intended to be opaque outside of the where.c module.
1547** It is included here only so that that compiler will know how big it
1548** is. None of the fields in this object should be used outside of
1549** the where.c module.
1550**
1551** Within the union, pIdx is only used when wsFlags&WHERE_INDEXED is true.
1552** pTerm is only used when wsFlags&WHERE_MULTI_OR is true. And pVtabIdx
1553** is only used when wsFlags&WHERE_VIRTUALTABLE is true. It is never the
1554** case that more than one of these conditions is true.
1555*/
1556struct WherePlan {
1557 u32 wsFlags; /* WHERE_* flags that describe the strategy */
1558 u32 nEq; /* Number of == constraints */
1559 union {
1560 Index *pIdx; /* Index when WHERE_INDEXED is true */
1561 struct WhereTerm *pTerm; /* WHERE clause term for OR-search */
1562 sqlite3_index_info *pVtabIdx; /* Virtual table index to use */
1563 } u;
1564};
1565
drh01f3f252002-05-24 16:14:15 +00001566/*
drh6b563442001-11-07 16:48:26 +00001567** For each nested loop in a WHERE clause implementation, the WhereInfo
1568** structure contains a single instance of this structure. This structure
1569** is intended to be private the the where.c module and should not be
1570** access or modified by other modules.
drh6d209d82006-06-27 01:54:26 +00001571**
drh111a6a72008-12-21 03:51:16 +00001572** The pIdxInfo field is used to help pick the best index on a
1573** virtual table. The pIdxInfo pointer contains indexing
drh6d209d82006-06-27 01:54:26 +00001574** information for the i-th table in the FROM clause before reordering.
1575** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
drh111a6a72008-12-21 03:51:16 +00001576** All other information in the i-th WhereLevel object for the i-th table
1577** after FROM clause ordering.
drh6b563442001-11-07 16:48:26 +00001578*/
1579struct WhereLevel {
drh111a6a72008-12-21 03:51:16 +00001580 WherePlan plan; /* query plan for this element of the FROM clause */
drh29dda4a2005-07-21 18:23:20 +00001581 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
drh29dda4a2005-07-21 18:23:20 +00001582 int iTabCur; /* The VDBE cursor used to access the table */
shane467bcf32008-11-24 20:01:32 +00001583 int iIdxCur; /* The VDBE cursor used to access pIdx */
drhb3190c12008-12-08 21:37:14 +00001584 int addrBrk; /* Jump here to break out of the loop */
1585 int addrNxt; /* Jump here to start the next IN combination */
1586 int addrCont; /* Jump here to continue with the next loop cycle */
1587 int addrFirst; /* First instruction of interior of the loop */
drh700a2262008-12-17 19:22:15 +00001588 u8 iFrom; /* Which entry in the FROM clause */
drh111a6a72008-12-21 03:51:16 +00001589 u8 op, p5; /* Opcode and P5 of the opcode that ends the loop */
1590 int p1, p2; /* Operands of the opcode used to ends the loop */
1591 union { /* Information that depends on plan.wsFlags */
1592 struct {
1593 int nIn; /* Number of entries in aInLoop[] */
1594 struct InLoop {
1595 int iCur; /* The VDBE cursor used by this IN operator */
1596 int addrInTop; /* Top of the IN loop */
1597 } *aInLoop; /* Information about each nested IN operator */
1598 } in; /* Used when plan.wsFlags&WHERE_IN_ABLE */
1599 struct {
1600 WherePlan *aPlan; /* Plans for each term of the WHERE clause */
1601 } or; /* Used when plan.wsFlags&WHERE_MULTI_OR */
1602 } u;
drh6d209d82006-06-27 01:54:26 +00001603
1604 /* The following field is really not part of the current level. But
drh111a6a72008-12-21 03:51:16 +00001605 ** we need a place to cache virtual table index information for each
1606 ** virtual table in the FROM clause and the WhereLevel structure is
1607 ** a convenient place since there is one WhereLevel for each FROM clause
1608 ** element.
drh6d209d82006-06-27 01:54:26 +00001609 */
1610 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */
drh6b563442001-11-07 16:48:26 +00001611};
1612
drh08c88eb2008-04-10 13:33:18 +00001613/*
drh165be382008-12-05 02:36:33 +00001614** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin().
drh08c88eb2008-04-10 13:33:18 +00001615*/
drh6df2acd2008-12-28 16:55:25 +00001616#define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
1617#define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
1618#define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
1619#define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
1620#define WHERE_FILL_ROWSET 0x0008 /* Save results in a RowSet object */
1621#define WHERE_OMIT_OPEN 0x0010 /* Table cursor are already open */
1622#define WHERE_OMIT_CLOSE 0x0020 /* Omit close of table & index cursors */
danielk1977a9d1ccb2008-01-05 17:39:29 +00001623
drh6b563442001-11-07 16:48:26 +00001624/*
drh75897232000-05-29 14:26:00 +00001625** The WHERE clause processing routine has two halves. The
1626** first part does the start of the WHERE loop and the second
1627** half does the tail of the WHERE loop. An instance of
1628** this structure is returned by the first half and passed
1629** into the second half to give some continuity.
1630*/
1631struct WhereInfo {
drh08c88eb2008-04-10 13:33:18 +00001632 Parse *pParse; /* Parsing and code generating context */
drh6df2acd2008-12-28 16:55:25 +00001633 u16 wctrlFlags; /* Flags originally passed to sqlite3WhereBegin() */
drh08c88eb2008-04-10 13:33:18 +00001634 u8 okOnePass; /* Ok to use one-pass algorithm for UPDATE or DELETE */
drh23d04d52008-12-23 23:56:22 +00001635 int regRowSet; /* Store rowids in this rowset if >=0 */
drh111a6a72008-12-21 03:51:16 +00001636 SrcList *pTabList; /* List of tables in the join */
1637 int iTop; /* The very beginning of the WHERE loop */
1638 int iContinue; /* Jump here to continue with next record */
1639 int iBreak; /* Jump here to break out of the loop */
1640 int nLevel; /* Number of nested loop */
1641 struct WhereClause *pWC; /* Decomposition of the WHERE clause */
drh111a6a72008-12-21 03:51:16 +00001642 WhereLevel a[1]; /* Information about each nest loop in WHERE */
drh75897232000-05-29 14:26:00 +00001643};
1644
1645/*
danielk1977b3bce662005-01-29 08:32:43 +00001646** A NameContext defines a context in which to resolve table and column
1647** names. The context consists of a list of tables (the pSrcList) field and
1648** a list of named expression (pEList). The named expression list may
1649** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1650** to the table being operated on by INSERT, UPDATE, or DELETE. The
1651** pEList corresponds to the result set of a SELECT and is NULL for
1652** other statements.
1653**
1654** NameContexts can be nested. When resolving names, the inner-most
1655** context is searched first. If no match is found, the next outer
1656** context is checked. If there is still no match, the next context
1657** is checked. This process continues until either a match is found
1658** or all contexts are check. When a match is found, the nRef member of
1659** the context containing the match is incremented.
1660**
1661** Each subquery gets a new NameContext. The pNext field points to the
1662** NameContext in the parent query. Thus the process of scanning the
1663** NameContext list corresponds to searching through successively outer
1664** subqueries looking for a match.
1665*/
1666struct NameContext {
1667 Parse *pParse; /* The parser */
1668 SrcList *pSrcList; /* One or more tables used to resolve names */
1669 ExprList *pEList; /* Optional list of named expressions */
1670 int nRef; /* Number of names resolved by this context */
1671 int nErr; /* Number of errors encountered while resolving names */
1672 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001673 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001674 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001675 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001676 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001677 NameContext *pNext; /* Next outer name context. NULL for outermost */
1678};
1679
1680/*
drh9bb61fe2000-06-05 16:01:39 +00001681** An instance of the following structure contains all information
1682** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001683**
drhd11d3822002-06-21 23:01:49 +00001684** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1685** If there is a LIMIT clause, the parser sets nLimit to the value of the
1686** limit and nOffset to the value of the offset (or 0 if there is not
1687** offset). But later on, nLimit and nOffset become the memory locations
1688** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001689**
drhb9bb7c12006-06-11 23:41:55 +00001690** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00001691** These addresses must be stored so that we can go back and fill in
drh66a51672008-01-03 00:01:23 +00001692** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
drh0342b1f2005-09-01 03:07:44 +00001693** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00001694** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00001695** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00001696** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1697** for the result set. The KeyInfo for addrOpenTran[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00001698** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001699*/
1700struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001701 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001702 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
drh6c1426f2007-04-12 03:54:38 +00001703 char affinity; /* MakeRecord with this affinity for SRT_Set */
drh7d10d5a2008-08-20 16:35:10 +00001704 u16 selFlags; /* Various SF_* values */
drhad3cab52002-05-24 02:04:32 +00001705 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001706 Expr *pWhere; /* The WHERE clause */
1707 ExprList *pGroupBy; /* The GROUP BY clause */
1708 Expr *pHaving; /* The HAVING clause */
1709 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001710 Select *pPrior; /* Prior select in a compound select statement */
drh1e281292007-12-13 03:45:07 +00001711 Select *pNext; /* Next select to the left in a compound */
drh0342b1f2005-09-01 03:07:44 +00001712 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001713 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1714 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001715 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drhb9bb7c12006-06-11 23:41:55 +00001716 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001717};
1718
1719/*
drh7d10d5a2008-08-20 16:35:10 +00001720** Allowed values for Select.selFlags. The "SF" prefix stands for
1721** "Select Flag".
1722*/
1723#define SF_Distinct 0x0001 /* Output should be DISTINCT */
1724#define SF_Resolved 0x0002 /* Identifiers have been resolved */
1725#define SF_Aggregate 0x0004 /* Contains aggregate functions */
1726#define SF_UsesEphemeral 0x0008 /* Uses the OpenEphemeral opcode */
1727#define SF_Expanded 0x0010 /* sqlite3SelectExpand() called on this */
1728#define SF_HasTypeInfo 0x0020 /* FROM subqueries have Table metadata */
1729
1730
1731/*
1732** The results of a select can be distributed in several ways. The
1733** "SRT" prefix means "SELECT Result Type".
drhfef52082000-06-06 01:50:43 +00001734*/
drh13449892005-09-07 21:22:45 +00001735#define SRT_Union 1 /* Store result as keys in an index */
1736#define SRT_Except 2 /* Remove result from a UNION index */
danielk19779ed1dfa2008-01-02 17:11:14 +00001737#define SRT_Exists 3 /* Store 1 if the result is not empty */
1738#define SRT_Discard 4 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001739
drh13449892005-09-07 21:22:45 +00001740/* The ORDER BY clause is ignored for all of the above */
danielk19776c8c8ce2008-01-02 16:27:09 +00001741#define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
drh13449892005-09-07 21:22:45 +00001742
drh7d10d5a2008-08-20 16:35:10 +00001743#define SRT_Output 5 /* Output each row of result */
danielk19779ed1dfa2008-01-02 17:11:14 +00001744#define SRT_Mem 6 /* Store result in a memory cell */
danielk19770cdc0222008-06-26 18:04:03 +00001745#define SRT_Set 7 /* Store results as keys in an index */
danielk19779ed1dfa2008-01-02 17:11:14 +00001746#define SRT_Table 8 /* Store result as data with an automatic rowid */
1747#define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */
drhe00ee6e2008-06-20 15:24:01 +00001748#define SRT_Coroutine 10 /* Generate a single row of result */
drh22827922000-06-06 17:27:05 +00001749
1750/*
shane467bcf32008-11-24 20:01:32 +00001751** A structure used to customize the behavior of sqlite3Select(). See
danielk19776c8c8ce2008-01-02 16:27:09 +00001752** comments above sqlite3Select() for details.
1753*/
1754typedef struct SelectDest SelectDest;
1755struct SelectDest {
drh477df4b2008-01-05 18:48:24 +00001756 u8 eDest; /* How to dispose of the results */
1757 u8 affinity; /* Affinity used when eDest==SRT_Set */
danielk19776c8c8ce2008-01-02 16:27:09 +00001758 int iParm; /* A parameter used by the eDest disposal method */
drh1013c932008-01-06 00:25:21 +00001759 int iMem; /* Base register where results are written */
drhad27e762008-03-26 12:46:23 +00001760 int nMem; /* Number of registers allocated */
danielk19776c8c8ce2008-01-02 16:27:09 +00001761};
1762
1763/*
drhf57b3392001-10-08 13:22:32 +00001764** An SQL parser context. A copy of this structure is passed through
1765** the parser and down into all the parser action routine in order to
1766** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001767**
1768** The structure is divided into two parts. When the parser and code
1769** generate call themselves recursively, the first part of the structure
1770** is constant but the second part is reset at the beginning and end of
1771** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001772**
1773** The nTableLock and aTableLock variables are only used if the shared-cache
1774** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1775** used to store the set of table-locks required by the statement being
1776** compiled. Function sqlite3TableLock() is used to add entries to the
1777** list.
drh75897232000-05-29 14:26:00 +00001778*/
1779struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001780 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001781 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001782 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001783 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001784 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001785 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001786 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001787 u8 nested; /* Number of nested calls to the parser/code generator */
drh7e326c02007-05-15 16:51:37 +00001788 u8 parseError; /* True after a parsing error. Ticket #1794 */
drh892d3172008-01-10 03:46:36 +00001789 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
drh2dcef112008-01-12 19:03:48 +00001790 u8 nTempInUse; /* Number of aTempReg[] currently checked out */
drh892d3172008-01-10 03:46:36 +00001791 int aTempReg[8]; /* Holding area for temporary registers */
1792 int nRangeReg; /* Size of the temporary register block */
1793 int iRangeReg; /* First register in temporary register block */
drh75897232000-05-29 14:26:00 +00001794 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001795 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001796 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001797 int nSet; /* Number of sets used so far */
drhaa9b8962008-01-08 02:57:55 +00001798 int ckBase; /* Base register of data during check constraints */
drhe55cbd72008-03-31 23:48:03 +00001799 int disableColCache; /* True to disable adding to column cache */
1800 int nColCache; /* Number of entries in the column cache */
1801 int iColCache; /* Next entry of the cache to replace */
drh2f7794c2008-04-01 03:27:39 +00001802 struct yColCache {
drhe55cbd72008-03-31 23:48:03 +00001803 int iTable; /* Table cursor number */
1804 int iColumn; /* Table column number */
drhda250ea2008-04-01 05:07:14 +00001805 char affChange; /* True if this register has had an affinity change */
drhe55cbd72008-03-31 23:48:03 +00001806 int iReg; /* Register holding value of this column */
1807 } aColCache[10]; /* One for each valid column cache entry */
drh80242052004-06-09 00:48:12 +00001808 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001809 u32 cookieMask; /* Bitmask of schema verified databases */
1810 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
drhc797d4d2007-05-08 01:08:49 +00001811 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001812#ifndef SQLITE_OMIT_SHARED_CACHE
1813 int nTableLock; /* Number of locks in aTableLock */
1814 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1815#endif
danielk1977cac336a2008-03-08 06:16:29 +00001816 int regRowid; /* Register holding rowid of CREATE TABLE entry */
1817 int regRoot; /* Register holding root page number for new objects */
drhf1974842004-11-05 03:56:00 +00001818
1819 /* Above is constant between recursions. Below is reset before and after
1820 ** each recursion */
1821
1822 int nVar; /* Number of '?' variables seen in the SQL so far */
1823 int nVarExpr; /* Number of used slots in apVarExpr[] */
1824 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1825 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
drh8b213892008-08-29 02:14:02 +00001826 int nAlias; /* Number of aliased result set columns */
drh555f8de2008-12-08 13:42:36 +00001827 int nAliasAlloc; /* Number of allocated slots for aAlias[] */
drh8b213892008-08-29 02:14:02 +00001828 int *aAlias; /* Register used to hold aliased result */
drhf1974842004-11-05 03:56:00 +00001829 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001830 Token sErrToken; /* The token at which the error occurred */
1831 Token sNameToken; /* Token with unqualified schema object name */
1832 Token sLastToken; /* The last token parsed */
1833 const char *zSql; /* All SQL text */
1834 const char *zTail; /* All SQL text past the last semicolon parsed */
1835 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1836 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1837 TriggerStack *trigStack; /* Trigger actions being coded */
1838 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drhb9bb7c12006-06-11 23:41:55 +00001839#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk197733b39332006-06-24 08:51:05 +00001840 Token sArg; /* Complete text of a module argument */
danielk1977f9e7dda2006-06-16 16:08:53 +00001841 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
drh4f3dd152008-04-28 18:46:43 +00001842 int nVtabLock; /* Number of virtual tables to lock */
1843 Table **apVtabLock; /* Pointer to virtual tables needing locking */
drhb9bb7c12006-06-11 23:41:55 +00001844#endif
danielk1977fc976062007-05-10 10:46:56 +00001845 int nHeight; /* Expression tree height of current sub-select */
drh588a9a12008-09-01 15:52:10 +00001846 Table *pZombieTab; /* List of Table objects to delete after code gen */
drh75897232000-05-29 14:26:00 +00001847};
1848
danielk19777e6ebfb2006-06-12 11:24:37 +00001849#ifdef SQLITE_OMIT_VIRTUALTABLE
1850 #define IN_DECLARE_VTAB 0
1851#else
1852 #define IN_DECLARE_VTAB (pParse->declareVtab)
1853#endif
1854
danielk1977d99bc932002-05-16 00:13:12 +00001855/*
drh85e20962003-04-25 17:52:11 +00001856** An instance of the following structure can be declared on a stack and used
1857** to save the Parse.zAuthContext value so that it can be restored later.
1858*/
1859struct AuthContext {
1860 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1861 Parse *pParse; /* The Parse structure */
1862};
1863
1864/*
drhf0863fe2005-06-12 21:35:51 +00001865** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001866*/
1867#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1868#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001869#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
drhe4d90812007-03-29 05:51:49 +00001870#define OPFLAG_APPEND 8 /* This is likely to be an append */
rdcb0c374f2004-02-20 22:53:38 +00001871
1872/*
danielk1977d99bc932002-05-16 00:13:12 +00001873 * Each trigger present in the database schema is stored as an instance of
1874 * struct Trigger.
1875 *
1876 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001877 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001878 * database). This allows Trigger structures to be retrieved by name.
1879 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001880 * pNext member of struct Trigger. A pointer to the first element of the
1881 * linked list is stored as the "pTrigger" member of the associated
1882 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001883 *
drhad3cab52002-05-24 02:04:32 +00001884 * The "step_list" member points to the first element of a linked list
1885 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001886 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001887struct Trigger {
drhdc379452002-05-15 12:45:43 +00001888 char *name; /* The name of the trigger */
1889 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001890 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001891 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
shane467bcf32008-11-24 20:01:32 +00001892 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
drhdc379452002-05-15 12:45:43 +00001893 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001894 the <column-list> is stored here */
drh4312db52003-06-03 01:47:11 +00001895 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001896 Schema *pSchema; /* Schema containing the trigger */
1897 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001898 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001899 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001900};
1901
danielk1977d99bc932002-05-16 00:13:12 +00001902/*
drhdca76842004-12-07 14:06:13 +00001903** A trigger is either a BEFORE or an AFTER trigger. The following constants
1904** determine which.
1905**
1906** If there are multiple triggers, you might of some BEFORE and some AFTER.
1907** In that cases, the constants below can be ORed together.
1908*/
1909#define TRIGGER_BEFORE 1
1910#define TRIGGER_AFTER 2
1911
1912/*
danielk1977d99bc932002-05-16 00:13:12 +00001913 * An instance of struct TriggerStep is used to store a single SQL statement
1914 * that is a part of a trigger-program.
1915 *
1916 * Instances of struct TriggerStep are stored in a singly linked list (linked
1917 * using the "pNext" member) referenced by the "step_list" member of the
1918 * associated struct Trigger instance. The first element of the linked list is
1919 * the first step of the trigger-program.
1920 *
1921 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1922 * "SELECT" statement. The meanings of the other members is determined by the
1923 * value of "op" as follows:
1924 *
1925 * (op == TK_INSERT)
1926 * orconf -> stores the ON CONFLICT algorithm
1927 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1928 * this stores a pointer to the SELECT statement. Otherwise NULL.
1929 * target -> A token holding the name of the table to insert into.
1930 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1931 * this stores values to be inserted. Otherwise NULL.
1932 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001933 * statement, then this stores the column-names to be
1934 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001935 *
1936 * (op == TK_DELETE)
1937 * target -> A token holding the name of the table to delete from.
1938 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1939 * Otherwise NULL.
1940 *
1941 * (op == TK_UPDATE)
1942 * target -> A token holding the name of the table to update rows of.
1943 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1944 * Otherwise NULL.
1945 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001946 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001947 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001948 *
1949 */
1950struct TriggerStep {
1951 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1952 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001953 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001954
danielk1977d99bc932002-05-16 00:13:12 +00001955 Select *pSelect; /* Valid for SELECT and sometimes
drhfd131da2007-08-07 17:13:03 +00001956 INSERT steps (when pExprList == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001957 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1958 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1959 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
drhfd131da2007-08-07 17:13:03 +00001960 INSERT steps (when pSelect == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001961 IdList *pIdList; /* Valid for INSERT statements only */
drh187e4c62006-02-27 22:22:27 +00001962 TriggerStep *pNext; /* Next in the link-list */
1963 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00001964};
1965
1966/*
1967 * An instance of struct TriggerStack stores information required during code
1968 * generation of a single trigger program. While the trigger program is being
1969 * coded, its associated TriggerStack instance is pointed to by the
1970 * "pTriggerStack" member of the Parse structure.
1971 *
1972 * The pTab member points to the table that triggers are being coded on. The
1973 * newIdx member contains the index of the vdbe cursor that points at the temp
1974 * table that stores the new.* references. If new.* references are not valid
1975 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1976 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1977 *
1978 * The ON CONFLICT policy to be used for the trigger program steps is stored
1979 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1980 * specified for individual triggers steps is used.
1981 *
1982 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1983 * constructed. When coding nested triggers (triggers fired by other triggers)
1984 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1985 * pointer. Once the nested trigger has been coded, the pNext value is restored
1986 * to the pTriggerStack member of the Parse stucture and coding of the parent
1987 * trigger continues.
1988 *
1989 * Before a nested trigger is coded, the linked list pointed to by the
1990 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1991 * recursively. If this condition is detected, the nested trigger is not coded.
1992 */
1993struct TriggerStack {
1994 Table *pTab; /* Table that triggers are currently being coded on */
1995 int newIdx; /* Index of vdbe cursor to "new" temp table */
1996 int oldIdx; /* Index of vdbe cursor to "old" temp table */
danielk19778f2c54e2008-01-01 19:02:09 +00001997 u32 newColMask;
1998 u32 oldColMask;
danielk1977d99bc932002-05-16 00:13:12 +00001999 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00002000 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00002001 Trigger *pTrigger; /* The trigger currently being coded */
2002 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00002003};
2004
2005/*
drhf26e09c2003-05-31 16:21:12 +00002006** The following structure contains information used by the sqliteFix...
2007** routines as they walk the parse tree to make database references
2008** explicit.
2009*/
2010typedef struct DbFixer DbFixer;
2011struct DbFixer {
2012 Parse *pParse; /* The parsing context. Error messages written here */
2013 const char *zDb; /* Make sure all objects are contained in this database */
2014 const char *zType; /* Type of the container - used for error messages */
2015 const Token *pName; /* Name of the container - used for error messages */
2016};
2017
2018/*
drhade86482007-11-28 22:36:40 +00002019** An objected used to accumulate the text of a string where we
2020** do not necessarily know how big the string will be in the end.
2021*/
2022struct StrAccum {
drh633e6d52008-07-28 19:34:53 +00002023 sqlite3 *db; /* Optional database for lookaside. Can be NULL */
2024 char *zBase; /* A base allocation. Not from malloc. */
2025 char *zText; /* The string collected so far */
2026 int nChar; /* Length of the string so far */
2027 int nAlloc; /* Amount of space allocated in zText */
drhbb4957f2008-03-20 14:03:29 +00002028 int mxAlloc; /* Maximum allowed string length */
drhade86482007-11-28 22:36:40 +00002029 u8 mallocFailed; /* Becomes true if any memory allocation fails */
shane467bcf32008-11-24 20:01:32 +00002030 u8 useMalloc; /* True if zText is enlargeable using realloc */
drhade86482007-11-28 22:36:40 +00002031 u8 tooBig; /* Becomes true if string size exceeds limits */
2032};
2033
2034/*
drh234c39d2004-07-24 03:30:47 +00002035** A pointer to this structure is used to communicate information
2036** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
2037*/
2038typedef struct {
drh9bb575f2004-09-06 17:24:11 +00002039 sqlite3 *db; /* The database being initialized */
drhece3c722006-09-23 20:36:01 +00002040 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh234c39d2004-07-24 03:30:47 +00002041 char **pzErrMsg; /* Error message stored here */
drh15ca1df2006-07-26 13:43:30 +00002042 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00002043} InitData;
2044
drhb6c29892004-11-22 19:12:19 +00002045/*
drh40257ff2008-06-13 18:24:27 +00002046** Structure containing global configuration data for the SQLite library.
drh33589792008-06-18 13:27:46 +00002047**
2048** This structure also contains some state information.
drh40257ff2008-06-13 18:24:27 +00002049*/
2050struct Sqlite3Config {
drhfec00ea2008-06-14 16:56:21 +00002051 int bMemstat; /* True to enable memory status */
2052 int bCoreMutex; /* True to enable core mutexing */
2053 int bFullMutex; /* True to enable full mutexing */
drh0a687d12008-07-08 14:52:07 +00002054 int mxStrlen; /* Maximum string length */
drh633e6d52008-07-28 19:34:53 +00002055 int szLookaside; /* Default lookaside buffer size */
2056 int nLookaside; /* Default lookaside buffer count */
drhfec00ea2008-06-14 16:56:21 +00002057 sqlite3_mem_methods m; /* Low-level memory allocation interface */
danielk19776d2ab0e2008-06-17 17:21:18 +00002058 sqlite3_mutex_methods mutex; /* Low-level mutex interface */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002059 sqlite3_pcache_methods pcache; /* Low-level page-cache interface */
drh40257ff2008-06-13 18:24:27 +00002060 void *pHeap; /* Heap storage space */
drh33589792008-06-18 13:27:46 +00002061 int nHeap; /* Size of pHeap[] */
2062 int mnReq, mxReq; /* Min and max heap requests sizes */
2063 void *pScratch; /* Scratch memory */
2064 int szScratch; /* Size of each scratch buffer */
2065 int nScratch; /* Number of scratch buffers */
2066 void *pPage; /* Page cache memory */
2067 int szPage; /* Size of each page in pPage[] */
2068 int nPage; /* Number of pages in pPage[] */
drh1875f7a2008-12-08 18:19:17 +00002069 int mxParserStack; /* maximum depth of the parser stack */
2070 int sharedCacheEnabled; /* true if shared-cache mode enabled */
2071 /* The above might be initialized to non-zero. The following need to always
2072 ** initially be zero, however. */
danielk197771bc31c2008-06-26 08:29:34 +00002073 int isInit; /* True after initialization has finished */
danielk1977502b4e02008-09-02 14:07:24 +00002074 int inProgress; /* True while initialization in progress */
danielk197771bc31c2008-06-26 08:29:34 +00002075 int isMallocInit; /* True after malloc is initialized */
2076 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
drh93ed56d2008-08-12 15:21:11 +00002077 int nRefInitMutex; /* Number of users of pInitMutex */
drh40257ff2008-06-13 18:24:27 +00002078};
2079
2080/*
drh7d10d5a2008-08-20 16:35:10 +00002081** Context pointer passed down through the tree-walk.
2082*/
2083struct Walker {
2084 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
2085 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
2086 Parse *pParse; /* Parser context. */
2087 union { /* Extra data for callback */
2088 NameContext *pNC; /* Naming context */
2089 int i; /* Integer value */
2090 } u;
2091};
2092
2093/* Forward declarations */
2094int sqlite3WalkExpr(Walker*, Expr*);
2095int sqlite3WalkExprList(Walker*, ExprList*);
2096int sqlite3WalkSelect(Walker*, Select*);
2097int sqlite3WalkSelectExpr(Walker*, Select*);
2098int sqlite3WalkSelectFrom(Walker*, Select*);
2099
2100/*
2101** Return code from the parse-tree walking primitives and their
2102** callbacks.
2103*/
drh2bf90f12008-12-09 13:04:29 +00002104#define WRC_Continue 0 /* Continue down into children */
2105#define WRC_Prune 1 /* Omit children but continue walking siblings */
2106#define WRC_Abort 2 /* Abandon the tree walk */
drh7d10d5a2008-08-20 16:35:10 +00002107
2108/*
drh66150952007-07-23 19:12:41 +00002109** Assuming zIn points to the first byte of a UTF-8 character,
2110** advance zIn to point to the first byte of the next UTF-8 character.
drh4a919112007-05-15 11:55:09 +00002111*/
drh4a919112007-05-15 11:55:09 +00002112#define SQLITE_SKIP_UTF8(zIn) { \
2113 if( (*(zIn++))>=0xc0 ){ \
2114 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
2115 } \
2116}
2117
drh4a919112007-05-15 11:55:09 +00002118/*
drh49285702005-09-17 15:20:26 +00002119** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
2120** builds) or a function call (for debugging). If it is a function call,
2121** it allows the operator to set a breakpoint at the spot where database
2122** corruption is first detected.
2123*/
2124#ifdef SQLITE_DEBUG
drh6e736832007-05-11 12:30:03 +00002125 int sqlite3Corrupt(void);
drh49285702005-09-17 15:20:26 +00002126# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
2127#else
2128# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
2129#endif
2130
2131/*
drh75897232000-05-29 14:26:00 +00002132** Internal function prototypes
2133*/
danielk19774adee202004-05-08 08:23:19 +00002134int sqlite3StrICmp(const char *, const char *);
2135int sqlite3StrNICmp(const char *, const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00002136int sqlite3IsNumber(const char*, int*, u8);
drh0a687d12008-07-08 14:52:07 +00002137int sqlite3Strlen(sqlite3*, const char*);
drhea678832008-12-10 19:26:22 +00002138int sqlite3Strlen30(const char*);
danielk19772e588c72005-12-09 14:25:08 +00002139
drh40257ff2008-06-13 18:24:27 +00002140int sqlite3MallocInit(void);
drhfec00ea2008-06-14 16:56:21 +00002141void sqlite3MallocEnd(void);
2142void *sqlite3Malloc(int);
2143void *sqlite3MallocZero(int);
2144void *sqlite3DbMallocZero(sqlite3*, int);
2145void *sqlite3DbMallocRaw(sqlite3*, int);
drh17435752007-08-16 04:30:38 +00002146char *sqlite3DbStrDup(sqlite3*,const char*);
2147char *sqlite3DbStrNDup(sqlite3*,const char*, int);
drhfec00ea2008-06-14 16:56:21 +00002148void *sqlite3Realloc(void*, int);
drh97c8ec32007-08-27 21:49:34 +00002149void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
danielk1977a1644fd2007-08-29 12:31:25 +00002150void *sqlite3DbRealloc(sqlite3 *, void *, int);
drh633e6d52008-07-28 19:34:53 +00002151void sqlite3DbFree(sqlite3*, void*);
2152int sqlite3MallocSize(void*);
2153int sqlite3DbMallocSize(sqlite3*, void*);
drhfacf0302008-06-17 15:12:00 +00002154void *sqlite3ScratchMalloc(int);
2155void sqlite3ScratchFree(void*);
2156void *sqlite3PageMalloc(int);
2157void sqlite3PageFree(void*);
drhfec00ea2008-06-14 16:56:21 +00002158void sqlite3MemSetDefault(void);
danielk1977171bfed2008-06-23 09:50:50 +00002159void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
shane4a27a282008-09-04 04:32:49 +00002160int sqlite3MemoryAlarm(void (*)(void*, sqlite3_int64, int), void*, sqlite3_int64);
danielk19772e588c72005-12-09 14:25:08 +00002161
danielk1977f3d3c272008-11-19 16:52:44 +00002162#ifdef SQLITE_ENABLE_MEMSYS3
2163const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
2164#endif
2165#ifdef SQLITE_ENABLE_MEMSYS5
2166const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
2167#endif
2168
2169
drh18472fa2008-10-07 15:25:48 +00002170#ifndef SQLITE_MUTEX_OMIT
drh65bbf292008-06-19 01:03:17 +00002171 sqlite3_mutex_methods *sqlite3DefaultMutex(void);
2172 sqlite3_mutex *sqlite3MutexAlloc(int);
2173 int sqlite3MutexInit(void);
2174 int sqlite3MutexEnd(void);
2175#endif
danielk19776d2ab0e2008-06-17 17:21:18 +00002176
drhf7141992008-06-19 00:16:08 +00002177int sqlite3StatusValue(int);
2178void sqlite3StatusAdd(int, int);
2179void sqlite3StatusSet(int, int);
2180
drh0de3ae92008-04-28 16:55:26 +00002181int sqlite3IsNaN(double);
2182
drhf089aa42008-07-08 19:34:06 +00002183void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
drh17435752007-08-16 04:30:38 +00002184char *sqlite3MPrintf(sqlite3*,const char*, ...);
2185char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
drh633e6d52008-07-28 19:34:53 +00002186char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
drh87cc3b32007-05-08 21:45:27 +00002187#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
2188 void sqlite3DebugPrintf(const char*, ...);
drhd919fe12007-12-11 19:34:44 +00002189#endif
2190#if defined(SQLITE_TEST)
drhe8f52c52008-07-12 14:52:20 +00002191 void *sqlite3TestTextToPtr(const char*);
drh87cc3b32007-05-08 21:45:27 +00002192#endif
drhf089aa42008-07-08 19:34:06 +00002193void sqlite3SetString(char **, sqlite3*, const char*, ...);
danielk19774adee202004-05-08 08:23:19 +00002194void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00002195void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00002196void sqlite3Dequote(char*);
drh17435752007-08-16 04:30:38 +00002197void sqlite3DequoteExpr(sqlite3*, Expr*);
drh2646da72005-12-09 20:02:05 +00002198int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00002199int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00002200void sqlite3FinishCoding(Parse*);
drh892d3172008-01-10 03:46:36 +00002201int sqlite3GetTempReg(Parse*);
2202void sqlite3ReleaseTempReg(Parse*,int);
2203int sqlite3GetTempRange(Parse*,int);
2204void sqlite3ReleaseTempRange(Parse*,int,int);
danielk1977a1644fd2007-08-29 12:31:25 +00002205Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
drh17435752007-08-16 04:30:38 +00002206Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00002207Expr *sqlite3RegisterExpr(Parse*,Token*);
danielk19771e536952007-08-16 10:09:01 +00002208Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00002209void sqlite3ExprSpan(Expr*,Token*,Token*);
drh17435752007-08-16 04:30:38 +00002210Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00002211void sqlite3ExprAssignVarNumber(Parse*, Expr*);
drh10fe8402008-10-11 16:47:35 +00002212void sqlite3ExprClear(sqlite3*, Expr*);
drh633e6d52008-07-28 19:34:53 +00002213void sqlite3ExprDelete(sqlite3*, Expr*);
drh17435752007-08-16 04:30:38 +00002214ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
drh633e6d52008-07-28 19:34:53 +00002215void sqlite3ExprListDelete(sqlite3*, ExprList*);
drh9bb575f2004-09-06 17:24:11 +00002216int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00002217int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00002218void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00002219void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00002220void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00002221void sqlite3CommitInternalChanges(sqlite3*);
drh7d10d5a2008-08-20 16:35:10 +00002222Table *sqlite3ResultSetOfSelect(Parse*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00002223void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00002224void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00002225void sqlite3AddColumn(Parse*,Token*);
2226void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00002227void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00002228void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00002229void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00002230void sqlite3AddDefaultValue(Parse*,Expr*);
danielk197739002502007-11-12 09:50:26 +00002231void sqlite3AddCollateType(Parse*, Token*);
danielk197719a8e7e2005-03-17 05:03:38 +00002232void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00002233
drhf5e7bb52008-02-18 14:47:33 +00002234Bitvec *sqlite3BitvecCreate(u32);
2235int sqlite3BitvecTest(Bitvec*, u32);
2236int sqlite3BitvecSet(Bitvec*, u32);
2237void sqlite3BitvecClear(Bitvec*, u32);
2238void sqlite3BitvecDestroy(Bitvec*);
drh3088d592008-03-21 16:45:47 +00002239int sqlite3BitvecBuiltinTest(int,int*);
drhf5e7bb52008-02-18 14:47:33 +00002240
drh3d4501e2008-12-04 20:40:10 +00002241RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
2242void sqlite3RowSetClear(RowSet*);
2243void sqlite3RowSetInsert(RowSet*, i64);
2244int sqlite3RowSetNext(RowSet*, i64*);
2245
drhfdd48a72006-09-11 23:45:48 +00002246void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00002247
2248#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00002249 int sqlite3ViewGetColumnNames(Parse*,Table*);
2250#else
2251# define sqlite3ViewGetColumnNames(A,B) 0
2252#endif
2253
drha0733842005-12-29 01:11:36 +00002254void sqlite3DropTable(Parse*, SrcList*, int, int);
danielk1977a04a34f2007-04-16 15:06:25 +00002255void sqlite3DeleteTable(Table*);
danielk19774adee202004-05-08 08:23:19 +00002256void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh17435752007-08-16 04:30:38 +00002257void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
2258IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
danielk19774adee202004-05-08 08:23:19 +00002259int sqlite3IdListIndex(IdList*,const char*);
drha78c22c2008-11-11 18:28:58 +00002260SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
drh17435752007-08-16 04:30:38 +00002261SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
danielk1977b1c685b2008-10-06 16:18:39 +00002262SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
danielk197785574e32008-10-06 05:32:18 +00002263 Token*, Select*, Expr*, IdList*);
danielk1977b1c685b2008-10-06 16:18:39 +00002264void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
2265int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
drh61dfc312006-12-16 16:25:15 +00002266void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002267void sqlite3SrcListAssignCursors(Parse*, SrcList*);
drh633e6d52008-07-28 19:34:53 +00002268void sqlite3IdListDelete(sqlite3*, IdList*);
2269void sqlite3SrcListDelete(sqlite3*, SrcList*);
danielk19770202b292004-06-09 09:55:16 +00002270void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00002271 Token*, int, int);
2272void sqlite3DropIndex(Parse*, SrcList*, int);
drh7d10d5a2008-08-20 16:35:10 +00002273int sqlite3Select(Parse*, Select*, SelectDest*);
drh17435752007-08-16 04:30:38 +00002274Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
2275 Expr*,ExprList*,int,Expr*,Expr*);
drh633e6d52008-07-28 19:34:53 +00002276void sqlite3SelectDelete(sqlite3*, Select*);
danielk19774adee202004-05-08 08:23:19 +00002277Table *sqlite3SrcListLookup(Parse*, SrcList*);
2278int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00002279void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
shane273f6192008-10-10 04:34:16 +00002280#if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
shane49ffdbf2008-10-10 18:25:45 +00002281Expr *sqlite3LimitWhere(Parse *, SrcList *, Expr *, ExprList *, Expr *, Expr *, char *);
shane4281bd42008-10-07 05:27:11 +00002282#endif
danielk19774adee202004-05-08 08:23:19 +00002283void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
2284void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drh23d04d52008-12-23 23:56:22 +00002285WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8, int);
danielk19774adee202004-05-08 08:23:19 +00002286void sqlite3WhereEnd(WhereInfo*);
drhda250ea2008-04-01 05:07:14 +00002287int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
drhb21e7c72008-06-22 12:37:57 +00002288void sqlite3ExprCodeMove(Parse*, int, int, int);
drh92b01d52008-06-24 00:32:35 +00002289void sqlite3ExprCodeCopy(Parse*, int, int, int);
drhe55cbd72008-03-31 23:48:03 +00002290void sqlite3ExprClearColumnCache(Parse*, int);
drhda250ea2008-04-01 05:07:14 +00002291void sqlite3ExprCacheAffinityChange(Parse*, int, int);
drhd1fa7bc2009-01-10 13:24:50 +00002292void sqlite3ExprWritableRegister(Parse*,int);
drh191b54c2008-04-15 12:14:21 +00002293void sqlite3ExprHardCopy(Parse*,int,int);
drh389a1ad2008-01-03 23:44:53 +00002294int sqlite3ExprCode(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00002295int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
drh678ccce2008-03-31 18:19:54 +00002296int sqlite3ExprCodeTarget(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00002297int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
drh678ccce2008-03-31 18:19:54 +00002298void sqlite3ExprCodeConstants(Parse*, Expr*);
drh191b54c2008-04-15 12:14:21 +00002299int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
danielk19774adee202004-05-08 08:23:19 +00002300void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
2301void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh9bb575f2004-09-06 17:24:11 +00002302Table *sqlite3FindTable(sqlite3*,const char*, const char*);
drhca424112008-01-25 15:04:48 +00002303Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00002304Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
2305void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
2306void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00002307void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00002308int sqlite3RunVacuum(char**, sqlite3*);
drh17435752007-08-16 04:30:38 +00002309char *sqlite3NameFromToken(sqlite3*, Token*);
danielk19774adee202004-05-08 08:23:19 +00002310int sqlite3ExprCompare(Expr*, Expr*);
drhd2b3e232008-01-23 14:51:49 +00002311void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2312void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00002313Vdbe *sqlite3GetVdbe(Parse*);
danielk19771e536952007-08-16 10:09:01 +00002314Expr *sqlite3CreateIdExpr(Parse *, const char*);
drh2fa18682008-03-19 14:15:34 +00002315void sqlite3PrngSaveState(void);
2316void sqlite3PrngRestoreState(void);
2317void sqlite3PrngResetState(void);
drh9bb575f2004-09-06 17:24:11 +00002318void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00002319void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00002320void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00002321void sqlite3CommitTransaction(Parse*);
2322void sqlite3RollbackTransaction(Parse*);
danielk1977fd7f0452008-12-17 17:30:26 +00002323void sqlite3Savepoint(Parse*, int, Token*);
2324void sqlite3CloseSavepoints(sqlite3 *);
danielk19774adee202004-05-08 08:23:19 +00002325int sqlite3ExprIsConstant(Expr*);
drh0a168372007-06-08 00:20:47 +00002326int sqlite3ExprIsConstantNotJoin(Expr*);
drheb55bd22005-06-30 17:04:21 +00002327int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00002328int sqlite3ExprIsInteger(Expr*, int*);
2329int sqlite3IsRowid(const char*);
drh2d401ab2008-01-10 23:50:11 +00002330void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
2331void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
drhe14006d2008-03-25 17:23:32 +00002332int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
drh04adf412008-01-08 18:57:50 +00002333void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
2334 int*,int,int,int,int);
danielk197762c14b32008-11-19 09:05:26 +00002335void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*, int, int, int);
drhaa9b8962008-01-08 02:57:55 +00002336int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00002337void sqlite3BeginWriteOperation(Parse*, int, int);
drh17435752007-08-16 04:30:38 +00002338Expr *sqlite3ExprDup(sqlite3*,Expr*);
2339void sqlite3TokenCopy(sqlite3*,Token*, Token*);
2340ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
2341SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
2342IdList *sqlite3IdListDup(sqlite3*,IdList*);
2343Select *sqlite3SelectDup(sqlite3*,Select*);
drh70a8ca32008-08-21 18:49:27 +00002344void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
drh9bb575f2004-09-06 17:24:11 +00002345FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
2346void sqlite3RegisterBuiltinFunctions(sqlite3*);
drh777c5382008-08-21 20:21:34 +00002347void sqlite3RegisterDateTimeFunctions(void);
drh70a8ca32008-08-21 18:49:27 +00002348void sqlite3RegisterGlobalFunctions(void);
drh7e8b8482008-01-23 03:03:05 +00002349#ifdef SQLITE_DEBUG
2350 int sqlite3SafetyOn(sqlite3*);
2351 int sqlite3SafetyOff(sqlite3*);
2352#else
2353# define sqlite3SafetyOn(A) 0
2354# define sqlite3SafetyOff(A) 0
2355#endif
2356int sqlite3SafetyCheckOk(sqlite3*);
2357int sqlite3SafetyCheckSickOrOk(sqlite3*);
drh9cbf3422008-01-17 16:22:13 +00002358void sqlite3ChangeCookie(Parse*, int);
shanefa4e62f2008-09-01 21:59:42 +00002359
2360#if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
drh2a5d8252008-08-22 12:30:52 +00002361void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
shanefa4e62f2008-09-01 21:59:42 +00002362#endif
drhb7f91642004-10-31 02:22:47 +00002363
2364#ifndef SQLITE_OMIT_TRIGGER
2365 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00002366 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00002367 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00002368 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00002369 void sqlite3DropTriggerPtr(Parse*, Trigger*);
danielk197762c14b32008-11-19 09:05:26 +00002370 int sqlite3TriggersExist(Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00002371 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
danielk19778f2c54e2008-01-01 19:02:09 +00002372 int, int, u32*, u32*);
drhb7f91642004-10-31 02:22:47 +00002373 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
drh633e6d52008-07-28 19:34:53 +00002374 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
drh17435752007-08-16 04:30:38 +00002375 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
2376 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
2377 ExprList*,Select*,int);
2378 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
2379 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
drh633e6d52008-07-28 19:34:53 +00002380 void sqlite3DeleteTrigger(sqlite3*, Trigger*);
drhb7f91642004-10-31 02:22:47 +00002381 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
2382#else
danielk197762c14b32008-11-19 09:05:26 +00002383# define sqlite3TriggersExist(B,C,D,E,F) 0
drh633e6d52008-07-28 19:34:53 +00002384# define sqlite3DeleteTrigger(A,B)
drhcdd536f2006-03-17 00:04:03 +00002385# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00002386# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
danielk19778f2c54e2008-01-01 19:02:09 +00002387# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
drhb7f91642004-10-31 02:22:47 +00002388#endif
2389
danielk19774adee202004-05-08 08:23:19 +00002390int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00002391void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00002392void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00002393#ifndef SQLITE_OMIT_AUTHORIZATION
drh728b5772007-09-18 15:55:07 +00002394 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
danielk19774adee202004-05-08 08:23:19 +00002395 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
2396 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
2397 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00002398#else
danielk1977b5258c32007-10-04 18:11:15 +00002399# define sqlite3AuthRead(a,b,c,d)
danielk19774adee202004-05-08 08:23:19 +00002400# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
2401# define sqlite3AuthContextPush(a,b,c)
2402# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00002403#endif
danielk1977f744bb52005-12-06 17:19:11 +00002404void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2405void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00002406int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh33f4e022007-09-03 15:19:34 +00002407 int omitJournal, int nCache, int flags, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00002408int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
2409int sqlite3FixSrcList(DbFixer*, SrcList*);
2410int sqlite3FixSelect(DbFixer*, Select*);
2411int sqlite3FixExpr(DbFixer*, Expr*);
2412int sqlite3FixExprList(DbFixer*, ExprList*);
2413int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00002414int sqlite3AtoF(const char *z, double*);
drhfec19aa2004-05-19 20:41:03 +00002415int sqlite3GetInt32(const char *, int*);
drh598f1342007-10-23 15:39:45 +00002416int sqlite3FitsIn64Bits(const char *, int);
drhee858132007-05-08 20:37:38 +00002417int sqlite3Utf16ByteLen(const void *pData, int nChar);
2418int sqlite3Utf8CharLen(const char *pData, int nByte);
drh66150952007-07-23 19:12:41 +00002419int sqlite3Utf8Read(const u8*, const u8*, const u8**);
shane3f8d5cf2008-04-24 19:15:09 +00002420
2421/*
2422** Routines to read and write variable-length integers. These used to
2423** be defined locally, but now we use the varint routines in the util.c
shane952856a2008-04-28 17:41:30 +00002424** file. Code should use the MACRO forms below, as the Varint32 versions
2425** are coded to assume the single byte case is already handled (which
2426** the MACRO form does).
shane3f8d5cf2008-04-24 19:15:09 +00002427*/
drh35b5a332008-04-05 18:41:42 +00002428int sqlite3PutVarint(unsigned char*, u64);
2429int sqlite3PutVarint32(unsigned char*, u32);
drh1bd10f82008-12-10 21:19:56 +00002430u8 sqlite3GetVarint(const unsigned char *, u64 *);
2431u8 sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00002432int sqlite3VarintLen(u64 v);
shane3f8d5cf2008-04-24 19:15:09 +00002433
2434/*
2435** The header of a record consists of a sequence variable-length integers.
2436** These integers are almost always small and are encoded as a single byte.
2437** The following macros take advantage this fact to provide a fast encode
2438** and decode of the integers in a record header. It is faster for the common
2439** case where the integer is a single byte. It is a little slower when the
2440** integer is two or more bytes. But overall it is faster.
2441**
2442** The following expressions are equivalent:
2443**
2444** x = sqlite3GetVarint32( A, &B );
2445** x = sqlite3PutVarint32( A, B );
2446**
2447** x = getVarint32( A, B );
2448** x = putVarint32( A, B );
2449**
2450*/
drh1bd10f82008-12-10 21:19:56 +00002451#define getVarint32(A,B) (u8)((*(A)<(u8)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), (u32 *)&(B)))
2452#define putVarint32(A,B) (u8)(((u32)(B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
shane3f8d5cf2008-04-24 19:15:09 +00002453#define getVarint sqlite3GetVarint
2454#define putVarint sqlite3PutVarint
2455
2456
danielk1977a37cdde2004-05-16 11:15:36 +00002457void sqlite3IndexAffinityStr(Vdbe *, Index *);
2458void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00002459char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00002460int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00002461char sqlite3ExprAffinity(Expr *pExpr);
drhb6a9ece2007-06-26 00:37:27 +00002462int sqlite3Atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00002463void sqlite3Error(sqlite3*, int, const char*,...);
drhca48c902008-01-18 14:08:24 +00002464void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
danielk1977ef2cb632004-05-29 02:37:19 +00002465int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00002466const char *sqlite3ErrStr(int);
danielk19778a414492004-06-29 08:59:35 +00002467int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00002468CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00002469CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00002470CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh8b4c40d2007-02-01 23:02:45 +00002471Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
danielk19777cedc8d2004-06-10 10:50:08 +00002472int sqlite3CheckCollSeq(Parse *, CollSeq *);
danielk1977d8123362004-06-12 09:25:12 +00002473int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00002474void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk19774e6af132004-06-10 14:01:08 +00002475
drhb21c8cd2007-08-21 19:33:56 +00002476const void *sqlite3ValueText(sqlite3_value*, u8);
2477int sqlite3ValueBytes(sqlite3_value*, u8);
2478void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
danielk19771e536952007-08-16 10:09:01 +00002479 void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00002480void sqlite3ValueFree(sqlite3_value*);
danielk19771e536952007-08-16 10:09:01 +00002481sqlite3_value *sqlite3ValueNew(sqlite3 *);
2482char *sqlite3Utf16to8(sqlite3 *, const void*, int);
2483int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
drhb21c8cd2007-08-21 19:33:56 +00002484void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh46c99e02007-08-27 23:26:59 +00002485#ifndef SQLITE_AMALGAMATION
drh4e5ffc52004-08-31 00:52:37 +00002486extern const unsigned char sqlite3UpperToLower[];
danielk1977075c23a2008-09-01 18:34:20 +00002487extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
2488extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions;
drh46c99e02007-08-27 23:26:59 +00002489#endif
danielk1977a0bf2652004-11-04 14:30:04 +00002490void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00002491void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00002492void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00002493void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
2494int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00002495void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00002496void sqlite3ExpirePreparedStatements(sqlite3*);
danielk197741a05b72008-10-02 13:50:55 +00002497void sqlite3CodeSubselect(Parse *, Expr *, int, int);
drh7d10d5a2008-08-20 16:35:10 +00002498void sqlite3SelectPrep(Parse*, Select*, NameContext*);
2499int sqlite3ResolveExprNames(NameContext*, Expr*);
drh7d10d5a2008-08-20 16:35:10 +00002500void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
2501int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
danielk1977aee18ef2005-03-09 12:26:50 +00002502void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00002503void sqlite3AlterFinishAddColumn(Parse *, Token *);
2504void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
danielk19774dade032005-05-25 10:45:10 +00002505CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00002506char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00002507void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00002508int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00002509int sqlite3FindDb(sqlite3*, Token*);
drhcf1be452007-05-12 12:08:51 +00002510int sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00002511void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00002512void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00002513int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
drhfdd6e852005-12-16 01:06:16 +00002514void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00002515void sqlite3SchemaFree(void *);
danielk19771e536952007-08-16 10:09:01 +00002516Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
danielk1977e501b892006-01-09 06:29:47 +00002517int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00002518KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00002519int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2520 void (*)(sqlite3_context*,int,sqlite3_value **),
2521 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
danielk197754f01982006-01-18 15:25:17 +00002522int sqlite3ApiExit(sqlite3 *db, int);
danielk1977ddfb2f02006-02-17 12:25:14 +00002523int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00002524
drhf089aa42008-07-08 19:34:06 +00002525void sqlite3StrAccumInit(StrAccum*, char*, int, int);
drhade86482007-11-28 22:36:40 +00002526void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2527char *sqlite3StrAccumFinish(StrAccum*);
2528void sqlite3StrAccumReset(StrAccum*);
drh1013c932008-01-06 00:25:21 +00002529void sqlite3SelectDestInit(SelectDest*,int,int);
danielk19771e536952007-08-16 10:09:01 +00002530
drh95bdbbb2007-07-23 19:31:16 +00002531/*
2532** The interface to the LEMON-generated parser
2533*/
2534void *sqlite3ParserAlloc(void*(*)(size_t));
2535void sqlite3ParserFree(void*, void(*)(void*));
2536void sqlite3Parser(void*, int, Token, Parse*);
drhec424a52008-07-25 15:39:03 +00002537#ifdef YYTRACKMAXSTACKDEPTH
2538 int sqlite3ParserStackPeak(void*);
2539#endif
drh95bdbbb2007-07-23 19:31:16 +00002540
drhcaa639f2008-03-20 00:32:20 +00002541int sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00002542#ifndef SQLITE_OMIT_LOAD_EXTENSION
2543 void sqlite3CloseExtensions(sqlite3*);
2544#else
2545# define sqlite3CloseExtensions(X)
2546#endif
danielk1977e3026632004-06-22 11:29:02 +00002547
danielk1977c00da102006-01-07 13:21:04 +00002548#ifndef SQLITE_OMIT_SHARED_CACHE
2549 void sqlite3TableLock(Parse *, int, int, u8, const char *);
2550#else
2551 #define sqlite3TableLock(v,w,x,y,z)
2552#endif
2553
drh53c14022007-05-10 17:23:11 +00002554#ifdef SQLITE_TEST
2555 int sqlite3Utf8To8(unsigned char*);
2556#endif
2557
drhb9bb7c12006-06-11 23:41:55 +00002558#ifdef SQLITE_OMIT_VIRTUALTABLE
2559# define sqlite3VtabClear(X)
danielk19779dbee7d2008-08-02 15:32:39 +00002560# define sqlite3VtabSync(X,Y) SQLITE_OK
danielk1977f9e7dda2006-06-16 16:08:53 +00002561# define sqlite3VtabRollback(X)
2562# define sqlite3VtabCommit(X)
danielk1977093e0f62008-11-13 18:00:14 +00002563# define sqlite3VtabInSync(db) 0
drhb9bb7c12006-06-11 23:41:55 +00002564#else
drh707205d2006-06-17 10:44:42 +00002565 void sqlite3VtabClear(Table*);
danielk19773e3a84d2008-08-01 17:37:40 +00002566 int sqlite3VtabSync(sqlite3 *db, char **);
danielk1977f9e7dda2006-06-16 16:08:53 +00002567 int sqlite3VtabRollback(sqlite3 *db);
2568 int sqlite3VtabCommit(sqlite3 *db);
danielk1977093e0f62008-11-13 18:00:14 +00002569# define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
drhb9bb7c12006-06-11 23:41:55 +00002570#endif
drh4f3dd152008-04-28 18:46:43 +00002571void sqlite3VtabMakeWritable(Parse*,Table*);
drh189d4af2006-09-02 20:57:52 +00002572void sqlite3VtabLock(sqlite3_vtab*);
danielk1977a04a34f2007-04-16 15:06:25 +00002573void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
drhb9bb7c12006-06-11 23:41:55 +00002574void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2575void sqlite3VtabFinishParse(Parse*, Token*);
2576void sqlite3VtabArgInit(Parse*);
2577void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00002578int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00002579int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00002580int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977f9e7dda2006-06-16 16:08:53 +00002581int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
danielk19771e536952007-08-16 10:09:01 +00002582FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00002583void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
shane4a27a282008-09-04 04:32:49 +00002584int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
drhb900aaf2006-11-09 00:24:53 +00002585int sqlite3Reprepare(Vdbe*);
drhb1a6c3c2008-03-20 16:30:17 +00002586void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
drh0a0e1312007-08-07 17:04:59 +00002587CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
drhb9bb7c12006-06-11 23:41:55 +00002588
drh643167f2008-01-22 21:30:53 +00002589
2590/*
2591** Available fault injectors. Should be numbered beginning with 0.
2592*/
2593#define SQLITE_FAULTINJECTOR_MALLOC 0
drh7e8b8482008-01-23 03:03:05 +00002594#define SQLITE_FAULTINJECTOR_COUNT 1
drh643167f2008-01-22 21:30:53 +00002595
2596/*
danielk1977ef05f2d2008-06-20 11:05:37 +00002597** The interface to the code in fault.c used for identifying "benign"
2598** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
2599** is not defined.
drh643167f2008-01-22 21:30:53 +00002600*/
drh3088d592008-03-21 16:45:47 +00002601#ifndef SQLITE_OMIT_BUILTIN_TEST
danielk19772d1d86f2008-06-20 14:59:51 +00002602 void sqlite3BeginBenignMalloc(void);
2603 void sqlite3EndBenignMalloc(void);
drh643167f2008-01-22 21:30:53 +00002604#else
danielk19772d1d86f2008-06-20 14:59:51 +00002605 #define sqlite3BeginBenignMalloc()
danielk1977867d05a2008-06-23 14:03:45 +00002606 #define sqlite3EndBenignMalloc()
drh643167f2008-01-22 21:30:53 +00002607#endif
drh643167f2008-01-22 21:30:53 +00002608
danielk19779a96b662007-11-29 17:05:18 +00002609#define IN_INDEX_ROWID 1
2610#define IN_INDEX_EPH 2
2611#define IN_INDEX_INDEX 3
danielk19770cdc0222008-06-26 18:04:03 +00002612int sqlite3FindInIndex(Parse *, Expr *, int*);
danielk19779a96b662007-11-29 17:05:18 +00002613
danielk1977c7b60172007-08-22 11:22:03 +00002614#ifdef SQLITE_ENABLE_ATOMIC_WRITE
2615 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2616 int sqlite3JournalSize(sqlite3_vfs *);
danielk1977f55b8992007-08-24 08:15:53 +00002617 int sqlite3JournalCreate(sqlite3_file *);
danielk1977c7b60172007-08-22 11:22:03 +00002618#else
2619 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2620#endif
2621
danielk1977b3175382008-10-17 18:51:52 +00002622void sqlite3MemJournalOpen(sqlite3_file *);
drh3a5990a2008-12-20 02:14:39 +00002623int sqlite3MemJournalSize(void);
danielk1977b3175382008-10-17 18:51:52 +00002624int sqlite3IsMemJournal(sqlite3_file *);
2625
drh0224d262008-05-28 13:49:34 +00002626#if SQLITE_MAX_EXPR_DEPTH>0
danielk19774b5255a2008-06-05 16:47:39 +00002627 void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
danielk1977fc976062007-05-10 10:46:56 +00002628 int sqlite3SelectExprHeight(Select *);
drh7d10d5a2008-08-20 16:35:10 +00002629 int sqlite3ExprCheckHeight(Parse*, int);
danielk1977fc976062007-05-10 10:46:56 +00002630#else
danielk19774b5255a2008-06-05 16:47:39 +00002631 #define sqlite3ExprSetHeight(x,y)
drh0224d262008-05-28 13:49:34 +00002632 #define sqlite3SelectExprHeight(x) 0
drh7d10d5a2008-08-20 16:35:10 +00002633 #define sqlite3ExprCheckHeight(x,y)
danielk1977fc976062007-05-10 10:46:56 +00002634#endif
2635
drha3152892007-05-05 11:48:52 +00002636u32 sqlite3Get4byte(const u8*);
drha3152892007-05-05 11:48:52 +00002637void sqlite3Put4byte(u8*, u32);
2638
danielk1977fd9a0a42005-05-24 12:01:00 +00002639#ifdef SQLITE_SSE
2640#include "sseInt.h"
2641#endif
2642
drh6e736832007-05-11 12:30:03 +00002643#ifdef SQLITE_DEBUG
2644 void sqlite3ParserTrace(FILE*, char *);
2645#endif
2646
drhb0603412007-02-28 04:47:26 +00002647/*
2648** If the SQLITE_ENABLE IOTRACE exists then the global variable
mlcreech3a00f902008-03-04 17:45:01 +00002649** sqlite3IoTrace is a pointer to a printf-like routine used to
drhb0603412007-02-28 04:47:26 +00002650** print I/O tracing messages.
2651*/
2652#ifdef SQLITE_ENABLE_IOTRACE
mlcreech3a00f902008-03-04 17:45:01 +00002653# define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
danielk1977b4622b62007-03-02 06:24:19 +00002654 void sqlite3VdbeIOTraceSql(Vdbe*);
drhe265b082008-05-01 17:03:49 +00002655SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
drhb0603412007-02-28 04:47:26 +00002656#else
2657# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00002658# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00002659#endif
drhb0603412007-02-28 04:47:26 +00002660
danielk1977e3026632004-06-22 11:29:02 +00002661#endif