blob: 696713114388381afa76224f958a8a03a6e453f2 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Main file for the SQLite library. The routines in this file
13** implement the programmer interface to the library. Routines in
14** other files are for internal use by SQLite and should not be
15** accessed by users of the library.
drh75897232000-05-29 14:26:00 +000016*/
17#include "sqliteInt.h"
drh58f1c8b2008-05-26 20:19:25 +000018
drh820a9062008-01-31 13:35:48 +000019#ifdef SQLITE_ENABLE_FTS3
20# include "fts3.h"
21#endif
drh58f1c8b2008-05-26 20:19:25 +000022#ifdef SQLITE_ENABLE_RTREE
23# include "rtree.h"
24#endif
danielk19771c826652008-09-08 08:08:09 +000025#ifdef SQLITE_ENABLE_ICU
26# include "sqliteicu.h"
27#endif
drh75897232000-05-29 14:26:00 +000028
drhb3190c12008-12-08 21:37:14 +000029#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000030/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
31** contains the text of SQLITE_VERSION macro.
32*/
danielk197724b03fd2004-05-10 10:34:34 +000033const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000034#endif
drh9f129f42010-08-31 15:27:32 +000035
36/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
37** a pointer to the to the sqlite3_version[] string constant.
38*/
drh4aec8b62004-08-28 16:19:00 +000039const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000040
41/* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
42** pointer to a string constant whose value is the same as the
43** SQLITE_SOURCE_ID C preprocessor macro.
44*/
drh47baebc2009-08-14 16:01:24 +000045const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000046
47/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
48** returns an integer equal to SQLITE_VERSION_NUMBER.
49*/
danielk197799ba19e2005-02-05 07:33:34 +000050int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000051
drh5dc2bcd2012-01-02 15:45:12 +000052/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000053** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000054** the SQLITE_THREADSAFE compile-time option being set to 0.
55*/
drhb67e8bf2007-08-30 20:09:48 +000056int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000057
drhe265b082008-05-01 17:03:49 +000058#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000059/*
drhb0603412007-02-28 04:47:26 +000060** If the following function pointer is not NULL and if
61** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
62** I/O active are written using this function. These messages
63** are intended for debugging activity only.
64*/
dan80389532014-12-24 17:17:30 +000065/* not-private */ void (*sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000066#endif
drhb0603412007-02-28 04:47:26 +000067
68/*
drha16313e2007-03-30 11:29:32 +000069** If the following global variable points to a string which is the
70** name of a directory, then that directory will be used to store
71** temporary files.
72**
73** See also the "PRAGMA temp_store_directory" SQL command.
74*/
75char *sqlite3_temp_directory = 0;
76
drhc5499be2008-04-01 15:06:33 +000077/*
mistachkina112d142012-03-14 00:44:01 +000078** If the following global variable points to a string which is the
79** name of a directory, then that directory will be used to store
80** all database files specified with a relative pathname.
81**
82** See also the "PRAGMA data_store_directory" SQL command.
83*/
84char *sqlite3_data_directory = 0;
85
86/*
drh40257ff2008-06-13 18:24:27 +000087** Initialize SQLite.
88**
89** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +000090** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +000091** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
92** this routine will be called automatically by key routines such as
93** sqlite3_open().
94**
95** This routine is a no-op except on its very first call for the process,
96** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +000097**
98** The first thread to call this routine runs the initialization to
99** completion. If subsequent threads call this routine before the first
100** thread has finished the initialization process, then the subsequent
101** threads must block until the first thread finishes with the initialization.
102**
103** The first thread might call this routine recursively. Recursive
104** calls to this routine should not block, of course. Otherwise the
105** initialization process would never complete.
106**
107** Let X be the first thread to enter this routine. Let Y be some other
108** thread. Then while the initial invocation of this routine by X is
109** incomplete, it is required that:
110**
111** * Calls to this routine from Y must block until the outer-most
112** call by X completes.
113**
114** * Recursive calls to this routine from thread X return immediately
115** without blocking.
drh40257ff2008-06-13 18:24:27 +0000116*/
117int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000118 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000119 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000120#ifdef SQLITE_EXTRA_INIT
121 int bRunExtraInit = 0; /* Extra initialization needed */
122#endif
danielk1977075c23a2008-09-01 18:34:20 +0000123
124#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000125 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000126 if( rc!=SQLITE_OK ){
127 return rc;
128 }
129#endif
danielk197771bc31c2008-06-26 08:29:34 +0000130
drh2b4905c2015-03-23 18:52:56 +0000131 /* If the following assert() fails on some obscure processor/compiler
132 ** combination, the work-around is to set the correct pointer
133 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
134 assert( SQLITE_PTRSIZE==sizeof(char*) );
135
drh93ed56d2008-08-12 15:21:11 +0000136 /* If SQLite is already completely initialized, then this call
137 ** to sqlite3_initialize() should be a no-op. But the initialization
138 ** must be complete. So isInit must not be set until the very end
139 ** of this routine.
140 */
danielk1977075c23a2008-09-01 18:34:20 +0000141 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000142
drh93ed56d2008-08-12 15:21:11 +0000143 /* Make sure the mutex subsystem is initialized. If unable to
144 ** initialize the mutex subsystem, return early with the error.
145 ** If the system is so sick that we are unable to allocate a mutex,
146 ** there is not much SQLite is going to be able to do.
147 **
148 ** The mutex subsystem must take care of serializing its own
149 ** initialization.
150 */
danielk1977d0251742008-06-18 18:57:42 +0000151 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000152 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000153
drh93ed56d2008-08-12 15:21:11 +0000154 /* Initialize the malloc() system and the recursive pInitMutex mutex.
155 ** This operation is protected by the STATIC_MASTER mutex. Note that
156 ** MutexAlloc() is called for a static mutex prior to initializing the
157 ** malloc subsystem - this implies that the allocation of a static
158 ** mutex must not require support from the malloc subsystem.
159 */
drh30ddce62011-10-15 00:16:30 +0000160 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000161 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000162 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000163 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000164 rc = sqlite3MallocInit();
165 }
drh40257ff2008-06-13 18:24:27 +0000166 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000167 sqlite3GlobalConfig.isMallocInit = 1;
168 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000169 sqlite3GlobalConfig.pInitMutex =
170 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000171 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000172 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000173 }
174 }
danielk197777eb5bb2008-09-22 17:22:19 +0000175 }
176 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000177 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000178 }
179 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000180
dane1ab2192009-08-17 15:16:19 +0000181 /* If rc is not SQLITE_OK at this point, then either the malloc
182 ** subsystem could not be initialized or the system failed to allocate
183 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000184 if( rc!=SQLITE_OK ){
185 return rc;
186 }
187
188 /* Do the rest of the initialization under the recursive mutex so
189 ** that we will be able to handle recursive calls into
190 ** sqlite3_initialize(). The recursive calls normally come through
191 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
192 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000193 **
194 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
195 ** to the xInit method, so the xInit method need not be threadsafe.
196 **
197 ** The following mutex is what serializes access to the appdef pcache xInit
198 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
199 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000200 */
danielk1977075c23a2008-09-01 18:34:20 +0000201 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000202 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000203 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000204 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000205 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000206 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000207 if( sqlite3GlobalConfig.isPCacheInit==0 ){
208 rc = sqlite3PcacheInitialize();
209 }
danielk19778c0a7912008-08-20 14:49:23 +0000210 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000211 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000212 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000213 }
214 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000215 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
216 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000217 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000218#ifdef SQLITE_EXTRA_INIT
219 bRunExtraInit = 1;
220#endif
danielk19778c0a7912008-08-20 14:49:23 +0000221 }
danielk1977502b4e02008-09-02 14:07:24 +0000222 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000223 }
danielk1977075c23a2008-09-01 18:34:20 +0000224 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000225
drh93ed56d2008-08-12 15:21:11 +0000226 /* Go back under the static mutex and clean up the recursive
227 ** mutex to prevent a resource leak.
228 */
229 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000230 sqlite3GlobalConfig.nRefInitMutex--;
231 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
232 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
233 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
234 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000235 }
236 sqlite3_mutex_leave(pMaster);
237
238 /* The following is just a sanity check to make sure SQLite has
239 ** been compiled correctly. It is important to run this code, but
240 ** we don't want to run it too often and soak up CPU cycles for no
241 ** reason. So we run it once during initialization.
242 */
shanedfb7b372008-07-22 05:13:30 +0000243#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000244#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000245 /* This section of code's only "output" is via assert() statements. */
246 if ( rc==SQLITE_OK ){
247 u64 x = (((u64)1)<<63)-1;
248 double y;
249 assert(sizeof(x)==8);
250 assert(sizeof(x)==sizeof(y));
251 memcpy(&y, &x, 8);
252 assert( sqlite3IsNaN(y) );
253 }
254#endif
shanefbd60f82009-02-04 03:59:25 +0000255#endif
shanedfb7b372008-07-22 05:13:30 +0000256
drhe4cf0b32011-08-25 00:14:41 +0000257 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
258 ** compile-time option.
259 */
260#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000261 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000262 int SQLITE_EXTRA_INIT(const char*);
263 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000264 }
265#endif
266
drh40257ff2008-06-13 18:24:27 +0000267 return rc;
268}
269
270/*
271** Undo the effects of sqlite3_initialize(). Must not be called while
272** there are outstanding database connections or memory allocations or
273** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000274** routine is not threadsafe. But it is safe to invoke this routine
275** on when SQLite is already shut down. If SQLite is already shut down
276** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000277*/
278int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000279#ifdef SQLITE_OMIT_WSD
280 int rc = sqlite3_wsd_init(4096, 24);
281 if( rc!=SQLITE_OK ){
282 return rc;
283 }
284#endif
285
danielk1977075c23a2008-09-01 18:34:20 +0000286 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000287#ifdef SQLITE_EXTRA_SHUTDOWN
288 void SQLITE_EXTRA_SHUTDOWN(void);
289 SQLITE_EXTRA_SHUTDOWN();
290#endif
drha7640922009-04-21 12:02:56 +0000291 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000292 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000293 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000294 }
dane1ab2192009-08-17 15:16:19 +0000295 if( sqlite3GlobalConfig.isPCacheInit ){
296 sqlite3PcacheShutdown();
297 sqlite3GlobalConfig.isPCacheInit = 0;
298 }
299 if( sqlite3GlobalConfig.isMallocInit ){
300 sqlite3MallocEnd();
301 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000302
303#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
304 /* The heap subsystem has now been shutdown and these values are supposed
305 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
306 ** which would rely on that heap subsystem; therefore, make sure these
307 ** values cannot refer to heap memory that was just invalidated when the
308 ** heap subsystem was shutdown. This is only done if the current call to
309 ** this function resulted in the heap subsystem actually being shutdown.
310 */
311 sqlite3_data_directory = 0;
312 sqlite3_temp_directory = 0;
313#endif
dane1ab2192009-08-17 15:16:19 +0000314 }
315 if( sqlite3GlobalConfig.isMutexInit ){
316 sqlite3MutexEnd();
317 sqlite3GlobalConfig.isMutexInit = 0;
318 }
319
drh40257ff2008-06-13 18:24:27 +0000320 return SQLITE_OK;
321}
322
323/*
324** This API allows applications to modify the global configuration of
325** the SQLite library at run-time.
326**
327** This routine should only be called when there are no outstanding
328** database connections or memory allocations. This routine is not
329** threadsafe. Failure to heed these warnings can lead to unpredictable
330** behavior.
331*/
332int sqlite3_config(int op, ...){
333 va_list ap;
334 int rc = SQLITE_OK;
335
336 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
337 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000338 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000339
340 va_start(ap, op);
341 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000342
343 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000344 ** compile.
drh18472fa2008-10-07 15:25:48 +0000345 */
drhd1dcb232014-11-01 18:32:18 +0000346#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000347 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000348 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
349 ** Single-thread. */
350 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
351 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000352 break;
353 }
drhd1dcb232014-11-01 18:32:18 +0000354#endif
355#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000356 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000357 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
358 ** Multi-thread. */
359 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
360 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000361 break;
362 }
drhd1dcb232014-11-01 18:32:18 +0000363#endif
364#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000365 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000366 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
367 ** Serialized. */
368 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
369 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000370 break;
371 }
drhd1dcb232014-11-01 18:32:18 +0000372#endif
373#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000374 case SQLITE_CONFIG_MUTEX: {
375 /* Specify an alternative mutex implementation */
376 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
377 break;
378 }
drhd1dcb232014-11-01 18:32:18 +0000379#endif
380#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000381 case SQLITE_CONFIG_GETMUTEX: {
382 /* Retrieve the current mutex implementation */
383 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
384 break;
385 }
386#endif
387
drh40257ff2008-06-13 18:24:27 +0000388 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000389 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
390 ** single argument which is a pointer to an instance of the
391 ** sqlite3_mem_methods structure. The argument specifies alternative
392 ** low-level memory allocation routines to be used in place of the memory
393 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000394 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000395 break;
396 }
drh33589792008-06-18 13:27:46 +0000397 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000398 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
399 ** single argument which is a pointer to an instance of the
400 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
401 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000402 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
403 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000404 break;
405 }
drhfec00ea2008-06-14 16:56:21 +0000406 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000407 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
408 ** single argument of type int, interpreted as a boolean, which enables
409 ** or disables the collection of memory allocation statistics. */
410 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000411 break;
412 }
drh33589792008-06-18 13:27:46 +0000413 case SQLITE_CONFIG_SCRATCH: {
drh5279d342014-11-04 13:41:32 +0000414 /* EVIDENCE-OF: R-08404-60887 There are three arguments to
415 ** SQLITE_CONFIG_SCRATCH: A pointer an 8-byte aligned memory buffer from
416 ** which the scratch allocations will be drawn, the size of each scratch
417 ** allocation (sz), and the maximum number of scratch allocations (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000418 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
419 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
420 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000421 break;
422 }
423 case SQLITE_CONFIG_PAGECACHE: {
drh5279d342014-11-04 13:41:32 +0000424 /* EVIDENCE-OF: R-31408-40510 There are three arguments to
425 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory, the size
426 ** of each page buffer (sz), and the number of pages (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000427 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
428 sqlite3GlobalConfig.szPage = va_arg(ap, int);
429 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000430 break;
431 }
drhdef68892014-11-04 12:11:23 +0000432 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000433 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
434 ** a single parameter which is a pointer to an integer and writes into
435 ** that integer the number of extra bytes per page required for each page
436 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000437 *va_arg(ap, int*) =
438 sqlite3HeaderSizeBtree() +
439 sqlite3HeaderSizePcache() +
440 sqlite3HeaderSizePcache1();
441 break;
442 }
danielk19775099be52008-06-27 13:27:03 +0000443
danielk1977bc2ca9e2008-11-13 14:28:28 +0000444 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000445 /* no-op */
446 break;
447 }
448 case SQLITE_CONFIG_GETPCACHE: {
449 /* now an error */
450 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000451 break;
452 }
453
dan22e21ff2011-11-08 20:08:44 +0000454 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000455 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
456 ** single argument which is a pointer to an sqlite3_pcache_methods2
457 ** object. This object specifies the interface to a custom page cache
458 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000459 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
460 break;
461 }
462 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000463 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
464 ** single argument which is a pointer to an sqlite3_pcache_methods2
465 ** object. SQLite copies of the current page cache implementation into
466 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000467 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000468 sqlite3PCacheSetDefault();
469 }
dan22e21ff2011-11-08 20:08:44 +0000470 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000471 break;
472 }
473
drh8790b6e2014-11-07 01:43:56 +0000474/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
475** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
476** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000477#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000478 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000479 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
480 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000481 ** number of bytes in the memory buffer, and the minimum allocation size.
482 */
danielk1977075c23a2008-09-01 18:34:20 +0000483 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
484 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
485 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000486
shaneha6ec8922011-03-09 21:36:17 +0000487 if( sqlite3GlobalConfig.mnReq<1 ){
488 sqlite3GlobalConfig.mnReq = 1;
489 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
490 /* cap min request size at 2^12 */
491 sqlite3GlobalConfig.mnReq = (1<<12);
492 }
493
danielk1977075c23a2008-09-01 18:34:20 +0000494 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000495 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
496 ** is NULL, then SQLite reverts to using its default memory allocator
497 ** (the system malloc() implementation), undoing any prior invocation of
498 ** SQLITE_CONFIG_MALLOC.
499 **
500 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
501 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000502 */
danielk1977075c23a2008-09-01 18:34:20 +0000503 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000504 }else{
drh8790b6e2014-11-07 01:43:56 +0000505 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
506 ** alternative memory allocator is engaged to handle all of SQLites
507 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000508#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000509 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000510#endif
511#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000512 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000513#endif
drh8a42cbd2008-07-10 18:13:42 +0000514 }
danielk19775099be52008-06-27 13:27:03 +0000515 break;
516 }
drh5d414832008-07-15 14:47:18 +0000517#endif
danielk19775099be52008-06-27 13:27:03 +0000518
drh633e6d52008-07-28 19:34:53 +0000519 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000520 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
521 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000522 break;
523 }
drh3f280702010-02-18 18:45:09 +0000524
mistachkin037933b2013-08-13 22:33:41 +0000525 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000526 ** The default is NULL. Logging is disabled if the function pointer is
527 ** NULL.
528 */
529 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000530 /* MSVC is picky about pulling func ptrs from va lists.
531 ** http://support.microsoft.com/kb/47961
532 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
533 */
534 typedef void(*LOGFUNC_t)(void*,int,const char*);
535 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000536 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
537 break;
538 }
drh633e6d52008-07-28 19:34:53 +0000539
drh00729cb2014-10-04 11:59:33 +0000540 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
541 ** can be changed at start-time using the
542 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
543 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
544 */
dancd74b612011-04-22 19:37:32 +0000545 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000546 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
547 ** argument of type int. If non-zero, then URI handling is globally
548 ** enabled. If the parameter is zero, then URI handling is globally
549 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000550 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
551 break;
552 }
553
drhde9a7b82012-09-17 20:44:46 +0000554 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000555 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
556 ** option takes a single integer argument which is interpreted as a
557 ** boolean in order to enable or disable the use of covering indices for
558 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000559 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
560 break;
561 }
562
danac455932012-11-26 19:50:41 +0000563#ifdef SQLITE_ENABLE_SQLLOG
564 case SQLITE_CONFIG_SQLLOG: {
565 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
566 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
567 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
568 break;
569 }
570#endif
571
drh9b4c59f2013-04-15 17:03:42 +0000572 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000573 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
574 ** integer (sqlite3_int64) values that are the default mmap size limit
575 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
576 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000577 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000578 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000579 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000580 ** negative, then that argument is changed to its compile-time default.
581 **
582 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
583 ** silently truncated if necessary so that it does not exceed the
584 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
585 ** compile-time option.
586 */
drh3ba689d2015-03-03 14:00:11 +0000587 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
588 mxMmap = SQLITE_MAX_MMAP_SIZE;
589 }
drh9b4c59f2013-04-15 17:03:42 +0000590 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
591 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000592 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000593 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000594 break;
595 }
596
drh4d9f1882014-11-04 17:23:24 +0000597#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000598 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000599 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
600 ** unsigned integer value that specifies the maximum size of the created
601 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000602 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
603 break;
604 }
605#endif
606
drh3bd17912015-01-02 15:55:29 +0000607 case SQLITE_CONFIG_PMASZ: {
608 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
609 break;
610 }
611
drh40257ff2008-06-13 18:24:27 +0000612 default: {
613 rc = SQLITE_ERROR;
614 break;
615 }
616 }
617 va_end(ap);
618 return rc;
619}
620
621/*
drh633e6d52008-07-28 19:34:53 +0000622** Set up the lookaside buffers for a database connection.
623** Return SQLITE_OK on success.
624** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000625**
626** The sz parameter is the number of bytes in each lookaside slot.
627** The cnt parameter is the number of slots. If pStart is NULL the
628** space for the lookaside memory is obtained from sqlite3_malloc().
629** If pStart is not NULL then it is sz*cnt bytes of memory to use for
630** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000631*/
drhe9d1c722008-08-04 20:13:26 +0000632static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000633 void *pStart;
634 if( db->lookaside.nOut ){
635 return SQLITE_BUSY;
636 }
shanef71f89e2009-01-30 06:11:54 +0000637 /* Free any existing lookaside buffer for this handle before
638 ** allocating a new one so we don't have to have space for
639 ** both at the same time.
640 */
641 if( db->lookaside.bMalloced ){
642 sqlite3_free(db->lookaside.pStart);
643 }
drh61a4bd52011-11-10 02:39:28 +0000644 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
645 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000646 */
drh61a4bd52011-11-10 02:39:28 +0000647 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000648 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000649 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000650 if( sz==0 || cnt==0 ){
651 sz = 0;
652 pStart = 0;
653 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000654 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000655 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000656 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000657 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000658 }else{
659 pStart = pBuf;
660 }
drh4cfb22f2008-08-01 18:47:01 +0000661 db->lookaside.pStart = pStart;
662 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000663 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000664 if( pStart ){
665 int i;
666 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000667 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000668 p = (LookasideSlot*)pStart;
669 for(i=cnt-1; i>=0; i--){
670 p->pNext = db->lookaside.pFree;
671 db->lookaside.pFree = p;
672 p = (LookasideSlot*)&((u8*)p)[sz];
673 }
674 db->lookaside.pEnd = p;
675 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000676 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000677 }else{
drhb0e77042013-12-10 19:49:00 +0000678 db->lookaside.pStart = db;
679 db->lookaside.pEnd = db;
drh4cfb22f2008-08-01 18:47:01 +0000680 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000681 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000682 }
683 return SQLITE_OK;
684}
685
686/*
drh4413d0e2008-11-04 13:46:27 +0000687** Return the mutex associated with a database connection.
688*/
689sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000690#ifdef SQLITE_ENABLE_API_ARMOR
691 if( !sqlite3SafetyCheckOk(db) ){
692 (void)SQLITE_MISUSE_BKPT;
693 return 0;
694 }
695#endif
drh4413d0e2008-11-04 13:46:27 +0000696 return db->mutex;
697}
698
699/*
drh09419b42011-11-16 19:29:17 +0000700** Free up as much memory as we can from the given database
701** connection.
702*/
703int sqlite3_db_release_memory(sqlite3 *db){
704 int i;
drh9ca95732014-10-24 00:35:58 +0000705
706#ifdef SQLITE_ENABLE_API_ARMOR
707 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
708#endif
dand9bb3a92011-12-30 11:43:59 +0000709 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000710 sqlite3BtreeEnterAll(db);
711 for(i=0; i<db->nDb; i++){
712 Btree *pBt = db->aDb[i].pBt;
713 if( pBt ){
714 Pager *pPager = sqlite3BtreePager(pBt);
715 sqlite3PagerShrink(pPager);
716 }
717 }
718 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000719 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000720 return SQLITE_OK;
721}
722
723/*
drh633e6d52008-07-28 19:34:53 +0000724** Configuration settings for an individual database connection
725*/
726int sqlite3_db_config(sqlite3 *db, int op, ...){
727 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000728 int rc;
drh633e6d52008-07-28 19:34:53 +0000729 va_start(ap, op);
730 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000731 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000732 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000733 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
734 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000735 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000736 break;
737 }
drh6480aad2008-08-01 16:31:14 +0000738 default: {
drhe83cafd2011-03-21 17:15:58 +0000739 static const struct {
740 int op; /* The opcode */
741 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
742 } aFlagOp[] = {
743 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
744 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
745 };
drh58ad5802011-03-23 22:02:23 +0000746 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000747 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000748 for(i=0; i<ArraySize(aFlagOp); i++){
749 if( aFlagOp[i].op==op ){
750 int onoff = va_arg(ap, int);
751 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000752 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000753 if( onoff>0 ){
754 db->flags |= aFlagOp[i].mask;
755 }else if( onoff==0 ){
756 db->flags &= ~aFlagOp[i].mask;
757 }
758 if( oldFlags!=db->flags ){
759 sqlite3ExpirePreparedStatements(db);
760 }
761 if( pRes ){
762 *pRes = (db->flags & aFlagOp[i].mask)!=0;
763 }
764 rc = SQLITE_OK;
765 break;
766 }
767 }
drh6480aad2008-08-01 16:31:14 +0000768 break;
769 }
drh633e6d52008-07-28 19:34:53 +0000770 }
771 va_end(ap);
772 return rc;
773}
774
drha16313e2007-03-30 11:29:32 +0000775
776/*
drh9b5adfa2008-01-20 23:19:56 +0000777** Return true if the buffer z[0..n-1] contains all spaces.
778*/
779static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000780 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000781 return n==0;
782}
783
784/*
drhd3d39e92004-05-20 22:16:29 +0000785** This is the default collating function named "BINARY" which is always
786** available.
drh9b5adfa2008-01-20 23:19:56 +0000787**
788** If the padFlag argument is not NULL then space padding at the end
789** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000790*/
danielk19772c336542005-01-13 02:14:23 +0000791static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000792 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000793 int nKey1, const void *pKey1,
794 int nKey2, const void *pKey2
795){
796 int rc, n;
797 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000798 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
799 ** strings byte by byte using the memcmp() function from the standard C
800 ** library. */
drhd3d39e92004-05-20 22:16:29 +0000801 rc = memcmp(pKey1, pKey2, n);
802 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000803 if( padFlag
804 && allSpaces(((char*)pKey1)+n, nKey1-n)
805 && allSpaces(((char*)pKey2)+n, nKey2-n)
806 ){
drh5e3b49b2014-11-20 19:22:26 +0000807 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
808 ** spaces at the end of either string do not change the result. In other
809 ** words, strings will compare equal to one another as long as they
810 ** differ only in the number of spaces at the end.
811 */
drh9b5adfa2008-01-20 23:19:56 +0000812 }else{
813 rc = nKey1 - nKey2;
814 }
drhd3d39e92004-05-20 22:16:29 +0000815 }
816 return rc;
817}
818
819/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000820** Another built-in collating sequence: NOCASE.
821**
drhf7b54962013-05-28 12:11:54 +0000822** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000823** comparison". SQLite's knowledge of upper and lower case equivalents
824** extends only to the 26 characters used in the English language.
825**
826** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000827*/
828static int nocaseCollatingFunc(
829 void *NotUsed,
830 int nKey1, const void *pKey1,
831 int nKey2, const void *pKey2
832){
833 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000834 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000835 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000836 if( 0==r ){
837 r = nKey1-nKey2;
838 }
839 return r;
840}
841
842/*
drhaf9ff332002-01-16 21:00:27 +0000843** Return the ROWID of the most recent insert
844*/
drh9bb575f2004-09-06 17:24:11 +0000845sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000846#ifdef SQLITE_ENABLE_API_ARMOR
847 if( !sqlite3SafetyCheckOk(db) ){
848 (void)SQLITE_MISUSE_BKPT;
849 return 0;
850 }
851#endif
drhaf9ff332002-01-16 21:00:27 +0000852 return db->lastRowid;
853}
854
855/*
danielk197724b03fd2004-05-10 10:34:34 +0000856** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000857*/
drh9bb575f2004-09-06 17:24:11 +0000858int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000859#ifdef SQLITE_ENABLE_API_ARMOR
860 if( !sqlite3SafetyCheckOk(db) ){
861 (void)SQLITE_MISUSE_BKPT;
862 return 0;
863 }
864#endif
drhc8d30ac2002-04-12 10:08:59 +0000865 return db->nChange;
866}
867
rdcf146a772004-02-25 22:51:06 +0000868/*
danielk1977b28af712004-06-21 06:50:26 +0000869** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000870*/
danielk1977b28af712004-06-21 06:50:26 +0000871int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000872#ifdef SQLITE_ENABLE_API_ARMOR
873 if( !sqlite3SafetyCheckOk(db) ){
874 (void)SQLITE_MISUSE_BKPT;
875 return 0;
876 }
877#endif
danielk1977b28af712004-06-21 06:50:26 +0000878 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000879}
880
drhc8d30ac2002-04-12 10:08:59 +0000881/*
danielk1977fd7f0452008-12-17 17:30:26 +0000882** Close all open savepoints. This function only manipulates fields of the
883** database handle object, it does not close any savepoints that may be open
884** at the b-tree/pager level.
885*/
886void sqlite3CloseSavepoints(sqlite3 *db){
887 while( db->pSavepoint ){
888 Savepoint *pTmp = db->pSavepoint;
889 db->pSavepoint = pTmp->pNext;
890 sqlite3DbFree(db, pTmp);
891 }
892 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000893 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000894 db->isTransactionSavepoint = 0;
895}
896
897/*
dand2199f02010-08-27 17:48:52 +0000898** Invoke the destructor function associated with FuncDef p, if any. Except,
899** if this is not the last copy of the function, do not invoke it. Multiple
900** copies of a single function are created when create_function() is called
901** with SQLITE_ANY as the encoding.
902*/
903static void functionDestroy(sqlite3 *db, FuncDef *p){
904 FuncDestructor *pDestructor = p->pDestructor;
905 if( pDestructor ){
906 pDestructor->nRef--;
907 if( pDestructor->nRef==0 ){
908 pDestructor->xDestroy(pDestructor->pUserData);
909 sqlite3DbFree(db, pDestructor);
910 }
911 }
912}
913
914/*
danbba02a92012-05-15 17:15:34 +0000915** Disconnect all sqlite3_vtab objects that belong to database connection
916** db. This is called when db is being closed.
917*/
918static void disconnectAllVtab(sqlite3 *db){
919#ifndef SQLITE_OMIT_VIRTUALTABLE
920 int i;
921 sqlite3BtreeEnterAll(db);
922 for(i=0; i<db->nDb; i++){
923 Schema *pSchema = db->aDb[i].pSchema;
924 if( db->aDb[i].pSchema ){
925 HashElem *p;
926 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
927 Table *pTab = (Table *)sqliteHashData(p);
928 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
929 }
930 }
931 }
dand88e5212014-03-12 19:38:38 +0000932 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000933 sqlite3BtreeLeaveAll(db);
934#else
935 UNUSED_PARAMETER(db);
936#endif
937}
938
939/*
drh167cd6a2012-06-02 17:09:46 +0000940** Return TRUE if database connection db has unfinalized prepared
941** statements or unfinished sqlite3_backup objects.
942*/
943static int connectionIsBusy(sqlite3 *db){
944 int j;
945 assert( sqlite3_mutex_held(db->mutex) );
946 if( db->pVdbe ) return 1;
947 for(j=0; j<db->nDb; j++){
948 Btree *pBt = db->aDb[j].pBt;
949 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
950 }
951 return 0;
952}
953
954/*
drh50e5dad2001-09-15 00:57:28 +0000955** Close an existing SQLite database
956*/
drh167cd6a2012-06-02 17:09:46 +0000957static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000958 if( !db ){
drhddb17ca2014-08-11 15:54:11 +0000959 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
960 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +0000961 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000962 }
drh7e8b8482008-01-23 03:03:05 +0000963 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000964 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000965 }
drh605264d2007-08-21 15:13:19 +0000966 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000967
danbba02a92012-05-15 17:15:34 +0000968 /* Force xDisconnect calls on all virtual tables */
969 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000970
danbba02a92012-05-15 17:15:34 +0000971 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000972 ** will not have called the xDisconnect() method on any virtual
973 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
974 ** call will do so. We need to do this before the check for active
975 ** SQL statements below, as the v-table implementation may be storing
976 ** some prepared statements internally.
977 */
dan67430812013-05-15 10:21:50 +0000978 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000979
drh167cd6a2012-06-02 17:09:46 +0000980 /* Legacy behavior (sqlite3_close() behavior) is to return
981 ** SQLITE_BUSY if the connection can not be closed immediately.
982 */
983 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +0000984 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +0000985 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000986 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000987 return SQLITE_BUSY;
988 }
danielk1977e0048402004-06-15 16:51:01 +0000989
danac455932012-11-26 19:50:41 +0000990#ifdef SQLITE_ENABLE_SQLLOG
991 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +0000992 /* Closing the handle. Fourth parameter is passed the value 2. */
993 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +0000994 }
995#endif
996
drh167cd6a2012-06-02 17:09:46 +0000997 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +0000998 */
999 db->magic = SQLITE_MAGIC_ZOMBIE;
1000 sqlite3LeaveMutexAndCloseZombie(db);
1001 return SQLITE_OK;
1002}
drh94e92032003-02-16 22:21:32 +00001003
drh167cd6a2012-06-02 17:09:46 +00001004/*
1005** Two variations on the public interface for closing a database
1006** connection. The sqlite3_close() version returns SQLITE_BUSY and
1007** leaves the connection option if there are unfinalized prepared
1008** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1009** version forces the connection to become a zombie if there are
1010** unclosed resources, and arranges for deallocation when the last
1011** prepare statement or sqlite3_backup closes.
1012*/
1013int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1014int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1015
drh4245c402012-06-02 14:32:21 +00001016
1017/*
1018** Close the mutex on database connection db.
1019**
1020** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001021** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1022** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1023** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001024*/
1025void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1026 HashElem *i; /* Hash table iterator */
1027 int j;
1028
drh4245c402012-06-02 14:32:21 +00001029 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001030 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1031 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001032 */
drh167cd6a2012-06-02 17:09:46 +00001033 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001034 sqlite3_mutex_leave(db->mutex);
1035 return;
danielk197704103022009-02-03 16:51:24 +00001036 }
1037
drh4245c402012-06-02 14:32:21 +00001038 /* If we reach this point, it means that the database connection has
1039 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001040 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001041 ** go ahead and free all resources.
1042 */
1043
dan617dc862013-05-16 11:57:28 +00001044 /* If a transaction is open, roll it back. This also ensures that if
1045 ** any database schemas have been modified by an uncommitted transaction
1046 ** they are reset. And that the required b-tree mutex is held to make
1047 ** the pager rollback and schema reset an atomic operation. */
1048 sqlite3RollbackAll(db, SQLITE_OK);
1049
danielk1977fd7f0452008-12-17 17:30:26 +00001050 /* Free any outstanding Savepoint structures. */
1051 sqlite3CloseSavepoints(db);
1052
drh5efb3142012-05-16 01:24:34 +00001053 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001054 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001055 struct Db *pDb = &db->aDb[j];
1056 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001057 sqlite3BtreeClose(pDb->pBt);
1058 pDb->pBt = 0;
1059 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001060 pDb->pSchema = 0;
1061 }
drh113088e2003-03-20 01:16:58 +00001062 }
drhf57b3392001-10-08 13:22:32 +00001063 }
drh5efb3142012-05-16 01:24:34 +00001064 /* Clear the TEMP schema separately and last */
1065 if( db->aDb[1].pSchema ){
1066 sqlite3SchemaClear(db->aDb[1].pSchema);
1067 }
1068 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001069
drh5efb3142012-05-16 01:24:34 +00001070 /* Free up the array of auxiliary databases */
1071 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001072 assert( db->nDb<=2 );
1073 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001074
1075 /* Tell the code in notify.c that the connection no longer holds any
1076 ** locks and does not require any further unlock-notify callbacks.
1077 */
1078 sqlite3ConnectionClosed(db);
1079
drh70a8ca32008-08-21 18:49:27 +00001080 for(j=0; j<ArraySize(db->aFunc.a); j++){
1081 FuncDef *pNext, *pHash, *p;
1082 for(p=db->aFunc.a[j]; p; p=pHash){
1083 pHash = p->pHash;
1084 while( p ){
dand2199f02010-08-27 17:48:52 +00001085 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +00001086 pNext = p->pNext;
1087 sqlite3DbFree(db, p);
1088 p = pNext;
1089 }
drh8e0a2f92002-02-23 23:45:45 +00001090 }
1091 }
danielk1977d8123362004-06-12 09:25:12 +00001092 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001093 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001094 /* Invoke any destructors registered for collation sequence user data. */
1095 for(j=0; j<3; j++){
1096 if( pColl[j].xDel ){
1097 pColl[j].xDel(pColl[j].pUser);
1098 }
1099 }
drh633e6d52008-07-28 19:34:53 +00001100 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001101 }
danielk1977d8123362004-06-12 09:25:12 +00001102 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001103#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001104 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1105 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001106 if( pMod->xDestroy ){
1107 pMod->xDestroy(pMod->pAux);
1108 }
drh633e6d52008-07-28 19:34:53 +00001109 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001110 }
drhb9bb7c12006-06-11 23:41:55 +00001111 sqlite3HashClear(&db->aModule);
1112#endif
danielk1977466be562004-06-10 02:16:01 +00001113
drh13f40da2014-08-22 18:00:11 +00001114 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001115 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001116 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001117#if SQLITE_USER_AUTHENTICATION
1118 sqlite3_free(db->auth.zAuthUser);
1119 sqlite3_free(db->auth.zAuthPW);
1120#endif
danielk197796d81f92004-06-19 03:33:57 +00001121
1122 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001123
1124 /* The temp-database schema is allocated differently from the other schema
1125 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1126 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1127 ** the same sqliteMalloc() as the one that allocates the database
1128 ** structure?
1129 */
drh633e6d52008-07-28 19:34:53 +00001130 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001131 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001132 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001133 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001134 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001135 if( db->lookaside.bMalloced ){
1136 sqlite3_free(db->lookaside.pStart);
1137 }
drh17435752007-08-16 04:30:38 +00001138 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001139}
1140
1141/*
drh0f198a72012-02-13 16:43:16 +00001142** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001143** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001144** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001145** attempts to use that cursor. Read cursors remain open and valid
1146** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001147*/
drh0f198a72012-02-13 16:43:16 +00001148void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001149 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001150 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001151 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001152 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001153 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001154
1155 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1156 ** This is important in case the transaction being rolled back has
1157 ** modified the database schema. If the b-tree mutexes are not taken
1158 ** here, then another shared-cache connection might sneak in between
1159 ** the database rollback and schema reset, which can cause false
1160 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001161 sqlite3BtreeEnterAll(db);
drh47b7fc72014-11-11 01:33:57 +00001162 schemaChange = (db->flags & SQLITE_InternChanges)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001163
drh001bbcb2003-03-19 03:14:00 +00001164 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001165 Btree *p = db->aDb[i].pBt;
1166 if( p ){
1167 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001168 inTrans = 1;
1169 }
drh47b7fc72014-11-11 01:33:57 +00001170 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001171 }
1172 }
danielk1977a298e902006-06-22 09:53:48 +00001173 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001174 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001175
drh5c5760a2013-02-19 18:34:45 +00001176 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001177 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001178 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001179 }
dancd7b91a2013-05-13 18:23:15 +00001180 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001181
dan1da40a32009-09-19 17:00:31 +00001182 /* Any deferred constraint violations have now been resolved. */
1183 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001184 db->nDeferredImmCons = 0;
1185 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001186
danielk197771fd80b2005-12-16 06:54:01 +00001187 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001188 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001189 db->xRollbackCallback(db->pRollbackArg);
1190 }
drh001bbcb2003-03-19 03:14:00 +00001191}
1192
1193/*
mistachkinf2c1c992013-04-28 01:44:43 +00001194** Return a static string containing the name corresponding to the error code
1195** specified in the argument.
1196*/
drh54027102014-08-06 14:36:53 +00001197#if (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) || defined(SQLITE_TEST)
mistachkinf2c1c992013-04-28 01:44:43 +00001198const char *sqlite3ErrName(int rc){
1199 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001200 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001201 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1202 switch( rc ){
1203 case SQLITE_OK: zName = "SQLITE_OK"; break;
1204 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1205 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1206 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1207 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001208 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001209 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001210 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001211 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001212 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1213 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1214 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1215 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001216 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1217 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1218 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001219 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001220 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1221 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001222 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1223 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1224 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1225 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1226 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1227 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1228 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1229 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1230 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1231 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001232 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1233 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1234 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1235 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1236 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1237 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1238 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1239 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1240 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1241 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1242 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1243 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1244 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1245 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001246 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001247 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001248 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001249 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001250 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1251 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1252 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001253 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1254 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1255 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001256 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001257 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1258 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1259 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1260 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1261 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1262 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1263 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1264 case SQLITE_CONSTRAINT_FOREIGNKEY:
1265 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1266 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1267 case SQLITE_CONSTRAINT_PRIMARYKEY:
1268 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1269 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1270 case SQLITE_CONSTRAINT_COMMITHOOK:
1271 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1272 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1273 case SQLITE_CONSTRAINT_FUNCTION:
1274 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001275 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001276 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1277 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1278 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1279 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1280 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1281 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1282 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1283 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1284 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001285 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1286 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1287 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001288 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001289 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001290 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001291 }
1292 }
mistachkin10269dc2013-04-30 07:54:42 +00001293 if( zName==0 ){
1294 static char zBuf[50];
1295 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1296 zName = zBuf;
1297 }
mistachkinf2c1c992013-04-28 01:44:43 +00001298 return zName;
1299}
mistachkin10269dc2013-04-30 07:54:42 +00001300#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001301
1302/*
drhc22bd472002-05-10 13:14:07 +00001303** Return a static string that describes the kind of error specified in the
1304** argument.
drh247be432002-05-10 05:44:55 +00001305*/
danielk1977f20b21c2004-05-31 23:56:42 +00001306const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001307 static const char* const aMsg[] = {
1308 /* SQLITE_OK */ "not an error",
1309 /* SQLITE_ERROR */ "SQL logic error or missing database",
1310 /* SQLITE_INTERNAL */ 0,
1311 /* SQLITE_PERM */ "access permission denied",
1312 /* SQLITE_ABORT */ "callback requested query abort",
1313 /* SQLITE_BUSY */ "database is locked",
1314 /* SQLITE_LOCKED */ "database table is locked",
1315 /* SQLITE_NOMEM */ "out of memory",
1316 /* SQLITE_READONLY */ "attempt to write a readonly database",
1317 /* SQLITE_INTERRUPT */ "interrupted",
1318 /* SQLITE_IOERR */ "disk I/O error",
1319 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001320 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001321 /* SQLITE_FULL */ "database or disk is full",
1322 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001323 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001324 /* SQLITE_EMPTY */ "table contains no data",
1325 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001326 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001327 /* SQLITE_CONSTRAINT */ "constraint failed",
1328 /* SQLITE_MISMATCH */ "datatype mismatch",
1329 /* SQLITE_MISUSE */ "library routine called out of sequence",
1330 /* SQLITE_NOLFS */ "large file support is disabled",
1331 /* SQLITE_AUTH */ "authorization denied",
1332 /* SQLITE_FORMAT */ "auxiliary database format error",
1333 /* SQLITE_RANGE */ "bind or column index out of range",
1334 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1335 };
drh21021a52012-02-13 17:01:51 +00001336 const char *zErr = "unknown error";
1337 switch( rc ){
1338 case SQLITE_ABORT_ROLLBACK: {
1339 zErr = "abort due to ROLLBACK";
1340 break;
1341 }
1342 default: {
1343 rc &= 0xff;
1344 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1345 zErr = aMsg[rc];
1346 }
1347 break;
1348 }
drh247be432002-05-10 05:44:55 +00001349 }
drh21021a52012-02-13 17:01:51 +00001350 return zErr;
drh247be432002-05-10 05:44:55 +00001351}
1352
1353/*
drh2dfbbca2000-07-28 14:32:48 +00001354** This routine implements a busy callback that sleeps and tries
1355** again until a timeout value is reached. The timeout value is
1356** an integer number of milliseconds passed in as the first
1357** argument.
1358*/
drhdaffd0e2001-04-11 14:28:42 +00001359static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001360 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001361 int count /* Number of times table has been busy */
1362){
drh0ede9eb2015-01-10 16:49:23 +00001363#if SQLITE_OS_WIN || HAVE_USLEEP
drhee570fa2005-04-28 12:06:05 +00001364 static const u8 delays[] =
1365 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1366 static const u8 totals[] =
1367 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001368# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001369 sqlite3 *db = (sqlite3 *)ptr;
1370 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001371 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001372
drhee570fa2005-04-28 12:06:05 +00001373 assert( count>=0 );
1374 if( count < NDELAY ){
1375 delay = delays[count];
1376 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001377 }else{
1378 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001379 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001380 }
drhd1bec472004-01-15 13:29:31 +00001381 if( prior + delay > timeout ){
1382 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001383 if( delay<=0 ) return 0;
1384 }
danielk19772a6bdf62007-08-20 16:07:00 +00001385 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001386 return 1;
1387#else
drh482ea182007-08-20 11:12:40 +00001388 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001389 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001390 if( (count+1)*1000 > timeout ){
1391 return 0;
1392 }
drh482ea182007-08-20 11:12:40 +00001393 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001394 return 1;
1395#endif
1396}
1397
1398/*
drha4afb652005-07-09 02:16:02 +00001399** Invoke the given busy handler.
1400**
1401** This routine is called when an operation failed with a lock.
1402** If this routine returns non-zero, the lock is retried. If it
1403** returns 0, the operation aborts with an SQLITE_BUSY error.
1404*/
1405int sqlite3InvokeBusyHandler(BusyHandler *p){
1406 int rc;
drh34004ce2008-07-11 16:15:17 +00001407 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001408 rc = p->xFunc(p->pArg, p->nBusy);
1409 if( rc==0 ){
1410 p->nBusy = -1;
1411 }else{
1412 p->nBusy++;
1413 }
1414 return rc;
1415}
1416
1417/*
drh2dfbbca2000-07-28 14:32:48 +00001418** This routine sets the busy callback for an Sqlite database to the
1419** given callback function with the given argument.
1420*/
danielk1977f9d64d22004-06-19 08:18:07 +00001421int sqlite3_busy_handler(
1422 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001423 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001424 void *pArg
1425){
drh9ca95732014-10-24 00:35:58 +00001426#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001427 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001428#endif
drhe30f4422007-08-21 16:15:55 +00001429 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001430 db->busyHandler.xFunc = xBusy;
1431 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001432 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001433 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001434 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001435 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001436}
1437
danielk1977348bb5d2003-10-18 09:37:26 +00001438#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1439/*
1440** This routine sets the progress callback for an Sqlite database to the
1441** given callback function with the given argument. The progress callback will
1442** be invoked every nOps opcodes.
1443*/
danielk197724b03fd2004-05-10 10:34:34 +00001444void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001445 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001446 int nOps,
1447 int (*xProgress)(void*),
1448 void *pArg
1449){
drh9ca95732014-10-24 00:35:58 +00001450#ifdef SQLITE_ENABLE_API_ARMOR
1451 if( !sqlite3SafetyCheckOk(db) ){
1452 (void)SQLITE_MISUSE_BKPT;
1453 return;
1454 }
1455#endif
drhbd0b1b52008-07-07 19:52:09 +00001456 sqlite3_mutex_enter(db->mutex);
1457 if( nOps>0 ){
1458 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001459 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001460 db->pProgressArg = pArg;
1461 }else{
1462 db->xProgress = 0;
1463 db->nProgressOps = 0;
1464 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001465 }
drhbd0b1b52008-07-07 19:52:09 +00001466 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001467}
1468#endif
1469
1470
drh2dfbbca2000-07-28 14:32:48 +00001471/*
1472** This routine installs a default busy handler that waits for the
1473** specified number of milliseconds before returning 0.
1474*/
danielk1977f9d64d22004-06-19 08:18:07 +00001475int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001476#ifdef SQLITE_ENABLE_API_ARMOR
1477 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1478#endif
drh2dfbbca2000-07-28 14:32:48 +00001479 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001480 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001481 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001482 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001483 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001484 }
danielk1977f9d64d22004-06-19 08:18:07 +00001485 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001486}
drh4c504392000-10-16 22:06:40 +00001487
1488/*
1489** Cause any pending operation to stop at its earliest opportunity.
1490*/
drh9bb575f2004-09-06 17:24:11 +00001491void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001492#ifdef SQLITE_ENABLE_API_ARMOR
1493 if( !sqlite3SafetyCheckOk(db) ){
1494 (void)SQLITE_MISUSE_BKPT;
1495 return;
1496 }
1497#endif
drhbd0b1b52008-07-07 19:52:09 +00001498 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001499}
drhfa86c412002-02-02 15:01:15 +00001500
drhfa86c412002-02-02 15:01:15 +00001501
1502/*
danielk1977771151b2006-01-17 13:21:40 +00001503** This function is exactly the same as sqlite3_create_function(), except
1504** that it is designed to be called by internal code. The difference is
1505** that if a malloc() fails in sqlite3_create_function(), an error code
1506** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001507*/
danielk1977771151b2006-01-17 13:21:40 +00001508int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001509 sqlite3 *db,
1510 const char *zFunctionName,
1511 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001512 int enc,
danielk197765904932004-05-26 06:18:37 +00001513 void *pUserData,
1514 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1515 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001516 void (*xFinal)(sqlite3_context*),
1517 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001518){
drh0bce8352002-02-28 00:41:10 +00001519 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001520 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001521 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001522
drhe30f4422007-08-21 16:15:55 +00001523 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001524 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001525 (xFunc && (xFinal || xStep)) ||
1526 (!xFunc && (xFinal && !xStep)) ||
1527 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001528 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001529 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001530 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001531 }
drh4a8ee3d2013-12-14 13:44:22 +00001532
1533 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1534 extraFlags = enc & SQLITE_DETERMINISTIC;
1535 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001536
danielk197793758c82005-01-21 08:13:14 +00001537#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001538 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1539 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1540 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1541 **
1542 ** If SQLITE_ANY is specified, add three versions of the function
1543 ** to the hash table.
1544 */
1545 if( enc==SQLITE_UTF16 ){
1546 enc = SQLITE_UTF16NATIVE;
1547 }else if( enc==SQLITE_ANY ){
1548 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001549 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dand2199f02010-08-27 17:48:52 +00001550 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001551 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001552 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dand2199f02010-08-27 17:48:52 +00001553 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001554 }
1555 if( rc!=SQLITE_OK ){
1556 return rc;
1557 }
danielk1977d8123362004-06-12 09:25:12 +00001558 enc = SQLITE_UTF16BE;
1559 }
danielk197793758c82005-01-21 08:13:14 +00001560#else
1561 enc = SQLITE_UTF8;
1562#endif
danielk19779636c4e2005-01-25 04:27:54 +00001563
1564 /* Check if an existing function is being overridden or deleted. If so,
1565 ** and there are active VMs, then return SQLITE_BUSY. If a function
1566 ** is being overridden/deleted but there are no active VMs, allow the
1567 ** operation to continue but invalidate all precompiled statements.
1568 */
drh3abbd392008-12-10 23:04:13 +00001569 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001570 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001571 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001572 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001573 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001574 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001575 return SQLITE_BUSY;
1576 }else{
1577 sqlite3ExpirePreparedStatements(db);
1578 }
1579 }
danielk197765904932004-05-26 06:18:37 +00001580
drh3abbd392008-12-10 23:04:13 +00001581 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001582 assert(p || db->mallocFailed);
1583 if( !p ){
1584 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001585 }
dand2199f02010-08-27 17:48:52 +00001586
1587 /* If an older version of the function with a configured destructor is
1588 ** being replaced invoke the destructor function here. */
1589 functionDestroy(db, p);
1590
1591 if( pDestructor ){
1592 pDestructor->nRef++;
1593 }
1594 p->pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001595 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1596 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
danielk1977fa18bec2007-09-03 11:04:22 +00001597 p->xFunc = xFunc;
1598 p->xStep = xStep;
1599 p->xFinalize = xFinal;
1600 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001601 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001602 return SQLITE_OK;
1603}
danielk1977771151b2006-01-17 13:21:40 +00001604
1605/*
1606** Create new user functions.
1607*/
1608int sqlite3_create_function(
1609 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001610 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001611 int nArg,
1612 int enc,
1613 void *p,
1614 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1615 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1616 void (*xFinal)(sqlite3_context*)
1617){
drh7b19fac2010-08-27 18:44:54 +00001618 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1619 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001620}
1621
1622int sqlite3_create_function_v2(
1623 sqlite3 *db,
1624 const char *zFunc,
1625 int nArg,
1626 int enc,
1627 void *p,
1628 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1629 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1630 void (*xFinal)(sqlite3_context*),
1631 void (*xDestroy)(void *)
1632){
shanehbd2aaf92010-09-01 02:38:21 +00001633 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001634 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001635
1636#ifdef SQLITE_ENABLE_API_ARMOR
1637 if( !sqlite3SafetyCheckOk(db) ){
1638 return SQLITE_MISUSE_BKPT;
1639 }
1640#endif
dand2199f02010-08-27 17:48:52 +00001641 sqlite3_mutex_enter(db->mutex);
1642 if( xDestroy ){
1643 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001644 if( !pArg ){
1645 xDestroy(p);
1646 goto out;
1647 }
dand2199f02010-08-27 17:48:52 +00001648 pArg->xDestroy = xDestroy;
1649 pArg->pUserData = p;
1650 }
1651 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1652 if( pArg && pArg->nRef==0 ){
1653 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001654 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001655 sqlite3DbFree(db, pArg);
1656 }
1657
1658 out:
drhe30f4422007-08-21 16:15:55 +00001659 rc = sqlite3ApiExit(db, rc);
1660 sqlite3_mutex_leave(db->mutex);
1661 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001662}
1663
danielk197793758c82005-01-21 08:13:14 +00001664#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001665int sqlite3_create_function16(
1666 sqlite3 *db,
1667 const void *zFunctionName,
1668 int nArg,
1669 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001670 void *p,
danielk197765904932004-05-26 06:18:37 +00001671 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1672 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1673 void (*xFinal)(sqlite3_context*)
1674){
1675 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001676 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001677
1678#ifdef SQLITE_ENABLE_API_ARMOR
1679 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1680#endif
drhe30f4422007-08-21 16:15:55 +00001681 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001682 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001683 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001684 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001685 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001686 rc = sqlite3ApiExit(db, rc);
1687 sqlite3_mutex_leave(db->mutex);
1688 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001689}
danielk197793758c82005-01-21 08:13:14 +00001690#endif
drhc9b84a12002-06-20 11:36:48 +00001691
drhb7481e72006-09-16 21:45:14 +00001692
1693/*
1694** Declare that a function has been overloaded by a virtual table.
1695**
1696** If the function already exists as a regular global function, then
1697** this routine is a no-op. If the function does not exist, then create
1698** a new one that always throws a run-time error.
1699**
1700** When virtual tables intend to provide an overloaded function, they
1701** should call this routine to make sure the global function exists.
1702** A global function must exist in order for name resolution to work
1703** properly.
1704*/
1705int sqlite3_overload_function(
1706 sqlite3 *db,
1707 const char *zName,
1708 int nArg
1709){
drhdee0e402009-05-03 20:23:53 +00001710 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001711 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001712
1713#ifdef SQLITE_ENABLE_API_ARMOR
1714 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1715 return SQLITE_MISUSE_BKPT;
1716 }
1717#endif
drhe30f4422007-08-21 16:15:55 +00001718 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001719 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001720 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1721 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001722 }
drhcb5e4db2011-10-12 23:49:49 +00001723 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001724 sqlite3_mutex_leave(db->mutex);
1725 return rc;
drhb7481e72006-09-16 21:45:14 +00001726}
1727
drh19e2d372005-08-29 23:00:03 +00001728#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001729/*
drh18de4822003-01-16 16:28:53 +00001730** Register a trace function. The pArg from the previously registered trace
1731** is returned.
1732**
1733** A NULL trace function means that no tracing is executes. A non-NULL
1734** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001735** SQL statement.
drh18de4822003-01-16 16:28:53 +00001736*/
drh9bb575f2004-09-06 17:24:11 +00001737void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001738 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001739
1740#ifdef SQLITE_ENABLE_API_ARMOR
1741 if( !sqlite3SafetyCheckOk(db) ){
1742 (void)SQLITE_MISUSE_BKPT;
1743 return 0;
1744 }
1745#endif
drhe30f4422007-08-21 16:15:55 +00001746 sqlite3_mutex_enter(db->mutex);
1747 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001748 db->xTrace = xTrace;
1749 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001750 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001751 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001752}
drh19e2d372005-08-29 23:00:03 +00001753/*
1754** Register a profile function. The pArg from the previously registered
1755** profile function is returned.
1756**
1757** A NULL profile function means that no profiling is executes. A non-NULL
1758** profile is a pointer to a function that is invoked at the conclusion of
1759** each SQL statement that is run.
1760*/
1761void *sqlite3_profile(
1762 sqlite3 *db,
1763 void (*xProfile)(void*,const char*,sqlite_uint64),
1764 void *pArg
1765){
drhe30f4422007-08-21 16:15:55 +00001766 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001767
1768#ifdef SQLITE_ENABLE_API_ARMOR
1769 if( !sqlite3SafetyCheckOk(db) ){
1770 (void)SQLITE_MISUSE_BKPT;
1771 return 0;
1772 }
1773#endif
drhe30f4422007-08-21 16:15:55 +00001774 sqlite3_mutex_enter(db->mutex);
1775 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001776 db->xProfile = xProfile;
1777 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001778 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001779 return pOld;
1780}
1781#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001782
drhcd565fd2012-03-01 21:30:44 +00001783/*
1784** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001785** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001786** rollback.
1787*/
danielk197724b03fd2004-05-10 10:34:34 +00001788void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001789 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001790 int (*xCallback)(void*), /* Function to invoke on each commit */
1791 void *pArg /* Argument to the function */
1792){
drhe30f4422007-08-21 16:15:55 +00001793 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001794
1795#ifdef SQLITE_ENABLE_API_ARMOR
1796 if( !sqlite3SafetyCheckOk(db) ){
1797 (void)SQLITE_MISUSE_BKPT;
1798 return 0;
1799 }
1800#endif
drhe30f4422007-08-21 16:15:55 +00001801 sqlite3_mutex_enter(db->mutex);
1802 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001803 db->xCommitCallback = xCallback;
1804 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001805 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001806 return pOld;
1807}
1808
danielk197794eb6a12005-12-15 15:22:08 +00001809/*
1810** Register a callback to be invoked each time a row is updated,
1811** inserted or deleted using this database connection.
1812*/
danielk197771fd80b2005-12-16 06:54:01 +00001813void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001814 sqlite3 *db, /* Attach the hook to this database */
1815 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1816 void *pArg /* Argument to the function */
1817){
drhe30f4422007-08-21 16:15:55 +00001818 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001819
1820#ifdef SQLITE_ENABLE_API_ARMOR
1821 if( !sqlite3SafetyCheckOk(db) ){
1822 (void)SQLITE_MISUSE_BKPT;
1823 return 0;
1824 }
1825#endif
drhe30f4422007-08-21 16:15:55 +00001826 sqlite3_mutex_enter(db->mutex);
1827 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001828 db->xUpdateCallback = xCallback;
1829 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001830 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001831 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001832}
1833
danielk197771fd80b2005-12-16 06:54:01 +00001834/*
1835** Register a callback to be invoked each time a transaction is rolled
1836** back by this database connection.
1837*/
1838void *sqlite3_rollback_hook(
1839 sqlite3 *db, /* Attach the hook to this database */
1840 void (*xCallback)(void*), /* Callback function */
1841 void *pArg /* Argument to the function */
1842){
drhe30f4422007-08-21 16:15:55 +00001843 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001844
1845#ifdef SQLITE_ENABLE_API_ARMOR
1846 if( !sqlite3SafetyCheckOk(db) ){
1847 (void)SQLITE_MISUSE_BKPT;
1848 return 0;
1849 }
1850#endif
drhe30f4422007-08-21 16:15:55 +00001851 sqlite3_mutex_enter(db->mutex);
1852 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001853 db->xRollbackCallback = xCallback;
1854 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001855 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001856 return pRet;
1857}
drhaa940ea2004-01-15 02:44:03 +00001858
dan586b9c82010-05-03 08:04:49 +00001859#ifndef SQLITE_OMIT_WAL
1860/*
1861** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001862** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1863** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001864** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001865*/
drhb033d8b2010-05-03 13:37:30 +00001866int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001867 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001868 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001869 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001870 int nFrame /* Size of WAL */
1871){
drh5def0842010-05-05 20:00:25 +00001872 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001873 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001874 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001875 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001876 }
1877 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001878}
drhb033d8b2010-05-03 13:37:30 +00001879#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001880
1881/*
1882** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1883** a database after committing a transaction if there are nFrame or
1884** more frames in the log file. Passing zero or a negative value as the
1885** nFrame parameter disables automatic checkpoints entirely.
1886**
1887** The callback registered by this function replaces any existing callback
1888** registered using sqlite3_wal_hook(). Likewise, registering a callback
1889** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1890** configured by this function.
1891*/
1892int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001893#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001894 UNUSED_PARAMETER(db);
1895 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001896#else
drh9ca95732014-10-24 00:35:58 +00001897#ifdef SQLITE_ENABLE_API_ARMOR
1898 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1899#endif
dan586b9c82010-05-03 08:04:49 +00001900 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001901 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001902 }else{
1903 sqlite3_wal_hook(db, 0, 0);
1904 }
drhb033d8b2010-05-03 13:37:30 +00001905#endif
dan586b9c82010-05-03 08:04:49 +00001906 return SQLITE_OK;
1907}
1908
paulb0208cc2003-04-13 18:26:49 +00001909/*
dan8d22a172010-04-19 18:03:51 +00001910** Register a callback to be invoked each time a transaction is written
1911** into the write-ahead-log by this database connection.
1912*/
drh833bf962010-04-28 14:42:19 +00001913void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001914 sqlite3 *db, /* Attach the hook to this db handle */
1915 int(*xCallback)(void *, sqlite3*, const char*, int),
1916 void *pArg /* First argument passed to xCallback() */
1917){
drhb033d8b2010-05-03 13:37:30 +00001918#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001919 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001920#ifdef SQLITE_ENABLE_API_ARMOR
1921 if( !sqlite3SafetyCheckOk(db) ){
1922 (void)SQLITE_MISUSE_BKPT;
1923 return 0;
1924 }
1925#endif
dan8d22a172010-04-19 18:03:51 +00001926 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001927 pRet = db->pWalArg;
1928 db->xWalCallback = xCallback;
1929 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001930 sqlite3_mutex_leave(db->mutex);
1931 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001932#else
1933 return 0;
1934#endif
dan8d22a172010-04-19 18:03:51 +00001935}
1936
1937/*
dancdc1f042010-11-18 12:11:05 +00001938** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001939*/
dancdc1f042010-11-18 12:11:05 +00001940int sqlite3_wal_checkpoint_v2(
1941 sqlite3 *db, /* Database handle */
1942 const char *zDb, /* Name of attached database (or NULL) */
1943 int eMode, /* SQLITE_CHECKPOINT_* value */
1944 int *pnLog, /* OUT: Size of WAL log in frames */
1945 int *pnCkpt /* OUT: Total number of frames checkpointed */
1946){
drhb033d8b2010-05-03 13:37:30 +00001947#ifdef SQLITE_OMIT_WAL
1948 return SQLITE_OK;
1949#else
dan586b9c82010-05-03 08:04:49 +00001950 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001951 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001952
drh9ca95732014-10-24 00:35:58 +00001953#ifdef SQLITE_ENABLE_API_ARMOR
1954 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1955#endif
1956
dan9c5e3682011-02-07 15:12:12 +00001957 /* Initialize the output variables to -1 in case an error occurs. */
1958 if( pnLog ) *pnLog = -1;
1959 if( pnCkpt ) *pnCkpt = -1;
1960
danf26a1542014-12-02 19:04:54 +00001961 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
1962 assert( SQLITE_CHECKPOINT_FULL==1 );
1963 assert( SQLITE_CHECKPOINT_RESTART==2 );
1964 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
1965 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00001966 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
1967 ** mode: */
dancdc1f042010-11-18 12:11:05 +00001968 return SQLITE_MISUSE;
1969 }
1970
dan586b9c82010-05-03 08:04:49 +00001971 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001972 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001973 iDb = sqlite3FindDbName(db, zDb);
1974 }
1975 if( iDb<0 ){
1976 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00001977 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001978 }else{
dan976b0032015-01-29 19:12:12 +00001979 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00001980 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00001981 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00001982 }
drhb033d8b2010-05-03 13:37:30 +00001983 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001984 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001985 return rc;
1986#endif
dan586b9c82010-05-03 08:04:49 +00001987}
1988
dancdc1f042010-11-18 12:11:05 +00001989
1990/*
1991** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1992** to contains a zero-length string, all attached databases are
1993** checkpointed.
1994*/
1995int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00001996 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
1997 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
1998 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00001999}
2000
drhb033d8b2010-05-03 13:37:30 +00002001#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002002/*
2003** Run a checkpoint on database iDb. This is a no-op if database iDb is
2004** not currently open in WAL mode.
2005**
dan6fcff072010-05-03 14:05:43 +00002006** If a transaction is open on the database being checkpointed, this
2007** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2008** an error occurs while running the checkpoint, an SQLite error code is
2009** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002010**
2011** The mutex on database handle db should be held by the caller. The mutex
2012** associated with the specific b-tree being checkpointed is taken by
2013** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002014**
2015** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2016** checkpointed. If an error is encountered it is returned immediately -
2017** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002018**
dancdc1f042010-11-18 12:11:05 +00002019** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00002020*/
dancdc1f042010-11-18 12:11:05 +00002021int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002022 int rc = SQLITE_OK; /* Return code */
2023 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002024 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002025
2026 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002027 assert( !pnLog || *pnLog==-1 );
2028 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002029
dan6fcff072010-05-03 14:05:43 +00002030 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2031 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002032 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002033 pnLog = 0;
2034 pnCkpt = 0;
2035 if( rc==SQLITE_BUSY ){
2036 bBusy = 1;
2037 rc = SQLITE_OK;
2038 }
dan6fcff072010-05-03 14:05:43 +00002039 }
dan586b9c82010-05-03 08:04:49 +00002040 }
2041
danf2b8dd52010-11-18 19:28:01 +00002042 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002043}
drhb033d8b2010-05-03 13:37:30 +00002044#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002045
2046/*
danielk1977d8293352009-04-30 09:10:37 +00002047** This function returns true if main-memory should be used instead of
2048** a temporary file for transient pager files and statement journals.
2049** The value returned depends on the value of db->temp_store (runtime
2050** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2051** following table describes the relationship between these two values
2052** and this functions return value.
2053**
2054** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2055** ----------------- -------------- ------------------------------
2056** 0 any file (return 0)
2057** 1 1 file (return 0)
2058** 1 2 memory (return 1)
2059** 1 0 file (return 0)
2060** 2 1 file (return 0)
2061** 2 2 memory (return 1)
2062** 2 0 memory (return 1)
2063** 3 any memory (return 1)
2064*/
drh1c514142009-04-30 12:25:10 +00002065int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002066#if SQLITE_TEMP_STORE==1
2067 return ( db->temp_store==2 );
2068#endif
2069#if SQLITE_TEMP_STORE==2
2070 return ( db->temp_store!=1 );
2071#endif
2072#if SQLITE_TEMP_STORE==3
2073 return 1;
shanecf697392009-06-01 16:53:09 +00002074#endif
2075#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00002076 return 0;
shane60a4b532009-05-06 18:57:09 +00002077#endif
danielk1977d8293352009-04-30 09:10:37 +00002078}
2079
2080/*
danielk19774ad17132004-05-21 01:47:26 +00002081** Return UTF-8 encoded English language explanation of the most recent
2082** error.
2083*/
danielk19776622cce2004-05-20 11:00:52 +00002084const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002085 const char *z;
drhf49661a2008-12-10 16:45:50 +00002086 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00002087 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00002088 }
drhd55d57e2008-07-07 17:53:07 +00002089 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002090 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002091 }
drh27641702007-08-22 02:56:42 +00002092 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002093 if( db->mallocFailed ){
2094 z = sqlite3ErrStr(SQLITE_NOMEM);
2095 }else{
drha3cc0072013-12-13 16:23:55 +00002096 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002097 z = (char*)sqlite3_value_text(db->pErr);
2098 assert( !db->mallocFailed );
2099 if( z==0 ){
2100 z = sqlite3ErrStr(db->errCode);
2101 }
danielk19776622cce2004-05-20 11:00:52 +00002102 }
drhe30f4422007-08-21 16:15:55 +00002103 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002104 return z;
danielk19776622cce2004-05-20 11:00:52 +00002105}
2106
drh6c626082004-11-14 21:56:29 +00002107#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002108/*
2109** Return UTF-16 encoded English language explanation of the most recent
2110** error.
2111*/
danielk19776622cce2004-05-20 11:00:52 +00002112const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002113 static const u16 outOfMem[] = {
2114 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002115 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002116 static const u16 misuse[] = {
2117 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2118 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2119 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2120 'o', 'u', 't', ' ',
2121 'o', 'f', ' ',
2122 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002123 };
danielk19774ad17132004-05-21 01:47:26 +00002124
drhc60d0442004-09-30 13:43:13 +00002125 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002126 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002127 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002128 }
drhd55d57e2008-07-07 17:53:07 +00002129 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002130 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002131 }
drhe30f4422007-08-21 16:15:55 +00002132 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002133 if( db->mallocFailed ){
2134 z = (void *)outOfMem;
2135 }else{
drhc60d0442004-09-30 13:43:13 +00002136 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002137 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002138 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002139 z = sqlite3_value_text16(db->pErr);
2140 }
2141 /* A malloc() may have failed within the call to sqlite3_value_text16()
2142 ** above. If this is the case, then the db->mallocFailed flag needs to
2143 ** be cleared before returning. Do this directly, instead of via
2144 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2145 */
2146 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00002147 }
drhe30f4422007-08-21 16:15:55 +00002148 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002149 return z;
danielk19776622cce2004-05-20 11:00:52 +00002150}
drh6c626082004-11-14 21:56:29 +00002151#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002152
drhc60d0442004-09-30 13:43:13 +00002153/*
danielk19777ddad962005-12-12 06:53:03 +00002154** Return the most recent error code generated by an SQLite routine. If NULL is
2155** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002156*/
danielk19776622cce2004-05-20 11:00:52 +00002157int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002158 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002159 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002160 }
drh01495b92008-01-23 12:52:40 +00002161 if( !db || db->mallocFailed ){
2162 return SQLITE_NOMEM;
2163 }
drh4ac285a2006-09-15 07:28:50 +00002164 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002165}
drh99dfe5e2008-10-30 15:03:15 +00002166int sqlite3_extended_errcode(sqlite3 *db){
2167 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002168 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002169 }
2170 if( !db || db->mallocFailed ){
2171 return SQLITE_NOMEM;
2172 }
2173 return db->errCode;
2174}
danielk19776622cce2004-05-20 11:00:52 +00002175
drh0e819f92006-02-01 13:50:41 +00002176/*
mistachkin5dac8432012-09-11 02:00:25 +00002177** Return a string that describes the kind of error specified in the
2178** argument. For now, this simply calls the internal sqlite3ErrStr()
2179** function.
2180*/
2181const char *sqlite3_errstr(int rc){
2182 return sqlite3ErrStr(rc);
2183}
2184
2185/*
drh0e819f92006-02-01 13:50:41 +00002186** Create a new collating function for database "db". The name is zName
2187** and the encoding is enc.
2188*/
danielk19779a30cf62006-01-18 04:26:07 +00002189static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002190 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002191 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002192 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002193 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002194 int(*xCompare)(void*,int,const void*,int,const void*),
2195 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002196){
2197 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002198 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002199
drhe30f4422007-08-21 16:15:55 +00002200 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002201
2202 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2203 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2204 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2205 */
drh51c7d862009-04-27 18:46:06 +00002206 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002207 testcase( enc2==SQLITE_UTF16 );
2208 testcase( enc2==SQLITE_UTF16_ALIGNED );
2209 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002210 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002211 }
drh51c7d862009-04-27 18:46:06 +00002212 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002213 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002214 }
2215
2216 /* Check if this call is removing or replacing an existing collation
2217 ** sequence. If so, and there are active VMs, return busy. If there
2218 ** are no active VMs, invalidate any pre-compiled statements.
2219 */
drhc4a64fa2009-05-11 20:53:28 +00002220 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002221 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002222 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002223 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002224 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002225 return SQLITE_BUSY;
2226 }
2227 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00002228
2229 /* If collation sequence pColl was created directly by a call to
2230 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2231 ** then any copies made by synthCollSeq() need to be invalidated.
2232 ** Also, collation destructor - CollSeq.xDel() - function may need
2233 ** to be called.
2234 */
2235 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002236 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002237 int j;
2238 for(j=0; j<3; j++){
2239 CollSeq *p = &aColl[j];
2240 if( p->enc==pColl->enc ){
2241 if( p->xDel ){
2242 p->xDel(p->pUser);
2243 }
2244 p->xCmp = 0;
2245 }
2246 }
2247 }
danielk19779a30cf62006-01-18 04:26:07 +00002248 }
2249
drhc4a64fa2009-05-11 20:53:28 +00002250 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002251 if( pColl==0 ) return SQLITE_NOMEM;
2252 pColl->xCmp = xCompare;
2253 pColl->pUser = pCtx;
2254 pColl->xDel = xDel;
2255 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002256 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002257 return SQLITE_OK;
2258}
2259
2260
danielk19776622cce2004-05-20 11:00:52 +00002261/*
drhbb4957f2008-03-20 14:03:29 +00002262** This array defines hard upper bounds on limit values. The
2263** initializer must be kept in sync with the SQLITE_LIMIT_*
2264** #defines in sqlite3.h.
2265*/
drhb1a6c3c2008-03-20 16:30:17 +00002266static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002267 SQLITE_MAX_LENGTH,
2268 SQLITE_MAX_SQL_LENGTH,
2269 SQLITE_MAX_COLUMN,
2270 SQLITE_MAX_EXPR_DEPTH,
2271 SQLITE_MAX_COMPOUND_SELECT,
2272 SQLITE_MAX_VDBE_OP,
2273 SQLITE_MAX_FUNCTION_ARG,
2274 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002275 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002276 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002277 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002278 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002279};
2280
2281/*
2282** Make sure the hard limits are set to reasonable values
2283*/
2284#if SQLITE_MAX_LENGTH<100
2285# error SQLITE_MAX_LENGTH must be at least 100
2286#endif
2287#if SQLITE_MAX_SQL_LENGTH<100
2288# error SQLITE_MAX_SQL_LENGTH must be at least 100
2289#endif
2290#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2291# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2292#endif
drhbb4957f2008-03-20 14:03:29 +00002293#if SQLITE_MAX_COMPOUND_SELECT<2
2294# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2295#endif
2296#if SQLITE_MAX_VDBE_OP<40
2297# error SQLITE_MAX_VDBE_OP must be at least 40
2298#endif
drhe82f5d02008-10-07 19:53:14 +00002299#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2300# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002301#endif
drhd08b2792014-07-22 15:33:31 +00002302#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2303# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002304#endif
drhbb4957f2008-03-20 14:03:29 +00002305#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2306# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2307#endif
drh70a8ca32008-08-21 18:49:27 +00002308#if SQLITE_MAX_COLUMN>32767
2309# error SQLITE_MAX_COLUMN must not exceed 32767
2310#endif
drh417168a2009-09-07 18:14:02 +00002311#if SQLITE_MAX_TRIGGER_DEPTH<1
2312# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2313#endif
drh111544c2014-08-29 16:20:47 +00002314#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2315# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2316#endif
drhbb4957f2008-03-20 14:03:29 +00002317
2318
2319/*
2320** Change the value of a limit. Report the old value.
2321** If an invalid limit index is supplied, report -1.
2322** Make no changes but still report the old value if the
2323** new limit is negative.
2324**
2325** A new lower limit does not shrink existing constructs.
2326** It merely prevents new constructs that exceed the limit
2327** from forming.
2328*/
2329int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2330 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002331
drh9ca95732014-10-24 00:35:58 +00002332#ifdef SQLITE_ENABLE_API_ARMOR
2333 if( !sqlite3SafetyCheckOk(db) ){
2334 (void)SQLITE_MISUSE_BKPT;
2335 return -1;
2336 }
2337#endif
drh4e93f5b2010-09-07 14:59:15 +00002338
2339 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2340 ** there is a hard upper bound set at compile-time by a C preprocessor
2341 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2342 ** "_MAX_".)
2343 */
2344 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2345 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2346 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2347 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2348 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2349 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2350 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2351 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2352 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2353 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2354 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2355 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002356 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2357 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002358
2359
drh521cc842008-04-15 02:36:33 +00002360 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002361 return -1;
2362 }
2363 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002364 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002365 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002366 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002367 }
2368 db->aLimit[limitId] = newLimit;
2369 }
drh4e93f5b2010-09-07 14:59:15 +00002370 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002371}
2372
2373/*
dan286ab7c2011-05-06 18:34:54 +00002374** This function is used to parse both URIs and non-URI filenames passed by the
2375** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2376** URIs specified as part of ATTACH statements.
2377**
2378** The first argument to this function is the name of the VFS to use (or
2379** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2380** query parameter. The second argument contains the URI (or non-URI filename)
2381** itself. When this function is called the *pFlags variable should contain
2382** the default flags to open the database handle with. The value stored in
2383** *pFlags may be updated before returning if the URI filename contains
2384** "cache=xxx" or "mode=xxx" query parameters.
2385**
2386** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2387** the VFS that should be used to open the database file. *pzFile is set to
2388** point to a buffer containing the name of the file to open. It is the
2389** responsibility of the caller to eventually call sqlite3_free() to release
2390** this buffer.
2391**
2392** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2393** may be set to point to a buffer containing an English language error
2394** message. It is the responsibility of the caller to eventually release
2395** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002396*/
2397int sqlite3ParseUri(
2398 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2399 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002400 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002401 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2402 char **pzFile, /* OUT: Filename component of URI */
2403 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2404){
dan78e9dd22011-05-03 10:22:32 +00002405 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002406 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002407 const char *zVfs = zDefaultVfs;
2408 char *zFile;
drhde941c32011-05-09 19:20:17 +00002409 char c;
dancd74b612011-04-22 19:37:32 +00002410 int nUri = sqlite3Strlen30(zUri);
2411
2412 assert( *pzErrMsg==0 );
2413
drh8790b6e2014-11-07 01:43:56 +00002414 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2415 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002416 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002417 ){
dan5de15372011-04-23 10:12:30 +00002418 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002419 int eState; /* Parser state when parsing URI */
2420 int iIn; /* Input character index */
2421 int iOut = 0; /* Output character index */
2422 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002423
dan286ab7c2011-05-06 18:34:54 +00002424 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2425 ** method that there may be extra parameters following the file-name. */
2426 flags |= SQLITE_OPEN_URI;
2427
2428 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002429 zFile = sqlite3_malloc(nByte);
2430 if( !zFile ) return SQLITE_NOMEM;
2431
drh869c0402013-08-07 23:15:52 +00002432 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002433#ifdef SQLITE_ALLOW_URI_AUTHORITY
2434 if( strncmp(zUri+5, "///", 3)==0 ){
2435 iIn = 7;
2436 /* The following condition causes URIs with five leading / characters
2437 ** like file://///host/path to be converted into UNCs like //host/path.
2438 ** The correct URI for that UNC has only two or four leading / characters
2439 ** file://host/path or file:////host/path. But 5 leading slashes is a
2440 ** common error, we are told, so we handle it as a special case. */
2441 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2442 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2443 iIn = 16;
2444 }
2445#else
dancd74b612011-04-22 19:37:32 +00002446 /* Discard the scheme and authority segments of the URI. */
2447 if( zUri[5]=='/' && zUri[6]=='/' ){
2448 iIn = 7;
2449 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002450 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2451 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2452 iIn-7, &zUri[7]);
2453 rc = SQLITE_ERROR;
2454 goto parse_uri_out;
2455 }
dancd74b612011-04-22 19:37:32 +00002456 }
drh869c0402013-08-07 23:15:52 +00002457#endif
dancd74b612011-04-22 19:37:32 +00002458
2459 /* Copy the filename and any query parameters into the zFile buffer.
2460 ** Decode %HH escape codes along the way.
2461 **
2462 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2463 ** on the parsing context. As follows:
2464 **
2465 ** 0: Parsing file-name.
2466 ** 1: Parsing name section of a name=value query parameter.
2467 ** 2: Parsing value section of a name=value query parameter.
2468 */
2469 eState = 0;
drhde941c32011-05-09 19:20:17 +00002470 while( (c = zUri[iIn])!=0 && c!='#' ){
2471 iIn++;
dancd74b612011-04-22 19:37:32 +00002472 if( c=='%'
2473 && sqlite3Isxdigit(zUri[iIn])
2474 && sqlite3Isxdigit(zUri[iIn+1])
2475 ){
dan6d49e252011-05-03 15:09:05 +00002476 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2477 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002478
dan6d49e252011-05-03 15:09:05 +00002479 assert( octet>=0 && octet<256 );
2480 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002481 /* This branch is taken when "%00" appears within the URI. In this
2482 ** case we ignore all text in the remainder of the path, name or
2483 ** value currently being parsed. So ignore the current character
2484 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002485 while( (c = zUri[iIn])!=0 && c!='#'
2486 && (eState!=0 || c!='?')
2487 && (eState!=1 || (c!='=' && c!='&'))
2488 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002489 ){
2490 iIn++;
2491 }
2492 continue;
dancd74b612011-04-22 19:37:32 +00002493 }
dan6d49e252011-05-03 15:09:05 +00002494 c = octet;
dan5de15372011-04-23 10:12:30 +00002495 }else if( eState==1 && (c=='&' || c=='=') ){
2496 if( zFile[iOut-1]==0 ){
2497 /* An empty option name. Ignore this option altogether. */
2498 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2499 continue;
2500 }
2501 if( c=='&' ){
2502 zFile[iOut++] = '\0';
2503 }else{
2504 eState = 2;
2505 }
dancd74b612011-04-22 19:37:32 +00002506 c = 0;
dan5de15372011-04-23 10:12:30 +00002507 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2508 c = 0;
dancd74b612011-04-22 19:37:32 +00002509 eState = 1;
dancd74b612011-04-22 19:37:32 +00002510 }
2511 zFile[iOut++] = c;
2512 }
2513 if( eState==1 ) zFile[iOut++] = '\0';
2514 zFile[iOut++] = '\0';
2515 zFile[iOut++] = '\0';
2516
2517 /* Check if there were any options specified that should be interpreted
2518 ** here. Options that are interpreted here include "vfs" and those that
2519 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002520 ** method. */
dan5de15372011-04-23 10:12:30 +00002521 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2522 while( zOpt[0] ){
2523 int nOpt = sqlite3Strlen30(zOpt);
2524 char *zVal = &zOpt[nOpt+1];
2525 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002526
dan286ab7c2011-05-06 18:34:54 +00002527 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002528 zVfs = zVal;
2529 }else{
2530 struct OpenMode {
2531 const char *z;
2532 int mode;
2533 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002534 char *zModeType = 0;
2535 int mask = 0;
2536 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002537
dan286ab7c2011-05-06 18:34:54 +00002538 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002539 static struct OpenMode aCacheMode[] = {
2540 { "shared", SQLITE_OPEN_SHAREDCACHE },
2541 { "private", SQLITE_OPEN_PRIVATECACHE },
2542 { 0, 0 }
2543 };
2544
2545 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2546 aMode = aCacheMode;
2547 limit = mask;
2548 zModeType = "cache";
2549 }
dan286ab7c2011-05-06 18:34:54 +00002550 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002551 static struct OpenMode aOpenMode[] = {
2552 { "ro", SQLITE_OPEN_READONLY },
2553 { "rw", SQLITE_OPEN_READWRITE },
2554 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002555 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002556 { 0, 0 }
2557 };
2558
drh9c67b2a2012-05-28 13:58:00 +00002559 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2560 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002561 aMode = aOpenMode;
2562 limit = mask & flags;
2563 zModeType = "access";
2564 }
2565
2566 if( aMode ){
2567 int i;
2568 int mode = 0;
2569 for(i=0; aMode[i].z; i++){
2570 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002571 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002572 mode = aMode[i].mode;
2573 break;
dancd74b612011-04-22 19:37:32 +00002574 }
2575 }
dan78e9dd22011-05-03 10:22:32 +00002576 if( mode==0 ){
2577 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2578 rc = SQLITE_ERROR;
2579 goto parse_uri_out;
2580 }
drh9c67b2a2012-05-28 13:58:00 +00002581 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002582 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2583 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002584 rc = SQLITE_PERM;
2585 goto parse_uri_out;
2586 }
2587 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002588 }
dancd74b612011-04-22 19:37:32 +00002589 }
dan5de15372011-04-23 10:12:30 +00002590
2591 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002592 }
2593
2594 }else{
2595 zFile = sqlite3_malloc(nUri+2);
2596 if( !zFile ) return SQLITE_NOMEM;
2597 memcpy(zFile, zUri, nUri);
2598 zFile[nUri] = '\0';
2599 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002600 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002601 }
2602
2603 *ppVfs = sqlite3_vfs_find(zVfs);
2604 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002605 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002606 rc = SQLITE_ERROR;
2607 }
2608 parse_uri_out:
2609 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002610 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002611 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002612 }
2613 *pFlags = flags;
2614 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002615 return rc;
dancd74b612011-04-22 19:37:32 +00002616}
2617
2618
2619/*
danielk19774ad17132004-05-21 01:47:26 +00002620** This routine does the work of opening a database on behalf of
2621** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002622** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002623*/
2624static int openDatabase(
2625 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002626 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002627 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002628 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002629){
dancd74b612011-04-22 19:37:32 +00002630 sqlite3 *db; /* Store allocated handle here */
2631 int rc; /* Return code */
2632 int isThreadsafe; /* True for threadsafe connections */
2633 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2634 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002635
drh9ca95732014-10-24 00:35:58 +00002636#ifdef SQLITE_ENABLE_API_ARMOR
2637 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2638#endif
drhe0d0f8e2009-04-28 04:47:31 +00002639 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002640#ifndef SQLITE_OMIT_AUTOINIT
2641 rc = sqlite3_initialize();
2642 if( rc ) return rc;
2643#endif
2644
dan78e9dd22011-05-03 10:22:32 +00002645 /* Only allow sensible combinations of bits in the flags argument.
2646 ** Throw an error if any non-sense combination is used. If we
2647 ** do not block illegal combinations here, it could trigger
2648 ** assert() statements in deeper layers. Sensible combinations
2649 ** are:
2650 **
2651 ** 1: SQLITE_OPEN_READONLY
2652 ** 2: SQLITE_OPEN_READWRITE
2653 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2654 */
2655 assert( SQLITE_OPEN_READONLY == 0x01 );
2656 assert( SQLITE_OPEN_READWRITE == 0x02 );
2657 assert( SQLITE_OPEN_CREATE == 0x04 );
2658 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2659 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2660 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002661 if( ((1<<(flags&7)) & 0x46)==0 ){
2662 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2663 }
dan78e9dd22011-05-03 10:22:32 +00002664
drh039963a2008-09-03 00:43:15 +00002665 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002666 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002667 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2668 isThreadsafe = 0;
2669 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2670 isThreadsafe = 1;
2671 }else{
2672 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002673 }
drhf1f12682009-09-09 14:17:52 +00002674 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002675 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002676 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2677 flags |= SQLITE_OPEN_SHAREDCACHE;
2678 }
danielk19779a6284c2008-07-10 17:52:49 +00002679
drhb25a9f42009-05-12 13:35:11 +00002680 /* Remove harmful bits from the flags parameter
2681 **
2682 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2683 ** dealt with in the previous code block. Besides these, the only
2684 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002685 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2686 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002687 ** off all other flags.
2688 */
drha4267dc2008-02-19 15:20:44 +00002689 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002690 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002691 SQLITE_OPEN_MAIN_DB |
2692 SQLITE_OPEN_TEMP_DB |
2693 SQLITE_OPEN_TRANSIENT_DB |
2694 SQLITE_OPEN_MAIN_JOURNAL |
2695 SQLITE_OPEN_TEMP_JOURNAL |
2696 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002697 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002698 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002699 SQLITE_OPEN_FULLMUTEX |
2700 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002701 );
2702
danielk19774ad17132004-05-21 01:47:26 +00002703 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002704 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002705 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002706 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002707 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2708 if( db->mutex==0 ){
2709 sqlite3_free(db);
2710 db = 0;
2711 goto opendb_out;
2712 }
drh605264d2007-08-21 15:13:19 +00002713 }
drh27641702007-08-22 02:56:42 +00002714 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002715 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002716 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002717 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002718 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002719
drhbb4957f2008-03-20 14:03:29 +00002720 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2721 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002722 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002723 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002724 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002725 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002726 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002727 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002728 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002729#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002730 | SQLITE_AutoIndex
2731#endif
drh883ad042015-02-19 00:29:11 +00002732#if SQLITE_DEFAULT_CKPTFULLFSYNC
2733 | SQLITE_CkptFullFSync
2734#endif
drh76fe8032006-07-11 14:17:51 +00002735#if SQLITE_DEFAULT_FILE_FORMAT<4
2736 | SQLITE_LegacyFileFmt
2737#endif
drh56424db2007-03-27 22:24:11 +00002738#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2739 | SQLITE_LoadExtension
2740#endif
dan5bde73c2009-09-01 17:11:07 +00002741#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002742 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002743#endif
drha4bfd7f2010-12-09 19:15:17 +00002744#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2745 | SQLITE_ForeignKeys
2746#endif
drhf5471922014-12-09 15:12:11 +00002747#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
2748 | SQLITE_ReverseOrder
2749#endif
drh76fe8032006-07-11 14:17:51 +00002750 ;
drhe61922a2009-05-02 13:29:37 +00002751 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002752#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002753 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002754#endif
danielk1977da184232006-01-05 11:34:32 +00002755
danielk19770202b292004-06-09 09:55:16 +00002756 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2757 ** and UTF-16, so add a version for each to avoid any unnecessary
2758 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00002759 **
2760 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
2761 ** functions:
danielk19770202b292004-06-09 09:55:16 +00002762 */
drh4dd65e02011-11-29 14:46:56 +00002763 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2764 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2765 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00002766 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00002767 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002768 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002769 goto opendb_out;
2770 }
drh5e3b49b2014-11-20 19:22:26 +00002771 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
2772 ** strings is BINARY.
2773 */
drhc4a64fa2009-05-11 20:53:28 +00002774 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002775 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002776
dancd74b612011-04-22 19:37:32 +00002777 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002778 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002779 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2780 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002781 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
drh13f40da2014-08-22 18:00:11 +00002782 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002783 sqlite3_free(zErrMsg);
2784 goto opendb_out;
2785 }
2786
danielk19774ad17132004-05-21 01:47:26 +00002787 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002788 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002789 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002790 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002791 if( rc==SQLITE_IOERR_NOMEM ){
2792 rc = SQLITE_NOMEM;
2793 }
drh13f40da2014-08-22 18:00:11 +00002794 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002795 goto opendb_out;
2796 }
dan0235a032014-12-08 20:20:16 +00002797 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002798 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00002799 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00002800 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002801 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002802
danielk197753c0f742005-03-29 03:10:59 +00002803 /* The default safety_level for the main database is 'full'; for the temp
2804 ** database it is 'NONE'. This matches the pager layer defaults.
2805 */
2806 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002807 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002808 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002809 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002810
danielk1977832a58a2007-06-22 15:21:15 +00002811 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002812 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002813 goto opendb_out;
2814 }
2815
danielk19778e227872004-06-07 07:52:17 +00002816 /* Register all built-in functions, but do not attempt to read the
2817 ** database schema yet. This is delayed until the first time the database
2818 ** is accessed.
2819 */
drh13f40da2014-08-22 18:00:11 +00002820 sqlite3Error(db, SQLITE_OK);
danielk1977832a58a2007-06-22 15:21:15 +00002821 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002822
drh1409be62006-08-23 20:07:20 +00002823 /* Load automatic extensions - extensions that have been registered
2824 ** using the sqlite3_automatic_extension() API.
2825 */
drh7aaa8782009-05-20 02:40:45 +00002826 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002827 if( rc==SQLITE_OK ){
2828 sqlite3AutoLoadExtensions(db);
2829 rc = sqlite3_errcode(db);
2830 if( rc!=SQLITE_OK ){
2831 goto opendb_out;
2832 }
danielk1977832a58a2007-06-22 15:21:15 +00002833 }
drh1409be62006-08-23 20:07:20 +00002834
drhaa29c132006-09-02 13:58:06 +00002835#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002836 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002837 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002838 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002839 }
2840#endif
2841
shessa26cf572006-10-19 20:27:58 +00002842#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002843 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002844 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002845 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002846 }
2847#endif
2848
shess69c4ae22007-08-20 17:37:47 +00002849#ifdef SQLITE_ENABLE_FTS3
2850 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002851 rc = sqlite3Fts3Init(db);
2852 }
2853#endif
2854
danielk197783852ac2007-05-06 16:04:11 +00002855#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002856 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002857 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002858 }
2859#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002860
2861#ifdef SQLITE_ENABLE_RTREE
2862 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002863 rc = sqlite3RtreeInit(db);
2864 }
2865#endif
2866
drh8fd5bd32007-04-02 16:40:37 +00002867 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2868 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2869 ** mode. Doing nothing at all also makes NORMAL the default.
2870 */
2871#ifdef SQLITE_DEFAULT_LOCKING_MODE
2872 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2873 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2874 SQLITE_DEFAULT_LOCKING_MODE);
2875#endif
2876
drh13f40da2014-08-22 18:00:11 +00002877 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00002878
drh633e6d52008-07-28 19:34:53 +00002879 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002880 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2881 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002882
dan5a299f92010-05-03 11:05:08 +00002883 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002884
danielk19774ad17132004-05-21 01:47:26 +00002885opendb_out:
dancd74b612011-04-22 19:37:32 +00002886 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002887 if( db ){
drh3ba689d2015-03-03 14:00:11 +00002888 assert( db->mutex!=0 || isThreadsafe==0
2889 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002890 sqlite3_mutex_leave(db->mutex);
2891 }
danielk197759633ae2008-08-27 19:01:57 +00002892 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002893 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002894 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002895 sqlite3_close(db);
2896 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002897 }else if( rc!=SQLITE_OK ){
2898 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002899 }
danielk19774ad17132004-05-21 01:47:26 +00002900 *ppDb = db;
danac455932012-11-26 19:50:41 +00002901#ifdef SQLITE_ENABLE_SQLLOG
2902 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002903 /* Opening a db handle. Fourth parameter is passed 0. */
2904 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2905 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002906 }
2907#endif
danielk197754f01982006-01-18 15:25:17 +00002908 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002909}
2910
2911/*
2912** Open a new database handle.
2913*/
danielk197780290862004-05-22 09:21:21 +00002914int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002915 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002916 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002917){
drh605264d2007-08-21 15:13:19 +00002918 return openDatabase(zFilename, ppDb,
2919 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2920}
2921int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002922 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002923 sqlite3 **ppDb, /* OUT: SQLite db handle */
2924 int flags, /* Flags */
2925 const char *zVfs /* Name of VFS module to use */
2926){
drh522c26f2011-05-07 14:40:29 +00002927 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002928}
2929
drh6c626082004-11-14 21:56:29 +00002930#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002931/*
2932** Open a new database handle.
2933*/
2934int sqlite3_open16(
2935 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002936 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002937){
danielk1977bfd6cce2004-06-18 04:24:54 +00002938 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002939 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002940 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002941
drh9ca95732014-10-24 00:35:58 +00002942#ifdef SQLITE_ENABLE_API_ARMOR
2943 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2944#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00002945 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002946#ifndef SQLITE_OMIT_AUTOINIT
2947 rc = sqlite3_initialize();
2948 if( rc ) return rc;
2949#endif
drh9ca95732014-10-24 00:35:58 +00002950 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00002951 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002952 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2953 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002954 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002955 rc = openDatabase(zFilename8, ppDb,
2956 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002957 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002958 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00002959 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002960 }
drh40257ff2008-06-13 18:24:27 +00002961 }else{
2962 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002963 }
danielk19777ddad962005-12-12 06:53:03 +00002964 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002965
danielk197754f01982006-01-18 15:25:17 +00002966 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002967}
drh6c626082004-11-14 21:56:29 +00002968#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002969
danielk1977106bb232004-05-21 10:08:53 +00002970/*
danielk1977d8123362004-06-12 09:25:12 +00002971** Register a new collation sequence with the database handle db.
2972*/
danielk19770202b292004-06-09 09:55:16 +00002973int sqlite3_create_collation(
2974 sqlite3* db,
2975 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002976 int enc,
danielk19770202b292004-06-09 09:55:16 +00002977 void* pCtx,
2978 int(*xCompare)(void*,int,const void*,int,const void*)
2979){
drh4f81bbb2014-10-23 01:01:26 +00002980 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002981}
2982
2983/*
2984** Register a new collation sequence with the database handle db.
2985*/
danielk1977a393c032007-05-07 14:58:53 +00002986int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002987 sqlite3* db,
2988 const char *zName,
2989 int enc,
2990 void* pCtx,
2991 int(*xCompare)(void*,int,const void*,int,const void*),
2992 void(*xDel)(void*)
2993){
2994 int rc;
drh9ca95732014-10-24 00:35:58 +00002995
2996#ifdef SQLITE_ENABLE_API_ARMOR
2997 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2998#endif
drhe30f4422007-08-21 16:15:55 +00002999 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003000 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003001 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003002 rc = sqlite3ApiExit(db, rc);
3003 sqlite3_mutex_leave(db->mutex);
3004 return rc;
danielk19770202b292004-06-09 09:55:16 +00003005}
3006
drh6c626082004-11-14 21:56:29 +00003007#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003008/*
3009** Register a new collation sequence with the database handle db.
3010*/
danielk19770202b292004-06-09 09:55:16 +00003011int sqlite3_create_collation16(
3012 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003013 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003014 int enc,
danielk19770202b292004-06-09 09:55:16 +00003015 void* pCtx,
3016 int(*xCompare)(void*,int,const void*,int,const void*)
3017){
danielk19779a30cf62006-01-18 04:26:07 +00003018 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003019 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003020
3021#ifdef SQLITE_ENABLE_API_ARMOR
3022 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3023#endif
drhe30f4422007-08-21 16:15:55 +00003024 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003025 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003026 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003027 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003028 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003029 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003030 }
drhe30f4422007-08-21 16:15:55 +00003031 rc = sqlite3ApiExit(db, rc);
3032 sqlite3_mutex_leave(db->mutex);
3033 return rc;
danielk19770202b292004-06-09 09:55:16 +00003034}
drh6c626082004-11-14 21:56:29 +00003035#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003036
danielk1977d8123362004-06-12 09:25:12 +00003037/*
3038** Register a collation sequence factory callback with the database handle
3039** db. Replace any previously installed collation sequence factory.
3040*/
danielk19777cedc8d2004-06-10 10:50:08 +00003041int sqlite3_collation_needed(
3042 sqlite3 *db,
3043 void *pCollNeededArg,
3044 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3045){
drh9ca95732014-10-24 00:35:58 +00003046#ifdef SQLITE_ENABLE_API_ARMOR
3047 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3048#endif
drhe30f4422007-08-21 16:15:55 +00003049 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003050 db->xCollNeeded = xCollNeeded;
3051 db->xCollNeeded16 = 0;
3052 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003053 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003054 return SQLITE_OK;
3055}
danielk1977d8123362004-06-12 09:25:12 +00003056
drh6c626082004-11-14 21:56:29 +00003057#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003058/*
3059** Register a collation sequence factory callback with the database handle
3060** db. Replace any previously installed collation sequence factory.
3061*/
danielk19777cedc8d2004-06-10 10:50:08 +00003062int sqlite3_collation_needed16(
3063 sqlite3 *db,
3064 void *pCollNeededArg,
3065 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3066){
drh9ca95732014-10-24 00:35:58 +00003067#ifdef SQLITE_ENABLE_API_ARMOR
3068 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3069#endif
drhe30f4422007-08-21 16:15:55 +00003070 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003071 db->xCollNeeded = 0;
3072 db->xCollNeeded16 = xCollNeeded16;
3073 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003074 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003075 return SQLITE_OK;
3076}
drh6c626082004-11-14 21:56:29 +00003077#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003078
shaneeec556d2008-10-12 00:27:53 +00003079#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003080/*
danielk19777ddad962005-12-12 06:53:03 +00003081** This function is now an anachronism. It used to be used to recover from a
3082** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003083*/
drh7d97efb2007-10-12 19:35:48 +00003084int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003085 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003086}
3087#endif
drh3e1d8e62005-05-26 16:23:34 +00003088
3089/*
3090** Test to see whether or not the database connection is in autocommit
3091** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3092** by default. Autocommit is disabled by a BEGIN statement and reenabled
3093** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003094*/
3095int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003096#ifdef SQLITE_ENABLE_API_ARMOR
3097 if( !sqlite3SafetyCheckOk(db) ){
3098 (void)SQLITE_MISUSE_BKPT;
3099 return 0;
3100 }
3101#endif
drh3e1d8e62005-05-26 16:23:34 +00003102 return db->autoCommit;
3103}
drh49285702005-09-17 15:20:26 +00003104
drh49285702005-09-17 15:20:26 +00003105/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003106** The following routines are substitutes for constants SQLITE_CORRUPT,
drh9978c972010-02-23 17:36:32 +00003107** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003108** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003109**
3110** 1. Serve as a convenient place to set a breakpoint in a debugger
3111** to detect when version error conditions occurs.
3112**
3113** 2. Invoke sqlite3_log() to provide the source code location where
3114** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003115*/
drh9978c972010-02-23 17:36:32 +00003116int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003117 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00003118 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00003119 "database corruption at line %d of [%.10s]",
3120 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00003121 return SQLITE_CORRUPT;
3122}
drh9978c972010-02-23 17:36:32 +00003123int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003124 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003125 sqlite3_log(SQLITE_MISUSE,
3126 "misuse at line %d of [%.10s]",
3127 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003128 return SQLITE_MISUSE;
3129}
3130int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003131 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003132 sqlite3_log(SQLITE_CANTOPEN,
3133 "cannot open file at line %d of [%.10s]",
3134 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003135 return SQLITE_CANTOPEN;
3136}
3137
drh7c1817e2006-01-10 13:58:48 +00003138
shaneeec556d2008-10-12 00:27:53 +00003139#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003140/*
3141** This is a convenience routine that makes sure that all thread-specific
3142** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003143**
3144** SQLite no longer uses thread-specific data so this routine is now a
3145** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003146*/
3147void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003148}
shaneeec556d2008-10-12 00:27:53 +00003149#endif
danielk1977deb802c2006-02-09 13:43:28 +00003150
3151/*
3152** Return meta information about a specific column of a database table.
3153** See comment in sqlite3.h (sqlite.h.in) for details.
3154*/
danielk1977deb802c2006-02-09 13:43:28 +00003155int sqlite3_table_column_metadata(
3156 sqlite3 *db, /* Connection handle */
3157 const char *zDbName, /* Database name or NULL */
3158 const char *zTableName, /* Table name */
3159 const char *zColumnName, /* Column name */
3160 char const **pzDataType, /* OUTPUT: Declared data type */
3161 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3162 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3163 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003164 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003165){
3166 int rc;
3167 char *zErrMsg = 0;
3168 Table *pTab = 0;
3169 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003170 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003171 char const *zDataType = 0;
3172 char const *zCollSeq = 0;
3173 int notnull = 0;
3174 int primarykey = 0;
3175 int autoinc = 0;
3176
drh96c707a2015-02-13 16:36:14 +00003177
3178#ifdef SQLITE_ENABLE_API_ARMOR
3179 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3180 return SQLITE_MISUSE_BKPT;
3181 }
3182#endif
3183
danielk1977deb802c2006-02-09 13:43:28 +00003184 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003185 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003186 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003187 rc = sqlite3Init(db, &zErrMsg);
3188 if( SQLITE_OK!=rc ){
3189 goto error_out;
3190 }
3191
3192 /* Locate the table in question */
3193 pTab = sqlite3FindTable(db, zTableName, zDbName);
3194 if( !pTab || pTab->pSelect ){
3195 pTab = 0;
3196 goto error_out;
3197 }
3198
3199 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003200 if( zColumnName==0 ){
3201 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003202 }else{
3203 for(iCol=0; iCol<pTab->nCol; iCol++){
3204 pCol = &pTab->aCol[iCol];
3205 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3206 break;
3207 }
3208 }
3209 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003210 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3211 iCol = pTab->iPKey;
3212 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3213 }else{
3214 pTab = 0;
3215 goto error_out;
3216 }
danielk1977deb802c2006-02-09 13:43:28 +00003217 }
3218 }
3219
3220 /* The following block stores the meta information that will be returned
3221 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3222 ** and autoinc. At this point there are two possibilities:
3223 **
3224 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3225 ** and there is no explicitly declared IPK column.
3226 **
3227 ** 2. The table is not a view and the column name identified an
3228 ** explicitly declared column. Copy meta information from *pCol.
3229 */
3230 if( pCol ){
3231 zDataType = pCol->zType;
3232 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003233 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003234 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003235 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003236 }else{
3237 zDataType = "INTEGER";
3238 primarykey = 1;
3239 }
3240 if( !zCollSeq ){
3241 zCollSeq = "BINARY";
3242 }
3243
3244error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003245 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003246
3247 /* Whether the function call succeeded or failed, set the output parameters
3248 ** to whatever their local counterparts contain. If an error did occur,
3249 ** this has the effect of zeroing all output parameters.
3250 */
3251 if( pzDataType ) *pzDataType = zDataType;
3252 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3253 if( pNotNull ) *pNotNull = notnull;
3254 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3255 if( pAutoinc ) *pAutoinc = autoinc;
3256
3257 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003258 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003259 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003260 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003261 rc = SQLITE_ERROR;
3262 }
drh13f40da2014-08-22 18:00:11 +00003263 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003264 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003265 rc = sqlite3ApiExit(db, rc);
3266 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003267 return rc;
3268}
3269
3270/*
3271** Sleep for a little while. Return the amount of time slept.
3272*/
3273int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003274 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003275 int rc;
drhd677b3d2007-08-20 22:48:41 +00003276 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003277 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003278
3279 /* This function works in milliseconds, but the underlying OsSleep()
3280 ** API uses microseconds. Hence the 1000's.
3281 */
drhe30f4422007-08-21 16:15:55 +00003282 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003283 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003284}
drh4ac285a2006-09-15 07:28:50 +00003285
3286/*
3287** Enable or disable the extended result codes.
3288*/
3289int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003290#ifdef SQLITE_ENABLE_API_ARMOR
3291 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3292#endif
drhe30f4422007-08-21 16:15:55 +00003293 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003294 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003295 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003296 return SQLITE_OK;
3297}
drhcc6bb3e2007-08-31 16:11:35 +00003298
3299/*
3300** Invoke the xFileControl method on a particular database.
3301*/
3302int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3303 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003304 Btree *pBtree;
3305
drh9ca95732014-10-24 00:35:58 +00003306#ifdef SQLITE_ENABLE_API_ARMOR
3307 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3308#endif
drhcc6bb3e2007-08-31 16:11:35 +00003309 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003310 pBtree = sqlite3DbNameToBtree(db, zDbName);
3311 if( pBtree ){
3312 Pager *pPager;
3313 sqlite3_file *fd;
3314 sqlite3BtreeEnter(pBtree);
3315 pPager = sqlite3BtreePager(pBtree);
3316 assert( pPager!=0 );
3317 fd = sqlite3PagerFile(pPager);
3318 assert( fd!=0 );
3319 if( op==SQLITE_FCNTL_FILE_POINTER ){
3320 *(sqlite3_file**)pArg = fd;
3321 rc = SQLITE_OK;
3322 }else if( fd->pMethods ){
3323 rc = sqlite3OsFileControl(fd, op, pArg);
3324 }else{
3325 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003326 }
drh421377e2012-03-15 21:28:54 +00003327 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003328 }
3329 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003330 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003331}
drhed13d982008-01-31 14:43:24 +00003332
3333/*
3334** Interface to the testing logic.
3335*/
3336int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003337 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003338#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003339 va_list ap;
drhed13d982008-01-31 14:43:24 +00003340 va_start(ap, op);
3341 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003342
3343 /*
drh984bfaa2008-03-19 16:08:53 +00003344 ** Save the current state of the PRNG.
3345 */
drh2fa18682008-03-19 14:15:34 +00003346 case SQLITE_TESTCTRL_PRNG_SAVE: {
3347 sqlite3PrngSaveState();
3348 break;
3349 }
drh984bfaa2008-03-19 16:08:53 +00003350
3351 /*
3352 ** Restore the state of the PRNG to the last state saved using
3353 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3354 ** this verb acts like PRNG_RESET.
3355 */
drh2fa18682008-03-19 14:15:34 +00003356 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3357 sqlite3PrngRestoreState();
3358 break;
3359 }
drh984bfaa2008-03-19 16:08:53 +00003360
3361 /*
3362 ** Reset the PRNG back to its uninitialized state. The next call
3363 ** to sqlite3_randomness() will reseed the PRNG using a single call
3364 ** to the xRandomness method of the default VFS.
3365 */
drh2fa18682008-03-19 14:15:34 +00003366 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003367 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003368 break;
3369 }
drh3088d592008-03-21 16:45:47 +00003370
3371 /*
3372 ** sqlite3_test_control(BITVEC_TEST, size, program)
3373 **
3374 ** Run a test against a Bitvec object of size. The program argument
3375 ** is an array of integers that defines the test. Return -1 on a
3376 ** memory allocation error, 0 on success, or non-zero for an error.
3377 ** See the sqlite3BitvecBuiltinTest() for additional information.
3378 */
3379 case SQLITE_TESTCTRL_BITVEC_TEST: {
3380 int sz = va_arg(ap, int);
3381 int *aProg = va_arg(ap, int*);
3382 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3383 break;
3384 }
danielk19772d1d86f2008-06-20 14:59:51 +00003385
3386 /*
drhc007f612014-05-16 14:17:01 +00003387 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3388 **
3389 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3390 ** if xCallback is not NULL.
3391 **
3392 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3393 ** is called immediately after installing the new callback and the return
3394 ** value from sqlite3FaultSim(0) becomes the return from
3395 ** sqlite3_test_control().
3396 */
3397 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003398 /* MSVC is picky about pulling func ptrs from va lists.
3399 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003400 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003401 */
3402 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003403 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003404 rc = sqlite3FaultSim(0);
3405 break;
3406 }
3407
3408 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003409 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3410 **
3411 ** Register hooks to call to indicate which malloc() failures
3412 ** are benign.
3413 */
3414 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003415 typedef void (*void_function)(void);
3416 void_function xBenignBegin;
3417 void_function xBenignEnd;
3418 xBenignBegin = va_arg(ap, void_function);
3419 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003420 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3421 break;
3422 }
drhc7a3bb92009-02-05 16:31:45 +00003423
3424 /*
drhf3af63f2009-05-09 18:59:42 +00003425 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003426 **
3427 ** Set the PENDING byte to the value in the argument, if X>0.
3428 ** Make no changes if X==0. Return the value of the pending byte
3429 ** as it existing before this routine was called.
3430 **
3431 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3432 ** an incompatible database file format. Changing the PENDING byte
3433 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003434 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003435 */
3436 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003437 rc = PENDING_BYTE;
3438#ifndef SQLITE_OMIT_WSD
3439 {
3440 unsigned int newVal = va_arg(ap, unsigned int);
3441 if( newVal ) sqlite3PendingByte = newVal;
3442 }
3443#endif
drhc7a3bb92009-02-05 16:31:45 +00003444 break;
3445 }
drhf3af63f2009-05-09 18:59:42 +00003446
3447 /*
3448 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3449 **
3450 ** This action provides a run-time test to see whether or not
3451 ** assert() was enabled at compile-time. If X is true and assert()
3452 ** is enabled, then the return value is true. If X is true and
3453 ** assert() is disabled, then the return value is zero. If X is
3454 ** false and assert() is enabled, then the assertion fires and the
3455 ** process aborts. If X is false and assert() is disabled, then the
3456 ** return value is zero.
3457 */
3458 case SQLITE_TESTCTRL_ASSERT: {
3459 volatile int x = 0;
3460 assert( (x = va_arg(ap,int))!=0 );
3461 rc = x;
3462 break;
3463 }
3464
3465
3466 /*
3467 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3468 **
3469 ** This action provides a run-time test to see how the ALWAYS and
3470 ** NEVER macros were defined at compile-time.
3471 **
3472 ** The return value is ALWAYS(X).
3473 **
3474 ** The recommended test is X==2. If the return value is 2, that means
3475 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3476 ** default setting. If the return value is 1, then ALWAYS() is either
3477 ** hard-coded to true or else it asserts if its argument is false.
3478 ** The first behavior (hard-coded to true) is the case if
3479 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3480 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3481 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3482 **
3483 ** The run-time test procedure might look something like this:
3484 **
3485 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3486 ** // ALWAYS() and NEVER() are no-op pass-through macros
3487 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3488 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3489 ** }else{
3490 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3491 ** }
3492 */
3493 case SQLITE_TESTCTRL_ALWAYS: {
3494 int x = va_arg(ap,int);
3495 rc = ALWAYS(x);
3496 break;
3497 }
drhc046e3e2009-07-15 11:26:44 +00003498
drh2cf4acb2014-04-18 00:06:02 +00003499 /*
3500 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3501 **
3502 ** The integer returned reveals the byte-order of the computer on which
3503 ** SQLite is running:
3504 **
3505 ** 1 big-endian, determined at run-time
3506 ** 10 little-endian, determined at run-time
3507 ** 432101 big-endian, determined at compile-time
3508 ** 123410 little-endian, determined at compile-time
3509 */
3510 case SQLITE_TESTCTRL_BYTEORDER: {
3511 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3512 break;
3513 }
3514
drhc046e3e2009-07-15 11:26:44 +00003515 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3516 **
3517 ** Set the nReserve size to N for the main database on the database
3518 ** connection db.
3519 */
3520 case SQLITE_TESTCTRL_RESERVE: {
3521 sqlite3 *db = va_arg(ap, sqlite3*);
3522 int x = va_arg(ap,int);
3523 sqlite3_mutex_enter(db->mutex);
3524 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3525 sqlite3_mutex_leave(db->mutex);
3526 break;
3527 }
3528
drh07096f62009-12-22 23:52:32 +00003529 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3530 **
3531 ** Enable or disable various optimizations for testing purposes. The
3532 ** argument N is a bitmask of optimizations to be disabled. For normal
3533 ** operation N should be 0. The idea is that a test program (like the
3534 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3535 ** with various optimizations disabled to verify that the same answer
3536 ** is obtained in every case.
3537 */
3538 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3539 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003540 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003541 break;
3542 }
3543
drh0e857732010-01-02 03:21:35 +00003544#ifdef SQLITE_N_KEYWORD
3545 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3546 **
3547 ** If zWord is a keyword recognized by the parser, then return the
3548 ** number of keywords. Or if zWord is not a keyword, return 0.
3549 **
3550 ** This test feature is only available in the amalgamation since
3551 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3552 ** is built using separate source files.
3553 */
3554 case SQLITE_TESTCTRL_ISKEYWORD: {
3555 const char *zWord = va_arg(ap, const char*);
3556 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003557 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003558 break;
3559 }
3560#endif
3561
drhbadc9802010-08-27 17:16:44 +00003562 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3563 **
3564 ** Pass pFree into sqlite3ScratchFree().
3565 ** If sz>0 then allocate a scratch buffer into pNew.
3566 */
3567 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3568 void *pFree, **ppNew;
3569 int sz;
3570 sz = va_arg(ap, int);
3571 ppNew = va_arg(ap, void**);
3572 pFree = va_arg(ap, void*);
3573 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3574 sqlite3ScratchFree(pFree);
3575 break;
3576 }
3577
danc17d6962011-06-21 12:47:30 +00003578 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3579 **
3580 ** If parameter onoff is non-zero, configure the wrappers so that all
3581 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3582 ** undo this setting.
3583 */
3584 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3585 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3586 break;
3587 }
3588
drh09fe6142013-11-29 15:06:27 +00003589 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3590 **
3591 ** Set or clear a flag that indicates that the database file is always well-
3592 ** formed and never corrupt. This flag is clear by default, indicating that
3593 ** database files might have arbitrary corruption. Setting the flag during
3594 ** testing causes certain assert() statements in the code to be activated
3595 ** that demonstrat invariants on well-formed database files.
3596 */
3597 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003598 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003599 break;
3600 }
3601
drh688852a2014-02-17 22:40:43 +00003602
3603 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3604 **
3605 ** Set the VDBE coverage callback function to xCallback with context
3606 ** pointer ptr.
3607 */
3608 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3609#ifdef SQLITE_VDBE_COVERAGE
3610 typedef void (*branch_callback)(void*,int,u8,u8);
3611 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3612 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3613#endif
3614 break;
3615 }
3616
dan8930c2a2014-04-03 16:25:29 +00003617 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3618 case SQLITE_TESTCTRL_SORTER_MMAP: {
3619 sqlite3 *db = va_arg(ap, sqlite3*);
3620 db->nMaxSorterMmap = va_arg(ap, int);
3621 break;
3622 }
3623
drh43cfc232014-07-29 14:09:21 +00003624 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3625 **
3626 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3627 ** not.
3628 */
3629 case SQLITE_TESTCTRL_ISINIT: {
3630 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3631 break;
3632 }
drh8964b342015-01-29 17:54:52 +00003633
drh3ba689d2015-03-03 14:00:11 +00003634 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00003635 **
drh1ffede82015-01-30 20:59:27 +00003636 ** This test control is used to create imposter tables. "db" is a pointer
3637 ** to the database connection. dbName is the database name (ex: "main" or
3638 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
3639 ** or off. "tnum" is the root page of the b-tree to which the imposter
3640 ** table should connect.
3641 **
3642 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00003643 ** run a single CREATE TABLE statement to construct the imposter table in
3644 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00003645 **
3646 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
3647 ** the schema to be reparsed the next time it is needed. This has the
3648 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00003649 */
drh1ffede82015-01-30 20:59:27 +00003650 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00003651 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00003652 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00003653 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
3654 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00003655 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00003656 if( db->init.busy==0 && db->init.newTnum>0 ){
3657 sqlite3ResetAllSchemasOfConnection(db);
3658 }
drh8fb15e32015-02-04 20:56:49 +00003659 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00003660 break;
3661 }
drhed13d982008-01-31 14:43:24 +00003662 }
3663 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003664#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003665 return rc;
drhed13d982008-01-31 14:43:24 +00003666}
drhcc487d12011-05-17 18:53:08 +00003667
3668/*
3669** This is a utility routine, useful to VFS implementations, that checks
3670** to see if a database file was a URI that contained a specific query
3671** parameter, and if so obtains the value of the query parameter.
3672**
3673** The zFilename argument is the filename pointer passed into the xOpen()
3674** method of a VFS implementation. The zParam argument is the name of the
3675** query parameter we seek. This routine returns the value of the zParam
3676** parameter if it exists. If the parameter does not exist, this routine
3677** returns a NULL pointer.
3678*/
3679const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003680 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003681 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003682 while( zFilename[0] ){
3683 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003684 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003685 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003686 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003687 }
3688 return 0;
3689}
drh283829c2011-11-17 00:56:20 +00003690
3691/*
drh92913722011-12-23 00:07:33 +00003692** Return a boolean value for a query parameter.
3693*/
3694int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3695 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003696 bDflt = bDflt!=0;
3697 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003698}
3699
3700/*
3701** Return a 64-bit integer value for a query parameter.
3702*/
3703sqlite3_int64 sqlite3_uri_int64(
3704 const char *zFilename, /* Filename as passed to xOpen */
3705 const char *zParam, /* URI parameter sought */
3706 sqlite3_int64 bDflt /* return if parameter is missing */
3707){
3708 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3709 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003710 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003711 bDflt = v;
3712 }
3713 return bDflt;
3714}
3715
3716/*
drh421377e2012-03-15 21:28:54 +00003717** Return the Btree pointer identified by zDbName. Return NULL if not found.
3718*/
3719Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3720 int i;
3721 for(i=0; i<db->nDb; i++){
3722 if( db->aDb[i].pBt
3723 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3724 ){
3725 return db->aDb[i].pBt;
3726 }
3727 }
3728 return 0;
3729}
3730
3731/*
drh283829c2011-11-17 00:56:20 +00003732** Return the filename of the database associated with a database
3733** connection.
3734*/
3735const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003736 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003737#ifdef SQLITE_ENABLE_API_ARMOR
3738 if( !sqlite3SafetyCheckOk(db) ){
3739 (void)SQLITE_MISUSE_BKPT;
3740 return 0;
3741 }
3742#endif
mistachkincd54bab2014-12-20 21:14:14 +00003743 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00003744 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3745}
3746
3747/*
3748** Return 1 if database is read-only or 0 if read/write. Return -1 if
3749** no such database exists.
3750*/
3751int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003752 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003753#ifdef SQLITE_ENABLE_API_ARMOR
3754 if( !sqlite3SafetyCheckOk(db) ){
3755 (void)SQLITE_MISUSE_BKPT;
3756 return -1;
3757 }
3758#endif
mistachkincd54bab2014-12-20 21:14:14 +00003759 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003760 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003761}