| 1 |
/* |
| 2 |
** 2018-09-27 |
| 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 |
** |
| 13 |
** This file demonstrates an eponymous virtual table that returns information |
| 14 |
** from sqlite3_status64() and sqlite3_db_status(). |
| 15 |
** |
| 16 |
** Usage example: |
| 17 |
** |
| 18 |
** .load ./memstat |
| 19 |
** .mode quote |
| 20 |
** .header on |
| 21 |
** SELECT * FROM memstat; |
| 22 |
*/ |
| 23 |
#if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_MEMSTATVTAB) |
| 24 |
#if !defined(SQLITEINT_H) |
| 25 |
#include "sqlite3ext.h" |
| 26 |
#endif |
| 27 |
SQLITE_EXTENSION_INIT1 |
| 28 |
#include <assert.h> |
| 29 |
#include <string.h> |
| 30 |
|
| 31 |
#ifndef SQLITE_OMIT_VIRTUALTABLE |
| 32 |
|
| 33 |
/* memstat_vtab is a subclass of sqlite3_vtab which will |
| 34 |
** serve as the underlying representation of a memstat virtual table |
| 35 |
*/ |
| 36 |
typedef struct memstat_vtab memstat_vtab; |
| 37 |
struct memstat_vtab { |
| 38 |
sqlite3_vtab base; /* Base class - must be first */ |
| 39 |
sqlite3 *db; /* Database connection for this memstat vtab */ |
| 40 |
}; |
| 41 |
|
| 42 |
/* memstat_cursor is a subclass of sqlite3_vtab_cursor which will |
| 43 |
** serve as the underlying representation of a cursor that scans |
| 44 |
** over rows of the result |
| 45 |
*/ |
| 46 |
typedef struct memstat_cursor memstat_cursor; |
| 47 |
struct memstat_cursor { |
| 48 |
sqlite3_vtab_cursor base; /* Base class - must be first */ |
| 49 |
sqlite3 *db; /* Database connection for this cursor */ |
| 50 |
int iRowid; /* Current row in aMemstatColumn[] */ |
| 51 |
int iDb; /* Which schema we are looking at */ |
| 52 |
int nDb; /* Number of schemas */ |
| 53 |
char **azDb; /* Names of all schemas */ |
| 54 |
sqlite3_int64 aVal[2]; /* Result values */ |
| 55 |
}; |
| 56 |
|
| 57 |
/* |
| 58 |
** The memstatConnect() method is invoked to create a new |
| 59 |
** memstat_vtab that describes the memstat virtual table. |
| 60 |
** |
| 61 |
** Think of this routine as the constructor for memstat_vtab objects. |
| 62 |
** |
| 63 |
** All this routine needs to do is: |
| 64 |
** |
| 65 |
** (1) Allocate the memstat_vtab object and initialize all fields. |
| 66 |
** |
| 67 |
** (2) Tell SQLite (via the sqlite3_declare_vtab() interface) what the |
| 68 |
** result set of queries against memstat will look like. |
| 69 |
*/ |
| 70 |
static int memstatConnect( |
| 71 |
sqlite3 *db, |
| 72 |
void *pAux, |
| 73 |
int argc, const char *const*argv, |
| 74 |
sqlite3_vtab **ppVtab, |
| 75 |
char **pzErr |
| 76 |
){ |
| 77 |
memstat_vtab *pNew; |
| 78 |
int rc; |
| 79 |
|
| 80 |
/* Column numbers */ |
| 81 |
#define MSV_COLUMN_NAME 0 /* Name of quantity being measured */ |
| 82 |
#define MSV_COLUMN_SCHEMA 1 /* schema name */ |
| 83 |
#define MSV_COLUMN_VALUE 2 /* Current value */ |
| 84 |
#define MSV_COLUMN_HIWTR 3 /* Highwater mark */ |
| 85 |
|
| 86 |
rc = sqlite3_declare_vtab(db,"CREATE TABLE x(name,schema,value,hiwtr)"); |
| 87 |
if( rc==SQLITE_OK ){ |
| 88 |
pNew = sqlite3_malloc64( sizeof(*pNew) ); |
| 89 |
*ppVtab = (sqlite3_vtab*)pNew; |
| 90 |
if( pNew==0 ) return SQLITE_NOMEM; |
| 91 |
memset(pNew, 0, sizeof(*pNew)); |
| 92 |
pNew->db = db; |
| 93 |
} |
| 94 |
return rc; |
| 95 |
} |
| 96 |
|
| 97 |
/* |
| 98 |
** This method is the destructor for memstat_cursor objects. |
| 99 |
*/ |
| 100 |
static int memstatDisconnect(sqlite3_vtab *pVtab){ |
| 101 |
sqlite3_free(pVtab); |
| 102 |
return SQLITE_OK; |
| 103 |
} |
| 104 |
|
| 105 |
/* |
| 106 |
** Constructor for a new memstat_cursor object. |
| 107 |
*/ |
| 108 |
static int memstatOpen(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){ |
| 109 |
memstat_cursor *pCur; |
| 110 |
pCur = sqlite3_malloc64( sizeof(*pCur) ); |
| 111 |
if( pCur==0 ) return SQLITE_NOMEM; |
| 112 |
memset(pCur, 0, sizeof(*pCur)); |
| 113 |
pCur->db = ((memstat_vtab*)p)->db; |
| 114 |
*ppCursor = &pCur->base; |
| 115 |
return SQLITE_OK; |
| 116 |
} |
| 117 |
|
| 118 |
/* |
| 119 |
** Clear all the schema names from a cursor |
| 120 |
*/ |
| 121 |
static void memstatClearSchema(memstat_cursor *pCur){ |
| 122 |
int i; |
| 123 |
if( pCur->azDb==0 ) return; |
| 124 |
for(i=0; i<pCur->nDb; i++){ |
| 125 |
sqlite3_free(pCur->azDb[i]); |
| 126 |
} |
| 127 |
sqlite3_free(pCur->azDb); |
| 128 |
pCur->azDb = 0; |
| 129 |
pCur->nDb = 0; |
| 130 |
} |
| 131 |
|
| 132 |
/* |
| 133 |
** Fill in the azDb[] array for the cursor. |
| 134 |
*/ |
| 135 |
static int memstatFindSchemas(memstat_cursor *pCur){ |
| 136 |
sqlite3_stmt *pStmt = 0; |
| 137 |
int rc; |
| 138 |
if( pCur->nDb ) return SQLITE_OK; |
| 139 |
rc = sqlite3_prepare_v2(pCur->db, "PRAGMA database_list", -1, &pStmt, 0); |
| 140 |
if( rc ){ |
| 141 |
sqlite3_finalize(pStmt); |
| 142 |
return rc; |
| 143 |
} |
| 144 |
while( sqlite3_step(pStmt)==SQLITE_ROW ){ |
| 145 |
char **az, *z; |
| 146 |
az = sqlite3_realloc64(pCur->azDb, sizeof(char*)*(pCur->nDb+1)); |
| 147 |
if( az==0 ){ |
| 148 |
memstatClearSchema(pCur); |
| 149 |
return SQLITE_NOMEM; |
| 150 |
} |
| 151 |
pCur->azDb = az; |
| 152 |
z = sqlite3_mprintf("%s", sqlite3_column_text(pStmt, 1)); |
| 153 |
if( z==0 ){ |
| 154 |
memstatClearSchema(pCur); |
| 155 |
return SQLITE_NOMEM; |
| 156 |
} |
| 157 |
pCur->azDb[pCur->nDb] = z; |
| 158 |
pCur->nDb++; |
| 159 |
} |
| 160 |
sqlite3_finalize(pStmt); |
| 161 |
return SQLITE_OK; |
| 162 |
} |
| 163 |
|
| 164 |
|
| 165 |
/* |
| 166 |
** Destructor for a memstat_cursor. |
| 167 |
*/ |
| 168 |
static int memstatClose(sqlite3_vtab_cursor *cur){ |
| 169 |
memstat_cursor *pCur = (memstat_cursor*)cur; |
| 170 |
memstatClearSchema(pCur); |
| 171 |
sqlite3_free(cur); |
| 172 |
return SQLITE_OK; |
| 173 |
} |
| 174 |
|
| 175 |
|
| 176 |
/* |
| 177 |
** Allowed values for aMemstatColumn[].eType |
| 178 |
*/ |
| 179 |
#define MSV_GSTAT 0 /* sqlite3_status64() information */ |
| 180 |
#define MSV_DB 1 /* sqlite3_db_status() information */ |
| 181 |
#define MSV_ZIPVFS 2 /* ZIPVFS file-control with 64-bit return */ |
| 182 |
|
| 183 |
/* |
| 184 |
** An array of quantities that can be measured and reported by |
| 185 |
** this virtual table |
| 186 |
*/ |
| 187 |
static const struct MemstatColumns { |
| 188 |
const char *zName; /* Symbolic name */ |
| 189 |
unsigned char eType; /* Type of interface */ |
| 190 |
unsigned char mNull; /* Bitmask of which columns are NULL */ |
| 191 |
/* 2: dbname, 4: current, 8: hiwtr */ |
| 192 |
int eOp; /* Opcode */ |
| 193 |
} aMemstatColumn[] = { |
| 194 |
{"MEMORY_USED", MSV_GSTAT, 2, SQLITE_STATUS_MEMORY_USED }, |
| 195 |
{"MALLOC_SIZE", MSV_GSTAT, 6, SQLITE_STATUS_MALLOC_SIZE }, |
| 196 |
{"MALLOC_COUNT", MSV_GSTAT, 2, SQLITE_STATUS_MALLOC_COUNT }, |
| 197 |
{"PAGECACHE_USED", MSV_GSTAT, 2, SQLITE_STATUS_PAGECACHE_USED }, |
| 198 |
{"PAGECACHE_OVERFLOW", MSV_GSTAT, 2, SQLITE_STATUS_PAGECACHE_OVERFLOW }, |
| 199 |
{"PAGECACHE_SIZE", MSV_GSTAT, 6, SQLITE_STATUS_PAGECACHE_SIZE }, |
| 200 |
{"PARSER_STACK", MSV_GSTAT, 6, SQLITE_STATUS_PARSER_STACK }, |
| 201 |
{"DB_LOOKASIDE_USED", MSV_DB, 2, SQLITE_DBSTATUS_LOOKASIDE_USED }, |
| 202 |
{"DB_LOOKASIDE_HIT", MSV_DB, 6, SQLITE_DBSTATUS_LOOKASIDE_HIT }, |
| 203 |
{"DB_LOOKASIDE_MISS_SIZE", MSV_DB, 6, SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE}, |
| 204 |
{"DB_LOOKASIDE_MISS_FULL", MSV_DB, 6, SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL}, |
| 205 |
{"DB_CACHE_USED", MSV_DB, 10, SQLITE_DBSTATUS_CACHE_USED }, |
| 206 |
#if SQLITE_VERSION_NUMBER >= 3140000 |
| 207 |
{"DB_CACHE_USED_SHARED", MSV_DB, 10, SQLITE_DBSTATUS_CACHE_USED_SHARED }, |
| 208 |
#endif |
| 209 |
{"DB_SCHEMA_USED", MSV_DB, 10, SQLITE_DBSTATUS_SCHEMA_USED }, |
| 210 |
{"DB_STMT_USED", MSV_DB, 10, SQLITE_DBSTATUS_STMT_USED }, |
| 211 |
{"DB_CACHE_HIT", MSV_DB, 10, SQLITE_DBSTATUS_CACHE_HIT }, |
| 212 |
{"DB_CACHE_MISS", MSV_DB, 10, SQLITE_DBSTATUS_CACHE_MISS }, |
| 213 |
{"DB_CACHE_WRITE", MSV_DB, 10, SQLITE_DBSTATUS_CACHE_WRITE }, |
| 214 |
#if SQLITE_VERSION_NUMBER >= 3230000 |
| 215 |
{"DB_CACHE_SPILL", MSV_DB, 10, SQLITE_DBSTATUS_CACHE_SPILL }, |
| 216 |
#endif |
| 217 |
{"DB_DEFERRED_FKS", MSV_DB, 10, SQLITE_DBSTATUS_DEFERRED_FKS }, |
| 218 |
#ifdef SQLITE_ENABLE_ZIPVFS |
| 219 |
{"ZIPVFS_CACHE_USED", MSV_ZIPVFS, 8, 231454 }, |
| 220 |
{"ZIPVFS_CACHE_HIT", MSV_ZIPVFS, 8, 231455 }, |
| 221 |
{"ZIPVFS_CACHE_MISS", MSV_ZIPVFS, 8, 231456 }, |
| 222 |
{"ZIPVFS_CACHE_WRITE", MSV_ZIPVFS, 8, 231457 }, |
| 223 |
{"ZIPVFS_DIRECT_READ", MSV_ZIPVFS, 8, 231458 }, |
| 224 |
{"ZIPVFS_DIRECT_BYTES", MSV_ZIPVFS, 8, 231459 }, |
| 225 |
#endif /* SQLITE_ENABLE_ZIPVFS */ |
| 226 |
}; |
| 227 |
#define MSV_NROW (sizeof(aMemstatColumn)/sizeof(aMemstatColumn[0])) |
| 228 |
|
| 229 |
/* |
| 230 |
** Advance a memstat_cursor to its next row of output. |
| 231 |
*/ |
| 232 |
static int memstatNext(sqlite3_vtab_cursor *cur){ |
| 233 |
memstat_cursor *pCur = (memstat_cursor*)cur; |
| 234 |
int i; |
| 235 |
assert( pCur->iRowid<=MSV_NROW ); |
| 236 |
while(1){ |
| 237 |
i = (int)pCur->iRowid - 1; |
| 238 |
if( i<0 || (aMemstatColumn[i].mNull & 2)!=0 || (++pCur->iDb)>=pCur->nDb ){ |
| 239 |
pCur->iRowid++; |
| 240 |
if( pCur->iRowid>MSV_NROW ) return SQLITE_OK; /* End of the table */ |
| 241 |
pCur->iDb = 0; |
| 242 |
i++; |
| 243 |
} |
| 244 |
pCur->aVal[0] = 0; |
| 245 |
pCur->aVal[1] = 0; |
| 246 |
switch( aMemstatColumn[i].eType ){ |
| 247 |
case MSV_GSTAT: { |
| 248 |
if( sqlite3_libversion_number()>=3010000 ){ |
| 249 |
sqlite3_status64(aMemstatColumn[i].eOp, |
| 250 |
&pCur->aVal[0], &pCur->aVal[1],0); |
| 251 |
}else{ |
| 252 |
int xCur, xHiwtr; |
| 253 |
sqlite3_status(aMemstatColumn[i].eOp, &xCur, &xHiwtr, 0); |
| 254 |
pCur->aVal[0] = xCur; |
| 255 |
pCur->aVal[1] = xHiwtr; |
| 256 |
} |
| 257 |
break; |
| 258 |
} |
| 259 |
case MSV_DB: { |
| 260 |
int xCur, xHiwtr; |
| 261 |
sqlite3_db_status(pCur->db, aMemstatColumn[i].eOp, &xCur, &xHiwtr, 0); |
| 262 |
pCur->aVal[0] = xCur; |
| 263 |
pCur->aVal[1] = xHiwtr; |
| 264 |
break; |
| 265 |
} |
| 266 |
case MSV_ZIPVFS: { |
| 267 |
int rc; |
| 268 |
rc = sqlite3_file_control(pCur->db, pCur->azDb[pCur->iDb], |
| 269 |
aMemstatColumn[i].eOp, (void*)&pCur->aVal[0]); |
| 270 |
if( rc!=SQLITE_OK ) continue; |
| 271 |
break; |
| 272 |
} |
| 273 |
} |
| 274 |
break; |
| 275 |
} |
| 276 |
return SQLITE_OK; |
| 277 |
} |
| 278 |
|
| 279 |
|
| 280 |
/* |
| 281 |
** Return values of columns for the row at which the memstat_cursor |
| 282 |
** is currently pointing. |
| 283 |
*/ |
| 284 |
static int memstatColumn( |
| 285 |
sqlite3_vtab_cursor *cur, /* The cursor */ |
| 286 |
sqlite3_context *ctx, /* First argument to sqlite3_result_...() */ |
| 287 |
int iCol /* Which column to return */ |
| 288 |
){ |
| 289 |
memstat_cursor *pCur = (memstat_cursor*)cur; |
| 290 |
int i; |
| 291 |
assert( pCur->iRowid>0 && pCur->iRowid<=MSV_NROW ); |
| 292 |
i = (int)pCur->iRowid - 1; |
| 293 |
if( (aMemstatColumn[i].mNull & (1<<iCol))!=0 ){ |
| 294 |
return SQLITE_OK; |
| 295 |
} |
| 296 |
switch( iCol ){ |
| 297 |
case MSV_COLUMN_NAME: { |
| 298 |
sqlite3_result_text(ctx, aMemstatColumn[i].zName, -1, SQLITE_STATIC); |
| 299 |
break; |
| 300 |
} |
| 301 |
case MSV_COLUMN_SCHEMA: { |
| 302 |
sqlite3_result_text(ctx, pCur->azDb[pCur->iDb], -1, 0); |
| 303 |
break; |
| 304 |
} |
| 305 |
case MSV_COLUMN_VALUE: { |
| 306 |
sqlite3_result_int64(ctx, pCur->aVal[0]); |
| 307 |
break; |
| 308 |
} |
| 309 |
case MSV_COLUMN_HIWTR: { |
| 310 |
sqlite3_result_int64(ctx, pCur->aVal[1]); |
| 311 |
break; |
| 312 |
} |
| 313 |
} |
| 314 |
return SQLITE_OK; |
| 315 |
} |
| 316 |
|
| 317 |
/* |
| 318 |
** Return the rowid for the current row. In this implementation, the |
| 319 |
** rowid is the same as the output value. |
| 320 |
*/ |
| 321 |
static int memstatRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){ |
| 322 |
memstat_cursor *pCur = (memstat_cursor*)cur; |
| 323 |
*pRowid = pCur->iRowid*1000 + pCur->iDb; |
| 324 |
return SQLITE_OK; |
| 325 |
} |
| 326 |
|
| 327 |
/* |
| 328 |
** Return TRUE if the cursor has been moved off of the last |
| 329 |
** row of output. |
| 330 |
*/ |
| 331 |
static int memstatEof(sqlite3_vtab_cursor *cur){ |
| 332 |
memstat_cursor *pCur = (memstat_cursor*)cur; |
| 333 |
return pCur->iRowid>MSV_NROW; |
| 334 |
} |
| 335 |
|
| 336 |
/* |
| 337 |
** This method is called to "rewind" the memstat_cursor object back |
| 338 |
** to the first row of output. This method is always called at least |
| 339 |
** once prior to any call to memstatColumn() or memstatRowid() or |
| 340 |
** memstatEof(). |
| 341 |
*/ |
| 342 |
static int memstatFilter( |
| 343 |
sqlite3_vtab_cursor *pVtabCursor, |
| 344 |
int idxNum, const char *idxStr, |
| 345 |
int argc, sqlite3_value **argv |
| 346 |
){ |
| 347 |
memstat_cursor *pCur = (memstat_cursor *)pVtabCursor; |
| 348 |
int rc = memstatFindSchemas(pCur); |
| 349 |
if( rc ) return rc; |
| 350 |
pCur->iRowid = 0; |
| 351 |
pCur->iDb = 0; |
| 352 |
return memstatNext(pVtabCursor); |
| 353 |
} |
| 354 |
|
| 355 |
/* |
| 356 |
** SQLite will invoke this method one or more times while planning a query |
| 357 |
** that uses the memstat virtual table. This routine needs to create |
| 358 |
** a query plan for each invocation and compute an estimated cost for that |
| 359 |
** plan. |
| 360 |
*/ |
| 361 |
static int memstatBestIndex( |
| 362 |
sqlite3_vtab *tab, |
| 363 |
sqlite3_index_info *pIdxInfo |
| 364 |
){ |
| 365 |
pIdxInfo->estimatedCost = (double)500; |
| 366 |
pIdxInfo->estimatedRows = 500; |
| 367 |
return SQLITE_OK; |
| 368 |
} |
| 369 |
|
| 370 |
/* |
| 371 |
** This following structure defines all the methods for the |
| 372 |
** memstat virtual table. |
| 373 |
*/ |
| 374 |
static sqlite3_module memstatModule = { |
| 375 |
0, /* iVersion */ |
| 376 |
0, /* xCreate */ |
| 377 |
memstatConnect, /* xConnect */ |
| 378 |
memstatBestIndex, /* xBestIndex */ |
| 379 |
memstatDisconnect, /* xDisconnect */ |
| 380 |
0, /* xDestroy */ |
| 381 |
memstatOpen, /* xOpen - open a cursor */ |
| 382 |
memstatClose, /* xClose - close a cursor */ |
| 383 |
memstatFilter, /* xFilter - configure scan constraints */ |
| 384 |
memstatNext, /* xNext - advance a cursor */ |
| 385 |
memstatEof, /* xEof - check for end of scan */ |
| 386 |
memstatColumn, /* xColumn - read data */ |
| 387 |
memstatRowid, /* xRowid - read data */ |
| 388 |
0, /* xUpdate */ |
| 389 |
0, /* xBegin */ |
| 390 |
0, /* xSync */ |
| 391 |
0, /* xCommit */ |
| 392 |
0, /* xRollback */ |
| 393 |
0, /* xFindMethod */ |
| 394 |
0, /* xRename */ |
| 395 |
0, /* xSavepoint */ |
| 396 |
0, /* xRelease */ |
| 397 |
0, /* xRollbackTo */ |
| 398 |
0, /* xShadowName */ |
| 399 |
0 /* xIntegrity */ |
| 400 |
}; |
| 401 |
|
| 402 |
#endif /* SQLITE_OMIT_VIRTUALTABLE */ |
| 403 |
|
| 404 |
int sqlite3MemstatVtabInit( |
| 405 |
sqlite3 *db, |
| 406 |
char **NotUsed1, |
| 407 |
const sqlite3_api_routines *NotUsed2 |
| 408 |
){ |
| 409 |
int rc = SQLITE_OK; |
| 410 |
(void)NotUsed1; |
| 411 |
(void)NotUsed2; |
| 412 |
#ifndef SQLITE_OMIT_VIRTUALTABLE |
| 413 |
rc = sqlite3_create_module(db, "sqlite_memstat", &memstatModule, 0); |
| 414 |
#endif |
| 415 |
return rc; |
| 416 |
} |
| 417 |
|
| 418 |
#ifndef SQLITE_CORE |
| 419 |
#ifdef _WIN32 |
| 420 |
__declspec(dllexport) |
| 421 |
#endif |
| 422 |
int sqlite3_memstat_init( |
| 423 |
sqlite3 *db, |
| 424 |
char **pzErrMsg, |
| 425 |
const sqlite3_api_routines *pApi |
| 426 |
){ |
| 427 |
int rc = SQLITE_OK; |
| 428 |
SQLITE_EXTENSION_INIT2(pApi); |
| 429 |
#ifndef SQLITE_OMIT_VIRTUALTABLE |
| 430 |
rc = sqlite3MemstatVtabInit(db, 0, 0); |
| 431 |
#endif |
| 432 |
return rc; |
| 433 |
} |
| 434 |
#endif /* SQLITE_CORE */ |
| 435 |
#endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_MEMSTATVTAB) */ |