xref: /sqlite-3.40.0/src/vtab.c (revision dedd51ae)
1 /*
2 ** 2006 June 10
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 ** This file contains code used to help implement virtual tables.
13 */
14 #ifndef SQLITE_OMIT_VIRTUALTABLE
15 #include "sqliteInt.h"
16 
17 /*
18 ** Before a virtual table xCreate() or xConnect() method is invoked, the
19 ** sqlite3.pVtabCtx member variable is set to point to an instance of
20 ** this struct allocated on the stack. It is used by the implementation of
21 ** the sqlite3_declare_vtab() and sqlite3_vtab_config() APIs, both of which
22 ** are invoked only from within xCreate and xConnect methods.
23 */
24 struct VtabCtx {
25   VTable *pVTable;    /* The virtual table being constructed */
26   Table *pTab;        /* The Table object to which the virtual table belongs */
27   VtabCtx *pPrior;    /* Parent context (if any) */
28   int bDeclared;      /* True after sqlite3_declare_vtab() is called */
29 };
30 
31 /*
32 ** Construct and install a Module object for a virtual table.  When this
33 ** routine is called, it is guaranteed that all appropriate locks are held
34 ** and the module is not already part of the connection.
35 **
36 ** If there already exists a module with zName, replace it with the new one.
37 ** If pModule==0, then delete the module zName if it exists.
38 */
39 Module *sqlite3VtabCreateModule(
40   sqlite3 *db,                    /* Database in which module is registered */
41   const char *zName,              /* Name assigned to this module */
42   const sqlite3_module *pModule,  /* The definition of the module */
43   void *pAux,                     /* Context pointer for xCreate/xConnect */
44   void (*xDestroy)(void *)        /* Module destructor function */
45 ){
46   Module *pMod;
47   Module *pDel;
48   char *zCopy;
49   if( pModule==0 ){
50     zCopy = (char*)zName;
51     pMod = 0;
52   }else{
53     int nName = sqlite3Strlen30(zName);
54     pMod = (Module *)sqlite3Malloc(sizeof(Module) + nName + 1);
55     if( pMod==0 ){
56       sqlite3OomFault(db);
57       return 0;
58     }
59     zCopy = (char *)(&pMod[1]);
60     memcpy(zCopy, zName, nName+1);
61     pMod->zName = zCopy;
62     pMod->pModule = pModule;
63     pMod->pAux = pAux;
64     pMod->xDestroy = xDestroy;
65     pMod->pEpoTab = 0;
66     pMod->nRefModule = 1;
67   }
68   pDel = (Module *)sqlite3HashInsert(&db->aModule,zCopy,(void*)pMod);
69   if( pDel ){
70     if( pDel==pMod ){
71       sqlite3OomFault(db);
72       sqlite3DbFree(db, pDel);
73       pMod = 0;
74     }else{
75       sqlite3VtabEponymousTableClear(db, pDel);
76       sqlite3VtabModuleUnref(db, pDel);
77     }
78   }
79   return pMod;
80 }
81 
82 /*
83 ** The actual function that does the work of creating a new module.
84 ** This function implements the sqlite3_create_module() and
85 ** sqlite3_create_module_v2() interfaces.
86 */
87 static int createModule(
88   sqlite3 *db,                    /* Database in which module is registered */
89   const char *zName,              /* Name assigned to this module */
90   const sqlite3_module *pModule,  /* The definition of the module */
91   void *pAux,                     /* Context pointer for xCreate/xConnect */
92   void (*xDestroy)(void *)        /* Module destructor function */
93 ){
94   int rc = SQLITE_OK;
95 
96   sqlite3_mutex_enter(db->mutex);
97   (void)sqlite3VtabCreateModule(db, zName, pModule, pAux, xDestroy);
98   rc = sqlite3ApiExit(db, rc);
99   if( rc!=SQLITE_OK && xDestroy ) xDestroy(pAux);
100   sqlite3_mutex_leave(db->mutex);
101   return rc;
102 }
103 
104 
105 /*
106 ** External API function used to create a new virtual-table module.
107 */
108 int sqlite3_create_module(
109   sqlite3 *db,                    /* Database in which module is registered */
110   const char *zName,              /* Name assigned to this module */
111   const sqlite3_module *pModule,  /* The definition of the module */
112   void *pAux                      /* Context pointer for xCreate/xConnect */
113 ){
114 #ifdef SQLITE_ENABLE_API_ARMOR
115   if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
116 #endif
117   return createModule(db, zName, pModule, pAux, 0);
118 }
119 
120 /*
121 ** External API function used to create a new virtual-table module.
122 */
123 int sqlite3_create_module_v2(
124   sqlite3 *db,                    /* Database in which module is registered */
125   const char *zName,              /* Name assigned to this module */
126   const sqlite3_module *pModule,  /* The definition of the module */
127   void *pAux,                     /* Context pointer for xCreate/xConnect */
128   void (*xDestroy)(void *)        /* Module destructor function */
129 ){
130 #ifdef SQLITE_ENABLE_API_ARMOR
131   if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
132 #endif
133   return createModule(db, zName, pModule, pAux, xDestroy);
134 }
135 
136 /*
137 ** External API to drop all virtual-table modules, except those named
138 ** on the azNames list.
139 */
140 int sqlite3_drop_modules(sqlite3 *db, const char** azNames){
141   HashElem *pThis, *pNext;
142 #ifdef SQLITE_ENABLE_API_ARMOR
143   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
144 #endif
145   for(pThis=sqliteHashFirst(&db->aModule); pThis; pThis=pNext){
146     Module *pMod = (Module*)sqliteHashData(pThis);
147     pNext = sqliteHashNext(pThis);
148     if( azNames ){
149       int ii;
150       for(ii=0; azNames[ii]!=0 && strcmp(azNames[ii],pMod->zName)!=0; ii++){}
151       if( azNames[ii]!=0 ) continue;
152     }
153     createModule(db, pMod->zName, 0, 0, 0);
154   }
155   return SQLITE_OK;
156 }
157 
158 /*
159 ** Decrement the reference count on a Module object.  Destroy the
160 ** module when the reference count reaches zero.
161 */
162 void sqlite3VtabModuleUnref(sqlite3 *db, Module *pMod){
163   assert( pMod->nRefModule>0 );
164   pMod->nRefModule--;
165   if( pMod->nRefModule==0 ){
166     if( pMod->xDestroy ){
167       pMod->xDestroy(pMod->pAux);
168     }
169     assert( pMod->pEpoTab==0 );
170     sqlite3DbFree(db, pMod);
171   }
172 }
173 
174 /*
175 ** Lock the virtual table so that it cannot be disconnected.
176 ** Locks nest.  Every lock should have a corresponding unlock.
177 ** If an unlock is omitted, resources leaks will occur.
178 **
179 ** If a disconnect is attempted while a virtual table is locked,
180 ** the disconnect is deferred until all locks have been removed.
181 */
182 void sqlite3VtabLock(VTable *pVTab){
183   pVTab->nRef++;
184 }
185 
186 
187 /*
188 ** pTab is a pointer to a Table structure representing a virtual-table.
189 ** Return a pointer to the VTable object used by connection db to access
190 ** this virtual-table, if one has been created, or NULL otherwise.
191 */
192 VTable *sqlite3GetVTable(sqlite3 *db, Table *pTab){
193   VTable *pVtab;
194   assert( IsVirtual(pTab) );
195   for(pVtab=pTab->u.vtab.p; pVtab && pVtab->db!=db; pVtab=pVtab->pNext);
196   return pVtab;
197 }
198 
199 /*
200 ** Decrement the ref-count on a virtual table object. When the ref-count
201 ** reaches zero, call the xDisconnect() method to delete the object.
202 */
203 void sqlite3VtabUnlock(VTable *pVTab){
204   sqlite3 *db = pVTab->db;
205 
206   assert( db );
207   assert( pVTab->nRef>0 );
208   assert( db->eOpenState==SQLITE_STATE_OPEN
209        || db->eOpenState==SQLITE_STATE_ZOMBIE );
210 
211   pVTab->nRef--;
212   if( pVTab->nRef==0 ){
213     sqlite3_vtab *p = pVTab->pVtab;
214     sqlite3VtabModuleUnref(pVTab->db, pVTab->pMod);
215     if( p ){
216       p->pModule->xDisconnect(p);
217     }
218     sqlite3DbFree(db, pVTab);
219   }
220 }
221 
222 /*
223 ** Table p is a virtual table. This function moves all elements in the
224 ** p->u.vtab.p list to the sqlite3.pDisconnect lists of their associated
225 ** database connections to be disconnected at the next opportunity.
226 ** Except, if argument db is not NULL, then the entry associated with
227 ** connection db is left in the p->u.vtab.p list.
228 */
229 static VTable *vtabDisconnectAll(sqlite3 *db, Table *p){
230   VTable *pRet = 0;
231   VTable *pVTable;
232 
233   assert( IsVirtual(p) );
234   pVTable = p->u.vtab.p;
235   p->u.vtab.p = 0;
236 
237   /* Assert that the mutex (if any) associated with the BtShared database
238   ** that contains table p is held by the caller. See header comments
239   ** above function sqlite3VtabUnlockList() for an explanation of why
240   ** this makes it safe to access the sqlite3.pDisconnect list of any
241   ** database connection that may have an entry in the p->u.vtab.p list.
242   */
243   assert( db==0 || sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
244 
245   while( pVTable ){
246     sqlite3 *db2 = pVTable->db;
247     VTable *pNext = pVTable->pNext;
248     assert( db2 );
249     if( db2==db ){
250       pRet = pVTable;
251       p->u.vtab.p = pRet;
252       pRet->pNext = 0;
253     }else{
254       pVTable->pNext = db2->pDisconnect;
255       db2->pDisconnect = pVTable;
256     }
257     pVTable = pNext;
258   }
259 
260   assert( !db || pRet );
261   return pRet;
262 }
263 
264 /*
265 ** Table *p is a virtual table. This function removes the VTable object
266 ** for table *p associated with database connection db from the linked
267 ** list in p->pVTab. It also decrements the VTable ref count. This is
268 ** used when closing database connection db to free all of its VTable
269 ** objects without disturbing the rest of the Schema object (which may
270 ** be being used by other shared-cache connections).
271 */
272 void sqlite3VtabDisconnect(sqlite3 *db, Table *p){
273   VTable **ppVTab;
274 
275   assert( IsVirtual(p) );
276   assert( sqlite3BtreeHoldsAllMutexes(db) );
277   assert( sqlite3_mutex_held(db->mutex) );
278 
279   for(ppVTab=&p->u.vtab.p; *ppVTab; ppVTab=&(*ppVTab)->pNext){
280     if( (*ppVTab)->db==db  ){
281       VTable *pVTab = *ppVTab;
282       *ppVTab = pVTab->pNext;
283       sqlite3VtabUnlock(pVTab);
284       break;
285     }
286   }
287 }
288 
289 
290 /*
291 ** Disconnect all the virtual table objects in the sqlite3.pDisconnect list.
292 **
293 ** This function may only be called when the mutexes associated with all
294 ** shared b-tree databases opened using connection db are held by the
295 ** caller. This is done to protect the sqlite3.pDisconnect list. The
296 ** sqlite3.pDisconnect list is accessed only as follows:
297 **
298 **   1) By this function. In this case, all BtShared mutexes and the mutex
299 **      associated with the database handle itself must be held.
300 **
301 **   2) By function vtabDisconnectAll(), when it adds a VTable entry to
302 **      the sqlite3.pDisconnect list. In this case either the BtShared mutex
303 **      associated with the database the virtual table is stored in is held
304 **      or, if the virtual table is stored in a non-sharable database, then
305 **      the database handle mutex is held.
306 **
307 ** As a result, a sqlite3.pDisconnect cannot be accessed simultaneously
308 ** by multiple threads. It is thread-safe.
309 */
310 void sqlite3VtabUnlockList(sqlite3 *db){
311   VTable *p = db->pDisconnect;
312 
313   assert( sqlite3BtreeHoldsAllMutexes(db) );
314   assert( sqlite3_mutex_held(db->mutex) );
315 
316   if( p ){
317     db->pDisconnect = 0;
318     sqlite3ExpirePreparedStatements(db, 0);
319     do {
320       VTable *pNext = p->pNext;
321       sqlite3VtabUnlock(p);
322       p = pNext;
323     }while( p );
324   }
325 }
326 
327 /*
328 ** Clear any and all virtual-table information from the Table record.
329 ** This routine is called, for example, just before deleting the Table
330 ** record.
331 **
332 ** Since it is a virtual-table, the Table structure contains a pointer
333 ** to the head of a linked list of VTable structures. Each VTable
334 ** structure is associated with a single sqlite3* user of the schema.
335 ** The reference count of the VTable structure associated with database
336 ** connection db is decremented immediately (which may lead to the
337 ** structure being xDisconnected and free). Any other VTable structures
338 ** in the list are moved to the sqlite3.pDisconnect list of the associated
339 ** database connection.
340 */
341 void sqlite3VtabClear(sqlite3 *db, Table *p){
342   assert( IsVirtual(p) );
343   if( !db || db->pnBytesFreed==0 ) vtabDisconnectAll(0, p);
344   if( p->u.vtab.azArg ){
345     int i;
346     for(i=0; i<p->u.vtab.nArg; i++){
347       if( i!=1 ) sqlite3DbFree(db, p->u.vtab.azArg[i]);
348     }
349     sqlite3DbFree(db, p->u.vtab.azArg);
350   }
351 }
352 
353 /*
354 ** Add a new module argument to pTable->u.vtab.azArg[].
355 ** The string is not copied - the pointer is stored.  The
356 ** string will be freed automatically when the table is
357 ** deleted.
358 */
359 static void addModuleArgument(Parse *pParse, Table *pTable, char *zArg){
360   sqlite3_int64 nBytes;
361   char **azModuleArg;
362   sqlite3 *db = pParse->db;
363 
364   assert( IsVirtual(pTable) );
365   nBytes = sizeof(char *)*(2+pTable->u.vtab.nArg);
366   if( pTable->u.vtab.nArg+3>=db->aLimit[SQLITE_LIMIT_COLUMN] ){
367     sqlite3ErrorMsg(pParse, "too many columns on %s", pTable->zName);
368   }
369   azModuleArg = sqlite3DbRealloc(db, pTable->u.vtab.azArg, nBytes);
370   if( azModuleArg==0 ){
371     sqlite3DbFree(db, zArg);
372   }else{
373     int i = pTable->u.vtab.nArg++;
374     azModuleArg[i] = zArg;
375     azModuleArg[i+1] = 0;
376     pTable->u.vtab.azArg = azModuleArg;
377   }
378 }
379 
380 /*
381 ** The parser calls this routine when it first sees a CREATE VIRTUAL TABLE
382 ** statement.  The module name has been parsed, but the optional list
383 ** of parameters that follow the module name are still pending.
384 */
385 void sqlite3VtabBeginParse(
386   Parse *pParse,        /* Parsing context */
387   Token *pName1,        /* Name of new table, or database name */
388   Token *pName2,        /* Name of new table or NULL */
389   Token *pModuleName,   /* Name of the module for the virtual table */
390   int ifNotExists       /* No error if the table already exists */
391 ){
392   Table *pTable;        /* The new virtual table */
393   sqlite3 *db;          /* Database connection */
394 
395   sqlite3StartTable(pParse, pName1, pName2, 0, 0, 1, ifNotExists);
396   pTable = pParse->pNewTable;
397   if( pTable==0 ) return;
398   assert( 0==pTable->pIndex );
399   pTable->eTabType = TABTYP_VTAB;
400 
401   db = pParse->db;
402 
403   assert( pTable->u.vtab.nArg==0 );
404   addModuleArgument(pParse, pTable, sqlite3NameFromToken(db, pModuleName));
405   addModuleArgument(pParse, pTable, 0);
406   addModuleArgument(pParse, pTable, sqlite3DbStrDup(db, pTable->zName));
407   assert( (pParse->sNameToken.z==pName2->z && pName2->z!=0)
408        || (pParse->sNameToken.z==pName1->z && pName2->z==0)
409   );
410   pParse->sNameToken.n = (int)(
411       &pModuleName->z[pModuleName->n] - pParse->sNameToken.z
412   );
413 
414 #ifndef SQLITE_OMIT_AUTHORIZATION
415   /* Creating a virtual table invokes the authorization callback twice.
416   ** The first invocation, to obtain permission to INSERT a row into the
417   ** sqlite_schema table, has already been made by sqlite3StartTable().
418   ** The second call, to obtain permission to create the table, is made now.
419   */
420   if( pTable->u.vtab.azArg ){
421     int iDb = sqlite3SchemaToIndex(db, pTable->pSchema);
422     assert( iDb>=0 ); /* The database the table is being created in */
423     sqlite3AuthCheck(pParse, SQLITE_CREATE_VTABLE, pTable->zName,
424             pTable->u.vtab.azArg[0], pParse->db->aDb[iDb].zDbSName);
425   }
426 #endif
427 }
428 
429 /*
430 ** This routine takes the module argument that has been accumulating
431 ** in pParse->zArg[] and appends it to the list of arguments on the
432 ** virtual table currently under construction in pParse->pTable.
433 */
434 static void addArgumentToVtab(Parse *pParse){
435   if( pParse->sArg.z && pParse->pNewTable ){
436     const char *z = (const char*)pParse->sArg.z;
437     int n = pParse->sArg.n;
438     sqlite3 *db = pParse->db;
439     addModuleArgument(pParse, pParse->pNewTable, sqlite3DbStrNDup(db, z, n));
440   }
441 }
442 
443 /*
444 ** The parser calls this routine after the CREATE VIRTUAL TABLE statement
445 ** has been completely parsed.
446 */
447 void sqlite3VtabFinishParse(Parse *pParse, Token *pEnd){
448   Table *pTab = pParse->pNewTable;  /* The table being constructed */
449   sqlite3 *db = pParse->db;         /* The database connection */
450 
451   if( pTab==0 ) return;
452   assert( IsVirtual(pTab) );
453   addArgumentToVtab(pParse);
454   pParse->sArg.z = 0;
455   if( pTab->u.vtab.nArg<1 ) return;
456 
457   /* If the CREATE VIRTUAL TABLE statement is being entered for the
458   ** first time (in other words if the virtual table is actually being
459   ** created now instead of just being read out of sqlite_schema) then
460   ** do additional initialization work and store the statement text
461   ** in the sqlite_schema table.
462   */
463   if( !db->init.busy ){
464     char *zStmt;
465     char *zWhere;
466     int iDb;
467     int iReg;
468     Vdbe *v;
469 
470     sqlite3MayAbort(pParse);
471 
472     /* Compute the complete text of the CREATE VIRTUAL TABLE statement */
473     if( pEnd ){
474       pParse->sNameToken.n = (int)(pEnd->z - pParse->sNameToken.z) + pEnd->n;
475     }
476     zStmt = sqlite3MPrintf(db, "CREATE VIRTUAL TABLE %T", &pParse->sNameToken);
477 
478     /* A slot for the record has already been allocated in the
479     ** schema table.  We just need to update that slot with all
480     ** the information we've collected.
481     **
482     ** The VM register number pParse->regRowid holds the rowid of an
483     ** entry in the sqlite_schema table tht was created for this vtab
484     ** by sqlite3StartTable().
485     */
486     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
487     sqlite3NestedParse(pParse,
488       "UPDATE %Q." LEGACY_SCHEMA_TABLE " "
489          "SET type='table', name=%Q, tbl_name=%Q, rootpage=0, sql=%Q "
490        "WHERE rowid=#%d",
491       db->aDb[iDb].zDbSName,
492       pTab->zName,
493       pTab->zName,
494       zStmt,
495       pParse->regRowid
496     );
497     v = sqlite3GetVdbe(pParse);
498     sqlite3ChangeCookie(pParse, iDb);
499 
500     sqlite3VdbeAddOp0(v, OP_Expire);
501     zWhere = sqlite3MPrintf(db, "name=%Q AND sql=%Q", pTab->zName, zStmt);
502     sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere, 0);
503     sqlite3DbFree(db, zStmt);
504 
505     iReg = ++pParse->nMem;
506     sqlite3VdbeLoadString(v, iReg, pTab->zName);
507     sqlite3VdbeAddOp2(v, OP_VCreate, iDb, iReg);
508   }else{
509     /* If we are rereading the sqlite_schema table create the in-memory
510     ** record of the table. */
511     Table *pOld;
512     Schema *pSchema = pTab->pSchema;
513     const char *zName = pTab->zName;
514     assert( zName!=0 );
515     sqlite3MarkAllShadowTablesOf(db, pTab);
516     pOld = sqlite3HashInsert(&pSchema->tblHash, zName, pTab);
517     if( pOld ){
518       sqlite3OomFault(db);
519       assert( pTab==pOld );  /* Malloc must have failed inside HashInsert() */
520       return;
521     }
522     pParse->pNewTable = 0;
523   }
524 }
525 
526 /*
527 ** The parser calls this routine when it sees the first token
528 ** of an argument to the module name in a CREATE VIRTUAL TABLE statement.
529 */
530 void sqlite3VtabArgInit(Parse *pParse){
531   addArgumentToVtab(pParse);
532   pParse->sArg.z = 0;
533   pParse->sArg.n = 0;
534 }
535 
536 /*
537 ** The parser calls this routine for each token after the first token
538 ** in an argument to the module name in a CREATE VIRTUAL TABLE statement.
539 */
540 void sqlite3VtabArgExtend(Parse *pParse, Token *p){
541   Token *pArg = &pParse->sArg;
542   if( pArg->z==0 ){
543     pArg->z = p->z;
544     pArg->n = p->n;
545   }else{
546     assert(pArg->z <= p->z);
547     pArg->n = (int)(&p->z[p->n] - pArg->z);
548   }
549 }
550 
551 /*
552 ** Invoke a virtual table constructor (either xCreate or xConnect). The
553 ** pointer to the function to invoke is passed as the fourth parameter
554 ** to this procedure.
555 */
556 static int vtabCallConstructor(
557   sqlite3 *db,
558   Table *pTab,
559   Module *pMod,
560   int (*xConstruct)(sqlite3*,void*,int,const char*const*,sqlite3_vtab**,char**),
561   char **pzErr
562 ){
563   VtabCtx sCtx;
564   VTable *pVTable;
565   int rc;
566   const char *const*azArg;
567   int nArg = pTab->u.vtab.nArg;
568   char *zErr = 0;
569   char *zModuleName;
570   int iDb;
571   VtabCtx *pCtx;
572 
573   assert( IsVirtual(pTab) );
574   azArg = (const char *const*)pTab->u.vtab.azArg;
575 
576   /* Check that the virtual-table is not already being initialized */
577   for(pCtx=db->pVtabCtx; pCtx; pCtx=pCtx->pPrior){
578     if( pCtx->pTab==pTab ){
579       *pzErr = sqlite3MPrintf(db,
580           "vtable constructor called recursively: %s", pTab->zName
581       );
582       return SQLITE_LOCKED;
583     }
584   }
585 
586   zModuleName = sqlite3DbStrDup(db, pTab->zName);
587   if( !zModuleName ){
588     return SQLITE_NOMEM_BKPT;
589   }
590 
591   pVTable = sqlite3MallocZero(sizeof(VTable));
592   if( !pVTable ){
593     sqlite3OomFault(db);
594     sqlite3DbFree(db, zModuleName);
595     return SQLITE_NOMEM_BKPT;
596   }
597   pVTable->db = db;
598   pVTable->pMod = pMod;
599   pVTable->eVtabRisk = SQLITE_VTABRISK_Normal;
600 
601   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
602   pTab->u.vtab.azArg[1] = db->aDb[iDb].zDbSName;
603 
604   /* Invoke the virtual table constructor */
605   assert( &db->pVtabCtx );
606   assert( xConstruct );
607   sCtx.pTab = pTab;
608   sCtx.pVTable = pVTable;
609   sCtx.pPrior = db->pVtabCtx;
610   sCtx.bDeclared = 0;
611   db->pVtabCtx = &sCtx;
612   rc = xConstruct(db, pMod->pAux, nArg, azArg, &pVTable->pVtab, &zErr);
613   db->pVtabCtx = sCtx.pPrior;
614   if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
615   assert( sCtx.pTab==pTab );
616 
617   if( SQLITE_OK!=rc ){
618     if( zErr==0 ){
619       *pzErr = sqlite3MPrintf(db, "vtable constructor failed: %s", zModuleName);
620     }else {
621       *pzErr = sqlite3MPrintf(db, "%s", zErr);
622       sqlite3_free(zErr);
623     }
624     sqlite3DbFree(db, pVTable);
625   }else if( ALWAYS(pVTable->pVtab) ){
626     /* Justification of ALWAYS():  A correct vtab constructor must allocate
627     ** the sqlite3_vtab object if successful.  */
628     memset(pVTable->pVtab, 0, sizeof(pVTable->pVtab[0]));
629     pVTable->pVtab->pModule = pMod->pModule;
630     pMod->nRefModule++;
631     pVTable->nRef = 1;
632     if( sCtx.bDeclared==0 ){
633       const char *zFormat = "vtable constructor did not declare schema: %s";
634       *pzErr = sqlite3MPrintf(db, zFormat, pTab->zName);
635       sqlite3VtabUnlock(pVTable);
636       rc = SQLITE_ERROR;
637     }else{
638       int iCol;
639       u16 oooHidden = 0;
640       /* If everything went according to plan, link the new VTable structure
641       ** into the linked list headed by pTab->u.vtab.p. Then loop through the
642       ** columns of the table to see if any of them contain the token "hidden".
643       ** If so, set the Column COLFLAG_HIDDEN flag and remove the token from
644       ** the type string.  */
645       pVTable->pNext = pTab->u.vtab.p;
646       pTab->u.vtab.p = pVTable;
647 
648       for(iCol=0; iCol<pTab->nCol; iCol++){
649         char *zType = sqlite3ColumnType(&pTab->aCol[iCol], "");
650         int nType;
651         int i = 0;
652         nType = sqlite3Strlen30(zType);
653         for(i=0; i<nType; i++){
654           if( 0==sqlite3StrNICmp("hidden", &zType[i], 6)
655            && (i==0 || zType[i-1]==' ')
656            && (zType[i+6]=='\0' || zType[i+6]==' ')
657           ){
658             break;
659           }
660         }
661         if( i<nType ){
662           int j;
663           int nDel = 6 + (zType[i+6] ? 1 : 0);
664           for(j=i; (j+nDel)<=nType; j++){
665             zType[j] = zType[j+nDel];
666           }
667           if( zType[i]=='\0' && i>0 ){
668             assert(zType[i-1]==' ');
669             zType[i-1] = '\0';
670           }
671           pTab->aCol[iCol].colFlags |= COLFLAG_HIDDEN;
672           pTab->tabFlags |= TF_HasHidden;
673           oooHidden = TF_OOOHidden;
674         }else{
675           pTab->tabFlags |= oooHidden;
676         }
677       }
678     }
679   }
680 
681   sqlite3DbFree(db, zModuleName);
682   return rc;
683 }
684 
685 /*
686 ** This function is invoked by the parser to call the xConnect() method
687 ** of the virtual table pTab. If an error occurs, an error code is returned
688 ** and an error left in pParse.
689 **
690 ** This call is a no-op if table pTab is not a virtual table.
691 */
692 int sqlite3VtabCallConnect(Parse *pParse, Table *pTab){
693   sqlite3 *db = pParse->db;
694   const char *zMod;
695   Module *pMod;
696   int rc;
697 
698   assert( pTab );
699   assert( IsVirtual(pTab) );
700   if( sqlite3GetVTable(db, pTab) ){
701     return SQLITE_OK;
702   }
703 
704   /* Locate the required virtual table module */
705   zMod = pTab->u.vtab.azArg[0];
706   pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
707 
708   if( !pMod ){
709     const char *zModule = pTab->u.vtab.azArg[0];
710     sqlite3ErrorMsg(pParse, "no such module: %s", zModule);
711     rc = SQLITE_ERROR;
712   }else{
713     char *zErr = 0;
714     rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xConnect, &zErr);
715     if( rc!=SQLITE_OK ){
716       sqlite3ErrorMsg(pParse, "%s", zErr);
717       pParse->rc = rc;
718     }
719     sqlite3DbFree(db, zErr);
720   }
721 
722   return rc;
723 }
724 /*
725 ** Grow the db->aVTrans[] array so that there is room for at least one
726 ** more v-table. Return SQLITE_NOMEM if a malloc fails, or SQLITE_OK otherwise.
727 */
728 static int growVTrans(sqlite3 *db){
729   const int ARRAY_INCR = 5;
730 
731   /* Grow the sqlite3.aVTrans array if required */
732   if( (db->nVTrans%ARRAY_INCR)==0 ){
733     VTable **aVTrans;
734     sqlite3_int64 nBytes = sizeof(sqlite3_vtab*)*
735                                  ((sqlite3_int64)db->nVTrans + ARRAY_INCR);
736     aVTrans = sqlite3DbRealloc(db, (void *)db->aVTrans, nBytes);
737     if( !aVTrans ){
738       return SQLITE_NOMEM_BKPT;
739     }
740     memset(&aVTrans[db->nVTrans], 0, sizeof(sqlite3_vtab *)*ARRAY_INCR);
741     db->aVTrans = aVTrans;
742   }
743 
744   return SQLITE_OK;
745 }
746 
747 /*
748 ** Add the virtual table pVTab to the array sqlite3.aVTrans[]. Space should
749 ** have already been reserved using growVTrans().
750 */
751 static void addToVTrans(sqlite3 *db, VTable *pVTab){
752   /* Add pVtab to the end of sqlite3.aVTrans */
753   db->aVTrans[db->nVTrans++] = pVTab;
754   sqlite3VtabLock(pVTab);
755 }
756 
757 /*
758 ** This function is invoked by the vdbe to call the xCreate method
759 ** of the virtual table named zTab in database iDb.
760 **
761 ** If an error occurs, *pzErr is set to point to an English language
762 ** description of the error and an SQLITE_XXX error code is returned.
763 ** In this case the caller must call sqlite3DbFree(db, ) on *pzErr.
764 */
765 int sqlite3VtabCallCreate(sqlite3 *db, int iDb, const char *zTab, char **pzErr){
766   int rc = SQLITE_OK;
767   Table *pTab;
768   Module *pMod;
769   const char *zMod;
770 
771   pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
772   assert( pTab && IsVirtual(pTab) && !pTab->u.vtab.p );
773 
774   /* Locate the required virtual table module */
775   zMod = pTab->u.vtab.azArg[0];
776   pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
777 
778   /* If the module has been registered and includes a Create method,
779   ** invoke it now. If the module has not been registered, return an
780   ** error. Otherwise, do nothing.
781   */
782   if( pMod==0 || pMod->pModule->xCreate==0 || pMod->pModule->xDestroy==0 ){
783     *pzErr = sqlite3MPrintf(db, "no such module: %s", zMod);
784     rc = SQLITE_ERROR;
785   }else{
786     rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xCreate, pzErr);
787   }
788 
789   /* Justification of ALWAYS():  The xConstructor method is required to
790   ** create a valid sqlite3_vtab if it returns SQLITE_OK. */
791   if( rc==SQLITE_OK && ALWAYS(sqlite3GetVTable(db, pTab)) ){
792     rc = growVTrans(db);
793     if( rc==SQLITE_OK ){
794       addToVTrans(db, sqlite3GetVTable(db, pTab));
795     }
796   }
797 
798   return rc;
799 }
800 
801 /*
802 ** This function is used to set the schema of a virtual table.  It is only
803 ** valid to call this function from within the xCreate() or xConnect() of a
804 ** virtual table module.
805 */
806 int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable){
807   VtabCtx *pCtx;
808   int rc = SQLITE_OK;
809   Table *pTab;
810   Parse sParse;
811   int initBusy;
812 
813 #ifdef SQLITE_ENABLE_API_ARMOR
814   if( !sqlite3SafetyCheckOk(db) || zCreateTable==0 ){
815     return SQLITE_MISUSE_BKPT;
816   }
817 #endif
818   sqlite3_mutex_enter(db->mutex);
819   pCtx = db->pVtabCtx;
820   if( !pCtx || pCtx->bDeclared ){
821     sqlite3Error(db, SQLITE_MISUSE);
822     sqlite3_mutex_leave(db->mutex);
823     return SQLITE_MISUSE_BKPT;
824   }
825   pTab = pCtx->pTab;
826   assert( IsVirtual(pTab) );
827 
828   sqlite3ParseObjectInit(&sParse, db);
829   sParse.eParseMode = PARSE_MODE_DECLARE_VTAB;
830   /* We should never be able to reach this point while loading the
831   ** schema.  Nevertheless, defend against that (turn off db->init.busy)
832   ** in case a bug arises. */
833   assert( db->init.busy==0 );
834   initBusy = db->init.busy;
835   db->init.busy = 0;
836   sParse.nQueryLoop = 1;
837   if( SQLITE_OK==sqlite3RunParser(&sParse, zCreateTable)
838    && ALWAYS(sParse.pNewTable!=0)
839    && ALWAYS(!db->mallocFailed)
840    && IsOrdinaryTable(sParse.pNewTable)
841   ){
842     assert( sParse.zErrMsg==0 );
843     if( !pTab->aCol ){
844       Table *pNew = sParse.pNewTable;
845       Index *pIdx;
846       pTab->aCol = pNew->aCol;
847       sqlite3ExprListDelete(db, pNew->u.tab.pDfltList);
848       pTab->nNVCol = pTab->nCol = pNew->nCol;
849       pTab->tabFlags |= pNew->tabFlags & (TF_WithoutRowid|TF_NoVisibleRowid);
850       pNew->nCol = 0;
851       pNew->aCol = 0;
852       assert( pTab->pIndex==0 );
853       assert( HasRowid(pNew) || sqlite3PrimaryKeyIndex(pNew)!=0 );
854       if( !HasRowid(pNew)
855        && pCtx->pVTable->pMod->pModule->xUpdate!=0
856        && sqlite3PrimaryKeyIndex(pNew)->nKeyCol!=1
857       ){
858         /* WITHOUT ROWID virtual tables must either be read-only (xUpdate==0)
859         ** or else must have a single-column PRIMARY KEY */
860         rc = SQLITE_ERROR;
861       }
862       pIdx = pNew->pIndex;
863       if( pIdx ){
864         assert( pIdx->pNext==0 );
865         pTab->pIndex = pIdx;
866         pNew->pIndex = 0;
867         pIdx->pTable = pTab;
868       }
869     }
870     pCtx->bDeclared = 1;
871   }else{
872     sqlite3ErrorWithMsg(db, SQLITE_ERROR,
873           (sParse.zErrMsg ? "%s" : 0), sParse.zErrMsg);
874     sqlite3DbFree(db, sParse.zErrMsg);
875     rc = SQLITE_ERROR;
876   }
877   sParse.eParseMode = PARSE_MODE_NORMAL;
878 
879   if( sParse.pVdbe ){
880     sqlite3VdbeFinalize(sParse.pVdbe);
881   }
882   sqlite3DeleteTable(db, sParse.pNewTable);
883   sqlite3ParseObjectReset(&sParse);
884   db->init.busy = initBusy;
885 
886   assert( (rc&0xff)==rc );
887   rc = sqlite3ApiExit(db, rc);
888   sqlite3_mutex_leave(db->mutex);
889   return rc;
890 }
891 
892 /*
893 ** This function is invoked by the vdbe to call the xDestroy method
894 ** of the virtual table named zTab in database iDb. This occurs
895 ** when a DROP TABLE is mentioned.
896 **
897 ** This call is a no-op if zTab is not a virtual table.
898 */
899 int sqlite3VtabCallDestroy(sqlite3 *db, int iDb, const char *zTab){
900   int rc = SQLITE_OK;
901   Table *pTab;
902 
903   pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
904   if( ALWAYS(pTab!=0)
905    && ALWAYS(IsVirtual(pTab))
906    && ALWAYS(pTab->u.vtab.p!=0)
907   ){
908     VTable *p;
909     int (*xDestroy)(sqlite3_vtab *);
910     for(p=pTab->u.vtab.p; p; p=p->pNext){
911       assert( p->pVtab );
912       if( p->pVtab->nRef>0 ){
913         return SQLITE_LOCKED;
914       }
915     }
916     p = vtabDisconnectAll(db, pTab);
917     xDestroy = p->pMod->pModule->xDestroy;
918     if( xDestroy==0 ) xDestroy = p->pMod->pModule->xDisconnect;
919     assert( xDestroy!=0 );
920     pTab->nTabRef++;
921     rc = xDestroy(p->pVtab);
922     /* Remove the sqlite3_vtab* from the aVTrans[] array, if applicable */
923     if( rc==SQLITE_OK ){
924       assert( pTab->u.vtab.p==p && p->pNext==0 );
925       p->pVtab = 0;
926       pTab->u.vtab.p = 0;
927       sqlite3VtabUnlock(p);
928     }
929     sqlite3DeleteTable(db, pTab);
930   }
931 
932   return rc;
933 }
934 
935 /*
936 ** This function invokes either the xRollback or xCommit method
937 ** of each of the virtual tables in the sqlite3.aVTrans array. The method
938 ** called is identified by the second argument, "offset", which is
939 ** the offset of the method to call in the sqlite3_module structure.
940 **
941 ** The array is cleared after invoking the callbacks.
942 */
943 static void callFinaliser(sqlite3 *db, int offset){
944   int i;
945   if( db->aVTrans ){
946     VTable **aVTrans = db->aVTrans;
947     db->aVTrans = 0;
948     for(i=0; i<db->nVTrans; i++){
949       VTable *pVTab = aVTrans[i];
950       sqlite3_vtab *p = pVTab->pVtab;
951       if( p ){
952         int (*x)(sqlite3_vtab *);
953         x = *(int (**)(sqlite3_vtab *))((char *)p->pModule + offset);
954         if( x ) x(p);
955       }
956       pVTab->iSavepoint = 0;
957       sqlite3VtabUnlock(pVTab);
958     }
959     sqlite3DbFree(db, aVTrans);
960     db->nVTrans = 0;
961   }
962 }
963 
964 /*
965 ** Invoke the xSync method of all virtual tables in the sqlite3.aVTrans
966 ** array. Return the error code for the first error that occurs, or
967 ** SQLITE_OK if all xSync operations are successful.
968 **
969 ** If an error message is available, leave it in p->zErrMsg.
970 */
971 int sqlite3VtabSync(sqlite3 *db, Vdbe *p){
972   int i;
973   int rc = SQLITE_OK;
974   VTable **aVTrans = db->aVTrans;
975 
976   db->aVTrans = 0;
977   for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
978     int (*x)(sqlite3_vtab *);
979     sqlite3_vtab *pVtab = aVTrans[i]->pVtab;
980     if( pVtab && (x = pVtab->pModule->xSync)!=0 ){
981       rc = x(pVtab);
982       sqlite3VtabImportErrmsg(p, pVtab);
983     }
984   }
985   db->aVTrans = aVTrans;
986   return rc;
987 }
988 
989 /*
990 ** Invoke the xRollback method of all virtual tables in the
991 ** sqlite3.aVTrans array. Then clear the array itself.
992 */
993 int sqlite3VtabRollback(sqlite3 *db){
994   callFinaliser(db, offsetof(sqlite3_module,xRollback));
995   return SQLITE_OK;
996 }
997 
998 /*
999 ** Invoke the xCommit method of all virtual tables in the
1000 ** sqlite3.aVTrans array. Then clear the array itself.
1001 */
1002 int sqlite3VtabCommit(sqlite3 *db){
1003   callFinaliser(db, offsetof(sqlite3_module,xCommit));
1004   return SQLITE_OK;
1005 }
1006 
1007 /*
1008 ** If the virtual table pVtab supports the transaction interface
1009 ** (xBegin/xRollback/xCommit and optionally xSync) and a transaction is
1010 ** not currently open, invoke the xBegin method now.
1011 **
1012 ** If the xBegin call is successful, place the sqlite3_vtab pointer
1013 ** in the sqlite3.aVTrans array.
1014 */
1015 int sqlite3VtabBegin(sqlite3 *db, VTable *pVTab){
1016   int rc = SQLITE_OK;
1017   const sqlite3_module *pModule;
1018 
1019   /* Special case: If db->aVTrans is NULL and db->nVTrans is greater
1020   ** than zero, then this function is being called from within a
1021   ** virtual module xSync() callback. It is illegal to write to
1022   ** virtual module tables in this case, so return SQLITE_LOCKED.
1023   */
1024   if( sqlite3VtabInSync(db) ){
1025     return SQLITE_LOCKED;
1026   }
1027   if( !pVTab ){
1028     return SQLITE_OK;
1029   }
1030   pModule = pVTab->pVtab->pModule;
1031 
1032   if( pModule->xBegin ){
1033     int i;
1034 
1035     /* If pVtab is already in the aVTrans array, return early */
1036     for(i=0; i<db->nVTrans; i++){
1037       if( db->aVTrans[i]==pVTab ){
1038         return SQLITE_OK;
1039       }
1040     }
1041 
1042     /* Invoke the xBegin method. If successful, add the vtab to the
1043     ** sqlite3.aVTrans[] array. */
1044     rc = growVTrans(db);
1045     if( rc==SQLITE_OK ){
1046       rc = pModule->xBegin(pVTab->pVtab);
1047       if( rc==SQLITE_OK ){
1048         int iSvpt = db->nStatement + db->nSavepoint;
1049         addToVTrans(db, pVTab);
1050         if( iSvpt && pModule->xSavepoint ){
1051           pVTab->iSavepoint = iSvpt;
1052           rc = pModule->xSavepoint(pVTab->pVtab, iSvpt-1);
1053         }
1054       }
1055     }
1056   }
1057   return rc;
1058 }
1059 
1060 /*
1061 ** Invoke either the xSavepoint, xRollbackTo or xRelease method of all
1062 ** virtual tables that currently have an open transaction. Pass iSavepoint
1063 ** as the second argument to the virtual table method invoked.
1064 **
1065 ** If op is SAVEPOINT_BEGIN, the xSavepoint method is invoked. If it is
1066 ** SAVEPOINT_ROLLBACK, the xRollbackTo method. Otherwise, if op is
1067 ** SAVEPOINT_RELEASE, then the xRelease method of each virtual table with
1068 ** an open transaction is invoked.
1069 **
1070 ** If any virtual table method returns an error code other than SQLITE_OK,
1071 ** processing is abandoned and the error returned to the caller of this
1072 ** function immediately. If all calls to virtual table methods are successful,
1073 ** SQLITE_OK is returned.
1074 */
1075 int sqlite3VtabSavepoint(sqlite3 *db, int op, int iSavepoint){
1076   int rc = SQLITE_OK;
1077 
1078   assert( op==SAVEPOINT_RELEASE||op==SAVEPOINT_ROLLBACK||op==SAVEPOINT_BEGIN );
1079   assert( iSavepoint>=-1 );
1080   if( db->aVTrans ){
1081     int i;
1082     for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
1083       VTable *pVTab = db->aVTrans[i];
1084       const sqlite3_module *pMod = pVTab->pMod->pModule;
1085       if( pVTab->pVtab && pMod->iVersion>=2 ){
1086         int (*xMethod)(sqlite3_vtab *, int);
1087         sqlite3VtabLock(pVTab);
1088         switch( op ){
1089           case SAVEPOINT_BEGIN:
1090             xMethod = pMod->xSavepoint;
1091             pVTab->iSavepoint = iSavepoint+1;
1092             break;
1093           case SAVEPOINT_ROLLBACK:
1094             xMethod = pMod->xRollbackTo;
1095             break;
1096           default:
1097             xMethod = pMod->xRelease;
1098             break;
1099         }
1100         if( xMethod && pVTab->iSavepoint>iSavepoint ){
1101           rc = xMethod(pVTab->pVtab, iSavepoint);
1102         }
1103         sqlite3VtabUnlock(pVTab);
1104       }
1105     }
1106   }
1107   return rc;
1108 }
1109 
1110 /*
1111 ** The first parameter (pDef) is a function implementation.  The
1112 ** second parameter (pExpr) is the first argument to this function.
1113 ** If pExpr is a column in a virtual table, then let the virtual
1114 ** table implementation have an opportunity to overload the function.
1115 **
1116 ** This routine is used to allow virtual table implementations to
1117 ** overload MATCH, LIKE, GLOB, and REGEXP operators.
1118 **
1119 ** Return either the pDef argument (indicating no change) or a
1120 ** new FuncDef structure that is marked as ephemeral using the
1121 ** SQLITE_FUNC_EPHEM flag.
1122 */
1123 FuncDef *sqlite3VtabOverloadFunction(
1124   sqlite3 *db,    /* Database connection for reporting malloc problems */
1125   FuncDef *pDef,  /* Function to possibly overload */
1126   int nArg,       /* Number of arguments to the function */
1127   Expr *pExpr     /* First argument to the function */
1128 ){
1129   Table *pTab;
1130   sqlite3_vtab *pVtab;
1131   sqlite3_module *pMod;
1132   void (*xSFunc)(sqlite3_context*,int,sqlite3_value**) = 0;
1133   void *pArg = 0;
1134   FuncDef *pNew;
1135   int rc = 0;
1136 
1137   /* Check to see the left operand is a column in a virtual table */
1138   if( NEVER(pExpr==0) ) return pDef;
1139   if( pExpr->op!=TK_COLUMN ) return pDef;
1140   assert( ExprUseYTab(pExpr) );
1141   pTab = pExpr->y.pTab;
1142   if( pTab==0 ) return pDef;
1143   if( !IsVirtual(pTab) ) return pDef;
1144   pVtab = sqlite3GetVTable(db, pTab)->pVtab;
1145   assert( pVtab!=0 );
1146   assert( pVtab->pModule!=0 );
1147   pMod = (sqlite3_module *)pVtab->pModule;
1148   if( pMod->xFindFunction==0 ) return pDef;
1149 
1150   /* Call the xFindFunction method on the virtual table implementation
1151   ** to see if the implementation wants to overload this function.
1152   **
1153   ** Though undocumented, we have historically always invoked xFindFunction
1154   ** with an all lower-case function name.  Continue in this tradition to
1155   ** avoid any chance of an incompatibility.
1156   */
1157 #ifdef SQLITE_DEBUG
1158   {
1159     int i;
1160     for(i=0; pDef->zName[i]; i++){
1161       unsigned char x = (unsigned char)pDef->zName[i];
1162       assert( x==sqlite3UpperToLower[x] );
1163     }
1164   }
1165 #endif
1166   rc = pMod->xFindFunction(pVtab, nArg, pDef->zName, &xSFunc, &pArg);
1167   if( rc==0 ){
1168     return pDef;
1169   }
1170 
1171   /* Create a new ephemeral function definition for the overloaded
1172   ** function */
1173   pNew = sqlite3DbMallocZero(db, sizeof(*pNew)
1174                              + sqlite3Strlen30(pDef->zName) + 1);
1175   if( pNew==0 ){
1176     return pDef;
1177   }
1178   *pNew = *pDef;
1179   pNew->zName = (const char*)&pNew[1];
1180   memcpy((char*)&pNew[1], pDef->zName, sqlite3Strlen30(pDef->zName)+1);
1181   pNew->xSFunc = xSFunc;
1182   pNew->pUserData = pArg;
1183   pNew->funcFlags |= SQLITE_FUNC_EPHEM;
1184   return pNew;
1185 }
1186 
1187 /*
1188 ** Make sure virtual table pTab is contained in the pParse->apVirtualLock[]
1189 ** array so that an OP_VBegin will get generated for it.  Add pTab to the
1190 ** array if it is missing.  If pTab is already in the array, this routine
1191 ** is a no-op.
1192 */
1193 void sqlite3VtabMakeWritable(Parse *pParse, Table *pTab){
1194   Parse *pToplevel = sqlite3ParseToplevel(pParse);
1195   int i, n;
1196   Table **apVtabLock;
1197 
1198   assert( IsVirtual(pTab) );
1199   for(i=0; i<pToplevel->nVtabLock; i++){
1200     if( pTab==pToplevel->apVtabLock[i] ) return;
1201   }
1202   n = (pToplevel->nVtabLock+1)*sizeof(pToplevel->apVtabLock[0]);
1203   apVtabLock = sqlite3Realloc(pToplevel->apVtabLock, n);
1204   if( apVtabLock ){
1205     pToplevel->apVtabLock = apVtabLock;
1206     pToplevel->apVtabLock[pToplevel->nVtabLock++] = pTab;
1207   }else{
1208     sqlite3OomFault(pToplevel->db);
1209   }
1210 }
1211 
1212 /*
1213 ** Check to see if virtual table module pMod can be have an eponymous
1214 ** virtual table instance.  If it can, create one if one does not already
1215 ** exist. Return non-zero if either the eponymous virtual table instance
1216 ** exists when this routine returns or if an attempt to create it failed
1217 ** and an error message was left in pParse.
1218 **
1219 ** An eponymous virtual table instance is one that is named after its
1220 ** module, and more importantly, does not require a CREATE VIRTUAL TABLE
1221 ** statement in order to come into existance.  Eponymous virtual table
1222 ** instances always exist.  They cannot be DROP-ed.
1223 **
1224 ** Any virtual table module for which xConnect and xCreate are the same
1225 ** method can have an eponymous virtual table instance.
1226 */
1227 int sqlite3VtabEponymousTableInit(Parse *pParse, Module *pMod){
1228   const sqlite3_module *pModule = pMod->pModule;
1229   Table *pTab;
1230   char *zErr = 0;
1231   int rc;
1232   sqlite3 *db = pParse->db;
1233   if( pMod->pEpoTab ) return 1;
1234   if( pModule->xCreate!=0 && pModule->xCreate!=pModule->xConnect ) return 0;
1235   pTab = sqlite3DbMallocZero(db, sizeof(Table));
1236   if( pTab==0 ) return 0;
1237   pTab->zName = sqlite3DbStrDup(db, pMod->zName);
1238   if( pTab->zName==0 ){
1239     sqlite3DbFree(db, pTab);
1240     return 0;
1241   }
1242   pMod->pEpoTab = pTab;
1243   pTab->nTabRef = 1;
1244   pTab->eTabType = TABTYP_VTAB;
1245   pTab->pSchema = db->aDb[0].pSchema;
1246   assert( pTab->u.vtab.nArg==0 );
1247   pTab->iPKey = -1;
1248   pTab->tabFlags |= TF_Eponymous;
1249   addModuleArgument(pParse, pTab, sqlite3DbStrDup(db, pTab->zName));
1250   addModuleArgument(pParse, pTab, 0);
1251   addModuleArgument(pParse, pTab, sqlite3DbStrDup(db, pTab->zName));
1252   rc = vtabCallConstructor(db, pTab, pMod, pModule->xConnect, &zErr);
1253   if( rc ){
1254     sqlite3ErrorMsg(pParse, "%s", zErr);
1255     sqlite3DbFree(db, zErr);
1256     sqlite3VtabEponymousTableClear(db, pMod);
1257   }
1258   return 1;
1259 }
1260 
1261 /*
1262 ** Erase the eponymous virtual table instance associated with
1263 ** virtual table module pMod, if it exists.
1264 */
1265 void sqlite3VtabEponymousTableClear(sqlite3 *db, Module *pMod){
1266   Table *pTab = pMod->pEpoTab;
1267   if( pTab!=0 ){
1268     /* Mark the table as Ephemeral prior to deleting it, so that the
1269     ** sqlite3DeleteTable() routine will know that it is not stored in
1270     ** the schema. */
1271     pTab->tabFlags |= TF_Ephemeral;
1272     sqlite3DeleteTable(db, pTab);
1273     pMod->pEpoTab = 0;
1274   }
1275 }
1276 
1277 /*
1278 ** Return the ON CONFLICT resolution mode in effect for the virtual
1279 ** table update operation currently in progress.
1280 **
1281 ** The results of this routine are undefined unless it is called from
1282 ** within an xUpdate method.
1283 */
1284 int sqlite3_vtab_on_conflict(sqlite3 *db){
1285   static const unsigned char aMap[] = {
1286     SQLITE_ROLLBACK, SQLITE_ABORT, SQLITE_FAIL, SQLITE_IGNORE, SQLITE_REPLACE
1287   };
1288 #ifdef SQLITE_ENABLE_API_ARMOR
1289   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1290 #endif
1291   assert( OE_Rollback==1 && OE_Abort==2 && OE_Fail==3 );
1292   assert( OE_Ignore==4 && OE_Replace==5 );
1293   assert( db->vtabOnConflict>=1 && db->vtabOnConflict<=5 );
1294   return (int)aMap[db->vtabOnConflict-1];
1295 }
1296 
1297 /*
1298 ** Call from within the xCreate() or xConnect() methods to provide
1299 ** the SQLite core with additional information about the behavior
1300 ** of the virtual table being implemented.
1301 */
1302 int sqlite3_vtab_config(sqlite3 *db, int op, ...){
1303   va_list ap;
1304   int rc = SQLITE_OK;
1305   VtabCtx *p;
1306 
1307 #ifdef SQLITE_ENABLE_API_ARMOR
1308   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1309 #endif
1310   sqlite3_mutex_enter(db->mutex);
1311   p = db->pVtabCtx;
1312   if( !p ){
1313     rc = SQLITE_MISUSE_BKPT;
1314   }else{
1315     assert( p->pTab==0 || IsVirtual(p->pTab) );
1316     va_start(ap, op);
1317     switch( op ){
1318       case SQLITE_VTAB_CONSTRAINT_SUPPORT: {
1319         p->pVTable->bConstraint = (u8)va_arg(ap, int);
1320         break;
1321       }
1322       case SQLITE_VTAB_INNOCUOUS: {
1323         p->pVTable->eVtabRisk = SQLITE_VTABRISK_Low;
1324         break;
1325       }
1326       case SQLITE_VTAB_DIRECTONLY: {
1327         p->pVTable->eVtabRisk = SQLITE_VTABRISK_High;
1328         break;
1329       }
1330       default: {
1331         rc = SQLITE_MISUSE_BKPT;
1332         break;
1333       }
1334     }
1335     va_end(ap);
1336   }
1337 
1338   if( rc!=SQLITE_OK ) sqlite3Error(db, rc);
1339   sqlite3_mutex_leave(db->mutex);
1340   return rc;
1341 }
1342 
1343 #endif /* SQLITE_OMIT_VIRTUALTABLE */
1344