blob: 32d00087f5f6945dd6ef9e6fb04d8c35f73a81c5 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Main file for the SQLite library. The routines in this file
13** implement the programmer interface to the library. Routines in
14** other files are for internal use by SQLite and should not be
15** accessed by users of the library.
drh75897232000-05-29 14:26:00 +000016*/
17#include "sqliteInt.h"
drh58f1c8b2008-05-26 20:19:25 +000018
drh820a9062008-01-31 13:35:48 +000019#ifdef SQLITE_ENABLE_FTS3
20# include "fts3.h"
21#endif
drh58f1c8b2008-05-26 20:19:25 +000022#ifdef SQLITE_ENABLE_RTREE
23# include "rtree.h"
24#endif
danielk19771c826652008-09-08 08:08:09 +000025#ifdef SQLITE_ENABLE_ICU
26# include "sqliteicu.h"
27#endif
drhc306e082015-10-08 23:37:00 +000028#ifdef SQLITE_ENABLE_JSON1
29int sqlite3Json1Init(sqlite3*);
30#endif
31#ifdef SQLITE_ENABLE_FTS5
32int sqlite3Fts5Init(sqlite3*);
33#endif
drh75897232000-05-29 14:26:00 +000034
drhb3190c12008-12-08 21:37:14 +000035#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000036/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
37** contains the text of SQLITE_VERSION macro.
38*/
danielk197724b03fd2004-05-10 10:34:34 +000039const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000040#endif
drh9f129f42010-08-31 15:27:32 +000041
42/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
43** a pointer to the to the sqlite3_version[] string constant.
44*/
drh4aec8b62004-08-28 16:19:00 +000045const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000046
47/* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
48** pointer to a string constant whose value is the same as the
49** SQLITE_SOURCE_ID C preprocessor macro.
50*/
drh47baebc2009-08-14 16:01:24 +000051const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000052
53/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
54** returns an integer equal to SQLITE_VERSION_NUMBER.
55*/
danielk197799ba19e2005-02-05 07:33:34 +000056int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000057
drh5dc2bcd2012-01-02 15:45:12 +000058/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000059** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000060** the SQLITE_THREADSAFE compile-time option being set to 0.
61*/
drhb67e8bf2007-08-30 20:09:48 +000062int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000063
mistachkin34cf2582015-04-02 17:46:52 +000064/*
65** When compiling the test fixture or with debugging enabled (on Win32),
66** this variable being set to non-zero will cause OSTRACE macros to emit
67** extra diagnostic information.
68*/
mistachkinfb383e92015-04-16 03:24:38 +000069#ifdef SQLITE_HAVE_OS_TRACE
mistachkin34cf2582015-04-02 17:46:52 +000070# ifndef SQLITE_DEBUG_OS_TRACE
71# define SQLITE_DEBUG_OS_TRACE 0
72# endif
73 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
74#endif
75
drhe265b082008-05-01 17:03:49 +000076#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000077/*
drhb0603412007-02-28 04:47:26 +000078** If the following function pointer is not NULL and if
79** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
80** I/O active are written using this function. These messages
81** are intended for debugging activity only.
82*/
mistachkin9871a932015-03-27 00:21:52 +000083SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000084#endif
drhb0603412007-02-28 04:47:26 +000085
86/*
drha16313e2007-03-30 11:29:32 +000087** If the following global variable points to a string which is the
88** name of a directory, then that directory will be used to store
89** temporary files.
90**
91** See also the "PRAGMA temp_store_directory" SQL command.
92*/
93char *sqlite3_temp_directory = 0;
94
drhc5499be2008-04-01 15:06:33 +000095/*
mistachkina112d142012-03-14 00:44:01 +000096** If the following global variable points to a string which is the
97** name of a directory, then that directory will be used to store
98** all database files specified with a relative pathname.
99**
100** See also the "PRAGMA data_store_directory" SQL command.
101*/
102char *sqlite3_data_directory = 0;
103
104/*
drh40257ff2008-06-13 18:24:27 +0000105** Initialize SQLite.
106**
107** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000108** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000109** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
110** this routine will be called automatically by key routines such as
111** sqlite3_open().
112**
113** This routine is a no-op except on its very first call for the process,
114** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000115**
116** The first thread to call this routine runs the initialization to
117** completion. If subsequent threads call this routine before the first
118** thread has finished the initialization process, then the subsequent
119** threads must block until the first thread finishes with the initialization.
120**
121** The first thread might call this routine recursively. Recursive
122** calls to this routine should not block, of course. Otherwise the
123** initialization process would never complete.
124**
125** Let X be the first thread to enter this routine. Let Y be some other
126** thread. Then while the initial invocation of this routine by X is
127** incomplete, it is required that:
128**
129** * Calls to this routine from Y must block until the outer-most
130** call by X completes.
131**
132** * Recursive calls to this routine from thread X return immediately
133** without blocking.
drh40257ff2008-06-13 18:24:27 +0000134*/
135int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000136 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000137 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000138#ifdef SQLITE_EXTRA_INIT
139 int bRunExtraInit = 0; /* Extra initialization needed */
140#endif
danielk1977075c23a2008-09-01 18:34:20 +0000141
142#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000143 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000144 if( rc!=SQLITE_OK ){
145 return rc;
146 }
147#endif
danielk197771bc31c2008-06-26 08:29:34 +0000148
drh2b4905c2015-03-23 18:52:56 +0000149 /* If the following assert() fails on some obscure processor/compiler
150 ** combination, the work-around is to set the correct pointer
151 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
152 assert( SQLITE_PTRSIZE==sizeof(char*) );
153
drh93ed56d2008-08-12 15:21:11 +0000154 /* If SQLite is already completely initialized, then this call
155 ** to sqlite3_initialize() should be a no-op. But the initialization
156 ** must be complete. So isInit must not be set until the very end
157 ** of this routine.
158 */
danielk1977075c23a2008-09-01 18:34:20 +0000159 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000160
drh93ed56d2008-08-12 15:21:11 +0000161 /* Make sure the mutex subsystem is initialized. If unable to
162 ** initialize the mutex subsystem, return early with the error.
163 ** If the system is so sick that we are unable to allocate a mutex,
164 ** there is not much SQLite is going to be able to do.
165 **
166 ** The mutex subsystem must take care of serializing its own
167 ** initialization.
168 */
danielk1977d0251742008-06-18 18:57:42 +0000169 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000170 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000171
drh93ed56d2008-08-12 15:21:11 +0000172 /* Initialize the malloc() system and the recursive pInitMutex mutex.
173 ** This operation is protected by the STATIC_MASTER mutex. Note that
174 ** MutexAlloc() is called for a static mutex prior to initializing the
175 ** malloc subsystem - this implies that the allocation of a static
176 ** mutex must not require support from the malloc subsystem.
177 */
drh30ddce62011-10-15 00:16:30 +0000178 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000179 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000180 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000181 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000182 rc = sqlite3MallocInit();
183 }
drh40257ff2008-06-13 18:24:27 +0000184 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000185 sqlite3GlobalConfig.isMallocInit = 1;
186 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000187 sqlite3GlobalConfig.pInitMutex =
188 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000189 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
mistachkinfad30392016-02-13 23:43:46 +0000190 rc = SQLITE_NOMEM_BKPT;
drh40257ff2008-06-13 18:24:27 +0000191 }
192 }
danielk197777eb5bb2008-09-22 17:22:19 +0000193 }
194 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000195 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000196 }
197 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000198
dane1ab2192009-08-17 15:16:19 +0000199 /* If rc is not SQLITE_OK at this point, then either the malloc
200 ** subsystem could not be initialized or the system failed to allocate
201 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000202 if( rc!=SQLITE_OK ){
203 return rc;
204 }
205
206 /* Do the rest of the initialization under the recursive mutex so
207 ** that we will be able to handle recursive calls into
208 ** sqlite3_initialize(). The recursive calls normally come through
209 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
210 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000211 **
212 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
213 ** to the xInit method, so the xInit method need not be threadsafe.
214 **
215 ** The following mutex is what serializes access to the appdef pcache xInit
216 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
217 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000218 */
danielk1977075c23a2008-09-01 18:34:20 +0000219 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000220 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977502b4e02008-09-02 14:07:24 +0000221 sqlite3GlobalConfig.inProgress = 1;
drh5e3cefe2015-11-12 23:48:08 +0000222#ifdef SQLITE_ENABLE_SQLLOG
dand83f7ca2015-11-12 20:12:51 +0000223 {
drh5e3cefe2015-11-12 23:48:08 +0000224 extern void sqlite3_init_sqllog(void);
225 sqlite3_init_sqllog();
dand83f7ca2015-11-12 20:12:51 +0000226 }
227#endif
drh80738d92016-02-15 00:34:16 +0000228 memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
229 sqlite3RegisterBuiltinFunctions();
dane1ab2192009-08-17 15:16:19 +0000230 if( sqlite3GlobalConfig.isPCacheInit==0 ){
231 rc = sqlite3PcacheInitialize();
232 }
danielk19778c0a7912008-08-20 14:49:23 +0000233 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000234 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000235 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000236 }
237 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000238 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
239 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000240 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000241#ifdef SQLITE_EXTRA_INIT
242 bRunExtraInit = 1;
243#endif
danielk19778c0a7912008-08-20 14:49:23 +0000244 }
danielk1977502b4e02008-09-02 14:07:24 +0000245 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000246 }
danielk1977075c23a2008-09-01 18:34:20 +0000247 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000248
drh93ed56d2008-08-12 15:21:11 +0000249 /* Go back under the static mutex and clean up the recursive
250 ** mutex to prevent a resource leak.
251 */
252 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000253 sqlite3GlobalConfig.nRefInitMutex--;
254 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
255 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
256 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
257 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000258 }
259 sqlite3_mutex_leave(pMaster);
260
261 /* The following is just a sanity check to make sure SQLite has
262 ** been compiled correctly. It is important to run this code, but
263 ** we don't want to run it too often and soak up CPU cycles for no
264 ** reason. So we run it once during initialization.
265 */
shanedfb7b372008-07-22 05:13:30 +0000266#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000267#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000268 /* This section of code's only "output" is via assert() statements. */
269 if ( rc==SQLITE_OK ){
270 u64 x = (((u64)1)<<63)-1;
271 double y;
272 assert(sizeof(x)==8);
273 assert(sizeof(x)==sizeof(y));
274 memcpy(&y, &x, 8);
275 assert( sqlite3IsNaN(y) );
276 }
277#endif
shanefbd60f82009-02-04 03:59:25 +0000278#endif
shanedfb7b372008-07-22 05:13:30 +0000279
drhe4cf0b32011-08-25 00:14:41 +0000280 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
281 ** compile-time option.
282 */
283#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000284 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000285 int SQLITE_EXTRA_INIT(const char*);
286 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000287 }
288#endif
289
drh40257ff2008-06-13 18:24:27 +0000290 return rc;
291}
292
293/*
294** Undo the effects of sqlite3_initialize(). Must not be called while
295** there are outstanding database connections or memory allocations or
296** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000297** routine is not threadsafe. But it is safe to invoke this routine
298** on when SQLite is already shut down. If SQLite is already shut down
299** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000300*/
301int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000302#ifdef SQLITE_OMIT_WSD
303 int rc = sqlite3_wsd_init(4096, 24);
304 if( rc!=SQLITE_OK ){
305 return rc;
306 }
307#endif
308
danielk1977075c23a2008-09-01 18:34:20 +0000309 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000310#ifdef SQLITE_EXTRA_SHUTDOWN
311 void SQLITE_EXTRA_SHUTDOWN(void);
312 SQLITE_EXTRA_SHUTDOWN();
313#endif
drha7640922009-04-21 12:02:56 +0000314 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000315 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000316 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000317 }
dane1ab2192009-08-17 15:16:19 +0000318 if( sqlite3GlobalConfig.isPCacheInit ){
319 sqlite3PcacheShutdown();
320 sqlite3GlobalConfig.isPCacheInit = 0;
321 }
322 if( sqlite3GlobalConfig.isMallocInit ){
323 sqlite3MallocEnd();
324 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000325
326#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
327 /* The heap subsystem has now been shutdown and these values are supposed
328 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
329 ** which would rely on that heap subsystem; therefore, make sure these
330 ** values cannot refer to heap memory that was just invalidated when the
331 ** heap subsystem was shutdown. This is only done if the current call to
332 ** this function resulted in the heap subsystem actually being shutdown.
333 */
334 sqlite3_data_directory = 0;
335 sqlite3_temp_directory = 0;
336#endif
dane1ab2192009-08-17 15:16:19 +0000337 }
338 if( sqlite3GlobalConfig.isMutexInit ){
339 sqlite3MutexEnd();
340 sqlite3GlobalConfig.isMutexInit = 0;
341 }
342
drh40257ff2008-06-13 18:24:27 +0000343 return SQLITE_OK;
344}
345
346/*
347** This API allows applications to modify the global configuration of
348** the SQLite library at run-time.
349**
350** This routine should only be called when there are no outstanding
351** database connections or memory allocations. This routine is not
352** threadsafe. Failure to heed these warnings can lead to unpredictable
353** behavior.
354*/
355int sqlite3_config(int op, ...){
356 va_list ap;
357 int rc = SQLITE_OK;
358
359 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
360 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000361 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000362
363 va_start(ap, op);
364 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000365
366 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000367 ** compile.
drh18472fa2008-10-07 15:25:48 +0000368 */
drhd1dcb232014-11-01 18:32:18 +0000369#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000370 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000371 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
372 ** Single-thread. */
373 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
374 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000375 break;
376 }
drhd1dcb232014-11-01 18:32:18 +0000377#endif
378#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000379 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000380 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
381 ** Multi-thread. */
382 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
383 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000384 break;
385 }
drhd1dcb232014-11-01 18:32:18 +0000386#endif
387#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000388 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000389 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
390 ** Serialized. */
391 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
392 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000393 break;
394 }
drhd1dcb232014-11-01 18:32:18 +0000395#endif
396#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000397 case SQLITE_CONFIG_MUTEX: {
398 /* Specify an alternative mutex implementation */
399 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
400 break;
401 }
drhd1dcb232014-11-01 18:32:18 +0000402#endif
403#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000404 case SQLITE_CONFIG_GETMUTEX: {
405 /* Retrieve the current mutex implementation */
406 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
407 break;
408 }
409#endif
410
drh40257ff2008-06-13 18:24:27 +0000411 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000412 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
413 ** single argument which is a pointer to an instance of the
414 ** sqlite3_mem_methods structure. The argument specifies alternative
415 ** low-level memory allocation routines to be used in place of the memory
416 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000417 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000418 break;
419 }
drh33589792008-06-18 13:27:46 +0000420 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000421 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
422 ** single argument which is a pointer to an instance of the
423 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
424 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000425 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
426 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000427 break;
428 }
drhfec00ea2008-06-14 16:56:21 +0000429 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000430 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
431 ** single argument of type int, interpreted as a boolean, which enables
432 ** or disables the collection of memory allocation statistics. */
danielk1977075c23a2008-09-01 18:34:20 +0000433 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000434 break;
435 }
drh33589792008-06-18 13:27:46 +0000436 case SQLITE_CONFIG_SCRATCH: {
drh5279d342014-11-04 13:41:32 +0000437 /* EVIDENCE-OF: R-08404-60887 There are three arguments to
438 ** SQLITE_CONFIG_SCRATCH: A pointer an 8-byte aligned memory buffer from
439 ** which the scratch allocations will be drawn, the size of each scratch
440 ** allocation (sz), and the maximum number of scratch allocations (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000441 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
442 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
443 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000444 break;
445 }
446 case SQLITE_CONFIG_PAGECACHE: {
drh15427272015-12-03 22:33:55 +0000447 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
448 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
449 ** the size of each page cache line (sz), and the number of cache lines
450 ** (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000451 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
452 sqlite3GlobalConfig.szPage = va_arg(ap, int);
453 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000454 break;
455 }
drhdef68892014-11-04 12:11:23 +0000456 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000457 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
458 ** a single parameter which is a pointer to an integer and writes into
459 ** that integer the number of extra bytes per page required for each page
460 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000461 *va_arg(ap, int*) =
462 sqlite3HeaderSizeBtree() +
463 sqlite3HeaderSizePcache() +
464 sqlite3HeaderSizePcache1();
465 break;
466 }
danielk19775099be52008-06-27 13:27:03 +0000467
danielk1977bc2ca9e2008-11-13 14:28:28 +0000468 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000469 /* no-op */
470 break;
471 }
472 case SQLITE_CONFIG_GETPCACHE: {
473 /* now an error */
474 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000475 break;
476 }
477
dan22e21ff2011-11-08 20:08:44 +0000478 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000479 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
480 ** single argument which is a pointer to an sqlite3_pcache_methods2
481 ** object. This object specifies the interface to a custom page cache
482 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000483 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
484 break;
485 }
486 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000487 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
488 ** single argument which is a pointer to an sqlite3_pcache_methods2
489 ** object. SQLite copies of the current page cache implementation into
490 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000491 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000492 sqlite3PCacheSetDefault();
493 }
dan22e21ff2011-11-08 20:08:44 +0000494 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000495 break;
496 }
497
drh8790b6e2014-11-07 01:43:56 +0000498/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
499** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
500** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000501#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000502 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000503 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
504 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000505 ** number of bytes in the memory buffer, and the minimum allocation size.
506 */
danielk1977075c23a2008-09-01 18:34:20 +0000507 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
508 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
509 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000510
shaneha6ec8922011-03-09 21:36:17 +0000511 if( sqlite3GlobalConfig.mnReq<1 ){
512 sqlite3GlobalConfig.mnReq = 1;
513 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
514 /* cap min request size at 2^12 */
515 sqlite3GlobalConfig.mnReq = (1<<12);
516 }
517
danielk1977075c23a2008-09-01 18:34:20 +0000518 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000519 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
520 ** is NULL, then SQLite reverts to using its default memory allocator
521 ** (the system malloc() implementation), undoing any prior invocation of
522 ** SQLITE_CONFIG_MALLOC.
523 **
524 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
525 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000526 */
danielk1977075c23a2008-09-01 18:34:20 +0000527 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000528 }else{
drh8790b6e2014-11-07 01:43:56 +0000529 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
530 ** alternative memory allocator is engaged to handle all of SQLites
531 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000532#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000533 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000534#endif
535#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000536 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000537#endif
drh8a42cbd2008-07-10 18:13:42 +0000538 }
danielk19775099be52008-06-27 13:27:03 +0000539 break;
540 }
drh5d414832008-07-15 14:47:18 +0000541#endif
danielk19775099be52008-06-27 13:27:03 +0000542
drh633e6d52008-07-28 19:34:53 +0000543 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000544 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
545 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000546 break;
547 }
drh3f280702010-02-18 18:45:09 +0000548
mistachkin037933b2013-08-13 22:33:41 +0000549 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000550 ** The default is NULL. Logging is disabled if the function pointer is
551 ** NULL.
552 */
553 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000554 /* MSVC is picky about pulling func ptrs from va lists.
555 ** http://support.microsoft.com/kb/47961
556 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
557 */
558 typedef void(*LOGFUNC_t)(void*,int,const char*);
559 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000560 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
561 break;
562 }
drh633e6d52008-07-28 19:34:53 +0000563
drh00729cb2014-10-04 11:59:33 +0000564 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
565 ** can be changed at start-time using the
566 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
567 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
568 */
dancd74b612011-04-22 19:37:32 +0000569 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000570 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
571 ** argument of type int. If non-zero, then URI handling is globally
572 ** enabled. If the parameter is zero, then URI handling is globally
573 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000574 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
575 break;
576 }
577
drhde9a7b82012-09-17 20:44:46 +0000578 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000579 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
580 ** option takes a single integer argument which is interpreted as a
581 ** boolean in order to enable or disable the use of covering indices for
582 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000583 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
584 break;
585 }
586
danac455932012-11-26 19:50:41 +0000587#ifdef SQLITE_ENABLE_SQLLOG
588 case SQLITE_CONFIG_SQLLOG: {
589 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
590 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
591 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
592 break;
593 }
594#endif
595
drh9b4c59f2013-04-15 17:03:42 +0000596 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000597 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
598 ** integer (sqlite3_int64) values that are the default mmap size limit
599 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
600 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000601 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000602 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000603 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000604 ** negative, then that argument is changed to its compile-time default.
605 **
606 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
607 ** silently truncated if necessary so that it does not exceed the
608 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
609 ** compile-time option.
610 */
drh3ba689d2015-03-03 14:00:11 +0000611 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
612 mxMmap = SQLITE_MAX_MMAP_SIZE;
613 }
drh9b4c59f2013-04-15 17:03:42 +0000614 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
615 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000616 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000617 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000618 break;
619 }
620
drh4d9f1882014-11-04 17:23:24 +0000621#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000622 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000623 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
624 ** unsigned integer value that specifies the maximum size of the created
625 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000626 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
627 break;
628 }
629#endif
630
drh3bd17912015-01-02 15:55:29 +0000631 case SQLITE_CONFIG_PMASZ: {
632 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
633 break;
634 }
635
drh8c71a982016-03-07 17:37:37 +0000636 case SQLITE_CONFIG_STMTJRNL_SPILL: {
637 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
638 break;
639 }
640
drh40257ff2008-06-13 18:24:27 +0000641 default: {
642 rc = SQLITE_ERROR;
643 break;
644 }
645 }
646 va_end(ap);
647 return rc;
648}
649
650/*
drh633e6d52008-07-28 19:34:53 +0000651** Set up the lookaside buffers for a database connection.
652** Return SQLITE_OK on success.
653** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000654**
655** The sz parameter is the number of bytes in each lookaside slot.
656** The cnt parameter is the number of slots. If pStart is NULL the
657** space for the lookaside memory is obtained from sqlite3_malloc().
658** If pStart is not NULL then it is sz*cnt bytes of memory to use for
659** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000660*/
drhe9d1c722008-08-04 20:13:26 +0000661static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh7877d9a2015-07-23 17:16:27 +0000662#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000663 void *pStart;
664 if( db->lookaside.nOut ){
665 return SQLITE_BUSY;
666 }
shanef71f89e2009-01-30 06:11:54 +0000667 /* Free any existing lookaside buffer for this handle before
668 ** allocating a new one so we don't have to have space for
669 ** both at the same time.
670 */
671 if( db->lookaside.bMalloced ){
672 sqlite3_free(db->lookaside.pStart);
673 }
drh61a4bd52011-11-10 02:39:28 +0000674 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
675 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000676 */
drh61a4bd52011-11-10 02:39:28 +0000677 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000678 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000679 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000680 if( sz==0 || cnt==0 ){
681 sz = 0;
682 pStart = 0;
683 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000684 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000685 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000686 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000687 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000688 }else{
689 pStart = pBuf;
690 }
drh4cfb22f2008-08-01 18:47:01 +0000691 db->lookaside.pStart = pStart;
692 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000693 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000694 if( pStart ){
695 int i;
696 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000697 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000698 p = (LookasideSlot*)pStart;
699 for(i=cnt-1; i>=0; i--){
700 p->pNext = db->lookaside.pFree;
701 db->lookaside.pFree = p;
702 p = (LookasideSlot*)&((u8*)p)[sz];
703 }
704 db->lookaside.pEnd = p;
drh4a642b62016-02-05 01:55:27 +0000705 db->lookaside.bDisable = 0;
shanef71f89e2009-01-30 06:11:54 +0000706 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000707 }else{
drhb0e77042013-12-10 19:49:00 +0000708 db->lookaside.pStart = db;
709 db->lookaside.pEnd = db;
drh4a642b62016-02-05 01:55:27 +0000710 db->lookaside.bDisable = 1;
shanef71f89e2009-01-30 06:11:54 +0000711 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000712 }
drh7877d9a2015-07-23 17:16:27 +0000713#endif /* SQLITE_OMIT_LOOKASIDE */
drh633e6d52008-07-28 19:34:53 +0000714 return SQLITE_OK;
715}
716
717/*
drh4413d0e2008-11-04 13:46:27 +0000718** Return the mutex associated with a database connection.
719*/
720sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000721#ifdef SQLITE_ENABLE_API_ARMOR
722 if( !sqlite3SafetyCheckOk(db) ){
723 (void)SQLITE_MISUSE_BKPT;
724 return 0;
725 }
726#endif
drh4413d0e2008-11-04 13:46:27 +0000727 return db->mutex;
728}
729
730/*
drh09419b42011-11-16 19:29:17 +0000731** Free up as much memory as we can from the given database
732** connection.
733*/
734int sqlite3_db_release_memory(sqlite3 *db){
735 int i;
drh9ca95732014-10-24 00:35:58 +0000736
737#ifdef SQLITE_ENABLE_API_ARMOR
738 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
739#endif
dand9bb3a92011-12-30 11:43:59 +0000740 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000741 sqlite3BtreeEnterAll(db);
742 for(i=0; i<db->nDb; i++){
743 Btree *pBt = db->aDb[i].pBt;
744 if( pBt ){
745 Pager *pPager = sqlite3BtreePager(pBt);
746 sqlite3PagerShrink(pPager);
747 }
748 }
749 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000750 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000751 return SQLITE_OK;
752}
753
754/*
dan6fa255f2015-10-28 19:46:57 +0000755** Flush any dirty pages in the pager-cache for any attached database
756** to disk.
757*/
758int sqlite3_db_cacheflush(sqlite3 *db){
759 int i;
760 int rc = SQLITE_OK;
761 int bSeenBusy = 0;
762
763#ifdef SQLITE_ENABLE_API_ARMOR
764 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
765#endif
766 sqlite3_mutex_enter(db->mutex);
767 sqlite3BtreeEnterAll(db);
768 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
769 Btree *pBt = db->aDb[i].pBt;
770 if( pBt && sqlite3BtreeIsInTrans(pBt) ){
771 Pager *pPager = sqlite3BtreePager(pBt);
772 rc = sqlite3PagerFlush(pPager);
773 if( rc==SQLITE_BUSY ){
774 bSeenBusy = 1;
775 rc = SQLITE_OK;
776 }
777 }
778 }
dan6fa255f2015-10-28 19:46:57 +0000779 sqlite3BtreeLeaveAll(db);
780 sqlite3_mutex_leave(db->mutex);
781 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
782}
783
784/*
drh633e6d52008-07-28 19:34:53 +0000785** Configuration settings for an individual database connection
786*/
787int sqlite3_db_config(sqlite3 *db, int op, ...){
788 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000789 int rc;
drh633e6d52008-07-28 19:34:53 +0000790 va_start(ap, op);
791 switch( op ){
drhda84dca2016-08-18 22:44:22 +0000792 case SQLITE_DBCONFIG_MAINDBNAME: {
793 db->aDb[0].zDbSName = va_arg(ap,char*);
794 rc = SQLITE_OK;
795 break;
796 }
drhe9d1c722008-08-04 20:13:26 +0000797 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000798 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000799 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
800 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000801 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000802 break;
803 }
drh6480aad2008-08-01 16:31:14 +0000804 default: {
drhe83cafd2011-03-21 17:15:58 +0000805 static const struct {
806 int op; /* The opcode */
807 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
808 } aFlagOp[] = {
drhd42908f2016-02-26 15:38:24 +0000809 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
810 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
811 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
drh191dd062016-04-21 01:30:09 +0000812 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
dan298af022016-10-31 16:16:49 +0000813 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
drhe83cafd2011-03-21 17:15:58 +0000814 };
drh58ad5802011-03-23 22:02:23 +0000815 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000816 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000817 for(i=0; i<ArraySize(aFlagOp); i++){
818 if( aFlagOp[i].op==op ){
819 int onoff = va_arg(ap, int);
820 int *pRes = va_arg(ap, int*);
drh9a48bf52011-03-23 22:48:46 +0000821 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000822 if( onoff>0 ){
823 db->flags |= aFlagOp[i].mask;
824 }else if( onoff==0 ){
825 db->flags &= ~aFlagOp[i].mask;
826 }
827 if( oldFlags!=db->flags ){
828 sqlite3ExpirePreparedStatements(db);
829 }
830 if( pRes ){
831 *pRes = (db->flags & aFlagOp[i].mask)!=0;
832 }
833 rc = SQLITE_OK;
834 break;
835 }
836 }
drh6480aad2008-08-01 16:31:14 +0000837 break;
838 }
drh633e6d52008-07-28 19:34:53 +0000839 }
840 va_end(ap);
841 return rc;
842}
843
drha16313e2007-03-30 11:29:32 +0000844
845/*
drh9b5adfa2008-01-20 23:19:56 +0000846** Return true if the buffer z[0..n-1] contains all spaces.
847*/
848static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000849 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000850 return n==0;
851}
852
853/*
drhd3d39e92004-05-20 22:16:29 +0000854** This is the default collating function named "BINARY" which is always
855** available.
drh9b5adfa2008-01-20 23:19:56 +0000856**
857** If the padFlag argument is not NULL then space padding at the end
858** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000859*/
danielk19772c336542005-01-13 02:14:23 +0000860static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000861 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000862 int nKey1, const void *pKey1,
863 int nKey2, const void *pKey2
864){
865 int rc, n;
866 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000867 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
868 ** strings byte by byte using the memcmp() function from the standard C
869 ** library. */
drhd3d39e92004-05-20 22:16:29 +0000870 rc = memcmp(pKey1, pKey2, n);
871 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000872 if( padFlag
873 && allSpaces(((char*)pKey1)+n, nKey1-n)
874 && allSpaces(((char*)pKey2)+n, nKey2-n)
875 ){
drh5e3b49b2014-11-20 19:22:26 +0000876 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
877 ** spaces at the end of either string do not change the result. In other
878 ** words, strings will compare equal to one another as long as they
879 ** differ only in the number of spaces at the end.
880 */
drh9b5adfa2008-01-20 23:19:56 +0000881 }else{
882 rc = nKey1 - nKey2;
883 }
drhd3d39e92004-05-20 22:16:29 +0000884 }
885 return rc;
886}
887
888/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000889** Another built-in collating sequence: NOCASE.
890**
drhf7b54962013-05-28 12:11:54 +0000891** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000892** comparison". SQLite's knowledge of upper and lower case equivalents
893** extends only to the 26 characters used in the English language.
894**
895** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000896*/
897static int nocaseCollatingFunc(
898 void *NotUsed,
899 int nKey1, const void *pKey1,
900 int nKey2, const void *pKey2
901){
902 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000903 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000904 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000905 if( 0==r ){
906 r = nKey1-nKey2;
907 }
908 return r;
909}
910
911/*
drhaf9ff332002-01-16 21:00:27 +0000912** Return the ROWID of the most recent insert
913*/
drh9bb575f2004-09-06 17:24:11 +0000914sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000915#ifdef SQLITE_ENABLE_API_ARMOR
916 if( !sqlite3SafetyCheckOk(db) ){
917 (void)SQLITE_MISUSE_BKPT;
918 return 0;
919 }
920#endif
drhaf9ff332002-01-16 21:00:27 +0000921 return db->lastRowid;
922}
923
924/*
dan9c58b632017-02-27 14:52:48 +0000925** Set the value returned by the sqlite3_last_insert_rowid() API function.
926*/
927void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
928#ifdef SQLITE_ENABLE_API_ARMOR
929 if( !sqlite3SafetyCheckOk(db) ){
930 (void)SQLITE_MISUSE_BKPT;
931 return;
932 }
933#endif
934 sqlite3_mutex_enter(db->mutex);
935 db->lastRowid = iRowid;
936 sqlite3_mutex_leave(db->mutex);
937}
938
939/*
danielk197724b03fd2004-05-10 10:34:34 +0000940** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000941*/
drh9bb575f2004-09-06 17:24:11 +0000942int sqlite3_changes(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
drhc8d30ac2002-04-12 10:08:59 +0000949 return db->nChange;
950}
951
rdcf146a772004-02-25 22:51:06 +0000952/*
danielk1977b28af712004-06-21 06:50:26 +0000953** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000954*/
danielk1977b28af712004-06-21 06:50:26 +0000955int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000956#ifdef SQLITE_ENABLE_API_ARMOR
957 if( !sqlite3SafetyCheckOk(db) ){
958 (void)SQLITE_MISUSE_BKPT;
959 return 0;
960 }
961#endif
danielk1977b28af712004-06-21 06:50:26 +0000962 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000963}
964
drhc8d30ac2002-04-12 10:08:59 +0000965/*
danielk1977fd7f0452008-12-17 17:30:26 +0000966** Close all open savepoints. This function only manipulates fields of the
967** database handle object, it does not close any savepoints that may be open
968** at the b-tree/pager level.
969*/
970void sqlite3CloseSavepoints(sqlite3 *db){
971 while( db->pSavepoint ){
972 Savepoint *pTmp = db->pSavepoint;
973 db->pSavepoint = pTmp->pNext;
974 sqlite3DbFree(db, pTmp);
975 }
976 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000977 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000978 db->isTransactionSavepoint = 0;
979}
980
981/*
dand2199f02010-08-27 17:48:52 +0000982** Invoke the destructor function associated with FuncDef p, if any. Except,
983** if this is not the last copy of the function, do not invoke it. Multiple
984** copies of a single function are created when create_function() is called
985** with SQLITE_ANY as the encoding.
986*/
987static void functionDestroy(sqlite3 *db, FuncDef *p){
drh80738d92016-02-15 00:34:16 +0000988 FuncDestructor *pDestructor = p->u.pDestructor;
dand2199f02010-08-27 17:48:52 +0000989 if( pDestructor ){
990 pDestructor->nRef--;
991 if( pDestructor->nRef==0 ){
992 pDestructor->xDestroy(pDestructor->pUserData);
993 sqlite3DbFree(db, pDestructor);
994 }
995 }
996}
997
998/*
danbba02a92012-05-15 17:15:34 +0000999** Disconnect all sqlite3_vtab objects that belong to database connection
1000** db. This is called when db is being closed.
1001*/
1002static void disconnectAllVtab(sqlite3 *db){
1003#ifndef SQLITE_OMIT_VIRTUALTABLE
1004 int i;
drh51be3872015-08-19 02:32:25 +00001005 HashElem *p;
danbba02a92012-05-15 17:15:34 +00001006 sqlite3BtreeEnterAll(db);
1007 for(i=0; i<db->nDb; i++){
1008 Schema *pSchema = db->aDb[i].pSchema;
1009 if( db->aDb[i].pSchema ){
danbba02a92012-05-15 17:15:34 +00001010 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1011 Table *pTab = (Table *)sqliteHashData(p);
1012 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1013 }
1014 }
1015 }
drh51be3872015-08-19 02:32:25 +00001016 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1017 Module *pMod = (Module *)sqliteHashData(p);
1018 if( pMod->pEpoTab ){
1019 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1020 }
1021 }
dand88e5212014-03-12 19:38:38 +00001022 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001023 sqlite3BtreeLeaveAll(db);
1024#else
1025 UNUSED_PARAMETER(db);
1026#endif
1027}
1028
1029/*
drh167cd6a2012-06-02 17:09:46 +00001030** Return TRUE if database connection db has unfinalized prepared
1031** statements or unfinished sqlite3_backup objects.
1032*/
1033static int connectionIsBusy(sqlite3 *db){
1034 int j;
1035 assert( sqlite3_mutex_held(db->mutex) );
1036 if( db->pVdbe ) return 1;
1037 for(j=0; j<db->nDb; j++){
1038 Btree *pBt = db->aDb[j].pBt;
1039 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1040 }
1041 return 0;
1042}
1043
1044/*
drh50e5dad2001-09-15 00:57:28 +00001045** Close an existing SQLite database
1046*/
drh167cd6a2012-06-02 17:09:46 +00001047static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +00001048 if( !db ){
drhddb17ca2014-08-11 15:54:11 +00001049 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1050 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +00001051 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +00001052 }
drh7e8b8482008-01-23 03:03:05 +00001053 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001054 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +00001055 }
drh605264d2007-08-21 15:13:19 +00001056 sqlite3_mutex_enter(db->mutex);
drh3d2a5292016-07-13 22:55:01 +00001057 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1058 db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1059 }
danielk1977e35ee192004-06-26 09:50:11 +00001060
danbba02a92012-05-15 17:15:34 +00001061 /* Force xDisconnect calls on all virtual tables */
1062 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +00001063
danbba02a92012-05-15 17:15:34 +00001064 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +00001065 ** will not have called the xDisconnect() method on any virtual
1066 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1067 ** call will do so. We need to do this before the check for active
1068 ** SQL statements below, as the v-table implementation may be storing
1069 ** some prepared statements internally.
1070 */
1071 sqlite3VtabRollback(db);
1072
drh167cd6a2012-06-02 17:09:46 +00001073 /* Legacy behavior (sqlite3_close() behavior) is to return
1074 ** SQLITE_BUSY if the connection can not be closed immediately.
1075 */
1076 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +00001077 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +00001078 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +00001079 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001080 return SQLITE_BUSY;
1081 }
danielk1977e0048402004-06-15 16:51:01 +00001082
danac455932012-11-26 19:50:41 +00001083#ifdef SQLITE_ENABLE_SQLLOG
1084 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001085 /* Closing the handle. Fourth parameter is passed the value 2. */
1086 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001087 }
1088#endif
1089
drh167cd6a2012-06-02 17:09:46 +00001090 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001091 */
1092 db->magic = SQLITE_MAGIC_ZOMBIE;
1093 sqlite3LeaveMutexAndCloseZombie(db);
1094 return SQLITE_OK;
1095}
drh94e92032003-02-16 22:21:32 +00001096
drh167cd6a2012-06-02 17:09:46 +00001097/*
1098** Two variations on the public interface for closing a database
1099** connection. The sqlite3_close() version returns SQLITE_BUSY and
1100** leaves the connection option if there are unfinalized prepared
1101** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1102** version forces the connection to become a zombie if there are
1103** unclosed resources, and arranges for deallocation when the last
1104** prepare statement or sqlite3_backup closes.
1105*/
1106int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1107int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1108
drh4245c402012-06-02 14:32:21 +00001109
1110/*
1111** Close the mutex on database connection db.
1112**
1113** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001114** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1115** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1116** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001117*/
1118void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1119 HashElem *i; /* Hash table iterator */
1120 int j;
1121
drh4245c402012-06-02 14:32:21 +00001122 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001123 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1124 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001125 */
drh167cd6a2012-06-02 17:09:46 +00001126 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001127 sqlite3_mutex_leave(db->mutex);
1128 return;
danielk197704103022009-02-03 16:51:24 +00001129 }
1130
drh4245c402012-06-02 14:32:21 +00001131 /* If we reach this point, it means that the database connection has
1132 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001133 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001134 ** go ahead and free all resources.
1135 */
1136
dan617dc862013-05-16 11:57:28 +00001137 /* If a transaction is open, roll it back. This also ensures that if
1138 ** any database schemas have been modified by an uncommitted transaction
1139 ** they are reset. And that the required b-tree mutex is held to make
1140 ** the pager rollback and schema reset an atomic operation. */
1141 sqlite3RollbackAll(db, SQLITE_OK);
1142
danielk1977fd7f0452008-12-17 17:30:26 +00001143 /* Free any outstanding Savepoint structures. */
1144 sqlite3CloseSavepoints(db);
1145
drh5efb3142012-05-16 01:24:34 +00001146 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001147 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001148 struct Db *pDb = &db->aDb[j];
1149 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +00001150 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +00001151 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +00001152 if( j!=1 ){
1153 pDb->pSchema = 0;
1154 }
drh113088e2003-03-20 01:16:58 +00001155 }
drhf57b3392001-10-08 13:22:32 +00001156 }
drh5efb3142012-05-16 01:24:34 +00001157 /* Clear the TEMP schema separately and last */
1158 if( db->aDb[1].pSchema ){
1159 sqlite3SchemaClear(db->aDb[1].pSchema);
1160 }
1161 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001162
drh5efb3142012-05-16 01:24:34 +00001163 /* Free up the array of auxiliary databases */
1164 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001165 assert( db->nDb<=2 );
1166 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001167
1168 /* Tell the code in notify.c that the connection no longer holds any
1169 ** locks and does not require any further unlock-notify callbacks.
1170 */
1171 sqlite3ConnectionClosed(db);
1172
drh80738d92016-02-15 00:34:16 +00001173 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1174 FuncDef *pNext, *p;
1175 p = sqliteHashData(i);
1176 do{
1177 functionDestroy(db, p);
1178 pNext = p->pNext;
1179 sqlite3DbFree(db, p);
1180 p = pNext;
1181 }while( p );
drh8e0a2f92002-02-23 23:45:45 +00001182 }
drh80738d92016-02-15 00:34:16 +00001183 sqlite3HashClear(&db->aFunc);
danielk1977d8123362004-06-12 09:25:12 +00001184 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001185 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001186 /* Invoke any destructors registered for collation sequence user data. */
1187 for(j=0; j<3; j++){
1188 if( pColl[j].xDel ){
1189 pColl[j].xDel(pColl[j].pUser);
1190 }
1191 }
drh633e6d52008-07-28 19:34:53 +00001192 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001193 }
danielk1977d8123362004-06-12 09:25:12 +00001194 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001195#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001196 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1197 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001198 if( pMod->xDestroy ){
1199 pMod->xDestroy(pMod->pAux);
1200 }
drh51be3872015-08-19 02:32:25 +00001201 sqlite3VtabEponymousTableClear(db, pMod);
drh633e6d52008-07-28 19:34:53 +00001202 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001203 }
drhb9bb7c12006-06-11 23:41:55 +00001204 sqlite3HashClear(&db->aModule);
1205#endif
danielk1977466be562004-06-10 02:16:01 +00001206
drh13f40da2014-08-22 18:00:11 +00001207 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001208 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001209 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001210#if SQLITE_USER_AUTHENTICATION
1211 sqlite3_free(db->auth.zAuthUser);
1212 sqlite3_free(db->auth.zAuthPW);
1213#endif
danielk197796d81f92004-06-19 03:33:57 +00001214
1215 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001216
1217 /* The temp-database schema is allocated differently from the other schema
1218 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1219 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1220 ** the same sqliteMalloc() as the one that allocates the database
1221 ** structure?
1222 */
drh633e6d52008-07-28 19:34:53 +00001223 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001224 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001225 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001226 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001227 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001228 if( db->lookaside.bMalloced ){
1229 sqlite3_free(db->lookaside.pStart);
1230 }
drh17435752007-08-16 04:30:38 +00001231 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001232}
1233
1234/*
drh0f198a72012-02-13 16:43:16 +00001235** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001236** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001237** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001238** attempts to use that cursor. Read cursors remain open and valid
1239** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001240*/
drh0f198a72012-02-13 16:43:16 +00001241void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001242 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001243 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001244 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001245 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001246 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001247
1248 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1249 ** This is important in case the transaction being rolled back has
1250 ** modified the database schema. If the b-tree mutexes are not taken
1251 ** here, then another shared-cache connection might sneak in between
1252 ** the database rollback and schema reset, which can cause false
1253 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001254 sqlite3BtreeEnterAll(db);
drh47b7fc72014-11-11 01:33:57 +00001255 schemaChange = (db->flags & SQLITE_InternChanges)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001256
drh001bbcb2003-03-19 03:14:00 +00001257 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001258 Btree *p = db->aDb[i].pBt;
1259 if( p ){
1260 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001261 inTrans = 1;
1262 }
drh47b7fc72014-11-11 01:33:57 +00001263 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001264 }
1265 }
danielk1977a298e902006-06-22 09:53:48 +00001266 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001267 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001268
drh5c5760a2013-02-19 18:34:45 +00001269 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001270 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001271 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001272 }
dancd7b91a2013-05-13 18:23:15 +00001273 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001274
dan1da40a32009-09-19 17:00:31 +00001275 /* Any deferred constraint violations have now been resolved. */
1276 db->nDeferredCons = 0;
dancb3e4b72013-07-03 19:53:05 +00001277 db->nDeferredImmCons = 0;
drh963c74d2013-07-11 12:19:12 +00001278 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001279
danielk197771fd80b2005-12-16 06:54:01 +00001280 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001281 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001282 db->xRollbackCallback(db->pRollbackArg);
1283 }
drh001bbcb2003-03-19 03:14:00 +00001284}
1285
1286/*
mistachkinf2c1c992013-04-28 01:44:43 +00001287** Return a static string containing the name corresponding to the error code
1288** specified in the argument.
1289*/
mistachkin5824d442015-04-28 23:34:10 +00001290#if defined(SQLITE_NEED_ERR_NAME)
mistachkinf2c1c992013-04-28 01:44:43 +00001291const char *sqlite3ErrName(int rc){
1292 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001293 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001294 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1295 switch( rc ){
1296 case SQLITE_OK: zName = "SQLITE_OK"; break;
1297 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1298 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1299 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1300 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001301 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001302 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001303 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001304 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001305 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1306 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1307 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1308 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001309 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1310 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1311 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001312 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001313 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1314 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001315 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1316 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1317 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1318 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1319 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1320 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1321 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1322 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1323 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1324 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001325 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1326 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1327 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1328 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1329 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1330 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1331 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1332 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1333 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1334 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1335 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1336 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1337 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1338 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001339 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001340 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001341 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001342 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001343 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1344 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1345 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001346 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1347 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1348 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001349 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001350 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1351 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1352 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1353 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1354 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1355 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1356 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1357 case SQLITE_CONSTRAINT_FOREIGNKEY:
1358 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1359 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1360 case SQLITE_CONSTRAINT_PRIMARYKEY:
1361 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1362 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1363 case SQLITE_CONSTRAINT_COMMITHOOK:
1364 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1365 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1366 case SQLITE_CONSTRAINT_FUNCTION:
1367 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001368 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001369 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1370 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1371 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1372 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1373 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1374 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1375 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1376 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1377 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001378 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1379 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1380 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001381 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001382 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001383 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001384 }
1385 }
mistachkin10269dc2013-04-30 07:54:42 +00001386 if( zName==0 ){
1387 static char zBuf[50];
1388 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1389 zName = zBuf;
1390 }
mistachkinf2c1c992013-04-28 01:44:43 +00001391 return zName;
1392}
mistachkin10269dc2013-04-30 07:54:42 +00001393#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001394
1395/*
drhc22bd472002-05-10 13:14:07 +00001396** Return a static string that describes the kind of error specified in the
1397** argument.
drh247be432002-05-10 05:44:55 +00001398*/
danielk1977f20b21c2004-05-31 23:56:42 +00001399const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001400 static const char* const aMsg[] = {
1401 /* SQLITE_OK */ "not an error",
1402 /* SQLITE_ERROR */ "SQL logic error or missing database",
1403 /* SQLITE_INTERNAL */ 0,
1404 /* SQLITE_PERM */ "access permission denied",
1405 /* SQLITE_ABORT */ "callback requested query abort",
1406 /* SQLITE_BUSY */ "database is locked",
1407 /* SQLITE_LOCKED */ "database table is locked",
1408 /* SQLITE_NOMEM */ "out of memory",
1409 /* SQLITE_READONLY */ "attempt to write a readonly database",
1410 /* SQLITE_INTERRUPT */ "interrupted",
1411 /* SQLITE_IOERR */ "disk I/O error",
1412 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001413 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001414 /* SQLITE_FULL */ "database or disk is full",
1415 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001416 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001417 /* SQLITE_EMPTY */ "table contains no data",
1418 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001419 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001420 /* SQLITE_CONSTRAINT */ "constraint failed",
1421 /* SQLITE_MISMATCH */ "datatype mismatch",
1422 /* SQLITE_MISUSE */ "library routine called out of sequence",
1423 /* SQLITE_NOLFS */ "large file support is disabled",
1424 /* SQLITE_AUTH */ "authorization denied",
1425 /* SQLITE_FORMAT */ "auxiliary database format error",
1426 /* SQLITE_RANGE */ "bind or column index out of range",
1427 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1428 };
drh21021a52012-02-13 17:01:51 +00001429 const char *zErr = "unknown error";
1430 switch( rc ){
1431 case SQLITE_ABORT_ROLLBACK: {
1432 zErr = "abort due to ROLLBACK";
1433 break;
1434 }
1435 default: {
1436 rc &= 0xff;
1437 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1438 zErr = aMsg[rc];
1439 }
1440 break;
1441 }
drh247be432002-05-10 05:44:55 +00001442 }
drh21021a52012-02-13 17:01:51 +00001443 return zErr;
drh247be432002-05-10 05:44:55 +00001444}
1445
1446/*
drh2dfbbca2000-07-28 14:32:48 +00001447** This routine implements a busy callback that sleeps and tries
1448** again until a timeout value is reached. The timeout value is
1449** an integer number of milliseconds passed in as the first
1450** argument.
1451*/
drhdaffd0e2001-04-11 14:28:42 +00001452static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001453 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001454 int count /* Number of times table has been busy */
1455){
drh0ede9eb2015-01-10 16:49:23 +00001456#if SQLITE_OS_WIN || HAVE_USLEEP
drhee570fa2005-04-28 12:06:05 +00001457 static const u8 delays[] =
1458 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1459 static const u8 totals[] =
1460 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001461# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001462 sqlite3 *db = (sqlite3 *)ptr;
1463 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001464 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001465
drhee570fa2005-04-28 12:06:05 +00001466 assert( count>=0 );
1467 if( count < NDELAY ){
1468 delay = delays[count];
1469 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001470 }else{
1471 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001472 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001473 }
drhd1bec472004-01-15 13:29:31 +00001474 if( prior + delay > timeout ){
1475 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001476 if( delay<=0 ) return 0;
1477 }
danielk19772a6bdf62007-08-20 16:07:00 +00001478 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001479 return 1;
1480#else
drh482ea182007-08-20 11:12:40 +00001481 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001482 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001483 if( (count+1)*1000 > timeout ){
1484 return 0;
1485 }
drh482ea182007-08-20 11:12:40 +00001486 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001487 return 1;
1488#endif
1489}
1490
1491/*
drha4afb652005-07-09 02:16:02 +00001492** Invoke the given busy handler.
1493**
1494** This routine is called when an operation failed with a lock.
1495** If this routine returns non-zero, the lock is retried. If it
1496** returns 0, the operation aborts with an SQLITE_BUSY error.
1497*/
1498int sqlite3InvokeBusyHandler(BusyHandler *p){
1499 int rc;
drh34004ce2008-07-11 16:15:17 +00001500 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001501 rc = p->xFunc(p->pArg, p->nBusy);
1502 if( rc==0 ){
1503 p->nBusy = -1;
1504 }else{
1505 p->nBusy++;
1506 }
1507 return rc;
1508}
1509
1510/*
drh2dfbbca2000-07-28 14:32:48 +00001511** This routine sets the busy callback for an Sqlite database to the
1512** given callback function with the given argument.
1513*/
danielk1977f9d64d22004-06-19 08:18:07 +00001514int sqlite3_busy_handler(
1515 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001516 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001517 void *pArg
1518){
drh9ca95732014-10-24 00:35:58 +00001519#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001520 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001521#endif
drhe30f4422007-08-21 16:15:55 +00001522 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001523 db->busyHandler.xFunc = xBusy;
1524 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001525 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001526 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001527 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001528 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001529}
1530
danielk1977348bb5d2003-10-18 09:37:26 +00001531#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1532/*
1533** This routine sets the progress callback for an Sqlite database to the
1534** given callback function with the given argument. The progress callback will
1535** be invoked every nOps opcodes.
1536*/
danielk197724b03fd2004-05-10 10:34:34 +00001537void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001538 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001539 int nOps,
1540 int (*xProgress)(void*),
1541 void *pArg
1542){
drh9ca95732014-10-24 00:35:58 +00001543#ifdef SQLITE_ENABLE_API_ARMOR
1544 if( !sqlite3SafetyCheckOk(db) ){
1545 (void)SQLITE_MISUSE_BKPT;
1546 return;
1547 }
1548#endif
drhbd0b1b52008-07-07 19:52:09 +00001549 sqlite3_mutex_enter(db->mutex);
1550 if( nOps>0 ){
1551 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001552 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001553 db->pProgressArg = pArg;
1554 }else{
1555 db->xProgress = 0;
1556 db->nProgressOps = 0;
1557 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001558 }
drhbd0b1b52008-07-07 19:52:09 +00001559 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001560}
1561#endif
1562
1563
drh2dfbbca2000-07-28 14:32:48 +00001564/*
1565** This routine installs a default busy handler that waits for the
1566** specified number of milliseconds before returning 0.
1567*/
danielk1977f9d64d22004-06-19 08:18:07 +00001568int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001569#ifdef SQLITE_ENABLE_API_ARMOR
1570 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1571#endif
drh2dfbbca2000-07-28 14:32:48 +00001572 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001573 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001574 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001575 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001576 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001577 }
danielk1977f9d64d22004-06-19 08:18:07 +00001578 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001579}
drh4c504392000-10-16 22:06:40 +00001580
1581/*
1582** Cause any pending operation to stop at its earliest opportunity.
1583*/
drh9bb575f2004-09-06 17:24:11 +00001584void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001585#ifdef SQLITE_ENABLE_API_ARMOR
drh575242f2016-12-27 13:33:52 +00001586 if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
drh9ca95732014-10-24 00:35:58 +00001587 (void)SQLITE_MISUSE_BKPT;
1588 return;
1589 }
1590#endif
drhbd0b1b52008-07-07 19:52:09 +00001591 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001592}
drhfa86c412002-02-02 15:01:15 +00001593
drhfa86c412002-02-02 15:01:15 +00001594
1595/*
danielk1977771151b2006-01-17 13:21:40 +00001596** This function is exactly the same as sqlite3_create_function(), except
1597** that it is designed to be called by internal code. The difference is
1598** that if a malloc() fails in sqlite3_create_function(), an error code
1599** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001600*/
danielk1977771151b2006-01-17 13:21:40 +00001601int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001602 sqlite3 *db,
1603 const char *zFunctionName,
1604 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001605 int enc,
danielk197765904932004-05-26 06:18:37 +00001606 void *pUserData,
drh2d801512016-01-14 22:19:58 +00001607 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk197765904932004-05-26 06:18:37 +00001608 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001609 void (*xFinal)(sqlite3_context*),
1610 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001611){
drh0bce8352002-02-28 00:41:10 +00001612 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001613 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001614 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001615
drhe30f4422007-08-21 16:15:55 +00001616 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001617 if( zFunctionName==0 ||
drh2d801512016-01-14 22:19:58 +00001618 (xSFunc && (xFinal || xStep)) ||
1619 (!xSFunc && (xFinal && !xStep)) ||
1620 (!xSFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001621 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001622 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001623 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001624 }
drh4a8ee3d2013-12-14 13:44:22 +00001625
1626 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1627 extraFlags = enc & SQLITE_DETERMINISTIC;
1628 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001629
danielk197793758c82005-01-21 08:13:14 +00001630#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001631 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1632 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1633 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1634 **
1635 ** If SQLITE_ANY is specified, add three versions of the function
1636 ** to the hash table.
1637 */
1638 if( enc==SQLITE_UTF16 ){
1639 enc = SQLITE_UTF16NATIVE;
1640 }else if( enc==SQLITE_ANY ){
1641 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001642 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
drh2d801512016-01-14 22:19:58 +00001643 pUserData, xSFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001644 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001645 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
drh2d801512016-01-14 22:19:58 +00001646 pUserData, xSFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001647 }
1648 if( rc!=SQLITE_OK ){
1649 return rc;
1650 }
danielk1977d8123362004-06-12 09:25:12 +00001651 enc = SQLITE_UTF16BE;
1652 }
danielk197793758c82005-01-21 08:13:14 +00001653#else
1654 enc = SQLITE_UTF8;
1655#endif
danielk19779636c4e2005-01-25 04:27:54 +00001656
1657 /* Check if an existing function is being overridden or deleted. If so,
1658 ** and there are active VMs, then return SQLITE_BUSY. If a function
1659 ** is being overridden/deleted but there are no active VMs, allow the
1660 ** operation to continue but invalidate all precompiled statements.
1661 */
drh80738d92016-02-15 00:34:16 +00001662 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001663 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001664 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001665 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001666 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001667 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001668 return SQLITE_BUSY;
1669 }else{
1670 sqlite3ExpirePreparedStatements(db);
1671 }
1672 }
danielk197765904932004-05-26 06:18:37 +00001673
drh80738d92016-02-15 00:34:16 +00001674 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001675 assert(p || db->mallocFailed);
1676 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00001677 return SQLITE_NOMEM_BKPT;
danielk1977771151b2006-01-17 13:21:40 +00001678 }
dand2199f02010-08-27 17:48:52 +00001679
1680 /* If an older version of the function with a configured destructor is
1681 ** being replaced invoke the destructor function here. */
1682 functionDestroy(db, p);
1683
1684 if( pDestructor ){
1685 pDestructor->nRef++;
1686 }
drh80738d92016-02-15 00:34:16 +00001687 p->u.pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001688 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1689 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
drh2d801512016-01-14 22:19:58 +00001690 p->xSFunc = xSFunc ? xSFunc : xStep;
danielk1977fa18bec2007-09-03 11:04:22 +00001691 p->xFinalize = xFinal;
1692 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001693 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001694 return SQLITE_OK;
1695}
danielk1977771151b2006-01-17 13:21:40 +00001696
1697/*
1698** Create new user functions.
1699*/
1700int sqlite3_create_function(
1701 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001702 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001703 int nArg,
1704 int enc,
1705 void *p,
drh2d801512016-01-14 22:19:58 +00001706 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
danielk1977771151b2006-01-17 13:21:40 +00001707 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1708 void (*xFinal)(sqlite3_context*)
1709){
drh2d801512016-01-14 22:19:58 +00001710 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xSFunc, xStep,
drh7b19fac2010-08-27 18:44:54 +00001711 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001712}
1713
1714int sqlite3_create_function_v2(
1715 sqlite3 *db,
1716 const char *zFunc,
1717 int nArg,
1718 int enc,
1719 void *p,
drh2d801512016-01-14 22:19:58 +00001720 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001721 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1722 void (*xFinal)(sqlite3_context*),
1723 void (*xDestroy)(void *)
1724){
shanehbd2aaf92010-09-01 02:38:21 +00001725 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001726 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001727
1728#ifdef SQLITE_ENABLE_API_ARMOR
1729 if( !sqlite3SafetyCheckOk(db) ){
1730 return SQLITE_MISUSE_BKPT;
1731 }
1732#endif
dand2199f02010-08-27 17:48:52 +00001733 sqlite3_mutex_enter(db->mutex);
1734 if( xDestroy ){
1735 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001736 if( !pArg ){
1737 xDestroy(p);
1738 goto out;
1739 }
dand2199f02010-08-27 17:48:52 +00001740 pArg->xDestroy = xDestroy;
1741 pArg->pUserData = p;
1742 }
drh2d801512016-01-14 22:19:58 +00001743 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xSFunc, xStep, xFinal, pArg);
dand2199f02010-08-27 17:48:52 +00001744 if( pArg && pArg->nRef==0 ){
1745 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001746 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001747 sqlite3DbFree(db, pArg);
1748 }
1749
1750 out:
drhe30f4422007-08-21 16:15:55 +00001751 rc = sqlite3ApiExit(db, rc);
1752 sqlite3_mutex_leave(db->mutex);
1753 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001754}
1755
danielk197793758c82005-01-21 08:13:14 +00001756#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001757int sqlite3_create_function16(
1758 sqlite3 *db,
1759 const void *zFunctionName,
1760 int nArg,
1761 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001762 void *p,
drh2d801512016-01-14 22:19:58 +00001763 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
danielk197765904932004-05-26 06:18:37 +00001764 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1765 void (*xFinal)(sqlite3_context*)
1766){
1767 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001768 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001769
1770#ifdef SQLITE_ENABLE_API_ARMOR
1771 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1772#endif
drhe30f4422007-08-21 16:15:55 +00001773 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001774 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001775 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
drh2d801512016-01-14 22:19:58 +00001776 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001777 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001778 rc = sqlite3ApiExit(db, rc);
1779 sqlite3_mutex_leave(db->mutex);
1780 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001781}
danielk197793758c82005-01-21 08:13:14 +00001782#endif
drhc9b84a12002-06-20 11:36:48 +00001783
drhb7481e72006-09-16 21:45:14 +00001784
1785/*
1786** Declare that a function has been overloaded by a virtual table.
1787**
1788** If the function already exists as a regular global function, then
1789** this routine is a no-op. If the function does not exist, then create
1790** a new one that always throws a run-time error.
1791**
1792** When virtual tables intend to provide an overloaded function, they
1793** should call this routine to make sure the global function exists.
1794** A global function must exist in order for name resolution to work
1795** properly.
1796*/
1797int sqlite3_overload_function(
1798 sqlite3 *db,
1799 const char *zName,
1800 int nArg
1801){
drhcb5e4db2011-10-12 23:49:49 +00001802 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001803
1804#ifdef SQLITE_ENABLE_API_ARMOR
1805 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1806 return SQLITE_MISUSE_BKPT;
1807 }
1808#endif
drhe30f4422007-08-21 16:15:55 +00001809 sqlite3_mutex_enter(db->mutex);
drh80738d92016-02-15 00:34:16 +00001810 if( sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001811 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1812 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001813 }
drhcb5e4db2011-10-12 23:49:49 +00001814 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001815 sqlite3_mutex_leave(db->mutex);
1816 return rc;
drhb7481e72006-09-16 21:45:14 +00001817}
1818
drh19e2d372005-08-29 23:00:03 +00001819#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001820/*
drh18de4822003-01-16 16:28:53 +00001821** Register a trace function. The pArg from the previously registered trace
1822** is returned.
1823**
1824** A NULL trace function means that no tracing is executes. A non-NULL
1825** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001826** SQL statement.
drh18de4822003-01-16 16:28:53 +00001827*/
drh3d2a5292016-07-13 22:55:01 +00001828#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00001829void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001830 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001831
1832#ifdef SQLITE_ENABLE_API_ARMOR
1833 if( !sqlite3SafetyCheckOk(db) ){
1834 (void)SQLITE_MISUSE_BKPT;
1835 return 0;
1836 }
1837#endif
drhe30f4422007-08-21 16:15:55 +00001838 sqlite3_mutex_enter(db->mutex);
1839 pOld = db->pTraceArg;
drh1637a512016-07-13 23:18:27 +00001840 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
drhfca760c2016-07-14 01:09:08 +00001841 db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
drh18de4822003-01-16 16:28:53 +00001842 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001843 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001844 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001845}
drh3d2a5292016-07-13 22:55:01 +00001846#endif /* SQLITE_OMIT_DEPRECATED */
1847
1848/* Register a trace callback using the version-2 interface.
1849*/
1850int sqlite3_trace_v2(
drhfca760c2016-07-14 01:09:08 +00001851 sqlite3 *db, /* Trace this connection */
1852 unsigned mTrace, /* Mask of events to be traced */
1853 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
1854 void *pArg /* Context */
drh3d2a5292016-07-13 22:55:01 +00001855){
1856#ifdef SQLITE_ENABLE_API_ARMOR
1857 if( !sqlite3SafetyCheckOk(db) ){
mistachkin283a85c2016-07-15 00:39:47 +00001858 return SQLITE_MISUSE_BKPT;
drh3d2a5292016-07-13 22:55:01 +00001859 }
1860#endif
1861 sqlite3_mutex_enter(db->mutex);
drhfb828202016-08-25 22:06:37 +00001862 if( mTrace==0 ) xTrace = 0;
1863 if( xTrace==0 ) mTrace = 0;
drh3d2a5292016-07-13 22:55:01 +00001864 db->mTrace = mTrace;
1865 db->xTrace = xTrace;
1866 db->pTraceArg = pArg;
1867 sqlite3_mutex_leave(db->mutex);
1868 return SQLITE_OK;
1869}
1870
drh087ec072016-07-25 00:05:56 +00001871#ifndef SQLITE_OMIT_DEPRECATED
drh19e2d372005-08-29 23:00:03 +00001872/*
1873** Register a profile function. The pArg from the previously registered
1874** profile function is returned.
1875**
1876** A NULL profile function means that no profiling is executes. A non-NULL
1877** profile is a pointer to a function that is invoked at the conclusion of
1878** each SQL statement that is run.
1879*/
1880void *sqlite3_profile(
1881 sqlite3 *db,
1882 void (*xProfile)(void*,const char*,sqlite_uint64),
1883 void *pArg
1884){
drhe30f4422007-08-21 16:15:55 +00001885 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001886
1887#ifdef SQLITE_ENABLE_API_ARMOR
1888 if( !sqlite3SafetyCheckOk(db) ){
1889 (void)SQLITE_MISUSE_BKPT;
1890 return 0;
1891 }
1892#endif
drhe30f4422007-08-21 16:15:55 +00001893 sqlite3_mutex_enter(db->mutex);
1894 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001895 db->xProfile = xProfile;
1896 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001897 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001898 return pOld;
1899}
drh087ec072016-07-25 00:05:56 +00001900#endif /* SQLITE_OMIT_DEPRECATED */
drh19e2d372005-08-29 23:00:03 +00001901#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001902
drhcd565fd2012-03-01 21:30:44 +00001903/*
1904** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001905** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001906** rollback.
1907*/
danielk197724b03fd2004-05-10 10:34:34 +00001908void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001909 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001910 int (*xCallback)(void*), /* Function to invoke on each commit */
1911 void *pArg /* Argument to the function */
1912){
drhe30f4422007-08-21 16:15:55 +00001913 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001914
1915#ifdef SQLITE_ENABLE_API_ARMOR
1916 if( !sqlite3SafetyCheckOk(db) ){
1917 (void)SQLITE_MISUSE_BKPT;
1918 return 0;
1919 }
1920#endif
drhe30f4422007-08-21 16:15:55 +00001921 sqlite3_mutex_enter(db->mutex);
1922 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001923 db->xCommitCallback = xCallback;
1924 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001925 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001926 return pOld;
1927}
1928
danielk197794eb6a12005-12-15 15:22:08 +00001929/*
1930** Register a callback to be invoked each time a row is updated,
1931** inserted or deleted using this database connection.
1932*/
danielk197771fd80b2005-12-16 06:54:01 +00001933void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001934 sqlite3 *db, /* Attach the hook to this database */
1935 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1936 void *pArg /* Argument to the function */
1937){
drhe30f4422007-08-21 16:15:55 +00001938 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001939
1940#ifdef SQLITE_ENABLE_API_ARMOR
1941 if( !sqlite3SafetyCheckOk(db) ){
1942 (void)SQLITE_MISUSE_BKPT;
1943 return 0;
1944 }
1945#endif
drhe30f4422007-08-21 16:15:55 +00001946 sqlite3_mutex_enter(db->mutex);
1947 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001948 db->xUpdateCallback = xCallback;
1949 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001950 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001951 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001952}
1953
danielk197771fd80b2005-12-16 06:54:01 +00001954/*
1955** Register a callback to be invoked each time a transaction is rolled
1956** back by this database connection.
1957*/
1958void *sqlite3_rollback_hook(
1959 sqlite3 *db, /* Attach the hook to this database */
1960 void (*xCallback)(void*), /* Callback function */
1961 void *pArg /* Argument to the function */
1962){
drhe30f4422007-08-21 16:15:55 +00001963 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001964
1965#ifdef SQLITE_ENABLE_API_ARMOR
1966 if( !sqlite3SafetyCheckOk(db) ){
1967 (void)SQLITE_MISUSE_BKPT;
1968 return 0;
1969 }
1970#endif
drhe30f4422007-08-21 16:15:55 +00001971 sqlite3_mutex_enter(db->mutex);
1972 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001973 db->xRollbackCallback = xCallback;
1974 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001975 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001976 return pRet;
1977}
drhaa940ea2004-01-15 02:44:03 +00001978
drh9b1c62d2011-03-30 21:04:43 +00001979#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00001980/*
1981** Register a callback to be invoked each time a row is updated,
1982** inserted or deleted using this database connection.
1983*/
1984void *sqlite3_preupdate_hook(
1985 sqlite3 *db, /* Attach the hook to this database */
1986 void(*xCallback)( /* Callback function */
1987 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
1988 void *pArg /* First callback argument */
1989){
1990 void *pRet;
1991 sqlite3_mutex_enter(db->mutex);
1992 pRet = db->pPreUpdateArg;
1993 db->xPreUpdateCallback = xCallback;
1994 db->pPreUpdateArg = pArg;
1995 sqlite3_mutex_leave(db->mutex);
1996 return pRet;
1997}
drh9b1c62d2011-03-30 21:04:43 +00001998#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan46c47d42011-03-01 18:42:07 +00001999
dan586b9c82010-05-03 08:04:49 +00002000#ifndef SQLITE_OMIT_WAL
2001/*
2002** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00002003** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2004** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00002005** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00002006*/
drhb033d8b2010-05-03 13:37:30 +00002007int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00002008 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00002009 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00002010 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00002011 int nFrame /* Size of WAL */
2012){
drh5def0842010-05-05 20:00:25 +00002013 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00002014 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002015 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00002016 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00002017 }
2018 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00002019}
drhb033d8b2010-05-03 13:37:30 +00002020#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002021
2022/*
2023** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2024** a database after committing a transaction if there are nFrame or
2025** more frames in the log file. Passing zero or a negative value as the
2026** nFrame parameter disables automatic checkpoints entirely.
2027**
2028** The callback registered by this function replaces any existing callback
2029** registered using sqlite3_wal_hook(). Likewise, registering a callback
2030** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2031** configured by this function.
2032*/
2033int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00002034#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00002035 UNUSED_PARAMETER(db);
2036 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00002037#else
drh9ca95732014-10-24 00:35:58 +00002038#ifdef SQLITE_ENABLE_API_ARMOR
2039 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2040#endif
dan586b9c82010-05-03 08:04:49 +00002041 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00002042 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00002043 }else{
2044 sqlite3_wal_hook(db, 0, 0);
2045 }
drhb033d8b2010-05-03 13:37:30 +00002046#endif
dan586b9c82010-05-03 08:04:49 +00002047 return SQLITE_OK;
2048}
2049
paulb0208cc2003-04-13 18:26:49 +00002050/*
dan8d22a172010-04-19 18:03:51 +00002051** Register a callback to be invoked each time a transaction is written
2052** into the write-ahead-log by this database connection.
2053*/
drh833bf962010-04-28 14:42:19 +00002054void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00002055 sqlite3 *db, /* Attach the hook to this db handle */
2056 int(*xCallback)(void *, sqlite3*, const char*, int),
2057 void *pArg /* First argument passed to xCallback() */
2058){
drhb033d8b2010-05-03 13:37:30 +00002059#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00002060 void *pRet;
drh9ca95732014-10-24 00:35:58 +00002061#ifdef SQLITE_ENABLE_API_ARMOR
2062 if( !sqlite3SafetyCheckOk(db) ){
2063 (void)SQLITE_MISUSE_BKPT;
2064 return 0;
2065 }
2066#endif
dan8d22a172010-04-19 18:03:51 +00002067 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00002068 pRet = db->pWalArg;
2069 db->xWalCallback = xCallback;
2070 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00002071 sqlite3_mutex_leave(db->mutex);
2072 return pRet;
drhb033d8b2010-05-03 13:37:30 +00002073#else
2074 return 0;
2075#endif
dan8d22a172010-04-19 18:03:51 +00002076}
2077
2078/*
dancdc1f042010-11-18 12:11:05 +00002079** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00002080*/
dancdc1f042010-11-18 12:11:05 +00002081int sqlite3_wal_checkpoint_v2(
2082 sqlite3 *db, /* Database handle */
2083 const char *zDb, /* Name of attached database (or NULL) */
2084 int eMode, /* SQLITE_CHECKPOINT_* value */
2085 int *pnLog, /* OUT: Size of WAL log in frames */
2086 int *pnCkpt /* OUT: Total number of frames checkpointed */
2087){
drhb033d8b2010-05-03 13:37:30 +00002088#ifdef SQLITE_OMIT_WAL
2089 return SQLITE_OK;
2090#else
dan586b9c82010-05-03 08:04:49 +00002091 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00002092 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00002093
drh9ca95732014-10-24 00:35:58 +00002094#ifdef SQLITE_ENABLE_API_ARMOR
2095 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2096#endif
2097
dan9c5e3682011-02-07 15:12:12 +00002098 /* Initialize the output variables to -1 in case an error occurs. */
2099 if( pnLog ) *pnLog = -1;
2100 if( pnCkpt ) *pnCkpt = -1;
2101
danf26a1542014-12-02 19:04:54 +00002102 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2103 assert( SQLITE_CHECKPOINT_FULL==1 );
2104 assert( SQLITE_CHECKPOINT_RESTART==2 );
2105 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2106 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00002107 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2108 ** mode: */
dancdc1f042010-11-18 12:11:05 +00002109 return SQLITE_MISUSE;
2110 }
2111
dan586b9c82010-05-03 08:04:49 +00002112 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00002113 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00002114 iDb = sqlite3FindDbName(db, zDb);
2115 }
2116 if( iDb<0 ){
2117 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00002118 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00002119 }else{
dan976b0032015-01-29 19:12:12 +00002120 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00002121 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00002122 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00002123 }
drhb033d8b2010-05-03 13:37:30 +00002124 rc = sqlite3ApiExit(db, rc);
dan7fb89902016-08-12 16:21:15 +00002125
2126 /* If there are no active statements, clear the interrupt flag at this
2127 ** point. */
2128 if( db->nVdbeActive==0 ){
2129 db->u1.isInterrupted = 0;
2130 }
2131
dan586b9c82010-05-03 08:04:49 +00002132 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00002133 return rc;
2134#endif
dan586b9c82010-05-03 08:04:49 +00002135}
2136
dancdc1f042010-11-18 12:11:05 +00002137
2138/*
2139** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2140** to contains a zero-length string, all attached databases are
2141** checkpointed.
2142*/
2143int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002144 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2145 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2146 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002147}
2148
drhb033d8b2010-05-03 13:37:30 +00002149#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002150/*
2151** Run a checkpoint on database iDb. This is a no-op if database iDb is
2152** not currently open in WAL mode.
2153**
dan6fcff072010-05-03 14:05:43 +00002154** If a transaction is open on the database being checkpointed, this
2155** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2156** an error occurs while running the checkpoint, an SQLite error code is
2157** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002158**
2159** The mutex on database handle db should be held by the caller. The mutex
2160** associated with the specific b-tree being checkpointed is taken by
2161** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002162**
2163** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2164** checkpointed. If an error is encountered it is returned immediately -
2165** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002166**
dancdc1f042010-11-18 12:11:05 +00002167** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00002168*/
dancdc1f042010-11-18 12:11:05 +00002169int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002170 int rc = SQLITE_OK; /* Return code */
2171 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002172 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002173
2174 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002175 assert( !pnLog || *pnLog==-1 );
2176 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002177
dan6fcff072010-05-03 14:05:43 +00002178 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2179 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002180 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002181 pnLog = 0;
2182 pnCkpt = 0;
2183 if( rc==SQLITE_BUSY ){
2184 bBusy = 1;
2185 rc = SQLITE_OK;
2186 }
dan6fcff072010-05-03 14:05:43 +00002187 }
dan586b9c82010-05-03 08:04:49 +00002188 }
2189
danf2b8dd52010-11-18 19:28:01 +00002190 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002191}
drhb033d8b2010-05-03 13:37:30 +00002192#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002193
2194/*
danielk1977d8293352009-04-30 09:10:37 +00002195** This function returns true if main-memory should be used instead of
2196** a temporary file for transient pager files and statement journals.
2197** The value returned depends on the value of db->temp_store (runtime
2198** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2199** following table describes the relationship between these two values
2200** and this functions return value.
2201**
2202** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2203** ----------------- -------------- ------------------------------
2204** 0 any file (return 0)
2205** 1 1 file (return 0)
2206** 1 2 memory (return 1)
2207** 1 0 file (return 0)
2208** 2 1 file (return 0)
2209** 2 2 memory (return 1)
2210** 2 0 memory (return 1)
2211** 3 any memory (return 1)
2212*/
drh1c514142009-04-30 12:25:10 +00002213int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002214#if SQLITE_TEMP_STORE==1
2215 return ( db->temp_store==2 );
2216#endif
2217#if SQLITE_TEMP_STORE==2
2218 return ( db->temp_store!=1 );
2219#endif
2220#if SQLITE_TEMP_STORE==3
drhf5ed7ad2015-06-15 14:43:25 +00002221 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002222 return 1;
shanecf697392009-06-01 16:53:09 +00002223#endif
2224#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
drhf5ed7ad2015-06-15 14:43:25 +00002225 UNUSED_PARAMETER(db);
danielk1977d8293352009-04-30 09:10:37 +00002226 return 0;
shane60a4b532009-05-06 18:57:09 +00002227#endif
danielk1977d8293352009-04-30 09:10:37 +00002228}
2229
2230/*
danielk19774ad17132004-05-21 01:47:26 +00002231** Return UTF-8 encoded English language explanation of the most recent
2232** error.
2233*/
danielk19776622cce2004-05-20 11:00:52 +00002234const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002235 const char *z;
drhf49661a2008-12-10 16:45:50 +00002236 if( !db ){
mistachkinfad30392016-02-13 23:43:46 +00002237 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk19774ad17132004-05-21 01:47:26 +00002238 }
drhd55d57e2008-07-07 17:53:07 +00002239 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002240 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002241 }
drh27641702007-08-22 02:56:42 +00002242 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002243 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002244 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
danielk1977238746a2009-03-19 18:51:06 +00002245 }else{
drha3cc0072013-12-13 16:23:55 +00002246 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002247 z = (char*)sqlite3_value_text(db->pErr);
2248 assert( !db->mallocFailed );
2249 if( z==0 ){
2250 z = sqlite3ErrStr(db->errCode);
2251 }
danielk19776622cce2004-05-20 11:00:52 +00002252 }
drhe30f4422007-08-21 16:15:55 +00002253 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002254 return z;
danielk19776622cce2004-05-20 11:00:52 +00002255}
2256
drh6c626082004-11-14 21:56:29 +00002257#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002258/*
2259** Return UTF-16 encoded English language explanation of the most recent
2260** error.
2261*/
danielk19776622cce2004-05-20 11:00:52 +00002262const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002263 static const u16 outOfMem[] = {
2264 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002265 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002266 static const u16 misuse[] = {
2267 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2268 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2269 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2270 'o', 'u', 't', ' ',
2271 'o', 'f', ' ',
2272 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002273 };
danielk19774ad17132004-05-21 01:47:26 +00002274
drhc60d0442004-09-30 13:43:13 +00002275 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002276 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002277 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002278 }
drhd55d57e2008-07-07 17:53:07 +00002279 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002280 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002281 }
drhe30f4422007-08-21 16:15:55 +00002282 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002283 if( db->mallocFailed ){
2284 z = (void *)outOfMem;
2285 }else{
drhc60d0442004-09-30 13:43:13 +00002286 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002287 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002288 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002289 z = sqlite3_value_text16(db->pErr);
2290 }
2291 /* A malloc() may have failed within the call to sqlite3_value_text16()
2292 ** above. If this is the case, then the db->mallocFailed flag needs to
2293 ** be cleared before returning. Do this directly, instead of via
2294 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2295 */
drh4a642b62016-02-05 01:55:27 +00002296 sqlite3OomClear(db);
drhc60d0442004-09-30 13:43:13 +00002297 }
drhe30f4422007-08-21 16:15:55 +00002298 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002299 return z;
danielk19776622cce2004-05-20 11:00:52 +00002300}
drh6c626082004-11-14 21:56:29 +00002301#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002302
drhc60d0442004-09-30 13:43:13 +00002303/*
danielk19777ddad962005-12-12 06:53:03 +00002304** Return the most recent error code generated by an SQLite routine. If NULL is
2305** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002306*/
danielk19776622cce2004-05-20 11:00:52 +00002307int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002308 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002309 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002310 }
drh01495b92008-01-23 12:52:40 +00002311 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002312 return SQLITE_NOMEM_BKPT;
drh01495b92008-01-23 12:52:40 +00002313 }
drh4ac285a2006-09-15 07:28:50 +00002314 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002315}
drh99dfe5e2008-10-30 15:03:15 +00002316int sqlite3_extended_errcode(sqlite3 *db){
2317 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002318 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002319 }
2320 if( !db || db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002321 return SQLITE_NOMEM_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002322 }
2323 return db->errCode;
2324}
drh1b9f2142016-03-17 16:01:23 +00002325int sqlite3_system_errno(sqlite3 *db){
2326 return db ? db->iSysErrno : 0;
2327}
danielk19776622cce2004-05-20 11:00:52 +00002328
drh0e819f92006-02-01 13:50:41 +00002329/*
mistachkin5dac8432012-09-11 02:00:25 +00002330** Return a string that describes the kind of error specified in the
2331** argument. For now, this simply calls the internal sqlite3ErrStr()
2332** function.
2333*/
2334const char *sqlite3_errstr(int rc){
2335 return sqlite3ErrStr(rc);
2336}
2337
2338/*
drh0e819f92006-02-01 13:50:41 +00002339** Create a new collating function for database "db". The name is zName
2340** and the encoding is enc.
2341*/
danielk19779a30cf62006-01-18 04:26:07 +00002342static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002343 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002344 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002345 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002346 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002347 int(*xCompare)(void*,int,const void*,int,const void*),
2348 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002349){
2350 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002351 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002352
drhe30f4422007-08-21 16:15:55 +00002353 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002354
2355 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2356 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2357 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2358 */
drh51c7d862009-04-27 18:46:06 +00002359 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002360 testcase( enc2==SQLITE_UTF16 );
2361 testcase( enc2==SQLITE_UTF16_ALIGNED );
2362 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002363 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002364 }
drh51c7d862009-04-27 18:46:06 +00002365 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002366 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002367 }
2368
2369 /* Check if this call is removing or replacing an existing collation
2370 ** sequence. If so, and there are active VMs, return busy. If there
2371 ** are no active VMs, invalidate any pre-compiled statements.
2372 */
drhc4a64fa2009-05-11 20:53:28 +00002373 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002374 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002375 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002376 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002377 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002378 return SQLITE_BUSY;
2379 }
2380 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00002381
2382 /* If collation sequence pColl was created directly by a call to
2383 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2384 ** then any copies made by synthCollSeq() need to be invalidated.
2385 ** Also, collation destructor - CollSeq.xDel() - function may need
2386 ** to be called.
2387 */
2388 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002389 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002390 int j;
2391 for(j=0; j<3; j++){
2392 CollSeq *p = &aColl[j];
2393 if( p->enc==pColl->enc ){
2394 if( p->xDel ){
2395 p->xDel(p->pUser);
2396 }
2397 p->xCmp = 0;
2398 }
2399 }
2400 }
danielk19779a30cf62006-01-18 04:26:07 +00002401 }
2402
drhc4a64fa2009-05-11 20:53:28 +00002403 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
mistachkinfad30392016-02-13 23:43:46 +00002404 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
drh88404c22010-10-11 17:58:21 +00002405 pColl->xCmp = xCompare;
2406 pColl->pUser = pCtx;
2407 pColl->xDel = xDel;
2408 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002409 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002410 return SQLITE_OK;
2411}
2412
2413
danielk19776622cce2004-05-20 11:00:52 +00002414/*
drhbb4957f2008-03-20 14:03:29 +00002415** This array defines hard upper bounds on limit values. The
2416** initializer must be kept in sync with the SQLITE_LIMIT_*
2417** #defines in sqlite3.h.
2418*/
drhb1a6c3c2008-03-20 16:30:17 +00002419static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002420 SQLITE_MAX_LENGTH,
2421 SQLITE_MAX_SQL_LENGTH,
2422 SQLITE_MAX_COLUMN,
2423 SQLITE_MAX_EXPR_DEPTH,
2424 SQLITE_MAX_COMPOUND_SELECT,
2425 SQLITE_MAX_VDBE_OP,
2426 SQLITE_MAX_FUNCTION_ARG,
2427 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002428 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002429 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002430 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002431 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002432};
2433
2434/*
2435** Make sure the hard limits are set to reasonable values
2436*/
2437#if SQLITE_MAX_LENGTH<100
2438# error SQLITE_MAX_LENGTH must be at least 100
2439#endif
2440#if SQLITE_MAX_SQL_LENGTH<100
2441# error SQLITE_MAX_SQL_LENGTH must be at least 100
2442#endif
2443#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2444# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2445#endif
drhbb4957f2008-03-20 14:03:29 +00002446#if SQLITE_MAX_COMPOUND_SELECT<2
2447# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2448#endif
2449#if SQLITE_MAX_VDBE_OP<40
2450# error SQLITE_MAX_VDBE_OP must be at least 40
2451#endif
drh80738d92016-02-15 00:34:16 +00002452#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2453# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
drhbb4957f2008-03-20 14:03:29 +00002454#endif
drhd08b2792014-07-22 15:33:31 +00002455#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2456# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002457#endif
drhbb4957f2008-03-20 14:03:29 +00002458#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2459# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2460#endif
drh70a8ca32008-08-21 18:49:27 +00002461#if SQLITE_MAX_COLUMN>32767
2462# error SQLITE_MAX_COLUMN must not exceed 32767
2463#endif
drh417168a2009-09-07 18:14:02 +00002464#if SQLITE_MAX_TRIGGER_DEPTH<1
2465# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2466#endif
drh111544c2014-08-29 16:20:47 +00002467#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2468# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2469#endif
drhbb4957f2008-03-20 14:03:29 +00002470
2471
2472/*
2473** Change the value of a limit. Report the old value.
2474** If an invalid limit index is supplied, report -1.
2475** Make no changes but still report the old value if the
2476** new limit is negative.
2477**
2478** A new lower limit does not shrink existing constructs.
2479** It merely prevents new constructs that exceed the limit
2480** from forming.
2481*/
2482int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2483 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002484
drh9ca95732014-10-24 00:35:58 +00002485#ifdef SQLITE_ENABLE_API_ARMOR
2486 if( !sqlite3SafetyCheckOk(db) ){
2487 (void)SQLITE_MISUSE_BKPT;
2488 return -1;
2489 }
2490#endif
drh4e93f5b2010-09-07 14:59:15 +00002491
2492 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2493 ** there is a hard upper bound set at compile-time by a C preprocessor
2494 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2495 ** "_MAX_".)
2496 */
2497 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2498 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2499 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2500 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2501 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2502 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2503 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2504 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2505 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2506 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2507 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2508 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002509 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2510 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002511
2512
drh521cc842008-04-15 02:36:33 +00002513 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002514 return -1;
2515 }
2516 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002517 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002518 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002519 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002520 }
2521 db->aLimit[limitId] = newLimit;
2522 }
drh4e93f5b2010-09-07 14:59:15 +00002523 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002524}
2525
2526/*
dan286ab7c2011-05-06 18:34:54 +00002527** This function is used to parse both URIs and non-URI filenames passed by the
2528** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2529** URIs specified as part of ATTACH statements.
2530**
2531** The first argument to this function is the name of the VFS to use (or
2532** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2533** query parameter. The second argument contains the URI (or non-URI filename)
2534** itself. When this function is called the *pFlags variable should contain
2535** the default flags to open the database handle with. The value stored in
2536** *pFlags may be updated before returning if the URI filename contains
2537** "cache=xxx" or "mode=xxx" query parameters.
2538**
2539** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2540** the VFS that should be used to open the database file. *pzFile is set to
2541** point to a buffer containing the name of the file to open. It is the
2542** responsibility of the caller to eventually call sqlite3_free() to release
2543** this buffer.
2544**
2545** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2546** may be set to point to a buffer containing an English language error
2547** message. It is the responsibility of the caller to eventually release
2548** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002549*/
2550int sqlite3ParseUri(
2551 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2552 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002553 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002554 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2555 char **pzFile, /* OUT: Filename component of URI */
2556 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2557){
dan78e9dd22011-05-03 10:22:32 +00002558 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002559 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002560 const char *zVfs = zDefaultVfs;
2561 char *zFile;
drhde941c32011-05-09 19:20:17 +00002562 char c;
dancd74b612011-04-22 19:37:32 +00002563 int nUri = sqlite3Strlen30(zUri);
2564
2565 assert( *pzErrMsg==0 );
2566
drh8790b6e2014-11-07 01:43:56 +00002567 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2568 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002569 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002570 ){
dan5de15372011-04-23 10:12:30 +00002571 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002572 int eState; /* Parser state when parsing URI */
2573 int iIn; /* Input character index */
2574 int iOut = 0; /* Output character index */
drhf3cdcdc2015-04-29 16:50:28 +00002575 u64 nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002576
dan286ab7c2011-05-06 18:34:54 +00002577 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2578 ** method that there may be extra parameters following the file-name. */
2579 flags |= SQLITE_OPEN_URI;
2580
2581 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
drhf3cdcdc2015-04-29 16:50:28 +00002582 zFile = sqlite3_malloc64(nByte);
mistachkinfad30392016-02-13 23:43:46 +00002583 if( !zFile ) return SQLITE_NOMEM_BKPT;
dancd74b612011-04-22 19:37:32 +00002584
drh869c0402013-08-07 23:15:52 +00002585 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002586#ifdef SQLITE_ALLOW_URI_AUTHORITY
2587 if( strncmp(zUri+5, "///", 3)==0 ){
2588 iIn = 7;
2589 /* The following condition causes URIs with five leading / characters
2590 ** like file://///host/path to be converted into UNCs like //host/path.
2591 ** The correct URI for that UNC has only two or four leading / characters
2592 ** file://host/path or file:////host/path. But 5 leading slashes is a
2593 ** common error, we are told, so we handle it as a special case. */
2594 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2595 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2596 iIn = 16;
2597 }
2598#else
dancd74b612011-04-22 19:37:32 +00002599 /* Discard the scheme and authority segments of the URI. */
2600 if( zUri[5]=='/' && zUri[6]=='/' ){
2601 iIn = 7;
2602 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002603 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2604 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2605 iIn-7, &zUri[7]);
2606 rc = SQLITE_ERROR;
2607 goto parse_uri_out;
2608 }
dancd74b612011-04-22 19:37:32 +00002609 }
drh869c0402013-08-07 23:15:52 +00002610#endif
dancd74b612011-04-22 19:37:32 +00002611
2612 /* Copy the filename and any query parameters into the zFile buffer.
2613 ** Decode %HH escape codes along the way.
2614 **
2615 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2616 ** on the parsing context. As follows:
2617 **
2618 ** 0: Parsing file-name.
2619 ** 1: Parsing name section of a name=value query parameter.
2620 ** 2: Parsing value section of a name=value query parameter.
2621 */
2622 eState = 0;
drhde941c32011-05-09 19:20:17 +00002623 while( (c = zUri[iIn])!=0 && c!='#' ){
2624 iIn++;
dancd74b612011-04-22 19:37:32 +00002625 if( c=='%'
2626 && sqlite3Isxdigit(zUri[iIn])
2627 && sqlite3Isxdigit(zUri[iIn+1])
2628 ){
dan6d49e252011-05-03 15:09:05 +00002629 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2630 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002631
dan6d49e252011-05-03 15:09:05 +00002632 assert( octet>=0 && octet<256 );
2633 if( octet==0 ){
dan5c35e902016-10-26 12:15:41 +00002634#ifndef SQLITE_ENABLE_URI_00_ERROR
dan5de15372011-04-23 10:12:30 +00002635 /* This branch is taken when "%00" appears within the URI. In this
2636 ** case we ignore all text in the remainder of the path, name or
2637 ** value currently being parsed. So ignore the current character
2638 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002639 while( (c = zUri[iIn])!=0 && c!='#'
2640 && (eState!=0 || c!='?')
2641 && (eState!=1 || (c!='=' && c!='&'))
2642 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002643 ){
2644 iIn++;
2645 }
2646 continue;
dan5c35e902016-10-26 12:15:41 +00002647#else
2648 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2649 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2650 rc = SQLITE_ERROR;
2651 goto parse_uri_out;
2652#endif
dancd74b612011-04-22 19:37:32 +00002653 }
dan6d49e252011-05-03 15:09:05 +00002654 c = octet;
dan5de15372011-04-23 10:12:30 +00002655 }else if( eState==1 && (c=='&' || c=='=') ){
2656 if( zFile[iOut-1]==0 ){
2657 /* An empty option name. Ignore this option altogether. */
2658 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2659 continue;
2660 }
2661 if( c=='&' ){
2662 zFile[iOut++] = '\0';
2663 }else{
2664 eState = 2;
2665 }
dancd74b612011-04-22 19:37:32 +00002666 c = 0;
dan5de15372011-04-23 10:12:30 +00002667 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2668 c = 0;
dancd74b612011-04-22 19:37:32 +00002669 eState = 1;
dancd74b612011-04-22 19:37:32 +00002670 }
2671 zFile[iOut++] = c;
2672 }
2673 if( eState==1 ) zFile[iOut++] = '\0';
2674 zFile[iOut++] = '\0';
2675 zFile[iOut++] = '\0';
2676
2677 /* Check if there were any options specified that should be interpreted
2678 ** here. Options that are interpreted here include "vfs" and those that
2679 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002680 ** method. */
dan5de15372011-04-23 10:12:30 +00002681 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2682 while( zOpt[0] ){
2683 int nOpt = sqlite3Strlen30(zOpt);
2684 char *zVal = &zOpt[nOpt+1];
2685 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002686
dan286ab7c2011-05-06 18:34:54 +00002687 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002688 zVfs = zVal;
2689 }else{
2690 struct OpenMode {
2691 const char *z;
2692 int mode;
2693 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002694 char *zModeType = 0;
2695 int mask = 0;
2696 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002697
dan286ab7c2011-05-06 18:34:54 +00002698 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002699 static struct OpenMode aCacheMode[] = {
2700 { "shared", SQLITE_OPEN_SHAREDCACHE },
2701 { "private", SQLITE_OPEN_PRIVATECACHE },
2702 { 0, 0 }
2703 };
2704
2705 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2706 aMode = aCacheMode;
2707 limit = mask;
2708 zModeType = "cache";
2709 }
dan286ab7c2011-05-06 18:34:54 +00002710 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002711 static struct OpenMode aOpenMode[] = {
2712 { "ro", SQLITE_OPEN_READONLY },
2713 { "rw", SQLITE_OPEN_READWRITE },
2714 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002715 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002716 { 0, 0 }
2717 };
2718
drh9c67b2a2012-05-28 13:58:00 +00002719 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2720 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002721 aMode = aOpenMode;
2722 limit = mask & flags;
2723 zModeType = "access";
2724 }
2725
2726 if( aMode ){
2727 int i;
2728 int mode = 0;
2729 for(i=0; aMode[i].z; i++){
2730 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002731 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002732 mode = aMode[i].mode;
2733 break;
dancd74b612011-04-22 19:37:32 +00002734 }
2735 }
dan78e9dd22011-05-03 10:22:32 +00002736 if( mode==0 ){
2737 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2738 rc = SQLITE_ERROR;
2739 goto parse_uri_out;
2740 }
drh9c67b2a2012-05-28 13:58:00 +00002741 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002742 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2743 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002744 rc = SQLITE_PERM;
2745 goto parse_uri_out;
2746 }
2747 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002748 }
dancd74b612011-04-22 19:37:32 +00002749 }
dan5de15372011-04-23 10:12:30 +00002750
2751 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002752 }
2753
2754 }else{
drhf3cdcdc2015-04-29 16:50:28 +00002755 zFile = sqlite3_malloc64(nUri+2);
mistachkinfad30392016-02-13 23:43:46 +00002756 if( !zFile ) return SQLITE_NOMEM_BKPT;
dan895decf2016-12-30 14:15:56 +00002757 if( nUri ){
2758 memcpy(zFile, zUri, nUri);
2759 }
dancd74b612011-04-22 19:37:32 +00002760 zFile[nUri] = '\0';
2761 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002762 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002763 }
2764
2765 *ppVfs = sqlite3_vfs_find(zVfs);
2766 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002767 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002768 rc = SQLITE_ERROR;
2769 }
2770 parse_uri_out:
2771 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002772 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002773 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002774 }
2775 *pFlags = flags;
2776 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002777 return rc;
dancd74b612011-04-22 19:37:32 +00002778}
2779
2780
2781/*
danielk19774ad17132004-05-21 01:47:26 +00002782** This routine does the work of opening a database on behalf of
2783** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002784** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002785*/
2786static int openDatabase(
2787 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002788 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002789 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002790 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002791){
dancd74b612011-04-22 19:37:32 +00002792 sqlite3 *db; /* Store allocated handle here */
2793 int rc; /* Return code */
2794 int isThreadsafe; /* True for threadsafe connections */
2795 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2796 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002797
drh9ca95732014-10-24 00:35:58 +00002798#ifdef SQLITE_ENABLE_API_ARMOR
2799 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2800#endif
drhe0d0f8e2009-04-28 04:47:31 +00002801 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002802#ifndef SQLITE_OMIT_AUTOINIT
2803 rc = sqlite3_initialize();
2804 if( rc ) return rc;
2805#endif
2806
drh357b5f92010-08-24 18:07:57 +00002807 /* Only allow sensible combinations of bits in the flags argument.
2808 ** Throw an error if any non-sense combination is used. If we
2809 ** do not block illegal combinations here, it could trigger
2810 ** assert() statements in deeper layers. Sensible combinations
2811 ** are:
2812 **
2813 ** 1: SQLITE_OPEN_READONLY
2814 ** 2: SQLITE_OPEN_READWRITE
2815 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2816 */
2817 assert( SQLITE_OPEN_READONLY == 0x01 );
2818 assert( SQLITE_OPEN_READWRITE == 0x02 );
2819 assert( SQLITE_OPEN_CREATE == 0x04 );
2820 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2821 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2822 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002823 if( ((1<<(flags&7)) & 0x46)==0 ){
2824 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2825 }
drh357b5f92010-08-24 18:07:57 +00002826
drh039963a2008-09-03 00:43:15 +00002827 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002828 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002829 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2830 isThreadsafe = 0;
2831 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2832 isThreadsafe = 1;
2833 }else{
2834 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002835 }
drhf1f12682009-09-09 14:17:52 +00002836 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002837 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002838 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2839 flags |= SQLITE_OPEN_SHAREDCACHE;
2840 }
danielk19779a6284c2008-07-10 17:52:49 +00002841
drhb25a9f42009-05-12 13:35:11 +00002842 /* Remove harmful bits from the flags parameter
2843 **
2844 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2845 ** dealt with in the previous code block. Besides these, the only
2846 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002847 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2848 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002849 ** off all other flags.
2850 */
drha4267dc2008-02-19 15:20:44 +00002851 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002852 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002853 SQLITE_OPEN_MAIN_DB |
2854 SQLITE_OPEN_TEMP_DB |
2855 SQLITE_OPEN_TRANSIENT_DB |
2856 SQLITE_OPEN_MAIN_JOURNAL |
2857 SQLITE_OPEN_TEMP_JOURNAL |
2858 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002859 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002860 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002861 SQLITE_OPEN_FULLMUTEX |
2862 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002863 );
2864
danielk19774ad17132004-05-21 01:47:26 +00002865 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002866 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002867 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002868 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002869 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2870 if( db->mutex==0 ){
2871 sqlite3_free(db);
2872 db = 0;
2873 goto opendb_out;
2874 }
drh605264d2007-08-21 15:13:19 +00002875 }
drh27641702007-08-22 02:56:42 +00002876 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002877 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002878 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002879 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002880 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002881
drhbb4957f2008-03-20 14:03:29 +00002882 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2883 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002884 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002885 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002886 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002887 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002888 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002889 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002890 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002891#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002892 | SQLITE_AutoIndex
2893#endif
drh883ad042015-02-19 00:29:11 +00002894#if SQLITE_DEFAULT_CKPTFULLFSYNC
2895 | SQLITE_CkptFullFSync
2896#endif
drh76fe8032006-07-11 14:17:51 +00002897#if SQLITE_DEFAULT_FILE_FORMAT<4
2898 | SQLITE_LegacyFileFmt
2899#endif
drh56424db2007-03-27 22:24:11 +00002900#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2901 | SQLITE_LoadExtension
2902#endif
dan5bde73c2009-09-01 17:11:07 +00002903#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002904 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002905#endif
drha4bfd7f2010-12-09 19:15:17 +00002906#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2907 | SQLITE_ForeignKeys
2908#endif
drhf5471922014-12-09 15:12:11 +00002909#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
2910 | SQLITE_ReverseOrder
2911#endif
drh1421d982015-05-27 03:46:18 +00002912#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
2913 | SQLITE_CellSizeCk
2914#endif
drhd42908f2016-02-26 15:38:24 +00002915#if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
2916 | SQLITE_Fts3Tokenizer
2917#endif
drh76fe8032006-07-11 14:17:51 +00002918 ;
drhe61922a2009-05-02 13:29:37 +00002919 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002920#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002921 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002922#endif
danielk1977da184232006-01-05 11:34:32 +00002923
danielk19770202b292004-06-09 09:55:16 +00002924 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2925 ** and UTF-16, so add a version for each to avoid any unnecessary
2926 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00002927 **
2928 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
2929 ** functions:
danielk19770202b292004-06-09 09:55:16 +00002930 */
drhf19aa5f2015-12-30 16:51:20 +00002931 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
2932 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
2933 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00002934 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00002935 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002936 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002937 goto opendb_out;
2938 }
drh5e3b49b2014-11-20 19:22:26 +00002939 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
2940 ** strings is BINARY.
2941 */
drhf19aa5f2015-12-30 16:51:20 +00002942 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
drh77db4c02008-03-18 13:01:38 +00002943 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002944
dancd74b612011-04-22 19:37:32 +00002945 /* Parse the filename/URI argument. */
drh33f4e022007-09-03 15:19:34 +00002946 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002947 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2948 if( rc!=SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00002949 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
drh13f40da2014-08-22 18:00:11 +00002950 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002951 sqlite3_free(zErrMsg);
2952 goto opendb_out;
2953 }
2954
danielk19774ad17132004-05-21 01:47:26 +00002955 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002956 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002957 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002958 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002959 if( rc==SQLITE_IOERR_NOMEM ){
mistachkinfad30392016-02-13 23:43:46 +00002960 rc = SQLITE_NOMEM_BKPT;
danielk197745e60aa2008-09-23 17:39:26 +00002961 }
drh13f40da2014-08-22 18:00:11 +00002962 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002963 goto opendb_out;
2964 }
dan0235a032014-12-08 20:20:16 +00002965 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002966 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00002967 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00002968 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002969 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002970
drhe872d512016-02-22 13:23:16 +00002971 /* The default safety_level for the main database is FULL; for the temp
2972 ** database it is OFF. This matches the pager layer defaults.
danielk197753c0f742005-03-29 03:10:59 +00002973 */
drh69c33822016-08-18 14:33:11 +00002974 db->aDb[0].zDbSName = "main";
drhc2ae2072016-03-08 15:30:01 +00002975 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
drh69c33822016-08-18 14:33:11 +00002976 db->aDb[1].zDbSName = "temp";
drhe872d512016-02-22 13:23:16 +00002977 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
danielk197753c0f742005-03-29 03:10:59 +00002978
danielk1977832a58a2007-06-22 15:21:15 +00002979 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002980 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002981 goto opendb_out;
2982 }
2983
danielk19778e227872004-06-07 07:52:17 +00002984 /* Register all built-in functions, but do not attempt to read the
2985 ** database schema yet. This is delayed until the first time the database
2986 ** is accessed.
2987 */
drh13f40da2014-08-22 18:00:11 +00002988 sqlite3Error(db, SQLITE_OK);
drh80738d92016-02-15 00:34:16 +00002989 sqlite3RegisterPerConnectionBuiltinFunctions(db);
danc9e75fb2016-08-19 18:37:35 +00002990 rc = sqlite3_errcode(db);
2991
2992#ifdef SQLITE_ENABLE_FTS5
2993 /* Register any built-in FTS5 module before loading the automatic
2994 ** extensions. This allows automatic extensions to register FTS5
2995 ** tokenizers and auxiliary functions. */
2996 if( !db->mallocFailed && rc==SQLITE_OK ){
2997 rc = sqlite3Fts5Init(db);
2998 }
2999#endif
danielk19774ad17132004-05-21 01:47:26 +00003000
drh1409be62006-08-23 20:07:20 +00003001 /* Load automatic extensions - extensions that have been registered
3002 ** using the sqlite3_automatic_extension() API.
3003 */
drhe5077c12011-12-13 04:08:36 +00003004 if( rc==SQLITE_OK ){
3005 sqlite3AutoLoadExtensions(db);
3006 rc = sqlite3_errcode(db);
drh76f63782017-02-07 03:44:42 +00003007 if( rc!=SQLITE_OK ){
3008 goto opendb_out;
3009 }
danielk1977832a58a2007-06-22 15:21:15 +00003010 }
drh1409be62006-08-23 20:07:20 +00003011
drhaa29c132006-09-02 13:58:06 +00003012#ifdef SQLITE_ENABLE_FTS1
drh76f63782017-02-07 03:44:42 +00003013 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00003014 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003015 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00003016 }
3017#endif
3018
shessa26cf572006-10-19 20:27:58 +00003019#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00003020 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00003021 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00003022 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00003023 }
3024#endif
3025
drh50065652015-10-08 19:29:18 +00003026#ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
shess69c4ae22007-08-20 17:37:47 +00003027 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00003028 rc = sqlite3Fts3Init(db);
3029 }
3030#endif
3031
danielk197783852ac2007-05-06 16:04:11 +00003032#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00003033 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00003034 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00003035 }
3036#endif
danielk1977ebaecc12008-05-26 18:41:54 +00003037
3038#ifdef SQLITE_ENABLE_RTREE
3039 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00003040 rc = sqlite3RtreeInit(db);
3041 }
3042#endif
3043
drha3ab9d02015-05-04 20:25:05 +00003044#ifdef SQLITE_ENABLE_DBSTAT_VTAB
3045 if( !db->mallocFailed && rc==SQLITE_OK){
drh3e0327d2015-05-11 11:59:15 +00003046 rc = sqlite3DbstatRegister(db);
drha3ab9d02015-05-04 20:25:05 +00003047 }
3048#endif
3049
drh2f20e132015-09-26 17:44:59 +00003050#ifdef SQLITE_ENABLE_JSON1
3051 if( !db->mallocFailed && rc==SQLITE_OK){
drh2f20e132015-09-26 17:44:59 +00003052 rc = sqlite3Json1Init(db);
3053 }
3054#endif
3055
drh76f63782017-02-07 03:44:42 +00003056 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3057 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3058 ** mode. Doing nothing at all also makes NORMAL the default.
3059 */
drh8fd5bd32007-04-02 16:40:37 +00003060#ifdef SQLITE_DEFAULT_LOCKING_MODE
drh76f63782017-02-07 03:44:42 +00003061 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3062 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3063 SQLITE_DEFAULT_LOCKING_MODE);
drh8fd5bd32007-04-02 16:40:37 +00003064#endif
3065
drh76f63782017-02-07 03:44:42 +00003066 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00003067
drh76f63782017-02-07 03:44:42 +00003068 /* Enable the lookaside-malloc subsystem */
3069 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3070 sqlite3GlobalConfig.nLookaside);
3071
3072 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00003073
danielk19774ad17132004-05-21 01:47:26 +00003074opendb_out:
drhafc91042008-02-21 02:09:45 +00003075 if( db ){
drh3ba689d2015-03-03 14:00:11 +00003076 assert( db->mutex!=0 || isThreadsafe==0
3077 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00003078 sqlite3_mutex_leave(db->mutex);
3079 }
danielk197759633ae2008-08-27 19:01:57 +00003080 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00003081 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00003082 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00003083 sqlite3_close(db);
3084 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00003085 }else if( rc!=SQLITE_OK ){
3086 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00003087 }
danielk19774ad17132004-05-21 01:47:26 +00003088 *ppDb = db;
danac455932012-11-26 19:50:41 +00003089#ifdef SQLITE_ENABLE_SQLLOG
3090 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00003091 /* Opening a db handle. Fourth parameter is passed 0. */
3092 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3093 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00003094 }
3095#endif
drh46e6ea02015-10-26 14:41:35 +00003096#if defined(SQLITE_HAS_CODEC)
3097 if( rc==SQLITE_OK ){
drhad012d02017-05-03 15:54:53 +00003098 const char *zKey;
3099 if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){;
drh46e6ea02015-10-26 14:41:35 +00003100 u8 iByte;
3101 int i;
drhad012d02017-05-03 15:54:53 +00003102 char zDecoded[40];
3103 for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
3104 iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
3105 if( (i&1)!=0 ) zDecoded[i/2] = iByte;
drh46e6ea02015-10-26 14:41:35 +00003106 }
drhad012d02017-05-03 15:54:53 +00003107 sqlite3_key_v2(db, 0, zDecoded, i/2);
3108 }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){
3109 sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey));
drh46e6ea02015-10-26 14:41:35 +00003110 }
3111 }
3112#endif
drh095fb472016-01-16 03:16:19 +00003113 sqlite3_free(zOpen);
drh597d2b62015-06-30 03:13:47 +00003114 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003115}
3116
3117/*
3118** Open a new database handle.
3119*/
danielk197780290862004-05-22 09:21:21 +00003120int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00003121 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003122 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003123){
drh605264d2007-08-21 15:13:19 +00003124 return openDatabase(zFilename, ppDb,
3125 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3126}
3127int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00003128 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00003129 sqlite3 **ppDb, /* OUT: SQLite db handle */
3130 int flags, /* Flags */
3131 const char *zVfs /* Name of VFS module to use */
3132){
drh522c26f2011-05-07 14:40:29 +00003133 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00003134}
3135
drh6c626082004-11-14 21:56:29 +00003136#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00003137/*
3138** Open a new database handle.
3139*/
3140int sqlite3_open16(
3141 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00003142 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00003143){
danielk1977bfd6cce2004-06-18 04:24:54 +00003144 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00003145 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00003146 int rc;
danielk19774ad17132004-05-21 01:47:26 +00003147
drh9ca95732014-10-24 00:35:58 +00003148#ifdef SQLITE_ENABLE_API_ARMOR
3149 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3150#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00003151 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00003152#ifndef SQLITE_OMIT_AUTOINIT
3153 rc = sqlite3_initialize();
3154 if( rc ) return rc;
3155#endif
drh9ca95732014-10-24 00:35:58 +00003156 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00003157 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00003158 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3159 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00003160 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00003161 rc = openDatabase(zFilename8, ppDb,
3162 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00003163 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00003164 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00003165 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00003166 }
drh40257ff2008-06-13 18:24:27 +00003167 }else{
mistachkinfad30392016-02-13 23:43:46 +00003168 rc = SQLITE_NOMEM_BKPT;
danielk19774ad17132004-05-21 01:47:26 +00003169 }
danielk19777ddad962005-12-12 06:53:03 +00003170 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00003171
drh597d2b62015-06-30 03:13:47 +00003172 return rc & 0xff;
danielk19774ad17132004-05-21 01:47:26 +00003173}
drh6c626082004-11-14 21:56:29 +00003174#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00003175
danielk1977106bb232004-05-21 10:08:53 +00003176/*
danielk1977d8123362004-06-12 09:25:12 +00003177** Register a new collation sequence with the database handle db.
3178*/
danielk19770202b292004-06-09 09:55:16 +00003179int sqlite3_create_collation(
3180 sqlite3* db,
3181 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00003182 int enc,
danielk19770202b292004-06-09 09:55:16 +00003183 void* pCtx,
3184 int(*xCompare)(void*,int,const void*,int,const void*)
3185){
drh4f81bbb2014-10-23 01:01:26 +00003186 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00003187}
3188
3189/*
3190** Register a new collation sequence with the database handle db.
3191*/
danielk1977a393c032007-05-07 14:58:53 +00003192int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003193 sqlite3* db,
3194 const char *zName,
3195 int enc,
3196 void* pCtx,
3197 int(*xCompare)(void*,int,const void*,int,const void*),
3198 void(*xDel)(void*)
3199){
3200 int rc;
drh9ca95732014-10-24 00:35:58 +00003201
3202#ifdef SQLITE_ENABLE_API_ARMOR
3203 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3204#endif
drhe30f4422007-08-21 16:15:55 +00003205 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003206 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003207 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003208 rc = sqlite3ApiExit(db, rc);
3209 sqlite3_mutex_leave(db->mutex);
3210 return rc;
danielk19770202b292004-06-09 09:55:16 +00003211}
3212
drh6c626082004-11-14 21:56:29 +00003213#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003214/*
3215** Register a new collation sequence with the database handle db.
3216*/
danielk19770202b292004-06-09 09:55:16 +00003217int sqlite3_create_collation16(
3218 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003219 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003220 int enc,
danielk19770202b292004-06-09 09:55:16 +00003221 void* pCtx,
3222 int(*xCompare)(void*,int,const void*,int,const void*)
3223){
danielk19779a30cf62006-01-18 04:26:07 +00003224 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003225 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003226
3227#ifdef SQLITE_ENABLE_API_ARMOR
3228 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3229#endif
drhe30f4422007-08-21 16:15:55 +00003230 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003231 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003232 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003233 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003234 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003235 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003236 }
drhe30f4422007-08-21 16:15:55 +00003237 rc = sqlite3ApiExit(db, rc);
3238 sqlite3_mutex_leave(db->mutex);
3239 return rc;
danielk19770202b292004-06-09 09:55:16 +00003240}
drh6c626082004-11-14 21:56:29 +00003241#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003242
danielk1977d8123362004-06-12 09:25:12 +00003243/*
3244** Register a collation sequence factory callback with the database handle
3245** db. Replace any previously installed collation sequence factory.
3246*/
danielk19777cedc8d2004-06-10 10:50:08 +00003247int sqlite3_collation_needed(
3248 sqlite3 *db,
3249 void *pCollNeededArg,
3250 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3251){
drh9ca95732014-10-24 00:35:58 +00003252#ifdef SQLITE_ENABLE_API_ARMOR
3253 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3254#endif
drhe30f4422007-08-21 16:15:55 +00003255 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003256 db->xCollNeeded = xCollNeeded;
3257 db->xCollNeeded16 = 0;
3258 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003259 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003260 return SQLITE_OK;
3261}
danielk1977d8123362004-06-12 09:25:12 +00003262
drh6c626082004-11-14 21:56:29 +00003263#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003264/*
3265** Register a collation sequence factory callback with the database handle
3266** db. Replace any previously installed collation sequence factory.
3267*/
danielk19777cedc8d2004-06-10 10:50:08 +00003268int sqlite3_collation_needed16(
3269 sqlite3 *db,
3270 void *pCollNeededArg,
3271 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3272){
drh9ca95732014-10-24 00:35:58 +00003273#ifdef SQLITE_ENABLE_API_ARMOR
3274 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3275#endif
drhe30f4422007-08-21 16:15:55 +00003276 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003277 db->xCollNeeded = 0;
3278 db->xCollNeeded16 = xCollNeeded16;
3279 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003280 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003281 return SQLITE_OK;
3282}
drh6c626082004-11-14 21:56:29 +00003283#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003284
shaneeec556d2008-10-12 00:27:53 +00003285#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003286/*
danielk19777ddad962005-12-12 06:53:03 +00003287** This function is now an anachronism. It used to be used to recover from a
3288** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003289*/
drh7d97efb2007-10-12 19:35:48 +00003290int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003291 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003292}
3293#endif
drh3e1d8e62005-05-26 16:23:34 +00003294
3295/*
3296** Test to see whether or not the database connection is in autocommit
3297** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3298** by default. Autocommit is disabled by a BEGIN statement and reenabled
3299** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003300*/
3301int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003302#ifdef SQLITE_ENABLE_API_ARMOR
3303 if( !sqlite3SafetyCheckOk(db) ){
3304 (void)SQLITE_MISUSE_BKPT;
3305 return 0;
3306 }
3307#endif
drh3e1d8e62005-05-26 16:23:34 +00003308 return db->autoCommit;
3309}
drh49285702005-09-17 15:20:26 +00003310
drh49285702005-09-17 15:20:26 +00003311/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003312** The following routines are substitutes for constants SQLITE_CORRUPT,
mistachkin8fd84132016-02-14 00:14:35 +00003313** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003314** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003315**
3316** 1. Serve as a convenient place to set a breakpoint in a debugger
3317** to detect when version error conditions occurs.
3318**
3319** 2. Invoke sqlite3_log() to provide the source code location where
3320** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003321*/
drh32c49902016-02-15 18:15:15 +00003322static int reportError(int iErr, int lineno, const char *zType){
3323 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3324 zType, lineno, 20+sqlite3_sourceid());
3325 return iErr;
3326}
drh9978c972010-02-23 17:36:32 +00003327int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003328 testcase( sqlite3GlobalConfig.xLog!=0 );
drh32c49902016-02-15 18:15:15 +00003329 return reportError(SQLITE_CORRUPT, lineno, "database corruption");
drh49285702005-09-17 15:20:26 +00003330}
drh9978c972010-02-23 17:36:32 +00003331int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003332 testcase( sqlite3GlobalConfig.xLog!=0 );
drh32c49902016-02-15 18:15:15 +00003333 return reportError(SQLITE_MISUSE, lineno, "misuse");
drh9978c972010-02-23 17:36:32 +00003334}
3335int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003336 testcase( sqlite3GlobalConfig.xLog!=0 );
drh32c49902016-02-15 18:15:15 +00003337 return reportError(SQLITE_CANTOPEN, lineno, "cannot open file");
drh9978c972010-02-23 17:36:32 +00003338}
drh32c49902016-02-15 18:15:15 +00003339#ifdef SQLITE_DEBUG
mistachkinfad30392016-02-13 23:43:46 +00003340int sqlite3NomemError(int lineno){
3341 testcase( sqlite3GlobalConfig.xLog!=0 );
drh32c49902016-02-15 18:15:15 +00003342 return reportError(SQLITE_NOMEM, lineno, "OOM");
mistachkinfad30392016-02-13 23:43:46 +00003343}
3344int sqlite3IoerrnomemError(int lineno){
3345 testcase( sqlite3GlobalConfig.xLog!=0 );
drh32c49902016-02-15 18:15:15 +00003346 return reportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
mistachkinfad30392016-02-13 23:43:46 +00003347}
drh32c49902016-02-15 18:15:15 +00003348#endif
drh7c1817e2006-01-10 13:58:48 +00003349
shaneeec556d2008-10-12 00:27:53 +00003350#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003351/*
3352** This is a convenience routine that makes sure that all thread-specific
3353** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003354**
3355** SQLite no longer uses thread-specific data so this routine is now a
3356** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003357*/
3358void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003359}
shaneeec556d2008-10-12 00:27:53 +00003360#endif
danielk1977deb802c2006-02-09 13:43:28 +00003361
3362/*
3363** Return meta information about a specific column of a database table.
3364** See comment in sqlite3.h (sqlite.h.in) for details.
3365*/
danielk1977deb802c2006-02-09 13:43:28 +00003366int sqlite3_table_column_metadata(
3367 sqlite3 *db, /* Connection handle */
3368 const char *zDbName, /* Database name or NULL */
3369 const char *zTableName, /* Table name */
3370 const char *zColumnName, /* Column name */
3371 char const **pzDataType, /* OUTPUT: Declared data type */
3372 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3373 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3374 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003375 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003376){
3377 int rc;
3378 char *zErrMsg = 0;
3379 Table *pTab = 0;
3380 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003381 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003382 char const *zDataType = 0;
3383 char const *zCollSeq = 0;
3384 int notnull = 0;
3385 int primarykey = 0;
3386 int autoinc = 0;
3387
drh96c707a2015-02-13 16:36:14 +00003388
3389#ifdef SQLITE_ENABLE_API_ARMOR
3390 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3391 return SQLITE_MISUSE_BKPT;
3392 }
3393#endif
3394
danielk1977deb802c2006-02-09 13:43:28 +00003395 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003396 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003397 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003398 rc = sqlite3Init(db, &zErrMsg);
3399 if( SQLITE_OK!=rc ){
3400 goto error_out;
3401 }
3402
3403 /* Locate the table in question */
3404 pTab = sqlite3FindTable(db, zTableName, zDbName);
3405 if( !pTab || pTab->pSelect ){
3406 pTab = 0;
3407 goto error_out;
3408 }
3409
3410 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003411 if( zColumnName==0 ){
3412 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003413 }else{
3414 for(iCol=0; iCol<pTab->nCol; iCol++){
3415 pCol = &pTab->aCol[iCol];
3416 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3417 break;
3418 }
3419 }
3420 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003421 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3422 iCol = pTab->iPKey;
3423 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3424 }else{
3425 pTab = 0;
3426 goto error_out;
3427 }
danielk1977deb802c2006-02-09 13:43:28 +00003428 }
3429 }
3430
3431 /* The following block stores the meta information that will be returned
3432 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3433 ** and autoinc. At this point there are two possibilities:
3434 **
3435 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3436 ** and there is no explicitly declared IPK column.
3437 **
3438 ** 2. The table is not a view and the column name identified an
3439 ** explicitly declared column. Copy meta information from *pCol.
3440 */
3441 if( pCol ){
drhd7564862016-03-22 20:05:09 +00003442 zDataType = sqlite3ColumnType(pCol,0);
danielk1977deb802c2006-02-09 13:43:28 +00003443 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003444 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003445 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003446 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003447 }else{
3448 zDataType = "INTEGER";
3449 primarykey = 1;
3450 }
3451 if( !zCollSeq ){
drhf19aa5f2015-12-30 16:51:20 +00003452 zCollSeq = sqlite3StrBINARY;
danielk1977deb802c2006-02-09 13:43:28 +00003453 }
3454
3455error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003456 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003457
3458 /* Whether the function call succeeded or failed, set the output parameters
3459 ** to whatever their local counterparts contain. If an error did occur,
3460 ** this has the effect of zeroing all output parameters.
3461 */
3462 if( pzDataType ) *pzDataType = zDataType;
3463 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3464 if( pNotNull ) *pNotNull = notnull;
3465 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3466 if( pAutoinc ) *pAutoinc = autoinc;
3467
3468 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003469 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003470 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003471 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003472 rc = SQLITE_ERROR;
3473 }
drh13f40da2014-08-22 18:00:11 +00003474 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003475 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003476 rc = sqlite3ApiExit(db, rc);
3477 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003478 return rc;
3479}
3480
3481/*
3482** Sleep for a little while. Return the amount of time slept.
3483*/
3484int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003485 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003486 int rc;
drhd677b3d2007-08-20 22:48:41 +00003487 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003488 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003489
3490 /* This function works in milliseconds, but the underlying OsSleep()
3491 ** API uses microseconds. Hence the 1000's.
3492 */
drhe30f4422007-08-21 16:15:55 +00003493 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003494 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003495}
drh4ac285a2006-09-15 07:28:50 +00003496
3497/*
3498** Enable or disable the extended result codes.
3499*/
3500int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003501#ifdef SQLITE_ENABLE_API_ARMOR
3502 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3503#endif
drhe30f4422007-08-21 16:15:55 +00003504 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003505 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003506 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003507 return SQLITE_OK;
3508}
drhcc6bb3e2007-08-31 16:11:35 +00003509
3510/*
3511** Invoke the xFileControl method on a particular database.
3512*/
3513int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3514 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003515 Btree *pBtree;
3516
drh9ca95732014-10-24 00:35:58 +00003517#ifdef SQLITE_ENABLE_API_ARMOR
3518 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3519#endif
drhcc6bb3e2007-08-31 16:11:35 +00003520 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003521 pBtree = sqlite3DbNameToBtree(db, zDbName);
3522 if( pBtree ){
3523 Pager *pPager;
3524 sqlite3_file *fd;
3525 sqlite3BtreeEnter(pBtree);
3526 pPager = sqlite3BtreePager(pBtree);
3527 assert( pPager!=0 );
3528 fd = sqlite3PagerFile(pPager);
3529 assert( fd!=0 );
3530 if( op==SQLITE_FCNTL_FILE_POINTER ){
3531 *(sqlite3_file**)pArg = fd;
3532 rc = SQLITE_OK;
drh790f2872015-11-28 18:06:36 +00003533 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3534 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3535 rc = SQLITE_OK;
drh21d61852016-01-08 02:27:01 +00003536 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3537 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3538 rc = SQLITE_OK;
drh421377e2012-03-15 21:28:54 +00003539 }else if( fd->pMethods ){
3540 rc = sqlite3OsFileControl(fd, op, pArg);
3541 }else{
3542 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003543 }
drh421377e2012-03-15 21:28:54 +00003544 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003545 }
3546 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003547 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003548}
drhed13d982008-01-31 14:43:24 +00003549
3550/*
3551** Interface to the testing logic.
3552*/
3553int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003554 int rc = 0;
drhd12602a2016-12-07 15:49:02 +00003555#ifdef SQLITE_UNTESTABLE
drhf5ed7ad2015-06-15 14:43:25 +00003556 UNUSED_PARAMETER(op);
3557#else
drh2fa18682008-03-19 14:15:34 +00003558 va_list ap;
drhed13d982008-01-31 14:43:24 +00003559 va_start(ap, op);
3560 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003561
3562 /*
drh984bfaa2008-03-19 16:08:53 +00003563 ** Save the current state of the PRNG.
3564 */
drh2fa18682008-03-19 14:15:34 +00003565 case SQLITE_TESTCTRL_PRNG_SAVE: {
3566 sqlite3PrngSaveState();
3567 break;
3568 }
drh984bfaa2008-03-19 16:08:53 +00003569
3570 /*
3571 ** Restore the state of the PRNG to the last state saved using
3572 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3573 ** this verb acts like PRNG_RESET.
3574 */
drh2fa18682008-03-19 14:15:34 +00003575 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3576 sqlite3PrngRestoreState();
3577 break;
3578 }
drh984bfaa2008-03-19 16:08:53 +00003579
3580 /*
3581 ** Reset the PRNG back to its uninitialized state. The next call
3582 ** to sqlite3_randomness() will reseed the PRNG using a single call
3583 ** to the xRandomness method of the default VFS.
3584 */
drh2fa18682008-03-19 14:15:34 +00003585 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003586 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003587 break;
3588 }
drh3088d592008-03-21 16:45:47 +00003589
3590 /*
3591 ** sqlite3_test_control(BITVEC_TEST, size, program)
3592 **
3593 ** Run a test against a Bitvec object of size. The program argument
3594 ** is an array of integers that defines the test. Return -1 on a
3595 ** memory allocation error, 0 on success, or non-zero for an error.
3596 ** See the sqlite3BitvecBuiltinTest() for additional information.
3597 */
3598 case SQLITE_TESTCTRL_BITVEC_TEST: {
3599 int sz = va_arg(ap, int);
3600 int *aProg = va_arg(ap, int*);
3601 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3602 break;
3603 }
danielk19772d1d86f2008-06-20 14:59:51 +00003604
3605 /*
drhc007f612014-05-16 14:17:01 +00003606 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3607 **
3608 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3609 ** if xCallback is not NULL.
3610 **
3611 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3612 ** is called immediately after installing the new callback and the return
3613 ** value from sqlite3FaultSim(0) becomes the return from
3614 ** sqlite3_test_control().
3615 */
3616 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003617 /* MSVC is picky about pulling func ptrs from va lists.
3618 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003619 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003620 */
3621 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003622 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003623 rc = sqlite3FaultSim(0);
3624 break;
3625 }
3626
3627 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003628 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3629 **
3630 ** Register hooks to call to indicate which malloc() failures
3631 ** are benign.
3632 */
3633 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003634 typedef void (*void_function)(void);
3635 void_function xBenignBegin;
3636 void_function xBenignEnd;
3637 xBenignBegin = va_arg(ap, void_function);
3638 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003639 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3640 break;
3641 }
drhc7a3bb92009-02-05 16:31:45 +00003642
3643 /*
drhf3af63f2009-05-09 18:59:42 +00003644 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003645 **
3646 ** Set the PENDING byte to the value in the argument, if X>0.
3647 ** Make no changes if X==0. Return the value of the pending byte
3648 ** as it existing before this routine was called.
3649 **
3650 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3651 ** an incompatible database file format. Changing the PENDING byte
3652 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003653 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003654 */
3655 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003656 rc = PENDING_BYTE;
3657#ifndef SQLITE_OMIT_WSD
3658 {
3659 unsigned int newVal = va_arg(ap, unsigned int);
3660 if( newVal ) sqlite3PendingByte = newVal;
3661 }
3662#endif
drhc7a3bb92009-02-05 16:31:45 +00003663 break;
3664 }
drhf3af63f2009-05-09 18:59:42 +00003665
3666 /*
3667 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3668 **
3669 ** This action provides a run-time test to see whether or not
3670 ** assert() was enabled at compile-time. If X is true and assert()
3671 ** is enabled, then the return value is true. If X is true and
3672 ** assert() is disabled, then the return value is zero. If X is
3673 ** false and assert() is enabled, then the assertion fires and the
3674 ** process aborts. If X is false and assert() is disabled, then the
3675 ** return value is zero.
3676 */
3677 case SQLITE_TESTCTRL_ASSERT: {
3678 volatile int x = 0;
drhcc5f8a42016-02-06 22:32:06 +00003679 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
drhf3af63f2009-05-09 18:59:42 +00003680 rc = x;
3681 break;
3682 }
3683
3684
3685 /*
3686 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3687 **
3688 ** This action provides a run-time test to see how the ALWAYS and
3689 ** NEVER macros were defined at compile-time.
3690 **
3691 ** The return value is ALWAYS(X).
3692 **
3693 ** The recommended test is X==2. If the return value is 2, that means
3694 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3695 ** default setting. If the return value is 1, then ALWAYS() is either
3696 ** hard-coded to true or else it asserts if its argument is false.
3697 ** The first behavior (hard-coded to true) is the case if
3698 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3699 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3700 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3701 **
3702 ** The run-time test procedure might look something like this:
3703 **
3704 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3705 ** // ALWAYS() and NEVER() are no-op pass-through macros
3706 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3707 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3708 ** }else{
3709 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3710 ** }
3711 */
3712 case SQLITE_TESTCTRL_ALWAYS: {
3713 int x = va_arg(ap,int);
3714 rc = ALWAYS(x);
3715 break;
3716 }
drhc046e3e2009-07-15 11:26:44 +00003717
drh2cf4acb2014-04-18 00:06:02 +00003718 /*
3719 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3720 **
3721 ** The integer returned reveals the byte-order of the computer on which
3722 ** SQLite is running:
3723 **
3724 ** 1 big-endian, determined at run-time
3725 ** 10 little-endian, determined at run-time
3726 ** 432101 big-endian, determined at compile-time
3727 ** 123410 little-endian, determined at compile-time
3728 */
3729 case SQLITE_TESTCTRL_BYTEORDER: {
3730 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3731 break;
3732 }
3733
drhc046e3e2009-07-15 11:26:44 +00003734 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3735 **
3736 ** Set the nReserve size to N for the main database on the database
3737 ** connection db.
3738 */
3739 case SQLITE_TESTCTRL_RESERVE: {
3740 sqlite3 *db = va_arg(ap, sqlite3*);
3741 int x = va_arg(ap,int);
3742 sqlite3_mutex_enter(db->mutex);
3743 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3744 sqlite3_mutex_leave(db->mutex);
3745 break;
3746 }
3747
drh07096f62009-12-22 23:52:32 +00003748 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3749 **
3750 ** Enable or disable various optimizations for testing purposes. The
3751 ** argument N is a bitmask of optimizations to be disabled. For normal
3752 ** operation N should be 0. The idea is that a test program (like the
3753 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3754 ** with various optimizations disabled to verify that the same answer
3755 ** is obtained in every case.
3756 */
3757 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3758 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003759 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003760 break;
3761 }
3762
drh0e857732010-01-02 03:21:35 +00003763#ifdef SQLITE_N_KEYWORD
3764 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3765 **
3766 ** If zWord is a keyword recognized by the parser, then return the
3767 ** number of keywords. Or if zWord is not a keyword, return 0.
3768 **
3769 ** This test feature is only available in the amalgamation since
3770 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3771 ** is built using separate source files.
3772 */
3773 case SQLITE_TESTCTRL_ISKEYWORD: {
3774 const char *zWord = va_arg(ap, const char*);
3775 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003776 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003777 break;
3778 }
3779#endif
3780
drhbadc9802010-08-27 17:16:44 +00003781 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3782 **
3783 ** Pass pFree into sqlite3ScratchFree().
3784 ** If sz>0 then allocate a scratch buffer into pNew.
3785 */
3786 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3787 void *pFree, **ppNew;
3788 int sz;
3789 sz = va_arg(ap, int);
3790 ppNew = va_arg(ap, void**);
3791 pFree = va_arg(ap, void*);
3792 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3793 sqlite3ScratchFree(pFree);
3794 break;
3795 }
3796
danc17d6962011-06-21 12:47:30 +00003797 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3798 **
3799 ** If parameter onoff is non-zero, configure the wrappers so that all
3800 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3801 ** undo this setting.
3802 */
3803 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3804 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3805 break;
3806 }
3807
drh09fe6142013-11-29 15:06:27 +00003808 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3809 **
3810 ** Set or clear a flag that indicates that the database file is always well-
3811 ** formed and never corrupt. This flag is clear by default, indicating that
3812 ** database files might have arbitrary corruption. Setting the flag during
3813 ** testing causes certain assert() statements in the code to be activated
3814 ** that demonstrat invariants on well-formed database files.
3815 */
3816 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003817 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003818 break;
3819 }
3820
drh9e5eb9c2016-09-18 16:08:10 +00003821 /* Set the threshold at which OP_Once counters reset back to zero.
mistachkine0736da2016-09-20 17:38:27 +00003822 ** By default this is 0x7ffffffe (over 2 billion), but that value is
drh9e5eb9c2016-09-18 16:08:10 +00003823 ** too big to test in a reasonable amount of time, so this control is
3824 ** provided to set a small and easily reachable reset value.
3825 */
3826 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
3827 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
3828 break;
3829 }
drh688852a2014-02-17 22:40:43 +00003830
3831 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3832 **
3833 ** Set the VDBE coverage callback function to xCallback with context
3834 ** pointer ptr.
3835 */
3836 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3837#ifdef SQLITE_VDBE_COVERAGE
3838 typedef void (*branch_callback)(void*,int,u8,u8);
3839 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3840 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3841#endif
3842 break;
3843 }
3844
dan8930c2a2014-04-03 16:25:29 +00003845 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3846 case SQLITE_TESTCTRL_SORTER_MMAP: {
3847 sqlite3 *db = va_arg(ap, sqlite3*);
3848 db->nMaxSorterMmap = va_arg(ap, int);
3849 break;
3850 }
3851
drh43cfc232014-07-29 14:09:21 +00003852 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3853 **
3854 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3855 ** not.
3856 */
3857 case SQLITE_TESTCTRL_ISINIT: {
3858 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3859 break;
3860 }
drh8964b342015-01-29 17:54:52 +00003861
drh3ba689d2015-03-03 14:00:11 +00003862 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00003863 **
drh1ffede82015-01-30 20:59:27 +00003864 ** This test control is used to create imposter tables. "db" is a pointer
3865 ** to the database connection. dbName is the database name (ex: "main" or
3866 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
3867 ** or off. "tnum" is the root page of the b-tree to which the imposter
3868 ** table should connect.
3869 **
3870 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00003871 ** run a single CREATE TABLE statement to construct the imposter table in
3872 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00003873 **
3874 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
3875 ** the schema to be reparsed the next time it is needed. This has the
3876 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00003877 */
drh1ffede82015-01-30 20:59:27 +00003878 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00003879 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00003880 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00003881 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
3882 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00003883 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00003884 if( db->init.busy==0 && db->init.newTnum>0 ){
3885 sqlite3ResetAllSchemasOfConnection(db);
3886 }
drh8fb15e32015-02-04 20:56:49 +00003887 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00003888 break;
3889 }
drhed13d982008-01-31 14:43:24 +00003890 }
3891 va_end(ap);
drhd12602a2016-12-07 15:49:02 +00003892#endif /* SQLITE_UNTESTABLE */
danielk19777c36d072008-01-31 15:31:01 +00003893 return rc;
drhed13d982008-01-31 14:43:24 +00003894}
drhcc487d12011-05-17 18:53:08 +00003895
3896/*
3897** This is a utility routine, useful to VFS implementations, that checks
3898** to see if a database file was a URI that contained a specific query
3899** parameter, and if so obtains the value of the query parameter.
3900**
3901** The zFilename argument is the filename pointer passed into the xOpen()
3902** method of a VFS implementation. The zParam argument is the name of the
3903** query parameter we seek. This routine returns the value of the zParam
3904** parameter if it exists. If the parameter does not exist, this routine
3905** returns a NULL pointer.
3906*/
3907const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003908 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003909 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003910 while( zFilename[0] ){
3911 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003912 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003913 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003914 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003915 }
3916 return 0;
3917}
drh283829c2011-11-17 00:56:20 +00003918
3919/*
drh92913722011-12-23 00:07:33 +00003920** Return a boolean value for a query parameter.
3921*/
3922int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3923 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003924 bDflt = bDflt!=0;
3925 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003926}
3927
3928/*
3929** Return a 64-bit integer value for a query parameter.
3930*/
3931sqlite3_int64 sqlite3_uri_int64(
3932 const char *zFilename, /* Filename as passed to xOpen */
3933 const char *zParam, /* URI parameter sought */
3934 sqlite3_int64 bDflt /* return if parameter is missing */
3935){
3936 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3937 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003938 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003939 bDflt = v;
3940 }
3941 return bDflt;
3942}
3943
3944/*
drh421377e2012-03-15 21:28:54 +00003945** Return the Btree pointer identified by zDbName. Return NULL if not found.
3946*/
3947Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
drh29518092016-12-24 19:37:16 +00003948 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
3949 return iDb<0 ? 0 : db->aDb[iDb].pBt;
drh421377e2012-03-15 21:28:54 +00003950}
3951
3952/*
drh283829c2011-11-17 00:56:20 +00003953** Return the filename of the database associated with a database
3954** connection.
3955*/
3956const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003957 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003958#ifdef SQLITE_ENABLE_API_ARMOR
3959 if( !sqlite3SafetyCheckOk(db) ){
3960 (void)SQLITE_MISUSE_BKPT;
3961 return 0;
3962 }
3963#endif
mistachkincd54bab2014-12-20 21:14:14 +00003964 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00003965 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3966}
3967
3968/*
3969** Return 1 if database is read-only or 0 if read/write. Return -1 if
3970** no such database exists.
3971*/
3972int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003973 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003974#ifdef SQLITE_ENABLE_API_ARMOR
3975 if( !sqlite3SafetyCheckOk(db) ){
3976 (void)SQLITE_MISUSE_BKPT;
3977 return -1;
3978 }
3979#endif
mistachkincd54bab2014-12-20 21:14:14 +00003980 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003981 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003982}
danfc1acf32015-12-05 20:51:54 +00003983
3984#ifdef SQLITE_ENABLE_SNAPSHOT
3985/*
3986** Obtain a snapshot handle for the snapshot of database zDb currently
3987** being read by handle db.
3988*/
3989int sqlite3_snapshot_get(
3990 sqlite3 *db,
3991 const char *zDb,
3992 sqlite3_snapshot **ppSnapshot
3993){
3994 int rc = SQLITE_ERROR;
3995#ifndef SQLITE_OMIT_WAL
danfc1acf32015-12-05 20:51:54 +00003996
3997#ifdef SQLITE_ENABLE_API_ARMOR
3998 if( !sqlite3SafetyCheckOk(db) ){
3999 return SQLITE_MISUSE_BKPT;
4000 }
4001#endif
4002 sqlite3_mutex_enter(db->mutex);
4003
danedace5d2016-11-18 18:43:39 +00004004 if( db->autoCommit==0 ){
4005 int iDb = sqlite3FindDbName(db, zDb);
4006 if( iDb==0 || iDb>1 ){
4007 Btree *pBt = db->aDb[iDb].pBt;
4008 if( 0==sqlite3BtreeIsInTrans(pBt) ){
4009 rc = sqlite3BtreeBeginTrans(pBt, 0);
4010 if( rc==SQLITE_OK ){
4011 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4012 }
dan7116dc62015-12-10 20:03:08 +00004013 }
danfc1acf32015-12-05 20:51:54 +00004014 }
4015 }
4016
4017 sqlite3_mutex_leave(db->mutex);
4018#endif /* SQLITE_OMIT_WAL */
4019 return rc;
4020}
4021
4022/*
4023** Open a read-transaction on the snapshot idendified by pSnapshot.
4024*/
4025int sqlite3_snapshot_open(
4026 sqlite3 *db,
4027 const char *zDb,
4028 sqlite3_snapshot *pSnapshot
4029){
4030 int rc = SQLITE_ERROR;
4031#ifndef SQLITE_OMIT_WAL
4032
4033#ifdef SQLITE_ENABLE_API_ARMOR
4034 if( !sqlite3SafetyCheckOk(db) ){
4035 return SQLITE_MISUSE_BKPT;
4036 }
4037#endif
4038 sqlite3_mutex_enter(db->mutex);
4039 if( db->autoCommit==0 ){
4040 int iDb;
4041 iDb = sqlite3FindDbName(db, zDb);
4042 if( iDb==0 || iDb>1 ){
4043 Btree *pBt = db->aDb[iDb].pBt;
4044 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
4045 rc = sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), pSnapshot);
4046 if( rc==SQLITE_OK ){
4047 rc = sqlite3BtreeBeginTrans(pBt, 0);
4048 sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), 0);
4049 }
4050 }
4051 }
4052 }
4053
4054 sqlite3_mutex_leave(db->mutex);
4055#endif /* SQLITE_OMIT_WAL */
4056 return rc;
4057}
4058
4059/*
dan11584982016-11-18 20:49:43 +00004060** Recover as many snapshots as possible from the wal file associated with
4061** schema zDb of database db.
4062*/
4063int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4064 int rc = SQLITE_ERROR;
4065 int iDb;
4066#ifndef SQLITE_OMIT_WAL
4067
4068#ifdef SQLITE_ENABLE_API_ARMOR
4069 if( !sqlite3SafetyCheckOk(db) ){
4070 return SQLITE_MISUSE_BKPT;
4071 }
4072#endif
4073
4074 sqlite3_mutex_enter(db->mutex);
4075 iDb = sqlite3FindDbName(db, zDb);
4076 if( iDb==0 || iDb>1 ){
4077 Btree *pBt = db->aDb[iDb].pBt;
4078 if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
dan93f51132016-11-19 18:31:37 +00004079 rc = sqlite3BtreeBeginTrans(pBt, 0);
4080 if( rc==SQLITE_OK ){
4081 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4082 sqlite3BtreeCommit(pBt);
4083 }
dan11584982016-11-18 20:49:43 +00004084 }
4085 }
4086 sqlite3_mutex_leave(db->mutex);
4087#endif /* SQLITE_OMIT_WAL */
4088 return rc;
4089}
4090
4091/*
danfc1acf32015-12-05 20:51:54 +00004092** Free a snapshot handle obtained from sqlite3_snapshot_get().
4093*/
4094void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4095 sqlite3_free(pSnapshot);
4096}
4097#endif /* SQLITE_ENABLE_SNAPSHOT */