blob: c40e6e877aa29ae6974050f807f107525c40e053 [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();
drh9dd55f52010-09-03 03:32:46 +0000708 pStart = sqlite3Malloc( sz*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 },
drhe83cafd2011-03-21 17:15:58 +0000846 };
drh58ad5802011-03-23 22:02:23 +0000847 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000848 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000849 for(i=0; i<ArraySize(aFlagOp); i++){
850 if( aFlagOp[i].op==op ){
851 int onoff = va_arg(ap, int);
852 int *pRes = va_arg(ap, int*);
drh70d5dfb2018-12-06 16:50:55 +0000853 u64 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000854 if( onoff>0 ){
855 db->flags |= aFlagOp[i].mask;
856 }else if( onoff==0 ){
drhd5b44d62018-12-06 17:06:02 +0000857 db->flags &= ~(u64)aFlagOp[i].mask;
drhe83cafd2011-03-21 17:15:58 +0000858 }
859 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000860 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000861 }
862 if( pRes ){
863 *pRes = (db->flags & aFlagOp[i].mask)!=0;
864 }
865 rc = SQLITE_OK;
866 break;
867 }
868 }
drh6480aad2008-08-01 16:31:14 +0000869 break;
870 }
drh633e6d52008-07-28 19:34:53 +0000871 }
872 va_end(ap);
873 return rc;
874}
875
drha16313e2007-03-30 11:29:32 +0000876
877/*
drh9b5adfa2008-01-20 23:19:56 +0000878** Return true if the buffer z[0..n-1] contains all spaces.
879*/
880static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000881 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000882 return n==0;
883}
884
885/*
drhd3d39e92004-05-20 22:16:29 +0000886** This is the default collating function named "BINARY" which is always
887** available.
drh9b5adfa2008-01-20 23:19:56 +0000888**
889** If the padFlag argument is not NULL then space padding at the end
890** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000891*/
danielk19772c336542005-01-13 02:14:23 +0000892static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000893 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000894 int nKey1, const void *pKey1,
895 int nKey2, const void *pKey2
896){
897 int rc, n;
898 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000899 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
900 ** strings byte by byte using the memcmp() function from the standard C
901 ** library. */
dan21766c02017-05-22 08:04:09 +0000902 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +0000903 rc = memcmp(pKey1, pKey2, n);
904 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000905 if( padFlag
906 && allSpaces(((char*)pKey1)+n, nKey1-n)
907 && allSpaces(((char*)pKey2)+n, nKey2-n)
908 ){
drh5e3b49b2014-11-20 19:22:26 +0000909 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
910 ** spaces at the end of either string do not change the result. In other
911 ** words, strings will compare equal to one another as long as they
912 ** differ only in the number of spaces at the end.
913 */
drh9b5adfa2008-01-20 23:19:56 +0000914 }else{
915 rc = nKey1 - nKey2;
916 }
drhd3d39e92004-05-20 22:16:29 +0000917 }
918 return rc;
919}
920
921/*
drhbcd15932018-07-27 18:12:40 +0000922** Return true if CollSeq is the default built-in BINARY.
923*/
924int sqlite3IsBinary(const CollSeq *p){
925 assert( p==0 || p->xCmp!=binCollFunc || p->pUser!=0
926 || strcmp(p->zName,"BINARY")==0 );
927 return p==0 || (p->xCmp==binCollFunc && p->pUser==0);
928}
929
930/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000931** Another built-in collating sequence: NOCASE.
932**
drhf7b54962013-05-28 12:11:54 +0000933** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000934** comparison". SQLite's knowledge of upper and lower case equivalents
935** extends only to the 26 characters used in the English language.
936**
937** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000938*/
939static int nocaseCollatingFunc(
940 void *NotUsed,
941 int nKey1, const void *pKey1,
942 int nKey2, const void *pKey2
943){
944 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000945 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000946 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000947 if( 0==r ){
948 r = nKey1-nKey2;
949 }
950 return r;
951}
952
953/*
drhaf9ff332002-01-16 21:00:27 +0000954** Return the ROWID of the most recent insert
955*/
drh9bb575f2004-09-06 17:24:11 +0000956sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000957#ifdef SQLITE_ENABLE_API_ARMOR
958 if( !sqlite3SafetyCheckOk(db) ){
959 (void)SQLITE_MISUSE_BKPT;
960 return 0;
961 }
962#endif
drhaf9ff332002-01-16 21:00:27 +0000963 return db->lastRowid;
964}
965
966/*
dan9c58b632017-02-27 14:52:48 +0000967** Set the value returned by the sqlite3_last_insert_rowid() API function.
968*/
969void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
970#ifdef SQLITE_ENABLE_API_ARMOR
971 if( !sqlite3SafetyCheckOk(db) ){
972 (void)SQLITE_MISUSE_BKPT;
973 return;
974 }
975#endif
976 sqlite3_mutex_enter(db->mutex);
977 db->lastRowid = iRowid;
978 sqlite3_mutex_leave(db->mutex);
979}
980
981/*
danielk197724b03fd2004-05-10 10:34:34 +0000982** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000983*/
drh9bb575f2004-09-06 17:24:11 +0000984int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000985#ifdef SQLITE_ENABLE_API_ARMOR
986 if( !sqlite3SafetyCheckOk(db) ){
987 (void)SQLITE_MISUSE_BKPT;
988 return 0;
989 }
990#endif
drhc8d30ac2002-04-12 10:08:59 +0000991 return db->nChange;
992}
993
rdcf146a772004-02-25 22:51:06 +0000994/*
danielk1977b28af712004-06-21 06:50:26 +0000995** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000996*/
danielk1977b28af712004-06-21 06:50:26 +0000997int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000998#ifdef SQLITE_ENABLE_API_ARMOR
999 if( !sqlite3SafetyCheckOk(db) ){
1000 (void)SQLITE_MISUSE_BKPT;
1001 return 0;
1002 }
1003#endif
danielk1977b28af712004-06-21 06:50:26 +00001004 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +00001005}
1006
drhc8d30ac2002-04-12 10:08:59 +00001007/*
danielk1977fd7f0452008-12-17 17:30:26 +00001008** Close all open savepoints. This function only manipulates fields of the
1009** database handle object, it does not close any savepoints that may be open
1010** at the b-tree/pager level.
1011*/
1012void sqlite3CloseSavepoints(sqlite3 *db){
1013 while( db->pSavepoint ){
1014 Savepoint *pTmp = db->pSavepoint;
1015 db->pSavepoint = pTmp->pNext;
1016 sqlite3DbFree(db, pTmp);
1017 }
1018 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001019 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001020 db->isTransactionSavepoint = 0;
1021}
1022
1023/*
dand2199f02010-08-27 17:48:52 +00001024** Invoke the destructor function associated with FuncDef p, if any. Except,
1025** if this is not the last copy of the function, do not invoke it. Multiple
1026** copies of a single function are created when create_function() is called
1027** with SQLITE_ANY as the encoding.
1028*/
1029static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001030 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001031 if( pDestructor ){
1032 pDestructor->nRef--;
1033 if( pDestructor->nRef==0 ){
1034 pDestructor->xDestroy(pDestructor->pUserData);
1035 sqlite3DbFree(db, pDestructor);
1036 }
1037 }
1038}
1039
1040/*
danbba02a92012-05-15 17:15:34 +00001041** Disconnect all sqlite3_vtab objects that belong to database connection
1042** db. This is called when db is being closed.
1043*/
1044static void disconnectAllVtab(sqlite3 *db){
1045#ifndef SQLITE_OMIT_VIRTUALTABLE
1046 int i;
drh51be3872015-08-19 02:32:25 +00001047 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001048 sqlite3BtreeEnterAll(db);
1049 for(i=0; i<db->nDb; i++){
1050 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001051 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001052 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1053 Table *pTab = (Table *)sqliteHashData(p);
1054 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1055 }
1056 }
1057 }
drh51be3872015-08-19 02:32:25 +00001058 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1059 Module *pMod = (Module *)sqliteHashData(p);
1060 if( pMod->pEpoTab ){
1061 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1062 }
1063 }
dand88e5212014-03-12 19:38:38 +00001064 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001065 sqlite3BtreeLeaveAll(db);
1066#else
1067 UNUSED_PARAMETER(db);
1068#endif
1069}
1070
1071/*
drh167cd6a2012-06-02 17:09:46 +00001072** Return TRUE if database connection db has unfinalized prepared
1073** statements or unfinished sqlite3_backup objects.
1074*/
1075static int connectionIsBusy(sqlite3 *db){
1076 int j;
1077 assert( sqlite3_mutex_held(db->mutex) );
1078 if( db->pVdbe ) return 1;
1079 for(j=0; j<db->nDb; j++){
1080 Btree *pBt = db->aDb[j].pBt;
1081 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1082 }
1083 return 0;
1084}
1085
1086/*
drh50e5dad2001-09-15 00:57:28 +00001087** Close an existing SQLite database
1088*/
drh167cd6a2012-06-02 17:09:46 +00001089static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001090 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001091 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1092 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001093 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001094 }
drh7e8b8482008-01-23 03:03:05 +00001095 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001096 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001097 }
drh605264d2007-08-21 15:13:19 +00001098 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001099 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1100 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1101 }
danielk1977e35ee192004-06-26 09:50:11 +00001102
danbba02a92012-05-15 17:15:34 +00001103 /* Force xDisconnect calls on all virtual tables */
1104 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001105
danbba02a92012-05-15 17:15:34 +00001106 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001107 ** will not have called the xDisconnect() method on any virtual
1108 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1109 ** call will do so. We need to do this before the check for active
1110 ** SQL statements below, as the v-table implementation may be storing
1111 ** some prepared statements internally.
1112 */
dan67430812013-05-15 10:21:50 +00001113 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001114
drh167cd6a2012-06-02 17:09:46 +00001115 /* Legacy behavior (sqlite3_close() behavior) is to return
1116 ** SQLITE_BUSY if the connection can not be closed immediately.
1117 */
1118 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001119 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001120 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001121 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001122 return SQLITE_BUSY;
1123 }
danielk1977e0048402004-06-15 16:51:01 +00001124
danac455932012-11-26 19:50:41 +00001125#ifdef SQLITE_ENABLE_SQLLOG
1126 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001127 /* Closing the handle. Fourth parameter is passed the value 2. */
1128 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001129 }
1130#endif
1131
drh167cd6a2012-06-02 17:09:46 +00001132 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001133 */
1134 db->magic = SQLITE_MAGIC_ZOMBIE;
1135 sqlite3LeaveMutexAndCloseZombie(db);
1136 return SQLITE_OK;
1137}
drh94e92032003-02-16 22:21:32 +00001138
drh167cd6a2012-06-02 17:09:46 +00001139/*
1140** Two variations on the public interface for closing a database
1141** connection. The sqlite3_close() version returns SQLITE_BUSY and
1142** leaves the connection option if there are unfinalized prepared
1143** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1144** version forces the connection to become a zombie if there are
1145** unclosed resources, and arranges for deallocation when the last
1146** prepare statement or sqlite3_backup closes.
1147*/
1148int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1149int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1150
drh4245c402012-06-02 14:32:21 +00001151
1152/*
1153** Close the mutex on database connection db.
1154**
1155** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001156** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1157** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1158** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001159*/
1160void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1161 HashElem *i; /* Hash table iterator */
1162 int j;
1163
drh4245c402012-06-02 14:32:21 +00001164 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001165 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1166 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001167 */
drh167cd6a2012-06-02 17:09:46 +00001168 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001169 sqlite3_mutex_leave(db->mutex);
1170 return;
danielk197704103022009-02-03 16:51:24 +00001171 }
1172
drh4245c402012-06-02 14:32:21 +00001173 /* If we reach this point, it means that the database connection has
1174 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001175 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001176 ** go ahead and free all resources.
1177 */
1178
dan617dc862013-05-16 11:57:28 +00001179 /* If a transaction is open, roll it back. This also ensures that if
1180 ** any database schemas have been modified by an uncommitted transaction
1181 ** they are reset. And that the required b-tree mutex is held to make
1182 ** the pager rollback and schema reset an atomic operation. */
1183 sqlite3RollbackAll(db, SQLITE_OK);
1184
danielk1977fd7f0452008-12-17 17:30:26 +00001185 /* Free any outstanding Savepoint structures. */
1186 sqlite3CloseSavepoints(db);
1187
drh5efb3142012-05-16 01:24:34 +00001188 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001189 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001190 struct Db *pDb = &db->aDb[j];
1191 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001192 sqlite3BtreeClose(pDb->pBt);
1193 pDb->pBt = 0;
1194 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001195 pDb->pSchema = 0;
1196 }
drh113088e2003-03-20 01:16:58 +00001197 }
drhf57b3392001-10-08 13:22:32 +00001198 }
drh5efb3142012-05-16 01:24:34 +00001199 /* Clear the TEMP schema separately and last */
1200 if( db->aDb[1].pSchema ){
1201 sqlite3SchemaClear(db->aDb[1].pSchema);
1202 }
1203 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001204
drh5efb3142012-05-16 01:24:34 +00001205 /* Free up the array of auxiliary databases */
1206 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001207 assert( db->nDb<=2 );
1208 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001209
1210 /* Tell the code in notify.c that the connection no longer holds any
1211 ** locks and does not require any further unlock-notify callbacks.
1212 */
1213 sqlite3ConnectionClosed(db);
1214
drh80738d92016-02-15 00:34:16 +00001215 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1216 FuncDef *pNext, *p;
1217 p = sqliteHashData(i);
1218 do{
1219 functionDestroy(db, p);
1220 pNext = p->pNext;
1221 sqlite3DbFree(db, p);
1222 p = pNext;
1223 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001224 }
drh80738d92016-02-15 00:34:16 +00001225 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001226 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001227 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001228 /* Invoke any destructors registered for collation sequence user data. */
1229 for(j=0; j<3; j++){
1230 if( pColl[j].xDel ){
1231 pColl[j].xDel(pColl[j].pUser);
1232 }
1233 }
drh633e6d52008-07-28 19:34:53 +00001234 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001235 }
danielk1977d8123362004-06-12 09:25:12 +00001236 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001237#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001238 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1239 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001240 if( pMod->xDestroy ){
1241 pMod->xDestroy(pMod->pAux);
1242 }
drh51be3872015-08-19 02:32:25 +00001243 sqlite3VtabEponymousTableClear(db, pMod);
drh633e6d52008-07-28 19:34:53 +00001244 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001245 }
drhb9bb7c12006-06-11 23:41:55 +00001246 sqlite3HashClear(&db->aModule);
1247#endif
danielk1977466be562004-06-10 02:16:01 +00001248
drh13f40da2014-08-22 18:00:11 +00001249 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001250 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001251 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001252#if SQLITE_USER_AUTHENTICATION
1253 sqlite3_free(db->auth.zAuthUser);
1254 sqlite3_free(db->auth.zAuthPW);
1255#endif
danielk197796d81f92004-06-19 03:33:57 +00001256
1257 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001258
1259 /* The temp-database schema is allocated differently from the other schema
1260 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1261 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1262 ** the same sqliteMalloc() as the one that allocates the database
1263 ** structure?
1264 */
drh633e6d52008-07-28 19:34:53 +00001265 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001266 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001267 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001268 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001269 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001270 if( db->lookaside.bMalloced ){
1271 sqlite3_free(db->lookaside.pStart);
1272 }
drh17435752007-08-16 04:30:38 +00001273 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001274}
1275
1276/*
drh0f198a72012-02-13 16:43:16 +00001277** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001278** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001279** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001280** attempts to use that cursor. Read cursors remain open and valid
1281** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001282*/
drh0f198a72012-02-13 16:43:16 +00001283void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001284 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001285 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001286 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001287 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001288 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001289
1290 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1291 ** This is important in case the transaction being rolled back has
1292 ** modified the database schema. If the b-tree mutexes are not taken
1293 ** here, then another shared-cache connection might sneak in between
1294 ** the database rollback and schema reset, which can cause false
1295 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001296 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001297 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001298
drh001bbcb2003-03-19 03:14:00 +00001299 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001300 Btree *p = db->aDb[i].pBt;
1301 if( p ){
1302 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001303 inTrans = 1;
1304 }
drh47b7fc72014-11-11 01:33:57 +00001305 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001306 }
1307 }
danielk1977a298e902006-06-22 09:53:48 +00001308 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001309 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001310
drh7f32dc92018-07-16 11:32:59 +00001311 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001312 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001313 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001314 }
dancd7b91a2013-05-13 18:23:15 +00001315 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001316
dan1da40a32009-09-19 17:00:31 +00001317 /* Any deferred constraint violations have now been resolved. */
1318 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001319 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00001320 db->flags &= ~(u64)SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001321
danielk197771fd80b2005-12-16 06:54:01 +00001322 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001323 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001324 db->xRollbackCallback(db->pRollbackArg);
1325 }
drh001bbcb2003-03-19 03:14:00 +00001326}
1327
1328/*
mistachkinf2c1c992013-04-28 01:44:43 +00001329** Return a static string containing the name corresponding to the error code
1330** specified in the argument.
1331*/
mistachkin5824d442015-04-28 23:34:10 +00001332#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001333const char *sqlite3ErrName(int rc){
1334 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001335 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001336 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1337 switch( rc ){
1338 case SQLITE_OK: zName = "SQLITE_OK"; break;
1339 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001340 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001341 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1342 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1343 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001344 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001345 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001346 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001347 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001348 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1349 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1350 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1351 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001352 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001353 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001354 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001355 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001356 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001357 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1358 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001359 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1360 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1361 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1362 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1363 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1364 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1365 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1366 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1367 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1368 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001369 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1370 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1371 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1372 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1373 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1374 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1375 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1376 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1377 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1378 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1379 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1380 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1381 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1382 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001383 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001384 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001385 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001386 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001387 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1388 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1389 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001390 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1391 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1392 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001393 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001394 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1395 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1396 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1397 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1398 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1399 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1400 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1401 case SQLITE_CONSTRAINT_FOREIGNKEY:
1402 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1403 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1404 case SQLITE_CONSTRAINT_PRIMARYKEY:
1405 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1406 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1407 case SQLITE_CONSTRAINT_COMMITHOOK:
1408 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1409 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1410 case SQLITE_CONSTRAINT_FUNCTION:
1411 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001412 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001413 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1414 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1415 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1416 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1417 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1418 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1419 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1420 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1421 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001422 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1423 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1424 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001425 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001426 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001427 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001428 }
1429 }
mistachkin10269dc2013-04-30 07:54:42 +00001430 if( zName==0 ){
1431 static char zBuf[50];
1432 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1433 zName = zBuf;
1434 }
mistachkinf2c1c992013-04-28 01:44:43 +00001435 return zName;
1436}
mistachkin10269dc2013-04-30 07:54:42 +00001437#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001438
1439/*
drhc22bd472002-05-10 13:14:07 +00001440** Return a static string that describes the kind of error specified in the
1441** argument.
drh247be432002-05-10 05:44:55 +00001442*/
danielk1977f20b21c2004-05-31 23:56:42 +00001443const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001444 static const char* const aMsg[] = {
1445 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001446 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001447 /* SQLITE_INTERNAL */ 0,
1448 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001449 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001450 /* SQLITE_BUSY */ "database is locked",
1451 /* SQLITE_LOCKED */ "database table is locked",
1452 /* SQLITE_NOMEM */ "out of memory",
1453 /* SQLITE_READONLY */ "attempt to write a readonly database",
1454 /* SQLITE_INTERRUPT */ "interrupted",
1455 /* SQLITE_IOERR */ "disk I/O error",
1456 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001457 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001458 /* SQLITE_FULL */ "database or disk is full",
1459 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001460 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001461 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001462 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001463 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001464 /* SQLITE_CONSTRAINT */ "constraint failed",
1465 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001466 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001467#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001468 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001469#else
1470 /* SQLITE_NOLFS */ 0,
1471#endif
drh51c7d862009-04-27 18:46:06 +00001472 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001473 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001474 /* SQLITE_RANGE */ "column index out of range",
1475 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001476 /* SQLITE_NOTICE */ "notification message",
1477 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001478 };
drh21021a52012-02-13 17:01:51 +00001479 const char *zErr = "unknown error";
1480 switch( rc ){
1481 case SQLITE_ABORT_ROLLBACK: {
1482 zErr = "abort due to ROLLBACK";
1483 break;
1484 }
mistachkin2a861102018-02-08 01:00:11 +00001485 case SQLITE_ROW: {
1486 zErr = "another row available";
1487 break;
1488 }
1489 case SQLITE_DONE: {
1490 zErr = "no more rows available";
1491 break;
1492 }
drh21021a52012-02-13 17:01:51 +00001493 default: {
1494 rc &= 0xff;
1495 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1496 zErr = aMsg[rc];
1497 }
1498 break;
1499 }
drh247be432002-05-10 05:44:55 +00001500 }
drh21021a52012-02-13 17:01:51 +00001501 return zErr;
drh247be432002-05-10 05:44:55 +00001502}
1503
1504/*
drh2dfbbca2000-07-28 14:32:48 +00001505** This routine implements a busy callback that sleeps and tries
1506** again until a timeout value is reached. The timeout value is
1507** an integer number of milliseconds passed in as the first
1508** argument.
drhf0119b22018-03-26 17:40:53 +00001509**
1510** Return non-zero to retry the lock. Return zero to stop trying
1511** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001512*/
drhdaffd0e2001-04-11 14:28:42 +00001513static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001514 void *ptr, /* Database connection */
1515 int count, /* Number of times table has been busy */
1516 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001517){
drh0ede9eb2015-01-10 16:49:23 +00001518#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001519 /* This case is for systems that have support for sleeping for fractions of
1520 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001521 static const u8 delays[] =
1522 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1523 static const u8 totals[] =
1524 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001525# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001526 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001527 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001528 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001529
drhf0119b22018-03-26 17:40:53 +00001530#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1531 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1532 if( count ){
1533 tmout = 0;
1534 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1535 return 0;
1536 }else{
1537 return 1;
1538 }
1539 }
drh5013c4b2018-03-28 21:45:03 +00001540#else
1541 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001542#endif
drhee570fa2005-04-28 12:06:05 +00001543 assert( count>=0 );
1544 if( count < NDELAY ){
1545 delay = delays[count];
1546 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001547 }else{
1548 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001549 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001550 }
drhf0119b22018-03-26 17:40:53 +00001551 if( prior + delay > tmout ){
1552 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001553 if( delay<=0 ) return 0;
1554 }
danielk19772a6bdf62007-08-20 16:07:00 +00001555 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001556 return 1;
1557#else
drhf0119b22018-03-26 17:40:53 +00001558 /* This case for unix systems that lack usleep() support. Sleeping
1559 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001560 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001561 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001562 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001563 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001564 return 0;
1565 }
drh482ea182007-08-20 11:12:40 +00001566 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001567 return 1;
1568#endif
1569}
1570
1571/*
drha4afb652005-07-09 02:16:02 +00001572** Invoke the given busy handler.
1573**
drhf0119b22018-03-26 17:40:53 +00001574** This routine is called when an operation failed to acquire a
1575** lock on VFS file pFile.
1576**
drha4afb652005-07-09 02:16:02 +00001577** If this routine returns non-zero, the lock is retried. If it
1578** returns 0, the operation aborts with an SQLITE_BUSY error.
1579*/
drhf0119b22018-03-26 17:40:53 +00001580int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001581 int rc;
drh80262892018-03-26 16:37:53 +00001582 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001583 if( p->bExtraFileArg ){
1584 /* Add an extra parameter with the pFile pointer to the end of the
1585 ** callback argument list */
1586 int (*xTra)(void*,int,sqlite3_file*);
1587 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1588 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1589 }else{
1590 /* Legacy style busy handler callback */
1591 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1592 }
drha4afb652005-07-09 02:16:02 +00001593 if( rc==0 ){
1594 p->nBusy = -1;
1595 }else{
1596 p->nBusy++;
1597 }
1598 return rc;
1599}
1600
1601/*
drh2dfbbca2000-07-28 14:32:48 +00001602** This routine sets the busy callback for an Sqlite database to the
1603** given callback function with the given argument.
1604*/
danielk1977f9d64d22004-06-19 08:18:07 +00001605int sqlite3_busy_handler(
1606 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001607 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001608 void *pArg
1609){
drh9ca95732014-10-24 00:35:58 +00001610#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001611 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001612#endif
drhe30f4422007-08-21 16:15:55 +00001613 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001614 db->busyHandler.xBusyHandler = xBusy;
1615 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001616 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001617 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001618 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001619 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001620 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001621}
1622
danielk1977348bb5d2003-10-18 09:37:26 +00001623#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1624/*
1625** This routine sets the progress callback for an Sqlite database to the
1626** given callback function with the given argument. The progress callback will
1627** be invoked every nOps opcodes.
1628*/
danielk197724b03fd2004-05-10 10:34:34 +00001629void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001630 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001631 int nOps,
1632 int (*xProgress)(void*),
1633 void *pArg
1634){
drh9ca95732014-10-24 00:35:58 +00001635#ifdef SQLITE_ENABLE_API_ARMOR
1636 if( !sqlite3SafetyCheckOk(db) ){
1637 (void)SQLITE_MISUSE_BKPT;
1638 return;
1639 }
1640#endif
drhbd0b1b52008-07-07 19:52:09 +00001641 sqlite3_mutex_enter(db->mutex);
1642 if( nOps>0 ){
1643 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001644 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001645 db->pProgressArg = pArg;
1646 }else{
1647 db->xProgress = 0;
1648 db->nProgressOps = 0;
1649 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001650 }
drhbd0b1b52008-07-07 19:52:09 +00001651 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001652}
1653#endif
1654
1655
drh2dfbbca2000-07-28 14:32:48 +00001656/*
1657** This routine installs a default busy handler that waits for the
1658** specified number of milliseconds before returning 0.
1659*/
danielk1977f9d64d22004-06-19 08:18:07 +00001660int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001661#ifdef SQLITE_ENABLE_API_ARMOR
1662 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1663#endif
drh2dfbbca2000-07-28 14:32:48 +00001664 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001665 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1666 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001667 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001668 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001669 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001670 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001671 }
danielk1977f9d64d22004-06-19 08:18:07 +00001672 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001673}
drh4c504392000-10-16 22:06:40 +00001674
1675/*
1676** Cause any pending operation to stop at its earliest opportunity.
1677*/
drh9bb575f2004-09-06 17:24:11 +00001678void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001679#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001680 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001681 (void)SQLITE_MISUSE_BKPT;
1682 return;
1683 }
1684#endif
drhbd0b1b52008-07-07 19:52:09 +00001685 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001686}
drhfa86c412002-02-02 15:01:15 +00001687
drhfa86c412002-02-02 15:01:15 +00001688
1689/*
danielk1977771151b2006-01-17 13:21:40 +00001690** This function is exactly the same as sqlite3_create_function(), except
1691** that it is designed to be called by internal code. The difference is
1692** that if a malloc() fails in sqlite3_create_function(), an error code
1693** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001694*/
danielk1977771151b2006-01-17 13:21:40 +00001695int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001696 sqlite3 *db,
1697 const char *zFunctionName,
1698 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001699 int enc,
danielk197765904932004-05-26 06:18:37 +00001700 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001701 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001702 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001703 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001704 void (*xValue)(sqlite3_context*),
1705 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001706 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001707){
drh0bce8352002-02-28 00:41:10 +00001708 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001709 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001710 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001711
drhe30f4422007-08-21 16:15:55 +00001712 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001713 assert( xValue==0 || xSFunc==0 );
1714 if( zFunctionName==0 /* Must have a valid name */
1715 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1716 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1717 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1718 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1719 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1720 ){
drh413c3d32010-02-23 20:11:56 +00001721 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001722 }
drh4a8ee3d2013-12-14 13:44:22 +00001723
1724 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1725 extraFlags = enc & SQLITE_DETERMINISTIC;
1726 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001727
danielk197793758c82005-01-21 08:13:14 +00001728#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001729 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1730 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1731 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1732 **
1733 ** If SQLITE_ANY is specified, add three versions of the function
1734 ** to the hash table.
1735 */
1736 if( enc==SQLITE_UTF16 ){
1737 enc = SQLITE_UTF16NATIVE;
1738 }else if( enc==SQLITE_ANY ){
1739 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001740 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dan660af932018-06-18 16:55:22 +00001741 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001742 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001743 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dan660af932018-06-18 16:55:22 +00001744 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001745 }
1746 if( rc!=SQLITE_OK ){
1747 return rc;
1748 }
danielk1977d8123362004-06-12 09:25:12 +00001749 enc = SQLITE_UTF16BE;
1750 }
danielk197793758c82005-01-21 08:13:14 +00001751#else
1752 enc = SQLITE_UTF8;
1753#endif
danielk19779636c4e2005-01-25 04:27:54 +00001754
1755 /* Check if an existing function is being overridden or deleted. If so,
1756 ** and there are active VMs, then return SQLITE_BUSY. If a function
1757 ** is being overridden/deleted but there are no active VMs, allow the
1758 ** operation to continue but invalidate all precompiled statements.
1759 */
drh80738d92016-02-15 00:34:16 +00001760 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001761 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001762 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001763 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001764 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001765 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001766 return SQLITE_BUSY;
1767 }else{
drhba968db2018-07-24 22:02:12 +00001768 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001769 }
1770 }
danielk197765904932004-05-26 06:18:37 +00001771
drh80738d92016-02-15 00:34:16 +00001772 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001773 assert(p || db->mallocFailed);
1774 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001775 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001776 }
dand2199f02010-08-27 17:48:52 +00001777
1778 /* If an older version of the function with a configured destructor is
1779 ** being replaced invoke the destructor function here. */
1780 functionDestroy(db, p);
1781
1782 if( pDestructor ){
1783 pDestructor->nRef++;
1784 }
drh80738d92016-02-15 00:34:16 +00001785 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001786 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1787 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh2d801512016-01-14 22:19:58 +00001788 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001789 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001790 p->xValue = xValue;
1791 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001792 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001793 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001794 return SQLITE_OK;
1795}
danielk1977771151b2006-01-17 13:21:40 +00001796
1797/*
dan660af932018-06-18 16:55:22 +00001798** Worker function used by utf-8 APIs that create new functions:
1799**
1800** sqlite3_create_function()
1801** sqlite3_create_function_v2()
1802** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001803*/
dan660af932018-06-18 16:55:22 +00001804static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001805 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001806 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001807 int nArg,
1808 int enc,
1809 void *p,
dan660af932018-06-18 16:55:22 +00001810 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1811 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001812 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001813 void (*xValue)(sqlite3_context*),
1814 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1815 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001816){
shanehbd2aaf92010-09-01 02:38:21 +00001817 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001818 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001819
1820#ifdef SQLITE_ENABLE_API_ARMOR
1821 if( !sqlite3SafetyCheckOk(db) ){
1822 return SQLITE_MISUSE_BKPT;
1823 }
1824#endif
dand2199f02010-08-27 17:48:52 +00001825 sqlite3_mutex_enter(db->mutex);
1826 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001827 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001828 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001829 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001830 xDestroy(p);
1831 goto out;
1832 }
drh92011842018-05-26 16:00:26 +00001833 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001834 pArg->xDestroy = xDestroy;
1835 pArg->pUserData = p;
1836 }
dan660af932018-06-18 16:55:22 +00001837 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1838 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1839 );
dand2199f02010-08-27 17:48:52 +00001840 if( pArg && pArg->nRef==0 ){
1841 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001842 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001843 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001844 }
1845
1846 out:
drhe30f4422007-08-21 16:15:55 +00001847 rc = sqlite3ApiExit(db, rc);
1848 sqlite3_mutex_leave(db->mutex);
1849 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001850}
1851
dan660af932018-06-18 16:55:22 +00001852/*
1853** Create new user functions.
1854*/
1855int sqlite3_create_function(
1856 sqlite3 *db,
1857 const char *zFunc,
1858 int nArg,
1859 int enc,
1860 void *p,
1861 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1862 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1863 void (*xFinal)(sqlite3_context*)
1864){
1865 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1866 xFinal, 0, 0, 0);
1867}
1868int sqlite3_create_function_v2(
1869 sqlite3 *db,
1870 const char *zFunc,
1871 int nArg,
1872 int enc,
1873 void *p,
1874 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1875 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1876 void (*xFinal)(sqlite3_context*),
1877 void (*xDestroy)(void *)
1878){
1879 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1880 xFinal, 0, 0, xDestroy);
1881}
1882int sqlite3_create_window_function(
1883 sqlite3 *db,
1884 const char *zFunc,
1885 int nArg,
1886 int enc,
1887 void *p,
1888 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1889 void (*xFinal)(sqlite3_context*),
1890 void (*xValue)(sqlite3_context*),
1891 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1892 void (*xDestroy)(void *)
1893){
1894 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1895 xFinal, xValue, xInverse, xDestroy);
1896}
1897
danielk197793758c82005-01-21 08:13:14 +00001898#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001899int sqlite3_create_function16(
1900 sqlite3 *db,
1901 const void *zFunctionName,
1902 int nArg,
1903 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001904 void *p,
drh2d801512016-01-14 22:19:58 +00001905 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001906 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1907 void (*xFinal)(sqlite3_context*)
1908){
1909 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001910 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001911
1912#ifdef SQLITE_ENABLE_API_ARMOR
1913 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1914#endif
drhe30f4422007-08-21 16:15:55 +00001915 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001916 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001917 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00001918 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00001919 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001920 rc = sqlite3ApiExit(db, rc);
1921 sqlite3_mutex_leave(db->mutex);
1922 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001923}
danielk197793758c82005-01-21 08:13:14 +00001924#endif
drhc9b84a12002-06-20 11:36:48 +00001925
drhb7481e72006-09-16 21:45:14 +00001926
1927/*
drh92011842018-05-26 16:00:26 +00001928** The following is the implementation of an SQL function that always
1929** fails with an error message stating that the function is used in the
1930** wrong context. The sqlite3_overload_function() API might construct
1931** SQL function that use this routine so that the functions will exist
1932** for name resolution but are actually overloaded by the xFindFunction
1933** method of virtual tables.
1934*/
1935static void sqlite3InvalidFunction(
1936 sqlite3_context *context, /* The function calling context */
1937 int NotUsed, /* Number of arguments to the function */
1938 sqlite3_value **NotUsed2 /* Value of each argument */
1939){
1940 const char *zName = (const char*)sqlite3_user_data(context);
1941 char *zErr;
1942 UNUSED_PARAMETER2(NotUsed, NotUsed2);
1943 zErr = sqlite3_mprintf(
1944 "unable to use function %s in the requested context", zName);
1945 sqlite3_result_error(context, zErr, -1);
1946 sqlite3_free(zErr);
1947}
1948
1949/*
drhb7481e72006-09-16 21:45:14 +00001950** Declare that a function has been overloaded by a virtual table.
1951**
1952** If the function already exists as a regular global function, then
1953** this routine is a no-op. If the function does not exist, then create
1954** a new one that always throws a run-time error.
1955**
1956** When virtual tables intend to provide an overloaded function, they
1957** should call this routine to make sure the global function exists.
1958** A global function must exist in order for name resolution to work
1959** properly.
1960*/
1961int sqlite3_overload_function(
1962 sqlite3 *db,
1963 const char *zName,
1964 int nArg
1965){
drh92011842018-05-26 16:00:26 +00001966 int rc;
1967 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00001968
1969#ifdef SQLITE_ENABLE_API_ARMOR
1970 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1971 return SQLITE_MISUSE_BKPT;
1972 }
1973#endif
drhe30f4422007-08-21 16:15:55 +00001974 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00001975 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00001976 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00001977 if( rc ) return SQLITE_OK;
1978 zCopy = sqlite3_mprintf(zName);
1979 if( zCopy==0 ) return SQLITE_NOMEM;
1980 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
1981 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00001982}
1983
drh19e2d372005-08-29 23:00:03 +00001984#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001985/*
drh18de4822003-01-16 16:28:53 +00001986** Register a trace function. The pArg from the previously registered trace
1987** is returned.
1988**
1989** A NULL trace function means that no tracing is executes. A non-NULL
1990** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001991** SQL statement.
drh18de4822003-01-16 16:28:53 +00001992*/
drh3d2a5292016-07-13 22:55:01 +00001993#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00001994void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001995 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001996
1997#ifdef SQLITE_ENABLE_API_ARMOR
1998 if( !sqlite3SafetyCheckOk(db) ){
1999 (void)SQLITE_MISUSE_BKPT;
2000 return 0;
2001 }
2002#endif
drhe30f4422007-08-21 16:15:55 +00002003 sqlite3_mutex_enter(db->mutex);
2004 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00002005 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00002006 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00002007 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002008 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002009 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002010}
drh3d2a5292016-07-13 22:55:01 +00002011#endif /* SQLITE_OMIT_DEPRECATED */
2012
2013/* Register a trace callback using the version-2 interface.
2014*/
2015int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002016 sqlite3 *db, /* Trace this connection */
2017 unsigned mTrace, /* Mask of events to be traced */
2018 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2019 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002020){
2021#ifdef SQLITE_ENABLE_API_ARMOR
2022 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002023 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002024 }
2025#endif
2026 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002027 if( mTrace==0 ) xTrace = 0;
2028 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002029 db->mTrace = mTrace;
2030 db->xTrace = xTrace;
2031 db->pTraceArg = pArg;
2032 sqlite3_mutex_leave(db->mutex);
2033 return SQLITE_OK;
2034}
2035
drh087ec072016-07-25 00:05:56 +00002036#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002037/*
2038** Register a profile function. The pArg from the previously registered
2039** profile function is returned.
2040**
2041** A NULL profile function means that no profiling is executes. A non-NULL
2042** profile is a pointer to a function that is invoked at the conclusion of
2043** each SQL statement that is run.
2044*/
2045void *sqlite3_profile(
2046 sqlite3 *db,
2047 void (*xProfile)(void*,const char*,sqlite_uint64),
2048 void *pArg
2049){
drhe30f4422007-08-21 16:15:55 +00002050 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002051
2052#ifdef SQLITE_ENABLE_API_ARMOR
2053 if( !sqlite3SafetyCheckOk(db) ){
2054 (void)SQLITE_MISUSE_BKPT;
2055 return 0;
2056 }
2057#endif
drhe30f4422007-08-21 16:15:55 +00002058 sqlite3_mutex_enter(db->mutex);
2059 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002060 db->xProfile = xProfile;
2061 db->pProfileArg = pArg;
drh04c67472018-12-04 14:33:02 +00002062 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2063 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
drhe30f4422007-08-21 16:15:55 +00002064 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002065 return pOld;
2066}
drh087ec072016-07-25 00:05:56 +00002067#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002068#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002069
drhcd565fd2012-03-01 21:30:44 +00002070/*
2071** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002072** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002073** rollback.
2074*/
danielk197724b03fd2004-05-10 10:34:34 +00002075void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002076 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002077 int (*xCallback)(void*), /* Function to invoke on each commit */
2078 void *pArg /* Argument to the function */
2079){
drhe30f4422007-08-21 16:15:55 +00002080 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002081
2082#ifdef SQLITE_ENABLE_API_ARMOR
2083 if( !sqlite3SafetyCheckOk(db) ){
2084 (void)SQLITE_MISUSE_BKPT;
2085 return 0;
2086 }
2087#endif
drhe30f4422007-08-21 16:15:55 +00002088 sqlite3_mutex_enter(db->mutex);
2089 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002090 db->xCommitCallback = xCallback;
2091 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002092 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002093 return pOld;
2094}
2095
danielk197794eb6a12005-12-15 15:22:08 +00002096/*
2097** Register a callback to be invoked each time a row is updated,
2098** inserted or deleted using this database connection.
2099*/
danielk197771fd80b2005-12-16 06:54:01 +00002100void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002101 sqlite3 *db, /* Attach the hook to this database */
2102 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2103 void *pArg /* Argument to the function */
2104){
drhe30f4422007-08-21 16:15:55 +00002105 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002106
2107#ifdef SQLITE_ENABLE_API_ARMOR
2108 if( !sqlite3SafetyCheckOk(db) ){
2109 (void)SQLITE_MISUSE_BKPT;
2110 return 0;
2111 }
2112#endif
drhe30f4422007-08-21 16:15:55 +00002113 sqlite3_mutex_enter(db->mutex);
2114 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002115 db->xUpdateCallback = xCallback;
2116 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002117 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002118 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002119}
2120
danielk197771fd80b2005-12-16 06:54:01 +00002121/*
2122** Register a callback to be invoked each time a transaction is rolled
2123** back by this database connection.
2124*/
2125void *sqlite3_rollback_hook(
2126 sqlite3 *db, /* Attach the hook to this database */
2127 void (*xCallback)(void*), /* Callback function */
2128 void *pArg /* Argument to the function */
2129){
drhe30f4422007-08-21 16:15:55 +00002130 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002131
2132#ifdef SQLITE_ENABLE_API_ARMOR
2133 if( !sqlite3SafetyCheckOk(db) ){
2134 (void)SQLITE_MISUSE_BKPT;
2135 return 0;
2136 }
2137#endif
drhe30f4422007-08-21 16:15:55 +00002138 sqlite3_mutex_enter(db->mutex);
2139 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002140 db->xRollbackCallback = xCallback;
2141 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002142 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002143 return pRet;
2144}
drhaa940ea2004-01-15 02:44:03 +00002145
drh9b1c62d2011-03-30 21:04:43 +00002146#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002147/*
2148** Register a callback to be invoked each time a row is updated,
2149** inserted or deleted using this database connection.
2150*/
2151void *sqlite3_preupdate_hook(
2152 sqlite3 *db, /* Attach the hook to this database */
2153 void(*xCallback)( /* Callback function */
2154 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2155 void *pArg /* First callback argument */
2156){
2157 void *pRet;
2158 sqlite3_mutex_enter(db->mutex);
2159 pRet = db->pPreUpdateArg;
2160 db->xPreUpdateCallback = xCallback;
2161 db->pPreUpdateArg = pArg;
2162 sqlite3_mutex_leave(db->mutex);
2163 return pRet;
2164}
drh9b1c62d2011-03-30 21:04:43 +00002165#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002166
dan586b9c82010-05-03 08:04:49 +00002167#ifndef SQLITE_OMIT_WAL
2168/*
2169** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002170** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2171** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002172** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002173*/
drhb033d8b2010-05-03 13:37:30 +00002174int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002175 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002176 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002177 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002178 int nFrame /* Size of WAL */
2179){
drh5def0842010-05-05 20:00:25 +00002180 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002181 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002182 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002183 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002184 }
2185 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002186}
drhb033d8b2010-05-03 13:37:30 +00002187#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002188
2189/*
2190** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2191** a database after committing a transaction if there are nFrame or
2192** more frames in the log file. Passing zero or a negative value as the
2193** nFrame parameter disables automatic checkpoints entirely.
2194**
2195** The callback registered by this function replaces any existing callback
2196** registered using sqlite3_wal_hook(). Likewise, registering a callback
2197** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2198** configured by this function.
2199*/
2200int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002201#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002202 UNUSED_PARAMETER(db);
2203 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002204#else
drh9ca95732014-10-24 00:35:58 +00002205#ifdef SQLITE_ENABLE_API_ARMOR
2206 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2207#endif
dan586b9c82010-05-03 08:04:49 +00002208 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002209 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002210 }else{
2211 sqlite3_wal_hook(db, 0, 0);
2212 }
drhb033d8b2010-05-03 13:37:30 +00002213#endif
dan586b9c82010-05-03 08:04:49 +00002214 return SQLITE_OK;
2215}
2216
paulb0208cc2003-04-13 18:26:49 +00002217/*
dan8d22a172010-04-19 18:03:51 +00002218** Register a callback to be invoked each time a transaction is written
2219** into the write-ahead-log by this database connection.
2220*/
drh833bf962010-04-28 14:42:19 +00002221void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002222 sqlite3 *db, /* Attach the hook to this db handle */
2223 int(*xCallback)(void *, sqlite3*, const char*, int),
2224 void *pArg /* First argument passed to xCallback() */
2225){
drhb033d8b2010-05-03 13:37:30 +00002226#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002227 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002228#ifdef SQLITE_ENABLE_API_ARMOR
2229 if( !sqlite3SafetyCheckOk(db) ){
2230 (void)SQLITE_MISUSE_BKPT;
2231 return 0;
2232 }
2233#endif
dan8d22a172010-04-19 18:03:51 +00002234 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002235 pRet = db->pWalArg;
2236 db->xWalCallback = xCallback;
2237 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002238 sqlite3_mutex_leave(db->mutex);
2239 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002240#else
2241 return 0;
2242#endif
dan8d22a172010-04-19 18:03:51 +00002243}
2244
2245/*
dancdc1f042010-11-18 12:11:05 +00002246** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002247*/
dancdc1f042010-11-18 12:11:05 +00002248int sqlite3_wal_checkpoint_v2(
2249 sqlite3 *db, /* Database handle */
2250 const char *zDb, /* Name of attached database (or NULL) */
2251 int eMode, /* SQLITE_CHECKPOINT_* value */
2252 int *pnLog, /* OUT: Size of WAL log in frames */
2253 int *pnCkpt /* OUT: Total number of frames checkpointed */
2254){
drhb033d8b2010-05-03 13:37:30 +00002255#ifdef SQLITE_OMIT_WAL
2256 return SQLITE_OK;
2257#else
dan586b9c82010-05-03 08:04:49 +00002258 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002259 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002260
drh9ca95732014-10-24 00:35:58 +00002261#ifdef SQLITE_ENABLE_API_ARMOR
2262 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2263#endif
2264
dan9c5e3682011-02-07 15:12:12 +00002265 /* Initialize the output variables to -1 in case an error occurs. */
2266 if( pnLog ) *pnLog = -1;
2267 if( pnCkpt ) *pnCkpt = -1;
2268
danf26a1542014-12-02 19:04:54 +00002269 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2270 assert( SQLITE_CHECKPOINT_FULL==1 );
2271 assert( SQLITE_CHECKPOINT_RESTART==2 );
2272 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2273 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002274 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2275 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002276 return SQLITE_MISUSE;
2277 }
2278
dan586b9c82010-05-03 08:04:49 +00002279 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002280 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002281 iDb = sqlite3FindDbName(db, zDb);
2282 }
2283 if( iDb<0 ){
2284 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002285 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002286 }else{
dan976b0032015-01-29 19:12:12 +00002287 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002288 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002289 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002290 }
drhb033d8b2010-05-03 13:37:30 +00002291 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002292
2293 /* If there are no active statements, clear the interrupt flag at this
2294 ** point. */
2295 if( db->nVdbeActive==0 ){
2296 db->u1.isInterrupted = 0;
2297 }
2298
dan586b9c82010-05-03 08:04:49 +00002299 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002300 return rc;
2301#endif
dan586b9c82010-05-03 08:04:49 +00002302}
2303
dancdc1f042010-11-18 12:11:05 +00002304
2305/*
2306** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2307** to contains a zero-length string, all attached databases are
2308** checkpointed.
2309*/
2310int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002311 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2312 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2313 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002314}
2315
drhb033d8b2010-05-03 13:37:30 +00002316#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002317/*
2318** Run a checkpoint on database iDb. This is a no-op if database iDb is
2319** not currently open in WAL mode.
2320**
dan6fcff072010-05-03 14:05:43 +00002321** If a transaction is open on the database being checkpointed, this
2322** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2323** an error occurs while running the checkpoint, an SQLite error code is
2324** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002325**
2326** The mutex on database handle db should be held by the caller. The mutex
2327** associated with the specific b-tree being checkpointed is taken by
2328** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002329**
2330** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2331** checkpointed. If an error is encountered it is returned immediately -
2332** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002333**
dan78345512017-09-08 17:48:00 +00002334** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2335** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002336*/
dancdc1f042010-11-18 12:11:05 +00002337int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002338 int rc = SQLITE_OK; /* Return code */
2339 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002340 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002341
2342 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002343 assert( !pnLog || *pnLog==-1 );
2344 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002345
dan6fcff072010-05-03 14:05:43 +00002346 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2347 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002348 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002349 pnLog = 0;
2350 pnCkpt = 0;
2351 if( rc==SQLITE_BUSY ){
2352 bBusy = 1;
2353 rc = SQLITE_OK;
2354 }
dan6fcff072010-05-03 14:05:43 +00002355 }
dan586b9c82010-05-03 08:04:49 +00002356 }
2357
danf2b8dd52010-11-18 19:28:01 +00002358 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002359}
drhb033d8b2010-05-03 13:37:30 +00002360#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002361
2362/*
danielk1977d8293352009-04-30 09:10:37 +00002363** This function returns true if main-memory should be used instead of
2364** a temporary file for transient pager files and statement journals.
2365** The value returned depends on the value of db->temp_store (runtime
2366** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2367** following table describes the relationship between these two values
2368** and this functions return value.
2369**
2370** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2371** ----------------- -------------- ------------------------------
2372** 0 any file (return 0)
2373** 1 1 file (return 0)
2374** 1 2 memory (return 1)
2375** 1 0 file (return 0)
2376** 2 1 file (return 0)
2377** 2 2 memory (return 1)
2378** 2 0 memory (return 1)
2379** 3 any memory (return 1)
2380*/
drh1c514142009-04-30 12:25:10 +00002381int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002382#if SQLITE_TEMP_STORE==1
2383 return ( db->temp_store==2 );
2384#endif
2385#if SQLITE_TEMP_STORE==2
2386 return ( db->temp_store!=1 );
2387#endif
2388#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002389 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002390 return 1;
shanecf697392009-06-01 16:53:09 +00002391#endif
2392#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002393 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002394 return 0;
shane60a4b532009-05-06 18:57:09 +00002395#endif
danielk1977d8293352009-04-30 09:10:37 +00002396}
2397
2398/*
danielk19774ad17132004-05-21 01:47:26 +00002399** Return UTF-8 encoded English language explanation of the most recent
2400** error.
2401*/
danielk19776622cce2004-05-20 11:00:52 +00002402const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002403 const char *z;
drhf49661a2008-12-10 16:45:50 +00002404 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002405 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002406 }
drhd55d57e2008-07-07 17:53:07 +00002407 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002408 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002409 }
drh27641702007-08-22 02:56:42 +00002410 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002411 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002412 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002413 }else{
drha3cc0072013-12-13 16:23:55 +00002414 testcase( db->pErr==0 );
drh368bfe82018-12-11 12:20:41 +00002415 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
danielk1977238746a2009-03-19 18:51:06 +00002416 assert( !db->mallocFailed );
2417 if( z==0 ){
2418 z = sqlite3ErrStr(db->errCode);
2419 }
danielk19776622cce2004-05-20 11:00:52 +00002420 }
drhe30f4422007-08-21 16:15:55 +00002421 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002422 return z;
danielk19776622cce2004-05-20 11:00:52 +00002423}
2424
drh6c626082004-11-14 21:56:29 +00002425#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002426/*
2427** Return UTF-16 encoded English language explanation of the most recent
2428** error.
2429*/
danielk19776622cce2004-05-20 11:00:52 +00002430const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002431 static const u16 outOfMem[] = {
2432 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002433 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002434 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002435 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2436 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2437 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002438 };
danielk19774ad17132004-05-21 01:47:26 +00002439
drhc60d0442004-09-30 13:43:13 +00002440 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002441 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002442 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002443 }
drhd55d57e2008-07-07 17:53:07 +00002444 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002445 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002446 }
drhe30f4422007-08-21 16:15:55 +00002447 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002448 if( db->mallocFailed ){
2449 z = (void *)outOfMem;
2450 }else{
drhc60d0442004-09-30 13:43:13 +00002451 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002452 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002453 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002454 z = sqlite3_value_text16(db->pErr);
2455 }
2456 /* A malloc() may have failed within the call to sqlite3_value_text16()
2457 ** above. If this is the case, then the db->mallocFailed flag needs to
2458 ** be cleared before returning. Do this directly, instead of via
2459 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2460 */
drh4a642b62016-02-05 01:55:27 +00002461 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002462 }
drhe30f4422007-08-21 16:15:55 +00002463 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002464 return z;
danielk19776622cce2004-05-20 11:00:52 +00002465}
drh6c626082004-11-14 21:56:29 +00002466#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002467
drhc60d0442004-09-30 13:43:13 +00002468/*
danielk19777ddad962005-12-12 06:53:03 +00002469** Return the most recent error code generated by an SQLite routine. If NULL is
2470** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002471*/
danielk19776622cce2004-05-20 11:00:52 +00002472int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002473 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002474 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002475 }
drh01495b92008-01-23 12:52:40 +00002476 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002477 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002478 }
drh4ac285a2006-09-15 07:28:50 +00002479 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002480}
drh99dfe5e2008-10-30 15:03:15 +00002481int sqlite3_extended_errcode(sqlite3 *db){
2482 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002483 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002484 }
2485 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002486 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002487 }
2488 return db->errCode;
2489}
drh1b9f2142016-03-17 16:01:23 +00002490int sqlite3_system_errno(sqlite3 *db){
2491 return db ? db->iSysErrno : 0;
2492}
danielk19776622cce2004-05-20 11:00:52 +00002493
drh0e819f92006-02-01 13:50:41 +00002494/*
mistachkin5dac8432012-09-11 02:00:25 +00002495** Return a string that describes the kind of error specified in the
2496** argument. For now, this simply calls the internal sqlite3ErrStr()
2497** function.
2498*/
2499const char *sqlite3_errstr(int rc){
2500 return sqlite3ErrStr(rc);
2501}
2502
2503/*
drh0e819f92006-02-01 13:50:41 +00002504** Create a new collating function for database "db". The name is zName
2505** and the encoding is enc.
2506*/
danielk19779a30cf62006-01-18 04:26:07 +00002507static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002508 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002509 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002510 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002511 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002512 int(*xCompare)(void*,int,const void*,int,const void*),
2513 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002514){
2515 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002516 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002517
drhe30f4422007-08-21 16:15:55 +00002518 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002519
2520 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2521 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2522 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2523 */
drh51c7d862009-04-27 18:46:06 +00002524 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002525 testcase( enc2==SQLITE_UTF16 );
2526 testcase( enc2==SQLITE_UTF16_ALIGNED );
2527 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002528 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002529 }
drh51c7d862009-04-27 18:46:06 +00002530 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002531 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002532 }
2533
2534 /* Check if this call is removing or replacing an existing collation
2535 ** sequence. If so, and there are active VMs, return busy. If there
2536 ** are no active VMs, invalidate any pre-compiled statements.
2537 */
drhc4a64fa2009-05-11 20:53:28 +00002538 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002539 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002540 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002541 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002542 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002543 return SQLITE_BUSY;
2544 }
drhba968db2018-07-24 22:02:12 +00002545 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002546
2547 /* If collation sequence pColl was created directly by a call to
2548 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2549 ** then any copies made by synthCollSeq() need to be invalidated.
2550 ** Also, collation destructor - CollSeq.xDel() - function may need
2551 ** to be called.
2552 */
2553 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002554 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002555 int j;
2556 for(j=0; j<3; j++){
2557 CollSeq *p = &aColl[j];
2558 if( p->enc==pColl->enc ){
2559 if( p->xDel ){
2560 p->xDel(p->pUser);
2561 }
2562 p->xCmp = 0;
2563 }
2564 }
2565 }
danielk19779a30cf62006-01-18 04:26:07 +00002566 }
2567
drhc4a64fa2009-05-11 20:53:28 +00002568 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002569 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002570 pColl->xCmp = xCompare;
2571 pColl->pUser = pCtx;
2572 pColl->xDel = xDel;
2573 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002574 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002575 return SQLITE_OK;
2576}
2577
2578
danielk19776622cce2004-05-20 11:00:52 +00002579/*
drhbb4957f2008-03-20 14:03:29 +00002580** This array defines hard upper bounds on limit values. The
2581** initializer must be kept in sync with the SQLITE_LIMIT_*
2582** #defines in sqlite3.h.
2583*/
drhb1a6c3c2008-03-20 16:30:17 +00002584static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002585 SQLITE_MAX_LENGTH,
2586 SQLITE_MAX_SQL_LENGTH,
2587 SQLITE_MAX_COLUMN,
2588 SQLITE_MAX_EXPR_DEPTH,
2589 SQLITE_MAX_COMPOUND_SELECT,
2590 SQLITE_MAX_VDBE_OP,
2591 SQLITE_MAX_FUNCTION_ARG,
2592 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002593 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002594 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002595 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002596 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002597};
2598
2599/*
2600** Make sure the hard limits are set to reasonable values
2601*/
2602#if SQLITE_MAX_LENGTH<100
2603# error SQLITE_MAX_LENGTH must be at least 100
2604#endif
2605#if SQLITE_MAX_SQL_LENGTH<100
2606# error SQLITE_MAX_SQL_LENGTH must be at least 100
2607#endif
2608#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2609# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2610#endif
drhbb4957f2008-03-20 14:03:29 +00002611#if SQLITE_MAX_COMPOUND_SELECT<2
2612# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2613#endif
2614#if SQLITE_MAX_VDBE_OP<40
2615# error SQLITE_MAX_VDBE_OP must be at least 40
2616#endif
drh80738d92016-02-15 00:34:16 +00002617#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2618# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002619#endif
drhd08b2792014-07-22 15:33:31 +00002620#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2621# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002622#endif
drhbb4957f2008-03-20 14:03:29 +00002623#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2624# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2625#endif
drh70a8ca32008-08-21 18:49:27 +00002626#if SQLITE_MAX_COLUMN>32767
2627# error SQLITE_MAX_COLUMN must not exceed 32767
2628#endif
drh417168a2009-09-07 18:14:02 +00002629#if SQLITE_MAX_TRIGGER_DEPTH<1
2630# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2631#endif
drh111544c2014-08-29 16:20:47 +00002632#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2633# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2634#endif
drhbb4957f2008-03-20 14:03:29 +00002635
2636
2637/*
2638** Change the value of a limit. Report the old value.
2639** If an invalid limit index is supplied, report -1.
2640** Make no changes but still report the old value if the
2641** new limit is negative.
2642**
2643** A new lower limit does not shrink existing constructs.
2644** It merely prevents new constructs that exceed the limit
2645** from forming.
2646*/
2647int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2648 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002649
drh9ca95732014-10-24 00:35:58 +00002650#ifdef SQLITE_ENABLE_API_ARMOR
2651 if( !sqlite3SafetyCheckOk(db) ){
2652 (void)SQLITE_MISUSE_BKPT;
2653 return -1;
2654 }
2655#endif
drh4e93f5b2010-09-07 14:59:15 +00002656
2657 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2658 ** there is a hard upper bound set at compile-time by a C preprocessor
2659 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2660 ** "_MAX_".)
2661 */
2662 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2663 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2664 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2665 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2666 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2667 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2668 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2669 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2670 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2671 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2672 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2673 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002674 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2675 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002676
2677
drh521cc842008-04-15 02:36:33 +00002678 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002679 return -1;
2680 }
2681 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002682 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002683 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002684 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002685 }
2686 db->aLimit[limitId] = newLimit;
2687 }
drh4e93f5b2010-09-07 14:59:15 +00002688 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002689}
2690
2691/*
dan286ab7c2011-05-06 18:34:54 +00002692** This function is used to parse both URIs and non-URI filenames passed by the
2693** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2694** URIs specified as part of ATTACH statements.
2695**
2696** The first argument to this function is the name of the VFS to use (or
2697** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2698** query parameter. The second argument contains the URI (or non-URI filename)
2699** itself. When this function is called the *pFlags variable should contain
2700** the default flags to open the database handle with. The value stored in
2701** *pFlags may be updated before returning if the URI filename contains
2702** "cache=xxx" or "mode=xxx" query parameters.
2703**
2704** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2705** the VFS that should be used to open the database file. *pzFile is set to
2706** point to a buffer containing the name of the file to open. It is the
2707** responsibility of the caller to eventually call sqlite3_free() to release
2708** this buffer.
2709**
2710** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2711** may be set to point to a buffer containing an English language error
2712** message. It is the responsibility of the caller to eventually release
2713** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002714*/
2715int sqlite3ParseUri(
2716 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2717 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002718 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002719 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2720 char **pzFile, /* OUT: Filename component of URI */
2721 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2722){
dan78e9dd22011-05-03 10:22:32 +00002723 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002724 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002725 const char *zVfs = zDefaultVfs;
2726 char *zFile;
drhde941c32011-05-09 19:20:17 +00002727 char c;
dancd74b612011-04-22 19:37:32 +00002728 int nUri = sqlite3Strlen30(zUri);
2729
2730 assert( *pzErrMsg==0 );
2731
drh8790b6e2014-11-07 01:43:56 +00002732 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2733 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002734 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002735 ){
dan5de15372011-04-23 10:12:30 +00002736 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002737 int eState; /* Parser state when parsing URI */
2738 int iIn; /* Input character index */
2739 int iOut = 0; /* Output character index */
drhf3cdcdc2015-04-29 16:50:28 +00002740 u64 nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002741
dan286ab7c2011-05-06 18:34:54 +00002742 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2743 ** method that there may be extra parameters following the file-name. */
2744 flags |= SQLITE_OPEN_URI;
2745
2746 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002747 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002748 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002749
drh869c0402013-08-07 23:15:52 +00002750 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002751#ifdef SQLITE_ALLOW_URI_AUTHORITY
2752 if( strncmp(zUri+5, "///", 3)==0 ){
2753 iIn = 7;
2754 /* The following condition causes URIs with five leading / characters
2755 ** like file://///host/path to be converted into UNCs like //host/path.
2756 ** The correct URI for that UNC has only two or four leading / characters
2757 ** file://host/path or file:////host/path. But 5 leading slashes is a
2758 ** common error, we are told, so we handle it as a special case. */
2759 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2760 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2761 iIn = 16;
2762 }
2763#else
dancd74b612011-04-22 19:37:32 +00002764 /* Discard the scheme and authority segments of the URI. */
2765 if( zUri[5]=='/' && zUri[6]=='/' ){
2766 iIn = 7;
2767 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002768 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2769 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2770 iIn-7, &zUri[7]);
2771 rc = SQLITE_ERROR;
2772 goto parse_uri_out;
2773 }
dancd74b612011-04-22 19:37:32 +00002774 }
drh869c0402013-08-07 23:15:52 +00002775#endif
dancd74b612011-04-22 19:37:32 +00002776
2777 /* Copy the filename and any query parameters into the zFile buffer.
2778 ** Decode %HH escape codes along the way.
2779 **
2780 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2781 ** on the parsing context. As follows:
2782 **
2783 ** 0: Parsing file-name.
2784 ** 1: Parsing name section of a name=value query parameter.
2785 ** 2: Parsing value section of a name=value query parameter.
2786 */
2787 eState = 0;
drhde941c32011-05-09 19:20:17 +00002788 while( (c = zUri[iIn])!=0 && c!='#' ){
2789 iIn++;
dancd74b612011-04-22 19:37:32 +00002790 if( c=='%'
2791 && sqlite3Isxdigit(zUri[iIn])
2792 && sqlite3Isxdigit(zUri[iIn+1])
2793 ){
dan6d49e252011-05-03 15:09:05 +00002794 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2795 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002796
dan6d49e252011-05-03 15:09:05 +00002797 assert( octet>=0 && octet<256 );
2798 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002799#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002800 /* This branch is taken when "%00" appears within the URI. In this
2801 ** case we ignore all text in the remainder of the path, name or
2802 ** value currently being parsed. So ignore the current character
2803 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002804 while( (c = zUri[iIn])!=0 && c!='#'
2805 && (eState!=0 || c!='?')
2806 && (eState!=1 || (c!='=' && c!='&'))
2807 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002808 ){
2809 iIn++;
2810 }
2811 continue;
dan5c35e902016-10-26 12:15:41 +00002812#else
2813 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2814 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2815 rc = SQLITE_ERROR;
2816 goto parse_uri_out;
2817#endif
dancd74b612011-04-22 19:37:32 +00002818 }
dan6d49e252011-05-03 15:09:05 +00002819 c = octet;
dan5de15372011-04-23 10:12:30 +00002820 }else if( eState==1 && (c=='&' || c=='=') ){
2821 if( zFile[iOut-1]==0 ){
2822 /* An empty option name. Ignore this option altogether. */
2823 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2824 continue;
2825 }
2826 if( c=='&' ){
2827 zFile[iOut++] = '\0';
2828 }else{
2829 eState = 2;
2830 }
dancd74b612011-04-22 19:37:32 +00002831 c = 0;
dan5de15372011-04-23 10:12:30 +00002832 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2833 c = 0;
dancd74b612011-04-22 19:37:32 +00002834 eState = 1;
dancd74b612011-04-22 19:37:32 +00002835 }
2836 zFile[iOut++] = c;
2837 }
2838 if( eState==1 ) zFile[iOut++] = '\0';
2839 zFile[iOut++] = '\0';
2840 zFile[iOut++] = '\0';
2841
2842 /* Check if there were any options specified that should be interpreted
2843 ** here. Options that are interpreted here include "vfs" and those that
2844 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002845 ** method. */
dan5de15372011-04-23 10:12:30 +00002846 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2847 while( zOpt[0] ){
2848 int nOpt = sqlite3Strlen30(zOpt);
2849 char *zVal = &zOpt[nOpt+1];
2850 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002851
dan286ab7c2011-05-06 18:34:54 +00002852 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002853 zVfs = zVal;
2854 }else{
2855 struct OpenMode {
2856 const char *z;
2857 int mode;
2858 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002859 char *zModeType = 0;
2860 int mask = 0;
2861 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002862
dan286ab7c2011-05-06 18:34:54 +00002863 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002864 static struct OpenMode aCacheMode[] = {
2865 { "shared", SQLITE_OPEN_SHAREDCACHE },
2866 { "private", SQLITE_OPEN_PRIVATECACHE },
2867 { 0, 0 }
2868 };
2869
2870 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2871 aMode = aCacheMode;
2872 limit = mask;
2873 zModeType = "cache";
2874 }
dan286ab7c2011-05-06 18:34:54 +00002875 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002876 static struct OpenMode aOpenMode[] = {
2877 { "ro", SQLITE_OPEN_READONLY },
2878 { "rw", SQLITE_OPEN_READWRITE },
2879 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002880 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002881 { 0, 0 }
2882 };
2883
drh9c67b2a2012-05-28 13:58:00 +00002884 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2885 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002886 aMode = aOpenMode;
2887 limit = mask & flags;
2888 zModeType = "access";
2889 }
2890
2891 if( aMode ){
2892 int i;
2893 int mode = 0;
2894 for(i=0; aMode[i].z; i++){
2895 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002896 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002897 mode = aMode[i].mode;
2898 break;
dancd74b612011-04-22 19:37:32 +00002899 }
2900 }
dan78e9dd22011-05-03 10:22:32 +00002901 if( mode==0 ){
2902 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2903 rc = SQLITE_ERROR;
2904 goto parse_uri_out;
2905 }
drh9c67b2a2012-05-28 13:58:00 +00002906 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002907 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2908 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002909 rc = SQLITE_PERM;
2910 goto parse_uri_out;
2911 }
2912 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002913 }
dancd74b612011-04-22 19:37:32 +00002914 }
dan5de15372011-04-23 10:12:30 +00002915
2916 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002917 }
2918
2919 }else{
drhf3cdcdc2015-04-29 16:50:28 +00002920 zFile = sqlite3_malloc64(nUri+2);
mistachkinfad30392016-02-13 23:43:46 +00002921 if( !zFile ) return SQLITE_NOMEM_BKPT;
dan895decf2016-12-30 14:15:56 +00002922 if( nUri ){
2923 memcpy(zFile, zUri, nUri);
2924 }
dancd74b612011-04-22 19:37:32 +00002925 zFile[nUri] = '\0';
2926 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002927 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002928 }
2929
2930 *ppVfs = sqlite3_vfs_find(zVfs);
2931 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002932 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002933 rc = SQLITE_ERROR;
2934 }
2935 parse_uri_out:
2936 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002937 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002938 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002939 }
2940 *pFlags = flags;
2941 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002942 return rc;
dancd74b612011-04-22 19:37:32 +00002943}
2944
2945
2946/*
danielk19774ad17132004-05-21 01:47:26 +00002947** This routine does the work of opening a database on behalf of
2948** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002949** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002950*/
2951static int openDatabase(
2952 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002953 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002954 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002955 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002956){
dancd74b612011-04-22 19:37:32 +00002957 sqlite3 *db; /* Store allocated handle here */
2958 int rc; /* Return code */
2959 int isThreadsafe; /* True for threadsafe connections */
2960 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2961 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002962
drh9ca95732014-10-24 00:35:58 +00002963#ifdef SQLITE_ENABLE_API_ARMOR
2964 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2965#endif
drhe0d0f8e2009-04-28 04:47:31 +00002966 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002967#ifndef SQLITE_OMIT_AUTOINIT
2968 rc = sqlite3_initialize();
2969 if( rc ) return rc;
2970#endif
2971
drh039963a2008-09-03 00:43:15 +00002972 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002973 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002974 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2975 isThreadsafe = 0;
2976 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2977 isThreadsafe = 1;
2978 }else{
2979 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002980 }
dan8385bec2017-11-25 17:51:01 +00002981
drhf1f12682009-09-09 14:17:52 +00002982 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002983 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002984 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2985 flags |= SQLITE_OPEN_SHAREDCACHE;
2986 }
danielk19779a6284c2008-07-10 17:52:49 +00002987
drhb25a9f42009-05-12 13:35:11 +00002988 /* Remove harmful bits from the flags parameter
2989 **
2990 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2991 ** dealt with in the previous code block. Besides these, the only
2992 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002993 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2994 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002995 ** off all other flags.
2996 */
drha4267dc2008-02-19 15:20:44 +00002997 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002998 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002999 SQLITE_OPEN_MAIN_DB |
3000 SQLITE_OPEN_TEMP_DB |
3001 SQLITE_OPEN_TRANSIENT_DB |
3002 SQLITE_OPEN_MAIN_JOURNAL |
3003 SQLITE_OPEN_TEMP_JOURNAL |
3004 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00003005 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003006 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003007 SQLITE_OPEN_FULLMUTEX |
3008 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003009 );
3010
danielk19774ad17132004-05-21 01:47:26 +00003011 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003012 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003013 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003014 if( isThreadsafe
3015#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3016 || sqlite3GlobalConfig.bCoreMutex
3017#endif
3018 ){
danielk197759f8c082008-06-18 17:09:10 +00003019 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3020 if( db->mutex==0 ){
3021 sqlite3_free(db);
3022 db = 0;
3023 goto opendb_out;
3024 }
dan8385bec2017-11-25 17:51:01 +00003025 if( isThreadsafe==0 ){
3026 sqlite3MutexWarnOnContention(db->mutex);
3027 }
drh605264d2007-08-21 15:13:19 +00003028 }
drh27641702007-08-22 02:56:42 +00003029 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003030 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003031 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003032 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003033 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003034 db->lookaside.bDisable = 1;
drh633e6d52008-07-28 19:34:53 +00003035
drhbb4957f2008-03-20 14:03:29 +00003036 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3037 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003038 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003039 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003040 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003041 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003042 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003043 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00003044 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00003045#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003046 | SQLITE_AutoIndex
3047#endif
drh883ad042015-02-19 00:29:11 +00003048#if SQLITE_DEFAULT_CKPTFULLFSYNC
3049 | SQLITE_CkptFullFSync
3050#endif
drh76fe8032006-07-11 14:17:51 +00003051#if SQLITE_DEFAULT_FILE_FORMAT<4
3052 | SQLITE_LegacyFileFmt
3053#endif
drh56424db2007-03-27 22:24:11 +00003054#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3055 | SQLITE_LoadExtension
3056#endif
dan5bde73c2009-09-01 17:11:07 +00003057#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003058 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003059#endif
drha4bfd7f2010-12-09 19:15:17 +00003060#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3061 | SQLITE_ForeignKeys
3062#endif
drhf5471922014-12-09 15:12:11 +00003063#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3064 | SQLITE_ReverseOrder
3065#endif
drh1421d982015-05-27 03:46:18 +00003066#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3067 | SQLITE_CellSizeCk
3068#endif
drhd42908f2016-02-26 15:38:24 +00003069#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3070 | SQLITE_Fts3Tokenizer
3071#endif
drh169dd922017-06-26 13:57:49 +00003072#if defined(SQLITE_ENABLE_QPSG)
3073 | SQLITE_EnableQPSG
3074#endif
drh6ab91a72018-11-07 02:17:01 +00003075#if defined(SQLITE_DEFAULT_DEFENSIVE)
3076 | SQLITE_Defensive
3077#endif
drh76fe8032006-07-11 14:17:51 +00003078 ;
drhe61922a2009-05-02 13:29:37 +00003079 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003080#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003081 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003082#endif
danielk1977da184232006-01-05 11:34:32 +00003083
danielk19770202b292004-06-09 09:55:16 +00003084 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3085 ** and UTF-16, so add a version for each to avoid any unnecessary
3086 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003087 **
3088 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3089 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003090 */
drhf19aa5f2015-12-30 16:51:20 +00003091 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3092 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3093 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003094 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00003095 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003096 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003097 goto opendb_out;
3098 }
drh5e3b49b2014-11-20 19:22:26 +00003099 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3100 ** strings is BINARY.
3101 */
drhf19aa5f2015-12-30 16:51:20 +00003102 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
drh77db4c02008-03-18 13:01:38 +00003103 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00003104
drhff4fa772017-07-10 12:07:53 +00003105 /* Parse the filename/URI argument
3106 **
3107 ** Only allow sensible combinations of bits in the flags argument.
3108 ** Throw an error if any non-sense combination is used. If we
3109 ** do not block illegal combinations here, it could trigger
3110 ** assert() statements in deeper layers. Sensible combinations
3111 ** are:
3112 **
3113 ** 1: SQLITE_OPEN_READONLY
3114 ** 2: SQLITE_OPEN_READWRITE
3115 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3116 */
dan19432992011-05-10 18:39:10 +00003117 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003118 assert( SQLITE_OPEN_READONLY == 0x01 );
3119 assert( SQLITE_OPEN_READWRITE == 0x02 );
3120 assert( SQLITE_OPEN_CREATE == 0x04 );
3121 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3122 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3123 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3124 if( ((1<<(flags&7)) & 0x46)==0 ){
3125 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3126 }else{
3127 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3128 }
dancd74b612011-04-22 19:37:32 +00003129 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003130 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003131 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003132 sqlite3_free(zErrMsg);
3133 goto opendb_out;
3134 }
3135
danielk19774ad17132004-05-21 01:47:26 +00003136 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003137 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003138 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003139 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003140 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003141 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003142 }
drh13f40da2014-08-22 18:00:11 +00003143 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003144 goto opendb_out;
3145 }
dan0235a032014-12-08 20:20:16 +00003146 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003147 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00003148 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00003149 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003150 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003151
drhe872d512016-02-22 13:23:16 +00003152 /* The default safety_level for the main database is FULL; for the temp
3153 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003154 */
drh69c33822016-08-18 14:33:11 +00003155 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003156 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003157 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003158 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003159
danielk1977832a58a2007-06-22 15:21:15 +00003160 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003161 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003162 goto opendb_out;
3163 }
3164
danielk19778e227872004-06-07 07:52:17 +00003165 /* Register all built-in functions, but do not attempt to read the
3166 ** database schema yet. This is delayed until the first time the database
3167 ** is accessed.
3168 */
drh13f40da2014-08-22 18:00:11 +00003169 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003170 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003171 rc = sqlite3_errcode(db);
3172
3173#ifdef SQLITE_ENABLE_FTS5
3174 /* Register any built-in FTS5 module before loading the automatic
3175 ** extensions. This allows automatic extensions to register FTS5
3176 ** tokenizers and auxiliary functions. */
3177 if( !db->mallocFailed && rc==SQLITE_OK ){
3178 rc = sqlite3Fts5Init(db);
3179 }
3180#endif
danielk19774ad17132004-05-21 01:47:26 +00003181
drh1409be62006-08-23 20:07:20 +00003182 /* Load automatic extensions - extensions that have been registered
3183 ** using the sqlite3_automatic_extension() API.
3184 */
drhe5077c12011-12-13 04:08:36 +00003185 if( rc==SQLITE_OK ){
3186 sqlite3AutoLoadExtensions(db);
3187 rc = sqlite3_errcode(db);
3188 if( rc!=SQLITE_OK ){
3189 goto opendb_out;
3190 }
danielk1977832a58a2007-06-22 15:21:15 +00003191 }
drh1409be62006-08-23 20:07:20 +00003192
drhaa29c132006-09-02 13:58:06 +00003193#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00003194 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003195 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003196 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003197 }
3198#endif
3199
shessa26cf572006-10-19 20:27:58 +00003200#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003201 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003202 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003203 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003204 }
3205#endif
3206
drh50065652015-10-08 19:29:18 +00003207#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003208 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003209 rc = sqlite3Fts3Init(db);
3210 }
3211#endif
3212
dan21540ae2017-12-08 16:23:38 +00003213#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
drh17435752007-08-16 04:30:38 +00003214 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003215 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003216 }
3217#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003218
3219#ifdef SQLITE_ENABLE_RTREE
3220 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003221 rc = sqlite3RtreeInit(db);
3222 }
3223#endif
3224
drha43c8c82017-10-11 13:48:11 +00003225#ifdef SQLITE_ENABLE_DBPAGE_VTAB
3226 if( !db->mallocFailed && rc==SQLITE_OK){
3227 rc = sqlite3DbpageRegister(db);
3228 }
3229#endif
3230
drha3ab9d02015-05-04 20:25:05 +00003231#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3232 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003233 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003234 }
3235#endif
3236
drh2f20e132015-09-26 17:44:59 +00003237#ifdef SQLITE_ENABLE_JSON1
3238 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003239 rc = sqlite3Json1Init(db);
3240 }
3241#endif
3242
drhc6603af2017-06-29 14:33:51 +00003243#ifdef SQLITE_ENABLE_STMTVTAB
drhf00f5302017-06-28 15:47:29 +00003244 if( !db->mallocFailed && rc==SQLITE_OK){
drhc6603af2017-06-29 14:33:51 +00003245 rc = sqlite3StmtVtabInit(db);
drhf00f5302017-06-28 15:47:29 +00003246 }
3247#endif
3248
drh8fd5bd32007-04-02 16:40:37 +00003249 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3250 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3251 ** mode. Doing nothing at all also makes NORMAL the default.
3252 */
3253#ifdef SQLITE_DEFAULT_LOCKING_MODE
3254 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3255 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3256 SQLITE_DEFAULT_LOCKING_MODE);
3257#endif
3258
drh13f40da2014-08-22 18:00:11 +00003259 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003260
drh633e6d52008-07-28 19:34:53 +00003261 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003262 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3263 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003264
dan5a299f92010-05-03 11:05:08 +00003265 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003266
danielk19774ad17132004-05-21 01:47:26 +00003267opendb_out:
drhafc91042008-02-21 02:09:45 +00003268 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003269 assert( db->mutex!=0 || isThreadsafe==0
3270 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003271 sqlite3_mutex_leave(db->mutex);
3272 }
danielk197759633ae2008-08-27 19:01:57 +00003273 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003274 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003275 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003276 sqlite3_close(db);
3277 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003278 }else if( rc!=SQLITE_OK ){
3279 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003280 }
danielk19774ad17132004-05-21 01:47:26 +00003281 *ppDb = db;
danac455932012-11-26 19:50:41 +00003282#ifdef SQLITE_ENABLE_SQLLOG
3283 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003284 /* Opening a db handle. Fourth parameter is passed 0. */
3285 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3286 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003287 }
3288#endif
drh46e6ea02015-10-26 14:41:35 +00003289#if defined(SQLITE_HAS_CODEC)
3290 if( rc==SQLITE_OK ){
drhad012d02017-05-03 15:54:53 +00003291 const char *zKey;
drhd4fb1962017-05-23 00:32:56 +00003292 if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){
drh46e6ea02015-10-26 14:41:35 +00003293 u8 iByte;
3294 int i;
drhad012d02017-05-03 15:54:53 +00003295 char zDecoded[40];
3296 for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
3297 iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
3298 if( (i&1)!=0 ) zDecoded[i/2] = iByte;
drh46e6ea02015-10-26 14:41:35 +00003299 }
drhad012d02017-05-03 15:54:53 +00003300 sqlite3_key_v2(db, 0, zDecoded, i/2);
3301 }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){
3302 sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey));
drh46e6ea02015-10-26 14:41:35 +00003303 }
3304 }
3305#endif
drh095fb472016-01-16 03:16:19 +00003306 sqlite3_free(zOpen);
drh597d2b62015-06-30 03:13:47 +00003307 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003308}
3309
3310/*
3311** Open a new database handle.
3312*/
danielk197780290862004-05-22 09:21:21 +00003313int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003314 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003315 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003316){
drh605264d2007-08-21 15:13:19 +00003317 return openDatabase(zFilename, ppDb,
3318 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3319}
3320int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003321 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003322 sqlite3 **ppDb, /* OUT: SQLite db handle */
3323 int flags, /* Flags */
3324 const char *zVfs /* Name of VFS module to use */
3325){
drh522c26f2011-05-07 14:40:29 +00003326 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003327}
3328
drh6c626082004-11-14 21:56:29 +00003329#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003330/*
3331** Open a new database handle.
3332*/
3333int sqlite3_open16(
3334 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003335 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003336){
danielk1977bfd6cce2004-06-18 04:24:54 +00003337 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003338 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003339 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003340
drh9ca95732014-10-24 00:35:58 +00003341#ifdef SQLITE_ENABLE_API_ARMOR
3342 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3343#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003344 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003345#ifndef SQLITE_OMIT_AUTOINIT
3346 rc = sqlite3_initialize();
3347 if( rc ) return rc;
3348#endif
drh9ca95732014-10-24 00:35:58 +00003349 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003350 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003351 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3352 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003353 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003354 rc = openDatabase(zFilename8, ppDb,
3355 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003356 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003357 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003358 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003359 }
drh40257ff2008-06-13 18:24:27 +00003360 }else{
mistachkinfad30392016-02-13 23:43:46 +00003361 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003362 }
danielk19777ddad962005-12-12 06:53:03 +00003363 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003364
drh597d2b62015-06-30 03:13:47 +00003365 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003366}
drh6c626082004-11-14 21:56:29 +00003367#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003368
danielk1977106bb232004-05-21 10:08:53 +00003369/*
danielk1977d8123362004-06-12 09:25:12 +00003370** Register a new collation sequence with the database handle db.
3371*/
danielk19770202b292004-06-09 09:55:16 +00003372int sqlite3_create_collation(
3373 sqlite3* db,
3374 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003375 int enc,
danielk19770202b292004-06-09 09:55:16 +00003376 void* pCtx,
3377 int(*xCompare)(void*,int,const void*,int,const void*)
3378){
drh4f81bbb2014-10-23 01:01:26 +00003379 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003380}
3381
3382/*
3383** Register a new collation sequence with the database handle db.
3384*/
danielk1977a393c032007-05-07 14:58:53 +00003385int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003386 sqlite3* db,
3387 const char *zName,
3388 int enc,
3389 void* pCtx,
3390 int(*xCompare)(void*,int,const void*,int,const void*),
3391 void(*xDel)(void*)
3392){
3393 int rc;
drh9ca95732014-10-24 00:35:58 +00003394
3395#ifdef SQLITE_ENABLE_API_ARMOR
3396 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3397#endif
drhe30f4422007-08-21 16:15:55 +00003398 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003399 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003400 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003401 rc = sqlite3ApiExit(db, rc);
3402 sqlite3_mutex_leave(db->mutex);
3403 return rc;
danielk19770202b292004-06-09 09:55:16 +00003404}
3405
drh6c626082004-11-14 21:56:29 +00003406#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003407/*
3408** Register a new collation sequence with the database handle db.
3409*/
danielk19770202b292004-06-09 09:55:16 +00003410int sqlite3_create_collation16(
3411 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003412 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003413 int enc,
danielk19770202b292004-06-09 09:55:16 +00003414 void* pCtx,
3415 int(*xCompare)(void*,int,const void*,int,const void*)
3416){
danielk19779a30cf62006-01-18 04:26:07 +00003417 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003418 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003419
3420#ifdef SQLITE_ENABLE_API_ARMOR
3421 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3422#endif
drhe30f4422007-08-21 16:15:55 +00003423 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003424 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003425 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003426 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003427 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003428 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003429 }
drhe30f4422007-08-21 16:15:55 +00003430 rc = sqlite3ApiExit(db, rc);
3431 sqlite3_mutex_leave(db->mutex);
3432 return rc;
danielk19770202b292004-06-09 09:55:16 +00003433}
drh6c626082004-11-14 21:56:29 +00003434#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003435
danielk1977d8123362004-06-12 09:25:12 +00003436/*
3437** Register a collation sequence factory callback with the database handle
3438** db. Replace any previously installed collation sequence factory.
3439*/
danielk19777cedc8d2004-06-10 10:50:08 +00003440int sqlite3_collation_needed(
3441 sqlite3 *db,
3442 void *pCollNeededArg,
3443 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3444){
drh9ca95732014-10-24 00:35:58 +00003445#ifdef SQLITE_ENABLE_API_ARMOR
3446 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3447#endif
drhe30f4422007-08-21 16:15:55 +00003448 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003449 db->xCollNeeded = xCollNeeded;
3450 db->xCollNeeded16 = 0;
3451 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003452 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003453 return SQLITE_OK;
3454}
danielk1977d8123362004-06-12 09:25:12 +00003455
drh6c626082004-11-14 21:56:29 +00003456#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003457/*
3458** Register a collation sequence factory callback with the database handle
3459** db. Replace any previously installed collation sequence factory.
3460*/
danielk19777cedc8d2004-06-10 10:50:08 +00003461int sqlite3_collation_needed16(
3462 sqlite3 *db,
3463 void *pCollNeededArg,
3464 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3465){
drh9ca95732014-10-24 00:35:58 +00003466#ifdef SQLITE_ENABLE_API_ARMOR
3467 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3468#endif
drhe30f4422007-08-21 16:15:55 +00003469 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003470 db->xCollNeeded = 0;
3471 db->xCollNeeded16 = xCollNeeded16;
3472 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003473 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003474 return SQLITE_OK;
3475}
drh6c626082004-11-14 21:56:29 +00003476#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003477
shaneeec556d2008-10-12 00:27:53 +00003478#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003479/*
danielk19777ddad962005-12-12 06:53:03 +00003480** This function is now an anachronism. It used to be used to recover from a
3481** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003482*/
drh7d97efb2007-10-12 19:35:48 +00003483int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003484 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003485}
3486#endif
drh3e1d8e62005-05-26 16:23:34 +00003487
3488/*
3489** Test to see whether or not the database connection is in autocommit
3490** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3491** by default. Autocommit is disabled by a BEGIN statement and reenabled
3492** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003493*/
3494int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003495#ifdef SQLITE_ENABLE_API_ARMOR
3496 if( !sqlite3SafetyCheckOk(db) ){
3497 (void)SQLITE_MISUSE_BKPT;
3498 return 0;
3499 }
3500#endif
drh3e1d8e62005-05-26 16:23:34 +00003501 return db->autoCommit;
3502}
drh49285702005-09-17 15:20:26 +00003503
drh49285702005-09-17 15:20:26 +00003504/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003505** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003506** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003507** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003508**
3509** 1. Serve as a convenient place to set a breakpoint in a debugger
3510** to detect when version error conditions occurs.
3511**
3512** 2. Invoke sqlite3_log() to provide the source code location where
3513** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003514*/
daneebf2f52017-11-18 17:30:08 +00003515int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003516 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3517 zType, lineno, 20+sqlite3_sourceid());
3518 return iErr;
3519}
drh9978c972010-02-23 17:36:32 +00003520int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003521 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003522 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003523}
drh9978c972010-02-23 17:36:32 +00003524int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003525 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003526 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003527}
3528int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003529 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003530 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003531}
drh32c49902016-02-15 18:15:15 +00003532#ifdef SQLITE_DEBUG
drhcc97ca42017-06-07 22:32:59 +00003533int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3534 char zMsg[100];
3535 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3536 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003537 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003538}
mistachkinfad30392016-02-13 23:43:46 +00003539int sqlite3NomemError(int lineno){
3540 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003541 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003542}
3543int sqlite3IoerrnomemError(int lineno){
3544 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003545 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003546}
drh32c49902016-02-15 18:15:15 +00003547#endif
drh7c1817e2006-01-10 13:58:48 +00003548
shaneeec556d2008-10-12 00:27:53 +00003549#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003550/*
3551** This is a convenience routine that makes sure that all thread-specific
3552** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003553**
3554** SQLite no longer uses thread-specific data so this routine is now a
3555** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003556*/
3557void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003558}
shaneeec556d2008-10-12 00:27:53 +00003559#endif
danielk1977deb802c2006-02-09 13:43:28 +00003560
3561/*
3562** Return meta information about a specific column of a database table.
3563** See comment in sqlite3.h (sqlite.h.in) for details.
3564*/
danielk1977deb802c2006-02-09 13:43:28 +00003565int sqlite3_table_column_metadata(
3566 sqlite3 *db, /* Connection handle */
3567 const char *zDbName, /* Database name or NULL */
3568 const char *zTableName, /* Table name */
3569 const char *zColumnName, /* Column name */
3570 char const **pzDataType, /* OUTPUT: Declared data type */
3571 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3572 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3573 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003574 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003575){
3576 int rc;
3577 char *zErrMsg = 0;
3578 Table *pTab = 0;
3579 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003580 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003581 char const *zDataType = 0;
3582 char const *zCollSeq = 0;
3583 int notnull = 0;
3584 int primarykey = 0;
3585 int autoinc = 0;
3586
drh96c707a2015-02-13 16:36:14 +00003587
3588#ifdef SQLITE_ENABLE_API_ARMOR
3589 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3590 return SQLITE_MISUSE_BKPT;
3591 }
3592#endif
3593
danielk1977deb802c2006-02-09 13:43:28 +00003594 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003595 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003596 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003597 rc = sqlite3Init(db, &zErrMsg);
3598 if( SQLITE_OK!=rc ){
3599 goto error_out;
3600 }
3601
3602 /* Locate the table in question */
3603 pTab = sqlite3FindTable(db, zTableName, zDbName);
3604 if( !pTab || pTab->pSelect ){
3605 pTab = 0;
3606 goto error_out;
3607 }
3608
3609 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003610 if( zColumnName==0 ){
3611 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003612 }else{
3613 for(iCol=0; iCol<pTab->nCol; iCol++){
3614 pCol = &pTab->aCol[iCol];
3615 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3616 break;
3617 }
3618 }
3619 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003620 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3621 iCol = pTab->iPKey;
3622 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3623 }else{
3624 pTab = 0;
3625 goto error_out;
3626 }
danielk1977deb802c2006-02-09 13:43:28 +00003627 }
3628 }
3629
3630 /* The following block stores the meta information that will be returned
3631 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3632 ** and autoinc. At this point there are two possibilities:
3633 **
3634 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3635 ** and there is no explicitly declared IPK column.
3636 **
3637 ** 2. The table is not a view and the column name identified an
3638 ** explicitly declared column. Copy meta information from *pCol.
3639 */
3640 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003641 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003642 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003643 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003644 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003645 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003646 }else{
3647 zDataType = "INTEGER";
3648 primarykey = 1;
3649 }
3650 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003651 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003652 }
3653
3654error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003655 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003656
3657 /* Whether the function call succeeded or failed, set the output parameters
3658 ** to whatever their local counterparts contain. If an error did occur,
3659 ** this has the effect of zeroing all output parameters.
3660 */
3661 if( pzDataType ) *pzDataType = zDataType;
3662 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3663 if( pNotNull ) *pNotNull = notnull;
3664 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3665 if( pAutoinc ) *pAutoinc = autoinc;
3666
3667 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003668 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003669 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003670 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003671 rc = SQLITE_ERROR;
3672 }
drh13f40da2014-08-22 18:00:11 +00003673 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003674 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003675 rc = sqlite3ApiExit(db, rc);
3676 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003677 return rc;
3678}
3679
3680/*
3681** Sleep for a little while. Return the amount of time slept.
3682*/
3683int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003684 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003685 int rc;
drhd677b3d2007-08-20 22:48:41 +00003686 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003687 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003688
3689 /* This function works in milliseconds, but the underlying OsSleep()
3690 ** API uses microseconds. Hence the 1000's.
3691 */
drhe30f4422007-08-21 16:15:55 +00003692 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003693 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003694}
drh4ac285a2006-09-15 07:28:50 +00003695
3696/*
3697** Enable or disable the extended result codes.
3698*/
3699int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003700#ifdef SQLITE_ENABLE_API_ARMOR
3701 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3702#endif
drhe30f4422007-08-21 16:15:55 +00003703 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003704 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003705 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003706 return SQLITE_OK;
3707}
drhcc6bb3e2007-08-31 16:11:35 +00003708
3709/*
3710** Invoke the xFileControl method on a particular database.
3711*/
3712int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3713 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003714 Btree *pBtree;
3715
drh9ca95732014-10-24 00:35:58 +00003716#ifdef SQLITE_ENABLE_API_ARMOR
3717 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3718#endif
drhcc6bb3e2007-08-31 16:11:35 +00003719 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003720 pBtree = sqlite3DbNameToBtree(db, zDbName);
3721 if( pBtree ){
3722 Pager *pPager;
3723 sqlite3_file *fd;
3724 sqlite3BtreeEnter(pBtree);
3725 pPager = sqlite3BtreePager(pBtree);
3726 assert( pPager!=0 );
3727 fd = sqlite3PagerFile(pPager);
3728 assert( fd!=0 );
3729 if( op==SQLITE_FCNTL_FILE_POINTER ){
3730 *(sqlite3_file**)pArg = fd;
3731 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003732 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3733 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3734 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003735 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3736 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3737 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003738 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3739 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3740 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003741 }else{
drhafb39a42018-03-29 13:47:01 +00003742 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003743 }
drh421377e2012-03-15 21:28:54 +00003744 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003745 }
3746 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003747 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003748}
drhed13d982008-01-31 14:43:24 +00003749
3750/*
3751** Interface to the testing logic.
3752*/
3753int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003754 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003755#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003756 UNUSED_PARAMETER(op);
3757#else
drh2fa18682008-03-19 14:15:34 +00003758 va_list ap;
drhed13d982008-01-31 14:43:24 +00003759 va_start(ap, op);
3760 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003761
3762 /*
drh984bfaa2008-03-19 16:08:53 +00003763 ** Save the current state of the PRNG.
3764 */
drh2fa18682008-03-19 14:15:34 +00003765 case SQLITE_TESTCTRL_PRNG_SAVE: {
3766 sqlite3PrngSaveState();
3767 break;
3768 }
drh984bfaa2008-03-19 16:08:53 +00003769
3770 /*
3771 ** Restore the state of the PRNG to the last state saved using
3772 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3773 ** this verb acts like PRNG_RESET.
3774 */
drh2fa18682008-03-19 14:15:34 +00003775 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3776 sqlite3PrngRestoreState();
3777 break;
3778 }
drh984bfaa2008-03-19 16:08:53 +00003779
3780 /*
3781 ** Reset the PRNG back to its uninitialized state. The next call
3782 ** to sqlite3_randomness() will reseed the PRNG using a single call
3783 ** to the xRandomness method of the default VFS.
3784 */
drh2fa18682008-03-19 14:15:34 +00003785 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003786 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003787 break;
3788 }
drh3088d592008-03-21 16:45:47 +00003789
3790 /*
3791 ** sqlite3_test_control(BITVEC_TEST, size, program)
3792 **
3793 ** Run a test against a Bitvec object of size. The program argument
3794 ** is an array of integers that defines the test. Return -1 on a
3795 ** memory allocation error, 0 on success, or non-zero for an error.
3796 ** See the sqlite3BitvecBuiltinTest() for additional information.
3797 */
3798 case SQLITE_TESTCTRL_BITVEC_TEST: {
3799 int sz = va_arg(ap, int);
3800 int *aProg = va_arg(ap, int*);
3801 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3802 break;
3803 }
danielk19772d1d86f2008-06-20 14:59:51 +00003804
3805 /*
drhc007f612014-05-16 14:17:01 +00003806 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3807 **
3808 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3809 ** if xCallback is not NULL.
3810 **
3811 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3812 ** is called immediately after installing the new callback and the return
3813 ** value from sqlite3FaultSim(0) becomes the return from
3814 ** sqlite3_test_control().
3815 */
3816 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003817 /* MSVC is picky about pulling func ptrs from va lists.
3818 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003819 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003820 */
3821 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003822 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003823 rc = sqlite3FaultSim(0);
3824 break;
3825 }
3826
3827 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003828 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3829 **
3830 ** Register hooks to call to indicate which malloc() failures
3831 ** are benign.
3832 */
3833 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003834 typedef void (*void_function)(void);
3835 void_function xBenignBegin;
3836 void_function xBenignEnd;
3837 xBenignBegin = va_arg(ap, void_function);
3838 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003839 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3840 break;
3841 }
drhc7a3bb92009-02-05 16:31:45 +00003842
3843 /*
drhf3af63f2009-05-09 18:59:42 +00003844 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003845 **
3846 ** Set the PENDING byte to the value in the argument, if X>0.
3847 ** Make no changes if X==0. Return the value of the pending byte
3848 ** as it existing before this routine was called.
3849 **
3850 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3851 ** an incompatible database file format. Changing the PENDING byte
3852 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003853 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003854 */
3855 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003856 rc = PENDING_BYTE;
3857#ifndef SQLITE_OMIT_WSD
3858 {
3859 unsigned int newVal = va_arg(ap, unsigned int);
3860 if( newVal ) sqlite3PendingByte = newVal;
3861 }
3862#endif
drhc7a3bb92009-02-05 16:31:45 +00003863 break;
3864 }
drhf3af63f2009-05-09 18:59:42 +00003865
3866 /*
3867 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3868 **
3869 ** This action provides a run-time test to see whether or not
3870 ** assert() was enabled at compile-time. If X is true and assert()
3871 ** is enabled, then the return value is true. If X is true and
3872 ** assert() is disabled, then the return value is zero. If X is
3873 ** false and assert() is enabled, then the assertion fires and the
3874 ** process aborts. If X is false and assert() is disabled, then the
3875 ** return value is zero.
3876 */
3877 case SQLITE_TESTCTRL_ASSERT: {
3878 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003879 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003880 rc = x;
3881 break;
3882 }
3883
3884
3885 /*
3886 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3887 **
3888 ** This action provides a run-time test to see how the ALWAYS and
3889 ** NEVER macros were defined at compile-time.
3890 **
drhce2c4822017-10-03 17:17:34 +00003891 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00003892 **
3893 ** The recommended test is X==2. If the return value is 2, that means
3894 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3895 ** default setting. If the return value is 1, then ALWAYS() is either
3896 ** hard-coded to true or else it asserts if its argument is false.
3897 ** The first behavior (hard-coded to true) is the case if
3898 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3899 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3900 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3901 **
3902 ** The run-time test procedure might look something like this:
3903 **
3904 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3905 ** // ALWAYS() and NEVER() are no-op pass-through macros
3906 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3907 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3908 ** }else{
3909 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3910 ** }
3911 */
3912 case SQLITE_TESTCTRL_ALWAYS: {
3913 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00003914 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00003915 break;
3916 }
drhc046e3e2009-07-15 11:26:44 +00003917
drh2cf4acb2014-04-18 00:06:02 +00003918 /*
3919 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3920 **
3921 ** The integer returned reveals the byte-order of the computer on which
3922 ** SQLite is running:
3923 **
3924 ** 1 big-endian, determined at run-time
3925 ** 10 little-endian, determined at run-time
3926 ** 432101 big-endian, determined at compile-time
3927 ** 123410 little-endian, determined at compile-time
3928 */
3929 case SQLITE_TESTCTRL_BYTEORDER: {
3930 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3931 break;
3932 }
3933
drhc046e3e2009-07-15 11:26:44 +00003934 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3935 **
3936 ** Set the nReserve size to N for the main database on the database
3937 ** connection db.
3938 */
3939 case SQLITE_TESTCTRL_RESERVE: {
3940 sqlite3 *db = va_arg(ap, sqlite3*);
3941 int x = va_arg(ap,int);
3942 sqlite3_mutex_enter(db->mutex);
3943 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3944 sqlite3_mutex_leave(db->mutex);
3945 break;
3946 }
3947
drh07096f62009-12-22 23:52:32 +00003948 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3949 **
3950 ** Enable or disable various optimizations for testing purposes. The
3951 ** argument N is a bitmask of optimizations to be disabled. For normal
3952 ** operation N should be 0. The idea is that a test program (like the
3953 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3954 ** with various optimizations disabled to verify that the same answer
3955 ** is obtained in every case.
3956 */
3957 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3958 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003959 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003960 break;
3961 }
3962
danc17d6962011-06-21 12:47:30 +00003963 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3964 **
drheea8eb62018-11-26 18:09:15 +00003965 ** If parameter onoff is non-zero, subsequent calls to localtime()
3966 ** and its variants fail. If onoff is zero, undo this setting.
danc17d6962011-06-21 12:47:30 +00003967 */
3968 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3969 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3970 break;
3971 }
3972
drheea8eb62018-11-26 18:09:15 +00003973 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCS, int onoff);
3974 **
3975 ** If parameter onoff is non-zero, internal-use-only SQL functions
3976 ** are visible to ordinary SQL. This is useful for testing but is
3977 ** unsafe because invalid parameters to those internal-use-only functions
3978 ** can result in crashes or segfaults.
3979 */
3980 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
3981 sqlite3GlobalConfig.bInternalFunctions = va_arg(ap, int);
3982 break;
3983 }
3984
drh09fe6142013-11-29 15:06:27 +00003985 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3986 **
3987 ** Set or clear a flag that indicates that the database file is always well-
3988 ** formed and never corrupt. This flag is clear by default, indicating that
3989 ** database files might have arbitrary corruption. Setting the flag during
3990 ** testing causes certain assert() statements in the code to be activated
3991 ** that demonstrat invariants on well-formed database files.
3992 */
3993 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003994 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003995 break;
3996 }
3997
drh9e5eb9c2016-09-18 16:08:10 +00003998 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00003999 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004000 ** too big to test in a reasonable amount of time, so this control is
4001 ** provided to set a small and easily reachable reset value.
4002 */
4003 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4004 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4005 break;
4006 }
drh688852a2014-02-17 22:40:43 +00004007
4008 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4009 **
4010 ** Set the VDBE coverage callback function to xCallback with context
4011 ** pointer ptr.
4012 */
4013 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4014#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00004015 typedef void (*branch_callback)(void*,unsigned int,
4016 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00004017 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4018 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4019#endif
4020 break;
4021 }
4022
dan8930c2a2014-04-03 16:25:29 +00004023 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4024 case SQLITE_TESTCTRL_SORTER_MMAP: {
4025 sqlite3 *db = va_arg(ap, sqlite3*);
4026 db->nMaxSorterMmap = va_arg(ap, int);
4027 break;
4028 }
4029
drh43cfc232014-07-29 14:09:21 +00004030 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4031 **
4032 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4033 ** not.
4034 */
4035 case SQLITE_TESTCTRL_ISINIT: {
4036 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4037 break;
4038 }
drh8964b342015-01-29 17:54:52 +00004039
drh3ba689d2015-03-03 14:00:11 +00004040 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004041 **
drh1ffede82015-01-30 20:59:27 +00004042 ** This test control is used to create imposter tables. "db" is a pointer
4043 ** to the database connection. dbName is the database name (ex: "main" or
4044 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4045 ** or off. "tnum" is the root page of the b-tree to which the imposter
4046 ** table should connect.
4047 **
4048 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004049 ** run a single CREATE TABLE statement to construct the imposter table in
4050 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004051 **
4052 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4053 ** the schema to be reparsed the next time it is needed. This has the
4054 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004055 */
drh1ffede82015-01-30 20:59:27 +00004056 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004057 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004058 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004059 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4060 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004061 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004062 if( db->init.busy==0 && db->init.newTnum>0 ){
4063 sqlite3ResetAllSchemasOfConnection(db);
4064 }
drh8fb15e32015-02-04 20:56:49 +00004065 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004066 break;
4067 }
drh0d9de992017-12-26 18:04:23 +00004068
4069#if defined(YYCOVERAGE)
4070 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4071 **
4072 ** This test control (only available when SQLite is compiled with
4073 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4074 ** state/lookahead combinations in the parser state machine
4075 ** which are never exercised. If any state is missed, make the
4076 ** return code SQLITE_ERROR.
4077 */
4078 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4079 FILE *out = va_arg(ap, FILE*);
4080 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4081 break;
4082 }
4083#endif /* defined(YYCOVERAGE) */
drhed13d982008-01-31 14:43:24 +00004084 }
4085 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004086#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004087 return rc;
drhed13d982008-01-31 14:43:24 +00004088}
drhcc487d12011-05-17 18:53:08 +00004089
4090/*
4091** This is a utility routine, useful to VFS implementations, that checks
4092** to see if a database file was a URI that contained a specific query
4093** parameter, and if so obtains the value of the query parameter.
4094**
4095** The zFilename argument is the filename pointer passed into the xOpen()
4096** method of a VFS implementation. The zParam argument is the name of the
4097** query parameter we seek. This routine returns the value of the zParam
4098** parameter if it exists. If the parameter does not exist, this routine
4099** returns a NULL pointer.
4100*/
4101const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004102 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00004103 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004104 while( zFilename[0] ){
4105 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00004106 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004107 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00004108 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004109 }
4110 return 0;
4111}
drh283829c2011-11-17 00:56:20 +00004112
4113/*
drh92913722011-12-23 00:07:33 +00004114** Return a boolean value for a query parameter.
4115*/
4116int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4117 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004118 bDflt = bDflt!=0;
4119 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004120}
4121
4122/*
4123** Return a 64-bit integer value for a query parameter.
4124*/
4125sqlite3_int64 sqlite3_uri_int64(
4126 const char *zFilename, /* Filename as passed to xOpen */
4127 const char *zParam, /* URI parameter sought */
4128 sqlite3_int64 bDflt /* return if parameter is missing */
4129){
4130 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4131 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004132 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004133 bDflt = v;
4134 }
4135 return bDflt;
4136}
4137
4138/*
drh421377e2012-03-15 21:28:54 +00004139** Return the Btree pointer identified by zDbName. Return NULL if not found.
4140*/
4141Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004142 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4143 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004144}
4145
4146/*
drh283829c2011-11-17 00:56:20 +00004147** Return the filename of the database associated with a database
4148** connection.
4149*/
4150const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004151 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004152#ifdef SQLITE_ENABLE_API_ARMOR
4153 if( !sqlite3SafetyCheckOk(db) ){
4154 (void)SQLITE_MISUSE_BKPT;
4155 return 0;
4156 }
4157#endif
mistachkincd54bab2014-12-20 21:14:14 +00004158 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004159 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4160}
4161
4162/*
4163** Return 1 if database is read-only or 0 if read/write. Return -1 if
4164** no such database exists.
4165*/
4166int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004167 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004168#ifdef SQLITE_ENABLE_API_ARMOR
4169 if( !sqlite3SafetyCheckOk(db) ){
4170 (void)SQLITE_MISUSE_BKPT;
4171 return -1;
4172 }
4173#endif
mistachkincd54bab2014-12-20 21:14:14 +00004174 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004175 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004176}
danfc1acf32015-12-05 20:51:54 +00004177
4178#ifdef SQLITE_ENABLE_SNAPSHOT
4179/*
4180** Obtain a snapshot handle for the snapshot of database zDb currently
4181** being read by handle db.
4182*/
4183int sqlite3_snapshot_get(
4184 sqlite3 *db,
4185 const char *zDb,
4186 sqlite3_snapshot **ppSnapshot
4187){
4188 int rc = SQLITE_ERROR;
4189#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004190
4191#ifdef SQLITE_ENABLE_API_ARMOR
4192 if( !sqlite3SafetyCheckOk(db) ){
4193 return SQLITE_MISUSE_BKPT;
4194 }
4195#endif
4196 sqlite3_mutex_enter(db->mutex);
4197
danedace5d2016-11-18 18:43:39 +00004198 if( db->autoCommit==0 ){
4199 int iDb = sqlite3FindDbName(db, zDb);
4200 if( iDb==0 || iDb>1 ){
4201 Btree *pBt = db->aDb[iDb].pBt;
4202 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004203 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004204 if( rc==SQLITE_OK ){
4205 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4206 }
dan7116dc62015-12-10 20:03:08 +00004207 }
danfc1acf32015-12-05 20:51:54 +00004208 }
4209 }
4210
4211 sqlite3_mutex_leave(db->mutex);
4212#endif /* SQLITE_OMIT_WAL */
4213 return rc;
4214}
4215
4216/*
4217** Open a read-transaction on the snapshot idendified by pSnapshot.
4218*/
4219int sqlite3_snapshot_open(
4220 sqlite3 *db,
4221 const char *zDb,
4222 sqlite3_snapshot *pSnapshot
4223){
4224 int rc = SQLITE_ERROR;
4225#ifndef SQLITE_OMIT_WAL
4226
4227#ifdef SQLITE_ENABLE_API_ARMOR
4228 if( !sqlite3SafetyCheckOk(db) ){
4229 return SQLITE_MISUSE_BKPT;
4230 }
4231#endif
4232 sqlite3_mutex_enter(db->mutex);
4233 if( db->autoCommit==0 ){
4234 int iDb;
4235 iDb = sqlite3FindDbName(db, zDb);
4236 if( iDb==0 || iDb>1 ){
4237 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004238 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4239 Pager *pPager = sqlite3BtreePager(pBt);
4240 int bUnlock = 0;
4241 if( sqlite3BtreeIsInReadTrans(pBt) ){
4242 if( db->nVdbeActive==0 ){
4243 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4244 if( rc==SQLITE_OK ){
4245 bUnlock = 1;
4246 rc = sqlite3BtreeCommit(pBt);
4247 }
4248 }
4249 }else{
4250 rc = SQLITE_OK;
4251 }
4252 if( rc==SQLITE_OK ){
4253 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4254 }
danfc1acf32015-12-05 20:51:54 +00004255 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004256 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danfa3d4c12018-08-06 17:12:36 +00004257 sqlite3PagerSnapshotOpen(pPager, 0);
4258 }
4259 if( bUnlock ){
4260 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004261 }
4262 }
4263 }
4264 }
4265
4266 sqlite3_mutex_leave(db->mutex);
4267#endif /* SQLITE_OMIT_WAL */
4268 return rc;
4269}
4270
4271/*
dan11584982016-11-18 20:49:43 +00004272** Recover as many snapshots as possible from the wal file associated with
4273** schema zDb of database db.
4274*/
4275int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4276 int rc = SQLITE_ERROR;
4277 int iDb;
4278#ifndef SQLITE_OMIT_WAL
4279
4280#ifdef SQLITE_ENABLE_API_ARMOR
4281 if( !sqlite3SafetyCheckOk(db) ){
4282 return SQLITE_MISUSE_BKPT;
4283 }
4284#endif
4285
4286 sqlite3_mutex_enter(db->mutex);
4287 iDb = sqlite3FindDbName(db, zDb);
4288 if( iDb==0 || iDb>1 ){
4289 Btree *pBt = db->aDb[iDb].pBt;
4290 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004291 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004292 if( rc==SQLITE_OK ){
4293 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4294 sqlite3BtreeCommit(pBt);
4295 }
dan11584982016-11-18 20:49:43 +00004296 }
4297 }
4298 sqlite3_mutex_leave(db->mutex);
4299#endif /* SQLITE_OMIT_WAL */
4300 return rc;
4301}
4302
4303/*
danfc1acf32015-12-05 20:51:54 +00004304** Free a snapshot handle obtained from sqlite3_snapshot_get().
4305*/
4306void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4307 sqlite3_free(pSnapshot);
4308}
4309#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004310
4311#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4312/*
4313** Given the name of a compile-time option, return true if that option
4314** was used and false if not.
4315**
4316** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4317** is not required for a match.
4318*/
4319int sqlite3_compileoption_used(const char *zOptName){
4320 int i, n;
4321 int nOpt;
4322 const char **azCompileOpt;
4323
4324#if SQLITE_ENABLE_API_ARMOR
4325 if( zOptName==0 ){
4326 (void)SQLITE_MISUSE_BKPT;
4327 return 0;
4328 }
4329#endif
4330
4331 azCompileOpt = sqlite3CompileOptions(&nOpt);
4332
4333 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4334 n = sqlite3Strlen30(zOptName);
4335
4336 /* Since nOpt is normally in single digits, a linear search is
4337 ** adequate. No need for a binary search. */
4338 for(i=0; i<nOpt; i++){
4339 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4340 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4341 ){
4342 return 1;
4343 }
4344 }
4345 return 0;
4346}
4347
4348/*
4349** Return the N-th compile-time option string. If N is out of range,
4350** return a NULL pointer.
4351*/
4352const char *sqlite3_compileoption_get(int N){
4353 int nOpt;
4354 const char **azCompileOpt;
4355 azCompileOpt = sqlite3CompileOptions(&nOpt);
4356 if( N>=0 && N<nOpt ){
4357 return azCompileOpt[N];
4358 }
4359 return 0;
4360}
4361#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */