blob: 9343e674c6cfd5711bc092cd1d01fe3eeffc2904 [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**
drhe82f5d02008-10-07 19:53:14 +000017** $Id: main.c,v 1.504 2008/10/07 19:53:14 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 }
danielk1977075c23a2008-09-01 18:34:20 +0000219 if( sqlite3GlobalConfig.m.xShutdown ){
danielk1977fb437272008-07-08 12:02:35 +0000220 sqlite3MallocEnd();
221 }
danielk1977075c23a2008-09-01 18:34:20 +0000222 if( sqlite3GlobalConfig.mutex.xMutexEnd ){
danielk1977fb437272008-07-08 12:02:35 +0000223 sqlite3MutexEnd();
224 }
danielk1977075c23a2008-09-01 18:34:20 +0000225 sqlite3GlobalConfig.isInit = 0;
drh40257ff2008-06-13 18:24:27 +0000226 return SQLITE_OK;
227}
228
229/*
230** This API allows applications to modify the global configuration of
231** the SQLite library at run-time.
232**
233** This routine should only be called when there are no outstanding
234** database connections or memory allocations. This routine is not
235** threadsafe. Failure to heed these warnings can lead to unpredictable
236** behavior.
237*/
238int sqlite3_config(int op, ...){
239 va_list ap;
240 int rc = SQLITE_OK;
241
242 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
243 ** the SQLite library is in use. */
danielk1977075c23a2008-09-01 18:34:20 +0000244 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE;
drh40257ff2008-06-13 18:24:27 +0000245
246 va_start(ap, op);
247 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000248
249 /* Mutex configuration options are only available in a threadsafe
250 ** compile.
251 */
252#if SQLITE_THREADSAFE
drh40257ff2008-06-13 18:24:27 +0000253 case SQLITE_CONFIG_SINGLETHREAD: {
254 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000255 sqlite3GlobalConfig.bCoreMutex = 0;
256 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000257 break;
258 }
259 case SQLITE_CONFIG_MULTITHREAD: {
260 /* Disable mutexing of database connections */
261 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000262 sqlite3GlobalConfig.bCoreMutex = 1;
263 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000264 break;
265 }
266 case SQLITE_CONFIG_SERIALIZED: {
267 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000268 sqlite3GlobalConfig.bCoreMutex = 1;
269 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000270 break;
271 }
drh18472fa2008-10-07 15:25:48 +0000272 case SQLITE_CONFIG_MUTEX: {
273 /* Specify an alternative mutex implementation */
274 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
275 break;
276 }
277 case SQLITE_CONFIG_GETMUTEX: {
278 /* Retrieve the current mutex implementation */
279 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
280 break;
281 }
282#endif
283
284
drh40257ff2008-06-13 18:24:27 +0000285 case SQLITE_CONFIG_MALLOC: {
286 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000287 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000288 break;
289 }
drh33589792008-06-18 13:27:46 +0000290 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000291 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000292 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
293 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000294 break;
295 }
drhfec00ea2008-06-14 16:56:21 +0000296 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000297 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000298 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000299 break;
300 }
drh33589792008-06-18 13:27:46 +0000301 case SQLITE_CONFIG_SCRATCH: {
302 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000303 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
304 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
305 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000306 break;
307 }
308 case SQLITE_CONFIG_PAGECACHE: {
309 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000310 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
311 sqlite3GlobalConfig.szPage = va_arg(ap, int);
312 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000313 break;
314 }
danielk19775099be52008-06-27 13:27:03 +0000315
drh5d414832008-07-15 14:47:18 +0000316#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000317 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000318 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000319 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
320 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
321 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000322
danielk1977075c23a2008-09-01 18:34:20 +0000323 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000324 /* If the heap pointer is NULL, then restore the malloc implementation
325 ** back to NULL pointers too. This will cause the malloc to go
326 ** back to its default implementation when sqlite3_initialize() is
327 ** run.
328 */
danielk1977075c23a2008-09-01 18:34:20 +0000329 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000330 }else{
331 /* The heap pointer is not NULL, then install one of the
332 ** mem5.c/mem3.c methods. If neither ENABLE_MEMSYS3 nor
333 ** ENABLE_MEMSYS5 is defined, return an error.
334 ** the default case and return an error.
335 */
danielk19775099be52008-06-27 13:27:03 +0000336#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000337 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000338#endif
339#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000340 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000341#endif
drh8a42cbd2008-07-10 18:13:42 +0000342 }
danielk19775099be52008-06-27 13:27:03 +0000343 break;
344 }
drh5d414832008-07-15 14:47:18 +0000345#endif
danielk19775099be52008-06-27 13:27:03 +0000346
danielk19772d340812008-07-24 08:20:40 +0000347#if defined(SQLITE_ENABLE_MEMSYS6)
348 case SQLITE_CONFIG_CHUNKALLOC: {
danielk1977075c23a2008-09-01 18:34:20 +0000349 sqlite3GlobalConfig.nSmall = va_arg(ap, int);
350 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys6();
danielk19772d340812008-07-24 08:20:40 +0000351 break;
352 }
353#endif
354
drh633e6d52008-07-28 19:34:53 +0000355 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000356 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
357 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000358 break;
359 }
360
drh40257ff2008-06-13 18:24:27 +0000361 default: {
362 rc = SQLITE_ERROR;
363 break;
364 }
365 }
366 va_end(ap);
367 return rc;
368}
369
370/*
drh633e6d52008-07-28 19:34:53 +0000371** Set up the lookaside buffers for a database connection.
372** Return SQLITE_OK on success.
373** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000374**
375** The sz parameter is the number of bytes in each lookaside slot.
376** The cnt parameter is the number of slots. If pStart is NULL the
377** space for the lookaside memory is obtained from sqlite3_malloc().
378** If pStart is not NULL then it is sz*cnt bytes of memory to use for
379** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000380*/
drhe9d1c722008-08-04 20:13:26 +0000381static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000382 void *pStart;
383 if( db->lookaside.nOut ){
384 return SQLITE_BUSY;
385 }
386 if( sz<0 ) sz = 0;
387 if( cnt<0 ) cnt = 0;
drhe9d1c722008-08-04 20:13:26 +0000388 if( pBuf==0 ){
drh63820332008-08-08 14:33:12 +0000389 sz = (sz + 7)&~7;
drhe9d1c722008-08-04 20:13:26 +0000390 sqlite3BeginBenignMalloc();
391 pStart = sqlite3Malloc( sz*cnt );
392 sqlite3EndBenignMalloc();
393 }else{
drh63820332008-08-08 14:33:12 +0000394 sz = sz&~7;
drhe9d1c722008-08-04 20:13:26 +0000395 pStart = pBuf;
396 }
397 if( db->lookaside.bMalloced ){
398 sqlite3_free(db->lookaside.pStart);
399 }
drh4cfb22f2008-08-01 18:47:01 +0000400 db->lookaside.pStart = pStart;
401 db->lookaside.pFree = 0;
402 db->lookaside.sz = sz;
drhe9d1c722008-08-04 20:13:26 +0000403 db->lookaside.bMalloced = pBuf==0;
drh633e6d52008-07-28 19:34:53 +0000404 if( pStart ){
405 int i;
406 LookasideSlot *p;
drh633e6d52008-07-28 19:34:53 +0000407 p = (LookasideSlot*)pStart;
408 for(i=cnt-1; i>=0; i--){
409 p->pNext = db->lookaside.pFree;
410 db->lookaside.pFree = p;
411 p = (LookasideSlot*)&((u8*)p)[sz];
412 }
413 db->lookaside.pEnd = p;
414 db->lookaside.bEnabled = 1;
drh4cfb22f2008-08-01 18:47:01 +0000415 }else{
416 db->lookaside.pEnd = 0;
417 db->lookaside.bEnabled = 0;
drh633e6d52008-07-28 19:34:53 +0000418 }
419 return SQLITE_OK;
420}
421
422/*
423** Configuration settings for an individual database connection
424*/
425int sqlite3_db_config(sqlite3 *db, int op, ...){
426 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000427 int rc;
drh633e6d52008-07-28 19:34:53 +0000428 va_start(ap, op);
429 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000430 case SQLITE_DBCONFIG_LOOKASIDE: {
431 void *pBuf = va_arg(ap, void*);
drh633e6d52008-07-28 19:34:53 +0000432 int sz = va_arg(ap, int);
433 int cnt = va_arg(ap, int);
drhe9d1c722008-08-04 20:13:26 +0000434 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000435 break;
436 }
drh6480aad2008-08-01 16:31:14 +0000437 default: {
438 rc = SQLITE_ERROR;
439 break;
440 }
drh633e6d52008-07-28 19:34:53 +0000441 }
442 va_end(ap);
443 return rc;
444}
445
446/*
drhc5499be2008-04-01 15:06:33 +0000447** Routine needed to support the testcase() macro.
448*/
449#ifdef SQLITE_COVERAGE_TEST
450void sqlite3Coverage(int x){
451 static int dummy = 0;
452 dummy += x;
453}
454#endif
455
drha16313e2007-03-30 11:29:32 +0000456
457/*
drh9b5adfa2008-01-20 23:19:56 +0000458** Return true if the buffer z[0..n-1] contains all spaces.
459*/
460static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000461 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000462 return n==0;
463}
464
465/*
drhd3d39e92004-05-20 22:16:29 +0000466** This is the default collating function named "BINARY" which is always
467** available.
drh9b5adfa2008-01-20 23:19:56 +0000468**
469** If the padFlag argument is not NULL then space padding at the end
470** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000471*/
danielk19772c336542005-01-13 02:14:23 +0000472static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000473 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000474 int nKey1, const void *pKey1,
475 int nKey2, const void *pKey2
476){
477 int rc, n;
478 n = nKey1<nKey2 ? nKey1 : nKey2;
479 rc = memcmp(pKey1, pKey2, n);
480 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000481 if( padFlag
482 && allSpaces(((char*)pKey1)+n, nKey1-n)
483 && allSpaces(((char*)pKey2)+n, nKey2-n)
484 ){
485 /* Leave rc unchanged at 0 */
486 }else{
487 rc = nKey1 - nKey2;
488 }
drhd3d39e92004-05-20 22:16:29 +0000489 }
490 return rc;
491}
492
493/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000494** Another built-in collating sequence: NOCASE.
495**
496** This collating sequence is intended to be used for "case independant
497** comparison". SQLite's knowledge of upper and lower case equivalents
498** extends only to the 26 characters used in the English language.
499**
500** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000501*/
502static int nocaseCollatingFunc(
503 void *NotUsed,
504 int nKey1, const void *pKey1,
505 int nKey2, const void *pKey2
506){
507 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000508 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk19770202b292004-06-09 09:55:16 +0000509 if( 0==r ){
510 r = nKey1-nKey2;
511 }
512 return r;
513}
514
515/*
drhaf9ff332002-01-16 21:00:27 +0000516** Return the ROWID of the most recent insert
517*/
drh9bb575f2004-09-06 17:24:11 +0000518sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +0000519 return db->lastRowid;
520}
521
522/*
danielk197724b03fd2004-05-10 10:34:34 +0000523** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000524*/
drh9bb575f2004-09-06 17:24:11 +0000525int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +0000526 return db->nChange;
527}
528
rdcf146a772004-02-25 22:51:06 +0000529/*
danielk1977b28af712004-06-21 06:50:26 +0000530** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000531*/
danielk1977b28af712004-06-21 06:50:26 +0000532int sqlite3_total_changes(sqlite3 *db){
533 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000534}
535
drhc8d30ac2002-04-12 10:08:59 +0000536/*
drh50e5dad2001-09-15 00:57:28 +0000537** Close an existing SQLite database
538*/
drh9bb575f2004-09-06 17:24:11 +0000539int sqlite3_close(sqlite3 *db){
drh8e0a2f92002-02-23 23:45:45 +0000540 HashElem *i;
drh001bbcb2003-03-19 03:14:00 +0000541 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000542
543 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000544 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000545 }
drh7e8b8482008-01-23 03:03:05 +0000546 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk1977e35ee192004-06-26 09:50:11 +0000547 return SQLITE_MISUSE;
548 }
drh605264d2007-08-21 15:13:19 +0000549 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000550
danielk19771f723bd2005-05-26 12:37:29 +0000551#ifdef SQLITE_SSE
drh37527852006-03-16 16:19:56 +0000552 {
553 extern void sqlite3SseCleanup(sqlite3*);
554 sqlite3SseCleanup(db);
555 }
danielk19771f723bd2005-05-26 12:37:29 +0000556#endif
557
drhffc13f62006-07-30 20:50:44 +0000558 sqlite3ResetInternalSchema(db, 0);
danielk1977a04a34f2007-04-16 15:06:25 +0000559
danielk197701256832007-04-18 14:24:32 +0000560 /* If a transaction is open, the ResetInternalSchema() call above
561 ** will not have called the xDisconnect() method on any virtual
562 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
563 ** call will do so. We need to do this before the check for active
564 ** SQL statements below, as the v-table implementation may be storing
565 ** some prepared statements internally.
566 */
567 sqlite3VtabRollback(db);
568
danielk1977a04a34f2007-04-16 15:06:25 +0000569 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +0000570 if( db->pVdbe ){
571 sqlite3Error(db, SQLITE_BUSY,
572 "Unable to close due to unfinalised statements");
drh27641702007-08-22 02:56:42 +0000573 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000574 return SQLITE_BUSY;
575 }
drh7e8b8482008-01-23 03:03:05 +0000576 assert( sqlite3SafetyCheckSickOrOk(db) );
danielk1977e0048402004-06-15 16:51:01 +0000577
drh001bbcb2003-03-19 03:14:00 +0000578 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000579 struct Db *pDb = &db->aDb[j];
580 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000581 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000582 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000583 if( j!=1 ){
584 pDb->pSchema = 0;
585 }
drh113088e2003-03-20 01:16:58 +0000586 }
drhf57b3392001-10-08 13:22:32 +0000587 }
danielk19774adee202004-05-08 08:23:19 +0000588 sqlite3ResetInternalSchema(db, 0);
drh1c2d8412003-03-31 00:30:47 +0000589 assert( db->nDb<=2 );
590 assert( db->aDb==db->aDbStatic );
drh70a8ca32008-08-21 18:49:27 +0000591 for(j=0; j<ArraySize(db->aFunc.a); j++){
592 FuncDef *pNext, *pHash, *p;
593 for(p=db->aFunc.a[j]; p; p=pHash){
594 pHash = p->pHash;
595 while( p ){
596 pNext = p->pNext;
597 sqlite3DbFree(db, p);
598 p = pNext;
599 }
drh8e0a2f92002-02-23 23:45:45 +0000600 }
601 }
danielk1977d8123362004-06-12 09:25:12 +0000602 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000603 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000604 /* Invoke any destructors registered for collation sequence user data. */
605 for(j=0; j<3; j++){
606 if( pColl[j].xDel ){
607 pColl[j].xDel(pColl[j].pUser);
608 }
609 }
drh633e6d52008-07-28 19:34:53 +0000610 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +0000611 }
danielk1977d8123362004-06-12 09:25:12 +0000612 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000613#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000614 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
615 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000616 if( pMod->xDestroy ){
617 pMod->xDestroy(pMod->pAux);
618 }
drh633e6d52008-07-28 19:34:53 +0000619 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000620 }
drhb9bb7c12006-06-11 23:41:55 +0000621 sqlite3HashClear(&db->aModule);
622#endif
danielk1977466be562004-06-10 02:16:01 +0000623
danielk19776622cce2004-05-20 11:00:52 +0000624 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000625 if( db->pErr ){
626 sqlite3ValueFree(db->pErr);
627 }
drhf1952c52006-06-08 15:48:00 +0000628 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000629
630 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000631
632 /* The temp-database schema is allocated differently from the other schema
633 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
634 ** So it needs to be freed here. Todo: Why not roll the temp schema into
635 ** the same sqliteMalloc() as the one that allocates the database
636 ** structure?
637 */
drh633e6d52008-07-28 19:34:53 +0000638 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000639 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +0000640 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +0000641 sqlite3_mutex_free(db->mutex);
drhe9d1c722008-08-04 20:13:26 +0000642 if( db->lookaside.bMalloced ){
643 sqlite3_free(db->lookaside.pStart);
644 }
drh17435752007-08-16 04:30:38 +0000645 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000646 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000647}
648
649/*
drh001bbcb2003-03-19 03:14:00 +0000650** Rollback all database files.
651*/
drh9bb575f2004-09-06 17:24:11 +0000652void sqlite3RollbackAll(sqlite3 *db){
drh001bbcb2003-03-19 03:14:00 +0000653 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000654 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000655 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +0000656 sqlite3BeginBenignMalloc();
drh001bbcb2003-03-19 03:14:00 +0000657 for(i=0; i<db->nDb; i++){
658 if( db->aDb[i].pBt ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000659 if( sqlite3BtreeIsInTrans(db->aDb[i].pBt) ){
660 inTrans = 1;
661 }
danielk19774adee202004-05-08 08:23:19 +0000662 sqlite3BtreeRollback(db->aDb[i].pBt);
drh001bbcb2003-03-19 03:14:00 +0000663 db->aDb[i].inTrans = 0;
664 }
665 }
danielk1977a298e902006-06-22 09:53:48 +0000666 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +0000667 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000668
danielk197771fd80b2005-12-16 06:54:01 +0000669 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000670 sqlite3ExpirePreparedStatements(db);
danielk197771fd80b2005-12-16 06:54:01 +0000671 sqlite3ResetInternalSchema(db, 0);
672 }
673
674 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000675 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000676 db->xRollbackCallback(db->pRollbackArg);
677 }
drh001bbcb2003-03-19 03:14:00 +0000678}
679
680/*
drhc22bd472002-05-10 13:14:07 +0000681** Return a static string that describes the kind of error specified in the
682** argument.
drh247be432002-05-10 05:44:55 +0000683*/
danielk1977f20b21c2004-05-31 23:56:42 +0000684const char *sqlite3ErrStr(int rc){
drhc22bd472002-05-10 13:14:07 +0000685 const char *z;
drh4ac285a2006-09-15 07:28:50 +0000686 switch( rc & 0xff ){
drhc60d0442004-09-30 13:43:13 +0000687 case SQLITE_ROW:
688 case SQLITE_DONE:
drhc22bd472002-05-10 13:14:07 +0000689 case SQLITE_OK: z = "not an error"; break;
690 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
drhc22bd472002-05-10 13:14:07 +0000691 case SQLITE_PERM: z = "access permission denied"; break;
692 case SQLITE_ABORT: z = "callback requested query abort"; break;
693 case SQLITE_BUSY: z = "database is locked"; break;
694 case SQLITE_LOCKED: z = "database table is locked"; break;
695 case SQLITE_NOMEM: z = "out of memory"; break;
696 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
697 case SQLITE_INTERRUPT: z = "interrupted"; break;
698 case SQLITE_IOERR: z = "disk I/O error"; break;
699 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
drh2db0bbc2005-08-11 02:10:18 +0000700 case SQLITE_FULL: z = "database or disk is full"; break;
drhc22bd472002-05-10 13:14:07 +0000701 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
drhc22bd472002-05-10 13:14:07 +0000702 case SQLITE_EMPTY: z = "table contains no data"; break;
703 case SQLITE_SCHEMA: z = "database schema has changed"; break;
drh023ae032007-05-08 12:12:16 +0000704 case SQLITE_TOOBIG: z = "String or BLOB exceeded size limit"; break;
drhc22bd472002-05-10 13:14:07 +0000705 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
706 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
707 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
drh65594042008-05-05 16:56:34 +0000708 case SQLITE_NOLFS: z = "large file support is disabled"; break;
drhed6c8672003-01-12 18:02:16 +0000709 case SQLITE_AUTH: z = "authorization denied"; break;
jplyon892f6712003-06-12 08:59:00 +0000710 case SQLITE_FORMAT: z = "auxiliary database format error"; break;
drhb08153d2004-11-20 20:18:55 +0000711 case SQLITE_RANGE: z = "bind or column index out of range"; break;
drhc602f9a2004-02-12 19:01:04 +0000712 case SQLITE_NOTADB: z = "file is encrypted or is not a database";break;
drhc22bd472002-05-10 13:14:07 +0000713 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000714 }
drhc22bd472002-05-10 13:14:07 +0000715 return z;
drh247be432002-05-10 05:44:55 +0000716}
717
718/*
drh2dfbbca2000-07-28 14:32:48 +0000719** This routine implements a busy callback that sleeps and tries
720** again until a timeout value is reached. The timeout value is
721** an integer number of milliseconds passed in as the first
722** argument.
723*/
drhdaffd0e2001-04-11 14:28:42 +0000724static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000725 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000726 int count /* Number of times table has been busy */
727){
danielk197729bafea2008-06-26 10:41:19 +0000728#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000729 static const u8 delays[] =
730 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
731 static const u8 totals[] =
732 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhd1bec472004-01-15 13:29:31 +0000733# define NDELAY (sizeof(delays)/sizeof(delays[0]))
danielk1977b4b47412007-08-17 15:53:36 +0000734 sqlite3 *db = (sqlite3 *)ptr;
735 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000736 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000737
drhee570fa2005-04-28 12:06:05 +0000738 assert( count>=0 );
739 if( count < NDELAY ){
740 delay = delays[count];
741 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000742 }else{
743 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000744 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000745 }
drhd1bec472004-01-15 13:29:31 +0000746 if( prior + delay > timeout ){
747 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +0000748 if( delay<=0 ) return 0;
749 }
danielk19772a6bdf62007-08-20 16:07:00 +0000750 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +0000751 return 1;
752#else
drh482ea182007-08-20 11:12:40 +0000753 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +0000754 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +0000755 if( (count+1)*1000 > timeout ){
756 return 0;
757 }
drh482ea182007-08-20 11:12:40 +0000758 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +0000759 return 1;
760#endif
761}
762
763/*
drha4afb652005-07-09 02:16:02 +0000764** Invoke the given busy handler.
765**
766** This routine is called when an operation failed with a lock.
767** If this routine returns non-zero, the lock is retried. If it
768** returns 0, the operation aborts with an SQLITE_BUSY error.
769*/
770int sqlite3InvokeBusyHandler(BusyHandler *p){
771 int rc;
drh34004ce2008-07-11 16:15:17 +0000772 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +0000773 rc = p->xFunc(p->pArg, p->nBusy);
774 if( rc==0 ){
775 p->nBusy = -1;
776 }else{
777 p->nBusy++;
778 }
779 return rc;
780}
781
782/*
drh2dfbbca2000-07-28 14:32:48 +0000783** This routine sets the busy callback for an Sqlite database to the
784** given callback function with the given argument.
785*/
danielk1977f9d64d22004-06-19 08:18:07 +0000786int sqlite3_busy_handler(
787 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +0000788 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +0000789 void *pArg
790){
drhe30f4422007-08-21 16:15:55 +0000791 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +0000792 db->busyHandler.xFunc = xBusy;
793 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +0000794 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +0000795 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +0000796 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000797}
798
danielk1977348bb5d2003-10-18 09:37:26 +0000799#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
800/*
801** This routine sets the progress callback for an Sqlite database to the
802** given callback function with the given argument. The progress callback will
803** be invoked every nOps opcodes.
804*/
danielk197724b03fd2004-05-10 10:34:34 +0000805void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +0000806 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +0000807 int nOps,
808 int (*xProgress)(void*),
809 void *pArg
810){
drhbd0b1b52008-07-07 19:52:09 +0000811 sqlite3_mutex_enter(db->mutex);
812 if( nOps>0 ){
813 db->xProgress = xProgress;
814 db->nProgressOps = nOps;
815 db->pProgressArg = pArg;
816 }else{
817 db->xProgress = 0;
818 db->nProgressOps = 0;
819 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +0000820 }
drhbd0b1b52008-07-07 19:52:09 +0000821 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +0000822}
823#endif
824
825
drh2dfbbca2000-07-28 14:32:48 +0000826/*
827** This routine installs a default busy handler that waits for the
828** specified number of milliseconds before returning 0.
829*/
danielk1977f9d64d22004-06-19 08:18:07 +0000830int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh2dfbbca2000-07-28 14:32:48 +0000831 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +0000832 db->busyTimeout = ms;
833 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +0000834 }else{
danielk197724b03fd2004-05-10 10:34:34 +0000835 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +0000836 }
danielk1977f9d64d22004-06-19 08:18:07 +0000837 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000838}
drh4c504392000-10-16 22:06:40 +0000839
840/*
841** Cause any pending operation to stop at its earliest opportunity.
842*/
drh9bb575f2004-09-06 17:24:11 +0000843void sqlite3_interrupt(sqlite3 *db){
drhbd0b1b52008-07-07 19:52:09 +0000844 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +0000845}
drhfa86c412002-02-02 15:01:15 +0000846
drhfa86c412002-02-02 15:01:15 +0000847
848/*
danielk1977771151b2006-01-17 13:21:40 +0000849** This function is exactly the same as sqlite3_create_function(), except
850** that it is designed to be called by internal code. The difference is
851** that if a malloc() fails in sqlite3_create_function(), an error code
852** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +0000853*/
danielk1977771151b2006-01-17 13:21:40 +0000854int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +0000855 sqlite3 *db,
856 const char *zFunctionName,
857 int nArg,
danielk1977d8123362004-06-12 09:25:12 +0000858 int enc,
danielk197765904932004-05-26 06:18:37 +0000859 void *pUserData,
860 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
861 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
862 void (*xFinal)(sqlite3_context*)
drh8e0a2f92002-02-23 23:45:45 +0000863){
drh0bce8352002-02-28 00:41:10 +0000864 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000865 int nName;
danielk197765904932004-05-26 06:18:37 +0000866
drhe30f4422007-08-21 16:15:55 +0000867 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +0000868 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +0000869 (xFunc && (xFinal || xStep)) ||
870 (!xFunc && (xFinal && !xStep)) ||
871 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +0000872 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drh0a687d12008-07-08 14:52:07 +0000873 (255<(nName = sqlite3Strlen(db, zFunctionName))) ){
drhbadf7a72006-06-14 15:35:36 +0000874 sqlite3Error(db, SQLITE_ERROR, "bad parameters");
danielk197765904932004-05-26 06:18:37 +0000875 return SQLITE_ERROR;
876 }
danielk1977d8123362004-06-12 09:25:12 +0000877
danielk197793758c82005-01-21 08:13:14 +0000878#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +0000879 /* If SQLITE_UTF16 is specified as the encoding type, transform this
880 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
881 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
882 **
883 ** If SQLITE_ANY is specified, add three versions of the function
884 ** to the hash table.
885 */
886 if( enc==SQLITE_UTF16 ){
887 enc = SQLITE_UTF16NATIVE;
888 }else if( enc==SQLITE_ANY ){
889 int rc;
danielk1977771151b2006-01-17 13:21:40 +0000890 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
danielk1977f9d64d22004-06-19 08:18:07 +0000891 pUserData, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000892 if( rc==SQLITE_OK ){
893 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
894 pUserData, xFunc, xStep, xFinal);
895 }
896 if( rc!=SQLITE_OK ){
897 return rc;
898 }
danielk1977d8123362004-06-12 09:25:12 +0000899 enc = SQLITE_UTF16BE;
900 }
danielk197793758c82005-01-21 08:13:14 +0000901#else
902 enc = SQLITE_UTF8;
903#endif
danielk19779636c4e2005-01-25 04:27:54 +0000904
905 /* Check if an existing function is being overridden or deleted. If so,
906 ** and there are active VMs, then return SQLITE_BUSY. If a function
907 ** is being overridden/deleted but there are no active VMs, allow the
908 ** operation to continue but invalidate all precompiled statements.
909 */
910 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 0);
911 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
912 if( db->activeVdbeCnt ){
913 sqlite3Error(db, SQLITE_BUSY,
914 "Unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +0000915 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +0000916 return SQLITE_BUSY;
917 }else{
918 sqlite3ExpirePreparedStatements(db);
919 }
920 }
danielk197765904932004-05-26 06:18:37 +0000921
danielk1977d8123362004-06-12 09:25:12 +0000922 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +0000923 assert(p || db->mallocFailed);
924 if( !p ){
925 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +0000926 }
danielk1977fa18bec2007-09-03 11:04:22 +0000927 p->flags = 0;
928 p->xFunc = xFunc;
929 p->xStep = xStep;
930 p->xFinalize = xFinal;
931 p->pUserData = pUserData;
932 p->nArg = nArg;
danielk197765904932004-05-26 06:18:37 +0000933 return SQLITE_OK;
934}
danielk1977771151b2006-01-17 13:21:40 +0000935
936/*
937** Create new user functions.
938*/
939int sqlite3_create_function(
940 sqlite3 *db,
941 const char *zFunctionName,
942 int nArg,
943 int enc,
944 void *p,
945 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
946 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
947 void (*xFinal)(sqlite3_context*)
948){
949 int rc;
drhe30f4422007-08-21 16:15:55 +0000950 sqlite3_mutex_enter(db->mutex);
danielk1977771151b2006-01-17 13:21:40 +0000951 rc = sqlite3CreateFunc(db, zFunctionName, nArg, enc, p, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000952 rc = sqlite3ApiExit(db, rc);
953 sqlite3_mutex_leave(db->mutex);
954 return rc;
danielk1977771151b2006-01-17 13:21:40 +0000955}
956
danielk197793758c82005-01-21 08:13:14 +0000957#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +0000958int sqlite3_create_function16(
959 sqlite3 *db,
960 const void *zFunctionName,
961 int nArg,
962 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +0000963 void *p,
danielk197765904932004-05-26 06:18:37 +0000964 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
965 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
966 void (*xFinal)(sqlite3_context*)
967){
968 int rc;
drhaf9a7c22005-12-15 03:04:10 +0000969 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +0000970 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000971 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +0000972 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1);
danielk1977771151b2006-01-17 13:21:40 +0000973 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal);
drh633e6d52008-07-28 19:34:53 +0000974 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +0000975 rc = sqlite3ApiExit(db, rc);
976 sqlite3_mutex_leave(db->mutex);
977 return rc;
drh8e0a2f92002-02-23 23:45:45 +0000978}
danielk197793758c82005-01-21 08:13:14 +0000979#endif
drhc9b84a12002-06-20 11:36:48 +0000980
drhb7481e72006-09-16 21:45:14 +0000981
982/*
983** Declare that a function has been overloaded by a virtual table.
984**
985** If the function already exists as a regular global function, then
986** this routine is a no-op. If the function does not exist, then create
987** a new one that always throws a run-time error.
988**
989** When virtual tables intend to provide an overloaded function, they
990** should call this routine to make sure the global function exists.
991** A global function must exist in order for name resolution to work
992** properly.
993*/
994int sqlite3_overload_function(
995 sqlite3 *db,
996 const char *zName,
997 int nArg
998){
drh0a687d12008-07-08 14:52:07 +0000999 int nName = sqlite3Strlen(db, zName);
drhe30f4422007-08-21 16:15:55 +00001000 int rc;
1001 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001002 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
1003 sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1004 0, sqlite3InvalidFunction, 0, 0);
1005 }
drhe30f4422007-08-21 16:15:55 +00001006 rc = sqlite3ApiExit(db, SQLITE_OK);
1007 sqlite3_mutex_leave(db->mutex);
1008 return rc;
drhb7481e72006-09-16 21:45:14 +00001009}
1010
drh19e2d372005-08-29 23:00:03 +00001011#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001012/*
drh18de4822003-01-16 16:28:53 +00001013** Register a trace function. The pArg from the previously registered trace
1014** is returned.
1015**
1016** A NULL trace function means that no tracing is executes. A non-NULL
1017** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001018** SQL statement.
drh18de4822003-01-16 16:28:53 +00001019*/
drh9bb575f2004-09-06 17:24:11 +00001020void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001021 void *pOld;
1022 sqlite3_mutex_enter(db->mutex);
1023 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001024 db->xTrace = xTrace;
1025 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001026 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001027 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001028}
drh19e2d372005-08-29 23:00:03 +00001029/*
1030** Register a profile function. The pArg from the previously registered
1031** profile function is returned.
1032**
1033** A NULL profile function means that no profiling is executes. A non-NULL
1034** profile is a pointer to a function that is invoked at the conclusion of
1035** each SQL statement that is run.
1036*/
1037void *sqlite3_profile(
1038 sqlite3 *db,
1039 void (*xProfile)(void*,const char*,sqlite_uint64),
1040 void *pArg
1041){
drhe30f4422007-08-21 16:15:55 +00001042 void *pOld;
1043 sqlite3_mutex_enter(db->mutex);
1044 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001045 db->xProfile = xProfile;
1046 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001047 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001048 return pOld;
1049}
1050#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001051
drhaa940ea2004-01-15 02:44:03 +00001052/*** EXPERIMENTAL ***
1053**
1054** Register a function to be invoked when a transaction comments.
danielk197771fd80b2005-12-16 06:54:01 +00001055** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001056** rollback.
1057*/
danielk197724b03fd2004-05-10 10:34:34 +00001058void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001059 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001060 int (*xCallback)(void*), /* Function to invoke on each commit */
1061 void *pArg /* Argument to the function */
1062){
drhe30f4422007-08-21 16:15:55 +00001063 void *pOld;
1064 sqlite3_mutex_enter(db->mutex);
1065 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001066 db->xCommitCallback = xCallback;
1067 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001068 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001069 return pOld;
1070}
1071
danielk197794eb6a12005-12-15 15:22:08 +00001072/*
1073** Register a callback to be invoked each time a row is updated,
1074** inserted or deleted using this database connection.
1075*/
danielk197771fd80b2005-12-16 06:54:01 +00001076void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001077 sqlite3 *db, /* Attach the hook to this database */
1078 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1079 void *pArg /* Argument to the function */
1080){
drhe30f4422007-08-21 16:15:55 +00001081 void *pRet;
1082 sqlite3_mutex_enter(db->mutex);
1083 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001084 db->xUpdateCallback = xCallback;
1085 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001086 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001087 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001088}
1089
danielk197771fd80b2005-12-16 06:54:01 +00001090/*
1091** Register a callback to be invoked each time a transaction is rolled
1092** back by this database connection.
1093*/
1094void *sqlite3_rollback_hook(
1095 sqlite3 *db, /* Attach the hook to this database */
1096 void (*xCallback)(void*), /* Callback function */
1097 void *pArg /* Argument to the function */
1098){
drhe30f4422007-08-21 16:15:55 +00001099 void *pRet;
1100 sqlite3_mutex_enter(db->mutex);
1101 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001102 db->xRollbackCallback = xCallback;
1103 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001104 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001105 return pRet;
1106}
drhaa940ea2004-01-15 02:44:03 +00001107
paulb0208cc2003-04-13 18:26:49 +00001108/*
drh13bff812003-04-15 01:19:47 +00001109** This routine is called to create a connection to a database BTree
1110** driver. If zFilename is the name of a file, then that file is
1111** opened and used. If zFilename is the magic name ":memory:" then
1112** the database is stored in memory (and is thus forgotten as soon as
1113** the connection is closed.) If zFilename is NULL then the database
drh84bfda42005-07-15 13:05:21 +00001114** is a "virtual" database for transient use only and is deleted as
1115** soon as the connection is closed.
drh90f5ecb2004-07-22 01:19:35 +00001116**
drh84bfda42005-07-15 13:05:21 +00001117** A virtual database can be either a disk file (that is automatically
1118** deleted when the file is closed) or it an be held entirely in memory,
danielk1977b06a0b62008-06-26 10:54:12 +00001119** depending on the values of the SQLITE_TEMP_STORE compile-time macro and the
drh90f5ecb2004-07-22 01:19:35 +00001120** db->temp_store variable, according to the following chart:
1121**
danielk1977b06a0b62008-06-26 10:54:12 +00001122** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1123** ----------------- -------------- ------------------------------
1124** 0 any file
1125** 1 1 file
1126** 1 2 memory
1127** 1 0 file
1128** 2 1 file
1129** 2 2 memory
1130** 2 0 memory
1131** 3 any memory
paulb0208cc2003-04-13 18:26:49 +00001132*/
danielk19774adee202004-05-08 08:23:19 +00001133int sqlite3BtreeFactory(
drh9bb575f2004-09-06 17:24:11 +00001134 const sqlite3 *db, /* Main database when opening aux otherwise 0 */
paulb0208cc2003-04-13 18:26:49 +00001135 const char *zFilename, /* Name of the file containing the BTree database */
1136 int omitJournal, /* if TRUE then do not journal this file */
1137 int nCache, /* How many pages in the page cache */
drh33f4e022007-09-03 15:19:34 +00001138 int vfsFlags, /* Flags passed through to vfsOpen */
danielk19774adee202004-05-08 08:23:19 +00001139 Btree **ppBtree /* Pointer to new Btree object written here */
1140){
drh33f4e022007-09-03 15:19:34 +00001141 int btFlags = 0;
drh90f5ecb2004-07-22 01:19:35 +00001142 int rc;
danielk19774adee202004-05-08 08:23:19 +00001143
drhe30f4422007-08-21 16:15:55 +00001144 assert( sqlite3_mutex_held(db->mutex) );
drheec983e2004-05-08 10:11:36 +00001145 assert( ppBtree != 0);
danielk19774adee202004-05-08 08:23:19 +00001146 if( omitJournal ){
drh33f4e022007-09-03 15:19:34 +00001147 btFlags |= BTREE_OMIT_JOURNAL;
paulb0208cc2003-04-13 18:26:49 +00001148 }
drh7bec5052005-02-06 02:45:41 +00001149 if( db->flags & SQLITE_NoReadlock ){
drh33f4e022007-09-03 15:19:34 +00001150 btFlags |= BTREE_NO_READLOCK;
drh7bec5052005-02-06 02:45:41 +00001151 }
drh90f5ecb2004-07-22 01:19:35 +00001152 if( zFilename==0 ){
danielk1977b06a0b62008-06-26 10:54:12 +00001153#if SQLITE_TEMP_STORE==0
drh22ac46d2004-08-14 18:34:54 +00001154 /* Do nothing */
drh90f5ecb2004-07-22 01:19:35 +00001155#endif
danielk197703aded42004-11-22 05:26:27 +00001156#ifndef SQLITE_OMIT_MEMORYDB
danielk1977b06a0b62008-06-26 10:54:12 +00001157#if SQLITE_TEMP_STORE==1
drh22ac46d2004-08-14 18:34:54 +00001158 if( db->temp_store==2 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001159#endif
danielk1977b06a0b62008-06-26 10:54:12 +00001160#if SQLITE_TEMP_STORE==2
drh22ac46d2004-08-14 18:34:54 +00001161 if( db->temp_store!=1 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001162#endif
danielk1977b06a0b62008-06-26 10:54:12 +00001163#if SQLITE_TEMP_STORE==3
drh22ac46d2004-08-14 18:34:54 +00001164 zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +00001165#endif
danielk197703aded42004-11-22 05:26:27 +00001166#endif /* SQLITE_OMIT_MEMORYDB */
drh90f5ecb2004-07-22 01:19:35 +00001167 }
danielk19774adee202004-05-08 08:23:19 +00001168
drh33f4e022007-09-03 15:19:34 +00001169 if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (zFilename==0 || *zFilename==0) ){
1170 vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
1171 }
1172 rc = sqlite3BtreeOpen(zFilename, (sqlite3 *)db, ppBtree, btFlags, vfsFlags);
danielk1977171bfed2008-06-23 09:50:50 +00001173
1174 /* If the B-Tree was successfully opened, set the pager-cache size to the
1175 ** default value. Except, if the call to BtreeOpen() returned a handle
1176 ** open on an existing shared pager-cache, do not change the pager-cache
1177 ** size.
1178 */
1179 if( rc==SQLITE_OK && 0==sqlite3BtreeSchema(*ppBtree, 0, 0) ){
drh90f5ecb2004-07-22 01:19:35 +00001180 sqlite3BtreeSetCacheSize(*ppBtree, nCache);
1181 }
1182 return rc;
paulb0208cc2003-04-13 18:26:49 +00001183}
danielk19774adee202004-05-08 08:23:19 +00001184
danielk19774ad17132004-05-21 01:47:26 +00001185/*
1186** Return UTF-8 encoded English language explanation of the most recent
1187** error.
1188*/
danielk19776622cce2004-05-20 11:00:52 +00001189const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001190 const char *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001191 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001192 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001193 }
drhd55d57e2008-07-07 17:53:07 +00001194 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk1977e35ee192004-06-26 09:50:11 +00001195 return sqlite3ErrStr(SQLITE_MISUSE);
1196 }
drh27641702007-08-22 02:56:42 +00001197 sqlite3_mutex_enter(db->mutex);
drh86f8c192007-08-22 00:39:19 +00001198 assert( !db->mallocFailed );
drh2646da72005-12-09 20:02:05 +00001199 z = (char*)sqlite3_value_text(db->pErr);
danielk1977131c8bc2008-05-22 13:56:17 +00001200 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +00001201 if( z==0 ){
1202 z = sqlite3ErrStr(db->errCode);
danielk19776622cce2004-05-20 11:00:52 +00001203 }
drhe30f4422007-08-21 16:15:55 +00001204 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001205 return z;
danielk19776622cce2004-05-20 11:00:52 +00001206}
1207
drh6c626082004-11-14 21:56:29 +00001208#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001209/*
1210** Return UTF-16 encoded English language explanation of the most recent
1211** error.
1212*/
danielk19776622cce2004-05-20 11:00:52 +00001213const void *sqlite3_errmsg16(sqlite3 *db){
danielk1977bfd6cce2004-06-18 04:24:54 +00001214 /* Because all the characters in the string are in the unicode
1215 ** range 0x00-0xFF, if we pad the big-endian string with a
1216 ** zero byte, we can obtain the little-endian string with
1217 ** &big_endian[1].
1218 */
drh57196282004-10-06 15:41:16 +00001219 static const char outOfMemBe[] = {
danielk1977bfd6cce2004-06-18 04:24:54 +00001220 0, 'o', 0, 'u', 0, 't', 0, ' ',
1221 0, 'o', 0, 'f', 0, ' ',
1222 0, 'm', 0, 'e', 0, 'm', 0, 'o', 0, 'r', 0, 'y', 0, 0, 0
1223 };
drh57196282004-10-06 15:41:16 +00001224 static const char misuseBe [] = {
danielk1977e35ee192004-06-26 09:50:11 +00001225 0, 'l', 0, 'i', 0, 'b', 0, 'r', 0, 'a', 0, 'r', 0, 'y', 0, ' ',
1226 0, 'r', 0, 'o', 0, 'u', 0, 't', 0, 'i', 0, 'n', 0, 'e', 0, ' ',
1227 0, 'c', 0, 'a', 0, 'l', 0, 'l', 0, 'e', 0, 'd', 0, ' ',
1228 0, 'o', 0, 'u', 0, 't', 0, ' ',
1229 0, 'o', 0, 'f', 0, ' ',
1230 0, 's', 0, 'e', 0, 'q', 0, 'u', 0, 'e', 0, 'n', 0, 'c', 0, 'e', 0, 0, 0
1231 };
danielk19774ad17132004-05-21 01:47:26 +00001232
drhc60d0442004-09-30 13:43:13 +00001233 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00001234 if( !db ){
drhc60d0442004-09-30 13:43:13 +00001235 return (void *)(&outOfMemBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
1236 }
drhd55d57e2008-07-07 17:53:07 +00001237 if( !sqlite3SafetyCheckSickOrOk(db) ){
drhc60d0442004-09-30 13:43:13 +00001238 return (void *)(&misuseBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
1239 }
drhe30f4422007-08-21 16:15:55 +00001240 sqlite3_mutex_enter(db->mutex);
1241 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +00001242 z = sqlite3_value_text16(db->pErr);
1243 if( z==0 ){
drhb21c8cd2007-08-21 19:33:56 +00001244 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
drhc60d0442004-09-30 13:43:13 +00001245 SQLITE_UTF8, SQLITE_STATIC);
1246 z = sqlite3_value_text16(db->pErr);
1247 }
danielk1977131c8bc2008-05-22 13:56:17 +00001248 /* A malloc() may have failed within the call to sqlite3_value_text16()
1249 ** above. If this is the case, then the db->mallocFailed flag needs to
1250 ** be cleared before returning. Do this directly, instead of via
1251 ** sqlite3ApiExit(), to avoid setting the database handle error message.
1252 */
1253 db->mallocFailed = 0;
drhe30f4422007-08-21 16:15:55 +00001254 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001255 return z;
danielk19776622cce2004-05-20 11:00:52 +00001256}
drh6c626082004-11-14 21:56:29 +00001257#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00001258
drhc60d0442004-09-30 13:43:13 +00001259/*
danielk19777ddad962005-12-12 06:53:03 +00001260** Return the most recent error code generated by an SQLite routine. If NULL is
1261** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00001262*/
danielk19776622cce2004-05-20 11:00:52 +00001263int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00001264 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drhc60d0442004-09-30 13:43:13 +00001265 return SQLITE_MISUSE;
1266 }
drh01495b92008-01-23 12:52:40 +00001267 if( !db || db->mallocFailed ){
1268 return SQLITE_NOMEM;
1269 }
drh4ac285a2006-09-15 07:28:50 +00001270 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00001271}
1272
drh0e819f92006-02-01 13:50:41 +00001273/*
1274** Create a new collating function for database "db". The name is zName
1275** and the encoding is enc.
1276*/
danielk19779a30cf62006-01-18 04:26:07 +00001277static int createCollation(
1278 sqlite3* db,
1279 const char *zName,
1280 int enc,
1281 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00001282 int(*xCompare)(void*,int,const void*,int,const void*),
1283 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00001284){
1285 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00001286 int enc2;
drh0a687d12008-07-08 14:52:07 +00001287 int nName;
danielk19779a30cf62006-01-18 04:26:07 +00001288
drhe30f4422007-08-21 16:15:55 +00001289 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00001290
1291 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1292 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1293 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1294 */
drh7d9bd4e2006-02-16 18:16:36 +00001295 enc2 = enc & ~SQLITE_UTF16_ALIGNED;
1296 if( enc2==SQLITE_UTF16 ){
1297 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00001298 }
drh7d9bd4e2006-02-16 18:16:36 +00001299 if( (enc2&~3)!=0 ){
drhd55d57e2008-07-07 17:53:07 +00001300 return SQLITE_MISUSE;
danielk19779a30cf62006-01-18 04:26:07 +00001301 }
1302
1303 /* Check if this call is removing or replacing an existing collation
1304 ** sequence. If so, and there are active VMs, return busy. If there
1305 ** are no active VMs, invalidate any pre-compiled statements.
1306 */
drh0a687d12008-07-08 14:52:07 +00001307 nName = sqlite3Strlen(db, zName);
1308 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, nName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00001309 if( pColl && pColl->xCmp ){
1310 if( db->activeVdbeCnt ){
1311 sqlite3Error(db, SQLITE_BUSY,
1312 "Unable to delete/modify collation sequence due to active statements");
1313 return SQLITE_BUSY;
1314 }
1315 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00001316
1317 /* If collation sequence pColl was created directly by a call to
1318 ** sqlite3_create_collation, and not generated by synthCollSeq(),
1319 ** then any copies made by synthCollSeq() need to be invalidated.
1320 ** Also, collation destructor - CollSeq.xDel() - function may need
1321 ** to be called.
1322 */
1323 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drh0a687d12008-07-08 14:52:07 +00001324 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, nName);
danielk1977a9808b32007-05-07 09:32:45 +00001325 int j;
1326 for(j=0; j<3; j++){
1327 CollSeq *p = &aColl[j];
1328 if( p->enc==pColl->enc ){
1329 if( p->xDel ){
1330 p->xDel(p->pUser);
1331 }
1332 p->xCmp = 0;
1333 }
1334 }
1335 }
danielk19779a30cf62006-01-18 04:26:07 +00001336 }
1337
drh0a687d12008-07-08 14:52:07 +00001338 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, nName, 1);
danielk19779a30cf62006-01-18 04:26:07 +00001339 if( pColl ){
1340 pColl->xCmp = xCompare;
1341 pColl->pUser = pCtx;
danielk1977a9808b32007-05-07 09:32:45 +00001342 pColl->xDel = xDel;
drh7d9bd4e2006-02-16 18:16:36 +00001343 pColl->enc = enc2 | (enc & SQLITE_UTF16_ALIGNED);
danielk19779a30cf62006-01-18 04:26:07 +00001344 }
1345 sqlite3Error(db, SQLITE_OK, 0);
1346 return SQLITE_OK;
1347}
1348
1349
danielk19776622cce2004-05-20 11:00:52 +00001350/*
drhbb4957f2008-03-20 14:03:29 +00001351** This array defines hard upper bounds on limit values. The
1352** initializer must be kept in sync with the SQLITE_LIMIT_*
1353** #defines in sqlite3.h.
1354*/
drhb1a6c3c2008-03-20 16:30:17 +00001355static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00001356 SQLITE_MAX_LENGTH,
1357 SQLITE_MAX_SQL_LENGTH,
1358 SQLITE_MAX_COLUMN,
1359 SQLITE_MAX_EXPR_DEPTH,
1360 SQLITE_MAX_COMPOUND_SELECT,
1361 SQLITE_MAX_VDBE_OP,
1362 SQLITE_MAX_FUNCTION_ARG,
1363 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00001364 SQLITE_MAX_LIKE_PATTERN_LENGTH,
1365 SQLITE_MAX_VARIABLE_NUMBER,
1366};
1367
1368/*
1369** Make sure the hard limits are set to reasonable values
1370*/
1371#if SQLITE_MAX_LENGTH<100
1372# error SQLITE_MAX_LENGTH must be at least 100
1373#endif
1374#if SQLITE_MAX_SQL_LENGTH<100
1375# error SQLITE_MAX_SQL_LENGTH must be at least 100
1376#endif
1377#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
1378# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
1379#endif
drhbb4957f2008-03-20 14:03:29 +00001380#if SQLITE_MAX_COMPOUND_SELECT<2
1381# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
1382#endif
1383#if SQLITE_MAX_VDBE_OP<40
1384# error SQLITE_MAX_VDBE_OP must be at least 40
1385#endif
drhe82f5d02008-10-07 19:53:14 +00001386#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
1387# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00001388#endif
danielk19777b7e23b2008-08-20 16:21:12 +00001389#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>30
1390# error SQLITE_MAX_ATTACHED must be between 0 and 30
drhbb4957f2008-03-20 14:03:29 +00001391#endif
drhbb4957f2008-03-20 14:03:29 +00001392#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
1393# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
1394#endif
1395#if SQLITE_MAX_VARIABLE_NUMBER<1
1396# error SQLITE_MAX_VARIABLE_NUMBER must be at least 1
1397#endif
drh70a8ca32008-08-21 18:49:27 +00001398#if SQLITE_MAX_COLUMN>32767
1399# error SQLITE_MAX_COLUMN must not exceed 32767
1400#endif
drhbb4957f2008-03-20 14:03:29 +00001401
1402
1403/*
1404** Change the value of a limit. Report the old value.
1405** If an invalid limit index is supplied, report -1.
1406** Make no changes but still report the old value if the
1407** new limit is negative.
1408**
1409** A new lower limit does not shrink existing constructs.
1410** It merely prevents new constructs that exceed the limit
1411** from forming.
1412*/
1413int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
1414 int oldLimit;
drh521cc842008-04-15 02:36:33 +00001415 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00001416 return -1;
1417 }
1418 oldLimit = db->aLimit[limitId];
1419 if( newLimit>=0 ){
drhf47ce562008-03-20 18:00:49 +00001420 if( newLimit>aHardLimit[limitId] ){
drhbb4957f2008-03-20 14:03:29 +00001421 newLimit = aHardLimit[limitId];
1422 }
1423 db->aLimit[limitId] = newLimit;
1424 }
1425 return oldLimit;
1426}
1427
1428/*
danielk19774ad17132004-05-21 01:47:26 +00001429** This routine does the work of opening a database on behalf of
1430** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00001431** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00001432*/
1433static int openDatabase(
1434 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00001435 sqlite3 **ppDb, /* OUT: Returned database handle */
1436 unsigned flags, /* Operational flags */
1437 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00001438){
1439 sqlite3 *db;
danielk1977da184232006-01-05 11:34:32 +00001440 int rc;
drhd64fe2f2005-08-28 17:00:23 +00001441 CollSeq *pColl;
drh039963a2008-09-03 00:43:15 +00001442 int isThreadsafe;
danielk19774ad17132004-05-21 01:47:26 +00001443
drh40257ff2008-06-13 18:24:27 +00001444#ifndef SQLITE_OMIT_AUTOINIT
1445 rc = sqlite3_initialize();
1446 if( rc ) return rc;
1447#endif
1448
drh039963a2008-09-03 00:43:15 +00001449 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00001450 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00001451 }else if( flags & SQLITE_OPEN_NOMUTEX ){
1452 isThreadsafe = 0;
1453 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
1454 isThreadsafe = 1;
1455 }else{
1456 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00001457 }
1458
drha4267dc2008-02-19 15:20:44 +00001459 /* Remove harmful bits from the flags parameter */
1460 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
1461 SQLITE_OPEN_MAIN_DB |
1462 SQLITE_OPEN_TEMP_DB |
1463 SQLITE_OPEN_TRANSIENT_DB |
1464 SQLITE_OPEN_MAIN_JOURNAL |
1465 SQLITE_OPEN_TEMP_JOURNAL |
1466 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00001467 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00001468 SQLITE_OPEN_NOMUTEX |
1469 SQLITE_OPEN_FULLMUTEX
drha4267dc2008-02-19 15:20:44 +00001470 );
1471
danielk19774ad17132004-05-21 01:47:26 +00001472 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00001473 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00001474 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00001475 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00001476 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
1477 if( db->mutex==0 ){
1478 sqlite3_free(db);
1479 db = 0;
1480 goto opendb_out;
1481 }
drh605264d2007-08-21 15:13:19 +00001482 }
drh27641702007-08-22 02:56:42 +00001483 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001484 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00001485 db->priorNewRowid = 0;
danielk19774ad17132004-05-21 01:47:26 +00001486 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00001487 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00001488 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00001489
drhbb4957f2008-03-20 14:03:29 +00001490 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
1491 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
danielk19771d850a72004-05-31 08:26:49 +00001492 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00001493 db->nextAutovac = -1;
danielk1977f653d782008-03-20 11:04:21 +00001494 db->nextPagesize = 0;
drh76fe8032006-07-11 14:17:51 +00001495 db->flags |= SQLITE_ShortColNames
1496#if SQLITE_DEFAULT_FILE_FORMAT<4
1497 | SQLITE_LegacyFileFmt
1498#endif
drh56424db2007-03-27 22:24:11 +00001499#ifdef SQLITE_ENABLE_LOAD_EXTENSION
1500 | SQLITE_LoadExtension
1501#endif
drh76fe8032006-07-11 14:17:51 +00001502 ;
danielk19774ad17132004-05-21 01:47:26 +00001503 sqlite3HashInit(&db->aCollSeq, SQLITE_HASH_STRING, 0);
drhb9bb7c12006-06-11 23:41:55 +00001504#ifndef SQLITE_OMIT_VIRTUALTABLE
1505 sqlite3HashInit(&db->aModule, SQLITE_HASH_STRING, 0);
1506#endif
danielk1977da184232006-01-05 11:34:32 +00001507
danielk197795c8a542007-09-01 06:51:27 +00001508 db->pVfs = sqlite3_vfs_find(zVfs);
1509 if( !db->pVfs ){
1510 rc = SQLITE_ERROR;
drhafc91042008-02-21 02:09:45 +00001511 sqlite3Error(db, rc, "no such vfs: %s", zVfs);
danielk197795c8a542007-09-01 06:51:27 +00001512 goto opendb_out;
1513 }
1514
danielk19770202b292004-06-09 09:55:16 +00001515 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
1516 ** and UTF-16, so add a version for each to avoid any unnecessary
1517 ** conversions. The only error that can occur here is a malloc() failure.
1518 */
drhafc91042008-02-21 02:09:45 +00001519 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
1520 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
1521 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
1522 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00001523 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00001524 goto opendb_out;
1525 }
drh77db4c02008-03-18 13:01:38 +00001526 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0);
1527 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00001528
1529 /* Also add a UTF-8 case-insensitive collation sequence. */
danielk1977a9808b32007-05-07 09:32:45 +00001530 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
danielk19770202b292004-06-09 09:55:16 +00001531
drhd64fe2f2005-08-28 17:00:23 +00001532 /* Set flags on the built-in collating sequences */
1533 db->pDfltColl->type = SQLITE_COLL_BINARY;
1534 pColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "NOCASE", 6, 0);
1535 if( pColl ){
1536 pColl->type = SQLITE_COLL_NOCASE;
1537 }
1538
danielk19774ad17132004-05-21 01:47:26 +00001539 /* Open the backend database driver */
drh33f4e022007-09-03 15:19:34 +00001540 db->openFlags = flags;
1541 rc = sqlite3BtreeFactory(db, zFilename, 0, SQLITE_DEFAULT_CACHE_SIZE,
1542 flags | SQLITE_OPEN_MAIN_DB,
drhc797d4d2007-05-08 01:08:49 +00001543 &db->aDb[0].pBt);
danielk19774ad17132004-05-21 01:47:26 +00001544 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00001545 if( rc==SQLITE_IOERR_NOMEM ){
1546 rc = SQLITE_NOMEM;
1547 }
danielk19774ad17132004-05-21 01:47:26 +00001548 sqlite3Error(db, rc, 0);
danielk19774ad17132004-05-21 01:47:26 +00001549 goto opendb_out;
1550 }
drh17435752007-08-16 04:30:38 +00001551 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
1552 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00001553
drh03b808a2006-03-13 15:06:05 +00001554
danielk197753c0f742005-03-29 03:10:59 +00001555 /* The default safety_level for the main database is 'full'; for the temp
1556 ** database it is 'NONE'. This matches the pager layer defaults.
1557 */
1558 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00001559 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00001560#ifndef SQLITE_OMIT_TEMPDB
1561 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00001562 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00001563#endif
1564
danielk1977832a58a2007-06-22 15:21:15 +00001565 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00001566 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00001567 goto opendb_out;
1568 }
1569
danielk19778e227872004-06-07 07:52:17 +00001570 /* Register all built-in functions, but do not attempt to read the
1571 ** database schema yet. This is delayed until the first time the database
1572 ** is accessed.
1573 */
danielk1977832a58a2007-06-22 15:21:15 +00001574 sqlite3Error(db, SQLITE_OK, 0);
1575 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00001576
drh1409be62006-08-23 20:07:20 +00001577 /* Load automatic extensions - extensions that have been registered
1578 ** using the sqlite3_automatic_extension() API.
1579 */
drhf533acc2006-12-19 18:57:11 +00001580 (void)sqlite3AutoLoadExtensions(db);
danielk1977832a58a2007-06-22 15:21:15 +00001581 if( sqlite3_errcode(db)!=SQLITE_OK ){
1582 goto opendb_out;
1583 }
drh1409be62006-08-23 20:07:20 +00001584
drhaa29c132006-09-02 13:58:06 +00001585#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00001586 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00001587 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001588 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00001589 }
1590#endif
1591
shessa26cf572006-10-19 20:27:58 +00001592#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00001593 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00001594 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001595 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00001596 }
1597#endif
1598
shess69c4ae22007-08-20 17:37:47 +00001599#ifdef SQLITE_ENABLE_FTS3
1600 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00001601 rc = sqlite3Fts3Init(db);
1602 }
1603#endif
1604
danielk197783852ac2007-05-06 16:04:11 +00001605#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00001606 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00001607 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00001608 }
1609#endif
danielk1977ebaecc12008-05-26 18:41:54 +00001610
1611#ifdef SQLITE_ENABLE_RTREE
1612 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00001613 rc = sqlite3RtreeInit(db);
1614 }
1615#endif
1616
danielk1977832a58a2007-06-22 15:21:15 +00001617 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00001618
drh8fd5bd32007-04-02 16:40:37 +00001619 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
1620 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
1621 ** mode. Doing nothing at all also makes NORMAL the default.
1622 */
1623#ifdef SQLITE_DEFAULT_LOCKING_MODE
1624 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
1625 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
1626 SQLITE_DEFAULT_LOCKING_MODE);
1627#endif
1628
drh633e6d52008-07-28 19:34:53 +00001629 /* Enable the lookaside-malloc subsystem */
danielk1977075c23a2008-09-01 18:34:20 +00001630 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside, sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00001631
danielk19774ad17132004-05-21 01:47:26 +00001632opendb_out:
drhafc91042008-02-21 02:09:45 +00001633 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00001634 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00001635 sqlite3_mutex_leave(db->mutex);
1636 }
danielk197759633ae2008-08-27 19:01:57 +00001637 rc = sqlite3_errcode(db);
1638 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00001639 sqlite3_close(db);
1640 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00001641 }else if( rc!=SQLITE_OK ){
1642 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00001643 }
danielk19774ad17132004-05-21 01:47:26 +00001644 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00001645 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001646}
1647
1648/*
1649** Open a new database handle.
1650*/
danielk197780290862004-05-22 09:21:21 +00001651int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00001652 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001653 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001654){
drh605264d2007-08-21 15:13:19 +00001655 return openDatabase(zFilename, ppDb,
1656 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
1657}
1658int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00001659 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00001660 sqlite3 **ppDb, /* OUT: SQLite db handle */
1661 int flags, /* Flags */
1662 const char *zVfs /* Name of VFS module to use */
1663){
1664 return openDatabase(filename, ppDb, flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00001665}
1666
drh6c626082004-11-14 21:56:29 +00001667#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001668/*
1669** Open a new database handle.
1670*/
1671int sqlite3_open16(
1672 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001673 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001674){
danielk1977bfd6cce2004-06-18 04:24:54 +00001675 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00001676 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00001677 int rc;
danielk19774ad17132004-05-21 01:47:26 +00001678
danielk19777ddad962005-12-12 06:53:03 +00001679 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00001680 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00001681 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00001682#ifndef SQLITE_OMIT_AUTOINIT
1683 rc = sqlite3_initialize();
1684 if( rc ) return rc;
1685#endif
danielk19771e536952007-08-16 10:09:01 +00001686 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00001687 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
1688 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001689 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00001690 rc = openDatabase(zFilename8, ppDb,
1691 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00001692 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00001693 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00001694 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00001695 }
drh40257ff2008-06-13 18:24:27 +00001696 }else{
1697 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00001698 }
danielk19777ddad962005-12-12 06:53:03 +00001699 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00001700
danielk197754f01982006-01-18 15:25:17 +00001701 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001702}
drh6c626082004-11-14 21:56:29 +00001703#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00001704
danielk1977106bb232004-05-21 10:08:53 +00001705/*
danielk1977d8123362004-06-12 09:25:12 +00001706** Register a new collation sequence with the database handle db.
1707*/
danielk19770202b292004-06-09 09:55:16 +00001708int sqlite3_create_collation(
1709 sqlite3* db,
1710 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001711 int enc,
danielk19770202b292004-06-09 09:55:16 +00001712 void* pCtx,
1713 int(*xCompare)(void*,int,const void*,int,const void*)
1714){
danielk19779a30cf62006-01-18 04:26:07 +00001715 int rc;
drhe30f4422007-08-21 16:15:55 +00001716 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001717 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001718 rc = createCollation(db, zName, enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00001719 rc = sqlite3ApiExit(db, rc);
1720 sqlite3_mutex_leave(db->mutex);
1721 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00001722}
1723
1724/*
1725** Register a new collation sequence with the database handle db.
1726*/
danielk1977a393c032007-05-07 14:58:53 +00001727int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00001728 sqlite3* db,
1729 const char *zName,
1730 int enc,
1731 void* pCtx,
1732 int(*xCompare)(void*,int,const void*,int,const void*),
1733 void(*xDel)(void*)
1734){
1735 int rc;
drhe30f4422007-08-21 16:15:55 +00001736 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001737 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001738 rc = createCollation(db, zName, enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00001739 rc = sqlite3ApiExit(db, rc);
1740 sqlite3_mutex_leave(db->mutex);
1741 return rc;
danielk19770202b292004-06-09 09:55:16 +00001742}
1743
drh6c626082004-11-14 21:56:29 +00001744#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001745/*
1746** Register a new collation sequence with the database handle db.
1747*/
danielk19770202b292004-06-09 09:55:16 +00001748int sqlite3_create_collation16(
1749 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00001750 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00001751 int enc,
danielk19770202b292004-06-09 09:55:16 +00001752 void* pCtx,
1753 int(*xCompare)(void*,int,const void*,int,const void*)
1754){
danielk19779a30cf62006-01-18 04:26:07 +00001755 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00001756 char *zName8;
drhe30f4422007-08-21 16:15:55 +00001757 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001758 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00001759 zName8 = sqlite3Utf16to8(db, zName, -1);
danielk19779a30cf62006-01-18 04:26:07 +00001760 if( zName8 ){
danielk1977a9808b32007-05-07 09:32:45 +00001761 rc = createCollation(db, zName8, enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00001762 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00001763 }
drhe30f4422007-08-21 16:15:55 +00001764 rc = sqlite3ApiExit(db, rc);
1765 sqlite3_mutex_leave(db->mutex);
1766 return rc;
danielk19770202b292004-06-09 09:55:16 +00001767}
drh6c626082004-11-14 21:56:29 +00001768#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00001769
danielk1977d8123362004-06-12 09:25:12 +00001770/*
1771** Register a collation sequence factory callback with the database handle
1772** db. Replace any previously installed collation sequence factory.
1773*/
danielk19777cedc8d2004-06-10 10:50:08 +00001774int sqlite3_collation_needed(
1775 sqlite3 *db,
1776 void *pCollNeededArg,
1777 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
1778){
drhe30f4422007-08-21 16:15:55 +00001779 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001780 db->xCollNeeded = xCollNeeded;
1781 db->xCollNeeded16 = 0;
1782 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001783 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001784 return SQLITE_OK;
1785}
danielk1977d8123362004-06-12 09:25:12 +00001786
drh6c626082004-11-14 21:56:29 +00001787#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001788/*
1789** Register a collation sequence factory callback with the database handle
1790** db. Replace any previously installed collation sequence factory.
1791*/
danielk19777cedc8d2004-06-10 10:50:08 +00001792int sqlite3_collation_needed16(
1793 sqlite3 *db,
1794 void *pCollNeededArg,
1795 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
1796){
drhe30f4422007-08-21 16:15:55 +00001797 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001798 db->xCollNeeded = 0;
1799 db->xCollNeeded16 = xCollNeeded16;
1800 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001801 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001802 return SQLITE_OK;
1803}
drh6c626082004-11-14 21:56:29 +00001804#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00001805
1806#ifndef SQLITE_OMIT_GLOBALRECOVER
1807/*
danielk19777ddad962005-12-12 06:53:03 +00001808** This function is now an anachronism. It used to be used to recover from a
1809** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00001810*/
drh7d97efb2007-10-12 19:35:48 +00001811int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00001812 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00001813}
1814#endif
drh3e1d8e62005-05-26 16:23:34 +00001815
1816/*
1817** Test to see whether or not the database connection is in autocommit
1818** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1819** by default. Autocommit is disabled by a BEGIN statement and reenabled
1820** by the next COMMIT or ROLLBACK.
1821**
1822******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
1823*/
1824int sqlite3_get_autocommit(sqlite3 *db){
1825 return db->autoCommit;
1826}
drh49285702005-09-17 15:20:26 +00001827
1828#ifdef SQLITE_DEBUG
1829/*
1830** The following routine is subtituted for constant SQLITE_CORRUPT in
1831** debugging builds. This provides a way to set a breakpoint for when
1832** corruption is first detected.
1833*/
1834int sqlite3Corrupt(void){
1835 return SQLITE_CORRUPT;
1836}
1837#endif
drh7c1817e2006-01-10 13:58:48 +00001838
drh6f7adc82006-01-11 21:41:20 +00001839/*
1840** This is a convenience routine that makes sure that all thread-specific
1841** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00001842**
1843** SQLite no longer uses thread-specific data so this routine is now a
1844** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00001845*/
1846void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00001847}
danielk1977deb802c2006-02-09 13:43:28 +00001848
1849/*
1850** Return meta information about a specific column of a database table.
1851** See comment in sqlite3.h (sqlite.h.in) for details.
1852*/
1853#ifdef SQLITE_ENABLE_COLUMN_METADATA
1854int sqlite3_table_column_metadata(
1855 sqlite3 *db, /* Connection handle */
1856 const char *zDbName, /* Database name or NULL */
1857 const char *zTableName, /* Table name */
1858 const char *zColumnName, /* Column name */
1859 char const **pzDataType, /* OUTPUT: Declared data type */
1860 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
1861 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
1862 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00001863 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00001864){
1865 int rc;
1866 char *zErrMsg = 0;
1867 Table *pTab = 0;
1868 Column *pCol = 0;
1869 int iCol;
1870
1871 char const *zDataType = 0;
1872 char const *zCollSeq = 0;
1873 int notnull = 0;
1874 int primarykey = 0;
1875 int autoinc = 0;
1876
1877 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00001878 sqlite3_mutex_enter(db->mutex);
drha0af99f2008-04-16 00:49:12 +00001879 (void)sqlite3SafetyOn(db);
drh3cb3edc2008-03-07 21:37:19 +00001880 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00001881 rc = sqlite3Init(db, &zErrMsg);
drh3cb3edc2008-03-07 21:37:19 +00001882 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00001883 if( SQLITE_OK!=rc ){
1884 goto error_out;
1885 }
1886
1887 /* Locate the table in question */
1888 pTab = sqlite3FindTable(db, zTableName, zDbName);
1889 if( !pTab || pTab->pSelect ){
1890 pTab = 0;
1891 goto error_out;
1892 }
1893
1894 /* Find the column for which info is requested */
1895 if( sqlite3IsRowid(zColumnName) ){
1896 iCol = pTab->iPKey;
1897 if( iCol>=0 ){
1898 pCol = &pTab->aCol[iCol];
1899 }
1900 }else{
1901 for(iCol=0; iCol<pTab->nCol; iCol++){
1902 pCol = &pTab->aCol[iCol];
1903 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
1904 break;
1905 }
1906 }
1907 if( iCol==pTab->nCol ){
1908 pTab = 0;
1909 goto error_out;
1910 }
1911 }
1912
1913 /* The following block stores the meta information that will be returned
1914 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
1915 ** and autoinc. At this point there are two possibilities:
1916 **
1917 ** 1. The specified column name was rowid", "oid" or "_rowid_"
1918 ** and there is no explicitly declared IPK column.
1919 **
1920 ** 2. The table is not a view and the column name identified an
1921 ** explicitly declared column. Copy meta information from *pCol.
1922 */
1923 if( pCol ){
1924 zDataType = pCol->zType;
1925 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00001926 notnull = pCol->notNull!=0;
1927 primarykey = pCol->isPrimKey!=0;
drh7d10d5a2008-08-20 16:35:10 +00001928 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00001929 }else{
1930 zDataType = "INTEGER";
1931 primarykey = 1;
1932 }
1933 if( !zCollSeq ){
1934 zCollSeq = "BINARY";
1935 }
1936
1937error_out:
drh01495b92008-01-23 12:52:40 +00001938 (void)sqlite3SafetyOff(db);
danielk1977deb802c2006-02-09 13:43:28 +00001939
1940 /* Whether the function call succeeded or failed, set the output parameters
1941 ** to whatever their local counterparts contain. If an error did occur,
1942 ** this has the effect of zeroing all output parameters.
1943 */
1944 if( pzDataType ) *pzDataType = zDataType;
1945 if( pzCollSeq ) *pzCollSeq = zCollSeq;
1946 if( pNotNull ) *pNotNull = notnull;
1947 if( pPrimaryKey ) *pPrimaryKey = primarykey;
1948 if( pAutoinc ) *pAutoinc = autoinc;
1949
1950 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00001951 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00001952 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00001953 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00001954 rc = SQLITE_ERROR;
1955 }
1956 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00001957 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00001958 rc = sqlite3ApiExit(db, rc);
1959 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00001960 return rc;
1961}
drhe30f4422007-08-21 16:15:55 +00001962#endif
drhf9cb7f52006-06-27 20:06:44 +00001963
1964/*
1965** Sleep for a little while. Return the amount of time slept.
1966*/
1967int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00001968 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00001969 int rc;
drhd677b3d2007-08-20 22:48:41 +00001970 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00001971 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00001972
1973 /* This function works in milliseconds, but the underlying OsSleep()
1974 ** API uses microseconds. Hence the 1000's.
1975 */
drhe30f4422007-08-21 16:15:55 +00001976 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00001977 return rc;
drhf9cb7f52006-06-27 20:06:44 +00001978}
drh4ac285a2006-09-15 07:28:50 +00001979
1980/*
1981** Enable or disable the extended result codes.
1982*/
1983int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00001984 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001985 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00001986 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001987 return SQLITE_OK;
1988}
drhcc6bb3e2007-08-31 16:11:35 +00001989
1990/*
1991** Invoke the xFileControl method on a particular database.
1992*/
1993int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
1994 int rc = SQLITE_ERROR;
1995 int iDb;
1996 sqlite3_mutex_enter(db->mutex);
1997 if( zDbName==0 ){
1998 iDb = 0;
1999 }else{
2000 for(iDb=0; iDb<db->nDb; iDb++){
2001 if( strcmp(db->aDb[iDb].zName, zDbName)==0 ) break;
2002 }
2003 }
2004 if( iDb<db->nDb ){
2005 Btree *pBtree = db->aDb[iDb].pBt;
2006 if( pBtree ){
2007 Pager *pPager;
drh55176252008-01-22 14:50:16 +00002008 sqlite3_file *fd;
drhcc6bb3e2007-08-31 16:11:35 +00002009 sqlite3BtreeEnter(pBtree);
2010 pPager = sqlite3BtreePager(pBtree);
drh55176252008-01-22 14:50:16 +00002011 assert( pPager!=0 );
2012 fd = sqlite3PagerFile(pPager);
2013 assert( fd!=0 );
2014 if( fd->pMethods ){
2015 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00002016 }
2017 sqlite3BtreeLeave(pBtree);
2018 }
2019 }
2020 sqlite3_mutex_leave(db->mutex);
2021 return rc;
2022}
drhed13d982008-01-31 14:43:24 +00002023
2024/*
2025** Interface to the testing logic.
2026*/
2027int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00002028 int rc = 0;
drh3088d592008-03-21 16:45:47 +00002029#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00002030 va_list ap;
drhed13d982008-01-31 14:43:24 +00002031 va_start(ap, op);
2032 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00002033
2034 /*
drh984bfaa2008-03-19 16:08:53 +00002035 ** Save the current state of the PRNG.
2036 */
drh2fa18682008-03-19 14:15:34 +00002037 case SQLITE_TESTCTRL_PRNG_SAVE: {
2038 sqlite3PrngSaveState();
2039 break;
2040 }
drh984bfaa2008-03-19 16:08:53 +00002041
2042 /*
2043 ** Restore the state of the PRNG to the last state saved using
2044 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
2045 ** this verb acts like PRNG_RESET.
2046 */
drh2fa18682008-03-19 14:15:34 +00002047 case SQLITE_TESTCTRL_PRNG_RESTORE: {
2048 sqlite3PrngRestoreState();
2049 break;
2050 }
drh984bfaa2008-03-19 16:08:53 +00002051
2052 /*
2053 ** Reset the PRNG back to its uninitialized state. The next call
2054 ** to sqlite3_randomness() will reseed the PRNG using a single call
2055 ** to the xRandomness method of the default VFS.
2056 */
drh2fa18682008-03-19 14:15:34 +00002057 case SQLITE_TESTCTRL_PRNG_RESET: {
2058 sqlite3PrngResetState();
2059 break;
2060 }
drh3088d592008-03-21 16:45:47 +00002061
2062 /*
2063 ** sqlite3_test_control(BITVEC_TEST, size, program)
2064 **
2065 ** Run a test against a Bitvec object of size. The program argument
2066 ** is an array of integers that defines the test. Return -1 on a
2067 ** memory allocation error, 0 on success, or non-zero for an error.
2068 ** See the sqlite3BitvecBuiltinTest() for additional information.
2069 */
2070 case SQLITE_TESTCTRL_BITVEC_TEST: {
2071 int sz = va_arg(ap, int);
2072 int *aProg = va_arg(ap, int*);
2073 rc = sqlite3BitvecBuiltinTest(sz, aProg);
2074 break;
2075 }
danielk19772d1d86f2008-06-20 14:59:51 +00002076
2077 /*
2078 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
2079 **
2080 ** Register hooks to call to indicate which malloc() failures
2081 ** are benign.
2082 */
2083 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00002084 typedef void (*void_function)(void);
2085 void_function xBenignBegin;
2086 void_function xBenignEnd;
2087 xBenignBegin = va_arg(ap, void_function);
2088 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00002089 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
2090 break;
2091 }
drhed13d982008-01-31 14:43:24 +00002092 }
2093 va_end(ap);
drh3088d592008-03-21 16:45:47 +00002094#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00002095 return rc;
drhed13d982008-01-31 14:43:24 +00002096}