blob: d0aebd5eeec2acd8ba34fbf6311808aa063523c1 [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** Main file for the SQLite library. The routines in this file
13** implement the programmer interface to the library. Routines in
14** other files are for internal use by SQLite and should not be
15** accessed by users of the library.
drh75897232000-05-29 14:26:00 +000016*/
17#include "sqliteInt.h"
drh58f1c8b2008-05-26 20:19:25 +000018
drh820a9062008-01-31 13:35:48 +000019#ifdef SQLITE_ENABLE_FTS3
20# include "fts3.h"
21#endif
drh58f1c8b2008-05-26 20:19:25 +000022#ifdef SQLITE_ENABLE_RTREE
23# include "rtree.h"
24#endif
danielk19771c826652008-09-08 08:08:09 +000025#ifdef SQLITE_ENABLE_ICU
26# include "sqliteicu.h"
27#endif
drh75897232000-05-29 14:26:00 +000028
drhb3190c12008-12-08 21:37:14 +000029#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000030/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
31** contains the text of SQLITE_VERSION macro.
32*/
danielk197724b03fd2004-05-10 10:34:34 +000033const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000034#endif
drh9f129f42010-08-31 15:27:32 +000035
36/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
37** a pointer to the to the sqlite3_version[] string constant.
38*/
drh4aec8b62004-08-28 16:19:00 +000039const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000040
41/* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
42** pointer to a string constant whose value is the same as the
43** SQLITE_SOURCE_ID C preprocessor macro.
44*/
drh47baebc2009-08-14 16:01:24 +000045const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000046
47/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
48** returns an integer equal to SQLITE_VERSION_NUMBER.
49*/
danielk197799ba19e2005-02-05 07:33:34 +000050int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000051
drh5dc2bcd2012-01-02 15:45:12 +000052/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000053** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000054** the SQLITE_THREADSAFE compile-time option being set to 0.
55*/
drhb67e8bf2007-08-30 20:09:48 +000056int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000057
drhe265b082008-05-01 17:03:49 +000058#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000059/*
drhb0603412007-02-28 04:47:26 +000060** If the following function pointer is not NULL and if
61** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
62** I/O active are written using this function. These messages
63** are intended for debugging activity only.
64*/
mlcreech3a00f902008-03-04 17:45:01 +000065void (*sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000066#endif
drhb0603412007-02-28 04:47:26 +000067
68/*
drha16313e2007-03-30 11:29:32 +000069** If the following global variable points to a string which is the
70** name of a directory, then that directory will be used to store
71** temporary files.
72**
73** See also the "PRAGMA temp_store_directory" SQL command.
74*/
75char *sqlite3_temp_directory = 0;
76
drhc5499be2008-04-01 15:06:33 +000077/*
drh40257ff2008-06-13 18:24:27 +000078** Initialize SQLite.
79**
80** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +000081** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +000082** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
83** this routine will be called automatically by key routines such as
84** sqlite3_open().
85**
86** This routine is a no-op except on its very first call for the process,
87** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +000088**
89** The first thread to call this routine runs the initialization to
90** completion. If subsequent threads call this routine before the first
91** thread has finished the initialization process, then the subsequent
92** threads must block until the first thread finishes with the initialization.
93**
94** The first thread might call this routine recursively. Recursive
95** calls to this routine should not block, of course. Otherwise the
96** initialization process would never complete.
97**
98** Let X be the first thread to enter this routine. Let Y be some other
99** thread. Then while the initial invocation of this routine by X is
100** incomplete, it is required that:
101**
102** * Calls to this routine from Y must block until the outer-most
103** call by X completes.
104**
105** * Recursive calls to this routine from thread X return immediately
106** without blocking.
drh40257ff2008-06-13 18:24:27 +0000107*/
108int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000109 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000110 int rc; /* Result code */
111
112#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000113 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000114 if( rc!=SQLITE_OK ){
115 return rc;
116 }
117#endif
danielk197771bc31c2008-06-26 08:29:34 +0000118
drh93ed56d2008-08-12 15:21:11 +0000119 /* If SQLite is already completely initialized, then this call
120 ** to sqlite3_initialize() should be a no-op. But the initialization
121 ** must be complete. So isInit must not be set until the very end
122 ** of this routine.
123 */
danielk1977075c23a2008-09-01 18:34:20 +0000124 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000125
drh93ed56d2008-08-12 15:21:11 +0000126 /* Make sure the mutex subsystem is initialized. If unable to
127 ** initialize the mutex subsystem, return early with the error.
128 ** If the system is so sick that we are unable to allocate a mutex,
129 ** there is not much SQLite is going to be able to do.
130 **
131 ** The mutex subsystem must take care of serializing its own
132 ** initialization.
133 */
danielk1977d0251742008-06-18 18:57:42 +0000134 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000135 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000136
drh93ed56d2008-08-12 15:21:11 +0000137 /* Initialize the malloc() system and the recursive pInitMutex mutex.
138 ** This operation is protected by the STATIC_MASTER mutex. Note that
139 ** MutexAlloc() is called for a static mutex prior to initializing the
140 ** malloc subsystem - this implies that the allocation of a static
141 ** mutex must not require support from the malloc subsystem.
142 */
drh30ddce62011-10-15 00:16:30 +0000143 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000144 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000145 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000146 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000147 rc = sqlite3MallocInit();
148 }
drh40257ff2008-06-13 18:24:27 +0000149 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000150 sqlite3GlobalConfig.isMallocInit = 1;
151 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000152 sqlite3GlobalConfig.pInitMutex =
153 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000154 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000155 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000156 }
157 }
danielk197777eb5bb2008-09-22 17:22:19 +0000158 }
159 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000160 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000161 }
162 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000163
dane1ab2192009-08-17 15:16:19 +0000164 /* If rc is not SQLITE_OK at this point, then either the malloc
165 ** subsystem could not be initialized or the system failed to allocate
166 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000167 if( rc!=SQLITE_OK ){
168 return rc;
169 }
170
171 /* Do the rest of the initialization under the recursive mutex so
172 ** that we will be able to handle recursive calls into
173 ** sqlite3_initialize(). The recursive calls normally come through
174 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
175 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000176 **
177 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
178 ** to the xInit method, so the xInit method need not be threadsafe.
179 **
180 ** The following mutex is what serializes access to the appdef pcache xInit
181 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
182 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000183 */
danielk1977075c23a2008-09-01 18:34:20 +0000184 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000185 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000186 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000187 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000188 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000189 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000190 if( sqlite3GlobalConfig.isPCacheInit==0 ){
191 rc = sqlite3PcacheInitialize();
192 }
danielk19778c0a7912008-08-20 14:49:23 +0000193 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000194 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000195 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000196 }
197 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000198 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
199 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000200 sqlite3GlobalConfig.isInit = 1;
danielk19778c0a7912008-08-20 14:49:23 +0000201 }
danielk1977502b4e02008-09-02 14:07:24 +0000202 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000203 }
danielk1977075c23a2008-09-01 18:34:20 +0000204 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000205
drh93ed56d2008-08-12 15:21:11 +0000206 /* Go back under the static mutex and clean up the recursive
207 ** mutex to prevent a resource leak.
208 */
209 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000210 sqlite3GlobalConfig.nRefInitMutex--;
211 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
212 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
213 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
214 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000215 }
216 sqlite3_mutex_leave(pMaster);
217
218 /* The following is just a sanity check to make sure SQLite has
219 ** been compiled correctly. It is important to run this code, but
220 ** we don't want to run it too often and soak up CPU cycles for no
221 ** reason. So we run it once during initialization.
222 */
shanedfb7b372008-07-22 05:13:30 +0000223#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000224#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000225 /* This section of code's only "output" is via assert() statements. */
226 if ( rc==SQLITE_OK ){
227 u64 x = (((u64)1)<<63)-1;
228 double y;
229 assert(sizeof(x)==8);
230 assert(sizeof(x)==sizeof(y));
231 memcpy(&y, &x, 8);
232 assert( sqlite3IsNaN(y) );
233 }
234#endif
shanefbd60f82009-02-04 03:59:25 +0000235#endif
shanedfb7b372008-07-22 05:13:30 +0000236
drhe4cf0b32011-08-25 00:14:41 +0000237 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
238 ** compile-time option.
239 */
240#ifdef SQLITE_EXTRA_INIT
241 if( rc==SQLITE_OK && sqlite3GlobalConfig.isInit ){
drhc7f94622011-12-13 18:22:38 +0000242 int SQLITE_EXTRA_INIT(const char*);
243 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000244 }
245#endif
246
drh40257ff2008-06-13 18:24:27 +0000247 return rc;
248}
249
250/*
251** Undo the effects of sqlite3_initialize(). Must not be called while
252** there are outstanding database connections or memory allocations or
253** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000254** routine is not threadsafe. But it is safe to invoke this routine
255** on when SQLite is already shut down. If SQLite is already shut down
256** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000257*/
258int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000259 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000260#ifdef SQLITE_EXTRA_SHUTDOWN
261 void SQLITE_EXTRA_SHUTDOWN(void);
262 SQLITE_EXTRA_SHUTDOWN();
263#endif
drha7640922009-04-21 12:02:56 +0000264 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000265 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000266 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000267 }
dane1ab2192009-08-17 15:16:19 +0000268 if( sqlite3GlobalConfig.isPCacheInit ){
269 sqlite3PcacheShutdown();
270 sqlite3GlobalConfig.isPCacheInit = 0;
271 }
272 if( sqlite3GlobalConfig.isMallocInit ){
273 sqlite3MallocEnd();
274 sqlite3GlobalConfig.isMallocInit = 0;
275 }
276 if( sqlite3GlobalConfig.isMutexInit ){
277 sqlite3MutexEnd();
278 sqlite3GlobalConfig.isMutexInit = 0;
279 }
280
drh40257ff2008-06-13 18:24:27 +0000281 return SQLITE_OK;
282}
283
284/*
285** This API allows applications to modify the global configuration of
286** the SQLite library at run-time.
287**
288** This routine should only be called when there are no outstanding
289** database connections or memory allocations. This routine is not
290** threadsafe. Failure to heed these warnings can lead to unpredictable
291** behavior.
292*/
293int sqlite3_config(int op, ...){
294 va_list ap;
295 int rc = SQLITE_OK;
296
297 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
298 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000299 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000300
301 va_start(ap, op);
302 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000303
304 /* Mutex configuration options are only available in a threadsafe
305 ** compile.
306 */
drhd68eee02009-12-11 03:44:18 +0000307#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000308 case SQLITE_CONFIG_SINGLETHREAD: {
309 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000310 sqlite3GlobalConfig.bCoreMutex = 0;
311 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000312 break;
313 }
314 case SQLITE_CONFIG_MULTITHREAD: {
315 /* Disable mutexing of database connections */
316 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000317 sqlite3GlobalConfig.bCoreMutex = 1;
318 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000319 break;
320 }
321 case SQLITE_CONFIG_SERIALIZED: {
322 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000323 sqlite3GlobalConfig.bCoreMutex = 1;
324 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000325 break;
326 }
drh18472fa2008-10-07 15:25:48 +0000327 case SQLITE_CONFIG_MUTEX: {
328 /* Specify an alternative mutex implementation */
329 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
330 break;
331 }
332 case SQLITE_CONFIG_GETMUTEX: {
333 /* Retrieve the current mutex implementation */
334 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
335 break;
336 }
337#endif
338
339
drh40257ff2008-06-13 18:24:27 +0000340 case SQLITE_CONFIG_MALLOC: {
341 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000342 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000343 break;
344 }
drh33589792008-06-18 13:27:46 +0000345 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000346 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000347 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
348 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000349 break;
350 }
drhfec00ea2008-06-14 16:56:21 +0000351 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000352 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000353 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000354 break;
355 }
drh33589792008-06-18 13:27:46 +0000356 case SQLITE_CONFIG_SCRATCH: {
357 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000358 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
359 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
360 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000361 break;
362 }
363 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000364 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000365 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
366 sqlite3GlobalConfig.szPage = va_arg(ap, int);
367 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000368 break;
369 }
danielk19775099be52008-06-27 13:27:03 +0000370
danielk1977bc2ca9e2008-11-13 14:28:28 +0000371 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000372 /* no-op */
373 break;
374 }
375 case SQLITE_CONFIG_GETPCACHE: {
376 /* now an error */
377 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000378 break;
379 }
380
dan22e21ff2011-11-08 20:08:44 +0000381 case SQLITE_CONFIG_PCACHE2: {
382 /* Specify an alternative page cache implementation */
383 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
384 break;
385 }
386 case SQLITE_CONFIG_GETPCACHE2: {
387 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000388 sqlite3PCacheSetDefault();
389 }
dan22e21ff2011-11-08 20:08:44 +0000390 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000391 break;
392 }
393
drh5d414832008-07-15 14:47:18 +0000394#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000395 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000396 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000397 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
398 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
399 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000400
shaneha6ec8922011-03-09 21:36:17 +0000401 if( sqlite3GlobalConfig.mnReq<1 ){
402 sqlite3GlobalConfig.mnReq = 1;
403 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
404 /* cap min request size at 2^12 */
405 sqlite3GlobalConfig.mnReq = (1<<12);
406 }
407
danielk1977075c23a2008-09-01 18:34:20 +0000408 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000409 /* If the heap pointer is NULL, then restore the malloc implementation
410 ** back to NULL pointers too. This will cause the malloc to go
411 ** back to its default implementation when sqlite3_initialize() is
412 ** run.
413 */
danielk1977075c23a2008-09-01 18:34:20 +0000414 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000415 }else{
416 /* The heap pointer is not NULL, then install one of the
417 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
418 ** ENABLE_MEMSYS5 is defined, return an error.
drh8a42cbd2008-07-10 18:13:42 +0000419 */
danielk19775099be52008-06-27 13:27:03 +0000420#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000421 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000422#endif
423#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000424 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000425#endif
drh8a42cbd2008-07-10 18:13:42 +0000426 }
danielk19775099be52008-06-27 13:27:03 +0000427 break;
428 }
drh5d414832008-07-15 14:47:18 +0000429#endif
danielk19775099be52008-06-27 13:27:03 +0000430
drh633e6d52008-07-28 19:34:53 +0000431 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000432 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
433 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000434 break;
435 }
drh3f280702010-02-18 18:45:09 +0000436
437 /* Record a pointer to the logger funcction and its first argument.
438 ** The default is NULL. Logging is disabled if the function pointer is
439 ** NULL.
440 */
441 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000442 /* MSVC is picky about pulling func ptrs from va lists.
443 ** http://support.microsoft.com/kb/47961
444 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
445 */
446 typedef void(*LOGFUNC_t)(void*,int,const char*);
447 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000448 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
449 break;
450 }
drh633e6d52008-07-28 19:34:53 +0000451
dancd74b612011-04-22 19:37:32 +0000452 case SQLITE_CONFIG_URI: {
453 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
454 break;
455 }
456
drh40257ff2008-06-13 18:24:27 +0000457 default: {
458 rc = SQLITE_ERROR;
459 break;
460 }
461 }
462 va_end(ap);
463 return rc;
464}
465
466/*
drh633e6d52008-07-28 19:34:53 +0000467** Set up the lookaside buffers for a database connection.
468** Return SQLITE_OK on success.
469** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000470**
471** The sz parameter is the number of bytes in each lookaside slot.
472** The cnt parameter is the number of slots. If pStart is NULL the
473** space for the lookaside memory is obtained from sqlite3_malloc().
474** If pStart is not NULL then it is sz*cnt bytes of memory to use for
475** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000476*/
drhe9d1c722008-08-04 20:13:26 +0000477static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000478 void *pStart;
479 if( db->lookaside.nOut ){
480 return SQLITE_BUSY;
481 }
shanef71f89e2009-01-30 06:11:54 +0000482 /* Free any existing lookaside buffer for this handle before
483 ** allocating a new one so we don't have to have space for
484 ** both at the same time.
485 */
486 if( db->lookaside.bMalloced ){
487 sqlite3_free(db->lookaside.pStart);
488 }
drh61a4bd52011-11-10 02:39:28 +0000489 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
490 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000491 */
drh61a4bd52011-11-10 02:39:28 +0000492 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000493 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000494 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000495 if( sz==0 || cnt==0 ){
496 sz = 0;
497 pStart = 0;
498 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000499 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000500 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000501 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000502 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000503 }else{
504 pStart = pBuf;
505 }
drh4cfb22f2008-08-01 18:47:01 +0000506 db->lookaside.pStart = pStart;
507 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000508 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000509 if( pStart ){
510 int i;
511 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000512 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000513 p = (LookasideSlot*)pStart;
514 for(i=cnt-1; i>=0; i--){
515 p->pNext = db->lookaside.pFree;
516 db->lookaside.pFree = p;
517 p = (LookasideSlot*)&((u8*)p)[sz];
518 }
519 db->lookaside.pEnd = p;
520 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000521 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000522 }else{
523 db->lookaside.pEnd = 0;
524 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000525 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000526 }
527 return SQLITE_OK;
528}
529
530/*
drh4413d0e2008-11-04 13:46:27 +0000531** Return the mutex associated with a database connection.
532*/
533sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
534 return db->mutex;
535}
536
537/*
drh09419b42011-11-16 19:29:17 +0000538** Free up as much memory as we can from the given database
539** connection.
540*/
541int sqlite3_db_release_memory(sqlite3 *db){
542 int i;
dand9bb3a92011-12-30 11:43:59 +0000543 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000544 sqlite3BtreeEnterAll(db);
545 for(i=0; i<db->nDb; i++){
546 Btree *pBt = db->aDb[i].pBt;
547 if( pBt ){
548 Pager *pPager = sqlite3BtreePager(pBt);
549 sqlite3PagerShrink(pPager);
550 }
551 }
552 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000553 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000554 return SQLITE_OK;
555}
556
557/*
drh633e6d52008-07-28 19:34:53 +0000558** Configuration settings for an individual database connection
559*/
560int sqlite3_db_config(sqlite3 *db, int op, ...){
561 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000562 int rc;
drh633e6d52008-07-28 19:34:53 +0000563 va_start(ap, op);
564 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000565 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000566 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000567 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
568 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000569 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000570 break;
571 }
drh6480aad2008-08-01 16:31:14 +0000572 default: {
drhe83cafd2011-03-21 17:15:58 +0000573 static const struct {
574 int op; /* The opcode */
575 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
576 } aFlagOp[] = {
577 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
578 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
579 };
drh58ad5802011-03-23 22:02:23 +0000580 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000581 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000582 for(i=0; i<ArraySize(aFlagOp); i++){
583 if( aFlagOp[i].op==op ){
584 int onoff = va_arg(ap, int);
585 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000586 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000587 if( onoff>0 ){
588 db->flags |= aFlagOp[i].mask;
589 }else if( onoff==0 ){
590 db->flags &= ~aFlagOp[i].mask;
591 }
592 if( oldFlags!=db->flags ){
593 sqlite3ExpirePreparedStatements(db);
594 }
595 if( pRes ){
596 *pRes = (db->flags & aFlagOp[i].mask)!=0;
597 }
598 rc = SQLITE_OK;
599 break;
600 }
601 }
drh6480aad2008-08-01 16:31:14 +0000602 break;
603 }
drh633e6d52008-07-28 19:34:53 +0000604 }
605 va_end(ap);
606 return rc;
607}
608
drha16313e2007-03-30 11:29:32 +0000609
610/*
drh9b5adfa2008-01-20 23:19:56 +0000611** Return true if the buffer z[0..n-1] contains all spaces.
612*/
613static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000614 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000615 return n==0;
616}
617
618/*
drhd3d39e92004-05-20 22:16:29 +0000619** This is the default collating function named "BINARY" which is always
620** available.
drh9b5adfa2008-01-20 23:19:56 +0000621**
622** If the padFlag argument is not NULL then space padding at the end
623** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000624*/
danielk19772c336542005-01-13 02:14:23 +0000625static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000626 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000627 int nKey1, const void *pKey1,
628 int nKey2, const void *pKey2
629){
630 int rc, n;
631 n = nKey1<nKey2 ? nKey1 : nKey2;
632 rc = memcmp(pKey1, pKey2, n);
633 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000634 if( padFlag
635 && allSpaces(((char*)pKey1)+n, nKey1-n)
636 && allSpaces(((char*)pKey2)+n, nKey2-n)
637 ){
638 /* Leave rc unchanged at 0 */
639 }else{
640 rc = nKey1 - nKey2;
641 }
drhd3d39e92004-05-20 22:16:29 +0000642 }
643 return rc;
644}
645
646/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000647** Another built-in collating sequence: NOCASE.
648**
649** This collating sequence is intended to be used for "case independant
650** comparison". SQLite's knowledge of upper and lower case equivalents
651** extends only to the 26 characters used in the English language.
652**
653** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000654*/
655static int nocaseCollatingFunc(
656 void *NotUsed,
657 int nKey1, const void *pKey1,
658 int nKey2, const void *pKey2
659){
660 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000661 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000662 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000663 if( 0==r ){
664 r = nKey1-nKey2;
665 }
666 return r;
667}
668
669/*
drhaf9ff332002-01-16 21:00:27 +0000670** Return the ROWID of the most recent insert
671*/
drh9bb575f2004-09-06 17:24:11 +0000672sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000673 return db->lastRowid;
674}
675
676/*
danielk197724b03fd2004-05-10 10:34:34 +0000677** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000678*/
drh9bb575f2004-09-06 17:24:11 +0000679int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000680 return db->nChange;
681}
682
rdcf146a772004-02-25 22:51:06 +0000683/*
danielk1977b28af712004-06-21 06:50:26 +0000684** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000685*/
danielk1977b28af712004-06-21 06:50:26 +0000686int sqlite3_total_changes(sqlite3 *db){
687 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000688}
689
drhc8d30ac2002-04-12 10:08:59 +0000690/*
danielk1977fd7f0452008-12-17 17:30:26 +0000691** Close all open savepoints. This function only manipulates fields of the
692** database handle object, it does not close any savepoints that may be open
693** at the b-tree/pager level.
694*/
695void sqlite3CloseSavepoints(sqlite3 *db){
696 while( db->pSavepoint ){
697 Savepoint *pTmp = db->pSavepoint;
698 db->pSavepoint = pTmp->pNext;
699 sqlite3DbFree(db, pTmp);
700 }
701 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000702 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000703 db->isTransactionSavepoint = 0;
704}
705
drh4245c402012-06-02 14:32:21 +0000706
danielk1977fd7f0452008-12-17 17:30:26 +0000707/*
dand2199f02010-08-27 17:48:52 +0000708** Invoke the destructor function associated with FuncDef p, if any. Except,
709** if this is not the last copy of the function, do not invoke it. Multiple
710** copies of a single function are created when create_function() is called
711** with SQLITE_ANY as the encoding.
712*/
713static void functionDestroy(sqlite3 *db, FuncDef *p){
714 FuncDestructor *pDestructor = p->pDestructor;
715 if( pDestructor ){
716 pDestructor->nRef--;
717 if( pDestructor->nRef==0 ){
718 pDestructor->xDestroy(pDestructor->pUserData);
719 sqlite3DbFree(db, pDestructor);
720 }
721 }
722}
723
724/*
drh50e5dad2001-09-15 00:57:28 +0000725** Close an existing SQLite database
726*/
drh9bb575f2004-09-06 17:24:11 +0000727int sqlite3_close(sqlite3 *db){
danielk19775c4c7782004-06-16 10:39:23 +0000728 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000729 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000730 }
drh7e8b8482008-01-23 03:03:05 +0000731 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000732 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000733 }
drh605264d2007-08-21 15:13:19 +0000734 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000735
drh9bbc2e22011-04-04 20:40:22 +0000736 /* Force xDestroy calls on all virtual tables */
drhc7792fa2011-04-02 16:28:52 +0000737 sqlite3ResetInternalSchema(db, -1);
danielk1977a04a34f2007-04-16 15:06:25 +0000738
danielk197701256832007-04-18 14:24:32 +0000739 /* If a transaction is open, the ResetInternalSchema() call above
740 ** will not have called the xDisconnect() method on any virtual
741 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
742 ** call will do so. We need to do this before the check for active
743 ** SQL statements below, as the v-table implementation may be storing
744 ** some prepared statements internally.
745 */
746 sqlite3VtabRollback(db);
747
drh4245c402012-06-02 14:32:21 +0000748 /*
749 ** Mark this database connection as a zombie. Then try to close it.
750 */
751 db->magic = SQLITE_MAGIC_ZOMBIE;
752 sqlite3LeaveMutexAndCloseZombie(db);
753 return SQLITE_OK;
754}
danielk1977e0048402004-06-15 16:51:01 +0000755
drh4245c402012-06-02 14:32:21 +0000756
757/*
758** Close the mutex on database connection db.
759**
760** Furthermore, if database connection db is a zombie (meaning that there
761** has been a prior call to sqlite3_close(db)) and every sqlite3_stmt
762** has now been finalized and every sqlite3_backup has finished, then
763** free all resources.
764*/
765void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
766 HashElem *i; /* Hash table iterator */
767 int j;
768
769 assert( sqlite3_mutex_held(db->mutex) );
770
771 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
772 ** or if the connection has not yet been closed by sqlite3_close, then
773 ** just leave the mutex and return.
774 */
775 if( db->pVdbe || db->magic!=SQLITE_MAGIC_ZOMBIE ){
776 sqlite3_mutex_leave(db->mutex);
777 return;
778 }
danielk197704103022009-02-03 16:51:24 +0000779 for(j=0; j<db->nDb; j++){
780 Btree *pBt = db->aDb[j].pBt;
781 if( pBt && sqlite3BtreeIsInBackup(pBt) ){
danielk197704103022009-02-03 16:51:24 +0000782 sqlite3_mutex_leave(db->mutex);
drh4245c402012-06-02 14:32:21 +0000783 return;
danielk197704103022009-02-03 16:51:24 +0000784 }
785 }
786
drh4245c402012-06-02 14:32:21 +0000787 /* If we reach this point, it means that the database connection has
788 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
789 ** pased to sqlite3_close (meaning that it is a zombie). Therefore,
790 ** go ahead and free all resources.
791 */
792
danielk1977fd7f0452008-12-17 17:30:26 +0000793 /* Free any outstanding Savepoint structures. */
794 sqlite3CloseSavepoints(db);
795
drh001bbcb2003-03-19 03:14:00 +0000796 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000797 struct Db *pDb = &db->aDb[j];
798 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000799 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000800 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000801 if( j!=1 ){
802 pDb->pSchema = 0;
803 }
drh113088e2003-03-20 01:16:58 +0000804 }
drhf57b3392001-10-08 13:22:32 +0000805 }
drhc7792fa2011-04-02 16:28:52 +0000806 sqlite3ResetInternalSchema(db, -1);
danielk1977404ca072009-03-16 13:19:36 +0000807
808 /* Tell the code in notify.c that the connection no longer holds any
809 ** locks and does not require any further unlock-notify callbacks.
810 */
811 sqlite3ConnectionClosed(db);
812
drh1c2d8412003-03-31 00:30:47 +0000813 assert( db->nDb<=2 );
814 assert( db->aDb==db->aDbStatic );
drh70a8ca32008-08-21 18:49:27 +0000815 for(j=0; j<ArraySize(db->aFunc.a); j++){
816 FuncDef *pNext, *pHash, *p;
817 for(p=db->aFunc.a[j]; p; p=pHash){
818 pHash = p->pHash;
819 while( p ){
dand2199f02010-08-27 17:48:52 +0000820 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000821 pNext = p->pNext;
822 sqlite3DbFree(db, p);
823 p = pNext;
824 }
drh8e0a2f92002-02-23 23:45:45 +0000825 }
826 }
danielk1977d8123362004-06-12 09:25:12 +0000827 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000828 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000829 /* Invoke any destructors registered for collation sequence user data. */
830 for(j=0; j<3; j++){
831 if( pColl[j].xDel ){
832 pColl[j].xDel(pColl[j].pUser);
833 }
834 }
drh633e6d52008-07-28 19:34:53 +0000835 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000836 }
danielk1977d8123362004-06-12 09:25:12 +0000837 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000838#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000839 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
840 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000841 if( pMod->xDestroy ){
842 pMod->xDestroy(pMod->pAux);
843 }
drh633e6d52008-07-28 19:34:53 +0000844 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000845 }
drhb9bb7c12006-06-11 23:41:55 +0000846 sqlite3HashClear(&db->aModule);
847#endif
danielk1977466be562004-06-10 02:16:01 +0000848
danielk19776622cce2004-05-20 11:00:52 +0000849 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000850 if( db->pErr ){
851 sqlite3ValueFree(db->pErr);
852 }
drhf1952c52006-06-08 15:48:00 +0000853 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000854
855 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000856
857 /* The temp-database schema is allocated differently from the other schema
858 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
859 ** So it needs to be freed here. Todo: Why not roll the temp schema into
860 ** the same sqliteMalloc() as the one that allocates the database
861 ** structure?
862 */
drh633e6d52008-07-28 19:34:53 +0000863 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000864 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000865 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000866 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +0000867 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +0000868 if( db->lookaside.bMalloced ){
869 sqlite3_free(db->lookaside.pStart);
870 }
drh17435752007-08-16 04:30:38 +0000871 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +0000872}
873
874/*
drh0f198a72012-02-13 16:43:16 +0000875** Rollback all database files. If tripCode is not SQLITE_OK, then
876** any open cursors are invalidated ("tripped" - as in "tripping a circuit
877** breaker") and made to return tripCode if there are any further
878** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +0000879*/
drh0f198a72012-02-13 16:43:16 +0000880void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +0000881 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000882 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000883 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +0000884 sqlite3BeginBenignMalloc();
drh001bbcb2003-03-19 03:14:00 +0000885 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +0000886 Btree *p = db->aDb[i].pBt;
887 if( p ){
888 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000889 inTrans = 1;
890 }
drh0f198a72012-02-13 16:43:16 +0000891 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +0000892 db->aDb[i].inTrans = 0;
893 }
894 }
danielk1977a298e902006-06-22 09:53:48 +0000895 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +0000896 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000897
danielk197771fd80b2005-12-16 06:54:01 +0000898 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000899 sqlite3ExpirePreparedStatements(db);
drhc7792fa2011-04-02 16:28:52 +0000900 sqlite3ResetInternalSchema(db, -1);
danielk197771fd80b2005-12-16 06:54:01 +0000901 }
902
dan1da40a32009-09-19 17:00:31 +0000903 /* Any deferred constraint violations have now been resolved. */
904 db->nDeferredCons = 0;
905
danielk197771fd80b2005-12-16 06:54:01 +0000906 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000907 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000908 db->xRollbackCallback(db->pRollbackArg);
909 }
drh001bbcb2003-03-19 03:14:00 +0000910}
911
912/*
drhc22bd472002-05-10 13:14:07 +0000913** Return a static string that describes the kind of error specified in the
914** argument.
drh247be432002-05-10 05:44:55 +0000915*/
danielk1977f20b21c2004-05-31 23:56:42 +0000916const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +0000917 static const char* const aMsg[] = {
918 /* SQLITE_OK */ "not an error",
919 /* SQLITE_ERROR */ "SQL logic error or missing database",
920 /* SQLITE_INTERNAL */ 0,
921 /* SQLITE_PERM */ "access permission denied",
922 /* SQLITE_ABORT */ "callback requested query abort",
923 /* SQLITE_BUSY */ "database is locked",
924 /* SQLITE_LOCKED */ "database table is locked",
925 /* SQLITE_NOMEM */ "out of memory",
926 /* SQLITE_READONLY */ "attempt to write a readonly database",
927 /* SQLITE_INTERRUPT */ "interrupted",
928 /* SQLITE_IOERR */ "disk I/O error",
929 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +0000930 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +0000931 /* SQLITE_FULL */ "database or disk is full",
932 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +0000933 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +0000934 /* SQLITE_EMPTY */ "table contains no data",
935 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +0000936 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +0000937 /* SQLITE_CONSTRAINT */ "constraint failed",
938 /* SQLITE_MISMATCH */ "datatype mismatch",
939 /* SQLITE_MISUSE */ "library routine called out of sequence",
940 /* SQLITE_NOLFS */ "large file support is disabled",
941 /* SQLITE_AUTH */ "authorization denied",
942 /* SQLITE_FORMAT */ "auxiliary database format error",
943 /* SQLITE_RANGE */ "bind or column index out of range",
944 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
945 };
drh21021a52012-02-13 17:01:51 +0000946 const char *zErr = "unknown error";
947 switch( rc ){
948 case SQLITE_ABORT_ROLLBACK: {
949 zErr = "abort due to ROLLBACK";
950 break;
951 }
952 default: {
953 rc &= 0xff;
954 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
955 zErr = aMsg[rc];
956 }
957 break;
958 }
drh247be432002-05-10 05:44:55 +0000959 }
drh21021a52012-02-13 17:01:51 +0000960 return zErr;
drh247be432002-05-10 05:44:55 +0000961}
962
963/*
drh2dfbbca2000-07-28 14:32:48 +0000964** This routine implements a busy callback that sleeps and tries
965** again until a timeout value is reached. The timeout value is
966** an integer number of milliseconds passed in as the first
967** argument.
968*/
drhdaffd0e2001-04-11 14:28:42 +0000969static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000970 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000971 int count /* Number of times table has been busy */
972){
danielk197729bafea2008-06-26 10:41:19 +0000973#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000974 static const u8 delays[] =
975 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
976 static const u8 totals[] =
977 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +0000978# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +0000979 sqlite3 *db = (sqlite3 *)ptr;
980 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000981 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000982
drhee570fa2005-04-28 12:06:05 +0000983 assert( count>=0 );
984 if( count < NDELAY ){
985 delay = delays[count];
986 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000987 }else{
988 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000989 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000990 }
drhd1bec472004-01-15 13:29:31 +0000991 if( prior + delay > timeout ){
992 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +0000993 if( delay<=0 ) return 0;
994 }
danielk19772a6bdf62007-08-20 16:07:00 +0000995 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +0000996 return 1;
997#else
drh482ea182007-08-20 11:12:40 +0000998 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +0000999 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001000 if( (count+1)*1000 > timeout ){
1001 return 0;
1002 }
drh482ea182007-08-20 11:12:40 +00001003 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001004 return 1;
1005#endif
1006}
1007
1008/*
drha4afb652005-07-09 02:16:02 +00001009** Invoke the given busy handler.
1010**
1011** This routine is called when an operation failed with a lock.
1012** If this routine returns non-zero, the lock is retried. If it
1013** returns 0, the operation aborts with an SQLITE_BUSY error.
1014*/
1015int sqlite3InvokeBusyHandler(BusyHandler *p){
1016 int rc;
drh34004ce2008-07-11 16:15:17 +00001017 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001018 rc = p->xFunc(p->pArg, p->nBusy);
1019 if( rc==0 ){
1020 p->nBusy = -1;
1021 }else{
1022 p->nBusy++;
1023 }
1024 return rc;
1025}
1026
1027/*
drh2dfbbca2000-07-28 14:32:48 +00001028** This routine sets the busy callback for an Sqlite database to the
1029** given callback function with the given argument.
1030*/
danielk1977f9d64d22004-06-19 08:18:07 +00001031int sqlite3_busy_handler(
1032 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001033 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001034 void *pArg
1035){
drhe30f4422007-08-21 16:15:55 +00001036 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001037 db->busyHandler.xFunc = xBusy;
1038 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001039 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +00001040 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001041 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001042}
1043
danielk1977348bb5d2003-10-18 09:37:26 +00001044#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1045/*
1046** This routine sets the progress callback for an Sqlite database to the
1047** given callback function with the given argument. The progress callback will
1048** be invoked every nOps opcodes.
1049*/
danielk197724b03fd2004-05-10 10:34:34 +00001050void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001051 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001052 int nOps,
1053 int (*xProgress)(void*),
1054 void *pArg
1055){
drhbd0b1b52008-07-07 19:52:09 +00001056 sqlite3_mutex_enter(db->mutex);
1057 if( nOps>0 ){
1058 db->xProgress = xProgress;
1059 db->nProgressOps = nOps;
1060 db->pProgressArg = pArg;
1061 }else{
1062 db->xProgress = 0;
1063 db->nProgressOps = 0;
1064 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001065 }
drhbd0b1b52008-07-07 19:52:09 +00001066 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001067}
1068#endif
1069
1070
drh2dfbbca2000-07-28 14:32:48 +00001071/*
1072** This routine installs a default busy handler that waits for the
1073** specified number of milliseconds before returning 0.
1074*/
danielk1977f9d64d22004-06-19 08:18:07 +00001075int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +00001076 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001077 db->busyTimeout = ms;
1078 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +00001079 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001080 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001081 }
danielk1977f9d64d22004-06-19 08:18:07 +00001082 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001083}
drh4c504392000-10-16 22:06:40 +00001084
1085/*
1086** Cause any pending operation to stop at its earliest opportunity.
1087*/
drh9bb575f2004-09-06 17:24:11 +00001088void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +00001089 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001090}
drhfa86c412002-02-02 15:01:15 +00001091
drhfa86c412002-02-02 15:01:15 +00001092
1093/*
danielk1977771151b2006-01-17 13:21:40 +00001094** This function is exactly the same as sqlite3_create_function(), except
1095** that it is designed to be called by internal code. The difference is
1096** that if a malloc() fails in sqlite3_create_function(), an error code
1097** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001098*/
danielk1977771151b2006-01-17 13:21:40 +00001099int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001100 sqlite3 *db,
1101 const char *zFunctionName,
1102 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001103 int enc,
danielk197765904932004-05-26 06:18:37 +00001104 void *pUserData,
1105 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1106 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001107 void (*xFinal)(sqlite3_context*),
1108 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001109){
drh0bce8352002-02-28 00:41:10 +00001110 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001111 int nName;
danielk197765904932004-05-26 06:18:37 +00001112
drhe30f4422007-08-21 16:15:55 +00001113 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001114 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001115 (xFunc && (xFinal || xStep)) ||
1116 (!xFunc && (xFinal && !xStep)) ||
1117 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001118 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001119 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001120 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001121 }
danielk1977d8123362004-06-12 09:25:12 +00001122
danielk197793758c82005-01-21 08:13:14 +00001123#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001124 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1125 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1126 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1127 **
1128 ** If SQLITE_ANY is specified, add three versions of the function
1129 ** to the hash table.
1130 */
1131 if( enc==SQLITE_UTF16 ){
1132 enc = SQLITE_UTF16NATIVE;
1133 }else if( enc==SQLITE_ANY ){
1134 int rc;
danielk1977771151b2006-01-17 13:21:40 +00001135 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
dand2199f02010-08-27 17:48:52 +00001136 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001137 if( rc==SQLITE_OK ){
1138 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
dand2199f02010-08-27 17:48:52 +00001139 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001140 }
1141 if( rc!=SQLITE_OK ){
1142 return rc;
1143 }
danielk1977d8123362004-06-12 09:25:12 +00001144 enc = SQLITE_UTF16BE;
1145 }
danielk197793758c82005-01-21 08:13:14 +00001146#else
1147 enc = SQLITE_UTF8;
1148#endif
danielk19779636c4e2005-01-25 04:27:54 +00001149
1150 /* Check if an existing function is being overridden or deleted. If so,
1151 ** and there are active VMs, then return SQLITE_BUSY. If a function
1152 ** is being overridden/deleted but there are no active VMs, allow the
1153 ** operation to continue but invalidate all precompiled statements.
1154 */
drh3abbd392008-12-10 23:04:13 +00001155 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001156 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
1157 if( db->activeVdbeCnt ){
1158 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001159 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001160 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001161 return SQLITE_BUSY;
1162 }else{
1163 sqlite3ExpirePreparedStatements(db);
1164 }
1165 }
danielk197765904932004-05-26 06:18:37 +00001166
drh3abbd392008-12-10 23:04:13 +00001167 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001168 assert(p || db->mallocFailed);
1169 if( !p ){
1170 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001171 }
dand2199f02010-08-27 17:48:52 +00001172
1173 /* If an older version of the function with a configured destructor is
1174 ** being replaced invoke the destructor function here. */
1175 functionDestroy(db, p);
1176
1177 if( pDestructor ){
1178 pDestructor->nRef++;
1179 }
1180 p->pDestructor = pDestructor;
danielk1977fa18bec2007-09-03 11:04:22 +00001181 p->flags = 0;
1182 p->xFunc = xFunc;
1183 p->xStep = xStep;
1184 p->xFinalize = xFinal;
1185 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001186 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001187 return SQLITE_OK;
1188}
danielk1977771151b2006-01-17 13:21:40 +00001189
1190/*
1191** Create new user functions.
1192*/
1193int sqlite3_create_function(
1194 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001195 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001196 int nArg,
1197 int enc,
1198 void *p,
1199 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1200 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1201 void (*xFinal)(sqlite3_context*)
1202){
drh7b19fac2010-08-27 18:44:54 +00001203 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1204 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001205}
1206
1207int sqlite3_create_function_v2(
1208 sqlite3 *db,
1209 const char *zFunc,
1210 int nArg,
1211 int enc,
1212 void *p,
1213 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1214 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1215 void (*xFinal)(sqlite3_context*),
1216 void (*xDestroy)(void *)
1217){
shanehbd2aaf92010-09-01 02:38:21 +00001218 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001219 FuncDestructor *pArg = 0;
1220 sqlite3_mutex_enter(db->mutex);
1221 if( xDestroy ){
1222 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001223 if( !pArg ){
1224 xDestroy(p);
1225 goto out;
1226 }
dand2199f02010-08-27 17:48:52 +00001227 pArg->xDestroy = xDestroy;
1228 pArg->pUserData = p;
1229 }
1230 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1231 if( pArg && pArg->nRef==0 ){
1232 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001233 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001234 sqlite3DbFree(db, pArg);
1235 }
1236
1237 out:
drhe30f4422007-08-21 16:15:55 +00001238 rc = sqlite3ApiExit(db, rc);
1239 sqlite3_mutex_leave(db->mutex);
1240 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001241}
1242
danielk197793758c82005-01-21 08:13:14 +00001243#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001244int sqlite3_create_function16(
1245 sqlite3 *db,
1246 const void *zFunctionName,
1247 int nArg,
1248 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001249 void *p,
danielk197765904932004-05-26 06:18:37 +00001250 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1251 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1252 void (*xFinal)(sqlite3_context*)
1253){
1254 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001255 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +00001256 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001257 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001258 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001259 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001260 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001261 rc = sqlite3ApiExit(db, rc);
1262 sqlite3_mutex_leave(db->mutex);
1263 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001264}
danielk197793758c82005-01-21 08:13:14 +00001265#endif
drhc9b84a12002-06-20 11:36:48 +00001266
drhb7481e72006-09-16 21:45:14 +00001267
1268/*
1269** Declare that a function has been overloaded by a virtual table.
1270**
1271** If the function already exists as a regular global function, then
1272** this routine is a no-op. If the function does not exist, then create
1273** a new one that always throws a run-time error.
1274**
1275** When virtual tables intend to provide an overloaded function, they
1276** should call this routine to make sure the global function exists.
1277** A global function must exist in order for name resolution to work
1278** properly.
1279*/
1280int sqlite3_overload_function(
1281 sqlite3 *db,
1282 const char *zName,
1283 int nArg
1284){
drhdee0e402009-05-03 20:23:53 +00001285 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001286 int rc = SQLITE_OK;
drhe30f4422007-08-21 16:15:55 +00001287 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001288 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001289 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1290 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001291 }
drhcb5e4db2011-10-12 23:49:49 +00001292 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001293 sqlite3_mutex_leave(db->mutex);
1294 return rc;
drhb7481e72006-09-16 21:45:14 +00001295}
1296
drh19e2d372005-08-29 23:00:03 +00001297#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001298/*
drh18de4822003-01-16 16:28:53 +00001299** Register a trace function. The pArg from the previously registered trace
1300** is returned.
1301**
1302** A NULL trace function means that no tracing is executes. A non-NULL
1303** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001304** SQL statement.
drh18de4822003-01-16 16:28:53 +00001305*/
drh9bb575f2004-09-06 17:24:11 +00001306void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001307 void *pOld;
1308 sqlite3_mutex_enter(db->mutex);
1309 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001310 db->xTrace = xTrace;
1311 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001312 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001313 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001314}
drh19e2d372005-08-29 23:00:03 +00001315/*
1316** Register a profile function. The pArg from the previously registered
1317** profile function is returned.
1318**
1319** A NULL profile function means that no profiling is executes. A non-NULL
1320** profile is a pointer to a function that is invoked at the conclusion of
1321** each SQL statement that is run.
1322*/
1323void *sqlite3_profile(
1324 sqlite3 *db,
1325 void (*xProfile)(void*,const char*,sqlite_uint64),
1326 void *pArg
1327){
drhe30f4422007-08-21 16:15:55 +00001328 void *pOld;
1329 sqlite3_mutex_enter(db->mutex);
1330 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001331 db->xProfile = xProfile;
1332 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001333 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001334 return pOld;
1335}
1336#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001337
drhcd565fd2012-03-01 21:30:44 +00001338/*
1339** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001340** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001341** rollback.
1342*/
danielk197724b03fd2004-05-10 10:34:34 +00001343void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001344 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001345 int (*xCallback)(void*), /* Function to invoke on each commit */
1346 void *pArg /* Argument to the function */
1347){
drhe30f4422007-08-21 16:15:55 +00001348 void *pOld;
1349 sqlite3_mutex_enter(db->mutex);
1350 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001351 db->xCommitCallback = xCallback;
1352 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001353 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001354 return pOld;
1355}
1356
danielk197794eb6a12005-12-15 15:22:08 +00001357/*
1358** Register a callback to be invoked each time a row is updated,
1359** inserted or deleted using this database connection.
1360*/
danielk197771fd80b2005-12-16 06:54:01 +00001361void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001362 sqlite3 *db, /* Attach the hook to this database */
1363 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1364 void *pArg /* Argument to the function */
1365){
drhe30f4422007-08-21 16:15:55 +00001366 void *pRet;
1367 sqlite3_mutex_enter(db->mutex);
1368 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001369 db->xUpdateCallback = xCallback;
1370 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001371 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001372 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001373}
1374
danielk197771fd80b2005-12-16 06:54:01 +00001375/*
1376** Register a callback to be invoked each time a transaction is rolled
1377** back by this database connection.
1378*/
1379void *sqlite3_rollback_hook(
1380 sqlite3 *db, /* Attach the hook to this database */
1381 void (*xCallback)(void*), /* Callback function */
1382 void *pArg /* Argument to the function */
1383){
drhe30f4422007-08-21 16:15:55 +00001384 void *pRet;
1385 sqlite3_mutex_enter(db->mutex);
1386 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001387 db->xRollbackCallback = xCallback;
1388 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001389 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001390 return pRet;
1391}
drhaa940ea2004-01-15 02:44:03 +00001392
dan586b9c82010-05-03 08:04:49 +00001393#ifndef SQLITE_OMIT_WAL
1394/*
1395** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001396** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1397** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001398** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001399*/
drhb033d8b2010-05-03 13:37:30 +00001400int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001401 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001402 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001403 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001404 int nFrame /* Size of WAL */
1405){
drh5def0842010-05-05 20:00:25 +00001406 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001407 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001408 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001409 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001410 }
1411 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001412}
drhb033d8b2010-05-03 13:37:30 +00001413#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001414
1415/*
1416** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1417** a database after committing a transaction if there are nFrame or
1418** more frames in the log file. Passing zero or a negative value as the
1419** nFrame parameter disables automatic checkpoints entirely.
1420**
1421** The callback registered by this function replaces any existing callback
1422** registered using sqlite3_wal_hook(). Likewise, registering a callback
1423** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1424** configured by this function.
1425*/
1426int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001427#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001428 UNUSED_PARAMETER(db);
1429 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001430#else
dan586b9c82010-05-03 08:04:49 +00001431 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001432 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001433 }else{
1434 sqlite3_wal_hook(db, 0, 0);
1435 }
drhb033d8b2010-05-03 13:37:30 +00001436#endif
dan586b9c82010-05-03 08:04:49 +00001437 return SQLITE_OK;
1438}
1439
paulb0208cc2003-04-13 18:26:49 +00001440/*
dan8d22a172010-04-19 18:03:51 +00001441** Register a callback to be invoked each time a transaction is written
1442** into the write-ahead-log by this database connection.
1443*/
drh833bf962010-04-28 14:42:19 +00001444void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001445 sqlite3 *db, /* Attach the hook to this db handle */
1446 int(*xCallback)(void *, sqlite3*, const char*, int),
1447 void *pArg /* First argument passed to xCallback() */
1448){
drhb033d8b2010-05-03 13:37:30 +00001449#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001450 void *pRet;
1451 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001452 pRet = db->pWalArg;
1453 db->xWalCallback = xCallback;
1454 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001455 sqlite3_mutex_leave(db->mutex);
1456 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001457#else
1458 return 0;
1459#endif
dan8d22a172010-04-19 18:03:51 +00001460}
1461
1462/*
dancdc1f042010-11-18 12:11:05 +00001463** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001464*/
dancdc1f042010-11-18 12:11:05 +00001465int sqlite3_wal_checkpoint_v2(
1466 sqlite3 *db, /* Database handle */
1467 const char *zDb, /* Name of attached database (or NULL) */
1468 int eMode, /* SQLITE_CHECKPOINT_* value */
1469 int *pnLog, /* OUT: Size of WAL log in frames */
1470 int *pnCkpt /* OUT: Total number of frames checkpointed */
1471){
drhb033d8b2010-05-03 13:37:30 +00001472#ifdef SQLITE_OMIT_WAL
1473 return SQLITE_OK;
1474#else
dan586b9c82010-05-03 08:04:49 +00001475 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001476 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001477
dan9c5e3682011-02-07 15:12:12 +00001478 /* Initialize the output variables to -1 in case an error occurs. */
1479 if( pnLog ) *pnLog = -1;
1480 if( pnCkpt ) *pnCkpt = -1;
1481
drh383d79e2011-02-09 03:03:16 +00001482 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1483 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1484 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1485 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001486 return SQLITE_MISUSE;
1487 }
1488
dan586b9c82010-05-03 08:04:49 +00001489 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001490 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001491 iDb = sqlite3FindDbName(db, zDb);
1492 }
1493 if( iDb<0 ){
1494 rc = SQLITE_ERROR;
dan87c1fe12010-05-03 12:14:15 +00001495 sqlite3Error(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001496 }else{
dancdc1f042010-11-18 12:11:05 +00001497 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
dan87c1fe12010-05-03 12:14:15 +00001498 sqlite3Error(db, rc, 0);
dan586b9c82010-05-03 08:04:49 +00001499 }
drhb033d8b2010-05-03 13:37:30 +00001500 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001501 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001502 return rc;
1503#endif
dan586b9c82010-05-03 08:04:49 +00001504}
1505
dancdc1f042010-11-18 12:11:05 +00001506
1507/*
1508** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1509** to contains a zero-length string, all attached databases are
1510** checkpointed.
1511*/
1512int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1513 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1514}
1515
drhb033d8b2010-05-03 13:37:30 +00001516#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001517/*
1518** Run a checkpoint on database iDb. This is a no-op if database iDb is
1519** not currently open in WAL mode.
1520**
dan6fcff072010-05-03 14:05:43 +00001521** If a transaction is open on the database being checkpointed, this
1522** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1523** an error occurs while running the checkpoint, an SQLite error code is
1524** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001525**
1526** The mutex on database handle db should be held by the caller. The mutex
1527** associated with the specific b-tree being checkpointed is taken by
1528** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001529**
1530** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1531** checkpointed. If an error is encountered it is returned immediately -
1532** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001533**
dancdc1f042010-11-18 12:11:05 +00001534** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001535*/
dancdc1f042010-11-18 12:11:05 +00001536int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001537 int rc = SQLITE_OK; /* Return code */
1538 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001539 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001540
1541 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001542 assert( !pnLog || *pnLog==-1 );
1543 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001544
dan6fcff072010-05-03 14:05:43 +00001545 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1546 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001547 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001548 pnLog = 0;
1549 pnCkpt = 0;
1550 if( rc==SQLITE_BUSY ){
1551 bBusy = 1;
1552 rc = SQLITE_OK;
1553 }
dan6fcff072010-05-03 14:05:43 +00001554 }
dan586b9c82010-05-03 08:04:49 +00001555 }
1556
danf2b8dd52010-11-18 19:28:01 +00001557 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001558}
drhb033d8b2010-05-03 13:37:30 +00001559#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001560
1561/*
danielk1977d8293352009-04-30 09:10:37 +00001562** This function returns true if main-memory should be used instead of
1563** a temporary file for transient pager files and statement journals.
1564** The value returned depends on the value of db->temp_store (runtime
1565** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1566** following table describes the relationship between these two values
1567** and this functions return value.
1568**
1569** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1570** ----------------- -------------- ------------------------------
1571** 0 any file (return 0)
1572** 1 1 file (return 0)
1573** 1 2 memory (return 1)
1574** 1 0 file (return 0)
1575** 2 1 file (return 0)
1576** 2 2 memory (return 1)
1577** 2 0 memory (return 1)
1578** 3 any memory (return 1)
1579*/
drh1c514142009-04-30 12:25:10 +00001580int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001581#if SQLITE_TEMP_STORE==1
1582 return ( db->temp_store==2 );
1583#endif
1584#if SQLITE_TEMP_STORE==2
1585 return ( db->temp_store!=1 );
1586#endif
1587#if SQLITE_TEMP_STORE==3
1588 return 1;
shanecf697392009-06-01 16:53:09 +00001589#endif
1590#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001591 return 0;
shane60a4b532009-05-06 18:57:09 +00001592#endif
danielk1977d8293352009-04-30 09:10:37 +00001593}
1594
1595/*
danielk19774ad17132004-05-21 01:47:26 +00001596** Return UTF-8 encoded English language explanation of the most recent
1597** error.
1598*/
danielk19776622cce2004-05-20 11:00:52 +00001599const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001600 const char *z;
drhf49661a2008-12-10 16:45:50 +00001601 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001602 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001603 }
drhd55d57e2008-07-07 17:53:07 +00001604 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001605 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001606 }
drh27641702007-08-22 02:56:42 +00001607 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001608 if( db->mallocFailed ){
1609 z = sqlite3ErrStr(SQLITE_NOMEM);
1610 }else{
1611 z = (char*)sqlite3_value_text(db->pErr);
1612 assert( !db->mallocFailed );
1613 if( z==0 ){
1614 z = sqlite3ErrStr(db->errCode);
1615 }
danielk19776622cce2004-05-20 11:00:52 +00001616 }
drhe30f4422007-08-21 16:15:55 +00001617 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001618 return z;
danielk19776622cce2004-05-20 11:00:52 +00001619}
1620
drh6c626082004-11-14 21:56:29 +00001621#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001622/*
1623** Return UTF-16 encoded English language explanation of the most recent
1624** error.
1625*/
danielk19776622cce2004-05-20 11:00:52 +00001626const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00001627 static const u16 outOfMem[] = {
1628 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00001629 };
danielk19777c5c3ca2009-02-23 14:42:53 +00001630 static const u16 misuse[] = {
1631 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
1632 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
1633 'c', 'a', 'l', 'l', 'e', 'd', ' ',
1634 'o', 'u', 't', ' ',
1635 'o', 'f', ' ',
1636 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00001637 };
danielk19774ad17132004-05-21 01:47:26 +00001638
drhc60d0442004-09-30 13:43:13 +00001639 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001640 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001641 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00001642 }
drhd55d57e2008-07-07 17:53:07 +00001643 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001644 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00001645 }
drhe30f4422007-08-21 16:15:55 +00001646 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001647 if( db->mallocFailed ){
1648 z = (void *)outOfMem;
1649 }else{
drhc60d0442004-09-30 13:43:13 +00001650 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00001651 if( z==0 ){
1652 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
1653 SQLITE_UTF8, SQLITE_STATIC);
1654 z = sqlite3_value_text16(db->pErr);
1655 }
1656 /* A malloc() may have failed within the call to sqlite3_value_text16()
1657 ** above. If this is the case, then the db->mallocFailed flag needs to
1658 ** be cleared before returning. Do this directly, instead of via
1659 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1660 */
1661 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00001662 }
drhe30f4422007-08-21 16:15:55 +00001663 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001664 return z;
danielk19776622cce2004-05-20 11:00:52 +00001665}
drh6c626082004-11-14 21:56:29 +00001666#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001667
drhc60d0442004-09-30 13:43:13 +00001668/*
danielk19777ddad962005-12-12 06:53:03 +00001669** Return the most recent error code generated by an SQLite routine. If NULL is
1670** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001671*/
danielk19776622cce2004-05-20 11:00:52 +00001672int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001673 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001674 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00001675 }
drh01495b92008-01-23 12:52:40 +00001676 if( !db || db->mallocFailed ){
1677 return SQLITE_NOMEM;
1678 }
drh4ac285a2006-09-15 07:28:50 +00001679 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001680}
drh99dfe5e2008-10-30 15:03:15 +00001681int sqlite3_extended_errcode(sqlite3 *db){
1682 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001683 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00001684 }
1685 if( !db || db->mallocFailed ){
1686 return SQLITE_NOMEM;
1687 }
1688 return db->errCode;
1689}
danielk19776622cce2004-05-20 11:00:52 +00001690
drh0e819f92006-02-01 13:50:41 +00001691/*
1692** Create a new collating function for database "db". The name is zName
1693** and the encoding is enc.
1694*/
danielk19779a30cf62006-01-18 04:26:07 +00001695static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00001696 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00001697 const char *zName,
shanecea72b22009-09-07 04:38:36 +00001698 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00001699 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001700 int(*xCompare)(void*,int,const void*,int,const void*),
1701 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001702){
1703 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001704 int enc2;
drhc4a64fa2009-05-11 20:53:28 +00001705 int nName = sqlite3Strlen30(zName);
danielk19779a30cf62006-01-18 04:26:07 +00001706
drhe30f4422007-08-21 16:15:55 +00001707 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001708
1709 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1710 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1711 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1712 */
drh51c7d862009-04-27 18:46:06 +00001713 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00001714 testcase( enc2==SQLITE_UTF16 );
1715 testcase( enc2==SQLITE_UTF16_ALIGNED );
1716 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00001717 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001718 }
drh51c7d862009-04-27 18:46:06 +00001719 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00001720 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00001721 }
1722
1723 /* Check if this call is removing or replacing an existing collation
1724 ** sequence. If so, and there are active VMs, return busy. If there
1725 ** are no active VMs, invalidate any pre-compiled statements.
1726 */
drhc4a64fa2009-05-11 20:53:28 +00001727 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001728 if( pColl && pColl->xCmp ){
1729 if( db->activeVdbeCnt ){
1730 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001731 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00001732 return SQLITE_BUSY;
1733 }
1734 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001735
1736 /* If collation sequence pColl was created directly by a call to
1737 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1738 ** then any copies made by synthCollSeq() need to be invalidated.
1739 ** Also, collation destructor - CollSeq.xDel() - function may need
1740 ** to be called.
1741 */
1742 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001743 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001744 int j;
1745 for(j=0; j<3; j++){
1746 CollSeq *p = &aColl[j];
1747 if( p->enc==pColl->enc ){
1748 if( p->xDel ){
1749 p->xDel(p->pUser);
1750 }
1751 p->xCmp = 0;
1752 }
1753 }
1754 }
danielk19779a30cf62006-01-18 04:26:07 +00001755 }
1756
drhc4a64fa2009-05-11 20:53:28 +00001757 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00001758 if( pColl==0 ) return SQLITE_NOMEM;
1759 pColl->xCmp = xCompare;
1760 pColl->pUser = pCtx;
1761 pColl->xDel = xDel;
1762 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
danielk19779a30cf62006-01-18 04:26:07 +00001763 sqlite3Error(db, SQLITE_OK, 0);
1764 return SQLITE_OK;
1765}
1766
1767
danielk19776622cce2004-05-20 11:00:52 +00001768/*
drhbb4957f2008-03-20 14:03:29 +00001769** This array defines hard upper bounds on limit values. The
1770** initializer must be kept in sync with the SQLITE_LIMIT_*
1771** #defines in sqlite3.h.
1772*/
drhb1a6c3c2008-03-20 16:30:17 +00001773static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00001774 SQLITE_MAX_LENGTH,
1775 SQLITE_MAX_SQL_LENGTH,
1776 SQLITE_MAX_COLUMN,
1777 SQLITE_MAX_EXPR_DEPTH,
1778 SQLITE_MAX_COMPOUND_SELECT,
1779 SQLITE_MAX_VDBE_OP,
1780 SQLITE_MAX_FUNCTION_ARG,
1781 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00001782 SQLITE_MAX_LIKE_PATTERN_LENGTH,
1783 SQLITE_MAX_VARIABLE_NUMBER,
drh417168a2009-09-07 18:14:02 +00001784 SQLITE_MAX_TRIGGER_DEPTH,
drhbb4957f2008-03-20 14:03:29 +00001785};
1786
1787/*
1788** Make sure the hard limits are set to reasonable values
1789*/
1790#if SQLITE_MAX_LENGTH<100
1791# error SQLITE_MAX_LENGTH must be at least 100
1792#endif
1793#if SQLITE_MAX_SQL_LENGTH<100
1794# error SQLITE_MAX_SQL_LENGTH must be at least 100
1795#endif
1796#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
1797# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
1798#endif
drhbb4957f2008-03-20 14:03:29 +00001799#if SQLITE_MAX_COMPOUND_SELECT<2
1800# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
1801#endif
1802#if SQLITE_MAX_VDBE_OP<40
1803# error SQLITE_MAX_VDBE_OP must be at least 40
1804#endif
drhe82f5d02008-10-07 19:53:14 +00001805#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
1806# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00001807#endif
drh01c7dc82011-03-23 18:22:34 +00001808#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>62
1809# error SQLITE_MAX_ATTACHED must be between 0 and 62
drhbb4957f2008-03-20 14:03:29 +00001810#endif
drhbb4957f2008-03-20 14:03:29 +00001811#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
1812# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
1813#endif
drh70a8ca32008-08-21 18:49:27 +00001814#if SQLITE_MAX_COLUMN>32767
1815# error SQLITE_MAX_COLUMN must not exceed 32767
1816#endif
drh417168a2009-09-07 18:14:02 +00001817#if SQLITE_MAX_TRIGGER_DEPTH<1
1818# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
1819#endif
drhbb4957f2008-03-20 14:03:29 +00001820
1821
1822/*
1823** Change the value of a limit. Report the old value.
1824** If an invalid limit index is supplied, report -1.
1825** Make no changes but still report the old value if the
1826** new limit is negative.
1827**
1828** A new lower limit does not shrink existing constructs.
1829** It merely prevents new constructs that exceed the limit
1830** from forming.
1831*/
1832int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
1833 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00001834
1835
1836 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
1837 ** there is a hard upper bound set at compile-time by a C preprocessor
1838 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
1839 ** "_MAX_".)
1840 */
1841 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
1842 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
1843 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
1844 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
1845 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
1846 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
1847 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
1848 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
1849 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
1850 SQLITE_MAX_LIKE_PATTERN_LENGTH );
1851 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
1852 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
1853 assert( SQLITE_LIMIT_TRIGGER_DEPTH==(SQLITE_N_LIMIT-1) );
1854
1855
drh521cc842008-04-15 02:36:33 +00001856 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00001857 return -1;
1858 }
1859 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00001860 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00001861 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00001862 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00001863 }
1864 db->aLimit[limitId] = newLimit;
1865 }
drh4e93f5b2010-09-07 14:59:15 +00001866 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00001867}
1868
1869/*
dan286ab7c2011-05-06 18:34:54 +00001870** This function is used to parse both URIs and non-URI filenames passed by the
1871** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
1872** URIs specified as part of ATTACH statements.
1873**
1874** The first argument to this function is the name of the VFS to use (or
1875** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
1876** query parameter. The second argument contains the URI (or non-URI filename)
1877** itself. When this function is called the *pFlags variable should contain
1878** the default flags to open the database handle with. The value stored in
1879** *pFlags may be updated before returning if the URI filename contains
1880** "cache=xxx" or "mode=xxx" query parameters.
1881**
1882** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
1883** the VFS that should be used to open the database file. *pzFile is set to
1884** point to a buffer containing the name of the file to open. It is the
1885** responsibility of the caller to eventually call sqlite3_free() to release
1886** this buffer.
1887**
1888** If an error occurs, then an SQLite error code is returned and *pzErrMsg
1889** may be set to point to a buffer containing an English language error
1890** message. It is the responsibility of the caller to eventually release
1891** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00001892*/
1893int sqlite3ParseUri(
1894 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
1895 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00001896 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00001897 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
1898 char **pzFile, /* OUT: Filename component of URI */
1899 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
1900){
dan78e9dd22011-05-03 10:22:32 +00001901 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00001902 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00001903 const char *zVfs = zDefaultVfs;
1904 char *zFile;
drhde941c32011-05-09 19:20:17 +00001905 char c;
dancd74b612011-04-22 19:37:32 +00001906 int nUri = sqlite3Strlen30(zUri);
1907
1908 assert( *pzErrMsg==0 );
1909
1910 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
1911 && nUri>=5 && memcmp(zUri, "file:", 5)==0
1912 ){
dan5de15372011-04-23 10:12:30 +00001913 char *zOpt;
dancd74b612011-04-22 19:37:32 +00001914 int eState; /* Parser state when parsing URI */
1915 int iIn; /* Input character index */
1916 int iOut = 0; /* Output character index */
1917 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00001918
dan286ab7c2011-05-06 18:34:54 +00001919 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
1920 ** method that there may be extra parameters following the file-name. */
1921 flags |= SQLITE_OPEN_URI;
1922
1923 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00001924 zFile = sqlite3_malloc(nByte);
1925 if( !zFile ) return SQLITE_NOMEM;
1926
1927 /* Discard the scheme and authority segments of the URI. */
1928 if( zUri[5]=='/' && zUri[6]=='/' ){
1929 iIn = 7;
1930 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00001931
1932 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
1933 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
1934 iIn-7, &zUri[7]);
1935 rc = SQLITE_ERROR;
1936 goto parse_uri_out;
1937 }
dancd74b612011-04-22 19:37:32 +00001938 }else{
1939 iIn = 5;
1940 }
1941
1942 /* Copy the filename and any query parameters into the zFile buffer.
1943 ** Decode %HH escape codes along the way.
1944 **
1945 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
1946 ** on the parsing context. As follows:
1947 **
1948 ** 0: Parsing file-name.
1949 ** 1: Parsing name section of a name=value query parameter.
1950 ** 2: Parsing value section of a name=value query parameter.
1951 */
1952 eState = 0;
drhde941c32011-05-09 19:20:17 +00001953 while( (c = zUri[iIn])!=0 && c!='#' ){
1954 iIn++;
dancd74b612011-04-22 19:37:32 +00001955 if( c=='%'
1956 && sqlite3Isxdigit(zUri[iIn])
1957 && sqlite3Isxdigit(zUri[iIn+1])
1958 ){
dan6d49e252011-05-03 15:09:05 +00001959 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
1960 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00001961
dan6d49e252011-05-03 15:09:05 +00001962 assert( octet>=0 && octet<256 );
1963 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00001964 /* This branch is taken when "%00" appears within the URI. In this
1965 ** case we ignore all text in the remainder of the path, name or
1966 ** value currently being parsed. So ignore the current character
1967 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00001968 while( (c = zUri[iIn])!=0 && c!='#'
1969 && (eState!=0 || c!='?')
1970 && (eState!=1 || (c!='=' && c!='&'))
1971 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00001972 ){
1973 iIn++;
1974 }
1975 continue;
dancd74b612011-04-22 19:37:32 +00001976 }
dan6d49e252011-05-03 15:09:05 +00001977 c = octet;
dan5de15372011-04-23 10:12:30 +00001978 }else if( eState==1 && (c=='&' || c=='=') ){
1979 if( zFile[iOut-1]==0 ){
1980 /* An empty option name. Ignore this option altogether. */
1981 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
1982 continue;
1983 }
1984 if( c=='&' ){
1985 zFile[iOut++] = '\0';
1986 }else{
1987 eState = 2;
1988 }
dancd74b612011-04-22 19:37:32 +00001989 c = 0;
dan5de15372011-04-23 10:12:30 +00001990 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
1991 c = 0;
dancd74b612011-04-22 19:37:32 +00001992 eState = 1;
dancd74b612011-04-22 19:37:32 +00001993 }
1994 zFile[iOut++] = c;
1995 }
1996 if( eState==1 ) zFile[iOut++] = '\0';
1997 zFile[iOut++] = '\0';
1998 zFile[iOut++] = '\0';
1999
2000 /* Check if there were any options specified that should be interpreted
2001 ** here. Options that are interpreted here include "vfs" and those that
2002 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002003 ** method. */
dan5de15372011-04-23 10:12:30 +00002004 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2005 while( zOpt[0] ){
2006 int nOpt = sqlite3Strlen30(zOpt);
2007 char *zVal = &zOpt[nOpt+1];
2008 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002009
dan286ab7c2011-05-06 18:34:54 +00002010 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002011 zVfs = zVal;
2012 }else{
2013 struct OpenMode {
2014 const char *z;
2015 int mode;
2016 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002017 char *zModeType = 0;
2018 int mask = 0;
2019 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002020
dan286ab7c2011-05-06 18:34:54 +00002021 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002022 static struct OpenMode aCacheMode[] = {
2023 { "shared", SQLITE_OPEN_SHAREDCACHE },
2024 { "private", SQLITE_OPEN_PRIVATECACHE },
2025 { 0, 0 }
2026 };
2027
2028 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2029 aMode = aCacheMode;
2030 limit = mask;
2031 zModeType = "cache";
2032 }
dan286ab7c2011-05-06 18:34:54 +00002033 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002034 static struct OpenMode aOpenMode[] = {
2035 { "ro", SQLITE_OPEN_READONLY },
2036 { "rw", SQLITE_OPEN_READWRITE },
2037 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
drh9c67b2a2012-05-28 13:58:00 +00002038 { "memory",
2039 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2040 | SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002041 { 0, 0 }
2042 };
2043
drh9c67b2a2012-05-28 13:58:00 +00002044 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2045 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002046 aMode = aOpenMode;
2047 limit = mask & flags;
2048 zModeType = "access";
2049 }
2050
2051 if( aMode ){
2052 int i;
2053 int mode = 0;
2054 for(i=0; aMode[i].z; i++){
2055 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002056 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002057 mode = aMode[i].mode;
2058 break;
dancd74b612011-04-22 19:37:32 +00002059 }
2060 }
dan78e9dd22011-05-03 10:22:32 +00002061 if( mode==0 ){
2062 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2063 rc = SQLITE_ERROR;
2064 goto parse_uri_out;
2065 }
drh9c67b2a2012-05-28 13:58:00 +00002066 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002067 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2068 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002069 rc = SQLITE_PERM;
2070 goto parse_uri_out;
2071 }
2072 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002073 }
dancd74b612011-04-22 19:37:32 +00002074 }
dan5de15372011-04-23 10:12:30 +00002075
2076 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002077 }
2078
2079 }else{
2080 zFile = sqlite3_malloc(nUri+2);
2081 if( !zFile ) return SQLITE_NOMEM;
2082 memcpy(zFile, zUri, nUri);
2083 zFile[nUri] = '\0';
2084 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002085 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002086 }
2087
2088 *ppVfs = sqlite3_vfs_find(zVfs);
2089 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002090 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002091 rc = SQLITE_ERROR;
2092 }
2093 parse_uri_out:
2094 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002095 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002096 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002097 }
2098 *pFlags = flags;
2099 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002100 return rc;
dancd74b612011-04-22 19:37:32 +00002101}
2102
2103
2104/*
danielk19774ad17132004-05-21 01:47:26 +00002105** This routine does the work of opening a database on behalf of
2106** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002107** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002108*/
2109static int openDatabase(
2110 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002111 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002112 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002113 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002114){
dancd74b612011-04-22 19:37:32 +00002115 sqlite3 *db; /* Store allocated handle here */
2116 int rc; /* Return code */
2117 int isThreadsafe; /* True for threadsafe connections */
2118 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2119 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002120
drhe0d0f8e2009-04-28 04:47:31 +00002121 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002122#ifndef SQLITE_OMIT_AUTOINIT
2123 rc = sqlite3_initialize();
2124 if( rc ) return rc;
2125#endif
2126
dan78e9dd22011-05-03 10:22:32 +00002127 /* Only allow sensible combinations of bits in the flags argument.
2128 ** Throw an error if any non-sense combination is used. If we
2129 ** do not block illegal combinations here, it could trigger
2130 ** assert() statements in deeper layers. Sensible combinations
2131 ** are:
2132 **
2133 ** 1: SQLITE_OPEN_READONLY
2134 ** 2: SQLITE_OPEN_READWRITE
2135 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2136 */
2137 assert( SQLITE_OPEN_READONLY == 0x01 );
2138 assert( SQLITE_OPEN_READWRITE == 0x02 );
2139 assert( SQLITE_OPEN_CREATE == 0x04 );
2140 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2141 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2142 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh5dd72ad2011-05-07 18:18:33 +00002143 if( ((1<<(flags&7)) & 0x46)==0 ) return SQLITE_MISUSE_BKPT;
dan78e9dd22011-05-03 10:22:32 +00002144
drh039963a2008-09-03 00:43:15 +00002145 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002146 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002147 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2148 isThreadsafe = 0;
2149 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2150 isThreadsafe = 1;
2151 }else{
2152 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002153 }
drhf1f12682009-09-09 14:17:52 +00002154 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002155 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002156 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2157 flags |= SQLITE_OPEN_SHAREDCACHE;
2158 }
danielk19779a6284c2008-07-10 17:52:49 +00002159
drhb25a9f42009-05-12 13:35:11 +00002160 /* Remove harmful bits from the flags parameter
2161 **
2162 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2163 ** dealt with in the previous code block. Besides these, the only
2164 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002165 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2166 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002167 ** off all other flags.
2168 */
drha4267dc2008-02-19 15:20:44 +00002169 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002170 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002171 SQLITE_OPEN_MAIN_DB |
2172 SQLITE_OPEN_TEMP_DB |
2173 SQLITE_OPEN_TRANSIENT_DB |
2174 SQLITE_OPEN_MAIN_JOURNAL |
2175 SQLITE_OPEN_TEMP_JOURNAL |
2176 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002177 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002178 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002179 SQLITE_OPEN_FULLMUTEX |
2180 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002181 );
2182
danielk19774ad17132004-05-21 01:47:26 +00002183 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002184 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002185 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002186 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002187 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2188 if( db->mutex==0 ){
2189 sqlite3_free(db);
2190 db = 0;
2191 goto opendb_out;
2192 }
drh605264d2007-08-21 15:13:19 +00002193 }
drh27641702007-08-22 02:56:42 +00002194 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002195 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002196 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002197 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002198 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002199
drhbb4957f2008-03-20 14:03:29 +00002200 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2201 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00002202 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002203 db->nextAutovac = -1;
danielk1977f653d782008-03-20 11:04:21 +00002204 db->nextPagesize = 0;
drhe83cafd2011-03-21 17:15:58 +00002205 db->flags |= SQLITE_ShortColNames | SQLITE_AutoIndex | SQLITE_EnableTrigger
drh76fe8032006-07-11 14:17:51 +00002206#if SQLITE_DEFAULT_FILE_FORMAT<4
2207 | SQLITE_LegacyFileFmt
2208#endif
drh56424db2007-03-27 22:24:11 +00002209#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2210 | SQLITE_LoadExtension
2211#endif
dan5bde73c2009-09-01 17:11:07 +00002212#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002213 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002214#endif
drha4bfd7f2010-12-09 19:15:17 +00002215#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2216 | SQLITE_ForeignKeys
2217#endif
drh76fe8032006-07-11 14:17:51 +00002218 ;
drhe61922a2009-05-02 13:29:37 +00002219 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002220#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002221 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002222#endif
danielk1977da184232006-01-05 11:34:32 +00002223
danielk19770202b292004-06-09 09:55:16 +00002224 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2225 ** and UTF-16, so add a version for each to avoid any unnecessary
2226 ** conversions. The only error that can occur here is a malloc() failure.
2227 */
drh4dd65e02011-11-29 14:46:56 +00002228 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2229 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2230 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2231 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002232 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002233 goto opendb_out;
2234 }
drhc4a64fa2009-05-11 20:53:28 +00002235 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002236 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002237
2238 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002239 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002240
dancd74b612011-04-22 19:37:32 +00002241 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002242 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002243 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2244 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002245 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
dan78e9dd22011-05-03 10:22:32 +00002246 sqlite3Error(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002247 sqlite3_free(zErrMsg);
2248 goto opendb_out;
2249 }
2250
danielk19774ad17132004-05-21 01:47:26 +00002251 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002252 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002253 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002254 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002255 if( rc==SQLITE_IOERR_NOMEM ){
2256 rc = SQLITE_NOMEM;
2257 }
danielk19774ad17132004-05-21 01:47:26 +00002258 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00002259 goto opendb_out;
2260 }
drh17435752007-08-16 04:30:38 +00002261 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2262 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002263
drh03b808a2006-03-13 15:06:05 +00002264
danielk197753c0f742005-03-29 03:10:59 +00002265 /* The default safety_level for the main database is 'full'; for the temp
2266 ** database it is 'NONE'. This matches the pager layer defaults.
2267 */
2268 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002269 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002270 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002271 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002272
danielk1977832a58a2007-06-22 15:21:15 +00002273 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002274 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002275 goto opendb_out;
2276 }
2277
danielk19778e227872004-06-07 07:52:17 +00002278 /* Register all built-in functions, but do not attempt to read the
2279 ** database schema yet. This is delayed until the first time the database
2280 ** is accessed.
2281 */
danielk1977832a58a2007-06-22 15:21:15 +00002282 sqlite3Error(db, SQLITE_OK, 0);
2283 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002284
drh1409be62006-08-23 20:07:20 +00002285 /* Load automatic extensions - extensions that have been registered
2286 ** using the sqlite3_automatic_extension() API.
2287 */
drh7aaa8782009-05-20 02:40:45 +00002288 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002289 if( rc==SQLITE_OK ){
2290 sqlite3AutoLoadExtensions(db);
2291 rc = sqlite3_errcode(db);
2292 if( rc!=SQLITE_OK ){
2293 goto opendb_out;
2294 }
danielk1977832a58a2007-06-22 15:21:15 +00002295 }
drh1409be62006-08-23 20:07:20 +00002296
drhaa29c132006-09-02 13:58:06 +00002297#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002298 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002299 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002300 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002301 }
2302#endif
2303
shessa26cf572006-10-19 20:27:58 +00002304#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002305 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002306 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002307 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002308 }
2309#endif
2310
shess69c4ae22007-08-20 17:37:47 +00002311#ifdef SQLITE_ENABLE_FTS3
2312 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002313 rc = sqlite3Fts3Init(db);
2314 }
2315#endif
2316
danielk197783852ac2007-05-06 16:04:11 +00002317#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002318 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002319 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002320 }
2321#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002322
2323#ifdef SQLITE_ENABLE_RTREE
2324 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002325 rc = sqlite3RtreeInit(db);
2326 }
2327#endif
2328
danielk1977832a58a2007-06-22 15:21:15 +00002329 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00002330
drh8fd5bd32007-04-02 16:40:37 +00002331 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2332 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2333 ** mode. Doing nothing at all also makes NORMAL the default.
2334 */
2335#ifdef SQLITE_DEFAULT_LOCKING_MODE
2336 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2337 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2338 SQLITE_DEFAULT_LOCKING_MODE);
2339#endif
2340
drh633e6d52008-07-28 19:34:53 +00002341 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002342 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2343 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002344
dan5a299f92010-05-03 11:05:08 +00002345 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002346
danielk19774ad17132004-05-21 01:47:26 +00002347opendb_out:
dancd74b612011-04-22 19:37:32 +00002348 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002349 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002350 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002351 sqlite3_mutex_leave(db->mutex);
2352 }
danielk197759633ae2008-08-27 19:01:57 +00002353 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002354 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002355 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002356 sqlite3_close(db);
2357 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002358 }else if( rc!=SQLITE_OK ){
2359 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002360 }
danielk19774ad17132004-05-21 01:47:26 +00002361 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00002362 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002363}
2364
2365/*
2366** Open a new database handle.
2367*/
danielk197780290862004-05-22 09:21:21 +00002368int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002369 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002370 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002371){
drh605264d2007-08-21 15:13:19 +00002372 return openDatabase(zFilename, ppDb,
2373 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2374}
2375int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002376 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002377 sqlite3 **ppDb, /* OUT: SQLite db handle */
2378 int flags, /* Flags */
2379 const char *zVfs /* Name of VFS module to use */
2380){
drh522c26f2011-05-07 14:40:29 +00002381 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002382}
2383
drh6c626082004-11-14 21:56:29 +00002384#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002385/*
2386** Open a new database handle.
2387*/
2388int sqlite3_open16(
2389 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002390 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002391){
danielk1977bfd6cce2004-06-18 04:24:54 +00002392 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002393 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002394 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002395
danielk19777ddad962005-12-12 06:53:03 +00002396 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00002397 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00002398 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002399#ifndef SQLITE_OMIT_AUTOINIT
2400 rc = sqlite3_initialize();
2401 if( rc ) return rc;
2402#endif
danielk19771e536952007-08-16 10:09:01 +00002403 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002404 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2405 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002406 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002407 rc = openDatabase(zFilename8, ppDb,
2408 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002409 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002410 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002411 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002412 }
drh40257ff2008-06-13 18:24:27 +00002413 }else{
2414 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002415 }
danielk19777ddad962005-12-12 06:53:03 +00002416 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002417
danielk197754f01982006-01-18 15:25:17 +00002418 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002419}
drh6c626082004-11-14 21:56:29 +00002420#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002421
danielk1977106bb232004-05-21 10:08:53 +00002422/*
danielk1977d8123362004-06-12 09:25:12 +00002423** Register a new collation sequence with the database handle db.
2424*/
danielk19770202b292004-06-09 09:55:16 +00002425int sqlite3_create_collation(
2426 sqlite3* db,
2427 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002428 int enc,
danielk19770202b292004-06-09 09:55:16 +00002429 void* pCtx,
2430 int(*xCompare)(void*,int,const void*,int,const void*)
2431){
danielk19779a30cf62006-01-18 04:26:07 +00002432 int rc;
drhe30f4422007-08-21 16:15:55 +00002433 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002434 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002435 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00002436 rc = sqlite3ApiExit(db, rc);
2437 sqlite3_mutex_leave(db->mutex);
2438 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00002439}
2440
2441/*
2442** Register a new collation sequence with the database handle db.
2443*/
danielk1977a393c032007-05-07 14:58:53 +00002444int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002445 sqlite3* db,
2446 const char *zName,
2447 int enc,
2448 void* pCtx,
2449 int(*xCompare)(void*,int,const void*,int,const void*),
2450 void(*xDel)(void*)
2451){
2452 int rc;
drhe30f4422007-08-21 16:15:55 +00002453 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002454 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002455 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002456 rc = sqlite3ApiExit(db, rc);
2457 sqlite3_mutex_leave(db->mutex);
2458 return rc;
danielk19770202b292004-06-09 09:55:16 +00002459}
2460
drh6c626082004-11-14 21:56:29 +00002461#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002462/*
2463** Register a new collation sequence with the database handle db.
2464*/
danielk19770202b292004-06-09 09:55:16 +00002465int sqlite3_create_collation16(
2466 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002467 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002468 int enc,
danielk19770202b292004-06-09 09:55:16 +00002469 void* pCtx,
2470 int(*xCompare)(void*,int,const void*,int,const void*)
2471){
danielk19779a30cf62006-01-18 04:26:07 +00002472 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002473 char *zName8;
drhe30f4422007-08-21 16:15:55 +00002474 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002475 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002476 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002477 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002478 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002479 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002480 }
drhe30f4422007-08-21 16:15:55 +00002481 rc = sqlite3ApiExit(db, rc);
2482 sqlite3_mutex_leave(db->mutex);
2483 return rc;
danielk19770202b292004-06-09 09:55:16 +00002484}
drh6c626082004-11-14 21:56:29 +00002485#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002486
danielk1977d8123362004-06-12 09:25:12 +00002487/*
2488** Register a collation sequence factory callback with the database handle
2489** db. Replace any previously installed collation sequence factory.
2490*/
danielk19777cedc8d2004-06-10 10:50:08 +00002491int sqlite3_collation_needed(
2492 sqlite3 *db,
2493 void *pCollNeededArg,
2494 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2495){
drhe30f4422007-08-21 16:15:55 +00002496 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002497 db->xCollNeeded = xCollNeeded;
2498 db->xCollNeeded16 = 0;
2499 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002500 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002501 return SQLITE_OK;
2502}
danielk1977d8123362004-06-12 09:25:12 +00002503
drh6c626082004-11-14 21:56:29 +00002504#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002505/*
2506** Register a collation sequence factory callback with the database handle
2507** db. Replace any previously installed collation sequence factory.
2508*/
danielk19777cedc8d2004-06-10 10:50:08 +00002509int sqlite3_collation_needed16(
2510 sqlite3 *db,
2511 void *pCollNeededArg,
2512 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2513){
drhe30f4422007-08-21 16:15:55 +00002514 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002515 db->xCollNeeded = 0;
2516 db->xCollNeeded16 = xCollNeeded16;
2517 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002518 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002519 return SQLITE_OK;
2520}
drh6c626082004-11-14 21:56:29 +00002521#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002522
shaneeec556d2008-10-12 00:27:53 +00002523#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002524/*
danielk19777ddad962005-12-12 06:53:03 +00002525** This function is now an anachronism. It used to be used to recover from a
2526** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002527*/
drh7d97efb2007-10-12 19:35:48 +00002528int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002529 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002530}
2531#endif
drh3e1d8e62005-05-26 16:23:34 +00002532
2533/*
2534** Test to see whether or not the database connection is in autocommit
2535** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2536** by default. Autocommit is disabled by a BEGIN statement and reenabled
2537** by the next COMMIT or ROLLBACK.
2538**
2539******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
2540*/
2541int sqlite3_get_autocommit(sqlite3 *db){
2542 return db->autoCommit;
2543}
drh49285702005-09-17 15:20:26 +00002544
drh49285702005-09-17 15:20:26 +00002545/*
drh9978c972010-02-23 17:36:32 +00002546** The following routines are subtitutes for constants SQLITE_CORRUPT,
2547** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
2548** constants. They server two purposes:
2549**
2550** 1. Serve as a convenient place to set a breakpoint in a debugger
2551** to detect when version error conditions occurs.
2552**
2553** 2. Invoke sqlite3_log() to provide the source code location where
2554** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00002555*/
drh9978c972010-02-23 17:36:32 +00002556int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002557 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00002558 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00002559 "database corruption at line %d of [%.10s]",
2560 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00002561 return SQLITE_CORRUPT;
2562}
drh9978c972010-02-23 17:36:32 +00002563int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002564 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002565 sqlite3_log(SQLITE_MISUSE,
2566 "misuse at line %d of [%.10s]",
2567 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002568 return SQLITE_MISUSE;
2569}
2570int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002571 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002572 sqlite3_log(SQLITE_CANTOPEN,
2573 "cannot open file at line %d of [%.10s]",
2574 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002575 return SQLITE_CANTOPEN;
2576}
2577
drh7c1817e2006-01-10 13:58:48 +00002578
shaneeec556d2008-10-12 00:27:53 +00002579#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00002580/*
2581** This is a convenience routine that makes sure that all thread-specific
2582** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00002583**
2584** SQLite no longer uses thread-specific data so this routine is now a
2585** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00002586*/
2587void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00002588}
shaneeec556d2008-10-12 00:27:53 +00002589#endif
danielk1977deb802c2006-02-09 13:43:28 +00002590
2591/*
2592** Return meta information about a specific column of a database table.
2593** See comment in sqlite3.h (sqlite.h.in) for details.
2594*/
2595#ifdef SQLITE_ENABLE_COLUMN_METADATA
2596int sqlite3_table_column_metadata(
2597 sqlite3 *db, /* Connection handle */
2598 const char *zDbName, /* Database name or NULL */
2599 const char *zTableName, /* Table name */
2600 const char *zColumnName, /* Column name */
2601 char const **pzDataType, /* OUTPUT: Declared data type */
2602 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
2603 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
2604 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00002605 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00002606){
2607 int rc;
2608 char *zErrMsg = 0;
2609 Table *pTab = 0;
2610 Column *pCol = 0;
2611 int iCol;
2612
2613 char const *zDataType = 0;
2614 char const *zCollSeq = 0;
2615 int notnull = 0;
2616 int primarykey = 0;
2617 int autoinc = 0;
2618
2619 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00002620 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00002621 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002622 rc = sqlite3Init(db, &zErrMsg);
2623 if( SQLITE_OK!=rc ){
2624 goto error_out;
2625 }
2626
2627 /* Locate the table in question */
2628 pTab = sqlite3FindTable(db, zTableName, zDbName);
2629 if( !pTab || pTab->pSelect ){
2630 pTab = 0;
2631 goto error_out;
2632 }
2633
2634 /* Find the column for which info is requested */
2635 if( sqlite3IsRowid(zColumnName) ){
2636 iCol = pTab->iPKey;
2637 if( iCol>=0 ){
2638 pCol = &pTab->aCol[iCol];
2639 }
2640 }else{
2641 for(iCol=0; iCol<pTab->nCol; iCol++){
2642 pCol = &pTab->aCol[iCol];
2643 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
2644 break;
2645 }
2646 }
2647 if( iCol==pTab->nCol ){
2648 pTab = 0;
2649 goto error_out;
2650 }
2651 }
2652
2653 /* The following block stores the meta information that will be returned
2654 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
2655 ** and autoinc. At this point there are two possibilities:
2656 **
2657 ** 1. The specified column name was rowid", "oid" or "_rowid_"
2658 ** and there is no explicitly declared IPK column.
2659 **
2660 ** 2. The table is not a view and the column name identified an
2661 ** explicitly declared column. Copy meta information from *pCol.
2662 */
2663 if( pCol ){
2664 zDataType = pCol->zType;
2665 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00002666 notnull = pCol->notNull!=0;
2667 primarykey = pCol->isPrimKey!=0;
drh7d10d5a2008-08-20 16:35:10 +00002668 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00002669 }else{
2670 zDataType = "INTEGER";
2671 primarykey = 1;
2672 }
2673 if( !zCollSeq ){
2674 zCollSeq = "BINARY";
2675 }
2676
2677error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00002678 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002679
2680 /* Whether the function call succeeded or failed, set the output parameters
2681 ** to whatever their local counterparts contain. If an error did occur,
2682 ** this has the effect of zeroing all output parameters.
2683 */
2684 if( pzDataType ) *pzDataType = zDataType;
2685 if( pzCollSeq ) *pzCollSeq = zCollSeq;
2686 if( pNotNull ) *pNotNull = notnull;
2687 if( pPrimaryKey ) *pPrimaryKey = primarykey;
2688 if( pAutoinc ) *pAutoinc = autoinc;
2689
2690 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00002691 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00002692 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00002693 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00002694 rc = SQLITE_ERROR;
2695 }
2696 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002697 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00002698 rc = sqlite3ApiExit(db, rc);
2699 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00002700 return rc;
2701}
drhe30f4422007-08-21 16:15:55 +00002702#endif
drhf9cb7f52006-06-27 20:06:44 +00002703
2704/*
2705** Sleep for a little while. Return the amount of time slept.
2706*/
2707int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00002708 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00002709 int rc;
drhd677b3d2007-08-20 22:48:41 +00002710 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00002711 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00002712
2713 /* This function works in milliseconds, but the underlying OsSleep()
2714 ** API uses microseconds. Hence the 1000's.
2715 */
drhe30f4422007-08-21 16:15:55 +00002716 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00002717 return rc;
drhf9cb7f52006-06-27 20:06:44 +00002718}
drh4ac285a2006-09-15 07:28:50 +00002719
2720/*
2721** Enable or disable the extended result codes.
2722*/
2723int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00002724 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002725 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00002726 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002727 return SQLITE_OK;
2728}
drhcc6bb3e2007-08-31 16:11:35 +00002729
2730/*
2731** Invoke the xFileControl method on a particular database.
2732*/
2733int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
2734 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00002735 Btree *pBtree;
2736
drhcc6bb3e2007-08-31 16:11:35 +00002737 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00002738 pBtree = sqlite3DbNameToBtree(db, zDbName);
2739 if( pBtree ){
2740 Pager *pPager;
2741 sqlite3_file *fd;
2742 sqlite3BtreeEnter(pBtree);
2743 pPager = sqlite3BtreePager(pBtree);
2744 assert( pPager!=0 );
2745 fd = sqlite3PagerFile(pPager);
2746 assert( fd!=0 );
2747 if( op==SQLITE_FCNTL_FILE_POINTER ){
2748 *(sqlite3_file**)pArg = fd;
2749 rc = SQLITE_OK;
2750 }else if( fd->pMethods ){
2751 rc = sqlite3OsFileControl(fd, op, pArg);
2752 }else{
2753 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00002754 }
drh421377e2012-03-15 21:28:54 +00002755 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00002756 }
2757 sqlite3_mutex_leave(db->mutex);
2758 return rc;
2759}
drhed13d982008-01-31 14:43:24 +00002760
2761/*
2762** Interface to the testing logic.
2763*/
2764int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00002765 int rc = 0;
drh3088d592008-03-21 16:45:47 +00002766#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00002767 va_list ap;
drhed13d982008-01-31 14:43:24 +00002768 va_start(ap, op);
2769 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00002770
2771 /*
drh984bfaa2008-03-19 16:08:53 +00002772 ** Save the current state of the PRNG.
2773 */
drh2fa18682008-03-19 14:15:34 +00002774 case SQLITE_TESTCTRL_PRNG_SAVE: {
2775 sqlite3PrngSaveState();
2776 break;
2777 }
drh984bfaa2008-03-19 16:08:53 +00002778
2779 /*
2780 ** Restore the state of the PRNG to the last state saved using
2781 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
2782 ** this verb acts like PRNG_RESET.
2783 */
drh2fa18682008-03-19 14:15:34 +00002784 case SQLITE_TESTCTRL_PRNG_RESTORE: {
2785 sqlite3PrngRestoreState();
2786 break;
2787 }
drh984bfaa2008-03-19 16:08:53 +00002788
2789 /*
2790 ** Reset the PRNG back to its uninitialized state. The next call
2791 ** to sqlite3_randomness() will reseed the PRNG using a single call
2792 ** to the xRandomness method of the default VFS.
2793 */
drh2fa18682008-03-19 14:15:34 +00002794 case SQLITE_TESTCTRL_PRNG_RESET: {
2795 sqlite3PrngResetState();
2796 break;
2797 }
drh3088d592008-03-21 16:45:47 +00002798
2799 /*
2800 ** sqlite3_test_control(BITVEC_TEST, size, program)
2801 **
2802 ** Run a test against a Bitvec object of size. The program argument
2803 ** is an array of integers that defines the test. Return -1 on a
2804 ** memory allocation error, 0 on success, or non-zero for an error.
2805 ** See the sqlite3BitvecBuiltinTest() for additional information.
2806 */
2807 case SQLITE_TESTCTRL_BITVEC_TEST: {
2808 int sz = va_arg(ap, int);
2809 int *aProg = va_arg(ap, int*);
2810 rc = sqlite3BitvecBuiltinTest(sz, aProg);
2811 break;
2812 }
danielk19772d1d86f2008-06-20 14:59:51 +00002813
2814 /*
2815 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
2816 **
2817 ** Register hooks to call to indicate which malloc() failures
2818 ** are benign.
2819 */
2820 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00002821 typedef void (*void_function)(void);
2822 void_function xBenignBegin;
2823 void_function xBenignEnd;
2824 xBenignBegin = va_arg(ap, void_function);
2825 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00002826 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
2827 break;
2828 }
drhc7a3bb92009-02-05 16:31:45 +00002829
2830 /*
drhf3af63f2009-05-09 18:59:42 +00002831 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00002832 **
2833 ** Set the PENDING byte to the value in the argument, if X>0.
2834 ** Make no changes if X==0. Return the value of the pending byte
2835 ** as it existing before this routine was called.
2836 **
2837 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
2838 ** an incompatible database file format. Changing the PENDING byte
2839 ** while any database connection is open results in undefined and
2840 ** dileterious behavior.
2841 */
2842 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00002843 rc = PENDING_BYTE;
2844#ifndef SQLITE_OMIT_WSD
2845 {
2846 unsigned int newVal = va_arg(ap, unsigned int);
2847 if( newVal ) sqlite3PendingByte = newVal;
2848 }
2849#endif
drhc7a3bb92009-02-05 16:31:45 +00002850 break;
2851 }
drhf3af63f2009-05-09 18:59:42 +00002852
2853 /*
2854 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
2855 **
2856 ** This action provides a run-time test to see whether or not
2857 ** assert() was enabled at compile-time. If X is true and assert()
2858 ** is enabled, then the return value is true. If X is true and
2859 ** assert() is disabled, then the return value is zero. If X is
2860 ** false and assert() is enabled, then the assertion fires and the
2861 ** process aborts. If X is false and assert() is disabled, then the
2862 ** return value is zero.
2863 */
2864 case SQLITE_TESTCTRL_ASSERT: {
2865 volatile int x = 0;
2866 assert( (x = va_arg(ap,int))!=0 );
2867 rc = x;
2868 break;
2869 }
2870
2871
2872 /*
2873 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
2874 **
2875 ** This action provides a run-time test to see how the ALWAYS and
2876 ** NEVER macros were defined at compile-time.
2877 **
2878 ** The return value is ALWAYS(X).
2879 **
2880 ** The recommended test is X==2. If the return value is 2, that means
2881 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
2882 ** default setting. If the return value is 1, then ALWAYS() is either
2883 ** hard-coded to true or else it asserts if its argument is false.
2884 ** The first behavior (hard-coded to true) is the case if
2885 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
2886 ** behavior (assert if the argument to ALWAYS() is false) is the case if
2887 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
2888 **
2889 ** The run-time test procedure might look something like this:
2890 **
2891 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
2892 ** // ALWAYS() and NEVER() are no-op pass-through macros
2893 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
2894 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
2895 ** }else{
2896 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
2897 ** }
2898 */
2899 case SQLITE_TESTCTRL_ALWAYS: {
2900 int x = va_arg(ap,int);
2901 rc = ALWAYS(x);
2902 break;
2903 }
drhc046e3e2009-07-15 11:26:44 +00002904
2905 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
2906 **
2907 ** Set the nReserve size to N for the main database on the database
2908 ** connection db.
2909 */
2910 case SQLITE_TESTCTRL_RESERVE: {
2911 sqlite3 *db = va_arg(ap, sqlite3*);
2912 int x = va_arg(ap,int);
2913 sqlite3_mutex_enter(db->mutex);
2914 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
2915 sqlite3_mutex_leave(db->mutex);
2916 break;
2917 }
2918
drh07096f62009-12-22 23:52:32 +00002919 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
2920 **
2921 ** Enable or disable various optimizations for testing purposes. The
2922 ** argument N is a bitmask of optimizations to be disabled. For normal
2923 ** operation N should be 0. The idea is that a test program (like the
2924 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
2925 ** with various optimizations disabled to verify that the same answer
2926 ** is obtained in every case.
2927 */
2928 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
2929 sqlite3 *db = va_arg(ap, sqlite3*);
2930 int x = va_arg(ap,int);
2931 db->flags = (x & SQLITE_OptMask) | (db->flags & ~SQLITE_OptMask);
2932 break;
2933 }
2934
drh0e857732010-01-02 03:21:35 +00002935#ifdef SQLITE_N_KEYWORD
2936 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
2937 **
2938 ** If zWord is a keyword recognized by the parser, then return the
2939 ** number of keywords. Or if zWord is not a keyword, return 0.
2940 **
2941 ** This test feature is only available in the amalgamation since
2942 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
2943 ** is built using separate source files.
2944 */
2945 case SQLITE_TESTCTRL_ISKEYWORD: {
2946 const char *zWord = va_arg(ap, const char*);
2947 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00002948 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00002949 break;
2950 }
2951#endif
2952
drhbadc9802010-08-27 17:16:44 +00002953 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
2954 **
2955 ** Pass pFree into sqlite3ScratchFree().
2956 ** If sz>0 then allocate a scratch buffer into pNew.
2957 */
2958 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
2959 void *pFree, **ppNew;
2960 int sz;
2961 sz = va_arg(ap, int);
2962 ppNew = va_arg(ap, void**);
2963 pFree = va_arg(ap, void*);
2964 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
2965 sqlite3ScratchFree(pFree);
2966 break;
2967 }
2968
danc17d6962011-06-21 12:47:30 +00002969 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
2970 **
2971 ** If parameter onoff is non-zero, configure the wrappers so that all
2972 ** subsequent calls to localtime() and variants fail. If onoff is zero,
2973 ** undo this setting.
2974 */
2975 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
2976 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
2977 break;
2978 }
2979
drh678a9aa2011-12-10 15:55:01 +00002980#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh7e02e5e2011-12-06 19:44:51 +00002981 /* sqlite3_test_control(SQLITE_TESTCTRL_EXPLAIN_STMT,
2982 ** sqlite3_stmt*,const char**);
2983 **
drh678a9aa2011-12-10 15:55:01 +00002984 ** If compiled with SQLITE_ENABLE_TREE_EXPLAIN, each sqlite3_stmt holds
2985 ** a string that describes the optimized parse tree. This test-control
2986 ** returns a pointer to that string.
drh7e02e5e2011-12-06 19:44:51 +00002987 */
2988 case SQLITE_TESTCTRL_EXPLAIN_STMT: {
2989 sqlite3_stmt *pStmt = va_arg(ap, sqlite3_stmt*);
2990 const char **pzRet = va_arg(ap, const char**);
2991 *pzRet = sqlite3VdbeExplanation((Vdbe*)pStmt);
2992 break;
2993 }
drh678a9aa2011-12-10 15:55:01 +00002994#endif
drh7e02e5e2011-12-06 19:44:51 +00002995
drhed13d982008-01-31 14:43:24 +00002996 }
2997 va_end(ap);
drh3088d592008-03-21 16:45:47 +00002998#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00002999 return rc;
drhed13d982008-01-31 14:43:24 +00003000}
drhcc487d12011-05-17 18:53:08 +00003001
3002/*
3003** This is a utility routine, useful to VFS implementations, that checks
3004** to see if a database file was a URI that contained a specific query
3005** parameter, and if so obtains the value of the query parameter.
3006**
3007** The zFilename argument is the filename pointer passed into the xOpen()
3008** method of a VFS implementation. The zParam argument is the name of the
3009** query parameter we seek. This routine returns the value of the zParam
3010** parameter if it exists. If the parameter does not exist, this routine
3011** returns a NULL pointer.
3012*/
3013const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh92913722011-12-23 00:07:33 +00003014 if( zFilename==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003015 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003016 while( zFilename[0] ){
3017 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003018 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003019 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003020 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003021 }
3022 return 0;
3023}
drh283829c2011-11-17 00:56:20 +00003024
3025/*
drh92913722011-12-23 00:07:33 +00003026** Return a boolean value for a query parameter.
3027*/
3028int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3029 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003030 bDflt = bDflt!=0;
3031 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003032}
3033
3034/*
3035** Return a 64-bit integer value for a query parameter.
3036*/
3037sqlite3_int64 sqlite3_uri_int64(
3038 const char *zFilename, /* Filename as passed to xOpen */
3039 const char *zParam, /* URI parameter sought */
3040 sqlite3_int64 bDflt /* return if parameter is missing */
3041){
3042 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3043 sqlite3_int64 v;
3044 if( z && sqlite3Atoi64(z, &v, sqlite3Strlen30(z), SQLITE_UTF8)==SQLITE_OK ){
3045 bDflt = v;
3046 }
3047 return bDflt;
3048}
3049
3050/*
drh421377e2012-03-15 21:28:54 +00003051** Return the Btree pointer identified by zDbName. Return NULL if not found.
3052*/
3053Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3054 int i;
3055 for(i=0; i<db->nDb; i++){
3056 if( db->aDb[i].pBt
3057 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3058 ){
3059 return db->aDb[i].pBt;
3060 }
3061 }
3062 return 0;
3063}
3064
3065/*
drh283829c2011-11-17 00:56:20 +00003066** Return the filename of the database associated with a database
3067** connection.
3068*/
3069const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh421377e2012-03-15 21:28:54 +00003070 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3071 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3072}
3073
3074/*
3075** Return 1 if database is read-only or 0 if read/write. Return -1 if
3076** no such database exists.
3077*/
3078int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
3079 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3080 return pBt ? sqlite3PagerIsreadonly(sqlite3BtreePager(pBt)) : -1;
drh283829c2011-11-17 00:56:20 +00003081}