blob: 5e6ff16543dcc3fadad5020642dd64adb533d753 [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
dan21540ae2017-12-08 16:23:38 +000025#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
danielk19771c826652008-09-08 08:08:09 +000026# include "sqliteicu.h"
27#endif
drhc306e082015-10-08 23:37:00 +000028#ifdef SQLITE_ENABLE_JSON1
29int sqlite3Json1Init(sqlite3*);
30#endif
drhc6603af2017-06-29 14:33:51 +000031#ifdef SQLITE_ENABLE_STMTVTAB
32int sqlite3StmtVtabInit(sqlite3*);
drhf00f5302017-06-28 15:47:29 +000033#endif
drhc306e082015-10-08 23:37:00 +000034#ifdef SQLITE_ENABLE_FTS5
35int sqlite3Fts5Init(sqlite3*);
36#endif
drh75897232000-05-29 14:26:00 +000037
drhb3190c12008-12-08 21:37:14 +000038#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000039/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
40** contains the text of SQLITE_VERSION macro.
41*/
danielk197724b03fd2004-05-10 10:34:34 +000042const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000043#endif
drh9f129f42010-08-31 15:27:32 +000044
45/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
46** a pointer to the to the sqlite3_version[] string constant.
47*/
drh4aec8b62004-08-28 16:19:00 +000048const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000049
drhc6aa3812017-10-04 18:26:44 +000050/* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
drh9f129f42010-08-31 15:27:32 +000051** pointer to a string constant whose value is the same as the
drhc6aa3812017-10-04 18:26:44 +000052** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
53** an edited copy of the amalgamation, then the last four characters of
54** the hash might be different from SQLITE_SOURCE_ID.
drh9f129f42010-08-31 15:27:32 +000055*/
drh47baebc2009-08-14 16:01:24 +000056const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000057
58/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
59** returns an integer equal to SQLITE_VERSION_NUMBER.
60*/
danielk197799ba19e2005-02-05 07:33:34 +000061int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000062
drh5dc2bcd2012-01-02 15:45:12 +000063/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000064** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000065** the SQLITE_THREADSAFE compile-time option being set to 0.
66*/
drhb67e8bf2007-08-30 20:09:48 +000067int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000068
mistachkin34cf2582015-04-02 17:46:52 +000069/*
70** When compiling the test fixture or with debugging enabled (on Win32),
71** this variable being set to non-zero will cause OSTRACE macros to emit
72** extra diagnostic information.
73*/
mistachkinfb383e92015-04-16 03:24:38 +000074#ifdef SQLITE_HAVE_OS_TRACE
mistachkin34cf2582015-04-02 17:46:52 +000075# ifndef SQLITE_DEBUG_OS_TRACE
76# define SQLITE_DEBUG_OS_TRACE 0
77# endif
78 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
79#endif
80
drhe265b082008-05-01 17:03:49 +000081#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000082/*
drhb0603412007-02-28 04:47:26 +000083** If the following function pointer is not NULL and if
84** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
85** I/O active are written using this function. These messages
86** are intended for debugging activity only.
87*/
mistachkin9871a932015-03-27 00:21:52 +000088SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000089#endif
drhb0603412007-02-28 04:47:26 +000090
91/*
drha16313e2007-03-30 11:29:32 +000092** If the following global variable points to a string which is the
93** name of a directory, then that directory will be used to store
94** temporary files.
95**
96** See also the "PRAGMA temp_store_directory" SQL command.
97*/
98char *sqlite3_temp_directory = 0;
99
drhc5499be2008-04-01 15:06:33 +0000100/*
mistachkina112d142012-03-14 00:44:01 +0000101** If the following global variable points to a string which is the
102** name of a directory, then that directory will be used to store
103** all database files specified with a relative pathname.
104**
105** See also the "PRAGMA data_store_directory" SQL command.
106*/
107char *sqlite3_data_directory = 0;
108
109/*
drh40257ff2008-06-13 18:24:27 +0000110** Initialize SQLite.
111**
112** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000113** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000114** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
115** this routine will be called automatically by key routines such as
116** sqlite3_open().
117**
118** This routine is a no-op except on its very first call for the process,
119** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000120**
121** The first thread to call this routine runs the initialization to
122** completion. If subsequent threads call this routine before the first
123** thread has finished the initialization process, then the subsequent
124** threads must block until the first thread finishes with the initialization.
125**
126** The first thread might call this routine recursively. Recursive
127** calls to this routine should not block, of course. Otherwise the
128** initialization process would never complete.
129**
130** Let X be the first thread to enter this routine. Let Y be some other
131** thread. Then while the initial invocation of this routine by X is
132** incomplete, it is required that:
133**
134** * Calls to this routine from Y must block until the outer-most
135** call by X completes.
136**
137** * Recursive calls to this routine from thread X return immediately
138** without blocking.
drh40257ff2008-06-13 18:24:27 +0000139*/
140int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000141 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000142 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000143#ifdef SQLITE_EXTRA_INIT
144 int bRunExtraInit = 0; /* Extra initialization needed */
145#endif
danielk1977075c23a2008-09-01 18:34:20 +0000146
147#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000148 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000149 if( rc!=SQLITE_OK ){
150 return rc;
151 }
152#endif
danielk197771bc31c2008-06-26 08:29:34 +0000153
drh2b4905c2015-03-23 18:52:56 +0000154 /* If the following assert() fails on some obscure processor/compiler
155 ** combination, the work-around is to set the correct pointer
156 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
157 assert( SQLITE_PTRSIZE==sizeof(char*) );
158
drh93ed56d2008-08-12 15:21:11 +0000159 /* If SQLite is already completely initialized, then this call
160 ** to sqlite3_initialize() should be a no-op. But the initialization
161 ** must be complete. So isInit must not be set until the very end
162 ** of this routine.
163 */
danielk1977075c23a2008-09-01 18:34:20 +0000164 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000165
drh93ed56d2008-08-12 15:21:11 +0000166 /* Make sure the mutex subsystem is initialized. If unable to
167 ** initialize the mutex subsystem, return early with the error.
168 ** If the system is so sick that we are unable to allocate a mutex,
169 ** there is not much SQLite is going to be able to do.
170 **
171 ** The mutex subsystem must take care of serializing its own
172 ** initialization.
173 */
danielk1977d0251742008-06-18 18:57:42 +0000174 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000175 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000176
drh93ed56d2008-08-12 15:21:11 +0000177 /* Initialize the malloc() system and the recursive pInitMutex mutex.
178 ** This operation is protected by the STATIC_MASTER mutex. Note that
179 ** MutexAlloc() is called for a static mutex prior to initializing the
180 ** malloc subsystem - this implies that the allocation of a static
181 ** mutex must not require support from the malloc subsystem.
182 */
drh30ddce62011-10-15 00:16:30 +0000183 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000184 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000185 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000186 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000187 rc = sqlite3MallocInit();
188 }
drh40257ff2008-06-13 18:24:27 +0000189 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000190 sqlite3GlobalConfig.isMallocInit = 1;
191 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000192 sqlite3GlobalConfig.pInitMutex =
193 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000194 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
mistachkinfad30392016-02-13 23:43:46 +0000195 rc = SQLITE_NOMEM_BKPT;
drh40257ff2008-06-13 18:24:27 +0000196 }
197 }
danielk197777eb5bb2008-09-22 17:22:19 +0000198 }
199 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000200 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000201 }
202 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000203
dane1ab2192009-08-17 15:16:19 +0000204 /* If rc is not SQLITE_OK at this point, then either the malloc
205 ** subsystem could not be initialized or the system failed to allocate
206 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000207 if( rc!=SQLITE_OK ){
208 return rc;
209 }
210
211 /* Do the rest of the initialization under the recursive mutex so
212 ** that we will be able to handle recursive calls into
213 ** sqlite3_initialize(). The recursive calls normally come through
214 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
215 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000216 **
217 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
218 ** to the xInit method, so the xInit method need not be threadsafe.
219 **
220 ** The following mutex is what serializes access to the appdef pcache xInit
221 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
222 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000223 */
danielk1977075c23a2008-09-01 18:34:20 +0000224 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000225 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977502b4e02008-09-02 14:07:24 +0000226 sqlite3GlobalConfig.inProgress = 1;
drh5e3cefe2015-11-12 23:48:08 +0000227#ifdef SQLITE_ENABLE_SQLLOG
dand83f7ca2015-11-12 20:12:51 +0000228 {
drh5e3cefe2015-11-12 23:48:08 +0000229 extern void sqlite3_init_sqllog(void);
230 sqlite3_init_sqllog();
dand83f7ca2015-11-12 20:12:51 +0000231 }
232#endif
drh80738d92016-02-15 00:34:16 +0000233 memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
234 sqlite3RegisterBuiltinFunctions();
dane1ab2192009-08-17 15:16:19 +0000235 if( sqlite3GlobalConfig.isPCacheInit==0 ){
236 rc = sqlite3PcacheInitialize();
237 }
danielk19778c0a7912008-08-20 14:49:23 +0000238 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000239 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000240 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000241 }
drh9c6396e2018-03-06 21:43:19 +0000242#ifdef SQLITE_ENABLE_DESERIALIZE
drhac442f42018-01-03 01:28:46 +0000243 if( rc==SQLITE_OK ){
244 rc = sqlite3MemdbInit();
245 }
246#endif
drh0bf9f7b2009-04-17 16:54:22 +0000247 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000248 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
249 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000250 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000251#ifdef SQLITE_EXTRA_INIT
252 bRunExtraInit = 1;
253#endif
danielk19778c0a7912008-08-20 14:49:23 +0000254 }
danielk1977502b4e02008-09-02 14:07:24 +0000255 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000256 }
danielk1977075c23a2008-09-01 18:34:20 +0000257 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000258
drh93ed56d2008-08-12 15:21:11 +0000259 /* Go back under the static mutex and clean up the recursive
260 ** mutex to prevent a resource leak.
261 */
262 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000263 sqlite3GlobalConfig.nRefInitMutex--;
264 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
265 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
266 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
267 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000268 }
269 sqlite3_mutex_leave(pMaster);
270
271 /* The following is just a sanity check to make sure SQLite has
272 ** been compiled correctly. It is important to run this code, but
273 ** we don't want to run it too often and soak up CPU cycles for no
274 ** reason. So we run it once during initialization.
275 */
shanedfb7b372008-07-22 05:13:30 +0000276#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000277#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000278 /* This section of code's only "output" is via assert() statements. */
drhac442f42018-01-03 01:28:46 +0000279 if( rc==SQLITE_OK ){
shanedfb7b372008-07-22 05:13:30 +0000280 u64 x = (((u64)1)<<63)-1;
281 double y;
282 assert(sizeof(x)==8);
283 assert(sizeof(x)==sizeof(y));
284 memcpy(&y, &x, 8);
285 assert( sqlite3IsNaN(y) );
286 }
287#endif
shanefbd60f82009-02-04 03:59:25 +0000288#endif
shanedfb7b372008-07-22 05:13:30 +0000289
drhe4cf0b32011-08-25 00:14:41 +0000290 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
291 ** compile-time option.
292 */
293#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000294 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000295 int SQLITE_EXTRA_INIT(const char*);
296 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000297 }
298#endif
299
drh40257ff2008-06-13 18:24:27 +0000300 return rc;
301}
302
303/*
304** Undo the effects of sqlite3_initialize(). Must not be called while
305** there are outstanding database connections or memory allocations or
306** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000307** routine is not threadsafe. But it is safe to invoke this routine
308** on when SQLite is already shut down. If SQLite is already shut down
309** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000310*/
311int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000312#ifdef SQLITE_OMIT_WSD
313 int rc = sqlite3_wsd_init(4096, 24);
314 if( rc!=SQLITE_OK ){
315 return rc;
316 }
317#endif
318
danielk1977075c23a2008-09-01 18:34:20 +0000319 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000320#ifdef SQLITE_EXTRA_SHUTDOWN
321 void SQLITE_EXTRA_SHUTDOWN(void);
322 SQLITE_EXTRA_SHUTDOWN();
323#endif
drha7640922009-04-21 12:02:56 +0000324 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000325 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000326 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000327 }
dane1ab2192009-08-17 15:16:19 +0000328 if( sqlite3GlobalConfig.isPCacheInit ){
329 sqlite3PcacheShutdown();
330 sqlite3GlobalConfig.isPCacheInit = 0;
331 }
332 if( sqlite3GlobalConfig.isMallocInit ){
333 sqlite3MallocEnd();
334 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000335
336#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
337 /* The heap subsystem has now been shutdown and these values are supposed
338 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
339 ** which would rely on that heap subsystem; therefore, make sure these
340 ** values cannot refer to heap memory that was just invalidated when the
341 ** heap subsystem was shutdown. This is only done if the current call to
342 ** this function resulted in the heap subsystem actually being shutdown.
343 */
344 sqlite3_data_directory = 0;
345 sqlite3_temp_directory = 0;
346#endif
dane1ab2192009-08-17 15:16:19 +0000347 }
348 if( sqlite3GlobalConfig.isMutexInit ){
349 sqlite3MutexEnd();
350 sqlite3GlobalConfig.isMutexInit = 0;
351 }
352
drh40257ff2008-06-13 18:24:27 +0000353 return SQLITE_OK;
354}
355
356/*
357** This API allows applications to modify the global configuration of
358** the SQLite library at run-time.
359**
360** This routine should only be called when there are no outstanding
361** database connections or memory allocations. This routine is not
362** threadsafe. Failure to heed these warnings can lead to unpredictable
363** behavior.
364*/
365int sqlite3_config(int op, ...){
366 va_list ap;
367 int rc = SQLITE_OK;
368
369 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
370 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000371 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000372
373 va_start(ap, op);
374 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000375
376 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000377 ** compile.
drh18472fa2008-10-07 15:25:48 +0000378 */
drhd1dcb232014-11-01 18:32:18 +0000379#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000380 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000381 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
382 ** Single-thread. */
383 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
384 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000385 break;
386 }
drhd1dcb232014-11-01 18:32:18 +0000387#endif
388#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000389 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000390 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
391 ** Multi-thread. */
392 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
393 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000394 break;
395 }
drhd1dcb232014-11-01 18:32:18 +0000396#endif
397#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000398 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000399 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
400 ** Serialized. */
401 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
402 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000403 break;
404 }
drhd1dcb232014-11-01 18:32:18 +0000405#endif
406#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000407 case SQLITE_CONFIG_MUTEX: {
408 /* Specify an alternative mutex implementation */
409 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
410 break;
411 }
drhd1dcb232014-11-01 18:32:18 +0000412#endif
413#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000414 case SQLITE_CONFIG_GETMUTEX: {
415 /* Retrieve the current mutex implementation */
416 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
417 break;
418 }
419#endif
420
drh40257ff2008-06-13 18:24:27 +0000421 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000422 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
423 ** single argument which is a pointer to an instance of the
424 ** sqlite3_mem_methods structure. The argument specifies alternative
425 ** low-level memory allocation routines to be used in place of the memory
426 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000427 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000428 break;
429 }
drh33589792008-06-18 13:27:46 +0000430 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000431 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
432 ** single argument which is a pointer to an instance of the
433 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
434 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000435 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
436 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000437 break;
438 }
drhfec00ea2008-06-14 16:56:21 +0000439 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000440 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
441 ** single argument of type int, interpreted as a boolean, which enables
442 ** or disables the collection of memory allocation statistics. */
443 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000444 break;
445 }
drhb2a0f752017-08-28 15:51:35 +0000446 case SQLITE_CONFIG_SMALL_MALLOC: {
447 sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000448 break;
449 }
450 case SQLITE_CONFIG_PAGECACHE: {
drh15427272015-12-03 22:33:55 +0000451 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
452 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
453 ** the size of each page cache line (sz), and the number of cache lines
454 ** (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000455 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
456 sqlite3GlobalConfig.szPage = va_arg(ap, int);
457 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000458 break;
459 }
drhdef68892014-11-04 12:11:23 +0000460 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000461 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
462 ** a single parameter which is a pointer to an integer and writes into
463 ** that integer the number of extra bytes per page required for each page
464 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000465 *va_arg(ap, int*) =
466 sqlite3HeaderSizeBtree() +
467 sqlite3HeaderSizePcache() +
468 sqlite3HeaderSizePcache1();
469 break;
470 }
danielk19775099be52008-06-27 13:27:03 +0000471
danielk1977bc2ca9e2008-11-13 14:28:28 +0000472 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000473 /* no-op */
474 break;
475 }
476 case SQLITE_CONFIG_GETPCACHE: {
477 /* now an error */
478 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000479 break;
480 }
481
dan22e21ff2011-11-08 20:08:44 +0000482 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000483 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
484 ** single argument which is a pointer to an sqlite3_pcache_methods2
485 ** object. This object specifies the interface to a custom page cache
486 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000487 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
488 break;
489 }
490 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000491 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
492 ** single argument which is a pointer to an sqlite3_pcache_methods2
493 ** object. SQLite copies of the current page cache implementation into
494 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000495 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000496 sqlite3PCacheSetDefault();
497 }
dan22e21ff2011-11-08 20:08:44 +0000498 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000499 break;
500 }
501
drh8790b6e2014-11-07 01:43:56 +0000502/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
503** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
504** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000505#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000506 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000507 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
508 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000509 ** number of bytes in the memory buffer, and the minimum allocation size.
510 */
danielk1977075c23a2008-09-01 18:34:20 +0000511 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
512 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
513 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000514
shaneha6ec8922011-03-09 21:36:17 +0000515 if( sqlite3GlobalConfig.mnReq<1 ){
516 sqlite3GlobalConfig.mnReq = 1;
517 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
518 /* cap min request size at 2^12 */
519 sqlite3GlobalConfig.mnReq = (1<<12);
520 }
521
danielk1977075c23a2008-09-01 18:34:20 +0000522 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000523 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
524 ** is NULL, then SQLite reverts to using its default memory allocator
525 ** (the system malloc() implementation), undoing any prior invocation of
526 ** SQLITE_CONFIG_MALLOC.
527 **
528 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
529 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000530 */
danielk1977075c23a2008-09-01 18:34:20 +0000531 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000532 }else{
drh8790b6e2014-11-07 01:43:56 +0000533 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
534 ** alternative memory allocator is engaged to handle all of SQLites
535 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000536#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000537 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000538#endif
539#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000540 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000541#endif
drh8a42cbd2008-07-10 18:13:42 +0000542 }
danielk19775099be52008-06-27 13:27:03 +0000543 break;
544 }
drh5d414832008-07-15 14:47:18 +0000545#endif
danielk19775099be52008-06-27 13:27:03 +0000546
drh633e6d52008-07-28 19:34:53 +0000547 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000548 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
549 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000550 break;
551 }
drh3f280702010-02-18 18:45:09 +0000552
mistachkin037933b2013-08-13 22:33:41 +0000553 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000554 ** The default is NULL. Logging is disabled if the function pointer is
555 ** NULL.
556 */
557 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000558 /* MSVC is picky about pulling func ptrs from va lists.
559 ** http://support.microsoft.com/kb/47961
560 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
561 */
562 typedef void(*LOGFUNC_t)(void*,int,const char*);
563 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000564 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
565 break;
566 }
drh633e6d52008-07-28 19:34:53 +0000567
drh00729cb2014-10-04 11:59:33 +0000568 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
569 ** can be changed at start-time using the
570 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
571 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
572 */
dancd74b612011-04-22 19:37:32 +0000573 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000574 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
575 ** argument of type int. If non-zero, then URI handling is globally
576 ** enabled. If the parameter is zero, then URI handling is globally
577 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000578 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
579 break;
580 }
581
drhde9a7b82012-09-17 20:44:46 +0000582 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000583 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
584 ** option takes a single integer argument which is interpreted as a
585 ** boolean in order to enable or disable the use of covering indices for
586 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000587 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
588 break;
589 }
590
danac455932012-11-26 19:50:41 +0000591#ifdef SQLITE_ENABLE_SQLLOG
592 case SQLITE_CONFIG_SQLLOG: {
593 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
594 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
595 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
596 break;
597 }
598#endif
599
drh9b4c59f2013-04-15 17:03:42 +0000600 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000601 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
602 ** integer (sqlite3_int64) values that are the default mmap size limit
603 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
604 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000605 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000606 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000607 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000608 ** negative, then that argument is changed to its compile-time default.
609 **
610 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
611 ** silently truncated if necessary so that it does not exceed the
612 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
613 ** compile-time option.
614 */
drh3ba689d2015-03-03 14:00:11 +0000615 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
616 mxMmap = SQLITE_MAX_MMAP_SIZE;
617 }
drh9b4c59f2013-04-15 17:03:42 +0000618 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
619 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000620 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000621 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000622 break;
623 }
624
drh4d9f1882014-11-04 17:23:24 +0000625#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000626 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000627 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
628 ** unsigned integer value that specifies the maximum size of the created
629 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000630 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
631 break;
632 }
633#endif
634
drh3bd17912015-01-02 15:55:29 +0000635 case SQLITE_CONFIG_PMASZ: {
636 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
637 break;
638 }
639
drh8c71a982016-03-07 17:37:37 +0000640 case SQLITE_CONFIG_STMTJRNL_SPILL: {
641 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
642 break;
643 }
644
dan2e3a5a82018-04-16 21:12:42 +0000645#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbade8d2018-04-18 14:48:08 +0000646 case SQLITE_CONFIG_SORTERREF_SIZE: {
dan2e3a5a82018-04-16 21:12:42 +0000647 int iVal = va_arg(ap, int);
648 if( iVal<0 ){
649 iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
650 }
651 sqlite3GlobalConfig.szSorterRef = (u32)iVal;
dan2e3a5a82018-04-16 21:12:42 +0000652 break;
653 }
drhbbade8d2018-04-18 14:48:08 +0000654#endif /* SQLITE_ENABLE_SORTER_REFERENCES */
dan2e3a5a82018-04-16 21:12:42 +0000655
drh23a88592019-01-31 15:38:53 +0000656#ifdef SQLITE_ENABLE_DESERIALIZE
657 case SQLITE_CONFIG_MEMDB_MAXSIZE: {
658 sqlite3GlobalConfig.mxMemdbSize = va_arg(ap, sqlite3_int64);
659 break;
660 }
661#endif /* SQLITE_ENABLE_DESERIALIZE */
662
drh40257ff2008-06-13 18:24:27 +0000663 default: {
664 rc = SQLITE_ERROR;
665 break;
666 }
667 }
668 va_end(ap);
669 return rc;
670}
671
672/*
drh633e6d52008-07-28 19:34:53 +0000673** Set up the lookaside buffers for a database connection.
674** Return SQLITE_OK on success.
675** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000676**
677** The sz parameter is the number of bytes in each lookaside slot.
678** The cnt parameter is the number of slots. If pStart is NULL the
679** space for the lookaside memory is obtained from sqlite3_malloc().
680** If pStart is not NULL then it is sz*cnt bytes of memory to use for
681** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000682*/
drhe9d1c722008-08-04 20:13:26 +0000683static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000684#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000685 void *pStart;
numist115d6632019-12-12 02:50:07 +0000686 sqlite3_int64 szAlloc = sz*(sqlite3_int64)cnt;
drhe6068022019-12-13 15:48:21 +0000687 int nBig; /* Number of full-size slots */
drhcf014f62019-12-31 15:12:34 +0000688 int nSm; /* Number smaller LOOKASIDE_SMALL-byte slots */
drh52fb8e12017-08-29 20:21:12 +0000689
690 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000691 return SQLITE_BUSY;
692 }
shanef71f89e2009-01-30 06:11:54 +0000693 /* Free any existing lookaside buffer for this handle before
694 ** allocating a new one so we don't have to have space for
695 ** both at the same time.
696 */
697 if( db->lookaside.bMalloced ){
698 sqlite3_free(db->lookaside.pStart);
699 }
drh61a4bd52011-11-10 02:39:28 +0000700 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
701 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000702 */
drh61a4bd52011-11-10 02:39:28 +0000703 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000704 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000705 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000706 if( sz==0 || cnt==0 ){
707 sz = 0;
708 pStart = 0;
709 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000710 sqlite3BeginBenignMalloc();
numist115d6632019-12-12 02:50:07 +0000711 pStart = sqlite3Malloc( szAlloc ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000712 sqlite3EndBenignMalloc();
drhe6068022019-12-13 15:48:21 +0000713 if( pStart ) szAlloc = sqlite3MallocSize(pStart);
drhe9d1c722008-08-04 20:13:26 +0000714 }else{
715 pStart = pBuf;
716 }
drhcf014f62019-12-31 15:12:34 +0000717#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
718 if( sz>=LOOKASIDE_SMALL*3 ){
719 nBig = szAlloc/(3*LOOKASIDE_SMALL+sz);
720 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
721 }else if( sz>=LOOKASIDE_SMALL*2 ){
722 nBig = szAlloc/(LOOKASIDE_SMALL+sz);
723 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
drhe6068022019-12-13 15:48:21 +0000724 }else
drhcf014f62019-12-31 15:12:34 +0000725#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000726 if( sz>0 ){
727 nBig = szAlloc/sz;
728 nSm = 0;
729 }else{
730 nBig = nSm = 0;
731 }
drh4cfb22f2008-08-01 18:47:01 +0000732 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000733 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000734 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000735 db->lookaside.sz = (u16)sz;
drh31f69622019-10-05 14:39:36 +0000736 db->lookaside.szTrue = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000737 if( pStart ){
738 int i;
739 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000740 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000741 p = (LookasideSlot*)pStart;
drhe6068022019-12-13 15:48:21 +0000742 for(i=0; i<nBig; i++){
drh52fb8e12017-08-29 20:21:12 +0000743 p->pNext = db->lookaside.pInit;
744 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000745 p = (LookasideSlot*)&((u8*)p)[sz];
746 }
drhcf014f62019-12-31 15:12:34 +0000747#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
748 db->lookaside.pSmallInit = 0;
749 db->lookaside.pSmallFree = 0;
numist115d6632019-12-12 02:50:07 +0000750 db->lookaside.pMiddle = p;
drhe6068022019-12-13 15:48:21 +0000751 for(i=0; i<nSm; i++){
drhcf014f62019-12-31 15:12:34 +0000752 p->pNext = db->lookaside.pSmallInit;
753 db->lookaside.pSmallInit = p;
754 p = (LookasideSlot*)&((u8*)p)[LOOKASIDE_SMALL];
numist115d6632019-12-12 02:50:07 +0000755 }
drhcf014f62019-12-31 15:12:34 +0000756#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000757 assert( ((uptr)p)<=szAlloc + (uptr)pStart );
drh633e6d52008-07-28 19:34:53 +0000758 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000759 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000760 db->lookaside.bMalloced = pBuf==0 ?1:0;
drhe6068022019-12-13 15:48:21 +0000761 db->lookaside.nSlot = nBig+nSm;
drh4cfb22f2008-08-01 18:47:01 +0000762 }else{
drhb0e77042013-12-10 19:49:00 +0000763 db->lookaside.pStart = db;
drhcf014f62019-12-31 15:12:34 +0000764#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
765 db->lookaside.pSmallInit = 0;
766 db->lookaside.pSmallFree = 0;
drhe6068022019-12-13 15:48:21 +0000767 db->lookaside.pMiddle = db;
drhcf014f62019-12-31 15:12:34 +0000768#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhb0e77042013-12-10 19:49:00 +0000769 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000770 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +0000771 db->lookaside.sz = 0;
shanef71f89e2009-01-30 06:11:54 +0000772 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000773 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000774 }
drhe6068022019-12-13 15:48:21 +0000775 assert( sqlite3LookasideUsed(db,0)==0 );
drh7877d9a2015-07-23 17:16:27 +0000776#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000777 return SQLITE_OK;
778}
779
780/*
drh4413d0e2008-11-04 13:46:27 +0000781** Return the mutex associated with a database connection.
782*/
783sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000784#ifdef SQLITE_ENABLE_API_ARMOR
785 if( !sqlite3SafetyCheckOk(db) ){
786 (void)SQLITE_MISUSE_BKPT;
787 return 0;
788 }
789#endif
drh4413d0e2008-11-04 13:46:27 +0000790 return db->mutex;
791}
792
793/*
drh09419b42011-11-16 19:29:17 +0000794** Free up as much memory as we can from the given database
795** connection.
796*/
797int sqlite3_db_release_memory(sqlite3 *db){
798 int i;
drh9ca95732014-10-24 00:35:58 +0000799
800#ifdef SQLITE_ENABLE_API_ARMOR
801 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
802#endif
dand9bb3a92011-12-30 11:43:59 +0000803 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000804 sqlite3BtreeEnterAll(db);
805 for(i=0; i<db->nDb; i++){
806 Btree *pBt = db->aDb[i].pBt;
807 if( pBt ){
808 Pager *pPager = sqlite3BtreePager(pBt);
809 sqlite3PagerShrink(pPager);
810 }
811 }
812 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000813 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000814 return SQLITE_OK;
815}
816
817/*
dan6fa255f2015-10-28 19:46:57 +0000818** Flush any dirty pages in the pager-cache for any attached database
819** to disk.
820*/
821int sqlite3_db_cacheflush(sqlite3 *db){
822 int i;
823 int rc = SQLITE_OK;
824 int bSeenBusy = 0;
825
826#ifdef SQLITE_ENABLE_API_ARMOR
827 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
828#endif
829 sqlite3_mutex_enter(db->mutex);
830 sqlite3BtreeEnterAll(db);
831 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
832 Btree *pBt = db->aDb[i].pBt;
833 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
834 Pager *pPager = sqlite3BtreePager(pBt);
835 rc = sqlite3PagerFlush(pPager);
836 if( rc==SQLITE_BUSY ){
837 bSeenBusy = 1;
838 rc = SQLITE_OK;
839 }
840 }
841 }
dan6fa255f2015-10-28 19:46:57 +0000842 sqlite3BtreeLeaveAll(db);
843 sqlite3_mutex_leave(db->mutex);
844 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
845}
846
847/*
drh633e6d52008-07-28 19:34:53 +0000848** Configuration settings for an individual database connection
849*/
850int sqlite3_db_config(sqlite3 *db, int op, ...){
851 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000852 int rc;
drh633e6d52008-07-28 19:34:53 +0000853 va_start(ap, op);
854 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000855 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000856 /* IMP: R-06824-28531 */
857 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000858 db->aDb[0].zDbSName = va_arg(ap,char*);
859 rc = SQLITE_OK;
860 break;
861 }
drhe9d1c722008-08-04 20:13:26 +0000862 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000863 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000864 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
865 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000866 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000867 break;
868 }
drh6480aad2008-08-01 16:31:14 +0000869 default: {
drhe83cafd2011-03-21 17:15:58 +0000870 static const struct {
871 int op; /* The opcode */
872 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
873 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000874 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
875 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
drh11d88e62019-08-15 21:27:20 +0000876 { SQLITE_DBCONFIG_ENABLE_VIEW, SQLITE_EnableView },
drhd42908f2016-02-26 15:38:24 +0000877 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000878 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000879 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000880 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000881 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000882 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drha296cda2018-11-03 16:09:59 +0000883 { SQLITE_DBCONFIG_DEFENSIVE, SQLITE_Defensive },
drh346f4e22019-03-25 21:35:41 +0000884 { SQLITE_DBCONFIG_WRITABLE_SCHEMA, SQLITE_WriteSchema|
885 SQLITE_NoSchemaError },
drh0a6873b2019-06-14 21:25:25 +0000886 { SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, SQLITE_LegacyAlter },
drhd0ff6012019-06-17 13:56:11 +0000887 { SQLITE_DBCONFIG_DQS_DDL, SQLITE_DqsDDL },
888 { SQLITE_DBCONFIG_DQS_DML, SQLITE_DqsDML },
drh66c48902019-10-29 16:18:45 +0000889 { SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, SQLITE_LegacyFileFmt },
drhb945bcd2019-12-31 22:52:10 +0000890 { SQLITE_DBCONFIG_UNSAFE_FUNC_IN_VIEW, SQLITE_UnsafeInView },
891 { SQLITE_DBCONFIG_VTAB_IN_VIEW, SQLITE_VtabInView },
drhe83cafd2011-03-21 17:15:58 +0000892 };
drh58ad5802011-03-23 22:02:23 +0000893 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000894 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000895 for(i=0; i<ArraySize(aFlagOp); i++){
896 if( aFlagOp[i].op==op ){
897 int onoff = va_arg(ap, int);
898 int *pRes = va_arg(ap, int*);
drh70d5dfb2018-12-06 16:50:55 +0000899 u64 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000900 if( onoff>0 ){
901 db->flags |= aFlagOp[i].mask;
902 }else if( onoff==0 ){
drhd5b44d62018-12-06 17:06:02 +0000903 db->flags &= ~(u64)aFlagOp[i].mask;
drhe83cafd2011-03-21 17:15:58 +0000904 }
905 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000906 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000907 }
908 if( pRes ){
909 *pRes = (db->flags & aFlagOp[i].mask)!=0;
910 }
911 rc = SQLITE_OK;
912 break;
913 }
914 }
drh6480aad2008-08-01 16:31:14 +0000915 break;
916 }
drh633e6d52008-07-28 19:34:53 +0000917 }
918 va_end(ap);
919 return rc;
920}
921
drh9b5adfa2008-01-20 23:19:56 +0000922/*
drhd3d39e92004-05-20 22:16:29 +0000923** This is the default collating function named "BINARY" which is always
924** available.
925*/
danielk19772c336542005-01-13 02:14:23 +0000926static int binCollFunc(
drh821afa42019-06-14 13:24:46 +0000927 void *NotUsed,
drhd3d39e92004-05-20 22:16:29 +0000928 int nKey1, const void *pKey1,
929 int nKey2, const void *pKey2
930){
931 int rc, n;
drh821afa42019-06-14 13:24:46 +0000932 UNUSED_PARAMETER(NotUsed);
drhd3d39e92004-05-20 22:16:29 +0000933 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000934 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
935 ** strings byte by byte using the memcmp() function from the standard C
936 ** library. */
dan21766c02017-05-22 08:04:09 +0000937 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +0000938 rc = memcmp(pKey1, pKey2, n);
939 if( rc==0 ){
drh821afa42019-06-14 13:24:46 +0000940 rc = nKey1 - nKey2;
drhd3d39e92004-05-20 22:16:29 +0000941 }
942 return rc;
943}
944
945/*
drh821afa42019-06-14 13:24:46 +0000946** This is the collating function named "RTRIM" which is always
947** available. Ignore trailing spaces.
948*/
949static int rtrimCollFunc(
950 void *pUser,
951 int nKey1, const void *pKey1,
952 int nKey2, const void *pKey2
953){
954 const u8 *pK1 = (const u8*)pKey1;
955 const u8 *pK2 = (const u8*)pKey2;
956 while( nKey1 && pK1[nKey1-1]==' ' ) nKey1--;
957 while( nKey2 && pK2[nKey2-1]==' ' ) nKey2--;
958 return binCollFunc(pUser, nKey1, pKey1, nKey2, pKey2);
959}
960
961/*
drhbcd15932018-07-27 18:12:40 +0000962** Return true if CollSeq is the default built-in BINARY.
963*/
964int sqlite3IsBinary(const CollSeq *p){
drh821afa42019-06-14 13:24:46 +0000965 assert( p==0 || p->xCmp!=binCollFunc || strcmp(p->zName,"BINARY")==0 );
966 return p==0 || p->xCmp==binCollFunc;
drhbcd15932018-07-27 18:12:40 +0000967}
968
969/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000970** Another built-in collating sequence: NOCASE.
971**
drhf7b54962013-05-28 12:11:54 +0000972** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000973** comparison". SQLite's knowledge of upper and lower case equivalents
974** extends only to the 26 characters used in the English language.
975**
976** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000977*/
978static int nocaseCollatingFunc(
979 void *NotUsed,
980 int nKey1, const void *pKey1,
981 int nKey2, const void *pKey2
982){
983 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000984 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000985 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000986 if( 0==r ){
987 r = nKey1-nKey2;
988 }
989 return r;
990}
991
992/*
drhaf9ff332002-01-16 21:00:27 +0000993** Return the ROWID of the most recent insert
994*/
drh9bb575f2004-09-06 17:24:11 +0000995sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000996#ifdef SQLITE_ENABLE_API_ARMOR
997 if( !sqlite3SafetyCheckOk(db) ){
998 (void)SQLITE_MISUSE_BKPT;
999 return 0;
1000 }
1001#endif
drhaf9ff332002-01-16 21:00:27 +00001002 return db->lastRowid;
1003}
1004
1005/*
dan9c58b632017-02-27 14:52:48 +00001006** Set the value returned by the sqlite3_last_insert_rowid() API function.
1007*/
1008void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
1009#ifdef SQLITE_ENABLE_API_ARMOR
1010 if( !sqlite3SafetyCheckOk(db) ){
1011 (void)SQLITE_MISUSE_BKPT;
1012 return;
1013 }
1014#endif
1015 sqlite3_mutex_enter(db->mutex);
1016 db->lastRowid = iRowid;
1017 sqlite3_mutex_leave(db->mutex);
1018}
1019
1020/*
danielk197724b03fd2004-05-10 10:34:34 +00001021** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +00001022*/
drh9bb575f2004-09-06 17:24:11 +00001023int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001024#ifdef SQLITE_ENABLE_API_ARMOR
1025 if( !sqlite3SafetyCheckOk(db) ){
1026 (void)SQLITE_MISUSE_BKPT;
1027 return 0;
1028 }
1029#endif
drhc8d30ac2002-04-12 10:08:59 +00001030 return db->nChange;
1031}
1032
rdcf146a772004-02-25 22:51:06 +00001033/*
danielk1977b28af712004-06-21 06:50:26 +00001034** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +00001035*/
danielk1977b28af712004-06-21 06:50:26 +00001036int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001037#ifdef SQLITE_ENABLE_API_ARMOR
1038 if( !sqlite3SafetyCheckOk(db) ){
1039 (void)SQLITE_MISUSE_BKPT;
1040 return 0;
1041 }
1042#endif
danielk1977b28af712004-06-21 06:50:26 +00001043 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +00001044}
1045
drhc8d30ac2002-04-12 10:08:59 +00001046/*
danielk1977fd7f0452008-12-17 17:30:26 +00001047** Close all open savepoints. This function only manipulates fields of the
1048** database handle object, it does not close any savepoints that may be open
1049** at the b-tree/pager level.
1050*/
1051void sqlite3CloseSavepoints(sqlite3 *db){
1052 while( db->pSavepoint ){
1053 Savepoint *pTmp = db->pSavepoint;
1054 db->pSavepoint = pTmp->pNext;
1055 sqlite3DbFree(db, pTmp);
1056 }
1057 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001058 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001059 db->isTransactionSavepoint = 0;
1060}
1061
1062/*
dand2199f02010-08-27 17:48:52 +00001063** Invoke the destructor function associated with FuncDef p, if any. Except,
1064** if this is not the last copy of the function, do not invoke it. Multiple
1065** copies of a single function are created when create_function() is called
1066** with SQLITE_ANY as the encoding.
1067*/
1068static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001069 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001070 if( pDestructor ){
1071 pDestructor->nRef--;
1072 if( pDestructor->nRef==0 ){
1073 pDestructor->xDestroy(pDestructor->pUserData);
1074 sqlite3DbFree(db, pDestructor);
1075 }
1076 }
1077}
1078
1079/*
danbba02a92012-05-15 17:15:34 +00001080** Disconnect all sqlite3_vtab objects that belong to database connection
1081** db. This is called when db is being closed.
1082*/
1083static void disconnectAllVtab(sqlite3 *db){
1084#ifndef SQLITE_OMIT_VIRTUALTABLE
1085 int i;
drh51be3872015-08-19 02:32:25 +00001086 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001087 sqlite3BtreeEnterAll(db);
1088 for(i=0; i<db->nDb; i++){
1089 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001090 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001091 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1092 Table *pTab = (Table *)sqliteHashData(p);
1093 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1094 }
1095 }
1096 }
drh51be3872015-08-19 02:32:25 +00001097 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1098 Module *pMod = (Module *)sqliteHashData(p);
1099 if( pMod->pEpoTab ){
1100 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1101 }
1102 }
dand88e5212014-03-12 19:38:38 +00001103 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001104 sqlite3BtreeLeaveAll(db);
1105#else
1106 UNUSED_PARAMETER(db);
1107#endif
1108}
1109
1110/*
drh167cd6a2012-06-02 17:09:46 +00001111** Return TRUE if database connection db has unfinalized prepared
1112** statements or unfinished sqlite3_backup objects.
1113*/
1114static int connectionIsBusy(sqlite3 *db){
1115 int j;
1116 assert( sqlite3_mutex_held(db->mutex) );
1117 if( db->pVdbe ) return 1;
1118 for(j=0; j<db->nDb; j++){
1119 Btree *pBt = db->aDb[j].pBt;
1120 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1121 }
1122 return 0;
1123}
1124
1125/*
drh50e5dad2001-09-15 00:57:28 +00001126** Close an existing SQLite database
1127*/
drh167cd6a2012-06-02 17:09:46 +00001128static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001129 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001130 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1131 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001132 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001133 }
drh7e8b8482008-01-23 03:03:05 +00001134 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001135 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001136 }
drh605264d2007-08-21 15:13:19 +00001137 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001138 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1139 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1140 }
danielk1977e35ee192004-06-26 09:50:11 +00001141
danbba02a92012-05-15 17:15:34 +00001142 /* Force xDisconnect calls on all virtual tables */
1143 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001144
danbba02a92012-05-15 17:15:34 +00001145 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001146 ** will not have called the xDisconnect() method on any virtual
1147 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1148 ** call will do so. We need to do this before the check for active
1149 ** SQL statements below, as the v-table implementation may be storing
1150 ** some prepared statements internally.
1151 */
dan67430812013-05-15 10:21:50 +00001152 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001153
drh167cd6a2012-06-02 17:09:46 +00001154 /* Legacy behavior (sqlite3_close() behavior) is to return
1155 ** SQLITE_BUSY if the connection can not be closed immediately.
1156 */
1157 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001158 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001159 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001160 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001161 return SQLITE_BUSY;
1162 }
danielk1977e0048402004-06-15 16:51:01 +00001163
danac455932012-11-26 19:50:41 +00001164#ifdef SQLITE_ENABLE_SQLLOG
1165 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001166 /* Closing the handle. Fourth parameter is passed the value 2. */
1167 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001168 }
1169#endif
1170
drh167cd6a2012-06-02 17:09:46 +00001171 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001172 */
1173 db->magic = SQLITE_MAGIC_ZOMBIE;
1174 sqlite3LeaveMutexAndCloseZombie(db);
1175 return SQLITE_OK;
1176}
drh94e92032003-02-16 22:21:32 +00001177
drh167cd6a2012-06-02 17:09:46 +00001178/*
1179** Two variations on the public interface for closing a database
1180** connection. The sqlite3_close() version returns SQLITE_BUSY and
1181** leaves the connection option if there are unfinalized prepared
1182** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1183** version forces the connection to become a zombie if there are
1184** unclosed resources, and arranges for deallocation when the last
1185** prepare statement or sqlite3_backup closes.
1186*/
1187int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1188int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1189
drh4245c402012-06-02 14:32:21 +00001190
1191/*
1192** Close the mutex on database connection db.
1193**
1194** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001195** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1196** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1197** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001198*/
1199void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1200 HashElem *i; /* Hash table iterator */
1201 int j;
1202
drh4245c402012-06-02 14:32:21 +00001203 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001204 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1205 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001206 */
drh167cd6a2012-06-02 17:09:46 +00001207 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001208 sqlite3_mutex_leave(db->mutex);
1209 return;
danielk197704103022009-02-03 16:51:24 +00001210 }
1211
drh4245c402012-06-02 14:32:21 +00001212 /* If we reach this point, it means that the database connection has
1213 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001214 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001215 ** go ahead and free all resources.
1216 */
1217
dan617dc862013-05-16 11:57:28 +00001218 /* If a transaction is open, roll it back. This also ensures that if
1219 ** any database schemas have been modified by an uncommitted transaction
1220 ** they are reset. And that the required b-tree mutex is held to make
1221 ** the pager rollback and schema reset an atomic operation. */
1222 sqlite3RollbackAll(db, SQLITE_OK);
1223
danielk1977fd7f0452008-12-17 17:30:26 +00001224 /* Free any outstanding Savepoint structures. */
1225 sqlite3CloseSavepoints(db);
1226
drh5efb3142012-05-16 01:24:34 +00001227 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001228 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001229 struct Db *pDb = &db->aDb[j];
1230 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001231 sqlite3BtreeClose(pDb->pBt);
1232 pDb->pBt = 0;
1233 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001234 pDb->pSchema = 0;
1235 }
drh113088e2003-03-20 01:16:58 +00001236 }
drhf57b3392001-10-08 13:22:32 +00001237 }
drh5efb3142012-05-16 01:24:34 +00001238 /* Clear the TEMP schema separately and last */
1239 if( db->aDb[1].pSchema ){
1240 sqlite3SchemaClear(db->aDb[1].pSchema);
1241 }
1242 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001243
drh5efb3142012-05-16 01:24:34 +00001244 /* Free up the array of auxiliary databases */
1245 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001246 assert( db->nDb<=2 );
1247 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001248
1249 /* Tell the code in notify.c that the connection no longer holds any
1250 ** locks and does not require any further unlock-notify callbacks.
1251 */
1252 sqlite3ConnectionClosed(db);
1253
drh80738d92016-02-15 00:34:16 +00001254 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1255 FuncDef *pNext, *p;
1256 p = sqliteHashData(i);
1257 do{
1258 functionDestroy(db, p);
1259 pNext = p->pNext;
1260 sqlite3DbFree(db, p);
1261 p = pNext;
1262 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001263 }
drh80738d92016-02-15 00:34:16 +00001264 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001265 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001266 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001267 /* Invoke any destructors registered for collation sequence user data. */
1268 for(j=0; j<3; j++){
1269 if( pColl[j].xDel ){
1270 pColl[j].xDel(pColl[j].pUser);
1271 }
1272 }
drh633e6d52008-07-28 19:34:53 +00001273 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001274 }
danielk1977d8123362004-06-12 09:25:12 +00001275 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001276#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001277 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1278 Module *pMod = (Module *)sqliteHashData(i);
drh51be3872015-08-19 02:32:25 +00001279 sqlite3VtabEponymousTableClear(db, pMod);
drhcc5979d2019-08-16 22:58:29 +00001280 sqlite3VtabModuleUnref(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001281 }
drhb9bb7c12006-06-11 23:41:55 +00001282 sqlite3HashClear(&db->aModule);
1283#endif
danielk1977466be562004-06-10 02:16:01 +00001284
drh13f40da2014-08-22 18:00:11 +00001285 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001286 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001287 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001288#if SQLITE_USER_AUTHENTICATION
1289 sqlite3_free(db->auth.zAuthUser);
1290 sqlite3_free(db->auth.zAuthPW);
1291#endif
danielk197796d81f92004-06-19 03:33:57 +00001292
1293 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001294
1295 /* The temp-database schema is allocated differently from the other schema
1296 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1297 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1298 ** the same sqliteMalloc() as the one that allocates the database
1299 ** structure?
1300 */
drh633e6d52008-07-28 19:34:53 +00001301 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001302 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001303 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001304 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001305 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001306 if( db->lookaside.bMalloced ){
1307 sqlite3_free(db->lookaside.pStart);
1308 }
drh17435752007-08-16 04:30:38 +00001309 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001310}
1311
1312/*
drh0f198a72012-02-13 16:43:16 +00001313** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001314** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001315** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001316** attempts to use that cursor. Read cursors remain open and valid
1317** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001318*/
drh0f198a72012-02-13 16:43:16 +00001319void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001320 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001321 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001322 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001323 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001324 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001325
1326 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1327 ** This is important in case the transaction being rolled back has
1328 ** modified the database schema. If the b-tree mutexes are not taken
1329 ** here, then another shared-cache connection might sneak in between
1330 ** the database rollback and schema reset, which can cause false
1331 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001332 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001333 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001334
drh001bbcb2003-03-19 03:14:00 +00001335 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001336 Btree *p = db->aDb[i].pBt;
1337 if( p ){
1338 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001339 inTrans = 1;
1340 }
drh47b7fc72014-11-11 01:33:57 +00001341 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001342 }
1343 }
danielk1977a298e902006-06-22 09:53:48 +00001344 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001345 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001346
drh7f32dc92018-07-16 11:32:59 +00001347 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001348 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001349 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001350 }
dancd7b91a2013-05-13 18:23:15 +00001351 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001352
dan1da40a32009-09-19 17:00:31 +00001353 /* Any deferred constraint violations have now been resolved. */
1354 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001355 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00001356 db->flags &= ~(u64)SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001357
danielk197771fd80b2005-12-16 06:54:01 +00001358 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001359 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001360 db->xRollbackCallback(db->pRollbackArg);
1361 }
drh001bbcb2003-03-19 03:14:00 +00001362}
1363
1364/*
mistachkinf2c1c992013-04-28 01:44:43 +00001365** Return a static string containing the name corresponding to the error code
1366** specified in the argument.
1367*/
mistachkin5824d442015-04-28 23:34:10 +00001368#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001369const char *sqlite3ErrName(int rc){
1370 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001371 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001372 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1373 switch( rc ){
1374 case SQLITE_OK: zName = "SQLITE_OK"; break;
1375 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001376 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001377 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1378 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1379 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001380 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001381 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001382 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001383 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001384 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1385 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1386 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1387 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001388 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001389 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001390 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001391 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001392 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001393 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1394 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001395 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1396 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1397 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1398 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1399 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1400 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1401 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1402 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1403 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1404 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001405 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1406 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1407 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1408 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1409 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1410 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1411 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1412 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1413 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1414 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1415 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1416 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1417 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1418 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001419 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001420 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001421 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001422 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001423 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1424 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1425 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001426 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1427 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1428 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001429 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkin3c161e02019-11-18 23:48:03 +00001430 case SQLITE_CANTOPEN_SYMLINK: zName = "SQLITE_CANTOPEN_SYMLINK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001431 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1432 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1433 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1434 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1435 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1436 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1437 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1438 case SQLITE_CONSTRAINT_FOREIGNKEY:
1439 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1440 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1441 case SQLITE_CONSTRAINT_PRIMARYKEY:
1442 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1443 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1444 case SQLITE_CONSTRAINT_COMMITHOOK:
1445 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1446 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1447 case SQLITE_CONSTRAINT_FUNCTION:
1448 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001449 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001450 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1451 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1452 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1453 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1454 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1455 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1456 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1457 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1458 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001459 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1460 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1461 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001462 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001463 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001464 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001465 }
1466 }
mistachkin10269dc2013-04-30 07:54:42 +00001467 if( zName==0 ){
1468 static char zBuf[50];
1469 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1470 zName = zBuf;
1471 }
mistachkinf2c1c992013-04-28 01:44:43 +00001472 return zName;
1473}
mistachkin10269dc2013-04-30 07:54:42 +00001474#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001475
1476/*
drhc22bd472002-05-10 13:14:07 +00001477** Return a static string that describes the kind of error specified in the
1478** argument.
drh247be432002-05-10 05:44:55 +00001479*/
danielk1977f20b21c2004-05-31 23:56:42 +00001480const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001481 static const char* const aMsg[] = {
1482 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001483 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001484 /* SQLITE_INTERNAL */ 0,
1485 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001486 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001487 /* SQLITE_BUSY */ "database is locked",
1488 /* SQLITE_LOCKED */ "database table is locked",
1489 /* SQLITE_NOMEM */ "out of memory",
1490 /* SQLITE_READONLY */ "attempt to write a readonly database",
1491 /* SQLITE_INTERRUPT */ "interrupted",
1492 /* SQLITE_IOERR */ "disk I/O error",
1493 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001494 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001495 /* SQLITE_FULL */ "database or disk is full",
1496 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001497 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001498 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001499 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001500 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001501 /* SQLITE_CONSTRAINT */ "constraint failed",
1502 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001503 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001504#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001505 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001506#else
1507 /* SQLITE_NOLFS */ 0,
1508#endif
drh51c7d862009-04-27 18:46:06 +00001509 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001510 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001511 /* SQLITE_RANGE */ "column index out of range",
1512 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001513 /* SQLITE_NOTICE */ "notification message",
1514 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001515 };
drh21021a52012-02-13 17:01:51 +00001516 const char *zErr = "unknown error";
1517 switch( rc ){
1518 case SQLITE_ABORT_ROLLBACK: {
1519 zErr = "abort due to ROLLBACK";
1520 break;
1521 }
mistachkin2a861102018-02-08 01:00:11 +00001522 case SQLITE_ROW: {
1523 zErr = "another row available";
1524 break;
1525 }
1526 case SQLITE_DONE: {
1527 zErr = "no more rows available";
1528 break;
1529 }
drh21021a52012-02-13 17:01:51 +00001530 default: {
1531 rc &= 0xff;
1532 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1533 zErr = aMsg[rc];
1534 }
1535 break;
1536 }
drh247be432002-05-10 05:44:55 +00001537 }
drh21021a52012-02-13 17:01:51 +00001538 return zErr;
drh247be432002-05-10 05:44:55 +00001539}
1540
1541/*
drh2dfbbca2000-07-28 14:32:48 +00001542** This routine implements a busy callback that sleeps and tries
1543** again until a timeout value is reached. The timeout value is
1544** an integer number of milliseconds passed in as the first
1545** argument.
drhf0119b22018-03-26 17:40:53 +00001546**
1547** Return non-zero to retry the lock. Return zero to stop trying
1548** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001549*/
drhdaffd0e2001-04-11 14:28:42 +00001550static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001551 void *ptr, /* Database connection */
1552 int count, /* Number of times table has been busy */
1553 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001554){
drh0ede9eb2015-01-10 16:49:23 +00001555#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001556 /* This case is for systems that have support for sleeping for fractions of
1557 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001558 static const u8 delays[] =
1559 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1560 static const u8 totals[] =
1561 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001562# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001563 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001564 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001565 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001566
drhf0119b22018-03-26 17:40:53 +00001567#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1568 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1569 if( count ){
1570 tmout = 0;
1571 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1572 return 0;
1573 }else{
1574 return 1;
1575 }
1576 }
drh5013c4b2018-03-28 21:45:03 +00001577#else
1578 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001579#endif
drhee570fa2005-04-28 12:06:05 +00001580 assert( count>=0 );
1581 if( count < NDELAY ){
1582 delay = delays[count];
1583 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001584 }else{
1585 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001586 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001587 }
drhf0119b22018-03-26 17:40:53 +00001588 if( prior + delay > tmout ){
1589 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001590 if( delay<=0 ) return 0;
1591 }
danielk19772a6bdf62007-08-20 16:07:00 +00001592 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001593 return 1;
1594#else
drhf0119b22018-03-26 17:40:53 +00001595 /* This case for unix systems that lack usleep() support. Sleeping
1596 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001597 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001598 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001599 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001600 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001601 return 0;
1602 }
drh482ea182007-08-20 11:12:40 +00001603 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001604 return 1;
1605#endif
1606}
1607
1608/*
drha4afb652005-07-09 02:16:02 +00001609** Invoke the given busy handler.
1610**
drhf0119b22018-03-26 17:40:53 +00001611** This routine is called when an operation failed to acquire a
1612** lock on VFS file pFile.
1613**
drha4afb652005-07-09 02:16:02 +00001614** If this routine returns non-zero, the lock is retried. If it
1615** returns 0, the operation aborts with an SQLITE_BUSY error.
1616*/
drhf0119b22018-03-26 17:40:53 +00001617int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001618 int rc;
drh80262892018-03-26 16:37:53 +00001619 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001620 if( p->bExtraFileArg ){
1621 /* Add an extra parameter with the pFile pointer to the end of the
1622 ** callback argument list */
1623 int (*xTra)(void*,int,sqlite3_file*);
1624 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1625 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1626 }else{
1627 /* Legacy style busy handler callback */
1628 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1629 }
drha4afb652005-07-09 02:16:02 +00001630 if( rc==0 ){
1631 p->nBusy = -1;
1632 }else{
1633 p->nBusy++;
1634 }
1635 return rc;
1636}
1637
1638/*
drh2dfbbca2000-07-28 14:32:48 +00001639** This routine sets the busy callback for an Sqlite database to the
1640** given callback function with the given argument.
1641*/
danielk1977f9d64d22004-06-19 08:18:07 +00001642int sqlite3_busy_handler(
1643 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001644 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001645 void *pArg
1646){
drh9ca95732014-10-24 00:35:58 +00001647#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001648 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001649#endif
drhe30f4422007-08-21 16:15:55 +00001650 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001651 db->busyHandler.xBusyHandler = xBusy;
1652 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001653 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001654 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001655 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001656 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001657 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001658}
1659
danielk1977348bb5d2003-10-18 09:37:26 +00001660#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1661/*
1662** This routine sets the progress callback for an Sqlite database to the
1663** given callback function with the given argument. The progress callback will
1664** be invoked every nOps opcodes.
1665*/
danielk197724b03fd2004-05-10 10:34:34 +00001666void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001667 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001668 int nOps,
1669 int (*xProgress)(void*),
1670 void *pArg
1671){
drh9ca95732014-10-24 00:35:58 +00001672#ifdef SQLITE_ENABLE_API_ARMOR
1673 if( !sqlite3SafetyCheckOk(db) ){
1674 (void)SQLITE_MISUSE_BKPT;
1675 return;
1676 }
1677#endif
drhbd0b1b52008-07-07 19:52:09 +00001678 sqlite3_mutex_enter(db->mutex);
1679 if( nOps>0 ){
1680 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001681 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001682 db->pProgressArg = pArg;
1683 }else{
1684 db->xProgress = 0;
1685 db->nProgressOps = 0;
1686 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001687 }
drhbd0b1b52008-07-07 19:52:09 +00001688 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001689}
1690#endif
1691
1692
drh2dfbbca2000-07-28 14:32:48 +00001693/*
1694** This routine installs a default busy handler that waits for the
1695** specified number of milliseconds before returning 0.
1696*/
danielk1977f9d64d22004-06-19 08:18:07 +00001697int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001698#ifdef SQLITE_ENABLE_API_ARMOR
1699 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1700#endif
drh2dfbbca2000-07-28 14:32:48 +00001701 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001702 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1703 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001704 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001705 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001706 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001707 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001708 }
danielk1977f9d64d22004-06-19 08:18:07 +00001709 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001710}
drh4c504392000-10-16 22:06:40 +00001711
1712/*
1713** Cause any pending operation to stop at its earliest opportunity.
1714*/
drh9bb575f2004-09-06 17:24:11 +00001715void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001716#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001717 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001718 (void)SQLITE_MISUSE_BKPT;
1719 return;
1720 }
1721#endif
drhbd0b1b52008-07-07 19:52:09 +00001722 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001723}
drhfa86c412002-02-02 15:01:15 +00001724
drhfa86c412002-02-02 15:01:15 +00001725
1726/*
danielk1977771151b2006-01-17 13:21:40 +00001727** This function is exactly the same as sqlite3_create_function(), except
1728** that it is designed to be called by internal code. The difference is
1729** that if a malloc() fails in sqlite3_create_function(), an error code
1730** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001731*/
danielk1977771151b2006-01-17 13:21:40 +00001732int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001733 sqlite3 *db,
1734 const char *zFunctionName,
1735 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001736 int enc,
danielk197765904932004-05-26 06:18:37 +00001737 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001738 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001739 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001740 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001741 void (*xValue)(sqlite3_context*),
1742 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001743 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001744){
drh0bce8352002-02-28 00:41:10 +00001745 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001746 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001747 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001748
drhe30f4422007-08-21 16:15:55 +00001749 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001750 assert( xValue==0 || xSFunc==0 );
1751 if( zFunctionName==0 /* Must have a valid name */
1752 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1753 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1754 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1755 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1756 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1757 ){
drh413c3d32010-02-23 20:11:56 +00001758 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001759 }
drh4a8ee3d2013-12-14 13:44:22 +00001760
1761 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001762 assert( SQLITE_FUNC_DIRECT==SQLITE_DIRECTONLY );
drhc4ad8492020-01-03 20:57:38 +00001763 assert( SQLITE_FUNC_SAFE==SQLITE_INNOCUOUS );
1764 extraFlags = enc & (SQLITE_DETERMINISTIC|SQLITE_DIRECTONLY|
1765 SQLITE_SUBTYPE|SQLITE_INNOCUOUS);
drh4a8ee3d2013-12-14 13:44:22 +00001766 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001767
danielk197793758c82005-01-21 08:13:14 +00001768#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001769 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1770 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1771 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1772 **
1773 ** If SQLITE_ANY is specified, add three versions of the function
1774 ** to the hash table.
1775 */
1776 if( enc==SQLITE_UTF16 ){
1777 enc = SQLITE_UTF16NATIVE;
1778 }else if( enc==SQLITE_ANY ){
1779 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001780 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dan660af932018-06-18 16:55:22 +00001781 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001782 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001783 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dan660af932018-06-18 16:55:22 +00001784 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001785 }
1786 if( rc!=SQLITE_OK ){
1787 return rc;
1788 }
danielk1977d8123362004-06-12 09:25:12 +00001789 enc = SQLITE_UTF16BE;
1790 }
danielk197793758c82005-01-21 08:13:14 +00001791#else
1792 enc = SQLITE_UTF8;
1793#endif
danielk19779636c4e2005-01-25 04:27:54 +00001794
1795 /* Check if an existing function is being overridden or deleted. If so,
1796 ** and there are active VMs, then return SQLITE_BUSY. If a function
1797 ** is being overridden/deleted but there are no active VMs, allow the
1798 ** operation to continue but invalidate all precompiled statements.
1799 */
drh80738d92016-02-15 00:34:16 +00001800 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001801 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001802 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001803 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001804 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001805 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001806 return SQLITE_BUSY;
1807 }else{
drhba968db2018-07-24 22:02:12 +00001808 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001809 }
1810 }
danielk197765904932004-05-26 06:18:37 +00001811
drh80738d92016-02-15 00:34:16 +00001812 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001813 assert(p || db->mallocFailed);
1814 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001815 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001816 }
dand2199f02010-08-27 17:48:52 +00001817
1818 /* If an older version of the function with a configured destructor is
1819 ** being replaced invoke the destructor function here. */
1820 functionDestroy(db, p);
1821
1822 if( pDestructor ){
1823 pDestructor->nRef++;
1824 }
drh80738d92016-02-15 00:34:16 +00001825 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001826 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1827 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001828 testcase( p->funcFlags & SQLITE_DIRECTONLY );
drh2d801512016-01-14 22:19:58 +00001829 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001830 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001831 p->xValue = xValue;
1832 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001833 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001834 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001835 return SQLITE_OK;
1836}
danielk1977771151b2006-01-17 13:21:40 +00001837
1838/*
dan660af932018-06-18 16:55:22 +00001839** Worker function used by utf-8 APIs that create new functions:
1840**
1841** sqlite3_create_function()
1842** sqlite3_create_function_v2()
1843** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001844*/
dan660af932018-06-18 16:55:22 +00001845static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001846 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001847 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001848 int nArg,
1849 int enc,
1850 void *p,
dan660af932018-06-18 16:55:22 +00001851 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1852 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001853 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001854 void (*xValue)(sqlite3_context*),
1855 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1856 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001857){
shanehbd2aaf92010-09-01 02:38:21 +00001858 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001859 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001860
1861#ifdef SQLITE_ENABLE_API_ARMOR
1862 if( !sqlite3SafetyCheckOk(db) ){
1863 return SQLITE_MISUSE_BKPT;
1864 }
1865#endif
dand2199f02010-08-27 17:48:52 +00001866 sqlite3_mutex_enter(db->mutex);
1867 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001868 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001869 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001870 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001871 xDestroy(p);
1872 goto out;
1873 }
drh92011842018-05-26 16:00:26 +00001874 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001875 pArg->xDestroy = xDestroy;
1876 pArg->pUserData = p;
1877 }
dan660af932018-06-18 16:55:22 +00001878 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1879 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1880 );
dand2199f02010-08-27 17:48:52 +00001881 if( pArg && pArg->nRef==0 ){
1882 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001883 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001884 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001885 }
1886
1887 out:
drhe30f4422007-08-21 16:15:55 +00001888 rc = sqlite3ApiExit(db, rc);
1889 sqlite3_mutex_leave(db->mutex);
1890 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001891}
1892
dan660af932018-06-18 16:55:22 +00001893/*
1894** Create new user functions.
1895*/
1896int sqlite3_create_function(
1897 sqlite3 *db,
1898 const char *zFunc,
1899 int nArg,
1900 int enc,
1901 void *p,
1902 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1903 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1904 void (*xFinal)(sqlite3_context*)
1905){
1906 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1907 xFinal, 0, 0, 0);
1908}
1909int sqlite3_create_function_v2(
1910 sqlite3 *db,
1911 const char *zFunc,
1912 int nArg,
1913 int enc,
1914 void *p,
1915 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1916 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1917 void (*xFinal)(sqlite3_context*),
1918 void (*xDestroy)(void *)
1919){
1920 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1921 xFinal, 0, 0, xDestroy);
1922}
1923int sqlite3_create_window_function(
1924 sqlite3 *db,
1925 const char *zFunc,
1926 int nArg,
1927 int enc,
1928 void *p,
1929 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1930 void (*xFinal)(sqlite3_context*),
1931 void (*xValue)(sqlite3_context*),
1932 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1933 void (*xDestroy)(void *)
1934){
1935 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1936 xFinal, xValue, xInverse, xDestroy);
1937}
1938
danielk197793758c82005-01-21 08:13:14 +00001939#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001940int sqlite3_create_function16(
1941 sqlite3 *db,
1942 const void *zFunctionName,
1943 int nArg,
1944 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001945 void *p,
drh2d801512016-01-14 22:19:58 +00001946 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001947 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1948 void (*xFinal)(sqlite3_context*)
1949){
1950 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001951 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001952
1953#ifdef SQLITE_ENABLE_API_ARMOR
1954 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1955#endif
drhe30f4422007-08-21 16:15:55 +00001956 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001957 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001958 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00001959 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00001960 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001961 rc = sqlite3ApiExit(db, rc);
1962 sqlite3_mutex_leave(db->mutex);
1963 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001964}
danielk197793758c82005-01-21 08:13:14 +00001965#endif
drhc9b84a12002-06-20 11:36:48 +00001966
drhb7481e72006-09-16 21:45:14 +00001967
1968/*
drh92011842018-05-26 16:00:26 +00001969** The following is the implementation of an SQL function that always
1970** fails with an error message stating that the function is used in the
1971** wrong context. The sqlite3_overload_function() API might construct
1972** SQL function that use this routine so that the functions will exist
1973** for name resolution but are actually overloaded by the xFindFunction
1974** method of virtual tables.
1975*/
1976static void sqlite3InvalidFunction(
1977 sqlite3_context *context, /* The function calling context */
1978 int NotUsed, /* Number of arguments to the function */
1979 sqlite3_value **NotUsed2 /* Value of each argument */
1980){
1981 const char *zName = (const char*)sqlite3_user_data(context);
1982 char *zErr;
1983 UNUSED_PARAMETER2(NotUsed, NotUsed2);
1984 zErr = sqlite3_mprintf(
1985 "unable to use function %s in the requested context", zName);
1986 sqlite3_result_error(context, zErr, -1);
1987 sqlite3_free(zErr);
1988}
1989
1990/*
drhb7481e72006-09-16 21:45:14 +00001991** Declare that a function has been overloaded by a virtual table.
1992**
1993** If the function already exists as a regular global function, then
1994** this routine is a no-op. If the function does not exist, then create
1995** a new one that always throws a run-time error.
1996**
1997** When virtual tables intend to provide an overloaded function, they
1998** should call this routine to make sure the global function exists.
1999** A global function must exist in order for name resolution to work
2000** properly.
2001*/
2002int sqlite3_overload_function(
2003 sqlite3 *db,
2004 const char *zName,
2005 int nArg
2006){
drh92011842018-05-26 16:00:26 +00002007 int rc;
2008 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00002009
2010#ifdef SQLITE_ENABLE_API_ARMOR
2011 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
2012 return SQLITE_MISUSE_BKPT;
2013 }
2014#endif
drhe30f4422007-08-21 16:15:55 +00002015 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00002016 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00002017 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00002018 if( rc ) return SQLITE_OK;
2019 zCopy = sqlite3_mprintf(zName);
2020 if( zCopy==0 ) return SQLITE_NOMEM;
2021 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
2022 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00002023}
2024
drh19e2d372005-08-29 23:00:03 +00002025#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00002026/*
drh18de4822003-01-16 16:28:53 +00002027** Register a trace function. The pArg from the previously registered trace
2028** is returned.
2029**
2030** A NULL trace function means that no tracing is executes. A non-NULL
2031** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00002032** SQL statement.
drh18de4822003-01-16 16:28:53 +00002033*/
drh3d2a5292016-07-13 22:55:01 +00002034#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00002035void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00002036 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002037
2038#ifdef SQLITE_ENABLE_API_ARMOR
2039 if( !sqlite3SafetyCheckOk(db) ){
2040 (void)SQLITE_MISUSE_BKPT;
2041 return 0;
2042 }
2043#endif
drhe30f4422007-08-21 16:15:55 +00002044 sqlite3_mutex_enter(db->mutex);
2045 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00002046 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00002047 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00002048 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002049 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002050 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002051}
drh3d2a5292016-07-13 22:55:01 +00002052#endif /* SQLITE_OMIT_DEPRECATED */
2053
2054/* Register a trace callback using the version-2 interface.
2055*/
2056int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002057 sqlite3 *db, /* Trace this connection */
2058 unsigned mTrace, /* Mask of events to be traced */
2059 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2060 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002061){
2062#ifdef SQLITE_ENABLE_API_ARMOR
2063 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002064 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002065 }
2066#endif
2067 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002068 if( mTrace==0 ) xTrace = 0;
2069 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002070 db->mTrace = mTrace;
2071 db->xTrace = xTrace;
2072 db->pTraceArg = pArg;
2073 sqlite3_mutex_leave(db->mutex);
2074 return SQLITE_OK;
2075}
2076
drh087ec072016-07-25 00:05:56 +00002077#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002078/*
2079** Register a profile function. The pArg from the previously registered
2080** profile function is returned.
2081**
2082** A NULL profile function means that no profiling is executes. A non-NULL
2083** profile is a pointer to a function that is invoked at the conclusion of
2084** each SQL statement that is run.
2085*/
2086void *sqlite3_profile(
2087 sqlite3 *db,
2088 void (*xProfile)(void*,const char*,sqlite_uint64),
2089 void *pArg
2090){
drhe30f4422007-08-21 16:15:55 +00002091 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002092
2093#ifdef SQLITE_ENABLE_API_ARMOR
2094 if( !sqlite3SafetyCheckOk(db) ){
2095 (void)SQLITE_MISUSE_BKPT;
2096 return 0;
2097 }
2098#endif
drhe30f4422007-08-21 16:15:55 +00002099 sqlite3_mutex_enter(db->mutex);
2100 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002101 db->xProfile = xProfile;
2102 db->pProfileArg = pArg;
drh04c67472018-12-04 14:33:02 +00002103 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2104 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
drhe30f4422007-08-21 16:15:55 +00002105 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002106 return pOld;
2107}
drh087ec072016-07-25 00:05:56 +00002108#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002109#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002110
drhcd565fd2012-03-01 21:30:44 +00002111/*
2112** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002113** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002114** rollback.
2115*/
danielk197724b03fd2004-05-10 10:34:34 +00002116void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002117 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002118 int (*xCallback)(void*), /* Function to invoke on each commit */
2119 void *pArg /* Argument to the function */
2120){
drhe30f4422007-08-21 16:15:55 +00002121 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002122
2123#ifdef SQLITE_ENABLE_API_ARMOR
2124 if( !sqlite3SafetyCheckOk(db) ){
2125 (void)SQLITE_MISUSE_BKPT;
2126 return 0;
2127 }
2128#endif
drhe30f4422007-08-21 16:15:55 +00002129 sqlite3_mutex_enter(db->mutex);
2130 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002131 db->xCommitCallback = xCallback;
2132 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002133 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002134 return pOld;
2135}
2136
danielk197794eb6a12005-12-15 15:22:08 +00002137/*
2138** Register a callback to be invoked each time a row is updated,
2139** inserted or deleted using this database connection.
2140*/
danielk197771fd80b2005-12-16 06:54:01 +00002141void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002142 sqlite3 *db, /* Attach the hook to this database */
2143 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2144 void *pArg /* Argument to the function */
2145){
drhe30f4422007-08-21 16:15:55 +00002146 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002147
2148#ifdef SQLITE_ENABLE_API_ARMOR
2149 if( !sqlite3SafetyCheckOk(db) ){
2150 (void)SQLITE_MISUSE_BKPT;
2151 return 0;
2152 }
2153#endif
drhe30f4422007-08-21 16:15:55 +00002154 sqlite3_mutex_enter(db->mutex);
2155 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002156 db->xUpdateCallback = xCallback;
2157 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002158 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002159 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002160}
2161
danielk197771fd80b2005-12-16 06:54:01 +00002162/*
2163** Register a callback to be invoked each time a transaction is rolled
2164** back by this database connection.
2165*/
2166void *sqlite3_rollback_hook(
2167 sqlite3 *db, /* Attach the hook to this database */
2168 void (*xCallback)(void*), /* Callback function */
2169 void *pArg /* Argument to the function */
2170){
drhe30f4422007-08-21 16:15:55 +00002171 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002172
2173#ifdef SQLITE_ENABLE_API_ARMOR
2174 if( !sqlite3SafetyCheckOk(db) ){
2175 (void)SQLITE_MISUSE_BKPT;
2176 return 0;
2177 }
2178#endif
drhe30f4422007-08-21 16:15:55 +00002179 sqlite3_mutex_enter(db->mutex);
2180 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002181 db->xRollbackCallback = xCallback;
2182 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002183 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002184 return pRet;
2185}
drhaa940ea2004-01-15 02:44:03 +00002186
drh9b1c62d2011-03-30 21:04:43 +00002187#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002188/*
2189** Register a callback to be invoked each time a row is updated,
2190** inserted or deleted using this database connection.
2191*/
2192void *sqlite3_preupdate_hook(
2193 sqlite3 *db, /* Attach the hook to this database */
2194 void(*xCallback)( /* Callback function */
2195 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2196 void *pArg /* First callback argument */
2197){
2198 void *pRet;
2199 sqlite3_mutex_enter(db->mutex);
2200 pRet = db->pPreUpdateArg;
2201 db->xPreUpdateCallback = xCallback;
2202 db->pPreUpdateArg = pArg;
2203 sqlite3_mutex_leave(db->mutex);
2204 return pRet;
2205}
drh9b1c62d2011-03-30 21:04:43 +00002206#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002207
dan586b9c82010-05-03 08:04:49 +00002208#ifndef SQLITE_OMIT_WAL
2209/*
2210** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002211** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2212** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002213** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002214*/
drhb033d8b2010-05-03 13:37:30 +00002215int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002216 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002217 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002218 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002219 int nFrame /* Size of WAL */
2220){
drh5def0842010-05-05 20:00:25 +00002221 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002222 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002223 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002224 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002225 }
2226 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002227}
drhb033d8b2010-05-03 13:37:30 +00002228#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002229
2230/*
2231** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2232** a database after committing a transaction if there are nFrame or
2233** more frames in the log file. Passing zero or a negative value as the
2234** nFrame parameter disables automatic checkpoints entirely.
2235**
2236** The callback registered by this function replaces any existing callback
2237** registered using sqlite3_wal_hook(). Likewise, registering a callback
2238** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2239** configured by this function.
2240*/
2241int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002242#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002243 UNUSED_PARAMETER(db);
2244 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002245#else
drh9ca95732014-10-24 00:35:58 +00002246#ifdef SQLITE_ENABLE_API_ARMOR
2247 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2248#endif
dan586b9c82010-05-03 08:04:49 +00002249 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002250 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002251 }else{
2252 sqlite3_wal_hook(db, 0, 0);
2253 }
drhb033d8b2010-05-03 13:37:30 +00002254#endif
dan586b9c82010-05-03 08:04:49 +00002255 return SQLITE_OK;
2256}
2257
paulb0208cc2003-04-13 18:26:49 +00002258/*
dan8d22a172010-04-19 18:03:51 +00002259** Register a callback to be invoked each time a transaction is written
2260** into the write-ahead-log by this database connection.
2261*/
drh833bf962010-04-28 14:42:19 +00002262void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002263 sqlite3 *db, /* Attach the hook to this db handle */
2264 int(*xCallback)(void *, sqlite3*, const char*, int),
2265 void *pArg /* First argument passed to xCallback() */
2266){
drhb033d8b2010-05-03 13:37:30 +00002267#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002268 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002269#ifdef SQLITE_ENABLE_API_ARMOR
2270 if( !sqlite3SafetyCheckOk(db) ){
2271 (void)SQLITE_MISUSE_BKPT;
2272 return 0;
2273 }
2274#endif
dan8d22a172010-04-19 18:03:51 +00002275 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002276 pRet = db->pWalArg;
2277 db->xWalCallback = xCallback;
2278 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002279 sqlite3_mutex_leave(db->mutex);
2280 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002281#else
2282 return 0;
2283#endif
dan8d22a172010-04-19 18:03:51 +00002284}
2285
2286/*
dancdc1f042010-11-18 12:11:05 +00002287** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002288*/
dancdc1f042010-11-18 12:11:05 +00002289int sqlite3_wal_checkpoint_v2(
2290 sqlite3 *db, /* Database handle */
2291 const char *zDb, /* Name of attached database (or NULL) */
2292 int eMode, /* SQLITE_CHECKPOINT_* value */
2293 int *pnLog, /* OUT: Size of WAL log in frames */
2294 int *pnCkpt /* OUT: Total number of frames checkpointed */
2295){
drhb033d8b2010-05-03 13:37:30 +00002296#ifdef SQLITE_OMIT_WAL
2297 return SQLITE_OK;
2298#else
dan586b9c82010-05-03 08:04:49 +00002299 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002300 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002301
drh9ca95732014-10-24 00:35:58 +00002302#ifdef SQLITE_ENABLE_API_ARMOR
2303 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2304#endif
2305
dan9c5e3682011-02-07 15:12:12 +00002306 /* Initialize the output variables to -1 in case an error occurs. */
2307 if( pnLog ) *pnLog = -1;
2308 if( pnCkpt ) *pnCkpt = -1;
2309
danf26a1542014-12-02 19:04:54 +00002310 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2311 assert( SQLITE_CHECKPOINT_FULL==1 );
2312 assert( SQLITE_CHECKPOINT_RESTART==2 );
2313 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2314 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002315 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2316 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002317 return SQLITE_MISUSE;
2318 }
2319
dan586b9c82010-05-03 08:04:49 +00002320 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002321 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002322 iDb = sqlite3FindDbName(db, zDb);
2323 }
2324 if( iDb<0 ){
2325 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002326 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002327 }else{
dan976b0032015-01-29 19:12:12 +00002328 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002329 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002330 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002331 }
drhb033d8b2010-05-03 13:37:30 +00002332 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002333
2334 /* If there are no active statements, clear the interrupt flag at this
2335 ** point. */
2336 if( db->nVdbeActive==0 ){
2337 db->u1.isInterrupted = 0;
2338 }
2339
dan586b9c82010-05-03 08:04:49 +00002340 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002341 return rc;
2342#endif
dan586b9c82010-05-03 08:04:49 +00002343}
2344
dancdc1f042010-11-18 12:11:05 +00002345
2346/*
2347** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2348** to contains a zero-length string, all attached databases are
2349** checkpointed.
2350*/
2351int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002352 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2353 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2354 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002355}
2356
drhb033d8b2010-05-03 13:37:30 +00002357#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002358/*
2359** Run a checkpoint on database iDb. This is a no-op if database iDb is
2360** not currently open in WAL mode.
2361**
dan6fcff072010-05-03 14:05:43 +00002362** If a transaction is open on the database being checkpointed, this
2363** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2364** an error occurs while running the checkpoint, an SQLite error code is
2365** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002366**
2367** The mutex on database handle db should be held by the caller. The mutex
2368** associated with the specific b-tree being checkpointed is taken by
2369** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002370**
2371** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2372** checkpointed. If an error is encountered it is returned immediately -
2373** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002374**
dan78345512017-09-08 17:48:00 +00002375** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2376** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002377*/
dancdc1f042010-11-18 12:11:05 +00002378int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002379 int rc = SQLITE_OK; /* Return code */
2380 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002381 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002382
2383 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002384 assert( !pnLog || *pnLog==-1 );
2385 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002386
dan6fcff072010-05-03 14:05:43 +00002387 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2388 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002389 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002390 pnLog = 0;
2391 pnCkpt = 0;
2392 if( rc==SQLITE_BUSY ){
2393 bBusy = 1;
2394 rc = SQLITE_OK;
2395 }
dan6fcff072010-05-03 14:05:43 +00002396 }
dan586b9c82010-05-03 08:04:49 +00002397 }
2398
danf2b8dd52010-11-18 19:28:01 +00002399 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002400}
drhb033d8b2010-05-03 13:37:30 +00002401#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002402
2403/*
danielk1977d8293352009-04-30 09:10:37 +00002404** This function returns true if main-memory should be used instead of
2405** a temporary file for transient pager files and statement journals.
2406** The value returned depends on the value of db->temp_store (runtime
2407** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2408** following table describes the relationship between these two values
2409** and this functions return value.
2410**
2411** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2412** ----------------- -------------- ------------------------------
2413** 0 any file (return 0)
2414** 1 1 file (return 0)
2415** 1 2 memory (return 1)
2416** 1 0 file (return 0)
2417** 2 1 file (return 0)
2418** 2 2 memory (return 1)
2419** 2 0 memory (return 1)
2420** 3 any memory (return 1)
2421*/
drh1c514142009-04-30 12:25:10 +00002422int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002423#if SQLITE_TEMP_STORE==1
2424 return ( db->temp_store==2 );
2425#endif
2426#if SQLITE_TEMP_STORE==2
2427 return ( db->temp_store!=1 );
2428#endif
2429#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002430 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002431 return 1;
shanecf697392009-06-01 16:53:09 +00002432#endif
2433#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002434 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002435 return 0;
shane60a4b532009-05-06 18:57:09 +00002436#endif
danielk1977d8293352009-04-30 09:10:37 +00002437}
2438
2439/*
danielk19774ad17132004-05-21 01:47:26 +00002440** Return UTF-8 encoded English language explanation of the most recent
2441** error.
2442*/
danielk19776622cce2004-05-20 11:00:52 +00002443const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002444 const char *z;
drhf49661a2008-12-10 16:45:50 +00002445 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002446 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002447 }
drhd55d57e2008-07-07 17:53:07 +00002448 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002449 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002450 }
drh27641702007-08-22 02:56:42 +00002451 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002452 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002453 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002454 }else{
drha3cc0072013-12-13 16:23:55 +00002455 testcase( db->pErr==0 );
drh368bfe82018-12-11 12:20:41 +00002456 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
danielk1977238746a2009-03-19 18:51:06 +00002457 assert( !db->mallocFailed );
2458 if( z==0 ){
2459 z = sqlite3ErrStr(db->errCode);
2460 }
danielk19776622cce2004-05-20 11:00:52 +00002461 }
drhe30f4422007-08-21 16:15:55 +00002462 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002463 return z;
danielk19776622cce2004-05-20 11:00:52 +00002464}
2465
drh6c626082004-11-14 21:56:29 +00002466#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002467/*
2468** Return UTF-16 encoded English language explanation of the most recent
2469** error.
2470*/
danielk19776622cce2004-05-20 11:00:52 +00002471const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002472 static const u16 outOfMem[] = {
2473 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002474 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002475 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002476 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2477 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2478 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002479 };
danielk19774ad17132004-05-21 01:47:26 +00002480
drhc60d0442004-09-30 13:43:13 +00002481 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002482 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002483 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002484 }
drhd55d57e2008-07-07 17:53:07 +00002485 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002486 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002487 }
drhe30f4422007-08-21 16:15:55 +00002488 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002489 if( db->mallocFailed ){
2490 z = (void *)outOfMem;
2491 }else{
drhc60d0442004-09-30 13:43:13 +00002492 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002493 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002494 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002495 z = sqlite3_value_text16(db->pErr);
2496 }
2497 /* A malloc() may have failed within the call to sqlite3_value_text16()
2498 ** above. If this is the case, then the db->mallocFailed flag needs to
2499 ** be cleared before returning. Do this directly, instead of via
2500 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2501 */
drh4a642b62016-02-05 01:55:27 +00002502 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002503 }
drhe30f4422007-08-21 16:15:55 +00002504 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002505 return z;
danielk19776622cce2004-05-20 11:00:52 +00002506}
drh6c626082004-11-14 21:56:29 +00002507#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002508
drhc60d0442004-09-30 13:43:13 +00002509/*
danielk19777ddad962005-12-12 06:53:03 +00002510** Return the most recent error code generated by an SQLite routine. If NULL is
2511** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002512*/
danielk19776622cce2004-05-20 11:00:52 +00002513int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002514 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002515 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002516 }
drh01495b92008-01-23 12:52:40 +00002517 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002518 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002519 }
drh4ac285a2006-09-15 07:28:50 +00002520 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002521}
drh99dfe5e2008-10-30 15:03:15 +00002522int sqlite3_extended_errcode(sqlite3 *db){
2523 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002524 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002525 }
2526 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002527 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002528 }
2529 return db->errCode;
2530}
drh1b9f2142016-03-17 16:01:23 +00002531int sqlite3_system_errno(sqlite3 *db){
2532 return db ? db->iSysErrno : 0;
2533}
danielk19776622cce2004-05-20 11:00:52 +00002534
drh0e819f92006-02-01 13:50:41 +00002535/*
mistachkin5dac8432012-09-11 02:00:25 +00002536** Return a string that describes the kind of error specified in the
2537** argument. For now, this simply calls the internal sqlite3ErrStr()
2538** function.
2539*/
2540const char *sqlite3_errstr(int rc){
2541 return sqlite3ErrStr(rc);
2542}
2543
2544/*
drh0e819f92006-02-01 13:50:41 +00002545** Create a new collating function for database "db". The name is zName
2546** and the encoding is enc.
2547*/
danielk19779a30cf62006-01-18 04:26:07 +00002548static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002549 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002550 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002551 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002552 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002553 int(*xCompare)(void*,int,const void*,int,const void*),
2554 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002555){
2556 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002557 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002558
drhe30f4422007-08-21 16:15:55 +00002559 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002560
2561 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2562 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2563 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2564 */
drh51c7d862009-04-27 18:46:06 +00002565 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002566 testcase( enc2==SQLITE_UTF16 );
2567 testcase( enc2==SQLITE_UTF16_ALIGNED );
2568 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002569 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002570 }
drh51c7d862009-04-27 18:46:06 +00002571 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002572 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002573 }
2574
2575 /* Check if this call is removing or replacing an existing collation
2576 ** sequence. If so, and there are active VMs, return busy. If there
2577 ** are no active VMs, invalidate any pre-compiled statements.
2578 */
drhc4a64fa2009-05-11 20:53:28 +00002579 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002580 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002581 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002582 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002583 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002584 return SQLITE_BUSY;
2585 }
drhba968db2018-07-24 22:02:12 +00002586 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002587
2588 /* If collation sequence pColl was created directly by a call to
2589 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2590 ** then any copies made by synthCollSeq() need to be invalidated.
2591 ** Also, collation destructor - CollSeq.xDel() - function may need
2592 ** to be called.
2593 */
2594 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002595 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002596 int j;
2597 for(j=0; j<3; j++){
2598 CollSeq *p = &aColl[j];
2599 if( p->enc==pColl->enc ){
2600 if( p->xDel ){
2601 p->xDel(p->pUser);
2602 }
2603 p->xCmp = 0;
2604 }
2605 }
2606 }
danielk19779a30cf62006-01-18 04:26:07 +00002607 }
2608
drhc4a64fa2009-05-11 20:53:28 +00002609 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002610 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002611 pColl->xCmp = xCompare;
2612 pColl->pUser = pCtx;
2613 pColl->xDel = xDel;
2614 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002615 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002616 return SQLITE_OK;
2617}
2618
2619
danielk19776622cce2004-05-20 11:00:52 +00002620/*
drhbb4957f2008-03-20 14:03:29 +00002621** This array defines hard upper bounds on limit values. The
2622** initializer must be kept in sync with the SQLITE_LIMIT_*
2623** #defines in sqlite3.h.
2624*/
drhb1a6c3c2008-03-20 16:30:17 +00002625static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002626 SQLITE_MAX_LENGTH,
2627 SQLITE_MAX_SQL_LENGTH,
2628 SQLITE_MAX_COLUMN,
2629 SQLITE_MAX_EXPR_DEPTH,
2630 SQLITE_MAX_COMPOUND_SELECT,
2631 SQLITE_MAX_VDBE_OP,
2632 SQLITE_MAX_FUNCTION_ARG,
2633 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002634 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002635 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002636 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002637 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002638};
2639
2640/*
2641** Make sure the hard limits are set to reasonable values
2642*/
2643#if SQLITE_MAX_LENGTH<100
2644# error SQLITE_MAX_LENGTH must be at least 100
2645#endif
2646#if SQLITE_MAX_SQL_LENGTH<100
2647# error SQLITE_MAX_SQL_LENGTH must be at least 100
2648#endif
2649#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2650# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2651#endif
drhbb4957f2008-03-20 14:03:29 +00002652#if SQLITE_MAX_COMPOUND_SELECT<2
2653# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2654#endif
2655#if SQLITE_MAX_VDBE_OP<40
2656# error SQLITE_MAX_VDBE_OP must be at least 40
2657#endif
drh80738d92016-02-15 00:34:16 +00002658#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2659# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002660#endif
drhd08b2792014-07-22 15:33:31 +00002661#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2662# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002663#endif
drhbb4957f2008-03-20 14:03:29 +00002664#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2665# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2666#endif
drh70a8ca32008-08-21 18:49:27 +00002667#if SQLITE_MAX_COLUMN>32767
2668# error SQLITE_MAX_COLUMN must not exceed 32767
2669#endif
drh417168a2009-09-07 18:14:02 +00002670#if SQLITE_MAX_TRIGGER_DEPTH<1
2671# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2672#endif
drh111544c2014-08-29 16:20:47 +00002673#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2674# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2675#endif
drhbb4957f2008-03-20 14:03:29 +00002676
2677
2678/*
2679** Change the value of a limit. Report the old value.
2680** If an invalid limit index is supplied, report -1.
2681** Make no changes but still report the old value if the
2682** new limit is negative.
2683**
2684** A new lower limit does not shrink existing constructs.
2685** It merely prevents new constructs that exceed the limit
2686** from forming.
2687*/
2688int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2689 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002690
drh9ca95732014-10-24 00:35:58 +00002691#ifdef SQLITE_ENABLE_API_ARMOR
2692 if( !sqlite3SafetyCheckOk(db) ){
2693 (void)SQLITE_MISUSE_BKPT;
2694 return -1;
2695 }
2696#endif
drh4e93f5b2010-09-07 14:59:15 +00002697
2698 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2699 ** there is a hard upper bound set at compile-time by a C preprocessor
2700 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2701 ** "_MAX_".)
2702 */
2703 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2704 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2705 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2706 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2707 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2708 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2709 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2710 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2711 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2712 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2713 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2714 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002715 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2716 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002717
2718
drh521cc842008-04-15 02:36:33 +00002719 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002720 return -1;
2721 }
2722 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002723 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002724 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002725 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002726 }
2727 db->aLimit[limitId] = newLimit;
2728 }
drh4e93f5b2010-09-07 14:59:15 +00002729 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002730}
2731
2732/*
dan286ab7c2011-05-06 18:34:54 +00002733** This function is used to parse both URIs and non-URI filenames passed by the
2734** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2735** URIs specified as part of ATTACH statements.
2736**
2737** The first argument to this function is the name of the VFS to use (or
2738** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2739** query parameter. The second argument contains the URI (or non-URI filename)
2740** itself. When this function is called the *pFlags variable should contain
2741** the default flags to open the database handle with. The value stored in
2742** *pFlags may be updated before returning if the URI filename contains
2743** "cache=xxx" or "mode=xxx" query parameters.
2744**
2745** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2746** the VFS that should be used to open the database file. *pzFile is set to
2747** point to a buffer containing the name of the file to open. It is the
2748** responsibility of the caller to eventually call sqlite3_free() to release
2749** this buffer.
2750**
2751** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2752** may be set to point to a buffer containing an English language error
2753** message. It is the responsibility of the caller to eventually release
2754** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002755*/
2756int sqlite3ParseUri(
2757 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2758 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002759 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002760 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2761 char **pzFile, /* OUT: Filename component of URI */
2762 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2763){
dan78e9dd22011-05-03 10:22:32 +00002764 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002765 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002766 const char *zVfs = zDefaultVfs;
2767 char *zFile;
drhde941c32011-05-09 19:20:17 +00002768 char c;
dancd74b612011-04-22 19:37:32 +00002769 int nUri = sqlite3Strlen30(zUri);
2770
2771 assert( *pzErrMsg==0 );
2772
drh8790b6e2014-11-07 01:43:56 +00002773 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2774 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002775 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002776 ){
dan5de15372011-04-23 10:12:30 +00002777 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002778 int eState; /* Parser state when parsing URI */
2779 int iIn; /* Input character index */
2780 int iOut = 0; /* Output character index */
drhf3cdcdc2015-04-29 16:50:28 +00002781 u64 nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002782
dan286ab7c2011-05-06 18:34:54 +00002783 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2784 ** method that there may be extra parameters following the file-name. */
2785 flags |= SQLITE_OPEN_URI;
2786
2787 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002788 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002789 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002790
drh869c0402013-08-07 23:15:52 +00002791 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002792#ifdef SQLITE_ALLOW_URI_AUTHORITY
2793 if( strncmp(zUri+5, "///", 3)==0 ){
2794 iIn = 7;
2795 /* The following condition causes URIs with five leading / characters
2796 ** like file://///host/path to be converted into UNCs like //host/path.
2797 ** The correct URI for that UNC has only two or four leading / characters
2798 ** file://host/path or file:////host/path. But 5 leading slashes is a
2799 ** common error, we are told, so we handle it as a special case. */
2800 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2801 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2802 iIn = 16;
2803 }
2804#else
dancd74b612011-04-22 19:37:32 +00002805 /* Discard the scheme and authority segments of the URI. */
2806 if( zUri[5]=='/' && zUri[6]=='/' ){
2807 iIn = 7;
2808 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002809 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2810 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2811 iIn-7, &zUri[7]);
2812 rc = SQLITE_ERROR;
2813 goto parse_uri_out;
2814 }
dancd74b612011-04-22 19:37:32 +00002815 }
drh869c0402013-08-07 23:15:52 +00002816#endif
dancd74b612011-04-22 19:37:32 +00002817
2818 /* Copy the filename and any query parameters into the zFile buffer.
2819 ** Decode %HH escape codes along the way.
2820 **
2821 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2822 ** on the parsing context. As follows:
2823 **
2824 ** 0: Parsing file-name.
2825 ** 1: Parsing name section of a name=value query parameter.
2826 ** 2: Parsing value section of a name=value query parameter.
2827 */
2828 eState = 0;
drhde941c32011-05-09 19:20:17 +00002829 while( (c = zUri[iIn])!=0 && c!='#' ){
2830 iIn++;
dancd74b612011-04-22 19:37:32 +00002831 if( c=='%'
2832 && sqlite3Isxdigit(zUri[iIn])
2833 && sqlite3Isxdigit(zUri[iIn+1])
2834 ){
dan6d49e252011-05-03 15:09:05 +00002835 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2836 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002837
dan6d49e252011-05-03 15:09:05 +00002838 assert( octet>=0 && octet<256 );
2839 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002840#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002841 /* This branch is taken when "%00" appears within the URI. In this
2842 ** case we ignore all text in the remainder of the path, name or
2843 ** value currently being parsed. So ignore the current character
2844 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002845 while( (c = zUri[iIn])!=0 && c!='#'
2846 && (eState!=0 || c!='?')
2847 && (eState!=1 || (c!='=' && c!='&'))
2848 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002849 ){
2850 iIn++;
2851 }
2852 continue;
dan5c35e902016-10-26 12:15:41 +00002853#else
2854 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2855 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2856 rc = SQLITE_ERROR;
2857 goto parse_uri_out;
2858#endif
dancd74b612011-04-22 19:37:32 +00002859 }
dan6d49e252011-05-03 15:09:05 +00002860 c = octet;
dan5de15372011-04-23 10:12:30 +00002861 }else if( eState==1 && (c=='&' || c=='=') ){
2862 if( zFile[iOut-1]==0 ){
2863 /* An empty option name. Ignore this option altogether. */
2864 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2865 continue;
2866 }
2867 if( c=='&' ){
2868 zFile[iOut++] = '\0';
2869 }else{
2870 eState = 2;
2871 }
dancd74b612011-04-22 19:37:32 +00002872 c = 0;
dan5de15372011-04-23 10:12:30 +00002873 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2874 c = 0;
dancd74b612011-04-22 19:37:32 +00002875 eState = 1;
dancd74b612011-04-22 19:37:32 +00002876 }
2877 zFile[iOut++] = c;
2878 }
2879 if( eState==1 ) zFile[iOut++] = '\0';
2880 zFile[iOut++] = '\0';
2881 zFile[iOut++] = '\0';
2882
2883 /* Check if there were any options specified that should be interpreted
2884 ** here. Options that are interpreted here include "vfs" and those that
2885 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002886 ** method. */
dan5de15372011-04-23 10:12:30 +00002887 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2888 while( zOpt[0] ){
2889 int nOpt = sqlite3Strlen30(zOpt);
2890 char *zVal = &zOpt[nOpt+1];
2891 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002892
dan286ab7c2011-05-06 18:34:54 +00002893 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002894 zVfs = zVal;
2895 }else{
2896 struct OpenMode {
2897 const char *z;
2898 int mode;
2899 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002900 char *zModeType = 0;
2901 int mask = 0;
2902 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002903
dan286ab7c2011-05-06 18:34:54 +00002904 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002905 static struct OpenMode aCacheMode[] = {
2906 { "shared", SQLITE_OPEN_SHAREDCACHE },
2907 { "private", SQLITE_OPEN_PRIVATECACHE },
2908 { 0, 0 }
2909 };
2910
2911 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2912 aMode = aCacheMode;
2913 limit = mask;
2914 zModeType = "cache";
2915 }
dan286ab7c2011-05-06 18:34:54 +00002916 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002917 static struct OpenMode aOpenMode[] = {
2918 { "ro", SQLITE_OPEN_READONLY },
2919 { "rw", SQLITE_OPEN_READWRITE },
2920 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002921 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002922 { 0, 0 }
2923 };
2924
drh9c67b2a2012-05-28 13:58:00 +00002925 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2926 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002927 aMode = aOpenMode;
2928 limit = mask & flags;
2929 zModeType = "access";
2930 }
2931
2932 if( aMode ){
2933 int i;
2934 int mode = 0;
2935 for(i=0; aMode[i].z; i++){
2936 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002937 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002938 mode = aMode[i].mode;
2939 break;
dancd74b612011-04-22 19:37:32 +00002940 }
2941 }
dan78e9dd22011-05-03 10:22:32 +00002942 if( mode==0 ){
2943 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2944 rc = SQLITE_ERROR;
2945 goto parse_uri_out;
2946 }
drh9c67b2a2012-05-28 13:58:00 +00002947 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002948 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2949 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002950 rc = SQLITE_PERM;
2951 goto parse_uri_out;
2952 }
2953 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002954 }
dancd74b612011-04-22 19:37:32 +00002955 }
dan5de15372011-04-23 10:12:30 +00002956
2957 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002958 }
2959
2960 }else{
drhf3cdcdc2015-04-29 16:50:28 +00002961 zFile = sqlite3_malloc64(nUri+2);
mistachkinfad30392016-02-13 23:43:46 +00002962 if( !zFile ) return SQLITE_NOMEM_BKPT;
dan895decf2016-12-30 14:15:56 +00002963 if( nUri ){
2964 memcpy(zFile, zUri, nUri);
2965 }
dancd74b612011-04-22 19:37:32 +00002966 zFile[nUri] = '\0';
2967 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002968 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002969 }
2970
2971 *ppVfs = sqlite3_vfs_find(zVfs);
2972 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002973 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002974 rc = SQLITE_ERROR;
2975 }
2976 parse_uri_out:
2977 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002978 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002979 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002980 }
2981 *pFlags = flags;
2982 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002983 return rc;
dancd74b612011-04-22 19:37:32 +00002984}
2985
drhe5989722019-02-02 15:59:49 +00002986#if defined(SQLITE_HAS_CODEC)
2987/*
2988** Process URI filename query parameters relevant to the SQLite Encryption
2989** Extension. Return true if any of the relevant query parameters are
2990** seen and return false if not.
2991*/
2992int sqlite3CodecQueryParameters(
2993 sqlite3 *db, /* Database connection */
2994 const char *zDb, /* Which schema is being created/attached */
2995 const char *zUri /* URI filename */
2996){
2997 const char *zKey;
2998 if( (zKey = sqlite3_uri_parameter(zUri, "hexkey"))!=0 && zKey[0] ){
2999 u8 iByte;
3000 int i;
3001 char zDecoded[40];
3002 for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
3003 iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
3004 if( (i&1)!=0 ) zDecoded[i/2] = iByte;
3005 }
3006 sqlite3_key_v2(db, zDb, zDecoded, i/2);
3007 return 1;
3008 }else if( (zKey = sqlite3_uri_parameter(zUri, "key"))!=0 ){
3009 sqlite3_key_v2(db, zDb, zKey, sqlite3Strlen30(zKey));
3010 return 1;
3011 }else if( (zKey = sqlite3_uri_parameter(zUri, "textkey"))!=0 ){
3012 sqlite3_key_v2(db, zDb, zKey, -1);
3013 return 1;
3014 }else{
3015 return 0;
3016 }
3017}
3018#endif
3019
dancd74b612011-04-22 19:37:32 +00003020
3021/*
danielk19774ad17132004-05-21 01:47:26 +00003022** This routine does the work of opening a database on behalf of
3023** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00003024** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00003025*/
3026static int openDatabase(
3027 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00003028 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00003029 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00003030 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00003031){
dancd74b612011-04-22 19:37:32 +00003032 sqlite3 *db; /* Store allocated handle here */
3033 int rc; /* Return code */
3034 int isThreadsafe; /* True for threadsafe connections */
3035 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
3036 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00003037
drh9ca95732014-10-24 00:35:58 +00003038#ifdef SQLITE_ENABLE_API_ARMOR
3039 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3040#endif
drhe0d0f8e2009-04-28 04:47:31 +00003041 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003042#ifndef SQLITE_OMIT_AUTOINIT
3043 rc = sqlite3_initialize();
3044 if( rc ) return rc;
3045#endif
3046
drh039963a2008-09-03 00:43:15 +00003047 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00003048 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00003049 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3050 isThreadsafe = 0;
3051 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3052 isThreadsafe = 1;
3053 }else{
3054 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00003055 }
dan8385bec2017-11-25 17:51:01 +00003056
drhf1f12682009-09-09 14:17:52 +00003057 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00003058 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00003059 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3060 flags |= SQLITE_OPEN_SHAREDCACHE;
3061 }
danielk19779a6284c2008-07-10 17:52:49 +00003062
drhb25a9f42009-05-12 13:35:11 +00003063 /* Remove harmful bits from the flags parameter
3064 **
3065 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3066 ** dealt with in the previous code block. Besides these, the only
3067 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00003068 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3069 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00003070 ** off all other flags.
3071 */
drha4267dc2008-02-19 15:20:44 +00003072 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00003073 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00003074 SQLITE_OPEN_MAIN_DB |
3075 SQLITE_OPEN_TEMP_DB |
3076 SQLITE_OPEN_TRANSIENT_DB |
3077 SQLITE_OPEN_MAIN_JOURNAL |
3078 SQLITE_OPEN_TEMP_JOURNAL |
3079 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00003080 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003081 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003082 SQLITE_OPEN_FULLMUTEX |
3083 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003084 );
3085
danielk19774ad17132004-05-21 01:47:26 +00003086 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003087 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003088 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003089 if( isThreadsafe
3090#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3091 || sqlite3GlobalConfig.bCoreMutex
3092#endif
3093 ){
danielk197759f8c082008-06-18 17:09:10 +00003094 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3095 if( db->mutex==0 ){
3096 sqlite3_free(db);
3097 db = 0;
3098 goto opendb_out;
3099 }
dan8385bec2017-11-25 17:51:01 +00003100 if( isThreadsafe==0 ){
3101 sqlite3MutexWarnOnContention(db->mutex);
3102 }
drh605264d2007-08-21 15:13:19 +00003103 }
drh27641702007-08-22 02:56:42 +00003104 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003105 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003106 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003107 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003108 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003109 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +00003110 db->lookaside.sz = 0;
drh633e6d52008-07-28 19:34:53 +00003111
drhbb4957f2008-03-20 14:03:29 +00003112 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3113 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003114 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003115 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003116 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003117 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003118 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003119 db->nMaxSorterMmap = 0x7FFFFFFF;
drh4b50da92019-07-02 12:23:09 +00003120 db->flags |= SQLITE_ShortColNames
3121 | SQLITE_EnableTrigger
drh11d88e62019-08-15 21:27:20 +00003122 | SQLITE_EnableView
drh4b50da92019-07-02 12:23:09 +00003123 | SQLITE_CacheSpill
drhb945bcd2019-12-31 22:52:10 +00003124 | SQLITE_UnsafeInView
3125 | SQLITE_VtabInView
drh4b50da92019-07-02 12:23:09 +00003126
3127/* The SQLITE_DQS compile-time option determines the default settings
3128** for SQLITE_DBCONFIG_DQS_DDL and SQLITE_DBCONFIG_DQS_DML.
3129**
3130** SQLITE_DQS SQLITE_DBCONFIG_DQS_DDL SQLITE_DBCONFIG_DQS_DML
3131** ---------- ----------------------- -----------------------
3132** undefined on on
3133** 3 on on
3134** 2 on off
3135** 1 off on
3136** 0 off off
3137**
3138** Legacy behavior is 3 (double-quoted string literals are allowed anywhere)
3139** and so that is the default. But developers are encouranged to use
3140** -DSQLITE_DQS=0 (best) or -DSQLITE_DQS=1 (second choice) if possible.
3141*/
3142#if !defined(SQLITE_DQS)
3143# define SQLITE_DQS 3
3144#endif
3145#if (SQLITE_DQS&1)==1
drhd0ff6012019-06-17 13:56:11 +00003146 | SQLITE_DqsDML
drh4b50da92019-07-02 12:23:09 +00003147#endif
3148#if (SQLITE_DQS&2)==2
3149 | SQLITE_DqsDDL
3150#endif
3151
dan1d1f07d2013-07-25 16:41:39 +00003152#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003153 | SQLITE_AutoIndex
3154#endif
drh883ad042015-02-19 00:29:11 +00003155#if SQLITE_DEFAULT_CKPTFULLFSYNC
3156 | SQLITE_CkptFullFSync
3157#endif
drh76fe8032006-07-11 14:17:51 +00003158#if SQLITE_DEFAULT_FILE_FORMAT<4
3159 | SQLITE_LegacyFileFmt
3160#endif
drh56424db2007-03-27 22:24:11 +00003161#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3162 | SQLITE_LoadExtension
3163#endif
dan5bde73c2009-09-01 17:11:07 +00003164#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003165 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003166#endif
drha4bfd7f2010-12-09 19:15:17 +00003167#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3168 | SQLITE_ForeignKeys
3169#endif
drhf5471922014-12-09 15:12:11 +00003170#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3171 | SQLITE_ReverseOrder
3172#endif
drh1421d982015-05-27 03:46:18 +00003173#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3174 | SQLITE_CellSizeCk
3175#endif
drhd42908f2016-02-26 15:38:24 +00003176#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3177 | SQLITE_Fts3Tokenizer
3178#endif
drh169dd922017-06-26 13:57:49 +00003179#if defined(SQLITE_ENABLE_QPSG)
3180 | SQLITE_EnableQPSG
3181#endif
drh6ab91a72018-11-07 02:17:01 +00003182#if defined(SQLITE_DEFAULT_DEFENSIVE)
3183 | SQLITE_Defensive
3184#endif
drh76fe8032006-07-11 14:17:51 +00003185 ;
drhe61922a2009-05-02 13:29:37 +00003186 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003187#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003188 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003189#endif
danielk1977da184232006-01-05 11:34:32 +00003190
danielk19770202b292004-06-09 09:55:16 +00003191 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3192 ** and UTF-16, so add a version for each to avoid any unnecessary
3193 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003194 **
3195 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3196 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003197 */
drhf19aa5f2015-12-30 16:51:20 +00003198 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3199 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3200 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003201 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh821afa42019-06-14 13:24:46 +00003202 createCollation(db, "RTRIM", SQLITE_UTF8, 0, rtrimCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003203 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003204 goto opendb_out;
3205 }
drh5e3b49b2014-11-20 19:22:26 +00003206 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3207 ** strings is BINARY.
3208 */
drhf19aa5f2015-12-30 16:51:20 +00003209 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
drh77db4c02008-03-18 13:01:38 +00003210 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00003211
drhff4fa772017-07-10 12:07:53 +00003212 /* Parse the filename/URI argument
3213 **
3214 ** Only allow sensible combinations of bits in the flags argument.
3215 ** Throw an error if any non-sense combination is used. If we
3216 ** do not block illegal combinations here, it could trigger
3217 ** assert() statements in deeper layers. Sensible combinations
3218 ** are:
3219 **
3220 ** 1: SQLITE_OPEN_READONLY
3221 ** 2: SQLITE_OPEN_READWRITE
3222 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3223 */
dan19432992011-05-10 18:39:10 +00003224 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003225 assert( SQLITE_OPEN_READONLY == 0x01 );
3226 assert( SQLITE_OPEN_READWRITE == 0x02 );
3227 assert( SQLITE_OPEN_CREATE == 0x04 );
3228 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3229 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3230 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3231 if( ((1<<(flags&7)) & 0x46)==0 ){
3232 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3233 }else{
3234 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3235 }
dancd74b612011-04-22 19:37:32 +00003236 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003237 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003238 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003239 sqlite3_free(zErrMsg);
3240 goto opendb_out;
3241 }
3242
danielk19774ad17132004-05-21 01:47:26 +00003243 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003244 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003245 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003246 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003247 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003248 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003249 }
drh13f40da2014-08-22 18:00:11 +00003250 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003251 goto opendb_out;
3252 }
dan0235a032014-12-08 20:20:16 +00003253 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003254 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00003255 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00003256 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003257 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003258
drhe872d512016-02-22 13:23:16 +00003259 /* The default safety_level for the main database is FULL; for the temp
3260 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003261 */
drh69c33822016-08-18 14:33:11 +00003262 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003263 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003264 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003265 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003266
danielk1977832a58a2007-06-22 15:21:15 +00003267 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003268 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003269 goto opendb_out;
3270 }
3271
danielk19778e227872004-06-07 07:52:17 +00003272 /* Register all built-in functions, but do not attempt to read the
3273 ** database schema yet. This is delayed until the first time the database
3274 ** is accessed.
3275 */
drh13f40da2014-08-22 18:00:11 +00003276 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003277 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003278 rc = sqlite3_errcode(db);
3279
3280#ifdef SQLITE_ENABLE_FTS5
3281 /* Register any built-in FTS5 module before loading the automatic
3282 ** extensions. This allows automatic extensions to register FTS5
3283 ** tokenizers and auxiliary functions. */
3284 if( !db->mallocFailed && rc==SQLITE_OK ){
3285 rc = sqlite3Fts5Init(db);
3286 }
3287#endif
danielk19774ad17132004-05-21 01:47:26 +00003288
drh1409be62006-08-23 20:07:20 +00003289 /* Load automatic extensions - extensions that have been registered
3290 ** using the sqlite3_automatic_extension() API.
3291 */
drhe5077c12011-12-13 04:08:36 +00003292 if( rc==SQLITE_OK ){
3293 sqlite3AutoLoadExtensions(db);
3294 rc = sqlite3_errcode(db);
3295 if( rc!=SQLITE_OK ){
3296 goto opendb_out;
3297 }
danielk1977832a58a2007-06-22 15:21:15 +00003298 }
drh1409be62006-08-23 20:07:20 +00003299
drhaa29c132006-09-02 13:58:06 +00003300#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00003301 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003302 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003303 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003304 }
3305#endif
3306
shessa26cf572006-10-19 20:27:58 +00003307#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003308 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003309 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003310 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003311 }
3312#endif
3313
drh50065652015-10-08 19:29:18 +00003314#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003315 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003316 rc = sqlite3Fts3Init(db);
3317 }
3318#endif
3319
dan21540ae2017-12-08 16:23:38 +00003320#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
drh17435752007-08-16 04:30:38 +00003321 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003322 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003323 }
3324#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003325
3326#ifdef SQLITE_ENABLE_RTREE
3327 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003328 rc = sqlite3RtreeInit(db);
3329 }
3330#endif
3331
drha43c8c82017-10-11 13:48:11 +00003332#ifdef SQLITE_ENABLE_DBPAGE_VTAB
3333 if( !db->mallocFailed && rc==SQLITE_OK){
3334 rc = sqlite3DbpageRegister(db);
3335 }
3336#endif
3337
drha3ab9d02015-05-04 20:25:05 +00003338#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3339 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003340 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003341 }
3342#endif
3343
drh2f20e132015-09-26 17:44:59 +00003344#ifdef SQLITE_ENABLE_JSON1
3345 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003346 rc = sqlite3Json1Init(db);
3347 }
3348#endif
3349
drhc6603af2017-06-29 14:33:51 +00003350#ifdef SQLITE_ENABLE_STMTVTAB
drhf00f5302017-06-28 15:47:29 +00003351 if( !db->mallocFailed && rc==SQLITE_OK){
drhc6603af2017-06-29 14:33:51 +00003352 rc = sqlite3StmtVtabInit(db);
drhf00f5302017-06-28 15:47:29 +00003353 }
3354#endif
3355
drh2a83c102020-01-01 23:02:35 +00003356#ifdef SQLITE_ENABLE_INTERNAL_FUNCTIONS
3357 /* Testing use only!!! The -DSQLITE_ENABLE_INTERNAL_FUNCTIONS=1 compile-time
3358 ** option gives access to internal functions by default.
3359 ** Testing use only!!! */
3360 db->mDbFlags |= DBFLAG_InternalFunc;
3361#endif
3362
drh8fd5bd32007-04-02 16:40:37 +00003363 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3364 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3365 ** mode. Doing nothing at all also makes NORMAL the default.
3366 */
3367#ifdef SQLITE_DEFAULT_LOCKING_MODE
3368 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3369 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3370 SQLITE_DEFAULT_LOCKING_MODE);
3371#endif
3372
drh13f40da2014-08-22 18:00:11 +00003373 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003374
drh633e6d52008-07-28 19:34:53 +00003375 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003376 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3377 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003378
dan5a299f92010-05-03 11:05:08 +00003379 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003380
danielk19774ad17132004-05-21 01:47:26 +00003381opendb_out:
drhafc91042008-02-21 02:09:45 +00003382 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003383 assert( db->mutex!=0 || isThreadsafe==0
3384 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003385 sqlite3_mutex_leave(db->mutex);
3386 }
danielk197759633ae2008-08-27 19:01:57 +00003387 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003388 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003389 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003390 sqlite3_close(db);
3391 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003392 }else if( rc!=SQLITE_OK ){
3393 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003394 }
danielk19774ad17132004-05-21 01:47:26 +00003395 *ppDb = db;
danac455932012-11-26 19:50:41 +00003396#ifdef SQLITE_ENABLE_SQLLOG
3397 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003398 /* Opening a db handle. Fourth parameter is passed 0. */
3399 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3400 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003401 }
3402#endif
drh46e6ea02015-10-26 14:41:35 +00003403#if defined(SQLITE_HAS_CODEC)
drhe5989722019-02-02 15:59:49 +00003404 if( rc==SQLITE_OK ) sqlite3CodecQueryParameters(db, 0, zOpen);
drh46e6ea02015-10-26 14:41:35 +00003405#endif
drh095fb472016-01-16 03:16:19 +00003406 sqlite3_free(zOpen);
drh597d2b62015-06-30 03:13:47 +00003407 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003408}
3409
drhe5989722019-02-02 15:59:49 +00003410
danielk19774ad17132004-05-21 01:47:26 +00003411/*
3412** Open a new database handle.
3413*/
danielk197780290862004-05-22 09:21:21 +00003414int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003415 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003416 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003417){
drh605264d2007-08-21 15:13:19 +00003418 return openDatabase(zFilename, ppDb,
3419 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3420}
3421int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003422 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003423 sqlite3 **ppDb, /* OUT: SQLite db handle */
3424 int flags, /* Flags */
3425 const char *zVfs /* Name of VFS module to use */
3426){
drh522c26f2011-05-07 14:40:29 +00003427 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003428}
3429
drh6c626082004-11-14 21:56:29 +00003430#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003431/*
3432** Open a new database handle.
3433*/
3434int sqlite3_open16(
3435 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003436 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003437){
danielk1977bfd6cce2004-06-18 04:24:54 +00003438 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003439 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003440 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003441
drh9ca95732014-10-24 00:35:58 +00003442#ifdef SQLITE_ENABLE_API_ARMOR
3443 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3444#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003445 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003446#ifndef SQLITE_OMIT_AUTOINIT
3447 rc = sqlite3_initialize();
3448 if( rc ) return rc;
3449#endif
drh9ca95732014-10-24 00:35:58 +00003450 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003451 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003452 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3453 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003454 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003455 rc = openDatabase(zFilename8, ppDb,
3456 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003457 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003458 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003459 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003460 }
drh40257ff2008-06-13 18:24:27 +00003461 }else{
mistachkinfad30392016-02-13 23:43:46 +00003462 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003463 }
danielk19777ddad962005-12-12 06:53:03 +00003464 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003465
drh597d2b62015-06-30 03:13:47 +00003466 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003467}
drh6c626082004-11-14 21:56:29 +00003468#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003469
danielk1977106bb232004-05-21 10:08:53 +00003470/*
danielk1977d8123362004-06-12 09:25:12 +00003471** Register a new collation sequence with the database handle db.
3472*/
danielk19770202b292004-06-09 09:55:16 +00003473int sqlite3_create_collation(
3474 sqlite3* db,
3475 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003476 int enc,
danielk19770202b292004-06-09 09:55:16 +00003477 void* pCtx,
3478 int(*xCompare)(void*,int,const void*,int,const void*)
3479){
drh4f81bbb2014-10-23 01:01:26 +00003480 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003481}
3482
3483/*
3484** Register a new collation sequence with the database handle db.
3485*/
danielk1977a393c032007-05-07 14:58:53 +00003486int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003487 sqlite3* db,
3488 const char *zName,
3489 int enc,
3490 void* pCtx,
3491 int(*xCompare)(void*,int,const void*,int,const void*),
3492 void(*xDel)(void*)
3493){
3494 int rc;
drh9ca95732014-10-24 00:35:58 +00003495
3496#ifdef SQLITE_ENABLE_API_ARMOR
3497 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3498#endif
drhe30f4422007-08-21 16:15:55 +00003499 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003500 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003501 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003502 rc = sqlite3ApiExit(db, rc);
3503 sqlite3_mutex_leave(db->mutex);
3504 return rc;
danielk19770202b292004-06-09 09:55:16 +00003505}
3506
drh6c626082004-11-14 21:56:29 +00003507#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003508/*
3509** Register a new collation sequence with the database handle db.
3510*/
danielk19770202b292004-06-09 09:55:16 +00003511int sqlite3_create_collation16(
3512 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003513 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003514 int enc,
danielk19770202b292004-06-09 09:55:16 +00003515 void* pCtx,
3516 int(*xCompare)(void*,int,const void*,int,const void*)
3517){
danielk19779a30cf62006-01-18 04:26:07 +00003518 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003519 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003520
3521#ifdef SQLITE_ENABLE_API_ARMOR
3522 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3523#endif
drhe30f4422007-08-21 16:15:55 +00003524 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003525 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003526 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003527 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003528 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003529 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003530 }
drhe30f4422007-08-21 16:15:55 +00003531 rc = sqlite3ApiExit(db, rc);
3532 sqlite3_mutex_leave(db->mutex);
3533 return rc;
danielk19770202b292004-06-09 09:55:16 +00003534}
drh6c626082004-11-14 21:56:29 +00003535#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003536
danielk1977d8123362004-06-12 09:25:12 +00003537/*
3538** Register a collation sequence factory callback with the database handle
3539** db. Replace any previously installed collation sequence factory.
3540*/
danielk19777cedc8d2004-06-10 10:50:08 +00003541int sqlite3_collation_needed(
3542 sqlite3 *db,
3543 void *pCollNeededArg,
3544 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3545){
drh9ca95732014-10-24 00:35:58 +00003546#ifdef SQLITE_ENABLE_API_ARMOR
3547 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3548#endif
drhe30f4422007-08-21 16:15:55 +00003549 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003550 db->xCollNeeded = xCollNeeded;
3551 db->xCollNeeded16 = 0;
3552 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003553 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003554 return SQLITE_OK;
3555}
danielk1977d8123362004-06-12 09:25:12 +00003556
drh6c626082004-11-14 21:56:29 +00003557#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003558/*
3559** Register a collation sequence factory callback with the database handle
3560** db. Replace any previously installed collation sequence factory.
3561*/
danielk19777cedc8d2004-06-10 10:50:08 +00003562int sqlite3_collation_needed16(
3563 sqlite3 *db,
3564 void *pCollNeededArg,
3565 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3566){
drh9ca95732014-10-24 00:35:58 +00003567#ifdef SQLITE_ENABLE_API_ARMOR
3568 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3569#endif
drhe30f4422007-08-21 16:15:55 +00003570 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003571 db->xCollNeeded = 0;
3572 db->xCollNeeded16 = xCollNeeded16;
3573 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003574 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003575 return SQLITE_OK;
3576}
drh6c626082004-11-14 21:56:29 +00003577#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003578
shaneeec556d2008-10-12 00:27:53 +00003579#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003580/*
danielk19777ddad962005-12-12 06:53:03 +00003581** This function is now an anachronism. It used to be used to recover from a
3582** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003583*/
drh7d97efb2007-10-12 19:35:48 +00003584int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003585 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003586}
3587#endif
drh3e1d8e62005-05-26 16:23:34 +00003588
3589/*
3590** Test to see whether or not the database connection is in autocommit
3591** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3592** by default. Autocommit is disabled by a BEGIN statement and reenabled
3593** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003594*/
3595int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003596#ifdef SQLITE_ENABLE_API_ARMOR
3597 if( !sqlite3SafetyCheckOk(db) ){
3598 (void)SQLITE_MISUSE_BKPT;
3599 return 0;
3600 }
3601#endif
drh3e1d8e62005-05-26 16:23:34 +00003602 return db->autoCommit;
3603}
drh49285702005-09-17 15:20:26 +00003604
drh49285702005-09-17 15:20:26 +00003605/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003606** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003607** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003608** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003609**
3610** 1. Serve as a convenient place to set a breakpoint in a debugger
3611** to detect when version error conditions occurs.
3612**
3613** 2. Invoke sqlite3_log() to provide the source code location where
3614** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003615*/
daneebf2f52017-11-18 17:30:08 +00003616int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003617 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3618 zType, lineno, 20+sqlite3_sourceid());
3619 return iErr;
3620}
drh9978c972010-02-23 17:36:32 +00003621int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003622 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003623 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003624}
drh9978c972010-02-23 17:36:32 +00003625int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003626 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003627 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003628}
3629int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003630 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003631 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003632}
drh32c49902016-02-15 18:15:15 +00003633#ifdef SQLITE_DEBUG
drhcc97ca42017-06-07 22:32:59 +00003634int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3635 char zMsg[100];
3636 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3637 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003638 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003639}
mistachkinfad30392016-02-13 23:43:46 +00003640int sqlite3NomemError(int lineno){
3641 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003642 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003643}
3644int sqlite3IoerrnomemError(int lineno){
3645 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003646 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003647}
drh32c49902016-02-15 18:15:15 +00003648#endif
drh7c1817e2006-01-10 13:58:48 +00003649
shaneeec556d2008-10-12 00:27:53 +00003650#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003651/*
3652** This is a convenience routine that makes sure that all thread-specific
3653** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003654**
3655** SQLite no longer uses thread-specific data so this routine is now a
3656** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003657*/
3658void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003659}
shaneeec556d2008-10-12 00:27:53 +00003660#endif
danielk1977deb802c2006-02-09 13:43:28 +00003661
3662/*
3663** Return meta information about a specific column of a database table.
3664** See comment in sqlite3.h (sqlite.h.in) for details.
3665*/
danielk1977deb802c2006-02-09 13:43:28 +00003666int sqlite3_table_column_metadata(
3667 sqlite3 *db, /* Connection handle */
3668 const char *zDbName, /* Database name or NULL */
3669 const char *zTableName, /* Table name */
3670 const char *zColumnName, /* Column name */
3671 char const **pzDataType, /* OUTPUT: Declared data type */
3672 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3673 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3674 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003675 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003676){
3677 int rc;
3678 char *zErrMsg = 0;
3679 Table *pTab = 0;
3680 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003681 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003682 char const *zDataType = 0;
3683 char const *zCollSeq = 0;
3684 int notnull = 0;
3685 int primarykey = 0;
3686 int autoinc = 0;
3687
drh96c707a2015-02-13 16:36:14 +00003688
3689#ifdef SQLITE_ENABLE_API_ARMOR
3690 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3691 return SQLITE_MISUSE_BKPT;
3692 }
3693#endif
3694
danielk1977deb802c2006-02-09 13:43:28 +00003695 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003696 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003697 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003698 rc = sqlite3Init(db, &zErrMsg);
3699 if( SQLITE_OK!=rc ){
3700 goto error_out;
3701 }
3702
3703 /* Locate the table in question */
3704 pTab = sqlite3FindTable(db, zTableName, zDbName);
3705 if( !pTab || pTab->pSelect ){
3706 pTab = 0;
3707 goto error_out;
3708 }
3709
3710 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003711 if( zColumnName==0 ){
3712 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003713 }else{
3714 for(iCol=0; iCol<pTab->nCol; iCol++){
3715 pCol = &pTab->aCol[iCol];
3716 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3717 break;
3718 }
3719 }
3720 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003721 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3722 iCol = pTab->iPKey;
3723 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3724 }else{
3725 pTab = 0;
3726 goto error_out;
3727 }
danielk1977deb802c2006-02-09 13:43:28 +00003728 }
3729 }
3730
3731 /* The following block stores the meta information that will be returned
3732 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3733 ** and autoinc. At this point there are two possibilities:
3734 **
3735 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3736 ** and there is no explicitly declared IPK column.
3737 **
3738 ** 2. The table is not a view and the column name identified an
3739 ** explicitly declared column. Copy meta information from *pCol.
3740 */
3741 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003742 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003743 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003744 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003745 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003746 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003747 }else{
3748 zDataType = "INTEGER";
3749 primarykey = 1;
3750 }
3751 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003752 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003753 }
3754
3755error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003756 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003757
3758 /* Whether the function call succeeded or failed, set the output parameters
3759 ** to whatever their local counterparts contain. If an error did occur,
3760 ** this has the effect of zeroing all output parameters.
3761 */
3762 if( pzDataType ) *pzDataType = zDataType;
3763 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3764 if( pNotNull ) *pNotNull = notnull;
3765 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3766 if( pAutoinc ) *pAutoinc = autoinc;
3767
3768 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003769 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003770 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003771 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003772 rc = SQLITE_ERROR;
3773 }
drh13f40da2014-08-22 18:00:11 +00003774 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003775 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003776 rc = sqlite3ApiExit(db, rc);
3777 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003778 return rc;
3779}
3780
3781/*
3782** Sleep for a little while. Return the amount of time slept.
3783*/
3784int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003785 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003786 int rc;
drhd677b3d2007-08-20 22:48:41 +00003787 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003788 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003789
3790 /* This function works in milliseconds, but the underlying OsSleep()
3791 ** API uses microseconds. Hence the 1000's.
3792 */
drhe30f4422007-08-21 16:15:55 +00003793 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003794 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003795}
drh4ac285a2006-09-15 07:28:50 +00003796
3797/*
3798** Enable or disable the extended result codes.
3799*/
3800int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003801#ifdef SQLITE_ENABLE_API_ARMOR
3802 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3803#endif
drhe30f4422007-08-21 16:15:55 +00003804 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003805 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003806 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003807 return SQLITE_OK;
3808}
drhcc6bb3e2007-08-31 16:11:35 +00003809
3810/*
3811** Invoke the xFileControl method on a particular database.
3812*/
3813int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3814 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003815 Btree *pBtree;
3816
drh9ca95732014-10-24 00:35:58 +00003817#ifdef SQLITE_ENABLE_API_ARMOR
3818 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3819#endif
drhcc6bb3e2007-08-31 16:11:35 +00003820 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003821 pBtree = sqlite3DbNameToBtree(db, zDbName);
3822 if( pBtree ){
3823 Pager *pPager;
3824 sqlite3_file *fd;
3825 sqlite3BtreeEnter(pBtree);
3826 pPager = sqlite3BtreePager(pBtree);
3827 assert( pPager!=0 );
3828 fd = sqlite3PagerFile(pPager);
3829 assert( fd!=0 );
3830 if( op==SQLITE_FCNTL_FILE_POINTER ){
3831 *(sqlite3_file**)pArg = fd;
3832 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003833 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3834 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3835 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003836 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3837 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3838 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003839 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3840 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3841 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003842 }else{
drhafb39a42018-03-29 13:47:01 +00003843 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003844 }
drh421377e2012-03-15 21:28:54 +00003845 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003846 }
3847 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003848 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003849}
drhed13d982008-01-31 14:43:24 +00003850
3851/*
3852** Interface to the testing logic.
3853*/
3854int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003855 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003856#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003857 UNUSED_PARAMETER(op);
3858#else
drh2fa18682008-03-19 14:15:34 +00003859 va_list ap;
drhed13d982008-01-31 14:43:24 +00003860 va_start(ap, op);
3861 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003862
3863 /*
drh984bfaa2008-03-19 16:08:53 +00003864 ** Save the current state of the PRNG.
3865 */
drh2fa18682008-03-19 14:15:34 +00003866 case SQLITE_TESTCTRL_PRNG_SAVE: {
3867 sqlite3PrngSaveState();
3868 break;
3869 }
drh984bfaa2008-03-19 16:08:53 +00003870
3871 /*
3872 ** Restore the state of the PRNG to the last state saved using
3873 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3874 ** this verb acts like PRNG_RESET.
3875 */
drh2fa18682008-03-19 14:15:34 +00003876 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3877 sqlite3PrngRestoreState();
3878 break;
3879 }
drh984bfaa2008-03-19 16:08:53 +00003880
drh2e6d83b2019-08-03 01:39:20 +00003881 /* sqlite3_test_control(SQLITE_TESTCTRL_PRNG_SEED, int x, sqlite3 *db);
drhade54d62019-08-02 20:45:04 +00003882 **
drh2e6d83b2019-08-03 01:39:20 +00003883 ** Control the seed for the pseudo-random number generator (PRNG) that
3884 ** is built into SQLite. Cases:
3885 **
3886 ** x!=0 && db!=0 Seed the PRNG to the current value of the
3887 ** schema cookie in the main database for db, or
3888 ** x if the schema cookie is zero. This case
3889 ** is convenient to use with database fuzzers
3890 ** as it allows the fuzzer some control over the
3891 ** the PRNG seed.
3892 **
3893 ** x!=0 && db==0 Seed the PRNG to the value of x.
3894 **
3895 ** x==0 && db==0 Revert to default behavior of using the
3896 ** xRandomness method on the primary VFS.
3897 **
3898 ** This test-control also resets the PRNG so that the new seed will
3899 ** be used for the next call to sqlite3_randomness().
drh984bfaa2008-03-19 16:08:53 +00003900 */
drhade54d62019-08-02 20:45:04 +00003901 case SQLITE_TESTCTRL_PRNG_SEED: {
drh2e6d83b2019-08-03 01:39:20 +00003902 int x = va_arg(ap, int);
3903 int y;
3904 sqlite3 *db = va_arg(ap, sqlite3*);
3905 assert( db==0 || db->aDb[0].pSchema!=0 );
3906 if( db && (y = db->aDb[0].pSchema->schema_cookie)!=0 ){ x = y; }
3907 sqlite3Config.iPrngSeed = x;
3908 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003909 break;
3910 }
drh3088d592008-03-21 16:45:47 +00003911
3912 /*
3913 ** sqlite3_test_control(BITVEC_TEST, size, program)
3914 **
3915 ** Run a test against a Bitvec object of size. The program argument
3916 ** is an array of integers that defines the test. Return -1 on a
3917 ** memory allocation error, 0 on success, or non-zero for an error.
3918 ** See the sqlite3BitvecBuiltinTest() for additional information.
3919 */
3920 case SQLITE_TESTCTRL_BITVEC_TEST: {
3921 int sz = va_arg(ap, int);
3922 int *aProg = va_arg(ap, int*);
3923 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3924 break;
3925 }
danielk19772d1d86f2008-06-20 14:59:51 +00003926
3927 /*
drhc007f612014-05-16 14:17:01 +00003928 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3929 **
3930 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3931 ** if xCallback is not NULL.
3932 **
3933 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3934 ** is called immediately after installing the new callback and the return
3935 ** value from sqlite3FaultSim(0) becomes the return from
3936 ** sqlite3_test_control().
3937 */
3938 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003939 /* MSVC is picky about pulling func ptrs from va lists.
3940 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003941 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003942 */
3943 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003944 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003945 rc = sqlite3FaultSim(0);
3946 break;
3947 }
3948
3949 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003950 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3951 **
3952 ** Register hooks to call to indicate which malloc() failures
3953 ** are benign.
3954 */
3955 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003956 typedef void (*void_function)(void);
3957 void_function xBenignBegin;
3958 void_function xBenignEnd;
3959 xBenignBegin = va_arg(ap, void_function);
3960 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003961 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3962 break;
3963 }
drhc7a3bb92009-02-05 16:31:45 +00003964
3965 /*
drhf3af63f2009-05-09 18:59:42 +00003966 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003967 **
3968 ** Set the PENDING byte to the value in the argument, if X>0.
3969 ** Make no changes if X==0. Return the value of the pending byte
3970 ** as it existing before this routine was called.
3971 **
3972 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3973 ** an incompatible database file format. Changing the PENDING byte
3974 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003975 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003976 */
3977 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003978 rc = PENDING_BYTE;
3979#ifndef SQLITE_OMIT_WSD
3980 {
3981 unsigned int newVal = va_arg(ap, unsigned int);
3982 if( newVal ) sqlite3PendingByte = newVal;
3983 }
3984#endif
drhc7a3bb92009-02-05 16:31:45 +00003985 break;
3986 }
drhf3af63f2009-05-09 18:59:42 +00003987
3988 /*
3989 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3990 **
3991 ** This action provides a run-time test to see whether or not
3992 ** assert() was enabled at compile-time. If X is true and assert()
3993 ** is enabled, then the return value is true. If X is true and
3994 ** assert() is disabled, then the return value is zero. If X is
3995 ** false and assert() is enabled, then the assertion fires and the
3996 ** process aborts. If X is false and assert() is disabled, then the
3997 ** return value is zero.
3998 */
3999 case SQLITE_TESTCTRL_ASSERT: {
4000 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00004001 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00004002 rc = x;
4003 break;
4004 }
4005
4006
4007 /*
4008 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
4009 **
4010 ** This action provides a run-time test to see how the ALWAYS and
4011 ** NEVER macros were defined at compile-time.
4012 **
drhce2c4822017-10-03 17:17:34 +00004013 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00004014 **
4015 ** The recommended test is X==2. If the return value is 2, that means
4016 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
4017 ** default setting. If the return value is 1, then ALWAYS() is either
4018 ** hard-coded to true or else it asserts if its argument is false.
4019 ** The first behavior (hard-coded to true) is the case if
4020 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
4021 ** behavior (assert if the argument to ALWAYS() is false) is the case if
4022 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
4023 **
4024 ** The run-time test procedure might look something like this:
4025 **
4026 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
4027 ** // ALWAYS() and NEVER() are no-op pass-through macros
4028 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
4029 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
4030 ** }else{
4031 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
4032 ** }
4033 */
4034 case SQLITE_TESTCTRL_ALWAYS: {
4035 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00004036 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00004037 break;
4038 }
drhc046e3e2009-07-15 11:26:44 +00004039
drh2cf4acb2014-04-18 00:06:02 +00004040 /*
4041 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
4042 **
4043 ** The integer returned reveals the byte-order of the computer on which
4044 ** SQLite is running:
4045 **
4046 ** 1 big-endian, determined at run-time
4047 ** 10 little-endian, determined at run-time
4048 ** 432101 big-endian, determined at compile-time
4049 ** 123410 little-endian, determined at compile-time
4050 */
4051 case SQLITE_TESTCTRL_BYTEORDER: {
4052 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
4053 break;
4054 }
4055
drhc046e3e2009-07-15 11:26:44 +00004056 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
4057 **
4058 ** Set the nReserve size to N for the main database on the database
4059 ** connection db.
4060 */
4061 case SQLITE_TESTCTRL_RESERVE: {
4062 sqlite3 *db = va_arg(ap, sqlite3*);
4063 int x = va_arg(ap,int);
4064 sqlite3_mutex_enter(db->mutex);
4065 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
4066 sqlite3_mutex_leave(db->mutex);
4067 break;
4068 }
4069
drh07096f62009-12-22 23:52:32 +00004070 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
4071 **
4072 ** Enable or disable various optimizations for testing purposes. The
4073 ** argument N is a bitmask of optimizations to be disabled. For normal
4074 ** operation N should be 0. The idea is that a test program (like the
4075 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
4076 ** with various optimizations disabled to verify that the same answer
4077 ** is obtained in every case.
4078 */
4079 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
4080 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00004081 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00004082 break;
4083 }
4084
danc17d6962011-06-21 12:47:30 +00004085 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
4086 **
drheea8eb62018-11-26 18:09:15 +00004087 ** If parameter onoff is non-zero, subsequent calls to localtime()
4088 ** and its variants fail. If onoff is zero, undo this setting.
danc17d6962011-06-21 12:47:30 +00004089 */
4090 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
4091 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
4092 break;
4093 }
4094
drh171c50e2020-01-01 15:43:30 +00004095 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCTIONS, sqlite3*);
drheea8eb62018-11-26 18:09:15 +00004096 **
drh171c50e2020-01-01 15:43:30 +00004097 ** Toggle the ability to use internal functions on or off for
4098 ** the database connection given in the argument.
drheea8eb62018-11-26 18:09:15 +00004099 */
4100 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
drh171c50e2020-01-01 15:43:30 +00004101 sqlite3 *db = va_arg(ap, sqlite3*);
4102 db->mDbFlags ^= DBFLAG_InternalFunc;
drheea8eb62018-11-26 18:09:15 +00004103 break;
4104 }
4105
drh09fe6142013-11-29 15:06:27 +00004106 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4107 **
4108 ** Set or clear a flag that indicates that the database file is always well-
4109 ** formed and never corrupt. This flag is clear by default, indicating that
4110 ** database files might have arbitrary corruption. Setting the flag during
4111 ** testing causes certain assert() statements in the code to be activated
4112 ** that demonstrat invariants on well-formed database files.
4113 */
4114 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00004115 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00004116 break;
4117 }
4118
drh30842992019-08-12 14:17:43 +00004119 /* sqlite3_test_control(SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS, int);
4120 **
4121 ** Set or clear a flag that causes SQLite to verify that type, name,
4122 ** and tbl_name fields of the sqlite_master table. This is normally
4123 ** on, but it is sometimes useful to turn it off for testing.
4124 */
4125 case SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS: {
4126 sqlite3GlobalConfig.bExtraSchemaChecks = va_arg(ap, int);
4127 break;
4128 }
4129
drh9e5eb9c2016-09-18 16:08:10 +00004130 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00004131 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004132 ** too big to test in a reasonable amount of time, so this control is
4133 ** provided to set a small and easily reachable reset value.
4134 */
4135 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4136 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4137 break;
4138 }
drh688852a2014-02-17 22:40:43 +00004139
4140 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4141 **
4142 ** Set the VDBE coverage callback function to xCallback with context
4143 ** pointer ptr.
4144 */
4145 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4146#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00004147 typedef void (*branch_callback)(void*,unsigned int,
4148 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00004149 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4150 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4151#endif
4152 break;
4153 }
4154
dan8930c2a2014-04-03 16:25:29 +00004155 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4156 case SQLITE_TESTCTRL_SORTER_MMAP: {
4157 sqlite3 *db = va_arg(ap, sqlite3*);
4158 db->nMaxSorterMmap = va_arg(ap, int);
4159 break;
4160 }
4161
drh43cfc232014-07-29 14:09:21 +00004162 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4163 **
4164 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4165 ** not.
4166 */
4167 case SQLITE_TESTCTRL_ISINIT: {
4168 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4169 break;
4170 }
drh8964b342015-01-29 17:54:52 +00004171
drh3ba689d2015-03-03 14:00:11 +00004172 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004173 **
drh1ffede82015-01-30 20:59:27 +00004174 ** This test control is used to create imposter tables. "db" is a pointer
4175 ** to the database connection. dbName is the database name (ex: "main" or
4176 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4177 ** or off. "tnum" is the root page of the b-tree to which the imposter
4178 ** table should connect.
4179 **
4180 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004181 ** run a single CREATE TABLE statement to construct the imposter table in
4182 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004183 **
4184 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4185 ** the schema to be reparsed the next time it is needed. This has the
4186 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004187 */
drh1ffede82015-01-30 20:59:27 +00004188 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004189 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004190 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004191 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4192 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004193 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004194 if( db->init.busy==0 && db->init.newTnum>0 ){
4195 sqlite3ResetAllSchemasOfConnection(db);
4196 }
drh8fb15e32015-02-04 20:56:49 +00004197 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004198 break;
4199 }
drh0d9de992017-12-26 18:04:23 +00004200
4201#if defined(YYCOVERAGE)
4202 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4203 **
4204 ** This test control (only available when SQLite is compiled with
4205 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4206 ** state/lookahead combinations in the parser state machine
4207 ** which are never exercised. If any state is missed, make the
4208 ** return code SQLITE_ERROR.
4209 */
4210 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4211 FILE *out = va_arg(ap, FILE*);
4212 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4213 break;
4214 }
4215#endif /* defined(YYCOVERAGE) */
drh0c8f4032019-05-03 21:17:28 +00004216
4217 /* sqlite3_test_control(SQLITE_TESTCTRL_RESULT_INTREAL, sqlite3_context*);
4218 **
4219 ** This test-control causes the most recent sqlite3_result_int64() value
4220 ** to be interpreted as a MEM_IntReal instead of as an MEM_Int. Normally,
4221 ** MEM_IntReal values only arise during an INSERT operation of integer
4222 ** values into a REAL column, so they can be challenging to test. This
4223 ** test-control enables us to write an intreal() SQL function that can
4224 ** inject an intreal() value at arbitrary places in an SQL statement,
4225 ** for testing purposes.
4226 */
4227 case SQLITE_TESTCTRL_RESULT_INTREAL: {
4228 sqlite3_context *pCtx = va_arg(ap, sqlite3_context*);
4229 sqlite3ResultIntReal(pCtx);
4230 break;
4231 }
drhed13d982008-01-31 14:43:24 +00004232 }
4233 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004234#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004235 return rc;
drhed13d982008-01-31 14:43:24 +00004236}
drhcc487d12011-05-17 18:53:08 +00004237
drh746461f2019-11-12 14:43:47 +00004238#ifdef SQLITE_DEBUG
4239/*
4240** This routine appears inside assert() statements only.
4241**
4242** Return the number of URI parameters that follow the filename.
4243*/
4244int sqlite3UriCount(const char *z){
4245 int n = 0;
4246 if( z==0 ) return 0;
4247 z += strlen(z)+1;
4248 while( z[0] ){
4249 z += strlen(z)+1;
4250 z += strlen(z)+1;
4251 n++;
4252 }
4253 return n;
4254}
4255#endif /* SQLITE_DEBUG */
4256
drhcc487d12011-05-17 18:53:08 +00004257/*
4258** This is a utility routine, useful to VFS implementations, that checks
4259** to see if a database file was a URI that contained a specific query
4260** parameter, and if so obtains the value of the query parameter.
4261**
4262** The zFilename argument is the filename pointer passed into the xOpen()
4263** method of a VFS implementation. The zParam argument is the name of the
4264** query parameter we seek. This routine returns the value of the zParam
4265** parameter if it exists. If the parameter does not exist, this routine
4266** returns a NULL pointer.
4267*/
4268const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004269 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00004270 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004271 while( zFilename[0] ){
4272 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00004273 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004274 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00004275 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004276 }
4277 return 0;
4278}
drh283829c2011-11-17 00:56:20 +00004279
4280/*
drh92913722011-12-23 00:07:33 +00004281** Return a boolean value for a query parameter.
4282*/
4283int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4284 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004285 bDflt = bDflt!=0;
4286 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004287}
4288
4289/*
4290** Return a 64-bit integer value for a query parameter.
4291*/
4292sqlite3_int64 sqlite3_uri_int64(
4293 const char *zFilename, /* Filename as passed to xOpen */
4294 const char *zParam, /* URI parameter sought */
4295 sqlite3_int64 bDflt /* return if parameter is missing */
4296){
4297 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4298 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004299 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004300 bDflt = v;
4301 }
4302 return bDflt;
4303}
4304
4305/*
drh421377e2012-03-15 21:28:54 +00004306** Return the Btree pointer identified by zDbName. Return NULL if not found.
4307*/
4308Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004309 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4310 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004311}
4312
4313/*
drh283829c2011-11-17 00:56:20 +00004314** Return the filename of the database associated with a database
4315** connection.
4316*/
4317const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004318 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004319#ifdef SQLITE_ENABLE_API_ARMOR
4320 if( !sqlite3SafetyCheckOk(db) ){
4321 (void)SQLITE_MISUSE_BKPT;
4322 return 0;
4323 }
4324#endif
mistachkincd54bab2014-12-20 21:14:14 +00004325 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004326 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4327}
4328
4329/*
4330** Return 1 if database is read-only or 0 if read/write. Return -1 if
4331** no such database exists.
4332*/
4333int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004334 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004335#ifdef SQLITE_ENABLE_API_ARMOR
4336 if( !sqlite3SafetyCheckOk(db) ){
4337 (void)SQLITE_MISUSE_BKPT;
4338 return -1;
4339 }
4340#endif
mistachkincd54bab2014-12-20 21:14:14 +00004341 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004342 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004343}
danfc1acf32015-12-05 20:51:54 +00004344
4345#ifdef SQLITE_ENABLE_SNAPSHOT
4346/*
4347** Obtain a snapshot handle for the snapshot of database zDb currently
4348** being read by handle db.
4349*/
4350int sqlite3_snapshot_get(
4351 sqlite3 *db,
4352 const char *zDb,
4353 sqlite3_snapshot **ppSnapshot
4354){
4355 int rc = SQLITE_ERROR;
4356#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004357
4358#ifdef SQLITE_ENABLE_API_ARMOR
4359 if( !sqlite3SafetyCheckOk(db) ){
4360 return SQLITE_MISUSE_BKPT;
4361 }
4362#endif
4363 sqlite3_mutex_enter(db->mutex);
4364
danedace5d2016-11-18 18:43:39 +00004365 if( db->autoCommit==0 ){
4366 int iDb = sqlite3FindDbName(db, zDb);
4367 if( iDb==0 || iDb>1 ){
4368 Btree *pBt = db->aDb[iDb].pBt;
4369 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004370 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004371 if( rc==SQLITE_OK ){
4372 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4373 }
dan7116dc62015-12-10 20:03:08 +00004374 }
danfc1acf32015-12-05 20:51:54 +00004375 }
4376 }
4377
4378 sqlite3_mutex_leave(db->mutex);
4379#endif /* SQLITE_OMIT_WAL */
4380 return rc;
4381}
4382
4383/*
4384** Open a read-transaction on the snapshot idendified by pSnapshot.
4385*/
4386int sqlite3_snapshot_open(
4387 sqlite3 *db,
4388 const char *zDb,
4389 sqlite3_snapshot *pSnapshot
4390){
4391 int rc = SQLITE_ERROR;
4392#ifndef SQLITE_OMIT_WAL
4393
4394#ifdef SQLITE_ENABLE_API_ARMOR
4395 if( !sqlite3SafetyCheckOk(db) ){
4396 return SQLITE_MISUSE_BKPT;
4397 }
4398#endif
4399 sqlite3_mutex_enter(db->mutex);
4400 if( db->autoCommit==0 ){
4401 int iDb;
4402 iDb = sqlite3FindDbName(db, zDb);
4403 if( iDb==0 || iDb>1 ){
4404 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004405 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4406 Pager *pPager = sqlite3BtreePager(pBt);
4407 int bUnlock = 0;
4408 if( sqlite3BtreeIsInReadTrans(pBt) ){
4409 if( db->nVdbeActive==0 ){
4410 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4411 if( rc==SQLITE_OK ){
4412 bUnlock = 1;
4413 rc = sqlite3BtreeCommit(pBt);
4414 }
4415 }
4416 }else{
4417 rc = SQLITE_OK;
4418 }
4419 if( rc==SQLITE_OK ){
4420 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4421 }
danfc1acf32015-12-05 20:51:54 +00004422 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004423 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danfa3d4c12018-08-06 17:12:36 +00004424 sqlite3PagerSnapshotOpen(pPager, 0);
4425 }
4426 if( bUnlock ){
4427 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004428 }
4429 }
4430 }
4431 }
4432
4433 sqlite3_mutex_leave(db->mutex);
4434#endif /* SQLITE_OMIT_WAL */
4435 return rc;
4436}
4437
4438/*
dan11584982016-11-18 20:49:43 +00004439** Recover as many snapshots as possible from the wal file associated with
4440** schema zDb of database db.
4441*/
4442int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4443 int rc = SQLITE_ERROR;
4444 int iDb;
4445#ifndef SQLITE_OMIT_WAL
4446
4447#ifdef SQLITE_ENABLE_API_ARMOR
4448 if( !sqlite3SafetyCheckOk(db) ){
4449 return SQLITE_MISUSE_BKPT;
4450 }
4451#endif
4452
4453 sqlite3_mutex_enter(db->mutex);
4454 iDb = sqlite3FindDbName(db, zDb);
4455 if( iDb==0 || iDb>1 ){
4456 Btree *pBt = db->aDb[iDb].pBt;
4457 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004458 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004459 if( rc==SQLITE_OK ){
4460 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4461 sqlite3BtreeCommit(pBt);
4462 }
dan11584982016-11-18 20:49:43 +00004463 }
4464 }
4465 sqlite3_mutex_leave(db->mutex);
4466#endif /* SQLITE_OMIT_WAL */
4467 return rc;
4468}
4469
4470/*
danfc1acf32015-12-05 20:51:54 +00004471** Free a snapshot handle obtained from sqlite3_snapshot_get().
4472*/
4473void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4474 sqlite3_free(pSnapshot);
4475}
4476#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004477
4478#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4479/*
4480** Given the name of a compile-time option, return true if that option
4481** was used and false if not.
4482**
4483** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4484** is not required for a match.
4485*/
4486int sqlite3_compileoption_used(const char *zOptName){
4487 int i, n;
4488 int nOpt;
4489 const char **azCompileOpt;
4490
4491#if SQLITE_ENABLE_API_ARMOR
4492 if( zOptName==0 ){
4493 (void)SQLITE_MISUSE_BKPT;
4494 return 0;
4495 }
4496#endif
4497
4498 azCompileOpt = sqlite3CompileOptions(&nOpt);
4499
4500 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4501 n = sqlite3Strlen30(zOptName);
4502
4503 /* Since nOpt is normally in single digits, a linear search is
4504 ** adequate. No need for a binary search. */
4505 for(i=0; i<nOpt; i++){
4506 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4507 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4508 ){
4509 return 1;
4510 }
4511 }
4512 return 0;
4513}
4514
4515/*
4516** Return the N-th compile-time option string. If N is out of range,
4517** return a NULL pointer.
4518*/
4519const char *sqlite3_compileoption_get(int N){
4520 int nOpt;
4521 const char **azCompileOpt;
4522 azCompileOpt = sqlite3CompileOptions(&nOpt);
4523 if( N>=0 && N<nOpt ){
4524 return azCompileOpt[N];
4525 }
4526 return 0;
4527}
4528#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */