blob: 4697009666bb9cace33aa190856ae8b8794fb767 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Main file for the SQLite library. The routines in this file
13** implement the programmer interface to the library. Routines in
14** other files are for internal use by SQLite and should not be
15** accessed by users of the library.
drh75897232000-05-29 14:26:00 +000016*/
17#include "sqliteInt.h"
drh58f1c8b2008-05-26 20:19:25 +000018
drh820a9062008-01-31 13:35:48 +000019#ifdef SQLITE_ENABLE_FTS3
20# include "fts3.h"
21#endif
drh58f1c8b2008-05-26 20:19:25 +000022#ifdef SQLITE_ENABLE_RTREE
23# include "rtree.h"
24#endif
danielk19771c826652008-09-08 08:08:09 +000025#ifdef SQLITE_ENABLE_ICU
26# include "sqliteicu.h"
27#endif
drh75897232000-05-29 14:26:00 +000028
drhb3190c12008-12-08 21:37:14 +000029#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000030/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
31** contains the text of SQLITE_VERSION macro.
32*/
danielk197724b03fd2004-05-10 10:34:34 +000033const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000034#endif
drh9f129f42010-08-31 15:27:32 +000035
36/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
37** a pointer to the to the sqlite3_version[] string constant.
38*/
drh4aec8b62004-08-28 16:19:00 +000039const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000040
41/* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
42** pointer to a string constant whose value is the same as the
43** SQLITE_SOURCE_ID C preprocessor macro.
44*/
drh47baebc2009-08-14 16:01:24 +000045const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000046
47/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
48** returns an integer equal to SQLITE_VERSION_NUMBER.
49*/
danielk197799ba19e2005-02-05 07:33:34 +000050int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000051
drh5dc2bcd2012-01-02 15:45:12 +000052/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000053** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000054** the SQLITE_THREADSAFE compile-time option being set to 0.
55*/
drhb67e8bf2007-08-30 20:09:48 +000056int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000057
drhe265b082008-05-01 17:03:49 +000058#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000059/*
drhb0603412007-02-28 04:47:26 +000060** If the following function pointer is not NULL and if
61** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
62** I/O active are written using this function. These messages
63** are intended for debugging activity only.
64*/
mlcreech3a00f902008-03-04 17:45:01 +000065void (*sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000066#endif
drhb0603412007-02-28 04:47:26 +000067
68/*
drha16313e2007-03-30 11:29:32 +000069** If the following global variable points to a string which is the
70** name of a directory, then that directory will be used to store
71** temporary files.
72**
73** See also the "PRAGMA temp_store_directory" SQL command.
74*/
75char *sqlite3_temp_directory = 0;
76
drhc5499be2008-04-01 15:06:33 +000077/*
mistachkina112d142012-03-14 00:44:01 +000078** If the following global variable points to a string which is the
79** name of a directory, then that directory will be used to store
80** all database files specified with a relative pathname.
81**
82** See also the "PRAGMA data_store_directory" SQL command.
83*/
84char *sqlite3_data_directory = 0;
85
86/*
drh40257ff2008-06-13 18:24:27 +000087** Initialize SQLite.
88**
89** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +000090** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +000091** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
92** this routine will be called automatically by key routines such as
93** sqlite3_open().
94**
95** This routine is a no-op except on its very first call for the process,
96** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +000097**
98** The first thread to call this routine runs the initialization to
99** completion. If subsequent threads call this routine before the first
100** thread has finished the initialization process, then the subsequent
101** threads must block until the first thread finishes with the initialization.
102**
103** The first thread might call this routine recursively. Recursive
104** calls to this routine should not block, of course. Otherwise the
105** initialization process would never complete.
106**
107** Let X be the first thread to enter this routine. Let Y be some other
108** thread. Then while the initial invocation of this routine by X is
109** incomplete, it is required that:
110**
111** * Calls to this routine from Y must block until the outer-most
112** call by X completes.
113**
114** * Recursive calls to this routine from thread X return immediately
115** without blocking.
drh40257ff2008-06-13 18:24:27 +0000116*/
117int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000118 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000119 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000120#ifdef SQLITE_EXTRA_INIT
121 int bRunExtraInit = 0; /* Extra initialization needed */
122#endif
danielk1977075c23a2008-09-01 18:34:20 +0000123
124#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000125 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000126 if( rc!=SQLITE_OK ){
127 return rc;
128 }
129#endif
danielk197771bc31c2008-06-26 08:29:34 +0000130
drh93ed56d2008-08-12 15:21:11 +0000131 /* If SQLite is already completely initialized, then this call
132 ** to sqlite3_initialize() should be a no-op. But the initialization
133 ** must be complete. So isInit must not be set until the very end
134 ** of this routine.
135 */
danielk1977075c23a2008-09-01 18:34:20 +0000136 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000137
danac455932012-11-26 19:50:41 +0000138#ifdef SQLITE_ENABLE_SQLLOG
139 {
dan71ba10d2012-11-27 10:56:39 +0000140 extern void sqlite3_init_sqllog(void);
danac455932012-11-26 19:50:41 +0000141 sqlite3_init_sqllog();
142 }
143#endif
144
drh93ed56d2008-08-12 15:21:11 +0000145 /* Make sure the mutex subsystem is initialized. If unable to
146 ** initialize the mutex subsystem, return early with the error.
147 ** If the system is so sick that we are unable to allocate a mutex,
148 ** there is not much SQLite is going to be able to do.
149 **
150 ** The mutex subsystem must take care of serializing its own
151 ** initialization.
152 */
danielk1977d0251742008-06-18 18:57:42 +0000153 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000154 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000155
drh93ed56d2008-08-12 15:21:11 +0000156 /* Initialize the malloc() system and the recursive pInitMutex mutex.
157 ** This operation is protected by the STATIC_MASTER mutex. Note that
158 ** MutexAlloc() is called for a static mutex prior to initializing the
159 ** malloc subsystem - this implies that the allocation of a static
160 ** mutex must not require support from the malloc subsystem.
161 */
drh30ddce62011-10-15 00:16:30 +0000162 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000163 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000164 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000165 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000166 rc = sqlite3MallocInit();
167 }
drh40257ff2008-06-13 18:24:27 +0000168 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000169 sqlite3GlobalConfig.isMallocInit = 1;
170 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000171 sqlite3GlobalConfig.pInitMutex =
172 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000173 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000174 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000175 }
176 }
danielk197777eb5bb2008-09-22 17:22:19 +0000177 }
178 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000179 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000180 }
181 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000182
dane1ab2192009-08-17 15:16:19 +0000183 /* If rc is not SQLITE_OK at this point, then either the malloc
184 ** subsystem could not be initialized or the system failed to allocate
185 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000186 if( rc!=SQLITE_OK ){
187 return rc;
188 }
189
190 /* Do the rest of the initialization under the recursive mutex so
191 ** that we will be able to handle recursive calls into
192 ** sqlite3_initialize(). The recursive calls normally come through
193 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
194 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000195 **
196 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
197 ** to the xInit method, so the xInit method need not be threadsafe.
198 **
199 ** The following mutex is what serializes access to the appdef pcache xInit
200 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
201 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000202 */
danielk1977075c23a2008-09-01 18:34:20 +0000203 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000204 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000205 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000206 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000207 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000208 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000209 if( sqlite3GlobalConfig.isPCacheInit==0 ){
210 rc = sqlite3PcacheInitialize();
211 }
danielk19778c0a7912008-08-20 14:49:23 +0000212 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000213 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000214 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000215 }
216 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000217 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
218 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000219 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000220#ifdef SQLITE_EXTRA_INIT
221 bRunExtraInit = 1;
222#endif
danielk19778c0a7912008-08-20 14:49:23 +0000223 }
danielk1977502b4e02008-09-02 14:07:24 +0000224 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000225 }
danielk1977075c23a2008-09-01 18:34:20 +0000226 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000227
drh93ed56d2008-08-12 15:21:11 +0000228 /* Go back under the static mutex and clean up the recursive
229 ** mutex to prevent a resource leak.
230 */
231 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000232 sqlite3GlobalConfig.nRefInitMutex--;
233 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
234 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
235 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
236 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000237 }
238 sqlite3_mutex_leave(pMaster);
239
240 /* The following is just a sanity check to make sure SQLite has
241 ** been compiled correctly. It is important to run this code, but
242 ** we don't want to run it too often and soak up CPU cycles for no
243 ** reason. So we run it once during initialization.
244 */
shanedfb7b372008-07-22 05:13:30 +0000245#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000246#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000247 /* This section of code's only "output" is via assert() statements. */
248 if ( rc==SQLITE_OK ){
249 u64 x = (((u64)1)<<63)-1;
250 double y;
251 assert(sizeof(x)==8);
252 assert(sizeof(x)==sizeof(y));
253 memcpy(&y, &x, 8);
254 assert( sqlite3IsNaN(y) );
255 }
256#endif
shanefbd60f82009-02-04 03:59:25 +0000257#endif
shanedfb7b372008-07-22 05:13:30 +0000258
drhe4cf0b32011-08-25 00:14:41 +0000259 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
260 ** compile-time option.
261 */
262#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000263 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000264 int SQLITE_EXTRA_INIT(const char*);
265 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000266 }
267#endif
268
drh40257ff2008-06-13 18:24:27 +0000269 return rc;
270}
271
272/*
273** Undo the effects of sqlite3_initialize(). Must not be called while
274** there are outstanding database connections or memory allocations or
275** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000276** routine is not threadsafe. But it is safe to invoke this routine
277** on when SQLite is already shut down. If SQLite is already shut down
278** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000279*/
280int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000281 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000282#ifdef SQLITE_EXTRA_SHUTDOWN
283 void SQLITE_EXTRA_SHUTDOWN(void);
284 SQLITE_EXTRA_SHUTDOWN();
285#endif
drha7640922009-04-21 12:02:56 +0000286 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000287 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000288 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000289 }
dane1ab2192009-08-17 15:16:19 +0000290 if( sqlite3GlobalConfig.isPCacheInit ){
291 sqlite3PcacheShutdown();
292 sqlite3GlobalConfig.isPCacheInit = 0;
293 }
294 if( sqlite3GlobalConfig.isMallocInit ){
295 sqlite3MallocEnd();
296 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000297
298#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
299 /* The heap subsystem has now been shutdown and these values are supposed
300 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
301 ** which would rely on that heap subsystem; therefore, make sure these
302 ** values cannot refer to heap memory that was just invalidated when the
303 ** heap subsystem was shutdown. This is only done if the current call to
304 ** this function resulted in the heap subsystem actually being shutdown.
305 */
306 sqlite3_data_directory = 0;
307 sqlite3_temp_directory = 0;
308#endif
dane1ab2192009-08-17 15:16:19 +0000309 }
310 if( sqlite3GlobalConfig.isMutexInit ){
311 sqlite3MutexEnd();
312 sqlite3GlobalConfig.isMutexInit = 0;
313 }
314
drh40257ff2008-06-13 18:24:27 +0000315 return SQLITE_OK;
316}
317
318/*
319** This API allows applications to modify the global configuration of
320** the SQLite library at run-time.
321**
322** This routine should only be called when there are no outstanding
323** database connections or memory allocations. This routine is not
324** threadsafe. Failure to heed these warnings can lead to unpredictable
325** behavior.
326*/
327int sqlite3_config(int op, ...){
328 va_list ap;
329 int rc = SQLITE_OK;
330
331 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
332 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000333 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000334
335 va_start(ap, op);
336 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000337
338 /* Mutex configuration options are only available in a threadsafe
339 ** compile.
340 */
drhd68eee02009-12-11 03:44:18 +0000341#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000342 case SQLITE_CONFIG_SINGLETHREAD: {
343 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000344 sqlite3GlobalConfig.bCoreMutex = 0;
345 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000346 break;
347 }
348 case SQLITE_CONFIG_MULTITHREAD: {
349 /* Disable mutexing of database connections */
350 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000351 sqlite3GlobalConfig.bCoreMutex = 1;
352 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000353 break;
354 }
355 case SQLITE_CONFIG_SERIALIZED: {
356 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000357 sqlite3GlobalConfig.bCoreMutex = 1;
358 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000359 break;
360 }
drh18472fa2008-10-07 15:25:48 +0000361 case SQLITE_CONFIG_MUTEX: {
362 /* Specify an alternative mutex implementation */
363 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
364 break;
365 }
366 case SQLITE_CONFIG_GETMUTEX: {
367 /* Retrieve the current mutex implementation */
368 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
369 break;
370 }
371#endif
372
373
drh40257ff2008-06-13 18:24:27 +0000374 case SQLITE_CONFIG_MALLOC: {
375 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000376 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000377 break;
378 }
drh33589792008-06-18 13:27:46 +0000379 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000380 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000381 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
382 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000383 break;
384 }
drhfec00ea2008-06-14 16:56:21 +0000385 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000386 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000387 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000388 break;
389 }
drh33589792008-06-18 13:27:46 +0000390 case SQLITE_CONFIG_SCRATCH: {
391 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000392 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
393 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
394 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000395 break;
396 }
397 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000398 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000399 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
400 sqlite3GlobalConfig.szPage = va_arg(ap, int);
401 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000402 break;
403 }
danielk19775099be52008-06-27 13:27:03 +0000404
danielk1977bc2ca9e2008-11-13 14:28:28 +0000405 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000406 /* no-op */
407 break;
408 }
409 case SQLITE_CONFIG_GETPCACHE: {
410 /* now an error */
411 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000412 break;
413 }
414
dan22e21ff2011-11-08 20:08:44 +0000415 case SQLITE_CONFIG_PCACHE2: {
416 /* Specify an alternative page cache implementation */
417 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
418 break;
419 }
420 case SQLITE_CONFIG_GETPCACHE2: {
421 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000422 sqlite3PCacheSetDefault();
423 }
dan22e21ff2011-11-08 20:08:44 +0000424 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000425 break;
426 }
427
drh5d414832008-07-15 14:47:18 +0000428#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000429 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000430 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000431 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
432 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
433 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000434
shaneha6ec8922011-03-09 21:36:17 +0000435 if( sqlite3GlobalConfig.mnReq<1 ){
436 sqlite3GlobalConfig.mnReq = 1;
437 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
438 /* cap min request size at 2^12 */
439 sqlite3GlobalConfig.mnReq = (1<<12);
440 }
441
danielk1977075c23a2008-09-01 18:34:20 +0000442 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000443 /* If the heap pointer is NULL, then restore the malloc implementation
444 ** back to NULL pointers too. This will cause the malloc to go
445 ** back to its default implementation when sqlite3_initialize() is
446 ** run.
447 */
danielk1977075c23a2008-09-01 18:34:20 +0000448 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000449 }else{
450 /* The heap pointer is not NULL, then install one of the
mistachkin037933b2013-08-13 22:33:41 +0000451 ** mem5.c/mem3.c methods. The enclosing #if guarantees at
452 ** least one of these methods is currently enabled.
drh8a42cbd2008-07-10 18:13:42 +0000453 */
danielk19775099be52008-06-27 13:27:03 +0000454#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000455 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000456#endif
457#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000458 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000459#endif
drh8a42cbd2008-07-10 18:13:42 +0000460 }
danielk19775099be52008-06-27 13:27:03 +0000461 break;
462 }
drh5d414832008-07-15 14:47:18 +0000463#endif
danielk19775099be52008-06-27 13:27:03 +0000464
drh633e6d52008-07-28 19:34:53 +0000465 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000466 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
467 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000468 break;
469 }
drh3f280702010-02-18 18:45:09 +0000470
mistachkin037933b2013-08-13 22:33:41 +0000471 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000472 ** The default is NULL. Logging is disabled if the function pointer is
473 ** NULL.
474 */
475 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000476 /* MSVC is picky about pulling func ptrs from va lists.
477 ** http://support.microsoft.com/kb/47961
478 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
479 */
480 typedef void(*LOGFUNC_t)(void*,int,const char*);
481 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000482 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
483 break;
484 }
drh633e6d52008-07-28 19:34:53 +0000485
dancd74b612011-04-22 19:37:32 +0000486 case SQLITE_CONFIG_URI: {
487 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
488 break;
489 }
490
drhde9a7b82012-09-17 20:44:46 +0000491 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
492 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
493 break;
494 }
495
danac455932012-11-26 19:50:41 +0000496#ifdef SQLITE_ENABLE_SQLLOG
497 case SQLITE_CONFIG_SQLLOG: {
498 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
499 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
500 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
501 break;
502 }
503#endif
504
drh9b4c59f2013-04-15 17:03:42 +0000505 case SQLITE_CONFIG_MMAP_SIZE: {
506 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000507 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh9b4c59f2013-04-15 17:03:42 +0000508 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
509 mxMmap = SQLITE_MAX_MMAP_SIZE;
510 }
drha1f42c72013-04-01 22:38:06 +0000511 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000512 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
513 if( szMmap>mxMmap) szMmap = mxMmap;
514 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000515 break;
516 }
517
drh40257ff2008-06-13 18:24:27 +0000518 default: {
519 rc = SQLITE_ERROR;
520 break;
521 }
522 }
523 va_end(ap);
524 return rc;
525}
526
527/*
drh633e6d52008-07-28 19:34:53 +0000528** Set up the lookaside buffers for a database connection.
529** Return SQLITE_OK on success.
530** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000531**
532** The sz parameter is the number of bytes in each lookaside slot.
533** The cnt parameter is the number of slots. If pStart is NULL the
534** space for the lookaside memory is obtained from sqlite3_malloc().
535** If pStart is not NULL then it is sz*cnt bytes of memory to use for
536** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000537*/
drhe9d1c722008-08-04 20:13:26 +0000538static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000539 void *pStart;
540 if( db->lookaside.nOut ){
541 return SQLITE_BUSY;
542 }
shanef71f89e2009-01-30 06:11:54 +0000543 /* Free any existing lookaside buffer for this handle before
544 ** allocating a new one so we don't have to have space for
545 ** both at the same time.
546 */
547 if( db->lookaside.bMalloced ){
548 sqlite3_free(db->lookaside.pStart);
549 }
drh61a4bd52011-11-10 02:39:28 +0000550 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
551 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000552 */
drh61a4bd52011-11-10 02:39:28 +0000553 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000554 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000555 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000556 if( sz==0 || cnt==0 ){
557 sz = 0;
558 pStart = 0;
559 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000560 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000561 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000562 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000563 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000564 }else{
565 pStart = pBuf;
566 }
drh4cfb22f2008-08-01 18:47:01 +0000567 db->lookaside.pStart = pStart;
568 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000569 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000570 if( pStart ){
571 int i;
572 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000573 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000574 p = (LookasideSlot*)pStart;
575 for(i=cnt-1; i>=0; i--){
576 p->pNext = db->lookaside.pFree;
577 db->lookaside.pFree = p;
578 p = (LookasideSlot*)&((u8*)p)[sz];
579 }
580 db->lookaside.pEnd = p;
581 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000582 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000583 }else{
584 db->lookaside.pEnd = 0;
585 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000586 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000587 }
588 return SQLITE_OK;
589}
590
591/*
drh4413d0e2008-11-04 13:46:27 +0000592** Return the mutex associated with a database connection.
593*/
594sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
595 return db->mutex;
596}
597
598/*
drh09419b42011-11-16 19:29:17 +0000599** Free up as much memory as we can from the given database
600** connection.
601*/
602int sqlite3_db_release_memory(sqlite3 *db){
603 int i;
dand9bb3a92011-12-30 11:43:59 +0000604 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000605 sqlite3BtreeEnterAll(db);
606 for(i=0; i<db->nDb; i++){
607 Btree *pBt = db->aDb[i].pBt;
608 if( pBt ){
609 Pager *pPager = sqlite3BtreePager(pBt);
610 sqlite3PagerShrink(pPager);
611 }
612 }
613 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000614 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000615 return SQLITE_OK;
616}
617
618/*
drh633e6d52008-07-28 19:34:53 +0000619** Configuration settings for an individual database connection
620*/
621int sqlite3_db_config(sqlite3 *db, int op, ...){
622 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000623 int rc;
drh633e6d52008-07-28 19:34:53 +0000624 va_start(ap, op);
625 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000626 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000627 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000628 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
629 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000630 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000631 break;
632 }
drh6480aad2008-08-01 16:31:14 +0000633 default: {
drhe83cafd2011-03-21 17:15:58 +0000634 static const struct {
635 int op; /* The opcode */
636 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
637 } aFlagOp[] = {
638 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
639 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
640 };
drh58ad5802011-03-23 22:02:23 +0000641 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000642 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000643 for(i=0; i<ArraySize(aFlagOp); i++){
644 if( aFlagOp[i].op==op ){
645 int onoff = va_arg(ap, int);
646 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000647 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000648 if( onoff>0 ){
649 db->flags |= aFlagOp[i].mask;
650 }else if( onoff==0 ){
651 db->flags &= ~aFlagOp[i].mask;
652 }
653 if( oldFlags!=db->flags ){
654 sqlite3ExpirePreparedStatements(db);
655 }
656 if( pRes ){
657 *pRes = (db->flags & aFlagOp[i].mask)!=0;
658 }
659 rc = SQLITE_OK;
660 break;
661 }
662 }
drh6480aad2008-08-01 16:31:14 +0000663 break;
664 }
drh633e6d52008-07-28 19:34:53 +0000665 }
666 va_end(ap);
667 return rc;
668}
669
drha16313e2007-03-30 11:29:32 +0000670
671/*
drh9b5adfa2008-01-20 23:19:56 +0000672** Return true if the buffer z[0..n-1] contains all spaces.
673*/
674static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000675 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000676 return n==0;
677}
678
679/*
drhd3d39e92004-05-20 22:16:29 +0000680** This is the default collating function named "BINARY" which is always
681** available.
drh9b5adfa2008-01-20 23:19:56 +0000682**
683** If the padFlag argument is not NULL then space padding at the end
684** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000685*/
danielk19772c336542005-01-13 02:14:23 +0000686static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000687 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000688 int nKey1, const void *pKey1,
689 int nKey2, const void *pKey2
690){
691 int rc, n;
692 n = nKey1<nKey2 ? nKey1 : nKey2;
693 rc = memcmp(pKey1, pKey2, n);
694 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000695 if( padFlag
696 && allSpaces(((char*)pKey1)+n, nKey1-n)
697 && allSpaces(((char*)pKey2)+n, nKey2-n)
698 ){
699 /* Leave rc unchanged at 0 */
700 }else{
701 rc = nKey1 - nKey2;
702 }
drhd3d39e92004-05-20 22:16:29 +0000703 }
704 return rc;
705}
706
707/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000708** Another built-in collating sequence: NOCASE.
709**
drhf7b54962013-05-28 12:11:54 +0000710** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000711** comparison". SQLite's knowledge of upper and lower case equivalents
712** extends only to the 26 characters used in the English language.
713**
714** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000715*/
716static int nocaseCollatingFunc(
717 void *NotUsed,
718 int nKey1, const void *pKey1,
719 int nKey2, const void *pKey2
720){
721 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000722 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000723 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000724 if( 0==r ){
725 r = nKey1-nKey2;
726 }
727 return r;
728}
729
730/*
drhaf9ff332002-01-16 21:00:27 +0000731** Return the ROWID of the most recent insert
732*/
drh9bb575f2004-09-06 17:24:11 +0000733sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000734 return db->lastRowid;
735}
736
737/*
danielk197724b03fd2004-05-10 10:34:34 +0000738** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000739*/
drh9bb575f2004-09-06 17:24:11 +0000740int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000741 return db->nChange;
742}
743
rdcf146a772004-02-25 22:51:06 +0000744/*
danielk1977b28af712004-06-21 06:50:26 +0000745** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000746*/
danielk1977b28af712004-06-21 06:50:26 +0000747int sqlite3_total_changes(sqlite3 *db){
748 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000749}
750
drhc8d30ac2002-04-12 10:08:59 +0000751/*
danielk1977fd7f0452008-12-17 17:30:26 +0000752** Close all open savepoints. This function only manipulates fields of the
753** database handle object, it does not close any savepoints that may be open
754** at the b-tree/pager level.
755*/
756void sqlite3CloseSavepoints(sqlite3 *db){
757 while( db->pSavepoint ){
758 Savepoint *pTmp = db->pSavepoint;
759 db->pSavepoint = pTmp->pNext;
760 sqlite3DbFree(db, pTmp);
761 }
762 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000763 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000764 db->isTransactionSavepoint = 0;
765}
766
767/*
dand2199f02010-08-27 17:48:52 +0000768** Invoke the destructor function associated with FuncDef p, if any. Except,
769** if this is not the last copy of the function, do not invoke it. Multiple
770** copies of a single function are created when create_function() is called
771** with SQLITE_ANY as the encoding.
772*/
773static void functionDestroy(sqlite3 *db, FuncDef *p){
774 FuncDestructor *pDestructor = p->pDestructor;
775 if( pDestructor ){
776 pDestructor->nRef--;
777 if( pDestructor->nRef==0 ){
778 pDestructor->xDestroy(pDestructor->pUserData);
779 sqlite3DbFree(db, pDestructor);
780 }
781 }
782}
783
784/*
danbba02a92012-05-15 17:15:34 +0000785** Disconnect all sqlite3_vtab objects that belong to database connection
786** db. This is called when db is being closed.
787*/
788static void disconnectAllVtab(sqlite3 *db){
789#ifndef SQLITE_OMIT_VIRTUALTABLE
790 int i;
791 sqlite3BtreeEnterAll(db);
792 for(i=0; i<db->nDb; i++){
793 Schema *pSchema = db->aDb[i].pSchema;
794 if( db->aDb[i].pSchema ){
795 HashElem *p;
796 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
797 Table *pTab = (Table *)sqliteHashData(p);
798 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
799 }
800 }
801 }
802 sqlite3BtreeLeaveAll(db);
803#else
804 UNUSED_PARAMETER(db);
805#endif
806}
807
808/*
drh167cd6a2012-06-02 17:09:46 +0000809** Return TRUE if database connection db has unfinalized prepared
810** statements or unfinished sqlite3_backup objects.
811*/
812static int connectionIsBusy(sqlite3 *db){
813 int j;
814 assert( sqlite3_mutex_held(db->mutex) );
815 if( db->pVdbe ) return 1;
816 for(j=0; j<db->nDb; j++){
817 Btree *pBt = db->aDb[j].pBt;
818 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
819 }
820 return 0;
821}
822
823/*
drh50e5dad2001-09-15 00:57:28 +0000824** Close an existing SQLite database
825*/
drh167cd6a2012-06-02 17:09:46 +0000826static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000827 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000828 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000829 }
drh7e8b8482008-01-23 03:03:05 +0000830 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000831 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000832 }
drh605264d2007-08-21 15:13:19 +0000833 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000834
danbba02a92012-05-15 17:15:34 +0000835 /* Force xDisconnect calls on all virtual tables */
836 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000837
danbba02a92012-05-15 17:15:34 +0000838 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000839 ** will not have called the xDisconnect() method on any virtual
840 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
841 ** call will do so. We need to do this before the check for active
842 ** SQL statements below, as the v-table implementation may be storing
843 ** some prepared statements internally.
844 */
dan67430812013-05-15 10:21:50 +0000845 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000846
drh167cd6a2012-06-02 17:09:46 +0000847 /* Legacy behavior (sqlite3_close() behavior) is to return
848 ** SQLITE_BUSY if the connection can not be closed immediately.
849 */
850 if( !forceZombie && connectionIsBusy(db) ){
851 sqlite3Error(db, SQLITE_BUSY, "unable to close due to unfinalized "
852 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000853 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000854 return SQLITE_BUSY;
855 }
danielk1977e0048402004-06-15 16:51:01 +0000856
danac455932012-11-26 19:50:41 +0000857#ifdef SQLITE_ENABLE_SQLLOG
858 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +0000859 /* Closing the handle. Fourth parameter is passed the value 2. */
860 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +0000861 }
862#endif
863
drh167cd6a2012-06-02 17:09:46 +0000864 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +0000865 */
866 db->magic = SQLITE_MAGIC_ZOMBIE;
867 sqlite3LeaveMutexAndCloseZombie(db);
868 return SQLITE_OK;
869}
drh94e92032003-02-16 22:21:32 +0000870
drh167cd6a2012-06-02 17:09:46 +0000871/*
872** Two variations on the public interface for closing a database
873** connection. The sqlite3_close() version returns SQLITE_BUSY and
874** leaves the connection option if there are unfinalized prepared
875** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
876** version forces the connection to become a zombie if there are
877** unclosed resources, and arranges for deallocation when the last
878** prepare statement or sqlite3_backup closes.
879*/
880int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
881int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
882
drh4245c402012-06-02 14:32:21 +0000883
884/*
885** Close the mutex on database connection db.
886**
887** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +0000888** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
889** every sqlite3_stmt has now been finalized and every sqlite3_backup has
890** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +0000891*/
892void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
893 HashElem *i; /* Hash table iterator */
894 int j;
895
drh4245c402012-06-02 14:32:21 +0000896 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +0000897 ** or if the connection has not yet been closed by sqlite3_close_v2(),
898 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +0000899 */
drh167cd6a2012-06-02 17:09:46 +0000900 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +0000901 sqlite3_mutex_leave(db->mutex);
902 return;
danielk197704103022009-02-03 16:51:24 +0000903 }
904
drh4245c402012-06-02 14:32:21 +0000905 /* If we reach this point, it means that the database connection has
906 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +0000907 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +0000908 ** go ahead and free all resources.
909 */
910
dan617dc862013-05-16 11:57:28 +0000911 /* If a transaction is open, roll it back. This also ensures that if
912 ** any database schemas have been modified by an uncommitted transaction
913 ** they are reset. And that the required b-tree mutex is held to make
914 ** the pager rollback and schema reset an atomic operation. */
915 sqlite3RollbackAll(db, SQLITE_OK);
916
danielk1977fd7f0452008-12-17 17:30:26 +0000917 /* Free any outstanding Savepoint structures. */
918 sqlite3CloseSavepoints(db);
919
drh5efb3142012-05-16 01:24:34 +0000920 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000921 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000922 struct Db *pDb = &db->aDb[j];
923 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000924 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000925 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000926 if( j!=1 ){
927 pDb->pSchema = 0;
928 }
drh113088e2003-03-20 01:16:58 +0000929 }
drhf57b3392001-10-08 13:22:32 +0000930 }
drh5efb3142012-05-16 01:24:34 +0000931 /* Clear the TEMP schema separately and last */
932 if( db->aDb[1].pSchema ){
933 sqlite3SchemaClear(db->aDb[1].pSchema);
934 }
935 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000936
drh5efb3142012-05-16 01:24:34 +0000937 /* Free up the array of auxiliary databases */
938 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000939 assert( db->nDb<=2 );
940 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000941
942 /* Tell the code in notify.c that the connection no longer holds any
943 ** locks and does not require any further unlock-notify callbacks.
944 */
945 sqlite3ConnectionClosed(db);
946
drh70a8ca32008-08-21 18:49:27 +0000947 for(j=0; j<ArraySize(db->aFunc.a); j++){
948 FuncDef *pNext, *pHash, *p;
949 for(p=db->aFunc.a[j]; p; p=pHash){
950 pHash = p->pHash;
951 while( p ){
dand2199f02010-08-27 17:48:52 +0000952 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000953 pNext = p->pNext;
954 sqlite3DbFree(db, p);
955 p = pNext;
956 }
drh8e0a2f92002-02-23 23:45:45 +0000957 }
958 }
danielk1977d8123362004-06-12 09:25:12 +0000959 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000960 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000961 /* Invoke any destructors registered for collation sequence user data. */
962 for(j=0; j<3; j++){
963 if( pColl[j].xDel ){
964 pColl[j].xDel(pColl[j].pUser);
965 }
966 }
drh633e6d52008-07-28 19:34:53 +0000967 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000968 }
danielk1977d8123362004-06-12 09:25:12 +0000969 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000970#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000971 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
972 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000973 if( pMod->xDestroy ){
974 pMod->xDestroy(pMod->pAux);
975 }
drh633e6d52008-07-28 19:34:53 +0000976 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000977 }
drhb9bb7c12006-06-11 23:41:55 +0000978 sqlite3HashClear(&db->aModule);
979#endif
danielk1977466be562004-06-10 02:16:01 +0000980
danielk19776622cce2004-05-20 11:00:52 +0000981 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000982 if( db->pErr ){
983 sqlite3ValueFree(db->pErr);
984 }
drhf1952c52006-06-08 15:48:00 +0000985 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000986
987 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000988
989 /* The temp-database schema is allocated differently from the other schema
990 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
991 ** So it needs to be freed here. Todo: Why not roll the temp schema into
992 ** the same sqliteMalloc() as the one that allocates the database
993 ** structure?
994 */
drh633e6d52008-07-28 19:34:53 +0000995 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000996 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000997 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000998 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +0000999 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001000 if( db->lookaside.bMalloced ){
1001 sqlite3_free(db->lookaside.pStart);
1002 }
drh17435752007-08-16 04:30:38 +00001003 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001004}
1005
1006/*
drh0f198a72012-02-13 16:43:16 +00001007** Rollback all database files. If tripCode is not SQLITE_OK, then
1008** any open cursors are invalidated ("tripped" - as in "tripping a circuit
1009** breaker") and made to return tripCode if there are any further
1010** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +00001011*/
drh0f198a72012-02-13 16:43:16 +00001012void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001013 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001014 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +00001015 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001016 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001017
1018 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1019 ** This is important in case the transaction being rolled back has
1020 ** modified the database schema. If the b-tree mutexes are not taken
1021 ** here, then another shared-cache connection might sneak in between
1022 ** the database rollback and schema reset, which can cause false
1023 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001024 sqlite3BtreeEnterAll(db);
dan617dc862013-05-16 11:57:28 +00001025
drh001bbcb2003-03-19 03:14:00 +00001026 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001027 Btree *p = db->aDb[i].pBt;
1028 if( p ){
1029 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001030 inTrans = 1;
1031 }
drh0f198a72012-02-13 16:43:16 +00001032 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +00001033 }
1034 }
danielk1977a298e902006-06-22 09:53:48 +00001035 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001036 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001037
drh5c5760a2013-02-19 18:34:45 +00001038 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001039 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001040 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001041 }
dancd7b91a2013-05-13 18:23:15 +00001042 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001043
dan1da40a32009-09-19 17:00:31 +00001044 /* Any deferred constraint violations have now been resolved. */
1045 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001046 db->nDeferredImmCons = 0;
1047 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001048
danielk197771fd80b2005-12-16 06:54:01 +00001049 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001050 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001051 db->xRollbackCallback(db->pRollbackArg);
1052 }
drh001bbcb2003-03-19 03:14:00 +00001053}
1054
1055/*
mistachkinf2c1c992013-04-28 01:44:43 +00001056** Return a static string containing the name corresponding to the error code
1057** specified in the argument.
1058*/
mistachkin10269dc2013-04-30 07:54:42 +00001059#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST) || \
1060 defined(SQLITE_DEBUG_OS_TRACE)
mistachkinf2c1c992013-04-28 01:44:43 +00001061const char *sqlite3ErrName(int rc){
1062 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001063 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001064 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1065 switch( rc ){
1066 case SQLITE_OK: zName = "SQLITE_OK"; break;
1067 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1068 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1069 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1070 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001071 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001072 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001073 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001074 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001075 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1076 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1077 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1078 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001079 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1080 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1081 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001082 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1083 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001084 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1085 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1086 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1087 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1088 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1089 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1090 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1091 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1092 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1093 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
1094 case SQLITE_IOERR_BLOCKED: zName = "SQLITE_IOERR_BLOCKED"; break;
1095 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1096 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1097 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1098 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1099 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1100 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1101 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1102 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1103 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1104 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1105 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1106 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1107 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1108 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001109 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001110 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001111 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001112 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001113 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1114 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1115 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001116 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1117 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1118 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001119 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001120 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1121 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1122 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1123 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1124 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1125 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1126 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1127 case SQLITE_CONSTRAINT_FOREIGNKEY:
1128 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1129 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1130 case SQLITE_CONSTRAINT_PRIMARYKEY:
1131 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1132 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1133 case SQLITE_CONSTRAINT_COMMITHOOK:
1134 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1135 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1136 case SQLITE_CONSTRAINT_FUNCTION:
1137 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
1138 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1139 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1140 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1141 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1142 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1143 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1144 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1145 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1146 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001147 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1148 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1149 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001150 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001151 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001152 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001153 }
1154 }
mistachkin10269dc2013-04-30 07:54:42 +00001155 if( zName==0 ){
1156 static char zBuf[50];
1157 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1158 zName = zBuf;
1159 }
mistachkinf2c1c992013-04-28 01:44:43 +00001160 return zName;
1161}
mistachkin10269dc2013-04-30 07:54:42 +00001162#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001163
1164/*
drhc22bd472002-05-10 13:14:07 +00001165** Return a static string that describes the kind of error specified in the
1166** argument.
drh247be432002-05-10 05:44:55 +00001167*/
danielk1977f20b21c2004-05-31 23:56:42 +00001168const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001169 static const char* const aMsg[] = {
1170 /* SQLITE_OK */ "not an error",
1171 /* SQLITE_ERROR */ "SQL logic error or missing database",
1172 /* SQLITE_INTERNAL */ 0,
1173 /* SQLITE_PERM */ "access permission denied",
1174 /* SQLITE_ABORT */ "callback requested query abort",
1175 /* SQLITE_BUSY */ "database is locked",
1176 /* SQLITE_LOCKED */ "database table is locked",
1177 /* SQLITE_NOMEM */ "out of memory",
1178 /* SQLITE_READONLY */ "attempt to write a readonly database",
1179 /* SQLITE_INTERRUPT */ "interrupted",
1180 /* SQLITE_IOERR */ "disk I/O error",
1181 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001182 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001183 /* SQLITE_FULL */ "database or disk is full",
1184 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001185 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001186 /* SQLITE_EMPTY */ "table contains no data",
1187 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001188 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001189 /* SQLITE_CONSTRAINT */ "constraint failed",
1190 /* SQLITE_MISMATCH */ "datatype mismatch",
1191 /* SQLITE_MISUSE */ "library routine called out of sequence",
1192 /* SQLITE_NOLFS */ "large file support is disabled",
1193 /* SQLITE_AUTH */ "authorization denied",
1194 /* SQLITE_FORMAT */ "auxiliary database format error",
1195 /* SQLITE_RANGE */ "bind or column index out of range",
1196 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1197 };
drh21021a52012-02-13 17:01:51 +00001198 const char *zErr = "unknown error";
1199 switch( rc ){
1200 case SQLITE_ABORT_ROLLBACK: {
1201 zErr = "abort due to ROLLBACK";
1202 break;
1203 }
1204 default: {
1205 rc &= 0xff;
1206 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1207 zErr = aMsg[rc];
1208 }
1209 break;
1210 }
drh247be432002-05-10 05:44:55 +00001211 }
drh21021a52012-02-13 17:01:51 +00001212 return zErr;
drh247be432002-05-10 05:44:55 +00001213}
1214
1215/*
drh2dfbbca2000-07-28 14:32:48 +00001216** This routine implements a busy callback that sleeps and tries
1217** again until a timeout value is reached. The timeout value is
1218** an integer number of milliseconds passed in as the first
1219** argument.
1220*/
drhdaffd0e2001-04-11 14:28:42 +00001221static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001222 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001223 int count /* Number of times table has been busy */
1224){
danielk197729bafea2008-06-26 10:41:19 +00001225#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001226 static const u8 delays[] =
1227 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1228 static const u8 totals[] =
1229 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001230# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001231 sqlite3 *db = (sqlite3 *)ptr;
1232 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001233 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001234
drhee570fa2005-04-28 12:06:05 +00001235 assert( count>=0 );
1236 if( count < NDELAY ){
1237 delay = delays[count];
1238 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001239 }else{
1240 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001241 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001242 }
drhd1bec472004-01-15 13:29:31 +00001243 if( prior + delay > timeout ){
1244 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001245 if( delay<=0 ) return 0;
1246 }
danielk19772a6bdf62007-08-20 16:07:00 +00001247 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001248 return 1;
1249#else
drh482ea182007-08-20 11:12:40 +00001250 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001251 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001252 if( (count+1)*1000 > timeout ){
1253 return 0;
1254 }
drh482ea182007-08-20 11:12:40 +00001255 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001256 return 1;
1257#endif
1258}
1259
1260/*
drha4afb652005-07-09 02:16:02 +00001261** Invoke the given busy handler.
1262**
1263** This routine is called when an operation failed with a lock.
1264** If this routine returns non-zero, the lock is retried. If it
1265** returns 0, the operation aborts with an SQLITE_BUSY error.
1266*/
1267int sqlite3InvokeBusyHandler(BusyHandler *p){
1268 int rc;
drh34004ce2008-07-11 16:15:17 +00001269 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001270 rc = p->xFunc(p->pArg, p->nBusy);
1271 if( rc==0 ){
1272 p->nBusy = -1;
1273 }else{
1274 p->nBusy++;
1275 }
1276 return rc;
1277}
1278
1279/*
drh2dfbbca2000-07-28 14:32:48 +00001280** This routine sets the busy callback for an Sqlite database to the
1281** given callback function with the given argument.
1282*/
danielk1977f9d64d22004-06-19 08:18:07 +00001283int sqlite3_busy_handler(
1284 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001285 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001286 void *pArg
1287){
drhe30f4422007-08-21 16:15:55 +00001288 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001289 db->busyHandler.xFunc = xBusy;
1290 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001291 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001292 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001293 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001294 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001295}
1296
danielk1977348bb5d2003-10-18 09:37:26 +00001297#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1298/*
1299** This routine sets the progress callback for an Sqlite database to the
1300** given callback function with the given argument. The progress callback will
1301** be invoked every nOps opcodes.
1302*/
danielk197724b03fd2004-05-10 10:34:34 +00001303void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001304 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001305 int nOps,
1306 int (*xProgress)(void*),
1307 void *pArg
1308){
drhbd0b1b52008-07-07 19:52:09 +00001309 sqlite3_mutex_enter(db->mutex);
1310 if( nOps>0 ){
1311 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001312 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001313 db->pProgressArg = pArg;
1314 }else{
1315 db->xProgress = 0;
1316 db->nProgressOps = 0;
1317 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001318 }
drhbd0b1b52008-07-07 19:52:09 +00001319 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001320}
1321#endif
1322
1323
drh2dfbbca2000-07-28 14:32:48 +00001324/*
1325** This routine installs a default busy handler that waits for the
1326** specified number of milliseconds before returning 0.
1327*/
danielk1977f9d64d22004-06-19 08:18:07 +00001328int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +00001329 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001330 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001331 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001332 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001333 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001334 }
danielk1977f9d64d22004-06-19 08:18:07 +00001335 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001336}
drh4c504392000-10-16 22:06:40 +00001337
1338/*
1339** Cause any pending operation to stop at its earliest opportunity.
1340*/
drh9bb575f2004-09-06 17:24:11 +00001341void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +00001342 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001343}
drhfa86c412002-02-02 15:01:15 +00001344
drhfa86c412002-02-02 15:01:15 +00001345
1346/*
danielk1977771151b2006-01-17 13:21:40 +00001347** This function is exactly the same as sqlite3_create_function(), except
1348** that it is designed to be called by internal code. The difference is
1349** that if a malloc() fails in sqlite3_create_function(), an error code
1350** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001351*/
danielk1977771151b2006-01-17 13:21:40 +00001352int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001353 sqlite3 *db,
1354 const char *zFunctionName,
1355 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001356 int enc,
danielk197765904932004-05-26 06:18:37 +00001357 void *pUserData,
1358 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1359 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001360 void (*xFinal)(sqlite3_context*),
1361 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001362){
drh0bce8352002-02-28 00:41:10 +00001363 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001364 int nName;
danielk197765904932004-05-26 06:18:37 +00001365
drhe30f4422007-08-21 16:15:55 +00001366 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001367 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001368 (xFunc && (xFinal || xStep)) ||
1369 (!xFunc && (xFinal && !xStep)) ||
1370 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001371 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001372 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001373 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001374 }
danielk1977d8123362004-06-12 09:25:12 +00001375
danielk197793758c82005-01-21 08:13:14 +00001376#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001377 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1378 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1379 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1380 **
1381 ** If SQLITE_ANY is specified, add three versions of the function
1382 ** to the hash table.
1383 */
1384 if( enc==SQLITE_UTF16 ){
1385 enc = SQLITE_UTF16NATIVE;
1386 }else if( enc==SQLITE_ANY ){
1387 int rc;
danielk1977771151b2006-01-17 13:21:40 +00001388 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
dand2199f02010-08-27 17:48:52 +00001389 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001390 if( rc==SQLITE_OK ){
1391 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
dand2199f02010-08-27 17:48:52 +00001392 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001393 }
1394 if( rc!=SQLITE_OK ){
1395 return rc;
1396 }
danielk1977d8123362004-06-12 09:25:12 +00001397 enc = SQLITE_UTF16BE;
1398 }
danielk197793758c82005-01-21 08:13:14 +00001399#else
1400 enc = SQLITE_UTF8;
1401#endif
danielk19779636c4e2005-01-25 04:27:54 +00001402
1403 /* Check if an existing function is being overridden or deleted. If so,
1404 ** and there are active VMs, then return SQLITE_BUSY. If a function
1405 ** is being overridden/deleted but there are no active VMs, allow the
1406 ** operation to continue but invalidate all precompiled statements.
1407 */
drh3abbd392008-12-10 23:04:13 +00001408 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001409 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001410 if( db->nVdbeActive ){
danielk19779636c4e2005-01-25 04:27:54 +00001411 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001412 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001413 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001414 return SQLITE_BUSY;
1415 }else{
1416 sqlite3ExpirePreparedStatements(db);
1417 }
1418 }
danielk197765904932004-05-26 06:18:37 +00001419
drh3abbd392008-12-10 23:04:13 +00001420 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001421 assert(p || db->mallocFailed);
1422 if( !p ){
1423 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001424 }
dand2199f02010-08-27 17:48:52 +00001425
1426 /* If an older version of the function with a configured destructor is
1427 ** being replaced invoke the destructor function here. */
1428 functionDestroy(db, p);
1429
1430 if( pDestructor ){
1431 pDestructor->nRef++;
1432 }
1433 p->pDestructor = pDestructor;
danielk1977fa18bec2007-09-03 11:04:22 +00001434 p->flags = 0;
1435 p->xFunc = xFunc;
1436 p->xStep = xStep;
1437 p->xFinalize = xFinal;
1438 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001439 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001440 return SQLITE_OK;
1441}
danielk1977771151b2006-01-17 13:21:40 +00001442
1443/*
1444** Create new user functions.
1445*/
1446int sqlite3_create_function(
1447 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001448 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001449 int nArg,
1450 int enc,
1451 void *p,
1452 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1453 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1454 void (*xFinal)(sqlite3_context*)
1455){
drh7b19fac2010-08-27 18:44:54 +00001456 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1457 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001458}
1459
1460int sqlite3_create_function_v2(
1461 sqlite3 *db,
1462 const char *zFunc,
1463 int nArg,
1464 int enc,
1465 void *p,
1466 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1467 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1468 void (*xFinal)(sqlite3_context*),
1469 void (*xDestroy)(void *)
1470){
shanehbd2aaf92010-09-01 02:38:21 +00001471 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001472 FuncDestructor *pArg = 0;
1473 sqlite3_mutex_enter(db->mutex);
1474 if( xDestroy ){
1475 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001476 if( !pArg ){
1477 xDestroy(p);
1478 goto out;
1479 }
dand2199f02010-08-27 17:48:52 +00001480 pArg->xDestroy = xDestroy;
1481 pArg->pUserData = p;
1482 }
1483 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1484 if( pArg && pArg->nRef==0 ){
1485 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001486 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001487 sqlite3DbFree(db, pArg);
1488 }
1489
1490 out:
drhe30f4422007-08-21 16:15:55 +00001491 rc = sqlite3ApiExit(db, rc);
1492 sqlite3_mutex_leave(db->mutex);
1493 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001494}
1495
danielk197793758c82005-01-21 08:13:14 +00001496#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001497int sqlite3_create_function16(
1498 sqlite3 *db,
1499 const void *zFunctionName,
1500 int nArg,
1501 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001502 void *p,
danielk197765904932004-05-26 06:18:37 +00001503 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1504 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1505 void (*xFinal)(sqlite3_context*)
1506){
1507 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001508 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +00001509 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001510 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001511 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001512 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001513 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001514 rc = sqlite3ApiExit(db, rc);
1515 sqlite3_mutex_leave(db->mutex);
1516 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001517}
danielk197793758c82005-01-21 08:13:14 +00001518#endif
drhc9b84a12002-06-20 11:36:48 +00001519
drhb7481e72006-09-16 21:45:14 +00001520
1521/*
1522** Declare that a function has been overloaded by a virtual table.
1523**
1524** If the function already exists as a regular global function, then
1525** this routine is a no-op. If the function does not exist, then create
1526** a new one that always throws a run-time error.
1527**
1528** When virtual tables intend to provide an overloaded function, they
1529** should call this routine to make sure the global function exists.
1530** A global function must exist in order for name resolution to work
1531** properly.
1532*/
1533int sqlite3_overload_function(
1534 sqlite3 *db,
1535 const char *zName,
1536 int nArg
1537){
drhdee0e402009-05-03 20:23:53 +00001538 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001539 int rc = SQLITE_OK;
drhe30f4422007-08-21 16:15:55 +00001540 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001541 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001542 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1543 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001544 }
drhcb5e4db2011-10-12 23:49:49 +00001545 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001546 sqlite3_mutex_leave(db->mutex);
1547 return rc;
drhb7481e72006-09-16 21:45:14 +00001548}
1549
drh19e2d372005-08-29 23:00:03 +00001550#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001551/*
drh18de4822003-01-16 16:28:53 +00001552** Register a trace function. The pArg from the previously registered trace
1553** is returned.
1554**
1555** A NULL trace function means that no tracing is executes. A non-NULL
1556** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001557** SQL statement.
drh18de4822003-01-16 16:28:53 +00001558*/
drh9bb575f2004-09-06 17:24:11 +00001559void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001560 void *pOld;
1561 sqlite3_mutex_enter(db->mutex);
1562 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001563 db->xTrace = xTrace;
1564 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001565 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001566 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001567}
drh19e2d372005-08-29 23:00:03 +00001568/*
1569** Register a profile function. The pArg from the previously registered
1570** profile function is returned.
1571**
1572** A NULL profile function means that no profiling is executes. A non-NULL
1573** profile is a pointer to a function that is invoked at the conclusion of
1574** each SQL statement that is run.
1575*/
1576void *sqlite3_profile(
1577 sqlite3 *db,
1578 void (*xProfile)(void*,const char*,sqlite_uint64),
1579 void *pArg
1580){
drhe30f4422007-08-21 16:15:55 +00001581 void *pOld;
1582 sqlite3_mutex_enter(db->mutex);
1583 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001584 db->xProfile = xProfile;
1585 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001586 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001587 return pOld;
1588}
1589#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001590
drhcd565fd2012-03-01 21:30:44 +00001591/*
1592** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001593** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001594** rollback.
1595*/
danielk197724b03fd2004-05-10 10:34:34 +00001596void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001597 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001598 int (*xCallback)(void*), /* Function to invoke on each commit */
1599 void *pArg /* Argument to the function */
1600){
drhe30f4422007-08-21 16:15:55 +00001601 void *pOld;
1602 sqlite3_mutex_enter(db->mutex);
1603 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001604 db->xCommitCallback = xCallback;
1605 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001606 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001607 return pOld;
1608}
1609
danielk197794eb6a12005-12-15 15:22:08 +00001610/*
1611** Register a callback to be invoked each time a row is updated,
1612** inserted or deleted using this database connection.
1613*/
danielk197771fd80b2005-12-16 06:54:01 +00001614void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001615 sqlite3 *db, /* Attach the hook to this database */
1616 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1617 void *pArg /* Argument to the function */
1618){
drhe30f4422007-08-21 16:15:55 +00001619 void *pRet;
1620 sqlite3_mutex_enter(db->mutex);
1621 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001622 db->xUpdateCallback = xCallback;
1623 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001624 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001625 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001626}
1627
danielk197771fd80b2005-12-16 06:54:01 +00001628/*
1629** Register a callback to be invoked each time a transaction is rolled
1630** back by this database connection.
1631*/
1632void *sqlite3_rollback_hook(
1633 sqlite3 *db, /* Attach the hook to this database */
1634 void (*xCallback)(void*), /* Callback function */
1635 void *pArg /* Argument to the function */
1636){
drhe30f4422007-08-21 16:15:55 +00001637 void *pRet;
1638 sqlite3_mutex_enter(db->mutex);
1639 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001640 db->xRollbackCallback = xCallback;
1641 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001642 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001643 return pRet;
1644}
drhaa940ea2004-01-15 02:44:03 +00001645
dan586b9c82010-05-03 08:04:49 +00001646#ifndef SQLITE_OMIT_WAL
1647/*
1648** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001649** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1650** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001651** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001652*/
drhb033d8b2010-05-03 13:37:30 +00001653int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001654 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001655 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001656 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001657 int nFrame /* Size of WAL */
1658){
drh5def0842010-05-05 20:00:25 +00001659 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001660 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001661 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001662 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001663 }
1664 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001665}
drhb033d8b2010-05-03 13:37:30 +00001666#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001667
1668/*
1669** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1670** a database after committing a transaction if there are nFrame or
1671** more frames in the log file. Passing zero or a negative value as the
1672** nFrame parameter disables automatic checkpoints entirely.
1673**
1674** The callback registered by this function replaces any existing callback
1675** registered using sqlite3_wal_hook(). Likewise, registering a callback
1676** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1677** configured by this function.
1678*/
1679int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001680#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001681 UNUSED_PARAMETER(db);
1682 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001683#else
dan586b9c82010-05-03 08:04:49 +00001684 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001685 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001686 }else{
1687 sqlite3_wal_hook(db, 0, 0);
1688 }
drhb033d8b2010-05-03 13:37:30 +00001689#endif
dan586b9c82010-05-03 08:04:49 +00001690 return SQLITE_OK;
1691}
1692
paulb0208cc2003-04-13 18:26:49 +00001693/*
dan8d22a172010-04-19 18:03:51 +00001694** Register a callback to be invoked each time a transaction is written
1695** into the write-ahead-log by this database connection.
1696*/
drh833bf962010-04-28 14:42:19 +00001697void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001698 sqlite3 *db, /* Attach the hook to this db handle */
1699 int(*xCallback)(void *, sqlite3*, const char*, int),
1700 void *pArg /* First argument passed to xCallback() */
1701){
drhb033d8b2010-05-03 13:37:30 +00001702#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001703 void *pRet;
1704 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001705 pRet = db->pWalArg;
1706 db->xWalCallback = xCallback;
1707 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001708 sqlite3_mutex_leave(db->mutex);
1709 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001710#else
1711 return 0;
1712#endif
dan8d22a172010-04-19 18:03:51 +00001713}
1714
1715/*
dancdc1f042010-11-18 12:11:05 +00001716** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001717*/
dancdc1f042010-11-18 12:11:05 +00001718int sqlite3_wal_checkpoint_v2(
1719 sqlite3 *db, /* Database handle */
1720 const char *zDb, /* Name of attached database (or NULL) */
1721 int eMode, /* SQLITE_CHECKPOINT_* value */
1722 int *pnLog, /* OUT: Size of WAL log in frames */
1723 int *pnCkpt /* OUT: Total number of frames checkpointed */
1724){
drhb033d8b2010-05-03 13:37:30 +00001725#ifdef SQLITE_OMIT_WAL
1726 return SQLITE_OK;
1727#else
dan586b9c82010-05-03 08:04:49 +00001728 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001729 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001730
dan9c5e3682011-02-07 15:12:12 +00001731 /* Initialize the output variables to -1 in case an error occurs. */
1732 if( pnLog ) *pnLog = -1;
1733 if( pnCkpt ) *pnCkpt = -1;
1734
drh383d79e2011-02-09 03:03:16 +00001735 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1736 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1737 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1738 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001739 return SQLITE_MISUSE;
1740 }
1741
dan586b9c82010-05-03 08:04:49 +00001742 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001743 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001744 iDb = sqlite3FindDbName(db, zDb);
1745 }
1746 if( iDb<0 ){
1747 rc = SQLITE_ERROR;
dan87c1fe12010-05-03 12:14:15 +00001748 sqlite3Error(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001749 }else{
dancdc1f042010-11-18 12:11:05 +00001750 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
dan87c1fe12010-05-03 12:14:15 +00001751 sqlite3Error(db, rc, 0);
dan586b9c82010-05-03 08:04:49 +00001752 }
drhb033d8b2010-05-03 13:37:30 +00001753 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001754 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001755 return rc;
1756#endif
dan586b9c82010-05-03 08:04:49 +00001757}
1758
dancdc1f042010-11-18 12:11:05 +00001759
1760/*
1761** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1762** to contains a zero-length string, all attached databases are
1763** checkpointed.
1764*/
1765int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1766 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1767}
1768
drhb033d8b2010-05-03 13:37:30 +00001769#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001770/*
1771** Run a checkpoint on database iDb. This is a no-op if database iDb is
1772** not currently open in WAL mode.
1773**
dan6fcff072010-05-03 14:05:43 +00001774** If a transaction is open on the database being checkpointed, this
1775** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1776** an error occurs while running the checkpoint, an SQLite error code is
1777** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001778**
1779** The mutex on database handle db should be held by the caller. The mutex
1780** associated with the specific b-tree being checkpointed is taken by
1781** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001782**
1783** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1784** checkpointed. If an error is encountered it is returned immediately -
1785** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001786**
dancdc1f042010-11-18 12:11:05 +00001787** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001788*/
dancdc1f042010-11-18 12:11:05 +00001789int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001790 int rc = SQLITE_OK; /* Return code */
1791 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001792 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001793
1794 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001795 assert( !pnLog || *pnLog==-1 );
1796 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001797
dan6fcff072010-05-03 14:05:43 +00001798 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1799 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001800 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001801 pnLog = 0;
1802 pnCkpt = 0;
1803 if( rc==SQLITE_BUSY ){
1804 bBusy = 1;
1805 rc = SQLITE_OK;
1806 }
dan6fcff072010-05-03 14:05:43 +00001807 }
dan586b9c82010-05-03 08:04:49 +00001808 }
1809
danf2b8dd52010-11-18 19:28:01 +00001810 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001811}
drhb033d8b2010-05-03 13:37:30 +00001812#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001813
1814/*
danielk1977d8293352009-04-30 09:10:37 +00001815** This function returns true if main-memory should be used instead of
1816** a temporary file for transient pager files and statement journals.
1817** The value returned depends on the value of db->temp_store (runtime
1818** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1819** following table describes the relationship between these two values
1820** and this functions return value.
1821**
1822** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1823** ----------------- -------------- ------------------------------
1824** 0 any file (return 0)
1825** 1 1 file (return 0)
1826** 1 2 memory (return 1)
1827** 1 0 file (return 0)
1828** 2 1 file (return 0)
1829** 2 2 memory (return 1)
1830** 2 0 memory (return 1)
1831** 3 any memory (return 1)
1832*/
drh1c514142009-04-30 12:25:10 +00001833int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001834#if SQLITE_TEMP_STORE==1
1835 return ( db->temp_store==2 );
1836#endif
1837#if SQLITE_TEMP_STORE==2
1838 return ( db->temp_store!=1 );
1839#endif
1840#if SQLITE_TEMP_STORE==3
1841 return 1;
shanecf697392009-06-01 16:53:09 +00001842#endif
1843#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001844 return 0;
shane60a4b532009-05-06 18:57:09 +00001845#endif
danielk1977d8293352009-04-30 09:10:37 +00001846}
1847
1848/*
danielk19774ad17132004-05-21 01:47:26 +00001849** Return UTF-8 encoded English language explanation of the most recent
1850** error.
1851*/
danielk19776622cce2004-05-20 11:00:52 +00001852const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001853 const char *z;
drhf49661a2008-12-10 16:45:50 +00001854 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001855 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001856 }
drhd55d57e2008-07-07 17:53:07 +00001857 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001858 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001859 }
drh27641702007-08-22 02:56:42 +00001860 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001861 if( db->mallocFailed ){
1862 z = sqlite3ErrStr(SQLITE_NOMEM);
1863 }else{
1864 z = (char*)sqlite3_value_text(db->pErr);
1865 assert( !db->mallocFailed );
1866 if( z==0 ){
1867 z = sqlite3ErrStr(db->errCode);
1868 }
danielk19776622cce2004-05-20 11:00:52 +00001869 }
drhe30f4422007-08-21 16:15:55 +00001870 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001871 return z;
danielk19776622cce2004-05-20 11:00:52 +00001872}
1873
drh6c626082004-11-14 21:56:29 +00001874#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001875/*
1876** Return UTF-16 encoded English language explanation of the most recent
1877** error.
1878*/
danielk19776622cce2004-05-20 11:00:52 +00001879const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00001880 static const u16 outOfMem[] = {
1881 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00001882 };
danielk19777c5c3ca2009-02-23 14:42:53 +00001883 static const u16 misuse[] = {
1884 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
1885 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
1886 'c', 'a', 'l', 'l', 'e', 'd', ' ',
1887 'o', 'u', 't', ' ',
1888 'o', 'f', ' ',
1889 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00001890 };
danielk19774ad17132004-05-21 01:47:26 +00001891
drhc60d0442004-09-30 13:43:13 +00001892 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001893 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001894 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00001895 }
drhd55d57e2008-07-07 17:53:07 +00001896 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001897 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00001898 }
drhe30f4422007-08-21 16:15:55 +00001899 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001900 if( db->mallocFailed ){
1901 z = (void *)outOfMem;
1902 }else{
drhc60d0442004-09-30 13:43:13 +00001903 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00001904 if( z==0 ){
1905 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
1906 SQLITE_UTF8, SQLITE_STATIC);
1907 z = sqlite3_value_text16(db->pErr);
1908 }
1909 /* A malloc() may have failed within the call to sqlite3_value_text16()
1910 ** above. If this is the case, then the db->mallocFailed flag needs to
1911 ** be cleared before returning. Do this directly, instead of via
1912 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1913 */
1914 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00001915 }
drhe30f4422007-08-21 16:15:55 +00001916 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001917 return z;
danielk19776622cce2004-05-20 11:00:52 +00001918}
drh6c626082004-11-14 21:56:29 +00001919#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001920
drhc60d0442004-09-30 13:43:13 +00001921/*
danielk19777ddad962005-12-12 06:53:03 +00001922** Return the most recent error code generated by an SQLite routine. If NULL is
1923** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001924*/
danielk19776622cce2004-05-20 11:00:52 +00001925int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001926 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001927 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00001928 }
drh01495b92008-01-23 12:52:40 +00001929 if( !db || db->mallocFailed ){
1930 return SQLITE_NOMEM;
1931 }
drh4ac285a2006-09-15 07:28:50 +00001932 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001933}
drh99dfe5e2008-10-30 15:03:15 +00001934int sqlite3_extended_errcode(sqlite3 *db){
1935 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001936 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00001937 }
1938 if( !db || db->mallocFailed ){
1939 return SQLITE_NOMEM;
1940 }
1941 return db->errCode;
1942}
danielk19776622cce2004-05-20 11:00:52 +00001943
drh0e819f92006-02-01 13:50:41 +00001944/*
mistachkin5dac8432012-09-11 02:00:25 +00001945** Return a string that describes the kind of error specified in the
1946** argument. For now, this simply calls the internal sqlite3ErrStr()
1947** function.
1948*/
1949const char *sqlite3_errstr(int rc){
1950 return sqlite3ErrStr(rc);
1951}
1952
1953/*
drh0e819f92006-02-01 13:50:41 +00001954** Create a new collating function for database "db". The name is zName
1955** and the encoding is enc.
1956*/
danielk19779a30cf62006-01-18 04:26:07 +00001957static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00001958 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00001959 const char *zName,
shanecea72b22009-09-07 04:38:36 +00001960 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00001961 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001962 int(*xCompare)(void*,int,const void*,int,const void*),
1963 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001964){
1965 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001966 int enc2;
drhc4a64fa2009-05-11 20:53:28 +00001967 int nName = sqlite3Strlen30(zName);
danielk19779a30cf62006-01-18 04:26:07 +00001968
drhe30f4422007-08-21 16:15:55 +00001969 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001970
1971 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1972 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1973 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1974 */
drh51c7d862009-04-27 18:46:06 +00001975 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00001976 testcase( enc2==SQLITE_UTF16 );
1977 testcase( enc2==SQLITE_UTF16_ALIGNED );
1978 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00001979 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001980 }
drh51c7d862009-04-27 18:46:06 +00001981 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00001982 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00001983 }
1984
1985 /* Check if this call is removing or replacing an existing collation
1986 ** sequence. If so, and there are active VMs, return busy. If there
1987 ** are no active VMs, invalidate any pre-compiled statements.
1988 */
drhc4a64fa2009-05-11 20:53:28 +00001989 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001990 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00001991 if( db->nVdbeActive ){
danielk19779a30cf62006-01-18 04:26:07 +00001992 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001993 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00001994 return SQLITE_BUSY;
1995 }
1996 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001997
1998 /* If collation sequence pColl was created directly by a call to
1999 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2000 ** then any copies made by synthCollSeq() need to be invalidated.
2001 ** Also, collation destructor - CollSeq.xDel() - function may need
2002 ** to be called.
2003 */
2004 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00002005 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00002006 int j;
2007 for(j=0; j<3; j++){
2008 CollSeq *p = &aColl[j];
2009 if( p->enc==pColl->enc ){
2010 if( p->xDel ){
2011 p->xDel(p->pUser);
2012 }
2013 p->xCmp = 0;
2014 }
2015 }
2016 }
danielk19779a30cf62006-01-18 04:26:07 +00002017 }
2018
drhc4a64fa2009-05-11 20:53:28 +00002019 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002020 if( pColl==0 ) return SQLITE_NOMEM;
2021 pColl->xCmp = xCompare;
2022 pColl->pUser = pCtx;
2023 pColl->xDel = xDel;
2024 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
danielk19779a30cf62006-01-18 04:26:07 +00002025 sqlite3Error(db, SQLITE_OK, 0);
2026 return SQLITE_OK;
2027}
2028
2029
danielk19776622cce2004-05-20 11:00:52 +00002030/*
drhbb4957f2008-03-20 14:03:29 +00002031** This array defines hard upper bounds on limit values. The
2032** initializer must be kept in sync with the SQLITE_LIMIT_*
2033** #defines in sqlite3.h.
2034*/
drhb1a6c3c2008-03-20 16:30:17 +00002035static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002036 SQLITE_MAX_LENGTH,
2037 SQLITE_MAX_SQL_LENGTH,
2038 SQLITE_MAX_COLUMN,
2039 SQLITE_MAX_EXPR_DEPTH,
2040 SQLITE_MAX_COMPOUND_SELECT,
2041 SQLITE_MAX_VDBE_OP,
2042 SQLITE_MAX_FUNCTION_ARG,
2043 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002044 SQLITE_MAX_LIKE_PATTERN_LENGTH,
2045 SQLITE_MAX_VARIABLE_NUMBER,
drh417168a2009-09-07 18:14:02 +00002046 SQLITE_MAX_TRIGGER_DEPTH,
drhbb4957f2008-03-20 14:03:29 +00002047};
2048
2049/*
2050** Make sure the hard limits are set to reasonable values
2051*/
2052#if SQLITE_MAX_LENGTH<100
2053# error SQLITE_MAX_LENGTH must be at least 100
2054#endif
2055#if SQLITE_MAX_SQL_LENGTH<100
2056# error SQLITE_MAX_SQL_LENGTH must be at least 100
2057#endif
2058#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2059# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2060#endif
drhbb4957f2008-03-20 14:03:29 +00002061#if SQLITE_MAX_COMPOUND_SELECT<2
2062# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2063#endif
2064#if SQLITE_MAX_VDBE_OP<40
2065# error SQLITE_MAX_VDBE_OP must be at least 40
2066#endif
drhe82f5d02008-10-07 19:53:14 +00002067#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2068# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002069#endif
drh01c7dc82011-03-23 18:22:34 +00002070#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>62
2071# error SQLITE_MAX_ATTACHED must be between 0 and 62
drhbb4957f2008-03-20 14:03:29 +00002072#endif
drhbb4957f2008-03-20 14:03:29 +00002073#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2074# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2075#endif
drh70a8ca32008-08-21 18:49:27 +00002076#if SQLITE_MAX_COLUMN>32767
2077# error SQLITE_MAX_COLUMN must not exceed 32767
2078#endif
drh417168a2009-09-07 18:14:02 +00002079#if SQLITE_MAX_TRIGGER_DEPTH<1
2080# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2081#endif
drhbb4957f2008-03-20 14:03:29 +00002082
2083
2084/*
2085** Change the value of a limit. Report the old value.
2086** If an invalid limit index is supplied, report -1.
2087** Make no changes but still report the old value if the
2088** new limit is negative.
2089**
2090** A new lower limit does not shrink existing constructs.
2091** It merely prevents new constructs that exceed the limit
2092** from forming.
2093*/
2094int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2095 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002096
2097
2098 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2099 ** there is a hard upper bound set at compile-time by a C preprocessor
2100 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2101 ** "_MAX_".)
2102 */
2103 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2104 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2105 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2106 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2107 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2108 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2109 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2110 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2111 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2112 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2113 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2114 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
2115 assert( SQLITE_LIMIT_TRIGGER_DEPTH==(SQLITE_N_LIMIT-1) );
2116
2117
drh521cc842008-04-15 02:36:33 +00002118 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002119 return -1;
2120 }
2121 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002122 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002123 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002124 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002125 }
2126 db->aLimit[limitId] = newLimit;
2127 }
drh4e93f5b2010-09-07 14:59:15 +00002128 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002129}
2130
2131/*
dan286ab7c2011-05-06 18:34:54 +00002132** This function is used to parse both URIs and non-URI filenames passed by the
2133** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2134** URIs specified as part of ATTACH statements.
2135**
2136** The first argument to this function is the name of the VFS to use (or
2137** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2138** query parameter. The second argument contains the URI (or non-URI filename)
2139** itself. When this function is called the *pFlags variable should contain
2140** the default flags to open the database handle with. The value stored in
2141** *pFlags may be updated before returning if the URI filename contains
2142** "cache=xxx" or "mode=xxx" query parameters.
2143**
2144** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2145** the VFS that should be used to open the database file. *pzFile is set to
2146** point to a buffer containing the name of the file to open. It is the
2147** responsibility of the caller to eventually call sqlite3_free() to release
2148** this buffer.
2149**
2150** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2151** may be set to point to a buffer containing an English language error
2152** message. It is the responsibility of the caller to eventually release
2153** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002154*/
2155int sqlite3ParseUri(
2156 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2157 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002158 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002159 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2160 char **pzFile, /* OUT: Filename component of URI */
2161 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2162){
dan78e9dd22011-05-03 10:22:32 +00002163 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002164 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002165 const char *zVfs = zDefaultVfs;
2166 char *zFile;
drhde941c32011-05-09 19:20:17 +00002167 char c;
dancd74b612011-04-22 19:37:32 +00002168 int nUri = sqlite3Strlen30(zUri);
2169
2170 assert( *pzErrMsg==0 );
2171
2172 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
2173 && nUri>=5 && memcmp(zUri, "file:", 5)==0
2174 ){
dan5de15372011-04-23 10:12:30 +00002175 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002176 int eState; /* Parser state when parsing URI */
2177 int iIn; /* Input character index */
2178 int iOut = 0; /* Output character index */
2179 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002180
dan286ab7c2011-05-06 18:34:54 +00002181 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2182 ** method that there may be extra parameters following the file-name. */
2183 flags |= SQLITE_OPEN_URI;
2184
2185 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002186 zFile = sqlite3_malloc(nByte);
2187 if( !zFile ) return SQLITE_NOMEM;
2188
drh869c0402013-08-07 23:15:52 +00002189 iIn = 5;
2190#ifndef SQLITE_ALLOW_URI_AUTHORITY
dancd74b612011-04-22 19:37:32 +00002191 /* Discard the scheme and authority segments of the URI. */
2192 if( zUri[5]=='/' && zUri[6]=='/' ){
2193 iIn = 7;
2194 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002195 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2196 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2197 iIn-7, &zUri[7]);
2198 rc = SQLITE_ERROR;
2199 goto parse_uri_out;
2200 }
dancd74b612011-04-22 19:37:32 +00002201 }
drh869c0402013-08-07 23:15:52 +00002202#endif
dancd74b612011-04-22 19:37:32 +00002203
2204 /* Copy the filename and any query parameters into the zFile buffer.
2205 ** Decode %HH escape codes along the way.
2206 **
2207 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2208 ** on the parsing context. As follows:
2209 **
2210 ** 0: Parsing file-name.
2211 ** 1: Parsing name section of a name=value query parameter.
2212 ** 2: Parsing value section of a name=value query parameter.
2213 */
2214 eState = 0;
drhde941c32011-05-09 19:20:17 +00002215 while( (c = zUri[iIn])!=0 && c!='#' ){
2216 iIn++;
dancd74b612011-04-22 19:37:32 +00002217 if( c=='%'
2218 && sqlite3Isxdigit(zUri[iIn])
2219 && sqlite3Isxdigit(zUri[iIn+1])
2220 ){
dan6d49e252011-05-03 15:09:05 +00002221 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2222 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002223
dan6d49e252011-05-03 15:09:05 +00002224 assert( octet>=0 && octet<256 );
2225 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002226 /* This branch is taken when "%00" appears within the URI. In this
2227 ** case we ignore all text in the remainder of the path, name or
2228 ** value currently being parsed. So ignore the current character
2229 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002230 while( (c = zUri[iIn])!=0 && c!='#'
2231 && (eState!=0 || c!='?')
2232 && (eState!=1 || (c!='=' && c!='&'))
2233 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002234 ){
2235 iIn++;
2236 }
2237 continue;
dancd74b612011-04-22 19:37:32 +00002238 }
dan6d49e252011-05-03 15:09:05 +00002239 c = octet;
dan5de15372011-04-23 10:12:30 +00002240 }else if( eState==1 && (c=='&' || c=='=') ){
2241 if( zFile[iOut-1]==0 ){
2242 /* An empty option name. Ignore this option altogether. */
2243 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2244 continue;
2245 }
2246 if( c=='&' ){
2247 zFile[iOut++] = '\0';
2248 }else{
2249 eState = 2;
2250 }
dancd74b612011-04-22 19:37:32 +00002251 c = 0;
dan5de15372011-04-23 10:12:30 +00002252 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2253 c = 0;
dancd74b612011-04-22 19:37:32 +00002254 eState = 1;
dancd74b612011-04-22 19:37:32 +00002255 }
2256 zFile[iOut++] = c;
2257 }
2258 if( eState==1 ) zFile[iOut++] = '\0';
2259 zFile[iOut++] = '\0';
2260 zFile[iOut++] = '\0';
2261
2262 /* Check if there were any options specified that should be interpreted
2263 ** here. Options that are interpreted here include "vfs" and those that
2264 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002265 ** method. */
dan5de15372011-04-23 10:12:30 +00002266 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2267 while( zOpt[0] ){
2268 int nOpt = sqlite3Strlen30(zOpt);
2269 char *zVal = &zOpt[nOpt+1];
2270 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002271
dan286ab7c2011-05-06 18:34:54 +00002272 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002273 zVfs = zVal;
2274 }else{
2275 struct OpenMode {
2276 const char *z;
2277 int mode;
2278 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002279 char *zModeType = 0;
2280 int mask = 0;
2281 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002282
dan286ab7c2011-05-06 18:34:54 +00002283 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002284 static struct OpenMode aCacheMode[] = {
2285 { "shared", SQLITE_OPEN_SHAREDCACHE },
2286 { "private", SQLITE_OPEN_PRIVATECACHE },
2287 { 0, 0 }
2288 };
2289
2290 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2291 aMode = aCacheMode;
2292 limit = mask;
2293 zModeType = "cache";
2294 }
dan286ab7c2011-05-06 18:34:54 +00002295 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002296 static struct OpenMode aOpenMode[] = {
2297 { "ro", SQLITE_OPEN_READONLY },
2298 { "rw", SQLITE_OPEN_READWRITE },
2299 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002300 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002301 { 0, 0 }
2302 };
2303
drh9c67b2a2012-05-28 13:58:00 +00002304 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2305 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002306 aMode = aOpenMode;
2307 limit = mask & flags;
2308 zModeType = "access";
2309 }
2310
2311 if( aMode ){
2312 int i;
2313 int mode = 0;
2314 for(i=0; aMode[i].z; i++){
2315 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002316 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002317 mode = aMode[i].mode;
2318 break;
dancd74b612011-04-22 19:37:32 +00002319 }
2320 }
dan78e9dd22011-05-03 10:22:32 +00002321 if( mode==0 ){
2322 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2323 rc = SQLITE_ERROR;
2324 goto parse_uri_out;
2325 }
drh9c67b2a2012-05-28 13:58:00 +00002326 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002327 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2328 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002329 rc = SQLITE_PERM;
2330 goto parse_uri_out;
2331 }
2332 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002333 }
dancd74b612011-04-22 19:37:32 +00002334 }
dan5de15372011-04-23 10:12:30 +00002335
2336 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002337 }
2338
2339 }else{
2340 zFile = sqlite3_malloc(nUri+2);
2341 if( !zFile ) return SQLITE_NOMEM;
2342 memcpy(zFile, zUri, nUri);
2343 zFile[nUri] = '\0';
2344 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002345 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002346 }
2347
2348 *ppVfs = sqlite3_vfs_find(zVfs);
2349 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002350 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002351 rc = SQLITE_ERROR;
2352 }
2353 parse_uri_out:
2354 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002355 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002356 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002357 }
2358 *pFlags = flags;
2359 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002360 return rc;
dancd74b612011-04-22 19:37:32 +00002361}
2362
2363
2364/*
danielk19774ad17132004-05-21 01:47:26 +00002365** This routine does the work of opening a database on behalf of
2366** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002367** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002368*/
2369static int openDatabase(
2370 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002371 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002372 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002373 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002374){
dancd74b612011-04-22 19:37:32 +00002375 sqlite3 *db; /* Store allocated handle here */
2376 int rc; /* Return code */
2377 int isThreadsafe; /* True for threadsafe connections */
2378 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2379 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002380
drhe0d0f8e2009-04-28 04:47:31 +00002381 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002382#ifndef SQLITE_OMIT_AUTOINIT
2383 rc = sqlite3_initialize();
2384 if( rc ) return rc;
2385#endif
2386
dan78e9dd22011-05-03 10:22:32 +00002387 /* Only allow sensible combinations of bits in the flags argument.
2388 ** Throw an error if any non-sense combination is used. If we
2389 ** do not block illegal combinations here, it could trigger
2390 ** assert() statements in deeper layers. Sensible combinations
2391 ** are:
2392 **
2393 ** 1: SQLITE_OPEN_READONLY
2394 ** 2: SQLITE_OPEN_READWRITE
2395 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2396 */
2397 assert( SQLITE_OPEN_READONLY == 0x01 );
2398 assert( SQLITE_OPEN_READWRITE == 0x02 );
2399 assert( SQLITE_OPEN_CREATE == 0x04 );
2400 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2401 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2402 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh5dd72ad2011-05-07 18:18:33 +00002403 if( ((1<<(flags&7)) & 0x46)==0 ) return SQLITE_MISUSE_BKPT;
dan78e9dd22011-05-03 10:22:32 +00002404
drh039963a2008-09-03 00:43:15 +00002405 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002406 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002407 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2408 isThreadsafe = 0;
2409 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2410 isThreadsafe = 1;
2411 }else{
2412 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002413 }
drhf1f12682009-09-09 14:17:52 +00002414 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002415 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002416 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2417 flags |= SQLITE_OPEN_SHAREDCACHE;
2418 }
danielk19779a6284c2008-07-10 17:52:49 +00002419
drhb25a9f42009-05-12 13:35:11 +00002420 /* Remove harmful bits from the flags parameter
2421 **
2422 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2423 ** dealt with in the previous code block. Besides these, the only
2424 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002425 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2426 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002427 ** off all other flags.
2428 */
drha4267dc2008-02-19 15:20:44 +00002429 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002430 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002431 SQLITE_OPEN_MAIN_DB |
2432 SQLITE_OPEN_TEMP_DB |
2433 SQLITE_OPEN_TRANSIENT_DB |
2434 SQLITE_OPEN_MAIN_JOURNAL |
2435 SQLITE_OPEN_TEMP_JOURNAL |
2436 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002437 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002438 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002439 SQLITE_OPEN_FULLMUTEX |
2440 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002441 );
2442
danielk19774ad17132004-05-21 01:47:26 +00002443 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002444 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002445 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002446 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002447 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2448 if( db->mutex==0 ){
2449 sqlite3_free(db);
2450 db = 0;
2451 goto opendb_out;
2452 }
drh605264d2007-08-21 15:13:19 +00002453 }
drh27641702007-08-22 02:56:42 +00002454 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002455 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002456 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002457 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002458 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002459
drhbb4957f2008-03-20 14:03:29 +00002460 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2461 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00002462 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002463 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002464 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002465 db->nextPagesize = 0;
drh40c39412013-08-16 20:42:20 +00002466 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002467#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002468 | SQLITE_AutoIndex
2469#endif
drh76fe8032006-07-11 14:17:51 +00002470#if SQLITE_DEFAULT_FILE_FORMAT<4
2471 | SQLITE_LegacyFileFmt
2472#endif
drh56424db2007-03-27 22:24:11 +00002473#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2474 | SQLITE_LoadExtension
2475#endif
dan5bde73c2009-09-01 17:11:07 +00002476#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002477 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002478#endif
drha4bfd7f2010-12-09 19:15:17 +00002479#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2480 | SQLITE_ForeignKeys
2481#endif
drh76fe8032006-07-11 14:17:51 +00002482 ;
drhe61922a2009-05-02 13:29:37 +00002483 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002484#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002485 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002486#endif
danielk1977da184232006-01-05 11:34:32 +00002487
danielk19770202b292004-06-09 09:55:16 +00002488 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2489 ** and UTF-16, so add a version for each to avoid any unnecessary
2490 ** conversions. The only error that can occur here is a malloc() failure.
2491 */
drh4dd65e02011-11-29 14:46:56 +00002492 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2493 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2494 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2495 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002496 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002497 goto opendb_out;
2498 }
drhc4a64fa2009-05-11 20:53:28 +00002499 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002500 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002501
2502 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002503 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002504
dancd74b612011-04-22 19:37:32 +00002505 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002506 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002507 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2508 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002509 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
dan78e9dd22011-05-03 10:22:32 +00002510 sqlite3Error(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002511 sqlite3_free(zErrMsg);
2512 goto opendb_out;
2513 }
2514
danielk19774ad17132004-05-21 01:47:26 +00002515 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002516 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002517 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002518 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002519 if( rc==SQLITE_IOERR_NOMEM ){
2520 rc = SQLITE_NOMEM;
2521 }
danielk19774ad17132004-05-21 01:47:26 +00002522 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00002523 goto opendb_out;
2524 }
drh17435752007-08-16 04:30:38 +00002525 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2526 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002527
drh03b808a2006-03-13 15:06:05 +00002528
danielk197753c0f742005-03-29 03:10:59 +00002529 /* The default safety_level for the main database is 'full'; for the temp
2530 ** database it is 'NONE'. This matches the pager layer defaults.
2531 */
2532 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002533 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002534 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002535 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002536
danielk1977832a58a2007-06-22 15:21:15 +00002537 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002538 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002539 goto opendb_out;
2540 }
2541
danielk19778e227872004-06-07 07:52:17 +00002542 /* Register all built-in functions, but do not attempt to read the
2543 ** database schema yet. This is delayed until the first time the database
2544 ** is accessed.
2545 */
danielk1977832a58a2007-06-22 15:21:15 +00002546 sqlite3Error(db, SQLITE_OK, 0);
2547 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002548
drh1409be62006-08-23 20:07:20 +00002549 /* Load automatic extensions - extensions that have been registered
2550 ** using the sqlite3_automatic_extension() API.
2551 */
drh7aaa8782009-05-20 02:40:45 +00002552 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002553 if( rc==SQLITE_OK ){
2554 sqlite3AutoLoadExtensions(db);
2555 rc = sqlite3_errcode(db);
2556 if( rc!=SQLITE_OK ){
2557 goto opendb_out;
2558 }
danielk1977832a58a2007-06-22 15:21:15 +00002559 }
drh1409be62006-08-23 20:07:20 +00002560
drhaa29c132006-09-02 13:58:06 +00002561#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002562 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002563 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002564 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002565 }
2566#endif
2567
shessa26cf572006-10-19 20:27:58 +00002568#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002569 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002570 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002571 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002572 }
2573#endif
2574
shess69c4ae22007-08-20 17:37:47 +00002575#ifdef SQLITE_ENABLE_FTS3
2576 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002577 rc = sqlite3Fts3Init(db);
2578 }
2579#endif
2580
danielk197783852ac2007-05-06 16:04:11 +00002581#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002582 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002583 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002584 }
2585#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002586
2587#ifdef SQLITE_ENABLE_RTREE
2588 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002589 rc = sqlite3RtreeInit(db);
2590 }
2591#endif
2592
danielk1977832a58a2007-06-22 15:21:15 +00002593 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00002594
drh8fd5bd32007-04-02 16:40:37 +00002595 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2596 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2597 ** mode. Doing nothing at all also makes NORMAL the default.
2598 */
2599#ifdef SQLITE_DEFAULT_LOCKING_MODE
2600 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2601 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2602 SQLITE_DEFAULT_LOCKING_MODE);
2603#endif
2604
drh633e6d52008-07-28 19:34:53 +00002605 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002606 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2607 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002608
dan5a299f92010-05-03 11:05:08 +00002609 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002610
danielk19774ad17132004-05-21 01:47:26 +00002611opendb_out:
dancd74b612011-04-22 19:37:32 +00002612 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002613 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002614 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002615 sqlite3_mutex_leave(db->mutex);
2616 }
danielk197759633ae2008-08-27 19:01:57 +00002617 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002618 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002619 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002620 sqlite3_close(db);
2621 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002622 }else if( rc!=SQLITE_OK ){
2623 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002624 }
danielk19774ad17132004-05-21 01:47:26 +00002625 *ppDb = db;
danac455932012-11-26 19:50:41 +00002626#ifdef SQLITE_ENABLE_SQLLOG
2627 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002628 /* Opening a db handle. Fourth parameter is passed 0. */
2629 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2630 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002631 }
2632#endif
danielk197754f01982006-01-18 15:25:17 +00002633 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002634}
2635
2636/*
2637** Open a new database handle.
2638*/
danielk197780290862004-05-22 09:21:21 +00002639int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002640 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002641 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002642){
drh605264d2007-08-21 15:13:19 +00002643 return openDatabase(zFilename, ppDb,
2644 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2645}
2646int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002647 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002648 sqlite3 **ppDb, /* OUT: SQLite db handle */
2649 int flags, /* Flags */
2650 const char *zVfs /* Name of VFS module to use */
2651){
drh522c26f2011-05-07 14:40:29 +00002652 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002653}
2654
drh6c626082004-11-14 21:56:29 +00002655#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002656/*
2657** Open a new database handle.
2658*/
2659int sqlite3_open16(
2660 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002661 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002662){
danielk1977bfd6cce2004-06-18 04:24:54 +00002663 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002664 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002665 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002666
danielk19777ddad962005-12-12 06:53:03 +00002667 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00002668 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00002669 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002670#ifndef SQLITE_OMIT_AUTOINIT
2671 rc = sqlite3_initialize();
2672 if( rc ) return rc;
2673#endif
danielk19771e536952007-08-16 10:09:01 +00002674 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002675 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2676 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002677 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002678 rc = openDatabase(zFilename8, ppDb,
2679 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002680 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002681 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002682 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002683 }
drh40257ff2008-06-13 18:24:27 +00002684 }else{
2685 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002686 }
danielk19777ddad962005-12-12 06:53:03 +00002687 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002688
danielk197754f01982006-01-18 15:25:17 +00002689 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002690}
drh6c626082004-11-14 21:56:29 +00002691#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002692
danielk1977106bb232004-05-21 10:08:53 +00002693/*
danielk1977d8123362004-06-12 09:25:12 +00002694** Register a new collation sequence with the database handle db.
2695*/
danielk19770202b292004-06-09 09:55:16 +00002696int sqlite3_create_collation(
2697 sqlite3* db,
2698 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002699 int enc,
danielk19770202b292004-06-09 09:55:16 +00002700 void* pCtx,
2701 int(*xCompare)(void*,int,const void*,int,const void*)
2702){
danielk19779a30cf62006-01-18 04:26:07 +00002703 int rc;
drhe30f4422007-08-21 16:15:55 +00002704 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002705 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002706 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00002707 rc = sqlite3ApiExit(db, rc);
2708 sqlite3_mutex_leave(db->mutex);
2709 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00002710}
2711
2712/*
2713** Register a new collation sequence with the database handle db.
2714*/
danielk1977a393c032007-05-07 14:58:53 +00002715int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002716 sqlite3* db,
2717 const char *zName,
2718 int enc,
2719 void* pCtx,
2720 int(*xCompare)(void*,int,const void*,int,const void*),
2721 void(*xDel)(void*)
2722){
2723 int rc;
drhe30f4422007-08-21 16:15:55 +00002724 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002725 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002726 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002727 rc = sqlite3ApiExit(db, rc);
2728 sqlite3_mutex_leave(db->mutex);
2729 return rc;
danielk19770202b292004-06-09 09:55:16 +00002730}
2731
drh6c626082004-11-14 21:56:29 +00002732#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002733/*
2734** Register a new collation sequence with the database handle db.
2735*/
danielk19770202b292004-06-09 09:55:16 +00002736int sqlite3_create_collation16(
2737 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002738 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002739 int enc,
danielk19770202b292004-06-09 09:55:16 +00002740 void* pCtx,
2741 int(*xCompare)(void*,int,const void*,int,const void*)
2742){
danielk19779a30cf62006-01-18 04:26:07 +00002743 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002744 char *zName8;
drhe30f4422007-08-21 16:15:55 +00002745 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002746 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002747 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002748 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002749 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002750 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002751 }
drhe30f4422007-08-21 16:15:55 +00002752 rc = sqlite3ApiExit(db, rc);
2753 sqlite3_mutex_leave(db->mutex);
2754 return rc;
danielk19770202b292004-06-09 09:55:16 +00002755}
drh6c626082004-11-14 21:56:29 +00002756#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002757
danielk1977d8123362004-06-12 09:25:12 +00002758/*
2759** Register a collation sequence factory callback with the database handle
2760** db. Replace any previously installed collation sequence factory.
2761*/
danielk19777cedc8d2004-06-10 10:50:08 +00002762int sqlite3_collation_needed(
2763 sqlite3 *db,
2764 void *pCollNeededArg,
2765 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2766){
drhe30f4422007-08-21 16:15:55 +00002767 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002768 db->xCollNeeded = xCollNeeded;
2769 db->xCollNeeded16 = 0;
2770 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002771 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002772 return SQLITE_OK;
2773}
danielk1977d8123362004-06-12 09:25:12 +00002774
drh6c626082004-11-14 21:56:29 +00002775#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002776/*
2777** Register a collation sequence factory callback with the database handle
2778** db. Replace any previously installed collation sequence factory.
2779*/
danielk19777cedc8d2004-06-10 10:50:08 +00002780int sqlite3_collation_needed16(
2781 sqlite3 *db,
2782 void *pCollNeededArg,
2783 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2784){
drhe30f4422007-08-21 16:15:55 +00002785 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002786 db->xCollNeeded = 0;
2787 db->xCollNeeded16 = xCollNeeded16;
2788 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002789 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002790 return SQLITE_OK;
2791}
drh6c626082004-11-14 21:56:29 +00002792#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002793
shaneeec556d2008-10-12 00:27:53 +00002794#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002795/*
danielk19777ddad962005-12-12 06:53:03 +00002796** This function is now an anachronism. It used to be used to recover from a
2797** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002798*/
drh7d97efb2007-10-12 19:35:48 +00002799int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002800 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002801}
2802#endif
drh3e1d8e62005-05-26 16:23:34 +00002803
2804/*
2805** Test to see whether or not the database connection is in autocommit
2806** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2807** by default. Autocommit is disabled by a BEGIN statement and reenabled
2808** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00002809*/
2810int sqlite3_get_autocommit(sqlite3 *db){
2811 return db->autoCommit;
2812}
drh49285702005-09-17 15:20:26 +00002813
drh49285702005-09-17 15:20:26 +00002814/*
drh9978c972010-02-23 17:36:32 +00002815** The following routines are subtitutes for constants SQLITE_CORRUPT,
2816** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
2817** constants. They server two purposes:
2818**
2819** 1. Serve as a convenient place to set a breakpoint in a debugger
2820** to detect when version error conditions occurs.
2821**
2822** 2. Invoke sqlite3_log() to provide the source code location where
2823** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00002824*/
drh9978c972010-02-23 17:36:32 +00002825int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002826 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00002827 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00002828 "database corruption at line %d of [%.10s]",
2829 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00002830 return SQLITE_CORRUPT;
2831}
drh9978c972010-02-23 17:36:32 +00002832int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002833 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002834 sqlite3_log(SQLITE_MISUSE,
2835 "misuse at line %d of [%.10s]",
2836 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002837 return SQLITE_MISUSE;
2838}
2839int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002840 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002841 sqlite3_log(SQLITE_CANTOPEN,
2842 "cannot open file at line %d of [%.10s]",
2843 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002844 return SQLITE_CANTOPEN;
2845}
2846
drh7c1817e2006-01-10 13:58:48 +00002847
shaneeec556d2008-10-12 00:27:53 +00002848#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00002849/*
2850** This is a convenience routine that makes sure that all thread-specific
2851** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00002852**
2853** SQLite no longer uses thread-specific data so this routine is now a
2854** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00002855*/
2856void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00002857}
shaneeec556d2008-10-12 00:27:53 +00002858#endif
danielk1977deb802c2006-02-09 13:43:28 +00002859
2860/*
2861** Return meta information about a specific column of a database table.
2862** See comment in sqlite3.h (sqlite.h.in) for details.
2863*/
2864#ifdef SQLITE_ENABLE_COLUMN_METADATA
2865int sqlite3_table_column_metadata(
2866 sqlite3 *db, /* Connection handle */
2867 const char *zDbName, /* Database name or NULL */
2868 const char *zTableName, /* Table name */
2869 const char *zColumnName, /* Column name */
2870 char const **pzDataType, /* OUTPUT: Declared data type */
2871 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
2872 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
2873 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00002874 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00002875){
2876 int rc;
2877 char *zErrMsg = 0;
2878 Table *pTab = 0;
2879 Column *pCol = 0;
2880 int iCol;
2881
2882 char const *zDataType = 0;
2883 char const *zCollSeq = 0;
2884 int notnull = 0;
2885 int primarykey = 0;
2886 int autoinc = 0;
2887
2888 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00002889 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00002890 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002891 rc = sqlite3Init(db, &zErrMsg);
2892 if( SQLITE_OK!=rc ){
2893 goto error_out;
2894 }
2895
2896 /* Locate the table in question */
2897 pTab = sqlite3FindTable(db, zTableName, zDbName);
2898 if( !pTab || pTab->pSelect ){
2899 pTab = 0;
2900 goto error_out;
2901 }
2902
2903 /* Find the column for which info is requested */
2904 if( sqlite3IsRowid(zColumnName) ){
2905 iCol = pTab->iPKey;
2906 if( iCol>=0 ){
2907 pCol = &pTab->aCol[iCol];
2908 }
2909 }else{
2910 for(iCol=0; iCol<pTab->nCol; iCol++){
2911 pCol = &pTab->aCol[iCol];
2912 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
2913 break;
2914 }
2915 }
2916 if( iCol==pTab->nCol ){
2917 pTab = 0;
2918 goto error_out;
2919 }
2920 }
2921
2922 /* The following block stores the meta information that will be returned
2923 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
2924 ** and autoinc. At this point there are two possibilities:
2925 **
2926 ** 1. The specified column name was rowid", "oid" or "_rowid_"
2927 ** and there is no explicitly declared IPK column.
2928 **
2929 ** 2. The table is not a view and the column name identified an
2930 ** explicitly declared column. Copy meta information from *pCol.
2931 */
2932 if( pCol ){
2933 zDataType = pCol->zType;
2934 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00002935 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00002936 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00002937 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00002938 }else{
2939 zDataType = "INTEGER";
2940 primarykey = 1;
2941 }
2942 if( !zCollSeq ){
2943 zCollSeq = "BINARY";
2944 }
2945
2946error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00002947 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002948
2949 /* Whether the function call succeeded or failed, set the output parameters
2950 ** to whatever their local counterparts contain. If an error did occur,
2951 ** this has the effect of zeroing all output parameters.
2952 */
2953 if( pzDataType ) *pzDataType = zDataType;
2954 if( pzCollSeq ) *pzCollSeq = zCollSeq;
2955 if( pNotNull ) *pNotNull = notnull;
2956 if( pPrimaryKey ) *pPrimaryKey = primarykey;
2957 if( pAutoinc ) *pAutoinc = autoinc;
2958
2959 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00002960 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00002961 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00002962 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00002963 rc = SQLITE_ERROR;
2964 }
2965 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002966 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00002967 rc = sqlite3ApiExit(db, rc);
2968 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00002969 return rc;
2970}
drhe30f4422007-08-21 16:15:55 +00002971#endif
drhf9cb7f52006-06-27 20:06:44 +00002972
2973/*
2974** Sleep for a little while. Return the amount of time slept.
2975*/
2976int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00002977 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00002978 int rc;
drhd677b3d2007-08-20 22:48:41 +00002979 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00002980 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00002981
2982 /* This function works in milliseconds, but the underlying OsSleep()
2983 ** API uses microseconds. Hence the 1000's.
2984 */
drhe30f4422007-08-21 16:15:55 +00002985 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00002986 return rc;
drhf9cb7f52006-06-27 20:06:44 +00002987}
drh4ac285a2006-09-15 07:28:50 +00002988
2989/*
2990** Enable or disable the extended result codes.
2991*/
2992int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00002993 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002994 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00002995 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002996 return SQLITE_OK;
2997}
drhcc6bb3e2007-08-31 16:11:35 +00002998
2999/*
3000** Invoke the xFileControl method on a particular database.
3001*/
3002int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3003 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003004 Btree *pBtree;
3005
drhcc6bb3e2007-08-31 16:11:35 +00003006 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003007 pBtree = sqlite3DbNameToBtree(db, zDbName);
3008 if( pBtree ){
3009 Pager *pPager;
3010 sqlite3_file *fd;
3011 sqlite3BtreeEnter(pBtree);
3012 pPager = sqlite3BtreePager(pBtree);
3013 assert( pPager!=0 );
3014 fd = sqlite3PagerFile(pPager);
3015 assert( fd!=0 );
3016 if( op==SQLITE_FCNTL_FILE_POINTER ){
3017 *(sqlite3_file**)pArg = fd;
3018 rc = SQLITE_OK;
3019 }else if( fd->pMethods ){
3020 rc = sqlite3OsFileControl(fd, op, pArg);
3021 }else{
3022 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003023 }
drh421377e2012-03-15 21:28:54 +00003024 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003025 }
3026 sqlite3_mutex_leave(db->mutex);
3027 return rc;
3028}
drhed13d982008-01-31 14:43:24 +00003029
3030/*
3031** Interface to the testing logic.
3032*/
3033int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003034 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003035#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003036 va_list ap;
drhed13d982008-01-31 14:43:24 +00003037 va_start(ap, op);
3038 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003039
3040 /*
drh984bfaa2008-03-19 16:08:53 +00003041 ** Save the current state of the PRNG.
3042 */
drh2fa18682008-03-19 14:15:34 +00003043 case SQLITE_TESTCTRL_PRNG_SAVE: {
3044 sqlite3PrngSaveState();
3045 break;
3046 }
drh984bfaa2008-03-19 16:08:53 +00003047
3048 /*
3049 ** Restore the state of the PRNG to the last state saved using
3050 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3051 ** this verb acts like PRNG_RESET.
3052 */
drh2fa18682008-03-19 14:15:34 +00003053 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3054 sqlite3PrngRestoreState();
3055 break;
3056 }
drh984bfaa2008-03-19 16:08:53 +00003057
3058 /*
3059 ** Reset the PRNG back to its uninitialized state. The next call
3060 ** to sqlite3_randomness() will reseed the PRNG using a single call
3061 ** to the xRandomness method of the default VFS.
3062 */
drh2fa18682008-03-19 14:15:34 +00003063 case SQLITE_TESTCTRL_PRNG_RESET: {
3064 sqlite3PrngResetState();
3065 break;
3066 }
drh3088d592008-03-21 16:45:47 +00003067
3068 /*
3069 ** sqlite3_test_control(BITVEC_TEST, size, program)
3070 **
3071 ** Run a test against a Bitvec object of size. The program argument
3072 ** is an array of integers that defines the test. Return -1 on a
3073 ** memory allocation error, 0 on success, or non-zero for an error.
3074 ** See the sqlite3BitvecBuiltinTest() for additional information.
3075 */
3076 case SQLITE_TESTCTRL_BITVEC_TEST: {
3077 int sz = va_arg(ap, int);
3078 int *aProg = va_arg(ap, int*);
3079 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3080 break;
3081 }
danielk19772d1d86f2008-06-20 14:59:51 +00003082
3083 /*
3084 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3085 **
3086 ** Register hooks to call to indicate which malloc() failures
3087 ** are benign.
3088 */
3089 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003090 typedef void (*void_function)(void);
3091 void_function xBenignBegin;
3092 void_function xBenignEnd;
3093 xBenignBegin = va_arg(ap, void_function);
3094 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003095 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3096 break;
3097 }
drhc7a3bb92009-02-05 16:31:45 +00003098
3099 /*
drhf3af63f2009-05-09 18:59:42 +00003100 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003101 **
3102 ** Set the PENDING byte to the value in the argument, if X>0.
3103 ** Make no changes if X==0. Return the value of the pending byte
3104 ** as it existing before this routine was called.
3105 **
3106 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3107 ** an incompatible database file format. Changing the PENDING byte
3108 ** while any database connection is open results in undefined and
3109 ** dileterious behavior.
3110 */
3111 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003112 rc = PENDING_BYTE;
3113#ifndef SQLITE_OMIT_WSD
3114 {
3115 unsigned int newVal = va_arg(ap, unsigned int);
3116 if( newVal ) sqlite3PendingByte = newVal;
3117 }
3118#endif
drhc7a3bb92009-02-05 16:31:45 +00003119 break;
3120 }
drhf3af63f2009-05-09 18:59:42 +00003121
3122 /*
3123 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3124 **
3125 ** This action provides a run-time test to see whether or not
3126 ** assert() was enabled at compile-time. If X is true and assert()
3127 ** is enabled, then the return value is true. If X is true and
3128 ** assert() is disabled, then the return value is zero. If X is
3129 ** false and assert() is enabled, then the assertion fires and the
3130 ** process aborts. If X is false and assert() is disabled, then the
3131 ** return value is zero.
3132 */
3133 case SQLITE_TESTCTRL_ASSERT: {
3134 volatile int x = 0;
3135 assert( (x = va_arg(ap,int))!=0 );
3136 rc = x;
3137 break;
3138 }
3139
3140
3141 /*
3142 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3143 **
3144 ** This action provides a run-time test to see how the ALWAYS and
3145 ** NEVER macros were defined at compile-time.
3146 **
3147 ** The return value is ALWAYS(X).
3148 **
3149 ** The recommended test is X==2. If the return value is 2, that means
3150 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3151 ** default setting. If the return value is 1, then ALWAYS() is either
3152 ** hard-coded to true or else it asserts if its argument is false.
3153 ** The first behavior (hard-coded to true) is the case if
3154 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3155 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3156 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3157 **
3158 ** The run-time test procedure might look something like this:
3159 **
3160 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3161 ** // ALWAYS() and NEVER() are no-op pass-through macros
3162 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3163 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3164 ** }else{
3165 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3166 ** }
3167 */
3168 case SQLITE_TESTCTRL_ALWAYS: {
3169 int x = va_arg(ap,int);
3170 rc = ALWAYS(x);
3171 break;
3172 }
drhc046e3e2009-07-15 11:26:44 +00003173
3174 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3175 **
3176 ** Set the nReserve size to N for the main database on the database
3177 ** connection db.
3178 */
3179 case SQLITE_TESTCTRL_RESERVE: {
3180 sqlite3 *db = va_arg(ap, sqlite3*);
3181 int x = va_arg(ap,int);
3182 sqlite3_mutex_enter(db->mutex);
3183 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3184 sqlite3_mutex_leave(db->mutex);
3185 break;
3186 }
3187
drh07096f62009-12-22 23:52:32 +00003188 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3189 **
3190 ** Enable or disable various optimizations for testing purposes. The
3191 ** argument N is a bitmask of optimizations to be disabled. For normal
3192 ** operation N should be 0. The idea is that a test program (like the
3193 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3194 ** with various optimizations disabled to verify that the same answer
3195 ** is obtained in every case.
3196 */
3197 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3198 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003199 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003200 break;
3201 }
3202
drh0e857732010-01-02 03:21:35 +00003203#ifdef SQLITE_N_KEYWORD
3204 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3205 **
3206 ** If zWord is a keyword recognized by the parser, then return the
3207 ** number of keywords. Or if zWord is not a keyword, return 0.
3208 **
3209 ** This test feature is only available in the amalgamation since
3210 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3211 ** is built using separate source files.
3212 */
3213 case SQLITE_TESTCTRL_ISKEYWORD: {
3214 const char *zWord = va_arg(ap, const char*);
3215 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003216 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003217 break;
3218 }
3219#endif
3220
drhbadc9802010-08-27 17:16:44 +00003221 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3222 **
3223 ** Pass pFree into sqlite3ScratchFree().
3224 ** If sz>0 then allocate a scratch buffer into pNew.
3225 */
3226 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3227 void *pFree, **ppNew;
3228 int sz;
3229 sz = va_arg(ap, int);
3230 ppNew = va_arg(ap, void**);
3231 pFree = va_arg(ap, void*);
3232 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3233 sqlite3ScratchFree(pFree);
3234 break;
3235 }
3236
danc17d6962011-06-21 12:47:30 +00003237 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3238 **
3239 ** If parameter onoff is non-zero, configure the wrappers so that all
3240 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3241 ** undo this setting.
3242 */
3243 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3244 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3245 break;
3246 }
3247
drh678a9aa2011-12-10 15:55:01 +00003248#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh7e02e5e2011-12-06 19:44:51 +00003249 /* sqlite3_test_control(SQLITE_TESTCTRL_EXPLAIN_STMT,
3250 ** sqlite3_stmt*,const char**);
3251 **
drh678a9aa2011-12-10 15:55:01 +00003252 ** If compiled with SQLITE_ENABLE_TREE_EXPLAIN, each sqlite3_stmt holds
3253 ** a string that describes the optimized parse tree. This test-control
3254 ** returns a pointer to that string.
drh7e02e5e2011-12-06 19:44:51 +00003255 */
3256 case SQLITE_TESTCTRL_EXPLAIN_STMT: {
3257 sqlite3_stmt *pStmt = va_arg(ap, sqlite3_stmt*);
3258 const char **pzRet = va_arg(ap, const char**);
3259 *pzRet = sqlite3VdbeExplanation((Vdbe*)pStmt);
3260 break;
3261 }
drh678a9aa2011-12-10 15:55:01 +00003262#endif
drh7e02e5e2011-12-06 19:44:51 +00003263
drhed13d982008-01-31 14:43:24 +00003264 }
3265 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003266#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003267 return rc;
drhed13d982008-01-31 14:43:24 +00003268}
drhcc487d12011-05-17 18:53:08 +00003269
3270/*
3271** This is a utility routine, useful to VFS implementations, that checks
3272** to see if a database file was a URI that contained a specific query
3273** parameter, and if so obtains the value of the query parameter.
3274**
3275** The zFilename argument is the filename pointer passed into the xOpen()
3276** method of a VFS implementation. The zParam argument is the name of the
3277** query parameter we seek. This routine returns the value of the zParam
3278** parameter if it exists. If the parameter does not exist, this routine
3279** returns a NULL pointer.
3280*/
3281const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh92913722011-12-23 00:07:33 +00003282 if( zFilename==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003283 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003284 while( zFilename[0] ){
3285 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003286 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003287 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003288 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003289 }
3290 return 0;
3291}
drh283829c2011-11-17 00:56:20 +00003292
3293/*
drh92913722011-12-23 00:07:33 +00003294** Return a boolean value for a query parameter.
3295*/
3296int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3297 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003298 bDflt = bDflt!=0;
3299 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003300}
3301
3302/*
3303** Return a 64-bit integer value for a query parameter.
3304*/
3305sqlite3_int64 sqlite3_uri_int64(
3306 const char *zFilename, /* Filename as passed to xOpen */
3307 const char *zParam, /* URI parameter sought */
3308 sqlite3_int64 bDflt /* return if parameter is missing */
3309){
3310 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3311 sqlite3_int64 v;
3312 if( z && sqlite3Atoi64(z, &v, sqlite3Strlen30(z), SQLITE_UTF8)==SQLITE_OK ){
3313 bDflt = v;
3314 }
3315 return bDflt;
3316}
3317
3318/*
drh421377e2012-03-15 21:28:54 +00003319** Return the Btree pointer identified by zDbName. Return NULL if not found.
3320*/
3321Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3322 int i;
3323 for(i=0; i<db->nDb; i++){
3324 if( db->aDb[i].pBt
3325 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3326 ){
3327 return db->aDb[i].pBt;
3328 }
3329 }
3330 return 0;
3331}
3332
3333/*
drh283829c2011-11-17 00:56:20 +00003334** Return the filename of the database associated with a database
3335** connection.
3336*/
3337const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh421377e2012-03-15 21:28:54 +00003338 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3339 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3340}
3341
3342/*
3343** Return 1 if database is read-only or 0 if read/write. Return -1 if
3344** no such database exists.
3345*/
3346int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
3347 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3348 return pBt ? sqlite3PagerIsreadonly(sqlite3BtreePager(pBt)) : -1;
drh283829c2011-11-17 00:56:20 +00003349}