tkeyvfs.h File Reference

#include "TFile.h"
#include <sqlite3.h>

Go to the source code of this file.

Functions
int	tkeyvfs_init (void)
int	tkeyvfs_open_v2 (const char *filename, sqlite3 **ppDb, int flags, TFile *rootFile)

Function Documentation

int tkeyvfs_init

(

void

)

Definition at line 1768 of file tkeyvfs.cc.

References ArraySize, aSyscall, nolockIoFinder, and UNIXVFS.

Referenced by art::completeRootHandlers(), and main().

{
/*
** The following macro defines an initializer for an sqlite3_vfs object.
** The name of the VFS is NAME.  The pAppData is a pointer to a pointer
** to the "finder" function.  (pAppData is a pointer to a pointer because
** silly C90 rules prohibit a void* from being cast to a function pointer
** and so we have to go through the intermediate pointer to avoid problems
** when compiling with -pedantic-errors on GCC.)
**
** The FINDER parameter to this macro is the name of the pointer to the
** finder-function.  The finder-function returns a pointer to the
** sqlite_io_methods object that implements the desired locking
** behaviors.  See the division above that contains the IOMETHODS
** macro for addition information on finder-functions.
**
** Most finders simply return a pointer to a fixed sqlite3_io_methods
** object.  But the "autolockIoFinder" available on MacOSX does a little
** more than that; it looks at the filesystem type that hosts the
** database file and tries to choose an locking method appropriate for
** that filesystem time.
*/
#define UNIXVFS(VFSNAME, FINDER)                                               \
  {                                                                            \
    1,                  /* iVersion */                                         \
      sizeof(unixFile), /* szOsFile */                                         \
      MAX_PATHNAME,     /* mxPathname */                                       \
      0,                /* pNext */                                            \
      VFSNAME,          /* zName */                                            \
      (void*)&FINDER,   /* pAppData */                                         \
      unixOpen,         /* xOpen */                                            \
      unixDelete,       /* xDelete */                                          \
      unixAccess,       /* xAccess */                                          \
      unixFullPathname, /* xFullPathname */                                    \
      unixDlOpen,       /* xDlOpen */                                          \
      unixDlError,      /* xDlError */                                         \
      unixDlSym,        /* xDlSym */                                           \
      unixDlClose,      /* xDlClose */                                         \
      unixRandomness,   /* xRandomness */                                      \
      unixSleep,        /* xSleep */                                           \
      unixCurrentTime,  /* xCurrentTime */                                     \
      unixGetLastError, /* xGetLastError */                                    \
    /* unixCurrentTimeInt64, v2, xCurrentTimeInt64 */                          \
    /* unixSetSystemCall,    v3, xSetSystemCall */                             \
    /* unixGetSystemCall,    v3, xGetSystemCall */                             \
    /* unixNextSystemCall,   v3, xNextSystemCall */                            \
  }
  /*
  ** All default VFSes for unix are contained in the following array.
  **
  ** Note that the sqlite3_vfs.pNext field of the VFS object is modified
  ** by the SQLite core when the VFS is registered.  So the following
  ** array cannot be const.
  */
  static sqlite3_vfs aVfs[] = {
    UNIXVFS("tkeyvfs", nolockIoFinder),
  };
  unsigned int i; /* Loop counter */
  /* Double-check that the aSyscall[] array has been constructed
  ** correctly.  See ticket [bb3a86e890c8e96ab] */
  assert(ArraySize(aSyscall) == 16);
  /* Register all VFSes defined in the aVfs[] array */
  for (i = 0; i < (sizeof(aVfs) / sizeof(sqlite3_vfs)); i++) {
    sqlite3_vfs_register(&aVfs[i], 0);
  }
  return SQLITE_OK;
}

int tkeyvfs_open_v2	(	const char *	filename,
		sqlite3 **	ppDb,
		int	flags,
		TFile *	rootFile
	)

Definition at line 1837 of file tkeyvfs.cc.

References unixFile::rootFile.

Referenced by art::SQLite3Wrapper::initDB(), and art::TKeyVFSOpenPolicy::open().

{
#ifndef TKEYVFS_NO_ROOT
  RootFileSentry rfs(rootFile);
  // Note that the sentry *is* the correct thing to do, here:
  // gRootFile is required in unixOpen(), which is called as part of
  // the chain of functions of which sqlite3_open_v2() is the first
  // call. By the time we return from sqlite3_open_v2() then, we no
  // longer require gRootFile and the sentry can do the job of
  // cleaning up when it goes out of scope.
#endif // TKEYVFS_NO_ROOT
  return sqlite3_open_v2(filename,
                         ppDb,
                         flags,
#ifdef TKEYVFS_NO_ROOT
                         nullptr
#else
                         "tkeyvfs"
#endif
  );
}