1 /* 2 ** 2015-06-08 3 ** 4 ** The author disclaims copyright to this source code. In place of 5 ** a legal notice, here is a blessing: 6 ** 7 ** May you do good and not evil. 8 ** May you find forgiveness for yourself and forgive others. 9 ** May you share freely, never taking more than you give. 10 ** 11 ************************************************************************* 12 ** 13 ** This file contains C code to implement the TreeView debugging routines. 14 ** These routines print a parse tree to standard output for debugging and 15 ** analysis. 16 ** 17 ** The interfaces in this file is only available when compiling 18 ** with SQLITE_DEBUG. 19 */ 20 #include "sqliteInt.h" 21 #ifdef SQLITE_DEBUG 22 23 /* 24 ** Add a new subitem to the tree. The moreToFollow flag indicates that this 25 ** is not the last item in the tree. 26 */ 27 static TreeView *sqlite3TreeViewPush(TreeView *p, u8 moreToFollow){ 28 if( p==0 ){ 29 p = sqlite3_malloc64( sizeof(*p) ); 30 if( p==0 ) return 0; 31 memset(p, 0, sizeof(*p)); 32 }else{ 33 p->iLevel++; 34 } 35 assert( moreToFollow==0 || moreToFollow==1 ); 36 if( p->iLevel<sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow; 37 return p; 38 } 39 40 /* 41 ** Finished with one layer of the tree 42 */ 43 static void sqlite3TreeViewPop(TreeView *p){ 44 if( p==0 ) return; 45 p->iLevel--; 46 if( p->iLevel<0 ) sqlite3_free(p); 47 } 48 49 /* 50 ** Generate a single line of output for the tree, with a prefix that contains 51 ** all the appropriate tree lines 52 */ 53 static void sqlite3TreeViewLine(TreeView *p, const char *zFormat, ...){ 54 va_list ap; 55 int i; 56 StrAccum acc; 57 char zBuf[500]; 58 sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0); 59 if( p ){ 60 for(i=0; i<p->iLevel && i<sizeof(p->bLine)-1; i++){ 61 sqlite3StrAccumAppend(&acc, p->bLine[i] ? "| " : " ", 4); 62 } 63 sqlite3StrAccumAppend(&acc, p->bLine[i] ? "|-- " : "'-- ", 4); 64 } 65 va_start(ap, zFormat); 66 sqlite3VXPrintf(&acc, 0, zFormat, ap); 67 va_end(ap); 68 if( zBuf[acc.nChar-1]!='\n' ) sqlite3StrAccumAppend(&acc, "\n", 1); 69 sqlite3StrAccumFinish(&acc); 70 fprintf(stdout,"%s", zBuf); 71 fflush(stdout); 72 } 73 74 /* 75 ** Shorthand for starting a new tree item that consists of a single label 76 */ 77 static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){ 78 p = sqlite3TreeViewPush(p, moreFollows); 79 sqlite3TreeViewLine(p, "%s", zLabel); 80 } 81 82 83 /* 84 ** Generate a human-readable description of a the Select object. 85 */ 86 void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){ 87 int n = 0; 88 pView = sqlite3TreeViewPush(pView, moreToFollow); 89 sqlite3TreeViewLine(pView, "SELECT%s%s (0x%p) selFlags=0x%x", 90 ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""), 91 ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""), p, p->selFlags 92 ); 93 if( p->pSrc && p->pSrc->nSrc ) n++; 94 if( p->pWhere ) n++; 95 if( p->pGroupBy ) n++; 96 if( p->pHaving ) n++; 97 if( p->pOrderBy ) n++; 98 if( p->pLimit ) n++; 99 if( p->pOffset ) n++; 100 if( p->pPrior ) n++; 101 sqlite3TreeViewExprList(pView, p->pEList, (n--)>0, "result-set"); 102 if( p->pSrc && p->pSrc->nSrc ){ 103 int i; 104 pView = sqlite3TreeViewPush(pView, (n--)>0); 105 sqlite3TreeViewLine(pView, "FROM"); 106 for(i=0; i<p->pSrc->nSrc; i++){ 107 struct SrcList_item *pItem = &p->pSrc->a[i]; 108 StrAccum x; 109 char zLine[100]; 110 sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0); 111 sqlite3XPrintf(&x, 0, "{%d,*}", pItem->iCursor); 112 if( pItem->zDatabase ){ 113 sqlite3XPrintf(&x, 0, " %s.%s", pItem->zDatabase, pItem->zName); 114 }else if( pItem->zName ){ 115 sqlite3XPrintf(&x, 0, " %s", pItem->zName); 116 } 117 if( pItem->pTab ){ 118 sqlite3XPrintf(&x, 0, " tabname=%Q", pItem->pTab->zName); 119 } 120 if( pItem->zAlias ){ 121 sqlite3XPrintf(&x, 0, " (AS %s)", pItem->zAlias); 122 } 123 if( pItem->jointype & JT_LEFT ){ 124 sqlite3XPrintf(&x, 0, " LEFT-JOIN"); 125 } 126 sqlite3StrAccumFinish(&x); 127 sqlite3TreeViewItem(pView, zLine, i<p->pSrc->nSrc-1); 128 if( pItem->pSelect ){ 129 sqlite3TreeViewSelect(pView, pItem->pSelect, 0); 130 } 131 sqlite3TreeViewPop(pView); 132 } 133 sqlite3TreeViewPop(pView); 134 } 135 if( p->pWhere ){ 136 sqlite3TreeViewItem(pView, "WHERE", (n--)>0); 137 sqlite3TreeViewExpr(pView, p->pWhere, 0); 138 sqlite3TreeViewPop(pView); 139 } 140 if( p->pGroupBy ){ 141 sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY"); 142 } 143 if( p->pHaving ){ 144 sqlite3TreeViewItem(pView, "HAVING", (n--)>0); 145 sqlite3TreeViewExpr(pView, p->pHaving, 0); 146 sqlite3TreeViewPop(pView); 147 } 148 if( p->pOrderBy ){ 149 sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY"); 150 } 151 if( p->pLimit ){ 152 sqlite3TreeViewItem(pView, "LIMIT", (n--)>0); 153 sqlite3TreeViewExpr(pView, p->pLimit, 0); 154 sqlite3TreeViewPop(pView); 155 } 156 if( p->pOffset ){ 157 sqlite3TreeViewItem(pView, "OFFSET", (n--)>0); 158 sqlite3TreeViewExpr(pView, p->pOffset, 0); 159 sqlite3TreeViewPop(pView); 160 } 161 if( p->pPrior ){ 162 const char *zOp = "UNION"; 163 switch( p->op ){ 164 case TK_ALL: zOp = "UNION ALL"; break; 165 case TK_INTERSECT: zOp = "INTERSECT"; break; 166 case TK_EXCEPT: zOp = "EXCEPT"; break; 167 } 168 sqlite3TreeViewItem(pView, zOp, (n--)>0); 169 sqlite3TreeViewSelect(pView, p->pPrior, 0); 170 sqlite3TreeViewPop(pView); 171 } 172 sqlite3TreeViewPop(pView); 173 } 174 175 /* 176 ** Generate a human-readable explanation of an expression tree. 177 */ 178 void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){ 179 const char *zBinOp = 0; /* Binary operator */ 180 const char *zUniOp = 0; /* Unary operator */ 181 pView = sqlite3TreeViewPush(pView, moreToFollow); 182 if( pExpr==0 ){ 183 sqlite3TreeViewLine(pView, "nil"); 184 sqlite3TreeViewPop(pView); 185 return; 186 } 187 switch( pExpr->op ){ 188 case TK_AGG_COLUMN: { 189 sqlite3TreeViewLine(pView, "AGG{%d:%d}", 190 pExpr->iTable, pExpr->iColumn); 191 break; 192 } 193 case TK_COLUMN: { 194 if( pExpr->iTable<0 ){ 195 /* This only happens when coding check constraints */ 196 sqlite3TreeViewLine(pView, "COLUMN(%d)", pExpr->iColumn); 197 }else{ 198 sqlite3TreeViewLine(pView, "{%d:%d}", 199 pExpr->iTable, pExpr->iColumn); 200 } 201 break; 202 } 203 case TK_INTEGER: { 204 if( pExpr->flags & EP_IntValue ){ 205 sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue); 206 }else{ 207 sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken); 208 } 209 break; 210 } 211 #ifndef SQLITE_OMIT_FLOATING_POINT 212 case TK_FLOAT: { 213 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken); 214 break; 215 } 216 #endif 217 case TK_STRING: { 218 sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken); 219 break; 220 } 221 case TK_NULL: { 222 sqlite3TreeViewLine(pView,"NULL"); 223 break; 224 } 225 #ifndef SQLITE_OMIT_BLOB_LITERAL 226 case TK_BLOB: { 227 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken); 228 break; 229 } 230 #endif 231 case TK_VARIABLE: { 232 sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)", 233 pExpr->u.zToken, pExpr->iColumn); 234 break; 235 } 236 case TK_REGISTER: { 237 sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable); 238 break; 239 } 240 case TK_AS: { 241 sqlite3TreeViewLine(pView,"AS %Q", pExpr->u.zToken); 242 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0); 243 break; 244 } 245 case TK_ID: { 246 sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken); 247 break; 248 } 249 #ifndef SQLITE_OMIT_CAST 250 case TK_CAST: { 251 /* Expressions of the form: CAST(pLeft AS token) */ 252 sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken); 253 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0); 254 break; 255 } 256 #endif /* SQLITE_OMIT_CAST */ 257 case TK_LT: zBinOp = "LT"; break; 258 case TK_LE: zBinOp = "LE"; break; 259 case TK_GT: zBinOp = "GT"; break; 260 case TK_GE: zBinOp = "GE"; break; 261 case TK_NE: zBinOp = "NE"; break; 262 case TK_EQ: zBinOp = "EQ"; break; 263 case TK_IS: zBinOp = "IS"; break; 264 case TK_ISNOT: zBinOp = "ISNOT"; break; 265 case TK_AND: zBinOp = "AND"; break; 266 case TK_OR: zBinOp = "OR"; break; 267 case TK_PLUS: zBinOp = "ADD"; break; 268 case TK_STAR: zBinOp = "MUL"; break; 269 case TK_MINUS: zBinOp = "SUB"; break; 270 case TK_REM: zBinOp = "REM"; break; 271 case TK_BITAND: zBinOp = "BITAND"; break; 272 case TK_BITOR: zBinOp = "BITOR"; break; 273 case TK_SLASH: zBinOp = "DIV"; break; 274 case TK_LSHIFT: zBinOp = "LSHIFT"; break; 275 case TK_RSHIFT: zBinOp = "RSHIFT"; break; 276 case TK_CONCAT: zBinOp = "CONCAT"; break; 277 case TK_DOT: zBinOp = "DOT"; break; 278 279 case TK_UMINUS: zUniOp = "UMINUS"; break; 280 case TK_UPLUS: zUniOp = "UPLUS"; break; 281 case TK_BITNOT: zUniOp = "BITNOT"; break; 282 case TK_NOT: zUniOp = "NOT"; break; 283 case TK_ISNULL: zUniOp = "ISNULL"; break; 284 case TK_NOTNULL: zUniOp = "NOTNULL"; break; 285 286 case TK_COLLATE: { 287 sqlite3TreeViewLine(pView, "COLLATE %Q", pExpr->u.zToken); 288 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0); 289 break; 290 } 291 292 case TK_AGG_FUNCTION: 293 case TK_FUNCTION: { 294 ExprList *pFarg; /* List of function arguments */ 295 if( ExprHasProperty(pExpr, EP_TokenOnly) ){ 296 pFarg = 0; 297 }else{ 298 pFarg = pExpr->x.pList; 299 } 300 if( pExpr->op==TK_AGG_FUNCTION ){ 301 sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q", 302 pExpr->op2, pExpr->u.zToken); 303 }else{ 304 sqlite3TreeViewLine(pView, "FUNCTION %Q", pExpr->u.zToken); 305 } 306 if( pFarg ){ 307 sqlite3TreeViewExprList(pView, pFarg, 0, 0); 308 } 309 break; 310 } 311 #ifndef SQLITE_OMIT_SUBQUERY 312 case TK_EXISTS: { 313 sqlite3TreeViewLine(pView, "EXISTS-expr"); 314 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0); 315 break; 316 } 317 case TK_SELECT: { 318 sqlite3TreeViewLine(pView, "SELECT-expr"); 319 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0); 320 break; 321 } 322 case TK_IN: { 323 sqlite3TreeViewLine(pView, "IN"); 324 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1); 325 if( ExprHasProperty(pExpr, EP_xIsSelect) ){ 326 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0); 327 }else{ 328 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0); 329 } 330 break; 331 } 332 #endif /* SQLITE_OMIT_SUBQUERY */ 333 334 /* 335 ** x BETWEEN y AND z 336 ** 337 ** This is equivalent to 338 ** 339 ** x>=y AND x<=z 340 ** 341 ** X is stored in pExpr->pLeft. 342 ** Y is stored in pExpr->pList->a[0].pExpr. 343 ** Z is stored in pExpr->pList->a[1].pExpr. 344 */ 345 case TK_BETWEEN: { 346 Expr *pX = pExpr->pLeft; 347 Expr *pY = pExpr->x.pList->a[0].pExpr; 348 Expr *pZ = pExpr->x.pList->a[1].pExpr; 349 sqlite3TreeViewLine(pView, "BETWEEN"); 350 sqlite3TreeViewExpr(pView, pX, 1); 351 sqlite3TreeViewExpr(pView, pY, 1); 352 sqlite3TreeViewExpr(pView, pZ, 0); 353 break; 354 } 355 case TK_TRIGGER: { 356 /* If the opcode is TK_TRIGGER, then the expression is a reference 357 ** to a column in the new.* or old.* pseudo-tables available to 358 ** trigger programs. In this case Expr.iTable is set to 1 for the 359 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn 360 ** is set to the column of the pseudo-table to read, or to -1 to 361 ** read the rowid field. 362 */ 363 sqlite3TreeViewLine(pView, "%s(%d)", 364 pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn); 365 break; 366 } 367 case TK_CASE: { 368 sqlite3TreeViewLine(pView, "CASE"); 369 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1); 370 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0); 371 break; 372 } 373 #ifndef SQLITE_OMIT_TRIGGER 374 case TK_RAISE: { 375 const char *zType = "unk"; 376 switch( pExpr->affinity ){ 377 case OE_Rollback: zType = "rollback"; break; 378 case OE_Abort: zType = "abort"; break; 379 case OE_Fail: zType = "fail"; break; 380 case OE_Ignore: zType = "ignore"; break; 381 } 382 sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken); 383 break; 384 } 385 #endif 386 default: { 387 sqlite3TreeViewLine(pView, "op=%d", pExpr->op); 388 break; 389 } 390 } 391 if( zBinOp ){ 392 sqlite3TreeViewLine(pView, "%s", zBinOp); 393 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1); 394 sqlite3TreeViewExpr(pView, pExpr->pRight, 0); 395 }else if( zUniOp ){ 396 sqlite3TreeViewLine(pView, "%s", zUniOp); 397 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0); 398 } 399 sqlite3TreeViewPop(pView); 400 } 401 402 /* 403 ** Generate a human-readable explanation of an expression list. 404 */ 405 void sqlite3TreeViewExprList( 406 TreeView *pView, 407 const ExprList *pList, 408 u8 moreToFollow, 409 const char *zLabel 410 ){ 411 int i; 412 pView = sqlite3TreeViewPush(pView, moreToFollow); 413 if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST"; 414 if( pList==0 ){ 415 sqlite3TreeViewLine(pView, "%s (empty)", zLabel); 416 }else{ 417 sqlite3TreeViewLine(pView, "%s", zLabel); 418 for(i=0; i<pList->nExpr; i++){ 419 sqlite3TreeViewExpr(pView, pList->a[i].pExpr, i<pList->nExpr-1); 420 } 421 } 422 sqlite3TreeViewPop(pView); 423 } 424 425 #endif /* SQLITE_DEBUG */ 426