drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 1 | /* |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 2 | ** 2001 September 15 |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 3 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 4 | ** The author disclaims copyright to this source code. In place of |
| 5 | ** a legal notice, here is a blessing: |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 6 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 7 | ** 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. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 10 | ** |
| 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. |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 16 | */ |
| 17 | #include "sqliteInt.h" |
drh | 58f1c8b | 2008-05-26 20:19:25 +0000 | [diff] [blame] | 18 | |
drh | 820a906 | 2008-01-31 13:35:48 +0000 | [diff] [blame] | 19 | #ifdef SQLITE_ENABLE_FTS3 |
| 20 | # include "fts3.h" |
| 21 | #endif |
drh | 58f1c8b | 2008-05-26 20:19:25 +0000 | [diff] [blame] | 22 | #ifdef SQLITE_ENABLE_RTREE |
| 23 | # include "rtree.h" |
| 24 | #endif |
dan | 21540ae | 2017-12-08 16:23:38 +0000 | [diff] [blame] | 25 | #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS) |
danielk1977 | 1c82665 | 2008-09-08 08:08:09 +0000 | [diff] [blame] | 26 | # include "sqliteicu.h" |
| 27 | #endif |
drh | c306e08 | 2015-10-08 23:37:00 +0000 | [diff] [blame] | 28 | #ifdef SQLITE_ENABLE_JSON1 |
| 29 | int sqlite3Json1Init(sqlite3*); |
| 30 | #endif |
drh | c6603af | 2017-06-29 14:33:51 +0000 | [diff] [blame] | 31 | #ifdef SQLITE_ENABLE_STMTVTAB |
| 32 | int sqlite3StmtVtabInit(sqlite3*); |
drh | f00f530 | 2017-06-28 15:47:29 +0000 | [diff] [blame] | 33 | #endif |
drh | c306e08 | 2015-10-08 23:37:00 +0000 | [diff] [blame] | 34 | #ifdef SQLITE_ENABLE_FTS5 |
| 35 | int sqlite3Fts5Init(sqlite3*); |
| 36 | #endif |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 37 | |
drh | b3190c1 | 2008-12-08 21:37:14 +0000 | [diff] [blame] | 38 | #ifndef SQLITE_AMALGAMATION |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 39 | /* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant |
| 40 | ** contains the text of SQLITE_VERSION macro. |
| 41 | */ |
danielk1977 | 24b03fd | 2004-05-10 10:34:34 +0000 | [diff] [blame] | 42 | const char sqlite3_version[] = SQLITE_VERSION; |
drh | b3190c1 | 2008-12-08 21:37:14 +0000 | [diff] [blame] | 43 | #endif |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 44 | |
| 45 | /* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns |
| 46 | ** a pointer to the to the sqlite3_version[] string constant. |
| 47 | */ |
drh | 4aec8b6 | 2004-08-28 16:19:00 +0000 | [diff] [blame] | 48 | const char *sqlite3_libversion(void){ return sqlite3_version; } |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 49 | |
drh | c6aa381 | 2017-10-04 18:26:44 +0000 | [diff] [blame] | 50 | /* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 51 | ** pointer to a string constant whose value is the same as the |
drh | c6aa381 | 2017-10-04 18:26:44 +0000 | [diff] [blame] | 52 | ** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using |
| 53 | ** an edited copy of the amalgamation, then the last four characters of |
| 54 | ** the hash might be different from SQLITE_SOURCE_ID. |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 55 | */ |
drh | 47baebc | 2009-08-14 16:01:24 +0000 | [diff] [blame] | 56 | const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; } |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 57 | |
| 58 | /* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function |
| 59 | ** returns an integer equal to SQLITE_VERSION_NUMBER. |
| 60 | */ |
danielk1977 | 99ba19e | 2005-02-05 07:33:34 +0000 | [diff] [blame] | 61 | int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; } |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 62 | |
drh | 5dc2bcd | 2012-01-02 15:45:12 +0000 | [diff] [blame] | 63 | /* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns |
drh | b8a45bb | 2011-12-31 21:51:55 +0000 | [diff] [blame] | 64 | ** zero if and only if SQLite was compiled with mutexing code omitted due to |
drh | 9f129f4 | 2010-08-31 15:27:32 +0000 | [diff] [blame] | 65 | ** the SQLITE_THREADSAFE compile-time option being set to 0. |
| 66 | */ |
drh | b67e8bf | 2007-08-30 20:09:48 +0000 | [diff] [blame] | 67 | int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; } |
drh | b217a57 | 2000-08-22 13:40:18 +0000 | [diff] [blame] | 68 | |
mistachkin | 34cf258 | 2015-04-02 17:46:52 +0000 | [diff] [blame] | 69 | /* |
| 70 | ** When compiling the test fixture or with debugging enabled (on Win32), |
| 71 | ** this variable being set to non-zero will cause OSTRACE macros to emit |
| 72 | ** extra diagnostic information. |
| 73 | */ |
mistachkin | fb383e9 | 2015-04-16 03:24:38 +0000 | [diff] [blame] | 74 | #ifdef SQLITE_HAVE_OS_TRACE |
mistachkin | 34cf258 | 2015-04-02 17:46:52 +0000 | [diff] [blame] | 75 | # ifndef SQLITE_DEBUG_OS_TRACE |
| 76 | # define SQLITE_DEBUG_OS_TRACE 0 |
| 77 | # endif |
| 78 | int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE; |
| 79 | #endif |
| 80 | |
drh | e265b08 | 2008-05-01 17:03:49 +0000 | [diff] [blame] | 81 | #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE) |
drh | b217a57 | 2000-08-22 13:40:18 +0000 | [diff] [blame] | 82 | /* |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 83 | ** If the following function pointer is not NULL and if |
| 84 | ** SQLITE_ENABLE_IOTRACE is enabled, then messages describing |
| 85 | ** I/O active are written using this function. These messages |
| 86 | ** are intended for debugging activity only. |
| 87 | */ |
mistachkin | 9871a93 | 2015-03-27 00:21:52 +0000 | [diff] [blame] | 88 | SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0; |
drh | e265b08 | 2008-05-01 17:03:49 +0000 | [diff] [blame] | 89 | #endif |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 90 | |
| 91 | /* |
drh | a16313e | 2007-03-30 11:29:32 +0000 | [diff] [blame] | 92 | ** If the following global variable points to a string which is the |
| 93 | ** name of a directory, then that directory will be used to store |
| 94 | ** temporary files. |
| 95 | ** |
| 96 | ** See also the "PRAGMA temp_store_directory" SQL command. |
| 97 | */ |
| 98 | char *sqlite3_temp_directory = 0; |
| 99 | |
drh | c5499be | 2008-04-01 15:06:33 +0000 | [diff] [blame] | 100 | /* |
mistachkin | a112d14 | 2012-03-14 00:44:01 +0000 | [diff] [blame] | 101 | ** If the following global variable points to a string which is the |
| 102 | ** name of a directory, then that directory will be used to store |
| 103 | ** all database files specified with a relative pathname. |
| 104 | ** |
| 105 | ** See also the "PRAGMA data_store_directory" SQL command. |
| 106 | */ |
| 107 | char *sqlite3_data_directory = 0; |
| 108 | |
| 109 | /* |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 110 | ** Initialize SQLite. |
| 111 | ** |
| 112 | ** This routine must be called to initialize the memory allocation, |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 113 | ** VFS, and mutex subsystems prior to doing any serious work with |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 114 | ** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT |
| 115 | ** this routine will be called automatically by key routines such as |
| 116 | ** sqlite3_open(). |
| 117 | ** |
| 118 | ** This routine is a no-op except on its very first call for the process, |
| 119 | ** or for the first call after a call to sqlite3_shutdown. |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 120 | ** |
| 121 | ** The first thread to call this routine runs the initialization to |
| 122 | ** completion. If subsequent threads call this routine before the first |
| 123 | ** thread has finished the initialization process, then the subsequent |
| 124 | ** threads must block until the first thread finishes with the initialization. |
| 125 | ** |
| 126 | ** The first thread might call this routine recursively. Recursive |
| 127 | ** calls to this routine should not block, of course. Otherwise the |
| 128 | ** initialization process would never complete. |
| 129 | ** |
| 130 | ** Let X be the first thread to enter this routine. Let Y be some other |
| 131 | ** thread. Then while the initial invocation of this routine by X is |
| 132 | ** incomplete, it is required that: |
| 133 | ** |
| 134 | ** * Calls to this routine from Y must block until the outer-most |
| 135 | ** call by X completes. |
| 136 | ** |
| 137 | ** * Recursive calls to this routine from thread X return immediately |
| 138 | ** without blocking. |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 139 | */ |
| 140 | int sqlite3_initialize(void){ |
drh | 30ddce6 | 2011-10-15 00:16:30 +0000 | [diff] [blame] | 141 | MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 142 | int rc; /* Result code */ |
drh | ab80be9 | 2013-08-08 14:38:45 +0000 | [diff] [blame] | 143 | #ifdef SQLITE_EXTRA_INIT |
| 144 | int bRunExtraInit = 0; /* Extra initialization needed */ |
| 145 | #endif |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 146 | |
| 147 | #ifdef SQLITE_OMIT_WSD |
danielk1977 | a8f83bf | 2008-09-02 16:22:28 +0000 | [diff] [blame] | 148 | rc = sqlite3_wsd_init(4096, 24); |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 149 | if( rc!=SQLITE_OK ){ |
| 150 | return rc; |
| 151 | } |
| 152 | #endif |
danielk1977 | 71bc31c | 2008-06-26 08:29:34 +0000 | [diff] [blame] | 153 | |
drh | 2b4905c | 2015-03-23 18:52:56 +0000 | [diff] [blame] | 154 | /* If the following assert() fails on some obscure processor/compiler |
| 155 | ** combination, the work-around is to set the correct pointer |
| 156 | ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */ |
| 157 | assert( SQLITE_PTRSIZE==sizeof(char*) ); |
| 158 | |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 159 | /* If SQLite is already completely initialized, then this call |
| 160 | ** to sqlite3_initialize() should be a no-op. But the initialization |
| 161 | ** must be complete. So isInit must not be set until the very end |
| 162 | ** of this routine. |
| 163 | */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 164 | if( sqlite3GlobalConfig.isInit ) return SQLITE_OK; |
danielk1977 | 71bc31c | 2008-06-26 08:29:34 +0000 | [diff] [blame] | 165 | |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 166 | /* Make sure the mutex subsystem is initialized. If unable to |
| 167 | ** initialize the mutex subsystem, return early with the error. |
| 168 | ** If the system is so sick that we are unable to allocate a mutex, |
| 169 | ** there is not much SQLite is going to be able to do. |
| 170 | ** |
| 171 | ** The mutex subsystem must take care of serializing its own |
| 172 | ** initialization. |
| 173 | */ |
danielk1977 | d025174 | 2008-06-18 18:57:42 +0000 | [diff] [blame] | 174 | rc = sqlite3MutexInit(); |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 175 | if( rc ) return rc; |
danielk1977 | 71bc31c | 2008-06-26 08:29:34 +0000 | [diff] [blame] | 176 | |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 177 | /* Initialize the malloc() system and the recursive pInitMutex mutex. |
| 178 | ** This operation is protected by the STATIC_MASTER mutex. Note that |
| 179 | ** MutexAlloc() is called for a static mutex prior to initializing the |
| 180 | ** malloc subsystem - this implies that the allocation of a static |
| 181 | ** mutex must not require support from the malloc subsystem. |
| 182 | */ |
drh | 30ddce6 | 2011-10-15 00:16:30 +0000 | [diff] [blame] | 183 | MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); ) |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 184 | sqlite3_mutex_enter(pMaster); |
dan | e1ab219 | 2009-08-17 15:16:19 +0000 | [diff] [blame] | 185 | sqlite3GlobalConfig.isMutexInit = 1; |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 186 | if( !sqlite3GlobalConfig.isMallocInit ){ |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 187 | rc = sqlite3MallocInit(); |
| 188 | } |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 189 | if( rc==SQLITE_OK ){ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 190 | sqlite3GlobalConfig.isMallocInit = 1; |
| 191 | if( !sqlite3GlobalConfig.pInitMutex ){ |
drh | 9ac0650 | 2009-08-17 13:42:29 +0000 | [diff] [blame] | 192 | sqlite3GlobalConfig.pInitMutex = |
| 193 | sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE); |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 194 | if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 195 | rc = SQLITE_NOMEM_BKPT; |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 196 | } |
| 197 | } |
danielk1977 | 77eb5bb | 2008-09-22 17:22:19 +0000 | [diff] [blame] | 198 | } |
| 199 | if( rc==SQLITE_OK ){ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 200 | sqlite3GlobalConfig.nRefInitMutex++; |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 201 | } |
| 202 | sqlite3_mutex_leave(pMaster); |
danielk1977 | 71bc31c | 2008-06-26 08:29:34 +0000 | [diff] [blame] | 203 | |
dan | e1ab219 | 2009-08-17 15:16:19 +0000 | [diff] [blame] | 204 | /* If rc is not SQLITE_OK at this point, then either the malloc |
| 205 | ** subsystem could not be initialized or the system failed to allocate |
| 206 | ** the pInitMutex mutex. Return an error in either case. */ |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 207 | if( rc!=SQLITE_OK ){ |
| 208 | return rc; |
| 209 | } |
| 210 | |
| 211 | /* Do the rest of the initialization under the recursive mutex so |
| 212 | ** that we will be able to handle recursive calls into |
| 213 | ** sqlite3_initialize(). The recursive calls normally come through |
| 214 | ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other |
| 215 | ** recursive calls might also be possible. |
drh | f759bb8 | 2010-09-09 18:25:34 +0000 | [diff] [blame] | 216 | ** |
| 217 | ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls |
| 218 | ** to the xInit method, so the xInit method need not be threadsafe. |
| 219 | ** |
| 220 | ** The following mutex is what serializes access to the appdef pcache xInit |
| 221 | ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the |
| 222 | ** call to sqlite3PcacheInitialize(). |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 223 | */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 224 | sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex); |
danielk1977 | 502b4e0 | 2008-09-02 14:07:24 +0000 | [diff] [blame] | 225 | if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){ |
danielk1977 | 502b4e0 | 2008-09-02 14:07:24 +0000 | [diff] [blame] | 226 | sqlite3GlobalConfig.inProgress = 1; |
drh | 5e3cefe | 2015-11-12 23:48:08 +0000 | [diff] [blame] | 227 | #ifdef SQLITE_ENABLE_SQLLOG |
dan | d83f7ca | 2015-11-12 20:12:51 +0000 | [diff] [blame] | 228 | { |
drh | 5e3cefe | 2015-11-12 23:48:08 +0000 | [diff] [blame] | 229 | extern void sqlite3_init_sqllog(void); |
| 230 | sqlite3_init_sqllog(); |
dan | d83f7ca | 2015-11-12 20:12:51 +0000 | [diff] [blame] | 231 | } |
| 232 | #endif |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 233 | memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions)); |
| 234 | sqlite3RegisterBuiltinFunctions(); |
dan | e1ab219 | 2009-08-17 15:16:19 +0000 | [diff] [blame] | 235 | if( sqlite3GlobalConfig.isPCacheInit==0 ){ |
| 236 | rc = sqlite3PcacheInitialize(); |
| 237 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 238 | if( rc==SQLITE_OK ){ |
dan | e1ab219 | 2009-08-17 15:16:19 +0000 | [diff] [blame] | 239 | sqlite3GlobalConfig.isPCacheInit = 1; |
dan | 3d6e060 | 2009-08-17 15:52:25 +0000 | [diff] [blame] | 240 | rc = sqlite3OsInit(); |
drh | 0bf9f7b | 2009-04-17 16:54:22 +0000 | [diff] [blame] | 241 | } |
drh | 9c6396e | 2018-03-06 21:43:19 +0000 | [diff] [blame] | 242 | #ifdef SQLITE_ENABLE_DESERIALIZE |
drh | ac442f4 | 2018-01-03 01:28:46 +0000 | [diff] [blame] | 243 | if( rc==SQLITE_OK ){ |
| 244 | rc = sqlite3MemdbInit(); |
| 245 | } |
| 246 | #endif |
drh | 0bf9f7b | 2009-04-17 16:54:22 +0000 | [diff] [blame] | 247 | if( rc==SQLITE_OK ){ |
danielk1977 | 5b77529 | 2008-09-02 09:38:06 +0000 | [diff] [blame] | 248 | sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage, |
| 249 | sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage); |
drh | 0bf9f7b | 2009-04-17 16:54:22 +0000 | [diff] [blame] | 250 | sqlite3GlobalConfig.isInit = 1; |
drh | ab80be9 | 2013-08-08 14:38:45 +0000 | [diff] [blame] | 251 | #ifdef SQLITE_EXTRA_INIT |
| 252 | bRunExtraInit = 1; |
| 253 | #endif |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 254 | } |
danielk1977 | 502b4e0 | 2008-09-02 14:07:24 +0000 | [diff] [blame] | 255 | sqlite3GlobalConfig.inProgress = 0; |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 256 | } |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 257 | sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex); |
shane | dfb7b37 | 2008-07-22 05:13:30 +0000 | [diff] [blame] | 258 | |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 259 | /* Go back under the static mutex and clean up the recursive |
| 260 | ** mutex to prevent a resource leak. |
| 261 | */ |
| 262 | sqlite3_mutex_enter(pMaster); |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 263 | sqlite3GlobalConfig.nRefInitMutex--; |
| 264 | if( sqlite3GlobalConfig.nRefInitMutex<=0 ){ |
| 265 | assert( sqlite3GlobalConfig.nRefInitMutex==0 ); |
| 266 | sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex); |
| 267 | sqlite3GlobalConfig.pInitMutex = 0; |
drh | 93ed56d | 2008-08-12 15:21:11 +0000 | [diff] [blame] | 268 | } |
| 269 | sqlite3_mutex_leave(pMaster); |
| 270 | |
| 271 | /* The following is just a sanity check to make sure SQLite has |
| 272 | ** been compiled correctly. It is important to run this code, but |
| 273 | ** we don't want to run it too often and soak up CPU cycles for no |
| 274 | ** reason. So we run it once during initialization. |
| 275 | */ |
shane | dfb7b37 | 2008-07-22 05:13:30 +0000 | [diff] [blame] | 276 | #ifndef NDEBUG |
shane | fbd60f8 | 2009-02-04 03:59:25 +0000 | [diff] [blame] | 277 | #ifndef SQLITE_OMIT_FLOATING_POINT |
shane | dfb7b37 | 2008-07-22 05:13:30 +0000 | [diff] [blame] | 278 | /* This section of code's only "output" is via assert() statements. */ |
drh | ac442f4 | 2018-01-03 01:28:46 +0000 | [diff] [blame] | 279 | if( rc==SQLITE_OK ){ |
shane | dfb7b37 | 2008-07-22 05:13:30 +0000 | [diff] [blame] | 280 | u64 x = (((u64)1)<<63)-1; |
| 281 | double y; |
| 282 | assert(sizeof(x)==8); |
| 283 | assert(sizeof(x)==sizeof(y)); |
| 284 | memcpy(&y, &x, 8); |
| 285 | assert( sqlite3IsNaN(y) ); |
| 286 | } |
| 287 | #endif |
shane | fbd60f8 | 2009-02-04 03:59:25 +0000 | [diff] [blame] | 288 | #endif |
shane | dfb7b37 | 2008-07-22 05:13:30 +0000 | [diff] [blame] | 289 | |
drh | e4cf0b3 | 2011-08-25 00:14:41 +0000 | [diff] [blame] | 290 | /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT |
| 291 | ** compile-time option. |
| 292 | */ |
| 293 | #ifdef SQLITE_EXTRA_INIT |
drh | ab80be9 | 2013-08-08 14:38:45 +0000 | [diff] [blame] | 294 | if( bRunExtraInit ){ |
drh | c7f9462 | 2011-12-13 18:22:38 +0000 | [diff] [blame] | 295 | int SQLITE_EXTRA_INIT(const char*); |
| 296 | rc = SQLITE_EXTRA_INIT(0); |
drh | e4cf0b3 | 2011-08-25 00:14:41 +0000 | [diff] [blame] | 297 | } |
| 298 | #endif |
| 299 | |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 300 | return rc; |
| 301 | } |
| 302 | |
| 303 | /* |
| 304 | ** Undo the effects of sqlite3_initialize(). Must not be called while |
| 305 | ** there are outstanding database connections or memory allocations or |
| 306 | ** while any part of SQLite is otherwise in use in any thread. This |
drh | d1a2440 | 2009-04-19 12:23:58 +0000 | [diff] [blame] | 307 | ** routine is not threadsafe. But it is safe to invoke this routine |
| 308 | ** on when SQLite is already shut down. If SQLite is already shut down |
| 309 | ** when this routine is invoked, then this routine is a harmless no-op. |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 310 | */ |
| 311 | int sqlite3_shutdown(void){ |
mistachkin | 054450f | 2014-12-23 20:42:48 +0000 | [diff] [blame] | 312 | #ifdef SQLITE_OMIT_WSD |
| 313 | int rc = sqlite3_wsd_init(4096, 24); |
| 314 | if( rc!=SQLITE_OK ){ |
| 315 | return rc; |
| 316 | } |
| 317 | #endif |
| 318 | |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 319 | if( sqlite3GlobalConfig.isInit ){ |
drh | 9797706 | 2011-12-13 01:34:21 +0000 | [diff] [blame] | 320 | #ifdef SQLITE_EXTRA_SHUTDOWN |
| 321 | void SQLITE_EXTRA_SHUTDOWN(void); |
| 322 | SQLITE_EXTRA_SHUTDOWN(); |
| 323 | #endif |
drh | a764092 | 2009-04-21 12:02:56 +0000 | [diff] [blame] | 324 | sqlite3_os_end(); |
drh | d1a2440 | 2009-04-19 12:23:58 +0000 | [diff] [blame] | 325 | sqlite3_reset_auto_extension(); |
drh | d1a2440 | 2009-04-19 12:23:58 +0000 | [diff] [blame] | 326 | sqlite3GlobalConfig.isInit = 0; |
danielk1977 | fb43727 | 2008-07-08 12:02:35 +0000 | [diff] [blame] | 327 | } |
dan | e1ab219 | 2009-08-17 15:16:19 +0000 | [diff] [blame] | 328 | if( sqlite3GlobalConfig.isPCacheInit ){ |
| 329 | sqlite3PcacheShutdown(); |
| 330 | sqlite3GlobalConfig.isPCacheInit = 0; |
| 331 | } |
| 332 | if( sqlite3GlobalConfig.isMallocInit ){ |
| 333 | sqlite3MallocEnd(); |
| 334 | sqlite3GlobalConfig.isMallocInit = 0; |
mistachkin | 86f8987 | 2012-03-18 01:32:44 +0000 | [diff] [blame] | 335 | |
| 336 | #ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES |
| 337 | /* The heap subsystem has now been shutdown and these values are supposed |
| 338 | ** to be NULL or point to memory that was obtained from sqlite3_malloc(), |
| 339 | ** which would rely on that heap subsystem; therefore, make sure these |
| 340 | ** values cannot refer to heap memory that was just invalidated when the |
| 341 | ** heap subsystem was shutdown. This is only done if the current call to |
| 342 | ** this function resulted in the heap subsystem actually being shutdown. |
| 343 | */ |
| 344 | sqlite3_data_directory = 0; |
| 345 | sqlite3_temp_directory = 0; |
| 346 | #endif |
dan | e1ab219 | 2009-08-17 15:16:19 +0000 | [diff] [blame] | 347 | } |
| 348 | if( sqlite3GlobalConfig.isMutexInit ){ |
| 349 | sqlite3MutexEnd(); |
| 350 | sqlite3GlobalConfig.isMutexInit = 0; |
| 351 | } |
| 352 | |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 353 | return SQLITE_OK; |
| 354 | } |
| 355 | |
| 356 | /* |
| 357 | ** This API allows applications to modify the global configuration of |
| 358 | ** the SQLite library at run-time. |
| 359 | ** |
| 360 | ** This routine should only be called when there are no outstanding |
| 361 | ** database connections or memory allocations. This routine is not |
| 362 | ** threadsafe. Failure to heed these warnings can lead to unpredictable |
| 363 | ** behavior. |
| 364 | */ |
| 365 | int sqlite3_config(int op, ...){ |
| 366 | va_list ap; |
| 367 | int rc = SQLITE_OK; |
| 368 | |
| 369 | /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while |
| 370 | ** the SQLite library is in use. */ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 371 | if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT; |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 372 | |
| 373 | va_start(ap, op); |
| 374 | switch( op ){ |
drh | 18472fa | 2008-10-07 15:25:48 +0000 | [diff] [blame] | 375 | |
| 376 | /* Mutex configuration options are only available in a threadsafe |
drh | d1dcb23 | 2014-11-01 18:32:18 +0000 | [diff] [blame] | 377 | ** compile. |
drh | 18472fa | 2008-10-07 15:25:48 +0000 | [diff] [blame] | 378 | */ |
drh | d1dcb23 | 2014-11-01 18:32:18 +0000 | [diff] [blame] | 379 | #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */ |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 380 | case SQLITE_CONFIG_SINGLETHREAD: { |
drh | 682a6ef | 2015-03-04 23:14:14 +0000 | [diff] [blame] | 381 | /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to |
| 382 | ** Single-thread. */ |
| 383 | sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */ |
| 384 | sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */ |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 385 | break; |
| 386 | } |
drh | d1dcb23 | 2014-11-01 18:32:18 +0000 | [diff] [blame] | 387 | #endif |
| 388 | #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */ |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 389 | case SQLITE_CONFIG_MULTITHREAD: { |
drh | 682a6ef | 2015-03-04 23:14:14 +0000 | [diff] [blame] | 390 | /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to |
| 391 | ** Multi-thread. */ |
| 392 | sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */ |
| 393 | sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */ |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 394 | break; |
| 395 | } |
drh | d1dcb23 | 2014-11-01 18:32:18 +0000 | [diff] [blame] | 396 | #endif |
| 397 | #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */ |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 398 | case SQLITE_CONFIG_SERIALIZED: { |
drh | 682a6ef | 2015-03-04 23:14:14 +0000 | [diff] [blame] | 399 | /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to |
| 400 | ** Serialized. */ |
| 401 | sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */ |
| 402 | sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */ |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 403 | break; |
| 404 | } |
drh | d1dcb23 | 2014-11-01 18:32:18 +0000 | [diff] [blame] | 405 | #endif |
| 406 | #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */ |
drh | 18472fa | 2008-10-07 15:25:48 +0000 | [diff] [blame] | 407 | case SQLITE_CONFIG_MUTEX: { |
| 408 | /* Specify an alternative mutex implementation */ |
| 409 | sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*); |
| 410 | break; |
| 411 | } |
drh | d1dcb23 | 2014-11-01 18:32:18 +0000 | [diff] [blame] | 412 | #endif |
| 413 | #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */ |
drh | 18472fa | 2008-10-07 15:25:48 +0000 | [diff] [blame] | 414 | case SQLITE_CONFIG_GETMUTEX: { |
| 415 | /* Retrieve the current mutex implementation */ |
| 416 | *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex; |
| 417 | break; |
| 418 | } |
| 419 | #endif |
| 420 | |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 421 | case SQLITE_CONFIG_MALLOC: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 422 | /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a |
| 423 | ** single argument which is a pointer to an instance of the |
| 424 | ** sqlite3_mem_methods structure. The argument specifies alternative |
| 425 | ** low-level memory allocation routines to be used in place of the memory |
| 426 | ** allocation routines built into SQLite. */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 427 | sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*); |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 428 | break; |
| 429 | } |
drh | 3358979 | 2008-06-18 13:27:46 +0000 | [diff] [blame] | 430 | case SQLITE_CONFIG_GETMALLOC: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 431 | /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a |
| 432 | ** single argument which is a pointer to an instance of the |
| 433 | ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is |
| 434 | ** filled with the currently defined memory allocation routines. */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 435 | if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault(); |
| 436 | *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m; |
drh | 3358979 | 2008-06-18 13:27:46 +0000 | [diff] [blame] | 437 | break; |
| 438 | } |
drh | fec00ea | 2008-06-14 16:56:21 +0000 | [diff] [blame] | 439 | case SQLITE_CONFIG_MEMSTATUS: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 440 | /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes |
| 441 | ** single argument of type int, interpreted as a boolean, which enables |
| 442 | ** or disables the collection of memory allocation statistics. */ |
| 443 | sqlite3GlobalConfig.bMemstat = va_arg(ap, int); |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 444 | break; |
| 445 | } |
drh | b2a0f75 | 2017-08-28 15:51:35 +0000 | [diff] [blame] | 446 | case SQLITE_CONFIG_SMALL_MALLOC: { |
| 447 | sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int); |
drh | 3358979 | 2008-06-18 13:27:46 +0000 | [diff] [blame] | 448 | break; |
| 449 | } |
| 450 | case SQLITE_CONFIG_PAGECACHE: { |
drh | 1542727 | 2015-12-03 22:33:55 +0000 | [diff] [blame] | 451 | /* EVIDENCE-OF: R-18761-36601 There are three arguments to |
| 452 | ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem), |
| 453 | ** the size of each page cache line (sz), and the number of cache lines |
| 454 | ** (N). */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 455 | sqlite3GlobalConfig.pPage = va_arg(ap, void*); |
| 456 | sqlite3GlobalConfig.szPage = va_arg(ap, int); |
| 457 | sqlite3GlobalConfig.nPage = va_arg(ap, int); |
drh | 3358979 | 2008-06-18 13:27:46 +0000 | [diff] [blame] | 458 | break; |
| 459 | } |
drh | def6889 | 2014-11-04 12:11:23 +0000 | [diff] [blame] | 460 | case SQLITE_CONFIG_PCACHE_HDRSZ: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 461 | /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes |
| 462 | ** a single parameter which is a pointer to an integer and writes into |
| 463 | ** that integer the number of extra bytes per page required for each page |
| 464 | ** in SQLITE_CONFIG_PAGECACHE. */ |
drh | def6889 | 2014-11-04 12:11:23 +0000 | [diff] [blame] | 465 | *va_arg(ap, int*) = |
| 466 | sqlite3HeaderSizeBtree() + |
| 467 | sqlite3HeaderSizePcache() + |
| 468 | sqlite3HeaderSizePcache1(); |
| 469 | break; |
| 470 | } |
danielk1977 | 5099be5 | 2008-06-27 13:27:03 +0000 | [diff] [blame] | 471 | |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 472 | case SQLITE_CONFIG_PCACHE: { |
dan | 22e21ff | 2011-11-08 20:08:44 +0000 | [diff] [blame] | 473 | /* no-op */ |
| 474 | break; |
| 475 | } |
| 476 | case SQLITE_CONFIG_GETPCACHE: { |
| 477 | /* now an error */ |
| 478 | rc = SQLITE_ERROR; |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 479 | break; |
| 480 | } |
| 481 | |
dan | 22e21ff | 2011-11-08 20:08:44 +0000 | [diff] [blame] | 482 | case SQLITE_CONFIG_PCACHE2: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 483 | /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a |
| 484 | ** single argument which is a pointer to an sqlite3_pcache_methods2 |
| 485 | ** object. This object specifies the interface to a custom page cache |
| 486 | ** implementation. */ |
dan | 22e21ff | 2011-11-08 20:08:44 +0000 | [diff] [blame] | 487 | sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*); |
| 488 | break; |
| 489 | } |
| 490 | case SQLITE_CONFIG_GETPCACHE2: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 491 | /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a |
| 492 | ** single argument which is a pointer to an sqlite3_pcache_methods2 |
| 493 | ** object. SQLite copies of the current page cache implementation into |
| 494 | ** that object. */ |
dan | 22e21ff | 2011-11-08 20:08:44 +0000 | [diff] [blame] | 495 | if( sqlite3GlobalConfig.pcache2.xInit==0 ){ |
drh | b232c23 | 2008-11-19 01:20:26 +0000 | [diff] [blame] | 496 | sqlite3PCacheSetDefault(); |
| 497 | } |
dan | 22e21ff | 2011-11-08 20:08:44 +0000 | [diff] [blame] | 498 | *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2; |
drh | b232c23 | 2008-11-19 01:20:26 +0000 | [diff] [blame] | 499 | break; |
| 500 | } |
| 501 | |
drh | 8790b6e | 2014-11-07 01:43:56 +0000 | [diff] [blame] | 502 | /* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only |
| 503 | ** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or |
| 504 | ** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */ |
drh | 5d41483 | 2008-07-15 14:47:18 +0000 | [diff] [blame] | 505 | #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5) |
drh | 3358979 | 2008-06-18 13:27:46 +0000 | [diff] [blame] | 506 | case SQLITE_CONFIG_HEAP: { |
drh | 5279d34 | 2014-11-04 13:41:32 +0000 | [diff] [blame] | 507 | /* EVIDENCE-OF: R-19854-42126 There are three arguments to |
| 508 | ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the |
drh | 3ba689d | 2015-03-03 14:00:11 +0000 | [diff] [blame] | 509 | ** number of bytes in the memory buffer, and the minimum allocation size. |
| 510 | */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 511 | sqlite3GlobalConfig.pHeap = va_arg(ap, void*); |
| 512 | sqlite3GlobalConfig.nHeap = va_arg(ap, int); |
| 513 | sqlite3GlobalConfig.mnReq = va_arg(ap, int); |
danielk1977 | 5099be5 | 2008-06-27 13:27:03 +0000 | [diff] [blame] | 514 | |
shaneh | a6ec892 | 2011-03-09 21:36:17 +0000 | [diff] [blame] | 515 | if( sqlite3GlobalConfig.mnReq<1 ){ |
| 516 | sqlite3GlobalConfig.mnReq = 1; |
| 517 | }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){ |
| 518 | /* cap min request size at 2^12 */ |
| 519 | sqlite3GlobalConfig.mnReq = (1<<12); |
| 520 | } |
| 521 | |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 522 | if( sqlite3GlobalConfig.pHeap==0 ){ |
drh | 8790b6e | 2014-11-07 01:43:56 +0000 | [diff] [blame] | 523 | /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer) |
| 524 | ** is NULL, then SQLite reverts to using its default memory allocator |
| 525 | ** (the system malloc() implementation), undoing any prior invocation of |
| 526 | ** SQLITE_CONFIG_MALLOC. |
| 527 | ** |
| 528 | ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to |
| 529 | ** revert to its default implementation when sqlite3_initialize() is run |
drh | 8a42cbd | 2008-07-10 18:13:42 +0000 | [diff] [blame] | 530 | */ |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 531 | memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m)); |
drh | 8a42cbd | 2008-07-10 18:13:42 +0000 | [diff] [blame] | 532 | }else{ |
drh | 8790b6e | 2014-11-07 01:43:56 +0000 | [diff] [blame] | 533 | /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the |
| 534 | ** alternative memory allocator is engaged to handle all of SQLites |
| 535 | ** memory allocation needs. */ |
danielk1977 | 5099be5 | 2008-06-27 13:27:03 +0000 | [diff] [blame] | 536 | #ifdef SQLITE_ENABLE_MEMSYS3 |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 537 | sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3(); |
drh | 8a42cbd | 2008-07-10 18:13:42 +0000 | [diff] [blame] | 538 | #endif |
| 539 | #ifdef SQLITE_ENABLE_MEMSYS5 |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 540 | sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5(); |
drh | 8a42cbd | 2008-07-10 18:13:42 +0000 | [diff] [blame] | 541 | #endif |
drh | 8a42cbd | 2008-07-10 18:13:42 +0000 | [diff] [blame] | 542 | } |
danielk1977 | 5099be5 | 2008-06-27 13:27:03 +0000 | [diff] [blame] | 543 | break; |
| 544 | } |
drh | 5d41483 | 2008-07-15 14:47:18 +0000 | [diff] [blame] | 545 | #endif |
danielk1977 | 5099be5 | 2008-06-27 13:27:03 +0000 | [diff] [blame] | 546 | |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 547 | case SQLITE_CONFIG_LOOKASIDE: { |
danielk1977 | 075c23a | 2008-09-01 18:34:20 +0000 | [diff] [blame] | 548 | sqlite3GlobalConfig.szLookaside = va_arg(ap, int); |
| 549 | sqlite3GlobalConfig.nLookaside = va_arg(ap, int); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 550 | break; |
| 551 | } |
drh | 3f28070 | 2010-02-18 18:45:09 +0000 | [diff] [blame] | 552 | |
mistachkin | 037933b | 2013-08-13 22:33:41 +0000 | [diff] [blame] | 553 | /* Record a pointer to the logger function and its first argument. |
drh | 3f28070 | 2010-02-18 18:45:09 +0000 | [diff] [blame] | 554 | ** The default is NULL. Logging is disabled if the function pointer is |
| 555 | ** NULL. |
| 556 | */ |
| 557 | case SQLITE_CONFIG_LOG: { |
shaneh | dc97a8c | 2010-02-23 20:08:35 +0000 | [diff] [blame] | 558 | /* MSVC is picky about pulling func ptrs from va lists. |
| 559 | ** http://support.microsoft.com/kb/47961 |
| 560 | ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*)); |
| 561 | */ |
| 562 | typedef void(*LOGFUNC_t)(void*,int,const char*); |
| 563 | sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t); |
drh | 3f28070 | 2010-02-18 18:45:09 +0000 | [diff] [blame] | 564 | sqlite3GlobalConfig.pLogArg = va_arg(ap, void*); |
| 565 | break; |
| 566 | } |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 567 | |
drh | 00729cb | 2014-10-04 11:59:33 +0000 | [diff] [blame] | 568 | /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames |
| 569 | ** can be changed at start-time using the |
| 570 | ** sqlite3_config(SQLITE_CONFIG_URI,1) or |
| 571 | ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls. |
| 572 | */ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 573 | case SQLITE_CONFIG_URI: { |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 574 | /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single |
| 575 | ** argument of type int. If non-zero, then URI handling is globally |
| 576 | ** enabled. If the parameter is zero, then URI handling is globally |
| 577 | ** disabled. */ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 578 | sqlite3GlobalConfig.bOpenUri = va_arg(ap, int); |
| 579 | break; |
| 580 | } |
| 581 | |
drh | de9a7b8 | 2012-09-17 20:44:46 +0000 | [diff] [blame] | 582 | case SQLITE_CONFIG_COVERING_INDEX_SCAN: { |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 583 | /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN |
| 584 | ** option takes a single integer argument which is interpreted as a |
| 585 | ** boolean in order to enable or disable the use of covering indices for |
| 586 | ** full table scans in the query optimizer. */ |
drh | de9a7b8 | 2012-09-17 20:44:46 +0000 | [diff] [blame] | 587 | sqlite3GlobalConfig.bUseCis = va_arg(ap, int); |
| 588 | break; |
| 589 | } |
| 590 | |
dan | ac45593 | 2012-11-26 19:50:41 +0000 | [diff] [blame] | 591 | #ifdef SQLITE_ENABLE_SQLLOG |
| 592 | case SQLITE_CONFIG_SQLLOG: { |
| 593 | typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int); |
| 594 | sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t); |
| 595 | sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *); |
| 596 | break; |
| 597 | } |
| 598 | #endif |
| 599 | |
drh | 9b4c59f | 2013-04-15 17:03:42 +0000 | [diff] [blame] | 600 | case SQLITE_CONFIG_MMAP_SIZE: { |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 601 | /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit |
| 602 | ** integer (sqlite3_int64) values that are the default mmap size limit |
| 603 | ** (the default setting for PRAGMA mmap_size) and the maximum allowed |
| 604 | ** mmap size limit. */ |
drh | 9b4c59f | 2013-04-15 17:03:42 +0000 | [diff] [blame] | 605 | sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64); |
drh | a1f42c7 | 2013-04-01 22:38:06 +0000 | [diff] [blame] | 606 | sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64); |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 607 | /* EVIDENCE-OF: R-53367-43190 If either argument to this option is |
drh | 8790b6e | 2014-11-07 01:43:56 +0000 | [diff] [blame] | 608 | ** negative, then that argument is changed to its compile-time default. |
| 609 | ** |
| 610 | ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be |
| 611 | ** silently truncated if necessary so that it does not exceed the |
| 612 | ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE |
| 613 | ** compile-time option. |
| 614 | */ |
drh | 3ba689d | 2015-03-03 14:00:11 +0000 | [diff] [blame] | 615 | if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){ |
| 616 | mxMmap = SQLITE_MAX_MMAP_SIZE; |
| 617 | } |
drh | 9b4c59f | 2013-04-15 17:03:42 +0000 | [diff] [blame] | 618 | if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE; |
| 619 | if( szMmap>mxMmap) szMmap = mxMmap; |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 620 | sqlite3GlobalConfig.mxMmap = mxMmap; |
drh | 9b4c59f | 2013-04-15 17:03:42 +0000 | [diff] [blame] | 621 | sqlite3GlobalConfig.szMmap = szMmap; |
drh | a1f42c7 | 2013-04-01 22:38:06 +0000 | [diff] [blame] | 622 | break; |
| 623 | } |
| 624 | |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 625 | #if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */ |
mistachkin | af8641b | 2013-11-25 21:49:04 +0000 | [diff] [blame] | 626 | case SQLITE_CONFIG_WIN32_HEAPSIZE: { |
drh | 4d9f188 | 2014-11-04 17:23:24 +0000 | [diff] [blame] | 627 | /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit |
| 628 | ** unsigned integer value that specifies the maximum size of the created |
| 629 | ** heap. */ |
mistachkin | ac1f104 | 2013-11-23 00:27:29 +0000 | [diff] [blame] | 630 | sqlite3GlobalConfig.nHeap = va_arg(ap, int); |
| 631 | break; |
| 632 | } |
| 633 | #endif |
| 634 | |
drh | 3bd1791 | 2015-01-02 15:55:29 +0000 | [diff] [blame] | 635 | case SQLITE_CONFIG_PMASZ: { |
| 636 | sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int); |
| 637 | break; |
| 638 | } |
| 639 | |
drh | 8c71a98 | 2016-03-07 17:37:37 +0000 | [diff] [blame] | 640 | case SQLITE_CONFIG_STMTJRNL_SPILL: { |
| 641 | sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int); |
| 642 | break; |
| 643 | } |
| 644 | |
dan | 2e3a5a8 | 2018-04-16 21:12:42 +0000 | [diff] [blame] | 645 | #ifdef SQLITE_ENABLE_SORTER_REFERENCES |
drh | bbade8d | 2018-04-18 14:48:08 +0000 | [diff] [blame] | 646 | case SQLITE_CONFIG_SORTERREF_SIZE: { |
dan | 2e3a5a8 | 2018-04-16 21:12:42 +0000 | [diff] [blame] | 647 | int iVal = va_arg(ap, int); |
| 648 | if( iVal<0 ){ |
| 649 | iVal = SQLITE_DEFAULT_SORTERREF_SIZE; |
| 650 | } |
| 651 | sqlite3GlobalConfig.szSorterRef = (u32)iVal; |
dan | 2e3a5a8 | 2018-04-16 21:12:42 +0000 | [diff] [blame] | 652 | break; |
| 653 | } |
drh | bbade8d | 2018-04-18 14:48:08 +0000 | [diff] [blame] | 654 | #endif /* SQLITE_ENABLE_SORTER_REFERENCES */ |
dan | 2e3a5a8 | 2018-04-16 21:12:42 +0000 | [diff] [blame] | 655 | |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 656 | default: { |
| 657 | rc = SQLITE_ERROR; |
| 658 | break; |
| 659 | } |
| 660 | } |
| 661 | va_end(ap); |
| 662 | return rc; |
| 663 | } |
| 664 | |
| 665 | /* |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 666 | ** Set up the lookaside buffers for a database connection. |
| 667 | ** Return SQLITE_OK on success. |
| 668 | ** If lookaside is already active, return SQLITE_BUSY. |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 669 | ** |
| 670 | ** The sz parameter is the number of bytes in each lookaside slot. |
| 671 | ** The cnt parameter is the number of slots. If pStart is NULL the |
| 672 | ** space for the lookaside memory is obtained from sqlite3_malloc(). |
| 673 | ** If pStart is not NULL then it is sz*cnt bytes of memory to use for |
| 674 | ** the lookaside memory. |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 675 | */ |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 676 | static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){ |
drh | 7877d9a | 2015-07-23 17:16:27 +0000 | [diff] [blame] | 677 | #ifndef SQLITE_OMIT_LOOKASIDE |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 678 | void *pStart; |
drh | 52fb8e1 | 2017-08-29 20:21:12 +0000 | [diff] [blame] | 679 | |
| 680 | if( sqlite3LookasideUsed(db,0)>0 ){ |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 681 | return SQLITE_BUSY; |
| 682 | } |
shane | f71f89e | 2009-01-30 06:11:54 +0000 | [diff] [blame] | 683 | /* Free any existing lookaside buffer for this handle before |
| 684 | ** allocating a new one so we don't have to have space for |
| 685 | ** both at the same time. |
| 686 | */ |
| 687 | if( db->lookaside.bMalloced ){ |
| 688 | sqlite3_free(db->lookaside.pStart); |
| 689 | } |
drh | 61a4bd5 | 2011-11-10 02:39:28 +0000 | [diff] [blame] | 690 | /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger |
| 691 | ** than a pointer to be useful. |
shane | f71f89e | 2009-01-30 06:11:54 +0000 | [diff] [blame] | 692 | */ |
drh | 61a4bd5 | 2011-11-10 02:39:28 +0000 | [diff] [blame] | 693 | sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */ |
drh | 1d34fde | 2009-02-03 15:50:33 +0000 | [diff] [blame] | 694 | if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 695 | if( cnt<0 ) cnt = 0; |
shane | f71f89e | 2009-01-30 06:11:54 +0000 | [diff] [blame] | 696 | if( sz==0 || cnt==0 ){ |
| 697 | sz = 0; |
| 698 | pStart = 0; |
| 699 | }else if( pBuf==0 ){ |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 700 | sqlite3BeginBenignMalloc(); |
drh | 9dd55f5 | 2010-09-03 03:32:46 +0000 | [diff] [blame] | 701 | pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */ |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 702 | sqlite3EndBenignMalloc(); |
drh | 8225d66 | 2011-11-10 02:24:11 +0000 | [diff] [blame] | 703 | if( pStart ) cnt = sqlite3MallocSize(pStart)/sz; |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 704 | }else{ |
| 705 | pStart = pBuf; |
| 706 | } |
drh | 4cfb22f | 2008-08-01 18:47:01 +0000 | [diff] [blame] | 707 | db->lookaside.pStart = pStart; |
drh | 52fb8e1 | 2017-08-29 20:21:12 +0000 | [diff] [blame] | 708 | db->lookaside.pInit = 0; |
drh | 4cfb22f | 2008-08-01 18:47:01 +0000 | [diff] [blame] | 709 | db->lookaside.pFree = 0; |
drh | 1bd10f8 | 2008-12-10 21:19:56 +0000 | [diff] [blame] | 710 | db->lookaside.sz = (u16)sz; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 711 | if( pStart ){ |
| 712 | int i; |
| 713 | LookasideSlot *p; |
drh | de46798 | 2009-04-02 17:22:41 +0000 | [diff] [blame] | 714 | assert( sz > (int)sizeof(LookasideSlot*) ); |
drh | 52fb8e1 | 2017-08-29 20:21:12 +0000 | [diff] [blame] | 715 | db->lookaside.nSlot = cnt; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 716 | p = (LookasideSlot*)pStart; |
| 717 | for(i=cnt-1; i>=0; i--){ |
drh | 52fb8e1 | 2017-08-29 20:21:12 +0000 | [diff] [blame] | 718 | p->pNext = db->lookaside.pInit; |
| 719 | db->lookaside.pInit = p; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 720 | p = (LookasideSlot*)&((u8*)p)[sz]; |
| 721 | } |
| 722 | db->lookaside.pEnd = p; |
drh | 4a642b6 | 2016-02-05 01:55:27 +0000 | [diff] [blame] | 723 | db->lookaside.bDisable = 0; |
shane | f71f89e | 2009-01-30 06:11:54 +0000 | [diff] [blame] | 724 | db->lookaside.bMalloced = pBuf==0 ?1:0; |
drh | 4cfb22f | 2008-08-01 18:47:01 +0000 | [diff] [blame] | 725 | }else{ |
drh | b0e7704 | 2013-12-10 19:49:00 +0000 | [diff] [blame] | 726 | db->lookaside.pStart = db; |
| 727 | db->lookaside.pEnd = db; |
drh | 4a642b6 | 2016-02-05 01:55:27 +0000 | [diff] [blame] | 728 | db->lookaside.bDisable = 1; |
shane | f71f89e | 2009-01-30 06:11:54 +0000 | [diff] [blame] | 729 | db->lookaside.bMalloced = 0; |
drh | 52fb8e1 | 2017-08-29 20:21:12 +0000 | [diff] [blame] | 730 | db->lookaside.nSlot = 0; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 731 | } |
drh | 7877d9a | 2015-07-23 17:16:27 +0000 | [diff] [blame] | 732 | #endif /* SQLITE_OMIT_LOOKASIDE */ |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 733 | return SQLITE_OK; |
| 734 | } |
| 735 | |
| 736 | /* |
drh | 4413d0e | 2008-11-04 13:46:27 +0000 | [diff] [blame] | 737 | ** Return the mutex associated with a database connection. |
| 738 | */ |
| 739 | sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 740 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 741 | if( !sqlite3SafetyCheckOk(db) ){ |
| 742 | (void)SQLITE_MISUSE_BKPT; |
| 743 | return 0; |
| 744 | } |
| 745 | #endif |
drh | 4413d0e | 2008-11-04 13:46:27 +0000 | [diff] [blame] | 746 | return db->mutex; |
| 747 | } |
| 748 | |
| 749 | /* |
drh | 09419b4 | 2011-11-16 19:29:17 +0000 | [diff] [blame] | 750 | ** Free up as much memory as we can from the given database |
| 751 | ** connection. |
| 752 | */ |
| 753 | int sqlite3_db_release_memory(sqlite3 *db){ |
| 754 | int i; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 755 | |
| 756 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 757 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 758 | #endif |
dan | d9bb3a9 | 2011-12-30 11:43:59 +0000 | [diff] [blame] | 759 | sqlite3_mutex_enter(db->mutex); |
drh | 09419b4 | 2011-11-16 19:29:17 +0000 | [diff] [blame] | 760 | sqlite3BtreeEnterAll(db); |
| 761 | for(i=0; i<db->nDb; i++){ |
| 762 | Btree *pBt = db->aDb[i].pBt; |
| 763 | if( pBt ){ |
| 764 | Pager *pPager = sqlite3BtreePager(pBt); |
| 765 | sqlite3PagerShrink(pPager); |
| 766 | } |
| 767 | } |
| 768 | sqlite3BtreeLeaveAll(db); |
dan | d9bb3a9 | 2011-12-30 11:43:59 +0000 | [diff] [blame] | 769 | sqlite3_mutex_leave(db->mutex); |
drh | 09419b4 | 2011-11-16 19:29:17 +0000 | [diff] [blame] | 770 | return SQLITE_OK; |
| 771 | } |
| 772 | |
| 773 | /* |
dan | 6fa255f | 2015-10-28 19:46:57 +0000 | [diff] [blame] | 774 | ** Flush any dirty pages in the pager-cache for any attached database |
| 775 | ** to disk. |
| 776 | */ |
| 777 | int sqlite3_db_cacheflush(sqlite3 *db){ |
| 778 | int i; |
| 779 | int rc = SQLITE_OK; |
| 780 | int bSeenBusy = 0; |
| 781 | |
| 782 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 783 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 784 | #endif |
| 785 | sqlite3_mutex_enter(db->mutex); |
| 786 | sqlite3BtreeEnterAll(db); |
| 787 | for(i=0; rc==SQLITE_OK && i<db->nDb; i++){ |
| 788 | Btree *pBt = db->aDb[i].pBt; |
| 789 | if( pBt && sqlite3BtreeIsInTrans(pBt) ){ |
| 790 | Pager *pPager = sqlite3BtreePager(pBt); |
| 791 | rc = sqlite3PagerFlush(pPager); |
| 792 | if( rc==SQLITE_BUSY ){ |
| 793 | bSeenBusy = 1; |
| 794 | rc = SQLITE_OK; |
| 795 | } |
| 796 | } |
| 797 | } |
dan | 6fa255f | 2015-10-28 19:46:57 +0000 | [diff] [blame] | 798 | sqlite3BtreeLeaveAll(db); |
| 799 | sqlite3_mutex_leave(db->mutex); |
| 800 | return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc); |
| 801 | } |
| 802 | |
| 803 | /* |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 804 | ** Configuration settings for an individual database connection |
| 805 | */ |
| 806 | int sqlite3_db_config(sqlite3 *db, int op, ...){ |
| 807 | va_list ap; |
drh | 6480aad | 2008-08-01 16:31:14 +0000 | [diff] [blame] | 808 | int rc; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 809 | va_start(ap, op); |
| 810 | switch( op ){ |
drh | da84dca | 2016-08-18 22:44:22 +0000 | [diff] [blame] | 811 | case SQLITE_DBCONFIG_MAINDBNAME: { |
drh | 749e4a9 | 2017-07-14 19:47:32 +0000 | [diff] [blame] | 812 | /* IMP: R-06824-28531 */ |
| 813 | /* IMP: R-36257-52125 */ |
drh | da84dca | 2016-08-18 22:44:22 +0000 | [diff] [blame] | 814 | db->aDb[0].zDbSName = va_arg(ap,char*); |
| 815 | rc = SQLITE_OK; |
| 816 | break; |
| 817 | } |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 818 | case SQLITE_DBCONFIG_LOOKASIDE: { |
drh | 8b2b2e6 | 2011-04-07 01:14:12 +0000 | [diff] [blame] | 819 | void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */ |
drh | 9dd55f5 | 2010-09-03 03:32:46 +0000 | [diff] [blame] | 820 | int sz = va_arg(ap, int); /* IMP: R-47871-25994 */ |
| 821 | int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */ |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 822 | rc = setupLookaside(db, pBuf, sz, cnt); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 823 | break; |
| 824 | } |
drh | 6480aad | 2008-08-01 16:31:14 +0000 | [diff] [blame] | 825 | default: { |
drh | e83cafd | 2011-03-21 17:15:58 +0000 | [diff] [blame] | 826 | static const struct { |
| 827 | int op; /* The opcode */ |
| 828 | u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */ |
| 829 | } aFlagOp[] = { |
drh | d42908f | 2016-02-26 15:38:24 +0000 | [diff] [blame] | 830 | { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys }, |
| 831 | { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger }, |
| 832 | { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer }, |
drh | 191dd06 | 2016-04-21 01:30:09 +0000 | [diff] [blame] | 833 | { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension }, |
dan | 298af02 | 2016-10-31 16:16:49 +0000 | [diff] [blame] | 834 | { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose }, |
drh | 169dd92 | 2017-06-26 13:57:49 +0000 | [diff] [blame] | 835 | { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG }, |
drh | 36e31c6 | 2017-12-21 18:23:26 +0000 | [diff] [blame] | 836 | { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP }, |
drh | 7df0119 | 2018-04-28 12:43:16 +0000 | [diff] [blame] | 837 | { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase }, |
drh | e83cafd | 2011-03-21 17:15:58 +0000 | [diff] [blame] | 838 | }; |
drh | 58ad580 | 2011-03-23 22:02:23 +0000 | [diff] [blame] | 839 | unsigned int i; |
drh | 9dd55f5 | 2010-09-03 03:32:46 +0000 | [diff] [blame] | 840 | rc = SQLITE_ERROR; /* IMP: R-42790-23372 */ |
drh | e83cafd | 2011-03-21 17:15:58 +0000 | [diff] [blame] | 841 | for(i=0; i<ArraySize(aFlagOp); i++){ |
| 842 | if( aFlagOp[i].op==op ){ |
| 843 | int onoff = va_arg(ap, int); |
| 844 | int *pRes = va_arg(ap, int*); |
mistachkin | f6285fa | 2017-07-28 22:13:26 +0000 | [diff] [blame] | 845 | u32 oldFlags = db->flags; |
drh | e83cafd | 2011-03-21 17:15:58 +0000 | [diff] [blame] | 846 | if( onoff>0 ){ |
| 847 | db->flags |= aFlagOp[i].mask; |
| 848 | }else if( onoff==0 ){ |
| 849 | db->flags &= ~aFlagOp[i].mask; |
| 850 | } |
| 851 | if( oldFlags!=db->flags ){ |
drh | ba968db | 2018-07-24 22:02:12 +0000 | [diff] [blame] | 852 | sqlite3ExpirePreparedStatements(db, 0); |
drh | e83cafd | 2011-03-21 17:15:58 +0000 | [diff] [blame] | 853 | } |
| 854 | if( pRes ){ |
| 855 | *pRes = (db->flags & aFlagOp[i].mask)!=0; |
| 856 | } |
| 857 | rc = SQLITE_OK; |
| 858 | break; |
| 859 | } |
| 860 | } |
drh | 6480aad | 2008-08-01 16:31:14 +0000 | [diff] [blame] | 861 | break; |
| 862 | } |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 863 | } |
| 864 | va_end(ap); |
| 865 | return rc; |
| 866 | } |
| 867 | |
drh | a16313e | 2007-03-30 11:29:32 +0000 | [diff] [blame] | 868 | |
| 869 | /* |
drh | 9b5adfa | 2008-01-20 23:19:56 +0000 | [diff] [blame] | 870 | ** Return true if the buffer z[0..n-1] contains all spaces. |
| 871 | */ |
| 872 | static int allSpaces(const char *z, int n){ |
drh | 5f3a367 | 2008-04-15 04:02:40 +0000 | [diff] [blame] | 873 | while( n>0 && z[n-1]==' ' ){ n--; } |
drh | 9b5adfa | 2008-01-20 23:19:56 +0000 | [diff] [blame] | 874 | return n==0; |
| 875 | } |
| 876 | |
| 877 | /* |
drh | d3d39e9 | 2004-05-20 22:16:29 +0000 | [diff] [blame] | 878 | ** This is the default collating function named "BINARY" which is always |
| 879 | ** available. |
drh | 9b5adfa | 2008-01-20 23:19:56 +0000 | [diff] [blame] | 880 | ** |
| 881 | ** If the padFlag argument is not NULL then space padding at the end |
| 882 | ** of strings is ignored. This implements the RTRIM collation. |
drh | d3d39e9 | 2004-05-20 22:16:29 +0000 | [diff] [blame] | 883 | */ |
danielk1977 | 2c33654 | 2005-01-13 02:14:23 +0000 | [diff] [blame] | 884 | static int binCollFunc( |
drh | 9b5adfa | 2008-01-20 23:19:56 +0000 | [diff] [blame] | 885 | void *padFlag, |
drh | d3d39e9 | 2004-05-20 22:16:29 +0000 | [diff] [blame] | 886 | int nKey1, const void *pKey1, |
| 887 | int nKey2, const void *pKey2 |
| 888 | ){ |
| 889 | int rc, n; |
| 890 | n = nKey1<nKey2 ? nKey1 : nKey2; |
drh | 5e3b49b | 2014-11-20 19:22:26 +0000 | [diff] [blame] | 891 | /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares |
| 892 | ** strings byte by byte using the memcmp() function from the standard C |
| 893 | ** library. */ |
dan | 21766c0 | 2017-05-22 08:04:09 +0000 | [diff] [blame] | 894 | assert( pKey1 && pKey2 ); |
drh | d3d39e9 | 2004-05-20 22:16:29 +0000 | [diff] [blame] | 895 | rc = memcmp(pKey1, pKey2, n); |
| 896 | if( rc==0 ){ |
drh | 9b5adfa | 2008-01-20 23:19:56 +0000 | [diff] [blame] | 897 | if( padFlag |
| 898 | && allSpaces(((char*)pKey1)+n, nKey1-n) |
| 899 | && allSpaces(((char*)pKey2)+n, nKey2-n) |
| 900 | ){ |
drh | 5e3b49b | 2014-11-20 19:22:26 +0000 | [diff] [blame] | 901 | /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra |
| 902 | ** spaces at the end of either string do not change the result. In other |
| 903 | ** words, strings will compare equal to one another as long as they |
| 904 | ** differ only in the number of spaces at the end. |
| 905 | */ |
drh | 9b5adfa | 2008-01-20 23:19:56 +0000 | [diff] [blame] | 906 | }else{ |
| 907 | rc = nKey1 - nKey2; |
| 908 | } |
drh | d3d39e9 | 2004-05-20 22:16:29 +0000 | [diff] [blame] | 909 | } |
| 910 | return rc; |
| 911 | } |
| 912 | |
| 913 | /* |
drh | bcd1593 | 2018-07-27 18:12:40 +0000 | [diff] [blame] | 914 | ** Return true if CollSeq is the default built-in BINARY. |
| 915 | */ |
| 916 | int sqlite3IsBinary(const CollSeq *p){ |
| 917 | assert( p==0 || p->xCmp!=binCollFunc || p->pUser!=0 |
| 918 | || strcmp(p->zName,"BINARY")==0 ); |
| 919 | return p==0 || (p->xCmp==binCollFunc && p->pUser==0); |
| 920 | } |
| 921 | |
| 922 | /* |
danielk1977 | dc1bdc4 | 2004-06-11 10:51:27 +0000 | [diff] [blame] | 923 | ** Another built-in collating sequence: NOCASE. |
| 924 | ** |
drh | f7b5496 | 2013-05-28 12:11:54 +0000 | [diff] [blame] | 925 | ** This collating sequence is intended to be used for "case independent |
danielk1977 | dc1bdc4 | 2004-06-11 10:51:27 +0000 | [diff] [blame] | 926 | ** comparison". SQLite's knowledge of upper and lower case equivalents |
| 927 | ** extends only to the 26 characters used in the English language. |
| 928 | ** |
| 929 | ** At the moment there is only a UTF-8 implementation. |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 930 | */ |
| 931 | static int nocaseCollatingFunc( |
| 932 | void *NotUsed, |
| 933 | int nKey1, const void *pKey1, |
| 934 | int nKey2, const void *pKey2 |
| 935 | ){ |
| 936 | int r = sqlite3StrNICmp( |
drh | 208f80a | 2004-08-29 20:08:58 +0000 | [diff] [blame] | 937 | (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2); |
danielk1977 | 62c14b3 | 2008-11-19 09:05:26 +0000 | [diff] [blame] | 938 | UNUSED_PARAMETER(NotUsed); |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 939 | if( 0==r ){ |
| 940 | r = nKey1-nKey2; |
| 941 | } |
| 942 | return r; |
| 943 | } |
| 944 | |
| 945 | /* |
drh | af9ff33 | 2002-01-16 21:00:27 +0000 | [diff] [blame] | 946 | ** Return the ROWID of the most recent insert |
| 947 | */ |
drh | 9bb575f | 2004-09-06 17:24:11 +0000 | [diff] [blame] | 948 | sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 949 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 950 | if( !sqlite3SafetyCheckOk(db) ){ |
| 951 | (void)SQLITE_MISUSE_BKPT; |
| 952 | return 0; |
| 953 | } |
| 954 | #endif |
drh | af9ff33 | 2002-01-16 21:00:27 +0000 | [diff] [blame] | 955 | return db->lastRowid; |
| 956 | } |
| 957 | |
| 958 | /* |
dan | 9c58b63 | 2017-02-27 14:52:48 +0000 | [diff] [blame] | 959 | ** Set the value returned by the sqlite3_last_insert_rowid() API function. |
| 960 | */ |
| 961 | void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){ |
| 962 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 963 | if( !sqlite3SafetyCheckOk(db) ){ |
| 964 | (void)SQLITE_MISUSE_BKPT; |
| 965 | return; |
| 966 | } |
| 967 | #endif |
| 968 | sqlite3_mutex_enter(db->mutex); |
| 969 | db->lastRowid = iRowid; |
| 970 | sqlite3_mutex_leave(db->mutex); |
| 971 | } |
| 972 | |
| 973 | /* |
danielk1977 | 24b03fd | 2004-05-10 10:34:34 +0000 | [diff] [blame] | 974 | ** Return the number of changes in the most recent call to sqlite3_exec(). |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 975 | */ |
drh | 9bb575f | 2004-09-06 17:24:11 +0000 | [diff] [blame] | 976 | int sqlite3_changes(sqlite3 *db){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 977 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 978 | if( !sqlite3SafetyCheckOk(db) ){ |
| 979 | (void)SQLITE_MISUSE_BKPT; |
| 980 | return 0; |
| 981 | } |
| 982 | #endif |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 983 | return db->nChange; |
| 984 | } |
| 985 | |
rdc | f146a77 | 2004-02-25 22:51:06 +0000 | [diff] [blame] | 986 | /* |
danielk1977 | b28af71 | 2004-06-21 06:50:26 +0000 | [diff] [blame] | 987 | ** Return the number of changes since the database handle was opened. |
rdc | f146a77 | 2004-02-25 22:51:06 +0000 | [diff] [blame] | 988 | */ |
danielk1977 | b28af71 | 2004-06-21 06:50:26 +0000 | [diff] [blame] | 989 | int sqlite3_total_changes(sqlite3 *db){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 990 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 991 | if( !sqlite3SafetyCheckOk(db) ){ |
| 992 | (void)SQLITE_MISUSE_BKPT; |
| 993 | return 0; |
| 994 | } |
| 995 | #endif |
danielk1977 | b28af71 | 2004-06-21 06:50:26 +0000 | [diff] [blame] | 996 | return db->nTotalChange; |
rdc | b0c374f | 2004-02-20 22:53:38 +0000 | [diff] [blame] | 997 | } |
| 998 | |
drh | c8d30ac | 2002-04-12 10:08:59 +0000 | [diff] [blame] | 999 | /* |
danielk1977 | fd7f045 | 2008-12-17 17:30:26 +0000 | [diff] [blame] | 1000 | ** Close all open savepoints. This function only manipulates fields of the |
| 1001 | ** database handle object, it does not close any savepoints that may be open |
| 1002 | ** at the b-tree/pager level. |
| 1003 | */ |
| 1004 | void sqlite3CloseSavepoints(sqlite3 *db){ |
| 1005 | while( db->pSavepoint ){ |
| 1006 | Savepoint *pTmp = db->pSavepoint; |
| 1007 | db->pSavepoint = pTmp->pNext; |
| 1008 | sqlite3DbFree(db, pTmp); |
| 1009 | } |
| 1010 | db->nSavepoint = 0; |
danielk1977 | bd43455 | 2009-03-18 10:33:00 +0000 | [diff] [blame] | 1011 | db->nStatement = 0; |
danielk1977 | fd7f045 | 2008-12-17 17:30:26 +0000 | [diff] [blame] | 1012 | db->isTransactionSavepoint = 0; |
| 1013 | } |
| 1014 | |
| 1015 | /* |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1016 | ** Invoke the destructor function associated with FuncDef p, if any. Except, |
| 1017 | ** if this is not the last copy of the function, do not invoke it. Multiple |
| 1018 | ** copies of a single function are created when create_function() is called |
| 1019 | ** with SQLITE_ANY as the encoding. |
| 1020 | */ |
| 1021 | static void functionDestroy(sqlite3 *db, FuncDef *p){ |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 1022 | FuncDestructor *pDestructor = p->u.pDestructor; |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1023 | if( pDestructor ){ |
| 1024 | pDestructor->nRef--; |
| 1025 | if( pDestructor->nRef==0 ){ |
| 1026 | pDestructor->xDestroy(pDestructor->pUserData); |
| 1027 | sqlite3DbFree(db, pDestructor); |
| 1028 | } |
| 1029 | } |
| 1030 | } |
| 1031 | |
| 1032 | /* |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1033 | ** Disconnect all sqlite3_vtab objects that belong to database connection |
| 1034 | ** db. This is called when db is being closed. |
| 1035 | */ |
| 1036 | static void disconnectAllVtab(sqlite3 *db){ |
| 1037 | #ifndef SQLITE_OMIT_VIRTUALTABLE |
| 1038 | int i; |
drh | 51be387 | 2015-08-19 02:32:25 +0000 | [diff] [blame] | 1039 | HashElem *p; |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1040 | sqlite3BtreeEnterAll(db); |
| 1041 | for(i=0; i<db->nDb; i++){ |
| 1042 | Schema *pSchema = db->aDb[i].pSchema; |
mistachkin | 6389a7b | 2018-08-08 20:46:35 +0000 | [diff] [blame] | 1043 | if( pSchema ){ |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1044 | for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){ |
| 1045 | Table *pTab = (Table *)sqliteHashData(p); |
| 1046 | if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab); |
| 1047 | } |
| 1048 | } |
| 1049 | } |
drh | 51be387 | 2015-08-19 02:32:25 +0000 | [diff] [blame] | 1050 | for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){ |
| 1051 | Module *pMod = (Module *)sqliteHashData(p); |
| 1052 | if( pMod->pEpoTab ){ |
| 1053 | sqlite3VtabDisconnect(db, pMod->pEpoTab); |
| 1054 | } |
| 1055 | } |
dan | d88e521 | 2014-03-12 19:38:38 +0000 | [diff] [blame] | 1056 | sqlite3VtabUnlockList(db); |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1057 | sqlite3BtreeLeaveAll(db); |
| 1058 | #else |
| 1059 | UNUSED_PARAMETER(db); |
| 1060 | #endif |
| 1061 | } |
| 1062 | |
| 1063 | /* |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1064 | ** Return TRUE if database connection db has unfinalized prepared |
| 1065 | ** statements or unfinished sqlite3_backup objects. |
| 1066 | */ |
| 1067 | static int connectionIsBusy(sqlite3 *db){ |
| 1068 | int j; |
| 1069 | assert( sqlite3_mutex_held(db->mutex) ); |
| 1070 | if( db->pVdbe ) return 1; |
| 1071 | for(j=0; j<db->nDb; j++){ |
| 1072 | Btree *pBt = db->aDb[j].pBt; |
| 1073 | if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1; |
| 1074 | } |
| 1075 | return 0; |
| 1076 | } |
| 1077 | |
| 1078 | /* |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 1079 | ** Close an existing SQLite database |
| 1080 | */ |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1081 | static int sqlite3Close(sqlite3 *db, int forceZombie){ |
danielk1977 | 5c4c778 | 2004-06-16 10:39:23 +0000 | [diff] [blame] | 1082 | if( !db ){ |
drh | ddb17ca | 2014-08-11 15:54:11 +0000 | [diff] [blame] | 1083 | /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or |
| 1084 | ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */ |
danielk1977 | 96d81f9 | 2004-06-19 03:33:57 +0000 | [diff] [blame] | 1085 | return SQLITE_OK; |
danielk1977 | 5c4c778 | 2004-06-16 10:39:23 +0000 | [diff] [blame] | 1086 | } |
drh | 7e8b848 | 2008-01-23 03:03:05 +0000 | [diff] [blame] | 1087 | if( !sqlite3SafetyCheckSickOrOk(db) ){ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 1088 | return SQLITE_MISUSE_BKPT; |
danielk1977 | e35ee19 | 2004-06-26 09:50:11 +0000 | [diff] [blame] | 1089 | } |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 1090 | sqlite3_mutex_enter(db->mutex); |
drh | 3d2a529 | 2016-07-13 22:55:01 +0000 | [diff] [blame] | 1091 | if( db->mTrace & SQLITE_TRACE_CLOSE ){ |
| 1092 | db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0); |
| 1093 | } |
danielk1977 | e35ee19 | 2004-06-26 09:50:11 +0000 | [diff] [blame] | 1094 | |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1095 | /* Force xDisconnect calls on all virtual tables */ |
| 1096 | disconnectAllVtab(db); |
danielk1977 | a04a34f | 2007-04-16 15:06:25 +0000 | [diff] [blame] | 1097 | |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1098 | /* If a transaction is open, the disconnectAllVtab() call above |
danielk1977 | 0125683 | 2007-04-18 14:24:32 +0000 | [diff] [blame] | 1099 | ** will not have called the xDisconnect() method on any virtual |
| 1100 | ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback() |
| 1101 | ** call will do so. We need to do this before the check for active |
| 1102 | ** SQL statements below, as the v-table implementation may be storing |
| 1103 | ** some prepared statements internally. |
| 1104 | */ |
dan | 6743081 | 2013-05-15 10:21:50 +0000 | [diff] [blame] | 1105 | sqlite3VtabRollback(db); |
danielk1977 | 0125683 | 2007-04-18 14:24:32 +0000 | [diff] [blame] | 1106 | |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1107 | /* Legacy behavior (sqlite3_close() behavior) is to return |
| 1108 | ** SQLITE_BUSY if the connection can not be closed immediately. |
| 1109 | */ |
| 1110 | if( !forceZombie && connectionIsBusy(db) ){ |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 1111 | sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized " |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1112 | "statements or unfinished backups"); |
drh | 2764170 | 2007-08-22 02:56:42 +0000 | [diff] [blame] | 1113 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | 96d81f9 | 2004-06-19 03:33:57 +0000 | [diff] [blame] | 1114 | return SQLITE_BUSY; |
| 1115 | } |
danielk1977 | e004840 | 2004-06-15 16:51:01 +0000 | [diff] [blame] | 1116 | |
dan | ac45593 | 2012-11-26 19:50:41 +0000 | [diff] [blame] | 1117 | #ifdef SQLITE_ENABLE_SQLLOG |
| 1118 | if( sqlite3GlobalConfig.xSqllog ){ |
dan | 71ba10d | 2012-11-27 10:56:39 +0000 | [diff] [blame] | 1119 | /* Closing the handle. Fourth parameter is passed the value 2. */ |
| 1120 | sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2); |
dan | ac45593 | 2012-11-26 19:50:41 +0000 | [diff] [blame] | 1121 | } |
| 1122 | #endif |
| 1123 | |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1124 | /* Convert the connection into a zombie and then close it. |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1125 | */ |
| 1126 | db->magic = SQLITE_MAGIC_ZOMBIE; |
| 1127 | sqlite3LeaveMutexAndCloseZombie(db); |
| 1128 | return SQLITE_OK; |
| 1129 | } |
drh | 94e9203 | 2003-02-16 22:21:32 +0000 | [diff] [blame] | 1130 | |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1131 | /* |
| 1132 | ** Two variations on the public interface for closing a database |
| 1133 | ** connection. The sqlite3_close() version returns SQLITE_BUSY and |
| 1134 | ** leaves the connection option if there are unfinalized prepared |
| 1135 | ** statements or unfinished sqlite3_backups. The sqlite3_close_v2() |
| 1136 | ** version forces the connection to become a zombie if there are |
| 1137 | ** unclosed resources, and arranges for deallocation when the last |
| 1138 | ** prepare statement or sqlite3_backup closes. |
| 1139 | */ |
| 1140 | int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); } |
| 1141 | int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); } |
| 1142 | |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1143 | |
| 1144 | /* |
| 1145 | ** Close the mutex on database connection db. |
| 1146 | ** |
| 1147 | ** Furthermore, if database connection db is a zombie (meaning that there |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1148 | ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and |
| 1149 | ** every sqlite3_stmt has now been finalized and every sqlite3_backup has |
| 1150 | ** finished, then free all resources. |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1151 | */ |
| 1152 | void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){ |
| 1153 | HashElem *i; /* Hash table iterator */ |
| 1154 | int j; |
| 1155 | |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1156 | /* If there are outstanding sqlite3_stmt or sqlite3_backup objects |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1157 | ** or if the connection has not yet been closed by sqlite3_close_v2(), |
| 1158 | ** then just leave the mutex and return. |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1159 | */ |
drh | 167cd6a | 2012-06-02 17:09:46 +0000 | [diff] [blame] | 1160 | if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){ |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1161 | sqlite3_mutex_leave(db->mutex); |
| 1162 | return; |
danielk1977 | 0410302 | 2009-02-03 16:51:24 +0000 | [diff] [blame] | 1163 | } |
| 1164 | |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1165 | /* If we reach this point, it means that the database connection has |
| 1166 | ** closed all sqlite3_stmt and sqlite3_backup objects and has been |
mistachkin | 48864df | 2013-03-21 21:20:32 +0000 | [diff] [blame] | 1167 | ** passed to sqlite3_close (meaning that it is a zombie). Therefore, |
drh | 4245c40 | 2012-06-02 14:32:21 +0000 | [diff] [blame] | 1168 | ** go ahead and free all resources. |
| 1169 | */ |
| 1170 | |
dan | 617dc86 | 2013-05-16 11:57:28 +0000 | [diff] [blame] | 1171 | /* If a transaction is open, roll it back. This also ensures that if |
| 1172 | ** any database schemas have been modified by an uncommitted transaction |
| 1173 | ** they are reset. And that the required b-tree mutex is held to make |
| 1174 | ** the pager rollback and schema reset an atomic operation. */ |
| 1175 | sqlite3RollbackAll(db, SQLITE_OK); |
| 1176 | |
danielk1977 | fd7f045 | 2008-12-17 17:30:26 +0000 | [diff] [blame] | 1177 | /* Free any outstanding Savepoint structures. */ |
| 1178 | sqlite3CloseSavepoints(db); |
| 1179 | |
drh | 5efb314 | 2012-05-16 01:24:34 +0000 | [diff] [blame] | 1180 | /* Close all database connections */ |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 1181 | for(j=0; j<db->nDb; j++){ |
drh | 4d189ca | 2004-02-12 18:46:38 +0000 | [diff] [blame] | 1182 | struct Db *pDb = &db->aDb[j]; |
| 1183 | if( pDb->pBt ){ |
drh | ebdb81d | 2014-12-05 15:31:33 +0000 | [diff] [blame] | 1184 | sqlite3BtreeClose(pDb->pBt); |
| 1185 | pDb->pBt = 0; |
| 1186 | if( j!=1 ){ |
danielk1977 | 311019b | 2006-01-10 07:14:23 +0000 | [diff] [blame] | 1187 | pDb->pSchema = 0; |
| 1188 | } |
drh | 113088e | 2003-03-20 01:16:58 +0000 | [diff] [blame] | 1189 | } |
drh | f57b339 | 2001-10-08 13:22:32 +0000 | [diff] [blame] | 1190 | } |
drh | 5efb314 | 2012-05-16 01:24:34 +0000 | [diff] [blame] | 1191 | /* Clear the TEMP schema separately and last */ |
| 1192 | if( db->aDb[1].pSchema ){ |
| 1193 | sqlite3SchemaClear(db->aDb[1].pSchema); |
| 1194 | } |
| 1195 | sqlite3VtabUnlockList(db); |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1196 | |
drh | 5efb314 | 2012-05-16 01:24:34 +0000 | [diff] [blame] | 1197 | /* Free up the array of auxiliary databases */ |
| 1198 | sqlite3CollapseDatabaseArray(db); |
dan | bba02a9 | 2012-05-15 17:15:34 +0000 | [diff] [blame] | 1199 | assert( db->nDb<=2 ); |
| 1200 | assert( db->aDb==db->aDbStatic ); |
danielk1977 | 404ca07 | 2009-03-16 13:19:36 +0000 | [diff] [blame] | 1201 | |
| 1202 | /* Tell the code in notify.c that the connection no longer holds any |
| 1203 | ** locks and does not require any further unlock-notify callbacks. |
| 1204 | */ |
| 1205 | sqlite3ConnectionClosed(db); |
| 1206 | |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 1207 | for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){ |
| 1208 | FuncDef *pNext, *p; |
| 1209 | p = sqliteHashData(i); |
| 1210 | do{ |
| 1211 | functionDestroy(db, p); |
| 1212 | pNext = p->pNext; |
| 1213 | sqlite3DbFree(db, p); |
| 1214 | p = pNext; |
| 1215 | }while( p ); |
drh | 8e0a2f9 | 2002-02-23 23:45:45 +0000 | [diff] [blame] | 1216 | } |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 1217 | sqlite3HashClear(&db->aFunc); |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1218 | for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){ |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 1219 | CollSeq *pColl = (CollSeq *)sqliteHashData(i); |
danielk1977 | a9808b3 | 2007-05-07 09:32:45 +0000 | [diff] [blame] | 1220 | /* Invoke any destructors registered for collation sequence user data. */ |
| 1221 | for(j=0; j<3; j++){ |
| 1222 | if( pColl[j].xDel ){ |
| 1223 | pColl[j].xDel(pColl[j].pUser); |
| 1224 | } |
| 1225 | } |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 1226 | sqlite3DbFree(db, pColl); |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 1227 | } |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1228 | sqlite3HashClear(&db->aCollSeq); |
drh | b9bb7c1 | 2006-06-11 23:41:55 +0000 | [diff] [blame] | 1229 | #ifndef SQLITE_OMIT_VIRTUALTABLE |
danielk1977 | d1ab1ba | 2006-06-15 04:28:13 +0000 | [diff] [blame] | 1230 | for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){ |
| 1231 | Module *pMod = (Module *)sqliteHashData(i); |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 1232 | if( pMod->xDestroy ){ |
| 1233 | pMod->xDestroy(pMod->pAux); |
| 1234 | } |
drh | 51be387 | 2015-08-19 02:32:25 +0000 | [diff] [blame] | 1235 | sqlite3VtabEponymousTableClear(db, pMod); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 1236 | sqlite3DbFree(db, pMod); |
danielk1977 | d1ab1ba | 2006-06-15 04:28:13 +0000 | [diff] [blame] | 1237 | } |
drh | b9bb7c1 | 2006-06-11 23:41:55 +0000 | [diff] [blame] | 1238 | sqlite3HashClear(&db->aModule); |
| 1239 | #endif |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 1240 | |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 1241 | sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */ |
drh | a3cc007 | 2013-12-13 16:23:55 +0000 | [diff] [blame] | 1242 | sqlite3ValueFree(db->pErr); |
drh | f1952c5 | 2006-06-08 15:48:00 +0000 | [diff] [blame] | 1243 | sqlite3CloseExtensions(db); |
drh | d453097 | 2014-09-09 14:47:53 +0000 | [diff] [blame] | 1244 | #if SQLITE_USER_AUTHENTICATION |
| 1245 | sqlite3_free(db->auth.zAuthUser); |
| 1246 | sqlite3_free(db->auth.zAuthPW); |
| 1247 | #endif |
danielk1977 | 96d81f9 | 2004-06-19 03:33:57 +0000 | [diff] [blame] | 1248 | |
| 1249 | db->magic = SQLITE_MAGIC_ERROR; |
danielk1977 | 311019b | 2006-01-10 07:14:23 +0000 | [diff] [blame] | 1250 | |
| 1251 | /* The temp-database schema is allocated differently from the other schema |
| 1252 | ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()). |
| 1253 | ** So it needs to be freed here. Todo: Why not roll the temp schema into |
| 1254 | ** the same sqliteMalloc() as the one that allocates the database |
| 1255 | ** structure? |
| 1256 | */ |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 1257 | sqlite3DbFree(db, db->aDb[1].pSchema); |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 1258 | sqlite3_mutex_leave(db->mutex); |
drh | 7e8b848 | 2008-01-23 03:03:05 +0000 | [diff] [blame] | 1259 | db->magic = SQLITE_MAGIC_CLOSED; |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 1260 | sqlite3_mutex_free(db->mutex); |
drh | 52fb8e1 | 2017-08-29 20:21:12 +0000 | [diff] [blame] | 1261 | assert( sqlite3LookasideUsed(db,0)==0 ); |
drh | e9d1c72 | 2008-08-04 20:13:26 +0000 | [diff] [blame] | 1262 | if( db->lookaside.bMalloced ){ |
| 1263 | sqlite3_free(db->lookaside.pStart); |
| 1264 | } |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 1265 | sqlite3_free(db); |
drh | 7589723 | 2000-05-29 14:26:00 +0000 | [diff] [blame] | 1266 | } |
| 1267 | |
| 1268 | /* |
drh | 0f198a7 | 2012-02-13 16:43:16 +0000 | [diff] [blame] | 1269 | ** Rollback all database files. If tripCode is not SQLITE_OK, then |
drh | 47b7fc7 | 2014-11-11 01:33:57 +0000 | [diff] [blame] | 1270 | ** any write cursors are invalidated ("tripped" - as in "tripping a circuit |
drh | 0f198a7 | 2012-02-13 16:43:16 +0000 | [diff] [blame] | 1271 | ** breaker") and made to return tripCode if there are any further |
drh | 47b7fc7 | 2014-11-11 01:33:57 +0000 | [diff] [blame] | 1272 | ** attempts to use that cursor. Read cursors remain open and valid |
| 1273 | ** but are "saved" in case the table pages are moved around. |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 1274 | */ |
drh | 0f198a7 | 2012-02-13 16:43:16 +0000 | [diff] [blame] | 1275 | void sqlite3RollbackAll(sqlite3 *db, int tripCode){ |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 1276 | int i; |
danielk1977 | f3f06bb | 2005-12-16 15:24:28 +0000 | [diff] [blame] | 1277 | int inTrans = 0; |
drh | 47b7fc7 | 2014-11-11 01:33:57 +0000 | [diff] [blame] | 1278 | int schemaChange; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1279 | assert( sqlite3_mutex_held(db->mutex) ); |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 1280 | sqlite3BeginBenignMalloc(); |
dan | 617dc86 | 2013-05-16 11:57:28 +0000 | [diff] [blame] | 1281 | |
| 1282 | /* Obtain all b-tree mutexes before making any calls to BtreeRollback(). |
| 1283 | ** This is important in case the transaction being rolled back has |
| 1284 | ** modified the database schema. If the b-tree mutexes are not taken |
| 1285 | ** here, then another shared-cache connection might sneak in between |
| 1286 | ** the database rollback and schema reset, which can cause false |
| 1287 | ** corruption reports in some cases. */ |
dan | cd7b91a | 2013-05-13 18:23:15 +0000 | [diff] [blame] | 1288 | sqlite3BtreeEnterAll(db); |
drh | 8257aa8 | 2017-07-26 19:59:13 +0000 | [diff] [blame] | 1289 | schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0; |
dan | 617dc86 | 2013-05-16 11:57:28 +0000 | [diff] [blame] | 1290 | |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 1291 | for(i=0; i<db->nDb; i++){ |
drh | 0f198a7 | 2012-02-13 16:43:16 +0000 | [diff] [blame] | 1292 | Btree *p = db->aDb[i].pBt; |
| 1293 | if( p ){ |
| 1294 | if( sqlite3BtreeIsInTrans(p) ){ |
danielk1977 | f3f06bb | 2005-12-16 15:24:28 +0000 | [diff] [blame] | 1295 | inTrans = 1; |
| 1296 | } |
drh | 47b7fc7 | 2014-11-11 01:33:57 +0000 | [diff] [blame] | 1297 | sqlite3BtreeRollback(p, tripCode, !schemaChange); |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 1298 | } |
| 1299 | } |
danielk1977 | a298e90 | 2006-06-22 09:53:48 +0000 | [diff] [blame] | 1300 | sqlite3VtabRollback(db); |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 1301 | sqlite3EndBenignMalloc(); |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 1302 | |
drh | 7f32dc9 | 2018-07-16 11:32:59 +0000 | [diff] [blame] | 1303 | if( schemaChange ){ |
drh | ba968db | 2018-07-24 22:02:12 +0000 | [diff] [blame] | 1304 | sqlite3ExpirePreparedStatements(db, 0); |
drh | 81028a4 | 2012-05-15 18:28:27 +0000 | [diff] [blame] | 1305 | sqlite3ResetAllSchemasOfConnection(db); |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 1306 | } |
dan | cd7b91a | 2013-05-13 18:23:15 +0000 | [diff] [blame] | 1307 | sqlite3BtreeLeaveAll(db); |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 1308 | |
dan | 1da40a3 | 2009-09-19 17:00:31 +0000 | [diff] [blame] | 1309 | /* Any deferred constraint violations have now been resolved. */ |
| 1310 | db->nDeferredCons = 0; |
drh | 648e264 | 2013-07-11 15:03:32 +0000 | [diff] [blame] | 1311 | db->nDeferredImmCons = 0; |
| 1312 | db->flags &= ~SQLITE_DeferFKs; |
dan | 1da40a3 | 2009-09-19 17:00:31 +0000 | [diff] [blame] | 1313 | |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 1314 | /* If one has been configured, invoke the rollback-hook callback */ |
danielk1977 | f3f06bb | 2005-12-16 15:24:28 +0000 | [diff] [blame] | 1315 | if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){ |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 1316 | db->xRollbackCallback(db->pRollbackArg); |
| 1317 | } |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 1318 | } |
| 1319 | |
| 1320 | /* |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1321 | ** Return a static string containing the name corresponding to the error code |
| 1322 | ** specified in the argument. |
| 1323 | */ |
mistachkin | 5824d44 | 2015-04-28 23:34:10 +0000 | [diff] [blame] | 1324 | #if defined(SQLITE_NEED_ERR_NAME) |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1325 | const char *sqlite3ErrName(int rc){ |
| 1326 | const char *zName = 0; |
mistachkin | 10269dc | 2013-04-30 07:54:42 +0000 | [diff] [blame] | 1327 | int i, origRc = rc; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1328 | for(i=0; i<2 && zName==0; i++, rc &= 0xff){ |
| 1329 | switch( rc ){ |
| 1330 | case SQLITE_OK: zName = "SQLITE_OK"; break; |
| 1331 | case SQLITE_ERROR: zName = "SQLITE_ERROR"; break; |
dan | 8d4b7a3 | 2018-08-31 19:00:16 +0000 | [diff] [blame] | 1332 | case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1333 | case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break; |
| 1334 | case SQLITE_PERM: zName = "SQLITE_PERM"; break; |
| 1335 | case SQLITE_ABORT: zName = "SQLITE_ABORT"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1336 | case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1337 | case SQLITE_BUSY: zName = "SQLITE_BUSY"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1338 | case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break; |
dan | f73819a | 2013-06-27 11:46:27 +0000 | [diff] [blame] | 1339 | case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1340 | case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break; |
| 1341 | case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break; |
| 1342 | case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break; |
| 1343 | case SQLITE_READONLY: zName = "SQLITE_READONLY"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1344 | case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break; |
drh | 7e45e3a | 2017-11-08 17:32:12 +0000 | [diff] [blame] | 1345 | case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1346 | case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break; |
mistachkin | 091a81b | 2013-12-06 19:58:32 +0000 | [diff] [blame] | 1347 | case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break; |
dan | a688ca5 | 2018-01-10 11:56:03 +0000 | [diff] [blame] | 1348 | case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1349 | case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break; |
| 1350 | case SQLITE_IOERR: zName = "SQLITE_IOERR"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1351 | case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break; |
| 1352 | case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break; |
| 1353 | case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break; |
| 1354 | case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break; |
| 1355 | case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break; |
| 1356 | case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break; |
| 1357 | case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break; |
| 1358 | case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break; |
| 1359 | case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break; |
| 1360 | case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1361 | case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break; |
| 1362 | case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break; |
| 1363 | case SQLITE_IOERR_CHECKRESERVEDLOCK: |
| 1364 | zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break; |
| 1365 | case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break; |
| 1366 | case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break; |
| 1367 | case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break; |
| 1368 | case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break; |
| 1369 | case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break; |
| 1370 | case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break; |
| 1371 | case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break; |
| 1372 | case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break; |
| 1373 | case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break; |
| 1374 | case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break; |
mistachkin | 16a2e7a | 2013-07-31 22:27:16 +0000 | [diff] [blame] | 1375 | case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break; |
mistachkin | d95a3d3 | 2013-08-30 21:52:38 +0000 | [diff] [blame] | 1376 | case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1377 | case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1378 | case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1379 | case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break; |
| 1380 | case SQLITE_FULL: zName = "SQLITE_FULL"; break; |
| 1381 | case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1382 | case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break; |
| 1383 | case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break; |
| 1384 | case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break; |
mistachkin | d95a3d3 | 2013-08-30 21:52:38 +0000 | [diff] [blame] | 1385 | case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1386 | case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break; |
| 1387 | case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break; |
| 1388 | case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break; |
| 1389 | case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break; |
| 1390 | case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break; |
| 1391 | case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break; |
| 1392 | case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break; |
| 1393 | case SQLITE_CONSTRAINT_FOREIGNKEY: |
| 1394 | zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break; |
| 1395 | case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break; |
| 1396 | case SQLITE_CONSTRAINT_PRIMARYKEY: |
| 1397 | zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break; |
| 1398 | case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break; |
| 1399 | case SQLITE_CONSTRAINT_COMMITHOOK: |
| 1400 | zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break; |
| 1401 | case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break; |
| 1402 | case SQLITE_CONSTRAINT_FUNCTION: |
| 1403 | zName = "SQLITE_CONSTRAINT_FUNCTION"; break; |
drh | f9c8ce3 | 2013-11-05 13:33:55 +0000 | [diff] [blame] | 1404 | case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1405 | case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break; |
| 1406 | case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break; |
| 1407 | case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break; |
| 1408 | case SQLITE_AUTH: zName = "SQLITE_AUTH"; break; |
| 1409 | case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break; |
| 1410 | case SQLITE_RANGE: zName = "SQLITE_RANGE"; break; |
| 1411 | case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break; |
| 1412 | case SQLITE_ROW: zName = "SQLITE_ROW"; break; |
| 1413 | case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break; |
mistachkin | e84d8d3 | 2013-04-29 03:09:10 +0000 | [diff] [blame] | 1414 | case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break; |
| 1415 | case SQLITE_NOTICE_RECOVER_ROLLBACK: |
| 1416 | zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1417 | case SQLITE_WARNING: zName = "SQLITE_WARNING"; break; |
drh | 8d56e20 | 2013-06-28 23:55:45 +0000 | [diff] [blame] | 1418 | case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1419 | case SQLITE_DONE: zName = "SQLITE_DONE"; break; |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1420 | } |
| 1421 | } |
mistachkin | 10269dc | 2013-04-30 07:54:42 +0000 | [diff] [blame] | 1422 | if( zName==0 ){ |
| 1423 | static char zBuf[50]; |
| 1424 | sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc); |
| 1425 | zName = zBuf; |
| 1426 | } |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1427 | return zName; |
| 1428 | } |
mistachkin | 10269dc | 2013-04-30 07:54:42 +0000 | [diff] [blame] | 1429 | #endif |
mistachkin | f2c1c99 | 2013-04-28 01:44:43 +0000 | [diff] [blame] | 1430 | |
| 1431 | /* |
drh | c22bd47 | 2002-05-10 13:14:07 +0000 | [diff] [blame] | 1432 | ** Return a static string that describes the kind of error specified in the |
| 1433 | ** argument. |
drh | 247be43 | 2002-05-10 05:44:55 +0000 | [diff] [blame] | 1434 | */ |
danielk1977 | f20b21c | 2004-05-31 23:56:42 +0000 | [diff] [blame] | 1435 | const char *sqlite3ErrStr(int rc){ |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1436 | static const char* const aMsg[] = { |
| 1437 | /* SQLITE_OK */ "not an error", |
drh | a690ff3 | 2017-07-07 19:43:23 +0000 | [diff] [blame] | 1438 | /* SQLITE_ERROR */ "SQL logic error", |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1439 | /* SQLITE_INTERNAL */ 0, |
| 1440 | /* SQLITE_PERM */ "access permission denied", |
drh | ff4fa77 | 2017-07-10 12:07:53 +0000 | [diff] [blame] | 1441 | /* SQLITE_ABORT */ "query aborted", |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1442 | /* SQLITE_BUSY */ "database is locked", |
| 1443 | /* SQLITE_LOCKED */ "database table is locked", |
| 1444 | /* SQLITE_NOMEM */ "out of memory", |
| 1445 | /* SQLITE_READONLY */ "attempt to write a readonly database", |
| 1446 | /* SQLITE_INTERRUPT */ "interrupted", |
| 1447 | /* SQLITE_IOERR */ "disk I/O error", |
| 1448 | /* SQLITE_CORRUPT */ "database disk image is malformed", |
drh | 0b52b7d | 2011-01-26 19:46:22 +0000 | [diff] [blame] | 1449 | /* SQLITE_NOTFOUND */ "unknown operation", |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1450 | /* SQLITE_FULL */ "database or disk is full", |
| 1451 | /* SQLITE_CANTOPEN */ "unable to open database file", |
dan | 0dc7b74 | 2010-06-04 15:59:58 +0000 | [diff] [blame] | 1452 | /* SQLITE_PROTOCOL */ "locking protocol", |
drh | e75be1a | 2017-07-10 11:17:51 +0000 | [diff] [blame] | 1453 | /* SQLITE_EMPTY */ 0, |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1454 | /* SQLITE_SCHEMA */ "database schema has changed", |
drh | 4c8555f | 2009-06-25 01:47:11 +0000 | [diff] [blame] | 1455 | /* SQLITE_TOOBIG */ "string or blob too big", |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1456 | /* SQLITE_CONSTRAINT */ "constraint failed", |
| 1457 | /* SQLITE_MISMATCH */ "datatype mismatch", |
drh | ff4fa77 | 2017-07-10 12:07:53 +0000 | [diff] [blame] | 1458 | /* SQLITE_MISUSE */ "bad parameter or other API misuse", |
drh | e75be1a | 2017-07-10 11:17:51 +0000 | [diff] [blame] | 1459 | #ifdef SQLITE_DISABLE_LFS |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1460 | /* SQLITE_NOLFS */ "large file support is disabled", |
drh | e75be1a | 2017-07-10 11:17:51 +0000 | [diff] [blame] | 1461 | #else |
| 1462 | /* SQLITE_NOLFS */ 0, |
| 1463 | #endif |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1464 | /* SQLITE_AUTH */ "authorization denied", |
drh | e75be1a | 2017-07-10 11:17:51 +0000 | [diff] [blame] | 1465 | /* SQLITE_FORMAT */ 0, |
drh | ff4fa77 | 2017-07-10 12:07:53 +0000 | [diff] [blame] | 1466 | /* SQLITE_RANGE */ "column index out of range", |
| 1467 | /* SQLITE_NOTADB */ "file is not a database", |
mistachkin | 2a86110 | 2018-02-08 01:00:11 +0000 | [diff] [blame] | 1468 | /* SQLITE_NOTICE */ "notification message", |
| 1469 | /* SQLITE_WARNING */ "warning message", |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 1470 | }; |
drh | 21021a5 | 2012-02-13 17:01:51 +0000 | [diff] [blame] | 1471 | const char *zErr = "unknown error"; |
| 1472 | switch( rc ){ |
| 1473 | case SQLITE_ABORT_ROLLBACK: { |
| 1474 | zErr = "abort due to ROLLBACK"; |
| 1475 | break; |
| 1476 | } |
mistachkin | 2a86110 | 2018-02-08 01:00:11 +0000 | [diff] [blame] | 1477 | case SQLITE_ROW: { |
| 1478 | zErr = "another row available"; |
| 1479 | break; |
| 1480 | } |
| 1481 | case SQLITE_DONE: { |
| 1482 | zErr = "no more rows available"; |
| 1483 | break; |
| 1484 | } |
drh | 21021a5 | 2012-02-13 17:01:51 +0000 | [diff] [blame] | 1485 | default: { |
| 1486 | rc &= 0xff; |
| 1487 | if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){ |
| 1488 | zErr = aMsg[rc]; |
| 1489 | } |
| 1490 | break; |
| 1491 | } |
drh | 247be43 | 2002-05-10 05:44:55 +0000 | [diff] [blame] | 1492 | } |
drh | 21021a5 | 2012-02-13 17:01:51 +0000 | [diff] [blame] | 1493 | return zErr; |
drh | 247be43 | 2002-05-10 05:44:55 +0000 | [diff] [blame] | 1494 | } |
| 1495 | |
| 1496 | /* |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1497 | ** This routine implements a busy callback that sleeps and tries |
| 1498 | ** again until a timeout value is reached. The timeout value is |
| 1499 | ** an integer number of milliseconds passed in as the first |
| 1500 | ** argument. |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1501 | ** |
| 1502 | ** Return non-zero to retry the lock. Return zero to stop trying |
| 1503 | ** and cause SQLite to return SQLITE_BUSY. |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1504 | */ |
drh | daffd0e | 2001-04-11 14:28:42 +0000 | [diff] [blame] | 1505 | static int sqliteDefaultBusyCallback( |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1506 | void *ptr, /* Database connection */ |
| 1507 | int count, /* Number of times table has been busy */ |
| 1508 | sqlite3_file *pFile /* The file on which the lock occurred */ |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1509 | ){ |
drh | 0ede9eb | 2015-01-10 16:49:23 +0000 | [diff] [blame] | 1510 | #if SQLITE_OS_WIN || HAVE_USLEEP |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1511 | /* This case is for systems that have support for sleeping for fractions of |
| 1512 | ** a second. Examples: All windows systems, unix systems with usleep() */ |
drh | ee570fa | 2005-04-28 12:06:05 +0000 | [diff] [blame] | 1513 | static const u8 delays[] = |
| 1514 | { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 }; |
| 1515 | static const u8 totals[] = |
| 1516 | { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 }; |
drh | fcd71b6 | 2011-04-05 22:08:24 +0000 | [diff] [blame] | 1517 | # define NDELAY ArraySize(delays) |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1518 | sqlite3 *db = (sqlite3 *)ptr; |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1519 | int tmout = db->busyTimeout; |
drh | 97903fe | 2005-05-24 20:19:57 +0000 | [diff] [blame] | 1520 | int delay, prior; |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1521 | |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1522 | #ifdef SQLITE_ENABLE_SETLK_TIMEOUT |
| 1523 | if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){ |
| 1524 | if( count ){ |
| 1525 | tmout = 0; |
| 1526 | sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout); |
| 1527 | return 0; |
| 1528 | }else{ |
| 1529 | return 1; |
| 1530 | } |
| 1531 | } |
drh | 5013c4b | 2018-03-28 21:45:03 +0000 | [diff] [blame] | 1532 | #else |
| 1533 | UNUSED_PARAMETER(pFile); |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1534 | #endif |
drh | ee570fa | 2005-04-28 12:06:05 +0000 | [diff] [blame] | 1535 | assert( count>=0 ); |
| 1536 | if( count < NDELAY ){ |
| 1537 | delay = delays[count]; |
| 1538 | prior = totals[count]; |
drh | d1bec47 | 2004-01-15 13:29:31 +0000 | [diff] [blame] | 1539 | }else{ |
| 1540 | delay = delays[NDELAY-1]; |
drh | 68cb619 | 2005-05-06 22:05:56 +0000 | [diff] [blame] | 1541 | prior = totals[NDELAY-1] + delay*(count-(NDELAY-1)); |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1542 | } |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1543 | if( prior + delay > tmout ){ |
| 1544 | delay = tmout - prior; |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1545 | if( delay<=0 ) return 0; |
| 1546 | } |
danielk1977 | 2a6bdf6 | 2007-08-20 16:07:00 +0000 | [diff] [blame] | 1547 | sqlite3OsSleep(db->pVfs, delay*1000); |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1548 | return 1; |
| 1549 | #else |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1550 | /* This case for unix systems that lack usleep() support. Sleeping |
| 1551 | ** must be done in increments of whole seconds */ |
drh | 482ea18 | 2007-08-20 11:12:40 +0000 | [diff] [blame] | 1552 | sqlite3 *db = (sqlite3 *)ptr; |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1553 | int tmout = ((sqlite3 *)ptr)->busyTimeout; |
drh | 5013c4b | 2018-03-28 21:45:03 +0000 | [diff] [blame] | 1554 | UNUSED_PARAMETER(pFile); |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1555 | if( (count+1)*1000 > tmout ){ |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1556 | return 0; |
| 1557 | } |
drh | 482ea18 | 2007-08-20 11:12:40 +0000 | [diff] [blame] | 1558 | sqlite3OsSleep(db->pVfs, 1000000); |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1559 | return 1; |
| 1560 | #endif |
| 1561 | } |
| 1562 | |
| 1563 | /* |
drh | a4afb65 | 2005-07-09 02:16:02 +0000 | [diff] [blame] | 1564 | ** Invoke the given busy handler. |
| 1565 | ** |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1566 | ** This routine is called when an operation failed to acquire a |
| 1567 | ** lock on VFS file pFile. |
| 1568 | ** |
drh | a4afb65 | 2005-07-09 02:16:02 +0000 | [diff] [blame] | 1569 | ** If this routine returns non-zero, the lock is retried. If it |
| 1570 | ** returns 0, the operation aborts with an SQLITE_BUSY error. |
| 1571 | */ |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1572 | int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){ |
drh | a4afb65 | 2005-07-09 02:16:02 +0000 | [diff] [blame] | 1573 | int rc; |
drh | 8026289 | 2018-03-26 16:37:53 +0000 | [diff] [blame] | 1574 | if( p->xBusyHandler==0 || p->nBusy<0 ) return 0; |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1575 | if( p->bExtraFileArg ){ |
| 1576 | /* Add an extra parameter with the pFile pointer to the end of the |
| 1577 | ** callback argument list */ |
| 1578 | int (*xTra)(void*,int,sqlite3_file*); |
| 1579 | xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler; |
| 1580 | rc = xTra(p->pBusyArg, p->nBusy, pFile); |
| 1581 | }else{ |
| 1582 | /* Legacy style busy handler callback */ |
| 1583 | rc = p->xBusyHandler(p->pBusyArg, p->nBusy); |
| 1584 | } |
drh | a4afb65 | 2005-07-09 02:16:02 +0000 | [diff] [blame] | 1585 | if( rc==0 ){ |
| 1586 | p->nBusy = -1; |
| 1587 | }else{ |
| 1588 | p->nBusy++; |
| 1589 | } |
| 1590 | return rc; |
| 1591 | } |
| 1592 | |
| 1593 | /* |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1594 | ** This routine sets the busy callback for an Sqlite database to the |
| 1595 | ** given callback function with the given argument. |
| 1596 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 1597 | int sqlite3_busy_handler( |
| 1598 | sqlite3 *db, |
danielk1977 | 2a764eb | 2004-06-12 01:43:26 +0000 | [diff] [blame] | 1599 | int (*xBusy)(void*,int), |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1600 | void *pArg |
| 1601 | ){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1602 | #ifdef SQLITE_ENABLE_API_ARMOR |
drh | 96c707a | 2015-02-13 16:36:14 +0000 | [diff] [blame] | 1603 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1604 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1605 | sqlite3_mutex_enter(db->mutex); |
drh | 8026289 | 2018-03-26 16:37:53 +0000 | [diff] [blame] | 1606 | db->busyHandler.xBusyHandler = xBusy; |
| 1607 | db->busyHandler.pBusyArg = pArg; |
drh | a4afb65 | 2005-07-09 02:16:02 +0000 | [diff] [blame] | 1608 | db->busyHandler.nBusy = 0; |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1609 | db->busyHandler.bExtraFileArg = 0; |
drh | c0c7b5e | 2012-09-07 18:49:57 +0000 | [diff] [blame] | 1610 | db->busyTimeout = 0; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1611 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 1612 | return SQLITE_OK; |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1613 | } |
| 1614 | |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 1615 | #ifndef SQLITE_OMIT_PROGRESS_CALLBACK |
| 1616 | /* |
| 1617 | ** This routine sets the progress callback for an Sqlite database to the |
| 1618 | ** given callback function with the given argument. The progress callback will |
| 1619 | ** be invoked every nOps opcodes. |
| 1620 | */ |
danielk1977 | 24b03fd | 2004-05-10 10:34:34 +0000 | [diff] [blame] | 1621 | void sqlite3_progress_handler( |
drh | 9bb575f | 2004-09-06 17:24:11 +0000 | [diff] [blame] | 1622 | sqlite3 *db, |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 1623 | int nOps, |
| 1624 | int (*xProgress)(void*), |
| 1625 | void *pArg |
| 1626 | ){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1627 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 1628 | if( !sqlite3SafetyCheckOk(db) ){ |
| 1629 | (void)SQLITE_MISUSE_BKPT; |
| 1630 | return; |
| 1631 | } |
| 1632 | #endif |
drh | bd0b1b5 | 2008-07-07 19:52:09 +0000 | [diff] [blame] | 1633 | sqlite3_mutex_enter(db->mutex); |
| 1634 | if( nOps>0 ){ |
| 1635 | db->xProgress = xProgress; |
drh | 8f8c65f | 2013-07-10 18:14:29 +0000 | [diff] [blame] | 1636 | db->nProgressOps = (unsigned)nOps; |
drh | bd0b1b5 | 2008-07-07 19:52:09 +0000 | [diff] [blame] | 1637 | db->pProgressArg = pArg; |
| 1638 | }else{ |
| 1639 | db->xProgress = 0; |
| 1640 | db->nProgressOps = 0; |
| 1641 | db->pProgressArg = 0; |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 1642 | } |
drh | bd0b1b5 | 2008-07-07 19:52:09 +0000 | [diff] [blame] | 1643 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | 348bb5d | 2003-10-18 09:37:26 +0000 | [diff] [blame] | 1644 | } |
| 1645 | #endif |
| 1646 | |
| 1647 | |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1648 | /* |
| 1649 | ** This routine installs a default busy handler that waits for the |
| 1650 | ** specified number of milliseconds before returning 0. |
| 1651 | */ |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 1652 | int sqlite3_busy_timeout(sqlite3 *db, int ms){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1653 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 1654 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 1655 | #endif |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1656 | if( ms>0 ){ |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1657 | sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback, |
| 1658 | (void*)db); |
drh | c0c7b5e | 2012-09-07 18:49:57 +0000 | [diff] [blame] | 1659 | db->busyTimeout = ms; |
drh | f0119b2 | 2018-03-26 17:40:53 +0000 | [diff] [blame] | 1660 | db->busyHandler.bExtraFileArg = 1; |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1661 | }else{ |
danielk1977 | 24b03fd | 2004-05-10 10:34:34 +0000 | [diff] [blame] | 1662 | sqlite3_busy_handler(db, 0, 0); |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1663 | } |
danielk1977 | f9d64d2 | 2004-06-19 08:18:07 +0000 | [diff] [blame] | 1664 | return SQLITE_OK; |
drh | 2dfbbca | 2000-07-28 14:32:48 +0000 | [diff] [blame] | 1665 | } |
drh | 4c50439 | 2000-10-16 22:06:40 +0000 | [diff] [blame] | 1666 | |
| 1667 | /* |
| 1668 | ** Cause any pending operation to stop at its earliest opportunity. |
| 1669 | */ |
drh | 9bb575f | 2004-09-06 17:24:11 +0000 | [diff] [blame] | 1670 | void sqlite3_interrupt(sqlite3 *db){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1671 | #ifdef SQLITE_ENABLE_API_ARMOR |
drh | 575242f | 2016-12-27 13:33:52 +0000 | [diff] [blame] | 1672 | if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1673 | (void)SQLITE_MISUSE_BKPT; |
| 1674 | return; |
| 1675 | } |
| 1676 | #endif |
drh | bd0b1b5 | 2008-07-07 19:52:09 +0000 | [diff] [blame] | 1677 | db->u1.isInterrupted = 1; |
drh | 4c50439 | 2000-10-16 22:06:40 +0000 | [diff] [blame] | 1678 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1679 | |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1680 | |
| 1681 | /* |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1682 | ** This function is exactly the same as sqlite3_create_function(), except |
| 1683 | ** that it is designed to be called by internal code. The difference is |
| 1684 | ** that if a malloc() fails in sqlite3_create_function(), an error code |
| 1685 | ** is returned and the mallocFailed flag cleared. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1686 | */ |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1687 | int sqlite3CreateFunc( |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1688 | sqlite3 *db, |
| 1689 | const char *zFunctionName, |
| 1690 | int nArg, |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1691 | int enc, |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1692 | void *pUserData, |
drh | 2d80151 | 2016-01-14 22:19:58 +0000 | [diff] [blame] | 1693 | void (*xSFunc)(sqlite3_context*,int,sqlite3_value **), |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1694 | void (*xStep)(sqlite3_context*,int,sqlite3_value **), |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1695 | void (*xFinal)(sqlite3_context*), |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1696 | void (*xValue)(sqlite3_context*), |
| 1697 | void (*xInverse)(sqlite3_context*,int,sqlite3_value **), |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1698 | FuncDestructor *pDestructor |
drh | 8e0a2f9 | 2002-02-23 23:45:45 +0000 | [diff] [blame] | 1699 | ){ |
drh | 0bce835 | 2002-02-28 00:41:10 +0000 | [diff] [blame] | 1700 | FuncDef *p; |
drh | 4b59ab5 | 2002-08-24 18:24:51 +0000 | [diff] [blame] | 1701 | int nName; |
drh | 4a8ee3d | 2013-12-14 13:44:22 +0000 | [diff] [blame] | 1702 | int extraFlags; |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1703 | |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1704 | assert( sqlite3_mutex_held(db->mutex) ); |
drh | 1e80ace | 2018-07-09 02:37:12 +0000 | [diff] [blame] | 1705 | assert( xValue==0 || xSFunc==0 ); |
| 1706 | if( zFunctionName==0 /* Must have a valid name */ |
| 1707 | || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */ |
| 1708 | || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */ |
| 1709 | || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */ |
| 1710 | || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) |
| 1711 | || (255<(nName = sqlite3Strlen30( zFunctionName))) |
| 1712 | ){ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 1713 | return SQLITE_MISUSE_BKPT; |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1714 | } |
drh | 4a8ee3d | 2013-12-14 13:44:22 +0000 | [diff] [blame] | 1715 | |
| 1716 | assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC ); |
| 1717 | extraFlags = enc & SQLITE_DETERMINISTIC; |
| 1718 | enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY); |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1719 | |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame] | 1720 | #ifndef SQLITE_OMIT_UTF16 |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1721 | /* If SQLITE_UTF16 is specified as the encoding type, transform this |
| 1722 | ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the |
| 1723 | ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally. |
| 1724 | ** |
| 1725 | ** If SQLITE_ANY is specified, add three versions of the function |
| 1726 | ** to the hash table. |
| 1727 | */ |
| 1728 | if( enc==SQLITE_UTF16 ){ |
| 1729 | enc = SQLITE_UTF16NATIVE; |
| 1730 | }else if( enc==SQLITE_ANY ){ |
| 1731 | int rc; |
drh | 4a8ee3d | 2013-12-14 13:44:22 +0000 | [diff] [blame] | 1732 | rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags, |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1733 | pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor); |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1734 | if( rc==SQLITE_OK ){ |
drh | 4a8ee3d | 2013-12-14 13:44:22 +0000 | [diff] [blame] | 1735 | rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags, |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1736 | pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor); |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1737 | } |
| 1738 | if( rc!=SQLITE_OK ){ |
| 1739 | return rc; |
| 1740 | } |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 1741 | enc = SQLITE_UTF16BE; |
| 1742 | } |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame] | 1743 | #else |
| 1744 | enc = SQLITE_UTF8; |
| 1745 | #endif |
danielk1977 | 9636c4e | 2005-01-25 04:27:54 +0000 | [diff] [blame] | 1746 | |
| 1747 | /* Check if an existing function is being overridden or deleted. If so, |
| 1748 | ** and there are active VMs, then return SQLITE_BUSY. If a function |
| 1749 | ** is being overridden/deleted but there are no active VMs, allow the |
| 1750 | ** operation to continue but invalidate all precompiled statements. |
| 1751 | */ |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 1752 | p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0); |
drh | c7bf571 | 2018-07-09 22:49:01 +0000 | [diff] [blame] | 1753 | if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){ |
drh | 4f7d3a5 | 2013-06-27 23:54:02 +0000 | [diff] [blame] | 1754 | if( db->nVdbeActive ){ |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 1755 | sqlite3ErrorWithMsg(db, SQLITE_BUSY, |
drh | b309bec | 2009-02-04 17:40:57 +0000 | [diff] [blame] | 1756 | "unable to delete/modify user-function due to active statements"); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 1757 | assert( !db->mallocFailed ); |
danielk1977 | 9636c4e | 2005-01-25 04:27:54 +0000 | [diff] [blame] | 1758 | return SQLITE_BUSY; |
| 1759 | }else{ |
drh | ba968db | 2018-07-24 22:02:12 +0000 | [diff] [blame] | 1760 | sqlite3ExpirePreparedStatements(db, 0); |
danielk1977 | 9636c4e | 2005-01-25 04:27:54 +0000 | [diff] [blame] | 1761 | } |
| 1762 | } |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1763 | |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 1764 | p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1); |
danielk1977 | fa18bec | 2007-09-03 11:04:22 +0000 | [diff] [blame] | 1765 | assert(p || db->mallocFailed); |
| 1766 | if( !p ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 1767 | return SQLITE_NOMEM_BKPT; |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1768 | } |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1769 | |
| 1770 | /* If an older version of the function with a configured destructor is |
| 1771 | ** being replaced invoke the destructor function here. */ |
| 1772 | functionDestroy(db, p); |
| 1773 | |
| 1774 | if( pDestructor ){ |
| 1775 | pDestructor->nRef++; |
| 1776 | } |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 1777 | p->u.pDestructor = pDestructor; |
drh | 4a8ee3d | 2013-12-14 13:44:22 +0000 | [diff] [blame] | 1778 | p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags; |
| 1779 | testcase( p->funcFlags & SQLITE_DETERMINISTIC ); |
drh | 2d80151 | 2016-01-14 22:19:58 +0000 | [diff] [blame] | 1780 | p->xSFunc = xSFunc ? xSFunc : xStep; |
danielk1977 | fa18bec | 2007-09-03 11:04:22 +0000 | [diff] [blame] | 1781 | p->xFinalize = xFinal; |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1782 | p->xValue = xValue; |
| 1783 | p->xInverse = xInverse; |
danielk1977 | fa18bec | 2007-09-03 11:04:22 +0000 | [diff] [blame] | 1784 | p->pUserData = pUserData; |
drh | 1bd10f8 | 2008-12-10 21:19:56 +0000 | [diff] [blame] | 1785 | p->nArg = (u16)nArg; |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1786 | return SQLITE_OK; |
| 1787 | } |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1788 | |
| 1789 | /* |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1790 | ** Worker function used by utf-8 APIs that create new functions: |
| 1791 | ** |
| 1792 | ** sqlite3_create_function() |
| 1793 | ** sqlite3_create_function_v2() |
| 1794 | ** sqlite3_create_window_function() |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1795 | */ |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1796 | static int createFunctionApi( |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1797 | sqlite3 *db, |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1798 | const char *zFunc, |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1799 | int nArg, |
| 1800 | int enc, |
| 1801 | void *p, |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1802 | void (*xSFunc)(sqlite3_context*,int,sqlite3_value**), |
| 1803 | void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1804 | void (*xFinal)(sqlite3_context*), |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1805 | void (*xValue)(sqlite3_context*), |
| 1806 | void (*xInverse)(sqlite3_context*,int,sqlite3_value**), |
| 1807 | void(*xDestroy)(void*) |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1808 | ){ |
shaneh | bd2aaf9 | 2010-09-01 02:38:21 +0000 | [diff] [blame] | 1809 | int rc = SQLITE_ERROR; |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1810 | FuncDestructor *pArg = 0; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1811 | |
| 1812 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 1813 | if( !sqlite3SafetyCheckOk(db) ){ |
| 1814 | return SQLITE_MISUSE_BKPT; |
| 1815 | } |
| 1816 | #endif |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1817 | sqlite3_mutex_enter(db->mutex); |
| 1818 | if( xDestroy ){ |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1819 | pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor)); |
dan | 9508daa | 2010-08-28 18:58:00 +0000 | [diff] [blame] | 1820 | if( !pArg ){ |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1821 | sqlite3OomFault(db); |
dan | 9508daa | 2010-08-28 18:58:00 +0000 | [diff] [blame] | 1822 | xDestroy(p); |
| 1823 | goto out; |
| 1824 | } |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1825 | pArg->nRef = 0; |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1826 | pArg->xDestroy = xDestroy; |
| 1827 | pArg->pUserData = p; |
| 1828 | } |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1829 | rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, |
| 1830 | xSFunc, xStep, xFinal, xValue, xInverse, pArg |
| 1831 | ); |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1832 | if( pArg && pArg->nRef==0 ){ |
| 1833 | assert( rc!=SQLITE_OK ); |
dan | 9508daa | 2010-08-28 18:58:00 +0000 | [diff] [blame] | 1834 | xDestroy(p); |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1835 | sqlite3_free(pArg); |
dan | d2199f0 | 2010-08-27 17:48:52 +0000 | [diff] [blame] | 1836 | } |
| 1837 | |
| 1838 | out: |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1839 | rc = sqlite3ApiExit(db, rc); |
| 1840 | sqlite3_mutex_leave(db->mutex); |
| 1841 | return rc; |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1842 | } |
| 1843 | |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1844 | /* |
| 1845 | ** Create new user functions. |
| 1846 | */ |
| 1847 | int sqlite3_create_function( |
| 1848 | sqlite3 *db, |
| 1849 | const char *zFunc, |
| 1850 | int nArg, |
| 1851 | int enc, |
| 1852 | void *p, |
| 1853 | void (*xSFunc)(sqlite3_context*,int,sqlite3_value **), |
| 1854 | void (*xStep)(sqlite3_context*,int,sqlite3_value **), |
| 1855 | void (*xFinal)(sqlite3_context*) |
| 1856 | ){ |
| 1857 | return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep, |
| 1858 | xFinal, 0, 0, 0); |
| 1859 | } |
| 1860 | int sqlite3_create_function_v2( |
| 1861 | sqlite3 *db, |
| 1862 | const char *zFunc, |
| 1863 | int nArg, |
| 1864 | int enc, |
| 1865 | void *p, |
| 1866 | void (*xSFunc)(sqlite3_context*,int,sqlite3_value **), |
| 1867 | void (*xStep)(sqlite3_context*,int,sqlite3_value **), |
| 1868 | void (*xFinal)(sqlite3_context*), |
| 1869 | void (*xDestroy)(void *) |
| 1870 | ){ |
| 1871 | return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep, |
| 1872 | xFinal, 0, 0, xDestroy); |
| 1873 | } |
| 1874 | int sqlite3_create_window_function( |
| 1875 | sqlite3 *db, |
| 1876 | const char *zFunc, |
| 1877 | int nArg, |
| 1878 | int enc, |
| 1879 | void *p, |
| 1880 | void (*xStep)(sqlite3_context*,int,sqlite3_value **), |
| 1881 | void (*xFinal)(sqlite3_context*), |
| 1882 | void (*xValue)(sqlite3_context*), |
| 1883 | void (*xInverse)(sqlite3_context*,int,sqlite3_value **), |
| 1884 | void (*xDestroy)(void *) |
| 1885 | ){ |
| 1886 | return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep, |
| 1887 | xFinal, xValue, xInverse, xDestroy); |
| 1888 | } |
| 1889 | |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame] | 1890 | #ifndef SQLITE_OMIT_UTF16 |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1891 | int sqlite3_create_function16( |
| 1892 | sqlite3 *db, |
| 1893 | const void *zFunctionName, |
| 1894 | int nArg, |
| 1895 | int eTextRep, |
danielk1977 | 771151b | 2006-01-17 13:21:40 +0000 | [diff] [blame] | 1896 | void *p, |
drh | 2d80151 | 2016-01-14 22:19:58 +0000 | [diff] [blame] | 1897 | void (*xSFunc)(sqlite3_context*,int,sqlite3_value**), |
danielk1977 | 6590493 | 2004-05-26 06:18:37 +0000 | [diff] [blame] | 1898 | void (*xStep)(sqlite3_context*,int,sqlite3_value**), |
| 1899 | void (*xFinal)(sqlite3_context*) |
| 1900 | ){ |
| 1901 | int rc; |
drh | af9a7c2 | 2005-12-15 03:04:10 +0000 | [diff] [blame] | 1902 | char *zFunc8; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1903 | |
| 1904 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 1905 | if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT; |
| 1906 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1907 | sqlite3_mutex_enter(db->mutex); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 1908 | assert( !db->mallocFailed ); |
dan | b7dca7d | 2010-03-05 16:32:12 +0000 | [diff] [blame] | 1909 | zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE); |
dan | 660af93 | 2018-06-18 16:55:22 +0000 | [diff] [blame] | 1910 | rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 1911 | sqlite3DbFree(db, zFunc8); |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1912 | rc = sqlite3ApiExit(db, rc); |
| 1913 | sqlite3_mutex_leave(db->mutex); |
| 1914 | return rc; |
drh | 8e0a2f9 | 2002-02-23 23:45:45 +0000 | [diff] [blame] | 1915 | } |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame] | 1916 | #endif |
drh | c9b84a1 | 2002-06-20 11:36:48 +0000 | [diff] [blame] | 1917 | |
drh | b7481e7 | 2006-09-16 21:45:14 +0000 | [diff] [blame] | 1918 | |
| 1919 | /* |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1920 | ** The following is the implementation of an SQL function that always |
| 1921 | ** fails with an error message stating that the function is used in the |
| 1922 | ** wrong context. The sqlite3_overload_function() API might construct |
| 1923 | ** SQL function that use this routine so that the functions will exist |
| 1924 | ** for name resolution but are actually overloaded by the xFindFunction |
| 1925 | ** method of virtual tables. |
| 1926 | */ |
| 1927 | static void sqlite3InvalidFunction( |
| 1928 | sqlite3_context *context, /* The function calling context */ |
| 1929 | int NotUsed, /* Number of arguments to the function */ |
| 1930 | sqlite3_value **NotUsed2 /* Value of each argument */ |
| 1931 | ){ |
| 1932 | const char *zName = (const char*)sqlite3_user_data(context); |
| 1933 | char *zErr; |
| 1934 | UNUSED_PARAMETER2(NotUsed, NotUsed2); |
| 1935 | zErr = sqlite3_mprintf( |
| 1936 | "unable to use function %s in the requested context", zName); |
| 1937 | sqlite3_result_error(context, zErr, -1); |
| 1938 | sqlite3_free(zErr); |
| 1939 | } |
| 1940 | |
| 1941 | /* |
drh | b7481e7 | 2006-09-16 21:45:14 +0000 | [diff] [blame] | 1942 | ** Declare that a function has been overloaded by a virtual table. |
| 1943 | ** |
| 1944 | ** If the function already exists as a regular global function, then |
| 1945 | ** this routine is a no-op. If the function does not exist, then create |
| 1946 | ** a new one that always throws a run-time error. |
| 1947 | ** |
| 1948 | ** When virtual tables intend to provide an overloaded function, they |
| 1949 | ** should call this routine to make sure the global function exists. |
| 1950 | ** A global function must exist in order for name resolution to work |
| 1951 | ** properly. |
| 1952 | */ |
| 1953 | int sqlite3_overload_function( |
| 1954 | sqlite3 *db, |
| 1955 | const char *zName, |
| 1956 | int nArg |
| 1957 | ){ |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1958 | int rc; |
| 1959 | char *zCopy; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1960 | |
| 1961 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 1962 | if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){ |
| 1963 | return SQLITE_MISUSE_BKPT; |
| 1964 | } |
| 1965 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1966 | sqlite3_mutex_enter(db->mutex); |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1967 | rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1968 | sqlite3_mutex_leave(db->mutex); |
drh | 9201184 | 2018-05-26 16:00:26 +0000 | [diff] [blame] | 1969 | if( rc ) return SQLITE_OK; |
| 1970 | zCopy = sqlite3_mprintf(zName); |
| 1971 | if( zCopy==0 ) return SQLITE_NOMEM; |
| 1972 | return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8, |
| 1973 | zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free); |
drh | b7481e7 | 2006-09-16 21:45:14 +0000 | [diff] [blame] | 1974 | } |
| 1975 | |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 1976 | #ifndef SQLITE_OMIT_TRACE |
drh | c9b84a1 | 2002-06-20 11:36:48 +0000 | [diff] [blame] | 1977 | /* |
drh | 18de482 | 2003-01-16 16:28:53 +0000 | [diff] [blame] | 1978 | ** Register a trace function. The pArg from the previously registered trace |
| 1979 | ** is returned. |
| 1980 | ** |
| 1981 | ** A NULL trace function means that no tracing is executes. A non-NULL |
| 1982 | ** trace is a pointer to a function that is invoked at the start of each |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 1983 | ** SQL statement. |
drh | 18de482 | 2003-01-16 16:28:53 +0000 | [diff] [blame] | 1984 | */ |
drh | 3d2a529 | 2016-07-13 22:55:01 +0000 | [diff] [blame] | 1985 | #ifndef SQLITE_OMIT_DEPRECATED |
drh | fca760c | 2016-07-14 01:09:08 +0000 | [diff] [blame] | 1986 | void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1987 | void *pOld; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 1988 | |
| 1989 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 1990 | if( !sqlite3SafetyCheckOk(db) ){ |
| 1991 | (void)SQLITE_MISUSE_BKPT; |
| 1992 | return 0; |
| 1993 | } |
| 1994 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 1995 | sqlite3_mutex_enter(db->mutex); |
| 1996 | pOld = db->pTraceArg; |
drh | 1637a51 | 2016-07-13 23:18:27 +0000 | [diff] [blame] | 1997 | db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0; |
drh | fca760c | 2016-07-14 01:09:08 +0000 | [diff] [blame] | 1998 | db->xTrace = (int(*)(u32,void*,void*,void*))xTrace; |
drh | 18de482 | 2003-01-16 16:28:53 +0000 | [diff] [blame] | 1999 | db->pTraceArg = pArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2000 | sqlite3_mutex_leave(db->mutex); |
drh | 18de482 | 2003-01-16 16:28:53 +0000 | [diff] [blame] | 2001 | return pOld; |
drh | 0d1a643 | 2003-04-03 15:46:04 +0000 | [diff] [blame] | 2002 | } |
drh | 3d2a529 | 2016-07-13 22:55:01 +0000 | [diff] [blame] | 2003 | #endif /* SQLITE_OMIT_DEPRECATED */ |
| 2004 | |
| 2005 | /* Register a trace callback using the version-2 interface. |
| 2006 | */ |
| 2007 | int sqlite3_trace_v2( |
drh | fca760c | 2016-07-14 01:09:08 +0000 | [diff] [blame] | 2008 | sqlite3 *db, /* Trace this connection */ |
| 2009 | unsigned mTrace, /* Mask of events to be traced */ |
| 2010 | int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */ |
| 2011 | void *pArg /* Context */ |
drh | 3d2a529 | 2016-07-13 22:55:01 +0000 | [diff] [blame] | 2012 | ){ |
| 2013 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2014 | if( !sqlite3SafetyCheckOk(db) ){ |
mistachkin | 283a85c | 2016-07-15 00:39:47 +0000 | [diff] [blame] | 2015 | return SQLITE_MISUSE_BKPT; |
drh | 3d2a529 | 2016-07-13 22:55:01 +0000 | [diff] [blame] | 2016 | } |
| 2017 | #endif |
| 2018 | sqlite3_mutex_enter(db->mutex); |
drh | fb82820 | 2016-08-25 22:06:37 +0000 | [diff] [blame] | 2019 | if( mTrace==0 ) xTrace = 0; |
| 2020 | if( xTrace==0 ) mTrace = 0; |
drh | 3d2a529 | 2016-07-13 22:55:01 +0000 | [diff] [blame] | 2021 | db->mTrace = mTrace; |
| 2022 | db->xTrace = xTrace; |
| 2023 | db->pTraceArg = pArg; |
| 2024 | sqlite3_mutex_leave(db->mutex); |
| 2025 | return SQLITE_OK; |
| 2026 | } |
| 2027 | |
drh | 087ec07 | 2016-07-25 00:05:56 +0000 | [diff] [blame] | 2028 | #ifndef SQLITE_OMIT_DEPRECATED |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 2029 | /* |
| 2030 | ** Register a profile function. The pArg from the previously registered |
| 2031 | ** profile function is returned. |
| 2032 | ** |
| 2033 | ** A NULL profile function means that no profiling is executes. A non-NULL |
| 2034 | ** profile is a pointer to a function that is invoked at the conclusion of |
| 2035 | ** each SQL statement that is run. |
| 2036 | */ |
| 2037 | void *sqlite3_profile( |
| 2038 | sqlite3 *db, |
| 2039 | void (*xProfile)(void*,const char*,sqlite_uint64), |
| 2040 | void *pArg |
| 2041 | ){ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2042 | void *pOld; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2043 | |
| 2044 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2045 | if( !sqlite3SafetyCheckOk(db) ){ |
| 2046 | (void)SQLITE_MISUSE_BKPT; |
| 2047 | return 0; |
| 2048 | } |
| 2049 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2050 | sqlite3_mutex_enter(db->mutex); |
| 2051 | pOld = db->pProfileArg; |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 2052 | db->xProfile = xProfile; |
| 2053 | db->pProfileArg = pArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2054 | sqlite3_mutex_leave(db->mutex); |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 2055 | return pOld; |
| 2056 | } |
drh | 087ec07 | 2016-07-25 00:05:56 +0000 | [diff] [blame] | 2057 | #endif /* SQLITE_OMIT_DEPRECATED */ |
drh | 19e2d37 | 2005-08-29 23:00:03 +0000 | [diff] [blame] | 2058 | #endif /* SQLITE_OMIT_TRACE */ |
paul | b0208cc | 2003-04-13 18:26:49 +0000 | [diff] [blame] | 2059 | |
drh | cd565fd | 2012-03-01 21:30:44 +0000 | [diff] [blame] | 2060 | /* |
| 2061 | ** Register a function to be invoked when a transaction commits. |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 2062 | ** If the invoked function returns non-zero, then the commit becomes a |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 2063 | ** rollback. |
| 2064 | */ |
danielk1977 | 24b03fd | 2004-05-10 10:34:34 +0000 | [diff] [blame] | 2065 | void *sqlite3_commit_hook( |
drh | 9bb575f | 2004-09-06 17:24:11 +0000 | [diff] [blame] | 2066 | sqlite3 *db, /* Attach the hook to this database */ |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 2067 | int (*xCallback)(void*), /* Function to invoke on each commit */ |
| 2068 | void *pArg /* Argument to the function */ |
| 2069 | ){ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2070 | void *pOld; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2071 | |
| 2072 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2073 | if( !sqlite3SafetyCheckOk(db) ){ |
| 2074 | (void)SQLITE_MISUSE_BKPT; |
| 2075 | return 0; |
| 2076 | } |
| 2077 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2078 | sqlite3_mutex_enter(db->mutex); |
| 2079 | pOld = db->pCommitArg; |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 2080 | db->xCommitCallback = xCallback; |
| 2081 | db->pCommitArg = pArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2082 | sqlite3_mutex_leave(db->mutex); |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 2083 | return pOld; |
| 2084 | } |
| 2085 | |
danielk1977 | 94eb6a1 | 2005-12-15 15:22:08 +0000 | [diff] [blame] | 2086 | /* |
| 2087 | ** Register a callback to be invoked each time a row is updated, |
| 2088 | ** inserted or deleted using this database connection. |
| 2089 | */ |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 2090 | void *sqlite3_update_hook( |
danielk1977 | 94eb6a1 | 2005-12-15 15:22:08 +0000 | [diff] [blame] | 2091 | sqlite3 *db, /* Attach the hook to this database */ |
| 2092 | void (*xCallback)(void*,int,char const *,char const *,sqlite_int64), |
| 2093 | void *pArg /* Argument to the function */ |
| 2094 | ){ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2095 | void *pRet; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2096 | |
| 2097 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2098 | if( !sqlite3SafetyCheckOk(db) ){ |
| 2099 | (void)SQLITE_MISUSE_BKPT; |
| 2100 | return 0; |
| 2101 | } |
| 2102 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2103 | sqlite3_mutex_enter(db->mutex); |
| 2104 | pRet = db->pUpdateArg; |
danielk1977 | 94eb6a1 | 2005-12-15 15:22:08 +0000 | [diff] [blame] | 2105 | db->xUpdateCallback = xCallback; |
| 2106 | db->pUpdateArg = pArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2107 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 2108 | return pRet; |
danielk1977 | 94eb6a1 | 2005-12-15 15:22:08 +0000 | [diff] [blame] | 2109 | } |
| 2110 | |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 2111 | /* |
| 2112 | ** Register a callback to be invoked each time a transaction is rolled |
| 2113 | ** back by this database connection. |
| 2114 | */ |
| 2115 | void *sqlite3_rollback_hook( |
| 2116 | sqlite3 *db, /* Attach the hook to this database */ |
| 2117 | void (*xCallback)(void*), /* Callback function */ |
| 2118 | void *pArg /* Argument to the function */ |
| 2119 | ){ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2120 | void *pRet; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2121 | |
| 2122 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2123 | if( !sqlite3SafetyCheckOk(db) ){ |
| 2124 | (void)SQLITE_MISUSE_BKPT; |
| 2125 | return 0; |
| 2126 | } |
| 2127 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2128 | sqlite3_mutex_enter(db->mutex); |
| 2129 | pRet = db->pRollbackArg; |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 2130 | db->xRollbackCallback = xCallback; |
| 2131 | db->pRollbackArg = pArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2132 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | 71fd80b | 2005-12-16 06:54:01 +0000 | [diff] [blame] | 2133 | return pRet; |
| 2134 | } |
drh | aa940ea | 2004-01-15 02:44:03 +0000 | [diff] [blame] | 2135 | |
drh | 9b1c62d | 2011-03-30 21:04:43 +0000 | [diff] [blame] | 2136 | #ifdef SQLITE_ENABLE_PREUPDATE_HOOK |
dan | 46c47d4 | 2011-03-01 18:42:07 +0000 | [diff] [blame] | 2137 | /* |
| 2138 | ** Register a callback to be invoked each time a row is updated, |
| 2139 | ** inserted or deleted using this database connection. |
| 2140 | */ |
| 2141 | void *sqlite3_preupdate_hook( |
| 2142 | sqlite3 *db, /* Attach the hook to this database */ |
| 2143 | void(*xCallback)( /* Callback function */ |
| 2144 | void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64), |
| 2145 | void *pArg /* First callback argument */ |
| 2146 | ){ |
| 2147 | void *pRet; |
| 2148 | sqlite3_mutex_enter(db->mutex); |
| 2149 | pRet = db->pPreUpdateArg; |
| 2150 | db->xPreUpdateCallback = xCallback; |
| 2151 | db->pPreUpdateArg = pArg; |
| 2152 | sqlite3_mutex_leave(db->mutex); |
| 2153 | return pRet; |
| 2154 | } |
drh | 9b1c62d | 2011-03-30 21:04:43 +0000 | [diff] [blame] | 2155 | #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */ |
dan | 46c47d4 | 2011-03-01 18:42:07 +0000 | [diff] [blame] | 2156 | |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2157 | #ifndef SQLITE_OMIT_WAL |
| 2158 | /* |
| 2159 | ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint(). |
drh | 5def084 | 2010-05-05 20:00:25 +0000 | [diff] [blame] | 2160 | ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file |
| 2161 | ** is greater than sqlite3.pWalArg cast to an integer (the value configured by |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2162 | ** wal_autocheckpoint()). |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2163 | */ |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2164 | int sqlite3WalDefaultHook( |
drh | 5def084 | 2010-05-05 20:00:25 +0000 | [diff] [blame] | 2165 | void *pClientData, /* Argument */ |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2166 | sqlite3 *db, /* Connection */ |
drh | 5def084 | 2010-05-05 20:00:25 +0000 | [diff] [blame] | 2167 | const char *zDb, /* Database */ |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2168 | int nFrame /* Size of WAL */ |
| 2169 | ){ |
drh | 5def084 | 2010-05-05 20:00:25 +0000 | [diff] [blame] | 2170 | if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){ |
drh | f533035 | 2010-05-24 20:27:44 +0000 | [diff] [blame] | 2171 | sqlite3BeginBenignMalloc(); |
drh | 5def084 | 2010-05-05 20:00:25 +0000 | [diff] [blame] | 2172 | sqlite3_wal_checkpoint(db, zDb); |
drh | f533035 | 2010-05-24 20:27:44 +0000 | [diff] [blame] | 2173 | sqlite3EndBenignMalloc(); |
drh | 5def084 | 2010-05-05 20:00:25 +0000 | [diff] [blame] | 2174 | } |
| 2175 | return SQLITE_OK; |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2176 | } |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2177 | #endif /* SQLITE_OMIT_WAL */ |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2178 | |
| 2179 | /* |
| 2180 | ** Configure an sqlite3_wal_hook() callback to automatically checkpoint |
| 2181 | ** a database after committing a transaction if there are nFrame or |
| 2182 | ** more frames in the log file. Passing zero or a negative value as the |
| 2183 | ** nFrame parameter disables automatic checkpoints entirely. |
| 2184 | ** |
| 2185 | ** The callback registered by this function replaces any existing callback |
| 2186 | ** registered using sqlite3_wal_hook(). Likewise, registering a callback |
| 2187 | ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism |
| 2188 | ** configured by this function. |
| 2189 | */ |
| 2190 | int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){ |
shaneh | bd2aaf9 | 2010-09-01 02:38:21 +0000 | [diff] [blame] | 2191 | #ifdef SQLITE_OMIT_WAL |
drh | 9dd55f5 | 2010-09-03 03:32:46 +0000 | [diff] [blame] | 2192 | UNUSED_PARAMETER(db); |
| 2193 | UNUSED_PARAMETER(nFrame); |
shaneh | bd2aaf9 | 2010-09-01 02:38:21 +0000 | [diff] [blame] | 2194 | #else |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2195 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2196 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 2197 | #endif |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2198 | if( nFrame>0 ){ |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2199 | sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame)); |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2200 | }else{ |
| 2201 | sqlite3_wal_hook(db, 0, 0); |
| 2202 | } |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2203 | #endif |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2204 | return SQLITE_OK; |
| 2205 | } |
| 2206 | |
paul | b0208cc | 2003-04-13 18:26:49 +0000 | [diff] [blame] | 2207 | /* |
dan | 8d22a17 | 2010-04-19 18:03:51 +0000 | [diff] [blame] | 2208 | ** Register a callback to be invoked each time a transaction is written |
| 2209 | ** into the write-ahead-log by this database connection. |
| 2210 | */ |
drh | 833bf96 | 2010-04-28 14:42:19 +0000 | [diff] [blame] | 2211 | void *sqlite3_wal_hook( |
dan | 8d22a17 | 2010-04-19 18:03:51 +0000 | [diff] [blame] | 2212 | sqlite3 *db, /* Attach the hook to this db handle */ |
| 2213 | int(*xCallback)(void *, sqlite3*, const char*, int), |
| 2214 | void *pArg /* First argument passed to xCallback() */ |
| 2215 | ){ |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2216 | #ifndef SQLITE_OMIT_WAL |
dan | 8d22a17 | 2010-04-19 18:03:51 +0000 | [diff] [blame] | 2217 | void *pRet; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2218 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2219 | if( !sqlite3SafetyCheckOk(db) ){ |
| 2220 | (void)SQLITE_MISUSE_BKPT; |
| 2221 | return 0; |
| 2222 | } |
| 2223 | #endif |
dan | 8d22a17 | 2010-04-19 18:03:51 +0000 | [diff] [blame] | 2224 | sqlite3_mutex_enter(db->mutex); |
drh | 7ed91f2 | 2010-04-29 22:34:07 +0000 | [diff] [blame] | 2225 | pRet = db->pWalArg; |
| 2226 | db->xWalCallback = xCallback; |
| 2227 | db->pWalArg = pArg; |
dan | 8d22a17 | 2010-04-19 18:03:51 +0000 | [diff] [blame] | 2228 | sqlite3_mutex_leave(db->mutex); |
| 2229 | return pRet; |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2230 | #else |
| 2231 | return 0; |
| 2232 | #endif |
dan | 8d22a17 | 2010-04-19 18:03:51 +0000 | [diff] [blame] | 2233 | } |
| 2234 | |
| 2235 | /* |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2236 | ** Checkpoint database zDb. |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2237 | */ |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2238 | int sqlite3_wal_checkpoint_v2( |
| 2239 | sqlite3 *db, /* Database handle */ |
| 2240 | const char *zDb, /* Name of attached database (or NULL) */ |
| 2241 | int eMode, /* SQLITE_CHECKPOINT_* value */ |
| 2242 | int *pnLog, /* OUT: Size of WAL log in frames */ |
| 2243 | int *pnCkpt /* OUT: Total number of frames checkpointed */ |
| 2244 | ){ |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2245 | #ifdef SQLITE_OMIT_WAL |
| 2246 | return SQLITE_OK; |
| 2247 | #else |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2248 | int rc; /* Return code */ |
dan | 6fcff07 | 2010-05-03 14:05:43 +0000 | [diff] [blame] | 2249 | int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */ |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2250 | |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2251 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2252 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 2253 | #endif |
| 2254 | |
dan | 9c5e368 | 2011-02-07 15:12:12 +0000 | [diff] [blame] | 2255 | /* Initialize the output variables to -1 in case an error occurs. */ |
| 2256 | if( pnLog ) *pnLog = -1; |
| 2257 | if( pnCkpt ) *pnCkpt = -1; |
| 2258 | |
dan | f26a154 | 2014-12-02 19:04:54 +0000 | [diff] [blame] | 2259 | assert( SQLITE_CHECKPOINT_PASSIVE==0 ); |
| 2260 | assert( SQLITE_CHECKPOINT_FULL==1 ); |
| 2261 | assert( SQLITE_CHECKPOINT_RESTART==2 ); |
| 2262 | assert( SQLITE_CHECKPOINT_TRUNCATE==3 ); |
| 2263 | if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){ |
drh | bb9a378 | 2014-12-03 18:32:47 +0000 | [diff] [blame] | 2264 | /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint |
| 2265 | ** mode: */ |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2266 | return SQLITE_MISUSE; |
| 2267 | } |
| 2268 | |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2269 | sqlite3_mutex_enter(db->mutex); |
dan | af0cfd3 | 2010-05-03 15:58:50 +0000 | [diff] [blame] | 2270 | if( zDb && zDb[0] ){ |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2271 | iDb = sqlite3FindDbName(db, zDb); |
| 2272 | } |
| 2273 | if( iDb<0 ){ |
| 2274 | rc = SQLITE_ERROR; |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 2275 | sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb); |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2276 | }else{ |
dan | 976b003 | 2015-01-29 19:12:12 +0000 | [diff] [blame] | 2277 | db->busyHandler.nBusy = 0; |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2278 | rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt); |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 2279 | sqlite3Error(db, rc); |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2280 | } |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2281 | rc = sqlite3ApiExit(db, rc); |
dan | 7fb8990 | 2016-08-12 16:21:15 +0000 | [diff] [blame] | 2282 | |
| 2283 | /* If there are no active statements, clear the interrupt flag at this |
| 2284 | ** point. */ |
| 2285 | if( db->nVdbeActive==0 ){ |
| 2286 | db->u1.isInterrupted = 0; |
| 2287 | } |
| 2288 | |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2289 | sqlite3_mutex_leave(db->mutex); |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2290 | return rc; |
| 2291 | #endif |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2292 | } |
| 2293 | |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2294 | |
| 2295 | /* |
| 2296 | ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points |
| 2297 | ** to contains a zero-length string, all attached databases are |
| 2298 | ** checkpointed. |
| 2299 | */ |
| 2300 | int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){ |
drh | bb9a378 | 2014-12-03 18:32:47 +0000 | [diff] [blame] | 2301 | /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to |
| 2302 | ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */ |
| 2303 | return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0); |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2304 | } |
| 2305 | |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2306 | #ifndef SQLITE_OMIT_WAL |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2307 | /* |
| 2308 | ** Run a checkpoint on database iDb. This is a no-op if database iDb is |
| 2309 | ** not currently open in WAL mode. |
| 2310 | ** |
dan | 6fcff07 | 2010-05-03 14:05:43 +0000 | [diff] [blame] | 2311 | ** If a transaction is open on the database being checkpointed, this |
| 2312 | ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If |
| 2313 | ** an error occurs while running the checkpoint, an SQLite error code is |
| 2314 | ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK. |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2315 | ** |
| 2316 | ** The mutex on database handle db should be held by the caller. The mutex |
| 2317 | ** associated with the specific b-tree being checkpointed is taken by |
| 2318 | ** this function while the checkpoint is running. |
dan | 6fcff07 | 2010-05-03 14:05:43 +0000 | [diff] [blame] | 2319 | ** |
| 2320 | ** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are |
| 2321 | ** checkpointed. If an error is encountered it is returned immediately - |
| 2322 | ** no attempt is made to checkpoint any remaining databases. |
dan | a58f26f | 2010-11-16 18:56:51 +0000 | [diff] [blame] | 2323 | ** |
dan | 7834551 | 2017-09-08 17:48:00 +0000 | [diff] [blame] | 2324 | ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART |
| 2325 | ** or TRUNCATE. |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2326 | */ |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2327 | int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){ |
dan | 6fcff07 | 2010-05-03 14:05:43 +0000 | [diff] [blame] | 2328 | int rc = SQLITE_OK; /* Return code */ |
| 2329 | int i; /* Used to iterate through attached dbs */ |
dan | f2b8dd5 | 2010-11-18 19:28:01 +0000 | [diff] [blame] | 2330 | int bBusy = 0; /* True if SQLITE_BUSY has been encountered */ |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2331 | |
| 2332 | assert( sqlite3_mutex_held(db->mutex) ); |
dan | 9c5e368 | 2011-02-07 15:12:12 +0000 | [diff] [blame] | 2333 | assert( !pnLog || *pnLog==-1 ); |
| 2334 | assert( !pnCkpt || *pnCkpt==-1 ); |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2335 | |
dan | 6fcff07 | 2010-05-03 14:05:43 +0000 | [diff] [blame] | 2336 | for(i=0; i<db->nDb && rc==SQLITE_OK; i++){ |
| 2337 | if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){ |
dan | cdc1f04 | 2010-11-18 12:11:05 +0000 | [diff] [blame] | 2338 | rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt); |
dan | f2b8dd5 | 2010-11-18 19:28:01 +0000 | [diff] [blame] | 2339 | pnLog = 0; |
| 2340 | pnCkpt = 0; |
| 2341 | if( rc==SQLITE_BUSY ){ |
| 2342 | bBusy = 1; |
| 2343 | rc = SQLITE_OK; |
| 2344 | } |
dan | 6fcff07 | 2010-05-03 14:05:43 +0000 | [diff] [blame] | 2345 | } |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2346 | } |
| 2347 | |
dan | f2b8dd5 | 2010-11-18 19:28:01 +0000 | [diff] [blame] | 2348 | return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc; |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2349 | } |
drh | b033d8b | 2010-05-03 13:37:30 +0000 | [diff] [blame] | 2350 | #endif /* SQLITE_OMIT_WAL */ |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 2351 | |
| 2352 | /* |
danielk1977 | d829335 | 2009-04-30 09:10:37 +0000 | [diff] [blame] | 2353 | ** This function returns true if main-memory should be used instead of |
| 2354 | ** a temporary file for transient pager files and statement journals. |
| 2355 | ** The value returned depends on the value of db->temp_store (runtime |
| 2356 | ** parameter) and the compile time value of SQLITE_TEMP_STORE. The |
| 2357 | ** following table describes the relationship between these two values |
| 2358 | ** and this functions return value. |
| 2359 | ** |
| 2360 | ** SQLITE_TEMP_STORE db->temp_store Location of temporary database |
| 2361 | ** ----------------- -------------- ------------------------------ |
| 2362 | ** 0 any file (return 0) |
| 2363 | ** 1 1 file (return 0) |
| 2364 | ** 1 2 memory (return 1) |
| 2365 | ** 1 0 file (return 0) |
| 2366 | ** 2 1 file (return 0) |
| 2367 | ** 2 2 memory (return 1) |
| 2368 | ** 2 0 memory (return 1) |
| 2369 | ** 3 any memory (return 1) |
| 2370 | */ |
drh | 1c51414 | 2009-04-30 12:25:10 +0000 | [diff] [blame] | 2371 | int sqlite3TempInMemory(const sqlite3 *db){ |
danielk1977 | d829335 | 2009-04-30 09:10:37 +0000 | [diff] [blame] | 2372 | #if SQLITE_TEMP_STORE==1 |
| 2373 | return ( db->temp_store==2 ); |
| 2374 | #endif |
| 2375 | #if SQLITE_TEMP_STORE==2 |
| 2376 | return ( db->temp_store!=1 ); |
| 2377 | #endif |
| 2378 | #if SQLITE_TEMP_STORE==3 |
drh | f5ed7ad | 2015-06-15 14:43:25 +0000 | [diff] [blame] | 2379 | UNUSED_PARAMETER(db); |
danielk1977 | d829335 | 2009-04-30 09:10:37 +0000 | [diff] [blame] | 2380 | return 1; |
shane | cf69739 | 2009-06-01 16:53:09 +0000 | [diff] [blame] | 2381 | #endif |
| 2382 | #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3 |
drh | f5ed7ad | 2015-06-15 14:43:25 +0000 | [diff] [blame] | 2383 | UNUSED_PARAMETER(db); |
danielk1977 | d829335 | 2009-04-30 09:10:37 +0000 | [diff] [blame] | 2384 | return 0; |
shane | 60a4b53 | 2009-05-06 18:57:09 +0000 | [diff] [blame] | 2385 | #endif |
danielk1977 | d829335 | 2009-04-30 09:10:37 +0000 | [diff] [blame] | 2386 | } |
| 2387 | |
| 2388 | /* |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2389 | ** Return UTF-8 encoded English language explanation of the most recent |
| 2390 | ** error. |
| 2391 | */ |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2392 | const char *sqlite3_errmsg(sqlite3 *db){ |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2393 | const char *z; |
drh | f49661a | 2008-12-10 16:45:50 +0000 | [diff] [blame] | 2394 | if( !db ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2395 | return sqlite3ErrStr(SQLITE_NOMEM_BKPT); |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2396 | } |
drh | d55d57e | 2008-07-07 17:53:07 +0000 | [diff] [blame] | 2397 | if( !sqlite3SafetyCheckSickOrOk(db) ){ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 2398 | return sqlite3ErrStr(SQLITE_MISUSE_BKPT); |
danielk1977 | e35ee19 | 2004-06-26 09:50:11 +0000 | [diff] [blame] | 2399 | } |
drh | 2764170 | 2007-08-22 02:56:42 +0000 | [diff] [blame] | 2400 | sqlite3_mutex_enter(db->mutex); |
danielk1977 | 238746a | 2009-03-19 18:51:06 +0000 | [diff] [blame] | 2401 | if( db->mallocFailed ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2402 | z = sqlite3ErrStr(SQLITE_NOMEM_BKPT); |
danielk1977 | 238746a | 2009-03-19 18:51:06 +0000 | [diff] [blame] | 2403 | }else{ |
drh | a3cc007 | 2013-12-13 16:23:55 +0000 | [diff] [blame] | 2404 | testcase( db->pErr==0 ); |
danielk1977 | 238746a | 2009-03-19 18:51:06 +0000 | [diff] [blame] | 2405 | z = (char*)sqlite3_value_text(db->pErr); |
| 2406 | assert( !db->mallocFailed ); |
| 2407 | if( z==0 ){ |
| 2408 | z = sqlite3ErrStr(db->errCode); |
| 2409 | } |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2410 | } |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2411 | sqlite3_mutex_leave(db->mutex); |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2412 | return z; |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2413 | } |
| 2414 | |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 2415 | #ifndef SQLITE_OMIT_UTF16 |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2416 | /* |
| 2417 | ** Return UTF-16 encoded English language explanation of the most recent |
| 2418 | ** error. |
| 2419 | */ |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2420 | const void *sqlite3_errmsg16(sqlite3 *db){ |
danielk1977 | 7c5c3ca | 2009-02-23 14:42:53 +0000 | [diff] [blame] | 2421 | static const u16 outOfMem[] = { |
| 2422 | 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0 |
danielk1977 | bfd6cce | 2004-06-18 04:24:54 +0000 | [diff] [blame] | 2423 | }; |
danielk1977 | 7c5c3ca | 2009-02-23 14:42:53 +0000 | [diff] [blame] | 2424 | static const u16 misuse[] = { |
drh | ff4fa77 | 2017-07-10 12:07:53 +0000 | [diff] [blame] | 2425 | 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ', |
| 2426 | 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ', |
| 2427 | 'm', 'i', 's', 'u', 's', 'e', 0 |
danielk1977 | e35ee19 | 2004-06-26 09:50:11 +0000 | [diff] [blame] | 2428 | }; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2429 | |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2430 | const void *z; |
danielk1977 | ae7fc49 | 2007-03-29 15:00:52 +0000 | [diff] [blame] | 2431 | if( !db ){ |
danielk1977 | 7c5c3ca | 2009-02-23 14:42:53 +0000 | [diff] [blame] | 2432 | return (void *)outOfMem; |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2433 | } |
drh | d55d57e | 2008-07-07 17:53:07 +0000 | [diff] [blame] | 2434 | if( !sqlite3SafetyCheckSickOrOk(db) ){ |
danielk1977 | 7c5c3ca | 2009-02-23 14:42:53 +0000 | [diff] [blame] | 2435 | return (void *)misuse; |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2436 | } |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2437 | sqlite3_mutex_enter(db->mutex); |
danielk1977 | 238746a | 2009-03-19 18:51:06 +0000 | [diff] [blame] | 2438 | if( db->mallocFailed ){ |
| 2439 | z = (void *)outOfMem; |
| 2440 | }else{ |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2441 | z = sqlite3_value_text16(db->pErr); |
danielk1977 | 238746a | 2009-03-19 18:51:06 +0000 | [diff] [blame] | 2442 | if( z==0 ){ |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 2443 | sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode)); |
danielk1977 | 238746a | 2009-03-19 18:51:06 +0000 | [diff] [blame] | 2444 | z = sqlite3_value_text16(db->pErr); |
| 2445 | } |
| 2446 | /* A malloc() may have failed within the call to sqlite3_value_text16() |
| 2447 | ** above. If this is the case, then the db->mallocFailed flag needs to |
| 2448 | ** be cleared before returning. Do this directly, instead of via |
| 2449 | ** sqlite3ApiExit(), to avoid setting the database handle error message. |
| 2450 | */ |
drh | 4a642b6 | 2016-02-05 01:55:27 +0000 | [diff] [blame] | 2451 | sqlite3OomClear(db); |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2452 | } |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2453 | sqlite3_mutex_leave(db->mutex); |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2454 | return z; |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2455 | } |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 2456 | #endif /* SQLITE_OMIT_UTF16 */ |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2457 | |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2458 | /* |
danielk1977 | 7ddad96 | 2005-12-12 06:53:03 +0000 | [diff] [blame] | 2459 | ** Return the most recent error code generated by an SQLite routine. If NULL is |
| 2460 | ** passed to this function, we assume a malloc() failed during sqlite3_open(). |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2461 | */ |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2462 | int sqlite3_errcode(sqlite3 *db){ |
danielk1977 | 7c36d07 | 2008-01-31 15:31:01 +0000 | [diff] [blame] | 2463 | if( db && !sqlite3SafetyCheckSickOrOk(db) ){ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 2464 | return SQLITE_MISUSE_BKPT; |
drh | c60d044 | 2004-09-30 13:43:13 +0000 | [diff] [blame] | 2465 | } |
drh | 01495b9 | 2008-01-23 12:52:40 +0000 | [diff] [blame] | 2466 | if( !db || db->mallocFailed ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2467 | return SQLITE_NOMEM_BKPT; |
drh | 01495b9 | 2008-01-23 12:52:40 +0000 | [diff] [blame] | 2468 | } |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 2469 | return db->errCode & db->errMask; |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2470 | } |
drh | 99dfe5e | 2008-10-30 15:03:15 +0000 | [diff] [blame] | 2471 | int sqlite3_extended_errcode(sqlite3 *db){ |
| 2472 | if( db && !sqlite3SafetyCheckSickOrOk(db) ){ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 2473 | return SQLITE_MISUSE_BKPT; |
drh | 99dfe5e | 2008-10-30 15:03:15 +0000 | [diff] [blame] | 2474 | } |
| 2475 | if( !db || db->mallocFailed ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2476 | return SQLITE_NOMEM_BKPT; |
drh | 99dfe5e | 2008-10-30 15:03:15 +0000 | [diff] [blame] | 2477 | } |
| 2478 | return db->errCode; |
| 2479 | } |
drh | 1b9f214 | 2016-03-17 16:01:23 +0000 | [diff] [blame] | 2480 | int sqlite3_system_errno(sqlite3 *db){ |
| 2481 | return db ? db->iSysErrno : 0; |
| 2482 | } |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2483 | |
drh | 0e819f9 | 2006-02-01 13:50:41 +0000 | [diff] [blame] | 2484 | /* |
mistachkin | 5dac843 | 2012-09-11 02:00:25 +0000 | [diff] [blame] | 2485 | ** Return a string that describes the kind of error specified in the |
| 2486 | ** argument. For now, this simply calls the internal sqlite3ErrStr() |
| 2487 | ** function. |
| 2488 | */ |
| 2489 | const char *sqlite3_errstr(int rc){ |
| 2490 | return sqlite3ErrStr(rc); |
| 2491 | } |
| 2492 | |
| 2493 | /* |
drh | 0e819f9 | 2006-02-01 13:50:41 +0000 | [diff] [blame] | 2494 | ** Create a new collating function for database "db". The name is zName |
| 2495 | ** and the encoding is enc. |
| 2496 | */ |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2497 | static int createCollation( |
drh | f8d4e8b | 2009-08-20 02:49:30 +0000 | [diff] [blame] | 2498 | sqlite3* db, |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2499 | const char *zName, |
shane | cea72b2 | 2009-09-07 04:38:36 +0000 | [diff] [blame] | 2500 | u8 enc, |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2501 | void* pCtx, |
danielk1977 | a9808b3 | 2007-05-07 09:32:45 +0000 | [diff] [blame] | 2502 | int(*xCompare)(void*,int,const void*,int,const void*), |
| 2503 | void(*xDel)(void*) |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2504 | ){ |
| 2505 | CollSeq *pColl; |
drh | 7d9bd4e | 2006-02-16 18:16:36 +0000 | [diff] [blame] | 2506 | int enc2; |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2507 | |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 2508 | assert( sqlite3_mutex_held(db->mutex) ); |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2509 | |
| 2510 | /* If SQLITE_UTF16 is specified as the encoding type, transform this |
| 2511 | ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the |
| 2512 | ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally. |
| 2513 | */ |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 2514 | enc2 = enc; |
danielk1977 | ebb3293 | 2009-04-28 15:35:38 +0000 | [diff] [blame] | 2515 | testcase( enc2==SQLITE_UTF16 ); |
| 2516 | testcase( enc2==SQLITE_UTF16_ALIGNED ); |
| 2517 | if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){ |
drh | 7d9bd4e | 2006-02-16 18:16:36 +0000 | [diff] [blame] | 2518 | enc2 = SQLITE_UTF16NATIVE; |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2519 | } |
drh | 51c7d86 | 2009-04-27 18:46:06 +0000 | [diff] [blame] | 2520 | if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){ |
drh | 413c3d3 | 2010-02-23 20:11:56 +0000 | [diff] [blame] | 2521 | return SQLITE_MISUSE_BKPT; |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2522 | } |
| 2523 | |
| 2524 | /* Check if this call is removing or replacing an existing collation |
| 2525 | ** sequence. If so, and there are active VMs, return busy. If there |
| 2526 | ** are no active VMs, invalidate any pre-compiled statements. |
| 2527 | */ |
drh | c4a64fa | 2009-05-11 20:53:28 +0000 | [diff] [blame] | 2528 | pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0); |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2529 | if( pColl && pColl->xCmp ){ |
drh | 4f7d3a5 | 2013-06-27 23:54:02 +0000 | [diff] [blame] | 2530 | if( db->nVdbeActive ){ |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 2531 | sqlite3ErrorWithMsg(db, SQLITE_BUSY, |
drh | b309bec | 2009-02-04 17:40:57 +0000 | [diff] [blame] | 2532 | "unable to delete/modify collation sequence due to active statements"); |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2533 | return SQLITE_BUSY; |
| 2534 | } |
drh | ba968db | 2018-07-24 22:02:12 +0000 | [diff] [blame] | 2535 | sqlite3ExpirePreparedStatements(db, 0); |
danielk1977 | a9808b3 | 2007-05-07 09:32:45 +0000 | [diff] [blame] | 2536 | |
| 2537 | /* If collation sequence pColl was created directly by a call to |
| 2538 | ** sqlite3_create_collation, and not generated by synthCollSeq(), |
| 2539 | ** then any copies made by synthCollSeq() need to be invalidated. |
| 2540 | ** Also, collation destructor - CollSeq.xDel() - function may need |
| 2541 | ** to be called. |
| 2542 | */ |
| 2543 | if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){ |
drh | acbcb7e | 2014-08-21 20:26:37 +0000 | [diff] [blame] | 2544 | CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName); |
danielk1977 | a9808b3 | 2007-05-07 09:32:45 +0000 | [diff] [blame] | 2545 | int j; |
| 2546 | for(j=0; j<3; j++){ |
| 2547 | CollSeq *p = &aColl[j]; |
| 2548 | if( p->enc==pColl->enc ){ |
| 2549 | if( p->xDel ){ |
| 2550 | p->xDel(p->pUser); |
| 2551 | } |
| 2552 | p->xCmp = 0; |
| 2553 | } |
| 2554 | } |
| 2555 | } |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2556 | } |
| 2557 | |
drh | c4a64fa | 2009-05-11 20:53:28 +0000 | [diff] [blame] | 2558 | pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1); |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2559 | if( pColl==0 ) return SQLITE_NOMEM_BKPT; |
drh | 88404c2 | 2010-10-11 17:58:21 +0000 | [diff] [blame] | 2560 | pColl->xCmp = xCompare; |
| 2561 | pColl->pUser = pCtx; |
| 2562 | pColl->xDel = xDel; |
| 2563 | pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED)); |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 2564 | sqlite3Error(db, SQLITE_OK); |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 2565 | return SQLITE_OK; |
| 2566 | } |
| 2567 | |
| 2568 | |
danielk1977 | 6622cce | 2004-05-20 11:00:52 +0000 | [diff] [blame] | 2569 | /* |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2570 | ** This array defines hard upper bounds on limit values. The |
| 2571 | ** initializer must be kept in sync with the SQLITE_LIMIT_* |
| 2572 | ** #defines in sqlite3.h. |
| 2573 | */ |
drh | b1a6c3c | 2008-03-20 16:30:17 +0000 | [diff] [blame] | 2574 | static const int aHardLimit[] = { |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2575 | SQLITE_MAX_LENGTH, |
| 2576 | SQLITE_MAX_SQL_LENGTH, |
| 2577 | SQLITE_MAX_COLUMN, |
| 2578 | SQLITE_MAX_EXPR_DEPTH, |
| 2579 | SQLITE_MAX_COMPOUND_SELECT, |
| 2580 | SQLITE_MAX_VDBE_OP, |
| 2581 | SQLITE_MAX_FUNCTION_ARG, |
| 2582 | SQLITE_MAX_ATTACHED, |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2583 | SQLITE_MAX_LIKE_PATTERN_LENGTH, |
drh | 9f959b0 | 2014-08-11 17:37:27 +0000 | [diff] [blame] | 2584 | SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */ |
drh | 417168a | 2009-09-07 18:14:02 +0000 | [diff] [blame] | 2585 | SQLITE_MAX_TRIGGER_DEPTH, |
drh | 111544c | 2014-08-29 16:20:47 +0000 | [diff] [blame] | 2586 | SQLITE_MAX_WORKER_THREADS, |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2587 | }; |
| 2588 | |
| 2589 | /* |
| 2590 | ** Make sure the hard limits are set to reasonable values |
| 2591 | */ |
| 2592 | #if SQLITE_MAX_LENGTH<100 |
| 2593 | # error SQLITE_MAX_LENGTH must be at least 100 |
| 2594 | #endif |
| 2595 | #if SQLITE_MAX_SQL_LENGTH<100 |
| 2596 | # error SQLITE_MAX_SQL_LENGTH must be at least 100 |
| 2597 | #endif |
| 2598 | #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH |
| 2599 | # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH |
| 2600 | #endif |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2601 | #if SQLITE_MAX_COMPOUND_SELECT<2 |
| 2602 | # error SQLITE_MAX_COMPOUND_SELECT must be at least 2 |
| 2603 | #endif |
| 2604 | #if SQLITE_MAX_VDBE_OP<40 |
| 2605 | # error SQLITE_MAX_VDBE_OP must be at least 40 |
| 2606 | #endif |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 2607 | #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127 |
| 2608 | # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127 |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2609 | #endif |
drh | d08b279 | 2014-07-22 15:33:31 +0000 | [diff] [blame] | 2610 | #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125 |
| 2611 | # error SQLITE_MAX_ATTACHED must be between 0 and 125 |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2612 | #endif |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2613 | #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1 |
| 2614 | # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1 |
| 2615 | #endif |
drh | 70a8ca3 | 2008-08-21 18:49:27 +0000 | [diff] [blame] | 2616 | #if SQLITE_MAX_COLUMN>32767 |
| 2617 | # error SQLITE_MAX_COLUMN must not exceed 32767 |
| 2618 | #endif |
drh | 417168a | 2009-09-07 18:14:02 +0000 | [diff] [blame] | 2619 | #if SQLITE_MAX_TRIGGER_DEPTH<1 |
| 2620 | # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1 |
| 2621 | #endif |
drh | 111544c | 2014-08-29 16:20:47 +0000 | [diff] [blame] | 2622 | #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50 |
| 2623 | # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50 |
| 2624 | #endif |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2625 | |
| 2626 | |
| 2627 | /* |
| 2628 | ** Change the value of a limit. Report the old value. |
| 2629 | ** If an invalid limit index is supplied, report -1. |
| 2630 | ** Make no changes but still report the old value if the |
| 2631 | ** new limit is negative. |
| 2632 | ** |
| 2633 | ** A new lower limit does not shrink existing constructs. |
| 2634 | ** It merely prevents new constructs that exceed the limit |
| 2635 | ** from forming. |
| 2636 | */ |
| 2637 | int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){ |
| 2638 | int oldLimit; |
drh | 4e93f5b | 2010-09-07 14:59:15 +0000 | [diff] [blame] | 2639 | |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2640 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2641 | if( !sqlite3SafetyCheckOk(db) ){ |
| 2642 | (void)SQLITE_MISUSE_BKPT; |
| 2643 | return -1; |
| 2644 | } |
| 2645 | #endif |
drh | 4e93f5b | 2010-09-07 14:59:15 +0000 | [diff] [blame] | 2646 | |
| 2647 | /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME |
| 2648 | ** there is a hard upper bound set at compile-time by a C preprocessor |
| 2649 | ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to |
| 2650 | ** "_MAX_".) |
| 2651 | */ |
| 2652 | assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH ); |
| 2653 | assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH ); |
| 2654 | assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN ); |
| 2655 | assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH ); |
| 2656 | assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT); |
| 2657 | assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP ); |
| 2658 | assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG ); |
| 2659 | assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED ); |
| 2660 | assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]== |
| 2661 | SQLITE_MAX_LIKE_PATTERN_LENGTH ); |
| 2662 | assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER); |
| 2663 | assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH ); |
drh | 111544c | 2014-08-29 16:20:47 +0000 | [diff] [blame] | 2664 | assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS ); |
| 2665 | assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) ); |
drh | 4e93f5b | 2010-09-07 14:59:15 +0000 | [diff] [blame] | 2666 | |
| 2667 | |
drh | 521cc84 | 2008-04-15 02:36:33 +0000 | [diff] [blame] | 2668 | if( limitId<0 || limitId>=SQLITE_N_LIMIT ){ |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2669 | return -1; |
| 2670 | } |
| 2671 | oldLimit = db->aLimit[limitId]; |
drh | 4e93f5b | 2010-09-07 14:59:15 +0000 | [diff] [blame] | 2672 | if( newLimit>=0 ){ /* IMP: R-52476-28732 */ |
drh | f47ce56 | 2008-03-20 18:00:49 +0000 | [diff] [blame] | 2673 | if( newLimit>aHardLimit[limitId] ){ |
drh | 4e93f5b | 2010-09-07 14:59:15 +0000 | [diff] [blame] | 2674 | newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */ |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2675 | } |
| 2676 | db->aLimit[limitId] = newLimit; |
| 2677 | } |
drh | 4e93f5b | 2010-09-07 14:59:15 +0000 | [diff] [blame] | 2678 | return oldLimit; /* IMP: R-53341-35419 */ |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 2679 | } |
| 2680 | |
| 2681 | /* |
dan | 286ab7c | 2011-05-06 18:34:54 +0000 | [diff] [blame] | 2682 | ** This function is used to parse both URIs and non-URI filenames passed by the |
| 2683 | ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database |
| 2684 | ** URIs specified as part of ATTACH statements. |
| 2685 | ** |
| 2686 | ** The first argument to this function is the name of the VFS to use (or |
| 2687 | ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx" |
| 2688 | ** query parameter. The second argument contains the URI (or non-URI filename) |
| 2689 | ** itself. When this function is called the *pFlags variable should contain |
| 2690 | ** the default flags to open the database handle with. The value stored in |
| 2691 | ** *pFlags may be updated before returning if the URI filename contains |
| 2692 | ** "cache=xxx" or "mode=xxx" query parameters. |
| 2693 | ** |
| 2694 | ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to |
| 2695 | ** the VFS that should be used to open the database file. *pzFile is set to |
| 2696 | ** point to a buffer containing the name of the file to open. It is the |
| 2697 | ** responsibility of the caller to eventually call sqlite3_free() to release |
| 2698 | ** this buffer. |
| 2699 | ** |
| 2700 | ** If an error occurs, then an SQLite error code is returned and *pzErrMsg |
| 2701 | ** may be set to point to a buffer containing an English language error |
| 2702 | ** message. It is the responsibility of the caller to eventually release |
| 2703 | ** this buffer by calling sqlite3_free(). |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2704 | */ |
| 2705 | int sqlite3ParseUri( |
| 2706 | const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */ |
| 2707 | const char *zUri, /* Nul-terminated URI to parse */ |
drh | 522c26f | 2011-05-07 14:40:29 +0000 | [diff] [blame] | 2708 | unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2709 | sqlite3_vfs **ppVfs, /* OUT: VFS to use */ |
| 2710 | char **pzFile, /* OUT: Filename component of URI */ |
| 2711 | char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */ |
| 2712 | ){ |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2713 | int rc = SQLITE_OK; |
drh | 522c26f | 2011-05-07 14:40:29 +0000 | [diff] [blame] | 2714 | unsigned int flags = *pFlags; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2715 | const char *zVfs = zDefaultVfs; |
| 2716 | char *zFile; |
drh | de941c3 | 2011-05-09 19:20:17 +0000 | [diff] [blame] | 2717 | char c; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2718 | int nUri = sqlite3Strlen30(zUri); |
| 2719 | |
| 2720 | assert( *pzErrMsg==0 ); |
| 2721 | |
drh | 8790b6e | 2014-11-07 01:43:56 +0000 | [diff] [blame] | 2722 | if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */ |
| 2723 | || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */ |
drh | 00729cb | 2014-10-04 11:59:33 +0000 | [diff] [blame] | 2724 | && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2725 | ){ |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2726 | char *zOpt; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2727 | int eState; /* Parser state when parsing URI */ |
| 2728 | int iIn; /* Input character index */ |
| 2729 | int iOut = 0; /* Output character index */ |
drh | f3cdcdc | 2015-04-29 16:50:28 +0000 | [diff] [blame] | 2730 | u64 nByte = nUri+2; /* Bytes of space to allocate */ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2731 | |
dan | 286ab7c | 2011-05-06 18:34:54 +0000 | [diff] [blame] | 2732 | /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen |
| 2733 | ** method that there may be extra parameters following the file-name. */ |
| 2734 | flags |= SQLITE_OPEN_URI; |
| 2735 | |
| 2736 | for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&'); |
drh | f3cdcdc | 2015-04-29 16:50:28 +0000 | [diff] [blame] | 2737 | zFile = sqlite3_malloc64(nByte); |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2738 | if( !zFile ) return SQLITE_NOMEM_BKPT; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2739 | |
drh | 869c040 | 2013-08-07 23:15:52 +0000 | [diff] [blame] | 2740 | iIn = 5; |
drh | 4a4b138 | 2015-03-03 16:58:56 +0000 | [diff] [blame] | 2741 | #ifdef SQLITE_ALLOW_URI_AUTHORITY |
| 2742 | if( strncmp(zUri+5, "///", 3)==0 ){ |
| 2743 | iIn = 7; |
| 2744 | /* The following condition causes URIs with five leading / characters |
| 2745 | ** like file://///host/path to be converted into UNCs like //host/path. |
| 2746 | ** The correct URI for that UNC has only two or four leading / characters |
| 2747 | ** file://host/path or file:////host/path. But 5 leading slashes is a |
| 2748 | ** common error, we are told, so we handle it as a special case. */ |
| 2749 | if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; } |
| 2750 | }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){ |
| 2751 | iIn = 16; |
| 2752 | } |
| 2753 | #else |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2754 | /* Discard the scheme and authority segments of the URI. */ |
| 2755 | if( zUri[5]=='/' && zUri[6]=='/' ){ |
| 2756 | iIn = 7; |
| 2757 | while( zUri[iIn] && zUri[iIn]!='/' ) iIn++; |
dan | 3b18a9a | 2011-05-03 11:53:20 +0000 | [diff] [blame] | 2758 | if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){ |
| 2759 | *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s", |
| 2760 | iIn-7, &zUri[7]); |
| 2761 | rc = SQLITE_ERROR; |
| 2762 | goto parse_uri_out; |
| 2763 | } |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2764 | } |
drh | 869c040 | 2013-08-07 23:15:52 +0000 | [diff] [blame] | 2765 | #endif |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2766 | |
| 2767 | /* Copy the filename and any query parameters into the zFile buffer. |
| 2768 | ** Decode %HH escape codes along the way. |
| 2769 | ** |
| 2770 | ** Within this loop, variable eState may be set to 0, 1 or 2, depending |
| 2771 | ** on the parsing context. As follows: |
| 2772 | ** |
| 2773 | ** 0: Parsing file-name. |
| 2774 | ** 1: Parsing name section of a name=value query parameter. |
| 2775 | ** 2: Parsing value section of a name=value query parameter. |
| 2776 | */ |
| 2777 | eState = 0; |
drh | de941c3 | 2011-05-09 19:20:17 +0000 | [diff] [blame] | 2778 | while( (c = zUri[iIn])!=0 && c!='#' ){ |
| 2779 | iIn++; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2780 | if( c=='%' |
| 2781 | && sqlite3Isxdigit(zUri[iIn]) |
| 2782 | && sqlite3Isxdigit(zUri[iIn+1]) |
| 2783 | ){ |
dan | 6d49e25 | 2011-05-03 15:09:05 +0000 | [diff] [blame] | 2784 | int octet = (sqlite3HexToInt(zUri[iIn++]) << 4); |
| 2785 | octet += sqlite3HexToInt(zUri[iIn++]); |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2786 | |
dan | 6d49e25 | 2011-05-03 15:09:05 +0000 | [diff] [blame] | 2787 | assert( octet>=0 && octet<256 ); |
| 2788 | if( octet==0 ){ |
dan | 5c35e90 | 2016-10-26 12:15:41 +0000 | [diff] [blame] | 2789 | #ifndef SQLITE_ENABLE_URI_00_ERROR |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2790 | /* This branch is taken when "%00" appears within the URI. In this |
| 2791 | ** case we ignore all text in the remainder of the path, name or |
| 2792 | ** value currently being parsed. So ignore the current character |
| 2793 | ** and skip to the next "?", "=" or "&", as appropriate. */ |
drh | de941c3 | 2011-05-09 19:20:17 +0000 | [diff] [blame] | 2794 | while( (c = zUri[iIn])!=0 && c!='#' |
| 2795 | && (eState!=0 || c!='?') |
| 2796 | && (eState!=1 || (c!='=' && c!='&')) |
| 2797 | && (eState!=2 || c!='&') |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2798 | ){ |
| 2799 | iIn++; |
| 2800 | } |
| 2801 | continue; |
dan | 5c35e90 | 2016-10-26 12:15:41 +0000 | [diff] [blame] | 2802 | #else |
| 2803 | /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */ |
| 2804 | *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri"); |
| 2805 | rc = SQLITE_ERROR; |
| 2806 | goto parse_uri_out; |
| 2807 | #endif |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2808 | } |
dan | 6d49e25 | 2011-05-03 15:09:05 +0000 | [diff] [blame] | 2809 | c = octet; |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2810 | }else if( eState==1 && (c=='&' || c=='=') ){ |
| 2811 | if( zFile[iOut-1]==0 ){ |
| 2812 | /* An empty option name. Ignore this option altogether. */ |
| 2813 | while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++; |
| 2814 | continue; |
| 2815 | } |
| 2816 | if( c=='&' ){ |
| 2817 | zFile[iOut++] = '\0'; |
| 2818 | }else{ |
| 2819 | eState = 2; |
| 2820 | } |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2821 | c = 0; |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2822 | }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){ |
| 2823 | c = 0; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2824 | eState = 1; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2825 | } |
| 2826 | zFile[iOut++] = c; |
| 2827 | } |
| 2828 | if( eState==1 ) zFile[iOut++] = '\0'; |
| 2829 | zFile[iOut++] = '\0'; |
| 2830 | zFile[iOut++] = '\0'; |
| 2831 | |
| 2832 | /* Check if there were any options specified that should be interpreted |
| 2833 | ** here. Options that are interpreted here include "vfs" and those that |
| 2834 | ** correspond to flags that may be passed to the sqlite3_open_v2() |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2835 | ** method. */ |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2836 | zOpt = &zFile[sqlite3Strlen30(zFile)+1]; |
| 2837 | while( zOpt[0] ){ |
| 2838 | int nOpt = sqlite3Strlen30(zOpt); |
| 2839 | char *zVal = &zOpt[nOpt+1]; |
| 2840 | int nVal = sqlite3Strlen30(zVal); |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2841 | |
dan | 286ab7c | 2011-05-06 18:34:54 +0000 | [diff] [blame] | 2842 | if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){ |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2843 | zVfs = zVal; |
| 2844 | }else{ |
| 2845 | struct OpenMode { |
| 2846 | const char *z; |
| 2847 | int mode; |
| 2848 | } *aMode = 0; |
drh | 45caede | 2011-06-03 14:19:10 +0000 | [diff] [blame] | 2849 | char *zModeType = 0; |
| 2850 | int mask = 0; |
| 2851 | int limit = 0; |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2852 | |
dan | 286ab7c | 2011-05-06 18:34:54 +0000 | [diff] [blame] | 2853 | if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){ |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2854 | static struct OpenMode aCacheMode[] = { |
| 2855 | { "shared", SQLITE_OPEN_SHAREDCACHE }, |
| 2856 | { "private", SQLITE_OPEN_PRIVATECACHE }, |
| 2857 | { 0, 0 } |
| 2858 | }; |
| 2859 | |
| 2860 | mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE; |
| 2861 | aMode = aCacheMode; |
| 2862 | limit = mask; |
| 2863 | zModeType = "cache"; |
| 2864 | } |
dan | 286ab7c | 2011-05-06 18:34:54 +0000 | [diff] [blame] | 2865 | if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){ |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2866 | static struct OpenMode aOpenMode[] = { |
| 2867 | { "ro", SQLITE_OPEN_READONLY }, |
| 2868 | { "rw", SQLITE_OPEN_READWRITE }, |
| 2869 | { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE }, |
dan | 0b8dcfa | 2012-06-07 17:16:04 +0000 | [diff] [blame] | 2870 | { "memory", SQLITE_OPEN_MEMORY }, |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2871 | { 0, 0 } |
| 2872 | }; |
| 2873 | |
drh | 9c67b2a | 2012-05-28 13:58:00 +0000 | [diff] [blame] | 2874 | mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE |
| 2875 | | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY; |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2876 | aMode = aOpenMode; |
| 2877 | limit = mask & flags; |
| 2878 | zModeType = "access"; |
| 2879 | } |
| 2880 | |
| 2881 | if( aMode ){ |
| 2882 | int i; |
| 2883 | int mode = 0; |
| 2884 | for(i=0; aMode[i].z; i++){ |
| 2885 | const char *z = aMode[i].z; |
drh | 522c26f | 2011-05-07 14:40:29 +0000 | [diff] [blame] | 2886 | if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){ |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2887 | mode = aMode[i].mode; |
| 2888 | break; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2889 | } |
| 2890 | } |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2891 | if( mode==0 ){ |
| 2892 | *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal); |
| 2893 | rc = SQLITE_ERROR; |
| 2894 | goto parse_uri_out; |
| 2895 | } |
drh | 9c67b2a | 2012-05-28 13:58:00 +0000 | [diff] [blame] | 2896 | if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){ |
drh | de941c3 | 2011-05-09 19:20:17 +0000 | [diff] [blame] | 2897 | *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s", |
| 2898 | zModeType, zVal); |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2899 | rc = SQLITE_PERM; |
| 2900 | goto parse_uri_out; |
| 2901 | } |
| 2902 | flags = (flags & ~mask) | mode; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2903 | } |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2904 | } |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2905 | |
| 2906 | zOpt = &zVal[nVal+1]; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2907 | } |
| 2908 | |
| 2909 | }else{ |
drh | f3cdcdc | 2015-04-29 16:50:28 +0000 | [diff] [blame] | 2910 | zFile = sqlite3_malloc64(nUri+2); |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 2911 | if( !zFile ) return SQLITE_NOMEM_BKPT; |
dan | 895decf | 2016-12-30 14:15:56 +0000 | [diff] [blame] | 2912 | if( nUri ){ |
| 2913 | memcpy(zFile, zUri, nUri); |
| 2914 | } |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2915 | zFile[nUri] = '\0'; |
| 2916 | zFile[nUri+1] = '\0'; |
drh | 4ab9d25 | 2012-05-26 20:08:49 +0000 | [diff] [blame] | 2917 | flags &= ~SQLITE_OPEN_URI; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2918 | } |
| 2919 | |
| 2920 | *ppVfs = sqlite3_vfs_find(zVfs); |
| 2921 | if( *ppVfs==0 ){ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2922 | *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs); |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2923 | rc = SQLITE_ERROR; |
| 2924 | } |
| 2925 | parse_uri_out: |
| 2926 | if( rc!=SQLITE_OK ){ |
dan | 5de1537 | 2011-04-23 10:12:30 +0000 | [diff] [blame] | 2927 | sqlite3_free(zFile); |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2928 | zFile = 0; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2929 | } |
| 2930 | *pFlags = flags; |
| 2931 | *pzFile = zFile; |
dan | 78e9dd2 | 2011-05-03 10:22:32 +0000 | [diff] [blame] | 2932 | return rc; |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2933 | } |
| 2934 | |
| 2935 | |
| 2936 | /* |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2937 | ** This routine does the work of opening a database on behalf of |
| 2938 | ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename" |
drh | ee570fa | 2005-04-28 12:06:05 +0000 | [diff] [blame] | 2939 | ** is UTF-8 encoded. |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2940 | */ |
| 2941 | static int openDatabase( |
| 2942 | const char *zFilename, /* Database filename UTF-8 encoded */ |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 2943 | sqlite3 **ppDb, /* OUT: Returned database handle */ |
drh | 522c26f | 2011-05-07 14:40:29 +0000 | [diff] [blame] | 2944 | unsigned int flags, /* Operational flags */ |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 2945 | const char *zVfs /* Name of the VFS to use */ |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2946 | ){ |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 2947 | sqlite3 *db; /* Store allocated handle here */ |
| 2948 | int rc; /* Return code */ |
| 2949 | int isThreadsafe; /* True for threadsafe connections */ |
| 2950 | char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */ |
| 2951 | char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */ |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 2952 | |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 2953 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 2954 | if( ppDb==0 ) return SQLITE_MISUSE_BKPT; |
| 2955 | #endif |
drh | e0d0f8e | 2009-04-28 04:47:31 +0000 | [diff] [blame] | 2956 | *ppDb = 0; |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 2957 | #ifndef SQLITE_OMIT_AUTOINIT |
| 2958 | rc = sqlite3_initialize(); |
| 2959 | if( rc ) return rc; |
| 2960 | #endif |
| 2961 | |
drh | 039963a | 2008-09-03 00:43:15 +0000 | [diff] [blame] | 2962 | if( sqlite3GlobalConfig.bCoreMutex==0 ){ |
danielk1977 | 9a6284c | 2008-07-10 17:52:49 +0000 | [diff] [blame] | 2963 | isThreadsafe = 0; |
drh | 039963a | 2008-09-03 00:43:15 +0000 | [diff] [blame] | 2964 | }else if( flags & SQLITE_OPEN_NOMUTEX ){ |
| 2965 | isThreadsafe = 0; |
| 2966 | }else if( flags & SQLITE_OPEN_FULLMUTEX ){ |
| 2967 | isThreadsafe = 1; |
| 2968 | }else{ |
| 2969 | isThreadsafe = sqlite3GlobalConfig.bFullMutex; |
danielk1977 | 9a6284c | 2008-07-10 17:52:49 +0000 | [diff] [blame] | 2970 | } |
dan | 8385bec | 2017-11-25 17:51:01 +0000 | [diff] [blame] | 2971 | |
drh | f1f1268 | 2009-09-09 14:17:52 +0000 | [diff] [blame] | 2972 | if( flags & SQLITE_OPEN_PRIVATECACHE ){ |
drh | f4cfac9 | 2009-09-09 15:29:41 +0000 | [diff] [blame] | 2973 | flags &= ~SQLITE_OPEN_SHAREDCACHE; |
drh | f1f1268 | 2009-09-09 14:17:52 +0000 | [diff] [blame] | 2974 | }else if( sqlite3GlobalConfig.sharedCacheEnabled ){ |
| 2975 | flags |= SQLITE_OPEN_SHAREDCACHE; |
| 2976 | } |
danielk1977 | 9a6284c | 2008-07-10 17:52:49 +0000 | [diff] [blame] | 2977 | |
drh | b25a9f4 | 2009-05-12 13:35:11 +0000 | [diff] [blame] | 2978 | /* Remove harmful bits from the flags parameter |
| 2979 | ** |
| 2980 | ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were |
| 2981 | ** dealt with in the previous code block. Besides these, the only |
| 2982 | ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY, |
drh | 03e1b40 | 2011-02-23 22:39:23 +0000 | [diff] [blame] | 2983 | ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE, |
| 2984 | ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask |
drh | b25a9f4 | 2009-05-12 13:35:11 +0000 | [diff] [blame] | 2985 | ** off all other flags. |
| 2986 | */ |
drh | a4267dc | 2008-02-19 15:20:44 +0000 | [diff] [blame] | 2987 | flags &= ~( SQLITE_OPEN_DELETEONCLOSE | |
drh | b25a9f4 | 2009-05-12 13:35:11 +0000 | [diff] [blame] | 2988 | SQLITE_OPEN_EXCLUSIVE | |
drh | a4267dc | 2008-02-19 15:20:44 +0000 | [diff] [blame] | 2989 | SQLITE_OPEN_MAIN_DB | |
| 2990 | SQLITE_OPEN_TEMP_DB | |
| 2991 | SQLITE_OPEN_TRANSIENT_DB | |
| 2992 | SQLITE_OPEN_MAIN_JOURNAL | |
| 2993 | SQLITE_OPEN_TEMP_JOURNAL | |
| 2994 | SQLITE_OPEN_SUBJOURNAL | |
danielk1977 | 9a6284c | 2008-07-10 17:52:49 +0000 | [diff] [blame] | 2995 | SQLITE_OPEN_MASTER_JOURNAL | |
drh | 039963a | 2008-09-03 00:43:15 +0000 | [diff] [blame] | 2996 | SQLITE_OPEN_NOMUTEX | |
drh | 357b5f9 | 2010-08-24 18:07:57 +0000 | [diff] [blame] | 2997 | SQLITE_OPEN_FULLMUTEX | |
| 2998 | SQLITE_OPEN_WAL |
drh | a4267dc | 2008-02-19 15:20:44 +0000 | [diff] [blame] | 2999 | ); |
| 3000 | |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3001 | /* Allocate the sqlite data structure */ |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3002 | db = sqlite3MallocZero( sizeof(sqlite3) ); |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3003 | if( db==0 ) goto opendb_out; |
dan | 8385bec | 2017-11-25 17:51:01 +0000 | [diff] [blame] | 3004 | if( isThreadsafe |
| 3005 | #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS |
| 3006 | || sqlite3GlobalConfig.bCoreMutex |
| 3007 | #endif |
| 3008 | ){ |
danielk1977 | 59f8c08 | 2008-06-18 17:09:10 +0000 | [diff] [blame] | 3009 | db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE); |
| 3010 | if( db->mutex==0 ){ |
| 3011 | sqlite3_free(db); |
| 3012 | db = 0; |
| 3013 | goto opendb_out; |
| 3014 | } |
dan | 8385bec | 2017-11-25 17:51:01 +0000 | [diff] [blame] | 3015 | if( isThreadsafe==0 ){ |
| 3016 | sqlite3MutexWarnOnContention(db->mutex); |
| 3017 | } |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 3018 | } |
drh | 2764170 | 2007-08-22 02:56:42 +0000 | [diff] [blame] | 3019 | sqlite3_mutex_enter(db->mutex); |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 3020 | db->errMask = 0xff; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3021 | db->nDb = 2; |
drh | 153c62c | 2007-08-24 03:51:33 +0000 | [diff] [blame] | 3022 | db->magic = SQLITE_MAGIC_BUSY; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3023 | db->aDb = db->aDbStatic; |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 3024 | |
drh | bb4957f | 2008-03-20 14:03:29 +0000 | [diff] [blame] | 3025 | assert( sizeof(db->aLimit)==sizeof(aHardLimit) ); |
| 3026 | memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit)); |
drh | 6b2129a | 2014-08-29 19:06:07 +0000 | [diff] [blame] | 3027 | db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS; |
danielk1977 | 1d850a7 | 2004-05-31 08:26:49 +0000 | [diff] [blame] | 3028 | db->autoCommit = 1; |
drh | ddac25c | 2007-12-05 01:38:23 +0000 | [diff] [blame] | 3029 | db->nextAutovac = -1; |
drh | 9b4c59f | 2013-04-15 17:03:42 +0000 | [diff] [blame] | 3030 | db->szMmap = sqlite3GlobalConfig.szMmap; |
danielk1977 | f653d78 | 2008-03-20 11:04:21 +0000 | [diff] [blame] | 3031 | db->nextPagesize = 0; |
dan | 8930c2a | 2014-04-03 16:25:29 +0000 | [diff] [blame] | 3032 | db->nMaxSorterMmap = 0x7FFFFFFF; |
drh | 40c3941 | 2013-08-16 20:42:20 +0000 | [diff] [blame] | 3033 | db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill |
dan | 1d1f07d | 2013-07-25 16:41:39 +0000 | [diff] [blame] | 3034 | #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX |
drh | 986b387 | 2013-06-28 21:12:20 +0000 | [diff] [blame] | 3035 | | SQLITE_AutoIndex |
| 3036 | #endif |
drh | 883ad04 | 2015-02-19 00:29:11 +0000 | [diff] [blame] | 3037 | #if SQLITE_DEFAULT_CKPTFULLFSYNC |
| 3038 | | SQLITE_CkptFullFSync |
| 3039 | #endif |
drh | 76fe803 | 2006-07-11 14:17:51 +0000 | [diff] [blame] | 3040 | #if SQLITE_DEFAULT_FILE_FORMAT<4 |
| 3041 | | SQLITE_LegacyFileFmt |
| 3042 | #endif |
drh | 56424db | 2007-03-27 22:24:11 +0000 | [diff] [blame] | 3043 | #ifdef SQLITE_ENABLE_LOAD_EXTENSION |
| 3044 | | SQLITE_LoadExtension |
| 3045 | #endif |
dan | 5bde73c | 2009-09-01 17:11:07 +0000 | [diff] [blame] | 3046 | #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS |
dan | 5e1a278 | 2009-09-01 17:28:29 +0000 | [diff] [blame] | 3047 | | SQLITE_RecTriggers |
dan | 76d462e | 2009-08-30 11:42:51 +0000 | [diff] [blame] | 3048 | #endif |
drh | a4bfd7f | 2010-12-09 19:15:17 +0000 | [diff] [blame] | 3049 | #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS |
| 3050 | | SQLITE_ForeignKeys |
| 3051 | #endif |
drh | f547192 | 2014-12-09 15:12:11 +0000 | [diff] [blame] | 3052 | #if defined(SQLITE_REVERSE_UNORDERED_SELECTS) |
| 3053 | | SQLITE_ReverseOrder |
| 3054 | #endif |
drh | 1421d98 | 2015-05-27 03:46:18 +0000 | [diff] [blame] | 3055 | #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK) |
| 3056 | | SQLITE_CellSizeCk |
| 3057 | #endif |
drh | d42908f | 2016-02-26 15:38:24 +0000 | [diff] [blame] | 3058 | #if defined(SQLITE_ENABLE_FTS3_TOKENIZER) |
| 3059 | | SQLITE_Fts3Tokenizer |
| 3060 | #endif |
drh | 169dd92 | 2017-06-26 13:57:49 +0000 | [diff] [blame] | 3061 | #if defined(SQLITE_ENABLE_QPSG) |
| 3062 | | SQLITE_EnableQPSG |
| 3063 | #endif |
drh | 76fe803 | 2006-07-11 14:17:51 +0000 | [diff] [blame] | 3064 | ; |
drh | e61922a | 2009-05-02 13:29:37 +0000 | [diff] [blame] | 3065 | sqlite3HashInit(&db->aCollSeq); |
drh | b9bb7c1 | 2006-06-11 23:41:55 +0000 | [diff] [blame] | 3066 | #ifndef SQLITE_OMIT_VIRTUALTABLE |
drh | e61922a | 2009-05-02 13:29:37 +0000 | [diff] [blame] | 3067 | sqlite3HashInit(&db->aModule); |
drh | b9bb7c1 | 2006-06-11 23:41:55 +0000 | [diff] [blame] | 3068 | #endif |
danielk1977 | da18423 | 2006-01-05 11:34:32 +0000 | [diff] [blame] | 3069 | |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3070 | /* Add the default collation sequence BINARY. BINARY works for both UTF-8 |
| 3071 | ** and UTF-16, so add a version for each to avoid any unnecessary |
| 3072 | ** conversions. The only error that can occur here is a malloc() failure. |
drh | 5e3b49b | 2014-11-20 19:22:26 +0000 | [diff] [blame] | 3073 | ** |
| 3074 | ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating |
| 3075 | ** functions: |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3076 | */ |
drh | f19aa5f | 2015-12-30 16:51:20 +0000 | [diff] [blame] | 3077 | createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0); |
| 3078 | createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0); |
| 3079 | createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0); |
drh | 5e3b49b | 2014-11-20 19:22:26 +0000 | [diff] [blame] | 3080 | createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0); |
drh | 4dd65e0 | 2011-11-29 14:46:56 +0000 | [diff] [blame] | 3081 | createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0); |
drh | 77db4c0 | 2008-03-18 13:01:38 +0000 | [diff] [blame] | 3082 | if( db->mallocFailed ){ |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3083 | goto opendb_out; |
| 3084 | } |
drh | 5e3b49b | 2014-11-20 19:22:26 +0000 | [diff] [blame] | 3085 | /* EVIDENCE-OF: R-08308-17224 The default collating function for all |
| 3086 | ** strings is BINARY. |
| 3087 | */ |
drh | f19aa5f | 2015-12-30 16:51:20 +0000 | [diff] [blame] | 3088 | db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0); |
drh | 77db4c0 | 2008-03-18 13:01:38 +0000 | [diff] [blame] | 3089 | assert( db->pDfltColl!=0 ); |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3090 | |
drh | ff4fa77 | 2017-07-10 12:07:53 +0000 | [diff] [blame] | 3091 | /* Parse the filename/URI argument |
| 3092 | ** |
| 3093 | ** Only allow sensible combinations of bits in the flags argument. |
| 3094 | ** Throw an error if any non-sense combination is used. If we |
| 3095 | ** do not block illegal combinations here, it could trigger |
| 3096 | ** assert() statements in deeper layers. Sensible combinations |
| 3097 | ** are: |
| 3098 | ** |
| 3099 | ** 1: SQLITE_OPEN_READONLY |
| 3100 | ** 2: SQLITE_OPEN_READWRITE |
| 3101 | ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
| 3102 | */ |
dan | 1943299 | 2011-05-10 18:39:10 +0000 | [diff] [blame] | 3103 | db->openFlags = flags; |
drh | ff4fa77 | 2017-07-10 12:07:53 +0000 | [diff] [blame] | 3104 | assert( SQLITE_OPEN_READONLY == 0x01 ); |
| 3105 | assert( SQLITE_OPEN_READWRITE == 0x02 ); |
| 3106 | assert( SQLITE_OPEN_CREATE == 0x04 ); |
| 3107 | testcase( (1<<(flags&7))==0x02 ); /* READONLY */ |
| 3108 | testcase( (1<<(flags&7))==0x04 ); /* READWRITE */ |
| 3109 | testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */ |
| 3110 | if( ((1<<(flags&7)) & 0x46)==0 ){ |
| 3111 | rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */ |
| 3112 | }else{ |
| 3113 | rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg); |
| 3114 | } |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 3115 | if( rc!=SQLITE_OK ){ |
drh | 4a642b6 | 2016-02-05 01:55:27 +0000 | [diff] [blame] | 3116 | if( rc==SQLITE_NOMEM ) sqlite3OomFault(db); |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 3117 | sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg); |
dan | cd74b61 | 2011-04-22 19:37:32 +0000 | [diff] [blame] | 3118 | sqlite3_free(zErrMsg); |
| 3119 | goto opendb_out; |
| 3120 | } |
| 3121 | |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3122 | /* Open the backend database driver */ |
dan | 3a6d8ae | 2011-04-23 15:54:54 +0000 | [diff] [blame] | 3123 | rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0, |
drh | 75c014c | 2010-08-30 15:02:28 +0000 | [diff] [blame] | 3124 | flags | SQLITE_OPEN_MAIN_DB); |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3125 | if( rc!=SQLITE_OK ){ |
danielk1977 | 45e60aa | 2008-09-23 17:39:26 +0000 | [diff] [blame] | 3126 | if( rc==SQLITE_IOERR_NOMEM ){ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 3127 | rc = SQLITE_NOMEM_BKPT; |
danielk1977 | 45e60aa | 2008-09-23 17:39:26 +0000 | [diff] [blame] | 3128 | } |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 3129 | sqlite3Error(db, rc); |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3130 | goto opendb_out; |
| 3131 | } |
dan | 0235a03 | 2014-12-08 20:20:16 +0000 | [diff] [blame] | 3132 | sqlite3BtreeEnter(db->aDb[0].pBt); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3133 | db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt); |
drh | 9bd3cc4 | 2014-12-12 23:17:54 +0000 | [diff] [blame] | 3134 | if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db); |
dan | 0235a03 | 2014-12-08 20:20:16 +0000 | [diff] [blame] | 3135 | sqlite3BtreeLeave(db->aDb[0].pBt); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3136 | db->aDb[1].pSchema = sqlite3SchemaGet(db, 0); |
danielk1977 | 14db266 | 2006-01-09 16:12:04 +0000 | [diff] [blame] | 3137 | |
drh | e872d51 | 2016-02-22 13:23:16 +0000 | [diff] [blame] | 3138 | /* The default safety_level for the main database is FULL; for the temp |
| 3139 | ** database it is OFF. This matches the pager layer defaults. |
danielk1977 | 53c0f74 | 2005-03-29 03:10:59 +0000 | [diff] [blame] | 3140 | */ |
drh | 69c3382 | 2016-08-18 14:33:11 +0000 | [diff] [blame] | 3141 | db->aDb[0].zDbSName = "main"; |
drh | c2ae207 | 2016-03-08 15:30:01 +0000 | [diff] [blame] | 3142 | db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1; |
drh | 69c3382 | 2016-08-18 14:33:11 +0000 | [diff] [blame] | 3143 | db->aDb[1].zDbSName = "temp"; |
drh | e872d51 | 2016-02-22 13:23:16 +0000 | [diff] [blame] | 3144 | db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF; |
danielk1977 | 53c0f74 | 2005-03-29 03:10:59 +0000 | [diff] [blame] | 3145 | |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 3146 | db->magic = SQLITE_MAGIC_OPEN; |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3147 | if( db->mallocFailed ){ |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 3148 | goto opendb_out; |
| 3149 | } |
| 3150 | |
danielk1977 | 8e22787 | 2004-06-07 07:52:17 +0000 | [diff] [blame] | 3151 | /* Register all built-in functions, but do not attempt to read the |
| 3152 | ** database schema yet. This is delayed until the first time the database |
| 3153 | ** is accessed. |
| 3154 | */ |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 3155 | sqlite3Error(db, SQLITE_OK); |
drh | 80738d9 | 2016-02-15 00:34:16 +0000 | [diff] [blame] | 3156 | sqlite3RegisterPerConnectionBuiltinFunctions(db); |
dan | c9e75fb | 2016-08-19 18:37:35 +0000 | [diff] [blame] | 3157 | rc = sqlite3_errcode(db); |
| 3158 | |
| 3159 | #ifdef SQLITE_ENABLE_FTS5 |
| 3160 | /* Register any built-in FTS5 module before loading the automatic |
| 3161 | ** extensions. This allows automatic extensions to register FTS5 |
| 3162 | ** tokenizers and auxiliary functions. */ |
| 3163 | if( !db->mallocFailed && rc==SQLITE_OK ){ |
| 3164 | rc = sqlite3Fts5Init(db); |
| 3165 | } |
| 3166 | #endif |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3167 | |
drh | 1409be6 | 2006-08-23 20:07:20 +0000 | [diff] [blame] | 3168 | /* Load automatic extensions - extensions that have been registered |
| 3169 | ** using the sqlite3_automatic_extension() API. |
| 3170 | */ |
drh | e5077c1 | 2011-12-13 04:08:36 +0000 | [diff] [blame] | 3171 | if( rc==SQLITE_OK ){ |
| 3172 | sqlite3AutoLoadExtensions(db); |
| 3173 | rc = sqlite3_errcode(db); |
| 3174 | if( rc!=SQLITE_OK ){ |
| 3175 | goto opendb_out; |
| 3176 | } |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 3177 | } |
drh | 1409be6 | 2006-08-23 20:07:20 +0000 | [diff] [blame] | 3178 | |
drh | aa29c13 | 2006-09-02 13:58:06 +0000 | [diff] [blame] | 3179 | #ifdef SQLITE_ENABLE_FTS1 |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3180 | if( !db->mallocFailed ){ |
drh | aa29c13 | 2006-09-02 13:58:06 +0000 | [diff] [blame] | 3181 | extern int sqlite3Fts1Init(sqlite3*); |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 3182 | rc = sqlite3Fts1Init(db); |
drh | aa29c13 | 2006-09-02 13:58:06 +0000 | [diff] [blame] | 3183 | } |
| 3184 | #endif |
| 3185 | |
shess | a26cf57 | 2006-10-19 20:27:58 +0000 | [diff] [blame] | 3186 | #ifdef SQLITE_ENABLE_FTS2 |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3187 | if( !db->mallocFailed && rc==SQLITE_OK ){ |
shess | a26cf57 | 2006-10-19 20:27:58 +0000 | [diff] [blame] | 3188 | extern int sqlite3Fts2Init(sqlite3*); |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 3189 | rc = sqlite3Fts2Init(db); |
shess | a26cf57 | 2006-10-19 20:27:58 +0000 | [diff] [blame] | 3190 | } |
| 3191 | #endif |
| 3192 | |
drh | 5006565 | 2015-10-08 19:29:18 +0000 | [diff] [blame] | 3193 | #ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */ |
shess | 69c4ae2 | 2007-08-20 17:37:47 +0000 | [diff] [blame] | 3194 | if( !db->mallocFailed && rc==SQLITE_OK ){ |
shess | 69c4ae2 | 2007-08-20 17:37:47 +0000 | [diff] [blame] | 3195 | rc = sqlite3Fts3Init(db); |
| 3196 | } |
| 3197 | #endif |
| 3198 | |
dan | 21540ae | 2017-12-08 16:23:38 +0000 | [diff] [blame] | 3199 | #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS) |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3200 | if( !db->mallocFailed && rc==SQLITE_OK ){ |
danielk1977 | 832a58a | 2007-06-22 15:21:15 +0000 | [diff] [blame] | 3201 | rc = sqlite3IcuInit(db); |
danielk1977 | 83852ac | 2007-05-06 16:04:11 +0000 | [diff] [blame] | 3202 | } |
| 3203 | #endif |
danielk1977 | ebaecc1 | 2008-05-26 18:41:54 +0000 | [diff] [blame] | 3204 | |
| 3205 | #ifdef SQLITE_ENABLE_RTREE |
| 3206 | if( !db->mallocFailed && rc==SQLITE_OK){ |
danielk1977 | ebaecc1 | 2008-05-26 18:41:54 +0000 | [diff] [blame] | 3207 | rc = sqlite3RtreeInit(db); |
| 3208 | } |
| 3209 | #endif |
| 3210 | |
drh | a43c8c8 | 2017-10-11 13:48:11 +0000 | [diff] [blame] | 3211 | #ifdef SQLITE_ENABLE_DBPAGE_VTAB |
| 3212 | if( !db->mallocFailed && rc==SQLITE_OK){ |
| 3213 | rc = sqlite3DbpageRegister(db); |
| 3214 | } |
| 3215 | #endif |
| 3216 | |
drh | a3ab9d0 | 2015-05-04 20:25:05 +0000 | [diff] [blame] | 3217 | #ifdef SQLITE_ENABLE_DBSTAT_VTAB |
| 3218 | if( !db->mallocFailed && rc==SQLITE_OK){ |
drh | 3e0327d | 2015-05-11 11:59:15 +0000 | [diff] [blame] | 3219 | rc = sqlite3DbstatRegister(db); |
drh | a3ab9d0 | 2015-05-04 20:25:05 +0000 | [diff] [blame] | 3220 | } |
| 3221 | #endif |
| 3222 | |
drh | 2f20e13 | 2015-09-26 17:44:59 +0000 | [diff] [blame] | 3223 | #ifdef SQLITE_ENABLE_JSON1 |
| 3224 | if( !db->mallocFailed && rc==SQLITE_OK){ |
drh | 2f20e13 | 2015-09-26 17:44:59 +0000 | [diff] [blame] | 3225 | rc = sqlite3Json1Init(db); |
| 3226 | } |
| 3227 | #endif |
| 3228 | |
drh | c6603af | 2017-06-29 14:33:51 +0000 | [diff] [blame] | 3229 | #ifdef SQLITE_ENABLE_STMTVTAB |
drh | f00f530 | 2017-06-28 15:47:29 +0000 | [diff] [blame] | 3230 | if( !db->mallocFailed && rc==SQLITE_OK){ |
drh | c6603af | 2017-06-29 14:33:51 +0000 | [diff] [blame] | 3231 | rc = sqlite3StmtVtabInit(db); |
drh | f00f530 | 2017-06-28 15:47:29 +0000 | [diff] [blame] | 3232 | } |
| 3233 | #endif |
| 3234 | |
drh | 8fd5bd3 | 2007-04-02 16:40:37 +0000 | [diff] [blame] | 3235 | /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking |
| 3236 | ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking |
| 3237 | ** mode. Doing nothing at all also makes NORMAL the default. |
| 3238 | */ |
| 3239 | #ifdef SQLITE_DEFAULT_LOCKING_MODE |
| 3240 | db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE; |
| 3241 | sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt), |
| 3242 | SQLITE_DEFAULT_LOCKING_MODE); |
| 3243 | #endif |
| 3244 | |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 3245 | if( rc ) sqlite3Error(db, rc); |
drh | f6b1a8e | 2013-12-19 16:26:05 +0000 | [diff] [blame] | 3246 | |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 3247 | /* Enable the lookaside-malloc subsystem */ |
drh | 1b67f3c | 2008-10-10 17:41:28 +0000 | [diff] [blame] | 3248 | setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside, |
| 3249 | sqlite3GlobalConfig.nLookaside); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 3250 | |
dan | 5a299f9 | 2010-05-03 11:05:08 +0000 | [diff] [blame] | 3251 | sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT); |
dan | 586b9c8 | 2010-05-03 08:04:49 +0000 | [diff] [blame] | 3252 | |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3253 | opendb_out: |
drh | afc9104 | 2008-02-21 02:09:45 +0000 | [diff] [blame] | 3254 | if( db ){ |
drh | 3ba689d | 2015-03-03 14:00:11 +0000 | [diff] [blame] | 3255 | assert( db->mutex!=0 || isThreadsafe==0 |
| 3256 | || sqlite3GlobalConfig.bFullMutex==0 ); |
drh | f3a65f7 | 2007-08-22 20:18:21 +0000 | [diff] [blame] | 3257 | sqlite3_mutex_leave(db->mutex); |
| 3258 | } |
danielk1977 | 59633ae | 2008-08-27 19:01:57 +0000 | [diff] [blame] | 3259 | rc = sqlite3_errcode(db); |
drh | b07028f | 2011-10-14 21:49:18 +0000 | [diff] [blame] | 3260 | assert( db!=0 || rc==SQLITE_NOMEM ); |
danielk1977 | 59633ae | 2008-08-27 19:01:57 +0000 | [diff] [blame] | 3261 | if( rc==SQLITE_NOMEM ){ |
danielk1977 | 7ddad96 | 2005-12-12 06:53:03 +0000 | [diff] [blame] | 3262 | sqlite3_close(db); |
| 3263 | db = 0; |
danielk1977 | 59633ae | 2008-08-27 19:01:57 +0000 | [diff] [blame] | 3264 | }else if( rc!=SQLITE_OK ){ |
| 3265 | db->magic = SQLITE_MAGIC_SICK; |
danielk1977 | 1307393 | 2004-06-30 11:54:06 +0000 | [diff] [blame] | 3266 | } |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3267 | *ppDb = db; |
dan | ac45593 | 2012-11-26 19:50:41 +0000 | [diff] [blame] | 3268 | #ifdef SQLITE_ENABLE_SQLLOG |
| 3269 | if( sqlite3GlobalConfig.xSqllog ){ |
dan | 71ba10d | 2012-11-27 10:56:39 +0000 | [diff] [blame] | 3270 | /* Opening a db handle. Fourth parameter is passed 0. */ |
| 3271 | void *pArg = sqlite3GlobalConfig.pSqllogArg; |
| 3272 | sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0); |
dan | ac45593 | 2012-11-26 19:50:41 +0000 | [diff] [blame] | 3273 | } |
| 3274 | #endif |
drh | 46e6ea0 | 2015-10-26 14:41:35 +0000 | [diff] [blame] | 3275 | #if defined(SQLITE_HAS_CODEC) |
| 3276 | if( rc==SQLITE_OK ){ |
drh | ad012d0 | 2017-05-03 15:54:53 +0000 | [diff] [blame] | 3277 | const char *zKey; |
drh | d4fb196 | 2017-05-23 00:32:56 +0000 | [diff] [blame] | 3278 | if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){ |
drh | 46e6ea0 | 2015-10-26 14:41:35 +0000 | [diff] [blame] | 3279 | u8 iByte; |
| 3280 | int i; |
drh | ad012d0 | 2017-05-03 15:54:53 +0000 | [diff] [blame] | 3281 | char zDecoded[40]; |
| 3282 | for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){ |
| 3283 | iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]); |
| 3284 | if( (i&1)!=0 ) zDecoded[i/2] = iByte; |
drh | 46e6ea0 | 2015-10-26 14:41:35 +0000 | [diff] [blame] | 3285 | } |
drh | ad012d0 | 2017-05-03 15:54:53 +0000 | [diff] [blame] | 3286 | sqlite3_key_v2(db, 0, zDecoded, i/2); |
| 3287 | }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){ |
| 3288 | sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey)); |
drh | 46e6ea0 | 2015-10-26 14:41:35 +0000 | [diff] [blame] | 3289 | } |
| 3290 | } |
| 3291 | #endif |
drh | 095fb47 | 2016-01-16 03:16:19 +0000 | [diff] [blame] | 3292 | sqlite3_free(zOpen); |
drh | 597d2b6 | 2015-06-30 03:13:47 +0000 | [diff] [blame] | 3293 | return rc & 0xff; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3294 | } |
| 3295 | |
| 3296 | /* |
| 3297 | ** Open a new database handle. |
| 3298 | */ |
danielk1977 | 8029086 | 2004-05-22 09:21:21 +0000 | [diff] [blame] | 3299 | int sqlite3_open( |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3300 | const char *zFilename, |
danielk1977 | 4f057f9 | 2004-06-08 00:02:33 +0000 | [diff] [blame] | 3301 | sqlite3 **ppDb |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3302 | ){ |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 3303 | return openDatabase(zFilename, ppDb, |
| 3304 | SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0); |
| 3305 | } |
| 3306 | int sqlite3_open_v2( |
drh | 428e282 | 2007-08-30 16:23:19 +0000 | [diff] [blame] | 3307 | const char *filename, /* Database filename (UTF-8) */ |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 3308 | sqlite3 **ppDb, /* OUT: SQLite db handle */ |
| 3309 | int flags, /* Flags */ |
| 3310 | const char *zVfs /* Name of VFS module to use */ |
| 3311 | ){ |
drh | 522c26f | 2011-05-07 14:40:29 +0000 | [diff] [blame] | 3312 | return openDatabase(filename, ppDb, (unsigned int)flags, zVfs); |
danielk1977 | 83ab5a8 | 2004-05-21 11:39:05 +0000 | [diff] [blame] | 3313 | } |
| 3314 | |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 3315 | #ifndef SQLITE_OMIT_UTF16 |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3316 | /* |
| 3317 | ** Open a new database handle. |
| 3318 | */ |
| 3319 | int sqlite3_open16( |
| 3320 | const void *zFilename, |
danielk1977 | 4f057f9 | 2004-06-08 00:02:33 +0000 | [diff] [blame] | 3321 | sqlite3 **ppDb |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3322 | ){ |
danielk1977 | bfd6cce | 2004-06-18 04:24:54 +0000 | [diff] [blame] | 3323 | char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */ |
danielk1977 | bfd6cce | 2004-06-18 04:24:54 +0000 | [diff] [blame] | 3324 | sqlite3_value *pVal; |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 3325 | int rc; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3326 | |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3327 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3328 | if( ppDb==0 ) return SQLITE_MISUSE_BKPT; |
| 3329 | #endif |
danielk1977 | bfd6cce | 2004-06-18 04:24:54 +0000 | [diff] [blame] | 3330 | *ppDb = 0; |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 3331 | #ifndef SQLITE_OMIT_AUTOINIT |
| 3332 | rc = sqlite3_initialize(); |
| 3333 | if( rc ) return rc; |
| 3334 | #endif |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3335 | if( zFilename==0 ) zFilename = "\000\000"; |
danielk1977 | 1e53695 | 2007-08-16 10:09:01 +0000 | [diff] [blame] | 3336 | pVal = sqlite3ValueNew(0); |
drh | b21c8cd | 2007-08-21 19:33:56 +0000 | [diff] [blame] | 3337 | sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC); |
| 3338 | zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8); |
danielk1977 | bfd6cce | 2004-06-18 04:24:54 +0000 | [diff] [blame] | 3339 | if( zFilename8 ){ |
drh | 605264d | 2007-08-21 15:13:19 +0000 | [diff] [blame] | 3340 | rc = openDatabase(zFilename8, ppDb, |
| 3341 | SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0); |
drh | afc9104 | 2008-02-21 02:09:45 +0000 | [diff] [blame] | 3342 | assert( *ppDb || rc==SQLITE_NOMEM ); |
danielk1977 | f51bf48 | 2008-04-28 16:19:35 +0000 | [diff] [blame] | 3343 | if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){ |
drh | 9bd3cc4 | 2014-12-12 23:17:54 +0000 | [diff] [blame] | 3344 | SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE; |
danielk1977 | bfd6cce | 2004-06-18 04:24:54 +0000 | [diff] [blame] | 3345 | } |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 3346 | }else{ |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 3347 | rc = SQLITE_NOMEM_BKPT; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3348 | } |
danielk1977 | 7ddad96 | 2005-12-12 06:53:03 +0000 | [diff] [blame] | 3349 | sqlite3ValueFree(pVal); |
danielk1977 | 8e22787 | 2004-06-07 07:52:17 +0000 | [diff] [blame] | 3350 | |
drh | 597d2b6 | 2015-06-30 03:13:47 +0000 | [diff] [blame] | 3351 | return rc & 0xff; |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3352 | } |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 3353 | #endif /* SQLITE_OMIT_UTF16 */ |
danielk1977 | 4ad1713 | 2004-05-21 01:47:26 +0000 | [diff] [blame] | 3354 | |
danielk1977 | 106bb23 | 2004-05-21 10:08:53 +0000 | [diff] [blame] | 3355 | /* |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 3356 | ** Register a new collation sequence with the database handle db. |
| 3357 | */ |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3358 | int sqlite3_create_collation( |
| 3359 | sqlite3* db, |
| 3360 | const char *zName, |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 3361 | int enc, |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3362 | void* pCtx, |
| 3363 | int(*xCompare)(void*,int,const void*,int,const void*) |
| 3364 | ){ |
drh | 4f81bbb | 2014-10-23 01:01:26 +0000 | [diff] [blame] | 3365 | return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0); |
danielk1977 | a9808b3 | 2007-05-07 09:32:45 +0000 | [diff] [blame] | 3366 | } |
| 3367 | |
| 3368 | /* |
| 3369 | ** Register a new collation sequence with the database handle db. |
| 3370 | */ |
danielk1977 | a393c03 | 2007-05-07 14:58:53 +0000 | [diff] [blame] | 3371 | int sqlite3_create_collation_v2( |
danielk1977 | a9808b3 | 2007-05-07 09:32:45 +0000 | [diff] [blame] | 3372 | sqlite3* db, |
| 3373 | const char *zName, |
| 3374 | int enc, |
| 3375 | void* pCtx, |
| 3376 | int(*xCompare)(void*,int,const void*,int,const void*), |
| 3377 | void(*xDel)(void*) |
| 3378 | ){ |
| 3379 | int rc; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3380 | |
| 3381 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3382 | if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT; |
| 3383 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3384 | sqlite3_mutex_enter(db->mutex); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3385 | assert( !db->mallocFailed ); |
drh | 4dd65e0 | 2011-11-29 14:46:56 +0000 | [diff] [blame] | 3386 | rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel); |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3387 | rc = sqlite3ApiExit(db, rc); |
| 3388 | sqlite3_mutex_leave(db->mutex); |
| 3389 | return rc; |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3390 | } |
| 3391 | |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 3392 | #ifndef SQLITE_OMIT_UTF16 |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 3393 | /* |
| 3394 | ** Register a new collation sequence with the database handle db. |
| 3395 | */ |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3396 | int sqlite3_create_collation16( |
| 3397 | sqlite3* db, |
mihailim | bda2e62 | 2008-06-23 11:23:14 +0000 | [diff] [blame] | 3398 | const void *zName, |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 3399 | int enc, |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3400 | void* pCtx, |
| 3401 | int(*xCompare)(void*,int,const void*,int,const void*) |
| 3402 | ){ |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 3403 | int rc = SQLITE_OK; |
drh | 01495b9 | 2008-01-23 12:52:40 +0000 | [diff] [blame] | 3404 | char *zName8; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3405 | |
| 3406 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3407 | if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT; |
| 3408 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3409 | sqlite3_mutex_enter(db->mutex); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 3410 | assert( !db->mallocFailed ); |
dan | b7dca7d | 2010-03-05 16:32:12 +0000 | [diff] [blame] | 3411 | zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE); |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 3412 | if( zName8 ){ |
drh | 4dd65e0 | 2011-11-29 14:46:56 +0000 | [diff] [blame] | 3413 | rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 3414 | sqlite3DbFree(db, zName8); |
danielk1977 | 9a30cf6 | 2006-01-18 04:26:07 +0000 | [diff] [blame] | 3415 | } |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3416 | rc = sqlite3ApiExit(db, rc); |
| 3417 | sqlite3_mutex_leave(db->mutex); |
| 3418 | return rc; |
danielk1977 | 0202b29 | 2004-06-09 09:55:16 +0000 | [diff] [blame] | 3419 | } |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 3420 | #endif /* SQLITE_OMIT_UTF16 */ |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3421 | |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 3422 | /* |
| 3423 | ** Register a collation sequence factory callback with the database handle |
| 3424 | ** db. Replace any previously installed collation sequence factory. |
| 3425 | */ |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3426 | int sqlite3_collation_needed( |
| 3427 | sqlite3 *db, |
| 3428 | void *pCollNeededArg, |
| 3429 | void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*) |
| 3430 | ){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3431 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3432 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 3433 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3434 | sqlite3_mutex_enter(db->mutex); |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3435 | db->xCollNeeded = xCollNeeded; |
| 3436 | db->xCollNeeded16 = 0; |
| 3437 | db->pCollNeededArg = pCollNeededArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3438 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3439 | return SQLITE_OK; |
| 3440 | } |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 3441 | |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 3442 | #ifndef SQLITE_OMIT_UTF16 |
danielk1977 | d812336 | 2004-06-12 09:25:12 +0000 | [diff] [blame] | 3443 | /* |
| 3444 | ** Register a collation sequence factory callback with the database handle |
| 3445 | ** db. Replace any previously installed collation sequence factory. |
| 3446 | */ |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3447 | int sqlite3_collation_needed16( |
| 3448 | sqlite3 *db, |
| 3449 | void *pCollNeededArg, |
| 3450 | void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*) |
| 3451 | ){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3452 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3453 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 3454 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3455 | sqlite3_mutex_enter(db->mutex); |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3456 | db->xCollNeeded = 0; |
| 3457 | db->xCollNeeded16 = xCollNeeded16; |
| 3458 | db->pCollNeededArg = pCollNeededArg; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3459 | sqlite3_mutex_leave(db->mutex); |
danielk1977 | 7cedc8d | 2004-06-10 10:50:08 +0000 | [diff] [blame] | 3460 | return SQLITE_OK; |
| 3461 | } |
drh | 6c62608 | 2004-11-14 21:56:29 +0000 | [diff] [blame] | 3462 | #endif /* SQLITE_OMIT_UTF16 */ |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 3463 | |
shane | eec556d | 2008-10-12 00:27:53 +0000 | [diff] [blame] | 3464 | #ifndef SQLITE_OMIT_DEPRECATED |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 3465 | /* |
danielk1977 | 7ddad96 | 2005-12-12 06:53:03 +0000 | [diff] [blame] | 3466 | ** This function is now an anachronism. It used to be used to recover from a |
| 3467 | ** malloc() failure, but SQLite now does this automatically. |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 3468 | */ |
drh | 7d97efb | 2007-10-12 19:35:48 +0000 | [diff] [blame] | 3469 | int sqlite3_global_recover(void){ |
danielk1977 | 261919c | 2005-12-06 12:52:59 +0000 | [diff] [blame] | 3470 | return SQLITE_OK; |
danielk1977 | 6b456a2 | 2005-03-21 04:04:02 +0000 | [diff] [blame] | 3471 | } |
| 3472 | #endif |
drh | 3e1d8e6 | 2005-05-26 16:23:34 +0000 | [diff] [blame] | 3473 | |
| 3474 | /* |
| 3475 | ** Test to see whether or not the database connection is in autocommit |
| 3476 | ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on |
| 3477 | ** by default. Autocommit is disabled by a BEGIN statement and reenabled |
| 3478 | ** by the next COMMIT or ROLLBACK. |
drh | 3e1d8e6 | 2005-05-26 16:23:34 +0000 | [diff] [blame] | 3479 | */ |
| 3480 | int sqlite3_get_autocommit(sqlite3 *db){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3481 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3482 | if( !sqlite3SafetyCheckOk(db) ){ |
| 3483 | (void)SQLITE_MISUSE_BKPT; |
| 3484 | return 0; |
| 3485 | } |
| 3486 | #endif |
drh | 3e1d8e6 | 2005-05-26 16:23:34 +0000 | [diff] [blame] | 3487 | return db->autoCommit; |
| 3488 | } |
drh | 4928570 | 2005-09-17 15:20:26 +0000 | [diff] [blame] | 3489 | |
drh | 4928570 | 2005-09-17 15:20:26 +0000 | [diff] [blame] | 3490 | /* |
peter.d.reid | 60ec914 | 2014-09-06 16:39:46 +0000 | [diff] [blame] | 3491 | ** The following routines are substitutes for constants SQLITE_CORRUPT, |
mistachkin | 8fd8413 | 2016-02-14 00:14:35 +0000 | [diff] [blame] | 3492 | ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error |
peter.d.reid | 60ec914 | 2014-09-06 16:39:46 +0000 | [diff] [blame] | 3493 | ** constants. They serve two purposes: |
drh | 9978c97 | 2010-02-23 17:36:32 +0000 | [diff] [blame] | 3494 | ** |
| 3495 | ** 1. Serve as a convenient place to set a breakpoint in a debugger |
| 3496 | ** to detect when version error conditions occurs. |
| 3497 | ** |
| 3498 | ** 2. Invoke sqlite3_log() to provide the source code location where |
| 3499 | ** a low-level error is first detected. |
drh | 4928570 | 2005-09-17 15:20:26 +0000 | [diff] [blame] | 3500 | */ |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3501 | int sqlite3ReportError(int iErr, int lineno, const char *zType){ |
drh | 32c4990 | 2016-02-15 18:15:15 +0000 | [diff] [blame] | 3502 | sqlite3_log(iErr, "%s at line %d of [%.10s]", |
| 3503 | zType, lineno, 20+sqlite3_sourceid()); |
| 3504 | return iErr; |
| 3505 | } |
drh | 9978c97 | 2010-02-23 17:36:32 +0000 | [diff] [blame] | 3506 | int sqlite3CorruptError(int lineno){ |
drh | af46dc1 | 2010-02-24 21:44:07 +0000 | [diff] [blame] | 3507 | testcase( sqlite3GlobalConfig.xLog!=0 ); |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3508 | return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption"); |
drh | 4928570 | 2005-09-17 15:20:26 +0000 | [diff] [blame] | 3509 | } |
drh | 9978c97 | 2010-02-23 17:36:32 +0000 | [diff] [blame] | 3510 | int sqlite3MisuseError(int lineno){ |
drh | af46dc1 | 2010-02-24 21:44:07 +0000 | [diff] [blame] | 3511 | testcase( sqlite3GlobalConfig.xLog!=0 ); |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3512 | return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse"); |
drh | 9978c97 | 2010-02-23 17:36:32 +0000 | [diff] [blame] | 3513 | } |
| 3514 | int sqlite3CantopenError(int lineno){ |
drh | af46dc1 | 2010-02-24 21:44:07 +0000 | [diff] [blame] | 3515 | testcase( sqlite3GlobalConfig.xLog!=0 ); |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3516 | return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file"); |
drh | 9978c97 | 2010-02-23 17:36:32 +0000 | [diff] [blame] | 3517 | } |
drh | 32c4990 | 2016-02-15 18:15:15 +0000 | [diff] [blame] | 3518 | #ifdef SQLITE_DEBUG |
drh | cc97ca4 | 2017-06-07 22:32:59 +0000 | [diff] [blame] | 3519 | int sqlite3CorruptPgnoError(int lineno, Pgno pgno){ |
| 3520 | char zMsg[100]; |
| 3521 | sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno); |
| 3522 | testcase( sqlite3GlobalConfig.xLog!=0 ); |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3523 | return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg); |
drh | cc97ca4 | 2017-06-07 22:32:59 +0000 | [diff] [blame] | 3524 | } |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 3525 | int sqlite3NomemError(int lineno){ |
| 3526 | testcase( sqlite3GlobalConfig.xLog!=0 ); |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3527 | return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM"); |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 3528 | } |
| 3529 | int sqlite3IoerrnomemError(int lineno){ |
| 3530 | testcase( sqlite3GlobalConfig.xLog!=0 ); |
dan | eebf2f5 | 2017-11-18 17:30:08 +0000 | [diff] [blame] | 3531 | return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error"); |
mistachkin | fad3039 | 2016-02-13 23:43:46 +0000 | [diff] [blame] | 3532 | } |
drh | 32c4990 | 2016-02-15 18:15:15 +0000 | [diff] [blame] | 3533 | #endif |
drh | 7c1817e | 2006-01-10 13:58:48 +0000 | [diff] [blame] | 3534 | |
shane | eec556d | 2008-10-12 00:27:53 +0000 | [diff] [blame] | 3535 | #ifndef SQLITE_OMIT_DEPRECATED |
drh | 6f7adc8 | 2006-01-11 21:41:20 +0000 | [diff] [blame] | 3536 | /* |
| 3537 | ** This is a convenience routine that makes sure that all thread-specific |
| 3538 | ** data for this thread has been deallocated. |
drh | dce8bdb | 2007-08-16 13:01:44 +0000 | [diff] [blame] | 3539 | ** |
| 3540 | ** SQLite no longer uses thread-specific data so this routine is now a |
| 3541 | ** no-op. It is retained for historical compatibility. |
drh | 6f7adc8 | 2006-01-11 21:41:20 +0000 | [diff] [blame] | 3542 | */ |
| 3543 | void sqlite3_thread_cleanup(void){ |
drh | 6f7adc8 | 2006-01-11 21:41:20 +0000 | [diff] [blame] | 3544 | } |
shane | eec556d | 2008-10-12 00:27:53 +0000 | [diff] [blame] | 3545 | #endif |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3546 | |
| 3547 | /* |
| 3548 | ** Return meta information about a specific column of a database table. |
| 3549 | ** See comment in sqlite3.h (sqlite.h.in) for details. |
| 3550 | */ |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3551 | int sqlite3_table_column_metadata( |
| 3552 | sqlite3 *db, /* Connection handle */ |
| 3553 | const char *zDbName, /* Database name or NULL */ |
| 3554 | const char *zTableName, /* Table name */ |
| 3555 | const char *zColumnName, /* Column name */ |
| 3556 | char const **pzDataType, /* OUTPUT: Declared data type */ |
| 3557 | char const **pzCollSeq, /* OUTPUT: Collation sequence name */ |
| 3558 | int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ |
| 3559 | int *pPrimaryKey, /* OUTPUT: True if column part of PK */ |
drh | 9be0716 | 2008-06-16 20:51:15 +0000 | [diff] [blame] | 3560 | int *pAutoinc /* OUTPUT: True if column is auto-increment */ |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3561 | ){ |
| 3562 | int rc; |
| 3563 | char *zErrMsg = 0; |
| 3564 | Table *pTab = 0; |
| 3565 | Column *pCol = 0; |
mistachkin | 1a51ce7 | 2015-01-12 18:38:02 +0000 | [diff] [blame] | 3566 | int iCol = 0; |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3567 | char const *zDataType = 0; |
| 3568 | char const *zCollSeq = 0; |
| 3569 | int notnull = 0; |
| 3570 | int primarykey = 0; |
| 3571 | int autoinc = 0; |
| 3572 | |
drh | 96c707a | 2015-02-13 16:36:14 +0000 | [diff] [blame] | 3573 | |
| 3574 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3575 | if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){ |
| 3576 | return SQLITE_MISUSE_BKPT; |
| 3577 | } |
| 3578 | #endif |
| 3579 | |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3580 | /* Ensure the database schema has been loaded */ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3581 | sqlite3_mutex_enter(db->mutex); |
drh | 3cb3edc | 2008-03-07 21:37:19 +0000 | [diff] [blame] | 3582 | sqlite3BtreeEnterAll(db); |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3583 | rc = sqlite3Init(db, &zErrMsg); |
| 3584 | if( SQLITE_OK!=rc ){ |
| 3585 | goto error_out; |
| 3586 | } |
| 3587 | |
| 3588 | /* Locate the table in question */ |
| 3589 | pTab = sqlite3FindTable(db, zTableName, zDbName); |
| 3590 | if( !pTab || pTab->pSelect ){ |
| 3591 | pTab = 0; |
| 3592 | goto error_out; |
| 3593 | } |
| 3594 | |
| 3595 | /* Find the column for which info is requested */ |
drh | 45d1b20 | 2014-12-09 22:24:42 +0000 | [diff] [blame] | 3596 | if( zColumnName==0 ){ |
| 3597 | /* Query for existance of table only */ |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3598 | }else{ |
| 3599 | for(iCol=0; iCol<pTab->nCol; iCol++){ |
| 3600 | pCol = &pTab->aCol[iCol]; |
| 3601 | if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){ |
| 3602 | break; |
| 3603 | } |
| 3604 | } |
| 3605 | if( iCol==pTab->nCol ){ |
drh | 45d1b20 | 2014-12-09 22:24:42 +0000 | [diff] [blame] | 3606 | if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){ |
| 3607 | iCol = pTab->iPKey; |
| 3608 | pCol = iCol>=0 ? &pTab->aCol[iCol] : 0; |
| 3609 | }else{ |
| 3610 | pTab = 0; |
| 3611 | goto error_out; |
| 3612 | } |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3613 | } |
| 3614 | } |
| 3615 | |
| 3616 | /* The following block stores the meta information that will be returned |
| 3617 | ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey |
| 3618 | ** and autoinc. At this point there are two possibilities: |
| 3619 | ** |
| 3620 | ** 1. The specified column name was rowid", "oid" or "_rowid_" |
| 3621 | ** and there is no explicitly declared IPK column. |
| 3622 | ** |
| 3623 | ** 2. The table is not a view and the column name identified an |
| 3624 | ** explicitly declared column. Copy meta information from *pCol. |
| 3625 | */ |
| 3626 | if( pCol ){ |
drh | d756486 | 2016-03-22 20:05:09 +0000 | [diff] [blame] | 3627 | zDataType = sqlite3ColumnType(pCol,0); |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3628 | zCollSeq = pCol->zColl; |
drh | 9be0716 | 2008-06-16 20:51:15 +0000 | [diff] [blame] | 3629 | notnull = pCol->notNull!=0; |
drh | a371ace | 2012-09-13 14:22:47 +0000 | [diff] [blame] | 3630 | primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0; |
drh | 7d10d5a | 2008-08-20 16:35:10 +0000 | [diff] [blame] | 3631 | autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0; |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3632 | }else{ |
| 3633 | zDataType = "INTEGER"; |
| 3634 | primarykey = 1; |
| 3635 | } |
| 3636 | if( !zCollSeq ){ |
drh | f19aa5f | 2015-12-30 16:51:20 +0000 | [diff] [blame] | 3637 | zCollSeq = sqlite3StrBINARY; |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3638 | } |
| 3639 | |
| 3640 | error_out: |
danielk1977 | 02b4e3b | 2009-02-26 07:15:59 +0000 | [diff] [blame] | 3641 | sqlite3BtreeLeaveAll(db); |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3642 | |
| 3643 | /* Whether the function call succeeded or failed, set the output parameters |
| 3644 | ** to whatever their local counterparts contain. If an error did occur, |
| 3645 | ** this has the effect of zeroing all output parameters. |
| 3646 | */ |
| 3647 | if( pzDataType ) *pzDataType = zDataType; |
| 3648 | if( pzCollSeq ) *pzCollSeq = zCollSeq; |
| 3649 | if( pNotNull ) *pNotNull = notnull; |
| 3650 | if( pPrimaryKey ) *pPrimaryKey = primarykey; |
| 3651 | if( pAutoinc ) *pAutoinc = autoinc; |
| 3652 | |
| 3653 | if( SQLITE_OK==rc && !pTab ){ |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 3654 | sqlite3DbFree(db, zErrMsg); |
drh | 118640b | 2008-07-16 14:02:32 +0000 | [diff] [blame] | 3655 | zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName, |
drh | f089aa4 | 2008-07-08 19:34:06 +0000 | [diff] [blame] | 3656 | zColumnName); |
danielk1977 | deb802c | 2006-02-09 13:43:28 +0000 | [diff] [blame] | 3657 | rc = SQLITE_ERROR; |
| 3658 | } |
drh | 13f40da | 2014-08-22 18:00:11 +0000 | [diff] [blame] | 3659 | sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg); |
drh | 633e6d5 | 2008-07-28 19:34:53 +0000 | [diff] [blame] | 3660 | sqlite3DbFree(db, zErrMsg); |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3661 | rc = sqlite3ApiExit(db, rc); |
| 3662 | sqlite3_mutex_leave(db->mutex); |
drh | f9cb7f5 | 2006-06-27 20:06:44 +0000 | [diff] [blame] | 3663 | return rc; |
| 3664 | } |
| 3665 | |
| 3666 | /* |
| 3667 | ** Sleep for a little while. Return the amount of time slept. |
| 3668 | */ |
| 3669 | int sqlite3_sleep(int ms){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 3670 | sqlite3_vfs *pVfs; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3671 | int rc; |
drh | d677b3d | 2007-08-20 22:48:41 +0000 | [diff] [blame] | 3672 | pVfs = sqlite3_vfs_find(0); |
drh | 40257ff | 2008-06-13 18:24:27 +0000 | [diff] [blame] | 3673 | if( pVfs==0 ) return 0; |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 3674 | |
| 3675 | /* This function works in milliseconds, but the underlying OsSleep() |
| 3676 | ** API uses microseconds. Hence the 1000's. |
| 3677 | */ |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3678 | rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000); |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3679 | return rc; |
drh | f9cb7f5 | 2006-06-27 20:06:44 +0000 | [diff] [blame] | 3680 | } |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 3681 | |
| 3682 | /* |
| 3683 | ** Enable or disable the extended result codes. |
| 3684 | */ |
| 3685 | int sqlite3_extended_result_codes(sqlite3 *db, int onoff){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3686 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3687 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 3688 | #endif |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3689 | sqlite3_mutex_enter(db->mutex); |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 3690 | db->errMask = onoff ? 0xffffffff : 0xff; |
drh | e30f442 | 2007-08-21 16:15:55 +0000 | [diff] [blame] | 3691 | sqlite3_mutex_leave(db->mutex); |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 3692 | return SQLITE_OK; |
| 3693 | } |
drh | cc6bb3e | 2007-08-31 16:11:35 +0000 | [diff] [blame] | 3694 | |
| 3695 | /* |
| 3696 | ** Invoke the xFileControl method on a particular database. |
| 3697 | */ |
| 3698 | int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){ |
| 3699 | int rc = SQLITE_ERROR; |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 3700 | Btree *pBtree; |
| 3701 | |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 3702 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 3703 | if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT; |
| 3704 | #endif |
drh | cc6bb3e | 2007-08-31 16:11:35 +0000 | [diff] [blame] | 3705 | sqlite3_mutex_enter(db->mutex); |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 3706 | pBtree = sqlite3DbNameToBtree(db, zDbName); |
| 3707 | if( pBtree ){ |
| 3708 | Pager *pPager; |
| 3709 | sqlite3_file *fd; |
| 3710 | sqlite3BtreeEnter(pBtree); |
| 3711 | pPager = sqlite3BtreePager(pBtree); |
| 3712 | assert( pPager!=0 ); |
| 3713 | fd = sqlite3PagerFile(pPager); |
| 3714 | assert( fd!=0 ); |
| 3715 | if( op==SQLITE_FCNTL_FILE_POINTER ){ |
| 3716 | *(sqlite3_file**)pArg = fd; |
| 3717 | rc = SQLITE_OK; |
drh | 790f287 | 2015-11-28 18:06:36 +0000 | [diff] [blame] | 3718 | }else if( op==SQLITE_FCNTL_VFS_POINTER ){ |
| 3719 | *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager); |
| 3720 | rc = SQLITE_OK; |
drh | 21d6185 | 2016-01-08 02:27:01 +0000 | [diff] [blame] | 3721 | }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){ |
| 3722 | *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager); |
| 3723 | rc = SQLITE_OK; |
drh | ea99a31 | 2018-07-18 19:09:07 +0000 | [diff] [blame] | 3724 | }else if( op==SQLITE_FCNTL_DATA_VERSION ){ |
| 3725 | *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager); |
| 3726 | rc = SQLITE_OK; |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 3727 | }else{ |
drh | afb39a4 | 2018-03-29 13:47:01 +0000 | [diff] [blame] | 3728 | rc = sqlite3OsFileControl(fd, op, pArg); |
drh | cc6bb3e | 2007-08-31 16:11:35 +0000 | [diff] [blame] | 3729 | } |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 3730 | sqlite3BtreeLeave(pBtree); |
drh | cc6bb3e | 2007-08-31 16:11:35 +0000 | [diff] [blame] | 3731 | } |
| 3732 | sqlite3_mutex_leave(db->mutex); |
drh | 883ad04 | 2015-02-19 00:29:11 +0000 | [diff] [blame] | 3733 | return rc; |
drh | cc6bb3e | 2007-08-31 16:11:35 +0000 | [diff] [blame] | 3734 | } |
drh | ed13d98 | 2008-01-31 14:43:24 +0000 | [diff] [blame] | 3735 | |
| 3736 | /* |
| 3737 | ** Interface to the testing logic. |
| 3738 | */ |
| 3739 | int sqlite3_test_control(int op, ...){ |
drh | ed13d98 | 2008-01-31 14:43:24 +0000 | [diff] [blame] | 3740 | int rc = 0; |
drh | d12602a | 2016-12-07 15:49:02 +0000 | [diff] [blame] | 3741 | #ifdef SQLITE_UNTESTABLE |
drh | f5ed7ad | 2015-06-15 14:43:25 +0000 | [diff] [blame] | 3742 | UNUSED_PARAMETER(op); |
| 3743 | #else |
drh | 2fa1868 | 2008-03-19 14:15:34 +0000 | [diff] [blame] | 3744 | va_list ap; |
drh | ed13d98 | 2008-01-31 14:43:24 +0000 | [diff] [blame] | 3745 | va_start(ap, op); |
| 3746 | switch( op ){ |
danielk1977 | d09414c | 2008-06-19 18:17:49 +0000 | [diff] [blame] | 3747 | |
| 3748 | /* |
drh | 984bfaa | 2008-03-19 16:08:53 +0000 | [diff] [blame] | 3749 | ** Save the current state of the PRNG. |
| 3750 | */ |
drh | 2fa1868 | 2008-03-19 14:15:34 +0000 | [diff] [blame] | 3751 | case SQLITE_TESTCTRL_PRNG_SAVE: { |
| 3752 | sqlite3PrngSaveState(); |
| 3753 | break; |
| 3754 | } |
drh | 984bfaa | 2008-03-19 16:08:53 +0000 | [diff] [blame] | 3755 | |
| 3756 | /* |
| 3757 | ** Restore the state of the PRNG to the last state saved using |
| 3758 | ** PRNG_SAVE. If PRNG_SAVE has never before been called, then |
| 3759 | ** this verb acts like PRNG_RESET. |
| 3760 | */ |
drh | 2fa1868 | 2008-03-19 14:15:34 +0000 | [diff] [blame] | 3761 | case SQLITE_TESTCTRL_PRNG_RESTORE: { |
| 3762 | sqlite3PrngRestoreState(); |
| 3763 | break; |
| 3764 | } |
drh | 984bfaa | 2008-03-19 16:08:53 +0000 | [diff] [blame] | 3765 | |
| 3766 | /* |
| 3767 | ** Reset the PRNG back to its uninitialized state. The next call |
| 3768 | ** to sqlite3_randomness() will reseed the PRNG using a single call |
| 3769 | ** to the xRandomness method of the default VFS. |
| 3770 | */ |
drh | 2fa1868 | 2008-03-19 14:15:34 +0000 | [diff] [blame] | 3771 | case SQLITE_TESTCTRL_PRNG_RESET: { |
drh | fe98081 | 2014-01-01 14:00:13 +0000 | [diff] [blame] | 3772 | sqlite3_randomness(0,0); |
drh | 2fa1868 | 2008-03-19 14:15:34 +0000 | [diff] [blame] | 3773 | break; |
| 3774 | } |
drh | 3088d59 | 2008-03-21 16:45:47 +0000 | [diff] [blame] | 3775 | |
| 3776 | /* |
| 3777 | ** sqlite3_test_control(BITVEC_TEST, size, program) |
| 3778 | ** |
| 3779 | ** Run a test against a Bitvec object of size. The program argument |
| 3780 | ** is an array of integers that defines the test. Return -1 on a |
| 3781 | ** memory allocation error, 0 on success, or non-zero for an error. |
| 3782 | ** See the sqlite3BitvecBuiltinTest() for additional information. |
| 3783 | */ |
| 3784 | case SQLITE_TESTCTRL_BITVEC_TEST: { |
| 3785 | int sz = va_arg(ap, int); |
| 3786 | int *aProg = va_arg(ap, int*); |
| 3787 | rc = sqlite3BitvecBuiltinTest(sz, aProg); |
| 3788 | break; |
| 3789 | } |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 3790 | |
| 3791 | /* |
drh | c007f61 | 2014-05-16 14:17:01 +0000 | [diff] [blame] | 3792 | ** sqlite3_test_control(FAULT_INSTALL, xCallback) |
| 3793 | ** |
| 3794 | ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called, |
| 3795 | ** if xCallback is not NULL. |
| 3796 | ** |
| 3797 | ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0) |
| 3798 | ** is called immediately after installing the new callback and the return |
| 3799 | ** value from sqlite3FaultSim(0) becomes the return from |
| 3800 | ** sqlite3_test_control(). |
| 3801 | */ |
| 3802 | case SQLITE_TESTCTRL_FAULT_INSTALL: { |
mistachkin | 77a90ce | 2014-05-16 23:15:50 +0000 | [diff] [blame] | 3803 | /* MSVC is picky about pulling func ptrs from va lists. |
| 3804 | ** http://support.microsoft.com/kb/47961 |
dan | 685ffb1 | 2014-06-23 10:18:50 +0000 | [diff] [blame] | 3805 | ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int)); |
mistachkin | 77a90ce | 2014-05-16 23:15:50 +0000 | [diff] [blame] | 3806 | */ |
| 3807 | typedef int(*TESTCALLBACKFUNC_t)(int); |
dan | 685ffb1 | 2014-06-23 10:18:50 +0000 | [diff] [blame] | 3808 | sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t); |
drh | c007f61 | 2014-05-16 14:17:01 +0000 | [diff] [blame] | 3809 | rc = sqlite3FaultSim(0); |
| 3810 | break; |
| 3811 | } |
| 3812 | |
| 3813 | /* |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 3814 | ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd) |
| 3815 | ** |
| 3816 | ** Register hooks to call to indicate which malloc() failures |
| 3817 | ** are benign. |
| 3818 | */ |
| 3819 | case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: { |
danielk1977 | ca02679 | 2008-06-23 14:15:52 +0000 | [diff] [blame] | 3820 | typedef void (*void_function)(void); |
| 3821 | void_function xBenignBegin; |
| 3822 | void_function xBenignEnd; |
| 3823 | xBenignBegin = va_arg(ap, void_function); |
| 3824 | xBenignEnd = va_arg(ap, void_function); |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 3825 | sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd); |
| 3826 | break; |
| 3827 | } |
drh | c7a3bb9 | 2009-02-05 16:31:45 +0000 | [diff] [blame] | 3828 | |
| 3829 | /* |
drh | f3af63f | 2009-05-09 18:59:42 +0000 | [diff] [blame] | 3830 | ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X) |
drh | c7a3bb9 | 2009-02-05 16:31:45 +0000 | [diff] [blame] | 3831 | ** |
| 3832 | ** Set the PENDING byte to the value in the argument, if X>0. |
| 3833 | ** Make no changes if X==0. Return the value of the pending byte |
| 3834 | ** as it existing before this routine was called. |
| 3835 | ** |
| 3836 | ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in |
| 3837 | ** an incompatible database file format. Changing the PENDING byte |
| 3838 | ** while any database connection is open results in undefined and |
peter.d.reid | 60ec914 | 2014-09-06 16:39:46 +0000 | [diff] [blame] | 3839 | ** deleterious behavior. |
drh | c7a3bb9 | 2009-02-05 16:31:45 +0000 | [diff] [blame] | 3840 | */ |
| 3841 | case SQLITE_TESTCTRL_PENDING_BYTE: { |
drh | f83dc1e | 2010-06-03 12:09:52 +0000 | [diff] [blame] | 3842 | rc = PENDING_BYTE; |
| 3843 | #ifndef SQLITE_OMIT_WSD |
| 3844 | { |
| 3845 | unsigned int newVal = va_arg(ap, unsigned int); |
| 3846 | if( newVal ) sqlite3PendingByte = newVal; |
| 3847 | } |
| 3848 | #endif |
drh | c7a3bb9 | 2009-02-05 16:31:45 +0000 | [diff] [blame] | 3849 | break; |
| 3850 | } |
drh | f3af63f | 2009-05-09 18:59:42 +0000 | [diff] [blame] | 3851 | |
| 3852 | /* |
| 3853 | ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X) |
| 3854 | ** |
| 3855 | ** This action provides a run-time test to see whether or not |
| 3856 | ** assert() was enabled at compile-time. If X is true and assert() |
| 3857 | ** is enabled, then the return value is true. If X is true and |
| 3858 | ** assert() is disabled, then the return value is zero. If X is |
| 3859 | ** false and assert() is enabled, then the assertion fires and the |
| 3860 | ** process aborts. If X is false and assert() is disabled, then the |
| 3861 | ** return value is zero. |
| 3862 | */ |
| 3863 | case SQLITE_TESTCTRL_ASSERT: { |
| 3864 | volatile int x = 0; |
drh | cc5f8a4 | 2016-02-06 22:32:06 +0000 | [diff] [blame] | 3865 | assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 ); |
drh | f3af63f | 2009-05-09 18:59:42 +0000 | [diff] [blame] | 3866 | rc = x; |
| 3867 | break; |
| 3868 | } |
| 3869 | |
| 3870 | |
| 3871 | /* |
| 3872 | ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X) |
| 3873 | ** |
| 3874 | ** This action provides a run-time test to see how the ALWAYS and |
| 3875 | ** NEVER macros were defined at compile-time. |
| 3876 | ** |
drh | ce2c482 | 2017-10-03 17:17:34 +0000 | [diff] [blame] | 3877 | ** The return value is ALWAYS(X) if X is true, or 0 if X is false. |
drh | f3af63f | 2009-05-09 18:59:42 +0000 | [diff] [blame] | 3878 | ** |
| 3879 | ** The recommended test is X==2. If the return value is 2, that means |
| 3880 | ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the |
| 3881 | ** default setting. If the return value is 1, then ALWAYS() is either |
| 3882 | ** hard-coded to true or else it asserts if its argument is false. |
| 3883 | ** The first behavior (hard-coded to true) is the case if |
| 3884 | ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second |
| 3885 | ** behavior (assert if the argument to ALWAYS() is false) is the case if |
| 3886 | ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled. |
| 3887 | ** |
| 3888 | ** The run-time test procedure might look something like this: |
| 3889 | ** |
| 3890 | ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){ |
| 3891 | ** // ALWAYS() and NEVER() are no-op pass-through macros |
| 3892 | ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){ |
| 3893 | ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false. |
| 3894 | ** }else{ |
| 3895 | ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0. |
| 3896 | ** } |
| 3897 | */ |
| 3898 | case SQLITE_TESTCTRL_ALWAYS: { |
| 3899 | int x = va_arg(ap,int); |
drh | ce2c482 | 2017-10-03 17:17:34 +0000 | [diff] [blame] | 3900 | rc = x ? ALWAYS(x) : 0; |
drh | f3af63f | 2009-05-09 18:59:42 +0000 | [diff] [blame] | 3901 | break; |
| 3902 | } |
drh | c046e3e | 2009-07-15 11:26:44 +0000 | [diff] [blame] | 3903 | |
drh | 2cf4acb | 2014-04-18 00:06:02 +0000 | [diff] [blame] | 3904 | /* |
| 3905 | ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER); |
| 3906 | ** |
| 3907 | ** The integer returned reveals the byte-order of the computer on which |
| 3908 | ** SQLite is running: |
| 3909 | ** |
| 3910 | ** 1 big-endian, determined at run-time |
| 3911 | ** 10 little-endian, determined at run-time |
| 3912 | ** 432101 big-endian, determined at compile-time |
| 3913 | ** 123410 little-endian, determined at compile-time |
| 3914 | */ |
| 3915 | case SQLITE_TESTCTRL_BYTEORDER: { |
| 3916 | rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN; |
| 3917 | break; |
| 3918 | } |
| 3919 | |
drh | c046e3e | 2009-07-15 11:26:44 +0000 | [diff] [blame] | 3920 | /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N) |
| 3921 | ** |
| 3922 | ** Set the nReserve size to N for the main database on the database |
| 3923 | ** connection db. |
| 3924 | */ |
| 3925 | case SQLITE_TESTCTRL_RESERVE: { |
| 3926 | sqlite3 *db = va_arg(ap, sqlite3*); |
| 3927 | int x = va_arg(ap,int); |
| 3928 | sqlite3_mutex_enter(db->mutex); |
| 3929 | sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0); |
| 3930 | sqlite3_mutex_leave(db->mutex); |
| 3931 | break; |
| 3932 | } |
| 3933 | |
drh | 07096f6 | 2009-12-22 23:52:32 +0000 | [diff] [blame] | 3934 | /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N) |
| 3935 | ** |
| 3936 | ** Enable or disable various optimizations for testing purposes. The |
| 3937 | ** argument N is a bitmask of optimizations to be disabled. For normal |
| 3938 | ** operation N should be 0. The idea is that a test program (like the |
| 3939 | ** SQL Logic Test or SLT test module) can run the same SQL multiple times |
| 3940 | ** with various optimizations disabled to verify that the same answer |
| 3941 | ** is obtained in every case. |
| 3942 | */ |
| 3943 | case SQLITE_TESTCTRL_OPTIMIZATIONS: { |
| 3944 | sqlite3 *db = va_arg(ap, sqlite3*); |
drh | a575967 | 2012-10-30 14:39:12 +0000 | [diff] [blame] | 3945 | db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff); |
drh | 07096f6 | 2009-12-22 23:52:32 +0000 | [diff] [blame] | 3946 | break; |
| 3947 | } |
| 3948 | |
dan | c17d696 | 2011-06-21 12:47:30 +0000 | [diff] [blame] | 3949 | /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff); |
| 3950 | ** |
| 3951 | ** If parameter onoff is non-zero, configure the wrappers so that all |
| 3952 | ** subsequent calls to localtime() and variants fail. If onoff is zero, |
| 3953 | ** undo this setting. |
| 3954 | */ |
| 3955 | case SQLITE_TESTCTRL_LOCALTIME_FAULT: { |
| 3956 | sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int); |
| 3957 | break; |
| 3958 | } |
| 3959 | |
drh | 09fe614 | 2013-11-29 15:06:27 +0000 | [diff] [blame] | 3960 | /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int); |
| 3961 | ** |
| 3962 | ** Set or clear a flag that indicates that the database file is always well- |
| 3963 | ** formed and never corrupt. This flag is clear by default, indicating that |
| 3964 | ** database files might have arbitrary corruption. Setting the flag during |
| 3965 | ** testing causes certain assert() statements in the code to be activated |
| 3966 | ** that demonstrat invariants on well-formed database files. |
| 3967 | */ |
| 3968 | case SQLITE_TESTCTRL_NEVER_CORRUPT: { |
dan | 9c2552f | 2014-01-28 17:49:13 +0000 | [diff] [blame] | 3969 | sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int); |
drh | 09fe614 | 2013-11-29 15:06:27 +0000 | [diff] [blame] | 3970 | break; |
| 3971 | } |
| 3972 | |
drh | 9e5eb9c | 2016-09-18 16:08:10 +0000 | [diff] [blame] | 3973 | /* Set the threshold at which OP_Once counters reset back to zero. |
mistachkin | e0736da | 2016-09-20 17:38:27 +0000 | [diff] [blame] | 3974 | ** By default this is 0x7ffffffe (over 2 billion), but that value is |
drh | 9e5eb9c | 2016-09-18 16:08:10 +0000 | [diff] [blame] | 3975 | ** too big to test in a reasonable amount of time, so this control is |
| 3976 | ** provided to set a small and easily reachable reset value. |
| 3977 | */ |
| 3978 | case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: { |
| 3979 | sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int); |
| 3980 | break; |
| 3981 | } |
drh | 688852a | 2014-02-17 22:40:43 +0000 | [diff] [blame] | 3982 | |
| 3983 | /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr); |
| 3984 | ** |
| 3985 | ** Set the VDBE coverage callback function to xCallback with context |
| 3986 | ** pointer ptr. |
| 3987 | */ |
| 3988 | case SQLITE_TESTCTRL_VDBE_COVERAGE: { |
| 3989 | #ifdef SQLITE_VDBE_COVERAGE |
drh | 7083a48 | 2018-07-10 16:04:04 +0000 | [diff] [blame] | 3990 | typedef void (*branch_callback)(void*,unsigned int, |
| 3991 | unsigned char,unsigned char); |
drh | 688852a | 2014-02-17 22:40:43 +0000 | [diff] [blame] | 3992 | sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback); |
| 3993 | sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*); |
| 3994 | #endif |
| 3995 | break; |
| 3996 | } |
| 3997 | |
dan | 8930c2a | 2014-04-03 16:25:29 +0000 | [diff] [blame] | 3998 | /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */ |
| 3999 | case SQLITE_TESTCTRL_SORTER_MMAP: { |
| 4000 | sqlite3 *db = va_arg(ap, sqlite3*); |
| 4001 | db->nMaxSorterMmap = va_arg(ap, int); |
| 4002 | break; |
| 4003 | } |
| 4004 | |
drh | 43cfc23 | 2014-07-29 14:09:21 +0000 | [diff] [blame] | 4005 | /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT); |
| 4006 | ** |
| 4007 | ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if |
| 4008 | ** not. |
| 4009 | */ |
| 4010 | case SQLITE_TESTCTRL_ISINIT: { |
| 4011 | if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR; |
| 4012 | break; |
| 4013 | } |
drh | 8964b34 | 2015-01-29 17:54:52 +0000 | [diff] [blame] | 4014 | |
drh | 3ba689d | 2015-03-03 14:00:11 +0000 | [diff] [blame] | 4015 | /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum); |
drh | 8964b34 | 2015-01-29 17:54:52 +0000 | [diff] [blame] | 4016 | ** |
drh | 1ffede8 | 2015-01-30 20:59:27 +0000 | [diff] [blame] | 4017 | ** This test control is used to create imposter tables. "db" is a pointer |
| 4018 | ** to the database connection. dbName is the database name (ex: "main" or |
| 4019 | ** "temp") which will receive the imposter. "onOff" turns imposter mode on |
| 4020 | ** or off. "tnum" is the root page of the b-tree to which the imposter |
| 4021 | ** table should connect. |
| 4022 | ** |
| 4023 | ** Enable imposter mode only when the schema has already been parsed. Then |
drh | 3ba689d | 2015-03-03 14:00:11 +0000 | [diff] [blame] | 4024 | ** run a single CREATE TABLE statement to construct the imposter table in |
| 4025 | ** the parsed schema. Then turn imposter mode back off again. |
drh | 1ffede8 | 2015-01-30 20:59:27 +0000 | [diff] [blame] | 4026 | ** |
| 4027 | ** If onOff==0 and tnum>0 then reset the schema for all databases, causing |
| 4028 | ** the schema to be reparsed the next time it is needed. This has the |
| 4029 | ** effect of erasing all imposter tables. |
drh | 8964b34 | 2015-01-29 17:54:52 +0000 | [diff] [blame] | 4030 | */ |
drh | 1ffede8 | 2015-01-30 20:59:27 +0000 | [diff] [blame] | 4031 | case SQLITE_TESTCTRL_IMPOSTER: { |
drh | 8964b34 | 2015-01-29 17:54:52 +0000 | [diff] [blame] | 4032 | sqlite3 *db = va_arg(ap, sqlite3*); |
drh | 8fb15e3 | 2015-02-04 20:56:49 +0000 | [diff] [blame] | 4033 | sqlite3_mutex_enter(db->mutex); |
drh | 1ffede8 | 2015-01-30 20:59:27 +0000 | [diff] [blame] | 4034 | db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*)); |
| 4035 | db->init.busy = db->init.imposterTable = va_arg(ap,int); |
drh | 8964b34 | 2015-01-29 17:54:52 +0000 | [diff] [blame] | 4036 | db->init.newTnum = va_arg(ap,int); |
drh | 1ffede8 | 2015-01-30 20:59:27 +0000 | [diff] [blame] | 4037 | if( db->init.busy==0 && db->init.newTnum>0 ){ |
| 4038 | sqlite3ResetAllSchemasOfConnection(db); |
| 4039 | } |
drh | 8fb15e3 | 2015-02-04 20:56:49 +0000 | [diff] [blame] | 4040 | sqlite3_mutex_leave(db->mutex); |
drh | 8964b34 | 2015-01-29 17:54:52 +0000 | [diff] [blame] | 4041 | break; |
| 4042 | } |
drh | 0d9de99 | 2017-12-26 18:04:23 +0000 | [diff] [blame] | 4043 | |
| 4044 | #if defined(YYCOVERAGE) |
| 4045 | /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out) |
| 4046 | ** |
| 4047 | ** This test control (only available when SQLite is compiled with |
| 4048 | ** -DYYCOVERAGE) writes a report onto "out" that shows all |
| 4049 | ** state/lookahead combinations in the parser state machine |
| 4050 | ** which are never exercised. If any state is missed, make the |
| 4051 | ** return code SQLITE_ERROR. |
| 4052 | */ |
| 4053 | case SQLITE_TESTCTRL_PARSER_COVERAGE: { |
| 4054 | FILE *out = va_arg(ap, FILE*); |
| 4055 | if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR; |
| 4056 | break; |
| 4057 | } |
| 4058 | #endif /* defined(YYCOVERAGE) */ |
drh | ed13d98 | 2008-01-31 14:43:24 +0000 | [diff] [blame] | 4059 | } |
| 4060 | va_end(ap); |
drh | d12602a | 2016-12-07 15:49:02 +0000 | [diff] [blame] | 4061 | #endif /* SQLITE_UNTESTABLE */ |
danielk1977 | 7c36d07 | 2008-01-31 15:31:01 +0000 | [diff] [blame] | 4062 | return rc; |
drh | ed13d98 | 2008-01-31 14:43:24 +0000 | [diff] [blame] | 4063 | } |
drh | cc487d1 | 2011-05-17 18:53:08 +0000 | [diff] [blame] | 4064 | |
| 4065 | /* |
| 4066 | ** This is a utility routine, useful to VFS implementations, that checks |
| 4067 | ** to see if a database file was a URI that contained a specific query |
| 4068 | ** parameter, and if so obtains the value of the query parameter. |
| 4069 | ** |
| 4070 | ** The zFilename argument is the filename pointer passed into the xOpen() |
| 4071 | ** method of a VFS implementation. The zParam argument is the name of the |
| 4072 | ** query parameter we seek. This routine returns the value of the zParam |
| 4073 | ** parameter if it exists. If the parameter does not exist, this routine |
| 4074 | ** returns a NULL pointer. |
| 4075 | */ |
| 4076 | const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){ |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 4077 | if( zFilename==0 || zParam==0 ) return 0; |
drh | bd69559 | 2011-05-17 19:43:38 +0000 | [diff] [blame] | 4078 | zFilename += sqlite3Strlen30(zFilename) + 1; |
drh | cc487d1 | 2011-05-17 18:53:08 +0000 | [diff] [blame] | 4079 | while( zFilename[0] ){ |
| 4080 | int x = strcmp(zFilename, zParam); |
drh | bd69559 | 2011-05-17 19:43:38 +0000 | [diff] [blame] | 4081 | zFilename += sqlite3Strlen30(zFilename) + 1; |
drh | cc487d1 | 2011-05-17 18:53:08 +0000 | [diff] [blame] | 4082 | if( x==0 ) return zFilename; |
drh | bd69559 | 2011-05-17 19:43:38 +0000 | [diff] [blame] | 4083 | zFilename += sqlite3Strlen30(zFilename) + 1; |
drh | cc487d1 | 2011-05-17 18:53:08 +0000 | [diff] [blame] | 4084 | } |
| 4085 | return 0; |
| 4086 | } |
drh | 283829c | 2011-11-17 00:56:20 +0000 | [diff] [blame] | 4087 | |
| 4088 | /* |
drh | 9291372 | 2011-12-23 00:07:33 +0000 | [diff] [blame] | 4089 | ** Return a boolean value for a query parameter. |
| 4090 | */ |
| 4091 | int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){ |
| 4092 | const char *z = sqlite3_uri_parameter(zFilename, zParam); |
drh | 38d9c61 | 2012-01-31 14:24:47 +0000 | [diff] [blame] | 4093 | bDflt = bDflt!=0; |
| 4094 | return z ? sqlite3GetBoolean(z, bDflt) : bDflt; |
drh | 9291372 | 2011-12-23 00:07:33 +0000 | [diff] [blame] | 4095 | } |
| 4096 | |
| 4097 | /* |
| 4098 | ** Return a 64-bit integer value for a query parameter. |
| 4099 | */ |
| 4100 | sqlite3_int64 sqlite3_uri_int64( |
| 4101 | const char *zFilename, /* Filename as passed to xOpen */ |
| 4102 | const char *zParam, /* URI parameter sought */ |
| 4103 | sqlite3_int64 bDflt /* return if parameter is missing */ |
| 4104 | ){ |
| 4105 | const char *z = sqlite3_uri_parameter(zFilename, zParam); |
| 4106 | sqlite3_int64 v; |
drh | 84d4f1a | 2017-09-20 10:47:10 +0000 | [diff] [blame] | 4107 | if( z && sqlite3DecOrHexToI64(z, &v)==0 ){ |
drh | 9291372 | 2011-12-23 00:07:33 +0000 | [diff] [blame] | 4108 | bDflt = v; |
| 4109 | } |
| 4110 | return bDflt; |
| 4111 | } |
| 4112 | |
| 4113 | /* |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 4114 | ** Return the Btree pointer identified by zDbName. Return NULL if not found. |
| 4115 | */ |
| 4116 | Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){ |
drh | 2951809 | 2016-12-24 19:37:16 +0000 | [diff] [blame] | 4117 | int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0; |
| 4118 | return iDb<0 ? 0 : db->aDb[iDb].pBt; |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 4119 | } |
| 4120 | |
| 4121 | /* |
drh | 283829c | 2011-11-17 00:56:20 +0000 | [diff] [blame] | 4122 | ** Return the filename of the database associated with a database |
| 4123 | ** connection. |
| 4124 | */ |
| 4125 | const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){ |
mistachkin | cd54bab | 2014-12-20 21:14:14 +0000 | [diff] [blame] | 4126 | Btree *pBt; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 4127 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 4128 | if( !sqlite3SafetyCheckOk(db) ){ |
| 4129 | (void)SQLITE_MISUSE_BKPT; |
| 4130 | return 0; |
| 4131 | } |
| 4132 | #endif |
mistachkin | cd54bab | 2014-12-20 21:14:14 +0000 | [diff] [blame] | 4133 | pBt = sqlite3DbNameToBtree(db, zDbName); |
drh | 421377e | 2012-03-15 21:28:54 +0000 | [diff] [blame] | 4134 | return pBt ? sqlite3BtreeGetFilename(pBt) : 0; |
| 4135 | } |
| 4136 | |
| 4137 | /* |
| 4138 | ** Return 1 if database is read-only or 0 if read/write. Return -1 if |
| 4139 | ** no such database exists. |
| 4140 | */ |
| 4141 | int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){ |
mistachkin | cd54bab | 2014-12-20 21:14:14 +0000 | [diff] [blame] | 4142 | Btree *pBt; |
drh | 9ca9573 | 2014-10-24 00:35:58 +0000 | [diff] [blame] | 4143 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 4144 | if( !sqlite3SafetyCheckOk(db) ){ |
| 4145 | (void)SQLITE_MISUSE_BKPT; |
| 4146 | return -1; |
| 4147 | } |
| 4148 | #endif |
mistachkin | cd54bab | 2014-12-20 21:14:14 +0000 | [diff] [blame] | 4149 | pBt = sqlite3DbNameToBtree(db, zDbName); |
drh | 781597f | 2014-05-21 08:21:07 +0000 | [diff] [blame] | 4150 | return pBt ? sqlite3BtreeIsReadonly(pBt) : -1; |
drh | 283829c | 2011-11-17 00:56:20 +0000 | [diff] [blame] | 4151 | } |
dan | fc1acf3 | 2015-12-05 20:51:54 +0000 | [diff] [blame] | 4152 | |
| 4153 | #ifdef SQLITE_ENABLE_SNAPSHOT |
| 4154 | /* |
| 4155 | ** Obtain a snapshot handle for the snapshot of database zDb currently |
| 4156 | ** being read by handle db. |
| 4157 | */ |
| 4158 | int sqlite3_snapshot_get( |
| 4159 | sqlite3 *db, |
| 4160 | const char *zDb, |
| 4161 | sqlite3_snapshot **ppSnapshot |
| 4162 | ){ |
| 4163 | int rc = SQLITE_ERROR; |
| 4164 | #ifndef SQLITE_OMIT_WAL |
dan | fc1acf3 | 2015-12-05 20:51:54 +0000 | [diff] [blame] | 4165 | |
| 4166 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 4167 | if( !sqlite3SafetyCheckOk(db) ){ |
| 4168 | return SQLITE_MISUSE_BKPT; |
| 4169 | } |
| 4170 | #endif |
| 4171 | sqlite3_mutex_enter(db->mutex); |
| 4172 | |
dan | edace5d | 2016-11-18 18:43:39 +0000 | [diff] [blame] | 4173 | if( db->autoCommit==0 ){ |
| 4174 | int iDb = sqlite3FindDbName(db, zDb); |
| 4175 | if( iDb==0 || iDb>1 ){ |
| 4176 | Btree *pBt = db->aDb[iDb].pBt; |
| 4177 | if( 0==sqlite3BtreeIsInTrans(pBt) ){ |
drh | 685a50a | 2018-06-06 18:50:50 +0000 | [diff] [blame] | 4178 | rc = sqlite3BtreeBeginTrans(pBt, 0, 0); |
dan | edace5d | 2016-11-18 18:43:39 +0000 | [diff] [blame] | 4179 | if( rc==SQLITE_OK ){ |
| 4180 | rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot); |
| 4181 | } |
dan | 7116dc6 | 2015-12-10 20:03:08 +0000 | [diff] [blame] | 4182 | } |
dan | fc1acf3 | 2015-12-05 20:51:54 +0000 | [diff] [blame] | 4183 | } |
| 4184 | } |
| 4185 | |
| 4186 | sqlite3_mutex_leave(db->mutex); |
| 4187 | #endif /* SQLITE_OMIT_WAL */ |
| 4188 | return rc; |
| 4189 | } |
| 4190 | |
| 4191 | /* |
| 4192 | ** Open a read-transaction on the snapshot idendified by pSnapshot. |
| 4193 | */ |
| 4194 | int sqlite3_snapshot_open( |
| 4195 | sqlite3 *db, |
| 4196 | const char *zDb, |
| 4197 | sqlite3_snapshot *pSnapshot |
| 4198 | ){ |
| 4199 | int rc = SQLITE_ERROR; |
| 4200 | #ifndef SQLITE_OMIT_WAL |
| 4201 | |
| 4202 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 4203 | if( !sqlite3SafetyCheckOk(db) ){ |
| 4204 | return SQLITE_MISUSE_BKPT; |
| 4205 | } |
| 4206 | #endif |
| 4207 | sqlite3_mutex_enter(db->mutex); |
| 4208 | if( db->autoCommit==0 ){ |
| 4209 | int iDb; |
| 4210 | iDb = sqlite3FindDbName(db, zDb); |
| 4211 | if( iDb==0 || iDb>1 ){ |
| 4212 | Btree *pBt = db->aDb[iDb].pBt; |
dan | fa3d4c1 | 2018-08-06 17:12:36 +0000 | [diff] [blame] | 4213 | if( sqlite3BtreeIsInTrans(pBt)==0 ){ |
| 4214 | Pager *pPager = sqlite3BtreePager(pBt); |
| 4215 | int bUnlock = 0; |
| 4216 | if( sqlite3BtreeIsInReadTrans(pBt) ){ |
| 4217 | if( db->nVdbeActive==0 ){ |
| 4218 | rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot); |
| 4219 | if( rc==SQLITE_OK ){ |
| 4220 | bUnlock = 1; |
| 4221 | rc = sqlite3BtreeCommit(pBt); |
| 4222 | } |
| 4223 | } |
| 4224 | }else{ |
| 4225 | rc = SQLITE_OK; |
| 4226 | } |
| 4227 | if( rc==SQLITE_OK ){ |
| 4228 | rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot); |
| 4229 | } |
dan | fc1acf3 | 2015-12-05 20:51:54 +0000 | [diff] [blame] | 4230 | if( rc==SQLITE_OK ){ |
drh | 685a50a | 2018-06-06 18:50:50 +0000 | [diff] [blame] | 4231 | rc = sqlite3BtreeBeginTrans(pBt, 0, 0); |
dan | fa3d4c1 | 2018-08-06 17:12:36 +0000 | [diff] [blame] | 4232 | sqlite3PagerSnapshotOpen(pPager, 0); |
| 4233 | } |
| 4234 | if( bUnlock ){ |
| 4235 | sqlite3PagerSnapshotUnlock(pPager); |
dan | fc1acf3 | 2015-12-05 20:51:54 +0000 | [diff] [blame] | 4236 | } |
| 4237 | } |
| 4238 | } |
| 4239 | } |
| 4240 | |
| 4241 | sqlite3_mutex_leave(db->mutex); |
| 4242 | #endif /* SQLITE_OMIT_WAL */ |
| 4243 | return rc; |
| 4244 | } |
| 4245 | |
| 4246 | /* |
dan | 1158498 | 2016-11-18 20:49:43 +0000 | [diff] [blame] | 4247 | ** Recover as many snapshots as possible from the wal file associated with |
| 4248 | ** schema zDb of database db. |
| 4249 | */ |
| 4250 | int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){ |
| 4251 | int rc = SQLITE_ERROR; |
| 4252 | int iDb; |
| 4253 | #ifndef SQLITE_OMIT_WAL |
| 4254 | |
| 4255 | #ifdef SQLITE_ENABLE_API_ARMOR |
| 4256 | if( !sqlite3SafetyCheckOk(db) ){ |
| 4257 | return SQLITE_MISUSE_BKPT; |
| 4258 | } |
| 4259 | #endif |
| 4260 | |
| 4261 | sqlite3_mutex_enter(db->mutex); |
| 4262 | iDb = sqlite3FindDbName(db, zDb); |
| 4263 | if( iDb==0 || iDb>1 ){ |
| 4264 | Btree *pBt = db->aDb[iDb].pBt; |
| 4265 | if( 0==sqlite3BtreeIsInReadTrans(pBt) ){ |
drh | 685a50a | 2018-06-06 18:50:50 +0000 | [diff] [blame] | 4266 | rc = sqlite3BtreeBeginTrans(pBt, 0, 0); |
dan | 93f5113 | 2016-11-19 18:31:37 +0000 | [diff] [blame] | 4267 | if( rc==SQLITE_OK ){ |
| 4268 | rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt)); |
| 4269 | sqlite3BtreeCommit(pBt); |
| 4270 | } |
dan | 1158498 | 2016-11-18 20:49:43 +0000 | [diff] [blame] | 4271 | } |
| 4272 | } |
| 4273 | sqlite3_mutex_leave(db->mutex); |
| 4274 | #endif /* SQLITE_OMIT_WAL */ |
| 4275 | return rc; |
| 4276 | } |
| 4277 | |
| 4278 | /* |
dan | fc1acf3 | 2015-12-05 20:51:54 +0000 | [diff] [blame] | 4279 | ** Free a snapshot handle obtained from sqlite3_snapshot_get(). |
| 4280 | */ |
| 4281 | void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){ |
| 4282 | sqlite3_free(pSnapshot); |
| 4283 | } |
| 4284 | #endif /* SQLITE_ENABLE_SNAPSHOT */ |
dan | da1f49b | 2017-06-16 19:51:47 +0000 | [diff] [blame] | 4285 | |
| 4286 | #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS |
| 4287 | /* |
| 4288 | ** Given the name of a compile-time option, return true if that option |
| 4289 | ** was used and false if not. |
| 4290 | ** |
| 4291 | ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix |
| 4292 | ** is not required for a match. |
| 4293 | */ |
| 4294 | int sqlite3_compileoption_used(const char *zOptName){ |
| 4295 | int i, n; |
| 4296 | int nOpt; |
| 4297 | const char **azCompileOpt; |
| 4298 | |
| 4299 | #if SQLITE_ENABLE_API_ARMOR |
| 4300 | if( zOptName==0 ){ |
| 4301 | (void)SQLITE_MISUSE_BKPT; |
| 4302 | return 0; |
| 4303 | } |
| 4304 | #endif |
| 4305 | |
| 4306 | azCompileOpt = sqlite3CompileOptions(&nOpt); |
| 4307 | |
| 4308 | if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7; |
| 4309 | n = sqlite3Strlen30(zOptName); |
| 4310 | |
| 4311 | /* Since nOpt is normally in single digits, a linear search is |
| 4312 | ** adequate. No need for a binary search. */ |
| 4313 | for(i=0; i<nOpt; i++){ |
| 4314 | if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0 |
| 4315 | && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0 |
| 4316 | ){ |
| 4317 | return 1; |
| 4318 | } |
| 4319 | } |
| 4320 | return 0; |
| 4321 | } |
| 4322 | |
| 4323 | /* |
| 4324 | ** Return the N-th compile-time option string. If N is out of range, |
| 4325 | ** return a NULL pointer. |
| 4326 | */ |
| 4327 | const char *sqlite3_compileoption_get(int N){ |
| 4328 | int nOpt; |
| 4329 | const char **azCompileOpt; |
| 4330 | azCompileOpt = sqlite3CompileOptions(&nOpt); |
| 4331 | if( N>=0 && N<nOpt ){ |
| 4332 | return azCompileOpt[N]; |
| 4333 | } |
| 4334 | return 0; |
| 4335 | } |
| 4336 | #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */ |