blob: 65a662ee5a1e7394937494d89a7b92505a821843 [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
drh93ed56d2008-08-12 15:21:11 +0000138 /* Make sure the mutex subsystem is initialized. If unable to
139 ** initialize the mutex subsystem, return early with the error.
140 ** If the system is so sick that we are unable to allocate a mutex,
141 ** there is not much SQLite is going to be able to do.
142 **
143 ** The mutex subsystem must take care of serializing its own
144 ** initialization.
145 */
danielk1977d0251742008-06-18 18:57:42 +0000146 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000147 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000148
drh93ed56d2008-08-12 15:21:11 +0000149 /* Initialize the malloc() system and the recursive pInitMutex mutex.
150 ** This operation is protected by the STATIC_MASTER mutex. Note that
151 ** MutexAlloc() is called for a static mutex prior to initializing the
152 ** malloc subsystem - this implies that the allocation of a static
153 ** mutex must not require support from the malloc subsystem.
154 */
drh30ddce62011-10-15 00:16:30 +0000155 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000156 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000157 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000158 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000159 rc = sqlite3MallocInit();
160 }
drh40257ff2008-06-13 18:24:27 +0000161 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000162 sqlite3GlobalConfig.isMallocInit = 1;
163 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000164 sqlite3GlobalConfig.pInitMutex =
165 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000166 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000167 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000168 }
169 }
danielk197777eb5bb2008-09-22 17:22:19 +0000170 }
171 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000172 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000173 }
174 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000175
dane1ab2192009-08-17 15:16:19 +0000176 /* If rc is not SQLITE_OK at this point, then either the malloc
177 ** subsystem could not be initialized or the system failed to allocate
178 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000179 if( rc!=SQLITE_OK ){
180 return rc;
181 }
182
183 /* Do the rest of the initialization under the recursive mutex so
184 ** that we will be able to handle recursive calls into
185 ** sqlite3_initialize(). The recursive calls normally come through
186 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
187 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000188 **
189 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
190 ** to the xInit method, so the xInit method need not be threadsafe.
191 **
192 ** The following mutex is what serializes access to the appdef pcache xInit
193 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
194 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000195 */
danielk1977075c23a2008-09-01 18:34:20 +0000196 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000197 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000198 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000199 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000200 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000201 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000202 if( sqlite3GlobalConfig.isPCacheInit==0 ){
203 rc = sqlite3PcacheInitialize();
204 }
danielk19778c0a7912008-08-20 14:49:23 +0000205 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000206 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000207 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000208 }
209 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000210 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
211 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000212 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000213#ifdef SQLITE_EXTRA_INIT
214 bRunExtraInit = 1;
215#endif
danielk19778c0a7912008-08-20 14:49:23 +0000216 }
danielk1977502b4e02008-09-02 14:07:24 +0000217 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000218 }
danielk1977075c23a2008-09-01 18:34:20 +0000219 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000220
drh93ed56d2008-08-12 15:21:11 +0000221 /* Go back under the static mutex and clean up the recursive
222 ** mutex to prevent a resource leak.
223 */
224 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000225 sqlite3GlobalConfig.nRefInitMutex--;
226 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
227 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
228 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
229 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000230 }
231 sqlite3_mutex_leave(pMaster);
232
233 /* The following is just a sanity check to make sure SQLite has
234 ** been compiled correctly. It is important to run this code, but
235 ** we don't want to run it too often and soak up CPU cycles for no
236 ** reason. So we run it once during initialization.
237 */
shanedfb7b372008-07-22 05:13:30 +0000238#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000239#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000240 /* This section of code's only "output" is via assert() statements. */
241 if ( rc==SQLITE_OK ){
242 u64 x = (((u64)1)<<63)-1;
243 double y;
244 assert(sizeof(x)==8);
245 assert(sizeof(x)==sizeof(y));
246 memcpy(&y, &x, 8);
247 assert( sqlite3IsNaN(y) );
248 }
249#endif
shanefbd60f82009-02-04 03:59:25 +0000250#endif
shanedfb7b372008-07-22 05:13:30 +0000251
drhe4cf0b32011-08-25 00:14:41 +0000252 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
253 ** compile-time option.
254 */
255#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000256 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000257 int SQLITE_EXTRA_INIT(const char*);
258 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000259 }
260#endif
261
drh40257ff2008-06-13 18:24:27 +0000262 return rc;
263}
264
265/*
266** Undo the effects of sqlite3_initialize(). Must not be called while
267** there are outstanding database connections or memory allocations or
268** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000269** routine is not threadsafe. But it is safe to invoke this routine
270** on when SQLite is already shut down. If SQLite is already shut down
271** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000272*/
273int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000274 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000275#ifdef SQLITE_EXTRA_SHUTDOWN
276 void SQLITE_EXTRA_SHUTDOWN(void);
277 SQLITE_EXTRA_SHUTDOWN();
278#endif
drha7640922009-04-21 12:02:56 +0000279 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000280 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000281 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000282 }
dane1ab2192009-08-17 15:16:19 +0000283 if( sqlite3GlobalConfig.isPCacheInit ){
284 sqlite3PcacheShutdown();
285 sqlite3GlobalConfig.isPCacheInit = 0;
286 }
287 if( sqlite3GlobalConfig.isMallocInit ){
288 sqlite3MallocEnd();
289 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000290
291#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
292 /* The heap subsystem has now been shutdown and these values are supposed
293 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
294 ** which would rely on that heap subsystem; therefore, make sure these
295 ** values cannot refer to heap memory that was just invalidated when the
296 ** heap subsystem was shutdown. This is only done if the current call to
297 ** this function resulted in the heap subsystem actually being shutdown.
298 */
299 sqlite3_data_directory = 0;
300 sqlite3_temp_directory = 0;
301#endif
dane1ab2192009-08-17 15:16:19 +0000302 }
303 if( sqlite3GlobalConfig.isMutexInit ){
304 sqlite3MutexEnd();
305 sqlite3GlobalConfig.isMutexInit = 0;
306 }
307
drh40257ff2008-06-13 18:24:27 +0000308 return SQLITE_OK;
309}
310
311/*
312** This API allows applications to modify the global configuration of
313** the SQLite library at run-time.
314**
315** This routine should only be called when there are no outstanding
316** database connections or memory allocations. This routine is not
317** threadsafe. Failure to heed these warnings can lead to unpredictable
318** behavior.
319*/
320int sqlite3_config(int op, ...){
321 va_list ap;
322 int rc = SQLITE_OK;
323
324 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
325 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000326 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000327
328 va_start(ap, op);
329 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000330
331 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000332 ** compile.
drh18472fa2008-10-07 15:25:48 +0000333 */
drhd1dcb232014-11-01 18:32:18 +0000334#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000335 case SQLITE_CONFIG_SINGLETHREAD: {
336 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000337 sqlite3GlobalConfig.bCoreMutex = 0;
338 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000339 break;
340 }
drhd1dcb232014-11-01 18:32:18 +0000341#endif
342#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000343 case SQLITE_CONFIG_MULTITHREAD: {
344 /* Disable mutexing of database connections */
345 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000346 sqlite3GlobalConfig.bCoreMutex = 1;
347 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000348 break;
349 }
drhd1dcb232014-11-01 18:32:18 +0000350#endif
351#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000352 case SQLITE_CONFIG_SERIALIZED: {
353 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000354 sqlite3GlobalConfig.bCoreMutex = 1;
355 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000356 break;
357 }
drhd1dcb232014-11-01 18:32:18 +0000358#endif
359#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000360 case SQLITE_CONFIG_MUTEX: {
361 /* Specify an alternative mutex implementation */
362 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
363 break;
364 }
drhd1dcb232014-11-01 18:32:18 +0000365#endif
366#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000367 case SQLITE_CONFIG_GETMUTEX: {
368 /* Retrieve the current mutex implementation */
369 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
370 break;
371 }
372#endif
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 */
drhd1dcb232014-11-01 18:32:18 +0000387 sqlite3GlobalConfig.bMemstat = va_arg(ap, int); /* IMP: R-27464-47829 */
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
drh00729cb2014-10-04 11:59:33 +0000486 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
487 ** can be changed at start-time using the
488 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
489 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
490 */
dancd74b612011-04-22 19:37:32 +0000491 case SQLITE_CONFIG_URI: {
492 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
493 break;
494 }
495
drhde9a7b82012-09-17 20:44:46 +0000496 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
497 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
498 break;
499 }
500
danac455932012-11-26 19:50:41 +0000501#ifdef SQLITE_ENABLE_SQLLOG
502 case SQLITE_CONFIG_SQLLOG: {
503 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
504 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
505 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
506 break;
507 }
508#endif
509
drh9b4c59f2013-04-15 17:03:42 +0000510 case SQLITE_CONFIG_MMAP_SIZE: {
511 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000512 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh9b4c59f2013-04-15 17:03:42 +0000513 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
514 mxMmap = SQLITE_MAX_MMAP_SIZE;
515 }
drha1f42c72013-04-01 22:38:06 +0000516 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000517 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
518 if( szMmap>mxMmap) szMmap = mxMmap;
519 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000520 break;
521 }
522
mistachkinac1f1042013-11-23 00:27:29 +0000523#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC)
mistachkinaf8641b2013-11-25 21:49:04 +0000524 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
mistachkinac1f1042013-11-23 00:27:29 +0000525 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
526 break;
527 }
528#endif
529
drh40257ff2008-06-13 18:24:27 +0000530 default: {
531 rc = SQLITE_ERROR;
532 break;
533 }
534 }
535 va_end(ap);
536 return rc;
537}
538
539/*
drh633e6d52008-07-28 19:34:53 +0000540** Set up the lookaside buffers for a database connection.
541** Return SQLITE_OK on success.
542** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000543**
544** The sz parameter is the number of bytes in each lookaside slot.
545** The cnt parameter is the number of slots. If pStart is NULL the
546** space for the lookaside memory is obtained from sqlite3_malloc().
547** If pStart is not NULL then it is sz*cnt bytes of memory to use for
548** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000549*/
drhe9d1c722008-08-04 20:13:26 +0000550static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000551 void *pStart;
552 if( db->lookaside.nOut ){
553 return SQLITE_BUSY;
554 }
shanef71f89e2009-01-30 06:11:54 +0000555 /* Free any existing lookaside buffer for this handle before
556 ** allocating a new one so we don't have to have space for
557 ** both at the same time.
558 */
559 if( db->lookaside.bMalloced ){
560 sqlite3_free(db->lookaside.pStart);
561 }
drh61a4bd52011-11-10 02:39:28 +0000562 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
563 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000564 */
drh61a4bd52011-11-10 02:39:28 +0000565 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000566 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000567 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000568 if( sz==0 || cnt==0 ){
569 sz = 0;
570 pStart = 0;
571 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000572 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000573 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000574 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000575 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000576 }else{
577 pStart = pBuf;
578 }
drh4cfb22f2008-08-01 18:47:01 +0000579 db->lookaside.pStart = pStart;
580 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000581 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000582 if( pStart ){
583 int i;
584 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000585 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000586 p = (LookasideSlot*)pStart;
587 for(i=cnt-1; i>=0; i--){
588 p->pNext = db->lookaside.pFree;
589 db->lookaside.pFree = p;
590 p = (LookasideSlot*)&((u8*)p)[sz];
591 }
592 db->lookaside.pEnd = p;
593 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000594 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000595 }else{
drhb0e77042013-12-10 19:49:00 +0000596 db->lookaside.pStart = db;
597 db->lookaside.pEnd = db;
drh4cfb22f2008-08-01 18:47:01 +0000598 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000599 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000600 }
601 return SQLITE_OK;
602}
603
604/*
drh4413d0e2008-11-04 13:46:27 +0000605** Return the mutex associated with a database connection.
606*/
607sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000608#ifdef SQLITE_ENABLE_API_ARMOR
609 if( !sqlite3SafetyCheckOk(db) ){
610 (void)SQLITE_MISUSE_BKPT;
611 return 0;
612 }
613#endif
drh4413d0e2008-11-04 13:46:27 +0000614 return db->mutex;
615}
616
617/*
drh09419b42011-11-16 19:29:17 +0000618** Free up as much memory as we can from the given database
619** connection.
620*/
621int sqlite3_db_release_memory(sqlite3 *db){
622 int i;
drh9ca95732014-10-24 00:35:58 +0000623
624#ifdef SQLITE_ENABLE_API_ARMOR
625 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
626#endif
dand9bb3a92011-12-30 11:43:59 +0000627 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000628 sqlite3BtreeEnterAll(db);
629 for(i=0; i<db->nDb; i++){
630 Btree *pBt = db->aDb[i].pBt;
631 if( pBt ){
632 Pager *pPager = sqlite3BtreePager(pBt);
633 sqlite3PagerShrink(pPager);
634 }
635 }
636 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000637 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000638 return SQLITE_OK;
639}
640
641/*
drh633e6d52008-07-28 19:34:53 +0000642** Configuration settings for an individual database connection
643*/
644int sqlite3_db_config(sqlite3 *db, int op, ...){
645 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000646 int rc;
drh633e6d52008-07-28 19:34:53 +0000647 va_start(ap, op);
648 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000649 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000650 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000651 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
652 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000653 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000654 break;
655 }
drh6480aad2008-08-01 16:31:14 +0000656 default: {
drhe83cafd2011-03-21 17:15:58 +0000657 static const struct {
658 int op; /* The opcode */
659 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
660 } aFlagOp[] = {
661 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
662 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
663 };
drh58ad5802011-03-23 22:02:23 +0000664 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000665 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000666 for(i=0; i<ArraySize(aFlagOp); i++){
667 if( aFlagOp[i].op==op ){
668 int onoff = va_arg(ap, int);
669 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000670 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000671 if( onoff>0 ){
672 db->flags |= aFlagOp[i].mask;
673 }else if( onoff==0 ){
674 db->flags &= ~aFlagOp[i].mask;
675 }
676 if( oldFlags!=db->flags ){
677 sqlite3ExpirePreparedStatements(db);
678 }
679 if( pRes ){
680 *pRes = (db->flags & aFlagOp[i].mask)!=0;
681 }
682 rc = SQLITE_OK;
683 break;
684 }
685 }
drh6480aad2008-08-01 16:31:14 +0000686 break;
687 }
drh633e6d52008-07-28 19:34:53 +0000688 }
689 va_end(ap);
690 return rc;
691}
692
drha16313e2007-03-30 11:29:32 +0000693
694/*
drh9b5adfa2008-01-20 23:19:56 +0000695** Return true if the buffer z[0..n-1] contains all spaces.
696*/
697static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000698 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000699 return n==0;
700}
701
702/*
drhd3d39e92004-05-20 22:16:29 +0000703** This is the default collating function named "BINARY" which is always
704** available.
drh9b5adfa2008-01-20 23:19:56 +0000705**
706** If the padFlag argument is not NULL then space padding at the end
707** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000708*/
danielk19772c336542005-01-13 02:14:23 +0000709static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000710 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000711 int nKey1, const void *pKey1,
712 int nKey2, const void *pKey2
713){
714 int rc, n;
715 n = nKey1<nKey2 ? nKey1 : nKey2;
716 rc = memcmp(pKey1, pKey2, n);
717 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000718 if( padFlag
719 && allSpaces(((char*)pKey1)+n, nKey1-n)
720 && allSpaces(((char*)pKey2)+n, nKey2-n)
721 ){
722 /* Leave rc unchanged at 0 */
723 }else{
724 rc = nKey1 - nKey2;
725 }
drhd3d39e92004-05-20 22:16:29 +0000726 }
727 return rc;
728}
729
730/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000731** Another built-in collating sequence: NOCASE.
732**
drhf7b54962013-05-28 12:11:54 +0000733** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000734** comparison". SQLite's knowledge of upper and lower case equivalents
735** extends only to the 26 characters used in the English language.
736**
737** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000738*/
739static int nocaseCollatingFunc(
740 void *NotUsed,
741 int nKey1, const void *pKey1,
742 int nKey2, const void *pKey2
743){
744 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000745 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000746 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000747 if( 0==r ){
748 r = nKey1-nKey2;
749 }
750 return r;
751}
752
753/*
drhaf9ff332002-01-16 21:00:27 +0000754** Return the ROWID of the most recent insert
755*/
drh9bb575f2004-09-06 17:24:11 +0000756sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000757#ifdef SQLITE_ENABLE_API_ARMOR
758 if( !sqlite3SafetyCheckOk(db) ){
759 (void)SQLITE_MISUSE_BKPT;
760 return 0;
761 }
762#endif
drhaf9ff332002-01-16 21:00:27 +0000763 return db->lastRowid;
764}
765
766/*
danielk197724b03fd2004-05-10 10:34:34 +0000767** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000768*/
drh9bb575f2004-09-06 17:24:11 +0000769int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000770#ifdef SQLITE_ENABLE_API_ARMOR
771 if( !sqlite3SafetyCheckOk(db) ){
772 (void)SQLITE_MISUSE_BKPT;
773 return 0;
774 }
775#endif
drhc8d30ac2002-04-12 10:08:59 +0000776 return db->nChange;
777}
778
rdcf146a772004-02-25 22:51:06 +0000779/*
danielk1977b28af712004-06-21 06:50:26 +0000780** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000781*/
danielk1977b28af712004-06-21 06:50:26 +0000782int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000783#ifdef SQLITE_ENABLE_API_ARMOR
784 if( !sqlite3SafetyCheckOk(db) ){
785 (void)SQLITE_MISUSE_BKPT;
786 return 0;
787 }
788#endif
danielk1977b28af712004-06-21 06:50:26 +0000789 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000790}
791
drhc8d30ac2002-04-12 10:08:59 +0000792/*
danielk1977fd7f0452008-12-17 17:30:26 +0000793** Close all open savepoints. This function only manipulates fields of the
794** database handle object, it does not close any savepoints that may be open
795** at the b-tree/pager level.
796*/
797void sqlite3CloseSavepoints(sqlite3 *db){
798 while( db->pSavepoint ){
799 Savepoint *pTmp = db->pSavepoint;
800 db->pSavepoint = pTmp->pNext;
801 sqlite3DbFree(db, pTmp);
802 }
803 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000804 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000805 db->isTransactionSavepoint = 0;
806}
807
808/*
dand2199f02010-08-27 17:48:52 +0000809** Invoke the destructor function associated with FuncDef p, if any. Except,
810** if this is not the last copy of the function, do not invoke it. Multiple
811** copies of a single function are created when create_function() is called
812** with SQLITE_ANY as the encoding.
813*/
814static void functionDestroy(sqlite3 *db, FuncDef *p){
815 FuncDestructor *pDestructor = p->pDestructor;
816 if( pDestructor ){
817 pDestructor->nRef--;
818 if( pDestructor->nRef==0 ){
819 pDestructor->xDestroy(pDestructor->pUserData);
820 sqlite3DbFree(db, pDestructor);
821 }
822 }
823}
824
825/*
danbba02a92012-05-15 17:15:34 +0000826** Disconnect all sqlite3_vtab objects that belong to database connection
827** db. This is called when db is being closed.
828*/
829static void disconnectAllVtab(sqlite3 *db){
830#ifndef SQLITE_OMIT_VIRTUALTABLE
831 int i;
832 sqlite3BtreeEnterAll(db);
833 for(i=0; i<db->nDb; i++){
834 Schema *pSchema = db->aDb[i].pSchema;
835 if( db->aDb[i].pSchema ){
836 HashElem *p;
837 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
838 Table *pTab = (Table *)sqliteHashData(p);
839 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
840 }
841 }
842 }
dand88e5212014-03-12 19:38:38 +0000843 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000844 sqlite3BtreeLeaveAll(db);
845#else
846 UNUSED_PARAMETER(db);
847#endif
848}
849
850/*
drh167cd6a2012-06-02 17:09:46 +0000851** Return TRUE if database connection db has unfinalized prepared
852** statements or unfinished sqlite3_backup objects.
853*/
854static int connectionIsBusy(sqlite3 *db){
855 int j;
856 assert( sqlite3_mutex_held(db->mutex) );
857 if( db->pVdbe ) return 1;
858 for(j=0; j<db->nDb; j++){
859 Btree *pBt = db->aDb[j].pBt;
860 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
861 }
862 return 0;
863}
864
865/*
drh50e5dad2001-09-15 00:57:28 +0000866** Close an existing SQLite database
867*/
drh167cd6a2012-06-02 17:09:46 +0000868static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000869 if( !db ){
drhddb17ca2014-08-11 15:54:11 +0000870 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
871 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +0000872 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000873 }
drh7e8b8482008-01-23 03:03:05 +0000874 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000875 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000876 }
drh605264d2007-08-21 15:13:19 +0000877 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000878
danbba02a92012-05-15 17:15:34 +0000879 /* Force xDisconnect calls on all virtual tables */
880 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000881
danbba02a92012-05-15 17:15:34 +0000882 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000883 ** will not have called the xDisconnect() method on any virtual
884 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
885 ** call will do so. We need to do this before the check for active
886 ** SQL statements below, as the v-table implementation may be storing
887 ** some prepared statements internally.
888 */
dan67430812013-05-15 10:21:50 +0000889 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000890
drh167cd6a2012-06-02 17:09:46 +0000891 /* Legacy behavior (sqlite3_close() behavior) is to return
892 ** SQLITE_BUSY if the connection can not be closed immediately.
893 */
894 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +0000895 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +0000896 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000897 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000898 return SQLITE_BUSY;
899 }
danielk1977e0048402004-06-15 16:51:01 +0000900
danac455932012-11-26 19:50:41 +0000901#ifdef SQLITE_ENABLE_SQLLOG
902 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +0000903 /* Closing the handle. Fourth parameter is passed the value 2. */
904 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +0000905 }
906#endif
907
drh167cd6a2012-06-02 17:09:46 +0000908 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +0000909 */
910 db->magic = SQLITE_MAGIC_ZOMBIE;
911 sqlite3LeaveMutexAndCloseZombie(db);
912 return SQLITE_OK;
913}
drh94e92032003-02-16 22:21:32 +0000914
drh167cd6a2012-06-02 17:09:46 +0000915/*
916** Two variations on the public interface for closing a database
917** connection. The sqlite3_close() version returns SQLITE_BUSY and
918** leaves the connection option if there are unfinalized prepared
919** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
920** version forces the connection to become a zombie if there are
921** unclosed resources, and arranges for deallocation when the last
922** prepare statement or sqlite3_backup closes.
923*/
924int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
925int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
926
drh4245c402012-06-02 14:32:21 +0000927
928/*
929** Close the mutex on database connection db.
930**
931** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +0000932** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
933** every sqlite3_stmt has now been finalized and every sqlite3_backup has
934** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +0000935*/
936void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
937 HashElem *i; /* Hash table iterator */
938 int j;
939
drh4245c402012-06-02 14:32:21 +0000940 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +0000941 ** or if the connection has not yet been closed by sqlite3_close_v2(),
942 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +0000943 */
drh167cd6a2012-06-02 17:09:46 +0000944 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +0000945 sqlite3_mutex_leave(db->mutex);
946 return;
danielk197704103022009-02-03 16:51:24 +0000947 }
948
drh4245c402012-06-02 14:32:21 +0000949 /* If we reach this point, it means that the database connection has
950 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +0000951 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +0000952 ** go ahead and free all resources.
953 */
954
dan617dc862013-05-16 11:57:28 +0000955 /* If a transaction is open, roll it back. This also ensures that if
956 ** any database schemas have been modified by an uncommitted transaction
957 ** they are reset. And that the required b-tree mutex is held to make
958 ** the pager rollback and schema reset an atomic operation. */
959 sqlite3RollbackAll(db, SQLITE_OK);
960
danielk1977fd7f0452008-12-17 17:30:26 +0000961 /* Free any outstanding Savepoint structures. */
962 sqlite3CloseSavepoints(db);
963
drh5efb3142012-05-16 01:24:34 +0000964 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000965 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000966 struct Db *pDb = &db->aDb[j];
967 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000968 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000969 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000970 if( j!=1 ){
971 pDb->pSchema = 0;
972 }
drh113088e2003-03-20 01:16:58 +0000973 }
drhf57b3392001-10-08 13:22:32 +0000974 }
drh5efb3142012-05-16 01:24:34 +0000975 /* Clear the TEMP schema separately and last */
976 if( db->aDb[1].pSchema ){
977 sqlite3SchemaClear(db->aDb[1].pSchema);
978 }
979 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000980
drh5efb3142012-05-16 01:24:34 +0000981 /* Free up the array of auxiliary databases */
982 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000983 assert( db->nDb<=2 );
984 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000985
986 /* Tell the code in notify.c that the connection no longer holds any
987 ** locks and does not require any further unlock-notify callbacks.
988 */
989 sqlite3ConnectionClosed(db);
990
drh70a8ca32008-08-21 18:49:27 +0000991 for(j=0; j<ArraySize(db->aFunc.a); j++){
992 FuncDef *pNext, *pHash, *p;
993 for(p=db->aFunc.a[j]; p; p=pHash){
994 pHash = p->pHash;
995 while( p ){
dand2199f02010-08-27 17:48:52 +0000996 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000997 pNext = p->pNext;
998 sqlite3DbFree(db, p);
999 p = pNext;
1000 }
drh8e0a2f92002-02-23 23:45:45 +00001001 }
1002 }
danielk1977d8123362004-06-12 09:25:12 +00001003 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001004 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001005 /* Invoke any destructors registered for collation sequence user data. */
1006 for(j=0; j<3; j++){
1007 if( pColl[j].xDel ){
1008 pColl[j].xDel(pColl[j].pUser);
1009 }
1010 }
drh633e6d52008-07-28 19:34:53 +00001011 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001012 }
danielk1977d8123362004-06-12 09:25:12 +00001013 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001014#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001015 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1016 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001017 if( pMod->xDestroy ){
1018 pMod->xDestroy(pMod->pAux);
1019 }
drh633e6d52008-07-28 19:34:53 +00001020 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001021 }
drhb9bb7c12006-06-11 23:41:55 +00001022 sqlite3HashClear(&db->aModule);
1023#endif
danielk1977466be562004-06-10 02:16:01 +00001024
drh13f40da2014-08-22 18:00:11 +00001025 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001026 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001027 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001028#if SQLITE_USER_AUTHENTICATION
1029 sqlite3_free(db->auth.zAuthUser);
1030 sqlite3_free(db->auth.zAuthPW);
1031#endif
danielk197796d81f92004-06-19 03:33:57 +00001032
1033 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001034
1035 /* The temp-database schema is allocated differently from the other schema
1036 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1037 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1038 ** the same sqliteMalloc() as the one that allocates the database
1039 ** structure?
1040 */
drh633e6d52008-07-28 19:34:53 +00001041 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001042 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001043 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001044 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001045 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001046 if( db->lookaside.bMalloced ){
1047 sqlite3_free(db->lookaside.pStart);
1048 }
drh17435752007-08-16 04:30:38 +00001049 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001050}
1051
1052/*
drh0f198a72012-02-13 16:43:16 +00001053** Rollback all database files. If tripCode is not SQLITE_OK, then
1054** any open cursors are invalidated ("tripped" - as in "tripping a circuit
1055** breaker") and made to return tripCode if there are any further
1056** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +00001057*/
drh0f198a72012-02-13 16:43:16 +00001058void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001059 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001060 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +00001061 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001062 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001063
1064 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1065 ** This is important in case the transaction being rolled back has
1066 ** modified the database schema. If the b-tree mutexes are not taken
1067 ** here, then another shared-cache connection might sneak in between
1068 ** the database rollback and schema reset, which can cause false
1069 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001070 sqlite3BtreeEnterAll(db);
dan617dc862013-05-16 11:57:28 +00001071
drh001bbcb2003-03-19 03:14:00 +00001072 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001073 Btree *p = db->aDb[i].pBt;
1074 if( p ){
1075 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001076 inTrans = 1;
1077 }
drh0f198a72012-02-13 16:43:16 +00001078 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +00001079 }
1080 }
danielk1977a298e902006-06-22 09:53:48 +00001081 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001082 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001083
drh5c5760a2013-02-19 18:34:45 +00001084 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001085 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001086 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001087 }
dancd7b91a2013-05-13 18:23:15 +00001088 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001089
dan1da40a32009-09-19 17:00:31 +00001090 /* Any deferred constraint violations have now been resolved. */
1091 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001092 db->nDeferredImmCons = 0;
1093 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001094
danielk197771fd80b2005-12-16 06:54:01 +00001095 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001096 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001097 db->xRollbackCallback(db->pRollbackArg);
1098 }
drh001bbcb2003-03-19 03:14:00 +00001099}
1100
1101/*
mistachkinf2c1c992013-04-28 01:44:43 +00001102** Return a static string containing the name corresponding to the error code
1103** specified in the argument.
1104*/
drh54027102014-08-06 14:36:53 +00001105#if (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) || defined(SQLITE_TEST)
mistachkinf2c1c992013-04-28 01:44:43 +00001106const char *sqlite3ErrName(int rc){
1107 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001108 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001109 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1110 switch( rc ){
1111 case SQLITE_OK: zName = "SQLITE_OK"; break;
1112 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1113 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1114 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1115 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001116 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001117 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001118 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001119 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001120 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1121 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1122 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1123 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001124 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1125 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1126 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001127 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001128 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1129 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001130 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1131 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1132 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1133 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1134 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1135 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1136 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1137 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1138 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1139 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001140 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1141 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1142 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1143 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1144 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1145 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1146 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1147 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1148 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1149 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1150 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1151 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1152 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1153 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001154 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001155 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001156 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001157 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001158 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1159 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1160 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001161 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1162 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1163 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001164 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001165 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1166 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1167 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1168 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1169 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1170 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1171 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1172 case SQLITE_CONSTRAINT_FOREIGNKEY:
1173 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1174 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1175 case SQLITE_CONSTRAINT_PRIMARYKEY:
1176 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1177 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1178 case SQLITE_CONSTRAINT_COMMITHOOK:
1179 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1180 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1181 case SQLITE_CONSTRAINT_FUNCTION:
1182 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001183 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001184 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1185 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1186 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1187 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1188 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1189 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1190 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1191 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1192 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001193 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1194 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1195 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001196 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001197 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001198 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001199 }
1200 }
mistachkin10269dc2013-04-30 07:54:42 +00001201 if( zName==0 ){
1202 static char zBuf[50];
1203 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1204 zName = zBuf;
1205 }
mistachkinf2c1c992013-04-28 01:44:43 +00001206 return zName;
1207}
mistachkin10269dc2013-04-30 07:54:42 +00001208#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001209
1210/*
drhc22bd472002-05-10 13:14:07 +00001211** Return a static string that describes the kind of error specified in the
1212** argument.
drh247be432002-05-10 05:44:55 +00001213*/
danielk1977f20b21c2004-05-31 23:56:42 +00001214const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001215 static const char* const aMsg[] = {
1216 /* SQLITE_OK */ "not an error",
1217 /* SQLITE_ERROR */ "SQL logic error or missing database",
1218 /* SQLITE_INTERNAL */ 0,
1219 /* SQLITE_PERM */ "access permission denied",
1220 /* SQLITE_ABORT */ "callback requested query abort",
1221 /* SQLITE_BUSY */ "database is locked",
1222 /* SQLITE_LOCKED */ "database table is locked",
1223 /* SQLITE_NOMEM */ "out of memory",
1224 /* SQLITE_READONLY */ "attempt to write a readonly database",
1225 /* SQLITE_INTERRUPT */ "interrupted",
1226 /* SQLITE_IOERR */ "disk I/O error",
1227 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001228 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001229 /* SQLITE_FULL */ "database or disk is full",
1230 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001231 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001232 /* SQLITE_EMPTY */ "table contains no data",
1233 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001234 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001235 /* SQLITE_CONSTRAINT */ "constraint failed",
1236 /* SQLITE_MISMATCH */ "datatype mismatch",
1237 /* SQLITE_MISUSE */ "library routine called out of sequence",
1238 /* SQLITE_NOLFS */ "large file support is disabled",
1239 /* SQLITE_AUTH */ "authorization denied",
1240 /* SQLITE_FORMAT */ "auxiliary database format error",
1241 /* SQLITE_RANGE */ "bind or column index out of range",
1242 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1243 };
drh21021a52012-02-13 17:01:51 +00001244 const char *zErr = "unknown error";
1245 switch( rc ){
1246 case SQLITE_ABORT_ROLLBACK: {
1247 zErr = "abort due to ROLLBACK";
1248 break;
1249 }
1250 default: {
1251 rc &= 0xff;
1252 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1253 zErr = aMsg[rc];
1254 }
1255 break;
1256 }
drh247be432002-05-10 05:44:55 +00001257 }
drh21021a52012-02-13 17:01:51 +00001258 return zErr;
drh247be432002-05-10 05:44:55 +00001259}
1260
1261/*
drh2dfbbca2000-07-28 14:32:48 +00001262** This routine implements a busy callback that sleeps and tries
1263** again until a timeout value is reached. The timeout value is
1264** an integer number of milliseconds passed in as the first
1265** argument.
1266*/
drhdaffd0e2001-04-11 14:28:42 +00001267static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001268 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001269 int count /* Number of times table has been busy */
1270){
danielk197729bafea2008-06-26 10:41:19 +00001271#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001272 static const u8 delays[] =
1273 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1274 static const u8 totals[] =
1275 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001276# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001277 sqlite3 *db = (sqlite3 *)ptr;
1278 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001279 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001280
drhee570fa2005-04-28 12:06:05 +00001281 assert( count>=0 );
1282 if( count < NDELAY ){
1283 delay = delays[count];
1284 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001285 }else{
1286 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001287 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001288 }
drhd1bec472004-01-15 13:29:31 +00001289 if( prior + delay > timeout ){
1290 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001291 if( delay<=0 ) return 0;
1292 }
danielk19772a6bdf62007-08-20 16:07:00 +00001293 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001294 return 1;
1295#else
drh482ea182007-08-20 11:12:40 +00001296 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001297 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001298 if( (count+1)*1000 > timeout ){
1299 return 0;
1300 }
drh482ea182007-08-20 11:12:40 +00001301 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001302 return 1;
1303#endif
1304}
1305
1306/*
drha4afb652005-07-09 02:16:02 +00001307** Invoke the given busy handler.
1308**
1309** This routine is called when an operation failed with a lock.
1310** If this routine returns non-zero, the lock is retried. If it
1311** returns 0, the operation aborts with an SQLITE_BUSY error.
1312*/
1313int sqlite3InvokeBusyHandler(BusyHandler *p){
1314 int rc;
drh34004ce2008-07-11 16:15:17 +00001315 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001316 rc = p->xFunc(p->pArg, p->nBusy);
1317 if( rc==0 ){
1318 p->nBusy = -1;
1319 }else{
1320 p->nBusy++;
1321 }
1322 return rc;
1323}
1324
1325/*
drh2dfbbca2000-07-28 14:32:48 +00001326** This routine sets the busy callback for an Sqlite database to the
1327** given callback function with the given argument.
1328*/
danielk1977f9d64d22004-06-19 08:18:07 +00001329int sqlite3_busy_handler(
1330 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001331 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001332 void *pArg
1333){
drh9ca95732014-10-24 00:35:58 +00001334#ifdef SQLITE_ENABLE_API_ARMOR
1335 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE;
1336#endif
drhe30f4422007-08-21 16:15:55 +00001337 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001338 db->busyHandler.xFunc = xBusy;
1339 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001340 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001341 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001342 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001343 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001344}
1345
danielk1977348bb5d2003-10-18 09:37:26 +00001346#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1347/*
1348** This routine sets the progress callback for an Sqlite database to the
1349** given callback function with the given argument. The progress callback will
1350** be invoked every nOps opcodes.
1351*/
danielk197724b03fd2004-05-10 10:34:34 +00001352void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001353 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001354 int nOps,
1355 int (*xProgress)(void*),
1356 void *pArg
1357){
drh9ca95732014-10-24 00:35:58 +00001358#ifdef SQLITE_ENABLE_API_ARMOR
1359 if( !sqlite3SafetyCheckOk(db) ){
1360 (void)SQLITE_MISUSE_BKPT;
1361 return;
1362 }
1363#endif
drhbd0b1b52008-07-07 19:52:09 +00001364 sqlite3_mutex_enter(db->mutex);
1365 if( nOps>0 ){
1366 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001367 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001368 db->pProgressArg = pArg;
1369 }else{
1370 db->xProgress = 0;
1371 db->nProgressOps = 0;
1372 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001373 }
drhbd0b1b52008-07-07 19:52:09 +00001374 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001375}
1376#endif
1377
1378
drh2dfbbca2000-07-28 14:32:48 +00001379/*
1380** This routine installs a default busy handler that waits for the
1381** specified number of milliseconds before returning 0.
1382*/
danielk1977f9d64d22004-06-19 08:18:07 +00001383int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001384#ifdef SQLITE_ENABLE_API_ARMOR
1385 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1386#endif
drh2dfbbca2000-07-28 14:32:48 +00001387 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001388 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001389 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001390 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001391 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001392 }
danielk1977f9d64d22004-06-19 08:18:07 +00001393 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001394}
drh4c504392000-10-16 22:06:40 +00001395
1396/*
1397** Cause any pending operation to stop at its earliest opportunity.
1398*/
drh9bb575f2004-09-06 17:24:11 +00001399void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001400#ifdef SQLITE_ENABLE_API_ARMOR
1401 if( !sqlite3SafetyCheckOk(db) ){
1402 (void)SQLITE_MISUSE_BKPT;
1403 return;
1404 }
1405#endif
drhbd0b1b52008-07-07 19:52:09 +00001406 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001407}
drhfa86c412002-02-02 15:01:15 +00001408
drhfa86c412002-02-02 15:01:15 +00001409
1410/*
danielk1977771151b2006-01-17 13:21:40 +00001411** This function is exactly the same as sqlite3_create_function(), except
1412** that it is designed to be called by internal code. The difference is
1413** that if a malloc() fails in sqlite3_create_function(), an error code
1414** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001415*/
danielk1977771151b2006-01-17 13:21:40 +00001416int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001417 sqlite3 *db,
1418 const char *zFunctionName,
1419 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001420 int enc,
danielk197765904932004-05-26 06:18:37 +00001421 void *pUserData,
1422 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1423 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001424 void (*xFinal)(sqlite3_context*),
1425 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001426){
drh0bce8352002-02-28 00:41:10 +00001427 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001428 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001429 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001430
drhe30f4422007-08-21 16:15:55 +00001431 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001432 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001433 (xFunc && (xFinal || xStep)) ||
1434 (!xFunc && (xFinal && !xStep)) ||
1435 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001436 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001437 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001438 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001439 }
drh4a8ee3d2013-12-14 13:44:22 +00001440
1441 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1442 extraFlags = enc & SQLITE_DETERMINISTIC;
1443 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001444
danielk197793758c82005-01-21 08:13:14 +00001445#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001446 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1447 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1448 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1449 **
1450 ** If SQLITE_ANY is specified, add three versions of the function
1451 ** to the hash table.
1452 */
1453 if( enc==SQLITE_UTF16 ){
1454 enc = SQLITE_UTF16NATIVE;
1455 }else if( enc==SQLITE_ANY ){
1456 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001457 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dand2199f02010-08-27 17:48:52 +00001458 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001459 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001460 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dand2199f02010-08-27 17:48:52 +00001461 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001462 }
1463 if( rc!=SQLITE_OK ){
1464 return rc;
1465 }
danielk1977d8123362004-06-12 09:25:12 +00001466 enc = SQLITE_UTF16BE;
1467 }
danielk197793758c82005-01-21 08:13:14 +00001468#else
1469 enc = SQLITE_UTF8;
1470#endif
danielk19779636c4e2005-01-25 04:27:54 +00001471
1472 /* Check if an existing function is being overridden or deleted. If so,
1473 ** and there are active VMs, then return SQLITE_BUSY. If a function
1474 ** is being overridden/deleted but there are no active VMs, allow the
1475 ** operation to continue but invalidate all precompiled statements.
1476 */
drh3abbd392008-12-10 23:04:13 +00001477 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001478 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001479 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001480 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001481 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001482 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001483 return SQLITE_BUSY;
1484 }else{
1485 sqlite3ExpirePreparedStatements(db);
1486 }
1487 }
danielk197765904932004-05-26 06:18:37 +00001488
drh3abbd392008-12-10 23:04:13 +00001489 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001490 assert(p || db->mallocFailed);
1491 if( !p ){
1492 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001493 }
dand2199f02010-08-27 17:48:52 +00001494
1495 /* If an older version of the function with a configured destructor is
1496 ** being replaced invoke the destructor function here. */
1497 functionDestroy(db, p);
1498
1499 if( pDestructor ){
1500 pDestructor->nRef++;
1501 }
1502 p->pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001503 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1504 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
danielk1977fa18bec2007-09-03 11:04:22 +00001505 p->xFunc = xFunc;
1506 p->xStep = xStep;
1507 p->xFinalize = xFinal;
1508 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001509 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001510 return SQLITE_OK;
1511}
danielk1977771151b2006-01-17 13:21:40 +00001512
1513/*
1514** Create new user functions.
1515*/
1516int sqlite3_create_function(
1517 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001518 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001519 int nArg,
1520 int enc,
1521 void *p,
1522 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1523 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1524 void (*xFinal)(sqlite3_context*)
1525){
drh7b19fac2010-08-27 18:44:54 +00001526 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1527 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001528}
1529
1530int sqlite3_create_function_v2(
1531 sqlite3 *db,
1532 const char *zFunc,
1533 int nArg,
1534 int enc,
1535 void *p,
1536 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1537 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1538 void (*xFinal)(sqlite3_context*),
1539 void (*xDestroy)(void *)
1540){
shanehbd2aaf92010-09-01 02:38:21 +00001541 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001542 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001543
1544#ifdef SQLITE_ENABLE_API_ARMOR
1545 if( !sqlite3SafetyCheckOk(db) ){
1546 return SQLITE_MISUSE_BKPT;
1547 }
1548#endif
dand2199f02010-08-27 17:48:52 +00001549 sqlite3_mutex_enter(db->mutex);
1550 if( xDestroy ){
1551 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001552 if( !pArg ){
1553 xDestroy(p);
1554 goto out;
1555 }
dand2199f02010-08-27 17:48:52 +00001556 pArg->xDestroy = xDestroy;
1557 pArg->pUserData = p;
1558 }
1559 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1560 if( pArg && pArg->nRef==0 ){
1561 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001562 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001563 sqlite3DbFree(db, pArg);
1564 }
1565
1566 out:
drhe30f4422007-08-21 16:15:55 +00001567 rc = sqlite3ApiExit(db, rc);
1568 sqlite3_mutex_leave(db->mutex);
1569 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001570}
1571
danielk197793758c82005-01-21 08:13:14 +00001572#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001573int sqlite3_create_function16(
1574 sqlite3 *db,
1575 const void *zFunctionName,
1576 int nArg,
1577 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001578 void *p,
danielk197765904932004-05-26 06:18:37 +00001579 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1580 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1581 void (*xFinal)(sqlite3_context*)
1582){
1583 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001584 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001585
1586#ifdef SQLITE_ENABLE_API_ARMOR
1587 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1588#endif
drhe30f4422007-08-21 16:15:55 +00001589 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001590 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001591 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001592 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001593 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001594 rc = sqlite3ApiExit(db, rc);
1595 sqlite3_mutex_leave(db->mutex);
1596 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001597}
danielk197793758c82005-01-21 08:13:14 +00001598#endif
drhc9b84a12002-06-20 11:36:48 +00001599
drhb7481e72006-09-16 21:45:14 +00001600
1601/*
1602** Declare that a function has been overloaded by a virtual table.
1603**
1604** If the function already exists as a regular global function, then
1605** this routine is a no-op. If the function does not exist, then create
1606** a new one that always throws a run-time error.
1607**
1608** When virtual tables intend to provide an overloaded function, they
1609** should call this routine to make sure the global function exists.
1610** A global function must exist in order for name resolution to work
1611** properly.
1612*/
1613int sqlite3_overload_function(
1614 sqlite3 *db,
1615 const char *zName,
1616 int nArg
1617){
drhdee0e402009-05-03 20:23:53 +00001618 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001619 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001620
1621#ifdef SQLITE_ENABLE_API_ARMOR
1622 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1623 return SQLITE_MISUSE_BKPT;
1624 }
1625#endif
drhe30f4422007-08-21 16:15:55 +00001626 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001627 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001628 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1629 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001630 }
drhcb5e4db2011-10-12 23:49:49 +00001631 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001632 sqlite3_mutex_leave(db->mutex);
1633 return rc;
drhb7481e72006-09-16 21:45:14 +00001634}
1635
drh19e2d372005-08-29 23:00:03 +00001636#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001637/*
drh18de4822003-01-16 16:28:53 +00001638** Register a trace function. The pArg from the previously registered trace
1639** is returned.
1640**
1641** A NULL trace function means that no tracing is executes. A non-NULL
1642** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001643** SQL statement.
drh18de4822003-01-16 16:28:53 +00001644*/
drh9bb575f2004-09-06 17:24:11 +00001645void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001646 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001647
1648#ifdef SQLITE_ENABLE_API_ARMOR
1649 if( !sqlite3SafetyCheckOk(db) ){
1650 (void)SQLITE_MISUSE_BKPT;
1651 return 0;
1652 }
1653#endif
drhe30f4422007-08-21 16:15:55 +00001654 sqlite3_mutex_enter(db->mutex);
1655 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001656 db->xTrace = xTrace;
1657 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001658 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001659 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001660}
drh19e2d372005-08-29 23:00:03 +00001661/*
1662** Register a profile function. The pArg from the previously registered
1663** profile function is returned.
1664**
1665** A NULL profile function means that no profiling is executes. A non-NULL
1666** profile is a pointer to a function that is invoked at the conclusion of
1667** each SQL statement that is run.
1668*/
1669void *sqlite3_profile(
1670 sqlite3 *db,
1671 void (*xProfile)(void*,const char*,sqlite_uint64),
1672 void *pArg
1673){
drhe30f4422007-08-21 16:15:55 +00001674 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001675
1676#ifdef SQLITE_ENABLE_API_ARMOR
1677 if( !sqlite3SafetyCheckOk(db) ){
1678 (void)SQLITE_MISUSE_BKPT;
1679 return 0;
1680 }
1681#endif
drhe30f4422007-08-21 16:15:55 +00001682 sqlite3_mutex_enter(db->mutex);
1683 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001684 db->xProfile = xProfile;
1685 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001686 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001687 return pOld;
1688}
1689#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001690
drhcd565fd2012-03-01 21:30:44 +00001691/*
1692** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001693** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001694** rollback.
1695*/
danielk197724b03fd2004-05-10 10:34:34 +00001696void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001697 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001698 int (*xCallback)(void*), /* Function to invoke on each commit */
1699 void *pArg /* Argument to the function */
1700){
drhe30f4422007-08-21 16:15:55 +00001701 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001702
1703#ifdef SQLITE_ENABLE_API_ARMOR
1704 if( !sqlite3SafetyCheckOk(db) ){
1705 (void)SQLITE_MISUSE_BKPT;
1706 return 0;
1707 }
1708#endif
drhe30f4422007-08-21 16:15:55 +00001709 sqlite3_mutex_enter(db->mutex);
1710 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001711 db->xCommitCallback = xCallback;
1712 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001713 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001714 return pOld;
1715}
1716
danielk197794eb6a12005-12-15 15:22:08 +00001717/*
1718** Register a callback to be invoked each time a row is updated,
1719** inserted or deleted using this database connection.
1720*/
danielk197771fd80b2005-12-16 06:54:01 +00001721void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001722 sqlite3 *db, /* Attach the hook to this database */
1723 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1724 void *pArg /* Argument to the function */
1725){
drhe30f4422007-08-21 16:15:55 +00001726 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001727
1728#ifdef SQLITE_ENABLE_API_ARMOR
1729 if( !sqlite3SafetyCheckOk(db) ){
1730 (void)SQLITE_MISUSE_BKPT;
1731 return 0;
1732 }
1733#endif
drhe30f4422007-08-21 16:15:55 +00001734 sqlite3_mutex_enter(db->mutex);
1735 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001736 db->xUpdateCallback = xCallback;
1737 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001738 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001739 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001740}
1741
danielk197771fd80b2005-12-16 06:54:01 +00001742/*
1743** Register a callback to be invoked each time a transaction is rolled
1744** back by this database connection.
1745*/
1746void *sqlite3_rollback_hook(
1747 sqlite3 *db, /* Attach the hook to this database */
1748 void (*xCallback)(void*), /* Callback function */
1749 void *pArg /* Argument to the function */
1750){
drhe30f4422007-08-21 16:15:55 +00001751 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001752
1753#ifdef SQLITE_ENABLE_API_ARMOR
1754 if( !sqlite3SafetyCheckOk(db) ){
1755 (void)SQLITE_MISUSE_BKPT;
1756 return 0;
1757 }
1758#endif
drhe30f4422007-08-21 16:15:55 +00001759 sqlite3_mutex_enter(db->mutex);
1760 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001761 db->xRollbackCallback = xCallback;
1762 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001763 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001764 return pRet;
1765}
drhaa940ea2004-01-15 02:44:03 +00001766
dan586b9c82010-05-03 08:04:49 +00001767#ifndef SQLITE_OMIT_WAL
1768/*
1769** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001770** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1771** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001772** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001773*/
drhb033d8b2010-05-03 13:37:30 +00001774int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001775 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001776 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001777 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001778 int nFrame /* Size of WAL */
1779){
drh5def0842010-05-05 20:00:25 +00001780 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001781 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001782 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001783 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001784 }
1785 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001786}
drhb033d8b2010-05-03 13:37:30 +00001787#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001788
1789/*
1790** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1791** a database after committing a transaction if there are nFrame or
1792** more frames in the log file. Passing zero or a negative value as the
1793** nFrame parameter disables automatic checkpoints entirely.
1794**
1795** The callback registered by this function replaces any existing callback
1796** registered using sqlite3_wal_hook(). Likewise, registering a callback
1797** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1798** configured by this function.
1799*/
1800int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001801#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001802 UNUSED_PARAMETER(db);
1803 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001804#else
drh9ca95732014-10-24 00:35:58 +00001805#ifdef SQLITE_ENABLE_API_ARMOR
1806 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1807#endif
dan586b9c82010-05-03 08:04:49 +00001808 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001809 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001810 }else{
1811 sqlite3_wal_hook(db, 0, 0);
1812 }
drhb033d8b2010-05-03 13:37:30 +00001813#endif
dan586b9c82010-05-03 08:04:49 +00001814 return SQLITE_OK;
1815}
1816
paulb0208cc2003-04-13 18:26:49 +00001817/*
dan8d22a172010-04-19 18:03:51 +00001818** Register a callback to be invoked each time a transaction is written
1819** into the write-ahead-log by this database connection.
1820*/
drh833bf962010-04-28 14:42:19 +00001821void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001822 sqlite3 *db, /* Attach the hook to this db handle */
1823 int(*xCallback)(void *, sqlite3*, const char*, int),
1824 void *pArg /* First argument passed to xCallback() */
1825){
drhb033d8b2010-05-03 13:37:30 +00001826#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001827 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001828#ifdef SQLITE_ENABLE_API_ARMOR
1829 if( !sqlite3SafetyCheckOk(db) ){
1830 (void)SQLITE_MISUSE_BKPT;
1831 return 0;
1832 }
1833#endif
dan8d22a172010-04-19 18:03:51 +00001834 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001835 pRet = db->pWalArg;
1836 db->xWalCallback = xCallback;
1837 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001838 sqlite3_mutex_leave(db->mutex);
1839 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001840#else
1841 return 0;
1842#endif
dan8d22a172010-04-19 18:03:51 +00001843}
1844
1845/*
dancdc1f042010-11-18 12:11:05 +00001846** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001847*/
dancdc1f042010-11-18 12:11:05 +00001848int sqlite3_wal_checkpoint_v2(
1849 sqlite3 *db, /* Database handle */
1850 const char *zDb, /* Name of attached database (or NULL) */
1851 int eMode, /* SQLITE_CHECKPOINT_* value */
1852 int *pnLog, /* OUT: Size of WAL log in frames */
1853 int *pnCkpt /* OUT: Total number of frames checkpointed */
1854){
drhb033d8b2010-05-03 13:37:30 +00001855#ifdef SQLITE_OMIT_WAL
1856 return SQLITE_OK;
1857#else
dan586b9c82010-05-03 08:04:49 +00001858 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001859 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001860
drh9ca95732014-10-24 00:35:58 +00001861#ifdef SQLITE_ENABLE_API_ARMOR
1862 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1863#endif
1864
dan9c5e3682011-02-07 15:12:12 +00001865 /* Initialize the output variables to -1 in case an error occurs. */
1866 if( pnLog ) *pnLog = -1;
1867 if( pnCkpt ) *pnCkpt = -1;
1868
drh383d79e2011-02-09 03:03:16 +00001869 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1870 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1871 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1872 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001873 return SQLITE_MISUSE;
1874 }
1875
dan586b9c82010-05-03 08:04:49 +00001876 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001877 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001878 iDb = sqlite3FindDbName(db, zDb);
1879 }
1880 if( iDb<0 ){
1881 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00001882 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001883 }else{
dancdc1f042010-11-18 12:11:05 +00001884 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00001885 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00001886 }
drhb033d8b2010-05-03 13:37:30 +00001887 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001888 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001889 return rc;
1890#endif
dan586b9c82010-05-03 08:04:49 +00001891}
1892
dancdc1f042010-11-18 12:11:05 +00001893
1894/*
1895** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1896** to contains a zero-length string, all attached databases are
1897** checkpointed.
1898*/
1899int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1900 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1901}
1902
drhb033d8b2010-05-03 13:37:30 +00001903#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001904/*
1905** Run a checkpoint on database iDb. This is a no-op if database iDb is
1906** not currently open in WAL mode.
1907**
dan6fcff072010-05-03 14:05:43 +00001908** If a transaction is open on the database being checkpointed, this
1909** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1910** an error occurs while running the checkpoint, an SQLite error code is
1911** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001912**
1913** The mutex on database handle db should be held by the caller. The mutex
1914** associated with the specific b-tree being checkpointed is taken by
1915** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001916**
1917** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1918** checkpointed. If an error is encountered it is returned immediately -
1919** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001920**
dancdc1f042010-11-18 12:11:05 +00001921** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001922*/
dancdc1f042010-11-18 12:11:05 +00001923int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001924 int rc = SQLITE_OK; /* Return code */
1925 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001926 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001927
1928 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001929 assert( !pnLog || *pnLog==-1 );
1930 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001931
dan6fcff072010-05-03 14:05:43 +00001932 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1933 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001934 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001935 pnLog = 0;
1936 pnCkpt = 0;
1937 if( rc==SQLITE_BUSY ){
1938 bBusy = 1;
1939 rc = SQLITE_OK;
1940 }
dan6fcff072010-05-03 14:05:43 +00001941 }
dan586b9c82010-05-03 08:04:49 +00001942 }
1943
danf2b8dd52010-11-18 19:28:01 +00001944 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001945}
drhb033d8b2010-05-03 13:37:30 +00001946#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001947
1948/*
danielk1977d8293352009-04-30 09:10:37 +00001949** This function returns true if main-memory should be used instead of
1950** a temporary file for transient pager files and statement journals.
1951** The value returned depends on the value of db->temp_store (runtime
1952** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1953** following table describes the relationship between these two values
1954** and this functions return value.
1955**
1956** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1957** ----------------- -------------- ------------------------------
1958** 0 any file (return 0)
1959** 1 1 file (return 0)
1960** 1 2 memory (return 1)
1961** 1 0 file (return 0)
1962** 2 1 file (return 0)
1963** 2 2 memory (return 1)
1964** 2 0 memory (return 1)
1965** 3 any memory (return 1)
1966*/
drh1c514142009-04-30 12:25:10 +00001967int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001968#if SQLITE_TEMP_STORE==1
1969 return ( db->temp_store==2 );
1970#endif
1971#if SQLITE_TEMP_STORE==2
1972 return ( db->temp_store!=1 );
1973#endif
1974#if SQLITE_TEMP_STORE==3
1975 return 1;
shanecf697392009-06-01 16:53:09 +00001976#endif
1977#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001978 return 0;
shane60a4b532009-05-06 18:57:09 +00001979#endif
danielk1977d8293352009-04-30 09:10:37 +00001980}
1981
1982/*
danielk19774ad17132004-05-21 01:47:26 +00001983** Return UTF-8 encoded English language explanation of the most recent
1984** error.
1985*/
danielk19776622cce2004-05-20 11:00:52 +00001986const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001987 const char *z;
drhf49661a2008-12-10 16:45:50 +00001988 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001989 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001990 }
drhd55d57e2008-07-07 17:53:07 +00001991 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001992 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001993 }
drh27641702007-08-22 02:56:42 +00001994 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001995 if( db->mallocFailed ){
1996 z = sqlite3ErrStr(SQLITE_NOMEM);
1997 }else{
drha3cc0072013-12-13 16:23:55 +00001998 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00001999 z = (char*)sqlite3_value_text(db->pErr);
2000 assert( !db->mallocFailed );
2001 if( z==0 ){
2002 z = sqlite3ErrStr(db->errCode);
2003 }
danielk19776622cce2004-05-20 11:00:52 +00002004 }
drhe30f4422007-08-21 16:15:55 +00002005 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002006 return z;
danielk19776622cce2004-05-20 11:00:52 +00002007}
2008
drh6c626082004-11-14 21:56:29 +00002009#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002010/*
2011** Return UTF-16 encoded English language explanation of the most recent
2012** error.
2013*/
danielk19776622cce2004-05-20 11:00:52 +00002014const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002015 static const u16 outOfMem[] = {
2016 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002017 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002018 static const u16 misuse[] = {
2019 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2020 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2021 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2022 'o', 'u', 't', ' ',
2023 'o', 'f', ' ',
2024 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002025 };
danielk19774ad17132004-05-21 01:47:26 +00002026
drhc60d0442004-09-30 13:43:13 +00002027 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002028 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002029 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002030 }
drhd55d57e2008-07-07 17:53:07 +00002031 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002032 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002033 }
drhe30f4422007-08-21 16:15:55 +00002034 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002035 if( db->mallocFailed ){
2036 z = (void *)outOfMem;
2037 }else{
drhc60d0442004-09-30 13:43:13 +00002038 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002039 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002040 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002041 z = sqlite3_value_text16(db->pErr);
2042 }
2043 /* A malloc() may have failed within the call to sqlite3_value_text16()
2044 ** above. If this is the case, then the db->mallocFailed flag needs to
2045 ** be cleared before returning. Do this directly, instead of via
2046 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2047 */
2048 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00002049 }
drhe30f4422007-08-21 16:15:55 +00002050 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002051 return z;
danielk19776622cce2004-05-20 11:00:52 +00002052}
drh6c626082004-11-14 21:56:29 +00002053#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002054
drhc60d0442004-09-30 13:43:13 +00002055/*
danielk19777ddad962005-12-12 06:53:03 +00002056** Return the most recent error code generated by an SQLite routine. If NULL is
2057** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002058*/
danielk19776622cce2004-05-20 11:00:52 +00002059int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002060 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002061 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002062 }
drh01495b92008-01-23 12:52:40 +00002063 if( !db || db->mallocFailed ){
2064 return SQLITE_NOMEM;
2065 }
drh4ac285a2006-09-15 07:28:50 +00002066 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002067}
drh99dfe5e2008-10-30 15:03:15 +00002068int sqlite3_extended_errcode(sqlite3 *db){
2069 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002070 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002071 }
2072 if( !db || db->mallocFailed ){
2073 return SQLITE_NOMEM;
2074 }
2075 return db->errCode;
2076}
danielk19776622cce2004-05-20 11:00:52 +00002077
drh0e819f92006-02-01 13:50:41 +00002078/*
mistachkin5dac8432012-09-11 02:00:25 +00002079** Return a string that describes the kind of error specified in the
2080** argument. For now, this simply calls the internal sqlite3ErrStr()
2081** function.
2082*/
2083const char *sqlite3_errstr(int rc){
2084 return sqlite3ErrStr(rc);
2085}
2086
2087/*
drh41e13e12013-11-07 14:09:39 +00002088** Invalidate all cached KeyInfo objects for database connection "db"
2089*/
2090static void invalidateCachedKeyInfo(sqlite3 *db){
2091 Db *pDb; /* A single database */
2092 int iDb; /* The database index number */
2093 HashElem *k; /* For looping over tables in pDb */
2094 Table *pTab; /* A table in the database */
2095 Index *pIdx; /* Each index */
2096
2097 for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
2098 if( pDb->pBt==0 ) continue;
2099 sqlite3BtreeEnter(pDb->pBt);
2100 for(k=sqliteHashFirst(&pDb->pSchema->tblHash); k; k=sqliteHashNext(k)){
2101 pTab = (Table*)sqliteHashData(k);
2102 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
2103 if( pIdx->pKeyInfo && pIdx->pKeyInfo->db==db ){
2104 sqlite3KeyInfoUnref(pIdx->pKeyInfo);
2105 pIdx->pKeyInfo = 0;
2106 }
2107 }
2108 }
2109 sqlite3BtreeLeave(pDb->pBt);
2110 }
2111}
2112
2113/*
drh0e819f92006-02-01 13:50:41 +00002114** Create a new collating function for database "db". The name is zName
2115** and the encoding is enc.
2116*/
danielk19779a30cf62006-01-18 04:26:07 +00002117static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002118 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002119 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002120 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002121 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002122 int(*xCompare)(void*,int,const void*,int,const void*),
2123 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002124){
2125 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002126 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002127
drhe30f4422007-08-21 16:15:55 +00002128 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002129
2130 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2131 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2132 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2133 */
drh51c7d862009-04-27 18:46:06 +00002134 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002135 testcase( enc2==SQLITE_UTF16 );
2136 testcase( enc2==SQLITE_UTF16_ALIGNED );
2137 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002138 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002139 }
drh51c7d862009-04-27 18:46:06 +00002140 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002141 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002142 }
2143
2144 /* Check if this call is removing or replacing an existing collation
2145 ** sequence. If so, and there are active VMs, return busy. If there
2146 ** are no active VMs, invalidate any pre-compiled statements.
2147 */
drhc4a64fa2009-05-11 20:53:28 +00002148 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002149 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002150 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002151 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002152 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002153 return SQLITE_BUSY;
2154 }
2155 sqlite3ExpirePreparedStatements(db);
drh41e13e12013-11-07 14:09:39 +00002156 invalidateCachedKeyInfo(db);
danielk1977a9808b32007-05-07 09:32:45 +00002157
2158 /* If collation sequence pColl was created directly by a call to
2159 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2160 ** then any copies made by synthCollSeq() need to be invalidated.
2161 ** Also, collation destructor - CollSeq.xDel() - function may need
2162 ** to be called.
2163 */
2164 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002165 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002166 int j;
2167 for(j=0; j<3; j++){
2168 CollSeq *p = &aColl[j];
2169 if( p->enc==pColl->enc ){
2170 if( p->xDel ){
2171 p->xDel(p->pUser);
2172 }
2173 p->xCmp = 0;
2174 }
2175 }
2176 }
danielk19779a30cf62006-01-18 04:26:07 +00002177 }
2178
drhc4a64fa2009-05-11 20:53:28 +00002179 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002180 if( pColl==0 ) return SQLITE_NOMEM;
2181 pColl->xCmp = xCompare;
2182 pColl->pUser = pCtx;
2183 pColl->xDel = xDel;
2184 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002185 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002186 return SQLITE_OK;
2187}
2188
2189
danielk19776622cce2004-05-20 11:00:52 +00002190/*
drhbb4957f2008-03-20 14:03:29 +00002191** This array defines hard upper bounds on limit values. The
2192** initializer must be kept in sync with the SQLITE_LIMIT_*
2193** #defines in sqlite3.h.
2194*/
drhb1a6c3c2008-03-20 16:30:17 +00002195static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002196 SQLITE_MAX_LENGTH,
2197 SQLITE_MAX_SQL_LENGTH,
2198 SQLITE_MAX_COLUMN,
2199 SQLITE_MAX_EXPR_DEPTH,
2200 SQLITE_MAX_COMPOUND_SELECT,
2201 SQLITE_MAX_VDBE_OP,
2202 SQLITE_MAX_FUNCTION_ARG,
2203 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002204 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002205 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002206 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002207 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002208};
2209
2210/*
2211** Make sure the hard limits are set to reasonable values
2212*/
2213#if SQLITE_MAX_LENGTH<100
2214# error SQLITE_MAX_LENGTH must be at least 100
2215#endif
2216#if SQLITE_MAX_SQL_LENGTH<100
2217# error SQLITE_MAX_SQL_LENGTH must be at least 100
2218#endif
2219#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2220# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2221#endif
drhbb4957f2008-03-20 14:03:29 +00002222#if SQLITE_MAX_COMPOUND_SELECT<2
2223# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2224#endif
2225#if SQLITE_MAX_VDBE_OP<40
2226# error SQLITE_MAX_VDBE_OP must be at least 40
2227#endif
drhe82f5d02008-10-07 19:53:14 +00002228#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2229# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002230#endif
drhd08b2792014-07-22 15:33:31 +00002231#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2232# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002233#endif
drhbb4957f2008-03-20 14:03:29 +00002234#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2235# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2236#endif
drh70a8ca32008-08-21 18:49:27 +00002237#if SQLITE_MAX_COLUMN>32767
2238# error SQLITE_MAX_COLUMN must not exceed 32767
2239#endif
drh417168a2009-09-07 18:14:02 +00002240#if SQLITE_MAX_TRIGGER_DEPTH<1
2241# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2242#endif
drh111544c2014-08-29 16:20:47 +00002243#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2244# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2245#endif
drhbb4957f2008-03-20 14:03:29 +00002246
2247
2248/*
2249** Change the value of a limit. Report the old value.
2250** If an invalid limit index is supplied, report -1.
2251** Make no changes but still report the old value if the
2252** new limit is negative.
2253**
2254** A new lower limit does not shrink existing constructs.
2255** It merely prevents new constructs that exceed the limit
2256** from forming.
2257*/
2258int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2259 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002260
drh9ca95732014-10-24 00:35:58 +00002261#ifdef SQLITE_ENABLE_API_ARMOR
2262 if( !sqlite3SafetyCheckOk(db) ){
2263 (void)SQLITE_MISUSE_BKPT;
2264 return -1;
2265 }
2266#endif
drh4e93f5b2010-09-07 14:59:15 +00002267
2268 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2269 ** there is a hard upper bound set at compile-time by a C preprocessor
2270 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2271 ** "_MAX_".)
2272 */
2273 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2274 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2275 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2276 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2277 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2278 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2279 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2280 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2281 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2282 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2283 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2284 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002285 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2286 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002287
2288
drh521cc842008-04-15 02:36:33 +00002289 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002290 return -1;
2291 }
2292 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002293 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002294 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002295 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002296 }
2297 db->aLimit[limitId] = newLimit;
2298 }
drh4e93f5b2010-09-07 14:59:15 +00002299 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002300}
2301
2302/*
dan286ab7c2011-05-06 18:34:54 +00002303** This function is used to parse both URIs and non-URI filenames passed by the
2304** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2305** URIs specified as part of ATTACH statements.
2306**
2307** The first argument to this function is the name of the VFS to use (or
2308** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2309** query parameter. The second argument contains the URI (or non-URI filename)
2310** itself. When this function is called the *pFlags variable should contain
2311** the default flags to open the database handle with. The value stored in
2312** *pFlags may be updated before returning if the URI filename contains
2313** "cache=xxx" or "mode=xxx" query parameters.
2314**
2315** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2316** the VFS that should be used to open the database file. *pzFile is set to
2317** point to a buffer containing the name of the file to open. It is the
2318** responsibility of the caller to eventually call sqlite3_free() to release
2319** this buffer.
2320**
2321** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2322** may be set to point to a buffer containing an English language error
2323** message. It is the responsibility of the caller to eventually release
2324** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002325*/
2326int sqlite3ParseUri(
2327 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2328 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002329 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002330 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2331 char **pzFile, /* OUT: Filename component of URI */
2332 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2333){
dan78e9dd22011-05-03 10:22:32 +00002334 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002335 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002336 const char *zVfs = zDefaultVfs;
2337 char *zFile;
drhde941c32011-05-09 19:20:17 +00002338 char c;
dancd74b612011-04-22 19:37:32 +00002339 int nUri = sqlite3Strlen30(zUri);
2340
2341 assert( *pzErrMsg==0 );
2342
2343 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
drh00729cb2014-10-04 11:59:33 +00002344 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002345 ){
dan5de15372011-04-23 10:12:30 +00002346 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002347 int eState; /* Parser state when parsing URI */
2348 int iIn; /* Input character index */
2349 int iOut = 0; /* Output character index */
2350 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002351
dan286ab7c2011-05-06 18:34:54 +00002352 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2353 ** method that there may be extra parameters following the file-name. */
2354 flags |= SQLITE_OPEN_URI;
2355
2356 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002357 zFile = sqlite3_malloc(nByte);
2358 if( !zFile ) return SQLITE_NOMEM;
2359
drh869c0402013-08-07 23:15:52 +00002360 iIn = 5;
2361#ifndef SQLITE_ALLOW_URI_AUTHORITY
dancd74b612011-04-22 19:37:32 +00002362 /* Discard the scheme and authority segments of the URI. */
2363 if( zUri[5]=='/' && zUri[6]=='/' ){
2364 iIn = 7;
2365 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002366 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2367 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2368 iIn-7, &zUri[7]);
2369 rc = SQLITE_ERROR;
2370 goto parse_uri_out;
2371 }
dancd74b612011-04-22 19:37:32 +00002372 }
drh869c0402013-08-07 23:15:52 +00002373#endif
dancd74b612011-04-22 19:37:32 +00002374
2375 /* Copy the filename and any query parameters into the zFile buffer.
2376 ** Decode %HH escape codes along the way.
2377 **
2378 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2379 ** on the parsing context. As follows:
2380 **
2381 ** 0: Parsing file-name.
2382 ** 1: Parsing name section of a name=value query parameter.
2383 ** 2: Parsing value section of a name=value query parameter.
2384 */
2385 eState = 0;
drhde941c32011-05-09 19:20:17 +00002386 while( (c = zUri[iIn])!=0 && c!='#' ){
2387 iIn++;
dancd74b612011-04-22 19:37:32 +00002388 if( c=='%'
2389 && sqlite3Isxdigit(zUri[iIn])
2390 && sqlite3Isxdigit(zUri[iIn+1])
2391 ){
dan6d49e252011-05-03 15:09:05 +00002392 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2393 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002394
dan6d49e252011-05-03 15:09:05 +00002395 assert( octet>=0 && octet<256 );
2396 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002397 /* This branch is taken when "%00" appears within the URI. In this
2398 ** case we ignore all text in the remainder of the path, name or
2399 ** value currently being parsed. So ignore the current character
2400 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002401 while( (c = zUri[iIn])!=0 && c!='#'
2402 && (eState!=0 || c!='?')
2403 && (eState!=1 || (c!='=' && c!='&'))
2404 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002405 ){
2406 iIn++;
2407 }
2408 continue;
dancd74b612011-04-22 19:37:32 +00002409 }
dan6d49e252011-05-03 15:09:05 +00002410 c = octet;
dan5de15372011-04-23 10:12:30 +00002411 }else if( eState==1 && (c=='&' || c=='=') ){
2412 if( zFile[iOut-1]==0 ){
2413 /* An empty option name. Ignore this option altogether. */
2414 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2415 continue;
2416 }
2417 if( c=='&' ){
2418 zFile[iOut++] = '\0';
2419 }else{
2420 eState = 2;
2421 }
dancd74b612011-04-22 19:37:32 +00002422 c = 0;
dan5de15372011-04-23 10:12:30 +00002423 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2424 c = 0;
dancd74b612011-04-22 19:37:32 +00002425 eState = 1;
dancd74b612011-04-22 19:37:32 +00002426 }
2427 zFile[iOut++] = c;
2428 }
2429 if( eState==1 ) zFile[iOut++] = '\0';
2430 zFile[iOut++] = '\0';
2431 zFile[iOut++] = '\0';
2432
2433 /* Check if there were any options specified that should be interpreted
2434 ** here. Options that are interpreted here include "vfs" and those that
2435 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002436 ** method. */
dan5de15372011-04-23 10:12:30 +00002437 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2438 while( zOpt[0] ){
2439 int nOpt = sqlite3Strlen30(zOpt);
2440 char *zVal = &zOpt[nOpt+1];
2441 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002442
dan286ab7c2011-05-06 18:34:54 +00002443 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002444 zVfs = zVal;
2445 }else{
2446 struct OpenMode {
2447 const char *z;
2448 int mode;
2449 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002450 char *zModeType = 0;
2451 int mask = 0;
2452 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002453
dan286ab7c2011-05-06 18:34:54 +00002454 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002455 static struct OpenMode aCacheMode[] = {
2456 { "shared", SQLITE_OPEN_SHAREDCACHE },
2457 { "private", SQLITE_OPEN_PRIVATECACHE },
2458 { 0, 0 }
2459 };
2460
2461 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2462 aMode = aCacheMode;
2463 limit = mask;
2464 zModeType = "cache";
2465 }
dan286ab7c2011-05-06 18:34:54 +00002466 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002467 static struct OpenMode aOpenMode[] = {
2468 { "ro", SQLITE_OPEN_READONLY },
2469 { "rw", SQLITE_OPEN_READWRITE },
2470 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002471 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002472 { 0, 0 }
2473 };
2474
drh9c67b2a2012-05-28 13:58:00 +00002475 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2476 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002477 aMode = aOpenMode;
2478 limit = mask & flags;
2479 zModeType = "access";
2480 }
2481
2482 if( aMode ){
2483 int i;
2484 int mode = 0;
2485 for(i=0; aMode[i].z; i++){
2486 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002487 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002488 mode = aMode[i].mode;
2489 break;
dancd74b612011-04-22 19:37:32 +00002490 }
2491 }
dan78e9dd22011-05-03 10:22:32 +00002492 if( mode==0 ){
2493 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2494 rc = SQLITE_ERROR;
2495 goto parse_uri_out;
2496 }
drh9c67b2a2012-05-28 13:58:00 +00002497 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002498 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2499 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002500 rc = SQLITE_PERM;
2501 goto parse_uri_out;
2502 }
2503 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002504 }
dancd74b612011-04-22 19:37:32 +00002505 }
dan5de15372011-04-23 10:12:30 +00002506
2507 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002508 }
2509
2510 }else{
2511 zFile = sqlite3_malloc(nUri+2);
2512 if( !zFile ) return SQLITE_NOMEM;
2513 memcpy(zFile, zUri, nUri);
2514 zFile[nUri] = '\0';
2515 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002516 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002517 }
2518
2519 *ppVfs = sqlite3_vfs_find(zVfs);
2520 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002521 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002522 rc = SQLITE_ERROR;
2523 }
2524 parse_uri_out:
2525 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002526 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002527 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002528 }
2529 *pFlags = flags;
2530 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002531 return rc;
dancd74b612011-04-22 19:37:32 +00002532}
2533
2534
2535/*
danielk19774ad17132004-05-21 01:47:26 +00002536** This routine does the work of opening a database on behalf of
2537** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002538** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002539*/
2540static int openDatabase(
2541 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002542 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002543 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002544 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002545){
dancd74b612011-04-22 19:37:32 +00002546 sqlite3 *db; /* Store allocated handle here */
2547 int rc; /* Return code */
2548 int isThreadsafe; /* True for threadsafe connections */
2549 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2550 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002551
drh9ca95732014-10-24 00:35:58 +00002552#ifdef SQLITE_ENABLE_API_ARMOR
2553 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2554#endif
drhe0d0f8e2009-04-28 04:47:31 +00002555 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002556#ifndef SQLITE_OMIT_AUTOINIT
2557 rc = sqlite3_initialize();
2558 if( rc ) return rc;
2559#endif
2560
dan78e9dd22011-05-03 10:22:32 +00002561 /* Only allow sensible combinations of bits in the flags argument.
2562 ** Throw an error if any non-sense combination is used. If we
2563 ** do not block illegal combinations here, it could trigger
2564 ** assert() statements in deeper layers. Sensible combinations
2565 ** are:
2566 **
2567 ** 1: SQLITE_OPEN_READONLY
2568 ** 2: SQLITE_OPEN_READWRITE
2569 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2570 */
2571 assert( SQLITE_OPEN_READONLY == 0x01 );
2572 assert( SQLITE_OPEN_READWRITE == 0x02 );
2573 assert( SQLITE_OPEN_CREATE == 0x04 );
2574 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2575 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2576 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002577 if( ((1<<(flags&7)) & 0x46)==0 ){
2578 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2579 }
dan78e9dd22011-05-03 10:22:32 +00002580
drh039963a2008-09-03 00:43:15 +00002581 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002582 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002583 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2584 isThreadsafe = 0;
2585 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2586 isThreadsafe = 1;
2587 }else{
2588 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002589 }
drhf1f12682009-09-09 14:17:52 +00002590 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002591 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002592 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2593 flags |= SQLITE_OPEN_SHAREDCACHE;
2594 }
danielk19779a6284c2008-07-10 17:52:49 +00002595
drhb25a9f42009-05-12 13:35:11 +00002596 /* Remove harmful bits from the flags parameter
2597 **
2598 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2599 ** dealt with in the previous code block. Besides these, the only
2600 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002601 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2602 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002603 ** off all other flags.
2604 */
drha4267dc2008-02-19 15:20:44 +00002605 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002606 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002607 SQLITE_OPEN_MAIN_DB |
2608 SQLITE_OPEN_TEMP_DB |
2609 SQLITE_OPEN_TRANSIENT_DB |
2610 SQLITE_OPEN_MAIN_JOURNAL |
2611 SQLITE_OPEN_TEMP_JOURNAL |
2612 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002613 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002614 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002615 SQLITE_OPEN_FULLMUTEX |
2616 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002617 );
2618
danielk19774ad17132004-05-21 01:47:26 +00002619 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002620 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002621 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002622 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002623 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2624 if( db->mutex==0 ){
2625 sqlite3_free(db);
2626 db = 0;
2627 goto opendb_out;
2628 }
drh605264d2007-08-21 15:13:19 +00002629 }
drh27641702007-08-22 02:56:42 +00002630 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002631 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002632 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002633 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002634 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002635
drhbb4957f2008-03-20 14:03:29 +00002636 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2637 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002638 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002639 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002640 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002641 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002642 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002643 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002644 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002645#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002646 | SQLITE_AutoIndex
2647#endif
drh76fe8032006-07-11 14:17:51 +00002648#if SQLITE_DEFAULT_FILE_FORMAT<4
2649 | SQLITE_LegacyFileFmt
2650#endif
drh56424db2007-03-27 22:24:11 +00002651#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2652 | SQLITE_LoadExtension
2653#endif
dan5bde73c2009-09-01 17:11:07 +00002654#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002655 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002656#endif
drha4bfd7f2010-12-09 19:15:17 +00002657#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2658 | SQLITE_ForeignKeys
2659#endif
drh76fe8032006-07-11 14:17:51 +00002660 ;
drhe61922a2009-05-02 13:29:37 +00002661 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002662#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002663 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002664#endif
danielk1977da184232006-01-05 11:34:32 +00002665
danielk19770202b292004-06-09 09:55:16 +00002666 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2667 ** and UTF-16, so add a version for each to avoid any unnecessary
2668 ** conversions. The only error that can occur here is a malloc() failure.
2669 */
drh4dd65e02011-11-29 14:46:56 +00002670 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2671 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2672 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2673 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002674 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002675 goto opendb_out;
2676 }
drhc4a64fa2009-05-11 20:53:28 +00002677 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002678 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002679
2680 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002681 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002682
dancd74b612011-04-22 19:37:32 +00002683 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002684 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002685 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2686 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002687 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
drh13f40da2014-08-22 18:00:11 +00002688 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002689 sqlite3_free(zErrMsg);
2690 goto opendb_out;
2691 }
2692
danielk19774ad17132004-05-21 01:47:26 +00002693 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002694 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002695 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002696 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002697 if( rc==SQLITE_IOERR_NOMEM ){
2698 rc = SQLITE_NOMEM;
2699 }
drh13f40da2014-08-22 18:00:11 +00002700 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002701 goto opendb_out;
2702 }
drh17435752007-08-16 04:30:38 +00002703 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2704 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002705
danielk197753c0f742005-03-29 03:10:59 +00002706 /* The default safety_level for the main database is 'full'; for the temp
2707 ** database it is 'NONE'. This matches the pager layer defaults.
2708 */
2709 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002710 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002711 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002712 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002713
danielk1977832a58a2007-06-22 15:21:15 +00002714 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002715 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002716 goto opendb_out;
2717 }
2718
danielk19778e227872004-06-07 07:52:17 +00002719 /* Register all built-in functions, but do not attempt to read the
2720 ** database schema yet. This is delayed until the first time the database
2721 ** is accessed.
2722 */
drh13f40da2014-08-22 18:00:11 +00002723 sqlite3Error(db, SQLITE_OK);
danielk1977832a58a2007-06-22 15:21:15 +00002724 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002725
drh1409be62006-08-23 20:07:20 +00002726 /* Load automatic extensions - extensions that have been registered
2727 ** using the sqlite3_automatic_extension() API.
2728 */
drh7aaa8782009-05-20 02:40:45 +00002729 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002730 if( rc==SQLITE_OK ){
2731 sqlite3AutoLoadExtensions(db);
2732 rc = sqlite3_errcode(db);
2733 if( rc!=SQLITE_OK ){
2734 goto opendb_out;
2735 }
danielk1977832a58a2007-06-22 15:21:15 +00002736 }
drh1409be62006-08-23 20:07:20 +00002737
drhaa29c132006-09-02 13:58:06 +00002738#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002739 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002740 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002741 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002742 }
2743#endif
2744
shessa26cf572006-10-19 20:27:58 +00002745#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002746 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002747 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002748 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002749 }
2750#endif
2751
shess69c4ae22007-08-20 17:37:47 +00002752#ifdef SQLITE_ENABLE_FTS3
2753 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002754 rc = sqlite3Fts3Init(db);
2755 }
2756#endif
2757
danielk197783852ac2007-05-06 16:04:11 +00002758#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002759 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002760 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002761 }
2762#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002763
2764#ifdef SQLITE_ENABLE_RTREE
2765 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002766 rc = sqlite3RtreeInit(db);
2767 }
2768#endif
2769
drh8fd5bd32007-04-02 16:40:37 +00002770 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2771 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2772 ** mode. Doing nothing at all also makes NORMAL the default.
2773 */
2774#ifdef SQLITE_DEFAULT_LOCKING_MODE
2775 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2776 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2777 SQLITE_DEFAULT_LOCKING_MODE);
2778#endif
2779
drh13f40da2014-08-22 18:00:11 +00002780 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00002781
drh633e6d52008-07-28 19:34:53 +00002782 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002783 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2784 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002785
dan5a299f92010-05-03 11:05:08 +00002786 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002787
danielk19774ad17132004-05-21 01:47:26 +00002788opendb_out:
dancd74b612011-04-22 19:37:32 +00002789 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002790 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002791 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002792 sqlite3_mutex_leave(db->mutex);
2793 }
danielk197759633ae2008-08-27 19:01:57 +00002794 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002795 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002796 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002797 sqlite3_close(db);
2798 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002799 }else if( rc!=SQLITE_OK ){
2800 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002801 }
danielk19774ad17132004-05-21 01:47:26 +00002802 *ppDb = db;
danac455932012-11-26 19:50:41 +00002803#ifdef SQLITE_ENABLE_SQLLOG
2804 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002805 /* Opening a db handle. Fourth parameter is passed 0. */
2806 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2807 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002808 }
2809#endif
danielk197754f01982006-01-18 15:25:17 +00002810 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002811}
2812
2813/*
2814** Open a new database handle.
2815*/
danielk197780290862004-05-22 09:21:21 +00002816int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002817 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002818 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002819){
drh605264d2007-08-21 15:13:19 +00002820 return openDatabase(zFilename, ppDb,
2821 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2822}
2823int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002824 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002825 sqlite3 **ppDb, /* OUT: SQLite db handle */
2826 int flags, /* Flags */
2827 const char *zVfs /* Name of VFS module to use */
2828){
drh522c26f2011-05-07 14:40:29 +00002829 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002830}
2831
drh6c626082004-11-14 21:56:29 +00002832#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002833/*
2834** Open a new database handle.
2835*/
2836int sqlite3_open16(
2837 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002838 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002839){
danielk1977bfd6cce2004-06-18 04:24:54 +00002840 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002841 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002842 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002843
drh9ca95732014-10-24 00:35:58 +00002844#ifdef SQLITE_ENABLE_API_ARMOR
2845 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2846#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00002847 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002848#ifndef SQLITE_OMIT_AUTOINIT
2849 rc = sqlite3_initialize();
2850 if( rc ) return rc;
2851#endif
drh9ca95732014-10-24 00:35:58 +00002852 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00002853 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002854 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2855 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002856 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002857 rc = openDatabase(zFilename8, ppDb,
2858 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002859 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002860 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002861 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002862 }
drh40257ff2008-06-13 18:24:27 +00002863 }else{
2864 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002865 }
danielk19777ddad962005-12-12 06:53:03 +00002866 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002867
danielk197754f01982006-01-18 15:25:17 +00002868 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002869}
drh6c626082004-11-14 21:56:29 +00002870#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002871
danielk1977106bb232004-05-21 10:08:53 +00002872/*
danielk1977d8123362004-06-12 09:25:12 +00002873** Register a new collation sequence with the database handle db.
2874*/
danielk19770202b292004-06-09 09:55:16 +00002875int sqlite3_create_collation(
2876 sqlite3* db,
2877 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002878 int enc,
danielk19770202b292004-06-09 09:55:16 +00002879 void* pCtx,
2880 int(*xCompare)(void*,int,const void*,int,const void*)
2881){
drh4f81bbb2014-10-23 01:01:26 +00002882 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002883}
2884
2885/*
2886** Register a new collation sequence with the database handle db.
2887*/
danielk1977a393c032007-05-07 14:58:53 +00002888int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002889 sqlite3* db,
2890 const char *zName,
2891 int enc,
2892 void* pCtx,
2893 int(*xCompare)(void*,int,const void*,int,const void*),
2894 void(*xDel)(void*)
2895){
2896 int rc;
drh9ca95732014-10-24 00:35:58 +00002897
2898#ifdef SQLITE_ENABLE_API_ARMOR
2899 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2900#endif
drhe30f4422007-08-21 16:15:55 +00002901 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002902 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002903 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002904 rc = sqlite3ApiExit(db, rc);
2905 sqlite3_mutex_leave(db->mutex);
2906 return rc;
danielk19770202b292004-06-09 09:55:16 +00002907}
2908
drh6c626082004-11-14 21:56:29 +00002909#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002910/*
2911** Register a new collation sequence with the database handle db.
2912*/
danielk19770202b292004-06-09 09:55:16 +00002913int sqlite3_create_collation16(
2914 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002915 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002916 int enc,
danielk19770202b292004-06-09 09:55:16 +00002917 void* pCtx,
2918 int(*xCompare)(void*,int,const void*,int,const void*)
2919){
danielk19779a30cf62006-01-18 04:26:07 +00002920 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002921 char *zName8;
drh9ca95732014-10-24 00:35:58 +00002922
2923#ifdef SQLITE_ENABLE_API_ARMOR
2924 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2925#endif
drhe30f4422007-08-21 16:15:55 +00002926 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002927 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002928 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002929 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002930 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002931 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002932 }
drhe30f4422007-08-21 16:15:55 +00002933 rc = sqlite3ApiExit(db, rc);
2934 sqlite3_mutex_leave(db->mutex);
2935 return rc;
danielk19770202b292004-06-09 09:55:16 +00002936}
drh6c626082004-11-14 21:56:29 +00002937#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002938
danielk1977d8123362004-06-12 09:25:12 +00002939/*
2940** Register a collation sequence factory callback with the database handle
2941** db. Replace any previously installed collation sequence factory.
2942*/
danielk19777cedc8d2004-06-10 10:50:08 +00002943int sqlite3_collation_needed(
2944 sqlite3 *db,
2945 void *pCollNeededArg,
2946 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2947){
drh9ca95732014-10-24 00:35:58 +00002948#ifdef SQLITE_ENABLE_API_ARMOR
2949 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2950#endif
drhe30f4422007-08-21 16:15:55 +00002951 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002952 db->xCollNeeded = xCollNeeded;
2953 db->xCollNeeded16 = 0;
2954 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002955 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002956 return SQLITE_OK;
2957}
danielk1977d8123362004-06-12 09:25:12 +00002958
drh6c626082004-11-14 21:56:29 +00002959#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002960/*
2961** Register a collation sequence factory callback with the database handle
2962** db. Replace any previously installed collation sequence factory.
2963*/
danielk19777cedc8d2004-06-10 10:50:08 +00002964int sqlite3_collation_needed16(
2965 sqlite3 *db,
2966 void *pCollNeededArg,
2967 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2968){
drh9ca95732014-10-24 00:35:58 +00002969#ifdef SQLITE_ENABLE_API_ARMOR
2970 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2971#endif
drhe30f4422007-08-21 16:15:55 +00002972 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002973 db->xCollNeeded = 0;
2974 db->xCollNeeded16 = xCollNeeded16;
2975 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002976 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002977 return SQLITE_OK;
2978}
drh6c626082004-11-14 21:56:29 +00002979#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002980
shaneeec556d2008-10-12 00:27:53 +00002981#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002982/*
danielk19777ddad962005-12-12 06:53:03 +00002983** This function is now an anachronism. It used to be used to recover from a
2984** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002985*/
drh7d97efb2007-10-12 19:35:48 +00002986int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002987 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002988}
2989#endif
drh3e1d8e62005-05-26 16:23:34 +00002990
2991/*
2992** Test to see whether or not the database connection is in autocommit
2993** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2994** by default. Autocommit is disabled by a BEGIN statement and reenabled
2995** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00002996*/
2997int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00002998#ifdef SQLITE_ENABLE_API_ARMOR
2999 if( !sqlite3SafetyCheckOk(db) ){
3000 (void)SQLITE_MISUSE_BKPT;
3001 return 0;
3002 }
3003#endif
drh3e1d8e62005-05-26 16:23:34 +00003004 return db->autoCommit;
3005}
drh49285702005-09-17 15:20:26 +00003006
drh49285702005-09-17 15:20:26 +00003007/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003008** The following routines are substitutes for constants SQLITE_CORRUPT,
drh9978c972010-02-23 17:36:32 +00003009** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003010** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003011**
3012** 1. Serve as a convenient place to set a breakpoint in a debugger
3013** to detect when version error conditions occurs.
3014**
3015** 2. Invoke sqlite3_log() to provide the source code location where
3016** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003017*/
drh9978c972010-02-23 17:36:32 +00003018int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003019 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00003020 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00003021 "database corruption at line %d of [%.10s]",
3022 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00003023 return SQLITE_CORRUPT;
3024}
drh9978c972010-02-23 17:36:32 +00003025int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003026 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003027 sqlite3_log(SQLITE_MISUSE,
3028 "misuse at line %d of [%.10s]",
3029 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003030 return SQLITE_MISUSE;
3031}
3032int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003033 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003034 sqlite3_log(SQLITE_CANTOPEN,
3035 "cannot open file at line %d of [%.10s]",
3036 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003037 return SQLITE_CANTOPEN;
3038}
3039
drh7c1817e2006-01-10 13:58:48 +00003040
shaneeec556d2008-10-12 00:27:53 +00003041#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003042/*
3043** This is a convenience routine that makes sure that all thread-specific
3044** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003045**
3046** SQLite no longer uses thread-specific data so this routine is now a
3047** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003048*/
3049void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003050}
shaneeec556d2008-10-12 00:27:53 +00003051#endif
danielk1977deb802c2006-02-09 13:43:28 +00003052
3053/*
3054** Return meta information about a specific column of a database table.
3055** See comment in sqlite3.h (sqlite.h.in) for details.
3056*/
3057#ifdef SQLITE_ENABLE_COLUMN_METADATA
3058int sqlite3_table_column_metadata(
3059 sqlite3 *db, /* Connection handle */
3060 const char *zDbName, /* Database name or NULL */
3061 const char *zTableName, /* Table name */
3062 const char *zColumnName, /* Column name */
3063 char const **pzDataType, /* OUTPUT: Declared data type */
3064 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3065 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3066 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003067 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003068){
3069 int rc;
3070 char *zErrMsg = 0;
3071 Table *pTab = 0;
3072 Column *pCol = 0;
3073 int iCol;
3074
3075 char const *zDataType = 0;
3076 char const *zCollSeq = 0;
3077 int notnull = 0;
3078 int primarykey = 0;
3079 int autoinc = 0;
3080
3081 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003082 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003083 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003084 rc = sqlite3Init(db, &zErrMsg);
3085 if( SQLITE_OK!=rc ){
3086 goto error_out;
3087 }
3088
3089 /* Locate the table in question */
3090 pTab = sqlite3FindTable(db, zTableName, zDbName);
3091 if( !pTab || pTab->pSelect ){
3092 pTab = 0;
3093 goto error_out;
3094 }
3095
3096 /* Find the column for which info is requested */
3097 if( sqlite3IsRowid(zColumnName) ){
3098 iCol = pTab->iPKey;
3099 if( iCol>=0 ){
3100 pCol = &pTab->aCol[iCol];
3101 }
3102 }else{
3103 for(iCol=0; iCol<pTab->nCol; iCol++){
3104 pCol = &pTab->aCol[iCol];
3105 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3106 break;
3107 }
3108 }
3109 if( iCol==pTab->nCol ){
3110 pTab = 0;
3111 goto error_out;
3112 }
3113 }
3114
3115 /* The following block stores the meta information that will be returned
3116 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3117 ** and autoinc. At this point there are two possibilities:
3118 **
3119 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3120 ** and there is no explicitly declared IPK column.
3121 **
3122 ** 2. The table is not a view and the column name identified an
3123 ** explicitly declared column. Copy meta information from *pCol.
3124 */
3125 if( pCol ){
3126 zDataType = pCol->zType;
3127 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003128 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003129 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003130 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003131 }else{
3132 zDataType = "INTEGER";
3133 primarykey = 1;
3134 }
3135 if( !zCollSeq ){
3136 zCollSeq = "BINARY";
3137 }
3138
3139error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003140 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003141
3142 /* Whether the function call succeeded or failed, set the output parameters
3143 ** to whatever their local counterparts contain. If an error did occur,
3144 ** this has the effect of zeroing all output parameters.
3145 */
3146 if( pzDataType ) *pzDataType = zDataType;
3147 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3148 if( pNotNull ) *pNotNull = notnull;
3149 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3150 if( pAutoinc ) *pAutoinc = autoinc;
3151
3152 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003153 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003154 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003155 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003156 rc = SQLITE_ERROR;
3157 }
drh13f40da2014-08-22 18:00:11 +00003158 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003159 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003160 rc = sqlite3ApiExit(db, rc);
3161 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003162 return rc;
3163}
drhe30f4422007-08-21 16:15:55 +00003164#endif
drhf9cb7f52006-06-27 20:06:44 +00003165
3166/*
3167** Sleep for a little while. Return the amount of time slept.
3168*/
3169int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003170 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003171 int rc;
drhd677b3d2007-08-20 22:48:41 +00003172 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003173 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003174
3175 /* This function works in milliseconds, but the underlying OsSleep()
3176 ** API uses microseconds. Hence the 1000's.
3177 */
drhe30f4422007-08-21 16:15:55 +00003178 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003179 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003180}
drh4ac285a2006-09-15 07:28:50 +00003181
3182/*
3183** Enable or disable the extended result codes.
3184*/
3185int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003186#ifdef SQLITE_ENABLE_API_ARMOR
3187 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3188#endif
drhe30f4422007-08-21 16:15:55 +00003189 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003190 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003191 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003192 return SQLITE_OK;
3193}
drhcc6bb3e2007-08-31 16:11:35 +00003194
3195/*
3196** Invoke the xFileControl method on a particular database.
3197*/
3198int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3199 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003200 Btree *pBtree;
3201
drh9ca95732014-10-24 00:35:58 +00003202#ifdef SQLITE_ENABLE_API_ARMOR
3203 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3204#endif
drhcc6bb3e2007-08-31 16:11:35 +00003205 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003206 pBtree = sqlite3DbNameToBtree(db, zDbName);
3207 if( pBtree ){
3208 Pager *pPager;
3209 sqlite3_file *fd;
3210 sqlite3BtreeEnter(pBtree);
3211 pPager = sqlite3BtreePager(pBtree);
3212 assert( pPager!=0 );
3213 fd = sqlite3PagerFile(pPager);
3214 assert( fd!=0 );
3215 if( op==SQLITE_FCNTL_FILE_POINTER ){
3216 *(sqlite3_file**)pArg = fd;
3217 rc = SQLITE_OK;
3218 }else if( fd->pMethods ){
3219 rc = sqlite3OsFileControl(fd, op, pArg);
3220 }else{
3221 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003222 }
drh421377e2012-03-15 21:28:54 +00003223 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003224 }
3225 sqlite3_mutex_leave(db->mutex);
3226 return rc;
3227}
drhed13d982008-01-31 14:43:24 +00003228
3229/*
3230** Interface to the testing logic.
3231*/
3232int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003233 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003234#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003235 va_list ap;
drhed13d982008-01-31 14:43:24 +00003236 va_start(ap, op);
3237 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003238
3239 /*
drh984bfaa2008-03-19 16:08:53 +00003240 ** Save the current state of the PRNG.
3241 */
drh2fa18682008-03-19 14:15:34 +00003242 case SQLITE_TESTCTRL_PRNG_SAVE: {
3243 sqlite3PrngSaveState();
3244 break;
3245 }
drh984bfaa2008-03-19 16:08:53 +00003246
3247 /*
3248 ** Restore the state of the PRNG to the last state saved using
3249 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3250 ** this verb acts like PRNG_RESET.
3251 */
drh2fa18682008-03-19 14:15:34 +00003252 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3253 sqlite3PrngRestoreState();
3254 break;
3255 }
drh984bfaa2008-03-19 16:08:53 +00003256
3257 /*
3258 ** Reset the PRNG back to its uninitialized state. The next call
3259 ** to sqlite3_randomness() will reseed the PRNG using a single call
3260 ** to the xRandomness method of the default VFS.
3261 */
drh2fa18682008-03-19 14:15:34 +00003262 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003263 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003264 break;
3265 }
drh3088d592008-03-21 16:45:47 +00003266
3267 /*
3268 ** sqlite3_test_control(BITVEC_TEST, size, program)
3269 **
3270 ** Run a test against a Bitvec object of size. The program argument
3271 ** is an array of integers that defines the test. Return -1 on a
3272 ** memory allocation error, 0 on success, or non-zero for an error.
3273 ** See the sqlite3BitvecBuiltinTest() for additional information.
3274 */
3275 case SQLITE_TESTCTRL_BITVEC_TEST: {
3276 int sz = va_arg(ap, int);
3277 int *aProg = va_arg(ap, int*);
3278 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3279 break;
3280 }
danielk19772d1d86f2008-06-20 14:59:51 +00003281
3282 /*
drhc007f612014-05-16 14:17:01 +00003283 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3284 **
3285 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3286 ** if xCallback is not NULL.
3287 **
3288 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3289 ** is called immediately after installing the new callback and the return
3290 ** value from sqlite3FaultSim(0) becomes the return from
3291 ** sqlite3_test_control().
3292 */
3293 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003294 /* MSVC is picky about pulling func ptrs from va lists.
3295 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003296 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003297 */
3298 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003299 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003300 rc = sqlite3FaultSim(0);
3301 break;
3302 }
3303
3304 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003305 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3306 **
3307 ** Register hooks to call to indicate which malloc() failures
3308 ** are benign.
3309 */
3310 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003311 typedef void (*void_function)(void);
3312 void_function xBenignBegin;
3313 void_function xBenignEnd;
3314 xBenignBegin = va_arg(ap, void_function);
3315 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003316 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3317 break;
3318 }
drhc7a3bb92009-02-05 16:31:45 +00003319
3320 /*
drhf3af63f2009-05-09 18:59:42 +00003321 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003322 **
3323 ** Set the PENDING byte to the value in the argument, if X>0.
3324 ** Make no changes if X==0. Return the value of the pending byte
3325 ** as it existing before this routine was called.
3326 **
3327 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3328 ** an incompatible database file format. Changing the PENDING byte
3329 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003330 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003331 */
3332 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003333 rc = PENDING_BYTE;
3334#ifndef SQLITE_OMIT_WSD
3335 {
3336 unsigned int newVal = va_arg(ap, unsigned int);
3337 if( newVal ) sqlite3PendingByte = newVal;
3338 }
3339#endif
drhc7a3bb92009-02-05 16:31:45 +00003340 break;
3341 }
drhf3af63f2009-05-09 18:59:42 +00003342
3343 /*
3344 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3345 **
3346 ** This action provides a run-time test to see whether or not
3347 ** assert() was enabled at compile-time. If X is true and assert()
3348 ** is enabled, then the return value is true. If X is true and
3349 ** assert() is disabled, then the return value is zero. If X is
3350 ** false and assert() is enabled, then the assertion fires and the
3351 ** process aborts. If X is false and assert() is disabled, then the
3352 ** return value is zero.
3353 */
3354 case SQLITE_TESTCTRL_ASSERT: {
3355 volatile int x = 0;
3356 assert( (x = va_arg(ap,int))!=0 );
3357 rc = x;
3358 break;
3359 }
3360
3361
3362 /*
3363 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3364 **
3365 ** This action provides a run-time test to see how the ALWAYS and
3366 ** NEVER macros were defined at compile-time.
3367 **
3368 ** The return value is ALWAYS(X).
3369 **
3370 ** The recommended test is X==2. If the return value is 2, that means
3371 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3372 ** default setting. If the return value is 1, then ALWAYS() is either
3373 ** hard-coded to true or else it asserts if its argument is false.
3374 ** The first behavior (hard-coded to true) is the case if
3375 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3376 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3377 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3378 **
3379 ** The run-time test procedure might look something like this:
3380 **
3381 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3382 ** // ALWAYS() and NEVER() are no-op pass-through macros
3383 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3384 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3385 ** }else{
3386 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3387 ** }
3388 */
3389 case SQLITE_TESTCTRL_ALWAYS: {
3390 int x = va_arg(ap,int);
3391 rc = ALWAYS(x);
3392 break;
3393 }
drhc046e3e2009-07-15 11:26:44 +00003394
drh2cf4acb2014-04-18 00:06:02 +00003395 /*
3396 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3397 **
3398 ** The integer returned reveals the byte-order of the computer on which
3399 ** SQLite is running:
3400 **
3401 ** 1 big-endian, determined at run-time
3402 ** 10 little-endian, determined at run-time
3403 ** 432101 big-endian, determined at compile-time
3404 ** 123410 little-endian, determined at compile-time
3405 */
3406 case SQLITE_TESTCTRL_BYTEORDER: {
3407 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3408 break;
3409 }
3410
drhc046e3e2009-07-15 11:26:44 +00003411 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3412 **
3413 ** Set the nReserve size to N for the main database on the database
3414 ** connection db.
3415 */
3416 case SQLITE_TESTCTRL_RESERVE: {
3417 sqlite3 *db = va_arg(ap, sqlite3*);
3418 int x = va_arg(ap,int);
3419 sqlite3_mutex_enter(db->mutex);
3420 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3421 sqlite3_mutex_leave(db->mutex);
3422 break;
3423 }
3424
drh07096f62009-12-22 23:52:32 +00003425 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3426 **
3427 ** Enable or disable various optimizations for testing purposes. The
3428 ** argument N is a bitmask of optimizations to be disabled. For normal
3429 ** operation N should be 0. The idea is that a test program (like the
3430 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3431 ** with various optimizations disabled to verify that the same answer
3432 ** is obtained in every case.
3433 */
3434 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3435 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003436 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003437 break;
3438 }
3439
drh0e857732010-01-02 03:21:35 +00003440#ifdef SQLITE_N_KEYWORD
3441 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3442 **
3443 ** If zWord is a keyword recognized by the parser, then return the
3444 ** number of keywords. Or if zWord is not a keyword, return 0.
3445 **
3446 ** This test feature is only available in the amalgamation since
3447 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3448 ** is built using separate source files.
3449 */
3450 case SQLITE_TESTCTRL_ISKEYWORD: {
3451 const char *zWord = va_arg(ap, const char*);
3452 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003453 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003454 break;
3455 }
3456#endif
3457
drhbadc9802010-08-27 17:16:44 +00003458 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3459 **
3460 ** Pass pFree into sqlite3ScratchFree().
3461 ** If sz>0 then allocate a scratch buffer into pNew.
3462 */
3463 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3464 void *pFree, **ppNew;
3465 int sz;
3466 sz = va_arg(ap, int);
3467 ppNew = va_arg(ap, void**);
3468 pFree = va_arg(ap, void*);
3469 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3470 sqlite3ScratchFree(pFree);
3471 break;
3472 }
3473
danc17d6962011-06-21 12:47:30 +00003474 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3475 **
3476 ** If parameter onoff is non-zero, configure the wrappers so that all
3477 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3478 ** undo this setting.
3479 */
3480 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3481 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3482 break;
3483 }
3484
drh09fe6142013-11-29 15:06:27 +00003485 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3486 **
3487 ** Set or clear a flag that indicates that the database file is always well-
3488 ** formed and never corrupt. This flag is clear by default, indicating that
3489 ** database files might have arbitrary corruption. Setting the flag during
3490 ** testing causes certain assert() statements in the code to be activated
3491 ** that demonstrat invariants on well-formed database files.
3492 */
3493 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003494 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003495 break;
3496 }
3497
drh688852a2014-02-17 22:40:43 +00003498
3499 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3500 **
3501 ** Set the VDBE coverage callback function to xCallback with context
3502 ** pointer ptr.
3503 */
3504 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3505#ifdef SQLITE_VDBE_COVERAGE
3506 typedef void (*branch_callback)(void*,int,u8,u8);
3507 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3508 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3509#endif
3510 break;
3511 }
3512
dan8930c2a2014-04-03 16:25:29 +00003513 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3514 case SQLITE_TESTCTRL_SORTER_MMAP: {
3515 sqlite3 *db = va_arg(ap, sqlite3*);
3516 db->nMaxSorterMmap = va_arg(ap, int);
3517 break;
3518 }
3519
drh43cfc232014-07-29 14:09:21 +00003520 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3521 **
3522 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3523 ** not.
3524 */
3525 case SQLITE_TESTCTRL_ISINIT: {
3526 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3527 break;
3528 }
drhed13d982008-01-31 14:43:24 +00003529 }
3530 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003531#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003532 return rc;
drhed13d982008-01-31 14:43:24 +00003533}
drhcc487d12011-05-17 18:53:08 +00003534
3535/*
3536** This is a utility routine, useful to VFS implementations, that checks
3537** to see if a database file was a URI that contained a specific query
3538** parameter, and if so obtains the value of the query parameter.
3539**
3540** The zFilename argument is the filename pointer passed into the xOpen()
3541** method of a VFS implementation. The zParam argument is the name of the
3542** query parameter we seek. This routine returns the value of the zParam
3543** parameter if it exists. If the parameter does not exist, this routine
3544** returns a NULL pointer.
3545*/
3546const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003547 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003548 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003549 while( zFilename[0] ){
3550 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003551 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003552 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003553 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003554 }
3555 return 0;
3556}
drh283829c2011-11-17 00:56:20 +00003557
3558/*
drh92913722011-12-23 00:07:33 +00003559** Return a boolean value for a query parameter.
3560*/
3561int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3562 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003563 bDflt = bDflt!=0;
3564 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003565}
3566
3567/*
3568** Return a 64-bit integer value for a query parameter.
3569*/
3570sqlite3_int64 sqlite3_uri_int64(
3571 const char *zFilename, /* Filename as passed to xOpen */
3572 const char *zParam, /* URI parameter sought */
3573 sqlite3_int64 bDflt /* return if parameter is missing */
3574){
3575 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3576 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003577 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003578 bDflt = v;
3579 }
3580 return bDflt;
3581}
3582
3583/*
drh421377e2012-03-15 21:28:54 +00003584** Return the Btree pointer identified by zDbName. Return NULL if not found.
3585*/
3586Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3587 int i;
3588 for(i=0; i<db->nDb; i++){
3589 if( db->aDb[i].pBt
3590 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3591 ){
3592 return db->aDb[i].pBt;
3593 }
3594 }
3595 return 0;
3596}
3597
3598/*
drh283829c2011-11-17 00:56:20 +00003599** Return the filename of the database associated with a database
3600** connection.
3601*/
3602const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh9ca95732014-10-24 00:35:58 +00003603#ifdef SQLITE_ENABLE_API_ARMOR
3604 if( !sqlite3SafetyCheckOk(db) ){
3605 (void)SQLITE_MISUSE_BKPT;
3606 return 0;
3607 }
3608#endif
drh421377e2012-03-15 21:28:54 +00003609 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3610 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3611}
3612
3613/*
3614** Return 1 if database is read-only or 0 if read/write. Return -1 if
3615** no such database exists.
3616*/
3617int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
drh9ca95732014-10-24 00:35:58 +00003618#ifdef SQLITE_ENABLE_API_ARMOR
3619 if( !sqlite3SafetyCheckOk(db) ){
3620 (void)SQLITE_MISUSE_BKPT;
3621 return -1;
3622 }
3623#endif
drh421377e2012-03-15 21:28:54 +00003624 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003625 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003626}