blob: 6056478519e3f10f12094cc2ae3b0d51b5315109 [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.
drhccb21132020-06-19 11:34:57 +0000244 ** This operation is protected by the STATIC_MAIN mutex. Note that
drh93ed56d2008-08-12 15:21:11 +0000245 ** 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 */
drhccb21132020-06-19 11:34:57 +0000249 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN); )
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);
drhc4842882020-05-16 16:23:48 +0000316 sqlite3MemoryBarrier();
drh0bf9f7b2009-04-17 16:54:22 +0000317 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000318#ifdef SQLITE_EXTRA_INIT
319 bRunExtraInit = 1;
320#endif
danielk19778c0a7912008-08-20 14:49:23 +0000321 }
danielk1977502b4e02008-09-02 14:07:24 +0000322 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000323 }
danielk1977075c23a2008-09-01 18:34:20 +0000324 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000325
drh93ed56d2008-08-12 15:21:11 +0000326 /* Go back under the static mutex and clean up the recursive
327 ** mutex to prevent a resource leak.
328 */
329 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000330 sqlite3GlobalConfig.nRefInitMutex--;
331 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
332 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
333 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
334 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000335 }
336 sqlite3_mutex_leave(pMaster);
337
338 /* The following is just a sanity check to make sure SQLite has
339 ** been compiled correctly. It is important to run this code, but
340 ** we don't want to run it too often and soak up CPU cycles for no
341 ** reason. So we run it once during initialization.
342 */
shanedfb7b372008-07-22 05:13:30 +0000343#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000344#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000345 /* This section of code's only "output" is via assert() statements. */
drhac442f42018-01-03 01:28:46 +0000346 if( rc==SQLITE_OK ){
shanedfb7b372008-07-22 05:13:30 +0000347 u64 x = (((u64)1)<<63)-1;
348 double y;
349 assert(sizeof(x)==8);
350 assert(sizeof(x)==sizeof(y));
351 memcpy(&y, &x, 8);
352 assert( sqlite3IsNaN(y) );
353 }
354#endif
shanefbd60f82009-02-04 03:59:25 +0000355#endif
shanedfb7b372008-07-22 05:13:30 +0000356
drhe4cf0b32011-08-25 00:14:41 +0000357 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
358 ** compile-time option.
359 */
360#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000361 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000362 int SQLITE_EXTRA_INIT(const char*);
363 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000364 }
365#endif
366
drh40257ff2008-06-13 18:24:27 +0000367 return rc;
368}
369
370/*
371** Undo the effects of sqlite3_initialize(). Must not be called while
372** there are outstanding database connections or memory allocations or
373** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000374** routine is not threadsafe. But it is safe to invoke this routine
375** on when SQLite is already shut down. If SQLite is already shut down
376** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000377*/
378int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000379#ifdef SQLITE_OMIT_WSD
380 int rc = sqlite3_wsd_init(4096, 24);
381 if( rc!=SQLITE_OK ){
382 return rc;
383 }
384#endif
385
danielk1977075c23a2008-09-01 18:34:20 +0000386 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000387#ifdef SQLITE_EXTRA_SHUTDOWN
388 void SQLITE_EXTRA_SHUTDOWN(void);
389 SQLITE_EXTRA_SHUTDOWN();
390#endif
drha7640922009-04-21 12:02:56 +0000391 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000392 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000393 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000394 }
dane1ab2192009-08-17 15:16:19 +0000395 if( sqlite3GlobalConfig.isPCacheInit ){
396 sqlite3PcacheShutdown();
397 sqlite3GlobalConfig.isPCacheInit = 0;
398 }
399 if( sqlite3GlobalConfig.isMallocInit ){
400 sqlite3MallocEnd();
401 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000402
403#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
404 /* The heap subsystem has now been shutdown and these values are supposed
405 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
406 ** which would rely on that heap subsystem; therefore, make sure these
407 ** values cannot refer to heap memory that was just invalidated when the
408 ** heap subsystem was shutdown. This is only done if the current call to
409 ** this function resulted in the heap subsystem actually being shutdown.
410 */
411 sqlite3_data_directory = 0;
412 sqlite3_temp_directory = 0;
413#endif
dane1ab2192009-08-17 15:16:19 +0000414 }
415 if( sqlite3GlobalConfig.isMutexInit ){
416 sqlite3MutexEnd();
417 sqlite3GlobalConfig.isMutexInit = 0;
418 }
419
drh40257ff2008-06-13 18:24:27 +0000420 return SQLITE_OK;
421}
422
423/*
424** This API allows applications to modify the global configuration of
425** the SQLite library at run-time.
426**
427** This routine should only be called when there are no outstanding
428** database connections or memory allocations. This routine is not
429** threadsafe. Failure to heed these warnings can lead to unpredictable
430** behavior.
431*/
432int sqlite3_config(int op, ...){
433 va_list ap;
434 int rc = SQLITE_OK;
435
436 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
437 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000438 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000439
440 va_start(ap, op);
441 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000442
443 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000444 ** compile.
drh18472fa2008-10-07 15:25:48 +0000445 */
drhd1dcb232014-11-01 18:32:18 +0000446#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000447 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000448 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
449 ** Single-thread. */
450 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
451 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000452 break;
453 }
drhd1dcb232014-11-01 18:32:18 +0000454#endif
455#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000456 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000457 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
458 ** Multi-thread. */
459 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
460 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000461 break;
462 }
drhd1dcb232014-11-01 18:32:18 +0000463#endif
464#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000465 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000466 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
467 ** Serialized. */
468 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
469 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000470 break;
471 }
drhd1dcb232014-11-01 18:32:18 +0000472#endif
473#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000474 case SQLITE_CONFIG_MUTEX: {
475 /* Specify an alternative mutex implementation */
476 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
477 break;
478 }
drhd1dcb232014-11-01 18:32:18 +0000479#endif
480#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000481 case SQLITE_CONFIG_GETMUTEX: {
482 /* Retrieve the current mutex implementation */
483 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
484 break;
485 }
486#endif
487
drh40257ff2008-06-13 18:24:27 +0000488 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000489 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
490 ** single argument which is a pointer to an instance of the
491 ** sqlite3_mem_methods structure. The argument specifies alternative
492 ** low-level memory allocation routines to be used in place of the memory
493 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000494 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000495 break;
496 }
drh33589792008-06-18 13:27:46 +0000497 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000498 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
499 ** single argument which is a pointer to an instance of the
500 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
501 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000502 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
503 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000504 break;
505 }
drhfec00ea2008-06-14 16:56:21 +0000506 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000507 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
508 ** single argument of type int, interpreted as a boolean, which enables
509 ** or disables the collection of memory allocation statistics. */
510 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000511 break;
512 }
drhb2a0f752017-08-28 15:51:35 +0000513 case SQLITE_CONFIG_SMALL_MALLOC: {
514 sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000515 break;
516 }
517 case SQLITE_CONFIG_PAGECACHE: {
drh15427272015-12-03 22:33:55 +0000518 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
519 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
520 ** the size of each page cache line (sz), and the number of cache lines
521 ** (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000522 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
523 sqlite3GlobalConfig.szPage = va_arg(ap, int);
524 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000525 break;
526 }
drhdef68892014-11-04 12:11:23 +0000527 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000528 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
529 ** a single parameter which is a pointer to an integer and writes into
530 ** that integer the number of extra bytes per page required for each page
531 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000532 *va_arg(ap, int*) =
533 sqlite3HeaderSizeBtree() +
534 sqlite3HeaderSizePcache() +
535 sqlite3HeaderSizePcache1();
536 break;
537 }
danielk19775099be52008-06-27 13:27:03 +0000538
danielk1977bc2ca9e2008-11-13 14:28:28 +0000539 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000540 /* no-op */
541 break;
542 }
543 case SQLITE_CONFIG_GETPCACHE: {
544 /* now an error */
545 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000546 break;
547 }
548
dan22e21ff2011-11-08 20:08:44 +0000549 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000550 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
551 ** single argument which is a pointer to an sqlite3_pcache_methods2
552 ** object. This object specifies the interface to a custom page cache
553 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000554 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
555 break;
556 }
557 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000558 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
559 ** single argument which is a pointer to an sqlite3_pcache_methods2
560 ** object. SQLite copies of the current page cache implementation into
561 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000562 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000563 sqlite3PCacheSetDefault();
564 }
dan22e21ff2011-11-08 20:08:44 +0000565 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000566 break;
567 }
568
drh8790b6e2014-11-07 01:43:56 +0000569/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
570** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
571** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000572#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000573 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000574 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
575 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000576 ** number of bytes in the memory buffer, and the minimum allocation size.
577 */
danielk1977075c23a2008-09-01 18:34:20 +0000578 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
579 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
580 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000581
shaneha6ec8922011-03-09 21:36:17 +0000582 if( sqlite3GlobalConfig.mnReq<1 ){
583 sqlite3GlobalConfig.mnReq = 1;
584 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
585 /* cap min request size at 2^12 */
586 sqlite3GlobalConfig.mnReq = (1<<12);
587 }
588
danielk1977075c23a2008-09-01 18:34:20 +0000589 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000590 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
591 ** is NULL, then SQLite reverts to using its default memory allocator
592 ** (the system malloc() implementation), undoing any prior invocation of
593 ** SQLITE_CONFIG_MALLOC.
594 **
595 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
596 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000597 */
danielk1977075c23a2008-09-01 18:34:20 +0000598 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000599 }else{
drh8790b6e2014-11-07 01:43:56 +0000600 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
601 ** alternative memory allocator is engaged to handle all of SQLites
602 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000603#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000604 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000605#endif
606#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000607 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000608#endif
drh8a42cbd2008-07-10 18:13:42 +0000609 }
danielk19775099be52008-06-27 13:27:03 +0000610 break;
611 }
drh5d414832008-07-15 14:47:18 +0000612#endif
danielk19775099be52008-06-27 13:27:03 +0000613
drh633e6d52008-07-28 19:34:53 +0000614 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000615 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
616 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000617 break;
618 }
drh3f280702010-02-18 18:45:09 +0000619
mistachkin037933b2013-08-13 22:33:41 +0000620 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000621 ** The default is NULL. Logging is disabled if the function pointer is
622 ** NULL.
623 */
624 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000625 /* MSVC is picky about pulling func ptrs from va lists.
626 ** http://support.microsoft.com/kb/47961
627 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
628 */
629 typedef void(*LOGFUNC_t)(void*,int,const char*);
630 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000631 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
632 break;
633 }
drh633e6d52008-07-28 19:34:53 +0000634
drh00729cb2014-10-04 11:59:33 +0000635 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
636 ** can be changed at start-time using the
637 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
638 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
639 */
dancd74b612011-04-22 19:37:32 +0000640 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000641 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
642 ** argument of type int. If non-zero, then URI handling is globally
643 ** enabled. If the parameter is zero, then URI handling is globally
644 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000645 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
646 break;
647 }
648
drhde9a7b82012-09-17 20:44:46 +0000649 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000650 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
651 ** option takes a single integer argument which is interpreted as a
652 ** boolean in order to enable or disable the use of covering indices for
653 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000654 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
655 break;
656 }
657
danac455932012-11-26 19:50:41 +0000658#ifdef SQLITE_ENABLE_SQLLOG
659 case SQLITE_CONFIG_SQLLOG: {
660 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
661 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
662 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
663 break;
664 }
665#endif
666
drh9b4c59f2013-04-15 17:03:42 +0000667 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000668 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
669 ** integer (sqlite3_int64) values that are the default mmap size limit
670 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
671 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000672 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000673 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000674 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000675 ** negative, then that argument is changed to its compile-time default.
676 **
677 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
678 ** silently truncated if necessary so that it does not exceed the
679 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
680 ** compile-time option.
681 */
drh3ba689d2015-03-03 14:00:11 +0000682 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
683 mxMmap = SQLITE_MAX_MMAP_SIZE;
684 }
drh9b4c59f2013-04-15 17:03:42 +0000685 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
686 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000687 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000688 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000689 break;
690 }
691
drh4d9f1882014-11-04 17:23:24 +0000692#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000693 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000694 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
695 ** unsigned integer value that specifies the maximum size of the created
696 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000697 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
698 break;
699 }
700#endif
701
drh3bd17912015-01-02 15:55:29 +0000702 case SQLITE_CONFIG_PMASZ: {
703 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
704 break;
705 }
706
drh8c71a982016-03-07 17:37:37 +0000707 case SQLITE_CONFIG_STMTJRNL_SPILL: {
708 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
709 break;
710 }
711
dan2e3a5a82018-04-16 21:12:42 +0000712#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbade8d2018-04-18 14:48:08 +0000713 case SQLITE_CONFIG_SORTERREF_SIZE: {
dan2e3a5a82018-04-16 21:12:42 +0000714 int iVal = va_arg(ap, int);
715 if( iVal<0 ){
716 iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
717 }
718 sqlite3GlobalConfig.szSorterRef = (u32)iVal;
dan2e3a5a82018-04-16 21:12:42 +0000719 break;
720 }
drhbbade8d2018-04-18 14:48:08 +0000721#endif /* SQLITE_ENABLE_SORTER_REFERENCES */
dan2e3a5a82018-04-16 21:12:42 +0000722
drh23a88592019-01-31 15:38:53 +0000723#ifdef SQLITE_ENABLE_DESERIALIZE
724 case SQLITE_CONFIG_MEMDB_MAXSIZE: {
725 sqlite3GlobalConfig.mxMemdbSize = va_arg(ap, sqlite3_int64);
726 break;
727 }
728#endif /* SQLITE_ENABLE_DESERIALIZE */
729
drh40257ff2008-06-13 18:24:27 +0000730 default: {
731 rc = SQLITE_ERROR;
732 break;
733 }
734 }
735 va_end(ap);
736 return rc;
737}
738
739/*
drh633e6d52008-07-28 19:34:53 +0000740** Set up the lookaside buffers for a database connection.
741** Return SQLITE_OK on success.
742** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000743**
744** The sz parameter is the number of bytes in each lookaside slot.
745** The cnt parameter is the number of slots. If pStart is NULL the
746** space for the lookaside memory is obtained from sqlite3_malloc().
747** If pStart is not NULL then it is sz*cnt bytes of memory to use for
748** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000749*/
drhe9d1c722008-08-04 20:13:26 +0000750static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000751#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000752 void *pStart;
numist115d6632019-12-12 02:50:07 +0000753 sqlite3_int64 szAlloc = sz*(sqlite3_int64)cnt;
drhe6068022019-12-13 15:48:21 +0000754 int nBig; /* Number of full-size slots */
drhcf014f62019-12-31 15:12:34 +0000755 int nSm; /* Number smaller LOOKASIDE_SMALL-byte slots */
drh52fb8e12017-08-29 20:21:12 +0000756
757 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000758 return SQLITE_BUSY;
759 }
shanef71f89e2009-01-30 06:11:54 +0000760 /* Free any existing lookaside buffer for this handle before
761 ** allocating a new one so we don't have to have space for
762 ** both at the same time.
763 */
764 if( db->lookaside.bMalloced ){
765 sqlite3_free(db->lookaside.pStart);
766 }
drh61a4bd52011-11-10 02:39:28 +0000767 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
768 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000769 */
drh61a4bd52011-11-10 02:39:28 +0000770 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000771 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000772 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000773 if( sz==0 || cnt==0 ){
774 sz = 0;
775 pStart = 0;
776 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000777 sqlite3BeginBenignMalloc();
numist115d6632019-12-12 02:50:07 +0000778 pStart = sqlite3Malloc( szAlloc ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000779 sqlite3EndBenignMalloc();
drhe6068022019-12-13 15:48:21 +0000780 if( pStart ) szAlloc = sqlite3MallocSize(pStart);
drhe9d1c722008-08-04 20:13:26 +0000781 }else{
782 pStart = pBuf;
783 }
drhcf014f62019-12-31 15:12:34 +0000784#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
785 if( sz>=LOOKASIDE_SMALL*3 ){
786 nBig = szAlloc/(3*LOOKASIDE_SMALL+sz);
787 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
788 }else if( sz>=LOOKASIDE_SMALL*2 ){
789 nBig = szAlloc/(LOOKASIDE_SMALL+sz);
790 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
drhe6068022019-12-13 15:48:21 +0000791 }else
drhcf014f62019-12-31 15:12:34 +0000792#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000793 if( sz>0 ){
794 nBig = szAlloc/sz;
795 nSm = 0;
796 }else{
797 nBig = nSm = 0;
798 }
drh4cfb22f2008-08-01 18:47:01 +0000799 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000800 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000801 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000802 db->lookaside.sz = (u16)sz;
drh31f69622019-10-05 14:39:36 +0000803 db->lookaside.szTrue = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000804 if( pStart ){
805 int i;
806 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000807 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000808 p = (LookasideSlot*)pStart;
drhe6068022019-12-13 15:48:21 +0000809 for(i=0; i<nBig; i++){
drh52fb8e12017-08-29 20:21:12 +0000810 p->pNext = db->lookaside.pInit;
811 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000812 p = (LookasideSlot*)&((u8*)p)[sz];
813 }
drhcf014f62019-12-31 15:12:34 +0000814#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
815 db->lookaside.pSmallInit = 0;
816 db->lookaside.pSmallFree = 0;
numist115d6632019-12-12 02:50:07 +0000817 db->lookaside.pMiddle = p;
drhe6068022019-12-13 15:48:21 +0000818 for(i=0; i<nSm; i++){
drhcf014f62019-12-31 15:12:34 +0000819 p->pNext = db->lookaside.pSmallInit;
820 db->lookaside.pSmallInit = p;
821 p = (LookasideSlot*)&((u8*)p)[LOOKASIDE_SMALL];
numist115d6632019-12-12 02:50:07 +0000822 }
drhcf014f62019-12-31 15:12:34 +0000823#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhe6068022019-12-13 15:48:21 +0000824 assert( ((uptr)p)<=szAlloc + (uptr)pStart );
drh633e6d52008-07-28 19:34:53 +0000825 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000826 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000827 db->lookaside.bMalloced = pBuf==0 ?1:0;
drhe6068022019-12-13 15:48:21 +0000828 db->lookaside.nSlot = nBig+nSm;
drh4cfb22f2008-08-01 18:47:01 +0000829 }else{
drhb0e77042013-12-10 19:49:00 +0000830 db->lookaside.pStart = db;
drhcf014f62019-12-31 15:12:34 +0000831#ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
832 db->lookaside.pSmallInit = 0;
833 db->lookaside.pSmallFree = 0;
drhe6068022019-12-13 15:48:21 +0000834 db->lookaside.pMiddle = db;
drhcf014f62019-12-31 15:12:34 +0000835#endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
drhb0e77042013-12-10 19:49:00 +0000836 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000837 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +0000838 db->lookaside.sz = 0;
shanef71f89e2009-01-30 06:11:54 +0000839 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000840 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000841 }
drhe6068022019-12-13 15:48:21 +0000842 assert( sqlite3LookasideUsed(db,0)==0 );
drh7877d9a2015-07-23 17:16:27 +0000843#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000844 return SQLITE_OK;
845}
846
847/*
drh4413d0e2008-11-04 13:46:27 +0000848** Return the mutex associated with a database connection.
849*/
850sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000851#ifdef SQLITE_ENABLE_API_ARMOR
852 if( !sqlite3SafetyCheckOk(db) ){
853 (void)SQLITE_MISUSE_BKPT;
854 return 0;
855 }
856#endif
drh4413d0e2008-11-04 13:46:27 +0000857 return db->mutex;
858}
859
860/*
drh09419b42011-11-16 19:29:17 +0000861** Free up as much memory as we can from the given database
862** connection.
863*/
864int sqlite3_db_release_memory(sqlite3 *db){
865 int i;
drh9ca95732014-10-24 00:35:58 +0000866
867#ifdef SQLITE_ENABLE_API_ARMOR
868 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
869#endif
dand9bb3a92011-12-30 11:43:59 +0000870 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000871 sqlite3BtreeEnterAll(db);
872 for(i=0; i<db->nDb; i++){
873 Btree *pBt = db->aDb[i].pBt;
874 if( pBt ){
875 Pager *pPager = sqlite3BtreePager(pBt);
876 sqlite3PagerShrink(pPager);
877 }
878 }
879 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000880 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000881 return SQLITE_OK;
882}
883
884/*
dan6fa255f2015-10-28 19:46:57 +0000885** Flush any dirty pages in the pager-cache for any attached database
886** to disk.
887*/
888int sqlite3_db_cacheflush(sqlite3 *db){
889 int i;
890 int rc = SQLITE_OK;
891 int bSeenBusy = 0;
892
893#ifdef SQLITE_ENABLE_API_ARMOR
894 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
895#endif
896 sqlite3_mutex_enter(db->mutex);
897 sqlite3BtreeEnterAll(db);
898 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
899 Btree *pBt = db->aDb[i].pBt;
900 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
901 Pager *pPager = sqlite3BtreePager(pBt);
902 rc = sqlite3PagerFlush(pPager);
903 if( rc==SQLITE_BUSY ){
904 bSeenBusy = 1;
905 rc = SQLITE_OK;
906 }
907 }
908 }
dan6fa255f2015-10-28 19:46:57 +0000909 sqlite3BtreeLeaveAll(db);
910 sqlite3_mutex_leave(db->mutex);
911 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
912}
913
914/*
drh633e6d52008-07-28 19:34:53 +0000915** Configuration settings for an individual database connection
916*/
917int sqlite3_db_config(sqlite3 *db, int op, ...){
918 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000919 int rc;
drh633e6d52008-07-28 19:34:53 +0000920 va_start(ap, op);
921 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000922 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000923 /* IMP: R-06824-28531 */
924 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000925 db->aDb[0].zDbSName = va_arg(ap,char*);
926 rc = SQLITE_OK;
927 break;
928 }
drhe9d1c722008-08-04 20:13:26 +0000929 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000930 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000931 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
932 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000933 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000934 break;
935 }
drh6480aad2008-08-01 16:31:14 +0000936 default: {
drhe83cafd2011-03-21 17:15:58 +0000937 static const struct {
938 int op; /* The opcode */
939 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
940 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000941 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
942 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
drh11d88e62019-08-15 21:27:20 +0000943 { SQLITE_DBCONFIG_ENABLE_VIEW, SQLITE_EnableView },
drhd42908f2016-02-26 15:38:24 +0000944 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000945 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000946 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000947 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000948 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000949 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drha296cda2018-11-03 16:09:59 +0000950 { SQLITE_DBCONFIG_DEFENSIVE, SQLITE_Defensive },
drh346f4e22019-03-25 21:35:41 +0000951 { SQLITE_DBCONFIG_WRITABLE_SCHEMA, SQLITE_WriteSchema|
952 SQLITE_NoSchemaError },
drh0a6873b2019-06-14 21:25:25 +0000953 { SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, SQLITE_LegacyAlter },
drhd0ff6012019-06-17 13:56:11 +0000954 { SQLITE_DBCONFIG_DQS_DDL, SQLITE_DqsDDL },
955 { SQLITE_DBCONFIG_DQS_DML, SQLITE_DqsDML },
drh66c48902019-10-29 16:18:45 +0000956 { SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, SQLITE_LegacyFileFmt },
drhb77da372020-01-07 16:09:11 +0000957 { SQLITE_DBCONFIG_TRUSTED_SCHEMA, SQLITE_TrustedSchema },
drhe83cafd2011-03-21 17:15:58 +0000958 };
drh58ad5802011-03-23 22:02:23 +0000959 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000960 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000961 for(i=0; i<ArraySize(aFlagOp); i++){
962 if( aFlagOp[i].op==op ){
963 int onoff = va_arg(ap, int);
964 int *pRes = va_arg(ap, int*);
drh70d5dfb2018-12-06 16:50:55 +0000965 u64 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000966 if( onoff>0 ){
967 db->flags |= aFlagOp[i].mask;
968 }else if( onoff==0 ){
drhd5b44d62018-12-06 17:06:02 +0000969 db->flags &= ~(u64)aFlagOp[i].mask;
drhe83cafd2011-03-21 17:15:58 +0000970 }
971 if( oldFlags!=db->flags ){
drhba968db2018-07-24 22:02:12 +0000972 sqlite3ExpirePreparedStatements(db, 0);
drhe83cafd2011-03-21 17:15:58 +0000973 }
974 if( pRes ){
975 *pRes = (db->flags & aFlagOp[i].mask)!=0;
976 }
977 rc = SQLITE_OK;
978 break;
979 }
980 }
drh6480aad2008-08-01 16:31:14 +0000981 break;
982 }
drh633e6d52008-07-28 19:34:53 +0000983 }
984 va_end(ap);
985 return rc;
986}
987
drh9b5adfa2008-01-20 23:19:56 +0000988/*
drhd3d39e92004-05-20 22:16:29 +0000989** This is the default collating function named "BINARY" which is always
990** available.
991*/
danielk19772c336542005-01-13 02:14:23 +0000992static int binCollFunc(
drh821afa42019-06-14 13:24:46 +0000993 void *NotUsed,
drhd3d39e92004-05-20 22:16:29 +0000994 int nKey1, const void *pKey1,
995 int nKey2, const void *pKey2
996){
997 int rc, n;
drh821afa42019-06-14 13:24:46 +0000998 UNUSED_PARAMETER(NotUsed);
drhd3d39e92004-05-20 22:16:29 +0000999 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +00001000 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
1001 ** strings byte by byte using the memcmp() function from the standard C
1002 ** library. */
dan21766c02017-05-22 08:04:09 +00001003 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +00001004 rc = memcmp(pKey1, pKey2, n);
1005 if( rc==0 ){
drh821afa42019-06-14 13:24:46 +00001006 rc = nKey1 - nKey2;
drhd3d39e92004-05-20 22:16:29 +00001007 }
1008 return rc;
1009}
1010
1011/*
drh821afa42019-06-14 13:24:46 +00001012** This is the collating function named "RTRIM" which is always
1013** available. Ignore trailing spaces.
1014*/
1015static int rtrimCollFunc(
1016 void *pUser,
1017 int nKey1, const void *pKey1,
1018 int nKey2, const void *pKey2
1019){
1020 const u8 *pK1 = (const u8*)pKey1;
1021 const u8 *pK2 = (const u8*)pKey2;
1022 while( nKey1 && pK1[nKey1-1]==' ' ) nKey1--;
1023 while( nKey2 && pK2[nKey2-1]==' ' ) nKey2--;
1024 return binCollFunc(pUser, nKey1, pKey1, nKey2, pKey2);
1025}
1026
1027/*
drhbcd15932018-07-27 18:12:40 +00001028** Return true if CollSeq is the default built-in BINARY.
1029*/
1030int sqlite3IsBinary(const CollSeq *p){
drh821afa42019-06-14 13:24:46 +00001031 assert( p==0 || p->xCmp!=binCollFunc || strcmp(p->zName,"BINARY")==0 );
1032 return p==0 || p->xCmp==binCollFunc;
drhbcd15932018-07-27 18:12:40 +00001033}
1034
1035/*
danielk1977dc1bdc42004-06-11 10:51:27 +00001036** Another built-in collating sequence: NOCASE.
1037**
drhf7b54962013-05-28 12:11:54 +00001038** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +00001039** comparison". SQLite's knowledge of upper and lower case equivalents
1040** extends only to the 26 characters used in the English language.
1041**
1042** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +00001043*/
1044static int nocaseCollatingFunc(
1045 void *NotUsed,
1046 int nKey1, const void *pKey1,
1047 int nKey2, const void *pKey2
1048){
1049 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +00001050 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +00001051 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +00001052 if( 0==r ){
1053 r = nKey1-nKey2;
1054 }
1055 return r;
1056}
1057
1058/*
drhaf9ff332002-01-16 21:00:27 +00001059** Return the ROWID of the most recent insert
1060*/
drh9bb575f2004-09-06 17:24:11 +00001061sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001062#ifdef SQLITE_ENABLE_API_ARMOR
1063 if( !sqlite3SafetyCheckOk(db) ){
1064 (void)SQLITE_MISUSE_BKPT;
1065 return 0;
1066 }
1067#endif
drhaf9ff332002-01-16 21:00:27 +00001068 return db->lastRowid;
1069}
1070
1071/*
dan9c58b632017-02-27 14:52:48 +00001072** Set the value returned by the sqlite3_last_insert_rowid() API function.
1073*/
1074void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
1075#ifdef SQLITE_ENABLE_API_ARMOR
1076 if( !sqlite3SafetyCheckOk(db) ){
1077 (void)SQLITE_MISUSE_BKPT;
1078 return;
1079 }
1080#endif
1081 sqlite3_mutex_enter(db->mutex);
1082 db->lastRowid = iRowid;
1083 sqlite3_mutex_leave(db->mutex);
1084}
1085
1086/*
danielk197724b03fd2004-05-10 10:34:34 +00001087** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +00001088*/
drh9bb575f2004-09-06 17:24:11 +00001089int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001090#ifdef SQLITE_ENABLE_API_ARMOR
1091 if( !sqlite3SafetyCheckOk(db) ){
1092 (void)SQLITE_MISUSE_BKPT;
1093 return 0;
1094 }
1095#endif
drhc8d30ac2002-04-12 10:08:59 +00001096 return db->nChange;
1097}
1098
rdcf146a772004-02-25 22:51:06 +00001099/*
danielk1977b28af712004-06-21 06:50:26 +00001100** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +00001101*/
danielk1977b28af712004-06-21 06:50:26 +00001102int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001103#ifdef SQLITE_ENABLE_API_ARMOR
1104 if( !sqlite3SafetyCheckOk(db) ){
1105 (void)SQLITE_MISUSE_BKPT;
1106 return 0;
1107 }
1108#endif
danielk1977b28af712004-06-21 06:50:26 +00001109 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +00001110}
1111
drhc8d30ac2002-04-12 10:08:59 +00001112/*
danielk1977fd7f0452008-12-17 17:30:26 +00001113** Close all open savepoints. This function only manipulates fields of the
1114** database handle object, it does not close any savepoints that may be open
1115** at the b-tree/pager level.
1116*/
1117void sqlite3CloseSavepoints(sqlite3 *db){
1118 while( db->pSavepoint ){
1119 Savepoint *pTmp = db->pSavepoint;
1120 db->pSavepoint = pTmp->pNext;
1121 sqlite3DbFree(db, pTmp);
1122 }
1123 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001124 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001125 db->isTransactionSavepoint = 0;
1126}
1127
1128/*
dand2199f02010-08-27 17:48:52 +00001129** Invoke the destructor function associated with FuncDef p, if any. Except,
1130** if this is not the last copy of the function, do not invoke it. Multiple
1131** copies of a single function are created when create_function() is called
1132** with SQLITE_ANY as the encoding.
1133*/
1134static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001135 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001136 if( pDestructor ){
1137 pDestructor->nRef--;
1138 if( pDestructor->nRef==0 ){
1139 pDestructor->xDestroy(pDestructor->pUserData);
1140 sqlite3DbFree(db, pDestructor);
1141 }
1142 }
1143}
1144
1145/*
danbba02a92012-05-15 17:15:34 +00001146** Disconnect all sqlite3_vtab objects that belong to database connection
1147** db. This is called when db is being closed.
1148*/
1149static void disconnectAllVtab(sqlite3 *db){
1150#ifndef SQLITE_OMIT_VIRTUALTABLE
1151 int i;
drh51be3872015-08-19 02:32:25 +00001152 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001153 sqlite3BtreeEnterAll(db);
1154 for(i=0; i<db->nDb; i++){
1155 Schema *pSchema = db->aDb[i].pSchema;
mistachkin6389a7b2018-08-08 20:46:35 +00001156 if( pSchema ){
danbba02a92012-05-15 17:15:34 +00001157 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1158 Table *pTab = (Table *)sqliteHashData(p);
1159 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1160 }
1161 }
1162 }
drh51be3872015-08-19 02:32:25 +00001163 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1164 Module *pMod = (Module *)sqliteHashData(p);
1165 if( pMod->pEpoTab ){
1166 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1167 }
1168 }
dand88e5212014-03-12 19:38:38 +00001169 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001170 sqlite3BtreeLeaveAll(db);
1171#else
1172 UNUSED_PARAMETER(db);
1173#endif
1174}
1175
1176/*
drh167cd6a2012-06-02 17:09:46 +00001177** Return TRUE if database connection db has unfinalized prepared
1178** statements or unfinished sqlite3_backup objects.
1179*/
1180static int connectionIsBusy(sqlite3 *db){
1181 int j;
1182 assert( sqlite3_mutex_held(db->mutex) );
1183 if( db->pVdbe ) return 1;
1184 for(j=0; j<db->nDb; j++){
1185 Btree *pBt = db->aDb[j].pBt;
1186 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1187 }
1188 return 0;
1189}
1190
1191/*
drh50e5dad2001-09-15 00:57:28 +00001192** Close an existing SQLite database
1193*/
drh167cd6a2012-06-02 17:09:46 +00001194static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001195 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001196 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1197 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001198 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001199 }
drh7e8b8482008-01-23 03:03:05 +00001200 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001201 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001202 }
drh605264d2007-08-21 15:13:19 +00001203 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001204 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1205 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1206 }
danielk1977e35ee192004-06-26 09:50:11 +00001207
danbba02a92012-05-15 17:15:34 +00001208 /* Force xDisconnect calls on all virtual tables */
1209 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001210
danbba02a92012-05-15 17:15:34 +00001211 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001212 ** will not have called the xDisconnect() method on any virtual
1213 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1214 ** call will do so. We need to do this before the check for active
1215 ** SQL statements below, as the v-table implementation may be storing
1216 ** some prepared statements internally.
1217 */
dan67430812013-05-15 10:21:50 +00001218 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +00001219
drh167cd6a2012-06-02 17:09:46 +00001220 /* Legacy behavior (sqlite3_close() behavior) is to return
1221 ** SQLITE_BUSY if the connection can not be closed immediately.
1222 */
1223 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001224 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001225 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001226 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001227 return SQLITE_BUSY;
1228 }
danielk1977e0048402004-06-15 16:51:01 +00001229
danac455932012-11-26 19:50:41 +00001230#ifdef SQLITE_ENABLE_SQLLOG
1231 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001232 /* Closing the handle. Fourth parameter is passed the value 2. */
1233 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001234 }
1235#endif
1236
drh167cd6a2012-06-02 17:09:46 +00001237 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001238 */
1239 db->magic = SQLITE_MAGIC_ZOMBIE;
1240 sqlite3LeaveMutexAndCloseZombie(db);
1241 return SQLITE_OK;
1242}
drh94e92032003-02-16 22:21:32 +00001243
drh167cd6a2012-06-02 17:09:46 +00001244/*
1245** Two variations on the public interface for closing a database
1246** connection. The sqlite3_close() version returns SQLITE_BUSY and
1247** leaves the connection option if there are unfinalized prepared
1248** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1249** version forces the connection to become a zombie if there are
1250** unclosed resources, and arranges for deallocation when the last
1251** prepare statement or sqlite3_backup closes.
1252*/
1253int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1254int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1255
drh4245c402012-06-02 14:32:21 +00001256
1257/*
1258** Close the mutex on database connection db.
1259**
1260** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001261** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1262** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1263** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001264*/
1265void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1266 HashElem *i; /* Hash table iterator */
1267 int j;
1268
drh4245c402012-06-02 14:32:21 +00001269 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001270 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1271 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001272 */
drh167cd6a2012-06-02 17:09:46 +00001273 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001274 sqlite3_mutex_leave(db->mutex);
1275 return;
danielk197704103022009-02-03 16:51:24 +00001276 }
1277
drh4245c402012-06-02 14:32:21 +00001278 /* If we reach this point, it means that the database connection has
1279 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001280 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001281 ** go ahead and free all resources.
1282 */
1283
dan617dc862013-05-16 11:57:28 +00001284 /* If a transaction is open, roll it back. This also ensures that if
1285 ** any database schemas have been modified by an uncommitted transaction
1286 ** they are reset. And that the required b-tree mutex is held to make
1287 ** the pager rollback and schema reset an atomic operation. */
1288 sqlite3RollbackAll(db, SQLITE_OK);
1289
danielk1977fd7f0452008-12-17 17:30:26 +00001290 /* Free any outstanding Savepoint structures. */
1291 sqlite3CloseSavepoints(db);
1292
drh5efb3142012-05-16 01:24:34 +00001293 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001294 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001295 struct Db *pDb = &db->aDb[j];
1296 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001297 sqlite3BtreeClose(pDb->pBt);
1298 pDb->pBt = 0;
1299 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001300 pDb->pSchema = 0;
1301 }
drh113088e2003-03-20 01:16:58 +00001302 }
drhf57b3392001-10-08 13:22:32 +00001303 }
drh5efb3142012-05-16 01:24:34 +00001304 /* Clear the TEMP schema separately and last */
1305 if( db->aDb[1].pSchema ){
1306 sqlite3SchemaClear(db->aDb[1].pSchema);
1307 }
1308 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001309
drh5efb3142012-05-16 01:24:34 +00001310 /* Free up the array of auxiliary databases */
1311 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001312 assert( db->nDb<=2 );
1313 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001314
1315 /* Tell the code in notify.c that the connection no longer holds any
1316 ** locks and does not require any further unlock-notify callbacks.
1317 */
1318 sqlite3ConnectionClosed(db);
1319
drh80738d92016-02-15 00:34:16 +00001320 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1321 FuncDef *pNext, *p;
1322 p = sqliteHashData(i);
1323 do{
1324 functionDestroy(db, p);
1325 pNext = p->pNext;
1326 sqlite3DbFree(db, p);
1327 p = pNext;
1328 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001329 }
drh80738d92016-02-15 00:34:16 +00001330 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001331 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001332 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001333 /* Invoke any destructors registered for collation sequence user data. */
1334 for(j=0; j<3; j++){
1335 if( pColl[j].xDel ){
1336 pColl[j].xDel(pColl[j].pUser);
1337 }
1338 }
drh633e6d52008-07-28 19:34:53 +00001339 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001340 }
danielk1977d8123362004-06-12 09:25:12 +00001341 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001342#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001343 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1344 Module *pMod = (Module *)sqliteHashData(i);
drh51be3872015-08-19 02:32:25 +00001345 sqlite3VtabEponymousTableClear(db, pMod);
drhcc5979d2019-08-16 22:58:29 +00001346 sqlite3VtabModuleUnref(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001347 }
drhb9bb7c12006-06-11 23:41:55 +00001348 sqlite3HashClear(&db->aModule);
1349#endif
danielk1977466be562004-06-10 02:16:01 +00001350
drh13f40da2014-08-22 18:00:11 +00001351 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001352 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001353 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001354#if SQLITE_USER_AUTHENTICATION
1355 sqlite3_free(db->auth.zAuthUser);
1356 sqlite3_free(db->auth.zAuthPW);
1357#endif
danielk197796d81f92004-06-19 03:33:57 +00001358
1359 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001360
1361 /* The temp-database schema is allocated differently from the other schema
1362 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1363 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1364 ** the same sqliteMalloc() as the one that allocates the database
1365 ** structure?
1366 */
drh633e6d52008-07-28 19:34:53 +00001367 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001368 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001369 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001370 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001371 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001372 if( db->lookaside.bMalloced ){
1373 sqlite3_free(db->lookaside.pStart);
1374 }
drh17435752007-08-16 04:30:38 +00001375 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001376}
1377
1378/*
drh0f198a72012-02-13 16:43:16 +00001379** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001380** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001381** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001382** attempts to use that cursor. Read cursors remain open and valid
1383** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001384*/
drh0f198a72012-02-13 16:43:16 +00001385void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001386 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001387 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001388 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001389 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001390 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001391
1392 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1393 ** This is important in case the transaction being rolled back has
1394 ** modified the database schema. If the b-tree mutexes are not taken
1395 ** here, then another shared-cache connection might sneak in between
1396 ** the database rollback and schema reset, which can cause false
1397 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001398 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001399 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001400
drh001bbcb2003-03-19 03:14:00 +00001401 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001402 Btree *p = db->aDb[i].pBt;
1403 if( p ){
1404 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001405 inTrans = 1;
1406 }
drh47b7fc72014-11-11 01:33:57 +00001407 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001408 }
1409 }
danielk1977a298e902006-06-22 09:53:48 +00001410 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001411 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001412
drh7f32dc92018-07-16 11:32:59 +00001413 if( schemaChange ){
drhba968db2018-07-24 22:02:12 +00001414 sqlite3ExpirePreparedStatements(db, 0);
drh81028a42012-05-15 18:28:27 +00001415 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001416 }
dancd7b91a2013-05-13 18:23:15 +00001417 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001418
dan1da40a32009-09-19 17:00:31 +00001419 /* Any deferred constraint violations have now been resolved. */
1420 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001421 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00001422 db->flags &= ~(u64)SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001423
danielk197771fd80b2005-12-16 06:54:01 +00001424 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001425 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001426 db->xRollbackCallback(db->pRollbackArg);
1427 }
drh001bbcb2003-03-19 03:14:00 +00001428}
1429
1430/*
mistachkinf2c1c992013-04-28 01:44:43 +00001431** Return a static string containing the name corresponding to the error code
1432** specified in the argument.
1433*/
mistachkin5824d442015-04-28 23:34:10 +00001434#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001435const char *sqlite3ErrName(int rc){
1436 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001437 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001438 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1439 switch( rc ){
1440 case SQLITE_OK: zName = "SQLITE_OK"; break;
1441 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
dan8d4b7a32018-08-31 19:00:16 +00001442 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001443 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1444 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1445 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001446 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001447 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001448 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001449 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001450 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1451 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1452 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1453 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001454 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001455 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001456 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001457 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001458 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001459 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1460 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001461 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1462 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1463 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1464 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1465 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1466 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1467 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1468 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1469 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1470 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001471 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1472 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1473 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1474 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1475 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1476 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1477 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1478 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1479 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1480 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1481 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1482 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1483 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1484 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001485 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001486 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001487 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001488 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001489 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1490 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1491 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001492 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1493 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1494 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001495 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkin3c161e02019-11-18 23:48:03 +00001496 case SQLITE_CANTOPEN_SYMLINK: zName = "SQLITE_CANTOPEN_SYMLINK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001497 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1498 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1499 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1500 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1501 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1502 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1503 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1504 case SQLITE_CONSTRAINT_FOREIGNKEY:
1505 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1506 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1507 case SQLITE_CONSTRAINT_PRIMARYKEY:
1508 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1509 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1510 case SQLITE_CONSTRAINT_COMMITHOOK:
1511 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1512 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1513 case SQLITE_CONSTRAINT_FUNCTION:
1514 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001515 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001516 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1517 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1518 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1519 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1520 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1521 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1522 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1523 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1524 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001525 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1526 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1527 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001528 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001529 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001530 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001531 }
1532 }
mistachkin10269dc2013-04-30 07:54:42 +00001533 if( zName==0 ){
1534 static char zBuf[50];
1535 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1536 zName = zBuf;
1537 }
mistachkinf2c1c992013-04-28 01:44:43 +00001538 return zName;
1539}
mistachkin10269dc2013-04-30 07:54:42 +00001540#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001541
1542/*
drhc22bd472002-05-10 13:14:07 +00001543** Return a static string that describes the kind of error specified in the
1544** argument.
drh247be432002-05-10 05:44:55 +00001545*/
danielk1977f20b21c2004-05-31 23:56:42 +00001546const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001547 static const char* const aMsg[] = {
1548 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001549 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001550 /* SQLITE_INTERNAL */ 0,
1551 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001552 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001553 /* SQLITE_BUSY */ "database is locked",
1554 /* SQLITE_LOCKED */ "database table is locked",
1555 /* SQLITE_NOMEM */ "out of memory",
1556 /* SQLITE_READONLY */ "attempt to write a readonly database",
1557 /* SQLITE_INTERRUPT */ "interrupted",
1558 /* SQLITE_IOERR */ "disk I/O error",
1559 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001560 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001561 /* SQLITE_FULL */ "database or disk is full",
1562 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001563 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001564 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001565 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001566 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001567 /* SQLITE_CONSTRAINT */ "constraint failed",
1568 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001569 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001570#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001571 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001572#else
1573 /* SQLITE_NOLFS */ 0,
1574#endif
drh51c7d862009-04-27 18:46:06 +00001575 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001576 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001577 /* SQLITE_RANGE */ "column index out of range",
1578 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001579 /* SQLITE_NOTICE */ "notification message",
1580 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001581 };
drh21021a52012-02-13 17:01:51 +00001582 const char *zErr = "unknown error";
1583 switch( rc ){
1584 case SQLITE_ABORT_ROLLBACK: {
1585 zErr = "abort due to ROLLBACK";
1586 break;
1587 }
mistachkin2a861102018-02-08 01:00:11 +00001588 case SQLITE_ROW: {
1589 zErr = "another row available";
1590 break;
1591 }
1592 case SQLITE_DONE: {
1593 zErr = "no more rows available";
1594 break;
1595 }
drh21021a52012-02-13 17:01:51 +00001596 default: {
1597 rc &= 0xff;
1598 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1599 zErr = aMsg[rc];
1600 }
1601 break;
1602 }
drh247be432002-05-10 05:44:55 +00001603 }
drh21021a52012-02-13 17:01:51 +00001604 return zErr;
drh247be432002-05-10 05:44:55 +00001605}
1606
1607/*
drh2dfbbca2000-07-28 14:32:48 +00001608** This routine implements a busy callback that sleeps and tries
1609** again until a timeout value is reached. The timeout value is
1610** an integer number of milliseconds passed in as the first
1611** argument.
drhf0119b22018-03-26 17:40:53 +00001612**
1613** Return non-zero to retry the lock. Return zero to stop trying
1614** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001615*/
drhdaffd0e2001-04-11 14:28:42 +00001616static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001617 void *ptr, /* Database connection */
dan8714de92020-05-04 19:42:35 +00001618 int count /* Number of times table has been busy */
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
drhee570fa2005-04-28 12:06:05 +00001632 assert( count>=0 );
1633 if( count < NDELAY ){
1634 delay = delays[count];
1635 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001636 }else{
1637 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001638 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001639 }
drhf0119b22018-03-26 17:40:53 +00001640 if( prior + delay > tmout ){
1641 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001642 if( delay<=0 ) return 0;
1643 }
danielk19772a6bdf62007-08-20 16:07:00 +00001644 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001645 return 1;
1646#else
drhf0119b22018-03-26 17:40:53 +00001647 /* This case for unix systems that lack usleep() support. Sleeping
1648 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001649 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001650 int tmout = ((sqlite3 *)ptr)->busyTimeout;
1651 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001652 return 0;
1653 }
drh482ea182007-08-20 11:12:40 +00001654 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001655 return 1;
1656#endif
1657}
1658
1659/*
drha4afb652005-07-09 02:16:02 +00001660** Invoke the given busy handler.
1661**
drhf0119b22018-03-26 17:40:53 +00001662** This routine is called when an operation failed to acquire a
1663** lock on VFS file pFile.
1664**
drha4afb652005-07-09 02:16:02 +00001665** If this routine returns non-zero, the lock is retried. If it
1666** returns 0, the operation aborts with an SQLITE_BUSY error.
1667*/
drh783e1592020-05-06 20:55:38 +00001668int sqlite3InvokeBusyHandler(BusyHandler *p){
drha4afb652005-07-09 02:16:02 +00001669 int rc;
drh80262892018-03-26 16:37:53 +00001670 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
dan8714de92020-05-04 19:42:35 +00001671 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
drha4afb652005-07-09 02:16:02 +00001672 if( rc==0 ){
1673 p->nBusy = -1;
1674 }else{
1675 p->nBusy++;
1676 }
1677 return rc;
1678}
1679
1680/*
drh2dfbbca2000-07-28 14:32:48 +00001681** This routine sets the busy callback for an Sqlite database to the
1682** given callback function with the given argument.
1683*/
danielk1977f9d64d22004-06-19 08:18:07 +00001684int sqlite3_busy_handler(
1685 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001686 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001687 void *pArg
1688){
drh9ca95732014-10-24 00:35:58 +00001689#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001690 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001691#endif
drhe30f4422007-08-21 16:15:55 +00001692 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001693 db->busyHandler.xBusyHandler = xBusy;
1694 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001695 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001696 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001697 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001698 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001699}
1700
danielk1977348bb5d2003-10-18 09:37:26 +00001701#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1702/*
1703** This routine sets the progress callback for an Sqlite database to the
1704** given callback function with the given argument. The progress callback will
1705** be invoked every nOps opcodes.
1706*/
danielk197724b03fd2004-05-10 10:34:34 +00001707void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001708 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001709 int nOps,
1710 int (*xProgress)(void*),
1711 void *pArg
1712){
drh9ca95732014-10-24 00:35:58 +00001713#ifdef SQLITE_ENABLE_API_ARMOR
1714 if( !sqlite3SafetyCheckOk(db) ){
1715 (void)SQLITE_MISUSE_BKPT;
1716 return;
1717 }
1718#endif
drhbd0b1b52008-07-07 19:52:09 +00001719 sqlite3_mutex_enter(db->mutex);
1720 if( nOps>0 ){
1721 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001722 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001723 db->pProgressArg = pArg;
1724 }else{
1725 db->xProgress = 0;
1726 db->nProgressOps = 0;
1727 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001728 }
drhbd0b1b52008-07-07 19:52:09 +00001729 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001730}
1731#endif
1732
1733
drh2dfbbca2000-07-28 14:32:48 +00001734/*
1735** This routine installs a default busy handler that waits for the
1736** specified number of milliseconds before returning 0.
1737*/
danielk1977f9d64d22004-06-19 08:18:07 +00001738int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001739#ifdef SQLITE_ENABLE_API_ARMOR
1740 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1741#endif
drh2dfbbca2000-07-28 14:32:48 +00001742 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001743 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1744 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001745 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001746 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001747 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001748 }
danielk1977f9d64d22004-06-19 08:18:07 +00001749 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001750}
drh4c504392000-10-16 22:06:40 +00001751
1752/*
1753** Cause any pending operation to stop at its earliest opportunity.
1754*/
drh9bb575f2004-09-06 17:24:11 +00001755void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001756#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001757 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001758 (void)SQLITE_MISUSE_BKPT;
1759 return;
1760 }
1761#endif
dan892edb62020-03-30 13:35:05 +00001762 AtomicStore(&db->u1.isInterrupted, 1);
drh4c504392000-10-16 22:06:40 +00001763}
drhfa86c412002-02-02 15:01:15 +00001764
drhfa86c412002-02-02 15:01:15 +00001765
1766/*
danielk1977771151b2006-01-17 13:21:40 +00001767** This function is exactly the same as sqlite3_create_function(), except
1768** that it is designed to be called by internal code. The difference is
1769** that if a malloc() fails in sqlite3_create_function(), an error code
1770** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001771*/
danielk1977771151b2006-01-17 13:21:40 +00001772int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001773 sqlite3 *db,
1774 const char *zFunctionName,
1775 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001776 int enc,
danielk197765904932004-05-26 06:18:37 +00001777 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001778 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001779 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001780 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001781 void (*xValue)(sqlite3_context*),
1782 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001783 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001784){
drh0bce8352002-02-28 00:41:10 +00001785 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001786 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001787 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001788
drhe30f4422007-08-21 16:15:55 +00001789 assert( sqlite3_mutex_held(db->mutex) );
drh1e80ace2018-07-09 02:37:12 +00001790 assert( xValue==0 || xSFunc==0 );
1791 if( zFunctionName==0 /* Must have a valid name */
1792 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1793 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1794 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1795 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1796 || (255<(nName = sqlite3Strlen30( zFunctionName)))
1797 ){
drh413c3d32010-02-23 20:11:56 +00001798 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001799 }
drh4a8ee3d2013-12-14 13:44:22 +00001800
1801 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001802 assert( SQLITE_FUNC_DIRECT==SQLITE_DIRECTONLY );
drhc4ad8492020-01-03 20:57:38 +00001803 extraFlags = enc & (SQLITE_DETERMINISTIC|SQLITE_DIRECTONLY|
1804 SQLITE_SUBTYPE|SQLITE_INNOCUOUS);
drh4a8ee3d2013-12-14 13:44:22 +00001805 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
drh4be621e2020-01-03 21:57:53 +00001806
1807 /* The SQLITE_INNOCUOUS flag is the same bit as SQLITE_FUNC_UNSAFE. But
1808 ** the meaning is inverted. So flip the bit. */
1809 assert( SQLITE_FUNC_UNSAFE==SQLITE_INNOCUOUS );
1810 extraFlags ^= SQLITE_FUNC_UNSAFE;
1811
danielk1977d8123362004-06-12 09:25:12 +00001812
danielk197793758c82005-01-21 08:13:14 +00001813#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001814 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1815 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1816 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1817 **
1818 ** If SQLITE_ANY is specified, add three versions of the function
1819 ** to the hash table.
1820 */
1821 if( enc==SQLITE_UTF16 ){
1822 enc = SQLITE_UTF16NATIVE;
1823 }else if( enc==SQLITE_ANY ){
1824 int rc;
drh79d5bc82020-01-04 01:43:02 +00001825 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1826 (SQLITE_UTF8|extraFlags)^SQLITE_FUNC_UNSAFE,
dan660af932018-06-18 16:55:22 +00001827 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001828 if( rc==SQLITE_OK ){
drh79d5bc82020-01-04 01:43:02 +00001829 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1830 (SQLITE_UTF16LE|extraFlags)^SQLITE_FUNC_UNSAFE,
1831 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001832 }
1833 if( rc!=SQLITE_OK ){
1834 return rc;
1835 }
danielk1977d8123362004-06-12 09:25:12 +00001836 enc = SQLITE_UTF16BE;
1837 }
danielk197793758c82005-01-21 08:13:14 +00001838#else
1839 enc = SQLITE_UTF8;
1840#endif
danielk19779636c4e2005-01-25 04:27:54 +00001841
1842 /* Check if an existing function is being overridden or deleted. If so,
1843 ** and there are active VMs, then return SQLITE_BUSY. If a function
1844 ** is being overridden/deleted but there are no active VMs, allow the
1845 ** operation to continue but invalidate all precompiled statements.
1846 */
drh80738d92016-02-15 00:34:16 +00001847 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhc7bf5712018-07-09 22:49:01 +00001848 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001849 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001850 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001851 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001852 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001853 return SQLITE_BUSY;
1854 }else{
drhba968db2018-07-24 22:02:12 +00001855 sqlite3ExpirePreparedStatements(db, 0);
danielk19779636c4e2005-01-25 04:27:54 +00001856 }
1857 }
danielk197765904932004-05-26 06:18:37 +00001858
drh80738d92016-02-15 00:34:16 +00001859 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001860 assert(p || db->mallocFailed);
1861 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001862 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001863 }
dand2199f02010-08-27 17:48:52 +00001864
1865 /* If an older version of the function with a configured destructor is
1866 ** being replaced invoke the destructor function here. */
1867 functionDestroy(db, p);
1868
1869 if( pDestructor ){
1870 pDestructor->nRef++;
1871 }
drh80738d92016-02-15 00:34:16 +00001872 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001873 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1874 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh42d2fce2019-08-15 20:04:09 +00001875 testcase( p->funcFlags & SQLITE_DIRECTONLY );
drh2d801512016-01-14 22:19:58 +00001876 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001877 p->xFinalize = xFinal;
dan660af932018-06-18 16:55:22 +00001878 p->xValue = xValue;
1879 p->xInverse = xInverse;
danielk1977fa18bec2007-09-03 11:04:22 +00001880 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001881 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001882 return SQLITE_OK;
1883}
danielk1977771151b2006-01-17 13:21:40 +00001884
1885/*
dan660af932018-06-18 16:55:22 +00001886** Worker function used by utf-8 APIs that create new functions:
1887**
1888** sqlite3_create_function()
1889** sqlite3_create_function_v2()
1890** sqlite3_create_window_function()
danielk1977771151b2006-01-17 13:21:40 +00001891*/
dan660af932018-06-18 16:55:22 +00001892static int createFunctionApi(
danielk1977771151b2006-01-17 13:21:40 +00001893 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001894 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001895 int nArg,
1896 int enc,
1897 void *p,
dan660af932018-06-18 16:55:22 +00001898 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1899 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
dand2199f02010-08-27 17:48:52 +00001900 void (*xFinal)(sqlite3_context*),
dan660af932018-06-18 16:55:22 +00001901 void (*xValue)(sqlite3_context*),
1902 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1903 void(*xDestroy)(void*)
dand2199f02010-08-27 17:48:52 +00001904){
shanehbd2aaf92010-09-01 02:38:21 +00001905 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001906 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001907
1908#ifdef SQLITE_ENABLE_API_ARMOR
1909 if( !sqlite3SafetyCheckOk(db) ){
1910 return SQLITE_MISUSE_BKPT;
1911 }
1912#endif
dand2199f02010-08-27 17:48:52 +00001913 sqlite3_mutex_enter(db->mutex);
1914 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001915 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001916 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001917 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001918 xDestroy(p);
1919 goto out;
1920 }
drh92011842018-05-26 16:00:26 +00001921 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001922 pArg->xDestroy = xDestroy;
1923 pArg->pUserData = p;
1924 }
dan660af932018-06-18 16:55:22 +00001925 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1926 xSFunc, xStep, xFinal, xValue, xInverse, pArg
1927 );
dand2199f02010-08-27 17:48:52 +00001928 if( pArg && pArg->nRef==0 ){
1929 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001930 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001931 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001932 }
1933
1934 out:
drhe30f4422007-08-21 16:15:55 +00001935 rc = sqlite3ApiExit(db, rc);
1936 sqlite3_mutex_leave(db->mutex);
1937 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001938}
1939
dan660af932018-06-18 16:55:22 +00001940/*
1941** Create new user functions.
1942*/
1943int sqlite3_create_function(
1944 sqlite3 *db,
1945 const char *zFunc,
1946 int nArg,
1947 int enc,
1948 void *p,
1949 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1950 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1951 void (*xFinal)(sqlite3_context*)
1952){
1953 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1954 xFinal, 0, 0, 0);
1955}
1956int sqlite3_create_function_v2(
1957 sqlite3 *db,
1958 const char *zFunc,
1959 int nArg,
1960 int enc,
1961 void *p,
1962 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1963 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1964 void (*xFinal)(sqlite3_context*),
1965 void (*xDestroy)(void *)
1966){
1967 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1968 xFinal, 0, 0, xDestroy);
1969}
1970int sqlite3_create_window_function(
1971 sqlite3 *db,
1972 const char *zFunc,
1973 int nArg,
1974 int enc,
1975 void *p,
1976 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1977 void (*xFinal)(sqlite3_context*),
1978 void (*xValue)(sqlite3_context*),
1979 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1980 void (*xDestroy)(void *)
1981){
1982 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1983 xFinal, xValue, xInverse, xDestroy);
1984}
1985
danielk197793758c82005-01-21 08:13:14 +00001986#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001987int sqlite3_create_function16(
1988 sqlite3 *db,
1989 const void *zFunctionName,
1990 int nArg,
1991 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001992 void *p,
drh2d801512016-01-14 22:19:58 +00001993 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001994 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1995 void (*xFinal)(sqlite3_context*)
1996){
1997 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001998 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001999
2000#ifdef SQLITE_ENABLE_API_ARMOR
2001 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
2002#endif
drhe30f4422007-08-21 16:15:55 +00002003 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002004 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002005 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dan660af932018-06-18 16:55:22 +00002006 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
drh633e6d52008-07-28 19:34:53 +00002007 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00002008 rc = sqlite3ApiExit(db, rc);
2009 sqlite3_mutex_leave(db->mutex);
2010 return rc;
drh8e0a2f92002-02-23 23:45:45 +00002011}
danielk197793758c82005-01-21 08:13:14 +00002012#endif
drhc9b84a12002-06-20 11:36:48 +00002013
drhb7481e72006-09-16 21:45:14 +00002014
2015/*
drh92011842018-05-26 16:00:26 +00002016** The following is the implementation of an SQL function that always
2017** fails with an error message stating that the function is used in the
2018** wrong context. The sqlite3_overload_function() API might construct
2019** SQL function that use this routine so that the functions will exist
2020** for name resolution but are actually overloaded by the xFindFunction
2021** method of virtual tables.
2022*/
2023static void sqlite3InvalidFunction(
2024 sqlite3_context *context, /* The function calling context */
2025 int NotUsed, /* Number of arguments to the function */
2026 sqlite3_value **NotUsed2 /* Value of each argument */
2027){
2028 const char *zName = (const char*)sqlite3_user_data(context);
2029 char *zErr;
2030 UNUSED_PARAMETER2(NotUsed, NotUsed2);
2031 zErr = sqlite3_mprintf(
2032 "unable to use function %s in the requested context", zName);
2033 sqlite3_result_error(context, zErr, -1);
2034 sqlite3_free(zErr);
2035}
2036
2037/*
drhb7481e72006-09-16 21:45:14 +00002038** Declare that a function has been overloaded by a virtual table.
2039**
2040** If the function already exists as a regular global function, then
2041** this routine is a no-op. If the function does not exist, then create
2042** a new one that always throws a run-time error.
2043**
2044** When virtual tables intend to provide an overloaded function, they
2045** should call this routine to make sure the global function exists.
2046** A global function must exist in order for name resolution to work
2047** properly.
2048*/
2049int sqlite3_overload_function(
2050 sqlite3 *db,
2051 const char *zName,
2052 int nArg
2053){
drh92011842018-05-26 16:00:26 +00002054 int rc;
2055 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00002056
2057#ifdef SQLITE_ENABLE_API_ARMOR
2058 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
2059 return SQLITE_MISUSE_BKPT;
2060 }
2061#endif
drhe30f4422007-08-21 16:15:55 +00002062 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00002063 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00002064 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00002065 if( rc ) return SQLITE_OK;
2066 zCopy = sqlite3_mprintf(zName);
2067 if( zCopy==0 ) return SQLITE_NOMEM;
2068 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
2069 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00002070}
2071
drh19e2d372005-08-29 23:00:03 +00002072#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00002073/*
drh18de4822003-01-16 16:28:53 +00002074** Register a trace function. The pArg from the previously registered trace
2075** is returned.
2076**
2077** A NULL trace function means that no tracing is executes. A non-NULL
2078** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00002079** SQL statement.
drh18de4822003-01-16 16:28:53 +00002080*/
drh3d2a5292016-07-13 22:55:01 +00002081#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00002082void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00002083 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002084
2085#ifdef SQLITE_ENABLE_API_ARMOR
2086 if( !sqlite3SafetyCheckOk(db) ){
2087 (void)SQLITE_MISUSE_BKPT;
2088 return 0;
2089 }
2090#endif
drhe30f4422007-08-21 16:15:55 +00002091 sqlite3_mutex_enter(db->mutex);
2092 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00002093 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00002094 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00002095 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002096 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00002097 return pOld;
drh0d1a6432003-04-03 15:46:04 +00002098}
drh3d2a5292016-07-13 22:55:01 +00002099#endif /* SQLITE_OMIT_DEPRECATED */
2100
2101/* Register a trace callback using the version-2 interface.
2102*/
2103int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00002104 sqlite3 *db, /* Trace this connection */
2105 unsigned mTrace, /* Mask of events to be traced */
2106 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2107 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00002108){
2109#ifdef SQLITE_ENABLE_API_ARMOR
2110 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00002111 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00002112 }
2113#endif
2114 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00002115 if( mTrace==0 ) xTrace = 0;
2116 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00002117 db->mTrace = mTrace;
2118 db->xTrace = xTrace;
2119 db->pTraceArg = pArg;
2120 sqlite3_mutex_leave(db->mutex);
2121 return SQLITE_OK;
2122}
2123
drh087ec072016-07-25 00:05:56 +00002124#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00002125/*
2126** Register a profile function. The pArg from the previously registered
2127** profile function is returned.
2128**
2129** A NULL profile function means that no profiling is executes. A non-NULL
2130** profile is a pointer to a function that is invoked at the conclusion of
2131** each SQL statement that is run.
2132*/
2133void *sqlite3_profile(
2134 sqlite3 *db,
2135 void (*xProfile)(void*,const char*,sqlite_uint64),
2136 void *pArg
2137){
drhe30f4422007-08-21 16:15:55 +00002138 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002139
2140#ifdef SQLITE_ENABLE_API_ARMOR
2141 if( !sqlite3SafetyCheckOk(db) ){
2142 (void)SQLITE_MISUSE_BKPT;
2143 return 0;
2144 }
2145#endif
drhe30f4422007-08-21 16:15:55 +00002146 sqlite3_mutex_enter(db->mutex);
2147 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002148 db->xProfile = xProfile;
2149 db->pProfileArg = pArg;
drh04c67472018-12-04 14:33:02 +00002150 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2151 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
drhe30f4422007-08-21 16:15:55 +00002152 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002153 return pOld;
2154}
drh087ec072016-07-25 00:05:56 +00002155#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002156#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002157
drhcd565fd2012-03-01 21:30:44 +00002158/*
2159** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002160** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002161** rollback.
2162*/
danielk197724b03fd2004-05-10 10:34:34 +00002163void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002164 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002165 int (*xCallback)(void*), /* Function to invoke on each commit */
2166 void *pArg /* Argument to the function */
2167){
drhe30f4422007-08-21 16:15:55 +00002168 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002169
2170#ifdef SQLITE_ENABLE_API_ARMOR
2171 if( !sqlite3SafetyCheckOk(db) ){
2172 (void)SQLITE_MISUSE_BKPT;
2173 return 0;
2174 }
2175#endif
drhe30f4422007-08-21 16:15:55 +00002176 sqlite3_mutex_enter(db->mutex);
2177 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002178 db->xCommitCallback = xCallback;
2179 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002180 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002181 return pOld;
2182}
2183
danielk197794eb6a12005-12-15 15:22:08 +00002184/*
2185** Register a callback to be invoked each time a row is updated,
2186** inserted or deleted using this database connection.
2187*/
danielk197771fd80b2005-12-16 06:54:01 +00002188void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002189 sqlite3 *db, /* Attach the hook to this database */
2190 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2191 void *pArg /* Argument to the function */
2192){
drhe30f4422007-08-21 16:15:55 +00002193 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002194
2195#ifdef SQLITE_ENABLE_API_ARMOR
2196 if( !sqlite3SafetyCheckOk(db) ){
2197 (void)SQLITE_MISUSE_BKPT;
2198 return 0;
2199 }
2200#endif
drhe30f4422007-08-21 16:15:55 +00002201 sqlite3_mutex_enter(db->mutex);
2202 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002203 db->xUpdateCallback = xCallback;
2204 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002205 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002206 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002207}
2208
danielk197771fd80b2005-12-16 06:54:01 +00002209/*
2210** Register a callback to be invoked each time a transaction is rolled
2211** back by this database connection.
2212*/
2213void *sqlite3_rollback_hook(
2214 sqlite3 *db, /* Attach the hook to this database */
2215 void (*xCallback)(void*), /* Callback function */
2216 void *pArg /* Argument to the function */
2217){
drhe30f4422007-08-21 16:15:55 +00002218 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002219
2220#ifdef SQLITE_ENABLE_API_ARMOR
2221 if( !sqlite3SafetyCheckOk(db) ){
2222 (void)SQLITE_MISUSE_BKPT;
2223 return 0;
2224 }
2225#endif
drhe30f4422007-08-21 16:15:55 +00002226 sqlite3_mutex_enter(db->mutex);
2227 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002228 db->xRollbackCallback = xCallback;
2229 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002230 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002231 return pRet;
2232}
drhaa940ea2004-01-15 02:44:03 +00002233
drh9b1c62d2011-03-30 21:04:43 +00002234#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002235/*
2236** Register a callback to be invoked each time a row is updated,
2237** inserted or deleted using this database connection.
2238*/
2239void *sqlite3_preupdate_hook(
2240 sqlite3 *db, /* Attach the hook to this database */
2241 void(*xCallback)( /* Callback function */
2242 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2243 void *pArg /* First callback argument */
2244){
2245 void *pRet;
2246 sqlite3_mutex_enter(db->mutex);
2247 pRet = db->pPreUpdateArg;
2248 db->xPreUpdateCallback = xCallback;
2249 db->pPreUpdateArg = pArg;
2250 sqlite3_mutex_leave(db->mutex);
2251 return pRet;
2252}
drh9b1c62d2011-03-30 21:04:43 +00002253#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002254
dan586b9c82010-05-03 08:04:49 +00002255#ifndef SQLITE_OMIT_WAL
2256/*
2257** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002258** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2259** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002260** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002261*/
drhb033d8b2010-05-03 13:37:30 +00002262int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002263 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002264 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002265 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002266 int nFrame /* Size of WAL */
2267){
drh5def0842010-05-05 20:00:25 +00002268 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002269 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002270 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002271 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002272 }
2273 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002274}
drhb033d8b2010-05-03 13:37:30 +00002275#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002276
2277/*
2278** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2279** a database after committing a transaction if there are nFrame or
2280** more frames in the log file. Passing zero or a negative value as the
2281** nFrame parameter disables automatic checkpoints entirely.
2282**
2283** The callback registered by this function replaces any existing callback
2284** registered using sqlite3_wal_hook(). Likewise, registering a callback
2285** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2286** configured by this function.
2287*/
2288int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002289#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002290 UNUSED_PARAMETER(db);
2291 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002292#else
drh9ca95732014-10-24 00:35:58 +00002293#ifdef SQLITE_ENABLE_API_ARMOR
2294 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2295#endif
dan586b9c82010-05-03 08:04:49 +00002296 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002297 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002298 }else{
2299 sqlite3_wal_hook(db, 0, 0);
2300 }
drhb033d8b2010-05-03 13:37:30 +00002301#endif
dan586b9c82010-05-03 08:04:49 +00002302 return SQLITE_OK;
2303}
2304
paulb0208cc2003-04-13 18:26:49 +00002305/*
dan8d22a172010-04-19 18:03:51 +00002306** Register a callback to be invoked each time a transaction is written
2307** into the write-ahead-log by this database connection.
2308*/
drh833bf962010-04-28 14:42:19 +00002309void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002310 sqlite3 *db, /* Attach the hook to this db handle */
2311 int(*xCallback)(void *, sqlite3*, const char*, int),
2312 void *pArg /* First argument passed to xCallback() */
2313){
drhb033d8b2010-05-03 13:37:30 +00002314#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002315 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002316#ifdef SQLITE_ENABLE_API_ARMOR
2317 if( !sqlite3SafetyCheckOk(db) ){
2318 (void)SQLITE_MISUSE_BKPT;
2319 return 0;
2320 }
2321#endif
dan8d22a172010-04-19 18:03:51 +00002322 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002323 pRet = db->pWalArg;
2324 db->xWalCallback = xCallback;
2325 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002326 sqlite3_mutex_leave(db->mutex);
2327 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002328#else
2329 return 0;
2330#endif
dan8d22a172010-04-19 18:03:51 +00002331}
2332
2333/*
dancdc1f042010-11-18 12:11:05 +00002334** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002335*/
dancdc1f042010-11-18 12:11:05 +00002336int sqlite3_wal_checkpoint_v2(
2337 sqlite3 *db, /* Database handle */
2338 const char *zDb, /* Name of attached database (or NULL) */
2339 int eMode, /* SQLITE_CHECKPOINT_* value */
2340 int *pnLog, /* OUT: Size of WAL log in frames */
2341 int *pnCkpt /* OUT: Total number of frames checkpointed */
2342){
drhb033d8b2010-05-03 13:37:30 +00002343#ifdef SQLITE_OMIT_WAL
2344 return SQLITE_OK;
2345#else
dan586b9c82010-05-03 08:04:49 +00002346 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002347 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002348
drh9ca95732014-10-24 00:35:58 +00002349#ifdef SQLITE_ENABLE_API_ARMOR
2350 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2351#endif
2352
dan9c5e3682011-02-07 15:12:12 +00002353 /* Initialize the output variables to -1 in case an error occurs. */
2354 if( pnLog ) *pnLog = -1;
2355 if( pnCkpt ) *pnCkpt = -1;
2356
danf26a1542014-12-02 19:04:54 +00002357 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2358 assert( SQLITE_CHECKPOINT_FULL==1 );
2359 assert( SQLITE_CHECKPOINT_RESTART==2 );
2360 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2361 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002362 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2363 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002364 return SQLITE_MISUSE;
2365 }
2366
dan586b9c82010-05-03 08:04:49 +00002367 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002368 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002369 iDb = sqlite3FindDbName(db, zDb);
2370 }
2371 if( iDb<0 ){
2372 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002373 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002374 }else{
dan976b0032015-01-29 19:12:12 +00002375 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002376 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002377 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002378 }
drhb033d8b2010-05-03 13:37:30 +00002379 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002380
2381 /* If there are no active statements, clear the interrupt flag at this
2382 ** point. */
2383 if( db->nVdbeActive==0 ){
dan892edb62020-03-30 13:35:05 +00002384 AtomicStore(&db->u1.isInterrupted, 0);
dan7fb89902016-08-12 16:21:15 +00002385 }
2386
dan586b9c82010-05-03 08:04:49 +00002387 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002388 return rc;
2389#endif
dan586b9c82010-05-03 08:04:49 +00002390}
2391
dancdc1f042010-11-18 12:11:05 +00002392
2393/*
2394** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2395** to contains a zero-length string, all attached databases are
2396** checkpointed.
2397*/
2398int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002399 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2400 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2401 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002402}
2403
drhb033d8b2010-05-03 13:37:30 +00002404#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002405/*
2406** Run a checkpoint on database iDb. This is a no-op if database iDb is
2407** not currently open in WAL mode.
2408**
dan6fcff072010-05-03 14:05:43 +00002409** If a transaction is open on the database being checkpointed, this
2410** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2411** an error occurs while running the checkpoint, an SQLite error code is
2412** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002413**
2414** The mutex on database handle db should be held by the caller. The mutex
2415** associated with the specific b-tree being checkpointed is taken by
2416** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002417**
2418** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2419** checkpointed. If an error is encountered it is returned immediately -
2420** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002421**
dan78345512017-09-08 17:48:00 +00002422** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2423** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002424*/
dancdc1f042010-11-18 12:11:05 +00002425int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002426 int rc = SQLITE_OK; /* Return code */
2427 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002428 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002429
2430 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002431 assert( !pnLog || *pnLog==-1 );
2432 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002433
dan6fcff072010-05-03 14:05:43 +00002434 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2435 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002436 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002437 pnLog = 0;
2438 pnCkpt = 0;
2439 if( rc==SQLITE_BUSY ){
2440 bBusy = 1;
2441 rc = SQLITE_OK;
2442 }
dan6fcff072010-05-03 14:05:43 +00002443 }
dan586b9c82010-05-03 08:04:49 +00002444 }
2445
danf2b8dd52010-11-18 19:28:01 +00002446 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002447}
drhb033d8b2010-05-03 13:37:30 +00002448#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002449
2450/*
danielk1977d8293352009-04-30 09:10:37 +00002451** This function returns true if main-memory should be used instead of
2452** a temporary file for transient pager files and statement journals.
2453** The value returned depends on the value of db->temp_store (runtime
2454** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2455** following table describes the relationship between these two values
2456** and this functions return value.
2457**
2458** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2459** ----------------- -------------- ------------------------------
2460** 0 any file (return 0)
2461** 1 1 file (return 0)
2462** 1 2 memory (return 1)
2463** 1 0 file (return 0)
2464** 2 1 file (return 0)
2465** 2 2 memory (return 1)
2466** 2 0 memory (return 1)
2467** 3 any memory (return 1)
2468*/
drh1c514142009-04-30 12:25:10 +00002469int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002470#if SQLITE_TEMP_STORE==1
2471 return ( db->temp_store==2 );
2472#endif
2473#if SQLITE_TEMP_STORE==2
2474 return ( db->temp_store!=1 );
2475#endif
2476#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002477 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002478 return 1;
shanecf697392009-06-01 16:53:09 +00002479#endif
2480#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002481 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002482 return 0;
shane60a4b532009-05-06 18:57:09 +00002483#endif
danielk1977d8293352009-04-30 09:10:37 +00002484}
2485
2486/*
danielk19774ad17132004-05-21 01:47:26 +00002487** Return UTF-8 encoded English language explanation of the most recent
2488** error.
2489*/
danielk19776622cce2004-05-20 11:00:52 +00002490const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002491 const char *z;
drhf49661a2008-12-10 16:45:50 +00002492 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002493 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002494 }
drhd55d57e2008-07-07 17:53:07 +00002495 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002496 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002497 }
drh27641702007-08-22 02:56:42 +00002498 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002499 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002500 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002501 }else{
drha3cc0072013-12-13 16:23:55 +00002502 testcase( db->pErr==0 );
drh368bfe82018-12-11 12:20:41 +00002503 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
danielk1977238746a2009-03-19 18:51:06 +00002504 assert( !db->mallocFailed );
2505 if( z==0 ){
2506 z = sqlite3ErrStr(db->errCode);
2507 }
danielk19776622cce2004-05-20 11:00:52 +00002508 }
drhe30f4422007-08-21 16:15:55 +00002509 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002510 return z;
danielk19776622cce2004-05-20 11:00:52 +00002511}
2512
drh6c626082004-11-14 21:56:29 +00002513#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002514/*
2515** Return UTF-16 encoded English language explanation of the most recent
2516** error.
2517*/
danielk19776622cce2004-05-20 11:00:52 +00002518const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002519 static const u16 outOfMem[] = {
2520 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002521 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002522 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002523 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2524 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2525 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002526 };
danielk19774ad17132004-05-21 01:47:26 +00002527
drhc60d0442004-09-30 13:43:13 +00002528 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002529 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002530 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002531 }
drhd55d57e2008-07-07 17:53:07 +00002532 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002533 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002534 }
drhe30f4422007-08-21 16:15:55 +00002535 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002536 if( db->mallocFailed ){
2537 z = (void *)outOfMem;
2538 }else{
drhc60d0442004-09-30 13:43:13 +00002539 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002540 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002541 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002542 z = sqlite3_value_text16(db->pErr);
2543 }
2544 /* A malloc() may have failed within the call to sqlite3_value_text16()
2545 ** above. If this is the case, then the db->mallocFailed flag needs to
2546 ** be cleared before returning. Do this directly, instead of via
2547 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2548 */
drh4a642b62016-02-05 01:55:27 +00002549 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002550 }
drhe30f4422007-08-21 16:15:55 +00002551 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002552 return z;
danielk19776622cce2004-05-20 11:00:52 +00002553}
drh6c626082004-11-14 21:56:29 +00002554#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002555
drhc60d0442004-09-30 13:43:13 +00002556/*
danielk19777ddad962005-12-12 06:53:03 +00002557** Return the most recent error code generated by an SQLite routine. If NULL is
2558** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002559*/
danielk19776622cce2004-05-20 11:00:52 +00002560int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002561 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002562 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002563 }
drh01495b92008-01-23 12:52:40 +00002564 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002565 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002566 }
drh4ac285a2006-09-15 07:28:50 +00002567 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002568}
drh99dfe5e2008-10-30 15:03:15 +00002569int sqlite3_extended_errcode(sqlite3 *db){
2570 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002571 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002572 }
2573 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002574 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002575 }
2576 return db->errCode;
2577}
drh1b9f2142016-03-17 16:01:23 +00002578int sqlite3_system_errno(sqlite3 *db){
2579 return db ? db->iSysErrno : 0;
2580}
danielk19776622cce2004-05-20 11:00:52 +00002581
drh0e819f92006-02-01 13:50:41 +00002582/*
mistachkin5dac8432012-09-11 02:00:25 +00002583** Return a string that describes the kind of error specified in the
2584** argument. For now, this simply calls the internal sqlite3ErrStr()
2585** function.
2586*/
2587const char *sqlite3_errstr(int rc){
2588 return sqlite3ErrStr(rc);
2589}
2590
2591/*
drh0e819f92006-02-01 13:50:41 +00002592** Create a new collating function for database "db". The name is zName
2593** and the encoding is enc.
2594*/
danielk19779a30cf62006-01-18 04:26:07 +00002595static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002596 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002597 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002598 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002599 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002600 int(*xCompare)(void*,int,const void*,int,const void*),
2601 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002602){
2603 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002604 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002605
drhe30f4422007-08-21 16:15:55 +00002606 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002607
2608 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2609 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2610 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2611 */
drh51c7d862009-04-27 18:46:06 +00002612 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002613 testcase( enc2==SQLITE_UTF16 );
2614 testcase( enc2==SQLITE_UTF16_ALIGNED );
2615 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002616 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002617 }
drh51c7d862009-04-27 18:46:06 +00002618 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002619 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002620 }
2621
2622 /* Check if this call is removing or replacing an existing collation
2623 ** sequence. If so, and there are active VMs, return busy. If there
2624 ** are no active VMs, invalidate any pre-compiled statements.
2625 */
drhc4a64fa2009-05-11 20:53:28 +00002626 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002627 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002628 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002629 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002630 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002631 return SQLITE_BUSY;
2632 }
drhba968db2018-07-24 22:02:12 +00002633 sqlite3ExpirePreparedStatements(db, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002634
2635 /* If collation sequence pColl was created directly by a call to
2636 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2637 ** then any copies made by synthCollSeq() need to be invalidated.
2638 ** Also, collation destructor - CollSeq.xDel() - function may need
2639 ** to be called.
2640 */
2641 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002642 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002643 int j;
2644 for(j=0; j<3; j++){
2645 CollSeq *p = &aColl[j];
2646 if( p->enc==pColl->enc ){
2647 if( p->xDel ){
2648 p->xDel(p->pUser);
2649 }
2650 p->xCmp = 0;
2651 }
2652 }
2653 }
danielk19779a30cf62006-01-18 04:26:07 +00002654 }
2655
drhc4a64fa2009-05-11 20:53:28 +00002656 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002657 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002658 pColl->xCmp = xCompare;
2659 pColl->pUser = pCtx;
2660 pColl->xDel = xDel;
2661 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002662 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002663 return SQLITE_OK;
2664}
2665
2666
danielk19776622cce2004-05-20 11:00:52 +00002667/*
drhbb4957f2008-03-20 14:03:29 +00002668** This array defines hard upper bounds on limit values. The
2669** initializer must be kept in sync with the SQLITE_LIMIT_*
2670** #defines in sqlite3.h.
2671*/
drhb1a6c3c2008-03-20 16:30:17 +00002672static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002673 SQLITE_MAX_LENGTH,
2674 SQLITE_MAX_SQL_LENGTH,
2675 SQLITE_MAX_COLUMN,
2676 SQLITE_MAX_EXPR_DEPTH,
2677 SQLITE_MAX_COMPOUND_SELECT,
2678 SQLITE_MAX_VDBE_OP,
2679 SQLITE_MAX_FUNCTION_ARG,
2680 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002681 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002682 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002683 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002684 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002685};
2686
2687/*
2688** Make sure the hard limits are set to reasonable values
2689*/
2690#if SQLITE_MAX_LENGTH<100
2691# error SQLITE_MAX_LENGTH must be at least 100
2692#endif
2693#if SQLITE_MAX_SQL_LENGTH<100
2694# error SQLITE_MAX_SQL_LENGTH must be at least 100
2695#endif
2696#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2697# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2698#endif
drhbb4957f2008-03-20 14:03:29 +00002699#if SQLITE_MAX_COMPOUND_SELECT<2
2700# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2701#endif
2702#if SQLITE_MAX_VDBE_OP<40
2703# error SQLITE_MAX_VDBE_OP must be at least 40
2704#endif
drh80738d92016-02-15 00:34:16 +00002705#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2706# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002707#endif
drhd08b2792014-07-22 15:33:31 +00002708#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2709# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002710#endif
drhbb4957f2008-03-20 14:03:29 +00002711#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2712# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2713#endif
drh70a8ca32008-08-21 18:49:27 +00002714#if SQLITE_MAX_COLUMN>32767
2715# error SQLITE_MAX_COLUMN must not exceed 32767
2716#endif
drh417168a2009-09-07 18:14:02 +00002717#if SQLITE_MAX_TRIGGER_DEPTH<1
2718# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2719#endif
drh111544c2014-08-29 16:20:47 +00002720#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2721# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2722#endif
drhbb4957f2008-03-20 14:03:29 +00002723
2724
2725/*
2726** Change the value of a limit. Report the old value.
2727** If an invalid limit index is supplied, report -1.
2728** Make no changes but still report the old value if the
2729** new limit is negative.
2730**
2731** A new lower limit does not shrink existing constructs.
2732** It merely prevents new constructs that exceed the limit
2733** from forming.
2734*/
2735int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2736 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002737
drh9ca95732014-10-24 00:35:58 +00002738#ifdef SQLITE_ENABLE_API_ARMOR
2739 if( !sqlite3SafetyCheckOk(db) ){
2740 (void)SQLITE_MISUSE_BKPT;
2741 return -1;
2742 }
2743#endif
drh4e93f5b2010-09-07 14:59:15 +00002744
2745 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2746 ** there is a hard upper bound set at compile-time by a C preprocessor
2747 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2748 ** "_MAX_".)
2749 */
2750 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2751 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2752 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2753 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2754 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2755 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2756 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2757 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2758 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2759 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2760 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2761 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002762 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2763 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002764
2765
drh521cc842008-04-15 02:36:33 +00002766 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002767 return -1;
2768 }
2769 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002770 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002771 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002772 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002773 }
2774 db->aLimit[limitId] = newLimit;
2775 }
drh4e93f5b2010-09-07 14:59:15 +00002776 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002777}
2778
2779/*
dan286ab7c2011-05-06 18:34:54 +00002780** This function is used to parse both URIs and non-URI filenames passed by the
2781** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2782** URIs specified as part of ATTACH statements.
2783**
2784** The first argument to this function is the name of the VFS to use (or
2785** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2786** query parameter. The second argument contains the URI (or non-URI filename)
2787** itself. When this function is called the *pFlags variable should contain
2788** the default flags to open the database handle with. The value stored in
2789** *pFlags may be updated before returning if the URI filename contains
2790** "cache=xxx" or "mode=xxx" query parameters.
2791**
2792** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2793** the VFS that should be used to open the database file. *pzFile is set to
drhdf97d432020-02-27 11:32:14 +00002794** point to a buffer containing the name of the file to open. The value
2795** stored in *pzFile is a database name acceptable to sqlite3_uri_parameter()
2796** and is in the same format as names created using sqlite3_create_filename().
2797** The caller must invoke sqlite3_free_filename() (not sqlite3_free()!) on
2798** the value returned in *pzFile to avoid a memory leak.
dan286ab7c2011-05-06 18:34:54 +00002799**
2800** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2801** may be set to point to a buffer containing an English language error
2802** message. It is the responsibility of the caller to eventually release
2803** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002804*/
2805int sqlite3ParseUri(
2806 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2807 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002808 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002809 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2810 char **pzFile, /* OUT: Filename component of URI */
2811 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2812){
dan78e9dd22011-05-03 10:22:32 +00002813 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002814 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002815 const char *zVfs = zDefaultVfs;
2816 char *zFile;
drhde941c32011-05-09 19:20:17 +00002817 char c;
dancd74b612011-04-22 19:37:32 +00002818 int nUri = sqlite3Strlen30(zUri);
2819
2820 assert( *pzErrMsg==0 );
2821
drh8790b6e2014-11-07 01:43:56 +00002822 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2823 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002824 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002825 ){
dan5de15372011-04-23 10:12:30 +00002826 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002827 int eState; /* Parser state when parsing URI */
2828 int iIn; /* Input character index */
2829 int iOut = 0; /* Output character index */
drhdf97d432020-02-27 11:32:14 +00002830 u64 nByte = nUri+8; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002831
dan286ab7c2011-05-06 18:34:54 +00002832 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2833 ** method that there may be extra parameters following the file-name. */
2834 flags |= SQLITE_OPEN_URI;
2835
2836 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002837 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002838 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002839
drhdf97d432020-02-27 11:32:14 +00002840 memset(zFile, 0, 4); /* 4-byte of 0x00 is the start of DB name marker */
2841 zFile += 4;
2842
drh869c0402013-08-07 23:15:52 +00002843 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002844#ifdef SQLITE_ALLOW_URI_AUTHORITY
2845 if( strncmp(zUri+5, "///", 3)==0 ){
2846 iIn = 7;
2847 /* The following condition causes URIs with five leading / characters
2848 ** like file://///host/path to be converted into UNCs like //host/path.
2849 ** The correct URI for that UNC has only two or four leading / characters
2850 ** file://host/path or file:////host/path. But 5 leading slashes is a
2851 ** common error, we are told, so we handle it as a special case. */
2852 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2853 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2854 iIn = 16;
2855 }
2856#else
dancd74b612011-04-22 19:37:32 +00002857 /* Discard the scheme and authority segments of the URI. */
2858 if( zUri[5]=='/' && zUri[6]=='/' ){
2859 iIn = 7;
2860 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002861 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2862 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2863 iIn-7, &zUri[7]);
2864 rc = SQLITE_ERROR;
2865 goto parse_uri_out;
2866 }
dancd74b612011-04-22 19:37:32 +00002867 }
drh869c0402013-08-07 23:15:52 +00002868#endif
dancd74b612011-04-22 19:37:32 +00002869
2870 /* Copy the filename and any query parameters into the zFile buffer.
2871 ** Decode %HH escape codes along the way.
2872 **
2873 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2874 ** on the parsing context. As follows:
2875 **
2876 ** 0: Parsing file-name.
2877 ** 1: Parsing name section of a name=value query parameter.
2878 ** 2: Parsing value section of a name=value query parameter.
2879 */
2880 eState = 0;
drhde941c32011-05-09 19:20:17 +00002881 while( (c = zUri[iIn])!=0 && c!='#' ){
2882 iIn++;
dancd74b612011-04-22 19:37:32 +00002883 if( c=='%'
2884 && sqlite3Isxdigit(zUri[iIn])
2885 && sqlite3Isxdigit(zUri[iIn+1])
2886 ){
dan6d49e252011-05-03 15:09:05 +00002887 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2888 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002889
dan6d49e252011-05-03 15:09:05 +00002890 assert( octet>=0 && octet<256 );
2891 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002892#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002893 /* This branch is taken when "%00" appears within the URI. In this
2894 ** case we ignore all text in the remainder of the path, name or
2895 ** value currently being parsed. So ignore the current character
2896 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002897 while( (c = zUri[iIn])!=0 && c!='#'
2898 && (eState!=0 || c!='?')
2899 && (eState!=1 || (c!='=' && c!='&'))
2900 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002901 ){
2902 iIn++;
2903 }
2904 continue;
dan5c35e902016-10-26 12:15:41 +00002905#else
2906 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2907 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2908 rc = SQLITE_ERROR;
2909 goto parse_uri_out;
2910#endif
dancd74b612011-04-22 19:37:32 +00002911 }
dan6d49e252011-05-03 15:09:05 +00002912 c = octet;
dan5de15372011-04-23 10:12:30 +00002913 }else if( eState==1 && (c=='&' || c=='=') ){
2914 if( zFile[iOut-1]==0 ){
2915 /* An empty option name. Ignore this option altogether. */
2916 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2917 continue;
2918 }
2919 if( c=='&' ){
2920 zFile[iOut++] = '\0';
2921 }else{
2922 eState = 2;
2923 }
dancd74b612011-04-22 19:37:32 +00002924 c = 0;
dan5de15372011-04-23 10:12:30 +00002925 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2926 c = 0;
dancd74b612011-04-22 19:37:32 +00002927 eState = 1;
dancd74b612011-04-22 19:37:32 +00002928 }
2929 zFile[iOut++] = c;
2930 }
2931 if( eState==1 ) zFile[iOut++] = '\0';
drhdf97d432020-02-27 11:32:14 +00002932 memset(zFile+iOut, 0, 4); /* end-of-options + empty journal filenames */
dancd74b612011-04-22 19:37:32 +00002933
2934 /* Check if there were any options specified that should be interpreted
2935 ** here. Options that are interpreted here include "vfs" and those that
2936 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002937 ** method. */
dan5de15372011-04-23 10:12:30 +00002938 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2939 while( zOpt[0] ){
2940 int nOpt = sqlite3Strlen30(zOpt);
2941 char *zVal = &zOpt[nOpt+1];
2942 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002943
dan286ab7c2011-05-06 18:34:54 +00002944 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002945 zVfs = zVal;
2946 }else{
2947 struct OpenMode {
2948 const char *z;
2949 int mode;
2950 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002951 char *zModeType = 0;
2952 int mask = 0;
2953 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002954
dan286ab7c2011-05-06 18:34:54 +00002955 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002956 static struct OpenMode aCacheMode[] = {
2957 { "shared", SQLITE_OPEN_SHAREDCACHE },
2958 { "private", SQLITE_OPEN_PRIVATECACHE },
2959 { 0, 0 }
2960 };
2961
2962 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2963 aMode = aCacheMode;
2964 limit = mask;
2965 zModeType = "cache";
2966 }
dan286ab7c2011-05-06 18:34:54 +00002967 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002968 static struct OpenMode aOpenMode[] = {
2969 { "ro", SQLITE_OPEN_READONLY },
2970 { "rw", SQLITE_OPEN_READWRITE },
2971 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002972 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002973 { 0, 0 }
2974 };
2975
drh9c67b2a2012-05-28 13:58:00 +00002976 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2977 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002978 aMode = aOpenMode;
2979 limit = mask & flags;
2980 zModeType = "access";
2981 }
2982
2983 if( aMode ){
2984 int i;
2985 int mode = 0;
2986 for(i=0; aMode[i].z; i++){
2987 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002988 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002989 mode = aMode[i].mode;
2990 break;
dancd74b612011-04-22 19:37:32 +00002991 }
2992 }
dan78e9dd22011-05-03 10:22:32 +00002993 if( mode==0 ){
2994 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2995 rc = SQLITE_ERROR;
2996 goto parse_uri_out;
2997 }
drh9c67b2a2012-05-28 13:58:00 +00002998 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002999 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
3000 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00003001 rc = SQLITE_PERM;
3002 goto parse_uri_out;
3003 }
3004 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00003005 }
dancd74b612011-04-22 19:37:32 +00003006 }
dan5de15372011-04-23 10:12:30 +00003007
3008 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00003009 }
3010
3011 }else{
drhdf97d432020-02-27 11:32:14 +00003012 zFile = sqlite3_malloc64(nUri+8);
mistachkinfad30392016-02-13 23:43:46 +00003013 if( !zFile ) return SQLITE_NOMEM_BKPT;
drhdf97d432020-02-27 11:32:14 +00003014 memset(zFile, 0, 4);
3015 zFile += 4;
dan895decf2016-12-30 14:15:56 +00003016 if( nUri ){
3017 memcpy(zFile, zUri, nUri);
3018 }
drhdf97d432020-02-27 11:32:14 +00003019 memset(zFile+nUri, 0, 4);
drh4ab9d252012-05-26 20:08:49 +00003020 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00003021 }
3022
3023 *ppVfs = sqlite3_vfs_find(zVfs);
3024 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00003025 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00003026 rc = SQLITE_ERROR;
3027 }
3028 parse_uri_out:
3029 if( rc!=SQLITE_OK ){
drhdf97d432020-02-27 11:32:14 +00003030 sqlite3_free_filename(zFile);
dan78e9dd22011-05-03 10:22:32 +00003031 zFile = 0;
dancd74b612011-04-22 19:37:32 +00003032 }
3033 *pFlags = flags;
3034 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00003035 return rc;
dancd74b612011-04-22 19:37:32 +00003036}
3037
drh1eac9662020-02-01 13:30:39 +00003038/*
3039** This routine does the core work of extracting URI parameters from a
3040** database filename for the sqlite3_uri_parameter() interface.
3041*/
3042static const char *uriParameter(const char *zFilename, const char *zParam){
3043 zFilename += sqlite3Strlen30(zFilename) + 1;
3044 while( zFilename[0] ){
3045 int x = strcmp(zFilename, zParam);
3046 zFilename += sqlite3Strlen30(zFilename) + 1;
3047 if( x==0 ) return zFilename;
3048 zFilename += sqlite3Strlen30(zFilename) + 1;
3049 }
3050 return 0;
3051}
3052
drhe5989722019-02-02 15:59:49 +00003053
dancd74b612011-04-22 19:37:32 +00003054
3055/*
danielk19774ad17132004-05-21 01:47:26 +00003056** This routine does the work of opening a database on behalf of
3057** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00003058** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00003059*/
3060static int openDatabase(
3061 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00003062 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00003063 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00003064 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00003065){
dancd74b612011-04-22 19:37:32 +00003066 sqlite3 *db; /* Store allocated handle here */
3067 int rc; /* Return code */
3068 int isThreadsafe; /* True for threadsafe connections */
3069 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
3070 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
drh20e34f92020-05-04 17:15:21 +00003071 int i; /* Loop counter */
danielk19774ad17132004-05-21 01:47:26 +00003072
drh9ca95732014-10-24 00:35:58 +00003073#ifdef SQLITE_ENABLE_API_ARMOR
3074 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3075#endif
drhe0d0f8e2009-04-28 04:47:31 +00003076 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003077#ifndef SQLITE_OMIT_AUTOINIT
3078 rc = sqlite3_initialize();
3079 if( rc ) return rc;
3080#endif
3081
drh039963a2008-09-03 00:43:15 +00003082 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00003083 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00003084 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3085 isThreadsafe = 0;
3086 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3087 isThreadsafe = 1;
3088 }else{
3089 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00003090 }
dan8385bec2017-11-25 17:51:01 +00003091
drhf1f12682009-09-09 14:17:52 +00003092 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00003093 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00003094 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3095 flags |= SQLITE_OPEN_SHAREDCACHE;
3096 }
danielk19779a6284c2008-07-10 17:52:49 +00003097
drhb25a9f42009-05-12 13:35:11 +00003098 /* Remove harmful bits from the flags parameter
3099 **
3100 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3101 ** dealt with in the previous code block. Besides these, the only
3102 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00003103 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3104 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00003105 ** off all other flags.
3106 */
drha4267dc2008-02-19 15:20:44 +00003107 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00003108 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00003109 SQLITE_OPEN_MAIN_DB |
3110 SQLITE_OPEN_TEMP_DB |
3111 SQLITE_OPEN_TRANSIENT_DB |
3112 SQLITE_OPEN_MAIN_JOURNAL |
3113 SQLITE_OPEN_TEMP_JOURNAL |
3114 SQLITE_OPEN_SUBJOURNAL |
drhccb21132020-06-19 11:34:57 +00003115 SQLITE_OPEN_SUPER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003116 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003117 SQLITE_OPEN_FULLMUTEX |
3118 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003119 );
3120
danielk19774ad17132004-05-21 01:47:26 +00003121 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003122 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003123 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003124 if( isThreadsafe
3125#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3126 || sqlite3GlobalConfig.bCoreMutex
3127#endif
3128 ){
danielk197759f8c082008-06-18 17:09:10 +00003129 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3130 if( db->mutex==0 ){
3131 sqlite3_free(db);
3132 db = 0;
3133 goto opendb_out;
3134 }
dan8385bec2017-11-25 17:51:01 +00003135 if( isThreadsafe==0 ){
3136 sqlite3MutexWarnOnContention(db->mutex);
3137 }
drh605264d2007-08-21 15:13:19 +00003138 }
drh27641702007-08-22 02:56:42 +00003139 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003140 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003141 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003142 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003143 db->aDb = db->aDbStatic;
danc4b1e5e2018-09-18 17:50:34 +00003144 db->lookaside.bDisable = 1;
drh31f69622019-10-05 14:39:36 +00003145 db->lookaside.sz = 0;
drh633e6d52008-07-28 19:34:53 +00003146
drhbb4957f2008-03-20 14:03:29 +00003147 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3148 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003149 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003150 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003151 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003152 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003153 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003154 db->nMaxSorterMmap = 0x7FFFFFFF;
drh4b50da92019-07-02 12:23:09 +00003155 db->flags |= SQLITE_ShortColNames
3156 | SQLITE_EnableTrigger
drh11d88e62019-08-15 21:27:20 +00003157 | SQLITE_EnableView
drh4b50da92019-07-02 12:23:09 +00003158 | SQLITE_CacheSpill
drhb77da372020-01-07 16:09:11 +00003159#if !defined(SQLITE_TRUSTED_SCHEMA) || SQLITE_TRUSTED_SCHEMA+0!=0
3160 | SQLITE_TrustedSchema
3161#endif
drh4b50da92019-07-02 12:23:09 +00003162/* The SQLITE_DQS compile-time option determines the default settings
3163** for SQLITE_DBCONFIG_DQS_DDL and SQLITE_DBCONFIG_DQS_DML.
3164**
3165** SQLITE_DQS SQLITE_DBCONFIG_DQS_DDL SQLITE_DBCONFIG_DQS_DML
3166** ---------- ----------------------- -----------------------
3167** undefined on on
3168** 3 on on
3169** 2 on off
3170** 1 off on
3171** 0 off off
3172**
3173** Legacy behavior is 3 (double-quoted string literals are allowed anywhere)
3174** and so that is the default. But developers are encouranged to use
3175** -DSQLITE_DQS=0 (best) or -DSQLITE_DQS=1 (second choice) if possible.
3176*/
3177#if !defined(SQLITE_DQS)
3178# define SQLITE_DQS 3
3179#endif
3180#if (SQLITE_DQS&1)==1
drhd0ff6012019-06-17 13:56:11 +00003181 | SQLITE_DqsDML
drh4b50da92019-07-02 12:23:09 +00003182#endif
3183#if (SQLITE_DQS&2)==2
3184 | SQLITE_DqsDDL
3185#endif
3186
dan1d1f07d2013-07-25 16:41:39 +00003187#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003188 | SQLITE_AutoIndex
3189#endif
drh883ad042015-02-19 00:29:11 +00003190#if SQLITE_DEFAULT_CKPTFULLFSYNC
3191 | SQLITE_CkptFullFSync
3192#endif
drh76fe8032006-07-11 14:17:51 +00003193#if SQLITE_DEFAULT_FILE_FORMAT<4
3194 | SQLITE_LegacyFileFmt
3195#endif
drh56424db2007-03-27 22:24:11 +00003196#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3197 | SQLITE_LoadExtension
3198#endif
dan5bde73c2009-09-01 17:11:07 +00003199#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003200 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003201#endif
drha4bfd7f2010-12-09 19:15:17 +00003202#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3203 | SQLITE_ForeignKeys
3204#endif
drhf5471922014-12-09 15:12:11 +00003205#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3206 | SQLITE_ReverseOrder
3207#endif
drh1421d982015-05-27 03:46:18 +00003208#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3209 | SQLITE_CellSizeCk
3210#endif
drhd42908f2016-02-26 15:38:24 +00003211#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3212 | SQLITE_Fts3Tokenizer
3213#endif
drh169dd922017-06-26 13:57:49 +00003214#if defined(SQLITE_ENABLE_QPSG)
3215 | SQLITE_EnableQPSG
3216#endif
drh6ab91a72018-11-07 02:17:01 +00003217#if defined(SQLITE_DEFAULT_DEFENSIVE)
3218 | SQLITE_Defensive
3219#endif
drhe0a8b712020-05-06 18:43:57 +00003220#if defined(SQLITE_DEFAULT_LEGACY_ALTER_TABLE)
3221 | SQLITE_LegacyAlter
3222#endif
drh76fe8032006-07-11 14:17:51 +00003223 ;
drhe61922a2009-05-02 13:29:37 +00003224 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003225#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003226 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003227#endif
danielk1977da184232006-01-05 11:34:32 +00003228
danielk19770202b292004-06-09 09:55:16 +00003229 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3230 ** and UTF-16, so add a version for each to avoid any unnecessary
3231 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003232 **
3233 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3234 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003235 */
drhf19aa5f2015-12-30 16:51:20 +00003236 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3237 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3238 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003239 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh821afa42019-06-14 13:24:46 +00003240 createCollation(db, "RTRIM", SQLITE_UTF8, 0, rtrimCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003241 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003242 goto opendb_out;
3243 }
3244
drhff4fa772017-07-10 12:07:53 +00003245 /* Parse the filename/URI argument
3246 **
3247 ** Only allow sensible combinations of bits in the flags argument.
3248 ** Throw an error if any non-sense combination is used. If we
3249 ** do not block illegal combinations here, it could trigger
3250 ** assert() statements in deeper layers. Sensible combinations
3251 ** are:
3252 **
3253 ** 1: SQLITE_OPEN_READONLY
3254 ** 2: SQLITE_OPEN_READWRITE
3255 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3256 */
dan19432992011-05-10 18:39:10 +00003257 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003258 assert( SQLITE_OPEN_READONLY == 0x01 );
3259 assert( SQLITE_OPEN_READWRITE == 0x02 );
3260 assert( SQLITE_OPEN_CREATE == 0x04 );
3261 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3262 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3263 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3264 if( ((1<<(flags&7)) & 0x46)==0 ){
drhbbf6d432020-05-15 15:03:51 +00003265 rc = SQLITE_MISUSE_BKPT; /* IMP: R-18321-05872 */
drhff4fa772017-07-10 12:07:53 +00003266 }else{
3267 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3268 }
dancd74b612011-04-22 19:37:32 +00003269 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003270 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003271 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003272 sqlite3_free(zErrMsg);
3273 goto opendb_out;
3274 }
3275
danielk19774ad17132004-05-21 01:47:26 +00003276 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003277 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003278 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003279 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003280 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003281 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003282 }
drh13f40da2014-08-22 18:00:11 +00003283 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003284 goto opendb_out;
3285 }
dan0235a032014-12-08 20:20:16 +00003286 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003287 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh42a630b2020-03-05 16:13:24 +00003288 if( !db->mallocFailed ){
3289 sqlite3SetTextEncoding(db, SCHEMA_ENC(db));
3290 }
dan0235a032014-12-08 20:20:16 +00003291 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003292 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003293
drhe872d512016-02-22 13:23:16 +00003294 /* The default safety_level for the main database is FULL; for the temp
3295 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003296 */
drh69c33822016-08-18 14:33:11 +00003297 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003298 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003299 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003300 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003301
danielk1977832a58a2007-06-22 15:21:15 +00003302 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003303 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003304 goto opendb_out;
3305 }
3306
danielk19778e227872004-06-07 07:52:17 +00003307 /* Register all built-in functions, but do not attempt to read the
3308 ** database schema yet. This is delayed until the first time the database
3309 ** is accessed.
3310 */
drh13f40da2014-08-22 18:00:11 +00003311 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003312 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003313 rc = sqlite3_errcode(db);
3314
drh20e34f92020-05-04 17:15:21 +00003315
3316 /* Load compiled-in extensions */
3317 for(i=0; rc==SQLITE_OK && i<ArraySize(sqlite3BuiltinExtensions); i++){
3318 rc = sqlite3BuiltinExtensions[i](db);
danc9e75fb2016-08-19 18:37:35 +00003319 }
danielk19774ad17132004-05-21 01:47:26 +00003320
drh1409be62006-08-23 20:07:20 +00003321 /* Load automatic extensions - extensions that have been registered
3322 ** using the sqlite3_automatic_extension() API.
3323 */
drhe5077c12011-12-13 04:08:36 +00003324 if( rc==SQLITE_OK ){
3325 sqlite3AutoLoadExtensions(db);
3326 rc = sqlite3_errcode(db);
3327 if( rc!=SQLITE_OK ){
3328 goto opendb_out;
3329 }
danielk1977832a58a2007-06-22 15:21:15 +00003330 }
drh1409be62006-08-23 20:07:20 +00003331
drh2a83c102020-01-01 23:02:35 +00003332#ifdef SQLITE_ENABLE_INTERNAL_FUNCTIONS
3333 /* Testing use only!!! The -DSQLITE_ENABLE_INTERNAL_FUNCTIONS=1 compile-time
3334 ** option gives access to internal functions by default.
3335 ** Testing use only!!! */
3336 db->mDbFlags |= DBFLAG_InternalFunc;
3337#endif
3338
drh8fd5bd32007-04-02 16:40:37 +00003339 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3340 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3341 ** mode. Doing nothing at all also makes NORMAL the default.
3342 */
3343#ifdef SQLITE_DEFAULT_LOCKING_MODE
3344 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3345 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3346 SQLITE_DEFAULT_LOCKING_MODE);
3347#endif
3348
drh13f40da2014-08-22 18:00:11 +00003349 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003350
drh633e6d52008-07-28 19:34:53 +00003351 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003352 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3353 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003354
dan5a299f92010-05-03 11:05:08 +00003355 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003356
danielk19774ad17132004-05-21 01:47:26 +00003357opendb_out:
drhafc91042008-02-21 02:09:45 +00003358 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003359 assert( db->mutex!=0 || isThreadsafe==0
3360 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003361 sqlite3_mutex_leave(db->mutex);
3362 }
danielk197759633ae2008-08-27 19:01:57 +00003363 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003364 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003365 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003366 sqlite3_close(db);
3367 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003368 }else if( rc!=SQLITE_OK ){
3369 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003370 }
danielk19774ad17132004-05-21 01:47:26 +00003371 *ppDb = db;
danac455932012-11-26 19:50:41 +00003372#ifdef SQLITE_ENABLE_SQLLOG
3373 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003374 /* Opening a db handle. Fourth parameter is passed 0. */
3375 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3376 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003377 }
3378#endif
drhdf97d432020-02-27 11:32:14 +00003379 sqlite3_free_filename(zOpen);
drh597d2b62015-06-30 03:13:47 +00003380 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003381}
3382
drhe5989722019-02-02 15:59:49 +00003383
danielk19774ad17132004-05-21 01:47:26 +00003384/*
3385** Open a new database handle.
3386*/
danielk197780290862004-05-22 09:21:21 +00003387int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003388 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003389 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003390){
drh605264d2007-08-21 15:13:19 +00003391 return openDatabase(zFilename, ppDb,
3392 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3393}
3394int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003395 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003396 sqlite3 **ppDb, /* OUT: SQLite db handle */
3397 int flags, /* Flags */
3398 const char *zVfs /* Name of VFS module to use */
3399){
drh522c26f2011-05-07 14:40:29 +00003400 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003401}
3402
drh6c626082004-11-14 21:56:29 +00003403#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003404/*
3405** Open a new database handle.
3406*/
3407int sqlite3_open16(
3408 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003409 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003410){
danielk1977bfd6cce2004-06-18 04:24:54 +00003411 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003412 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003413 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003414
drh9ca95732014-10-24 00:35:58 +00003415#ifdef SQLITE_ENABLE_API_ARMOR
3416 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3417#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003418 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003419#ifndef SQLITE_OMIT_AUTOINIT
3420 rc = sqlite3_initialize();
3421 if( rc ) return rc;
3422#endif
drh9ca95732014-10-24 00:35:58 +00003423 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003424 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003425 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3426 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003427 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003428 rc = openDatabase(zFilename8, ppDb,
3429 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003430 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003431 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003432 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003433 }
drh40257ff2008-06-13 18:24:27 +00003434 }else{
mistachkinfad30392016-02-13 23:43:46 +00003435 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003436 }
danielk19777ddad962005-12-12 06:53:03 +00003437 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003438
drh597d2b62015-06-30 03:13:47 +00003439 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003440}
drh6c626082004-11-14 21:56:29 +00003441#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003442
danielk1977106bb232004-05-21 10:08:53 +00003443/*
danielk1977d8123362004-06-12 09:25:12 +00003444** Register a new collation sequence with the database handle db.
3445*/
danielk19770202b292004-06-09 09:55:16 +00003446int sqlite3_create_collation(
3447 sqlite3* db,
3448 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003449 int enc,
danielk19770202b292004-06-09 09:55:16 +00003450 void* pCtx,
3451 int(*xCompare)(void*,int,const void*,int,const void*)
3452){
drh4f81bbb2014-10-23 01:01:26 +00003453 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003454}
3455
3456/*
3457** Register a new collation sequence with the database handle db.
3458*/
danielk1977a393c032007-05-07 14:58:53 +00003459int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003460 sqlite3* db,
3461 const char *zName,
3462 int enc,
3463 void* pCtx,
3464 int(*xCompare)(void*,int,const void*,int,const void*),
3465 void(*xDel)(void*)
3466){
3467 int rc;
drh9ca95732014-10-24 00:35:58 +00003468
3469#ifdef SQLITE_ENABLE_API_ARMOR
3470 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3471#endif
drhe30f4422007-08-21 16:15:55 +00003472 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003473 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003474 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003475 rc = sqlite3ApiExit(db, rc);
3476 sqlite3_mutex_leave(db->mutex);
3477 return rc;
danielk19770202b292004-06-09 09:55:16 +00003478}
3479
drh6c626082004-11-14 21:56:29 +00003480#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003481/*
3482** Register a new collation sequence with the database handle db.
3483*/
danielk19770202b292004-06-09 09:55:16 +00003484int sqlite3_create_collation16(
3485 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003486 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003487 int enc,
danielk19770202b292004-06-09 09:55:16 +00003488 void* pCtx,
3489 int(*xCompare)(void*,int,const void*,int,const void*)
3490){
danielk19779a30cf62006-01-18 04:26:07 +00003491 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003492 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003493
3494#ifdef SQLITE_ENABLE_API_ARMOR
3495 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3496#endif
drhe30f4422007-08-21 16:15:55 +00003497 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003498 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003499 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003500 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003501 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003502 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003503 }
drhe30f4422007-08-21 16:15:55 +00003504 rc = sqlite3ApiExit(db, rc);
3505 sqlite3_mutex_leave(db->mutex);
3506 return rc;
danielk19770202b292004-06-09 09:55:16 +00003507}
drh6c626082004-11-14 21:56:29 +00003508#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003509
danielk1977d8123362004-06-12 09:25:12 +00003510/*
3511** Register a collation sequence factory callback with the database handle
3512** db. Replace any previously installed collation sequence factory.
3513*/
danielk19777cedc8d2004-06-10 10:50:08 +00003514int sqlite3_collation_needed(
3515 sqlite3 *db,
3516 void *pCollNeededArg,
3517 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3518){
drh9ca95732014-10-24 00:35:58 +00003519#ifdef SQLITE_ENABLE_API_ARMOR
3520 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3521#endif
drhe30f4422007-08-21 16:15:55 +00003522 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003523 db->xCollNeeded = xCollNeeded;
3524 db->xCollNeeded16 = 0;
3525 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003526 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003527 return SQLITE_OK;
3528}
danielk1977d8123362004-06-12 09:25:12 +00003529
drh6c626082004-11-14 21:56:29 +00003530#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003531/*
3532** Register a collation sequence factory callback with the database handle
3533** db. Replace any previously installed collation sequence factory.
3534*/
danielk19777cedc8d2004-06-10 10:50:08 +00003535int sqlite3_collation_needed16(
3536 sqlite3 *db,
3537 void *pCollNeededArg,
3538 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3539){
drh9ca95732014-10-24 00:35:58 +00003540#ifdef SQLITE_ENABLE_API_ARMOR
3541 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3542#endif
drhe30f4422007-08-21 16:15:55 +00003543 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003544 db->xCollNeeded = 0;
3545 db->xCollNeeded16 = xCollNeeded16;
3546 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003547 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003548 return SQLITE_OK;
3549}
drh6c626082004-11-14 21:56:29 +00003550#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003551
shaneeec556d2008-10-12 00:27:53 +00003552#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003553/*
danielk19777ddad962005-12-12 06:53:03 +00003554** This function is now an anachronism. It used to be used to recover from a
3555** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003556*/
drh7d97efb2007-10-12 19:35:48 +00003557int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003558 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003559}
3560#endif
drh3e1d8e62005-05-26 16:23:34 +00003561
3562/*
3563** Test to see whether or not the database connection is in autocommit
3564** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3565** by default. Autocommit is disabled by a BEGIN statement and reenabled
3566** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003567*/
3568int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003569#ifdef SQLITE_ENABLE_API_ARMOR
3570 if( !sqlite3SafetyCheckOk(db) ){
3571 (void)SQLITE_MISUSE_BKPT;
3572 return 0;
3573 }
3574#endif
drh3e1d8e62005-05-26 16:23:34 +00003575 return db->autoCommit;
3576}
drh49285702005-09-17 15:20:26 +00003577
drh49285702005-09-17 15:20:26 +00003578/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003579** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003580** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003581** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003582**
3583** 1. Serve as a convenient place to set a breakpoint in a debugger
3584** to detect when version error conditions occurs.
3585**
3586** 2. Invoke sqlite3_log() to provide the source code location where
3587** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003588*/
daneebf2f52017-11-18 17:30:08 +00003589int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003590 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3591 zType, lineno, 20+sqlite3_sourceid());
3592 return iErr;
3593}
drh9978c972010-02-23 17:36:32 +00003594int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003595 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003596 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003597}
drh9978c972010-02-23 17:36:32 +00003598int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003599 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003600 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003601}
3602int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003603 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003604 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003605}
dan3cdc8202020-02-04 20:01:44 +00003606#if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO)
drhcc97ca42017-06-07 22:32:59 +00003607int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3608 char zMsg[100];
3609 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3610 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003611 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003612}
dan3cdc8202020-02-04 20:01:44 +00003613#endif
3614#ifdef SQLITE_DEBUG
mistachkinfad30392016-02-13 23:43:46 +00003615int sqlite3NomemError(int lineno){
3616 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003617 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003618}
3619int sqlite3IoerrnomemError(int lineno){
3620 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003621 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003622}
drh32c49902016-02-15 18:15:15 +00003623#endif
drh7c1817e2006-01-10 13:58:48 +00003624
shaneeec556d2008-10-12 00:27:53 +00003625#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003626/*
3627** This is a convenience routine that makes sure that all thread-specific
3628** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003629**
3630** SQLite no longer uses thread-specific data so this routine is now a
3631** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003632*/
3633void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003634}
shaneeec556d2008-10-12 00:27:53 +00003635#endif
danielk1977deb802c2006-02-09 13:43:28 +00003636
3637/*
3638** Return meta information about a specific column of a database table.
3639** See comment in sqlite3.h (sqlite.h.in) for details.
3640*/
danielk1977deb802c2006-02-09 13:43:28 +00003641int sqlite3_table_column_metadata(
3642 sqlite3 *db, /* Connection handle */
3643 const char *zDbName, /* Database name or NULL */
3644 const char *zTableName, /* Table name */
3645 const char *zColumnName, /* Column name */
3646 char const **pzDataType, /* OUTPUT: Declared data type */
3647 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3648 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3649 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003650 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003651){
3652 int rc;
3653 char *zErrMsg = 0;
3654 Table *pTab = 0;
3655 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003656 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003657 char const *zDataType = 0;
3658 char const *zCollSeq = 0;
3659 int notnull = 0;
3660 int primarykey = 0;
3661 int autoinc = 0;
3662
drh96c707a2015-02-13 16:36:14 +00003663
3664#ifdef SQLITE_ENABLE_API_ARMOR
3665 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3666 return SQLITE_MISUSE_BKPT;
3667 }
3668#endif
3669
danielk1977deb802c2006-02-09 13:43:28 +00003670 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003671 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003672 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003673 rc = sqlite3Init(db, &zErrMsg);
3674 if( SQLITE_OK!=rc ){
3675 goto error_out;
3676 }
3677
3678 /* Locate the table in question */
3679 pTab = sqlite3FindTable(db, zTableName, zDbName);
3680 if( !pTab || pTab->pSelect ){
3681 pTab = 0;
3682 goto error_out;
3683 }
3684
3685 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003686 if( zColumnName==0 ){
3687 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003688 }else{
3689 for(iCol=0; iCol<pTab->nCol; iCol++){
3690 pCol = &pTab->aCol[iCol];
3691 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3692 break;
3693 }
3694 }
3695 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003696 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3697 iCol = pTab->iPKey;
3698 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3699 }else{
3700 pTab = 0;
3701 goto error_out;
3702 }
danielk1977deb802c2006-02-09 13:43:28 +00003703 }
3704 }
3705
3706 /* The following block stores the meta information that will be returned
3707 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3708 ** and autoinc. At this point there are two possibilities:
3709 **
3710 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3711 ** and there is no explicitly declared IPK column.
3712 **
3713 ** 2. The table is not a view and the column name identified an
3714 ** explicitly declared column. Copy meta information from *pCol.
3715 */
3716 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003717 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003718 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003719 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003720 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003721 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003722 }else{
3723 zDataType = "INTEGER";
3724 primarykey = 1;
3725 }
3726 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003727 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003728 }
3729
3730error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003731 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003732
3733 /* Whether the function call succeeded or failed, set the output parameters
3734 ** to whatever their local counterparts contain. If an error did occur,
3735 ** this has the effect of zeroing all output parameters.
3736 */
3737 if( pzDataType ) *pzDataType = zDataType;
3738 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3739 if( pNotNull ) *pNotNull = notnull;
3740 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3741 if( pAutoinc ) *pAutoinc = autoinc;
3742
3743 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003744 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003745 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003746 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003747 rc = SQLITE_ERROR;
3748 }
drh13f40da2014-08-22 18:00:11 +00003749 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003750 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003751 rc = sqlite3ApiExit(db, rc);
3752 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003753 return rc;
3754}
3755
3756/*
3757** Sleep for a little while. Return the amount of time slept.
3758*/
3759int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003760 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003761 int rc;
drhd677b3d2007-08-20 22:48:41 +00003762 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003763 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003764
3765 /* This function works in milliseconds, but the underlying OsSleep()
3766 ** API uses microseconds. Hence the 1000's.
3767 */
drhe30f4422007-08-21 16:15:55 +00003768 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003769 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003770}
drh4ac285a2006-09-15 07:28:50 +00003771
3772/*
3773** Enable or disable the extended result codes.
3774*/
3775int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003776#ifdef SQLITE_ENABLE_API_ARMOR
3777 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3778#endif
drhe30f4422007-08-21 16:15:55 +00003779 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003780 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003781 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003782 return SQLITE_OK;
3783}
drhcc6bb3e2007-08-31 16:11:35 +00003784
3785/*
3786** Invoke the xFileControl method on a particular database.
3787*/
3788int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3789 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003790 Btree *pBtree;
3791
drh9ca95732014-10-24 00:35:58 +00003792#ifdef SQLITE_ENABLE_API_ARMOR
3793 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3794#endif
drhcc6bb3e2007-08-31 16:11:35 +00003795 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003796 pBtree = sqlite3DbNameToBtree(db, zDbName);
3797 if( pBtree ){
3798 Pager *pPager;
3799 sqlite3_file *fd;
3800 sqlite3BtreeEnter(pBtree);
3801 pPager = sqlite3BtreePager(pBtree);
3802 assert( pPager!=0 );
3803 fd = sqlite3PagerFile(pPager);
3804 assert( fd!=0 );
3805 if( op==SQLITE_FCNTL_FILE_POINTER ){
3806 *(sqlite3_file**)pArg = fd;
3807 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003808 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3809 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3810 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003811 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3812 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3813 rc = SQLITE_OK;
drhea99a312018-07-18 19:09:07 +00003814 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3815 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3816 rc = SQLITE_OK;
drh45248de2020-04-20 15:18:43 +00003817 }else if( op==SQLITE_FCNTL_RESERVE_BYTES ){
3818 int iNew = *(int*)pArg;
3819 *(int*)pArg = sqlite3BtreeGetRequestedReserve(pBtree);
drhe937df82020-05-07 01:56:57 +00003820 if( iNew>=0 && iNew<=255 ){
drh45248de2020-04-20 15:18:43 +00003821 sqlite3BtreeSetPageSize(pBtree, 0, iNew, 0);
3822 }
3823 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003824 }else{
drhafb39a42018-03-29 13:47:01 +00003825 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003826 }
drh421377e2012-03-15 21:28:54 +00003827 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003828 }
3829 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003830 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003831}
drhed13d982008-01-31 14:43:24 +00003832
3833/*
3834** Interface to the testing logic.
3835*/
3836int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003837 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003838#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003839 UNUSED_PARAMETER(op);
3840#else
drh2fa18682008-03-19 14:15:34 +00003841 va_list ap;
drhed13d982008-01-31 14:43:24 +00003842 va_start(ap, op);
3843 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003844
3845 /*
drh984bfaa2008-03-19 16:08:53 +00003846 ** Save the current state of the PRNG.
3847 */
drh2fa18682008-03-19 14:15:34 +00003848 case SQLITE_TESTCTRL_PRNG_SAVE: {
3849 sqlite3PrngSaveState();
3850 break;
3851 }
drh984bfaa2008-03-19 16:08:53 +00003852
3853 /*
3854 ** Restore the state of the PRNG to the last state saved using
3855 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3856 ** this verb acts like PRNG_RESET.
3857 */
drh2fa18682008-03-19 14:15:34 +00003858 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3859 sqlite3PrngRestoreState();
3860 break;
3861 }
drh984bfaa2008-03-19 16:08:53 +00003862
drh2e6d83b2019-08-03 01:39:20 +00003863 /* sqlite3_test_control(SQLITE_TESTCTRL_PRNG_SEED, int x, sqlite3 *db);
drhade54d62019-08-02 20:45:04 +00003864 **
drh2e6d83b2019-08-03 01:39:20 +00003865 ** Control the seed for the pseudo-random number generator (PRNG) that
3866 ** is built into SQLite. Cases:
3867 **
3868 ** x!=0 && db!=0 Seed the PRNG to the current value of the
3869 ** schema cookie in the main database for db, or
3870 ** x if the schema cookie is zero. This case
3871 ** is convenient to use with database fuzzers
3872 ** as it allows the fuzzer some control over the
3873 ** the PRNG seed.
3874 **
3875 ** x!=0 && db==0 Seed the PRNG to the value of x.
3876 **
3877 ** x==0 && db==0 Revert to default behavior of using the
3878 ** xRandomness method on the primary VFS.
3879 **
3880 ** This test-control also resets the PRNG so that the new seed will
3881 ** be used for the next call to sqlite3_randomness().
drh984bfaa2008-03-19 16:08:53 +00003882 */
drhef9f7192020-01-17 19:14:08 +00003883#ifndef SQLITE_OMIT_WSD
drhade54d62019-08-02 20:45:04 +00003884 case SQLITE_TESTCTRL_PRNG_SEED: {
drh2e6d83b2019-08-03 01:39:20 +00003885 int x = va_arg(ap, int);
3886 int y;
3887 sqlite3 *db = va_arg(ap, sqlite3*);
3888 assert( db==0 || db->aDb[0].pSchema!=0 );
3889 if( db && (y = db->aDb[0].pSchema->schema_cookie)!=0 ){ x = y; }
3890 sqlite3Config.iPrngSeed = x;
3891 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003892 break;
3893 }
drhef9f7192020-01-17 19:14:08 +00003894#endif
drh3088d592008-03-21 16:45:47 +00003895
3896 /*
3897 ** sqlite3_test_control(BITVEC_TEST, size, program)
3898 **
3899 ** Run a test against a Bitvec object of size. The program argument
3900 ** is an array of integers that defines the test. Return -1 on a
3901 ** memory allocation error, 0 on success, or non-zero for an error.
3902 ** See the sqlite3BitvecBuiltinTest() for additional information.
3903 */
3904 case SQLITE_TESTCTRL_BITVEC_TEST: {
3905 int sz = va_arg(ap, int);
3906 int *aProg = va_arg(ap, int*);
3907 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3908 break;
3909 }
danielk19772d1d86f2008-06-20 14:59:51 +00003910
3911 /*
drhc007f612014-05-16 14:17:01 +00003912 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3913 **
3914 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3915 ** if xCallback is not NULL.
3916 **
3917 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3918 ** is called immediately after installing the new callback and the return
3919 ** value from sqlite3FaultSim(0) becomes the return from
3920 ** sqlite3_test_control().
3921 */
3922 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003923 /* MSVC is picky about pulling func ptrs from va lists.
3924 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003925 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003926 */
3927 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003928 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003929 rc = sqlite3FaultSim(0);
3930 break;
3931 }
3932
3933 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003934 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3935 **
3936 ** Register hooks to call to indicate which malloc() failures
3937 ** are benign.
3938 */
3939 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003940 typedef void (*void_function)(void);
3941 void_function xBenignBegin;
3942 void_function xBenignEnd;
3943 xBenignBegin = va_arg(ap, void_function);
3944 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003945 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3946 break;
3947 }
drhc7a3bb92009-02-05 16:31:45 +00003948
3949 /*
drhf3af63f2009-05-09 18:59:42 +00003950 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003951 **
3952 ** Set the PENDING byte to the value in the argument, if X>0.
3953 ** Make no changes if X==0. Return the value of the pending byte
3954 ** as it existing before this routine was called.
3955 **
3956 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3957 ** an incompatible database file format. Changing the PENDING byte
3958 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003959 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003960 */
3961 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003962 rc = PENDING_BYTE;
3963#ifndef SQLITE_OMIT_WSD
3964 {
3965 unsigned int newVal = va_arg(ap, unsigned int);
3966 if( newVal ) sqlite3PendingByte = newVal;
3967 }
3968#endif
drhc7a3bb92009-02-05 16:31:45 +00003969 break;
3970 }
drhf3af63f2009-05-09 18:59:42 +00003971
3972 /*
3973 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3974 **
3975 ** This action provides a run-time test to see whether or not
3976 ** assert() was enabled at compile-time. If X is true and assert()
3977 ** is enabled, then the return value is true. If X is true and
3978 ** assert() is disabled, then the return value is zero. If X is
3979 ** false and assert() is enabled, then the assertion fires and the
3980 ** process aborts. If X is false and assert() is disabled, then the
3981 ** return value is zero.
3982 */
3983 case SQLITE_TESTCTRL_ASSERT: {
3984 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003985 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003986 rc = x;
3987 break;
3988 }
3989
3990
3991 /*
3992 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3993 **
3994 ** This action provides a run-time test to see how the ALWAYS and
3995 ** NEVER macros were defined at compile-time.
3996 **
drhce2c4822017-10-03 17:17:34 +00003997 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00003998 **
3999 ** The recommended test is X==2. If the return value is 2, that means
4000 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
4001 ** default setting. If the return value is 1, then ALWAYS() is either
4002 ** hard-coded to true or else it asserts if its argument is false.
4003 ** The first behavior (hard-coded to true) is the case if
4004 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
4005 ** behavior (assert if the argument to ALWAYS() is false) is the case if
4006 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
4007 **
4008 ** The run-time test procedure might look something like this:
4009 **
4010 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
4011 ** // ALWAYS() and NEVER() are no-op pass-through macros
4012 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
4013 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
4014 ** }else{
4015 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
4016 ** }
4017 */
4018 case SQLITE_TESTCTRL_ALWAYS: {
4019 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00004020 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00004021 break;
4022 }
drhc046e3e2009-07-15 11:26:44 +00004023
drh2cf4acb2014-04-18 00:06:02 +00004024 /*
4025 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
4026 **
4027 ** The integer returned reveals the byte-order of the computer on which
4028 ** SQLite is running:
4029 **
4030 ** 1 big-endian, determined at run-time
4031 ** 10 little-endian, determined at run-time
4032 ** 432101 big-endian, determined at compile-time
4033 ** 123410 little-endian, determined at compile-time
4034 */
4035 case SQLITE_TESTCTRL_BYTEORDER: {
4036 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
4037 break;
4038 }
4039
drh07096f62009-12-22 23:52:32 +00004040 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
4041 **
4042 ** Enable or disable various optimizations for testing purposes. The
4043 ** argument N is a bitmask of optimizations to be disabled. For normal
4044 ** operation N should be 0. The idea is that a test program (like the
4045 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
4046 ** with various optimizations disabled to verify that the same answer
4047 ** is obtained in every case.
4048 */
4049 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
4050 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00004051 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00004052 break;
4053 }
4054
danc17d6962011-06-21 12:47:30 +00004055 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
4056 **
drheea8eb62018-11-26 18:09:15 +00004057 ** If parameter onoff is non-zero, subsequent calls to localtime()
4058 ** and its variants fail. If onoff is zero, undo this setting.
danc17d6962011-06-21 12:47:30 +00004059 */
4060 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
4061 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
4062 break;
4063 }
4064
drh171c50e2020-01-01 15:43:30 +00004065 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCTIONS, sqlite3*);
drheea8eb62018-11-26 18:09:15 +00004066 **
drh171c50e2020-01-01 15:43:30 +00004067 ** Toggle the ability to use internal functions on or off for
4068 ** the database connection given in the argument.
drheea8eb62018-11-26 18:09:15 +00004069 */
4070 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
drh171c50e2020-01-01 15:43:30 +00004071 sqlite3 *db = va_arg(ap, sqlite3*);
4072 db->mDbFlags ^= DBFLAG_InternalFunc;
drheea8eb62018-11-26 18:09:15 +00004073 break;
4074 }
4075
drh09fe6142013-11-29 15:06:27 +00004076 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4077 **
4078 ** Set or clear a flag that indicates that the database file is always well-
4079 ** formed and never corrupt. This flag is clear by default, indicating that
4080 ** database files might have arbitrary corruption. Setting the flag during
4081 ** testing causes certain assert() statements in the code to be activated
4082 ** that demonstrat invariants on well-formed database files.
4083 */
4084 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00004085 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00004086 break;
4087 }
4088
drh30842992019-08-12 14:17:43 +00004089 /* sqlite3_test_control(SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS, int);
4090 **
4091 ** Set or clear a flag that causes SQLite to verify that type, name,
4092 ** and tbl_name fields of the sqlite_master table. This is normally
4093 ** on, but it is sometimes useful to turn it off for testing.
4094 */
4095 case SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS: {
4096 sqlite3GlobalConfig.bExtraSchemaChecks = va_arg(ap, int);
4097 break;
4098 }
4099
drh9e5eb9c2016-09-18 16:08:10 +00004100 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00004101 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004102 ** too big to test in a reasonable amount of time, so this control is
4103 ** provided to set a small and easily reachable reset value.
4104 */
4105 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4106 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4107 break;
4108 }
drh688852a2014-02-17 22:40:43 +00004109
4110 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4111 **
4112 ** Set the VDBE coverage callback function to xCallback with context
4113 ** pointer ptr.
4114 */
4115 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4116#ifdef SQLITE_VDBE_COVERAGE
drh7083a482018-07-10 16:04:04 +00004117 typedef void (*branch_callback)(void*,unsigned int,
4118 unsigned char,unsigned char);
drh688852a2014-02-17 22:40:43 +00004119 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4120 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4121#endif
4122 break;
4123 }
4124
dan8930c2a2014-04-03 16:25:29 +00004125 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4126 case SQLITE_TESTCTRL_SORTER_MMAP: {
4127 sqlite3 *db = va_arg(ap, sqlite3*);
4128 db->nMaxSorterMmap = va_arg(ap, int);
4129 break;
4130 }
4131
drh43cfc232014-07-29 14:09:21 +00004132 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4133 **
4134 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4135 ** not.
4136 */
4137 case SQLITE_TESTCTRL_ISINIT: {
4138 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4139 break;
4140 }
drh8964b342015-01-29 17:54:52 +00004141
drh3ba689d2015-03-03 14:00:11 +00004142 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004143 **
drh1ffede82015-01-30 20:59:27 +00004144 ** This test control is used to create imposter tables. "db" is a pointer
4145 ** to the database connection. dbName is the database name (ex: "main" or
4146 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4147 ** or off. "tnum" is the root page of the b-tree to which the imposter
4148 ** table should connect.
4149 **
4150 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004151 ** run a single CREATE TABLE statement to construct the imposter table in
4152 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004153 **
4154 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4155 ** the schema to be reparsed the next time it is needed. This has the
4156 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004157 */
drh1ffede82015-01-30 20:59:27 +00004158 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004159 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004160 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004161 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4162 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004163 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004164 if( db->init.busy==0 && db->init.newTnum>0 ){
4165 sqlite3ResetAllSchemasOfConnection(db);
4166 }
drh8fb15e32015-02-04 20:56:49 +00004167 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004168 break;
4169 }
drh0d9de992017-12-26 18:04:23 +00004170
4171#if defined(YYCOVERAGE)
4172 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4173 **
4174 ** This test control (only available when SQLite is compiled with
4175 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4176 ** state/lookahead combinations in the parser state machine
4177 ** which are never exercised. If any state is missed, make the
4178 ** return code SQLITE_ERROR.
4179 */
4180 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4181 FILE *out = va_arg(ap, FILE*);
4182 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4183 break;
4184 }
4185#endif /* defined(YYCOVERAGE) */
drh0c8f4032019-05-03 21:17:28 +00004186
4187 /* sqlite3_test_control(SQLITE_TESTCTRL_RESULT_INTREAL, sqlite3_context*);
4188 **
4189 ** This test-control causes the most recent sqlite3_result_int64() value
4190 ** to be interpreted as a MEM_IntReal instead of as an MEM_Int. Normally,
4191 ** MEM_IntReal values only arise during an INSERT operation of integer
4192 ** values into a REAL column, so they can be challenging to test. This
4193 ** test-control enables us to write an intreal() SQL function that can
4194 ** inject an intreal() value at arbitrary places in an SQL statement,
4195 ** for testing purposes.
4196 */
4197 case SQLITE_TESTCTRL_RESULT_INTREAL: {
4198 sqlite3_context *pCtx = va_arg(ap, sqlite3_context*);
4199 sqlite3ResultIntReal(pCtx);
4200 break;
4201 }
drhed13d982008-01-31 14:43:24 +00004202 }
4203 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004204#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004205 return rc;
drhed13d982008-01-31 14:43:24 +00004206}
drhcc487d12011-05-17 18:53:08 +00004207
4208/*
drh532b0d22020-01-27 14:40:44 +00004209** The Pager stores the Database filename, Journal filename, and WAL filename
4210** consecutively in memory, in that order. The database filename is prefixed
4211** by four zero bytes. Locate the start of the database filename by searching
4212** backwards for the first byte following four consecutive zero bytes.
4213**
4214** This only works if the filename passed in was obtained from the Pager.
4215*/
4216static const char *databaseName(const char *zName){
4217 while( zName[-1]!=0 || zName[-2]!=0 || zName[-3]!=0 || zName[-4]!=0 ){
4218 zName--;
4219 }
4220 return zName;
4221}
4222
4223/*
drh4defddd2020-02-18 19:49:48 +00004224** Append text z[] to the end of p[]. Return a pointer to the first
4225** character after then zero terminator on the new text in p[].
4226*/
4227static char *appendText(char *p, const char *z){
4228 size_t n = strlen(z);
4229 memcpy(p, z, n+1);
4230 return p+n+1;
4231}
4232
4233/*
4234** Allocate memory to hold names for a database, journal file, WAL file,
4235** and query parameters. The pointer returned is valid for use by
4236** sqlite3_filename_database() and sqlite3_uri_parameter() and related
4237** functions.
4238**
4239** Memory layout must be compatible with that generated by the pager
4240** and expected by sqlite3_uri_parameter() and databaseName().
4241*/
4242char *sqlite3_create_filename(
4243 const char *zDatabase,
4244 const char *zJournal,
4245 const char *zWal,
4246 int nParam,
4247 const char **azParam
4248){
4249 sqlite3_int64 nByte;
4250 int i;
4251 char *pResult, *p;
4252 nByte = strlen(zDatabase) + strlen(zJournal) + strlen(zWal) + 10;
4253 for(i=0; i<nParam*2; i++){
4254 nByte += strlen(azParam[i])+1;
4255 }
4256 pResult = p = sqlite3_malloc64( nByte );
4257 if( p==0 ) return 0;
4258 memset(p, 0, 4);
4259 p += 4;
4260 p = appendText(p, zDatabase);
4261 for(i=0; i<nParam*2; i++){
4262 p = appendText(p, azParam[i]);
4263 }
4264 *(p++) = 0;
4265 p = appendText(p, zJournal);
4266 p = appendText(p, zWal);
4267 *(p++) = 0;
4268 *(p++) = 0;
4269 assert( (sqlite3_int64)(p - pResult)==nByte );
4270 return pResult + 4;
4271}
4272
4273/*
4274** Free memory obtained from sqlite3_create_filename(). It is a severe
4275** error to call this routine with any parameter other than a pointer
4276** previously obtained from sqlite3_create_filename() or a NULL pointer.
4277*/
4278void sqlite3_free_filename(char *p){
4279 if( p==0 ) return;
4280 p = (char*)databaseName(p);
4281 sqlite3_free(p - 4);
4282}
4283
4284
4285/*
drhcc487d12011-05-17 18:53:08 +00004286** This is a utility routine, useful to VFS implementations, that checks
4287** to see if a database file was a URI that contained a specific query
4288** parameter, and if so obtains the value of the query parameter.
4289**
4290** The zFilename argument is the filename pointer passed into the xOpen()
4291** method of a VFS implementation. The zParam argument is the name of the
4292** query parameter we seek. This routine returns the value of the zParam
4293** parameter if it exists. If the parameter does not exist, this routine
4294** returns a NULL pointer.
4295*/
4296const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004297 if( zFilename==0 || zParam==0 ) return 0;
drh532b0d22020-01-27 14:40:44 +00004298 zFilename = databaseName(zFilename);
drh1eac9662020-02-01 13:30:39 +00004299 return uriParameter(zFilename, zParam);
drhcc487d12011-05-17 18:53:08 +00004300}
drh283829c2011-11-17 00:56:20 +00004301
4302/*
drh80804032020-01-11 16:08:31 +00004303** Return a pointer to the name of Nth query parameter of the filename.
4304*/
4305const char *sqlite3_uri_key(const char *zFilename, int N){
4306 if( zFilename==0 || N<0 ) return 0;
drh532b0d22020-01-27 14:40:44 +00004307 zFilename = databaseName(zFilename);
drh80804032020-01-11 16:08:31 +00004308 zFilename += sqlite3Strlen30(zFilename) + 1;
4309 while( zFilename[0] && (N--)>0 ){
4310 zFilename += sqlite3Strlen30(zFilename) + 1;
4311 zFilename += sqlite3Strlen30(zFilename) + 1;
4312 }
4313 return zFilename[0] ? zFilename : 0;
4314}
4315
4316/*
drh92913722011-12-23 00:07:33 +00004317** Return a boolean value for a query parameter.
4318*/
4319int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4320 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004321 bDflt = bDflt!=0;
4322 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004323}
4324
4325/*
4326** Return a 64-bit integer value for a query parameter.
4327*/
4328sqlite3_int64 sqlite3_uri_int64(
4329 const char *zFilename, /* Filename as passed to xOpen */
4330 const char *zParam, /* URI parameter sought */
4331 sqlite3_int64 bDflt /* return if parameter is missing */
4332){
4333 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4334 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004335 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004336 bDflt = v;
4337 }
4338 return bDflt;
4339}
4340
4341/*
drh8875b9e2020-01-10 18:05:55 +00004342** Translate a filename that was handed to a VFS routine into the corresponding
4343** database, journal, or WAL file.
4344**
4345** It is an error to pass this routine a filename string that was not
4346** passed into the VFS from the SQLite core. Doing so is similar to
4347** passing free() a pointer that was not obtained from malloc() - it is
4348** an error that we cannot easily detect but that will likely cause memory
4349** corruption.
4350*/
4351const char *sqlite3_filename_database(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004352 return databaseName(zFilename);
drh8875b9e2020-01-10 18:05:55 +00004353}
4354const char *sqlite3_filename_journal(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004355 zFilename = databaseName(zFilename);
4356 zFilename += sqlite3Strlen30(zFilename) + 1;
4357 while( zFilename[0] ){
4358 zFilename += sqlite3Strlen30(zFilename) + 1;
4359 zFilename += sqlite3Strlen30(zFilename) + 1;
4360 }
4361 return zFilename + 1;
drh8875b9e2020-01-10 18:05:55 +00004362}
4363const char *sqlite3_filename_wal(const char *zFilename){
drh532b0d22020-01-27 14:40:44 +00004364#ifdef SQLITE_OMIT_WAL
4365 return 0;
4366#else
4367 zFilename = sqlite3_filename_journal(zFilename);
4368 zFilename += sqlite3Strlen30(zFilename) + 1;
4369 return zFilename;
4370#endif
drh8875b9e2020-01-10 18:05:55 +00004371}
4372
4373/*
drh421377e2012-03-15 21:28:54 +00004374** Return the Btree pointer identified by zDbName. Return NULL if not found.
4375*/
4376Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004377 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4378 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004379}
4380
4381/*
drh283829c2011-11-17 00:56:20 +00004382** Return the filename of the database associated with a database
4383** connection.
4384*/
4385const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004386 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004387#ifdef SQLITE_ENABLE_API_ARMOR
4388 if( !sqlite3SafetyCheckOk(db) ){
4389 (void)SQLITE_MISUSE_BKPT;
4390 return 0;
4391 }
4392#endif
mistachkincd54bab2014-12-20 21:14:14 +00004393 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004394 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4395}
4396
4397/*
4398** Return 1 if database is read-only or 0 if read/write. Return -1 if
4399** no such database exists.
4400*/
4401int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004402 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004403#ifdef SQLITE_ENABLE_API_ARMOR
4404 if( !sqlite3SafetyCheckOk(db) ){
4405 (void)SQLITE_MISUSE_BKPT;
4406 return -1;
4407 }
4408#endif
mistachkincd54bab2014-12-20 21:14:14 +00004409 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004410 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004411}
danfc1acf32015-12-05 20:51:54 +00004412
4413#ifdef SQLITE_ENABLE_SNAPSHOT
4414/*
4415** Obtain a snapshot handle for the snapshot of database zDb currently
4416** being read by handle db.
4417*/
4418int sqlite3_snapshot_get(
4419 sqlite3 *db,
4420 const char *zDb,
4421 sqlite3_snapshot **ppSnapshot
4422){
4423 int rc = SQLITE_ERROR;
4424#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004425
4426#ifdef SQLITE_ENABLE_API_ARMOR
4427 if( !sqlite3SafetyCheckOk(db) ){
4428 return SQLITE_MISUSE_BKPT;
4429 }
4430#endif
4431 sqlite3_mutex_enter(db->mutex);
4432
danedace5d2016-11-18 18:43:39 +00004433 if( db->autoCommit==0 ){
4434 int iDb = sqlite3FindDbName(db, zDb);
4435 if( iDb==0 || iDb>1 ){
4436 Btree *pBt = db->aDb[iDb].pBt;
4437 if( 0==sqlite3BtreeIsInTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004438 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
danedace5d2016-11-18 18:43:39 +00004439 if( rc==SQLITE_OK ){
4440 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4441 }
dan7116dc62015-12-10 20:03:08 +00004442 }
danfc1acf32015-12-05 20:51:54 +00004443 }
4444 }
4445
4446 sqlite3_mutex_leave(db->mutex);
4447#endif /* SQLITE_OMIT_WAL */
4448 return rc;
4449}
4450
4451/*
4452** Open a read-transaction on the snapshot idendified by pSnapshot.
4453*/
4454int sqlite3_snapshot_open(
4455 sqlite3 *db,
4456 const char *zDb,
4457 sqlite3_snapshot *pSnapshot
4458){
4459 int rc = SQLITE_ERROR;
4460#ifndef SQLITE_OMIT_WAL
4461
4462#ifdef SQLITE_ENABLE_API_ARMOR
4463 if( !sqlite3SafetyCheckOk(db) ){
4464 return SQLITE_MISUSE_BKPT;
4465 }
4466#endif
4467 sqlite3_mutex_enter(db->mutex);
4468 if( db->autoCommit==0 ){
4469 int iDb;
4470 iDb = sqlite3FindDbName(db, zDb);
4471 if( iDb==0 || iDb>1 ){
4472 Btree *pBt = db->aDb[iDb].pBt;
danfa3d4c12018-08-06 17:12:36 +00004473 if( sqlite3BtreeIsInTrans(pBt)==0 ){
4474 Pager *pPager = sqlite3BtreePager(pBt);
4475 int bUnlock = 0;
4476 if( sqlite3BtreeIsInReadTrans(pBt) ){
4477 if( db->nVdbeActive==0 ){
4478 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4479 if( rc==SQLITE_OK ){
4480 bUnlock = 1;
4481 rc = sqlite3BtreeCommit(pBt);
4482 }
4483 }
4484 }else{
4485 rc = SQLITE_OK;
4486 }
4487 if( rc==SQLITE_OK ){
dan861fb1e2020-05-06 19:14:41 +00004488 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
danfa3d4c12018-08-06 17:12:36 +00004489 }
danfc1acf32015-12-05 20:51:54 +00004490 if( rc==SQLITE_OK ){
drh685a50a2018-06-06 18:50:50 +00004491 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan861fb1e2020-05-06 19:14:41 +00004492 sqlite3PagerSnapshotOpen(pPager, 0);
danfa3d4c12018-08-06 17:12:36 +00004493 }
4494 if( bUnlock ){
4495 sqlite3PagerSnapshotUnlock(pPager);
danfc1acf32015-12-05 20:51:54 +00004496 }
4497 }
4498 }
4499 }
4500
4501 sqlite3_mutex_leave(db->mutex);
4502#endif /* SQLITE_OMIT_WAL */
4503 return rc;
4504}
4505
4506/*
dan11584982016-11-18 20:49:43 +00004507** Recover as many snapshots as possible from the wal file associated with
4508** schema zDb of database db.
4509*/
4510int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4511 int rc = SQLITE_ERROR;
4512 int iDb;
4513#ifndef SQLITE_OMIT_WAL
4514
4515#ifdef SQLITE_ENABLE_API_ARMOR
4516 if( !sqlite3SafetyCheckOk(db) ){
4517 return SQLITE_MISUSE_BKPT;
4518 }
4519#endif
4520
4521 sqlite3_mutex_enter(db->mutex);
4522 iDb = sqlite3FindDbName(db, zDb);
4523 if( iDb==0 || iDb>1 ){
4524 Btree *pBt = db->aDb[iDb].pBt;
4525 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
drh685a50a2018-06-06 18:50:50 +00004526 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
dan93f51132016-11-19 18:31:37 +00004527 if( rc==SQLITE_OK ){
4528 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4529 sqlite3BtreeCommit(pBt);
4530 }
dan11584982016-11-18 20:49:43 +00004531 }
4532 }
4533 sqlite3_mutex_leave(db->mutex);
4534#endif /* SQLITE_OMIT_WAL */
4535 return rc;
4536}
4537
4538/*
danfc1acf32015-12-05 20:51:54 +00004539** Free a snapshot handle obtained from sqlite3_snapshot_get().
4540*/
4541void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4542 sqlite3_free(pSnapshot);
4543}
4544#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004545
4546#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4547/*
4548** Given the name of a compile-time option, return true if that option
4549** was used and false if not.
4550**
4551** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4552** is not required for a match.
4553*/
4554int sqlite3_compileoption_used(const char *zOptName){
4555 int i, n;
4556 int nOpt;
4557 const char **azCompileOpt;
4558
4559#if SQLITE_ENABLE_API_ARMOR
4560 if( zOptName==0 ){
4561 (void)SQLITE_MISUSE_BKPT;
4562 return 0;
4563 }
4564#endif
4565
4566 azCompileOpt = sqlite3CompileOptions(&nOpt);
4567
4568 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4569 n = sqlite3Strlen30(zOptName);
4570
4571 /* Since nOpt is normally in single digits, a linear search is
4572 ** adequate. No need for a binary search. */
4573 for(i=0; i<nOpt; i++){
4574 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4575 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4576 ){
4577 return 1;
4578 }
4579 }
4580 return 0;
4581}
4582
4583/*
4584** Return the N-th compile-time option string. If N is out of range,
4585** return a NULL pointer.
4586*/
4587const char *sqlite3_compileoption_get(int N){
4588 int nOpt;
4589 const char **azCompileOpt;
4590 azCompileOpt = sqlite3CompileOptions(&nOpt);
4591 if( N>=0 && N<nOpt ){
4592 return azCompileOpt[N];
4593 }
4594 return 0;
4595}
4596#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */