blob: 5c20b17500c639bf1dee397edaa29d7af354ea27 [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.
16**
drh1b67f3c2008-10-10 17:41:28 +000017** $Id: main.c,v 1.505 2008/10/10 17:41:29 drh Exp $
drh75897232000-05-29 14:26:00 +000018*/
19#include "sqliteInt.h"
drhce9079c2002-05-15 14:17:44 +000020#include <ctype.h>
drh58f1c8b2008-05-26 20:19:25 +000021
drh820a9062008-01-31 13:35:48 +000022#ifdef SQLITE_ENABLE_FTS3
23# include "fts3.h"
24#endif
drh58f1c8b2008-05-26 20:19:25 +000025#ifdef SQLITE_ENABLE_RTREE
26# include "rtree.h"
27#endif
danielk19771c826652008-09-08 08:08:09 +000028#ifdef SQLITE_ENABLE_ICU
29# include "sqliteicu.h"
30#endif
drh75897232000-05-29 14:26:00 +000031
32/*
drhb217a572000-08-22 13:40:18 +000033** The version of the library
34*/
danielk197724b03fd2004-05-10 10:34:34 +000035const char sqlite3_version[] = SQLITE_VERSION;
drh4aec8b62004-08-28 16:19:00 +000036const char *sqlite3_libversion(void){ return sqlite3_version; }
danielk197799ba19e2005-02-05 07:33:34 +000037int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drhb67e8bf2007-08-30 20:09:48 +000038int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000039
drhe265b082008-05-01 17:03:49 +000040#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000041/*
drhb0603412007-02-28 04:47:26 +000042** If the following function pointer is not NULL and if
43** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
44** I/O active are written using this function. These messages
45** are intended for debugging activity only.
46*/
mlcreech3a00f902008-03-04 17:45:01 +000047void (*sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000048#endif
drhb0603412007-02-28 04:47:26 +000049
50/*
drha16313e2007-03-30 11:29:32 +000051** If the following global variable points to a string which is the
52** name of a directory, then that directory will be used to store
53** temporary files.
54**
55** See also the "PRAGMA temp_store_directory" SQL command.
56*/
57char *sqlite3_temp_directory = 0;
58
drhc5499be2008-04-01 15:06:33 +000059/*
drh40257ff2008-06-13 18:24:27 +000060** Initialize SQLite.
61**
62** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +000063** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +000064** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
65** this routine will be called automatically by key routines such as
66** sqlite3_open().
67**
68** This routine is a no-op except on its very first call for the process,
69** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +000070**
71** The first thread to call this routine runs the initialization to
72** completion. If subsequent threads call this routine before the first
73** thread has finished the initialization process, then the subsequent
74** threads must block until the first thread finishes with the initialization.
75**
76** The first thread might call this routine recursively. Recursive
77** calls to this routine should not block, of course. Otherwise the
78** initialization process would never complete.
79**
80** Let X be the first thread to enter this routine. Let Y be some other
81** thread. Then while the initial invocation of this routine by X is
82** incomplete, it is required that:
83**
84** * Calls to this routine from Y must block until the outer-most
85** call by X completes.
86**
87** * Recursive calls to this routine from thread X return immediately
88** without blocking.
drh40257ff2008-06-13 18:24:27 +000089*/
90int sqlite3_initialize(void){
danielk1977075c23a2008-09-01 18:34:20 +000091 sqlite3_mutex *pMaster; /* The main static mutex */
92 int rc; /* Result code */
93
94#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +000095 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +000096 if( rc!=SQLITE_OK ){
97 return rc;
98 }
99#endif
danielk197771bc31c2008-06-26 08:29:34 +0000100
drh93ed56d2008-08-12 15:21:11 +0000101 /* If SQLite is already completely initialized, then this call
102 ** to sqlite3_initialize() should be a no-op. But the initialization
103 ** must be complete. So isInit must not be set until the very end
104 ** of this routine.
105 */
danielk1977075c23a2008-09-01 18:34:20 +0000106 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000107
drh93ed56d2008-08-12 15:21:11 +0000108 /* Make sure the mutex subsystem is initialized. If unable to
109 ** initialize the mutex subsystem, return early with the error.
110 ** If the system is so sick that we are unable to allocate a mutex,
111 ** there is not much SQLite is going to be able to do.
112 **
113 ** The mutex subsystem must take care of serializing its own
114 ** initialization.
115 */
danielk1977d0251742008-06-18 18:57:42 +0000116 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000117 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000118
drh93ed56d2008-08-12 15:21:11 +0000119 /* Initialize the malloc() system and the recursive pInitMutex mutex.
120 ** This operation is protected by the STATIC_MASTER mutex. Note that
121 ** MutexAlloc() is called for a static mutex prior to initializing the
122 ** malloc subsystem - this implies that the allocation of a static
123 ** mutex must not require support from the malloc subsystem.
124 */
125 pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
126 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000127 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000128 rc = sqlite3MallocInit();
129 }
drh40257ff2008-06-13 18:24:27 +0000130 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000131 sqlite3GlobalConfig.isMallocInit = 1;
132 if( !sqlite3GlobalConfig.pInitMutex ){
133 sqlite3GlobalConfig.pInitMutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
134 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000135 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000136 }
137 }
danielk197777eb5bb2008-09-22 17:22:19 +0000138 }
139 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000140 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000141 }
142 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000143
drh93ed56d2008-08-12 15:21:11 +0000144 /* If unable to initialize the malloc subsystem, then return early.
145 ** There is little hope of getting SQLite to run if the malloc
146 ** subsystem cannot be initialized.
147 */
148 if( rc!=SQLITE_OK ){
149 return rc;
150 }
151
152 /* Do the rest of the initialization under the recursive mutex so
153 ** that we will be able to handle recursive calls into
154 ** sqlite3_initialize(). The recursive calls normally come through
155 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
156 ** recursive calls might also be possible.
157 */
danielk1977075c23a2008-09-01 18:34:20 +0000158 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000159 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000160 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000161 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000162 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000163 sqlite3RegisterGlobalFunctions();
danielk197771bc31c2008-06-26 08:29:34 +0000164 rc = sqlite3_os_init();
danielk19778c0a7912008-08-20 14:49:23 +0000165 if( rc==SQLITE_OK ){
166 rc = sqlite3PcacheInitialize();
danielk19775b775292008-09-02 09:38:06 +0000167 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
168 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
danielk19778c0a7912008-08-20 14:49:23 +0000169 }
danielk1977502b4e02008-09-02 14:07:24 +0000170 sqlite3GlobalConfig.inProgress = 0;
danielk1977075c23a2008-09-01 18:34:20 +0000171 sqlite3GlobalConfig.isInit = (rc==SQLITE_OK ? 1 : 0);
drh40257ff2008-06-13 18:24:27 +0000172 }
danielk1977075c23a2008-09-01 18:34:20 +0000173 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000174
drh93ed56d2008-08-12 15:21:11 +0000175 /* Go back under the static mutex and clean up the recursive
176 ** mutex to prevent a resource leak.
177 */
178 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000179 sqlite3GlobalConfig.nRefInitMutex--;
180 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
181 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
182 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
183 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000184 }
185 sqlite3_mutex_leave(pMaster);
186
187 /* The following is just a sanity check to make sure SQLite has
188 ** been compiled correctly. It is important to run this code, but
189 ** we don't want to run it too often and soak up CPU cycles for no
190 ** reason. So we run it once during initialization.
191 */
shanedfb7b372008-07-22 05:13:30 +0000192#ifndef NDEBUG
193 /* This section of code's only "output" is via assert() statements. */
194 if ( rc==SQLITE_OK ){
195 u64 x = (((u64)1)<<63)-1;
196 double y;
197 assert(sizeof(x)==8);
198 assert(sizeof(x)==sizeof(y));
199 memcpy(&y, &x, 8);
200 assert( sqlite3IsNaN(y) );
201 }
202#endif
203
drh40257ff2008-06-13 18:24:27 +0000204 return rc;
205}
206
207/*
208** Undo the effects of sqlite3_initialize(). Must not be called while
209** there are outstanding database connections or memory allocations or
210** while any part of SQLite is otherwise in use in any thread. This
211** routine is not threadsafe. Not by a long shot.
212*/
213int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000214 sqlite3GlobalConfig.isMallocInit = 0;
danielk19778c0a7912008-08-20 14:49:23 +0000215 sqlite3PcacheShutdown();
danielk1977075c23a2008-09-01 18:34:20 +0000216 if( sqlite3GlobalConfig.isInit ){
danielk1977fb437272008-07-08 12:02:35 +0000217 sqlite3_os_end();
218 }
drh1b67f3c2008-10-10 17:41:28 +0000219 assert( sqlite3GlobalConfig.m.xShutdown!=0 );
220 sqlite3MallocEnd();
221 assert( sqlite3GlobalConfig.mutex.xMutexEnd!=0 );
222 sqlite3MutexEnd();
danielk1977075c23a2008-09-01 18:34:20 +0000223 sqlite3GlobalConfig.isInit = 0;
drh40257ff2008-06-13 18:24:27 +0000224 return SQLITE_OK;
225}
226
227/*
228** This API allows applications to modify the global configuration of
229** the SQLite library at run-time.
230**
231** This routine should only be called when there are no outstanding
232** database connections or memory allocations. This routine is not
233** threadsafe. Failure to heed these warnings can lead to unpredictable
234** behavior.
235*/
236int sqlite3_config(int op, ...){
237 va_list ap;
238 int rc = SQLITE_OK;
239
240 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
241 ** the SQLite library is in use. */
danielk1977075c23a2008-09-01 18:34:20 +0000242 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE;
drh40257ff2008-06-13 18:24:27 +0000243
244 va_start(ap, op);
245 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000246
247 /* Mutex configuration options are only available in a threadsafe
248 ** compile.
249 */
250#if SQLITE_THREADSAFE
drh40257ff2008-06-13 18:24:27 +0000251 case SQLITE_CONFIG_SINGLETHREAD: {
252 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000253 sqlite3GlobalConfig.bCoreMutex = 0;
254 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000255 break;
256 }
257 case SQLITE_CONFIG_MULTITHREAD: {
258 /* Disable mutexing of database connections */
259 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000260 sqlite3GlobalConfig.bCoreMutex = 1;
261 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000262 break;
263 }
264 case SQLITE_CONFIG_SERIALIZED: {
265 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000266 sqlite3GlobalConfig.bCoreMutex = 1;
267 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000268 break;
269 }
drh18472fa2008-10-07 15:25:48 +0000270 case SQLITE_CONFIG_MUTEX: {
271 /* Specify an alternative mutex implementation */
272 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
273 break;
274 }
275 case SQLITE_CONFIG_GETMUTEX: {
276 /* Retrieve the current mutex implementation */
277 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
278 break;
279 }
280#endif
281
282
drh40257ff2008-06-13 18:24:27 +0000283 case SQLITE_CONFIG_MALLOC: {
284 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000285 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000286 break;
287 }
drh33589792008-06-18 13:27:46 +0000288 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000289 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000290 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
291 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000292 break;
293 }
drhfec00ea2008-06-14 16:56:21 +0000294 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000295 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000296 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000297 break;
298 }
drh33589792008-06-18 13:27:46 +0000299 case SQLITE_CONFIG_SCRATCH: {
300 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000301 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
302 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
303 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000304 break;
305 }
306 case SQLITE_CONFIG_PAGECACHE: {
307 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000308 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
309 sqlite3GlobalConfig.szPage = va_arg(ap, int);
310 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000311 break;
312 }
danielk19775099be52008-06-27 13:27:03 +0000313
drh5d414832008-07-15 14:47:18 +0000314#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000315 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000316 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000317 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
318 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
319 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000320
danielk1977075c23a2008-09-01 18:34:20 +0000321 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000322 /* If the heap pointer is NULL, then restore the malloc implementation
323 ** back to NULL pointers too. This will cause the malloc to go
324 ** back to its default implementation when sqlite3_initialize() is
325 ** run.
326 */
danielk1977075c23a2008-09-01 18:34:20 +0000327 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000328 }else{
329 /* The heap pointer is not NULL, then install one of the
330 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
331 ** ENABLE_MEMSYS5 is defined, return an error.
332 ** the default case and return an error.
333 */
danielk19775099be52008-06-27 13:27:03 +0000334#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000335 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000336#endif
337#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000338 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000339#endif
drh8a42cbd2008-07-10 18:13:42 +0000340 }
danielk19775099be52008-06-27 13:27:03 +0000341 break;
342 }
drh5d414832008-07-15 14:47:18 +0000343#endif
danielk19775099be52008-06-27 13:27:03 +0000344
danielk19772d340812008-07-24 08:20:40 +0000345#if defined(SQLITE_ENABLE_MEMSYS6)
346 case SQLITE_CONFIG_CHUNKALLOC: {
danielk1977075c23a2008-09-01 18:34:20 +0000347 sqlite3GlobalConfig.nSmall = va_arg(ap, int);
348 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys6();
danielk19772d340812008-07-24 08:20:40 +0000349 break;
350 }
351#endif
352
drh633e6d52008-07-28 19:34:53 +0000353 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000354 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
355 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000356 break;
357 }
358
drh40257ff2008-06-13 18:24:27 +0000359 default: {
360 rc = SQLITE_ERROR;
361 break;
362 }
363 }
364 va_end(ap);
365 return rc;
366}
367
368/*
drh633e6d52008-07-28 19:34:53 +0000369** Set up the lookaside buffers for a database connection.
370** Return SQLITE_OK on success.
371** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000372**
373** The sz parameter is the number of bytes in each lookaside slot.
374** The cnt parameter is the number of slots. If pStart is NULL the
375** space for the lookaside memory is obtained from sqlite3_malloc().
376** If pStart is not NULL then it is sz*cnt bytes of memory to use for
377** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000378*/
drhe9d1c722008-08-04 20:13:26 +0000379static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000380 void *pStart;
381 if( db->lookaside.nOut ){
382 return SQLITE_BUSY;
383 }
384 if( sz<0 ) sz = 0;
385 if( cnt<0 ) cnt = 0;
drhe9d1c722008-08-04 20:13:26 +0000386 if( pBuf==0 ){
drh63820332008-08-08 14:33:12 +0000387 sz = (sz + 7)&~7;
drhe9d1c722008-08-04 20:13:26 +0000388 sqlite3BeginBenignMalloc();
389 pStart = sqlite3Malloc( sz*cnt );
390 sqlite3EndBenignMalloc();
391 }else{
drh63820332008-08-08 14:33:12 +0000392 sz = sz&~7;
drhe9d1c722008-08-04 20:13:26 +0000393 pStart = pBuf;
394 }
395 if( db->lookaside.bMalloced ){
396 sqlite3_free(db->lookaside.pStart);
397 }
drh4cfb22f2008-08-01 18:47:01 +0000398 db->lookaside.pStart = pStart;
399 db->lookaside.pFree = 0;
400 db->lookaside.sz = sz;
drhe9d1c722008-08-04 20:13:26 +0000401 db->lookaside.bMalloced = pBuf==0;
drh633e6d52008-07-28 19:34:53 +0000402 if( pStart ){
403 int i;
404 LookasideSlot *p;
drh633e6d52008-07-28 19:34:53 +0000405 p = (LookasideSlot*)pStart;
406 for(i=cnt-1; i>=0; i--){
407 p->pNext = db->lookaside.pFree;
408 db->lookaside.pFree = p;
409 p = (LookasideSlot*)&((u8*)p)[sz];
410 }
411 db->lookaside.pEnd = p;
412 db->lookaside.bEnabled = 1;
drh4cfb22f2008-08-01 18:47:01 +0000413 }else{
414 db->lookaside.pEnd = 0;
415 db->lookaside.bEnabled = 0;
drh633e6d52008-07-28 19:34:53 +0000416 }
417 return SQLITE_OK;
418}
419
420/*
421** Configuration settings for an individual database connection
422*/
423int sqlite3_db_config(sqlite3 *db, int op, ...){
424 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000425 int rc;
drh633e6d52008-07-28 19:34:53 +0000426 va_start(ap, op);
427 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000428 case SQLITE_DBCONFIG_LOOKASIDE: {
429 void *pBuf = va_arg(ap, void*);
drh633e6d52008-07-28 19:34:53 +0000430 int sz = va_arg(ap, int);
431 int cnt = va_arg(ap, int);
drhe9d1c722008-08-04 20:13:26 +0000432 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000433 break;
434 }
drh6480aad2008-08-01 16:31:14 +0000435 default: {
436 rc = SQLITE_ERROR;
437 break;
438 }
drh633e6d52008-07-28 19:34:53 +0000439 }
440 va_end(ap);
441 return rc;
442}
443
444/*
drhc5499be2008-04-01 15:06:33 +0000445** Routine needed to support the testcase() macro.
446*/
447#ifdef SQLITE_COVERAGE_TEST
448void sqlite3Coverage(int x){
449 static int dummy = 0;
450 dummy += x;
451}
452#endif
453
drha16313e2007-03-30 11:29:32 +0000454
455/*
drh9b5adfa2008-01-20 23:19:56 +0000456** Return true if the buffer z[0..n-1] contains all spaces.
457*/
458static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000459 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000460 return n==0;
461}
462
463/*
drhd3d39e92004-05-20 22:16:29 +0000464** This is the default collating function named "BINARY" which is always
465** available.
drh9b5adfa2008-01-20 23:19:56 +0000466**
467** If the padFlag argument is not NULL then space padding at the end
468** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000469*/
danielk19772c336542005-01-13 02:14:23 +0000470static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000471 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000472 int nKey1, const void *pKey1,
473 int nKey2, const void *pKey2
474){
475 int rc, n;
476 n = nKey1<nKey2 ? nKey1 : nKey2;
477 rc = memcmp(pKey1, pKey2, n);
478 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000479 if( padFlag
480 && allSpaces(((char*)pKey1)+n, nKey1-n)
481 && allSpaces(((char*)pKey2)+n, nKey2-n)
482 ){
483 /* Leave rc unchanged at 0 */
484 }else{
485 rc = nKey1 - nKey2;
486 }
drhd3d39e92004-05-20 22:16:29 +0000487 }
488 return rc;
489}
490
491/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000492** Another built-in collating sequence: NOCASE.
493**
494** This collating sequence is intended to be used for "case independant
495** comparison". SQLite's knowledge of upper and lower case equivalents
496** extends only to the 26 characters used in the English language.
497**
498** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000499*/
500static int nocaseCollatingFunc(
501 void *NotUsed,
502 int nKey1, const void *pKey1,
503 int nKey2, const void *pKey2
504){
505 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000506 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk19770202b292004-06-09 09:55:16 +0000507 if( 0==r ){
508 r = nKey1-nKey2;
509 }
510 return r;
511}
512
513/*
drhaf9ff332002-01-16 21:00:27 +0000514** Return the ROWID of the most recent insert
515*/
drh9bb575f2004-09-06 17:24:11 +0000516sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000517 return db->lastRowid;
518}
519
520/*
danielk197724b03fd2004-05-10 10:34:34 +0000521** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000522*/
drh9bb575f2004-09-06 17:24:11 +0000523int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000524 return db->nChange;
525}
526
rdcf146a772004-02-25 22:51:06 +0000527/*
danielk1977b28af712004-06-21 06:50:26 +0000528** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000529*/
danielk1977b28af712004-06-21 06:50:26 +0000530int sqlite3_total_changes(sqlite3 *db){
531 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000532}
533
drhc8d30ac2002-04-12 10:08:59 +0000534/*
drh50e5dad2001-09-15 00:57:28 +0000535** Close an existing SQLite database
536*/
drh9bb575f2004-09-06 17:24:11 +0000537int sqlite3_close(sqlite3 *db){
drh8e0a2f92002-02-23 23:45:45 +0000538 HashElem *i;
drh001bbcb2003-03-19 03:14:00 +0000539 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000540
541 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000542 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000543 }
drh7e8b8482008-01-23 03:03:05 +0000544 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk1977e35ee192004-06-26 09:50:11 +0000545 return SQLITE_MISUSE;
546 }
drh605264d2007-08-21 15:13:19 +0000547 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000548
danielk19771f723bd2005-05-26 12:37:29 +0000549#ifdef SQLITE_SSE
drh37527852006-03-16 16:19:56 +0000550 {
551 extern void sqlite3SseCleanup(sqlite3*);
552 sqlite3SseCleanup(db);
553 }
danielk19771f723bd2005-05-26 12:37:29 +0000554#endif
555
drhffc13f62006-07-30 20:50:44 +0000556 sqlite3ResetInternalSchema(db, 0);
danielk1977a04a34f2007-04-16 15:06:25 +0000557
danielk197701256832007-04-18 14:24:32 +0000558 /* If a transaction is open, the ResetInternalSchema() call above
559 ** will not have called the xDisconnect() method on any virtual
560 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
561 ** call will do so. We need to do this before the check for active
562 ** SQL statements below, as the v-table implementation may be storing
563 ** some prepared statements internally.
564 */
565 sqlite3VtabRollback(db);
566
danielk1977a04a34f2007-04-16 15:06:25 +0000567 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +0000568 if( db->pVdbe ){
569 sqlite3Error(db, SQLITE_BUSY,
570 "Unable to close due to unfinalised statements");
drh27641702007-08-22 02:56:42 +0000571 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000572 return SQLITE_BUSY;
573 }
drh7e8b8482008-01-23 03:03:05 +0000574 assert( sqlite3SafetyCheckSickOrOk(db) );
danielk1977e0048402004-06-15 16:51:01 +0000575
drh001bbcb2003-03-19 03:14:00 +0000576 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000577 struct Db *pDb = &db->aDb[j];
578 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000579 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000580 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000581 if( j!=1 ){
582 pDb->pSchema = 0;
583 }
drh113088e2003-03-20 01:16:58 +0000584 }
drhf57b3392001-10-08 13:22:32 +0000585 }
danielk19774adee202004-05-08 08:23:19 +0000586 sqlite3ResetInternalSchema(db, 0);
drh1c2d8412003-03-31 00:30:47 +0000587 assert( db->nDb<=2 );
588 assert( db->aDb==db->aDbStatic );
drh70a8ca32008-08-21 18:49:27 +0000589 for(j=0; j<ArraySize(db->aFunc.a); j++){
590 FuncDef *pNext, *pHash, *p;
591 for(p=db->aFunc.a[j]; p; p=pHash){
592 pHash = p->pHash;
593 while( p ){
594 pNext = p->pNext;
595 sqlite3DbFree(db, p);
596 p = pNext;
597 }
drh8e0a2f92002-02-23 23:45:45 +0000598 }
599 }
danielk1977d8123362004-06-12 09:25:12 +0000600 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000601 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000602 /* Invoke any destructors registered for collation sequence user data. */
603 for(j=0; j<3; j++){
604 if( pColl[j].xDel ){
605 pColl[j].xDel(pColl[j].pUser);
606 }
607 }
drh633e6d52008-07-28 19:34:53 +0000608 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000609 }
danielk1977d8123362004-06-12 09:25:12 +0000610 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000611#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000612 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
613 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000614 if( pMod->xDestroy ){
615 pMod->xDestroy(pMod->pAux);
616 }
drh633e6d52008-07-28 19:34:53 +0000617 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000618 }
drhb9bb7c12006-06-11 23:41:55 +0000619 sqlite3HashClear(&db->aModule);
620#endif
danielk1977466be562004-06-10 02:16:01 +0000621
danielk19776622cce2004-05-20 11:00:52 +0000622 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000623 if( db->pErr ){
624 sqlite3ValueFree(db->pErr);
625 }
drhf1952c52006-06-08 15:48:00 +0000626 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000627
628 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000629
630 /* The temp-database schema is allocated differently from the other schema
631 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
632 ** So it needs to be freed here. Todo: Why not roll the temp schema into
633 ** the same sqliteMalloc() as the one that allocates the database
634 ** structure?
635 */
drh633e6d52008-07-28 19:34:53 +0000636 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000637 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000638 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000639 sqlite3_mutex_free(db->mutex);
drhe9d1c722008-08-04 20:13:26 +0000640 if( db->lookaside.bMalloced ){
641 sqlite3_free(db->lookaside.pStart);
642 }
drh17435752007-08-16 04:30:38 +0000643 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000644 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000645}
646
647/*
drh001bbcb2003-03-19 03:14:00 +0000648** Rollback all database files.
649*/
drh9bb575f2004-09-06 17:24:11 +0000650void sqlite3RollbackAll(sqlite3 *db){
drh001bbcb2003-03-19 03:14:00 +0000651 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000652 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000653 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +0000654 sqlite3BeginBenignMalloc();
drh001bbcb2003-03-19 03:14:00 +0000655 for(i=0; i<db->nDb; i++){
656 if( db->aDb[i].pBt ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000657 if( sqlite3BtreeIsInTrans(db->aDb[i].pBt) ){
658 inTrans = 1;
659 }
danielk19774adee202004-05-08 08:23:19 +0000660 sqlite3BtreeRollback(db->aDb[i].pBt);
drh001bbcb2003-03-19 03:14:00 +0000661 db->aDb[i].inTrans = 0;
662 }
663 }
danielk1977a298e902006-06-22 09:53:48 +0000664 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +0000665 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000666
danielk197771fd80b2005-12-16 06:54:01 +0000667 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000668 sqlite3ExpirePreparedStatements(db);
danielk197771fd80b2005-12-16 06:54:01 +0000669 sqlite3ResetInternalSchema(db, 0);
670 }
671
672 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000673 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000674 db->xRollbackCallback(db->pRollbackArg);
675 }
drh001bbcb2003-03-19 03:14:00 +0000676}
677
678/*
drhc22bd472002-05-10 13:14:07 +0000679** Return a static string that describes the kind of error specified in the
680** argument.
drh247be432002-05-10 05:44:55 +0000681*/
danielk1977f20b21c2004-05-31 23:56:42 +0000682const char *sqlite3ErrStr(int rc){
drhc22bd472002-05-10 13:14:07 +0000683 const char *z;
drh4ac285a2006-09-15 07:28:50 +0000684 switch( rc & 0xff ){
drhc60d0442004-09-30 13:43:13 +0000685 case SQLITE_ROW:
686 case SQLITE_DONE:
drhc22bd472002-05-10 13:14:07 +0000687 case SQLITE_OK: z = "not an error"; break;
688 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
drhc22bd472002-05-10 13:14:07 +0000689 case SQLITE_PERM: z = "access permission denied"; break;
690 case SQLITE_ABORT: z = "callback requested query abort"; break;
691 case SQLITE_BUSY: z = "database is locked"; break;
692 case SQLITE_LOCKED: z = "database table is locked"; break;
693 case SQLITE_NOMEM: z = "out of memory"; break;
694 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
695 case SQLITE_INTERRUPT: z = "interrupted"; break;
696 case SQLITE_IOERR: z = "disk I/O error"; break;
697 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
drh2db0bbc2005-08-11 02:10:18 +0000698 case SQLITE_FULL: z = "database or disk is full"; break;
drhc22bd472002-05-10 13:14:07 +0000699 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
drhc22bd472002-05-10 13:14:07 +0000700 case SQLITE_EMPTY: z = "table contains no data"; break;
701 case SQLITE_SCHEMA: z = "database schema has changed"; break;
drh023ae032007-05-08 12:12:16 +0000702 case SQLITE_TOOBIG: z = "String or BLOB exceeded size limit"; break;
drhc22bd472002-05-10 13:14:07 +0000703 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
704 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
705 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
drh65594042008-05-05 16:56:34 +0000706 case SQLITE_NOLFS: z = "large file support is disabled"; break;
drhed6c8672003-01-12 18:02:16 +0000707 case SQLITE_AUTH: z = "authorization denied"; break;
jplyon892f6712003-06-12 08:59:00 +0000708 case SQLITE_FORMAT: z = "auxiliary database format error"; break;
drhb08153d2004-11-20 20:18:55 +0000709 case SQLITE_RANGE: z = "bind or column index out of range"; break;
drhc602f9a2004-02-12 19:01:04 +0000710 case SQLITE_NOTADB: z = "file is encrypted or is not a database";break;
drhc22bd472002-05-10 13:14:07 +0000711 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000712 }
drhc22bd472002-05-10 13:14:07 +0000713 return z;
drh247be432002-05-10 05:44:55 +0000714}
715
716/*
drh2dfbbca2000-07-28 14:32:48 +0000717** This routine implements a busy callback that sleeps and tries
718** again until a timeout value is reached. The timeout value is
719** an integer number of milliseconds passed in as the first
720** argument.
721*/
drhdaffd0e2001-04-11 14:28:42 +0000722static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000723 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000724 int count /* Number of times table has been busy */
725){
danielk197729bafea2008-06-26 10:41:19 +0000726#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000727 static const u8 delays[] =
728 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
729 static const u8 totals[] =
730 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhd1bec472004-01-15 13:29:31 +0000731# define NDELAY (sizeof(delays)/sizeof(delays[0]))
danielk1977b4b47412007-08-17 15:53:36 +0000732 sqlite3 *db = (sqlite3 *)ptr;
733 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000734 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000735
drhee570fa2005-04-28 12:06:05 +0000736 assert( count>=0 );
737 if( count < NDELAY ){
738 delay = delays[count];
739 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000740 }else{
741 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000742 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000743 }
drhd1bec472004-01-15 13:29:31 +0000744 if( prior + delay > timeout ){
745 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +0000746 if( delay<=0 ) return 0;
747 }
danielk19772a6bdf62007-08-20 16:07:00 +0000748 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +0000749 return 1;
750#else
drh482ea182007-08-20 11:12:40 +0000751 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +0000752 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +0000753 if( (count+1)*1000 > timeout ){
754 return 0;
755 }
drh482ea182007-08-20 11:12:40 +0000756 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +0000757 return 1;
758#endif
759}
760
761/*
drha4afb652005-07-09 02:16:02 +0000762** Invoke the given busy handler.
763**
764** This routine is called when an operation failed with a lock.
765** If this routine returns non-zero, the lock is retried. If it
766** returns 0, the operation aborts with an SQLITE_BUSY error.
767*/
768int sqlite3InvokeBusyHandler(BusyHandler *p){
769 int rc;
drh34004ce2008-07-11 16:15:17 +0000770 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +0000771 rc = p->xFunc(p->pArg, p->nBusy);
772 if( rc==0 ){
773 p->nBusy = -1;
774 }else{
775 p->nBusy++;
776 }
777 return rc;
778}
779
780/*
drh2dfbbca2000-07-28 14:32:48 +0000781** This routine sets the busy callback for an Sqlite database to the
782** given callback function with the given argument.
783*/
danielk1977f9d64d22004-06-19 08:18:07 +0000784int sqlite3_busy_handler(
785 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +0000786 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +0000787 void *pArg
788){
drhe30f4422007-08-21 16:15:55 +0000789 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +0000790 db->busyHandler.xFunc = xBusy;
791 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +0000792 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +0000793 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +0000794 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000795}
796
danielk1977348bb5d2003-10-18 09:37:26 +0000797#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
798/*
799** This routine sets the progress callback for an Sqlite database to the
800** given callback function with the given argument. The progress callback will
801** be invoked every nOps opcodes.
802*/
danielk197724b03fd2004-05-10 10:34:34 +0000803void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +0000804 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +0000805 int nOps,
806 int (*xProgress)(void*),
807 void *pArg
808){
drhbd0b1b52008-07-07 19:52:09 +0000809 sqlite3_mutex_enter(db->mutex);
810 if( nOps>0 ){
811 db->xProgress = xProgress;
812 db->nProgressOps = nOps;
813 db->pProgressArg = pArg;
814 }else{
815 db->xProgress = 0;
816 db->nProgressOps = 0;
817 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +0000818 }
drhbd0b1b52008-07-07 19:52:09 +0000819 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +0000820}
821#endif
822
823
drh2dfbbca2000-07-28 14:32:48 +0000824/*
825** This routine installs a default busy handler that waits for the
826** specified number of milliseconds before returning 0.
827*/
danielk1977f9d64d22004-06-19 08:18:07 +0000828int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +0000829 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +0000830 db->busyTimeout = ms;
831 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +0000832 }else{
danielk197724b03fd2004-05-10 10:34:34 +0000833 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +0000834 }
danielk1977f9d64d22004-06-19 08:18:07 +0000835 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000836}
drh4c504392000-10-16 22:06:40 +0000837
838/*
839** Cause any pending operation to stop at its earliest opportunity.
840*/
drh9bb575f2004-09-06 17:24:11 +0000841void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +0000842 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +0000843}
drhfa86c412002-02-02 15:01:15 +0000844
drhfa86c412002-02-02 15:01:15 +0000845
846/*
danielk1977771151b2006-01-17 13:21:40 +0000847** This function is exactly the same as sqlite3_create_function(), except
848** that it is designed to be called by internal code. The difference is
849** that if a malloc() fails in sqlite3_create_function(), an error code
850** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +0000851*/
danielk1977771151b2006-01-17 13:21:40 +0000852int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +0000853 sqlite3 *db,
854 const char *zFunctionName,
855 int nArg,
danielk1977d8123362004-06-12 09:25:12 +0000856 int enc,
danielk197765904932004-05-26 06:18:37 +0000857 void *pUserData,
858 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
859 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
860 void (*xFinal)(sqlite3_context*)
drh8e0a2f92002-02-23 23:45:45 +0000861){
drh0bce8352002-02-28 00:41:10 +0000862 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000863 int nName;
danielk197765904932004-05-26 06:18:37 +0000864
drhe30f4422007-08-21 16:15:55 +0000865 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +0000866 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +0000867 (xFunc && (xFinal || xStep)) ||
868 (!xFunc && (xFinal && !xStep)) ||
869 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +0000870 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drh0a687d12008-07-08 14:52:07 +0000871 (255<(nName = sqlite3Strlen(db, zFunctionName))) ){
drhbadf7a72006-06-14 15:35:36 +0000872 sqlite3Error(db, SQLITE_ERROR, "bad parameters");
danielk197765904932004-05-26 06:18:37 +0000873 return SQLITE_ERROR;
874 }
danielk1977d8123362004-06-12 09:25:12 +0000875
danielk197793758c82005-01-21 08:13:14 +0000876#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +0000877 /* If SQLITE_UTF16 is specified as the encoding type, transform this
878 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
879 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
880 **
881 ** If SQLITE_ANY is specified, add three versions of the function
882 ** to the hash table.
883 */
884 if( enc==SQLITE_UTF16 ){
885 enc = SQLITE_UTF16NATIVE;
886 }else if( enc==SQLITE_ANY ){
887 int rc;
danielk1977771151b2006-01-17 13:21:40 +0000888 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
danielk1977f9d64d22004-06-19 08:18:07 +0000889 pUserData, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000890 if( rc==SQLITE_OK ){
891 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
892 pUserData, xFunc, xStep, xFinal);
893 }
894 if( rc!=SQLITE_OK ){
895 return rc;
896 }
danielk1977d8123362004-06-12 09:25:12 +0000897 enc = SQLITE_UTF16BE;
898 }
danielk197793758c82005-01-21 08:13:14 +0000899#else
900 enc = SQLITE_UTF8;
901#endif
danielk19779636c4e2005-01-25 04:27:54 +0000902
903 /* Check if an existing function is being overridden or deleted. If so,
904 ** and there are active VMs, then return SQLITE_BUSY. If a function
905 ** is being overridden/deleted but there are no active VMs, allow the
906 ** operation to continue but invalidate all precompiled statements.
907 */
908 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 0);
909 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
910 if( db->activeVdbeCnt ){
911 sqlite3Error(db, SQLITE_BUSY,
912 "Unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +0000913 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +0000914 return SQLITE_BUSY;
915 }else{
916 sqlite3ExpirePreparedStatements(db);
917 }
918 }
danielk197765904932004-05-26 06:18:37 +0000919
danielk1977d8123362004-06-12 09:25:12 +0000920 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +0000921 assert(p || db->mallocFailed);
922 if( !p ){
923 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +0000924 }
danielk1977fa18bec2007-09-03 11:04:22 +0000925 p->flags = 0;
926 p->xFunc = xFunc;
927 p->xStep = xStep;
928 p->xFinalize = xFinal;
929 p->pUserData = pUserData;
930 p->nArg = nArg;
danielk197765904932004-05-26 06:18:37 +0000931 return SQLITE_OK;
932}
danielk1977771151b2006-01-17 13:21:40 +0000933
934/*
935** Create new user functions.
936*/
937int sqlite3_create_function(
938 sqlite3 *db,
939 const char *zFunctionName,
940 int nArg,
941 int enc,
942 void *p,
943 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
944 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
945 void (*xFinal)(sqlite3_context*)
946){
947 int rc;
drhe30f4422007-08-21 16:15:55 +0000948 sqlite3_mutex_enter(db->mutex);
danielk1977771151b2006-01-17 13:21:40 +0000949 rc = sqlite3CreateFunc(db, zFunctionName, nArg, enc, p, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000950 rc = sqlite3ApiExit(db, rc);
951 sqlite3_mutex_leave(db->mutex);
952 return rc;
danielk1977771151b2006-01-17 13:21:40 +0000953}
954
danielk197793758c82005-01-21 08:13:14 +0000955#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +0000956int sqlite3_create_function16(
957 sqlite3 *db,
958 const void *zFunctionName,
959 int nArg,
960 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +0000961 void *p,
danielk197765904932004-05-26 06:18:37 +0000962 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
963 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
964 void (*xFinal)(sqlite3_context*)
965){
966 int rc;
drhaf9a7c22005-12-15 03:04:10 +0000967 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +0000968 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000969 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +0000970 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1);
danielk1977771151b2006-01-17 13:21:40 +0000971 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal);
drh633e6d52008-07-28 19:34:53 +0000972 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +0000973 rc = sqlite3ApiExit(db, rc);
974 sqlite3_mutex_leave(db->mutex);
975 return rc;
drh8e0a2f92002-02-23 23:45:45 +0000976}
danielk197793758c82005-01-21 08:13:14 +0000977#endif
drhc9b84a12002-06-20 11:36:48 +0000978
drhb7481e72006-09-16 21:45:14 +0000979
980/*
981** Declare that a function has been overloaded by a virtual table.
982**
983** If the function already exists as a regular global function, then
984** this routine is a no-op. If the function does not exist, then create
985** a new one that always throws a run-time error.
986**
987** When virtual tables intend to provide an overloaded function, they
988** should call this routine to make sure the global function exists.
989** A global function must exist in order for name resolution to work
990** properly.
991*/
992int sqlite3_overload_function(
993 sqlite3 *db,
994 const char *zName,
995 int nArg
996){
drh0a687d12008-07-08 14:52:07 +0000997 int nName = sqlite3Strlen(db, zName);
drhe30f4422007-08-21 16:15:55 +0000998 int rc;
999 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001000 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
1001 sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1002 0, sqlite3InvalidFunction, 0, 0);
1003 }
drhe30f4422007-08-21 16:15:55 +00001004 rc = sqlite3ApiExit(db, SQLITE_OK);
1005 sqlite3_mutex_leave(db->mutex);
1006 return rc;
drhb7481e72006-09-16 21:45:14 +00001007}
1008
drh19e2d372005-08-29 23:00:03 +00001009#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001010/*
drh18de4822003-01-16 16:28:53 +00001011** Register a trace function. The pArg from the previously registered trace
1012** is returned.
1013**
1014** A NULL trace function means that no tracing is executes. A non-NULL
1015** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001016** SQL statement.
drh18de4822003-01-16 16:28:53 +00001017*/
drh9bb575f2004-09-06 17:24:11 +00001018void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001019 void *pOld;
1020 sqlite3_mutex_enter(db->mutex);
1021 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001022 db->xTrace = xTrace;
1023 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001024 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001025 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001026}
drh19e2d372005-08-29 23:00:03 +00001027/*
1028** Register a profile function. The pArg from the previously registered
1029** profile function is returned.
1030**
1031** A NULL profile function means that no profiling is executes. A non-NULL
1032** profile is a pointer to a function that is invoked at the conclusion of
1033** each SQL statement that is run.
1034*/
1035void *sqlite3_profile(
1036 sqlite3 *db,
1037 void (*xProfile)(void*,const char*,sqlite_uint64),
1038 void *pArg
1039){
drhe30f4422007-08-21 16:15:55 +00001040 void *pOld;
1041 sqlite3_mutex_enter(db->mutex);
1042 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001043 db->xProfile = xProfile;
1044 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001045 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001046 return pOld;
1047}
1048#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001049
drhaa940ea2004-01-15 02:44:03 +00001050/*** EXPERIMENTAL ***
1051**
1052** Register a function to be invoked when a transaction comments.
danielk197771fd80b2005-12-16 06:54:01 +00001053** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001054** rollback.
1055*/
danielk197724b03fd2004-05-10 10:34:34 +00001056void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001057 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001058 int (*xCallback)(void*), /* Function to invoke on each commit */
1059 void *pArg /* Argument to the function */
1060){
drhe30f4422007-08-21 16:15:55 +00001061 void *pOld;
1062 sqlite3_mutex_enter(db->mutex);
1063 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001064 db->xCommitCallback = xCallback;
1065 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001066 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001067 return pOld;
1068}
1069
danielk197794eb6a12005-12-15 15:22:08 +00001070/*
1071** Register a callback to be invoked each time a row is updated,
1072** inserted or deleted using this database connection.
1073*/
danielk197771fd80b2005-12-16 06:54:01 +00001074void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001075 sqlite3 *db, /* Attach the hook to this database */
1076 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1077 void *pArg /* Argument to the function */
1078){
drhe30f4422007-08-21 16:15:55 +00001079 void *pRet;
1080 sqlite3_mutex_enter(db->mutex);
1081 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001082 db->xUpdateCallback = xCallback;
1083 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001084 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001085 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001086}
1087
danielk197771fd80b2005-12-16 06:54:01 +00001088/*
1089** Register a callback to be invoked each time a transaction is rolled
1090** back by this database connection.
1091*/
1092void *sqlite3_rollback_hook(
1093 sqlite3 *db, /* Attach the hook to this database */
1094 void (*xCallback)(void*), /* Callback function */
1095 void *pArg /* Argument to the function */
1096){
drhe30f4422007-08-21 16:15:55 +00001097 void *pRet;
1098 sqlite3_mutex_enter(db->mutex);
1099 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001100 db->xRollbackCallback = xCallback;
1101 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001102 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001103 return pRet;
1104}
drhaa940ea2004-01-15 02:44:03 +00001105
paulb0208cc2003-04-13 18:26:49 +00001106/*
drh13bff812003-04-15 01:19:47 +00001107** This routine is called to create a connection to a database BTree
1108** driver. If zFilename is the name of a file, then that file is
1109** opened and used. If zFilename is the magic name ":memory:" then
1110** the database is stored in memory (and is thus forgotten as soon as
1111** the connection is closed.) If zFilename is NULL then the database
drh84bfda42005-07-15 13:05:21 +00001112** is a "virtual" database for transient use only and is deleted as
1113** soon as the connection is closed.
drh90f5ecb2004-07-22 01:19:35 +00001114**
drh84bfda42005-07-15 13:05:21 +00001115** A virtual database can be either a disk file (that is automatically
1116** deleted when the file is closed) or it an be held entirely in memory,
danielk1977b06a0b62008-06-26 10:54:12 +00001117** depending on the values of the SQLITE_TEMP_STORE compile-time macro and the
drh90f5ecb2004-07-22 01:19:35 +00001118** db->temp_store variable, according to the following chart:
1119**
danielk1977b06a0b62008-06-26 10:54:12 +00001120** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1121** ----------------- -------------- ------------------------------
1122** 0 any file
1123** 1 1 file
1124** 1 2 memory
1125** 1 0 file
1126** 2 1 file
1127** 2 2 memory
1128** 2 0 memory
1129** 3 any memory
paulb0208cc2003-04-13 18:26:49 +00001130*/
danielk19774adee202004-05-08 08:23:19 +00001131int sqlite3BtreeFactory(
drh9bb575f2004-09-06 17:24:11 +00001132 const sqlite3 *db, /* Main database when opening aux otherwise 0 */
paulb0208cc2003-04-13 18:26:49 +00001133 const char *zFilename, /* Name of the file containing the BTree database */
1134 int omitJournal, /* if TRUE then do not journal this file */
1135 int nCache, /* How many pages in the page cache */
drh33f4e022007-09-03 15:19:34 +00001136 int vfsFlags, /* Flags passed through to vfsOpen */
danielk19774adee202004-05-08 08:23:19 +00001137 Btree **ppBtree /* Pointer to new Btree object written here */
1138){
drh33f4e022007-09-03 15:19:34 +00001139 int btFlags = 0;
drh90f5ecb2004-07-22 01:19:35 +00001140 int rc;
danielk19774adee202004-05-08 08:23:19 +00001141
drhe30f4422007-08-21 16:15:55 +00001142 assert( sqlite3_mutex_held(db->mutex) );
drheec983e2004-05-08 10:11:36 +00001143 assert( ppBtree != 0);
danielk19774adee202004-05-08 08:23:19 +00001144 if( omitJournal ){
drh33f4e022007-09-03 15:19:34 +00001145 btFlags |= BTREE_OMIT_JOURNAL;
paulb0208cc2003-04-13 18:26:49 +00001146 }
drh7bec5052005-02-06 02:45:41 +00001147 if( db->flags & SQLITE_NoReadlock ){
drh33f4e022007-09-03 15:19:34 +00001148 btFlags |= BTREE_NO_READLOCK;
drh7bec5052005-02-06 02:45:41 +00001149 }
drh90f5ecb2004-07-22 01:19:35 +00001150 if( zFilename==0 ){
danielk1977b06a0b62008-06-26 10:54:12 +00001151#if SQLITE_TEMP_STORE==0
drh22ac46d2004-08-14 18:34:54 +00001152 /* Do nothing */
drh90f5ecb2004-07-22 01:19:35 +00001153#endif
danielk197703aded42004-11-22 05:26:27 +00001154#ifndef SQLITE_OMIT_MEMORYDB
danielk1977b06a0b62008-06-26 10:54:12 +00001155#if SQLITE_TEMP_STORE==1
drh22ac46d2004-08-14 18:34:54 +00001156 if( db->temp_store==2 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001157#endif
danielk1977b06a0b62008-06-26 10:54:12 +00001158#if SQLITE_TEMP_STORE==2
drh22ac46d2004-08-14 18:34:54 +00001159 if( db->temp_store!=1 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001160#endif
danielk1977b06a0b62008-06-26 10:54:12 +00001161#if SQLITE_TEMP_STORE==3
drh22ac46d2004-08-14 18:34:54 +00001162 zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001163#endif
danielk197703aded42004-11-22 05:26:27 +00001164#endif /* SQLITE_OMIT_MEMORYDB */
drh90f5ecb2004-07-22 01:19:35 +00001165 }
danielk19774adee202004-05-08 08:23:19 +00001166
drh33f4e022007-09-03 15:19:34 +00001167 if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (zFilename==0 || *zFilename==0) ){
1168 vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
1169 }
1170 rc = sqlite3BtreeOpen(zFilename, (sqlite3 *)db, ppBtree, btFlags, vfsFlags);
danielk1977171bfed2008-06-23 09:50:50 +00001171
1172 /* If the B-Tree was successfully opened, set the pager-cache size to the
1173 ** default value. Except, if the call to BtreeOpen() returned a handle
1174 ** open on an existing shared pager-cache, do not change the pager-cache
1175 ** size.
1176 */
1177 if( rc==SQLITE_OK && 0==sqlite3BtreeSchema(*ppBtree, 0, 0) ){
drh90f5ecb2004-07-22 01:19:35 +00001178 sqlite3BtreeSetCacheSize(*ppBtree, nCache);
1179 }
1180 return rc;
paulb0208cc2003-04-13 18:26:49 +00001181}
danielk19774adee202004-05-08 08:23:19 +00001182
danielk19774ad17132004-05-21 01:47:26 +00001183/*
1184** Return UTF-8 encoded English language explanation of the most recent
1185** error.
1186*/
danielk19776622cce2004-05-20 11:00:52 +00001187const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001188 const char *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001189 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001190 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001191 }
drhd55d57e2008-07-07 17:53:07 +00001192 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk1977e35ee192004-06-26 09:50:11 +00001193 return sqlite3ErrStr(SQLITE_MISUSE);
1194 }
drh27641702007-08-22 02:56:42 +00001195 sqlite3_mutex_enter(db->mutex);
drh86f8c192007-08-22 00:39:19 +00001196 assert( !db->mallocFailed );
drh2646da72005-12-09 20:02:05 +00001197 z = (char*)sqlite3_value_text(db->pErr);
danielk1977131c8bc2008-05-22 13:56:17 +00001198 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +00001199 if( z==0 ){
1200 z = sqlite3ErrStr(db->errCode);
danielk19776622cce2004-05-20 11:00:52 +00001201 }
drhe30f4422007-08-21 16:15:55 +00001202 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001203 return z;
danielk19776622cce2004-05-20 11:00:52 +00001204}
1205
drh6c626082004-11-14 21:56:29 +00001206#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001207/*
1208** Return UTF-16 encoded English language explanation of the most recent
1209** error.
1210*/
danielk19776622cce2004-05-20 11:00:52 +00001211const void *sqlite3_errmsg16(sqlite3 *db){
danielk1977bfd6cce2004-06-18 04:24:54 +00001212 /* Because all the characters in the string are in the unicode
1213 ** range 0x00-0xFF, if we pad the big-endian string with a
1214 ** zero byte, we can obtain the little-endian string with
1215 ** &big_endian[1].
1216 */
drh57196282004-10-06 15:41:16 +00001217 static const char outOfMemBe[] = {
danielk1977bfd6cce2004-06-18 04:24:54 +00001218 0, 'o', 0, 'u', 0, 't', 0, ' ',
1219 0, 'o', 0, 'f', 0, ' ',
1220 0, 'm', 0, 'e', 0, 'm', 0, 'o', 0, 'r', 0, 'y', 0, 0, 0
1221 };
drh57196282004-10-06 15:41:16 +00001222 static const char misuseBe [] = {
danielk1977e35ee192004-06-26 09:50:11 +00001223 0, 'l', 0, 'i', 0, 'b', 0, 'r', 0, 'a', 0, 'r', 0, 'y', 0, ' ',
1224 0, 'r', 0, 'o', 0, 'u', 0, 't', 0, 'i', 0, 'n', 0, 'e', 0, ' ',
1225 0, 'c', 0, 'a', 0, 'l', 0, 'l', 0, 'e', 0, 'd', 0, ' ',
1226 0, 'o', 0, 'u', 0, 't', 0, ' ',
1227 0, 'o', 0, 'f', 0, ' ',
1228 0, 's', 0, 'e', 0, 'q', 0, 'u', 0, 'e', 0, 'n', 0, 'c', 0, 'e', 0, 0, 0
1229 };
danielk19774ad17132004-05-21 01:47:26 +00001230
drhc60d0442004-09-30 13:43:13 +00001231 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001232 if( !db ){
drhc60d0442004-09-30 13:43:13 +00001233 return (void *)(&outOfMemBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
1234 }
drhd55d57e2008-07-07 17:53:07 +00001235 if( !sqlite3SafetyCheckSickOrOk(db) ){
drhc60d0442004-09-30 13:43:13 +00001236 return (void *)(&misuseBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
1237 }
drhe30f4422007-08-21 16:15:55 +00001238 sqlite3_mutex_enter(db->mutex);
1239 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +00001240 z = sqlite3_value_text16(db->pErr);
1241 if( z==0 ){
drhb21c8cd2007-08-21 19:33:56 +00001242 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
drhc60d0442004-09-30 13:43:13 +00001243 SQLITE_UTF8, SQLITE_STATIC);
1244 z = sqlite3_value_text16(db->pErr);
1245 }
danielk1977131c8bc2008-05-22 13:56:17 +00001246 /* A malloc() may have failed within the call to sqlite3_value_text16()
1247 ** above. If this is the case, then the db->mallocFailed flag needs to
1248 ** be cleared before returning. Do this directly, instead of via
1249 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1250 */
1251 db->mallocFailed = 0;
drhe30f4422007-08-21 16:15:55 +00001252 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001253 return z;
danielk19776622cce2004-05-20 11:00:52 +00001254}
drh6c626082004-11-14 21:56:29 +00001255#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001256
drhc60d0442004-09-30 13:43:13 +00001257/*
danielk19777ddad962005-12-12 06:53:03 +00001258** Return the most recent error code generated by an SQLite routine. If NULL is
1259** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001260*/
danielk19776622cce2004-05-20 11:00:52 +00001261int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001262 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drhc60d0442004-09-30 13:43:13 +00001263 return SQLITE_MISUSE;
1264 }
drh01495b92008-01-23 12:52:40 +00001265 if( !db || db->mallocFailed ){
1266 return SQLITE_NOMEM;
1267 }
drh4ac285a2006-09-15 07:28:50 +00001268 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001269}
1270
drh0e819f92006-02-01 13:50:41 +00001271/*
1272** Create a new collating function for database "db". The name is zName
1273** and the encoding is enc.
1274*/
danielk19779a30cf62006-01-18 04:26:07 +00001275static int createCollation(
1276 sqlite3* db,
1277 const char *zName,
1278 int enc,
1279 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001280 int(*xCompare)(void*,int,const void*,int,const void*),
1281 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001282){
1283 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001284 int enc2;
drh0a687d12008-07-08 14:52:07 +00001285 int nName;
danielk19779a30cf62006-01-18 04:26:07 +00001286
drhe30f4422007-08-21 16:15:55 +00001287 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001288
1289 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1290 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1291 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1292 */
drh7d9bd4e2006-02-16 18:16:36 +00001293 enc2 = enc & ~SQLITE_UTF16_ALIGNED;
1294 if( enc2==SQLITE_UTF16 ){
1295 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001296 }
drh7d9bd4e2006-02-16 18:16:36 +00001297 if( (enc2&~3)!=0 ){
drhd55d57e2008-07-07 17:53:07 +00001298 return SQLITE_MISUSE;
danielk19779a30cf62006-01-18 04:26:07 +00001299 }
1300
1301 /* Check if this call is removing or replacing an existing collation
1302 ** sequence. If so, and there are active VMs, return busy. If there
1303 ** are no active VMs, invalidate any pre-compiled statements.
1304 */
drh0a687d12008-07-08 14:52:07 +00001305 nName = sqlite3Strlen(db, zName);
1306 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, nName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001307 if( pColl && pColl->xCmp ){
1308 if( db->activeVdbeCnt ){
1309 sqlite3Error(db, SQLITE_BUSY,
1310 "Unable to delete/modify collation sequence due to active statements");
1311 return SQLITE_BUSY;
1312 }
1313 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001314
1315 /* If collation sequence pColl was created directly by a call to
1316 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1317 ** then any copies made by synthCollSeq() need to be invalidated.
1318 ** Also, collation destructor - CollSeq.xDel() - function may need
1319 ** to be called.
1320 */
1321 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001322 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001323 int j;
1324 for(j=0; j<3; j++){
1325 CollSeq *p = &aColl[j];
1326 if( p->enc==pColl->enc ){
1327 if( p->xDel ){
1328 p->xDel(p->pUser);
1329 }
1330 p->xCmp = 0;
1331 }
1332 }
1333 }
danielk19779a30cf62006-01-18 04:26:07 +00001334 }
1335
drh0a687d12008-07-08 14:52:07 +00001336 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, nName, 1);
danielk19779a30cf62006-01-18 04:26:07 +00001337 if( pColl ){
1338 pColl->xCmp = xCompare;
1339 pColl->pUser = pCtx;
danielk1977a9808b32007-05-07 09:32:45 +00001340 pColl->xDel = xDel;
drh7d9bd4e2006-02-16 18:16:36 +00001341 pColl->enc = enc2 | (enc & SQLITE_UTF16_ALIGNED);
danielk19779a30cf62006-01-18 04:26:07 +00001342 }
1343 sqlite3Error(db, SQLITE_OK, 0);
1344 return SQLITE_OK;
1345}
1346
1347
danielk19776622cce2004-05-20 11:00:52 +00001348/*
drhbb4957f2008-03-20 14:03:29 +00001349** This array defines hard upper bounds on limit values. The
1350** initializer must be kept in sync with the SQLITE_LIMIT_*
1351** #defines in sqlite3.h.
1352*/
drhb1a6c3c2008-03-20 16:30:17 +00001353static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00001354 SQLITE_MAX_LENGTH,
1355 SQLITE_MAX_SQL_LENGTH,
1356 SQLITE_MAX_COLUMN,
1357 SQLITE_MAX_EXPR_DEPTH,
1358 SQLITE_MAX_COMPOUND_SELECT,
1359 SQLITE_MAX_VDBE_OP,
1360 SQLITE_MAX_FUNCTION_ARG,
1361 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00001362 SQLITE_MAX_LIKE_PATTERN_LENGTH,
1363 SQLITE_MAX_VARIABLE_NUMBER,
1364};
1365
1366/*
1367** Make sure the hard limits are set to reasonable values
1368*/
1369#if SQLITE_MAX_LENGTH<100
1370# error SQLITE_MAX_LENGTH must be at least 100
1371#endif
1372#if SQLITE_MAX_SQL_LENGTH<100
1373# error SQLITE_MAX_SQL_LENGTH must be at least 100
1374#endif
1375#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
1376# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
1377#endif
drhbb4957f2008-03-20 14:03:29 +00001378#if SQLITE_MAX_COMPOUND_SELECT<2
1379# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
1380#endif
1381#if SQLITE_MAX_VDBE_OP<40
1382# error SQLITE_MAX_VDBE_OP must be at least 40
1383#endif
drhe82f5d02008-10-07 19:53:14 +00001384#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
1385# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00001386#endif
danielk19777b7e23b2008-08-20 16:21:12 +00001387#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>30
1388# error SQLITE_MAX_ATTACHED must be between 0 and 30
drhbb4957f2008-03-20 14:03:29 +00001389#endif
drhbb4957f2008-03-20 14:03:29 +00001390#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
1391# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
1392#endif
1393#if SQLITE_MAX_VARIABLE_NUMBER<1
1394# error SQLITE_MAX_VARIABLE_NUMBER must be at least 1
1395#endif
drh70a8ca32008-08-21 18:49:27 +00001396#if SQLITE_MAX_COLUMN>32767
1397# error SQLITE_MAX_COLUMN must not exceed 32767
1398#endif
drhbb4957f2008-03-20 14:03:29 +00001399
1400
1401/*
1402** Change the value of a limit. Report the old value.
1403** If an invalid limit index is supplied, report -1.
1404** Make no changes but still report the old value if the
1405** new limit is negative.
1406**
1407** A new lower limit does not shrink existing constructs.
1408** It merely prevents new constructs that exceed the limit
1409** from forming.
1410*/
1411int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
1412 int oldLimit;
drh521cc842008-04-15 02:36:33 +00001413 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00001414 return -1;
1415 }
1416 oldLimit = db->aLimit[limitId];
1417 if( newLimit>=0 ){
drhf47ce562008-03-20 18:00:49 +00001418 if( newLimit>aHardLimit[limitId] ){
drhbb4957f2008-03-20 14:03:29 +00001419 newLimit = aHardLimit[limitId];
1420 }
1421 db->aLimit[limitId] = newLimit;
1422 }
1423 return oldLimit;
1424}
1425
1426/*
danielk19774ad17132004-05-21 01:47:26 +00001427** This routine does the work of opening a database on behalf of
1428** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00001429** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00001430*/
1431static int openDatabase(
1432 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00001433 sqlite3 **ppDb, /* OUT: Returned database handle */
1434 unsigned flags, /* Operational flags */
1435 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00001436){
1437 sqlite3 *db;
danielk1977da184232006-01-05 11:34:32 +00001438 int rc;
drhd64fe2f2005-08-28 17:00:23 +00001439 CollSeq *pColl;
drh039963a2008-09-03 00:43:15 +00001440 int isThreadsafe;
danielk19774ad17132004-05-21 01:47:26 +00001441
drh40257ff2008-06-13 18:24:27 +00001442#ifndef SQLITE_OMIT_AUTOINIT
1443 rc = sqlite3_initialize();
1444 if( rc ) return rc;
1445#endif
1446
drh039963a2008-09-03 00:43:15 +00001447 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00001448 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00001449 }else if( flags & SQLITE_OPEN_NOMUTEX ){
1450 isThreadsafe = 0;
1451 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
1452 isThreadsafe = 1;
1453 }else{
1454 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00001455 }
1456
drha4267dc2008-02-19 15:20:44 +00001457 /* Remove harmful bits from the flags parameter */
1458 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
1459 SQLITE_OPEN_MAIN_DB |
1460 SQLITE_OPEN_TEMP_DB |
1461 SQLITE_OPEN_TRANSIENT_DB |
1462 SQLITE_OPEN_MAIN_JOURNAL |
1463 SQLITE_OPEN_TEMP_JOURNAL |
1464 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00001465 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00001466 SQLITE_OPEN_NOMUTEX |
1467 SQLITE_OPEN_FULLMUTEX
drha4267dc2008-02-19 15:20:44 +00001468 );
1469
danielk19774ad17132004-05-21 01:47:26 +00001470 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00001471 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00001472 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00001473 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00001474 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
1475 if( db->mutex==0 ){
1476 sqlite3_free(db);
1477 db = 0;
1478 goto opendb_out;
1479 }
drh605264d2007-08-21 15:13:19 +00001480 }
drh27641702007-08-22 02:56:42 +00001481 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001482 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00001483 db->priorNewRowid = 0;
danielk19774ad17132004-05-21 01:47:26 +00001484 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00001485 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00001486 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00001487
drhbb4957f2008-03-20 14:03:29 +00001488 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
1489 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00001490 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00001491 db->nextAutovac = -1;
danielk1977f653d782008-03-20 11:04:21 +00001492 db->nextPagesize = 0;
drh76fe8032006-07-11 14:17:51 +00001493 db->flags |= SQLITE_ShortColNames
1494#if SQLITE_DEFAULT_FILE_FORMAT<4
1495 | SQLITE_LegacyFileFmt
1496#endif
drh56424db2007-03-27 22:24:11 +00001497#ifdef SQLITE_ENABLE_LOAD_EXTENSION
1498 | SQLITE_LoadExtension
1499#endif
drh76fe8032006-07-11 14:17:51 +00001500 ;
drh1b67f3c2008-10-10 17:41:28 +00001501 sqlite3HashInit(&db->aCollSeq, 0);
drhb9bb7c12006-06-11 23:41:55 +00001502#ifndef SQLITE_OMIT_VIRTUALTABLE
drh1b67f3c2008-10-10 17:41:28 +00001503 sqlite3HashInit(&db->aModule, 0);
drhb9bb7c12006-06-11 23:41:55 +00001504#endif
danielk1977da184232006-01-05 11:34:32 +00001505
danielk197795c8a542007-09-01 06:51:27 +00001506 db->pVfs = sqlite3_vfs_find(zVfs);
1507 if( !db->pVfs ){
1508 rc = SQLITE_ERROR;
drhafc91042008-02-21 02:09:45 +00001509 sqlite3Error(db, rc, "no such vfs: %s", zVfs);
danielk197795c8a542007-09-01 06:51:27 +00001510 goto opendb_out;
1511 }
1512
danielk19770202b292004-06-09 09:55:16 +00001513 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
1514 ** and UTF-16, so add a version for each to avoid any unnecessary
1515 ** conversions. The only error that can occur here is a malloc() failure.
1516 */
drhafc91042008-02-21 02:09:45 +00001517 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
1518 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
1519 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
1520 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00001521 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00001522 goto opendb_out;
1523 }
drh77db4c02008-03-18 13:01:38 +00001524 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0);
1525 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00001526
1527 /* Also add a UTF-8 case-insensitive collation sequence. */
danielk1977a9808b32007-05-07 09:32:45 +00001528 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
danielk19770202b292004-06-09 09:55:16 +00001529
drhd64fe2f2005-08-28 17:00:23 +00001530 /* Set flags on the built-in collating sequences */
1531 db->pDfltColl->type = SQLITE_COLL_BINARY;
1532 pColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "NOCASE", 6, 0);
1533 if( pColl ){
1534 pColl->type = SQLITE_COLL_NOCASE;
1535 }
1536
danielk19774ad17132004-05-21 01:47:26 +00001537 /* Open the backend database driver */
drh33f4e022007-09-03 15:19:34 +00001538 db->openFlags = flags;
1539 rc = sqlite3BtreeFactory(db, zFilename, 0, SQLITE_DEFAULT_CACHE_SIZE,
1540 flags | SQLITE_OPEN_MAIN_DB,
drhc797d4d2007-05-08 01:08:49 +00001541 &db->aDb[0].pBt);
danielk19774ad17132004-05-21 01:47:26 +00001542 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00001543 if( rc==SQLITE_IOERR_NOMEM ){
1544 rc = SQLITE_NOMEM;
1545 }
danielk19774ad17132004-05-21 01:47:26 +00001546 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00001547 goto opendb_out;
1548 }
drh17435752007-08-16 04:30:38 +00001549 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
1550 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00001551
drh03b808a2006-03-13 15:06:05 +00001552
danielk197753c0f742005-03-29 03:10:59 +00001553 /* The default safety_level for the main database is 'full'; for the temp
1554 ** database it is 'NONE'. This matches the pager layer defaults.
1555 */
1556 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00001557 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00001558#ifndef SQLITE_OMIT_TEMPDB
1559 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00001560 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00001561#endif
1562
danielk1977832a58a2007-06-22 15:21:15 +00001563 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00001564 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00001565 goto opendb_out;
1566 }
1567
danielk19778e227872004-06-07 07:52:17 +00001568 /* Register all built-in functions, but do not attempt to read the
1569 ** database schema yet. This is delayed until the first time the database
1570 ** is accessed.
1571 */
danielk1977832a58a2007-06-22 15:21:15 +00001572 sqlite3Error(db, SQLITE_OK, 0);
1573 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00001574
drh1409be62006-08-23 20:07:20 +00001575 /* Load automatic extensions - extensions that have been registered
1576 ** using the sqlite3_automatic_extension() API.
1577 */
drhf533acc2006-12-19 18:57:11 +00001578 (void)sqlite3AutoLoadExtensions(db);
danielk1977832a58a2007-06-22 15:21:15 +00001579 if( sqlite3_errcode(db)!=SQLITE_OK ){
1580 goto opendb_out;
1581 }
drh1409be62006-08-23 20:07:20 +00001582
drhaa29c132006-09-02 13:58:06 +00001583#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00001584 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00001585 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001586 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00001587 }
1588#endif
1589
shessa26cf572006-10-19 20:27:58 +00001590#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00001591 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00001592 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001593 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00001594 }
1595#endif
1596
shess69c4ae22007-08-20 17:37:47 +00001597#ifdef SQLITE_ENABLE_FTS3
1598 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00001599 rc = sqlite3Fts3Init(db);
1600 }
1601#endif
1602
danielk197783852ac2007-05-06 16:04:11 +00001603#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00001604 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00001605 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00001606 }
1607#endif
danielk1977ebaecc12008-05-26 18:41:54 +00001608
1609#ifdef SQLITE_ENABLE_RTREE
1610 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00001611 rc = sqlite3RtreeInit(db);
1612 }
1613#endif
1614
danielk1977832a58a2007-06-22 15:21:15 +00001615 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00001616
drh8fd5bd32007-04-02 16:40:37 +00001617 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
1618 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
1619 ** mode. Doing nothing at all also makes NORMAL the default.
1620 */
1621#ifdef SQLITE_DEFAULT_LOCKING_MODE
1622 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
1623 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
1624 SQLITE_DEFAULT_LOCKING_MODE);
1625#endif
1626
drh633e6d52008-07-28 19:34:53 +00001627 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00001628 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
1629 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00001630
danielk19774ad17132004-05-21 01:47:26 +00001631opendb_out:
drhafc91042008-02-21 02:09:45 +00001632 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00001633 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00001634 sqlite3_mutex_leave(db->mutex);
1635 }
danielk197759633ae2008-08-27 19:01:57 +00001636 rc = sqlite3_errcode(db);
1637 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00001638 sqlite3_close(db);
1639 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00001640 }else if( rc!=SQLITE_OK ){
1641 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00001642 }
danielk19774ad17132004-05-21 01:47:26 +00001643 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00001644 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001645}
1646
1647/*
1648** Open a new database handle.
1649*/
danielk197780290862004-05-22 09:21:21 +00001650int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00001651 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001652 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001653){
drh605264d2007-08-21 15:13:19 +00001654 return openDatabase(zFilename, ppDb,
1655 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
1656}
1657int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00001658 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00001659 sqlite3 **ppDb, /* OUT: SQLite db handle */
1660 int flags, /* Flags */
1661 const char *zVfs /* Name of VFS module to use */
1662){
1663 return openDatabase(filename, ppDb, flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00001664}
1665
drh6c626082004-11-14 21:56:29 +00001666#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001667/*
1668** Open a new database handle.
1669*/
1670int sqlite3_open16(
1671 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001672 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001673){
danielk1977bfd6cce2004-06-18 04:24:54 +00001674 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00001675 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00001676 int rc;
danielk19774ad17132004-05-21 01:47:26 +00001677
danielk19777ddad962005-12-12 06:53:03 +00001678 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00001679 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00001680 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00001681#ifndef SQLITE_OMIT_AUTOINIT
1682 rc = sqlite3_initialize();
1683 if( rc ) return rc;
1684#endif
danielk19771e536952007-08-16 10:09:01 +00001685 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00001686 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
1687 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001688 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00001689 rc = openDatabase(zFilename8, ppDb,
1690 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00001691 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00001692 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00001693 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00001694 }
drh40257ff2008-06-13 18:24:27 +00001695 }else{
1696 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00001697 }
danielk19777ddad962005-12-12 06:53:03 +00001698 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00001699
danielk197754f01982006-01-18 15:25:17 +00001700 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001701}
drh6c626082004-11-14 21:56:29 +00001702#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00001703
danielk1977106bb232004-05-21 10:08:53 +00001704/*
danielk1977d8123362004-06-12 09:25:12 +00001705** Register a new collation sequence with the database handle db.
1706*/
danielk19770202b292004-06-09 09:55:16 +00001707int sqlite3_create_collation(
1708 sqlite3* db,
1709 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001710 int enc,
danielk19770202b292004-06-09 09:55:16 +00001711 void* pCtx,
1712 int(*xCompare)(void*,int,const void*,int,const void*)
1713){
danielk19779a30cf62006-01-18 04:26:07 +00001714 int rc;
drhe30f4422007-08-21 16:15:55 +00001715 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001716 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001717 rc = createCollation(db, zName, enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00001718 rc = sqlite3ApiExit(db, rc);
1719 sqlite3_mutex_leave(db->mutex);
1720 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00001721}
1722
1723/*
1724** Register a new collation sequence with the database handle db.
1725*/
danielk1977a393c032007-05-07 14:58:53 +00001726int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00001727 sqlite3* db,
1728 const char *zName,
1729 int enc,
1730 void* pCtx,
1731 int(*xCompare)(void*,int,const void*,int,const void*),
1732 void(*xDel)(void*)
1733){
1734 int rc;
drhe30f4422007-08-21 16:15:55 +00001735 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001736 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001737 rc = createCollation(db, zName, enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00001738 rc = sqlite3ApiExit(db, rc);
1739 sqlite3_mutex_leave(db->mutex);
1740 return rc;
danielk19770202b292004-06-09 09:55:16 +00001741}
1742
drh6c626082004-11-14 21:56:29 +00001743#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001744/*
1745** Register a new collation sequence with the database handle db.
1746*/
danielk19770202b292004-06-09 09:55:16 +00001747int sqlite3_create_collation16(
1748 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00001749 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00001750 int enc,
danielk19770202b292004-06-09 09:55:16 +00001751 void* pCtx,
1752 int(*xCompare)(void*,int,const void*,int,const void*)
1753){
danielk19779a30cf62006-01-18 04:26:07 +00001754 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00001755 char *zName8;
drhe30f4422007-08-21 16:15:55 +00001756 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001757 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00001758 zName8 = sqlite3Utf16to8(db, zName, -1);
danielk19779a30cf62006-01-18 04:26:07 +00001759 if( zName8 ){
danielk1977a9808b32007-05-07 09:32:45 +00001760 rc = createCollation(db, zName8, enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00001761 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00001762 }
drhe30f4422007-08-21 16:15:55 +00001763 rc = sqlite3ApiExit(db, rc);
1764 sqlite3_mutex_leave(db->mutex);
1765 return rc;
danielk19770202b292004-06-09 09:55:16 +00001766}
drh6c626082004-11-14 21:56:29 +00001767#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00001768
danielk1977d8123362004-06-12 09:25:12 +00001769/*
1770** Register a collation sequence factory callback with the database handle
1771** db. Replace any previously installed collation sequence factory.
1772*/
danielk19777cedc8d2004-06-10 10:50:08 +00001773int sqlite3_collation_needed(
1774 sqlite3 *db,
1775 void *pCollNeededArg,
1776 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
1777){
drhe30f4422007-08-21 16:15:55 +00001778 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001779 db->xCollNeeded = xCollNeeded;
1780 db->xCollNeeded16 = 0;
1781 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001782 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001783 return SQLITE_OK;
1784}
danielk1977d8123362004-06-12 09:25:12 +00001785
drh6c626082004-11-14 21:56:29 +00001786#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001787/*
1788** Register a collation sequence factory callback with the database handle
1789** db. Replace any previously installed collation sequence factory.
1790*/
danielk19777cedc8d2004-06-10 10:50:08 +00001791int sqlite3_collation_needed16(
1792 sqlite3 *db,
1793 void *pCollNeededArg,
1794 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
1795){
drhe30f4422007-08-21 16:15:55 +00001796 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001797 db->xCollNeeded = 0;
1798 db->xCollNeeded16 = xCollNeeded16;
1799 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001800 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001801 return SQLITE_OK;
1802}
drh6c626082004-11-14 21:56:29 +00001803#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00001804
1805#ifndef SQLITE_OMIT_GLOBALRECOVER
1806/*
danielk19777ddad962005-12-12 06:53:03 +00001807** This function is now an anachronism. It used to be used to recover from a
1808** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00001809*/
drh7d97efb2007-10-12 19:35:48 +00001810int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00001811 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00001812}
1813#endif
drh3e1d8e62005-05-26 16:23:34 +00001814
1815/*
1816** Test to see whether or not the database connection is in autocommit
1817** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1818** by default. Autocommit is disabled by a BEGIN statement and reenabled
1819** by the next COMMIT or ROLLBACK.
1820**
1821******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
1822*/
1823int sqlite3_get_autocommit(sqlite3 *db){
1824 return db->autoCommit;
1825}
drh49285702005-09-17 15:20:26 +00001826
1827#ifdef SQLITE_DEBUG
1828/*
1829** The following routine is subtituted for constant SQLITE_CORRUPT in
1830** debugging builds. This provides a way to set a breakpoint for when
1831** corruption is first detected.
1832*/
1833int sqlite3Corrupt(void){
1834 return SQLITE_CORRUPT;
1835}
1836#endif
drh7c1817e2006-01-10 13:58:48 +00001837
drh6f7adc82006-01-11 21:41:20 +00001838/*
1839** This is a convenience routine that makes sure that all thread-specific
1840** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00001841**
1842** SQLite no longer uses thread-specific data so this routine is now a
1843** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00001844*/
1845void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00001846}
danielk1977deb802c2006-02-09 13:43:28 +00001847
1848/*
1849** Return meta information about a specific column of a database table.
1850** See comment in sqlite3.h (sqlite.h.in) for details.
1851*/
1852#ifdef SQLITE_ENABLE_COLUMN_METADATA
1853int sqlite3_table_column_metadata(
1854 sqlite3 *db, /* Connection handle */
1855 const char *zDbName, /* Database name or NULL */
1856 const char *zTableName, /* Table name */
1857 const char *zColumnName, /* Column name */
1858 char const **pzDataType, /* OUTPUT: Declared data type */
1859 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
1860 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
1861 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00001862 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00001863){
1864 int rc;
1865 char *zErrMsg = 0;
1866 Table *pTab = 0;
1867 Column *pCol = 0;
1868 int iCol;
1869
1870 char const *zDataType = 0;
1871 char const *zCollSeq = 0;
1872 int notnull = 0;
1873 int primarykey = 0;
1874 int autoinc = 0;
1875
1876 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00001877 sqlite3_mutex_enter(db->mutex);
drha0af99f2008-04-16 00:49:12 +00001878 (void)sqlite3SafetyOn(db);
drh3cb3edc2008-03-07 21:37:19 +00001879 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00001880 rc = sqlite3Init(db, &zErrMsg);
drh3cb3edc2008-03-07 21:37:19 +00001881 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00001882 if( SQLITE_OK!=rc ){
1883 goto error_out;
1884 }
1885
1886 /* Locate the table in question */
1887 pTab = sqlite3FindTable(db, zTableName, zDbName);
1888 if( !pTab || pTab->pSelect ){
1889 pTab = 0;
1890 goto error_out;
1891 }
1892
1893 /* Find the column for which info is requested */
1894 if( sqlite3IsRowid(zColumnName) ){
1895 iCol = pTab->iPKey;
1896 if( iCol>=0 ){
1897 pCol = &pTab->aCol[iCol];
1898 }
1899 }else{
1900 for(iCol=0; iCol<pTab->nCol; iCol++){
1901 pCol = &pTab->aCol[iCol];
1902 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
1903 break;
1904 }
1905 }
1906 if( iCol==pTab->nCol ){
1907 pTab = 0;
1908 goto error_out;
1909 }
1910 }
1911
1912 /* The following block stores the meta information that will be returned
1913 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
1914 ** and autoinc. At this point there are two possibilities:
1915 **
1916 ** 1. The specified column name was rowid", "oid" or "_rowid_"
1917 ** and there is no explicitly declared IPK column.
1918 **
1919 ** 2. The table is not a view and the column name identified an
1920 ** explicitly declared column. Copy meta information from *pCol.
1921 */
1922 if( pCol ){
1923 zDataType = pCol->zType;
1924 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00001925 notnull = pCol->notNull!=0;
1926 primarykey = pCol->isPrimKey!=0;
drh7d10d5a2008-08-20 16:35:10 +00001927 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00001928 }else{
1929 zDataType = "INTEGER";
1930 primarykey = 1;
1931 }
1932 if( !zCollSeq ){
1933 zCollSeq = "BINARY";
1934 }
1935
1936error_out:
drh01495b92008-01-23 12:52:40 +00001937 (void)sqlite3SafetyOff(db);
danielk1977deb802c2006-02-09 13:43:28 +00001938
1939 /* Whether the function call succeeded or failed, set the output parameters
1940 ** to whatever their local counterparts contain. If an error did occur,
1941 ** this has the effect of zeroing all output parameters.
1942 */
1943 if( pzDataType ) *pzDataType = zDataType;
1944 if( pzCollSeq ) *pzCollSeq = zCollSeq;
1945 if( pNotNull ) *pNotNull = notnull;
1946 if( pPrimaryKey ) *pPrimaryKey = primarykey;
1947 if( pAutoinc ) *pAutoinc = autoinc;
1948
1949 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00001950 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00001951 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00001952 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00001953 rc = SQLITE_ERROR;
1954 }
1955 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00001956 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00001957 rc = sqlite3ApiExit(db, rc);
1958 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00001959 return rc;
1960}
drhe30f4422007-08-21 16:15:55 +00001961#endif
drhf9cb7f52006-06-27 20:06:44 +00001962
1963/*
1964** Sleep for a little while. Return the amount of time slept.
1965*/
1966int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00001967 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00001968 int rc;
drhd677b3d2007-08-20 22:48:41 +00001969 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00001970 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00001971
1972 /* This function works in milliseconds, but the underlying OsSleep()
1973 ** API uses microseconds. Hence the 1000's.
1974 */
drhe30f4422007-08-21 16:15:55 +00001975 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00001976 return rc;
drhf9cb7f52006-06-27 20:06:44 +00001977}
drh4ac285a2006-09-15 07:28:50 +00001978
1979/*
1980** Enable or disable the extended result codes.
1981*/
1982int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00001983 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001984 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00001985 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001986 return SQLITE_OK;
1987}
drhcc6bb3e2007-08-31 16:11:35 +00001988
1989/*
1990** Invoke the xFileControl method on a particular database.
1991*/
1992int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
1993 int rc = SQLITE_ERROR;
1994 int iDb;
1995 sqlite3_mutex_enter(db->mutex);
1996 if( zDbName==0 ){
1997 iDb = 0;
1998 }else{
1999 for(iDb=0; iDb<db->nDb; iDb++){
2000 if( strcmp(db->aDb[iDb].zName, zDbName)==0 ) break;
2001 }
2002 }
2003 if( iDb<db->nDb ){
2004 Btree *pBtree = db->aDb[iDb].pBt;
2005 if( pBtree ){
2006 Pager *pPager;
drh55176252008-01-22 14:50:16 +00002007 sqlite3_file *fd;
drhcc6bb3e2007-08-31 16:11:35 +00002008 sqlite3BtreeEnter(pBtree);
2009 pPager = sqlite3BtreePager(pBtree);
drh55176252008-01-22 14:50:16 +00002010 assert( pPager!=0 );
2011 fd = sqlite3PagerFile(pPager);
2012 assert( fd!=0 );
2013 if( fd->pMethods ){
2014 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00002015 }
2016 sqlite3BtreeLeave(pBtree);
2017 }
2018 }
2019 sqlite3_mutex_leave(db->mutex);
2020 return rc;
2021}
drhed13d982008-01-31 14:43:24 +00002022
2023/*
2024** Interface to the testing logic.
2025*/
2026int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00002027 int rc = 0;
drh3088d592008-03-21 16:45:47 +00002028#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00002029 va_list ap;
drhed13d982008-01-31 14:43:24 +00002030 va_start(ap, op);
2031 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00002032
2033 /*
drh984bfaa2008-03-19 16:08:53 +00002034 ** Save the current state of the PRNG.
2035 */
drh2fa18682008-03-19 14:15:34 +00002036 case SQLITE_TESTCTRL_PRNG_SAVE: {
2037 sqlite3PrngSaveState();
2038 break;
2039 }
drh984bfaa2008-03-19 16:08:53 +00002040
2041 /*
2042 ** Restore the state of the PRNG to the last state saved using
2043 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
2044 ** this verb acts like PRNG_RESET.
2045 */
drh2fa18682008-03-19 14:15:34 +00002046 case SQLITE_TESTCTRL_PRNG_RESTORE: {
2047 sqlite3PrngRestoreState();
2048 break;
2049 }
drh984bfaa2008-03-19 16:08:53 +00002050
2051 /*
2052 ** Reset the PRNG back to its uninitialized state. The next call
2053 ** to sqlite3_randomness() will reseed the PRNG using a single call
2054 ** to the xRandomness method of the default VFS.
2055 */
drh2fa18682008-03-19 14:15:34 +00002056 case SQLITE_TESTCTRL_PRNG_RESET: {
2057 sqlite3PrngResetState();
2058 break;
2059 }
drh3088d592008-03-21 16:45:47 +00002060
2061 /*
2062 ** sqlite3_test_control(BITVEC_TEST, size, program)
2063 **
2064 ** Run a test against a Bitvec object of size. The program argument
2065 ** is an array of integers that defines the test. Return -1 on a
2066 ** memory allocation error, 0 on success, or non-zero for an error.
2067 ** See the sqlite3BitvecBuiltinTest() for additional information.
2068 */
2069 case SQLITE_TESTCTRL_BITVEC_TEST: {
2070 int sz = va_arg(ap, int);
2071 int *aProg = va_arg(ap, int*);
2072 rc = sqlite3BitvecBuiltinTest(sz, aProg);
2073 break;
2074 }
danielk19772d1d86f2008-06-20 14:59:51 +00002075
2076 /*
2077 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
2078 **
2079 ** Register hooks to call to indicate which malloc() failures
2080 ** are benign.
2081 */
2082 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00002083 typedef void (*void_function)(void);
2084 void_function xBenignBegin;
2085 void_function xBenignEnd;
2086 xBenignBegin = va_arg(ap, void_function);
2087 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00002088 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
2089 break;
2090 }
drhed13d982008-01-31 14:43:24 +00002091 }
2092 va_end(ap);
drh3088d592008-03-21 16:45:47 +00002093#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00002094 return rc;
drhed13d982008-01-31 14:43:24 +00002095}