blob: bed5e4718a2c8c0f46f83e35ac993a1d57687b37 [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
adame6c3c722009-11-03 22:34:35 +000019#ifdef SQLITE_ENABLE_SQLRR
20# include "sqlrr.h"
21#endif
drh820a9062008-01-31 13:35:48 +000022#ifdef SQLITE_ENABLE_FTS3
23# include "fts3.h"
24#endif
drh58f1c8b2008-05-26 20:19:25 +000025#ifdef SQLITE_ENABLE_RTREE
26# include "rtree.h"
27#endif
dan21540ae2017-12-08 16:23:38 +000028#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
danielk19771c826652008-09-08 08:08:09 +000029# include "sqliteicu.h"
30#endif
drhc306e082015-10-08 23:37:00 +000031#ifdef SQLITE_ENABLE_JSON1
32int sqlite3Json1Init(sqlite3*);
33#endif
drhc6603af2017-06-29 14:33:51 +000034#ifdef SQLITE_ENABLE_STMTVTAB
35int sqlite3StmtVtabInit(sqlite3*);
drhf00f5302017-06-28 15:47:29 +000036#endif
drhc306e082015-10-08 23:37:00 +000037#ifdef SQLITE_ENABLE_FTS5
38int sqlite3Fts5Init(sqlite3*);
39#endif
drh75897232000-05-29 14:26:00 +000040
drhb3190c12008-12-08 21:37:14 +000041#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000042/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
43** contains the text of SQLITE_VERSION macro.
44*/
danielk197724b03fd2004-05-10 10:34:34 +000045const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000046#endif
drh9f129f42010-08-31 15:27:32 +000047
48/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
49** a pointer to the to the sqlite3_version[] string constant.
50*/
drh4aec8b62004-08-28 16:19:00 +000051const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000052
drhc6aa3812017-10-04 18:26:44 +000053/* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
drh9f129f42010-08-31 15:27:32 +000054** pointer to a string constant whose value is the same as the
drhc6aa3812017-10-04 18:26:44 +000055** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
56** an edited copy of the amalgamation, then the last four characters of
57** the hash might be different from SQLITE_SOURCE_ID.
drh9f129f42010-08-31 15:27:32 +000058*/
drh47baebc2009-08-14 16:01:24 +000059const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000060
61/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
62** returns an integer equal to SQLITE_VERSION_NUMBER.
63*/
danielk197799ba19e2005-02-05 07:33:34 +000064int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000065
drh5dc2bcd2012-01-02 15:45:12 +000066/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000067** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000068** the SQLITE_THREADSAFE compile-time option being set to 0.
69*/
drhb67e8bf2007-08-30 20:09:48 +000070int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000071
mistachkin34cf2582015-04-02 17:46:52 +000072/*
73** When compiling the test fixture or with debugging enabled (on Win32),
74** this variable being set to non-zero will cause OSTRACE macros to emit
75** extra diagnostic information.
76*/
mistachkinfb383e92015-04-16 03:24:38 +000077#ifdef SQLITE_HAVE_OS_TRACE
mistachkin34cf2582015-04-02 17:46:52 +000078# ifndef SQLITE_DEBUG_OS_TRACE
79# define SQLITE_DEBUG_OS_TRACE 0
80# endif
81 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
82#endif
83
drhe265b082008-05-01 17:03:49 +000084#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000085/*
drhb0603412007-02-28 04:47:26 +000086** If the following function pointer is not NULL and if
87** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
88** I/O active are written using this function. These messages
89** are intended for debugging activity only.
90*/
mistachkin9871a932015-03-27 00:21:52 +000091SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000092#endif
drhb0603412007-02-28 04:47:26 +000093
94/*
drha16313e2007-03-30 11:29:32 +000095** If the following global variable points to a string which is the
96** name of a directory, then that directory will be used to store
97** temporary files.
98**
99** See also the "PRAGMA temp_store_directory" SQL command.
100*/
101char *sqlite3_temp_directory = 0;
102
drhc5499be2008-04-01 15:06:33 +0000103/*
mistachkina112d142012-03-14 00:44:01 +0000104** If the following global variable points to a string which is the
105** name of a directory, then that directory will be used to store
106** all database files specified with a relative pathname.
107**
108** See also the "PRAGMA data_store_directory" SQL command.
109*/
110char *sqlite3_data_directory = 0;
111
112/*
drh40257ff2008-06-13 18:24:27 +0000113** Initialize SQLite.
114**
115** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000116** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000117** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
118** this routine will be called automatically by key routines such as
119** sqlite3_open().
120**
121** This routine is a no-op except on its very first call for the process,
122** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000123**
124** The first thread to call this routine runs the initialization to
125** completion. If subsequent threads call this routine before the first
126** thread has finished the initialization process, then the subsequent
127** threads must block until the first thread finishes with the initialization.
128**
129** The first thread might call this routine recursively. Recursive
130** calls to this routine should not block, of course. Otherwise the
131** initialization process would never complete.
132**
133** Let X be the first thread to enter this routine. Let Y be some other
134** thread. Then while the initial invocation of this routine by X is
135** incomplete, it is required that:
136**
137** * Calls to this routine from Y must block until the outer-most
138** call by X completes.
139**
140** * Recursive calls to this routine from thread X return immediately
141** without blocking.
drh40257ff2008-06-13 18:24:27 +0000142*/
143int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000144 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000145 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000146#ifdef SQLITE_EXTRA_INIT
147 int bRunExtraInit = 0; /* Extra initialization needed */
148#endif
danielk1977075c23a2008-09-01 18:34:20 +0000149
150#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000151 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000152 if( rc!=SQLITE_OK ){
153 return rc;
154 }
155#endif
danielk197771bc31c2008-06-26 08:29:34 +0000156
drh2b4905c2015-03-23 18:52:56 +0000157 /* If the following assert() fails on some obscure processor/compiler
158 ** combination, the work-around is to set the correct pointer
159 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
160 assert( SQLITE_PTRSIZE==sizeof(char*) );
161
drh93ed56d2008-08-12 15:21:11 +0000162 /* If SQLite is already completely initialized, then this call
163 ** to sqlite3_initialize() should be a no-op. But the initialization
164 ** must be complete. So isInit must not be set until the very end
165 ** of this routine.
166 */
danielk1977075c23a2008-09-01 18:34:20 +0000167 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000168
drh93ed56d2008-08-12 15:21:11 +0000169 /* Make sure the mutex subsystem is initialized. If unable to
170 ** initialize the mutex subsystem, return early with the error.
171 ** If the system is so sick that we are unable to allocate a mutex,
172 ** there is not much SQLite is going to be able to do.
173 **
174 ** The mutex subsystem must take care of serializing its own
175 ** initialization.
176 */
danielk1977d0251742008-06-18 18:57:42 +0000177 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000178 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000179
drh93ed56d2008-08-12 15:21:11 +0000180 /* Initialize the malloc() system and the recursive pInitMutex mutex.
181 ** This operation is protected by the STATIC_MASTER mutex. Note that
182 ** MutexAlloc() is called for a static mutex prior to initializing the
183 ** malloc subsystem - this implies that the allocation of a static
184 ** mutex must not require support from the malloc subsystem.
185 */
drh30ddce62011-10-15 00:16:30 +0000186 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000187 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000188 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000189 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000190 rc = sqlite3MallocInit();
191 }
drh40257ff2008-06-13 18:24:27 +0000192 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000193 sqlite3GlobalConfig.isMallocInit = 1;
194 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000195 sqlite3GlobalConfig.pInitMutex =
196 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000197 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
mistachkinfad30392016-02-13 23:43:46 +0000198 rc = SQLITE_NOMEM_BKPT;
drh40257ff2008-06-13 18:24:27 +0000199 }
200 }
danielk197777eb5bb2008-09-22 17:22:19 +0000201 }
202 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000203 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000204 }
205 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000206
dane1ab2192009-08-17 15:16:19 +0000207 /* If rc is not SQLITE_OK at this point, then either the malloc
208 ** subsystem could not be initialized or the system failed to allocate
209 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000210 if( rc!=SQLITE_OK ){
211 return rc;
212 }
213
214 /* Do the rest of the initialization under the recursive mutex so
215 ** that we will be able to handle recursive calls into
216 ** sqlite3_initialize(). The recursive calls normally come through
217 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
218 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000219 **
220 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
221 ** to the xInit method, so the xInit method need not be threadsafe.
222 **
223 ** The following mutex is what serializes access to the appdef pcache xInit
224 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
225 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000226 */
danielk1977075c23a2008-09-01 18:34:20 +0000227 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000228 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977502b4e02008-09-02 14:07:24 +0000229 sqlite3GlobalConfig.inProgress = 1;
drh5e3cefe2015-11-12 23:48:08 +0000230#ifdef SQLITE_ENABLE_SQLLOG
dand83f7ca2015-11-12 20:12:51 +0000231 {
drh5e3cefe2015-11-12 23:48:08 +0000232 extern void sqlite3_init_sqllog(void);
233 sqlite3_init_sqllog();
dand83f7ca2015-11-12 20:12:51 +0000234 }
235#endif
drh80738d92016-02-15 00:34:16 +0000236 memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
237 sqlite3RegisterBuiltinFunctions();
dane1ab2192009-08-17 15:16:19 +0000238 if( sqlite3GlobalConfig.isPCacheInit==0 ){
239 rc = sqlite3PcacheInitialize();
240 }
danielk19778c0a7912008-08-20 14:49:23 +0000241 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000242 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000243 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000244 }
drh9c6396e2018-03-06 21:43:19 +0000245#ifdef SQLITE_ENABLE_DESERIALIZE
drhac442f42018-01-03 01:28:46 +0000246 if( rc==SQLITE_OK ){
247 rc = sqlite3MemdbInit();
248 }
249#endif
drh0bf9f7b2009-04-17 16:54:22 +0000250 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000251 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
252 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000253 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000254#ifdef SQLITE_EXTRA_INIT
255 bRunExtraInit = 1;
256#endif
danielk19778c0a7912008-08-20 14:49:23 +0000257 }
danielk1977502b4e02008-09-02 14:07:24 +0000258 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000259 }
danielk1977075c23a2008-09-01 18:34:20 +0000260 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000261
drh93ed56d2008-08-12 15:21:11 +0000262 /* Go back under the static mutex and clean up the recursive
263 ** mutex to prevent a resource leak.
264 */
265 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000266 sqlite3GlobalConfig.nRefInitMutex--;
267 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
268 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
269 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
270 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000271 }
272 sqlite3_mutex_leave(pMaster);
273
274 /* The following is just a sanity check to make sure SQLite has
275 ** been compiled correctly. It is important to run this code, but
276 ** we don't want to run it too often and soak up CPU cycles for no
277 ** reason. So we run it once during initialization.
278 */
shanedfb7b372008-07-22 05:13:30 +0000279#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000280#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000281 /* This section of code's only "output" is via assert() statements. */
drhac442f42018-01-03 01:28:46 +0000282 if( rc==SQLITE_OK ){
shanedfb7b372008-07-22 05:13:30 +0000283 u64 x = (((u64)1)<<63)-1;
284 double y;
285 assert(sizeof(x)==8);
286 assert(sizeof(x)==sizeof(y));
287 memcpy(&y, &x, 8);
288 assert( sqlite3IsNaN(y) );
289 }
290#endif
shanefbd60f82009-02-04 03:59:25 +0000291#endif
shanedfb7b372008-07-22 05:13:30 +0000292
drhe4cf0b32011-08-25 00:14:41 +0000293 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
294 ** compile-time option.
295 */
296#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000297 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000298 int SQLITE_EXTRA_INIT(const char*);
299 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000300 }
301#endif
302
drh40257ff2008-06-13 18:24:27 +0000303 return rc;
304}
305
306/*
307** Undo the effects of sqlite3_initialize(). Must not be called while
308** there are outstanding database connections or memory allocations or
309** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000310** routine is not threadsafe. But it is safe to invoke this routine
311** on when SQLite is already shut down. If SQLite is already shut down
312** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000313*/
314int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000315#ifdef SQLITE_OMIT_WSD
316 int rc = sqlite3_wsd_init(4096, 24);
317 if( rc!=SQLITE_OK ){
318 return rc;
319 }
320#endif
321
danielk1977075c23a2008-09-01 18:34:20 +0000322 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000323#ifdef SQLITE_EXTRA_SHUTDOWN
324 void SQLITE_EXTRA_SHUTDOWN(void);
325 SQLITE_EXTRA_SHUTDOWN();
326#endif
drha7640922009-04-21 12:02:56 +0000327 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000328 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000329 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000330 }
dane1ab2192009-08-17 15:16:19 +0000331 if( sqlite3GlobalConfig.isPCacheInit ){
332 sqlite3PcacheShutdown();
333 sqlite3GlobalConfig.isPCacheInit = 0;
334 }
335 if( sqlite3GlobalConfig.isMallocInit ){
336 sqlite3MallocEnd();
337 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000338
339#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
340 /* The heap subsystem has now been shutdown and these values are supposed
341 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
342 ** which would rely on that heap subsystem; therefore, make sure these
343 ** values cannot refer to heap memory that was just invalidated when the
344 ** heap subsystem was shutdown. This is only done if the current call to
345 ** this function resulted in the heap subsystem actually being shutdown.
346 */
347 sqlite3_data_directory = 0;
348 sqlite3_temp_directory = 0;
349#endif
dane1ab2192009-08-17 15:16:19 +0000350 }
351 if( sqlite3GlobalConfig.isMutexInit ){
352 sqlite3MutexEnd();
353 sqlite3GlobalConfig.isMutexInit = 0;
354 }
355
drh40257ff2008-06-13 18:24:27 +0000356 return SQLITE_OK;
357}
358
359/*
360** This API allows applications to modify the global configuration of
361** the SQLite library at run-time.
362**
363** This routine should only be called when there are no outstanding
364** database connections or memory allocations. This routine is not
365** threadsafe. Failure to heed these warnings can lead to unpredictable
366** behavior.
367*/
368int sqlite3_config(int op, ...){
369 va_list ap;
370 int rc = SQLITE_OK;
371
372 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
373 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000374 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000375
376 va_start(ap, op);
377 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000378
379 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000380 ** compile.
drh18472fa2008-10-07 15:25:48 +0000381 */
drhd1dcb232014-11-01 18:32:18 +0000382#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000383 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000384 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
385 ** Single-thread. */
386 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
387 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000388 break;
389 }
drhd1dcb232014-11-01 18:32:18 +0000390#endif
391#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000392 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000393 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
394 ** Multi-thread. */
395 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
396 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000397 break;
398 }
drhd1dcb232014-11-01 18:32:18 +0000399#endif
400#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000401 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000402 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
403 ** Serialized. */
404 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
405 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000406 break;
407 }
drhd1dcb232014-11-01 18:32:18 +0000408#endif
409#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000410 case SQLITE_CONFIG_MUTEX: {
411 /* Specify an alternative mutex implementation */
412 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
413 break;
414 }
drhd1dcb232014-11-01 18:32:18 +0000415#endif
416#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000417 case SQLITE_CONFIG_GETMUTEX: {
418 /* Retrieve the current mutex implementation */
419 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
420 break;
421 }
422#endif
423
drh40257ff2008-06-13 18:24:27 +0000424 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000425 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
426 ** single argument which is a pointer to an instance of the
427 ** sqlite3_mem_methods structure. The argument specifies alternative
428 ** low-level memory allocation routines to be used in place of the memory
429 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000430 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000431 break;
432 }
drh33589792008-06-18 13:27:46 +0000433 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000434 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
435 ** single argument which is a pointer to an instance of the
436 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
437 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000438 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
439 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000440 break;
441 }
drhfec00ea2008-06-14 16:56:21 +0000442 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000443 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
444 ** single argument of type int, interpreted as a boolean, which enables
445 ** or disables the collection of memory allocation statistics. */
danielk1977075c23a2008-09-01 18:34:20 +0000446 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000447 break;
448 }
drhb2a0f752017-08-28 15:51:35 +0000449 case SQLITE_CONFIG_SMALL_MALLOC: {
450 sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000451 break;
452 }
453 case SQLITE_CONFIG_PAGECACHE: {
drh15427272015-12-03 22:33:55 +0000454 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
455 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
456 ** the size of each page cache line (sz), and the number of cache lines
457 ** (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000458 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
459 sqlite3GlobalConfig.szPage = va_arg(ap, int);
460 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000461 break;
462 }
drhdef68892014-11-04 12:11:23 +0000463 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000464 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
465 ** a single parameter which is a pointer to an integer and writes into
466 ** that integer the number of extra bytes per page required for each page
467 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000468 *va_arg(ap, int*) =
469 sqlite3HeaderSizeBtree() +
470 sqlite3HeaderSizePcache() +
471 sqlite3HeaderSizePcache1();
472 break;
473 }
danielk19775099be52008-06-27 13:27:03 +0000474
danielk1977bc2ca9e2008-11-13 14:28:28 +0000475 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000476 /* no-op */
477 break;
478 }
479 case SQLITE_CONFIG_GETPCACHE: {
480 /* now an error */
481 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000482 break;
483 }
484
dan22e21ff2011-11-08 20:08:44 +0000485 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000486 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
487 ** single argument which is a pointer to an sqlite3_pcache_methods2
488 ** object. This object specifies the interface to a custom page cache
489 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000490 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
491 break;
492 }
493 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000494 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
495 ** single argument which is a pointer to an sqlite3_pcache_methods2
496 ** object. SQLite copies of the current page cache implementation into
497 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000498 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000499 sqlite3PCacheSetDefault();
500 }
dan22e21ff2011-11-08 20:08:44 +0000501 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000502 break;
503 }
504
drh8790b6e2014-11-07 01:43:56 +0000505/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
506** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
507** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000508#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000509 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000510 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
511 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000512 ** number of bytes in the memory buffer, and the minimum allocation size.
513 */
danielk1977075c23a2008-09-01 18:34:20 +0000514 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
515 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
516 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000517
shaneha6ec8922011-03-09 21:36:17 +0000518 if( sqlite3GlobalConfig.mnReq<1 ){
519 sqlite3GlobalConfig.mnReq = 1;
520 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
521 /* cap min request size at 2^12 */
522 sqlite3GlobalConfig.mnReq = (1<<12);
523 }
524
danielk1977075c23a2008-09-01 18:34:20 +0000525 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000526 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
527 ** is NULL, then SQLite reverts to using its default memory allocator
528 ** (the system malloc() implementation), undoing any prior invocation of
529 ** SQLITE_CONFIG_MALLOC.
530 **
531 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
532 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000533 */
danielk1977075c23a2008-09-01 18:34:20 +0000534 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000535 }else{
drh8790b6e2014-11-07 01:43:56 +0000536 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
537 ** alternative memory allocator is engaged to handle all of SQLites
538 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000539#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000540 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000541#endif
542#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000543 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000544#endif
drh8a42cbd2008-07-10 18:13:42 +0000545 }
danielk19775099be52008-06-27 13:27:03 +0000546 break;
547 }
drh5d414832008-07-15 14:47:18 +0000548#endif
danielk19775099be52008-06-27 13:27:03 +0000549
drh633e6d52008-07-28 19:34:53 +0000550 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000551 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
552 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000553 break;
554 }
drh3f280702010-02-18 18:45:09 +0000555
mistachkin037933b2013-08-13 22:33:41 +0000556 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000557 ** The default is NULL. Logging is disabled if the function pointer is
558 ** NULL.
559 */
560 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000561 /* MSVC is picky about pulling func ptrs from va lists.
562 ** http://support.microsoft.com/kb/47961
563 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
564 */
565 typedef void(*LOGFUNC_t)(void*,int,const char*);
566 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000567 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
568 break;
569 }
drh633e6d52008-07-28 19:34:53 +0000570
drh00729cb2014-10-04 11:59:33 +0000571 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
572 ** can be changed at start-time using the
573 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
574 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
575 */
dancd74b612011-04-22 19:37:32 +0000576 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000577 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
578 ** argument of type int. If non-zero, then URI handling is globally
579 ** enabled. If the parameter is zero, then URI handling is globally
580 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000581 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
582 break;
583 }
584
drhde9a7b82012-09-17 20:44:46 +0000585 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000586 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
587 ** option takes a single integer argument which is interpreted as a
588 ** boolean in order to enable or disable the use of covering indices for
589 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000590 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
591 break;
592 }
593
danac455932012-11-26 19:50:41 +0000594#ifdef SQLITE_ENABLE_SQLLOG
595 case SQLITE_CONFIG_SQLLOG: {
596 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
597 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
598 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
599 break;
600 }
601#endif
602
drh9b4c59f2013-04-15 17:03:42 +0000603 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000604 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
605 ** integer (sqlite3_int64) values that are the default mmap size limit
606 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
607 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000608 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000609 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000610 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000611 ** negative, then that argument is changed to its compile-time default.
612 **
613 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
614 ** silently truncated if necessary so that it does not exceed the
615 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
616 ** compile-time option.
617 */
drh3ba689d2015-03-03 14:00:11 +0000618 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
619 mxMmap = SQLITE_MAX_MMAP_SIZE;
620 }
drh9b4c59f2013-04-15 17:03:42 +0000621 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
622 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000623 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000624 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000625 break;
626 }
627
drh4d9f1882014-11-04 17:23:24 +0000628#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000629 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000630 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
631 ** unsigned integer value that specifies the maximum size of the created
632 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000633 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
634 break;
635 }
636#endif
637
drh3bd17912015-01-02 15:55:29 +0000638 case SQLITE_CONFIG_PMASZ: {
639 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
640 break;
641 }
642
drh8c71a982016-03-07 17:37:37 +0000643 case SQLITE_CONFIG_STMTJRNL_SPILL: {
644 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
645 break;
646 }
647
dan2e3a5a82018-04-16 21:12:42 +0000648#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbade8d2018-04-18 14:48:08 +0000649 case SQLITE_CONFIG_SORTERREF_SIZE: {
dan2e3a5a82018-04-16 21:12:42 +0000650 int iVal = va_arg(ap, int);
651 if( iVal<0 ){
652 iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
653 }
654 sqlite3GlobalConfig.szSorterRef = (u32)iVal;
dan2e3a5a82018-04-16 21:12:42 +0000655 break;
656 }
drhbbade8d2018-04-18 14:48:08 +0000657#endif /* SQLITE_ENABLE_SORTER_REFERENCES */
dan2e3a5a82018-04-16 21:12:42 +0000658
drh40257ff2008-06-13 18:24:27 +0000659 default: {
660 rc = SQLITE_ERROR;
661 break;
662 }
663 }
664 va_end(ap);
665 return rc;
666}
667
668/*
drh633e6d52008-07-28 19:34:53 +0000669** Set up the lookaside buffers for a database connection.
670** Return SQLITE_OK on success.
671** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000672**
673** The sz parameter is the number of bytes in each lookaside slot.
674** The cnt parameter is the number of slots. If pStart is NULL the
675** space for the lookaside memory is obtained from sqlite3_malloc().
676** If pStart is not NULL then it is sz*cnt bytes of memory to use for
677** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000678*/
drhe9d1c722008-08-04 20:13:26 +0000679static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000680#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000681 void *pStart;
drh52fb8e12017-08-29 20:21:12 +0000682
683 if( sqlite3LookasideUsed(db,0)>0 ){
drh633e6d52008-07-28 19:34:53 +0000684 return SQLITE_BUSY;
685 }
shanef71f89e2009-01-30 06:11:54 +0000686 /* Free any existing lookaside buffer for this handle before
687 ** allocating a new one so we don't have to have space for
688 ** both at the same time.
689 */
690 if( db->lookaside.bMalloced ){
691 sqlite3_free(db->lookaside.pStart);
692 }
drh61a4bd52011-11-10 02:39:28 +0000693 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
694 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000695 */
drh61a4bd52011-11-10 02:39:28 +0000696 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000697 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000698 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000699 if( sz==0 || cnt==0 ){
700 sz = 0;
701 pStart = 0;
702 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000703 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000704 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000705 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000706 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000707 }else{
708 pStart = pBuf;
709 }
drh4cfb22f2008-08-01 18:47:01 +0000710 db->lookaside.pStart = pStart;
drh52fb8e12017-08-29 20:21:12 +0000711 db->lookaside.pInit = 0;
drh4cfb22f2008-08-01 18:47:01 +0000712 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000713 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000714 if( pStart ){
715 int i;
716 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000717 assert( sz > (int)sizeof(LookasideSlot*) );
drh52fb8e12017-08-29 20:21:12 +0000718 db->lookaside.nSlot = cnt;
drh633e6d52008-07-28 19:34:53 +0000719 p = (LookasideSlot*)pStart;
720 for(i=cnt-1; i>=0; i--){
drh52fb8e12017-08-29 20:21:12 +0000721 p->pNext = db->lookaside.pInit;
722 db->lookaside.pInit = p;
drh633e6d52008-07-28 19:34:53 +0000723 p = (LookasideSlot*)&((u8*)p)[sz];
724 }
725 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000726 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000727 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000728 }else{
drhb0e77042013-12-10 19:49:00 +0000729 db->lookaside.pStart = db;
730 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000731 db->lookaside.bDisable = 1;
shanef71f89e2009-01-30 06:11:54 +0000732 db->lookaside.bMalloced = 0;
drh52fb8e12017-08-29 20:21:12 +0000733 db->lookaside.nSlot = 0;
drh633e6d52008-07-28 19:34:53 +0000734 }
drh7877d9a2015-07-23 17:16:27 +0000735#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000736 return SQLITE_OK;
737}
738
739/*
drh4413d0e2008-11-04 13:46:27 +0000740** Return the mutex associated with a database connection.
741*/
742sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000743#ifdef SQLITE_ENABLE_API_ARMOR
744 if( !sqlite3SafetyCheckOk(db) ){
745 (void)SQLITE_MISUSE_BKPT;
746 return 0;
747 }
748#endif
drh4413d0e2008-11-04 13:46:27 +0000749 return db->mutex;
750}
751
752/*
drh09419b42011-11-16 19:29:17 +0000753** Free up as much memory as we can from the given database
754** connection.
755*/
756int sqlite3_db_release_memory(sqlite3 *db){
757 int i;
drh9ca95732014-10-24 00:35:58 +0000758
759#ifdef SQLITE_ENABLE_API_ARMOR
760 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
761#endif
dand9bb3a92011-12-30 11:43:59 +0000762 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000763 sqlite3BtreeEnterAll(db);
764 for(i=0; i<db->nDb; i++){
765 Btree *pBt = db->aDb[i].pBt;
766 if( pBt ){
767 Pager *pPager = sqlite3BtreePager(pBt);
768 sqlite3PagerShrink(pPager);
769 }
770 }
771 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000772 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000773 return SQLITE_OK;
774}
775
776/*
dan6fa255f2015-10-28 19:46:57 +0000777** Flush any dirty pages in the pager-cache for any attached database
778** to disk.
779*/
780int sqlite3_db_cacheflush(sqlite3 *db){
781 int i;
782 int rc = SQLITE_OK;
783 int bSeenBusy = 0;
784
785#ifdef SQLITE_ENABLE_API_ARMOR
786 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
787#endif
788 sqlite3_mutex_enter(db->mutex);
789 sqlite3BtreeEnterAll(db);
790 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
791 Btree *pBt = db->aDb[i].pBt;
792 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
793 Pager *pPager = sqlite3BtreePager(pBt);
794 rc = sqlite3PagerFlush(pPager);
795 if( rc==SQLITE_BUSY ){
796 bSeenBusy = 1;
797 rc = SQLITE_OK;
798 }
799 }
800 }
dan6fa255f2015-10-28 19:46:57 +0000801 sqlite3BtreeLeaveAll(db);
802 sqlite3_mutex_leave(db->mutex);
803 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
804}
805
806/*
drh633e6d52008-07-28 19:34:53 +0000807** Configuration settings for an individual database connection
808*/
809int sqlite3_db_config(sqlite3 *db, int op, ...){
810 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000811 int rc;
drh633e6d52008-07-28 19:34:53 +0000812 va_start(ap, op);
813 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000814 case SQLITE_DBCONFIG_MAINDBNAME: {
drh749e4a92017-07-14 19:47:32 +0000815 /* IMP: R-06824-28531 */
816 /* IMP: R-36257-52125 */
drhda84dca2016-08-18 22:44:22 +0000817 db->aDb[0].zDbSName = va_arg(ap,char*);
818 rc = SQLITE_OK;
819 break;
820 }
drhe9d1c722008-08-04 20:13:26 +0000821 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000822 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000823 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
824 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000825 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000826 break;
827 }
drh6480aad2008-08-01 16:31:14 +0000828 default: {
drhe83cafd2011-03-21 17:15:58 +0000829 static const struct {
830 int op; /* The opcode */
831 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
832 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000833 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
834 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
835 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000836 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000837 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drh169dd922017-06-26 13:57:49 +0000838 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
drh36e31c62017-12-21 18:23:26 +0000839 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
drh7df01192018-04-28 12:43:16 +0000840 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
drhe83cafd2011-03-21 17:15:58 +0000841 };
drh58ad5802011-03-23 22:02:23 +0000842 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000843 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000844 for(i=0; i<ArraySize(aFlagOp); i++){
845 if( aFlagOp[i].op==op ){
846 int onoff = va_arg(ap, int);
847 int *pRes = va_arg(ap, int*);
mistachkinf6285fa2017-07-28 22:13:26 +0000848 u32 oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000849 if( onoff>0 ){
850 db->flags |= aFlagOp[i].mask;
851 }else if( onoff==0 ){
852 db->flags &= ~aFlagOp[i].mask;
853 }
854 if( oldFlags!=db->flags ){
855 sqlite3ExpirePreparedStatements(db);
856 }
857 if( pRes ){
858 *pRes = (db->flags & aFlagOp[i].mask)!=0;
859 }
860 rc = SQLITE_OK;
861 break;
862 }
863 }
drh6480aad2008-08-01 16:31:14 +0000864 break;
865 }
drh633e6d52008-07-28 19:34:53 +0000866 }
867 va_end(ap);
868 return rc;
869}
870
drha16313e2007-03-30 11:29:32 +0000871
872/*
drh9b5adfa2008-01-20 23:19:56 +0000873** Return true if the buffer z[0..n-1] contains all spaces.
874*/
875static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000876 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000877 return n==0;
878}
879
880/*
drhd3d39e92004-05-20 22:16:29 +0000881** This is the default collating function named "BINARY" which is always
882** available.
drh9b5adfa2008-01-20 23:19:56 +0000883**
884** If the padFlag argument is not NULL then space padding at the end
885** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000886*/
danielk19772c336542005-01-13 02:14:23 +0000887static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000888 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000889 int nKey1, const void *pKey1,
890 int nKey2, const void *pKey2
891){
892 int rc, n;
893 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000894 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
895 ** strings byte by byte using the memcmp() function from the standard C
896 ** library. */
dan21766c02017-05-22 08:04:09 +0000897 assert( pKey1 && pKey2 );
drhd3d39e92004-05-20 22:16:29 +0000898 rc = memcmp(pKey1, pKey2, n);
899 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000900 if( padFlag
901 && allSpaces(((char*)pKey1)+n, nKey1-n)
902 && allSpaces(((char*)pKey2)+n, nKey2-n)
903 ){
drh5e3b49b2014-11-20 19:22:26 +0000904 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
905 ** spaces at the end of either string do not change the result. In other
906 ** words, strings will compare equal to one another as long as they
907 ** differ only in the number of spaces at the end.
908 */
drh9b5adfa2008-01-20 23:19:56 +0000909 }else{
910 rc = nKey1 - nKey2;
911 }
drhd3d39e92004-05-20 22:16:29 +0000912 }
913 return rc;
914}
915
916/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000917** Another built-in collating sequence: NOCASE.
918**
drhf7b54962013-05-28 12:11:54 +0000919** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000920** comparison". SQLite's knowledge of upper and lower case equivalents
921** extends only to the 26 characters used in the English language.
922**
923** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000924*/
925static int nocaseCollatingFunc(
926 void *NotUsed,
927 int nKey1, const void *pKey1,
928 int nKey2, const void *pKey2
929){
930 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000931 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000932 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000933 if( 0==r ){
934 r = nKey1-nKey2;
935 }
936 return r;
937}
938
939/*
drhaf9ff332002-01-16 21:00:27 +0000940** Return the ROWID of the most recent insert
941*/
drh9bb575f2004-09-06 17:24:11 +0000942sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000943#ifdef SQLITE_ENABLE_API_ARMOR
944 if( !sqlite3SafetyCheckOk(db) ){
945 (void)SQLITE_MISUSE_BKPT;
946 return 0;
947 }
948#endif
drhaf9ff332002-01-16 21:00:27 +0000949 return db->lastRowid;
950}
951
952/*
dan9c58b632017-02-27 14:52:48 +0000953** Set the value returned by the sqlite3_last_insert_rowid() API function.
954*/
955void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
956#ifdef SQLITE_ENABLE_API_ARMOR
957 if( !sqlite3SafetyCheckOk(db) ){
958 (void)SQLITE_MISUSE_BKPT;
959 return;
960 }
961#endif
962 sqlite3_mutex_enter(db->mutex);
963 db->lastRowid = iRowid;
964 sqlite3_mutex_leave(db->mutex);
965}
966
967/*
danielk197724b03fd2004-05-10 10:34:34 +0000968** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000969*/
drh9bb575f2004-09-06 17:24:11 +0000970int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000971#ifdef SQLITE_ENABLE_API_ARMOR
972 if( !sqlite3SafetyCheckOk(db) ){
973 (void)SQLITE_MISUSE_BKPT;
974 return 0;
975 }
976#endif
drhc8d30ac2002-04-12 10:08:59 +0000977 return db->nChange;
978}
979
rdcf146a772004-02-25 22:51:06 +0000980/*
danielk1977b28af712004-06-21 06:50:26 +0000981** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000982*/
danielk1977b28af712004-06-21 06:50:26 +0000983int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000984#ifdef SQLITE_ENABLE_API_ARMOR
985 if( !sqlite3SafetyCheckOk(db) ){
986 (void)SQLITE_MISUSE_BKPT;
987 return 0;
988 }
989#endif
danielk1977b28af712004-06-21 06:50:26 +0000990 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000991}
992
drhc8d30ac2002-04-12 10:08:59 +0000993/*
danielk1977fd7f0452008-12-17 17:30:26 +0000994** Close all open savepoints. This function only manipulates fields of the
995** database handle object, it does not close any savepoints that may be open
996** at the b-tree/pager level.
997*/
998void sqlite3CloseSavepoints(sqlite3 *db){
999 while( db->pSavepoint ){
1000 Savepoint *pTmp = db->pSavepoint;
1001 db->pSavepoint = pTmp->pNext;
1002 sqlite3DbFree(db, pTmp);
1003 }
1004 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +00001005 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00001006 db->isTransactionSavepoint = 0;
1007}
1008
1009/*
dand2199f02010-08-27 17:48:52 +00001010** Invoke the destructor function associated with FuncDef p, if any. Except,
1011** if this is not the last copy of the function, do not invoke it. Multiple
1012** copies of a single function are created when create_function() is called
1013** with SQLITE_ANY as the encoding.
1014*/
1015static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +00001016 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +00001017 if( pDestructor ){
1018 pDestructor->nRef--;
1019 if( pDestructor->nRef==0 ){
1020 pDestructor->xDestroy(pDestructor->pUserData);
1021 sqlite3DbFree(db, pDestructor);
1022 }
1023 }
1024}
1025
1026/*
danbba02a92012-05-15 17:15:34 +00001027** Disconnect all sqlite3_vtab objects that belong to database connection
1028** db. This is called when db is being closed.
1029*/
1030static void disconnectAllVtab(sqlite3 *db){
1031#ifndef SQLITE_OMIT_VIRTUALTABLE
1032 int i;
drh51be3872015-08-19 02:32:25 +00001033 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001034 sqlite3BtreeEnterAll(db);
1035 for(i=0; i<db->nDb; i++){
1036 Schema *pSchema = db->aDb[i].pSchema;
1037 if( db->aDb[i].pSchema ){
danbba02a92012-05-15 17:15:34 +00001038 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1039 Table *pTab = (Table *)sqliteHashData(p);
1040 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1041 }
1042 }
1043 }
drh51be3872015-08-19 02:32:25 +00001044 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1045 Module *pMod = (Module *)sqliteHashData(p);
1046 if( pMod->pEpoTab ){
1047 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1048 }
1049 }
dand88e5212014-03-12 19:38:38 +00001050 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001051 sqlite3BtreeLeaveAll(db);
1052#else
1053 UNUSED_PARAMETER(db);
1054#endif
1055}
1056
1057/*
drh167cd6a2012-06-02 17:09:46 +00001058** Return TRUE if database connection db has unfinalized prepared
1059** statements or unfinished sqlite3_backup objects.
1060*/
1061static int connectionIsBusy(sqlite3 *db){
1062 int j;
1063 assert( sqlite3_mutex_held(db->mutex) );
1064 if( db->pVdbe ) return 1;
1065 for(j=0; j<db->nDb; j++){
1066 Btree *pBt = db->aDb[j].pBt;
1067 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1068 }
1069 return 0;
1070}
1071
1072/*
drh50e5dad2001-09-15 00:57:28 +00001073** Close an existing SQLite database
1074*/
drh167cd6a2012-06-02 17:09:46 +00001075static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001076 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001077 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1078 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001079 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001080 }
drh7e8b8482008-01-23 03:03:05 +00001081 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001082 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001083 }
drh605264d2007-08-21 15:13:19 +00001084 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001085 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1086 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1087 }
danielk1977e35ee192004-06-26 09:50:11 +00001088
danbba02a92012-05-15 17:15:34 +00001089 /* Force xDisconnect calls on all virtual tables */
1090 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001091
danbba02a92012-05-15 17:15:34 +00001092 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001093 ** will not have called the xDisconnect() method on any virtual
1094 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1095 ** call will do so. We need to do this before the check for active
1096 ** SQL statements below, as the v-table implementation may be storing
1097 ** some prepared statements internally.
1098 */
1099 sqlite3VtabRollback(db);
1100
drh167cd6a2012-06-02 17:09:46 +00001101 /* Legacy behavior (sqlite3_close() behavior) is to return
1102 ** SQLITE_BUSY if the connection can not be closed immediately.
1103 */
1104 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001105 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001106 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001107 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001108 return SQLITE_BUSY;
1109 }
danielk1977e0048402004-06-15 16:51:01 +00001110
danac455932012-11-26 19:50:41 +00001111#ifdef SQLITE_ENABLE_SQLLOG
1112 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001113 /* Closing the handle. Fourth parameter is passed the value 2. */
1114 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001115 }
1116#endif
1117
drh167cd6a2012-06-02 17:09:46 +00001118 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001119 */
1120 db->magic = SQLITE_MAGIC_ZOMBIE;
1121 sqlite3LeaveMutexAndCloseZombie(db);
1122 return SQLITE_OK;
1123}
drh94e92032003-02-16 22:21:32 +00001124
drh167cd6a2012-06-02 17:09:46 +00001125/*
1126** Two variations on the public interface for closing a database
1127** connection. The sqlite3_close() version returns SQLITE_BUSY and
1128** leaves the connection option if there are unfinalized prepared
1129** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1130** version forces the connection to become a zombie if there are
1131** unclosed resources, and arranges for deallocation when the last
1132** prepare statement or sqlite3_backup closes.
1133*/
1134int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1135int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1136
drh4245c402012-06-02 14:32:21 +00001137
1138/*
1139** Close the mutex on database connection db.
1140**
1141** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001142** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1143** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1144** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001145*/
1146void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1147 HashElem *i; /* Hash table iterator */
1148 int j;
1149
drh4245c402012-06-02 14:32:21 +00001150 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001151 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1152 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001153 */
drh167cd6a2012-06-02 17:09:46 +00001154 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001155 sqlite3_mutex_leave(db->mutex);
1156 return;
danielk197704103022009-02-03 16:51:24 +00001157 }
1158
drh4245c402012-06-02 14:32:21 +00001159 /* If we reach this point, it means that the database connection has
1160 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001161 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001162 ** go ahead and free all resources.
1163 */
1164
dan617dc862013-05-16 11:57:28 +00001165 /* If a transaction is open, roll it back. This also ensures that if
1166 ** any database schemas have been modified by an uncommitted transaction
1167 ** they are reset. And that the required b-tree mutex is held to make
1168 ** the pager rollback and schema reset an atomic operation. */
1169 sqlite3RollbackAll(db, SQLITE_OK);
1170
danielk1977fd7f0452008-12-17 17:30:26 +00001171 /* Free any outstanding Savepoint structures. */
1172 sqlite3CloseSavepoints(db);
1173
drh5efb3142012-05-16 01:24:34 +00001174 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001175 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001176 struct Db *pDb = &db->aDb[j];
1177 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +00001178 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +00001179 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +00001180 if( j!=1 ){
1181 pDb->pSchema = 0;
1182 }
drh113088e2003-03-20 01:16:58 +00001183 }
drhf57b3392001-10-08 13:22:32 +00001184 }
drh5efb3142012-05-16 01:24:34 +00001185 /* Clear the TEMP schema separately and last */
1186 if( db->aDb[1].pSchema ){
1187 sqlite3SchemaClear(db->aDb[1].pSchema);
1188 }
1189 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001190
drh5efb3142012-05-16 01:24:34 +00001191 /* Free up the array of auxiliary databases */
1192 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001193 assert( db->nDb<=2 );
1194 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001195
1196 /* Tell the code in notify.c that the connection no longer holds any
1197 ** locks and does not require any further unlock-notify callbacks.
1198 */
1199 sqlite3ConnectionClosed(db);
1200
drh80738d92016-02-15 00:34:16 +00001201 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1202 FuncDef *pNext, *p;
1203 p = sqliteHashData(i);
1204 do{
1205 functionDestroy(db, p);
1206 pNext = p->pNext;
1207 sqlite3DbFree(db, p);
1208 p = pNext;
1209 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001210 }
drh80738d92016-02-15 00:34:16 +00001211 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001212 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001213 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001214 /* Invoke any destructors registered for collation sequence user data. */
1215 for(j=0; j<3; j++){
1216 if( pColl[j].xDel ){
1217 pColl[j].xDel(pColl[j].pUser);
1218 }
1219 }
drh633e6d52008-07-28 19:34:53 +00001220 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001221 }
danielk1977d8123362004-06-12 09:25:12 +00001222 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001223#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001224 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1225 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001226 if( pMod->xDestroy ){
1227 pMod->xDestroy(pMod->pAux);
1228 }
drh51be3872015-08-19 02:32:25 +00001229 sqlite3VtabEponymousTableClear(db, pMod);
drh633e6d52008-07-28 19:34:53 +00001230 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001231 }
drhb9bb7c12006-06-11 23:41:55 +00001232 sqlite3HashClear(&db->aModule);
1233#endif
danielk1977466be562004-06-10 02:16:01 +00001234
drh13f40da2014-08-22 18:00:11 +00001235 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001236 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001237 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001238#if SQLITE_USER_AUTHENTICATION
1239 sqlite3_free(db->auth.zAuthUser);
1240 sqlite3_free(db->auth.zAuthPW);
1241#endif
danielk197796d81f92004-06-19 03:33:57 +00001242
1243 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001244
1245 /* The temp-database schema is allocated differently from the other schema
1246 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1247 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1248 ** the same sqliteMalloc() as the one that allocates the database
1249 ** structure?
1250 */
drh633e6d52008-07-28 19:34:53 +00001251 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001252 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001253 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001254 sqlite3_mutex_free(db->mutex);
drh52fb8e12017-08-29 20:21:12 +00001255 assert( sqlite3LookasideUsed(db,0)==0 );
drhe9d1c722008-08-04 20:13:26 +00001256 if( db->lookaside.bMalloced ){
1257 sqlite3_free(db->lookaside.pStart);
1258 }
adame6c3c722009-11-03 22:34:35 +00001259#ifdef SQLITE_ENABLE_SQLRR
1260 SRRecClose(db);
1261#endif
1262
drh17435752007-08-16 04:30:38 +00001263 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001264}
1265
1266/*
drh0f198a72012-02-13 16:43:16 +00001267** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001268** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001269** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001270** attempts to use that cursor. Read cursors remain open and valid
1271** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001272*/
drh0f198a72012-02-13 16:43:16 +00001273void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001274 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001275 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001276 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001277 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001278 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001279
1280 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1281 ** This is important in case the transaction being rolled back has
1282 ** modified the database schema. If the b-tree mutexes are not taken
1283 ** here, then another shared-cache connection might sneak in between
1284 ** the database rollback and schema reset, which can cause false
1285 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001286 sqlite3BtreeEnterAll(db);
drh8257aa82017-07-26 19:59:13 +00001287 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001288
drh001bbcb2003-03-19 03:14:00 +00001289 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001290 Btree *p = db->aDb[i].pBt;
1291 if( p ){
1292 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001293 inTrans = 1;
1294 }
drh47b7fc72014-11-11 01:33:57 +00001295 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001296 }
1297 }
danielk1977a298e902006-06-22 09:53:48 +00001298 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001299 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001300
drh8257aa82017-07-26 19:59:13 +00001301 if( (db->mDbFlags&DBFLAG_SchemaChange)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001302 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001303 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001304 }
dancd7b91a2013-05-13 18:23:15 +00001305 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001306
dan1da40a32009-09-19 17:00:31 +00001307 /* Any deferred constraint violations have now been resolved. */
1308 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001309 db->nDeferredImmCons = 0;
1310 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001311
danielk197771fd80b2005-12-16 06:54:01 +00001312 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001313 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001314 db->xRollbackCallback(db->pRollbackArg);
1315 }
drh001bbcb2003-03-19 03:14:00 +00001316}
1317
1318/*
mistachkinf2c1c992013-04-28 01:44:43 +00001319** Return a static string containing the name corresponding to the error code
1320** specified in the argument.
1321*/
mistachkin5824d442015-04-28 23:34:10 +00001322#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001323const char *sqlite3ErrName(int rc){
1324 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001325 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001326 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1327 switch( rc ){
1328 case SQLITE_OK: zName = "SQLITE_OK"; break;
1329 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1330 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1331 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1332 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001333 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001334 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001335 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001336 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001337 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1338 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1339 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1340 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001341 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
drh7e45e3a2017-11-08 17:32:12 +00001342 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001343 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001344 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
dana688ca52018-01-10 11:56:03 +00001345 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
mistachkinf2c1c992013-04-28 01:44:43 +00001346 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1347 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001348 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1349 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1350 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1351 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1352 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1353 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1354 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1355 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1356 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1357 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001358 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1359 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1360 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1361 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1362 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1363 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1364 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1365 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1366 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1367 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1368 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1369 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1370 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1371 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001372 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001373 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
dan30410532017-11-17 20:22:11 +00001374 case SQLITE_IOERR_VNODE: zName = "SQLITE_IOERR_VNODE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001375 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001376 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001377 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1378 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1379 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001380 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1381 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1382 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001383 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001384 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1385 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1386 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1387 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1388 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1389 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1390 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1391 case SQLITE_CONSTRAINT_FOREIGNKEY:
1392 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1393 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1394 case SQLITE_CONSTRAINT_PRIMARYKEY:
1395 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1396 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1397 case SQLITE_CONSTRAINT_COMMITHOOK:
1398 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1399 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1400 case SQLITE_CONSTRAINT_FUNCTION:
1401 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001402 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001403 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1404 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1405 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1406 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1407 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1408 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1409 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1410 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1411 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001412 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1413 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1414 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001415 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001416 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001417 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001418 }
1419 }
mistachkin10269dc2013-04-30 07:54:42 +00001420 if( zName==0 ){
1421 static char zBuf[50];
1422 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1423 zName = zBuf;
1424 }
mistachkinf2c1c992013-04-28 01:44:43 +00001425 return zName;
1426}
mistachkin10269dc2013-04-30 07:54:42 +00001427#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001428
1429/*
drhc22bd472002-05-10 13:14:07 +00001430** Return a static string that describes the kind of error specified in the
1431** argument.
drh247be432002-05-10 05:44:55 +00001432*/
danielk1977f20b21c2004-05-31 23:56:42 +00001433const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001434 static const char* const aMsg[] = {
1435 /* SQLITE_OK */ "not an error",
drha690ff32017-07-07 19:43:23 +00001436 /* SQLITE_ERROR */ "SQL logic error",
drh51c7d862009-04-27 18:46:06 +00001437 /* SQLITE_INTERNAL */ 0,
1438 /* SQLITE_PERM */ "access permission denied",
drhff4fa772017-07-10 12:07:53 +00001439 /* SQLITE_ABORT */ "query aborted",
drh51c7d862009-04-27 18:46:06 +00001440 /* SQLITE_BUSY */ "database is locked",
1441 /* SQLITE_LOCKED */ "database table is locked",
1442 /* SQLITE_NOMEM */ "out of memory",
1443 /* SQLITE_READONLY */ "attempt to write a readonly database",
1444 /* SQLITE_INTERRUPT */ "interrupted",
1445 /* SQLITE_IOERR */ "disk I/O error",
1446 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001447 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001448 /* SQLITE_FULL */ "database or disk is full",
1449 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001450 /* SQLITE_PROTOCOL */ "locking protocol",
drhe75be1a2017-07-10 11:17:51 +00001451 /* SQLITE_EMPTY */ 0,
drh51c7d862009-04-27 18:46:06 +00001452 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001453 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001454 /* SQLITE_CONSTRAINT */ "constraint failed",
1455 /* SQLITE_MISMATCH */ "datatype mismatch",
drhff4fa772017-07-10 12:07:53 +00001456 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
drhe75be1a2017-07-10 11:17:51 +00001457#ifdef SQLITE_DISABLE_LFS
drh51c7d862009-04-27 18:46:06 +00001458 /* SQLITE_NOLFS */ "large file support is disabled",
drhe75be1a2017-07-10 11:17:51 +00001459#else
1460 /* SQLITE_NOLFS */ 0,
1461#endif
drh51c7d862009-04-27 18:46:06 +00001462 /* SQLITE_AUTH */ "authorization denied",
drhe75be1a2017-07-10 11:17:51 +00001463 /* SQLITE_FORMAT */ 0,
drhff4fa772017-07-10 12:07:53 +00001464 /* SQLITE_RANGE */ "column index out of range",
1465 /* SQLITE_NOTADB */ "file is not a database",
mistachkin2a861102018-02-08 01:00:11 +00001466 /* SQLITE_NOTICE */ "notification message",
1467 /* SQLITE_WARNING */ "warning message",
drh51c7d862009-04-27 18:46:06 +00001468 };
drh21021a52012-02-13 17:01:51 +00001469 const char *zErr = "unknown error";
1470 switch( rc ){
1471 case SQLITE_ABORT_ROLLBACK: {
1472 zErr = "abort due to ROLLBACK";
1473 break;
1474 }
mistachkin2a861102018-02-08 01:00:11 +00001475 case SQLITE_ROW: {
1476 zErr = "another row available";
1477 break;
1478 }
1479 case SQLITE_DONE: {
1480 zErr = "no more rows available";
1481 break;
1482 }
drh21021a52012-02-13 17:01:51 +00001483 default: {
1484 rc &= 0xff;
1485 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1486 zErr = aMsg[rc];
1487 }
1488 break;
1489 }
drh247be432002-05-10 05:44:55 +00001490 }
drh21021a52012-02-13 17:01:51 +00001491 return zErr;
drh247be432002-05-10 05:44:55 +00001492}
1493
1494/*
drh2dfbbca2000-07-28 14:32:48 +00001495** This routine implements a busy callback that sleeps and tries
1496** again until a timeout value is reached. The timeout value is
1497** an integer number of milliseconds passed in as the first
1498** argument.
drhf0119b22018-03-26 17:40:53 +00001499**
1500** Return non-zero to retry the lock. Return zero to stop trying
1501** and cause SQLite to return SQLITE_BUSY.
drh2dfbbca2000-07-28 14:32:48 +00001502*/
drhdaffd0e2001-04-11 14:28:42 +00001503static int sqliteDefaultBusyCallback(
drhf0119b22018-03-26 17:40:53 +00001504 void *ptr, /* Database connection */
1505 int count, /* Number of times table has been busy */
1506 sqlite3_file *pFile /* The file on which the lock occurred */
drh2dfbbca2000-07-28 14:32:48 +00001507){
drh0ede9eb2015-01-10 16:49:23 +00001508#if SQLITE_OS_WIN || HAVE_USLEEP
drhf0119b22018-03-26 17:40:53 +00001509 /* This case is for systems that have support for sleeping for fractions of
1510 ** a second. Examples: All windows systems, unix systems with usleep() */
drhee570fa2005-04-28 12:06:05 +00001511 static const u8 delays[] =
1512 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1513 static const u8 totals[] =
1514 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001515# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001516 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001517 int tmout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001518 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001519
drhf0119b22018-03-26 17:40:53 +00001520#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1521 if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1522 if( count ){
1523 tmout = 0;
1524 sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1525 return 0;
1526 }else{
1527 return 1;
1528 }
1529 }
drh5013c4b2018-03-28 21:45:03 +00001530#else
1531 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001532#endif
drhee570fa2005-04-28 12:06:05 +00001533 assert( count>=0 );
1534 if( count < NDELAY ){
1535 delay = delays[count];
1536 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001537 }else{
1538 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001539 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001540 }
drhf0119b22018-03-26 17:40:53 +00001541 if( prior + delay > tmout ){
1542 delay = tmout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001543 if( delay<=0 ) return 0;
1544 }
danielk19772a6bdf62007-08-20 16:07:00 +00001545 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001546 return 1;
1547#else
drhf0119b22018-03-26 17:40:53 +00001548 /* This case for unix systems that lack usleep() support. Sleeping
1549 ** must be done in increments of whole seconds */
drh482ea182007-08-20 11:12:40 +00001550 sqlite3 *db = (sqlite3 *)ptr;
drhf0119b22018-03-26 17:40:53 +00001551 int tmout = ((sqlite3 *)ptr)->busyTimeout;
drh5013c4b2018-03-28 21:45:03 +00001552 UNUSED_PARAMETER(pFile);
drhf0119b22018-03-26 17:40:53 +00001553 if( (count+1)*1000 > tmout ){
drh2dfbbca2000-07-28 14:32:48 +00001554 return 0;
1555 }
drh482ea182007-08-20 11:12:40 +00001556 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001557 return 1;
1558#endif
1559}
1560
1561/*
drha4afb652005-07-09 02:16:02 +00001562** Invoke the given busy handler.
1563**
drhf0119b22018-03-26 17:40:53 +00001564** This routine is called when an operation failed to acquire a
1565** lock on VFS file pFile.
1566**
drha4afb652005-07-09 02:16:02 +00001567** If this routine returns non-zero, the lock is retried. If it
1568** returns 0, the operation aborts with an SQLITE_BUSY error.
1569*/
drhf0119b22018-03-26 17:40:53 +00001570int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
drha4afb652005-07-09 02:16:02 +00001571 int rc;
drh80262892018-03-26 16:37:53 +00001572 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
drhf0119b22018-03-26 17:40:53 +00001573 if( p->bExtraFileArg ){
1574 /* Add an extra parameter with the pFile pointer to the end of the
1575 ** callback argument list */
1576 int (*xTra)(void*,int,sqlite3_file*);
1577 xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1578 rc = xTra(p->pBusyArg, p->nBusy, pFile);
1579 }else{
1580 /* Legacy style busy handler callback */
1581 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1582 }
drha4afb652005-07-09 02:16:02 +00001583 if( rc==0 ){
1584 p->nBusy = -1;
1585 }else{
1586 p->nBusy++;
1587 }
1588 return rc;
1589}
1590
1591/*
drh2dfbbca2000-07-28 14:32:48 +00001592** This routine sets the busy callback for an Sqlite database to the
1593** given callback function with the given argument.
1594*/
danielk1977f9d64d22004-06-19 08:18:07 +00001595int sqlite3_busy_handler(
1596 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001597 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001598 void *pArg
1599){
drh9ca95732014-10-24 00:35:58 +00001600#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001601 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001602#endif
drhe30f4422007-08-21 16:15:55 +00001603 sqlite3_mutex_enter(db->mutex);
drh80262892018-03-26 16:37:53 +00001604 db->busyHandler.xBusyHandler = xBusy;
1605 db->busyHandler.pBusyArg = pArg;
drha4afb652005-07-09 02:16:02 +00001606 db->busyHandler.nBusy = 0;
drhf0119b22018-03-26 17:40:53 +00001607 db->busyHandler.bExtraFileArg = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001608 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001609 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001610 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001611}
1612
danielk1977348bb5d2003-10-18 09:37:26 +00001613#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1614/*
1615** This routine sets the progress callback for an Sqlite database to the
1616** given callback function with the given argument. The progress callback will
1617** be invoked every nOps opcodes.
1618*/
danielk197724b03fd2004-05-10 10:34:34 +00001619void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001620 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001621 int nOps,
1622 int (*xProgress)(void*),
1623 void *pArg
1624){
drh9ca95732014-10-24 00:35:58 +00001625#ifdef SQLITE_ENABLE_API_ARMOR
1626 if( !sqlite3SafetyCheckOk(db) ){
1627 (void)SQLITE_MISUSE_BKPT;
1628 return;
1629 }
1630#endif
drhbd0b1b52008-07-07 19:52:09 +00001631 sqlite3_mutex_enter(db->mutex);
1632 if( nOps>0 ){
1633 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001634 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001635 db->pProgressArg = pArg;
1636 }else{
1637 db->xProgress = 0;
1638 db->nProgressOps = 0;
1639 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001640 }
drhbd0b1b52008-07-07 19:52:09 +00001641 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001642}
1643#endif
1644
1645
drh2dfbbca2000-07-28 14:32:48 +00001646/*
1647** This routine installs a default busy handler that waits for the
1648** specified number of milliseconds before returning 0.
1649*/
danielk1977f9d64d22004-06-19 08:18:07 +00001650int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001651#ifdef SQLITE_ENABLE_API_ARMOR
1652 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1653#endif
drh2dfbbca2000-07-28 14:32:48 +00001654 if( ms>0 ){
drhf0119b22018-03-26 17:40:53 +00001655 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1656 (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001657 db->busyTimeout = ms;
drhf0119b22018-03-26 17:40:53 +00001658 db->busyHandler.bExtraFileArg = 1;
drh2dfbbca2000-07-28 14:32:48 +00001659 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001660 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001661 }
danielk1977f9d64d22004-06-19 08:18:07 +00001662 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001663}
drh4c504392000-10-16 22:06:40 +00001664
1665/*
1666** Cause any pending operation to stop at its earliest opportunity.
1667*/
drh9bb575f2004-09-06 17:24:11 +00001668void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001669#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001670 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001671 (void)SQLITE_MISUSE_BKPT;
1672 return;
1673 }
1674#endif
drhbd0b1b52008-07-07 19:52:09 +00001675 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001676}
drhfa86c412002-02-02 15:01:15 +00001677
drhfa86c412002-02-02 15:01:15 +00001678
1679/*
danielk1977771151b2006-01-17 13:21:40 +00001680** This function is exactly the same as sqlite3_create_function(), except
1681** that it is designed to be called by internal code. The difference is
1682** that if a malloc() fails in sqlite3_create_function(), an error code
1683** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001684*/
danielk1977771151b2006-01-17 13:21:40 +00001685int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001686 sqlite3 *db,
1687 const char *zFunctionName,
1688 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001689 int enc,
danielk197765904932004-05-26 06:18:37 +00001690 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001691 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001692 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001693 void (*xFinal)(sqlite3_context*),
1694 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001695){
drh0bce8352002-02-28 00:41:10 +00001696 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001697 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001698 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001699
drhe30f4422007-08-21 16:15:55 +00001700 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001701 if( zFunctionName==0 ||
drh2d801512016-01-14 22:19:58 +00001702 (xSFunc && (xFinal || xStep)) ||
1703 (!xSFunc && (xFinal && !xStep)) ||
1704 (!xSFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001705 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001706 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001707 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001708 }
drh4a8ee3d2013-12-14 13:44:22 +00001709
1710 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1711 extraFlags = enc & SQLITE_DETERMINISTIC;
1712 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001713
danielk197793758c82005-01-21 08:13:14 +00001714#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001715 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1716 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1717 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1718 **
1719 ** If SQLITE_ANY is specified, add three versions of the function
1720 ** to the hash table.
1721 */
1722 if( enc==SQLITE_UTF16 ){
1723 enc = SQLITE_UTF16NATIVE;
1724 }else if( enc==SQLITE_ANY ){
1725 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001726 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
drh2d801512016-01-14 22:19:58 +00001727 pUserData, xSFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001728 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001729 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
drh2d801512016-01-14 22:19:58 +00001730 pUserData, xSFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001731 }
1732 if( rc!=SQLITE_OK ){
1733 return rc;
1734 }
danielk1977d8123362004-06-12 09:25:12 +00001735 enc = SQLITE_UTF16BE;
1736 }
danielk197793758c82005-01-21 08:13:14 +00001737#else
1738 enc = SQLITE_UTF8;
1739#endif
danielk19779636c4e2005-01-25 04:27:54 +00001740
1741 /* Check if an existing function is being overridden or deleted. If so,
1742 ** and there are active VMs, then return SQLITE_BUSY. If a function
1743 ** is being overridden/deleted but there are no active VMs, allow the
1744 ** operation to continue but invalidate all precompiled statements.
1745 */
drh80738d92016-02-15 00:34:16 +00001746 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001747 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001748 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001749 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001750 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001751 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001752 return SQLITE_BUSY;
1753 }else{
1754 sqlite3ExpirePreparedStatements(db);
1755 }
1756 }
danielk197765904932004-05-26 06:18:37 +00001757
drh80738d92016-02-15 00:34:16 +00001758 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001759 assert(p || db->mallocFailed);
1760 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001761 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001762 }
dand2199f02010-08-27 17:48:52 +00001763
1764 /* If an older version of the function with a configured destructor is
1765 ** being replaced invoke the destructor function here. */
1766 functionDestroy(db, p);
1767
1768 if( pDestructor ){
1769 pDestructor->nRef++;
1770 }
drh80738d92016-02-15 00:34:16 +00001771 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001772 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1773 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh2d801512016-01-14 22:19:58 +00001774 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001775 p->xFinalize = xFinal;
1776 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001777 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001778 return SQLITE_OK;
1779}
danielk1977771151b2006-01-17 13:21:40 +00001780
1781/*
1782** Create new user functions.
1783*/
1784int sqlite3_create_function(
1785 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001786 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001787 int nArg,
1788 int enc,
1789 void *p,
drh2d801512016-01-14 22:19:58 +00001790 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk1977771151b2006-01-17 13:21:40 +00001791 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1792 void (*xFinal)(sqlite3_context*)
1793){
drh2d801512016-01-14 22:19:58 +00001794 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xSFunc, xStep,
drh7b19fac2010-08-27 18:44:54 +00001795 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001796}
1797
1798int sqlite3_create_function_v2(
1799 sqlite3 *db,
1800 const char *zFunc,
1801 int nArg,
1802 int enc,
1803 void *p,
drh2d801512016-01-14 22:19:58 +00001804 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001805 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1806 void (*xFinal)(sqlite3_context*),
1807 void (*xDestroy)(void *)
1808){
shanehbd2aaf92010-09-01 02:38:21 +00001809 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001810 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001811
1812#ifdef SQLITE_ENABLE_API_ARMOR
1813 if( !sqlite3SafetyCheckOk(db) ){
1814 return SQLITE_MISUSE_BKPT;
1815 }
1816#endif
drhe30f4422007-08-21 16:15:55 +00001817 sqlite3_mutex_enter(db->mutex);
dand2199f02010-08-27 17:48:52 +00001818 if( xDestroy ){
drh92011842018-05-26 16:00:26 +00001819 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001820 if( !pArg ){
drh92011842018-05-26 16:00:26 +00001821 sqlite3OomFault(db);
dan9508daa2010-08-28 18:58:00 +00001822 xDestroy(p);
1823 goto out;
1824 }
drh92011842018-05-26 16:00:26 +00001825 pArg->nRef = 0;
dand2199f02010-08-27 17:48:52 +00001826 pArg->xDestroy = xDestroy;
1827 pArg->pUserData = p;
1828 }
drh2d801512016-01-14 22:19:58 +00001829 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xSFunc, xStep, xFinal, pArg);
dand2199f02010-08-27 17:48:52 +00001830 if( pArg && pArg->nRef==0 ){
1831 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001832 xDestroy(p);
drh92011842018-05-26 16:00:26 +00001833 sqlite3_free(pArg);
dand2199f02010-08-27 17:48:52 +00001834 }
1835
1836 out:
drhe30f4422007-08-21 16:15:55 +00001837 rc = sqlite3ApiExit(db, rc);
1838 sqlite3_mutex_leave(db->mutex);
1839 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001840}
1841
danielk197793758c82005-01-21 08:13:14 +00001842#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001843int sqlite3_create_function16(
1844 sqlite3 *db,
1845 const void *zFunctionName,
1846 int nArg,
1847 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001848 void *p,
drh2d801512016-01-14 22:19:58 +00001849 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001850 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1851 void (*xFinal)(sqlite3_context*)
1852){
1853 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001854 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001855
1856#ifdef SQLITE_ENABLE_API_ARMOR
1857 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1858#endif
drhe30f4422007-08-21 16:15:55 +00001859 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001860 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001861 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
drh2d801512016-01-14 22:19:58 +00001862 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001863 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001864 rc = sqlite3ApiExit(db, rc);
1865 sqlite3_mutex_leave(db->mutex);
1866 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001867}
danielk197793758c82005-01-21 08:13:14 +00001868#endif
drhc9b84a12002-06-20 11:36:48 +00001869
drhb7481e72006-09-16 21:45:14 +00001870
1871/*
drh92011842018-05-26 16:00:26 +00001872** The following is the implementation of an SQL function that always
1873** fails with an error message stating that the function is used in the
1874** wrong context. The sqlite3_overload_function() API might construct
1875** SQL function that use this routine so that the functions will exist
1876** for name resolution but are actually overloaded by the xFindFunction
1877** method of virtual tables.
1878*/
1879static void sqlite3InvalidFunction(
1880 sqlite3_context *context, /* The function calling context */
1881 int NotUsed, /* Number of arguments to the function */
1882 sqlite3_value **NotUsed2 /* Value of each argument */
1883){
1884 const char *zName = (const char*)sqlite3_user_data(context);
1885 char *zErr;
1886 UNUSED_PARAMETER2(NotUsed, NotUsed2);
1887 zErr = sqlite3_mprintf(
1888 "unable to use function %s in the requested context", zName);
1889 sqlite3_result_error(context, zErr, -1);
1890 sqlite3_free(zErr);
1891}
1892
1893/*
drhb7481e72006-09-16 21:45:14 +00001894** Declare that a function has been overloaded by a virtual table.
1895**
1896** If the function already exists as a regular global function, then
1897** this routine is a no-op. If the function does not exist, then create
1898** a new one that always throws a run-time error.
1899**
1900** When virtual tables intend to provide an overloaded function, they
1901** should call this routine to make sure the global function exists.
1902** A global function must exist in order for name resolution to work
1903** properly.
1904*/
1905int sqlite3_overload_function(
1906 sqlite3 *db,
1907 const char *zName,
1908 int nArg
1909){
drh92011842018-05-26 16:00:26 +00001910 int rc;
1911 char *zCopy;
drh9ca95732014-10-24 00:35:58 +00001912
1913#ifdef SQLITE_ENABLE_API_ARMOR
1914 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1915 return SQLITE_MISUSE_BKPT;
1916 }
1917#endif
drhe30f4422007-08-21 16:15:55 +00001918 sqlite3_mutex_enter(db->mutex);
drh92011842018-05-26 16:00:26 +00001919 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
drhe30f4422007-08-21 16:15:55 +00001920 sqlite3_mutex_leave(db->mutex);
drh92011842018-05-26 16:00:26 +00001921 if( rc ) return SQLITE_OK;
1922 zCopy = sqlite3_mprintf(zName);
1923 if( zCopy==0 ) return SQLITE_NOMEM;
1924 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
1925 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
drhb7481e72006-09-16 21:45:14 +00001926}
1927
drh19e2d372005-08-29 23:00:03 +00001928#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001929/*
drh18de4822003-01-16 16:28:53 +00001930** Register a trace function. The pArg from the previously registered trace
1931** is returned.
1932**
1933** A NULL trace function means that no tracing is executes. A non-NULL
1934** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001935** SQL statement.
drh18de4822003-01-16 16:28:53 +00001936*/
drh3d2a5292016-07-13 22:55:01 +00001937#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00001938void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001939 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001940
1941#ifdef SQLITE_ENABLE_API_ARMOR
1942 if( !sqlite3SafetyCheckOk(db) ){
1943 (void)SQLITE_MISUSE_BKPT;
1944 return 0;
1945 }
1946#endif
drhe30f4422007-08-21 16:15:55 +00001947 sqlite3_mutex_enter(db->mutex);
1948 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00001949 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00001950 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00001951 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001952 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001953 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001954}
drh3d2a5292016-07-13 22:55:01 +00001955#endif /* SQLITE_OMIT_DEPRECATED */
1956
1957/* Register a trace callback using the version-2 interface.
1958*/
1959int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00001960 sqlite3 *db, /* Trace this connection */
1961 unsigned mTrace, /* Mask of events to be traced */
1962 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
1963 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00001964){
1965#ifdef SQLITE_ENABLE_API_ARMOR
1966 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00001967 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00001968 }
1969#endif
1970 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00001971 if( mTrace==0 ) xTrace = 0;
1972 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00001973 db->mTrace = mTrace;
1974 db->xTrace = xTrace;
1975 db->pTraceArg = pArg;
1976 sqlite3_mutex_leave(db->mutex);
1977 return SQLITE_OK;
1978}
1979
drh087ec072016-07-25 00:05:56 +00001980#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00001981/*
1982** Register a profile function. The pArg from the previously registered
1983** profile function is returned.
1984**
1985** A NULL profile function means that no profiling is executes. A non-NULL
1986** profile is a pointer to a function that is invoked at the conclusion of
1987** each SQL statement that is run.
1988*/
1989void *sqlite3_profile(
1990 sqlite3 *db,
1991 void (*xProfile)(void*,const char*,sqlite_uint64),
1992 void *pArg
1993){
drhe30f4422007-08-21 16:15:55 +00001994 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001995
1996#ifdef SQLITE_ENABLE_API_ARMOR
1997 if( !sqlite3SafetyCheckOk(db) ){
1998 (void)SQLITE_MISUSE_BKPT;
1999 return 0;
2000 }
2001#endif
drhe30f4422007-08-21 16:15:55 +00002002 sqlite3_mutex_enter(db->mutex);
2003 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00002004 db->xProfile = xProfile;
2005 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002006 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00002007 return pOld;
2008}
drh087ec072016-07-25 00:05:56 +00002009#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00002010#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00002011
drhcd565fd2012-03-01 21:30:44 +00002012/*
2013** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00002014** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00002015** rollback.
2016*/
danielk197724b03fd2004-05-10 10:34:34 +00002017void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00002018 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00002019 int (*xCallback)(void*), /* Function to invoke on each commit */
2020 void *pArg /* Argument to the function */
2021){
drhe30f4422007-08-21 16:15:55 +00002022 void *pOld;
drh9ca95732014-10-24 00:35:58 +00002023
2024#ifdef SQLITE_ENABLE_API_ARMOR
2025 if( !sqlite3SafetyCheckOk(db) ){
2026 (void)SQLITE_MISUSE_BKPT;
2027 return 0;
2028 }
2029#endif
drhe30f4422007-08-21 16:15:55 +00002030 sqlite3_mutex_enter(db->mutex);
2031 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00002032 db->xCommitCallback = xCallback;
2033 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002034 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00002035 return pOld;
2036}
2037
danielk197794eb6a12005-12-15 15:22:08 +00002038/*
2039** Register a callback to be invoked each time a row is updated,
2040** inserted or deleted using this database connection.
2041*/
danielk197771fd80b2005-12-16 06:54:01 +00002042void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00002043 sqlite3 *db, /* Attach the hook to this database */
2044 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2045 void *pArg /* Argument to the function */
2046){
drhe30f4422007-08-21 16:15:55 +00002047 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002048
2049#ifdef SQLITE_ENABLE_API_ARMOR
2050 if( !sqlite3SafetyCheckOk(db) ){
2051 (void)SQLITE_MISUSE_BKPT;
2052 return 0;
2053 }
2054#endif
drhe30f4422007-08-21 16:15:55 +00002055 sqlite3_mutex_enter(db->mutex);
2056 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00002057 db->xUpdateCallback = xCallback;
2058 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002059 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002060 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00002061}
2062
danielk197771fd80b2005-12-16 06:54:01 +00002063/*
2064** Register a callback to be invoked each time a transaction is rolled
2065** back by this database connection.
2066*/
2067void *sqlite3_rollback_hook(
2068 sqlite3 *db, /* Attach the hook to this database */
2069 void (*xCallback)(void*), /* Callback function */
2070 void *pArg /* Argument to the function */
2071){
drhe30f4422007-08-21 16:15:55 +00002072 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002073
2074#ifdef SQLITE_ENABLE_API_ARMOR
2075 if( !sqlite3SafetyCheckOk(db) ){
2076 (void)SQLITE_MISUSE_BKPT;
2077 return 0;
2078 }
2079#endif
drhe30f4422007-08-21 16:15:55 +00002080 sqlite3_mutex_enter(db->mutex);
2081 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00002082 db->xRollbackCallback = xCallback;
2083 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00002084 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00002085 return pRet;
2086}
drhaa940ea2004-01-15 02:44:03 +00002087
drh9b1c62d2011-03-30 21:04:43 +00002088#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00002089/*
2090** Register a callback to be invoked each time a row is updated,
2091** inserted or deleted using this database connection.
2092*/
2093void *sqlite3_preupdate_hook(
2094 sqlite3 *db, /* Attach the hook to this database */
2095 void(*xCallback)( /* Callback function */
2096 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2097 void *pArg /* First callback argument */
2098){
2099 void *pRet;
2100 sqlite3_mutex_enter(db->mutex);
2101 pRet = db->pPreUpdateArg;
2102 db->xPreUpdateCallback = xCallback;
2103 db->pPreUpdateArg = pArg;
2104 sqlite3_mutex_leave(db->mutex);
2105 return pRet;
2106}
drh9b1c62d2011-03-30 21:04:43 +00002107#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00002108
dan586b9c82010-05-03 08:04:49 +00002109#ifndef SQLITE_OMIT_WAL
2110/*
2111** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002112** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2113** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002114** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002115*/
drhb033d8b2010-05-03 13:37:30 +00002116int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002117 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002118 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002119 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002120 int nFrame /* Size of WAL */
2121){
drh5def0842010-05-05 20:00:25 +00002122 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002123 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002124 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002125 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002126 }
2127 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002128}
drhb033d8b2010-05-03 13:37:30 +00002129#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002130
2131/*
2132** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2133** a database after committing a transaction if there are nFrame or
2134** more frames in the log file. Passing zero or a negative value as the
2135** nFrame parameter disables automatic checkpoints entirely.
2136**
2137** The callback registered by this function replaces any existing callback
2138** registered using sqlite3_wal_hook(). Likewise, registering a callback
2139** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2140** configured by this function.
2141*/
2142int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002143#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002144 UNUSED_PARAMETER(db);
2145 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002146#else
drh9ca95732014-10-24 00:35:58 +00002147#ifdef SQLITE_ENABLE_API_ARMOR
2148 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2149#endif
dan586b9c82010-05-03 08:04:49 +00002150 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002151 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002152 }else{
2153 sqlite3_wal_hook(db, 0, 0);
2154 }
drhb033d8b2010-05-03 13:37:30 +00002155#endif
dan586b9c82010-05-03 08:04:49 +00002156 return SQLITE_OK;
2157}
2158
paulb0208cc2003-04-13 18:26:49 +00002159/*
dan8d22a172010-04-19 18:03:51 +00002160** Register a callback to be invoked each time a transaction is written
2161** into the write-ahead-log by this database connection.
2162*/
drh833bf962010-04-28 14:42:19 +00002163void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002164 sqlite3 *db, /* Attach the hook to this db handle */
2165 int(*xCallback)(void *, sqlite3*, const char*, int),
2166 void *pArg /* First argument passed to xCallback() */
2167){
drhb033d8b2010-05-03 13:37:30 +00002168#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002169 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002170#ifdef SQLITE_ENABLE_API_ARMOR
2171 if( !sqlite3SafetyCheckOk(db) ){
2172 (void)SQLITE_MISUSE_BKPT;
2173 return 0;
2174 }
2175#endif
dan8d22a172010-04-19 18:03:51 +00002176 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002177 pRet = db->pWalArg;
2178 db->xWalCallback = xCallback;
2179 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002180 sqlite3_mutex_leave(db->mutex);
2181 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002182#else
2183 return 0;
2184#endif
dan8d22a172010-04-19 18:03:51 +00002185}
2186
2187/*
dancdc1f042010-11-18 12:11:05 +00002188** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002189*/
dancdc1f042010-11-18 12:11:05 +00002190int sqlite3_wal_checkpoint_v2(
2191 sqlite3 *db, /* Database handle */
2192 const char *zDb, /* Name of attached database (or NULL) */
2193 int eMode, /* SQLITE_CHECKPOINT_* value */
2194 int *pnLog, /* OUT: Size of WAL log in frames */
2195 int *pnCkpt /* OUT: Total number of frames checkpointed */
2196){
drhb033d8b2010-05-03 13:37:30 +00002197#ifdef SQLITE_OMIT_WAL
2198 return SQLITE_OK;
2199#else
dan586b9c82010-05-03 08:04:49 +00002200 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002201 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002202
drh9ca95732014-10-24 00:35:58 +00002203#ifdef SQLITE_ENABLE_API_ARMOR
2204 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2205#endif
2206
dan9c5e3682011-02-07 15:12:12 +00002207 /* Initialize the output variables to -1 in case an error occurs. */
2208 if( pnLog ) *pnLog = -1;
2209 if( pnCkpt ) *pnCkpt = -1;
2210
danf26a1542014-12-02 19:04:54 +00002211 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2212 assert( SQLITE_CHECKPOINT_FULL==1 );
2213 assert( SQLITE_CHECKPOINT_RESTART==2 );
2214 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2215 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002216 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2217 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002218 return SQLITE_MISUSE;
2219 }
2220
dan586b9c82010-05-03 08:04:49 +00002221 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002222 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002223 iDb = sqlite3FindDbName(db, zDb);
2224 }
2225 if( iDb<0 ){
2226 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002227 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002228 }else{
dan976b0032015-01-29 19:12:12 +00002229 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002230 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002231 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002232 }
drhb033d8b2010-05-03 13:37:30 +00002233 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002234
2235 /* If there are no active statements, clear the interrupt flag at this
2236 ** point. */
2237 if( db->nVdbeActive==0 ){
2238 db->u1.isInterrupted = 0;
2239 }
2240
dan586b9c82010-05-03 08:04:49 +00002241 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002242 return rc;
2243#endif
dan586b9c82010-05-03 08:04:49 +00002244}
2245
dancdc1f042010-11-18 12:11:05 +00002246
2247/*
2248** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2249** to contains a zero-length string, all attached databases are
2250** checkpointed.
2251*/
2252int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002253 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2254 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2255 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002256}
2257
drhb033d8b2010-05-03 13:37:30 +00002258#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002259/*
2260** Run a checkpoint on database iDb. This is a no-op if database iDb is
2261** not currently open in WAL mode.
2262**
dan6fcff072010-05-03 14:05:43 +00002263** If a transaction is open on the database being checkpointed, this
2264** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2265** an error occurs while running the checkpoint, an SQLite error code is
2266** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002267**
2268** The mutex on database handle db should be held by the caller. The mutex
2269** associated with the specific b-tree being checkpointed is taken by
2270** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002271**
2272** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2273** checkpointed. If an error is encountered it is returned immediately -
2274** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002275**
dan78345512017-09-08 17:48:00 +00002276** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2277** or TRUNCATE.
dan586b9c82010-05-03 08:04:49 +00002278*/
dancdc1f042010-11-18 12:11:05 +00002279int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002280 int rc = SQLITE_OK; /* Return code */
2281 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002282 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002283
2284 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002285 assert( !pnLog || *pnLog==-1 );
2286 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002287
dan6fcff072010-05-03 14:05:43 +00002288 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2289 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002290 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002291 pnLog = 0;
2292 pnCkpt = 0;
2293 if( rc==SQLITE_BUSY ){
2294 bBusy = 1;
2295 rc = SQLITE_OK;
2296 }
dan6fcff072010-05-03 14:05:43 +00002297 }
dan586b9c82010-05-03 08:04:49 +00002298 }
2299
danf2b8dd52010-11-18 19:28:01 +00002300 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002301}
drhb033d8b2010-05-03 13:37:30 +00002302#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002303
paulb0208cc2003-04-13 18:26:49 +00002304/*
danielk1977d8293352009-04-30 09:10:37 +00002305** This function returns true if main-memory should be used instead of
2306** a temporary file for transient pager files and statement journals.
2307** The value returned depends on the value of db->temp_store (runtime
2308** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2309** following table describes the relationship between these two values
2310** and this functions return value.
2311**
2312** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2313** ----------------- -------------- ------------------------------
2314** 0 any file (return 0)
2315** 1 1 file (return 0)
2316** 1 2 memory (return 1)
2317** 1 0 file (return 0)
2318** 2 1 file (return 0)
2319** 2 2 memory (return 1)
2320** 2 0 memory (return 1)
2321** 3 any memory (return 1)
2322*/
drh1c514142009-04-30 12:25:10 +00002323int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002324#if SQLITE_TEMP_STORE==1
2325 return ( db->temp_store==2 );
2326#endif
2327#if SQLITE_TEMP_STORE==2
2328 return ( db->temp_store!=1 );
2329#endif
2330#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002331 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002332 return 1;
shanecf697392009-06-01 16:53:09 +00002333#endif
2334#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002335 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002336 return 0;
shane60a4b532009-05-06 18:57:09 +00002337#endif
danielk1977d8293352009-04-30 09:10:37 +00002338}
2339
2340/*
danielk19774ad17132004-05-21 01:47:26 +00002341** Return UTF-8 encoded English language explanation of the most recent
2342** error.
2343*/
danielk19776622cce2004-05-20 11:00:52 +00002344const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002345 const char *z;
drhf49661a2008-12-10 16:45:50 +00002346 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002347 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002348 }
drhd55d57e2008-07-07 17:53:07 +00002349 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002350 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002351 }
drh27641702007-08-22 02:56:42 +00002352 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002353 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002354 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002355 }else{
drha3cc0072013-12-13 16:23:55 +00002356 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002357 z = (char*)sqlite3_value_text(db->pErr);
2358 assert( !db->mallocFailed );
2359 if( z==0 ){
2360 z = sqlite3ErrStr(db->errCode);
2361 }
danielk19776622cce2004-05-20 11:00:52 +00002362 }
drhe30f4422007-08-21 16:15:55 +00002363 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002364 return z;
danielk19776622cce2004-05-20 11:00:52 +00002365}
2366
drh6c626082004-11-14 21:56:29 +00002367#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002368/*
2369** Return UTF-16 encoded English language explanation of the most recent
2370** error.
2371*/
danielk19776622cce2004-05-20 11:00:52 +00002372const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002373 static const u16 outOfMem[] = {
2374 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002375 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002376 static const u16 misuse[] = {
drhff4fa772017-07-10 12:07:53 +00002377 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2378 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2379 'm', 'i', 's', 'u', 's', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002380 };
danielk19774ad17132004-05-21 01:47:26 +00002381
drhc60d0442004-09-30 13:43:13 +00002382 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002383 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002384 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002385 }
drhd55d57e2008-07-07 17:53:07 +00002386 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002387 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002388 }
drhe30f4422007-08-21 16:15:55 +00002389 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002390 if( db->mallocFailed ){
2391 z = (void *)outOfMem;
2392 }else{
drhc60d0442004-09-30 13:43:13 +00002393 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002394 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002395 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002396 z = sqlite3_value_text16(db->pErr);
2397 }
2398 /* A malloc() may have failed within the call to sqlite3_value_text16()
2399 ** above. If this is the case, then the db->mallocFailed flag needs to
2400 ** be cleared before returning. Do this directly, instead of via
2401 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2402 */
drh4a642b62016-02-05 01:55:27 +00002403 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002404 }
drhe30f4422007-08-21 16:15:55 +00002405 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002406 return z;
danielk19776622cce2004-05-20 11:00:52 +00002407}
drh6c626082004-11-14 21:56:29 +00002408#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002409
drhc60d0442004-09-30 13:43:13 +00002410/*
danielk19777ddad962005-12-12 06:53:03 +00002411** Return the most recent error code generated by an SQLite routine. If NULL is
2412** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002413*/
danielk19776622cce2004-05-20 11:00:52 +00002414int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002415 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002416 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002417 }
drh01495b92008-01-23 12:52:40 +00002418 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002419 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002420 }
drh4ac285a2006-09-15 07:28:50 +00002421 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002422}
drh99dfe5e2008-10-30 15:03:15 +00002423int sqlite3_extended_errcode(sqlite3 *db){
2424 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002425 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002426 }
2427 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002428 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002429 }
2430 return db->errCode;
2431}
drh1b9f2142016-03-17 16:01:23 +00002432int sqlite3_system_errno(sqlite3 *db){
2433 return db ? db->iSysErrno : 0;
2434}
danielk19776622cce2004-05-20 11:00:52 +00002435
drh0e819f92006-02-01 13:50:41 +00002436/*
mistachkin5dac8432012-09-11 02:00:25 +00002437** Return a string that describes the kind of error specified in the
2438** argument. For now, this simply calls the internal sqlite3ErrStr()
2439** function.
2440*/
2441const char *sqlite3_errstr(int rc){
2442 return sqlite3ErrStr(rc);
2443}
2444
2445/*
drh0e819f92006-02-01 13:50:41 +00002446** Create a new collating function for database "db". The name is zName
2447** and the encoding is enc.
2448*/
danielk19779a30cf62006-01-18 04:26:07 +00002449static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002450 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002451 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002452 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002453 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002454 int(*xCompare)(void*,int,const void*,int,const void*),
2455 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002456){
2457 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002458 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002459
drhe30f4422007-08-21 16:15:55 +00002460 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002461
2462 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2463 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2464 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2465 */
drh51c7d862009-04-27 18:46:06 +00002466 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002467 testcase( enc2==SQLITE_UTF16 );
2468 testcase( enc2==SQLITE_UTF16_ALIGNED );
2469 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002470 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002471 }
drh51c7d862009-04-27 18:46:06 +00002472 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002473 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002474 }
2475
2476 /* Check if this call is removing or replacing an existing collation
2477 ** sequence. If so, and there are active VMs, return busy. If there
2478 ** are no active VMs, invalidate any pre-compiled statements.
2479 */
drhc4a64fa2009-05-11 20:53:28 +00002480 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002481 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002482 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002483 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002484 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002485 return SQLITE_BUSY;
2486 }
2487 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00002488
2489 /* If collation sequence pColl was created directly by a call to
2490 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2491 ** then any copies made by synthCollSeq() need to be invalidated.
2492 ** Also, collation destructor - CollSeq.xDel() - function may need
2493 ** to be called.
2494 */
2495 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002496 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002497 int j;
2498 for(j=0; j<3; j++){
2499 CollSeq *p = &aColl[j];
2500 if( p->enc==pColl->enc ){
2501 if( p->xDel ){
2502 p->xDel(p->pUser);
2503 }
2504 p->xCmp = 0;
2505 }
2506 }
2507 }
danielk19779a30cf62006-01-18 04:26:07 +00002508 }
2509
drhc4a64fa2009-05-11 20:53:28 +00002510 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002511 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002512 pColl->xCmp = xCompare;
2513 pColl->pUser = pCtx;
2514 pColl->xDel = xDel;
2515 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002516 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002517 return SQLITE_OK;
2518}
2519
2520
danielk19776622cce2004-05-20 11:00:52 +00002521/*
drhbb4957f2008-03-20 14:03:29 +00002522** This array defines hard upper bounds on limit values. The
2523** initializer must be kept in sync with the SQLITE_LIMIT_*
2524** #defines in sqlite3.h.
2525*/
drhb1a6c3c2008-03-20 16:30:17 +00002526static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002527 SQLITE_MAX_LENGTH,
2528 SQLITE_MAX_SQL_LENGTH,
2529 SQLITE_MAX_COLUMN,
2530 SQLITE_MAX_EXPR_DEPTH,
2531 SQLITE_MAX_COMPOUND_SELECT,
2532 SQLITE_MAX_VDBE_OP,
2533 SQLITE_MAX_FUNCTION_ARG,
2534 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002535 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002536 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002537 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002538 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002539};
2540
2541/*
2542** Make sure the hard limits are set to reasonable values
2543*/
2544#if SQLITE_MAX_LENGTH<100
2545# error SQLITE_MAX_LENGTH must be at least 100
2546#endif
2547#if SQLITE_MAX_SQL_LENGTH<100
2548# error SQLITE_MAX_SQL_LENGTH must be at least 100
2549#endif
2550#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2551# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2552#endif
drhbb4957f2008-03-20 14:03:29 +00002553#if SQLITE_MAX_COMPOUND_SELECT<2
2554# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2555#endif
2556#if SQLITE_MAX_VDBE_OP<40
2557# error SQLITE_MAX_VDBE_OP must be at least 40
2558#endif
drh80738d92016-02-15 00:34:16 +00002559#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2560# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002561#endif
drhd08b2792014-07-22 15:33:31 +00002562#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2563# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002564#endif
drhbb4957f2008-03-20 14:03:29 +00002565#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2566# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2567#endif
drh70a8ca32008-08-21 18:49:27 +00002568#if SQLITE_MAX_COLUMN>32767
2569# error SQLITE_MAX_COLUMN must not exceed 32767
2570#endif
drh417168a2009-09-07 18:14:02 +00002571#if SQLITE_MAX_TRIGGER_DEPTH<1
2572# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2573#endif
drh111544c2014-08-29 16:20:47 +00002574#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2575# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2576#endif
drhbb4957f2008-03-20 14:03:29 +00002577
2578
2579/*
2580** Change the value of a limit. Report the old value.
2581** If an invalid limit index is supplied, report -1.
2582** Make no changes but still report the old value if the
2583** new limit is negative.
2584**
2585** A new lower limit does not shrink existing constructs.
2586** It merely prevents new constructs that exceed the limit
2587** from forming.
2588*/
2589int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2590 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002591
drh9ca95732014-10-24 00:35:58 +00002592#ifdef SQLITE_ENABLE_API_ARMOR
2593 if( !sqlite3SafetyCheckOk(db) ){
2594 (void)SQLITE_MISUSE_BKPT;
2595 return -1;
2596 }
2597#endif
drh4e93f5b2010-09-07 14:59:15 +00002598
2599 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2600 ** there is a hard upper bound set at compile-time by a C preprocessor
2601 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2602 ** "_MAX_".)
2603 */
2604 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2605 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2606 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2607 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2608 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2609 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2610 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2611 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2612 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2613 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2614 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2615 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002616 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2617 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002618
2619
drh521cc842008-04-15 02:36:33 +00002620 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002621 return -1;
2622 }
2623 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002624 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002625 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002626 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002627 }
2628 db->aLimit[limitId] = newLimit;
2629 }
drh4e93f5b2010-09-07 14:59:15 +00002630 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002631}
adame6c3c722009-11-03 22:34:35 +00002632#if defined(SQLITE_ENABLE_AUTO_PROFILE)
adam0cb33b62012-04-02 23:35:45 +00002633/* stderr logging */
adam2e4491d2011-06-24 20:47:06 +00002634void _sqlite_auto_profile(void *aux, const char *sql, u64 ns);
2635void _sqlite_auto_trace(void *aux, const char *sql);
2636void _sqlite_auto_profile(void *aux, const char *sql, u64 ns) {
adame6c3c722009-11-03 22:34:35 +00002637#pragma unused(aux)
2638 fprintf(stderr, "Query: %s\n Execution Time: %llu ms\n", sql, ns / 1000000);
2639}
adam2e4491d2011-06-24 20:47:06 +00002640void _sqlite_auto_trace(void *aux, const char *sql) {
2641 fprintf(stderr, "TraceSQL(%p): %s\n", aux, sql);
2642}
adam0cb33b62012-04-02 23:35:45 +00002643
2644/* syslog logging */
2645#include <asl.h>
2646static aslclient autolog_client = NULL;
2647static void _close_asl_log() {
2648 if( NULL!=autolog_client ){
2649 asl_close(autolog_client);
2650 autolog_client = NULL;
2651 }
2652}
2653static void _open_asl_log() {
2654 if( NULL==autolog_client ){
2655 autolog_client = asl_open("SQLite", NULL, 0);
2656 atexit(_close_asl_log);
2657 }
2658}
2659
2660void _sqlite_auto_profile_syslog(void *aux, const char *sql, u64 ns);
2661void _sqlite_auto_trace_syslog(void *aux, const char *sql);
2662void _sqlite_auto_profile_syslog(void *aux, const char *sql, u64 ns) {
2663#pragma unused(aux)
2664 asl_log(autolog_client, NULL, ASL_LEVEL_NOTICE, "Query: %s\n Execution Time: %llu ms\n", sql, ns / 1000000);
2665}
2666void _sqlite_auto_trace_syslog(void *aux, const char *sql) {
2667 asl_log(autolog_client, NULL, ASL_LEVEL_NOTICE, "TraceSQL(%p): %s\n", aux, sql);
2668}
adame6c3c722009-11-03 22:34:35 +00002669#endif
drhbb4957f2008-03-20 14:03:29 +00002670
2671/*
dan286ab7c2011-05-06 18:34:54 +00002672** This function is used to parse both URIs and non-URI filenames passed by the
2673** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2674** URIs specified as part of ATTACH statements.
2675**
2676** The first argument to this function is the name of the VFS to use (or
2677** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2678** query parameter. The second argument contains the URI (or non-URI filename)
2679** itself. When this function is called the *pFlags variable should contain
2680** the default flags to open the database handle with. The value stored in
2681** *pFlags may be updated before returning if the URI filename contains
2682** "cache=xxx" or "mode=xxx" query parameters.
2683**
2684** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2685** the VFS that should be used to open the database file. *pzFile is set to
2686** point to a buffer containing the name of the file to open. It is the
2687** responsibility of the caller to eventually call sqlite3_free() to release
2688** this buffer.
2689**
2690** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2691** may be set to point to a buffer containing an English language error
2692** message. It is the responsibility of the caller to eventually release
2693** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002694*/
2695int sqlite3ParseUri(
2696 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2697 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002698 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002699 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2700 char **pzFile, /* OUT: Filename component of URI */
2701 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2702){
dan78e9dd22011-05-03 10:22:32 +00002703 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002704 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002705 const char *zVfs = zDefaultVfs;
2706 char *zFile;
drhde941c32011-05-09 19:20:17 +00002707 char c;
dancd74b612011-04-22 19:37:32 +00002708 int nUri = sqlite3Strlen30(zUri);
2709
2710 assert( *pzErrMsg==0 );
2711
drh8790b6e2014-11-07 01:43:56 +00002712 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2713 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002714 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002715 ){
dan5de15372011-04-23 10:12:30 +00002716 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002717 int eState; /* Parser state when parsing URI */
2718 int iIn; /* Input character index */
2719 int iOut = 0; /* Output character index */
drhf3cdcdc2015-04-29 16:50:28 +00002720 u64 nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002721
dan286ab7c2011-05-06 18:34:54 +00002722 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2723 ** method that there may be extra parameters following the file-name. */
2724 flags |= SQLITE_OPEN_URI;
2725
2726 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002727 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002728 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002729
drh869c0402013-08-07 23:15:52 +00002730 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002731#ifdef SQLITE_ALLOW_URI_AUTHORITY
2732 if( strncmp(zUri+5, "///", 3)==0 ){
2733 iIn = 7;
2734 /* The following condition causes URIs with five leading / characters
2735 ** like file://///host/path to be converted into UNCs like //host/path.
2736 ** The correct URI for that UNC has only two or four leading / characters
2737 ** file://host/path or file:////host/path. But 5 leading slashes is a
2738 ** common error, we are told, so we handle it as a special case. */
2739 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2740 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2741 iIn = 16;
2742 }
2743#else
dancd74b612011-04-22 19:37:32 +00002744 /* Discard the scheme and authority segments of the URI. */
2745 if( zUri[5]=='/' && zUri[6]=='/' ){
2746 iIn = 7;
2747 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002748 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2749 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2750 iIn-7, &zUri[7]);
2751 rc = SQLITE_ERROR;
2752 goto parse_uri_out;
2753 }
dancd74b612011-04-22 19:37:32 +00002754 }
drh869c0402013-08-07 23:15:52 +00002755#endif
dancd74b612011-04-22 19:37:32 +00002756
2757 /* Copy the filename and any query parameters into the zFile buffer.
2758 ** Decode %HH escape codes along the way.
2759 **
2760 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2761 ** on the parsing context. As follows:
2762 **
2763 ** 0: Parsing file-name.
2764 ** 1: Parsing name section of a name=value query parameter.
2765 ** 2: Parsing value section of a name=value query parameter.
2766 */
2767 eState = 0;
drhde941c32011-05-09 19:20:17 +00002768 while( (c = zUri[iIn])!=0 && c!='#' ){
2769 iIn++;
dancd74b612011-04-22 19:37:32 +00002770 if( c=='%'
2771 && sqlite3Isxdigit(zUri[iIn])
2772 && sqlite3Isxdigit(zUri[iIn+1])
2773 ){
dan6d49e252011-05-03 15:09:05 +00002774 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2775 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002776
dan6d49e252011-05-03 15:09:05 +00002777 assert( octet>=0 && octet<256 );
2778 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002779#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002780 /* This branch is taken when "%00" appears within the URI. In this
2781 ** case we ignore all text in the remainder of the path, name or
2782 ** value currently being parsed. So ignore the current character
2783 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002784 while( (c = zUri[iIn])!=0 && c!='#'
2785 && (eState!=0 || c!='?')
2786 && (eState!=1 || (c!='=' && c!='&'))
2787 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002788 ){
2789 iIn++;
2790 }
2791 continue;
dan5c35e902016-10-26 12:15:41 +00002792#else
2793 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2794 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2795 rc = SQLITE_ERROR;
2796 goto parse_uri_out;
2797#endif
dancd74b612011-04-22 19:37:32 +00002798 }
dan6d49e252011-05-03 15:09:05 +00002799 c = octet;
dan5de15372011-04-23 10:12:30 +00002800 }else if( eState==1 && (c=='&' || c=='=') ){
2801 if( zFile[iOut-1]==0 ){
2802 /* An empty option name. Ignore this option altogether. */
2803 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2804 continue;
2805 }
2806 if( c=='&' ){
2807 zFile[iOut++] = '\0';
2808 }else{
2809 eState = 2;
2810 }
dancd74b612011-04-22 19:37:32 +00002811 c = 0;
dan5de15372011-04-23 10:12:30 +00002812 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2813 c = 0;
dancd74b612011-04-22 19:37:32 +00002814 eState = 1;
dancd74b612011-04-22 19:37:32 +00002815 }
2816 zFile[iOut++] = c;
2817 }
2818 if( eState==1 ) zFile[iOut++] = '\0';
2819 zFile[iOut++] = '\0';
2820 zFile[iOut++] = '\0';
2821
2822 /* Check if there were any options specified that should be interpreted
2823 ** here. Options that are interpreted here include "vfs" and those that
2824 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002825 ** method. */
dan5de15372011-04-23 10:12:30 +00002826 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2827 while( zOpt[0] ){
2828 int nOpt = sqlite3Strlen30(zOpt);
2829 char *zVal = &zOpt[nOpt+1];
2830 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002831
dan286ab7c2011-05-06 18:34:54 +00002832 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002833 zVfs = zVal;
2834 }else{
2835 struct OpenMode {
2836 const char *z;
2837 int mode;
2838 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002839 char *zModeType = 0;
2840 int mask = 0;
2841 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002842
dan286ab7c2011-05-06 18:34:54 +00002843 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002844 static struct OpenMode aCacheMode[] = {
2845 { "shared", SQLITE_OPEN_SHAREDCACHE },
2846 { "private", SQLITE_OPEN_PRIVATECACHE },
2847 { 0, 0 }
2848 };
2849
2850 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2851 aMode = aCacheMode;
2852 limit = mask;
2853 zModeType = "cache";
2854 }
dan286ab7c2011-05-06 18:34:54 +00002855 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002856 static struct OpenMode aOpenMode[] = {
2857 { "ro", SQLITE_OPEN_READONLY },
2858 { "rw", SQLITE_OPEN_READWRITE },
2859 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002860 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002861 { 0, 0 }
2862 };
2863
drh9c67b2a2012-05-28 13:58:00 +00002864 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2865 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002866 aMode = aOpenMode;
2867 limit = mask & flags;
2868 zModeType = "access";
2869 }
2870
2871 if( aMode ){
2872 int i;
2873 int mode = 0;
2874 for(i=0; aMode[i].z; i++){
2875 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002876 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002877 mode = aMode[i].mode;
2878 break;
dancd74b612011-04-22 19:37:32 +00002879 }
2880 }
dan78e9dd22011-05-03 10:22:32 +00002881 if( mode==0 ){
2882 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2883 rc = SQLITE_ERROR;
2884 goto parse_uri_out;
2885 }
drh9c67b2a2012-05-28 13:58:00 +00002886 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002887 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2888 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002889 rc = SQLITE_PERM;
2890 goto parse_uri_out;
2891 }
2892 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002893 }
dancd74b612011-04-22 19:37:32 +00002894 }
dan5de15372011-04-23 10:12:30 +00002895
2896 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002897 }
2898
2899 }else{
drhf3cdcdc2015-04-29 16:50:28 +00002900 zFile = sqlite3_malloc64(nUri+2);
mistachkinfad30392016-02-13 23:43:46 +00002901 if( !zFile ) return SQLITE_NOMEM_BKPT;
dan895decf2016-12-30 14:15:56 +00002902 if( nUri ){
2903 memcpy(zFile, zUri, nUri);
2904 }
dancd74b612011-04-22 19:37:32 +00002905 zFile[nUri] = '\0';
2906 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002907 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002908 }
2909
2910 *ppVfs = sqlite3_vfs_find(zVfs);
2911 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002912 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002913 rc = SQLITE_ERROR;
2914 }
2915 parse_uri_out:
2916 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002917 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002918 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002919 }
2920 *pFlags = flags;
2921 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002922 return rc;
dancd74b612011-04-22 19:37:32 +00002923}
2924
adam0cb33b62012-04-02 23:35:45 +00002925#if defined(SQLITE_ENABLE_AUTO_PROFILE)
2926#define SQLITE_AUTOLOGGING_STDERR 1
2927#define SQLITE_AUTOLOGGING_SYSLOG 2
2928static void enableAutoLogging(
2929 sqlite3 *db
2930){
2931 char *envprofile = getenv("SQLITE_AUTO_PROFILE");
2932
2933 if( envprofile!=NULL ){
2934 int where = 0;
2935 if( !strncasecmp("1", envprofile, 1) ){
dan4e76b642012-08-31 14:10:24 +00002936 if( isatty(2) ){
adam0cb33b62012-04-02 23:35:45 +00002937 where = SQLITE_AUTOLOGGING_STDERR;
2938 }else{
2939 where = SQLITE_AUTOLOGGING_SYSLOG;
2940 }
2941 } else if( !strncasecmp("stderr", envprofile, 6) ){
2942 where = SQLITE_AUTOLOGGING_STDERR;
2943 } else if( !strncasecmp("syslog", envprofile, 6) ){
2944 where = SQLITE_AUTOLOGGING_SYSLOG;
2945 }
2946 if( where==SQLITE_AUTOLOGGING_STDERR ){
2947 sqlite3_profile(db, _sqlite_auto_profile, db);
2948 }else if( where==SQLITE_AUTOLOGGING_SYSLOG ){
2949 _open_asl_log();
2950 sqlite3_profile(db, _sqlite_auto_profile_syslog, db);
2951 }
2952 }
2953 char *envtrace = getenv("SQLITE_AUTO_TRACE");
2954 if( envtrace!=NULL ){
2955 int where = 0;
2956 if( !strncasecmp("1", envtrace, 1) ){
dan4e76b642012-08-31 14:10:24 +00002957 if( isatty(2) ){
adam0cb33b62012-04-02 23:35:45 +00002958 where = SQLITE_AUTOLOGGING_STDERR;
2959 }else{
2960 where = SQLITE_AUTOLOGGING_SYSLOG;
2961 }
2962 } else if( !strncasecmp("stderr", envtrace, 6) ){
2963 where = SQLITE_AUTOLOGGING_STDERR;
2964 } else if( !strncasecmp("syslog", envtrace, 6) ){
2965 where = SQLITE_AUTOLOGGING_SYSLOG;
2966 }
2967 if( where==SQLITE_AUTOLOGGING_STDERR ){
2968 sqlite3_trace(db, _sqlite_auto_trace, db);
2969 }else if( where==SQLITE_AUTOLOGGING_SYSLOG ){
2970 _open_asl_log();
2971 sqlite3_trace(db, _sqlite_auto_trace_syslog, db);
2972 }
2973 }
2974}
2975#endif
dancd74b612011-04-22 19:37:32 +00002976
2977/*
danielk19774ad17132004-05-21 01:47:26 +00002978** This routine does the work of opening a database on behalf of
2979** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002980** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002981*/
2982static int openDatabase(
2983 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002984 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002985 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002986 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002987){
dancd74b612011-04-22 19:37:32 +00002988 sqlite3 *db; /* Store allocated handle here */
2989 int rc; /* Return code */
2990 int isThreadsafe; /* True for threadsafe connections */
2991 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2992 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002993
drh9ca95732014-10-24 00:35:58 +00002994#ifdef SQLITE_ENABLE_API_ARMOR
2995 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2996#endif
drhe0d0f8e2009-04-28 04:47:31 +00002997 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002998#ifndef SQLITE_OMIT_AUTOINIT
2999 rc = sqlite3_initialize();
3000 if( rc ) return rc;
3001#endif
3002
drh039963a2008-09-03 00:43:15 +00003003 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00003004 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00003005 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3006 isThreadsafe = 0;
3007 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3008 isThreadsafe = 1;
3009 }else{
3010 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00003011 }
dan8385bec2017-11-25 17:51:01 +00003012
drhf1f12682009-09-09 14:17:52 +00003013 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00003014 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00003015 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3016 flags |= SQLITE_OPEN_SHAREDCACHE;
3017 }
danielk19779a6284c2008-07-10 17:52:49 +00003018
drhb25a9f42009-05-12 13:35:11 +00003019 /* Remove harmful bits from the flags parameter
3020 **
3021 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3022 ** dealt with in the previous code block. Besides these, the only
3023 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00003024 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3025 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00003026 ** off all other flags.
3027 */
drha4267dc2008-02-19 15:20:44 +00003028 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00003029 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00003030 SQLITE_OPEN_MAIN_DB |
3031 SQLITE_OPEN_TEMP_DB |
3032 SQLITE_OPEN_TRANSIENT_DB |
3033 SQLITE_OPEN_MAIN_JOURNAL |
3034 SQLITE_OPEN_TEMP_JOURNAL |
3035 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00003036 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00003037 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00003038 SQLITE_OPEN_FULLMUTEX |
3039 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00003040 );
3041
danielk19774ad17132004-05-21 01:47:26 +00003042 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00003043 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00003044 if( db==0 ) goto opendb_out;
dan8385bec2017-11-25 17:51:01 +00003045 if( isThreadsafe
3046#ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3047 || sqlite3GlobalConfig.bCoreMutex
3048#endif
3049 ){
danielk197759f8c082008-06-18 17:09:10 +00003050 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3051 if( db->mutex==0 ){
3052 sqlite3_free(db);
3053 db = 0;
3054 goto opendb_out;
3055 }
dan8385bec2017-11-25 17:51:01 +00003056 if( isThreadsafe==0 ){
3057 sqlite3MutexWarnOnContention(db->mutex);
3058 }
drh605264d2007-08-21 15:13:19 +00003059 }
drh27641702007-08-22 02:56:42 +00003060 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003061 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003062 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00003063 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00003064 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00003065
drhbb4957f2008-03-20 14:03:29 +00003066 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3067 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00003068 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00003069 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00003070 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00003071 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00003072 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00003073 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00003074 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00003075#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00003076 | SQLITE_AutoIndex
3077#endif
adam2e4491d2011-06-24 20:47:06 +00003078#if SQLITE_DEFAULT_CKPTFULLFSYNC
3079 | SQLITE_CkptFullFSync
3080#endif
drh76fe8032006-07-11 14:17:51 +00003081#if SQLITE_DEFAULT_FILE_FORMAT<4
3082 | SQLITE_LegacyFileFmt
3083#endif
drh56424db2007-03-27 22:24:11 +00003084#ifdef SQLITE_ENABLE_LOAD_EXTENSION
3085 | SQLITE_LoadExtension
3086#endif
dan5bde73c2009-09-01 17:11:07 +00003087#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00003088 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00003089#endif
drha4bfd7f2010-12-09 19:15:17 +00003090#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3091 | SQLITE_ForeignKeys
3092#endif
drhf5471922014-12-09 15:12:11 +00003093#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3094 | SQLITE_ReverseOrder
3095#endif
drh1421d982015-05-27 03:46:18 +00003096#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3097 | SQLITE_CellSizeCk
3098#endif
drhd42908f2016-02-26 15:38:24 +00003099#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3100 | SQLITE_Fts3Tokenizer
3101#endif
drh169dd922017-06-26 13:57:49 +00003102#if defined(SQLITE_ENABLE_QPSG)
3103 | SQLITE_EnableQPSG
3104#endif
drh76fe8032006-07-11 14:17:51 +00003105 ;
drhe61922a2009-05-02 13:29:37 +00003106 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00003107#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00003108 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00003109#endif
danielk1977da184232006-01-05 11:34:32 +00003110
danielk19770202b292004-06-09 09:55:16 +00003111 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3112 ** and UTF-16, so add a version for each to avoid any unnecessary
3113 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00003114 **
3115 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3116 ** functions:
danielk19770202b292004-06-09 09:55:16 +00003117 */
drhf19aa5f2015-12-30 16:51:20 +00003118 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3119 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3120 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00003121 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00003122 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00003123 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00003124 goto opendb_out;
3125 }
drh5e3b49b2014-11-20 19:22:26 +00003126 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3127 ** strings is BINARY.
3128 */
drhf19aa5f2015-12-30 16:51:20 +00003129 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
drh77db4c02008-03-18 13:01:38 +00003130 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00003131
drhff4fa772017-07-10 12:07:53 +00003132 /* Parse the filename/URI argument
3133 **
3134 ** Only allow sensible combinations of bits in the flags argument.
3135 ** Throw an error if any non-sense combination is used. If we
3136 ** do not block illegal combinations here, it could trigger
3137 ** assert() statements in deeper layers. Sensible combinations
3138 ** are:
3139 **
3140 ** 1: SQLITE_OPEN_READONLY
3141 ** 2: SQLITE_OPEN_READWRITE
3142 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3143 */
drh33f4e022007-09-03 15:19:34 +00003144 db->openFlags = flags;
drhff4fa772017-07-10 12:07:53 +00003145 assert( SQLITE_OPEN_READONLY == 0x01 );
3146 assert( SQLITE_OPEN_READWRITE == 0x02 );
3147 assert( SQLITE_OPEN_CREATE == 0x04 );
3148 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3149 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3150 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3151 if( ((1<<(flags&7)) & 0x46)==0 ){
3152 rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
3153 }else{
3154 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3155 }
dancd74b612011-04-22 19:37:32 +00003156 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00003157 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00003158 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00003159 sqlite3_free(zErrMsg);
3160 goto opendb_out;
3161 }
3162
danielk19774ad17132004-05-21 01:47:26 +00003163 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00003164 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00003165 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00003166 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00003167 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00003168 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00003169 }
drh13f40da2014-08-22 18:00:11 +00003170 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00003171 goto opendb_out;
3172 }
dan0235a032014-12-08 20:20:16 +00003173 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003174 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00003175 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00003176 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00003177 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00003178
drhe872d512016-02-22 13:23:16 +00003179 /* The default safety_level for the main database is FULL; for the temp
3180 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00003181 */
drh69c33822016-08-18 14:33:11 +00003182 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00003183 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00003184 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00003185 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00003186
danielk1977832a58a2007-06-22 15:21:15 +00003187 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00003188 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00003189 goto opendb_out;
3190 }
3191
danielk19778e227872004-06-07 07:52:17 +00003192 /* Register all built-in functions, but do not attempt to read the
3193 ** database schema yet. This is delayed until the first time the database
3194 ** is accessed.
3195 */
drh13f40da2014-08-22 18:00:11 +00003196 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00003197 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00003198 rc = sqlite3_errcode(db);
3199
3200#ifdef SQLITE_ENABLE_FTS5
3201 /* Register any built-in FTS5 module before loading the automatic
3202 ** extensions. This allows automatic extensions to register FTS5
3203 ** tokenizers and auxiliary functions. */
3204 if( !db->mallocFailed && rc==SQLITE_OK ){
3205 rc = sqlite3Fts5Init(db);
3206 }
3207#endif
danielk19774ad17132004-05-21 01:47:26 +00003208
drh1409be62006-08-23 20:07:20 +00003209 /* Load automatic extensions - extensions that have been registered
3210 ** using the sqlite3_automatic_extension() API.
3211 */
drhe5077c12011-12-13 04:08:36 +00003212 if( rc==SQLITE_OK ){
3213 sqlite3AutoLoadExtensions(db);
3214 rc = sqlite3_errcode(db);
3215 if( rc!=SQLITE_OK ){
3216 goto opendb_out;
3217 }
danielk1977832a58a2007-06-22 15:21:15 +00003218 }
drh1409be62006-08-23 20:07:20 +00003219
drhaa29c132006-09-02 13:58:06 +00003220#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00003221 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003222 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003223 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003224 }
3225#endif
3226
shessa26cf572006-10-19 20:27:58 +00003227#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003228 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003229 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003230 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003231 }
3232#endif
3233
drh50065652015-10-08 19:29:18 +00003234#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003235 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003236 rc = sqlite3Fts3Init(db);
3237 }
3238#endif
3239
dan21540ae2017-12-08 16:23:38 +00003240#if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
drh17435752007-08-16 04:30:38 +00003241 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003242 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003243 }
3244#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003245
3246#ifdef SQLITE_ENABLE_RTREE
3247 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003248 rc = sqlite3RtreeInit(db);
3249 }
3250#endif
3251
drha43c8c82017-10-11 13:48:11 +00003252#ifdef SQLITE_ENABLE_DBPAGE_VTAB
3253 if( !db->mallocFailed && rc==SQLITE_OK){
3254 rc = sqlite3DbpageRegister(db);
3255 }
3256#endif
3257
drha3ab9d02015-05-04 20:25:05 +00003258#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3259 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003260 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003261 }
3262#endif
3263
drh2f20e132015-09-26 17:44:59 +00003264#ifdef SQLITE_ENABLE_JSON1
3265 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003266 rc = sqlite3Json1Init(db);
3267 }
3268#endif
3269
drhc6603af2017-06-29 14:33:51 +00003270#ifdef SQLITE_ENABLE_STMTVTAB
drhf00f5302017-06-28 15:47:29 +00003271 if( !db->mallocFailed && rc==SQLITE_OK){
drhc6603af2017-06-29 14:33:51 +00003272 rc = sqlite3StmtVtabInit(db);
drhf00f5302017-06-28 15:47:29 +00003273 }
3274#endif
3275
drh8fd5bd32007-04-02 16:40:37 +00003276 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3277 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3278 ** mode. Doing nothing at all also makes NORMAL the default.
3279 */
3280#ifdef SQLITE_DEFAULT_LOCKING_MODE
3281 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3282 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3283 SQLITE_DEFAULT_LOCKING_MODE);
3284#endif
3285
drh13f40da2014-08-22 18:00:11 +00003286 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003287
drh633e6d52008-07-28 19:34:53 +00003288 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00003289 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3290 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00003291
dan5a299f92010-05-03 11:05:08 +00003292 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003293
danielk19774ad17132004-05-21 01:47:26 +00003294opendb_out:
drhafc91042008-02-21 02:09:45 +00003295 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003296 assert( db->mutex!=0 || isThreadsafe==0
3297 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003298 sqlite3_mutex_leave(db->mutex);
3299 }
danielk197759633ae2008-08-27 19:01:57 +00003300 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003301 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003302 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003303 sqlite3_close(db);
3304 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003305 }else if( rc!=SQLITE_OK ){
3306 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003307 }
adam0cb33b62012-04-02 23:35:45 +00003308#if defined(__APPLE__) && ENABLE_FORCE_WAL
3309 if( db && !rc ){
3310 if ((0 == access("/var/db/enableForceWAL", R_OK))) {
3311#ifdef SQLITE_DEBUG
3312 fprintf(stderr, "SQLite WAL journal_mode ENABLED by default.\n");
3313#endif
3314
3315 sqlite3_exec(db, "pragma journal_mode=wal", NULL, NULL, NULL);
3316#ifdef SQLITE_DEBUG
3317// } else {
3318// fprintf(stderr, "SQLite WAL journal_mode NOT ENABLED by default.\n");
3319#endif
3320 }
3321 }
3322#endif
adame6c3c722009-11-03 22:34:35 +00003323#if defined(SQLITE_ENABLE_AUTO_PROFILE)
3324 if( db && !rc ){
adam0cb33b62012-04-02 23:35:45 +00003325 enableAutoLogging(db);
adame6c3c722009-11-03 22:34:35 +00003326 }
3327#endif
danielk19774ad17132004-05-21 01:47:26 +00003328 *ppDb = db;
adame6c3c722009-11-03 22:34:35 +00003329#ifdef SQLITE_ENABLE_SQLRR
3330 SRRecOpen(db, zFilename, flags);
3331#endif
danac455932012-11-26 19:50:41 +00003332#ifdef SQLITE_ENABLE_SQLLOG
3333 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003334 /* Opening a db handle. Fourth parameter is passed 0. */
3335 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3336 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003337 }
3338#endif
drh46e6ea02015-10-26 14:41:35 +00003339#if defined(SQLITE_HAS_CODEC)
3340 if( rc==SQLITE_OK ){
drhad012d02017-05-03 15:54:53 +00003341 const char *zKey;
drh44bdc922017-05-23 01:30:26 +00003342 if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){
drh46e6ea02015-10-26 14:41:35 +00003343 u8 iByte;
3344 int i;
drhad012d02017-05-03 15:54:53 +00003345 char zDecoded[40];
3346 for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
3347 iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
3348 if( (i&1)!=0 ) zDecoded[i/2] = iByte;
drh46e6ea02015-10-26 14:41:35 +00003349 }
drhad012d02017-05-03 15:54:53 +00003350 sqlite3_key_v2(db, 0, zDecoded, i/2);
3351 }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){
3352 sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey));
drh46e6ea02015-10-26 14:41:35 +00003353 }
3354 }
3355#endif
drh095fb472016-01-16 03:16:19 +00003356 sqlite3_free(zOpen);
drh597d2b62015-06-30 03:13:47 +00003357 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003358}
3359
3360/*
3361** Open a new database handle.
3362*/
danielk197780290862004-05-22 09:21:21 +00003363int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003364 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003365 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003366){
drh605264d2007-08-21 15:13:19 +00003367 return openDatabase(zFilename, ppDb,
3368 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3369}
3370int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003371 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003372 sqlite3 **ppDb, /* OUT: SQLite db handle */
3373 int flags, /* Flags */
3374 const char *zVfs /* Name of VFS module to use */
3375){
drh522c26f2011-05-07 14:40:29 +00003376 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003377}
3378
drh6c626082004-11-14 21:56:29 +00003379#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003380/*
3381** Open a new database handle.
3382*/
3383int sqlite3_open16(
3384 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003385 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003386){
danielk1977bfd6cce2004-06-18 04:24:54 +00003387 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003388 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003389 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003390
drh9ca95732014-10-24 00:35:58 +00003391#ifdef SQLITE_ENABLE_API_ARMOR
3392 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3393#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003394 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003395#ifndef SQLITE_OMIT_AUTOINIT
3396 rc = sqlite3_initialize();
3397 if( rc ) return rc;
3398#endif
drh9ca95732014-10-24 00:35:58 +00003399 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003400 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003401 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3402 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003403 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003404 rc = openDatabase(zFilename8, ppDb,
3405 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003406 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003407 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003408 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003409 }
drh40257ff2008-06-13 18:24:27 +00003410 }else{
mistachkinfad30392016-02-13 23:43:46 +00003411 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003412 }
danielk19777ddad962005-12-12 06:53:03 +00003413 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003414
drh597d2b62015-06-30 03:13:47 +00003415 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003416}
drh6c626082004-11-14 21:56:29 +00003417#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003418
danielk1977106bb232004-05-21 10:08:53 +00003419/*
danielk1977d8123362004-06-12 09:25:12 +00003420** Register a new collation sequence with the database handle db.
3421*/
danielk19770202b292004-06-09 09:55:16 +00003422int sqlite3_create_collation(
3423 sqlite3* db,
3424 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003425 int enc,
danielk19770202b292004-06-09 09:55:16 +00003426 void* pCtx,
3427 int(*xCompare)(void*,int,const void*,int,const void*)
3428){
drh4f81bbb2014-10-23 01:01:26 +00003429 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003430}
3431
3432/*
3433** Register a new collation sequence with the database handle db.
3434*/
danielk1977a393c032007-05-07 14:58:53 +00003435int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003436 sqlite3* db,
3437 const char *zName,
3438 int enc,
3439 void* pCtx,
3440 int(*xCompare)(void*,int,const void*,int,const void*),
3441 void(*xDel)(void*)
3442){
3443 int rc;
drh9ca95732014-10-24 00:35:58 +00003444
3445#ifdef SQLITE_ENABLE_API_ARMOR
3446 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3447#endif
drhe30f4422007-08-21 16:15:55 +00003448 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003449 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003450 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003451 rc = sqlite3ApiExit(db, rc);
3452 sqlite3_mutex_leave(db->mutex);
3453 return rc;
danielk19770202b292004-06-09 09:55:16 +00003454}
3455
drh6c626082004-11-14 21:56:29 +00003456#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003457/*
3458** Register a new collation sequence with the database handle db.
3459*/
danielk19770202b292004-06-09 09:55:16 +00003460int sqlite3_create_collation16(
3461 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003462 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003463 int enc,
danielk19770202b292004-06-09 09:55:16 +00003464 void* pCtx,
3465 int(*xCompare)(void*,int,const void*,int,const void*)
3466){
danielk19779a30cf62006-01-18 04:26:07 +00003467 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003468 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003469
3470#ifdef SQLITE_ENABLE_API_ARMOR
3471 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3472#endif
drhe30f4422007-08-21 16:15:55 +00003473 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003474 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003475 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003476 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003477 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003478 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003479 }
drhe30f4422007-08-21 16:15:55 +00003480 rc = sqlite3ApiExit(db, rc);
3481 sqlite3_mutex_leave(db->mutex);
3482 return rc;
danielk19770202b292004-06-09 09:55:16 +00003483}
drh6c626082004-11-14 21:56:29 +00003484#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003485
danielk1977d8123362004-06-12 09:25:12 +00003486/*
3487** Register a collation sequence factory callback with the database handle
3488** db. Replace any previously installed collation sequence factory.
3489*/
danielk19777cedc8d2004-06-10 10:50:08 +00003490int sqlite3_collation_needed(
3491 sqlite3 *db,
3492 void *pCollNeededArg,
3493 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3494){
drh9ca95732014-10-24 00:35:58 +00003495#ifdef SQLITE_ENABLE_API_ARMOR
3496 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3497#endif
drhe30f4422007-08-21 16:15:55 +00003498 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003499 db->xCollNeeded = xCollNeeded;
3500 db->xCollNeeded16 = 0;
3501 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003502 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003503 return SQLITE_OK;
3504}
danielk1977d8123362004-06-12 09:25:12 +00003505
drh6c626082004-11-14 21:56:29 +00003506#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003507/*
3508** Register a collation sequence factory callback with the database handle
3509** db. Replace any previously installed collation sequence factory.
3510*/
danielk19777cedc8d2004-06-10 10:50:08 +00003511int sqlite3_collation_needed16(
3512 sqlite3 *db,
3513 void *pCollNeededArg,
3514 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3515){
drh9ca95732014-10-24 00:35:58 +00003516#ifdef SQLITE_ENABLE_API_ARMOR
3517 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3518#endif
drhe30f4422007-08-21 16:15:55 +00003519 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003520 db->xCollNeeded = 0;
3521 db->xCollNeeded16 = xCollNeeded16;
3522 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003523 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003524 return SQLITE_OK;
3525}
drh6c626082004-11-14 21:56:29 +00003526#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003527
shaneeec556d2008-10-12 00:27:53 +00003528#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003529/*
danielk19777ddad962005-12-12 06:53:03 +00003530** This function is now an anachronism. It used to be used to recover from a
3531** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003532*/
drh7d97efb2007-10-12 19:35:48 +00003533int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003534 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003535}
3536#endif
drh3e1d8e62005-05-26 16:23:34 +00003537
3538/*
3539** Test to see whether or not the database connection is in autocommit
3540** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3541** by default. Autocommit is disabled by a BEGIN statement and reenabled
3542** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003543*/
3544int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003545#ifdef SQLITE_ENABLE_API_ARMOR
3546 if( !sqlite3SafetyCheckOk(db) ){
3547 (void)SQLITE_MISUSE_BKPT;
3548 return 0;
3549 }
3550#endif
drh3e1d8e62005-05-26 16:23:34 +00003551 return db->autoCommit;
3552}
drh49285702005-09-17 15:20:26 +00003553
drh49285702005-09-17 15:20:26 +00003554/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003555** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003556** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003557** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003558**
3559** 1. Serve as a convenient place to set a breakpoint in a debugger
3560** to detect when version error conditions occurs.
3561**
3562** 2. Invoke sqlite3_log() to provide the source code location where
3563** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003564*/
daneebf2f52017-11-18 17:30:08 +00003565int sqlite3ReportError(int iErr, int lineno, const char *zType){
drh32c49902016-02-15 18:15:15 +00003566 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3567 zType, lineno, 20+sqlite3_sourceid());
3568 return iErr;
3569}
drh9978c972010-02-23 17:36:32 +00003570int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003571 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003572 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003573}
drh9978c972010-02-23 17:36:32 +00003574int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003575 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003576 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003577}
3578int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003579 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003580 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003581}
drh32c49902016-02-15 18:15:15 +00003582#ifdef SQLITE_DEBUG
drhcc97ca42017-06-07 22:32:59 +00003583int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3584 char zMsg[100];
3585 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3586 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003587 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
drhcc97ca42017-06-07 22:32:59 +00003588}
mistachkinfad30392016-02-13 23:43:46 +00003589int sqlite3NomemError(int lineno){
3590 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003591 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003592}
3593int sqlite3IoerrnomemError(int lineno){
3594 testcase( sqlite3GlobalConfig.xLog!=0 );
daneebf2f52017-11-18 17:30:08 +00003595 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003596}
drh32c49902016-02-15 18:15:15 +00003597#endif
drh7c1817e2006-01-10 13:58:48 +00003598
shaneeec556d2008-10-12 00:27:53 +00003599#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003600/*
3601** This is a convenience routine that makes sure that all thread-specific
3602** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003603**
3604** SQLite no longer uses thread-specific data so this routine is now a
3605** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003606*/
3607void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003608}
shaneeec556d2008-10-12 00:27:53 +00003609#endif
danielk1977deb802c2006-02-09 13:43:28 +00003610
3611/*
3612** Return meta information about a specific column of a database table.
3613** See comment in sqlite3.h (sqlite.h.in) for details.
3614*/
danielk1977deb802c2006-02-09 13:43:28 +00003615int sqlite3_table_column_metadata(
3616 sqlite3 *db, /* Connection handle */
3617 const char *zDbName, /* Database name or NULL */
3618 const char *zTableName, /* Table name */
3619 const char *zColumnName, /* Column name */
3620 char const **pzDataType, /* OUTPUT: Declared data type */
3621 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3622 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3623 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003624 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003625){
3626 int rc;
3627 char *zErrMsg = 0;
3628 Table *pTab = 0;
3629 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003630 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003631 char const *zDataType = 0;
3632 char const *zCollSeq = 0;
3633 int notnull = 0;
3634 int primarykey = 0;
3635 int autoinc = 0;
3636
drh96c707a2015-02-13 16:36:14 +00003637
3638#ifdef SQLITE_ENABLE_API_ARMOR
3639 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3640 return SQLITE_MISUSE_BKPT;
3641 }
3642#endif
3643
danielk1977deb802c2006-02-09 13:43:28 +00003644 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003645 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003646 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003647 rc = sqlite3Init(db, &zErrMsg);
3648 if( SQLITE_OK!=rc ){
3649 goto error_out;
3650 }
3651
3652 /* Locate the table in question */
3653 pTab = sqlite3FindTable(db, zTableName, zDbName);
3654 if( !pTab || pTab->pSelect ){
3655 pTab = 0;
3656 goto error_out;
3657 }
3658
3659 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003660 if( zColumnName==0 ){
3661 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003662 }else{
3663 for(iCol=0; iCol<pTab->nCol; iCol++){
3664 pCol = &pTab->aCol[iCol];
3665 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3666 break;
3667 }
3668 }
3669 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003670 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3671 iCol = pTab->iPKey;
3672 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3673 }else{
3674 pTab = 0;
3675 goto error_out;
3676 }
danielk1977deb802c2006-02-09 13:43:28 +00003677 }
3678 }
3679
3680 /* The following block stores the meta information that will be returned
3681 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3682 ** and autoinc. At this point there are two possibilities:
3683 **
3684 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3685 ** and there is no explicitly declared IPK column.
3686 **
3687 ** 2. The table is not a view and the column name identified an
3688 ** explicitly declared column. Copy meta information from *pCol.
3689 */
3690 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003691 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003692 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003693 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003694 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003695 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003696 }else{
3697 zDataType = "INTEGER";
3698 primarykey = 1;
3699 }
3700 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003701 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003702 }
3703
3704error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003705 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003706
3707 /* Whether the function call succeeded or failed, set the output parameters
3708 ** to whatever their local counterparts contain. If an error did occur,
3709 ** this has the effect of zeroing all output parameters.
3710 */
3711 if( pzDataType ) *pzDataType = zDataType;
3712 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3713 if( pNotNull ) *pNotNull = notnull;
3714 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3715 if( pAutoinc ) *pAutoinc = autoinc;
3716
3717 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003718 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003719 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003720 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003721 rc = SQLITE_ERROR;
3722 }
drh13f40da2014-08-22 18:00:11 +00003723 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003724 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003725 rc = sqlite3ApiExit(db, rc);
3726 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003727 return rc;
3728}
3729
3730/*
3731** Sleep for a little while. Return the amount of time slept.
3732*/
3733int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003734 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003735 int rc;
drhd677b3d2007-08-20 22:48:41 +00003736 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003737 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003738
3739 /* This function works in milliseconds, but the underlying OsSleep()
3740 ** API uses microseconds. Hence the 1000's.
3741 */
drhe30f4422007-08-21 16:15:55 +00003742 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003743 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003744}
drh4ac285a2006-09-15 07:28:50 +00003745
3746/*
3747** Enable or disable the extended result codes.
3748*/
3749int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003750#ifdef SQLITE_ENABLE_API_ARMOR
3751 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3752#endif
drhe30f4422007-08-21 16:15:55 +00003753 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003754 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003755 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003756 return SQLITE_OK;
3757}
drhcc6bb3e2007-08-31 16:11:35 +00003758
3759/*
3760** Invoke the xFileControl method on a particular database.
3761*/
3762int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3763 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003764 Btree *pBtree;
3765
drh9ca95732014-10-24 00:35:58 +00003766#ifdef SQLITE_ENABLE_API_ARMOR
3767 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3768#endif
drhcc6bb3e2007-08-31 16:11:35 +00003769 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003770 pBtree = sqlite3DbNameToBtree(db, zDbName);
3771 if( pBtree ){
3772 Pager *pPager;
3773 sqlite3_file *fd;
3774 sqlite3BtreeEnter(pBtree);
3775 pPager = sqlite3BtreePager(pBtree);
3776 assert( pPager!=0 );
3777 fd = sqlite3PagerFile(pPager);
3778 assert( fd!=0 );
3779 if( op==SQLITE_FCNTL_FILE_POINTER ){
3780 *(sqlite3_file**)pArg = fd;
3781 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003782 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3783 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3784 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003785 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3786 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3787 rc = SQLITE_OK;
adam02d24932012-05-09 22:36:25 +00003788#ifndef SQLITE_OMIT_WAL
adam8a1c4682012-05-16 22:08:18 +00003789 if( (rc==SQLITE_OK)&&(op==SQLITE_FCNTL_LAST_ERRNO)&&(*(int *)pArg==0) ){
adam02d24932012-05-09 22:36:25 +00003790 sqlite3_file *pWalFd = sqlite3PagerWalFile(pPager);
3791 if( pWalFd&&(pWalFd->pMethods) ){
3792 rc = sqlite3OsFileControl(pWalFd, op, pArg);
3793 }
3794 }
3795#endif
drh421377e2012-03-15 21:28:54 +00003796 }else{
drhafb39a42018-03-29 13:47:01 +00003797 rc = sqlite3OsFileControl(fd, op, pArg);
drhcc6bb3e2007-08-31 16:11:35 +00003798 }
drh421377e2012-03-15 21:28:54 +00003799 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003800 }
drhedb58662014-08-26 02:02:40 +00003801 sqlite3Error(db, rc);
drhcc6bb3e2007-08-31 16:11:35 +00003802 sqlite3_mutex_leave(db->mutex);
adam8a1c4682012-05-16 22:08:18 +00003803 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003804}
drhed13d982008-01-31 14:43:24 +00003805
3806/*
3807** Interface to the testing logic.
3808*/
3809int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003810 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003811#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003812 UNUSED_PARAMETER(op);
3813#else
drh2fa18682008-03-19 14:15:34 +00003814 va_list ap;
drhed13d982008-01-31 14:43:24 +00003815 va_start(ap, op);
3816 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003817
3818 /*
drh984bfaa2008-03-19 16:08:53 +00003819 ** Save the current state of the PRNG.
3820 */
drh2fa18682008-03-19 14:15:34 +00003821 case SQLITE_TESTCTRL_PRNG_SAVE: {
3822 sqlite3PrngSaveState();
3823 break;
3824 }
drh984bfaa2008-03-19 16:08:53 +00003825
3826 /*
3827 ** Restore the state of the PRNG to the last state saved using
3828 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3829 ** this verb acts like PRNG_RESET.
3830 */
drh2fa18682008-03-19 14:15:34 +00003831 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3832 sqlite3PrngRestoreState();
3833 break;
3834 }
drh984bfaa2008-03-19 16:08:53 +00003835
3836 /*
3837 ** Reset the PRNG back to its uninitialized state. The next call
3838 ** to sqlite3_randomness() will reseed the PRNG using a single call
3839 ** to the xRandomness method of the default VFS.
3840 */
drh2fa18682008-03-19 14:15:34 +00003841 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003842 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003843 break;
3844 }
drh3088d592008-03-21 16:45:47 +00003845
3846 /*
3847 ** sqlite3_test_control(BITVEC_TEST, size, program)
3848 **
3849 ** Run a test against a Bitvec object of size. The program argument
3850 ** is an array of integers that defines the test. Return -1 on a
3851 ** memory allocation error, 0 on success, or non-zero for an error.
3852 ** See the sqlite3BitvecBuiltinTest() for additional information.
3853 */
3854 case SQLITE_TESTCTRL_BITVEC_TEST: {
3855 int sz = va_arg(ap, int);
3856 int *aProg = va_arg(ap, int*);
3857 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3858 break;
3859 }
danielk19772d1d86f2008-06-20 14:59:51 +00003860
3861 /*
drhc007f612014-05-16 14:17:01 +00003862 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3863 **
3864 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3865 ** if xCallback is not NULL.
3866 **
3867 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3868 ** is called immediately after installing the new callback and the return
3869 ** value from sqlite3FaultSim(0) becomes the return from
3870 ** sqlite3_test_control().
3871 */
3872 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003873 /* MSVC is picky about pulling func ptrs from va lists.
3874 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003875 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003876 */
3877 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003878 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003879 rc = sqlite3FaultSim(0);
3880 break;
3881 }
3882
3883 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003884 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3885 **
3886 ** Register hooks to call to indicate which malloc() failures
3887 ** are benign.
3888 */
3889 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003890 typedef void (*void_function)(void);
3891 void_function xBenignBegin;
3892 void_function xBenignEnd;
3893 xBenignBegin = va_arg(ap, void_function);
3894 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003895 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3896 break;
3897 }
drhc7a3bb92009-02-05 16:31:45 +00003898
3899 /*
drhf3af63f2009-05-09 18:59:42 +00003900 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003901 **
3902 ** Set the PENDING byte to the value in the argument, if X>0.
3903 ** Make no changes if X==0. Return the value of the pending byte
3904 ** as it existing before this routine was called.
3905 **
3906 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3907 ** an incompatible database file format. Changing the PENDING byte
3908 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003909 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003910 */
3911 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003912 rc = PENDING_BYTE;
3913#ifndef SQLITE_OMIT_WSD
3914 {
3915 unsigned int newVal = va_arg(ap, unsigned int);
3916 if( newVal ) sqlite3PendingByte = newVal;
3917 }
3918#endif
drhc7a3bb92009-02-05 16:31:45 +00003919 break;
3920 }
drhf3af63f2009-05-09 18:59:42 +00003921
3922 /*
3923 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3924 **
3925 ** This action provides a run-time test to see whether or not
3926 ** assert() was enabled at compile-time. If X is true and assert()
3927 ** is enabled, then the return value is true. If X is true and
3928 ** assert() is disabled, then the return value is zero. If X is
3929 ** false and assert() is enabled, then the assertion fires and the
3930 ** process aborts. If X is false and assert() is disabled, then the
3931 ** return value is zero.
3932 */
3933 case SQLITE_TESTCTRL_ASSERT: {
3934 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003935 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003936 rc = x;
3937 break;
3938 }
3939
3940
3941 /*
3942 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3943 **
3944 ** This action provides a run-time test to see how the ALWAYS and
3945 ** NEVER macros were defined at compile-time.
3946 **
drhce2c4822017-10-03 17:17:34 +00003947 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
drhf3af63f2009-05-09 18:59:42 +00003948 **
3949 ** The recommended test is X==2. If the return value is 2, that means
3950 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3951 ** default setting. If the return value is 1, then ALWAYS() is either
3952 ** hard-coded to true or else it asserts if its argument is false.
3953 ** The first behavior (hard-coded to true) is the case if
3954 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3955 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3956 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3957 **
3958 ** The run-time test procedure might look something like this:
3959 **
3960 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3961 ** // ALWAYS() and NEVER() are no-op pass-through macros
3962 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3963 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3964 ** }else{
3965 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3966 ** }
3967 */
3968 case SQLITE_TESTCTRL_ALWAYS: {
3969 int x = va_arg(ap,int);
drhce2c4822017-10-03 17:17:34 +00003970 rc = x ? ALWAYS(x) : 0;
drhf3af63f2009-05-09 18:59:42 +00003971 break;
3972 }
drhc046e3e2009-07-15 11:26:44 +00003973
drh2cf4acb2014-04-18 00:06:02 +00003974 /*
3975 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3976 **
3977 ** The integer returned reveals the byte-order of the computer on which
3978 ** SQLite is running:
3979 **
3980 ** 1 big-endian, determined at run-time
3981 ** 10 little-endian, determined at run-time
3982 ** 432101 big-endian, determined at compile-time
3983 ** 123410 little-endian, determined at compile-time
3984 */
3985 case SQLITE_TESTCTRL_BYTEORDER: {
3986 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3987 break;
3988 }
3989
drhc046e3e2009-07-15 11:26:44 +00003990 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3991 **
3992 ** Set the nReserve size to N for the main database on the database
3993 ** connection db.
3994 */
3995 case SQLITE_TESTCTRL_RESERVE: {
3996 sqlite3 *db = va_arg(ap, sqlite3*);
3997 int x = va_arg(ap,int);
3998 sqlite3_mutex_enter(db->mutex);
3999 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
4000 sqlite3_mutex_leave(db->mutex);
4001 break;
4002 }
4003
drh07096f62009-12-22 23:52:32 +00004004 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
4005 **
4006 ** Enable or disable various optimizations for testing purposes. The
4007 ** argument N is a bitmask of optimizations to be disabled. For normal
4008 ** operation N should be 0. The idea is that a test program (like the
4009 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
4010 ** with various optimizations disabled to verify that the same answer
4011 ** is obtained in every case.
4012 */
4013 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
4014 sqlite3 *db = va_arg(ap, sqlite3*);
drh7e5418e2012-09-27 15:05:54 +00004015 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00004016 break;
4017 }
4018
danc17d6962011-06-21 12:47:30 +00004019 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
4020 **
4021 ** If parameter onoff is non-zero, configure the wrappers so that all
4022 ** subsequent calls to localtime() and variants fail. If onoff is zero,
4023 ** undo this setting.
4024 */
4025 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
4026 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
4027 break;
4028 }
4029
drh09fe6142013-11-29 15:06:27 +00004030 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4031 **
4032 ** Set or clear a flag that indicates that the database file is always well-
4033 ** formed and never corrupt. This flag is clear by default, indicating that
4034 ** database files might have arbitrary corruption. Setting the flag during
4035 ** testing causes certain assert() statements in the code to be activated
4036 ** that demonstrat invariants on well-formed database files.
4037 */
4038 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00004039 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00004040 break;
4041 }
4042
drh9e5eb9c2016-09-18 16:08:10 +00004043 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00004044 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00004045 ** too big to test in a reasonable amount of time, so this control is
4046 ** provided to set a small and easily reachable reset value.
4047 */
4048 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4049 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4050 break;
4051 }
drh688852a2014-02-17 22:40:43 +00004052
4053 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4054 **
4055 ** Set the VDBE coverage callback function to xCallback with context
4056 ** pointer ptr.
4057 */
4058 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4059#ifdef SQLITE_VDBE_COVERAGE
4060 typedef void (*branch_callback)(void*,int,u8,u8);
4061 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4062 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4063#endif
4064 break;
4065 }
4066
dan8930c2a2014-04-03 16:25:29 +00004067 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4068 case SQLITE_TESTCTRL_SORTER_MMAP: {
4069 sqlite3 *db = va_arg(ap, sqlite3*);
4070 db->nMaxSorterMmap = va_arg(ap, int);
4071 break;
4072 }
4073
drh43cfc232014-07-29 14:09:21 +00004074 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4075 **
4076 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4077 ** not.
4078 */
4079 case SQLITE_TESTCTRL_ISINIT: {
4080 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4081 break;
4082 }
drh8964b342015-01-29 17:54:52 +00004083
drh3ba689d2015-03-03 14:00:11 +00004084 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00004085 **
drh1ffede82015-01-30 20:59:27 +00004086 ** This test control is used to create imposter tables. "db" is a pointer
4087 ** to the database connection. dbName is the database name (ex: "main" or
4088 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4089 ** or off. "tnum" is the root page of the b-tree to which the imposter
4090 ** table should connect.
4091 **
4092 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00004093 ** run a single CREATE TABLE statement to construct the imposter table in
4094 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00004095 **
4096 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4097 ** the schema to be reparsed the next time it is needed. This has the
4098 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00004099 */
drh1ffede82015-01-30 20:59:27 +00004100 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00004101 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00004102 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00004103 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4104 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00004105 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00004106 if( db->init.busy==0 && db->init.newTnum>0 ){
4107 sqlite3ResetAllSchemasOfConnection(db);
4108 }
drh8fb15e32015-02-04 20:56:49 +00004109 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00004110 break;
4111 }
drh0d9de992017-12-26 18:04:23 +00004112
4113#if defined(YYCOVERAGE)
4114 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4115 **
4116 ** This test control (only available when SQLite is compiled with
4117 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4118 ** state/lookahead combinations in the parser state machine
4119 ** which are never exercised. If any state is missed, make the
4120 ** return code SQLITE_ERROR.
4121 */
4122 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4123 FILE *out = va_arg(ap, FILE*);
4124 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4125 break;
4126 }
4127#endif /* defined(YYCOVERAGE) */
drhed13d982008-01-31 14:43:24 +00004128 }
4129 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00004130#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00004131 return rc;
drhed13d982008-01-31 14:43:24 +00004132}
drhcc487d12011-05-17 18:53:08 +00004133
4134/*
4135** This is a utility routine, useful to VFS implementations, that checks
4136** to see if a database file was a URI that contained a specific query
4137** parameter, and if so obtains the value of the query parameter.
4138**
4139** The zFilename argument is the filename pointer passed into the xOpen()
4140** method of a VFS implementation. The zParam argument is the name of the
4141** query parameter we seek. This routine returns the value of the zParam
4142** parameter if it exists. If the parameter does not exist, this routine
4143** returns a NULL pointer.
4144*/
4145const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00004146 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00004147 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004148 while( zFilename[0] ){
4149 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00004150 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004151 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00004152 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00004153 }
4154 return 0;
4155}
adam2e4491d2011-06-24 20:47:06 +00004156
drh283829c2011-11-17 00:56:20 +00004157/*
drh92913722011-12-23 00:07:33 +00004158** Return a boolean value for a query parameter.
4159*/
4160int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4161 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00004162 bDflt = bDflt!=0;
4163 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00004164}
4165
4166/*
4167** Return a 64-bit integer value for a query parameter.
4168*/
4169sqlite3_int64 sqlite3_uri_int64(
4170 const char *zFilename, /* Filename as passed to xOpen */
4171 const char *zParam, /* URI parameter sought */
4172 sqlite3_int64 bDflt /* return if parameter is missing */
4173){
4174 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4175 sqlite3_int64 v;
drh84d4f1a2017-09-20 10:47:10 +00004176 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
drh92913722011-12-23 00:07:33 +00004177 bDflt = v;
4178 }
4179 return bDflt;
4180}
4181
4182/*
drh421377e2012-03-15 21:28:54 +00004183** Return the Btree pointer identified by zDbName. Return NULL if not found.
4184*/
4185Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00004186 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4187 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00004188}
4189
4190/*
drh283829c2011-11-17 00:56:20 +00004191** Return the filename of the database associated with a database
4192** connection.
4193*/
4194const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004195 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004196#ifdef SQLITE_ENABLE_API_ARMOR
4197 if( !sqlite3SafetyCheckOk(db) ){
4198 (void)SQLITE_MISUSE_BKPT;
4199 return 0;
4200 }
4201#endif
mistachkincd54bab2014-12-20 21:14:14 +00004202 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00004203 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4204}
4205
4206/*
4207** Return 1 if database is read-only or 0 if read/write. Return -1 if
4208** no such database exists.
4209*/
4210int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00004211 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00004212#ifdef SQLITE_ENABLE_API_ARMOR
4213 if( !sqlite3SafetyCheckOk(db) ){
4214 (void)SQLITE_MISUSE_BKPT;
4215 return -1;
4216 }
4217#endif
mistachkincd54bab2014-12-20 21:14:14 +00004218 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00004219 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00004220}
adamaec336a2011-10-10 22:11:44 +00004221#if (SQLITE_ENABLE_APPLE_SPI>0) && defined(__APPLE__)
4222
adam2e4491d2011-06-24 20:47:06 +00004223#include "sqlite3_private.h"
adam2e4491d2011-06-24 20:47:06 +00004224
4225/*
4226** Testing a file path for sqlite locks held by a process ID.
4227** Returns SQLITE_LOCKSTATE_ON if locks are present on path
4228** that would prevent writing to the database.
adam2e4491d2011-06-24 20:47:06 +00004229*/
4230int _sqlite3_lockstate(const char *path, pid_t pid){
adamaec336a2011-10-10 22:11:44 +00004231 sqlite3 *db = NULL;
adam2e4491d2011-06-24 20:47:06 +00004232
adamaec336a2011-10-10 22:11:44 +00004233 if( sqlite3_open_v2(path, &db, SQLITE_OPEN_READONLY, NULL) == SQLITE_OK ){
4234 LockstatePID lockstate = {pid, -1};
4235 sqlite3_file_control(db, NULL, SQLITE_FCNTL_LOCKSTATE_PID, &lockstate);
4236 sqlite3_close(db);
4237 int state = lockstate.state;
4238 return state;
adam2e4491d2011-06-24 20:47:06 +00004239 }
adam0cb33b62012-04-02 23:35:45 +00004240 if( NULL!=db ){
4241 sqlite3_close(db); /* need to close even if open returns an error */
4242 }
adamaec336a2011-10-10 22:11:44 +00004243 return SQLITE_LOCKSTATE_ERROR;
adam2e4491d2011-06-24 20:47:06 +00004244}
4245
4246#endif /* SQLITE_ENABLE_APPLE_SPI */
danfc1acf32015-12-05 20:51:54 +00004247
4248#ifdef SQLITE_ENABLE_SNAPSHOT
4249/*
4250** Obtain a snapshot handle for the snapshot of database zDb currently
4251** being read by handle db.
4252*/
4253int sqlite3_snapshot_get(
4254 sqlite3 *db,
4255 const char *zDb,
4256 sqlite3_snapshot **ppSnapshot
4257){
4258 int rc = SQLITE_ERROR;
4259#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00004260
4261#ifdef SQLITE_ENABLE_API_ARMOR
4262 if( !sqlite3SafetyCheckOk(db) ){
4263 return SQLITE_MISUSE_BKPT;
4264 }
4265#endif
4266 sqlite3_mutex_enter(db->mutex);
4267
danedace5d2016-11-18 18:43:39 +00004268 if( db->autoCommit==0 ){
4269 int iDb = sqlite3FindDbName(db, zDb);
4270 if( iDb==0 || iDb>1 ){
4271 Btree *pBt = db->aDb[iDb].pBt;
4272 if( 0==sqlite3BtreeIsInTrans(pBt) ){
4273 rc = sqlite3BtreeBeginTrans(pBt, 0);
4274 if( rc==SQLITE_OK ){
4275 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4276 }
dan7116dc62015-12-10 20:03:08 +00004277 }
danfc1acf32015-12-05 20:51:54 +00004278 }
4279 }
4280
4281 sqlite3_mutex_leave(db->mutex);
4282#endif /* SQLITE_OMIT_WAL */
4283 return rc;
4284}
4285
4286/*
4287** Open a read-transaction on the snapshot idendified by pSnapshot.
4288*/
4289int sqlite3_snapshot_open(
4290 sqlite3 *db,
4291 const char *zDb,
4292 sqlite3_snapshot *pSnapshot
4293){
4294 int rc = SQLITE_ERROR;
4295#ifndef SQLITE_OMIT_WAL
4296
4297#ifdef SQLITE_ENABLE_API_ARMOR
4298 if( !sqlite3SafetyCheckOk(db) ){
4299 return SQLITE_MISUSE_BKPT;
4300 }
4301#endif
4302 sqlite3_mutex_enter(db->mutex);
4303 if( db->autoCommit==0 ){
4304 int iDb;
4305 iDb = sqlite3FindDbName(db, zDb);
4306 if( iDb==0 || iDb>1 ){
4307 Btree *pBt = db->aDb[iDb].pBt;
4308 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
4309 rc = sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), pSnapshot);
4310 if( rc==SQLITE_OK ){
4311 rc = sqlite3BtreeBeginTrans(pBt, 0);
4312 sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), 0);
4313 }
4314 }
4315 }
4316 }
4317
4318 sqlite3_mutex_leave(db->mutex);
4319#endif /* SQLITE_OMIT_WAL */
4320 return rc;
4321}
4322
4323/*
dan11584982016-11-18 20:49:43 +00004324** Recover as many snapshots as possible from the wal file associated with
4325** schema zDb of database db.
4326*/
4327int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4328 int rc = SQLITE_ERROR;
4329 int iDb;
4330#ifndef SQLITE_OMIT_WAL
4331
4332#ifdef SQLITE_ENABLE_API_ARMOR
4333 if( !sqlite3SafetyCheckOk(db) ){
4334 return SQLITE_MISUSE_BKPT;
4335 }
4336#endif
4337
4338 sqlite3_mutex_enter(db->mutex);
4339 iDb = sqlite3FindDbName(db, zDb);
4340 if( iDb==0 || iDb>1 ){
4341 Btree *pBt = db->aDb[iDb].pBt;
4342 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
dan93f51132016-11-19 18:31:37 +00004343 rc = sqlite3BtreeBeginTrans(pBt, 0);
4344 if( rc==SQLITE_OK ){
4345 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4346 sqlite3BtreeCommit(pBt);
4347 }
dan11584982016-11-18 20:49:43 +00004348 }
4349 }
4350 sqlite3_mutex_leave(db->mutex);
4351#endif /* SQLITE_OMIT_WAL */
4352 return rc;
4353}
4354
4355/*
danfc1acf32015-12-05 20:51:54 +00004356** Free a snapshot handle obtained from sqlite3_snapshot_get().
4357*/
4358void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4359 sqlite3_free(pSnapshot);
4360}
4361#endif /* SQLITE_ENABLE_SNAPSHOT */
danda1f49b2017-06-16 19:51:47 +00004362
4363#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4364/*
4365** Given the name of a compile-time option, return true if that option
4366** was used and false if not.
4367**
4368** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4369** is not required for a match.
4370*/
4371int sqlite3_compileoption_used(const char *zOptName){
4372 int i, n;
4373 int nOpt;
4374 const char **azCompileOpt;
4375
4376#if SQLITE_ENABLE_API_ARMOR
4377 if( zOptName==0 ){
4378 (void)SQLITE_MISUSE_BKPT;
4379 return 0;
4380 }
4381#endif
4382
4383 azCompileOpt = sqlite3CompileOptions(&nOpt);
4384
4385 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4386 n = sqlite3Strlen30(zOptName);
4387
4388 /* Since nOpt is normally in single digits, a linear search is
4389 ** adequate. No need for a binary search. */
4390 for(i=0; i<nOpt; i++){
4391 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4392 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4393 ){
4394 return 1;
4395 }
4396 }
4397 return 0;
4398}
4399
4400/*
4401** Return the N-th compile-time option string. If N is out of range,
4402** return a NULL pointer.
4403*/
4404const char *sqlite3_compileoption_get(int N){
4405 int nOpt;
4406 const char **azCompileOpt;
4407 azCompileOpt = sqlite3CompileOptions(&nOpt);
4408 if( N>=0 && N<nOpt ){
4409 return azCompileOpt[N];
4410 }
4411 return 0;
4412}
4413#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */