blob: 9e1a0e9dab80665940c3234a781597cc59d736fa [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
drh20e34f92020-05-04 17:15:21 +000028
29/*
30** This is an extension initializer that is a no-op and always
31** succeeds, except that it fails if the fault-simulation is set
32** to 500.
33*/
34static int sqlite3TestExtInit(sqlite3 *db){
35 (void)db;
36 return sqlite3FaultSim(500);
37}
38
39
40/*
41** Forward declarations of external module initializer functions
42** for modules that need them.
43*/
44#ifdef SQLITE_ENABLE_FTS1
45int sqlite3Fts1Init(sqlite3*);
46#endif
47#ifdef SQLITE_ENABLE_FTS2
48int sqlite3Fts2Init(sqlite3*);
49#endif
50#ifdef SQLITE_ENABLE_FTS5
51int sqlite3Fts5Init(sqlite3*);
52#endif
drhc306e082015-10-08 23:37:00 +000053#ifdef SQLITE_ENABLE_JSON1
54int sqlite3Json1Init(sqlite3*);
55#endif
drhc6603af2017-06-29 14:33:51 +000056#ifdef SQLITE_ENABLE_STMTVTAB
57int sqlite3StmtVtabInit(sqlite3*);
drhf00f5302017-06-28 15:47:29 +000058#endif
drh20e34f92020-05-04 17:15:21 +000059
60/*
61** An array of pointers to extension initializer functions for
62** built-in extensions.
63*/
64static int (*const sqlite3BuiltinExtensions[])(sqlite3*) = {
65#ifdef SQLITE_ENABLE_FTS1
66 sqlite3Fts1Init,
drhc306e082015-10-08 23:37:00 +000067#endif
drh20e34f92020-05-04 17:15:21 +000068#ifdef SQLITE_ENABLE_FTS2
69 sqlite3Fts2Init,
70#endif
71#ifdef SQLITE_ENABLE_FTS3
72 sqlite3Fts3Init,
73#endif
74#ifdef SQLITE_ENABLE_FTS5
75 sqlite3Fts5Init,
76#endif
77#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
78 sqlite3IcuInit,
79#endif
80#ifdef SQLITE_ENABLE_RTREE
81 sqlite3RtreeInit,
82#endif
83#ifdef SQLITE_ENABLE_DBPAGE_VTAB
84 sqlite3DbpageRegister,
85#endif
86#ifdef SQLITE_ENABLE_DBSTAT_VTAB
87 sqlite3DbstatRegister,
88#endif
89 sqlite3TestExtInit,
90#ifdef SQLITE_ENABLE_JSON1
91 sqlite3Json1Init,
92#endif
93#ifdef SQLITE_ENABLE_STMTVTAB
94 sqlite3StmtVtabInit,
95#endif
96#ifdef SQLITE_ENABLE_BYTECODE_VTAB
97 sqlite3VdbeBytecodeVtabInit,
98#endif
99};
drh75897232000-05-29 14:26:00 +0000100
drhb3190c12008-12-08 21:37:14 +0000101#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +0000102/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
103** contains the text of SQLITE_VERSION macro.
104*/
danielk197724b03fd2004-05-10 10:34:34 +0000105const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +0000106#endif
drh9f129f42010-08-31 15:27:32 +0000107
108/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
109** a pointer to the to the sqlite3_version[] string constant.
110*/
drh4aec8b62004-08-28 16:19:00 +0000111const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +0000112
drhc6aa3812017-10-04 18:26:44 +0000113/* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
drh9f129f42010-08-31 15:27:32 +0000114** pointer to a string constant whose value is the same as the
drhc6aa3812017-10-04 18:26:44 +0000115** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
116** an edited copy of the amalgamation, then the last four characters of
117** the hash might be different from SQLITE_SOURCE_ID.
drh9f129f42010-08-31 15:27:32 +0000118*/
drh47baebc2009-08-14 16:01:24 +0000119const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +0000120
121/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
122** returns an integer equal to SQLITE_VERSION_NUMBER.
123*/
danielk197799ba19e2005-02-05 07:33:34 +0000124int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +0000125
drh5dc2bcd2012-01-02 15:45:12 +0000126/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +0000127** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +0000128** the SQLITE_THREADSAFE compile-time option being set to 0.
129*/
drhb67e8bf2007-08-30 20:09:48 +0000130int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +0000131
mistachkin34cf2582015-04-02 17:46:52 +0000132/*
133** When compiling the test fixture or with debugging enabled (on Win32),
134** this variable being set to non-zero will cause OSTRACE macros to emit
135** extra diagnostic information.
136*/
mistachkinfb383e92015-04-16 03:24:38 +0000137#ifdef SQLITE_HAVE_OS_TRACE
mistachkin34cf2582015-04-02 17:46:52 +0000138# ifndef SQLITE_DEBUG_OS_TRACE
139# define SQLITE_DEBUG_OS_TRACE 0
140# endif
141 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
142#endif
143
drhe265b082008-05-01 17:03:49 +0000144#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +0000145/*
drhb0603412007-02-28 04:47:26 +0000146** If the following function pointer is not NULL and if
147** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
148** I/O active are written using this function. These messages
149** are intended for debugging activity only.
150*/
mistachkin9871a932015-03-27 00:21:52 +0000151SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +0000152#endif
drhb0603412007-02-28 04:47:26 +0000153
154/*
drha16313e2007-03-30 11:29:32 +0000155** If the following global variable points to a string which is the
156** name of a directory, then that directory will be used to store
157** temporary files.
158**
159** See also the "PRAGMA temp_store_directory" SQL command.
160*/
161char *sqlite3_temp_directory = 0;
162
drhc5499be2008-04-01 15:06:33 +0000163/*
mistachkina112d142012-03-14 00:44:01 +0000164** If the following global variable points to a string which is the
165** name of a directory, then that directory will be used to store
166** all database files specified with a relative pathname.
167**
168** See also the "PRAGMA data_store_directory" SQL command.
169*/
170char *sqlite3_data_directory = 0;
171
172/*
drh40257ff2008-06-13 18:24:27 +0000173** Initialize SQLite.
174**
175** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000176** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000177** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
178** this routine will be called automatically by key routines such as
179** sqlite3_open().
180**
181** This routine is a no-op except on its very first call for the process,
182** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000183**
184** The first thread to call this routine runs the initialization to
185** completion. If subsequent threads call this routine before the first
186** thread has finished the initialization process, then the subsequent
187** threads must block until the first thread finishes with the initialization.
188**
189** The first thread might call this routine recursively. Recursive
190** calls to this routine should not block, of course. Otherwise the
191** initialization process would never complete.
192**
193** Let X be the first thread to enter this routine. Let Y be some other
194** thread. Then while the initial invocation of this routine by X is
195** incomplete, it is required that:
196**
197** * Calls to this routine from Y must block until the outer-most
198** call by X completes.
199**
200** * Recursive calls to this routine from thread X return immediately
201** without blocking.
drh40257ff2008-06-13 18:24:27 +0000202*/
203int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000204 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000205 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000206#ifdef SQLITE_EXTRA_INIT
207 int bRunExtraInit = 0; /* Extra initialization needed */
208#endif
danielk1977075c23a2008-09-01 18:34:20 +0000209
210#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000211 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000212 if( rc!=SQLITE_OK ){
213 return rc;
214 }
215#endif
danielk197771bc31c2008-06-26 08:29:34 +0000216
drh2b4905c2015-03-23 18:52:56 +0000217 /* If the following assert() fails on some obscure processor/compiler
218 ** combination, the work-around is to set the correct pointer
219 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
220 assert( SQLITE_PTRSIZE==sizeof(char*) );
221
drh93ed56d2008-08-12 15:21:11 +0000222 /* If SQLite is already completely initialized, then this call
223 ** to sqlite3_initialize() should be a no-op. But the initialization
224 ** must be complete. So isInit must not be set until the very end
225 ** of this routine.
226 */
drhffd3fd02020-01-29 13:10:50 +0000227 if( sqlite3GlobalConfig.isInit ){
228 sqlite3MemoryBarrier();
229 return SQLITE_OK;
230 }
danielk197771bc31c2008-06-26 08:29:34 +0000231
drh93ed56d2008-08-12 15:21:11 +0000232 /* Make sure the mutex subsystem is initialized. If unable to
233 ** initialize the mutex subsystem, return early with the error.
234 ** If the system is so sick that we are unable to allocate a mutex,
235 ** there is not much SQLite is going to be able to do.
236 **
237 ** The mutex subsystem must take care of serializing its own
238 ** initialization.
239 */
danielk1977d0251742008-06-18 18:57:42 +0000240 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000241 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000242
drh93ed56d2008-08-12 15:21:11 +0000243 /* Initialize the malloc() system and the recursive pInitMutex mutex.
244 ** This operation is protected by the STATIC_MASTER mutex. Note that
245 ** MutexAlloc() is called for a static mutex prior to initializing the
246 ** malloc subsystem - this implies that the allocation of a static
247 ** mutex must not require support from the malloc subsystem.
248 */
drh30ddce62011-10-15 00:16:30 +0000249 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000250 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000251 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000252 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000253 rc = sqlite3MallocInit();
254 }
drh40257ff2008-06-13 18:24:27 +0000255 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000256 sqlite3GlobalConfig.isMallocInit = 1;
257 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000258 sqlite3GlobalConfig.pInitMutex =
259 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000260 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
mistachkinfad30392016-02-13 23:43:46 +0000261 rc = SQLITE_NOMEM_BKPT;
drh40257ff2008-06-13 18:24:27 +0000262 }
263 }
danielk197777eb5bb2008-09-22 17:22:19 +0000264 }
265 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000266 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000267 }
268 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000269
dane1ab2192009-08-17 15:16:19 +0000270 /* If rc is not SQLITE_OK at this point, then either the malloc
271 ** subsystem could not be initialized or the system failed to allocate
272 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000273 if( rc!=SQLITE_OK ){
274 return rc;
275 }
276
277 /* Do the rest of the initialization under the recursive mutex so
278 ** that we will be able to handle recursive calls into
279 ** sqlite3_initialize(). The recursive calls normally come through
280 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
281 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000282 **
283 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
284 ** to the xInit method, so the xInit method need not be threadsafe.
285 **
286 ** The following mutex is what serializes access to the appdef pcache xInit
287 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
288 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000289 */
danielk1977075c23a2008-09-01 18:34:20 +0000290 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000291 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977502b4e02008-09-02 14:07:24 +0000292 sqlite3GlobalConfig.inProgress = 1;
drh5e3cefe2015-11-12 23:48:08 +0000293#ifdef SQLITE_ENABLE_SQLLOG
dand83f7ca2015-11-12 20:12:51 +0000294 {
drh5e3cefe2015-11-12 23:48:08 +0000295 extern void sqlite3_init_sqllog(void);
296 sqlite3_init_sqllog();
dand83f7ca2015-11-12 20:12:51 +0000297 }
298#endif
drh80738d92016-02-15 00:34:16 +0000299 memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
300 sqlite3RegisterBuiltinFunctions();
dane1ab2192009-08-17 15:16:19 +0000301 if( sqlite3GlobalConfig.isPCacheInit==0 ){
302 rc = sqlite3PcacheInitialize();
303 }
danielk19778c0a7912008-08-20 14:49:23 +0000304 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000305 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000306 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000307 }
drh9c6396e2018-03-06 21:43:19 +0000308#ifdef SQLITE_ENABLE_DESERIALIZE
drhac442f42018-01-03 01:28:46 +0000309 if( rc==SQLITE_OK ){
310 rc = sqlite3MemdbInit();
311 }
312#endif
drh0bf9f7b2009-04-17 16:54:22 +0000313 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000314 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
315 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000316 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000317#ifdef SQLITE_EXTRA_INIT
318 bRunExtraInit = 1;
319#endif
danielk19778c0a7912008-08-20 14:49:23 +0000320 }
danielk1977502b4e02008-09-02 14:07:24 +0000321 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000322 }
danielk1977075c23a2008-09-01 18:34:20 +0000323 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000324
drh93ed56d2008-08-12 15:21:11 +0000325 /* Go back under the static mutex and clean up the recursive
326 ** mutex to prevent a resource leak.
327 */
328 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000329 sqlite3GlobalConfig.nRefInitMutex--;
330 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
331 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
332 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
333 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000334 }
335 sqlite3_mutex_leave(pMaster);
336
337 /* The following is just a sanity check to make sure SQLite has
338 ** been compiled correctly. It is important to run this code, but
339 ** we don't want to run it too often and soak up CPU cycles for no
340 ** reason. So we run it once during initialization.
341 */
shanedfb7b372008-07-22 05:13:30 +0000342#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000343#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000344 /* This section of code's only "output" is via assert() statements. */
drhac442f42018-01-03 01:28:46 +0000345 if( rc==SQLITE_OK ){
shanedfb7b372008-07-22 05:13:30 +0000346 u64 x = (((u64)1)<<63)-1;
347 double y;
348 assert(sizeof(x)==8);
349 assert(sizeof(x)==sizeof(y));
350 memcpy(&y, &x, 8);
351 assert( sqlite3IsNaN(y) );
352 }
353#endif
shanefbd60f82009-02-04 03:59:25 +0000354#endif
shanedfb7b372008-07-22 05:13:30 +0000355
drhe4cf0b32011-08-25 00:14:41 +0000356 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
357 ** compile-time option.
358 */
359#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000360 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000361 int SQLITE_EXTRA_INIT(const char*);
362 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000363 }
364#endif
365
drh40257ff2008-06-13 18:24:27 +0000366 return rc;
367}
368
369/*
370** Undo the effects of sqlite3_initialize(). Must not be called while
371** there are outstanding database connections or memory allocations or
372** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000373** routine is not threadsafe. But it is safe to invoke this routine
374** on when SQLite is already shut down. If SQLite is already shut down
375** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000376*/
377int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000378#ifdef SQLITE_OMIT_WSD
379 int rc = sqlite3_wsd_init(4096, 24);
380 if( rc!=SQLITE_OK ){
381 return rc;
382 }
383#endif
384
danielk1977075c23a2008-09-01 18:34:20 +0000385 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000386#ifdef SQLITE_EXTRA_SHUTDOWN
387 void SQLITE_EXTRA_SHUTDOWN(void);
388 SQLITE_EXTRA_SHUTDOWN();
389#endif
drha7640922009-04-21 12:02:56 +0000390 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000391 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000392 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000393 }
dane1ab2192009-08-17 15:16:19 +0000394 if( sqlite3GlobalConfig.isPCacheInit ){
395 sqlite3PcacheShutdown();
396 sqlite3GlobalConfig.isPCacheInit = 0;
397 }
398 if( sqlite3GlobalConfig.isMallocInit ){
399 sqlite3MallocEnd();
400 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000401
402#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
403 /* The heap subsystem has now been shutdown and these values are supposed
404 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
405 ** which would rely on that heap subsystem; therefore, make sure these
406 ** values cannot refer to heap memory that was just invalidated when the
407 ** heap subsystem was shutdown. This is only done if the current call to
408 ** this function resulted in the heap subsystem actually being shutdown.
409 */
410 sqlite3_data_directory = 0;
411 sqlite3_temp_directory = 0;
412#endif
dane1ab2192009-08-17 15:16:19 +0000413 }
414 if( sqlite3GlobalConfig.isMutexInit ){
415 sqlite3MutexEnd();
416 sqlite3GlobalConfig.isMutexInit = 0;
417 }
418
drh40257ff2008-06-13 18:24:27 +0000419 return SQLITE_OK;
420}
421
422/*
423** This API allows applications to modify the global configuration of
424** the SQLite library at run-time.
425**
426** This routine should only be called when there are no outstanding
427** database connections or memory allocations. This routine is not
428** threadsafe. Failure to heed these warnings can lead to unpredictable
429** behavior.
430*/
431int sqlite3_config(int op, ...){
432 va_list ap;
433 int rc = SQLITE_OK;
434
435 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
436 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000437 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000438
439 va_start(ap, op);
440 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000441
442 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000443 ** compile.
drh18472fa2008-10-07 15:25:48 +0000444 */
drhd1dcb232014-11-01 18:32:18 +0000445#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000446 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000447 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
448 ** Single-thread. */
449 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
450 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000451 break;
452 }
drhd1dcb232014-11-01 18:32:18 +0000453#endif
454#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000455 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000456 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
457 ** Multi-thread. */
458 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
459 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000460 break;
461 }
drhd1dcb232014-11-01 18:32:18 +0000462#endif
463#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000464 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000465 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
466 ** Serialized. */
467 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
468 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000469 break;
470 }
drhd1dcb232014-11-01 18:32:18 +0000471#endif
472#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000473 case SQLITE_CONFIG_MUTEX: {
474 /* Specify an alternative mutex implementation */
475 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
476 break;
477 }
drhd1dcb232014-11-01 18:32:18 +0000478#endif
479#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000480 case SQLITE_CONFIG_GETMUTEX: {
481 /* Retrieve the current mutex implementation */
482 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
483 break;
484 }
485#endif
486
drh40257ff2008-06-13 18:24:27 +0000487 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000488 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
489 ** single argument which is a pointer to an instance of the
490 ** sqlite3_mem_methods structure. The argument specifies alternative
491 ** low-level memory allocation routines to be used in place of the memory
492 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000493 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000494 break;
495 }
drh33589792008-06-18 13:27:46 +0000496 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000497 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
498 ** single argument which is a pointer to an instance of the
499 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
500 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000501 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
502 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000503 break;
504 }
drhfec00ea2008-06-14 16:56:21 +0000505 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000506 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
507 ** single argument of type int, interpreted as a boolean, which enables
508 ** or disables the collection of memory allocation statistics. */
509 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000510 break;
511 }
drhb2a0f752017-08-28 15:51:35 +0000512 case SQLITE_CONFIG_SMALL_MALLOC: {
513 sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000514 break;
515 }
516 case SQLITE_CONFIG_PAGECACHE: {
drh15427272015-12-03 22:33:55 +0000517 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
518 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
519 ** the size of each page cache line (sz), and the number of cache lines
520 ** (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000521 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
522 sqlite3GlobalConfig.szPage = va_arg(ap, int);
523 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000524 break;
525 }
drhdef68892014-11-04 12:11:23 +0000526 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000527 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
528 ** a single parameter which is a pointer to an integer and writes into
529 ** that integer the number of extra bytes per page required for each page
530 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000531 *va_arg(ap, int*) =
532 sqlite3HeaderSizeBtree() +
533 sqlite3HeaderSizePcache() +
534 sqlite3HeaderSizePcache1();
535 break;
536 }
danielk19775099be52008-06-27 13:27:03 +0000537
danielk1977bc2ca9e2008-11-13 14:28:28 +0000538 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000539 /* no-op */
540 break;
541 }
542 case SQLITE_CONFIG_GETPCACHE: {
543 /* now an error */
544 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000545 break;
546 }
547
dan22e21ff2011-11-08 20:08:44 +0000548 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000549 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
550 ** single argument which is a pointer to an sqlite3_pcache_methods2
551 ** object. This object specifies the interface to a custom page cache
552 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000553 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
554 break;
555 }
556 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000557 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
558 ** single argument which is a pointer to an sqlite3_pcache_methods2
559 ** object. SQLite copies of the current page cache implementation into
560 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000561 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000562 sqlite3PCacheSetDefault();
563 }
dan22e21ff2011-11-08 20:08:44 +0000564 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000565 break;
566 }
567
drh8790b6e2014-11-07 01:43:56 +0000568/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
569** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
570** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000571#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000572 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000573 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
574 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000575 ** number of bytes in the memory buffer, and the minimum allocation size.
576 */
danielk1977075c23a2008-09-01 18:34:20 +0000577 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
578 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
579 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000580
shaneha6ec8922011-03-09 21:36:17 +0000581 if( sqlite3GlobalConfig.mnReq<1 ){
582 sqlite3GlobalConfig.mnReq = 1;
583 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
584 /* cap min request size at 2^12 */
585 sqlite3GlobalConfig.mnReq = (1<<12);
586 }
587
danielk1977075c23a2008-09-01 18:34:20 +0000588 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000589 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
590 ** is NULL, then SQLite reverts to using its default memory allocator
591 ** (the system malloc() implementation), undoing any prior invocation of
592 ** SQLITE_CONFIG_MALLOC.
593 **
594 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
595 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000596 */
danielk1977075c23a2008-09-01 18:34:20 +0000597 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000598 }else{
drh8790b6e2014-11-07 01:43:56 +0000599 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
600 ** alternative memory allocator is engaged to handle all of SQLites
601 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000602#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000603 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000604#endif
605#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000606 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000607#endif
drh8a42cbd2008-07-10 18:13:42 +0000608 }
danielk19775099be52008-06-27 13:27:03 +0000609 break;
610 }
drh5d414832008-07-15 14:47:18 +0000611#endif
danielk19775099be52008-06-27 13:27:03 +0000612
drh633e6d52008-07-28 19:34:53 +0000613 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000614 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
615 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000616 break;
617 }
drh3f280702010-02-18 18:45:09 +0000618
mistachkin037933b2013-08-13 22:33:41 +0000619 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000620 ** The default is NULL. Logging is disabled if the function pointer is
621 ** NULL.
622 */
623 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000624 /* MSVC is picky about pulling func ptrs from va lists.
625 ** http://support.microsoft.com/kb/47961
626 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
627 */
628 typedef void(*LOGFUNC_t)(void*,int,const char*);
629 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000630 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
631 break;
632 }
drh633e6d52008-07-28 19:34:53 +0000633
drh00729cb2014-10-04 11:59:33 +0000634 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
635 ** can be changed at start-time using the
636 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
637 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
638 */
dancd74b612011-04-22 19:37:32 +0000639 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000640 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
641 ** argument of type int. If non-zero, then URI handling is globally
642 ** enabled. If the parameter is zero, then URI handling is globally
643 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000644 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
645 break;
646 }
647
drhde9a7b82012-09-17 20:44:46 +0000648 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000649 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
650 ** option takes a single integer argument which is interpreted as a
651 ** boolean in order to enable or disable the use of covering indices for
652 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000653 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
654 break;
655 }
656
danac455932012-11-26 19:50:41 +0000657#ifdef SQLITE_ENABLE_SQLLOG
658 case SQLITE_CONFIG_SQLLOG: {
659 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
660 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
661 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
662 break;
663 }
664#endif
665
drh9b4c59f2013-04-15 17:03:42 +0000666 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000667 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
668 ** integer (sqlite3_int64) values that are the default mmap size limit
669 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
670 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000671 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000672 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000673 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000674 ** negative, then that argument is changed to its compile-time default.
675 **
676 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
677 ** silently truncated if necessary so that it does not exceed the
678 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
679 ** compile-time option.
680 */
drh3ba689d2015-03-03 14:00:11 +0000681 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
682 mxMmap = SQLITE_MAX_MMAP_SIZE;
683 }
drh9b4c59f2013-04-15 17:03:42 +0000684 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
685 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000686 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000687 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000688 break;
689 }
690
drh4d9f1882014-11-04 17:23:24 +0000691#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000692 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000693 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
694 ** unsigned integer value that specifies the maximum size of the created
695 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000696 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
697 break;
698 }
699#endif
700
drh3bd17912015-01-02 15:55:29 +0000701 case SQLITE_CONFIG_PMASZ: {
702 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
703 break;
704 }
705
drh8c71a982016-03-07 17:37:37 +0000706 case SQLITE_CONFIG_STMTJRNL_SPILL: {
707 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
708 break;
709 }
710
dan2e3a5a82018-04-16 21:12:42 +0000711#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbade8d2018-04-18 14:48:08 +0000712 case SQLITE_CONFIG_SORTERREF_SIZE: {
dan2e3a5a82018-04-16 21:12:42 +0000713 int iVal = va_arg(ap, int);
714 if( iVal<0 ){
715 iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
716 }
717 sqlite3GlobalConfig.szSorterRef = (u32)iVal;
dan2e3a5a82018-04-16 21:12:42 +0000718 break;
719 }
drhbbade8d2018-04-18 14:48:08 +0000720#endif /* SQLITE_ENABLE_SORTER_REFERENCES */
dan2e3a5a82018-04-16 21:12:42 +0000721
drh23a88592019-01-31 15:38:53 +0000722#ifdef SQLITE_ENABLE_DESERIALIZE
723 case SQLITE_CONFIG_MEMDB_MAXSIZE: {
724 sqlite3GlobalConfig.mxMemdbSize = va_arg(ap, sqlite3_int64);
725 break;
726 }
727#endif /* SQLITE_ENABLE_DESERIALIZE */
728
drh40257ff2008-06-13 18:24:27 +0000729 default: {
730 rc = SQLITE_ERROR;
731 break;
732 }
733 }
734 va_end(ap);
735 return rc;
736}
737
738/*
drh633e6d52008-07-28 19:34:53 +0000739** Set up the lookaside buffers for a database connection.
740** Return SQLITE_OK on success.
741** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000742**
743** The sz parameter is the number of bytes in each lookaside slot.
744** The cnt parameter is the number of slots. If pStart is NULL the
745** space for the lookaside memory is obtained from sqlite3_malloc().
746** If pStart is not NULL then it is sz*cnt bytes of memory to use for
747** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000748*/
drhe9d1c722008-08-04 20:13:26 +0000749static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000750#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000751 void *pStart;
numist115d6632019-12-12 02:50:07 +0000752 sqlite3_int64 szAlloc = sz*(sqlite3_int64)cnt;
drhe6068022019-12-13 15:48:21 +0000753 int nBig; /* Number of full-size slots */
drhcf014f62019-12-31 15:12:34 +0000754 int nSm; /* Number smaller LOOKASIDE_SMALL-byte slots */
drh52fb8e12017-08-29 20:21:12 +0000755
756 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000757 return SQLITE_BUSY;
758 }
shanef71f89e2009-01-30 06:11:54 +0000759 /* Free any existing lookaside buffer for this handle before
760 ** allocating a new one so we don't have to have space for
761 ** both at the same time.
762 */
763 if( db->lookaside.bMalloced ){
764 sqlite3_free(db->lookaside.pStart);
765 }
drh61a4bd52011-11-10 02:39:28 +0000766 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
767 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000768 */
drh61a4bd52011-11-10 02:39:28 +0000769 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000770 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000771 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000772 if( sz==0 || cnt==0 ){
773 sz = 0;
774 pStart = 0;
775 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000776 sqlite3BeginBenignMalloc();
numist115d6632019-12-12 02:50:07 +0000777 pStart = sqlite3Malloc( szAlloc ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000778 sqlite3EndBenignMalloc();
drhe6068022019-12-13 15:48:21 +0000779 if( pStart ) szAlloc = sqlite3MallocSize(pStart);
drhe9d1c722008-08-04 20:13:26 +0000780 }else{
781 pStart = pBuf;
782 }
drhcf014f62019-12-31 15:12:34 +0000783#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
784 if( sz>=LOOKASIDE_SMALL*3 ){
785 nBig = szAlloc/(3*LOOKASIDE_SMALL+sz);
786 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
787 }else if( sz>=LOOKASIDE_SMALL*2 ){
788 nBig = szAlloc/(LOOKASIDE_SMALL+sz);
789 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
drhe6068022019-12-13 15:48:21 +0000790 }else
drhcf014f62019-12-31 15:12:34 +0000791#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000792 if( sz>0 ){
793 nBig = szAlloc/sz;
794 nSm = 0;
795 }else{
796 nBig = nSm = 0;
797 }
drh4cfb22f2008-08-01 18:47:01 +0000798 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000799 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000800 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000801 db->lookaside.sz = (u16)sz;
drh31f69622019-10-05 14:39:36 +0000802 db->lookaside.szTrue = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000803 if( pStart ){
804 int i;
805 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000806 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000807 p = (LookasideSlot*)pStart;
drhe6068022019-12-13 15:48:21 +0000808 for(i=0; i<nBig; i++){
drh52fb8e12017-08-29 20:21:12 +0000809 p->pNext = db->lookaside.pInit;
810 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000811 p = (LookasideSlot*)&((u8*)p)[sz];
812 }
drhcf014f62019-12-31 15:12:34 +0000813#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
814 db->lookaside.pSmallInit = 0;
815 db->lookaside.pSmallFree = 0;
numist115d6632019-12-12 02:50:07 +0000816 db->lookaside.pMiddle = p;
drhe6068022019-12-13 15:48:21 +0000817 for(i=0; i<nSm; i++){
drhcf014f62019-12-31 15:12:34 +0000818 p->pNext = db->lookaside.pSmallInit;
819 db->lookaside.pSmallInit = p;
820 p = (LookasideSlot*)&((u8*)p)[LOOKASIDE_SMALL];
numist115d6632019-12-12 02:50:07 +0000821 }
drhcf014f62019-12-31 15:12:34 +0000822#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000823 assert( ((uptr)p)<=szAlloc + (uptr)pStart );
drh633e6d52008-07-28 19:34:53 +0000824 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000825 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000826 db->lookaside.bMalloced = pBuf==0 ?1:0;
drhe6068022019-12-13 15:48:21 +0000827 db->lookaside.nSlot = nBig+nSm;
drh4cfb22f2008-08-01 18:47:01 +0000828 }else{
drhb0e77042013-12-10 19:49:00 +0000829 db->lookaside.pStart = db;
drhcf014f62019-12-31 15:12:34 +0000830#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
831 db->lookaside.pSmallInit = 0;
832 db->lookaside.pSmallFree = 0;
drhe6068022019-12-13 15:48:21 +0000833 db->lookaside.pMiddle = db;
drhcf014f62019-12-31 15:12:34 +0000834#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhb0e77042013-12-10 19:49:00 +0000835 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000836 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +0000837 db->lookaside.sz = 0;
shanef71f89e2009-01-30 06:11:54 +0000838 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000839 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000840 }
drhe6068022019-12-13 15:48:21 +0000841 assert( sqlite3LookasideUsed(db,0)==0 );
drh7877d9a2015-07-23 17:16:27 +0000842#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000843 return SQLITE_OK;
844}
845
846/*
drh4413d0e2008-11-04 13:46:27 +0000847** Return the mutex associated with a database connection.
848*/
849sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000850#ifdef SQLITE_ENABLE_API_ARMOR
851 if( !sqlite3SafetyCheckOk(db) ){
852 (void)SQLITE_MISUSE_BKPT;
853 return 0;
854 }
855#endif
drh4413d0e2008-11-04 13:46:27 +0000856 return db->mutex;
857}
858
859/*
drh09419b42011-11-16 19:29:17 +0000860** Free up as much memory as we can from the given database
861** connection.
862*/
863int sqlite3_db_release_memory(sqlite3 *db){
864 int i;
drh9ca95732014-10-24 00:35:58 +0000865
866#ifdef SQLITE_ENABLE_API_ARMOR
867 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
868#endif
dand9bb3a92011-12-30 11:43:59 +0000869 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000870 sqlite3BtreeEnterAll(db);
871 for(i=0; i<db->nDb; i++){
872 Btree *pBt = db->aDb[i].pBt;
873 if( pBt ){
874 Pager *pPager = sqlite3BtreePager(pBt);
875 sqlite3PagerShrink(pPager);
876 }
877 }
878 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000879 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000880 return SQLITE_OK;
881}
882
883/*
dan6fa255f2015-10-28 19:46:57 +0000884** Flush any dirty pages in the pager-cache for any attached database
885** to disk.
886*/
887int sqlite3_db_cacheflush(sqlite3 *db){
888 int i;
889 int rc = SQLITE_OK;
890 int bSeenBusy = 0;
891
892#ifdef SQLITE_ENABLE_API_ARMOR
893 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
894#endif
895 sqlite3_mutex_enter(db->mutex);
896 sqlite3BtreeEnterAll(db);
897 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
898 Btree *pBt = db->aDb[i].pBt;
899 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
900 Pager *pPager = sqlite3BtreePager(pBt);
901 rc = sqlite3PagerFlush(pPager);
902 if( rc==SQLITE_BUSY ){
903 bSeenBusy = 1;
904 rc = SQLITE_OK;
905 }
906 }
907 }
dan6fa255f2015-10-28 19:46:57 +0000908 sqlite3BtreeLeaveAll(db);
909 sqlite3_mutex_leave(db->mutex);
910 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
911}
912
913/*
drh633e6d52008-07-28 19:34:53 +0000914** Configuration settings for an individual database connection
915*/
916int sqlite3_db_config(sqlite3 *db, int op, ...){
917 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000918 int rc;
drh633e6d52008-07-28 19:34:53 +0000919 va_start(ap, op);
920 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000921 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000922 /* IMP: R-06824-28531 */
923 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000924 db->aDb[0].zDbSName = va_arg(ap,char*);
925 rc = SQLITE_OK;
926 break;
927 }
drhe9d1c722008-08-04 20:13:26 +0000928 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000929 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000930 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
931 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000932 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000933 break;
934 }
drh6480aad2008-08-01 16:31:14 +0000935 default: {
drhe83cafd2011-03-21 17:15:58 +0000936 static const struct {
937 int op; /* The opcode */
938 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
939 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000940 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
941 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
drh11d88e62019-08-15 21:27:20 +0000942 { SQLITE_DBCONFIG_ENABLE_VIEW, SQLITE_EnableView },
drhd42908f2016-02-26 15:38:24 +0000943 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000944 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000945 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000946 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000947 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000948 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drha296cda2018-11-03 16:09:59 +0000949 { SQLITE_DBCONFIG_DEFENSIVE, SQLITE_Defensive },
drh346f4e22019-03-25 21:35:41 +0000950 { SQLITE_DBCONFIG_WRITABLE_SCHEMA, SQLITE_WriteSchema|
951 SQLITE_NoSchemaError },
drh0a6873b2019-06-14 21:25:25 +0000952 { SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, SQLITE_LegacyAlter },
drhd0ff6012019-06-17 13:56:11 +0000953 { SQLITE_DBCONFIG_DQS_DDL, SQLITE_DqsDDL },
954 { SQLITE_DBCONFIG_DQS_DML, SQLITE_DqsDML },
drh66c48902019-10-29 16:18:45 +0000955 { SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, SQLITE_LegacyFileFmt },
drhb77da372020-01-07 16:09:11 +0000956 { SQLITE_DBCONFIG_TRUSTED_SCHEMA, SQLITE_TrustedSchema },
drhe83cafd2011-03-21 17:15:58 +0000957 };
drh58ad5802011-03-23 22:02:23 +0000958 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000959 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000960 for(i=0; i<ArraySize(aFlagOp); i++){
961 if( aFlagOp[i].op==op ){
962 int onoff = va_arg(ap, int);
963 int *pRes = va_arg(ap, int*);
drh70d5dfb2018-12-06 16:50:55 +0000964 u64 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000965 if( onoff>0 ){
966 db->flags |= aFlagOp[i].mask;
967 }else if( onoff==0 ){
drhd5b44d62018-12-06 17:06:02 +0000968 db->flags &= ~(u64)aFlagOp[i].mask;
drhe83cafd2011-03-21 17:15:58 +0000969 }
970 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000971 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000972 }
973 if( pRes ){
974 *pRes = (db->flags & aFlagOp[i].mask)!=0;
975 }
976 rc = SQLITE_OK;
977 break;
978 }
979 }
drh6480aad2008-08-01 16:31:14 +0000980 break;
981 }
drh633e6d52008-07-28 19:34:53 +0000982 }
983 va_end(ap);
984 return rc;
985}
986
drh9b5adfa2008-01-20 23:19:56 +0000987/*
drhd3d39e92004-05-20 22:16:29 +0000988** This is the default collating function named "BINARY" which is always
989** available.
990*/
danielk19772c336542005-01-13 02:14:23 +0000991static int binCollFunc(
drh821afa42019-06-14 13:24:46 +0000992 void *NotUsed,
drhd3d39e92004-05-20 22:16:29 +0000993 int nKey1, const void *pKey1,
994 int nKey2, const void *pKey2
995){
996 int rc, n;
drh821afa42019-06-14 13:24:46 +0000997 UNUSED_PARAMETER(NotUsed);
drhd3d39e92004-05-20 22:16:29 +0000998 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000999 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
1000 ** strings byte by byte using the memcmp() function from the standard C
1001 ** library. */
dan21766c02017-05-22 08:04:09 +00001002 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +00001003 rc = memcmp(pKey1, pKey2, n);
1004 if( rc==0 ){
drh821afa42019-06-14 13:24:46 +00001005 rc = nKey1 - nKey2;
drhd3d39e92004-05-20 22:16:29 +00001006 }
1007 return rc;
1008}
1009
1010/*
drh821afa42019-06-14 13:24:46 +00001011** This is the collating function named "RTRIM" which is always
1012** available. Ignore trailing spaces.
1013*/
1014static int rtrimCollFunc(
1015 void *pUser,
1016 int nKey1, const void *pKey1,
1017 int nKey2, const void *pKey2
1018){
1019 const u8 *pK1 = (const u8*)pKey1;
1020 const u8 *pK2 = (const u8*)pKey2;
1021 while( nKey1 && pK1[nKey1-1]==' ' ) nKey1--;
1022 while( nKey2 && pK2[nKey2-1]==' ' ) nKey2--;
1023 return binCollFunc(pUser, nKey1, pKey1, nKey2, pKey2);
1024}
1025
1026/*
drhbcd15932018-07-27 18:12:40 +00001027** Return true if CollSeq is the default built-in BINARY.
1028*/
1029int sqlite3IsBinary(const CollSeq *p){
drh821afa42019-06-14 13:24:46 +00001030 assert( p==0 || p->xCmp!=binCollFunc || strcmp(p->zName,"BINARY")==0 );
1031 return p==0 || p->xCmp==binCollFunc;
drhbcd15932018-07-27 18:12:40 +00001032}
1033
1034/*
danielk1977dc1bdc42004-06-11 10:51:27 +00001035** Another built-in collating sequence: NOCASE.
1036**
drhf7b54962013-05-28 12:11:54 +00001037** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +00001038** comparison". SQLite's knowledge of upper and lower case equivalents
1039** extends only to the 26 characters used in the English language.
1040**
1041** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +00001042*/
1043static int nocaseCollatingFunc(
1044 void *NotUsed,
1045 int nKey1, const void *pKey1,
1046 int nKey2, const void *pKey2
1047){
1048 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +00001049 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +00001050 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +00001051 if( 0==r ){
1052 r = nKey1-nKey2;
1053 }
1054 return r;
1055}
1056
1057/*
drhaf9ff332002-01-16 21:00:27 +00001058** Return the ROWID of the most recent insert
1059*/
drh9bb575f2004-09-06 17:24:11 +00001060sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001061#ifdef SQLITE_ENABLE_API_ARMOR
1062 if( !sqlite3SafetyCheckOk(db) ){
1063 (void)SQLITE_MISUSE_BKPT;
1064 return 0;
1065 }
1066#endif
drhaf9ff332002-01-16 21:00:27 +00001067 return db->lastRowid;
1068}
1069
1070/*
dan9c58b632017-02-27 14:52:48 +00001071** Set the value returned by the sqlite3_last_insert_rowid() API function.
1072*/
1073void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
1074#ifdef SQLITE_ENABLE_API_ARMOR
1075 if( !sqlite3SafetyCheckOk(db) ){
1076 (void)SQLITE_MISUSE_BKPT;
1077 return;
1078 }
1079#endif
1080 sqlite3_mutex_enter(db->mutex);
1081 db->lastRowid = iRowid;
1082 sqlite3_mutex_leave(db->mutex);
1083}
1084
1085/*
danielk197724b03fd2004-05-10 10:34:34 +00001086** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +00001087*/
drh9bb575f2004-09-06 17:24:11 +00001088int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001089#ifdef SQLITE_ENABLE_API_ARMOR
1090 if( !sqlite3SafetyCheckOk(db) ){
1091 (void)SQLITE_MISUSE_BKPT;
1092 return 0;
1093 }
1094#endif
drhc8d30ac2002-04-12 10:08:59 +00001095 return db->nChange;
1096}
1097
rdcf146a772004-02-25 22:51:06 +00001098/*
danielk1977b28af712004-06-21 06:50:26 +00001099** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +00001100*/
danielk1977b28af712004-06-21 06:50:26 +00001101int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001102#ifdef SQLITE_ENABLE_API_ARMOR
1103 if( !sqlite3SafetyCheckOk(db) ){
1104 (void)SQLITE_MISUSE_BKPT;
1105 return 0;
1106 }
1107#endif
danielk1977b28af712004-06-21 06:50:26 +00001108 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +00001109}
1110
drhc8d30ac2002-04-12 10:08:59 +00001111/*
danielk1977fd7f0452008-12-17 17:30:26 +00001112** Close all open savepoints. This function only manipulates fields of the
1113** database handle object, it does not close any savepoints that may be open
1114** at the b-tree/pager level.
1115*/
1116void sqlite3CloseSavepoints(sqlite3 *db){
1117 while( db->pSavepoint ){
1118 Savepoint *pTmp = db->pSavepoint;
1119 db->pSavepoint = pTmp->pNext;
1120 sqlite3DbFree(db, pTmp);
1121 }
1122 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001123 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001124 db->isTransactionSavepoint = 0;
1125}
1126
1127/*
dand2199f02010-08-27 17:48:52 +00001128** Invoke the destructor function associated with FuncDef p, if any. Except,
1129** if this is not the last copy of the function, do not invoke it. Multiple
1130** copies of a single function are created when create_function() is called
1131** with SQLITE_ANY as the encoding.
1132*/
1133static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001134 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001135 if( pDestructor ){
1136 pDestructor->nRef--;
1137 if( pDestructor->nRef==0 ){
1138 pDestructor->xDestroy(pDestructor->pUserData);
1139 sqlite3DbFree(db, pDestructor);
1140 }
1141 }
1142}
1143
1144/*
danbba02a92012-05-15 17:15:34 +00001145** Disconnect all sqlite3_vtab objects that belong to database connection
1146** db. This is called when db is being closed.
1147*/
1148static void disconnectAllVtab(sqlite3 *db){
1149#ifndef SQLITE_OMIT_VIRTUALTABLE
1150 int i;
drh51be3872015-08-19 02:32:25 +00001151 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001152 sqlite3BtreeEnterAll(db);
1153 for(i=0; i<db->nDb; i++){
1154 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001155 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001156 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1157 Table *pTab = (Table *)sqliteHashData(p);
1158 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1159 }
1160 }
1161 }
drh51be3872015-08-19 02:32:25 +00001162 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1163 Module *pMod = (Module *)sqliteHashData(p);
1164 if( pMod->pEpoTab ){
1165 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1166 }
1167 }
dand88e5212014-03-12 19:38:38 +00001168 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001169 sqlite3BtreeLeaveAll(db);
1170#else
1171 UNUSED_PARAMETER(db);
1172#endif
1173}
1174
1175/*
drh167cd6a2012-06-02 17:09:46 +00001176** Return TRUE if database connection db has unfinalized prepared
1177** statements or unfinished sqlite3_backup objects.
1178*/
1179static int connectionIsBusy(sqlite3 *db){
1180 int j;
1181 assert( sqlite3_mutex_held(db->mutex) );
1182 if( db->pVdbe ) return 1;
1183 for(j=0; j<db->nDb; j++){
1184 Btree *pBt = db->aDb[j].pBt;
1185 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1186 }
1187 return 0;
1188}
1189
1190/*
drh50e5dad2001-09-15 00:57:28 +00001191** Close an existing SQLite database
1192*/
drh167cd6a2012-06-02 17:09:46 +00001193static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001194 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001195 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1196 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001197 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001198 }
drh7e8b8482008-01-23 03:03:05 +00001199 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001200 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001201 }
drh605264d2007-08-21 15:13:19 +00001202 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001203 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1204 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1205 }
danielk1977e35ee192004-06-26 09:50:11 +00001206
danbba02a92012-05-15 17:15:34 +00001207 /* Force xDisconnect calls on all virtual tables */
1208 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001209
danbba02a92012-05-15 17:15:34 +00001210 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001211 ** will not have called the xDisconnect() method on any virtual
1212 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1213 ** call will do so. We need to do this before the check for active
1214 ** SQL statements below, as the v-table implementation may be storing
1215 ** some prepared statements internally.
1216 */
dan67430812013-05-15 10:21:50 +00001217 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001218
drh167cd6a2012-06-02 17:09:46 +00001219 /* Legacy behavior (sqlite3_close() behavior) is to return
1220 ** SQLITE_BUSY if the connection can not be closed immediately.
1221 */
1222 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001223 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001224 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001225 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001226 return SQLITE_BUSY;
1227 }
danielk1977e0048402004-06-15 16:51:01 +00001228
danac455932012-11-26 19:50:41 +00001229#ifdef SQLITE_ENABLE_SQLLOG
1230 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001231 /* Closing the handle. Fourth parameter is passed the value 2. */
1232 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001233 }
1234#endif
1235
drh167cd6a2012-06-02 17:09:46 +00001236 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001237 */
1238 db->magic = SQLITE_MAGIC_ZOMBIE;
1239 sqlite3LeaveMutexAndCloseZombie(db);
1240 return SQLITE_OK;
1241}
drh94e92032003-02-16 22:21:32 +00001242
drh167cd6a2012-06-02 17:09:46 +00001243/*
1244** Two variations on the public interface for closing a database
1245** connection. The sqlite3_close() version returns SQLITE_BUSY and
1246** leaves the connection option if there are unfinalized prepared
1247** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1248** version forces the connection to become a zombie if there are
1249** unclosed resources, and arranges for deallocation when the last
1250** prepare statement or sqlite3_backup closes.
1251*/
1252int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1253int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1254
drh4245c402012-06-02 14:32:21 +00001255
1256/*
1257** Close the mutex on database connection db.
1258**
1259** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001260** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1261** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1262** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001263*/
1264void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1265 HashElem *i; /* Hash table iterator */
1266 int j;
1267
drh4245c402012-06-02 14:32:21 +00001268 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001269 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1270 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001271 */
drh167cd6a2012-06-02 17:09:46 +00001272 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001273 sqlite3_mutex_leave(db->mutex);
1274 return;
danielk197704103022009-02-03 16:51:24 +00001275 }
1276
drh4245c402012-06-02 14:32:21 +00001277 /* If we reach this point, it means that the database connection has
1278 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001279 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001280 ** go ahead and free all resources.
1281 */
1282
dan617dc862013-05-16 11:57:28 +00001283 /* If a transaction is open, roll it back. This also ensures that if
1284 ** any database schemas have been modified by an uncommitted transaction
1285 ** they are reset. And that the required b-tree mutex is held to make
1286 ** the pager rollback and schema reset an atomic operation. */
1287 sqlite3RollbackAll(db, SQLITE_OK);
1288
danielk1977fd7f0452008-12-17 17:30:26 +00001289 /* Free any outstanding Savepoint structures. */
1290 sqlite3CloseSavepoints(db);
1291
drh5efb3142012-05-16 01:24:34 +00001292 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001293 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001294 struct Db *pDb = &db->aDb[j];
1295 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001296 sqlite3BtreeClose(pDb->pBt);
1297 pDb->pBt = 0;
1298 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001299 pDb->pSchema = 0;
1300 }
drh113088e2003-03-20 01:16:58 +00001301 }
drhf57b3392001-10-08 13:22:32 +00001302 }
drh5efb3142012-05-16 01:24:34 +00001303 /* Clear the TEMP schema separately and last */
1304 if( db->aDb[1].pSchema ){
1305 sqlite3SchemaClear(db->aDb[1].pSchema);
1306 }
1307 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001308
drh5efb3142012-05-16 01:24:34 +00001309 /* Free up the array of auxiliary databases */
1310 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001311 assert( db->nDb<=2 );
1312 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001313
1314 /* Tell the code in notify.c that the connection no longer holds any
1315 ** locks and does not require any further unlock-notify callbacks.
1316 */
1317 sqlite3ConnectionClosed(db);
1318
drh80738d92016-02-15 00:34:16 +00001319 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1320 FuncDef *pNext, *p;
1321 p = sqliteHashData(i);
1322 do{
1323 functionDestroy(db, p);
1324 pNext = p->pNext;
1325 sqlite3DbFree(db, p);
1326 p = pNext;
1327 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001328 }
drh80738d92016-02-15 00:34:16 +00001329 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001330 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001331 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001332 /* Invoke any destructors registered for collation sequence user data. */
1333 for(j=0; j<3; j++){
1334 if( pColl[j].xDel ){
1335 pColl[j].xDel(pColl[j].pUser);
1336 }
1337 }
drh633e6d52008-07-28 19:34:53 +00001338 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001339 }
danielk1977d8123362004-06-12 09:25:12 +00001340 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001341#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001342 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1343 Module *pMod = (Module *)sqliteHashData(i);
drh51be3872015-08-19 02:32:25 +00001344 sqlite3VtabEponymousTableClear(db, pMod);
drhcc5979d2019-08-16 22:58:29 +00001345 sqlite3VtabModuleUnref(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001346 }
drhb9bb7c12006-06-11 23:41:55 +00001347 sqlite3HashClear(&db->aModule);
1348#endif
danielk1977466be562004-06-10 02:16:01 +00001349
drh13f40da2014-08-22 18:00:11 +00001350 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001351 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001352 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001353#if SQLITE_USER_AUTHENTICATION
1354 sqlite3_free(db->auth.zAuthUser);
1355 sqlite3_free(db->auth.zAuthPW);
1356#endif
danielk197796d81f92004-06-19 03:33:57 +00001357
1358 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001359
1360 /* The temp-database schema is allocated differently from the other schema
1361 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1362 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1363 ** the same sqliteMalloc() as the one that allocates the database
1364 ** structure?
1365 */
drh633e6d52008-07-28 19:34:53 +00001366 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001367 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001368 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001369 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001370 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001371 if( db->lookaside.bMalloced ){
1372 sqlite3_free(db->lookaside.pStart);
1373 }
drh17435752007-08-16 04:30:38 +00001374 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001375}
1376
1377/*
drh0f198a72012-02-13 16:43:16 +00001378** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001379** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001380** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001381** attempts to use that cursor. Read cursors remain open and valid
1382** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001383*/
drh0f198a72012-02-13 16:43:16 +00001384void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001385 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001386 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001387 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001388 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001389 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001390
1391 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1392 ** This is important in case the transaction being rolled back has
1393 ** modified the database schema. If the b-tree mutexes are not taken
1394 ** here, then another shared-cache connection might sneak in between
1395 ** the database rollback and schema reset, which can cause false
1396 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001397 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001398 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001399
drh001bbcb2003-03-19 03:14:00 +00001400 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001401 Btree *p = db->aDb[i].pBt;
1402 if( p ){
1403 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001404 inTrans = 1;
1405 }
drh47b7fc72014-11-11 01:33:57 +00001406 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001407 }
1408 }
danielk1977a298e902006-06-22 09:53:48 +00001409 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001410 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001411
drh7f32dc92018-07-16 11:32:59 +00001412 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001413 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001414 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001415 }
dancd7b91a2013-05-13 18:23:15 +00001416 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001417
dan1da40a32009-09-19 17:00:31 +00001418 /* Any deferred constraint violations have now been resolved. */
1419 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001420 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00001421 db->flags &= ~(u64)SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001422
danielk197771fd80b2005-12-16 06:54:01 +00001423 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001424 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001425 db->xRollbackCallback(db->pRollbackArg);
1426 }
drh001bbcb2003-03-19 03:14:00 +00001427}
1428
1429/*
mistachkinf2c1c992013-04-28 01:44:43 +00001430** Return a static string containing the name corresponding to the error code
1431** specified in the argument.
1432*/
mistachkin5824d442015-04-28 23:34:10 +00001433#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001434const char *sqlite3ErrName(int rc){
1435 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001436 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001437 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1438 switch( rc ){
1439 case SQLITE_OK: zName = "SQLITE_OK"; break;
1440 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001441 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001442 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1443 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1444 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001445 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001446 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001447 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001448 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001449 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1450 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1451 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1452 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001453 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001454 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001455 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001456 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001457 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001458 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1459 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001460 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1461 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1462 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1463 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1464 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1465 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1466 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1467 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1468 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1469 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001470 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1471 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1472 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1473 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1474 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1475 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1476 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1477 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1478 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1479 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1480 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1481 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1482 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1483 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001484 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001485 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001486 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001487 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001488 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1489 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1490 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001491 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1492 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1493 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001494 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkin3c161e02019-11-18 23:48:03 +00001495 case SQLITE_CANTOPEN_SYMLINK: zName = "SQLITE_CANTOPEN_SYMLINK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001496 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1497 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1498 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1499 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1500 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1501 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1502 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1503 case SQLITE_CONSTRAINT_FOREIGNKEY:
1504 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1505 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1506 case SQLITE_CONSTRAINT_PRIMARYKEY:
1507 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1508 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1509 case SQLITE_CONSTRAINT_COMMITHOOK:
1510 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1511 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1512 case SQLITE_CONSTRAINT_FUNCTION:
1513 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001514 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001515 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1516 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1517 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1518 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1519 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1520 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1521 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1522 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1523 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001524 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1525 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1526 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001527 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001528 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001529 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001530 }
1531 }
mistachkin10269dc2013-04-30 07:54:42 +00001532 if( zName==0 ){
1533 static char zBuf[50];
1534 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1535 zName = zBuf;
1536 }
mistachkinf2c1c992013-04-28 01:44:43 +00001537 return zName;
1538}
mistachkin10269dc2013-04-30 07:54:42 +00001539#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001540
1541/*
drhc22bd472002-05-10 13:14:07 +00001542** Return a static string that describes the kind of error specified in the
1543** argument.
drh247be432002-05-10 05:44:55 +00001544*/
danielk1977f20b21c2004-05-31 23:56:42 +00001545const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001546 static const char* const aMsg[] = {
1547 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001548 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001549 /* SQLITE_INTERNAL */ 0,
1550 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001551 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001552 /* SQLITE_BUSY */ "database is locked",
1553 /* SQLITE_LOCKED */ "database table is locked",
1554 /* SQLITE_NOMEM */ "out of memory",
1555 /* SQLITE_READONLY */ "attempt to write a readonly database",
1556 /* SQLITE_INTERRUPT */ "interrupted",
1557 /* SQLITE_IOERR */ "disk I/O error",
1558 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001559 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001560 /* SQLITE_FULL */ "database or disk is full",
1561 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001562 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001563 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001564 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001565 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001566 /* SQLITE_CONSTRAINT */ "constraint failed",
1567 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001568 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001569#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001570 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001571#else
1572 /* SQLITE_NOLFS */ 0,
1573#endif
drh51c7d862009-04-27 18:46:06 +00001574 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001575 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001576 /* SQLITE_RANGE */ "column index out of range",
1577 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001578 /* SQLITE_NOTICE */ "notification message",
1579 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001580 };
drh21021a52012-02-13 17:01:51 +00001581 const char *zErr = "unknown error";
1582 switch( rc ){
1583 case SQLITE_ABORT_ROLLBACK: {
1584 zErr = "abort due to ROLLBACK";
1585 break;
1586 }
mistachkin2a861102018-02-08 01:00:11 +00001587 case SQLITE_ROW: {
1588 zErr = "another row available";
1589 break;
1590 }
1591 case SQLITE_DONE: {
1592 zErr = "no more rows available";
1593 break;
1594 }
drh21021a52012-02-13 17:01:51 +00001595 default: {
1596 rc &= 0xff;
1597 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1598 zErr = aMsg[rc];
1599 }
1600 break;
1601 }
drh247be432002-05-10 05:44:55 +00001602 }
drh21021a52012-02-13 17:01:51 +00001603 return zErr;
drh247be432002-05-10 05:44:55 +00001604}
1605
1606/*
drh2dfbbca2000-07-28 14:32:48 +00001607** This routine implements a busy callback that sleeps and tries
1608** again until a timeout value is reached. The timeout value is
1609** an integer number of milliseconds passed in as the first
1610** argument.
drhf0119b22018-03-26 17:40:53 +00001611**
1612** Return non-zero to retry the lock. Return zero to stop trying
1613** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001614*/
drhdaffd0e2001-04-11 14:28:42 +00001615static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001616 void *ptr, /* Database connection */
1617 int count, /* Number of times table has been busy */
1618 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001619){
drh0ede9eb2015-01-10 16:49:23 +00001620#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001621 /* This case is for systems that have support for sleeping for fractions of
1622 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001623 static const u8 delays[] =
1624 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1625 static const u8 totals[] =
1626 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001627# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001628 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001629 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001630 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001631
drhf0119b22018-03-26 17:40:53 +00001632#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1633 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1634 if( count ){
dan97ccc1b2020-03-27 17:23:17 +00001635 /* If this is the second or later invocation of the busy-handler,
1636 ** but tmout==0, then code in wal.c must have disabled the blocking
1637 ** lock before the SQLITE_BUSY error was hit. In this case, no delay
1638 ** occurred while waiting for the lock, so fall through to the xSleep()
1639 ** code below to delay a while before retrying the lock.
1640 **
1641 ** Alternatively, if tmout!=0, then SQLite has already waited
1642 ** sqlite3.busyTimeout ms for a lock. In this case, return 0 to
1643 ** indicate that the lock should not be retried and the SQLITE_BUSY
1644 ** error returned to the application. */
1645 if( tmout ){
1646 tmout = 0;
1647 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1648 return 0;
1649 }
drhf0119b22018-03-26 17:40:53 +00001650 }else{
1651 return 1;
1652 }
1653 }
drh5013c4b2018-03-28 21:45:03 +00001654#else
1655 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001656#endif
drhee570fa2005-04-28 12:06:05 +00001657 assert( count>=0 );
1658 if( count < NDELAY ){
1659 delay = delays[count];
1660 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001661 }else{
1662 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001663 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001664 }
drhf0119b22018-03-26 17:40:53 +00001665 if( prior + delay > tmout ){
1666 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001667 if( delay<=0 ) return 0;
1668 }
danielk19772a6bdf62007-08-20 16:07:00 +00001669 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001670 return 1;
1671#else
drhf0119b22018-03-26 17:40:53 +00001672 /* This case for unix systems that lack usleep() support. Sleeping
1673 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001674 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001675 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001676 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001677 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001678 return 0;
1679 }
drh482ea182007-08-20 11:12:40 +00001680 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001681 return 1;
1682#endif
1683}
1684
1685/*
drha4afb652005-07-09 02:16:02 +00001686** Invoke the given busy handler.
1687**
drhf0119b22018-03-26 17:40:53 +00001688** This routine is called when an operation failed to acquire a
1689** lock on VFS file pFile.
1690**
drha4afb652005-07-09 02:16:02 +00001691** If this routine returns non-zero, the lock is retried. If it
1692** returns 0, the operation aborts with an SQLITE_BUSY error.
1693*/
drhf0119b22018-03-26 17:40:53 +00001694int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001695 int rc;
drh80262892018-03-26 16:37:53 +00001696 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001697 if( p->bExtraFileArg ){
1698 /* Add an extra parameter with the pFile pointer to the end of the
1699 ** callback argument list */
1700 int (*xTra)(void*,int,sqlite3_file*);
1701 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1702 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1703 }else{
1704 /* Legacy style busy handler callback */
1705 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1706 }
drha4afb652005-07-09 02:16:02 +00001707 if( rc==0 ){
1708 p->nBusy = -1;
1709 }else{
1710 p->nBusy++;
1711 }
1712 return rc;
1713}
1714
1715/*
drh2dfbbca2000-07-28 14:32:48 +00001716** This routine sets the busy callback for an Sqlite database to the
1717** given callback function with the given argument.
1718*/
danielk1977f9d64d22004-06-19 08:18:07 +00001719int sqlite3_busy_handler(
1720 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001721 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001722 void *pArg
1723){
drh9ca95732014-10-24 00:35:58 +00001724#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001725 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001726#endif
drhe30f4422007-08-21 16:15:55 +00001727 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001728 db->busyHandler.xBusyHandler = xBusy;
1729 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001730 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001731 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001732 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001733 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001734 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001735}
1736
danielk1977348bb5d2003-10-18 09:37:26 +00001737#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1738/*
1739** This routine sets the progress callback for an Sqlite database to the
1740** given callback function with the given argument. The progress callback will
1741** be invoked every nOps opcodes.
1742*/
danielk197724b03fd2004-05-10 10:34:34 +00001743void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001744 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001745 int nOps,
1746 int (*xProgress)(void*),
1747 void *pArg
1748){
drh9ca95732014-10-24 00:35:58 +00001749#ifdef SQLITE_ENABLE_API_ARMOR
1750 if( !sqlite3SafetyCheckOk(db) ){
1751 (void)SQLITE_MISUSE_BKPT;
1752 return;
1753 }
1754#endif
drhbd0b1b52008-07-07 19:52:09 +00001755 sqlite3_mutex_enter(db->mutex);
1756 if( nOps>0 ){
1757 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001758 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001759 db->pProgressArg = pArg;
1760 }else{
1761 db->xProgress = 0;
1762 db->nProgressOps = 0;
1763 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001764 }
drhbd0b1b52008-07-07 19:52:09 +00001765 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001766}
1767#endif
1768
1769
drh2dfbbca2000-07-28 14:32:48 +00001770/*
1771** This routine installs a default busy handler that waits for the
1772** specified number of milliseconds before returning 0.
1773*/
danielk1977f9d64d22004-06-19 08:18:07 +00001774int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001775#ifdef SQLITE_ENABLE_API_ARMOR
1776 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1777#endif
drh2dfbbca2000-07-28 14:32:48 +00001778 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001779 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1780 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001781 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001782 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001783 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001784 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001785 }
danielk1977f9d64d22004-06-19 08:18:07 +00001786 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001787}
drh4c504392000-10-16 22:06:40 +00001788
1789/*
1790** Cause any pending operation to stop at its earliest opportunity.
1791*/
drh9bb575f2004-09-06 17:24:11 +00001792void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001793#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001794 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001795 (void)SQLITE_MISUSE_BKPT;
1796 return;
1797 }
1798#endif
dan892edb62020-03-30 13:35:05 +00001799 AtomicStore(&db->u1.isInterrupted, 1);
drh4c504392000-10-16 22:06:40 +00001800}
drhfa86c412002-02-02 15:01:15 +00001801
drhfa86c412002-02-02 15:01:15 +00001802
1803/*
danielk1977771151b2006-01-17 13:21:40 +00001804** This function is exactly the same as sqlite3_create_function(), except
1805** that it is designed to be called by internal code. The difference is
1806** that if a malloc() fails in sqlite3_create_function(), an error code
1807** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001808*/
danielk1977771151b2006-01-17 13:21:40 +00001809int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001810 sqlite3 *db,
1811 const char *zFunctionName,
1812 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001813 int enc,
danielk197765904932004-05-26 06:18:37 +00001814 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001815 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001816 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001817 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001818 void (*xValue)(sqlite3_context*),
1819 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001820 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001821){
drh0bce8352002-02-28 00:41:10 +00001822 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001823 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001824 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001825
drhe30f4422007-08-21 16:15:55 +00001826 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001827 assert( xValue==0 || xSFunc==0 );
1828 if( zFunctionName==0 /* Must have a valid name */
1829 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1830 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1831 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1832 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1833 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1834 ){
drh413c3d32010-02-23 20:11:56 +00001835 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001836 }
drh4a8ee3d2013-12-14 13:44:22 +00001837
1838 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001839 assert( SQLITE_FUNC_DIRECT==SQLITE_DIRECTONLY );
drhc4ad8492020-01-03 20:57:38 +00001840 extraFlags = enc & (SQLITE_DETERMINISTIC|SQLITE_DIRECTONLY|
1841 SQLITE_SUBTYPE|SQLITE_INNOCUOUS);
drh4a8ee3d2013-12-14 13:44:22 +00001842 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
drh4be621e2020-01-03 21:57:53 +00001843
1844 /* The SQLITE_INNOCUOUS flag is the same bit as SQLITE_FUNC_UNSAFE. But
1845 ** the meaning is inverted. So flip the bit. */
1846 assert( SQLITE_FUNC_UNSAFE==SQLITE_INNOCUOUS );
1847 extraFlags ^= SQLITE_FUNC_UNSAFE;
1848
danielk1977d8123362004-06-12 09:25:12 +00001849
danielk197793758c82005-01-21 08:13:14 +00001850#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001851 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1852 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1853 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1854 **
1855 ** If SQLITE_ANY is specified, add three versions of the function
1856 ** to the hash table.
1857 */
1858 if( enc==SQLITE_UTF16 ){
1859 enc = SQLITE_UTF16NATIVE;
1860 }else if( enc==SQLITE_ANY ){
1861 int rc;
drh79d5bc82020-01-04 01:43:02 +00001862 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1863 (SQLITE_UTF8|extraFlags)^SQLITE_FUNC_UNSAFE,
dan660af932018-06-18 16:55:22 +00001864 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001865 if( rc==SQLITE_OK ){
drh79d5bc82020-01-04 01:43:02 +00001866 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1867 (SQLITE_UTF16LE|extraFlags)^SQLITE_FUNC_UNSAFE,
1868 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001869 }
1870 if( rc!=SQLITE_OK ){
1871 return rc;
1872 }
danielk1977d8123362004-06-12 09:25:12 +00001873 enc = SQLITE_UTF16BE;
1874 }
danielk197793758c82005-01-21 08:13:14 +00001875#else
1876 enc = SQLITE_UTF8;
1877#endif
danielk19779636c4e2005-01-25 04:27:54 +00001878
1879 /* Check if an existing function is being overridden or deleted. If so,
1880 ** and there are active VMs, then return SQLITE_BUSY. If a function
1881 ** is being overridden/deleted but there are no active VMs, allow the
1882 ** operation to continue but invalidate all precompiled statements.
1883 */
drh80738d92016-02-15 00:34:16 +00001884 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001885 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001886 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001887 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001888 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001889 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001890 return SQLITE_BUSY;
1891 }else{
drhba968db2018-07-24 22:02:12 +00001892 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001893 }
1894 }
danielk197765904932004-05-26 06:18:37 +00001895
drh80738d92016-02-15 00:34:16 +00001896 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001897 assert(p || db->mallocFailed);
1898 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001899 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001900 }
dand2199f02010-08-27 17:48:52 +00001901
1902 /* If an older version of the function with a configured destructor is
1903 ** being replaced invoke the destructor function here. */
1904 functionDestroy(db, p);
1905
1906 if( pDestructor ){
1907 pDestructor->nRef++;
1908 }
drh80738d92016-02-15 00:34:16 +00001909 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001910 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1911 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001912 testcase( p->funcFlags & SQLITE_DIRECTONLY );
drh2d801512016-01-14 22:19:58 +00001913 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001914 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001915 p->xValue = xValue;
1916 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001917 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001918 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001919 return SQLITE_OK;
1920}
danielk1977771151b2006-01-17 13:21:40 +00001921
1922/*
dan660af932018-06-18 16:55:22 +00001923** Worker function used by utf-8 APIs that create new functions:
1924**
1925** sqlite3_create_function()
1926** sqlite3_create_function_v2()
1927** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001928*/
dan660af932018-06-18 16:55:22 +00001929static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001930 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001931 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001932 int nArg,
1933 int enc,
1934 void *p,
dan660af932018-06-18 16:55:22 +00001935 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1936 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001937 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001938 void (*xValue)(sqlite3_context*),
1939 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1940 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001941){
shanehbd2aaf92010-09-01 02:38:21 +00001942 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001943 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001944
1945#ifdef SQLITE_ENABLE_API_ARMOR
1946 if( !sqlite3SafetyCheckOk(db) ){
1947 return SQLITE_MISUSE_BKPT;
1948 }
1949#endif
dand2199f02010-08-27 17:48:52 +00001950 sqlite3_mutex_enter(db->mutex);
1951 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001952 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001953 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001954 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001955 xDestroy(p);
1956 goto out;
1957 }
drh92011842018-05-26 16:00:26 +00001958 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001959 pArg->xDestroy = xDestroy;
1960 pArg->pUserData = p;
1961 }
dan660af932018-06-18 16:55:22 +00001962 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1963 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1964 );
dand2199f02010-08-27 17:48:52 +00001965 if( pArg && pArg->nRef==0 ){
1966 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001967 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001968 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001969 }
1970
1971 out:
drhe30f4422007-08-21 16:15:55 +00001972 rc = sqlite3ApiExit(db, rc);
1973 sqlite3_mutex_leave(db->mutex);
1974 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001975}
1976
dan660af932018-06-18 16:55:22 +00001977/*
1978** Create new user functions.
1979*/
1980int sqlite3_create_function(
1981 sqlite3 *db,
1982 const char *zFunc,
1983 int nArg,
1984 int enc,
1985 void *p,
1986 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1987 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1988 void (*xFinal)(sqlite3_context*)
1989){
1990 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1991 xFinal, 0, 0, 0);
1992}
1993int sqlite3_create_function_v2(
1994 sqlite3 *db,
1995 const char *zFunc,
1996 int nArg,
1997 int enc,
1998 void *p,
1999 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
2000 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
2001 void (*xFinal)(sqlite3_context*),
2002 void (*xDestroy)(void *)
2003){
2004 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
2005 xFinal, 0, 0, xDestroy);
2006}
2007int sqlite3_create_window_function(
2008 sqlite3 *db,
2009 const char *zFunc,
2010 int nArg,
2011 int enc,
2012 void *p,
2013 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
2014 void (*xFinal)(sqlite3_context*),
2015 void (*xValue)(sqlite3_context*),
2016 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
2017 void (*xDestroy)(void *)
2018){
2019 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
2020 xFinal, xValue, xInverse, xDestroy);
2021}
2022
danielk197793758c82005-01-21 08:13:14 +00002023#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00002024int sqlite3_create_function16(
2025 sqlite3 *db,
2026 const void *zFunctionName,
2027 int nArg,
2028 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00002029 void *p,
drh2d801512016-01-14 22:19:58 +00002030 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00002031 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
2032 void (*xFinal)(sqlite3_context*)
2033){
2034 int rc;
drhaf9a7c22005-12-15 03:04:10 +00002035 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00002036
2037#ifdef SQLITE_ENABLE_API_ARMOR
2038 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
2039#endif
drhe30f4422007-08-21 16:15:55 +00002040 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002041 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002042 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00002043 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00002044 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00002045 rc = sqlite3ApiExit(db, rc);
2046 sqlite3_mutex_leave(db->mutex);
2047 return rc;
drh8e0a2f92002-02-23 23:45:45 +00002048}
danielk197793758c82005-01-21 08:13:14 +00002049#endif
drhc9b84a12002-06-20 11:36:48 +00002050
drhb7481e72006-09-16 21:45:14 +00002051
2052/*
drh92011842018-05-26 16:00:26 +00002053** The following is the implementation of an SQL function that always
2054** fails with an error message stating that the function is used in the
2055** wrong context. The sqlite3_overload_function() API might construct
2056** SQL function that use this routine so that the functions will exist
2057** for name resolution but are actually overloaded by the xFindFunction
2058** method of virtual tables.
2059*/
2060static void sqlite3InvalidFunction(
2061 sqlite3_context *context, /* The function calling context */
2062 int NotUsed, /* Number of arguments to the function */
2063 sqlite3_value **NotUsed2 /* Value of each argument */
2064){
2065 const char *zName = (const char*)sqlite3_user_data(context);
2066 char *zErr;
2067 UNUSED_PARAMETER2(NotUsed, NotUsed2);
2068 zErr = sqlite3_mprintf(
2069 "unable to use function %s in the requested context", zName);
2070 sqlite3_result_error(context, zErr, -1);
2071 sqlite3_free(zErr);
2072}
2073
2074/*
drhb7481e72006-09-16 21:45:14 +00002075** Declare that a function has been overloaded by a virtual table.
2076**
2077** If the function already exists as a regular global function, then
2078** this routine is a no-op. If the function does not exist, then create
2079** a new one that always throws a run-time error.
2080**
2081** When virtual tables intend to provide an overloaded function, they
2082** should call this routine to make sure the global function exists.
2083** A global function must exist in order for name resolution to work
2084** properly.
2085*/
2086int sqlite3_overload_function(
2087 sqlite3 *db,
2088 const char *zName,
2089 int nArg
2090){
drh92011842018-05-26 16:00:26 +00002091 int rc;
2092 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00002093
2094#ifdef SQLITE_ENABLE_API_ARMOR
2095 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
2096 return SQLITE_MISUSE_BKPT;
2097 }
2098#endif
drhe30f4422007-08-21 16:15:55 +00002099 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00002100 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00002101 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00002102 if( rc ) return SQLITE_OK;
2103 zCopy = sqlite3_mprintf(zName);
2104 if( zCopy==0 ) return SQLITE_NOMEM;
2105 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
2106 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00002107}
2108
drh19e2d372005-08-29 23:00:03 +00002109#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00002110/*
drh18de4822003-01-16 16:28:53 +00002111** Register a trace function. The pArg from the previously registered trace
2112** is returned.
2113**
2114** A NULL trace function means that no tracing is executes. A non-NULL
2115** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00002116** SQL statement.
drh18de4822003-01-16 16:28:53 +00002117*/
drh3d2a5292016-07-13 22:55:01 +00002118#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00002119void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00002120 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002121
2122#ifdef SQLITE_ENABLE_API_ARMOR
2123 if( !sqlite3SafetyCheckOk(db) ){
2124 (void)SQLITE_MISUSE_BKPT;
2125 return 0;
2126 }
2127#endif
drhe30f4422007-08-21 16:15:55 +00002128 sqlite3_mutex_enter(db->mutex);
2129 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00002130 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00002131 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00002132 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002133 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002134 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002135}
drh3d2a5292016-07-13 22:55:01 +00002136#endif /* SQLITE_OMIT_DEPRECATED */
2137
2138/* Register a trace callback using the version-2 interface.
2139*/
2140int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002141 sqlite3 *db, /* Trace this connection */
2142 unsigned mTrace, /* Mask of events to be traced */
2143 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2144 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002145){
2146#ifdef SQLITE_ENABLE_API_ARMOR
2147 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002148 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002149 }
2150#endif
2151 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002152 if( mTrace==0 ) xTrace = 0;
2153 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002154 db->mTrace = mTrace;
2155 db->xTrace = xTrace;
2156 db->pTraceArg = pArg;
2157 sqlite3_mutex_leave(db->mutex);
2158 return SQLITE_OK;
2159}
2160
drh087ec072016-07-25 00:05:56 +00002161#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002162/*
2163** Register a profile function. The pArg from the previously registered
2164** profile function is returned.
2165**
2166** A NULL profile function means that no profiling is executes. A non-NULL
2167** profile is a pointer to a function that is invoked at the conclusion of
2168** each SQL statement that is run.
2169*/
2170void *sqlite3_profile(
2171 sqlite3 *db,
2172 void (*xProfile)(void*,const char*,sqlite_uint64),
2173 void *pArg
2174){
drhe30f4422007-08-21 16:15:55 +00002175 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002176
2177#ifdef SQLITE_ENABLE_API_ARMOR
2178 if( !sqlite3SafetyCheckOk(db) ){
2179 (void)SQLITE_MISUSE_BKPT;
2180 return 0;
2181 }
2182#endif
drhe30f4422007-08-21 16:15:55 +00002183 sqlite3_mutex_enter(db->mutex);
2184 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002185 db->xProfile = xProfile;
2186 db->pProfileArg = pArg;
drh04c67472018-12-04 14:33:02 +00002187 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2188 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
drhe30f4422007-08-21 16:15:55 +00002189 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002190 return pOld;
2191}
drh087ec072016-07-25 00:05:56 +00002192#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002193#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002194
drhcd565fd2012-03-01 21:30:44 +00002195/*
2196** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002197** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002198** rollback.
2199*/
danielk197724b03fd2004-05-10 10:34:34 +00002200void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002201 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002202 int (*xCallback)(void*), /* Function to invoke on each commit */
2203 void *pArg /* Argument to the function */
2204){
drhe30f4422007-08-21 16:15:55 +00002205 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002206
2207#ifdef SQLITE_ENABLE_API_ARMOR
2208 if( !sqlite3SafetyCheckOk(db) ){
2209 (void)SQLITE_MISUSE_BKPT;
2210 return 0;
2211 }
2212#endif
drhe30f4422007-08-21 16:15:55 +00002213 sqlite3_mutex_enter(db->mutex);
2214 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002215 db->xCommitCallback = xCallback;
2216 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002217 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002218 return pOld;
2219}
2220
danielk197794eb6a12005-12-15 15:22:08 +00002221/*
2222** Register a callback to be invoked each time a row is updated,
2223** inserted or deleted using this database connection.
2224*/
danielk197771fd80b2005-12-16 06:54:01 +00002225void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002226 sqlite3 *db, /* Attach the hook to this database */
2227 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2228 void *pArg /* Argument to the function */
2229){
drhe30f4422007-08-21 16:15:55 +00002230 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002231
2232#ifdef SQLITE_ENABLE_API_ARMOR
2233 if( !sqlite3SafetyCheckOk(db) ){
2234 (void)SQLITE_MISUSE_BKPT;
2235 return 0;
2236 }
2237#endif
drhe30f4422007-08-21 16:15:55 +00002238 sqlite3_mutex_enter(db->mutex);
2239 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002240 db->xUpdateCallback = xCallback;
2241 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002242 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002243 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002244}
2245
danielk197771fd80b2005-12-16 06:54:01 +00002246/*
2247** Register a callback to be invoked each time a transaction is rolled
2248** back by this database connection.
2249*/
2250void *sqlite3_rollback_hook(
2251 sqlite3 *db, /* Attach the hook to this database */
2252 void (*xCallback)(void*), /* Callback function */
2253 void *pArg /* Argument to the function */
2254){
drhe30f4422007-08-21 16:15:55 +00002255 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002256
2257#ifdef SQLITE_ENABLE_API_ARMOR
2258 if( !sqlite3SafetyCheckOk(db) ){
2259 (void)SQLITE_MISUSE_BKPT;
2260 return 0;
2261 }
2262#endif
drhe30f4422007-08-21 16:15:55 +00002263 sqlite3_mutex_enter(db->mutex);
2264 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002265 db->xRollbackCallback = xCallback;
2266 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002267 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002268 return pRet;
2269}
drhaa940ea2004-01-15 02:44:03 +00002270
drh9b1c62d2011-03-30 21:04:43 +00002271#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002272/*
2273** Register a callback to be invoked each time a row is updated,
2274** inserted or deleted using this database connection.
2275*/
2276void *sqlite3_preupdate_hook(
2277 sqlite3 *db, /* Attach the hook to this database */
2278 void(*xCallback)( /* Callback function */
2279 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2280 void *pArg /* First callback argument */
2281){
2282 void *pRet;
2283 sqlite3_mutex_enter(db->mutex);
2284 pRet = db->pPreUpdateArg;
2285 db->xPreUpdateCallback = xCallback;
2286 db->pPreUpdateArg = pArg;
2287 sqlite3_mutex_leave(db->mutex);
2288 return pRet;
2289}
drh9b1c62d2011-03-30 21:04:43 +00002290#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002291
dan586b9c82010-05-03 08:04:49 +00002292#ifndef SQLITE_OMIT_WAL
2293/*
2294** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002295** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2296** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002297** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002298*/
drhb033d8b2010-05-03 13:37:30 +00002299int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002300 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002301 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002302 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002303 int nFrame /* Size of WAL */
2304){
drh5def0842010-05-05 20:00:25 +00002305 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002306 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002307 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002308 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002309 }
2310 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002311}
drhb033d8b2010-05-03 13:37:30 +00002312#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002313
2314/*
2315** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2316** a database after committing a transaction if there are nFrame or
2317** more frames in the log file. Passing zero or a negative value as the
2318** nFrame parameter disables automatic checkpoints entirely.
2319**
2320** The callback registered by this function replaces any existing callback
2321** registered using sqlite3_wal_hook(). Likewise, registering a callback
2322** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2323** configured by this function.
2324*/
2325int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002326#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002327 UNUSED_PARAMETER(db);
2328 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002329#else
drh9ca95732014-10-24 00:35:58 +00002330#ifdef SQLITE_ENABLE_API_ARMOR
2331 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2332#endif
dan586b9c82010-05-03 08:04:49 +00002333 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002334 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002335 }else{
2336 sqlite3_wal_hook(db, 0, 0);
2337 }
drhb033d8b2010-05-03 13:37:30 +00002338#endif
dan586b9c82010-05-03 08:04:49 +00002339 return SQLITE_OK;
2340}
2341
paulb0208cc2003-04-13 18:26:49 +00002342/*
dan8d22a172010-04-19 18:03:51 +00002343** Register a callback to be invoked each time a transaction is written
2344** into the write-ahead-log by this database connection.
2345*/
drh833bf962010-04-28 14:42:19 +00002346void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002347 sqlite3 *db, /* Attach the hook to this db handle */
2348 int(*xCallback)(void *, sqlite3*, const char*, int),
2349 void *pArg /* First argument passed to xCallback() */
2350){
drhb033d8b2010-05-03 13:37:30 +00002351#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002352 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002353#ifdef SQLITE_ENABLE_API_ARMOR
2354 if( !sqlite3SafetyCheckOk(db) ){
2355 (void)SQLITE_MISUSE_BKPT;
2356 return 0;
2357 }
2358#endif
dan8d22a172010-04-19 18:03:51 +00002359 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002360 pRet = db->pWalArg;
2361 db->xWalCallback = xCallback;
2362 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002363 sqlite3_mutex_leave(db->mutex);
2364 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002365#else
2366 return 0;
2367#endif
dan8d22a172010-04-19 18:03:51 +00002368}
2369
2370/*
dancdc1f042010-11-18 12:11:05 +00002371** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002372*/
dancdc1f042010-11-18 12:11:05 +00002373int sqlite3_wal_checkpoint_v2(
2374 sqlite3 *db, /* Database handle */
2375 const char *zDb, /* Name of attached database (or NULL) */
2376 int eMode, /* SQLITE_CHECKPOINT_* value */
2377 int *pnLog, /* OUT: Size of WAL log in frames */
2378 int *pnCkpt /* OUT: Total number of frames checkpointed */
2379){
drhb033d8b2010-05-03 13:37:30 +00002380#ifdef SQLITE_OMIT_WAL
2381 return SQLITE_OK;
2382#else
dan586b9c82010-05-03 08:04:49 +00002383 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002384 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002385
drh9ca95732014-10-24 00:35:58 +00002386#ifdef SQLITE_ENABLE_API_ARMOR
2387 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2388#endif
2389
dan9c5e3682011-02-07 15:12:12 +00002390 /* Initialize the output variables to -1 in case an error occurs. */
2391 if( pnLog ) *pnLog = -1;
2392 if( pnCkpt ) *pnCkpt = -1;
2393
danf26a1542014-12-02 19:04:54 +00002394 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2395 assert( SQLITE_CHECKPOINT_FULL==1 );
2396 assert( SQLITE_CHECKPOINT_RESTART==2 );
2397 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2398 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002399 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2400 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002401 return SQLITE_MISUSE;
2402 }
2403
dan586b9c82010-05-03 08:04:49 +00002404 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002405 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002406 iDb = sqlite3FindDbName(db, zDb);
2407 }
2408 if( iDb<0 ){
2409 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002410 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002411 }else{
dan976b0032015-01-29 19:12:12 +00002412 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002413 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002414 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002415 }
drhb033d8b2010-05-03 13:37:30 +00002416 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002417
2418 /* If there are no active statements, clear the interrupt flag at this
2419 ** point. */
2420 if( db->nVdbeActive==0 ){
dan892edb62020-03-30 13:35:05 +00002421 AtomicStore(&db->u1.isInterrupted, 0);
dan7fb89902016-08-12 16:21:15 +00002422 }
2423
dan586b9c82010-05-03 08:04:49 +00002424 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002425 return rc;
2426#endif
dan586b9c82010-05-03 08:04:49 +00002427}
2428
dancdc1f042010-11-18 12:11:05 +00002429
2430/*
2431** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2432** to contains a zero-length string, all attached databases are
2433** checkpointed.
2434*/
2435int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002436 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2437 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2438 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002439}
2440
drhb033d8b2010-05-03 13:37:30 +00002441#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002442/*
2443** Run a checkpoint on database iDb. This is a no-op if database iDb is
2444** not currently open in WAL mode.
2445**
dan6fcff072010-05-03 14:05:43 +00002446** If a transaction is open on the database being checkpointed, this
2447** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2448** an error occurs while running the checkpoint, an SQLite error code is
2449** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002450**
2451** The mutex on database handle db should be held by the caller. The mutex
2452** associated with the specific b-tree being checkpointed is taken by
2453** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002454**
2455** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2456** checkpointed. If an error is encountered it is returned immediately -
2457** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002458**
dan78345512017-09-08 17:48:00 +00002459** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2460** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002461*/
dancdc1f042010-11-18 12:11:05 +00002462int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002463 int rc = SQLITE_OK; /* Return code */
2464 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002465 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002466
2467 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002468 assert( !pnLog || *pnLog==-1 );
2469 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002470
dan6fcff072010-05-03 14:05:43 +00002471 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2472 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002473 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002474 pnLog = 0;
2475 pnCkpt = 0;
2476 if( rc==SQLITE_BUSY ){
2477 bBusy = 1;
2478 rc = SQLITE_OK;
2479 }
dan6fcff072010-05-03 14:05:43 +00002480 }
dan586b9c82010-05-03 08:04:49 +00002481 }
2482
danf2b8dd52010-11-18 19:28:01 +00002483 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002484}
drhb033d8b2010-05-03 13:37:30 +00002485#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002486
2487/*
danielk1977d8293352009-04-30 09:10:37 +00002488** This function returns true if main-memory should be used instead of
2489** a temporary file for transient pager files and statement journals.
2490** The value returned depends on the value of db->temp_store (runtime
2491** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2492** following table describes the relationship between these two values
2493** and this functions return value.
2494**
2495** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2496** ----------------- -------------- ------------------------------
2497** 0 any file (return 0)
2498** 1 1 file (return 0)
2499** 1 2 memory (return 1)
2500** 1 0 file (return 0)
2501** 2 1 file (return 0)
2502** 2 2 memory (return 1)
2503** 2 0 memory (return 1)
2504** 3 any memory (return 1)
2505*/
drh1c514142009-04-30 12:25:10 +00002506int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002507#if SQLITE_TEMP_STORE==1
2508 return ( db->temp_store==2 );
2509#endif
2510#if SQLITE_TEMP_STORE==2
2511 return ( db->temp_store!=1 );
2512#endif
2513#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002514 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002515 return 1;
shanecf697392009-06-01 16:53:09 +00002516#endif
2517#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002518 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002519 return 0;
shane60a4b532009-05-06 18:57:09 +00002520#endif
danielk1977d8293352009-04-30 09:10:37 +00002521}
2522
2523/*
danielk19774ad17132004-05-21 01:47:26 +00002524** Return UTF-8 encoded English language explanation of the most recent
2525** error.
2526*/
danielk19776622cce2004-05-20 11:00:52 +00002527const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002528 const char *z;
drhf49661a2008-12-10 16:45:50 +00002529 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002530 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002531 }
drhd55d57e2008-07-07 17:53:07 +00002532 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002533 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002534 }
drh27641702007-08-22 02:56:42 +00002535 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002536 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002537 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002538 }else{
drha3cc0072013-12-13 16:23:55 +00002539 testcase( db->pErr==0 );
drh368bfe82018-12-11 12:20:41 +00002540 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
danielk1977238746a2009-03-19 18:51:06 +00002541 assert( !db->mallocFailed );
2542 if( z==0 ){
2543 z = sqlite3ErrStr(db->errCode);
2544 }
danielk19776622cce2004-05-20 11:00:52 +00002545 }
drhe30f4422007-08-21 16:15:55 +00002546 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002547 return z;
danielk19776622cce2004-05-20 11:00:52 +00002548}
2549
drh6c626082004-11-14 21:56:29 +00002550#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002551/*
2552** Return UTF-16 encoded English language explanation of the most recent
2553** error.
2554*/
danielk19776622cce2004-05-20 11:00:52 +00002555const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002556 static const u16 outOfMem[] = {
2557 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002558 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002559 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002560 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2561 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2562 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002563 };
danielk19774ad17132004-05-21 01:47:26 +00002564
drhc60d0442004-09-30 13:43:13 +00002565 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002566 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002567 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002568 }
drhd55d57e2008-07-07 17:53:07 +00002569 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002570 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002571 }
drhe30f4422007-08-21 16:15:55 +00002572 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002573 if( db->mallocFailed ){
2574 z = (void *)outOfMem;
2575 }else{
drhc60d0442004-09-30 13:43:13 +00002576 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002577 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002578 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002579 z = sqlite3_value_text16(db->pErr);
2580 }
2581 /* A malloc() may have failed within the call to sqlite3_value_text16()
2582 ** above. If this is the case, then the db->mallocFailed flag needs to
2583 ** be cleared before returning. Do this directly, instead of via
2584 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2585 */
drh4a642b62016-02-05 01:55:27 +00002586 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002587 }
drhe30f4422007-08-21 16:15:55 +00002588 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002589 return z;
danielk19776622cce2004-05-20 11:00:52 +00002590}
drh6c626082004-11-14 21:56:29 +00002591#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002592
drhc60d0442004-09-30 13:43:13 +00002593/*
danielk19777ddad962005-12-12 06:53:03 +00002594** Return the most recent error code generated by an SQLite routine. If NULL is
2595** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002596*/
danielk19776622cce2004-05-20 11:00:52 +00002597int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002598 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002599 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002600 }
drh01495b92008-01-23 12:52:40 +00002601 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002602 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002603 }
drh4ac285a2006-09-15 07:28:50 +00002604 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002605}
drh99dfe5e2008-10-30 15:03:15 +00002606int sqlite3_extended_errcode(sqlite3 *db){
2607 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002608 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002609 }
2610 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002611 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002612 }
2613 return db->errCode;
2614}
drh1b9f2142016-03-17 16:01:23 +00002615int sqlite3_system_errno(sqlite3 *db){
2616 return db ? db->iSysErrno : 0;
2617}
danielk19776622cce2004-05-20 11:00:52 +00002618
drh0e819f92006-02-01 13:50:41 +00002619/*
mistachkin5dac8432012-09-11 02:00:25 +00002620** Return a string that describes the kind of error specified in the
2621** argument. For now, this simply calls the internal sqlite3ErrStr()
2622** function.
2623*/
2624const char *sqlite3_errstr(int rc){
2625 return sqlite3ErrStr(rc);
2626}
2627
2628/*
drh0e819f92006-02-01 13:50:41 +00002629** Create a new collating function for database "db". The name is zName
2630** and the encoding is enc.
2631*/
danielk19779a30cf62006-01-18 04:26:07 +00002632static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002633 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002634 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002635 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002636 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002637 int(*xCompare)(void*,int,const void*,int,const void*),
2638 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002639){
2640 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002641 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002642
drhe30f4422007-08-21 16:15:55 +00002643 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002644
2645 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2646 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2647 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2648 */
drh51c7d862009-04-27 18:46:06 +00002649 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002650 testcase( enc2==SQLITE_UTF16 );
2651 testcase( enc2==SQLITE_UTF16_ALIGNED );
2652 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002653 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002654 }
drh51c7d862009-04-27 18:46:06 +00002655 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002656 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002657 }
2658
2659 /* Check if this call is removing or replacing an existing collation
2660 ** sequence. If so, and there are active VMs, return busy. If there
2661 ** are no active VMs, invalidate any pre-compiled statements.
2662 */
drhc4a64fa2009-05-11 20:53:28 +00002663 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002664 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002665 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002666 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002667 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002668 return SQLITE_BUSY;
2669 }
drhba968db2018-07-24 22:02:12 +00002670 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002671
2672 /* If collation sequence pColl was created directly by a call to
2673 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2674 ** then any copies made by synthCollSeq() need to be invalidated.
2675 ** Also, collation destructor - CollSeq.xDel() - function may need
2676 ** to be called.
2677 */
2678 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002679 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002680 int j;
2681 for(j=0; j<3; j++){
2682 CollSeq *p = &aColl[j];
2683 if( p->enc==pColl->enc ){
2684 if( p->xDel ){
2685 p->xDel(p->pUser);
2686 }
2687 p->xCmp = 0;
2688 }
2689 }
2690 }
danielk19779a30cf62006-01-18 04:26:07 +00002691 }
2692
drhc4a64fa2009-05-11 20:53:28 +00002693 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002694 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002695 pColl->xCmp = xCompare;
2696 pColl->pUser = pCtx;
2697 pColl->xDel = xDel;
2698 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002699 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002700 return SQLITE_OK;
2701}
2702
2703
danielk19776622cce2004-05-20 11:00:52 +00002704/*
drhbb4957f2008-03-20 14:03:29 +00002705** This array defines hard upper bounds on limit values. The
2706** initializer must be kept in sync with the SQLITE_LIMIT_*
2707** #defines in sqlite3.h.
2708*/
drhb1a6c3c2008-03-20 16:30:17 +00002709static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002710 SQLITE_MAX_LENGTH,
2711 SQLITE_MAX_SQL_LENGTH,
2712 SQLITE_MAX_COLUMN,
2713 SQLITE_MAX_EXPR_DEPTH,
2714 SQLITE_MAX_COMPOUND_SELECT,
2715 SQLITE_MAX_VDBE_OP,
2716 SQLITE_MAX_FUNCTION_ARG,
2717 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002718 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002719 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002720 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002721 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002722};
2723
2724/*
2725** Make sure the hard limits are set to reasonable values
2726*/
2727#if SQLITE_MAX_LENGTH<100
2728# error SQLITE_MAX_LENGTH must be at least 100
2729#endif
2730#if SQLITE_MAX_SQL_LENGTH<100
2731# error SQLITE_MAX_SQL_LENGTH must be at least 100
2732#endif
2733#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2734# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2735#endif
drhbb4957f2008-03-20 14:03:29 +00002736#if SQLITE_MAX_COMPOUND_SELECT<2
2737# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2738#endif
2739#if SQLITE_MAX_VDBE_OP<40
2740# error SQLITE_MAX_VDBE_OP must be at least 40
2741#endif
drh80738d92016-02-15 00:34:16 +00002742#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2743# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002744#endif
drhd08b2792014-07-22 15:33:31 +00002745#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2746# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002747#endif
drhbb4957f2008-03-20 14:03:29 +00002748#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2749# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2750#endif
drh70a8ca32008-08-21 18:49:27 +00002751#if SQLITE_MAX_COLUMN>32767
2752# error SQLITE_MAX_COLUMN must not exceed 32767
2753#endif
drh417168a2009-09-07 18:14:02 +00002754#if SQLITE_MAX_TRIGGER_DEPTH<1
2755# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2756#endif
drh111544c2014-08-29 16:20:47 +00002757#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2758# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2759#endif
drhbb4957f2008-03-20 14:03:29 +00002760
2761
2762/*
2763** Change the value of a limit. Report the old value.
2764** If an invalid limit index is supplied, report -1.
2765** Make no changes but still report the old value if the
2766** new limit is negative.
2767**
2768** A new lower limit does not shrink existing constructs.
2769** It merely prevents new constructs that exceed the limit
2770** from forming.
2771*/
2772int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2773 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002774
drh9ca95732014-10-24 00:35:58 +00002775#ifdef SQLITE_ENABLE_API_ARMOR
2776 if( !sqlite3SafetyCheckOk(db) ){
2777 (void)SQLITE_MISUSE_BKPT;
2778 return -1;
2779 }
2780#endif
drh4e93f5b2010-09-07 14:59:15 +00002781
2782 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2783 ** there is a hard upper bound set at compile-time by a C preprocessor
2784 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2785 ** "_MAX_".)
2786 */
2787 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2788 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2789 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2790 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2791 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2792 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2793 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2794 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2795 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2796 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2797 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2798 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002799 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2800 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002801
2802
drh521cc842008-04-15 02:36:33 +00002803 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002804 return -1;
2805 }
2806 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002807 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002808 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002809 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002810 }
2811 db->aLimit[limitId] = newLimit;
2812 }
drh4e93f5b2010-09-07 14:59:15 +00002813 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002814}
2815
2816/*
dan286ab7c2011-05-06 18:34:54 +00002817** This function is used to parse both URIs and non-URI filenames passed by the
2818** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2819** URIs specified as part of ATTACH statements.
2820**
2821** The first argument to this function is the name of the VFS to use (or
2822** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2823** query parameter. The second argument contains the URI (or non-URI filename)
2824** itself. When this function is called the *pFlags variable should contain
2825** the default flags to open the database handle with. The value stored in
2826** *pFlags may be updated before returning if the URI filename contains
2827** "cache=xxx" or "mode=xxx" query parameters.
2828**
2829** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2830** the VFS that should be used to open the database file. *pzFile is set to
drhdf97d432020-02-27 11:32:14 +00002831** point to a buffer containing the name of the file to open. The value
2832** stored in *pzFile is a database name acceptable to sqlite3_uri_parameter()
2833** and is in the same format as names created using sqlite3_create_filename().
2834** The caller must invoke sqlite3_free_filename() (not sqlite3_free()!) on
2835** the value returned in *pzFile to avoid a memory leak.
dan286ab7c2011-05-06 18:34:54 +00002836**
2837** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2838** may be set to point to a buffer containing an English language error
2839** message. It is the responsibility of the caller to eventually release
2840** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002841*/
2842int sqlite3ParseUri(
2843 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2844 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002845 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002846 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2847 char **pzFile, /* OUT: Filename component of URI */
2848 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2849){
dan78e9dd22011-05-03 10:22:32 +00002850 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002851 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002852 const char *zVfs = zDefaultVfs;
2853 char *zFile;
drhde941c32011-05-09 19:20:17 +00002854 char c;
dancd74b612011-04-22 19:37:32 +00002855 int nUri = sqlite3Strlen30(zUri);
2856
2857 assert( *pzErrMsg==0 );
2858
drh8790b6e2014-11-07 01:43:56 +00002859 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2860 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002861 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002862 ){
dan5de15372011-04-23 10:12:30 +00002863 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002864 int eState; /* Parser state when parsing URI */
2865 int iIn; /* Input character index */
2866 int iOut = 0; /* Output character index */
drhdf97d432020-02-27 11:32:14 +00002867 u64 nByte = nUri+8; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002868
dan286ab7c2011-05-06 18:34:54 +00002869 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2870 ** method that there may be extra parameters following the file-name. */
2871 flags |= SQLITE_OPEN_URI;
2872
2873 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002874 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002875 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002876
drhdf97d432020-02-27 11:32:14 +00002877 memset(zFile, 0, 4); /* 4-byte of 0x00 is the start of DB name marker */
2878 zFile += 4;
2879
drh869c0402013-08-07 23:15:52 +00002880 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002881#ifdef SQLITE_ALLOW_URI_AUTHORITY
2882 if( strncmp(zUri+5, "///", 3)==0 ){
2883 iIn = 7;
2884 /* The following condition causes URIs with five leading / characters
2885 ** like file://///host/path to be converted into UNCs like //host/path.
2886 ** The correct URI for that UNC has only two or four leading / characters
2887 ** file://host/path or file:////host/path. But 5 leading slashes is a
2888 ** common error, we are told, so we handle it as a special case. */
2889 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2890 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2891 iIn = 16;
2892 }
2893#else
dancd74b612011-04-22 19:37:32 +00002894 /* Discard the scheme and authority segments of the URI. */
2895 if( zUri[5]=='/' && zUri[6]=='/' ){
2896 iIn = 7;
2897 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002898 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2899 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2900 iIn-7, &zUri[7]);
2901 rc = SQLITE_ERROR;
2902 goto parse_uri_out;
2903 }
dancd74b612011-04-22 19:37:32 +00002904 }
drh869c0402013-08-07 23:15:52 +00002905#endif
dancd74b612011-04-22 19:37:32 +00002906
2907 /* Copy the filename and any query parameters into the zFile buffer.
2908 ** Decode %HH escape codes along the way.
2909 **
2910 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2911 ** on the parsing context. As follows:
2912 **
2913 ** 0: Parsing file-name.
2914 ** 1: Parsing name section of a name=value query parameter.
2915 ** 2: Parsing value section of a name=value query parameter.
2916 */
2917 eState = 0;
drhde941c32011-05-09 19:20:17 +00002918 while( (c = zUri[iIn])!=0 && c!='#' ){
2919 iIn++;
dancd74b612011-04-22 19:37:32 +00002920 if( c=='%'
2921 && sqlite3Isxdigit(zUri[iIn])
2922 && sqlite3Isxdigit(zUri[iIn+1])
2923 ){
dan6d49e252011-05-03 15:09:05 +00002924 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2925 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002926
dan6d49e252011-05-03 15:09:05 +00002927 assert( octet>=0 && octet<256 );
2928 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002929#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002930 /* This branch is taken when "%00" appears within the URI. In this
2931 ** case we ignore all text in the remainder of the path, name or
2932 ** value currently being parsed. So ignore the current character
2933 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002934 while( (c = zUri[iIn])!=0 && c!='#'
2935 && (eState!=0 || c!='?')
2936 && (eState!=1 || (c!='=' && c!='&'))
2937 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002938 ){
2939 iIn++;
2940 }
2941 continue;
dan5c35e902016-10-26 12:15:41 +00002942#else
2943 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2944 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2945 rc = SQLITE_ERROR;
2946 goto parse_uri_out;
2947#endif
dancd74b612011-04-22 19:37:32 +00002948 }
dan6d49e252011-05-03 15:09:05 +00002949 c = octet;
dan5de15372011-04-23 10:12:30 +00002950 }else if( eState==1 && (c=='&' || c=='=') ){
2951 if( zFile[iOut-1]==0 ){
2952 /* An empty option name. Ignore this option altogether. */
2953 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2954 continue;
2955 }
2956 if( c=='&' ){
2957 zFile[iOut++] = '\0';
2958 }else{
2959 eState = 2;
2960 }
dancd74b612011-04-22 19:37:32 +00002961 c = 0;
dan5de15372011-04-23 10:12:30 +00002962 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2963 c = 0;
dancd74b612011-04-22 19:37:32 +00002964 eState = 1;
dancd74b612011-04-22 19:37:32 +00002965 }
2966 zFile[iOut++] = c;
2967 }
2968 if( eState==1 ) zFile[iOut++] = '\0';
drhdf97d432020-02-27 11:32:14 +00002969 memset(zFile+iOut, 0, 4); /* end-of-options + empty journal filenames */
dancd74b612011-04-22 19:37:32 +00002970
2971 /* Check if there were any options specified that should be interpreted
2972 ** here. Options that are interpreted here include "vfs" and those that
2973 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002974 ** method. */
dan5de15372011-04-23 10:12:30 +00002975 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2976 while( zOpt[0] ){
2977 int nOpt = sqlite3Strlen30(zOpt);
2978 char *zVal = &zOpt[nOpt+1];
2979 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002980
dan286ab7c2011-05-06 18:34:54 +00002981 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002982 zVfs = zVal;
2983 }else{
2984 struct OpenMode {
2985 const char *z;
2986 int mode;
2987 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002988 char *zModeType = 0;
2989 int mask = 0;
2990 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002991
dan286ab7c2011-05-06 18:34:54 +00002992 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002993 static struct OpenMode aCacheMode[] = {
2994 { "shared", SQLITE_OPEN_SHAREDCACHE },
2995 { "private", SQLITE_OPEN_PRIVATECACHE },
2996 { 0, 0 }
2997 };
2998
2999 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
3000 aMode = aCacheMode;
3001 limit = mask;
3002 zModeType = "cache";
3003 }
dan286ab7c2011-05-06 18:34:54 +00003004 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00003005 static struct OpenMode aOpenMode[] = {
3006 { "ro", SQLITE_OPEN_READONLY },
3007 { "rw", SQLITE_OPEN_READWRITE },
3008 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00003009 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00003010 { 0, 0 }
3011 };
3012
drh9c67b2a2012-05-28 13:58:00 +00003013 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
3014 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00003015 aMode = aOpenMode;
3016 limit = mask & flags;
3017 zModeType = "access";
3018 }
3019
3020 if( aMode ){
3021 int i;
3022 int mode = 0;
3023 for(i=0; aMode[i].z; i++){
3024 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00003025 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00003026 mode = aMode[i].mode;
3027 break;
dancd74b612011-04-22 19:37:32 +00003028 }
3029 }
dan78e9dd22011-05-03 10:22:32 +00003030 if( mode==0 ){
3031 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
3032 rc = SQLITE_ERROR;
3033 goto parse_uri_out;
3034 }
drh9c67b2a2012-05-28 13:58:00 +00003035 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00003036 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
3037 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00003038 rc = SQLITE_PERM;
3039 goto parse_uri_out;
3040 }
3041 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00003042 }
dancd74b612011-04-22 19:37:32 +00003043 }
dan5de15372011-04-23 10:12:30 +00003044
3045 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00003046 }
3047
3048 }else{
drhdf97d432020-02-27 11:32:14 +00003049 zFile = sqlite3_malloc64(nUri+8);
mistachkinfad30392016-02-13 23:43:46 +00003050 if( !zFile ) return SQLITE_NOMEM_BKPT;
drhdf97d432020-02-27 11:32:14 +00003051 memset(zFile, 0, 4);
3052 zFile += 4;
dan895decf2016-12-30 14:15:56 +00003053 if( nUri ){
3054 memcpy(zFile, zUri, nUri);
3055 }
drhdf97d432020-02-27 11:32:14 +00003056 memset(zFile+nUri, 0, 4);
drh4ab9d252012-05-26 20:08:49 +00003057 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00003058 }
3059
3060 *ppVfs = sqlite3_vfs_find(zVfs);
3061 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00003062 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00003063 rc = SQLITE_ERROR;
3064 }
3065 parse_uri_out:
3066 if( rc!=SQLITE_OK ){
drhdf97d432020-02-27 11:32:14 +00003067 sqlite3_free_filename(zFile);
dan78e9dd22011-05-03 10:22:32 +00003068 zFile = 0;
dancd74b612011-04-22 19:37:32 +00003069 }
3070 *pFlags = flags;
3071 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00003072 return rc;
dancd74b612011-04-22 19:37:32 +00003073}
3074
drh1eac9662020-02-01 13:30:39 +00003075/*
3076** This routine does the core work of extracting URI parameters from a
3077** database filename for the sqlite3_uri_parameter() interface.
3078*/
3079static const char *uriParameter(const char *zFilename, const char *zParam){
3080 zFilename += sqlite3Strlen30(zFilename) + 1;
3081 while( zFilename[0] ){
3082 int x = strcmp(zFilename, zParam);
3083 zFilename += sqlite3Strlen30(zFilename) + 1;
3084 if( x==0 ) return zFilename;
3085 zFilename += sqlite3Strlen30(zFilename) + 1;
3086 }
3087 return 0;
3088}
3089
drhe5989722019-02-02 15:59:49 +00003090
dancd74b612011-04-22 19:37:32 +00003091
3092/*
danielk19774ad17132004-05-21 01:47:26 +00003093** This routine does the work of opening a database on behalf of
3094** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00003095** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00003096*/
3097static int openDatabase(
3098 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00003099 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00003100 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00003101 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00003102){
dancd74b612011-04-22 19:37:32 +00003103 sqlite3 *db; /* Store allocated handle here */
3104 int rc; /* Return code */
3105 int isThreadsafe; /* True for threadsafe connections */
3106 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
3107 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
drh20e34f92020-05-04 17:15:21 +00003108 int i; /* Loop counter */
danielk19774ad17132004-05-21 01:47:26 +00003109
drh9ca95732014-10-24 00:35:58 +00003110#ifdef SQLITE_ENABLE_API_ARMOR
3111 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3112#endif
drhe0d0f8e2009-04-28 04:47:31 +00003113 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003114#ifndef SQLITE_OMIT_AUTOINIT
3115 rc = sqlite3_initialize();
3116 if( rc ) return rc;
3117#endif
3118
drh039963a2008-09-03 00:43:15 +00003119 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00003120 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00003121 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3122 isThreadsafe = 0;
3123 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3124 isThreadsafe = 1;
3125 }else{
3126 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00003127 }
dan8385bec2017-11-25 17:51:01 +00003128
drhf1f12682009-09-09 14:17:52 +00003129 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00003130 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00003131 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3132 flags |= SQLITE_OPEN_SHAREDCACHE;
3133 }
danielk19779a6284c2008-07-10 17:52:49 +00003134
drhb25a9f42009-05-12 13:35:11 +00003135 /* Remove harmful bits from the flags parameter
3136 **
3137 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3138 ** dealt with in the previous code block. Besides these, the only
3139 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00003140 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3141 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00003142 ** off all other flags.
3143 */
drha4267dc2008-02-19 15:20:44 +00003144 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00003145 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00003146 SQLITE_OPEN_MAIN_DB |
3147 SQLITE_OPEN_TEMP_DB |
3148 SQLITE_OPEN_TRANSIENT_DB |
3149 SQLITE_OPEN_MAIN_JOURNAL |
3150 SQLITE_OPEN_TEMP_JOURNAL |
3151 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00003152 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003153 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003154 SQLITE_OPEN_FULLMUTEX |
3155 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003156 );
3157
danielk19774ad17132004-05-21 01:47:26 +00003158 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003159 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003160 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003161 if( isThreadsafe
3162#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3163 || sqlite3GlobalConfig.bCoreMutex
3164#endif
3165 ){
danielk197759f8c082008-06-18 17:09:10 +00003166 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3167 if( db->mutex==0 ){
3168 sqlite3_free(db);
3169 db = 0;
3170 goto opendb_out;
3171 }
dan8385bec2017-11-25 17:51:01 +00003172 if( isThreadsafe==0 ){
3173 sqlite3MutexWarnOnContention(db->mutex);
3174 }
drh605264d2007-08-21 15:13:19 +00003175 }
drh27641702007-08-22 02:56:42 +00003176 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003177 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003178 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003179 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003180 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003181 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +00003182 db->lookaside.sz = 0;
drh633e6d52008-07-28 19:34:53 +00003183
drhbb4957f2008-03-20 14:03:29 +00003184 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3185 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003186 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003187 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003188 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003189 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003190 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003191 db->nMaxSorterMmap = 0x7FFFFFFF;
drh4b50da92019-07-02 12:23:09 +00003192 db->flags |= SQLITE_ShortColNames
3193 | SQLITE_EnableTrigger
drh11d88e62019-08-15 21:27:20 +00003194 | SQLITE_EnableView
drh4b50da92019-07-02 12:23:09 +00003195 | SQLITE_CacheSpill
drhb77da372020-01-07 16:09:11 +00003196#if !defined(SQLITE_TRUSTED_SCHEMA) || SQLITE_TRUSTED_SCHEMA+0!=0
3197 | SQLITE_TrustedSchema
3198#endif
drh4b50da92019-07-02 12:23:09 +00003199/* The SQLITE_DQS compile-time option determines the default settings
3200** for SQLITE_DBCONFIG_DQS_DDL and SQLITE_DBCONFIG_DQS_DML.
3201**
3202** SQLITE_DQS SQLITE_DBCONFIG_DQS_DDL SQLITE_DBCONFIG_DQS_DML
3203** ---------- ----------------------- -----------------------
3204** undefined on on
3205** 3 on on
3206** 2 on off
3207** 1 off on
3208** 0 off off
3209**
3210** Legacy behavior is 3 (double-quoted string literals are allowed anywhere)
3211** and so that is the default. But developers are encouranged to use
3212** -DSQLITE_DQS=0 (best) or -DSQLITE_DQS=1 (second choice) if possible.
3213*/
3214#if !defined(SQLITE_DQS)
3215# define SQLITE_DQS 3
3216#endif
3217#if (SQLITE_DQS&1)==1
drhd0ff6012019-06-17 13:56:11 +00003218 | SQLITE_DqsDML
drh4b50da92019-07-02 12:23:09 +00003219#endif
3220#if (SQLITE_DQS&2)==2
3221 | SQLITE_DqsDDL
3222#endif
3223
dan1d1f07d2013-07-25 16:41:39 +00003224#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003225 | SQLITE_AutoIndex
3226#endif
drh883ad042015-02-19 00:29:11 +00003227#if SQLITE_DEFAULT_CKPTFULLFSYNC
3228 | SQLITE_CkptFullFSync
3229#endif
drh76fe8032006-07-11 14:17:51 +00003230#if SQLITE_DEFAULT_FILE_FORMAT<4
3231 | SQLITE_LegacyFileFmt
3232#endif
drh56424db2007-03-27 22:24:11 +00003233#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3234 | SQLITE_LoadExtension
3235#endif
dan5bde73c2009-09-01 17:11:07 +00003236#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003237 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003238#endif
drha4bfd7f2010-12-09 19:15:17 +00003239#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3240 | SQLITE_ForeignKeys
3241#endif
drhf5471922014-12-09 15:12:11 +00003242#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3243 | SQLITE_ReverseOrder
3244#endif
drh1421d982015-05-27 03:46:18 +00003245#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3246 | SQLITE_CellSizeCk
3247#endif
drhd42908f2016-02-26 15:38:24 +00003248#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3249 | SQLITE_Fts3Tokenizer
3250#endif
drh169dd922017-06-26 13:57:49 +00003251#if defined(SQLITE_ENABLE_QPSG)
3252 | SQLITE_EnableQPSG
3253#endif
drh6ab91a72018-11-07 02:17:01 +00003254#if defined(SQLITE_DEFAULT_DEFENSIVE)
3255 | SQLITE_Defensive
3256#endif
drhe0a8b712020-05-06 18:43:57 +00003257#if defined(SQLITE_DEFAULT_LEGACY_ALTER_TABLE)
3258 | SQLITE_LegacyAlter
3259#endif
drh76fe8032006-07-11 14:17:51 +00003260 ;
drhe61922a2009-05-02 13:29:37 +00003261 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003262#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003263 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003264#endif
danielk1977da184232006-01-05 11:34:32 +00003265
danielk19770202b292004-06-09 09:55:16 +00003266 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3267 ** and UTF-16, so add a version for each to avoid any unnecessary
3268 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003269 **
3270 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3271 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003272 */
drhf19aa5f2015-12-30 16:51:20 +00003273 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3274 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3275 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003276 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh821afa42019-06-14 13:24:46 +00003277 createCollation(db, "RTRIM", SQLITE_UTF8, 0, rtrimCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003278 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003279 goto opendb_out;
3280 }
3281
drhff4fa772017-07-10 12:07:53 +00003282 /* Parse the filename/URI argument
3283 **
3284 ** Only allow sensible combinations of bits in the flags argument.
3285 ** Throw an error if any non-sense combination is used. If we
3286 ** do not block illegal combinations here, it could trigger
3287 ** assert() statements in deeper layers. Sensible combinations
3288 ** are:
3289 **
3290 ** 1: SQLITE_OPEN_READONLY
3291 ** 2: SQLITE_OPEN_READWRITE
3292 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3293 */
dan19432992011-05-10 18:39:10 +00003294 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003295 assert( SQLITE_OPEN_READONLY == 0x01 );
3296 assert( SQLITE_OPEN_READWRITE == 0x02 );
3297 assert( SQLITE_OPEN_CREATE == 0x04 );
3298 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3299 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3300 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3301 if( ((1<<(flags&7)) & 0x46)==0 ){
3302 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3303 }else{
3304 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3305 }
dancd74b612011-04-22 19:37:32 +00003306 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003307 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003308 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003309 sqlite3_free(zErrMsg);
3310 goto opendb_out;
3311 }
3312
danielk19774ad17132004-05-21 01:47:26 +00003313 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003314 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003315 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003316 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003317 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003318 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003319 }
drh13f40da2014-08-22 18:00:11 +00003320 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003321 goto opendb_out;
3322 }
dan0235a032014-12-08 20:20:16 +00003323 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003324 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh42a630b2020-03-05 16:13:24 +00003325 if( !db->mallocFailed ){
3326 sqlite3SetTextEncoding(db, SCHEMA_ENC(db));
3327 }
dan0235a032014-12-08 20:20:16 +00003328 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003329 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003330
drhe872d512016-02-22 13:23:16 +00003331 /* The default safety_level for the main database is FULL; for the temp
3332 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003333 */
drh69c33822016-08-18 14:33:11 +00003334 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003335 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003336 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003337 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003338
danielk1977832a58a2007-06-22 15:21:15 +00003339 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003340 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003341 goto opendb_out;
3342 }
3343
danielk19778e227872004-06-07 07:52:17 +00003344 /* Register all built-in functions, but do not attempt to read the
3345 ** database schema yet. This is delayed until the first time the database
3346 ** is accessed.
3347 */
drh13f40da2014-08-22 18:00:11 +00003348 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003349 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003350 rc = sqlite3_errcode(db);
3351
drh20e34f92020-05-04 17:15:21 +00003352
3353 /* Load compiled-in extensions */
3354 for(i=0; rc==SQLITE_OK && i<ArraySize(sqlite3BuiltinExtensions); i++){
3355 rc = sqlite3BuiltinExtensions[i](db);
danc9e75fb2016-08-19 18:37:35 +00003356 }
danielk19774ad17132004-05-21 01:47:26 +00003357
drh1409be62006-08-23 20:07:20 +00003358 /* Load automatic extensions - extensions that have been registered
3359 ** using the sqlite3_automatic_extension() API.
3360 */
drhe5077c12011-12-13 04:08:36 +00003361 if( rc==SQLITE_OK ){
3362 sqlite3AutoLoadExtensions(db);
3363 rc = sqlite3_errcode(db);
3364 if( rc!=SQLITE_OK ){
3365 goto opendb_out;
3366 }
danielk1977832a58a2007-06-22 15:21:15 +00003367 }
drh1409be62006-08-23 20:07:20 +00003368
drh2a83c102020-01-01 23:02:35 +00003369#ifdef SQLITE_ENABLE_INTERNAL_FUNCTIONS
3370 /* Testing use only!!! The -DSQLITE_ENABLE_INTERNAL_FUNCTIONS=1 compile-time
3371 ** option gives access to internal functions by default.
3372 ** Testing use only!!! */
3373 db->mDbFlags |= DBFLAG_InternalFunc;
3374#endif
3375
drh8fd5bd32007-04-02 16:40:37 +00003376 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3377 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3378 ** mode. Doing nothing at all also makes NORMAL the default.
3379 */
3380#ifdef SQLITE_DEFAULT_LOCKING_MODE
3381 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3382 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3383 SQLITE_DEFAULT_LOCKING_MODE);
3384#endif
3385
drh13f40da2014-08-22 18:00:11 +00003386 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003387
drh633e6d52008-07-28 19:34:53 +00003388 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003389 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3390 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003391
dan5a299f92010-05-03 11:05:08 +00003392 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003393
danielk19774ad17132004-05-21 01:47:26 +00003394opendb_out:
drhafc91042008-02-21 02:09:45 +00003395 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003396 assert( db->mutex!=0 || isThreadsafe==0
3397 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003398 sqlite3_mutex_leave(db->mutex);
3399 }
danielk197759633ae2008-08-27 19:01:57 +00003400 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003401 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003402 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003403 sqlite3_close(db);
3404 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003405 }else if( rc!=SQLITE_OK ){
3406 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003407 }
danielk19774ad17132004-05-21 01:47:26 +00003408 *ppDb = db;
danac455932012-11-26 19:50:41 +00003409#ifdef SQLITE_ENABLE_SQLLOG
3410 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003411 /* Opening a db handle. Fourth parameter is passed 0. */
3412 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3413 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003414 }
3415#endif
drhdf97d432020-02-27 11:32:14 +00003416 sqlite3_free_filename(zOpen);
drh597d2b62015-06-30 03:13:47 +00003417 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003418}
3419
drhe5989722019-02-02 15:59:49 +00003420
danielk19774ad17132004-05-21 01:47:26 +00003421/*
3422** Open a new database handle.
3423*/
danielk197780290862004-05-22 09:21:21 +00003424int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003425 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003426 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003427){
drh605264d2007-08-21 15:13:19 +00003428 return openDatabase(zFilename, ppDb,
3429 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3430}
3431int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003432 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003433 sqlite3 **ppDb, /* OUT: SQLite db handle */
3434 int flags, /* Flags */
3435 const char *zVfs /* Name of VFS module to use */
3436){
drh522c26f2011-05-07 14:40:29 +00003437 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003438}
3439
drh6c626082004-11-14 21:56:29 +00003440#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003441/*
3442** Open a new database handle.
3443*/
3444int sqlite3_open16(
3445 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003446 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003447){
danielk1977bfd6cce2004-06-18 04:24:54 +00003448 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003449 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003450 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003451
drh9ca95732014-10-24 00:35:58 +00003452#ifdef SQLITE_ENABLE_API_ARMOR
3453 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3454#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003455 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003456#ifndef SQLITE_OMIT_AUTOINIT
3457 rc = sqlite3_initialize();
3458 if( rc ) return rc;
3459#endif
drh9ca95732014-10-24 00:35:58 +00003460 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003461 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003462 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3463 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003464 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003465 rc = openDatabase(zFilename8, ppDb,
3466 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003467 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003468 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003469 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003470 }
drh40257ff2008-06-13 18:24:27 +00003471 }else{
mistachkinfad30392016-02-13 23:43:46 +00003472 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003473 }
danielk19777ddad962005-12-12 06:53:03 +00003474 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003475
drh597d2b62015-06-30 03:13:47 +00003476 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003477}
drh6c626082004-11-14 21:56:29 +00003478#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003479
danielk1977106bb232004-05-21 10:08:53 +00003480/*
danielk1977d8123362004-06-12 09:25:12 +00003481** Register a new collation sequence with the database handle db.
3482*/
danielk19770202b292004-06-09 09:55:16 +00003483int sqlite3_create_collation(
3484 sqlite3* db,
3485 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003486 int enc,
danielk19770202b292004-06-09 09:55:16 +00003487 void* pCtx,
3488 int(*xCompare)(void*,int,const void*,int,const void*)
3489){
drh4f81bbb2014-10-23 01:01:26 +00003490 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003491}
3492
3493/*
3494** Register a new collation sequence with the database handle db.
3495*/
danielk1977a393c032007-05-07 14:58:53 +00003496int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003497 sqlite3* db,
3498 const char *zName,
3499 int enc,
3500 void* pCtx,
3501 int(*xCompare)(void*,int,const void*,int,const void*),
3502 void(*xDel)(void*)
3503){
3504 int rc;
drh9ca95732014-10-24 00:35:58 +00003505
3506#ifdef SQLITE_ENABLE_API_ARMOR
3507 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3508#endif
drhe30f4422007-08-21 16:15:55 +00003509 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003510 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003511 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003512 rc = sqlite3ApiExit(db, rc);
3513 sqlite3_mutex_leave(db->mutex);
3514 return rc;
danielk19770202b292004-06-09 09:55:16 +00003515}
3516
drh6c626082004-11-14 21:56:29 +00003517#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003518/*
3519** Register a new collation sequence with the database handle db.
3520*/
danielk19770202b292004-06-09 09:55:16 +00003521int sqlite3_create_collation16(
3522 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003523 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003524 int enc,
danielk19770202b292004-06-09 09:55:16 +00003525 void* pCtx,
3526 int(*xCompare)(void*,int,const void*,int,const void*)
3527){
danielk19779a30cf62006-01-18 04:26:07 +00003528 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003529 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003530
3531#ifdef SQLITE_ENABLE_API_ARMOR
3532 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3533#endif
drhe30f4422007-08-21 16:15:55 +00003534 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003535 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003536 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003537 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003538 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003539 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003540 }
drhe30f4422007-08-21 16:15:55 +00003541 rc = sqlite3ApiExit(db, rc);
3542 sqlite3_mutex_leave(db->mutex);
3543 return rc;
danielk19770202b292004-06-09 09:55:16 +00003544}
drh6c626082004-11-14 21:56:29 +00003545#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003546
danielk1977d8123362004-06-12 09:25:12 +00003547/*
3548** Register a collation sequence factory callback with the database handle
3549** db. Replace any previously installed collation sequence factory.
3550*/
danielk19777cedc8d2004-06-10 10:50:08 +00003551int sqlite3_collation_needed(
3552 sqlite3 *db,
3553 void *pCollNeededArg,
3554 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3555){
drh9ca95732014-10-24 00:35:58 +00003556#ifdef SQLITE_ENABLE_API_ARMOR
3557 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3558#endif
drhe30f4422007-08-21 16:15:55 +00003559 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003560 db->xCollNeeded = xCollNeeded;
3561 db->xCollNeeded16 = 0;
3562 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003563 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003564 return SQLITE_OK;
3565}
danielk1977d8123362004-06-12 09:25:12 +00003566
drh6c626082004-11-14 21:56:29 +00003567#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003568/*
3569** Register a collation sequence factory callback with the database handle
3570** db. Replace any previously installed collation sequence factory.
3571*/
danielk19777cedc8d2004-06-10 10:50:08 +00003572int sqlite3_collation_needed16(
3573 sqlite3 *db,
3574 void *pCollNeededArg,
3575 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3576){
drh9ca95732014-10-24 00:35:58 +00003577#ifdef SQLITE_ENABLE_API_ARMOR
3578 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3579#endif
drhe30f4422007-08-21 16:15:55 +00003580 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003581 db->xCollNeeded = 0;
3582 db->xCollNeeded16 = xCollNeeded16;
3583 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003584 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003585 return SQLITE_OK;
3586}
drh6c626082004-11-14 21:56:29 +00003587#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003588
shaneeec556d2008-10-12 00:27:53 +00003589#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003590/*
danielk19777ddad962005-12-12 06:53:03 +00003591** This function is now an anachronism. It used to be used to recover from a
3592** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003593*/
drh7d97efb2007-10-12 19:35:48 +00003594int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003595 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003596}
3597#endif
drh3e1d8e62005-05-26 16:23:34 +00003598
3599/*
3600** Test to see whether or not the database connection is in autocommit
3601** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3602** by default. Autocommit is disabled by a BEGIN statement and reenabled
3603** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003604*/
3605int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003606#ifdef SQLITE_ENABLE_API_ARMOR
3607 if( !sqlite3SafetyCheckOk(db) ){
3608 (void)SQLITE_MISUSE_BKPT;
3609 return 0;
3610 }
3611#endif
drh3e1d8e62005-05-26 16:23:34 +00003612 return db->autoCommit;
3613}
drh49285702005-09-17 15:20:26 +00003614
drh49285702005-09-17 15:20:26 +00003615/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003616** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003617** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003618** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003619**
3620** 1. Serve as a convenient place to set a breakpoint in a debugger
3621** to detect when version error conditions occurs.
3622**
3623** 2. Invoke sqlite3_log() to provide the source code location where
3624** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003625*/
daneebf2f52017-11-18 17:30:08 +00003626int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003627 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3628 zType, lineno, 20+sqlite3_sourceid());
3629 return iErr;
3630}
drh9978c972010-02-23 17:36:32 +00003631int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003632 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003633 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003634}
drh9978c972010-02-23 17:36:32 +00003635int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003636 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003637 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003638}
3639int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003640 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003641 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003642}
dan3cdc8202020-02-04 20:01:44 +00003643#if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO)
drhcc97ca42017-06-07 22:32:59 +00003644int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3645 char zMsg[100];
3646 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3647 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003648 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003649}
dan3cdc8202020-02-04 20:01:44 +00003650#endif
3651#ifdef SQLITE_DEBUG
mistachkinfad30392016-02-13 23:43:46 +00003652int sqlite3NomemError(int lineno){
3653 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003654 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003655}
3656int sqlite3IoerrnomemError(int lineno){
3657 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003658 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003659}
drh32c49902016-02-15 18:15:15 +00003660#endif
drh7c1817e2006-01-10 13:58:48 +00003661
shaneeec556d2008-10-12 00:27:53 +00003662#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003663/*
3664** This is a convenience routine that makes sure that all thread-specific
3665** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003666**
3667** SQLite no longer uses thread-specific data so this routine is now a
3668** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003669*/
3670void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003671}
shaneeec556d2008-10-12 00:27:53 +00003672#endif
danielk1977deb802c2006-02-09 13:43:28 +00003673
3674/*
3675** Return meta information about a specific column of a database table.
3676** See comment in sqlite3.h (sqlite.h.in) for details.
3677*/
danielk1977deb802c2006-02-09 13:43:28 +00003678int sqlite3_table_column_metadata(
3679 sqlite3 *db, /* Connection handle */
3680 const char *zDbName, /* Database name or NULL */
3681 const char *zTableName, /* Table name */
3682 const char *zColumnName, /* Column name */
3683 char const **pzDataType, /* OUTPUT: Declared data type */
3684 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3685 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3686 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003687 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003688){
3689 int rc;
3690 char *zErrMsg = 0;
3691 Table *pTab = 0;
3692 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003693 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003694 char const *zDataType = 0;
3695 char const *zCollSeq = 0;
3696 int notnull = 0;
3697 int primarykey = 0;
3698 int autoinc = 0;
3699
drh96c707a2015-02-13 16:36:14 +00003700
3701#ifdef SQLITE_ENABLE_API_ARMOR
3702 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3703 return SQLITE_MISUSE_BKPT;
3704 }
3705#endif
3706
danielk1977deb802c2006-02-09 13:43:28 +00003707 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003708 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003709 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003710 rc = sqlite3Init(db, &zErrMsg);
3711 if( SQLITE_OK!=rc ){
3712 goto error_out;
3713 }
3714
3715 /* Locate the table in question */
3716 pTab = sqlite3FindTable(db, zTableName, zDbName);
3717 if( !pTab || pTab->pSelect ){
3718 pTab = 0;
3719 goto error_out;
3720 }
3721
3722 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003723 if( zColumnName==0 ){
3724 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003725 }else{
3726 for(iCol=0; iCol<pTab->nCol; iCol++){
3727 pCol = &pTab->aCol[iCol];
3728 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3729 break;
3730 }
3731 }
3732 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003733 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3734 iCol = pTab->iPKey;
3735 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3736 }else{
3737 pTab = 0;
3738 goto error_out;
3739 }
danielk1977deb802c2006-02-09 13:43:28 +00003740 }
3741 }
3742
3743 /* The following block stores the meta information that will be returned
3744 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3745 ** and autoinc. At this point there are two possibilities:
3746 **
3747 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3748 ** and there is no explicitly declared IPK column.
3749 **
3750 ** 2. The table is not a view and the column name identified an
3751 ** explicitly declared column. Copy meta information from *pCol.
3752 */
3753 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003754 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003755 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003756 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003757 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003758 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003759 }else{
3760 zDataType = "INTEGER";
3761 primarykey = 1;
3762 }
3763 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003764 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003765 }
3766
3767error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003768 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003769
3770 /* Whether the function call succeeded or failed, set the output parameters
3771 ** to whatever their local counterparts contain. If an error did occur,
3772 ** this has the effect of zeroing all output parameters.
3773 */
3774 if( pzDataType ) *pzDataType = zDataType;
3775 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3776 if( pNotNull ) *pNotNull = notnull;
3777 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3778 if( pAutoinc ) *pAutoinc = autoinc;
3779
3780 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003781 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003782 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003783 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003784 rc = SQLITE_ERROR;
3785 }
drh13f40da2014-08-22 18:00:11 +00003786 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003787 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003788 rc = sqlite3ApiExit(db, rc);
3789 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003790 return rc;
3791}
3792
3793/*
3794** Sleep for a little while. Return the amount of time slept.
3795*/
3796int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003797 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003798 int rc;
drhd677b3d2007-08-20 22:48:41 +00003799 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003800 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003801
3802 /* This function works in milliseconds, but the underlying OsSleep()
3803 ** API uses microseconds. Hence the 1000's.
3804 */
drhe30f4422007-08-21 16:15:55 +00003805 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003806 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003807}
drh4ac285a2006-09-15 07:28:50 +00003808
3809/*
3810** Enable or disable the extended result codes.
3811*/
3812int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003813#ifdef SQLITE_ENABLE_API_ARMOR
3814 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3815#endif
drhe30f4422007-08-21 16:15:55 +00003816 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003817 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003818 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003819 return SQLITE_OK;
3820}
drhcc6bb3e2007-08-31 16:11:35 +00003821
3822/*
3823** Invoke the xFileControl method on a particular database.
3824*/
3825int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3826 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003827 Btree *pBtree;
3828
drh9ca95732014-10-24 00:35:58 +00003829#ifdef SQLITE_ENABLE_API_ARMOR
3830 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3831#endif
drhcc6bb3e2007-08-31 16:11:35 +00003832 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003833 pBtree = sqlite3DbNameToBtree(db, zDbName);
3834 if( pBtree ){
3835 Pager *pPager;
3836 sqlite3_file *fd;
3837 sqlite3BtreeEnter(pBtree);
3838 pPager = sqlite3BtreePager(pBtree);
3839 assert( pPager!=0 );
3840 fd = sqlite3PagerFile(pPager);
3841 assert( fd!=0 );
3842 if( op==SQLITE_FCNTL_FILE_POINTER ){
3843 *(sqlite3_file**)pArg = fd;
3844 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003845 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3846 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3847 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003848 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3849 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3850 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003851 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3852 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3853 rc = SQLITE_OK;
drh45248de2020-04-20 15:18:43 +00003854 }else if( op==SQLITE_FCNTL_RESERVE_BYTES ){
3855 int iNew = *(int*)pArg;
3856 *(int*)pArg = sqlite3BtreeGetRequestedReserve(pBtree);
drhe937df82020-05-07 01:56:57 +00003857 if( iNew>=0 && iNew<=255 ){
drh45248de2020-04-20 15:18:43 +00003858 sqlite3BtreeSetPageSize(pBtree, 0, iNew, 0);
3859 }
3860 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003861 }else{
drhafb39a42018-03-29 13:47:01 +00003862 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003863 }
drh421377e2012-03-15 21:28:54 +00003864 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003865 }
3866 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003867 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003868}
drhed13d982008-01-31 14:43:24 +00003869
3870/*
3871** Interface to the testing logic.
3872*/
3873int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003874 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003875#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003876 UNUSED_PARAMETER(op);
3877#else
drh2fa18682008-03-19 14:15:34 +00003878 va_list ap;
drhed13d982008-01-31 14:43:24 +00003879 va_start(ap, op);
3880 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003881
3882 /*
drh984bfaa2008-03-19 16:08:53 +00003883 ** Save the current state of the PRNG.
3884 */
drh2fa18682008-03-19 14:15:34 +00003885 case SQLITE_TESTCTRL_PRNG_SAVE: {
3886 sqlite3PrngSaveState();
3887 break;
3888 }
drh984bfaa2008-03-19 16:08:53 +00003889
3890 /*
3891 ** Restore the state of the PRNG to the last state saved using
3892 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3893 ** this verb acts like PRNG_RESET.
3894 */
drh2fa18682008-03-19 14:15:34 +00003895 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3896 sqlite3PrngRestoreState();
3897 break;
3898 }
drh984bfaa2008-03-19 16:08:53 +00003899
drh2e6d83b2019-08-03 01:39:20 +00003900 /* sqlite3_test_control(SQLITE_TESTCTRL_PRNG_SEED, int x, sqlite3 *db);
drhade54d62019-08-02 20:45:04 +00003901 **
drh2e6d83b2019-08-03 01:39:20 +00003902 ** Control the seed for the pseudo-random number generator (PRNG) that
3903 ** is built into SQLite. Cases:
3904 **
3905 ** x!=0 && db!=0 Seed the PRNG to the current value of the
3906 ** schema cookie in the main database for db, or
3907 ** x if the schema cookie is zero. This case
3908 ** is convenient to use with database fuzzers
3909 ** as it allows the fuzzer some control over the
3910 ** the PRNG seed.
3911 **
3912 ** x!=0 && db==0 Seed the PRNG to the value of x.
3913 **
3914 ** x==0 && db==0 Revert to default behavior of using the
3915 ** xRandomness method on the primary VFS.
3916 **
3917 ** This test-control also resets the PRNG so that the new seed will
3918 ** be used for the next call to sqlite3_randomness().
drh984bfaa2008-03-19 16:08:53 +00003919 */
drhef9f7192020-01-17 19:14:08 +00003920#ifndef SQLITE_OMIT_WSD
drhade54d62019-08-02 20:45:04 +00003921 case SQLITE_TESTCTRL_PRNG_SEED: {
drh2e6d83b2019-08-03 01:39:20 +00003922 int x = va_arg(ap, int);
3923 int y;
3924 sqlite3 *db = va_arg(ap, sqlite3*);
3925 assert( db==0 || db->aDb[0].pSchema!=0 );
3926 if( db && (y = db->aDb[0].pSchema->schema_cookie)!=0 ){ x = y; }
3927 sqlite3Config.iPrngSeed = x;
3928 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003929 break;
3930 }
drhef9f7192020-01-17 19:14:08 +00003931#endif
drh3088d592008-03-21 16:45:47 +00003932
3933 /*
3934 ** sqlite3_test_control(BITVEC_TEST, size, program)
3935 **
3936 ** Run a test against a Bitvec object of size. The program argument
3937 ** is an array of integers that defines the test. Return -1 on a
3938 ** memory allocation error, 0 on success, or non-zero for an error.
3939 ** See the sqlite3BitvecBuiltinTest() for additional information.
3940 */
3941 case SQLITE_TESTCTRL_BITVEC_TEST: {
3942 int sz = va_arg(ap, int);
3943 int *aProg = va_arg(ap, int*);
3944 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3945 break;
3946 }
danielk19772d1d86f2008-06-20 14:59:51 +00003947
3948 /*
drhc007f612014-05-16 14:17:01 +00003949 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3950 **
3951 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3952 ** if xCallback is not NULL.
3953 **
3954 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3955 ** is called immediately after installing the new callback and the return
3956 ** value from sqlite3FaultSim(0) becomes the return from
3957 ** sqlite3_test_control().
3958 */
3959 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003960 /* MSVC is picky about pulling func ptrs from va lists.
3961 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003962 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003963 */
3964 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003965 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003966 rc = sqlite3FaultSim(0);
3967 break;
3968 }
3969
3970 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003971 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3972 **
3973 ** Register hooks to call to indicate which malloc() failures
3974 ** are benign.
3975 */
3976 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003977 typedef void (*void_function)(void);
3978 void_function xBenignBegin;
3979 void_function xBenignEnd;
3980 xBenignBegin = va_arg(ap, void_function);
3981 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003982 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3983 break;
3984 }
drhc7a3bb92009-02-05 16:31:45 +00003985
3986 /*
drhf3af63f2009-05-09 18:59:42 +00003987 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003988 **
3989 ** Set the PENDING byte to the value in the argument, if X>0.
3990 ** Make no changes if X==0. Return the value of the pending byte
3991 ** as it existing before this routine was called.
3992 **
3993 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3994 ** an incompatible database file format. Changing the PENDING byte
3995 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003996 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003997 */
3998 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003999 rc = PENDING_BYTE;
4000#ifndef SQLITE_OMIT_WSD
4001 {
4002 unsigned int newVal = va_arg(ap, unsigned int);
4003 if( newVal ) sqlite3PendingByte = newVal;
4004 }
4005#endif
drhc7a3bb92009-02-05 16:31:45 +00004006 break;
4007 }
drhf3af63f2009-05-09 18:59:42 +00004008
4009 /*
4010 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
4011 **
4012 ** This action provides a run-time test to see whether or not
4013 ** assert() was enabled at compile-time. If X is true and assert()
4014 ** is enabled, then the return value is true. If X is true and
4015 ** assert() is disabled, then the return value is zero. If X is
4016 ** false and assert() is enabled, then the assertion fires and the
4017 ** process aborts. If X is false and assert() is disabled, then the
4018 ** return value is zero.
4019 */
4020 case SQLITE_TESTCTRL_ASSERT: {
4021 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00004022 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00004023 rc = x;
4024 break;
4025 }
4026
4027
4028 /*
4029 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
4030 **
4031 ** This action provides a run-time test to see how the ALWAYS and
4032 ** NEVER macros were defined at compile-time.
4033 **
drhce2c4822017-10-03 17:17:34 +00004034 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00004035 **
4036 ** The recommended test is X==2. If the return value is 2, that means
4037 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
4038 ** default setting. If the return value is 1, then ALWAYS() is either
4039 ** hard-coded to true or else it asserts if its argument is false.
4040 ** The first behavior (hard-coded to true) is the case if
4041 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
4042 ** behavior (assert if the argument to ALWAYS() is false) is the case if
4043 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
4044 **
4045 ** The run-time test procedure might look something like this:
4046 **
4047 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
4048 ** // ALWAYS() and NEVER() are no-op pass-through macros
4049 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
4050 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
4051 ** }else{
4052 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
4053 ** }
4054 */
4055 case SQLITE_TESTCTRL_ALWAYS: {
4056 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00004057 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00004058 break;
4059 }
drhc046e3e2009-07-15 11:26:44 +00004060
drh2cf4acb2014-04-18 00:06:02 +00004061 /*
4062 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
4063 **
4064 ** The integer returned reveals the byte-order of the computer on which
4065 ** SQLite is running:
4066 **
4067 ** 1 big-endian, determined at run-time
4068 ** 10 little-endian, determined at run-time
4069 ** 432101 big-endian, determined at compile-time
4070 ** 123410 little-endian, determined at compile-time
4071 */
4072 case SQLITE_TESTCTRL_BYTEORDER: {
4073 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
4074 break;
4075 }
4076
drh07096f62009-12-22 23:52:32 +00004077 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
4078 **
4079 ** Enable or disable various optimizations for testing purposes. The
4080 ** argument N is a bitmask of optimizations to be disabled. For normal
4081 ** operation N should be 0. The idea is that a test program (like the
4082 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
4083 ** with various optimizations disabled to verify that the same answer
4084 ** is obtained in every case.
4085 */
4086 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
4087 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00004088 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00004089 break;
4090 }
4091
danc17d6962011-06-21 12:47:30 +00004092 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
4093 **
drheea8eb62018-11-26 18:09:15 +00004094 ** If parameter onoff is non-zero, subsequent calls to localtime()
4095 ** and its variants fail. If onoff is zero, undo this setting.
danc17d6962011-06-21 12:47:30 +00004096 */
4097 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
4098 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
4099 break;
4100 }
4101
drh171c50e2020-01-01 15:43:30 +00004102 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCTIONS, sqlite3*);
drheea8eb62018-11-26 18:09:15 +00004103 **
drh171c50e2020-01-01 15:43:30 +00004104 ** Toggle the ability to use internal functions on or off for
4105 ** the database connection given in the argument.
drheea8eb62018-11-26 18:09:15 +00004106 */
4107 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
drh171c50e2020-01-01 15:43:30 +00004108 sqlite3 *db = va_arg(ap, sqlite3*);
4109 db->mDbFlags ^= DBFLAG_InternalFunc;
drheea8eb62018-11-26 18:09:15 +00004110 break;
4111 }
4112
drh09fe6142013-11-29 15:06:27 +00004113 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4114 **
4115 ** Set or clear a flag that indicates that the database file is always well-
4116 ** formed and never corrupt. This flag is clear by default, indicating that
4117 ** database files might have arbitrary corruption. Setting the flag during
4118 ** testing causes certain assert() statements in the code to be activated
4119 ** that demonstrat invariants on well-formed database files.
4120 */
4121 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00004122 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00004123 break;
4124 }
4125
drh30842992019-08-12 14:17:43 +00004126 /* sqlite3_test_control(SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS, int);
4127 **
4128 ** Set or clear a flag that causes SQLite to verify that type, name,
4129 ** and tbl_name fields of the sqlite_master table. This is normally
4130 ** on, but it is sometimes useful to turn it off for testing.
4131 */
4132 case SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS: {
4133 sqlite3GlobalConfig.bExtraSchemaChecks = va_arg(ap, int);
4134 break;
4135 }
4136
drh9e5eb9c2016-09-18 16:08:10 +00004137 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00004138 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004139 ** too big to test in a reasonable amount of time, so this control is
4140 ** provided to set a small and easily reachable reset value.
4141 */
4142 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4143 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4144 break;
4145 }
drh688852a2014-02-17 22:40:43 +00004146
4147 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4148 **
4149 ** Set the VDBE coverage callback function to xCallback with context
4150 ** pointer ptr.
4151 */
4152 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4153#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00004154 typedef void (*branch_callback)(void*,unsigned int,
4155 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00004156 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4157 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4158#endif
4159 break;
4160 }
4161
dan8930c2a2014-04-03 16:25:29 +00004162 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4163 case SQLITE_TESTCTRL_SORTER_MMAP: {
4164 sqlite3 *db = va_arg(ap, sqlite3*);
4165 db->nMaxSorterMmap = va_arg(ap, int);
4166 break;
4167 }
4168
drh43cfc232014-07-29 14:09:21 +00004169 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4170 **
4171 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4172 ** not.
4173 */
4174 case SQLITE_TESTCTRL_ISINIT: {
4175 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4176 break;
4177 }
drh8964b342015-01-29 17:54:52 +00004178
drh3ba689d2015-03-03 14:00:11 +00004179 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004180 **
drh1ffede82015-01-30 20:59:27 +00004181 ** This test control is used to create imposter tables. "db" is a pointer
4182 ** to the database connection. dbName is the database name (ex: "main" or
4183 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4184 ** or off. "tnum" is the root page of the b-tree to which the imposter
4185 ** table should connect.
4186 **
4187 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004188 ** run a single CREATE TABLE statement to construct the imposter table in
4189 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004190 **
4191 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4192 ** the schema to be reparsed the next time it is needed. This has the
4193 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004194 */
drh1ffede82015-01-30 20:59:27 +00004195 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004196 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004197 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004198 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4199 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004200 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004201 if( db->init.busy==0 && db->init.newTnum>0 ){
4202 sqlite3ResetAllSchemasOfConnection(db);
4203 }
drh8fb15e32015-02-04 20:56:49 +00004204 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004205 break;
4206 }
drh0d9de992017-12-26 18:04:23 +00004207
4208#if defined(YYCOVERAGE)
4209 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4210 **
4211 ** This test control (only available when SQLite is compiled with
4212 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4213 ** state/lookahead combinations in the parser state machine
4214 ** which are never exercised. If any state is missed, make the
4215 ** return code SQLITE_ERROR.
4216 */
4217 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4218 FILE *out = va_arg(ap, FILE*);
4219 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4220 break;
4221 }
4222#endif /* defined(YYCOVERAGE) */
drh0c8f4032019-05-03 21:17:28 +00004223
4224 /* sqlite3_test_control(SQLITE_TESTCTRL_RESULT_INTREAL, sqlite3_context*);
4225 **
4226 ** This test-control causes the most recent sqlite3_result_int64() value
4227 ** to be interpreted as a MEM_IntReal instead of as an MEM_Int. Normally,
4228 ** MEM_IntReal values only arise during an INSERT operation of integer
4229 ** values into a REAL column, so they can be challenging to test. This
4230 ** test-control enables us to write an intreal() SQL function that can
4231 ** inject an intreal() value at arbitrary places in an SQL statement,
4232 ** for testing purposes.
4233 */
4234 case SQLITE_TESTCTRL_RESULT_INTREAL: {
4235 sqlite3_context *pCtx = va_arg(ap, sqlite3_context*);
4236 sqlite3ResultIntReal(pCtx);
4237 break;
4238 }
drhed13d982008-01-31 14:43:24 +00004239 }
4240 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004241#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004242 return rc;
drhed13d982008-01-31 14:43:24 +00004243}
drhcc487d12011-05-17 18:53:08 +00004244
4245/*
drh532b0d22020-01-27 14:40:44 +00004246** The Pager stores the Database filename, Journal filename, and WAL filename
4247** consecutively in memory, in that order. The database filename is prefixed
4248** by four zero bytes. Locate the start of the database filename by searching
4249** backwards for the first byte following four consecutive zero bytes.
4250**
4251** This only works if the filename passed in was obtained from the Pager.
4252*/
4253static const char *databaseName(const char *zName){
4254 while( zName[-1]!=0 || zName[-2]!=0 || zName[-3]!=0 || zName[-4]!=0 ){
4255 zName--;
4256 }
4257 return zName;
4258}
4259
4260/*
drh4defddd2020-02-18 19:49:48 +00004261** Append text z[] to the end of p[]. Return a pointer to the first
4262** character after then zero terminator on the new text in p[].
4263*/
4264static char *appendText(char *p, const char *z){
4265 size_t n = strlen(z);
4266 memcpy(p, z, n+1);
4267 return p+n+1;
4268}
4269
4270/*
4271** Allocate memory to hold names for a database, journal file, WAL file,
4272** and query parameters. The pointer returned is valid for use by
4273** sqlite3_filename_database() and sqlite3_uri_parameter() and related
4274** functions.
4275**
4276** Memory layout must be compatible with that generated by the pager
4277** and expected by sqlite3_uri_parameter() and databaseName().
4278*/
4279char *sqlite3_create_filename(
4280 const char *zDatabase,
4281 const char *zJournal,
4282 const char *zWal,
4283 int nParam,
4284 const char **azParam
4285){
4286 sqlite3_int64 nByte;
4287 int i;
4288 char *pResult, *p;
4289 nByte = strlen(zDatabase) + strlen(zJournal) + strlen(zWal) + 10;
4290 for(i=0; i<nParam*2; i++){
4291 nByte += strlen(azParam[i])+1;
4292 }
4293 pResult = p = sqlite3_malloc64( nByte );
4294 if( p==0 ) return 0;
4295 memset(p, 0, 4);
4296 p += 4;
4297 p = appendText(p, zDatabase);
4298 for(i=0; i<nParam*2; i++){
4299 p = appendText(p, azParam[i]);
4300 }
4301 *(p++) = 0;
4302 p = appendText(p, zJournal);
4303 p = appendText(p, zWal);
4304 *(p++) = 0;
4305 *(p++) = 0;
4306 assert( (sqlite3_int64)(p - pResult)==nByte );
4307 return pResult + 4;
4308}
4309
4310/*
4311** Free memory obtained from sqlite3_create_filename(). It is a severe
4312** error to call this routine with any parameter other than a pointer
4313** previously obtained from sqlite3_create_filename() or a NULL pointer.
4314*/
4315void sqlite3_free_filename(char *p){
4316 if( p==0 ) return;
4317 p = (char*)databaseName(p);
4318 sqlite3_free(p - 4);
4319}
4320
4321
4322/*
drhcc487d12011-05-17 18:53:08 +00004323** This is a utility routine, useful to VFS implementations, that checks
4324** to see if a database file was a URI that contained a specific query
4325** parameter, and if so obtains the value of the query parameter.
4326**
4327** The zFilename argument is the filename pointer passed into the xOpen()
4328** method of a VFS implementation. The zParam argument is the name of the
4329** query parameter we seek. This routine returns the value of the zParam
4330** parameter if it exists. If the parameter does not exist, this routine
4331** returns a NULL pointer.
4332*/
4333const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004334 if( zFilename==0 || zParam==0 ) return 0;
drh532b0d22020-01-27 14:40:44 +00004335 zFilename = databaseName(zFilename);
drh1eac9662020-02-01 13:30:39 +00004336 return uriParameter(zFilename, zParam);
drhcc487d12011-05-17 18:53:08 +00004337}
drh283829c2011-11-17 00:56:20 +00004338
4339/*
drh80804032020-01-11 16:08:31 +00004340** Return a pointer to the name of Nth query parameter of the filename.
4341*/
4342const char *sqlite3_uri_key(const char *zFilename, int N){
4343 if( zFilename==0 || N<0 ) return 0;
drh532b0d22020-01-27 14:40:44 +00004344 zFilename = databaseName(zFilename);
drh80804032020-01-11 16:08:31 +00004345 zFilename += sqlite3Strlen30(zFilename) + 1;
4346 while( zFilename[0] && (N--)>0 ){
4347 zFilename += sqlite3Strlen30(zFilename) + 1;
4348 zFilename += sqlite3Strlen30(zFilename) + 1;
4349 }
4350 return zFilename[0] ? zFilename : 0;
4351}
4352
4353/*
drh92913722011-12-23 00:07:33 +00004354** Return a boolean value for a query parameter.
4355*/
4356int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4357 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004358 bDflt = bDflt!=0;
4359 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004360}
4361
4362/*
4363** Return a 64-bit integer value for a query parameter.
4364*/
4365sqlite3_int64 sqlite3_uri_int64(
4366 const char *zFilename, /* Filename as passed to xOpen */
4367 const char *zParam, /* URI parameter sought */
4368 sqlite3_int64 bDflt /* return if parameter is missing */
4369){
4370 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4371 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004372 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004373 bDflt = v;
4374 }
4375 return bDflt;
4376}
4377
4378/*
drh8875b9e2020-01-10 18:05:55 +00004379** Translate a filename that was handed to a VFS routine into the corresponding
4380** database, journal, or WAL file.
4381**
4382** It is an error to pass this routine a filename string that was not
4383** passed into the VFS from the SQLite core. Doing so is similar to
4384** passing free() a pointer that was not obtained from malloc() - it is
4385** an error that we cannot easily detect but that will likely cause memory
4386** corruption.
4387*/
4388const char *sqlite3_filename_database(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004389 return databaseName(zFilename);
drh8875b9e2020-01-10 18:05:55 +00004390}
4391const char *sqlite3_filename_journal(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004392 zFilename = databaseName(zFilename);
4393 zFilename += sqlite3Strlen30(zFilename) + 1;
4394 while( zFilename[0] ){
4395 zFilename += sqlite3Strlen30(zFilename) + 1;
4396 zFilename += sqlite3Strlen30(zFilename) + 1;
4397 }
4398 return zFilename + 1;
drh8875b9e2020-01-10 18:05:55 +00004399}
4400const char *sqlite3_filename_wal(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004401#ifdef SQLITE_OMIT_WAL
4402 return 0;
4403#else
4404 zFilename = sqlite3_filename_journal(zFilename);
4405 zFilename += sqlite3Strlen30(zFilename) + 1;
4406 return zFilename;
4407#endif
drh8875b9e2020-01-10 18:05:55 +00004408}
4409
4410/*
drh421377e2012-03-15 21:28:54 +00004411** Return the Btree pointer identified by zDbName. Return NULL if not found.
4412*/
4413Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004414 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4415 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004416}
4417
4418/*
drh283829c2011-11-17 00:56:20 +00004419** Return the filename of the database associated with a database
4420** connection.
4421*/
4422const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004423 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004424#ifdef SQLITE_ENABLE_API_ARMOR
4425 if( !sqlite3SafetyCheckOk(db) ){
4426 (void)SQLITE_MISUSE_BKPT;
4427 return 0;
4428 }
4429#endif
mistachkincd54bab2014-12-20 21:14:14 +00004430 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004431 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4432}
4433
4434/*
4435** Return 1 if database is read-only or 0 if read/write. Return -1 if
4436** no such database exists.
4437*/
4438int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004439 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004440#ifdef SQLITE_ENABLE_API_ARMOR
4441 if( !sqlite3SafetyCheckOk(db) ){
4442 (void)SQLITE_MISUSE_BKPT;
4443 return -1;
4444 }
4445#endif
mistachkincd54bab2014-12-20 21:14:14 +00004446 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004447 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004448}
danfc1acf32015-12-05 20:51:54 +00004449
4450#ifdef SQLITE_ENABLE_SNAPSHOT
4451/*
4452** Obtain a snapshot handle for the snapshot of database zDb currently
4453** being read by handle db.
4454*/
4455int sqlite3_snapshot_get(
4456 sqlite3 *db,
4457 const char *zDb,
4458 sqlite3_snapshot **ppSnapshot
4459){
4460 int rc = SQLITE_ERROR;
4461#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004462
4463#ifdef SQLITE_ENABLE_API_ARMOR
4464 if( !sqlite3SafetyCheckOk(db) ){
4465 return SQLITE_MISUSE_BKPT;
4466 }
4467#endif
4468 sqlite3_mutex_enter(db->mutex);
4469
danedace5d2016-11-18 18:43:39 +00004470 if( db->autoCommit==0 ){
4471 int iDb = sqlite3FindDbName(db, zDb);
4472 if( iDb==0 || iDb>1 ){
4473 Btree *pBt = db->aDb[iDb].pBt;
4474 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004475 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004476 if( rc==SQLITE_OK ){
4477 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4478 }
dan7116dc62015-12-10 20:03:08 +00004479 }
danfc1acf32015-12-05 20:51:54 +00004480 }
4481 }
4482
4483 sqlite3_mutex_leave(db->mutex);
4484#endif /* SQLITE_OMIT_WAL */
4485 return rc;
4486}
4487
4488/*
4489** Open a read-transaction on the snapshot idendified by pSnapshot.
4490*/
4491int sqlite3_snapshot_open(
4492 sqlite3 *db,
4493 const char *zDb,
4494 sqlite3_snapshot *pSnapshot
4495){
4496 int rc = SQLITE_ERROR;
4497#ifndef SQLITE_OMIT_WAL
4498
4499#ifdef SQLITE_ENABLE_API_ARMOR
4500 if( !sqlite3SafetyCheckOk(db) ){
4501 return SQLITE_MISUSE_BKPT;
4502 }
4503#endif
4504 sqlite3_mutex_enter(db->mutex);
4505 if( db->autoCommit==0 ){
4506 int iDb;
4507 iDb = sqlite3FindDbName(db, zDb);
4508 if( iDb==0 || iDb>1 ){
4509 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004510 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4511 Pager *pPager = sqlite3BtreePager(pBt);
4512 int bUnlock = 0;
4513 if( sqlite3BtreeIsInReadTrans(pBt) ){
4514 if( db->nVdbeActive==0 ){
4515 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4516 if( rc==SQLITE_OK ){
4517 bUnlock = 1;
4518 rc = sqlite3BtreeCommit(pBt);
4519 }
4520 }
4521 }else{
4522 rc = SQLITE_OK;
4523 }
4524 if( rc==SQLITE_OK ){
4525 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4526 }
danfc1acf32015-12-05 20:51:54 +00004527 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004528 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danfa3d4c12018-08-06 17:12:36 +00004529 sqlite3PagerSnapshotOpen(pPager, 0);
4530 }
4531 if( bUnlock ){
4532 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004533 }
4534 }
4535 }
4536 }
4537
4538 sqlite3_mutex_leave(db->mutex);
4539#endif /* SQLITE_OMIT_WAL */
4540 return rc;
4541}
4542
4543/*
dan11584982016-11-18 20:49:43 +00004544** Recover as many snapshots as possible from the wal file associated with
4545** schema zDb of database db.
4546*/
4547int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4548 int rc = SQLITE_ERROR;
4549 int iDb;
4550#ifndef SQLITE_OMIT_WAL
4551
4552#ifdef SQLITE_ENABLE_API_ARMOR
4553 if( !sqlite3SafetyCheckOk(db) ){
4554 return SQLITE_MISUSE_BKPT;
4555 }
4556#endif
4557
4558 sqlite3_mutex_enter(db->mutex);
4559 iDb = sqlite3FindDbName(db, zDb);
4560 if( iDb==0 || iDb>1 ){
4561 Btree *pBt = db->aDb[iDb].pBt;
4562 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004563 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004564 if( rc==SQLITE_OK ){
4565 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4566 sqlite3BtreeCommit(pBt);
4567 }
dan11584982016-11-18 20:49:43 +00004568 }
4569 }
4570 sqlite3_mutex_leave(db->mutex);
4571#endif /* SQLITE_OMIT_WAL */
4572 return rc;
4573}
4574
4575/*
danfc1acf32015-12-05 20:51:54 +00004576** Free a snapshot handle obtained from sqlite3_snapshot_get().
4577*/
4578void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4579 sqlite3_free(pSnapshot);
4580}
4581#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004582
4583#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4584/*
4585** Given the name of a compile-time option, return true if that option
4586** was used and false if not.
4587**
4588** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4589** is not required for a match.
4590*/
4591int sqlite3_compileoption_used(const char *zOptName){
4592 int i, n;
4593 int nOpt;
4594 const char **azCompileOpt;
4595
4596#if SQLITE_ENABLE_API_ARMOR
4597 if( zOptName==0 ){
4598 (void)SQLITE_MISUSE_BKPT;
4599 return 0;
4600 }
4601#endif
4602
4603 azCompileOpt = sqlite3CompileOptions(&nOpt);
4604
4605 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4606 n = sqlite3Strlen30(zOptName);
4607
4608 /* Since nOpt is normally in single digits, a linear search is
4609 ** adequate. No need for a binary search. */
4610 for(i=0; i<nOpt; i++){
4611 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4612 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4613 ){
4614 return 1;
4615 }
4616 }
4617 return 0;
4618}
4619
4620/*
4621** Return the N-th compile-time option string. If N is out of range,
4622** return a NULL pointer.
4623*/
4624const char *sqlite3_compileoption_get(int N){
4625 int nOpt;
4626 const char **azCompileOpt;
4627 azCompileOpt = sqlite3CompileOptions(&nOpt);
4628 if( N>=0 && N<nOpt ){
4629 return azCompileOpt[N];
4630 }
4631 return 0;
4632}
4633#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */