blob: 8935a19d757ab89871d5222687ec1d92b38a51b1 [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
drh40257ff2008-06-13 18:24:27 +0000656 default: {
657 rc = SQLITE_ERROR;
658 break;
659 }
660 }
661 va_end(ap);
662 return rc;
663}
664
665/*
drh633e6d52008-07-28 19:34:53 +0000666** Set up the lookaside buffers for a database connection.
667** Return SQLITE_OK on success.
668** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000669**
670** The sz parameter is the number of bytes in each lookaside slot.
671** The cnt parameter is the number of slots. If pStart is NULL the
672** space for the lookaside memory is obtained from sqlite3_malloc().
673** If pStart is not NULL then it is sz*cnt bytes of memory to use for
674** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000675*/
drhe9d1c722008-08-04 20:13:26 +0000676static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000677#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000678 void *pStart;
drh52fb8e12017-08-29 20:21:12 +0000679
680 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000681 return SQLITE_BUSY;
682 }
shanef71f89e2009-01-30 06:11:54 +0000683 /* Free any existing lookaside buffer for this handle before
684 ** allocating a new one so we don't have to have space for
685 ** both at the same time.
686 */
687 if( db->lookaside.bMalloced ){
688 sqlite3_free(db->lookaside.pStart);
689 }
drh61a4bd52011-11-10 02:39:28 +0000690 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
691 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000692 */
drh61a4bd52011-11-10 02:39:28 +0000693 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000694 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000695 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000696 if( sz==0 || cnt==0 ){
697 sz = 0;
698 pStart = 0;
699 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000700 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000701 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000702 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000703 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000704 }else{
705 pStart = pBuf;
706 }
drh4cfb22f2008-08-01 18:47:01 +0000707 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000708 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000709 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000710 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000711 if( pStart ){
712 int i;
713 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000714 assert( sz > (int)sizeof(LookasideSlot*) );
drh52fb8e12017-08-29 20:21:12 +0000715 db->lookaside.nSlot = cnt;
drh633e6d52008-07-28 19:34:53 +0000716 p = (LookasideSlot*)pStart;
717 for(i=cnt-1; i>=0; i--){
drh52fb8e12017-08-29 20:21:12 +0000718 p->pNext = db->lookaside.pInit;
719 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000720 p = (LookasideSlot*)&((u8*)p)[sz];
721 }
722 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000723 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000724 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000725 }else{
drhb0e77042013-12-10 19:49:00 +0000726 db->lookaside.pStart = db;
727 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000728 db->lookaside.bDisable = 1;
shanef71f89e2009-01-30 06:11:54 +0000729 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000730 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000731 }
drh7877d9a2015-07-23 17:16:27 +0000732#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000733 return SQLITE_OK;
734}
735
736/*
drh4413d0e2008-11-04 13:46:27 +0000737** Return the mutex associated with a database connection.
738*/
739sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000740#ifdef SQLITE_ENABLE_API_ARMOR
741 if( !sqlite3SafetyCheckOk(db) ){
742 (void)SQLITE_MISUSE_BKPT;
743 return 0;
744 }
745#endif
drh4413d0e2008-11-04 13:46:27 +0000746 return db->mutex;
747}
748
749/*
drh09419b42011-11-16 19:29:17 +0000750** Free up as much memory as we can from the given database
751** connection.
752*/
753int sqlite3_db_release_memory(sqlite3 *db){
754 int i;
drh9ca95732014-10-24 00:35:58 +0000755
756#ifdef SQLITE_ENABLE_API_ARMOR
757 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
758#endif
dand9bb3a92011-12-30 11:43:59 +0000759 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000760 sqlite3BtreeEnterAll(db);
761 for(i=0; i<db->nDb; i++){
762 Btree *pBt = db->aDb[i].pBt;
763 if( pBt ){
764 Pager *pPager = sqlite3BtreePager(pBt);
765 sqlite3PagerShrink(pPager);
766 }
767 }
768 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000769 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000770 return SQLITE_OK;
771}
772
773/*
dan6fa255f2015-10-28 19:46:57 +0000774** Flush any dirty pages in the pager-cache for any attached database
775** to disk.
776*/
777int sqlite3_db_cacheflush(sqlite3 *db){
778 int i;
779 int rc = SQLITE_OK;
780 int bSeenBusy = 0;
781
782#ifdef SQLITE_ENABLE_API_ARMOR
783 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
784#endif
785 sqlite3_mutex_enter(db->mutex);
786 sqlite3BtreeEnterAll(db);
787 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
788 Btree *pBt = db->aDb[i].pBt;
789 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
790 Pager *pPager = sqlite3BtreePager(pBt);
791 rc = sqlite3PagerFlush(pPager);
792 if( rc==SQLITE_BUSY ){
793 bSeenBusy = 1;
794 rc = SQLITE_OK;
795 }
796 }
797 }
dan6fa255f2015-10-28 19:46:57 +0000798 sqlite3BtreeLeaveAll(db);
799 sqlite3_mutex_leave(db->mutex);
800 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
801}
802
803/*
drh633e6d52008-07-28 19:34:53 +0000804** Configuration settings for an individual database connection
805*/
806int sqlite3_db_config(sqlite3 *db, int op, ...){
807 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000808 int rc;
drh633e6d52008-07-28 19:34:53 +0000809 va_start(ap, op);
810 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000811 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000812 /* IMP: R-06824-28531 */
813 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000814 db->aDb[0].zDbSName = va_arg(ap,char*);
815 rc = SQLITE_OK;
816 break;
817 }
drhe9d1c722008-08-04 20:13:26 +0000818 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000819 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000820 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
821 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000822 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000823 break;
824 }
drh6480aad2008-08-01 16:31:14 +0000825 default: {
drhe83cafd2011-03-21 17:15:58 +0000826 static const struct {
827 int op; /* The opcode */
828 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
829 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000830 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
831 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
832 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000833 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000834 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000835 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000836 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000837 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drhe83cafd2011-03-21 17:15:58 +0000838 };
drh58ad5802011-03-23 22:02:23 +0000839 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000840 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000841 for(i=0; i<ArraySize(aFlagOp); i++){
842 if( aFlagOp[i].op==op ){
843 int onoff = va_arg(ap, int);
844 int *pRes = va_arg(ap, int*);
mistachkinf6285fa2017-07-28 22:13:26 +0000845 u32 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000846 if( onoff>0 ){
847 db->flags |= aFlagOp[i].mask;
848 }else if( onoff==0 ){
849 db->flags &= ~aFlagOp[i].mask;
850 }
851 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000852 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000853 }
854 if( pRes ){
855 *pRes = (db->flags & aFlagOp[i].mask)!=0;
856 }
857 rc = SQLITE_OK;
858 break;
859 }
860 }
drh6480aad2008-08-01 16:31:14 +0000861 break;
862 }
drh633e6d52008-07-28 19:34:53 +0000863 }
864 va_end(ap);
865 return rc;
866}
867
drha16313e2007-03-30 11:29:32 +0000868
869/*
drh9b5adfa2008-01-20 23:19:56 +0000870** Return true if the buffer z[0..n-1] contains all spaces.
871*/
872static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000873 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000874 return n==0;
875}
876
877/*
drhd3d39e92004-05-20 22:16:29 +0000878** This is the default collating function named "BINARY" which is always
879** available.
drh9b5adfa2008-01-20 23:19:56 +0000880**
881** If the padFlag argument is not NULL then space padding at the end
882** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000883*/
danielk19772c336542005-01-13 02:14:23 +0000884static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000885 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000886 int nKey1, const void *pKey1,
887 int nKey2, const void *pKey2
888){
889 int rc, n;
890 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000891 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
892 ** strings byte by byte using the memcmp() function from the standard C
893 ** library. */
dan21766c02017-05-22 08:04:09 +0000894 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +0000895 rc = memcmp(pKey1, pKey2, n);
896 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000897 if( padFlag
898 && allSpaces(((char*)pKey1)+n, nKey1-n)
899 && allSpaces(((char*)pKey2)+n, nKey2-n)
900 ){
drh5e3b49b2014-11-20 19:22:26 +0000901 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
902 ** spaces at the end of either string do not change the result. In other
903 ** words, strings will compare equal to one another as long as they
904 ** differ only in the number of spaces at the end.
905 */
drh9b5adfa2008-01-20 23:19:56 +0000906 }else{
907 rc = nKey1 - nKey2;
908 }
drhd3d39e92004-05-20 22:16:29 +0000909 }
910 return rc;
911}
912
913/*
drhbcd15932018-07-27 18:12:40 +0000914** Return true if CollSeq is the default built-in BINARY.
915*/
916int sqlite3IsBinary(const CollSeq *p){
917 assert( p==0 || p->xCmp!=binCollFunc || p->pUser!=0
918 || strcmp(p->zName,"BINARY")==0 );
919 return p==0 || (p->xCmp==binCollFunc && p->pUser==0);
920}
921
922/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000923** Another built-in collating sequence: NOCASE.
924**
drhf7b54962013-05-28 12:11:54 +0000925** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000926** comparison". SQLite's knowledge of upper and lower case equivalents
927** extends only to the 26 characters used in the English language.
928**
929** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000930*/
931static int nocaseCollatingFunc(
932 void *NotUsed,
933 int nKey1, const void *pKey1,
934 int nKey2, const void *pKey2
935){
936 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000937 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000938 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000939 if( 0==r ){
940 r = nKey1-nKey2;
941 }
942 return r;
943}
944
945/*
drhaf9ff332002-01-16 21:00:27 +0000946** Return the ROWID of the most recent insert
947*/
drh9bb575f2004-09-06 17:24:11 +0000948sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000949#ifdef SQLITE_ENABLE_API_ARMOR
950 if( !sqlite3SafetyCheckOk(db) ){
951 (void)SQLITE_MISUSE_BKPT;
952 return 0;
953 }
954#endif
drhaf9ff332002-01-16 21:00:27 +0000955 return db->lastRowid;
956}
957
958/*
dan9c58b632017-02-27 14:52:48 +0000959** Set the value returned by the sqlite3_last_insert_rowid() API function.
960*/
961void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
962#ifdef SQLITE_ENABLE_API_ARMOR
963 if( !sqlite3SafetyCheckOk(db) ){
964 (void)SQLITE_MISUSE_BKPT;
965 return;
966 }
967#endif
968 sqlite3_mutex_enter(db->mutex);
969 db->lastRowid = iRowid;
970 sqlite3_mutex_leave(db->mutex);
971}
972
973/*
danielk197724b03fd2004-05-10 10:34:34 +0000974** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000975*/
drh9bb575f2004-09-06 17:24:11 +0000976int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000977#ifdef SQLITE_ENABLE_API_ARMOR
978 if( !sqlite3SafetyCheckOk(db) ){
979 (void)SQLITE_MISUSE_BKPT;
980 return 0;
981 }
982#endif
drhc8d30ac2002-04-12 10:08:59 +0000983 return db->nChange;
984}
985
rdcf146a772004-02-25 22:51:06 +0000986/*
danielk1977b28af712004-06-21 06:50:26 +0000987** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000988*/
danielk1977b28af712004-06-21 06:50:26 +0000989int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000990#ifdef SQLITE_ENABLE_API_ARMOR
991 if( !sqlite3SafetyCheckOk(db) ){
992 (void)SQLITE_MISUSE_BKPT;
993 return 0;
994 }
995#endif
danielk1977b28af712004-06-21 06:50:26 +0000996 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000997}
998
drhc8d30ac2002-04-12 10:08:59 +0000999/*
danielk1977fd7f0452008-12-17 17:30:26 +00001000** Close all open savepoints. This function only manipulates fields of the
1001** database handle object, it does not close any savepoints that may be open
1002** at the b-tree/pager level.
1003*/
1004void sqlite3CloseSavepoints(sqlite3 *db){
1005 while( db->pSavepoint ){
1006 Savepoint *pTmp = db->pSavepoint;
1007 db->pSavepoint = pTmp->pNext;
1008 sqlite3DbFree(db, pTmp);
1009 }
1010 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001011 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001012 db->isTransactionSavepoint = 0;
1013}
1014
1015/*
dand2199f02010-08-27 17:48:52 +00001016** Invoke the destructor function associated with FuncDef p, if any. Except,
1017** if this is not the last copy of the function, do not invoke it. Multiple
1018** copies of a single function are created when create_function() is called
1019** with SQLITE_ANY as the encoding.
1020*/
1021static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001022 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001023 if( pDestructor ){
1024 pDestructor->nRef--;
1025 if( pDestructor->nRef==0 ){
1026 pDestructor->xDestroy(pDestructor->pUserData);
1027 sqlite3DbFree(db, pDestructor);
1028 }
1029 }
1030}
1031
1032/*
danbba02a92012-05-15 17:15:34 +00001033** Disconnect all sqlite3_vtab objects that belong to database connection
1034** db. This is called when db is being closed.
1035*/
1036static void disconnectAllVtab(sqlite3 *db){
1037#ifndef SQLITE_OMIT_VIRTUALTABLE
1038 int i;
drh51be3872015-08-19 02:32:25 +00001039 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001040 sqlite3BtreeEnterAll(db);
1041 for(i=0; i<db->nDb; i++){
1042 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001043 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001044 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1045 Table *pTab = (Table *)sqliteHashData(p);
1046 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1047 }
1048 }
1049 }
drh51be3872015-08-19 02:32:25 +00001050 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1051 Module *pMod = (Module *)sqliteHashData(p);
1052 if( pMod->pEpoTab ){
1053 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1054 }
1055 }
dand88e5212014-03-12 19:38:38 +00001056 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001057 sqlite3BtreeLeaveAll(db);
1058#else
1059 UNUSED_PARAMETER(db);
1060#endif
1061}
1062
1063/*
drh167cd6a2012-06-02 17:09:46 +00001064** Return TRUE if database connection db has unfinalized prepared
1065** statements or unfinished sqlite3_backup objects.
1066*/
1067static int connectionIsBusy(sqlite3 *db){
1068 int j;
1069 assert( sqlite3_mutex_held(db->mutex) );
1070 if( db->pVdbe ) return 1;
1071 for(j=0; j<db->nDb; j++){
1072 Btree *pBt = db->aDb[j].pBt;
1073 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1074 }
1075 return 0;
1076}
1077
1078/*
drh50e5dad2001-09-15 00:57:28 +00001079** Close an existing SQLite database
1080*/
drh167cd6a2012-06-02 17:09:46 +00001081static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001082 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001083 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1084 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001085 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001086 }
drh7e8b8482008-01-23 03:03:05 +00001087 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001088 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001089 }
drh605264d2007-08-21 15:13:19 +00001090 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001091 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1092 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1093 }
danielk1977e35ee192004-06-26 09:50:11 +00001094
danbba02a92012-05-15 17:15:34 +00001095 /* Force xDisconnect calls on all virtual tables */
1096 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001097
danbba02a92012-05-15 17:15:34 +00001098 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001099 ** will not have called the xDisconnect() method on any virtual
1100 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1101 ** call will do so. We need to do this before the check for active
1102 ** SQL statements below, as the v-table implementation may be storing
1103 ** some prepared statements internally.
1104 */
dan67430812013-05-15 10:21:50 +00001105 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001106
drh167cd6a2012-06-02 17:09:46 +00001107 /* Legacy behavior (sqlite3_close() behavior) is to return
1108 ** SQLITE_BUSY if the connection can not be closed immediately.
1109 */
1110 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001111 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001112 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001113 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001114 return SQLITE_BUSY;
1115 }
danielk1977e0048402004-06-15 16:51:01 +00001116
danac455932012-11-26 19:50:41 +00001117#ifdef SQLITE_ENABLE_SQLLOG
1118 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001119 /* Closing the handle. Fourth parameter is passed the value 2. */
1120 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001121 }
1122#endif
1123
drh167cd6a2012-06-02 17:09:46 +00001124 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001125 */
1126 db->magic = SQLITE_MAGIC_ZOMBIE;
1127 sqlite3LeaveMutexAndCloseZombie(db);
1128 return SQLITE_OK;
1129}
drh94e92032003-02-16 22:21:32 +00001130
drh167cd6a2012-06-02 17:09:46 +00001131/*
1132** Two variations on the public interface for closing a database
1133** connection. The sqlite3_close() version returns SQLITE_BUSY and
1134** leaves the connection option if there are unfinalized prepared
1135** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1136** version forces the connection to become a zombie if there are
1137** unclosed resources, and arranges for deallocation when the last
1138** prepare statement or sqlite3_backup closes.
1139*/
1140int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1141int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1142
drh4245c402012-06-02 14:32:21 +00001143
1144/*
1145** Close the mutex on database connection db.
1146**
1147** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001148** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1149** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1150** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001151*/
1152void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1153 HashElem *i; /* Hash table iterator */
1154 int j;
1155
drh4245c402012-06-02 14:32:21 +00001156 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001157 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1158 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001159 */
drh167cd6a2012-06-02 17:09:46 +00001160 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001161 sqlite3_mutex_leave(db->mutex);
1162 return;
danielk197704103022009-02-03 16:51:24 +00001163 }
1164
drh4245c402012-06-02 14:32:21 +00001165 /* If we reach this point, it means that the database connection has
1166 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001167 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001168 ** go ahead and free all resources.
1169 */
1170
dan617dc862013-05-16 11:57:28 +00001171 /* If a transaction is open, roll it back. This also ensures that if
1172 ** any database schemas have been modified by an uncommitted transaction
1173 ** they are reset. And that the required b-tree mutex is held to make
1174 ** the pager rollback and schema reset an atomic operation. */
1175 sqlite3RollbackAll(db, SQLITE_OK);
1176
danielk1977fd7f0452008-12-17 17:30:26 +00001177 /* Free any outstanding Savepoint structures. */
1178 sqlite3CloseSavepoints(db);
1179
drh5efb3142012-05-16 01:24:34 +00001180 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001181 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001182 struct Db *pDb = &db->aDb[j];
1183 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001184 sqlite3BtreeClose(pDb->pBt);
1185 pDb->pBt = 0;
1186 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001187 pDb->pSchema = 0;
1188 }
drh113088e2003-03-20 01:16:58 +00001189 }
drhf57b3392001-10-08 13:22:32 +00001190 }
drh5efb3142012-05-16 01:24:34 +00001191 /* Clear the TEMP schema separately and last */
1192 if( db->aDb[1].pSchema ){
1193 sqlite3SchemaClear(db->aDb[1].pSchema);
1194 }
1195 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001196
drh5efb3142012-05-16 01:24:34 +00001197 /* Free up the array of auxiliary databases */
1198 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001199 assert( db->nDb<=2 );
1200 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001201
1202 /* Tell the code in notify.c that the connection no longer holds any
1203 ** locks and does not require any further unlock-notify callbacks.
1204 */
1205 sqlite3ConnectionClosed(db);
1206
drh80738d92016-02-15 00:34:16 +00001207 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1208 FuncDef *pNext, *p;
1209 p = sqliteHashData(i);
1210 do{
1211 functionDestroy(db, p);
1212 pNext = p->pNext;
1213 sqlite3DbFree(db, p);
1214 p = pNext;
1215 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001216 }
drh80738d92016-02-15 00:34:16 +00001217 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001218 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001219 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001220 /* Invoke any destructors registered for collation sequence user data. */
1221 for(j=0; j<3; j++){
1222 if( pColl[j].xDel ){
1223 pColl[j].xDel(pColl[j].pUser);
1224 }
1225 }
drh633e6d52008-07-28 19:34:53 +00001226 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001227 }
danielk1977d8123362004-06-12 09:25:12 +00001228 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001229#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001230 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1231 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001232 if( pMod->xDestroy ){
1233 pMod->xDestroy(pMod->pAux);
1234 }
drh51be3872015-08-19 02:32:25 +00001235 sqlite3VtabEponymousTableClear(db, pMod);
drh633e6d52008-07-28 19:34:53 +00001236 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001237 }
drhb9bb7c12006-06-11 23:41:55 +00001238 sqlite3HashClear(&db->aModule);
1239#endif
danielk1977466be562004-06-10 02:16:01 +00001240
drh13f40da2014-08-22 18:00:11 +00001241 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001242 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001243 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001244#if SQLITE_USER_AUTHENTICATION
1245 sqlite3_free(db->auth.zAuthUser);
1246 sqlite3_free(db->auth.zAuthPW);
1247#endif
danielk197796d81f92004-06-19 03:33:57 +00001248
1249 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001250
1251 /* The temp-database schema is allocated differently from the other schema
1252 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1253 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1254 ** the same sqliteMalloc() as the one that allocates the database
1255 ** structure?
1256 */
drh633e6d52008-07-28 19:34:53 +00001257 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001258 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001259 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001260 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001261 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001262 if( db->lookaside.bMalloced ){
1263 sqlite3_free(db->lookaside.pStart);
1264 }
drh17435752007-08-16 04:30:38 +00001265 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001266}
1267
1268/*
drh0f198a72012-02-13 16:43:16 +00001269** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001270** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001271** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001272** attempts to use that cursor. Read cursors remain open and valid
1273** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001274*/
drh0f198a72012-02-13 16:43:16 +00001275void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001276 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001277 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001278 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001279 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001280 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001281
1282 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1283 ** This is important in case the transaction being rolled back has
1284 ** modified the database schema. If the b-tree mutexes are not taken
1285 ** here, then another shared-cache connection might sneak in between
1286 ** the database rollback and schema reset, which can cause false
1287 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001288 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001289 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001290
drh001bbcb2003-03-19 03:14:00 +00001291 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001292 Btree *p = db->aDb[i].pBt;
1293 if( p ){
1294 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001295 inTrans = 1;
1296 }
drh47b7fc72014-11-11 01:33:57 +00001297 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001298 }
1299 }
danielk1977a298e902006-06-22 09:53:48 +00001300 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001301 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001302
drh7f32dc92018-07-16 11:32:59 +00001303 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001304 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001305 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001306 }
dancd7b91a2013-05-13 18:23:15 +00001307 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001308
dan1da40a32009-09-19 17:00:31 +00001309 /* Any deferred constraint violations have now been resolved. */
1310 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001311 db->nDeferredImmCons = 0;
1312 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001313
danielk197771fd80b2005-12-16 06:54:01 +00001314 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001315 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001316 db->xRollbackCallback(db->pRollbackArg);
1317 }
drh001bbcb2003-03-19 03:14:00 +00001318}
1319
1320/*
mistachkinf2c1c992013-04-28 01:44:43 +00001321** Return a static string containing the name corresponding to the error code
1322** specified in the argument.
1323*/
mistachkin5824d442015-04-28 23:34:10 +00001324#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001325const char *sqlite3ErrName(int rc){
1326 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001327 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001328 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1329 switch( rc ){
1330 case SQLITE_OK: zName = "SQLITE_OK"; break;
1331 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001332 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001333 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1334 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1335 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001336 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001337 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001338 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001339 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001340 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1341 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1342 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1343 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001344 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001345 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001346 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001347 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001348 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001349 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1350 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001351 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1352 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1353 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1354 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1355 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1356 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1357 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1358 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1359 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1360 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001361 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1362 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1363 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1364 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1365 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1366 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1367 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1368 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1369 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1370 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1371 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1372 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1373 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1374 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001375 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001376 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001377 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001378 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001379 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1380 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1381 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001382 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1383 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1384 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001385 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001386 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1387 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1388 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1389 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1390 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1391 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1392 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1393 case SQLITE_CONSTRAINT_FOREIGNKEY:
1394 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1395 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1396 case SQLITE_CONSTRAINT_PRIMARYKEY:
1397 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1398 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1399 case SQLITE_CONSTRAINT_COMMITHOOK:
1400 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1401 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1402 case SQLITE_CONSTRAINT_FUNCTION:
1403 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001404 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001405 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1406 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1407 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1408 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1409 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1410 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1411 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1412 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1413 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001414 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1415 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1416 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001417 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001418 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001419 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001420 }
1421 }
mistachkin10269dc2013-04-30 07:54:42 +00001422 if( zName==0 ){
1423 static char zBuf[50];
1424 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1425 zName = zBuf;
1426 }
mistachkinf2c1c992013-04-28 01:44:43 +00001427 return zName;
1428}
mistachkin10269dc2013-04-30 07:54:42 +00001429#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001430
1431/*
drhc22bd472002-05-10 13:14:07 +00001432** Return a static string that describes the kind of error specified in the
1433** argument.
drh247be432002-05-10 05:44:55 +00001434*/
danielk1977f20b21c2004-05-31 23:56:42 +00001435const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001436 static const char* const aMsg[] = {
1437 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001438 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001439 /* SQLITE_INTERNAL */ 0,
1440 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001441 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001442 /* SQLITE_BUSY */ "database is locked",
1443 /* SQLITE_LOCKED */ "database table is locked",
1444 /* SQLITE_NOMEM */ "out of memory",
1445 /* SQLITE_READONLY */ "attempt to write a readonly database",
1446 /* SQLITE_INTERRUPT */ "interrupted",
1447 /* SQLITE_IOERR */ "disk I/O error",
1448 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001449 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001450 /* SQLITE_FULL */ "database or disk is full",
1451 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001452 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001453 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001454 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001455 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001456 /* SQLITE_CONSTRAINT */ "constraint failed",
1457 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001458 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001459#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001460 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001461#else
1462 /* SQLITE_NOLFS */ 0,
1463#endif
drh51c7d862009-04-27 18:46:06 +00001464 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001465 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001466 /* SQLITE_RANGE */ "column index out of range",
1467 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001468 /* SQLITE_NOTICE */ "notification message",
1469 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001470 };
drh21021a52012-02-13 17:01:51 +00001471 const char *zErr = "unknown error";
1472 switch( rc ){
1473 case SQLITE_ABORT_ROLLBACK: {
1474 zErr = "abort due to ROLLBACK";
1475 break;
1476 }
mistachkin2a861102018-02-08 01:00:11 +00001477 case SQLITE_ROW: {
1478 zErr = "another row available";
1479 break;
1480 }
1481 case SQLITE_DONE: {
1482 zErr = "no more rows available";
1483 break;
1484 }
drh21021a52012-02-13 17:01:51 +00001485 default: {
1486 rc &= 0xff;
1487 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1488 zErr = aMsg[rc];
1489 }
1490 break;
1491 }
drh247be432002-05-10 05:44:55 +00001492 }
drh21021a52012-02-13 17:01:51 +00001493 return zErr;
drh247be432002-05-10 05:44:55 +00001494}
1495
1496/*
drh2dfbbca2000-07-28 14:32:48 +00001497** This routine implements a busy callback that sleeps and tries
1498** again until a timeout value is reached. The timeout value is
1499** an integer number of milliseconds passed in as the first
1500** argument.
drhf0119b22018-03-26 17:40:53 +00001501**
1502** Return non-zero to retry the lock. Return zero to stop trying
1503** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001504*/
drhdaffd0e2001-04-11 14:28:42 +00001505static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001506 void *ptr, /* Database connection */
1507 int count, /* Number of times table has been busy */
1508 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001509){
drh0ede9eb2015-01-10 16:49:23 +00001510#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001511 /* This case is for systems that have support for sleeping for fractions of
1512 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001513 static const u8 delays[] =
1514 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1515 static const u8 totals[] =
1516 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001517# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001518 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001519 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001520 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001521
drhf0119b22018-03-26 17:40:53 +00001522#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1523 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1524 if( count ){
1525 tmout = 0;
1526 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1527 return 0;
1528 }else{
1529 return 1;
1530 }
1531 }
drh5013c4b2018-03-28 21:45:03 +00001532#else
1533 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001534#endif
drhee570fa2005-04-28 12:06:05 +00001535 assert( count>=0 );
1536 if( count < NDELAY ){
1537 delay = delays[count];
1538 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001539 }else{
1540 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001541 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001542 }
drhf0119b22018-03-26 17:40:53 +00001543 if( prior + delay > tmout ){
1544 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001545 if( delay<=0 ) return 0;
1546 }
danielk19772a6bdf62007-08-20 16:07:00 +00001547 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001548 return 1;
1549#else
drhf0119b22018-03-26 17:40:53 +00001550 /* This case for unix systems that lack usleep() support. Sleeping
1551 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001552 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001553 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001554 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001555 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001556 return 0;
1557 }
drh482ea182007-08-20 11:12:40 +00001558 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001559 return 1;
1560#endif
1561}
1562
1563/*
drha4afb652005-07-09 02:16:02 +00001564** Invoke the given busy handler.
1565**
drhf0119b22018-03-26 17:40:53 +00001566** This routine is called when an operation failed to acquire a
1567** lock on VFS file pFile.
1568**
drha4afb652005-07-09 02:16:02 +00001569** If this routine returns non-zero, the lock is retried. If it
1570** returns 0, the operation aborts with an SQLITE_BUSY error.
1571*/
drhf0119b22018-03-26 17:40:53 +00001572int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001573 int rc;
drh80262892018-03-26 16:37:53 +00001574 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001575 if( p->bExtraFileArg ){
1576 /* Add an extra parameter with the pFile pointer to the end of the
1577 ** callback argument list */
1578 int (*xTra)(void*,int,sqlite3_file*);
1579 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1580 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1581 }else{
1582 /* Legacy style busy handler callback */
1583 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1584 }
drha4afb652005-07-09 02:16:02 +00001585 if( rc==0 ){
1586 p->nBusy = -1;
1587 }else{
1588 p->nBusy++;
1589 }
1590 return rc;
1591}
1592
1593/*
drh2dfbbca2000-07-28 14:32:48 +00001594** This routine sets the busy callback for an Sqlite database to the
1595** given callback function with the given argument.
1596*/
danielk1977f9d64d22004-06-19 08:18:07 +00001597int sqlite3_busy_handler(
1598 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001599 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001600 void *pArg
1601){
drh9ca95732014-10-24 00:35:58 +00001602#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001603 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001604#endif
drhe30f4422007-08-21 16:15:55 +00001605 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001606 db->busyHandler.xBusyHandler = xBusy;
1607 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001608 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001609 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001610 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001611 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001612 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001613}
1614
danielk1977348bb5d2003-10-18 09:37:26 +00001615#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1616/*
1617** This routine sets the progress callback for an Sqlite database to the
1618** given callback function with the given argument. The progress callback will
1619** be invoked every nOps opcodes.
1620*/
danielk197724b03fd2004-05-10 10:34:34 +00001621void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001622 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001623 int nOps,
1624 int (*xProgress)(void*),
1625 void *pArg
1626){
drh9ca95732014-10-24 00:35:58 +00001627#ifdef SQLITE_ENABLE_API_ARMOR
1628 if( !sqlite3SafetyCheckOk(db) ){
1629 (void)SQLITE_MISUSE_BKPT;
1630 return;
1631 }
1632#endif
drhbd0b1b52008-07-07 19:52:09 +00001633 sqlite3_mutex_enter(db->mutex);
1634 if( nOps>0 ){
1635 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001636 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001637 db->pProgressArg = pArg;
1638 }else{
1639 db->xProgress = 0;
1640 db->nProgressOps = 0;
1641 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001642 }
drhbd0b1b52008-07-07 19:52:09 +00001643 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001644}
1645#endif
1646
1647
drh2dfbbca2000-07-28 14:32:48 +00001648/*
1649** This routine installs a default busy handler that waits for the
1650** specified number of milliseconds before returning 0.
1651*/
danielk1977f9d64d22004-06-19 08:18:07 +00001652int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001653#ifdef SQLITE_ENABLE_API_ARMOR
1654 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1655#endif
drh2dfbbca2000-07-28 14:32:48 +00001656 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001657 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1658 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001659 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001660 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001661 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001662 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001663 }
danielk1977f9d64d22004-06-19 08:18:07 +00001664 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001665}
drh4c504392000-10-16 22:06:40 +00001666
1667/*
1668** Cause any pending operation to stop at its earliest opportunity.
1669*/
drh9bb575f2004-09-06 17:24:11 +00001670void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001671#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001672 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001673 (void)SQLITE_MISUSE_BKPT;
1674 return;
1675 }
1676#endif
drhbd0b1b52008-07-07 19:52:09 +00001677 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001678}
drhfa86c412002-02-02 15:01:15 +00001679
drhfa86c412002-02-02 15:01:15 +00001680
1681/*
danielk1977771151b2006-01-17 13:21:40 +00001682** This function is exactly the same as sqlite3_create_function(), except
1683** that it is designed to be called by internal code. The difference is
1684** that if a malloc() fails in sqlite3_create_function(), an error code
1685** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001686*/
danielk1977771151b2006-01-17 13:21:40 +00001687int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001688 sqlite3 *db,
1689 const char *zFunctionName,
1690 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001691 int enc,
danielk197765904932004-05-26 06:18:37 +00001692 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001693 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001694 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001695 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001696 void (*xValue)(sqlite3_context*),
1697 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001698 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001699){
drh0bce8352002-02-28 00:41:10 +00001700 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001701 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001702 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001703
drhe30f4422007-08-21 16:15:55 +00001704 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001705 assert( xValue==0 || xSFunc==0 );
1706 if( zFunctionName==0 /* Must have a valid name */
1707 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1708 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1709 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1710 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1711 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1712 ){
drh413c3d32010-02-23 20:11:56 +00001713 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001714 }
drh4a8ee3d2013-12-14 13:44:22 +00001715
1716 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1717 extraFlags = enc & SQLITE_DETERMINISTIC;
1718 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001719
danielk197793758c82005-01-21 08:13:14 +00001720#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001721 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1722 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1723 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1724 **
1725 ** If SQLITE_ANY is specified, add three versions of the function
1726 ** to the hash table.
1727 */
1728 if( enc==SQLITE_UTF16 ){
1729 enc = SQLITE_UTF16NATIVE;
1730 }else if( enc==SQLITE_ANY ){
1731 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001732 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dan660af932018-06-18 16:55:22 +00001733 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001734 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001735 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dan660af932018-06-18 16:55:22 +00001736 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001737 }
1738 if( rc!=SQLITE_OK ){
1739 return rc;
1740 }
danielk1977d8123362004-06-12 09:25:12 +00001741 enc = SQLITE_UTF16BE;
1742 }
danielk197793758c82005-01-21 08:13:14 +00001743#else
1744 enc = SQLITE_UTF8;
1745#endif
danielk19779636c4e2005-01-25 04:27:54 +00001746
1747 /* Check if an existing function is being overridden or deleted. If so,
1748 ** and there are active VMs, then return SQLITE_BUSY. If a function
1749 ** is being overridden/deleted but there are no active VMs, allow the
1750 ** operation to continue but invalidate all precompiled statements.
1751 */
drh80738d92016-02-15 00:34:16 +00001752 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001753 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001754 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001755 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001756 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001757 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001758 return SQLITE_BUSY;
1759 }else{
drhba968db2018-07-24 22:02:12 +00001760 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001761 }
1762 }
danielk197765904932004-05-26 06:18:37 +00001763
drh80738d92016-02-15 00:34:16 +00001764 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001765 assert(p || db->mallocFailed);
1766 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001767 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001768 }
dand2199f02010-08-27 17:48:52 +00001769
1770 /* If an older version of the function with a configured destructor is
1771 ** being replaced invoke the destructor function here. */
1772 functionDestroy(db, p);
1773
1774 if( pDestructor ){
1775 pDestructor->nRef++;
1776 }
drh80738d92016-02-15 00:34:16 +00001777 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001778 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1779 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh2d801512016-01-14 22:19:58 +00001780 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001781 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001782 p->xValue = xValue;
1783 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001784 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001785 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001786 return SQLITE_OK;
1787}
danielk1977771151b2006-01-17 13:21:40 +00001788
1789/*
dan660af932018-06-18 16:55:22 +00001790** Worker function used by utf-8 APIs that create new functions:
1791**
1792** sqlite3_create_function()
1793** sqlite3_create_function_v2()
1794** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001795*/
dan660af932018-06-18 16:55:22 +00001796static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001797 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001798 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001799 int nArg,
1800 int enc,
1801 void *p,
dan660af932018-06-18 16:55:22 +00001802 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1803 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001804 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001805 void (*xValue)(sqlite3_context*),
1806 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1807 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001808){
shanehbd2aaf92010-09-01 02:38:21 +00001809 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001810 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001811
1812#ifdef SQLITE_ENABLE_API_ARMOR
1813 if( !sqlite3SafetyCheckOk(db) ){
1814 return SQLITE_MISUSE_BKPT;
1815 }
1816#endif
dand2199f02010-08-27 17:48:52 +00001817 sqlite3_mutex_enter(db->mutex);
1818 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001819 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001820 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001821 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001822 xDestroy(p);
1823 goto out;
1824 }
drh92011842018-05-26 16:00:26 +00001825 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001826 pArg->xDestroy = xDestroy;
1827 pArg->pUserData = p;
1828 }
dan660af932018-06-18 16:55:22 +00001829 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1830 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1831 );
dand2199f02010-08-27 17:48:52 +00001832 if( pArg && pArg->nRef==0 ){
1833 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001834 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001835 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001836 }
1837
1838 out:
drhe30f4422007-08-21 16:15:55 +00001839 rc = sqlite3ApiExit(db, rc);
1840 sqlite3_mutex_leave(db->mutex);
1841 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001842}
1843
dan660af932018-06-18 16:55:22 +00001844/*
1845** Create new user functions.
1846*/
1847int sqlite3_create_function(
1848 sqlite3 *db,
1849 const char *zFunc,
1850 int nArg,
1851 int enc,
1852 void *p,
1853 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1854 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1855 void (*xFinal)(sqlite3_context*)
1856){
1857 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1858 xFinal, 0, 0, 0);
1859}
1860int sqlite3_create_function_v2(
1861 sqlite3 *db,
1862 const char *zFunc,
1863 int nArg,
1864 int enc,
1865 void *p,
1866 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1867 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1868 void (*xFinal)(sqlite3_context*),
1869 void (*xDestroy)(void *)
1870){
1871 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1872 xFinal, 0, 0, xDestroy);
1873}
1874int sqlite3_create_window_function(
1875 sqlite3 *db,
1876 const char *zFunc,
1877 int nArg,
1878 int enc,
1879 void *p,
1880 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1881 void (*xFinal)(sqlite3_context*),
1882 void (*xValue)(sqlite3_context*),
1883 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1884 void (*xDestroy)(void *)
1885){
1886 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1887 xFinal, xValue, xInverse, xDestroy);
1888}
1889
danielk197793758c82005-01-21 08:13:14 +00001890#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001891int sqlite3_create_function16(
1892 sqlite3 *db,
1893 const void *zFunctionName,
1894 int nArg,
1895 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001896 void *p,
drh2d801512016-01-14 22:19:58 +00001897 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001898 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1899 void (*xFinal)(sqlite3_context*)
1900){
1901 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001902 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001903
1904#ifdef SQLITE_ENABLE_API_ARMOR
1905 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1906#endif
drhe30f4422007-08-21 16:15:55 +00001907 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001908 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001909 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00001910 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00001911 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001912 rc = sqlite3ApiExit(db, rc);
1913 sqlite3_mutex_leave(db->mutex);
1914 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001915}
danielk197793758c82005-01-21 08:13:14 +00001916#endif
drhc9b84a12002-06-20 11:36:48 +00001917
drhb7481e72006-09-16 21:45:14 +00001918
1919/*
drh92011842018-05-26 16:00:26 +00001920** The following is the implementation of an SQL function that always
1921** fails with an error message stating that the function is used in the
1922** wrong context. The sqlite3_overload_function() API might construct
1923** SQL function that use this routine so that the functions will exist
1924** for name resolution but are actually overloaded by the xFindFunction
1925** method of virtual tables.
1926*/
1927static void sqlite3InvalidFunction(
1928 sqlite3_context *context, /* The function calling context */
1929 int NotUsed, /* Number of arguments to the function */
1930 sqlite3_value **NotUsed2 /* Value of each argument */
1931){
1932 const char *zName = (const char*)sqlite3_user_data(context);
1933 char *zErr;
1934 UNUSED_PARAMETER2(NotUsed, NotUsed2);
1935 zErr = sqlite3_mprintf(
1936 "unable to use function %s in the requested context", zName);
1937 sqlite3_result_error(context, zErr, -1);
1938 sqlite3_free(zErr);
1939}
1940
1941/*
drhb7481e72006-09-16 21:45:14 +00001942** Declare that a function has been overloaded by a virtual table.
1943**
1944** If the function already exists as a regular global function, then
1945** this routine is a no-op. If the function does not exist, then create
1946** a new one that always throws a run-time error.
1947**
1948** When virtual tables intend to provide an overloaded function, they
1949** should call this routine to make sure the global function exists.
1950** A global function must exist in order for name resolution to work
1951** properly.
1952*/
1953int sqlite3_overload_function(
1954 sqlite3 *db,
1955 const char *zName,
1956 int nArg
1957){
drh92011842018-05-26 16:00:26 +00001958 int rc;
1959 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00001960
1961#ifdef SQLITE_ENABLE_API_ARMOR
1962 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1963 return SQLITE_MISUSE_BKPT;
1964 }
1965#endif
drhe30f4422007-08-21 16:15:55 +00001966 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00001967 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00001968 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00001969 if( rc ) return SQLITE_OK;
1970 zCopy = sqlite3_mprintf(zName);
1971 if( zCopy==0 ) return SQLITE_NOMEM;
1972 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
1973 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00001974}
1975
drh19e2d372005-08-29 23:00:03 +00001976#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001977/*
drh18de4822003-01-16 16:28:53 +00001978** Register a trace function. The pArg from the previously registered trace
1979** is returned.
1980**
1981** A NULL trace function means that no tracing is executes. A non-NULL
1982** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001983** SQL statement.
drh18de4822003-01-16 16:28:53 +00001984*/
drh3d2a5292016-07-13 22:55:01 +00001985#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00001986void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001987 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001988
1989#ifdef SQLITE_ENABLE_API_ARMOR
1990 if( !sqlite3SafetyCheckOk(db) ){
1991 (void)SQLITE_MISUSE_BKPT;
1992 return 0;
1993 }
1994#endif
drhe30f4422007-08-21 16:15:55 +00001995 sqlite3_mutex_enter(db->mutex);
1996 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00001997 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00001998 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00001999 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002000 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002001 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002002}
drh3d2a5292016-07-13 22:55:01 +00002003#endif /* SQLITE_OMIT_DEPRECATED */
2004
2005/* Register a trace callback using the version-2 interface.
2006*/
2007int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002008 sqlite3 *db, /* Trace this connection */
2009 unsigned mTrace, /* Mask of events to be traced */
2010 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2011 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002012){
2013#ifdef SQLITE_ENABLE_API_ARMOR
2014 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002015 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002016 }
2017#endif
2018 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002019 if( mTrace==0 ) xTrace = 0;
2020 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002021 db->mTrace = mTrace;
2022 db->xTrace = xTrace;
2023 db->pTraceArg = pArg;
2024 sqlite3_mutex_leave(db->mutex);
2025 return SQLITE_OK;
2026}
2027
drh087ec072016-07-25 00:05:56 +00002028#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002029/*
2030** Register a profile function. The pArg from the previously registered
2031** profile function is returned.
2032**
2033** A NULL profile function means that no profiling is executes. A non-NULL
2034** profile is a pointer to a function that is invoked at the conclusion of
2035** each SQL statement that is run.
2036*/
2037void *sqlite3_profile(
2038 sqlite3 *db,
2039 void (*xProfile)(void*,const char*,sqlite_uint64),
2040 void *pArg
2041){
drhe30f4422007-08-21 16:15:55 +00002042 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002043
2044#ifdef SQLITE_ENABLE_API_ARMOR
2045 if( !sqlite3SafetyCheckOk(db) ){
2046 (void)SQLITE_MISUSE_BKPT;
2047 return 0;
2048 }
2049#endif
drhe30f4422007-08-21 16:15:55 +00002050 sqlite3_mutex_enter(db->mutex);
2051 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002052 db->xProfile = xProfile;
2053 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002054 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002055 return pOld;
2056}
drh087ec072016-07-25 00:05:56 +00002057#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002058#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002059
drhcd565fd2012-03-01 21:30:44 +00002060/*
2061** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002062** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002063** rollback.
2064*/
danielk197724b03fd2004-05-10 10:34:34 +00002065void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002066 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002067 int (*xCallback)(void*), /* Function to invoke on each commit */
2068 void *pArg /* Argument to the function */
2069){
drhe30f4422007-08-21 16:15:55 +00002070 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002071
2072#ifdef SQLITE_ENABLE_API_ARMOR
2073 if( !sqlite3SafetyCheckOk(db) ){
2074 (void)SQLITE_MISUSE_BKPT;
2075 return 0;
2076 }
2077#endif
drhe30f4422007-08-21 16:15:55 +00002078 sqlite3_mutex_enter(db->mutex);
2079 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002080 db->xCommitCallback = xCallback;
2081 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002082 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002083 return pOld;
2084}
2085
danielk197794eb6a12005-12-15 15:22:08 +00002086/*
2087** Register a callback to be invoked each time a row is updated,
2088** inserted or deleted using this database connection.
2089*/
danielk197771fd80b2005-12-16 06:54:01 +00002090void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002091 sqlite3 *db, /* Attach the hook to this database */
2092 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2093 void *pArg /* Argument to the function */
2094){
drhe30f4422007-08-21 16:15:55 +00002095 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002096
2097#ifdef SQLITE_ENABLE_API_ARMOR
2098 if( !sqlite3SafetyCheckOk(db) ){
2099 (void)SQLITE_MISUSE_BKPT;
2100 return 0;
2101 }
2102#endif
drhe30f4422007-08-21 16:15:55 +00002103 sqlite3_mutex_enter(db->mutex);
2104 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002105 db->xUpdateCallback = xCallback;
2106 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002107 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002108 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002109}
2110
danielk197771fd80b2005-12-16 06:54:01 +00002111/*
2112** Register a callback to be invoked each time a transaction is rolled
2113** back by this database connection.
2114*/
2115void *sqlite3_rollback_hook(
2116 sqlite3 *db, /* Attach the hook to this database */
2117 void (*xCallback)(void*), /* Callback function */
2118 void *pArg /* Argument to the function */
2119){
drhe30f4422007-08-21 16:15:55 +00002120 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002121
2122#ifdef SQLITE_ENABLE_API_ARMOR
2123 if( !sqlite3SafetyCheckOk(db) ){
2124 (void)SQLITE_MISUSE_BKPT;
2125 return 0;
2126 }
2127#endif
drhe30f4422007-08-21 16:15:55 +00002128 sqlite3_mutex_enter(db->mutex);
2129 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002130 db->xRollbackCallback = xCallback;
2131 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002132 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002133 return pRet;
2134}
drhaa940ea2004-01-15 02:44:03 +00002135
drh9b1c62d2011-03-30 21:04:43 +00002136#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002137/*
2138** Register a callback to be invoked each time a row is updated,
2139** inserted or deleted using this database connection.
2140*/
2141void *sqlite3_preupdate_hook(
2142 sqlite3 *db, /* Attach the hook to this database */
2143 void(*xCallback)( /* Callback function */
2144 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2145 void *pArg /* First callback argument */
2146){
2147 void *pRet;
2148 sqlite3_mutex_enter(db->mutex);
2149 pRet = db->pPreUpdateArg;
2150 db->xPreUpdateCallback = xCallback;
2151 db->pPreUpdateArg = pArg;
2152 sqlite3_mutex_leave(db->mutex);
2153 return pRet;
2154}
drh9b1c62d2011-03-30 21:04:43 +00002155#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002156
dan586b9c82010-05-03 08:04:49 +00002157#ifndef SQLITE_OMIT_WAL
2158/*
2159** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002160** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2161** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002162** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002163*/
drhb033d8b2010-05-03 13:37:30 +00002164int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002165 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002166 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002167 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002168 int nFrame /* Size of WAL */
2169){
drh5def0842010-05-05 20:00:25 +00002170 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002171 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002172 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002173 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002174 }
2175 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002176}
drhb033d8b2010-05-03 13:37:30 +00002177#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002178
2179/*
2180** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2181** a database after committing a transaction if there are nFrame or
2182** more frames in the log file. Passing zero or a negative value as the
2183** nFrame parameter disables automatic checkpoints entirely.
2184**
2185** The callback registered by this function replaces any existing callback
2186** registered using sqlite3_wal_hook(). Likewise, registering a callback
2187** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2188** configured by this function.
2189*/
2190int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002191#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002192 UNUSED_PARAMETER(db);
2193 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002194#else
drh9ca95732014-10-24 00:35:58 +00002195#ifdef SQLITE_ENABLE_API_ARMOR
2196 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2197#endif
dan586b9c82010-05-03 08:04:49 +00002198 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002199 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002200 }else{
2201 sqlite3_wal_hook(db, 0, 0);
2202 }
drhb033d8b2010-05-03 13:37:30 +00002203#endif
dan586b9c82010-05-03 08:04:49 +00002204 return SQLITE_OK;
2205}
2206
paulb0208cc2003-04-13 18:26:49 +00002207/*
dan8d22a172010-04-19 18:03:51 +00002208** Register a callback to be invoked each time a transaction is written
2209** into the write-ahead-log by this database connection.
2210*/
drh833bf962010-04-28 14:42:19 +00002211void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002212 sqlite3 *db, /* Attach the hook to this db handle */
2213 int(*xCallback)(void *, sqlite3*, const char*, int),
2214 void *pArg /* First argument passed to xCallback() */
2215){
drhb033d8b2010-05-03 13:37:30 +00002216#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002217 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002218#ifdef SQLITE_ENABLE_API_ARMOR
2219 if( !sqlite3SafetyCheckOk(db) ){
2220 (void)SQLITE_MISUSE_BKPT;
2221 return 0;
2222 }
2223#endif
dan8d22a172010-04-19 18:03:51 +00002224 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002225 pRet = db->pWalArg;
2226 db->xWalCallback = xCallback;
2227 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002228 sqlite3_mutex_leave(db->mutex);
2229 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002230#else
2231 return 0;
2232#endif
dan8d22a172010-04-19 18:03:51 +00002233}
2234
2235/*
dancdc1f042010-11-18 12:11:05 +00002236** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002237*/
dancdc1f042010-11-18 12:11:05 +00002238int sqlite3_wal_checkpoint_v2(
2239 sqlite3 *db, /* Database handle */
2240 const char *zDb, /* Name of attached database (or NULL) */
2241 int eMode, /* SQLITE_CHECKPOINT_* value */
2242 int *pnLog, /* OUT: Size of WAL log in frames */
2243 int *pnCkpt /* OUT: Total number of frames checkpointed */
2244){
drhb033d8b2010-05-03 13:37:30 +00002245#ifdef SQLITE_OMIT_WAL
2246 return SQLITE_OK;
2247#else
dan586b9c82010-05-03 08:04:49 +00002248 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002249 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002250
drh9ca95732014-10-24 00:35:58 +00002251#ifdef SQLITE_ENABLE_API_ARMOR
2252 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2253#endif
2254
dan9c5e3682011-02-07 15:12:12 +00002255 /* Initialize the output variables to -1 in case an error occurs. */
2256 if( pnLog ) *pnLog = -1;
2257 if( pnCkpt ) *pnCkpt = -1;
2258
danf26a1542014-12-02 19:04:54 +00002259 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2260 assert( SQLITE_CHECKPOINT_FULL==1 );
2261 assert( SQLITE_CHECKPOINT_RESTART==2 );
2262 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2263 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002264 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2265 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002266 return SQLITE_MISUSE;
2267 }
2268
dan586b9c82010-05-03 08:04:49 +00002269 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002270 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002271 iDb = sqlite3FindDbName(db, zDb);
2272 }
2273 if( iDb<0 ){
2274 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002275 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002276 }else{
dan976b0032015-01-29 19:12:12 +00002277 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002278 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002279 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002280 }
drhb033d8b2010-05-03 13:37:30 +00002281 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002282
2283 /* If there are no active statements, clear the interrupt flag at this
2284 ** point. */
2285 if( db->nVdbeActive==0 ){
2286 db->u1.isInterrupted = 0;
2287 }
2288
dan586b9c82010-05-03 08:04:49 +00002289 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002290 return rc;
2291#endif
dan586b9c82010-05-03 08:04:49 +00002292}
2293
dancdc1f042010-11-18 12:11:05 +00002294
2295/*
2296** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2297** to contains a zero-length string, all attached databases are
2298** checkpointed.
2299*/
2300int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002301 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2302 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2303 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002304}
2305
drhb033d8b2010-05-03 13:37:30 +00002306#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002307/*
2308** Run a checkpoint on database iDb. This is a no-op if database iDb is
2309** not currently open in WAL mode.
2310**
dan6fcff072010-05-03 14:05:43 +00002311** If a transaction is open on the database being checkpointed, this
2312** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2313** an error occurs while running the checkpoint, an SQLite error code is
2314** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002315**
2316** The mutex on database handle db should be held by the caller. The mutex
2317** associated with the specific b-tree being checkpointed is taken by
2318** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002319**
2320** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2321** checkpointed. If an error is encountered it is returned immediately -
2322** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002323**
dan78345512017-09-08 17:48:00 +00002324** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2325** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002326*/
dancdc1f042010-11-18 12:11:05 +00002327int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002328 int rc = SQLITE_OK; /* Return code */
2329 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002330 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002331
2332 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002333 assert( !pnLog || *pnLog==-1 );
2334 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002335
dan6fcff072010-05-03 14:05:43 +00002336 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2337 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002338 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002339 pnLog = 0;
2340 pnCkpt = 0;
2341 if( rc==SQLITE_BUSY ){
2342 bBusy = 1;
2343 rc = SQLITE_OK;
2344 }
dan6fcff072010-05-03 14:05:43 +00002345 }
dan586b9c82010-05-03 08:04:49 +00002346 }
2347
danf2b8dd52010-11-18 19:28:01 +00002348 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002349}
drhb033d8b2010-05-03 13:37:30 +00002350#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002351
2352/*
danielk1977d8293352009-04-30 09:10:37 +00002353** This function returns true if main-memory should be used instead of
2354** a temporary file for transient pager files and statement journals.
2355** The value returned depends on the value of db->temp_store (runtime
2356** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2357** following table describes the relationship between these two values
2358** and this functions return value.
2359**
2360** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2361** ----------------- -------------- ------------------------------
2362** 0 any file (return 0)
2363** 1 1 file (return 0)
2364** 1 2 memory (return 1)
2365** 1 0 file (return 0)
2366** 2 1 file (return 0)
2367** 2 2 memory (return 1)
2368** 2 0 memory (return 1)
2369** 3 any memory (return 1)
2370*/
drh1c514142009-04-30 12:25:10 +00002371int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002372#if SQLITE_TEMP_STORE==1
2373 return ( db->temp_store==2 );
2374#endif
2375#if SQLITE_TEMP_STORE==2
2376 return ( db->temp_store!=1 );
2377#endif
2378#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002379 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002380 return 1;
shanecf697392009-06-01 16:53:09 +00002381#endif
2382#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002383 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002384 return 0;
shane60a4b532009-05-06 18:57:09 +00002385#endif
danielk1977d8293352009-04-30 09:10:37 +00002386}
2387
2388/*
danielk19774ad17132004-05-21 01:47:26 +00002389** Return UTF-8 encoded English language explanation of the most recent
2390** error.
2391*/
danielk19776622cce2004-05-20 11:00:52 +00002392const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002393 const char *z;
drhf49661a2008-12-10 16:45:50 +00002394 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002395 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002396 }
drhd55d57e2008-07-07 17:53:07 +00002397 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002398 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002399 }
drh27641702007-08-22 02:56:42 +00002400 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002401 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002402 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002403 }else{
drha3cc0072013-12-13 16:23:55 +00002404 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002405 z = (char*)sqlite3_value_text(db->pErr);
2406 assert( !db->mallocFailed );
2407 if( z==0 ){
2408 z = sqlite3ErrStr(db->errCode);
2409 }
danielk19776622cce2004-05-20 11:00:52 +00002410 }
drhe30f4422007-08-21 16:15:55 +00002411 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002412 return z;
danielk19776622cce2004-05-20 11:00:52 +00002413}
2414
drh6c626082004-11-14 21:56:29 +00002415#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002416/*
2417** Return UTF-16 encoded English language explanation of the most recent
2418** error.
2419*/
danielk19776622cce2004-05-20 11:00:52 +00002420const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002421 static const u16 outOfMem[] = {
2422 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002423 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002424 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002425 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2426 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2427 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002428 };
danielk19774ad17132004-05-21 01:47:26 +00002429
drhc60d0442004-09-30 13:43:13 +00002430 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002431 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002432 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002433 }
drhd55d57e2008-07-07 17:53:07 +00002434 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002435 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002436 }
drhe30f4422007-08-21 16:15:55 +00002437 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002438 if( db->mallocFailed ){
2439 z = (void *)outOfMem;
2440 }else{
drhc60d0442004-09-30 13:43:13 +00002441 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002442 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002443 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002444 z = sqlite3_value_text16(db->pErr);
2445 }
2446 /* A malloc() may have failed within the call to sqlite3_value_text16()
2447 ** above. If this is the case, then the db->mallocFailed flag needs to
2448 ** be cleared before returning. Do this directly, instead of via
2449 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2450 */
drh4a642b62016-02-05 01:55:27 +00002451 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002452 }
drhe30f4422007-08-21 16:15:55 +00002453 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002454 return z;
danielk19776622cce2004-05-20 11:00:52 +00002455}
drh6c626082004-11-14 21:56:29 +00002456#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002457
drhc60d0442004-09-30 13:43:13 +00002458/*
danielk19777ddad962005-12-12 06:53:03 +00002459** Return the most recent error code generated by an SQLite routine. If NULL is
2460** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002461*/
danielk19776622cce2004-05-20 11:00:52 +00002462int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002463 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002464 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002465 }
drh01495b92008-01-23 12:52:40 +00002466 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002467 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002468 }
drh4ac285a2006-09-15 07:28:50 +00002469 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002470}
drh99dfe5e2008-10-30 15:03:15 +00002471int sqlite3_extended_errcode(sqlite3 *db){
2472 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002473 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002474 }
2475 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002476 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002477 }
2478 return db->errCode;
2479}
drh1b9f2142016-03-17 16:01:23 +00002480int sqlite3_system_errno(sqlite3 *db){
2481 return db ? db->iSysErrno : 0;
2482}
danielk19776622cce2004-05-20 11:00:52 +00002483
drh0e819f92006-02-01 13:50:41 +00002484/*
mistachkin5dac8432012-09-11 02:00:25 +00002485** Return a string that describes the kind of error specified in the
2486** argument. For now, this simply calls the internal sqlite3ErrStr()
2487** function.
2488*/
2489const char *sqlite3_errstr(int rc){
2490 return sqlite3ErrStr(rc);
2491}
2492
2493/*
drh0e819f92006-02-01 13:50:41 +00002494** Create a new collating function for database "db". The name is zName
2495** and the encoding is enc.
2496*/
danielk19779a30cf62006-01-18 04:26:07 +00002497static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002498 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002499 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002500 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002501 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002502 int(*xCompare)(void*,int,const void*,int,const void*),
2503 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002504){
2505 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002506 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002507
drhe30f4422007-08-21 16:15:55 +00002508 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002509
2510 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2511 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2512 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2513 */
drh51c7d862009-04-27 18:46:06 +00002514 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002515 testcase( enc2==SQLITE_UTF16 );
2516 testcase( enc2==SQLITE_UTF16_ALIGNED );
2517 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002518 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002519 }
drh51c7d862009-04-27 18:46:06 +00002520 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002521 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002522 }
2523
2524 /* Check if this call is removing or replacing an existing collation
2525 ** sequence. If so, and there are active VMs, return busy. If there
2526 ** are no active VMs, invalidate any pre-compiled statements.
2527 */
drhc4a64fa2009-05-11 20:53:28 +00002528 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002529 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002530 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002531 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002532 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002533 return SQLITE_BUSY;
2534 }
drhba968db2018-07-24 22:02:12 +00002535 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002536
2537 /* If collation sequence pColl was created directly by a call to
2538 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2539 ** then any copies made by synthCollSeq() need to be invalidated.
2540 ** Also, collation destructor - CollSeq.xDel() - function may need
2541 ** to be called.
2542 */
2543 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002544 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002545 int j;
2546 for(j=0; j<3; j++){
2547 CollSeq *p = &aColl[j];
2548 if( p->enc==pColl->enc ){
2549 if( p->xDel ){
2550 p->xDel(p->pUser);
2551 }
2552 p->xCmp = 0;
2553 }
2554 }
2555 }
danielk19779a30cf62006-01-18 04:26:07 +00002556 }
2557
drhc4a64fa2009-05-11 20:53:28 +00002558 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002559 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002560 pColl->xCmp = xCompare;
2561 pColl->pUser = pCtx;
2562 pColl->xDel = xDel;
2563 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002564 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002565 return SQLITE_OK;
2566}
2567
2568
danielk19776622cce2004-05-20 11:00:52 +00002569/*
drhbb4957f2008-03-20 14:03:29 +00002570** This array defines hard upper bounds on limit values. The
2571** initializer must be kept in sync with the SQLITE_LIMIT_*
2572** #defines in sqlite3.h.
2573*/
drhb1a6c3c2008-03-20 16:30:17 +00002574static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002575 SQLITE_MAX_LENGTH,
2576 SQLITE_MAX_SQL_LENGTH,
2577 SQLITE_MAX_COLUMN,
2578 SQLITE_MAX_EXPR_DEPTH,
2579 SQLITE_MAX_COMPOUND_SELECT,
2580 SQLITE_MAX_VDBE_OP,
2581 SQLITE_MAX_FUNCTION_ARG,
2582 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002583 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002584 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002585 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002586 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002587};
2588
2589/*
2590** Make sure the hard limits are set to reasonable values
2591*/
2592#if SQLITE_MAX_LENGTH<100
2593# error SQLITE_MAX_LENGTH must be at least 100
2594#endif
2595#if SQLITE_MAX_SQL_LENGTH<100
2596# error SQLITE_MAX_SQL_LENGTH must be at least 100
2597#endif
2598#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2599# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2600#endif
drhbb4957f2008-03-20 14:03:29 +00002601#if SQLITE_MAX_COMPOUND_SELECT<2
2602# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2603#endif
2604#if SQLITE_MAX_VDBE_OP<40
2605# error SQLITE_MAX_VDBE_OP must be at least 40
2606#endif
drh80738d92016-02-15 00:34:16 +00002607#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2608# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002609#endif
drhd08b2792014-07-22 15:33:31 +00002610#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2611# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002612#endif
drhbb4957f2008-03-20 14:03:29 +00002613#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2614# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2615#endif
drh70a8ca32008-08-21 18:49:27 +00002616#if SQLITE_MAX_COLUMN>32767
2617# error SQLITE_MAX_COLUMN must not exceed 32767
2618#endif
drh417168a2009-09-07 18:14:02 +00002619#if SQLITE_MAX_TRIGGER_DEPTH<1
2620# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2621#endif
drh111544c2014-08-29 16:20:47 +00002622#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2623# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2624#endif
drhbb4957f2008-03-20 14:03:29 +00002625
2626
2627/*
2628** Change the value of a limit. Report the old value.
2629** If an invalid limit index is supplied, report -1.
2630** Make no changes but still report the old value if the
2631** new limit is negative.
2632**
2633** A new lower limit does not shrink existing constructs.
2634** It merely prevents new constructs that exceed the limit
2635** from forming.
2636*/
2637int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2638 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002639
drh9ca95732014-10-24 00:35:58 +00002640#ifdef SQLITE_ENABLE_API_ARMOR
2641 if( !sqlite3SafetyCheckOk(db) ){
2642 (void)SQLITE_MISUSE_BKPT;
2643 return -1;
2644 }
2645#endif
drh4e93f5b2010-09-07 14:59:15 +00002646
2647 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2648 ** there is a hard upper bound set at compile-time by a C preprocessor
2649 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2650 ** "_MAX_".)
2651 */
2652 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2653 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2654 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2655 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2656 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2657 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2658 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2659 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2660 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2661 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2662 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2663 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002664 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2665 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002666
2667
drh521cc842008-04-15 02:36:33 +00002668 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002669 return -1;
2670 }
2671 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002672 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002673 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002674 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002675 }
2676 db->aLimit[limitId] = newLimit;
2677 }
drh4e93f5b2010-09-07 14:59:15 +00002678 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002679}
2680
2681/*
dan286ab7c2011-05-06 18:34:54 +00002682** This function is used to parse both URIs and non-URI filenames passed by the
2683** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2684** URIs specified as part of ATTACH statements.
2685**
2686** The first argument to this function is the name of the VFS to use (or
2687** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2688** query parameter. The second argument contains the URI (or non-URI filename)
2689** itself. When this function is called the *pFlags variable should contain
2690** the default flags to open the database handle with. The value stored in
2691** *pFlags may be updated before returning if the URI filename contains
2692** "cache=xxx" or "mode=xxx" query parameters.
2693**
2694** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2695** the VFS that should be used to open the database file. *pzFile is set to
2696** point to a buffer containing the name of the file to open. It is the
2697** responsibility of the caller to eventually call sqlite3_free() to release
2698** this buffer.
2699**
2700** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2701** may be set to point to a buffer containing an English language error
2702** message. It is the responsibility of the caller to eventually release
2703** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002704*/
2705int sqlite3ParseUri(
2706 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2707 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002708 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002709 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2710 char **pzFile, /* OUT: Filename component of URI */
2711 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2712){
dan78e9dd22011-05-03 10:22:32 +00002713 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002714 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002715 const char *zVfs = zDefaultVfs;
2716 char *zFile;
drhde941c32011-05-09 19:20:17 +00002717 char c;
dancd74b612011-04-22 19:37:32 +00002718 int nUri = sqlite3Strlen30(zUri);
2719
2720 assert( *pzErrMsg==0 );
2721
drh8790b6e2014-11-07 01:43:56 +00002722 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2723 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002724 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002725 ){
dan5de15372011-04-23 10:12:30 +00002726 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002727 int eState; /* Parser state when parsing URI */
2728 int iIn; /* Input character index */
2729 int iOut = 0; /* Output character index */
drhf3cdcdc2015-04-29 16:50:28 +00002730 u64 nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002731
dan286ab7c2011-05-06 18:34:54 +00002732 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2733 ** method that there may be extra parameters following the file-name. */
2734 flags |= SQLITE_OPEN_URI;
2735
2736 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002737 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002738 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002739
drh869c0402013-08-07 23:15:52 +00002740 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002741#ifdef SQLITE_ALLOW_URI_AUTHORITY
2742 if( strncmp(zUri+5, "///", 3)==0 ){
2743 iIn = 7;
2744 /* The following condition causes URIs with five leading / characters
2745 ** like file://///host/path to be converted into UNCs like //host/path.
2746 ** The correct URI for that UNC has only two or four leading / characters
2747 ** file://host/path or file:////host/path. But 5 leading slashes is a
2748 ** common error, we are told, so we handle it as a special case. */
2749 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2750 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2751 iIn = 16;
2752 }
2753#else
dancd74b612011-04-22 19:37:32 +00002754 /* Discard the scheme and authority segments of the URI. */
2755 if( zUri[5]=='/' && zUri[6]=='/' ){
2756 iIn = 7;
2757 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002758 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2759 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2760 iIn-7, &zUri[7]);
2761 rc = SQLITE_ERROR;
2762 goto parse_uri_out;
2763 }
dancd74b612011-04-22 19:37:32 +00002764 }
drh869c0402013-08-07 23:15:52 +00002765#endif
dancd74b612011-04-22 19:37:32 +00002766
2767 /* Copy the filename and any query parameters into the zFile buffer.
2768 ** Decode %HH escape codes along the way.
2769 **
2770 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2771 ** on the parsing context. As follows:
2772 **
2773 ** 0: Parsing file-name.
2774 ** 1: Parsing name section of a name=value query parameter.
2775 ** 2: Parsing value section of a name=value query parameter.
2776 */
2777 eState = 0;
drhde941c32011-05-09 19:20:17 +00002778 while( (c = zUri[iIn])!=0 && c!='#' ){
2779 iIn++;
dancd74b612011-04-22 19:37:32 +00002780 if( c=='%'
2781 && sqlite3Isxdigit(zUri[iIn])
2782 && sqlite3Isxdigit(zUri[iIn+1])
2783 ){
dan6d49e252011-05-03 15:09:05 +00002784 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2785 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002786
dan6d49e252011-05-03 15:09:05 +00002787 assert( octet>=0 && octet<256 );
2788 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002789#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002790 /* This branch is taken when "%00" appears within the URI. In this
2791 ** case we ignore all text in the remainder of the path, name or
2792 ** value currently being parsed. So ignore the current character
2793 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002794 while( (c = zUri[iIn])!=0 && c!='#'
2795 && (eState!=0 || c!='?')
2796 && (eState!=1 || (c!='=' && c!='&'))
2797 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002798 ){
2799 iIn++;
2800 }
2801 continue;
dan5c35e902016-10-26 12:15:41 +00002802#else
2803 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2804 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2805 rc = SQLITE_ERROR;
2806 goto parse_uri_out;
2807#endif
dancd74b612011-04-22 19:37:32 +00002808 }
dan6d49e252011-05-03 15:09:05 +00002809 c = octet;
dan5de15372011-04-23 10:12:30 +00002810 }else if( eState==1 && (c=='&' || c=='=') ){
2811 if( zFile[iOut-1]==0 ){
2812 /* An empty option name. Ignore this option altogether. */
2813 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2814 continue;
2815 }
2816 if( c=='&' ){
2817 zFile[iOut++] = '\0';
2818 }else{
2819 eState = 2;
2820 }
dancd74b612011-04-22 19:37:32 +00002821 c = 0;
dan5de15372011-04-23 10:12:30 +00002822 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2823 c = 0;
dancd74b612011-04-22 19:37:32 +00002824 eState = 1;
dancd74b612011-04-22 19:37:32 +00002825 }
2826 zFile[iOut++] = c;
2827 }
2828 if( eState==1 ) zFile[iOut++] = '\0';
2829 zFile[iOut++] = '\0';
2830 zFile[iOut++] = '\0';
2831
2832 /* Check if there were any options specified that should be interpreted
2833 ** here. Options that are interpreted here include "vfs" and those that
2834 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002835 ** method. */
dan5de15372011-04-23 10:12:30 +00002836 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2837 while( zOpt[0] ){
2838 int nOpt = sqlite3Strlen30(zOpt);
2839 char *zVal = &zOpt[nOpt+1];
2840 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002841
dan286ab7c2011-05-06 18:34:54 +00002842 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002843 zVfs = zVal;
2844 }else{
2845 struct OpenMode {
2846 const char *z;
2847 int mode;
2848 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002849 char *zModeType = 0;
2850 int mask = 0;
2851 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002852
dan286ab7c2011-05-06 18:34:54 +00002853 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002854 static struct OpenMode aCacheMode[] = {
2855 { "shared", SQLITE_OPEN_SHAREDCACHE },
2856 { "private", SQLITE_OPEN_PRIVATECACHE },
2857 { 0, 0 }
2858 };
2859
2860 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2861 aMode = aCacheMode;
2862 limit = mask;
2863 zModeType = "cache";
2864 }
dan286ab7c2011-05-06 18:34:54 +00002865 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002866 static struct OpenMode aOpenMode[] = {
2867 { "ro", SQLITE_OPEN_READONLY },
2868 { "rw", SQLITE_OPEN_READWRITE },
2869 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002870 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002871 { 0, 0 }
2872 };
2873
drh9c67b2a2012-05-28 13:58:00 +00002874 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2875 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002876 aMode = aOpenMode;
2877 limit = mask & flags;
2878 zModeType = "access";
2879 }
2880
2881 if( aMode ){
2882 int i;
2883 int mode = 0;
2884 for(i=0; aMode[i].z; i++){
2885 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002886 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002887 mode = aMode[i].mode;
2888 break;
dancd74b612011-04-22 19:37:32 +00002889 }
2890 }
dan78e9dd22011-05-03 10:22:32 +00002891 if( mode==0 ){
2892 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2893 rc = SQLITE_ERROR;
2894 goto parse_uri_out;
2895 }
drh9c67b2a2012-05-28 13:58:00 +00002896 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002897 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2898 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002899 rc = SQLITE_PERM;
2900 goto parse_uri_out;
2901 }
2902 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002903 }
dancd74b612011-04-22 19:37:32 +00002904 }
dan5de15372011-04-23 10:12:30 +00002905
2906 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002907 }
2908
2909 }else{
drhf3cdcdc2015-04-29 16:50:28 +00002910 zFile = sqlite3_malloc64(nUri+2);
mistachkinfad30392016-02-13 23:43:46 +00002911 if( !zFile ) return SQLITE_NOMEM_BKPT;
dan895decf2016-12-30 14:15:56 +00002912 if( nUri ){
2913 memcpy(zFile, zUri, nUri);
2914 }
dancd74b612011-04-22 19:37:32 +00002915 zFile[nUri] = '\0';
2916 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002917 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002918 }
2919
2920 *ppVfs = sqlite3_vfs_find(zVfs);
2921 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002922 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002923 rc = SQLITE_ERROR;
2924 }
2925 parse_uri_out:
2926 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002927 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002928 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002929 }
2930 *pFlags = flags;
2931 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002932 return rc;
dancd74b612011-04-22 19:37:32 +00002933}
2934
2935
2936/*
danielk19774ad17132004-05-21 01:47:26 +00002937** This routine does the work of opening a database on behalf of
2938** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002939** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002940*/
2941static int openDatabase(
2942 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002943 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002944 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002945 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002946){
dancd74b612011-04-22 19:37:32 +00002947 sqlite3 *db; /* Store allocated handle here */
2948 int rc; /* Return code */
2949 int isThreadsafe; /* True for threadsafe connections */
2950 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2951 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002952
drh9ca95732014-10-24 00:35:58 +00002953#ifdef SQLITE_ENABLE_API_ARMOR
2954 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2955#endif
drhe0d0f8e2009-04-28 04:47:31 +00002956 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002957#ifndef SQLITE_OMIT_AUTOINIT
2958 rc = sqlite3_initialize();
2959 if( rc ) return rc;
2960#endif
2961
drh039963a2008-09-03 00:43:15 +00002962 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002963 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002964 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2965 isThreadsafe = 0;
2966 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2967 isThreadsafe = 1;
2968 }else{
2969 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002970 }
dan8385bec2017-11-25 17:51:01 +00002971
drhf1f12682009-09-09 14:17:52 +00002972 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002973 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002974 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2975 flags |= SQLITE_OPEN_SHAREDCACHE;
2976 }
danielk19779a6284c2008-07-10 17:52:49 +00002977
drhb25a9f42009-05-12 13:35:11 +00002978 /* Remove harmful bits from the flags parameter
2979 **
2980 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2981 ** dealt with in the previous code block. Besides these, the only
2982 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002983 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2984 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002985 ** off all other flags.
2986 */
drha4267dc2008-02-19 15:20:44 +00002987 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002988 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002989 SQLITE_OPEN_MAIN_DB |
2990 SQLITE_OPEN_TEMP_DB |
2991 SQLITE_OPEN_TRANSIENT_DB |
2992 SQLITE_OPEN_MAIN_JOURNAL |
2993 SQLITE_OPEN_TEMP_JOURNAL |
2994 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002995 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002996 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002997 SQLITE_OPEN_FULLMUTEX |
2998 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002999 );
3000
danielk19774ad17132004-05-21 01:47:26 +00003001 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003002 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003003 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003004 if( isThreadsafe
3005#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3006 || sqlite3GlobalConfig.bCoreMutex
3007#endif
3008 ){
danielk197759f8c082008-06-18 17:09:10 +00003009 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3010 if( db->mutex==0 ){
3011 sqlite3_free(db);
3012 db = 0;
3013 goto opendb_out;
3014 }
dan8385bec2017-11-25 17:51:01 +00003015 if( isThreadsafe==0 ){
3016 sqlite3MutexWarnOnContention(db->mutex);
3017 }
drh605264d2007-08-21 15:13:19 +00003018 }
drh27641702007-08-22 02:56:42 +00003019 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003020 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003021 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003022 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003023 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003024 db->lookaside.bDisable = 1;
drh633e6d52008-07-28 19:34:53 +00003025
drhbb4957f2008-03-20 14:03:29 +00003026 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3027 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003028 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003029 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003030 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003031 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003032 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003033 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00003034 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00003035#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003036 | SQLITE_AutoIndex
3037#endif
drh883ad042015-02-19 00:29:11 +00003038#if SQLITE_DEFAULT_CKPTFULLFSYNC
3039 | SQLITE_CkptFullFSync
3040#endif
drh76fe8032006-07-11 14:17:51 +00003041#if SQLITE_DEFAULT_FILE_FORMAT<4
3042 | SQLITE_LegacyFileFmt
3043#endif
drh56424db2007-03-27 22:24:11 +00003044#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3045 | SQLITE_LoadExtension
3046#endif
dan5bde73c2009-09-01 17:11:07 +00003047#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003048 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003049#endif
drha4bfd7f2010-12-09 19:15:17 +00003050#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3051 | SQLITE_ForeignKeys
3052#endif
drhf5471922014-12-09 15:12:11 +00003053#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3054 | SQLITE_ReverseOrder
3055#endif
drh1421d982015-05-27 03:46:18 +00003056#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3057 | SQLITE_CellSizeCk
3058#endif
drhd42908f2016-02-26 15:38:24 +00003059#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3060 | SQLITE_Fts3Tokenizer
3061#endif
drh169dd922017-06-26 13:57:49 +00003062#if defined(SQLITE_ENABLE_QPSG)
3063 | SQLITE_EnableQPSG
3064#endif
drh76fe8032006-07-11 14:17:51 +00003065 ;
drhe61922a2009-05-02 13:29:37 +00003066 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003067#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003068 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003069#endif
danielk1977da184232006-01-05 11:34:32 +00003070
danielk19770202b292004-06-09 09:55:16 +00003071 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3072 ** and UTF-16, so add a version for each to avoid any unnecessary
3073 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003074 **
3075 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3076 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003077 */
drhf19aa5f2015-12-30 16:51:20 +00003078 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3079 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3080 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003081 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00003082 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003083 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003084 goto opendb_out;
3085 }
drh5e3b49b2014-11-20 19:22:26 +00003086 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3087 ** strings is BINARY.
3088 */
drhf19aa5f2015-12-30 16:51:20 +00003089 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
drh77db4c02008-03-18 13:01:38 +00003090 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00003091
drhff4fa772017-07-10 12:07:53 +00003092 /* Parse the filename/URI argument
3093 **
3094 ** Only allow sensible combinations of bits in the flags argument.
3095 ** Throw an error if any non-sense combination is used. If we
3096 ** do not block illegal combinations here, it could trigger
3097 ** assert() statements in deeper layers. Sensible combinations
3098 ** are:
3099 **
3100 ** 1: SQLITE_OPEN_READONLY
3101 ** 2: SQLITE_OPEN_READWRITE
3102 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3103 */
dan19432992011-05-10 18:39:10 +00003104 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003105 assert( SQLITE_OPEN_READONLY == 0x01 );
3106 assert( SQLITE_OPEN_READWRITE == 0x02 );
3107 assert( SQLITE_OPEN_CREATE == 0x04 );
3108 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3109 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3110 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3111 if( ((1<<(flags&7)) & 0x46)==0 ){
3112 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3113 }else{
3114 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3115 }
dancd74b612011-04-22 19:37:32 +00003116 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003117 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003118 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003119 sqlite3_free(zErrMsg);
3120 goto opendb_out;
3121 }
3122
danielk19774ad17132004-05-21 01:47:26 +00003123 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003124 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003125 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003126 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003127 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003128 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003129 }
drh13f40da2014-08-22 18:00:11 +00003130 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003131 goto opendb_out;
3132 }
dan0235a032014-12-08 20:20:16 +00003133 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003134 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00003135 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00003136 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003137 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003138
drhe872d512016-02-22 13:23:16 +00003139 /* The default safety_level for the main database is FULL; for the temp
3140 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003141 */
drh69c33822016-08-18 14:33:11 +00003142 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003143 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003144 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003145 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003146
danielk1977832a58a2007-06-22 15:21:15 +00003147 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003148 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003149 goto opendb_out;
3150 }
3151
danielk19778e227872004-06-07 07:52:17 +00003152 /* Register all built-in functions, but do not attempt to read the
3153 ** database schema yet. This is delayed until the first time the database
3154 ** is accessed.
3155 */
drh13f40da2014-08-22 18:00:11 +00003156 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003157 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003158 rc = sqlite3_errcode(db);
3159
3160#ifdef SQLITE_ENABLE_FTS5
3161 /* Register any built-in FTS5 module before loading the automatic
3162 ** extensions. This allows automatic extensions to register FTS5
3163 ** tokenizers and auxiliary functions. */
3164 if( !db->mallocFailed && rc==SQLITE_OK ){
3165 rc = sqlite3Fts5Init(db);
3166 }
3167#endif
danielk19774ad17132004-05-21 01:47:26 +00003168
drh1409be62006-08-23 20:07:20 +00003169 /* Load automatic extensions - extensions that have been registered
3170 ** using the sqlite3_automatic_extension() API.
3171 */
drhe5077c12011-12-13 04:08:36 +00003172 if( rc==SQLITE_OK ){
3173 sqlite3AutoLoadExtensions(db);
3174 rc = sqlite3_errcode(db);
3175 if( rc!=SQLITE_OK ){
3176 goto opendb_out;
3177 }
danielk1977832a58a2007-06-22 15:21:15 +00003178 }
drh1409be62006-08-23 20:07:20 +00003179
drhaa29c132006-09-02 13:58:06 +00003180#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00003181 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003182 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003183 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003184 }
3185#endif
3186
shessa26cf572006-10-19 20:27:58 +00003187#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003188 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003189 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003190 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003191 }
3192#endif
3193
drh50065652015-10-08 19:29:18 +00003194#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003195 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003196 rc = sqlite3Fts3Init(db);
3197 }
3198#endif
3199
dan21540ae2017-12-08 16:23:38 +00003200#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
drh17435752007-08-16 04:30:38 +00003201 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003202 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003203 }
3204#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003205
3206#ifdef SQLITE_ENABLE_RTREE
3207 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003208 rc = sqlite3RtreeInit(db);
3209 }
3210#endif
3211
drha43c8c82017-10-11 13:48:11 +00003212#ifdef SQLITE_ENABLE_DBPAGE_VTAB
3213 if( !db->mallocFailed && rc==SQLITE_OK){
3214 rc = sqlite3DbpageRegister(db);
3215 }
3216#endif
3217
drha3ab9d02015-05-04 20:25:05 +00003218#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3219 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003220 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003221 }
3222#endif
3223
drh2f20e132015-09-26 17:44:59 +00003224#ifdef SQLITE_ENABLE_JSON1
3225 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003226 rc = sqlite3Json1Init(db);
3227 }
3228#endif
3229
drhc6603af2017-06-29 14:33:51 +00003230#ifdef SQLITE_ENABLE_STMTVTAB
drhf00f5302017-06-28 15:47:29 +00003231 if( !db->mallocFailed && rc==SQLITE_OK){
drhc6603af2017-06-29 14:33:51 +00003232 rc = sqlite3StmtVtabInit(db);
drhf00f5302017-06-28 15:47:29 +00003233 }
3234#endif
3235
drh8fd5bd32007-04-02 16:40:37 +00003236 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3237 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3238 ** mode. Doing nothing at all also makes NORMAL the default.
3239 */
3240#ifdef SQLITE_DEFAULT_LOCKING_MODE
3241 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3242 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3243 SQLITE_DEFAULT_LOCKING_MODE);
3244#endif
3245
drh13f40da2014-08-22 18:00:11 +00003246 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003247
drh633e6d52008-07-28 19:34:53 +00003248 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003249 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3250 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003251
dan5a299f92010-05-03 11:05:08 +00003252 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003253
danielk19774ad17132004-05-21 01:47:26 +00003254opendb_out:
drhafc91042008-02-21 02:09:45 +00003255 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003256 assert( db->mutex!=0 || isThreadsafe==0
3257 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003258 sqlite3_mutex_leave(db->mutex);
3259 }
danielk197759633ae2008-08-27 19:01:57 +00003260 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003261 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003262 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003263 sqlite3_close(db);
3264 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003265 }else if( rc!=SQLITE_OK ){
3266 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003267 }
danielk19774ad17132004-05-21 01:47:26 +00003268 *ppDb = db;
danac455932012-11-26 19:50:41 +00003269#ifdef SQLITE_ENABLE_SQLLOG
3270 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003271 /* Opening a db handle. Fourth parameter is passed 0. */
3272 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3273 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003274 }
3275#endif
drh46e6ea02015-10-26 14:41:35 +00003276#if defined(SQLITE_HAS_CODEC)
3277 if( rc==SQLITE_OK ){
drhad012d02017-05-03 15:54:53 +00003278 const char *zKey;
drhd4fb1962017-05-23 00:32:56 +00003279 if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){
drh46e6ea02015-10-26 14:41:35 +00003280 u8 iByte;
3281 int i;
drhad012d02017-05-03 15:54:53 +00003282 char zDecoded[40];
3283 for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
3284 iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
3285 if( (i&1)!=0 ) zDecoded[i/2] = iByte;
drh46e6ea02015-10-26 14:41:35 +00003286 }
drhad012d02017-05-03 15:54:53 +00003287 sqlite3_key_v2(db, 0, zDecoded, i/2);
3288 }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){
3289 sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey));
drh46e6ea02015-10-26 14:41:35 +00003290 }
3291 }
3292#endif
drh095fb472016-01-16 03:16:19 +00003293 sqlite3_free(zOpen);
drh597d2b62015-06-30 03:13:47 +00003294 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003295}
3296
3297/*
3298** Open a new database handle.
3299*/
danielk197780290862004-05-22 09:21:21 +00003300int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003301 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003302 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003303){
drh605264d2007-08-21 15:13:19 +00003304 return openDatabase(zFilename, ppDb,
3305 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3306}
3307int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003308 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003309 sqlite3 **ppDb, /* OUT: SQLite db handle */
3310 int flags, /* Flags */
3311 const char *zVfs /* Name of VFS module to use */
3312){
drh522c26f2011-05-07 14:40:29 +00003313 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003314}
3315
drh6c626082004-11-14 21:56:29 +00003316#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003317/*
3318** Open a new database handle.
3319*/
3320int sqlite3_open16(
3321 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003322 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003323){
danielk1977bfd6cce2004-06-18 04:24:54 +00003324 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003325 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003326 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003327
drh9ca95732014-10-24 00:35:58 +00003328#ifdef SQLITE_ENABLE_API_ARMOR
3329 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3330#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003331 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003332#ifndef SQLITE_OMIT_AUTOINIT
3333 rc = sqlite3_initialize();
3334 if( rc ) return rc;
3335#endif
drh9ca95732014-10-24 00:35:58 +00003336 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003337 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003338 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3339 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003340 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003341 rc = openDatabase(zFilename8, ppDb,
3342 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003343 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003344 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003345 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003346 }
drh40257ff2008-06-13 18:24:27 +00003347 }else{
mistachkinfad30392016-02-13 23:43:46 +00003348 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003349 }
danielk19777ddad962005-12-12 06:53:03 +00003350 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003351
drh597d2b62015-06-30 03:13:47 +00003352 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003353}
drh6c626082004-11-14 21:56:29 +00003354#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003355
danielk1977106bb232004-05-21 10:08:53 +00003356/*
danielk1977d8123362004-06-12 09:25:12 +00003357** Register a new collation sequence with the database handle db.
3358*/
danielk19770202b292004-06-09 09:55:16 +00003359int sqlite3_create_collation(
3360 sqlite3* db,
3361 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003362 int enc,
danielk19770202b292004-06-09 09:55:16 +00003363 void* pCtx,
3364 int(*xCompare)(void*,int,const void*,int,const void*)
3365){
drh4f81bbb2014-10-23 01:01:26 +00003366 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003367}
3368
3369/*
3370** Register a new collation sequence with the database handle db.
3371*/
danielk1977a393c032007-05-07 14:58:53 +00003372int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003373 sqlite3* db,
3374 const char *zName,
3375 int enc,
3376 void* pCtx,
3377 int(*xCompare)(void*,int,const void*,int,const void*),
3378 void(*xDel)(void*)
3379){
3380 int rc;
drh9ca95732014-10-24 00:35:58 +00003381
3382#ifdef SQLITE_ENABLE_API_ARMOR
3383 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3384#endif
drhe30f4422007-08-21 16:15:55 +00003385 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003386 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003387 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003388 rc = sqlite3ApiExit(db, rc);
3389 sqlite3_mutex_leave(db->mutex);
3390 return rc;
danielk19770202b292004-06-09 09:55:16 +00003391}
3392
drh6c626082004-11-14 21:56:29 +00003393#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003394/*
3395** Register a new collation sequence with the database handle db.
3396*/
danielk19770202b292004-06-09 09:55:16 +00003397int sqlite3_create_collation16(
3398 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003399 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003400 int enc,
danielk19770202b292004-06-09 09:55:16 +00003401 void* pCtx,
3402 int(*xCompare)(void*,int,const void*,int,const void*)
3403){
danielk19779a30cf62006-01-18 04:26:07 +00003404 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003405 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003406
3407#ifdef SQLITE_ENABLE_API_ARMOR
3408 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3409#endif
drhe30f4422007-08-21 16:15:55 +00003410 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003411 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003412 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003413 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003414 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003415 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003416 }
drhe30f4422007-08-21 16:15:55 +00003417 rc = sqlite3ApiExit(db, rc);
3418 sqlite3_mutex_leave(db->mutex);
3419 return rc;
danielk19770202b292004-06-09 09:55:16 +00003420}
drh6c626082004-11-14 21:56:29 +00003421#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003422
danielk1977d8123362004-06-12 09:25:12 +00003423/*
3424** Register a collation sequence factory callback with the database handle
3425** db. Replace any previously installed collation sequence factory.
3426*/
danielk19777cedc8d2004-06-10 10:50:08 +00003427int sqlite3_collation_needed(
3428 sqlite3 *db,
3429 void *pCollNeededArg,
3430 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3431){
drh9ca95732014-10-24 00:35:58 +00003432#ifdef SQLITE_ENABLE_API_ARMOR
3433 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3434#endif
drhe30f4422007-08-21 16:15:55 +00003435 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003436 db->xCollNeeded = xCollNeeded;
3437 db->xCollNeeded16 = 0;
3438 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003439 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003440 return SQLITE_OK;
3441}
danielk1977d8123362004-06-12 09:25:12 +00003442
drh6c626082004-11-14 21:56:29 +00003443#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003444/*
3445** Register a collation sequence factory callback with the database handle
3446** db. Replace any previously installed collation sequence factory.
3447*/
danielk19777cedc8d2004-06-10 10:50:08 +00003448int sqlite3_collation_needed16(
3449 sqlite3 *db,
3450 void *pCollNeededArg,
3451 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3452){
drh9ca95732014-10-24 00:35:58 +00003453#ifdef SQLITE_ENABLE_API_ARMOR
3454 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3455#endif
drhe30f4422007-08-21 16:15:55 +00003456 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003457 db->xCollNeeded = 0;
3458 db->xCollNeeded16 = xCollNeeded16;
3459 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003460 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003461 return SQLITE_OK;
3462}
drh6c626082004-11-14 21:56:29 +00003463#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003464
shaneeec556d2008-10-12 00:27:53 +00003465#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003466/*
danielk19777ddad962005-12-12 06:53:03 +00003467** This function is now an anachronism. It used to be used to recover from a
3468** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003469*/
drh7d97efb2007-10-12 19:35:48 +00003470int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003471 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003472}
3473#endif
drh3e1d8e62005-05-26 16:23:34 +00003474
3475/*
3476** Test to see whether or not the database connection is in autocommit
3477** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3478** by default. Autocommit is disabled by a BEGIN statement and reenabled
3479** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003480*/
3481int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003482#ifdef SQLITE_ENABLE_API_ARMOR
3483 if( !sqlite3SafetyCheckOk(db) ){
3484 (void)SQLITE_MISUSE_BKPT;
3485 return 0;
3486 }
3487#endif
drh3e1d8e62005-05-26 16:23:34 +00003488 return db->autoCommit;
3489}
drh49285702005-09-17 15:20:26 +00003490
drh49285702005-09-17 15:20:26 +00003491/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003492** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003493** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003494** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003495**
3496** 1. Serve as a convenient place to set a breakpoint in a debugger
3497** to detect when version error conditions occurs.
3498**
3499** 2. Invoke sqlite3_log() to provide the source code location where
3500** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003501*/
daneebf2f52017-11-18 17:30:08 +00003502int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003503 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3504 zType, lineno, 20+sqlite3_sourceid());
3505 return iErr;
3506}
drh9978c972010-02-23 17:36:32 +00003507int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003508 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003509 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003510}
drh9978c972010-02-23 17:36:32 +00003511int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003512 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003513 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003514}
3515int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003516 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003517 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003518}
drh32c49902016-02-15 18:15:15 +00003519#ifdef SQLITE_DEBUG
drhcc97ca42017-06-07 22:32:59 +00003520int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3521 char zMsg[100];
3522 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3523 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003524 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003525}
mistachkinfad30392016-02-13 23:43:46 +00003526int sqlite3NomemError(int lineno){
3527 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003528 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003529}
3530int sqlite3IoerrnomemError(int lineno){
3531 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003532 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003533}
drh32c49902016-02-15 18:15:15 +00003534#endif
drh7c1817e2006-01-10 13:58:48 +00003535
shaneeec556d2008-10-12 00:27:53 +00003536#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003537/*
3538** This is a convenience routine that makes sure that all thread-specific
3539** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003540**
3541** SQLite no longer uses thread-specific data so this routine is now a
3542** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003543*/
3544void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003545}
shaneeec556d2008-10-12 00:27:53 +00003546#endif
danielk1977deb802c2006-02-09 13:43:28 +00003547
3548/*
3549** Return meta information about a specific column of a database table.
3550** See comment in sqlite3.h (sqlite.h.in) for details.
3551*/
danielk1977deb802c2006-02-09 13:43:28 +00003552int sqlite3_table_column_metadata(
3553 sqlite3 *db, /* Connection handle */
3554 const char *zDbName, /* Database name or NULL */
3555 const char *zTableName, /* Table name */
3556 const char *zColumnName, /* Column name */
3557 char const **pzDataType, /* OUTPUT: Declared data type */
3558 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3559 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3560 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003561 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003562){
3563 int rc;
3564 char *zErrMsg = 0;
3565 Table *pTab = 0;
3566 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003567 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003568 char const *zDataType = 0;
3569 char const *zCollSeq = 0;
3570 int notnull = 0;
3571 int primarykey = 0;
3572 int autoinc = 0;
3573
drh96c707a2015-02-13 16:36:14 +00003574
3575#ifdef SQLITE_ENABLE_API_ARMOR
3576 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3577 return SQLITE_MISUSE_BKPT;
3578 }
3579#endif
3580
danielk1977deb802c2006-02-09 13:43:28 +00003581 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003582 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003583 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003584 rc = sqlite3Init(db, &zErrMsg);
3585 if( SQLITE_OK!=rc ){
3586 goto error_out;
3587 }
3588
3589 /* Locate the table in question */
3590 pTab = sqlite3FindTable(db, zTableName, zDbName);
3591 if( !pTab || pTab->pSelect ){
3592 pTab = 0;
3593 goto error_out;
3594 }
3595
3596 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003597 if( zColumnName==0 ){
3598 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003599 }else{
3600 for(iCol=0; iCol<pTab->nCol; iCol++){
3601 pCol = &pTab->aCol[iCol];
3602 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3603 break;
3604 }
3605 }
3606 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003607 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3608 iCol = pTab->iPKey;
3609 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3610 }else{
3611 pTab = 0;
3612 goto error_out;
3613 }
danielk1977deb802c2006-02-09 13:43:28 +00003614 }
3615 }
3616
3617 /* The following block stores the meta information that will be returned
3618 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3619 ** and autoinc. At this point there are two possibilities:
3620 **
3621 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3622 ** and there is no explicitly declared IPK column.
3623 **
3624 ** 2. The table is not a view and the column name identified an
3625 ** explicitly declared column. Copy meta information from *pCol.
3626 */
3627 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003628 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003629 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003630 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003631 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003632 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003633 }else{
3634 zDataType = "INTEGER";
3635 primarykey = 1;
3636 }
3637 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003638 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003639 }
3640
3641error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003642 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003643
3644 /* Whether the function call succeeded or failed, set the output parameters
3645 ** to whatever their local counterparts contain. If an error did occur,
3646 ** this has the effect of zeroing all output parameters.
3647 */
3648 if( pzDataType ) *pzDataType = zDataType;
3649 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3650 if( pNotNull ) *pNotNull = notnull;
3651 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3652 if( pAutoinc ) *pAutoinc = autoinc;
3653
3654 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003655 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003656 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003657 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003658 rc = SQLITE_ERROR;
3659 }
drh13f40da2014-08-22 18:00:11 +00003660 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003661 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003662 rc = sqlite3ApiExit(db, rc);
3663 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003664 return rc;
3665}
3666
3667/*
3668** Sleep for a little while. Return the amount of time slept.
3669*/
3670int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003671 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003672 int rc;
drhd677b3d2007-08-20 22:48:41 +00003673 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003674 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003675
3676 /* This function works in milliseconds, but the underlying OsSleep()
3677 ** API uses microseconds. Hence the 1000's.
3678 */
drhe30f4422007-08-21 16:15:55 +00003679 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003680 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003681}
drh4ac285a2006-09-15 07:28:50 +00003682
3683/*
3684** Enable or disable the extended result codes.
3685*/
3686int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003687#ifdef SQLITE_ENABLE_API_ARMOR
3688 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3689#endif
drhe30f4422007-08-21 16:15:55 +00003690 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003691 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003692 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003693 return SQLITE_OK;
3694}
drhcc6bb3e2007-08-31 16:11:35 +00003695
3696/*
3697** Invoke the xFileControl method on a particular database.
3698*/
3699int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3700 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003701 Btree *pBtree;
3702
drh9ca95732014-10-24 00:35:58 +00003703#ifdef SQLITE_ENABLE_API_ARMOR
3704 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3705#endif
drhcc6bb3e2007-08-31 16:11:35 +00003706 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003707 pBtree = sqlite3DbNameToBtree(db, zDbName);
3708 if( pBtree ){
3709 Pager *pPager;
3710 sqlite3_file *fd;
3711 sqlite3BtreeEnter(pBtree);
3712 pPager = sqlite3BtreePager(pBtree);
3713 assert( pPager!=0 );
3714 fd = sqlite3PagerFile(pPager);
3715 assert( fd!=0 );
3716 if( op==SQLITE_FCNTL_FILE_POINTER ){
3717 *(sqlite3_file**)pArg = fd;
3718 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003719 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3720 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3721 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003722 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3723 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3724 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003725 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3726 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3727 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003728 }else{
drhafb39a42018-03-29 13:47:01 +00003729 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003730 }
drh421377e2012-03-15 21:28:54 +00003731 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003732 }
3733 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003734 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003735}
drhed13d982008-01-31 14:43:24 +00003736
3737/*
3738** Interface to the testing logic.
3739*/
3740int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003741 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003742#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003743 UNUSED_PARAMETER(op);
3744#else
drh2fa18682008-03-19 14:15:34 +00003745 va_list ap;
drhed13d982008-01-31 14:43:24 +00003746 va_start(ap, op);
3747 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003748
3749 /*
drh984bfaa2008-03-19 16:08:53 +00003750 ** Save the current state of the PRNG.
3751 */
drh2fa18682008-03-19 14:15:34 +00003752 case SQLITE_TESTCTRL_PRNG_SAVE: {
3753 sqlite3PrngSaveState();
3754 break;
3755 }
drh984bfaa2008-03-19 16:08:53 +00003756
3757 /*
3758 ** Restore the state of the PRNG to the last state saved using
3759 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3760 ** this verb acts like PRNG_RESET.
3761 */
drh2fa18682008-03-19 14:15:34 +00003762 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3763 sqlite3PrngRestoreState();
3764 break;
3765 }
drh984bfaa2008-03-19 16:08:53 +00003766
3767 /*
3768 ** Reset the PRNG back to its uninitialized state. The next call
3769 ** to sqlite3_randomness() will reseed the PRNG using a single call
3770 ** to the xRandomness method of the default VFS.
3771 */
drh2fa18682008-03-19 14:15:34 +00003772 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003773 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003774 break;
3775 }
drh3088d592008-03-21 16:45:47 +00003776
3777 /*
3778 ** sqlite3_test_control(BITVEC_TEST, size, program)
3779 **
3780 ** Run a test against a Bitvec object of size. The program argument
3781 ** is an array of integers that defines the test. Return -1 on a
3782 ** memory allocation error, 0 on success, or non-zero for an error.
3783 ** See the sqlite3BitvecBuiltinTest() for additional information.
3784 */
3785 case SQLITE_TESTCTRL_BITVEC_TEST: {
3786 int sz = va_arg(ap, int);
3787 int *aProg = va_arg(ap, int*);
3788 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3789 break;
3790 }
danielk19772d1d86f2008-06-20 14:59:51 +00003791
3792 /*
drhc007f612014-05-16 14:17:01 +00003793 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3794 **
3795 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3796 ** if xCallback is not NULL.
3797 **
3798 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3799 ** is called immediately after installing the new callback and the return
3800 ** value from sqlite3FaultSim(0) becomes the return from
3801 ** sqlite3_test_control().
3802 */
3803 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003804 /* MSVC is picky about pulling func ptrs from va lists.
3805 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003806 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003807 */
3808 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003809 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003810 rc = sqlite3FaultSim(0);
3811 break;
3812 }
3813
3814 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003815 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3816 **
3817 ** Register hooks to call to indicate which malloc() failures
3818 ** are benign.
3819 */
3820 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003821 typedef void (*void_function)(void);
3822 void_function xBenignBegin;
3823 void_function xBenignEnd;
3824 xBenignBegin = va_arg(ap, void_function);
3825 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003826 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3827 break;
3828 }
drhc7a3bb92009-02-05 16:31:45 +00003829
3830 /*
drhf3af63f2009-05-09 18:59:42 +00003831 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003832 **
3833 ** Set the PENDING byte to the value in the argument, if X>0.
3834 ** Make no changes if X==0. Return the value of the pending byte
3835 ** as it existing before this routine was called.
3836 **
3837 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3838 ** an incompatible database file format. Changing the PENDING byte
3839 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003840 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003841 */
3842 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003843 rc = PENDING_BYTE;
3844#ifndef SQLITE_OMIT_WSD
3845 {
3846 unsigned int newVal = va_arg(ap, unsigned int);
3847 if( newVal ) sqlite3PendingByte = newVal;
3848 }
3849#endif
drhc7a3bb92009-02-05 16:31:45 +00003850 break;
3851 }
drhf3af63f2009-05-09 18:59:42 +00003852
3853 /*
3854 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3855 **
3856 ** This action provides a run-time test to see whether or not
3857 ** assert() was enabled at compile-time. If X is true and assert()
3858 ** is enabled, then the return value is true. If X is true and
3859 ** assert() is disabled, then the return value is zero. If X is
3860 ** false and assert() is enabled, then the assertion fires and the
3861 ** process aborts. If X is false and assert() is disabled, then the
3862 ** return value is zero.
3863 */
3864 case SQLITE_TESTCTRL_ASSERT: {
3865 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003866 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003867 rc = x;
3868 break;
3869 }
3870
3871
3872 /*
3873 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3874 **
3875 ** This action provides a run-time test to see how the ALWAYS and
3876 ** NEVER macros were defined at compile-time.
3877 **
drhce2c4822017-10-03 17:17:34 +00003878 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00003879 **
3880 ** The recommended test is X==2. If the return value is 2, that means
3881 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3882 ** default setting. If the return value is 1, then ALWAYS() is either
3883 ** hard-coded to true or else it asserts if its argument is false.
3884 ** The first behavior (hard-coded to true) is the case if
3885 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3886 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3887 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3888 **
3889 ** The run-time test procedure might look something like this:
3890 **
3891 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3892 ** // ALWAYS() and NEVER() are no-op pass-through macros
3893 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3894 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3895 ** }else{
3896 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3897 ** }
3898 */
3899 case SQLITE_TESTCTRL_ALWAYS: {
3900 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00003901 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00003902 break;
3903 }
drhc046e3e2009-07-15 11:26:44 +00003904
drh2cf4acb2014-04-18 00:06:02 +00003905 /*
3906 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3907 **
3908 ** The integer returned reveals the byte-order of the computer on which
3909 ** SQLite is running:
3910 **
3911 ** 1 big-endian, determined at run-time
3912 ** 10 little-endian, determined at run-time
3913 ** 432101 big-endian, determined at compile-time
3914 ** 123410 little-endian, determined at compile-time
3915 */
3916 case SQLITE_TESTCTRL_BYTEORDER: {
3917 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3918 break;
3919 }
3920
drhc046e3e2009-07-15 11:26:44 +00003921 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3922 **
3923 ** Set the nReserve size to N for the main database on the database
3924 ** connection db.
3925 */
3926 case SQLITE_TESTCTRL_RESERVE: {
3927 sqlite3 *db = va_arg(ap, sqlite3*);
3928 int x = va_arg(ap,int);
3929 sqlite3_mutex_enter(db->mutex);
3930 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3931 sqlite3_mutex_leave(db->mutex);
3932 break;
3933 }
3934
drh07096f62009-12-22 23:52:32 +00003935 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3936 **
3937 ** Enable or disable various optimizations for testing purposes. The
3938 ** argument N is a bitmask of optimizations to be disabled. For normal
3939 ** operation N should be 0. The idea is that a test program (like the
3940 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3941 ** with various optimizations disabled to verify that the same answer
3942 ** is obtained in every case.
3943 */
3944 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3945 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003946 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003947 break;
3948 }
3949
danc17d6962011-06-21 12:47:30 +00003950 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3951 **
3952 ** If parameter onoff is non-zero, configure the wrappers so that all
3953 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3954 ** undo this setting.
3955 */
3956 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3957 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3958 break;
3959 }
3960
drh09fe6142013-11-29 15:06:27 +00003961 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3962 **
3963 ** Set or clear a flag that indicates that the database file is always well-
3964 ** formed and never corrupt. This flag is clear by default, indicating that
3965 ** database files might have arbitrary corruption. Setting the flag during
3966 ** testing causes certain assert() statements in the code to be activated
3967 ** that demonstrat invariants on well-formed database files.
3968 */
3969 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003970 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003971 break;
3972 }
3973
drh9e5eb9c2016-09-18 16:08:10 +00003974 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00003975 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00003976 ** too big to test in a reasonable amount of time, so this control is
3977 ** provided to set a small and easily reachable reset value.
3978 */
3979 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
3980 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
3981 break;
3982 }
drh688852a2014-02-17 22:40:43 +00003983
3984 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3985 **
3986 ** Set the VDBE coverage callback function to xCallback with context
3987 ** pointer ptr.
3988 */
3989 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3990#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00003991 typedef void (*branch_callback)(void*,unsigned int,
3992 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00003993 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3994 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3995#endif
3996 break;
3997 }
3998
dan8930c2a2014-04-03 16:25:29 +00003999 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4000 case SQLITE_TESTCTRL_SORTER_MMAP: {
4001 sqlite3 *db = va_arg(ap, sqlite3*);
4002 db->nMaxSorterMmap = va_arg(ap, int);
4003 break;
4004 }
4005
drh43cfc232014-07-29 14:09:21 +00004006 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4007 **
4008 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4009 ** not.
4010 */
4011 case SQLITE_TESTCTRL_ISINIT: {
4012 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4013 break;
4014 }
drh8964b342015-01-29 17:54:52 +00004015
drh3ba689d2015-03-03 14:00:11 +00004016 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004017 **
drh1ffede82015-01-30 20:59:27 +00004018 ** This test control is used to create imposter tables. "db" is a pointer
4019 ** to the database connection. dbName is the database name (ex: "main" or
4020 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4021 ** or off. "tnum" is the root page of the b-tree to which the imposter
4022 ** table should connect.
4023 **
4024 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004025 ** run a single CREATE TABLE statement to construct the imposter table in
4026 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004027 **
4028 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4029 ** the schema to be reparsed the next time it is needed. This has the
4030 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004031 */
drh1ffede82015-01-30 20:59:27 +00004032 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004033 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004034 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004035 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4036 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004037 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004038 if( db->init.busy==0 && db->init.newTnum>0 ){
4039 sqlite3ResetAllSchemasOfConnection(db);
4040 }
drh8fb15e32015-02-04 20:56:49 +00004041 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004042 break;
4043 }
drh0d9de992017-12-26 18:04:23 +00004044
4045#if defined(YYCOVERAGE)
4046 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4047 **
4048 ** This test control (only available when SQLite is compiled with
4049 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4050 ** state/lookahead combinations in the parser state machine
4051 ** which are never exercised. If any state is missed, make the
4052 ** return code SQLITE_ERROR.
4053 */
4054 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4055 FILE *out = va_arg(ap, FILE*);
4056 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4057 break;
4058 }
4059#endif /* defined(YYCOVERAGE) */
drhed13d982008-01-31 14:43:24 +00004060 }
4061 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004062#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004063 return rc;
drhed13d982008-01-31 14:43:24 +00004064}
drhcc487d12011-05-17 18:53:08 +00004065
4066/*
4067** This is a utility routine, useful to VFS implementations, that checks
4068** to see if a database file was a URI that contained a specific query
4069** parameter, and if so obtains the value of the query parameter.
4070**
4071** The zFilename argument is the filename pointer passed into the xOpen()
4072** method of a VFS implementation. The zParam argument is the name of the
4073** query parameter we seek. This routine returns the value of the zParam
4074** parameter if it exists. If the parameter does not exist, this routine
4075** returns a NULL pointer.
4076*/
4077const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004078 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00004079 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004080 while( zFilename[0] ){
4081 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00004082 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004083 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00004084 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004085 }
4086 return 0;
4087}
drh283829c2011-11-17 00:56:20 +00004088
4089/*
drh92913722011-12-23 00:07:33 +00004090** Return a boolean value for a query parameter.
4091*/
4092int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4093 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004094 bDflt = bDflt!=0;
4095 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004096}
4097
4098/*
4099** Return a 64-bit integer value for a query parameter.
4100*/
4101sqlite3_int64 sqlite3_uri_int64(
4102 const char *zFilename, /* Filename as passed to xOpen */
4103 const char *zParam, /* URI parameter sought */
4104 sqlite3_int64 bDflt /* return if parameter is missing */
4105){
4106 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4107 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004108 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004109 bDflt = v;
4110 }
4111 return bDflt;
4112}
4113
4114/*
drh421377e2012-03-15 21:28:54 +00004115** Return the Btree pointer identified by zDbName. Return NULL if not found.
4116*/
4117Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004118 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4119 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004120}
4121
4122/*
drh283829c2011-11-17 00:56:20 +00004123** Return the filename of the database associated with a database
4124** connection.
4125*/
4126const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004127 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004128#ifdef SQLITE_ENABLE_API_ARMOR
4129 if( !sqlite3SafetyCheckOk(db) ){
4130 (void)SQLITE_MISUSE_BKPT;
4131 return 0;
4132 }
4133#endif
mistachkincd54bab2014-12-20 21:14:14 +00004134 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004135 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4136}
4137
4138/*
4139** Return 1 if database is read-only or 0 if read/write. Return -1 if
4140** no such database exists.
4141*/
4142int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004143 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004144#ifdef SQLITE_ENABLE_API_ARMOR
4145 if( !sqlite3SafetyCheckOk(db) ){
4146 (void)SQLITE_MISUSE_BKPT;
4147 return -1;
4148 }
4149#endif
mistachkincd54bab2014-12-20 21:14:14 +00004150 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004151 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004152}
danfc1acf32015-12-05 20:51:54 +00004153
4154#ifdef SQLITE_ENABLE_SNAPSHOT
4155/*
4156** Obtain a snapshot handle for the snapshot of database zDb currently
4157** being read by handle db.
4158*/
4159int sqlite3_snapshot_get(
4160 sqlite3 *db,
4161 const char *zDb,
4162 sqlite3_snapshot **ppSnapshot
4163){
4164 int rc = SQLITE_ERROR;
4165#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004166
4167#ifdef SQLITE_ENABLE_API_ARMOR
4168 if( !sqlite3SafetyCheckOk(db) ){
4169 return SQLITE_MISUSE_BKPT;
4170 }
4171#endif
4172 sqlite3_mutex_enter(db->mutex);
4173
danedace5d2016-11-18 18:43:39 +00004174 if( db->autoCommit==0 ){
4175 int iDb = sqlite3FindDbName(db, zDb);
4176 if( iDb==0 || iDb>1 ){
4177 Btree *pBt = db->aDb[iDb].pBt;
4178 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004179 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004180 if( rc==SQLITE_OK ){
4181 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4182 }
dan7116dc62015-12-10 20:03:08 +00004183 }
danfc1acf32015-12-05 20:51:54 +00004184 }
4185 }
4186
4187 sqlite3_mutex_leave(db->mutex);
4188#endif /* SQLITE_OMIT_WAL */
4189 return rc;
4190}
4191
4192/*
4193** Open a read-transaction on the snapshot idendified by pSnapshot.
4194*/
4195int sqlite3_snapshot_open(
4196 sqlite3 *db,
4197 const char *zDb,
4198 sqlite3_snapshot *pSnapshot
4199){
4200 int rc = SQLITE_ERROR;
4201#ifndef SQLITE_OMIT_WAL
4202
4203#ifdef SQLITE_ENABLE_API_ARMOR
4204 if( !sqlite3SafetyCheckOk(db) ){
4205 return SQLITE_MISUSE_BKPT;
4206 }
4207#endif
4208 sqlite3_mutex_enter(db->mutex);
4209 if( db->autoCommit==0 ){
4210 int iDb;
4211 iDb = sqlite3FindDbName(db, zDb);
4212 if( iDb==0 || iDb>1 ){
4213 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004214 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4215 Pager *pPager = sqlite3BtreePager(pBt);
4216 int bUnlock = 0;
4217 if( sqlite3BtreeIsInReadTrans(pBt) ){
4218 if( db->nVdbeActive==0 ){
4219 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4220 if( rc==SQLITE_OK ){
4221 bUnlock = 1;
4222 rc = sqlite3BtreeCommit(pBt);
4223 }
4224 }
4225 }else{
4226 rc = SQLITE_OK;
4227 }
4228 if( rc==SQLITE_OK ){
4229 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4230 }
danfc1acf32015-12-05 20:51:54 +00004231 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004232 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danfa3d4c12018-08-06 17:12:36 +00004233 sqlite3PagerSnapshotOpen(pPager, 0);
4234 }
4235 if( bUnlock ){
4236 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004237 }
4238 }
4239 }
4240 }
4241
4242 sqlite3_mutex_leave(db->mutex);
4243#endif /* SQLITE_OMIT_WAL */
4244 return rc;
4245}
4246
4247/*
dan11584982016-11-18 20:49:43 +00004248** Recover as many snapshots as possible from the wal file associated with
4249** schema zDb of database db.
4250*/
4251int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4252 int rc = SQLITE_ERROR;
4253 int iDb;
4254#ifndef SQLITE_OMIT_WAL
4255
4256#ifdef SQLITE_ENABLE_API_ARMOR
4257 if( !sqlite3SafetyCheckOk(db) ){
4258 return SQLITE_MISUSE_BKPT;
4259 }
4260#endif
4261
4262 sqlite3_mutex_enter(db->mutex);
4263 iDb = sqlite3FindDbName(db, zDb);
4264 if( iDb==0 || iDb>1 ){
4265 Btree *pBt = db->aDb[iDb].pBt;
4266 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004267 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004268 if( rc==SQLITE_OK ){
4269 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4270 sqlite3BtreeCommit(pBt);
4271 }
dan11584982016-11-18 20:49:43 +00004272 }
4273 }
4274 sqlite3_mutex_leave(db->mutex);
4275#endif /* SQLITE_OMIT_WAL */
4276 return rc;
4277}
4278
4279/*
danfc1acf32015-12-05 20:51:54 +00004280** Free a snapshot handle obtained from sqlite3_snapshot_get().
4281*/
4282void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4283 sqlite3_free(pSnapshot);
4284}
4285#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004286
4287#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4288/*
4289** Given the name of a compile-time option, return true if that option
4290** was used and false if not.
4291**
4292** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4293** is not required for a match.
4294*/
4295int sqlite3_compileoption_used(const char *zOptName){
4296 int i, n;
4297 int nOpt;
4298 const char **azCompileOpt;
4299
4300#if SQLITE_ENABLE_API_ARMOR
4301 if( zOptName==0 ){
4302 (void)SQLITE_MISUSE_BKPT;
4303 return 0;
4304 }
4305#endif
4306
4307 azCompileOpt = sqlite3CompileOptions(&nOpt);
4308
4309 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4310 n = sqlite3Strlen30(zOptName);
4311
4312 /* Since nOpt is normally in single digits, a linear search is
4313 ** adequate. No need for a binary search. */
4314 for(i=0; i<nOpt; i++){
4315 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4316 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4317 ){
4318 return 1;
4319 }
4320 }
4321 return 0;
4322}
4323
4324/*
4325** Return the N-th compile-time option string. If N is out of range,
4326** return a NULL pointer.
4327*/
4328const char *sqlite3_compileoption_get(int N){
4329 int nOpt;
4330 const char **azCompileOpt;
4331 azCompileOpt = sqlite3CompileOptions(&nOpt);
4332 if( N>=0 && N<nOpt ){
4333 return azCompileOpt[N];
4334 }
4335 return 0;
4336}
4337#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */