/ Artifact Content
Login

Artifact c1e97e4c6fffff1fb1a6f1c48807386819af78657b4ae4acfd6d6d17353b8277:


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