xref: /sqlite-3.40.0/src/vtab.c (revision ddfec00d)
1b9bb7c18Sdrh /*
2b9bb7c18Sdrh ** 2006 June 10
3b9bb7c18Sdrh **
4b9bb7c18Sdrh ** The author disclaims copyright to this source code.  In place of
5b9bb7c18Sdrh ** a legal notice, here is a blessing:
6b9bb7c18Sdrh **
7b9bb7c18Sdrh **    May you do good and not evil.
8b9bb7c18Sdrh **    May you find forgiveness for yourself and forgive others.
9b9bb7c18Sdrh **    May you share freely, never taking more than you give.
10b9bb7c18Sdrh **
11b9bb7c18Sdrh *************************************************************************
12b9bb7c18Sdrh ** This file contains code used to help implement virtual tables.
13b9bb7c18Sdrh */
14b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
15b9bb7c18Sdrh #include "sqliteInt.h"
16b9bb7c18Sdrh 
1763842415Sdrh /*
18b061d058Sdan ** Before a virtual table xCreate() or xConnect() method is invoked, the
19b061d058Sdan ** sqlite3.pVtabCtx member variable is set to point to an instance of
20b061d058Sdan ** this struct allocated on the stack. It is used by the implementation of
21b061d058Sdan ** the sqlite3_declare_vtab() and sqlite3_vtab_config() APIs, both of which
22b061d058Sdan ** are invoked only from within xCreate and xConnect methods.
23b061d058Sdan */
24b061d058Sdan struct VtabCtx {
2581028a45Sdrh   VTable *pVTable;    /* The virtual table being constructed */
2681028a45Sdrh   Table *pTab;        /* The Table object to which the virtual table belongs */
2775395ccdSdan   VtabCtx *pPrior;    /* Parent context (if any) */
2875395ccdSdan   int bDeclared;      /* True after sqlite3_declare_vtab() is called */
29b061d058Sdan };
30b061d058Sdan 
31b061d058Sdan /*
322fcc1590Sdrh ** Construct and install a Module object for a virtual table.  When this
332fcc1590Sdrh ** routine is called, it is guaranteed that all appropriate locks are held
342fcc1590Sdrh ** and the module is not already part of the connection.
35cc5979dbSdrh **
36cc5979dbSdrh ** If there already exists a module with zName, replace it with the new one.
37cc5979dbSdrh ** If pModule==0, then delete the module zName if it exists.
3863842415Sdrh */
392fcc1590Sdrh Module *sqlite3VtabCreateModule(
40832a58a6Sdanielk1977   sqlite3 *db,                    /* Database in which module is registered */
41832a58a6Sdanielk1977   const char *zName,              /* Name assigned to this module */
42832a58a6Sdanielk1977   const sqlite3_module *pModule,  /* The definition of the module */
43832a58a6Sdanielk1977   void *pAux,                     /* Context pointer for xCreate/xConnect */
44832a58a6Sdanielk1977   void (*xDestroy)(void *)        /* Module destructor function */
45832a58a6Sdanielk1977 ){
46ca8b9bacSdan   Module *pMod;
47cc5979dbSdrh   Module *pDel;
48cc5979dbSdrh   char *zCopy;
49cc5979dbSdrh   if( pModule==0 ){
50cc5979dbSdrh     zCopy = (char*)zName;
51cc5979dbSdrh     pMod = 0;
52cc5979dbSdrh   }else{
532fcc1590Sdrh     int nName = sqlite3Strlen30(zName);
543ee1416bSdrh     pMod = (Module *)sqlite3Malloc(sizeof(Module) + nName + 1);
553ee1416bSdrh     if( pMod==0 ){
563ee1416bSdrh       sqlite3OomFault(db);
57cc5979dbSdrh       return 0;
58cc5979dbSdrh     }
59cc5979dbSdrh     zCopy = (char *)(&pMod[1]);
60832a58a6Sdanielk1977     memcpy(zCopy, zName, nName+1);
61832a58a6Sdanielk1977     pMod->zName = zCopy;
62832a58a6Sdanielk1977     pMod->pModule = pModule;
63832a58a6Sdanielk1977     pMod->pAux = pAux;
64832a58a6Sdanielk1977     pMod->xDestroy = xDestroy;
6551be3873Sdrh     pMod->pEpoTab = 0;
66cc5979dbSdrh     pMod->nRefModule = 1;
67cc5979dbSdrh   }
68acbcb7e0Sdrh   pDel = (Module *)sqlite3HashInsert(&db->aModule,zCopy,(void*)pMod);
69ca8b9bacSdan   if( pDel ){
70cc5979dbSdrh     if( pDel==pMod ){
714a642b60Sdrh       sqlite3OomFault(db);
72ca8b9bacSdan       sqlite3DbFree(db, pDel);
739a63f092Sdrh       pMod = 0;
74cc5979dbSdrh     }else{
7587ca8067Sdrh       sqlite3VtabEponymousTableClear(db, pDel);
76cc5979dbSdrh       sqlite3VtabModuleUnref(db, pDel);
7727a430ccSdanielk1977     }
78832a58a6Sdanielk1977   }
792fcc1590Sdrh   return pMod;
802fcc1590Sdrh }
812fcc1590Sdrh 
822fcc1590Sdrh /*
832fcc1590Sdrh ** The actual function that does the work of creating a new module.
842fcc1590Sdrh ** This function implements the sqlite3_create_module() and
852fcc1590Sdrh ** sqlite3_create_module_v2() interfaces.
862fcc1590Sdrh */
872fcc1590Sdrh static int createModule(
882fcc1590Sdrh   sqlite3 *db,                    /* Database in which module is registered */
892fcc1590Sdrh   const char *zName,              /* Name assigned to this module */
902fcc1590Sdrh   const sqlite3_module *pModule,  /* The definition of the module */
912fcc1590Sdrh   void *pAux,                     /* Context pointer for xCreate/xConnect */
922fcc1590Sdrh   void (*xDestroy)(void *)        /* Module destructor function */
932fcc1590Sdrh ){
942fcc1590Sdrh   int rc = SQLITE_OK;
952fcc1590Sdrh 
962fcc1590Sdrh   sqlite3_mutex_enter(db->mutex);
972fcc1590Sdrh   (void)sqlite3VtabCreateModule(db, zName, pModule, pAux, xDestroy);
98ca8b9bacSdan   rc = sqlite3ApiExit(db, rc);
99ca8b9bacSdan   if( rc!=SQLITE_OK && xDestroy ) xDestroy(pAux);
10027641703Sdrh   sqlite3_mutex_leave(db->mutex);
10127641703Sdrh   return rc;
102832a58a6Sdanielk1977 }
103832a58a6Sdanielk1977 
104832a58a6Sdanielk1977 
105b9bb7c18Sdrh /*
106b9bb7c18Sdrh ** External API function used to create a new virtual-table module.
107b9bb7c18Sdrh */
108b9bb7c18Sdrh int sqlite3_create_module(
109b9bb7c18Sdrh   sqlite3 *db,                    /* Database in which module is registered */
110b9bb7c18Sdrh   const char *zName,              /* Name assigned to this module */
111d1ab1ba5Sdanielk1977   const sqlite3_module *pModule,  /* The definition of the module */
112d1ab1ba5Sdanielk1977   void *pAux                      /* Context pointer for xCreate/xConnect */
113b9bb7c18Sdrh ){
1149ca95730Sdrh #ifdef SQLITE_ENABLE_API_ARMOR
1159ca95730Sdrh   if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
1169ca95730Sdrh #endif
117832a58a6Sdanielk1977   return createModule(db, zName, pModule, pAux, 0);
118d1ab1ba5Sdanielk1977 }
119832a58a6Sdanielk1977 
120832a58a6Sdanielk1977 /*
121832a58a6Sdanielk1977 ** External API function used to create a new virtual-table module.
122832a58a6Sdanielk1977 */
123832a58a6Sdanielk1977 int sqlite3_create_module_v2(
124832a58a6Sdanielk1977   sqlite3 *db,                    /* Database in which module is registered */
125832a58a6Sdanielk1977   const char *zName,              /* Name assigned to this module */
126832a58a6Sdanielk1977   const sqlite3_module *pModule,  /* The definition of the module */
127832a58a6Sdanielk1977   void *pAux,                     /* Context pointer for xCreate/xConnect */
128832a58a6Sdanielk1977   void (*xDestroy)(void *)        /* Module destructor function */
129832a58a6Sdanielk1977 ){
1309ca95730Sdrh #ifdef SQLITE_ENABLE_API_ARMOR
1319ca95730Sdrh   if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
1329ca95730Sdrh #endif
133832a58a6Sdanielk1977   return createModule(db, zName, pModule, pAux, xDestroy);
134b9bb7c18Sdrh }
135b9bb7c18Sdrh 
136b9bb7c18Sdrh /*
1375df84280Sdrh ** External API to drop all virtual-table modules, except those named
1385df84280Sdrh ** on the azNames list.
1395df84280Sdrh */
1408c754a36Sdrh int sqlite3_drop_modules(sqlite3 *db, const char** azNames){
1415df84280Sdrh   HashElem *pThis, *pNext;
1425df84280Sdrh #ifdef SQLITE_ENABLE_API_ARMOR
1433722b3abSmistachkin   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1445df84280Sdrh #endif
1455df84280Sdrh   for(pThis=sqliteHashFirst(&db->aModule); pThis; pThis=pNext){
1465df84280Sdrh     Module *pMod = (Module*)sqliteHashData(pThis);
1475df84280Sdrh     pNext = sqliteHashNext(pThis);
1485df84280Sdrh     if( azNames ){
1495df84280Sdrh       int ii;
1505df84280Sdrh       for(ii=0; azNames[ii]!=0 && strcmp(azNames[ii],pMod->zName)!=0; ii++){}
1515df84280Sdrh       if( azNames[ii]!=0 ) continue;
1525df84280Sdrh     }
1535df84280Sdrh     createModule(db, pMod->zName, 0, 0, 0);
1545df84280Sdrh   }
1555df84280Sdrh   return SQLITE_OK;
1565df84280Sdrh }
1575df84280Sdrh 
1585df84280Sdrh /*
159cc5979dbSdrh ** Decrement the reference count on a Module object.  Destroy the
160cc5979dbSdrh ** module when the reference count reaches zero.
161cc5979dbSdrh */
162cc5979dbSdrh void sqlite3VtabModuleUnref(sqlite3 *db, Module *pMod){
163cc5979dbSdrh   assert( pMod->nRefModule>0 );
164cc5979dbSdrh   pMod->nRefModule--;
165cc5979dbSdrh   if( pMod->nRefModule==0 ){
166cc5979dbSdrh     if( pMod->xDestroy ){
167cc5979dbSdrh       pMod->xDestroy(pMod->pAux);
168cc5979dbSdrh     }
169cc5979dbSdrh     assert( pMod->pEpoTab==0 );
170cc5979dbSdrh     sqlite3DbFree(db, pMod);
171cc5979dbSdrh   }
172cc5979dbSdrh }
173cc5979dbSdrh 
174cc5979dbSdrh /*
175189d4afaSdrh ** Lock the virtual table so that it cannot be disconnected.
176189d4afaSdrh ** Locks nest.  Every lock should have a corresponding unlock.
177189d4afaSdrh ** If an unlock is omitted, resources leaks will occur.
178189d4afaSdrh **
179189d4afaSdrh ** If a disconnect is attempted while a virtual table is locked,
180189d4afaSdrh ** the disconnect is deferred until all locks have been removed.
181189d4afaSdrh */
182595a523aSdanielk1977 void sqlite3VtabLock(VTable *pVTab){
183595a523aSdanielk1977   pVTab->nRef++;
184595a523aSdanielk1977 }
185595a523aSdanielk1977 
186595a523aSdanielk1977 
187595a523aSdanielk1977 /*
188595a523aSdanielk1977 ** pTab is a pointer to a Table structure representing a virtual-table.
189595a523aSdanielk1977 ** Return a pointer to the VTable object used by connection db to access
190595a523aSdanielk1977 ** this virtual-table, if one has been created, or NULL otherwise.
191595a523aSdanielk1977 */
192595a523aSdanielk1977 VTable *sqlite3GetVTable(sqlite3 *db, Table *pTab){
193595a523aSdanielk1977   VTable *pVtab;
194595a523aSdanielk1977   assert( IsVirtual(pTab) );
195f38524d2Sdrh   for(pVtab=pTab->u.vtab.p; pVtab && pVtab->db!=db; pVtab=pVtab->pNext);
196595a523aSdanielk1977   return pVtab;
197189d4afaSdrh }
198189d4afaSdrh 
199189d4afaSdrh /*
200595a523aSdanielk1977 ** Decrement the ref-count on a virtual table object. When the ref-count
201595a523aSdanielk1977 ** reaches zero, call the xDisconnect() method to delete the object.
202189d4afaSdrh */
203595a523aSdanielk1977 void sqlite3VtabUnlock(VTable *pVTab){
204595a523aSdanielk1977   sqlite3 *db = pVTab->db;
205595a523aSdanielk1977 
206a04a34ffSdanielk1977   assert( db );
207595a523aSdanielk1977   assert( pVTab->nRef>0 );
2085f9de6ecSdrh   assert( db->eOpenState==SQLITE_STATE_OPEN
2095f9de6ecSdrh        || db->eOpenState==SQLITE_STATE_ZOMBIE );
210595a523aSdanielk1977 
211595a523aSdanielk1977   pVTab->nRef--;
212595a523aSdanielk1977   if( pVTab->nRef==0 ){
213595a523aSdanielk1977     sqlite3_vtab *p = pVTab->pVtab;
214cc5979dbSdrh     sqlite3VtabModuleUnref(pVTab->db, pVTab->pMod);
215595a523aSdanielk1977     if( p ){
216595a523aSdanielk1977       p->pModule->xDisconnect(p);
217189d4afaSdrh     }
218595a523aSdanielk1977     sqlite3DbFree(db, pVTab);
219595a523aSdanielk1977   }
220595a523aSdanielk1977 }
221595a523aSdanielk1977 
222595a523aSdanielk1977 /*
223595a523aSdanielk1977 ** Table p is a virtual table. This function moves all elements in the
224f38524d2Sdrh ** p->u.vtab.p list to the sqlite3.pDisconnect lists of their associated
225595a523aSdanielk1977 ** database connections to be disconnected at the next opportunity.
226595a523aSdanielk1977 ** Except, if argument db is not NULL, then the entry associated with
227f38524d2Sdrh ** connection db is left in the p->u.vtab.p list.
228595a523aSdanielk1977 */
229595a523aSdanielk1977 static VTable *vtabDisconnectAll(sqlite3 *db, Table *p){
230595a523aSdanielk1977   VTable *pRet = 0;
23178b2fa86Sdrh   VTable *pVTable;
23278b2fa86Sdrh 
23378b2fa86Sdrh   assert( IsVirtual(p) );
23478b2fa86Sdrh   pVTable = p->u.vtab.p;
235f38524d2Sdrh   p->u.vtab.p = 0;
236595a523aSdanielk1977 
237595a523aSdanielk1977   /* Assert that the mutex (if any) associated with the BtShared database
238595a523aSdanielk1977   ** that contains table p is held by the caller. See header comments
239595a523aSdanielk1977   ** above function sqlite3VtabUnlockList() for an explanation of why
240595a523aSdanielk1977   ** this makes it safe to access the sqlite3.pDisconnect list of any
241f38524d2Sdrh   ** database connection that may have an entry in the p->u.vtab.p list.
2429bbc2e28Sdrh   */
2439bbc2e28Sdrh   assert( db==0 || sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
244595a523aSdanielk1977 
245595a523aSdanielk1977   while( pVTable ){
246595a523aSdanielk1977     sqlite3 *db2 = pVTable->db;
247595a523aSdanielk1977     VTable *pNext = pVTable->pNext;
248595a523aSdanielk1977     assert( db2 );
249595a523aSdanielk1977     if( db2==db ){
250595a523aSdanielk1977       pRet = pVTable;
251f38524d2Sdrh       p->u.vtab.p = pRet;
252595a523aSdanielk1977       pRet->pNext = 0;
253595a523aSdanielk1977     }else{
254595a523aSdanielk1977       pVTable->pNext = db2->pDisconnect;
255595a523aSdanielk1977       db2->pDisconnect = pVTable;
256595a523aSdanielk1977     }
257595a523aSdanielk1977     pVTable = pNext;
258595a523aSdanielk1977   }
259595a523aSdanielk1977 
260595a523aSdanielk1977   assert( !db || pRet );
261595a523aSdanielk1977   return pRet;
262595a523aSdanielk1977 }
263595a523aSdanielk1977 
264bba02a95Sdan /*
265bba02a95Sdan ** Table *p is a virtual table. This function removes the VTable object
266bba02a95Sdan ** for table *p associated with database connection db from the linked
267bba02a95Sdan ** list in p->pVTab. It also decrements the VTable ref count. This is
268bba02a95Sdan ** used when closing database connection db to free all of its VTable
269bba02a95Sdan ** objects without disturbing the rest of the Schema object (which may
270bba02a95Sdan ** be being used by other shared-cache connections).
271bba02a95Sdan */
272bba02a95Sdan void sqlite3VtabDisconnect(sqlite3 *db, Table *p){
273bba02a95Sdan   VTable **ppVTab;
274bba02a95Sdan 
275bba02a95Sdan   assert( IsVirtual(p) );
276bba02a95Sdan   assert( sqlite3BtreeHoldsAllMutexes(db) );
277bba02a95Sdan   assert( sqlite3_mutex_held(db->mutex) );
278bba02a95Sdan 
279f38524d2Sdrh   for(ppVTab=&p->u.vtab.p; *ppVTab; ppVTab=&(*ppVTab)->pNext){
280bba02a95Sdan     if( (*ppVTab)->db==db  ){
281bba02a95Sdan       VTable *pVTab = *ppVTab;
282bba02a95Sdan       *ppVTab = pVTab->pNext;
283bba02a95Sdan       sqlite3VtabUnlock(pVTab);
284bba02a95Sdan       break;
285bba02a95Sdan     }
286bba02a95Sdan   }
287bba02a95Sdan }
288bba02a95Sdan 
289595a523aSdanielk1977 
290595a523aSdanielk1977 /*
291595a523aSdanielk1977 ** Disconnect all the virtual table objects in the sqlite3.pDisconnect list.
292595a523aSdanielk1977 **
293595a523aSdanielk1977 ** This function may only be called when the mutexes associated with all
294595a523aSdanielk1977 ** shared b-tree databases opened using connection db are held by the
295595a523aSdanielk1977 ** caller. This is done to protect the sqlite3.pDisconnect list. The
296595a523aSdanielk1977 ** sqlite3.pDisconnect list is accessed only as follows:
297595a523aSdanielk1977 **
298595a523aSdanielk1977 **   1) By this function. In this case, all BtShared mutexes and the mutex
299595a523aSdanielk1977 **      associated with the database handle itself must be held.
300595a523aSdanielk1977 **
301595a523aSdanielk1977 **   2) By function vtabDisconnectAll(), when it adds a VTable entry to
302595a523aSdanielk1977 **      the sqlite3.pDisconnect list. In this case either the BtShared mutex
303595a523aSdanielk1977 **      associated with the database the virtual table is stored in is held
304595a523aSdanielk1977 **      or, if the virtual table is stored in a non-sharable database, then
305595a523aSdanielk1977 **      the database handle mutex is held.
306595a523aSdanielk1977 **
307595a523aSdanielk1977 ** As a result, a sqlite3.pDisconnect cannot be accessed simultaneously
308595a523aSdanielk1977 ** by multiple threads. It is thread-safe.
309595a523aSdanielk1977 */
310595a523aSdanielk1977 void sqlite3VtabUnlockList(sqlite3 *db){
311595a523aSdanielk1977   VTable *p = db->pDisconnect;
312595a523aSdanielk1977 
313595a523aSdanielk1977   assert( sqlite3BtreeHoldsAllMutexes(db) );
314595a523aSdanielk1977   assert( sqlite3_mutex_held(db->mutex) );
315595a523aSdanielk1977 
316595a523aSdanielk1977   if( p ){
3171de92a64Sdrh     db->pDisconnect = 0;
318ba968dbfSdrh     sqlite3ExpirePreparedStatements(db, 0);
319595a523aSdanielk1977     do {
320595a523aSdanielk1977       VTable *pNext = p->pNext;
321595a523aSdanielk1977       sqlite3VtabUnlock(p);
322595a523aSdanielk1977       p = pNext;
323595a523aSdanielk1977     }while( p );
324595a523aSdanielk1977   }
325189d4afaSdrh }
326189d4afaSdrh 
327189d4afaSdrh /*
328b9bb7c18Sdrh ** Clear any and all virtual-table information from the Table record.
329b9bb7c18Sdrh ** This routine is called, for example, just before deleting the Table
330b9bb7c18Sdrh ** record.
331595a523aSdanielk1977 **
332595a523aSdanielk1977 ** Since it is a virtual-table, the Table structure contains a pointer
333595a523aSdanielk1977 ** to the head of a linked list of VTable structures. Each VTable
334595a523aSdanielk1977 ** structure is associated with a single sqlite3* user of the schema.
335595a523aSdanielk1977 ** The reference count of the VTable structure associated with database
336595a523aSdanielk1977 ** connection db is decremented immediately (which may lead to the
337595a523aSdanielk1977 ** structure being xDisconnected and free). Any other VTable structures
338595a523aSdanielk1977 ** in the list are moved to the sqlite3.pDisconnect list of the associated
339595a523aSdanielk1977 ** database connection.
340b9bb7c18Sdrh */
3411feeaed2Sdan void sqlite3VtabClear(sqlite3 *db, Table *p){
34278b2fa86Sdrh   assert( IsVirtual(p) );
343d46def77Sdan   if( !db || db->pnBytesFreed==0 ) vtabDisconnectAll(0, p);
344f38524d2Sdrh   if( p->u.vtab.azArg ){
345b9bb7c18Sdrh     int i;
346f38524d2Sdrh     for(i=0; i<p->u.vtab.nArg; i++){
347f38524d2Sdrh       if( i!=1 ) sqlite3DbFree(db, p->u.vtab.azArg[i]);
348b9bb7c18Sdrh     }
349f38524d2Sdrh     sqlite3DbFree(db, p->u.vtab.azArg);
350b9bb7c18Sdrh   }
351b9bb7c18Sdrh }
352b9bb7c18Sdrh 
353b9bb7c18Sdrh /*
354f38524d2Sdrh ** Add a new module argument to pTable->u.vtab.azArg[].
355b9bb7c18Sdrh ** The string is not copied - the pointer is stored.  The
356b9bb7c18Sdrh ** string will be freed automatically when the table is
357b9bb7c18Sdrh ** deleted.
358b9bb7c18Sdrh */
3590aa3231fSdrh static void addModuleArgument(Parse *pParse, Table *pTable, char *zArg){
36078b2fa86Sdrh   sqlite3_int64 nBytes;
361b7a2f2e8Sdanielk1977   char **azModuleArg;
3620aa3231fSdrh   sqlite3 *db = pParse->db;
36378b2fa86Sdrh 
36478b2fa86Sdrh   assert( IsVirtual(pTable) );
36578b2fa86Sdrh   nBytes = sizeof(char *)*(2+pTable->u.vtab.nArg);
366f38524d2Sdrh   if( pTable->u.vtab.nArg+3>=db->aLimit[SQLITE_LIMIT_COLUMN] ){
3670aa3231fSdrh     sqlite3ErrorMsg(pParse, "too many columns on %s", pTable->zName);
3680aa3231fSdrh   }
369f38524d2Sdrh   azModuleArg = sqlite3DbRealloc(db, pTable->u.vtab.azArg, nBytes);
370b7a2f2e8Sdanielk1977   if( azModuleArg==0 ){
371633e6d57Sdrh     sqlite3DbFree(db, zArg);
372b7a2f2e8Sdanielk1977   }else{
373f38524d2Sdrh     int i = pTable->u.vtab.nArg++;
374b7a2f2e8Sdanielk1977     azModuleArg[i] = zArg;
375b7a2f2e8Sdanielk1977     azModuleArg[i+1] = 0;
376f38524d2Sdrh     pTable->u.vtab.azArg = azModuleArg;
377b9bb7c18Sdrh   }
3780e07f6aeSdrh }
379b9bb7c18Sdrh 
380b9bb7c18Sdrh /*
381b9bb7c18Sdrh ** The parser calls this routine when it first sees a CREATE VIRTUAL TABLE
382b9bb7c18Sdrh ** statement.  The module name has been parsed, but the optional list
383b9bb7c18Sdrh ** of parameters that follow the module name are still pending.
384b9bb7c18Sdrh */
385b9bb7c18Sdrh void sqlite3VtabBeginParse(
386b9bb7c18Sdrh   Parse *pParse,        /* Parsing context */
387b9bb7c18Sdrh   Token *pName1,        /* Name of new table, or database name */
388b9bb7c18Sdrh   Token *pName2,        /* Name of new table or NULL */
389b421b894Sdrh   Token *pModuleName,   /* Name of the module for the virtual table */
390b421b894Sdrh   int ifNotExists       /* No error if the table already exists */
391b9bb7c18Sdrh ){
392b9bb7c18Sdrh   Table *pTable;        /* The new virtual table */
39317435752Sdrh   sqlite3 *db;          /* Database connection */
394b9bb7c18Sdrh 
395b421b894Sdrh   sqlite3StartTable(pParse, pName1, pName2, 0, 0, 1, ifNotExists);
396b9bb7c18Sdrh   pTable = pParse->pNewTable;
397748ce211Sdrh   if( pTable==0 ) return;
398f1a381e7Sdanielk1977   assert( 0==pTable->pIndex );
399f38524d2Sdrh   pTable->eTabType = TABTYP_VTAB;
400f1a381e7Sdanielk1977 
40117435752Sdrh   db = pParse->db;
40270ba1640Sdanielk1977 
403f38524d2Sdrh   assert( pTable->u.vtab.nArg==0 );
4040aa3231fSdrh   addModuleArgument(pParse, pTable, sqlite3NameFromToken(db, pModuleName));
4050aa3231fSdrh   addModuleArgument(pParse, pTable, 0);
4060aa3231fSdrh   addModuleArgument(pParse, pTable, sqlite3DbStrDup(db, pTable->zName));
407d89b834fSdan   assert( (pParse->sNameToken.z==pName2->z && pName2->z!=0)
408d89b834fSdan        || (pParse->sNameToken.z==pName1->z && pName2->z==0)
409d89b834fSdan   );
410d89b834fSdan   pParse->sNameToken.n = (int)(
411d89b834fSdan       &pModuleName->z[pModuleName->n] - pParse->sNameToken.z
412d89b834fSdan   );
413f1a381e7Sdanielk1977 
414f1a381e7Sdanielk1977 #ifndef SQLITE_OMIT_AUTHORIZATION
415f1a381e7Sdanielk1977   /* Creating a virtual table invokes the authorization callback twice.
416f1a381e7Sdanielk1977   ** The first invocation, to obtain permission to INSERT a row into the
4171e32bed3Sdrh   ** sqlite_schema table, has already been made by sqlite3StartTable().
418f1a381e7Sdanielk1977   ** The second call, to obtain permission to create the table, is made now.
419f1a381e7Sdanielk1977   */
420f38524d2Sdrh   if( pTable->u.vtab.azArg ){
4217cc5595aSmistachkin     int iDb = sqlite3SchemaToIndex(db, pTable->pSchema);
4227cc5595aSmistachkin     assert( iDb>=0 ); /* The database the table is being created in */
423be718897Sdanielk1977     sqlite3AuthCheck(pParse, SQLITE_CREATE_VTABLE, pTable->zName,
424f38524d2Sdrh             pTable->u.vtab.azArg[0], pParse->db->aDb[iDb].zDbSName);
425f1a381e7Sdanielk1977   }
426f1a381e7Sdanielk1977 #endif
427b9bb7c18Sdrh }
428b9bb7c18Sdrh 
429b9bb7c18Sdrh /*
430b9bb7c18Sdrh ** This routine takes the module argument that has been accumulating
431b9bb7c18Sdrh ** in pParse->zArg[] and appends it to the list of arguments on the
432b9bb7c18Sdrh ** virtual table currently under construction in pParse->pTable.
433b9bb7c18Sdrh */
434b9bb7c18Sdrh static void addArgumentToVtab(Parse *pParse){
435b421b894Sdrh   if( pParse->sArg.z && pParse->pNewTable ){
4367c2d87cdSdrh     const char *z = (const char*)pParse->sArg.z;
43733b3933cSdanielk1977     int n = pParse->sArg.n;
43817435752Sdrh     sqlite3 *db = pParse->db;
4390aa3231fSdrh     addModuleArgument(pParse, pParse->pNewTable, sqlite3DbStrNDup(db, z, n));
440b9bb7c18Sdrh   }
441b9bb7c18Sdrh }
442b9bb7c18Sdrh 
443b9bb7c18Sdrh /*
444b9bb7c18Sdrh ** The parser calls this routine after the CREATE VIRTUAL TABLE statement
445b9bb7c18Sdrh ** has been completely parsed.
446b9bb7c18Sdrh */
447b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse *pParse, Token *pEnd){
448595a523aSdanielk1977   Table *pTab = pParse->pNewTable;  /* The table being constructed */
449595a523aSdanielk1977   sqlite3 *db = pParse->db;         /* The database connection */
450b9bb7c18Sdrh 
451595a523aSdanielk1977   if( pTab==0 ) return;
45278b2fa86Sdrh   assert( IsVirtual(pTab) );
453b9bb7c18Sdrh   addArgumentToVtab(pParse);
45433b3933cSdanielk1977   pParse->sArg.z = 0;
455f38524d2Sdrh   if( pTab->u.vtab.nArg<1 ) return;
456b9bb7c18Sdrh 
457b9bb7c18Sdrh   /* If the CREATE VIRTUAL TABLE statement is being entered for the
458b9bb7c18Sdrh   ** first time (in other words if the virtual table is actually being
4591e32bed3Sdrh   ** created now instead of just being read out of sqlite_schema) then
460b9bb7c18Sdrh   ** do additional initialization work and store the statement text
4611e32bed3Sdrh   ** in the sqlite_schema table.
462b9bb7c18Sdrh   */
463b9bb7c18Sdrh   if( !db->init.busy ){
464b9bb7c18Sdrh     char *zStmt;
46578efaba1Sdanielk1977     char *zWhere;
466b9bb7c18Sdrh     int iDb;
4677377945aSdan     int iReg;
468b9bb7c18Sdrh     Vdbe *v;
469b9bb7c18Sdrh 
4708e8c8896Sdrh     sqlite3MayAbort(pParse);
4718e8c8896Sdrh 
472b9bb7c18Sdrh     /* Compute the complete text of the CREATE VIRTUAL TABLE statement */
473b9bb7c18Sdrh     if( pEnd ){
474b27b7f5dSdrh       pParse->sNameToken.n = (int)(pEnd->z - pParse->sNameToken.z) + pEnd->n;
475b9bb7c18Sdrh     }
4761e536953Sdanielk1977     zStmt = sqlite3MPrintf(db, "CREATE VIRTUAL TABLE %T", &pParse->sNameToken);
477b9bb7c18Sdrh 
478b9bb7c18Sdrh     /* A slot for the record has already been allocated in the
479346a70caSdrh     ** schema table.  We just need to update that slot with all
48078efaba1Sdanielk1977     ** the information we've collected.
48178efaba1Sdanielk1977     **
482b7654111Sdrh     ** The VM register number pParse->regRowid holds the rowid of an
4831e32bed3Sdrh     ** entry in the sqlite_schema table tht was created for this vtab
484b7654111Sdrh     ** by sqlite3StartTable().
485b9bb7c18Sdrh     */
486b9bb7c18Sdrh     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
487b9bb7c18Sdrh     sqlite3NestedParse(pParse,
488346a70caSdrh       "UPDATE %Q." DFLT_SCHEMA_TABLE " "
48978efaba1Sdanielk1977          "SET type='table', name=%Q, tbl_name=%Q, rootpage=0, sql=%Q "
490b7654111Sdrh        "WHERE rowid=#%d",
491346a70caSdrh       db->aDb[iDb].zDbSName,
492b9bb7c18Sdrh       pTab->zName,
493b9bb7c18Sdrh       pTab->zName,
494b7654111Sdrh       zStmt,
495b7654111Sdrh       pParse->regRowid
496b9bb7c18Sdrh     );
497b9bb7c18Sdrh     v = sqlite3GetVdbe(pParse);
4989cbf3425Sdrh     sqlite3ChangeCookie(pParse, iDb);
49978efaba1Sdanielk1977 
50001c736dbSdrh     sqlite3VdbeAddOp0(v, OP_Expire);
501f4f31df0Sdrh     zWhere = sqlite3MPrintf(db, "name=%Q AND sql=%Q", pTab->zName, zStmt);
5026a5a13dfSdan     sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere, 0);
503f4f31df0Sdrh     sqlite3DbFree(db, zStmt);
5047377945aSdan 
5057377945aSdan     iReg = ++pParse->nMem;
506076e85f5Sdrh     sqlite3VdbeLoadString(v, iReg, pTab->zName);
5077377945aSdan     sqlite3VdbeAddOp2(v, OP_VCreate, iDb, iReg);
508*ddfec00dSdrh   }else{
5091e32bed3Sdrh     /* If we are rereading the sqlite_schema table create the in-memory
510*ddfec00dSdrh     ** record of the table. */
51178efaba1Sdanielk1977     Table *pOld;
51278efaba1Sdanielk1977     Schema *pSchema = pTab->pSchema;
51378efaba1Sdanielk1977     const char *zName = pTab->zName;
514*ddfec00dSdrh     assert( zName!=0 );
515*ddfec00dSdrh     sqlite3MarkAllShadowTablesOf(db, pTab);
516acbcb7e0Sdrh     pOld = sqlite3HashInsert(&pSchema->tblHash, zName, pTab);
51778efaba1Sdanielk1977     if( pOld ){
5184a642b60Sdrh       sqlite3OomFault(db);
51978efaba1Sdanielk1977       assert( pTab==pOld );  /* Malloc must have failed inside HashInsert() */
52078efaba1Sdanielk1977       return;
52178efaba1Sdanielk1977     }
5227e6ebfb2Sdanielk1977     pParse->pNewTable = 0;
523b9bb7c18Sdrh   }
524b9bb7c18Sdrh }
525b9bb7c18Sdrh 
526b9bb7c18Sdrh /*
527b9bb7c18Sdrh ** The parser calls this routine when it sees the first token
528b9bb7c18Sdrh ** of an argument to the module name in a CREATE VIRTUAL TABLE statement.
529b9bb7c18Sdrh */
530b9bb7c18Sdrh void sqlite3VtabArgInit(Parse *pParse){
531b9bb7c18Sdrh   addArgumentToVtab(pParse);
53233b3933cSdanielk1977   pParse->sArg.z = 0;
53333b3933cSdanielk1977   pParse->sArg.n = 0;
534b9bb7c18Sdrh }
535b9bb7c18Sdrh 
536b9bb7c18Sdrh /*
537b9bb7c18Sdrh ** The parser calls this routine for each token after the first token
538b9bb7c18Sdrh ** in an argument to the module name in a CREATE VIRTUAL TABLE statement.
539b9bb7c18Sdrh */
540b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse *pParse, Token *p){
54133b3933cSdanielk1977   Token *pArg = &pParse->sArg;
54233b3933cSdanielk1977   if( pArg->z==0 ){
54333b3933cSdanielk1977     pArg->z = p->z;
54433b3933cSdanielk1977     pArg->n = p->n;
54533b3933cSdanielk1977   }else{
546542a176dSdrh     assert(pArg->z <= p->z);
547b27b7f5dSdrh     pArg->n = (int)(&p->z[p->n] - pArg->z);
548b9bb7c18Sdrh   }
549b9bb7c18Sdrh }
550b9bb7c18Sdrh 
55178efaba1Sdanielk1977 /*
5529da9d471Sdanielk1977 ** Invoke a virtual table constructor (either xCreate or xConnect). The
5539da9d471Sdanielk1977 ** pointer to the function to invoke is passed as the fourth parameter
5549da9d471Sdanielk1977 ** to this procedure.
5559da9d471Sdanielk1977 */
5569da9d471Sdanielk1977 static int vtabCallConstructor(
5579da9d471Sdanielk1977   sqlite3 *db,
5589da9d471Sdanielk1977   Table *pTab,
559d1ab1ba5Sdanielk1977   Module *pMod,
560e4102960Sdrh   int (*xConstruct)(sqlite3*,void*,int,const char*const*,sqlite3_vtab**,char**),
5619da9d471Sdanielk1977   char **pzErr
5629da9d471Sdanielk1977 ){
56375395ccdSdan   VtabCtx sCtx;
564595a523aSdanielk1977   VTable *pVTable;
5659da9d471Sdanielk1977   int rc;
56678b2fa86Sdrh   const char *const*azArg;
567f38524d2Sdrh   int nArg = pTab->u.vtab.nArg;
5684ca8aac2Sdrh   char *zErr = 0;
56975395ccdSdan   char *zModuleName;
57041fb5cd1Sdan   int iDb;
57175395ccdSdan   VtabCtx *pCtx;
5729da9d471Sdanielk1977 
57378b2fa86Sdrh   assert( IsVirtual(pTab) );
57478b2fa86Sdrh   azArg = (const char *const*)pTab->u.vtab.azArg;
57578b2fa86Sdrh 
57675395ccdSdan   /* Check that the virtual-table is not already being initialized */
57775395ccdSdan   for(pCtx=db->pVtabCtx; pCtx; pCtx=pCtx->pPrior){
57875395ccdSdan     if( pCtx->pTab==pTab ){
57975395ccdSdan       *pzErr = sqlite3MPrintf(db,
58075395ccdSdan           "vtable constructor called recursively: %s", pTab->zName
58175395ccdSdan       );
58275395ccdSdan       return SQLITE_LOCKED;
58375395ccdSdan     }
58475395ccdSdan   }
58575395ccdSdan 
5863ee1416bSdrh   zModuleName = sqlite3DbStrDup(db, pTab->zName);
58701256832Sdanielk1977   if( !zModuleName ){
588fad3039cSmistachkin     return SQLITE_NOMEM_BKPT;
58901256832Sdanielk1977   }
59001256832Sdanielk1977 
5913ee1416bSdrh   pVTable = sqlite3MallocZero(sizeof(VTable));
592595a523aSdanielk1977   if( !pVTable ){
5933ee1416bSdrh     sqlite3OomFault(db);
594595a523aSdanielk1977     sqlite3DbFree(db, zModuleName);
595fad3039cSmistachkin     return SQLITE_NOMEM_BKPT;
596595a523aSdanielk1977   }
597595a523aSdanielk1977   pVTable->db = db;
598595a523aSdanielk1977   pVTable->pMod = pMod;
5992928a15bSdrh   pVTable->eVtabRisk = SQLITE_VTABRISK_Normal;
600595a523aSdanielk1977 
60141fb5cd1Sdan   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
602f38524d2Sdrh   pTab->u.vtab.azArg[1] = db->aDb[iDb].zDbSName;
60341fb5cd1Sdan 
604595a523aSdanielk1977   /* Invoke the virtual table constructor */
605b061d058Sdan   assert( &db->pVtabCtx );
606b061d058Sdan   assert( xConstruct );
607b061d058Sdan   sCtx.pTab = pTab;
608b061d058Sdan   sCtx.pVTable = pVTable;
60975395ccdSdan   sCtx.pPrior = db->pVtabCtx;
61075395ccdSdan   sCtx.bDeclared = 0;
611b061d058Sdan   db->pVtabCtx = &sCtx;
612595a523aSdanielk1977   rc = xConstruct(db, pMod->pAux, nArg, azArg, &pVTable->pVtab, &zErr);
61375395ccdSdan   db->pVtabCtx = sCtx.pPrior;
6144a642b60Sdrh   if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
61575395ccdSdan   assert( sCtx.pTab==pTab );
6169da9d471Sdanielk1977 
6179da9d471Sdanielk1977   if( SQLITE_OK!=rc ){
6184ca8aac2Sdrh     if( zErr==0 ){
6191e536953Sdanielk1977       *pzErr = sqlite3MPrintf(db, "vtable constructor failed: %s", zModuleName);
620fe1368eeSdrh     }else {
6211e536953Sdanielk1977       *pzErr = sqlite3MPrintf(db, "%s", zErr);
622b975598eSdrh       sqlite3_free(zErr);
623fe1368eeSdrh     }
624595a523aSdanielk1977     sqlite3DbFree(db, pVTable);
625595a523aSdanielk1977   }else if( ALWAYS(pVTable->pVtab) ){
626595a523aSdanielk1977     /* Justification of ALWAYS():  A correct vtab constructor must allocate
627595a523aSdanielk1977     ** the sqlite3_vtab object if successful.  */
6285604cc0dSdrh     memset(pVTable->pVtab, 0, sizeof(pVTable->pVtab[0]));
629595a523aSdanielk1977     pVTable->pVtab->pModule = pMod->pModule;
630cc5979dbSdrh     pMod->nRefModule++;
631595a523aSdanielk1977     pVTable->nRef = 1;
63275395ccdSdan     if( sCtx.bDeclared==0 ){
6339da9d471Sdanielk1977       const char *zFormat = "vtable constructor did not declare schema: %s";
6341e536953Sdanielk1977       *pzErr = sqlite3MPrintf(db, zFormat, pTab->zName);
635595a523aSdanielk1977       sqlite3VtabUnlock(pVTable);
6369da9d471Sdanielk1977       rc = SQLITE_ERROR;
637595a523aSdanielk1977     }else{
638034ca14fSdanielk1977       int iCol;
639c1431144Sdrh       u16 oooHidden = 0;
640595a523aSdanielk1977       /* If everything went according to plan, link the new VTable structure
641f38524d2Sdrh       ** into the linked list headed by pTab->u.vtab.p. Then loop through the
642595a523aSdanielk1977       ** columns of the table to see if any of them contain the token "hidden".
643a371ace4Sdrh       ** If so, set the Column COLFLAG_HIDDEN flag and remove the token from
644595a523aSdanielk1977       ** the type string.  */
645f38524d2Sdrh       pVTable->pNext = pTab->u.vtab.p;
646f38524d2Sdrh       pTab->u.vtab.p = pVTable;
647595a523aSdanielk1977 
648034ca14fSdanielk1977       for(iCol=0; iCol<pTab->nCol; iCol++){
649d7564865Sdrh         char *zType = sqlite3ColumnType(&pTab->aCol[iCol], "");
650034ca14fSdanielk1977         int nType;
651034ca14fSdanielk1977         int i = 0;
652ea678832Sdrh         nType = sqlite3Strlen30(zType);
653034ca14fSdanielk1977         for(i=0; i<nType; i++){
654d7564865Sdrh           if( 0==sqlite3StrNICmp("hidden", &zType[i], 6)
655d7564865Sdrh            && (i==0 || zType[i-1]==' ')
656d7564865Sdrh            && (zType[i+6]=='\0' || zType[i+6]==' ')
657034ca14fSdanielk1977           ){
658034ca14fSdanielk1977             break;
659034ca14fSdanielk1977           }
660034ca14fSdanielk1977         }
661034ca14fSdanielk1977         if( i<nType ){
662034ca14fSdanielk1977           int j;
663034ca14fSdanielk1977           int nDel = 6 + (zType[i+6] ? 1 : 0);
664034ca14fSdanielk1977           for(j=i; (j+nDel)<=nType; j++){
665034ca14fSdanielk1977             zType[j] = zType[j+nDel];
666034ca14fSdanielk1977           }
667034ca14fSdanielk1977           if( zType[i]=='\0' && i>0 ){
668034ca14fSdanielk1977             assert(zType[i-1]==' ');
669034ca14fSdanielk1977             zType[i-1] = '\0';
670034ca14fSdanielk1977           }
671a371ace4Sdrh           pTab->aCol[iCol].colFlags |= COLFLAG_HIDDEN;
6726f6e60ddSdrh           pTab->tabFlags |= TF_HasHidden;
673a21f78b9Sdrh           oooHidden = TF_OOOHidden;
674a21f78b9Sdrh         }else{
675a21f78b9Sdrh           pTab->tabFlags |= oooHidden;
676034ca14fSdanielk1977         }
677034ca14fSdanielk1977       }
678034ca14fSdanielk1977     }
679595a523aSdanielk1977   }
680595a523aSdanielk1977 
681595a523aSdanielk1977   sqlite3DbFree(db, zModuleName);
6829da9d471Sdanielk1977   return rc;
6839da9d471Sdanielk1977 }
6849da9d471Sdanielk1977 
6859da9d471Sdanielk1977 /*
6867e6ebfb2Sdanielk1977 ** This function is invoked by the parser to call the xConnect() method
687fe3fcbe2Sdanielk1977 ** of the virtual table pTab. If an error occurs, an error code is returned
688fe3fcbe2Sdanielk1977 ** and an error left in pParse.
689fe3fcbe2Sdanielk1977 **
690fe3fcbe2Sdanielk1977 ** This call is a no-op if table pTab is not a virtual table.
6917e6ebfb2Sdanielk1977 */
6927e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse *pParse, Table *pTab){
693595a523aSdanielk1977   sqlite3 *db = pParse->db;
694595a523aSdanielk1977   const char *zMod;
695d1ab1ba5Sdanielk1977   Module *pMod;
696595a523aSdanielk1977   int rc;
6977e6ebfb2Sdanielk1977 
698748ce211Sdrh   assert( pTab );
69944266ec6Sdrh   if( !IsVirtual(pTab) || sqlite3GetVTable(db, pTab) ){
7007e6ebfb2Sdanielk1977     return SQLITE_OK;
7017e6ebfb2Sdanielk1977   }
7027e6ebfb2Sdanielk1977 
703595a523aSdanielk1977   /* Locate the required virtual table module */
704f38524d2Sdrh   zMod = pTab->u.vtab.azArg[0];
705acbcb7e0Sdrh   pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
706595a523aSdanielk1977 
707d1ab1ba5Sdanielk1977   if( !pMod ){
708f38524d2Sdrh     const char *zModule = pTab->u.vtab.azArg[0];
709a4e76367Sdanielk1977     sqlite3ErrorMsg(pParse, "no such module: %s", zModule);
7107e6ebfb2Sdanielk1977     rc = SQLITE_ERROR;
7117e6ebfb2Sdanielk1977   }else{
7129da9d471Sdanielk1977     char *zErr = 0;
713d1ab1ba5Sdanielk1977     rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xConnect, &zErr);
7149da9d471Sdanielk1977     if( rc!=SQLITE_OK ){
7159da9d471Sdanielk1977       sqlite3ErrorMsg(pParse, "%s", zErr);
7167524b613Sdrh       pParse->rc = rc;
7177e6ebfb2Sdanielk1977     }
718633e6d57Sdrh     sqlite3DbFree(db, zErr);
7197e6ebfb2Sdanielk1977   }
7207e6ebfb2Sdanielk1977 
7217e6ebfb2Sdanielk1977   return rc;
7227e6ebfb2Sdanielk1977 }
7239da9d471Sdanielk1977 /*
7242cac2078Sdan ** Grow the db->aVTrans[] array so that there is room for at least one
7252cac2078Sdan ** more v-table. Return SQLITE_NOMEM if a malloc fails, or SQLITE_OK otherwise.
726e7ff403aSdanielk1977 */
7272cac2078Sdan static int growVTrans(sqlite3 *db){
728e7ff403aSdanielk1977   const int ARRAY_INCR = 5;
729e7ff403aSdanielk1977 
730e7ff403aSdanielk1977   /* Grow the sqlite3.aVTrans array if required */
731e7ff403aSdanielk1977   if( (db->nVTrans%ARRAY_INCR)==0 ){
732595a523aSdanielk1977     VTable **aVTrans;
7330aa3231fSdrh     sqlite3_int64 nBytes = sizeof(sqlite3_vtab*)*
7340aa3231fSdrh                                  ((sqlite3_int64)db->nVTrans + ARRAY_INCR);
73526783a58Sdanielk1977     aVTrans = sqlite3DbRealloc(db, (void *)db->aVTrans, nBytes);
736e7ff403aSdanielk1977     if( !aVTrans ){
737fad3039cSmistachkin       return SQLITE_NOMEM_BKPT;
738e7ff403aSdanielk1977     }
739e7ff403aSdanielk1977     memset(&aVTrans[db->nVTrans], 0, sizeof(sqlite3_vtab *)*ARRAY_INCR);
740e7ff403aSdanielk1977     db->aVTrans = aVTrans;
741e7ff403aSdanielk1977   }
742e7ff403aSdanielk1977 
7432cac2078Sdan   return SQLITE_OK;
7442cac2078Sdan }
7452cac2078Sdan 
7462cac2078Sdan /*
7472cac2078Sdan ** Add the virtual table pVTab to the array sqlite3.aVTrans[]. Space should
7482cac2078Sdan ** have already been reserved using growVTrans().
7492cac2078Sdan */
7502cac2078Sdan static void addToVTrans(sqlite3 *db, VTable *pVTab){
751e7ff403aSdanielk1977   /* Add pVtab to the end of sqlite3.aVTrans */
752595a523aSdanielk1977   db->aVTrans[db->nVTrans++] = pVTab;
753595a523aSdanielk1977   sqlite3VtabLock(pVTab);
754e7ff403aSdanielk1977 }
755e7ff403aSdanielk1977 
756e7ff403aSdanielk1977 /*
7579da9d471Sdanielk1977 ** This function is invoked by the vdbe to call the xCreate method
7589da9d471Sdanielk1977 ** of the virtual table named zTab in database iDb.
7599da9d471Sdanielk1977 **
7602e5c5052Sdrh ** If an error occurs, *pzErr is set to point to an English language
7619da9d471Sdanielk1977 ** description of the error and an SQLITE_XXX error code is returned.
762633e6d57Sdrh ** In this case the caller must call sqlite3DbFree(db, ) on *pzErr.
7639da9d471Sdanielk1977 */
7649da9d471Sdanielk1977 int sqlite3VtabCallCreate(sqlite3 *db, int iDb, const char *zTab, char **pzErr){
7659da9d471Sdanielk1977   int rc = SQLITE_OK;
7669da9d471Sdanielk1977   Table *pTab;
767d1ab1ba5Sdanielk1977   Module *pMod;
768595a523aSdanielk1977   const char *zMod;
7699da9d471Sdanielk1977 
77069c33826Sdrh   pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
771f38524d2Sdrh   assert( pTab && IsVirtual(pTab) && !pTab->u.vtab.p );
772595a523aSdanielk1977 
773595a523aSdanielk1977   /* Locate the required virtual table module */
774f38524d2Sdrh   zMod = pTab->u.vtab.azArg[0];
775acbcb7e0Sdrh   pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
7769da9d471Sdanielk1977 
7779da9d471Sdanielk1977   /* If the module has been registered and includes a Create method,
7789da9d471Sdanielk1977   ** invoke it now. If the module has not been registered, return an
7799da9d471Sdanielk1977   ** error. Otherwise, do nothing.
7809da9d471Sdanielk1977   */
781d8b1bfc6Sdrh   if( pMod==0 || pMod->pModule->xCreate==0 || pMod->pModule->xDestroy==0 ){
782595a523aSdanielk1977     *pzErr = sqlite3MPrintf(db, "no such module: %s", zMod);
7839da9d471Sdanielk1977     rc = SQLITE_ERROR;
7849da9d471Sdanielk1977   }else{
785d1ab1ba5Sdanielk1977     rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xCreate, pzErr);
7869da9d471Sdanielk1977   }
7879da9d471Sdanielk1977 
788748ce211Sdrh   /* Justification of ALWAYS():  The xConstructor method is required to
789748ce211Sdrh   ** create a valid sqlite3_vtab if it returns SQLITE_OK. */
790595a523aSdanielk1977   if( rc==SQLITE_OK && ALWAYS(sqlite3GetVTable(db, pTab)) ){
7912cac2078Sdan     rc = growVTrans(db);
7922cac2078Sdan     if( rc==SQLITE_OK ){
7932cac2078Sdan       addToVTrans(db, sqlite3GetVTable(db, pTab));
7942cac2078Sdan     }
795e7ff403aSdanielk1977   }
796e7ff403aSdanielk1977 
7979da9d471Sdanielk1977   return rc;
7989da9d471Sdanielk1977 }
799be8a7835Sdanielk1977 
800be8a7835Sdanielk1977 /*
801fe3fcbe2Sdanielk1977 ** This function is used to set the schema of a virtual table.  It is only
802fe3fcbe2Sdanielk1977 ** valid to call this function from within the xCreate() or xConnect() of a
803fe3fcbe2Sdanielk1977 ** virtual table module.
804fe3fcbe2Sdanielk1977 */
8057e6ebfb2Sdanielk1977 int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable){
8064e23536eSdan   VtabCtx *pCtx;
8077e6ebfb2Sdanielk1977   int rc = SQLITE_OK;
80827641703Sdrh   Table *pTab;
8097e6ebfb2Sdanielk1977   char *zErr = 0;
8106903bf6dSdrh   Parse sParse;
811ebd1ff62Sdrh   int initBusy;
8127e6ebfb2Sdanielk1977 
8139ca95730Sdrh #ifdef SQLITE_ENABLE_API_ARMOR
81496c707a3Sdrh   if( !sqlite3SafetyCheckOk(db) || zCreateTable==0 ){
81596c707a3Sdrh     return SQLITE_MISUSE_BKPT;
81696c707a3Sdrh   }
8179ca95730Sdrh #endif
81827641703Sdrh   sqlite3_mutex_enter(db->mutex);
8194e23536eSdan   pCtx = db->pVtabCtx;
82075395ccdSdan   if( !pCtx || pCtx->bDeclared ){
82113f40da3Sdrh     sqlite3Error(db, SQLITE_MISUSE);
82227641703Sdrh     sqlite3_mutex_leave(db->mutex);
823413c3d36Sdrh     return SQLITE_MISUSE_BKPT;
8247e6ebfb2Sdanielk1977   }
82575395ccdSdan   pTab = pCtx->pTab;
82644266ec6Sdrh   assert( IsVirtual(pTab) );
8277e6ebfb2Sdanielk1977 
8286903bf6dSdrh   memset(&sParse, 0, sizeof(sParse));
829cf8f2895Sdan   sParse.eParseMode = PARSE_MODE_DECLARE_VTAB;
8306903bf6dSdrh   sParse.db = db;
831ebd1ff62Sdrh   /* We should never be able to reach this point while loading the
832ebd1ff62Sdrh   ** schema.  Nevertheless, defend against that (turn off db->init.busy)
833ebd1ff62Sdrh   ** in case a bug arises. */
834ebd1ff62Sdrh   assert( db->init.busy==0 );
835ebd1ff62Sdrh   initBusy = db->init.busy;
836ebd1ff62Sdrh   db->init.busy = 0;
8376903bf6dSdrh   sParse.nQueryLoop = 1;
8386903bf6dSdrh   if( SQLITE_OK==sqlite3RunParser(&sParse, zCreateTable, &zErr)
8396903bf6dSdrh    && sParse.pNewTable
8400e3c512bSdrh    && !db->mallocFailed
841f38524d2Sdrh    && IsOrdinaryTable(sParse.pNewTable)
8427e6ebfb2Sdanielk1977   ){
843595a523aSdanielk1977     if( !pTab->aCol ){
8446903bf6dSdrh       Table *pNew = sParse.pNewTable;
845273bfe9fSdrh       Index *pIdx;
84662340f84Sdrh       pTab->aCol = pNew->aCol;
847f38524d2Sdrh       sqlite3ExprListDelete(db, pNew->u.tab.pDfltList);
8487dec804dSdrh       pTab->nNVCol = pTab->nCol = pNew->nCol;
8497edcf627Sdrh       pTab->tabFlags |= pNew->tabFlags & (TF_WithoutRowid|TF_NoVisibleRowid);
85062340f84Sdrh       pNew->nCol = 0;
85162340f84Sdrh       pNew->aCol = 0;
852273bfe9fSdrh       assert( pTab->pIndex==0 );
853e3740f27Sdrh       assert( HasRowid(pNew) || sqlite3PrimaryKeyIndex(pNew)!=0 );
854e3740f27Sdrh       if( !HasRowid(pNew)
855e3740f27Sdrh        && pCtx->pVTable->pMod->pModule->xUpdate!=0
856e3740f27Sdrh        && sqlite3PrimaryKeyIndex(pNew)->nKeyCol!=1
857e3740f27Sdrh       ){
858e3740f27Sdrh         /* WITHOUT ROWID virtual tables must either be read-only (xUpdate==0)
859e3740f27Sdrh         ** or else must have a single-column PRIMARY KEY */
860ac9c3d2cSdrh         rc = SQLITE_ERROR;
861ac9c3d2cSdrh       }
862273bfe9fSdrh       pIdx = pNew->pIndex;
863273bfe9fSdrh       if( pIdx ){
864273bfe9fSdrh         assert( pIdx->pNext==0 );
865273bfe9fSdrh         pTab->pIndex = pIdx;
86662340f84Sdrh         pNew->pIndex = 0;
867273bfe9fSdrh         pIdx->pTable = pTab;
868273bfe9fSdrh       }
869595a523aSdanielk1977     }
87075395ccdSdan     pCtx->bDeclared = 1;
8717e6ebfb2Sdanielk1977   }else{
87213f40da3Sdrh     sqlite3ErrorWithMsg(db, SQLITE_ERROR, (zErr ? "%s" : 0), zErr);
87378f9b731Sdan     sqlite3DbFree(db, zErr);
8747e6ebfb2Sdanielk1977     rc = SQLITE_ERROR;
8757e6ebfb2Sdanielk1977   }
876cf8f2895Sdan   sParse.eParseMode = PARSE_MODE_NORMAL;
8777e6ebfb2Sdanielk1977 
8786903bf6dSdrh   if( sParse.pVdbe ){
8796903bf6dSdrh     sqlite3VdbeFinalize(sParse.pVdbe);
880238746a6Sdanielk1977   }
8816903bf6dSdrh   sqlite3DeleteTable(db, sParse.pNewTable);
8826903bf6dSdrh   sqlite3ParserReset(&sParse);
883ebd1ff62Sdrh   db->init.busy = initBusy;
8847e6ebfb2Sdanielk1977 
8854ac285a1Sdrh   assert( (rc&0xff)==rc );
88627641703Sdrh   rc = sqlite3ApiExit(db, rc);
88727641703Sdrh   sqlite3_mutex_leave(db->mutex);
88827641703Sdrh   return rc;
8897e6ebfb2Sdanielk1977 }
8907e6ebfb2Sdanielk1977 
8917e6ebfb2Sdanielk1977 /*
8929e39ce87Sdanielk1977 ** This function is invoked by the vdbe to call the xDestroy method
8939e39ce87Sdanielk1977 ** of the virtual table named zTab in database iDb. This occurs
8949e39ce87Sdanielk1977 ** when a DROP TABLE is mentioned.
8959e39ce87Sdanielk1977 **
8969e39ce87Sdanielk1977 ** This call is a no-op if zTab is not a virtual table.
8979e39ce87Sdanielk1977 */
898748ce211Sdrh int sqlite3VtabCallDestroy(sqlite3 *db, int iDb, const char *zTab){
8999e39ce87Sdanielk1977   int rc = SQLITE_OK;
9009e39ce87Sdanielk1977   Table *pTab;
9019e39ce87Sdanielk1977 
90269c33826Sdrh   pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
90378b2fa86Sdrh   if( pTab!=0 && ALWAYS(IsVirtual(pTab)) && ALWAYS(pTab->u.vtab.p!=0) ){
904a68d6282Sdrh     VTable *p;
905197d59ffSmistachkin     int (*xDestroy)(sqlite3_vtab *);
906f38524d2Sdrh     for(p=pTab->u.vtab.p; p; p=p->pNext){
907a68d6282Sdrh       assert( p->pVtab );
908a68d6282Sdrh       if( p->pVtab->nRef>0 ){
909a68d6282Sdrh         return SQLITE_LOCKED;
910a68d6282Sdrh       }
911a68d6282Sdrh     }
912a68d6282Sdrh     p = vtabDisconnectAll(db, pTab);
913197d59ffSmistachkin     xDestroy = p->pMod->pModule->xDestroy;
914a1ca00edSdrh     if( xDestroy==0 ) xDestroy = p->pMod->pModule->xDisconnect;
915a1ca00edSdrh     assert( xDestroy!=0 );
916c589acbcSdan     pTab->nTabRef++;
917a1ca00edSdrh     rc = xDestroy(p->pVtab);
918595a523aSdanielk1977     /* Remove the sqlite3_vtab* from the aVTrans[] array, if applicable */
9199e39ce87Sdanielk1977     if( rc==SQLITE_OK ){
920f38524d2Sdrh       assert( pTab->u.vtab.p==p && p->pNext==0 );
921595a523aSdanielk1977       p->pVtab = 0;
922f38524d2Sdrh       pTab->u.vtab.p = 0;
923595a523aSdanielk1977       sqlite3VtabUnlock(p);
9249e39ce87Sdanielk1977     }
925c589acbcSdan     sqlite3DeleteTable(db, pTab);
9269e39ce87Sdanielk1977   }
9279e39ce87Sdanielk1977 
9289e39ce87Sdanielk1977   return rc;
9299e39ce87Sdanielk1977 }
9309e39ce87Sdanielk1977 
931f9e7dda7Sdanielk1977 /*
932e7ff403aSdanielk1977 ** This function invokes either the xRollback or xCommit method
933e7ff403aSdanielk1977 ** of each of the virtual tables in the sqlite3.aVTrans array. The method
934e7ff403aSdanielk1977 ** called is identified by the second argument, "offset", which is
935e7ff403aSdanielk1977 ** the offset of the method to call in the sqlite3_module structure.
936e7ff403aSdanielk1977 **
937e7ff403aSdanielk1977 ** The array is cleared after invoking the callbacks.
938e7ff403aSdanielk1977 */
9397209c697Sdrh static void callFinaliser(sqlite3 *db, int offset){
940e7ff403aSdanielk1977   int i;
9410b83fa82Sdanielk1977   if( db->aVTrans ){
942e4bec379Sdan     VTable **aVTrans = db->aVTrans;
943e4bec379Sdan     db->aVTrans = 0;
944748ce211Sdrh     for(i=0; i<db->nVTrans; i++){
945e4bec379Sdan       VTable *pVTab = aVTrans[i];
946595a523aSdanielk1977       sqlite3_vtab *p = pVTab->pVtab;
947595a523aSdanielk1977       if( p ){
948e7ff403aSdanielk1977         int (*x)(sqlite3_vtab *);
949595a523aSdanielk1977         x = *(int (**)(sqlite3_vtab *))((char *)p->pModule + offset);
950595a523aSdanielk1977         if( x ) x(p);
951595a523aSdanielk1977       }
952346506f9Sdrh       pVTab->iSavepoint = 0;
953595a523aSdanielk1977       sqlite3VtabUnlock(pVTab);
954e7ff403aSdanielk1977     }
955e4bec379Sdan     sqlite3DbFree(db, aVTrans);
956e7ff403aSdanielk1977     db->nVTrans = 0;
957e7ff403aSdanielk1977   }
9580b83fa82Sdanielk1977 }
959e7ff403aSdanielk1977 
960e7ff403aSdanielk1977 /*
9613e3a84d3Sdanielk1977 ** Invoke the xSync method of all virtual tables in the sqlite3.aVTrans
9623e3a84d3Sdanielk1977 ** array. Return the error code for the first error that occurs, or
9633e3a84d3Sdanielk1977 ** SQLITE_OK if all xSync operations are successful.
9643e3a84d3Sdanielk1977 **
965016f7811Sdan ** If an error message is available, leave it in p->zErrMsg.
966f9e7dda7Sdanielk1977 */
967016f7811Sdan int sqlite3VtabSync(sqlite3 *db, Vdbe *p){
968e7ff403aSdanielk1977   int i;
969e7ff403aSdanielk1977   int rc = SQLITE_OK;
970595a523aSdanielk1977   VTable **aVTrans = db->aVTrans;
97120b1eaffSdanielk1977 
97220b1eaffSdanielk1977   db->aVTrans = 0;
973748ce211Sdrh   for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
974e7ff403aSdanielk1977     int (*x)(sqlite3_vtab *);
975595a523aSdanielk1977     sqlite3_vtab *pVtab = aVTrans[i]->pVtab;
976595a523aSdanielk1977     if( pVtab && (x = pVtab->pModule->xSync)!=0 ){
977e7ff403aSdanielk1977       rc = x(pVtab);
978016f7811Sdan       sqlite3VtabImportErrmsg(p, pVtab);
979e7ff403aSdanielk1977     }
980e7ff403aSdanielk1977   }
98120b1eaffSdanielk1977   db->aVTrans = aVTrans;
982e7ff403aSdanielk1977   return rc;
983f9e7dda7Sdanielk1977 }
984f9e7dda7Sdanielk1977 
985f9e7dda7Sdanielk1977 /*
986f9e7dda7Sdanielk1977 ** Invoke the xRollback method of all virtual tables in the
987f9e7dda7Sdanielk1977 ** sqlite3.aVTrans array. Then clear the array itself.
988f9e7dda7Sdanielk1977 */
989f9e7dda7Sdanielk1977 int sqlite3VtabRollback(sqlite3 *db){
9907209c697Sdrh   callFinaliser(db, offsetof(sqlite3_module,xRollback));
991e7ff403aSdanielk1977   return SQLITE_OK;
992f9e7dda7Sdanielk1977 }
993f9e7dda7Sdanielk1977 
994f9e7dda7Sdanielk1977 /*
995f9e7dda7Sdanielk1977 ** Invoke the xCommit method of all virtual tables in the
996f9e7dda7Sdanielk1977 ** sqlite3.aVTrans array. Then clear the array itself.
997f9e7dda7Sdanielk1977 */
998f9e7dda7Sdanielk1977 int sqlite3VtabCommit(sqlite3 *db){
9997209c697Sdrh   callFinaliser(db, offsetof(sqlite3_module,xCommit));
1000e7ff403aSdanielk1977   return SQLITE_OK;
1001f9e7dda7Sdanielk1977 }
1002f9e7dda7Sdanielk1977 
1003f9e7dda7Sdanielk1977 /*
1004f9e7dda7Sdanielk1977 ** If the virtual table pVtab supports the transaction interface
1005f9e7dda7Sdanielk1977 ** (xBegin/xRollback/xCommit and optionally xSync) and a transaction is
1006f9e7dda7Sdanielk1977 ** not currently open, invoke the xBegin method now.
1007f9e7dda7Sdanielk1977 **
1008f9e7dda7Sdanielk1977 ** If the xBegin call is successful, place the sqlite3_vtab pointer
1009f9e7dda7Sdanielk1977 ** in the sqlite3.aVTrans array.
1010f9e7dda7Sdanielk1977 */
1011595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *db, VTable *pVTab){
1012f9e7dda7Sdanielk1977   int rc = SQLITE_OK;
101320b1eaffSdanielk1977   const sqlite3_module *pModule;
101420b1eaffSdanielk1977 
101520b1eaffSdanielk1977   /* Special case: If db->aVTrans is NULL and db->nVTrans is greater
101620b1eaffSdanielk1977   ** than zero, then this function is being called from within a
101720b1eaffSdanielk1977   ** virtual module xSync() callback. It is illegal to write to
1018748ce211Sdrh   ** virtual module tables in this case, so return SQLITE_LOCKED.
101920b1eaffSdanielk1977   */
1020093e0f6fSdanielk1977   if( sqlite3VtabInSync(db) ){
102120b1eaffSdanielk1977     return SQLITE_LOCKED;
102220b1eaffSdanielk1977   }
1023595a523aSdanielk1977   if( !pVTab ){
102420b1eaffSdanielk1977     return SQLITE_OK;
102520b1eaffSdanielk1977   }
1026595a523aSdanielk1977   pModule = pVTab->pVtab->pModule;
102720b1eaffSdanielk1977 
1028f9e7dda7Sdanielk1977   if( pModule->xBegin ){
1029f9e7dda7Sdanielk1977     int i;
1030f9e7dda7Sdanielk1977 
1031f9e7dda7Sdanielk1977     /* If pVtab is already in the aVTrans array, return early */
1032748ce211Sdrh     for(i=0; i<db->nVTrans; i++){
1033595a523aSdanielk1977       if( db->aVTrans[i]==pVTab ){
1034f9e7dda7Sdanielk1977         return SQLITE_OK;
1035f9e7dda7Sdanielk1977       }
1036f9e7dda7Sdanielk1977     }
1037f9e7dda7Sdanielk1977 
10382cac2078Sdan     /* Invoke the xBegin method. If successful, add the vtab to the
10392cac2078Sdan     ** sqlite3.aVTrans[] array. */
10402cac2078Sdan     rc = growVTrans(db);
10412cac2078Sdan     if( rc==SQLITE_OK ){
1042595a523aSdanielk1977       rc = pModule->xBegin(pVTab->pVtab);
10433e3a84d3Sdanielk1977       if( rc==SQLITE_OK ){
104465c4f591Sdan         int iSvpt = db->nStatement + db->nSavepoint;
10452cac2078Sdan         addToVTrans(db, pVTab);
1046914b7e42Sdan         if( iSvpt && pModule->xSavepoint ){
1047914b7e42Sdan           pVTab->iSavepoint = iSvpt;
1048914b7e42Sdan           rc = pModule->xSavepoint(pVTab->pVtab, iSvpt-1);
1049914b7e42Sdan         }
10502cac2078Sdan       }
1051f9e7dda7Sdanielk1977     }
10523e3a84d3Sdanielk1977   }
1053f9e7dda7Sdanielk1977   return rc;
1054f9e7dda7Sdanielk1977 }
1055f9e7dda7Sdanielk1977 
1056d9495cd0Sdan /*
1057d9495cd0Sdan ** Invoke either the xSavepoint, xRollbackTo or xRelease method of all
1058d9495cd0Sdan ** virtual tables that currently have an open transaction. Pass iSavepoint
1059d9495cd0Sdan ** as the second argument to the virtual table method invoked.
1060d9495cd0Sdan **
1061d9495cd0Sdan ** If op is SAVEPOINT_BEGIN, the xSavepoint method is invoked. If it is
1062d9495cd0Sdan ** SAVEPOINT_ROLLBACK, the xRollbackTo method. Otherwise, if op is
1063d9495cd0Sdan ** SAVEPOINT_RELEASE, then the xRelease method of each virtual table with
1064d9495cd0Sdan ** an open transaction is invoked.
1065d9495cd0Sdan **
1066d9495cd0Sdan ** If any virtual table method returns an error code other than SQLITE_OK,
1067d9495cd0Sdan ** processing is abandoned and the error returned to the caller of this
1068d9495cd0Sdan ** function immediately. If all calls to virtual table methods are successful,
1069d9495cd0Sdan ** SQLITE_OK is returned.
1070d9495cd0Sdan */
1071a311b803Sdan int sqlite3VtabSavepoint(sqlite3 *db, int op, int iSavepoint){
1072a311b803Sdan   int rc = SQLITE_OK;
1073a311b803Sdan 
1074a311b803Sdan   assert( op==SAVEPOINT_RELEASE||op==SAVEPOINT_ROLLBACK||op==SAVEPOINT_BEGIN );
1075ea8562edSdan   assert( iSavepoint>=-1 );
1076d9495cd0Sdan   if( db->aVTrans ){
1077d9495cd0Sdan     int i;
1078a311b803Sdan     for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
1079e4855224Sdrh       VTable *pVTab = db->aVTrans[i];
1080e4855224Sdrh       const sqlite3_module *pMod = pVTab->pMod->pModule;
1081341cadeeSdan       if( pVTab->pVtab && pMod->iVersion>=2 ){
1082d9495cd0Sdan         int (*xMethod)(sqlite3_vtab *, int);
108383a635a2Sdan         sqlite3VtabLock(pVTab);
1084a311b803Sdan         switch( op ){
1085a311b803Sdan           case SAVEPOINT_BEGIN:
1086d9495cd0Sdan             xMethod = pMod->xSavepoint;
1087346506f9Sdrh             pVTab->iSavepoint = iSavepoint+1;
1088a311b803Sdan             break;
1089a311b803Sdan           case SAVEPOINT_ROLLBACK:
1090d9495cd0Sdan             xMethod = pMod->xRollbackTo;
1091a311b803Sdan             break;
1092a311b803Sdan           default:
1093d9495cd0Sdan             xMethod = pMod->xRelease;
1094a311b803Sdan             break;
1095a311b803Sdan         }
1096346506f9Sdrh         if( xMethod && pVTab->iSavepoint>iSavepoint ){
1097341cadeeSdan           rc = xMethod(pVTab->pVtab, iSavepoint);
1098346506f9Sdrh         }
109983a635a2Sdan         sqlite3VtabUnlock(pVTab);
1100d9495cd0Sdan       }
1101a311b803Sdan     }
1102a311b803Sdan   }
1103a311b803Sdan   return rc;
1104a311b803Sdan }
1105a311b803Sdan 
1106b7f6f68fSdrh /*
1107b7f6f68fSdrh ** The first parameter (pDef) is a function implementation.  The
1108b7f6f68fSdrh ** second parameter (pExpr) is the first argument to this function.
1109b7f6f68fSdrh ** If pExpr is a column in a virtual table, then let the virtual
1110b7f6f68fSdrh ** table implementation have an opportunity to overload the function.
1111b7f6f68fSdrh **
1112b7f6f68fSdrh ** This routine is used to allow virtual table implementations to
1113b7f6f68fSdrh ** overload MATCH, LIKE, GLOB, and REGEXP operators.
1114b7f6f68fSdrh **
1115b7f6f68fSdrh ** Return either the pDef argument (indicating no change) or a
1116b7f6f68fSdrh ** new FuncDef structure that is marked as ephemeral using the
1117b7f6f68fSdrh ** SQLITE_FUNC_EPHEM flag.
1118b7f6f68fSdrh */
1119b7f6f68fSdrh FuncDef *sqlite3VtabOverloadFunction(
112017435752Sdrh   sqlite3 *db,    /* Database connection for reporting malloc problems */
1121b7f6f68fSdrh   FuncDef *pDef,  /* Function to possibly overload */
1122b7f6f68fSdrh   int nArg,       /* Number of arguments to the function */
1123b7f6f68fSdrh   Expr *pExpr     /* First argument to the function */
1124b7f6f68fSdrh ){
1125b7f6f68fSdrh   Table *pTab;
1126b7f6f68fSdrh   sqlite3_vtab *pVtab;
1127b7f6f68fSdrh   sqlite3_module *pMod;
11282d80151fSdrh   void (*xSFunc)(sqlite3_context*,int,sqlite3_value**) = 0;
1129dc5ea5c7Sdrh   void *pArg = 0;
1130b7f6f68fSdrh   FuncDef *pNew;
1131777b17afSdrh   int rc = 0;
1132b7f6f68fSdrh 
1133b7f6f68fSdrh   /* Check to see the left operand is a column in a virtual table */
1134748ce211Sdrh   if( NEVER(pExpr==0) ) return pDef;
1135b7f6f68fSdrh   if( pExpr->op!=TK_COLUMN ) return pDef;
1136477572b9Sdrh   assert( ExprUseYTab(pExpr) );
1137eda079cdSdrh   pTab = pExpr->y.pTab;
113839c9d3a3Sdan   if( pTab==0 ) return pDef;
113944266ec6Sdrh   if( !IsVirtual(pTab) ) return pDef;
1140595a523aSdanielk1977   pVtab = sqlite3GetVTable(db, pTab)->pVtab;
1141b7f6f68fSdrh   assert( pVtab!=0 );
1142b7f6f68fSdrh   assert( pVtab->pModule!=0 );
11435bd270b2Sdanielk1977   pMod = (sqlite3_module *)pVtab->pModule;
1144b7f6f68fSdrh   if( pMod->xFindFunction==0 ) return pDef;
1145b7f6f68fSdrh 
1146b72e88d7Srse   /* Call the xFindFunction method on the virtual table implementation
114792011847Sdrh   ** to see if the implementation wants to overload this function.
114892011847Sdrh   **
114992011847Sdrh   ** Though undocumented, we have historically always invoked xFindFunction
115092011847Sdrh   ** with an all lower-case function name.  Continue in this tradition to
115192011847Sdrh   ** avoid any chance of an incompatibility.
1152a70034deSdrh   */
115392011847Sdrh #ifdef SQLITE_DEBUG
115492011847Sdrh   {
115592011847Sdrh     int i;
115692011847Sdrh     for(i=0; pDef->zName[i]; i++){
115792011847Sdrh       unsigned char x = (unsigned char)pDef->zName[i];
115892011847Sdrh       assert( x==sqlite3UpperToLower[x] );
1159a70034deSdrh     }
116017435752Sdrh   }
116192011847Sdrh #endif
116292011847Sdrh   rc = pMod->xFindFunction(pVtab, nArg, pDef->zName, &xSFunc, &pArg);
1163a70034deSdrh   if( rc==0 ){
1164b7f6f68fSdrh     return pDef;
1165b7f6f68fSdrh   }
1166b7f6f68fSdrh 
1167b7f6f68fSdrh   /* Create a new ephemeral function definition for the overloaded
1168b7f6f68fSdrh   ** function */
1169ea678832Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(*pNew)
1170e25a50b6Sdanielk1977                              + sqlite3Strlen30(pDef->zName) + 1);
1171b7f6f68fSdrh   if( pNew==0 ){
1172b7f6f68fSdrh     return pDef;
1173b7f6f68fSdrh   }
1174b7f6f68fSdrh   *pNew = *pDef;
11756ad224e9Sdrh   pNew->zName = (const char*)&pNew[1];
11766ad224e9Sdrh   memcpy((char*)&pNew[1], pDef->zName, sqlite3Strlen30(pDef->zName)+1);
11772d80151fSdrh   pNew->xSFunc = xSFunc;
1178b7f6f68fSdrh   pNew->pUserData = pArg;
1179d36e1041Sdrh   pNew->funcFlags |= SQLITE_FUNC_EPHEM;
1180b7f6f68fSdrh   return pNew;
1181b7f6f68fSdrh }
1182b7f6f68fSdrh 
11834f3dd150Sdrh /*
11844f3dd150Sdrh ** Make sure virtual table pTab is contained in the pParse->apVirtualLock[]
11854f3dd150Sdrh ** array so that an OP_VBegin will get generated for it.  Add pTab to the
11864f3dd150Sdrh ** array if it is missing.  If pTab is already in the array, this routine
11874f3dd150Sdrh ** is a no-op.
11884f3dd150Sdrh */
11894f3dd150Sdrh void sqlite3VtabMakeWritable(Parse *pParse, Table *pTab){
119065a7cd16Sdan   Parse *pToplevel = sqlite3ParseToplevel(pParse);
11914f3dd150Sdrh   int i, n;
1192748ce211Sdrh   Table **apVtabLock;
1193748ce211Sdrh 
11944f3dd150Sdrh   assert( IsVirtual(pTab) );
119565a7cd16Sdan   for(i=0; i<pToplevel->nVtabLock; i++){
119665a7cd16Sdan     if( pTab==pToplevel->apVtabLock[i] ) return;
11974f3dd150Sdrh   }
119865a7cd16Sdan   n = (pToplevel->nVtabLock+1)*sizeof(pToplevel->apVtabLock[0]);
1199d924e7bcSdrh   apVtabLock = sqlite3Realloc(pToplevel->apVtabLock, n);
1200748ce211Sdrh   if( apVtabLock ){
120165a7cd16Sdan     pToplevel->apVtabLock = apVtabLock;
120265a7cd16Sdan     pToplevel->apVtabLock[pToplevel->nVtabLock++] = pTab;
1203344c38e3Sdrh   }else{
12044a642b60Sdrh     sqlite3OomFault(pToplevel->db);
12054f3dd150Sdrh   }
12064f3dd150Sdrh }
12074f3dd150Sdrh 
1208ef45bb75Sdrh /*
12090b2c140aSdrh ** Check to see if virtual table module pMod can be have an eponymous
121051be3873Sdrh ** virtual table instance.  If it can, create one if one does not already
1211bd24e8faSdan ** exist. Return non-zero if either the eponymous virtual table instance
1212bd24e8faSdan ** exists when this routine returns or if an attempt to create it failed
1213bd24e8faSdan ** and an error message was left in pParse.
121451be3873Sdrh **
121551be3873Sdrh ** An eponymous virtual table instance is one that is named after its
121651be3873Sdrh ** module, and more importantly, does not require a CREATE VIRTUAL TABLE
121751be3873Sdrh ** statement in order to come into existance.  Eponymous virtual table
121851be3873Sdrh ** instances always exist.  They cannot be DROP-ed.
121951be3873Sdrh **
122051be3873Sdrh ** Any virtual table module for which xConnect and xCreate are the same
122151be3873Sdrh ** method can have an eponymous virtual table instance.
122251be3873Sdrh */
122351be3873Sdrh int sqlite3VtabEponymousTableInit(Parse *pParse, Module *pMod){
122451be3873Sdrh   const sqlite3_module *pModule = pMod->pModule;
122551be3873Sdrh   Table *pTab;
122651be3873Sdrh   char *zErr = 0;
122751be3873Sdrh   int rc;
122851be3873Sdrh   sqlite3 *db = pParse->db;
122951be3873Sdrh   if( pMod->pEpoTab ) return 1;
1230398f872dSdrh   if( pModule->xCreate!=0 && pModule->xCreate!=pModule->xConnect ) return 0;
12310b2c140aSdrh   pTab = sqlite3DbMallocZero(db, sizeof(Table));
123251be3873Sdrh   if( pTab==0 ) return 0;
12330b2c140aSdrh   pTab->zName = sqlite3DbStrDup(db, pMod->zName);
12340b2c140aSdrh   if( pTab->zName==0 ){
12350b2c140aSdrh     sqlite3DbFree(db, pTab);
12360b2c140aSdrh     return 0;
12370b2c140aSdrh   }
123851be3873Sdrh   pMod->pEpoTab = pTab;
123979df7782Sdrh   pTab->nTabRef = 1;
1240f38524d2Sdrh   pTab->eTabType = TABTYP_VTAB;
124151be3873Sdrh   pTab->pSchema = db->aDb[0].pSchema;
1242f38524d2Sdrh   assert( pTab->u.vtab.nArg==0 );
1243509c3fc0Sdrh   pTab->iPKey = -1;
12443d8c92d0Sdrh   pTab->tabFlags |= TF_Eponymous;
12450aa3231fSdrh   addModuleArgument(pParse, pTab, sqlite3DbStrDup(db, pTab->zName));
12460aa3231fSdrh   addModuleArgument(pParse, pTab, 0);
12470aa3231fSdrh   addModuleArgument(pParse, pTab, sqlite3DbStrDup(db, pTab->zName));
124851be3873Sdrh   rc = vtabCallConstructor(db, pTab, pMod, pModule->xConnect, &zErr);
124951be3873Sdrh   if( rc ){
125051be3873Sdrh     sqlite3ErrorMsg(pParse, "%s", zErr);
125151be3873Sdrh     sqlite3DbFree(db, zErr);
125251be3873Sdrh     sqlite3VtabEponymousTableClear(db, pMod);
125351be3873Sdrh   }
125451be3873Sdrh   return 1;
125551be3873Sdrh }
125651be3873Sdrh 
125751be3873Sdrh /*
125851be3873Sdrh ** Erase the eponymous virtual table instance associated with
125951be3873Sdrh ** virtual table module pMod, if it exists.
126051be3873Sdrh */
126151be3873Sdrh void sqlite3VtabEponymousTableClear(sqlite3 *db, Module *pMod){
126251be3873Sdrh   Table *pTab = pMod->pEpoTab;
1263d7fd6aa4Sdrh   if( pTab!=0 ){
12640b2c140aSdrh     /* Mark the table as Ephemeral prior to deleting it, so that the
12650b2c140aSdrh     ** sqlite3DeleteTable() routine will know that it is not stored in
12660b2c140aSdrh     ** the schema. */
12670b2c140aSdrh     pTab->tabFlags |= TF_Ephemeral;
12680b2c140aSdrh     sqlite3DeleteTable(db, pTab);
126951be3873Sdrh     pMod->pEpoTab = 0;
127051be3873Sdrh   }
127151be3873Sdrh }
127251be3873Sdrh 
127351be3873Sdrh /*
1274ef45bb75Sdrh ** Return the ON CONFLICT resolution mode in effect for the virtual
1275ef45bb75Sdrh ** table update operation currently in progress.
1276ef45bb75Sdrh **
1277ef45bb75Sdrh ** The results of this routine are undefined unless it is called from
1278ef45bb75Sdrh ** within an xUpdate method.
1279ef45bb75Sdrh */
1280b061d058Sdan int sqlite3_vtab_on_conflict(sqlite3 *db){
1281ef45bb75Sdrh   static const unsigned char aMap[] = {
128287f67bf1Sdrh     SQLITE_ROLLBACK, SQLITE_ABORT, SQLITE_FAIL, SQLITE_IGNORE, SQLITE_REPLACE
1283b061d058Sdan   };
12849ca95730Sdrh #ifdef SQLITE_ENABLE_API_ARMOR
12859ca95730Sdrh   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
12869ca95730Sdrh #endif
1287b061d058Sdan   assert( OE_Rollback==1 && OE_Abort==2 && OE_Fail==3 );
1288b061d058Sdan   assert( OE_Ignore==4 && OE_Replace==5 );
1289b061d058Sdan   assert( db->vtabOnConflict>=1 && db->vtabOnConflict<=5 );
1290ef45bb75Sdrh   return (int)aMap[db->vtabOnConflict-1];
1291b061d058Sdan }
1292b061d058Sdan 
1293ef45bb75Sdrh /*
1294ef45bb75Sdrh ** Call from within the xCreate() or xConnect() methods to provide
1295ef45bb75Sdrh ** the SQLite core with additional information about the behavior
1296ef45bb75Sdrh ** of the virtual table being implemented.
1297ef45bb75Sdrh */
1298b061d058Sdan int sqlite3_vtab_config(sqlite3 *db, int op, ...){
1299b061d058Sdan   va_list ap;
1300b061d058Sdan   int rc = SQLITE_OK;
13012928a15bSdrh   VtabCtx *p;
1302b061d058Sdan 
13039ca95730Sdrh #ifdef SQLITE_ENABLE_API_ARMOR
13049ca95730Sdrh   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
13059ca95730Sdrh #endif
1306b061d058Sdan   sqlite3_mutex_enter(db->mutex);
13072928a15bSdrh   p = db->pVtabCtx;
1308b061d058Sdan   if( !p ){
1309b061d058Sdan     rc = SQLITE_MISUSE_BKPT;
1310b061d058Sdan   }else{
131144266ec6Sdrh     assert( p->pTab==0 || IsVirtual(p->pTab) );
13122928a15bSdrh     va_start(ap, op);
13132928a15bSdrh     switch( op ){
13142928a15bSdrh       case SQLITE_VTAB_CONSTRAINT_SUPPORT: {
1315b061d058Sdan         p->pVTable->bConstraint = (u8)va_arg(ap, int);
1316b061d058Sdan         break;
1317b061d058Sdan       }
13182928a15bSdrh       case SQLITE_VTAB_INNOCUOUS: {
13192928a15bSdrh         p->pVTable->eVtabRisk = SQLITE_VTABRISK_Low;
13202928a15bSdrh         break;
13212928a15bSdrh       }
13222928a15bSdrh       case SQLITE_VTAB_DIRECTONLY: {
13232928a15bSdrh         p->pVTable->eVtabRisk = SQLITE_VTABRISK_High;
13242928a15bSdrh         break;
13252928a15bSdrh       }
13262928a15bSdrh       default: {
1327b061d058Sdan         rc = SQLITE_MISUSE_BKPT;
1328b061d058Sdan         break;
1329b061d058Sdan       }
13302928a15bSdrh     }
1331b061d058Sdan     va_end(ap);
13322928a15bSdrh   }
1333b061d058Sdan 
133413f40da3Sdrh   if( rc!=SQLITE_OK ) sqlite3Error(db, rc);
1335b061d058Sdan   sqlite3_mutex_leave(db->mutex);
1336b061d058Sdan   return rc;
1337b061d058Sdan }
1338b061d058Sdan 
1339b9bb7c18Sdrh #endif /* SQLITE_OMIT_VIRTUALTABLE */
1340