blob: 6a896b2a3db9dc5f682a788beb338fbf80203bda [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 }
drhdef68892014-11-04 12:11:23 +0000404 case SQLITE_CONFIG_PCACHE_HDRSZ: {
405 /* Return the total size of all headers added to each page
406 ** of the page cache */
407 *va_arg(ap, int*) =
408 sqlite3HeaderSizeBtree() +
409 sqlite3HeaderSizePcache() +
410 sqlite3HeaderSizePcache1();
411 break;
412 }
danielk19775099be52008-06-27 13:27:03 +0000413
danielk1977bc2ca9e2008-11-13 14:28:28 +0000414 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000415 /* no-op */
416 break;
417 }
418 case SQLITE_CONFIG_GETPCACHE: {
419 /* now an error */
420 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000421 break;
422 }
423
dan22e21ff2011-11-08 20:08:44 +0000424 case SQLITE_CONFIG_PCACHE2: {
425 /* Specify an alternative page cache implementation */
426 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
427 break;
428 }
429 case SQLITE_CONFIG_GETPCACHE2: {
430 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000431 sqlite3PCacheSetDefault();
432 }
dan22e21ff2011-11-08 20:08:44 +0000433 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000434 break;
435 }
436
drh5d414832008-07-15 14:47:18 +0000437#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000438 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000439 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000440 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
441 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
442 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000443
shaneha6ec8922011-03-09 21:36:17 +0000444 if( sqlite3GlobalConfig.mnReq<1 ){
445 sqlite3GlobalConfig.mnReq = 1;
446 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
447 /* cap min request size at 2^12 */
448 sqlite3GlobalConfig.mnReq = (1<<12);
449 }
450
danielk1977075c23a2008-09-01 18:34:20 +0000451 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000452 /* If the heap pointer is NULL, then restore the malloc implementation
453 ** back to NULL pointers too. This will cause the malloc to go
454 ** back to its default implementation when sqlite3_initialize() is
455 ** run.
456 */
danielk1977075c23a2008-09-01 18:34:20 +0000457 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000458 }else{
459 /* The heap pointer is not NULL, then install one of the
mistachkin037933b2013-08-13 22:33:41 +0000460 ** mem5.c/mem3.c methods. The enclosing #if guarantees at
461 ** least one of these methods is currently enabled.
drh8a42cbd2008-07-10 18:13:42 +0000462 */
danielk19775099be52008-06-27 13:27:03 +0000463#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000464 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000465#endif
466#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000467 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000468#endif
drh8a42cbd2008-07-10 18:13:42 +0000469 }
danielk19775099be52008-06-27 13:27:03 +0000470 break;
471 }
drh5d414832008-07-15 14:47:18 +0000472#endif
danielk19775099be52008-06-27 13:27:03 +0000473
drh633e6d52008-07-28 19:34:53 +0000474 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000475 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
476 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000477 break;
478 }
drh3f280702010-02-18 18:45:09 +0000479
mistachkin037933b2013-08-13 22:33:41 +0000480 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000481 ** The default is NULL. Logging is disabled if the function pointer is
482 ** NULL.
483 */
484 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000485 /* MSVC is picky about pulling func ptrs from va lists.
486 ** http://support.microsoft.com/kb/47961
487 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
488 */
489 typedef void(*LOGFUNC_t)(void*,int,const char*);
490 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000491 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
492 break;
493 }
drh633e6d52008-07-28 19:34:53 +0000494
drh00729cb2014-10-04 11:59:33 +0000495 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
496 ** can be changed at start-time using the
497 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
498 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
499 */
dancd74b612011-04-22 19:37:32 +0000500 case SQLITE_CONFIG_URI: {
501 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
502 break;
503 }
504
drhde9a7b82012-09-17 20:44:46 +0000505 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
506 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
507 break;
508 }
509
danac455932012-11-26 19:50:41 +0000510#ifdef SQLITE_ENABLE_SQLLOG
511 case SQLITE_CONFIG_SQLLOG: {
512 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
513 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
514 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
515 break;
516 }
517#endif
518
drh9b4c59f2013-04-15 17:03:42 +0000519 case SQLITE_CONFIG_MMAP_SIZE: {
520 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000521 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh9b4c59f2013-04-15 17:03:42 +0000522 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
523 mxMmap = SQLITE_MAX_MMAP_SIZE;
524 }
drha1f42c72013-04-01 22:38:06 +0000525 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000526 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
527 if( szMmap>mxMmap) szMmap = mxMmap;
528 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000529 break;
530 }
531
mistachkinac1f1042013-11-23 00:27:29 +0000532#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC)
mistachkinaf8641b2013-11-25 21:49:04 +0000533 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
mistachkinac1f1042013-11-23 00:27:29 +0000534 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
535 break;
536 }
537#endif
538
drh40257ff2008-06-13 18:24:27 +0000539 default: {
540 rc = SQLITE_ERROR;
541 break;
542 }
543 }
544 va_end(ap);
545 return rc;
546}
547
548/*
drh633e6d52008-07-28 19:34:53 +0000549** Set up the lookaside buffers for a database connection.
550** Return SQLITE_OK on success.
551** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000552**
553** The sz parameter is the number of bytes in each lookaside slot.
554** The cnt parameter is the number of slots. If pStart is NULL the
555** space for the lookaside memory is obtained from sqlite3_malloc().
556** If pStart is not NULL then it is sz*cnt bytes of memory to use for
557** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000558*/
drhe9d1c722008-08-04 20:13:26 +0000559static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000560 void *pStart;
561 if( db->lookaside.nOut ){
562 return SQLITE_BUSY;
563 }
shanef71f89e2009-01-30 06:11:54 +0000564 /* Free any existing lookaside buffer for this handle before
565 ** allocating a new one so we don't have to have space for
566 ** both at the same time.
567 */
568 if( db->lookaside.bMalloced ){
569 sqlite3_free(db->lookaside.pStart);
570 }
drh61a4bd52011-11-10 02:39:28 +0000571 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
572 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000573 */
drh61a4bd52011-11-10 02:39:28 +0000574 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000575 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000576 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000577 if( sz==0 || cnt==0 ){
578 sz = 0;
579 pStart = 0;
580 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000581 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000582 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000583 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000584 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000585 }else{
586 pStart = pBuf;
587 }
drh4cfb22f2008-08-01 18:47:01 +0000588 db->lookaside.pStart = pStart;
589 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000590 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000591 if( pStart ){
592 int i;
593 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000594 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000595 p = (LookasideSlot*)pStart;
596 for(i=cnt-1; i>=0; i--){
597 p->pNext = db->lookaside.pFree;
598 db->lookaside.pFree = p;
599 p = (LookasideSlot*)&((u8*)p)[sz];
600 }
601 db->lookaside.pEnd = p;
602 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000603 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000604 }else{
drhb0e77042013-12-10 19:49:00 +0000605 db->lookaside.pStart = db;
606 db->lookaside.pEnd = db;
drh4cfb22f2008-08-01 18:47:01 +0000607 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000608 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000609 }
610 return SQLITE_OK;
611}
612
613/*
drh4413d0e2008-11-04 13:46:27 +0000614** Return the mutex associated with a database connection.
615*/
616sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000617#ifdef SQLITE_ENABLE_API_ARMOR
618 if( !sqlite3SafetyCheckOk(db) ){
619 (void)SQLITE_MISUSE_BKPT;
620 return 0;
621 }
622#endif
drh4413d0e2008-11-04 13:46:27 +0000623 return db->mutex;
624}
625
626/*
drh09419b42011-11-16 19:29:17 +0000627** Free up as much memory as we can from the given database
628** connection.
629*/
630int sqlite3_db_release_memory(sqlite3 *db){
631 int i;
drh9ca95732014-10-24 00:35:58 +0000632
633#ifdef SQLITE_ENABLE_API_ARMOR
634 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
635#endif
dand9bb3a92011-12-30 11:43:59 +0000636 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000637 sqlite3BtreeEnterAll(db);
638 for(i=0; i<db->nDb; i++){
639 Btree *pBt = db->aDb[i].pBt;
640 if( pBt ){
641 Pager *pPager = sqlite3BtreePager(pBt);
642 sqlite3PagerShrink(pPager);
643 }
644 }
645 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000646 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000647 return SQLITE_OK;
648}
649
650/*
drh633e6d52008-07-28 19:34:53 +0000651** Configuration settings for an individual database connection
652*/
653int sqlite3_db_config(sqlite3 *db, int op, ...){
654 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000655 int rc;
drh633e6d52008-07-28 19:34:53 +0000656 va_start(ap, op);
657 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000658 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000659 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000660 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
661 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000662 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000663 break;
664 }
drh6480aad2008-08-01 16:31:14 +0000665 default: {
drhe83cafd2011-03-21 17:15:58 +0000666 static const struct {
667 int op; /* The opcode */
668 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
669 } aFlagOp[] = {
670 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
671 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
672 };
drh58ad5802011-03-23 22:02:23 +0000673 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000674 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000675 for(i=0; i<ArraySize(aFlagOp); i++){
676 if( aFlagOp[i].op==op ){
677 int onoff = va_arg(ap, int);
678 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000679 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000680 if( onoff>0 ){
681 db->flags |= aFlagOp[i].mask;
682 }else if( onoff==0 ){
683 db->flags &= ~aFlagOp[i].mask;
684 }
685 if( oldFlags!=db->flags ){
686 sqlite3ExpirePreparedStatements(db);
687 }
688 if( pRes ){
689 *pRes = (db->flags & aFlagOp[i].mask)!=0;
690 }
691 rc = SQLITE_OK;
692 break;
693 }
694 }
drh6480aad2008-08-01 16:31:14 +0000695 break;
696 }
drh633e6d52008-07-28 19:34:53 +0000697 }
698 va_end(ap);
699 return rc;
700}
701
drha16313e2007-03-30 11:29:32 +0000702
703/*
drh9b5adfa2008-01-20 23:19:56 +0000704** Return true if the buffer z[0..n-1] contains all spaces.
705*/
706static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000707 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000708 return n==0;
709}
710
711/*
drhd3d39e92004-05-20 22:16:29 +0000712** This is the default collating function named "BINARY" which is always
713** available.
drh9b5adfa2008-01-20 23:19:56 +0000714**
715** If the padFlag argument is not NULL then space padding at the end
716** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000717*/
danielk19772c336542005-01-13 02:14:23 +0000718static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000719 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000720 int nKey1, const void *pKey1,
721 int nKey2, const void *pKey2
722){
723 int rc, n;
724 n = nKey1<nKey2 ? nKey1 : nKey2;
725 rc = memcmp(pKey1, pKey2, n);
726 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000727 if( padFlag
728 && allSpaces(((char*)pKey1)+n, nKey1-n)
729 && allSpaces(((char*)pKey2)+n, nKey2-n)
730 ){
731 /* Leave rc unchanged at 0 */
732 }else{
733 rc = nKey1 - nKey2;
734 }
drhd3d39e92004-05-20 22:16:29 +0000735 }
736 return rc;
737}
738
739/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000740** Another built-in collating sequence: NOCASE.
741**
drhf7b54962013-05-28 12:11:54 +0000742** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000743** comparison". SQLite's knowledge of upper and lower case equivalents
744** extends only to the 26 characters used in the English language.
745**
746** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000747*/
748static int nocaseCollatingFunc(
749 void *NotUsed,
750 int nKey1, const void *pKey1,
751 int nKey2, const void *pKey2
752){
753 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000754 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000755 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000756 if( 0==r ){
757 r = nKey1-nKey2;
758 }
759 return r;
760}
761
762/*
drhaf9ff332002-01-16 21:00:27 +0000763** Return the ROWID of the most recent insert
764*/
drh9bb575f2004-09-06 17:24:11 +0000765sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000766#ifdef SQLITE_ENABLE_API_ARMOR
767 if( !sqlite3SafetyCheckOk(db) ){
768 (void)SQLITE_MISUSE_BKPT;
769 return 0;
770 }
771#endif
drhaf9ff332002-01-16 21:00:27 +0000772 return db->lastRowid;
773}
774
775/*
danielk197724b03fd2004-05-10 10:34:34 +0000776** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000777*/
drh9bb575f2004-09-06 17:24:11 +0000778int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000779#ifdef SQLITE_ENABLE_API_ARMOR
780 if( !sqlite3SafetyCheckOk(db) ){
781 (void)SQLITE_MISUSE_BKPT;
782 return 0;
783 }
784#endif
drhc8d30ac2002-04-12 10:08:59 +0000785 return db->nChange;
786}
787
rdcf146a772004-02-25 22:51:06 +0000788/*
danielk1977b28af712004-06-21 06:50:26 +0000789** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000790*/
danielk1977b28af712004-06-21 06:50:26 +0000791int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000792#ifdef SQLITE_ENABLE_API_ARMOR
793 if( !sqlite3SafetyCheckOk(db) ){
794 (void)SQLITE_MISUSE_BKPT;
795 return 0;
796 }
797#endif
danielk1977b28af712004-06-21 06:50:26 +0000798 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000799}
800
drhc8d30ac2002-04-12 10:08:59 +0000801/*
danielk1977fd7f0452008-12-17 17:30:26 +0000802** Close all open savepoints. This function only manipulates fields of the
803** database handle object, it does not close any savepoints that may be open
804** at the b-tree/pager level.
805*/
806void sqlite3CloseSavepoints(sqlite3 *db){
807 while( db->pSavepoint ){
808 Savepoint *pTmp = db->pSavepoint;
809 db->pSavepoint = pTmp->pNext;
810 sqlite3DbFree(db, pTmp);
811 }
812 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000813 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000814 db->isTransactionSavepoint = 0;
815}
816
817/*
dand2199f02010-08-27 17:48:52 +0000818** Invoke the destructor function associated with FuncDef p, if any. Except,
819** if this is not the last copy of the function, do not invoke it. Multiple
820** copies of a single function are created when create_function() is called
821** with SQLITE_ANY as the encoding.
822*/
823static void functionDestroy(sqlite3 *db, FuncDef *p){
824 FuncDestructor *pDestructor = p->pDestructor;
825 if( pDestructor ){
826 pDestructor->nRef--;
827 if( pDestructor->nRef==0 ){
828 pDestructor->xDestroy(pDestructor->pUserData);
829 sqlite3DbFree(db, pDestructor);
830 }
831 }
832}
833
834/*
danbba02a92012-05-15 17:15:34 +0000835** Disconnect all sqlite3_vtab objects that belong to database connection
836** db. This is called when db is being closed.
837*/
838static void disconnectAllVtab(sqlite3 *db){
839#ifndef SQLITE_OMIT_VIRTUALTABLE
840 int i;
841 sqlite3BtreeEnterAll(db);
842 for(i=0; i<db->nDb; i++){
843 Schema *pSchema = db->aDb[i].pSchema;
844 if( db->aDb[i].pSchema ){
845 HashElem *p;
846 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
847 Table *pTab = (Table *)sqliteHashData(p);
848 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
849 }
850 }
851 }
dand88e5212014-03-12 19:38:38 +0000852 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000853 sqlite3BtreeLeaveAll(db);
854#else
855 UNUSED_PARAMETER(db);
856#endif
857}
858
859/*
drh167cd6a2012-06-02 17:09:46 +0000860** Return TRUE if database connection db has unfinalized prepared
861** statements or unfinished sqlite3_backup objects.
862*/
863static int connectionIsBusy(sqlite3 *db){
864 int j;
865 assert( sqlite3_mutex_held(db->mutex) );
866 if( db->pVdbe ) return 1;
867 for(j=0; j<db->nDb; j++){
868 Btree *pBt = db->aDb[j].pBt;
869 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
870 }
871 return 0;
872}
873
874/*
drh50e5dad2001-09-15 00:57:28 +0000875** Close an existing SQLite database
876*/
drh167cd6a2012-06-02 17:09:46 +0000877static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000878 if( !db ){
drhddb17ca2014-08-11 15:54:11 +0000879 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
880 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +0000881 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000882 }
drh7e8b8482008-01-23 03:03:05 +0000883 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000884 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000885 }
drh605264d2007-08-21 15:13:19 +0000886 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000887
danbba02a92012-05-15 17:15:34 +0000888 /* Force xDisconnect calls on all virtual tables */
889 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000890
danbba02a92012-05-15 17:15:34 +0000891 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000892 ** will not have called the xDisconnect() method on any virtual
893 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
894 ** call will do so. We need to do this before the check for active
895 ** SQL statements below, as the v-table implementation may be storing
896 ** some prepared statements internally.
897 */
dan67430812013-05-15 10:21:50 +0000898 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000899
drh167cd6a2012-06-02 17:09:46 +0000900 /* Legacy behavior (sqlite3_close() behavior) is to return
901 ** SQLITE_BUSY if the connection can not be closed immediately.
902 */
903 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +0000904 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +0000905 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000906 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000907 return SQLITE_BUSY;
908 }
danielk1977e0048402004-06-15 16:51:01 +0000909
danac455932012-11-26 19:50:41 +0000910#ifdef SQLITE_ENABLE_SQLLOG
911 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +0000912 /* Closing the handle. Fourth parameter is passed the value 2. */
913 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +0000914 }
915#endif
916
drh167cd6a2012-06-02 17:09:46 +0000917 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +0000918 */
919 db->magic = SQLITE_MAGIC_ZOMBIE;
920 sqlite3LeaveMutexAndCloseZombie(db);
921 return SQLITE_OK;
922}
drh94e92032003-02-16 22:21:32 +0000923
drh167cd6a2012-06-02 17:09:46 +0000924/*
925** Two variations on the public interface for closing a database
926** connection. The sqlite3_close() version returns SQLITE_BUSY and
927** leaves the connection option if there are unfinalized prepared
928** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
929** version forces the connection to become a zombie if there are
930** unclosed resources, and arranges for deallocation when the last
931** prepare statement or sqlite3_backup closes.
932*/
933int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
934int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
935
drh4245c402012-06-02 14:32:21 +0000936
937/*
938** Close the mutex on database connection db.
939**
940** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +0000941** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
942** every sqlite3_stmt has now been finalized and every sqlite3_backup has
943** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +0000944*/
945void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
946 HashElem *i; /* Hash table iterator */
947 int j;
948
drh4245c402012-06-02 14:32:21 +0000949 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +0000950 ** or if the connection has not yet been closed by sqlite3_close_v2(),
951 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +0000952 */
drh167cd6a2012-06-02 17:09:46 +0000953 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +0000954 sqlite3_mutex_leave(db->mutex);
955 return;
danielk197704103022009-02-03 16:51:24 +0000956 }
957
drh4245c402012-06-02 14:32:21 +0000958 /* If we reach this point, it means that the database connection has
959 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +0000960 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +0000961 ** go ahead and free all resources.
962 */
963
dan617dc862013-05-16 11:57:28 +0000964 /* If a transaction is open, roll it back. This also ensures that if
965 ** any database schemas have been modified by an uncommitted transaction
966 ** they are reset. And that the required b-tree mutex is held to make
967 ** the pager rollback and schema reset an atomic operation. */
968 sqlite3RollbackAll(db, SQLITE_OK);
969
danielk1977fd7f0452008-12-17 17:30:26 +0000970 /* Free any outstanding Savepoint structures. */
971 sqlite3CloseSavepoints(db);
972
drh5efb3142012-05-16 01:24:34 +0000973 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000974 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000975 struct Db *pDb = &db->aDb[j];
976 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000977 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000978 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000979 if( j!=1 ){
980 pDb->pSchema = 0;
981 }
drh113088e2003-03-20 01:16:58 +0000982 }
drhf57b3392001-10-08 13:22:32 +0000983 }
drh5efb3142012-05-16 01:24:34 +0000984 /* Clear the TEMP schema separately and last */
985 if( db->aDb[1].pSchema ){
986 sqlite3SchemaClear(db->aDb[1].pSchema);
987 }
988 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000989
drh5efb3142012-05-16 01:24:34 +0000990 /* Free up the array of auxiliary databases */
991 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000992 assert( db->nDb<=2 );
993 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000994
995 /* Tell the code in notify.c that the connection no longer holds any
996 ** locks and does not require any further unlock-notify callbacks.
997 */
998 sqlite3ConnectionClosed(db);
999
drh70a8ca32008-08-21 18:49:27 +00001000 for(j=0; j<ArraySize(db->aFunc.a); j++){
1001 FuncDef *pNext, *pHash, *p;
1002 for(p=db->aFunc.a[j]; p; p=pHash){
1003 pHash = p->pHash;
1004 while( p ){
dand2199f02010-08-27 17:48:52 +00001005 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +00001006 pNext = p->pNext;
1007 sqlite3DbFree(db, p);
1008 p = pNext;
1009 }
drh8e0a2f92002-02-23 23:45:45 +00001010 }
1011 }
danielk1977d8123362004-06-12 09:25:12 +00001012 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001013 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001014 /* Invoke any destructors registered for collation sequence user data. */
1015 for(j=0; j<3; j++){
1016 if( pColl[j].xDel ){
1017 pColl[j].xDel(pColl[j].pUser);
1018 }
1019 }
drh633e6d52008-07-28 19:34:53 +00001020 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001021 }
danielk1977d8123362004-06-12 09:25:12 +00001022 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001023#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001024 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1025 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001026 if( pMod->xDestroy ){
1027 pMod->xDestroy(pMod->pAux);
1028 }
drh633e6d52008-07-28 19:34:53 +00001029 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001030 }
drhb9bb7c12006-06-11 23:41:55 +00001031 sqlite3HashClear(&db->aModule);
1032#endif
danielk1977466be562004-06-10 02:16:01 +00001033
drh13f40da2014-08-22 18:00:11 +00001034 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001035 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001036 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001037#if SQLITE_USER_AUTHENTICATION
1038 sqlite3_free(db->auth.zAuthUser);
1039 sqlite3_free(db->auth.zAuthPW);
1040#endif
danielk197796d81f92004-06-19 03:33:57 +00001041
1042 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001043
1044 /* The temp-database schema is allocated differently from the other schema
1045 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1046 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1047 ** the same sqliteMalloc() as the one that allocates the database
1048 ** structure?
1049 */
drh633e6d52008-07-28 19:34:53 +00001050 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001051 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001052 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001053 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001054 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001055 if( db->lookaside.bMalloced ){
1056 sqlite3_free(db->lookaside.pStart);
1057 }
drh17435752007-08-16 04:30:38 +00001058 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001059}
1060
1061/*
drh0f198a72012-02-13 16:43:16 +00001062** Rollback all database files. If tripCode is not SQLITE_OK, then
1063** any open cursors are invalidated ("tripped" - as in "tripping a circuit
1064** breaker") and made to return tripCode if there are any further
1065** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +00001066*/
drh0f198a72012-02-13 16:43:16 +00001067void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001068 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001069 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +00001070 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001071 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001072
1073 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1074 ** This is important in case the transaction being rolled back has
1075 ** modified the database schema. If the b-tree mutexes are not taken
1076 ** here, then another shared-cache connection might sneak in between
1077 ** the database rollback and schema reset, which can cause false
1078 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001079 sqlite3BtreeEnterAll(db);
dan617dc862013-05-16 11:57:28 +00001080
drh001bbcb2003-03-19 03:14:00 +00001081 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001082 Btree *p = db->aDb[i].pBt;
1083 if( p ){
1084 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001085 inTrans = 1;
1086 }
drh0f198a72012-02-13 16:43:16 +00001087 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +00001088 }
1089 }
danielk1977a298e902006-06-22 09:53:48 +00001090 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001091 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001092
drh5c5760a2013-02-19 18:34:45 +00001093 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001094 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001095 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001096 }
dancd7b91a2013-05-13 18:23:15 +00001097 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001098
dan1da40a32009-09-19 17:00:31 +00001099 /* Any deferred constraint violations have now been resolved. */
1100 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001101 db->nDeferredImmCons = 0;
1102 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001103
danielk197771fd80b2005-12-16 06:54:01 +00001104 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001105 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001106 db->xRollbackCallback(db->pRollbackArg);
1107 }
drh001bbcb2003-03-19 03:14:00 +00001108}
1109
1110/*
mistachkinf2c1c992013-04-28 01:44:43 +00001111** Return a static string containing the name corresponding to the error code
1112** specified in the argument.
1113*/
drh54027102014-08-06 14:36:53 +00001114#if (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) || defined(SQLITE_TEST)
mistachkinf2c1c992013-04-28 01:44:43 +00001115const char *sqlite3ErrName(int rc){
1116 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001117 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001118 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1119 switch( rc ){
1120 case SQLITE_OK: zName = "SQLITE_OK"; break;
1121 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1122 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1123 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1124 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001125 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001126 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001127 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001128 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001129 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1130 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1131 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1132 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001133 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1134 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1135 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001136 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001137 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1138 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001139 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1140 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1141 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1142 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1143 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1144 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1145 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1146 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1147 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1148 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001149 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1150 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1151 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1152 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1153 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1154 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1155 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1156 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1157 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1158 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1159 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1160 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1161 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1162 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001163 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001164 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001165 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001166 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001167 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1168 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1169 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001170 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1171 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1172 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001173 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001174 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1175 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1176 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1177 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1178 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1179 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1180 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1181 case SQLITE_CONSTRAINT_FOREIGNKEY:
1182 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1183 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1184 case SQLITE_CONSTRAINT_PRIMARYKEY:
1185 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1186 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1187 case SQLITE_CONSTRAINT_COMMITHOOK:
1188 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1189 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1190 case SQLITE_CONSTRAINT_FUNCTION:
1191 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001192 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001193 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1194 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1195 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1196 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1197 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1198 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1199 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1200 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1201 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001202 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1203 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1204 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001205 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001206 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001207 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001208 }
1209 }
mistachkin10269dc2013-04-30 07:54:42 +00001210 if( zName==0 ){
1211 static char zBuf[50];
1212 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1213 zName = zBuf;
1214 }
mistachkinf2c1c992013-04-28 01:44:43 +00001215 return zName;
1216}
mistachkin10269dc2013-04-30 07:54:42 +00001217#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001218
1219/*
drhc22bd472002-05-10 13:14:07 +00001220** Return a static string that describes the kind of error specified in the
1221** argument.
drh247be432002-05-10 05:44:55 +00001222*/
danielk1977f20b21c2004-05-31 23:56:42 +00001223const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001224 static const char* const aMsg[] = {
1225 /* SQLITE_OK */ "not an error",
1226 /* SQLITE_ERROR */ "SQL logic error or missing database",
1227 /* SQLITE_INTERNAL */ 0,
1228 /* SQLITE_PERM */ "access permission denied",
1229 /* SQLITE_ABORT */ "callback requested query abort",
1230 /* SQLITE_BUSY */ "database is locked",
1231 /* SQLITE_LOCKED */ "database table is locked",
1232 /* SQLITE_NOMEM */ "out of memory",
1233 /* SQLITE_READONLY */ "attempt to write a readonly database",
1234 /* SQLITE_INTERRUPT */ "interrupted",
1235 /* SQLITE_IOERR */ "disk I/O error",
1236 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001237 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001238 /* SQLITE_FULL */ "database or disk is full",
1239 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001240 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001241 /* SQLITE_EMPTY */ "table contains no data",
1242 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001243 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001244 /* SQLITE_CONSTRAINT */ "constraint failed",
1245 /* SQLITE_MISMATCH */ "datatype mismatch",
1246 /* SQLITE_MISUSE */ "library routine called out of sequence",
1247 /* SQLITE_NOLFS */ "large file support is disabled",
1248 /* SQLITE_AUTH */ "authorization denied",
1249 /* SQLITE_FORMAT */ "auxiliary database format error",
1250 /* SQLITE_RANGE */ "bind or column index out of range",
1251 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1252 };
drh21021a52012-02-13 17:01:51 +00001253 const char *zErr = "unknown error";
1254 switch( rc ){
1255 case SQLITE_ABORT_ROLLBACK: {
1256 zErr = "abort due to ROLLBACK";
1257 break;
1258 }
1259 default: {
1260 rc &= 0xff;
1261 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1262 zErr = aMsg[rc];
1263 }
1264 break;
1265 }
drh247be432002-05-10 05:44:55 +00001266 }
drh21021a52012-02-13 17:01:51 +00001267 return zErr;
drh247be432002-05-10 05:44:55 +00001268}
1269
1270/*
drh2dfbbca2000-07-28 14:32:48 +00001271** This routine implements a busy callback that sleeps and tries
1272** again until a timeout value is reached. The timeout value is
1273** an integer number of milliseconds passed in as the first
1274** argument.
1275*/
drhdaffd0e2001-04-11 14:28:42 +00001276static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001277 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001278 int count /* Number of times table has been busy */
1279){
danielk197729bafea2008-06-26 10:41:19 +00001280#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001281 static const u8 delays[] =
1282 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1283 static const u8 totals[] =
1284 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001285# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001286 sqlite3 *db = (sqlite3 *)ptr;
1287 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001288 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001289
drhee570fa2005-04-28 12:06:05 +00001290 assert( count>=0 );
1291 if( count < NDELAY ){
1292 delay = delays[count];
1293 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001294 }else{
1295 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001296 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001297 }
drhd1bec472004-01-15 13:29:31 +00001298 if( prior + delay > timeout ){
1299 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001300 if( delay<=0 ) return 0;
1301 }
danielk19772a6bdf62007-08-20 16:07:00 +00001302 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001303 return 1;
1304#else
drh482ea182007-08-20 11:12:40 +00001305 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001306 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001307 if( (count+1)*1000 > timeout ){
1308 return 0;
1309 }
drh482ea182007-08-20 11:12:40 +00001310 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001311 return 1;
1312#endif
1313}
1314
1315/*
drha4afb652005-07-09 02:16:02 +00001316** Invoke the given busy handler.
1317**
1318** This routine is called when an operation failed with a lock.
1319** If this routine returns non-zero, the lock is retried. If it
1320** returns 0, the operation aborts with an SQLITE_BUSY error.
1321*/
1322int sqlite3InvokeBusyHandler(BusyHandler *p){
1323 int rc;
drh34004ce2008-07-11 16:15:17 +00001324 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001325 rc = p->xFunc(p->pArg, p->nBusy);
1326 if( rc==0 ){
1327 p->nBusy = -1;
1328 }else{
1329 p->nBusy++;
1330 }
1331 return rc;
1332}
1333
1334/*
drh2dfbbca2000-07-28 14:32:48 +00001335** This routine sets the busy callback for an Sqlite database to the
1336** given callback function with the given argument.
1337*/
danielk1977f9d64d22004-06-19 08:18:07 +00001338int sqlite3_busy_handler(
1339 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001340 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001341 void *pArg
1342){
drh9ca95732014-10-24 00:35:58 +00001343#ifdef SQLITE_ENABLE_API_ARMOR
1344 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE;
1345#endif
drhe30f4422007-08-21 16:15:55 +00001346 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001347 db->busyHandler.xFunc = xBusy;
1348 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001349 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001350 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001351 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001352 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001353}
1354
danielk1977348bb5d2003-10-18 09:37:26 +00001355#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1356/*
1357** This routine sets the progress callback for an Sqlite database to the
1358** given callback function with the given argument. The progress callback will
1359** be invoked every nOps opcodes.
1360*/
danielk197724b03fd2004-05-10 10:34:34 +00001361void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001362 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001363 int nOps,
1364 int (*xProgress)(void*),
1365 void *pArg
1366){
drh9ca95732014-10-24 00:35:58 +00001367#ifdef SQLITE_ENABLE_API_ARMOR
1368 if( !sqlite3SafetyCheckOk(db) ){
1369 (void)SQLITE_MISUSE_BKPT;
1370 return;
1371 }
1372#endif
drhbd0b1b52008-07-07 19:52:09 +00001373 sqlite3_mutex_enter(db->mutex);
1374 if( nOps>0 ){
1375 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001376 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001377 db->pProgressArg = pArg;
1378 }else{
1379 db->xProgress = 0;
1380 db->nProgressOps = 0;
1381 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001382 }
drhbd0b1b52008-07-07 19:52:09 +00001383 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001384}
1385#endif
1386
1387
drh2dfbbca2000-07-28 14:32:48 +00001388/*
1389** This routine installs a default busy handler that waits for the
1390** specified number of milliseconds before returning 0.
1391*/
danielk1977f9d64d22004-06-19 08:18:07 +00001392int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001393#ifdef SQLITE_ENABLE_API_ARMOR
1394 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1395#endif
drh2dfbbca2000-07-28 14:32:48 +00001396 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001397 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001398 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001399 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001400 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001401 }
danielk1977f9d64d22004-06-19 08:18:07 +00001402 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001403}
drh4c504392000-10-16 22:06:40 +00001404
1405/*
1406** Cause any pending operation to stop at its earliest opportunity.
1407*/
drh9bb575f2004-09-06 17:24:11 +00001408void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001409#ifdef SQLITE_ENABLE_API_ARMOR
1410 if( !sqlite3SafetyCheckOk(db) ){
1411 (void)SQLITE_MISUSE_BKPT;
1412 return;
1413 }
1414#endif
drhbd0b1b52008-07-07 19:52:09 +00001415 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001416}
drhfa86c412002-02-02 15:01:15 +00001417
drhfa86c412002-02-02 15:01:15 +00001418
1419/*
danielk1977771151b2006-01-17 13:21:40 +00001420** This function is exactly the same as sqlite3_create_function(), except
1421** that it is designed to be called by internal code. The difference is
1422** that if a malloc() fails in sqlite3_create_function(), an error code
1423** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001424*/
danielk1977771151b2006-01-17 13:21:40 +00001425int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001426 sqlite3 *db,
1427 const char *zFunctionName,
1428 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001429 int enc,
danielk197765904932004-05-26 06:18:37 +00001430 void *pUserData,
1431 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1432 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001433 void (*xFinal)(sqlite3_context*),
1434 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001435){
drh0bce8352002-02-28 00:41:10 +00001436 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001437 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001438 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001439
drhe30f4422007-08-21 16:15:55 +00001440 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001441 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001442 (xFunc && (xFinal || xStep)) ||
1443 (!xFunc && (xFinal && !xStep)) ||
1444 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001445 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001446 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001447 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001448 }
drh4a8ee3d2013-12-14 13:44:22 +00001449
1450 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1451 extraFlags = enc & SQLITE_DETERMINISTIC;
1452 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001453
danielk197793758c82005-01-21 08:13:14 +00001454#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001455 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1456 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1457 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1458 **
1459 ** If SQLITE_ANY is specified, add three versions of the function
1460 ** to the hash table.
1461 */
1462 if( enc==SQLITE_UTF16 ){
1463 enc = SQLITE_UTF16NATIVE;
1464 }else if( enc==SQLITE_ANY ){
1465 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001466 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dand2199f02010-08-27 17:48:52 +00001467 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001468 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001469 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dand2199f02010-08-27 17:48:52 +00001470 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001471 }
1472 if( rc!=SQLITE_OK ){
1473 return rc;
1474 }
danielk1977d8123362004-06-12 09:25:12 +00001475 enc = SQLITE_UTF16BE;
1476 }
danielk197793758c82005-01-21 08:13:14 +00001477#else
1478 enc = SQLITE_UTF8;
1479#endif
danielk19779636c4e2005-01-25 04:27:54 +00001480
1481 /* Check if an existing function is being overridden or deleted. If so,
1482 ** and there are active VMs, then return SQLITE_BUSY. If a function
1483 ** is being overridden/deleted but there are no active VMs, allow the
1484 ** operation to continue but invalidate all precompiled statements.
1485 */
drh3abbd392008-12-10 23:04:13 +00001486 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001487 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001488 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001489 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001490 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001491 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001492 return SQLITE_BUSY;
1493 }else{
1494 sqlite3ExpirePreparedStatements(db);
1495 }
1496 }
danielk197765904932004-05-26 06:18:37 +00001497
drh3abbd392008-12-10 23:04:13 +00001498 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001499 assert(p || db->mallocFailed);
1500 if( !p ){
1501 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001502 }
dand2199f02010-08-27 17:48:52 +00001503
1504 /* If an older version of the function with a configured destructor is
1505 ** being replaced invoke the destructor function here. */
1506 functionDestroy(db, p);
1507
1508 if( pDestructor ){
1509 pDestructor->nRef++;
1510 }
1511 p->pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001512 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1513 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
danielk1977fa18bec2007-09-03 11:04:22 +00001514 p->xFunc = xFunc;
1515 p->xStep = xStep;
1516 p->xFinalize = xFinal;
1517 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001518 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001519 return SQLITE_OK;
1520}
danielk1977771151b2006-01-17 13:21:40 +00001521
1522/*
1523** Create new user functions.
1524*/
1525int sqlite3_create_function(
1526 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001527 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001528 int nArg,
1529 int enc,
1530 void *p,
1531 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1532 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1533 void (*xFinal)(sqlite3_context*)
1534){
drh7b19fac2010-08-27 18:44:54 +00001535 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1536 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001537}
1538
1539int sqlite3_create_function_v2(
1540 sqlite3 *db,
1541 const char *zFunc,
1542 int nArg,
1543 int enc,
1544 void *p,
1545 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1546 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1547 void (*xFinal)(sqlite3_context*),
1548 void (*xDestroy)(void *)
1549){
shanehbd2aaf92010-09-01 02:38:21 +00001550 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001551 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001552
1553#ifdef SQLITE_ENABLE_API_ARMOR
1554 if( !sqlite3SafetyCheckOk(db) ){
1555 return SQLITE_MISUSE_BKPT;
1556 }
1557#endif
dand2199f02010-08-27 17:48:52 +00001558 sqlite3_mutex_enter(db->mutex);
1559 if( xDestroy ){
1560 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001561 if( !pArg ){
1562 xDestroy(p);
1563 goto out;
1564 }
dand2199f02010-08-27 17:48:52 +00001565 pArg->xDestroy = xDestroy;
1566 pArg->pUserData = p;
1567 }
1568 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1569 if( pArg && pArg->nRef==0 ){
1570 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001571 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001572 sqlite3DbFree(db, pArg);
1573 }
1574
1575 out:
drhe30f4422007-08-21 16:15:55 +00001576 rc = sqlite3ApiExit(db, rc);
1577 sqlite3_mutex_leave(db->mutex);
1578 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001579}
1580
danielk197793758c82005-01-21 08:13:14 +00001581#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001582int sqlite3_create_function16(
1583 sqlite3 *db,
1584 const void *zFunctionName,
1585 int nArg,
1586 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001587 void *p,
danielk197765904932004-05-26 06:18:37 +00001588 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1589 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1590 void (*xFinal)(sqlite3_context*)
1591){
1592 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001593 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001594
1595#ifdef SQLITE_ENABLE_API_ARMOR
1596 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1597#endif
drhe30f4422007-08-21 16:15:55 +00001598 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001599 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001600 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001601 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001602 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001603 rc = sqlite3ApiExit(db, rc);
1604 sqlite3_mutex_leave(db->mutex);
1605 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001606}
danielk197793758c82005-01-21 08:13:14 +00001607#endif
drhc9b84a12002-06-20 11:36:48 +00001608
drhb7481e72006-09-16 21:45:14 +00001609
1610/*
1611** Declare that a function has been overloaded by a virtual table.
1612**
1613** If the function already exists as a regular global function, then
1614** this routine is a no-op. If the function does not exist, then create
1615** a new one that always throws a run-time error.
1616**
1617** When virtual tables intend to provide an overloaded function, they
1618** should call this routine to make sure the global function exists.
1619** A global function must exist in order for name resolution to work
1620** properly.
1621*/
1622int sqlite3_overload_function(
1623 sqlite3 *db,
1624 const char *zName,
1625 int nArg
1626){
drhdee0e402009-05-03 20:23:53 +00001627 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001628 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001629
1630#ifdef SQLITE_ENABLE_API_ARMOR
1631 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1632 return SQLITE_MISUSE_BKPT;
1633 }
1634#endif
drhe30f4422007-08-21 16:15:55 +00001635 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001636 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001637 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1638 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001639 }
drhcb5e4db2011-10-12 23:49:49 +00001640 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001641 sqlite3_mutex_leave(db->mutex);
1642 return rc;
drhb7481e72006-09-16 21:45:14 +00001643}
1644
drh19e2d372005-08-29 23:00:03 +00001645#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001646/*
drh18de4822003-01-16 16:28:53 +00001647** Register a trace function. The pArg from the previously registered trace
1648** is returned.
1649**
1650** A NULL trace function means that no tracing is executes. A non-NULL
1651** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001652** SQL statement.
drh18de4822003-01-16 16:28:53 +00001653*/
drh9bb575f2004-09-06 17:24:11 +00001654void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001655 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001656
1657#ifdef SQLITE_ENABLE_API_ARMOR
1658 if( !sqlite3SafetyCheckOk(db) ){
1659 (void)SQLITE_MISUSE_BKPT;
1660 return 0;
1661 }
1662#endif
drhe30f4422007-08-21 16:15:55 +00001663 sqlite3_mutex_enter(db->mutex);
1664 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001665 db->xTrace = xTrace;
1666 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001667 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001668 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001669}
drh19e2d372005-08-29 23:00:03 +00001670/*
1671** Register a profile function. The pArg from the previously registered
1672** profile function is returned.
1673**
1674** A NULL profile function means that no profiling is executes. A non-NULL
1675** profile is a pointer to a function that is invoked at the conclusion of
1676** each SQL statement that is run.
1677*/
1678void *sqlite3_profile(
1679 sqlite3 *db,
1680 void (*xProfile)(void*,const char*,sqlite_uint64),
1681 void *pArg
1682){
drhe30f4422007-08-21 16:15:55 +00001683 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001684
1685#ifdef SQLITE_ENABLE_API_ARMOR
1686 if( !sqlite3SafetyCheckOk(db) ){
1687 (void)SQLITE_MISUSE_BKPT;
1688 return 0;
1689 }
1690#endif
drhe30f4422007-08-21 16:15:55 +00001691 sqlite3_mutex_enter(db->mutex);
1692 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001693 db->xProfile = xProfile;
1694 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001695 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001696 return pOld;
1697}
1698#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001699
drhcd565fd2012-03-01 21:30:44 +00001700/*
1701** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001702** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001703** rollback.
1704*/
danielk197724b03fd2004-05-10 10:34:34 +00001705void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001706 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001707 int (*xCallback)(void*), /* Function to invoke on each commit */
1708 void *pArg /* Argument to the function */
1709){
drhe30f4422007-08-21 16:15:55 +00001710 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001711
1712#ifdef SQLITE_ENABLE_API_ARMOR
1713 if( !sqlite3SafetyCheckOk(db) ){
1714 (void)SQLITE_MISUSE_BKPT;
1715 return 0;
1716 }
1717#endif
drhe30f4422007-08-21 16:15:55 +00001718 sqlite3_mutex_enter(db->mutex);
1719 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001720 db->xCommitCallback = xCallback;
1721 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001722 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001723 return pOld;
1724}
1725
danielk197794eb6a12005-12-15 15:22:08 +00001726/*
1727** Register a callback to be invoked each time a row is updated,
1728** inserted or deleted using this database connection.
1729*/
danielk197771fd80b2005-12-16 06:54:01 +00001730void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001731 sqlite3 *db, /* Attach the hook to this database */
1732 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1733 void *pArg /* Argument to the function */
1734){
drhe30f4422007-08-21 16:15:55 +00001735 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001736
1737#ifdef SQLITE_ENABLE_API_ARMOR
1738 if( !sqlite3SafetyCheckOk(db) ){
1739 (void)SQLITE_MISUSE_BKPT;
1740 return 0;
1741 }
1742#endif
drhe30f4422007-08-21 16:15:55 +00001743 sqlite3_mutex_enter(db->mutex);
1744 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001745 db->xUpdateCallback = xCallback;
1746 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001747 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001748 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001749}
1750
danielk197771fd80b2005-12-16 06:54:01 +00001751/*
1752** Register a callback to be invoked each time a transaction is rolled
1753** back by this database connection.
1754*/
1755void *sqlite3_rollback_hook(
1756 sqlite3 *db, /* Attach the hook to this database */
1757 void (*xCallback)(void*), /* Callback function */
1758 void *pArg /* Argument to the function */
1759){
drhe30f4422007-08-21 16:15:55 +00001760 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001761
1762#ifdef SQLITE_ENABLE_API_ARMOR
1763 if( !sqlite3SafetyCheckOk(db) ){
1764 (void)SQLITE_MISUSE_BKPT;
1765 return 0;
1766 }
1767#endif
drhe30f4422007-08-21 16:15:55 +00001768 sqlite3_mutex_enter(db->mutex);
1769 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001770 db->xRollbackCallback = xCallback;
1771 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001772 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001773 return pRet;
1774}
drhaa940ea2004-01-15 02:44:03 +00001775
dan586b9c82010-05-03 08:04:49 +00001776#ifndef SQLITE_OMIT_WAL
1777/*
1778** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001779** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1780** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001781** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001782*/
drhb033d8b2010-05-03 13:37:30 +00001783int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001784 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001785 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001786 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001787 int nFrame /* Size of WAL */
1788){
drh5def0842010-05-05 20:00:25 +00001789 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001790 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001791 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001792 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001793 }
1794 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001795}
drhb033d8b2010-05-03 13:37:30 +00001796#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001797
1798/*
1799** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1800** a database after committing a transaction if there are nFrame or
1801** more frames in the log file. Passing zero or a negative value as the
1802** nFrame parameter disables automatic checkpoints entirely.
1803**
1804** The callback registered by this function replaces any existing callback
1805** registered using sqlite3_wal_hook(). Likewise, registering a callback
1806** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1807** configured by this function.
1808*/
1809int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001810#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001811 UNUSED_PARAMETER(db);
1812 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001813#else
drh9ca95732014-10-24 00:35:58 +00001814#ifdef SQLITE_ENABLE_API_ARMOR
1815 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1816#endif
dan586b9c82010-05-03 08:04:49 +00001817 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001818 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001819 }else{
1820 sqlite3_wal_hook(db, 0, 0);
1821 }
drhb033d8b2010-05-03 13:37:30 +00001822#endif
dan586b9c82010-05-03 08:04:49 +00001823 return SQLITE_OK;
1824}
1825
paulb0208cc2003-04-13 18:26:49 +00001826/*
dan8d22a172010-04-19 18:03:51 +00001827** Register a callback to be invoked each time a transaction is written
1828** into the write-ahead-log by this database connection.
1829*/
drh833bf962010-04-28 14:42:19 +00001830void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001831 sqlite3 *db, /* Attach the hook to this db handle */
1832 int(*xCallback)(void *, sqlite3*, const char*, int),
1833 void *pArg /* First argument passed to xCallback() */
1834){
drhb033d8b2010-05-03 13:37:30 +00001835#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001836 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001837#ifdef SQLITE_ENABLE_API_ARMOR
1838 if( !sqlite3SafetyCheckOk(db) ){
1839 (void)SQLITE_MISUSE_BKPT;
1840 return 0;
1841 }
1842#endif
dan8d22a172010-04-19 18:03:51 +00001843 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001844 pRet = db->pWalArg;
1845 db->xWalCallback = xCallback;
1846 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001847 sqlite3_mutex_leave(db->mutex);
1848 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001849#else
1850 return 0;
1851#endif
dan8d22a172010-04-19 18:03:51 +00001852}
1853
1854/*
dancdc1f042010-11-18 12:11:05 +00001855** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001856*/
dancdc1f042010-11-18 12:11:05 +00001857int sqlite3_wal_checkpoint_v2(
1858 sqlite3 *db, /* Database handle */
1859 const char *zDb, /* Name of attached database (or NULL) */
1860 int eMode, /* SQLITE_CHECKPOINT_* value */
1861 int *pnLog, /* OUT: Size of WAL log in frames */
1862 int *pnCkpt /* OUT: Total number of frames checkpointed */
1863){
drhb033d8b2010-05-03 13:37:30 +00001864#ifdef SQLITE_OMIT_WAL
1865 return SQLITE_OK;
1866#else
dan586b9c82010-05-03 08:04:49 +00001867 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001868 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001869
drh9ca95732014-10-24 00:35:58 +00001870#ifdef SQLITE_ENABLE_API_ARMOR
1871 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1872#endif
1873
dan9c5e3682011-02-07 15:12:12 +00001874 /* Initialize the output variables to -1 in case an error occurs. */
1875 if( pnLog ) *pnLog = -1;
1876 if( pnCkpt ) *pnCkpt = -1;
1877
drh383d79e2011-02-09 03:03:16 +00001878 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1879 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1880 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1881 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001882 return SQLITE_MISUSE;
1883 }
1884
dan586b9c82010-05-03 08:04:49 +00001885 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001886 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001887 iDb = sqlite3FindDbName(db, zDb);
1888 }
1889 if( iDb<0 ){
1890 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00001891 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001892 }else{
dancdc1f042010-11-18 12:11:05 +00001893 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00001894 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00001895 }
drhb033d8b2010-05-03 13:37:30 +00001896 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001897 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001898 return rc;
1899#endif
dan586b9c82010-05-03 08:04:49 +00001900}
1901
dancdc1f042010-11-18 12:11:05 +00001902
1903/*
1904** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1905** to contains a zero-length string, all attached databases are
1906** checkpointed.
1907*/
1908int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1909 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1910}
1911
drhb033d8b2010-05-03 13:37:30 +00001912#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001913/*
1914** Run a checkpoint on database iDb. This is a no-op if database iDb is
1915** not currently open in WAL mode.
1916**
dan6fcff072010-05-03 14:05:43 +00001917** If a transaction is open on the database being checkpointed, this
1918** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1919** an error occurs while running the checkpoint, an SQLite error code is
1920** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001921**
1922** The mutex on database handle db should be held by the caller. The mutex
1923** associated with the specific b-tree being checkpointed is taken by
1924** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001925**
1926** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1927** checkpointed. If an error is encountered it is returned immediately -
1928** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001929**
dancdc1f042010-11-18 12:11:05 +00001930** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001931*/
dancdc1f042010-11-18 12:11:05 +00001932int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001933 int rc = SQLITE_OK; /* Return code */
1934 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001935 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001936
1937 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001938 assert( !pnLog || *pnLog==-1 );
1939 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001940
dan6fcff072010-05-03 14:05:43 +00001941 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1942 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001943 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001944 pnLog = 0;
1945 pnCkpt = 0;
1946 if( rc==SQLITE_BUSY ){
1947 bBusy = 1;
1948 rc = SQLITE_OK;
1949 }
dan6fcff072010-05-03 14:05:43 +00001950 }
dan586b9c82010-05-03 08:04:49 +00001951 }
1952
danf2b8dd52010-11-18 19:28:01 +00001953 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001954}
drhb033d8b2010-05-03 13:37:30 +00001955#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001956
1957/*
danielk1977d8293352009-04-30 09:10:37 +00001958** This function returns true if main-memory should be used instead of
1959** a temporary file for transient pager files and statement journals.
1960** The value returned depends on the value of db->temp_store (runtime
1961** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1962** following table describes the relationship between these two values
1963** and this functions return value.
1964**
1965** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1966** ----------------- -------------- ------------------------------
1967** 0 any file (return 0)
1968** 1 1 file (return 0)
1969** 1 2 memory (return 1)
1970** 1 0 file (return 0)
1971** 2 1 file (return 0)
1972** 2 2 memory (return 1)
1973** 2 0 memory (return 1)
1974** 3 any memory (return 1)
1975*/
drh1c514142009-04-30 12:25:10 +00001976int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001977#if SQLITE_TEMP_STORE==1
1978 return ( db->temp_store==2 );
1979#endif
1980#if SQLITE_TEMP_STORE==2
1981 return ( db->temp_store!=1 );
1982#endif
1983#if SQLITE_TEMP_STORE==3
1984 return 1;
shanecf697392009-06-01 16:53:09 +00001985#endif
1986#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001987 return 0;
shane60a4b532009-05-06 18:57:09 +00001988#endif
danielk1977d8293352009-04-30 09:10:37 +00001989}
1990
1991/*
danielk19774ad17132004-05-21 01:47:26 +00001992** Return UTF-8 encoded English language explanation of the most recent
1993** error.
1994*/
danielk19776622cce2004-05-20 11:00:52 +00001995const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001996 const char *z;
drhf49661a2008-12-10 16:45:50 +00001997 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001998 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001999 }
drhd55d57e2008-07-07 17:53:07 +00002000 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002001 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002002 }
drh27641702007-08-22 02:56:42 +00002003 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002004 if( db->mallocFailed ){
2005 z = sqlite3ErrStr(SQLITE_NOMEM);
2006 }else{
drha3cc0072013-12-13 16:23:55 +00002007 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002008 z = (char*)sqlite3_value_text(db->pErr);
2009 assert( !db->mallocFailed );
2010 if( z==0 ){
2011 z = sqlite3ErrStr(db->errCode);
2012 }
danielk19776622cce2004-05-20 11:00:52 +00002013 }
drhe30f4422007-08-21 16:15:55 +00002014 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002015 return z;
danielk19776622cce2004-05-20 11:00:52 +00002016}
2017
drh6c626082004-11-14 21:56:29 +00002018#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002019/*
2020** Return UTF-16 encoded English language explanation of the most recent
2021** error.
2022*/
danielk19776622cce2004-05-20 11:00:52 +00002023const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002024 static const u16 outOfMem[] = {
2025 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002026 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002027 static const u16 misuse[] = {
2028 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2029 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2030 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2031 'o', 'u', 't', ' ',
2032 'o', 'f', ' ',
2033 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002034 };
danielk19774ad17132004-05-21 01:47:26 +00002035
drhc60d0442004-09-30 13:43:13 +00002036 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002037 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002038 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002039 }
drhd55d57e2008-07-07 17:53:07 +00002040 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002041 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002042 }
drhe30f4422007-08-21 16:15:55 +00002043 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002044 if( db->mallocFailed ){
2045 z = (void *)outOfMem;
2046 }else{
drhc60d0442004-09-30 13:43:13 +00002047 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002048 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002049 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002050 z = sqlite3_value_text16(db->pErr);
2051 }
2052 /* A malloc() may have failed within the call to sqlite3_value_text16()
2053 ** above. If this is the case, then the db->mallocFailed flag needs to
2054 ** be cleared before returning. Do this directly, instead of via
2055 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2056 */
2057 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00002058 }
drhe30f4422007-08-21 16:15:55 +00002059 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002060 return z;
danielk19776622cce2004-05-20 11:00:52 +00002061}
drh6c626082004-11-14 21:56:29 +00002062#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002063
drhc60d0442004-09-30 13:43:13 +00002064/*
danielk19777ddad962005-12-12 06:53:03 +00002065** Return the most recent error code generated by an SQLite routine. If NULL is
2066** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002067*/
danielk19776622cce2004-05-20 11:00:52 +00002068int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002069 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002070 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002071 }
drh01495b92008-01-23 12:52:40 +00002072 if( !db || db->mallocFailed ){
2073 return SQLITE_NOMEM;
2074 }
drh4ac285a2006-09-15 07:28:50 +00002075 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002076}
drh99dfe5e2008-10-30 15:03:15 +00002077int sqlite3_extended_errcode(sqlite3 *db){
2078 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002079 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002080 }
2081 if( !db || db->mallocFailed ){
2082 return SQLITE_NOMEM;
2083 }
2084 return db->errCode;
2085}
danielk19776622cce2004-05-20 11:00:52 +00002086
drh0e819f92006-02-01 13:50:41 +00002087/*
mistachkin5dac8432012-09-11 02:00:25 +00002088** Return a string that describes the kind of error specified in the
2089** argument. For now, this simply calls the internal sqlite3ErrStr()
2090** function.
2091*/
2092const char *sqlite3_errstr(int rc){
2093 return sqlite3ErrStr(rc);
2094}
2095
2096/*
drh41e13e12013-11-07 14:09:39 +00002097** Invalidate all cached KeyInfo objects for database connection "db"
2098*/
2099static void invalidateCachedKeyInfo(sqlite3 *db){
2100 Db *pDb; /* A single database */
2101 int iDb; /* The database index number */
2102 HashElem *k; /* For looping over tables in pDb */
2103 Table *pTab; /* A table in the database */
2104 Index *pIdx; /* Each index */
2105
2106 for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
2107 if( pDb->pBt==0 ) continue;
2108 sqlite3BtreeEnter(pDb->pBt);
2109 for(k=sqliteHashFirst(&pDb->pSchema->tblHash); k; k=sqliteHashNext(k)){
2110 pTab = (Table*)sqliteHashData(k);
2111 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
2112 if( pIdx->pKeyInfo && pIdx->pKeyInfo->db==db ){
2113 sqlite3KeyInfoUnref(pIdx->pKeyInfo);
2114 pIdx->pKeyInfo = 0;
2115 }
2116 }
2117 }
2118 sqlite3BtreeLeave(pDb->pBt);
2119 }
2120}
2121
2122/*
drh0e819f92006-02-01 13:50:41 +00002123** Create a new collating function for database "db". The name is zName
2124** and the encoding is enc.
2125*/
danielk19779a30cf62006-01-18 04:26:07 +00002126static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002127 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002128 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002129 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002130 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002131 int(*xCompare)(void*,int,const void*,int,const void*),
2132 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002133){
2134 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002135 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002136
drhe30f4422007-08-21 16:15:55 +00002137 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002138
2139 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2140 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2141 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2142 */
drh51c7d862009-04-27 18:46:06 +00002143 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002144 testcase( enc2==SQLITE_UTF16 );
2145 testcase( enc2==SQLITE_UTF16_ALIGNED );
2146 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002147 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002148 }
drh51c7d862009-04-27 18:46:06 +00002149 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002150 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002151 }
2152
2153 /* Check if this call is removing or replacing an existing collation
2154 ** sequence. If so, and there are active VMs, return busy. If there
2155 ** are no active VMs, invalidate any pre-compiled statements.
2156 */
drhc4a64fa2009-05-11 20:53:28 +00002157 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002158 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002159 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002160 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002161 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002162 return SQLITE_BUSY;
2163 }
2164 sqlite3ExpirePreparedStatements(db);
drh41e13e12013-11-07 14:09:39 +00002165 invalidateCachedKeyInfo(db);
danielk1977a9808b32007-05-07 09:32:45 +00002166
2167 /* If collation sequence pColl was created directly by a call to
2168 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2169 ** then any copies made by synthCollSeq() need to be invalidated.
2170 ** Also, collation destructor - CollSeq.xDel() - function may need
2171 ** to be called.
2172 */
2173 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002174 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002175 int j;
2176 for(j=0; j<3; j++){
2177 CollSeq *p = &aColl[j];
2178 if( p->enc==pColl->enc ){
2179 if( p->xDel ){
2180 p->xDel(p->pUser);
2181 }
2182 p->xCmp = 0;
2183 }
2184 }
2185 }
danielk19779a30cf62006-01-18 04:26:07 +00002186 }
2187
drhc4a64fa2009-05-11 20:53:28 +00002188 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002189 if( pColl==0 ) return SQLITE_NOMEM;
2190 pColl->xCmp = xCompare;
2191 pColl->pUser = pCtx;
2192 pColl->xDel = xDel;
2193 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002194 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002195 return SQLITE_OK;
2196}
2197
2198
danielk19776622cce2004-05-20 11:00:52 +00002199/*
drhbb4957f2008-03-20 14:03:29 +00002200** This array defines hard upper bounds on limit values. The
2201** initializer must be kept in sync with the SQLITE_LIMIT_*
2202** #defines in sqlite3.h.
2203*/
drhb1a6c3c2008-03-20 16:30:17 +00002204static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002205 SQLITE_MAX_LENGTH,
2206 SQLITE_MAX_SQL_LENGTH,
2207 SQLITE_MAX_COLUMN,
2208 SQLITE_MAX_EXPR_DEPTH,
2209 SQLITE_MAX_COMPOUND_SELECT,
2210 SQLITE_MAX_VDBE_OP,
2211 SQLITE_MAX_FUNCTION_ARG,
2212 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002213 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002214 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002215 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002216 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002217};
2218
2219/*
2220** Make sure the hard limits are set to reasonable values
2221*/
2222#if SQLITE_MAX_LENGTH<100
2223# error SQLITE_MAX_LENGTH must be at least 100
2224#endif
2225#if SQLITE_MAX_SQL_LENGTH<100
2226# error SQLITE_MAX_SQL_LENGTH must be at least 100
2227#endif
2228#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2229# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2230#endif
drhbb4957f2008-03-20 14:03:29 +00002231#if SQLITE_MAX_COMPOUND_SELECT<2
2232# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2233#endif
2234#if SQLITE_MAX_VDBE_OP<40
2235# error SQLITE_MAX_VDBE_OP must be at least 40
2236#endif
drhe82f5d02008-10-07 19:53:14 +00002237#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2238# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002239#endif
drhd08b2792014-07-22 15:33:31 +00002240#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2241# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002242#endif
drhbb4957f2008-03-20 14:03:29 +00002243#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2244# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2245#endif
drh70a8ca32008-08-21 18:49:27 +00002246#if SQLITE_MAX_COLUMN>32767
2247# error SQLITE_MAX_COLUMN must not exceed 32767
2248#endif
drh417168a2009-09-07 18:14:02 +00002249#if SQLITE_MAX_TRIGGER_DEPTH<1
2250# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2251#endif
drh111544c2014-08-29 16:20:47 +00002252#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2253# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2254#endif
drhbb4957f2008-03-20 14:03:29 +00002255
2256
2257/*
2258** Change the value of a limit. Report the old value.
2259** If an invalid limit index is supplied, report -1.
2260** Make no changes but still report the old value if the
2261** new limit is negative.
2262**
2263** A new lower limit does not shrink existing constructs.
2264** It merely prevents new constructs that exceed the limit
2265** from forming.
2266*/
2267int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2268 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002269
drh9ca95732014-10-24 00:35:58 +00002270#ifdef SQLITE_ENABLE_API_ARMOR
2271 if( !sqlite3SafetyCheckOk(db) ){
2272 (void)SQLITE_MISUSE_BKPT;
2273 return -1;
2274 }
2275#endif
drh4e93f5b2010-09-07 14:59:15 +00002276
2277 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2278 ** there is a hard upper bound set at compile-time by a C preprocessor
2279 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2280 ** "_MAX_".)
2281 */
2282 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2283 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2284 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2285 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2286 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2287 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2288 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2289 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2290 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2291 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2292 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2293 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002294 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2295 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002296
2297
drh521cc842008-04-15 02:36:33 +00002298 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002299 return -1;
2300 }
2301 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002302 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002303 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002304 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002305 }
2306 db->aLimit[limitId] = newLimit;
2307 }
drh4e93f5b2010-09-07 14:59:15 +00002308 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002309}
2310
2311/*
dan286ab7c2011-05-06 18:34:54 +00002312** This function is used to parse both URIs and non-URI filenames passed by the
2313** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2314** URIs specified as part of ATTACH statements.
2315**
2316** The first argument to this function is the name of the VFS to use (or
2317** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2318** query parameter. The second argument contains the URI (or non-URI filename)
2319** itself. When this function is called the *pFlags variable should contain
2320** the default flags to open the database handle with. The value stored in
2321** *pFlags may be updated before returning if the URI filename contains
2322** "cache=xxx" or "mode=xxx" query parameters.
2323**
2324** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2325** the VFS that should be used to open the database file. *pzFile is set to
2326** point to a buffer containing the name of the file to open. It is the
2327** responsibility of the caller to eventually call sqlite3_free() to release
2328** this buffer.
2329**
2330** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2331** may be set to point to a buffer containing an English language error
2332** message. It is the responsibility of the caller to eventually release
2333** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002334*/
2335int sqlite3ParseUri(
2336 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2337 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002338 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002339 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2340 char **pzFile, /* OUT: Filename component of URI */
2341 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2342){
dan78e9dd22011-05-03 10:22:32 +00002343 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002344 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002345 const char *zVfs = zDefaultVfs;
2346 char *zFile;
drhde941c32011-05-09 19:20:17 +00002347 char c;
dancd74b612011-04-22 19:37:32 +00002348 int nUri = sqlite3Strlen30(zUri);
2349
2350 assert( *pzErrMsg==0 );
2351
2352 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
drh00729cb2014-10-04 11:59:33 +00002353 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002354 ){
dan5de15372011-04-23 10:12:30 +00002355 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002356 int eState; /* Parser state when parsing URI */
2357 int iIn; /* Input character index */
2358 int iOut = 0; /* Output character index */
2359 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002360
dan286ab7c2011-05-06 18:34:54 +00002361 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2362 ** method that there may be extra parameters following the file-name. */
2363 flags |= SQLITE_OPEN_URI;
2364
2365 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002366 zFile = sqlite3_malloc(nByte);
2367 if( !zFile ) return SQLITE_NOMEM;
2368
drh869c0402013-08-07 23:15:52 +00002369 iIn = 5;
2370#ifndef SQLITE_ALLOW_URI_AUTHORITY
dancd74b612011-04-22 19:37:32 +00002371 /* Discard the scheme and authority segments of the URI. */
2372 if( zUri[5]=='/' && zUri[6]=='/' ){
2373 iIn = 7;
2374 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002375 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2376 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2377 iIn-7, &zUri[7]);
2378 rc = SQLITE_ERROR;
2379 goto parse_uri_out;
2380 }
dancd74b612011-04-22 19:37:32 +00002381 }
drh869c0402013-08-07 23:15:52 +00002382#endif
dancd74b612011-04-22 19:37:32 +00002383
2384 /* Copy the filename and any query parameters into the zFile buffer.
2385 ** Decode %HH escape codes along the way.
2386 **
2387 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2388 ** on the parsing context. As follows:
2389 **
2390 ** 0: Parsing file-name.
2391 ** 1: Parsing name section of a name=value query parameter.
2392 ** 2: Parsing value section of a name=value query parameter.
2393 */
2394 eState = 0;
drhde941c32011-05-09 19:20:17 +00002395 while( (c = zUri[iIn])!=0 && c!='#' ){
2396 iIn++;
dancd74b612011-04-22 19:37:32 +00002397 if( c=='%'
2398 && sqlite3Isxdigit(zUri[iIn])
2399 && sqlite3Isxdigit(zUri[iIn+1])
2400 ){
dan6d49e252011-05-03 15:09:05 +00002401 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2402 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002403
dan6d49e252011-05-03 15:09:05 +00002404 assert( octet>=0 && octet<256 );
2405 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002406 /* This branch is taken when "%00" appears within the URI. In this
2407 ** case we ignore all text in the remainder of the path, name or
2408 ** value currently being parsed. So ignore the current character
2409 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002410 while( (c = zUri[iIn])!=0 && c!='#'
2411 && (eState!=0 || c!='?')
2412 && (eState!=1 || (c!='=' && c!='&'))
2413 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002414 ){
2415 iIn++;
2416 }
2417 continue;
dancd74b612011-04-22 19:37:32 +00002418 }
dan6d49e252011-05-03 15:09:05 +00002419 c = octet;
dan5de15372011-04-23 10:12:30 +00002420 }else if( eState==1 && (c=='&' || c=='=') ){
2421 if( zFile[iOut-1]==0 ){
2422 /* An empty option name. Ignore this option altogether. */
2423 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2424 continue;
2425 }
2426 if( c=='&' ){
2427 zFile[iOut++] = '\0';
2428 }else{
2429 eState = 2;
2430 }
dancd74b612011-04-22 19:37:32 +00002431 c = 0;
dan5de15372011-04-23 10:12:30 +00002432 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2433 c = 0;
dancd74b612011-04-22 19:37:32 +00002434 eState = 1;
dancd74b612011-04-22 19:37:32 +00002435 }
2436 zFile[iOut++] = c;
2437 }
2438 if( eState==1 ) zFile[iOut++] = '\0';
2439 zFile[iOut++] = '\0';
2440 zFile[iOut++] = '\0';
2441
2442 /* Check if there were any options specified that should be interpreted
2443 ** here. Options that are interpreted here include "vfs" and those that
2444 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002445 ** method. */
dan5de15372011-04-23 10:12:30 +00002446 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2447 while( zOpt[0] ){
2448 int nOpt = sqlite3Strlen30(zOpt);
2449 char *zVal = &zOpt[nOpt+1];
2450 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002451
dan286ab7c2011-05-06 18:34:54 +00002452 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002453 zVfs = zVal;
2454 }else{
2455 struct OpenMode {
2456 const char *z;
2457 int mode;
2458 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002459 char *zModeType = 0;
2460 int mask = 0;
2461 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002462
dan286ab7c2011-05-06 18:34:54 +00002463 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002464 static struct OpenMode aCacheMode[] = {
2465 { "shared", SQLITE_OPEN_SHAREDCACHE },
2466 { "private", SQLITE_OPEN_PRIVATECACHE },
2467 { 0, 0 }
2468 };
2469
2470 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2471 aMode = aCacheMode;
2472 limit = mask;
2473 zModeType = "cache";
2474 }
dan286ab7c2011-05-06 18:34:54 +00002475 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002476 static struct OpenMode aOpenMode[] = {
2477 { "ro", SQLITE_OPEN_READONLY },
2478 { "rw", SQLITE_OPEN_READWRITE },
2479 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002480 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002481 { 0, 0 }
2482 };
2483
drh9c67b2a2012-05-28 13:58:00 +00002484 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2485 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002486 aMode = aOpenMode;
2487 limit = mask & flags;
2488 zModeType = "access";
2489 }
2490
2491 if( aMode ){
2492 int i;
2493 int mode = 0;
2494 for(i=0; aMode[i].z; i++){
2495 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002496 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002497 mode = aMode[i].mode;
2498 break;
dancd74b612011-04-22 19:37:32 +00002499 }
2500 }
dan78e9dd22011-05-03 10:22:32 +00002501 if( mode==0 ){
2502 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2503 rc = SQLITE_ERROR;
2504 goto parse_uri_out;
2505 }
drh9c67b2a2012-05-28 13:58:00 +00002506 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002507 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2508 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002509 rc = SQLITE_PERM;
2510 goto parse_uri_out;
2511 }
2512 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002513 }
dancd74b612011-04-22 19:37:32 +00002514 }
dan5de15372011-04-23 10:12:30 +00002515
2516 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002517 }
2518
2519 }else{
2520 zFile = sqlite3_malloc(nUri+2);
2521 if( !zFile ) return SQLITE_NOMEM;
2522 memcpy(zFile, zUri, nUri);
2523 zFile[nUri] = '\0';
2524 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002525 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002526 }
2527
2528 *ppVfs = sqlite3_vfs_find(zVfs);
2529 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002530 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002531 rc = SQLITE_ERROR;
2532 }
2533 parse_uri_out:
2534 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002535 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002536 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002537 }
2538 *pFlags = flags;
2539 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002540 return rc;
dancd74b612011-04-22 19:37:32 +00002541}
2542
2543
2544/*
danielk19774ad17132004-05-21 01:47:26 +00002545** This routine does the work of opening a database on behalf of
2546** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002547** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002548*/
2549static int openDatabase(
2550 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002551 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002552 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002553 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002554){
dancd74b612011-04-22 19:37:32 +00002555 sqlite3 *db; /* Store allocated handle here */
2556 int rc; /* Return code */
2557 int isThreadsafe; /* True for threadsafe connections */
2558 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2559 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002560
drh9ca95732014-10-24 00:35:58 +00002561#ifdef SQLITE_ENABLE_API_ARMOR
2562 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2563#endif
drhe0d0f8e2009-04-28 04:47:31 +00002564 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002565#ifndef SQLITE_OMIT_AUTOINIT
2566 rc = sqlite3_initialize();
2567 if( rc ) return rc;
2568#endif
2569
dan78e9dd22011-05-03 10:22:32 +00002570 /* Only allow sensible combinations of bits in the flags argument.
2571 ** Throw an error if any non-sense combination is used. If we
2572 ** do not block illegal combinations here, it could trigger
2573 ** assert() statements in deeper layers. Sensible combinations
2574 ** are:
2575 **
2576 ** 1: SQLITE_OPEN_READONLY
2577 ** 2: SQLITE_OPEN_READWRITE
2578 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2579 */
2580 assert( SQLITE_OPEN_READONLY == 0x01 );
2581 assert( SQLITE_OPEN_READWRITE == 0x02 );
2582 assert( SQLITE_OPEN_CREATE == 0x04 );
2583 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2584 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2585 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002586 if( ((1<<(flags&7)) & 0x46)==0 ){
2587 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2588 }
dan78e9dd22011-05-03 10:22:32 +00002589
drh039963a2008-09-03 00:43:15 +00002590 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002591 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002592 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2593 isThreadsafe = 0;
2594 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2595 isThreadsafe = 1;
2596 }else{
2597 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002598 }
drhf1f12682009-09-09 14:17:52 +00002599 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002600 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002601 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2602 flags |= SQLITE_OPEN_SHAREDCACHE;
2603 }
danielk19779a6284c2008-07-10 17:52:49 +00002604
drhb25a9f42009-05-12 13:35:11 +00002605 /* Remove harmful bits from the flags parameter
2606 **
2607 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2608 ** dealt with in the previous code block. Besides these, the only
2609 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002610 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2611 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002612 ** off all other flags.
2613 */
drha4267dc2008-02-19 15:20:44 +00002614 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002615 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002616 SQLITE_OPEN_MAIN_DB |
2617 SQLITE_OPEN_TEMP_DB |
2618 SQLITE_OPEN_TRANSIENT_DB |
2619 SQLITE_OPEN_MAIN_JOURNAL |
2620 SQLITE_OPEN_TEMP_JOURNAL |
2621 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002622 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002623 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002624 SQLITE_OPEN_FULLMUTEX |
2625 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002626 );
2627
danielk19774ad17132004-05-21 01:47:26 +00002628 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002629 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002630 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002631 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002632 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2633 if( db->mutex==0 ){
2634 sqlite3_free(db);
2635 db = 0;
2636 goto opendb_out;
2637 }
drh605264d2007-08-21 15:13:19 +00002638 }
drh27641702007-08-22 02:56:42 +00002639 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002640 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002641 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002642 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002643 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002644
drhbb4957f2008-03-20 14:03:29 +00002645 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2646 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002647 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002648 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002649 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002650 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002651 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002652 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002653 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002654#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002655 | SQLITE_AutoIndex
2656#endif
drh76fe8032006-07-11 14:17:51 +00002657#if SQLITE_DEFAULT_FILE_FORMAT<4
2658 | SQLITE_LegacyFileFmt
2659#endif
drh56424db2007-03-27 22:24:11 +00002660#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2661 | SQLITE_LoadExtension
2662#endif
dan5bde73c2009-09-01 17:11:07 +00002663#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002664 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002665#endif
drha4bfd7f2010-12-09 19:15:17 +00002666#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2667 | SQLITE_ForeignKeys
2668#endif
drh76fe8032006-07-11 14:17:51 +00002669 ;
drhe61922a2009-05-02 13:29:37 +00002670 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002671#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002672 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002673#endif
danielk1977da184232006-01-05 11:34:32 +00002674
danielk19770202b292004-06-09 09:55:16 +00002675 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2676 ** and UTF-16, so add a version for each to avoid any unnecessary
2677 ** conversions. The only error that can occur here is a malloc() failure.
2678 */
drh4dd65e02011-11-29 14:46:56 +00002679 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2680 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2681 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2682 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002683 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002684 goto opendb_out;
2685 }
drhc4a64fa2009-05-11 20:53:28 +00002686 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002687 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002688
2689 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002690 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002691
dancd74b612011-04-22 19:37:32 +00002692 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002693 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002694 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2695 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002696 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
drh13f40da2014-08-22 18:00:11 +00002697 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002698 sqlite3_free(zErrMsg);
2699 goto opendb_out;
2700 }
2701
danielk19774ad17132004-05-21 01:47:26 +00002702 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002703 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002704 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002705 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002706 if( rc==SQLITE_IOERR_NOMEM ){
2707 rc = SQLITE_NOMEM;
2708 }
drh13f40da2014-08-22 18:00:11 +00002709 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002710 goto opendb_out;
2711 }
drh17435752007-08-16 04:30:38 +00002712 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2713 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002714
danielk197753c0f742005-03-29 03:10:59 +00002715 /* The default safety_level for the main database is 'full'; for the temp
2716 ** database it is 'NONE'. This matches the pager layer defaults.
2717 */
2718 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002719 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002720 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002721 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002722
danielk1977832a58a2007-06-22 15:21:15 +00002723 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002724 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002725 goto opendb_out;
2726 }
2727
danielk19778e227872004-06-07 07:52:17 +00002728 /* Register all built-in functions, but do not attempt to read the
2729 ** database schema yet. This is delayed until the first time the database
2730 ** is accessed.
2731 */
drh13f40da2014-08-22 18:00:11 +00002732 sqlite3Error(db, SQLITE_OK);
danielk1977832a58a2007-06-22 15:21:15 +00002733 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002734
drh1409be62006-08-23 20:07:20 +00002735 /* Load automatic extensions - extensions that have been registered
2736 ** using the sqlite3_automatic_extension() API.
2737 */
drh7aaa8782009-05-20 02:40:45 +00002738 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002739 if( rc==SQLITE_OK ){
2740 sqlite3AutoLoadExtensions(db);
2741 rc = sqlite3_errcode(db);
2742 if( rc!=SQLITE_OK ){
2743 goto opendb_out;
2744 }
danielk1977832a58a2007-06-22 15:21:15 +00002745 }
drh1409be62006-08-23 20:07:20 +00002746
drhaa29c132006-09-02 13:58:06 +00002747#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002748 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002749 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002750 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002751 }
2752#endif
2753
shessa26cf572006-10-19 20:27:58 +00002754#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002755 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002756 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002757 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002758 }
2759#endif
2760
shess69c4ae22007-08-20 17:37:47 +00002761#ifdef SQLITE_ENABLE_FTS3
2762 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002763 rc = sqlite3Fts3Init(db);
2764 }
2765#endif
2766
danielk197783852ac2007-05-06 16:04:11 +00002767#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002768 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002769 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002770 }
2771#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002772
2773#ifdef SQLITE_ENABLE_RTREE
2774 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002775 rc = sqlite3RtreeInit(db);
2776 }
2777#endif
2778
drh8fd5bd32007-04-02 16:40:37 +00002779 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2780 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2781 ** mode. Doing nothing at all also makes NORMAL the default.
2782 */
2783#ifdef SQLITE_DEFAULT_LOCKING_MODE
2784 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2785 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2786 SQLITE_DEFAULT_LOCKING_MODE);
2787#endif
2788
drh13f40da2014-08-22 18:00:11 +00002789 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00002790
drh633e6d52008-07-28 19:34:53 +00002791 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002792 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2793 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002794
dan5a299f92010-05-03 11:05:08 +00002795 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002796
danielk19774ad17132004-05-21 01:47:26 +00002797opendb_out:
dancd74b612011-04-22 19:37:32 +00002798 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002799 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002800 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002801 sqlite3_mutex_leave(db->mutex);
2802 }
danielk197759633ae2008-08-27 19:01:57 +00002803 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002804 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002805 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002806 sqlite3_close(db);
2807 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002808 }else if( rc!=SQLITE_OK ){
2809 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002810 }
danielk19774ad17132004-05-21 01:47:26 +00002811 *ppDb = db;
danac455932012-11-26 19:50:41 +00002812#ifdef SQLITE_ENABLE_SQLLOG
2813 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002814 /* Opening a db handle. Fourth parameter is passed 0. */
2815 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2816 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002817 }
2818#endif
danielk197754f01982006-01-18 15:25:17 +00002819 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002820}
2821
2822/*
2823** Open a new database handle.
2824*/
danielk197780290862004-05-22 09:21:21 +00002825int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002826 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002827 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002828){
drh605264d2007-08-21 15:13:19 +00002829 return openDatabase(zFilename, ppDb,
2830 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2831}
2832int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002833 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002834 sqlite3 **ppDb, /* OUT: SQLite db handle */
2835 int flags, /* Flags */
2836 const char *zVfs /* Name of VFS module to use */
2837){
drh522c26f2011-05-07 14:40:29 +00002838 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002839}
2840
drh6c626082004-11-14 21:56:29 +00002841#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002842/*
2843** Open a new database handle.
2844*/
2845int sqlite3_open16(
2846 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002847 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002848){
danielk1977bfd6cce2004-06-18 04:24:54 +00002849 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002850 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002851 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002852
drh9ca95732014-10-24 00:35:58 +00002853#ifdef SQLITE_ENABLE_API_ARMOR
2854 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2855#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00002856 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002857#ifndef SQLITE_OMIT_AUTOINIT
2858 rc = sqlite3_initialize();
2859 if( rc ) return rc;
2860#endif
drh9ca95732014-10-24 00:35:58 +00002861 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00002862 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002863 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2864 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002865 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002866 rc = openDatabase(zFilename8, ppDb,
2867 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002868 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002869 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002870 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002871 }
drh40257ff2008-06-13 18:24:27 +00002872 }else{
2873 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002874 }
danielk19777ddad962005-12-12 06:53:03 +00002875 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002876
danielk197754f01982006-01-18 15:25:17 +00002877 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002878}
drh6c626082004-11-14 21:56:29 +00002879#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002880
danielk1977106bb232004-05-21 10:08:53 +00002881/*
danielk1977d8123362004-06-12 09:25:12 +00002882** Register a new collation sequence with the database handle db.
2883*/
danielk19770202b292004-06-09 09:55:16 +00002884int sqlite3_create_collation(
2885 sqlite3* db,
2886 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002887 int enc,
danielk19770202b292004-06-09 09:55:16 +00002888 void* pCtx,
2889 int(*xCompare)(void*,int,const void*,int,const void*)
2890){
drh4f81bbb2014-10-23 01:01:26 +00002891 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002892}
2893
2894/*
2895** Register a new collation sequence with the database handle db.
2896*/
danielk1977a393c032007-05-07 14:58:53 +00002897int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002898 sqlite3* db,
2899 const char *zName,
2900 int enc,
2901 void* pCtx,
2902 int(*xCompare)(void*,int,const void*,int,const void*),
2903 void(*xDel)(void*)
2904){
2905 int rc;
drh9ca95732014-10-24 00:35:58 +00002906
2907#ifdef SQLITE_ENABLE_API_ARMOR
2908 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2909#endif
drhe30f4422007-08-21 16:15:55 +00002910 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002911 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002912 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002913 rc = sqlite3ApiExit(db, rc);
2914 sqlite3_mutex_leave(db->mutex);
2915 return rc;
danielk19770202b292004-06-09 09:55:16 +00002916}
2917
drh6c626082004-11-14 21:56:29 +00002918#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002919/*
2920** Register a new collation sequence with the database handle db.
2921*/
danielk19770202b292004-06-09 09:55:16 +00002922int sqlite3_create_collation16(
2923 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002924 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002925 int enc,
danielk19770202b292004-06-09 09:55:16 +00002926 void* pCtx,
2927 int(*xCompare)(void*,int,const void*,int,const void*)
2928){
danielk19779a30cf62006-01-18 04:26:07 +00002929 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002930 char *zName8;
drh9ca95732014-10-24 00:35:58 +00002931
2932#ifdef SQLITE_ENABLE_API_ARMOR
2933 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2934#endif
drhe30f4422007-08-21 16:15:55 +00002935 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002936 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002937 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002938 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002939 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002940 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002941 }
drhe30f4422007-08-21 16:15:55 +00002942 rc = sqlite3ApiExit(db, rc);
2943 sqlite3_mutex_leave(db->mutex);
2944 return rc;
danielk19770202b292004-06-09 09:55:16 +00002945}
drh6c626082004-11-14 21:56:29 +00002946#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002947
danielk1977d8123362004-06-12 09:25:12 +00002948/*
2949** Register a collation sequence factory callback with the database handle
2950** db. Replace any previously installed collation sequence factory.
2951*/
danielk19777cedc8d2004-06-10 10:50:08 +00002952int sqlite3_collation_needed(
2953 sqlite3 *db,
2954 void *pCollNeededArg,
2955 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2956){
drh9ca95732014-10-24 00:35:58 +00002957#ifdef SQLITE_ENABLE_API_ARMOR
2958 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2959#endif
drhe30f4422007-08-21 16:15:55 +00002960 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002961 db->xCollNeeded = xCollNeeded;
2962 db->xCollNeeded16 = 0;
2963 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002964 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002965 return SQLITE_OK;
2966}
danielk1977d8123362004-06-12 09:25:12 +00002967
drh6c626082004-11-14 21:56:29 +00002968#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002969/*
2970** Register a collation sequence factory callback with the database handle
2971** db. Replace any previously installed collation sequence factory.
2972*/
danielk19777cedc8d2004-06-10 10:50:08 +00002973int sqlite3_collation_needed16(
2974 sqlite3 *db,
2975 void *pCollNeededArg,
2976 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2977){
drh9ca95732014-10-24 00:35:58 +00002978#ifdef SQLITE_ENABLE_API_ARMOR
2979 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2980#endif
drhe30f4422007-08-21 16:15:55 +00002981 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002982 db->xCollNeeded = 0;
2983 db->xCollNeeded16 = xCollNeeded16;
2984 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002985 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002986 return SQLITE_OK;
2987}
drh6c626082004-11-14 21:56:29 +00002988#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002989
shaneeec556d2008-10-12 00:27:53 +00002990#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002991/*
danielk19777ddad962005-12-12 06:53:03 +00002992** This function is now an anachronism. It used to be used to recover from a
2993** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002994*/
drh7d97efb2007-10-12 19:35:48 +00002995int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002996 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002997}
2998#endif
drh3e1d8e62005-05-26 16:23:34 +00002999
3000/*
3001** Test to see whether or not the database connection is in autocommit
3002** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3003** by default. Autocommit is disabled by a BEGIN statement and reenabled
3004** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003005*/
3006int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003007#ifdef SQLITE_ENABLE_API_ARMOR
3008 if( !sqlite3SafetyCheckOk(db) ){
3009 (void)SQLITE_MISUSE_BKPT;
3010 return 0;
3011 }
3012#endif
drh3e1d8e62005-05-26 16:23:34 +00003013 return db->autoCommit;
3014}
drh49285702005-09-17 15:20:26 +00003015
drh49285702005-09-17 15:20:26 +00003016/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003017** The following routines are substitutes for constants SQLITE_CORRUPT,
drh9978c972010-02-23 17:36:32 +00003018** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003019** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003020**
3021** 1. Serve as a convenient place to set a breakpoint in a debugger
3022** to detect when version error conditions occurs.
3023**
3024** 2. Invoke sqlite3_log() to provide the source code location where
3025** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003026*/
drh9978c972010-02-23 17:36:32 +00003027int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003028 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00003029 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00003030 "database corruption at line %d of [%.10s]",
3031 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00003032 return SQLITE_CORRUPT;
3033}
drh9978c972010-02-23 17:36:32 +00003034int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003035 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003036 sqlite3_log(SQLITE_MISUSE,
3037 "misuse at line %d of [%.10s]",
3038 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003039 return SQLITE_MISUSE;
3040}
3041int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003042 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003043 sqlite3_log(SQLITE_CANTOPEN,
3044 "cannot open file at line %d of [%.10s]",
3045 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003046 return SQLITE_CANTOPEN;
3047}
3048
drh7c1817e2006-01-10 13:58:48 +00003049
shaneeec556d2008-10-12 00:27:53 +00003050#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003051/*
3052** This is a convenience routine that makes sure that all thread-specific
3053** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003054**
3055** SQLite no longer uses thread-specific data so this routine is now a
3056** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003057*/
3058void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003059}
shaneeec556d2008-10-12 00:27:53 +00003060#endif
danielk1977deb802c2006-02-09 13:43:28 +00003061
3062/*
3063** Return meta information about a specific column of a database table.
3064** See comment in sqlite3.h (sqlite.h.in) for details.
3065*/
3066#ifdef SQLITE_ENABLE_COLUMN_METADATA
3067int sqlite3_table_column_metadata(
3068 sqlite3 *db, /* Connection handle */
3069 const char *zDbName, /* Database name or NULL */
3070 const char *zTableName, /* Table name */
3071 const char *zColumnName, /* Column name */
3072 char const **pzDataType, /* OUTPUT: Declared data type */
3073 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3074 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3075 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003076 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003077){
3078 int rc;
3079 char *zErrMsg = 0;
3080 Table *pTab = 0;
3081 Column *pCol = 0;
3082 int iCol;
3083
3084 char const *zDataType = 0;
3085 char const *zCollSeq = 0;
3086 int notnull = 0;
3087 int primarykey = 0;
3088 int autoinc = 0;
3089
3090 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003091 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003092 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003093 rc = sqlite3Init(db, &zErrMsg);
3094 if( SQLITE_OK!=rc ){
3095 goto error_out;
3096 }
3097
3098 /* Locate the table in question */
3099 pTab = sqlite3FindTable(db, zTableName, zDbName);
3100 if( !pTab || pTab->pSelect ){
3101 pTab = 0;
3102 goto error_out;
3103 }
3104
3105 /* Find the column for which info is requested */
3106 if( sqlite3IsRowid(zColumnName) ){
3107 iCol = pTab->iPKey;
3108 if( iCol>=0 ){
3109 pCol = &pTab->aCol[iCol];
3110 }
3111 }else{
3112 for(iCol=0; iCol<pTab->nCol; iCol++){
3113 pCol = &pTab->aCol[iCol];
3114 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3115 break;
3116 }
3117 }
3118 if( iCol==pTab->nCol ){
3119 pTab = 0;
3120 goto error_out;
3121 }
3122 }
3123
3124 /* The following block stores the meta information that will be returned
3125 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3126 ** and autoinc. At this point there are two possibilities:
3127 **
3128 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3129 ** and there is no explicitly declared IPK column.
3130 **
3131 ** 2. The table is not a view and the column name identified an
3132 ** explicitly declared column. Copy meta information from *pCol.
3133 */
3134 if( pCol ){
3135 zDataType = pCol->zType;
3136 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003137 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003138 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003139 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003140 }else{
3141 zDataType = "INTEGER";
3142 primarykey = 1;
3143 }
3144 if( !zCollSeq ){
3145 zCollSeq = "BINARY";
3146 }
3147
3148error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003149 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003150
3151 /* Whether the function call succeeded or failed, set the output parameters
3152 ** to whatever their local counterparts contain. If an error did occur,
3153 ** this has the effect of zeroing all output parameters.
3154 */
3155 if( pzDataType ) *pzDataType = zDataType;
3156 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3157 if( pNotNull ) *pNotNull = notnull;
3158 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3159 if( pAutoinc ) *pAutoinc = autoinc;
3160
3161 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003162 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003163 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003164 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003165 rc = SQLITE_ERROR;
3166 }
drh13f40da2014-08-22 18:00:11 +00003167 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003168 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003169 rc = sqlite3ApiExit(db, rc);
3170 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003171 return rc;
3172}
drhe30f4422007-08-21 16:15:55 +00003173#endif
drhf9cb7f52006-06-27 20:06:44 +00003174
3175/*
3176** Sleep for a little while. Return the amount of time slept.
3177*/
3178int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003179 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003180 int rc;
drhd677b3d2007-08-20 22:48:41 +00003181 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003182 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003183
3184 /* This function works in milliseconds, but the underlying OsSleep()
3185 ** API uses microseconds. Hence the 1000's.
3186 */
drhe30f4422007-08-21 16:15:55 +00003187 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003188 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003189}
drh4ac285a2006-09-15 07:28:50 +00003190
3191/*
3192** Enable or disable the extended result codes.
3193*/
3194int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003195#ifdef SQLITE_ENABLE_API_ARMOR
3196 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3197#endif
drhe30f4422007-08-21 16:15:55 +00003198 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003199 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003200 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003201 return SQLITE_OK;
3202}
drhcc6bb3e2007-08-31 16:11:35 +00003203
3204/*
3205** Invoke the xFileControl method on a particular database.
3206*/
3207int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3208 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003209 Btree *pBtree;
3210
drh9ca95732014-10-24 00:35:58 +00003211#ifdef SQLITE_ENABLE_API_ARMOR
3212 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3213#endif
drhcc6bb3e2007-08-31 16:11:35 +00003214 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003215 pBtree = sqlite3DbNameToBtree(db, zDbName);
3216 if( pBtree ){
3217 Pager *pPager;
3218 sqlite3_file *fd;
3219 sqlite3BtreeEnter(pBtree);
3220 pPager = sqlite3BtreePager(pBtree);
3221 assert( pPager!=0 );
3222 fd = sqlite3PagerFile(pPager);
3223 assert( fd!=0 );
3224 if( op==SQLITE_FCNTL_FILE_POINTER ){
3225 *(sqlite3_file**)pArg = fd;
3226 rc = SQLITE_OK;
3227 }else if( fd->pMethods ){
3228 rc = sqlite3OsFileControl(fd, op, pArg);
3229 }else{
3230 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003231 }
drh421377e2012-03-15 21:28:54 +00003232 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003233 }
3234 sqlite3_mutex_leave(db->mutex);
3235 return rc;
3236}
drhed13d982008-01-31 14:43:24 +00003237
3238/*
3239** Interface to the testing logic.
3240*/
3241int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003242 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003243#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003244 va_list ap;
drhed13d982008-01-31 14:43:24 +00003245 va_start(ap, op);
3246 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003247
3248 /*
drh984bfaa2008-03-19 16:08:53 +00003249 ** Save the current state of the PRNG.
3250 */
drh2fa18682008-03-19 14:15:34 +00003251 case SQLITE_TESTCTRL_PRNG_SAVE: {
3252 sqlite3PrngSaveState();
3253 break;
3254 }
drh984bfaa2008-03-19 16:08:53 +00003255
3256 /*
3257 ** Restore the state of the PRNG to the last state saved using
3258 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3259 ** this verb acts like PRNG_RESET.
3260 */
drh2fa18682008-03-19 14:15:34 +00003261 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3262 sqlite3PrngRestoreState();
3263 break;
3264 }
drh984bfaa2008-03-19 16:08:53 +00003265
3266 /*
3267 ** Reset the PRNG back to its uninitialized state. The next call
3268 ** to sqlite3_randomness() will reseed the PRNG using a single call
3269 ** to the xRandomness method of the default VFS.
3270 */
drh2fa18682008-03-19 14:15:34 +00003271 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003272 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003273 break;
3274 }
drh3088d592008-03-21 16:45:47 +00003275
3276 /*
3277 ** sqlite3_test_control(BITVEC_TEST, size, program)
3278 **
3279 ** Run a test against a Bitvec object of size. The program argument
3280 ** is an array of integers that defines the test. Return -1 on a
3281 ** memory allocation error, 0 on success, or non-zero for an error.
3282 ** See the sqlite3BitvecBuiltinTest() for additional information.
3283 */
3284 case SQLITE_TESTCTRL_BITVEC_TEST: {
3285 int sz = va_arg(ap, int);
3286 int *aProg = va_arg(ap, int*);
3287 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3288 break;
3289 }
danielk19772d1d86f2008-06-20 14:59:51 +00003290
3291 /*
drhc007f612014-05-16 14:17:01 +00003292 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3293 **
3294 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3295 ** if xCallback is not NULL.
3296 **
3297 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3298 ** is called immediately after installing the new callback and the return
3299 ** value from sqlite3FaultSim(0) becomes the return from
3300 ** sqlite3_test_control().
3301 */
3302 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003303 /* MSVC is picky about pulling func ptrs from va lists.
3304 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003305 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003306 */
3307 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003308 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003309 rc = sqlite3FaultSim(0);
3310 break;
3311 }
3312
3313 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003314 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3315 **
3316 ** Register hooks to call to indicate which malloc() failures
3317 ** are benign.
3318 */
3319 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003320 typedef void (*void_function)(void);
3321 void_function xBenignBegin;
3322 void_function xBenignEnd;
3323 xBenignBegin = va_arg(ap, void_function);
3324 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003325 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3326 break;
3327 }
drhc7a3bb92009-02-05 16:31:45 +00003328
3329 /*
drhf3af63f2009-05-09 18:59:42 +00003330 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003331 **
3332 ** Set the PENDING byte to the value in the argument, if X>0.
3333 ** Make no changes if X==0. Return the value of the pending byte
3334 ** as it existing before this routine was called.
3335 **
3336 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3337 ** an incompatible database file format. Changing the PENDING byte
3338 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003339 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003340 */
3341 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003342 rc = PENDING_BYTE;
3343#ifndef SQLITE_OMIT_WSD
3344 {
3345 unsigned int newVal = va_arg(ap, unsigned int);
3346 if( newVal ) sqlite3PendingByte = newVal;
3347 }
3348#endif
drhc7a3bb92009-02-05 16:31:45 +00003349 break;
3350 }
drhf3af63f2009-05-09 18:59:42 +00003351
3352 /*
3353 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3354 **
3355 ** This action provides a run-time test to see whether or not
3356 ** assert() was enabled at compile-time. If X is true and assert()
3357 ** is enabled, then the return value is true. If X is true and
3358 ** assert() is disabled, then the return value is zero. If X is
3359 ** false and assert() is enabled, then the assertion fires and the
3360 ** process aborts. If X is false and assert() is disabled, then the
3361 ** return value is zero.
3362 */
3363 case SQLITE_TESTCTRL_ASSERT: {
3364 volatile int x = 0;
3365 assert( (x = va_arg(ap,int))!=0 );
3366 rc = x;
3367 break;
3368 }
3369
3370
3371 /*
3372 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3373 **
3374 ** This action provides a run-time test to see how the ALWAYS and
3375 ** NEVER macros were defined at compile-time.
3376 **
3377 ** The return value is ALWAYS(X).
3378 **
3379 ** The recommended test is X==2. If the return value is 2, that means
3380 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3381 ** default setting. If the return value is 1, then ALWAYS() is either
3382 ** hard-coded to true or else it asserts if its argument is false.
3383 ** The first behavior (hard-coded to true) is the case if
3384 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3385 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3386 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3387 **
3388 ** The run-time test procedure might look something like this:
3389 **
3390 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3391 ** // ALWAYS() and NEVER() are no-op pass-through macros
3392 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3393 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3394 ** }else{
3395 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3396 ** }
3397 */
3398 case SQLITE_TESTCTRL_ALWAYS: {
3399 int x = va_arg(ap,int);
3400 rc = ALWAYS(x);
3401 break;
3402 }
drhc046e3e2009-07-15 11:26:44 +00003403
drh2cf4acb2014-04-18 00:06:02 +00003404 /*
3405 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3406 **
3407 ** The integer returned reveals the byte-order of the computer on which
3408 ** SQLite is running:
3409 **
3410 ** 1 big-endian, determined at run-time
3411 ** 10 little-endian, determined at run-time
3412 ** 432101 big-endian, determined at compile-time
3413 ** 123410 little-endian, determined at compile-time
3414 */
3415 case SQLITE_TESTCTRL_BYTEORDER: {
3416 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3417 break;
3418 }
3419
drhc046e3e2009-07-15 11:26:44 +00003420 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3421 **
3422 ** Set the nReserve size to N for the main database on the database
3423 ** connection db.
3424 */
3425 case SQLITE_TESTCTRL_RESERVE: {
3426 sqlite3 *db = va_arg(ap, sqlite3*);
3427 int x = va_arg(ap,int);
3428 sqlite3_mutex_enter(db->mutex);
3429 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3430 sqlite3_mutex_leave(db->mutex);
3431 break;
3432 }
3433
drh07096f62009-12-22 23:52:32 +00003434 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3435 **
3436 ** Enable or disable various optimizations for testing purposes. The
3437 ** argument N is a bitmask of optimizations to be disabled. For normal
3438 ** operation N should be 0. The idea is that a test program (like the
3439 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3440 ** with various optimizations disabled to verify that the same answer
3441 ** is obtained in every case.
3442 */
3443 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3444 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003445 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003446 break;
3447 }
3448
drh0e857732010-01-02 03:21:35 +00003449#ifdef SQLITE_N_KEYWORD
3450 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3451 **
3452 ** If zWord is a keyword recognized by the parser, then return the
3453 ** number of keywords. Or if zWord is not a keyword, return 0.
3454 **
3455 ** This test feature is only available in the amalgamation since
3456 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3457 ** is built using separate source files.
3458 */
3459 case SQLITE_TESTCTRL_ISKEYWORD: {
3460 const char *zWord = va_arg(ap, const char*);
3461 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003462 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003463 break;
3464 }
3465#endif
3466
drhbadc9802010-08-27 17:16:44 +00003467 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3468 **
3469 ** Pass pFree into sqlite3ScratchFree().
3470 ** If sz>0 then allocate a scratch buffer into pNew.
3471 */
3472 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3473 void *pFree, **ppNew;
3474 int sz;
3475 sz = va_arg(ap, int);
3476 ppNew = va_arg(ap, void**);
3477 pFree = va_arg(ap, void*);
3478 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3479 sqlite3ScratchFree(pFree);
3480 break;
3481 }
3482
danc17d6962011-06-21 12:47:30 +00003483 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3484 **
3485 ** If parameter onoff is non-zero, configure the wrappers so that all
3486 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3487 ** undo this setting.
3488 */
3489 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3490 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3491 break;
3492 }
3493
drh09fe6142013-11-29 15:06:27 +00003494 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3495 **
3496 ** Set or clear a flag that indicates that the database file is always well-
3497 ** formed and never corrupt. This flag is clear by default, indicating that
3498 ** database files might have arbitrary corruption. Setting the flag during
3499 ** testing causes certain assert() statements in the code to be activated
3500 ** that demonstrat invariants on well-formed database files.
3501 */
3502 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003503 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003504 break;
3505 }
3506
drh688852a2014-02-17 22:40:43 +00003507
3508 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3509 **
3510 ** Set the VDBE coverage callback function to xCallback with context
3511 ** pointer ptr.
3512 */
3513 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3514#ifdef SQLITE_VDBE_COVERAGE
3515 typedef void (*branch_callback)(void*,int,u8,u8);
3516 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3517 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3518#endif
3519 break;
3520 }
3521
dan8930c2a2014-04-03 16:25:29 +00003522 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3523 case SQLITE_TESTCTRL_SORTER_MMAP: {
3524 sqlite3 *db = va_arg(ap, sqlite3*);
3525 db->nMaxSorterMmap = va_arg(ap, int);
3526 break;
3527 }
3528
drh43cfc232014-07-29 14:09:21 +00003529 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3530 **
3531 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3532 ** not.
3533 */
3534 case SQLITE_TESTCTRL_ISINIT: {
3535 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3536 break;
3537 }
drhed13d982008-01-31 14:43:24 +00003538 }
3539 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003540#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003541 return rc;
drhed13d982008-01-31 14:43:24 +00003542}
drhcc487d12011-05-17 18:53:08 +00003543
3544/*
3545** This is a utility routine, useful to VFS implementations, that checks
3546** to see if a database file was a URI that contained a specific query
3547** parameter, and if so obtains the value of the query parameter.
3548**
3549** The zFilename argument is the filename pointer passed into the xOpen()
3550** method of a VFS implementation. The zParam argument is the name of the
3551** query parameter we seek. This routine returns the value of the zParam
3552** parameter if it exists. If the parameter does not exist, this routine
3553** returns a NULL pointer.
3554*/
3555const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003556 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003557 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003558 while( zFilename[0] ){
3559 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003560 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003561 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003562 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003563 }
3564 return 0;
3565}
drh283829c2011-11-17 00:56:20 +00003566
3567/*
drh92913722011-12-23 00:07:33 +00003568** Return a boolean value for a query parameter.
3569*/
3570int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3571 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003572 bDflt = bDflt!=0;
3573 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003574}
3575
3576/*
3577** Return a 64-bit integer value for a query parameter.
3578*/
3579sqlite3_int64 sqlite3_uri_int64(
3580 const char *zFilename, /* Filename as passed to xOpen */
3581 const char *zParam, /* URI parameter sought */
3582 sqlite3_int64 bDflt /* return if parameter is missing */
3583){
3584 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3585 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003586 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003587 bDflt = v;
3588 }
3589 return bDflt;
3590}
3591
3592/*
drh421377e2012-03-15 21:28:54 +00003593** Return the Btree pointer identified by zDbName. Return NULL if not found.
3594*/
3595Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3596 int i;
3597 for(i=0; i<db->nDb; i++){
3598 if( db->aDb[i].pBt
3599 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3600 ){
3601 return db->aDb[i].pBt;
3602 }
3603 }
3604 return 0;
3605}
3606
3607/*
drh283829c2011-11-17 00:56:20 +00003608** Return the filename of the database associated with a database
3609** connection.
3610*/
3611const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh9ca95732014-10-24 00:35:58 +00003612#ifdef SQLITE_ENABLE_API_ARMOR
3613 if( !sqlite3SafetyCheckOk(db) ){
3614 (void)SQLITE_MISUSE_BKPT;
3615 return 0;
3616 }
3617#endif
drh421377e2012-03-15 21:28:54 +00003618 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3619 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3620}
3621
3622/*
3623** Return 1 if database is read-only or 0 if read/write. Return -1 if
3624** no such database exists.
3625*/
3626int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
drh9ca95732014-10-24 00:35:58 +00003627#ifdef SQLITE_ENABLE_API_ARMOR
3628 if( !sqlite3SafetyCheckOk(db) ){
3629 (void)SQLITE_MISUSE_BKPT;
3630 return -1;
3631 }
3632#endif
drh421377e2012-03-15 21:28:54 +00003633 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003634 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003635}