blob: 7ecb4f2617613717e6f44fb4a3c57347da6eb300 [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
drh93ed56d2008-08-12 15:21:11 +0000135 /* Make sure the mutex subsystem is initialized. If unable to
136 ** initialize the mutex subsystem, return early with the error.
137 ** If the system is so sick that we are unable to allocate a mutex,
138 ** there is not much SQLite is going to be able to do.
139 **
140 ** The mutex subsystem must take care of serializing its own
141 ** initialization.
142 */
danielk1977d0251742008-06-18 18:57:42 +0000143 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000144 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000145
drh93ed56d2008-08-12 15:21:11 +0000146 /* Initialize the malloc() system and the recursive pInitMutex mutex.
147 ** This operation is protected by the STATIC_MASTER mutex. Note that
148 ** MutexAlloc() is called for a static mutex prior to initializing the
149 ** malloc subsystem - this implies that the allocation of a static
150 ** mutex must not require support from the malloc subsystem.
151 */
drh30ddce62011-10-15 00:16:30 +0000152 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000153 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000154 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000155 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000156 rc = sqlite3MallocInit();
157 }
drh40257ff2008-06-13 18:24:27 +0000158 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000159 sqlite3GlobalConfig.isMallocInit = 1;
160 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000161 sqlite3GlobalConfig.pInitMutex =
162 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000163 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000164 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000165 }
166 }
danielk197777eb5bb2008-09-22 17:22:19 +0000167 }
168 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000169 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000170 }
171 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000172
dane1ab2192009-08-17 15:16:19 +0000173 /* If rc is not SQLITE_OK at this point, then either the malloc
174 ** subsystem could not be initialized or the system failed to allocate
175 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000176 if( rc!=SQLITE_OK ){
177 return rc;
178 }
179
180 /* Do the rest of the initialization under the recursive mutex so
181 ** that we will be able to handle recursive calls into
182 ** sqlite3_initialize(). The recursive calls normally come through
183 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
184 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000185 **
186 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
187 ** to the xInit method, so the xInit method need not be threadsafe.
188 **
189 ** The following mutex is what serializes access to the appdef pcache xInit
190 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
191 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000192 */
danielk1977075c23a2008-09-01 18:34:20 +0000193 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000194 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000195 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000196 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000197 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000198 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000199 if( sqlite3GlobalConfig.isPCacheInit==0 ){
200 rc = sqlite3PcacheInitialize();
201 }
danielk19778c0a7912008-08-20 14:49:23 +0000202 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000203 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000204 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000205 }
206 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000207 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
208 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000209 sqlite3GlobalConfig.isInit = 1;
danielk19778c0a7912008-08-20 14:49:23 +0000210 }
danielk1977502b4e02008-09-02 14:07:24 +0000211 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000212 }
danielk1977075c23a2008-09-01 18:34:20 +0000213 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000214
drh93ed56d2008-08-12 15:21:11 +0000215 /* Go back under the static mutex and clean up the recursive
216 ** mutex to prevent a resource leak.
217 */
218 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000219 sqlite3GlobalConfig.nRefInitMutex--;
220 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
221 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
222 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
223 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000224 }
225 sqlite3_mutex_leave(pMaster);
226
227 /* The following is just a sanity check to make sure SQLite has
228 ** been compiled correctly. It is important to run this code, but
229 ** we don't want to run it too often and soak up CPU cycles for no
230 ** reason. So we run it once during initialization.
231 */
shanedfb7b372008-07-22 05:13:30 +0000232#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000233#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000234 /* This section of code's only "output" is via assert() statements. */
235 if ( rc==SQLITE_OK ){
236 u64 x = (((u64)1)<<63)-1;
237 double y;
238 assert(sizeof(x)==8);
239 assert(sizeof(x)==sizeof(y));
240 memcpy(&y, &x, 8);
241 assert( sqlite3IsNaN(y) );
242 }
243#endif
shanefbd60f82009-02-04 03:59:25 +0000244#endif
shanedfb7b372008-07-22 05:13:30 +0000245
drhe4cf0b32011-08-25 00:14:41 +0000246 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
247 ** compile-time option.
248 */
249#ifdef SQLITE_EXTRA_INIT
250 if( rc==SQLITE_OK && sqlite3GlobalConfig.isInit ){
drhc7f94622011-12-13 18:22:38 +0000251 int SQLITE_EXTRA_INIT(const char*);
252 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000253 }
254#endif
255
drh40257ff2008-06-13 18:24:27 +0000256 return rc;
257}
258
259/*
260** Undo the effects of sqlite3_initialize(). Must not be called while
261** there are outstanding database connections or memory allocations or
262** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000263** routine is not threadsafe. But it is safe to invoke this routine
264** on when SQLite is already shut down. If SQLite is already shut down
265** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000266*/
267int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000268 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000269#ifdef SQLITE_EXTRA_SHUTDOWN
270 void SQLITE_EXTRA_SHUTDOWN(void);
271 SQLITE_EXTRA_SHUTDOWN();
272#endif
drha7640922009-04-21 12:02:56 +0000273 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000274 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000275 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000276 }
dane1ab2192009-08-17 15:16:19 +0000277 if( sqlite3GlobalConfig.isPCacheInit ){
278 sqlite3PcacheShutdown();
279 sqlite3GlobalConfig.isPCacheInit = 0;
280 }
281 if( sqlite3GlobalConfig.isMallocInit ){
282 sqlite3MallocEnd();
283 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000284
285#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
286 /* The heap subsystem has now been shutdown and these values are supposed
287 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
288 ** which would rely on that heap subsystem; therefore, make sure these
289 ** values cannot refer to heap memory that was just invalidated when the
290 ** heap subsystem was shutdown. This is only done if the current call to
291 ** this function resulted in the heap subsystem actually being shutdown.
292 */
293 sqlite3_data_directory = 0;
294 sqlite3_temp_directory = 0;
295#endif
dane1ab2192009-08-17 15:16:19 +0000296 }
297 if( sqlite3GlobalConfig.isMutexInit ){
298 sqlite3MutexEnd();
299 sqlite3GlobalConfig.isMutexInit = 0;
300 }
301
drh40257ff2008-06-13 18:24:27 +0000302 return SQLITE_OK;
303}
304
305/*
306** This API allows applications to modify the global configuration of
307** the SQLite library at run-time.
308**
309** This routine should only be called when there are no outstanding
310** database connections or memory allocations. This routine is not
311** threadsafe. Failure to heed these warnings can lead to unpredictable
312** behavior.
313*/
314int sqlite3_config(int op, ...){
315 va_list ap;
316 int rc = SQLITE_OK;
317
318 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
319 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000320 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000321
322 va_start(ap, op);
323 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000324
325 /* Mutex configuration options are only available in a threadsafe
326 ** compile.
327 */
drhd68eee02009-12-11 03:44:18 +0000328#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000329 case SQLITE_CONFIG_SINGLETHREAD: {
330 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000331 sqlite3GlobalConfig.bCoreMutex = 0;
332 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000333 break;
334 }
335 case SQLITE_CONFIG_MULTITHREAD: {
336 /* Disable mutexing of database connections */
337 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000338 sqlite3GlobalConfig.bCoreMutex = 1;
339 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000340 break;
341 }
342 case SQLITE_CONFIG_SERIALIZED: {
343 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000344 sqlite3GlobalConfig.bCoreMutex = 1;
345 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000346 break;
347 }
drh18472fa2008-10-07 15:25:48 +0000348 case SQLITE_CONFIG_MUTEX: {
349 /* Specify an alternative mutex implementation */
350 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
351 break;
352 }
353 case SQLITE_CONFIG_GETMUTEX: {
354 /* Retrieve the current mutex implementation */
355 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
356 break;
357 }
358#endif
359
360
drh40257ff2008-06-13 18:24:27 +0000361 case SQLITE_CONFIG_MALLOC: {
362 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000363 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000364 break;
365 }
drh33589792008-06-18 13:27:46 +0000366 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000367 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000368 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
369 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000370 break;
371 }
drhfec00ea2008-06-14 16:56:21 +0000372 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000373 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000374 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000375 break;
376 }
drh33589792008-06-18 13:27:46 +0000377 case SQLITE_CONFIG_SCRATCH: {
378 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000379 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
380 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
381 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000382 break;
383 }
384 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000385 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000386 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
387 sqlite3GlobalConfig.szPage = va_arg(ap, int);
388 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000389 break;
390 }
danielk19775099be52008-06-27 13:27:03 +0000391
danielk1977bc2ca9e2008-11-13 14:28:28 +0000392 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000393 /* no-op */
394 break;
395 }
396 case SQLITE_CONFIG_GETPCACHE: {
397 /* now an error */
398 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000399 break;
400 }
401
dan22e21ff2011-11-08 20:08:44 +0000402 case SQLITE_CONFIG_PCACHE2: {
403 /* Specify an alternative page cache implementation */
404 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
405 break;
406 }
407 case SQLITE_CONFIG_GETPCACHE2: {
408 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000409 sqlite3PCacheSetDefault();
410 }
dan22e21ff2011-11-08 20:08:44 +0000411 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000412 break;
413 }
414
drh5d414832008-07-15 14:47:18 +0000415#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000416 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000417 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000418 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
419 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
420 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000421
shaneha6ec8922011-03-09 21:36:17 +0000422 if( sqlite3GlobalConfig.mnReq<1 ){
423 sqlite3GlobalConfig.mnReq = 1;
424 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
425 /* cap min request size at 2^12 */
426 sqlite3GlobalConfig.mnReq = (1<<12);
427 }
428
danielk1977075c23a2008-09-01 18:34:20 +0000429 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000430 /* If the heap pointer is NULL, then restore the malloc implementation
431 ** back to NULL pointers too. This will cause the malloc to go
432 ** back to its default implementation when sqlite3_initialize() is
433 ** run.
434 */
danielk1977075c23a2008-09-01 18:34:20 +0000435 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000436 }else{
437 /* The heap pointer is not NULL, then install one of the
438 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
439 ** ENABLE_MEMSYS5 is defined, return an error.
drh8a42cbd2008-07-10 18:13:42 +0000440 */
danielk19775099be52008-06-27 13:27:03 +0000441#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000442 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000443#endif
444#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000445 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000446#endif
drh8a42cbd2008-07-10 18:13:42 +0000447 }
danielk19775099be52008-06-27 13:27:03 +0000448 break;
449 }
drh5d414832008-07-15 14:47:18 +0000450#endif
danielk19775099be52008-06-27 13:27:03 +0000451
drh633e6d52008-07-28 19:34:53 +0000452 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000453 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
454 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000455 break;
456 }
drh3f280702010-02-18 18:45:09 +0000457
458 /* Record a pointer to the logger funcction and its first argument.
459 ** The default is NULL. Logging is disabled if the function pointer is
460 ** NULL.
461 */
462 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000463 /* MSVC is picky about pulling func ptrs from va lists.
464 ** http://support.microsoft.com/kb/47961
465 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
466 */
467 typedef void(*LOGFUNC_t)(void*,int,const char*);
468 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000469 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
470 break;
471 }
drh633e6d52008-07-28 19:34:53 +0000472
dancd74b612011-04-22 19:37:32 +0000473 case SQLITE_CONFIG_URI: {
474 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
475 break;
476 }
477
drh40257ff2008-06-13 18:24:27 +0000478 default: {
479 rc = SQLITE_ERROR;
480 break;
481 }
482 }
483 va_end(ap);
484 return rc;
485}
486
487/*
drh633e6d52008-07-28 19:34:53 +0000488** Set up the lookaside buffers for a database connection.
489** Return SQLITE_OK on success.
490** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000491**
492** The sz parameter is the number of bytes in each lookaside slot.
493** The cnt parameter is the number of slots. If pStart is NULL the
494** space for the lookaside memory is obtained from sqlite3_malloc().
495** If pStart is not NULL then it is sz*cnt bytes of memory to use for
496** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000497*/
drhe9d1c722008-08-04 20:13:26 +0000498static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000499 void *pStart;
500 if( db->lookaside.nOut ){
501 return SQLITE_BUSY;
502 }
shanef71f89e2009-01-30 06:11:54 +0000503 /* Free any existing lookaside buffer for this handle before
504 ** allocating a new one so we don't have to have space for
505 ** both at the same time.
506 */
507 if( db->lookaside.bMalloced ){
508 sqlite3_free(db->lookaside.pStart);
509 }
drh61a4bd52011-11-10 02:39:28 +0000510 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
511 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000512 */
drh61a4bd52011-11-10 02:39:28 +0000513 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000514 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000515 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000516 if( sz==0 || cnt==0 ){
517 sz = 0;
518 pStart = 0;
519 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000520 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000521 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000522 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000523 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000524 }else{
525 pStart = pBuf;
526 }
drh4cfb22f2008-08-01 18:47:01 +0000527 db->lookaside.pStart = pStart;
528 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000529 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000530 if( pStart ){
531 int i;
532 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000533 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000534 p = (LookasideSlot*)pStart;
535 for(i=cnt-1; i>=0; i--){
536 p->pNext = db->lookaside.pFree;
537 db->lookaside.pFree = p;
538 p = (LookasideSlot*)&((u8*)p)[sz];
539 }
540 db->lookaside.pEnd = p;
541 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000542 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000543 }else{
544 db->lookaside.pEnd = 0;
545 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000546 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000547 }
548 return SQLITE_OK;
549}
550
551/*
drh4413d0e2008-11-04 13:46:27 +0000552** Return the mutex associated with a database connection.
553*/
554sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
555 return db->mutex;
556}
557
558/*
drh09419b42011-11-16 19:29:17 +0000559** Free up as much memory as we can from the given database
560** connection.
561*/
562int sqlite3_db_release_memory(sqlite3 *db){
563 int i;
dand9bb3a92011-12-30 11:43:59 +0000564 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000565 sqlite3BtreeEnterAll(db);
566 for(i=0; i<db->nDb; i++){
567 Btree *pBt = db->aDb[i].pBt;
568 if( pBt ){
569 Pager *pPager = sqlite3BtreePager(pBt);
570 sqlite3PagerShrink(pPager);
571 }
572 }
573 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000574 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000575 return SQLITE_OK;
576}
577
578/*
drh633e6d52008-07-28 19:34:53 +0000579** Configuration settings for an individual database connection
580*/
581int sqlite3_db_config(sqlite3 *db, int op, ...){
582 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000583 int rc;
drh633e6d52008-07-28 19:34:53 +0000584 va_start(ap, op);
585 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000586 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000587 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000588 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
589 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000590 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000591 break;
592 }
drh6480aad2008-08-01 16:31:14 +0000593 default: {
drhe83cafd2011-03-21 17:15:58 +0000594 static const struct {
595 int op; /* The opcode */
596 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
597 } aFlagOp[] = {
598 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
599 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
600 };
drh58ad5802011-03-23 22:02:23 +0000601 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000602 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000603 for(i=0; i<ArraySize(aFlagOp); i++){
604 if( aFlagOp[i].op==op ){
605 int onoff = va_arg(ap, int);
606 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000607 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000608 if( onoff>0 ){
609 db->flags |= aFlagOp[i].mask;
610 }else if( onoff==0 ){
611 db->flags &= ~aFlagOp[i].mask;
612 }
613 if( oldFlags!=db->flags ){
614 sqlite3ExpirePreparedStatements(db);
615 }
616 if( pRes ){
617 *pRes = (db->flags & aFlagOp[i].mask)!=0;
618 }
619 rc = SQLITE_OK;
620 break;
621 }
622 }
drh6480aad2008-08-01 16:31:14 +0000623 break;
624 }
drh633e6d52008-07-28 19:34:53 +0000625 }
626 va_end(ap);
627 return rc;
628}
629
drha16313e2007-03-30 11:29:32 +0000630
631/*
drh9b5adfa2008-01-20 23:19:56 +0000632** Return true if the buffer z[0..n-1] contains all spaces.
633*/
634static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000635 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000636 return n==0;
637}
638
639/*
drhd3d39e92004-05-20 22:16:29 +0000640** This is the default collating function named "BINARY" which is always
641** available.
drh9b5adfa2008-01-20 23:19:56 +0000642**
643** If the padFlag argument is not NULL then space padding at the end
644** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000645*/
danielk19772c336542005-01-13 02:14:23 +0000646static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000647 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000648 int nKey1, const void *pKey1,
649 int nKey2, const void *pKey2
650){
651 int rc, n;
652 n = nKey1<nKey2 ? nKey1 : nKey2;
653 rc = memcmp(pKey1, pKey2, n);
654 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000655 if( padFlag
656 && allSpaces(((char*)pKey1)+n, nKey1-n)
657 && allSpaces(((char*)pKey2)+n, nKey2-n)
658 ){
659 /* Leave rc unchanged at 0 */
660 }else{
661 rc = nKey1 - nKey2;
662 }
drhd3d39e92004-05-20 22:16:29 +0000663 }
664 return rc;
665}
666
667/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000668** Another built-in collating sequence: NOCASE.
669**
670** This collating sequence is intended to be used for "case independant
671** comparison". SQLite's knowledge of upper and lower case equivalents
672** extends only to the 26 characters used in the English language.
673**
674** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000675*/
676static int nocaseCollatingFunc(
677 void *NotUsed,
678 int nKey1, const void *pKey1,
679 int nKey2, const void *pKey2
680){
681 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000682 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000683 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000684 if( 0==r ){
685 r = nKey1-nKey2;
686 }
687 return r;
688}
689
690/*
drhaf9ff332002-01-16 21:00:27 +0000691** Return the ROWID of the most recent insert
692*/
drh9bb575f2004-09-06 17:24:11 +0000693sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000694 return db->lastRowid;
695}
696
697/*
danielk197724b03fd2004-05-10 10:34:34 +0000698** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000699*/
drh9bb575f2004-09-06 17:24:11 +0000700int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000701 return db->nChange;
702}
703
rdcf146a772004-02-25 22:51:06 +0000704/*
danielk1977b28af712004-06-21 06:50:26 +0000705** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000706*/
danielk1977b28af712004-06-21 06:50:26 +0000707int sqlite3_total_changes(sqlite3 *db){
708 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000709}
710
drhc8d30ac2002-04-12 10:08:59 +0000711/*
danielk1977fd7f0452008-12-17 17:30:26 +0000712** Close all open savepoints. This function only manipulates fields of the
713** database handle object, it does not close any savepoints that may be open
714** at the b-tree/pager level.
715*/
716void sqlite3CloseSavepoints(sqlite3 *db){
717 while( db->pSavepoint ){
718 Savepoint *pTmp = db->pSavepoint;
719 db->pSavepoint = pTmp->pNext;
720 sqlite3DbFree(db, pTmp);
721 }
722 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000723 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000724 db->isTransactionSavepoint = 0;
725}
726
727/*
dand2199f02010-08-27 17:48:52 +0000728** Invoke the destructor function associated with FuncDef p, if any. Except,
729** if this is not the last copy of the function, do not invoke it. Multiple
730** copies of a single function are created when create_function() is called
731** with SQLITE_ANY as the encoding.
732*/
733static void functionDestroy(sqlite3 *db, FuncDef *p){
734 FuncDestructor *pDestructor = p->pDestructor;
735 if( pDestructor ){
736 pDestructor->nRef--;
737 if( pDestructor->nRef==0 ){
738 pDestructor->xDestroy(pDestructor->pUserData);
739 sqlite3DbFree(db, pDestructor);
740 }
741 }
742}
743
744/*
danbba02a92012-05-15 17:15:34 +0000745** Disconnect all sqlite3_vtab objects that belong to database connection
746** db. This is called when db is being closed.
747*/
748static void disconnectAllVtab(sqlite3 *db){
749#ifndef SQLITE_OMIT_VIRTUALTABLE
750 int i;
751 sqlite3BtreeEnterAll(db);
752 for(i=0; i<db->nDb; i++){
753 Schema *pSchema = db->aDb[i].pSchema;
754 if( db->aDb[i].pSchema ){
755 HashElem *p;
756 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
757 Table *pTab = (Table *)sqliteHashData(p);
758 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
759 }
760 }
761 }
762 sqlite3BtreeLeaveAll(db);
763#else
764 UNUSED_PARAMETER(db);
765#endif
766}
767
768/*
drh50e5dad2001-09-15 00:57:28 +0000769** Close an existing SQLite database
770*/
drh9bb575f2004-09-06 17:24:11 +0000771int sqlite3_close(sqlite3 *db){
dand2199f02010-08-27 17:48:52 +0000772 HashElem *i; /* Hash table iterator */
drh001bbcb2003-03-19 03:14:00 +0000773 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000774
775 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000776 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000777 }
drh7e8b8482008-01-23 03:03:05 +0000778 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000779 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000780 }
drh605264d2007-08-21 15:13:19 +0000781 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000782
danbba02a92012-05-15 17:15:34 +0000783 /* Force xDisconnect calls on all virtual tables */
784 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000785
danbba02a92012-05-15 17:15:34 +0000786 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000787 ** will not have called the xDisconnect() method on any virtual
788 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
789 ** call will do so. We need to do this before the check for active
790 ** SQL statements below, as the v-table implementation may be storing
791 ** some prepared statements internally.
792 */
793 sqlite3VtabRollback(db);
794
danielk1977a04a34f2007-04-16 15:06:25 +0000795 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +0000796 if( db->pVdbe ){
797 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +0000798 "unable to close due to unfinalised statements");
drh27641702007-08-22 02:56:42 +0000799 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000800 return SQLITE_BUSY;
801 }
drh7e8b8482008-01-23 03:03:05 +0000802 assert( sqlite3SafetyCheckSickOrOk(db) );
danielk1977e0048402004-06-15 16:51:01 +0000803
danielk197704103022009-02-03 16:51:24 +0000804 for(j=0; j<db->nDb; j++){
805 Btree *pBt = db->aDb[j].pBt;
806 if( pBt && sqlite3BtreeIsInBackup(pBt) ){
807 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +0000808 "unable to close due to unfinished backup operation");
danielk197704103022009-02-03 16:51:24 +0000809 sqlite3_mutex_leave(db->mutex);
810 return SQLITE_BUSY;
811 }
812 }
813
danielk1977fd7f0452008-12-17 17:30:26 +0000814 /* Free any outstanding Savepoint structures. */
815 sqlite3CloseSavepoints(db);
816
drh5efb3142012-05-16 01:24:34 +0000817 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000818 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000819 struct Db *pDb = &db->aDb[j];
820 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000821 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000822 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000823 if( j!=1 ){
824 pDb->pSchema = 0;
825 }
drh113088e2003-03-20 01:16:58 +0000826 }
drhf57b3392001-10-08 13:22:32 +0000827 }
drh5efb3142012-05-16 01:24:34 +0000828 /* Clear the TEMP schema separately and last */
829 if( db->aDb[1].pSchema ){
830 sqlite3SchemaClear(db->aDb[1].pSchema);
831 }
832 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000833
drh5efb3142012-05-16 01:24:34 +0000834 /* Free up the array of auxiliary databases */
835 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000836 assert( db->nDb<=2 );
837 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000838
839 /* Tell the code in notify.c that the connection no longer holds any
840 ** locks and does not require any further unlock-notify callbacks.
841 */
842 sqlite3ConnectionClosed(db);
843
drh70a8ca32008-08-21 18:49:27 +0000844 for(j=0; j<ArraySize(db->aFunc.a); j++){
845 FuncDef *pNext, *pHash, *p;
846 for(p=db->aFunc.a[j]; p; p=pHash){
847 pHash = p->pHash;
848 while( p ){
dand2199f02010-08-27 17:48:52 +0000849 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000850 pNext = p->pNext;
851 sqlite3DbFree(db, p);
852 p = pNext;
853 }
drh8e0a2f92002-02-23 23:45:45 +0000854 }
855 }
danielk1977d8123362004-06-12 09:25:12 +0000856 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000857 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000858 /* Invoke any destructors registered for collation sequence user data. */
859 for(j=0; j<3; j++){
860 if( pColl[j].xDel ){
861 pColl[j].xDel(pColl[j].pUser);
862 }
863 }
drh633e6d52008-07-28 19:34:53 +0000864 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000865 }
danielk1977d8123362004-06-12 09:25:12 +0000866 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000867#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000868 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
869 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000870 if( pMod->xDestroy ){
871 pMod->xDestroy(pMod->pAux);
872 }
drh633e6d52008-07-28 19:34:53 +0000873 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000874 }
drhb9bb7c12006-06-11 23:41:55 +0000875 sqlite3HashClear(&db->aModule);
876#endif
danielk1977466be562004-06-10 02:16:01 +0000877
danielk19776622cce2004-05-20 11:00:52 +0000878 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000879 if( db->pErr ){
880 sqlite3ValueFree(db->pErr);
881 }
drhf1952c52006-06-08 15:48:00 +0000882 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000883
884 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000885
886 /* The temp-database schema is allocated differently from the other schema
887 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
888 ** So it needs to be freed here. Todo: Why not roll the temp schema into
889 ** the same sqliteMalloc() as the one that allocates the database
890 ** structure?
891 */
drh633e6d52008-07-28 19:34:53 +0000892 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000893 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000894 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000895 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +0000896 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +0000897 if( db->lookaside.bMalloced ){
898 sqlite3_free(db->lookaside.pStart);
899 }
drh17435752007-08-16 04:30:38 +0000900 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000901 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000902}
903
904/*
drh0f198a72012-02-13 16:43:16 +0000905** Rollback all database files. If tripCode is not SQLITE_OK, then
906** any open cursors are invalidated ("tripped" - as in "tripping a circuit
907** breaker") and made to return tripCode if there are any further
908** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +0000909*/
drh0f198a72012-02-13 16:43:16 +0000910void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +0000911 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000912 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000913 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +0000914 sqlite3BeginBenignMalloc();
drh001bbcb2003-03-19 03:14:00 +0000915 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +0000916 Btree *p = db->aDb[i].pBt;
917 if( p ){
918 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000919 inTrans = 1;
920 }
drh0f198a72012-02-13 16:43:16 +0000921 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +0000922 db->aDb[i].inTrans = 0;
923 }
924 }
danielk1977a298e902006-06-22 09:53:48 +0000925 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +0000926 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000927
danielk197771fd80b2005-12-16 06:54:01 +0000928 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000929 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +0000930 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +0000931 }
932
dan1da40a32009-09-19 17:00:31 +0000933 /* Any deferred constraint violations have now been resolved. */
934 db->nDeferredCons = 0;
935
danielk197771fd80b2005-12-16 06:54:01 +0000936 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000937 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000938 db->xRollbackCallback(db->pRollbackArg);
939 }
drh001bbcb2003-03-19 03:14:00 +0000940}
941
942/*
drhc22bd472002-05-10 13:14:07 +0000943** Return a static string that describes the kind of error specified in the
944** argument.
drh247be432002-05-10 05:44:55 +0000945*/
danielk1977f20b21c2004-05-31 23:56:42 +0000946const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +0000947 static const char* const aMsg[] = {
948 /* SQLITE_OK */ "not an error",
949 /* SQLITE_ERROR */ "SQL logic error or missing database",
950 /* SQLITE_INTERNAL */ 0,
951 /* SQLITE_PERM */ "access permission denied",
952 /* SQLITE_ABORT */ "callback requested query abort",
953 /* SQLITE_BUSY */ "database is locked",
954 /* SQLITE_LOCKED */ "database table is locked",
955 /* SQLITE_NOMEM */ "out of memory",
956 /* SQLITE_READONLY */ "attempt to write a readonly database",
957 /* SQLITE_INTERRUPT */ "interrupted",
958 /* SQLITE_IOERR */ "disk I/O error",
959 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +0000960 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +0000961 /* SQLITE_FULL */ "database or disk is full",
962 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +0000963 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +0000964 /* SQLITE_EMPTY */ "table contains no data",
965 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +0000966 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +0000967 /* SQLITE_CONSTRAINT */ "constraint failed",
968 /* SQLITE_MISMATCH */ "datatype mismatch",
969 /* SQLITE_MISUSE */ "library routine called out of sequence",
970 /* SQLITE_NOLFS */ "large file support is disabled",
971 /* SQLITE_AUTH */ "authorization denied",
972 /* SQLITE_FORMAT */ "auxiliary database format error",
973 /* SQLITE_RANGE */ "bind or column index out of range",
974 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
975 };
drh21021a52012-02-13 17:01:51 +0000976 const char *zErr = "unknown error";
977 switch( rc ){
978 case SQLITE_ABORT_ROLLBACK: {
979 zErr = "abort due to ROLLBACK";
980 break;
981 }
982 default: {
983 rc &= 0xff;
984 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
985 zErr = aMsg[rc];
986 }
987 break;
988 }
drh247be432002-05-10 05:44:55 +0000989 }
drh21021a52012-02-13 17:01:51 +0000990 return zErr;
drh247be432002-05-10 05:44:55 +0000991}
992
993/*
drh2dfbbca2000-07-28 14:32:48 +0000994** This routine implements a busy callback that sleeps and tries
995** again until a timeout value is reached. The timeout value is
996** an integer number of milliseconds passed in as the first
997** argument.
998*/
drhdaffd0e2001-04-11 14:28:42 +0000999static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001000 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001001 int count /* Number of times table has been busy */
1002){
danielk197729bafea2008-06-26 10:41:19 +00001003#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001004 static const u8 delays[] =
1005 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1006 static const u8 totals[] =
1007 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001008# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001009 sqlite3 *db = (sqlite3 *)ptr;
1010 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001011 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001012
drhee570fa2005-04-28 12:06:05 +00001013 assert( count>=0 );
1014 if( count < NDELAY ){
1015 delay = delays[count];
1016 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001017 }else{
1018 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001019 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001020 }
drhd1bec472004-01-15 13:29:31 +00001021 if( prior + delay > timeout ){
1022 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001023 if( delay<=0 ) return 0;
1024 }
danielk19772a6bdf62007-08-20 16:07:00 +00001025 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001026 return 1;
1027#else
drh482ea182007-08-20 11:12:40 +00001028 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001029 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001030 if( (count+1)*1000 > timeout ){
1031 return 0;
1032 }
drh482ea182007-08-20 11:12:40 +00001033 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001034 return 1;
1035#endif
1036}
1037
1038/*
drha4afb652005-07-09 02:16:02 +00001039** Invoke the given busy handler.
1040**
1041** This routine is called when an operation failed with a lock.
1042** If this routine returns non-zero, the lock is retried. If it
1043** returns 0, the operation aborts with an SQLITE_BUSY error.
1044*/
1045int sqlite3InvokeBusyHandler(BusyHandler *p){
1046 int rc;
drh34004ce2008-07-11 16:15:17 +00001047 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001048 rc = p->xFunc(p->pArg, p->nBusy);
1049 if( rc==0 ){
1050 p->nBusy = -1;
1051 }else{
1052 p->nBusy++;
1053 }
1054 return rc;
1055}
1056
1057/*
drh2dfbbca2000-07-28 14:32:48 +00001058** This routine sets the busy callback for an Sqlite database to the
1059** given callback function with the given argument.
1060*/
danielk1977f9d64d22004-06-19 08:18:07 +00001061int sqlite3_busy_handler(
1062 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001063 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001064 void *pArg
1065){
drhe30f4422007-08-21 16:15:55 +00001066 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001067 db->busyHandler.xFunc = xBusy;
1068 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001069 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +00001070 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001071 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001072}
1073
danielk1977348bb5d2003-10-18 09:37:26 +00001074#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1075/*
1076** This routine sets the progress callback for an Sqlite database to the
1077** given callback function with the given argument. The progress callback will
1078** be invoked every nOps opcodes.
1079*/
danielk197724b03fd2004-05-10 10:34:34 +00001080void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001081 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001082 int nOps,
1083 int (*xProgress)(void*),
1084 void *pArg
1085){
drhbd0b1b52008-07-07 19:52:09 +00001086 sqlite3_mutex_enter(db->mutex);
1087 if( nOps>0 ){
1088 db->xProgress = xProgress;
1089 db->nProgressOps = nOps;
1090 db->pProgressArg = pArg;
1091 }else{
1092 db->xProgress = 0;
1093 db->nProgressOps = 0;
1094 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001095 }
drhbd0b1b52008-07-07 19:52:09 +00001096 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001097}
1098#endif
1099
1100
drh2dfbbca2000-07-28 14:32:48 +00001101/*
1102** This routine installs a default busy handler that waits for the
1103** specified number of milliseconds before returning 0.
1104*/
danielk1977f9d64d22004-06-19 08:18:07 +00001105int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +00001106 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001107 db->busyTimeout = ms;
1108 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +00001109 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001110 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001111 }
danielk1977f9d64d22004-06-19 08:18:07 +00001112 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001113}
drh4c504392000-10-16 22:06:40 +00001114
1115/*
1116** Cause any pending operation to stop at its earliest opportunity.
1117*/
drh9bb575f2004-09-06 17:24:11 +00001118void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +00001119 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001120}
drhfa86c412002-02-02 15:01:15 +00001121
drhfa86c412002-02-02 15:01:15 +00001122
1123/*
danielk1977771151b2006-01-17 13:21:40 +00001124** This function is exactly the same as sqlite3_create_function(), except
1125** that it is designed to be called by internal code. The difference is
1126** that if a malloc() fails in sqlite3_create_function(), an error code
1127** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001128*/
danielk1977771151b2006-01-17 13:21:40 +00001129int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001130 sqlite3 *db,
1131 const char *zFunctionName,
1132 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001133 int enc,
danielk197765904932004-05-26 06:18:37 +00001134 void *pUserData,
1135 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1136 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001137 void (*xFinal)(sqlite3_context*),
1138 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001139){
drh0bce8352002-02-28 00:41:10 +00001140 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001141 int nName;
danielk197765904932004-05-26 06:18:37 +00001142
drhe30f4422007-08-21 16:15:55 +00001143 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001144 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001145 (xFunc && (xFinal || xStep)) ||
1146 (!xFunc && (xFinal && !xStep)) ||
1147 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001148 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001149 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001150 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001151 }
danielk1977d8123362004-06-12 09:25:12 +00001152
danielk197793758c82005-01-21 08:13:14 +00001153#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001154 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1155 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1156 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1157 **
1158 ** If SQLITE_ANY is specified, add three versions of the function
1159 ** to the hash table.
1160 */
1161 if( enc==SQLITE_UTF16 ){
1162 enc = SQLITE_UTF16NATIVE;
1163 }else if( enc==SQLITE_ANY ){
1164 int rc;
danielk1977771151b2006-01-17 13:21:40 +00001165 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
dand2199f02010-08-27 17:48:52 +00001166 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001167 if( rc==SQLITE_OK ){
1168 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
dand2199f02010-08-27 17:48:52 +00001169 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001170 }
1171 if( rc!=SQLITE_OK ){
1172 return rc;
1173 }
danielk1977d8123362004-06-12 09:25:12 +00001174 enc = SQLITE_UTF16BE;
1175 }
danielk197793758c82005-01-21 08:13:14 +00001176#else
1177 enc = SQLITE_UTF8;
1178#endif
danielk19779636c4e2005-01-25 04:27:54 +00001179
1180 /* Check if an existing function is being overridden or deleted. If so,
1181 ** and there are active VMs, then return SQLITE_BUSY. If a function
1182 ** is being overridden/deleted but there are no active VMs, allow the
1183 ** operation to continue but invalidate all precompiled statements.
1184 */
drh3abbd392008-12-10 23:04:13 +00001185 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001186 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
1187 if( db->activeVdbeCnt ){
1188 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001189 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001190 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001191 return SQLITE_BUSY;
1192 }else{
1193 sqlite3ExpirePreparedStatements(db);
1194 }
1195 }
danielk197765904932004-05-26 06:18:37 +00001196
drh3abbd392008-12-10 23:04:13 +00001197 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001198 assert(p || db->mallocFailed);
1199 if( !p ){
1200 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001201 }
dand2199f02010-08-27 17:48:52 +00001202
1203 /* If an older version of the function with a configured destructor is
1204 ** being replaced invoke the destructor function here. */
1205 functionDestroy(db, p);
1206
1207 if( pDestructor ){
1208 pDestructor->nRef++;
1209 }
1210 p->pDestructor = pDestructor;
danielk1977fa18bec2007-09-03 11:04:22 +00001211 p->flags = 0;
1212 p->xFunc = xFunc;
1213 p->xStep = xStep;
1214 p->xFinalize = xFinal;
1215 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001216 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001217 return SQLITE_OK;
1218}
danielk1977771151b2006-01-17 13:21:40 +00001219
1220/*
1221** Create new user functions.
1222*/
1223int sqlite3_create_function(
1224 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001225 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001226 int nArg,
1227 int enc,
1228 void *p,
1229 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1230 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1231 void (*xFinal)(sqlite3_context*)
1232){
drh7b19fac2010-08-27 18:44:54 +00001233 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1234 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001235}
1236
1237int sqlite3_create_function_v2(
1238 sqlite3 *db,
1239 const char *zFunc,
1240 int nArg,
1241 int enc,
1242 void *p,
1243 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1244 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1245 void (*xFinal)(sqlite3_context*),
1246 void (*xDestroy)(void *)
1247){
shanehbd2aaf92010-09-01 02:38:21 +00001248 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001249 FuncDestructor *pArg = 0;
1250 sqlite3_mutex_enter(db->mutex);
1251 if( xDestroy ){
1252 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001253 if( !pArg ){
1254 xDestroy(p);
1255 goto out;
1256 }
dand2199f02010-08-27 17:48:52 +00001257 pArg->xDestroy = xDestroy;
1258 pArg->pUserData = p;
1259 }
1260 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1261 if( pArg && pArg->nRef==0 ){
1262 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001263 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001264 sqlite3DbFree(db, pArg);
1265 }
1266
1267 out:
drhe30f4422007-08-21 16:15:55 +00001268 rc = sqlite3ApiExit(db, rc);
1269 sqlite3_mutex_leave(db->mutex);
1270 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001271}
1272
danielk197793758c82005-01-21 08:13:14 +00001273#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001274int sqlite3_create_function16(
1275 sqlite3 *db,
1276 const void *zFunctionName,
1277 int nArg,
1278 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001279 void *p,
danielk197765904932004-05-26 06:18:37 +00001280 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1281 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1282 void (*xFinal)(sqlite3_context*)
1283){
1284 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001285 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +00001286 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001287 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001288 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001289 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001290 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001291 rc = sqlite3ApiExit(db, rc);
1292 sqlite3_mutex_leave(db->mutex);
1293 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001294}
danielk197793758c82005-01-21 08:13:14 +00001295#endif
drhc9b84a12002-06-20 11:36:48 +00001296
drhb7481e72006-09-16 21:45:14 +00001297
1298/*
1299** Declare that a function has been overloaded by a virtual table.
1300**
1301** If the function already exists as a regular global function, then
1302** this routine is a no-op. If the function does not exist, then create
1303** a new one that always throws a run-time error.
1304**
1305** When virtual tables intend to provide an overloaded function, they
1306** should call this routine to make sure the global function exists.
1307** A global function must exist in order for name resolution to work
1308** properly.
1309*/
1310int sqlite3_overload_function(
1311 sqlite3 *db,
1312 const char *zName,
1313 int nArg
1314){
drhdee0e402009-05-03 20:23:53 +00001315 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001316 int rc = SQLITE_OK;
drhe30f4422007-08-21 16:15:55 +00001317 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001318 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001319 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1320 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001321 }
drhcb5e4db2011-10-12 23:49:49 +00001322 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001323 sqlite3_mutex_leave(db->mutex);
1324 return rc;
drhb7481e72006-09-16 21:45:14 +00001325}
1326
drh19e2d372005-08-29 23:00:03 +00001327#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001328/*
drh18de4822003-01-16 16:28:53 +00001329** Register a trace function. The pArg from the previously registered trace
1330** is returned.
1331**
1332** A NULL trace function means that no tracing is executes. A non-NULL
1333** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001334** SQL statement.
drh18de4822003-01-16 16:28:53 +00001335*/
drh9bb575f2004-09-06 17:24:11 +00001336void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001337 void *pOld;
1338 sqlite3_mutex_enter(db->mutex);
1339 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001340 db->xTrace = xTrace;
1341 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001342 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001343 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001344}
drh19e2d372005-08-29 23:00:03 +00001345/*
1346** Register a profile function. The pArg from the previously registered
1347** profile function is returned.
1348**
1349** A NULL profile function means that no profiling is executes. A non-NULL
1350** profile is a pointer to a function that is invoked at the conclusion of
1351** each SQL statement that is run.
1352*/
1353void *sqlite3_profile(
1354 sqlite3 *db,
1355 void (*xProfile)(void*,const char*,sqlite_uint64),
1356 void *pArg
1357){
drhe30f4422007-08-21 16:15:55 +00001358 void *pOld;
1359 sqlite3_mutex_enter(db->mutex);
1360 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001361 db->xProfile = xProfile;
1362 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001363 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001364 return pOld;
1365}
1366#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001367
drhcd565fd2012-03-01 21:30:44 +00001368/*
1369** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001370** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001371** rollback.
1372*/
danielk197724b03fd2004-05-10 10:34:34 +00001373void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001374 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001375 int (*xCallback)(void*), /* Function to invoke on each commit */
1376 void *pArg /* Argument to the function */
1377){
drhe30f4422007-08-21 16:15:55 +00001378 void *pOld;
1379 sqlite3_mutex_enter(db->mutex);
1380 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001381 db->xCommitCallback = xCallback;
1382 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001383 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001384 return pOld;
1385}
1386
danielk197794eb6a12005-12-15 15:22:08 +00001387/*
1388** Register a callback to be invoked each time a row is updated,
1389** inserted or deleted using this database connection.
1390*/
danielk197771fd80b2005-12-16 06:54:01 +00001391void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001392 sqlite3 *db, /* Attach the hook to this database */
1393 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1394 void *pArg /* Argument to the function */
1395){
drhe30f4422007-08-21 16:15:55 +00001396 void *pRet;
1397 sqlite3_mutex_enter(db->mutex);
1398 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001399 db->xUpdateCallback = xCallback;
1400 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001401 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001402 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001403}
1404
danielk197771fd80b2005-12-16 06:54:01 +00001405/*
1406** Register a callback to be invoked each time a transaction is rolled
1407** back by this database connection.
1408*/
1409void *sqlite3_rollback_hook(
1410 sqlite3 *db, /* Attach the hook to this database */
1411 void (*xCallback)(void*), /* Callback function */
1412 void *pArg /* Argument to the function */
1413){
drhe30f4422007-08-21 16:15:55 +00001414 void *pRet;
1415 sqlite3_mutex_enter(db->mutex);
1416 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001417 db->xRollbackCallback = xCallback;
1418 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001419 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001420 return pRet;
1421}
drhaa940ea2004-01-15 02:44:03 +00001422
dan586b9c82010-05-03 08:04:49 +00001423#ifndef SQLITE_OMIT_WAL
1424/*
1425** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001426** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1427** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001428** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001429*/
drhb033d8b2010-05-03 13:37:30 +00001430int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001431 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001432 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001433 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001434 int nFrame /* Size of WAL */
1435){
drh5def0842010-05-05 20:00:25 +00001436 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001437 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001438 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001439 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001440 }
1441 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001442}
drhb033d8b2010-05-03 13:37:30 +00001443#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001444
1445/*
1446** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1447** a database after committing a transaction if there are nFrame or
1448** more frames in the log file. Passing zero or a negative value as the
1449** nFrame parameter disables automatic checkpoints entirely.
1450**
1451** The callback registered by this function replaces any existing callback
1452** registered using sqlite3_wal_hook(). Likewise, registering a callback
1453** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1454** configured by this function.
1455*/
1456int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001457#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001458 UNUSED_PARAMETER(db);
1459 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001460#else
dan586b9c82010-05-03 08:04:49 +00001461 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001462 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001463 }else{
1464 sqlite3_wal_hook(db, 0, 0);
1465 }
drhb033d8b2010-05-03 13:37:30 +00001466#endif
dan586b9c82010-05-03 08:04:49 +00001467 return SQLITE_OK;
1468}
1469
paulb0208cc2003-04-13 18:26:49 +00001470/*
dan8d22a172010-04-19 18:03:51 +00001471** Register a callback to be invoked each time a transaction is written
1472** into the write-ahead-log by this database connection.
1473*/
drh833bf962010-04-28 14:42:19 +00001474void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001475 sqlite3 *db, /* Attach the hook to this db handle */
1476 int(*xCallback)(void *, sqlite3*, const char*, int),
1477 void *pArg /* First argument passed to xCallback() */
1478){
drhb033d8b2010-05-03 13:37:30 +00001479#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001480 void *pRet;
1481 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001482 pRet = db->pWalArg;
1483 db->xWalCallback = xCallback;
1484 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001485 sqlite3_mutex_leave(db->mutex);
1486 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001487#else
1488 return 0;
1489#endif
dan8d22a172010-04-19 18:03:51 +00001490}
1491
1492/*
dancdc1f042010-11-18 12:11:05 +00001493** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001494*/
dancdc1f042010-11-18 12:11:05 +00001495int sqlite3_wal_checkpoint_v2(
1496 sqlite3 *db, /* Database handle */
1497 const char *zDb, /* Name of attached database (or NULL) */
1498 int eMode, /* SQLITE_CHECKPOINT_* value */
1499 int *pnLog, /* OUT: Size of WAL log in frames */
1500 int *pnCkpt /* OUT: Total number of frames checkpointed */
1501){
drhb033d8b2010-05-03 13:37:30 +00001502#ifdef SQLITE_OMIT_WAL
1503 return SQLITE_OK;
1504#else
dan586b9c82010-05-03 08:04:49 +00001505 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001506 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001507
dan9c5e3682011-02-07 15:12:12 +00001508 /* Initialize the output variables to -1 in case an error occurs. */
1509 if( pnLog ) *pnLog = -1;
1510 if( pnCkpt ) *pnCkpt = -1;
1511
drh383d79e2011-02-09 03:03:16 +00001512 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1513 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1514 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1515 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001516 return SQLITE_MISUSE;
1517 }
1518
dan586b9c82010-05-03 08:04:49 +00001519 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001520 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001521 iDb = sqlite3FindDbName(db, zDb);
1522 }
1523 if( iDb<0 ){
1524 rc = SQLITE_ERROR;
dan87c1fe12010-05-03 12:14:15 +00001525 sqlite3Error(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001526 }else{
dancdc1f042010-11-18 12:11:05 +00001527 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
dan87c1fe12010-05-03 12:14:15 +00001528 sqlite3Error(db, rc, 0);
dan586b9c82010-05-03 08:04:49 +00001529 }
drhb033d8b2010-05-03 13:37:30 +00001530 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001531 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001532 return rc;
1533#endif
dan586b9c82010-05-03 08:04:49 +00001534}
1535
dancdc1f042010-11-18 12:11:05 +00001536
1537/*
1538** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1539** to contains a zero-length string, all attached databases are
1540** checkpointed.
1541*/
1542int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1543 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1544}
1545
drhb033d8b2010-05-03 13:37:30 +00001546#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001547/*
1548** Run a checkpoint on database iDb. This is a no-op if database iDb is
1549** not currently open in WAL mode.
1550**
dan6fcff072010-05-03 14:05:43 +00001551** If a transaction is open on the database being checkpointed, this
1552** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1553** an error occurs while running the checkpoint, an SQLite error code is
1554** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001555**
1556** The mutex on database handle db should be held by the caller. The mutex
1557** associated with the specific b-tree being checkpointed is taken by
1558** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001559**
1560** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1561** checkpointed. If an error is encountered it is returned immediately -
1562** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001563**
dancdc1f042010-11-18 12:11:05 +00001564** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001565*/
dancdc1f042010-11-18 12:11:05 +00001566int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001567 int rc = SQLITE_OK; /* Return code */
1568 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001569 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001570
1571 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001572 assert( !pnLog || *pnLog==-1 );
1573 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001574
dan6fcff072010-05-03 14:05:43 +00001575 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1576 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001577 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001578 pnLog = 0;
1579 pnCkpt = 0;
1580 if( rc==SQLITE_BUSY ){
1581 bBusy = 1;
1582 rc = SQLITE_OK;
1583 }
dan6fcff072010-05-03 14:05:43 +00001584 }
dan586b9c82010-05-03 08:04:49 +00001585 }
1586
danf2b8dd52010-11-18 19:28:01 +00001587 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001588}
drhb033d8b2010-05-03 13:37:30 +00001589#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001590
1591/*
danielk1977d8293352009-04-30 09:10:37 +00001592** This function returns true if main-memory should be used instead of
1593** a temporary file for transient pager files and statement journals.
1594** The value returned depends on the value of db->temp_store (runtime
1595** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1596** following table describes the relationship between these two values
1597** and this functions return value.
1598**
1599** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1600** ----------------- -------------- ------------------------------
1601** 0 any file (return 0)
1602** 1 1 file (return 0)
1603** 1 2 memory (return 1)
1604** 1 0 file (return 0)
1605** 2 1 file (return 0)
1606** 2 2 memory (return 1)
1607** 2 0 memory (return 1)
1608** 3 any memory (return 1)
1609*/
drh1c514142009-04-30 12:25:10 +00001610int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001611#if SQLITE_TEMP_STORE==1
1612 return ( db->temp_store==2 );
1613#endif
1614#if SQLITE_TEMP_STORE==2
1615 return ( db->temp_store!=1 );
1616#endif
1617#if SQLITE_TEMP_STORE==3
1618 return 1;
shanecf697392009-06-01 16:53:09 +00001619#endif
1620#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001621 return 0;
shane60a4b532009-05-06 18:57:09 +00001622#endif
danielk1977d8293352009-04-30 09:10:37 +00001623}
1624
1625/*
danielk19774ad17132004-05-21 01:47:26 +00001626** Return UTF-8 encoded English language explanation of the most recent
1627** error.
1628*/
danielk19776622cce2004-05-20 11:00:52 +00001629const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001630 const char *z;
drhf49661a2008-12-10 16:45:50 +00001631 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001632 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001633 }
drhd55d57e2008-07-07 17:53:07 +00001634 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001635 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001636 }
drh27641702007-08-22 02:56:42 +00001637 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001638 if( db->mallocFailed ){
1639 z = sqlite3ErrStr(SQLITE_NOMEM);
1640 }else{
1641 z = (char*)sqlite3_value_text(db->pErr);
1642 assert( !db->mallocFailed );
1643 if( z==0 ){
1644 z = sqlite3ErrStr(db->errCode);
1645 }
danielk19776622cce2004-05-20 11:00:52 +00001646 }
drhe30f4422007-08-21 16:15:55 +00001647 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001648 return z;
danielk19776622cce2004-05-20 11:00:52 +00001649}
1650
drh6c626082004-11-14 21:56:29 +00001651#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001652/*
1653** Return UTF-16 encoded English language explanation of the most recent
1654** error.
1655*/
danielk19776622cce2004-05-20 11:00:52 +00001656const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00001657 static const u16 outOfMem[] = {
1658 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00001659 };
danielk19777c5c3ca2009-02-23 14:42:53 +00001660 static const u16 misuse[] = {
1661 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
1662 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
1663 'c', 'a', 'l', 'l', 'e', 'd', ' ',
1664 'o', 'u', 't', ' ',
1665 'o', 'f', ' ',
1666 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00001667 };
danielk19774ad17132004-05-21 01:47:26 +00001668
drhc60d0442004-09-30 13:43:13 +00001669 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001670 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001671 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00001672 }
drhd55d57e2008-07-07 17:53:07 +00001673 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001674 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00001675 }
drhe30f4422007-08-21 16:15:55 +00001676 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001677 if( db->mallocFailed ){
1678 z = (void *)outOfMem;
1679 }else{
drhc60d0442004-09-30 13:43:13 +00001680 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00001681 if( z==0 ){
1682 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
1683 SQLITE_UTF8, SQLITE_STATIC);
1684 z = sqlite3_value_text16(db->pErr);
1685 }
1686 /* A malloc() may have failed within the call to sqlite3_value_text16()
1687 ** above. If this is the case, then the db->mallocFailed flag needs to
1688 ** be cleared before returning. Do this directly, instead of via
1689 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1690 */
1691 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00001692 }
drhe30f4422007-08-21 16:15:55 +00001693 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001694 return z;
danielk19776622cce2004-05-20 11:00:52 +00001695}
drh6c626082004-11-14 21:56:29 +00001696#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001697
drhc60d0442004-09-30 13:43:13 +00001698/*
danielk19777ddad962005-12-12 06:53:03 +00001699** Return the most recent error code generated by an SQLite routine. If NULL is
1700** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001701*/
danielk19776622cce2004-05-20 11:00:52 +00001702int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001703 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001704 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00001705 }
drh01495b92008-01-23 12:52:40 +00001706 if( !db || db->mallocFailed ){
1707 return SQLITE_NOMEM;
1708 }
drh4ac285a2006-09-15 07:28:50 +00001709 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001710}
drh99dfe5e2008-10-30 15:03:15 +00001711int sqlite3_extended_errcode(sqlite3 *db){
1712 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001713 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00001714 }
1715 if( !db || db->mallocFailed ){
1716 return SQLITE_NOMEM;
1717 }
1718 return db->errCode;
1719}
danielk19776622cce2004-05-20 11:00:52 +00001720
drh0e819f92006-02-01 13:50:41 +00001721/*
1722** Create a new collating function for database "db". The name is zName
1723** and the encoding is enc.
1724*/
danielk19779a30cf62006-01-18 04:26:07 +00001725static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00001726 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00001727 const char *zName,
shanecea72b22009-09-07 04:38:36 +00001728 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00001729 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001730 int(*xCompare)(void*,int,const void*,int,const void*),
1731 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001732){
1733 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001734 int enc2;
drhc4a64fa2009-05-11 20:53:28 +00001735 int nName = sqlite3Strlen30(zName);
danielk19779a30cf62006-01-18 04:26:07 +00001736
drhe30f4422007-08-21 16:15:55 +00001737 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001738
1739 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1740 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1741 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1742 */
drh51c7d862009-04-27 18:46:06 +00001743 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00001744 testcase( enc2==SQLITE_UTF16 );
1745 testcase( enc2==SQLITE_UTF16_ALIGNED );
1746 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00001747 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001748 }
drh51c7d862009-04-27 18:46:06 +00001749 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00001750 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00001751 }
1752
1753 /* Check if this call is removing or replacing an existing collation
1754 ** sequence. If so, and there are active VMs, return busy. If there
1755 ** are no active VMs, invalidate any pre-compiled statements.
1756 */
drhc4a64fa2009-05-11 20:53:28 +00001757 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001758 if( pColl && pColl->xCmp ){
1759 if( db->activeVdbeCnt ){
1760 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001761 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00001762 return SQLITE_BUSY;
1763 }
1764 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001765
1766 /* If collation sequence pColl was created directly by a call to
1767 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1768 ** then any copies made by synthCollSeq() need to be invalidated.
1769 ** Also, collation destructor - CollSeq.xDel() - function may need
1770 ** to be called.
1771 */
1772 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001773 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001774 int j;
1775 for(j=0; j<3; j++){
1776 CollSeq *p = &aColl[j];
1777 if( p->enc==pColl->enc ){
1778 if( p->xDel ){
1779 p->xDel(p->pUser);
1780 }
1781 p->xCmp = 0;
1782 }
1783 }
1784 }
danielk19779a30cf62006-01-18 04:26:07 +00001785 }
1786
drhc4a64fa2009-05-11 20:53:28 +00001787 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00001788 if( pColl==0 ) return SQLITE_NOMEM;
1789 pColl->xCmp = xCompare;
1790 pColl->pUser = pCtx;
1791 pColl->xDel = xDel;
1792 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
danielk19779a30cf62006-01-18 04:26:07 +00001793 sqlite3Error(db, SQLITE_OK, 0);
1794 return SQLITE_OK;
1795}
1796
1797
danielk19776622cce2004-05-20 11:00:52 +00001798/*
drhbb4957f2008-03-20 14:03:29 +00001799** This array defines hard upper bounds on limit values. The
1800** initializer must be kept in sync with the SQLITE_LIMIT_*
1801** #defines in sqlite3.h.
1802*/
drhb1a6c3c2008-03-20 16:30:17 +00001803static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00001804 SQLITE_MAX_LENGTH,
1805 SQLITE_MAX_SQL_LENGTH,
1806 SQLITE_MAX_COLUMN,
1807 SQLITE_MAX_EXPR_DEPTH,
1808 SQLITE_MAX_COMPOUND_SELECT,
1809 SQLITE_MAX_VDBE_OP,
1810 SQLITE_MAX_FUNCTION_ARG,
1811 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00001812 SQLITE_MAX_LIKE_PATTERN_LENGTH,
1813 SQLITE_MAX_VARIABLE_NUMBER,
drh417168a2009-09-07 18:14:02 +00001814 SQLITE_MAX_TRIGGER_DEPTH,
drhbb4957f2008-03-20 14:03:29 +00001815};
1816
1817/*
1818** Make sure the hard limits are set to reasonable values
1819*/
1820#if SQLITE_MAX_LENGTH<100
1821# error SQLITE_MAX_LENGTH must be at least 100
1822#endif
1823#if SQLITE_MAX_SQL_LENGTH<100
1824# error SQLITE_MAX_SQL_LENGTH must be at least 100
1825#endif
1826#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
1827# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
1828#endif
drhbb4957f2008-03-20 14:03:29 +00001829#if SQLITE_MAX_COMPOUND_SELECT<2
1830# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
1831#endif
1832#if SQLITE_MAX_VDBE_OP<40
1833# error SQLITE_MAX_VDBE_OP must be at least 40
1834#endif
drhe82f5d02008-10-07 19:53:14 +00001835#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
1836# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00001837#endif
drh01c7dc82011-03-23 18:22:34 +00001838#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>62
1839# error SQLITE_MAX_ATTACHED must be between 0 and 62
drhbb4957f2008-03-20 14:03:29 +00001840#endif
drhbb4957f2008-03-20 14:03:29 +00001841#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
1842# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
1843#endif
drh70a8ca32008-08-21 18:49:27 +00001844#if SQLITE_MAX_COLUMN>32767
1845# error SQLITE_MAX_COLUMN must not exceed 32767
1846#endif
drh417168a2009-09-07 18:14:02 +00001847#if SQLITE_MAX_TRIGGER_DEPTH<1
1848# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
1849#endif
drhbb4957f2008-03-20 14:03:29 +00001850
1851
1852/*
1853** Change the value of a limit. Report the old value.
1854** If an invalid limit index is supplied, report -1.
1855** Make no changes but still report the old value if the
1856** new limit is negative.
1857**
1858** A new lower limit does not shrink existing constructs.
1859** It merely prevents new constructs that exceed the limit
1860** from forming.
1861*/
1862int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
1863 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00001864
1865
1866 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
1867 ** there is a hard upper bound set at compile-time by a C preprocessor
1868 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
1869 ** "_MAX_".)
1870 */
1871 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
1872 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
1873 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
1874 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
1875 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
1876 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
1877 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
1878 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
1879 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
1880 SQLITE_MAX_LIKE_PATTERN_LENGTH );
1881 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
1882 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
1883 assert( SQLITE_LIMIT_TRIGGER_DEPTH==(SQLITE_N_LIMIT-1) );
1884
1885
drh521cc842008-04-15 02:36:33 +00001886 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00001887 return -1;
1888 }
1889 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00001890 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00001891 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00001892 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00001893 }
1894 db->aLimit[limitId] = newLimit;
1895 }
drh4e93f5b2010-09-07 14:59:15 +00001896 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00001897}
1898
1899/*
dan286ab7c2011-05-06 18:34:54 +00001900** This function is used to parse both URIs and non-URI filenames passed by the
1901** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
1902** URIs specified as part of ATTACH statements.
1903**
1904** The first argument to this function is the name of the VFS to use (or
1905** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
1906** query parameter. The second argument contains the URI (or non-URI filename)
1907** itself. When this function is called the *pFlags variable should contain
1908** the default flags to open the database handle with. The value stored in
1909** *pFlags may be updated before returning if the URI filename contains
1910** "cache=xxx" or "mode=xxx" query parameters.
1911**
1912** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
1913** the VFS that should be used to open the database file. *pzFile is set to
1914** point to a buffer containing the name of the file to open. It is the
1915** responsibility of the caller to eventually call sqlite3_free() to release
1916** this buffer.
1917**
1918** If an error occurs, then an SQLite error code is returned and *pzErrMsg
1919** may be set to point to a buffer containing an English language error
1920** message. It is the responsibility of the caller to eventually release
1921** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00001922*/
1923int sqlite3ParseUri(
1924 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
1925 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00001926 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00001927 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
1928 char **pzFile, /* OUT: Filename component of URI */
1929 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
1930){
dan78e9dd22011-05-03 10:22:32 +00001931 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00001932 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00001933 const char *zVfs = zDefaultVfs;
1934 char *zFile;
drhde941c32011-05-09 19:20:17 +00001935 char c;
dancd74b612011-04-22 19:37:32 +00001936 int nUri = sqlite3Strlen30(zUri);
1937
1938 assert( *pzErrMsg==0 );
1939
1940 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
1941 && nUri>=5 && memcmp(zUri, "file:", 5)==0
1942 ){
dan5de15372011-04-23 10:12:30 +00001943 char *zOpt;
dancd74b612011-04-22 19:37:32 +00001944 int eState; /* Parser state when parsing URI */
1945 int iIn; /* Input character index */
1946 int iOut = 0; /* Output character index */
1947 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00001948
dan286ab7c2011-05-06 18:34:54 +00001949 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
1950 ** method that there may be extra parameters following the file-name. */
1951 flags |= SQLITE_OPEN_URI;
1952
1953 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00001954 zFile = sqlite3_malloc(nByte);
1955 if( !zFile ) return SQLITE_NOMEM;
1956
1957 /* Discard the scheme and authority segments of the URI. */
1958 if( zUri[5]=='/' && zUri[6]=='/' ){
1959 iIn = 7;
1960 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00001961
1962 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
1963 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
1964 iIn-7, &zUri[7]);
1965 rc = SQLITE_ERROR;
1966 goto parse_uri_out;
1967 }
dancd74b612011-04-22 19:37:32 +00001968 }else{
1969 iIn = 5;
1970 }
1971
1972 /* Copy the filename and any query parameters into the zFile buffer.
1973 ** Decode %HH escape codes along the way.
1974 **
1975 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
1976 ** on the parsing context. As follows:
1977 **
1978 ** 0: Parsing file-name.
1979 ** 1: Parsing name section of a name=value query parameter.
1980 ** 2: Parsing value section of a name=value query parameter.
1981 */
1982 eState = 0;
drhde941c32011-05-09 19:20:17 +00001983 while( (c = zUri[iIn])!=0 && c!='#' ){
1984 iIn++;
dancd74b612011-04-22 19:37:32 +00001985 if( c=='%'
1986 && sqlite3Isxdigit(zUri[iIn])
1987 && sqlite3Isxdigit(zUri[iIn+1])
1988 ){
dan6d49e252011-05-03 15:09:05 +00001989 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
1990 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00001991
dan6d49e252011-05-03 15:09:05 +00001992 assert( octet>=0 && octet<256 );
1993 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00001994 /* This branch is taken when "%00" appears within the URI. In this
1995 ** case we ignore all text in the remainder of the path, name or
1996 ** value currently being parsed. So ignore the current character
1997 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00001998 while( (c = zUri[iIn])!=0 && c!='#'
1999 && (eState!=0 || c!='?')
2000 && (eState!=1 || (c!='=' && c!='&'))
2001 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002002 ){
2003 iIn++;
2004 }
2005 continue;
dancd74b612011-04-22 19:37:32 +00002006 }
dan6d49e252011-05-03 15:09:05 +00002007 c = octet;
dan5de15372011-04-23 10:12:30 +00002008 }else if( eState==1 && (c=='&' || c=='=') ){
2009 if( zFile[iOut-1]==0 ){
2010 /* An empty option name. Ignore this option altogether. */
2011 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2012 continue;
2013 }
2014 if( c=='&' ){
2015 zFile[iOut++] = '\0';
2016 }else{
2017 eState = 2;
2018 }
dancd74b612011-04-22 19:37:32 +00002019 c = 0;
dan5de15372011-04-23 10:12:30 +00002020 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2021 c = 0;
dancd74b612011-04-22 19:37:32 +00002022 eState = 1;
dancd74b612011-04-22 19:37:32 +00002023 }
2024 zFile[iOut++] = c;
2025 }
2026 if( eState==1 ) zFile[iOut++] = '\0';
2027 zFile[iOut++] = '\0';
2028 zFile[iOut++] = '\0';
2029
2030 /* Check if there were any options specified that should be interpreted
2031 ** here. Options that are interpreted here include "vfs" and those that
2032 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002033 ** method. */
dan5de15372011-04-23 10:12:30 +00002034 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2035 while( zOpt[0] ){
2036 int nOpt = sqlite3Strlen30(zOpt);
2037 char *zVal = &zOpt[nOpt+1];
2038 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002039
dan286ab7c2011-05-06 18:34:54 +00002040 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002041 zVfs = zVal;
2042 }else{
2043 struct OpenMode {
2044 const char *z;
2045 int mode;
2046 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002047 char *zModeType = 0;
2048 int mask = 0;
2049 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002050
dan286ab7c2011-05-06 18:34:54 +00002051 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002052 static struct OpenMode aCacheMode[] = {
2053 { "shared", SQLITE_OPEN_SHAREDCACHE },
2054 { "private", SQLITE_OPEN_PRIVATECACHE },
2055 { 0, 0 }
2056 };
2057
2058 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2059 aMode = aCacheMode;
2060 limit = mask;
2061 zModeType = "cache";
2062 }
dan286ab7c2011-05-06 18:34:54 +00002063 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002064 static struct OpenMode aOpenMode[] = {
2065 { "ro", SQLITE_OPEN_READONLY },
2066 { "rw", SQLITE_OPEN_READWRITE },
2067 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002068 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002069 { 0, 0 }
2070 };
2071
drh9c67b2a2012-05-28 13:58:00 +00002072 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2073 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002074 aMode = aOpenMode;
2075 limit = mask & flags;
2076 zModeType = "access";
2077 }
2078
2079 if( aMode ){
2080 int i;
2081 int mode = 0;
2082 for(i=0; aMode[i].z; i++){
2083 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002084 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002085 mode = aMode[i].mode;
2086 break;
dancd74b612011-04-22 19:37:32 +00002087 }
2088 }
dan78e9dd22011-05-03 10:22:32 +00002089 if( mode==0 ){
2090 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2091 rc = SQLITE_ERROR;
2092 goto parse_uri_out;
2093 }
drh9c67b2a2012-05-28 13:58:00 +00002094 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002095 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2096 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002097 rc = SQLITE_PERM;
2098 goto parse_uri_out;
2099 }
2100 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002101 }
dancd74b612011-04-22 19:37:32 +00002102 }
dan5de15372011-04-23 10:12:30 +00002103
2104 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002105 }
2106
2107 }else{
2108 zFile = sqlite3_malloc(nUri+2);
2109 if( !zFile ) return SQLITE_NOMEM;
2110 memcpy(zFile, zUri, nUri);
2111 zFile[nUri] = '\0';
2112 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002113 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002114 }
2115
2116 *ppVfs = sqlite3_vfs_find(zVfs);
2117 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002118 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002119 rc = SQLITE_ERROR;
2120 }
2121 parse_uri_out:
2122 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002123 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002124 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002125 }
2126 *pFlags = flags;
2127 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002128 return rc;
dancd74b612011-04-22 19:37:32 +00002129}
2130
2131
2132/*
danielk19774ad17132004-05-21 01:47:26 +00002133** This routine does the work of opening a database on behalf of
2134** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002135** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002136*/
2137static int openDatabase(
2138 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002139 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002140 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002141 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002142){
dancd74b612011-04-22 19:37:32 +00002143 sqlite3 *db; /* Store allocated handle here */
2144 int rc; /* Return code */
2145 int isThreadsafe; /* True for threadsafe connections */
2146 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2147 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002148
drhe0d0f8e2009-04-28 04:47:31 +00002149 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002150#ifndef SQLITE_OMIT_AUTOINIT
2151 rc = sqlite3_initialize();
2152 if( rc ) return rc;
2153#endif
2154
dan78e9dd22011-05-03 10:22:32 +00002155 /* Only allow sensible combinations of bits in the flags argument.
2156 ** Throw an error if any non-sense combination is used. If we
2157 ** do not block illegal combinations here, it could trigger
2158 ** assert() statements in deeper layers. Sensible combinations
2159 ** are:
2160 **
2161 ** 1: SQLITE_OPEN_READONLY
2162 ** 2: SQLITE_OPEN_READWRITE
2163 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2164 */
2165 assert( SQLITE_OPEN_READONLY == 0x01 );
2166 assert( SQLITE_OPEN_READWRITE == 0x02 );
2167 assert( SQLITE_OPEN_CREATE == 0x04 );
2168 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2169 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2170 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh5dd72ad2011-05-07 18:18:33 +00002171 if( ((1<<(flags&7)) & 0x46)==0 ) return SQLITE_MISUSE_BKPT;
dan78e9dd22011-05-03 10:22:32 +00002172
drh039963a2008-09-03 00:43:15 +00002173 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002174 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002175 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2176 isThreadsafe = 0;
2177 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2178 isThreadsafe = 1;
2179 }else{
2180 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002181 }
drhf1f12682009-09-09 14:17:52 +00002182 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002183 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002184 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2185 flags |= SQLITE_OPEN_SHAREDCACHE;
2186 }
danielk19779a6284c2008-07-10 17:52:49 +00002187
drhb25a9f42009-05-12 13:35:11 +00002188 /* Remove harmful bits from the flags parameter
2189 **
2190 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2191 ** dealt with in the previous code block. Besides these, the only
2192 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002193 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2194 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002195 ** off all other flags.
2196 */
drha4267dc2008-02-19 15:20:44 +00002197 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002198 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002199 SQLITE_OPEN_MAIN_DB |
2200 SQLITE_OPEN_TEMP_DB |
2201 SQLITE_OPEN_TRANSIENT_DB |
2202 SQLITE_OPEN_MAIN_JOURNAL |
2203 SQLITE_OPEN_TEMP_JOURNAL |
2204 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002205 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002206 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002207 SQLITE_OPEN_FULLMUTEX |
2208 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002209 );
2210
danielk19774ad17132004-05-21 01:47:26 +00002211 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002212 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002213 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002214 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002215 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2216 if( db->mutex==0 ){
2217 sqlite3_free(db);
2218 db = 0;
2219 goto opendb_out;
2220 }
drh605264d2007-08-21 15:13:19 +00002221 }
drh27641702007-08-22 02:56:42 +00002222 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002223 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002224 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002225 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002226 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002227
drhbb4957f2008-03-20 14:03:29 +00002228 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2229 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00002230 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002231 db->nextAutovac = -1;
danielk1977f653d782008-03-20 11:04:21 +00002232 db->nextPagesize = 0;
drhe83cafd2011-03-21 17:15:58 +00002233 db->flags |= SQLITE_ShortColNames | SQLITE_AutoIndex | SQLITE_EnableTrigger
drh76fe8032006-07-11 14:17:51 +00002234#if SQLITE_DEFAULT_FILE_FORMAT<4
2235 | SQLITE_LegacyFileFmt
2236#endif
drh56424db2007-03-27 22:24:11 +00002237#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2238 | SQLITE_LoadExtension
2239#endif
dan5bde73c2009-09-01 17:11:07 +00002240#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002241 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002242#endif
drha4bfd7f2010-12-09 19:15:17 +00002243#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2244 | SQLITE_ForeignKeys
2245#endif
drh76fe8032006-07-11 14:17:51 +00002246 ;
drhe61922a2009-05-02 13:29:37 +00002247 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002248#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002249 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002250#endif
danielk1977da184232006-01-05 11:34:32 +00002251
danielk19770202b292004-06-09 09:55:16 +00002252 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2253 ** and UTF-16, so add a version for each to avoid any unnecessary
2254 ** conversions. The only error that can occur here is a malloc() failure.
2255 */
drh4dd65e02011-11-29 14:46:56 +00002256 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2257 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2258 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2259 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002260 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002261 goto opendb_out;
2262 }
drhc4a64fa2009-05-11 20:53:28 +00002263 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002264 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002265
2266 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002267 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002268
dancd74b612011-04-22 19:37:32 +00002269 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002270 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002271 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2272 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002273 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
dan78e9dd22011-05-03 10:22:32 +00002274 sqlite3Error(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002275 sqlite3_free(zErrMsg);
2276 goto opendb_out;
2277 }
2278
danielk19774ad17132004-05-21 01:47:26 +00002279 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002280 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002281 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002282 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002283 if( rc==SQLITE_IOERR_NOMEM ){
2284 rc = SQLITE_NOMEM;
2285 }
danielk19774ad17132004-05-21 01:47:26 +00002286 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00002287 goto opendb_out;
2288 }
drh17435752007-08-16 04:30:38 +00002289 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2290 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002291
drh03b808a2006-03-13 15:06:05 +00002292
danielk197753c0f742005-03-29 03:10:59 +00002293 /* The default safety_level for the main database is 'full'; for the temp
2294 ** database it is 'NONE'. This matches the pager layer defaults.
2295 */
2296 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002297 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002298 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002299 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002300
danielk1977832a58a2007-06-22 15:21:15 +00002301 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002302 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002303 goto opendb_out;
2304 }
2305
danielk19778e227872004-06-07 07:52:17 +00002306 /* Register all built-in functions, but do not attempt to read the
2307 ** database schema yet. This is delayed until the first time the database
2308 ** is accessed.
2309 */
danielk1977832a58a2007-06-22 15:21:15 +00002310 sqlite3Error(db, SQLITE_OK, 0);
2311 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002312
drh1409be62006-08-23 20:07:20 +00002313 /* Load automatic extensions - extensions that have been registered
2314 ** using the sqlite3_automatic_extension() API.
2315 */
drh7aaa8782009-05-20 02:40:45 +00002316 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002317 if( rc==SQLITE_OK ){
2318 sqlite3AutoLoadExtensions(db);
2319 rc = sqlite3_errcode(db);
2320 if( rc!=SQLITE_OK ){
2321 goto opendb_out;
2322 }
danielk1977832a58a2007-06-22 15:21:15 +00002323 }
drh1409be62006-08-23 20:07:20 +00002324
drhaa29c132006-09-02 13:58:06 +00002325#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002326 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002327 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002328 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002329 }
2330#endif
2331
shessa26cf572006-10-19 20:27:58 +00002332#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002333 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002334 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002335 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002336 }
2337#endif
2338
shess69c4ae22007-08-20 17:37:47 +00002339#ifdef SQLITE_ENABLE_FTS3
2340 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002341 rc = sqlite3Fts3Init(db);
2342 }
2343#endif
2344
danielk197783852ac2007-05-06 16:04:11 +00002345#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002346 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002347 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002348 }
2349#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002350
2351#ifdef SQLITE_ENABLE_RTREE
2352 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002353 rc = sqlite3RtreeInit(db);
2354 }
2355#endif
2356
danielk1977832a58a2007-06-22 15:21:15 +00002357 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00002358
drh8fd5bd32007-04-02 16:40:37 +00002359 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2360 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2361 ** mode. Doing nothing at all also makes NORMAL the default.
2362 */
2363#ifdef SQLITE_DEFAULT_LOCKING_MODE
2364 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2365 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2366 SQLITE_DEFAULT_LOCKING_MODE);
2367#endif
2368
drh633e6d52008-07-28 19:34:53 +00002369 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002370 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2371 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002372
dan5a299f92010-05-03 11:05:08 +00002373 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002374
danielk19774ad17132004-05-21 01:47:26 +00002375opendb_out:
dancd74b612011-04-22 19:37:32 +00002376 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002377 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002378 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002379 sqlite3_mutex_leave(db->mutex);
2380 }
danielk197759633ae2008-08-27 19:01:57 +00002381 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002382 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002383 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002384 sqlite3_close(db);
2385 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002386 }else if( rc!=SQLITE_OK ){
2387 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002388 }
danielk19774ad17132004-05-21 01:47:26 +00002389 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00002390 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002391}
2392
2393/*
2394** Open a new database handle.
2395*/
danielk197780290862004-05-22 09:21:21 +00002396int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002397 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002398 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002399){
drh605264d2007-08-21 15:13:19 +00002400 return openDatabase(zFilename, ppDb,
2401 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2402}
2403int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002404 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002405 sqlite3 **ppDb, /* OUT: SQLite db handle */
2406 int flags, /* Flags */
2407 const char *zVfs /* Name of VFS module to use */
2408){
drh522c26f2011-05-07 14:40:29 +00002409 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002410}
2411
drh6c626082004-11-14 21:56:29 +00002412#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002413/*
2414** Open a new database handle.
2415*/
2416int sqlite3_open16(
2417 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002418 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002419){
danielk1977bfd6cce2004-06-18 04:24:54 +00002420 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002421 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002422 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002423
danielk19777ddad962005-12-12 06:53:03 +00002424 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00002425 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00002426 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002427#ifndef SQLITE_OMIT_AUTOINIT
2428 rc = sqlite3_initialize();
2429 if( rc ) return rc;
2430#endif
danielk19771e536952007-08-16 10:09:01 +00002431 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002432 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2433 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002434 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002435 rc = openDatabase(zFilename8, ppDb,
2436 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002437 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002438 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002439 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002440 }
drh40257ff2008-06-13 18:24:27 +00002441 }else{
2442 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002443 }
danielk19777ddad962005-12-12 06:53:03 +00002444 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002445
danielk197754f01982006-01-18 15:25:17 +00002446 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002447}
drh6c626082004-11-14 21:56:29 +00002448#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002449
danielk1977106bb232004-05-21 10:08:53 +00002450/*
danielk1977d8123362004-06-12 09:25:12 +00002451** Register a new collation sequence with the database handle db.
2452*/
danielk19770202b292004-06-09 09:55:16 +00002453int sqlite3_create_collation(
2454 sqlite3* db,
2455 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002456 int enc,
danielk19770202b292004-06-09 09:55:16 +00002457 void* pCtx,
2458 int(*xCompare)(void*,int,const void*,int,const void*)
2459){
danielk19779a30cf62006-01-18 04:26:07 +00002460 int rc;
drhe30f4422007-08-21 16:15:55 +00002461 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002462 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002463 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00002464 rc = sqlite3ApiExit(db, rc);
2465 sqlite3_mutex_leave(db->mutex);
2466 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00002467}
2468
2469/*
2470** Register a new collation sequence with the database handle db.
2471*/
danielk1977a393c032007-05-07 14:58:53 +00002472int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002473 sqlite3* db,
2474 const char *zName,
2475 int enc,
2476 void* pCtx,
2477 int(*xCompare)(void*,int,const void*,int,const void*),
2478 void(*xDel)(void*)
2479){
2480 int rc;
drhe30f4422007-08-21 16:15:55 +00002481 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002482 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002483 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002484 rc = sqlite3ApiExit(db, rc);
2485 sqlite3_mutex_leave(db->mutex);
2486 return rc;
danielk19770202b292004-06-09 09:55:16 +00002487}
2488
drh6c626082004-11-14 21:56:29 +00002489#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002490/*
2491** Register a new collation sequence with the database handle db.
2492*/
danielk19770202b292004-06-09 09:55:16 +00002493int sqlite3_create_collation16(
2494 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002495 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002496 int enc,
danielk19770202b292004-06-09 09:55:16 +00002497 void* pCtx,
2498 int(*xCompare)(void*,int,const void*,int,const void*)
2499){
danielk19779a30cf62006-01-18 04:26:07 +00002500 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002501 char *zName8;
drhe30f4422007-08-21 16:15:55 +00002502 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002503 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002504 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002505 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002506 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002507 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002508 }
drhe30f4422007-08-21 16:15:55 +00002509 rc = sqlite3ApiExit(db, rc);
2510 sqlite3_mutex_leave(db->mutex);
2511 return rc;
danielk19770202b292004-06-09 09:55:16 +00002512}
drh6c626082004-11-14 21:56:29 +00002513#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002514
danielk1977d8123362004-06-12 09:25:12 +00002515/*
2516** Register a collation sequence factory callback with the database handle
2517** db. Replace any previously installed collation sequence factory.
2518*/
danielk19777cedc8d2004-06-10 10:50:08 +00002519int sqlite3_collation_needed(
2520 sqlite3 *db,
2521 void *pCollNeededArg,
2522 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2523){
drhe30f4422007-08-21 16:15:55 +00002524 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002525 db->xCollNeeded = xCollNeeded;
2526 db->xCollNeeded16 = 0;
2527 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002528 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002529 return SQLITE_OK;
2530}
danielk1977d8123362004-06-12 09:25:12 +00002531
drh6c626082004-11-14 21:56:29 +00002532#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002533/*
2534** Register a collation sequence factory callback with the database handle
2535** db. Replace any previously installed collation sequence factory.
2536*/
danielk19777cedc8d2004-06-10 10:50:08 +00002537int sqlite3_collation_needed16(
2538 sqlite3 *db,
2539 void *pCollNeededArg,
2540 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2541){
drhe30f4422007-08-21 16:15:55 +00002542 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002543 db->xCollNeeded = 0;
2544 db->xCollNeeded16 = xCollNeeded16;
2545 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002546 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002547 return SQLITE_OK;
2548}
drh6c626082004-11-14 21:56:29 +00002549#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002550
shaneeec556d2008-10-12 00:27:53 +00002551#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002552/*
danielk19777ddad962005-12-12 06:53:03 +00002553** This function is now an anachronism. It used to be used to recover from a
2554** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002555*/
drh7d97efb2007-10-12 19:35:48 +00002556int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002557 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002558}
2559#endif
drh3e1d8e62005-05-26 16:23:34 +00002560
2561/*
2562** Test to see whether or not the database connection is in autocommit
2563** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2564** by default. Autocommit is disabled by a BEGIN statement and reenabled
2565** by the next COMMIT or ROLLBACK.
2566**
2567******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
2568*/
2569int sqlite3_get_autocommit(sqlite3 *db){
2570 return db->autoCommit;
2571}
drh49285702005-09-17 15:20:26 +00002572
drh49285702005-09-17 15:20:26 +00002573/*
drh9978c972010-02-23 17:36:32 +00002574** The following routines are subtitutes for constants SQLITE_CORRUPT,
2575** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
2576** constants. They server two purposes:
2577**
2578** 1. Serve as a convenient place to set a breakpoint in a debugger
2579** to detect when version error conditions occurs.
2580**
2581** 2. Invoke sqlite3_log() to provide the source code location where
2582** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00002583*/
drh9978c972010-02-23 17:36:32 +00002584int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002585 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00002586 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00002587 "database corruption at line %d of [%.10s]",
2588 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00002589 return SQLITE_CORRUPT;
2590}
drh9978c972010-02-23 17:36:32 +00002591int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002592 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002593 sqlite3_log(SQLITE_MISUSE,
2594 "misuse at line %d of [%.10s]",
2595 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002596 return SQLITE_MISUSE;
2597}
2598int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002599 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002600 sqlite3_log(SQLITE_CANTOPEN,
2601 "cannot open file at line %d of [%.10s]",
2602 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002603 return SQLITE_CANTOPEN;
2604}
2605
drh7c1817e2006-01-10 13:58:48 +00002606
shaneeec556d2008-10-12 00:27:53 +00002607#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00002608/*
2609** This is a convenience routine that makes sure that all thread-specific
2610** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00002611**
2612** SQLite no longer uses thread-specific data so this routine is now a
2613** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00002614*/
2615void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00002616}
shaneeec556d2008-10-12 00:27:53 +00002617#endif
danielk1977deb802c2006-02-09 13:43:28 +00002618
2619/*
2620** Return meta information about a specific column of a database table.
2621** See comment in sqlite3.h (sqlite.h.in) for details.
2622*/
2623#ifdef SQLITE_ENABLE_COLUMN_METADATA
2624int sqlite3_table_column_metadata(
2625 sqlite3 *db, /* Connection handle */
2626 const char *zDbName, /* Database name or NULL */
2627 const char *zTableName, /* Table name */
2628 const char *zColumnName, /* Column name */
2629 char const **pzDataType, /* OUTPUT: Declared data type */
2630 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
2631 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
2632 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00002633 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00002634){
2635 int rc;
2636 char *zErrMsg = 0;
2637 Table *pTab = 0;
2638 Column *pCol = 0;
2639 int iCol;
2640
2641 char const *zDataType = 0;
2642 char const *zCollSeq = 0;
2643 int notnull = 0;
2644 int primarykey = 0;
2645 int autoinc = 0;
2646
2647 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00002648 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00002649 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002650 rc = sqlite3Init(db, &zErrMsg);
2651 if( SQLITE_OK!=rc ){
2652 goto error_out;
2653 }
2654
2655 /* Locate the table in question */
2656 pTab = sqlite3FindTable(db, zTableName, zDbName);
2657 if( !pTab || pTab->pSelect ){
2658 pTab = 0;
2659 goto error_out;
2660 }
2661
2662 /* Find the column for which info is requested */
2663 if( sqlite3IsRowid(zColumnName) ){
2664 iCol = pTab->iPKey;
2665 if( iCol>=0 ){
2666 pCol = &pTab->aCol[iCol];
2667 }
2668 }else{
2669 for(iCol=0; iCol<pTab->nCol; iCol++){
2670 pCol = &pTab->aCol[iCol];
2671 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
2672 break;
2673 }
2674 }
2675 if( iCol==pTab->nCol ){
2676 pTab = 0;
2677 goto error_out;
2678 }
2679 }
2680
2681 /* The following block stores the meta information that will be returned
2682 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
2683 ** and autoinc. At this point there are two possibilities:
2684 **
2685 ** 1. The specified column name was rowid", "oid" or "_rowid_"
2686 ** and there is no explicitly declared IPK column.
2687 **
2688 ** 2. The table is not a view and the column name identified an
2689 ** explicitly declared column. Copy meta information from *pCol.
2690 */
2691 if( pCol ){
2692 zDataType = pCol->zType;
2693 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00002694 notnull = pCol->notNull!=0;
2695 primarykey = pCol->isPrimKey!=0;
drh7d10d5a2008-08-20 16:35:10 +00002696 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00002697 }else{
2698 zDataType = "INTEGER";
2699 primarykey = 1;
2700 }
2701 if( !zCollSeq ){
2702 zCollSeq = "BINARY";
2703 }
2704
2705error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00002706 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002707
2708 /* Whether the function call succeeded or failed, set the output parameters
2709 ** to whatever their local counterparts contain. If an error did occur,
2710 ** this has the effect of zeroing all output parameters.
2711 */
2712 if( pzDataType ) *pzDataType = zDataType;
2713 if( pzCollSeq ) *pzCollSeq = zCollSeq;
2714 if( pNotNull ) *pNotNull = notnull;
2715 if( pPrimaryKey ) *pPrimaryKey = primarykey;
2716 if( pAutoinc ) *pAutoinc = autoinc;
2717
2718 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00002719 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00002720 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00002721 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00002722 rc = SQLITE_ERROR;
2723 }
2724 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002725 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00002726 rc = sqlite3ApiExit(db, rc);
2727 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00002728 return rc;
2729}
drhe30f4422007-08-21 16:15:55 +00002730#endif
drhf9cb7f52006-06-27 20:06:44 +00002731
2732/*
2733** Sleep for a little while. Return the amount of time slept.
2734*/
2735int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00002736 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00002737 int rc;
drhd677b3d2007-08-20 22:48:41 +00002738 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00002739 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00002740
2741 /* This function works in milliseconds, but the underlying OsSleep()
2742 ** API uses microseconds. Hence the 1000's.
2743 */
drhe30f4422007-08-21 16:15:55 +00002744 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00002745 return rc;
drhf9cb7f52006-06-27 20:06:44 +00002746}
drh4ac285a2006-09-15 07:28:50 +00002747
2748/*
2749** Enable or disable the extended result codes.
2750*/
2751int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00002752 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002753 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00002754 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002755 return SQLITE_OK;
2756}
drhcc6bb3e2007-08-31 16:11:35 +00002757
2758/*
2759** Invoke the xFileControl method on a particular database.
2760*/
2761int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
2762 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00002763 Btree *pBtree;
2764
drhcc6bb3e2007-08-31 16:11:35 +00002765 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00002766 pBtree = sqlite3DbNameToBtree(db, zDbName);
2767 if( pBtree ){
2768 Pager *pPager;
2769 sqlite3_file *fd;
2770 sqlite3BtreeEnter(pBtree);
2771 pPager = sqlite3BtreePager(pBtree);
2772 assert( pPager!=0 );
2773 fd = sqlite3PagerFile(pPager);
2774 assert( fd!=0 );
2775 if( op==SQLITE_FCNTL_FILE_POINTER ){
2776 *(sqlite3_file**)pArg = fd;
2777 rc = SQLITE_OK;
2778 }else if( fd->pMethods ){
2779 rc = sqlite3OsFileControl(fd, op, pArg);
2780 }else{
2781 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00002782 }
drh421377e2012-03-15 21:28:54 +00002783 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00002784 }
2785 sqlite3_mutex_leave(db->mutex);
2786 return rc;
2787}
drhed13d982008-01-31 14:43:24 +00002788
2789/*
2790** Interface to the testing logic.
2791*/
2792int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00002793 int rc = 0;
drh3088d592008-03-21 16:45:47 +00002794#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00002795 va_list ap;
drhed13d982008-01-31 14:43:24 +00002796 va_start(ap, op);
2797 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00002798
2799 /*
drh984bfaa2008-03-19 16:08:53 +00002800 ** Save the current state of the PRNG.
2801 */
drh2fa18682008-03-19 14:15:34 +00002802 case SQLITE_TESTCTRL_PRNG_SAVE: {
2803 sqlite3PrngSaveState();
2804 break;
2805 }
drh984bfaa2008-03-19 16:08:53 +00002806
2807 /*
2808 ** Restore the state of the PRNG to the last state saved using
2809 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
2810 ** this verb acts like PRNG_RESET.
2811 */
drh2fa18682008-03-19 14:15:34 +00002812 case SQLITE_TESTCTRL_PRNG_RESTORE: {
2813 sqlite3PrngRestoreState();
2814 break;
2815 }
drh984bfaa2008-03-19 16:08:53 +00002816
2817 /*
2818 ** Reset the PRNG back to its uninitialized state. The next call
2819 ** to sqlite3_randomness() will reseed the PRNG using a single call
2820 ** to the xRandomness method of the default VFS.
2821 */
drh2fa18682008-03-19 14:15:34 +00002822 case SQLITE_TESTCTRL_PRNG_RESET: {
2823 sqlite3PrngResetState();
2824 break;
2825 }
drh3088d592008-03-21 16:45:47 +00002826
2827 /*
2828 ** sqlite3_test_control(BITVEC_TEST, size, program)
2829 **
2830 ** Run a test against a Bitvec object of size. The program argument
2831 ** is an array of integers that defines the test. Return -1 on a
2832 ** memory allocation error, 0 on success, or non-zero for an error.
2833 ** See the sqlite3BitvecBuiltinTest() for additional information.
2834 */
2835 case SQLITE_TESTCTRL_BITVEC_TEST: {
2836 int sz = va_arg(ap, int);
2837 int *aProg = va_arg(ap, int*);
2838 rc = sqlite3BitvecBuiltinTest(sz, aProg);
2839 break;
2840 }
danielk19772d1d86f2008-06-20 14:59:51 +00002841
2842 /*
2843 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
2844 **
2845 ** Register hooks to call to indicate which malloc() failures
2846 ** are benign.
2847 */
2848 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00002849 typedef void (*void_function)(void);
2850 void_function xBenignBegin;
2851 void_function xBenignEnd;
2852 xBenignBegin = va_arg(ap, void_function);
2853 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00002854 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
2855 break;
2856 }
drhc7a3bb92009-02-05 16:31:45 +00002857
2858 /*
drhf3af63f2009-05-09 18:59:42 +00002859 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00002860 **
2861 ** Set the PENDING byte to the value in the argument, if X>0.
2862 ** Make no changes if X==0. Return the value of the pending byte
2863 ** as it existing before this routine was called.
2864 **
2865 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
2866 ** an incompatible database file format. Changing the PENDING byte
2867 ** while any database connection is open results in undefined and
2868 ** dileterious behavior.
2869 */
2870 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00002871 rc = PENDING_BYTE;
2872#ifndef SQLITE_OMIT_WSD
2873 {
2874 unsigned int newVal = va_arg(ap, unsigned int);
2875 if( newVal ) sqlite3PendingByte = newVal;
2876 }
2877#endif
drhc7a3bb92009-02-05 16:31:45 +00002878 break;
2879 }
drhf3af63f2009-05-09 18:59:42 +00002880
2881 /*
2882 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
2883 **
2884 ** This action provides a run-time test to see whether or not
2885 ** assert() was enabled at compile-time. If X is true and assert()
2886 ** is enabled, then the return value is true. If X is true and
2887 ** assert() is disabled, then the return value is zero. If X is
2888 ** false and assert() is enabled, then the assertion fires and the
2889 ** process aborts. If X is false and assert() is disabled, then the
2890 ** return value is zero.
2891 */
2892 case SQLITE_TESTCTRL_ASSERT: {
2893 volatile int x = 0;
2894 assert( (x = va_arg(ap,int))!=0 );
2895 rc = x;
2896 break;
2897 }
2898
2899
2900 /*
2901 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
2902 **
2903 ** This action provides a run-time test to see how the ALWAYS and
2904 ** NEVER macros were defined at compile-time.
2905 **
2906 ** The return value is ALWAYS(X).
2907 **
2908 ** The recommended test is X==2. If the return value is 2, that means
2909 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
2910 ** default setting. If the return value is 1, then ALWAYS() is either
2911 ** hard-coded to true or else it asserts if its argument is false.
2912 ** The first behavior (hard-coded to true) is the case if
2913 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
2914 ** behavior (assert if the argument to ALWAYS() is false) is the case if
2915 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
2916 **
2917 ** The run-time test procedure might look something like this:
2918 **
2919 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
2920 ** // ALWAYS() and NEVER() are no-op pass-through macros
2921 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
2922 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
2923 ** }else{
2924 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
2925 ** }
2926 */
2927 case SQLITE_TESTCTRL_ALWAYS: {
2928 int x = va_arg(ap,int);
2929 rc = ALWAYS(x);
2930 break;
2931 }
drhc046e3e2009-07-15 11:26:44 +00002932
2933 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
2934 **
2935 ** Set the nReserve size to N for the main database on the database
2936 ** connection db.
2937 */
2938 case SQLITE_TESTCTRL_RESERVE: {
2939 sqlite3 *db = va_arg(ap, sqlite3*);
2940 int x = va_arg(ap,int);
2941 sqlite3_mutex_enter(db->mutex);
2942 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
2943 sqlite3_mutex_leave(db->mutex);
2944 break;
2945 }
2946
drh07096f62009-12-22 23:52:32 +00002947 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
2948 **
2949 ** Enable or disable various optimizations for testing purposes. The
2950 ** argument N is a bitmask of optimizations to be disabled. For normal
2951 ** operation N should be 0. The idea is that a test program (like the
2952 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
2953 ** with various optimizations disabled to verify that the same answer
2954 ** is obtained in every case.
2955 */
2956 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
2957 sqlite3 *db = va_arg(ap, sqlite3*);
2958 int x = va_arg(ap,int);
2959 db->flags = (x & SQLITE_OptMask) | (db->flags & ~SQLITE_OptMask);
2960 break;
2961 }
2962
drh0e857732010-01-02 03:21:35 +00002963#ifdef SQLITE_N_KEYWORD
2964 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
2965 **
2966 ** If zWord is a keyword recognized by the parser, then return the
2967 ** number of keywords. Or if zWord is not a keyword, return 0.
2968 **
2969 ** This test feature is only available in the amalgamation since
2970 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
2971 ** is built using separate source files.
2972 */
2973 case SQLITE_TESTCTRL_ISKEYWORD: {
2974 const char *zWord = va_arg(ap, const char*);
2975 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00002976 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00002977 break;
2978 }
2979#endif
2980
drhbadc9802010-08-27 17:16:44 +00002981 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
2982 **
2983 ** Pass pFree into sqlite3ScratchFree().
2984 ** If sz>0 then allocate a scratch buffer into pNew.
2985 */
2986 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
2987 void *pFree, **ppNew;
2988 int sz;
2989 sz = va_arg(ap, int);
2990 ppNew = va_arg(ap, void**);
2991 pFree = va_arg(ap, void*);
2992 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
2993 sqlite3ScratchFree(pFree);
2994 break;
2995 }
2996
danc17d6962011-06-21 12:47:30 +00002997 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
2998 **
2999 ** If parameter onoff is non-zero, configure the wrappers so that all
3000 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3001 ** undo this setting.
3002 */
3003 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3004 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3005 break;
3006 }
3007
drh678a9aa2011-12-10 15:55:01 +00003008#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh7e02e5e2011-12-06 19:44:51 +00003009 /* sqlite3_test_control(SQLITE_TESTCTRL_EXPLAIN_STMT,
3010 ** sqlite3_stmt*,const char**);
3011 **
drh678a9aa2011-12-10 15:55:01 +00003012 ** If compiled with SQLITE_ENABLE_TREE_EXPLAIN, each sqlite3_stmt holds
3013 ** a string that describes the optimized parse tree. This test-control
3014 ** returns a pointer to that string.
drh7e02e5e2011-12-06 19:44:51 +00003015 */
3016 case SQLITE_TESTCTRL_EXPLAIN_STMT: {
3017 sqlite3_stmt *pStmt = va_arg(ap, sqlite3_stmt*);
3018 const char **pzRet = va_arg(ap, const char**);
3019 *pzRet = sqlite3VdbeExplanation((Vdbe*)pStmt);
3020 break;
3021 }
drh678a9aa2011-12-10 15:55:01 +00003022#endif
drh7e02e5e2011-12-06 19:44:51 +00003023
drhed13d982008-01-31 14:43:24 +00003024 }
3025 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003026#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003027 return rc;
drhed13d982008-01-31 14:43:24 +00003028}
drhcc487d12011-05-17 18:53:08 +00003029
3030/*
3031** This is a utility routine, useful to VFS implementations, that checks
3032** to see if a database file was a URI that contained a specific query
3033** parameter, and if so obtains the value of the query parameter.
3034**
3035** The zFilename argument is the filename pointer passed into the xOpen()
3036** method of a VFS implementation. The zParam argument is the name of the
3037** query parameter we seek. This routine returns the value of the zParam
3038** parameter if it exists. If the parameter does not exist, this routine
3039** returns a NULL pointer.
3040*/
3041const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh92913722011-12-23 00:07:33 +00003042 if( zFilename==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003043 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003044 while( zFilename[0] ){
3045 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003046 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003047 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003048 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003049 }
3050 return 0;
3051}
drh283829c2011-11-17 00:56:20 +00003052
3053/*
drh92913722011-12-23 00:07:33 +00003054** Return a boolean value for a query parameter.
3055*/
3056int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3057 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003058 bDflt = bDflt!=0;
3059 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003060}
3061
3062/*
3063** Return a 64-bit integer value for a query parameter.
3064*/
3065sqlite3_int64 sqlite3_uri_int64(
3066 const char *zFilename, /* Filename as passed to xOpen */
3067 const char *zParam, /* URI parameter sought */
3068 sqlite3_int64 bDflt /* return if parameter is missing */
3069){
3070 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3071 sqlite3_int64 v;
3072 if( z && sqlite3Atoi64(z, &v, sqlite3Strlen30(z), SQLITE_UTF8)==SQLITE_OK ){
3073 bDflt = v;
3074 }
3075 return bDflt;
3076}
3077
3078/*
drh421377e2012-03-15 21:28:54 +00003079** Return the Btree pointer identified by zDbName. Return NULL if not found.
3080*/
3081Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3082 int i;
3083 for(i=0; i<db->nDb; i++){
3084 if( db->aDb[i].pBt
3085 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3086 ){
3087 return db->aDb[i].pBt;
3088 }
3089 }
3090 return 0;
3091}
3092
3093/*
drh283829c2011-11-17 00:56:20 +00003094** Return the filename of the database associated with a database
3095** connection.
3096*/
3097const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh421377e2012-03-15 21:28:54 +00003098 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3099 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3100}
3101
3102/*
3103** Return 1 if database is read-only or 0 if read/write. Return -1 if
3104** no such database exists.
3105*/
3106int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
3107 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3108 return pBt ? sqlite3PagerIsreadonly(sqlite3BtreePager(pBt)) : -1;
drh283829c2011-11-17 00:56:20 +00003109}