blob: 0dd8e294f5a8d4b4996fdfcb8b2c799b03aecf9d [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;
drh52fb8e12017-08-29 20:21:12 +0000686
687 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000688 return SQLITE_BUSY;
689 }
shanef71f89e2009-01-30 06:11:54 +0000690 /* Free any existing lookaside buffer for this handle before
691 ** allocating a new one so we don't have to have space for
692 ** both at the same time.
693 */
694 if( db->lookaside.bMalloced ){
695 sqlite3_free(db->lookaside.pStart);
696 }
drh61a4bd52011-11-10 02:39:28 +0000697 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
698 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000699 */
drh61a4bd52011-11-10 02:39:28 +0000700 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000701 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000702 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000703 if( sz==0 || cnt==0 ){
704 sz = 0;
705 pStart = 0;
706 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000707 sqlite3BeginBenignMalloc();
drh0aa32312019-04-13 04:01:12 +0000708 pStart = sqlite3Malloc( sz*(sqlite3_int64)cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000709 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000710 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000711 }else{
712 pStart = pBuf;
713 }
drh4cfb22f2008-08-01 18:47:01 +0000714 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000715 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000716 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000717 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000718 if( pStart ){
719 int i;
720 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000721 assert( sz > (int)sizeof(LookasideSlot*) );
drh52fb8e12017-08-29 20:21:12 +0000722 db->lookaside.nSlot = cnt;
drh633e6d52008-07-28 19:34:53 +0000723 p = (LookasideSlot*)pStart;
724 for(i=cnt-1; i>=0; i--){
drh52fb8e12017-08-29 20:21:12 +0000725 p->pNext = db->lookaside.pInit;
726 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000727 p = (LookasideSlot*)&((u8*)p)[sz];
728 }
729 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000730 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000731 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000732 }else{
drhb0e77042013-12-10 19:49:00 +0000733 db->lookaside.pStart = db;
734 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000735 db->lookaside.bDisable = 1;
shanef71f89e2009-01-30 06:11:54 +0000736 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000737 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000738 }
drh7877d9a2015-07-23 17:16:27 +0000739#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000740 return SQLITE_OK;
741}
742
743/*
drh4413d0e2008-11-04 13:46:27 +0000744** Return the mutex associated with a database connection.
745*/
746sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000747#ifdef SQLITE_ENABLE_API_ARMOR
748 if( !sqlite3SafetyCheckOk(db) ){
749 (void)SQLITE_MISUSE_BKPT;
750 return 0;
751 }
752#endif
drh4413d0e2008-11-04 13:46:27 +0000753 return db->mutex;
754}
755
756/*
drh09419b42011-11-16 19:29:17 +0000757** Free up as much memory as we can from the given database
758** connection.
759*/
760int sqlite3_db_release_memory(sqlite3 *db){
761 int i;
drh9ca95732014-10-24 00:35:58 +0000762
763#ifdef SQLITE_ENABLE_API_ARMOR
764 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
765#endif
dand9bb3a92011-12-30 11:43:59 +0000766 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000767 sqlite3BtreeEnterAll(db);
768 for(i=0; i<db->nDb; i++){
769 Btree *pBt = db->aDb[i].pBt;
770 if( pBt ){
771 Pager *pPager = sqlite3BtreePager(pBt);
772 sqlite3PagerShrink(pPager);
773 }
774 }
775 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000776 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000777 return SQLITE_OK;
778}
779
780/*
dan6fa255f2015-10-28 19:46:57 +0000781** Flush any dirty pages in the pager-cache for any attached database
782** to disk.
783*/
784int sqlite3_db_cacheflush(sqlite3 *db){
785 int i;
786 int rc = SQLITE_OK;
787 int bSeenBusy = 0;
788
789#ifdef SQLITE_ENABLE_API_ARMOR
790 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
791#endif
792 sqlite3_mutex_enter(db->mutex);
793 sqlite3BtreeEnterAll(db);
794 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
795 Btree *pBt = db->aDb[i].pBt;
796 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
797 Pager *pPager = sqlite3BtreePager(pBt);
798 rc = sqlite3PagerFlush(pPager);
799 if( rc==SQLITE_BUSY ){
800 bSeenBusy = 1;
801 rc = SQLITE_OK;
802 }
803 }
804 }
dan6fa255f2015-10-28 19:46:57 +0000805 sqlite3BtreeLeaveAll(db);
806 sqlite3_mutex_leave(db->mutex);
807 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
808}
809
810/*
drh633e6d52008-07-28 19:34:53 +0000811** Configuration settings for an individual database connection
812*/
813int sqlite3_db_config(sqlite3 *db, int op, ...){
814 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000815 int rc;
drh633e6d52008-07-28 19:34:53 +0000816 va_start(ap, op);
817 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000818 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000819 /* IMP: R-06824-28531 */
820 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000821 db->aDb[0].zDbSName = va_arg(ap,char*);
822 rc = SQLITE_OK;
823 break;
824 }
drhe9d1c722008-08-04 20:13:26 +0000825 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000826 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000827 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
828 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000829 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000830 break;
831 }
drh6480aad2008-08-01 16:31:14 +0000832 default: {
drhe83cafd2011-03-21 17:15:58 +0000833 static const struct {
834 int op; /* The opcode */
835 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
836 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000837 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
838 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
839 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000840 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000841 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000842 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000843 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000844 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drha296cda2018-11-03 16:09:59 +0000845 { SQLITE_DBCONFIG_DEFENSIVE, SQLITE_Defensive },
drh346f4e22019-03-25 21:35:41 +0000846 { SQLITE_DBCONFIG_WRITABLE_SCHEMA, SQLITE_WriteSchema|
847 SQLITE_NoSchemaError },
drhe83cafd2011-03-21 17:15:58 +0000848 };
drh58ad5802011-03-23 22:02:23 +0000849 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000850 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000851 for(i=0; i<ArraySize(aFlagOp); i++){
852 if( aFlagOp[i].op==op ){
853 int onoff = va_arg(ap, int);
854 int *pRes = va_arg(ap, int*);
drh70d5dfb2018-12-06 16:50:55 +0000855 u64 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000856 if( onoff>0 ){
857 db->flags |= aFlagOp[i].mask;
858 }else if( onoff==0 ){
drhd5b44d62018-12-06 17:06:02 +0000859 db->flags &= ~(u64)aFlagOp[i].mask;
drhe83cafd2011-03-21 17:15:58 +0000860 }
861 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000862 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000863 }
864 if( pRes ){
865 *pRes = (db->flags & aFlagOp[i].mask)!=0;
866 }
867 rc = SQLITE_OK;
868 break;
869 }
870 }
drh6480aad2008-08-01 16:31:14 +0000871 break;
872 }
drh633e6d52008-07-28 19:34:53 +0000873 }
874 va_end(ap);
875 return rc;
876}
877
drh9b5adfa2008-01-20 23:19:56 +0000878/*
drhd3d39e92004-05-20 22:16:29 +0000879** This is the default collating function named "BINARY" which is always
880** available.
881*/
danielk19772c336542005-01-13 02:14:23 +0000882static int binCollFunc(
drh821afa42019-06-14 13:24:46 +0000883 void *NotUsed,
drhd3d39e92004-05-20 22:16:29 +0000884 int nKey1, const void *pKey1,
885 int nKey2, const void *pKey2
886){
887 int rc, n;
drh821afa42019-06-14 13:24:46 +0000888 UNUSED_PARAMETER(NotUsed);
drhd3d39e92004-05-20 22:16:29 +0000889 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000890 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
891 ** strings byte by byte using the memcmp() function from the standard C
892 ** library. */
dan21766c02017-05-22 08:04:09 +0000893 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +0000894 rc = memcmp(pKey1, pKey2, n);
895 if( rc==0 ){
drh821afa42019-06-14 13:24:46 +0000896 rc = nKey1 - nKey2;
drhd3d39e92004-05-20 22:16:29 +0000897 }
898 return rc;
899}
900
901/*
drh821afa42019-06-14 13:24:46 +0000902** This is the collating function named "RTRIM" which is always
903** available. Ignore trailing spaces.
904*/
905static int rtrimCollFunc(
906 void *pUser,
907 int nKey1, const void *pKey1,
908 int nKey2, const void *pKey2
909){
910 const u8 *pK1 = (const u8*)pKey1;
911 const u8 *pK2 = (const u8*)pKey2;
912 while( nKey1 && pK1[nKey1-1]==' ' ) nKey1--;
913 while( nKey2 && pK2[nKey2-1]==' ' ) nKey2--;
914 return binCollFunc(pUser, nKey1, pKey1, nKey2, pKey2);
915}
916
917/*
drhbcd15932018-07-27 18:12:40 +0000918** Return true if CollSeq is the default built-in BINARY.
919*/
920int sqlite3IsBinary(const CollSeq *p){
drh821afa42019-06-14 13:24:46 +0000921 assert( p==0 || p->xCmp!=binCollFunc || strcmp(p->zName,"BINARY")==0 );
922 return p==0 || p->xCmp==binCollFunc;
drhbcd15932018-07-27 18:12:40 +0000923}
924
925/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000926** Another built-in collating sequence: NOCASE.
927**
drhf7b54962013-05-28 12:11:54 +0000928** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000929** comparison". SQLite's knowledge of upper and lower case equivalents
930** extends only to the 26 characters used in the English language.
931**
932** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000933*/
934static int nocaseCollatingFunc(
935 void *NotUsed,
936 int nKey1, const void *pKey1,
937 int nKey2, const void *pKey2
938){
939 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000940 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000941 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000942 if( 0==r ){
943 r = nKey1-nKey2;
944 }
945 return r;
946}
947
948/*
drhaf9ff332002-01-16 21:00:27 +0000949** Return the ROWID of the most recent insert
950*/
drh9bb575f2004-09-06 17:24:11 +0000951sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000952#ifdef SQLITE_ENABLE_API_ARMOR
953 if( !sqlite3SafetyCheckOk(db) ){
954 (void)SQLITE_MISUSE_BKPT;
955 return 0;
956 }
957#endif
drhaf9ff332002-01-16 21:00:27 +0000958 return db->lastRowid;
959}
960
961/*
dan9c58b632017-02-27 14:52:48 +0000962** Set the value returned by the sqlite3_last_insert_rowid() API function.
963*/
964void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
965#ifdef SQLITE_ENABLE_API_ARMOR
966 if( !sqlite3SafetyCheckOk(db) ){
967 (void)SQLITE_MISUSE_BKPT;
968 return;
969 }
970#endif
971 sqlite3_mutex_enter(db->mutex);
972 db->lastRowid = iRowid;
973 sqlite3_mutex_leave(db->mutex);
974}
975
976/*
danielk197724b03fd2004-05-10 10:34:34 +0000977** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000978*/
drh9bb575f2004-09-06 17:24:11 +0000979int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000980#ifdef SQLITE_ENABLE_API_ARMOR
981 if( !sqlite3SafetyCheckOk(db) ){
982 (void)SQLITE_MISUSE_BKPT;
983 return 0;
984 }
985#endif
drhc8d30ac2002-04-12 10:08:59 +0000986 return db->nChange;
987}
988
rdcf146a772004-02-25 22:51:06 +0000989/*
danielk1977b28af712004-06-21 06:50:26 +0000990** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000991*/
danielk1977b28af712004-06-21 06:50:26 +0000992int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000993#ifdef SQLITE_ENABLE_API_ARMOR
994 if( !sqlite3SafetyCheckOk(db) ){
995 (void)SQLITE_MISUSE_BKPT;
996 return 0;
997 }
998#endif
danielk1977b28af712004-06-21 06:50:26 +0000999 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +00001000}
1001
drhc8d30ac2002-04-12 10:08:59 +00001002/*
danielk1977fd7f0452008-12-17 17:30:26 +00001003** Close all open savepoints. This function only manipulates fields of the
1004** database handle object, it does not close any savepoints that may be open
1005** at the b-tree/pager level.
1006*/
1007void sqlite3CloseSavepoints(sqlite3 *db){
1008 while( db->pSavepoint ){
1009 Savepoint *pTmp = db->pSavepoint;
1010 db->pSavepoint = pTmp->pNext;
1011 sqlite3DbFree(db, pTmp);
1012 }
1013 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001014 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001015 db->isTransactionSavepoint = 0;
1016}
1017
1018/*
dand2199f02010-08-27 17:48:52 +00001019** Invoke the destructor function associated with FuncDef p, if any. Except,
1020** if this is not the last copy of the function, do not invoke it. Multiple
1021** copies of a single function are created when create_function() is called
1022** with SQLITE_ANY as the encoding.
1023*/
1024static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001025 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001026 if( pDestructor ){
1027 pDestructor->nRef--;
1028 if( pDestructor->nRef==0 ){
1029 pDestructor->xDestroy(pDestructor->pUserData);
1030 sqlite3DbFree(db, pDestructor);
1031 }
1032 }
1033}
1034
1035/*
danbba02a92012-05-15 17:15:34 +00001036** Disconnect all sqlite3_vtab objects that belong to database connection
1037** db. This is called when db is being closed.
1038*/
1039static void disconnectAllVtab(sqlite3 *db){
1040#ifndef SQLITE_OMIT_VIRTUALTABLE
1041 int i;
drh51be3872015-08-19 02:32:25 +00001042 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001043 sqlite3BtreeEnterAll(db);
1044 for(i=0; i<db->nDb; i++){
1045 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001046 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001047 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1048 Table *pTab = (Table *)sqliteHashData(p);
1049 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1050 }
1051 }
1052 }
drh51be3872015-08-19 02:32:25 +00001053 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1054 Module *pMod = (Module *)sqliteHashData(p);
1055 if( pMod->pEpoTab ){
1056 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1057 }
1058 }
dand88e5212014-03-12 19:38:38 +00001059 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001060 sqlite3BtreeLeaveAll(db);
1061#else
1062 UNUSED_PARAMETER(db);
1063#endif
1064}
1065
1066/*
drh167cd6a2012-06-02 17:09:46 +00001067** Return TRUE if database connection db has unfinalized prepared
1068** statements or unfinished sqlite3_backup objects.
1069*/
1070static int connectionIsBusy(sqlite3 *db){
1071 int j;
1072 assert( sqlite3_mutex_held(db->mutex) );
1073 if( db->pVdbe ) return 1;
1074 for(j=0; j<db->nDb; j++){
1075 Btree *pBt = db->aDb[j].pBt;
1076 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1077 }
1078 return 0;
1079}
1080
1081/*
drh50e5dad2001-09-15 00:57:28 +00001082** Close an existing SQLite database
1083*/
drh167cd6a2012-06-02 17:09:46 +00001084static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001085 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001086 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1087 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001088 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001089 }
drh7e8b8482008-01-23 03:03:05 +00001090 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001091 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001092 }
drh605264d2007-08-21 15:13:19 +00001093 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001094 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1095 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1096 }
danielk1977e35ee192004-06-26 09:50:11 +00001097
danbba02a92012-05-15 17:15:34 +00001098 /* Force xDisconnect calls on all virtual tables */
1099 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001100
danbba02a92012-05-15 17:15:34 +00001101 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001102 ** will not have called the xDisconnect() method on any virtual
1103 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1104 ** call will do so. We need to do this before the check for active
1105 ** SQL statements below, as the v-table implementation may be storing
1106 ** some prepared statements internally.
1107 */
dan67430812013-05-15 10:21:50 +00001108 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001109
drh167cd6a2012-06-02 17:09:46 +00001110 /* Legacy behavior (sqlite3_close() behavior) is to return
1111 ** SQLITE_BUSY if the connection can not be closed immediately.
1112 */
1113 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001114 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001115 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001116 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001117 return SQLITE_BUSY;
1118 }
danielk1977e0048402004-06-15 16:51:01 +00001119
danac455932012-11-26 19:50:41 +00001120#ifdef SQLITE_ENABLE_SQLLOG
1121 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001122 /* Closing the handle. Fourth parameter is passed the value 2. */
1123 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001124 }
1125#endif
1126
drh167cd6a2012-06-02 17:09:46 +00001127 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001128 */
1129 db->magic = SQLITE_MAGIC_ZOMBIE;
1130 sqlite3LeaveMutexAndCloseZombie(db);
1131 return SQLITE_OK;
1132}
drh94e92032003-02-16 22:21:32 +00001133
drh167cd6a2012-06-02 17:09:46 +00001134/*
1135** Two variations on the public interface for closing a database
1136** connection. The sqlite3_close() version returns SQLITE_BUSY and
1137** leaves the connection option if there are unfinalized prepared
1138** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1139** version forces the connection to become a zombie if there are
1140** unclosed resources, and arranges for deallocation when the last
1141** prepare statement or sqlite3_backup closes.
1142*/
1143int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1144int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1145
drh4245c402012-06-02 14:32:21 +00001146
1147/*
1148** Close the mutex on database connection db.
1149**
1150** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001151** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1152** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1153** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001154*/
1155void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1156 HashElem *i; /* Hash table iterator */
1157 int j;
1158
drh4245c402012-06-02 14:32:21 +00001159 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001160 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1161 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001162 */
drh167cd6a2012-06-02 17:09:46 +00001163 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001164 sqlite3_mutex_leave(db->mutex);
1165 return;
danielk197704103022009-02-03 16:51:24 +00001166 }
1167
drh4245c402012-06-02 14:32:21 +00001168 /* If we reach this point, it means that the database connection has
1169 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001170 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001171 ** go ahead and free all resources.
1172 */
1173
dan617dc862013-05-16 11:57:28 +00001174 /* If a transaction is open, roll it back. This also ensures that if
1175 ** any database schemas have been modified by an uncommitted transaction
1176 ** they are reset. And that the required b-tree mutex is held to make
1177 ** the pager rollback and schema reset an atomic operation. */
1178 sqlite3RollbackAll(db, SQLITE_OK);
1179
danielk1977fd7f0452008-12-17 17:30:26 +00001180 /* Free any outstanding Savepoint structures. */
1181 sqlite3CloseSavepoints(db);
1182
drh5efb3142012-05-16 01:24:34 +00001183 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001184 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001185 struct Db *pDb = &db->aDb[j];
1186 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001187 sqlite3BtreeClose(pDb->pBt);
1188 pDb->pBt = 0;
1189 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001190 pDb->pSchema = 0;
1191 }
drh113088e2003-03-20 01:16:58 +00001192 }
drhf57b3392001-10-08 13:22:32 +00001193 }
drh5efb3142012-05-16 01:24:34 +00001194 /* Clear the TEMP schema separately and last */
1195 if( db->aDb[1].pSchema ){
1196 sqlite3SchemaClear(db->aDb[1].pSchema);
1197 }
1198 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001199
drh5efb3142012-05-16 01:24:34 +00001200 /* Free up the array of auxiliary databases */
1201 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001202 assert( db->nDb<=2 );
1203 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001204
1205 /* Tell the code in notify.c that the connection no longer holds any
1206 ** locks and does not require any further unlock-notify callbacks.
1207 */
1208 sqlite3ConnectionClosed(db);
1209
drh80738d92016-02-15 00:34:16 +00001210 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1211 FuncDef *pNext, *p;
1212 p = sqliteHashData(i);
1213 do{
1214 functionDestroy(db, p);
1215 pNext = p->pNext;
1216 sqlite3DbFree(db, p);
1217 p = pNext;
1218 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001219 }
drh80738d92016-02-15 00:34:16 +00001220 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001221 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001222 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001223 /* Invoke any destructors registered for collation sequence user data. */
1224 for(j=0; j<3; j++){
1225 if( pColl[j].xDel ){
1226 pColl[j].xDel(pColl[j].pUser);
1227 }
1228 }
drh633e6d52008-07-28 19:34:53 +00001229 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001230 }
danielk1977d8123362004-06-12 09:25:12 +00001231 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001232#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001233 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1234 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001235 if( pMod->xDestroy ){
1236 pMod->xDestroy(pMod->pAux);
1237 }
drh51be3872015-08-19 02:32:25 +00001238 sqlite3VtabEponymousTableClear(db, pMod);
drh633e6d52008-07-28 19:34:53 +00001239 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001240 }
drhb9bb7c12006-06-11 23:41:55 +00001241 sqlite3HashClear(&db->aModule);
1242#endif
danielk1977466be562004-06-10 02:16:01 +00001243
drh13f40da2014-08-22 18:00:11 +00001244 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001245 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001246 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001247#if SQLITE_USER_AUTHENTICATION
1248 sqlite3_free(db->auth.zAuthUser);
1249 sqlite3_free(db->auth.zAuthPW);
1250#endif
danielk197796d81f92004-06-19 03:33:57 +00001251
1252 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001253
1254 /* The temp-database schema is allocated differently from the other schema
1255 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1256 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1257 ** the same sqliteMalloc() as the one that allocates the database
1258 ** structure?
1259 */
drh633e6d52008-07-28 19:34:53 +00001260 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001261 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001262 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001263 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001264 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001265 if( db->lookaside.bMalloced ){
1266 sqlite3_free(db->lookaside.pStart);
1267 }
drh17435752007-08-16 04:30:38 +00001268 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001269}
1270
1271/*
drh0f198a72012-02-13 16:43:16 +00001272** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001273** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001274** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001275** attempts to use that cursor. Read cursors remain open and valid
1276** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001277*/
drh0f198a72012-02-13 16:43:16 +00001278void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001279 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001280 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001281 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001282 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001283 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001284
1285 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1286 ** This is important in case the transaction being rolled back has
1287 ** modified the database schema. If the b-tree mutexes are not taken
1288 ** here, then another shared-cache connection might sneak in between
1289 ** the database rollback and schema reset, which can cause false
1290 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001291 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001292 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001293
drh001bbcb2003-03-19 03:14:00 +00001294 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001295 Btree *p = db->aDb[i].pBt;
1296 if( p ){
1297 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001298 inTrans = 1;
1299 }
drh47b7fc72014-11-11 01:33:57 +00001300 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001301 }
1302 }
danielk1977a298e902006-06-22 09:53:48 +00001303 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001304 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001305
drh7f32dc92018-07-16 11:32:59 +00001306 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001307 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001308 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001309 }
dancd7b91a2013-05-13 18:23:15 +00001310 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001311
dan1da40a32009-09-19 17:00:31 +00001312 /* Any deferred constraint violations have now been resolved. */
1313 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001314 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00001315 db->flags &= ~(u64)SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001316
danielk197771fd80b2005-12-16 06:54:01 +00001317 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001318 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001319 db->xRollbackCallback(db->pRollbackArg);
1320 }
drh001bbcb2003-03-19 03:14:00 +00001321}
1322
1323/*
mistachkinf2c1c992013-04-28 01:44:43 +00001324** Return a static string containing the name corresponding to the error code
1325** specified in the argument.
1326*/
mistachkin5824d442015-04-28 23:34:10 +00001327#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001328const char *sqlite3ErrName(int rc){
1329 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001330 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001331 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1332 switch( rc ){
1333 case SQLITE_OK: zName = "SQLITE_OK"; break;
1334 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001335 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001336 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1337 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1338 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001339 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001340 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001341 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001342 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001343 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1344 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1345 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1346 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001347 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001348 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001349 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001350 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001351 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001352 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1353 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001354 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1355 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1356 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1357 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1358 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1359 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1360 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1361 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1362 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1363 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001364 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1365 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1366 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1367 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1368 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1369 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1370 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1371 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1372 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1373 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1374 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1375 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1376 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1377 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001378 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001379 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001380 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001381 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001382 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1383 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1384 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001385 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1386 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1387 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001388 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001389 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1390 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1391 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1392 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1393 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1394 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1395 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1396 case SQLITE_CONSTRAINT_FOREIGNKEY:
1397 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1398 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1399 case SQLITE_CONSTRAINT_PRIMARYKEY:
1400 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1401 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1402 case SQLITE_CONSTRAINT_COMMITHOOK:
1403 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1404 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1405 case SQLITE_CONSTRAINT_FUNCTION:
1406 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001407 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001408 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1409 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1410 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1411 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1412 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1413 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1414 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1415 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1416 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001417 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1418 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1419 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001420 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001421 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001422 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001423 }
1424 }
mistachkin10269dc2013-04-30 07:54:42 +00001425 if( zName==0 ){
1426 static char zBuf[50];
1427 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1428 zName = zBuf;
1429 }
mistachkinf2c1c992013-04-28 01:44:43 +00001430 return zName;
1431}
mistachkin10269dc2013-04-30 07:54:42 +00001432#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001433
1434/*
drhc22bd472002-05-10 13:14:07 +00001435** Return a static string that describes the kind of error specified in the
1436** argument.
drh247be432002-05-10 05:44:55 +00001437*/
danielk1977f20b21c2004-05-31 23:56:42 +00001438const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001439 static const char* const aMsg[] = {
1440 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001441 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001442 /* SQLITE_INTERNAL */ 0,
1443 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001444 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001445 /* SQLITE_BUSY */ "database is locked",
1446 /* SQLITE_LOCKED */ "database table is locked",
1447 /* SQLITE_NOMEM */ "out of memory",
1448 /* SQLITE_READONLY */ "attempt to write a readonly database",
1449 /* SQLITE_INTERRUPT */ "interrupted",
1450 /* SQLITE_IOERR */ "disk I/O error",
1451 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001452 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001453 /* SQLITE_FULL */ "database or disk is full",
1454 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001455 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001456 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001457 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001458 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001459 /* SQLITE_CONSTRAINT */ "constraint failed",
1460 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001461 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001462#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001463 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001464#else
1465 /* SQLITE_NOLFS */ 0,
1466#endif
drh51c7d862009-04-27 18:46:06 +00001467 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001468 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001469 /* SQLITE_RANGE */ "column index out of range",
1470 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001471 /* SQLITE_NOTICE */ "notification message",
1472 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001473 };
drh21021a52012-02-13 17:01:51 +00001474 const char *zErr = "unknown error";
1475 switch( rc ){
1476 case SQLITE_ABORT_ROLLBACK: {
1477 zErr = "abort due to ROLLBACK";
1478 break;
1479 }
mistachkin2a861102018-02-08 01:00:11 +00001480 case SQLITE_ROW: {
1481 zErr = "another row available";
1482 break;
1483 }
1484 case SQLITE_DONE: {
1485 zErr = "no more rows available";
1486 break;
1487 }
drh21021a52012-02-13 17:01:51 +00001488 default: {
1489 rc &= 0xff;
1490 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1491 zErr = aMsg[rc];
1492 }
1493 break;
1494 }
drh247be432002-05-10 05:44:55 +00001495 }
drh21021a52012-02-13 17:01:51 +00001496 return zErr;
drh247be432002-05-10 05:44:55 +00001497}
1498
1499/*
drh2dfbbca2000-07-28 14:32:48 +00001500** This routine implements a busy callback that sleeps and tries
1501** again until a timeout value is reached. The timeout value is
1502** an integer number of milliseconds passed in as the first
1503** argument.
drhf0119b22018-03-26 17:40:53 +00001504**
1505** Return non-zero to retry the lock. Return zero to stop trying
1506** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001507*/
drhdaffd0e2001-04-11 14:28:42 +00001508static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001509 void *ptr, /* Database connection */
1510 int count, /* Number of times table has been busy */
1511 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001512){
drh0ede9eb2015-01-10 16:49:23 +00001513#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001514 /* This case is for systems that have support for sleeping for fractions of
1515 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001516 static const u8 delays[] =
1517 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1518 static const u8 totals[] =
1519 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001520# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001521 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001522 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001523 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001524
drhf0119b22018-03-26 17:40:53 +00001525#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1526 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1527 if( count ){
1528 tmout = 0;
1529 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1530 return 0;
1531 }else{
1532 return 1;
1533 }
1534 }
drh5013c4b2018-03-28 21:45:03 +00001535#else
1536 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001537#endif
drhee570fa2005-04-28 12:06:05 +00001538 assert( count>=0 );
1539 if( count < NDELAY ){
1540 delay = delays[count];
1541 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001542 }else{
1543 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001544 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001545 }
drhf0119b22018-03-26 17:40:53 +00001546 if( prior + delay > tmout ){
1547 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001548 if( delay<=0 ) return 0;
1549 }
danielk19772a6bdf62007-08-20 16:07:00 +00001550 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001551 return 1;
1552#else
drhf0119b22018-03-26 17:40:53 +00001553 /* This case for unix systems that lack usleep() support. Sleeping
1554 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001555 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001556 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001557 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001558 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001559 return 0;
1560 }
drh482ea182007-08-20 11:12:40 +00001561 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001562 return 1;
1563#endif
1564}
1565
1566/*
drha4afb652005-07-09 02:16:02 +00001567** Invoke the given busy handler.
1568**
drhf0119b22018-03-26 17:40:53 +00001569** This routine is called when an operation failed to acquire a
1570** lock on VFS file pFile.
1571**
drha4afb652005-07-09 02:16:02 +00001572** If this routine returns non-zero, the lock is retried. If it
1573** returns 0, the operation aborts with an SQLITE_BUSY error.
1574*/
drhf0119b22018-03-26 17:40:53 +00001575int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001576 int rc;
drh80262892018-03-26 16:37:53 +00001577 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001578 if( p->bExtraFileArg ){
1579 /* Add an extra parameter with the pFile pointer to the end of the
1580 ** callback argument list */
1581 int (*xTra)(void*,int,sqlite3_file*);
1582 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1583 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1584 }else{
1585 /* Legacy style busy handler callback */
1586 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1587 }
drha4afb652005-07-09 02:16:02 +00001588 if( rc==0 ){
1589 p->nBusy = -1;
1590 }else{
1591 p->nBusy++;
1592 }
1593 return rc;
1594}
1595
1596/*
drh2dfbbca2000-07-28 14:32:48 +00001597** This routine sets the busy callback for an Sqlite database to the
1598** given callback function with the given argument.
1599*/
danielk1977f9d64d22004-06-19 08:18:07 +00001600int sqlite3_busy_handler(
1601 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001602 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001603 void *pArg
1604){
drh9ca95732014-10-24 00:35:58 +00001605#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001606 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001607#endif
drhe30f4422007-08-21 16:15:55 +00001608 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001609 db->busyHandler.xBusyHandler = xBusy;
1610 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001611 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001612 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001613 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001614 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001615 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001616}
1617
danielk1977348bb5d2003-10-18 09:37:26 +00001618#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1619/*
1620** This routine sets the progress callback for an Sqlite database to the
1621** given callback function with the given argument. The progress callback will
1622** be invoked every nOps opcodes.
1623*/
danielk197724b03fd2004-05-10 10:34:34 +00001624void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001625 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001626 int nOps,
1627 int (*xProgress)(void*),
1628 void *pArg
1629){
drh9ca95732014-10-24 00:35:58 +00001630#ifdef SQLITE_ENABLE_API_ARMOR
1631 if( !sqlite3SafetyCheckOk(db) ){
1632 (void)SQLITE_MISUSE_BKPT;
1633 return;
1634 }
1635#endif
drhbd0b1b52008-07-07 19:52:09 +00001636 sqlite3_mutex_enter(db->mutex);
1637 if( nOps>0 ){
1638 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001639 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001640 db->pProgressArg = pArg;
1641 }else{
1642 db->xProgress = 0;
1643 db->nProgressOps = 0;
1644 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001645 }
drhbd0b1b52008-07-07 19:52:09 +00001646 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001647}
1648#endif
1649
1650
drh2dfbbca2000-07-28 14:32:48 +00001651/*
1652** This routine installs a default busy handler that waits for the
1653** specified number of milliseconds before returning 0.
1654*/
danielk1977f9d64d22004-06-19 08:18:07 +00001655int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001656#ifdef SQLITE_ENABLE_API_ARMOR
1657 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1658#endif
drh2dfbbca2000-07-28 14:32:48 +00001659 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001660 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1661 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001662 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001663 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001664 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001665 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001666 }
danielk1977f9d64d22004-06-19 08:18:07 +00001667 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001668}
drh4c504392000-10-16 22:06:40 +00001669
1670/*
1671** Cause any pending operation to stop at its earliest opportunity.
1672*/
drh9bb575f2004-09-06 17:24:11 +00001673void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001674#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001675 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001676 (void)SQLITE_MISUSE_BKPT;
1677 return;
1678 }
1679#endif
drhbd0b1b52008-07-07 19:52:09 +00001680 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001681}
drhfa86c412002-02-02 15:01:15 +00001682
drhfa86c412002-02-02 15:01:15 +00001683
1684/*
danielk1977771151b2006-01-17 13:21:40 +00001685** This function is exactly the same as sqlite3_create_function(), except
1686** that it is designed to be called by internal code. The difference is
1687** that if a malloc() fails in sqlite3_create_function(), an error code
1688** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001689*/
danielk1977771151b2006-01-17 13:21:40 +00001690int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001691 sqlite3 *db,
1692 const char *zFunctionName,
1693 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001694 int enc,
danielk197765904932004-05-26 06:18:37 +00001695 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001696 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001697 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001698 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001699 void (*xValue)(sqlite3_context*),
1700 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001701 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001702){
drh0bce8352002-02-28 00:41:10 +00001703 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001704 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001705 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001706
drhe30f4422007-08-21 16:15:55 +00001707 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001708 assert( xValue==0 || xSFunc==0 );
1709 if( zFunctionName==0 /* Must have a valid name */
1710 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1711 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1712 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1713 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1714 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1715 ){
drh413c3d32010-02-23 20:11:56 +00001716 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001717 }
drh4a8ee3d2013-12-14 13:44:22 +00001718
1719 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1720 extraFlags = enc & SQLITE_DETERMINISTIC;
1721 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001722
danielk197793758c82005-01-21 08:13:14 +00001723#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001724 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1725 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1726 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1727 **
1728 ** If SQLITE_ANY is specified, add three versions of the function
1729 ** to the hash table.
1730 */
1731 if( enc==SQLITE_UTF16 ){
1732 enc = SQLITE_UTF16NATIVE;
1733 }else if( enc==SQLITE_ANY ){
1734 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001735 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dan660af932018-06-18 16:55:22 +00001736 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001737 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001738 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dan660af932018-06-18 16:55:22 +00001739 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001740 }
1741 if( rc!=SQLITE_OK ){
1742 return rc;
1743 }
danielk1977d8123362004-06-12 09:25:12 +00001744 enc = SQLITE_UTF16BE;
1745 }
danielk197793758c82005-01-21 08:13:14 +00001746#else
1747 enc = SQLITE_UTF8;
1748#endif
danielk19779636c4e2005-01-25 04:27:54 +00001749
1750 /* Check if an existing function is being overridden or deleted. If so,
1751 ** and there are active VMs, then return SQLITE_BUSY. If a function
1752 ** is being overridden/deleted but there are no active VMs, allow the
1753 ** operation to continue but invalidate all precompiled statements.
1754 */
drh80738d92016-02-15 00:34:16 +00001755 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001756 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001757 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001758 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001759 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001760 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001761 return SQLITE_BUSY;
1762 }else{
drhba968db2018-07-24 22:02:12 +00001763 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001764 }
1765 }
danielk197765904932004-05-26 06:18:37 +00001766
drh80738d92016-02-15 00:34:16 +00001767 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001768 assert(p || db->mallocFailed);
1769 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001770 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001771 }
dand2199f02010-08-27 17:48:52 +00001772
1773 /* If an older version of the function with a configured destructor is
1774 ** being replaced invoke the destructor function here. */
1775 functionDestroy(db, p);
1776
1777 if( pDestructor ){
1778 pDestructor->nRef++;
1779 }
drh80738d92016-02-15 00:34:16 +00001780 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001781 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1782 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh2d801512016-01-14 22:19:58 +00001783 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001784 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001785 p->xValue = xValue;
1786 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001787 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001788 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001789 return SQLITE_OK;
1790}
danielk1977771151b2006-01-17 13:21:40 +00001791
1792/*
dan660af932018-06-18 16:55:22 +00001793** Worker function used by utf-8 APIs that create new functions:
1794**
1795** sqlite3_create_function()
1796** sqlite3_create_function_v2()
1797** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001798*/
dan660af932018-06-18 16:55:22 +00001799static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001800 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001801 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001802 int nArg,
1803 int enc,
1804 void *p,
dan660af932018-06-18 16:55:22 +00001805 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1806 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001807 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001808 void (*xValue)(sqlite3_context*),
1809 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1810 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001811){
shanehbd2aaf92010-09-01 02:38:21 +00001812 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001813 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001814
1815#ifdef SQLITE_ENABLE_API_ARMOR
1816 if( !sqlite3SafetyCheckOk(db) ){
1817 return SQLITE_MISUSE_BKPT;
1818 }
1819#endif
dand2199f02010-08-27 17:48:52 +00001820 sqlite3_mutex_enter(db->mutex);
1821 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001822 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001823 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001824 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001825 xDestroy(p);
1826 goto out;
1827 }
drh92011842018-05-26 16:00:26 +00001828 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001829 pArg->xDestroy = xDestroy;
1830 pArg->pUserData = p;
1831 }
dan660af932018-06-18 16:55:22 +00001832 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1833 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1834 );
dand2199f02010-08-27 17:48:52 +00001835 if( pArg && pArg->nRef==0 ){
1836 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001837 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001838 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001839 }
1840
1841 out:
drhe30f4422007-08-21 16:15:55 +00001842 rc = sqlite3ApiExit(db, rc);
1843 sqlite3_mutex_leave(db->mutex);
1844 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001845}
1846
dan660af932018-06-18 16:55:22 +00001847/*
1848** Create new user functions.
1849*/
1850int sqlite3_create_function(
1851 sqlite3 *db,
1852 const char *zFunc,
1853 int nArg,
1854 int enc,
1855 void *p,
1856 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1857 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1858 void (*xFinal)(sqlite3_context*)
1859){
1860 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1861 xFinal, 0, 0, 0);
1862}
1863int sqlite3_create_function_v2(
1864 sqlite3 *db,
1865 const char *zFunc,
1866 int nArg,
1867 int enc,
1868 void *p,
1869 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1870 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1871 void (*xFinal)(sqlite3_context*),
1872 void (*xDestroy)(void *)
1873){
1874 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1875 xFinal, 0, 0, xDestroy);
1876}
1877int sqlite3_create_window_function(
1878 sqlite3 *db,
1879 const char *zFunc,
1880 int nArg,
1881 int enc,
1882 void *p,
1883 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1884 void (*xFinal)(sqlite3_context*),
1885 void (*xValue)(sqlite3_context*),
1886 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1887 void (*xDestroy)(void *)
1888){
1889 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1890 xFinal, xValue, xInverse, xDestroy);
1891}
1892
danielk197793758c82005-01-21 08:13:14 +00001893#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001894int sqlite3_create_function16(
1895 sqlite3 *db,
1896 const void *zFunctionName,
1897 int nArg,
1898 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001899 void *p,
drh2d801512016-01-14 22:19:58 +00001900 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001901 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1902 void (*xFinal)(sqlite3_context*)
1903){
1904 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001905 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001906
1907#ifdef SQLITE_ENABLE_API_ARMOR
1908 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1909#endif
drhe30f4422007-08-21 16:15:55 +00001910 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001911 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001912 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00001913 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00001914 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001915 rc = sqlite3ApiExit(db, rc);
1916 sqlite3_mutex_leave(db->mutex);
1917 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001918}
danielk197793758c82005-01-21 08:13:14 +00001919#endif
drhc9b84a12002-06-20 11:36:48 +00001920
drhb7481e72006-09-16 21:45:14 +00001921
1922/*
drh92011842018-05-26 16:00:26 +00001923** The following is the implementation of an SQL function that always
1924** fails with an error message stating that the function is used in the
1925** wrong context. The sqlite3_overload_function() API might construct
1926** SQL function that use this routine so that the functions will exist
1927** for name resolution but are actually overloaded by the xFindFunction
1928** method of virtual tables.
1929*/
1930static void sqlite3InvalidFunction(
1931 sqlite3_context *context, /* The function calling context */
1932 int NotUsed, /* Number of arguments to the function */
1933 sqlite3_value **NotUsed2 /* Value of each argument */
1934){
1935 const char *zName = (const char*)sqlite3_user_data(context);
1936 char *zErr;
1937 UNUSED_PARAMETER2(NotUsed, NotUsed2);
1938 zErr = sqlite3_mprintf(
1939 "unable to use function %s in the requested context", zName);
1940 sqlite3_result_error(context, zErr, -1);
1941 sqlite3_free(zErr);
1942}
1943
1944/*
drhb7481e72006-09-16 21:45:14 +00001945** Declare that a function has been overloaded by a virtual table.
1946**
1947** If the function already exists as a regular global function, then
1948** this routine is a no-op. If the function does not exist, then create
1949** a new one that always throws a run-time error.
1950**
1951** When virtual tables intend to provide an overloaded function, they
1952** should call this routine to make sure the global function exists.
1953** A global function must exist in order for name resolution to work
1954** properly.
1955*/
1956int sqlite3_overload_function(
1957 sqlite3 *db,
1958 const char *zName,
1959 int nArg
1960){
drh92011842018-05-26 16:00:26 +00001961 int rc;
1962 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00001963
1964#ifdef SQLITE_ENABLE_API_ARMOR
1965 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1966 return SQLITE_MISUSE_BKPT;
1967 }
1968#endif
drhe30f4422007-08-21 16:15:55 +00001969 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00001970 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00001971 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00001972 if( rc ) return SQLITE_OK;
1973 zCopy = sqlite3_mprintf(zName);
1974 if( zCopy==0 ) return SQLITE_NOMEM;
1975 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
1976 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00001977}
1978
drh19e2d372005-08-29 23:00:03 +00001979#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001980/*
drh18de4822003-01-16 16:28:53 +00001981** Register a trace function. The pArg from the previously registered trace
1982** is returned.
1983**
1984** A NULL trace function means that no tracing is executes. A non-NULL
1985** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001986** SQL statement.
drh18de4822003-01-16 16:28:53 +00001987*/
drh3d2a5292016-07-13 22:55:01 +00001988#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00001989void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001990 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001991
1992#ifdef SQLITE_ENABLE_API_ARMOR
1993 if( !sqlite3SafetyCheckOk(db) ){
1994 (void)SQLITE_MISUSE_BKPT;
1995 return 0;
1996 }
1997#endif
drhe30f4422007-08-21 16:15:55 +00001998 sqlite3_mutex_enter(db->mutex);
1999 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00002000 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00002001 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00002002 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002003 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002004 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002005}
drh3d2a5292016-07-13 22:55:01 +00002006#endif /* SQLITE_OMIT_DEPRECATED */
2007
2008/* Register a trace callback using the version-2 interface.
2009*/
2010int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002011 sqlite3 *db, /* Trace this connection */
2012 unsigned mTrace, /* Mask of events to be traced */
2013 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2014 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002015){
2016#ifdef SQLITE_ENABLE_API_ARMOR
2017 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002018 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002019 }
2020#endif
2021 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002022 if( mTrace==0 ) xTrace = 0;
2023 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002024 db->mTrace = mTrace;
2025 db->xTrace = xTrace;
2026 db->pTraceArg = pArg;
2027 sqlite3_mutex_leave(db->mutex);
2028 return SQLITE_OK;
2029}
2030
drh087ec072016-07-25 00:05:56 +00002031#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002032/*
2033** Register a profile function. The pArg from the previously registered
2034** profile function is returned.
2035**
2036** A NULL profile function means that no profiling is executes. A non-NULL
2037** profile is a pointer to a function that is invoked at the conclusion of
2038** each SQL statement that is run.
2039*/
2040void *sqlite3_profile(
2041 sqlite3 *db,
2042 void (*xProfile)(void*,const char*,sqlite_uint64),
2043 void *pArg
2044){
drhe30f4422007-08-21 16:15:55 +00002045 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002046
2047#ifdef SQLITE_ENABLE_API_ARMOR
2048 if( !sqlite3SafetyCheckOk(db) ){
2049 (void)SQLITE_MISUSE_BKPT;
2050 return 0;
2051 }
2052#endif
drhe30f4422007-08-21 16:15:55 +00002053 sqlite3_mutex_enter(db->mutex);
2054 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002055 db->xProfile = xProfile;
2056 db->pProfileArg = pArg;
drh04c67472018-12-04 14:33:02 +00002057 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2058 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
drhe30f4422007-08-21 16:15:55 +00002059 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002060 return pOld;
2061}
drh087ec072016-07-25 00:05:56 +00002062#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002063#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002064
drhcd565fd2012-03-01 21:30:44 +00002065/*
2066** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002067** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002068** rollback.
2069*/
danielk197724b03fd2004-05-10 10:34:34 +00002070void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002071 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002072 int (*xCallback)(void*), /* Function to invoke on each commit */
2073 void *pArg /* Argument to the function */
2074){
drhe30f4422007-08-21 16:15:55 +00002075 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002076
2077#ifdef SQLITE_ENABLE_API_ARMOR
2078 if( !sqlite3SafetyCheckOk(db) ){
2079 (void)SQLITE_MISUSE_BKPT;
2080 return 0;
2081 }
2082#endif
drhe30f4422007-08-21 16:15:55 +00002083 sqlite3_mutex_enter(db->mutex);
2084 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002085 db->xCommitCallback = xCallback;
2086 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002087 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002088 return pOld;
2089}
2090
danielk197794eb6a12005-12-15 15:22:08 +00002091/*
2092** Register a callback to be invoked each time a row is updated,
2093** inserted or deleted using this database connection.
2094*/
danielk197771fd80b2005-12-16 06:54:01 +00002095void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002096 sqlite3 *db, /* Attach the hook to this database */
2097 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2098 void *pArg /* Argument to the function */
2099){
drhe30f4422007-08-21 16:15:55 +00002100 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002101
2102#ifdef SQLITE_ENABLE_API_ARMOR
2103 if( !sqlite3SafetyCheckOk(db) ){
2104 (void)SQLITE_MISUSE_BKPT;
2105 return 0;
2106 }
2107#endif
drhe30f4422007-08-21 16:15:55 +00002108 sqlite3_mutex_enter(db->mutex);
2109 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002110 db->xUpdateCallback = xCallback;
2111 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002112 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002113 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002114}
2115
danielk197771fd80b2005-12-16 06:54:01 +00002116/*
2117** Register a callback to be invoked each time a transaction is rolled
2118** back by this database connection.
2119*/
2120void *sqlite3_rollback_hook(
2121 sqlite3 *db, /* Attach the hook to this database */
2122 void (*xCallback)(void*), /* Callback function */
2123 void *pArg /* Argument to the function */
2124){
drhe30f4422007-08-21 16:15:55 +00002125 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002126
2127#ifdef SQLITE_ENABLE_API_ARMOR
2128 if( !sqlite3SafetyCheckOk(db) ){
2129 (void)SQLITE_MISUSE_BKPT;
2130 return 0;
2131 }
2132#endif
drhe30f4422007-08-21 16:15:55 +00002133 sqlite3_mutex_enter(db->mutex);
2134 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002135 db->xRollbackCallback = xCallback;
2136 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002137 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002138 return pRet;
2139}
drhaa940ea2004-01-15 02:44:03 +00002140
drh9b1c62d2011-03-30 21:04:43 +00002141#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002142/*
2143** Register a callback to be invoked each time a row is updated,
2144** inserted or deleted using this database connection.
2145*/
2146void *sqlite3_preupdate_hook(
2147 sqlite3 *db, /* Attach the hook to this database */
2148 void(*xCallback)( /* Callback function */
2149 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2150 void *pArg /* First callback argument */
2151){
2152 void *pRet;
2153 sqlite3_mutex_enter(db->mutex);
2154 pRet = db->pPreUpdateArg;
2155 db->xPreUpdateCallback = xCallback;
2156 db->pPreUpdateArg = pArg;
2157 sqlite3_mutex_leave(db->mutex);
2158 return pRet;
2159}
drh9b1c62d2011-03-30 21:04:43 +00002160#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002161
dan586b9c82010-05-03 08:04:49 +00002162#ifndef SQLITE_OMIT_WAL
2163/*
2164** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002165** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2166** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002167** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002168*/
drhb033d8b2010-05-03 13:37:30 +00002169int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002170 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002171 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002172 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002173 int nFrame /* Size of WAL */
2174){
drh5def0842010-05-05 20:00:25 +00002175 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002176 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002177 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002178 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002179 }
2180 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002181}
drhb033d8b2010-05-03 13:37:30 +00002182#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002183
2184/*
2185** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2186** a database after committing a transaction if there are nFrame or
2187** more frames in the log file. Passing zero or a negative value as the
2188** nFrame parameter disables automatic checkpoints entirely.
2189**
2190** The callback registered by this function replaces any existing callback
2191** registered using sqlite3_wal_hook(). Likewise, registering a callback
2192** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2193** configured by this function.
2194*/
2195int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002196#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002197 UNUSED_PARAMETER(db);
2198 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002199#else
drh9ca95732014-10-24 00:35:58 +00002200#ifdef SQLITE_ENABLE_API_ARMOR
2201 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2202#endif
dan586b9c82010-05-03 08:04:49 +00002203 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002204 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002205 }else{
2206 sqlite3_wal_hook(db, 0, 0);
2207 }
drhb033d8b2010-05-03 13:37:30 +00002208#endif
dan586b9c82010-05-03 08:04:49 +00002209 return SQLITE_OK;
2210}
2211
paulb0208cc2003-04-13 18:26:49 +00002212/*
dan8d22a172010-04-19 18:03:51 +00002213** Register a callback to be invoked each time a transaction is written
2214** into the write-ahead-log by this database connection.
2215*/
drh833bf962010-04-28 14:42:19 +00002216void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002217 sqlite3 *db, /* Attach the hook to this db handle */
2218 int(*xCallback)(void *, sqlite3*, const char*, int),
2219 void *pArg /* First argument passed to xCallback() */
2220){
drhb033d8b2010-05-03 13:37:30 +00002221#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002222 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002223#ifdef SQLITE_ENABLE_API_ARMOR
2224 if( !sqlite3SafetyCheckOk(db) ){
2225 (void)SQLITE_MISUSE_BKPT;
2226 return 0;
2227 }
2228#endif
dan8d22a172010-04-19 18:03:51 +00002229 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002230 pRet = db->pWalArg;
2231 db->xWalCallback = xCallback;
2232 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002233 sqlite3_mutex_leave(db->mutex);
2234 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002235#else
2236 return 0;
2237#endif
dan8d22a172010-04-19 18:03:51 +00002238}
2239
2240/*
dancdc1f042010-11-18 12:11:05 +00002241** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002242*/
dancdc1f042010-11-18 12:11:05 +00002243int sqlite3_wal_checkpoint_v2(
2244 sqlite3 *db, /* Database handle */
2245 const char *zDb, /* Name of attached database (or NULL) */
2246 int eMode, /* SQLITE_CHECKPOINT_* value */
2247 int *pnLog, /* OUT: Size of WAL log in frames */
2248 int *pnCkpt /* OUT: Total number of frames checkpointed */
2249){
drhb033d8b2010-05-03 13:37:30 +00002250#ifdef SQLITE_OMIT_WAL
2251 return SQLITE_OK;
2252#else
dan586b9c82010-05-03 08:04:49 +00002253 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002254 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002255
drh9ca95732014-10-24 00:35:58 +00002256#ifdef SQLITE_ENABLE_API_ARMOR
2257 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2258#endif
2259
dan9c5e3682011-02-07 15:12:12 +00002260 /* Initialize the output variables to -1 in case an error occurs. */
2261 if( pnLog ) *pnLog = -1;
2262 if( pnCkpt ) *pnCkpt = -1;
2263
danf26a1542014-12-02 19:04:54 +00002264 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2265 assert( SQLITE_CHECKPOINT_FULL==1 );
2266 assert( SQLITE_CHECKPOINT_RESTART==2 );
2267 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2268 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002269 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2270 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002271 return SQLITE_MISUSE;
2272 }
2273
dan586b9c82010-05-03 08:04:49 +00002274 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002275 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002276 iDb = sqlite3FindDbName(db, zDb);
2277 }
2278 if( iDb<0 ){
2279 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002280 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002281 }else{
dan976b0032015-01-29 19:12:12 +00002282 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002283 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002284 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002285 }
drhb033d8b2010-05-03 13:37:30 +00002286 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002287
2288 /* If there are no active statements, clear the interrupt flag at this
2289 ** point. */
2290 if( db->nVdbeActive==0 ){
2291 db->u1.isInterrupted = 0;
2292 }
2293
dan586b9c82010-05-03 08:04:49 +00002294 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002295 return rc;
2296#endif
dan586b9c82010-05-03 08:04:49 +00002297}
2298
dancdc1f042010-11-18 12:11:05 +00002299
2300/*
2301** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2302** to contains a zero-length string, all attached databases are
2303** checkpointed.
2304*/
2305int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002306 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2307 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2308 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002309}
2310
drhb033d8b2010-05-03 13:37:30 +00002311#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002312/*
2313** Run a checkpoint on database iDb. This is a no-op if database iDb is
2314** not currently open in WAL mode.
2315**
dan6fcff072010-05-03 14:05:43 +00002316** If a transaction is open on the database being checkpointed, this
2317** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2318** an error occurs while running the checkpoint, an SQLite error code is
2319** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002320**
2321** The mutex on database handle db should be held by the caller. The mutex
2322** associated with the specific b-tree being checkpointed is taken by
2323** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002324**
2325** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2326** checkpointed. If an error is encountered it is returned immediately -
2327** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002328**
dan78345512017-09-08 17:48:00 +00002329** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2330** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002331*/
dancdc1f042010-11-18 12:11:05 +00002332int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002333 int rc = SQLITE_OK; /* Return code */
2334 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002335 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002336
2337 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002338 assert( !pnLog || *pnLog==-1 );
2339 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002340
dan6fcff072010-05-03 14:05:43 +00002341 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2342 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002343 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002344 pnLog = 0;
2345 pnCkpt = 0;
2346 if( rc==SQLITE_BUSY ){
2347 bBusy = 1;
2348 rc = SQLITE_OK;
2349 }
dan6fcff072010-05-03 14:05:43 +00002350 }
dan586b9c82010-05-03 08:04:49 +00002351 }
2352
danf2b8dd52010-11-18 19:28:01 +00002353 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002354}
drhb033d8b2010-05-03 13:37:30 +00002355#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002356
2357/*
danielk1977d8293352009-04-30 09:10:37 +00002358** This function returns true if main-memory should be used instead of
2359** a temporary file for transient pager files and statement journals.
2360** The value returned depends on the value of db->temp_store (runtime
2361** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2362** following table describes the relationship between these two values
2363** and this functions return value.
2364**
2365** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2366** ----------------- -------------- ------------------------------
2367** 0 any file (return 0)
2368** 1 1 file (return 0)
2369** 1 2 memory (return 1)
2370** 1 0 file (return 0)
2371** 2 1 file (return 0)
2372** 2 2 memory (return 1)
2373** 2 0 memory (return 1)
2374** 3 any memory (return 1)
2375*/
drh1c514142009-04-30 12:25:10 +00002376int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002377#if SQLITE_TEMP_STORE==1
2378 return ( db->temp_store==2 );
2379#endif
2380#if SQLITE_TEMP_STORE==2
2381 return ( db->temp_store!=1 );
2382#endif
2383#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002384 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002385 return 1;
shanecf697392009-06-01 16:53:09 +00002386#endif
2387#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002388 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002389 return 0;
shane60a4b532009-05-06 18:57:09 +00002390#endif
danielk1977d8293352009-04-30 09:10:37 +00002391}
2392
2393/*
danielk19774ad17132004-05-21 01:47:26 +00002394** Return UTF-8 encoded English language explanation of the most recent
2395** error.
2396*/
danielk19776622cce2004-05-20 11:00:52 +00002397const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002398 const char *z;
drhf49661a2008-12-10 16:45:50 +00002399 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002400 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002401 }
drhd55d57e2008-07-07 17:53:07 +00002402 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002403 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002404 }
drh27641702007-08-22 02:56:42 +00002405 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002406 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002407 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002408 }else{
drha3cc0072013-12-13 16:23:55 +00002409 testcase( db->pErr==0 );
drh368bfe82018-12-11 12:20:41 +00002410 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
danielk1977238746a2009-03-19 18:51:06 +00002411 assert( !db->mallocFailed );
2412 if( z==0 ){
2413 z = sqlite3ErrStr(db->errCode);
2414 }
danielk19776622cce2004-05-20 11:00:52 +00002415 }
drhe30f4422007-08-21 16:15:55 +00002416 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002417 return z;
danielk19776622cce2004-05-20 11:00:52 +00002418}
2419
drh6c626082004-11-14 21:56:29 +00002420#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002421/*
2422** Return UTF-16 encoded English language explanation of the most recent
2423** error.
2424*/
danielk19776622cce2004-05-20 11:00:52 +00002425const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002426 static const u16 outOfMem[] = {
2427 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002428 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002429 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002430 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2431 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2432 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002433 };
danielk19774ad17132004-05-21 01:47:26 +00002434
drhc60d0442004-09-30 13:43:13 +00002435 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002436 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002437 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002438 }
drhd55d57e2008-07-07 17:53:07 +00002439 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002440 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002441 }
drhe30f4422007-08-21 16:15:55 +00002442 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002443 if( db->mallocFailed ){
2444 z = (void *)outOfMem;
2445 }else{
drhc60d0442004-09-30 13:43:13 +00002446 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002447 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002448 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002449 z = sqlite3_value_text16(db->pErr);
2450 }
2451 /* A malloc() may have failed within the call to sqlite3_value_text16()
2452 ** above. If this is the case, then the db->mallocFailed flag needs to
2453 ** be cleared before returning. Do this directly, instead of via
2454 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2455 */
drh4a642b62016-02-05 01:55:27 +00002456 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002457 }
drhe30f4422007-08-21 16:15:55 +00002458 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002459 return z;
danielk19776622cce2004-05-20 11:00:52 +00002460}
drh6c626082004-11-14 21:56:29 +00002461#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002462
drhc60d0442004-09-30 13:43:13 +00002463/*
danielk19777ddad962005-12-12 06:53:03 +00002464** Return the most recent error code generated by an SQLite routine. If NULL is
2465** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002466*/
danielk19776622cce2004-05-20 11:00:52 +00002467int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002468 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002469 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002470 }
drh01495b92008-01-23 12:52:40 +00002471 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002472 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002473 }
drh4ac285a2006-09-15 07:28:50 +00002474 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002475}
drh99dfe5e2008-10-30 15:03:15 +00002476int sqlite3_extended_errcode(sqlite3 *db){
2477 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002478 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002479 }
2480 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002481 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002482 }
2483 return db->errCode;
2484}
drh1b9f2142016-03-17 16:01:23 +00002485int sqlite3_system_errno(sqlite3 *db){
2486 return db ? db->iSysErrno : 0;
2487}
danielk19776622cce2004-05-20 11:00:52 +00002488
drh0e819f92006-02-01 13:50:41 +00002489/*
mistachkin5dac8432012-09-11 02:00:25 +00002490** Return a string that describes the kind of error specified in the
2491** argument. For now, this simply calls the internal sqlite3ErrStr()
2492** function.
2493*/
2494const char *sqlite3_errstr(int rc){
2495 return sqlite3ErrStr(rc);
2496}
2497
2498/*
drh0e819f92006-02-01 13:50:41 +00002499** Create a new collating function for database "db". The name is zName
2500** and the encoding is enc.
2501*/
danielk19779a30cf62006-01-18 04:26:07 +00002502static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002503 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002504 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002505 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002506 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002507 int(*xCompare)(void*,int,const void*,int,const void*),
2508 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002509){
2510 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002511 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002512
drhe30f4422007-08-21 16:15:55 +00002513 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002514
2515 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2516 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2517 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2518 */
drh51c7d862009-04-27 18:46:06 +00002519 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002520 testcase( enc2==SQLITE_UTF16 );
2521 testcase( enc2==SQLITE_UTF16_ALIGNED );
2522 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002523 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002524 }
drh51c7d862009-04-27 18:46:06 +00002525 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002526 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002527 }
2528
2529 /* Check if this call is removing or replacing an existing collation
2530 ** sequence. If so, and there are active VMs, return busy. If there
2531 ** are no active VMs, invalidate any pre-compiled statements.
2532 */
drhc4a64fa2009-05-11 20:53:28 +00002533 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002534 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002535 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002536 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002537 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002538 return SQLITE_BUSY;
2539 }
drhba968db2018-07-24 22:02:12 +00002540 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002541
2542 /* If collation sequence pColl was created directly by a call to
2543 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2544 ** then any copies made by synthCollSeq() need to be invalidated.
2545 ** Also, collation destructor - CollSeq.xDel() - function may need
2546 ** to be called.
2547 */
2548 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002549 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002550 int j;
2551 for(j=0; j<3; j++){
2552 CollSeq *p = &aColl[j];
2553 if( p->enc==pColl->enc ){
2554 if( p->xDel ){
2555 p->xDel(p->pUser);
2556 }
2557 p->xCmp = 0;
2558 }
2559 }
2560 }
danielk19779a30cf62006-01-18 04:26:07 +00002561 }
2562
drhc4a64fa2009-05-11 20:53:28 +00002563 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002564 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002565 pColl->xCmp = xCompare;
2566 pColl->pUser = pCtx;
2567 pColl->xDel = xDel;
2568 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002569 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002570 return SQLITE_OK;
2571}
2572
2573
danielk19776622cce2004-05-20 11:00:52 +00002574/*
drhbb4957f2008-03-20 14:03:29 +00002575** This array defines hard upper bounds on limit values. The
2576** initializer must be kept in sync with the SQLITE_LIMIT_*
2577** #defines in sqlite3.h.
2578*/
drhb1a6c3c2008-03-20 16:30:17 +00002579static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002580 SQLITE_MAX_LENGTH,
2581 SQLITE_MAX_SQL_LENGTH,
2582 SQLITE_MAX_COLUMN,
2583 SQLITE_MAX_EXPR_DEPTH,
2584 SQLITE_MAX_COMPOUND_SELECT,
2585 SQLITE_MAX_VDBE_OP,
2586 SQLITE_MAX_FUNCTION_ARG,
2587 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002588 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002589 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002590 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002591 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002592};
2593
2594/*
2595** Make sure the hard limits are set to reasonable values
2596*/
2597#if SQLITE_MAX_LENGTH<100
2598# error SQLITE_MAX_LENGTH must be at least 100
2599#endif
2600#if SQLITE_MAX_SQL_LENGTH<100
2601# error SQLITE_MAX_SQL_LENGTH must be at least 100
2602#endif
2603#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2604# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2605#endif
drhbb4957f2008-03-20 14:03:29 +00002606#if SQLITE_MAX_COMPOUND_SELECT<2
2607# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2608#endif
2609#if SQLITE_MAX_VDBE_OP<40
2610# error SQLITE_MAX_VDBE_OP must be at least 40
2611#endif
drh80738d92016-02-15 00:34:16 +00002612#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2613# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002614#endif
drhd08b2792014-07-22 15:33:31 +00002615#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2616# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002617#endif
drhbb4957f2008-03-20 14:03:29 +00002618#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2619# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2620#endif
drh70a8ca32008-08-21 18:49:27 +00002621#if SQLITE_MAX_COLUMN>32767
2622# error SQLITE_MAX_COLUMN must not exceed 32767
2623#endif
drh417168a2009-09-07 18:14:02 +00002624#if SQLITE_MAX_TRIGGER_DEPTH<1
2625# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2626#endif
drh111544c2014-08-29 16:20:47 +00002627#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2628# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2629#endif
drhbb4957f2008-03-20 14:03:29 +00002630
2631
2632/*
2633** Change the value of a limit. Report the old value.
2634** If an invalid limit index is supplied, report -1.
2635** Make no changes but still report the old value if the
2636** new limit is negative.
2637**
2638** A new lower limit does not shrink existing constructs.
2639** It merely prevents new constructs that exceed the limit
2640** from forming.
2641*/
2642int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2643 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002644
drh9ca95732014-10-24 00:35:58 +00002645#ifdef SQLITE_ENABLE_API_ARMOR
2646 if( !sqlite3SafetyCheckOk(db) ){
2647 (void)SQLITE_MISUSE_BKPT;
2648 return -1;
2649 }
2650#endif
drh4e93f5b2010-09-07 14:59:15 +00002651
2652 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2653 ** there is a hard upper bound set at compile-time by a C preprocessor
2654 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2655 ** "_MAX_".)
2656 */
2657 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2658 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2659 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2660 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2661 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2662 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2663 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2664 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2665 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2666 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2667 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2668 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002669 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2670 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002671
2672
drh521cc842008-04-15 02:36:33 +00002673 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002674 return -1;
2675 }
2676 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002677 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002678 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002679 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002680 }
2681 db->aLimit[limitId] = newLimit;
2682 }
drh4e93f5b2010-09-07 14:59:15 +00002683 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002684}
2685
2686/*
dan286ab7c2011-05-06 18:34:54 +00002687** This function is used to parse both URIs and non-URI filenames passed by the
2688** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2689** URIs specified as part of ATTACH statements.
2690**
2691** The first argument to this function is the name of the VFS to use (or
2692** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2693** query parameter. The second argument contains the URI (or non-URI filename)
2694** itself. When this function is called the *pFlags variable should contain
2695** the default flags to open the database handle with. The value stored in
2696** *pFlags may be updated before returning if the URI filename contains
2697** "cache=xxx" or "mode=xxx" query parameters.
2698**
2699** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2700** the VFS that should be used to open the database file. *pzFile is set to
2701** point to a buffer containing the name of the file to open. It is the
2702** responsibility of the caller to eventually call sqlite3_free() to release
2703** this buffer.
2704**
2705** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2706** may be set to point to a buffer containing an English language error
2707** message. It is the responsibility of the caller to eventually release
2708** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002709*/
2710int sqlite3ParseUri(
2711 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2712 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002713 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002714 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2715 char **pzFile, /* OUT: Filename component of URI */
2716 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2717){
dan78e9dd22011-05-03 10:22:32 +00002718 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002719 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002720 const char *zVfs = zDefaultVfs;
2721 char *zFile;
drhde941c32011-05-09 19:20:17 +00002722 char c;
dancd74b612011-04-22 19:37:32 +00002723 int nUri = sqlite3Strlen30(zUri);
2724
2725 assert( *pzErrMsg==0 );
2726
drh8790b6e2014-11-07 01:43:56 +00002727 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2728 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002729 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002730 ){
dan5de15372011-04-23 10:12:30 +00002731 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002732 int eState; /* Parser state when parsing URI */
2733 int iIn; /* Input character index */
2734 int iOut = 0; /* Output character index */
drhf3cdcdc2015-04-29 16:50:28 +00002735 u64 nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002736
dan286ab7c2011-05-06 18:34:54 +00002737 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2738 ** method that there may be extra parameters following the file-name. */
2739 flags |= SQLITE_OPEN_URI;
2740
2741 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002742 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002743 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002744
drh869c0402013-08-07 23:15:52 +00002745 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002746#ifdef SQLITE_ALLOW_URI_AUTHORITY
2747 if( strncmp(zUri+5, "///", 3)==0 ){
2748 iIn = 7;
2749 /* The following condition causes URIs with five leading / characters
2750 ** like file://///host/path to be converted into UNCs like //host/path.
2751 ** The correct URI for that UNC has only two or four leading / characters
2752 ** file://host/path or file:////host/path. But 5 leading slashes is a
2753 ** common error, we are told, so we handle it as a special case. */
2754 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2755 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2756 iIn = 16;
2757 }
2758#else
dancd74b612011-04-22 19:37:32 +00002759 /* Discard the scheme and authority segments of the URI. */
2760 if( zUri[5]=='/' && zUri[6]=='/' ){
2761 iIn = 7;
2762 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002763 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2764 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2765 iIn-7, &zUri[7]);
2766 rc = SQLITE_ERROR;
2767 goto parse_uri_out;
2768 }
dancd74b612011-04-22 19:37:32 +00002769 }
drh869c0402013-08-07 23:15:52 +00002770#endif
dancd74b612011-04-22 19:37:32 +00002771
2772 /* Copy the filename and any query parameters into the zFile buffer.
2773 ** Decode %HH escape codes along the way.
2774 **
2775 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2776 ** on the parsing context. As follows:
2777 **
2778 ** 0: Parsing file-name.
2779 ** 1: Parsing name section of a name=value query parameter.
2780 ** 2: Parsing value section of a name=value query parameter.
2781 */
2782 eState = 0;
drhde941c32011-05-09 19:20:17 +00002783 while( (c = zUri[iIn])!=0 && c!='#' ){
2784 iIn++;
dancd74b612011-04-22 19:37:32 +00002785 if( c=='%'
2786 && sqlite3Isxdigit(zUri[iIn])
2787 && sqlite3Isxdigit(zUri[iIn+1])
2788 ){
dan6d49e252011-05-03 15:09:05 +00002789 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2790 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002791
dan6d49e252011-05-03 15:09:05 +00002792 assert( octet>=0 && octet<256 );
2793 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002794#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002795 /* This branch is taken when "%00" appears within the URI. In this
2796 ** case we ignore all text in the remainder of the path, name or
2797 ** value currently being parsed. So ignore the current character
2798 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002799 while( (c = zUri[iIn])!=0 && c!='#'
2800 && (eState!=0 || c!='?')
2801 && (eState!=1 || (c!='=' && c!='&'))
2802 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002803 ){
2804 iIn++;
2805 }
2806 continue;
dan5c35e902016-10-26 12:15:41 +00002807#else
2808 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2809 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2810 rc = SQLITE_ERROR;
2811 goto parse_uri_out;
2812#endif
dancd74b612011-04-22 19:37:32 +00002813 }
dan6d49e252011-05-03 15:09:05 +00002814 c = octet;
dan5de15372011-04-23 10:12:30 +00002815 }else if( eState==1 && (c=='&' || c=='=') ){
2816 if( zFile[iOut-1]==0 ){
2817 /* An empty option name. Ignore this option altogether. */
2818 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2819 continue;
2820 }
2821 if( c=='&' ){
2822 zFile[iOut++] = '\0';
2823 }else{
2824 eState = 2;
2825 }
dancd74b612011-04-22 19:37:32 +00002826 c = 0;
dan5de15372011-04-23 10:12:30 +00002827 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2828 c = 0;
dancd74b612011-04-22 19:37:32 +00002829 eState = 1;
dancd74b612011-04-22 19:37:32 +00002830 }
2831 zFile[iOut++] = c;
2832 }
2833 if( eState==1 ) zFile[iOut++] = '\0';
2834 zFile[iOut++] = '\0';
2835 zFile[iOut++] = '\0';
2836
2837 /* Check if there were any options specified that should be interpreted
2838 ** here. Options that are interpreted here include "vfs" and those that
2839 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002840 ** method. */
dan5de15372011-04-23 10:12:30 +00002841 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2842 while( zOpt[0] ){
2843 int nOpt = sqlite3Strlen30(zOpt);
2844 char *zVal = &zOpt[nOpt+1];
2845 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002846
dan286ab7c2011-05-06 18:34:54 +00002847 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002848 zVfs = zVal;
2849 }else{
2850 struct OpenMode {
2851 const char *z;
2852 int mode;
2853 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002854 char *zModeType = 0;
2855 int mask = 0;
2856 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002857
dan286ab7c2011-05-06 18:34:54 +00002858 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002859 static struct OpenMode aCacheMode[] = {
2860 { "shared", SQLITE_OPEN_SHAREDCACHE },
2861 { "private", SQLITE_OPEN_PRIVATECACHE },
2862 { 0, 0 }
2863 };
2864
2865 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2866 aMode = aCacheMode;
2867 limit = mask;
2868 zModeType = "cache";
2869 }
dan286ab7c2011-05-06 18:34:54 +00002870 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002871 static struct OpenMode aOpenMode[] = {
2872 { "ro", SQLITE_OPEN_READONLY },
2873 { "rw", SQLITE_OPEN_READWRITE },
2874 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002875 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002876 { 0, 0 }
2877 };
2878
drh9c67b2a2012-05-28 13:58:00 +00002879 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2880 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002881 aMode = aOpenMode;
2882 limit = mask & flags;
2883 zModeType = "access";
2884 }
2885
2886 if( aMode ){
2887 int i;
2888 int mode = 0;
2889 for(i=0; aMode[i].z; i++){
2890 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002891 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002892 mode = aMode[i].mode;
2893 break;
dancd74b612011-04-22 19:37:32 +00002894 }
2895 }
dan78e9dd22011-05-03 10:22:32 +00002896 if( mode==0 ){
2897 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2898 rc = SQLITE_ERROR;
2899 goto parse_uri_out;
2900 }
drh9c67b2a2012-05-28 13:58:00 +00002901 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002902 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2903 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002904 rc = SQLITE_PERM;
2905 goto parse_uri_out;
2906 }
2907 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002908 }
dancd74b612011-04-22 19:37:32 +00002909 }
dan5de15372011-04-23 10:12:30 +00002910
2911 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002912 }
2913
2914 }else{
drhf3cdcdc2015-04-29 16:50:28 +00002915 zFile = sqlite3_malloc64(nUri+2);
mistachkinfad30392016-02-13 23:43:46 +00002916 if( !zFile ) return SQLITE_NOMEM_BKPT;
dan895decf2016-12-30 14:15:56 +00002917 if( nUri ){
2918 memcpy(zFile, zUri, nUri);
2919 }
dancd74b612011-04-22 19:37:32 +00002920 zFile[nUri] = '\0';
2921 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002922 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002923 }
2924
2925 *ppVfs = sqlite3_vfs_find(zVfs);
2926 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002927 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002928 rc = SQLITE_ERROR;
2929 }
2930 parse_uri_out:
2931 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002932 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002933 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002934 }
2935 *pFlags = flags;
2936 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002937 return rc;
dancd74b612011-04-22 19:37:32 +00002938}
2939
drhe5989722019-02-02 15:59:49 +00002940#if defined(SQLITE_HAS_CODEC)
2941/*
2942** Process URI filename query parameters relevant to the SQLite Encryption
2943** Extension. Return true if any of the relevant query parameters are
2944** seen and return false if not.
2945*/
2946int sqlite3CodecQueryParameters(
2947 sqlite3 *db, /* Database connection */
2948 const char *zDb, /* Which schema is being created/attached */
2949 const char *zUri /* URI filename */
2950){
2951 const char *zKey;
2952 if( (zKey = sqlite3_uri_parameter(zUri, "hexkey"))!=0 && zKey[0] ){
2953 u8 iByte;
2954 int i;
2955 char zDecoded[40];
2956 for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
2957 iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
2958 if( (i&1)!=0 ) zDecoded[i/2] = iByte;
2959 }
2960 sqlite3_key_v2(db, zDb, zDecoded, i/2);
2961 return 1;
2962 }else if( (zKey = sqlite3_uri_parameter(zUri, "key"))!=0 ){
2963 sqlite3_key_v2(db, zDb, zKey, sqlite3Strlen30(zKey));
2964 return 1;
2965 }else if( (zKey = sqlite3_uri_parameter(zUri, "textkey"))!=0 ){
2966 sqlite3_key_v2(db, zDb, zKey, -1);
2967 return 1;
2968 }else{
2969 return 0;
2970 }
2971}
2972#endif
2973
dancd74b612011-04-22 19:37:32 +00002974
2975/*
danielk19774ad17132004-05-21 01:47:26 +00002976** This routine does the work of opening a database on behalf of
2977** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002978** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002979*/
2980static int openDatabase(
2981 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002982 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002983 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002984 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002985){
dancd74b612011-04-22 19:37:32 +00002986 sqlite3 *db; /* Store allocated handle here */
2987 int rc; /* Return code */
2988 int isThreadsafe; /* True for threadsafe connections */
2989 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2990 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002991
drh9ca95732014-10-24 00:35:58 +00002992#ifdef SQLITE_ENABLE_API_ARMOR
2993 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2994#endif
drhe0d0f8e2009-04-28 04:47:31 +00002995 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002996#ifndef SQLITE_OMIT_AUTOINIT
2997 rc = sqlite3_initialize();
2998 if( rc ) return rc;
2999#endif
3000
drh039963a2008-09-03 00:43:15 +00003001 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00003002 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00003003 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3004 isThreadsafe = 0;
3005 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3006 isThreadsafe = 1;
3007 }else{
3008 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00003009 }
dan8385bec2017-11-25 17:51:01 +00003010
drhf1f12682009-09-09 14:17:52 +00003011 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00003012 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00003013 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3014 flags |= SQLITE_OPEN_SHAREDCACHE;
3015 }
danielk19779a6284c2008-07-10 17:52:49 +00003016
drhb25a9f42009-05-12 13:35:11 +00003017 /* Remove harmful bits from the flags parameter
3018 **
3019 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3020 ** dealt with in the previous code block. Besides these, the only
3021 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00003022 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3023 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00003024 ** off all other flags.
3025 */
drha4267dc2008-02-19 15:20:44 +00003026 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00003027 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00003028 SQLITE_OPEN_MAIN_DB |
3029 SQLITE_OPEN_TEMP_DB |
3030 SQLITE_OPEN_TRANSIENT_DB |
3031 SQLITE_OPEN_MAIN_JOURNAL |
3032 SQLITE_OPEN_TEMP_JOURNAL |
3033 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00003034 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003035 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003036 SQLITE_OPEN_FULLMUTEX |
3037 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003038 );
3039
danielk19774ad17132004-05-21 01:47:26 +00003040 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003041 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003042 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003043 if( isThreadsafe
3044#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3045 || sqlite3GlobalConfig.bCoreMutex
3046#endif
3047 ){
danielk197759f8c082008-06-18 17:09:10 +00003048 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3049 if( db->mutex==0 ){
3050 sqlite3_free(db);
3051 db = 0;
3052 goto opendb_out;
3053 }
dan8385bec2017-11-25 17:51:01 +00003054 if( isThreadsafe==0 ){
3055 sqlite3MutexWarnOnContention(db->mutex);
3056 }
drh605264d2007-08-21 15:13:19 +00003057 }
drh27641702007-08-22 02:56:42 +00003058 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003059 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003060 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003061 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003062 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003063 db->lookaside.bDisable = 1;
drh633e6d52008-07-28 19:34:53 +00003064
drhbb4957f2008-03-20 14:03:29 +00003065 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3066 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003067 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003068 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003069 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003070 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003071 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003072 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00003073 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00003074#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003075 | SQLITE_AutoIndex
3076#endif
drh883ad042015-02-19 00:29:11 +00003077#if SQLITE_DEFAULT_CKPTFULLFSYNC
3078 | SQLITE_CkptFullFSync
3079#endif
drh76fe8032006-07-11 14:17:51 +00003080#if SQLITE_DEFAULT_FILE_FORMAT<4
3081 | SQLITE_LegacyFileFmt
3082#endif
drh56424db2007-03-27 22:24:11 +00003083#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3084 | SQLITE_LoadExtension
3085#endif
dan5bde73c2009-09-01 17:11:07 +00003086#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003087 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003088#endif
drha4bfd7f2010-12-09 19:15:17 +00003089#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3090 | SQLITE_ForeignKeys
3091#endif
drhf5471922014-12-09 15:12:11 +00003092#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3093 | SQLITE_ReverseOrder
3094#endif
drh1421d982015-05-27 03:46:18 +00003095#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3096 | SQLITE_CellSizeCk
3097#endif
drhd42908f2016-02-26 15:38:24 +00003098#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3099 | SQLITE_Fts3Tokenizer
3100#endif
drh169dd922017-06-26 13:57:49 +00003101#if defined(SQLITE_ENABLE_QPSG)
3102 | SQLITE_EnableQPSG
3103#endif
drh6ab91a72018-11-07 02:17:01 +00003104#if defined(SQLITE_DEFAULT_DEFENSIVE)
3105 | SQLITE_Defensive
3106#endif
drh76fe8032006-07-11 14:17:51 +00003107 ;
drhe61922a2009-05-02 13:29:37 +00003108 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003109#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003110 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003111#endif
danielk1977da184232006-01-05 11:34:32 +00003112
danielk19770202b292004-06-09 09:55:16 +00003113 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3114 ** and UTF-16, so add a version for each to avoid any unnecessary
3115 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003116 **
3117 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3118 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003119 */
drhf19aa5f2015-12-30 16:51:20 +00003120 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3121 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3122 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003123 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh821afa42019-06-14 13:24:46 +00003124 createCollation(db, "RTRIM", SQLITE_UTF8, 0, rtrimCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003125 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003126 goto opendb_out;
3127 }
drh5e3b49b2014-11-20 19:22:26 +00003128 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3129 ** strings is BINARY.
3130 */
drhf19aa5f2015-12-30 16:51:20 +00003131 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
drh77db4c02008-03-18 13:01:38 +00003132 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00003133
drhff4fa772017-07-10 12:07:53 +00003134 /* Parse the filename/URI argument
3135 **
3136 ** Only allow sensible combinations of bits in the flags argument.
3137 ** Throw an error if any non-sense combination is used. If we
3138 ** do not block illegal combinations here, it could trigger
3139 ** assert() statements in deeper layers. Sensible combinations
3140 ** are:
3141 **
3142 ** 1: SQLITE_OPEN_READONLY
3143 ** 2: SQLITE_OPEN_READWRITE
3144 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3145 */
dan19432992011-05-10 18:39:10 +00003146 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003147 assert( SQLITE_OPEN_READONLY == 0x01 );
3148 assert( SQLITE_OPEN_READWRITE == 0x02 );
3149 assert( SQLITE_OPEN_CREATE == 0x04 );
3150 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3151 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3152 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3153 if( ((1<<(flags&7)) & 0x46)==0 ){
3154 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3155 }else{
3156 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3157 }
dancd74b612011-04-22 19:37:32 +00003158 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003159 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003160 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003161 sqlite3_free(zErrMsg);
3162 goto opendb_out;
3163 }
3164
danielk19774ad17132004-05-21 01:47:26 +00003165 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003166 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003167 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003168 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003169 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003170 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003171 }
drh13f40da2014-08-22 18:00:11 +00003172 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003173 goto opendb_out;
3174 }
dan0235a032014-12-08 20:20:16 +00003175 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003176 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00003177 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00003178 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003179 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003180
drhe872d512016-02-22 13:23:16 +00003181 /* The default safety_level for the main database is FULL; for the temp
3182 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003183 */
drh69c33822016-08-18 14:33:11 +00003184 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003185 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003186 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003187 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003188
danielk1977832a58a2007-06-22 15:21:15 +00003189 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003190 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003191 goto opendb_out;
3192 }
3193
danielk19778e227872004-06-07 07:52:17 +00003194 /* Register all built-in functions, but do not attempt to read the
3195 ** database schema yet. This is delayed until the first time the database
3196 ** is accessed.
3197 */
drh13f40da2014-08-22 18:00:11 +00003198 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003199 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003200 rc = sqlite3_errcode(db);
3201
3202#ifdef SQLITE_ENABLE_FTS5
3203 /* Register any built-in FTS5 module before loading the automatic
3204 ** extensions. This allows automatic extensions to register FTS5
3205 ** tokenizers and auxiliary functions. */
3206 if( !db->mallocFailed && rc==SQLITE_OK ){
3207 rc = sqlite3Fts5Init(db);
3208 }
3209#endif
danielk19774ad17132004-05-21 01:47:26 +00003210
drh1409be62006-08-23 20:07:20 +00003211 /* Load automatic extensions - extensions that have been registered
3212 ** using the sqlite3_automatic_extension() API.
3213 */
drhe5077c12011-12-13 04:08:36 +00003214 if( rc==SQLITE_OK ){
3215 sqlite3AutoLoadExtensions(db);
3216 rc = sqlite3_errcode(db);
3217 if( rc!=SQLITE_OK ){
3218 goto opendb_out;
3219 }
danielk1977832a58a2007-06-22 15:21:15 +00003220 }
drh1409be62006-08-23 20:07:20 +00003221
drhaa29c132006-09-02 13:58:06 +00003222#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00003223 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003224 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003225 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003226 }
3227#endif
3228
shessa26cf572006-10-19 20:27:58 +00003229#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003230 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003231 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003232 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003233 }
3234#endif
3235
drh50065652015-10-08 19:29:18 +00003236#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003237 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003238 rc = sqlite3Fts3Init(db);
3239 }
3240#endif
3241
dan21540ae2017-12-08 16:23:38 +00003242#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
drh17435752007-08-16 04:30:38 +00003243 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003244 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003245 }
3246#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003247
3248#ifdef SQLITE_ENABLE_RTREE
3249 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003250 rc = sqlite3RtreeInit(db);
3251 }
3252#endif
3253
drha43c8c82017-10-11 13:48:11 +00003254#ifdef SQLITE_ENABLE_DBPAGE_VTAB
3255 if( !db->mallocFailed && rc==SQLITE_OK){
3256 rc = sqlite3DbpageRegister(db);
3257 }
3258#endif
3259
drha3ab9d02015-05-04 20:25:05 +00003260#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3261 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003262 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003263 }
3264#endif
3265
drh2f20e132015-09-26 17:44:59 +00003266#ifdef SQLITE_ENABLE_JSON1
3267 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003268 rc = sqlite3Json1Init(db);
3269 }
3270#endif
3271
drhc6603af2017-06-29 14:33:51 +00003272#ifdef SQLITE_ENABLE_STMTVTAB
drhf00f5302017-06-28 15:47:29 +00003273 if( !db->mallocFailed && rc==SQLITE_OK){
drhc6603af2017-06-29 14:33:51 +00003274 rc = sqlite3StmtVtabInit(db);
drhf00f5302017-06-28 15:47:29 +00003275 }
3276#endif
3277
drh8fd5bd32007-04-02 16:40:37 +00003278 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3279 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3280 ** mode. Doing nothing at all also makes NORMAL the default.
3281 */
3282#ifdef SQLITE_DEFAULT_LOCKING_MODE
3283 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3284 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3285 SQLITE_DEFAULT_LOCKING_MODE);
3286#endif
3287
drh13f40da2014-08-22 18:00:11 +00003288 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003289
drh633e6d52008-07-28 19:34:53 +00003290 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003291 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3292 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003293
dan5a299f92010-05-03 11:05:08 +00003294 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003295
danielk19774ad17132004-05-21 01:47:26 +00003296opendb_out:
drhafc91042008-02-21 02:09:45 +00003297 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003298 assert( db->mutex!=0 || isThreadsafe==0
3299 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003300 sqlite3_mutex_leave(db->mutex);
3301 }
danielk197759633ae2008-08-27 19:01:57 +00003302 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003303 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003304 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003305 sqlite3_close(db);
3306 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003307 }else if( rc!=SQLITE_OK ){
3308 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003309 }
danielk19774ad17132004-05-21 01:47:26 +00003310 *ppDb = db;
danac455932012-11-26 19:50:41 +00003311#ifdef SQLITE_ENABLE_SQLLOG
3312 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003313 /* Opening a db handle. Fourth parameter is passed 0. */
3314 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3315 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003316 }
3317#endif
drh46e6ea02015-10-26 14:41:35 +00003318#if defined(SQLITE_HAS_CODEC)
drhe5989722019-02-02 15:59:49 +00003319 if( rc==SQLITE_OK ) sqlite3CodecQueryParameters(db, 0, zOpen);
drh46e6ea02015-10-26 14:41:35 +00003320#endif
drh095fb472016-01-16 03:16:19 +00003321 sqlite3_free(zOpen);
drh597d2b62015-06-30 03:13:47 +00003322 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003323}
3324
drhe5989722019-02-02 15:59:49 +00003325
danielk19774ad17132004-05-21 01:47:26 +00003326/*
3327** Open a new database handle.
3328*/
danielk197780290862004-05-22 09:21:21 +00003329int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003330 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003331 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003332){
drh605264d2007-08-21 15:13:19 +00003333 return openDatabase(zFilename, ppDb,
3334 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3335}
3336int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003337 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003338 sqlite3 **ppDb, /* OUT: SQLite db handle */
3339 int flags, /* Flags */
3340 const char *zVfs /* Name of VFS module to use */
3341){
drh522c26f2011-05-07 14:40:29 +00003342 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003343}
3344
drh6c626082004-11-14 21:56:29 +00003345#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003346/*
3347** Open a new database handle.
3348*/
3349int sqlite3_open16(
3350 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003351 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003352){
danielk1977bfd6cce2004-06-18 04:24:54 +00003353 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003354 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003355 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003356
drh9ca95732014-10-24 00:35:58 +00003357#ifdef SQLITE_ENABLE_API_ARMOR
3358 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3359#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003360 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003361#ifndef SQLITE_OMIT_AUTOINIT
3362 rc = sqlite3_initialize();
3363 if( rc ) return rc;
3364#endif
drh9ca95732014-10-24 00:35:58 +00003365 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003366 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003367 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3368 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003369 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003370 rc = openDatabase(zFilename8, ppDb,
3371 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003372 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003373 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003374 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003375 }
drh40257ff2008-06-13 18:24:27 +00003376 }else{
mistachkinfad30392016-02-13 23:43:46 +00003377 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003378 }
danielk19777ddad962005-12-12 06:53:03 +00003379 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003380
drh597d2b62015-06-30 03:13:47 +00003381 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003382}
drh6c626082004-11-14 21:56:29 +00003383#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003384
danielk1977106bb232004-05-21 10:08:53 +00003385/*
danielk1977d8123362004-06-12 09:25:12 +00003386** Register a new collation sequence with the database handle db.
3387*/
danielk19770202b292004-06-09 09:55:16 +00003388int sqlite3_create_collation(
3389 sqlite3* db,
3390 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003391 int enc,
danielk19770202b292004-06-09 09:55:16 +00003392 void* pCtx,
3393 int(*xCompare)(void*,int,const void*,int,const void*)
3394){
drh4f81bbb2014-10-23 01:01:26 +00003395 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003396}
3397
3398/*
3399** Register a new collation sequence with the database handle db.
3400*/
danielk1977a393c032007-05-07 14:58:53 +00003401int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003402 sqlite3* db,
3403 const char *zName,
3404 int enc,
3405 void* pCtx,
3406 int(*xCompare)(void*,int,const void*,int,const void*),
3407 void(*xDel)(void*)
3408){
3409 int rc;
drh9ca95732014-10-24 00:35:58 +00003410
3411#ifdef SQLITE_ENABLE_API_ARMOR
3412 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3413#endif
drhe30f4422007-08-21 16:15:55 +00003414 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003415 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003416 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003417 rc = sqlite3ApiExit(db, rc);
3418 sqlite3_mutex_leave(db->mutex);
3419 return rc;
danielk19770202b292004-06-09 09:55:16 +00003420}
3421
drh6c626082004-11-14 21:56:29 +00003422#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003423/*
3424** Register a new collation sequence with the database handle db.
3425*/
danielk19770202b292004-06-09 09:55:16 +00003426int sqlite3_create_collation16(
3427 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003428 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003429 int enc,
danielk19770202b292004-06-09 09:55:16 +00003430 void* pCtx,
3431 int(*xCompare)(void*,int,const void*,int,const void*)
3432){
danielk19779a30cf62006-01-18 04:26:07 +00003433 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003434 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003435
3436#ifdef SQLITE_ENABLE_API_ARMOR
3437 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3438#endif
drhe30f4422007-08-21 16:15:55 +00003439 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003440 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003441 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003442 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003443 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003444 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003445 }
drhe30f4422007-08-21 16:15:55 +00003446 rc = sqlite3ApiExit(db, rc);
3447 sqlite3_mutex_leave(db->mutex);
3448 return rc;
danielk19770202b292004-06-09 09:55:16 +00003449}
drh6c626082004-11-14 21:56:29 +00003450#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003451
danielk1977d8123362004-06-12 09:25:12 +00003452/*
3453** Register a collation sequence factory callback with the database handle
3454** db. Replace any previously installed collation sequence factory.
3455*/
danielk19777cedc8d2004-06-10 10:50:08 +00003456int sqlite3_collation_needed(
3457 sqlite3 *db,
3458 void *pCollNeededArg,
3459 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3460){
drh9ca95732014-10-24 00:35:58 +00003461#ifdef SQLITE_ENABLE_API_ARMOR
3462 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3463#endif
drhe30f4422007-08-21 16:15:55 +00003464 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003465 db->xCollNeeded = xCollNeeded;
3466 db->xCollNeeded16 = 0;
3467 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003468 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003469 return SQLITE_OK;
3470}
danielk1977d8123362004-06-12 09:25:12 +00003471
drh6c626082004-11-14 21:56:29 +00003472#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003473/*
3474** Register a collation sequence factory callback with the database handle
3475** db. Replace any previously installed collation sequence factory.
3476*/
danielk19777cedc8d2004-06-10 10:50:08 +00003477int sqlite3_collation_needed16(
3478 sqlite3 *db,
3479 void *pCollNeededArg,
3480 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3481){
drh9ca95732014-10-24 00:35:58 +00003482#ifdef SQLITE_ENABLE_API_ARMOR
3483 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3484#endif
drhe30f4422007-08-21 16:15:55 +00003485 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003486 db->xCollNeeded = 0;
3487 db->xCollNeeded16 = xCollNeeded16;
3488 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003489 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003490 return SQLITE_OK;
3491}
drh6c626082004-11-14 21:56:29 +00003492#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003493
shaneeec556d2008-10-12 00:27:53 +00003494#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003495/*
danielk19777ddad962005-12-12 06:53:03 +00003496** This function is now an anachronism. It used to be used to recover from a
3497** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003498*/
drh7d97efb2007-10-12 19:35:48 +00003499int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003500 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003501}
3502#endif
drh3e1d8e62005-05-26 16:23:34 +00003503
3504/*
3505** Test to see whether or not the database connection is in autocommit
3506** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3507** by default. Autocommit is disabled by a BEGIN statement and reenabled
3508** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003509*/
3510int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003511#ifdef SQLITE_ENABLE_API_ARMOR
3512 if( !sqlite3SafetyCheckOk(db) ){
3513 (void)SQLITE_MISUSE_BKPT;
3514 return 0;
3515 }
3516#endif
drh3e1d8e62005-05-26 16:23:34 +00003517 return db->autoCommit;
3518}
drh49285702005-09-17 15:20:26 +00003519
drh49285702005-09-17 15:20:26 +00003520/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003521** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003522** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003523** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003524**
3525** 1. Serve as a convenient place to set a breakpoint in a debugger
3526** to detect when version error conditions occurs.
3527**
3528** 2. Invoke sqlite3_log() to provide the source code location where
3529** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003530*/
daneebf2f52017-11-18 17:30:08 +00003531int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003532 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3533 zType, lineno, 20+sqlite3_sourceid());
3534 return iErr;
3535}
drh9978c972010-02-23 17:36:32 +00003536int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003537 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003538 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003539}
drh9978c972010-02-23 17:36:32 +00003540int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003541 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003542 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003543}
3544int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003545 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003546 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003547}
drh32c49902016-02-15 18:15:15 +00003548#ifdef SQLITE_DEBUG
drhcc97ca42017-06-07 22:32:59 +00003549int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3550 char zMsg[100];
3551 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3552 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003553 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003554}
mistachkinfad30392016-02-13 23:43:46 +00003555int sqlite3NomemError(int lineno){
3556 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003557 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003558}
3559int sqlite3IoerrnomemError(int lineno){
3560 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003561 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003562}
drh32c49902016-02-15 18:15:15 +00003563#endif
drh7c1817e2006-01-10 13:58:48 +00003564
shaneeec556d2008-10-12 00:27:53 +00003565#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003566/*
3567** This is a convenience routine that makes sure that all thread-specific
3568** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003569**
3570** SQLite no longer uses thread-specific data so this routine is now a
3571** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003572*/
3573void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003574}
shaneeec556d2008-10-12 00:27:53 +00003575#endif
danielk1977deb802c2006-02-09 13:43:28 +00003576
3577/*
3578** Return meta information about a specific column of a database table.
3579** See comment in sqlite3.h (sqlite.h.in) for details.
3580*/
danielk1977deb802c2006-02-09 13:43:28 +00003581int sqlite3_table_column_metadata(
3582 sqlite3 *db, /* Connection handle */
3583 const char *zDbName, /* Database name or NULL */
3584 const char *zTableName, /* Table name */
3585 const char *zColumnName, /* Column name */
3586 char const **pzDataType, /* OUTPUT: Declared data type */
3587 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3588 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3589 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003590 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003591){
3592 int rc;
3593 char *zErrMsg = 0;
3594 Table *pTab = 0;
3595 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003596 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003597 char const *zDataType = 0;
3598 char const *zCollSeq = 0;
3599 int notnull = 0;
3600 int primarykey = 0;
3601 int autoinc = 0;
3602
drh96c707a2015-02-13 16:36:14 +00003603
3604#ifdef SQLITE_ENABLE_API_ARMOR
3605 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3606 return SQLITE_MISUSE_BKPT;
3607 }
3608#endif
3609
danielk1977deb802c2006-02-09 13:43:28 +00003610 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003611 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003612 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003613 rc = sqlite3Init(db, &zErrMsg);
3614 if( SQLITE_OK!=rc ){
3615 goto error_out;
3616 }
3617
3618 /* Locate the table in question */
3619 pTab = sqlite3FindTable(db, zTableName, zDbName);
3620 if( !pTab || pTab->pSelect ){
3621 pTab = 0;
3622 goto error_out;
3623 }
3624
3625 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003626 if( zColumnName==0 ){
3627 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003628 }else{
3629 for(iCol=0; iCol<pTab->nCol; iCol++){
3630 pCol = &pTab->aCol[iCol];
3631 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3632 break;
3633 }
3634 }
3635 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003636 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3637 iCol = pTab->iPKey;
3638 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3639 }else{
3640 pTab = 0;
3641 goto error_out;
3642 }
danielk1977deb802c2006-02-09 13:43:28 +00003643 }
3644 }
3645
3646 /* The following block stores the meta information that will be returned
3647 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3648 ** and autoinc. At this point there are two possibilities:
3649 **
3650 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3651 ** and there is no explicitly declared IPK column.
3652 **
3653 ** 2. The table is not a view and the column name identified an
3654 ** explicitly declared column. Copy meta information from *pCol.
3655 */
3656 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003657 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003658 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003659 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003660 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003661 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003662 }else{
3663 zDataType = "INTEGER";
3664 primarykey = 1;
3665 }
3666 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003667 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003668 }
3669
3670error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003671 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003672
3673 /* Whether the function call succeeded or failed, set the output parameters
3674 ** to whatever their local counterparts contain. If an error did occur,
3675 ** this has the effect of zeroing all output parameters.
3676 */
3677 if( pzDataType ) *pzDataType = zDataType;
3678 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3679 if( pNotNull ) *pNotNull = notnull;
3680 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3681 if( pAutoinc ) *pAutoinc = autoinc;
3682
3683 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003684 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003685 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003686 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003687 rc = SQLITE_ERROR;
3688 }
drh13f40da2014-08-22 18:00:11 +00003689 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003690 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003691 rc = sqlite3ApiExit(db, rc);
3692 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003693 return rc;
3694}
3695
3696/*
3697** Sleep for a little while. Return the amount of time slept.
3698*/
3699int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003700 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003701 int rc;
drhd677b3d2007-08-20 22:48:41 +00003702 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003703 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003704
3705 /* This function works in milliseconds, but the underlying OsSleep()
3706 ** API uses microseconds. Hence the 1000's.
3707 */
drhe30f4422007-08-21 16:15:55 +00003708 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003709 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003710}
drh4ac285a2006-09-15 07:28:50 +00003711
3712/*
3713** Enable or disable the extended result codes.
3714*/
3715int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003716#ifdef SQLITE_ENABLE_API_ARMOR
3717 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3718#endif
drhe30f4422007-08-21 16:15:55 +00003719 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003720 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003721 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003722 return SQLITE_OK;
3723}
drhcc6bb3e2007-08-31 16:11:35 +00003724
3725/*
3726** Invoke the xFileControl method on a particular database.
3727*/
3728int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3729 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003730 Btree *pBtree;
3731
drh9ca95732014-10-24 00:35:58 +00003732#ifdef SQLITE_ENABLE_API_ARMOR
3733 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3734#endif
drhcc6bb3e2007-08-31 16:11:35 +00003735 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003736 pBtree = sqlite3DbNameToBtree(db, zDbName);
3737 if( pBtree ){
3738 Pager *pPager;
3739 sqlite3_file *fd;
3740 sqlite3BtreeEnter(pBtree);
3741 pPager = sqlite3BtreePager(pBtree);
3742 assert( pPager!=0 );
3743 fd = sqlite3PagerFile(pPager);
3744 assert( fd!=0 );
3745 if( op==SQLITE_FCNTL_FILE_POINTER ){
3746 *(sqlite3_file**)pArg = fd;
3747 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003748 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3749 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3750 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003751 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3752 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3753 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003754 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3755 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3756 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003757 }else{
drhafb39a42018-03-29 13:47:01 +00003758 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003759 }
drh421377e2012-03-15 21:28:54 +00003760 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003761 }
3762 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003763 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003764}
drhed13d982008-01-31 14:43:24 +00003765
3766/*
3767** Interface to the testing logic.
3768*/
3769int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003770 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003771#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003772 UNUSED_PARAMETER(op);
3773#else
drh2fa18682008-03-19 14:15:34 +00003774 va_list ap;
drhed13d982008-01-31 14:43:24 +00003775 va_start(ap, op);
3776 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003777
3778 /*
drh984bfaa2008-03-19 16:08:53 +00003779 ** Save the current state of the PRNG.
3780 */
drh2fa18682008-03-19 14:15:34 +00003781 case SQLITE_TESTCTRL_PRNG_SAVE: {
3782 sqlite3PrngSaveState();
3783 break;
3784 }
drh984bfaa2008-03-19 16:08:53 +00003785
3786 /*
3787 ** Restore the state of the PRNG to the last state saved using
3788 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3789 ** this verb acts like PRNG_RESET.
3790 */
drh2fa18682008-03-19 14:15:34 +00003791 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3792 sqlite3PrngRestoreState();
3793 break;
3794 }
drh984bfaa2008-03-19 16:08:53 +00003795
3796 /*
3797 ** Reset the PRNG back to its uninitialized state. The next call
3798 ** to sqlite3_randomness() will reseed the PRNG using a single call
3799 ** to the xRandomness method of the default VFS.
3800 */
drh2fa18682008-03-19 14:15:34 +00003801 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003802 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003803 break;
3804 }
drh3088d592008-03-21 16:45:47 +00003805
3806 /*
3807 ** sqlite3_test_control(BITVEC_TEST, size, program)
3808 **
3809 ** Run a test against a Bitvec object of size. The program argument
3810 ** is an array of integers that defines the test. Return -1 on a
3811 ** memory allocation error, 0 on success, or non-zero for an error.
3812 ** See the sqlite3BitvecBuiltinTest() for additional information.
3813 */
3814 case SQLITE_TESTCTRL_BITVEC_TEST: {
3815 int sz = va_arg(ap, int);
3816 int *aProg = va_arg(ap, int*);
3817 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3818 break;
3819 }
danielk19772d1d86f2008-06-20 14:59:51 +00003820
3821 /*
drhc007f612014-05-16 14:17:01 +00003822 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3823 **
3824 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3825 ** if xCallback is not NULL.
3826 **
3827 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3828 ** is called immediately after installing the new callback and the return
3829 ** value from sqlite3FaultSim(0) becomes the return from
3830 ** sqlite3_test_control().
3831 */
3832 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003833 /* MSVC is picky about pulling func ptrs from va lists.
3834 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003835 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003836 */
3837 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003838 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003839 rc = sqlite3FaultSim(0);
3840 break;
3841 }
3842
3843 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003844 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3845 **
3846 ** Register hooks to call to indicate which malloc() failures
3847 ** are benign.
3848 */
3849 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003850 typedef void (*void_function)(void);
3851 void_function xBenignBegin;
3852 void_function xBenignEnd;
3853 xBenignBegin = va_arg(ap, void_function);
3854 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003855 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3856 break;
3857 }
drhc7a3bb92009-02-05 16:31:45 +00003858
3859 /*
drhf3af63f2009-05-09 18:59:42 +00003860 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003861 **
3862 ** Set the PENDING byte to the value in the argument, if X>0.
3863 ** Make no changes if X==0. Return the value of the pending byte
3864 ** as it existing before this routine was called.
3865 **
3866 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3867 ** an incompatible database file format. Changing the PENDING byte
3868 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003869 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003870 */
3871 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003872 rc = PENDING_BYTE;
3873#ifndef SQLITE_OMIT_WSD
3874 {
3875 unsigned int newVal = va_arg(ap, unsigned int);
3876 if( newVal ) sqlite3PendingByte = newVal;
3877 }
3878#endif
drhc7a3bb92009-02-05 16:31:45 +00003879 break;
3880 }
drhf3af63f2009-05-09 18:59:42 +00003881
3882 /*
3883 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3884 **
3885 ** This action provides a run-time test to see whether or not
3886 ** assert() was enabled at compile-time. If X is true and assert()
3887 ** is enabled, then the return value is true. If X is true and
3888 ** assert() is disabled, then the return value is zero. If X is
3889 ** false and assert() is enabled, then the assertion fires and the
3890 ** process aborts. If X is false and assert() is disabled, then the
3891 ** return value is zero.
3892 */
3893 case SQLITE_TESTCTRL_ASSERT: {
3894 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003895 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003896 rc = x;
3897 break;
3898 }
3899
3900
3901 /*
3902 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3903 **
3904 ** This action provides a run-time test to see how the ALWAYS and
3905 ** NEVER macros were defined at compile-time.
3906 **
drhce2c4822017-10-03 17:17:34 +00003907 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00003908 **
3909 ** The recommended test is X==2. If the return value is 2, that means
3910 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3911 ** default setting. If the return value is 1, then ALWAYS() is either
3912 ** hard-coded to true or else it asserts if its argument is false.
3913 ** The first behavior (hard-coded to true) is the case if
3914 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3915 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3916 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3917 **
3918 ** The run-time test procedure might look something like this:
3919 **
3920 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3921 ** // ALWAYS() and NEVER() are no-op pass-through macros
3922 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3923 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3924 ** }else{
3925 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3926 ** }
3927 */
3928 case SQLITE_TESTCTRL_ALWAYS: {
3929 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00003930 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00003931 break;
3932 }
drhc046e3e2009-07-15 11:26:44 +00003933
drh2cf4acb2014-04-18 00:06:02 +00003934 /*
3935 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3936 **
3937 ** The integer returned reveals the byte-order of the computer on which
3938 ** SQLite is running:
3939 **
3940 ** 1 big-endian, determined at run-time
3941 ** 10 little-endian, determined at run-time
3942 ** 432101 big-endian, determined at compile-time
3943 ** 123410 little-endian, determined at compile-time
3944 */
3945 case SQLITE_TESTCTRL_BYTEORDER: {
3946 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3947 break;
3948 }
3949
drhc046e3e2009-07-15 11:26:44 +00003950 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3951 **
3952 ** Set the nReserve size to N for the main database on the database
3953 ** connection db.
3954 */
3955 case SQLITE_TESTCTRL_RESERVE: {
3956 sqlite3 *db = va_arg(ap, sqlite3*);
3957 int x = va_arg(ap,int);
3958 sqlite3_mutex_enter(db->mutex);
3959 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3960 sqlite3_mutex_leave(db->mutex);
3961 break;
3962 }
3963
drh07096f62009-12-22 23:52:32 +00003964 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3965 **
3966 ** Enable or disable various optimizations for testing purposes. The
3967 ** argument N is a bitmask of optimizations to be disabled. For normal
3968 ** operation N should be 0. The idea is that a test program (like the
3969 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3970 ** with various optimizations disabled to verify that the same answer
3971 ** is obtained in every case.
3972 */
3973 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3974 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003975 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003976 break;
3977 }
3978
danc17d6962011-06-21 12:47:30 +00003979 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3980 **
drheea8eb62018-11-26 18:09:15 +00003981 ** If parameter onoff is non-zero, subsequent calls to localtime()
3982 ** and its variants fail. If onoff is zero, undo this setting.
danc17d6962011-06-21 12:47:30 +00003983 */
3984 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3985 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3986 break;
3987 }
3988
drheea8eb62018-11-26 18:09:15 +00003989 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCS, int onoff);
3990 **
3991 ** If parameter onoff is non-zero, internal-use-only SQL functions
3992 ** are visible to ordinary SQL. This is useful for testing but is
3993 ** unsafe because invalid parameters to those internal-use-only functions
3994 ** can result in crashes or segfaults.
3995 */
3996 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
3997 sqlite3GlobalConfig.bInternalFunctions = va_arg(ap, int);
3998 break;
3999 }
4000
drh09fe6142013-11-29 15:06:27 +00004001 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4002 **
4003 ** Set or clear a flag that indicates that the database file is always well-
4004 ** formed and never corrupt. This flag is clear by default, indicating that
4005 ** database files might have arbitrary corruption. Setting the flag during
4006 ** testing causes certain assert() statements in the code to be activated
4007 ** that demonstrat invariants on well-formed database files.
4008 */
4009 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00004010 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00004011 break;
4012 }
4013
drh9e5eb9c2016-09-18 16:08:10 +00004014 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00004015 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004016 ** too big to test in a reasonable amount of time, so this control is
4017 ** provided to set a small and easily reachable reset value.
4018 */
4019 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4020 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4021 break;
4022 }
drh688852a2014-02-17 22:40:43 +00004023
4024 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4025 **
4026 ** Set the VDBE coverage callback function to xCallback with context
4027 ** pointer ptr.
4028 */
4029 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4030#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00004031 typedef void (*branch_callback)(void*,unsigned int,
4032 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00004033 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4034 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4035#endif
4036 break;
4037 }
4038
dan8930c2a2014-04-03 16:25:29 +00004039 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4040 case SQLITE_TESTCTRL_SORTER_MMAP: {
4041 sqlite3 *db = va_arg(ap, sqlite3*);
4042 db->nMaxSorterMmap = va_arg(ap, int);
4043 break;
4044 }
4045
drh43cfc232014-07-29 14:09:21 +00004046 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4047 **
4048 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4049 ** not.
4050 */
4051 case SQLITE_TESTCTRL_ISINIT: {
4052 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4053 break;
4054 }
drh8964b342015-01-29 17:54:52 +00004055
drh3ba689d2015-03-03 14:00:11 +00004056 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004057 **
drh1ffede82015-01-30 20:59:27 +00004058 ** This test control is used to create imposter tables. "db" is a pointer
4059 ** to the database connection. dbName is the database name (ex: "main" or
4060 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4061 ** or off. "tnum" is the root page of the b-tree to which the imposter
4062 ** table should connect.
4063 **
4064 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004065 ** run a single CREATE TABLE statement to construct the imposter table in
4066 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004067 **
4068 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4069 ** the schema to be reparsed the next time it is needed. This has the
4070 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004071 */
drh1ffede82015-01-30 20:59:27 +00004072 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004073 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004074 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004075 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4076 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004077 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004078 if( db->init.busy==0 && db->init.newTnum>0 ){
4079 sqlite3ResetAllSchemasOfConnection(db);
4080 }
drh8fb15e32015-02-04 20:56:49 +00004081 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004082 break;
4083 }
drh0d9de992017-12-26 18:04:23 +00004084
4085#if defined(YYCOVERAGE)
4086 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4087 **
4088 ** This test control (only available when SQLite is compiled with
4089 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4090 ** state/lookahead combinations in the parser state machine
4091 ** which are never exercised. If any state is missed, make the
4092 ** return code SQLITE_ERROR.
4093 */
4094 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4095 FILE *out = va_arg(ap, FILE*);
4096 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4097 break;
4098 }
4099#endif /* defined(YYCOVERAGE) */
drh0c8f4032019-05-03 21:17:28 +00004100
4101 /* sqlite3_test_control(SQLITE_TESTCTRL_RESULT_INTREAL, sqlite3_context*);
4102 **
4103 ** This test-control causes the most recent sqlite3_result_int64() value
4104 ** to be interpreted as a MEM_IntReal instead of as an MEM_Int. Normally,
4105 ** MEM_IntReal values only arise during an INSERT operation of integer
4106 ** values into a REAL column, so they can be challenging to test. This
4107 ** test-control enables us to write an intreal() SQL function that can
4108 ** inject an intreal() value at arbitrary places in an SQL statement,
4109 ** for testing purposes.
4110 */
4111 case SQLITE_TESTCTRL_RESULT_INTREAL: {
4112 sqlite3_context *pCtx = va_arg(ap, sqlite3_context*);
4113 sqlite3ResultIntReal(pCtx);
4114 break;
4115 }
drhed13d982008-01-31 14:43:24 +00004116 }
4117 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004118#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004119 return rc;
drhed13d982008-01-31 14:43:24 +00004120}
drhcc487d12011-05-17 18:53:08 +00004121
4122/*
4123** This is a utility routine, useful to VFS implementations, that checks
4124** to see if a database file was a URI that contained a specific query
4125** parameter, and if so obtains the value of the query parameter.
4126**
4127** The zFilename argument is the filename pointer passed into the xOpen()
4128** method of a VFS implementation. The zParam argument is the name of the
4129** query parameter we seek. This routine returns the value of the zParam
4130** parameter if it exists. If the parameter does not exist, this routine
4131** returns a NULL pointer.
4132*/
4133const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004134 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00004135 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004136 while( zFilename[0] ){
4137 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00004138 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004139 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00004140 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004141 }
4142 return 0;
4143}
drh283829c2011-11-17 00:56:20 +00004144
4145/*
drh92913722011-12-23 00:07:33 +00004146** Return a boolean value for a query parameter.
4147*/
4148int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4149 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004150 bDflt = bDflt!=0;
4151 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004152}
4153
4154/*
4155** Return a 64-bit integer value for a query parameter.
4156*/
4157sqlite3_int64 sqlite3_uri_int64(
4158 const char *zFilename, /* Filename as passed to xOpen */
4159 const char *zParam, /* URI parameter sought */
4160 sqlite3_int64 bDflt /* return if parameter is missing */
4161){
4162 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4163 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004164 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004165 bDflt = v;
4166 }
4167 return bDflt;
4168}
4169
4170/*
drh421377e2012-03-15 21:28:54 +00004171** Return the Btree pointer identified by zDbName. Return NULL if not found.
4172*/
4173Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004174 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4175 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004176}
4177
4178/*
drh283829c2011-11-17 00:56:20 +00004179** Return the filename of the database associated with a database
4180** connection.
4181*/
4182const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004183 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004184#ifdef SQLITE_ENABLE_API_ARMOR
4185 if( !sqlite3SafetyCheckOk(db) ){
4186 (void)SQLITE_MISUSE_BKPT;
4187 return 0;
4188 }
4189#endif
mistachkincd54bab2014-12-20 21:14:14 +00004190 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004191 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4192}
4193
4194/*
4195** Return 1 if database is read-only or 0 if read/write. Return -1 if
4196** no such database exists.
4197*/
4198int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004199 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004200#ifdef SQLITE_ENABLE_API_ARMOR
4201 if( !sqlite3SafetyCheckOk(db) ){
4202 (void)SQLITE_MISUSE_BKPT;
4203 return -1;
4204 }
4205#endif
mistachkincd54bab2014-12-20 21:14:14 +00004206 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004207 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004208}
danfc1acf32015-12-05 20:51:54 +00004209
4210#ifdef SQLITE_ENABLE_SNAPSHOT
4211/*
4212** Obtain a snapshot handle for the snapshot of database zDb currently
4213** being read by handle db.
4214*/
4215int sqlite3_snapshot_get(
4216 sqlite3 *db,
4217 const char *zDb,
4218 sqlite3_snapshot **ppSnapshot
4219){
4220 int rc = SQLITE_ERROR;
4221#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004222
4223#ifdef SQLITE_ENABLE_API_ARMOR
4224 if( !sqlite3SafetyCheckOk(db) ){
4225 return SQLITE_MISUSE_BKPT;
4226 }
4227#endif
4228 sqlite3_mutex_enter(db->mutex);
4229
danedace5d2016-11-18 18:43:39 +00004230 if( db->autoCommit==0 ){
4231 int iDb = sqlite3FindDbName(db, zDb);
4232 if( iDb==0 || iDb>1 ){
4233 Btree *pBt = db->aDb[iDb].pBt;
4234 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004235 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004236 if( rc==SQLITE_OK ){
4237 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4238 }
dan7116dc62015-12-10 20:03:08 +00004239 }
danfc1acf32015-12-05 20:51:54 +00004240 }
4241 }
4242
4243 sqlite3_mutex_leave(db->mutex);
4244#endif /* SQLITE_OMIT_WAL */
4245 return rc;
4246}
4247
4248/*
4249** Open a read-transaction on the snapshot idendified by pSnapshot.
4250*/
4251int sqlite3_snapshot_open(
4252 sqlite3 *db,
4253 const char *zDb,
4254 sqlite3_snapshot *pSnapshot
4255){
4256 int rc = SQLITE_ERROR;
4257#ifndef SQLITE_OMIT_WAL
4258
4259#ifdef SQLITE_ENABLE_API_ARMOR
4260 if( !sqlite3SafetyCheckOk(db) ){
4261 return SQLITE_MISUSE_BKPT;
4262 }
4263#endif
4264 sqlite3_mutex_enter(db->mutex);
4265 if( db->autoCommit==0 ){
4266 int iDb;
4267 iDb = sqlite3FindDbName(db, zDb);
4268 if( iDb==0 || iDb>1 ){
4269 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004270 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4271 Pager *pPager = sqlite3BtreePager(pBt);
4272 int bUnlock = 0;
4273 if( sqlite3BtreeIsInReadTrans(pBt) ){
4274 if( db->nVdbeActive==0 ){
4275 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4276 if( rc==SQLITE_OK ){
4277 bUnlock = 1;
4278 rc = sqlite3BtreeCommit(pBt);
4279 }
4280 }
4281 }else{
4282 rc = SQLITE_OK;
4283 }
4284 if( rc==SQLITE_OK ){
4285 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4286 }
danfc1acf32015-12-05 20:51:54 +00004287 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004288 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danfa3d4c12018-08-06 17:12:36 +00004289 sqlite3PagerSnapshotOpen(pPager, 0);
4290 }
4291 if( bUnlock ){
4292 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004293 }
4294 }
4295 }
4296 }
4297
4298 sqlite3_mutex_leave(db->mutex);
4299#endif /* SQLITE_OMIT_WAL */
4300 return rc;
4301}
4302
4303/*
dan11584982016-11-18 20:49:43 +00004304** Recover as many snapshots as possible from the wal file associated with
4305** schema zDb of database db.
4306*/
4307int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4308 int rc = SQLITE_ERROR;
4309 int iDb;
4310#ifndef SQLITE_OMIT_WAL
4311
4312#ifdef SQLITE_ENABLE_API_ARMOR
4313 if( !sqlite3SafetyCheckOk(db) ){
4314 return SQLITE_MISUSE_BKPT;
4315 }
4316#endif
4317
4318 sqlite3_mutex_enter(db->mutex);
4319 iDb = sqlite3FindDbName(db, zDb);
4320 if( iDb==0 || iDb>1 ){
4321 Btree *pBt = db->aDb[iDb].pBt;
4322 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004323 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004324 if( rc==SQLITE_OK ){
4325 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4326 sqlite3BtreeCommit(pBt);
4327 }
dan11584982016-11-18 20:49:43 +00004328 }
4329 }
4330 sqlite3_mutex_leave(db->mutex);
4331#endif /* SQLITE_OMIT_WAL */
4332 return rc;
4333}
4334
4335/*
danfc1acf32015-12-05 20:51:54 +00004336** Free a snapshot handle obtained from sqlite3_snapshot_get().
4337*/
4338void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4339 sqlite3_free(pSnapshot);
4340}
4341#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004342
4343#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4344/*
4345** Given the name of a compile-time option, return true if that option
4346** was used and false if not.
4347**
4348** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4349** is not required for a match.
4350*/
4351int sqlite3_compileoption_used(const char *zOptName){
4352 int i, n;
4353 int nOpt;
4354 const char **azCompileOpt;
4355
4356#if SQLITE_ENABLE_API_ARMOR
4357 if( zOptName==0 ){
4358 (void)SQLITE_MISUSE_BKPT;
4359 return 0;
4360 }
4361#endif
4362
4363 azCompileOpt = sqlite3CompileOptions(&nOpt);
4364
4365 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4366 n = sqlite3Strlen30(zOptName);
4367
4368 /* Since nOpt is normally in single digits, a linear search is
4369 ** adequate. No need for a binary search. */
4370 for(i=0; i<nOpt; i++){
4371 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4372 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4373 ){
4374 return 1;
4375 }
4376 }
4377 return 0;
4378}
4379
4380/*
4381** Return the N-th compile-time option string. If N is out of range,
4382** return a NULL pointer.
4383*/
4384const char *sqlite3_compileoption_get(int N){
4385 int nOpt;
4386 const char **azCompileOpt;
4387 azCompileOpt = sqlite3CompileOptions(&nOpt);
4388 if( N>=0 && N<nOpt ){
4389 return azCompileOpt[N];
4390 }
4391 return 0;
4392}
4393#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */