blob: 78e11d233417e6bdfe9c07420be4ff6a59f5ffb3 [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
29/*
drhb217a572000-08-22 13:40:18 +000030** The version of the library
31*/
drhb3190c12008-12-08 21:37:14 +000032#ifndef SQLITE_AMALGAMATION
danielk197724b03fd2004-05-10 10:34:34 +000033const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000034#endif
drh4aec8b62004-08-28 16:19:00 +000035const char *sqlite3_libversion(void){ return sqlite3_version; }
drh47baebc2009-08-14 16:01:24 +000036const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
danielk197799ba19e2005-02-05 07:33:34 +000037int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drhb67e8bf2007-08-30 20:09:48 +000038int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
shanehbdea6d12010-02-23 04:19:54 +000039const char *sqlite3_compileopts(void){
40 static char zOpts[32] = "";
41 sqlite_int64 iEnable = 0; /* bitmask of all the SQLITE_ENABLE* defines */
42 sqlite_int64 iOmit = 0; /* bitmask of all the SQLITE_OMIT* defines */
43 sqlite_int64 iOther = 0; /* bitmask of all the SQLITE_* defines except */
44 /* SQLITE_MAX* and SQLITE_DEF* */
45
46#ifdef SQLITE_32BIT_ROWID
47 iOther |= ((sqlite_int64)1<<0);
48#endif
49#ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
50 iOther |= ((sqlite_int64)1<<1);
51#endif
52#ifdef SQLITE_AMALGAMATION
53 iOther |= ((sqlite_int64)1<<2);
54#endif
55#ifdef SQLITE_API
56 iOther |= ((sqlite_int64)1<<3);
57#endif
58#ifdef SQLITE_ASCII
59 iOther |= ((sqlite_int64)1<<4);
60#endif
61#ifdef SQLITE_BIG_DBL
62 iOther |= ((sqlite_int64)1<<5);
63#endif
64#ifdef SQLITE_CASE_SENSITIVE_LIKE
65 iOther |= ((sqlite_int64)1<<6);
66#endif
67#ifdef SQLITE_CHECK_PAGES
68 iOther |= ((sqlite_int64)1<<7);
69#endif
70#ifdef SQLITE_CORE
71 iOther |= ((sqlite_int64)1<<8);
72#endif
73#ifdef SQLITE_COVERAGE_TEST
74 iOther |= ((sqlite_int64)1<<9);
75#endif
76#ifdef SQLITE_DEBUG
77 iOther |= ((sqlite_int64)1<<10);
78#endif
79#ifdef SQLITE_DISABLE_DIRSYNC
80 iOther |= ((sqlite_int64)1<<11);
81#endif
82#ifdef SQLITE_DISABLE_LFS
83 iOther |= ((sqlite_int64)1<<12);
84#endif
85#ifdef SQLITE_EBCDIC
86 iOther |= ((sqlite_int64)1<<13);
87#endif
88#ifdef SQLITE_ENABLE_ATOMIC_WRITE
89 iEnable |= ((sqlite_int64)1<<0);
90#endif
91#ifdef SQLITE_ENABLE_CEROD
92 iEnable |= ((sqlite_int64)1<<1);
93#endif
94#ifdef SQLITE_ENABLE_COLUMN_METADATA
95 iEnable |= ((sqlite_int64)1<<2);
96#endif
97#ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
98 iEnable |= ((sqlite_int64)1<<3);
99#endif
100#ifdef SQLITE_ENABLE_FTS1
101 iEnable |= ((sqlite_int64)1<<4);
102#endif
103#ifdef SQLITE_ENABLE_FTS2
104 iEnable |= ((sqlite_int64)1<<5);
105#endif
106#ifdef SQLITE_ENABLE_FTS3
107 iEnable |= ((sqlite_int64)1<<6);
108#endif
109#ifdef SQLITE_ENABLE_FTS4
110 iEnable |= ((sqlite_int64)1<<7);
111#endif
112#ifdef SQLITE_ENABLE_ICU
113 iEnable |= ((sqlite_int64)1<<8);
114#endif
115#ifdef SQLITE_ENABLE_IOTRACE
116 iEnable |= ((sqlite_int64)1<<9);
117#endif
118#ifdef SQLITE_ENABLE_LOAD_EXTENSION
119 iEnable |= ((sqlite_int64)1<<10);
120#endif
121#ifdef SQLITE_ENABLE_LOCKING_STYLE
122 iEnable |= ((sqlite_int64)1<<11);
123#endif
124#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
125 iEnable |= ((sqlite_int64)1<<12);
126#endif
127#ifdef SQLITE_ENABLE_MEMSYS3
128 iEnable |= ((sqlite_int64)1<<13);
129#endif
130#ifdef SQLITE_ENABLE_MEMSYS5
131 iEnable |= ((sqlite_int64)1<<14);
132#endif
133#ifdef SQLITE_ENABLE_OVERSIZE_CELL_CHECK
134 iEnable |= ((sqlite_int64)1<<15);
135#endif
136#ifdef SQLITE_ENABLE_RTREE
137 iEnable |= ((sqlite_int64)1<<16);
138#endif
139#ifdef SQLITE_ENABLE_STAT2
140 iEnable |= ((sqlite_int64)1<<17);
141#endif
142#ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
143 iEnable |= ((sqlite_int64)1<<18);
144#endif
145#ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
146 iEnable |= ((sqlite_int64)1<<19);
147#endif
148#ifdef SQLITE_EXTERN
149 iOther |= ((sqlite_int64)1<<14);
150#endif
151#ifdef SQLITE_FILE_HEADER
152 iOther |= ((sqlite_int64)1<<15);
153#endif
154#ifdef SQLITE_HAS_CODEC
155 iOther |= ((sqlite_int64)1<<16);
156#endif
157#ifdef SQLITE_HAVE_ISNAN
158 iOther |= ((sqlite_int64)1<<17);
159#endif
160#ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
161 iOther |= ((sqlite_int64)1<<18);
162#endif
163#ifdef SQLITE_IGNORE_AFP_LOCK_ERRORS
164 iOther |= ((sqlite_int64)1<<19);
165#endif
166#ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
167 iOther |= ((sqlite_int64)1<<20);
168#endif
169#ifdef SQLITE_INT64_TYPE
170 iOther |= ((sqlite_int64)1<<21);
171#endif
172#ifdef SQLITE_INTEGRITY_CHECK_ERROR_MAX
173 iOther |= ((sqlite_int64)1<<22);
174#endif
175#ifdef SQLITE_LOCK_TRACE
176 iOther |= ((sqlite_int64)1<<23);
177#endif
178#ifdef SQLITE_MALLOC_SOFT_LIMIT
179 iOther |= ((sqlite_int64)1<<24);
180#endif
181#ifdef SQLITE_MEMDEBUG
182 iOther |= ((sqlite_int64)1<<25);
183#endif
184#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
185 iOther |= ((sqlite_int64)1<<26);
186#endif
187#ifdef SQLITE_MUTEX_NOOP
188 iOther |= ((sqlite_int64)1<<27);
189#endif
190#ifdef SQLITE_MUTEX_OMIT
191 iOther |= ((sqlite_int64)1<<28);
192#endif
193#ifdef SQLITE_MUTEX_OS2
194 iOther |= ((sqlite_int64)1<<29);
195#endif
196#ifdef SQLITE_MUTEX_PTHREADS
197 iOther |= ((sqlite_int64)1<<30);
198#endif
199#ifdef SQLITE_MUTEX_W32
200 iOther |= ((sqlite_int64)1<<31);
201#endif
202#ifdef SQLITE_NO_SYNC
203 iOther |= ((sqlite_int64)1<<32);
204#endif
205#ifdef SQLITE_N_COLCACHE
206 iOther |= ((sqlite_int64)1<<33);
207#endif
208#ifdef SQLITE_N_KEYWORD
209 iOther |= ((sqlite_int64)1<<34);
210#endif
211#ifdef SQLITE_OMIT_ALTERTABLE
212 iOmit |= ((sqlite_int64)1<<0);
213#endif
214#ifdef SQLITE_OMIT_ANALYZE
215 iOmit |= ((sqlite_int64)1<<1);
216#endif
217#ifdef SQLITE_OMIT_ATTACH
218 iOmit |= ((sqlite_int64)1<<2);
219#endif
220#ifdef SQLITE_OMIT_AUTHORIZATION
221 iOmit |= ((sqlite_int64)1<<3);
222#endif
223#ifdef SQLITE_OMIT_AUTOINCREMENT
224 iOmit |= ((sqlite_int64)1<<4);
225#endif
226#ifdef SQLITE_OMIT_AUTOINIT
227 iOmit |= ((sqlite_int64)1<<5);
228#endif
229#ifdef SQLITE_OMIT_AUTOVACUUM
230 iOmit |= ((sqlite_int64)1<<6);
231#endif
232#ifdef SQLITE_OMIT_BETWEEN_OPTIMIZATION
233 iOmit |= ((sqlite_int64)1<<7);
234#endif
235#ifdef SQLITE_OMIT_BLOB_LITERAL
236 iOmit |= ((sqlite_int64)1<<8);
237#endif
238#ifdef SQLITE_OMIT_BTREECOUNT
239 iOmit |= ((sqlite_int64)1<<9);
240#endif
241#ifdef SQLITE_OMIT_BUILTIN_TEST
242 iOmit |= ((sqlite_int64)1<<10);
243#endif
244#ifdef SQLITE_OMIT_CAST
245 iOmit |= ((sqlite_int64)1<<11);
246#endif
247#ifdef SQLITE_OMIT_CHECK
248 iOmit |= ((sqlite_int64)1<<12);
249#endif
250#ifdef SQLITE_OMIT_COMPLETE
251 iOmit |= ((sqlite_int64)1<<13);
252#endif
253#ifdef SQLITE_OMIT_COMPOUND_SELECT
254 iOmit |= ((sqlite_int64)1<<14);
255#endif
256#ifdef SQLITE_OMIT_DATETIME_FUNCS
257 iOmit |= ((sqlite_int64)1<<15);
258#endif
259#ifdef SQLITE_OMIT_DECLTYPE
260 iOmit |= ((sqlite_int64)1<<16);
261#endif
262#ifdef SQLITE_OMIT_DEPRECATED
263 iOmit |= ((sqlite_int64)1<<17);
264#endif
265#ifdef SQLITE_OMIT_DISKIO
266 iOmit |= ((sqlite_int64)1<<18);
267#endif
268#ifdef SQLITE_OMIT_EXPLAIN
269 iOmit |= ((sqlite_int64)1<<19);
270#endif
271#ifdef SQLITE_OMIT_FLAG_PRAGMAS
272 iOmit |= ((sqlite_int64)1<<20);
273#endif
274#ifdef SQLITE_OMIT_FLOATING_POINT
275 iOmit |= ((sqlite_int64)1<<21);
276#endif
277#ifdef SQLITE_OMIT_FOREIGN_KEY
278 iOmit |= ((sqlite_int64)1<<22);
279#endif
280#ifdef SQLITE_OMIT_GET_TABLE
281 iOmit |= ((sqlite_int64)1<<23);
282#endif
283#ifdef SQLITE_OMIT_GLOBALRECOVER
284 iOmit |= ((sqlite_int64)1<<24);
285#endif
286#ifdef SQLITE_OMIT_INCRBLOB
287 iOmit |= ((sqlite_int64)1<<25);
288#endif
289#ifdef SQLITE_OMIT_INTEGRITY_CHECK
290 iOmit |= ((sqlite_int64)1<<26);
291#endif
292#ifdef SQLITE_OMIT_LIKE_OPTIMIZATION
293 iOmit |= ((sqlite_int64)1<<27);
294#endif
295#ifdef SQLITE_OMIT_LOAD_EXTENSION
296 iOmit |= ((sqlite_int64)1<<28);
297#endif
298#ifdef SQLITE_OMIT_LOCALTIME
299 iOmit |= ((sqlite_int64)1<<29);
300#endif
301#ifdef SQLITE_OMIT_LOOKASIDE
302 iOmit |= ((sqlite_int64)1<<30);
303#endif
304#ifdef SQLITE_OMIT_MEMORYDB
305 iOmit |= ((sqlite_int64)1<<31);
306#endif
307#ifdef SQLITE_OMIT_OR_OPTIMIZATION
308 iOmit |= ((sqlite_int64)1<<32);
309#endif
310#ifdef SQLITE_OMIT_PAGER_PRAGMAS
311 iOmit |= ((sqlite_int64)1<<33);
312#endif
313#ifdef SQLITE_OMIT_PRAGMA
314 iOmit |= ((sqlite_int64)1<<34);
315#endif
316#ifdef SQLITE_OMIT_PROGRESS_CALLBACK
317 iOmit |= ((sqlite_int64)1<<35);
318#endif
319#ifdef SQLITE_OMIT_QUICKBALANCE
320 iOmit |= ((sqlite_int64)1<<36);
321#endif
322#ifdef SQLITE_OMIT_REINDEX
323 iOmit |= ((sqlite_int64)1<<37);
324#endif
325#ifdef SQLITE_OMIT_SCHEMA_PRAGMAS
326 iOmit |= ((sqlite_int64)1<<38);
327#endif
328#ifdef SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
329 iOmit |= ((sqlite_int64)1<<39);
330#endif
331#ifdef SQLITE_OMIT_SHARED_CACHE
332 iOmit |= ((sqlite_int64)1<<40);
333#endif
334#ifdef SQLITE_OMIT_SUBQUERY
335 iOmit |= ((sqlite_int64)1<<41);
336#endif
337#ifdef SQLITE_OMIT_TCL_VARIABLE
338 iOmit |= ((sqlite_int64)1<<42);
339#endif
340#ifdef SQLITE_OMIT_TEMPDB
341 iOmit |= ((sqlite_int64)1<<43);
342#endif
343#ifdef SQLITE_OMIT_TRACE
344 iOmit |= ((sqlite_int64)1<<44);
345#endif
346#ifdef SQLITE_OMIT_TRIGGER
347 iOmit |= ((sqlite_int64)1<<45);
348#endif
349#ifdef SQLITE_OMIT_TRUNCATE_OPTIMIZATION
350 iOmit |= ((sqlite_int64)1<<46);
351#endif
352#ifdef SQLITE_OMIT_UTF16
353 iOmit |= ((sqlite_int64)1<<47);
354#endif
355#ifdef SQLITE_OMIT_VACUUM
356 iOmit |= ((sqlite_int64)1<<48);
357#endif
358#ifdef SQLITE_OMIT_VIEW
359 iOmit |= ((sqlite_int64)1<<49);
360#endif
361#ifdef SQLITE_OMIT_VIRTUALTABLE
362 iOmit |= ((sqlite_int64)1<<50);
363#endif
364#ifdef SQLITE_OMIT_WSD
365 iOmit |= ((sqlite_int64)1<<51);
366#endif
367#ifdef SQLITE_OMIT_XFER_OPT
368 iOmit |= ((sqlite_int64)1<<52);
369#endif
370#ifdef SQLITE_OS_OTHER
371 iOther |= ((sqlite_int64)1<<35);
372#endif
373#ifdef SQLITE_OS_UNIX
374 iOther |= ((sqlite_int64)1<<36);
375#endif
376#ifdef SQLITE_PERFORMANCE_TRACE
377 iOther |= ((sqlite_int64)1<<37);
378#endif
379#ifdef SQLITE_PRINT_BUF_SIZE
380 iOther |= ((sqlite_int64)1<<38);
381#endif
382#ifdef SQLITE_PRIVATE
383 iOther |= ((sqlite_int64)1<<39);
384#endif
385#ifdef SQLITE_PROXY_DEBUG
386 iOther |= ((sqlite_int64)1<<40);
387#endif
388#ifdef SQLITE_SECURE_DELETE
389 iOther |= ((sqlite_int64)1<<41);
390#endif
391#ifdef SQLITE_SMALL_STACK
392 iOther |= ((sqlite_int64)1<<42);
393#endif
394#ifdef SQLITE_SOUNDEX
395 iOther |= ((sqlite_int64)1<<43);
396#endif
397#ifdef SQLITE_SYSTEM_MALLOC
398 iOther |= ((sqlite_int64)1<<44);
399#endif
400#ifdef SQLITE_TCL
401 iOther |= ((sqlite_int64)1<<45);
402#endif
403#ifdef SQLITE_TEMP_FILE_PREFIX
404 iOther |= ((sqlite_int64)1<<46);
405#endif
406#ifdef SQLITE_TEMP_STORE
407 iOther |= ((sqlite_int64)1<<47);
408#endif
409#ifdef SQLITE_TEST
410 iOther |= ((sqlite_int64)1<<48);
411#endif
412#ifdef SQLITE_TEXT
413 iOther |= ((sqlite_int64)1<<49);
414#endif
415#ifdef SQLITE_THREADSAFE
416 iOther |= ((sqlite_int64)1<<50);
417#endif
418#ifdef SQLITE_USE_ALLOCA
419 iOther |= ((sqlite_int64)1<<51);
420#endif
421#ifdef SQLITE_VERSION
422 iOther |= ((sqlite_int64)1<<52);
423#endif
424#ifdef SQLITE_VERSION_NUMBER
425 iOther |= ((sqlite_int64)1<<53);
426#endif
427#ifdef SQLITE_ZERO_MALLOC
428 iOther |= ((sqlite_int64)1<<54);
429#endif
430
431 sqlite3_snprintf(sizeof(zOpts)-1, zOpts,
432 "%016llx%016llx%016llx", iEnable, iOmit, iOther);
433 return zOpts;
434}
drhb217a572000-08-22 13:40:18 +0000435
drhe265b082008-05-01 17:03:49 +0000436#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +0000437/*
drhb0603412007-02-28 04:47:26 +0000438** If the following function pointer is not NULL and if
439** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
440** I/O active are written using this function. These messages
441** are intended for debugging activity only.
442*/
mlcreech3a00f902008-03-04 17:45:01 +0000443void (*sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +0000444#endif
drhb0603412007-02-28 04:47:26 +0000445
446/*
drha16313e2007-03-30 11:29:32 +0000447** If the following global variable points to a string which is the
448** name of a directory, then that directory will be used to store
449** temporary files.
450**
451** See also the "PRAGMA temp_store_directory" SQL command.
452*/
453char *sqlite3_temp_directory = 0;
454
drhc5499be2008-04-01 15:06:33 +0000455/*
drh40257ff2008-06-13 18:24:27 +0000456** Initialize SQLite.
457**
458** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000459** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000460** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
461** this routine will be called automatically by key routines such as
462** sqlite3_open().
463**
464** This routine is a no-op except on its very first call for the process,
465** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000466**
467** The first thread to call this routine runs the initialization to
468** completion. If subsequent threads call this routine before the first
469** thread has finished the initialization process, then the subsequent
470** threads must block until the first thread finishes with the initialization.
471**
472** The first thread might call this routine recursively. Recursive
473** calls to this routine should not block, of course. Otherwise the
474** initialization process would never complete.
475**
476** Let X be the first thread to enter this routine. Let Y be some other
477** thread. Then while the initial invocation of this routine by X is
478** incomplete, it is required that:
479**
480** * Calls to this routine from Y must block until the outer-most
481** call by X completes.
482**
483** * Recursive calls to this routine from thread X return immediately
484** without blocking.
drh40257ff2008-06-13 18:24:27 +0000485*/
486int sqlite3_initialize(void){
danielk1977075c23a2008-09-01 18:34:20 +0000487 sqlite3_mutex *pMaster; /* The main static mutex */
488 int rc; /* Result code */
489
490#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000491 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000492 if( rc!=SQLITE_OK ){
493 return rc;
494 }
495#endif
danielk197771bc31c2008-06-26 08:29:34 +0000496
drh93ed56d2008-08-12 15:21:11 +0000497 /* If SQLite is already completely initialized, then this call
498 ** to sqlite3_initialize() should be a no-op. But the initialization
499 ** must be complete. So isInit must not be set until the very end
500 ** of this routine.
501 */
danielk1977075c23a2008-09-01 18:34:20 +0000502 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000503
drh93ed56d2008-08-12 15:21:11 +0000504 /* Make sure the mutex subsystem is initialized. If unable to
505 ** initialize the mutex subsystem, return early with the error.
506 ** If the system is so sick that we are unable to allocate a mutex,
507 ** there is not much SQLite is going to be able to do.
508 **
509 ** The mutex subsystem must take care of serializing its own
510 ** initialization.
511 */
danielk1977d0251742008-06-18 18:57:42 +0000512 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000513 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000514
drh93ed56d2008-08-12 15:21:11 +0000515 /* Initialize the malloc() system and the recursive pInitMutex mutex.
516 ** This operation is protected by the STATIC_MASTER mutex. Note that
517 ** MutexAlloc() is called for a static mutex prior to initializing the
518 ** malloc subsystem - this implies that the allocation of a static
519 ** mutex must not require support from the malloc subsystem.
520 */
521 pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
522 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000523 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000524 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000525 rc = sqlite3MallocInit();
526 }
drh40257ff2008-06-13 18:24:27 +0000527 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000528 sqlite3GlobalConfig.isMallocInit = 1;
529 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000530 sqlite3GlobalConfig.pInitMutex =
531 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000532 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000533 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000534 }
535 }
danielk197777eb5bb2008-09-22 17:22:19 +0000536 }
537 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000538 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000539 }
540 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000541
dane1ab2192009-08-17 15:16:19 +0000542 /* If rc is not SQLITE_OK at this point, then either the malloc
543 ** subsystem could not be initialized or the system failed to allocate
544 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000545 if( rc!=SQLITE_OK ){
546 return rc;
547 }
548
549 /* Do the rest of the initialization under the recursive mutex so
550 ** that we will be able to handle recursive calls into
551 ** sqlite3_initialize(). The recursive calls normally come through
552 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
553 ** recursive calls might also be possible.
554 */
danielk1977075c23a2008-09-01 18:34:20 +0000555 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000556 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000557 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000558 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000559 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000560 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000561 if( sqlite3GlobalConfig.isPCacheInit==0 ){
562 rc = sqlite3PcacheInitialize();
563 }
danielk19778c0a7912008-08-20 14:49:23 +0000564 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000565 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000566 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000567 }
568 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000569 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
570 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000571 sqlite3GlobalConfig.isInit = 1;
danielk19778c0a7912008-08-20 14:49:23 +0000572 }
danielk1977502b4e02008-09-02 14:07:24 +0000573 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000574 }
danielk1977075c23a2008-09-01 18:34:20 +0000575 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000576
drh93ed56d2008-08-12 15:21:11 +0000577 /* Go back under the static mutex and clean up the recursive
578 ** mutex to prevent a resource leak.
579 */
580 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000581 sqlite3GlobalConfig.nRefInitMutex--;
582 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
583 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
584 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
585 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000586 }
587 sqlite3_mutex_leave(pMaster);
588
589 /* The following is just a sanity check to make sure SQLite has
590 ** been compiled correctly. It is important to run this code, but
591 ** we don't want to run it too often and soak up CPU cycles for no
592 ** reason. So we run it once during initialization.
593 */
shanedfb7b372008-07-22 05:13:30 +0000594#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000595#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000596 /* This section of code's only "output" is via assert() statements. */
597 if ( rc==SQLITE_OK ){
598 u64 x = (((u64)1)<<63)-1;
599 double y;
600 assert(sizeof(x)==8);
601 assert(sizeof(x)==sizeof(y));
602 memcpy(&y, &x, 8);
603 assert( sqlite3IsNaN(y) );
604 }
605#endif
shanefbd60f82009-02-04 03:59:25 +0000606#endif
shanedfb7b372008-07-22 05:13:30 +0000607
drh40257ff2008-06-13 18:24:27 +0000608 return rc;
609}
610
611/*
612** Undo the effects of sqlite3_initialize(). Must not be called while
613** there are outstanding database connections or memory allocations or
614** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000615** routine is not threadsafe. But it is safe to invoke this routine
616** on when SQLite is already shut down. If SQLite is already shut down
617** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000618*/
619int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000620 if( sqlite3GlobalConfig.isInit ){
drha7640922009-04-21 12:02:56 +0000621 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000622 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000623 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000624 }
dane1ab2192009-08-17 15:16:19 +0000625 if( sqlite3GlobalConfig.isPCacheInit ){
626 sqlite3PcacheShutdown();
627 sqlite3GlobalConfig.isPCacheInit = 0;
628 }
629 if( sqlite3GlobalConfig.isMallocInit ){
630 sqlite3MallocEnd();
631 sqlite3GlobalConfig.isMallocInit = 0;
632 }
633 if( sqlite3GlobalConfig.isMutexInit ){
634 sqlite3MutexEnd();
635 sqlite3GlobalConfig.isMutexInit = 0;
636 }
637
drh40257ff2008-06-13 18:24:27 +0000638 return SQLITE_OK;
639}
640
641/*
642** This API allows applications to modify the global configuration of
643** the SQLite library at run-time.
644**
645** This routine should only be called when there are no outstanding
646** database connections or memory allocations. This routine is not
647** threadsafe. Failure to heed these warnings can lead to unpredictable
648** behavior.
649*/
650int sqlite3_config(int op, ...){
651 va_list ap;
652 int rc = SQLITE_OK;
653
654 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
655 ** the SQLite library is in use. */
danielk1977075c23a2008-09-01 18:34:20 +0000656 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE;
drh40257ff2008-06-13 18:24:27 +0000657
658 va_start(ap, op);
659 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000660
661 /* Mutex configuration options are only available in a threadsafe
662 ** compile.
663 */
drhd68eee02009-12-11 03:44:18 +0000664#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000665 case SQLITE_CONFIG_SINGLETHREAD: {
666 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000667 sqlite3GlobalConfig.bCoreMutex = 0;
668 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000669 break;
670 }
671 case SQLITE_CONFIG_MULTITHREAD: {
672 /* Disable mutexing of database connections */
673 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000674 sqlite3GlobalConfig.bCoreMutex = 1;
675 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000676 break;
677 }
678 case SQLITE_CONFIG_SERIALIZED: {
679 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000680 sqlite3GlobalConfig.bCoreMutex = 1;
681 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000682 break;
683 }
drh18472fa2008-10-07 15:25:48 +0000684 case SQLITE_CONFIG_MUTEX: {
685 /* Specify an alternative mutex implementation */
686 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
687 break;
688 }
689 case SQLITE_CONFIG_GETMUTEX: {
690 /* Retrieve the current mutex implementation */
691 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
692 break;
693 }
694#endif
695
696
drh40257ff2008-06-13 18:24:27 +0000697 case SQLITE_CONFIG_MALLOC: {
698 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000699 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000700 break;
701 }
drh33589792008-06-18 13:27:46 +0000702 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000703 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000704 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
705 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000706 break;
707 }
drhfec00ea2008-06-14 16:56:21 +0000708 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000709 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000710 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000711 break;
712 }
drh33589792008-06-18 13:27:46 +0000713 case SQLITE_CONFIG_SCRATCH: {
714 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000715 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
716 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
717 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000718 break;
719 }
720 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000721 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000722 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
723 sqlite3GlobalConfig.szPage = va_arg(ap, int);
724 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000725 break;
726 }
danielk19775099be52008-06-27 13:27:03 +0000727
danielk1977bc2ca9e2008-11-13 14:28:28 +0000728 case SQLITE_CONFIG_PCACHE: {
drhb0937192009-05-22 10:53:29 +0000729 /* Specify an alternative page cache implementation */
danielk1977bc2ca9e2008-11-13 14:28:28 +0000730 sqlite3GlobalConfig.pcache = *va_arg(ap, sqlite3_pcache_methods*);
731 break;
732 }
733
drhb232c232008-11-19 01:20:26 +0000734 case SQLITE_CONFIG_GETPCACHE: {
735 if( sqlite3GlobalConfig.pcache.xInit==0 ){
736 sqlite3PCacheSetDefault();
737 }
738 *va_arg(ap, sqlite3_pcache_methods*) = sqlite3GlobalConfig.pcache;
739 break;
740 }
741
drh5d414832008-07-15 14:47:18 +0000742#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000743 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000744 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000745 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
746 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
747 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000748
danielk1977075c23a2008-09-01 18:34:20 +0000749 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000750 /* If the heap pointer is NULL, then restore the malloc implementation
751 ** back to NULL pointers too. This will cause the malloc to go
752 ** back to its default implementation when sqlite3_initialize() is
753 ** run.
754 */
danielk1977075c23a2008-09-01 18:34:20 +0000755 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000756 }else{
757 /* The heap pointer is not NULL, then install one of the
758 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
759 ** ENABLE_MEMSYS5 is defined, return an error.
drh8a42cbd2008-07-10 18:13:42 +0000760 */
danielk19775099be52008-06-27 13:27:03 +0000761#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000762 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000763#endif
764#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000765 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000766#endif
drh8a42cbd2008-07-10 18:13:42 +0000767 }
danielk19775099be52008-06-27 13:27:03 +0000768 break;
769 }
drh5d414832008-07-15 14:47:18 +0000770#endif
danielk19775099be52008-06-27 13:27:03 +0000771
drh633e6d52008-07-28 19:34:53 +0000772 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000773 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
774 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000775 break;
776 }
drh3f280702010-02-18 18:45:09 +0000777
778 /* Record a pointer to the logger funcction and its first argument.
779 ** The default is NULL. Logging is disabled if the function pointer is
780 ** NULL.
781 */
782 case SQLITE_CONFIG_LOG: {
783 sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
784 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
785 break;
786 }
drh633e6d52008-07-28 19:34:53 +0000787
drh40257ff2008-06-13 18:24:27 +0000788 default: {
789 rc = SQLITE_ERROR;
790 break;
791 }
792 }
793 va_end(ap);
794 return rc;
795}
796
797/*
drh633e6d52008-07-28 19:34:53 +0000798** Set up the lookaside buffers for a database connection.
799** Return SQLITE_OK on success.
800** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000801**
802** The sz parameter is the number of bytes in each lookaside slot.
803** The cnt parameter is the number of slots. If pStart is NULL the
804** space for the lookaside memory is obtained from sqlite3_malloc().
805** If pStart is not NULL then it is sz*cnt bytes of memory to use for
806** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000807*/
drhe9d1c722008-08-04 20:13:26 +0000808static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000809 void *pStart;
810 if( db->lookaside.nOut ){
811 return SQLITE_BUSY;
812 }
shanef71f89e2009-01-30 06:11:54 +0000813 /* Free any existing lookaside buffer for this handle before
814 ** allocating a new one so we don't have to have space for
815 ** both at the same time.
816 */
817 if( db->lookaside.bMalloced ){
818 sqlite3_free(db->lookaside.pStart);
819 }
820 /* The size of a lookaside slot needs to be larger than a pointer
821 ** to be useful.
822 */
drh1d34fde2009-02-03 15:50:33 +0000823 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000824 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000825 if( sz==0 || cnt==0 ){
826 sz = 0;
827 pStart = 0;
828 }else if( pBuf==0 ){
danielk1977bc739712009-03-23 04:33:32 +0000829 sz = ROUND8(sz);
drhe9d1c722008-08-04 20:13:26 +0000830 sqlite3BeginBenignMalloc();
831 pStart = sqlite3Malloc( sz*cnt );
832 sqlite3EndBenignMalloc();
833 }else{
danielk1977bc739712009-03-23 04:33:32 +0000834 sz = ROUNDDOWN8(sz);
drhe9d1c722008-08-04 20:13:26 +0000835 pStart = pBuf;
836 }
drh4cfb22f2008-08-01 18:47:01 +0000837 db->lookaside.pStart = pStart;
838 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000839 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000840 if( pStart ){
841 int i;
842 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000843 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000844 p = (LookasideSlot*)pStart;
845 for(i=cnt-1; i>=0; i--){
846 p->pNext = db->lookaside.pFree;
847 db->lookaside.pFree = p;
848 p = (LookasideSlot*)&((u8*)p)[sz];
849 }
850 db->lookaside.pEnd = p;
851 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000852 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000853 }else{
854 db->lookaside.pEnd = 0;
855 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000856 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000857 }
858 return SQLITE_OK;
859}
860
861/*
drh4413d0e2008-11-04 13:46:27 +0000862** Return the mutex associated with a database connection.
863*/
864sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
865 return db->mutex;
866}
867
868/*
drh633e6d52008-07-28 19:34:53 +0000869** Configuration settings for an individual database connection
870*/
871int sqlite3_db_config(sqlite3 *db, int op, ...){
872 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000873 int rc;
drh633e6d52008-07-28 19:34:53 +0000874 va_start(ap, op);
875 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000876 case SQLITE_DBCONFIG_LOOKASIDE: {
877 void *pBuf = va_arg(ap, void*);
drh633e6d52008-07-28 19:34:53 +0000878 int sz = va_arg(ap, int);
879 int cnt = va_arg(ap, int);
drhe9d1c722008-08-04 20:13:26 +0000880 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000881 break;
882 }
drh6480aad2008-08-01 16:31:14 +0000883 default: {
884 rc = SQLITE_ERROR;
885 break;
886 }
drh633e6d52008-07-28 19:34:53 +0000887 }
888 va_end(ap);
889 return rc;
890}
891
drha16313e2007-03-30 11:29:32 +0000892
893/*
drh9b5adfa2008-01-20 23:19:56 +0000894** Return true if the buffer z[0..n-1] contains all spaces.
895*/
896static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000897 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000898 return n==0;
899}
900
901/*
drhd3d39e92004-05-20 22:16:29 +0000902** This is the default collating function named "BINARY" which is always
903** available.
drh9b5adfa2008-01-20 23:19:56 +0000904**
905** If the padFlag argument is not NULL then space padding at the end
906** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000907*/
danielk19772c336542005-01-13 02:14:23 +0000908static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000909 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000910 int nKey1, const void *pKey1,
911 int nKey2, const void *pKey2
912){
913 int rc, n;
914 n = nKey1<nKey2 ? nKey1 : nKey2;
915 rc = memcmp(pKey1, pKey2, n);
916 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000917 if( padFlag
918 && allSpaces(((char*)pKey1)+n, nKey1-n)
919 && allSpaces(((char*)pKey2)+n, nKey2-n)
920 ){
921 /* Leave rc unchanged at 0 */
922 }else{
923 rc = nKey1 - nKey2;
924 }
drhd3d39e92004-05-20 22:16:29 +0000925 }
926 return rc;
927}
928
929/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000930** Another built-in collating sequence: NOCASE.
931**
932** This collating sequence is intended to be used for "case independant
933** comparison". SQLite's knowledge of upper and lower case equivalents
934** extends only to the 26 characters used in the English language.
935**
936** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000937*/
938static int nocaseCollatingFunc(
939 void *NotUsed,
940 int nKey1, const void *pKey1,
941 int nKey2, const void *pKey2
942){
943 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000944 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000945 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000946 if( 0==r ){
947 r = nKey1-nKey2;
948 }
949 return r;
950}
951
952/*
drhaf9ff332002-01-16 21:00:27 +0000953** Return the ROWID of the most recent insert
954*/
drh9bb575f2004-09-06 17:24:11 +0000955sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000956 return db->lastRowid;
957}
958
959/*
danielk197724b03fd2004-05-10 10:34:34 +0000960** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000961*/
drh9bb575f2004-09-06 17:24:11 +0000962int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000963 return db->nChange;
964}
965
rdcf146a772004-02-25 22:51:06 +0000966/*
danielk1977b28af712004-06-21 06:50:26 +0000967** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000968*/
danielk1977b28af712004-06-21 06:50:26 +0000969int sqlite3_total_changes(sqlite3 *db){
970 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000971}
972
drhc8d30ac2002-04-12 10:08:59 +0000973/*
danielk1977fd7f0452008-12-17 17:30:26 +0000974** Close all open savepoints. This function only manipulates fields of the
975** database handle object, it does not close any savepoints that may be open
976** at the b-tree/pager level.
977*/
978void sqlite3CloseSavepoints(sqlite3 *db){
979 while( db->pSavepoint ){
980 Savepoint *pTmp = db->pSavepoint;
981 db->pSavepoint = pTmp->pNext;
982 sqlite3DbFree(db, pTmp);
983 }
984 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000985 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000986 db->isTransactionSavepoint = 0;
987}
988
989/*
drh50e5dad2001-09-15 00:57:28 +0000990** Close an existing SQLite database
991*/
drh9bb575f2004-09-06 17:24:11 +0000992int sqlite3_close(sqlite3 *db){
drh8e0a2f92002-02-23 23:45:45 +0000993 HashElem *i;
drh001bbcb2003-03-19 03:14:00 +0000994 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000995
996 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000997 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000998 }
drh7e8b8482008-01-23 03:03:05 +0000999 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk1977e35ee192004-06-26 09:50:11 +00001000 return SQLITE_MISUSE;
1001 }
drh605264d2007-08-21 15:13:19 +00001002 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +00001003
drhffc13f62006-07-30 20:50:44 +00001004 sqlite3ResetInternalSchema(db, 0);
danielk1977a04a34f2007-04-16 15:06:25 +00001005
danielk197701256832007-04-18 14:24:32 +00001006 /* If a transaction is open, the ResetInternalSchema() call above
1007 ** will not have called the xDisconnect() method on any virtual
1008 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1009 ** call will do so. We need to do this before the check for active
1010 ** SQL statements below, as the v-table implementation may be storing
1011 ** some prepared statements internally.
1012 */
1013 sqlite3VtabRollback(db);
1014
danielk1977a04a34f2007-04-16 15:06:25 +00001015 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +00001016 if( db->pVdbe ){
1017 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001018 "unable to close due to unfinalised statements");
drh27641702007-08-22 02:56:42 +00001019 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001020 return SQLITE_BUSY;
1021 }
drh7e8b8482008-01-23 03:03:05 +00001022 assert( sqlite3SafetyCheckSickOrOk(db) );
danielk1977e0048402004-06-15 16:51:01 +00001023
danielk197704103022009-02-03 16:51:24 +00001024 for(j=0; j<db->nDb; j++){
1025 Btree *pBt = db->aDb[j].pBt;
1026 if( pBt && sqlite3BtreeIsInBackup(pBt) ){
1027 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001028 "unable to close due to unfinished backup operation");
danielk197704103022009-02-03 16:51:24 +00001029 sqlite3_mutex_leave(db->mutex);
1030 return SQLITE_BUSY;
1031 }
1032 }
1033
danielk1977fd7f0452008-12-17 17:30:26 +00001034 /* Free any outstanding Savepoint structures. */
1035 sqlite3CloseSavepoints(db);
1036
drh001bbcb2003-03-19 03:14:00 +00001037 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001038 struct Db *pDb = &db->aDb[j];
1039 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +00001040 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +00001041 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +00001042 if( j!=1 ){
1043 pDb->pSchema = 0;
1044 }
drh113088e2003-03-20 01:16:58 +00001045 }
drhf57b3392001-10-08 13:22:32 +00001046 }
danielk19774adee202004-05-08 08:23:19 +00001047 sqlite3ResetInternalSchema(db, 0);
danielk1977404ca072009-03-16 13:19:36 +00001048
1049 /* Tell the code in notify.c that the connection no longer holds any
1050 ** locks and does not require any further unlock-notify callbacks.
1051 */
1052 sqlite3ConnectionClosed(db);
1053
drh1c2d8412003-03-31 00:30:47 +00001054 assert( db->nDb<=2 );
1055 assert( db->aDb==db->aDbStatic );
drh70a8ca32008-08-21 18:49:27 +00001056 for(j=0; j<ArraySize(db->aFunc.a); j++){
1057 FuncDef *pNext, *pHash, *p;
1058 for(p=db->aFunc.a[j]; p; p=pHash){
1059 pHash = p->pHash;
1060 while( p ){
1061 pNext = p->pNext;
1062 sqlite3DbFree(db, p);
1063 p = pNext;
1064 }
drh8e0a2f92002-02-23 23:45:45 +00001065 }
1066 }
danielk1977d8123362004-06-12 09:25:12 +00001067 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001068 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001069 /* Invoke any destructors registered for collation sequence user data. */
1070 for(j=0; j<3; j++){
1071 if( pColl[j].xDel ){
1072 pColl[j].xDel(pColl[j].pUser);
1073 }
1074 }
drh633e6d52008-07-28 19:34:53 +00001075 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001076 }
danielk1977d8123362004-06-12 09:25:12 +00001077 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001078#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001079 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1080 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001081 if( pMod->xDestroy ){
1082 pMod->xDestroy(pMod->pAux);
1083 }
drh633e6d52008-07-28 19:34:53 +00001084 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001085 }
drhb9bb7c12006-06-11 23:41:55 +00001086 sqlite3HashClear(&db->aModule);
1087#endif
danielk1977466be562004-06-10 02:16:01 +00001088
danielk19776622cce2004-05-20 11:00:52 +00001089 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +00001090 if( db->pErr ){
1091 sqlite3ValueFree(db->pErr);
1092 }
drhf1952c52006-06-08 15:48:00 +00001093 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +00001094
1095 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001096
1097 /* The temp-database schema is allocated differently from the other schema
1098 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1099 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1100 ** the same sqliteMalloc() as the one that allocates the database
1101 ** structure?
1102 */
drh633e6d52008-07-28 19:34:53 +00001103 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001104 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001105 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001106 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001107 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001108 if( db->lookaside.bMalloced ){
1109 sqlite3_free(db->lookaside.pStart);
1110 }
drh17435752007-08-16 04:30:38 +00001111 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +00001112 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +00001113}
1114
1115/*
drh001bbcb2003-03-19 03:14:00 +00001116** Rollback all database files.
1117*/
drh9bb575f2004-09-06 17:24:11 +00001118void sqlite3RollbackAll(sqlite3 *db){
drh001bbcb2003-03-19 03:14:00 +00001119 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001120 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +00001121 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001122 sqlite3BeginBenignMalloc();
drh001bbcb2003-03-19 03:14:00 +00001123 for(i=0; i<db->nDb; i++){
1124 if( db->aDb[i].pBt ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001125 if( sqlite3BtreeIsInTrans(db->aDb[i].pBt) ){
1126 inTrans = 1;
1127 }
danielk19774adee202004-05-08 08:23:19 +00001128 sqlite3BtreeRollback(db->aDb[i].pBt);
drh001bbcb2003-03-19 03:14:00 +00001129 db->aDb[i].inTrans = 0;
1130 }
1131 }
danielk1977a298e902006-06-22 09:53:48 +00001132 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001133 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001134
danielk197771fd80b2005-12-16 06:54:01 +00001135 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001136 sqlite3ExpirePreparedStatements(db);
danielk197771fd80b2005-12-16 06:54:01 +00001137 sqlite3ResetInternalSchema(db, 0);
1138 }
1139
dan1da40a32009-09-19 17:00:31 +00001140 /* Any deferred constraint violations have now been resolved. */
1141 db->nDeferredCons = 0;
1142
danielk197771fd80b2005-12-16 06:54:01 +00001143 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001144 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001145 db->xRollbackCallback(db->pRollbackArg);
1146 }
drh001bbcb2003-03-19 03:14:00 +00001147}
1148
1149/*
drhc22bd472002-05-10 13:14:07 +00001150** Return a static string that describes the kind of error specified in the
1151** argument.
drh247be432002-05-10 05:44:55 +00001152*/
danielk1977f20b21c2004-05-31 23:56:42 +00001153const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001154 static const char* const aMsg[] = {
1155 /* SQLITE_OK */ "not an error",
1156 /* SQLITE_ERROR */ "SQL logic error or missing database",
1157 /* SQLITE_INTERNAL */ 0,
1158 /* SQLITE_PERM */ "access permission denied",
1159 /* SQLITE_ABORT */ "callback requested query abort",
1160 /* SQLITE_BUSY */ "database is locked",
1161 /* SQLITE_LOCKED */ "database table is locked",
1162 /* SQLITE_NOMEM */ "out of memory",
1163 /* SQLITE_READONLY */ "attempt to write a readonly database",
1164 /* SQLITE_INTERRUPT */ "interrupted",
1165 /* SQLITE_IOERR */ "disk I/O error",
1166 /* SQLITE_CORRUPT */ "database disk image is malformed",
1167 /* SQLITE_NOTFOUND */ 0,
1168 /* SQLITE_FULL */ "database or disk is full",
1169 /* SQLITE_CANTOPEN */ "unable to open database file",
1170 /* SQLITE_PROTOCOL */ 0,
1171 /* SQLITE_EMPTY */ "table contains no data",
1172 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001173 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001174 /* SQLITE_CONSTRAINT */ "constraint failed",
1175 /* SQLITE_MISMATCH */ "datatype mismatch",
1176 /* SQLITE_MISUSE */ "library routine called out of sequence",
1177 /* SQLITE_NOLFS */ "large file support is disabled",
1178 /* SQLITE_AUTH */ "authorization denied",
1179 /* SQLITE_FORMAT */ "auxiliary database format error",
1180 /* SQLITE_RANGE */ "bind or column index out of range",
1181 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1182 };
1183 rc &= 0xff;
drhb2f9efc2009-05-06 19:03:13 +00001184 if( ALWAYS(rc>=0) && rc<(int)(sizeof(aMsg)/sizeof(aMsg[0])) && aMsg[rc]!=0 ){
drh51c7d862009-04-27 18:46:06 +00001185 return aMsg[rc];
1186 }else{
1187 return "unknown error";
drh247be432002-05-10 05:44:55 +00001188 }
drh247be432002-05-10 05:44:55 +00001189}
1190
1191/*
drh2dfbbca2000-07-28 14:32:48 +00001192** This routine implements a busy callback that sleeps and tries
1193** again until a timeout value is reached. The timeout value is
1194** an integer number of milliseconds passed in as the first
1195** argument.
1196*/
drhdaffd0e2001-04-11 14:28:42 +00001197static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001198 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001199 int count /* Number of times table has been busy */
1200){
danielk197729bafea2008-06-26 10:41:19 +00001201#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001202 static const u8 delays[] =
1203 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1204 static const u8 totals[] =
1205 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhd1bec472004-01-15 13:29:31 +00001206# define NDELAY (sizeof(delays)/sizeof(delays[0]))
danielk1977b4b47412007-08-17 15:53:36 +00001207 sqlite3 *db = (sqlite3 *)ptr;
1208 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001209 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001210
drhee570fa2005-04-28 12:06:05 +00001211 assert( count>=0 );
1212 if( count < NDELAY ){
1213 delay = delays[count];
1214 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001215 }else{
1216 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001217 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001218 }
drhd1bec472004-01-15 13:29:31 +00001219 if( prior + delay > timeout ){
1220 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001221 if( delay<=0 ) return 0;
1222 }
danielk19772a6bdf62007-08-20 16:07:00 +00001223 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001224 return 1;
1225#else
drh482ea182007-08-20 11:12:40 +00001226 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001227 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001228 if( (count+1)*1000 > timeout ){
1229 return 0;
1230 }
drh482ea182007-08-20 11:12:40 +00001231 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001232 return 1;
1233#endif
1234}
1235
1236/*
drha4afb652005-07-09 02:16:02 +00001237** Invoke the given busy handler.
1238**
1239** This routine is called when an operation failed with a lock.
1240** If this routine returns non-zero, the lock is retried. If it
1241** returns 0, the operation aborts with an SQLITE_BUSY error.
1242*/
1243int sqlite3InvokeBusyHandler(BusyHandler *p){
1244 int rc;
drh34004ce2008-07-11 16:15:17 +00001245 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001246 rc = p->xFunc(p->pArg, p->nBusy);
1247 if( rc==0 ){
1248 p->nBusy = -1;
1249 }else{
1250 p->nBusy++;
1251 }
1252 return rc;
1253}
1254
1255/*
drh2dfbbca2000-07-28 14:32:48 +00001256** This routine sets the busy callback for an Sqlite database to the
1257** given callback function with the given argument.
1258*/
danielk1977f9d64d22004-06-19 08:18:07 +00001259int sqlite3_busy_handler(
1260 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001261 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001262 void *pArg
1263){
drhe30f4422007-08-21 16:15:55 +00001264 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001265 db->busyHandler.xFunc = xBusy;
1266 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001267 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +00001268 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001269 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001270}
1271
danielk1977348bb5d2003-10-18 09:37:26 +00001272#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1273/*
1274** This routine sets the progress callback for an Sqlite database to the
1275** given callback function with the given argument. The progress callback will
1276** be invoked every nOps opcodes.
1277*/
danielk197724b03fd2004-05-10 10:34:34 +00001278void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001279 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001280 int nOps,
1281 int (*xProgress)(void*),
1282 void *pArg
1283){
drhbd0b1b52008-07-07 19:52:09 +00001284 sqlite3_mutex_enter(db->mutex);
1285 if( nOps>0 ){
1286 db->xProgress = xProgress;
1287 db->nProgressOps = nOps;
1288 db->pProgressArg = pArg;
1289 }else{
1290 db->xProgress = 0;
1291 db->nProgressOps = 0;
1292 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001293 }
drhbd0b1b52008-07-07 19:52:09 +00001294 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001295}
1296#endif
1297
1298
drh2dfbbca2000-07-28 14:32:48 +00001299/*
1300** This routine installs a default busy handler that waits for the
1301** specified number of milliseconds before returning 0.
1302*/
danielk1977f9d64d22004-06-19 08:18:07 +00001303int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +00001304 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001305 db->busyTimeout = ms;
1306 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +00001307 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001308 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001309 }
danielk1977f9d64d22004-06-19 08:18:07 +00001310 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001311}
drh4c504392000-10-16 22:06:40 +00001312
1313/*
1314** Cause any pending operation to stop at its earliest opportunity.
1315*/
drh9bb575f2004-09-06 17:24:11 +00001316void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +00001317 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001318}
drhfa86c412002-02-02 15:01:15 +00001319
drhfa86c412002-02-02 15:01:15 +00001320
1321/*
danielk1977771151b2006-01-17 13:21:40 +00001322** This function is exactly the same as sqlite3_create_function(), except
1323** that it is designed to be called by internal code. The difference is
1324** that if a malloc() fails in sqlite3_create_function(), an error code
1325** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001326*/
danielk1977771151b2006-01-17 13:21:40 +00001327int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001328 sqlite3 *db,
1329 const char *zFunctionName,
1330 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001331 int enc,
danielk197765904932004-05-26 06:18:37 +00001332 void *pUserData,
1333 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1334 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1335 void (*xFinal)(sqlite3_context*)
drh8e0a2f92002-02-23 23:45:45 +00001336){
drh0bce8352002-02-28 00:41:10 +00001337 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001338 int nName;
danielk197765904932004-05-26 06:18:37 +00001339
drhe30f4422007-08-21 16:15:55 +00001340 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001341 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001342 (xFunc && (xFinal || xStep)) ||
1343 (!xFunc && (xFinal && !xStep)) ||
1344 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001345 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001346 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drhdff6c172009-05-07 13:43:49 +00001347 return SQLITE_MISUSE;
danielk197765904932004-05-26 06:18:37 +00001348 }
danielk1977d8123362004-06-12 09:25:12 +00001349
danielk197793758c82005-01-21 08:13:14 +00001350#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001351 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1352 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1353 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1354 **
1355 ** If SQLITE_ANY is specified, add three versions of the function
1356 ** to the hash table.
1357 */
1358 if( enc==SQLITE_UTF16 ){
1359 enc = SQLITE_UTF16NATIVE;
1360 }else if( enc==SQLITE_ANY ){
1361 int rc;
danielk1977771151b2006-01-17 13:21:40 +00001362 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
danielk1977f9d64d22004-06-19 08:18:07 +00001363 pUserData, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +00001364 if( rc==SQLITE_OK ){
1365 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
1366 pUserData, xFunc, xStep, xFinal);
1367 }
1368 if( rc!=SQLITE_OK ){
1369 return rc;
1370 }
danielk1977d8123362004-06-12 09:25:12 +00001371 enc = SQLITE_UTF16BE;
1372 }
danielk197793758c82005-01-21 08:13:14 +00001373#else
1374 enc = SQLITE_UTF8;
1375#endif
danielk19779636c4e2005-01-25 04:27:54 +00001376
1377 /* Check if an existing function is being overridden or deleted. If so,
1378 ** and there are active VMs, then return SQLITE_BUSY. If a function
1379 ** is being overridden/deleted but there are no active VMs, allow the
1380 ** operation to continue but invalidate all precompiled statements.
1381 */
drh3abbd392008-12-10 23:04:13 +00001382 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001383 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
1384 if( db->activeVdbeCnt ){
1385 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001386 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001387 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001388 return SQLITE_BUSY;
1389 }else{
1390 sqlite3ExpirePreparedStatements(db);
1391 }
1392 }
danielk197765904932004-05-26 06:18:37 +00001393
drh3abbd392008-12-10 23:04:13 +00001394 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001395 assert(p || db->mallocFailed);
1396 if( !p ){
1397 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001398 }
danielk1977fa18bec2007-09-03 11:04:22 +00001399 p->flags = 0;
1400 p->xFunc = xFunc;
1401 p->xStep = xStep;
1402 p->xFinalize = xFinal;
1403 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001404 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001405 return SQLITE_OK;
1406}
danielk1977771151b2006-01-17 13:21:40 +00001407
1408/*
1409** Create new user functions.
1410*/
1411int sqlite3_create_function(
1412 sqlite3 *db,
1413 const char *zFunctionName,
1414 int nArg,
1415 int enc,
1416 void *p,
1417 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1418 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1419 void (*xFinal)(sqlite3_context*)
1420){
1421 int rc;
drhe30f4422007-08-21 16:15:55 +00001422 sqlite3_mutex_enter(db->mutex);
danielk1977771151b2006-01-17 13:21:40 +00001423 rc = sqlite3CreateFunc(db, zFunctionName, nArg, enc, p, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +00001424 rc = sqlite3ApiExit(db, rc);
1425 sqlite3_mutex_leave(db->mutex);
1426 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001427}
1428
danielk197793758c82005-01-21 08:13:14 +00001429#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001430int sqlite3_create_function16(
1431 sqlite3 *db,
1432 const void *zFunctionName,
1433 int nArg,
1434 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001435 void *p,
danielk197765904932004-05-26 06:18:37 +00001436 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1437 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1438 void (*xFinal)(sqlite3_context*)
1439){
1440 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001441 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +00001442 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001443 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00001444 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1);
danielk1977771151b2006-01-17 13:21:40 +00001445 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal);
drh633e6d52008-07-28 19:34:53 +00001446 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001447 rc = sqlite3ApiExit(db, rc);
1448 sqlite3_mutex_leave(db->mutex);
1449 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001450}
danielk197793758c82005-01-21 08:13:14 +00001451#endif
drhc9b84a12002-06-20 11:36:48 +00001452
drhb7481e72006-09-16 21:45:14 +00001453
1454/*
1455** Declare that a function has been overloaded by a virtual table.
1456**
1457** If the function already exists as a regular global function, then
1458** this routine is a no-op. If the function does not exist, then create
1459** a new one that always throws a run-time error.
1460**
1461** When virtual tables intend to provide an overloaded function, they
1462** should call this routine to make sure the global function exists.
1463** A global function must exist in order for name resolution to work
1464** properly.
1465*/
1466int sqlite3_overload_function(
1467 sqlite3 *db,
1468 const char *zName,
1469 int nArg
1470){
drhdee0e402009-05-03 20:23:53 +00001471 int nName = sqlite3Strlen30(zName);
drhe30f4422007-08-21 16:15:55 +00001472 int rc;
1473 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001474 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
1475 sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1476 0, sqlite3InvalidFunction, 0, 0);
1477 }
drhe30f4422007-08-21 16:15:55 +00001478 rc = sqlite3ApiExit(db, SQLITE_OK);
1479 sqlite3_mutex_leave(db->mutex);
1480 return rc;
drhb7481e72006-09-16 21:45:14 +00001481}
1482
drh19e2d372005-08-29 23:00:03 +00001483#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001484/*
drh18de4822003-01-16 16:28:53 +00001485** Register a trace function. The pArg from the previously registered trace
1486** is returned.
1487**
1488** A NULL trace function means that no tracing is executes. A non-NULL
1489** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001490** SQL statement.
drh18de4822003-01-16 16:28:53 +00001491*/
drh9bb575f2004-09-06 17:24:11 +00001492void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001493 void *pOld;
1494 sqlite3_mutex_enter(db->mutex);
1495 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001496 db->xTrace = xTrace;
1497 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001498 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001499 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001500}
drh19e2d372005-08-29 23:00:03 +00001501/*
1502** Register a profile function. The pArg from the previously registered
1503** profile function is returned.
1504**
1505** A NULL profile function means that no profiling is executes. A non-NULL
1506** profile is a pointer to a function that is invoked at the conclusion of
1507** each SQL statement that is run.
1508*/
1509void *sqlite3_profile(
1510 sqlite3 *db,
1511 void (*xProfile)(void*,const char*,sqlite_uint64),
1512 void *pArg
1513){
drhe30f4422007-08-21 16:15:55 +00001514 void *pOld;
1515 sqlite3_mutex_enter(db->mutex);
1516 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001517 db->xProfile = xProfile;
1518 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001519 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001520 return pOld;
1521}
1522#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001523
drhaa940ea2004-01-15 02:44:03 +00001524/*** EXPERIMENTAL ***
1525**
1526** Register a function to be invoked when a transaction comments.
danielk197771fd80b2005-12-16 06:54:01 +00001527** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001528** rollback.
1529*/
danielk197724b03fd2004-05-10 10:34:34 +00001530void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001531 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001532 int (*xCallback)(void*), /* Function to invoke on each commit */
1533 void *pArg /* Argument to the function */
1534){
drhe30f4422007-08-21 16:15:55 +00001535 void *pOld;
1536 sqlite3_mutex_enter(db->mutex);
1537 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001538 db->xCommitCallback = xCallback;
1539 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001540 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001541 return pOld;
1542}
1543
danielk197794eb6a12005-12-15 15:22:08 +00001544/*
1545** Register a callback to be invoked each time a row is updated,
1546** inserted or deleted using this database connection.
1547*/
danielk197771fd80b2005-12-16 06:54:01 +00001548void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001549 sqlite3 *db, /* Attach the hook to this database */
1550 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1551 void *pArg /* Argument to the function */
1552){
drhe30f4422007-08-21 16:15:55 +00001553 void *pRet;
1554 sqlite3_mutex_enter(db->mutex);
1555 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001556 db->xUpdateCallback = xCallback;
1557 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001558 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001559 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001560}
1561
danielk197771fd80b2005-12-16 06:54:01 +00001562/*
1563** Register a callback to be invoked each time a transaction is rolled
1564** back by this database connection.
1565*/
1566void *sqlite3_rollback_hook(
1567 sqlite3 *db, /* Attach the hook to this database */
1568 void (*xCallback)(void*), /* Callback function */
1569 void *pArg /* Argument to the function */
1570){
drhe30f4422007-08-21 16:15:55 +00001571 void *pRet;
1572 sqlite3_mutex_enter(db->mutex);
1573 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001574 db->xRollbackCallback = xCallback;
1575 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001576 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001577 return pRet;
1578}
drhaa940ea2004-01-15 02:44:03 +00001579
paulb0208cc2003-04-13 18:26:49 +00001580/*
danielk1977d8293352009-04-30 09:10:37 +00001581** This function returns true if main-memory should be used instead of
1582** a temporary file for transient pager files and statement journals.
1583** The value returned depends on the value of db->temp_store (runtime
1584** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1585** following table describes the relationship between these two values
1586** and this functions return value.
1587**
1588** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1589** ----------------- -------------- ------------------------------
1590** 0 any file (return 0)
1591** 1 1 file (return 0)
1592** 1 2 memory (return 1)
1593** 1 0 file (return 0)
1594** 2 1 file (return 0)
1595** 2 2 memory (return 1)
1596** 2 0 memory (return 1)
1597** 3 any memory (return 1)
1598*/
drh1c514142009-04-30 12:25:10 +00001599int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001600#if SQLITE_TEMP_STORE==1
1601 return ( db->temp_store==2 );
1602#endif
1603#if SQLITE_TEMP_STORE==2
1604 return ( db->temp_store!=1 );
1605#endif
1606#if SQLITE_TEMP_STORE==3
1607 return 1;
shanecf697392009-06-01 16:53:09 +00001608#endif
1609#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001610 return 0;
shane60a4b532009-05-06 18:57:09 +00001611#endif
danielk1977d8293352009-04-30 09:10:37 +00001612}
1613
1614/*
drh13bff812003-04-15 01:19:47 +00001615** This routine is called to create a connection to a database BTree
1616** driver. If zFilename is the name of a file, then that file is
1617** opened and used. If zFilename is the magic name ":memory:" then
1618** the database is stored in memory (and is thus forgotten as soon as
1619** the connection is closed.) If zFilename is NULL then the database
drh84bfda42005-07-15 13:05:21 +00001620** is a "virtual" database for transient use only and is deleted as
1621** soon as the connection is closed.
drh90f5ecb2004-07-22 01:19:35 +00001622**
drh84bfda42005-07-15 13:05:21 +00001623** A virtual database can be either a disk file (that is automatically
danielk1977d8293352009-04-30 09:10:37 +00001624** deleted when the file is closed) or it an be held entirely in memory.
1625** The sqlite3TempInMemory() function is used to determine which.
paulb0208cc2003-04-13 18:26:49 +00001626*/
danielk19774adee202004-05-08 08:23:19 +00001627int sqlite3BtreeFactory(
drh1860e3f2009-11-04 13:30:01 +00001628 sqlite3 *db, /* Main database when opening aux otherwise 0 */
paulb0208cc2003-04-13 18:26:49 +00001629 const char *zFilename, /* Name of the file containing the BTree database */
1630 int omitJournal, /* if TRUE then do not journal this file */
1631 int nCache, /* How many pages in the page cache */
drh33f4e022007-09-03 15:19:34 +00001632 int vfsFlags, /* Flags passed through to vfsOpen */
danielk19774adee202004-05-08 08:23:19 +00001633 Btree **ppBtree /* Pointer to new Btree object written here */
1634){
drh33f4e022007-09-03 15:19:34 +00001635 int btFlags = 0;
drh90f5ecb2004-07-22 01:19:35 +00001636 int rc;
danielk19774adee202004-05-08 08:23:19 +00001637
drhe30f4422007-08-21 16:15:55 +00001638 assert( sqlite3_mutex_held(db->mutex) );
drheec983e2004-05-08 10:11:36 +00001639 assert( ppBtree != 0);
danielk19774adee202004-05-08 08:23:19 +00001640 if( omitJournal ){
drh33f4e022007-09-03 15:19:34 +00001641 btFlags |= BTREE_OMIT_JOURNAL;
paulb0208cc2003-04-13 18:26:49 +00001642 }
drh7bec5052005-02-06 02:45:41 +00001643 if( db->flags & SQLITE_NoReadlock ){
drh33f4e022007-09-03 15:19:34 +00001644 btFlags |= BTREE_NO_READLOCK;
drh7bec5052005-02-06 02:45:41 +00001645 }
danielk197703aded42004-11-22 05:26:27 +00001646#ifndef SQLITE_OMIT_MEMORYDB
danielk1977d8293352009-04-30 09:10:37 +00001647 if( zFilename==0 && sqlite3TempInMemory(db) ){
drh22ac46d2004-08-14 18:34:54 +00001648 zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001649 }
danielk1977d8293352009-04-30 09:10:37 +00001650#endif
danielk19774adee202004-05-08 08:23:19 +00001651
drh33f4e022007-09-03 15:19:34 +00001652 if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (zFilename==0 || *zFilename==0) ){
1653 vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
1654 }
1655 rc = sqlite3BtreeOpen(zFilename, (sqlite3 *)db, ppBtree, btFlags, vfsFlags);
danielk1977171bfed2008-06-23 09:50:50 +00001656
1657 /* If the B-Tree was successfully opened, set the pager-cache size to the
1658 ** default value. Except, if the call to BtreeOpen() returned a handle
1659 ** open on an existing shared pager-cache, do not change the pager-cache
1660 ** size.
1661 */
1662 if( rc==SQLITE_OK && 0==sqlite3BtreeSchema(*ppBtree, 0, 0) ){
drh90f5ecb2004-07-22 01:19:35 +00001663 sqlite3BtreeSetCacheSize(*ppBtree, nCache);
1664 }
1665 return rc;
paulb0208cc2003-04-13 18:26:49 +00001666}
danielk19774adee202004-05-08 08:23:19 +00001667
danielk19774ad17132004-05-21 01:47:26 +00001668/*
1669** Return UTF-8 encoded English language explanation of the most recent
1670** error.
1671*/
danielk19776622cce2004-05-20 11:00:52 +00001672const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001673 const char *z;
drhf49661a2008-12-10 16:45:50 +00001674 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001675 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001676 }
drhd55d57e2008-07-07 17:53:07 +00001677 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk1977e35ee192004-06-26 09:50:11 +00001678 return sqlite3ErrStr(SQLITE_MISUSE);
1679 }
drh27641702007-08-22 02:56:42 +00001680 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001681 if( db->mallocFailed ){
1682 z = sqlite3ErrStr(SQLITE_NOMEM);
1683 }else{
1684 z = (char*)sqlite3_value_text(db->pErr);
1685 assert( !db->mallocFailed );
1686 if( z==0 ){
1687 z = sqlite3ErrStr(db->errCode);
1688 }
danielk19776622cce2004-05-20 11:00:52 +00001689 }
drhe30f4422007-08-21 16:15:55 +00001690 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001691 return z;
danielk19776622cce2004-05-20 11:00:52 +00001692}
1693
drh6c626082004-11-14 21:56:29 +00001694#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001695/*
1696** Return UTF-16 encoded English language explanation of the most recent
1697** error.
1698*/
danielk19776622cce2004-05-20 11:00:52 +00001699const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00001700 static const u16 outOfMem[] = {
1701 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00001702 };
danielk19777c5c3ca2009-02-23 14:42:53 +00001703 static const u16 misuse[] = {
1704 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
1705 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
1706 'c', 'a', 'l', 'l', 'e', 'd', ' ',
1707 'o', 'u', 't', ' ',
1708 'o', 'f', ' ',
1709 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00001710 };
danielk19774ad17132004-05-21 01:47:26 +00001711
drhc60d0442004-09-30 13:43:13 +00001712 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001713 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001714 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00001715 }
drhd55d57e2008-07-07 17:53:07 +00001716 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001717 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00001718 }
drhe30f4422007-08-21 16:15:55 +00001719 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001720 if( db->mallocFailed ){
1721 z = (void *)outOfMem;
1722 }else{
drhc60d0442004-09-30 13:43:13 +00001723 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00001724 if( z==0 ){
1725 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
1726 SQLITE_UTF8, SQLITE_STATIC);
1727 z = sqlite3_value_text16(db->pErr);
1728 }
1729 /* A malloc() may have failed within the call to sqlite3_value_text16()
1730 ** above. If this is the case, then the db->mallocFailed flag needs to
1731 ** be cleared before returning. Do this directly, instead of via
1732 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1733 */
1734 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00001735 }
drhe30f4422007-08-21 16:15:55 +00001736 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001737 return z;
danielk19776622cce2004-05-20 11:00:52 +00001738}
drh6c626082004-11-14 21:56:29 +00001739#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001740
drhc60d0442004-09-30 13:43:13 +00001741/*
danielk19777ddad962005-12-12 06:53:03 +00001742** Return the most recent error code generated by an SQLite routine. If NULL is
1743** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001744*/
danielk19776622cce2004-05-20 11:00:52 +00001745int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001746 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drhc60d0442004-09-30 13:43:13 +00001747 return SQLITE_MISUSE;
1748 }
drh01495b92008-01-23 12:52:40 +00001749 if( !db || db->mallocFailed ){
1750 return SQLITE_NOMEM;
1751 }
drh4ac285a2006-09-15 07:28:50 +00001752 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001753}
drh99dfe5e2008-10-30 15:03:15 +00001754int sqlite3_extended_errcode(sqlite3 *db){
1755 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
1756 return SQLITE_MISUSE;
1757 }
1758 if( !db || db->mallocFailed ){
1759 return SQLITE_NOMEM;
1760 }
1761 return db->errCode;
1762}
danielk19776622cce2004-05-20 11:00:52 +00001763
drh0e819f92006-02-01 13:50:41 +00001764/*
1765** Create a new collating function for database "db". The name is zName
1766** and the encoding is enc.
1767*/
danielk19779a30cf62006-01-18 04:26:07 +00001768static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00001769 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00001770 const char *zName,
shanecea72b22009-09-07 04:38:36 +00001771 u8 enc,
1772 u8 collType,
danielk19779a30cf62006-01-18 04:26:07 +00001773 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001774 int(*xCompare)(void*,int,const void*,int,const void*),
1775 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001776){
1777 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001778 int enc2;
drhc4a64fa2009-05-11 20:53:28 +00001779 int nName = sqlite3Strlen30(zName);
danielk19779a30cf62006-01-18 04:26:07 +00001780
drhe30f4422007-08-21 16:15:55 +00001781 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001782
1783 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1784 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1785 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1786 */
drh51c7d862009-04-27 18:46:06 +00001787 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00001788 testcase( enc2==SQLITE_UTF16 );
1789 testcase( enc2==SQLITE_UTF16_ALIGNED );
1790 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00001791 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001792 }
drh51c7d862009-04-27 18:46:06 +00001793 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drhd55d57e2008-07-07 17:53:07 +00001794 return SQLITE_MISUSE;
danielk19779a30cf62006-01-18 04:26:07 +00001795 }
1796
1797 /* Check if this call is removing or replacing an existing collation
1798 ** sequence. If so, and there are active VMs, return busy. If there
1799 ** are no active VMs, invalidate any pre-compiled statements.
1800 */
drhc4a64fa2009-05-11 20:53:28 +00001801 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001802 if( pColl && pColl->xCmp ){
1803 if( db->activeVdbeCnt ){
1804 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001805 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00001806 return SQLITE_BUSY;
1807 }
1808 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001809
1810 /* If collation sequence pColl was created directly by a call to
1811 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1812 ** then any copies made by synthCollSeq() need to be invalidated.
1813 ** Also, collation destructor - CollSeq.xDel() - function may need
1814 ** to be called.
1815 */
1816 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001817 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001818 int j;
1819 for(j=0; j<3; j++){
1820 CollSeq *p = &aColl[j];
1821 if( p->enc==pColl->enc ){
1822 if( p->xDel ){
1823 p->xDel(p->pUser);
1824 }
1825 p->xCmp = 0;
1826 }
1827 }
1828 }
danielk19779a30cf62006-01-18 04:26:07 +00001829 }
1830
drhc4a64fa2009-05-11 20:53:28 +00001831 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
danielk19779a30cf62006-01-18 04:26:07 +00001832 if( pColl ){
1833 pColl->xCmp = xCompare;
1834 pColl->pUser = pCtx;
danielk1977a9808b32007-05-07 09:32:45 +00001835 pColl->xDel = xDel;
drh1bd10f82008-12-10 21:19:56 +00001836 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drhf8d4e8b2009-08-20 02:49:30 +00001837 pColl->type = collType;
danielk19779a30cf62006-01-18 04:26:07 +00001838 }
1839 sqlite3Error(db, SQLITE_OK, 0);
1840 return SQLITE_OK;
1841}
1842
1843
danielk19776622cce2004-05-20 11:00:52 +00001844/*
drhbb4957f2008-03-20 14:03:29 +00001845** This array defines hard upper bounds on limit values. The
1846** initializer must be kept in sync with the SQLITE_LIMIT_*
1847** #defines in sqlite3.h.
1848*/
drhb1a6c3c2008-03-20 16:30:17 +00001849static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00001850 SQLITE_MAX_LENGTH,
1851 SQLITE_MAX_SQL_LENGTH,
1852 SQLITE_MAX_COLUMN,
1853 SQLITE_MAX_EXPR_DEPTH,
1854 SQLITE_MAX_COMPOUND_SELECT,
1855 SQLITE_MAX_VDBE_OP,
1856 SQLITE_MAX_FUNCTION_ARG,
1857 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00001858 SQLITE_MAX_LIKE_PATTERN_LENGTH,
1859 SQLITE_MAX_VARIABLE_NUMBER,
drh417168a2009-09-07 18:14:02 +00001860 SQLITE_MAX_TRIGGER_DEPTH,
drhbb4957f2008-03-20 14:03:29 +00001861};
1862
1863/*
1864** Make sure the hard limits are set to reasonable values
1865*/
1866#if SQLITE_MAX_LENGTH<100
1867# error SQLITE_MAX_LENGTH must be at least 100
1868#endif
1869#if SQLITE_MAX_SQL_LENGTH<100
1870# error SQLITE_MAX_SQL_LENGTH must be at least 100
1871#endif
1872#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
1873# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
1874#endif
drhbb4957f2008-03-20 14:03:29 +00001875#if SQLITE_MAX_COMPOUND_SELECT<2
1876# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
1877#endif
1878#if SQLITE_MAX_VDBE_OP<40
1879# error SQLITE_MAX_VDBE_OP must be at least 40
1880#endif
drhe82f5d02008-10-07 19:53:14 +00001881#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
1882# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00001883#endif
danielk19777b7e23b2008-08-20 16:21:12 +00001884#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>30
1885# error SQLITE_MAX_ATTACHED must be between 0 and 30
drhbb4957f2008-03-20 14:03:29 +00001886#endif
drhbb4957f2008-03-20 14:03:29 +00001887#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
1888# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
1889#endif
drh70a8ca32008-08-21 18:49:27 +00001890#if SQLITE_MAX_COLUMN>32767
1891# error SQLITE_MAX_COLUMN must not exceed 32767
1892#endif
drh417168a2009-09-07 18:14:02 +00001893#if SQLITE_MAX_TRIGGER_DEPTH<1
1894# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
1895#endif
drhbb4957f2008-03-20 14:03:29 +00001896
1897
1898/*
1899** Change the value of a limit. Report the old value.
1900** If an invalid limit index is supplied, report -1.
1901** Make no changes but still report the old value if the
1902** new limit is negative.
1903**
1904** A new lower limit does not shrink existing constructs.
1905** It merely prevents new constructs that exceed the limit
1906** from forming.
1907*/
1908int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
1909 int oldLimit;
drh521cc842008-04-15 02:36:33 +00001910 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00001911 return -1;
1912 }
1913 oldLimit = db->aLimit[limitId];
1914 if( newLimit>=0 ){
drhf47ce562008-03-20 18:00:49 +00001915 if( newLimit>aHardLimit[limitId] ){
drhbb4957f2008-03-20 14:03:29 +00001916 newLimit = aHardLimit[limitId];
1917 }
1918 db->aLimit[limitId] = newLimit;
1919 }
1920 return oldLimit;
1921}
1922
1923/*
danielk19774ad17132004-05-21 01:47:26 +00001924** This routine does the work of opening a database on behalf of
1925** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00001926** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00001927*/
1928static int openDatabase(
1929 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00001930 sqlite3 **ppDb, /* OUT: Returned database handle */
1931 unsigned flags, /* Operational flags */
1932 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00001933){
1934 sqlite3 *db;
danielk1977da184232006-01-05 11:34:32 +00001935 int rc;
drh039963a2008-09-03 00:43:15 +00001936 int isThreadsafe;
danielk19774ad17132004-05-21 01:47:26 +00001937
drhe0d0f8e2009-04-28 04:47:31 +00001938 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00001939#ifndef SQLITE_OMIT_AUTOINIT
1940 rc = sqlite3_initialize();
1941 if( rc ) return rc;
1942#endif
1943
drh039963a2008-09-03 00:43:15 +00001944 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00001945 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00001946 }else if( flags & SQLITE_OPEN_NOMUTEX ){
1947 isThreadsafe = 0;
1948 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
1949 isThreadsafe = 1;
1950 }else{
1951 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00001952 }
drhf1f12682009-09-09 14:17:52 +00001953 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00001954 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00001955 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
1956 flags |= SQLITE_OPEN_SHAREDCACHE;
1957 }
danielk19779a6284c2008-07-10 17:52:49 +00001958
drhb25a9f42009-05-12 13:35:11 +00001959 /* Remove harmful bits from the flags parameter
1960 **
1961 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
1962 ** dealt with in the previous code block. Besides these, the only
1963 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
1964 ** SQLITE_OPEN_READWRITE, and SQLITE_OPEN_CREATE. Silently mask
1965 ** off all other flags.
1966 */
drha4267dc2008-02-19 15:20:44 +00001967 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00001968 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00001969 SQLITE_OPEN_MAIN_DB |
1970 SQLITE_OPEN_TEMP_DB |
1971 SQLITE_OPEN_TRANSIENT_DB |
1972 SQLITE_OPEN_MAIN_JOURNAL |
1973 SQLITE_OPEN_TEMP_JOURNAL |
1974 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00001975 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00001976 SQLITE_OPEN_NOMUTEX |
1977 SQLITE_OPEN_FULLMUTEX
drha4267dc2008-02-19 15:20:44 +00001978 );
1979
danielk19774ad17132004-05-21 01:47:26 +00001980 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00001981 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00001982 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00001983 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00001984 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
1985 if( db->mutex==0 ){
1986 sqlite3_free(db);
1987 db = 0;
1988 goto opendb_out;
1989 }
drh605264d2007-08-21 15:13:19 +00001990 }
drh27641702007-08-22 02:56:42 +00001991 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001992 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00001993 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00001994 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00001995 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00001996
drhbb4957f2008-03-20 14:03:29 +00001997 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
1998 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00001999 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002000 db->nextAutovac = -1;
danielk1977f653d782008-03-20 11:04:21 +00002001 db->nextPagesize = 0;
drh76fe8032006-07-11 14:17:51 +00002002 db->flags |= SQLITE_ShortColNames
2003#if SQLITE_DEFAULT_FILE_FORMAT<4
2004 | SQLITE_LegacyFileFmt
2005#endif
drh56424db2007-03-27 22:24:11 +00002006#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2007 | SQLITE_LoadExtension
2008#endif
dan5bde73c2009-09-01 17:11:07 +00002009#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002010 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002011#endif
drh76fe8032006-07-11 14:17:51 +00002012 ;
drhe61922a2009-05-02 13:29:37 +00002013 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002014#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002015 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002016#endif
danielk1977da184232006-01-05 11:34:32 +00002017
danielk197795c8a542007-09-01 06:51:27 +00002018 db->pVfs = sqlite3_vfs_find(zVfs);
2019 if( !db->pVfs ){
2020 rc = SQLITE_ERROR;
drhafc91042008-02-21 02:09:45 +00002021 sqlite3Error(db, rc, "no such vfs: %s", zVfs);
danielk197795c8a542007-09-01 06:51:27 +00002022 goto opendb_out;
2023 }
2024
danielk19770202b292004-06-09 09:55:16 +00002025 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2026 ** and UTF-16, so add a version for each to avoid any unnecessary
2027 ** conversions. The only error that can occur here is a malloc() failure.
2028 */
drhf8d4e8b2009-08-20 02:49:30 +00002029 createCollation(db, "BINARY", SQLITE_UTF8, SQLITE_COLL_BINARY, 0,
2030 binCollFunc, 0);
2031 createCollation(db, "BINARY", SQLITE_UTF16BE, SQLITE_COLL_BINARY, 0,
2032 binCollFunc, 0);
2033 createCollation(db, "BINARY", SQLITE_UTF16LE, SQLITE_COLL_BINARY, 0,
2034 binCollFunc, 0);
2035 createCollation(db, "RTRIM", SQLITE_UTF8, SQLITE_COLL_USER, (void*)1,
2036 binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002037 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002038 goto opendb_out;
2039 }
drhc4a64fa2009-05-11 20:53:28 +00002040 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002041 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002042
2043 /* Also add a UTF-8 case-insensitive collation sequence. */
drhf8d4e8b2009-08-20 02:49:30 +00002044 createCollation(db, "NOCASE", SQLITE_UTF8, SQLITE_COLL_NOCASE, 0,
2045 nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002046
danielk19774ad17132004-05-21 01:47:26 +00002047 /* Open the backend database driver */
drh33f4e022007-09-03 15:19:34 +00002048 db->openFlags = flags;
2049 rc = sqlite3BtreeFactory(db, zFilename, 0, SQLITE_DEFAULT_CACHE_SIZE,
2050 flags | SQLITE_OPEN_MAIN_DB,
drhc797d4d2007-05-08 01:08:49 +00002051 &db->aDb[0].pBt);
danielk19774ad17132004-05-21 01:47:26 +00002052 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002053 if( rc==SQLITE_IOERR_NOMEM ){
2054 rc = SQLITE_NOMEM;
2055 }
danielk19774ad17132004-05-21 01:47:26 +00002056 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00002057 goto opendb_out;
2058 }
drh17435752007-08-16 04:30:38 +00002059 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2060 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002061
drh03b808a2006-03-13 15:06:05 +00002062
danielk197753c0f742005-03-29 03:10:59 +00002063 /* The default safety_level for the main database is 'full'; for the temp
2064 ** database it is 'NONE'. This matches the pager layer defaults.
2065 */
2066 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002067 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002068 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002069 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002070
danielk1977832a58a2007-06-22 15:21:15 +00002071 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002072 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002073 goto opendb_out;
2074 }
2075
danielk19778e227872004-06-07 07:52:17 +00002076 /* Register all built-in functions, but do not attempt to read the
2077 ** database schema yet. This is delayed until the first time the database
2078 ** is accessed.
2079 */
danielk1977832a58a2007-06-22 15:21:15 +00002080 sqlite3Error(db, SQLITE_OK, 0);
2081 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002082
drh1409be62006-08-23 20:07:20 +00002083 /* Load automatic extensions - extensions that have been registered
2084 ** using the sqlite3_automatic_extension() API.
2085 */
drh7aaa8782009-05-20 02:40:45 +00002086 sqlite3AutoLoadExtensions(db);
2087 rc = sqlite3_errcode(db);
2088 if( rc!=SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002089 goto opendb_out;
2090 }
drh1409be62006-08-23 20:07:20 +00002091
drhaa29c132006-09-02 13:58:06 +00002092#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002093 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002094 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002095 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002096 }
2097#endif
2098
shessa26cf572006-10-19 20:27:58 +00002099#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002100 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002101 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002102 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002103 }
2104#endif
2105
shess69c4ae22007-08-20 17:37:47 +00002106#ifdef SQLITE_ENABLE_FTS3
2107 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002108 rc = sqlite3Fts3Init(db);
2109 }
2110#endif
2111
danielk197783852ac2007-05-06 16:04:11 +00002112#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002113 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002114 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002115 }
2116#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002117
2118#ifdef SQLITE_ENABLE_RTREE
2119 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002120 rc = sqlite3RtreeInit(db);
2121 }
2122#endif
2123
danielk1977832a58a2007-06-22 15:21:15 +00002124 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00002125
drh8fd5bd32007-04-02 16:40:37 +00002126 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2127 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2128 ** mode. Doing nothing at all also makes NORMAL the default.
2129 */
2130#ifdef SQLITE_DEFAULT_LOCKING_MODE
2131 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2132 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2133 SQLITE_DEFAULT_LOCKING_MODE);
2134#endif
2135
drh633e6d52008-07-28 19:34:53 +00002136 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002137 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2138 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002139
danielk19774ad17132004-05-21 01:47:26 +00002140opendb_out:
drhafc91042008-02-21 02:09:45 +00002141 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002142 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002143 sqlite3_mutex_leave(db->mutex);
2144 }
danielk197759633ae2008-08-27 19:01:57 +00002145 rc = sqlite3_errcode(db);
2146 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002147 sqlite3_close(db);
2148 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002149 }else if( rc!=SQLITE_OK ){
2150 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002151 }
danielk19774ad17132004-05-21 01:47:26 +00002152 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00002153 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002154}
2155
2156/*
2157** Open a new database handle.
2158*/
danielk197780290862004-05-22 09:21:21 +00002159int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002160 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002161 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002162){
drh605264d2007-08-21 15:13:19 +00002163 return openDatabase(zFilename, ppDb,
2164 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2165}
2166int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002167 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002168 sqlite3 **ppDb, /* OUT: SQLite db handle */
2169 int flags, /* Flags */
2170 const char *zVfs /* Name of VFS module to use */
2171){
2172 return openDatabase(filename, ppDb, flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002173}
2174
drh6c626082004-11-14 21:56:29 +00002175#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002176/*
2177** Open a new database handle.
2178*/
2179int sqlite3_open16(
2180 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002181 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002182){
danielk1977bfd6cce2004-06-18 04:24:54 +00002183 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002184 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002185 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002186
danielk19777ddad962005-12-12 06:53:03 +00002187 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00002188 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00002189 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002190#ifndef SQLITE_OMIT_AUTOINIT
2191 rc = sqlite3_initialize();
2192 if( rc ) return rc;
2193#endif
danielk19771e536952007-08-16 10:09:01 +00002194 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002195 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2196 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002197 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002198 rc = openDatabase(zFilename8, ppDb,
2199 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002200 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002201 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002202 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002203 }
drh40257ff2008-06-13 18:24:27 +00002204 }else{
2205 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002206 }
danielk19777ddad962005-12-12 06:53:03 +00002207 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002208
danielk197754f01982006-01-18 15:25:17 +00002209 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002210}
drh6c626082004-11-14 21:56:29 +00002211#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002212
danielk1977106bb232004-05-21 10:08:53 +00002213/*
danielk1977d8123362004-06-12 09:25:12 +00002214** Register a new collation sequence with the database handle db.
2215*/
danielk19770202b292004-06-09 09:55:16 +00002216int sqlite3_create_collation(
2217 sqlite3* db,
2218 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002219 int enc,
danielk19770202b292004-06-09 09:55:16 +00002220 void* pCtx,
2221 int(*xCompare)(void*,int,const void*,int,const void*)
2222){
danielk19779a30cf62006-01-18 04:26:07 +00002223 int rc;
drhe30f4422007-08-21 16:15:55 +00002224 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002225 assert( !db->mallocFailed );
shanecea72b22009-09-07 04:38:36 +00002226 rc = createCollation(db, zName, (u8)enc, SQLITE_COLL_USER, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00002227 rc = sqlite3ApiExit(db, rc);
2228 sqlite3_mutex_leave(db->mutex);
2229 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00002230}
2231
2232/*
2233** Register a new collation sequence with the database handle db.
2234*/
danielk1977a393c032007-05-07 14:58:53 +00002235int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002236 sqlite3* db,
2237 const char *zName,
2238 int enc,
2239 void* pCtx,
2240 int(*xCompare)(void*,int,const void*,int,const void*),
2241 void(*xDel)(void*)
2242){
2243 int rc;
drhe30f4422007-08-21 16:15:55 +00002244 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002245 assert( !db->mallocFailed );
shanecea72b22009-09-07 04:38:36 +00002246 rc = createCollation(db, zName, (u8)enc, SQLITE_COLL_USER, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002247 rc = sqlite3ApiExit(db, rc);
2248 sqlite3_mutex_leave(db->mutex);
2249 return rc;
danielk19770202b292004-06-09 09:55:16 +00002250}
2251
drh6c626082004-11-14 21:56:29 +00002252#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002253/*
2254** Register a new collation sequence with the database handle db.
2255*/
danielk19770202b292004-06-09 09:55:16 +00002256int sqlite3_create_collation16(
2257 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002258 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002259 int enc,
danielk19770202b292004-06-09 09:55:16 +00002260 void* pCtx,
2261 int(*xCompare)(void*,int,const void*,int,const void*)
2262){
danielk19779a30cf62006-01-18 04:26:07 +00002263 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002264 char *zName8;
drhe30f4422007-08-21 16:15:55 +00002265 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002266 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00002267 zName8 = sqlite3Utf16to8(db, zName, -1);
danielk19779a30cf62006-01-18 04:26:07 +00002268 if( zName8 ){
shanecea72b22009-09-07 04:38:36 +00002269 rc = createCollation(db, zName8, (u8)enc, SQLITE_COLL_USER, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002270 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002271 }
drhe30f4422007-08-21 16:15:55 +00002272 rc = sqlite3ApiExit(db, rc);
2273 sqlite3_mutex_leave(db->mutex);
2274 return rc;
danielk19770202b292004-06-09 09:55:16 +00002275}
drh6c626082004-11-14 21:56:29 +00002276#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002277
danielk1977d8123362004-06-12 09:25:12 +00002278/*
2279** Register a collation sequence factory callback with the database handle
2280** db. Replace any previously installed collation sequence factory.
2281*/
danielk19777cedc8d2004-06-10 10:50:08 +00002282int sqlite3_collation_needed(
2283 sqlite3 *db,
2284 void *pCollNeededArg,
2285 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2286){
drhe30f4422007-08-21 16:15:55 +00002287 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002288 db->xCollNeeded = xCollNeeded;
2289 db->xCollNeeded16 = 0;
2290 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002291 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002292 return SQLITE_OK;
2293}
danielk1977d8123362004-06-12 09:25:12 +00002294
drh6c626082004-11-14 21:56:29 +00002295#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002296/*
2297** Register a collation sequence factory callback with the database handle
2298** db. Replace any previously installed collation sequence factory.
2299*/
danielk19777cedc8d2004-06-10 10:50:08 +00002300int sqlite3_collation_needed16(
2301 sqlite3 *db,
2302 void *pCollNeededArg,
2303 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2304){
drhe30f4422007-08-21 16:15:55 +00002305 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002306 db->xCollNeeded = 0;
2307 db->xCollNeeded16 = xCollNeeded16;
2308 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002309 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002310 return SQLITE_OK;
2311}
drh6c626082004-11-14 21:56:29 +00002312#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002313
2314#ifndef SQLITE_OMIT_GLOBALRECOVER
shaneeec556d2008-10-12 00:27:53 +00002315#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002316/*
danielk19777ddad962005-12-12 06:53:03 +00002317** This function is now an anachronism. It used to be used to recover from a
2318** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002319*/
drh7d97efb2007-10-12 19:35:48 +00002320int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002321 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002322}
2323#endif
shaneeec556d2008-10-12 00:27:53 +00002324#endif
drh3e1d8e62005-05-26 16:23:34 +00002325
2326/*
2327** Test to see whether or not the database connection is in autocommit
2328** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2329** by default. Autocommit is disabled by a BEGIN statement and reenabled
2330** by the next COMMIT or ROLLBACK.
2331**
2332******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
2333*/
2334int sqlite3_get_autocommit(sqlite3 *db){
2335 return db->autoCommit;
2336}
drh49285702005-09-17 15:20:26 +00002337
2338#ifdef SQLITE_DEBUG
2339/*
2340** The following routine is subtituted for constant SQLITE_CORRUPT in
2341** debugging builds. This provides a way to set a breakpoint for when
2342** corruption is first detected.
2343*/
2344int sqlite3Corrupt(void){
2345 return SQLITE_CORRUPT;
2346}
2347#endif
drh7c1817e2006-01-10 13:58:48 +00002348
shaneeec556d2008-10-12 00:27:53 +00002349#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00002350/*
2351** This is a convenience routine that makes sure that all thread-specific
2352** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00002353**
2354** SQLite no longer uses thread-specific data so this routine is now a
2355** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00002356*/
2357void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00002358}
shaneeec556d2008-10-12 00:27:53 +00002359#endif
danielk1977deb802c2006-02-09 13:43:28 +00002360
2361/*
2362** Return meta information about a specific column of a database table.
2363** See comment in sqlite3.h (sqlite.h.in) for details.
2364*/
2365#ifdef SQLITE_ENABLE_COLUMN_METADATA
2366int sqlite3_table_column_metadata(
2367 sqlite3 *db, /* Connection handle */
2368 const char *zDbName, /* Database name or NULL */
2369 const char *zTableName, /* Table name */
2370 const char *zColumnName, /* Column name */
2371 char const **pzDataType, /* OUTPUT: Declared data type */
2372 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
2373 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
2374 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00002375 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00002376){
2377 int rc;
2378 char *zErrMsg = 0;
2379 Table *pTab = 0;
2380 Column *pCol = 0;
2381 int iCol;
2382
2383 char const *zDataType = 0;
2384 char const *zCollSeq = 0;
2385 int notnull = 0;
2386 int primarykey = 0;
2387 int autoinc = 0;
2388
2389 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00002390 sqlite3_mutex_enter(db->mutex);
drha0af99f2008-04-16 00:49:12 +00002391 (void)sqlite3SafetyOn(db);
drh3cb3edc2008-03-07 21:37:19 +00002392 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002393 rc = sqlite3Init(db, &zErrMsg);
2394 if( SQLITE_OK!=rc ){
2395 goto error_out;
2396 }
2397
2398 /* Locate the table in question */
2399 pTab = sqlite3FindTable(db, zTableName, zDbName);
2400 if( !pTab || pTab->pSelect ){
2401 pTab = 0;
2402 goto error_out;
2403 }
2404
2405 /* Find the column for which info is requested */
2406 if( sqlite3IsRowid(zColumnName) ){
2407 iCol = pTab->iPKey;
2408 if( iCol>=0 ){
2409 pCol = &pTab->aCol[iCol];
2410 }
2411 }else{
2412 for(iCol=0; iCol<pTab->nCol; iCol++){
2413 pCol = &pTab->aCol[iCol];
2414 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
2415 break;
2416 }
2417 }
2418 if( iCol==pTab->nCol ){
2419 pTab = 0;
2420 goto error_out;
2421 }
2422 }
2423
2424 /* The following block stores the meta information that will be returned
2425 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
2426 ** and autoinc. At this point there are two possibilities:
2427 **
2428 ** 1. The specified column name was rowid", "oid" or "_rowid_"
2429 ** and there is no explicitly declared IPK column.
2430 **
2431 ** 2. The table is not a view and the column name identified an
2432 ** explicitly declared column. Copy meta information from *pCol.
2433 */
2434 if( pCol ){
2435 zDataType = pCol->zType;
2436 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00002437 notnull = pCol->notNull!=0;
2438 primarykey = pCol->isPrimKey!=0;
drh7d10d5a2008-08-20 16:35:10 +00002439 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00002440 }else{
2441 zDataType = "INTEGER";
2442 primarykey = 1;
2443 }
2444 if( !zCollSeq ){
2445 zCollSeq = "BINARY";
2446 }
2447
2448error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00002449 sqlite3BtreeLeaveAll(db);
drh01495b92008-01-23 12:52:40 +00002450 (void)sqlite3SafetyOff(db);
danielk1977deb802c2006-02-09 13:43:28 +00002451
2452 /* Whether the function call succeeded or failed, set the output parameters
2453 ** to whatever their local counterparts contain. If an error did occur,
2454 ** this has the effect of zeroing all output parameters.
2455 */
2456 if( pzDataType ) *pzDataType = zDataType;
2457 if( pzCollSeq ) *pzCollSeq = zCollSeq;
2458 if( pNotNull ) *pNotNull = notnull;
2459 if( pPrimaryKey ) *pPrimaryKey = primarykey;
2460 if( pAutoinc ) *pAutoinc = autoinc;
2461
2462 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00002463 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00002464 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00002465 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00002466 rc = SQLITE_ERROR;
2467 }
2468 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002469 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00002470 rc = sqlite3ApiExit(db, rc);
2471 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00002472 return rc;
2473}
drhe30f4422007-08-21 16:15:55 +00002474#endif
drhf9cb7f52006-06-27 20:06:44 +00002475
2476/*
2477** Sleep for a little while. Return the amount of time slept.
2478*/
2479int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00002480 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00002481 int rc;
drhd677b3d2007-08-20 22:48:41 +00002482 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00002483 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00002484
2485 /* This function works in milliseconds, but the underlying OsSleep()
2486 ** API uses microseconds. Hence the 1000's.
2487 */
drhe30f4422007-08-21 16:15:55 +00002488 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00002489 return rc;
drhf9cb7f52006-06-27 20:06:44 +00002490}
drh4ac285a2006-09-15 07:28:50 +00002491
2492/*
2493** Enable or disable the extended result codes.
2494*/
2495int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00002496 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002497 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00002498 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002499 return SQLITE_OK;
2500}
drhcc6bb3e2007-08-31 16:11:35 +00002501
2502/*
2503** Invoke the xFileControl method on a particular database.
2504*/
2505int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
2506 int rc = SQLITE_ERROR;
2507 int iDb;
2508 sqlite3_mutex_enter(db->mutex);
2509 if( zDbName==0 ){
2510 iDb = 0;
2511 }else{
2512 for(iDb=0; iDb<db->nDb; iDb++){
2513 if( strcmp(db->aDb[iDb].zName, zDbName)==0 ) break;
2514 }
2515 }
2516 if( iDb<db->nDb ){
2517 Btree *pBtree = db->aDb[iDb].pBt;
2518 if( pBtree ){
2519 Pager *pPager;
drh55176252008-01-22 14:50:16 +00002520 sqlite3_file *fd;
drhcc6bb3e2007-08-31 16:11:35 +00002521 sqlite3BtreeEnter(pBtree);
2522 pPager = sqlite3BtreePager(pBtree);
drh55176252008-01-22 14:50:16 +00002523 assert( pPager!=0 );
2524 fd = sqlite3PagerFile(pPager);
2525 assert( fd!=0 );
2526 if( fd->pMethods ){
2527 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00002528 }
2529 sqlite3BtreeLeave(pBtree);
2530 }
2531 }
2532 sqlite3_mutex_leave(db->mutex);
2533 return rc;
2534}
drhed13d982008-01-31 14:43:24 +00002535
2536/*
2537** Interface to the testing logic.
2538*/
2539int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00002540 int rc = 0;
drh3088d592008-03-21 16:45:47 +00002541#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00002542 va_list ap;
drhed13d982008-01-31 14:43:24 +00002543 va_start(ap, op);
2544 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00002545
2546 /*
drh984bfaa2008-03-19 16:08:53 +00002547 ** Save the current state of the PRNG.
2548 */
drh2fa18682008-03-19 14:15:34 +00002549 case SQLITE_TESTCTRL_PRNG_SAVE: {
2550 sqlite3PrngSaveState();
2551 break;
2552 }
drh984bfaa2008-03-19 16:08:53 +00002553
2554 /*
2555 ** Restore the state of the PRNG to the last state saved using
2556 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
2557 ** this verb acts like PRNG_RESET.
2558 */
drh2fa18682008-03-19 14:15:34 +00002559 case SQLITE_TESTCTRL_PRNG_RESTORE: {
2560 sqlite3PrngRestoreState();
2561 break;
2562 }
drh984bfaa2008-03-19 16:08:53 +00002563
2564 /*
2565 ** Reset the PRNG back to its uninitialized state. The next call
2566 ** to sqlite3_randomness() will reseed the PRNG using a single call
2567 ** to the xRandomness method of the default VFS.
2568 */
drh2fa18682008-03-19 14:15:34 +00002569 case SQLITE_TESTCTRL_PRNG_RESET: {
2570 sqlite3PrngResetState();
2571 break;
2572 }
drh3088d592008-03-21 16:45:47 +00002573
2574 /*
2575 ** sqlite3_test_control(BITVEC_TEST, size, program)
2576 **
2577 ** Run a test against a Bitvec object of size. The program argument
2578 ** is an array of integers that defines the test. Return -1 on a
2579 ** memory allocation error, 0 on success, or non-zero for an error.
2580 ** See the sqlite3BitvecBuiltinTest() for additional information.
2581 */
2582 case SQLITE_TESTCTRL_BITVEC_TEST: {
2583 int sz = va_arg(ap, int);
2584 int *aProg = va_arg(ap, int*);
2585 rc = sqlite3BitvecBuiltinTest(sz, aProg);
2586 break;
2587 }
danielk19772d1d86f2008-06-20 14:59:51 +00002588
2589 /*
2590 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
2591 **
2592 ** Register hooks to call to indicate which malloc() failures
2593 ** are benign.
2594 */
2595 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00002596 typedef void (*void_function)(void);
2597 void_function xBenignBegin;
2598 void_function xBenignEnd;
2599 xBenignBegin = va_arg(ap, void_function);
2600 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00002601 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
2602 break;
2603 }
drhc7a3bb92009-02-05 16:31:45 +00002604
2605 /*
drhf3af63f2009-05-09 18:59:42 +00002606 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00002607 **
2608 ** Set the PENDING byte to the value in the argument, if X>0.
2609 ** Make no changes if X==0. Return the value of the pending byte
2610 ** as it existing before this routine was called.
2611 **
2612 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
2613 ** an incompatible database file format. Changing the PENDING byte
2614 ** while any database connection is open results in undefined and
2615 ** dileterious behavior.
2616 */
2617 case SQLITE_TESTCTRL_PENDING_BYTE: {
2618 unsigned int newVal = va_arg(ap, unsigned int);
2619 rc = sqlite3PendingByte;
2620 if( newVal ) sqlite3PendingByte = newVal;
2621 break;
2622 }
drhf3af63f2009-05-09 18:59:42 +00002623
2624 /*
2625 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
2626 **
2627 ** This action provides a run-time test to see whether or not
2628 ** assert() was enabled at compile-time. If X is true and assert()
2629 ** is enabled, then the return value is true. If X is true and
2630 ** assert() is disabled, then the return value is zero. If X is
2631 ** false and assert() is enabled, then the assertion fires and the
2632 ** process aborts. If X is false and assert() is disabled, then the
2633 ** return value is zero.
2634 */
2635 case SQLITE_TESTCTRL_ASSERT: {
2636 volatile int x = 0;
2637 assert( (x = va_arg(ap,int))!=0 );
2638 rc = x;
2639 break;
2640 }
2641
2642
2643 /*
2644 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
2645 **
2646 ** This action provides a run-time test to see how the ALWAYS and
2647 ** NEVER macros were defined at compile-time.
2648 **
2649 ** The return value is ALWAYS(X).
2650 **
2651 ** The recommended test is X==2. If the return value is 2, that means
2652 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
2653 ** default setting. If the return value is 1, then ALWAYS() is either
2654 ** hard-coded to true or else it asserts if its argument is false.
2655 ** The first behavior (hard-coded to true) is the case if
2656 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
2657 ** behavior (assert if the argument to ALWAYS() is false) is the case if
2658 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
2659 **
2660 ** The run-time test procedure might look something like this:
2661 **
2662 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
2663 ** // ALWAYS() and NEVER() are no-op pass-through macros
2664 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
2665 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
2666 ** }else{
2667 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
2668 ** }
2669 */
2670 case SQLITE_TESTCTRL_ALWAYS: {
2671 int x = va_arg(ap,int);
2672 rc = ALWAYS(x);
2673 break;
2674 }
drhc046e3e2009-07-15 11:26:44 +00002675
2676 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
2677 **
2678 ** Set the nReserve size to N for the main database on the database
2679 ** connection db.
2680 */
2681 case SQLITE_TESTCTRL_RESERVE: {
2682 sqlite3 *db = va_arg(ap, sqlite3*);
2683 int x = va_arg(ap,int);
2684 sqlite3_mutex_enter(db->mutex);
2685 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
2686 sqlite3_mutex_leave(db->mutex);
2687 break;
2688 }
2689
drh07096f62009-12-22 23:52:32 +00002690 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
2691 **
2692 ** Enable or disable various optimizations for testing purposes. The
2693 ** argument N is a bitmask of optimizations to be disabled. For normal
2694 ** operation N should be 0. The idea is that a test program (like the
2695 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
2696 ** with various optimizations disabled to verify that the same answer
2697 ** is obtained in every case.
2698 */
2699 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
2700 sqlite3 *db = va_arg(ap, sqlite3*);
2701 int x = va_arg(ap,int);
2702 db->flags = (x & SQLITE_OptMask) | (db->flags & ~SQLITE_OptMask);
2703 break;
2704 }
2705
drh0e857732010-01-02 03:21:35 +00002706#ifdef SQLITE_N_KEYWORD
2707 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
2708 **
2709 ** If zWord is a keyword recognized by the parser, then return the
2710 ** number of keywords. Or if zWord is not a keyword, return 0.
2711 **
2712 ** This test feature is only available in the amalgamation since
2713 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
2714 ** is built using separate source files.
2715 */
2716 case SQLITE_TESTCTRL_ISKEYWORD: {
2717 const char *zWord = va_arg(ap, const char*);
2718 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00002719 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00002720 break;
2721 }
2722#endif
2723
drhed13d982008-01-31 14:43:24 +00002724 }
2725 va_end(ap);
drh3088d592008-03-21 16:45:47 +00002726#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00002727 return rc;
drhed13d982008-01-31 14:43:24 +00002728}