blob: aa260436295de1d297f2206b8924a79a4a2c09e7 [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 */
120
121#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000122 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000123 if( rc!=SQLITE_OK ){
124 return rc;
125 }
126#endif
danielk197771bc31c2008-06-26 08:29:34 +0000127
drh93ed56d2008-08-12 15:21:11 +0000128 /* If SQLite is already completely initialized, then this call
129 ** to sqlite3_initialize() should be a no-op. But the initialization
130 ** must be complete. So isInit must not be set until the very end
131 ** of this routine.
132 */
danielk1977075c23a2008-09-01 18:34:20 +0000133 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000134
danac455932012-11-26 19:50:41 +0000135#ifdef SQLITE_ENABLE_SQLLOG
136 {
dan71ba10d2012-11-27 10:56:39 +0000137 extern void sqlite3_init_sqllog(void);
danac455932012-11-26 19:50:41 +0000138 sqlite3_init_sqllog();
139 }
140#endif
141
drh93ed56d2008-08-12 15:21:11 +0000142 /* Make sure the mutex subsystem is initialized. If unable to
143 ** initialize the mutex subsystem, return early with the error.
144 ** If the system is so sick that we are unable to allocate a mutex,
145 ** there is not much SQLite is going to be able to do.
146 **
147 ** The mutex subsystem must take care of serializing its own
148 ** initialization.
149 */
danielk1977d0251742008-06-18 18:57:42 +0000150 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000151 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000152
drh93ed56d2008-08-12 15:21:11 +0000153 /* Initialize the malloc() system and the recursive pInitMutex mutex.
154 ** This operation is protected by the STATIC_MASTER mutex. Note that
155 ** MutexAlloc() is called for a static mutex prior to initializing the
156 ** malloc subsystem - this implies that the allocation of a static
157 ** mutex must not require support from the malloc subsystem.
158 */
drh30ddce62011-10-15 00:16:30 +0000159 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000160 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000161 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000162 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000163 rc = sqlite3MallocInit();
164 }
drh40257ff2008-06-13 18:24:27 +0000165 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000166 sqlite3GlobalConfig.isMallocInit = 1;
167 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000168 sqlite3GlobalConfig.pInitMutex =
169 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000170 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000171 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000172 }
173 }
danielk197777eb5bb2008-09-22 17:22:19 +0000174 }
175 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000176 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000177 }
178 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000179
dane1ab2192009-08-17 15:16:19 +0000180 /* If rc is not SQLITE_OK at this point, then either the malloc
181 ** subsystem could not be initialized or the system failed to allocate
182 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000183 if( rc!=SQLITE_OK ){
184 return rc;
185 }
186
187 /* Do the rest of the initialization under the recursive mutex so
188 ** that we will be able to handle recursive calls into
189 ** sqlite3_initialize(). The recursive calls normally come through
190 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
191 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000192 **
193 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
194 ** to the xInit method, so the xInit method need not be threadsafe.
195 **
196 ** The following mutex is what serializes access to the appdef pcache xInit
197 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
198 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000199 */
danielk1977075c23a2008-09-01 18:34:20 +0000200 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000201 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000202 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000203 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000204 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000205 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000206 if( sqlite3GlobalConfig.isPCacheInit==0 ){
207 rc = sqlite3PcacheInitialize();
208 }
danielk19778c0a7912008-08-20 14:49:23 +0000209 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000210 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000211 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000212 }
213 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000214 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
215 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000216 sqlite3GlobalConfig.isInit = 1;
danielk19778c0a7912008-08-20 14:49:23 +0000217 }
danielk1977502b4e02008-09-02 14:07:24 +0000218 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000219 }
danielk1977075c23a2008-09-01 18:34:20 +0000220 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000221
drh93ed56d2008-08-12 15:21:11 +0000222 /* Go back under the static mutex and clean up the recursive
223 ** mutex to prevent a resource leak.
224 */
225 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000226 sqlite3GlobalConfig.nRefInitMutex--;
227 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
228 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
229 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
230 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000231 }
232 sqlite3_mutex_leave(pMaster);
233
234 /* The following is just a sanity check to make sure SQLite has
235 ** been compiled correctly. It is important to run this code, but
236 ** we don't want to run it too often and soak up CPU cycles for no
237 ** reason. So we run it once during initialization.
238 */
shanedfb7b372008-07-22 05:13:30 +0000239#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000240#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000241 /* This section of code's only "output" is via assert() statements. */
242 if ( rc==SQLITE_OK ){
243 u64 x = (((u64)1)<<63)-1;
244 double y;
245 assert(sizeof(x)==8);
246 assert(sizeof(x)==sizeof(y));
247 memcpy(&y, &x, 8);
248 assert( sqlite3IsNaN(y) );
249 }
250#endif
shanefbd60f82009-02-04 03:59:25 +0000251#endif
shanedfb7b372008-07-22 05:13:30 +0000252
drhe4cf0b32011-08-25 00:14:41 +0000253 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
254 ** compile-time option.
255 */
256#ifdef SQLITE_EXTRA_INIT
257 if( rc==SQLITE_OK && sqlite3GlobalConfig.isInit ){
drhc7f94622011-12-13 18:22:38 +0000258 int SQLITE_EXTRA_INIT(const char*);
259 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000260 }
261#endif
262
drh40257ff2008-06-13 18:24:27 +0000263 return rc;
264}
265
266/*
267** Undo the effects of sqlite3_initialize(). Must not be called while
268** there are outstanding database connections or memory allocations or
269** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000270** routine is not threadsafe. But it is safe to invoke this routine
271** on when SQLite is already shut down. If SQLite is already shut down
272** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000273*/
274int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000275 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000276#ifdef SQLITE_EXTRA_SHUTDOWN
277 void SQLITE_EXTRA_SHUTDOWN(void);
278 SQLITE_EXTRA_SHUTDOWN();
279#endif
drha7640922009-04-21 12:02:56 +0000280 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000281 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000282 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000283 }
dane1ab2192009-08-17 15:16:19 +0000284 if( sqlite3GlobalConfig.isPCacheInit ){
285 sqlite3PcacheShutdown();
286 sqlite3GlobalConfig.isPCacheInit = 0;
287 }
288 if( sqlite3GlobalConfig.isMallocInit ){
289 sqlite3MallocEnd();
290 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000291
292#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
293 /* The heap subsystem has now been shutdown and these values are supposed
294 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
295 ** which would rely on that heap subsystem; therefore, make sure these
296 ** values cannot refer to heap memory that was just invalidated when the
297 ** heap subsystem was shutdown. This is only done if the current call to
298 ** this function resulted in the heap subsystem actually being shutdown.
299 */
300 sqlite3_data_directory = 0;
301 sqlite3_temp_directory = 0;
302#endif
dane1ab2192009-08-17 15:16:19 +0000303 }
304 if( sqlite3GlobalConfig.isMutexInit ){
305 sqlite3MutexEnd();
306 sqlite3GlobalConfig.isMutexInit = 0;
307 }
308
drh40257ff2008-06-13 18:24:27 +0000309 return SQLITE_OK;
310}
311
312/*
313** This API allows applications to modify the global configuration of
314** the SQLite library at run-time.
315**
316** This routine should only be called when there are no outstanding
317** database connections or memory allocations. This routine is not
318** threadsafe. Failure to heed these warnings can lead to unpredictable
319** behavior.
320*/
321int sqlite3_config(int op, ...){
322 va_list ap;
323 int rc = SQLITE_OK;
324
325 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
326 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000327 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000328
329 va_start(ap, op);
330 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000331
332 /* Mutex configuration options are only available in a threadsafe
333 ** compile.
334 */
drhd68eee02009-12-11 03:44:18 +0000335#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000336 case SQLITE_CONFIG_SINGLETHREAD: {
337 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000338 sqlite3GlobalConfig.bCoreMutex = 0;
339 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000340 break;
341 }
342 case SQLITE_CONFIG_MULTITHREAD: {
343 /* Disable mutexing of database connections */
344 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000345 sqlite3GlobalConfig.bCoreMutex = 1;
346 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000347 break;
348 }
349 case SQLITE_CONFIG_SERIALIZED: {
350 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000351 sqlite3GlobalConfig.bCoreMutex = 1;
352 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000353 break;
354 }
drh18472fa2008-10-07 15:25:48 +0000355 case SQLITE_CONFIG_MUTEX: {
356 /* Specify an alternative mutex implementation */
357 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
358 break;
359 }
360 case SQLITE_CONFIG_GETMUTEX: {
361 /* Retrieve the current mutex implementation */
362 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
363 break;
364 }
365#endif
366
367
drh40257ff2008-06-13 18:24:27 +0000368 case SQLITE_CONFIG_MALLOC: {
369 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000370 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000371 break;
372 }
drh33589792008-06-18 13:27:46 +0000373 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000374 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000375 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
376 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000377 break;
378 }
drhfec00ea2008-06-14 16:56:21 +0000379 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000380 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000381 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000382 break;
383 }
drh33589792008-06-18 13:27:46 +0000384 case SQLITE_CONFIG_SCRATCH: {
385 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000386 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
387 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
388 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000389 break;
390 }
391 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000392 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000393 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
394 sqlite3GlobalConfig.szPage = va_arg(ap, int);
395 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000396 break;
397 }
danielk19775099be52008-06-27 13:27:03 +0000398
danielk1977bc2ca9e2008-11-13 14:28:28 +0000399 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000400 /* no-op */
401 break;
402 }
403 case SQLITE_CONFIG_GETPCACHE: {
404 /* now an error */
405 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000406 break;
407 }
408
dan22e21ff2011-11-08 20:08:44 +0000409 case SQLITE_CONFIG_PCACHE2: {
410 /* Specify an alternative page cache implementation */
411 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
412 break;
413 }
414 case SQLITE_CONFIG_GETPCACHE2: {
415 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000416 sqlite3PCacheSetDefault();
417 }
dan22e21ff2011-11-08 20:08:44 +0000418 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000419 break;
420 }
421
drh5d414832008-07-15 14:47:18 +0000422#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000423 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000424 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000425 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
426 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
427 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000428
shaneha6ec8922011-03-09 21:36:17 +0000429 if( sqlite3GlobalConfig.mnReq<1 ){
430 sqlite3GlobalConfig.mnReq = 1;
431 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
432 /* cap min request size at 2^12 */
433 sqlite3GlobalConfig.mnReq = (1<<12);
434 }
435
danielk1977075c23a2008-09-01 18:34:20 +0000436 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000437 /* If the heap pointer is NULL, then restore the malloc implementation
438 ** back to NULL pointers too. This will cause the malloc to go
439 ** back to its default implementation when sqlite3_initialize() is
440 ** run.
441 */
danielk1977075c23a2008-09-01 18:34:20 +0000442 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000443 }else{
444 /* The heap pointer is not NULL, then install one of the
445 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
446 ** ENABLE_MEMSYS5 is defined, return an error.
drh8a42cbd2008-07-10 18:13:42 +0000447 */
danielk19775099be52008-06-27 13:27:03 +0000448#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000449 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000450#endif
451#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000452 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000453#endif
drh8a42cbd2008-07-10 18:13:42 +0000454 }
danielk19775099be52008-06-27 13:27:03 +0000455 break;
456 }
drh5d414832008-07-15 14:47:18 +0000457#endif
danielk19775099be52008-06-27 13:27:03 +0000458
drh633e6d52008-07-28 19:34:53 +0000459 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000460 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
461 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000462 break;
463 }
drh3f280702010-02-18 18:45:09 +0000464
465 /* Record a pointer to the logger funcction and its first argument.
466 ** The default is NULL. Logging is disabled if the function pointer is
467 ** NULL.
468 */
469 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000470 /* MSVC is picky about pulling func ptrs from va lists.
471 ** http://support.microsoft.com/kb/47961
472 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
473 */
474 typedef void(*LOGFUNC_t)(void*,int,const char*);
475 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000476 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
477 break;
478 }
drh633e6d52008-07-28 19:34:53 +0000479
dancd74b612011-04-22 19:37:32 +0000480 case SQLITE_CONFIG_URI: {
481 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
482 break;
483 }
484
drhde9a7b82012-09-17 20:44:46 +0000485 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
486 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
487 break;
488 }
489
danac455932012-11-26 19:50:41 +0000490#ifdef SQLITE_ENABLE_SQLLOG
491 case SQLITE_CONFIG_SQLLOG: {
492 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
493 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
494 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
495 break;
496 }
497#endif
498
drh9b4c59f2013-04-15 17:03:42 +0000499 case SQLITE_CONFIG_MMAP_SIZE: {
500 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000501 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh9b4c59f2013-04-15 17:03:42 +0000502 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
503 mxMmap = SQLITE_MAX_MMAP_SIZE;
504 }
drha1f42c72013-04-01 22:38:06 +0000505 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000506 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
507 if( szMmap>mxMmap) szMmap = mxMmap;
508 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000509 break;
510 }
511
drh40257ff2008-06-13 18:24:27 +0000512 default: {
513 rc = SQLITE_ERROR;
514 break;
515 }
516 }
517 va_end(ap);
518 return rc;
519}
520
521/*
drh633e6d52008-07-28 19:34:53 +0000522** Set up the lookaside buffers for a database connection.
523** Return SQLITE_OK on success.
524** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000525**
526** The sz parameter is the number of bytes in each lookaside slot.
527** The cnt parameter is the number of slots. If pStart is NULL the
528** space for the lookaside memory is obtained from sqlite3_malloc().
529** If pStart is not NULL then it is sz*cnt bytes of memory to use for
530** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000531*/
drhe9d1c722008-08-04 20:13:26 +0000532static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000533 void *pStart;
534 if( db->lookaside.nOut ){
535 return SQLITE_BUSY;
536 }
shanef71f89e2009-01-30 06:11:54 +0000537 /* Free any existing lookaside buffer for this handle before
538 ** allocating a new one so we don't have to have space for
539 ** both at the same time.
540 */
541 if( db->lookaside.bMalloced ){
542 sqlite3_free(db->lookaside.pStart);
543 }
drh61a4bd52011-11-10 02:39:28 +0000544 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
545 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000546 */
drh61a4bd52011-11-10 02:39:28 +0000547 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000548 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000549 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000550 if( sz==0 || cnt==0 ){
551 sz = 0;
552 pStart = 0;
553 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000554 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000555 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000556 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000557 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000558 }else{
559 pStart = pBuf;
560 }
drh4cfb22f2008-08-01 18:47:01 +0000561 db->lookaside.pStart = pStart;
562 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000563 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000564 if( pStart ){
565 int i;
566 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000567 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000568 p = (LookasideSlot*)pStart;
569 for(i=cnt-1; i>=0; i--){
570 p->pNext = db->lookaside.pFree;
571 db->lookaside.pFree = p;
572 p = (LookasideSlot*)&((u8*)p)[sz];
573 }
574 db->lookaside.pEnd = p;
575 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000576 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000577 }else{
578 db->lookaside.pEnd = 0;
579 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000580 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000581 }
582 return SQLITE_OK;
583}
584
585/*
drh4413d0e2008-11-04 13:46:27 +0000586** Return the mutex associated with a database connection.
587*/
588sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
589 return db->mutex;
590}
591
592/*
drh09419b42011-11-16 19:29:17 +0000593** Free up as much memory as we can from the given database
594** connection.
595*/
596int sqlite3_db_release_memory(sqlite3 *db){
597 int i;
dand9bb3a92011-12-30 11:43:59 +0000598 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000599 sqlite3BtreeEnterAll(db);
600 for(i=0; i<db->nDb; i++){
601 Btree *pBt = db->aDb[i].pBt;
602 if( pBt ){
603 Pager *pPager = sqlite3BtreePager(pBt);
604 sqlite3PagerShrink(pPager);
605 }
606 }
607 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000608 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000609 return SQLITE_OK;
610}
611
612/*
drh633e6d52008-07-28 19:34:53 +0000613** Configuration settings for an individual database connection
614*/
615int sqlite3_db_config(sqlite3 *db, int op, ...){
616 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000617 int rc;
drh633e6d52008-07-28 19:34:53 +0000618 va_start(ap, op);
619 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000620 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000621 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000622 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
623 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000624 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000625 break;
626 }
drh6480aad2008-08-01 16:31:14 +0000627 default: {
drhe83cafd2011-03-21 17:15:58 +0000628 static const struct {
629 int op; /* The opcode */
630 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
631 } aFlagOp[] = {
632 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
633 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
634 };
drh58ad5802011-03-23 22:02:23 +0000635 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000636 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000637 for(i=0; i<ArraySize(aFlagOp); i++){
638 if( aFlagOp[i].op==op ){
639 int onoff = va_arg(ap, int);
640 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000641 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000642 if( onoff>0 ){
643 db->flags |= aFlagOp[i].mask;
644 }else if( onoff==0 ){
645 db->flags &= ~aFlagOp[i].mask;
646 }
647 if( oldFlags!=db->flags ){
648 sqlite3ExpirePreparedStatements(db);
649 }
650 if( pRes ){
651 *pRes = (db->flags & aFlagOp[i].mask)!=0;
652 }
653 rc = SQLITE_OK;
654 break;
655 }
656 }
drh6480aad2008-08-01 16:31:14 +0000657 break;
658 }
drh633e6d52008-07-28 19:34:53 +0000659 }
660 va_end(ap);
661 return rc;
662}
663
drha16313e2007-03-30 11:29:32 +0000664
665/*
drh9b5adfa2008-01-20 23:19:56 +0000666** Return true if the buffer z[0..n-1] contains all spaces.
667*/
668static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000669 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000670 return n==0;
671}
672
673/*
drhd3d39e92004-05-20 22:16:29 +0000674** This is the default collating function named "BINARY" which is always
675** available.
drh9b5adfa2008-01-20 23:19:56 +0000676**
677** If the padFlag argument is not NULL then space padding at the end
678** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000679*/
danielk19772c336542005-01-13 02:14:23 +0000680static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000681 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000682 int nKey1, const void *pKey1,
683 int nKey2, const void *pKey2
684){
685 int rc, n;
686 n = nKey1<nKey2 ? nKey1 : nKey2;
687 rc = memcmp(pKey1, pKey2, n);
688 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000689 if( padFlag
690 && allSpaces(((char*)pKey1)+n, nKey1-n)
691 && allSpaces(((char*)pKey2)+n, nKey2-n)
692 ){
693 /* Leave rc unchanged at 0 */
694 }else{
695 rc = nKey1 - nKey2;
696 }
drhd3d39e92004-05-20 22:16:29 +0000697 }
698 return rc;
699}
700
701/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000702** Another built-in collating sequence: NOCASE.
703**
drhf7b54962013-05-28 12:11:54 +0000704** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000705** comparison". SQLite's knowledge of upper and lower case equivalents
706** extends only to the 26 characters used in the English language.
707**
708** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000709*/
710static int nocaseCollatingFunc(
711 void *NotUsed,
712 int nKey1, const void *pKey1,
713 int nKey2, const void *pKey2
714){
715 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000716 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000717 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000718 if( 0==r ){
719 r = nKey1-nKey2;
720 }
721 return r;
722}
723
724/*
drhaf9ff332002-01-16 21:00:27 +0000725** Return the ROWID of the most recent insert
726*/
drh9bb575f2004-09-06 17:24:11 +0000727sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000728 return db->lastRowid;
729}
730
731/*
danielk197724b03fd2004-05-10 10:34:34 +0000732** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000733*/
drh9bb575f2004-09-06 17:24:11 +0000734int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000735 return db->nChange;
736}
737
rdcf146a772004-02-25 22:51:06 +0000738/*
danielk1977b28af712004-06-21 06:50:26 +0000739** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000740*/
danielk1977b28af712004-06-21 06:50:26 +0000741int sqlite3_total_changes(sqlite3 *db){
742 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000743}
744
drhc8d30ac2002-04-12 10:08:59 +0000745/*
danielk1977fd7f0452008-12-17 17:30:26 +0000746** Close all open savepoints. This function only manipulates fields of the
747** database handle object, it does not close any savepoints that may be open
748** at the b-tree/pager level.
749*/
750void sqlite3CloseSavepoints(sqlite3 *db){
751 while( db->pSavepoint ){
752 Savepoint *pTmp = db->pSavepoint;
753 db->pSavepoint = pTmp->pNext;
754 sqlite3DbFree(db, pTmp);
755 }
756 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000757 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000758 db->isTransactionSavepoint = 0;
759}
760
761/*
dand2199f02010-08-27 17:48:52 +0000762** Invoke the destructor function associated with FuncDef p, if any. Except,
763** if this is not the last copy of the function, do not invoke it. Multiple
764** copies of a single function are created when create_function() is called
765** with SQLITE_ANY as the encoding.
766*/
767static void functionDestroy(sqlite3 *db, FuncDef *p){
768 FuncDestructor *pDestructor = p->pDestructor;
769 if( pDestructor ){
770 pDestructor->nRef--;
771 if( pDestructor->nRef==0 ){
772 pDestructor->xDestroy(pDestructor->pUserData);
773 sqlite3DbFree(db, pDestructor);
774 }
775 }
776}
777
778/*
danbba02a92012-05-15 17:15:34 +0000779** Disconnect all sqlite3_vtab objects that belong to database connection
780** db. This is called when db is being closed.
781*/
782static void disconnectAllVtab(sqlite3 *db){
783#ifndef SQLITE_OMIT_VIRTUALTABLE
784 int i;
785 sqlite3BtreeEnterAll(db);
786 for(i=0; i<db->nDb; i++){
787 Schema *pSchema = db->aDb[i].pSchema;
788 if( db->aDb[i].pSchema ){
789 HashElem *p;
790 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
791 Table *pTab = (Table *)sqliteHashData(p);
792 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
793 }
794 }
795 }
796 sqlite3BtreeLeaveAll(db);
797#else
798 UNUSED_PARAMETER(db);
799#endif
800}
801
802/*
drh167cd6a2012-06-02 17:09:46 +0000803** Return TRUE if database connection db has unfinalized prepared
804** statements or unfinished sqlite3_backup objects.
805*/
806static int connectionIsBusy(sqlite3 *db){
807 int j;
808 assert( sqlite3_mutex_held(db->mutex) );
809 if( db->pVdbe ) return 1;
810 for(j=0; j<db->nDb; j++){
811 Btree *pBt = db->aDb[j].pBt;
812 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
813 }
814 return 0;
815}
816
817/*
drh50e5dad2001-09-15 00:57:28 +0000818** Close an existing SQLite database
819*/
drh167cd6a2012-06-02 17:09:46 +0000820static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000821 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000822 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000823 }
drh7e8b8482008-01-23 03:03:05 +0000824 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000825 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000826 }
drh605264d2007-08-21 15:13:19 +0000827 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000828
danbba02a92012-05-15 17:15:34 +0000829 /* Force xDisconnect calls on all virtual tables */
830 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000831
danbba02a92012-05-15 17:15:34 +0000832 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000833 ** will not have called the xDisconnect() method on any virtual
834 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
835 ** call will do so. We need to do this before the check for active
836 ** SQL statements below, as the v-table implementation may be storing
837 ** some prepared statements internally.
838 */
dan67430812013-05-15 10:21:50 +0000839 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000840
drh167cd6a2012-06-02 17:09:46 +0000841 /* Legacy behavior (sqlite3_close() behavior) is to return
842 ** SQLITE_BUSY if the connection can not be closed immediately.
843 */
844 if( !forceZombie && connectionIsBusy(db) ){
845 sqlite3Error(db, SQLITE_BUSY, "unable to close due to unfinalized "
846 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000847 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000848 return SQLITE_BUSY;
849 }
danielk1977e0048402004-06-15 16:51:01 +0000850
danac455932012-11-26 19:50:41 +0000851#ifdef SQLITE_ENABLE_SQLLOG
852 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +0000853 /* Closing the handle. Fourth parameter is passed the value 2. */
854 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +0000855 }
856#endif
857
drh167cd6a2012-06-02 17:09:46 +0000858 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +0000859 */
860 db->magic = SQLITE_MAGIC_ZOMBIE;
861 sqlite3LeaveMutexAndCloseZombie(db);
862 return SQLITE_OK;
863}
drh94e92032003-02-16 22:21:32 +0000864
drh167cd6a2012-06-02 17:09:46 +0000865/*
866** Two variations on the public interface for closing a database
867** connection. The sqlite3_close() version returns SQLITE_BUSY and
868** leaves the connection option if there are unfinalized prepared
869** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
870** version forces the connection to become a zombie if there are
871** unclosed resources, and arranges for deallocation when the last
872** prepare statement or sqlite3_backup closes.
873*/
874int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
875int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
876
drh4245c402012-06-02 14:32:21 +0000877
878/*
879** Close the mutex on database connection db.
880**
881** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +0000882** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
883** every sqlite3_stmt has now been finalized and every sqlite3_backup has
884** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +0000885*/
886void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
887 HashElem *i; /* Hash table iterator */
888 int j;
889
drh4245c402012-06-02 14:32:21 +0000890 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +0000891 ** or if the connection has not yet been closed by sqlite3_close_v2(),
892 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +0000893 */
drh167cd6a2012-06-02 17:09:46 +0000894 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +0000895 sqlite3_mutex_leave(db->mutex);
896 return;
danielk197704103022009-02-03 16:51:24 +0000897 }
898
drh4245c402012-06-02 14:32:21 +0000899 /* If we reach this point, it means that the database connection has
900 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +0000901 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +0000902 ** go ahead and free all resources.
903 */
904
dan617dc862013-05-16 11:57:28 +0000905 /* If a transaction is open, roll it back. This also ensures that if
906 ** any database schemas have been modified by an uncommitted transaction
907 ** they are reset. And that the required b-tree mutex is held to make
908 ** the pager rollback and schema reset an atomic operation. */
909 sqlite3RollbackAll(db, SQLITE_OK);
910
danielk1977fd7f0452008-12-17 17:30:26 +0000911 /* Free any outstanding Savepoint structures. */
912 sqlite3CloseSavepoints(db);
913
drh5efb3142012-05-16 01:24:34 +0000914 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000915 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000916 struct Db *pDb = &db->aDb[j];
917 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000918 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000919 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000920 if( j!=1 ){
921 pDb->pSchema = 0;
922 }
drh113088e2003-03-20 01:16:58 +0000923 }
drhf57b3392001-10-08 13:22:32 +0000924 }
drh5efb3142012-05-16 01:24:34 +0000925 /* Clear the TEMP schema separately and last */
926 if( db->aDb[1].pSchema ){
927 sqlite3SchemaClear(db->aDb[1].pSchema);
928 }
929 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000930
drh5efb3142012-05-16 01:24:34 +0000931 /* Free up the array of auxiliary databases */
932 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000933 assert( db->nDb<=2 );
934 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000935
936 /* Tell the code in notify.c that the connection no longer holds any
937 ** locks and does not require any further unlock-notify callbacks.
938 */
939 sqlite3ConnectionClosed(db);
940
drh70a8ca32008-08-21 18:49:27 +0000941 for(j=0; j<ArraySize(db->aFunc.a); j++){
942 FuncDef *pNext, *pHash, *p;
943 for(p=db->aFunc.a[j]; p; p=pHash){
944 pHash = p->pHash;
945 while( p ){
dand2199f02010-08-27 17:48:52 +0000946 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000947 pNext = p->pNext;
948 sqlite3DbFree(db, p);
949 p = pNext;
950 }
drh8e0a2f92002-02-23 23:45:45 +0000951 }
952 }
danielk1977d8123362004-06-12 09:25:12 +0000953 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000954 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000955 /* Invoke any destructors registered for collation sequence user data. */
956 for(j=0; j<3; j++){
957 if( pColl[j].xDel ){
958 pColl[j].xDel(pColl[j].pUser);
959 }
960 }
drh633e6d52008-07-28 19:34:53 +0000961 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000962 }
danielk1977d8123362004-06-12 09:25:12 +0000963 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000964#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000965 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
966 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000967 if( pMod->xDestroy ){
968 pMod->xDestroy(pMod->pAux);
969 }
drh633e6d52008-07-28 19:34:53 +0000970 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000971 }
drhb9bb7c12006-06-11 23:41:55 +0000972 sqlite3HashClear(&db->aModule);
973#endif
danielk1977466be562004-06-10 02:16:01 +0000974
danielk19776622cce2004-05-20 11:00:52 +0000975 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000976 if( db->pErr ){
977 sqlite3ValueFree(db->pErr);
978 }
drhf1952c52006-06-08 15:48:00 +0000979 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000980
981 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000982
983 /* The temp-database schema is allocated differently from the other schema
984 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
985 ** So it needs to be freed here. Todo: Why not roll the temp schema into
986 ** the same sqliteMalloc() as the one that allocates the database
987 ** structure?
988 */
drh633e6d52008-07-28 19:34:53 +0000989 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000990 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000991 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000992 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +0000993 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +0000994 if( db->lookaside.bMalloced ){
995 sqlite3_free(db->lookaside.pStart);
996 }
drh17435752007-08-16 04:30:38 +0000997 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +0000998}
999
1000/*
drh0f198a72012-02-13 16:43:16 +00001001** Rollback all database files. If tripCode is not SQLITE_OK, then
1002** any open cursors are invalidated ("tripped" - as in "tripping a circuit
1003** breaker") and made to return tripCode if there are any further
1004** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +00001005*/
drh0f198a72012-02-13 16:43:16 +00001006void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001007 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001008 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +00001009 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001010 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001011
1012 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1013 ** This is important in case the transaction being rolled back has
1014 ** modified the database schema. If the b-tree mutexes are not taken
1015 ** here, then another shared-cache connection might sneak in between
1016 ** the database rollback and schema reset, which can cause false
1017 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001018 sqlite3BtreeEnterAll(db);
dan617dc862013-05-16 11:57:28 +00001019
drh001bbcb2003-03-19 03:14:00 +00001020 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001021 Btree *p = db->aDb[i].pBt;
1022 if( p ){
1023 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001024 inTrans = 1;
1025 }
drh0f198a72012-02-13 16:43:16 +00001026 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +00001027 }
1028 }
danielk1977a298e902006-06-22 09:53:48 +00001029 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001030 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001031
drh5c5760a2013-02-19 18:34:45 +00001032 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001033 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001034 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001035 }
dancd7b91a2013-05-13 18:23:15 +00001036 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001037
dan1da40a32009-09-19 17:00:31 +00001038 /* Any deferred constraint violations have now been resolved. */
1039 db->nDeferredCons = 0;
1040
danielk197771fd80b2005-12-16 06:54:01 +00001041 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001042 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001043 db->xRollbackCallback(db->pRollbackArg);
1044 }
drh001bbcb2003-03-19 03:14:00 +00001045}
1046
1047/*
mistachkinf2c1c992013-04-28 01:44:43 +00001048** Return a static string containing the name corresponding to the error code
1049** specified in the argument.
1050*/
mistachkin10269dc2013-04-30 07:54:42 +00001051#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST) || \
1052 defined(SQLITE_DEBUG_OS_TRACE)
mistachkinf2c1c992013-04-28 01:44:43 +00001053const char *sqlite3ErrName(int rc){
1054 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001055 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001056 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1057 switch( rc ){
1058 case SQLITE_OK: zName = "SQLITE_OK"; break;
1059 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1060 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1061 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1062 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001063 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001064 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001065 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001066 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1067 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1068 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1069 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001070 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1071 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1072 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001073 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1074 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001075 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1076 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1077 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1078 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1079 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1080 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1081 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1082 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1083 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1084 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
1085 case SQLITE_IOERR_BLOCKED: zName = "SQLITE_IOERR_BLOCKED"; break;
1086 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1087 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1088 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1089 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1090 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1091 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1092 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1093 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1094 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1095 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1096 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1097 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1098 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1099 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001100 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001101 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001102 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1103 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1104 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001105 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1106 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1107 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001108 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1109 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1110 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1111 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1112 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1113 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1114 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1115 case SQLITE_CONSTRAINT_FOREIGNKEY:
1116 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1117 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1118 case SQLITE_CONSTRAINT_PRIMARYKEY:
1119 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1120 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1121 case SQLITE_CONSTRAINT_COMMITHOOK:
1122 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1123 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1124 case SQLITE_CONSTRAINT_FUNCTION:
1125 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
1126 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1127 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1128 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1129 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1130 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1131 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1132 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1133 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1134 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001135 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1136 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1137 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001138 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
1139 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001140 }
1141 }
mistachkin10269dc2013-04-30 07:54:42 +00001142 if( zName==0 ){
1143 static char zBuf[50];
1144 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1145 zName = zBuf;
1146 }
mistachkinf2c1c992013-04-28 01:44:43 +00001147 return zName;
1148}
mistachkin10269dc2013-04-30 07:54:42 +00001149#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001150
1151/*
drhc22bd472002-05-10 13:14:07 +00001152** Return a static string that describes the kind of error specified in the
1153** argument.
drh247be432002-05-10 05:44:55 +00001154*/
danielk1977f20b21c2004-05-31 23:56:42 +00001155const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001156 static const char* const aMsg[] = {
1157 /* SQLITE_OK */ "not an error",
1158 /* SQLITE_ERROR */ "SQL logic error or missing database",
1159 /* SQLITE_INTERNAL */ 0,
1160 /* SQLITE_PERM */ "access permission denied",
1161 /* SQLITE_ABORT */ "callback requested query abort",
1162 /* SQLITE_BUSY */ "database is locked",
1163 /* SQLITE_LOCKED */ "database table is locked",
1164 /* SQLITE_NOMEM */ "out of memory",
1165 /* SQLITE_READONLY */ "attempt to write a readonly database",
1166 /* SQLITE_INTERRUPT */ "interrupted",
1167 /* SQLITE_IOERR */ "disk I/O error",
1168 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001169 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001170 /* SQLITE_FULL */ "database or disk is full",
1171 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001172 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001173 /* SQLITE_EMPTY */ "table contains no data",
1174 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001175 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001176 /* SQLITE_CONSTRAINT */ "constraint failed",
1177 /* SQLITE_MISMATCH */ "datatype mismatch",
1178 /* SQLITE_MISUSE */ "library routine called out of sequence",
1179 /* SQLITE_NOLFS */ "large file support is disabled",
1180 /* SQLITE_AUTH */ "authorization denied",
1181 /* SQLITE_FORMAT */ "auxiliary database format error",
1182 /* SQLITE_RANGE */ "bind or column index out of range",
1183 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1184 };
drh21021a52012-02-13 17:01:51 +00001185 const char *zErr = "unknown error";
1186 switch( rc ){
1187 case SQLITE_ABORT_ROLLBACK: {
1188 zErr = "abort due to ROLLBACK";
1189 break;
1190 }
1191 default: {
1192 rc &= 0xff;
1193 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1194 zErr = aMsg[rc];
1195 }
1196 break;
1197 }
drh247be432002-05-10 05:44:55 +00001198 }
drh21021a52012-02-13 17:01:51 +00001199 return zErr;
drh247be432002-05-10 05:44:55 +00001200}
1201
1202/*
drh2dfbbca2000-07-28 14:32:48 +00001203** This routine implements a busy callback that sleeps and tries
1204** again until a timeout value is reached. The timeout value is
1205** an integer number of milliseconds passed in as the first
1206** argument.
1207*/
drhdaffd0e2001-04-11 14:28:42 +00001208static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001209 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001210 int count /* Number of times table has been busy */
1211){
danielk197729bafea2008-06-26 10:41:19 +00001212#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001213 static const u8 delays[] =
1214 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1215 static const u8 totals[] =
1216 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001217# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001218 sqlite3 *db = (sqlite3 *)ptr;
1219 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001220 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001221
drhee570fa2005-04-28 12:06:05 +00001222 assert( count>=0 );
1223 if( count < NDELAY ){
1224 delay = delays[count];
1225 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001226 }else{
1227 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001228 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001229 }
drhd1bec472004-01-15 13:29:31 +00001230 if( prior + delay > timeout ){
1231 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001232 if( delay<=0 ) return 0;
1233 }
danielk19772a6bdf62007-08-20 16:07:00 +00001234 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001235 return 1;
1236#else
drh482ea182007-08-20 11:12:40 +00001237 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001238 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001239 if( (count+1)*1000 > timeout ){
1240 return 0;
1241 }
drh482ea182007-08-20 11:12:40 +00001242 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001243 return 1;
1244#endif
1245}
1246
1247/*
drha4afb652005-07-09 02:16:02 +00001248** Invoke the given busy handler.
1249**
1250** This routine is called when an operation failed with a lock.
1251** If this routine returns non-zero, the lock is retried. If it
1252** returns 0, the operation aborts with an SQLITE_BUSY error.
1253*/
1254int sqlite3InvokeBusyHandler(BusyHandler *p){
1255 int rc;
drh34004ce2008-07-11 16:15:17 +00001256 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001257 rc = p->xFunc(p->pArg, p->nBusy);
1258 if( rc==0 ){
1259 p->nBusy = -1;
1260 }else{
1261 p->nBusy++;
1262 }
1263 return rc;
1264}
1265
1266/*
drh2dfbbca2000-07-28 14:32:48 +00001267** This routine sets the busy callback for an Sqlite database to the
1268** given callback function with the given argument.
1269*/
danielk1977f9d64d22004-06-19 08:18:07 +00001270int sqlite3_busy_handler(
1271 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001272 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001273 void *pArg
1274){
drhe30f4422007-08-21 16:15:55 +00001275 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001276 db->busyHandler.xFunc = xBusy;
1277 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001278 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001279 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001280 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001281 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001282}
1283
danielk1977348bb5d2003-10-18 09:37:26 +00001284#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1285/*
1286** This routine sets the progress callback for an Sqlite database to the
1287** given callback function with the given argument. The progress callback will
1288** be invoked every nOps opcodes.
1289*/
danielk197724b03fd2004-05-10 10:34:34 +00001290void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001291 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001292 int nOps,
1293 int (*xProgress)(void*),
1294 void *pArg
1295){
drhbd0b1b52008-07-07 19:52:09 +00001296 sqlite3_mutex_enter(db->mutex);
1297 if( nOps>0 ){
1298 db->xProgress = xProgress;
1299 db->nProgressOps = nOps;
1300 db->pProgressArg = pArg;
1301 }else{
1302 db->xProgress = 0;
1303 db->nProgressOps = 0;
1304 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001305 }
drhbd0b1b52008-07-07 19:52:09 +00001306 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001307}
1308#endif
1309
1310
drh2dfbbca2000-07-28 14:32:48 +00001311/*
1312** This routine installs a default busy handler that waits for the
1313** specified number of milliseconds before returning 0.
1314*/
danielk1977f9d64d22004-06-19 08:18:07 +00001315int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +00001316 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001317 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001318 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001319 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001320 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001321 }
danielk1977f9d64d22004-06-19 08:18:07 +00001322 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001323}
drh4c504392000-10-16 22:06:40 +00001324
1325/*
1326** Cause any pending operation to stop at its earliest opportunity.
1327*/
drh9bb575f2004-09-06 17:24:11 +00001328void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +00001329 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001330}
drhfa86c412002-02-02 15:01:15 +00001331
drhfa86c412002-02-02 15:01:15 +00001332
1333/*
danielk1977771151b2006-01-17 13:21:40 +00001334** This function is exactly the same as sqlite3_create_function(), except
1335** that it is designed to be called by internal code. The difference is
1336** that if a malloc() fails in sqlite3_create_function(), an error code
1337** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001338*/
danielk1977771151b2006-01-17 13:21:40 +00001339int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001340 sqlite3 *db,
1341 const char *zFunctionName,
1342 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001343 int enc,
danielk197765904932004-05-26 06:18:37 +00001344 void *pUserData,
1345 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1346 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001347 void (*xFinal)(sqlite3_context*),
1348 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001349){
drh0bce8352002-02-28 00:41:10 +00001350 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001351 int nName;
danielk197765904932004-05-26 06:18:37 +00001352
drhe30f4422007-08-21 16:15:55 +00001353 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001354 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001355 (xFunc && (xFinal || xStep)) ||
1356 (!xFunc && (xFinal && !xStep)) ||
1357 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001358 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001359 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001360 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001361 }
danielk1977d8123362004-06-12 09:25:12 +00001362
danielk197793758c82005-01-21 08:13:14 +00001363#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001364 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1365 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1366 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1367 **
1368 ** If SQLITE_ANY is specified, add three versions of the function
1369 ** to the hash table.
1370 */
1371 if( enc==SQLITE_UTF16 ){
1372 enc = SQLITE_UTF16NATIVE;
1373 }else if( enc==SQLITE_ANY ){
1374 int rc;
danielk1977771151b2006-01-17 13:21:40 +00001375 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
dand2199f02010-08-27 17:48:52 +00001376 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001377 if( rc==SQLITE_OK ){
1378 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
dand2199f02010-08-27 17:48:52 +00001379 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001380 }
1381 if( rc!=SQLITE_OK ){
1382 return rc;
1383 }
danielk1977d8123362004-06-12 09:25:12 +00001384 enc = SQLITE_UTF16BE;
1385 }
danielk197793758c82005-01-21 08:13:14 +00001386#else
1387 enc = SQLITE_UTF8;
1388#endif
danielk19779636c4e2005-01-25 04:27:54 +00001389
1390 /* Check if an existing function is being overridden or deleted. If so,
1391 ** and there are active VMs, then return SQLITE_BUSY. If a function
1392 ** is being overridden/deleted but there are no active VMs, allow the
1393 ** operation to continue but invalidate all precompiled statements.
1394 */
drh3abbd392008-12-10 23:04:13 +00001395 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001396 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
1397 if( db->activeVdbeCnt ){
1398 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001399 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001400 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001401 return SQLITE_BUSY;
1402 }else{
1403 sqlite3ExpirePreparedStatements(db);
1404 }
1405 }
danielk197765904932004-05-26 06:18:37 +00001406
drh3abbd392008-12-10 23:04:13 +00001407 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001408 assert(p || db->mallocFailed);
1409 if( !p ){
1410 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001411 }
dand2199f02010-08-27 17:48:52 +00001412
1413 /* If an older version of the function with a configured destructor is
1414 ** being replaced invoke the destructor function here. */
1415 functionDestroy(db, p);
1416
1417 if( pDestructor ){
1418 pDestructor->nRef++;
1419 }
1420 p->pDestructor = pDestructor;
danielk1977fa18bec2007-09-03 11:04:22 +00001421 p->flags = 0;
1422 p->xFunc = xFunc;
1423 p->xStep = xStep;
1424 p->xFinalize = xFinal;
1425 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001426 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001427 return SQLITE_OK;
1428}
danielk1977771151b2006-01-17 13:21:40 +00001429
1430/*
1431** Create new user functions.
1432*/
1433int sqlite3_create_function(
1434 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001435 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001436 int nArg,
1437 int enc,
1438 void *p,
1439 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1440 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1441 void (*xFinal)(sqlite3_context*)
1442){
drh7b19fac2010-08-27 18:44:54 +00001443 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1444 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001445}
1446
1447int sqlite3_create_function_v2(
1448 sqlite3 *db,
1449 const char *zFunc,
1450 int nArg,
1451 int enc,
1452 void *p,
1453 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1454 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1455 void (*xFinal)(sqlite3_context*),
1456 void (*xDestroy)(void *)
1457){
shanehbd2aaf92010-09-01 02:38:21 +00001458 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001459 FuncDestructor *pArg = 0;
1460 sqlite3_mutex_enter(db->mutex);
1461 if( xDestroy ){
1462 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001463 if( !pArg ){
1464 xDestroy(p);
1465 goto out;
1466 }
dand2199f02010-08-27 17:48:52 +00001467 pArg->xDestroy = xDestroy;
1468 pArg->pUserData = p;
1469 }
1470 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1471 if( pArg && pArg->nRef==0 ){
1472 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001473 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001474 sqlite3DbFree(db, pArg);
1475 }
1476
1477 out:
drhe30f4422007-08-21 16:15:55 +00001478 rc = sqlite3ApiExit(db, rc);
1479 sqlite3_mutex_leave(db->mutex);
1480 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001481}
1482
danielk197793758c82005-01-21 08:13:14 +00001483#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001484int sqlite3_create_function16(
1485 sqlite3 *db,
1486 const void *zFunctionName,
1487 int nArg,
1488 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001489 void *p,
danielk197765904932004-05-26 06:18:37 +00001490 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1491 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1492 void (*xFinal)(sqlite3_context*)
1493){
1494 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001495 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +00001496 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001497 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001498 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001499 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001500 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001501 rc = sqlite3ApiExit(db, rc);
1502 sqlite3_mutex_leave(db->mutex);
1503 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001504}
danielk197793758c82005-01-21 08:13:14 +00001505#endif
drhc9b84a12002-06-20 11:36:48 +00001506
drhb7481e72006-09-16 21:45:14 +00001507
1508/*
1509** Declare that a function has been overloaded by a virtual table.
1510**
1511** If the function already exists as a regular global function, then
1512** this routine is a no-op. If the function does not exist, then create
1513** a new one that always throws a run-time error.
1514**
1515** When virtual tables intend to provide an overloaded function, they
1516** should call this routine to make sure the global function exists.
1517** A global function must exist in order for name resolution to work
1518** properly.
1519*/
1520int sqlite3_overload_function(
1521 sqlite3 *db,
1522 const char *zName,
1523 int nArg
1524){
drhdee0e402009-05-03 20:23:53 +00001525 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001526 int rc = SQLITE_OK;
drhe30f4422007-08-21 16:15:55 +00001527 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001528 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001529 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1530 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001531 }
drhcb5e4db2011-10-12 23:49:49 +00001532 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001533 sqlite3_mutex_leave(db->mutex);
1534 return rc;
drhb7481e72006-09-16 21:45:14 +00001535}
1536
drh19e2d372005-08-29 23:00:03 +00001537#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001538/*
drh18de4822003-01-16 16:28:53 +00001539** Register a trace function. The pArg from the previously registered trace
1540** is returned.
1541**
1542** A NULL trace function means that no tracing is executes. A non-NULL
1543** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001544** SQL statement.
drh18de4822003-01-16 16:28:53 +00001545*/
drh9bb575f2004-09-06 17:24:11 +00001546void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001547 void *pOld;
1548 sqlite3_mutex_enter(db->mutex);
1549 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001550 db->xTrace = xTrace;
1551 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001552 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001553 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001554}
drh19e2d372005-08-29 23:00:03 +00001555/*
1556** Register a profile function. The pArg from the previously registered
1557** profile function is returned.
1558**
1559** A NULL profile function means that no profiling is executes. A non-NULL
1560** profile is a pointer to a function that is invoked at the conclusion of
1561** each SQL statement that is run.
1562*/
1563void *sqlite3_profile(
1564 sqlite3 *db,
1565 void (*xProfile)(void*,const char*,sqlite_uint64),
1566 void *pArg
1567){
drhe30f4422007-08-21 16:15:55 +00001568 void *pOld;
1569 sqlite3_mutex_enter(db->mutex);
1570 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001571 db->xProfile = xProfile;
1572 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001573 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001574 return pOld;
1575}
1576#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001577
drhcd565fd2012-03-01 21:30:44 +00001578/*
1579** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001580** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001581** rollback.
1582*/
danielk197724b03fd2004-05-10 10:34:34 +00001583void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001584 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001585 int (*xCallback)(void*), /* Function to invoke on each commit */
1586 void *pArg /* Argument to the function */
1587){
drhe30f4422007-08-21 16:15:55 +00001588 void *pOld;
1589 sqlite3_mutex_enter(db->mutex);
1590 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001591 db->xCommitCallback = xCallback;
1592 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001593 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001594 return pOld;
1595}
1596
danielk197794eb6a12005-12-15 15:22:08 +00001597/*
1598** Register a callback to be invoked each time a row is updated,
1599** inserted or deleted using this database connection.
1600*/
danielk197771fd80b2005-12-16 06:54:01 +00001601void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001602 sqlite3 *db, /* Attach the hook to this database */
1603 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1604 void *pArg /* Argument to the function */
1605){
drhe30f4422007-08-21 16:15:55 +00001606 void *pRet;
1607 sqlite3_mutex_enter(db->mutex);
1608 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001609 db->xUpdateCallback = xCallback;
1610 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001611 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001612 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001613}
1614
danielk197771fd80b2005-12-16 06:54:01 +00001615/*
1616** Register a callback to be invoked each time a transaction is rolled
1617** back by this database connection.
1618*/
1619void *sqlite3_rollback_hook(
1620 sqlite3 *db, /* Attach the hook to this database */
1621 void (*xCallback)(void*), /* Callback function */
1622 void *pArg /* Argument to the function */
1623){
drhe30f4422007-08-21 16:15:55 +00001624 void *pRet;
1625 sqlite3_mutex_enter(db->mutex);
1626 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001627 db->xRollbackCallback = xCallback;
1628 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001629 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001630 return pRet;
1631}
drhaa940ea2004-01-15 02:44:03 +00001632
dan586b9c82010-05-03 08:04:49 +00001633#ifndef SQLITE_OMIT_WAL
1634/*
1635** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001636** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1637** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001638** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001639*/
drhb033d8b2010-05-03 13:37:30 +00001640int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001641 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001642 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001643 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001644 int nFrame /* Size of WAL */
1645){
drh5def0842010-05-05 20:00:25 +00001646 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001647 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001648 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001649 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001650 }
1651 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001652}
drhb033d8b2010-05-03 13:37:30 +00001653#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001654
1655/*
1656** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1657** a database after committing a transaction if there are nFrame or
1658** more frames in the log file. Passing zero or a negative value as the
1659** nFrame parameter disables automatic checkpoints entirely.
1660**
1661** The callback registered by this function replaces any existing callback
1662** registered using sqlite3_wal_hook(). Likewise, registering a callback
1663** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1664** configured by this function.
1665*/
1666int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001667#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001668 UNUSED_PARAMETER(db);
1669 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001670#else
dan586b9c82010-05-03 08:04:49 +00001671 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001672 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001673 }else{
1674 sqlite3_wal_hook(db, 0, 0);
1675 }
drhb033d8b2010-05-03 13:37:30 +00001676#endif
dan586b9c82010-05-03 08:04:49 +00001677 return SQLITE_OK;
1678}
1679
paulb0208cc2003-04-13 18:26:49 +00001680/*
dan8d22a172010-04-19 18:03:51 +00001681** Register a callback to be invoked each time a transaction is written
1682** into the write-ahead-log by this database connection.
1683*/
drh833bf962010-04-28 14:42:19 +00001684void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001685 sqlite3 *db, /* Attach the hook to this db handle */
1686 int(*xCallback)(void *, sqlite3*, const char*, int),
1687 void *pArg /* First argument passed to xCallback() */
1688){
drhb033d8b2010-05-03 13:37:30 +00001689#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001690 void *pRet;
1691 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001692 pRet = db->pWalArg;
1693 db->xWalCallback = xCallback;
1694 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001695 sqlite3_mutex_leave(db->mutex);
1696 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001697#else
1698 return 0;
1699#endif
dan8d22a172010-04-19 18:03:51 +00001700}
1701
1702/*
dancdc1f042010-11-18 12:11:05 +00001703** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001704*/
dancdc1f042010-11-18 12:11:05 +00001705int sqlite3_wal_checkpoint_v2(
1706 sqlite3 *db, /* Database handle */
1707 const char *zDb, /* Name of attached database (or NULL) */
1708 int eMode, /* SQLITE_CHECKPOINT_* value */
1709 int *pnLog, /* OUT: Size of WAL log in frames */
1710 int *pnCkpt /* OUT: Total number of frames checkpointed */
1711){
drhb033d8b2010-05-03 13:37:30 +00001712#ifdef SQLITE_OMIT_WAL
1713 return SQLITE_OK;
1714#else
dan586b9c82010-05-03 08:04:49 +00001715 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001716 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001717
dan9c5e3682011-02-07 15:12:12 +00001718 /* Initialize the output variables to -1 in case an error occurs. */
1719 if( pnLog ) *pnLog = -1;
1720 if( pnCkpt ) *pnCkpt = -1;
1721
drh383d79e2011-02-09 03:03:16 +00001722 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1723 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1724 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1725 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001726 return SQLITE_MISUSE;
1727 }
1728
dan586b9c82010-05-03 08:04:49 +00001729 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001730 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001731 iDb = sqlite3FindDbName(db, zDb);
1732 }
1733 if( iDb<0 ){
1734 rc = SQLITE_ERROR;
dan87c1fe12010-05-03 12:14:15 +00001735 sqlite3Error(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001736 }else{
dancdc1f042010-11-18 12:11:05 +00001737 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
dan87c1fe12010-05-03 12:14:15 +00001738 sqlite3Error(db, rc, 0);
dan586b9c82010-05-03 08:04:49 +00001739 }
drhb033d8b2010-05-03 13:37:30 +00001740 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001741 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001742 return rc;
1743#endif
dan586b9c82010-05-03 08:04:49 +00001744}
1745
dancdc1f042010-11-18 12:11:05 +00001746
1747/*
1748** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1749** to contains a zero-length string, all attached databases are
1750** checkpointed.
1751*/
1752int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1753 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1754}
1755
drhb033d8b2010-05-03 13:37:30 +00001756#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001757/*
1758** Run a checkpoint on database iDb. This is a no-op if database iDb is
1759** not currently open in WAL mode.
1760**
dan6fcff072010-05-03 14:05:43 +00001761** If a transaction is open on the database being checkpointed, this
1762** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1763** an error occurs while running the checkpoint, an SQLite error code is
1764** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001765**
1766** The mutex on database handle db should be held by the caller. The mutex
1767** associated with the specific b-tree being checkpointed is taken by
1768** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001769**
1770** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1771** checkpointed. If an error is encountered it is returned immediately -
1772** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001773**
dancdc1f042010-11-18 12:11:05 +00001774** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001775*/
dancdc1f042010-11-18 12:11:05 +00001776int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001777 int rc = SQLITE_OK; /* Return code */
1778 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001779 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001780
1781 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001782 assert( !pnLog || *pnLog==-1 );
1783 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001784
dan6fcff072010-05-03 14:05:43 +00001785 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1786 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001787 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001788 pnLog = 0;
1789 pnCkpt = 0;
1790 if( rc==SQLITE_BUSY ){
1791 bBusy = 1;
1792 rc = SQLITE_OK;
1793 }
dan6fcff072010-05-03 14:05:43 +00001794 }
dan586b9c82010-05-03 08:04:49 +00001795 }
1796
danf2b8dd52010-11-18 19:28:01 +00001797 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001798}
drhb033d8b2010-05-03 13:37:30 +00001799#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001800
1801/*
danielk1977d8293352009-04-30 09:10:37 +00001802** This function returns true if main-memory should be used instead of
1803** a temporary file for transient pager files and statement journals.
1804** The value returned depends on the value of db->temp_store (runtime
1805** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1806** following table describes the relationship between these two values
1807** and this functions return value.
1808**
1809** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1810** ----------------- -------------- ------------------------------
1811** 0 any file (return 0)
1812** 1 1 file (return 0)
1813** 1 2 memory (return 1)
1814** 1 0 file (return 0)
1815** 2 1 file (return 0)
1816** 2 2 memory (return 1)
1817** 2 0 memory (return 1)
1818** 3 any memory (return 1)
1819*/
drh1c514142009-04-30 12:25:10 +00001820int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001821#if SQLITE_TEMP_STORE==1
1822 return ( db->temp_store==2 );
1823#endif
1824#if SQLITE_TEMP_STORE==2
1825 return ( db->temp_store!=1 );
1826#endif
1827#if SQLITE_TEMP_STORE==3
1828 return 1;
shanecf697392009-06-01 16:53:09 +00001829#endif
1830#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001831 return 0;
shane60a4b532009-05-06 18:57:09 +00001832#endif
danielk1977d8293352009-04-30 09:10:37 +00001833}
1834
1835/*
danielk19774ad17132004-05-21 01:47:26 +00001836** Return UTF-8 encoded English language explanation of the most recent
1837** error.
1838*/
danielk19776622cce2004-05-20 11:00:52 +00001839const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001840 const char *z;
drhf49661a2008-12-10 16:45:50 +00001841 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001842 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001843 }
drhd55d57e2008-07-07 17:53:07 +00001844 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001845 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001846 }
drh27641702007-08-22 02:56:42 +00001847 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001848 if( db->mallocFailed ){
1849 z = sqlite3ErrStr(SQLITE_NOMEM);
1850 }else{
1851 z = (char*)sqlite3_value_text(db->pErr);
1852 assert( !db->mallocFailed );
1853 if( z==0 ){
1854 z = sqlite3ErrStr(db->errCode);
1855 }
danielk19776622cce2004-05-20 11:00:52 +00001856 }
drhe30f4422007-08-21 16:15:55 +00001857 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001858 return z;
danielk19776622cce2004-05-20 11:00:52 +00001859}
1860
drh6c626082004-11-14 21:56:29 +00001861#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001862/*
1863** Return UTF-16 encoded English language explanation of the most recent
1864** error.
1865*/
danielk19776622cce2004-05-20 11:00:52 +00001866const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00001867 static const u16 outOfMem[] = {
1868 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00001869 };
danielk19777c5c3ca2009-02-23 14:42:53 +00001870 static const u16 misuse[] = {
1871 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
1872 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
1873 'c', 'a', 'l', 'l', 'e', 'd', ' ',
1874 'o', 'u', 't', ' ',
1875 'o', 'f', ' ',
1876 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00001877 };
danielk19774ad17132004-05-21 01:47:26 +00001878
drhc60d0442004-09-30 13:43:13 +00001879 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001880 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001881 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00001882 }
drhd55d57e2008-07-07 17:53:07 +00001883 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001884 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00001885 }
drhe30f4422007-08-21 16:15:55 +00001886 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001887 if( db->mallocFailed ){
1888 z = (void *)outOfMem;
1889 }else{
drhc60d0442004-09-30 13:43:13 +00001890 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00001891 if( z==0 ){
1892 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
1893 SQLITE_UTF8, SQLITE_STATIC);
1894 z = sqlite3_value_text16(db->pErr);
1895 }
1896 /* A malloc() may have failed within the call to sqlite3_value_text16()
1897 ** above. If this is the case, then the db->mallocFailed flag needs to
1898 ** be cleared before returning. Do this directly, instead of via
1899 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1900 */
1901 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00001902 }
drhe30f4422007-08-21 16:15:55 +00001903 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001904 return z;
danielk19776622cce2004-05-20 11:00:52 +00001905}
drh6c626082004-11-14 21:56:29 +00001906#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001907
drhc60d0442004-09-30 13:43:13 +00001908/*
danielk19777ddad962005-12-12 06:53:03 +00001909** Return the most recent error code generated by an SQLite routine. If NULL is
1910** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001911*/
danielk19776622cce2004-05-20 11:00:52 +00001912int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001913 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001914 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00001915 }
drh01495b92008-01-23 12:52:40 +00001916 if( !db || db->mallocFailed ){
1917 return SQLITE_NOMEM;
1918 }
drh4ac285a2006-09-15 07:28:50 +00001919 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001920}
drh99dfe5e2008-10-30 15:03:15 +00001921int sqlite3_extended_errcode(sqlite3 *db){
1922 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001923 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00001924 }
1925 if( !db || db->mallocFailed ){
1926 return SQLITE_NOMEM;
1927 }
1928 return db->errCode;
1929}
danielk19776622cce2004-05-20 11:00:52 +00001930
drh0e819f92006-02-01 13:50:41 +00001931/*
mistachkin5dac8432012-09-11 02:00:25 +00001932** Return a string that describes the kind of error specified in the
1933** argument. For now, this simply calls the internal sqlite3ErrStr()
1934** function.
1935*/
1936const char *sqlite3_errstr(int rc){
1937 return sqlite3ErrStr(rc);
1938}
1939
1940/*
drh0e819f92006-02-01 13:50:41 +00001941** Create a new collating function for database "db". The name is zName
1942** and the encoding is enc.
1943*/
danielk19779a30cf62006-01-18 04:26:07 +00001944static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00001945 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00001946 const char *zName,
shanecea72b22009-09-07 04:38:36 +00001947 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00001948 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001949 int(*xCompare)(void*,int,const void*,int,const void*),
1950 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001951){
1952 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001953 int enc2;
drhc4a64fa2009-05-11 20:53:28 +00001954 int nName = sqlite3Strlen30(zName);
danielk19779a30cf62006-01-18 04:26:07 +00001955
drhe30f4422007-08-21 16:15:55 +00001956 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001957
1958 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1959 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1960 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1961 */
drh51c7d862009-04-27 18:46:06 +00001962 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00001963 testcase( enc2==SQLITE_UTF16 );
1964 testcase( enc2==SQLITE_UTF16_ALIGNED );
1965 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00001966 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001967 }
drh51c7d862009-04-27 18:46:06 +00001968 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00001969 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00001970 }
1971
1972 /* Check if this call is removing or replacing an existing collation
1973 ** sequence. If so, and there are active VMs, return busy. If there
1974 ** are no active VMs, invalidate any pre-compiled statements.
1975 */
drhc4a64fa2009-05-11 20:53:28 +00001976 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001977 if( pColl && pColl->xCmp ){
1978 if( db->activeVdbeCnt ){
1979 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001980 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00001981 return SQLITE_BUSY;
1982 }
1983 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001984
1985 /* If collation sequence pColl was created directly by a call to
1986 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1987 ** then any copies made by synthCollSeq() need to be invalidated.
1988 ** Also, collation destructor - CollSeq.xDel() - function may need
1989 ** to be called.
1990 */
1991 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001992 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001993 int j;
1994 for(j=0; j<3; j++){
1995 CollSeq *p = &aColl[j];
1996 if( p->enc==pColl->enc ){
1997 if( p->xDel ){
1998 p->xDel(p->pUser);
1999 }
2000 p->xCmp = 0;
2001 }
2002 }
2003 }
danielk19779a30cf62006-01-18 04:26:07 +00002004 }
2005
drhc4a64fa2009-05-11 20:53:28 +00002006 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002007 if( pColl==0 ) return SQLITE_NOMEM;
2008 pColl->xCmp = xCompare;
2009 pColl->pUser = pCtx;
2010 pColl->xDel = xDel;
2011 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
danielk19779a30cf62006-01-18 04:26:07 +00002012 sqlite3Error(db, SQLITE_OK, 0);
2013 return SQLITE_OK;
2014}
2015
2016
danielk19776622cce2004-05-20 11:00:52 +00002017/*
drhbb4957f2008-03-20 14:03:29 +00002018** This array defines hard upper bounds on limit values. The
2019** initializer must be kept in sync with the SQLITE_LIMIT_*
2020** #defines in sqlite3.h.
2021*/
drhb1a6c3c2008-03-20 16:30:17 +00002022static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002023 SQLITE_MAX_LENGTH,
2024 SQLITE_MAX_SQL_LENGTH,
2025 SQLITE_MAX_COLUMN,
2026 SQLITE_MAX_EXPR_DEPTH,
2027 SQLITE_MAX_COMPOUND_SELECT,
2028 SQLITE_MAX_VDBE_OP,
2029 SQLITE_MAX_FUNCTION_ARG,
2030 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002031 SQLITE_MAX_LIKE_PATTERN_LENGTH,
2032 SQLITE_MAX_VARIABLE_NUMBER,
drh417168a2009-09-07 18:14:02 +00002033 SQLITE_MAX_TRIGGER_DEPTH,
drhbb4957f2008-03-20 14:03:29 +00002034};
2035
2036/*
2037** Make sure the hard limits are set to reasonable values
2038*/
2039#if SQLITE_MAX_LENGTH<100
2040# error SQLITE_MAX_LENGTH must be at least 100
2041#endif
2042#if SQLITE_MAX_SQL_LENGTH<100
2043# error SQLITE_MAX_SQL_LENGTH must be at least 100
2044#endif
2045#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2046# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2047#endif
drhbb4957f2008-03-20 14:03:29 +00002048#if SQLITE_MAX_COMPOUND_SELECT<2
2049# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2050#endif
2051#if SQLITE_MAX_VDBE_OP<40
2052# error SQLITE_MAX_VDBE_OP must be at least 40
2053#endif
drhe82f5d02008-10-07 19:53:14 +00002054#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2055# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002056#endif
drh01c7dc82011-03-23 18:22:34 +00002057#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>62
2058# error SQLITE_MAX_ATTACHED must be between 0 and 62
drhbb4957f2008-03-20 14:03:29 +00002059#endif
drhbb4957f2008-03-20 14:03:29 +00002060#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2061# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2062#endif
drh70a8ca32008-08-21 18:49:27 +00002063#if SQLITE_MAX_COLUMN>32767
2064# error SQLITE_MAX_COLUMN must not exceed 32767
2065#endif
drh417168a2009-09-07 18:14:02 +00002066#if SQLITE_MAX_TRIGGER_DEPTH<1
2067# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2068#endif
drhbb4957f2008-03-20 14:03:29 +00002069
2070
2071/*
2072** Change the value of a limit. Report the old value.
2073** If an invalid limit index is supplied, report -1.
2074** Make no changes but still report the old value if the
2075** new limit is negative.
2076**
2077** A new lower limit does not shrink existing constructs.
2078** It merely prevents new constructs that exceed the limit
2079** from forming.
2080*/
2081int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2082 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002083
2084
2085 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2086 ** there is a hard upper bound set at compile-time by a C preprocessor
2087 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2088 ** "_MAX_".)
2089 */
2090 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2091 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2092 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2093 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2094 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2095 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2096 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2097 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2098 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2099 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2100 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2101 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
2102 assert( SQLITE_LIMIT_TRIGGER_DEPTH==(SQLITE_N_LIMIT-1) );
2103
2104
drh521cc842008-04-15 02:36:33 +00002105 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002106 return -1;
2107 }
2108 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002109 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002110 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002111 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002112 }
2113 db->aLimit[limitId] = newLimit;
2114 }
drh4e93f5b2010-09-07 14:59:15 +00002115 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002116}
2117
2118/*
dan286ab7c2011-05-06 18:34:54 +00002119** This function is used to parse both URIs and non-URI filenames passed by the
2120** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2121** URIs specified as part of ATTACH statements.
2122**
2123** The first argument to this function is the name of the VFS to use (or
2124** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2125** query parameter. The second argument contains the URI (or non-URI filename)
2126** itself. When this function is called the *pFlags variable should contain
2127** the default flags to open the database handle with. The value stored in
2128** *pFlags may be updated before returning if the URI filename contains
2129** "cache=xxx" or "mode=xxx" query parameters.
2130**
2131** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2132** the VFS that should be used to open the database file. *pzFile is set to
2133** point to a buffer containing the name of the file to open. It is the
2134** responsibility of the caller to eventually call sqlite3_free() to release
2135** this buffer.
2136**
2137** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2138** may be set to point to a buffer containing an English language error
2139** message. It is the responsibility of the caller to eventually release
2140** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002141*/
2142int sqlite3ParseUri(
2143 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2144 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002145 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002146 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2147 char **pzFile, /* OUT: Filename component of URI */
2148 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2149){
dan78e9dd22011-05-03 10:22:32 +00002150 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002151 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002152 const char *zVfs = zDefaultVfs;
2153 char *zFile;
drhde941c32011-05-09 19:20:17 +00002154 char c;
dancd74b612011-04-22 19:37:32 +00002155 int nUri = sqlite3Strlen30(zUri);
2156
2157 assert( *pzErrMsg==0 );
2158
2159 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
2160 && nUri>=5 && memcmp(zUri, "file:", 5)==0
2161 ){
dan5de15372011-04-23 10:12:30 +00002162 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002163 int eState; /* Parser state when parsing URI */
2164 int iIn; /* Input character index */
2165 int iOut = 0; /* Output character index */
2166 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002167
dan286ab7c2011-05-06 18:34:54 +00002168 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2169 ** method that there may be extra parameters following the file-name. */
2170 flags |= SQLITE_OPEN_URI;
2171
2172 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002173 zFile = sqlite3_malloc(nByte);
2174 if( !zFile ) return SQLITE_NOMEM;
2175
2176 /* Discard the scheme and authority segments of the URI. */
2177 if( zUri[5]=='/' && zUri[6]=='/' ){
2178 iIn = 7;
2179 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002180
2181 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2182 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2183 iIn-7, &zUri[7]);
2184 rc = SQLITE_ERROR;
2185 goto parse_uri_out;
2186 }
dancd74b612011-04-22 19:37:32 +00002187 }else{
2188 iIn = 5;
2189 }
2190
2191 /* Copy the filename and any query parameters into the zFile buffer.
2192 ** Decode %HH escape codes along the way.
2193 **
2194 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2195 ** on the parsing context. As follows:
2196 **
2197 ** 0: Parsing file-name.
2198 ** 1: Parsing name section of a name=value query parameter.
2199 ** 2: Parsing value section of a name=value query parameter.
2200 */
2201 eState = 0;
drhde941c32011-05-09 19:20:17 +00002202 while( (c = zUri[iIn])!=0 && c!='#' ){
2203 iIn++;
dancd74b612011-04-22 19:37:32 +00002204 if( c=='%'
2205 && sqlite3Isxdigit(zUri[iIn])
2206 && sqlite3Isxdigit(zUri[iIn+1])
2207 ){
dan6d49e252011-05-03 15:09:05 +00002208 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2209 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002210
dan6d49e252011-05-03 15:09:05 +00002211 assert( octet>=0 && octet<256 );
2212 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002213 /* This branch is taken when "%00" appears within the URI. In this
2214 ** case we ignore all text in the remainder of the path, name or
2215 ** value currently being parsed. So ignore the current character
2216 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002217 while( (c = zUri[iIn])!=0 && c!='#'
2218 && (eState!=0 || c!='?')
2219 && (eState!=1 || (c!='=' && c!='&'))
2220 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002221 ){
2222 iIn++;
2223 }
2224 continue;
dancd74b612011-04-22 19:37:32 +00002225 }
dan6d49e252011-05-03 15:09:05 +00002226 c = octet;
dan5de15372011-04-23 10:12:30 +00002227 }else if( eState==1 && (c=='&' || c=='=') ){
2228 if( zFile[iOut-1]==0 ){
2229 /* An empty option name. Ignore this option altogether. */
2230 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2231 continue;
2232 }
2233 if( c=='&' ){
2234 zFile[iOut++] = '\0';
2235 }else{
2236 eState = 2;
2237 }
dancd74b612011-04-22 19:37:32 +00002238 c = 0;
dan5de15372011-04-23 10:12:30 +00002239 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2240 c = 0;
dancd74b612011-04-22 19:37:32 +00002241 eState = 1;
dancd74b612011-04-22 19:37:32 +00002242 }
2243 zFile[iOut++] = c;
2244 }
2245 if( eState==1 ) zFile[iOut++] = '\0';
2246 zFile[iOut++] = '\0';
2247 zFile[iOut++] = '\0';
2248
2249 /* Check if there were any options specified that should be interpreted
2250 ** here. Options that are interpreted here include "vfs" and those that
2251 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002252 ** method. */
dan5de15372011-04-23 10:12:30 +00002253 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2254 while( zOpt[0] ){
2255 int nOpt = sqlite3Strlen30(zOpt);
2256 char *zVal = &zOpt[nOpt+1];
2257 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002258
dan286ab7c2011-05-06 18:34:54 +00002259 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002260 zVfs = zVal;
2261 }else{
2262 struct OpenMode {
2263 const char *z;
2264 int mode;
2265 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002266 char *zModeType = 0;
2267 int mask = 0;
2268 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002269
dan286ab7c2011-05-06 18:34:54 +00002270 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002271 static struct OpenMode aCacheMode[] = {
2272 { "shared", SQLITE_OPEN_SHAREDCACHE },
2273 { "private", SQLITE_OPEN_PRIVATECACHE },
2274 { 0, 0 }
2275 };
2276
2277 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2278 aMode = aCacheMode;
2279 limit = mask;
2280 zModeType = "cache";
2281 }
dan286ab7c2011-05-06 18:34:54 +00002282 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002283 static struct OpenMode aOpenMode[] = {
2284 { "ro", SQLITE_OPEN_READONLY },
2285 { "rw", SQLITE_OPEN_READWRITE },
2286 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002287 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002288 { 0, 0 }
2289 };
2290
drh9c67b2a2012-05-28 13:58:00 +00002291 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2292 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002293 aMode = aOpenMode;
2294 limit = mask & flags;
2295 zModeType = "access";
2296 }
2297
2298 if( aMode ){
2299 int i;
2300 int mode = 0;
2301 for(i=0; aMode[i].z; i++){
2302 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002303 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002304 mode = aMode[i].mode;
2305 break;
dancd74b612011-04-22 19:37:32 +00002306 }
2307 }
dan78e9dd22011-05-03 10:22:32 +00002308 if( mode==0 ){
2309 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2310 rc = SQLITE_ERROR;
2311 goto parse_uri_out;
2312 }
drh9c67b2a2012-05-28 13:58:00 +00002313 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002314 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2315 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002316 rc = SQLITE_PERM;
2317 goto parse_uri_out;
2318 }
2319 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002320 }
dancd74b612011-04-22 19:37:32 +00002321 }
dan5de15372011-04-23 10:12:30 +00002322
2323 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002324 }
2325
2326 }else{
2327 zFile = sqlite3_malloc(nUri+2);
2328 if( !zFile ) return SQLITE_NOMEM;
2329 memcpy(zFile, zUri, nUri);
2330 zFile[nUri] = '\0';
2331 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002332 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002333 }
2334
2335 *ppVfs = sqlite3_vfs_find(zVfs);
2336 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002337 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002338 rc = SQLITE_ERROR;
2339 }
2340 parse_uri_out:
2341 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002342 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002343 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002344 }
2345 *pFlags = flags;
2346 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002347 return rc;
dancd74b612011-04-22 19:37:32 +00002348}
2349
2350
2351/*
danielk19774ad17132004-05-21 01:47:26 +00002352** This routine does the work of opening a database on behalf of
2353** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002354** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002355*/
2356static int openDatabase(
2357 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002358 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002359 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002360 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002361){
dancd74b612011-04-22 19:37:32 +00002362 sqlite3 *db; /* Store allocated handle here */
2363 int rc; /* Return code */
2364 int isThreadsafe; /* True for threadsafe connections */
2365 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2366 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002367
drhe0d0f8e2009-04-28 04:47:31 +00002368 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002369#ifndef SQLITE_OMIT_AUTOINIT
2370 rc = sqlite3_initialize();
2371 if( rc ) return rc;
2372#endif
2373
dan78e9dd22011-05-03 10:22:32 +00002374 /* Only allow sensible combinations of bits in the flags argument.
2375 ** Throw an error if any non-sense combination is used. If we
2376 ** do not block illegal combinations here, it could trigger
2377 ** assert() statements in deeper layers. Sensible combinations
2378 ** are:
2379 **
2380 ** 1: SQLITE_OPEN_READONLY
2381 ** 2: SQLITE_OPEN_READWRITE
2382 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2383 */
2384 assert( SQLITE_OPEN_READONLY == 0x01 );
2385 assert( SQLITE_OPEN_READWRITE == 0x02 );
2386 assert( SQLITE_OPEN_CREATE == 0x04 );
2387 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2388 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2389 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh5dd72ad2011-05-07 18:18:33 +00002390 if( ((1<<(flags&7)) & 0x46)==0 ) return SQLITE_MISUSE_BKPT;
dan78e9dd22011-05-03 10:22:32 +00002391
drh039963a2008-09-03 00:43:15 +00002392 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002393 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002394 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2395 isThreadsafe = 0;
2396 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2397 isThreadsafe = 1;
2398 }else{
2399 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002400 }
drhf1f12682009-09-09 14:17:52 +00002401 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002402 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002403 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2404 flags |= SQLITE_OPEN_SHAREDCACHE;
2405 }
danielk19779a6284c2008-07-10 17:52:49 +00002406
drhb25a9f42009-05-12 13:35:11 +00002407 /* Remove harmful bits from the flags parameter
2408 **
2409 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2410 ** dealt with in the previous code block. Besides these, the only
2411 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002412 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2413 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002414 ** off all other flags.
2415 */
drha4267dc2008-02-19 15:20:44 +00002416 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002417 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002418 SQLITE_OPEN_MAIN_DB |
2419 SQLITE_OPEN_TEMP_DB |
2420 SQLITE_OPEN_TRANSIENT_DB |
2421 SQLITE_OPEN_MAIN_JOURNAL |
2422 SQLITE_OPEN_TEMP_JOURNAL |
2423 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002424 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002425 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002426 SQLITE_OPEN_FULLMUTEX |
2427 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002428 );
2429
danielk19774ad17132004-05-21 01:47:26 +00002430 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002431 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002432 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002433 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002434 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2435 if( db->mutex==0 ){
2436 sqlite3_free(db);
2437 db = 0;
2438 goto opendb_out;
2439 }
drh605264d2007-08-21 15:13:19 +00002440 }
drh27641702007-08-22 02:56:42 +00002441 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002442 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002443 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002444 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002445 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002446
drhbb4957f2008-03-20 14:03:29 +00002447 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2448 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00002449 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002450 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002451 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002452 db->nextPagesize = 0;
drhe83cafd2011-03-21 17:15:58 +00002453 db->flags |= SQLITE_ShortColNames | SQLITE_AutoIndex | SQLITE_EnableTrigger
drh76fe8032006-07-11 14:17:51 +00002454#if SQLITE_DEFAULT_FILE_FORMAT<4
2455 | SQLITE_LegacyFileFmt
2456#endif
drh56424db2007-03-27 22:24:11 +00002457#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2458 | SQLITE_LoadExtension
2459#endif
dan5bde73c2009-09-01 17:11:07 +00002460#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002461 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002462#endif
drha4bfd7f2010-12-09 19:15:17 +00002463#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2464 | SQLITE_ForeignKeys
2465#endif
drh76fe8032006-07-11 14:17:51 +00002466 ;
drhe61922a2009-05-02 13:29:37 +00002467 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002468#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002469 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002470#endif
danielk1977da184232006-01-05 11:34:32 +00002471
danielk19770202b292004-06-09 09:55:16 +00002472 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2473 ** and UTF-16, so add a version for each to avoid any unnecessary
2474 ** conversions. The only error that can occur here is a malloc() failure.
2475 */
drh4dd65e02011-11-29 14:46:56 +00002476 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2477 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2478 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2479 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002480 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002481 goto opendb_out;
2482 }
drhc4a64fa2009-05-11 20:53:28 +00002483 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002484 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002485
2486 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002487 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002488
dancd74b612011-04-22 19:37:32 +00002489 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002490 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002491 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2492 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002493 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
dan78e9dd22011-05-03 10:22:32 +00002494 sqlite3Error(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002495 sqlite3_free(zErrMsg);
2496 goto opendb_out;
2497 }
2498
danielk19774ad17132004-05-21 01:47:26 +00002499 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002500 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002501 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002502 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002503 if( rc==SQLITE_IOERR_NOMEM ){
2504 rc = SQLITE_NOMEM;
2505 }
danielk19774ad17132004-05-21 01:47:26 +00002506 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00002507 goto opendb_out;
2508 }
drh17435752007-08-16 04:30:38 +00002509 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2510 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002511
drh03b808a2006-03-13 15:06:05 +00002512
danielk197753c0f742005-03-29 03:10:59 +00002513 /* The default safety_level for the main database is 'full'; for the temp
2514 ** database it is 'NONE'. This matches the pager layer defaults.
2515 */
2516 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002517 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002518 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002519 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002520
danielk1977832a58a2007-06-22 15:21:15 +00002521 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002522 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002523 goto opendb_out;
2524 }
2525
danielk19778e227872004-06-07 07:52:17 +00002526 /* Register all built-in functions, but do not attempt to read the
2527 ** database schema yet. This is delayed until the first time the database
2528 ** is accessed.
2529 */
danielk1977832a58a2007-06-22 15:21:15 +00002530 sqlite3Error(db, SQLITE_OK, 0);
2531 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002532
drh1409be62006-08-23 20:07:20 +00002533 /* Load automatic extensions - extensions that have been registered
2534 ** using the sqlite3_automatic_extension() API.
2535 */
drh7aaa8782009-05-20 02:40:45 +00002536 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002537 if( rc==SQLITE_OK ){
2538 sqlite3AutoLoadExtensions(db);
2539 rc = sqlite3_errcode(db);
2540 if( rc!=SQLITE_OK ){
2541 goto opendb_out;
2542 }
danielk1977832a58a2007-06-22 15:21:15 +00002543 }
drh1409be62006-08-23 20:07:20 +00002544
drhaa29c132006-09-02 13:58:06 +00002545#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002546 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002547 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002548 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002549 }
2550#endif
2551
shessa26cf572006-10-19 20:27:58 +00002552#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002553 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002554 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002555 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002556 }
2557#endif
2558
shess69c4ae22007-08-20 17:37:47 +00002559#ifdef SQLITE_ENABLE_FTS3
2560 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002561 rc = sqlite3Fts3Init(db);
2562 }
2563#endif
2564
danielk197783852ac2007-05-06 16:04:11 +00002565#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002566 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002567 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002568 }
2569#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002570
2571#ifdef SQLITE_ENABLE_RTREE
2572 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002573 rc = sqlite3RtreeInit(db);
2574 }
2575#endif
2576
danielk1977832a58a2007-06-22 15:21:15 +00002577 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00002578
drh8fd5bd32007-04-02 16:40:37 +00002579 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2580 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2581 ** mode. Doing nothing at all also makes NORMAL the default.
2582 */
2583#ifdef SQLITE_DEFAULT_LOCKING_MODE
2584 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2585 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2586 SQLITE_DEFAULT_LOCKING_MODE);
2587#endif
2588
drh633e6d52008-07-28 19:34:53 +00002589 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002590 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2591 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002592
dan5a299f92010-05-03 11:05:08 +00002593 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002594
danielk19774ad17132004-05-21 01:47:26 +00002595opendb_out:
dancd74b612011-04-22 19:37:32 +00002596 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002597 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002598 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002599 sqlite3_mutex_leave(db->mutex);
2600 }
danielk197759633ae2008-08-27 19:01:57 +00002601 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002602 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002603 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002604 sqlite3_close(db);
2605 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002606 }else if( rc!=SQLITE_OK ){
2607 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002608 }
danielk19774ad17132004-05-21 01:47:26 +00002609 *ppDb = db;
danac455932012-11-26 19:50:41 +00002610#ifdef SQLITE_ENABLE_SQLLOG
2611 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002612 /* Opening a db handle. Fourth parameter is passed 0. */
2613 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2614 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002615 }
2616#endif
danielk197754f01982006-01-18 15:25:17 +00002617 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002618}
2619
2620/*
2621** Open a new database handle.
2622*/
danielk197780290862004-05-22 09:21:21 +00002623int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002624 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002625 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002626){
drh605264d2007-08-21 15:13:19 +00002627 return openDatabase(zFilename, ppDb,
2628 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2629}
2630int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002631 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002632 sqlite3 **ppDb, /* OUT: SQLite db handle */
2633 int flags, /* Flags */
2634 const char *zVfs /* Name of VFS module to use */
2635){
drh522c26f2011-05-07 14:40:29 +00002636 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002637}
2638
drh6c626082004-11-14 21:56:29 +00002639#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002640/*
2641** Open a new database handle.
2642*/
2643int sqlite3_open16(
2644 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002645 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002646){
danielk1977bfd6cce2004-06-18 04:24:54 +00002647 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002648 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002649 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002650
danielk19777ddad962005-12-12 06:53:03 +00002651 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00002652 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00002653 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002654#ifndef SQLITE_OMIT_AUTOINIT
2655 rc = sqlite3_initialize();
2656 if( rc ) return rc;
2657#endif
danielk19771e536952007-08-16 10:09:01 +00002658 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002659 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2660 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002661 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002662 rc = openDatabase(zFilename8, ppDb,
2663 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002664 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002665 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002666 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002667 }
drh40257ff2008-06-13 18:24:27 +00002668 }else{
2669 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002670 }
danielk19777ddad962005-12-12 06:53:03 +00002671 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002672
danielk197754f01982006-01-18 15:25:17 +00002673 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002674}
drh6c626082004-11-14 21:56:29 +00002675#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002676
danielk1977106bb232004-05-21 10:08:53 +00002677/*
danielk1977d8123362004-06-12 09:25:12 +00002678** Register a new collation sequence with the database handle db.
2679*/
danielk19770202b292004-06-09 09:55:16 +00002680int sqlite3_create_collation(
2681 sqlite3* db,
2682 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002683 int enc,
danielk19770202b292004-06-09 09:55:16 +00002684 void* pCtx,
2685 int(*xCompare)(void*,int,const void*,int,const void*)
2686){
danielk19779a30cf62006-01-18 04:26:07 +00002687 int rc;
drhe30f4422007-08-21 16:15:55 +00002688 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002689 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002690 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00002691 rc = sqlite3ApiExit(db, rc);
2692 sqlite3_mutex_leave(db->mutex);
2693 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00002694}
2695
2696/*
2697** Register a new collation sequence with the database handle db.
2698*/
danielk1977a393c032007-05-07 14:58:53 +00002699int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002700 sqlite3* db,
2701 const char *zName,
2702 int enc,
2703 void* pCtx,
2704 int(*xCompare)(void*,int,const void*,int,const void*),
2705 void(*xDel)(void*)
2706){
2707 int rc;
drhe30f4422007-08-21 16:15:55 +00002708 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002709 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002710 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002711 rc = sqlite3ApiExit(db, rc);
2712 sqlite3_mutex_leave(db->mutex);
2713 return rc;
danielk19770202b292004-06-09 09:55:16 +00002714}
2715
drh6c626082004-11-14 21:56:29 +00002716#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002717/*
2718** Register a new collation sequence with the database handle db.
2719*/
danielk19770202b292004-06-09 09:55:16 +00002720int sqlite3_create_collation16(
2721 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002722 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002723 int enc,
danielk19770202b292004-06-09 09:55:16 +00002724 void* pCtx,
2725 int(*xCompare)(void*,int,const void*,int,const void*)
2726){
danielk19779a30cf62006-01-18 04:26:07 +00002727 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002728 char *zName8;
drhe30f4422007-08-21 16:15:55 +00002729 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002730 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002731 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002732 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002733 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002734 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002735 }
drhe30f4422007-08-21 16:15:55 +00002736 rc = sqlite3ApiExit(db, rc);
2737 sqlite3_mutex_leave(db->mutex);
2738 return rc;
danielk19770202b292004-06-09 09:55:16 +00002739}
drh6c626082004-11-14 21:56:29 +00002740#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002741
danielk1977d8123362004-06-12 09:25:12 +00002742/*
2743** Register a collation sequence factory callback with the database handle
2744** db. Replace any previously installed collation sequence factory.
2745*/
danielk19777cedc8d2004-06-10 10:50:08 +00002746int sqlite3_collation_needed(
2747 sqlite3 *db,
2748 void *pCollNeededArg,
2749 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2750){
drhe30f4422007-08-21 16:15:55 +00002751 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002752 db->xCollNeeded = xCollNeeded;
2753 db->xCollNeeded16 = 0;
2754 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002755 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002756 return SQLITE_OK;
2757}
danielk1977d8123362004-06-12 09:25:12 +00002758
drh6c626082004-11-14 21:56:29 +00002759#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002760/*
2761** Register a collation sequence factory callback with the database handle
2762** db. Replace any previously installed collation sequence factory.
2763*/
danielk19777cedc8d2004-06-10 10:50:08 +00002764int sqlite3_collation_needed16(
2765 sqlite3 *db,
2766 void *pCollNeededArg,
2767 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2768){
drhe30f4422007-08-21 16:15:55 +00002769 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002770 db->xCollNeeded = 0;
2771 db->xCollNeeded16 = xCollNeeded16;
2772 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002773 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002774 return SQLITE_OK;
2775}
drh6c626082004-11-14 21:56:29 +00002776#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002777
shaneeec556d2008-10-12 00:27:53 +00002778#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002779/*
danielk19777ddad962005-12-12 06:53:03 +00002780** This function is now an anachronism. It used to be used to recover from a
2781** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002782*/
drh7d97efb2007-10-12 19:35:48 +00002783int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002784 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002785}
2786#endif
drh3e1d8e62005-05-26 16:23:34 +00002787
2788/*
2789** Test to see whether or not the database connection is in autocommit
2790** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2791** by default. Autocommit is disabled by a BEGIN statement and reenabled
2792** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00002793*/
2794int sqlite3_get_autocommit(sqlite3 *db){
2795 return db->autoCommit;
2796}
drh49285702005-09-17 15:20:26 +00002797
drh49285702005-09-17 15:20:26 +00002798/*
drh9978c972010-02-23 17:36:32 +00002799** The following routines are subtitutes for constants SQLITE_CORRUPT,
2800** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
2801** constants. They server two purposes:
2802**
2803** 1. Serve as a convenient place to set a breakpoint in a debugger
2804** to detect when version error conditions occurs.
2805**
2806** 2. Invoke sqlite3_log() to provide the source code location where
2807** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00002808*/
drh9978c972010-02-23 17:36:32 +00002809int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002810 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00002811 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00002812 "database corruption at line %d of [%.10s]",
2813 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00002814 return SQLITE_CORRUPT;
2815}
drh9978c972010-02-23 17:36:32 +00002816int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002817 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002818 sqlite3_log(SQLITE_MISUSE,
2819 "misuse at line %d of [%.10s]",
2820 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002821 return SQLITE_MISUSE;
2822}
2823int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002824 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002825 sqlite3_log(SQLITE_CANTOPEN,
2826 "cannot open file at line %d of [%.10s]",
2827 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002828 return SQLITE_CANTOPEN;
2829}
2830
drh7c1817e2006-01-10 13:58:48 +00002831
shaneeec556d2008-10-12 00:27:53 +00002832#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00002833/*
2834** This is a convenience routine that makes sure that all thread-specific
2835** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00002836**
2837** SQLite no longer uses thread-specific data so this routine is now a
2838** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00002839*/
2840void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00002841}
shaneeec556d2008-10-12 00:27:53 +00002842#endif
danielk1977deb802c2006-02-09 13:43:28 +00002843
2844/*
2845** Return meta information about a specific column of a database table.
2846** See comment in sqlite3.h (sqlite.h.in) for details.
2847*/
2848#ifdef SQLITE_ENABLE_COLUMN_METADATA
2849int sqlite3_table_column_metadata(
2850 sqlite3 *db, /* Connection handle */
2851 const char *zDbName, /* Database name or NULL */
2852 const char *zTableName, /* Table name */
2853 const char *zColumnName, /* Column name */
2854 char const **pzDataType, /* OUTPUT: Declared data type */
2855 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
2856 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
2857 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00002858 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00002859){
2860 int rc;
2861 char *zErrMsg = 0;
2862 Table *pTab = 0;
2863 Column *pCol = 0;
2864 int iCol;
2865
2866 char const *zDataType = 0;
2867 char const *zCollSeq = 0;
2868 int notnull = 0;
2869 int primarykey = 0;
2870 int autoinc = 0;
2871
2872 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00002873 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00002874 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002875 rc = sqlite3Init(db, &zErrMsg);
2876 if( SQLITE_OK!=rc ){
2877 goto error_out;
2878 }
2879
2880 /* Locate the table in question */
2881 pTab = sqlite3FindTable(db, zTableName, zDbName);
2882 if( !pTab || pTab->pSelect ){
2883 pTab = 0;
2884 goto error_out;
2885 }
2886
2887 /* Find the column for which info is requested */
2888 if( sqlite3IsRowid(zColumnName) ){
2889 iCol = pTab->iPKey;
2890 if( iCol>=0 ){
2891 pCol = &pTab->aCol[iCol];
2892 }
2893 }else{
2894 for(iCol=0; iCol<pTab->nCol; iCol++){
2895 pCol = &pTab->aCol[iCol];
2896 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
2897 break;
2898 }
2899 }
2900 if( iCol==pTab->nCol ){
2901 pTab = 0;
2902 goto error_out;
2903 }
2904 }
2905
2906 /* The following block stores the meta information that will be returned
2907 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
2908 ** and autoinc. At this point there are two possibilities:
2909 **
2910 ** 1. The specified column name was rowid", "oid" or "_rowid_"
2911 ** and there is no explicitly declared IPK column.
2912 **
2913 ** 2. The table is not a view and the column name identified an
2914 ** explicitly declared column. Copy meta information from *pCol.
2915 */
2916 if( pCol ){
2917 zDataType = pCol->zType;
2918 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00002919 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00002920 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00002921 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00002922 }else{
2923 zDataType = "INTEGER";
2924 primarykey = 1;
2925 }
2926 if( !zCollSeq ){
2927 zCollSeq = "BINARY";
2928 }
2929
2930error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00002931 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002932
2933 /* Whether the function call succeeded or failed, set the output parameters
2934 ** to whatever their local counterparts contain. If an error did occur,
2935 ** this has the effect of zeroing all output parameters.
2936 */
2937 if( pzDataType ) *pzDataType = zDataType;
2938 if( pzCollSeq ) *pzCollSeq = zCollSeq;
2939 if( pNotNull ) *pNotNull = notnull;
2940 if( pPrimaryKey ) *pPrimaryKey = primarykey;
2941 if( pAutoinc ) *pAutoinc = autoinc;
2942
2943 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00002944 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00002945 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00002946 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00002947 rc = SQLITE_ERROR;
2948 }
2949 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002950 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00002951 rc = sqlite3ApiExit(db, rc);
2952 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00002953 return rc;
2954}
drhe30f4422007-08-21 16:15:55 +00002955#endif
drhf9cb7f52006-06-27 20:06:44 +00002956
2957/*
2958** Sleep for a little while. Return the amount of time slept.
2959*/
2960int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00002961 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00002962 int rc;
drhd677b3d2007-08-20 22:48:41 +00002963 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00002964 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00002965
2966 /* This function works in milliseconds, but the underlying OsSleep()
2967 ** API uses microseconds. Hence the 1000's.
2968 */
drhe30f4422007-08-21 16:15:55 +00002969 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00002970 return rc;
drhf9cb7f52006-06-27 20:06:44 +00002971}
drh4ac285a2006-09-15 07:28:50 +00002972
2973/*
2974** Enable or disable the extended result codes.
2975*/
2976int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00002977 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002978 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00002979 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002980 return SQLITE_OK;
2981}
drhcc6bb3e2007-08-31 16:11:35 +00002982
2983/*
2984** Invoke the xFileControl method on a particular database.
2985*/
2986int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
2987 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00002988 Btree *pBtree;
2989
drhcc6bb3e2007-08-31 16:11:35 +00002990 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00002991 pBtree = sqlite3DbNameToBtree(db, zDbName);
2992 if( pBtree ){
2993 Pager *pPager;
2994 sqlite3_file *fd;
2995 sqlite3BtreeEnter(pBtree);
2996 pPager = sqlite3BtreePager(pBtree);
2997 assert( pPager!=0 );
2998 fd = sqlite3PagerFile(pPager);
2999 assert( fd!=0 );
3000 if( op==SQLITE_FCNTL_FILE_POINTER ){
3001 *(sqlite3_file**)pArg = fd;
3002 rc = SQLITE_OK;
3003 }else if( fd->pMethods ){
3004 rc = sqlite3OsFileControl(fd, op, pArg);
3005 }else{
3006 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003007 }
drh421377e2012-03-15 21:28:54 +00003008 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003009 }
3010 sqlite3_mutex_leave(db->mutex);
3011 return rc;
3012}
drhed13d982008-01-31 14:43:24 +00003013
3014/*
3015** Interface to the testing logic.
3016*/
3017int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003018 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003019#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003020 va_list ap;
drhed13d982008-01-31 14:43:24 +00003021 va_start(ap, op);
3022 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003023
3024 /*
drh984bfaa2008-03-19 16:08:53 +00003025 ** Save the current state of the PRNG.
3026 */
drh2fa18682008-03-19 14:15:34 +00003027 case SQLITE_TESTCTRL_PRNG_SAVE: {
3028 sqlite3PrngSaveState();
3029 break;
3030 }
drh984bfaa2008-03-19 16:08:53 +00003031
3032 /*
3033 ** Restore the state of the PRNG to the last state saved using
3034 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3035 ** this verb acts like PRNG_RESET.
3036 */
drh2fa18682008-03-19 14:15:34 +00003037 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3038 sqlite3PrngRestoreState();
3039 break;
3040 }
drh984bfaa2008-03-19 16:08:53 +00003041
3042 /*
3043 ** Reset the PRNG back to its uninitialized state. The next call
3044 ** to sqlite3_randomness() will reseed the PRNG using a single call
3045 ** to the xRandomness method of the default VFS.
3046 */
drh2fa18682008-03-19 14:15:34 +00003047 case SQLITE_TESTCTRL_PRNG_RESET: {
3048 sqlite3PrngResetState();
3049 break;
3050 }
drh3088d592008-03-21 16:45:47 +00003051
3052 /*
3053 ** sqlite3_test_control(BITVEC_TEST, size, program)
3054 **
3055 ** Run a test against a Bitvec object of size. The program argument
3056 ** is an array of integers that defines the test. Return -1 on a
3057 ** memory allocation error, 0 on success, or non-zero for an error.
3058 ** See the sqlite3BitvecBuiltinTest() for additional information.
3059 */
3060 case SQLITE_TESTCTRL_BITVEC_TEST: {
3061 int sz = va_arg(ap, int);
3062 int *aProg = va_arg(ap, int*);
3063 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3064 break;
3065 }
danielk19772d1d86f2008-06-20 14:59:51 +00003066
3067 /*
3068 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3069 **
3070 ** Register hooks to call to indicate which malloc() failures
3071 ** are benign.
3072 */
3073 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003074 typedef void (*void_function)(void);
3075 void_function xBenignBegin;
3076 void_function xBenignEnd;
3077 xBenignBegin = va_arg(ap, void_function);
3078 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003079 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3080 break;
3081 }
drhc7a3bb92009-02-05 16:31:45 +00003082
3083 /*
drhf3af63f2009-05-09 18:59:42 +00003084 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003085 **
3086 ** Set the PENDING byte to the value in the argument, if X>0.
3087 ** Make no changes if X==0. Return the value of the pending byte
3088 ** as it existing before this routine was called.
3089 **
3090 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3091 ** an incompatible database file format. Changing the PENDING byte
3092 ** while any database connection is open results in undefined and
3093 ** dileterious behavior.
3094 */
3095 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003096 rc = PENDING_BYTE;
3097#ifndef SQLITE_OMIT_WSD
3098 {
3099 unsigned int newVal = va_arg(ap, unsigned int);
3100 if( newVal ) sqlite3PendingByte = newVal;
3101 }
3102#endif
drhc7a3bb92009-02-05 16:31:45 +00003103 break;
3104 }
drhf3af63f2009-05-09 18:59:42 +00003105
3106 /*
3107 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3108 **
3109 ** This action provides a run-time test to see whether or not
3110 ** assert() was enabled at compile-time. If X is true and assert()
3111 ** is enabled, then the return value is true. If X is true and
3112 ** assert() is disabled, then the return value is zero. If X is
3113 ** false and assert() is enabled, then the assertion fires and the
3114 ** process aborts. If X is false and assert() is disabled, then the
3115 ** return value is zero.
3116 */
3117 case SQLITE_TESTCTRL_ASSERT: {
3118 volatile int x = 0;
3119 assert( (x = va_arg(ap,int))!=0 );
3120 rc = x;
3121 break;
3122 }
3123
3124
3125 /*
3126 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3127 **
3128 ** This action provides a run-time test to see how the ALWAYS and
3129 ** NEVER macros were defined at compile-time.
3130 **
3131 ** The return value is ALWAYS(X).
3132 **
3133 ** The recommended test is X==2. If the return value is 2, that means
3134 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3135 ** default setting. If the return value is 1, then ALWAYS() is either
3136 ** hard-coded to true or else it asserts if its argument is false.
3137 ** The first behavior (hard-coded to true) is the case if
3138 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3139 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3140 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3141 **
3142 ** The run-time test procedure might look something like this:
3143 **
3144 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3145 ** // ALWAYS() and NEVER() are no-op pass-through macros
3146 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3147 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3148 ** }else{
3149 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3150 ** }
3151 */
3152 case SQLITE_TESTCTRL_ALWAYS: {
3153 int x = va_arg(ap,int);
3154 rc = ALWAYS(x);
3155 break;
3156 }
drhc046e3e2009-07-15 11:26:44 +00003157
3158 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3159 **
3160 ** Set the nReserve size to N for the main database on the database
3161 ** connection db.
3162 */
3163 case SQLITE_TESTCTRL_RESERVE: {
3164 sqlite3 *db = va_arg(ap, sqlite3*);
3165 int x = va_arg(ap,int);
3166 sqlite3_mutex_enter(db->mutex);
3167 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3168 sqlite3_mutex_leave(db->mutex);
3169 break;
3170 }
3171
drh07096f62009-12-22 23:52:32 +00003172 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3173 **
3174 ** Enable or disable various optimizations for testing purposes. The
3175 ** argument N is a bitmask of optimizations to be disabled. For normal
3176 ** operation N should be 0. The idea is that a test program (like the
3177 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3178 ** with various optimizations disabled to verify that the same answer
3179 ** is obtained in every case.
3180 */
3181 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3182 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003183 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003184 break;
3185 }
3186
drh0e857732010-01-02 03:21:35 +00003187#ifdef SQLITE_N_KEYWORD
3188 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3189 **
3190 ** If zWord is a keyword recognized by the parser, then return the
3191 ** number of keywords. Or if zWord is not a keyword, return 0.
3192 **
3193 ** This test feature is only available in the amalgamation since
3194 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3195 ** is built using separate source files.
3196 */
3197 case SQLITE_TESTCTRL_ISKEYWORD: {
3198 const char *zWord = va_arg(ap, const char*);
3199 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003200 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003201 break;
3202 }
3203#endif
3204
drhbadc9802010-08-27 17:16:44 +00003205 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3206 **
3207 ** Pass pFree into sqlite3ScratchFree().
3208 ** If sz>0 then allocate a scratch buffer into pNew.
3209 */
3210 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3211 void *pFree, **ppNew;
3212 int sz;
3213 sz = va_arg(ap, int);
3214 ppNew = va_arg(ap, void**);
3215 pFree = va_arg(ap, void*);
3216 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3217 sqlite3ScratchFree(pFree);
3218 break;
3219 }
3220
danc17d6962011-06-21 12:47:30 +00003221 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3222 **
3223 ** If parameter onoff is non-zero, configure the wrappers so that all
3224 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3225 ** undo this setting.
3226 */
3227 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3228 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3229 break;
3230 }
3231
drh678a9aa2011-12-10 15:55:01 +00003232#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh7e02e5e2011-12-06 19:44:51 +00003233 /* sqlite3_test_control(SQLITE_TESTCTRL_EXPLAIN_STMT,
3234 ** sqlite3_stmt*,const char**);
3235 **
drh678a9aa2011-12-10 15:55:01 +00003236 ** If compiled with SQLITE_ENABLE_TREE_EXPLAIN, each sqlite3_stmt holds
3237 ** a string that describes the optimized parse tree. This test-control
3238 ** returns a pointer to that string.
drh7e02e5e2011-12-06 19:44:51 +00003239 */
3240 case SQLITE_TESTCTRL_EXPLAIN_STMT: {
3241 sqlite3_stmt *pStmt = va_arg(ap, sqlite3_stmt*);
3242 const char **pzRet = va_arg(ap, const char**);
3243 *pzRet = sqlite3VdbeExplanation((Vdbe*)pStmt);
3244 break;
3245 }
drh678a9aa2011-12-10 15:55:01 +00003246#endif
drh7e02e5e2011-12-06 19:44:51 +00003247
drhed13d982008-01-31 14:43:24 +00003248 }
3249 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003250#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003251 return rc;
drhed13d982008-01-31 14:43:24 +00003252}
drhcc487d12011-05-17 18:53:08 +00003253
3254/*
3255** This is a utility routine, useful to VFS implementations, that checks
3256** to see if a database file was a URI that contained a specific query
3257** parameter, and if so obtains the value of the query parameter.
3258**
3259** The zFilename argument is the filename pointer passed into the xOpen()
3260** method of a VFS implementation. The zParam argument is the name of the
3261** query parameter we seek. This routine returns the value of the zParam
3262** parameter if it exists. If the parameter does not exist, this routine
3263** returns a NULL pointer.
3264*/
3265const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh92913722011-12-23 00:07:33 +00003266 if( zFilename==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003267 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003268 while( zFilename[0] ){
3269 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003270 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003271 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003272 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003273 }
3274 return 0;
3275}
drh283829c2011-11-17 00:56:20 +00003276
3277/*
drh92913722011-12-23 00:07:33 +00003278** Return a boolean value for a query parameter.
3279*/
3280int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3281 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003282 bDflt = bDflt!=0;
3283 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003284}
3285
3286/*
3287** Return a 64-bit integer value for a query parameter.
3288*/
3289sqlite3_int64 sqlite3_uri_int64(
3290 const char *zFilename, /* Filename as passed to xOpen */
3291 const char *zParam, /* URI parameter sought */
3292 sqlite3_int64 bDflt /* return if parameter is missing */
3293){
3294 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3295 sqlite3_int64 v;
3296 if( z && sqlite3Atoi64(z, &v, sqlite3Strlen30(z), SQLITE_UTF8)==SQLITE_OK ){
3297 bDflt = v;
3298 }
3299 return bDflt;
3300}
3301
3302/*
drh421377e2012-03-15 21:28:54 +00003303** Return the Btree pointer identified by zDbName. Return NULL if not found.
3304*/
3305Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3306 int i;
3307 for(i=0; i<db->nDb; i++){
3308 if( db->aDb[i].pBt
3309 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3310 ){
3311 return db->aDb[i].pBt;
3312 }
3313 }
3314 return 0;
3315}
3316
3317/*
drh283829c2011-11-17 00:56:20 +00003318** Return the filename of the database associated with a database
3319** connection.
3320*/
3321const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh421377e2012-03-15 21:28:54 +00003322 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3323 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3324}
3325
3326/*
3327** Return 1 if database is read-only or 0 if read/write. Return -1 if
3328** no such database exists.
3329*/
3330int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
3331 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3332 return pBt ? sqlite3PagerIsreadonly(sqlite3BtreePager(pBt)) : -1;
drh283829c2011-11-17 00:56:20 +00003333}