blob: 27a0fe58d827a78dd3b8cf0fc31988da07062af2 [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
mistachkin34cf2582015-04-02 17:46:52 +000058/*
59** When compiling the test fixture or with debugging enabled (on Win32),
60** this variable being set to non-zero will cause OSTRACE macros to emit
61** extra diagnostic information.
62*/
mistachkinfb383e92015-04-16 03:24:38 +000063#ifdef SQLITE_HAVE_OS_TRACE
mistachkin34cf2582015-04-02 17:46:52 +000064# ifndef SQLITE_DEBUG_OS_TRACE
65# define SQLITE_DEBUG_OS_TRACE 0
66# endif
67 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
68#endif
69
drhe265b082008-05-01 17:03:49 +000070#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000071/*
drhb0603412007-02-28 04:47:26 +000072** If the following function pointer is not NULL and if
73** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
74** I/O active are written using this function. These messages
75** are intended for debugging activity only.
76*/
mistachkin9871a932015-03-27 00:21:52 +000077SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000078#endif
drhb0603412007-02-28 04:47:26 +000079
80/*
drha16313e2007-03-30 11:29:32 +000081** If the following global variable points to a string which is the
82** name of a directory, then that directory will be used to store
83** temporary files.
84**
85** See also the "PRAGMA temp_store_directory" SQL command.
86*/
87char *sqlite3_temp_directory = 0;
88
drhc5499be2008-04-01 15:06:33 +000089/*
mistachkina112d142012-03-14 00:44:01 +000090** If the following global variable points to a string which is the
91** name of a directory, then that directory will be used to store
92** all database files specified with a relative pathname.
93**
94** See also the "PRAGMA data_store_directory" SQL command.
95*/
96char *sqlite3_data_directory = 0;
97
98/*
drh40257ff2008-06-13 18:24:27 +000099** Initialize SQLite.
100**
101** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000102** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000103** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
104** this routine will be called automatically by key routines such as
105** sqlite3_open().
106**
107** This routine is a no-op except on its very first call for the process,
108** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000109**
110** The first thread to call this routine runs the initialization to
111** completion. If subsequent threads call this routine before the first
112** thread has finished the initialization process, then the subsequent
113** threads must block until the first thread finishes with the initialization.
114**
115** The first thread might call this routine recursively. Recursive
116** calls to this routine should not block, of course. Otherwise the
117** initialization process would never complete.
118**
119** Let X be the first thread to enter this routine. Let Y be some other
120** thread. Then while the initial invocation of this routine by X is
121** incomplete, it is required that:
122**
123** * Calls to this routine from Y must block until the outer-most
124** call by X completes.
125**
126** * Recursive calls to this routine from thread X return immediately
127** without blocking.
drh40257ff2008-06-13 18:24:27 +0000128*/
129int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000130 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000131 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000132#ifdef SQLITE_EXTRA_INIT
133 int bRunExtraInit = 0; /* Extra initialization needed */
134#endif
danielk1977075c23a2008-09-01 18:34:20 +0000135
136#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000137 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000138 if( rc!=SQLITE_OK ){
139 return rc;
140 }
141#endif
danielk197771bc31c2008-06-26 08:29:34 +0000142
drh2b4905c2015-03-23 18:52:56 +0000143 /* If the following assert() fails on some obscure processor/compiler
144 ** combination, the work-around is to set the correct pointer
145 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
146 assert( SQLITE_PTRSIZE==sizeof(char*) );
147
drh93ed56d2008-08-12 15:21:11 +0000148 /* If SQLite is already completely initialized, then this call
149 ** to sqlite3_initialize() should be a no-op. But the initialization
150 ** must be complete. So isInit must not be set until the very end
151 ** of this routine.
152 */
danielk1977075c23a2008-09-01 18:34:20 +0000153 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000154
drh93ed56d2008-08-12 15:21:11 +0000155 /* Make sure the mutex subsystem is initialized. If unable to
156 ** initialize the mutex subsystem, return early with the error.
157 ** If the system is so sick that we are unable to allocate a mutex,
158 ** there is not much SQLite is going to be able to do.
159 **
160 ** The mutex subsystem must take care of serializing its own
161 ** initialization.
162 */
danielk1977d0251742008-06-18 18:57:42 +0000163 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000164 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000165
drh93ed56d2008-08-12 15:21:11 +0000166 /* Initialize the malloc() system and the recursive pInitMutex mutex.
167 ** This operation is protected by the STATIC_MASTER mutex. Note that
168 ** MutexAlloc() is called for a static mutex prior to initializing the
169 ** malloc subsystem - this implies that the allocation of a static
170 ** mutex must not require support from the malloc subsystem.
171 */
drh30ddce62011-10-15 00:16:30 +0000172 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000173 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000174 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000175 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000176 rc = sqlite3MallocInit();
177 }
drh40257ff2008-06-13 18:24:27 +0000178 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000179 sqlite3GlobalConfig.isMallocInit = 1;
180 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000181 sqlite3GlobalConfig.pInitMutex =
182 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000183 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000184 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000185 }
186 }
danielk197777eb5bb2008-09-22 17:22:19 +0000187 }
188 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000189 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000190 }
191 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000192
dane1ab2192009-08-17 15:16:19 +0000193 /* If rc is not SQLITE_OK at this point, then either the malloc
194 ** subsystem could not be initialized or the system failed to allocate
195 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000196 if( rc!=SQLITE_OK ){
197 return rc;
198 }
199
200 /* Do the rest of the initialization under the recursive mutex so
201 ** that we will be able to handle recursive calls into
202 ** sqlite3_initialize(). The recursive calls normally come through
203 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
204 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000205 **
206 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
207 ** to the xInit method, so the xInit method need not be threadsafe.
208 **
209 ** The following mutex is what serializes access to the appdef pcache xInit
210 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
211 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000212 */
danielk1977075c23a2008-09-01 18:34:20 +0000213 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000214 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000215 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000216 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000217 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000218 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000219 if( sqlite3GlobalConfig.isPCacheInit==0 ){
220 rc = sqlite3PcacheInitialize();
221 }
danielk19778c0a7912008-08-20 14:49:23 +0000222 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000223 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000224 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000225 }
226 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000227 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
228 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000229 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000230#ifdef SQLITE_EXTRA_INIT
231 bRunExtraInit = 1;
232#endif
danielk19778c0a7912008-08-20 14:49:23 +0000233 }
danielk1977502b4e02008-09-02 14:07:24 +0000234 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000235 }
danielk1977075c23a2008-09-01 18:34:20 +0000236 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000237
drh93ed56d2008-08-12 15:21:11 +0000238 /* Go back under the static mutex and clean up the recursive
239 ** mutex to prevent a resource leak.
240 */
241 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000242 sqlite3GlobalConfig.nRefInitMutex--;
243 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
244 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
245 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
246 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000247 }
248 sqlite3_mutex_leave(pMaster);
249
250 /* The following is just a sanity check to make sure SQLite has
251 ** been compiled correctly. It is important to run this code, but
252 ** we don't want to run it too often and soak up CPU cycles for no
253 ** reason. So we run it once during initialization.
254 */
shanedfb7b372008-07-22 05:13:30 +0000255#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000256#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000257 /* This section of code's only "output" is via assert() statements. */
258 if ( rc==SQLITE_OK ){
259 u64 x = (((u64)1)<<63)-1;
260 double y;
261 assert(sizeof(x)==8);
262 assert(sizeof(x)==sizeof(y));
263 memcpy(&y, &x, 8);
264 assert( sqlite3IsNaN(y) );
265 }
266#endif
shanefbd60f82009-02-04 03:59:25 +0000267#endif
shanedfb7b372008-07-22 05:13:30 +0000268
drhe4cf0b32011-08-25 00:14:41 +0000269 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
270 ** compile-time option.
271 */
272#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000273 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000274 int SQLITE_EXTRA_INIT(const char*);
275 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000276 }
277#endif
278
drh40257ff2008-06-13 18:24:27 +0000279 return rc;
280}
281
282/*
283** Undo the effects of sqlite3_initialize(). Must not be called while
284** there are outstanding database connections or memory allocations or
285** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000286** routine is not threadsafe. But it is safe to invoke this routine
287** on when SQLite is already shut down. If SQLite is already shut down
288** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000289*/
290int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000291#ifdef SQLITE_OMIT_WSD
292 int rc = sqlite3_wsd_init(4096, 24);
293 if( rc!=SQLITE_OK ){
294 return rc;
295 }
296#endif
297
danielk1977075c23a2008-09-01 18:34:20 +0000298 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000299#ifdef SQLITE_EXTRA_SHUTDOWN
300 void SQLITE_EXTRA_SHUTDOWN(void);
301 SQLITE_EXTRA_SHUTDOWN();
302#endif
drha7640922009-04-21 12:02:56 +0000303 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000304 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000305 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000306 }
dane1ab2192009-08-17 15:16:19 +0000307 if( sqlite3GlobalConfig.isPCacheInit ){
308 sqlite3PcacheShutdown();
309 sqlite3GlobalConfig.isPCacheInit = 0;
310 }
311 if( sqlite3GlobalConfig.isMallocInit ){
312 sqlite3MallocEnd();
313 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000314
315#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
316 /* The heap subsystem has now been shutdown and these values are supposed
317 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
318 ** which would rely on that heap subsystem; therefore, make sure these
319 ** values cannot refer to heap memory that was just invalidated when the
320 ** heap subsystem was shutdown. This is only done if the current call to
321 ** this function resulted in the heap subsystem actually being shutdown.
322 */
323 sqlite3_data_directory = 0;
324 sqlite3_temp_directory = 0;
325#endif
dane1ab2192009-08-17 15:16:19 +0000326 }
327 if( sqlite3GlobalConfig.isMutexInit ){
328 sqlite3MutexEnd();
329 sqlite3GlobalConfig.isMutexInit = 0;
330 }
331
drh40257ff2008-06-13 18:24:27 +0000332 return SQLITE_OK;
333}
334
335/*
336** This API allows applications to modify the global configuration of
337** the SQLite library at run-time.
338**
339** This routine should only be called when there are no outstanding
340** database connections or memory allocations. This routine is not
341** threadsafe. Failure to heed these warnings can lead to unpredictable
342** behavior.
343*/
344int sqlite3_config(int op, ...){
345 va_list ap;
346 int rc = SQLITE_OK;
347
348 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
349 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000350 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000351
352 va_start(ap, op);
353 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000354
355 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000356 ** compile.
drh18472fa2008-10-07 15:25:48 +0000357 */
drhd1dcb232014-11-01 18:32:18 +0000358#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000359 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000360 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
361 ** Single-thread. */
362 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
363 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000364 break;
365 }
drhd1dcb232014-11-01 18:32:18 +0000366#endif
367#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000368 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000369 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
370 ** Multi-thread. */
371 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
372 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000373 break;
374 }
drhd1dcb232014-11-01 18:32:18 +0000375#endif
376#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000377 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000378 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
379 ** Serialized. */
380 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
381 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000382 break;
383 }
drhd1dcb232014-11-01 18:32:18 +0000384#endif
385#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000386 case SQLITE_CONFIG_MUTEX: {
387 /* Specify an alternative mutex implementation */
388 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
389 break;
390 }
drhd1dcb232014-11-01 18:32:18 +0000391#endif
392#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000393 case SQLITE_CONFIG_GETMUTEX: {
394 /* Retrieve the current mutex implementation */
395 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
396 break;
397 }
398#endif
399
drh40257ff2008-06-13 18:24:27 +0000400 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000401 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
402 ** single argument which is a pointer to an instance of the
403 ** sqlite3_mem_methods structure. The argument specifies alternative
404 ** low-level memory allocation routines to be used in place of the memory
405 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000406 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000407 break;
408 }
drh33589792008-06-18 13:27:46 +0000409 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000410 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
411 ** single argument which is a pointer to an instance of the
412 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
413 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000414 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
415 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000416 break;
417 }
drhfec00ea2008-06-14 16:56:21 +0000418 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000419 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
420 ** single argument of type int, interpreted as a boolean, which enables
421 ** or disables the collection of memory allocation statistics. */
422 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000423 break;
424 }
drh33589792008-06-18 13:27:46 +0000425 case SQLITE_CONFIG_SCRATCH: {
drh5279d342014-11-04 13:41:32 +0000426 /* EVIDENCE-OF: R-08404-60887 There are three arguments to
427 ** SQLITE_CONFIG_SCRATCH: A pointer an 8-byte aligned memory buffer from
428 ** which the scratch allocations will be drawn, the size of each scratch
429 ** allocation (sz), and the maximum number of scratch allocations (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000430 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
431 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
432 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000433 break;
434 }
435 case SQLITE_CONFIG_PAGECACHE: {
drh5279d342014-11-04 13:41:32 +0000436 /* EVIDENCE-OF: R-31408-40510 There are three arguments to
437 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory, the size
438 ** of each page buffer (sz), and the number of pages (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000439 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
440 sqlite3GlobalConfig.szPage = va_arg(ap, int);
441 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000442 break;
443 }
drhdef68892014-11-04 12:11:23 +0000444 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000445 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
446 ** a single parameter which is a pointer to an integer and writes into
447 ** that integer the number of extra bytes per page required for each page
448 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000449 *va_arg(ap, int*) =
450 sqlite3HeaderSizeBtree() +
451 sqlite3HeaderSizePcache() +
452 sqlite3HeaderSizePcache1();
453 break;
454 }
danielk19775099be52008-06-27 13:27:03 +0000455
danielk1977bc2ca9e2008-11-13 14:28:28 +0000456 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000457 /* no-op */
458 break;
459 }
460 case SQLITE_CONFIG_GETPCACHE: {
461 /* now an error */
462 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000463 break;
464 }
465
dan22e21ff2011-11-08 20:08:44 +0000466 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000467 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
468 ** single argument which is a pointer to an sqlite3_pcache_methods2
469 ** object. This object specifies the interface to a custom page cache
470 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000471 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
472 break;
473 }
474 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000475 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
476 ** single argument which is a pointer to an sqlite3_pcache_methods2
477 ** object. SQLite copies of the current page cache implementation into
478 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000479 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000480 sqlite3PCacheSetDefault();
481 }
dan22e21ff2011-11-08 20:08:44 +0000482 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000483 break;
484 }
485
drh8790b6e2014-11-07 01:43:56 +0000486/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
487** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
488** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000489#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000490 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000491 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
492 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000493 ** number of bytes in the memory buffer, and the minimum allocation size.
494 */
danielk1977075c23a2008-09-01 18:34:20 +0000495 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
496 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
497 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000498
shaneha6ec8922011-03-09 21:36:17 +0000499 if( sqlite3GlobalConfig.mnReq<1 ){
500 sqlite3GlobalConfig.mnReq = 1;
501 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
502 /* cap min request size at 2^12 */
503 sqlite3GlobalConfig.mnReq = (1<<12);
504 }
505
danielk1977075c23a2008-09-01 18:34:20 +0000506 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000507 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
508 ** is NULL, then SQLite reverts to using its default memory allocator
509 ** (the system malloc() implementation), undoing any prior invocation of
510 ** SQLITE_CONFIG_MALLOC.
511 **
512 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
513 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000514 */
danielk1977075c23a2008-09-01 18:34:20 +0000515 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000516 }else{
drh8790b6e2014-11-07 01:43:56 +0000517 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
518 ** alternative memory allocator is engaged to handle all of SQLites
519 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000520#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000521 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000522#endif
523#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000524 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000525#endif
drh8a42cbd2008-07-10 18:13:42 +0000526 }
danielk19775099be52008-06-27 13:27:03 +0000527 break;
528 }
drh5d414832008-07-15 14:47:18 +0000529#endif
danielk19775099be52008-06-27 13:27:03 +0000530
drh633e6d52008-07-28 19:34:53 +0000531 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000532 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
533 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000534 break;
535 }
drh3f280702010-02-18 18:45:09 +0000536
mistachkin037933b2013-08-13 22:33:41 +0000537 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000538 ** The default is NULL. Logging is disabled if the function pointer is
539 ** NULL.
540 */
541 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000542 /* MSVC is picky about pulling func ptrs from va lists.
543 ** http://support.microsoft.com/kb/47961
544 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
545 */
546 typedef void(*LOGFUNC_t)(void*,int,const char*);
547 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000548 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
549 break;
550 }
drh633e6d52008-07-28 19:34:53 +0000551
drh00729cb2014-10-04 11:59:33 +0000552 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
553 ** can be changed at start-time using the
554 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
555 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
556 */
dancd74b612011-04-22 19:37:32 +0000557 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000558 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
559 ** argument of type int. If non-zero, then URI handling is globally
560 ** enabled. If the parameter is zero, then URI handling is globally
561 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000562 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
563 break;
564 }
565
drhde9a7b82012-09-17 20:44:46 +0000566 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000567 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
568 ** option takes a single integer argument which is interpreted as a
569 ** boolean in order to enable or disable the use of covering indices for
570 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000571 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
572 break;
573 }
574
danac455932012-11-26 19:50:41 +0000575#ifdef SQLITE_ENABLE_SQLLOG
576 case SQLITE_CONFIG_SQLLOG: {
577 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
578 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
579 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
580 break;
581 }
582#endif
583
drh9b4c59f2013-04-15 17:03:42 +0000584 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000585 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
586 ** integer (sqlite3_int64) values that are the default mmap size limit
587 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
588 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000589 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000590 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000591 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000592 ** negative, then that argument is changed to its compile-time default.
593 **
594 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
595 ** silently truncated if necessary so that it does not exceed the
596 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
597 ** compile-time option.
598 */
drh3ba689d2015-03-03 14:00:11 +0000599 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
600 mxMmap = SQLITE_MAX_MMAP_SIZE;
601 }
drh9b4c59f2013-04-15 17:03:42 +0000602 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
603 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000604 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000605 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000606 break;
607 }
608
drh4d9f1882014-11-04 17:23:24 +0000609#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000610 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000611 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
612 ** unsigned integer value that specifies the maximum size of the created
613 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000614 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
615 break;
616 }
617#endif
618
drh3bd17912015-01-02 15:55:29 +0000619 case SQLITE_CONFIG_PMASZ: {
620 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
621 break;
622 }
623
drh40257ff2008-06-13 18:24:27 +0000624 default: {
625 rc = SQLITE_ERROR;
626 break;
627 }
628 }
629 va_end(ap);
630 return rc;
631}
632
633/*
drh633e6d52008-07-28 19:34:53 +0000634** Set up the lookaside buffers for a database connection.
635** Return SQLITE_OK on success.
636** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000637**
638** The sz parameter is the number of bytes in each lookaside slot.
639** The cnt parameter is the number of slots. If pStart is NULL the
640** space for the lookaside memory is obtained from sqlite3_malloc().
641** If pStart is not NULL then it is sz*cnt bytes of memory to use for
642** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000643*/
drhe9d1c722008-08-04 20:13:26 +0000644static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000645 void *pStart;
646 if( db->lookaside.nOut ){
647 return SQLITE_BUSY;
648 }
shanef71f89e2009-01-30 06:11:54 +0000649 /* Free any existing lookaside buffer for this handle before
650 ** allocating a new one so we don't have to have space for
651 ** both at the same time.
652 */
653 if( db->lookaside.bMalloced ){
654 sqlite3_free(db->lookaside.pStart);
655 }
drh61a4bd52011-11-10 02:39:28 +0000656 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
657 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000658 */
drh61a4bd52011-11-10 02:39:28 +0000659 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000660 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000661 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000662 if( sz==0 || cnt==0 ){
663 sz = 0;
664 pStart = 0;
665 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000666 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000667 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000668 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000669 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000670 }else{
671 pStart = pBuf;
672 }
drh4cfb22f2008-08-01 18:47:01 +0000673 db->lookaside.pStart = pStart;
674 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000675 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000676 if( pStart ){
677 int i;
678 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000679 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000680 p = (LookasideSlot*)pStart;
681 for(i=cnt-1; i>=0; i--){
682 p->pNext = db->lookaside.pFree;
683 db->lookaside.pFree = p;
684 p = (LookasideSlot*)&((u8*)p)[sz];
685 }
686 db->lookaside.pEnd = p;
687 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000688 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000689 }else{
drhb0e77042013-12-10 19:49:00 +0000690 db->lookaside.pStart = db;
691 db->lookaside.pEnd = db;
drh4cfb22f2008-08-01 18:47:01 +0000692 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000693 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000694 }
695 return SQLITE_OK;
696}
697
698/*
drh4413d0e2008-11-04 13:46:27 +0000699** Return the mutex associated with a database connection.
700*/
701sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000702#ifdef SQLITE_ENABLE_API_ARMOR
703 if( !sqlite3SafetyCheckOk(db) ){
704 (void)SQLITE_MISUSE_BKPT;
705 return 0;
706 }
707#endif
drh4413d0e2008-11-04 13:46:27 +0000708 return db->mutex;
709}
710
711/*
drh09419b42011-11-16 19:29:17 +0000712** Free up as much memory as we can from the given database
713** connection.
714*/
715int sqlite3_db_release_memory(sqlite3 *db){
716 int i;
drh9ca95732014-10-24 00:35:58 +0000717
718#ifdef SQLITE_ENABLE_API_ARMOR
719 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
720#endif
dand9bb3a92011-12-30 11:43:59 +0000721 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000722 sqlite3BtreeEnterAll(db);
723 for(i=0; i<db->nDb; i++){
724 Btree *pBt = db->aDb[i].pBt;
725 if( pBt ){
726 Pager *pPager = sqlite3BtreePager(pBt);
727 sqlite3PagerShrink(pPager);
728 }
729 }
730 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000731 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000732 return SQLITE_OK;
733}
734
735/*
drh633e6d52008-07-28 19:34:53 +0000736** Configuration settings for an individual database connection
737*/
738int sqlite3_db_config(sqlite3 *db, int op, ...){
739 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000740 int rc;
drh633e6d52008-07-28 19:34:53 +0000741 va_start(ap, op);
742 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000743 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000744 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000745 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
746 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000747 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000748 break;
749 }
drh6480aad2008-08-01 16:31:14 +0000750 default: {
drhe83cafd2011-03-21 17:15:58 +0000751 static const struct {
752 int op; /* The opcode */
753 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
754 } aFlagOp[] = {
755 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
756 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
757 };
drh58ad5802011-03-23 22:02:23 +0000758 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000759 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000760 for(i=0; i<ArraySize(aFlagOp); i++){
761 if( aFlagOp[i].op==op ){
762 int onoff = va_arg(ap, int);
763 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000764 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000765 if( onoff>0 ){
766 db->flags |= aFlagOp[i].mask;
767 }else if( onoff==0 ){
768 db->flags &= ~aFlagOp[i].mask;
769 }
770 if( oldFlags!=db->flags ){
771 sqlite3ExpirePreparedStatements(db);
772 }
773 if( pRes ){
774 *pRes = (db->flags & aFlagOp[i].mask)!=0;
775 }
776 rc = SQLITE_OK;
777 break;
778 }
779 }
drh6480aad2008-08-01 16:31:14 +0000780 break;
781 }
drh633e6d52008-07-28 19:34:53 +0000782 }
783 va_end(ap);
784 return rc;
785}
786
drha16313e2007-03-30 11:29:32 +0000787
788/*
drh9b5adfa2008-01-20 23:19:56 +0000789** Return true if the buffer z[0..n-1] contains all spaces.
790*/
791static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000792 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000793 return n==0;
794}
795
796/*
drhd3d39e92004-05-20 22:16:29 +0000797** This is the default collating function named "BINARY" which is always
798** available.
drh9b5adfa2008-01-20 23:19:56 +0000799**
800** If the padFlag argument is not NULL then space padding at the end
801** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000802*/
danielk19772c336542005-01-13 02:14:23 +0000803static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000804 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000805 int nKey1, const void *pKey1,
806 int nKey2, const void *pKey2
807){
808 int rc, n;
809 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000810 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
811 ** strings byte by byte using the memcmp() function from the standard C
812 ** library. */
drhd3d39e92004-05-20 22:16:29 +0000813 rc = memcmp(pKey1, pKey2, n);
814 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000815 if( padFlag
816 && allSpaces(((char*)pKey1)+n, nKey1-n)
817 && allSpaces(((char*)pKey2)+n, nKey2-n)
818 ){
drh5e3b49b2014-11-20 19:22:26 +0000819 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
820 ** spaces at the end of either string do not change the result. In other
821 ** words, strings will compare equal to one another as long as they
822 ** differ only in the number of spaces at the end.
823 */
drh9b5adfa2008-01-20 23:19:56 +0000824 }else{
825 rc = nKey1 - nKey2;
826 }
drhd3d39e92004-05-20 22:16:29 +0000827 }
828 return rc;
829}
830
831/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000832** Another built-in collating sequence: NOCASE.
833**
drhf7b54962013-05-28 12:11:54 +0000834** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000835** comparison". SQLite's knowledge of upper and lower case equivalents
836** extends only to the 26 characters used in the English language.
837**
838** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000839*/
840static int nocaseCollatingFunc(
841 void *NotUsed,
842 int nKey1, const void *pKey1,
843 int nKey2, const void *pKey2
844){
845 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000846 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000847 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000848 if( 0==r ){
849 r = nKey1-nKey2;
850 }
851 return r;
852}
853
854/*
drhaf9ff332002-01-16 21:00:27 +0000855** Return the ROWID of the most recent insert
856*/
drh9bb575f2004-09-06 17:24:11 +0000857sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000858#ifdef SQLITE_ENABLE_API_ARMOR
859 if( !sqlite3SafetyCheckOk(db) ){
860 (void)SQLITE_MISUSE_BKPT;
861 return 0;
862 }
863#endif
drhaf9ff332002-01-16 21:00:27 +0000864 return db->lastRowid;
865}
866
867/*
danielk197724b03fd2004-05-10 10:34:34 +0000868** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000869*/
drh9bb575f2004-09-06 17:24:11 +0000870int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000871#ifdef SQLITE_ENABLE_API_ARMOR
872 if( !sqlite3SafetyCheckOk(db) ){
873 (void)SQLITE_MISUSE_BKPT;
874 return 0;
875 }
876#endif
drhc8d30ac2002-04-12 10:08:59 +0000877 return db->nChange;
878}
879
rdcf146a772004-02-25 22:51:06 +0000880/*
danielk1977b28af712004-06-21 06:50:26 +0000881** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000882*/
danielk1977b28af712004-06-21 06:50:26 +0000883int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000884#ifdef SQLITE_ENABLE_API_ARMOR
885 if( !sqlite3SafetyCheckOk(db) ){
886 (void)SQLITE_MISUSE_BKPT;
887 return 0;
888 }
889#endif
danielk1977b28af712004-06-21 06:50:26 +0000890 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000891}
892
drhc8d30ac2002-04-12 10:08:59 +0000893/*
danielk1977fd7f0452008-12-17 17:30:26 +0000894** Close all open savepoints. This function only manipulates fields of the
895** database handle object, it does not close any savepoints that may be open
896** at the b-tree/pager level.
897*/
898void sqlite3CloseSavepoints(sqlite3 *db){
899 while( db->pSavepoint ){
900 Savepoint *pTmp = db->pSavepoint;
901 db->pSavepoint = pTmp->pNext;
902 sqlite3DbFree(db, pTmp);
903 }
904 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000905 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000906 db->isTransactionSavepoint = 0;
907}
908
909/*
dand2199f02010-08-27 17:48:52 +0000910** Invoke the destructor function associated with FuncDef p, if any. Except,
911** if this is not the last copy of the function, do not invoke it. Multiple
912** copies of a single function are created when create_function() is called
913** with SQLITE_ANY as the encoding.
914*/
915static void functionDestroy(sqlite3 *db, FuncDef *p){
916 FuncDestructor *pDestructor = p->pDestructor;
917 if( pDestructor ){
918 pDestructor->nRef--;
919 if( pDestructor->nRef==0 ){
920 pDestructor->xDestroy(pDestructor->pUserData);
921 sqlite3DbFree(db, pDestructor);
922 }
923 }
924}
925
926/*
danbba02a92012-05-15 17:15:34 +0000927** Disconnect all sqlite3_vtab objects that belong to database connection
928** db. This is called when db is being closed.
929*/
930static void disconnectAllVtab(sqlite3 *db){
931#ifndef SQLITE_OMIT_VIRTUALTABLE
932 int i;
933 sqlite3BtreeEnterAll(db);
934 for(i=0; i<db->nDb; i++){
935 Schema *pSchema = db->aDb[i].pSchema;
936 if( db->aDb[i].pSchema ){
937 HashElem *p;
938 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
939 Table *pTab = (Table *)sqliteHashData(p);
940 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
941 }
942 }
943 }
dand88e5212014-03-12 19:38:38 +0000944 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000945 sqlite3BtreeLeaveAll(db);
946#else
947 UNUSED_PARAMETER(db);
948#endif
949}
950
951/*
drh167cd6a2012-06-02 17:09:46 +0000952** Return TRUE if database connection db has unfinalized prepared
953** statements or unfinished sqlite3_backup objects.
954*/
955static int connectionIsBusy(sqlite3 *db){
956 int j;
957 assert( sqlite3_mutex_held(db->mutex) );
958 if( db->pVdbe ) return 1;
959 for(j=0; j<db->nDb; j++){
960 Btree *pBt = db->aDb[j].pBt;
961 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
962 }
963 return 0;
964}
965
966/*
drh50e5dad2001-09-15 00:57:28 +0000967** Close an existing SQLite database
968*/
drh167cd6a2012-06-02 17:09:46 +0000969static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000970 if( !db ){
drhddb17ca2014-08-11 15:54:11 +0000971 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
972 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +0000973 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000974 }
drh7e8b8482008-01-23 03:03:05 +0000975 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000976 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000977 }
drh605264d2007-08-21 15:13:19 +0000978 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000979
danbba02a92012-05-15 17:15:34 +0000980 /* Force xDisconnect calls on all virtual tables */
981 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000982
danbba02a92012-05-15 17:15:34 +0000983 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000984 ** will not have called the xDisconnect() method on any virtual
985 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
986 ** call will do so. We need to do this before the check for active
987 ** SQL statements below, as the v-table implementation may be storing
988 ** some prepared statements internally.
989 */
dan67430812013-05-15 10:21:50 +0000990 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000991
drh167cd6a2012-06-02 17:09:46 +0000992 /* Legacy behavior (sqlite3_close() behavior) is to return
993 ** SQLITE_BUSY if the connection can not be closed immediately.
994 */
995 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +0000996 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +0000997 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000998 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000999 return SQLITE_BUSY;
1000 }
danielk1977e0048402004-06-15 16:51:01 +00001001
danac455932012-11-26 19:50:41 +00001002#ifdef SQLITE_ENABLE_SQLLOG
1003 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001004 /* Closing the handle. Fourth parameter is passed the value 2. */
1005 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001006 }
1007#endif
1008
drh167cd6a2012-06-02 17:09:46 +00001009 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001010 */
1011 db->magic = SQLITE_MAGIC_ZOMBIE;
1012 sqlite3LeaveMutexAndCloseZombie(db);
1013 return SQLITE_OK;
1014}
drh94e92032003-02-16 22:21:32 +00001015
drh167cd6a2012-06-02 17:09:46 +00001016/*
1017** Two variations on the public interface for closing a database
1018** connection. The sqlite3_close() version returns SQLITE_BUSY and
1019** leaves the connection option if there are unfinalized prepared
1020** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1021** version forces the connection to become a zombie if there are
1022** unclosed resources, and arranges for deallocation when the last
1023** prepare statement or sqlite3_backup closes.
1024*/
1025int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1026int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1027
drh4245c402012-06-02 14:32:21 +00001028
1029/*
1030** Close the mutex on database connection db.
1031**
1032** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001033** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1034** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1035** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001036*/
1037void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1038 HashElem *i; /* Hash table iterator */
1039 int j;
1040
drh4245c402012-06-02 14:32:21 +00001041 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001042 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1043 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001044 */
drh167cd6a2012-06-02 17:09:46 +00001045 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001046 sqlite3_mutex_leave(db->mutex);
1047 return;
danielk197704103022009-02-03 16:51:24 +00001048 }
1049
drh4245c402012-06-02 14:32:21 +00001050 /* If we reach this point, it means that the database connection has
1051 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001052 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001053 ** go ahead and free all resources.
1054 */
1055
dan617dc862013-05-16 11:57:28 +00001056 /* If a transaction is open, roll it back. This also ensures that if
1057 ** any database schemas have been modified by an uncommitted transaction
1058 ** they are reset. And that the required b-tree mutex is held to make
1059 ** the pager rollback and schema reset an atomic operation. */
1060 sqlite3RollbackAll(db, SQLITE_OK);
1061
danielk1977fd7f0452008-12-17 17:30:26 +00001062 /* Free any outstanding Savepoint structures. */
1063 sqlite3CloseSavepoints(db);
1064
drh5efb3142012-05-16 01:24:34 +00001065 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001066 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001067 struct Db *pDb = &db->aDb[j];
1068 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001069 sqlite3BtreeClose(pDb->pBt);
1070 pDb->pBt = 0;
1071 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001072 pDb->pSchema = 0;
1073 }
drh113088e2003-03-20 01:16:58 +00001074 }
drhf57b3392001-10-08 13:22:32 +00001075 }
drh5efb3142012-05-16 01:24:34 +00001076 /* Clear the TEMP schema separately and last */
1077 if( db->aDb[1].pSchema ){
1078 sqlite3SchemaClear(db->aDb[1].pSchema);
1079 }
1080 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001081
drh5efb3142012-05-16 01:24:34 +00001082 /* Free up the array of auxiliary databases */
1083 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001084 assert( db->nDb<=2 );
1085 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001086
1087 /* Tell the code in notify.c that the connection no longer holds any
1088 ** locks and does not require any further unlock-notify callbacks.
1089 */
1090 sqlite3ConnectionClosed(db);
1091
drh70a8ca32008-08-21 18:49:27 +00001092 for(j=0; j<ArraySize(db->aFunc.a); j++){
1093 FuncDef *pNext, *pHash, *p;
1094 for(p=db->aFunc.a[j]; p; p=pHash){
1095 pHash = p->pHash;
1096 while( p ){
dand2199f02010-08-27 17:48:52 +00001097 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +00001098 pNext = p->pNext;
1099 sqlite3DbFree(db, p);
1100 p = pNext;
1101 }
drh8e0a2f92002-02-23 23:45:45 +00001102 }
1103 }
danielk1977d8123362004-06-12 09:25:12 +00001104 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001105 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001106 /* Invoke any destructors registered for collation sequence user data. */
1107 for(j=0; j<3; j++){
1108 if( pColl[j].xDel ){
1109 pColl[j].xDel(pColl[j].pUser);
1110 }
1111 }
drh633e6d52008-07-28 19:34:53 +00001112 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001113 }
danielk1977d8123362004-06-12 09:25:12 +00001114 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001115#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001116 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1117 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001118 if( pMod->xDestroy ){
1119 pMod->xDestroy(pMod->pAux);
1120 }
drh633e6d52008-07-28 19:34:53 +00001121 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001122 }
drhb9bb7c12006-06-11 23:41:55 +00001123 sqlite3HashClear(&db->aModule);
1124#endif
danielk1977466be562004-06-10 02:16:01 +00001125
drh13f40da2014-08-22 18:00:11 +00001126 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001127 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001128 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001129#if SQLITE_USER_AUTHENTICATION
1130 sqlite3_free(db->auth.zAuthUser);
1131 sqlite3_free(db->auth.zAuthPW);
1132#endif
danielk197796d81f92004-06-19 03:33:57 +00001133
1134 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001135
1136 /* The temp-database schema is allocated differently from the other schema
1137 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1138 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1139 ** the same sqliteMalloc() as the one that allocates the database
1140 ** structure?
1141 */
drh633e6d52008-07-28 19:34:53 +00001142 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001143 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001144 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001145 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001146 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001147 if( db->lookaside.bMalloced ){
1148 sqlite3_free(db->lookaside.pStart);
1149 }
drh17435752007-08-16 04:30:38 +00001150 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001151}
1152
1153/*
drh0f198a72012-02-13 16:43:16 +00001154** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001155** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001156** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001157** attempts to use that cursor. Read cursors remain open and valid
1158** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001159*/
drh0f198a72012-02-13 16:43:16 +00001160void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001161 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001162 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001163 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001164 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001165 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001166
1167 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1168 ** This is important in case the transaction being rolled back has
1169 ** modified the database schema. If the b-tree mutexes are not taken
1170 ** here, then another shared-cache connection might sneak in between
1171 ** the database rollback and schema reset, which can cause false
1172 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001173 sqlite3BtreeEnterAll(db);
drh47b7fc72014-11-11 01:33:57 +00001174 schemaChange = (db->flags & SQLITE_InternChanges)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001175
drh001bbcb2003-03-19 03:14:00 +00001176 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001177 Btree *p = db->aDb[i].pBt;
1178 if( p ){
1179 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001180 inTrans = 1;
1181 }
drh47b7fc72014-11-11 01:33:57 +00001182 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001183 }
1184 }
danielk1977a298e902006-06-22 09:53:48 +00001185 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001186 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001187
drh5c5760a2013-02-19 18:34:45 +00001188 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001189 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001190 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001191 }
dancd7b91a2013-05-13 18:23:15 +00001192 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001193
dan1da40a32009-09-19 17:00:31 +00001194 /* Any deferred constraint violations have now been resolved. */
1195 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001196 db->nDeferredImmCons = 0;
1197 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001198
danielk197771fd80b2005-12-16 06:54:01 +00001199 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001200 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001201 db->xRollbackCallback(db->pRollbackArg);
1202 }
drh001bbcb2003-03-19 03:14:00 +00001203}
1204
1205/*
mistachkinf2c1c992013-04-28 01:44:43 +00001206** Return a static string containing the name corresponding to the error code
1207** specified in the argument.
1208*/
mistachkin0cbcffa2015-04-16 03:56:32 +00001209#if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
mistachkinf2c1c992013-04-28 01:44:43 +00001210const char *sqlite3ErrName(int rc){
1211 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001212 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001213 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1214 switch( rc ){
1215 case SQLITE_OK: zName = "SQLITE_OK"; break;
1216 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1217 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1218 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1219 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001220 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001221 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001222 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001223 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001224 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1225 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1226 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1227 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001228 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1229 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1230 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001231 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001232 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1233 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001234 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1235 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1236 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1237 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1238 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1239 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1240 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1241 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1242 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1243 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001244 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1245 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1246 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1247 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1248 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1249 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1250 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1251 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1252 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1253 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1254 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1255 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1256 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1257 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001258 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001259 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001260 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001261 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001262 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1263 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1264 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001265 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1266 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1267 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001268 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001269 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1270 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1271 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1272 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1273 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1274 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1275 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1276 case SQLITE_CONSTRAINT_FOREIGNKEY:
1277 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1278 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1279 case SQLITE_CONSTRAINT_PRIMARYKEY:
1280 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1281 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1282 case SQLITE_CONSTRAINT_COMMITHOOK:
1283 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1284 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1285 case SQLITE_CONSTRAINT_FUNCTION:
1286 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001287 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001288 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1289 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1290 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1291 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1292 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1293 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1294 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1295 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1296 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001297 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1298 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1299 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001300 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001301 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001302 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001303 }
1304 }
mistachkin10269dc2013-04-30 07:54:42 +00001305 if( zName==0 ){
1306 static char zBuf[50];
1307 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1308 zName = zBuf;
1309 }
mistachkinf2c1c992013-04-28 01:44:43 +00001310 return zName;
1311}
mistachkin10269dc2013-04-30 07:54:42 +00001312#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001313
1314/*
drhc22bd472002-05-10 13:14:07 +00001315** Return a static string that describes the kind of error specified in the
1316** argument.
drh247be432002-05-10 05:44:55 +00001317*/
danielk1977f20b21c2004-05-31 23:56:42 +00001318const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001319 static const char* const aMsg[] = {
1320 /* SQLITE_OK */ "not an error",
1321 /* SQLITE_ERROR */ "SQL logic error or missing database",
1322 /* SQLITE_INTERNAL */ 0,
1323 /* SQLITE_PERM */ "access permission denied",
1324 /* SQLITE_ABORT */ "callback requested query abort",
1325 /* SQLITE_BUSY */ "database is locked",
1326 /* SQLITE_LOCKED */ "database table is locked",
1327 /* SQLITE_NOMEM */ "out of memory",
1328 /* SQLITE_READONLY */ "attempt to write a readonly database",
1329 /* SQLITE_INTERRUPT */ "interrupted",
1330 /* SQLITE_IOERR */ "disk I/O error",
1331 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001332 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001333 /* SQLITE_FULL */ "database or disk is full",
1334 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001335 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001336 /* SQLITE_EMPTY */ "table contains no data",
1337 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001338 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001339 /* SQLITE_CONSTRAINT */ "constraint failed",
1340 /* SQLITE_MISMATCH */ "datatype mismatch",
1341 /* SQLITE_MISUSE */ "library routine called out of sequence",
1342 /* SQLITE_NOLFS */ "large file support is disabled",
1343 /* SQLITE_AUTH */ "authorization denied",
1344 /* SQLITE_FORMAT */ "auxiliary database format error",
1345 /* SQLITE_RANGE */ "bind or column index out of range",
1346 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1347 };
drh21021a52012-02-13 17:01:51 +00001348 const char *zErr = "unknown error";
1349 switch( rc ){
1350 case SQLITE_ABORT_ROLLBACK: {
1351 zErr = "abort due to ROLLBACK";
1352 break;
1353 }
1354 default: {
1355 rc &= 0xff;
1356 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1357 zErr = aMsg[rc];
1358 }
1359 break;
1360 }
drh247be432002-05-10 05:44:55 +00001361 }
drh21021a52012-02-13 17:01:51 +00001362 return zErr;
drh247be432002-05-10 05:44:55 +00001363}
1364
1365/*
drh2dfbbca2000-07-28 14:32:48 +00001366** This routine implements a busy callback that sleeps and tries
1367** again until a timeout value is reached. The timeout value is
1368** an integer number of milliseconds passed in as the first
1369** argument.
1370*/
drhdaffd0e2001-04-11 14:28:42 +00001371static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001372 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001373 int count /* Number of times table has been busy */
1374){
drh0ede9eb2015-01-10 16:49:23 +00001375#if SQLITE_OS_WIN || HAVE_USLEEP
drhee570fa2005-04-28 12:06:05 +00001376 static const u8 delays[] =
1377 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1378 static const u8 totals[] =
1379 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001380# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001381 sqlite3 *db = (sqlite3 *)ptr;
1382 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001383 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001384
drhee570fa2005-04-28 12:06:05 +00001385 assert( count>=0 );
1386 if( count < NDELAY ){
1387 delay = delays[count];
1388 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001389 }else{
1390 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001391 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001392 }
drhd1bec472004-01-15 13:29:31 +00001393 if( prior + delay > timeout ){
1394 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001395 if( delay<=0 ) return 0;
1396 }
danielk19772a6bdf62007-08-20 16:07:00 +00001397 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001398 return 1;
1399#else
drh482ea182007-08-20 11:12:40 +00001400 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001401 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001402 if( (count+1)*1000 > timeout ){
1403 return 0;
1404 }
drh482ea182007-08-20 11:12:40 +00001405 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001406 return 1;
1407#endif
1408}
1409
1410/*
drha4afb652005-07-09 02:16:02 +00001411** Invoke the given busy handler.
1412**
1413** This routine is called when an operation failed with a lock.
1414** If this routine returns non-zero, the lock is retried. If it
1415** returns 0, the operation aborts with an SQLITE_BUSY error.
1416*/
1417int sqlite3InvokeBusyHandler(BusyHandler *p){
1418 int rc;
drh34004ce2008-07-11 16:15:17 +00001419 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001420 rc = p->xFunc(p->pArg, p->nBusy);
1421 if( rc==0 ){
1422 p->nBusy = -1;
1423 }else{
1424 p->nBusy++;
1425 }
1426 return rc;
1427}
1428
1429/*
drh2dfbbca2000-07-28 14:32:48 +00001430** This routine sets the busy callback for an Sqlite database to the
1431** given callback function with the given argument.
1432*/
danielk1977f9d64d22004-06-19 08:18:07 +00001433int sqlite3_busy_handler(
1434 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001435 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001436 void *pArg
1437){
drh9ca95732014-10-24 00:35:58 +00001438#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001439 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001440#endif
drhe30f4422007-08-21 16:15:55 +00001441 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001442 db->busyHandler.xFunc = xBusy;
1443 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001444 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001445 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001446 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001447 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001448}
1449
danielk1977348bb5d2003-10-18 09:37:26 +00001450#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1451/*
1452** This routine sets the progress callback for an Sqlite database to the
1453** given callback function with the given argument. The progress callback will
1454** be invoked every nOps opcodes.
1455*/
danielk197724b03fd2004-05-10 10:34:34 +00001456void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001457 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001458 int nOps,
1459 int (*xProgress)(void*),
1460 void *pArg
1461){
drh9ca95732014-10-24 00:35:58 +00001462#ifdef SQLITE_ENABLE_API_ARMOR
1463 if( !sqlite3SafetyCheckOk(db) ){
1464 (void)SQLITE_MISUSE_BKPT;
1465 return;
1466 }
1467#endif
drhbd0b1b52008-07-07 19:52:09 +00001468 sqlite3_mutex_enter(db->mutex);
1469 if( nOps>0 ){
1470 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001471 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001472 db->pProgressArg = pArg;
1473 }else{
1474 db->xProgress = 0;
1475 db->nProgressOps = 0;
1476 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001477 }
drhbd0b1b52008-07-07 19:52:09 +00001478 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001479}
1480#endif
1481
1482
drh2dfbbca2000-07-28 14:32:48 +00001483/*
1484** This routine installs a default busy handler that waits for the
1485** specified number of milliseconds before returning 0.
1486*/
danielk1977f9d64d22004-06-19 08:18:07 +00001487int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001488#ifdef SQLITE_ENABLE_API_ARMOR
1489 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1490#endif
drh2dfbbca2000-07-28 14:32:48 +00001491 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001492 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001493 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001494 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001495 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001496 }
danielk1977f9d64d22004-06-19 08:18:07 +00001497 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001498}
drh4c504392000-10-16 22:06:40 +00001499
1500/*
1501** Cause any pending operation to stop at its earliest opportunity.
1502*/
drh9bb575f2004-09-06 17:24:11 +00001503void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001504#ifdef SQLITE_ENABLE_API_ARMOR
1505 if( !sqlite3SafetyCheckOk(db) ){
1506 (void)SQLITE_MISUSE_BKPT;
1507 return;
1508 }
1509#endif
drhbd0b1b52008-07-07 19:52:09 +00001510 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001511}
drhfa86c412002-02-02 15:01:15 +00001512
drhfa86c412002-02-02 15:01:15 +00001513
1514/*
danielk1977771151b2006-01-17 13:21:40 +00001515** This function is exactly the same as sqlite3_create_function(), except
1516** that it is designed to be called by internal code. The difference is
1517** that if a malloc() fails in sqlite3_create_function(), an error code
1518** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001519*/
danielk1977771151b2006-01-17 13:21:40 +00001520int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001521 sqlite3 *db,
1522 const char *zFunctionName,
1523 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001524 int enc,
danielk197765904932004-05-26 06:18:37 +00001525 void *pUserData,
1526 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1527 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001528 void (*xFinal)(sqlite3_context*),
1529 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001530){
drh0bce8352002-02-28 00:41:10 +00001531 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001532 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001533 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001534
drhe30f4422007-08-21 16:15:55 +00001535 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001536 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001537 (xFunc && (xFinal || xStep)) ||
1538 (!xFunc && (xFinal && !xStep)) ||
1539 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001540 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001541 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001542 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001543 }
drh4a8ee3d2013-12-14 13:44:22 +00001544
1545 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1546 extraFlags = enc & SQLITE_DETERMINISTIC;
1547 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001548
danielk197793758c82005-01-21 08:13:14 +00001549#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001550 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1551 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1552 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1553 **
1554 ** If SQLITE_ANY is specified, add three versions of the function
1555 ** to the hash table.
1556 */
1557 if( enc==SQLITE_UTF16 ){
1558 enc = SQLITE_UTF16NATIVE;
1559 }else if( enc==SQLITE_ANY ){
1560 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001561 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dand2199f02010-08-27 17:48:52 +00001562 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001563 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001564 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dand2199f02010-08-27 17:48:52 +00001565 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001566 }
1567 if( rc!=SQLITE_OK ){
1568 return rc;
1569 }
danielk1977d8123362004-06-12 09:25:12 +00001570 enc = SQLITE_UTF16BE;
1571 }
danielk197793758c82005-01-21 08:13:14 +00001572#else
1573 enc = SQLITE_UTF8;
1574#endif
danielk19779636c4e2005-01-25 04:27:54 +00001575
1576 /* Check if an existing function is being overridden or deleted. If so,
1577 ** and there are active VMs, then return SQLITE_BUSY. If a function
1578 ** is being overridden/deleted but there are no active VMs, allow the
1579 ** operation to continue but invalidate all precompiled statements.
1580 */
drh3abbd392008-12-10 23:04:13 +00001581 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001582 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001583 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001584 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001585 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001586 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001587 return SQLITE_BUSY;
1588 }else{
1589 sqlite3ExpirePreparedStatements(db);
1590 }
1591 }
danielk197765904932004-05-26 06:18:37 +00001592
drh3abbd392008-12-10 23:04:13 +00001593 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001594 assert(p || db->mallocFailed);
1595 if( !p ){
1596 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001597 }
dand2199f02010-08-27 17:48:52 +00001598
1599 /* If an older version of the function with a configured destructor is
1600 ** being replaced invoke the destructor function here. */
1601 functionDestroy(db, p);
1602
1603 if( pDestructor ){
1604 pDestructor->nRef++;
1605 }
1606 p->pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001607 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1608 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
danielk1977fa18bec2007-09-03 11:04:22 +00001609 p->xFunc = xFunc;
1610 p->xStep = xStep;
1611 p->xFinalize = xFinal;
1612 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001613 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001614 return SQLITE_OK;
1615}
danielk1977771151b2006-01-17 13:21:40 +00001616
1617/*
1618** Create new user functions.
1619*/
1620int sqlite3_create_function(
1621 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001622 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001623 int nArg,
1624 int enc,
1625 void *p,
1626 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1627 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1628 void (*xFinal)(sqlite3_context*)
1629){
drh7b19fac2010-08-27 18:44:54 +00001630 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1631 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001632}
1633
1634int sqlite3_create_function_v2(
1635 sqlite3 *db,
1636 const char *zFunc,
1637 int nArg,
1638 int enc,
1639 void *p,
1640 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1641 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1642 void (*xFinal)(sqlite3_context*),
1643 void (*xDestroy)(void *)
1644){
shanehbd2aaf92010-09-01 02:38:21 +00001645 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001646 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001647
1648#ifdef SQLITE_ENABLE_API_ARMOR
1649 if( !sqlite3SafetyCheckOk(db) ){
1650 return SQLITE_MISUSE_BKPT;
1651 }
1652#endif
dand2199f02010-08-27 17:48:52 +00001653 sqlite3_mutex_enter(db->mutex);
1654 if( xDestroy ){
1655 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001656 if( !pArg ){
1657 xDestroy(p);
1658 goto out;
1659 }
dand2199f02010-08-27 17:48:52 +00001660 pArg->xDestroy = xDestroy;
1661 pArg->pUserData = p;
1662 }
1663 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1664 if( pArg && pArg->nRef==0 ){
1665 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001666 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001667 sqlite3DbFree(db, pArg);
1668 }
1669
1670 out:
drhe30f4422007-08-21 16:15:55 +00001671 rc = sqlite3ApiExit(db, rc);
1672 sqlite3_mutex_leave(db->mutex);
1673 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001674}
1675
danielk197793758c82005-01-21 08:13:14 +00001676#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001677int sqlite3_create_function16(
1678 sqlite3 *db,
1679 const void *zFunctionName,
1680 int nArg,
1681 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001682 void *p,
danielk197765904932004-05-26 06:18:37 +00001683 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1684 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1685 void (*xFinal)(sqlite3_context*)
1686){
1687 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001688 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001689
1690#ifdef SQLITE_ENABLE_API_ARMOR
1691 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1692#endif
drhe30f4422007-08-21 16:15:55 +00001693 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001694 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001695 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001696 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001697 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001698 rc = sqlite3ApiExit(db, rc);
1699 sqlite3_mutex_leave(db->mutex);
1700 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001701}
danielk197793758c82005-01-21 08:13:14 +00001702#endif
drhc9b84a12002-06-20 11:36:48 +00001703
drhb7481e72006-09-16 21:45:14 +00001704
1705/*
1706** Declare that a function has been overloaded by a virtual table.
1707**
1708** If the function already exists as a regular global function, then
1709** this routine is a no-op. If the function does not exist, then create
1710** a new one that always throws a run-time error.
1711**
1712** When virtual tables intend to provide an overloaded function, they
1713** should call this routine to make sure the global function exists.
1714** A global function must exist in order for name resolution to work
1715** properly.
1716*/
1717int sqlite3_overload_function(
1718 sqlite3 *db,
1719 const char *zName,
1720 int nArg
1721){
drhdee0e402009-05-03 20:23:53 +00001722 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001723 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001724
1725#ifdef SQLITE_ENABLE_API_ARMOR
1726 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1727 return SQLITE_MISUSE_BKPT;
1728 }
1729#endif
drhe30f4422007-08-21 16:15:55 +00001730 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001731 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001732 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1733 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001734 }
drhcb5e4db2011-10-12 23:49:49 +00001735 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001736 sqlite3_mutex_leave(db->mutex);
1737 return rc;
drhb7481e72006-09-16 21:45:14 +00001738}
1739
drh19e2d372005-08-29 23:00:03 +00001740#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001741/*
drh18de4822003-01-16 16:28:53 +00001742** Register a trace function. The pArg from the previously registered trace
1743** is returned.
1744**
1745** A NULL trace function means that no tracing is executes. A non-NULL
1746** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001747** SQL statement.
drh18de4822003-01-16 16:28:53 +00001748*/
drh9bb575f2004-09-06 17:24:11 +00001749void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001750 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001751
1752#ifdef SQLITE_ENABLE_API_ARMOR
1753 if( !sqlite3SafetyCheckOk(db) ){
1754 (void)SQLITE_MISUSE_BKPT;
1755 return 0;
1756 }
1757#endif
drhe30f4422007-08-21 16:15:55 +00001758 sqlite3_mutex_enter(db->mutex);
1759 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001760 db->xTrace = xTrace;
1761 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001762 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001763 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001764}
drh19e2d372005-08-29 23:00:03 +00001765/*
1766** Register a profile function. The pArg from the previously registered
1767** profile function is returned.
1768**
1769** A NULL profile function means that no profiling is executes. A non-NULL
1770** profile is a pointer to a function that is invoked at the conclusion of
1771** each SQL statement that is run.
1772*/
1773void *sqlite3_profile(
1774 sqlite3 *db,
1775 void (*xProfile)(void*,const char*,sqlite_uint64),
1776 void *pArg
1777){
drhe30f4422007-08-21 16:15:55 +00001778 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001779
1780#ifdef SQLITE_ENABLE_API_ARMOR
1781 if( !sqlite3SafetyCheckOk(db) ){
1782 (void)SQLITE_MISUSE_BKPT;
1783 return 0;
1784 }
1785#endif
drhe30f4422007-08-21 16:15:55 +00001786 sqlite3_mutex_enter(db->mutex);
1787 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001788 db->xProfile = xProfile;
1789 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001790 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001791 return pOld;
1792}
1793#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001794
drhcd565fd2012-03-01 21:30:44 +00001795/*
1796** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001797** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001798** rollback.
1799*/
danielk197724b03fd2004-05-10 10:34:34 +00001800void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001801 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001802 int (*xCallback)(void*), /* Function to invoke on each commit */
1803 void *pArg /* Argument to the function */
1804){
drhe30f4422007-08-21 16:15:55 +00001805 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001806
1807#ifdef SQLITE_ENABLE_API_ARMOR
1808 if( !sqlite3SafetyCheckOk(db) ){
1809 (void)SQLITE_MISUSE_BKPT;
1810 return 0;
1811 }
1812#endif
drhe30f4422007-08-21 16:15:55 +00001813 sqlite3_mutex_enter(db->mutex);
1814 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001815 db->xCommitCallback = xCallback;
1816 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001817 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001818 return pOld;
1819}
1820
danielk197794eb6a12005-12-15 15:22:08 +00001821/*
1822** Register a callback to be invoked each time a row is updated,
1823** inserted or deleted using this database connection.
1824*/
danielk197771fd80b2005-12-16 06:54:01 +00001825void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001826 sqlite3 *db, /* Attach the hook to this database */
1827 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1828 void *pArg /* Argument to the function */
1829){
drhe30f4422007-08-21 16:15:55 +00001830 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001831
1832#ifdef SQLITE_ENABLE_API_ARMOR
1833 if( !sqlite3SafetyCheckOk(db) ){
1834 (void)SQLITE_MISUSE_BKPT;
1835 return 0;
1836 }
1837#endif
drhe30f4422007-08-21 16:15:55 +00001838 sqlite3_mutex_enter(db->mutex);
1839 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001840 db->xUpdateCallback = xCallback;
1841 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001842 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001843 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001844}
1845
danielk197771fd80b2005-12-16 06:54:01 +00001846/*
1847** Register a callback to be invoked each time a transaction is rolled
1848** back by this database connection.
1849*/
1850void *sqlite3_rollback_hook(
1851 sqlite3 *db, /* Attach the hook to this database */
1852 void (*xCallback)(void*), /* Callback function */
1853 void *pArg /* Argument to the function */
1854){
drhe30f4422007-08-21 16:15:55 +00001855 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001856
1857#ifdef SQLITE_ENABLE_API_ARMOR
1858 if( !sqlite3SafetyCheckOk(db) ){
1859 (void)SQLITE_MISUSE_BKPT;
1860 return 0;
1861 }
1862#endif
drhe30f4422007-08-21 16:15:55 +00001863 sqlite3_mutex_enter(db->mutex);
1864 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001865 db->xRollbackCallback = xCallback;
1866 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001867 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001868 return pRet;
1869}
drhaa940ea2004-01-15 02:44:03 +00001870
dan586b9c82010-05-03 08:04:49 +00001871#ifndef SQLITE_OMIT_WAL
1872/*
1873** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001874** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1875** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001876** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001877*/
drhb033d8b2010-05-03 13:37:30 +00001878int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001879 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001880 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001881 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001882 int nFrame /* Size of WAL */
1883){
drh5def0842010-05-05 20:00:25 +00001884 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001885 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001886 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001887 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001888 }
1889 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001890}
drhb033d8b2010-05-03 13:37:30 +00001891#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001892
1893/*
1894** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1895** a database after committing a transaction if there are nFrame or
1896** more frames in the log file. Passing zero or a negative value as the
1897** nFrame parameter disables automatic checkpoints entirely.
1898**
1899** The callback registered by this function replaces any existing callback
1900** registered using sqlite3_wal_hook(). Likewise, registering a callback
1901** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1902** configured by this function.
1903*/
1904int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001905#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001906 UNUSED_PARAMETER(db);
1907 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001908#else
drh9ca95732014-10-24 00:35:58 +00001909#ifdef SQLITE_ENABLE_API_ARMOR
1910 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1911#endif
dan586b9c82010-05-03 08:04:49 +00001912 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001913 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001914 }else{
1915 sqlite3_wal_hook(db, 0, 0);
1916 }
drhb033d8b2010-05-03 13:37:30 +00001917#endif
dan586b9c82010-05-03 08:04:49 +00001918 return SQLITE_OK;
1919}
1920
paulb0208cc2003-04-13 18:26:49 +00001921/*
dan8d22a172010-04-19 18:03:51 +00001922** Register a callback to be invoked each time a transaction is written
1923** into the write-ahead-log by this database connection.
1924*/
drh833bf962010-04-28 14:42:19 +00001925void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001926 sqlite3 *db, /* Attach the hook to this db handle */
1927 int(*xCallback)(void *, sqlite3*, const char*, int),
1928 void *pArg /* First argument passed to xCallback() */
1929){
drhb033d8b2010-05-03 13:37:30 +00001930#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001931 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001932#ifdef SQLITE_ENABLE_API_ARMOR
1933 if( !sqlite3SafetyCheckOk(db) ){
1934 (void)SQLITE_MISUSE_BKPT;
1935 return 0;
1936 }
1937#endif
dan8d22a172010-04-19 18:03:51 +00001938 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001939 pRet = db->pWalArg;
1940 db->xWalCallback = xCallback;
1941 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001942 sqlite3_mutex_leave(db->mutex);
1943 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001944#else
1945 return 0;
1946#endif
dan8d22a172010-04-19 18:03:51 +00001947}
1948
1949/*
dancdc1f042010-11-18 12:11:05 +00001950** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001951*/
dancdc1f042010-11-18 12:11:05 +00001952int sqlite3_wal_checkpoint_v2(
1953 sqlite3 *db, /* Database handle */
1954 const char *zDb, /* Name of attached database (or NULL) */
1955 int eMode, /* SQLITE_CHECKPOINT_* value */
1956 int *pnLog, /* OUT: Size of WAL log in frames */
1957 int *pnCkpt /* OUT: Total number of frames checkpointed */
1958){
drhb033d8b2010-05-03 13:37:30 +00001959#ifdef SQLITE_OMIT_WAL
1960 return SQLITE_OK;
1961#else
dan586b9c82010-05-03 08:04:49 +00001962 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001963 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001964
drh9ca95732014-10-24 00:35:58 +00001965#ifdef SQLITE_ENABLE_API_ARMOR
1966 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1967#endif
1968
dan9c5e3682011-02-07 15:12:12 +00001969 /* Initialize the output variables to -1 in case an error occurs. */
1970 if( pnLog ) *pnLog = -1;
1971 if( pnCkpt ) *pnCkpt = -1;
1972
danf26a1542014-12-02 19:04:54 +00001973 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
1974 assert( SQLITE_CHECKPOINT_FULL==1 );
1975 assert( SQLITE_CHECKPOINT_RESTART==2 );
1976 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
1977 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00001978 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
1979 ** mode: */
dancdc1f042010-11-18 12:11:05 +00001980 return SQLITE_MISUSE;
1981 }
1982
dan586b9c82010-05-03 08:04:49 +00001983 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001984 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001985 iDb = sqlite3FindDbName(db, zDb);
1986 }
1987 if( iDb<0 ){
1988 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00001989 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001990 }else{
dan976b0032015-01-29 19:12:12 +00001991 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00001992 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00001993 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00001994 }
drhb033d8b2010-05-03 13:37:30 +00001995 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001996 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001997 return rc;
1998#endif
dan586b9c82010-05-03 08:04:49 +00001999}
2000
dancdc1f042010-11-18 12:11:05 +00002001
2002/*
2003** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2004** to contains a zero-length string, all attached databases are
2005** checkpointed.
2006*/
2007int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002008 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2009 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2010 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002011}
2012
drhb033d8b2010-05-03 13:37:30 +00002013#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002014/*
2015** Run a checkpoint on database iDb. This is a no-op if database iDb is
2016** not currently open in WAL mode.
2017**
dan6fcff072010-05-03 14:05:43 +00002018** If a transaction is open on the database being checkpointed, this
2019** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2020** an error occurs while running the checkpoint, an SQLite error code is
2021** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002022**
2023** The mutex on database handle db should be held by the caller. The mutex
2024** associated with the specific b-tree being checkpointed is taken by
2025** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002026**
2027** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2028** checkpointed. If an error is encountered it is returned immediately -
2029** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002030**
dancdc1f042010-11-18 12:11:05 +00002031** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00002032*/
dancdc1f042010-11-18 12:11:05 +00002033int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002034 int rc = SQLITE_OK; /* Return code */
2035 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002036 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002037
2038 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002039 assert( !pnLog || *pnLog==-1 );
2040 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002041
dan6fcff072010-05-03 14:05:43 +00002042 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2043 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002044 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002045 pnLog = 0;
2046 pnCkpt = 0;
2047 if( rc==SQLITE_BUSY ){
2048 bBusy = 1;
2049 rc = SQLITE_OK;
2050 }
dan6fcff072010-05-03 14:05:43 +00002051 }
dan586b9c82010-05-03 08:04:49 +00002052 }
2053
danf2b8dd52010-11-18 19:28:01 +00002054 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002055}
drhb033d8b2010-05-03 13:37:30 +00002056#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002057
2058/*
danielk1977d8293352009-04-30 09:10:37 +00002059** This function returns true if main-memory should be used instead of
2060** a temporary file for transient pager files and statement journals.
2061** The value returned depends on the value of db->temp_store (runtime
2062** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2063** following table describes the relationship between these two values
2064** and this functions return value.
2065**
2066** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2067** ----------------- -------------- ------------------------------
2068** 0 any file (return 0)
2069** 1 1 file (return 0)
2070** 1 2 memory (return 1)
2071** 1 0 file (return 0)
2072** 2 1 file (return 0)
2073** 2 2 memory (return 1)
2074** 2 0 memory (return 1)
2075** 3 any memory (return 1)
2076*/
drh1c514142009-04-30 12:25:10 +00002077int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002078#if SQLITE_TEMP_STORE==1
2079 return ( db->temp_store==2 );
2080#endif
2081#if SQLITE_TEMP_STORE==2
2082 return ( db->temp_store!=1 );
2083#endif
2084#if SQLITE_TEMP_STORE==3
2085 return 1;
shanecf697392009-06-01 16:53:09 +00002086#endif
2087#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00002088 return 0;
shane60a4b532009-05-06 18:57:09 +00002089#endif
danielk1977d8293352009-04-30 09:10:37 +00002090}
2091
2092/*
danielk19774ad17132004-05-21 01:47:26 +00002093** Return UTF-8 encoded English language explanation of the most recent
2094** error.
2095*/
danielk19776622cce2004-05-20 11:00:52 +00002096const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002097 const char *z;
drhf49661a2008-12-10 16:45:50 +00002098 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00002099 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00002100 }
drhd55d57e2008-07-07 17:53:07 +00002101 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002102 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002103 }
drh27641702007-08-22 02:56:42 +00002104 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002105 if( db->mallocFailed ){
2106 z = sqlite3ErrStr(SQLITE_NOMEM);
2107 }else{
drha3cc0072013-12-13 16:23:55 +00002108 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002109 z = (char*)sqlite3_value_text(db->pErr);
2110 assert( !db->mallocFailed );
2111 if( z==0 ){
2112 z = sqlite3ErrStr(db->errCode);
2113 }
danielk19776622cce2004-05-20 11:00:52 +00002114 }
drhe30f4422007-08-21 16:15:55 +00002115 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002116 return z;
danielk19776622cce2004-05-20 11:00:52 +00002117}
2118
drh6c626082004-11-14 21:56:29 +00002119#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002120/*
2121** Return UTF-16 encoded English language explanation of the most recent
2122** error.
2123*/
danielk19776622cce2004-05-20 11:00:52 +00002124const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002125 static const u16 outOfMem[] = {
2126 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002127 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002128 static const u16 misuse[] = {
2129 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2130 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2131 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2132 'o', 'u', 't', ' ',
2133 'o', 'f', ' ',
2134 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002135 };
danielk19774ad17132004-05-21 01:47:26 +00002136
drhc60d0442004-09-30 13:43:13 +00002137 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002138 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002139 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002140 }
drhd55d57e2008-07-07 17:53:07 +00002141 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002142 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002143 }
drhe30f4422007-08-21 16:15:55 +00002144 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002145 if( db->mallocFailed ){
2146 z = (void *)outOfMem;
2147 }else{
drhc60d0442004-09-30 13:43:13 +00002148 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002149 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002150 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002151 z = sqlite3_value_text16(db->pErr);
2152 }
2153 /* A malloc() may have failed within the call to sqlite3_value_text16()
2154 ** above. If this is the case, then the db->mallocFailed flag needs to
2155 ** be cleared before returning. Do this directly, instead of via
2156 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2157 */
2158 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00002159 }
drhe30f4422007-08-21 16:15:55 +00002160 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002161 return z;
danielk19776622cce2004-05-20 11:00:52 +00002162}
drh6c626082004-11-14 21:56:29 +00002163#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002164
drhc60d0442004-09-30 13:43:13 +00002165/*
danielk19777ddad962005-12-12 06:53:03 +00002166** Return the most recent error code generated by an SQLite routine. If NULL is
2167** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002168*/
danielk19776622cce2004-05-20 11:00:52 +00002169int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002170 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002171 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002172 }
drh01495b92008-01-23 12:52:40 +00002173 if( !db || db->mallocFailed ){
2174 return SQLITE_NOMEM;
2175 }
drh4ac285a2006-09-15 07:28:50 +00002176 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002177}
drh99dfe5e2008-10-30 15:03:15 +00002178int sqlite3_extended_errcode(sqlite3 *db){
2179 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002180 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002181 }
2182 if( !db || db->mallocFailed ){
2183 return SQLITE_NOMEM;
2184 }
2185 return db->errCode;
2186}
danielk19776622cce2004-05-20 11:00:52 +00002187
drh0e819f92006-02-01 13:50:41 +00002188/*
mistachkin5dac8432012-09-11 02:00:25 +00002189** Return a string that describes the kind of error specified in the
2190** argument. For now, this simply calls the internal sqlite3ErrStr()
2191** function.
2192*/
2193const char *sqlite3_errstr(int rc){
2194 return sqlite3ErrStr(rc);
2195}
2196
2197/*
drh0e819f92006-02-01 13:50:41 +00002198** Create a new collating function for database "db". The name is zName
2199** and the encoding is enc.
2200*/
danielk19779a30cf62006-01-18 04:26:07 +00002201static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002202 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002203 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002204 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002205 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002206 int(*xCompare)(void*,int,const void*,int,const void*),
2207 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002208){
2209 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002210 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002211
drhe30f4422007-08-21 16:15:55 +00002212 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002213
2214 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2215 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2216 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2217 */
drh51c7d862009-04-27 18:46:06 +00002218 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002219 testcase( enc2==SQLITE_UTF16 );
2220 testcase( enc2==SQLITE_UTF16_ALIGNED );
2221 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002222 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002223 }
drh51c7d862009-04-27 18:46:06 +00002224 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002225 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002226 }
2227
2228 /* Check if this call is removing or replacing an existing collation
2229 ** sequence. If so, and there are active VMs, return busy. If there
2230 ** are no active VMs, invalidate any pre-compiled statements.
2231 */
drhc4a64fa2009-05-11 20:53:28 +00002232 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002233 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002234 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002235 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002236 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002237 return SQLITE_BUSY;
2238 }
2239 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00002240
2241 /* If collation sequence pColl was created directly by a call to
2242 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2243 ** then any copies made by synthCollSeq() need to be invalidated.
2244 ** Also, collation destructor - CollSeq.xDel() - function may need
2245 ** to be called.
2246 */
2247 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002248 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002249 int j;
2250 for(j=0; j<3; j++){
2251 CollSeq *p = &aColl[j];
2252 if( p->enc==pColl->enc ){
2253 if( p->xDel ){
2254 p->xDel(p->pUser);
2255 }
2256 p->xCmp = 0;
2257 }
2258 }
2259 }
danielk19779a30cf62006-01-18 04:26:07 +00002260 }
2261
drhc4a64fa2009-05-11 20:53:28 +00002262 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002263 if( pColl==0 ) return SQLITE_NOMEM;
2264 pColl->xCmp = xCompare;
2265 pColl->pUser = pCtx;
2266 pColl->xDel = xDel;
2267 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002268 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002269 return SQLITE_OK;
2270}
2271
2272
danielk19776622cce2004-05-20 11:00:52 +00002273/*
drhbb4957f2008-03-20 14:03:29 +00002274** This array defines hard upper bounds on limit values. The
2275** initializer must be kept in sync with the SQLITE_LIMIT_*
2276** #defines in sqlite3.h.
2277*/
drhb1a6c3c2008-03-20 16:30:17 +00002278static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002279 SQLITE_MAX_LENGTH,
2280 SQLITE_MAX_SQL_LENGTH,
2281 SQLITE_MAX_COLUMN,
2282 SQLITE_MAX_EXPR_DEPTH,
2283 SQLITE_MAX_COMPOUND_SELECT,
2284 SQLITE_MAX_VDBE_OP,
2285 SQLITE_MAX_FUNCTION_ARG,
2286 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002287 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002288 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002289 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002290 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002291};
2292
2293/*
2294** Make sure the hard limits are set to reasonable values
2295*/
2296#if SQLITE_MAX_LENGTH<100
2297# error SQLITE_MAX_LENGTH must be at least 100
2298#endif
2299#if SQLITE_MAX_SQL_LENGTH<100
2300# error SQLITE_MAX_SQL_LENGTH must be at least 100
2301#endif
2302#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2303# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2304#endif
drhbb4957f2008-03-20 14:03:29 +00002305#if SQLITE_MAX_COMPOUND_SELECT<2
2306# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2307#endif
2308#if SQLITE_MAX_VDBE_OP<40
2309# error SQLITE_MAX_VDBE_OP must be at least 40
2310#endif
drhe82f5d02008-10-07 19:53:14 +00002311#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2312# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002313#endif
drhd08b2792014-07-22 15:33:31 +00002314#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2315# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002316#endif
drhbb4957f2008-03-20 14:03:29 +00002317#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2318# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2319#endif
drh70a8ca32008-08-21 18:49:27 +00002320#if SQLITE_MAX_COLUMN>32767
2321# error SQLITE_MAX_COLUMN must not exceed 32767
2322#endif
drh417168a2009-09-07 18:14:02 +00002323#if SQLITE_MAX_TRIGGER_DEPTH<1
2324# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2325#endif
drh111544c2014-08-29 16:20:47 +00002326#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2327# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2328#endif
drhbb4957f2008-03-20 14:03:29 +00002329
2330
2331/*
2332** Change the value of a limit. Report the old value.
2333** If an invalid limit index is supplied, report -1.
2334** Make no changes but still report the old value if the
2335** new limit is negative.
2336**
2337** A new lower limit does not shrink existing constructs.
2338** It merely prevents new constructs that exceed the limit
2339** from forming.
2340*/
2341int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2342 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002343
drh9ca95732014-10-24 00:35:58 +00002344#ifdef SQLITE_ENABLE_API_ARMOR
2345 if( !sqlite3SafetyCheckOk(db) ){
2346 (void)SQLITE_MISUSE_BKPT;
2347 return -1;
2348 }
2349#endif
drh4e93f5b2010-09-07 14:59:15 +00002350
2351 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2352 ** there is a hard upper bound set at compile-time by a C preprocessor
2353 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2354 ** "_MAX_".)
2355 */
2356 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2357 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2358 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2359 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2360 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2361 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2362 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2363 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2364 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2365 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2366 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2367 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002368 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2369 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002370
2371
drh521cc842008-04-15 02:36:33 +00002372 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002373 return -1;
2374 }
2375 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002376 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002377 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002378 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002379 }
2380 db->aLimit[limitId] = newLimit;
2381 }
drh4e93f5b2010-09-07 14:59:15 +00002382 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002383}
2384
2385/*
dan286ab7c2011-05-06 18:34:54 +00002386** This function is used to parse both URIs and non-URI filenames passed by the
2387** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2388** URIs specified as part of ATTACH statements.
2389**
2390** The first argument to this function is the name of the VFS to use (or
2391** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2392** query parameter. The second argument contains the URI (or non-URI filename)
2393** itself. When this function is called the *pFlags variable should contain
2394** the default flags to open the database handle with. The value stored in
2395** *pFlags may be updated before returning if the URI filename contains
2396** "cache=xxx" or "mode=xxx" query parameters.
2397**
2398** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2399** the VFS that should be used to open the database file. *pzFile is set to
2400** point to a buffer containing the name of the file to open. It is the
2401** responsibility of the caller to eventually call sqlite3_free() to release
2402** this buffer.
2403**
2404** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2405** may be set to point to a buffer containing an English language error
2406** message. It is the responsibility of the caller to eventually release
2407** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002408*/
2409int sqlite3ParseUri(
2410 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2411 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002412 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002413 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2414 char **pzFile, /* OUT: Filename component of URI */
2415 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2416){
dan78e9dd22011-05-03 10:22:32 +00002417 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002418 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002419 const char *zVfs = zDefaultVfs;
2420 char *zFile;
drhde941c32011-05-09 19:20:17 +00002421 char c;
dancd74b612011-04-22 19:37:32 +00002422 int nUri = sqlite3Strlen30(zUri);
2423
2424 assert( *pzErrMsg==0 );
2425
drh8790b6e2014-11-07 01:43:56 +00002426 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2427 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002428 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002429 ){
dan5de15372011-04-23 10:12:30 +00002430 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002431 int eState; /* Parser state when parsing URI */
2432 int iIn; /* Input character index */
2433 int iOut = 0; /* Output character index */
2434 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002435
dan286ab7c2011-05-06 18:34:54 +00002436 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2437 ** method that there may be extra parameters following the file-name. */
2438 flags |= SQLITE_OPEN_URI;
2439
2440 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002441 zFile = sqlite3_malloc(nByte);
2442 if( !zFile ) return SQLITE_NOMEM;
2443
drh869c0402013-08-07 23:15:52 +00002444 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002445#ifdef SQLITE_ALLOW_URI_AUTHORITY
2446 if( strncmp(zUri+5, "///", 3)==0 ){
2447 iIn = 7;
2448 /* The following condition causes URIs with five leading / characters
2449 ** like file://///host/path to be converted into UNCs like //host/path.
2450 ** The correct URI for that UNC has only two or four leading / characters
2451 ** file://host/path or file:////host/path. But 5 leading slashes is a
2452 ** common error, we are told, so we handle it as a special case. */
2453 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2454 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2455 iIn = 16;
2456 }
2457#else
dancd74b612011-04-22 19:37:32 +00002458 /* Discard the scheme and authority segments of the URI. */
2459 if( zUri[5]=='/' && zUri[6]=='/' ){
2460 iIn = 7;
2461 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002462 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2463 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2464 iIn-7, &zUri[7]);
2465 rc = SQLITE_ERROR;
2466 goto parse_uri_out;
2467 }
dancd74b612011-04-22 19:37:32 +00002468 }
drh869c0402013-08-07 23:15:52 +00002469#endif
dancd74b612011-04-22 19:37:32 +00002470
2471 /* Copy the filename and any query parameters into the zFile buffer.
2472 ** Decode %HH escape codes along the way.
2473 **
2474 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2475 ** on the parsing context. As follows:
2476 **
2477 ** 0: Parsing file-name.
2478 ** 1: Parsing name section of a name=value query parameter.
2479 ** 2: Parsing value section of a name=value query parameter.
2480 */
2481 eState = 0;
drhde941c32011-05-09 19:20:17 +00002482 while( (c = zUri[iIn])!=0 && c!='#' ){
2483 iIn++;
dancd74b612011-04-22 19:37:32 +00002484 if( c=='%'
2485 && sqlite3Isxdigit(zUri[iIn])
2486 && sqlite3Isxdigit(zUri[iIn+1])
2487 ){
dan6d49e252011-05-03 15:09:05 +00002488 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2489 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002490
dan6d49e252011-05-03 15:09:05 +00002491 assert( octet>=0 && octet<256 );
2492 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002493 /* This branch is taken when "%00" appears within the URI. In this
2494 ** case we ignore all text in the remainder of the path, name or
2495 ** value currently being parsed. So ignore the current character
2496 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002497 while( (c = zUri[iIn])!=0 && c!='#'
2498 && (eState!=0 || c!='?')
2499 && (eState!=1 || (c!='=' && c!='&'))
2500 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002501 ){
2502 iIn++;
2503 }
2504 continue;
dancd74b612011-04-22 19:37:32 +00002505 }
dan6d49e252011-05-03 15:09:05 +00002506 c = octet;
dan5de15372011-04-23 10:12:30 +00002507 }else if( eState==1 && (c=='&' || c=='=') ){
2508 if( zFile[iOut-1]==0 ){
2509 /* An empty option name. Ignore this option altogether. */
2510 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2511 continue;
2512 }
2513 if( c=='&' ){
2514 zFile[iOut++] = '\0';
2515 }else{
2516 eState = 2;
2517 }
dancd74b612011-04-22 19:37:32 +00002518 c = 0;
dan5de15372011-04-23 10:12:30 +00002519 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2520 c = 0;
dancd74b612011-04-22 19:37:32 +00002521 eState = 1;
dancd74b612011-04-22 19:37:32 +00002522 }
2523 zFile[iOut++] = c;
2524 }
2525 if( eState==1 ) zFile[iOut++] = '\0';
2526 zFile[iOut++] = '\0';
2527 zFile[iOut++] = '\0';
2528
2529 /* Check if there were any options specified that should be interpreted
2530 ** here. Options that are interpreted here include "vfs" and those that
2531 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002532 ** method. */
dan5de15372011-04-23 10:12:30 +00002533 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2534 while( zOpt[0] ){
2535 int nOpt = sqlite3Strlen30(zOpt);
2536 char *zVal = &zOpt[nOpt+1];
2537 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002538
dan286ab7c2011-05-06 18:34:54 +00002539 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002540 zVfs = zVal;
2541 }else{
2542 struct OpenMode {
2543 const char *z;
2544 int mode;
2545 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002546 char *zModeType = 0;
2547 int mask = 0;
2548 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002549
dan286ab7c2011-05-06 18:34:54 +00002550 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002551 static struct OpenMode aCacheMode[] = {
2552 { "shared", SQLITE_OPEN_SHAREDCACHE },
2553 { "private", SQLITE_OPEN_PRIVATECACHE },
2554 { 0, 0 }
2555 };
2556
2557 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2558 aMode = aCacheMode;
2559 limit = mask;
2560 zModeType = "cache";
2561 }
dan286ab7c2011-05-06 18:34:54 +00002562 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002563 static struct OpenMode aOpenMode[] = {
2564 { "ro", SQLITE_OPEN_READONLY },
2565 { "rw", SQLITE_OPEN_READWRITE },
2566 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002567 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002568 { 0, 0 }
2569 };
2570
drh9c67b2a2012-05-28 13:58:00 +00002571 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2572 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002573 aMode = aOpenMode;
2574 limit = mask & flags;
2575 zModeType = "access";
2576 }
2577
2578 if( aMode ){
2579 int i;
2580 int mode = 0;
2581 for(i=0; aMode[i].z; i++){
2582 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002583 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002584 mode = aMode[i].mode;
2585 break;
dancd74b612011-04-22 19:37:32 +00002586 }
2587 }
dan78e9dd22011-05-03 10:22:32 +00002588 if( mode==0 ){
2589 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2590 rc = SQLITE_ERROR;
2591 goto parse_uri_out;
2592 }
drh9c67b2a2012-05-28 13:58:00 +00002593 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002594 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2595 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002596 rc = SQLITE_PERM;
2597 goto parse_uri_out;
2598 }
2599 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002600 }
dancd74b612011-04-22 19:37:32 +00002601 }
dan5de15372011-04-23 10:12:30 +00002602
2603 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002604 }
2605
2606 }else{
2607 zFile = sqlite3_malloc(nUri+2);
2608 if( !zFile ) return SQLITE_NOMEM;
2609 memcpy(zFile, zUri, nUri);
2610 zFile[nUri] = '\0';
2611 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002612 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002613 }
2614
2615 *ppVfs = sqlite3_vfs_find(zVfs);
2616 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002617 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002618 rc = SQLITE_ERROR;
2619 }
2620 parse_uri_out:
2621 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002622 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002623 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002624 }
2625 *pFlags = flags;
2626 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002627 return rc;
dancd74b612011-04-22 19:37:32 +00002628}
2629
2630
2631/*
danielk19774ad17132004-05-21 01:47:26 +00002632** This routine does the work of opening a database on behalf of
2633** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002634** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002635*/
2636static int openDatabase(
2637 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002638 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002639 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002640 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002641){
dancd74b612011-04-22 19:37:32 +00002642 sqlite3 *db; /* Store allocated handle here */
2643 int rc; /* Return code */
2644 int isThreadsafe; /* True for threadsafe connections */
2645 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2646 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002647
drh9ca95732014-10-24 00:35:58 +00002648#ifdef SQLITE_ENABLE_API_ARMOR
2649 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2650#endif
drhe0d0f8e2009-04-28 04:47:31 +00002651 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002652#ifndef SQLITE_OMIT_AUTOINIT
2653 rc = sqlite3_initialize();
2654 if( rc ) return rc;
2655#endif
2656
dan78e9dd22011-05-03 10:22:32 +00002657 /* Only allow sensible combinations of bits in the flags argument.
2658 ** Throw an error if any non-sense combination is used. If we
2659 ** do not block illegal combinations here, it could trigger
2660 ** assert() statements in deeper layers. Sensible combinations
2661 ** are:
2662 **
2663 ** 1: SQLITE_OPEN_READONLY
2664 ** 2: SQLITE_OPEN_READWRITE
2665 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2666 */
2667 assert( SQLITE_OPEN_READONLY == 0x01 );
2668 assert( SQLITE_OPEN_READWRITE == 0x02 );
2669 assert( SQLITE_OPEN_CREATE == 0x04 );
2670 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2671 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2672 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002673 if( ((1<<(flags&7)) & 0x46)==0 ){
2674 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2675 }
dan78e9dd22011-05-03 10:22:32 +00002676
drh039963a2008-09-03 00:43:15 +00002677 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002678 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002679 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2680 isThreadsafe = 0;
2681 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2682 isThreadsafe = 1;
2683 }else{
2684 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002685 }
drhf1f12682009-09-09 14:17:52 +00002686 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002687 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002688 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2689 flags |= SQLITE_OPEN_SHAREDCACHE;
2690 }
danielk19779a6284c2008-07-10 17:52:49 +00002691
drhb25a9f42009-05-12 13:35:11 +00002692 /* Remove harmful bits from the flags parameter
2693 **
2694 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2695 ** dealt with in the previous code block. Besides these, the only
2696 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002697 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2698 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002699 ** off all other flags.
2700 */
drha4267dc2008-02-19 15:20:44 +00002701 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002702 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002703 SQLITE_OPEN_MAIN_DB |
2704 SQLITE_OPEN_TEMP_DB |
2705 SQLITE_OPEN_TRANSIENT_DB |
2706 SQLITE_OPEN_MAIN_JOURNAL |
2707 SQLITE_OPEN_TEMP_JOURNAL |
2708 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002709 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002710 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002711 SQLITE_OPEN_FULLMUTEX |
2712 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002713 );
2714
danielk19774ad17132004-05-21 01:47:26 +00002715 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002716 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002717 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002718 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002719 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2720 if( db->mutex==0 ){
2721 sqlite3_free(db);
2722 db = 0;
2723 goto opendb_out;
2724 }
drh605264d2007-08-21 15:13:19 +00002725 }
drh27641702007-08-22 02:56:42 +00002726 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002727 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002728 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002729 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002730 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002731
drhbb4957f2008-03-20 14:03:29 +00002732 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2733 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002734 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002735 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002736 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002737 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002738 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002739 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002740 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002741#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002742 | SQLITE_AutoIndex
2743#endif
drh883ad042015-02-19 00:29:11 +00002744#if SQLITE_DEFAULT_CKPTFULLFSYNC
2745 | SQLITE_CkptFullFSync
2746#endif
drh76fe8032006-07-11 14:17:51 +00002747#if SQLITE_DEFAULT_FILE_FORMAT<4
2748 | SQLITE_LegacyFileFmt
2749#endif
drh56424db2007-03-27 22:24:11 +00002750#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2751 | SQLITE_LoadExtension
2752#endif
dan5bde73c2009-09-01 17:11:07 +00002753#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002754 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002755#endif
drha4bfd7f2010-12-09 19:15:17 +00002756#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2757 | SQLITE_ForeignKeys
2758#endif
drhf5471922014-12-09 15:12:11 +00002759#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
2760 | SQLITE_ReverseOrder
2761#endif
drh76fe8032006-07-11 14:17:51 +00002762 ;
drhe61922a2009-05-02 13:29:37 +00002763 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002764#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002765 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002766#endif
danielk1977da184232006-01-05 11:34:32 +00002767
danielk19770202b292004-06-09 09:55:16 +00002768 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2769 ** and UTF-16, so add a version for each to avoid any unnecessary
2770 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00002771 **
2772 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
2773 ** functions:
danielk19770202b292004-06-09 09:55:16 +00002774 */
drh4dd65e02011-11-29 14:46:56 +00002775 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2776 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2777 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00002778 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00002779 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002780 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002781 goto opendb_out;
2782 }
drh5e3b49b2014-11-20 19:22:26 +00002783 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
2784 ** strings is BINARY.
2785 */
drhc4a64fa2009-05-11 20:53:28 +00002786 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002787 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002788
dancd74b612011-04-22 19:37:32 +00002789 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002790 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002791 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2792 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002793 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
drh13f40da2014-08-22 18:00:11 +00002794 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002795 sqlite3_free(zErrMsg);
2796 goto opendb_out;
2797 }
2798
danielk19774ad17132004-05-21 01:47:26 +00002799 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002800 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002801 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002802 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002803 if( rc==SQLITE_IOERR_NOMEM ){
2804 rc = SQLITE_NOMEM;
2805 }
drh13f40da2014-08-22 18:00:11 +00002806 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002807 goto opendb_out;
2808 }
dan0235a032014-12-08 20:20:16 +00002809 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002810 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00002811 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00002812 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002813 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002814
danielk197753c0f742005-03-29 03:10:59 +00002815 /* The default safety_level for the main database is 'full'; for the temp
2816 ** database it is 'NONE'. This matches the pager layer defaults.
2817 */
2818 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002819 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002820 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002821 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002822
danielk1977832a58a2007-06-22 15:21:15 +00002823 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002824 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002825 goto opendb_out;
2826 }
2827
danielk19778e227872004-06-07 07:52:17 +00002828 /* Register all built-in functions, but do not attempt to read the
2829 ** database schema yet. This is delayed until the first time the database
2830 ** is accessed.
2831 */
drh13f40da2014-08-22 18:00:11 +00002832 sqlite3Error(db, SQLITE_OK);
danielk1977832a58a2007-06-22 15:21:15 +00002833 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002834
drh1409be62006-08-23 20:07:20 +00002835 /* Load automatic extensions - extensions that have been registered
2836 ** using the sqlite3_automatic_extension() API.
2837 */
drh7aaa8782009-05-20 02:40:45 +00002838 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002839 if( rc==SQLITE_OK ){
2840 sqlite3AutoLoadExtensions(db);
2841 rc = sqlite3_errcode(db);
2842 if( rc!=SQLITE_OK ){
2843 goto opendb_out;
2844 }
danielk1977832a58a2007-06-22 15:21:15 +00002845 }
drh1409be62006-08-23 20:07:20 +00002846
drhaa29c132006-09-02 13:58:06 +00002847#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002848 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002849 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002850 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002851 }
2852#endif
2853
shessa26cf572006-10-19 20:27:58 +00002854#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002855 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002856 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002857 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002858 }
2859#endif
2860
shess69c4ae22007-08-20 17:37:47 +00002861#ifdef SQLITE_ENABLE_FTS3
2862 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002863 rc = sqlite3Fts3Init(db);
2864 }
2865#endif
2866
danielk197783852ac2007-05-06 16:04:11 +00002867#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002868 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002869 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002870 }
2871#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002872
2873#ifdef SQLITE_ENABLE_RTREE
2874 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002875 rc = sqlite3RtreeInit(db);
2876 }
2877#endif
2878
drh8fd5bd32007-04-02 16:40:37 +00002879 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2880 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2881 ** mode. Doing nothing at all also makes NORMAL the default.
2882 */
2883#ifdef SQLITE_DEFAULT_LOCKING_MODE
2884 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2885 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2886 SQLITE_DEFAULT_LOCKING_MODE);
2887#endif
2888
drh13f40da2014-08-22 18:00:11 +00002889 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00002890
drh633e6d52008-07-28 19:34:53 +00002891 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002892 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2893 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002894
dan5a299f92010-05-03 11:05:08 +00002895 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002896
danielk19774ad17132004-05-21 01:47:26 +00002897opendb_out:
dancd74b612011-04-22 19:37:32 +00002898 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002899 if( db ){
drh3ba689d2015-03-03 14:00:11 +00002900 assert( db->mutex!=0 || isThreadsafe==0
2901 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002902 sqlite3_mutex_leave(db->mutex);
2903 }
danielk197759633ae2008-08-27 19:01:57 +00002904 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002905 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002906 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002907 sqlite3_close(db);
2908 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002909 }else if( rc!=SQLITE_OK ){
2910 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002911 }
danielk19774ad17132004-05-21 01:47:26 +00002912 *ppDb = db;
danac455932012-11-26 19:50:41 +00002913#ifdef SQLITE_ENABLE_SQLLOG
2914 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002915 /* Opening a db handle. Fourth parameter is passed 0. */
2916 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2917 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002918 }
2919#endif
danielk197754f01982006-01-18 15:25:17 +00002920 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002921}
2922
2923/*
2924** Open a new database handle.
2925*/
danielk197780290862004-05-22 09:21:21 +00002926int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002927 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002928 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002929){
drh605264d2007-08-21 15:13:19 +00002930 return openDatabase(zFilename, ppDb,
2931 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2932}
2933int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002934 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002935 sqlite3 **ppDb, /* OUT: SQLite db handle */
2936 int flags, /* Flags */
2937 const char *zVfs /* Name of VFS module to use */
2938){
drh522c26f2011-05-07 14:40:29 +00002939 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002940}
2941
drh6c626082004-11-14 21:56:29 +00002942#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002943/*
2944** Open a new database handle.
2945*/
2946int sqlite3_open16(
2947 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002948 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002949){
danielk1977bfd6cce2004-06-18 04:24:54 +00002950 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002951 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002952 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002953
drh9ca95732014-10-24 00:35:58 +00002954#ifdef SQLITE_ENABLE_API_ARMOR
2955 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2956#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00002957 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002958#ifndef SQLITE_OMIT_AUTOINIT
2959 rc = sqlite3_initialize();
2960 if( rc ) return rc;
2961#endif
drh9ca95732014-10-24 00:35:58 +00002962 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00002963 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002964 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2965 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002966 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002967 rc = openDatabase(zFilename8, ppDb,
2968 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002969 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002970 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00002971 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002972 }
drh40257ff2008-06-13 18:24:27 +00002973 }else{
2974 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002975 }
danielk19777ddad962005-12-12 06:53:03 +00002976 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002977
danielk197754f01982006-01-18 15:25:17 +00002978 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002979}
drh6c626082004-11-14 21:56:29 +00002980#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002981
danielk1977106bb232004-05-21 10:08:53 +00002982/*
danielk1977d8123362004-06-12 09:25:12 +00002983** Register a new collation sequence with the database handle db.
2984*/
danielk19770202b292004-06-09 09:55:16 +00002985int sqlite3_create_collation(
2986 sqlite3* db,
2987 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002988 int enc,
danielk19770202b292004-06-09 09:55:16 +00002989 void* pCtx,
2990 int(*xCompare)(void*,int,const void*,int,const void*)
2991){
drh4f81bbb2014-10-23 01:01:26 +00002992 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002993}
2994
2995/*
2996** Register a new collation sequence with the database handle db.
2997*/
danielk1977a393c032007-05-07 14:58:53 +00002998int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002999 sqlite3* db,
3000 const char *zName,
3001 int enc,
3002 void* pCtx,
3003 int(*xCompare)(void*,int,const void*,int,const void*),
3004 void(*xDel)(void*)
3005){
3006 int rc;
drh9ca95732014-10-24 00:35:58 +00003007
3008#ifdef SQLITE_ENABLE_API_ARMOR
3009 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3010#endif
drhe30f4422007-08-21 16:15:55 +00003011 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003012 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003013 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003014 rc = sqlite3ApiExit(db, rc);
3015 sqlite3_mutex_leave(db->mutex);
3016 return rc;
danielk19770202b292004-06-09 09:55:16 +00003017}
3018
drh6c626082004-11-14 21:56:29 +00003019#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003020/*
3021** Register a new collation sequence with the database handle db.
3022*/
danielk19770202b292004-06-09 09:55:16 +00003023int sqlite3_create_collation16(
3024 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003025 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003026 int enc,
danielk19770202b292004-06-09 09:55:16 +00003027 void* pCtx,
3028 int(*xCompare)(void*,int,const void*,int,const void*)
3029){
danielk19779a30cf62006-01-18 04:26:07 +00003030 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003031 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003032
3033#ifdef SQLITE_ENABLE_API_ARMOR
3034 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3035#endif
drhe30f4422007-08-21 16:15:55 +00003036 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003037 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003038 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003039 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003040 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003041 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003042 }
drhe30f4422007-08-21 16:15:55 +00003043 rc = sqlite3ApiExit(db, rc);
3044 sqlite3_mutex_leave(db->mutex);
3045 return rc;
danielk19770202b292004-06-09 09:55:16 +00003046}
drh6c626082004-11-14 21:56:29 +00003047#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003048
danielk1977d8123362004-06-12 09:25:12 +00003049/*
3050** Register a collation sequence factory callback with the database handle
3051** db. Replace any previously installed collation sequence factory.
3052*/
danielk19777cedc8d2004-06-10 10:50:08 +00003053int sqlite3_collation_needed(
3054 sqlite3 *db,
3055 void *pCollNeededArg,
3056 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3057){
drh9ca95732014-10-24 00:35:58 +00003058#ifdef SQLITE_ENABLE_API_ARMOR
3059 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3060#endif
drhe30f4422007-08-21 16:15:55 +00003061 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003062 db->xCollNeeded = xCollNeeded;
3063 db->xCollNeeded16 = 0;
3064 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003065 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003066 return SQLITE_OK;
3067}
danielk1977d8123362004-06-12 09:25:12 +00003068
drh6c626082004-11-14 21:56:29 +00003069#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003070/*
3071** Register a collation sequence factory callback with the database handle
3072** db. Replace any previously installed collation sequence factory.
3073*/
danielk19777cedc8d2004-06-10 10:50:08 +00003074int sqlite3_collation_needed16(
3075 sqlite3 *db,
3076 void *pCollNeededArg,
3077 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3078){
drh9ca95732014-10-24 00:35:58 +00003079#ifdef SQLITE_ENABLE_API_ARMOR
3080 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3081#endif
drhe30f4422007-08-21 16:15:55 +00003082 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003083 db->xCollNeeded = 0;
3084 db->xCollNeeded16 = xCollNeeded16;
3085 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003086 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003087 return SQLITE_OK;
3088}
drh6c626082004-11-14 21:56:29 +00003089#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003090
shaneeec556d2008-10-12 00:27:53 +00003091#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003092/*
danielk19777ddad962005-12-12 06:53:03 +00003093** This function is now an anachronism. It used to be used to recover from a
3094** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003095*/
drh7d97efb2007-10-12 19:35:48 +00003096int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003097 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003098}
3099#endif
drh3e1d8e62005-05-26 16:23:34 +00003100
3101/*
3102** Test to see whether or not the database connection is in autocommit
3103** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3104** by default. Autocommit is disabled by a BEGIN statement and reenabled
3105** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003106*/
3107int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003108#ifdef SQLITE_ENABLE_API_ARMOR
3109 if( !sqlite3SafetyCheckOk(db) ){
3110 (void)SQLITE_MISUSE_BKPT;
3111 return 0;
3112 }
3113#endif
drh3e1d8e62005-05-26 16:23:34 +00003114 return db->autoCommit;
3115}
drh49285702005-09-17 15:20:26 +00003116
drh49285702005-09-17 15:20:26 +00003117/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003118** The following routines are substitutes for constants SQLITE_CORRUPT,
drh9978c972010-02-23 17:36:32 +00003119** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003120** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003121**
3122** 1. Serve as a convenient place to set a breakpoint in a debugger
3123** to detect when version error conditions occurs.
3124**
3125** 2. Invoke sqlite3_log() to provide the source code location where
3126** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003127*/
drh9978c972010-02-23 17:36:32 +00003128int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003129 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00003130 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00003131 "database corruption at line %d of [%.10s]",
3132 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00003133 return SQLITE_CORRUPT;
3134}
drh9978c972010-02-23 17:36:32 +00003135int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003136 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003137 sqlite3_log(SQLITE_MISUSE,
3138 "misuse at line %d of [%.10s]",
3139 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003140 return SQLITE_MISUSE;
3141}
3142int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003143 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003144 sqlite3_log(SQLITE_CANTOPEN,
3145 "cannot open file at line %d of [%.10s]",
3146 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003147 return SQLITE_CANTOPEN;
3148}
3149
drh7c1817e2006-01-10 13:58:48 +00003150
shaneeec556d2008-10-12 00:27:53 +00003151#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003152/*
3153** This is a convenience routine that makes sure that all thread-specific
3154** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003155**
3156** SQLite no longer uses thread-specific data so this routine is now a
3157** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003158*/
3159void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003160}
shaneeec556d2008-10-12 00:27:53 +00003161#endif
danielk1977deb802c2006-02-09 13:43:28 +00003162
3163/*
3164** Return meta information about a specific column of a database table.
3165** See comment in sqlite3.h (sqlite.h.in) for details.
3166*/
danielk1977deb802c2006-02-09 13:43:28 +00003167int sqlite3_table_column_metadata(
3168 sqlite3 *db, /* Connection handle */
3169 const char *zDbName, /* Database name or NULL */
3170 const char *zTableName, /* Table name */
3171 const char *zColumnName, /* Column name */
3172 char const **pzDataType, /* OUTPUT: Declared data type */
3173 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3174 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3175 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003176 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003177){
3178 int rc;
3179 char *zErrMsg = 0;
3180 Table *pTab = 0;
3181 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003182 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003183 char const *zDataType = 0;
3184 char const *zCollSeq = 0;
3185 int notnull = 0;
3186 int primarykey = 0;
3187 int autoinc = 0;
3188
drh96c707a2015-02-13 16:36:14 +00003189
3190#ifdef SQLITE_ENABLE_API_ARMOR
3191 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3192 return SQLITE_MISUSE_BKPT;
3193 }
3194#endif
3195
danielk1977deb802c2006-02-09 13:43:28 +00003196 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003197 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003198 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003199 rc = sqlite3Init(db, &zErrMsg);
3200 if( SQLITE_OK!=rc ){
3201 goto error_out;
3202 }
3203
3204 /* Locate the table in question */
3205 pTab = sqlite3FindTable(db, zTableName, zDbName);
3206 if( !pTab || pTab->pSelect ){
3207 pTab = 0;
3208 goto error_out;
3209 }
3210
3211 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003212 if( zColumnName==0 ){
3213 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003214 }else{
3215 for(iCol=0; iCol<pTab->nCol; iCol++){
3216 pCol = &pTab->aCol[iCol];
3217 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3218 break;
3219 }
3220 }
3221 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003222 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3223 iCol = pTab->iPKey;
3224 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3225 }else{
3226 pTab = 0;
3227 goto error_out;
3228 }
danielk1977deb802c2006-02-09 13:43:28 +00003229 }
3230 }
3231
3232 /* The following block stores the meta information that will be returned
3233 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3234 ** and autoinc. At this point there are two possibilities:
3235 **
3236 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3237 ** and there is no explicitly declared IPK column.
3238 **
3239 ** 2. The table is not a view and the column name identified an
3240 ** explicitly declared column. Copy meta information from *pCol.
3241 */
3242 if( pCol ){
3243 zDataType = pCol->zType;
3244 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003245 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003246 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003247 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003248 }else{
3249 zDataType = "INTEGER";
3250 primarykey = 1;
3251 }
3252 if( !zCollSeq ){
3253 zCollSeq = "BINARY";
3254 }
3255
3256error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003257 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003258
3259 /* Whether the function call succeeded or failed, set the output parameters
3260 ** to whatever their local counterparts contain. If an error did occur,
3261 ** this has the effect of zeroing all output parameters.
3262 */
3263 if( pzDataType ) *pzDataType = zDataType;
3264 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3265 if( pNotNull ) *pNotNull = notnull;
3266 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3267 if( pAutoinc ) *pAutoinc = autoinc;
3268
3269 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003270 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003271 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003272 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003273 rc = SQLITE_ERROR;
3274 }
drh13f40da2014-08-22 18:00:11 +00003275 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003276 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003277 rc = sqlite3ApiExit(db, rc);
3278 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003279 return rc;
3280}
3281
3282/*
3283** Sleep for a little while. Return the amount of time slept.
3284*/
3285int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003286 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003287 int rc;
drhd677b3d2007-08-20 22:48:41 +00003288 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003289 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003290
3291 /* This function works in milliseconds, but the underlying OsSleep()
3292 ** API uses microseconds. Hence the 1000's.
3293 */
drhe30f4422007-08-21 16:15:55 +00003294 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003295 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003296}
drh4ac285a2006-09-15 07:28:50 +00003297
3298/*
3299** Enable or disable the extended result codes.
3300*/
3301int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003302#ifdef SQLITE_ENABLE_API_ARMOR
3303 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3304#endif
drhe30f4422007-08-21 16:15:55 +00003305 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003306 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003307 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003308 return SQLITE_OK;
3309}
drhcc6bb3e2007-08-31 16:11:35 +00003310
3311/*
3312** Invoke the xFileControl method on a particular database.
3313*/
3314int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3315 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003316 Btree *pBtree;
3317
drh9ca95732014-10-24 00:35:58 +00003318#ifdef SQLITE_ENABLE_API_ARMOR
3319 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3320#endif
drhcc6bb3e2007-08-31 16:11:35 +00003321 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003322 pBtree = sqlite3DbNameToBtree(db, zDbName);
3323 if( pBtree ){
3324 Pager *pPager;
3325 sqlite3_file *fd;
3326 sqlite3BtreeEnter(pBtree);
3327 pPager = sqlite3BtreePager(pBtree);
3328 assert( pPager!=0 );
3329 fd = sqlite3PagerFile(pPager);
3330 assert( fd!=0 );
3331 if( op==SQLITE_FCNTL_FILE_POINTER ){
3332 *(sqlite3_file**)pArg = fd;
3333 rc = SQLITE_OK;
3334 }else if( fd->pMethods ){
3335 rc = sqlite3OsFileControl(fd, op, pArg);
3336 }else{
3337 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003338 }
drh421377e2012-03-15 21:28:54 +00003339 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003340 }
3341 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003342 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003343}
drhed13d982008-01-31 14:43:24 +00003344
3345/*
3346** Interface to the testing logic.
3347*/
3348int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003349 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003350#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003351 va_list ap;
drhed13d982008-01-31 14:43:24 +00003352 va_start(ap, op);
3353 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003354
3355 /*
drh984bfaa2008-03-19 16:08:53 +00003356 ** Save the current state of the PRNG.
3357 */
drh2fa18682008-03-19 14:15:34 +00003358 case SQLITE_TESTCTRL_PRNG_SAVE: {
3359 sqlite3PrngSaveState();
3360 break;
3361 }
drh984bfaa2008-03-19 16:08:53 +00003362
3363 /*
3364 ** Restore the state of the PRNG to the last state saved using
3365 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3366 ** this verb acts like PRNG_RESET.
3367 */
drh2fa18682008-03-19 14:15:34 +00003368 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3369 sqlite3PrngRestoreState();
3370 break;
3371 }
drh984bfaa2008-03-19 16:08:53 +00003372
3373 /*
3374 ** Reset the PRNG back to its uninitialized state. The next call
3375 ** to sqlite3_randomness() will reseed the PRNG using a single call
3376 ** to the xRandomness method of the default VFS.
3377 */
drh2fa18682008-03-19 14:15:34 +00003378 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003379 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003380 break;
3381 }
drh3088d592008-03-21 16:45:47 +00003382
3383 /*
3384 ** sqlite3_test_control(BITVEC_TEST, size, program)
3385 **
3386 ** Run a test against a Bitvec object of size. The program argument
3387 ** is an array of integers that defines the test. Return -1 on a
3388 ** memory allocation error, 0 on success, or non-zero for an error.
3389 ** See the sqlite3BitvecBuiltinTest() for additional information.
3390 */
3391 case SQLITE_TESTCTRL_BITVEC_TEST: {
3392 int sz = va_arg(ap, int);
3393 int *aProg = va_arg(ap, int*);
3394 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3395 break;
3396 }
danielk19772d1d86f2008-06-20 14:59:51 +00003397
3398 /*
drhc007f612014-05-16 14:17:01 +00003399 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3400 **
3401 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3402 ** if xCallback is not NULL.
3403 **
3404 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3405 ** is called immediately after installing the new callback and the return
3406 ** value from sqlite3FaultSim(0) becomes the return from
3407 ** sqlite3_test_control().
3408 */
3409 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003410 /* MSVC is picky about pulling func ptrs from va lists.
3411 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003412 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003413 */
3414 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003415 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003416 rc = sqlite3FaultSim(0);
3417 break;
3418 }
3419
3420 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003421 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3422 **
3423 ** Register hooks to call to indicate which malloc() failures
3424 ** are benign.
3425 */
3426 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003427 typedef void (*void_function)(void);
3428 void_function xBenignBegin;
3429 void_function xBenignEnd;
3430 xBenignBegin = va_arg(ap, void_function);
3431 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003432 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3433 break;
3434 }
drhc7a3bb92009-02-05 16:31:45 +00003435
3436 /*
drhf3af63f2009-05-09 18:59:42 +00003437 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003438 **
3439 ** Set the PENDING byte to the value in the argument, if X>0.
3440 ** Make no changes if X==0. Return the value of the pending byte
3441 ** as it existing before this routine was called.
3442 **
3443 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3444 ** an incompatible database file format. Changing the PENDING byte
3445 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003446 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003447 */
3448 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003449 rc = PENDING_BYTE;
3450#ifndef SQLITE_OMIT_WSD
3451 {
3452 unsigned int newVal = va_arg(ap, unsigned int);
3453 if( newVal ) sqlite3PendingByte = newVal;
3454 }
3455#endif
drhc7a3bb92009-02-05 16:31:45 +00003456 break;
3457 }
drhf3af63f2009-05-09 18:59:42 +00003458
3459 /*
3460 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3461 **
3462 ** This action provides a run-time test to see whether or not
3463 ** assert() was enabled at compile-time. If X is true and assert()
3464 ** is enabled, then the return value is true. If X is true and
3465 ** assert() is disabled, then the return value is zero. If X is
3466 ** false and assert() is enabled, then the assertion fires and the
3467 ** process aborts. If X is false and assert() is disabled, then the
3468 ** return value is zero.
3469 */
3470 case SQLITE_TESTCTRL_ASSERT: {
3471 volatile int x = 0;
3472 assert( (x = va_arg(ap,int))!=0 );
3473 rc = x;
3474 break;
3475 }
3476
3477
3478 /*
3479 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3480 **
3481 ** This action provides a run-time test to see how the ALWAYS and
3482 ** NEVER macros were defined at compile-time.
3483 **
3484 ** The return value is ALWAYS(X).
3485 **
3486 ** The recommended test is X==2. If the return value is 2, that means
3487 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3488 ** default setting. If the return value is 1, then ALWAYS() is either
3489 ** hard-coded to true or else it asserts if its argument is false.
3490 ** The first behavior (hard-coded to true) is the case if
3491 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3492 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3493 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3494 **
3495 ** The run-time test procedure might look something like this:
3496 **
3497 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3498 ** // ALWAYS() and NEVER() are no-op pass-through macros
3499 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3500 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3501 ** }else{
3502 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3503 ** }
3504 */
3505 case SQLITE_TESTCTRL_ALWAYS: {
3506 int x = va_arg(ap,int);
3507 rc = ALWAYS(x);
3508 break;
3509 }
drhc046e3e2009-07-15 11:26:44 +00003510
drh2cf4acb2014-04-18 00:06:02 +00003511 /*
3512 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3513 **
3514 ** The integer returned reveals the byte-order of the computer on which
3515 ** SQLite is running:
3516 **
3517 ** 1 big-endian, determined at run-time
3518 ** 10 little-endian, determined at run-time
3519 ** 432101 big-endian, determined at compile-time
3520 ** 123410 little-endian, determined at compile-time
3521 */
3522 case SQLITE_TESTCTRL_BYTEORDER: {
3523 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3524 break;
3525 }
3526
drhc046e3e2009-07-15 11:26:44 +00003527 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3528 **
3529 ** Set the nReserve size to N for the main database on the database
3530 ** connection db.
3531 */
3532 case SQLITE_TESTCTRL_RESERVE: {
3533 sqlite3 *db = va_arg(ap, sqlite3*);
3534 int x = va_arg(ap,int);
3535 sqlite3_mutex_enter(db->mutex);
3536 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3537 sqlite3_mutex_leave(db->mutex);
3538 break;
3539 }
3540
drh07096f62009-12-22 23:52:32 +00003541 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3542 **
3543 ** Enable or disable various optimizations for testing purposes. The
3544 ** argument N is a bitmask of optimizations to be disabled. For normal
3545 ** operation N should be 0. The idea is that a test program (like the
3546 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3547 ** with various optimizations disabled to verify that the same answer
3548 ** is obtained in every case.
3549 */
3550 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3551 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003552 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003553 break;
3554 }
3555
drh0e857732010-01-02 03:21:35 +00003556#ifdef SQLITE_N_KEYWORD
3557 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3558 **
3559 ** If zWord is a keyword recognized by the parser, then return the
3560 ** number of keywords. Or if zWord is not a keyword, return 0.
3561 **
3562 ** This test feature is only available in the amalgamation since
3563 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3564 ** is built using separate source files.
3565 */
3566 case SQLITE_TESTCTRL_ISKEYWORD: {
3567 const char *zWord = va_arg(ap, const char*);
3568 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003569 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003570 break;
3571 }
3572#endif
3573
drhbadc9802010-08-27 17:16:44 +00003574 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3575 **
3576 ** Pass pFree into sqlite3ScratchFree().
3577 ** If sz>0 then allocate a scratch buffer into pNew.
3578 */
3579 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3580 void *pFree, **ppNew;
3581 int sz;
3582 sz = va_arg(ap, int);
3583 ppNew = va_arg(ap, void**);
3584 pFree = va_arg(ap, void*);
3585 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3586 sqlite3ScratchFree(pFree);
3587 break;
3588 }
3589
danc17d6962011-06-21 12:47:30 +00003590 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3591 **
3592 ** If parameter onoff is non-zero, configure the wrappers so that all
3593 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3594 ** undo this setting.
3595 */
3596 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3597 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3598 break;
3599 }
3600
drh09fe6142013-11-29 15:06:27 +00003601 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3602 **
3603 ** Set or clear a flag that indicates that the database file is always well-
3604 ** formed and never corrupt. This flag is clear by default, indicating that
3605 ** database files might have arbitrary corruption. Setting the flag during
3606 ** testing causes certain assert() statements in the code to be activated
3607 ** that demonstrat invariants on well-formed database files.
3608 */
3609 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003610 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003611 break;
3612 }
3613
drh688852a2014-02-17 22:40:43 +00003614
3615 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3616 **
3617 ** Set the VDBE coverage callback function to xCallback with context
3618 ** pointer ptr.
3619 */
3620 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3621#ifdef SQLITE_VDBE_COVERAGE
3622 typedef void (*branch_callback)(void*,int,u8,u8);
3623 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3624 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3625#endif
3626 break;
3627 }
3628
dan8930c2a2014-04-03 16:25:29 +00003629 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3630 case SQLITE_TESTCTRL_SORTER_MMAP: {
3631 sqlite3 *db = va_arg(ap, sqlite3*);
3632 db->nMaxSorterMmap = va_arg(ap, int);
3633 break;
3634 }
3635
drh43cfc232014-07-29 14:09:21 +00003636 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3637 **
3638 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3639 ** not.
3640 */
3641 case SQLITE_TESTCTRL_ISINIT: {
3642 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3643 break;
3644 }
drh8964b342015-01-29 17:54:52 +00003645
drh3ba689d2015-03-03 14:00:11 +00003646 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00003647 **
drh1ffede82015-01-30 20:59:27 +00003648 ** This test control is used to create imposter tables. "db" is a pointer
3649 ** to the database connection. dbName is the database name (ex: "main" or
3650 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
3651 ** or off. "tnum" is the root page of the b-tree to which the imposter
3652 ** table should connect.
3653 **
3654 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00003655 ** run a single CREATE TABLE statement to construct the imposter table in
3656 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00003657 **
3658 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
3659 ** the schema to be reparsed the next time it is needed. This has the
3660 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00003661 */
drh1ffede82015-01-30 20:59:27 +00003662 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00003663 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00003664 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00003665 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
3666 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00003667 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00003668 if( db->init.busy==0 && db->init.newTnum>0 ){
3669 sqlite3ResetAllSchemasOfConnection(db);
3670 }
drh8fb15e32015-02-04 20:56:49 +00003671 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00003672 break;
3673 }
drhed13d982008-01-31 14:43:24 +00003674 }
3675 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003676#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003677 return rc;
drhed13d982008-01-31 14:43:24 +00003678}
drhcc487d12011-05-17 18:53:08 +00003679
3680/*
3681** This is a utility routine, useful to VFS implementations, that checks
3682** to see if a database file was a URI that contained a specific query
3683** parameter, and if so obtains the value of the query parameter.
3684**
3685** The zFilename argument is the filename pointer passed into the xOpen()
3686** method of a VFS implementation. The zParam argument is the name of the
3687** query parameter we seek. This routine returns the value of the zParam
3688** parameter if it exists. If the parameter does not exist, this routine
3689** returns a NULL pointer.
3690*/
3691const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003692 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003693 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003694 while( zFilename[0] ){
3695 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003696 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003697 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003698 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003699 }
3700 return 0;
3701}
drh283829c2011-11-17 00:56:20 +00003702
3703/*
drh92913722011-12-23 00:07:33 +00003704** Return a boolean value for a query parameter.
3705*/
3706int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3707 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003708 bDflt = bDflt!=0;
3709 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003710}
3711
3712/*
3713** Return a 64-bit integer value for a query parameter.
3714*/
3715sqlite3_int64 sqlite3_uri_int64(
3716 const char *zFilename, /* Filename as passed to xOpen */
3717 const char *zParam, /* URI parameter sought */
3718 sqlite3_int64 bDflt /* return if parameter is missing */
3719){
3720 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3721 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003722 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003723 bDflt = v;
3724 }
3725 return bDflt;
3726}
3727
3728/*
drh421377e2012-03-15 21:28:54 +00003729** Return the Btree pointer identified by zDbName. Return NULL if not found.
3730*/
3731Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3732 int i;
3733 for(i=0; i<db->nDb; i++){
3734 if( db->aDb[i].pBt
3735 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3736 ){
3737 return db->aDb[i].pBt;
3738 }
3739 }
3740 return 0;
3741}
3742
3743/*
drh283829c2011-11-17 00:56:20 +00003744** Return the filename of the database associated with a database
3745** connection.
3746*/
3747const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003748 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003749#ifdef SQLITE_ENABLE_API_ARMOR
3750 if( !sqlite3SafetyCheckOk(db) ){
3751 (void)SQLITE_MISUSE_BKPT;
3752 return 0;
3753 }
3754#endif
mistachkincd54bab2014-12-20 21:14:14 +00003755 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00003756 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3757}
3758
3759/*
3760** Return 1 if database is read-only or 0 if read/write. Return -1 if
3761** no such database exists.
3762*/
3763int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003764 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003765#ifdef SQLITE_ENABLE_API_ARMOR
3766 if( !sqlite3SafetyCheckOk(db) ){
3767 (void)SQLITE_MISUSE_BKPT;
3768 return -1;
3769 }
3770#endif
mistachkincd54bab2014-12-20 21:14:14 +00003771 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003772 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003773}