blob: 98e030fad15521763a06c8c8e3601ddfec66350f [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 */
drhffd3fd02020-01-29 13:10:50 +0000164 if( sqlite3GlobalConfig.isInit ){
165 sqlite3MemoryBarrier();
166 return SQLITE_OK;
167 }
danielk197771bc31c2008-06-26 08:29:34 +0000168
drh93ed56d2008-08-12 15:21:11 +0000169 /* Make sure the mutex subsystem is initialized. If unable to
170 ** initialize the mutex subsystem, return early with the error.
171 ** If the system is so sick that we are unable to allocate a mutex,
172 ** there is not much SQLite is going to be able to do.
173 **
174 ** The mutex subsystem must take care of serializing its own
175 ** initialization.
176 */
danielk1977d0251742008-06-18 18:57:42 +0000177 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000178 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000179
drh93ed56d2008-08-12 15:21:11 +0000180 /* Initialize the malloc() system and the recursive pInitMutex mutex.
181 ** This operation is protected by the STATIC_MASTER mutex. Note that
182 ** MutexAlloc() is called for a static mutex prior to initializing the
183 ** malloc subsystem - this implies that the allocation of a static
184 ** mutex must not require support from the malloc subsystem.
185 */
drh30ddce62011-10-15 00:16:30 +0000186 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000187 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000188 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000189 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000190 rc = sqlite3MallocInit();
191 }
drh40257ff2008-06-13 18:24:27 +0000192 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000193 sqlite3GlobalConfig.isMallocInit = 1;
194 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000195 sqlite3GlobalConfig.pInitMutex =
196 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000197 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
mistachkinfad30392016-02-13 23:43:46 +0000198 rc = SQLITE_NOMEM_BKPT;
drh40257ff2008-06-13 18:24:27 +0000199 }
200 }
danielk197777eb5bb2008-09-22 17:22:19 +0000201 }
202 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000203 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000204 }
205 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000206
dane1ab2192009-08-17 15:16:19 +0000207 /* If rc is not SQLITE_OK at this point, then either the malloc
208 ** subsystem could not be initialized or the system failed to allocate
209 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000210 if( rc!=SQLITE_OK ){
211 return rc;
212 }
213
214 /* Do the rest of the initialization under the recursive mutex so
215 ** that we will be able to handle recursive calls into
216 ** sqlite3_initialize(). The recursive calls normally come through
217 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
218 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000219 **
220 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
221 ** to the xInit method, so the xInit method need not be threadsafe.
222 **
223 ** The following mutex is what serializes access to the appdef pcache xInit
224 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
225 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000226 */
danielk1977075c23a2008-09-01 18:34:20 +0000227 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000228 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977502b4e02008-09-02 14:07:24 +0000229 sqlite3GlobalConfig.inProgress = 1;
drh5e3cefe2015-11-12 23:48:08 +0000230#ifdef SQLITE_ENABLE_SQLLOG
dand83f7ca2015-11-12 20:12:51 +0000231 {
drh5e3cefe2015-11-12 23:48:08 +0000232 extern void sqlite3_init_sqllog(void);
233 sqlite3_init_sqllog();
dand83f7ca2015-11-12 20:12:51 +0000234 }
235#endif
drh80738d92016-02-15 00:34:16 +0000236 memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
237 sqlite3RegisterBuiltinFunctions();
dane1ab2192009-08-17 15:16:19 +0000238 if( sqlite3GlobalConfig.isPCacheInit==0 ){
239 rc = sqlite3PcacheInitialize();
240 }
danielk19778c0a7912008-08-20 14:49:23 +0000241 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000242 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000243 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000244 }
drh9c6396e2018-03-06 21:43:19 +0000245#ifdef SQLITE_ENABLE_DESERIALIZE
drhac442f42018-01-03 01:28:46 +0000246 if( rc==SQLITE_OK ){
247 rc = sqlite3MemdbInit();
248 }
249#endif
drh0bf9f7b2009-04-17 16:54:22 +0000250 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000251 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
252 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000253 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000254#ifdef SQLITE_EXTRA_INIT
255 bRunExtraInit = 1;
256#endif
danielk19778c0a7912008-08-20 14:49:23 +0000257 }
danielk1977502b4e02008-09-02 14:07:24 +0000258 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000259 }
danielk1977075c23a2008-09-01 18:34:20 +0000260 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000261
drh93ed56d2008-08-12 15:21:11 +0000262 /* Go back under the static mutex and clean up the recursive
263 ** mutex to prevent a resource leak.
264 */
265 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000266 sqlite3GlobalConfig.nRefInitMutex--;
267 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
268 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
269 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
270 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000271 }
272 sqlite3_mutex_leave(pMaster);
273
274 /* The following is just a sanity check to make sure SQLite has
275 ** been compiled correctly. It is important to run this code, but
276 ** we don't want to run it too often and soak up CPU cycles for no
277 ** reason. So we run it once during initialization.
278 */
shanedfb7b372008-07-22 05:13:30 +0000279#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000280#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000281 /* This section of code's only "output" is via assert() statements. */
drhac442f42018-01-03 01:28:46 +0000282 if( rc==SQLITE_OK ){
shanedfb7b372008-07-22 05:13:30 +0000283 u64 x = (((u64)1)<<63)-1;
284 double y;
285 assert(sizeof(x)==8);
286 assert(sizeof(x)==sizeof(y));
287 memcpy(&y, &x, 8);
288 assert( sqlite3IsNaN(y) );
289 }
290#endif
shanefbd60f82009-02-04 03:59:25 +0000291#endif
shanedfb7b372008-07-22 05:13:30 +0000292
drhe4cf0b32011-08-25 00:14:41 +0000293 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
294 ** compile-time option.
295 */
296#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000297 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000298 int SQLITE_EXTRA_INIT(const char*);
299 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000300 }
301#endif
302
drh40257ff2008-06-13 18:24:27 +0000303 return rc;
304}
305
306/*
307** Undo the effects of sqlite3_initialize(). Must not be called while
308** there are outstanding database connections or memory allocations or
309** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000310** routine is not threadsafe. But it is safe to invoke this routine
311** on when SQLite is already shut down. If SQLite is already shut down
312** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000313*/
314int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000315#ifdef SQLITE_OMIT_WSD
316 int rc = sqlite3_wsd_init(4096, 24);
317 if( rc!=SQLITE_OK ){
318 return rc;
319 }
320#endif
321
danielk1977075c23a2008-09-01 18:34:20 +0000322 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000323#ifdef SQLITE_EXTRA_SHUTDOWN
324 void SQLITE_EXTRA_SHUTDOWN(void);
325 SQLITE_EXTRA_SHUTDOWN();
326#endif
drha7640922009-04-21 12:02:56 +0000327 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000328 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000329 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000330 }
dane1ab2192009-08-17 15:16:19 +0000331 if( sqlite3GlobalConfig.isPCacheInit ){
332 sqlite3PcacheShutdown();
333 sqlite3GlobalConfig.isPCacheInit = 0;
334 }
335 if( sqlite3GlobalConfig.isMallocInit ){
336 sqlite3MallocEnd();
337 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000338
339#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
340 /* The heap subsystem has now been shutdown and these values are supposed
341 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
342 ** which would rely on that heap subsystem; therefore, make sure these
343 ** values cannot refer to heap memory that was just invalidated when the
344 ** heap subsystem was shutdown. This is only done if the current call to
345 ** this function resulted in the heap subsystem actually being shutdown.
346 */
347 sqlite3_data_directory = 0;
348 sqlite3_temp_directory = 0;
349#endif
dane1ab2192009-08-17 15:16:19 +0000350 }
351 if( sqlite3GlobalConfig.isMutexInit ){
352 sqlite3MutexEnd();
353 sqlite3GlobalConfig.isMutexInit = 0;
354 }
355
drh40257ff2008-06-13 18:24:27 +0000356 return SQLITE_OK;
357}
358
359/*
360** This API allows applications to modify the global configuration of
361** the SQLite library at run-time.
362**
363** This routine should only be called when there are no outstanding
364** database connections or memory allocations. This routine is not
365** threadsafe. Failure to heed these warnings can lead to unpredictable
366** behavior.
367*/
368int sqlite3_config(int op, ...){
369 va_list ap;
370 int rc = SQLITE_OK;
371
372 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
373 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000374 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000375
376 va_start(ap, op);
377 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000378
379 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000380 ** compile.
drh18472fa2008-10-07 15:25:48 +0000381 */
drhd1dcb232014-11-01 18:32:18 +0000382#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000383 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000384 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
385 ** Single-thread. */
386 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
387 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000388 break;
389 }
drhd1dcb232014-11-01 18:32:18 +0000390#endif
391#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000392 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000393 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
394 ** Multi-thread. */
395 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
396 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000397 break;
398 }
drhd1dcb232014-11-01 18:32:18 +0000399#endif
400#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000401 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000402 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
403 ** Serialized. */
404 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
405 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000406 break;
407 }
drhd1dcb232014-11-01 18:32:18 +0000408#endif
409#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000410 case SQLITE_CONFIG_MUTEX: {
411 /* Specify an alternative mutex implementation */
412 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
413 break;
414 }
drhd1dcb232014-11-01 18:32:18 +0000415#endif
416#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000417 case SQLITE_CONFIG_GETMUTEX: {
418 /* Retrieve the current mutex implementation */
419 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
420 break;
421 }
422#endif
423
drh40257ff2008-06-13 18:24:27 +0000424 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000425 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
426 ** single argument which is a pointer to an instance of the
427 ** sqlite3_mem_methods structure. The argument specifies alternative
428 ** low-level memory allocation routines to be used in place of the memory
429 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000430 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000431 break;
432 }
drh33589792008-06-18 13:27:46 +0000433 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000434 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
435 ** single argument which is a pointer to an instance of the
436 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
437 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000438 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
439 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000440 break;
441 }
drhfec00ea2008-06-14 16:56:21 +0000442 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000443 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
444 ** single argument of type int, interpreted as a boolean, which enables
445 ** or disables the collection of memory allocation statistics. */
446 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000447 break;
448 }
drhb2a0f752017-08-28 15:51:35 +0000449 case SQLITE_CONFIG_SMALL_MALLOC: {
450 sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000451 break;
452 }
453 case SQLITE_CONFIG_PAGECACHE: {
drh15427272015-12-03 22:33:55 +0000454 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
455 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
456 ** the size of each page cache line (sz), and the number of cache lines
457 ** (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000458 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
459 sqlite3GlobalConfig.szPage = va_arg(ap, int);
460 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000461 break;
462 }
drhdef68892014-11-04 12:11:23 +0000463 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000464 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
465 ** a single parameter which is a pointer to an integer and writes into
466 ** that integer the number of extra bytes per page required for each page
467 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000468 *va_arg(ap, int*) =
469 sqlite3HeaderSizeBtree() +
470 sqlite3HeaderSizePcache() +
471 sqlite3HeaderSizePcache1();
472 break;
473 }
danielk19775099be52008-06-27 13:27:03 +0000474
danielk1977bc2ca9e2008-11-13 14:28:28 +0000475 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000476 /* no-op */
477 break;
478 }
479 case SQLITE_CONFIG_GETPCACHE: {
480 /* now an error */
481 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000482 break;
483 }
484
dan22e21ff2011-11-08 20:08:44 +0000485 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000486 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
487 ** single argument which is a pointer to an sqlite3_pcache_methods2
488 ** object. This object specifies the interface to a custom page cache
489 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000490 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
491 break;
492 }
493 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000494 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
495 ** single argument which is a pointer to an sqlite3_pcache_methods2
496 ** object. SQLite copies of the current page cache implementation into
497 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000498 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000499 sqlite3PCacheSetDefault();
500 }
dan22e21ff2011-11-08 20:08:44 +0000501 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000502 break;
503 }
504
drh8790b6e2014-11-07 01:43:56 +0000505/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
506** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
507** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000508#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000509 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000510 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
511 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000512 ** number of bytes in the memory buffer, and the minimum allocation size.
513 */
danielk1977075c23a2008-09-01 18:34:20 +0000514 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
515 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
516 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000517
shaneha6ec8922011-03-09 21:36:17 +0000518 if( sqlite3GlobalConfig.mnReq<1 ){
519 sqlite3GlobalConfig.mnReq = 1;
520 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
521 /* cap min request size at 2^12 */
522 sqlite3GlobalConfig.mnReq = (1<<12);
523 }
524
danielk1977075c23a2008-09-01 18:34:20 +0000525 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000526 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
527 ** is NULL, then SQLite reverts to using its default memory allocator
528 ** (the system malloc() implementation), undoing any prior invocation of
529 ** SQLITE_CONFIG_MALLOC.
530 **
531 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
532 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000533 */
danielk1977075c23a2008-09-01 18:34:20 +0000534 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000535 }else{
drh8790b6e2014-11-07 01:43:56 +0000536 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
537 ** alternative memory allocator is engaged to handle all of SQLites
538 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000539#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000540 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000541#endif
542#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000543 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000544#endif
drh8a42cbd2008-07-10 18:13:42 +0000545 }
danielk19775099be52008-06-27 13:27:03 +0000546 break;
547 }
drh5d414832008-07-15 14:47:18 +0000548#endif
danielk19775099be52008-06-27 13:27:03 +0000549
drh633e6d52008-07-28 19:34:53 +0000550 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000551 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
552 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000553 break;
554 }
drh3f280702010-02-18 18:45:09 +0000555
mistachkin037933b2013-08-13 22:33:41 +0000556 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000557 ** The default is NULL. Logging is disabled if the function pointer is
558 ** NULL.
559 */
560 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000561 /* MSVC is picky about pulling func ptrs from va lists.
562 ** http://support.microsoft.com/kb/47961
563 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
564 */
565 typedef void(*LOGFUNC_t)(void*,int,const char*);
566 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000567 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
568 break;
569 }
drh633e6d52008-07-28 19:34:53 +0000570
drh00729cb2014-10-04 11:59:33 +0000571 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
572 ** can be changed at start-time using the
573 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
574 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
575 */
dancd74b612011-04-22 19:37:32 +0000576 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000577 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
578 ** argument of type int. If non-zero, then URI handling is globally
579 ** enabled. If the parameter is zero, then URI handling is globally
580 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000581 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
582 break;
583 }
584
drhde9a7b82012-09-17 20:44:46 +0000585 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000586 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
587 ** option takes a single integer argument which is interpreted as a
588 ** boolean in order to enable or disable the use of covering indices for
589 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000590 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
591 break;
592 }
593
danac455932012-11-26 19:50:41 +0000594#ifdef SQLITE_ENABLE_SQLLOG
595 case SQLITE_CONFIG_SQLLOG: {
596 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
597 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
598 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
599 break;
600 }
601#endif
602
drh9b4c59f2013-04-15 17:03:42 +0000603 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000604 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
605 ** integer (sqlite3_int64) values that are the default mmap size limit
606 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
607 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000608 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000609 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000610 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000611 ** negative, then that argument is changed to its compile-time default.
612 **
613 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
614 ** silently truncated if necessary so that it does not exceed the
615 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
616 ** compile-time option.
617 */
drh3ba689d2015-03-03 14:00:11 +0000618 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
619 mxMmap = SQLITE_MAX_MMAP_SIZE;
620 }
drh9b4c59f2013-04-15 17:03:42 +0000621 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
622 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000623 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000624 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000625 break;
626 }
627
drh4d9f1882014-11-04 17:23:24 +0000628#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000629 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000630 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
631 ** unsigned integer value that specifies the maximum size of the created
632 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000633 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
634 break;
635 }
636#endif
637
drh3bd17912015-01-02 15:55:29 +0000638 case SQLITE_CONFIG_PMASZ: {
639 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
640 break;
641 }
642
drh8c71a982016-03-07 17:37:37 +0000643 case SQLITE_CONFIG_STMTJRNL_SPILL: {
644 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
645 break;
646 }
647
dan2e3a5a82018-04-16 21:12:42 +0000648#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbade8d2018-04-18 14:48:08 +0000649 case SQLITE_CONFIG_SORTERREF_SIZE: {
dan2e3a5a82018-04-16 21:12:42 +0000650 int iVal = va_arg(ap, int);
651 if( iVal<0 ){
652 iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
653 }
654 sqlite3GlobalConfig.szSorterRef = (u32)iVal;
dan2e3a5a82018-04-16 21:12:42 +0000655 break;
656 }
drhbbade8d2018-04-18 14:48:08 +0000657#endif /* SQLITE_ENABLE_SORTER_REFERENCES */
dan2e3a5a82018-04-16 21:12:42 +0000658
drh23a88592019-01-31 15:38:53 +0000659#ifdef SQLITE_ENABLE_DESERIALIZE
660 case SQLITE_CONFIG_MEMDB_MAXSIZE: {
661 sqlite3GlobalConfig.mxMemdbSize = va_arg(ap, sqlite3_int64);
662 break;
663 }
664#endif /* SQLITE_ENABLE_DESERIALIZE */
665
drh40257ff2008-06-13 18:24:27 +0000666 default: {
667 rc = SQLITE_ERROR;
668 break;
669 }
670 }
671 va_end(ap);
672 return rc;
673}
674
675/*
drh633e6d52008-07-28 19:34:53 +0000676** Set up the lookaside buffers for a database connection.
677** Return SQLITE_OK on success.
678** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000679**
680** The sz parameter is the number of bytes in each lookaside slot.
681** The cnt parameter is the number of slots. If pStart is NULL the
682** space for the lookaside memory is obtained from sqlite3_malloc().
683** If pStart is not NULL then it is sz*cnt bytes of memory to use for
684** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000685*/
drhe9d1c722008-08-04 20:13:26 +0000686static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000687#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000688 void *pStart;
numist115d6632019-12-12 02:50:07 +0000689 sqlite3_int64 szAlloc = sz*(sqlite3_int64)cnt;
drhe6068022019-12-13 15:48:21 +0000690 int nBig; /* Number of full-size slots */
drhcf014f62019-12-31 15:12:34 +0000691 int nSm; /* Number smaller LOOKASIDE_SMALL-byte slots */
drh52fb8e12017-08-29 20:21:12 +0000692
693 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000694 return SQLITE_BUSY;
695 }
shanef71f89e2009-01-30 06:11:54 +0000696 /* Free any existing lookaside buffer for this handle before
697 ** allocating a new one so we don't have to have space for
698 ** both at the same time.
699 */
700 if( db->lookaside.bMalloced ){
701 sqlite3_free(db->lookaside.pStart);
702 }
drh61a4bd52011-11-10 02:39:28 +0000703 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
704 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000705 */
drh61a4bd52011-11-10 02:39:28 +0000706 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000707 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000708 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000709 if( sz==0 || cnt==0 ){
710 sz = 0;
711 pStart = 0;
712 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000713 sqlite3BeginBenignMalloc();
numist115d6632019-12-12 02:50:07 +0000714 pStart = sqlite3Malloc( szAlloc ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000715 sqlite3EndBenignMalloc();
drhe6068022019-12-13 15:48:21 +0000716 if( pStart ) szAlloc = sqlite3MallocSize(pStart);
drhe9d1c722008-08-04 20:13:26 +0000717 }else{
718 pStart = pBuf;
719 }
drhcf014f62019-12-31 15:12:34 +0000720#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
721 if( sz>=LOOKASIDE_SMALL*3 ){
722 nBig = szAlloc/(3*LOOKASIDE_SMALL+sz);
723 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
724 }else if( sz>=LOOKASIDE_SMALL*2 ){
725 nBig = szAlloc/(LOOKASIDE_SMALL+sz);
726 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
drhe6068022019-12-13 15:48:21 +0000727 }else
drhcf014f62019-12-31 15:12:34 +0000728#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000729 if( sz>0 ){
730 nBig = szAlloc/sz;
731 nSm = 0;
732 }else{
733 nBig = nSm = 0;
734 }
drh4cfb22f2008-08-01 18:47:01 +0000735 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000736 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000737 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000738 db->lookaside.sz = (u16)sz;
drh31f69622019-10-05 14:39:36 +0000739 db->lookaside.szTrue = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000740 if( pStart ){
741 int i;
742 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000743 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000744 p = (LookasideSlot*)pStart;
drhe6068022019-12-13 15:48:21 +0000745 for(i=0; i<nBig; i++){
drh52fb8e12017-08-29 20:21:12 +0000746 p->pNext = db->lookaside.pInit;
747 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000748 p = (LookasideSlot*)&((u8*)p)[sz];
749 }
drhcf014f62019-12-31 15:12:34 +0000750#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
751 db->lookaside.pSmallInit = 0;
752 db->lookaside.pSmallFree = 0;
numist115d6632019-12-12 02:50:07 +0000753 db->lookaside.pMiddle = p;
drhe6068022019-12-13 15:48:21 +0000754 for(i=0; i<nSm; i++){
drhcf014f62019-12-31 15:12:34 +0000755 p->pNext = db->lookaside.pSmallInit;
756 db->lookaside.pSmallInit = p;
757 p = (LookasideSlot*)&((u8*)p)[LOOKASIDE_SMALL];
numist115d6632019-12-12 02:50:07 +0000758 }
drhcf014f62019-12-31 15:12:34 +0000759#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000760 assert( ((uptr)p)<=szAlloc + (uptr)pStart );
drh633e6d52008-07-28 19:34:53 +0000761 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000762 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000763 db->lookaside.bMalloced = pBuf==0 ?1:0;
drhe6068022019-12-13 15:48:21 +0000764 db->lookaside.nSlot = nBig+nSm;
drh4cfb22f2008-08-01 18:47:01 +0000765 }else{
drhb0e77042013-12-10 19:49:00 +0000766 db->lookaside.pStart = db;
drhcf014f62019-12-31 15:12:34 +0000767#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
768 db->lookaside.pSmallInit = 0;
769 db->lookaside.pSmallFree = 0;
drhe6068022019-12-13 15:48:21 +0000770 db->lookaside.pMiddle = db;
drhcf014f62019-12-31 15:12:34 +0000771#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhb0e77042013-12-10 19:49:00 +0000772 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000773 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +0000774 db->lookaside.sz = 0;
shanef71f89e2009-01-30 06:11:54 +0000775 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000776 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000777 }
drhe6068022019-12-13 15:48:21 +0000778 assert( sqlite3LookasideUsed(db,0)==0 );
drh7877d9a2015-07-23 17:16:27 +0000779#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000780 return SQLITE_OK;
781}
782
783/*
drh4413d0e2008-11-04 13:46:27 +0000784** Return the mutex associated with a database connection.
785*/
786sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000787#ifdef SQLITE_ENABLE_API_ARMOR
788 if( !sqlite3SafetyCheckOk(db) ){
789 (void)SQLITE_MISUSE_BKPT;
790 return 0;
791 }
792#endif
drh4413d0e2008-11-04 13:46:27 +0000793 return db->mutex;
794}
795
796/*
drh09419b42011-11-16 19:29:17 +0000797** Free up as much memory as we can from the given database
798** connection.
799*/
800int sqlite3_db_release_memory(sqlite3 *db){
801 int i;
drh9ca95732014-10-24 00:35:58 +0000802
803#ifdef SQLITE_ENABLE_API_ARMOR
804 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
805#endif
dand9bb3a92011-12-30 11:43:59 +0000806 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000807 sqlite3BtreeEnterAll(db);
808 for(i=0; i<db->nDb; i++){
809 Btree *pBt = db->aDb[i].pBt;
810 if( pBt ){
811 Pager *pPager = sqlite3BtreePager(pBt);
812 sqlite3PagerShrink(pPager);
813 }
814 }
815 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000816 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000817 return SQLITE_OK;
818}
819
820/*
dan6fa255f2015-10-28 19:46:57 +0000821** Flush any dirty pages in the pager-cache for any attached database
822** to disk.
823*/
824int sqlite3_db_cacheflush(sqlite3 *db){
825 int i;
826 int rc = SQLITE_OK;
827 int bSeenBusy = 0;
828
829#ifdef SQLITE_ENABLE_API_ARMOR
830 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
831#endif
832 sqlite3_mutex_enter(db->mutex);
833 sqlite3BtreeEnterAll(db);
834 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
835 Btree *pBt = db->aDb[i].pBt;
836 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
837 Pager *pPager = sqlite3BtreePager(pBt);
838 rc = sqlite3PagerFlush(pPager);
839 if( rc==SQLITE_BUSY ){
840 bSeenBusy = 1;
841 rc = SQLITE_OK;
842 }
843 }
844 }
dan6fa255f2015-10-28 19:46:57 +0000845 sqlite3BtreeLeaveAll(db);
846 sqlite3_mutex_leave(db->mutex);
847 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
848}
849
850/*
drh633e6d52008-07-28 19:34:53 +0000851** Configuration settings for an individual database connection
852*/
853int sqlite3_db_config(sqlite3 *db, int op, ...){
854 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000855 int rc;
drh633e6d52008-07-28 19:34:53 +0000856 va_start(ap, op);
857 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000858 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000859 /* IMP: R-06824-28531 */
860 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000861 db->aDb[0].zDbSName = va_arg(ap,char*);
862 rc = SQLITE_OK;
863 break;
864 }
drhe9d1c722008-08-04 20:13:26 +0000865 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000866 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000867 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
868 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000869 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000870 break;
871 }
drh6480aad2008-08-01 16:31:14 +0000872 default: {
drhe83cafd2011-03-21 17:15:58 +0000873 static const struct {
874 int op; /* The opcode */
875 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
876 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000877 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
878 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
drh11d88e62019-08-15 21:27:20 +0000879 { SQLITE_DBCONFIG_ENABLE_VIEW, SQLITE_EnableView },
drhd42908f2016-02-26 15:38:24 +0000880 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000881 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000882 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000883 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000884 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000885 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drha296cda2018-11-03 16:09:59 +0000886 { SQLITE_DBCONFIG_DEFENSIVE, SQLITE_Defensive },
drh346f4e22019-03-25 21:35:41 +0000887 { SQLITE_DBCONFIG_WRITABLE_SCHEMA, SQLITE_WriteSchema|
888 SQLITE_NoSchemaError },
drh0a6873b2019-06-14 21:25:25 +0000889 { SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, SQLITE_LegacyAlter },
drhd0ff6012019-06-17 13:56:11 +0000890 { SQLITE_DBCONFIG_DQS_DDL, SQLITE_DqsDDL },
891 { SQLITE_DBCONFIG_DQS_DML, SQLITE_DqsDML },
drh66c48902019-10-29 16:18:45 +0000892 { SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, SQLITE_LegacyFileFmt },
drhb77da372020-01-07 16:09:11 +0000893 { SQLITE_DBCONFIG_TRUSTED_SCHEMA, SQLITE_TrustedSchema },
drhe83cafd2011-03-21 17:15:58 +0000894 };
drh58ad5802011-03-23 22:02:23 +0000895 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000896 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000897 for(i=0; i<ArraySize(aFlagOp); i++){
898 if( aFlagOp[i].op==op ){
899 int onoff = va_arg(ap, int);
900 int *pRes = va_arg(ap, int*);
drh70d5dfb2018-12-06 16:50:55 +0000901 u64 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000902 if( onoff>0 ){
903 db->flags |= aFlagOp[i].mask;
904 }else if( onoff==0 ){
drhd5b44d62018-12-06 17:06:02 +0000905 db->flags &= ~(u64)aFlagOp[i].mask;
drhe83cafd2011-03-21 17:15:58 +0000906 }
907 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000908 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000909 }
910 if( pRes ){
911 *pRes = (db->flags & aFlagOp[i].mask)!=0;
912 }
913 rc = SQLITE_OK;
914 break;
915 }
916 }
drh6480aad2008-08-01 16:31:14 +0000917 break;
918 }
drh633e6d52008-07-28 19:34:53 +0000919 }
920 va_end(ap);
921 return rc;
922}
923
drh9b5adfa2008-01-20 23:19:56 +0000924/*
drhd3d39e92004-05-20 22:16:29 +0000925** This is the default collating function named "BINARY" which is always
926** available.
927*/
danielk19772c336542005-01-13 02:14:23 +0000928static int binCollFunc(
drh821afa42019-06-14 13:24:46 +0000929 void *NotUsed,
drhd3d39e92004-05-20 22:16:29 +0000930 int nKey1, const void *pKey1,
931 int nKey2, const void *pKey2
932){
933 int rc, n;
drh821afa42019-06-14 13:24:46 +0000934 UNUSED_PARAMETER(NotUsed);
drhd3d39e92004-05-20 22:16:29 +0000935 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000936 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
937 ** strings byte by byte using the memcmp() function from the standard C
938 ** library. */
dan21766c02017-05-22 08:04:09 +0000939 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +0000940 rc = memcmp(pKey1, pKey2, n);
941 if( rc==0 ){
drh821afa42019-06-14 13:24:46 +0000942 rc = nKey1 - nKey2;
drhd3d39e92004-05-20 22:16:29 +0000943 }
944 return rc;
945}
946
947/*
drh821afa42019-06-14 13:24:46 +0000948** This is the collating function named "RTRIM" which is always
949** available. Ignore trailing spaces.
950*/
951static int rtrimCollFunc(
952 void *pUser,
953 int nKey1, const void *pKey1,
954 int nKey2, const void *pKey2
955){
956 const u8 *pK1 = (const u8*)pKey1;
957 const u8 *pK2 = (const u8*)pKey2;
958 while( nKey1 && pK1[nKey1-1]==' ' ) nKey1--;
959 while( nKey2 && pK2[nKey2-1]==' ' ) nKey2--;
960 return binCollFunc(pUser, nKey1, pKey1, nKey2, pKey2);
961}
962
963/*
drhbcd15932018-07-27 18:12:40 +0000964** Return true if CollSeq is the default built-in BINARY.
965*/
966int sqlite3IsBinary(const CollSeq *p){
drh821afa42019-06-14 13:24:46 +0000967 assert( p==0 || p->xCmp!=binCollFunc || strcmp(p->zName,"BINARY")==0 );
968 return p==0 || p->xCmp==binCollFunc;
drhbcd15932018-07-27 18:12:40 +0000969}
970
971/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000972** Another built-in collating sequence: NOCASE.
973**
drhf7b54962013-05-28 12:11:54 +0000974** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000975** comparison". SQLite's knowledge of upper and lower case equivalents
976** extends only to the 26 characters used in the English language.
977**
978** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000979*/
980static int nocaseCollatingFunc(
981 void *NotUsed,
982 int nKey1, const void *pKey1,
983 int nKey2, const void *pKey2
984){
985 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000986 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000987 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000988 if( 0==r ){
989 r = nKey1-nKey2;
990 }
991 return r;
992}
993
994/*
drhaf9ff332002-01-16 21:00:27 +0000995** Return the ROWID of the most recent insert
996*/
drh9bb575f2004-09-06 17:24:11 +0000997sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000998#ifdef SQLITE_ENABLE_API_ARMOR
999 if( !sqlite3SafetyCheckOk(db) ){
1000 (void)SQLITE_MISUSE_BKPT;
1001 return 0;
1002 }
1003#endif
drhaf9ff332002-01-16 21:00:27 +00001004 return db->lastRowid;
1005}
1006
1007/*
dan9c58b632017-02-27 14:52:48 +00001008** Set the value returned by the sqlite3_last_insert_rowid() API function.
1009*/
1010void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
1011#ifdef SQLITE_ENABLE_API_ARMOR
1012 if( !sqlite3SafetyCheckOk(db) ){
1013 (void)SQLITE_MISUSE_BKPT;
1014 return;
1015 }
1016#endif
1017 sqlite3_mutex_enter(db->mutex);
1018 db->lastRowid = iRowid;
1019 sqlite3_mutex_leave(db->mutex);
1020}
1021
1022/*
danielk197724b03fd2004-05-10 10:34:34 +00001023** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +00001024*/
drh9bb575f2004-09-06 17:24:11 +00001025int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001026#ifdef SQLITE_ENABLE_API_ARMOR
1027 if( !sqlite3SafetyCheckOk(db) ){
1028 (void)SQLITE_MISUSE_BKPT;
1029 return 0;
1030 }
1031#endif
drhc8d30ac2002-04-12 10:08:59 +00001032 return db->nChange;
1033}
1034
rdcf146a772004-02-25 22:51:06 +00001035/*
danielk1977b28af712004-06-21 06:50:26 +00001036** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +00001037*/
danielk1977b28af712004-06-21 06:50:26 +00001038int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001039#ifdef SQLITE_ENABLE_API_ARMOR
1040 if( !sqlite3SafetyCheckOk(db) ){
1041 (void)SQLITE_MISUSE_BKPT;
1042 return 0;
1043 }
1044#endif
danielk1977b28af712004-06-21 06:50:26 +00001045 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +00001046}
1047
drhc8d30ac2002-04-12 10:08:59 +00001048/*
danielk1977fd7f0452008-12-17 17:30:26 +00001049** Close all open savepoints. This function only manipulates fields of the
1050** database handle object, it does not close any savepoints that may be open
1051** at the b-tree/pager level.
1052*/
1053void sqlite3CloseSavepoints(sqlite3 *db){
1054 while( db->pSavepoint ){
1055 Savepoint *pTmp = db->pSavepoint;
1056 db->pSavepoint = pTmp->pNext;
1057 sqlite3DbFree(db, pTmp);
1058 }
1059 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001060 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001061 db->isTransactionSavepoint = 0;
1062}
1063
1064/*
dand2199f02010-08-27 17:48:52 +00001065** Invoke the destructor function associated with FuncDef p, if any. Except,
1066** if this is not the last copy of the function, do not invoke it. Multiple
1067** copies of a single function are created when create_function() is called
1068** with SQLITE_ANY as the encoding.
1069*/
1070static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001071 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001072 if( pDestructor ){
1073 pDestructor->nRef--;
1074 if( pDestructor->nRef==0 ){
1075 pDestructor->xDestroy(pDestructor->pUserData);
1076 sqlite3DbFree(db, pDestructor);
1077 }
1078 }
1079}
1080
1081/*
danbba02a92012-05-15 17:15:34 +00001082** Disconnect all sqlite3_vtab objects that belong to database connection
1083** db. This is called when db is being closed.
1084*/
1085static void disconnectAllVtab(sqlite3 *db){
1086#ifndef SQLITE_OMIT_VIRTUALTABLE
1087 int i;
drh51be3872015-08-19 02:32:25 +00001088 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001089 sqlite3BtreeEnterAll(db);
1090 for(i=0; i<db->nDb; i++){
1091 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001092 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001093 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1094 Table *pTab = (Table *)sqliteHashData(p);
1095 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1096 }
1097 }
1098 }
drh51be3872015-08-19 02:32:25 +00001099 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1100 Module *pMod = (Module *)sqliteHashData(p);
1101 if( pMod->pEpoTab ){
1102 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1103 }
1104 }
dand88e5212014-03-12 19:38:38 +00001105 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001106 sqlite3BtreeLeaveAll(db);
1107#else
1108 UNUSED_PARAMETER(db);
1109#endif
1110}
1111
1112/*
drh167cd6a2012-06-02 17:09:46 +00001113** Return TRUE if database connection db has unfinalized prepared
1114** statements or unfinished sqlite3_backup objects.
1115*/
1116static int connectionIsBusy(sqlite3 *db){
1117 int j;
1118 assert( sqlite3_mutex_held(db->mutex) );
1119 if( db->pVdbe ) return 1;
1120 for(j=0; j<db->nDb; j++){
1121 Btree *pBt = db->aDb[j].pBt;
1122 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1123 }
1124 return 0;
1125}
1126
1127/*
drh50e5dad2001-09-15 00:57:28 +00001128** Close an existing SQLite database
1129*/
drh167cd6a2012-06-02 17:09:46 +00001130static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001131 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001132 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1133 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001134 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001135 }
drh7e8b8482008-01-23 03:03:05 +00001136 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001137 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001138 }
drh605264d2007-08-21 15:13:19 +00001139 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001140 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1141 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1142 }
danielk1977e35ee192004-06-26 09:50:11 +00001143
danbba02a92012-05-15 17:15:34 +00001144 /* Force xDisconnect calls on all virtual tables */
1145 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001146
danbba02a92012-05-15 17:15:34 +00001147 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001148 ** will not have called the xDisconnect() method on any virtual
1149 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1150 ** call will do so. We need to do this before the check for active
1151 ** SQL statements below, as the v-table implementation may be storing
1152 ** some prepared statements internally.
1153 */
dan67430812013-05-15 10:21:50 +00001154 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001155
drh167cd6a2012-06-02 17:09:46 +00001156 /* Legacy behavior (sqlite3_close() behavior) is to return
1157 ** SQLITE_BUSY if the connection can not be closed immediately.
1158 */
1159 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001160 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001161 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001162 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001163 return SQLITE_BUSY;
1164 }
danielk1977e0048402004-06-15 16:51:01 +00001165
danac455932012-11-26 19:50:41 +00001166#ifdef SQLITE_ENABLE_SQLLOG
1167 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001168 /* Closing the handle. Fourth parameter is passed the value 2. */
1169 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001170 }
1171#endif
1172
drh167cd6a2012-06-02 17:09:46 +00001173 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001174 */
1175 db->magic = SQLITE_MAGIC_ZOMBIE;
1176 sqlite3LeaveMutexAndCloseZombie(db);
1177 return SQLITE_OK;
1178}
drh94e92032003-02-16 22:21:32 +00001179
drh167cd6a2012-06-02 17:09:46 +00001180/*
1181** Two variations on the public interface for closing a database
1182** connection. The sqlite3_close() version returns SQLITE_BUSY and
1183** leaves the connection option if there are unfinalized prepared
1184** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1185** version forces the connection to become a zombie if there are
1186** unclosed resources, and arranges for deallocation when the last
1187** prepare statement or sqlite3_backup closes.
1188*/
1189int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1190int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1191
drh4245c402012-06-02 14:32:21 +00001192
1193/*
1194** Close the mutex on database connection db.
1195**
1196** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001197** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1198** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1199** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001200*/
1201void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1202 HashElem *i; /* Hash table iterator */
1203 int j;
1204
drh4245c402012-06-02 14:32:21 +00001205 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001206 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1207 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001208 */
drh167cd6a2012-06-02 17:09:46 +00001209 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001210 sqlite3_mutex_leave(db->mutex);
1211 return;
danielk197704103022009-02-03 16:51:24 +00001212 }
1213
drh4245c402012-06-02 14:32:21 +00001214 /* If we reach this point, it means that the database connection has
1215 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001216 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001217 ** go ahead and free all resources.
1218 */
1219
dan617dc862013-05-16 11:57:28 +00001220 /* If a transaction is open, roll it back. This also ensures that if
1221 ** any database schemas have been modified by an uncommitted transaction
1222 ** they are reset. And that the required b-tree mutex is held to make
1223 ** the pager rollback and schema reset an atomic operation. */
1224 sqlite3RollbackAll(db, SQLITE_OK);
1225
danielk1977fd7f0452008-12-17 17:30:26 +00001226 /* Free any outstanding Savepoint structures. */
1227 sqlite3CloseSavepoints(db);
1228
drh5efb3142012-05-16 01:24:34 +00001229 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001230 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001231 struct Db *pDb = &db->aDb[j];
1232 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001233 sqlite3BtreeClose(pDb->pBt);
1234 pDb->pBt = 0;
1235 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001236 pDb->pSchema = 0;
1237 }
drh113088e2003-03-20 01:16:58 +00001238 }
drhf57b3392001-10-08 13:22:32 +00001239 }
drh5efb3142012-05-16 01:24:34 +00001240 /* Clear the TEMP schema separately and last */
1241 if( db->aDb[1].pSchema ){
1242 sqlite3SchemaClear(db->aDb[1].pSchema);
1243 }
1244 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001245
drh5efb3142012-05-16 01:24:34 +00001246 /* Free up the array of auxiliary databases */
1247 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001248 assert( db->nDb<=2 );
1249 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001250
1251 /* Tell the code in notify.c that the connection no longer holds any
1252 ** locks and does not require any further unlock-notify callbacks.
1253 */
1254 sqlite3ConnectionClosed(db);
1255
drh80738d92016-02-15 00:34:16 +00001256 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1257 FuncDef *pNext, *p;
1258 p = sqliteHashData(i);
1259 do{
1260 functionDestroy(db, p);
1261 pNext = p->pNext;
1262 sqlite3DbFree(db, p);
1263 p = pNext;
1264 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001265 }
drh80738d92016-02-15 00:34:16 +00001266 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001267 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001268 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001269 /* Invoke any destructors registered for collation sequence user data. */
1270 for(j=0; j<3; j++){
1271 if( pColl[j].xDel ){
1272 pColl[j].xDel(pColl[j].pUser);
1273 }
1274 }
drh633e6d52008-07-28 19:34:53 +00001275 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001276 }
danielk1977d8123362004-06-12 09:25:12 +00001277 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001278#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001279 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1280 Module *pMod = (Module *)sqliteHashData(i);
drh51be3872015-08-19 02:32:25 +00001281 sqlite3VtabEponymousTableClear(db, pMod);
drhcc5979d2019-08-16 22:58:29 +00001282 sqlite3VtabModuleUnref(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001283 }
drhb9bb7c12006-06-11 23:41:55 +00001284 sqlite3HashClear(&db->aModule);
1285#endif
danielk1977466be562004-06-10 02:16:01 +00001286
drh13f40da2014-08-22 18:00:11 +00001287 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001288 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001289 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001290#if SQLITE_USER_AUTHENTICATION
1291 sqlite3_free(db->auth.zAuthUser);
1292 sqlite3_free(db->auth.zAuthPW);
1293#endif
danielk197796d81f92004-06-19 03:33:57 +00001294
1295 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001296
1297 /* The temp-database schema is allocated differently from the other schema
1298 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1299 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1300 ** the same sqliteMalloc() as the one that allocates the database
1301 ** structure?
1302 */
drh633e6d52008-07-28 19:34:53 +00001303 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001304 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001305 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001306 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001307 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001308 if( db->lookaside.bMalloced ){
1309 sqlite3_free(db->lookaside.pStart);
1310 }
drh17435752007-08-16 04:30:38 +00001311 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001312}
1313
1314/*
drh0f198a72012-02-13 16:43:16 +00001315** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001316** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001317** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001318** attempts to use that cursor. Read cursors remain open and valid
1319** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001320*/
drh0f198a72012-02-13 16:43:16 +00001321void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001322 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001323 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001324 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001325 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001326 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001327
1328 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1329 ** This is important in case the transaction being rolled back has
1330 ** modified the database schema. If the b-tree mutexes are not taken
1331 ** here, then another shared-cache connection might sneak in between
1332 ** the database rollback and schema reset, which can cause false
1333 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001334 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001335 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001336
drh001bbcb2003-03-19 03:14:00 +00001337 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001338 Btree *p = db->aDb[i].pBt;
1339 if( p ){
1340 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001341 inTrans = 1;
1342 }
drh47b7fc72014-11-11 01:33:57 +00001343 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001344 }
1345 }
danielk1977a298e902006-06-22 09:53:48 +00001346 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001347 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001348
drh7f32dc92018-07-16 11:32:59 +00001349 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001350 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001351 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001352 }
dancd7b91a2013-05-13 18:23:15 +00001353 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001354
dan1da40a32009-09-19 17:00:31 +00001355 /* Any deferred constraint violations have now been resolved. */
1356 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001357 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00001358 db->flags &= ~(u64)SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001359
danielk197771fd80b2005-12-16 06:54:01 +00001360 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001361 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001362 db->xRollbackCallback(db->pRollbackArg);
1363 }
drh001bbcb2003-03-19 03:14:00 +00001364}
1365
1366/*
mistachkinf2c1c992013-04-28 01:44:43 +00001367** Return a static string containing the name corresponding to the error code
1368** specified in the argument.
1369*/
mistachkin5824d442015-04-28 23:34:10 +00001370#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001371const char *sqlite3ErrName(int rc){
1372 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001373 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001374 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1375 switch( rc ){
1376 case SQLITE_OK: zName = "SQLITE_OK"; break;
1377 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001378 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001379 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1380 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1381 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001382 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001383 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001384 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001385 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001386 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1387 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1388 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1389 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001390 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001391 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001392 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001393 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001394 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001395 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1396 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001397 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1398 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1399 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1400 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1401 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1402 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1403 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1404 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1405 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1406 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001407 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1408 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1409 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1410 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1411 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1412 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1413 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1414 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1415 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1416 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1417 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1418 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1419 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1420 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001421 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001422 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001423 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001424 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001425 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1426 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1427 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001428 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1429 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1430 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001431 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkin3c161e02019-11-18 23:48:03 +00001432 case SQLITE_CANTOPEN_SYMLINK: zName = "SQLITE_CANTOPEN_SYMLINK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001433 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1434 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1435 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1436 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1437 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1438 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1439 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1440 case SQLITE_CONSTRAINT_FOREIGNKEY:
1441 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1442 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1443 case SQLITE_CONSTRAINT_PRIMARYKEY:
1444 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1445 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1446 case SQLITE_CONSTRAINT_COMMITHOOK:
1447 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1448 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1449 case SQLITE_CONSTRAINT_FUNCTION:
1450 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001451 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001452 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1453 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1454 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1455 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1456 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1457 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1458 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1459 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1460 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001461 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1462 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1463 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001464 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001465 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001466 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001467 }
1468 }
mistachkin10269dc2013-04-30 07:54:42 +00001469 if( zName==0 ){
1470 static char zBuf[50];
1471 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1472 zName = zBuf;
1473 }
mistachkinf2c1c992013-04-28 01:44:43 +00001474 return zName;
1475}
mistachkin10269dc2013-04-30 07:54:42 +00001476#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001477
1478/*
drhc22bd472002-05-10 13:14:07 +00001479** Return a static string that describes the kind of error specified in the
1480** argument.
drh247be432002-05-10 05:44:55 +00001481*/
danielk1977f20b21c2004-05-31 23:56:42 +00001482const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001483 static const char* const aMsg[] = {
1484 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001485 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001486 /* SQLITE_INTERNAL */ 0,
1487 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001488 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001489 /* SQLITE_BUSY */ "database is locked",
1490 /* SQLITE_LOCKED */ "database table is locked",
1491 /* SQLITE_NOMEM */ "out of memory",
1492 /* SQLITE_READONLY */ "attempt to write a readonly database",
1493 /* SQLITE_INTERRUPT */ "interrupted",
1494 /* SQLITE_IOERR */ "disk I/O error",
1495 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001496 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001497 /* SQLITE_FULL */ "database or disk is full",
1498 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001499 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001500 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001501 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001502 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001503 /* SQLITE_CONSTRAINT */ "constraint failed",
1504 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001505 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001506#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001507 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001508#else
1509 /* SQLITE_NOLFS */ 0,
1510#endif
drh51c7d862009-04-27 18:46:06 +00001511 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001512 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001513 /* SQLITE_RANGE */ "column index out of range",
1514 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001515 /* SQLITE_NOTICE */ "notification message",
1516 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001517 };
drh21021a52012-02-13 17:01:51 +00001518 const char *zErr = "unknown error";
1519 switch( rc ){
1520 case SQLITE_ABORT_ROLLBACK: {
1521 zErr = "abort due to ROLLBACK";
1522 break;
1523 }
mistachkin2a861102018-02-08 01:00:11 +00001524 case SQLITE_ROW: {
1525 zErr = "another row available";
1526 break;
1527 }
1528 case SQLITE_DONE: {
1529 zErr = "no more rows available";
1530 break;
1531 }
drh21021a52012-02-13 17:01:51 +00001532 default: {
1533 rc &= 0xff;
1534 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1535 zErr = aMsg[rc];
1536 }
1537 break;
1538 }
drh247be432002-05-10 05:44:55 +00001539 }
drh21021a52012-02-13 17:01:51 +00001540 return zErr;
drh247be432002-05-10 05:44:55 +00001541}
1542
1543/*
drh2dfbbca2000-07-28 14:32:48 +00001544** This routine implements a busy callback that sleeps and tries
1545** again until a timeout value is reached. The timeout value is
1546** an integer number of milliseconds passed in as the first
1547** argument.
drhf0119b22018-03-26 17:40:53 +00001548**
1549** Return non-zero to retry the lock. Return zero to stop trying
1550** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001551*/
drhdaffd0e2001-04-11 14:28:42 +00001552static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001553 void *ptr, /* Database connection */
1554 int count, /* Number of times table has been busy */
1555 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001556){
drh0ede9eb2015-01-10 16:49:23 +00001557#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001558 /* This case is for systems that have support for sleeping for fractions of
1559 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001560 static const u8 delays[] =
1561 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1562 static const u8 totals[] =
1563 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001564# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001565 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001566 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001567 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001568
drhf0119b22018-03-26 17:40:53 +00001569#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1570 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1571 if( count ){
1572 tmout = 0;
1573 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1574 return 0;
1575 }else{
1576 return 1;
1577 }
1578 }
drh5013c4b2018-03-28 21:45:03 +00001579#else
1580 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001581#endif
drhee570fa2005-04-28 12:06:05 +00001582 assert( count>=0 );
1583 if( count < NDELAY ){
1584 delay = delays[count];
1585 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001586 }else{
1587 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001588 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001589 }
drhf0119b22018-03-26 17:40:53 +00001590 if( prior + delay > tmout ){
1591 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001592 if( delay<=0 ) return 0;
1593 }
danielk19772a6bdf62007-08-20 16:07:00 +00001594 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001595 return 1;
1596#else
drhf0119b22018-03-26 17:40:53 +00001597 /* This case for unix systems that lack usleep() support. Sleeping
1598 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001599 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001600 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001601 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001602 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001603 return 0;
1604 }
drh482ea182007-08-20 11:12:40 +00001605 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001606 return 1;
1607#endif
1608}
1609
1610/*
drha4afb652005-07-09 02:16:02 +00001611** Invoke the given busy handler.
1612**
drhf0119b22018-03-26 17:40:53 +00001613** This routine is called when an operation failed to acquire a
1614** lock on VFS file pFile.
1615**
drha4afb652005-07-09 02:16:02 +00001616** If this routine returns non-zero, the lock is retried. If it
1617** returns 0, the operation aborts with an SQLITE_BUSY error.
1618*/
drhf0119b22018-03-26 17:40:53 +00001619int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001620 int rc;
drh80262892018-03-26 16:37:53 +00001621 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001622 if( p->bExtraFileArg ){
1623 /* Add an extra parameter with the pFile pointer to the end of the
1624 ** callback argument list */
1625 int (*xTra)(void*,int,sqlite3_file*);
1626 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1627 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1628 }else{
1629 /* Legacy style busy handler callback */
1630 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1631 }
drha4afb652005-07-09 02:16:02 +00001632 if( rc==0 ){
1633 p->nBusy = -1;
1634 }else{
1635 p->nBusy++;
1636 }
1637 return rc;
1638}
1639
1640/*
drh2dfbbca2000-07-28 14:32:48 +00001641** This routine sets the busy callback for an Sqlite database to the
1642** given callback function with the given argument.
1643*/
danielk1977f9d64d22004-06-19 08:18:07 +00001644int sqlite3_busy_handler(
1645 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001646 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001647 void *pArg
1648){
drh9ca95732014-10-24 00:35:58 +00001649#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001650 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001651#endif
drhe30f4422007-08-21 16:15:55 +00001652 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001653 db->busyHandler.xBusyHandler = xBusy;
1654 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001655 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001656 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001657 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001658 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001659 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001660}
1661
danielk1977348bb5d2003-10-18 09:37:26 +00001662#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1663/*
1664** This routine sets the progress callback for an Sqlite database to the
1665** given callback function with the given argument. The progress callback will
1666** be invoked every nOps opcodes.
1667*/
danielk197724b03fd2004-05-10 10:34:34 +00001668void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001669 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001670 int nOps,
1671 int (*xProgress)(void*),
1672 void *pArg
1673){
drh9ca95732014-10-24 00:35:58 +00001674#ifdef SQLITE_ENABLE_API_ARMOR
1675 if( !sqlite3SafetyCheckOk(db) ){
1676 (void)SQLITE_MISUSE_BKPT;
1677 return;
1678 }
1679#endif
drhbd0b1b52008-07-07 19:52:09 +00001680 sqlite3_mutex_enter(db->mutex);
1681 if( nOps>0 ){
1682 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001683 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001684 db->pProgressArg = pArg;
1685 }else{
1686 db->xProgress = 0;
1687 db->nProgressOps = 0;
1688 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001689 }
drhbd0b1b52008-07-07 19:52:09 +00001690 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001691}
1692#endif
1693
1694
drh2dfbbca2000-07-28 14:32:48 +00001695/*
1696** This routine installs a default busy handler that waits for the
1697** specified number of milliseconds before returning 0.
1698*/
danielk1977f9d64d22004-06-19 08:18:07 +00001699int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001700#ifdef SQLITE_ENABLE_API_ARMOR
1701 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1702#endif
drh2dfbbca2000-07-28 14:32:48 +00001703 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001704 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1705 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001706 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001707 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001708 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001709 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001710 }
danielk1977f9d64d22004-06-19 08:18:07 +00001711 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001712}
drh4c504392000-10-16 22:06:40 +00001713
1714/*
1715** Cause any pending operation to stop at its earliest opportunity.
1716*/
drh9bb575f2004-09-06 17:24:11 +00001717void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001718#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001719 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001720 (void)SQLITE_MISUSE_BKPT;
1721 return;
1722 }
1723#endif
drhbd0b1b52008-07-07 19:52:09 +00001724 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001725}
drhfa86c412002-02-02 15:01:15 +00001726
drhfa86c412002-02-02 15:01:15 +00001727
1728/*
danielk1977771151b2006-01-17 13:21:40 +00001729** This function is exactly the same as sqlite3_create_function(), except
1730** that it is designed to be called by internal code. The difference is
1731** that if a malloc() fails in sqlite3_create_function(), an error code
1732** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001733*/
danielk1977771151b2006-01-17 13:21:40 +00001734int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001735 sqlite3 *db,
1736 const char *zFunctionName,
1737 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001738 int enc,
danielk197765904932004-05-26 06:18:37 +00001739 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001740 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001741 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001742 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001743 void (*xValue)(sqlite3_context*),
1744 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001745 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001746){
drh0bce8352002-02-28 00:41:10 +00001747 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001748 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001749 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001750
drhe30f4422007-08-21 16:15:55 +00001751 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001752 assert( xValue==0 || xSFunc==0 );
1753 if( zFunctionName==0 /* Must have a valid name */
1754 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1755 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1756 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1757 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1758 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1759 ){
drh413c3d32010-02-23 20:11:56 +00001760 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001761 }
drh4a8ee3d2013-12-14 13:44:22 +00001762
1763 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001764 assert( SQLITE_FUNC_DIRECT==SQLITE_DIRECTONLY );
drhc4ad8492020-01-03 20:57:38 +00001765 extraFlags = enc & (SQLITE_DETERMINISTIC|SQLITE_DIRECTONLY|
1766 SQLITE_SUBTYPE|SQLITE_INNOCUOUS);
drh4a8ee3d2013-12-14 13:44:22 +00001767 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
drh4be621e2020-01-03 21:57:53 +00001768
1769 /* The SQLITE_INNOCUOUS flag is the same bit as SQLITE_FUNC_UNSAFE. But
1770 ** the meaning is inverted. So flip the bit. */
1771 assert( SQLITE_FUNC_UNSAFE==SQLITE_INNOCUOUS );
1772 extraFlags ^= SQLITE_FUNC_UNSAFE;
1773
danielk1977d8123362004-06-12 09:25:12 +00001774
danielk197793758c82005-01-21 08:13:14 +00001775#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001776 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1777 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1778 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1779 **
1780 ** If SQLITE_ANY is specified, add three versions of the function
1781 ** to the hash table.
1782 */
1783 if( enc==SQLITE_UTF16 ){
1784 enc = SQLITE_UTF16NATIVE;
1785 }else if( enc==SQLITE_ANY ){
1786 int rc;
drh79d5bc82020-01-04 01:43:02 +00001787 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1788 (SQLITE_UTF8|extraFlags)^SQLITE_FUNC_UNSAFE,
dan660af932018-06-18 16:55:22 +00001789 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001790 if( rc==SQLITE_OK ){
drh79d5bc82020-01-04 01:43:02 +00001791 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1792 (SQLITE_UTF16LE|extraFlags)^SQLITE_FUNC_UNSAFE,
1793 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001794 }
1795 if( rc!=SQLITE_OK ){
1796 return rc;
1797 }
danielk1977d8123362004-06-12 09:25:12 +00001798 enc = SQLITE_UTF16BE;
1799 }
danielk197793758c82005-01-21 08:13:14 +00001800#else
1801 enc = SQLITE_UTF8;
1802#endif
danielk19779636c4e2005-01-25 04:27:54 +00001803
1804 /* Check if an existing function is being overridden or deleted. If so,
1805 ** and there are active VMs, then return SQLITE_BUSY. If a function
1806 ** is being overridden/deleted but there are no active VMs, allow the
1807 ** operation to continue but invalidate all precompiled statements.
1808 */
drh80738d92016-02-15 00:34:16 +00001809 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001810 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001811 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001812 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001813 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001814 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001815 return SQLITE_BUSY;
1816 }else{
drhba968db2018-07-24 22:02:12 +00001817 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001818 }
1819 }
danielk197765904932004-05-26 06:18:37 +00001820
drh80738d92016-02-15 00:34:16 +00001821 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001822 assert(p || db->mallocFailed);
1823 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001824 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001825 }
dand2199f02010-08-27 17:48:52 +00001826
1827 /* If an older version of the function with a configured destructor is
1828 ** being replaced invoke the destructor function here. */
1829 functionDestroy(db, p);
1830
1831 if( pDestructor ){
1832 pDestructor->nRef++;
1833 }
drh80738d92016-02-15 00:34:16 +00001834 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001835 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1836 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001837 testcase( p->funcFlags & SQLITE_DIRECTONLY );
drh2d801512016-01-14 22:19:58 +00001838 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001839 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001840 p->xValue = xValue;
1841 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001842 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001843 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001844 return SQLITE_OK;
1845}
danielk1977771151b2006-01-17 13:21:40 +00001846
1847/*
dan660af932018-06-18 16:55:22 +00001848** Worker function used by utf-8 APIs that create new functions:
1849**
1850** sqlite3_create_function()
1851** sqlite3_create_function_v2()
1852** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001853*/
dan660af932018-06-18 16:55:22 +00001854static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001855 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001856 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001857 int nArg,
1858 int enc,
1859 void *p,
dan660af932018-06-18 16:55:22 +00001860 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1861 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001862 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001863 void (*xValue)(sqlite3_context*),
1864 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1865 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001866){
shanehbd2aaf92010-09-01 02:38:21 +00001867 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001868 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001869
1870#ifdef SQLITE_ENABLE_API_ARMOR
1871 if( !sqlite3SafetyCheckOk(db) ){
1872 return SQLITE_MISUSE_BKPT;
1873 }
1874#endif
dand2199f02010-08-27 17:48:52 +00001875 sqlite3_mutex_enter(db->mutex);
1876 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001877 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001878 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001879 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001880 xDestroy(p);
1881 goto out;
1882 }
drh92011842018-05-26 16:00:26 +00001883 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001884 pArg->xDestroy = xDestroy;
1885 pArg->pUserData = p;
1886 }
dan660af932018-06-18 16:55:22 +00001887 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1888 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1889 );
dand2199f02010-08-27 17:48:52 +00001890 if( pArg && pArg->nRef==0 ){
1891 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001892 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001893 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001894 }
1895
1896 out:
drhe30f4422007-08-21 16:15:55 +00001897 rc = sqlite3ApiExit(db, rc);
1898 sqlite3_mutex_leave(db->mutex);
1899 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001900}
1901
dan660af932018-06-18 16:55:22 +00001902/*
1903** Create new user functions.
1904*/
1905int sqlite3_create_function(
1906 sqlite3 *db,
1907 const char *zFunc,
1908 int nArg,
1909 int enc,
1910 void *p,
1911 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1912 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1913 void (*xFinal)(sqlite3_context*)
1914){
1915 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1916 xFinal, 0, 0, 0);
1917}
1918int sqlite3_create_function_v2(
1919 sqlite3 *db,
1920 const char *zFunc,
1921 int nArg,
1922 int enc,
1923 void *p,
1924 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1925 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1926 void (*xFinal)(sqlite3_context*),
1927 void (*xDestroy)(void *)
1928){
1929 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1930 xFinal, 0, 0, xDestroy);
1931}
1932int sqlite3_create_window_function(
1933 sqlite3 *db,
1934 const char *zFunc,
1935 int nArg,
1936 int enc,
1937 void *p,
1938 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1939 void (*xFinal)(sqlite3_context*),
1940 void (*xValue)(sqlite3_context*),
1941 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1942 void (*xDestroy)(void *)
1943){
1944 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1945 xFinal, xValue, xInverse, xDestroy);
1946}
1947
danielk197793758c82005-01-21 08:13:14 +00001948#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001949int sqlite3_create_function16(
1950 sqlite3 *db,
1951 const void *zFunctionName,
1952 int nArg,
1953 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001954 void *p,
drh2d801512016-01-14 22:19:58 +00001955 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001956 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1957 void (*xFinal)(sqlite3_context*)
1958){
1959 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001960 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001961
1962#ifdef SQLITE_ENABLE_API_ARMOR
1963 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1964#endif
drhe30f4422007-08-21 16:15:55 +00001965 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001966 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001967 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00001968 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00001969 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001970 rc = sqlite3ApiExit(db, rc);
1971 sqlite3_mutex_leave(db->mutex);
1972 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001973}
danielk197793758c82005-01-21 08:13:14 +00001974#endif
drhc9b84a12002-06-20 11:36:48 +00001975
drhb7481e72006-09-16 21:45:14 +00001976
1977/*
drh92011842018-05-26 16:00:26 +00001978** The following is the implementation of an SQL function that always
1979** fails with an error message stating that the function is used in the
1980** wrong context. The sqlite3_overload_function() API might construct
1981** SQL function that use this routine so that the functions will exist
1982** for name resolution but are actually overloaded by the xFindFunction
1983** method of virtual tables.
1984*/
1985static void sqlite3InvalidFunction(
1986 sqlite3_context *context, /* The function calling context */
1987 int NotUsed, /* Number of arguments to the function */
1988 sqlite3_value **NotUsed2 /* Value of each argument */
1989){
1990 const char *zName = (const char*)sqlite3_user_data(context);
1991 char *zErr;
1992 UNUSED_PARAMETER2(NotUsed, NotUsed2);
1993 zErr = sqlite3_mprintf(
1994 "unable to use function %s in the requested context", zName);
1995 sqlite3_result_error(context, zErr, -1);
1996 sqlite3_free(zErr);
1997}
1998
1999/*
drhb7481e72006-09-16 21:45:14 +00002000** Declare that a function has been overloaded by a virtual table.
2001**
2002** If the function already exists as a regular global function, then
2003** this routine is a no-op. If the function does not exist, then create
2004** a new one that always throws a run-time error.
2005**
2006** When virtual tables intend to provide an overloaded function, they
2007** should call this routine to make sure the global function exists.
2008** A global function must exist in order for name resolution to work
2009** properly.
2010*/
2011int sqlite3_overload_function(
2012 sqlite3 *db,
2013 const char *zName,
2014 int nArg
2015){
drh92011842018-05-26 16:00:26 +00002016 int rc;
2017 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00002018
2019#ifdef SQLITE_ENABLE_API_ARMOR
2020 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
2021 return SQLITE_MISUSE_BKPT;
2022 }
2023#endif
drhe30f4422007-08-21 16:15:55 +00002024 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00002025 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00002026 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00002027 if( rc ) return SQLITE_OK;
2028 zCopy = sqlite3_mprintf(zName);
2029 if( zCopy==0 ) return SQLITE_NOMEM;
2030 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
2031 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00002032}
2033
drh19e2d372005-08-29 23:00:03 +00002034#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00002035/*
drh18de4822003-01-16 16:28:53 +00002036** Register a trace function. The pArg from the previously registered trace
2037** is returned.
2038**
2039** A NULL trace function means that no tracing is executes. A non-NULL
2040** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00002041** SQL statement.
drh18de4822003-01-16 16:28:53 +00002042*/
drh3d2a5292016-07-13 22:55:01 +00002043#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00002044void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00002045 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002046
2047#ifdef SQLITE_ENABLE_API_ARMOR
2048 if( !sqlite3SafetyCheckOk(db) ){
2049 (void)SQLITE_MISUSE_BKPT;
2050 return 0;
2051 }
2052#endif
drhe30f4422007-08-21 16:15:55 +00002053 sqlite3_mutex_enter(db->mutex);
2054 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00002055 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00002056 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00002057 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002058 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002059 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002060}
drh3d2a5292016-07-13 22:55:01 +00002061#endif /* SQLITE_OMIT_DEPRECATED */
2062
2063/* Register a trace callback using the version-2 interface.
2064*/
2065int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002066 sqlite3 *db, /* Trace this connection */
2067 unsigned mTrace, /* Mask of events to be traced */
2068 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2069 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002070){
2071#ifdef SQLITE_ENABLE_API_ARMOR
2072 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002073 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002074 }
2075#endif
2076 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002077 if( mTrace==0 ) xTrace = 0;
2078 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002079 db->mTrace = mTrace;
2080 db->xTrace = xTrace;
2081 db->pTraceArg = pArg;
2082 sqlite3_mutex_leave(db->mutex);
2083 return SQLITE_OK;
2084}
2085
drh087ec072016-07-25 00:05:56 +00002086#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002087/*
2088** Register a profile function. The pArg from the previously registered
2089** profile function is returned.
2090**
2091** A NULL profile function means that no profiling is executes. A non-NULL
2092** profile is a pointer to a function that is invoked at the conclusion of
2093** each SQL statement that is run.
2094*/
2095void *sqlite3_profile(
2096 sqlite3 *db,
2097 void (*xProfile)(void*,const char*,sqlite_uint64),
2098 void *pArg
2099){
drhe30f4422007-08-21 16:15:55 +00002100 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002101
2102#ifdef SQLITE_ENABLE_API_ARMOR
2103 if( !sqlite3SafetyCheckOk(db) ){
2104 (void)SQLITE_MISUSE_BKPT;
2105 return 0;
2106 }
2107#endif
drhe30f4422007-08-21 16:15:55 +00002108 sqlite3_mutex_enter(db->mutex);
2109 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002110 db->xProfile = xProfile;
2111 db->pProfileArg = pArg;
drh04c67472018-12-04 14:33:02 +00002112 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2113 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
drhe30f4422007-08-21 16:15:55 +00002114 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002115 return pOld;
2116}
drh087ec072016-07-25 00:05:56 +00002117#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002118#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002119
drhcd565fd2012-03-01 21:30:44 +00002120/*
2121** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002122** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002123** rollback.
2124*/
danielk197724b03fd2004-05-10 10:34:34 +00002125void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002126 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002127 int (*xCallback)(void*), /* Function to invoke on each commit */
2128 void *pArg /* Argument to the function */
2129){
drhe30f4422007-08-21 16:15:55 +00002130 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002131
2132#ifdef SQLITE_ENABLE_API_ARMOR
2133 if( !sqlite3SafetyCheckOk(db) ){
2134 (void)SQLITE_MISUSE_BKPT;
2135 return 0;
2136 }
2137#endif
drhe30f4422007-08-21 16:15:55 +00002138 sqlite3_mutex_enter(db->mutex);
2139 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002140 db->xCommitCallback = xCallback;
2141 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002142 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002143 return pOld;
2144}
2145
danielk197794eb6a12005-12-15 15:22:08 +00002146/*
2147** Register a callback to be invoked each time a row is updated,
2148** inserted or deleted using this database connection.
2149*/
danielk197771fd80b2005-12-16 06:54:01 +00002150void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002151 sqlite3 *db, /* Attach the hook to this database */
2152 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2153 void *pArg /* Argument to the function */
2154){
drhe30f4422007-08-21 16:15:55 +00002155 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002156
2157#ifdef SQLITE_ENABLE_API_ARMOR
2158 if( !sqlite3SafetyCheckOk(db) ){
2159 (void)SQLITE_MISUSE_BKPT;
2160 return 0;
2161 }
2162#endif
drhe30f4422007-08-21 16:15:55 +00002163 sqlite3_mutex_enter(db->mutex);
2164 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002165 db->xUpdateCallback = xCallback;
2166 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002167 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002168 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002169}
2170
danielk197771fd80b2005-12-16 06:54:01 +00002171/*
2172** Register a callback to be invoked each time a transaction is rolled
2173** back by this database connection.
2174*/
2175void *sqlite3_rollback_hook(
2176 sqlite3 *db, /* Attach the hook to this database */
2177 void (*xCallback)(void*), /* Callback function */
2178 void *pArg /* Argument to the function */
2179){
drhe30f4422007-08-21 16:15:55 +00002180 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002181
2182#ifdef SQLITE_ENABLE_API_ARMOR
2183 if( !sqlite3SafetyCheckOk(db) ){
2184 (void)SQLITE_MISUSE_BKPT;
2185 return 0;
2186 }
2187#endif
drhe30f4422007-08-21 16:15:55 +00002188 sqlite3_mutex_enter(db->mutex);
2189 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002190 db->xRollbackCallback = xCallback;
2191 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002192 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002193 return pRet;
2194}
drhaa940ea2004-01-15 02:44:03 +00002195
drh9b1c62d2011-03-30 21:04:43 +00002196#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002197/*
2198** Register a callback to be invoked each time a row is updated,
2199** inserted or deleted using this database connection.
2200*/
2201void *sqlite3_preupdate_hook(
2202 sqlite3 *db, /* Attach the hook to this database */
2203 void(*xCallback)( /* Callback function */
2204 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2205 void *pArg /* First callback argument */
2206){
2207 void *pRet;
2208 sqlite3_mutex_enter(db->mutex);
2209 pRet = db->pPreUpdateArg;
2210 db->xPreUpdateCallback = xCallback;
2211 db->pPreUpdateArg = pArg;
2212 sqlite3_mutex_leave(db->mutex);
2213 return pRet;
2214}
drh9b1c62d2011-03-30 21:04:43 +00002215#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002216
dan586b9c82010-05-03 08:04:49 +00002217#ifndef SQLITE_OMIT_WAL
2218/*
2219** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002220** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2221** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002222** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002223*/
drhb033d8b2010-05-03 13:37:30 +00002224int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002225 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002226 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002227 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002228 int nFrame /* Size of WAL */
2229){
drh5def0842010-05-05 20:00:25 +00002230 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002231 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002232 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002233 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002234 }
2235 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002236}
drhb033d8b2010-05-03 13:37:30 +00002237#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002238
2239/*
2240** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2241** a database after committing a transaction if there are nFrame or
2242** more frames in the log file. Passing zero or a negative value as the
2243** nFrame parameter disables automatic checkpoints entirely.
2244**
2245** The callback registered by this function replaces any existing callback
2246** registered using sqlite3_wal_hook(). Likewise, registering a callback
2247** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2248** configured by this function.
2249*/
2250int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002251#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002252 UNUSED_PARAMETER(db);
2253 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002254#else
drh9ca95732014-10-24 00:35:58 +00002255#ifdef SQLITE_ENABLE_API_ARMOR
2256 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2257#endif
dan586b9c82010-05-03 08:04:49 +00002258 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002259 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002260 }else{
2261 sqlite3_wal_hook(db, 0, 0);
2262 }
drhb033d8b2010-05-03 13:37:30 +00002263#endif
dan586b9c82010-05-03 08:04:49 +00002264 return SQLITE_OK;
2265}
2266
paulb0208cc2003-04-13 18:26:49 +00002267/*
dan8d22a172010-04-19 18:03:51 +00002268** Register a callback to be invoked each time a transaction is written
2269** into the write-ahead-log by this database connection.
2270*/
drh833bf962010-04-28 14:42:19 +00002271void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002272 sqlite3 *db, /* Attach the hook to this db handle */
2273 int(*xCallback)(void *, sqlite3*, const char*, int),
2274 void *pArg /* First argument passed to xCallback() */
2275){
drhb033d8b2010-05-03 13:37:30 +00002276#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002277 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002278#ifdef SQLITE_ENABLE_API_ARMOR
2279 if( !sqlite3SafetyCheckOk(db) ){
2280 (void)SQLITE_MISUSE_BKPT;
2281 return 0;
2282 }
2283#endif
dan8d22a172010-04-19 18:03:51 +00002284 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002285 pRet = db->pWalArg;
2286 db->xWalCallback = xCallback;
2287 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002288 sqlite3_mutex_leave(db->mutex);
2289 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002290#else
2291 return 0;
2292#endif
dan8d22a172010-04-19 18:03:51 +00002293}
2294
2295/*
dancdc1f042010-11-18 12:11:05 +00002296** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002297*/
dancdc1f042010-11-18 12:11:05 +00002298int sqlite3_wal_checkpoint_v2(
2299 sqlite3 *db, /* Database handle */
2300 const char *zDb, /* Name of attached database (or NULL) */
2301 int eMode, /* SQLITE_CHECKPOINT_* value */
2302 int *pnLog, /* OUT: Size of WAL log in frames */
2303 int *pnCkpt /* OUT: Total number of frames checkpointed */
2304){
drhb033d8b2010-05-03 13:37:30 +00002305#ifdef SQLITE_OMIT_WAL
2306 return SQLITE_OK;
2307#else
dan586b9c82010-05-03 08:04:49 +00002308 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002309 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002310
drh9ca95732014-10-24 00:35:58 +00002311#ifdef SQLITE_ENABLE_API_ARMOR
2312 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2313#endif
2314
dan9c5e3682011-02-07 15:12:12 +00002315 /* Initialize the output variables to -1 in case an error occurs. */
2316 if( pnLog ) *pnLog = -1;
2317 if( pnCkpt ) *pnCkpt = -1;
2318
danf26a1542014-12-02 19:04:54 +00002319 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2320 assert( SQLITE_CHECKPOINT_FULL==1 );
2321 assert( SQLITE_CHECKPOINT_RESTART==2 );
2322 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2323 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002324 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2325 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002326 return SQLITE_MISUSE;
2327 }
2328
dan586b9c82010-05-03 08:04:49 +00002329 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002330 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002331 iDb = sqlite3FindDbName(db, zDb);
2332 }
2333 if( iDb<0 ){
2334 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002335 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002336 }else{
dan976b0032015-01-29 19:12:12 +00002337 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002338 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002339 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002340 }
drhb033d8b2010-05-03 13:37:30 +00002341 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002342
2343 /* If there are no active statements, clear the interrupt flag at this
2344 ** point. */
2345 if( db->nVdbeActive==0 ){
2346 db->u1.isInterrupted = 0;
2347 }
2348
dan586b9c82010-05-03 08:04:49 +00002349 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002350 return rc;
2351#endif
dan586b9c82010-05-03 08:04:49 +00002352}
2353
dancdc1f042010-11-18 12:11:05 +00002354
2355/*
2356** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2357** to contains a zero-length string, all attached databases are
2358** checkpointed.
2359*/
2360int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002361 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2362 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2363 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002364}
2365
drhb033d8b2010-05-03 13:37:30 +00002366#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002367/*
2368** Run a checkpoint on database iDb. This is a no-op if database iDb is
2369** not currently open in WAL mode.
2370**
dan6fcff072010-05-03 14:05:43 +00002371** If a transaction is open on the database being checkpointed, this
2372** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2373** an error occurs while running the checkpoint, an SQLite error code is
2374** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002375**
2376** The mutex on database handle db should be held by the caller. The mutex
2377** associated with the specific b-tree being checkpointed is taken by
2378** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002379**
2380** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2381** checkpointed. If an error is encountered it is returned immediately -
2382** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002383**
dan78345512017-09-08 17:48:00 +00002384** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2385** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002386*/
dancdc1f042010-11-18 12:11:05 +00002387int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002388 int rc = SQLITE_OK; /* Return code */
2389 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002390 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002391
2392 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002393 assert( !pnLog || *pnLog==-1 );
2394 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002395
dan6fcff072010-05-03 14:05:43 +00002396 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2397 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002398 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002399 pnLog = 0;
2400 pnCkpt = 0;
2401 if( rc==SQLITE_BUSY ){
2402 bBusy = 1;
2403 rc = SQLITE_OK;
2404 }
dan6fcff072010-05-03 14:05:43 +00002405 }
dan586b9c82010-05-03 08:04:49 +00002406 }
2407
danf2b8dd52010-11-18 19:28:01 +00002408 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002409}
drhb033d8b2010-05-03 13:37:30 +00002410#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002411
2412/*
danielk1977d8293352009-04-30 09:10:37 +00002413** This function returns true if main-memory should be used instead of
2414** a temporary file for transient pager files and statement journals.
2415** The value returned depends on the value of db->temp_store (runtime
2416** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2417** following table describes the relationship between these two values
2418** and this functions return value.
2419**
2420** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2421** ----------------- -------------- ------------------------------
2422** 0 any file (return 0)
2423** 1 1 file (return 0)
2424** 1 2 memory (return 1)
2425** 1 0 file (return 0)
2426** 2 1 file (return 0)
2427** 2 2 memory (return 1)
2428** 2 0 memory (return 1)
2429** 3 any memory (return 1)
2430*/
drh1c514142009-04-30 12:25:10 +00002431int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002432#if SQLITE_TEMP_STORE==1
2433 return ( db->temp_store==2 );
2434#endif
2435#if SQLITE_TEMP_STORE==2
2436 return ( db->temp_store!=1 );
2437#endif
2438#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002439 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002440 return 1;
shanecf697392009-06-01 16:53:09 +00002441#endif
2442#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002443 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002444 return 0;
shane60a4b532009-05-06 18:57:09 +00002445#endif
danielk1977d8293352009-04-30 09:10:37 +00002446}
2447
2448/*
danielk19774ad17132004-05-21 01:47:26 +00002449** Return UTF-8 encoded English language explanation of the most recent
2450** error.
2451*/
danielk19776622cce2004-05-20 11:00:52 +00002452const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002453 const char *z;
drhf49661a2008-12-10 16:45:50 +00002454 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002455 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002456 }
drhd55d57e2008-07-07 17:53:07 +00002457 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002458 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002459 }
drh27641702007-08-22 02:56:42 +00002460 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002461 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002462 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002463 }else{
drha3cc0072013-12-13 16:23:55 +00002464 testcase( db->pErr==0 );
drh368bfe82018-12-11 12:20:41 +00002465 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
danielk1977238746a2009-03-19 18:51:06 +00002466 assert( !db->mallocFailed );
2467 if( z==0 ){
2468 z = sqlite3ErrStr(db->errCode);
2469 }
danielk19776622cce2004-05-20 11:00:52 +00002470 }
drhe30f4422007-08-21 16:15:55 +00002471 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002472 return z;
danielk19776622cce2004-05-20 11:00:52 +00002473}
2474
drh6c626082004-11-14 21:56:29 +00002475#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002476/*
2477** Return UTF-16 encoded English language explanation of the most recent
2478** error.
2479*/
danielk19776622cce2004-05-20 11:00:52 +00002480const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002481 static const u16 outOfMem[] = {
2482 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002483 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002484 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002485 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2486 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2487 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002488 };
danielk19774ad17132004-05-21 01:47:26 +00002489
drhc60d0442004-09-30 13:43:13 +00002490 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002491 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002492 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002493 }
drhd55d57e2008-07-07 17:53:07 +00002494 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002495 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002496 }
drhe30f4422007-08-21 16:15:55 +00002497 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002498 if( db->mallocFailed ){
2499 z = (void *)outOfMem;
2500 }else{
drhc60d0442004-09-30 13:43:13 +00002501 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002502 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002503 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002504 z = sqlite3_value_text16(db->pErr);
2505 }
2506 /* A malloc() may have failed within the call to sqlite3_value_text16()
2507 ** above. If this is the case, then the db->mallocFailed flag needs to
2508 ** be cleared before returning. Do this directly, instead of via
2509 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2510 */
drh4a642b62016-02-05 01:55:27 +00002511 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002512 }
drhe30f4422007-08-21 16:15:55 +00002513 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002514 return z;
danielk19776622cce2004-05-20 11:00:52 +00002515}
drh6c626082004-11-14 21:56:29 +00002516#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002517
drhc60d0442004-09-30 13:43:13 +00002518/*
danielk19777ddad962005-12-12 06:53:03 +00002519** Return the most recent error code generated by an SQLite routine. If NULL is
2520** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002521*/
danielk19776622cce2004-05-20 11:00:52 +00002522int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002523 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002524 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002525 }
drh01495b92008-01-23 12:52:40 +00002526 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002527 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002528 }
drh4ac285a2006-09-15 07:28:50 +00002529 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002530}
drh99dfe5e2008-10-30 15:03:15 +00002531int sqlite3_extended_errcode(sqlite3 *db){
2532 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002533 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002534 }
2535 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002536 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002537 }
2538 return db->errCode;
2539}
drh1b9f2142016-03-17 16:01:23 +00002540int sqlite3_system_errno(sqlite3 *db){
2541 return db ? db->iSysErrno : 0;
2542}
danielk19776622cce2004-05-20 11:00:52 +00002543
drh0e819f92006-02-01 13:50:41 +00002544/*
mistachkin5dac8432012-09-11 02:00:25 +00002545** Return a string that describes the kind of error specified in the
2546** argument. For now, this simply calls the internal sqlite3ErrStr()
2547** function.
2548*/
2549const char *sqlite3_errstr(int rc){
2550 return sqlite3ErrStr(rc);
2551}
2552
2553/*
drh0e819f92006-02-01 13:50:41 +00002554** Create a new collating function for database "db". The name is zName
2555** and the encoding is enc.
2556*/
danielk19779a30cf62006-01-18 04:26:07 +00002557static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002558 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002559 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002560 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002561 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002562 int(*xCompare)(void*,int,const void*,int,const void*),
2563 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002564){
2565 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002566 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002567
drhe30f4422007-08-21 16:15:55 +00002568 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002569
2570 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2571 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2572 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2573 */
drh51c7d862009-04-27 18:46:06 +00002574 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002575 testcase( enc2==SQLITE_UTF16 );
2576 testcase( enc2==SQLITE_UTF16_ALIGNED );
2577 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002578 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002579 }
drh51c7d862009-04-27 18:46:06 +00002580 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002581 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002582 }
2583
2584 /* Check if this call is removing or replacing an existing collation
2585 ** sequence. If so, and there are active VMs, return busy. If there
2586 ** are no active VMs, invalidate any pre-compiled statements.
2587 */
drhc4a64fa2009-05-11 20:53:28 +00002588 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002589 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002590 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002591 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002592 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002593 return SQLITE_BUSY;
2594 }
drhba968db2018-07-24 22:02:12 +00002595 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002596
2597 /* If collation sequence pColl was created directly by a call to
2598 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2599 ** then any copies made by synthCollSeq() need to be invalidated.
2600 ** Also, collation destructor - CollSeq.xDel() - function may need
2601 ** to be called.
2602 */
2603 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002604 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002605 int j;
2606 for(j=0; j<3; j++){
2607 CollSeq *p = &aColl[j];
2608 if( p->enc==pColl->enc ){
2609 if( p->xDel ){
2610 p->xDel(p->pUser);
2611 }
2612 p->xCmp = 0;
2613 }
2614 }
2615 }
danielk19779a30cf62006-01-18 04:26:07 +00002616 }
2617
drhc4a64fa2009-05-11 20:53:28 +00002618 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002619 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002620 pColl->xCmp = xCompare;
2621 pColl->pUser = pCtx;
2622 pColl->xDel = xDel;
2623 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002624 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002625 return SQLITE_OK;
2626}
2627
2628
danielk19776622cce2004-05-20 11:00:52 +00002629/*
drhbb4957f2008-03-20 14:03:29 +00002630** This array defines hard upper bounds on limit values. The
2631** initializer must be kept in sync with the SQLITE_LIMIT_*
2632** #defines in sqlite3.h.
2633*/
drhb1a6c3c2008-03-20 16:30:17 +00002634static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002635 SQLITE_MAX_LENGTH,
2636 SQLITE_MAX_SQL_LENGTH,
2637 SQLITE_MAX_COLUMN,
2638 SQLITE_MAX_EXPR_DEPTH,
2639 SQLITE_MAX_COMPOUND_SELECT,
2640 SQLITE_MAX_VDBE_OP,
2641 SQLITE_MAX_FUNCTION_ARG,
2642 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002643 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002644 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002645 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002646 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002647};
2648
2649/*
2650** Make sure the hard limits are set to reasonable values
2651*/
2652#if SQLITE_MAX_LENGTH<100
2653# error SQLITE_MAX_LENGTH must be at least 100
2654#endif
2655#if SQLITE_MAX_SQL_LENGTH<100
2656# error SQLITE_MAX_SQL_LENGTH must be at least 100
2657#endif
2658#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2659# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2660#endif
drhbb4957f2008-03-20 14:03:29 +00002661#if SQLITE_MAX_COMPOUND_SELECT<2
2662# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2663#endif
2664#if SQLITE_MAX_VDBE_OP<40
2665# error SQLITE_MAX_VDBE_OP must be at least 40
2666#endif
drh80738d92016-02-15 00:34:16 +00002667#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2668# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002669#endif
drhd08b2792014-07-22 15:33:31 +00002670#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2671# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002672#endif
drhbb4957f2008-03-20 14:03:29 +00002673#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2674# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2675#endif
drh70a8ca32008-08-21 18:49:27 +00002676#if SQLITE_MAX_COLUMN>32767
2677# error SQLITE_MAX_COLUMN must not exceed 32767
2678#endif
drh417168a2009-09-07 18:14:02 +00002679#if SQLITE_MAX_TRIGGER_DEPTH<1
2680# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2681#endif
drh111544c2014-08-29 16:20:47 +00002682#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2683# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2684#endif
drhbb4957f2008-03-20 14:03:29 +00002685
2686
2687/*
2688** Change the value of a limit. Report the old value.
2689** If an invalid limit index is supplied, report -1.
2690** Make no changes but still report the old value if the
2691** new limit is negative.
2692**
2693** A new lower limit does not shrink existing constructs.
2694** It merely prevents new constructs that exceed the limit
2695** from forming.
2696*/
2697int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2698 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002699
drh9ca95732014-10-24 00:35:58 +00002700#ifdef SQLITE_ENABLE_API_ARMOR
2701 if( !sqlite3SafetyCheckOk(db) ){
2702 (void)SQLITE_MISUSE_BKPT;
2703 return -1;
2704 }
2705#endif
drh4e93f5b2010-09-07 14:59:15 +00002706
2707 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2708 ** there is a hard upper bound set at compile-time by a C preprocessor
2709 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2710 ** "_MAX_".)
2711 */
2712 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2713 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2714 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2715 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2716 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2717 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2718 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2719 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2720 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2721 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2722 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2723 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002724 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2725 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002726
2727
drh521cc842008-04-15 02:36:33 +00002728 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002729 return -1;
2730 }
2731 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002732 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002733 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002734 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002735 }
2736 db->aLimit[limitId] = newLimit;
2737 }
drh4e93f5b2010-09-07 14:59:15 +00002738 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002739}
2740
2741/*
dan286ab7c2011-05-06 18:34:54 +00002742** This function is used to parse both URIs and non-URI filenames passed by the
2743** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2744** URIs specified as part of ATTACH statements.
2745**
2746** The first argument to this function is the name of the VFS to use (or
2747** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2748** query parameter. The second argument contains the URI (or non-URI filename)
2749** itself. When this function is called the *pFlags variable should contain
2750** the default flags to open the database handle with. The value stored in
2751** *pFlags may be updated before returning if the URI filename contains
2752** "cache=xxx" or "mode=xxx" query parameters.
2753**
2754** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2755** the VFS that should be used to open the database file. *pzFile is set to
drhdf97d432020-02-27 11:32:14 +00002756** point to a buffer containing the name of the file to open. The value
2757** stored in *pzFile is a database name acceptable to sqlite3_uri_parameter()
2758** and is in the same format as names created using sqlite3_create_filename().
2759** The caller must invoke sqlite3_free_filename() (not sqlite3_free()!) on
2760** the value returned in *pzFile to avoid a memory leak.
dan286ab7c2011-05-06 18:34:54 +00002761**
2762** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2763** may be set to point to a buffer containing an English language error
2764** message. It is the responsibility of the caller to eventually release
2765** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002766*/
2767int sqlite3ParseUri(
2768 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2769 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002770 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002771 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2772 char **pzFile, /* OUT: Filename component of URI */
2773 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2774){
dan78e9dd22011-05-03 10:22:32 +00002775 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002776 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002777 const char *zVfs = zDefaultVfs;
2778 char *zFile;
drhde941c32011-05-09 19:20:17 +00002779 char c;
dancd74b612011-04-22 19:37:32 +00002780 int nUri = sqlite3Strlen30(zUri);
2781
2782 assert( *pzErrMsg==0 );
2783
drh8790b6e2014-11-07 01:43:56 +00002784 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2785 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002786 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002787 ){
dan5de15372011-04-23 10:12:30 +00002788 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002789 int eState; /* Parser state when parsing URI */
2790 int iIn; /* Input character index */
2791 int iOut = 0; /* Output character index */
drhdf97d432020-02-27 11:32:14 +00002792 u64 nByte = nUri+8; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002793
dan286ab7c2011-05-06 18:34:54 +00002794 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2795 ** method that there may be extra parameters following the file-name. */
2796 flags |= SQLITE_OPEN_URI;
2797
2798 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002799 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002800 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002801
drhdf97d432020-02-27 11:32:14 +00002802 memset(zFile, 0, 4); /* 4-byte of 0x00 is the start of DB name marker */
2803 zFile += 4;
2804
drh869c0402013-08-07 23:15:52 +00002805 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002806#ifdef SQLITE_ALLOW_URI_AUTHORITY
2807 if( strncmp(zUri+5, "///", 3)==0 ){
2808 iIn = 7;
2809 /* The following condition causes URIs with five leading / characters
2810 ** like file://///host/path to be converted into UNCs like //host/path.
2811 ** The correct URI for that UNC has only two or four leading / characters
2812 ** file://host/path or file:////host/path. But 5 leading slashes is a
2813 ** common error, we are told, so we handle it as a special case. */
2814 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2815 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2816 iIn = 16;
2817 }
2818#else
dancd74b612011-04-22 19:37:32 +00002819 /* Discard the scheme and authority segments of the URI. */
2820 if( zUri[5]=='/' && zUri[6]=='/' ){
2821 iIn = 7;
2822 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002823 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2824 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2825 iIn-7, &zUri[7]);
2826 rc = SQLITE_ERROR;
2827 goto parse_uri_out;
2828 }
dancd74b612011-04-22 19:37:32 +00002829 }
drh869c0402013-08-07 23:15:52 +00002830#endif
dancd74b612011-04-22 19:37:32 +00002831
2832 /* Copy the filename and any query parameters into the zFile buffer.
2833 ** Decode %HH escape codes along the way.
2834 **
2835 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2836 ** on the parsing context. As follows:
2837 **
2838 ** 0: Parsing file-name.
2839 ** 1: Parsing name section of a name=value query parameter.
2840 ** 2: Parsing value section of a name=value query parameter.
2841 */
2842 eState = 0;
drhde941c32011-05-09 19:20:17 +00002843 while( (c = zUri[iIn])!=0 && c!='#' ){
2844 iIn++;
dancd74b612011-04-22 19:37:32 +00002845 if( c=='%'
2846 && sqlite3Isxdigit(zUri[iIn])
2847 && sqlite3Isxdigit(zUri[iIn+1])
2848 ){
dan6d49e252011-05-03 15:09:05 +00002849 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2850 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002851
dan6d49e252011-05-03 15:09:05 +00002852 assert( octet>=0 && octet<256 );
2853 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002854#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002855 /* This branch is taken when "%00" appears within the URI. In this
2856 ** case we ignore all text in the remainder of the path, name or
2857 ** value currently being parsed. So ignore the current character
2858 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002859 while( (c = zUri[iIn])!=0 && c!='#'
2860 && (eState!=0 || c!='?')
2861 && (eState!=1 || (c!='=' && c!='&'))
2862 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002863 ){
2864 iIn++;
2865 }
2866 continue;
dan5c35e902016-10-26 12:15:41 +00002867#else
2868 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2869 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2870 rc = SQLITE_ERROR;
2871 goto parse_uri_out;
2872#endif
dancd74b612011-04-22 19:37:32 +00002873 }
dan6d49e252011-05-03 15:09:05 +00002874 c = octet;
dan5de15372011-04-23 10:12:30 +00002875 }else if( eState==1 && (c=='&' || c=='=') ){
2876 if( zFile[iOut-1]==0 ){
2877 /* An empty option name. Ignore this option altogether. */
2878 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2879 continue;
2880 }
2881 if( c=='&' ){
2882 zFile[iOut++] = '\0';
2883 }else{
2884 eState = 2;
2885 }
dancd74b612011-04-22 19:37:32 +00002886 c = 0;
dan5de15372011-04-23 10:12:30 +00002887 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2888 c = 0;
dancd74b612011-04-22 19:37:32 +00002889 eState = 1;
dancd74b612011-04-22 19:37:32 +00002890 }
2891 zFile[iOut++] = c;
2892 }
2893 if( eState==1 ) zFile[iOut++] = '\0';
drhdf97d432020-02-27 11:32:14 +00002894 memset(zFile+iOut, 0, 4); /* end-of-options + empty journal filenames */
dancd74b612011-04-22 19:37:32 +00002895
2896 /* Check if there were any options specified that should be interpreted
2897 ** here. Options that are interpreted here include "vfs" and those that
2898 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002899 ** method. */
dan5de15372011-04-23 10:12:30 +00002900 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2901 while( zOpt[0] ){
2902 int nOpt = sqlite3Strlen30(zOpt);
2903 char *zVal = &zOpt[nOpt+1];
2904 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002905
dan286ab7c2011-05-06 18:34:54 +00002906 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002907 zVfs = zVal;
2908 }else{
2909 struct OpenMode {
2910 const char *z;
2911 int mode;
2912 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002913 char *zModeType = 0;
2914 int mask = 0;
2915 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002916
dan286ab7c2011-05-06 18:34:54 +00002917 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002918 static struct OpenMode aCacheMode[] = {
2919 { "shared", SQLITE_OPEN_SHAREDCACHE },
2920 { "private", SQLITE_OPEN_PRIVATECACHE },
2921 { 0, 0 }
2922 };
2923
2924 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2925 aMode = aCacheMode;
2926 limit = mask;
2927 zModeType = "cache";
2928 }
dan286ab7c2011-05-06 18:34:54 +00002929 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002930 static struct OpenMode aOpenMode[] = {
2931 { "ro", SQLITE_OPEN_READONLY },
2932 { "rw", SQLITE_OPEN_READWRITE },
2933 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002934 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002935 { 0, 0 }
2936 };
2937
drh9c67b2a2012-05-28 13:58:00 +00002938 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2939 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002940 aMode = aOpenMode;
2941 limit = mask & flags;
2942 zModeType = "access";
2943 }
2944
2945 if( aMode ){
2946 int i;
2947 int mode = 0;
2948 for(i=0; aMode[i].z; i++){
2949 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002950 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002951 mode = aMode[i].mode;
2952 break;
dancd74b612011-04-22 19:37:32 +00002953 }
2954 }
dan78e9dd22011-05-03 10:22:32 +00002955 if( mode==0 ){
2956 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2957 rc = SQLITE_ERROR;
2958 goto parse_uri_out;
2959 }
drh9c67b2a2012-05-28 13:58:00 +00002960 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002961 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2962 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002963 rc = SQLITE_PERM;
2964 goto parse_uri_out;
2965 }
2966 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002967 }
dancd74b612011-04-22 19:37:32 +00002968 }
dan5de15372011-04-23 10:12:30 +00002969
2970 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002971 }
2972
2973 }else{
drhdf97d432020-02-27 11:32:14 +00002974 zFile = sqlite3_malloc64(nUri+8);
mistachkinfad30392016-02-13 23:43:46 +00002975 if( !zFile ) return SQLITE_NOMEM_BKPT;
drhdf97d432020-02-27 11:32:14 +00002976 memset(zFile, 0, 4);
2977 zFile += 4;
dan895decf2016-12-30 14:15:56 +00002978 if( nUri ){
2979 memcpy(zFile, zUri, nUri);
2980 }
drhdf97d432020-02-27 11:32:14 +00002981 memset(zFile+nUri, 0, 4);
drh4ab9d252012-05-26 20:08:49 +00002982 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002983 }
2984
2985 *ppVfs = sqlite3_vfs_find(zVfs);
2986 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002987 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002988 rc = SQLITE_ERROR;
2989 }
2990 parse_uri_out:
2991 if( rc!=SQLITE_OK ){
drhdf97d432020-02-27 11:32:14 +00002992 sqlite3_free_filename(zFile);
dan78e9dd22011-05-03 10:22:32 +00002993 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002994 }
2995 *pFlags = flags;
2996 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002997 return rc;
dancd74b612011-04-22 19:37:32 +00002998}
2999
drh1eac9662020-02-01 13:30:39 +00003000/*
3001** This routine does the core work of extracting URI parameters from a
3002** database filename for the sqlite3_uri_parameter() interface.
3003*/
3004static const char *uriParameter(const char *zFilename, const char *zParam){
3005 zFilename += sqlite3Strlen30(zFilename) + 1;
3006 while( zFilename[0] ){
3007 int x = strcmp(zFilename, zParam);
3008 zFilename += sqlite3Strlen30(zFilename) + 1;
3009 if( x==0 ) return zFilename;
3010 zFilename += sqlite3Strlen30(zFilename) + 1;
3011 }
3012 return 0;
3013}
3014
drhe5989722019-02-02 15:59:49 +00003015
dancd74b612011-04-22 19:37:32 +00003016
3017/*
danielk19774ad17132004-05-21 01:47:26 +00003018** This routine does the work of opening a database on behalf of
3019** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00003020** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00003021*/
3022static int openDatabase(
3023 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00003024 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00003025 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00003026 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00003027){
dancd74b612011-04-22 19:37:32 +00003028 sqlite3 *db; /* Store allocated handle here */
3029 int rc; /* Return code */
3030 int isThreadsafe; /* True for threadsafe connections */
3031 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
3032 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00003033
drh9ca95732014-10-24 00:35:58 +00003034#ifdef SQLITE_ENABLE_API_ARMOR
3035 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3036#endif
drhe0d0f8e2009-04-28 04:47:31 +00003037 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003038#ifndef SQLITE_OMIT_AUTOINIT
3039 rc = sqlite3_initialize();
3040 if( rc ) return rc;
3041#endif
3042
drh039963a2008-09-03 00:43:15 +00003043 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00003044 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00003045 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3046 isThreadsafe = 0;
3047 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3048 isThreadsafe = 1;
3049 }else{
3050 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00003051 }
dan8385bec2017-11-25 17:51:01 +00003052
drhf1f12682009-09-09 14:17:52 +00003053 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00003054 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00003055 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3056 flags |= SQLITE_OPEN_SHAREDCACHE;
3057 }
danielk19779a6284c2008-07-10 17:52:49 +00003058
drhb25a9f42009-05-12 13:35:11 +00003059 /* Remove harmful bits from the flags parameter
3060 **
3061 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3062 ** dealt with in the previous code block. Besides these, the only
3063 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00003064 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3065 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00003066 ** off all other flags.
3067 */
drha4267dc2008-02-19 15:20:44 +00003068 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00003069 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00003070 SQLITE_OPEN_MAIN_DB |
3071 SQLITE_OPEN_TEMP_DB |
3072 SQLITE_OPEN_TRANSIENT_DB |
3073 SQLITE_OPEN_MAIN_JOURNAL |
3074 SQLITE_OPEN_TEMP_JOURNAL |
3075 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00003076 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003077 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003078 SQLITE_OPEN_FULLMUTEX |
3079 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003080 );
3081
danielk19774ad17132004-05-21 01:47:26 +00003082 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003083 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003084 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003085 if( isThreadsafe
3086#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3087 || sqlite3GlobalConfig.bCoreMutex
3088#endif
3089 ){
danielk197759f8c082008-06-18 17:09:10 +00003090 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3091 if( db->mutex==0 ){
3092 sqlite3_free(db);
3093 db = 0;
3094 goto opendb_out;
3095 }
dan8385bec2017-11-25 17:51:01 +00003096 if( isThreadsafe==0 ){
3097 sqlite3MutexWarnOnContention(db->mutex);
3098 }
drh605264d2007-08-21 15:13:19 +00003099 }
drh27641702007-08-22 02:56:42 +00003100 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003101 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003102 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003103 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003104 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003105 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +00003106 db->lookaside.sz = 0;
drh633e6d52008-07-28 19:34:53 +00003107
drhbb4957f2008-03-20 14:03:29 +00003108 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3109 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003110 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003111 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003112 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003113 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003114 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003115 db->nMaxSorterMmap = 0x7FFFFFFF;
drh4b50da92019-07-02 12:23:09 +00003116 db->flags |= SQLITE_ShortColNames
3117 | SQLITE_EnableTrigger
drh11d88e62019-08-15 21:27:20 +00003118 | SQLITE_EnableView
drh4b50da92019-07-02 12:23:09 +00003119 | SQLITE_CacheSpill
drhb77da372020-01-07 16:09:11 +00003120#if !defined(SQLITE_TRUSTED_SCHEMA) || SQLITE_TRUSTED_SCHEMA+0!=0
3121 | SQLITE_TrustedSchema
3122#endif
drh4b50da92019-07-02 12:23:09 +00003123/* The SQLITE_DQS compile-time option determines the default settings
3124** for SQLITE_DBCONFIG_DQS_DDL and SQLITE_DBCONFIG_DQS_DML.
3125**
3126** SQLITE_DQS SQLITE_DBCONFIG_DQS_DDL SQLITE_DBCONFIG_DQS_DML
3127** ---------- ----------------------- -----------------------
3128** undefined on on
3129** 3 on on
3130** 2 on off
3131** 1 off on
3132** 0 off off
3133**
3134** Legacy behavior is 3 (double-quoted string literals are allowed anywhere)
3135** and so that is the default. But developers are encouranged to use
3136** -DSQLITE_DQS=0 (best) or -DSQLITE_DQS=1 (second choice) if possible.
3137*/
3138#if !defined(SQLITE_DQS)
3139# define SQLITE_DQS 3
3140#endif
3141#if (SQLITE_DQS&1)==1
drhd0ff6012019-06-17 13:56:11 +00003142 | SQLITE_DqsDML
drh4b50da92019-07-02 12:23:09 +00003143#endif
3144#if (SQLITE_DQS&2)==2
3145 | SQLITE_DqsDDL
3146#endif
3147
dan1d1f07d2013-07-25 16:41:39 +00003148#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003149 | SQLITE_AutoIndex
3150#endif
drh883ad042015-02-19 00:29:11 +00003151#if SQLITE_DEFAULT_CKPTFULLFSYNC
3152 | SQLITE_CkptFullFSync
3153#endif
drh76fe8032006-07-11 14:17:51 +00003154#if SQLITE_DEFAULT_FILE_FORMAT<4
3155 | SQLITE_LegacyFileFmt
3156#endif
drh56424db2007-03-27 22:24:11 +00003157#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3158 | SQLITE_LoadExtension
3159#endif
dan5bde73c2009-09-01 17:11:07 +00003160#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003161 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003162#endif
drha4bfd7f2010-12-09 19:15:17 +00003163#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3164 | SQLITE_ForeignKeys
3165#endif
drhf5471922014-12-09 15:12:11 +00003166#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3167 | SQLITE_ReverseOrder
3168#endif
drh1421d982015-05-27 03:46:18 +00003169#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3170 | SQLITE_CellSizeCk
3171#endif
drhd42908f2016-02-26 15:38:24 +00003172#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3173 | SQLITE_Fts3Tokenizer
3174#endif
drh169dd922017-06-26 13:57:49 +00003175#if defined(SQLITE_ENABLE_QPSG)
3176 | SQLITE_EnableQPSG
3177#endif
drh6ab91a72018-11-07 02:17:01 +00003178#if defined(SQLITE_DEFAULT_DEFENSIVE)
3179 | SQLITE_Defensive
3180#endif
drh76fe8032006-07-11 14:17:51 +00003181 ;
drhe61922a2009-05-02 13:29:37 +00003182 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003183#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003184 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003185#endif
danielk1977da184232006-01-05 11:34:32 +00003186
danielk19770202b292004-06-09 09:55:16 +00003187 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3188 ** and UTF-16, so add a version for each to avoid any unnecessary
3189 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003190 **
3191 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3192 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003193 */
drhf19aa5f2015-12-30 16:51:20 +00003194 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3195 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3196 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003197 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh821afa42019-06-14 13:24:46 +00003198 createCollation(db, "RTRIM", SQLITE_UTF8, 0, rtrimCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003199 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003200 goto opendb_out;
3201 }
3202
drhff4fa772017-07-10 12:07:53 +00003203 /* Parse the filename/URI argument
3204 **
3205 ** Only allow sensible combinations of bits in the flags argument.
3206 ** Throw an error if any non-sense combination is used. If we
3207 ** do not block illegal combinations here, it could trigger
3208 ** assert() statements in deeper layers. Sensible combinations
3209 ** are:
3210 **
3211 ** 1: SQLITE_OPEN_READONLY
3212 ** 2: SQLITE_OPEN_READWRITE
3213 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3214 */
dan19432992011-05-10 18:39:10 +00003215 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003216 assert( SQLITE_OPEN_READONLY == 0x01 );
3217 assert( SQLITE_OPEN_READWRITE == 0x02 );
3218 assert( SQLITE_OPEN_CREATE == 0x04 );
3219 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3220 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3221 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3222 if( ((1<<(flags&7)) & 0x46)==0 ){
3223 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3224 }else{
3225 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3226 }
dancd74b612011-04-22 19:37:32 +00003227 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003228 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003229 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003230 sqlite3_free(zErrMsg);
3231 goto opendb_out;
3232 }
3233
danielk19774ad17132004-05-21 01:47:26 +00003234 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003235 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003236 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003237 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003238 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003239 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003240 }
drh13f40da2014-08-22 18:00:11 +00003241 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003242 goto opendb_out;
3243 }
dan0235a032014-12-08 20:20:16 +00003244 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003245 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh42a630b2020-03-05 16:13:24 +00003246 if( !db->mallocFailed ){
3247 sqlite3SetTextEncoding(db, SCHEMA_ENC(db));
3248 }
dan0235a032014-12-08 20:20:16 +00003249 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003250 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003251
drhe872d512016-02-22 13:23:16 +00003252 /* The default safety_level for the main database is FULL; for the temp
3253 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003254 */
drh69c33822016-08-18 14:33:11 +00003255 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003256 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003257 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003258 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003259
danielk1977832a58a2007-06-22 15:21:15 +00003260 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003261 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003262 goto opendb_out;
3263 }
3264
danielk19778e227872004-06-07 07:52:17 +00003265 /* Register all built-in functions, but do not attempt to read the
3266 ** database schema yet. This is delayed until the first time the database
3267 ** is accessed.
3268 */
drh13f40da2014-08-22 18:00:11 +00003269 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003270 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003271 rc = sqlite3_errcode(db);
3272
3273#ifdef SQLITE_ENABLE_FTS5
3274 /* Register any built-in FTS5 module before loading the automatic
3275 ** extensions. This allows automatic extensions to register FTS5
3276 ** tokenizers and auxiliary functions. */
3277 if( !db->mallocFailed && rc==SQLITE_OK ){
3278 rc = sqlite3Fts5Init(db);
3279 }
3280#endif
danielk19774ad17132004-05-21 01:47:26 +00003281
drh1409be62006-08-23 20:07:20 +00003282 /* Load automatic extensions - extensions that have been registered
3283 ** using the sqlite3_automatic_extension() API.
3284 */
drhe5077c12011-12-13 04:08:36 +00003285 if( rc==SQLITE_OK ){
3286 sqlite3AutoLoadExtensions(db);
3287 rc = sqlite3_errcode(db);
3288 if( rc!=SQLITE_OK ){
3289 goto opendb_out;
3290 }
danielk1977832a58a2007-06-22 15:21:15 +00003291 }
drh1409be62006-08-23 20:07:20 +00003292
drhaa29c132006-09-02 13:58:06 +00003293#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00003294 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003295 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003296 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003297 }
3298#endif
3299
shessa26cf572006-10-19 20:27:58 +00003300#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003301 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003302 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003303 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003304 }
3305#endif
3306
drh50065652015-10-08 19:29:18 +00003307#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003308 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003309 rc = sqlite3Fts3Init(db);
3310 }
3311#endif
3312
dan21540ae2017-12-08 16:23:38 +00003313#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
drh17435752007-08-16 04:30:38 +00003314 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003315 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003316 }
3317#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003318
3319#ifdef SQLITE_ENABLE_RTREE
3320 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003321 rc = sqlite3RtreeInit(db);
3322 }
3323#endif
3324
drha43c8c82017-10-11 13:48:11 +00003325#ifdef SQLITE_ENABLE_DBPAGE_VTAB
3326 if( !db->mallocFailed && rc==SQLITE_OK){
3327 rc = sqlite3DbpageRegister(db);
3328 }
3329#endif
3330
drha3ab9d02015-05-04 20:25:05 +00003331#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3332 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003333 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003334 }
3335#endif
3336
drh2f20e132015-09-26 17:44:59 +00003337#ifdef SQLITE_ENABLE_JSON1
3338 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003339 rc = sqlite3Json1Init(db);
3340 }
3341#endif
3342
drhc6603af2017-06-29 14:33:51 +00003343#ifdef SQLITE_ENABLE_STMTVTAB
drhf00f5302017-06-28 15:47:29 +00003344 if( !db->mallocFailed && rc==SQLITE_OK){
drhc6603af2017-06-29 14:33:51 +00003345 rc = sqlite3StmtVtabInit(db);
drhf00f5302017-06-28 15:47:29 +00003346 }
3347#endif
3348
drh2a83c102020-01-01 23:02:35 +00003349#ifdef SQLITE_ENABLE_INTERNAL_FUNCTIONS
3350 /* Testing use only!!! The -DSQLITE_ENABLE_INTERNAL_FUNCTIONS=1 compile-time
3351 ** option gives access to internal functions by default.
3352 ** Testing use only!!! */
3353 db->mDbFlags |= DBFLAG_InternalFunc;
3354#endif
3355
drh8fd5bd32007-04-02 16:40:37 +00003356 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3357 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3358 ** mode. Doing nothing at all also makes NORMAL the default.
3359 */
3360#ifdef SQLITE_DEFAULT_LOCKING_MODE
3361 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3362 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3363 SQLITE_DEFAULT_LOCKING_MODE);
3364#endif
3365
drh13f40da2014-08-22 18:00:11 +00003366 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003367
drh633e6d52008-07-28 19:34:53 +00003368 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003369 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3370 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003371
dan5a299f92010-05-03 11:05:08 +00003372 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003373
danielk19774ad17132004-05-21 01:47:26 +00003374opendb_out:
drhafc91042008-02-21 02:09:45 +00003375 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003376 assert( db->mutex!=0 || isThreadsafe==0
3377 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003378 sqlite3_mutex_leave(db->mutex);
3379 }
danielk197759633ae2008-08-27 19:01:57 +00003380 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003381 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003382 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003383 sqlite3_close(db);
3384 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003385 }else if( rc!=SQLITE_OK ){
3386 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003387 }
danielk19774ad17132004-05-21 01:47:26 +00003388 *ppDb = db;
danac455932012-11-26 19:50:41 +00003389#ifdef SQLITE_ENABLE_SQLLOG
3390 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003391 /* Opening a db handle. Fourth parameter is passed 0. */
3392 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3393 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003394 }
3395#endif
drhdf97d432020-02-27 11:32:14 +00003396 sqlite3_free_filename(zOpen);
drh597d2b62015-06-30 03:13:47 +00003397 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003398}
3399
drhe5989722019-02-02 15:59:49 +00003400
danielk19774ad17132004-05-21 01:47:26 +00003401/*
3402** Open a new database handle.
3403*/
danielk197780290862004-05-22 09:21:21 +00003404int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003405 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003406 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003407){
drh605264d2007-08-21 15:13:19 +00003408 return openDatabase(zFilename, ppDb,
3409 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3410}
3411int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003412 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003413 sqlite3 **ppDb, /* OUT: SQLite db handle */
3414 int flags, /* Flags */
3415 const char *zVfs /* Name of VFS module to use */
3416){
drh522c26f2011-05-07 14:40:29 +00003417 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003418}
3419
drh6c626082004-11-14 21:56:29 +00003420#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003421/*
3422** Open a new database handle.
3423*/
3424int sqlite3_open16(
3425 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003426 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003427){
danielk1977bfd6cce2004-06-18 04:24:54 +00003428 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003429 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003430 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003431
drh9ca95732014-10-24 00:35:58 +00003432#ifdef SQLITE_ENABLE_API_ARMOR
3433 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3434#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003435 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003436#ifndef SQLITE_OMIT_AUTOINIT
3437 rc = sqlite3_initialize();
3438 if( rc ) return rc;
3439#endif
drh9ca95732014-10-24 00:35:58 +00003440 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003441 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003442 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3443 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003444 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003445 rc = openDatabase(zFilename8, ppDb,
3446 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003447 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003448 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003449 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003450 }
drh40257ff2008-06-13 18:24:27 +00003451 }else{
mistachkinfad30392016-02-13 23:43:46 +00003452 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003453 }
danielk19777ddad962005-12-12 06:53:03 +00003454 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003455
drh597d2b62015-06-30 03:13:47 +00003456 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003457}
drh6c626082004-11-14 21:56:29 +00003458#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003459
danielk1977106bb232004-05-21 10:08:53 +00003460/*
danielk1977d8123362004-06-12 09:25:12 +00003461** Register a new collation sequence with the database handle db.
3462*/
danielk19770202b292004-06-09 09:55:16 +00003463int sqlite3_create_collation(
3464 sqlite3* db,
3465 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003466 int enc,
danielk19770202b292004-06-09 09:55:16 +00003467 void* pCtx,
3468 int(*xCompare)(void*,int,const void*,int,const void*)
3469){
drh4f81bbb2014-10-23 01:01:26 +00003470 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003471}
3472
3473/*
3474** Register a new collation sequence with the database handle db.
3475*/
danielk1977a393c032007-05-07 14:58:53 +00003476int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003477 sqlite3* db,
3478 const char *zName,
3479 int enc,
3480 void* pCtx,
3481 int(*xCompare)(void*,int,const void*,int,const void*),
3482 void(*xDel)(void*)
3483){
3484 int rc;
drh9ca95732014-10-24 00:35:58 +00003485
3486#ifdef SQLITE_ENABLE_API_ARMOR
3487 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3488#endif
drhe30f4422007-08-21 16:15:55 +00003489 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003490 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003491 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003492 rc = sqlite3ApiExit(db, rc);
3493 sqlite3_mutex_leave(db->mutex);
3494 return rc;
danielk19770202b292004-06-09 09:55:16 +00003495}
3496
drh6c626082004-11-14 21:56:29 +00003497#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003498/*
3499** Register a new collation sequence with the database handle db.
3500*/
danielk19770202b292004-06-09 09:55:16 +00003501int sqlite3_create_collation16(
3502 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003503 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003504 int enc,
danielk19770202b292004-06-09 09:55:16 +00003505 void* pCtx,
3506 int(*xCompare)(void*,int,const void*,int,const void*)
3507){
danielk19779a30cf62006-01-18 04:26:07 +00003508 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003509 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003510
3511#ifdef SQLITE_ENABLE_API_ARMOR
3512 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3513#endif
drhe30f4422007-08-21 16:15:55 +00003514 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003515 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003516 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003517 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003518 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003519 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003520 }
drhe30f4422007-08-21 16:15:55 +00003521 rc = sqlite3ApiExit(db, rc);
3522 sqlite3_mutex_leave(db->mutex);
3523 return rc;
danielk19770202b292004-06-09 09:55:16 +00003524}
drh6c626082004-11-14 21:56:29 +00003525#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003526
danielk1977d8123362004-06-12 09:25:12 +00003527/*
3528** Register a collation sequence factory callback with the database handle
3529** db. Replace any previously installed collation sequence factory.
3530*/
danielk19777cedc8d2004-06-10 10:50:08 +00003531int sqlite3_collation_needed(
3532 sqlite3 *db,
3533 void *pCollNeededArg,
3534 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3535){
drh9ca95732014-10-24 00:35:58 +00003536#ifdef SQLITE_ENABLE_API_ARMOR
3537 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3538#endif
drhe30f4422007-08-21 16:15:55 +00003539 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003540 db->xCollNeeded = xCollNeeded;
3541 db->xCollNeeded16 = 0;
3542 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003543 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003544 return SQLITE_OK;
3545}
danielk1977d8123362004-06-12 09:25:12 +00003546
drh6c626082004-11-14 21:56:29 +00003547#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003548/*
3549** Register a collation sequence factory callback with the database handle
3550** db. Replace any previously installed collation sequence factory.
3551*/
danielk19777cedc8d2004-06-10 10:50:08 +00003552int sqlite3_collation_needed16(
3553 sqlite3 *db,
3554 void *pCollNeededArg,
3555 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3556){
drh9ca95732014-10-24 00:35:58 +00003557#ifdef SQLITE_ENABLE_API_ARMOR
3558 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3559#endif
drhe30f4422007-08-21 16:15:55 +00003560 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003561 db->xCollNeeded = 0;
3562 db->xCollNeeded16 = xCollNeeded16;
3563 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003564 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003565 return SQLITE_OK;
3566}
drh6c626082004-11-14 21:56:29 +00003567#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003568
shaneeec556d2008-10-12 00:27:53 +00003569#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003570/*
danielk19777ddad962005-12-12 06:53:03 +00003571** This function is now an anachronism. It used to be used to recover from a
3572** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003573*/
drh7d97efb2007-10-12 19:35:48 +00003574int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003575 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003576}
3577#endif
drh3e1d8e62005-05-26 16:23:34 +00003578
3579/*
3580** Test to see whether or not the database connection is in autocommit
3581** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3582** by default. Autocommit is disabled by a BEGIN statement and reenabled
3583** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003584*/
3585int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003586#ifdef SQLITE_ENABLE_API_ARMOR
3587 if( !sqlite3SafetyCheckOk(db) ){
3588 (void)SQLITE_MISUSE_BKPT;
3589 return 0;
3590 }
3591#endif
drh3e1d8e62005-05-26 16:23:34 +00003592 return db->autoCommit;
3593}
drh49285702005-09-17 15:20:26 +00003594
drh49285702005-09-17 15:20:26 +00003595/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003596** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003597** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003598** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003599**
3600** 1. Serve as a convenient place to set a breakpoint in a debugger
3601** to detect when version error conditions occurs.
3602**
3603** 2. Invoke sqlite3_log() to provide the source code location where
3604** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003605*/
daneebf2f52017-11-18 17:30:08 +00003606int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003607 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3608 zType, lineno, 20+sqlite3_sourceid());
3609 return iErr;
3610}
drh9978c972010-02-23 17:36:32 +00003611int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003612 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003613 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003614}
drh9978c972010-02-23 17:36:32 +00003615int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003616 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003617 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003618}
3619int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003620 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003621 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003622}
dan3cdc8202020-02-04 20:01:44 +00003623#if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO)
drhcc97ca42017-06-07 22:32:59 +00003624int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3625 char zMsg[100];
3626 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3627 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003628 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003629}
dan3cdc8202020-02-04 20:01:44 +00003630#endif
3631#ifdef SQLITE_DEBUG
mistachkinfad30392016-02-13 23:43:46 +00003632int sqlite3NomemError(int lineno){
3633 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003634 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003635}
3636int sqlite3IoerrnomemError(int lineno){
3637 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003638 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003639}
drh32c49902016-02-15 18:15:15 +00003640#endif
drh7c1817e2006-01-10 13:58:48 +00003641
shaneeec556d2008-10-12 00:27:53 +00003642#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003643/*
3644** This is a convenience routine that makes sure that all thread-specific
3645** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003646**
3647** SQLite no longer uses thread-specific data so this routine is now a
3648** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003649*/
3650void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003651}
shaneeec556d2008-10-12 00:27:53 +00003652#endif
danielk1977deb802c2006-02-09 13:43:28 +00003653
3654/*
3655** Return meta information about a specific column of a database table.
3656** See comment in sqlite3.h (sqlite.h.in) for details.
3657*/
danielk1977deb802c2006-02-09 13:43:28 +00003658int sqlite3_table_column_metadata(
3659 sqlite3 *db, /* Connection handle */
3660 const char *zDbName, /* Database name or NULL */
3661 const char *zTableName, /* Table name */
3662 const char *zColumnName, /* Column name */
3663 char const **pzDataType, /* OUTPUT: Declared data type */
3664 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3665 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3666 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003667 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003668){
3669 int rc;
3670 char *zErrMsg = 0;
3671 Table *pTab = 0;
3672 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003673 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003674 char const *zDataType = 0;
3675 char const *zCollSeq = 0;
3676 int notnull = 0;
3677 int primarykey = 0;
3678 int autoinc = 0;
3679
drh96c707a2015-02-13 16:36:14 +00003680
3681#ifdef SQLITE_ENABLE_API_ARMOR
3682 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3683 return SQLITE_MISUSE_BKPT;
3684 }
3685#endif
3686
danielk1977deb802c2006-02-09 13:43:28 +00003687 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003688 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003689 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003690 rc = sqlite3Init(db, &zErrMsg);
3691 if( SQLITE_OK!=rc ){
3692 goto error_out;
3693 }
3694
3695 /* Locate the table in question */
3696 pTab = sqlite3FindTable(db, zTableName, zDbName);
3697 if( !pTab || pTab->pSelect ){
3698 pTab = 0;
3699 goto error_out;
3700 }
3701
3702 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003703 if( zColumnName==0 ){
3704 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003705 }else{
3706 for(iCol=0; iCol<pTab->nCol; iCol++){
3707 pCol = &pTab->aCol[iCol];
3708 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3709 break;
3710 }
3711 }
3712 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003713 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3714 iCol = pTab->iPKey;
3715 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3716 }else{
3717 pTab = 0;
3718 goto error_out;
3719 }
danielk1977deb802c2006-02-09 13:43:28 +00003720 }
3721 }
3722
3723 /* The following block stores the meta information that will be returned
3724 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3725 ** and autoinc. At this point there are two possibilities:
3726 **
3727 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3728 ** and there is no explicitly declared IPK column.
3729 **
3730 ** 2. The table is not a view and the column name identified an
3731 ** explicitly declared column. Copy meta information from *pCol.
3732 */
3733 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003734 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003735 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003736 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003737 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003738 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003739 }else{
3740 zDataType = "INTEGER";
3741 primarykey = 1;
3742 }
3743 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003744 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003745 }
3746
3747error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003748 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003749
3750 /* Whether the function call succeeded or failed, set the output parameters
3751 ** to whatever their local counterparts contain. If an error did occur,
3752 ** this has the effect of zeroing all output parameters.
3753 */
3754 if( pzDataType ) *pzDataType = zDataType;
3755 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3756 if( pNotNull ) *pNotNull = notnull;
3757 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3758 if( pAutoinc ) *pAutoinc = autoinc;
3759
3760 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003761 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003762 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003763 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003764 rc = SQLITE_ERROR;
3765 }
drh13f40da2014-08-22 18:00:11 +00003766 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003767 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003768 rc = sqlite3ApiExit(db, rc);
3769 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003770 return rc;
3771}
3772
3773/*
3774** Sleep for a little while. Return the amount of time slept.
3775*/
3776int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003777 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003778 int rc;
drhd677b3d2007-08-20 22:48:41 +00003779 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003780 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003781
3782 /* This function works in milliseconds, but the underlying OsSleep()
3783 ** API uses microseconds. Hence the 1000's.
3784 */
drhe30f4422007-08-21 16:15:55 +00003785 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003786 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003787}
drh4ac285a2006-09-15 07:28:50 +00003788
3789/*
3790** Enable or disable the extended result codes.
3791*/
3792int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003793#ifdef SQLITE_ENABLE_API_ARMOR
3794 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3795#endif
drhe30f4422007-08-21 16:15:55 +00003796 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003797 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003798 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003799 return SQLITE_OK;
3800}
drhcc6bb3e2007-08-31 16:11:35 +00003801
3802/*
3803** Invoke the xFileControl method on a particular database.
3804*/
3805int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3806 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003807 Btree *pBtree;
3808
drh9ca95732014-10-24 00:35:58 +00003809#ifdef SQLITE_ENABLE_API_ARMOR
3810 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3811#endif
drhcc6bb3e2007-08-31 16:11:35 +00003812 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003813 pBtree = sqlite3DbNameToBtree(db, zDbName);
3814 if( pBtree ){
3815 Pager *pPager;
3816 sqlite3_file *fd;
3817 sqlite3BtreeEnter(pBtree);
3818 pPager = sqlite3BtreePager(pBtree);
3819 assert( pPager!=0 );
3820 fd = sqlite3PagerFile(pPager);
3821 assert( fd!=0 );
3822 if( op==SQLITE_FCNTL_FILE_POINTER ){
3823 *(sqlite3_file**)pArg = fd;
3824 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003825 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3826 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3827 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003828 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3829 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3830 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003831 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3832 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3833 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003834 }else{
drhafb39a42018-03-29 13:47:01 +00003835 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003836 }
drh421377e2012-03-15 21:28:54 +00003837 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003838 }
3839 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003840 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003841}
drhed13d982008-01-31 14:43:24 +00003842
3843/*
3844** Interface to the testing logic.
3845*/
3846int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003847 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003848#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003849 UNUSED_PARAMETER(op);
3850#else
drh2fa18682008-03-19 14:15:34 +00003851 va_list ap;
drhed13d982008-01-31 14:43:24 +00003852 va_start(ap, op);
3853 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003854
3855 /*
drh984bfaa2008-03-19 16:08:53 +00003856 ** Save the current state of the PRNG.
3857 */
drh2fa18682008-03-19 14:15:34 +00003858 case SQLITE_TESTCTRL_PRNG_SAVE: {
3859 sqlite3PrngSaveState();
3860 break;
3861 }
drh984bfaa2008-03-19 16:08:53 +00003862
3863 /*
3864 ** Restore the state of the PRNG to the last state saved using
3865 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3866 ** this verb acts like PRNG_RESET.
3867 */
drh2fa18682008-03-19 14:15:34 +00003868 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3869 sqlite3PrngRestoreState();
3870 break;
3871 }
drh984bfaa2008-03-19 16:08:53 +00003872
drh2e6d83b2019-08-03 01:39:20 +00003873 /* sqlite3_test_control(SQLITE_TESTCTRL_PRNG_SEED, int x, sqlite3 *db);
drhade54d62019-08-02 20:45:04 +00003874 **
drh2e6d83b2019-08-03 01:39:20 +00003875 ** Control the seed for the pseudo-random number generator (PRNG) that
3876 ** is built into SQLite. Cases:
3877 **
3878 ** x!=0 && db!=0 Seed the PRNG to the current value of the
3879 ** schema cookie in the main database for db, or
3880 ** x if the schema cookie is zero. This case
3881 ** is convenient to use with database fuzzers
3882 ** as it allows the fuzzer some control over the
3883 ** the PRNG seed.
3884 **
3885 ** x!=0 && db==0 Seed the PRNG to the value of x.
3886 **
3887 ** x==0 && db==0 Revert to default behavior of using the
3888 ** xRandomness method on the primary VFS.
3889 **
3890 ** This test-control also resets the PRNG so that the new seed will
3891 ** be used for the next call to sqlite3_randomness().
drh984bfaa2008-03-19 16:08:53 +00003892 */
drhef9f7192020-01-17 19:14:08 +00003893#ifndef SQLITE_OMIT_WSD
drhade54d62019-08-02 20:45:04 +00003894 case SQLITE_TESTCTRL_PRNG_SEED: {
drh2e6d83b2019-08-03 01:39:20 +00003895 int x = va_arg(ap, int);
3896 int y;
3897 sqlite3 *db = va_arg(ap, sqlite3*);
3898 assert( db==0 || db->aDb[0].pSchema!=0 );
3899 if( db && (y = db->aDb[0].pSchema->schema_cookie)!=0 ){ x = y; }
3900 sqlite3Config.iPrngSeed = x;
3901 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003902 break;
3903 }
drhef9f7192020-01-17 19:14:08 +00003904#endif
drh3088d592008-03-21 16:45:47 +00003905
3906 /*
3907 ** sqlite3_test_control(BITVEC_TEST, size, program)
3908 **
3909 ** Run a test against a Bitvec object of size. The program argument
3910 ** is an array of integers that defines the test. Return -1 on a
3911 ** memory allocation error, 0 on success, or non-zero for an error.
3912 ** See the sqlite3BitvecBuiltinTest() for additional information.
3913 */
3914 case SQLITE_TESTCTRL_BITVEC_TEST: {
3915 int sz = va_arg(ap, int);
3916 int *aProg = va_arg(ap, int*);
3917 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3918 break;
3919 }
danielk19772d1d86f2008-06-20 14:59:51 +00003920
3921 /*
drhc007f612014-05-16 14:17:01 +00003922 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3923 **
3924 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3925 ** if xCallback is not NULL.
3926 **
3927 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3928 ** is called immediately after installing the new callback and the return
3929 ** value from sqlite3FaultSim(0) becomes the return from
3930 ** sqlite3_test_control().
3931 */
3932 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003933 /* MSVC is picky about pulling func ptrs from va lists.
3934 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003935 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003936 */
3937 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003938 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003939 rc = sqlite3FaultSim(0);
3940 break;
3941 }
3942
3943 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003944 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3945 **
3946 ** Register hooks to call to indicate which malloc() failures
3947 ** are benign.
3948 */
3949 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003950 typedef void (*void_function)(void);
3951 void_function xBenignBegin;
3952 void_function xBenignEnd;
3953 xBenignBegin = va_arg(ap, void_function);
3954 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003955 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3956 break;
3957 }
drhc7a3bb92009-02-05 16:31:45 +00003958
3959 /*
drhf3af63f2009-05-09 18:59:42 +00003960 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003961 **
3962 ** Set the PENDING byte to the value in the argument, if X>0.
3963 ** Make no changes if X==0. Return the value of the pending byte
3964 ** as it existing before this routine was called.
3965 **
3966 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3967 ** an incompatible database file format. Changing the PENDING byte
3968 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003969 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003970 */
3971 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003972 rc = PENDING_BYTE;
3973#ifndef SQLITE_OMIT_WSD
3974 {
3975 unsigned int newVal = va_arg(ap, unsigned int);
3976 if( newVal ) sqlite3PendingByte = newVal;
3977 }
3978#endif
drhc7a3bb92009-02-05 16:31:45 +00003979 break;
3980 }
drhf3af63f2009-05-09 18:59:42 +00003981
3982 /*
3983 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3984 **
3985 ** This action provides a run-time test to see whether or not
3986 ** assert() was enabled at compile-time. If X is true and assert()
3987 ** is enabled, then the return value is true. If X is true and
3988 ** assert() is disabled, then the return value is zero. If X is
3989 ** false and assert() is enabled, then the assertion fires and the
3990 ** process aborts. If X is false and assert() is disabled, then the
3991 ** return value is zero.
3992 */
3993 case SQLITE_TESTCTRL_ASSERT: {
3994 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003995 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003996 rc = x;
3997 break;
3998 }
3999
4000
4001 /*
4002 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
4003 **
4004 ** This action provides a run-time test to see how the ALWAYS and
4005 ** NEVER macros were defined at compile-time.
4006 **
drhce2c4822017-10-03 17:17:34 +00004007 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00004008 **
4009 ** The recommended test is X==2. If the return value is 2, that means
4010 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
4011 ** default setting. If the return value is 1, then ALWAYS() is either
4012 ** hard-coded to true or else it asserts if its argument is false.
4013 ** The first behavior (hard-coded to true) is the case if
4014 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
4015 ** behavior (assert if the argument to ALWAYS() is false) is the case if
4016 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
4017 **
4018 ** The run-time test procedure might look something like this:
4019 **
4020 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
4021 ** // ALWAYS() and NEVER() are no-op pass-through macros
4022 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
4023 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
4024 ** }else{
4025 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
4026 ** }
4027 */
4028 case SQLITE_TESTCTRL_ALWAYS: {
4029 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00004030 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00004031 break;
4032 }
drhc046e3e2009-07-15 11:26:44 +00004033
drh2cf4acb2014-04-18 00:06:02 +00004034 /*
4035 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
4036 **
4037 ** The integer returned reveals the byte-order of the computer on which
4038 ** SQLite is running:
4039 **
4040 ** 1 big-endian, determined at run-time
4041 ** 10 little-endian, determined at run-time
4042 ** 432101 big-endian, determined at compile-time
4043 ** 123410 little-endian, determined at compile-time
4044 */
4045 case SQLITE_TESTCTRL_BYTEORDER: {
4046 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
4047 break;
4048 }
4049
drhc046e3e2009-07-15 11:26:44 +00004050 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
4051 **
4052 ** Set the nReserve size to N for the main database on the database
4053 ** connection db.
4054 */
4055 case SQLITE_TESTCTRL_RESERVE: {
4056 sqlite3 *db = va_arg(ap, sqlite3*);
4057 int x = va_arg(ap,int);
4058 sqlite3_mutex_enter(db->mutex);
4059 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
4060 sqlite3_mutex_leave(db->mutex);
4061 break;
4062 }
4063
drh07096f62009-12-22 23:52:32 +00004064 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
4065 **
4066 ** Enable or disable various optimizations for testing purposes. The
4067 ** argument N is a bitmask of optimizations to be disabled. For normal
4068 ** operation N should be 0. The idea is that a test program (like the
4069 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
4070 ** with various optimizations disabled to verify that the same answer
4071 ** is obtained in every case.
4072 */
4073 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
4074 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00004075 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00004076 break;
4077 }
4078
danc17d6962011-06-21 12:47:30 +00004079 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
4080 **
drheea8eb62018-11-26 18:09:15 +00004081 ** If parameter onoff is non-zero, subsequent calls to localtime()
4082 ** and its variants fail. If onoff is zero, undo this setting.
danc17d6962011-06-21 12:47:30 +00004083 */
4084 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
4085 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
4086 break;
4087 }
4088
drh171c50e2020-01-01 15:43:30 +00004089 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCTIONS, sqlite3*);
drheea8eb62018-11-26 18:09:15 +00004090 **
drh171c50e2020-01-01 15:43:30 +00004091 ** Toggle the ability to use internal functions on or off for
4092 ** the database connection given in the argument.
drheea8eb62018-11-26 18:09:15 +00004093 */
4094 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
drh171c50e2020-01-01 15:43:30 +00004095 sqlite3 *db = va_arg(ap, sqlite3*);
4096 db->mDbFlags ^= DBFLAG_InternalFunc;
drheea8eb62018-11-26 18:09:15 +00004097 break;
4098 }
4099
drh09fe6142013-11-29 15:06:27 +00004100 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4101 **
4102 ** Set or clear a flag that indicates that the database file is always well-
4103 ** formed and never corrupt. This flag is clear by default, indicating that
4104 ** database files might have arbitrary corruption. Setting the flag during
4105 ** testing causes certain assert() statements in the code to be activated
4106 ** that demonstrat invariants on well-formed database files.
4107 */
4108 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00004109 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00004110 break;
4111 }
4112
drh30842992019-08-12 14:17:43 +00004113 /* sqlite3_test_control(SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS, int);
4114 **
4115 ** Set or clear a flag that causes SQLite to verify that type, name,
4116 ** and tbl_name fields of the sqlite_master table. This is normally
4117 ** on, but it is sometimes useful to turn it off for testing.
4118 */
4119 case SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS: {
4120 sqlite3GlobalConfig.bExtraSchemaChecks = va_arg(ap, int);
4121 break;
4122 }
4123
drh9e5eb9c2016-09-18 16:08:10 +00004124 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00004125 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004126 ** too big to test in a reasonable amount of time, so this control is
4127 ** provided to set a small and easily reachable reset value.
4128 */
4129 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4130 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4131 break;
4132 }
drh688852a2014-02-17 22:40:43 +00004133
4134 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4135 **
4136 ** Set the VDBE coverage callback function to xCallback with context
4137 ** pointer ptr.
4138 */
4139 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4140#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00004141 typedef void (*branch_callback)(void*,unsigned int,
4142 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00004143 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4144 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4145#endif
4146 break;
4147 }
4148
dan8930c2a2014-04-03 16:25:29 +00004149 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4150 case SQLITE_TESTCTRL_SORTER_MMAP: {
4151 sqlite3 *db = va_arg(ap, sqlite3*);
4152 db->nMaxSorterMmap = va_arg(ap, int);
4153 break;
4154 }
4155
drh43cfc232014-07-29 14:09:21 +00004156 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4157 **
4158 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4159 ** not.
4160 */
4161 case SQLITE_TESTCTRL_ISINIT: {
4162 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4163 break;
4164 }
drh8964b342015-01-29 17:54:52 +00004165
drh3ba689d2015-03-03 14:00:11 +00004166 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004167 **
drh1ffede82015-01-30 20:59:27 +00004168 ** This test control is used to create imposter tables. "db" is a pointer
4169 ** to the database connection. dbName is the database name (ex: "main" or
4170 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4171 ** or off. "tnum" is the root page of the b-tree to which the imposter
4172 ** table should connect.
4173 **
4174 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004175 ** run a single CREATE TABLE statement to construct the imposter table in
4176 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004177 **
4178 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4179 ** the schema to be reparsed the next time it is needed. This has the
4180 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004181 */
drh1ffede82015-01-30 20:59:27 +00004182 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004183 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004184 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004185 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4186 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004187 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004188 if( db->init.busy==0 && db->init.newTnum>0 ){
4189 sqlite3ResetAllSchemasOfConnection(db);
4190 }
drh8fb15e32015-02-04 20:56:49 +00004191 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004192 break;
4193 }
drh0d9de992017-12-26 18:04:23 +00004194
4195#if defined(YYCOVERAGE)
4196 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4197 **
4198 ** This test control (only available when SQLite is compiled with
4199 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4200 ** state/lookahead combinations in the parser state machine
4201 ** which are never exercised. If any state is missed, make the
4202 ** return code SQLITE_ERROR.
4203 */
4204 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4205 FILE *out = va_arg(ap, FILE*);
4206 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4207 break;
4208 }
4209#endif /* defined(YYCOVERAGE) */
drh0c8f4032019-05-03 21:17:28 +00004210
4211 /* sqlite3_test_control(SQLITE_TESTCTRL_RESULT_INTREAL, sqlite3_context*);
4212 **
4213 ** This test-control causes the most recent sqlite3_result_int64() value
4214 ** to be interpreted as a MEM_IntReal instead of as an MEM_Int. Normally,
4215 ** MEM_IntReal values only arise during an INSERT operation of integer
4216 ** values into a REAL column, so they can be challenging to test. This
4217 ** test-control enables us to write an intreal() SQL function that can
4218 ** inject an intreal() value at arbitrary places in an SQL statement,
4219 ** for testing purposes.
4220 */
4221 case SQLITE_TESTCTRL_RESULT_INTREAL: {
4222 sqlite3_context *pCtx = va_arg(ap, sqlite3_context*);
4223 sqlite3ResultIntReal(pCtx);
4224 break;
4225 }
drhed13d982008-01-31 14:43:24 +00004226 }
4227 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004228#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004229 return rc;
drhed13d982008-01-31 14:43:24 +00004230}
drhcc487d12011-05-17 18:53:08 +00004231
4232/*
drh532b0d22020-01-27 14:40:44 +00004233** The Pager stores the Database filename, Journal filename, and WAL filename
4234** consecutively in memory, in that order. The database filename is prefixed
4235** by four zero bytes. Locate the start of the database filename by searching
4236** backwards for the first byte following four consecutive zero bytes.
4237**
4238** This only works if the filename passed in was obtained from the Pager.
4239*/
4240static const char *databaseName(const char *zName){
4241 while( zName[-1]!=0 || zName[-2]!=0 || zName[-3]!=0 || zName[-4]!=0 ){
4242 zName--;
4243 }
4244 return zName;
4245}
4246
4247/*
drh4defddd2020-02-18 19:49:48 +00004248** Append text z[] to the end of p[]. Return a pointer to the first
4249** character after then zero terminator on the new text in p[].
4250*/
4251static char *appendText(char *p, const char *z){
4252 size_t n = strlen(z);
4253 memcpy(p, z, n+1);
4254 return p+n+1;
4255}
4256
4257/*
4258** Allocate memory to hold names for a database, journal file, WAL file,
4259** and query parameters. The pointer returned is valid for use by
4260** sqlite3_filename_database() and sqlite3_uri_parameter() and related
4261** functions.
4262**
4263** Memory layout must be compatible with that generated by the pager
4264** and expected by sqlite3_uri_parameter() and databaseName().
4265*/
4266char *sqlite3_create_filename(
4267 const char *zDatabase,
4268 const char *zJournal,
4269 const char *zWal,
4270 int nParam,
4271 const char **azParam
4272){
4273 sqlite3_int64 nByte;
4274 int i;
4275 char *pResult, *p;
4276 nByte = strlen(zDatabase) + strlen(zJournal) + strlen(zWal) + 10;
4277 for(i=0; i<nParam*2; i++){
4278 nByte += strlen(azParam[i])+1;
4279 }
4280 pResult = p = sqlite3_malloc64( nByte );
4281 if( p==0 ) return 0;
4282 memset(p, 0, 4);
4283 p += 4;
4284 p = appendText(p, zDatabase);
4285 for(i=0; i<nParam*2; i++){
4286 p = appendText(p, azParam[i]);
4287 }
4288 *(p++) = 0;
4289 p = appendText(p, zJournal);
4290 p = appendText(p, zWal);
4291 *(p++) = 0;
4292 *(p++) = 0;
4293 assert( (sqlite3_int64)(p - pResult)==nByte );
4294 return pResult + 4;
4295}
4296
4297/*
4298** Free memory obtained from sqlite3_create_filename(). It is a severe
4299** error to call this routine with any parameter other than a pointer
4300** previously obtained from sqlite3_create_filename() or a NULL pointer.
4301*/
4302void sqlite3_free_filename(char *p){
4303 if( p==0 ) return;
4304 p = (char*)databaseName(p);
4305 sqlite3_free(p - 4);
4306}
4307
4308
4309/*
drhcc487d12011-05-17 18:53:08 +00004310** This is a utility routine, useful to VFS implementations, that checks
4311** to see if a database file was a URI that contained a specific query
4312** parameter, and if so obtains the value of the query parameter.
4313**
4314** The zFilename argument is the filename pointer passed into the xOpen()
4315** method of a VFS implementation. The zParam argument is the name of the
4316** query parameter we seek. This routine returns the value of the zParam
4317** parameter if it exists. If the parameter does not exist, this routine
4318** returns a NULL pointer.
4319*/
4320const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004321 if( zFilename==0 || zParam==0 ) return 0;
drh532b0d22020-01-27 14:40:44 +00004322 zFilename = databaseName(zFilename);
drh1eac9662020-02-01 13:30:39 +00004323 return uriParameter(zFilename, zParam);
drhcc487d12011-05-17 18:53:08 +00004324}
drh283829c2011-11-17 00:56:20 +00004325
4326/*
drh80804032020-01-11 16:08:31 +00004327** Return a pointer to the name of Nth query parameter of the filename.
4328*/
4329const char *sqlite3_uri_key(const char *zFilename, int N){
4330 if( zFilename==0 || N<0 ) return 0;
drh532b0d22020-01-27 14:40:44 +00004331 zFilename = databaseName(zFilename);
drh80804032020-01-11 16:08:31 +00004332 zFilename += sqlite3Strlen30(zFilename) + 1;
4333 while( zFilename[0] && (N--)>0 ){
4334 zFilename += sqlite3Strlen30(zFilename) + 1;
4335 zFilename += sqlite3Strlen30(zFilename) + 1;
4336 }
4337 return zFilename[0] ? zFilename : 0;
4338}
4339
4340/*
drh92913722011-12-23 00:07:33 +00004341** Return a boolean value for a query parameter.
4342*/
4343int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4344 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004345 bDflt = bDflt!=0;
4346 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004347}
4348
4349/*
4350** Return a 64-bit integer value for a query parameter.
4351*/
4352sqlite3_int64 sqlite3_uri_int64(
4353 const char *zFilename, /* Filename as passed to xOpen */
4354 const char *zParam, /* URI parameter sought */
4355 sqlite3_int64 bDflt /* return if parameter is missing */
4356){
4357 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4358 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004359 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004360 bDflt = v;
4361 }
4362 return bDflt;
4363}
4364
4365/*
drh8875b9e2020-01-10 18:05:55 +00004366** Translate a filename that was handed to a VFS routine into the corresponding
4367** database, journal, or WAL file.
4368**
4369** It is an error to pass this routine a filename string that was not
4370** passed into the VFS from the SQLite core. Doing so is similar to
4371** passing free() a pointer that was not obtained from malloc() - it is
4372** an error that we cannot easily detect but that will likely cause memory
4373** corruption.
4374*/
4375const char *sqlite3_filename_database(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004376 return databaseName(zFilename);
drh8875b9e2020-01-10 18:05:55 +00004377}
4378const char *sqlite3_filename_journal(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004379 zFilename = databaseName(zFilename);
4380 zFilename += sqlite3Strlen30(zFilename) + 1;
4381 while( zFilename[0] ){
4382 zFilename += sqlite3Strlen30(zFilename) + 1;
4383 zFilename += sqlite3Strlen30(zFilename) + 1;
4384 }
4385 return zFilename + 1;
drh8875b9e2020-01-10 18:05:55 +00004386}
4387const char *sqlite3_filename_wal(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004388#ifdef SQLITE_OMIT_WAL
4389 return 0;
4390#else
4391 zFilename = sqlite3_filename_journal(zFilename);
4392 zFilename += sqlite3Strlen30(zFilename) + 1;
4393 return zFilename;
4394#endif
drh8875b9e2020-01-10 18:05:55 +00004395}
4396
4397/*
drh421377e2012-03-15 21:28:54 +00004398** Return the Btree pointer identified by zDbName. Return NULL if not found.
4399*/
4400Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004401 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4402 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004403}
4404
4405/*
drh283829c2011-11-17 00:56:20 +00004406** Return the filename of the database associated with a database
4407** connection.
4408*/
4409const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004410 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004411#ifdef SQLITE_ENABLE_API_ARMOR
4412 if( !sqlite3SafetyCheckOk(db) ){
4413 (void)SQLITE_MISUSE_BKPT;
4414 return 0;
4415 }
4416#endif
mistachkincd54bab2014-12-20 21:14:14 +00004417 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004418 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4419}
4420
4421/*
4422** Return 1 if database is read-only or 0 if read/write. Return -1 if
4423** no such database exists.
4424*/
4425int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004426 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004427#ifdef SQLITE_ENABLE_API_ARMOR
4428 if( !sqlite3SafetyCheckOk(db) ){
4429 (void)SQLITE_MISUSE_BKPT;
4430 return -1;
4431 }
4432#endif
mistachkincd54bab2014-12-20 21:14:14 +00004433 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004434 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004435}
danfc1acf32015-12-05 20:51:54 +00004436
4437#ifdef SQLITE_ENABLE_SNAPSHOT
4438/*
4439** Obtain a snapshot handle for the snapshot of database zDb currently
4440** being read by handle db.
4441*/
4442int sqlite3_snapshot_get(
4443 sqlite3 *db,
4444 const char *zDb,
4445 sqlite3_snapshot **ppSnapshot
4446){
4447 int rc = SQLITE_ERROR;
4448#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004449
4450#ifdef SQLITE_ENABLE_API_ARMOR
4451 if( !sqlite3SafetyCheckOk(db) ){
4452 return SQLITE_MISUSE_BKPT;
4453 }
4454#endif
4455 sqlite3_mutex_enter(db->mutex);
4456
danedace5d2016-11-18 18:43:39 +00004457 if( db->autoCommit==0 ){
4458 int iDb = sqlite3FindDbName(db, zDb);
4459 if( iDb==0 || iDb>1 ){
4460 Btree *pBt = db->aDb[iDb].pBt;
4461 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004462 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004463 if( rc==SQLITE_OK ){
4464 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4465 }
dan7116dc62015-12-10 20:03:08 +00004466 }
danfc1acf32015-12-05 20:51:54 +00004467 }
4468 }
4469
4470 sqlite3_mutex_leave(db->mutex);
4471#endif /* SQLITE_OMIT_WAL */
4472 return rc;
4473}
4474
4475/*
4476** Open a read-transaction on the snapshot idendified by pSnapshot.
4477*/
4478int sqlite3_snapshot_open(
4479 sqlite3 *db,
4480 const char *zDb,
4481 sqlite3_snapshot *pSnapshot
4482){
4483 int rc = SQLITE_ERROR;
4484#ifndef SQLITE_OMIT_WAL
4485
4486#ifdef SQLITE_ENABLE_API_ARMOR
4487 if( !sqlite3SafetyCheckOk(db) ){
4488 return SQLITE_MISUSE_BKPT;
4489 }
4490#endif
4491 sqlite3_mutex_enter(db->mutex);
4492 if( db->autoCommit==0 ){
4493 int iDb;
4494 iDb = sqlite3FindDbName(db, zDb);
4495 if( iDb==0 || iDb>1 ){
4496 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004497 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4498 Pager *pPager = sqlite3BtreePager(pBt);
4499 int bUnlock = 0;
4500 if( sqlite3BtreeIsInReadTrans(pBt) ){
4501 if( db->nVdbeActive==0 ){
4502 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4503 if( rc==SQLITE_OK ){
4504 bUnlock = 1;
4505 rc = sqlite3BtreeCommit(pBt);
4506 }
4507 }
4508 }else{
4509 rc = SQLITE_OK;
4510 }
4511 if( rc==SQLITE_OK ){
4512 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4513 }
danfc1acf32015-12-05 20:51:54 +00004514 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004515 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danfa3d4c12018-08-06 17:12:36 +00004516 sqlite3PagerSnapshotOpen(pPager, 0);
4517 }
4518 if( bUnlock ){
4519 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004520 }
4521 }
4522 }
4523 }
4524
4525 sqlite3_mutex_leave(db->mutex);
4526#endif /* SQLITE_OMIT_WAL */
4527 return rc;
4528}
4529
4530/*
dan11584982016-11-18 20:49:43 +00004531** Recover as many snapshots as possible from the wal file associated with
4532** schema zDb of database db.
4533*/
4534int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4535 int rc = SQLITE_ERROR;
4536 int iDb;
4537#ifndef SQLITE_OMIT_WAL
4538
4539#ifdef SQLITE_ENABLE_API_ARMOR
4540 if( !sqlite3SafetyCheckOk(db) ){
4541 return SQLITE_MISUSE_BKPT;
4542 }
4543#endif
4544
4545 sqlite3_mutex_enter(db->mutex);
4546 iDb = sqlite3FindDbName(db, zDb);
4547 if( iDb==0 || iDb>1 ){
4548 Btree *pBt = db->aDb[iDb].pBt;
4549 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004550 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004551 if( rc==SQLITE_OK ){
4552 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4553 sqlite3BtreeCommit(pBt);
4554 }
dan11584982016-11-18 20:49:43 +00004555 }
4556 }
4557 sqlite3_mutex_leave(db->mutex);
4558#endif /* SQLITE_OMIT_WAL */
4559 return rc;
4560}
4561
4562/*
danfc1acf32015-12-05 20:51:54 +00004563** Free a snapshot handle obtained from sqlite3_snapshot_get().
4564*/
4565void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4566 sqlite3_free(pSnapshot);
4567}
4568#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004569
4570#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4571/*
4572** Given the name of a compile-time option, return true if that option
4573** was used and false if not.
4574**
4575** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4576** is not required for a match.
4577*/
4578int sqlite3_compileoption_used(const char *zOptName){
4579 int i, n;
4580 int nOpt;
4581 const char **azCompileOpt;
4582
4583#if SQLITE_ENABLE_API_ARMOR
4584 if( zOptName==0 ){
4585 (void)SQLITE_MISUSE_BKPT;
4586 return 0;
4587 }
4588#endif
4589
4590 azCompileOpt = sqlite3CompileOptions(&nOpt);
4591
4592 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4593 n = sqlite3Strlen30(zOptName);
4594
4595 /* Since nOpt is normally in single digits, a linear search is
4596 ** adequate. No need for a binary search. */
4597 for(i=0; i<nOpt; i++){
4598 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4599 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4600 ){
4601 return 1;
4602 }
4603 }
4604 return 0;
4605}
4606
4607/*
4608** Return the N-th compile-time option string. If N is out of range,
4609** return a NULL pointer.
4610*/
4611const char *sqlite3_compileoption_get(int N){
4612 int nOpt;
4613 const char **azCompileOpt;
4614 azCompileOpt = sqlite3CompileOptions(&nOpt);
4615 if( N>=0 && N<nOpt ){
4616 return azCompileOpt[N];
4617 }
4618 return 0;
4619}
4620#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */