blob: 41adb0e932a52759545b90c984b299e1aff91d23 [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/*
drh40257ff2008-06-13 18:24:27 +000078** Initialize SQLite.
79**
80** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +000081** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +000082** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
83** this routine will be called automatically by key routines such as
84** sqlite3_open().
85**
86** This routine is a no-op except on its very first call for the process,
87** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +000088**
89** The first thread to call this routine runs the initialization to
90** completion. If subsequent threads call this routine before the first
91** thread has finished the initialization process, then the subsequent
92** threads must block until the first thread finishes with the initialization.
93**
94** The first thread might call this routine recursively. Recursive
95** calls to this routine should not block, of course. Otherwise the
96** initialization process would never complete.
97**
98** Let X be the first thread to enter this routine. Let Y be some other
99** thread. Then while the initial invocation of this routine by X is
100** incomplete, it is required that:
101**
102** * Calls to this routine from Y must block until the outer-most
103** call by X completes.
104**
105** * Recursive calls to this routine from thread X return immediately
106** without blocking.
drh40257ff2008-06-13 18:24:27 +0000107*/
108int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000109 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000110 int rc; /* Result code */
111
112#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000113 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000114 if( rc!=SQLITE_OK ){
115 return rc;
116 }
117#endif
danielk197771bc31c2008-06-26 08:29:34 +0000118
drh93ed56d2008-08-12 15:21:11 +0000119 /* If SQLite is already completely initialized, then this call
120 ** to sqlite3_initialize() should be a no-op. But the initialization
121 ** must be complete. So isInit must not be set until the very end
122 ** of this routine.
123 */
danielk1977075c23a2008-09-01 18:34:20 +0000124 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000125
drh93ed56d2008-08-12 15:21:11 +0000126 /* Make sure the mutex subsystem is initialized. If unable to
127 ** initialize the mutex subsystem, return early with the error.
128 ** If the system is so sick that we are unable to allocate a mutex,
129 ** there is not much SQLite is going to be able to do.
130 **
131 ** The mutex subsystem must take care of serializing its own
132 ** initialization.
133 */
danielk1977d0251742008-06-18 18:57:42 +0000134 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000135 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000136
drh93ed56d2008-08-12 15:21:11 +0000137 /* Initialize the malloc() system and the recursive pInitMutex mutex.
138 ** This operation is protected by the STATIC_MASTER mutex. Note that
139 ** MutexAlloc() is called for a static mutex prior to initializing the
140 ** malloc subsystem - this implies that the allocation of a static
141 ** mutex must not require support from the malloc subsystem.
142 */
drh30ddce62011-10-15 00:16:30 +0000143 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000144 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000145 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000146 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000147 rc = sqlite3MallocInit();
148 }
drh40257ff2008-06-13 18:24:27 +0000149 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000150 sqlite3GlobalConfig.isMallocInit = 1;
151 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000152 sqlite3GlobalConfig.pInitMutex =
153 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000154 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000155 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000156 }
157 }
danielk197777eb5bb2008-09-22 17:22:19 +0000158 }
159 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000160 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000161 }
162 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000163
dane1ab2192009-08-17 15:16:19 +0000164 /* If rc is not SQLITE_OK at this point, then either the malloc
165 ** subsystem could not be initialized or the system failed to allocate
166 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000167 if( rc!=SQLITE_OK ){
168 return rc;
169 }
170
171 /* Do the rest of the initialization under the recursive mutex so
172 ** that we will be able to handle recursive calls into
173 ** sqlite3_initialize(). The recursive calls normally come through
174 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
175 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000176 **
177 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
178 ** to the xInit method, so the xInit method need not be threadsafe.
179 **
180 ** The following mutex is what serializes access to the appdef pcache xInit
181 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
182 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000183 */
danielk1977075c23a2008-09-01 18:34:20 +0000184 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000185 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000186 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000187 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000188 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000189 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000190 if( sqlite3GlobalConfig.isPCacheInit==0 ){
191 rc = sqlite3PcacheInitialize();
192 }
danielk19778c0a7912008-08-20 14:49:23 +0000193 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000194 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000195 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000196 }
197 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000198 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
199 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000200 sqlite3GlobalConfig.isInit = 1;
danielk19778c0a7912008-08-20 14:49:23 +0000201 }
danielk1977502b4e02008-09-02 14:07:24 +0000202 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000203 }
danielk1977075c23a2008-09-01 18:34:20 +0000204 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000205
drh93ed56d2008-08-12 15:21:11 +0000206 /* Go back under the static mutex and clean up the recursive
207 ** mutex to prevent a resource leak.
208 */
209 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000210 sqlite3GlobalConfig.nRefInitMutex--;
211 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
212 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
213 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
214 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000215 }
216 sqlite3_mutex_leave(pMaster);
217
218 /* The following is just a sanity check to make sure SQLite has
219 ** been compiled correctly. It is important to run this code, but
220 ** we don't want to run it too often and soak up CPU cycles for no
221 ** reason. So we run it once during initialization.
222 */
shanedfb7b372008-07-22 05:13:30 +0000223#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000224#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000225 /* This section of code's only "output" is via assert() statements. */
226 if ( rc==SQLITE_OK ){
227 u64 x = (((u64)1)<<63)-1;
228 double y;
229 assert(sizeof(x)==8);
230 assert(sizeof(x)==sizeof(y));
231 memcpy(&y, &x, 8);
232 assert( sqlite3IsNaN(y) );
233 }
234#endif
shanefbd60f82009-02-04 03:59:25 +0000235#endif
shanedfb7b372008-07-22 05:13:30 +0000236
drhe4cf0b32011-08-25 00:14:41 +0000237 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
238 ** compile-time option.
239 */
240#ifdef SQLITE_EXTRA_INIT
241 if( rc==SQLITE_OK && sqlite3GlobalConfig.isInit ){
drhc7f94622011-12-13 18:22:38 +0000242 int SQLITE_EXTRA_INIT(const char*);
243 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000244 }
245#endif
246
drh40257ff2008-06-13 18:24:27 +0000247 return rc;
248}
249
250/*
251** Undo the effects of sqlite3_initialize(). Must not be called while
252** there are outstanding database connections or memory allocations or
253** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000254** routine is not threadsafe. But it is safe to invoke this routine
255** on when SQLite is already shut down. If SQLite is already shut down
256** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000257*/
258int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000259 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000260#ifdef SQLITE_EXTRA_SHUTDOWN
261 void SQLITE_EXTRA_SHUTDOWN(void);
262 SQLITE_EXTRA_SHUTDOWN();
263#endif
drha7640922009-04-21 12:02:56 +0000264 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000265 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000266 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000267 }
dane1ab2192009-08-17 15:16:19 +0000268 if( sqlite3GlobalConfig.isPCacheInit ){
269 sqlite3PcacheShutdown();
270 sqlite3GlobalConfig.isPCacheInit = 0;
271 }
272 if( sqlite3GlobalConfig.isMallocInit ){
273 sqlite3MallocEnd();
274 sqlite3GlobalConfig.isMallocInit = 0;
275 }
276 if( sqlite3GlobalConfig.isMutexInit ){
277 sqlite3MutexEnd();
278 sqlite3GlobalConfig.isMutexInit = 0;
279 }
280
drh40257ff2008-06-13 18:24:27 +0000281 return SQLITE_OK;
282}
283
284/*
285** This API allows applications to modify the global configuration of
286** the SQLite library at run-time.
287**
288** This routine should only be called when there are no outstanding
289** database connections or memory allocations. This routine is not
290** threadsafe. Failure to heed these warnings can lead to unpredictable
291** behavior.
292*/
293int sqlite3_config(int op, ...){
294 va_list ap;
295 int rc = SQLITE_OK;
296
297 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
298 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000299 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000300
301 va_start(ap, op);
302 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000303
304 /* Mutex configuration options are only available in a threadsafe
305 ** compile.
306 */
drhd68eee02009-12-11 03:44:18 +0000307#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000308 case SQLITE_CONFIG_SINGLETHREAD: {
309 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000310 sqlite3GlobalConfig.bCoreMutex = 0;
311 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000312 break;
313 }
314 case SQLITE_CONFIG_MULTITHREAD: {
315 /* Disable mutexing of database connections */
316 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000317 sqlite3GlobalConfig.bCoreMutex = 1;
318 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000319 break;
320 }
321 case SQLITE_CONFIG_SERIALIZED: {
322 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000323 sqlite3GlobalConfig.bCoreMutex = 1;
324 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000325 break;
326 }
drh18472fa2008-10-07 15:25:48 +0000327 case SQLITE_CONFIG_MUTEX: {
328 /* Specify an alternative mutex implementation */
329 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
330 break;
331 }
332 case SQLITE_CONFIG_GETMUTEX: {
333 /* Retrieve the current mutex implementation */
334 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
335 break;
336 }
337#endif
338
339
drh40257ff2008-06-13 18:24:27 +0000340 case SQLITE_CONFIG_MALLOC: {
341 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000342 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000343 break;
344 }
drh33589792008-06-18 13:27:46 +0000345 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000346 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000347 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
348 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000349 break;
350 }
drhfec00ea2008-06-14 16:56:21 +0000351 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000352 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000353 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000354 break;
355 }
drh33589792008-06-18 13:27:46 +0000356 case SQLITE_CONFIG_SCRATCH: {
357 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000358 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
359 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
360 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000361 break;
362 }
363 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000364 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000365 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
366 sqlite3GlobalConfig.szPage = va_arg(ap, int);
367 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000368 break;
369 }
danielk19775099be52008-06-27 13:27:03 +0000370
danielk1977bc2ca9e2008-11-13 14:28:28 +0000371 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000372 /* no-op */
373 break;
374 }
375 case SQLITE_CONFIG_GETPCACHE: {
376 /* now an error */
377 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000378 break;
379 }
380
dan22e21ff2011-11-08 20:08:44 +0000381 case SQLITE_CONFIG_PCACHE2: {
382 /* Specify an alternative page cache implementation */
383 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
384 break;
385 }
386 case SQLITE_CONFIG_GETPCACHE2: {
387 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000388 sqlite3PCacheSetDefault();
389 }
dan22e21ff2011-11-08 20:08:44 +0000390 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000391 break;
392 }
393
drh5d414832008-07-15 14:47:18 +0000394#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000395 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000396 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000397 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
398 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
399 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000400
shaneha6ec8922011-03-09 21:36:17 +0000401 if( sqlite3GlobalConfig.mnReq<1 ){
402 sqlite3GlobalConfig.mnReq = 1;
403 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
404 /* cap min request size at 2^12 */
405 sqlite3GlobalConfig.mnReq = (1<<12);
406 }
407
danielk1977075c23a2008-09-01 18:34:20 +0000408 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000409 /* If the heap pointer is NULL, then restore the malloc implementation
410 ** back to NULL pointers too. This will cause the malloc to go
411 ** back to its default implementation when sqlite3_initialize() is
412 ** run.
413 */
danielk1977075c23a2008-09-01 18:34:20 +0000414 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000415 }else{
416 /* The heap pointer is not NULL, then install one of the
417 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
418 ** ENABLE_MEMSYS5 is defined, return an error.
drh8a42cbd2008-07-10 18:13:42 +0000419 */
danielk19775099be52008-06-27 13:27:03 +0000420#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000421 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000422#endif
423#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000424 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000425#endif
drh8a42cbd2008-07-10 18:13:42 +0000426 }
danielk19775099be52008-06-27 13:27:03 +0000427 break;
428 }
drh5d414832008-07-15 14:47:18 +0000429#endif
danielk19775099be52008-06-27 13:27:03 +0000430
drh633e6d52008-07-28 19:34:53 +0000431 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000432 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
433 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000434 break;
435 }
drh3f280702010-02-18 18:45:09 +0000436
437 /* Record a pointer to the logger funcction and its first argument.
438 ** The default is NULL. Logging is disabled if the function pointer is
439 ** NULL.
440 */
441 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000442 /* MSVC is picky about pulling func ptrs from va lists.
443 ** http://support.microsoft.com/kb/47961
444 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
445 */
446 typedef void(*LOGFUNC_t)(void*,int,const char*);
447 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000448 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
449 break;
450 }
drh633e6d52008-07-28 19:34:53 +0000451
dancd74b612011-04-22 19:37:32 +0000452 case SQLITE_CONFIG_URI: {
453 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
454 break;
455 }
456
drh40257ff2008-06-13 18:24:27 +0000457 default: {
458 rc = SQLITE_ERROR;
459 break;
460 }
461 }
462 va_end(ap);
463 return rc;
464}
465
466/*
drh633e6d52008-07-28 19:34:53 +0000467** Set up the lookaside buffers for a database connection.
468** Return SQLITE_OK on success.
469** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000470**
471** The sz parameter is the number of bytes in each lookaside slot.
472** The cnt parameter is the number of slots. If pStart is NULL the
473** space for the lookaside memory is obtained from sqlite3_malloc().
474** If pStart is not NULL then it is sz*cnt bytes of memory to use for
475** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000476*/
drhe9d1c722008-08-04 20:13:26 +0000477static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000478 void *pStart;
479 if( db->lookaside.nOut ){
480 return SQLITE_BUSY;
481 }
shanef71f89e2009-01-30 06:11:54 +0000482 /* Free any existing lookaside buffer for this handle before
483 ** allocating a new one so we don't have to have space for
484 ** both at the same time.
485 */
486 if( db->lookaside.bMalloced ){
487 sqlite3_free(db->lookaside.pStart);
488 }
drh61a4bd52011-11-10 02:39:28 +0000489 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
490 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000491 */
drh61a4bd52011-11-10 02:39:28 +0000492 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000493 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000494 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000495 if( sz==0 || cnt==0 ){
496 sz = 0;
497 pStart = 0;
498 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000499 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000500 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000501 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000502 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000503 }else{
504 pStart = pBuf;
505 }
drh4cfb22f2008-08-01 18:47:01 +0000506 db->lookaside.pStart = pStart;
507 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000508 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000509 if( pStart ){
510 int i;
511 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000512 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000513 p = (LookasideSlot*)pStart;
514 for(i=cnt-1; i>=0; i--){
515 p->pNext = db->lookaside.pFree;
516 db->lookaside.pFree = p;
517 p = (LookasideSlot*)&((u8*)p)[sz];
518 }
519 db->lookaside.pEnd = p;
520 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000521 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000522 }else{
523 db->lookaside.pEnd = 0;
524 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000525 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000526 }
527 return SQLITE_OK;
528}
529
530/*
drh4413d0e2008-11-04 13:46:27 +0000531** Return the mutex associated with a database connection.
532*/
533sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
534 return db->mutex;
535}
536
537/*
drh09419b42011-11-16 19:29:17 +0000538** Free up as much memory as we can from the given database
539** connection.
540*/
541int sqlite3_db_release_memory(sqlite3 *db){
542 int i;
dand9bb3a92011-12-30 11:43:59 +0000543 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000544 sqlite3BtreeEnterAll(db);
545 for(i=0; i<db->nDb; i++){
546 Btree *pBt = db->aDb[i].pBt;
547 if( pBt ){
548 Pager *pPager = sqlite3BtreePager(pBt);
549 sqlite3PagerShrink(pPager);
550 }
551 }
552 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000553 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000554 return SQLITE_OK;
555}
556
557/*
drh633e6d52008-07-28 19:34:53 +0000558** Configuration settings for an individual database connection
559*/
560int sqlite3_db_config(sqlite3 *db, int op, ...){
561 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000562 int rc;
drh633e6d52008-07-28 19:34:53 +0000563 va_start(ap, op);
564 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000565 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000566 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000567 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
568 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000569 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000570 break;
571 }
drh6480aad2008-08-01 16:31:14 +0000572 default: {
drhe83cafd2011-03-21 17:15:58 +0000573 static const struct {
574 int op; /* The opcode */
575 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
576 } aFlagOp[] = {
577 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
578 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
579 };
drh58ad5802011-03-23 22:02:23 +0000580 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000581 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000582 for(i=0; i<ArraySize(aFlagOp); i++){
583 if( aFlagOp[i].op==op ){
584 int onoff = va_arg(ap, int);
585 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000586 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000587 if( onoff>0 ){
588 db->flags |= aFlagOp[i].mask;
589 }else if( onoff==0 ){
590 db->flags &= ~aFlagOp[i].mask;
591 }
592 if( oldFlags!=db->flags ){
593 sqlite3ExpirePreparedStatements(db);
594 }
595 if( pRes ){
596 *pRes = (db->flags & aFlagOp[i].mask)!=0;
597 }
598 rc = SQLITE_OK;
599 break;
600 }
601 }
drh6480aad2008-08-01 16:31:14 +0000602 break;
603 }
drh633e6d52008-07-28 19:34:53 +0000604 }
605 va_end(ap);
606 return rc;
607}
608
drha16313e2007-03-30 11:29:32 +0000609
610/*
drh9b5adfa2008-01-20 23:19:56 +0000611** Return true if the buffer z[0..n-1] contains all spaces.
612*/
613static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000614 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000615 return n==0;
616}
617
618/*
drhd3d39e92004-05-20 22:16:29 +0000619** This is the default collating function named "BINARY" which is always
620** available.
drh9b5adfa2008-01-20 23:19:56 +0000621**
622** If the padFlag argument is not NULL then space padding at the end
623** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000624*/
danielk19772c336542005-01-13 02:14:23 +0000625static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000626 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000627 int nKey1, const void *pKey1,
628 int nKey2, const void *pKey2
629){
630 int rc, n;
631 n = nKey1<nKey2 ? nKey1 : nKey2;
632 rc = memcmp(pKey1, pKey2, n);
633 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000634 if( padFlag
635 && allSpaces(((char*)pKey1)+n, nKey1-n)
636 && allSpaces(((char*)pKey2)+n, nKey2-n)
637 ){
638 /* Leave rc unchanged at 0 */
639 }else{
640 rc = nKey1 - nKey2;
641 }
drhd3d39e92004-05-20 22:16:29 +0000642 }
643 return rc;
644}
645
646/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000647** Another built-in collating sequence: NOCASE.
648**
649** This collating sequence is intended to be used for "case independant
650** comparison". SQLite's knowledge of upper and lower case equivalents
651** extends only to the 26 characters used in the English language.
652**
653** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000654*/
655static int nocaseCollatingFunc(
656 void *NotUsed,
657 int nKey1, const void *pKey1,
658 int nKey2, const void *pKey2
659){
660 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000661 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000662 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000663 if( 0==r ){
664 r = nKey1-nKey2;
665 }
666 return r;
667}
668
669/*
drhaf9ff332002-01-16 21:00:27 +0000670** Return the ROWID of the most recent insert
671*/
drh9bb575f2004-09-06 17:24:11 +0000672sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000673 return db->lastRowid;
674}
675
676/*
danielk197724b03fd2004-05-10 10:34:34 +0000677** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000678*/
drh9bb575f2004-09-06 17:24:11 +0000679int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000680 return db->nChange;
681}
682
rdcf146a772004-02-25 22:51:06 +0000683/*
danielk1977b28af712004-06-21 06:50:26 +0000684** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000685*/
danielk1977b28af712004-06-21 06:50:26 +0000686int sqlite3_total_changes(sqlite3 *db){
687 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000688}
689
drhc8d30ac2002-04-12 10:08:59 +0000690/*
danielk1977fd7f0452008-12-17 17:30:26 +0000691** Close all open savepoints. This function only manipulates fields of the
692** database handle object, it does not close any savepoints that may be open
693** at the b-tree/pager level.
694*/
695void sqlite3CloseSavepoints(sqlite3 *db){
696 while( db->pSavepoint ){
697 Savepoint *pTmp = db->pSavepoint;
698 db->pSavepoint = pTmp->pNext;
699 sqlite3DbFree(db, pTmp);
700 }
701 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000702 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000703 db->isTransactionSavepoint = 0;
704}
705
706/*
dand2199f02010-08-27 17:48:52 +0000707** Invoke the destructor function associated with FuncDef p, if any. Except,
708** if this is not the last copy of the function, do not invoke it. Multiple
709** copies of a single function are created when create_function() is called
710** with SQLITE_ANY as the encoding.
711*/
712static void functionDestroy(sqlite3 *db, FuncDef *p){
713 FuncDestructor *pDestructor = p->pDestructor;
714 if( pDestructor ){
715 pDestructor->nRef--;
716 if( pDestructor->nRef==0 ){
717 pDestructor->xDestroy(pDestructor->pUserData);
718 sqlite3DbFree(db, pDestructor);
719 }
720 }
721}
722
723/*
danbba02a92012-05-15 17:15:34 +0000724** Disconnect all sqlite3_vtab objects that belong to database connection
725** db. This is called when db is being closed.
726*/
727static void disconnectAllVtab(sqlite3 *db){
728#ifndef SQLITE_OMIT_VIRTUALTABLE
729 int i;
730 sqlite3BtreeEnterAll(db);
731 for(i=0; i<db->nDb; i++){
732 Schema *pSchema = db->aDb[i].pSchema;
733 if( db->aDb[i].pSchema ){
734 HashElem *p;
735 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
736 Table *pTab = (Table *)sqliteHashData(p);
737 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
738 }
739 }
740 }
741 sqlite3BtreeLeaveAll(db);
742#else
743 UNUSED_PARAMETER(db);
744#endif
745}
746
747/*
drh50e5dad2001-09-15 00:57:28 +0000748** Close an existing SQLite database
749*/
drh9bb575f2004-09-06 17:24:11 +0000750int sqlite3_close(sqlite3 *db){
dand2199f02010-08-27 17:48:52 +0000751 HashElem *i; /* Hash table iterator */
drh001bbcb2003-03-19 03:14:00 +0000752 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000753
754 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000755 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000756 }
drh7e8b8482008-01-23 03:03:05 +0000757 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000758 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000759 }
drh605264d2007-08-21 15:13:19 +0000760 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000761
danbba02a92012-05-15 17:15:34 +0000762 /* Force xDisconnect calls on all virtual tables */
763 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000764
danbba02a92012-05-15 17:15:34 +0000765 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000766 ** will not have called the xDisconnect() method on any virtual
767 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
768 ** call will do so. We need to do this before the check for active
769 ** SQL statements below, as the v-table implementation may be storing
770 ** some prepared statements internally.
771 */
772 sqlite3VtabRollback(db);
773
danielk1977a04a34f2007-04-16 15:06:25 +0000774 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +0000775 if( db->pVdbe ){
776 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +0000777 "unable to close due to unfinalised statements");
drh27641702007-08-22 02:56:42 +0000778 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000779 return SQLITE_BUSY;
780 }
drh7e8b8482008-01-23 03:03:05 +0000781 assert( sqlite3SafetyCheckSickOrOk(db) );
danielk1977e0048402004-06-15 16:51:01 +0000782
danielk197704103022009-02-03 16:51:24 +0000783 for(j=0; j<db->nDb; j++){
784 Btree *pBt = db->aDb[j].pBt;
785 if( pBt && sqlite3BtreeIsInBackup(pBt) ){
786 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +0000787 "unable to close due to unfinished backup operation");
danielk197704103022009-02-03 16:51:24 +0000788 sqlite3_mutex_leave(db->mutex);
789 return SQLITE_BUSY;
790 }
791 }
792
danielk1977fd7f0452008-12-17 17:30:26 +0000793 /* Free any outstanding Savepoint structures. */
794 sqlite3CloseSavepoints(db);
795
drh5efb3142012-05-16 01:24:34 +0000796 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000797 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000798 struct Db *pDb = &db->aDb[j];
799 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000800 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000801 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000802 if( j!=1 ){
803 pDb->pSchema = 0;
804 }
drh113088e2003-03-20 01:16:58 +0000805 }
drhf57b3392001-10-08 13:22:32 +0000806 }
drh5efb3142012-05-16 01:24:34 +0000807 /* Clear the TEMP schema separately and last */
808 if( db->aDb[1].pSchema ){
809 sqlite3SchemaClear(db->aDb[1].pSchema);
810 }
811 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000812
drh5efb3142012-05-16 01:24:34 +0000813 /* Free up the array of auxiliary databases */
814 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000815 assert( db->nDb<=2 );
816 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000817
818 /* Tell the code in notify.c that the connection no longer holds any
819 ** locks and does not require any further unlock-notify callbacks.
820 */
821 sqlite3ConnectionClosed(db);
822
drh70a8ca32008-08-21 18:49:27 +0000823 for(j=0; j<ArraySize(db->aFunc.a); j++){
824 FuncDef *pNext, *pHash, *p;
825 for(p=db->aFunc.a[j]; p; p=pHash){
826 pHash = p->pHash;
827 while( p ){
dand2199f02010-08-27 17:48:52 +0000828 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000829 pNext = p->pNext;
830 sqlite3DbFree(db, p);
831 p = pNext;
832 }
drh8e0a2f92002-02-23 23:45:45 +0000833 }
834 }
danielk1977d8123362004-06-12 09:25:12 +0000835 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000836 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000837 /* Invoke any destructors registered for collation sequence user data. */
838 for(j=0; j<3; j++){
839 if( pColl[j].xDel ){
840 pColl[j].xDel(pColl[j].pUser);
841 }
842 }
drh633e6d52008-07-28 19:34:53 +0000843 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000844 }
danielk1977d8123362004-06-12 09:25:12 +0000845 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000846#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000847 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
848 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000849 if( pMod->xDestroy ){
850 pMod->xDestroy(pMod->pAux);
851 }
drh633e6d52008-07-28 19:34:53 +0000852 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000853 }
drhb9bb7c12006-06-11 23:41:55 +0000854 sqlite3HashClear(&db->aModule);
855#endif
danielk1977466be562004-06-10 02:16:01 +0000856
danielk19776622cce2004-05-20 11:00:52 +0000857 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000858 if( db->pErr ){
859 sqlite3ValueFree(db->pErr);
860 }
drhf1952c52006-06-08 15:48:00 +0000861 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000862
863 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000864
865 /* The temp-database schema is allocated differently from the other schema
866 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
867 ** So it needs to be freed here. Todo: Why not roll the temp schema into
868 ** the same sqliteMalloc() as the one that allocates the database
869 ** structure?
870 */
drh633e6d52008-07-28 19:34:53 +0000871 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000872 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000873 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000874 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +0000875 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +0000876 if( db->lookaside.bMalloced ){
877 sqlite3_free(db->lookaside.pStart);
878 }
drh17435752007-08-16 04:30:38 +0000879 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000880 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000881}
882
883/*
drh0f198a72012-02-13 16:43:16 +0000884** Rollback all database files. If tripCode is not SQLITE_OK, then
885** any open cursors are invalidated ("tripped" - as in "tripping a circuit
886** breaker") and made to return tripCode if there are any further
887** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +0000888*/
drh0f198a72012-02-13 16:43:16 +0000889void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +0000890 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000891 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000892 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +0000893 sqlite3BeginBenignMalloc();
drh001bbcb2003-03-19 03:14:00 +0000894 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +0000895 Btree *p = db->aDb[i].pBt;
896 if( p ){
897 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000898 inTrans = 1;
899 }
drh0f198a72012-02-13 16:43:16 +0000900 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +0000901 db->aDb[i].inTrans = 0;
902 }
903 }
danielk1977a298e902006-06-22 09:53:48 +0000904 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +0000905 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000906
danielk197771fd80b2005-12-16 06:54:01 +0000907 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000908 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +0000909 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +0000910 }
911
dan1da40a32009-09-19 17:00:31 +0000912 /* Any deferred constraint violations have now been resolved. */
913 db->nDeferredCons = 0;
914
danielk197771fd80b2005-12-16 06:54:01 +0000915 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000916 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000917 db->xRollbackCallback(db->pRollbackArg);
918 }
drh001bbcb2003-03-19 03:14:00 +0000919}
920
921/*
drhc22bd472002-05-10 13:14:07 +0000922** Return a static string that describes the kind of error specified in the
923** argument.
drh247be432002-05-10 05:44:55 +0000924*/
danielk1977f20b21c2004-05-31 23:56:42 +0000925const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +0000926 static const char* const aMsg[] = {
927 /* SQLITE_OK */ "not an error",
928 /* SQLITE_ERROR */ "SQL logic error or missing database",
929 /* SQLITE_INTERNAL */ 0,
930 /* SQLITE_PERM */ "access permission denied",
931 /* SQLITE_ABORT */ "callback requested query abort",
932 /* SQLITE_BUSY */ "database is locked",
933 /* SQLITE_LOCKED */ "database table is locked",
934 /* SQLITE_NOMEM */ "out of memory",
935 /* SQLITE_READONLY */ "attempt to write a readonly database",
936 /* SQLITE_INTERRUPT */ "interrupted",
937 /* SQLITE_IOERR */ "disk I/O error",
938 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +0000939 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +0000940 /* SQLITE_FULL */ "database or disk is full",
941 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +0000942 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +0000943 /* SQLITE_EMPTY */ "table contains no data",
944 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +0000945 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +0000946 /* SQLITE_CONSTRAINT */ "constraint failed",
947 /* SQLITE_MISMATCH */ "datatype mismatch",
948 /* SQLITE_MISUSE */ "library routine called out of sequence",
949 /* SQLITE_NOLFS */ "large file support is disabled",
950 /* SQLITE_AUTH */ "authorization denied",
951 /* SQLITE_FORMAT */ "auxiliary database format error",
952 /* SQLITE_RANGE */ "bind or column index out of range",
953 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
954 };
drh21021a52012-02-13 17:01:51 +0000955 const char *zErr = "unknown error";
956 switch( rc ){
957 case SQLITE_ABORT_ROLLBACK: {
958 zErr = "abort due to ROLLBACK";
959 break;
960 }
961 default: {
962 rc &= 0xff;
963 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
964 zErr = aMsg[rc];
965 }
966 break;
967 }
drh247be432002-05-10 05:44:55 +0000968 }
drh21021a52012-02-13 17:01:51 +0000969 return zErr;
drh247be432002-05-10 05:44:55 +0000970}
971
972/*
drh2dfbbca2000-07-28 14:32:48 +0000973** This routine implements a busy callback that sleeps and tries
974** again until a timeout value is reached. The timeout value is
975** an integer number of milliseconds passed in as the first
976** argument.
977*/
drhdaffd0e2001-04-11 14:28:42 +0000978static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000979 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000980 int count /* Number of times table has been busy */
981){
danielk197729bafea2008-06-26 10:41:19 +0000982#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000983 static const u8 delays[] =
984 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
985 static const u8 totals[] =
986 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +0000987# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +0000988 sqlite3 *db = (sqlite3 *)ptr;
989 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000990 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000991
drhee570fa2005-04-28 12:06:05 +0000992 assert( count>=0 );
993 if( count < NDELAY ){
994 delay = delays[count];
995 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000996 }else{
997 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000998 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000999 }
drhd1bec472004-01-15 13:29:31 +00001000 if( prior + delay > timeout ){
1001 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001002 if( delay<=0 ) return 0;
1003 }
danielk19772a6bdf62007-08-20 16:07:00 +00001004 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001005 return 1;
1006#else
drh482ea182007-08-20 11:12:40 +00001007 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001008 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001009 if( (count+1)*1000 > timeout ){
1010 return 0;
1011 }
drh482ea182007-08-20 11:12:40 +00001012 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001013 return 1;
1014#endif
1015}
1016
1017/*
drha4afb652005-07-09 02:16:02 +00001018** Invoke the given busy handler.
1019**
1020** This routine is called when an operation failed with a lock.
1021** If this routine returns non-zero, the lock is retried. If it
1022** returns 0, the operation aborts with an SQLITE_BUSY error.
1023*/
1024int sqlite3InvokeBusyHandler(BusyHandler *p){
1025 int rc;
drh34004ce2008-07-11 16:15:17 +00001026 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001027 rc = p->xFunc(p->pArg, p->nBusy);
1028 if( rc==0 ){
1029 p->nBusy = -1;
1030 }else{
1031 p->nBusy++;
1032 }
1033 return rc;
1034}
1035
1036/*
drh2dfbbca2000-07-28 14:32:48 +00001037** This routine sets the busy callback for an Sqlite database to the
1038** given callback function with the given argument.
1039*/
danielk1977f9d64d22004-06-19 08:18:07 +00001040int sqlite3_busy_handler(
1041 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001042 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001043 void *pArg
1044){
drhe30f4422007-08-21 16:15:55 +00001045 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001046 db->busyHandler.xFunc = xBusy;
1047 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001048 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +00001049 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001050 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001051}
1052
danielk1977348bb5d2003-10-18 09:37:26 +00001053#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1054/*
1055** This routine sets the progress callback for an Sqlite database to the
1056** given callback function with the given argument. The progress callback will
1057** be invoked every nOps opcodes.
1058*/
danielk197724b03fd2004-05-10 10:34:34 +00001059void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001060 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001061 int nOps,
1062 int (*xProgress)(void*),
1063 void *pArg
1064){
drhbd0b1b52008-07-07 19:52:09 +00001065 sqlite3_mutex_enter(db->mutex);
1066 if( nOps>0 ){
1067 db->xProgress = xProgress;
1068 db->nProgressOps = nOps;
1069 db->pProgressArg = pArg;
1070 }else{
1071 db->xProgress = 0;
1072 db->nProgressOps = 0;
1073 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001074 }
drhbd0b1b52008-07-07 19:52:09 +00001075 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001076}
1077#endif
1078
1079
drh2dfbbca2000-07-28 14:32:48 +00001080/*
1081** This routine installs a default busy handler that waits for the
1082** specified number of milliseconds before returning 0.
1083*/
danielk1977f9d64d22004-06-19 08:18:07 +00001084int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +00001085 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001086 db->busyTimeout = ms;
1087 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +00001088 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001089 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001090 }
danielk1977f9d64d22004-06-19 08:18:07 +00001091 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001092}
drh4c504392000-10-16 22:06:40 +00001093
1094/*
1095** Cause any pending operation to stop at its earliest opportunity.
1096*/
drh9bb575f2004-09-06 17:24:11 +00001097void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +00001098 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001099}
drhfa86c412002-02-02 15:01:15 +00001100
drhfa86c412002-02-02 15:01:15 +00001101
1102/*
danielk1977771151b2006-01-17 13:21:40 +00001103** This function is exactly the same as sqlite3_create_function(), except
1104** that it is designed to be called by internal code. The difference is
1105** that if a malloc() fails in sqlite3_create_function(), an error code
1106** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001107*/
danielk1977771151b2006-01-17 13:21:40 +00001108int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001109 sqlite3 *db,
1110 const char *zFunctionName,
1111 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001112 int enc,
danielk197765904932004-05-26 06:18:37 +00001113 void *pUserData,
1114 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1115 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001116 void (*xFinal)(sqlite3_context*),
1117 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001118){
drh0bce8352002-02-28 00:41:10 +00001119 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001120 int nName;
danielk197765904932004-05-26 06:18:37 +00001121
drhe30f4422007-08-21 16:15:55 +00001122 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001123 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001124 (xFunc && (xFinal || xStep)) ||
1125 (!xFunc && (xFinal && !xStep)) ||
1126 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001127 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001128 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001129 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001130 }
danielk1977d8123362004-06-12 09:25:12 +00001131
danielk197793758c82005-01-21 08:13:14 +00001132#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001133 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1134 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1135 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1136 **
1137 ** If SQLITE_ANY is specified, add three versions of the function
1138 ** to the hash table.
1139 */
1140 if( enc==SQLITE_UTF16 ){
1141 enc = SQLITE_UTF16NATIVE;
1142 }else if( enc==SQLITE_ANY ){
1143 int rc;
danielk1977771151b2006-01-17 13:21:40 +00001144 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
dand2199f02010-08-27 17:48:52 +00001145 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001146 if( rc==SQLITE_OK ){
1147 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
dand2199f02010-08-27 17:48:52 +00001148 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001149 }
1150 if( rc!=SQLITE_OK ){
1151 return rc;
1152 }
danielk1977d8123362004-06-12 09:25:12 +00001153 enc = SQLITE_UTF16BE;
1154 }
danielk197793758c82005-01-21 08:13:14 +00001155#else
1156 enc = SQLITE_UTF8;
1157#endif
danielk19779636c4e2005-01-25 04:27:54 +00001158
1159 /* Check if an existing function is being overridden or deleted. If so,
1160 ** and there are active VMs, then return SQLITE_BUSY. If a function
1161 ** is being overridden/deleted but there are no active VMs, allow the
1162 ** operation to continue but invalidate all precompiled statements.
1163 */
drh3abbd392008-12-10 23:04:13 +00001164 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001165 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
1166 if( db->activeVdbeCnt ){
1167 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001168 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001169 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001170 return SQLITE_BUSY;
1171 }else{
1172 sqlite3ExpirePreparedStatements(db);
1173 }
1174 }
danielk197765904932004-05-26 06:18:37 +00001175
drh3abbd392008-12-10 23:04:13 +00001176 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001177 assert(p || db->mallocFailed);
1178 if( !p ){
1179 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001180 }
dand2199f02010-08-27 17:48:52 +00001181
1182 /* If an older version of the function with a configured destructor is
1183 ** being replaced invoke the destructor function here. */
1184 functionDestroy(db, p);
1185
1186 if( pDestructor ){
1187 pDestructor->nRef++;
1188 }
1189 p->pDestructor = pDestructor;
danielk1977fa18bec2007-09-03 11:04:22 +00001190 p->flags = 0;
1191 p->xFunc = xFunc;
1192 p->xStep = xStep;
1193 p->xFinalize = xFinal;
1194 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001195 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001196 return SQLITE_OK;
1197}
danielk1977771151b2006-01-17 13:21:40 +00001198
1199/*
1200** Create new user functions.
1201*/
1202int sqlite3_create_function(
1203 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001204 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001205 int nArg,
1206 int enc,
1207 void *p,
1208 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1209 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1210 void (*xFinal)(sqlite3_context*)
1211){
drh7b19fac2010-08-27 18:44:54 +00001212 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1213 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001214}
1215
1216int sqlite3_create_function_v2(
1217 sqlite3 *db,
1218 const char *zFunc,
1219 int nArg,
1220 int enc,
1221 void *p,
1222 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1223 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1224 void (*xFinal)(sqlite3_context*),
1225 void (*xDestroy)(void *)
1226){
shanehbd2aaf92010-09-01 02:38:21 +00001227 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001228 FuncDestructor *pArg = 0;
1229 sqlite3_mutex_enter(db->mutex);
1230 if( xDestroy ){
1231 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001232 if( !pArg ){
1233 xDestroy(p);
1234 goto out;
1235 }
dand2199f02010-08-27 17:48:52 +00001236 pArg->xDestroy = xDestroy;
1237 pArg->pUserData = p;
1238 }
1239 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1240 if( pArg && pArg->nRef==0 ){
1241 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001242 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001243 sqlite3DbFree(db, pArg);
1244 }
1245
1246 out:
drhe30f4422007-08-21 16:15:55 +00001247 rc = sqlite3ApiExit(db, rc);
1248 sqlite3_mutex_leave(db->mutex);
1249 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001250}
1251
danielk197793758c82005-01-21 08:13:14 +00001252#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001253int sqlite3_create_function16(
1254 sqlite3 *db,
1255 const void *zFunctionName,
1256 int nArg,
1257 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001258 void *p,
danielk197765904932004-05-26 06:18:37 +00001259 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1260 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1261 void (*xFinal)(sqlite3_context*)
1262){
1263 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001264 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +00001265 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001266 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001267 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001268 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001269 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001270 rc = sqlite3ApiExit(db, rc);
1271 sqlite3_mutex_leave(db->mutex);
1272 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001273}
danielk197793758c82005-01-21 08:13:14 +00001274#endif
drhc9b84a12002-06-20 11:36:48 +00001275
drhb7481e72006-09-16 21:45:14 +00001276
1277/*
1278** Declare that a function has been overloaded by a virtual table.
1279**
1280** If the function already exists as a regular global function, then
1281** this routine is a no-op. If the function does not exist, then create
1282** a new one that always throws a run-time error.
1283**
1284** When virtual tables intend to provide an overloaded function, they
1285** should call this routine to make sure the global function exists.
1286** A global function must exist in order for name resolution to work
1287** properly.
1288*/
1289int sqlite3_overload_function(
1290 sqlite3 *db,
1291 const char *zName,
1292 int nArg
1293){
drhdee0e402009-05-03 20:23:53 +00001294 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001295 int rc = SQLITE_OK;
drhe30f4422007-08-21 16:15:55 +00001296 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001297 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001298 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1299 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001300 }
drhcb5e4db2011-10-12 23:49:49 +00001301 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001302 sqlite3_mutex_leave(db->mutex);
1303 return rc;
drhb7481e72006-09-16 21:45:14 +00001304}
1305
drh19e2d372005-08-29 23:00:03 +00001306#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001307/*
drh18de4822003-01-16 16:28:53 +00001308** Register a trace function. The pArg from the previously registered trace
1309** is returned.
1310**
1311** A NULL trace function means that no tracing is executes. A non-NULL
1312** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001313** SQL statement.
drh18de4822003-01-16 16:28:53 +00001314*/
drh9bb575f2004-09-06 17:24:11 +00001315void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001316 void *pOld;
1317 sqlite3_mutex_enter(db->mutex);
1318 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001319 db->xTrace = xTrace;
1320 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001321 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001322 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001323}
drh19e2d372005-08-29 23:00:03 +00001324/*
1325** Register a profile function. The pArg from the previously registered
1326** profile function is returned.
1327**
1328** A NULL profile function means that no profiling is executes. A non-NULL
1329** profile is a pointer to a function that is invoked at the conclusion of
1330** each SQL statement that is run.
1331*/
1332void *sqlite3_profile(
1333 sqlite3 *db,
1334 void (*xProfile)(void*,const char*,sqlite_uint64),
1335 void *pArg
1336){
drhe30f4422007-08-21 16:15:55 +00001337 void *pOld;
1338 sqlite3_mutex_enter(db->mutex);
1339 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001340 db->xProfile = xProfile;
1341 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001342 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001343 return pOld;
1344}
1345#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001346
drhcd565fd2012-03-01 21:30:44 +00001347/*
1348** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001349** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001350** rollback.
1351*/
danielk197724b03fd2004-05-10 10:34:34 +00001352void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001353 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001354 int (*xCallback)(void*), /* Function to invoke on each commit */
1355 void *pArg /* Argument to the function */
1356){
drhe30f4422007-08-21 16:15:55 +00001357 void *pOld;
1358 sqlite3_mutex_enter(db->mutex);
1359 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001360 db->xCommitCallback = xCallback;
1361 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001362 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001363 return pOld;
1364}
1365
danielk197794eb6a12005-12-15 15:22:08 +00001366/*
1367** Register a callback to be invoked each time a row is updated,
1368** inserted or deleted using this database connection.
1369*/
danielk197771fd80b2005-12-16 06:54:01 +00001370void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001371 sqlite3 *db, /* Attach the hook to this database */
1372 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1373 void *pArg /* Argument to the function */
1374){
drhe30f4422007-08-21 16:15:55 +00001375 void *pRet;
1376 sqlite3_mutex_enter(db->mutex);
1377 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001378 db->xUpdateCallback = xCallback;
1379 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001380 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001381 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001382}
1383
danielk197771fd80b2005-12-16 06:54:01 +00001384/*
1385** Register a callback to be invoked each time a transaction is rolled
1386** back by this database connection.
1387*/
1388void *sqlite3_rollback_hook(
1389 sqlite3 *db, /* Attach the hook to this database */
1390 void (*xCallback)(void*), /* Callback function */
1391 void *pArg /* Argument to the function */
1392){
drhe30f4422007-08-21 16:15:55 +00001393 void *pRet;
1394 sqlite3_mutex_enter(db->mutex);
1395 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001396 db->xRollbackCallback = xCallback;
1397 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001398 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001399 return pRet;
1400}
drhaa940ea2004-01-15 02:44:03 +00001401
dan586b9c82010-05-03 08:04:49 +00001402#ifndef SQLITE_OMIT_WAL
1403/*
1404** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001405** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1406** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001407** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001408*/
drhb033d8b2010-05-03 13:37:30 +00001409int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001410 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001411 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001412 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001413 int nFrame /* Size of WAL */
1414){
drh5def0842010-05-05 20:00:25 +00001415 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001416 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001417 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001418 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001419 }
1420 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001421}
drhb033d8b2010-05-03 13:37:30 +00001422#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001423
1424/*
1425** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1426** a database after committing a transaction if there are nFrame or
1427** more frames in the log file. Passing zero or a negative value as the
1428** nFrame parameter disables automatic checkpoints entirely.
1429**
1430** The callback registered by this function replaces any existing callback
1431** registered using sqlite3_wal_hook(). Likewise, registering a callback
1432** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1433** configured by this function.
1434*/
1435int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001436#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001437 UNUSED_PARAMETER(db);
1438 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001439#else
dan586b9c82010-05-03 08:04:49 +00001440 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001441 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001442 }else{
1443 sqlite3_wal_hook(db, 0, 0);
1444 }
drhb033d8b2010-05-03 13:37:30 +00001445#endif
dan586b9c82010-05-03 08:04:49 +00001446 return SQLITE_OK;
1447}
1448
paulb0208cc2003-04-13 18:26:49 +00001449/*
dan8d22a172010-04-19 18:03:51 +00001450** Register a callback to be invoked each time a transaction is written
1451** into the write-ahead-log by this database connection.
1452*/
drh833bf962010-04-28 14:42:19 +00001453void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001454 sqlite3 *db, /* Attach the hook to this db handle */
1455 int(*xCallback)(void *, sqlite3*, const char*, int),
1456 void *pArg /* First argument passed to xCallback() */
1457){
drhb033d8b2010-05-03 13:37:30 +00001458#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001459 void *pRet;
1460 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001461 pRet = db->pWalArg;
1462 db->xWalCallback = xCallback;
1463 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001464 sqlite3_mutex_leave(db->mutex);
1465 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001466#else
1467 return 0;
1468#endif
dan8d22a172010-04-19 18:03:51 +00001469}
1470
1471/*
dancdc1f042010-11-18 12:11:05 +00001472** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001473*/
dancdc1f042010-11-18 12:11:05 +00001474int sqlite3_wal_checkpoint_v2(
1475 sqlite3 *db, /* Database handle */
1476 const char *zDb, /* Name of attached database (or NULL) */
1477 int eMode, /* SQLITE_CHECKPOINT_* value */
1478 int *pnLog, /* OUT: Size of WAL log in frames */
1479 int *pnCkpt /* OUT: Total number of frames checkpointed */
1480){
drhb033d8b2010-05-03 13:37:30 +00001481#ifdef SQLITE_OMIT_WAL
1482 return SQLITE_OK;
1483#else
dan586b9c82010-05-03 08:04:49 +00001484 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001485 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001486
dan9c5e3682011-02-07 15:12:12 +00001487 /* Initialize the output variables to -1 in case an error occurs. */
1488 if( pnLog ) *pnLog = -1;
1489 if( pnCkpt ) *pnCkpt = -1;
1490
drh383d79e2011-02-09 03:03:16 +00001491 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1492 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1493 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1494 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001495 return SQLITE_MISUSE;
1496 }
1497
dan586b9c82010-05-03 08:04:49 +00001498 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001499 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001500 iDb = sqlite3FindDbName(db, zDb);
1501 }
1502 if( iDb<0 ){
1503 rc = SQLITE_ERROR;
dan87c1fe12010-05-03 12:14:15 +00001504 sqlite3Error(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001505 }else{
dancdc1f042010-11-18 12:11:05 +00001506 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
dan87c1fe12010-05-03 12:14:15 +00001507 sqlite3Error(db, rc, 0);
dan586b9c82010-05-03 08:04:49 +00001508 }
drhb033d8b2010-05-03 13:37:30 +00001509 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001510 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001511 return rc;
1512#endif
dan586b9c82010-05-03 08:04:49 +00001513}
1514
dancdc1f042010-11-18 12:11:05 +00001515
1516/*
1517** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1518** to contains a zero-length string, all attached databases are
1519** checkpointed.
1520*/
1521int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1522 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1523}
1524
drhb033d8b2010-05-03 13:37:30 +00001525#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001526/*
1527** Run a checkpoint on database iDb. This is a no-op if database iDb is
1528** not currently open in WAL mode.
1529**
dan6fcff072010-05-03 14:05:43 +00001530** If a transaction is open on the database being checkpointed, this
1531** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1532** an error occurs while running the checkpoint, an SQLite error code is
1533** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001534**
1535** The mutex on database handle db should be held by the caller. The mutex
1536** associated with the specific b-tree being checkpointed is taken by
1537** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001538**
1539** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1540** checkpointed. If an error is encountered it is returned immediately -
1541** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001542**
dancdc1f042010-11-18 12:11:05 +00001543** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001544*/
dancdc1f042010-11-18 12:11:05 +00001545int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001546 int rc = SQLITE_OK; /* Return code */
1547 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001548 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001549
1550 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001551 assert( !pnLog || *pnLog==-1 );
1552 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001553
dan6fcff072010-05-03 14:05:43 +00001554 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1555 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001556 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001557 pnLog = 0;
1558 pnCkpt = 0;
1559 if( rc==SQLITE_BUSY ){
1560 bBusy = 1;
1561 rc = SQLITE_OK;
1562 }
dan6fcff072010-05-03 14:05:43 +00001563 }
dan586b9c82010-05-03 08:04:49 +00001564 }
1565
danf2b8dd52010-11-18 19:28:01 +00001566 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001567}
drhb033d8b2010-05-03 13:37:30 +00001568#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001569
1570/*
danielk1977d8293352009-04-30 09:10:37 +00001571** This function returns true if main-memory should be used instead of
1572** a temporary file for transient pager files and statement journals.
1573** The value returned depends on the value of db->temp_store (runtime
1574** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1575** following table describes the relationship between these two values
1576** and this functions return value.
1577**
1578** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1579** ----------------- -------------- ------------------------------
1580** 0 any file (return 0)
1581** 1 1 file (return 0)
1582** 1 2 memory (return 1)
1583** 1 0 file (return 0)
1584** 2 1 file (return 0)
1585** 2 2 memory (return 1)
1586** 2 0 memory (return 1)
1587** 3 any memory (return 1)
1588*/
drh1c514142009-04-30 12:25:10 +00001589int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001590#if SQLITE_TEMP_STORE==1
1591 return ( db->temp_store==2 );
1592#endif
1593#if SQLITE_TEMP_STORE==2
1594 return ( db->temp_store!=1 );
1595#endif
1596#if SQLITE_TEMP_STORE==3
1597 return 1;
shanecf697392009-06-01 16:53:09 +00001598#endif
1599#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001600 return 0;
shane60a4b532009-05-06 18:57:09 +00001601#endif
danielk1977d8293352009-04-30 09:10:37 +00001602}
1603
1604/*
danielk19774ad17132004-05-21 01:47:26 +00001605** Return UTF-8 encoded English language explanation of the most recent
1606** error.
1607*/
danielk19776622cce2004-05-20 11:00:52 +00001608const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001609 const char *z;
drhf49661a2008-12-10 16:45:50 +00001610 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001611 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001612 }
drhd55d57e2008-07-07 17:53:07 +00001613 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001614 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001615 }
drh27641702007-08-22 02:56:42 +00001616 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001617 if( db->mallocFailed ){
1618 z = sqlite3ErrStr(SQLITE_NOMEM);
1619 }else{
1620 z = (char*)sqlite3_value_text(db->pErr);
1621 assert( !db->mallocFailed );
1622 if( z==0 ){
1623 z = sqlite3ErrStr(db->errCode);
1624 }
danielk19776622cce2004-05-20 11:00:52 +00001625 }
drhe30f4422007-08-21 16:15:55 +00001626 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001627 return z;
danielk19776622cce2004-05-20 11:00:52 +00001628}
1629
drh6c626082004-11-14 21:56:29 +00001630#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001631/*
1632** Return UTF-16 encoded English language explanation of the most recent
1633** error.
1634*/
danielk19776622cce2004-05-20 11:00:52 +00001635const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00001636 static const u16 outOfMem[] = {
1637 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00001638 };
danielk19777c5c3ca2009-02-23 14:42:53 +00001639 static const u16 misuse[] = {
1640 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
1641 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
1642 'c', 'a', 'l', 'l', 'e', 'd', ' ',
1643 'o', 'u', 't', ' ',
1644 'o', 'f', ' ',
1645 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00001646 };
danielk19774ad17132004-05-21 01:47:26 +00001647
drhc60d0442004-09-30 13:43:13 +00001648 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001649 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001650 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00001651 }
drhd55d57e2008-07-07 17:53:07 +00001652 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00001653 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00001654 }
drhe30f4422007-08-21 16:15:55 +00001655 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001656 if( db->mallocFailed ){
1657 z = (void *)outOfMem;
1658 }else{
drhc60d0442004-09-30 13:43:13 +00001659 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00001660 if( z==0 ){
1661 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
1662 SQLITE_UTF8, SQLITE_STATIC);
1663 z = sqlite3_value_text16(db->pErr);
1664 }
1665 /* A malloc() may have failed within the call to sqlite3_value_text16()
1666 ** above. If this is the case, then the db->mallocFailed flag needs to
1667 ** be cleared before returning. Do this directly, instead of via
1668 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1669 */
1670 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00001671 }
drhe30f4422007-08-21 16:15:55 +00001672 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001673 return z;
danielk19776622cce2004-05-20 11:00:52 +00001674}
drh6c626082004-11-14 21:56:29 +00001675#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001676
drhc60d0442004-09-30 13:43:13 +00001677/*
danielk19777ddad962005-12-12 06:53:03 +00001678** Return the most recent error code generated by an SQLite routine. If NULL is
1679** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001680*/
danielk19776622cce2004-05-20 11:00:52 +00001681int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001682 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001683 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00001684 }
drh01495b92008-01-23 12:52:40 +00001685 if( !db || db->mallocFailed ){
1686 return SQLITE_NOMEM;
1687 }
drh4ac285a2006-09-15 07:28:50 +00001688 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001689}
drh99dfe5e2008-10-30 15:03:15 +00001690int sqlite3_extended_errcode(sqlite3 *db){
1691 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001692 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00001693 }
1694 if( !db || db->mallocFailed ){
1695 return SQLITE_NOMEM;
1696 }
1697 return db->errCode;
1698}
danielk19776622cce2004-05-20 11:00:52 +00001699
drh0e819f92006-02-01 13:50:41 +00001700/*
1701** Create a new collating function for database "db". The name is zName
1702** and the encoding is enc.
1703*/
danielk19779a30cf62006-01-18 04:26:07 +00001704static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00001705 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00001706 const char *zName,
shanecea72b22009-09-07 04:38:36 +00001707 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00001708 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001709 int(*xCompare)(void*,int,const void*,int,const void*),
1710 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001711){
1712 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001713 int enc2;
drhc4a64fa2009-05-11 20:53:28 +00001714 int nName = sqlite3Strlen30(zName);
danielk19779a30cf62006-01-18 04:26:07 +00001715
drhe30f4422007-08-21 16:15:55 +00001716 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001717
1718 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1719 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1720 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1721 */
drh51c7d862009-04-27 18:46:06 +00001722 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00001723 testcase( enc2==SQLITE_UTF16 );
1724 testcase( enc2==SQLITE_UTF16_ALIGNED );
1725 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00001726 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001727 }
drh51c7d862009-04-27 18:46:06 +00001728 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00001729 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00001730 }
1731
1732 /* Check if this call is removing or replacing an existing collation
1733 ** sequence. If so, and there are active VMs, return busy. If there
1734 ** are no active VMs, invalidate any pre-compiled statements.
1735 */
drhc4a64fa2009-05-11 20:53:28 +00001736 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001737 if( pColl && pColl->xCmp ){
1738 if( db->activeVdbeCnt ){
1739 sqlite3Error(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001740 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00001741 return SQLITE_BUSY;
1742 }
1743 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001744
1745 /* If collation sequence pColl was created directly by a call to
1746 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1747 ** then any copies made by synthCollSeq() need to be invalidated.
1748 ** Also, collation destructor - CollSeq.xDel() - function may need
1749 ** to be called.
1750 */
1751 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001752 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001753 int j;
1754 for(j=0; j<3; j++){
1755 CollSeq *p = &aColl[j];
1756 if( p->enc==pColl->enc ){
1757 if( p->xDel ){
1758 p->xDel(p->pUser);
1759 }
1760 p->xCmp = 0;
1761 }
1762 }
1763 }
danielk19779a30cf62006-01-18 04:26:07 +00001764 }
1765
drhc4a64fa2009-05-11 20:53:28 +00001766 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00001767 if( pColl==0 ) return SQLITE_NOMEM;
1768 pColl->xCmp = xCompare;
1769 pColl->pUser = pCtx;
1770 pColl->xDel = xDel;
1771 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
danielk19779a30cf62006-01-18 04:26:07 +00001772 sqlite3Error(db, SQLITE_OK, 0);
1773 return SQLITE_OK;
1774}
1775
1776
danielk19776622cce2004-05-20 11:00:52 +00001777/*
drhbb4957f2008-03-20 14:03:29 +00001778** This array defines hard upper bounds on limit values. The
1779** initializer must be kept in sync with the SQLITE_LIMIT_*
1780** #defines in sqlite3.h.
1781*/
drhb1a6c3c2008-03-20 16:30:17 +00001782static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00001783 SQLITE_MAX_LENGTH,
1784 SQLITE_MAX_SQL_LENGTH,
1785 SQLITE_MAX_COLUMN,
1786 SQLITE_MAX_EXPR_DEPTH,
1787 SQLITE_MAX_COMPOUND_SELECT,
1788 SQLITE_MAX_VDBE_OP,
1789 SQLITE_MAX_FUNCTION_ARG,
1790 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00001791 SQLITE_MAX_LIKE_PATTERN_LENGTH,
1792 SQLITE_MAX_VARIABLE_NUMBER,
drh417168a2009-09-07 18:14:02 +00001793 SQLITE_MAX_TRIGGER_DEPTH,
drhbb4957f2008-03-20 14:03:29 +00001794};
1795
1796/*
1797** Make sure the hard limits are set to reasonable values
1798*/
1799#if SQLITE_MAX_LENGTH<100
1800# error SQLITE_MAX_LENGTH must be at least 100
1801#endif
1802#if SQLITE_MAX_SQL_LENGTH<100
1803# error SQLITE_MAX_SQL_LENGTH must be at least 100
1804#endif
1805#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
1806# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
1807#endif
drhbb4957f2008-03-20 14:03:29 +00001808#if SQLITE_MAX_COMPOUND_SELECT<2
1809# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
1810#endif
1811#if SQLITE_MAX_VDBE_OP<40
1812# error SQLITE_MAX_VDBE_OP must be at least 40
1813#endif
drhe82f5d02008-10-07 19:53:14 +00001814#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
1815# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00001816#endif
drh01c7dc82011-03-23 18:22:34 +00001817#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>62
1818# error SQLITE_MAX_ATTACHED must be between 0 and 62
drhbb4957f2008-03-20 14:03:29 +00001819#endif
drhbb4957f2008-03-20 14:03:29 +00001820#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
1821# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
1822#endif
drh70a8ca32008-08-21 18:49:27 +00001823#if SQLITE_MAX_COLUMN>32767
1824# error SQLITE_MAX_COLUMN must not exceed 32767
1825#endif
drh417168a2009-09-07 18:14:02 +00001826#if SQLITE_MAX_TRIGGER_DEPTH<1
1827# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
1828#endif
drhbb4957f2008-03-20 14:03:29 +00001829
1830
1831/*
1832** Change the value of a limit. Report the old value.
1833** If an invalid limit index is supplied, report -1.
1834** Make no changes but still report the old value if the
1835** new limit is negative.
1836**
1837** A new lower limit does not shrink existing constructs.
1838** It merely prevents new constructs that exceed the limit
1839** from forming.
1840*/
1841int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
1842 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00001843
1844
1845 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
1846 ** there is a hard upper bound set at compile-time by a C preprocessor
1847 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
1848 ** "_MAX_".)
1849 */
1850 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
1851 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
1852 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
1853 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
1854 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
1855 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
1856 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
1857 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
1858 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
1859 SQLITE_MAX_LIKE_PATTERN_LENGTH );
1860 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
1861 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
1862 assert( SQLITE_LIMIT_TRIGGER_DEPTH==(SQLITE_N_LIMIT-1) );
1863
1864
drh521cc842008-04-15 02:36:33 +00001865 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00001866 return -1;
1867 }
1868 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00001869 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00001870 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00001871 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00001872 }
1873 db->aLimit[limitId] = newLimit;
1874 }
drh4e93f5b2010-09-07 14:59:15 +00001875 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00001876}
1877
1878/*
dan286ab7c2011-05-06 18:34:54 +00001879** This function is used to parse both URIs and non-URI filenames passed by the
1880** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
1881** URIs specified as part of ATTACH statements.
1882**
1883** The first argument to this function is the name of the VFS to use (or
1884** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
1885** query parameter. The second argument contains the URI (or non-URI filename)
1886** itself. When this function is called the *pFlags variable should contain
1887** the default flags to open the database handle with. The value stored in
1888** *pFlags may be updated before returning if the URI filename contains
1889** "cache=xxx" or "mode=xxx" query parameters.
1890**
1891** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
1892** the VFS that should be used to open the database file. *pzFile is set to
1893** point to a buffer containing the name of the file to open. It is the
1894** responsibility of the caller to eventually call sqlite3_free() to release
1895** this buffer.
1896**
1897** If an error occurs, then an SQLite error code is returned and *pzErrMsg
1898** may be set to point to a buffer containing an English language error
1899** message. It is the responsibility of the caller to eventually release
1900** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00001901*/
1902int sqlite3ParseUri(
1903 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
1904 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00001905 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00001906 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
1907 char **pzFile, /* OUT: Filename component of URI */
1908 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
1909){
dan78e9dd22011-05-03 10:22:32 +00001910 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00001911 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00001912 const char *zVfs = zDefaultVfs;
1913 char *zFile;
drhde941c32011-05-09 19:20:17 +00001914 char c;
dancd74b612011-04-22 19:37:32 +00001915 int nUri = sqlite3Strlen30(zUri);
1916
1917 assert( *pzErrMsg==0 );
1918
1919 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
1920 && nUri>=5 && memcmp(zUri, "file:", 5)==0
1921 ){
dan5de15372011-04-23 10:12:30 +00001922 char *zOpt;
dancd74b612011-04-22 19:37:32 +00001923 int eState; /* Parser state when parsing URI */
1924 int iIn; /* Input character index */
1925 int iOut = 0; /* Output character index */
1926 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00001927
dan286ab7c2011-05-06 18:34:54 +00001928 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
1929 ** method that there may be extra parameters following the file-name. */
1930 flags |= SQLITE_OPEN_URI;
1931
1932 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00001933 zFile = sqlite3_malloc(nByte);
1934 if( !zFile ) return SQLITE_NOMEM;
1935
1936 /* Discard the scheme and authority segments of the URI. */
1937 if( zUri[5]=='/' && zUri[6]=='/' ){
1938 iIn = 7;
1939 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00001940
1941 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
1942 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
1943 iIn-7, &zUri[7]);
1944 rc = SQLITE_ERROR;
1945 goto parse_uri_out;
1946 }
dancd74b612011-04-22 19:37:32 +00001947 }else{
1948 iIn = 5;
1949 }
1950
1951 /* Copy the filename and any query parameters into the zFile buffer.
1952 ** Decode %HH escape codes along the way.
1953 **
1954 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
1955 ** on the parsing context. As follows:
1956 **
1957 ** 0: Parsing file-name.
1958 ** 1: Parsing name section of a name=value query parameter.
1959 ** 2: Parsing value section of a name=value query parameter.
1960 */
1961 eState = 0;
drhde941c32011-05-09 19:20:17 +00001962 while( (c = zUri[iIn])!=0 && c!='#' ){
1963 iIn++;
dancd74b612011-04-22 19:37:32 +00001964 if( c=='%'
1965 && sqlite3Isxdigit(zUri[iIn])
1966 && sqlite3Isxdigit(zUri[iIn+1])
1967 ){
dan6d49e252011-05-03 15:09:05 +00001968 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
1969 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00001970
dan6d49e252011-05-03 15:09:05 +00001971 assert( octet>=0 && octet<256 );
1972 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00001973 /* This branch is taken when "%00" appears within the URI. In this
1974 ** case we ignore all text in the remainder of the path, name or
1975 ** value currently being parsed. So ignore the current character
1976 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00001977 while( (c = zUri[iIn])!=0 && c!='#'
1978 && (eState!=0 || c!='?')
1979 && (eState!=1 || (c!='=' && c!='&'))
1980 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00001981 ){
1982 iIn++;
1983 }
1984 continue;
dancd74b612011-04-22 19:37:32 +00001985 }
dan6d49e252011-05-03 15:09:05 +00001986 c = octet;
dan5de15372011-04-23 10:12:30 +00001987 }else if( eState==1 && (c=='&' || c=='=') ){
1988 if( zFile[iOut-1]==0 ){
1989 /* An empty option name. Ignore this option altogether. */
1990 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
1991 continue;
1992 }
1993 if( c=='&' ){
1994 zFile[iOut++] = '\0';
1995 }else{
1996 eState = 2;
1997 }
dancd74b612011-04-22 19:37:32 +00001998 c = 0;
dan5de15372011-04-23 10:12:30 +00001999 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2000 c = 0;
dancd74b612011-04-22 19:37:32 +00002001 eState = 1;
dancd74b612011-04-22 19:37:32 +00002002 }
2003 zFile[iOut++] = c;
2004 }
2005 if( eState==1 ) zFile[iOut++] = '\0';
2006 zFile[iOut++] = '\0';
2007 zFile[iOut++] = '\0';
2008
2009 /* Check if there were any options specified that should be interpreted
2010 ** here. Options that are interpreted here include "vfs" and those that
2011 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002012 ** method. */
dan5de15372011-04-23 10:12:30 +00002013 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2014 while( zOpt[0] ){
2015 int nOpt = sqlite3Strlen30(zOpt);
2016 char *zVal = &zOpt[nOpt+1];
2017 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002018
dan286ab7c2011-05-06 18:34:54 +00002019 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002020 zVfs = zVal;
2021 }else{
2022 struct OpenMode {
2023 const char *z;
2024 int mode;
2025 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002026 char *zModeType = 0;
2027 int mask = 0;
2028 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002029
dan286ab7c2011-05-06 18:34:54 +00002030 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002031 static struct OpenMode aCacheMode[] = {
2032 { "shared", SQLITE_OPEN_SHAREDCACHE },
2033 { "private", SQLITE_OPEN_PRIVATECACHE },
2034 { 0, 0 }
2035 };
2036
2037 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2038 aMode = aCacheMode;
2039 limit = mask;
2040 zModeType = "cache";
2041 }
dan286ab7c2011-05-06 18:34:54 +00002042 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002043 static struct OpenMode aOpenMode[] = {
2044 { "ro", SQLITE_OPEN_READONLY },
2045 { "rw", SQLITE_OPEN_READWRITE },
2046 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
2047 { 0, 0 }
2048 };
2049
2050 mask = SQLITE_OPEN_READONLY|SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE;
2051 aMode = aOpenMode;
2052 limit = mask & flags;
2053 zModeType = "access";
2054 }
2055
2056 if( aMode ){
2057 int i;
2058 int mode = 0;
2059 for(i=0; aMode[i].z; i++){
2060 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002061 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002062 mode = aMode[i].mode;
2063 break;
dancd74b612011-04-22 19:37:32 +00002064 }
2065 }
dan78e9dd22011-05-03 10:22:32 +00002066 if( mode==0 ){
2067 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2068 rc = SQLITE_ERROR;
2069 goto parse_uri_out;
2070 }
2071 if( mode>limit ){
drhde941c32011-05-09 19:20:17 +00002072 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2073 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002074 rc = SQLITE_PERM;
2075 goto parse_uri_out;
2076 }
2077 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002078 }
dancd74b612011-04-22 19:37:32 +00002079 }
dan5de15372011-04-23 10:12:30 +00002080
2081 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002082 }
2083
2084 }else{
2085 zFile = sqlite3_malloc(nUri+2);
2086 if( !zFile ) return SQLITE_NOMEM;
2087 memcpy(zFile, zUri, nUri);
2088 zFile[nUri] = '\0';
2089 zFile[nUri+1] = '\0';
2090 }
2091
2092 *ppVfs = sqlite3_vfs_find(zVfs);
2093 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002094 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002095 rc = SQLITE_ERROR;
2096 }
2097 parse_uri_out:
2098 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002099 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002100 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002101 }
2102 *pFlags = flags;
2103 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002104 return rc;
dancd74b612011-04-22 19:37:32 +00002105}
2106
2107
2108/*
danielk19774ad17132004-05-21 01:47:26 +00002109** This routine does the work of opening a database on behalf of
2110** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002111** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002112*/
2113static int openDatabase(
2114 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002115 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002116 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002117 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002118){
dancd74b612011-04-22 19:37:32 +00002119 sqlite3 *db; /* Store allocated handle here */
2120 int rc; /* Return code */
2121 int isThreadsafe; /* True for threadsafe connections */
2122 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2123 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002124
drhe0d0f8e2009-04-28 04:47:31 +00002125 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002126#ifndef SQLITE_OMIT_AUTOINIT
2127 rc = sqlite3_initialize();
2128 if( rc ) return rc;
2129#endif
2130
dan78e9dd22011-05-03 10:22:32 +00002131 /* Only allow sensible combinations of bits in the flags argument.
2132 ** Throw an error if any non-sense combination is used. If we
2133 ** do not block illegal combinations here, it could trigger
2134 ** assert() statements in deeper layers. Sensible combinations
2135 ** are:
2136 **
2137 ** 1: SQLITE_OPEN_READONLY
2138 ** 2: SQLITE_OPEN_READWRITE
2139 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2140 */
2141 assert( SQLITE_OPEN_READONLY == 0x01 );
2142 assert( SQLITE_OPEN_READWRITE == 0x02 );
2143 assert( SQLITE_OPEN_CREATE == 0x04 );
2144 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2145 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2146 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh5dd72ad2011-05-07 18:18:33 +00002147 if( ((1<<(flags&7)) & 0x46)==0 ) return SQLITE_MISUSE_BKPT;
dan78e9dd22011-05-03 10:22:32 +00002148
drh039963a2008-09-03 00:43:15 +00002149 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002150 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002151 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2152 isThreadsafe = 0;
2153 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2154 isThreadsafe = 1;
2155 }else{
2156 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002157 }
drhf1f12682009-09-09 14:17:52 +00002158 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002159 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002160 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2161 flags |= SQLITE_OPEN_SHAREDCACHE;
2162 }
danielk19779a6284c2008-07-10 17:52:49 +00002163
drhb25a9f42009-05-12 13:35:11 +00002164 /* Remove harmful bits from the flags parameter
2165 **
2166 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2167 ** dealt with in the previous code block. Besides these, the only
2168 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002169 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2170 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002171 ** off all other flags.
2172 */
drha4267dc2008-02-19 15:20:44 +00002173 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002174 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002175 SQLITE_OPEN_MAIN_DB |
2176 SQLITE_OPEN_TEMP_DB |
2177 SQLITE_OPEN_TRANSIENT_DB |
2178 SQLITE_OPEN_MAIN_JOURNAL |
2179 SQLITE_OPEN_TEMP_JOURNAL |
2180 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002181 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002182 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002183 SQLITE_OPEN_FULLMUTEX |
2184 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002185 );
2186
danielk19774ad17132004-05-21 01:47:26 +00002187 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002188 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002189 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002190 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002191 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2192 if( db->mutex==0 ){
2193 sqlite3_free(db);
2194 db = 0;
2195 goto opendb_out;
2196 }
drh605264d2007-08-21 15:13:19 +00002197 }
drh27641702007-08-22 02:56:42 +00002198 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002199 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002200 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002201 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002202 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002203
drhbb4957f2008-03-20 14:03:29 +00002204 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2205 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00002206 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002207 db->nextAutovac = -1;
danielk1977f653d782008-03-20 11:04:21 +00002208 db->nextPagesize = 0;
drhe83cafd2011-03-21 17:15:58 +00002209 db->flags |= SQLITE_ShortColNames | SQLITE_AutoIndex | SQLITE_EnableTrigger
drh76fe8032006-07-11 14:17:51 +00002210#if SQLITE_DEFAULT_FILE_FORMAT<4
2211 | SQLITE_LegacyFileFmt
2212#endif
drh56424db2007-03-27 22:24:11 +00002213#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2214 | SQLITE_LoadExtension
2215#endif
dan5bde73c2009-09-01 17:11:07 +00002216#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002217 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002218#endif
drha4bfd7f2010-12-09 19:15:17 +00002219#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2220 | SQLITE_ForeignKeys
2221#endif
drh76fe8032006-07-11 14:17:51 +00002222 ;
drhe61922a2009-05-02 13:29:37 +00002223 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002224#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002225 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002226#endif
danielk1977da184232006-01-05 11:34:32 +00002227
danielk19770202b292004-06-09 09:55:16 +00002228 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2229 ** and UTF-16, so add a version for each to avoid any unnecessary
2230 ** conversions. The only error that can occur here is a malloc() failure.
2231 */
drh4dd65e02011-11-29 14:46:56 +00002232 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2233 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2234 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2235 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002236 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002237 goto opendb_out;
2238 }
drhc4a64fa2009-05-11 20:53:28 +00002239 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002240 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002241
2242 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002243 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002244
dancd74b612011-04-22 19:37:32 +00002245 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002246 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002247 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2248 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002249 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
dan78e9dd22011-05-03 10:22:32 +00002250 sqlite3Error(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002251 sqlite3_free(zErrMsg);
2252 goto opendb_out;
2253 }
2254
danielk19774ad17132004-05-21 01:47:26 +00002255 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002256 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002257 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002258 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002259 if( rc==SQLITE_IOERR_NOMEM ){
2260 rc = SQLITE_NOMEM;
2261 }
danielk19774ad17132004-05-21 01:47:26 +00002262 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00002263 goto opendb_out;
2264 }
drh17435752007-08-16 04:30:38 +00002265 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2266 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002267
drh03b808a2006-03-13 15:06:05 +00002268
danielk197753c0f742005-03-29 03:10:59 +00002269 /* The default safety_level for the main database is 'full'; for the temp
2270 ** database it is 'NONE'. This matches the pager layer defaults.
2271 */
2272 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002273 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002274 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002275 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002276
danielk1977832a58a2007-06-22 15:21:15 +00002277 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002278 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002279 goto opendb_out;
2280 }
2281
danielk19778e227872004-06-07 07:52:17 +00002282 /* Register all built-in functions, but do not attempt to read the
2283 ** database schema yet. This is delayed until the first time the database
2284 ** is accessed.
2285 */
danielk1977832a58a2007-06-22 15:21:15 +00002286 sqlite3Error(db, SQLITE_OK, 0);
2287 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002288
drh1409be62006-08-23 20:07:20 +00002289 /* Load automatic extensions - extensions that have been registered
2290 ** using the sqlite3_automatic_extension() API.
2291 */
drh7aaa8782009-05-20 02:40:45 +00002292 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002293 if( rc==SQLITE_OK ){
2294 sqlite3AutoLoadExtensions(db);
2295 rc = sqlite3_errcode(db);
2296 if( rc!=SQLITE_OK ){
2297 goto opendb_out;
2298 }
danielk1977832a58a2007-06-22 15:21:15 +00002299 }
drh1409be62006-08-23 20:07:20 +00002300
drhaa29c132006-09-02 13:58:06 +00002301#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002302 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002303 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002304 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002305 }
2306#endif
2307
shessa26cf572006-10-19 20:27:58 +00002308#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002309 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002310 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002311 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002312 }
2313#endif
2314
shess69c4ae22007-08-20 17:37:47 +00002315#ifdef SQLITE_ENABLE_FTS3
2316 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002317 rc = sqlite3Fts3Init(db);
2318 }
2319#endif
2320
danielk197783852ac2007-05-06 16:04:11 +00002321#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002322 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002323 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002324 }
2325#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002326
2327#ifdef SQLITE_ENABLE_RTREE
2328 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002329 rc = sqlite3RtreeInit(db);
2330 }
2331#endif
2332
danielk1977832a58a2007-06-22 15:21:15 +00002333 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00002334
drh8fd5bd32007-04-02 16:40:37 +00002335 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2336 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2337 ** mode. Doing nothing at all also makes NORMAL the default.
2338 */
2339#ifdef SQLITE_DEFAULT_LOCKING_MODE
2340 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2341 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2342 SQLITE_DEFAULT_LOCKING_MODE);
2343#endif
2344
drh633e6d52008-07-28 19:34:53 +00002345 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002346 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2347 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002348
dan5a299f92010-05-03 11:05:08 +00002349 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002350
danielk19774ad17132004-05-21 01:47:26 +00002351opendb_out:
dancd74b612011-04-22 19:37:32 +00002352 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002353 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002354 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002355 sqlite3_mutex_leave(db->mutex);
2356 }
danielk197759633ae2008-08-27 19:01:57 +00002357 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002358 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002359 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002360 sqlite3_close(db);
2361 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002362 }else if( rc!=SQLITE_OK ){
2363 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002364 }
danielk19774ad17132004-05-21 01:47:26 +00002365 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00002366 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002367}
2368
2369/*
2370** Open a new database handle.
2371*/
danielk197780290862004-05-22 09:21:21 +00002372int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002373 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002374 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002375){
drh605264d2007-08-21 15:13:19 +00002376 return openDatabase(zFilename, ppDb,
2377 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2378}
2379int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002380 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002381 sqlite3 **ppDb, /* OUT: SQLite db handle */
2382 int flags, /* Flags */
2383 const char *zVfs /* Name of VFS module to use */
2384){
drh522c26f2011-05-07 14:40:29 +00002385 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002386}
2387
drh6c626082004-11-14 21:56:29 +00002388#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002389/*
2390** Open a new database handle.
2391*/
2392int sqlite3_open16(
2393 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002394 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002395){
danielk1977bfd6cce2004-06-18 04:24:54 +00002396 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002397 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002398 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002399
danielk19777ddad962005-12-12 06:53:03 +00002400 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00002401 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00002402 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002403#ifndef SQLITE_OMIT_AUTOINIT
2404 rc = sqlite3_initialize();
2405 if( rc ) return rc;
2406#endif
danielk19771e536952007-08-16 10:09:01 +00002407 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002408 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2409 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002410 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002411 rc = openDatabase(zFilename8, ppDb,
2412 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002413 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002414 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002415 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002416 }
drh40257ff2008-06-13 18:24:27 +00002417 }else{
2418 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002419 }
danielk19777ddad962005-12-12 06:53:03 +00002420 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002421
danielk197754f01982006-01-18 15:25:17 +00002422 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002423}
drh6c626082004-11-14 21:56:29 +00002424#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002425
danielk1977106bb232004-05-21 10:08:53 +00002426/*
danielk1977d8123362004-06-12 09:25:12 +00002427** Register a new collation sequence with the database handle db.
2428*/
danielk19770202b292004-06-09 09:55:16 +00002429int sqlite3_create_collation(
2430 sqlite3* db,
2431 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002432 int enc,
danielk19770202b292004-06-09 09:55:16 +00002433 void* pCtx,
2434 int(*xCompare)(void*,int,const void*,int,const void*)
2435){
danielk19779a30cf62006-01-18 04:26:07 +00002436 int rc;
drhe30f4422007-08-21 16:15:55 +00002437 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002438 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002439 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00002440 rc = sqlite3ApiExit(db, rc);
2441 sqlite3_mutex_leave(db->mutex);
2442 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00002443}
2444
2445/*
2446** Register a new collation sequence with the database handle db.
2447*/
danielk1977a393c032007-05-07 14:58:53 +00002448int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002449 sqlite3* db,
2450 const char *zName,
2451 int enc,
2452 void* pCtx,
2453 int(*xCompare)(void*,int,const void*,int,const void*),
2454 void(*xDel)(void*)
2455){
2456 int rc;
drhe30f4422007-08-21 16:15:55 +00002457 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002458 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002459 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002460 rc = sqlite3ApiExit(db, rc);
2461 sqlite3_mutex_leave(db->mutex);
2462 return rc;
danielk19770202b292004-06-09 09:55:16 +00002463}
2464
drh6c626082004-11-14 21:56:29 +00002465#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002466/*
2467** Register a new collation sequence with the database handle db.
2468*/
danielk19770202b292004-06-09 09:55:16 +00002469int sqlite3_create_collation16(
2470 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002471 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002472 int enc,
danielk19770202b292004-06-09 09:55:16 +00002473 void* pCtx,
2474 int(*xCompare)(void*,int,const void*,int,const void*)
2475){
danielk19779a30cf62006-01-18 04:26:07 +00002476 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002477 char *zName8;
drhe30f4422007-08-21 16:15:55 +00002478 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002479 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002480 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002481 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002482 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002483 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002484 }
drhe30f4422007-08-21 16:15:55 +00002485 rc = sqlite3ApiExit(db, rc);
2486 sqlite3_mutex_leave(db->mutex);
2487 return rc;
danielk19770202b292004-06-09 09:55:16 +00002488}
drh6c626082004-11-14 21:56:29 +00002489#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002490
danielk1977d8123362004-06-12 09:25:12 +00002491/*
2492** Register a collation sequence factory callback with the database handle
2493** db. Replace any previously installed collation sequence factory.
2494*/
danielk19777cedc8d2004-06-10 10:50:08 +00002495int sqlite3_collation_needed(
2496 sqlite3 *db,
2497 void *pCollNeededArg,
2498 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2499){
drhe30f4422007-08-21 16:15:55 +00002500 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002501 db->xCollNeeded = xCollNeeded;
2502 db->xCollNeeded16 = 0;
2503 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002504 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002505 return SQLITE_OK;
2506}
danielk1977d8123362004-06-12 09:25:12 +00002507
drh6c626082004-11-14 21:56:29 +00002508#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002509/*
2510** Register a collation sequence factory callback with the database handle
2511** db. Replace any previously installed collation sequence factory.
2512*/
danielk19777cedc8d2004-06-10 10:50:08 +00002513int sqlite3_collation_needed16(
2514 sqlite3 *db,
2515 void *pCollNeededArg,
2516 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2517){
drhe30f4422007-08-21 16:15:55 +00002518 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002519 db->xCollNeeded = 0;
2520 db->xCollNeeded16 = xCollNeeded16;
2521 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002522 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002523 return SQLITE_OK;
2524}
drh6c626082004-11-14 21:56:29 +00002525#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002526
shaneeec556d2008-10-12 00:27:53 +00002527#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002528/*
danielk19777ddad962005-12-12 06:53:03 +00002529** This function is now an anachronism. It used to be used to recover from a
2530** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002531*/
drh7d97efb2007-10-12 19:35:48 +00002532int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002533 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002534}
2535#endif
drh3e1d8e62005-05-26 16:23:34 +00002536
2537/*
2538** Test to see whether or not the database connection is in autocommit
2539** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2540** by default. Autocommit is disabled by a BEGIN statement and reenabled
2541** by the next COMMIT or ROLLBACK.
2542**
2543******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
2544*/
2545int sqlite3_get_autocommit(sqlite3 *db){
2546 return db->autoCommit;
2547}
drh49285702005-09-17 15:20:26 +00002548
drh49285702005-09-17 15:20:26 +00002549/*
drh9978c972010-02-23 17:36:32 +00002550** The following routines are subtitutes for constants SQLITE_CORRUPT,
2551** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
2552** constants. They server two purposes:
2553**
2554** 1. Serve as a convenient place to set a breakpoint in a debugger
2555** to detect when version error conditions occurs.
2556**
2557** 2. Invoke sqlite3_log() to provide the source code location where
2558** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00002559*/
drh9978c972010-02-23 17:36:32 +00002560int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002561 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00002562 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00002563 "database corruption at line %d of [%.10s]",
2564 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00002565 return SQLITE_CORRUPT;
2566}
drh9978c972010-02-23 17:36:32 +00002567int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002568 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002569 sqlite3_log(SQLITE_MISUSE,
2570 "misuse at line %d of [%.10s]",
2571 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002572 return SQLITE_MISUSE;
2573}
2574int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00002575 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00002576 sqlite3_log(SQLITE_CANTOPEN,
2577 "cannot open file at line %d of [%.10s]",
2578 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00002579 return SQLITE_CANTOPEN;
2580}
2581
drh7c1817e2006-01-10 13:58:48 +00002582
shaneeec556d2008-10-12 00:27:53 +00002583#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00002584/*
2585** This is a convenience routine that makes sure that all thread-specific
2586** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00002587**
2588** SQLite no longer uses thread-specific data so this routine is now a
2589** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00002590*/
2591void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00002592}
shaneeec556d2008-10-12 00:27:53 +00002593#endif
danielk1977deb802c2006-02-09 13:43:28 +00002594
2595/*
2596** Return meta information about a specific column of a database table.
2597** See comment in sqlite3.h (sqlite.h.in) for details.
2598*/
2599#ifdef SQLITE_ENABLE_COLUMN_METADATA
2600int sqlite3_table_column_metadata(
2601 sqlite3 *db, /* Connection handle */
2602 const char *zDbName, /* Database name or NULL */
2603 const char *zTableName, /* Table name */
2604 const char *zColumnName, /* Column name */
2605 char const **pzDataType, /* OUTPUT: Declared data type */
2606 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
2607 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
2608 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00002609 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00002610){
2611 int rc;
2612 char *zErrMsg = 0;
2613 Table *pTab = 0;
2614 Column *pCol = 0;
2615 int iCol;
2616
2617 char const *zDataType = 0;
2618 char const *zCollSeq = 0;
2619 int notnull = 0;
2620 int primarykey = 0;
2621 int autoinc = 0;
2622
2623 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00002624 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00002625 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002626 rc = sqlite3Init(db, &zErrMsg);
2627 if( SQLITE_OK!=rc ){
2628 goto error_out;
2629 }
2630
2631 /* Locate the table in question */
2632 pTab = sqlite3FindTable(db, zTableName, zDbName);
2633 if( !pTab || pTab->pSelect ){
2634 pTab = 0;
2635 goto error_out;
2636 }
2637
2638 /* Find the column for which info is requested */
2639 if( sqlite3IsRowid(zColumnName) ){
2640 iCol = pTab->iPKey;
2641 if( iCol>=0 ){
2642 pCol = &pTab->aCol[iCol];
2643 }
2644 }else{
2645 for(iCol=0; iCol<pTab->nCol; iCol++){
2646 pCol = &pTab->aCol[iCol];
2647 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
2648 break;
2649 }
2650 }
2651 if( iCol==pTab->nCol ){
2652 pTab = 0;
2653 goto error_out;
2654 }
2655 }
2656
2657 /* The following block stores the meta information that will be returned
2658 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
2659 ** and autoinc. At this point there are two possibilities:
2660 **
2661 ** 1. The specified column name was rowid", "oid" or "_rowid_"
2662 ** and there is no explicitly declared IPK column.
2663 **
2664 ** 2. The table is not a view and the column name identified an
2665 ** explicitly declared column. Copy meta information from *pCol.
2666 */
2667 if( pCol ){
2668 zDataType = pCol->zType;
2669 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00002670 notnull = pCol->notNull!=0;
2671 primarykey = pCol->isPrimKey!=0;
drh7d10d5a2008-08-20 16:35:10 +00002672 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00002673 }else{
2674 zDataType = "INTEGER";
2675 primarykey = 1;
2676 }
2677 if( !zCollSeq ){
2678 zCollSeq = "BINARY";
2679 }
2680
2681error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00002682 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00002683
2684 /* Whether the function call succeeded or failed, set the output parameters
2685 ** to whatever their local counterparts contain. If an error did occur,
2686 ** this has the effect of zeroing all output parameters.
2687 */
2688 if( pzDataType ) *pzDataType = zDataType;
2689 if( pzCollSeq ) *pzCollSeq = zCollSeq;
2690 if( pNotNull ) *pNotNull = notnull;
2691 if( pPrimaryKey ) *pPrimaryKey = primarykey;
2692 if( pAutoinc ) *pAutoinc = autoinc;
2693
2694 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00002695 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00002696 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00002697 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00002698 rc = SQLITE_ERROR;
2699 }
2700 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002701 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00002702 rc = sqlite3ApiExit(db, rc);
2703 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00002704 return rc;
2705}
drhe30f4422007-08-21 16:15:55 +00002706#endif
drhf9cb7f52006-06-27 20:06:44 +00002707
2708/*
2709** Sleep for a little while. Return the amount of time slept.
2710*/
2711int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00002712 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00002713 int rc;
drhd677b3d2007-08-20 22:48:41 +00002714 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00002715 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00002716
2717 /* This function works in milliseconds, but the underlying OsSleep()
2718 ** API uses microseconds. Hence the 1000's.
2719 */
drhe30f4422007-08-21 16:15:55 +00002720 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00002721 return rc;
drhf9cb7f52006-06-27 20:06:44 +00002722}
drh4ac285a2006-09-15 07:28:50 +00002723
2724/*
2725** Enable or disable the extended result codes.
2726*/
2727int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00002728 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002729 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00002730 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002731 return SQLITE_OK;
2732}
drhcc6bb3e2007-08-31 16:11:35 +00002733
2734/*
2735** Invoke the xFileControl method on a particular database.
2736*/
2737int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
2738 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00002739 Btree *pBtree;
2740
drhcc6bb3e2007-08-31 16:11:35 +00002741 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00002742 pBtree = sqlite3DbNameToBtree(db, zDbName);
2743 if( pBtree ){
2744 Pager *pPager;
2745 sqlite3_file *fd;
2746 sqlite3BtreeEnter(pBtree);
2747 pPager = sqlite3BtreePager(pBtree);
2748 assert( pPager!=0 );
2749 fd = sqlite3PagerFile(pPager);
2750 assert( fd!=0 );
2751 if( op==SQLITE_FCNTL_FILE_POINTER ){
2752 *(sqlite3_file**)pArg = fd;
2753 rc = SQLITE_OK;
2754 }else if( fd->pMethods ){
2755 rc = sqlite3OsFileControl(fd, op, pArg);
2756 }else{
2757 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00002758 }
drh421377e2012-03-15 21:28:54 +00002759 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00002760 }
2761 sqlite3_mutex_leave(db->mutex);
2762 return rc;
2763}
drhed13d982008-01-31 14:43:24 +00002764
2765/*
2766** Interface to the testing logic.
2767*/
2768int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00002769 int rc = 0;
drh3088d592008-03-21 16:45:47 +00002770#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00002771 va_list ap;
drhed13d982008-01-31 14:43:24 +00002772 va_start(ap, op);
2773 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00002774
2775 /*
drh984bfaa2008-03-19 16:08:53 +00002776 ** Save the current state of the PRNG.
2777 */
drh2fa18682008-03-19 14:15:34 +00002778 case SQLITE_TESTCTRL_PRNG_SAVE: {
2779 sqlite3PrngSaveState();
2780 break;
2781 }
drh984bfaa2008-03-19 16:08:53 +00002782
2783 /*
2784 ** Restore the state of the PRNG to the last state saved using
2785 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
2786 ** this verb acts like PRNG_RESET.
2787 */
drh2fa18682008-03-19 14:15:34 +00002788 case SQLITE_TESTCTRL_PRNG_RESTORE: {
2789 sqlite3PrngRestoreState();
2790 break;
2791 }
drh984bfaa2008-03-19 16:08:53 +00002792
2793 /*
2794 ** Reset the PRNG back to its uninitialized state. The next call
2795 ** to sqlite3_randomness() will reseed the PRNG using a single call
2796 ** to the xRandomness method of the default VFS.
2797 */
drh2fa18682008-03-19 14:15:34 +00002798 case SQLITE_TESTCTRL_PRNG_RESET: {
2799 sqlite3PrngResetState();
2800 break;
2801 }
drh3088d592008-03-21 16:45:47 +00002802
2803 /*
2804 ** sqlite3_test_control(BITVEC_TEST, size, program)
2805 **
2806 ** Run a test against a Bitvec object of size. The program argument
2807 ** is an array of integers that defines the test. Return -1 on a
2808 ** memory allocation error, 0 on success, or non-zero for an error.
2809 ** See the sqlite3BitvecBuiltinTest() for additional information.
2810 */
2811 case SQLITE_TESTCTRL_BITVEC_TEST: {
2812 int sz = va_arg(ap, int);
2813 int *aProg = va_arg(ap, int*);
2814 rc = sqlite3BitvecBuiltinTest(sz, aProg);
2815 break;
2816 }
danielk19772d1d86f2008-06-20 14:59:51 +00002817
2818 /*
2819 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
2820 **
2821 ** Register hooks to call to indicate which malloc() failures
2822 ** are benign.
2823 */
2824 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00002825 typedef void (*void_function)(void);
2826 void_function xBenignBegin;
2827 void_function xBenignEnd;
2828 xBenignBegin = va_arg(ap, void_function);
2829 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00002830 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
2831 break;
2832 }
drhc7a3bb92009-02-05 16:31:45 +00002833
2834 /*
drhf3af63f2009-05-09 18:59:42 +00002835 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00002836 **
2837 ** Set the PENDING byte to the value in the argument, if X>0.
2838 ** Make no changes if X==0. Return the value of the pending byte
2839 ** as it existing before this routine was called.
2840 **
2841 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
2842 ** an incompatible database file format. Changing the PENDING byte
2843 ** while any database connection is open results in undefined and
2844 ** dileterious behavior.
2845 */
2846 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00002847 rc = PENDING_BYTE;
2848#ifndef SQLITE_OMIT_WSD
2849 {
2850 unsigned int newVal = va_arg(ap, unsigned int);
2851 if( newVal ) sqlite3PendingByte = newVal;
2852 }
2853#endif
drhc7a3bb92009-02-05 16:31:45 +00002854 break;
2855 }
drhf3af63f2009-05-09 18:59:42 +00002856
2857 /*
2858 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
2859 **
2860 ** This action provides a run-time test to see whether or not
2861 ** assert() was enabled at compile-time. If X is true and assert()
2862 ** is enabled, then the return value is true. If X is true and
2863 ** assert() is disabled, then the return value is zero. If X is
2864 ** false and assert() is enabled, then the assertion fires and the
2865 ** process aborts. If X is false and assert() is disabled, then the
2866 ** return value is zero.
2867 */
2868 case SQLITE_TESTCTRL_ASSERT: {
2869 volatile int x = 0;
2870 assert( (x = va_arg(ap,int))!=0 );
2871 rc = x;
2872 break;
2873 }
2874
2875
2876 /*
2877 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
2878 **
2879 ** This action provides a run-time test to see how the ALWAYS and
2880 ** NEVER macros were defined at compile-time.
2881 **
2882 ** The return value is ALWAYS(X).
2883 **
2884 ** The recommended test is X==2. If the return value is 2, that means
2885 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
2886 ** default setting. If the return value is 1, then ALWAYS() is either
2887 ** hard-coded to true or else it asserts if its argument is false.
2888 ** The first behavior (hard-coded to true) is the case if
2889 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
2890 ** behavior (assert if the argument to ALWAYS() is false) is the case if
2891 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
2892 **
2893 ** The run-time test procedure might look something like this:
2894 **
2895 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
2896 ** // ALWAYS() and NEVER() are no-op pass-through macros
2897 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
2898 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
2899 ** }else{
2900 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
2901 ** }
2902 */
2903 case SQLITE_TESTCTRL_ALWAYS: {
2904 int x = va_arg(ap,int);
2905 rc = ALWAYS(x);
2906 break;
2907 }
drhc046e3e2009-07-15 11:26:44 +00002908
2909 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
2910 **
2911 ** Set the nReserve size to N for the main database on the database
2912 ** connection db.
2913 */
2914 case SQLITE_TESTCTRL_RESERVE: {
2915 sqlite3 *db = va_arg(ap, sqlite3*);
2916 int x = va_arg(ap,int);
2917 sqlite3_mutex_enter(db->mutex);
2918 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
2919 sqlite3_mutex_leave(db->mutex);
2920 break;
2921 }
2922
drh07096f62009-12-22 23:52:32 +00002923 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
2924 **
2925 ** Enable or disable various optimizations for testing purposes. The
2926 ** argument N is a bitmask of optimizations to be disabled. For normal
2927 ** operation N should be 0. The idea is that a test program (like the
2928 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
2929 ** with various optimizations disabled to verify that the same answer
2930 ** is obtained in every case.
2931 */
2932 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
2933 sqlite3 *db = va_arg(ap, sqlite3*);
2934 int x = va_arg(ap,int);
2935 db->flags = (x & SQLITE_OptMask) | (db->flags & ~SQLITE_OptMask);
2936 break;
2937 }
2938
drh0e857732010-01-02 03:21:35 +00002939#ifdef SQLITE_N_KEYWORD
2940 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
2941 **
2942 ** If zWord is a keyword recognized by the parser, then return the
2943 ** number of keywords. Or if zWord is not a keyword, return 0.
2944 **
2945 ** This test feature is only available in the amalgamation since
2946 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
2947 ** is built using separate source files.
2948 */
2949 case SQLITE_TESTCTRL_ISKEYWORD: {
2950 const char *zWord = va_arg(ap, const char*);
2951 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00002952 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00002953 break;
2954 }
2955#endif
2956
drhbadc9802010-08-27 17:16:44 +00002957 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
2958 **
2959 ** Pass pFree into sqlite3ScratchFree().
2960 ** If sz>0 then allocate a scratch buffer into pNew.
2961 */
2962 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
2963 void *pFree, **ppNew;
2964 int sz;
2965 sz = va_arg(ap, int);
2966 ppNew = va_arg(ap, void**);
2967 pFree = va_arg(ap, void*);
2968 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
2969 sqlite3ScratchFree(pFree);
2970 break;
2971 }
2972
danc17d6962011-06-21 12:47:30 +00002973 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
2974 **
2975 ** If parameter onoff is non-zero, configure the wrappers so that all
2976 ** subsequent calls to localtime() and variants fail. If onoff is zero,
2977 ** undo this setting.
2978 */
2979 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
2980 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
2981 break;
2982 }
2983
drh678a9aa2011-12-10 15:55:01 +00002984#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh7e02e5e2011-12-06 19:44:51 +00002985 /* sqlite3_test_control(SQLITE_TESTCTRL_EXPLAIN_STMT,
2986 ** sqlite3_stmt*,const char**);
2987 **
drh678a9aa2011-12-10 15:55:01 +00002988 ** If compiled with SQLITE_ENABLE_TREE_EXPLAIN, each sqlite3_stmt holds
2989 ** a string that describes the optimized parse tree. This test-control
2990 ** returns a pointer to that string.
drh7e02e5e2011-12-06 19:44:51 +00002991 */
2992 case SQLITE_TESTCTRL_EXPLAIN_STMT: {
2993 sqlite3_stmt *pStmt = va_arg(ap, sqlite3_stmt*);
2994 const char **pzRet = va_arg(ap, const char**);
2995 *pzRet = sqlite3VdbeExplanation((Vdbe*)pStmt);
2996 break;
2997 }
drh678a9aa2011-12-10 15:55:01 +00002998#endif
drh7e02e5e2011-12-06 19:44:51 +00002999
drhed13d982008-01-31 14:43:24 +00003000 }
3001 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003002#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003003 return rc;
drhed13d982008-01-31 14:43:24 +00003004}
drhcc487d12011-05-17 18:53:08 +00003005
3006/*
3007** This is a utility routine, useful to VFS implementations, that checks
3008** to see if a database file was a URI that contained a specific query
3009** parameter, and if so obtains the value of the query parameter.
3010**
3011** The zFilename argument is the filename pointer passed into the xOpen()
3012** method of a VFS implementation. The zParam argument is the name of the
3013** query parameter we seek. This routine returns the value of the zParam
3014** parameter if it exists. If the parameter does not exist, this routine
3015** returns a NULL pointer.
3016*/
3017const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh92913722011-12-23 00:07:33 +00003018 if( zFilename==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003019 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003020 while( zFilename[0] ){
3021 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003022 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003023 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003024 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003025 }
3026 return 0;
3027}
drh283829c2011-11-17 00:56:20 +00003028
3029/*
drh92913722011-12-23 00:07:33 +00003030** Return a boolean value for a query parameter.
3031*/
3032int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3033 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003034 bDflt = bDflt!=0;
3035 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003036}
3037
3038/*
3039** Return a 64-bit integer value for a query parameter.
3040*/
3041sqlite3_int64 sqlite3_uri_int64(
3042 const char *zFilename, /* Filename as passed to xOpen */
3043 const char *zParam, /* URI parameter sought */
3044 sqlite3_int64 bDflt /* return if parameter is missing */
3045){
3046 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3047 sqlite3_int64 v;
3048 if( z && sqlite3Atoi64(z, &v, sqlite3Strlen30(z), SQLITE_UTF8)==SQLITE_OK ){
3049 bDflt = v;
3050 }
3051 return bDflt;
3052}
3053
3054/*
drh421377e2012-03-15 21:28:54 +00003055** Return the Btree pointer identified by zDbName. Return NULL if not found.
3056*/
3057Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3058 int i;
3059 for(i=0; i<db->nDb; i++){
3060 if( db->aDb[i].pBt
3061 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3062 ){
3063 return db->aDb[i].pBt;
3064 }
3065 }
3066 return 0;
3067}
3068
3069/*
drh283829c2011-11-17 00:56:20 +00003070** Return the filename of the database associated with a database
3071** connection.
3072*/
3073const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh421377e2012-03-15 21:28:54 +00003074 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3075 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3076}
3077
3078/*
3079** Return 1 if database is read-only or 0 if read/write. Return -1 if
3080** no such database exists.
3081*/
3082int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
3083 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3084 return pBt ? sqlite3PagerIsreadonly(sqlite3BtreePager(pBt)) : -1;
drh283829c2011-11-17 00:56:20 +00003085}