blob: a2177fd79614aefc61a387028fd01e7cd2ae9e3a [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
drh75897232000-05-29 14:26:00 +000028
drhb3190c12008-12-08 21:37:14 +000029#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000030/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
31** contains the text of SQLITE_VERSION macro.
32*/
danielk197724b03fd2004-05-10 10:34:34 +000033const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000034#endif
drh9f129f42010-08-31 15:27:32 +000035
36/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
37** a pointer to the to the sqlite3_version[] string constant.
38*/
drh4aec8b62004-08-28 16:19:00 +000039const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000040
41/* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
42** pointer to a string constant whose value is the same as the
43** SQLITE_SOURCE_ID C preprocessor macro.
44*/
drh47baebc2009-08-14 16:01:24 +000045const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000046
47/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
48** returns an integer equal to SQLITE_VERSION_NUMBER.
49*/
danielk197799ba19e2005-02-05 07:33:34 +000050int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000051
drh5dc2bcd2012-01-02 15:45:12 +000052/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000053** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000054** the SQLITE_THREADSAFE compile-time option being set to 0.
55*/
drhb67e8bf2007-08-30 20:09:48 +000056int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000057
mistachkin34cf2582015-04-02 17:46:52 +000058/*
59** When compiling the test fixture or with debugging enabled (on Win32),
60** this variable being set to non-zero will cause OSTRACE macros to emit
61** extra diagnostic information.
62*/
63#if (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) || \
64 (defined(SQLITE_TEST) || defined(SQLITE_FORCE_OS_TRACE))
65# ifndef SQLITE_DEBUG_OS_TRACE
66# define SQLITE_DEBUG_OS_TRACE 0
67# endif
68 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
69#endif
70
drhe265b082008-05-01 17:03:49 +000071#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000072/*
drhb0603412007-02-28 04:47:26 +000073** If the following function pointer is not NULL and if
74** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
75** I/O active are written using this function. These messages
76** are intended for debugging activity only.
77*/
mistachkin9871a932015-03-27 00:21:52 +000078SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000079#endif
drhb0603412007-02-28 04:47:26 +000080
81/*
drha16313e2007-03-30 11:29:32 +000082** If the following global variable points to a string which is the
83** name of a directory, then that directory will be used to store
84** temporary files.
85**
86** See also the "PRAGMA temp_store_directory" SQL command.
87*/
88char *sqlite3_temp_directory = 0;
89
drhc5499be2008-04-01 15:06:33 +000090/*
mistachkina112d142012-03-14 00:44:01 +000091** If the following global variable points to a string which is the
92** name of a directory, then that directory will be used to store
93** all database files specified with a relative pathname.
94**
95** See also the "PRAGMA data_store_directory" SQL command.
96*/
97char *sqlite3_data_directory = 0;
98
99/*
drh40257ff2008-06-13 18:24:27 +0000100** Initialize SQLite.
101**
102** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +0000103** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +0000104** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
105** this routine will be called automatically by key routines such as
106** sqlite3_open().
107**
108** This routine is a no-op except on its very first call for the process,
109** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +0000110**
111** The first thread to call this routine runs the initialization to
112** completion. If subsequent threads call this routine before the first
113** thread has finished the initialization process, then the subsequent
114** threads must block until the first thread finishes with the initialization.
115**
116** The first thread might call this routine recursively. Recursive
117** calls to this routine should not block, of course. Otherwise the
118** initialization process would never complete.
119**
120** Let X be the first thread to enter this routine. Let Y be some other
121** thread. Then while the initial invocation of this routine by X is
122** incomplete, it is required that:
123**
124** * Calls to this routine from Y must block until the outer-most
125** call by X completes.
126**
127** * Recursive calls to this routine from thread X return immediately
128** without blocking.
drh40257ff2008-06-13 18:24:27 +0000129*/
130int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000131 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000132 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000133#ifdef SQLITE_EXTRA_INIT
134 int bRunExtraInit = 0; /* Extra initialization needed */
135#endif
danielk1977075c23a2008-09-01 18:34:20 +0000136
137#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000138 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000139 if( rc!=SQLITE_OK ){
140 return rc;
141 }
142#endif
danielk197771bc31c2008-06-26 08:29:34 +0000143
drh2b4905c2015-03-23 18:52:56 +0000144 /* If the following assert() fails on some obscure processor/compiler
145 ** combination, the work-around is to set the correct pointer
146 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
147 assert( SQLITE_PTRSIZE==sizeof(char*) );
148
drh93ed56d2008-08-12 15:21:11 +0000149 /* If SQLite is already completely initialized, then this call
150 ** to sqlite3_initialize() should be a no-op. But the initialization
151 ** must be complete. So isInit must not be set until the very end
152 ** of this routine.
153 */
danielk1977075c23a2008-09-01 18:34:20 +0000154 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000155
drh93ed56d2008-08-12 15:21:11 +0000156 /* Make sure the mutex subsystem is initialized. If unable to
157 ** initialize the mutex subsystem, return early with the error.
158 ** If the system is so sick that we are unable to allocate a mutex,
159 ** there is not much SQLite is going to be able to do.
160 **
161 ** The mutex subsystem must take care of serializing its own
162 ** initialization.
163 */
danielk1977d0251742008-06-18 18:57:42 +0000164 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000165 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000166
drh93ed56d2008-08-12 15:21:11 +0000167 /* Initialize the malloc() system and the recursive pInitMutex mutex.
168 ** This operation is protected by the STATIC_MASTER mutex. Note that
169 ** MutexAlloc() is called for a static mutex prior to initializing the
170 ** malloc subsystem - this implies that the allocation of a static
171 ** mutex must not require support from the malloc subsystem.
172 */
drh30ddce62011-10-15 00:16:30 +0000173 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000174 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000175 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000176 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000177 rc = sqlite3MallocInit();
178 }
drh40257ff2008-06-13 18:24:27 +0000179 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000180 sqlite3GlobalConfig.isMallocInit = 1;
181 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000182 sqlite3GlobalConfig.pInitMutex =
183 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000184 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000185 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000186 }
187 }
danielk197777eb5bb2008-09-22 17:22:19 +0000188 }
189 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000190 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000191 }
192 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000193
dane1ab2192009-08-17 15:16:19 +0000194 /* If rc is not SQLITE_OK at this point, then either the malloc
195 ** subsystem could not be initialized or the system failed to allocate
196 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000197 if( rc!=SQLITE_OK ){
198 return rc;
199 }
200
201 /* Do the rest of the initialization under the recursive mutex so
202 ** that we will be able to handle recursive calls into
203 ** sqlite3_initialize(). The recursive calls normally come through
204 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
205 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000206 **
207 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
208 ** to the xInit method, so the xInit method need not be threadsafe.
209 **
210 ** The following mutex is what serializes access to the appdef pcache xInit
211 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
212 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000213 */
danielk1977075c23a2008-09-01 18:34:20 +0000214 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000215 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000216 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000217 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000218 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000219 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000220 if( sqlite3GlobalConfig.isPCacheInit==0 ){
221 rc = sqlite3PcacheInitialize();
222 }
danielk19778c0a7912008-08-20 14:49:23 +0000223 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000224 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000225 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000226 }
227 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000228 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
229 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000230 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000231#ifdef SQLITE_EXTRA_INIT
232 bRunExtraInit = 1;
233#endif
danielk19778c0a7912008-08-20 14:49:23 +0000234 }
danielk1977502b4e02008-09-02 14:07:24 +0000235 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000236 }
danielk1977075c23a2008-09-01 18:34:20 +0000237 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000238
drh93ed56d2008-08-12 15:21:11 +0000239 /* Go back under the static mutex and clean up the recursive
240 ** mutex to prevent a resource leak.
241 */
242 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000243 sqlite3GlobalConfig.nRefInitMutex--;
244 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
245 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
246 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
247 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000248 }
249 sqlite3_mutex_leave(pMaster);
250
251 /* The following is just a sanity check to make sure SQLite has
252 ** been compiled correctly. It is important to run this code, but
253 ** we don't want to run it too often and soak up CPU cycles for no
254 ** reason. So we run it once during initialization.
255 */
shanedfb7b372008-07-22 05:13:30 +0000256#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000257#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000258 /* This section of code's only "output" is via assert() statements. */
259 if ( rc==SQLITE_OK ){
260 u64 x = (((u64)1)<<63)-1;
261 double y;
262 assert(sizeof(x)==8);
263 assert(sizeof(x)==sizeof(y));
264 memcpy(&y, &x, 8);
265 assert( sqlite3IsNaN(y) );
266 }
267#endif
shanefbd60f82009-02-04 03:59:25 +0000268#endif
shanedfb7b372008-07-22 05:13:30 +0000269
drhe4cf0b32011-08-25 00:14:41 +0000270 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
271 ** compile-time option.
272 */
273#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000274 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000275 int SQLITE_EXTRA_INIT(const char*);
276 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000277 }
278#endif
279
drh40257ff2008-06-13 18:24:27 +0000280 return rc;
281}
282
283/*
284** Undo the effects of sqlite3_initialize(). Must not be called while
285** there are outstanding database connections or memory allocations or
286** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000287** routine is not threadsafe. But it is safe to invoke this routine
288** on when SQLite is already shut down. If SQLite is already shut down
289** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000290*/
291int sqlite3_shutdown(void){
mistachkin054450f2014-12-23 20:42:48 +0000292#ifdef SQLITE_OMIT_WSD
293 int rc = sqlite3_wsd_init(4096, 24);
294 if( rc!=SQLITE_OK ){
295 return rc;
296 }
297#endif
298
danielk1977075c23a2008-09-01 18:34:20 +0000299 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000300#ifdef SQLITE_EXTRA_SHUTDOWN
301 void SQLITE_EXTRA_SHUTDOWN(void);
302 SQLITE_EXTRA_SHUTDOWN();
303#endif
drha7640922009-04-21 12:02:56 +0000304 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000305 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000306 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000307 }
dane1ab2192009-08-17 15:16:19 +0000308 if( sqlite3GlobalConfig.isPCacheInit ){
309 sqlite3PcacheShutdown();
310 sqlite3GlobalConfig.isPCacheInit = 0;
311 }
312 if( sqlite3GlobalConfig.isMallocInit ){
313 sqlite3MallocEnd();
314 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000315
316#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
317 /* The heap subsystem has now been shutdown and these values are supposed
318 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
319 ** which would rely on that heap subsystem; therefore, make sure these
320 ** values cannot refer to heap memory that was just invalidated when the
321 ** heap subsystem was shutdown. This is only done if the current call to
322 ** this function resulted in the heap subsystem actually being shutdown.
323 */
324 sqlite3_data_directory = 0;
325 sqlite3_temp_directory = 0;
326#endif
dane1ab2192009-08-17 15:16:19 +0000327 }
328 if( sqlite3GlobalConfig.isMutexInit ){
329 sqlite3MutexEnd();
330 sqlite3GlobalConfig.isMutexInit = 0;
331 }
332
drh40257ff2008-06-13 18:24:27 +0000333 return SQLITE_OK;
334}
335
336/*
337** This API allows applications to modify the global configuration of
338** the SQLite library at run-time.
339**
340** This routine should only be called when there are no outstanding
341** database connections or memory allocations. This routine is not
342** threadsafe. Failure to heed these warnings can lead to unpredictable
343** behavior.
344*/
345int sqlite3_config(int op, ...){
346 va_list ap;
347 int rc = SQLITE_OK;
348
349 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
350 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000351 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000352
353 va_start(ap, op);
354 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000355
356 /* Mutex configuration options are only available in a threadsafe
drhd1dcb232014-11-01 18:32:18 +0000357 ** compile.
drh18472fa2008-10-07 15:25:48 +0000358 */
drhd1dcb232014-11-01 18:32:18 +0000359#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
drh40257ff2008-06-13 18:24:27 +0000360 case SQLITE_CONFIG_SINGLETHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000361 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
362 ** Single-thread. */
363 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
364 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000365 break;
366 }
drhd1dcb232014-11-01 18:32:18 +0000367#endif
368#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
drh40257ff2008-06-13 18:24:27 +0000369 case SQLITE_CONFIG_MULTITHREAD: {
drh682a6ef2015-03-04 23:14:14 +0000370 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
371 ** Multi-thread. */
372 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
373 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000374 break;
375 }
drhd1dcb232014-11-01 18:32:18 +0000376#endif
377#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
drh40257ff2008-06-13 18:24:27 +0000378 case SQLITE_CONFIG_SERIALIZED: {
drh682a6ef2015-03-04 23:14:14 +0000379 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
380 ** Serialized. */
381 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
382 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
drh40257ff2008-06-13 18:24:27 +0000383 break;
384 }
drhd1dcb232014-11-01 18:32:18 +0000385#endif
386#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
drh18472fa2008-10-07 15:25:48 +0000387 case SQLITE_CONFIG_MUTEX: {
388 /* Specify an alternative mutex implementation */
389 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
390 break;
391 }
drhd1dcb232014-11-01 18:32:18 +0000392#endif
393#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
drh18472fa2008-10-07 15:25:48 +0000394 case SQLITE_CONFIG_GETMUTEX: {
395 /* Retrieve the current mutex implementation */
396 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
397 break;
398 }
399#endif
400
drh40257ff2008-06-13 18:24:27 +0000401 case SQLITE_CONFIG_MALLOC: {
drh5279d342014-11-04 13:41:32 +0000402 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
403 ** single argument which is a pointer to an instance of the
404 ** sqlite3_mem_methods structure. The argument specifies alternative
405 ** low-level memory allocation routines to be used in place of the memory
406 ** allocation routines built into SQLite. */
danielk1977075c23a2008-09-01 18:34:20 +0000407 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000408 break;
409 }
drh33589792008-06-18 13:27:46 +0000410 case SQLITE_CONFIG_GETMALLOC: {
drh5279d342014-11-04 13:41:32 +0000411 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
412 ** single argument which is a pointer to an instance of the
413 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
414 ** filled with the currently defined memory allocation routines. */
danielk1977075c23a2008-09-01 18:34:20 +0000415 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
416 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000417 break;
418 }
drhfec00ea2008-06-14 16:56:21 +0000419 case SQLITE_CONFIG_MEMSTATUS: {
drh5279d342014-11-04 13:41:32 +0000420 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
421 ** single argument of type int, interpreted as a boolean, which enables
422 ** or disables the collection of memory allocation statistics. */
423 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000424 break;
425 }
drh33589792008-06-18 13:27:46 +0000426 case SQLITE_CONFIG_SCRATCH: {
drh5279d342014-11-04 13:41:32 +0000427 /* EVIDENCE-OF: R-08404-60887 There are three arguments to
428 ** SQLITE_CONFIG_SCRATCH: A pointer an 8-byte aligned memory buffer from
429 ** which the scratch allocations will be drawn, the size of each scratch
430 ** allocation (sz), and the maximum number of scratch allocations (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000431 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
432 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
433 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000434 break;
435 }
436 case SQLITE_CONFIG_PAGECACHE: {
drh5279d342014-11-04 13:41:32 +0000437 /* EVIDENCE-OF: R-31408-40510 There are three arguments to
438 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory, the size
439 ** of each page buffer (sz), and the number of pages (N). */
danielk1977075c23a2008-09-01 18:34:20 +0000440 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
441 sqlite3GlobalConfig.szPage = va_arg(ap, int);
442 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000443 break;
444 }
drhdef68892014-11-04 12:11:23 +0000445 case SQLITE_CONFIG_PCACHE_HDRSZ: {
drh5279d342014-11-04 13:41:32 +0000446 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
447 ** a single parameter which is a pointer to an integer and writes into
448 ** that integer the number of extra bytes per page required for each page
449 ** in SQLITE_CONFIG_PAGECACHE. */
drhdef68892014-11-04 12:11:23 +0000450 *va_arg(ap, int*) =
451 sqlite3HeaderSizeBtree() +
452 sqlite3HeaderSizePcache() +
453 sqlite3HeaderSizePcache1();
454 break;
455 }
danielk19775099be52008-06-27 13:27:03 +0000456
danielk1977bc2ca9e2008-11-13 14:28:28 +0000457 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000458 /* no-op */
459 break;
460 }
461 case SQLITE_CONFIG_GETPCACHE: {
462 /* now an error */
463 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000464 break;
465 }
466
dan22e21ff2011-11-08 20:08:44 +0000467 case SQLITE_CONFIG_PCACHE2: {
drh5279d342014-11-04 13:41:32 +0000468 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
469 ** single argument which is a pointer to an sqlite3_pcache_methods2
470 ** object. This object specifies the interface to a custom page cache
471 ** implementation. */
dan22e21ff2011-11-08 20:08:44 +0000472 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
473 break;
474 }
475 case SQLITE_CONFIG_GETPCACHE2: {
drh5279d342014-11-04 13:41:32 +0000476 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
477 ** single argument which is a pointer to an sqlite3_pcache_methods2
478 ** object. SQLite copies of the current page cache implementation into
479 ** that object. */
dan22e21ff2011-11-08 20:08:44 +0000480 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000481 sqlite3PCacheSetDefault();
482 }
dan22e21ff2011-11-08 20:08:44 +0000483 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000484 break;
485 }
486
drh8790b6e2014-11-07 01:43:56 +0000487/* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
488** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
489** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
drh5d414832008-07-15 14:47:18 +0000490#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000491 case SQLITE_CONFIG_HEAP: {
drh5279d342014-11-04 13:41:32 +0000492 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
493 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
drh3ba689d2015-03-03 14:00:11 +0000494 ** number of bytes in the memory buffer, and the minimum allocation size.
495 */
danielk1977075c23a2008-09-01 18:34:20 +0000496 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
497 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
498 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000499
shaneha6ec8922011-03-09 21:36:17 +0000500 if( sqlite3GlobalConfig.mnReq<1 ){
501 sqlite3GlobalConfig.mnReq = 1;
502 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
503 /* cap min request size at 2^12 */
504 sqlite3GlobalConfig.mnReq = (1<<12);
505 }
506
danielk1977075c23a2008-09-01 18:34:20 +0000507 if( sqlite3GlobalConfig.pHeap==0 ){
drh8790b6e2014-11-07 01:43:56 +0000508 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
509 ** is NULL, then SQLite reverts to using its default memory allocator
510 ** (the system malloc() implementation), undoing any prior invocation of
511 ** SQLITE_CONFIG_MALLOC.
512 **
513 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
514 ** revert to its default implementation when sqlite3_initialize() is run
drh8a42cbd2008-07-10 18:13:42 +0000515 */
danielk1977075c23a2008-09-01 18:34:20 +0000516 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000517 }else{
drh8790b6e2014-11-07 01:43:56 +0000518 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
519 ** alternative memory allocator is engaged to handle all of SQLites
520 ** memory allocation needs. */
danielk19775099be52008-06-27 13:27:03 +0000521#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000522 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000523#endif
524#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000525 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000526#endif
drh8a42cbd2008-07-10 18:13:42 +0000527 }
danielk19775099be52008-06-27 13:27:03 +0000528 break;
529 }
drh5d414832008-07-15 14:47:18 +0000530#endif
danielk19775099be52008-06-27 13:27:03 +0000531
drh633e6d52008-07-28 19:34:53 +0000532 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000533 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
534 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000535 break;
536 }
drh3f280702010-02-18 18:45:09 +0000537
mistachkin037933b2013-08-13 22:33:41 +0000538 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000539 ** The default is NULL. Logging is disabled if the function pointer is
540 ** NULL.
541 */
542 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000543 /* MSVC is picky about pulling func ptrs from va lists.
544 ** http://support.microsoft.com/kb/47961
545 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
546 */
547 typedef void(*LOGFUNC_t)(void*,int,const char*);
548 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000549 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
550 break;
551 }
drh633e6d52008-07-28 19:34:53 +0000552
drh00729cb2014-10-04 11:59:33 +0000553 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
554 ** can be changed at start-time using the
555 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
556 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
557 */
dancd74b612011-04-22 19:37:32 +0000558 case SQLITE_CONFIG_URI: {
drh4d9f1882014-11-04 17:23:24 +0000559 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
560 ** argument of type int. If non-zero, then URI handling is globally
561 ** enabled. If the parameter is zero, then URI handling is globally
562 ** disabled. */
dancd74b612011-04-22 19:37:32 +0000563 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
564 break;
565 }
566
drhde9a7b82012-09-17 20:44:46 +0000567 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
drh4d9f1882014-11-04 17:23:24 +0000568 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
569 ** option takes a single integer argument which is interpreted as a
570 ** boolean in order to enable or disable the use of covering indices for
571 ** full table scans in the query optimizer. */
drhde9a7b82012-09-17 20:44:46 +0000572 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
573 break;
574 }
575
danac455932012-11-26 19:50:41 +0000576#ifdef SQLITE_ENABLE_SQLLOG
577 case SQLITE_CONFIG_SQLLOG: {
578 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
579 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
580 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
581 break;
582 }
583#endif
584
drh9b4c59f2013-04-15 17:03:42 +0000585 case SQLITE_CONFIG_MMAP_SIZE: {
drh4d9f1882014-11-04 17:23:24 +0000586 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
587 ** integer (sqlite3_int64) values that are the default mmap size limit
588 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
589 ** mmap size limit. */
drh9b4c59f2013-04-15 17:03:42 +0000590 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000591 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh4d9f1882014-11-04 17:23:24 +0000592 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
drh8790b6e2014-11-07 01:43:56 +0000593 ** negative, then that argument is changed to its compile-time default.
594 **
595 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
596 ** silently truncated if necessary so that it does not exceed the
597 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
598 ** compile-time option.
599 */
drh3ba689d2015-03-03 14:00:11 +0000600 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
601 mxMmap = SQLITE_MAX_MMAP_SIZE;
602 }
drh9b4c59f2013-04-15 17:03:42 +0000603 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
604 if( szMmap>mxMmap) szMmap = mxMmap;
drh4d9f1882014-11-04 17:23:24 +0000605 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000606 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000607 break;
608 }
609
drh4d9f1882014-11-04 17:23:24 +0000610#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
mistachkinaf8641b2013-11-25 21:49:04 +0000611 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
drh4d9f1882014-11-04 17:23:24 +0000612 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
613 ** unsigned integer value that specifies the maximum size of the created
614 ** heap. */
mistachkinac1f1042013-11-23 00:27:29 +0000615 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
616 break;
617 }
618#endif
619
drh3bd17912015-01-02 15:55:29 +0000620 case SQLITE_CONFIG_PMASZ: {
621 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
622 break;
623 }
624
drh40257ff2008-06-13 18:24:27 +0000625 default: {
626 rc = SQLITE_ERROR;
627 break;
628 }
629 }
630 va_end(ap);
631 return rc;
632}
633
634/*
drh633e6d52008-07-28 19:34:53 +0000635** Set up the lookaside buffers for a database connection.
636** Return SQLITE_OK on success.
637** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000638**
639** The sz parameter is the number of bytes in each lookaside slot.
640** The cnt parameter is the number of slots. If pStart is NULL the
641** space for the lookaside memory is obtained from sqlite3_malloc().
642** If pStart is not NULL then it is sz*cnt bytes of memory to use for
643** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000644*/
drhe9d1c722008-08-04 20:13:26 +0000645static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000646 void *pStart;
647 if( db->lookaside.nOut ){
648 return SQLITE_BUSY;
649 }
shanef71f89e2009-01-30 06:11:54 +0000650 /* Free any existing lookaside buffer for this handle before
651 ** allocating a new one so we don't have to have space for
652 ** both at the same time.
653 */
654 if( db->lookaside.bMalloced ){
655 sqlite3_free(db->lookaside.pStart);
656 }
drh61a4bd52011-11-10 02:39:28 +0000657 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
658 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000659 */
drh61a4bd52011-11-10 02:39:28 +0000660 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000661 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000662 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000663 if( sz==0 || cnt==0 ){
664 sz = 0;
665 pStart = 0;
666 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000667 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000668 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000669 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000670 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000671 }else{
672 pStart = pBuf;
673 }
drh4cfb22f2008-08-01 18:47:01 +0000674 db->lookaside.pStart = pStart;
675 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000676 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000677 if( pStart ){
678 int i;
679 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000680 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000681 p = (LookasideSlot*)pStart;
682 for(i=cnt-1; i>=0; i--){
683 p->pNext = db->lookaside.pFree;
684 db->lookaside.pFree = p;
685 p = (LookasideSlot*)&((u8*)p)[sz];
686 }
687 db->lookaside.pEnd = p;
688 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000689 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000690 }else{
drhb0e77042013-12-10 19:49:00 +0000691 db->lookaside.pStart = db;
692 db->lookaside.pEnd = db;
drh4cfb22f2008-08-01 18:47:01 +0000693 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000694 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000695 }
696 return SQLITE_OK;
697}
698
699/*
drh4413d0e2008-11-04 13:46:27 +0000700** Return the mutex associated with a database connection.
701*/
702sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000703#ifdef SQLITE_ENABLE_API_ARMOR
704 if( !sqlite3SafetyCheckOk(db) ){
705 (void)SQLITE_MISUSE_BKPT;
706 return 0;
707 }
708#endif
drh4413d0e2008-11-04 13:46:27 +0000709 return db->mutex;
710}
711
712/*
drh09419b42011-11-16 19:29:17 +0000713** Free up as much memory as we can from the given database
714** connection.
715*/
716int sqlite3_db_release_memory(sqlite3 *db){
717 int i;
drh9ca95732014-10-24 00:35:58 +0000718
719#ifdef SQLITE_ENABLE_API_ARMOR
720 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
721#endif
dand9bb3a92011-12-30 11:43:59 +0000722 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000723 sqlite3BtreeEnterAll(db);
724 for(i=0; i<db->nDb; i++){
725 Btree *pBt = db->aDb[i].pBt;
726 if( pBt ){
727 Pager *pPager = sqlite3BtreePager(pBt);
728 sqlite3PagerShrink(pPager);
729 }
730 }
731 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000732 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000733 return SQLITE_OK;
734}
735
736/*
drh633e6d52008-07-28 19:34:53 +0000737** Configuration settings for an individual database connection
738*/
739int sqlite3_db_config(sqlite3 *db, int op, ...){
740 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000741 int rc;
drh633e6d52008-07-28 19:34:53 +0000742 va_start(ap, op);
743 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000744 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000745 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000746 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
747 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000748 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000749 break;
750 }
drh6480aad2008-08-01 16:31:14 +0000751 default: {
drhe83cafd2011-03-21 17:15:58 +0000752 static const struct {
753 int op; /* The opcode */
754 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
755 } aFlagOp[] = {
756 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
757 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
758 };
drh58ad5802011-03-23 22:02:23 +0000759 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000760 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000761 for(i=0; i<ArraySize(aFlagOp); i++){
762 if( aFlagOp[i].op==op ){
763 int onoff = va_arg(ap, int);
764 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000765 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000766 if( onoff>0 ){
767 db->flags |= aFlagOp[i].mask;
768 }else if( onoff==0 ){
769 db->flags &= ~aFlagOp[i].mask;
770 }
771 if( oldFlags!=db->flags ){
772 sqlite3ExpirePreparedStatements(db);
773 }
774 if( pRes ){
775 *pRes = (db->flags & aFlagOp[i].mask)!=0;
776 }
777 rc = SQLITE_OK;
778 break;
779 }
780 }
drh6480aad2008-08-01 16:31:14 +0000781 break;
782 }
drh633e6d52008-07-28 19:34:53 +0000783 }
784 va_end(ap);
785 return rc;
786}
787
drha16313e2007-03-30 11:29:32 +0000788
789/*
drh9b5adfa2008-01-20 23:19:56 +0000790** Return true if the buffer z[0..n-1] contains all spaces.
791*/
792static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000793 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000794 return n==0;
795}
796
797/*
drhd3d39e92004-05-20 22:16:29 +0000798** This is the default collating function named "BINARY" which is always
799** available.
drh9b5adfa2008-01-20 23:19:56 +0000800**
801** If the padFlag argument is not NULL then space padding at the end
802** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000803*/
danielk19772c336542005-01-13 02:14:23 +0000804static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000805 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000806 int nKey1, const void *pKey1,
807 int nKey2, const void *pKey2
808){
809 int rc, n;
810 n = nKey1<nKey2 ? nKey1 : nKey2;
drh5e3b49b2014-11-20 19:22:26 +0000811 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
812 ** strings byte by byte using the memcmp() function from the standard C
813 ** library. */
drhd3d39e92004-05-20 22:16:29 +0000814 rc = memcmp(pKey1, pKey2, n);
815 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000816 if( padFlag
817 && allSpaces(((char*)pKey1)+n, nKey1-n)
818 && allSpaces(((char*)pKey2)+n, nKey2-n)
819 ){
drh5e3b49b2014-11-20 19:22:26 +0000820 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
821 ** spaces at the end of either string do not change the result. In other
822 ** words, strings will compare equal to one another as long as they
823 ** differ only in the number of spaces at the end.
824 */
drh9b5adfa2008-01-20 23:19:56 +0000825 }else{
826 rc = nKey1 - nKey2;
827 }
drhd3d39e92004-05-20 22:16:29 +0000828 }
829 return rc;
830}
831
832/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000833** Another built-in collating sequence: NOCASE.
834**
drhf7b54962013-05-28 12:11:54 +0000835** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000836** comparison". SQLite's knowledge of upper and lower case equivalents
837** extends only to the 26 characters used in the English language.
838**
839** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000840*/
841static int nocaseCollatingFunc(
842 void *NotUsed,
843 int nKey1, const void *pKey1,
844 int nKey2, const void *pKey2
845){
846 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000847 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000848 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000849 if( 0==r ){
850 r = nKey1-nKey2;
851 }
852 return r;
853}
854
855/*
drhaf9ff332002-01-16 21:00:27 +0000856** Return the ROWID of the most recent insert
857*/
drh9bb575f2004-09-06 17:24:11 +0000858sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000859#ifdef SQLITE_ENABLE_API_ARMOR
860 if( !sqlite3SafetyCheckOk(db) ){
861 (void)SQLITE_MISUSE_BKPT;
862 return 0;
863 }
864#endif
drhaf9ff332002-01-16 21:00:27 +0000865 return db->lastRowid;
866}
867
868/*
danielk197724b03fd2004-05-10 10:34:34 +0000869** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000870*/
drh9bb575f2004-09-06 17:24:11 +0000871int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000872#ifdef SQLITE_ENABLE_API_ARMOR
873 if( !sqlite3SafetyCheckOk(db) ){
874 (void)SQLITE_MISUSE_BKPT;
875 return 0;
876 }
877#endif
drhc8d30ac2002-04-12 10:08:59 +0000878 return db->nChange;
879}
880
rdcf146a772004-02-25 22:51:06 +0000881/*
danielk1977b28af712004-06-21 06:50:26 +0000882** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000883*/
danielk1977b28af712004-06-21 06:50:26 +0000884int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000885#ifdef SQLITE_ENABLE_API_ARMOR
886 if( !sqlite3SafetyCheckOk(db) ){
887 (void)SQLITE_MISUSE_BKPT;
888 return 0;
889 }
890#endif
danielk1977b28af712004-06-21 06:50:26 +0000891 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000892}
893
drhc8d30ac2002-04-12 10:08:59 +0000894/*
danielk1977fd7f0452008-12-17 17:30:26 +0000895** Close all open savepoints. This function only manipulates fields of the
896** database handle object, it does not close any savepoints that may be open
897** at the b-tree/pager level.
898*/
899void sqlite3CloseSavepoints(sqlite3 *db){
900 while( db->pSavepoint ){
901 Savepoint *pTmp = db->pSavepoint;
902 db->pSavepoint = pTmp->pNext;
903 sqlite3DbFree(db, pTmp);
904 }
905 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000906 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000907 db->isTransactionSavepoint = 0;
908}
909
910/*
dand2199f02010-08-27 17:48:52 +0000911** Invoke the destructor function associated with FuncDef p, if any. Except,
912** if this is not the last copy of the function, do not invoke it. Multiple
913** copies of a single function are created when create_function() is called
914** with SQLITE_ANY as the encoding.
915*/
916static void functionDestroy(sqlite3 *db, FuncDef *p){
917 FuncDestructor *pDestructor = p->pDestructor;
918 if( pDestructor ){
919 pDestructor->nRef--;
920 if( pDestructor->nRef==0 ){
921 pDestructor->xDestroy(pDestructor->pUserData);
922 sqlite3DbFree(db, pDestructor);
923 }
924 }
925}
926
927/*
danbba02a92012-05-15 17:15:34 +0000928** Disconnect all sqlite3_vtab objects that belong to database connection
929** db. This is called when db is being closed.
930*/
931static void disconnectAllVtab(sqlite3 *db){
932#ifndef SQLITE_OMIT_VIRTUALTABLE
933 int i;
934 sqlite3BtreeEnterAll(db);
935 for(i=0; i<db->nDb; i++){
936 Schema *pSchema = db->aDb[i].pSchema;
937 if( db->aDb[i].pSchema ){
938 HashElem *p;
939 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
940 Table *pTab = (Table *)sqliteHashData(p);
941 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
942 }
943 }
944 }
dand88e5212014-03-12 19:38:38 +0000945 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000946 sqlite3BtreeLeaveAll(db);
947#else
948 UNUSED_PARAMETER(db);
949#endif
950}
951
952/*
drh167cd6a2012-06-02 17:09:46 +0000953** Return TRUE if database connection db has unfinalized prepared
954** statements or unfinished sqlite3_backup objects.
955*/
956static int connectionIsBusy(sqlite3 *db){
957 int j;
958 assert( sqlite3_mutex_held(db->mutex) );
959 if( db->pVdbe ) return 1;
960 for(j=0; j<db->nDb; j++){
961 Btree *pBt = db->aDb[j].pBt;
962 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
963 }
964 return 0;
965}
966
967/*
drh50e5dad2001-09-15 00:57:28 +0000968** Close an existing SQLite database
969*/
drh167cd6a2012-06-02 17:09:46 +0000970static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000971 if( !db ){
drhddb17ca2014-08-11 15:54:11 +0000972 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
973 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +0000974 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000975 }
drh7e8b8482008-01-23 03:03:05 +0000976 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000977 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000978 }
drh605264d2007-08-21 15:13:19 +0000979 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000980
danbba02a92012-05-15 17:15:34 +0000981 /* Force xDisconnect calls on all virtual tables */
982 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000983
danbba02a92012-05-15 17:15:34 +0000984 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000985 ** will not have called the xDisconnect() method on any virtual
986 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
987 ** call will do so. We need to do this before the check for active
988 ** SQL statements below, as the v-table implementation may be storing
989 ** some prepared statements internally.
990 */
dan67430812013-05-15 10:21:50 +0000991 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000992
drh167cd6a2012-06-02 17:09:46 +0000993 /* Legacy behavior (sqlite3_close() behavior) is to return
994 ** SQLITE_BUSY if the connection can not be closed immediately.
995 */
996 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +0000997 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +0000998 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000999 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +00001000 return SQLITE_BUSY;
1001 }
danielk1977e0048402004-06-15 16:51:01 +00001002
danac455932012-11-26 19:50:41 +00001003#ifdef SQLITE_ENABLE_SQLLOG
1004 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00001005 /* Closing the handle. Fourth parameter is passed the value 2. */
1006 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +00001007 }
1008#endif
1009
drh167cd6a2012-06-02 17:09:46 +00001010 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +00001011 */
1012 db->magic = SQLITE_MAGIC_ZOMBIE;
1013 sqlite3LeaveMutexAndCloseZombie(db);
1014 return SQLITE_OK;
1015}
drh94e92032003-02-16 22:21:32 +00001016
drh167cd6a2012-06-02 17:09:46 +00001017/*
1018** Two variations on the public interface for closing a database
1019** connection. The sqlite3_close() version returns SQLITE_BUSY and
1020** leaves the connection option if there are unfinalized prepared
1021** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1022** version forces the connection to become a zombie if there are
1023** unclosed resources, and arranges for deallocation when the last
1024** prepare statement or sqlite3_backup closes.
1025*/
1026int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1027int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1028
drh4245c402012-06-02 14:32:21 +00001029
1030/*
1031** Close the mutex on database connection db.
1032**
1033** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +00001034** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1035** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1036** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +00001037*/
1038void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1039 HashElem *i; /* Hash table iterator */
1040 int j;
1041
drh4245c402012-06-02 14:32:21 +00001042 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +00001043 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1044 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +00001045 */
drh167cd6a2012-06-02 17:09:46 +00001046 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +00001047 sqlite3_mutex_leave(db->mutex);
1048 return;
danielk197704103022009-02-03 16:51:24 +00001049 }
1050
drh4245c402012-06-02 14:32:21 +00001051 /* If we reach this point, it means that the database connection has
1052 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +00001053 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +00001054 ** go ahead and free all resources.
1055 */
1056
dan617dc862013-05-16 11:57:28 +00001057 /* If a transaction is open, roll it back. This also ensures that if
1058 ** any database schemas have been modified by an uncommitted transaction
1059 ** they are reset. And that the required b-tree mutex is held to make
1060 ** the pager rollback and schema reset an atomic operation. */
1061 sqlite3RollbackAll(db, SQLITE_OK);
1062
danielk1977fd7f0452008-12-17 17:30:26 +00001063 /* Free any outstanding Savepoint structures. */
1064 sqlite3CloseSavepoints(db);
1065
drh5efb3142012-05-16 01:24:34 +00001066 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +00001067 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +00001068 struct Db *pDb = &db->aDb[j];
1069 if( pDb->pBt ){
drhebdb81d2014-12-05 15:31:33 +00001070 sqlite3BtreeClose(pDb->pBt);
1071 pDb->pBt = 0;
1072 if( j!=1 ){
danielk1977311019b2006-01-10 07:14:23 +00001073 pDb->pSchema = 0;
1074 }
drh113088e2003-03-20 01:16:58 +00001075 }
drhf57b3392001-10-08 13:22:32 +00001076 }
drh5efb3142012-05-16 01:24:34 +00001077 /* Clear the TEMP schema separately and last */
1078 if( db->aDb[1].pSchema ){
1079 sqlite3SchemaClear(db->aDb[1].pSchema);
1080 }
1081 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +00001082
drh5efb3142012-05-16 01:24:34 +00001083 /* Free up the array of auxiliary databases */
1084 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +00001085 assert( db->nDb<=2 );
1086 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +00001087
1088 /* Tell the code in notify.c that the connection no longer holds any
1089 ** locks and does not require any further unlock-notify callbacks.
1090 */
1091 sqlite3ConnectionClosed(db);
1092
drh70a8ca32008-08-21 18:49:27 +00001093 for(j=0; j<ArraySize(db->aFunc.a); j++){
1094 FuncDef *pNext, *pHash, *p;
1095 for(p=db->aFunc.a[j]; p; p=pHash){
1096 pHash = p->pHash;
1097 while( p ){
dand2199f02010-08-27 17:48:52 +00001098 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +00001099 pNext = p->pNext;
1100 sqlite3DbFree(db, p);
1101 p = pNext;
1102 }
drh8e0a2f92002-02-23 23:45:45 +00001103 }
1104 }
danielk1977d8123362004-06-12 09:25:12 +00001105 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +00001106 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +00001107 /* Invoke any destructors registered for collation sequence user data. */
1108 for(j=0; j<3; j++){
1109 if( pColl[j].xDel ){
1110 pColl[j].xDel(pColl[j].pUser);
1111 }
1112 }
drh633e6d52008-07-28 19:34:53 +00001113 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001114 }
danielk1977d8123362004-06-12 09:25:12 +00001115 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001116#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001117 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1118 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001119 if( pMod->xDestroy ){
1120 pMod->xDestroy(pMod->pAux);
1121 }
drh633e6d52008-07-28 19:34:53 +00001122 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001123 }
drhb9bb7c12006-06-11 23:41:55 +00001124 sqlite3HashClear(&db->aModule);
1125#endif
danielk1977466be562004-06-10 02:16:01 +00001126
drh13f40da2014-08-22 18:00:11 +00001127 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001128 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001129 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001130#if SQLITE_USER_AUTHENTICATION
1131 sqlite3_free(db->auth.zAuthUser);
1132 sqlite3_free(db->auth.zAuthPW);
1133#endif
danielk197796d81f92004-06-19 03:33:57 +00001134
1135 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001136
1137 /* The temp-database schema is allocated differently from the other schema
1138 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1139 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1140 ** the same sqliteMalloc() as the one that allocates the database
1141 ** structure?
1142 */
drh633e6d52008-07-28 19:34:53 +00001143 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001144 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001145 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001146 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001147 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001148 if( db->lookaside.bMalloced ){
1149 sqlite3_free(db->lookaside.pStart);
1150 }
drh17435752007-08-16 04:30:38 +00001151 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001152}
1153
1154/*
drh0f198a72012-02-13 16:43:16 +00001155** Rollback all database files. If tripCode is not SQLITE_OK, then
drh47b7fc72014-11-11 01:33:57 +00001156** any write cursors are invalidated ("tripped" - as in "tripping a circuit
drh0f198a72012-02-13 16:43:16 +00001157** breaker") and made to return tripCode if there are any further
drh47b7fc72014-11-11 01:33:57 +00001158** attempts to use that cursor. Read cursors remain open and valid
1159** but are "saved" in case the table pages are moved around.
drh001bbcb2003-03-19 03:14:00 +00001160*/
drh0f198a72012-02-13 16:43:16 +00001161void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001162 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001163 int inTrans = 0;
drh47b7fc72014-11-11 01:33:57 +00001164 int schemaChange;
drhe30f4422007-08-21 16:15:55 +00001165 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001166 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001167
1168 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1169 ** This is important in case the transaction being rolled back has
1170 ** modified the database schema. If the b-tree mutexes are not taken
1171 ** here, then another shared-cache connection might sneak in between
1172 ** the database rollback and schema reset, which can cause false
1173 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001174 sqlite3BtreeEnterAll(db);
drh47b7fc72014-11-11 01:33:57 +00001175 schemaChange = (db->flags & SQLITE_InternChanges)!=0 && db->init.busy==0;
dan617dc862013-05-16 11:57:28 +00001176
drh001bbcb2003-03-19 03:14:00 +00001177 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001178 Btree *p = db->aDb[i].pBt;
1179 if( p ){
1180 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001181 inTrans = 1;
1182 }
drh47b7fc72014-11-11 01:33:57 +00001183 sqlite3BtreeRollback(p, tripCode, !schemaChange);
drh001bbcb2003-03-19 03:14:00 +00001184 }
1185 }
danielk1977a298e902006-06-22 09:53:48 +00001186 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001187 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001188
drh5c5760a2013-02-19 18:34:45 +00001189 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001190 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001191 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001192 }
dancd7b91a2013-05-13 18:23:15 +00001193 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001194
dan1da40a32009-09-19 17:00:31 +00001195 /* Any deferred constraint violations have now been resolved. */
1196 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001197 db->nDeferredImmCons = 0;
1198 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001199
danielk197771fd80b2005-12-16 06:54:01 +00001200 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001201 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001202 db->xRollbackCallback(db->pRollbackArg);
1203 }
drh001bbcb2003-03-19 03:14:00 +00001204}
1205
1206/*
mistachkinf2c1c992013-04-28 01:44:43 +00001207** Return a static string containing the name corresponding to the error code
1208** specified in the argument.
1209*/
mistachkind25675f2015-03-31 19:06:46 +00001210#if (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) || \
mistachkineb48b062015-03-31 17:45:44 +00001211 (defined(SQLITE_TEST) || defined(SQLITE_FORCE_OS_TRACE))
mistachkinf2c1c992013-04-28 01:44:43 +00001212const char *sqlite3ErrName(int rc){
1213 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001214 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001215 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1216 switch( rc ){
1217 case SQLITE_OK: zName = "SQLITE_OK"; break;
1218 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1219 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1220 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1221 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001222 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001223 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001224 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001225 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001226 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1227 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1228 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1229 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001230 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1231 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1232 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001233 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001234 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1235 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001236 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1237 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1238 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1239 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1240 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1241 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1242 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1243 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1244 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1245 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001246 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1247 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1248 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1249 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1250 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1251 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1252 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1253 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1254 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1255 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1256 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1257 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1258 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1259 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001260 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001261 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001262 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001263 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001264 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1265 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1266 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001267 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1268 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1269 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001270 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001271 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1272 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1273 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1274 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1275 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1276 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1277 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1278 case SQLITE_CONSTRAINT_FOREIGNKEY:
1279 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1280 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1281 case SQLITE_CONSTRAINT_PRIMARYKEY:
1282 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1283 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1284 case SQLITE_CONSTRAINT_COMMITHOOK:
1285 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1286 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1287 case SQLITE_CONSTRAINT_FUNCTION:
1288 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001289 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001290 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1291 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1292 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1293 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1294 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1295 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1296 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1297 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1298 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001299 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1300 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1301 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001302 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001303 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001304 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001305 }
1306 }
mistachkin10269dc2013-04-30 07:54:42 +00001307 if( zName==0 ){
1308 static char zBuf[50];
1309 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1310 zName = zBuf;
1311 }
mistachkinf2c1c992013-04-28 01:44:43 +00001312 return zName;
1313}
mistachkin10269dc2013-04-30 07:54:42 +00001314#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001315
1316/*
drhc22bd472002-05-10 13:14:07 +00001317** Return a static string that describes the kind of error specified in the
1318** argument.
drh247be432002-05-10 05:44:55 +00001319*/
danielk1977f20b21c2004-05-31 23:56:42 +00001320const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001321 static const char* const aMsg[] = {
1322 /* SQLITE_OK */ "not an error",
1323 /* SQLITE_ERROR */ "SQL logic error or missing database",
1324 /* SQLITE_INTERNAL */ 0,
1325 /* SQLITE_PERM */ "access permission denied",
1326 /* SQLITE_ABORT */ "callback requested query abort",
1327 /* SQLITE_BUSY */ "database is locked",
1328 /* SQLITE_LOCKED */ "database table is locked",
1329 /* SQLITE_NOMEM */ "out of memory",
1330 /* SQLITE_READONLY */ "attempt to write a readonly database",
1331 /* SQLITE_INTERRUPT */ "interrupted",
1332 /* SQLITE_IOERR */ "disk I/O error",
1333 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001334 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001335 /* SQLITE_FULL */ "database or disk is full",
1336 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001337 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001338 /* SQLITE_EMPTY */ "table contains no data",
1339 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001340 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001341 /* SQLITE_CONSTRAINT */ "constraint failed",
1342 /* SQLITE_MISMATCH */ "datatype mismatch",
1343 /* SQLITE_MISUSE */ "library routine called out of sequence",
1344 /* SQLITE_NOLFS */ "large file support is disabled",
1345 /* SQLITE_AUTH */ "authorization denied",
1346 /* SQLITE_FORMAT */ "auxiliary database format error",
1347 /* SQLITE_RANGE */ "bind or column index out of range",
1348 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1349 };
drh21021a52012-02-13 17:01:51 +00001350 const char *zErr = "unknown error";
1351 switch( rc ){
1352 case SQLITE_ABORT_ROLLBACK: {
1353 zErr = "abort due to ROLLBACK";
1354 break;
1355 }
1356 default: {
1357 rc &= 0xff;
1358 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1359 zErr = aMsg[rc];
1360 }
1361 break;
1362 }
drh247be432002-05-10 05:44:55 +00001363 }
drh21021a52012-02-13 17:01:51 +00001364 return zErr;
drh247be432002-05-10 05:44:55 +00001365}
1366
1367/*
drh2dfbbca2000-07-28 14:32:48 +00001368** This routine implements a busy callback that sleeps and tries
1369** again until a timeout value is reached. The timeout value is
1370** an integer number of milliseconds passed in as the first
1371** argument.
1372*/
drhdaffd0e2001-04-11 14:28:42 +00001373static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001374 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001375 int count /* Number of times table has been busy */
1376){
drh0ede9eb2015-01-10 16:49:23 +00001377#if SQLITE_OS_WIN || HAVE_USLEEP
drhee570fa2005-04-28 12:06:05 +00001378 static const u8 delays[] =
1379 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1380 static const u8 totals[] =
1381 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001382# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001383 sqlite3 *db = (sqlite3 *)ptr;
1384 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001385 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001386
drhee570fa2005-04-28 12:06:05 +00001387 assert( count>=0 );
1388 if( count < NDELAY ){
1389 delay = delays[count];
1390 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001391 }else{
1392 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001393 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001394 }
drhd1bec472004-01-15 13:29:31 +00001395 if( prior + delay > timeout ){
1396 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001397 if( delay<=0 ) return 0;
1398 }
danielk19772a6bdf62007-08-20 16:07:00 +00001399 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001400 return 1;
1401#else
drh482ea182007-08-20 11:12:40 +00001402 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001403 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001404 if( (count+1)*1000 > timeout ){
1405 return 0;
1406 }
drh482ea182007-08-20 11:12:40 +00001407 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001408 return 1;
1409#endif
1410}
1411
1412/*
drha4afb652005-07-09 02:16:02 +00001413** Invoke the given busy handler.
1414**
1415** This routine is called when an operation failed with a lock.
1416** If this routine returns non-zero, the lock is retried. If it
1417** returns 0, the operation aborts with an SQLITE_BUSY error.
1418*/
1419int sqlite3InvokeBusyHandler(BusyHandler *p){
1420 int rc;
drh34004ce2008-07-11 16:15:17 +00001421 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001422 rc = p->xFunc(p->pArg, p->nBusy);
1423 if( rc==0 ){
1424 p->nBusy = -1;
1425 }else{
1426 p->nBusy++;
1427 }
1428 return rc;
1429}
1430
1431/*
drh2dfbbca2000-07-28 14:32:48 +00001432** This routine sets the busy callback for an Sqlite database to the
1433** given callback function with the given argument.
1434*/
danielk1977f9d64d22004-06-19 08:18:07 +00001435int sqlite3_busy_handler(
1436 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001437 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001438 void *pArg
1439){
drh9ca95732014-10-24 00:35:58 +00001440#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +00001441 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh9ca95732014-10-24 00:35:58 +00001442#endif
drhe30f4422007-08-21 16:15:55 +00001443 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001444 db->busyHandler.xFunc = xBusy;
1445 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001446 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001447 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001448 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001449 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001450}
1451
danielk1977348bb5d2003-10-18 09:37:26 +00001452#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1453/*
1454** This routine sets the progress callback for an Sqlite database to the
1455** given callback function with the given argument. The progress callback will
1456** be invoked every nOps opcodes.
1457*/
danielk197724b03fd2004-05-10 10:34:34 +00001458void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001459 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001460 int nOps,
1461 int (*xProgress)(void*),
1462 void *pArg
1463){
drh9ca95732014-10-24 00:35:58 +00001464#ifdef SQLITE_ENABLE_API_ARMOR
1465 if( !sqlite3SafetyCheckOk(db) ){
1466 (void)SQLITE_MISUSE_BKPT;
1467 return;
1468 }
1469#endif
drhbd0b1b52008-07-07 19:52:09 +00001470 sqlite3_mutex_enter(db->mutex);
1471 if( nOps>0 ){
1472 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001473 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001474 db->pProgressArg = pArg;
1475 }else{
1476 db->xProgress = 0;
1477 db->nProgressOps = 0;
1478 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001479 }
drhbd0b1b52008-07-07 19:52:09 +00001480 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001481}
1482#endif
1483
1484
drh2dfbbca2000-07-28 14:32:48 +00001485/*
1486** This routine installs a default busy handler that waits for the
1487** specified number of milliseconds before returning 0.
1488*/
danielk1977f9d64d22004-06-19 08:18:07 +00001489int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001490#ifdef SQLITE_ENABLE_API_ARMOR
1491 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1492#endif
drh2dfbbca2000-07-28 14:32:48 +00001493 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001494 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001495 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001496 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001497 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001498 }
danielk1977f9d64d22004-06-19 08:18:07 +00001499 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001500}
drh4c504392000-10-16 22:06:40 +00001501
1502/*
1503** Cause any pending operation to stop at its earliest opportunity.
1504*/
drh9bb575f2004-09-06 17:24:11 +00001505void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001506#ifdef SQLITE_ENABLE_API_ARMOR
1507 if( !sqlite3SafetyCheckOk(db) ){
1508 (void)SQLITE_MISUSE_BKPT;
1509 return;
1510 }
1511#endif
drhbd0b1b52008-07-07 19:52:09 +00001512 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001513}
drhfa86c412002-02-02 15:01:15 +00001514
drhfa86c412002-02-02 15:01:15 +00001515
1516/*
danielk1977771151b2006-01-17 13:21:40 +00001517** This function is exactly the same as sqlite3_create_function(), except
1518** that it is designed to be called by internal code. The difference is
1519** that if a malloc() fails in sqlite3_create_function(), an error code
1520** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001521*/
danielk1977771151b2006-01-17 13:21:40 +00001522int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001523 sqlite3 *db,
1524 const char *zFunctionName,
1525 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001526 int enc,
danielk197765904932004-05-26 06:18:37 +00001527 void *pUserData,
1528 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1529 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001530 void (*xFinal)(sqlite3_context*),
1531 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001532){
drh0bce8352002-02-28 00:41:10 +00001533 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001534 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001535 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001536
drhe30f4422007-08-21 16:15:55 +00001537 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001538 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001539 (xFunc && (xFinal || xStep)) ||
1540 (!xFunc && (xFinal && !xStep)) ||
1541 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001542 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001543 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001544 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001545 }
drh4a8ee3d2013-12-14 13:44:22 +00001546
1547 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1548 extraFlags = enc & SQLITE_DETERMINISTIC;
1549 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001550
danielk197793758c82005-01-21 08:13:14 +00001551#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001552 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1553 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1554 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1555 **
1556 ** If SQLITE_ANY is specified, add three versions of the function
1557 ** to the hash table.
1558 */
1559 if( enc==SQLITE_UTF16 ){
1560 enc = SQLITE_UTF16NATIVE;
1561 }else if( enc==SQLITE_ANY ){
1562 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001563 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dand2199f02010-08-27 17:48:52 +00001564 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001565 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001566 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dand2199f02010-08-27 17:48:52 +00001567 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001568 }
1569 if( rc!=SQLITE_OK ){
1570 return rc;
1571 }
danielk1977d8123362004-06-12 09:25:12 +00001572 enc = SQLITE_UTF16BE;
1573 }
danielk197793758c82005-01-21 08:13:14 +00001574#else
1575 enc = SQLITE_UTF8;
1576#endif
danielk19779636c4e2005-01-25 04:27:54 +00001577
1578 /* Check if an existing function is being overridden or deleted. If so,
1579 ** and there are active VMs, then return SQLITE_BUSY. If a function
1580 ** is being overridden/deleted but there are no active VMs, allow the
1581 ** operation to continue but invalidate all precompiled statements.
1582 */
drh3abbd392008-12-10 23:04:13 +00001583 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001584 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001585 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001586 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001587 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001588 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001589 return SQLITE_BUSY;
1590 }else{
1591 sqlite3ExpirePreparedStatements(db);
1592 }
1593 }
danielk197765904932004-05-26 06:18:37 +00001594
drh3abbd392008-12-10 23:04:13 +00001595 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001596 assert(p || db->mallocFailed);
1597 if( !p ){
1598 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001599 }
dand2199f02010-08-27 17:48:52 +00001600
1601 /* If an older version of the function with a configured destructor is
1602 ** being replaced invoke the destructor function here. */
1603 functionDestroy(db, p);
1604
1605 if( pDestructor ){
1606 pDestructor->nRef++;
1607 }
1608 p->pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001609 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1610 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
danielk1977fa18bec2007-09-03 11:04:22 +00001611 p->xFunc = xFunc;
1612 p->xStep = xStep;
1613 p->xFinalize = xFinal;
1614 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001615 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001616 return SQLITE_OK;
1617}
danielk1977771151b2006-01-17 13:21:40 +00001618
1619/*
1620** Create new user functions.
1621*/
1622int sqlite3_create_function(
1623 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001624 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001625 int nArg,
1626 int enc,
1627 void *p,
1628 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1629 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1630 void (*xFinal)(sqlite3_context*)
1631){
drh7b19fac2010-08-27 18:44:54 +00001632 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1633 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001634}
1635
1636int sqlite3_create_function_v2(
1637 sqlite3 *db,
1638 const char *zFunc,
1639 int nArg,
1640 int enc,
1641 void *p,
1642 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1643 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1644 void (*xFinal)(sqlite3_context*),
1645 void (*xDestroy)(void *)
1646){
shanehbd2aaf92010-09-01 02:38:21 +00001647 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001648 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001649
1650#ifdef SQLITE_ENABLE_API_ARMOR
1651 if( !sqlite3SafetyCheckOk(db) ){
1652 return SQLITE_MISUSE_BKPT;
1653 }
1654#endif
dand2199f02010-08-27 17:48:52 +00001655 sqlite3_mutex_enter(db->mutex);
1656 if( xDestroy ){
1657 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001658 if( !pArg ){
1659 xDestroy(p);
1660 goto out;
1661 }
dand2199f02010-08-27 17:48:52 +00001662 pArg->xDestroy = xDestroy;
1663 pArg->pUserData = p;
1664 }
1665 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1666 if( pArg && pArg->nRef==0 ){
1667 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001668 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001669 sqlite3DbFree(db, pArg);
1670 }
1671
1672 out:
drhe30f4422007-08-21 16:15:55 +00001673 rc = sqlite3ApiExit(db, rc);
1674 sqlite3_mutex_leave(db->mutex);
1675 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001676}
1677
danielk197793758c82005-01-21 08:13:14 +00001678#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001679int sqlite3_create_function16(
1680 sqlite3 *db,
1681 const void *zFunctionName,
1682 int nArg,
1683 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001684 void *p,
danielk197765904932004-05-26 06:18:37 +00001685 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1686 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1687 void (*xFinal)(sqlite3_context*)
1688){
1689 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001690 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001691
1692#ifdef SQLITE_ENABLE_API_ARMOR
1693 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1694#endif
drhe30f4422007-08-21 16:15:55 +00001695 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001696 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001697 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001698 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001699 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001700 rc = sqlite3ApiExit(db, rc);
1701 sqlite3_mutex_leave(db->mutex);
1702 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001703}
danielk197793758c82005-01-21 08:13:14 +00001704#endif
drhc9b84a12002-06-20 11:36:48 +00001705
drhb7481e72006-09-16 21:45:14 +00001706
1707/*
1708** Declare that a function has been overloaded by a virtual table.
1709**
1710** If the function already exists as a regular global function, then
1711** this routine is a no-op. If the function does not exist, then create
1712** a new one that always throws a run-time error.
1713**
1714** When virtual tables intend to provide an overloaded function, they
1715** should call this routine to make sure the global function exists.
1716** A global function must exist in order for name resolution to work
1717** properly.
1718*/
1719int sqlite3_overload_function(
1720 sqlite3 *db,
1721 const char *zName,
1722 int nArg
1723){
drhdee0e402009-05-03 20:23:53 +00001724 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001725 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001726
1727#ifdef SQLITE_ENABLE_API_ARMOR
1728 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1729 return SQLITE_MISUSE_BKPT;
1730 }
1731#endif
drhe30f4422007-08-21 16:15:55 +00001732 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001733 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001734 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1735 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001736 }
drhcb5e4db2011-10-12 23:49:49 +00001737 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001738 sqlite3_mutex_leave(db->mutex);
1739 return rc;
drhb7481e72006-09-16 21:45:14 +00001740}
1741
drh19e2d372005-08-29 23:00:03 +00001742#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001743/*
drh18de4822003-01-16 16:28:53 +00001744** Register a trace function. The pArg from the previously registered trace
1745** is returned.
1746**
1747** A NULL trace function means that no tracing is executes. A non-NULL
1748** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001749** SQL statement.
drh18de4822003-01-16 16:28:53 +00001750*/
drh9bb575f2004-09-06 17:24:11 +00001751void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001752 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001753
1754#ifdef SQLITE_ENABLE_API_ARMOR
1755 if( !sqlite3SafetyCheckOk(db) ){
1756 (void)SQLITE_MISUSE_BKPT;
1757 return 0;
1758 }
1759#endif
drhe30f4422007-08-21 16:15:55 +00001760 sqlite3_mutex_enter(db->mutex);
1761 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001762 db->xTrace = xTrace;
1763 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001764 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001765 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001766}
drh19e2d372005-08-29 23:00:03 +00001767/*
1768** Register a profile function. The pArg from the previously registered
1769** profile function is returned.
1770**
1771** A NULL profile function means that no profiling is executes. A non-NULL
1772** profile is a pointer to a function that is invoked at the conclusion of
1773** each SQL statement that is run.
1774*/
1775void *sqlite3_profile(
1776 sqlite3 *db,
1777 void (*xProfile)(void*,const char*,sqlite_uint64),
1778 void *pArg
1779){
drhe30f4422007-08-21 16:15:55 +00001780 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001781
1782#ifdef SQLITE_ENABLE_API_ARMOR
1783 if( !sqlite3SafetyCheckOk(db) ){
1784 (void)SQLITE_MISUSE_BKPT;
1785 return 0;
1786 }
1787#endif
drhe30f4422007-08-21 16:15:55 +00001788 sqlite3_mutex_enter(db->mutex);
1789 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001790 db->xProfile = xProfile;
1791 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001792 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001793 return pOld;
1794}
1795#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001796
drhcd565fd2012-03-01 21:30:44 +00001797/*
1798** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001799** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001800** rollback.
1801*/
danielk197724b03fd2004-05-10 10:34:34 +00001802void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001803 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001804 int (*xCallback)(void*), /* Function to invoke on each commit */
1805 void *pArg /* Argument to the function */
1806){
drhe30f4422007-08-21 16:15:55 +00001807 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001808
1809#ifdef SQLITE_ENABLE_API_ARMOR
1810 if( !sqlite3SafetyCheckOk(db) ){
1811 (void)SQLITE_MISUSE_BKPT;
1812 return 0;
1813 }
1814#endif
drhe30f4422007-08-21 16:15:55 +00001815 sqlite3_mutex_enter(db->mutex);
1816 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001817 db->xCommitCallback = xCallback;
1818 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001819 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001820 return pOld;
1821}
1822
danielk197794eb6a12005-12-15 15:22:08 +00001823/*
1824** Register a callback to be invoked each time a row is updated,
1825** inserted or deleted using this database connection.
1826*/
danielk197771fd80b2005-12-16 06:54:01 +00001827void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001828 sqlite3 *db, /* Attach the hook to this database */
1829 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1830 void *pArg /* Argument to the function */
1831){
drhe30f4422007-08-21 16:15:55 +00001832 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001833
1834#ifdef SQLITE_ENABLE_API_ARMOR
1835 if( !sqlite3SafetyCheckOk(db) ){
1836 (void)SQLITE_MISUSE_BKPT;
1837 return 0;
1838 }
1839#endif
drhe30f4422007-08-21 16:15:55 +00001840 sqlite3_mutex_enter(db->mutex);
1841 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001842 db->xUpdateCallback = xCallback;
1843 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001844 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001845 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001846}
1847
danielk197771fd80b2005-12-16 06:54:01 +00001848/*
1849** Register a callback to be invoked each time a transaction is rolled
1850** back by this database connection.
1851*/
1852void *sqlite3_rollback_hook(
1853 sqlite3 *db, /* Attach the hook to this database */
1854 void (*xCallback)(void*), /* Callback function */
1855 void *pArg /* Argument to the function */
1856){
drhe30f4422007-08-21 16:15:55 +00001857 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001858
1859#ifdef SQLITE_ENABLE_API_ARMOR
1860 if( !sqlite3SafetyCheckOk(db) ){
1861 (void)SQLITE_MISUSE_BKPT;
1862 return 0;
1863 }
1864#endif
drhe30f4422007-08-21 16:15:55 +00001865 sqlite3_mutex_enter(db->mutex);
1866 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001867 db->xRollbackCallback = xCallback;
1868 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001869 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001870 return pRet;
1871}
drhaa940ea2004-01-15 02:44:03 +00001872
dan586b9c82010-05-03 08:04:49 +00001873#ifndef SQLITE_OMIT_WAL
1874/*
1875** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001876** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1877** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001878** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001879*/
drhb033d8b2010-05-03 13:37:30 +00001880int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001881 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001882 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001883 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001884 int nFrame /* Size of WAL */
1885){
drh5def0842010-05-05 20:00:25 +00001886 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001887 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001888 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001889 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001890 }
1891 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001892}
drhb033d8b2010-05-03 13:37:30 +00001893#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001894
1895/*
1896** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1897** a database after committing a transaction if there are nFrame or
1898** more frames in the log file. Passing zero or a negative value as the
1899** nFrame parameter disables automatic checkpoints entirely.
1900**
1901** The callback registered by this function replaces any existing callback
1902** registered using sqlite3_wal_hook(). Likewise, registering a callback
1903** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1904** configured by this function.
1905*/
1906int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001907#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001908 UNUSED_PARAMETER(db);
1909 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001910#else
drh9ca95732014-10-24 00:35:58 +00001911#ifdef SQLITE_ENABLE_API_ARMOR
1912 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1913#endif
dan586b9c82010-05-03 08:04:49 +00001914 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001915 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001916 }else{
1917 sqlite3_wal_hook(db, 0, 0);
1918 }
drhb033d8b2010-05-03 13:37:30 +00001919#endif
dan586b9c82010-05-03 08:04:49 +00001920 return SQLITE_OK;
1921}
1922
paulb0208cc2003-04-13 18:26:49 +00001923/*
dan8d22a172010-04-19 18:03:51 +00001924** Register a callback to be invoked each time a transaction is written
1925** into the write-ahead-log by this database connection.
1926*/
drh833bf962010-04-28 14:42:19 +00001927void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001928 sqlite3 *db, /* Attach the hook to this db handle */
1929 int(*xCallback)(void *, sqlite3*, const char*, int),
1930 void *pArg /* First argument passed to xCallback() */
1931){
drhb033d8b2010-05-03 13:37:30 +00001932#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001933 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001934#ifdef SQLITE_ENABLE_API_ARMOR
1935 if( !sqlite3SafetyCheckOk(db) ){
1936 (void)SQLITE_MISUSE_BKPT;
1937 return 0;
1938 }
1939#endif
dan8d22a172010-04-19 18:03:51 +00001940 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001941 pRet = db->pWalArg;
1942 db->xWalCallback = xCallback;
1943 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001944 sqlite3_mutex_leave(db->mutex);
1945 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001946#else
1947 return 0;
1948#endif
dan8d22a172010-04-19 18:03:51 +00001949}
1950
1951/*
dancdc1f042010-11-18 12:11:05 +00001952** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001953*/
dancdc1f042010-11-18 12:11:05 +00001954int sqlite3_wal_checkpoint_v2(
1955 sqlite3 *db, /* Database handle */
1956 const char *zDb, /* Name of attached database (or NULL) */
1957 int eMode, /* SQLITE_CHECKPOINT_* value */
1958 int *pnLog, /* OUT: Size of WAL log in frames */
1959 int *pnCkpt /* OUT: Total number of frames checkpointed */
1960){
drhb033d8b2010-05-03 13:37:30 +00001961#ifdef SQLITE_OMIT_WAL
1962 return SQLITE_OK;
1963#else
dan586b9c82010-05-03 08:04:49 +00001964 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001965 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001966
drh9ca95732014-10-24 00:35:58 +00001967#ifdef SQLITE_ENABLE_API_ARMOR
1968 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1969#endif
1970
dan9c5e3682011-02-07 15:12:12 +00001971 /* Initialize the output variables to -1 in case an error occurs. */
1972 if( pnLog ) *pnLog = -1;
1973 if( pnCkpt ) *pnCkpt = -1;
1974
danf26a1542014-12-02 19:04:54 +00001975 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
1976 assert( SQLITE_CHECKPOINT_FULL==1 );
1977 assert( SQLITE_CHECKPOINT_RESTART==2 );
1978 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
1979 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
drhbb9a3782014-12-03 18:32:47 +00001980 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
1981 ** mode: */
dancdc1f042010-11-18 12:11:05 +00001982 return SQLITE_MISUSE;
1983 }
1984
dan586b9c82010-05-03 08:04:49 +00001985 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001986 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001987 iDb = sqlite3FindDbName(db, zDb);
1988 }
1989 if( iDb<0 ){
1990 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00001991 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001992 }else{
dan976b0032015-01-29 19:12:12 +00001993 db->busyHandler.nBusy = 0;
dancdc1f042010-11-18 12:11:05 +00001994 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00001995 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00001996 }
drhb033d8b2010-05-03 13:37:30 +00001997 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001998 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001999 return rc;
2000#endif
dan586b9c82010-05-03 08:04:49 +00002001}
2002
dancdc1f042010-11-18 12:11:05 +00002003
2004/*
2005** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2006** to contains a zero-length string, all attached databases are
2007** checkpointed.
2008*/
2009int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
drhbb9a3782014-12-03 18:32:47 +00002010 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2011 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2012 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
dancdc1f042010-11-18 12:11:05 +00002013}
2014
drhb033d8b2010-05-03 13:37:30 +00002015#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00002016/*
2017** Run a checkpoint on database iDb. This is a no-op if database iDb is
2018** not currently open in WAL mode.
2019**
dan6fcff072010-05-03 14:05:43 +00002020** If a transaction is open on the database being checkpointed, this
2021** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2022** an error occurs while running the checkpoint, an SQLite error code is
2023** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00002024**
2025** The mutex on database handle db should be held by the caller. The mutex
2026** associated with the specific b-tree being checkpointed is taken by
2027** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00002028**
2029** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2030** checkpointed. If an error is encountered it is returned immediately -
2031** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00002032**
dancdc1f042010-11-18 12:11:05 +00002033** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00002034*/
dancdc1f042010-11-18 12:11:05 +00002035int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00002036 int rc = SQLITE_OK; /* Return code */
2037 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00002038 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00002039
2040 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00002041 assert( !pnLog || *pnLog==-1 );
2042 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00002043
dan6fcff072010-05-03 14:05:43 +00002044 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2045 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00002046 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00002047 pnLog = 0;
2048 pnCkpt = 0;
2049 if( rc==SQLITE_BUSY ){
2050 bBusy = 1;
2051 rc = SQLITE_OK;
2052 }
dan6fcff072010-05-03 14:05:43 +00002053 }
dan586b9c82010-05-03 08:04:49 +00002054 }
2055
danf2b8dd52010-11-18 19:28:01 +00002056 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00002057}
drhb033d8b2010-05-03 13:37:30 +00002058#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00002059
2060/*
danielk1977d8293352009-04-30 09:10:37 +00002061** This function returns true if main-memory should be used instead of
2062** a temporary file for transient pager files and statement journals.
2063** The value returned depends on the value of db->temp_store (runtime
2064** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2065** following table describes the relationship between these two values
2066** and this functions return value.
2067**
2068** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2069** ----------------- -------------- ------------------------------
2070** 0 any file (return 0)
2071** 1 1 file (return 0)
2072** 1 2 memory (return 1)
2073** 1 0 file (return 0)
2074** 2 1 file (return 0)
2075** 2 2 memory (return 1)
2076** 2 0 memory (return 1)
2077** 3 any memory (return 1)
2078*/
drh1c514142009-04-30 12:25:10 +00002079int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00002080#if SQLITE_TEMP_STORE==1
2081 return ( db->temp_store==2 );
2082#endif
2083#if SQLITE_TEMP_STORE==2
2084 return ( db->temp_store!=1 );
2085#endif
2086#if SQLITE_TEMP_STORE==3
2087 return 1;
shanecf697392009-06-01 16:53:09 +00002088#endif
2089#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00002090 return 0;
shane60a4b532009-05-06 18:57:09 +00002091#endif
danielk1977d8293352009-04-30 09:10:37 +00002092}
2093
2094/*
danielk19774ad17132004-05-21 01:47:26 +00002095** Return UTF-8 encoded English language explanation of the most recent
2096** error.
2097*/
danielk19776622cce2004-05-20 11:00:52 +00002098const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00002099 const char *z;
drhf49661a2008-12-10 16:45:50 +00002100 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00002101 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00002102 }
drhd55d57e2008-07-07 17:53:07 +00002103 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002104 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00002105 }
drh27641702007-08-22 02:56:42 +00002106 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002107 if( db->mallocFailed ){
2108 z = sqlite3ErrStr(SQLITE_NOMEM);
2109 }else{
drha3cc0072013-12-13 16:23:55 +00002110 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00002111 z = (char*)sqlite3_value_text(db->pErr);
2112 assert( !db->mallocFailed );
2113 if( z==0 ){
2114 z = sqlite3ErrStr(db->errCode);
2115 }
danielk19776622cce2004-05-20 11:00:52 +00002116 }
drhe30f4422007-08-21 16:15:55 +00002117 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002118 return z;
danielk19776622cce2004-05-20 11:00:52 +00002119}
2120
drh6c626082004-11-14 21:56:29 +00002121#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002122/*
2123** Return UTF-16 encoded English language explanation of the most recent
2124** error.
2125*/
danielk19776622cce2004-05-20 11:00:52 +00002126const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002127 static const u16 outOfMem[] = {
2128 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002129 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002130 static const u16 misuse[] = {
2131 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2132 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2133 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2134 'o', 'u', 't', ' ',
2135 'o', 'f', ' ',
2136 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002137 };
danielk19774ad17132004-05-21 01:47:26 +00002138
drhc60d0442004-09-30 13:43:13 +00002139 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002140 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002141 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002142 }
drhd55d57e2008-07-07 17:53:07 +00002143 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002144 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002145 }
drhe30f4422007-08-21 16:15:55 +00002146 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002147 if( db->mallocFailed ){
2148 z = (void *)outOfMem;
2149 }else{
drhc60d0442004-09-30 13:43:13 +00002150 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002151 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002152 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002153 z = sqlite3_value_text16(db->pErr);
2154 }
2155 /* A malloc() may have failed within the call to sqlite3_value_text16()
2156 ** above. If this is the case, then the db->mallocFailed flag needs to
2157 ** be cleared before returning. Do this directly, instead of via
2158 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2159 */
2160 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00002161 }
drhe30f4422007-08-21 16:15:55 +00002162 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002163 return z;
danielk19776622cce2004-05-20 11:00:52 +00002164}
drh6c626082004-11-14 21:56:29 +00002165#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002166
drhc60d0442004-09-30 13:43:13 +00002167/*
danielk19777ddad962005-12-12 06:53:03 +00002168** Return the most recent error code generated by an SQLite routine. If NULL is
2169** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002170*/
danielk19776622cce2004-05-20 11:00:52 +00002171int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002172 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002173 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002174 }
drh01495b92008-01-23 12:52:40 +00002175 if( !db || db->mallocFailed ){
2176 return SQLITE_NOMEM;
2177 }
drh4ac285a2006-09-15 07:28:50 +00002178 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002179}
drh99dfe5e2008-10-30 15:03:15 +00002180int sqlite3_extended_errcode(sqlite3 *db){
2181 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002182 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002183 }
2184 if( !db || db->mallocFailed ){
2185 return SQLITE_NOMEM;
2186 }
2187 return db->errCode;
2188}
danielk19776622cce2004-05-20 11:00:52 +00002189
drh0e819f92006-02-01 13:50:41 +00002190/*
mistachkin5dac8432012-09-11 02:00:25 +00002191** Return a string that describes the kind of error specified in the
2192** argument. For now, this simply calls the internal sqlite3ErrStr()
2193** function.
2194*/
2195const char *sqlite3_errstr(int rc){
2196 return sqlite3ErrStr(rc);
2197}
2198
2199/*
drh0e819f92006-02-01 13:50:41 +00002200** Create a new collating function for database "db". The name is zName
2201** and the encoding is enc.
2202*/
danielk19779a30cf62006-01-18 04:26:07 +00002203static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002204 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002205 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002206 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002207 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002208 int(*xCompare)(void*,int,const void*,int,const void*),
2209 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002210){
2211 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002212 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002213
drhe30f4422007-08-21 16:15:55 +00002214 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002215
2216 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2217 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2218 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2219 */
drh51c7d862009-04-27 18:46:06 +00002220 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002221 testcase( enc2==SQLITE_UTF16 );
2222 testcase( enc2==SQLITE_UTF16_ALIGNED );
2223 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002224 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002225 }
drh51c7d862009-04-27 18:46:06 +00002226 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002227 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002228 }
2229
2230 /* Check if this call is removing or replacing an existing collation
2231 ** sequence. If so, and there are active VMs, return busy. If there
2232 ** are no active VMs, invalidate any pre-compiled statements.
2233 */
drhc4a64fa2009-05-11 20:53:28 +00002234 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002235 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002236 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002237 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002238 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002239 return SQLITE_BUSY;
2240 }
2241 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +00002242
2243 /* If collation sequence pColl was created directly by a call to
2244 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2245 ** then any copies made by synthCollSeq() need to be invalidated.
2246 ** Also, collation destructor - CollSeq.xDel() - function may need
2247 ** to be called.
2248 */
2249 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002250 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002251 int j;
2252 for(j=0; j<3; j++){
2253 CollSeq *p = &aColl[j];
2254 if( p->enc==pColl->enc ){
2255 if( p->xDel ){
2256 p->xDel(p->pUser);
2257 }
2258 p->xCmp = 0;
2259 }
2260 }
2261 }
danielk19779a30cf62006-01-18 04:26:07 +00002262 }
2263
drhc4a64fa2009-05-11 20:53:28 +00002264 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002265 if( pColl==0 ) return SQLITE_NOMEM;
2266 pColl->xCmp = xCompare;
2267 pColl->pUser = pCtx;
2268 pColl->xDel = xDel;
2269 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002270 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002271 return SQLITE_OK;
2272}
2273
2274
danielk19776622cce2004-05-20 11:00:52 +00002275/*
drhbb4957f2008-03-20 14:03:29 +00002276** This array defines hard upper bounds on limit values. The
2277** initializer must be kept in sync with the SQLITE_LIMIT_*
2278** #defines in sqlite3.h.
2279*/
drhb1a6c3c2008-03-20 16:30:17 +00002280static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002281 SQLITE_MAX_LENGTH,
2282 SQLITE_MAX_SQL_LENGTH,
2283 SQLITE_MAX_COLUMN,
2284 SQLITE_MAX_EXPR_DEPTH,
2285 SQLITE_MAX_COMPOUND_SELECT,
2286 SQLITE_MAX_VDBE_OP,
2287 SQLITE_MAX_FUNCTION_ARG,
2288 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002289 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002290 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002291 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002292 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002293};
2294
2295/*
2296** Make sure the hard limits are set to reasonable values
2297*/
2298#if SQLITE_MAX_LENGTH<100
2299# error SQLITE_MAX_LENGTH must be at least 100
2300#endif
2301#if SQLITE_MAX_SQL_LENGTH<100
2302# error SQLITE_MAX_SQL_LENGTH must be at least 100
2303#endif
2304#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2305# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2306#endif
drhbb4957f2008-03-20 14:03:29 +00002307#if SQLITE_MAX_COMPOUND_SELECT<2
2308# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2309#endif
2310#if SQLITE_MAX_VDBE_OP<40
2311# error SQLITE_MAX_VDBE_OP must be at least 40
2312#endif
drhe82f5d02008-10-07 19:53:14 +00002313#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2314# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002315#endif
drhd08b2792014-07-22 15:33:31 +00002316#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2317# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002318#endif
drhbb4957f2008-03-20 14:03:29 +00002319#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2320# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2321#endif
drh70a8ca32008-08-21 18:49:27 +00002322#if SQLITE_MAX_COLUMN>32767
2323# error SQLITE_MAX_COLUMN must not exceed 32767
2324#endif
drh417168a2009-09-07 18:14:02 +00002325#if SQLITE_MAX_TRIGGER_DEPTH<1
2326# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2327#endif
drh111544c2014-08-29 16:20:47 +00002328#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2329# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2330#endif
drhbb4957f2008-03-20 14:03:29 +00002331
2332
2333/*
2334** Change the value of a limit. Report the old value.
2335** If an invalid limit index is supplied, report -1.
2336** Make no changes but still report the old value if the
2337** new limit is negative.
2338**
2339** A new lower limit does not shrink existing constructs.
2340** It merely prevents new constructs that exceed the limit
2341** from forming.
2342*/
2343int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2344 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002345
drh9ca95732014-10-24 00:35:58 +00002346#ifdef SQLITE_ENABLE_API_ARMOR
2347 if( !sqlite3SafetyCheckOk(db) ){
2348 (void)SQLITE_MISUSE_BKPT;
2349 return -1;
2350 }
2351#endif
drh4e93f5b2010-09-07 14:59:15 +00002352
2353 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2354 ** there is a hard upper bound set at compile-time by a C preprocessor
2355 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2356 ** "_MAX_".)
2357 */
2358 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2359 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2360 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2361 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2362 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2363 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2364 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2365 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2366 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2367 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2368 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2369 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002370 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2371 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002372
2373
drh521cc842008-04-15 02:36:33 +00002374 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002375 return -1;
2376 }
2377 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002378 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002379 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002380 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002381 }
2382 db->aLimit[limitId] = newLimit;
2383 }
drh4e93f5b2010-09-07 14:59:15 +00002384 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002385}
2386
2387/*
dan286ab7c2011-05-06 18:34:54 +00002388** This function is used to parse both URIs and non-URI filenames passed by the
2389** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2390** URIs specified as part of ATTACH statements.
2391**
2392** The first argument to this function is the name of the VFS to use (or
2393** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2394** query parameter. The second argument contains the URI (or non-URI filename)
2395** itself. When this function is called the *pFlags variable should contain
2396** the default flags to open the database handle with. The value stored in
2397** *pFlags may be updated before returning if the URI filename contains
2398** "cache=xxx" or "mode=xxx" query parameters.
2399**
2400** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2401** the VFS that should be used to open the database file. *pzFile is set to
2402** point to a buffer containing the name of the file to open. It is the
2403** responsibility of the caller to eventually call sqlite3_free() to release
2404** this buffer.
2405**
2406** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2407** may be set to point to a buffer containing an English language error
2408** message. It is the responsibility of the caller to eventually release
2409** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002410*/
2411int sqlite3ParseUri(
2412 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2413 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002414 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002415 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2416 char **pzFile, /* OUT: Filename component of URI */
2417 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2418){
dan78e9dd22011-05-03 10:22:32 +00002419 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002420 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002421 const char *zVfs = zDefaultVfs;
2422 char *zFile;
drhde941c32011-05-09 19:20:17 +00002423 char c;
dancd74b612011-04-22 19:37:32 +00002424 int nUri = sqlite3Strlen30(zUri);
2425
2426 assert( *pzErrMsg==0 );
2427
drh8790b6e2014-11-07 01:43:56 +00002428 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2429 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
drh00729cb2014-10-04 11:59:33 +00002430 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002431 ){
dan5de15372011-04-23 10:12:30 +00002432 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002433 int eState; /* Parser state when parsing URI */
2434 int iIn; /* Input character index */
2435 int iOut = 0; /* Output character index */
2436 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002437
dan286ab7c2011-05-06 18:34:54 +00002438 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2439 ** method that there may be extra parameters following the file-name. */
2440 flags |= SQLITE_OPEN_URI;
2441
2442 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002443 zFile = sqlite3_malloc(nByte);
2444 if( !zFile ) return SQLITE_NOMEM;
2445
drh869c0402013-08-07 23:15:52 +00002446 iIn = 5;
drh4a4b1382015-03-03 16:58:56 +00002447#ifdef SQLITE_ALLOW_URI_AUTHORITY
2448 if( strncmp(zUri+5, "///", 3)==0 ){
2449 iIn = 7;
2450 /* The following condition causes URIs with five leading / characters
2451 ** like file://///host/path to be converted into UNCs like //host/path.
2452 ** The correct URI for that UNC has only two or four leading / characters
2453 ** file://host/path or file:////host/path. But 5 leading slashes is a
2454 ** common error, we are told, so we handle it as a special case. */
2455 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2456 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2457 iIn = 16;
2458 }
2459#else
dancd74b612011-04-22 19:37:32 +00002460 /* Discard the scheme and authority segments of the URI. */
2461 if( zUri[5]=='/' && zUri[6]=='/' ){
2462 iIn = 7;
2463 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002464 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2465 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2466 iIn-7, &zUri[7]);
2467 rc = SQLITE_ERROR;
2468 goto parse_uri_out;
2469 }
dancd74b612011-04-22 19:37:32 +00002470 }
drh869c0402013-08-07 23:15:52 +00002471#endif
dancd74b612011-04-22 19:37:32 +00002472
2473 /* Copy the filename and any query parameters into the zFile buffer.
2474 ** Decode %HH escape codes along the way.
2475 **
2476 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2477 ** on the parsing context. As follows:
2478 **
2479 ** 0: Parsing file-name.
2480 ** 1: Parsing name section of a name=value query parameter.
2481 ** 2: Parsing value section of a name=value query parameter.
2482 */
2483 eState = 0;
drhde941c32011-05-09 19:20:17 +00002484 while( (c = zUri[iIn])!=0 && c!='#' ){
2485 iIn++;
dancd74b612011-04-22 19:37:32 +00002486 if( c=='%'
2487 && sqlite3Isxdigit(zUri[iIn])
2488 && sqlite3Isxdigit(zUri[iIn+1])
2489 ){
dan6d49e252011-05-03 15:09:05 +00002490 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2491 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002492
dan6d49e252011-05-03 15:09:05 +00002493 assert( octet>=0 && octet<256 );
2494 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002495 /* This branch is taken when "%00" appears within the URI. In this
2496 ** case we ignore all text in the remainder of the path, name or
2497 ** value currently being parsed. So ignore the current character
2498 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002499 while( (c = zUri[iIn])!=0 && c!='#'
2500 && (eState!=0 || c!='?')
2501 && (eState!=1 || (c!='=' && c!='&'))
2502 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002503 ){
2504 iIn++;
2505 }
2506 continue;
dancd74b612011-04-22 19:37:32 +00002507 }
dan6d49e252011-05-03 15:09:05 +00002508 c = octet;
dan5de15372011-04-23 10:12:30 +00002509 }else if( eState==1 && (c=='&' || c=='=') ){
2510 if( zFile[iOut-1]==0 ){
2511 /* An empty option name. Ignore this option altogether. */
2512 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2513 continue;
2514 }
2515 if( c=='&' ){
2516 zFile[iOut++] = '\0';
2517 }else{
2518 eState = 2;
2519 }
dancd74b612011-04-22 19:37:32 +00002520 c = 0;
dan5de15372011-04-23 10:12:30 +00002521 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2522 c = 0;
dancd74b612011-04-22 19:37:32 +00002523 eState = 1;
dancd74b612011-04-22 19:37:32 +00002524 }
2525 zFile[iOut++] = c;
2526 }
2527 if( eState==1 ) zFile[iOut++] = '\0';
2528 zFile[iOut++] = '\0';
2529 zFile[iOut++] = '\0';
2530
2531 /* Check if there were any options specified that should be interpreted
2532 ** here. Options that are interpreted here include "vfs" and those that
2533 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002534 ** method. */
dan5de15372011-04-23 10:12:30 +00002535 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2536 while( zOpt[0] ){
2537 int nOpt = sqlite3Strlen30(zOpt);
2538 char *zVal = &zOpt[nOpt+1];
2539 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002540
dan286ab7c2011-05-06 18:34:54 +00002541 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002542 zVfs = zVal;
2543 }else{
2544 struct OpenMode {
2545 const char *z;
2546 int mode;
2547 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002548 char *zModeType = 0;
2549 int mask = 0;
2550 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002551
dan286ab7c2011-05-06 18:34:54 +00002552 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002553 static struct OpenMode aCacheMode[] = {
2554 { "shared", SQLITE_OPEN_SHAREDCACHE },
2555 { "private", SQLITE_OPEN_PRIVATECACHE },
2556 { 0, 0 }
2557 };
2558
2559 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2560 aMode = aCacheMode;
2561 limit = mask;
2562 zModeType = "cache";
2563 }
dan286ab7c2011-05-06 18:34:54 +00002564 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002565 static struct OpenMode aOpenMode[] = {
2566 { "ro", SQLITE_OPEN_READONLY },
2567 { "rw", SQLITE_OPEN_READWRITE },
2568 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002569 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002570 { 0, 0 }
2571 };
2572
drh9c67b2a2012-05-28 13:58:00 +00002573 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2574 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002575 aMode = aOpenMode;
2576 limit = mask & flags;
2577 zModeType = "access";
2578 }
2579
2580 if( aMode ){
2581 int i;
2582 int mode = 0;
2583 for(i=0; aMode[i].z; i++){
2584 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002585 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002586 mode = aMode[i].mode;
2587 break;
dancd74b612011-04-22 19:37:32 +00002588 }
2589 }
dan78e9dd22011-05-03 10:22:32 +00002590 if( mode==0 ){
2591 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2592 rc = SQLITE_ERROR;
2593 goto parse_uri_out;
2594 }
drh9c67b2a2012-05-28 13:58:00 +00002595 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002596 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2597 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002598 rc = SQLITE_PERM;
2599 goto parse_uri_out;
2600 }
2601 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002602 }
dancd74b612011-04-22 19:37:32 +00002603 }
dan5de15372011-04-23 10:12:30 +00002604
2605 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002606 }
2607
2608 }else{
2609 zFile = sqlite3_malloc(nUri+2);
2610 if( !zFile ) return SQLITE_NOMEM;
2611 memcpy(zFile, zUri, nUri);
2612 zFile[nUri] = '\0';
2613 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002614 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002615 }
2616
2617 *ppVfs = sqlite3_vfs_find(zVfs);
2618 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002619 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002620 rc = SQLITE_ERROR;
2621 }
2622 parse_uri_out:
2623 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002624 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002625 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002626 }
2627 *pFlags = flags;
2628 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002629 return rc;
dancd74b612011-04-22 19:37:32 +00002630}
2631
2632
2633/*
danielk19774ad17132004-05-21 01:47:26 +00002634** This routine does the work of opening a database on behalf of
2635** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002636** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002637*/
2638static int openDatabase(
2639 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002640 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002641 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002642 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002643){
dancd74b612011-04-22 19:37:32 +00002644 sqlite3 *db; /* Store allocated handle here */
2645 int rc; /* Return code */
2646 int isThreadsafe; /* True for threadsafe connections */
2647 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2648 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002649
drh9ca95732014-10-24 00:35:58 +00002650#ifdef SQLITE_ENABLE_API_ARMOR
2651 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2652#endif
drhe0d0f8e2009-04-28 04:47:31 +00002653 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002654#ifndef SQLITE_OMIT_AUTOINIT
2655 rc = sqlite3_initialize();
2656 if( rc ) return rc;
2657#endif
2658
dan78e9dd22011-05-03 10:22:32 +00002659 /* Only allow sensible combinations of bits in the flags argument.
2660 ** Throw an error if any non-sense combination is used. If we
2661 ** do not block illegal combinations here, it could trigger
2662 ** assert() statements in deeper layers. Sensible combinations
2663 ** are:
2664 **
2665 ** 1: SQLITE_OPEN_READONLY
2666 ** 2: SQLITE_OPEN_READWRITE
2667 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2668 */
2669 assert( SQLITE_OPEN_READONLY == 0x01 );
2670 assert( SQLITE_OPEN_READWRITE == 0x02 );
2671 assert( SQLITE_OPEN_CREATE == 0x04 );
2672 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2673 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2674 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002675 if( ((1<<(flags&7)) & 0x46)==0 ){
2676 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2677 }
dan78e9dd22011-05-03 10:22:32 +00002678
drh039963a2008-09-03 00:43:15 +00002679 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002680 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002681 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2682 isThreadsafe = 0;
2683 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2684 isThreadsafe = 1;
2685 }else{
2686 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002687 }
drhf1f12682009-09-09 14:17:52 +00002688 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002689 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002690 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2691 flags |= SQLITE_OPEN_SHAREDCACHE;
2692 }
danielk19779a6284c2008-07-10 17:52:49 +00002693
drhb25a9f42009-05-12 13:35:11 +00002694 /* Remove harmful bits from the flags parameter
2695 **
2696 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2697 ** dealt with in the previous code block. Besides these, the only
2698 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002699 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2700 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002701 ** off all other flags.
2702 */
drha4267dc2008-02-19 15:20:44 +00002703 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002704 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002705 SQLITE_OPEN_MAIN_DB |
2706 SQLITE_OPEN_TEMP_DB |
2707 SQLITE_OPEN_TRANSIENT_DB |
2708 SQLITE_OPEN_MAIN_JOURNAL |
2709 SQLITE_OPEN_TEMP_JOURNAL |
2710 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002711 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002712 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002713 SQLITE_OPEN_FULLMUTEX |
2714 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002715 );
2716
danielk19774ad17132004-05-21 01:47:26 +00002717 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002718 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002719 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002720 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002721 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2722 if( db->mutex==0 ){
2723 sqlite3_free(db);
2724 db = 0;
2725 goto opendb_out;
2726 }
drh605264d2007-08-21 15:13:19 +00002727 }
drh27641702007-08-22 02:56:42 +00002728 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002729 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002730 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002731 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002732 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002733
drhbb4957f2008-03-20 14:03:29 +00002734 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2735 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002736 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002737 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002738 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002739 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002740 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002741 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002742 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002743#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002744 | SQLITE_AutoIndex
2745#endif
drh883ad042015-02-19 00:29:11 +00002746#if SQLITE_DEFAULT_CKPTFULLFSYNC
2747 | SQLITE_CkptFullFSync
2748#endif
drh76fe8032006-07-11 14:17:51 +00002749#if SQLITE_DEFAULT_FILE_FORMAT<4
2750 | SQLITE_LegacyFileFmt
2751#endif
drh56424db2007-03-27 22:24:11 +00002752#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2753 | SQLITE_LoadExtension
2754#endif
dan5bde73c2009-09-01 17:11:07 +00002755#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002756 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002757#endif
drha4bfd7f2010-12-09 19:15:17 +00002758#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2759 | SQLITE_ForeignKeys
2760#endif
drhf5471922014-12-09 15:12:11 +00002761#if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
2762 | SQLITE_ReverseOrder
2763#endif
drh76fe8032006-07-11 14:17:51 +00002764 ;
drhe61922a2009-05-02 13:29:37 +00002765 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002766#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002767 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002768#endif
danielk1977da184232006-01-05 11:34:32 +00002769
danielk19770202b292004-06-09 09:55:16 +00002770 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2771 ** and UTF-16, so add a version for each to avoid any unnecessary
2772 ** conversions. The only error that can occur here is a malloc() failure.
drh5e3b49b2014-11-20 19:22:26 +00002773 **
2774 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
2775 ** functions:
danielk19770202b292004-06-09 09:55:16 +00002776 */
drh4dd65e02011-11-29 14:46:56 +00002777 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2778 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2779 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
drh5e3b49b2014-11-20 19:22:26 +00002780 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drh4dd65e02011-11-29 14:46:56 +00002781 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002782 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002783 goto opendb_out;
2784 }
drh5e3b49b2014-11-20 19:22:26 +00002785 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
2786 ** strings is BINARY.
2787 */
drhc4a64fa2009-05-11 20:53:28 +00002788 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002789 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002790
dancd74b612011-04-22 19:37:32 +00002791 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002792 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002793 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2794 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002795 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
drh13f40da2014-08-22 18:00:11 +00002796 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002797 sqlite3_free(zErrMsg);
2798 goto opendb_out;
2799 }
2800
danielk19774ad17132004-05-21 01:47:26 +00002801 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002802 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002803 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002804 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002805 if( rc==SQLITE_IOERR_NOMEM ){
2806 rc = SQLITE_NOMEM;
2807 }
drh13f40da2014-08-22 18:00:11 +00002808 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002809 goto opendb_out;
2810 }
dan0235a032014-12-08 20:20:16 +00002811 sqlite3BtreeEnter(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002812 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
drh9bd3cc42014-12-12 23:17:54 +00002813 if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
dan0235a032014-12-08 20:20:16 +00002814 sqlite3BtreeLeave(db->aDb[0].pBt);
drh17435752007-08-16 04:30:38 +00002815 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002816
danielk197753c0f742005-03-29 03:10:59 +00002817 /* The default safety_level for the main database is 'full'; for the temp
2818 ** database it is 'NONE'. This matches the pager layer defaults.
2819 */
2820 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002821 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002822 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002823 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002824
danielk1977832a58a2007-06-22 15:21:15 +00002825 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002826 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002827 goto opendb_out;
2828 }
2829
danielk19778e227872004-06-07 07:52:17 +00002830 /* Register all built-in functions, but do not attempt to read the
2831 ** database schema yet. This is delayed until the first time the database
2832 ** is accessed.
2833 */
drh13f40da2014-08-22 18:00:11 +00002834 sqlite3Error(db, SQLITE_OK);
danielk1977832a58a2007-06-22 15:21:15 +00002835 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002836
drh1409be62006-08-23 20:07:20 +00002837 /* Load automatic extensions - extensions that have been registered
2838 ** using the sqlite3_automatic_extension() API.
2839 */
drh7aaa8782009-05-20 02:40:45 +00002840 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002841 if( rc==SQLITE_OK ){
2842 sqlite3AutoLoadExtensions(db);
2843 rc = sqlite3_errcode(db);
2844 if( rc!=SQLITE_OK ){
2845 goto opendb_out;
2846 }
danielk1977832a58a2007-06-22 15:21:15 +00002847 }
drh1409be62006-08-23 20:07:20 +00002848
drhaa29c132006-09-02 13:58:06 +00002849#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002850 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002851 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002852 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002853 }
2854#endif
2855
shessa26cf572006-10-19 20:27:58 +00002856#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002857 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002858 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002859 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002860 }
2861#endif
2862
shess69c4ae22007-08-20 17:37:47 +00002863#ifdef SQLITE_ENABLE_FTS3
2864 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002865 rc = sqlite3Fts3Init(db);
2866 }
2867#endif
2868
danielk197783852ac2007-05-06 16:04:11 +00002869#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002870 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002871 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002872 }
2873#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002874
2875#ifdef SQLITE_ENABLE_RTREE
2876 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002877 rc = sqlite3RtreeInit(db);
2878 }
2879#endif
2880
drh8fd5bd32007-04-02 16:40:37 +00002881 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2882 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2883 ** mode. Doing nothing at all also makes NORMAL the default.
2884 */
2885#ifdef SQLITE_DEFAULT_LOCKING_MODE
2886 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2887 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2888 SQLITE_DEFAULT_LOCKING_MODE);
2889#endif
2890
drh13f40da2014-08-22 18:00:11 +00002891 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00002892
drh633e6d52008-07-28 19:34:53 +00002893 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002894 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2895 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002896
dan5a299f92010-05-03 11:05:08 +00002897 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002898
danielk19774ad17132004-05-21 01:47:26 +00002899opendb_out:
dancd74b612011-04-22 19:37:32 +00002900 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002901 if( db ){
drh3ba689d2015-03-03 14:00:11 +00002902 assert( db->mutex!=0 || isThreadsafe==0
2903 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002904 sqlite3_mutex_leave(db->mutex);
2905 }
danielk197759633ae2008-08-27 19:01:57 +00002906 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002907 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002908 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002909 sqlite3_close(db);
2910 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002911 }else if( rc!=SQLITE_OK ){
2912 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002913 }
danielk19774ad17132004-05-21 01:47:26 +00002914 *ppDb = db;
danac455932012-11-26 19:50:41 +00002915#ifdef SQLITE_ENABLE_SQLLOG
2916 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002917 /* Opening a db handle. Fourth parameter is passed 0. */
2918 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2919 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002920 }
2921#endif
danielk197754f01982006-01-18 15:25:17 +00002922 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002923}
2924
2925/*
2926** Open a new database handle.
2927*/
danielk197780290862004-05-22 09:21:21 +00002928int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002929 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002930 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002931){
drh605264d2007-08-21 15:13:19 +00002932 return openDatabase(zFilename, ppDb,
2933 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2934}
2935int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002936 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002937 sqlite3 **ppDb, /* OUT: SQLite db handle */
2938 int flags, /* Flags */
2939 const char *zVfs /* Name of VFS module to use */
2940){
drh522c26f2011-05-07 14:40:29 +00002941 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002942}
2943
drh6c626082004-11-14 21:56:29 +00002944#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002945/*
2946** Open a new database handle.
2947*/
2948int sqlite3_open16(
2949 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002950 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002951){
danielk1977bfd6cce2004-06-18 04:24:54 +00002952 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002953 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002954 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002955
drh9ca95732014-10-24 00:35:58 +00002956#ifdef SQLITE_ENABLE_API_ARMOR
2957 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2958#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00002959 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002960#ifndef SQLITE_OMIT_AUTOINIT
2961 rc = sqlite3_initialize();
2962 if( rc ) return rc;
2963#endif
drh9ca95732014-10-24 00:35:58 +00002964 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00002965 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002966 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2967 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002968 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002969 rc = openDatabase(zFilename8, ppDb,
2970 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002971 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002972 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
drh9bd3cc42014-12-12 23:17:54 +00002973 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002974 }
drh40257ff2008-06-13 18:24:27 +00002975 }else{
2976 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002977 }
danielk19777ddad962005-12-12 06:53:03 +00002978 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002979
danielk197754f01982006-01-18 15:25:17 +00002980 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002981}
drh6c626082004-11-14 21:56:29 +00002982#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002983
danielk1977106bb232004-05-21 10:08:53 +00002984/*
danielk1977d8123362004-06-12 09:25:12 +00002985** Register a new collation sequence with the database handle db.
2986*/
danielk19770202b292004-06-09 09:55:16 +00002987int sqlite3_create_collation(
2988 sqlite3* db,
2989 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002990 int enc,
danielk19770202b292004-06-09 09:55:16 +00002991 void* pCtx,
2992 int(*xCompare)(void*,int,const void*,int,const void*)
2993){
drh4f81bbb2014-10-23 01:01:26 +00002994 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002995}
2996
2997/*
2998** Register a new collation sequence with the database handle db.
2999*/
danielk1977a393c032007-05-07 14:58:53 +00003000int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00003001 sqlite3* db,
3002 const char *zName,
3003 int enc,
3004 void* pCtx,
3005 int(*xCompare)(void*,int,const void*,int,const void*),
3006 void(*xDel)(void*)
3007){
3008 int rc;
drh9ca95732014-10-24 00:35:58 +00003009
3010#ifdef SQLITE_ENABLE_API_ARMOR
3011 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3012#endif
drhe30f4422007-08-21 16:15:55 +00003013 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003014 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00003015 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00003016 rc = sqlite3ApiExit(db, rc);
3017 sqlite3_mutex_leave(db->mutex);
3018 return rc;
danielk19770202b292004-06-09 09:55:16 +00003019}
3020
drh6c626082004-11-14 21:56:29 +00003021#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003022/*
3023** Register a new collation sequence with the database handle db.
3024*/
danielk19770202b292004-06-09 09:55:16 +00003025int sqlite3_create_collation16(
3026 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00003027 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00003028 int enc,
danielk19770202b292004-06-09 09:55:16 +00003029 void* pCtx,
3030 int(*xCompare)(void*,int,const void*,int,const void*)
3031){
danielk19779a30cf62006-01-18 04:26:07 +00003032 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00003033 char *zName8;
drh9ca95732014-10-24 00:35:58 +00003034
3035#ifdef SQLITE_ENABLE_API_ARMOR
3036 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3037#endif
drhe30f4422007-08-21 16:15:55 +00003038 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00003039 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00003040 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00003041 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00003042 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00003043 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00003044 }
drhe30f4422007-08-21 16:15:55 +00003045 rc = sqlite3ApiExit(db, rc);
3046 sqlite3_mutex_leave(db->mutex);
3047 return rc;
danielk19770202b292004-06-09 09:55:16 +00003048}
drh6c626082004-11-14 21:56:29 +00003049#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00003050
danielk1977d8123362004-06-12 09:25:12 +00003051/*
3052** Register a collation sequence factory callback with the database handle
3053** db. Replace any previously installed collation sequence factory.
3054*/
danielk19777cedc8d2004-06-10 10:50:08 +00003055int sqlite3_collation_needed(
3056 sqlite3 *db,
3057 void *pCollNeededArg,
3058 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3059){
drh9ca95732014-10-24 00:35:58 +00003060#ifdef SQLITE_ENABLE_API_ARMOR
3061 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3062#endif
drhe30f4422007-08-21 16:15:55 +00003063 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003064 db->xCollNeeded = xCollNeeded;
3065 db->xCollNeeded16 = 0;
3066 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003067 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003068 return SQLITE_OK;
3069}
danielk1977d8123362004-06-12 09:25:12 +00003070
drh6c626082004-11-14 21:56:29 +00003071#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00003072/*
3073** Register a collation sequence factory callback with the database handle
3074** db. Replace any previously installed collation sequence factory.
3075*/
danielk19777cedc8d2004-06-10 10:50:08 +00003076int sqlite3_collation_needed16(
3077 sqlite3 *db,
3078 void *pCollNeededArg,
3079 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3080){
drh9ca95732014-10-24 00:35:58 +00003081#ifdef SQLITE_ENABLE_API_ARMOR
3082 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3083#endif
drhe30f4422007-08-21 16:15:55 +00003084 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003085 db->xCollNeeded = 0;
3086 db->xCollNeeded16 = xCollNeeded16;
3087 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00003088 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00003089 return SQLITE_OK;
3090}
drh6c626082004-11-14 21:56:29 +00003091#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00003092
shaneeec556d2008-10-12 00:27:53 +00003093#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00003094/*
danielk19777ddad962005-12-12 06:53:03 +00003095** This function is now an anachronism. It used to be used to recover from a
3096** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00003097*/
drh7d97efb2007-10-12 19:35:48 +00003098int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00003099 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00003100}
3101#endif
drh3e1d8e62005-05-26 16:23:34 +00003102
3103/*
3104** Test to see whether or not the database connection is in autocommit
3105** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3106** by default. Autocommit is disabled by a BEGIN statement and reenabled
3107** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00003108*/
3109int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00003110#ifdef SQLITE_ENABLE_API_ARMOR
3111 if( !sqlite3SafetyCheckOk(db) ){
3112 (void)SQLITE_MISUSE_BKPT;
3113 return 0;
3114 }
3115#endif
drh3e1d8e62005-05-26 16:23:34 +00003116 return db->autoCommit;
3117}
drh49285702005-09-17 15:20:26 +00003118
drh49285702005-09-17 15:20:26 +00003119/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003120** The following routines are substitutes for constants SQLITE_CORRUPT,
drh9978c972010-02-23 17:36:32 +00003121** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003122** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003123**
3124** 1. Serve as a convenient place to set a breakpoint in a debugger
3125** to detect when version error conditions occurs.
3126**
3127** 2. Invoke sqlite3_log() to provide the source code location where
3128** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003129*/
drh9978c972010-02-23 17:36:32 +00003130int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003131 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00003132 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00003133 "database corruption at line %d of [%.10s]",
3134 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00003135 return SQLITE_CORRUPT;
3136}
drh9978c972010-02-23 17:36:32 +00003137int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003138 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003139 sqlite3_log(SQLITE_MISUSE,
3140 "misuse at line %d of [%.10s]",
3141 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003142 return SQLITE_MISUSE;
3143}
3144int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003145 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003146 sqlite3_log(SQLITE_CANTOPEN,
3147 "cannot open file at line %d of [%.10s]",
3148 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003149 return SQLITE_CANTOPEN;
3150}
3151
drh7c1817e2006-01-10 13:58:48 +00003152
shaneeec556d2008-10-12 00:27:53 +00003153#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003154/*
3155** This is a convenience routine that makes sure that all thread-specific
3156** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003157**
3158** SQLite no longer uses thread-specific data so this routine is now a
3159** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003160*/
3161void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003162}
shaneeec556d2008-10-12 00:27:53 +00003163#endif
danielk1977deb802c2006-02-09 13:43:28 +00003164
3165/*
3166** Return meta information about a specific column of a database table.
3167** See comment in sqlite3.h (sqlite.h.in) for details.
3168*/
danielk1977deb802c2006-02-09 13:43:28 +00003169int sqlite3_table_column_metadata(
3170 sqlite3 *db, /* Connection handle */
3171 const char *zDbName, /* Database name or NULL */
3172 const char *zTableName, /* Table name */
3173 const char *zColumnName, /* Column name */
3174 char const **pzDataType, /* OUTPUT: Declared data type */
3175 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3176 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3177 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003178 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003179){
3180 int rc;
3181 char *zErrMsg = 0;
3182 Table *pTab = 0;
3183 Column *pCol = 0;
mistachkin1a51ce72015-01-12 18:38:02 +00003184 int iCol = 0;
danielk1977deb802c2006-02-09 13:43:28 +00003185 char const *zDataType = 0;
3186 char const *zCollSeq = 0;
3187 int notnull = 0;
3188 int primarykey = 0;
3189 int autoinc = 0;
3190
drh96c707a2015-02-13 16:36:14 +00003191
3192#ifdef SQLITE_ENABLE_API_ARMOR
3193 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3194 return SQLITE_MISUSE_BKPT;
3195 }
3196#endif
3197
danielk1977deb802c2006-02-09 13:43:28 +00003198 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003199 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003200 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003201 rc = sqlite3Init(db, &zErrMsg);
3202 if( SQLITE_OK!=rc ){
3203 goto error_out;
3204 }
3205
3206 /* Locate the table in question */
3207 pTab = sqlite3FindTable(db, zTableName, zDbName);
3208 if( !pTab || pTab->pSelect ){
3209 pTab = 0;
3210 goto error_out;
3211 }
3212
3213 /* Find the column for which info is requested */
drh45d1b202014-12-09 22:24:42 +00003214 if( zColumnName==0 ){
3215 /* Query for existance of table only */
danielk1977deb802c2006-02-09 13:43:28 +00003216 }else{
3217 for(iCol=0; iCol<pTab->nCol; iCol++){
3218 pCol = &pTab->aCol[iCol];
3219 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3220 break;
3221 }
3222 }
3223 if( iCol==pTab->nCol ){
drh45d1b202014-12-09 22:24:42 +00003224 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3225 iCol = pTab->iPKey;
3226 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3227 }else{
3228 pTab = 0;
3229 goto error_out;
3230 }
danielk1977deb802c2006-02-09 13:43:28 +00003231 }
3232 }
3233
3234 /* The following block stores the meta information that will be returned
3235 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3236 ** and autoinc. At this point there are two possibilities:
3237 **
3238 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3239 ** and there is no explicitly declared IPK column.
3240 **
3241 ** 2. The table is not a view and the column name identified an
3242 ** explicitly declared column. Copy meta information from *pCol.
3243 */
3244 if( pCol ){
3245 zDataType = pCol->zType;
3246 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003247 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003248 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003249 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003250 }else{
3251 zDataType = "INTEGER";
3252 primarykey = 1;
3253 }
3254 if( !zCollSeq ){
3255 zCollSeq = "BINARY";
3256 }
3257
3258error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003259 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003260
3261 /* Whether the function call succeeded or failed, set the output parameters
3262 ** to whatever their local counterparts contain. If an error did occur,
3263 ** this has the effect of zeroing all output parameters.
3264 */
3265 if( pzDataType ) *pzDataType = zDataType;
3266 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3267 if( pNotNull ) *pNotNull = notnull;
3268 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3269 if( pAutoinc ) *pAutoinc = autoinc;
3270
3271 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003272 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003273 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003274 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003275 rc = SQLITE_ERROR;
3276 }
drh13f40da2014-08-22 18:00:11 +00003277 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003278 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003279 rc = sqlite3ApiExit(db, rc);
3280 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003281 return rc;
3282}
3283
3284/*
3285** Sleep for a little while. Return the amount of time slept.
3286*/
3287int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003288 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003289 int rc;
drhd677b3d2007-08-20 22:48:41 +00003290 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003291 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003292
3293 /* This function works in milliseconds, but the underlying OsSleep()
3294 ** API uses microseconds. Hence the 1000's.
3295 */
drhe30f4422007-08-21 16:15:55 +00003296 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003297 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003298}
drh4ac285a2006-09-15 07:28:50 +00003299
3300/*
3301** Enable or disable the extended result codes.
3302*/
3303int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003304#ifdef SQLITE_ENABLE_API_ARMOR
3305 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3306#endif
drhe30f4422007-08-21 16:15:55 +00003307 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003308 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003309 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003310 return SQLITE_OK;
3311}
drhcc6bb3e2007-08-31 16:11:35 +00003312
3313/*
3314** Invoke the xFileControl method on a particular database.
3315*/
3316int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3317 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003318 Btree *pBtree;
3319
drh9ca95732014-10-24 00:35:58 +00003320#ifdef SQLITE_ENABLE_API_ARMOR
3321 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3322#endif
drhcc6bb3e2007-08-31 16:11:35 +00003323 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003324 pBtree = sqlite3DbNameToBtree(db, zDbName);
3325 if( pBtree ){
3326 Pager *pPager;
3327 sqlite3_file *fd;
3328 sqlite3BtreeEnter(pBtree);
3329 pPager = sqlite3BtreePager(pBtree);
3330 assert( pPager!=0 );
3331 fd = sqlite3PagerFile(pPager);
3332 assert( fd!=0 );
3333 if( op==SQLITE_FCNTL_FILE_POINTER ){
3334 *(sqlite3_file**)pArg = fd;
3335 rc = SQLITE_OK;
3336 }else if( fd->pMethods ){
3337 rc = sqlite3OsFileControl(fd, op, pArg);
3338 }else{
3339 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003340 }
drh421377e2012-03-15 21:28:54 +00003341 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003342 }
3343 sqlite3_mutex_leave(db->mutex);
drh883ad042015-02-19 00:29:11 +00003344 return rc;
drhcc6bb3e2007-08-31 16:11:35 +00003345}
drhed13d982008-01-31 14:43:24 +00003346
3347/*
3348** Interface to the testing logic.
3349*/
3350int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003351 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003352#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003353 va_list ap;
drhed13d982008-01-31 14:43:24 +00003354 va_start(ap, op);
3355 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003356
3357 /*
drh984bfaa2008-03-19 16:08:53 +00003358 ** Save the current state of the PRNG.
3359 */
drh2fa18682008-03-19 14:15:34 +00003360 case SQLITE_TESTCTRL_PRNG_SAVE: {
3361 sqlite3PrngSaveState();
3362 break;
3363 }
drh984bfaa2008-03-19 16:08:53 +00003364
3365 /*
3366 ** Restore the state of the PRNG to the last state saved using
3367 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3368 ** this verb acts like PRNG_RESET.
3369 */
drh2fa18682008-03-19 14:15:34 +00003370 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3371 sqlite3PrngRestoreState();
3372 break;
3373 }
drh984bfaa2008-03-19 16:08:53 +00003374
3375 /*
3376 ** Reset the PRNG back to its uninitialized state. The next call
3377 ** to sqlite3_randomness() will reseed the PRNG using a single call
3378 ** to the xRandomness method of the default VFS.
3379 */
drh2fa18682008-03-19 14:15:34 +00003380 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003381 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003382 break;
3383 }
drh3088d592008-03-21 16:45:47 +00003384
3385 /*
3386 ** sqlite3_test_control(BITVEC_TEST, size, program)
3387 **
3388 ** Run a test against a Bitvec object of size. The program argument
3389 ** is an array of integers that defines the test. Return -1 on a
3390 ** memory allocation error, 0 on success, or non-zero for an error.
3391 ** See the sqlite3BitvecBuiltinTest() for additional information.
3392 */
3393 case SQLITE_TESTCTRL_BITVEC_TEST: {
3394 int sz = va_arg(ap, int);
3395 int *aProg = va_arg(ap, int*);
3396 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3397 break;
3398 }
danielk19772d1d86f2008-06-20 14:59:51 +00003399
3400 /*
drhc007f612014-05-16 14:17:01 +00003401 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3402 **
3403 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3404 ** if xCallback is not NULL.
3405 **
3406 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3407 ** is called immediately after installing the new callback and the return
3408 ** value from sqlite3FaultSim(0) becomes the return from
3409 ** sqlite3_test_control().
3410 */
3411 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003412 /* MSVC is picky about pulling func ptrs from va lists.
3413 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003414 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003415 */
3416 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003417 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003418 rc = sqlite3FaultSim(0);
3419 break;
3420 }
3421
3422 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003423 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3424 **
3425 ** Register hooks to call to indicate which malloc() failures
3426 ** are benign.
3427 */
3428 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003429 typedef void (*void_function)(void);
3430 void_function xBenignBegin;
3431 void_function xBenignEnd;
3432 xBenignBegin = va_arg(ap, void_function);
3433 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003434 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3435 break;
3436 }
drhc7a3bb92009-02-05 16:31:45 +00003437
3438 /*
drhf3af63f2009-05-09 18:59:42 +00003439 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003440 **
3441 ** Set the PENDING byte to the value in the argument, if X>0.
3442 ** Make no changes if X==0. Return the value of the pending byte
3443 ** as it existing before this routine was called.
3444 **
3445 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3446 ** an incompatible database file format. Changing the PENDING byte
3447 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003448 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003449 */
3450 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003451 rc = PENDING_BYTE;
3452#ifndef SQLITE_OMIT_WSD
3453 {
3454 unsigned int newVal = va_arg(ap, unsigned int);
3455 if( newVal ) sqlite3PendingByte = newVal;
3456 }
3457#endif
drhc7a3bb92009-02-05 16:31:45 +00003458 break;
3459 }
drhf3af63f2009-05-09 18:59:42 +00003460
3461 /*
3462 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3463 **
3464 ** This action provides a run-time test to see whether or not
3465 ** assert() was enabled at compile-time. If X is true and assert()
3466 ** is enabled, then the return value is true. If X is true and
3467 ** assert() is disabled, then the return value is zero. If X is
3468 ** false and assert() is enabled, then the assertion fires and the
3469 ** process aborts. If X is false and assert() is disabled, then the
3470 ** return value is zero.
3471 */
3472 case SQLITE_TESTCTRL_ASSERT: {
3473 volatile int x = 0;
3474 assert( (x = va_arg(ap,int))!=0 );
3475 rc = x;
3476 break;
3477 }
3478
3479
3480 /*
3481 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3482 **
3483 ** This action provides a run-time test to see how the ALWAYS and
3484 ** NEVER macros were defined at compile-time.
3485 **
3486 ** The return value is ALWAYS(X).
3487 **
3488 ** The recommended test is X==2. If the return value is 2, that means
3489 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3490 ** default setting. If the return value is 1, then ALWAYS() is either
3491 ** hard-coded to true or else it asserts if its argument is false.
3492 ** The first behavior (hard-coded to true) is the case if
3493 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3494 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3495 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3496 **
3497 ** The run-time test procedure might look something like this:
3498 **
3499 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3500 ** // ALWAYS() and NEVER() are no-op pass-through macros
3501 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3502 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3503 ** }else{
3504 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3505 ** }
3506 */
3507 case SQLITE_TESTCTRL_ALWAYS: {
3508 int x = va_arg(ap,int);
3509 rc = ALWAYS(x);
3510 break;
3511 }
drhc046e3e2009-07-15 11:26:44 +00003512
drh2cf4acb2014-04-18 00:06:02 +00003513 /*
3514 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3515 **
3516 ** The integer returned reveals the byte-order of the computer on which
3517 ** SQLite is running:
3518 **
3519 ** 1 big-endian, determined at run-time
3520 ** 10 little-endian, determined at run-time
3521 ** 432101 big-endian, determined at compile-time
3522 ** 123410 little-endian, determined at compile-time
3523 */
3524 case SQLITE_TESTCTRL_BYTEORDER: {
3525 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3526 break;
3527 }
3528
drhc046e3e2009-07-15 11:26:44 +00003529 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3530 **
3531 ** Set the nReserve size to N for the main database on the database
3532 ** connection db.
3533 */
3534 case SQLITE_TESTCTRL_RESERVE: {
3535 sqlite3 *db = va_arg(ap, sqlite3*);
3536 int x = va_arg(ap,int);
3537 sqlite3_mutex_enter(db->mutex);
3538 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3539 sqlite3_mutex_leave(db->mutex);
3540 break;
3541 }
3542
drh07096f62009-12-22 23:52:32 +00003543 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3544 **
3545 ** Enable or disable various optimizations for testing purposes. The
3546 ** argument N is a bitmask of optimizations to be disabled. For normal
3547 ** operation N should be 0. The idea is that a test program (like the
3548 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3549 ** with various optimizations disabled to verify that the same answer
3550 ** is obtained in every case.
3551 */
3552 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3553 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003554 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003555 break;
3556 }
3557
drh0e857732010-01-02 03:21:35 +00003558#ifdef SQLITE_N_KEYWORD
3559 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3560 **
3561 ** If zWord is a keyword recognized by the parser, then return the
3562 ** number of keywords. Or if zWord is not a keyword, return 0.
3563 **
3564 ** This test feature is only available in the amalgamation since
3565 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3566 ** is built using separate source files.
3567 */
3568 case SQLITE_TESTCTRL_ISKEYWORD: {
3569 const char *zWord = va_arg(ap, const char*);
3570 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003571 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003572 break;
3573 }
3574#endif
3575
drhbadc9802010-08-27 17:16:44 +00003576 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3577 **
3578 ** Pass pFree into sqlite3ScratchFree().
3579 ** If sz>0 then allocate a scratch buffer into pNew.
3580 */
3581 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3582 void *pFree, **ppNew;
3583 int sz;
3584 sz = va_arg(ap, int);
3585 ppNew = va_arg(ap, void**);
3586 pFree = va_arg(ap, void*);
3587 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3588 sqlite3ScratchFree(pFree);
3589 break;
3590 }
3591
danc17d6962011-06-21 12:47:30 +00003592 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3593 **
3594 ** If parameter onoff is non-zero, configure the wrappers so that all
3595 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3596 ** undo this setting.
3597 */
3598 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3599 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3600 break;
3601 }
3602
drh09fe6142013-11-29 15:06:27 +00003603 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3604 **
3605 ** Set or clear a flag that indicates that the database file is always well-
3606 ** formed and never corrupt. This flag is clear by default, indicating that
3607 ** database files might have arbitrary corruption. Setting the flag during
3608 ** testing causes certain assert() statements in the code to be activated
3609 ** that demonstrat invariants on well-formed database files.
3610 */
3611 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003612 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003613 break;
3614 }
3615
drh688852a2014-02-17 22:40:43 +00003616
3617 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3618 **
3619 ** Set the VDBE coverage callback function to xCallback with context
3620 ** pointer ptr.
3621 */
3622 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3623#ifdef SQLITE_VDBE_COVERAGE
3624 typedef void (*branch_callback)(void*,int,u8,u8);
3625 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3626 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3627#endif
3628 break;
3629 }
3630
dan8930c2a2014-04-03 16:25:29 +00003631 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3632 case SQLITE_TESTCTRL_SORTER_MMAP: {
3633 sqlite3 *db = va_arg(ap, sqlite3*);
3634 db->nMaxSorterMmap = va_arg(ap, int);
3635 break;
3636 }
3637
drh43cfc232014-07-29 14:09:21 +00003638 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3639 **
3640 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3641 ** not.
3642 */
3643 case SQLITE_TESTCTRL_ISINIT: {
3644 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3645 break;
3646 }
drh8964b342015-01-29 17:54:52 +00003647
drh3ba689d2015-03-03 14:00:11 +00003648 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
drh8964b342015-01-29 17:54:52 +00003649 **
drh1ffede82015-01-30 20:59:27 +00003650 ** This test control is used to create imposter tables. "db" is a pointer
3651 ** to the database connection. dbName is the database name (ex: "main" or
3652 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
3653 ** or off. "tnum" is the root page of the b-tree to which the imposter
3654 ** table should connect.
3655 **
3656 ** Enable imposter mode only when the schema has already been parsed. Then
drh3ba689d2015-03-03 14:00:11 +00003657 ** run a single CREATE TABLE statement to construct the imposter table in
3658 ** the parsed schema. Then turn imposter mode back off again.
drh1ffede82015-01-30 20:59:27 +00003659 **
3660 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
3661 ** the schema to be reparsed the next time it is needed. This has the
3662 ** effect of erasing all imposter tables.
drh8964b342015-01-29 17:54:52 +00003663 */
drh1ffede82015-01-30 20:59:27 +00003664 case SQLITE_TESTCTRL_IMPOSTER: {
drh8964b342015-01-29 17:54:52 +00003665 sqlite3 *db = va_arg(ap, sqlite3*);
drh8fb15e32015-02-04 20:56:49 +00003666 sqlite3_mutex_enter(db->mutex);
drh1ffede82015-01-30 20:59:27 +00003667 db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
3668 db->init.busy = db->init.imposterTable = va_arg(ap,int);
drh8964b342015-01-29 17:54:52 +00003669 db->init.newTnum = va_arg(ap,int);
drh1ffede82015-01-30 20:59:27 +00003670 if( db->init.busy==0 && db->init.newTnum>0 ){
3671 sqlite3ResetAllSchemasOfConnection(db);
3672 }
drh8fb15e32015-02-04 20:56:49 +00003673 sqlite3_mutex_leave(db->mutex);
drh8964b342015-01-29 17:54:52 +00003674 break;
3675 }
drhed13d982008-01-31 14:43:24 +00003676 }
3677 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003678#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003679 return rc;
drhed13d982008-01-31 14:43:24 +00003680}
drhcc487d12011-05-17 18:53:08 +00003681
3682/*
3683** This is a utility routine, useful to VFS implementations, that checks
3684** to see if a database file was a URI that contained a specific query
3685** parameter, and if so obtains the value of the query parameter.
3686**
3687** The zFilename argument is the filename pointer passed into the xOpen()
3688** method of a VFS implementation. The zParam argument is the name of the
3689** query parameter we seek. This routine returns the value of the zParam
3690** parameter if it exists. If the parameter does not exist, this routine
3691** returns a NULL pointer.
3692*/
3693const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003694 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003695 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003696 while( zFilename[0] ){
3697 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003698 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003699 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003700 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003701 }
3702 return 0;
3703}
drh283829c2011-11-17 00:56:20 +00003704
3705/*
drh92913722011-12-23 00:07:33 +00003706** Return a boolean value for a query parameter.
3707*/
3708int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3709 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003710 bDflt = bDflt!=0;
3711 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003712}
3713
3714/*
3715** Return a 64-bit integer value for a query parameter.
3716*/
3717sqlite3_int64 sqlite3_uri_int64(
3718 const char *zFilename, /* Filename as passed to xOpen */
3719 const char *zParam, /* URI parameter sought */
3720 sqlite3_int64 bDflt /* return if parameter is missing */
3721){
3722 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3723 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003724 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003725 bDflt = v;
3726 }
3727 return bDflt;
3728}
3729
3730/*
drh421377e2012-03-15 21:28:54 +00003731** Return the Btree pointer identified by zDbName. Return NULL if not found.
3732*/
3733Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3734 int i;
3735 for(i=0; i<db->nDb; i++){
3736 if( db->aDb[i].pBt
3737 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3738 ){
3739 return db->aDb[i].pBt;
3740 }
3741 }
3742 return 0;
3743}
3744
3745/*
drh283829c2011-11-17 00:56:20 +00003746** Return the filename of the database associated with a database
3747** connection.
3748*/
3749const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003750 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003751#ifdef SQLITE_ENABLE_API_ARMOR
3752 if( !sqlite3SafetyCheckOk(db) ){
3753 (void)SQLITE_MISUSE_BKPT;
3754 return 0;
3755 }
3756#endif
mistachkincd54bab2014-12-20 21:14:14 +00003757 pBt = sqlite3DbNameToBtree(db, zDbName);
drh421377e2012-03-15 21:28:54 +00003758 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3759}
3760
3761/*
3762** Return 1 if database is read-only or 0 if read/write. Return -1 if
3763** no such database exists.
3764*/
3765int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
mistachkincd54bab2014-12-20 21:14:14 +00003766 Btree *pBt;
drh9ca95732014-10-24 00:35:58 +00003767#ifdef SQLITE_ENABLE_API_ARMOR
3768 if( !sqlite3SafetyCheckOk(db) ){
3769 (void)SQLITE_MISUSE_BKPT;
3770 return -1;
3771 }
3772#endif
mistachkincd54bab2014-12-20 21:14:14 +00003773 pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003774 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003775}