blob: 5c67de1297335121899d36513210fbcfc52119ce [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
danielk1977e014a832004-05-17 10:48:57 +000017/*
18** Return the 'affinity' of the expression pExpr if any.
19**
20** If pExpr is a column, a reference to a column via an 'AS' alias,
21** or a sub-select with a column as the return value, then the
22** affinity of that column is returned. Otherwise, 0x00 is returned,
23** indicating no affinity for the expression.
24**
peter.d.reid60ec9142014-09-06 16:39:46 +000025** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000026** have an affinity:
27**
28** CREATE TABLE t1(a);
29** SELECT * FROM t1 WHERE a;
30** SELECT a AS b FROM t1 WHERE b;
31** SELECT * FROM t1 WHERE (select a from t1);
32*/
danielk1977bf3b7212004-05-18 10:06:24 +000033char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000034 int op;
35 pExpr = sqlite3ExprSkipCollate(pExpr);
mistachkin9bec6fb2014-06-26 21:28:21 +000036 if( pExpr->flags & EP_Generic ) return 0;
drh580c8c12012-12-08 03:34:04 +000037 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000038 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000039 assert( pExpr->flags&EP_xIsSelect );
40 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000041 }
drh487e2622005-06-25 18:42:14 +000042#ifndef SQLITE_OMIT_CAST
43 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000044 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000045 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000046 }
47#endif
danielk1977259a4552008-11-12 08:07:12 +000048 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
49 && pExpr->pTab!=0
50 ){
drh7d10d5a2008-08-20 16:35:10 +000051 /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
52 ** a TK_COLUMN but was previously evaluated and cached in a register */
53 int j = pExpr->iColumn;
54 if( j<0 ) return SQLITE_AFF_INTEGER;
55 assert( pExpr->pTab && j<pExpr->pTab->nCol );
56 return pExpr->pTab->aCol[j].affinity;
57 }
danielk1977a37cdde2004-05-16 11:15:36 +000058 return pExpr->affinity;
59}
60
drh53db1452004-05-20 13:54:53 +000061/*
drh8b4c40d2007-02-01 23:02:45 +000062** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000063** sequence named by pToken. Return a pointer to a new Expr node that
64** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000065**
66** If a memory allocation error occurs, that fact is recorded in pParse->db
67** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000068*/
drh4ef7efa2014-03-20 15:14:08 +000069Expr *sqlite3ExprAddCollateToken(
70 Parse *pParse, /* Parsing context */
71 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000072 const Token *pCollName, /* Name of collating sequence */
73 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000074){
drh0a8a4062012-12-07 18:38:16 +000075 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000076 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000077 if( pNew ){
78 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000079 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000080 pExpr = pNew;
81 }
drhae80dde2012-12-06 21:16:43 +000082 }
drh0a8a4062012-12-07 18:38:16 +000083 return pExpr;
84}
85Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +000086 Token s;
87 assert( zC!=0 );
88 s.z = zC;
89 s.n = sqlite3Strlen30(s.z);
dan80103fc2015-03-20 08:43:59 +000090 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +000091}
92
93/*
drh0b8d2552015-09-05 22:36:07 +000094** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +000095** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +000096*/
97Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha4c3c872013-09-12 17:29:25 +000098 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
99 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000100 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
101 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000102 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000103 pExpr = pExpr->x.pList->a[0].pExpr;
104 }else{
drh0b8d2552015-09-05 22:36:07 +0000105 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000106 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000107 }
drha4c3c872013-09-12 17:29:25 +0000108 }
drh0a8a4062012-12-07 18:38:16 +0000109 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000110}
111
112/*
drhae80dde2012-12-06 21:16:43 +0000113** Return the collation sequence for the expression pExpr. If
114** there is no defined collating sequence, return NULL.
115**
116** The collating sequence might be determined by a COLLATE operator
117** or by the presence of a column with a defined collating sequence.
118** COLLATE operators take first precedence. Left operands take
119** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000120*/
danielk19777cedc8d2004-06-10 10:50:08 +0000121CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000122 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000123 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000124 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000125 while( p ){
drhae80dde2012-12-06 21:16:43 +0000126 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000127 if( p->flags & EP_Generic ) break;
drhae80dde2012-12-06 21:16:43 +0000128 if( op==TK_CAST || op==TK_UPLUS ){
129 p = p->pLeft;
130 continue;
131 }
dan36e78302013-08-21 12:04:32 +0000132 if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
drh6fdd3d82013-05-15 17:47:12 +0000133 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
drhae80dde2012-12-06 21:16:43 +0000134 break;
135 }
drha58d4a92015-01-27 13:17:05 +0000136 if( (op==TK_AGG_COLUMN || op==TK_COLUMN
drhae80dde2012-12-06 21:16:43 +0000137 || op==TK_REGISTER || op==TK_TRIGGER)
drha58d4a92015-01-27 13:17:05 +0000138 && p->pTab!=0
drhae80dde2012-12-06 21:16:43 +0000139 ){
drh7d10d5a2008-08-20 16:35:10 +0000140 /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
141 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000142 int j = p->iColumn;
143 if( j>=0 ){
drhae80dde2012-12-06 21:16:43 +0000144 const char *zColl = p->pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000145 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000146 }
147 break;
danielk19770202b292004-06-09 09:55:16 +0000148 }
drhae80dde2012-12-06 21:16:43 +0000149 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000150 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000151 p = p->pLeft;
152 }else{
drh2308ed32015-02-09 16:09:34 +0000153 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000154 /* The Expr.x union is never used at the same time as Expr.pRight */
155 assert( p->x.pList==0 || p->pRight==0 );
156 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
157 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
158 ** least one EP_Collate. Thus the following two ALWAYS. */
159 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000160 int i;
drh6728cd92015-02-09 18:28:03 +0000161 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000162 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
163 pNext = p->x.pList->a[i].pExpr;
164 break;
165 }
166 }
167 }
168 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000169 }
170 }else{
drh7d10d5a2008-08-20 16:35:10 +0000171 break;
172 }
danielk19770202b292004-06-09 09:55:16 +0000173 }
danielk19777cedc8d2004-06-10 10:50:08 +0000174 if( sqlite3CheckCollSeq(pParse, pColl) ){
175 pColl = 0;
176 }
177 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000178}
179
180/*
drh626a8792005-01-17 22:08:19 +0000181** pExpr is an operand of a comparison operator. aff2 is the
182** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000183** type affinity that should be used for the comparison operator.
184*/
danielk1977e014a832004-05-17 10:48:57 +0000185char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000186 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000187 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000188 /* Both sides of the comparison are columns. If one has numeric
189 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000190 */
drh8a512562005-11-14 22:29:05 +0000191 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000192 return SQLITE_AFF_NUMERIC;
193 }else{
drh05883a32015-06-02 15:32:08 +0000194 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000195 }
196 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000197 /* Neither side of the comparison is a column. Compare the
198 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000199 */
drh05883a32015-06-02 15:32:08 +0000200 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000201 }else{
202 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000203 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000204 return (aff1 + aff2);
205 }
206}
207
drh53db1452004-05-20 13:54:53 +0000208/*
209** pExpr is a comparison operator. Return the type affinity that should
210** be applied to both operands prior to doing the comparison.
211*/
danielk1977e014a832004-05-17 10:48:57 +0000212static char comparisonAffinity(Expr *pExpr){
213 char aff;
214 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
215 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000216 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000217 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000218 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000219 if( pExpr->pRight ){
220 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000221 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
222 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
223 }else if( !aff ){
drh05883a32015-06-02 15:32:08 +0000224 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000225 }
226 return aff;
227}
228
229/*
230** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
231** idx_affinity is the affinity of an indexed column. Return true
232** if the index with affinity idx_affinity may be used to implement
233** the comparison in pExpr.
234*/
235int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
236 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000237 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000238 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000239 return 1;
240 case SQLITE_AFF_TEXT:
241 return idx_affinity==SQLITE_AFF_TEXT;
242 default:
243 return sqlite3IsNumericAffinity(idx_affinity);
244 }
danielk1977e014a832004-05-17 10:48:57 +0000245}
246
danielk1977a37cdde2004-05-16 11:15:36 +0000247/*
drh35573352008-01-08 23:54:25 +0000248** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000249** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000250*/
drh35573352008-01-08 23:54:25 +0000251static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
252 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000253 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000254 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000255}
256
drha2e00042002-01-22 03:13:42 +0000257/*
danielk19770202b292004-06-09 09:55:16 +0000258** Return a pointer to the collation sequence that should be used by
259** a binary comparison operator comparing pLeft and pRight.
260**
261** If the left hand expression has a collating sequence type, then it is
262** used. Otherwise the collation sequence for the right hand expression
263** is used, or the default (BINARY) if neither expression has a collating
264** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000265**
266** Argument pRight (but not pLeft) may be a null pointer. In this case,
267** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000268*/
drh0a0e1312007-08-07 17:04:59 +0000269CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000270 Parse *pParse,
271 Expr *pLeft,
272 Expr *pRight
273){
drhec41dda2007-02-07 13:09:45 +0000274 CollSeq *pColl;
275 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000276 if( pLeft->flags & EP_Collate ){
277 pColl = sqlite3ExprCollSeq(pParse, pLeft);
278 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
279 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000280 }else{
281 pColl = sqlite3ExprCollSeq(pParse, pLeft);
282 if( !pColl ){
283 pColl = sqlite3ExprCollSeq(pParse, pRight);
284 }
danielk19770202b292004-06-09 09:55:16 +0000285 }
286 return pColl;
287}
288
289/*
drhbe5c89a2004-07-26 00:31:09 +0000290** Generate code for a comparison operator.
291*/
292static int codeCompare(
293 Parse *pParse, /* The parsing (and code generating) context */
294 Expr *pLeft, /* The left operand */
295 Expr *pRight, /* The right operand */
296 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000297 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000298 int dest, /* Jump here if true. */
299 int jumpIfNull /* If true, jump if either operand is NULL */
300){
drh35573352008-01-08 23:54:25 +0000301 int p5;
302 int addr;
303 CollSeq *p4;
304
305 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
306 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
307 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
308 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000309 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000310 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000311}
312
danielk19774b5255a2008-06-05 16:47:39 +0000313#if SQLITE_MAX_EXPR_DEPTH>0
314/*
315** Check that argument nHeight is less than or equal to the maximum
316** expression depth allowed. If it is not, leave an error message in
317** pParse.
318*/
drh7d10d5a2008-08-20 16:35:10 +0000319int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000320 int rc = SQLITE_OK;
321 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
322 if( nHeight>mxHeight ){
323 sqlite3ErrorMsg(pParse,
324 "Expression tree is too large (maximum depth %d)", mxHeight
325 );
326 rc = SQLITE_ERROR;
327 }
328 return rc;
329}
330
331/* The following three functions, heightOfExpr(), heightOfExprList()
332** and heightOfSelect(), are used to determine the maximum height
333** of any expression tree referenced by the structure passed as the
334** first argument.
335**
336** If this maximum height is greater than the current value pointed
337** to by pnHeight, the second parameter, then set *pnHeight to that
338** value.
339*/
340static void heightOfExpr(Expr *p, int *pnHeight){
341 if( p ){
342 if( p->nHeight>*pnHeight ){
343 *pnHeight = p->nHeight;
344 }
345 }
346}
347static void heightOfExprList(ExprList *p, int *pnHeight){
348 if( p ){
349 int i;
350 for(i=0; i<p->nExpr; i++){
351 heightOfExpr(p->a[i].pExpr, pnHeight);
352 }
353 }
354}
355static void heightOfSelect(Select *p, int *pnHeight){
356 if( p ){
357 heightOfExpr(p->pWhere, pnHeight);
358 heightOfExpr(p->pHaving, pnHeight);
359 heightOfExpr(p->pLimit, pnHeight);
360 heightOfExpr(p->pOffset, pnHeight);
361 heightOfExprList(p->pEList, pnHeight);
362 heightOfExprList(p->pGroupBy, pnHeight);
363 heightOfExprList(p->pOrderBy, pnHeight);
364 heightOfSelect(p->pPrior, pnHeight);
365 }
366}
367
368/*
369** Set the Expr.nHeight variable in the structure passed as an
370** argument. An expression with no children, Expr.pList or
371** Expr.pSelect member has a height of 1. Any other expression
372** has a height equal to the maximum height of any other
373** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000374**
375** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
376** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000377*/
378static void exprSetHeight(Expr *p){
379 int nHeight = 0;
380 heightOfExpr(p->pLeft, &nHeight);
381 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000382 if( ExprHasProperty(p, EP_xIsSelect) ){
383 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000384 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000385 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000386 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000387 }
danielk19774b5255a2008-06-05 16:47:39 +0000388 p->nHeight = nHeight + 1;
389}
390
391/*
392** Set the Expr.nHeight variable using the exprSetHeight() function. If
393** the height is greater than the maximum allowed expression depth,
394** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000395**
396** Also propagate all EP_Propagate flags from the Expr.x.pList into
397** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000398*/
drh2308ed32015-02-09 16:09:34 +0000399void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000400 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000401 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000402 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000403}
404
405/*
406** Return the maximum height of any expression tree referenced
407** by the select statement passed as an argument.
408*/
409int sqlite3SelectExprHeight(Select *p){
410 int nHeight = 0;
411 heightOfSelect(p, &nHeight);
412 return nHeight;
413}
drh2308ed32015-02-09 16:09:34 +0000414#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
415/*
416** Propagate all EP_Propagate flags from the Expr.x.pList into
417** Expr.flags.
418*/
419void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
420 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
421 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
422 }
423}
424#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000425#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
426
drhbe5c89a2004-07-26 00:31:09 +0000427/*
drhb7916a72009-05-27 10:31:29 +0000428** This routine is the core allocator for Expr nodes.
429**
drha76b5df2002-02-23 02:32:10 +0000430** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000431** for this node and for the pToken argument is a single allocation
432** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000433** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000434**
435** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000436** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000437** parameter is ignored if pToken is NULL or if the token does not
438** appear to be quoted. If the quotes were of the form "..." (double-quotes)
439** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000440**
441** Special case: If op==TK_INTEGER and pToken points to a string that
442** can be translated into a 32-bit integer, then the token is not
443** stored in u.zToken. Instead, the integer values is written
444** into u.iValue and the EP_IntValue flag is set. No extra storage
445** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000446*/
drhb7916a72009-05-27 10:31:29 +0000447Expr *sqlite3ExprAlloc(
danielk1977a1644fd2007-08-29 12:31:25 +0000448 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
drh17435752007-08-16 04:30:38 +0000449 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000450 const Token *pToken, /* Token argument. Might be NULL */
451 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000452){
drha76b5df2002-02-23 02:32:10 +0000453 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000454 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000455 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000456
drhb7916a72009-05-27 10:31:29 +0000457 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000458 if( op!=TK_INTEGER || pToken->z==0
459 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
460 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000461 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000462 }
drhb7916a72009-05-27 10:31:29 +0000463 }
464 pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
465 if( pNew ){
466 pNew->op = (u8)op;
467 pNew->iAgg = -1;
468 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000469 if( nExtra==0 ){
470 pNew->flags |= EP_IntValue;
471 pNew->u.iValue = iValue;
472 }else{
473 int c;
474 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000475 assert( pToken->z!=0 || pToken->n==0 );
476 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000477 pNew->u.zToken[pToken->n] = 0;
478 if( dequote && nExtra>=3
479 && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
480 sqlite3Dequote(pNew->u.zToken);
481 if( c=='"' ) pNew->flags |= EP_DblQuoted;
482 }
drhb7916a72009-05-27 10:31:29 +0000483 }
484 }
485#if SQLITE_MAX_EXPR_DEPTH>0
486 pNew->nHeight = 1;
487#endif
488 }
drha76b5df2002-02-23 02:32:10 +0000489 return pNew;
490}
491
492/*
drhb7916a72009-05-27 10:31:29 +0000493** Allocate a new expression node from a zero-terminated token that has
494** already been dequoted.
495*/
496Expr *sqlite3Expr(
497 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
498 int op, /* Expression opcode */
499 const char *zToken /* Token argument. Might be NULL */
500){
501 Token x;
502 x.z = zToken;
503 x.n = zToken ? sqlite3Strlen30(zToken) : 0;
504 return sqlite3ExprAlloc(db, op, &x, 0);
505}
506
507/*
508** Attach subtrees pLeft and pRight to the Expr node pRoot.
509**
510** If pRoot==NULL that means that a memory allocation error has occurred.
511** In that case, delete the subtrees pLeft and pRight.
512*/
513void sqlite3ExprAttachSubtrees(
514 sqlite3 *db,
515 Expr *pRoot,
516 Expr *pLeft,
517 Expr *pRight
518){
519 if( pRoot==0 ){
520 assert( db->mallocFailed );
521 sqlite3ExprDelete(db, pLeft);
522 sqlite3ExprDelete(db, pRight);
523 }else{
524 if( pRight ){
525 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000526 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000527 }
528 if( pLeft ){
529 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000530 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000531 }
532 exprSetHeight(pRoot);
533 }
534}
535
536/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000537** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000538**
drhbf664462009-06-19 18:32:54 +0000539** One or both of the subtrees can be NULL. Return a pointer to the new
540** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
541** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000542*/
drh17435752007-08-16 04:30:38 +0000543Expr *sqlite3PExpr(
544 Parse *pParse, /* Parsing context */
545 int op, /* Expression opcode */
546 Expr *pLeft, /* Left operand */
547 Expr *pRight, /* Right operand */
548 const Token *pToken /* Argument token */
549){
drh5fb52ca2012-03-31 02:34:35 +0000550 Expr *p;
drh1167d322015-10-28 20:01:45 +0000551 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000552 /* Take advantage of short-circuit false optimization for AND */
553 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
554 }else{
drh1167d322015-10-28 20:01:45 +0000555 p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
drh5fb52ca2012-03-31 02:34:35 +0000556 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
557 }
dan2b359bd2010-10-28 11:31:23 +0000558 if( p ) {
559 sqlite3ExprCheckHeight(pParse, p->nHeight);
560 }
drh4e0cff62004-11-05 05:10:28 +0000561 return p;
562}
563
564/*
drh991a1982014-01-02 17:57:16 +0000565** If the expression is always either TRUE or FALSE (respectively),
566** then return 1. If one cannot determine the truth value of the
567** expression at compile-time return 0.
568**
569** This is an optimization. If is OK to return 0 here even if
570** the expression really is always false or false (a false negative).
571** But it is a bug to return 1 if the expression might have different
572** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000573**
574** Note that if the expression is part of conditional for a
575** LEFT JOIN, then we cannot determine at compile-time whether or not
576** is it true or false, so always return 0.
577*/
drh991a1982014-01-02 17:57:16 +0000578static int exprAlwaysTrue(Expr *p){
579 int v = 0;
580 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
581 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
582 return v!=0;
583}
drh5fb52ca2012-03-31 02:34:35 +0000584static int exprAlwaysFalse(Expr *p){
585 int v = 0;
586 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
587 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
588 return v==0;
589}
590
591/*
drh91bb0ee2004-09-01 03:06:34 +0000592** Join two expressions using an AND operator. If either expression is
593** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000594**
595** If one side or the other of the AND is known to be false, then instead
596** of returning an AND expression, just return a constant expression with
597** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000598*/
danielk19771e536952007-08-16 10:09:01 +0000599Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000600 if( pLeft==0 ){
601 return pRight;
602 }else if( pRight==0 ){
603 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000604 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
605 sqlite3ExprDelete(db, pLeft);
606 sqlite3ExprDelete(db, pRight);
607 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000608 }else{
drhb7916a72009-05-27 10:31:29 +0000609 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
610 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
611 return pNew;
drha76b5df2002-02-23 02:32:10 +0000612 }
613}
614
615/*
616** Construct a new expression node for a function with multiple
617** arguments.
618*/
drh17435752007-08-16 04:30:38 +0000619Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
drha76b5df2002-02-23 02:32:10 +0000620 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000621 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000622 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000623 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000624 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000625 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000626 return 0;
627 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000628 pNew->x.pList = pList;
629 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000630 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drha76b5df2002-02-23 02:32:10 +0000631 return pNew;
632}
633
634/*
drhfa6bc002004-09-07 16:19:52 +0000635** Assign a variable number to an expression that encodes a wildcard
636** in the original SQL statement.
637**
638** Wildcards consisting of a single "?" are assigned the next sequential
639** variable number.
640**
641** Wildcards of the form "?nnn" are assigned the number "nnn". We make
642** sure "nnn" is not too be to avoid a denial of service attack when
643** the SQL statement comes from an external source.
644**
drh51f49f12009-05-21 20:41:32 +0000645** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000646** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000647** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000648** assigned.
649*/
650void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
drh17435752007-08-16 04:30:38 +0000651 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000652 const char *z;
drh17435752007-08-16 04:30:38 +0000653
drhfa6bc002004-09-07 16:19:52 +0000654 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000655 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000656 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000657 assert( z!=0 );
658 assert( z[0]!=0 );
659 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000660 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000661 assert( z[0]=='?' );
drh8677d302009-11-04 13:17:14 +0000662 pExpr->iColumn = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000663 }else{
drh124c0b42011-06-01 18:15:55 +0000664 ynVar x = 0;
665 u32 n = sqlite3Strlen30(z);
666 if( z[0]=='?' ){
667 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
668 ** use it as the variable number */
669 i64 i;
670 int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
671 pExpr->iColumn = x = (ynVar)i;
672 testcase( i==0 );
673 testcase( i==1 );
674 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
675 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
676 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
677 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
678 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
679 x = 0;
drhfa6bc002004-09-07 16:19:52 +0000680 }
drh124c0b42011-06-01 18:15:55 +0000681 if( i>pParse->nVar ){
682 pParse->nVar = (int)i;
683 }
684 }else{
685 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
686 ** number as the prior appearance of the same name, or if the name
687 ** has never appeared before, reuse the same variable number
688 */
689 ynVar i;
690 for(i=0; i<pParse->nzVar; i++){
drh503a6862013-03-01 01:07:17 +0000691 if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
drh124c0b42011-06-01 18:15:55 +0000692 pExpr->iColumn = x = (ynVar)i+1;
693 break;
694 }
695 }
696 if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000697 }
drh124c0b42011-06-01 18:15:55 +0000698 if( x>0 ){
699 if( x>pParse->nzVar ){
700 char **a;
701 a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
702 if( a==0 ) return; /* Error reported through db->mallocFailed */
703 pParse->azVar = a;
704 memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
705 pParse->nzVar = x;
drhfa6bc002004-09-07 16:19:52 +0000706 }
drh124c0b42011-06-01 18:15:55 +0000707 if( z[0]!='?' || pParse->azVar[x-1]==0 ){
708 sqlite3DbFree(db, pParse->azVar[x-1]);
709 pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
drhfa6bc002004-09-07 16:19:52 +0000710 }
711 }
712 }
drhbb4957f2008-03-20 14:03:29 +0000713 if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +0000714 sqlite3ErrorMsg(pParse, "too many SQL variables");
715 }
drhfa6bc002004-09-07 16:19:52 +0000716}
717
718/*
danf6963f92009-11-23 14:39:14 +0000719** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +0000720*/
danf6963f92009-11-23 14:39:14 +0000721void sqlite3ExprDelete(sqlite3 *db, Expr *p){
722 if( p==0 ) return;
drhd50ffc42011-03-08 02:38:28 +0000723 /* Sanity check: Assert that the IntValue is non-negative if it exists */
724 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drhc5cd1242013-09-12 16:50:49 +0000725 if( !ExprHasProperty(p, EP_TokenOnly) ){
726 /* The Expr.x union is never used at the same time as Expr.pRight */
727 assert( p->x.pList==0 || p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +0000728 sqlite3ExprDelete(db, p->pLeft);
729 sqlite3ExprDelete(db, p->pRight);
drhc5cd1242013-09-12 16:50:49 +0000730 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
danielk19776ab3a2e2009-02-19 14:39:25 +0000731 if( ExprHasProperty(p, EP_xIsSelect) ){
732 sqlite3SelectDelete(db, p->x.pSelect);
733 }else{
734 sqlite3ExprListDelete(db, p->x.pList);
735 }
736 }
drh33e619f2009-05-28 01:00:55 +0000737 if( !ExprHasProperty(p, EP_Static) ){
738 sqlite3DbFree(db, p);
739 }
drha2e00042002-01-22 03:13:42 +0000740}
741
drhd2687b72005-08-12 22:56:09 +0000742/*
danielk19776ab3a2e2009-02-19 14:39:25 +0000743** Return the number of bytes allocated for the expression structure
744** passed as the first argument. This is always one of EXPR_FULLSIZE,
745** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
746*/
747static int exprStructSize(Expr *p){
748 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +0000749 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
750 return EXPR_FULLSIZE;
751}
752
753/*
drh33e619f2009-05-28 01:00:55 +0000754** The dupedExpr*Size() routines each return the number of bytes required
755** to store a copy of an expression or expression tree. They differ in
756** how much of the tree is measured.
757**
758** dupedExprStructSize() Size of only the Expr structure
759** dupedExprNodeSize() Size of Expr + space for token
760** dupedExprSize() Expr + token + subtree components
761**
762***************************************************************************
763**
764** The dupedExprStructSize() function returns two values OR-ed together:
765** (1) the space required for a copy of the Expr structure only and
766** (2) the EP_xxx flags that indicate what the structure size should be.
767** The return values is always one of:
768**
769** EXPR_FULLSIZE
770** EXPR_REDUCEDSIZE | EP_Reduced
771** EXPR_TOKENONLYSIZE | EP_TokenOnly
772**
773** The size of the structure can be found by masking the return value
774** of this routine with 0xfff. The flags can be found by masking the
775** return value with EP_Reduced|EP_TokenOnly.
776**
777** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
778** (unreduced) Expr objects as they or originally constructed by the parser.
779** During expression analysis, extra information is computed and moved into
780** later parts of teh Expr object and that extra information might get chopped
781** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +0000782** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +0000783** to reduce a pristine expression tree from the parser. The implementation
784** of dupedExprStructSize() contain multiple assert() statements that attempt
785** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +0000786*/
787static int dupedExprStructSize(Expr *p, int flags){
788 int nSize;
drh33e619f2009-05-28 01:00:55 +0000789 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +0000790 assert( EXPR_FULLSIZE<=0xfff );
791 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +0000792 if( 0==(flags&EXPRDUP_REDUCE) ){
793 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +0000794 }else{
drhc5cd1242013-09-12 16:50:49 +0000795 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +0000796 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +0000797 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +0000798 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +0000799 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +0000800 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
801 }else{
drhaecd8022013-09-13 18:15:15 +0000802 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +0000803 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
804 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000805 }
806 return nSize;
807}
808
809/*
drh33e619f2009-05-28 01:00:55 +0000810** This function returns the space in bytes required to store the copy
811** of the Expr structure and a copy of the Expr.u.zToken string (if that
812** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +0000813*/
814static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +0000815 int nByte = dupedExprStructSize(p, flags) & 0xfff;
816 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
817 nByte += sqlite3Strlen30(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +0000818 }
danielk1977bc739712009-03-23 04:33:32 +0000819 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +0000820}
821
822/*
823** Return the number of bytes required to create a duplicate of the
824** expression passed as the first argument. The second argument is a
825** mask containing EXPRDUP_XXX flags.
826**
827** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +0000828** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +0000829**
830** If the EXPRDUP_REDUCE flag is set, then the return value includes
831** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
832** and Expr.pRight variables (but not for any structures pointed to or
833** descended from the Expr.x.pList or Expr.x.pSelect variables).
834*/
835static int dupedExprSize(Expr *p, int flags){
836 int nByte = 0;
837 if( p ){
838 nByte = dupedExprNodeSize(p, flags);
839 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +0000840 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +0000841 }
842 }
843 return nByte;
844}
845
846/*
847** This function is similar to sqlite3ExprDup(), except that if pzBuffer
848** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +0000849** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +0000850** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +0000851** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +0000852** portion of the buffer copied into by this function.
853*/
854static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
855 Expr *pNew = 0; /* Value to return */
drh72ea29d2015-12-08 16:58:45 +0000856 assert( flags==0 || flags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +0000857 if( p ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000858 const int isReduced = (flags&EXPRDUP_REDUCE);
859 u8 *zAlloc;
drh33e619f2009-05-28 01:00:55 +0000860 u32 staticFlag = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +0000861
862 assert( pzBuffer==0 || isReduced );
863
864 /* Figure out where to write the new Expr structure. */
865 if( pzBuffer ){
866 zAlloc = *pzBuffer;
drh33e619f2009-05-28 01:00:55 +0000867 staticFlag = EP_Static;
danielk19776ab3a2e2009-02-19 14:39:25 +0000868 }else{
869 zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
870 }
871 pNew = (Expr *)zAlloc;
872
873 if( pNew ){
874 /* Set nNewSize to the size allocated for the structure pointed to
875 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
876 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
drh33e619f2009-05-28 01:00:55 +0000877 ** by the copy of the p->u.zToken string (if any).
danielk19776ab3a2e2009-02-19 14:39:25 +0000878 */
drh33e619f2009-05-28 01:00:55 +0000879 const unsigned nStructSize = dupedExprStructSize(p, flags);
880 const int nNewSize = nStructSize & 0xfff;
881 int nToken;
882 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
883 nToken = sqlite3Strlen30(p->u.zToken) + 1;
884 }else{
885 nToken = 0;
886 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000887 if( isReduced ){
888 assert( ExprHasProperty(p, EP_Reduced)==0 );
889 memcpy(zAlloc, p, nNewSize);
890 }else{
891 int nSize = exprStructSize(p);
892 memcpy(zAlloc, p, nSize);
drh72ea29d2015-12-08 16:58:45 +0000893 if( nSize<EXPR_FULLSIZE ){
894 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
895 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000896 }
897
drh33e619f2009-05-28 01:00:55 +0000898 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
drhc5cd1242013-09-12 16:50:49 +0000899 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
drh33e619f2009-05-28 01:00:55 +0000900 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
901 pNew->flags |= staticFlag;
danielk19776ab3a2e2009-02-19 14:39:25 +0000902
drh33e619f2009-05-28 01:00:55 +0000903 /* Copy the p->u.zToken string, if any. */
danielk19776ab3a2e2009-02-19 14:39:25 +0000904 if( nToken ){
drh33e619f2009-05-28 01:00:55 +0000905 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
906 memcpy(zToken, p->u.zToken, nToken);
danielk19776ab3a2e2009-02-19 14:39:25 +0000907 }
908
909 if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000910 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
911 if( ExprHasProperty(p, EP_xIsSelect) ){
912 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
913 }else{
914 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
915 }
916 }
917
918 /* Fill in pNew->pLeft and pNew->pRight. */
drhc5cd1242013-09-12 16:50:49 +0000919 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000920 zAlloc += dupedExprNodeSize(p, flags);
921 if( ExprHasProperty(pNew, EP_Reduced) ){
922 pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
923 pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
924 }
925 if( pzBuffer ){
926 *pzBuffer = zAlloc;
927 }
drhb7916a72009-05-27 10:31:29 +0000928 }else{
drhc5cd1242013-09-12 16:50:49 +0000929 if( !ExprHasProperty(p, EP_TokenOnly) ){
drhb7916a72009-05-27 10:31:29 +0000930 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
931 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
932 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000933 }
drhb7916a72009-05-27 10:31:29 +0000934
danielk19776ab3a2e2009-02-19 14:39:25 +0000935 }
936 }
937 return pNew;
938}
939
940/*
danbfe31e72014-01-15 14:17:31 +0000941** Create and return a deep copy of the object passed as the second
942** argument. If an OOM condition is encountered, NULL is returned
943** and the db->mallocFailed flag set.
944*/
daneede6a52014-01-15 19:42:23 +0000945#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +0000946static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +0000947 With *pRet = 0;
948 if( p ){
949 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
950 pRet = sqlite3DbMallocZero(db, nByte);
951 if( pRet ){
952 int i;
953 pRet->nCte = p->nCte;
954 for(i=0; i<p->nCte; i++){
955 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
956 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
957 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
958 }
959 }
960 }
961 return pRet;
962}
daneede6a52014-01-15 19:42:23 +0000963#else
964# define withDup(x,y) 0
965#endif
dan4e9119d2014-01-13 15:12:23 +0000966
drha76b5df2002-02-23 02:32:10 +0000967/*
drhff78bd22002-02-27 01:47:11 +0000968** The following group of routines make deep copies of expressions,
969** expression lists, ID lists, and select statements. The copies can
970** be deleted (by being passed to their respective ...Delete() routines)
971** without effecting the originals.
972**
danielk19774adee202004-05-08 08:23:19 +0000973** The expression list, ID, and source lists return by sqlite3ExprListDup(),
974** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +0000975** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +0000976**
drhad3cab52002-05-24 02:04:32 +0000977** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +0000978**
drhb7916a72009-05-27 10:31:29 +0000979** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +0000980** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
981** truncated version of the usual Expr structure that will be stored as
982** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +0000983*/
danielk19776ab3a2e2009-02-19 14:39:25 +0000984Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +0000985 assert( flags==0 || flags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +0000986 return exprDup(db, p, flags, 0);
drhff78bd22002-02-27 01:47:11 +0000987}
danielk19776ab3a2e2009-02-19 14:39:25 +0000988ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +0000989 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +0000990 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +0000991 int i;
992 if( p==0 ) return 0;
drh17435752007-08-16 04:30:38 +0000993 pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +0000994 if( pNew==0 ) return 0;
drhd872bb12012-02-02 01:58:08 +0000995 pNew->nExpr = i = p->nExpr;
996 if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
997 pNew->a = pItem = sqlite3DbMallocRaw(db, i*sizeof(p->a[0]) );
danielk1977e0048402004-06-15 16:51:01 +0000998 if( pItem==0 ){
drh633e6d52008-07-28 19:34:53 +0000999 sqlite3DbFree(db, pNew);
danielk1977e0048402004-06-15 16:51:01 +00001000 return 0;
1001 }
drh145716b2004-09-24 12:24:06 +00001002 pOldItem = p->a;
1003 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001004 Expr *pOldExpr = pOldItem->pExpr;
drhb5526ea2009-07-16 12:41:05 +00001005 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh17435752007-08-16 04:30:38 +00001006 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001007 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001008 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001009 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001010 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
drhc2acc4e2013-11-15 18:15:19 +00001011 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001012 }
1013 return pNew;
1014}
danielk197793758c82005-01-21 08:13:14 +00001015
1016/*
1017** If cursors, triggers, views and subqueries are all omitted from
1018** the build, then none of the following routines, except for
1019** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1020** called with a NULL argument.
1021*/
danielk19776a67fe82005-02-04 04:07:16 +00001022#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1023 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001024SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001025 SrcList *pNew;
1026 int i;
drh113088e2003-03-20 01:16:58 +00001027 int nByte;
drhad3cab52002-05-24 02:04:32 +00001028 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001029 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh17435752007-08-16 04:30:38 +00001030 pNew = sqlite3DbMallocRaw(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001031 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001032 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001033 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001034 struct SrcList_item *pNewItem = &pNew->a[i];
1035 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001036 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001037 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001038 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1039 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1040 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001041 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001042 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001043 pNewItem->addrFillSub = pOldItem->addrFillSub;
1044 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001045 if( pNewItem->fg.isIndexedBy ){
1046 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1047 }
1048 pNewItem->pIBIndex = pOldItem->pIBIndex;
1049 if( pNewItem->fg.isTabFunc ){
1050 pNewItem->u1.pFuncArg =
1051 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1052 }
drhed8a3bb2005-06-06 21:19:56 +00001053 pTab = pNewItem->pTab = pOldItem->pTab;
1054 if( pTab ){
1055 pTab->nRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001056 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001057 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1058 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001059 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001060 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001061 }
1062 return pNew;
1063}
drh17435752007-08-16 04:30:38 +00001064IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001065 IdList *pNew;
1066 int i;
1067 if( p==0 ) return 0;
drh17435752007-08-16 04:30:38 +00001068 pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001069 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001070 pNew->nId = p->nId;
drh17435752007-08-16 04:30:38 +00001071 pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001072 if( pNew->a==0 ){
drh633e6d52008-07-28 19:34:53 +00001073 sqlite3DbFree(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001074 return 0;
1075 }
drh6c535152012-02-02 03:38:30 +00001076 /* Note that because the size of the allocation for p->a[] is not
1077 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1078 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001079 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001080 struct IdList_item *pNewItem = &pNew->a[i];
1081 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001082 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001083 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001084 }
1085 return pNew;
1086}
danielk19776ab3a2e2009-02-19 14:39:25 +00001087Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
drh23b1b372011-12-07 01:55:51 +00001088 Select *pNew, *pPrior;
drhff78bd22002-02-27 01:47:11 +00001089 if( p==0 ) return 0;
drh17435752007-08-16 04:30:38 +00001090 pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
drhff78bd22002-02-27 01:47:11 +00001091 if( pNew==0 ) return 0;
drhb7916a72009-05-27 10:31:29 +00001092 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001093 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1094 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1095 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1096 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1097 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
drhff78bd22002-02-27 01:47:11 +00001098 pNew->op = p->op;
drh23b1b372011-12-07 01:55:51 +00001099 pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
1100 if( pPrior ) pPrior->pNext = pNew;
1101 pNew->pNext = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001102 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
1103 pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
drh92b01d52008-06-24 00:32:35 +00001104 pNew->iLimit = 0;
1105 pNew->iOffset = 0;
drh7d10d5a2008-08-20 16:35:10 +00001106 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
drhb9bb7c12006-06-11 23:41:55 +00001107 pNew->addrOpenEphm[0] = -1;
1108 pNew->addrOpenEphm[1] = -1;
drhec2da852014-01-29 01:46:12 +00001109 pNew->nSelectRow = p->nSelectRow;
dan4e9119d2014-01-13 15:12:23 +00001110 pNew->pWith = withDup(db, p->pWith);
drheb9b8842014-09-21 00:27:26 +00001111 sqlite3SelectSetName(pNew, p->zSelName);
drhff78bd22002-02-27 01:47:11 +00001112 return pNew;
1113}
danielk197793758c82005-01-21 08:13:14 +00001114#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001115Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001116 assert( p==0 );
1117 return 0;
1118}
1119#endif
drhff78bd22002-02-27 01:47:11 +00001120
1121
1122/*
drha76b5df2002-02-23 02:32:10 +00001123** Add a new element to the end of an expression list. If pList is
1124** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001125**
1126** If a memory allocation error occurs, the entire list is freed and
1127** NULL is returned. If non-NULL is returned, then it is guaranteed
1128** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001129*/
drh17435752007-08-16 04:30:38 +00001130ExprList *sqlite3ExprListAppend(
1131 Parse *pParse, /* Parsing context */
1132 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001133 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001134){
1135 sqlite3 *db = pParse->db;
drha76b5df2002-02-23 02:32:10 +00001136 if( pList==0 ){
drh17435752007-08-16 04:30:38 +00001137 pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001138 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001139 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001140 }
drhd872bb12012-02-02 01:58:08 +00001141 pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1142 if( pList->a==0 ) goto no_mem;
1143 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001144 struct ExprList_item *a;
drhd872bb12012-02-02 01:58:08 +00001145 assert( pList->nExpr>0 );
1146 a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
danielk1977d5d56522005-03-16 12:15:20 +00001147 if( a==0 ){
1148 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001149 }
danielk1977d5d56522005-03-16 12:15:20 +00001150 pList->a = a;
drha76b5df2002-02-23 02:32:10 +00001151 }
drh4efc4752004-01-16 15:55:37 +00001152 assert( pList->a!=0 );
drhb7916a72009-05-27 10:31:29 +00001153 if( 1 ){
drh4efc4752004-01-16 15:55:37 +00001154 struct ExprList_item *pItem = &pList->a[pList->nExpr++];
1155 memset(pItem, 0, sizeof(*pItem));
danielk1977e94ddc92005-03-21 03:53:38 +00001156 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001157 }
1158 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001159
1160no_mem:
1161 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001162 sqlite3ExprDelete(db, pExpr);
1163 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001164 return 0;
drha76b5df2002-02-23 02:32:10 +00001165}
1166
1167/*
drhbc622bc2015-08-24 15:39:42 +00001168** Set the sort order for the last element on the given ExprList.
1169*/
1170void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1171 if( p==0 ) return;
1172 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1173 assert( p->nExpr>0 );
1174 if( iSortOrder<0 ){
1175 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1176 return;
1177 }
1178 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001179}
1180
1181/*
drhb7916a72009-05-27 10:31:29 +00001182** Set the ExprList.a[].zName element of the most recently added item
1183** on the expression list.
1184**
1185** pList might be NULL following an OOM error. But pName should never be
1186** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1187** is set.
1188*/
1189void sqlite3ExprListSetName(
1190 Parse *pParse, /* Parsing context */
1191 ExprList *pList, /* List to which to add the span. */
1192 Token *pName, /* Name to be added */
1193 int dequote /* True to cause the name to be dequoted */
1194){
1195 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1196 if( pList ){
1197 struct ExprList_item *pItem;
1198 assert( pList->nExpr>0 );
1199 pItem = &pList->a[pList->nExpr-1];
1200 assert( pItem->zName==0 );
1201 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1202 if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1203 }
1204}
1205
1206/*
1207** Set the ExprList.a[].zSpan element of the most recently added item
1208** on the expression list.
1209**
1210** pList might be NULL following an OOM error. But pSpan should never be
1211** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1212** is set.
1213*/
1214void sqlite3ExprListSetSpan(
1215 Parse *pParse, /* Parsing context */
1216 ExprList *pList, /* List to which to add the span. */
1217 ExprSpan *pSpan /* The span to be added */
1218){
1219 sqlite3 *db = pParse->db;
1220 assert( pList!=0 || db->mallocFailed!=0 );
1221 if( pList ){
1222 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1223 assert( pList->nExpr>0 );
1224 assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1225 sqlite3DbFree(db, pItem->zSpan);
1226 pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
shanecf697392009-06-01 16:53:09 +00001227 (int)(pSpan->zEnd - pSpan->zStart));
drhb7916a72009-05-27 10:31:29 +00001228 }
1229}
1230
1231/*
danielk19777a15a4b2007-05-08 17:54:43 +00001232** If the expression list pEList contains more than iLimit elements,
1233** leave an error message in pParse.
1234*/
1235void sqlite3ExprListCheckLength(
1236 Parse *pParse,
1237 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001238 const char *zObject
1239){
drhb1a6c3c2008-03-20 16:30:17 +00001240 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001241 testcase( pEList && pEList->nExpr==mx );
1242 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001243 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001244 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1245 }
1246}
1247
1248/*
drha76b5df2002-02-23 02:32:10 +00001249** Delete an entire expression list.
1250*/
drh633e6d52008-07-28 19:34:53 +00001251void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
drha76b5df2002-02-23 02:32:10 +00001252 int i;
drhbe5c89a2004-07-26 00:31:09 +00001253 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001254 if( pList==0 ) return;
drhd872bb12012-02-02 01:58:08 +00001255 assert( pList->a!=0 || pList->nExpr==0 );
drhbe5c89a2004-07-26 00:31:09 +00001256 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
drh633e6d52008-07-28 19:34:53 +00001257 sqlite3ExprDelete(db, pItem->pExpr);
1258 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001259 sqlite3DbFree(db, pItem->zSpan);
drha76b5df2002-02-23 02:32:10 +00001260 }
drh633e6d52008-07-28 19:34:53 +00001261 sqlite3DbFree(db, pList->a);
1262 sqlite3DbFree(db, pList);
drha76b5df2002-02-23 02:32:10 +00001263}
1264
1265/*
drh2308ed32015-02-09 16:09:34 +00001266** Return the bitwise-OR of all Expr.flags fields in the given
1267** ExprList.
drh885a5b02015-02-09 15:21:36 +00001268*/
drh2308ed32015-02-09 16:09:34 +00001269u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001270 int i;
drh2308ed32015-02-09 16:09:34 +00001271 u32 m = 0;
1272 if( pList ){
1273 for(i=0; i<pList->nExpr; i++){
drhd0c73052015-04-19 19:21:19 +00001274 Expr *pExpr = pList->a[i].pExpr;
drh0a969312015-05-05 16:57:52 +00001275 if( ALWAYS(pExpr) ) m |= pExpr->flags;
drh2308ed32015-02-09 16:09:34 +00001276 }
drh885a5b02015-02-09 15:21:36 +00001277 }
drh2308ed32015-02-09 16:09:34 +00001278 return m;
drh885a5b02015-02-09 15:21:36 +00001279}
1280
1281/*
drh059b2d52014-10-24 19:28:09 +00001282** These routines are Walker callbacks used to check expressions to
1283** see if they are "constant" for some definition of constant. The
1284** Walker.eCode value determines the type of "constant" we are looking
1285** for.
drh73b211a2005-01-18 04:00:42 +00001286**
drh7d10d5a2008-08-20 16:35:10 +00001287** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001288**
drh059b2d52014-10-24 19:28:09 +00001289** sqlite3ExprIsConstant() pWalker->eCode==1
1290** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001291** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001292** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001293**
drh059b2d52014-10-24 19:28:09 +00001294** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1295** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001296**
drhfeada2d2014-09-24 13:20:22 +00001297** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001298** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1299** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001300** parameter raises an error for new statements, but is silently converted
1301** to NULL for existing schemas. This allows sqlite_master tables that
1302** contain a bound parameter because they were generated by older versions
1303** of SQLite to be parsed by newer versions of SQLite without raising a
1304** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001305*/
drh7d10d5a2008-08-20 16:35:10 +00001306static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001307
drh059b2d52014-10-24 19:28:09 +00001308 /* If pWalker->eCode is 2 then any term of the expression that comes from
1309 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001310 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001311 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1312 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001313 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001314 }
1315
drh626a8792005-01-17 22:08:19 +00001316 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001317 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001318 ** and either pWalker->eCode==4 or 5 or the function has the
1319 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001320 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001321 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001322 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001323 }else{
1324 pWalker->eCode = 0;
1325 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001326 }
drh626a8792005-01-17 22:08:19 +00001327 case TK_ID:
1328 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001329 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001330 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001331 testcase( pExpr->op==TK_ID );
1332 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001333 testcase( pExpr->op==TK_AGG_FUNCTION );
1334 testcase( pExpr->op==TK_AGG_COLUMN );
drh059b2d52014-10-24 19:28:09 +00001335 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1336 return WRC_Continue;
1337 }else{
1338 pWalker->eCode = 0;
1339 return WRC_Abort;
1340 }
drhfeada2d2014-09-24 13:20:22 +00001341 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001342 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001343 /* Silently convert bound parameters that appear inside of CREATE
1344 ** statements into a NULL when parsing the CREATE statement text out
1345 ** of the sqlite_master table */
1346 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001347 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001348 /* A bound parameter in a CREATE statement that originates from
1349 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001350 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001351 return WRC_Abort;
1352 }
1353 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001354 default:
drhb74b1012009-05-28 21:04:37 +00001355 testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1356 testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
drh7d10d5a2008-08-20 16:35:10 +00001357 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001358 }
1359}
danielk197762c14b32008-11-19 09:05:26 +00001360static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
1361 UNUSED_PARAMETER(NotUsed);
drh059b2d52014-10-24 19:28:09 +00001362 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001363 return WRC_Abort;
1364}
drh059b2d52014-10-24 19:28:09 +00001365static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001366 Walker w;
drhaa87f9a2013-04-25 00:57:10 +00001367 memset(&w, 0, sizeof(w));
drh059b2d52014-10-24 19:28:09 +00001368 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001369 w.xExprCallback = exprNodeIsConstant;
1370 w.xSelectCallback = selectNodeIsConstant;
drh059b2d52014-10-24 19:28:09 +00001371 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001372 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001373 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001374}
drh626a8792005-01-17 22:08:19 +00001375
1376/*
drh059b2d52014-10-24 19:28:09 +00001377** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001378** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001379**
1380** For the purposes of this function, a double-quoted string (ex: "abc")
1381** is considered a variable but a single-quoted string (ex: 'abc') is
1382** a constant.
drhfef52082000-06-06 01:50:43 +00001383*/
danielk19774adee202004-05-08 08:23:19 +00001384int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001385 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001386}
1387
1388/*
drh059b2d52014-10-24 19:28:09 +00001389** Walk an expression tree. Return non-zero if the expression is constant
drh0a168372007-06-08 00:20:47 +00001390** that does no originate from the ON or USING clauses of a join.
1391** Return 0 if it involves variables or function calls or terms from
1392** an ON or USING clause.
1393*/
1394int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001395 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001396}
1397
1398/*
drhfcb9f4f2015-06-01 18:13:16 +00001399** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001400** for any single row of the table with cursor iCur. In other words, the
1401** expression must not refer to any non-deterministic function nor any
1402** table other than iCur.
1403*/
1404int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1405 return exprIsConst(p, 3, iCur);
1406}
1407
1408/*
1409** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001410** or a function call with constant arguments. Return and 0 if there
1411** are any variables.
1412**
1413** For the purposes of this function, a double-quoted string (ex: "abc")
1414** is considered a variable but a single-quoted string (ex: 'abc') is
1415** a constant.
1416*/
drhfeada2d2014-09-24 13:20:22 +00001417int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1418 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00001419 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00001420}
1421
drh5b88bc42013-12-07 23:35:21 +00001422#ifdef SQLITE_ENABLE_CURSOR_HINTS
1423/*
1424** Walk an expression tree. Return 1 if the expression contains a
1425** subquery of some kind. Return 0 if there are no subqueries.
1426*/
1427int sqlite3ExprContainsSubquery(Expr *p){
1428 Walker w;
1429 memset(&w, 0, sizeof(w));
drhbec24762015-08-13 20:07:13 +00001430 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00001431 w.xExprCallback = sqlite3ExprWalkNoop;
1432 w.xSelectCallback = selectNodeIsConstant;
1433 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00001434 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00001435}
1436#endif
1437
drheb55bd22005-06-30 17:04:21 +00001438/*
drh73b211a2005-01-18 04:00:42 +00001439** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00001440** to fit in a 32-bit integer, return 1 and put the value of the integer
1441** in *pValue. If the expression is not an integer or if it is too big
1442** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00001443*/
danielk19774adee202004-05-08 08:23:19 +00001444int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00001445 int rc = 0;
drhcd92e842011-02-17 15:58:20 +00001446
1447 /* If an expression is an integer literal that fits in a signed 32-bit
1448 ** integer, then the EP_IntValue flag will have already been set */
1449 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1450 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1451
drh92b01d52008-06-24 00:32:35 +00001452 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00001453 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00001454 return 1;
1455 }
drhe4de1fe2002-06-02 16:09:01 +00001456 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00001457 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00001458 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00001459 break;
drh4b59ab52002-08-24 18:24:51 +00001460 }
drhe4de1fe2002-06-02 16:09:01 +00001461 case TK_UMINUS: {
1462 int v;
danielk19774adee202004-05-08 08:23:19 +00001463 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00001464 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00001465 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00001466 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00001467 }
1468 break;
1469 }
1470 default: break;
1471 }
drh92b01d52008-06-24 00:32:35 +00001472 return rc;
drhe4de1fe2002-06-02 16:09:01 +00001473}
1474
1475/*
drh039fc322009-11-17 18:31:47 +00001476** Return FALSE if there is no chance that the expression can be NULL.
1477**
1478** If the expression might be NULL or if the expression is too complex
1479** to tell return TRUE.
1480**
1481** This routine is used as an optimization, to skip OP_IsNull opcodes
1482** when we know that a value cannot be NULL. Hence, a false positive
1483** (returning TRUE when in fact the expression can never be NULL) might
1484** be a small performance hit but is otherwise harmless. On the other
1485** hand, a false negative (returning FALSE when the result could be NULL)
1486** will likely result in an incorrect answer. So when in doubt, return
1487** TRUE.
1488*/
1489int sqlite3ExprCanBeNull(const Expr *p){
1490 u8 op;
drhcd7f4572009-11-19 14:48:40 +00001491 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00001492 op = p->op;
1493 if( op==TK_REGISTER ) op = p->op2;
1494 switch( op ){
1495 case TK_INTEGER:
1496 case TK_STRING:
1497 case TK_FLOAT:
1498 case TK_BLOB:
1499 return 0;
drh7248a8b2014-08-04 18:50:54 +00001500 case TK_COLUMN:
1501 assert( p->pTab!=0 );
drh72673a22014-12-04 16:27:17 +00001502 return ExprHasProperty(p, EP_CanBeNull) ||
1503 (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00001504 default:
1505 return 1;
1506 }
1507}
1508
1509/*
1510** Return TRUE if the given expression is a constant which would be
1511** unchanged by OP_Affinity with the affinity given in the second
1512** argument.
1513**
1514** This routine is used to determine if the OP_Affinity operation
1515** can be omitted. When in doubt return FALSE. A false negative
1516** is harmless. A false positive, however, can result in the wrong
1517** answer.
1518*/
1519int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1520 u8 op;
drh05883a32015-06-02 15:32:08 +00001521 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00001522 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00001523 op = p->op;
1524 if( op==TK_REGISTER ) op = p->op2;
1525 switch( op ){
1526 case TK_INTEGER: {
1527 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1528 }
1529 case TK_FLOAT: {
1530 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1531 }
1532 case TK_STRING: {
1533 return aff==SQLITE_AFF_TEXT;
1534 }
1535 case TK_BLOB: {
1536 return 1;
1537 }
drh2f2855b2009-11-18 01:25:26 +00001538 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00001539 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
1540 return p->iColumn<0
1541 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00001542 }
drh039fc322009-11-17 18:31:47 +00001543 default: {
1544 return 0;
1545 }
1546 }
1547}
1548
1549/*
drhc4a3c772001-04-04 11:48:57 +00001550** Return TRUE if the given string is a row-id column name.
1551*/
danielk19774adee202004-05-08 08:23:19 +00001552int sqlite3IsRowid(const char *z){
1553 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
1554 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
1555 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00001556 return 0;
1557}
1558
danielk19779a96b662007-11-29 17:05:18 +00001559/*
drhb74b1012009-05-28 21:04:37 +00001560** Return true if we are able to the IN operator optimization on a
1561** query of the form
drhb287f4b2008-04-25 00:08:38 +00001562**
drhb74b1012009-05-28 21:04:37 +00001563** x IN (SELECT ...)
drhb287f4b2008-04-25 00:08:38 +00001564**
drhb74b1012009-05-28 21:04:37 +00001565** Where the SELECT... clause is as specified by the parameter to this
1566** routine.
1567**
1568** The Select object passed in has already been preprocessed and no
1569** errors have been found.
drhb287f4b2008-04-25 00:08:38 +00001570*/
1571#ifndef SQLITE_OMIT_SUBQUERY
1572static int isCandidateForInOpt(Select *p){
1573 SrcList *pSrc;
1574 ExprList *pEList;
1575 Table *pTab;
drhb287f4b2008-04-25 00:08:38 +00001576 if( p==0 ) return 0; /* right-hand side of IN is SELECT */
1577 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00001578 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00001579 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1580 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
1581 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00001582 }
drhb74b1012009-05-28 21:04:37 +00001583 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00001584 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb74b1012009-05-28 21:04:37 +00001585 assert( p->pOffset==0 ); /* No LIMIT means no OFFSET */
drhb287f4b2008-04-25 00:08:38 +00001586 if( p->pWhere ) return 0; /* Has no WHERE clause */
1587 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00001588 assert( pSrc!=0 );
1589 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00001590 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00001591 pTab = pSrc->a[0].pTab;
drhb74b1012009-05-28 21:04:37 +00001592 if( NEVER(pTab==0) ) return 0;
1593 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00001594 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
1595 pEList = p->pEList;
1596 if( pEList->nExpr!=1 ) return 0; /* One column in the result set */
1597 if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1598 return 1;
1599}
1600#endif /* SQLITE_OMIT_SUBQUERY */
1601
1602/*
dan1d8cb212011-12-09 13:24:16 +00001603** Code an OP_Once instruction and allocate space for its flag. Return the
1604** address of the new instruction.
1605*/
1606int sqlite3CodeOnce(Parse *pParse){
1607 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
1608 return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
1609}
1610
1611/*
drh4c259e92014-08-01 21:12:35 +00001612** Generate code that checks the left-most column of index table iCur to see if
1613** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00001614** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
1615** to be set to NULL if iCur contains one or more NULL values.
1616*/
1617static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00001618 int addr1;
drh6be515e2014-08-01 21:00:53 +00001619 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00001620 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00001621 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
1622 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00001623 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00001624 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00001625}
1626
drhbb53ecb2014-08-02 21:03:33 +00001627
1628#ifndef SQLITE_OMIT_SUBQUERY
1629/*
1630** The argument is an IN operator with a list (not a subquery) on the
1631** right-hand side. Return TRUE if that list is constant.
1632*/
1633static int sqlite3InRhsIsConstant(Expr *pIn){
1634 Expr *pLHS;
1635 int res;
1636 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1637 pLHS = pIn->pLeft;
1638 pIn->pLeft = 0;
1639 res = sqlite3ExprIsConstant(pIn);
1640 pIn->pLeft = pLHS;
1641 return res;
1642}
1643#endif
1644
drh6be515e2014-08-01 21:00:53 +00001645/*
danielk19779a96b662007-11-29 17:05:18 +00001646** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00001647** The pX parameter is the expression on the RHS of the IN operator, which
1648** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00001649**
drhd4305ca2012-09-18 17:08:33 +00001650** The job of this routine is to find or create a b-tree object that can
1651** be used either to test for membership in the RHS set or to iterate through
1652** all members of the RHS set, skipping duplicates.
1653**
drh3a856252014-08-01 14:46:57 +00001654** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00001655** and pX->iTable is set to the index of that cursor.
1656**
drhb74b1012009-05-28 21:04:37 +00001657** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00001658**
drh1ccce442013-03-12 20:38:51 +00001659** IN_INDEX_ROWID - The cursor was opened on a database table.
1660** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
1661** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
1662** IN_INDEX_EPH - The cursor was opened on a specially created and
1663** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00001664** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
1665** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00001666**
drhd4305ca2012-09-18 17:08:33 +00001667** An existing b-tree might be used if the RHS expression pX is a simple
1668** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00001669**
1670** SELECT <column> FROM <table>
1671**
drhd4305ca2012-09-18 17:08:33 +00001672** If the RHS of the IN operator is a list or a more complex subquery, then
1673** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00001674** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00001675** existing table.
drhd4305ca2012-09-18 17:08:33 +00001676**
drh3a856252014-08-01 14:46:57 +00001677** The inFlags parameter must contain exactly one of the bits
1678** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP. If inFlags contains
1679** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
1680** fast membership test. When the IN_INDEX_LOOP bit is set, the
1681** IN index will be used to loop over all values of the RHS of the
1682** IN operator.
1683**
1684** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
1685** through the set members) then the b-tree must not contain duplicates.
1686** An epheremal table must be used unless the selected <column> is guaranteed
danielk19779a96b662007-11-29 17:05:18 +00001687** to be unique - either because it is an INTEGER PRIMARY KEY or it
drhb74b1012009-05-28 21:04:37 +00001688** has a UNIQUE constraint or UNIQUE index.
danielk19770cdc0222008-06-26 18:04:03 +00001689**
drh3a856252014-08-01 14:46:57 +00001690** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
1691** for fast set membership tests) then an epheremal table must
danielk19770cdc0222008-06-26 18:04:03 +00001692** be used unless <column> is an INTEGER PRIMARY KEY or an index can
1693** be found with <column> as its left-most column.
1694**
drhbb53ecb2014-08-02 21:03:33 +00001695** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
1696** if the RHS of the IN operator is a list (not a subquery) then this
1697** routine might decide that creating an ephemeral b-tree for membership
1698** testing is too expensive and return IN_INDEX_NOOP. In that case, the
1699** calling routine should implement the IN operator using a sequence
1700** of Eq or Ne comparison operations.
1701**
drhb74b1012009-05-28 21:04:37 +00001702** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00001703** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00001704** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00001705** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00001706** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00001707** to *prRhsHasNull. If there is no chance that the (...) contains a
1708** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00001709**
drhe21a6e12014-08-01 18:00:24 +00001710** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00001711** the value in that register will be NULL if the b-tree contains one or more
1712** NULL values, and it will be some non-NULL value if the b-tree contains no
1713** NULL values.
danielk19779a96b662007-11-29 17:05:18 +00001714*/
danielk1977284f4ac2007-12-10 05:03:46 +00001715#ifndef SQLITE_OMIT_SUBQUERY
drhe21a6e12014-08-01 18:00:24 +00001716int sqlite3FindInIndex(Parse *pParse, Expr *pX, u32 inFlags, int *prRhsHasNull){
drhb74b1012009-05-28 21:04:37 +00001717 Select *p; /* SELECT to the right of IN operator */
1718 int eType = 0; /* Type of RHS table. IN_INDEX_* */
1719 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00001720 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00001721 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00001722
drh1450bc62009-10-30 13:25:56 +00001723 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00001724 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00001725
drhb74b1012009-05-28 21:04:37 +00001726 /* Check to see if an existing table or index can be used to
1727 ** satisfy the query. This is preferable to generating a new
1728 ** ephemeral table.
danielk19779a96b662007-11-29 17:05:18 +00001729 */
danielk19776ab3a2e2009-02-19 14:39:25 +00001730 p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
drh311efc72015-04-15 04:20:58 +00001731 if( pParse->nErr==0 && isCandidateForInOpt(p) ){
danielk1977e1fb65a2009-04-02 17:23:32 +00001732 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00001733 Table *pTab; /* Table <table>. */
1734 Expr *pExpr; /* Expression <column> */
drhbbbdc832013-10-22 18:01:40 +00001735 i16 iCol; /* Index of column <column> */
1736 i16 iDb; /* Database idx for pTab */
drhb07028f2011-10-14 21:49:18 +00001737
1738 assert( p ); /* Because of isCandidateForInOpt(p) */
1739 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
1740 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1741 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
1742 pTab = p->pSrc->a[0].pTab;
1743 pExpr = p->pEList->a[0].pExpr;
drhbbbdc832013-10-22 18:01:40 +00001744 iCol = (i16)pExpr->iColumn;
danielk1977e1fb65a2009-04-02 17:23:32 +00001745
drhb22f7c82014-02-06 23:56:27 +00001746 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00001747 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1748 sqlite3CodeVerifySchema(pParse, iDb);
1749 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00001750
1751 /* This function is only called from two places. In both cases the vdbe
1752 ** has already been allocated. So assume sqlite3GetVdbe() is always
1753 ** successful here.
1754 */
1755 assert(v);
1756 if( iCol<0 ){
drh7d176102014-02-18 03:07:12 +00001757 int iAddr = sqlite3CodeOnce(pParse);
1758 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00001759
1760 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
1761 eType = IN_INDEX_ROWID;
1762
1763 sqlite3VdbeJumpHere(v, iAddr);
1764 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00001765 Index *pIdx; /* Iterator variable */
1766
drhb74b1012009-05-28 21:04:37 +00001767 /* The collation sequence used by the comparison. If an index is to
danielk19779a96b662007-11-29 17:05:18 +00001768 ** be used in place of a temp-table, it must be ordered according
danielk1977e1fb65a2009-04-02 17:23:32 +00001769 ** to this collation sequence. */
danielk19779a96b662007-11-29 17:05:18 +00001770 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
1771
1772 /* Check that the affinity that will be used to perform the
1773 ** comparison is the same as the affinity of the column. If
1774 ** it is not, it is not possible to use any index.
1775 */
drhdbaee5e2012-09-18 19:29:06 +00001776 int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
danielk19779a96b662007-11-29 17:05:18 +00001777
1778 for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
1779 if( (pIdx->aiColumn[0]==iCol)
drhb74b1012009-05-28 21:04:37 +00001780 && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
drh5f1d1d92014-07-31 22:59:04 +00001781 && (!mustBeUnique || (pIdx->nKeyCol==1 && IsUniqueIndex(pIdx)))
danielk19779a96b662007-11-29 17:05:18 +00001782 ){
drh7d176102014-02-18 03:07:12 +00001783 int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
drh2ec2fb22013-11-06 19:59:23 +00001784 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
1785 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danielk1977207872a2008-01-03 07:54:23 +00001786 VdbeComment((v, "%s", pIdx->zName));
drh1ccce442013-03-12 20:38:51 +00001787 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
1788 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
danielk19779a96b662007-11-29 17:05:18 +00001789
drhe21a6e12014-08-01 18:00:24 +00001790 if( prRhsHasNull && !pTab->aCol[iCol].notNull ){
1791 *prRhsHasNull = ++pParse->nMem;
drh6be515e2014-08-01 21:00:53 +00001792 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
danielk19770cdc0222008-06-26 18:04:03 +00001793 }
drh552fd452014-02-18 01:07:38 +00001794 sqlite3VdbeJumpHere(v, iAddr);
danielk19779a96b662007-11-29 17:05:18 +00001795 }
1796 }
1797 }
1798 }
1799
drhbb53ecb2014-08-02 21:03:33 +00001800 /* If no preexisting index is available for the IN clause
1801 ** and IN_INDEX_NOOP is an allowed reply
1802 ** and the RHS of the IN operator is a list, not a subquery
1803 ** and the RHS is not contant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00001804 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00001805 ** the IN operator so return IN_INDEX_NOOP.
1806 */
1807 if( eType==0
1808 && (inFlags & IN_INDEX_NOOP_OK)
1809 && !ExprHasProperty(pX, EP_xIsSelect)
1810 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
1811 ){
1812 eType = IN_INDEX_NOOP;
1813 }
1814
1815
danielk19779a96b662007-11-29 17:05:18 +00001816 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00001817 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00001818 ** We will have to generate an ephemeral table to do the job.
1819 */
drh8e23daf2013-06-11 13:30:04 +00001820 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00001821 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00001822 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00001823 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00001824 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00001825 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00001826 eType = IN_INDEX_ROWID;
1827 }
drhe21a6e12014-08-01 18:00:24 +00001828 }else if( prRhsHasNull ){
1829 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00001830 }
danielk197741a05b72008-10-02 13:50:55 +00001831 sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
drhcf4d38a2010-07-28 02:53:36 +00001832 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00001833 }else{
1834 pX->iTable = iTab;
1835 }
1836 return eType;
1837}
danielk1977284f4ac2007-12-10 05:03:46 +00001838#endif
drh626a8792005-01-17 22:08:19 +00001839
1840/*
drhd4187c72010-08-30 22:15:45 +00001841** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1842** or IN operators. Examples:
drh626a8792005-01-17 22:08:19 +00001843**
drh9cbe6352005-11-29 03:13:21 +00001844** (SELECT a FROM b) -- subquery
1845** EXISTS (SELECT a FROM b) -- EXISTS subquery
1846** x IN (4,5,11) -- IN operator with list on right-hand side
1847** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00001848**
drh9cbe6352005-11-29 03:13:21 +00001849** The pExpr parameter describes the expression that contains the IN
1850** operator or subquery.
danielk197741a05b72008-10-02 13:50:55 +00001851**
1852** If parameter isRowid is non-zero, then expression pExpr is guaranteed
1853** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
1854** to some integer key column of a table B-Tree. In this case, use an
1855** intkey B-Tree to store the set of IN(...) values instead of the usual
1856** (slower) variable length keys B-Tree.
drhfd773cf2009-05-29 14:39:07 +00001857**
1858** If rMayHaveNull is non-zero, that means that the operation is an IN
1859** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
drh3a856252014-08-01 14:46:57 +00001860** All this routine does is initialize the register given by rMayHaveNull
1861** to NULL. Calling routines will take care of changing this register
1862** value to non-NULL if the RHS is NULL-free.
drh1450bc62009-10-30 13:25:56 +00001863**
1864** For a SELECT or EXISTS operator, return the register that holds the
1865** result. For IN operators or if an error occurs, the return value is 0.
drhcce7d172000-05-31 15:34:51 +00001866*/
drh51522cd2005-01-20 13:36:19 +00001867#ifndef SQLITE_OMIT_SUBQUERY
drh1450bc62009-10-30 13:25:56 +00001868int sqlite3CodeSubselect(
drhfd773cf2009-05-29 14:39:07 +00001869 Parse *pParse, /* Parsing context */
1870 Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
drh6be515e2014-08-01 21:00:53 +00001871 int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
drhfd773cf2009-05-29 14:39:07 +00001872 int isRowid /* If true, LHS of IN operator is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00001873){
drh6be515e2014-08-01 21:00:53 +00001874 int jmpIfDynamic = -1; /* One-time test address */
drh1450bc62009-10-30 13:25:56 +00001875 int rReg = 0; /* Register storing resulting */
danielk1977b3bce662005-01-29 08:32:43 +00001876 Vdbe *v = sqlite3GetVdbe(pParse);
drh1450bc62009-10-30 13:25:56 +00001877 if( NEVER(v==0) ) return 0;
drhceea3322009-04-23 13:22:42 +00001878 sqlite3ExprCachePush(pParse);
danielk1977fc976062007-05-10 10:46:56 +00001879
drh57dbd7b2005-07-08 18:25:26 +00001880 /* This code must be run in its entirety every time it is encountered
1881 ** if any of the following is true:
1882 **
1883 ** * The right-hand side is a correlated subquery
1884 ** * The right-hand side is an expression list containing variables
1885 ** * We are inside a trigger
1886 **
1887 ** If all of the above are false, then we can run this code just once
1888 ** save the results, and reuse the same result on subsequent invocations.
danielk1977b3bce662005-01-29 08:32:43 +00001889 */
drhc5cd1242013-09-12 16:50:49 +00001890 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh6be515e2014-08-01 21:00:53 +00001891 jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00001892 }
1893
dan4a07e3d2010-11-09 14:48:59 +00001894#ifndef SQLITE_OMIT_EXPLAIN
1895 if( pParse->explain==2 ){
drh62aaa6c2015-11-21 17:27:42 +00001896 char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
1897 jmpIfDynamic>=0?"":"CORRELATED ",
1898 pExpr->op==TK_IN?"LIST":"SCALAR",
1899 pParse->iNextSelectId
dan4a07e3d2010-11-09 14:48:59 +00001900 );
1901 sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
1902 }
1903#endif
1904
drhcce7d172000-05-31 15:34:51 +00001905 switch( pExpr->op ){
drhfef52082000-06-06 01:50:43 +00001906 case TK_IN: {
drhd4187c72010-08-30 22:15:45 +00001907 char affinity; /* Affinity of the LHS of the IN */
drhd4187c72010-08-30 22:15:45 +00001908 int addr; /* Address of OP_OpenEphemeral instruction */
1909 Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
drh323df792013-08-05 19:11:29 +00001910 KeyInfo *pKeyInfo = 0; /* Key information */
drhd3d39e92004-05-20 22:16:29 +00001911
danielk197741a05b72008-10-02 13:50:55 +00001912 affinity = sqlite3ExprAffinity(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00001913
1914 /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
drh8cff69d2009-11-12 19:59:44 +00001915 ** expression it is handled the same way. An ephemeral table is
danielk1977e014a832004-05-17 10:48:57 +00001916 ** filled with single-field index keys representing the results
1917 ** from the SELECT or the <exprlist>.
1918 **
1919 ** If the 'x' expression is a column value, or the SELECT...
1920 ** statement returns a column value, then the affinity of that
1921 ** column is used to build the index keys. If both 'x' and the
1922 ** SELECT... statement are columns, then numeric affinity is used
1923 ** if either column has NUMERIC or INTEGER affinity. If neither
1924 ** 'x' nor the SELECT... statement are columns, then numeric affinity
1925 ** is used.
1926 */
1927 pExpr->iTable = pParse->nTab++;
danielk197741a05b72008-10-02 13:50:55 +00001928 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
drhad124322013-10-23 13:30:58 +00001929 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1, 1);
danielk1977e014a832004-05-17 10:48:57 +00001930
danielk19776ab3a2e2009-02-19 14:39:25 +00001931 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhfef52082000-06-06 01:50:43 +00001932 /* Case 1: expr IN (SELECT ...)
1933 **
danielk1977e014a832004-05-17 10:48:57 +00001934 ** Generate code to write the results of the select into the temporary
1935 ** table allocated and opened above.
drhfef52082000-06-06 01:50:43 +00001936 */
drh43870062014-07-31 15:44:44 +00001937 Select *pSelect = pExpr->x.pSelect;
drh1013c932008-01-06 00:25:21 +00001938 SelectDest dest;
drhbe5c89a2004-07-26 00:31:09 +00001939 ExprList *pEList;
drh1013c932008-01-06 00:25:21 +00001940
danielk197741a05b72008-10-02 13:50:55 +00001941 assert( !isRowid );
drh1013c932008-01-06 00:25:21 +00001942 sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
drh2b596da2012-07-23 21:43:19 +00001943 dest.affSdst = (u8)affinity;
danielk1977e014a832004-05-17 10:48:57 +00001944 assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
drh43870062014-07-31 15:44:44 +00001945 pSelect->iLimit = 0;
1946 testcase( pSelect->selFlags & SF_Distinct );
drh812ea832013-08-06 17:24:23 +00001947 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh43870062014-07-31 15:44:44 +00001948 if( sqlite3Select(pParse, pSelect, &dest) ){
drh2ec2fb22013-11-06 19:59:23 +00001949 sqlite3KeyInfoUnref(pKeyInfo);
drh1450bc62009-10-30 13:25:56 +00001950 return 0;
drh94ccde52007-04-13 16:06:32 +00001951 }
drh43870062014-07-31 15:44:44 +00001952 pEList = pSelect->pEList;
drh812ea832013-08-06 17:24:23 +00001953 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
drh3535ec32013-08-06 16:56:44 +00001954 assert( pEList!=0 );
1955 assert( pEList->nExpr>0 );
drh2ec2fb22013-11-06 19:59:23 +00001956 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh3535ec32013-08-06 16:56:44 +00001957 pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1958 pEList->a[0].pExpr);
drha7d2db12010-07-14 20:23:52 +00001959 }else if( ALWAYS(pExpr->x.pList!=0) ){
drhfef52082000-06-06 01:50:43 +00001960 /* Case 2: expr IN (exprlist)
1961 **
drhfd131da2007-08-07 17:13:03 +00001962 ** For each expression, build an index key from the evaluation and
danielk1977e014a832004-05-17 10:48:57 +00001963 ** store it in the temporary table. If <expr> is a column, then use
1964 ** that columns affinity when building index keys. If <expr> is not
1965 ** a column, use numeric affinity.
drhfef52082000-06-06 01:50:43 +00001966 */
danielk1977e014a832004-05-17 10:48:57 +00001967 int i;
danielk19776ab3a2e2009-02-19 14:39:25 +00001968 ExprList *pList = pExpr->x.pList;
drh57dbd7b2005-07-08 18:25:26 +00001969 struct ExprList_item *pItem;
drhecc31802008-06-26 20:06:06 +00001970 int r1, r2, r3;
drh57dbd7b2005-07-08 18:25:26 +00001971
danielk1977e014a832004-05-17 10:48:57 +00001972 if( !affinity ){
drh05883a32015-06-02 15:32:08 +00001973 affinity = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +00001974 }
drh323df792013-08-05 19:11:29 +00001975 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00001976 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh323df792013-08-05 19:11:29 +00001977 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1978 }
danielk1977e014a832004-05-17 10:48:57 +00001979
1980 /* Loop through each expression in <exprlist>. */
drh2d401ab2008-01-10 23:50:11 +00001981 r1 = sqlite3GetTempReg(pParse);
1982 r2 = sqlite3GetTempReg(pParse);
drh37e08082014-07-31 20:16:08 +00001983 if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
drh57dbd7b2005-07-08 18:25:26 +00001984 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
1985 Expr *pE2 = pItem->pExpr;
drhe05c9292009-10-29 13:48:10 +00001986 int iValToIns;
danielk1977e014a832004-05-17 10:48:57 +00001987
drh57dbd7b2005-07-08 18:25:26 +00001988 /* If the expression is not constant then we will need to
1989 ** disable the test that was generated above that makes sure
1990 ** this code only executes once. Because for a non-constant
1991 ** expression we need to rerun this code each time.
1992 */
drh6be515e2014-08-01 21:00:53 +00001993 if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
1994 sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
1995 jmpIfDynamic = -1;
drh4794b982000-06-06 13:54:14 +00001996 }
danielk1977e014a832004-05-17 10:48:57 +00001997
1998 /* Evaluate the expression and insert it into the temp table */
drhe05c9292009-10-29 13:48:10 +00001999 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2000 sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
danielk197741a05b72008-10-02 13:50:55 +00002001 }else{
drhe05c9292009-10-29 13:48:10 +00002002 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2003 if( isRowid ){
2004 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2005 sqlite3VdbeCurrentAddr(v)+2);
drh688852a2014-02-17 22:40:43 +00002006 VdbeCoverage(v);
drhe05c9292009-10-29 13:48:10 +00002007 sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
2008 }else{
2009 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2010 sqlite3ExprCacheAffinityChange(pParse, r3, 1);
2011 sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2012 }
danielk197741a05b72008-10-02 13:50:55 +00002013 }
drhfef52082000-06-06 01:50:43 +00002014 }
drh2d401ab2008-01-10 23:50:11 +00002015 sqlite3ReleaseTempReg(pParse, r1);
2016 sqlite3ReleaseTempReg(pParse, r2);
drhfef52082000-06-06 01:50:43 +00002017 }
drh323df792013-08-05 19:11:29 +00002018 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002019 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
danielk197741a05b72008-10-02 13:50:55 +00002020 }
danielk1977b3bce662005-01-29 08:32:43 +00002021 break;
drhfef52082000-06-06 01:50:43 +00002022 }
2023
drh51522cd2005-01-20 13:36:19 +00002024 case TK_EXISTS:
drhfd773cf2009-05-29 14:39:07 +00002025 case TK_SELECT:
2026 default: {
drhfd773cf2009-05-29 14:39:07 +00002027 /* If this has to be a scalar SELECT. Generate code to put the
drhfef52082000-06-06 01:50:43 +00002028 ** value of this select in a memory cell and record the number
drhfd773cf2009-05-29 14:39:07 +00002029 ** of the memory cell in iColumn. If this is an EXISTS, write
2030 ** an integer 0 (not exists) or 1 (exists) into a memory cell
2031 ** and record that memory cell in iColumn.
drhfef52082000-06-06 01:50:43 +00002032 */
drhfd773cf2009-05-29 14:39:07 +00002033 Select *pSel; /* SELECT statement to encode */
2034 SelectDest dest; /* How to deal with SELECt result */
drh1398ad32005-01-19 23:24:50 +00002035
shanecf697392009-06-01 16:53:09 +00002036 testcase( pExpr->op==TK_EXISTS );
2037 testcase( pExpr->op==TK_SELECT );
2038 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2039
danielk19776ab3a2e2009-02-19 14:39:25 +00002040 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2041 pSel = pExpr->x.pSelect;
drh1013c932008-01-06 00:25:21 +00002042 sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
drh51522cd2005-01-20 13:36:19 +00002043 if( pExpr->op==TK_SELECT ){
danielk19776c8c8ce2008-01-02 16:27:09 +00002044 dest.eDest = SRT_Mem;
drh53932ce2014-08-29 12:29:39 +00002045 dest.iSdst = dest.iSDParm;
drh2b596da2012-07-23 21:43:19 +00002046 sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002047 VdbeComment((v, "Init subquery result"));
drh51522cd2005-01-20 13:36:19 +00002048 }else{
danielk19776c8c8ce2008-01-02 16:27:09 +00002049 dest.eDest = SRT_Exists;
drh2b596da2012-07-23 21:43:19 +00002050 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002051 VdbeComment((v, "Init EXISTS result"));
drh51522cd2005-01-20 13:36:19 +00002052 }
drh633e6d52008-07-28 19:34:53 +00002053 sqlite3ExprDelete(pParse->db, pSel->pLimit);
drh094430e2010-07-14 18:24:06 +00002054 pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2055 &sqlite3IntTokens[1]);
drh48b5b042010-12-06 18:50:32 +00002056 pSel->iLimit = 0;
drh772460f2015-04-16 14:13:12 +00002057 pSel->selFlags &= ~SF_MultiValue;
drh7d10d5a2008-08-20 16:35:10 +00002058 if( sqlite3Select(pParse, pSel, &dest) ){
drh1450bc62009-10-30 13:25:56 +00002059 return 0;
drh94ccde52007-04-13 16:06:32 +00002060 }
drh2b596da2012-07-23 21:43:19 +00002061 rReg = dest.iSDParm;
drhebb6a652013-09-12 23:42:22 +00002062 ExprSetVVAProperty(pExpr, EP_NoReduce);
danielk1977b3bce662005-01-29 08:32:43 +00002063 break;
drhcce7d172000-05-31 15:34:51 +00002064 }
2065 }
danielk1977b3bce662005-01-29 08:32:43 +00002066
drh6be515e2014-08-01 21:00:53 +00002067 if( rHasNullFlag ){
2068 sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
danielk1977b3bce662005-01-29 08:32:43 +00002069 }
drh6be515e2014-08-01 21:00:53 +00002070
2071 if( jmpIfDynamic>=0 ){
2072 sqlite3VdbeJumpHere(v, jmpIfDynamic);
danielk1977b3bce662005-01-29 08:32:43 +00002073 }
drhd2490902014-04-13 19:28:15 +00002074 sqlite3ExprCachePop(pParse);
danielk1977fc976062007-05-10 10:46:56 +00002075
drh1450bc62009-10-30 13:25:56 +00002076 return rReg;
drhcce7d172000-05-31 15:34:51 +00002077}
drh51522cd2005-01-20 13:36:19 +00002078#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002079
drhe3365e62009-11-12 17:52:24 +00002080#ifndef SQLITE_OMIT_SUBQUERY
2081/*
2082** Generate code for an IN expression.
2083**
2084** x IN (SELECT ...)
2085** x IN (value, value, ...)
2086**
2087** The left-hand side (LHS) is a scalar expression. The right-hand side (RHS)
2088** is an array of zero or more values. The expression is true if the LHS is
2089** contained within the RHS. The value of the expression is unknown (NULL)
2090** if the LHS is NULL or if the LHS is not contained within the RHS and the
2091** RHS contains one or more NULL values.
2092**
drh6be515e2014-08-01 21:00:53 +00002093** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002094** contained within the RHS. If due to NULLs we cannot determine if the LHS
2095** is contained in the RHS then jump to destIfNull. If the LHS is contained
2096** within the RHS then fall through.
2097*/
2098static void sqlite3ExprCodeIN(
2099 Parse *pParse, /* Parsing and code generating context */
2100 Expr *pExpr, /* The IN expression */
2101 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2102 int destIfNull /* Jump here if the results are unknown due to NULLs */
2103){
2104 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
2105 char affinity; /* Comparison affinity to use */
2106 int eType; /* Type of the RHS */
2107 int r1; /* Temporary use register */
2108 Vdbe *v; /* Statement under construction */
2109
2110 /* Compute the RHS. After this step, the table with cursor
2111 ** pExpr->iTable will contains the values that make up the RHS.
2112 */
2113 v = pParse->pVdbe;
2114 assert( v!=0 ); /* OOM detected prior to this routine */
2115 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00002116 eType = sqlite3FindInIndex(pParse, pExpr,
2117 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh3a856252014-08-01 14:46:57 +00002118 destIfFalse==destIfNull ? 0 : &rRhsHasNull);
drhe3365e62009-11-12 17:52:24 +00002119
2120 /* Figure out the affinity to use to create a key from the results
2121 ** of the expression. affinityStr stores a static string suitable for
2122 ** P4 of OP_MakeRecord.
2123 */
2124 affinity = comparisonAffinity(pExpr);
2125
2126 /* Code the LHS, the <expr> from "<expr> IN (...)".
2127 */
2128 sqlite3ExprCachePush(pParse);
2129 r1 = sqlite3GetTempReg(pParse);
2130 sqlite3ExprCode(pParse, pExpr->pLeft, r1);
drhe3365e62009-11-12 17:52:24 +00002131
drhbb53ecb2014-08-02 21:03:33 +00002132 /* If sqlite3FindInIndex() did not find or create an index that is
2133 ** suitable for evaluating the IN operator, then evaluate using a
2134 ** sequence of comparisons.
drh094430e2010-07-14 18:24:06 +00002135 */
drhbb53ecb2014-08-02 21:03:33 +00002136 if( eType==IN_INDEX_NOOP ){
2137 ExprList *pList = pExpr->x.pList;
2138 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2139 int labelOk = sqlite3VdbeMakeLabel(v);
2140 int r2, regToFree;
2141 int regCkNull = 0;
2142 int ii;
2143 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00002144 if( destIfNull!=destIfFalse ){
2145 regCkNull = sqlite3GetTempReg(pParse);
drha9769792014-08-04 16:39:39 +00002146 sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00002147 }
2148 for(ii=0; ii<pList->nExpr; ii++){
2149 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00002150 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00002151 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2152 }
2153 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2154 sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00002155 (void*)pColl, P4_COLLSEQ);
2156 VdbeCoverageIf(v, ii<pList->nExpr-1);
2157 VdbeCoverageIf(v, ii==pList->nExpr-1);
drhbb53ecb2014-08-02 21:03:33 +00002158 sqlite3VdbeChangeP5(v, affinity);
2159 }else{
2160 assert( destIfNull==destIfFalse );
2161 sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2162 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2163 sqlite3VdbeChangeP5(v, affinity | SQLITE_JUMPIFNULL);
2164 }
2165 sqlite3ReleaseTempReg(pParse, regToFree);
2166 }
2167 if( regCkNull ){
2168 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002169 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00002170 }
2171 sqlite3VdbeResolveLabel(v, labelOk);
2172 sqlite3ReleaseTempReg(pParse, regCkNull);
drh094430e2010-07-14 18:24:06 +00002173 }else{
drhbb53ecb2014-08-02 21:03:33 +00002174
2175 /* If the LHS is NULL, then the result is either false or NULL depending
2176 ** on whether the RHS is empty or not, respectively.
drhe3365e62009-11-12 17:52:24 +00002177 */
drh7248a8b2014-08-04 18:50:54 +00002178 if( sqlite3ExprCanBeNull(pExpr->pLeft) ){
2179 if( destIfNull==destIfFalse ){
2180 /* Shortcut for the common case where the false and NULL outcomes are
2181 ** the same. */
2182 sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull); VdbeCoverage(v);
2183 }else{
2184 int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2185 sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2186 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002187 sqlite3VdbeGoto(v, destIfNull);
drh7248a8b2014-08-04 18:50:54 +00002188 sqlite3VdbeJumpHere(v, addr1);
2189 }
drhbb53ecb2014-08-02 21:03:33 +00002190 }
2191
2192 if( eType==IN_INDEX_ROWID ){
2193 /* In this case, the RHS is the ROWID of table b-tree
drhe3365e62009-11-12 17:52:24 +00002194 */
drhbb53ecb2014-08-02 21:03:33 +00002195 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse); VdbeCoverage(v);
2196 sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
drh688852a2014-02-17 22:40:43 +00002197 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00002198 }else{
drhbb53ecb2014-08-02 21:03:33 +00002199 /* In this case, the RHS is an index b-tree.
drhe3365e62009-11-12 17:52:24 +00002200 */
drhbb53ecb2014-08-02 21:03:33 +00002201 sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
2202
2203 /* If the set membership test fails, then the result of the
2204 ** "x IN (...)" expression must be either 0 or NULL. If the set
2205 ** contains no NULL values, then the result is 0. If the set
2206 ** contains one or more NULL values, then the result of the
2207 ** expression is also NULL.
drhe3365e62009-11-12 17:52:24 +00002208 */
drhbb53ecb2014-08-02 21:03:33 +00002209 assert( destIfFalse!=destIfNull || rRhsHasNull==0 );
2210 if( rRhsHasNull==0 ){
2211 /* This branch runs if it is known at compile time that the RHS
2212 ** cannot contain NULL values. This happens as the result
2213 ** of a "NOT NULL" constraint in the database schema.
2214 **
2215 ** Also run this branch if NULL is equivalent to FALSE
2216 ** for this particular IN operator.
2217 */
2218 sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
2219 VdbeCoverage(v);
2220 }else{
2221 /* In this branch, the RHS of the IN might contain a NULL and
2222 ** the presence of a NULL on the RHS makes a difference in the
2223 ** outcome.
2224 */
drh728e0f92015-10-10 14:41:28 +00002225 int addr1;
drhbb53ecb2014-08-02 21:03:33 +00002226
2227 /* First check to see if the LHS is contained in the RHS. If so,
2228 ** then the answer is TRUE the presence of NULLs in the RHS does
2229 ** not matter. If the LHS is not contained in the RHS, then the
2230 ** answer is NULL if the RHS contains NULLs and the answer is
2231 ** FALSE if the RHS is NULL-free.
2232 */
drh728e0f92015-10-10 14:41:28 +00002233 addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
drhbb53ecb2014-08-02 21:03:33 +00002234 VdbeCoverage(v);
2235 sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2236 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002237 sqlite3VdbeGoto(v, destIfFalse);
drh728e0f92015-10-10 14:41:28 +00002238 sqlite3VdbeJumpHere(v, addr1);
drhbb53ecb2014-08-02 21:03:33 +00002239 }
drhe3365e62009-11-12 17:52:24 +00002240 }
drhe3365e62009-11-12 17:52:24 +00002241 }
2242 sqlite3ReleaseTempReg(pParse, r1);
drhd2490902014-04-13 19:28:15 +00002243 sqlite3ExprCachePop(pParse);
drhe3365e62009-11-12 17:52:24 +00002244 VdbeComment((v, "end IN expr"));
2245}
2246#endif /* SQLITE_OMIT_SUBQUERY */
2247
drh13573c72010-01-12 17:04:07 +00002248#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00002249/*
2250** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00002251** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00002252**
2253** The z[] string will probably not be zero-terminated. But the
2254** z[n] character is guaranteed to be something that does not look
2255** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00002256*/
drhb7916a72009-05-27 10:31:29 +00002257static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00002258 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00002259 double value;
drh9339da12010-09-30 00:50:49 +00002260 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00002261 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2262 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00002263 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00002264 }
2265}
drh13573c72010-01-12 17:04:07 +00002266#endif
drh598f1342007-10-23 15:39:45 +00002267
2268
2269/*
drhfec19aa2004-05-19 20:41:03 +00002270** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00002271** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00002272**
shaneh5f1d6b62010-09-30 16:51:25 +00002273** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00002274*/
drh13573c72010-01-12 17:04:07 +00002275static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
2276 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00002277 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002278 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00002279 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00002280 if( negFlag ) i = -i;
2281 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00002282 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00002283 int c;
2284 i64 value;
drhfd773cf2009-05-29 14:39:07 +00002285 const char *z = pExpr->u.zToken;
2286 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00002287 c = sqlite3DecOrHexToI64(z, &value);
shaneh5f1d6b62010-09-30 16:51:25 +00002288 if( c==0 || (c==2 && negFlag) ){
drh158b9cb2011-03-05 20:59:46 +00002289 if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
drh97bae792015-06-05 15:59:57 +00002290 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00002291 }else{
drh13573c72010-01-12 17:04:07 +00002292#ifdef SQLITE_OMIT_FLOATING_POINT
2293 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
2294#else
drh1b7ddc52014-07-23 14:52:05 +00002295#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00002296 if( sqlite3_strnicmp(z,"0x",2)==0 ){
2297 sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
drh1b7ddc52014-07-23 14:52:05 +00002298 }else
2299#endif
2300 {
drh9296c182014-07-23 13:40:49 +00002301 codeReal(v, z, negFlag, iMem);
2302 }
drh13573c72010-01-12 17:04:07 +00002303#endif
danielk1977c9cf9012007-05-30 10:36:47 +00002304 }
drhfec19aa2004-05-19 20:41:03 +00002305 }
2306}
2307
drhceea3322009-04-23 13:22:42 +00002308/*
2309** Clear a cache entry.
2310*/
2311static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2312 if( p->tempReg ){
2313 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2314 pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2315 }
2316 p->tempReg = 0;
2317 }
2318}
2319
2320
2321/*
2322** Record in the column cache that a particular column from a
2323** particular table is stored in a particular register.
2324*/
2325void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2326 int i;
2327 int minLru;
2328 int idxLru;
2329 struct yColCache *p;
2330
dance8f53d2015-01-21 17:00:57 +00002331 /* Unless an error has occurred, register numbers are always positive. */
2332 assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00002333 assert( iCol>=-1 && iCol<32768 ); /* Finite column numbers */
2334
drhb6da74e2009-12-24 16:00:28 +00002335 /* The SQLITE_ColumnCache flag disables the column cache. This is used
2336 ** for testing only - to verify that SQLite always gets the same answer
2337 ** with and without the column cache.
2338 */
drh7e5418e2012-09-27 15:05:54 +00002339 if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
drhb6da74e2009-12-24 16:00:28 +00002340
drh27ee4062009-12-30 01:13:11 +00002341 /* First replace any existing entry.
2342 **
2343 ** Actually, the way the column cache is currently used, we are guaranteed
2344 ** that the object will never already be in cache. Verify this guarantee.
2345 */
2346#ifndef NDEBUG
drhceea3322009-04-23 13:22:42 +00002347 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drh27ee4062009-12-30 01:13:11 +00002348 assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
drhceea3322009-04-23 13:22:42 +00002349 }
drh27ee4062009-12-30 01:13:11 +00002350#endif
drhceea3322009-04-23 13:22:42 +00002351
2352 /* Find an empty slot and replace it */
2353 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2354 if( p->iReg==0 ){
2355 p->iLevel = pParse->iCacheLevel;
2356 p->iTable = iTab;
2357 p->iColumn = iCol;
2358 p->iReg = iReg;
drhceea3322009-04-23 13:22:42 +00002359 p->tempReg = 0;
2360 p->lru = pParse->iCacheCnt++;
2361 return;
2362 }
2363 }
2364
2365 /* Replace the last recently used */
2366 minLru = 0x7fffffff;
2367 idxLru = -1;
2368 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2369 if( p->lru<minLru ){
2370 idxLru = i;
2371 minLru = p->lru;
2372 }
2373 }
drh20411ea2009-05-29 19:00:12 +00002374 if( ALWAYS(idxLru>=0) ){
drhceea3322009-04-23 13:22:42 +00002375 p = &pParse->aColCache[idxLru];
2376 p->iLevel = pParse->iCacheLevel;
2377 p->iTable = iTab;
2378 p->iColumn = iCol;
2379 p->iReg = iReg;
drhceea3322009-04-23 13:22:42 +00002380 p->tempReg = 0;
2381 p->lru = pParse->iCacheCnt++;
2382 return;
2383 }
2384}
2385
2386/*
drhf49f3522009-12-30 14:12:38 +00002387** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2388** Purge the range of registers from the column cache.
drhceea3322009-04-23 13:22:42 +00002389*/
drhf49f3522009-12-30 14:12:38 +00002390void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
drhceea3322009-04-23 13:22:42 +00002391 int i;
drhf49f3522009-12-30 14:12:38 +00002392 int iLast = iReg + nReg - 1;
drhceea3322009-04-23 13:22:42 +00002393 struct yColCache *p;
2394 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drhf49f3522009-12-30 14:12:38 +00002395 int r = p->iReg;
2396 if( r>=iReg && r<=iLast ){
drhceea3322009-04-23 13:22:42 +00002397 cacheEntryClear(pParse, p);
2398 p->iReg = 0;
2399 }
2400 }
2401}
2402
2403/*
2404** Remember the current column cache context. Any new entries added
2405** added to the column cache after this call are removed when the
2406** corresponding pop occurs.
2407*/
2408void sqlite3ExprCachePush(Parse *pParse){
2409 pParse->iCacheLevel++;
drh9ac79622013-12-18 15:11:47 +00002410#ifdef SQLITE_DEBUG
2411 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2412 printf("PUSH to %d\n", pParse->iCacheLevel);
2413 }
2414#endif
drhceea3322009-04-23 13:22:42 +00002415}
2416
2417/*
2418** Remove from the column cache any entries that were added since the
drhd2490902014-04-13 19:28:15 +00002419** the previous sqlite3ExprCachePush operation. In other words, restore
2420** the cache to the state it was in prior the most recent Push.
drhceea3322009-04-23 13:22:42 +00002421*/
drhd2490902014-04-13 19:28:15 +00002422void sqlite3ExprCachePop(Parse *pParse){
drhceea3322009-04-23 13:22:42 +00002423 int i;
2424 struct yColCache *p;
drhd2490902014-04-13 19:28:15 +00002425 assert( pParse->iCacheLevel>=1 );
2426 pParse->iCacheLevel--;
drh9ac79622013-12-18 15:11:47 +00002427#ifdef SQLITE_DEBUG
2428 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2429 printf("POP to %d\n", pParse->iCacheLevel);
2430 }
2431#endif
drhceea3322009-04-23 13:22:42 +00002432 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2433 if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2434 cacheEntryClear(pParse, p);
2435 p->iReg = 0;
2436 }
2437 }
2438}
drh945498f2007-02-24 11:52:52 +00002439
2440/*
drh5cd79232009-05-25 11:46:29 +00002441** When a cached column is reused, make sure that its register is
2442** no longer available as a temp register. ticket #3879: that same
2443** register might be in the cache in multiple places, so be sure to
2444** get them all.
2445*/
2446static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
2447 int i;
2448 struct yColCache *p;
2449 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2450 if( p->iReg==iReg ){
2451 p->tempReg = 0;
2452 }
2453 }
2454}
2455
drh1f9ca2c2015-08-25 16:57:52 +00002456/* Generate code that will load into register regOut a value that is
2457** appropriate for the iIdxCol-th column of index pIdx.
2458*/
2459void sqlite3ExprCodeLoadIndexColumn(
2460 Parse *pParse, /* The parsing context */
2461 Index *pIdx, /* The index whose column is to be loaded */
2462 int iTabCur, /* Cursor pointing to a table row */
2463 int iIdxCol, /* The column of the index to be loaded */
2464 int regOut /* Store the index column value in this register */
2465){
2466 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00002467 if( iTabCol==XN_EXPR ){
2468 assert( pIdx->aColExpr );
2469 assert( pIdx->aColExpr->nExpr>iIdxCol );
2470 pParse->iSelfTab = iTabCur;
drh1c75c9d2015-12-21 15:22:13 +00002471 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh4b92f982015-09-29 17:20:14 +00002472 }else{
drh1f9ca2c2015-08-25 16:57:52 +00002473 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
2474 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00002475 }
drh1f9ca2c2015-08-25 16:57:52 +00002476}
2477
drh5cd79232009-05-25 11:46:29 +00002478/*
drh5c092e82010-05-14 19:24:02 +00002479** Generate code to extract the value of the iCol-th column of a table.
2480*/
2481void sqlite3ExprCodeGetColumnOfTable(
2482 Vdbe *v, /* The VDBE under construction */
2483 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00002484 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00002485 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00002486 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00002487){
2488 if( iCol<0 || iCol==pTab->iPKey ){
2489 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
2490 }else{
2491 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00002492 int x = iCol;
2493 if( !HasRowid(pTab) ){
2494 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2495 }
2496 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00002497 }
2498 if( iCol>=0 ){
2499 sqlite3ColumnDefault(v, pTab, iCol, regOut);
2500 }
2501}
2502
2503/*
drh945498f2007-02-24 11:52:52 +00002504** Generate code that will extract the iColumn-th column from
drhce78bc62015-10-15 19:21:51 +00002505** table pTab and store the column value in a register.
2506**
2507** An effort is made to store the column value in register iReg. This
2508** is not garanteeed for GetColumn() - the result can be stored in
2509** any register. But the result is guaranteed to land in register iReg
2510** for GetColumnToReg().
drhe55cbd72008-03-31 23:48:03 +00002511**
2512** There must be an open cursor to pTab in iTable when this routine
2513** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00002514*/
drhe55cbd72008-03-31 23:48:03 +00002515int sqlite3ExprCodeGetColumn(
2516 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00002517 Table *pTab, /* Description of the table we are reading from */
2518 int iColumn, /* Index of the table column */
2519 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00002520 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00002521 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00002522){
drhe55cbd72008-03-31 23:48:03 +00002523 Vdbe *v = pParse->pVdbe;
2524 int i;
drhda250ea2008-04-01 05:07:14 +00002525 struct yColCache *p;
drhe55cbd72008-03-31 23:48:03 +00002526
drhceea3322009-04-23 13:22:42 +00002527 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drhb6da74e2009-12-24 16:00:28 +00002528 if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
drhceea3322009-04-23 13:22:42 +00002529 p->lru = pParse->iCacheCnt++;
drh5cd79232009-05-25 11:46:29 +00002530 sqlite3ExprCachePinRegister(pParse, p->iReg);
drhda250ea2008-04-01 05:07:14 +00002531 return p->iReg;
drhe55cbd72008-03-31 23:48:03 +00002532 }
2533 }
2534 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00002535 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00002536 if( p5 ){
2537 sqlite3VdbeChangeP5(v, p5);
2538 }else{
2539 sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2540 }
drhe55cbd72008-03-31 23:48:03 +00002541 return iReg;
2542}
drhce78bc62015-10-15 19:21:51 +00002543void sqlite3ExprCodeGetColumnToReg(
2544 Parse *pParse, /* Parsing and code generating context */
2545 Table *pTab, /* Description of the table we are reading from */
2546 int iColumn, /* Index of the table column */
2547 int iTable, /* The cursor pointing to the table */
2548 int iReg /* Store results here */
2549){
2550 int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
2551 if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
2552}
2553
drhe55cbd72008-03-31 23:48:03 +00002554
2555/*
drhceea3322009-04-23 13:22:42 +00002556** Clear all column cache entries.
drhe55cbd72008-03-31 23:48:03 +00002557*/
drhceea3322009-04-23 13:22:42 +00002558void sqlite3ExprCacheClear(Parse *pParse){
2559 int i;
2560 struct yColCache *p;
2561
drh9ac79622013-12-18 15:11:47 +00002562#if SQLITE_DEBUG
2563 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2564 printf("CLEAR\n");
2565 }
2566#endif
drhceea3322009-04-23 13:22:42 +00002567 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2568 if( p->iReg ){
2569 cacheEntryClear(pParse, p);
2570 p->iReg = 0;
drhe55cbd72008-03-31 23:48:03 +00002571 }
drhe55cbd72008-03-31 23:48:03 +00002572 }
2573}
2574
2575/*
drhda250ea2008-04-01 05:07:14 +00002576** Record the fact that an affinity change has occurred on iCount
2577** registers starting with iStart.
drhe55cbd72008-03-31 23:48:03 +00002578*/
drhda250ea2008-04-01 05:07:14 +00002579void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
drhf49f3522009-12-30 14:12:38 +00002580 sqlite3ExprCacheRemove(pParse, iStart, iCount);
drhe55cbd72008-03-31 23:48:03 +00002581}
2582
2583/*
drhb21e7c72008-06-22 12:37:57 +00002584** Generate code to move content from registers iFrom...iFrom+nReg-1
2585** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
drhe55cbd72008-03-31 23:48:03 +00002586*/
drhb21e7c72008-06-22 12:37:57 +00002587void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00002588 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00002589 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh236241a2014-09-12 17:41:30 +00002590 sqlite3ExprCacheRemove(pParse, iFrom, nReg);
drh945498f2007-02-24 11:52:52 +00002591}
2592
drhf49f3522009-12-30 14:12:38 +00002593#if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
drh92b01d52008-06-24 00:32:35 +00002594/*
drh652fbf52008-04-01 01:42:41 +00002595** Return true if any register in the range iFrom..iTo (inclusive)
2596** is used as part of the column cache.
drhf49f3522009-12-30 14:12:38 +00002597**
2598** This routine is used within assert() and testcase() macros only
2599** and does not appear in a normal build.
drh652fbf52008-04-01 01:42:41 +00002600*/
2601static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2602 int i;
drhceea3322009-04-23 13:22:42 +00002603 struct yColCache *p;
2604 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2605 int r = p->iReg;
drhf49f3522009-12-30 14:12:38 +00002606 if( r>=iFrom && r<=iTo ) return 1; /*NO_TEST*/
drh652fbf52008-04-01 01:42:41 +00002607 }
2608 return 0;
2609}
drhf49f3522009-12-30 14:12:38 +00002610#endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
drh652fbf52008-04-01 01:42:41 +00002611
2612/*
drha4c3c872013-09-12 17:29:25 +00002613** Convert an expression node to a TK_REGISTER
2614*/
2615static void exprToRegister(Expr *p, int iReg){
2616 p->op2 = p->op;
2617 p->op = TK_REGISTER;
2618 p->iTable = iReg;
2619 ExprClearProperty(p, EP_Skip);
2620}
2621
2622/*
drhcce7d172000-05-31 15:34:51 +00002623** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00002624** expression. Attempt to store the results in register "target".
2625** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00002626**
drh8b213892008-08-29 02:14:02 +00002627** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00002628** be stored in target. The result might be stored in some other
2629** register if it is convenient to do so. The calling function
2630** must check the return code and move the results to the desired
2631** register.
drhcce7d172000-05-31 15:34:51 +00002632*/
drh678ccce2008-03-31 18:19:54 +00002633int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00002634 Vdbe *v = pParse->pVdbe; /* The VM under construction */
2635 int op; /* The opcode being coded */
2636 int inReg = target; /* Results stored in register inReg */
2637 int regFree1 = 0; /* If non-zero free this temporary register */
2638 int regFree2 = 0; /* If non-zero free this temporary register */
drh678ccce2008-03-31 18:19:54 +00002639 int r1, r2, r3, r4; /* Various register numbers */
drh20411ea2009-05-29 19:00:12 +00002640 sqlite3 *db = pParse->db; /* The database connection */
drh10d1edf2013-11-15 15:52:39 +00002641 Expr tempX; /* Temporary expression node */
drhffe07b22005-11-03 00:41:17 +00002642
drh9cbf3422008-01-17 16:22:13 +00002643 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00002644 if( v==0 ){
2645 assert( pParse->db->mallocFailed );
2646 return 0;
2647 }
drh389a1ad2008-01-03 23:44:53 +00002648
2649 if( pExpr==0 ){
2650 op = TK_NULL;
2651 }else{
2652 op = pExpr->op;
2653 }
drhf2bc0132004-10-04 13:19:23 +00002654 switch( op ){
drh13449892005-09-07 21:22:45 +00002655 case TK_AGG_COLUMN: {
2656 AggInfo *pAggInfo = pExpr->pAggInfo;
2657 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
2658 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00002659 assert( pCol->iMem>0 );
2660 inReg = pCol->iMem;
drh13449892005-09-07 21:22:45 +00002661 break;
2662 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00002663 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00002664 pCol->iSorterColumn, target);
drh13449892005-09-07 21:22:45 +00002665 break;
2666 }
2667 /* Otherwise, fall thru into the TK_COLUMN case */
2668 }
drh967e8b72000-06-21 13:59:10 +00002669 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00002670 int iTab = pExpr->iTable;
2671 if( iTab<0 ){
2672 if( pParse->ckBase>0 ){
2673 /* Generating CHECK constraints or inserting into partial index */
2674 inReg = pExpr->iColumn + pParse->ckBase;
2675 break;
2676 }else{
drh1f9ca2c2015-08-25 16:57:52 +00002677 /* Coding an expression that is part of an index where column names
2678 ** in the index refer to the table to which the index belongs */
2679 iTab = pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00002680 }
drh22827922000-06-06 17:27:05 +00002681 }
drhb2b9d3d2013-08-01 01:14:43 +00002682 inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2683 pExpr->iColumn, iTab, target,
2684 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00002685 break;
2686 }
2687 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00002688 codeInteger(pParse, pExpr, 0, target);
drhfec19aa2004-05-19 20:41:03 +00002689 break;
2690 }
drh13573c72010-01-12 17:04:07 +00002691#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00002692 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00002693 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2694 codeReal(v, pExpr->u.zToken, 0, target);
drh598f1342007-10-23 15:39:45 +00002695 break;
2696 }
drh13573c72010-01-12 17:04:07 +00002697#endif
drhfec19aa2004-05-19 20:41:03 +00002698 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00002699 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00002700 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhcce7d172000-05-31 15:34:51 +00002701 break;
2702 }
drhf0863fe2005-06-12 21:35:51 +00002703 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00002704 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhf0863fe2005-06-12 21:35:51 +00002705 break;
2706 }
danielk19775338a5f2005-01-20 13:03:10 +00002707#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00002708 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00002709 int n;
2710 const char *z;
drhca48c902008-01-18 14:08:24 +00002711 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00002712 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2713 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
2714 assert( pExpr->u.zToken[1]=='\'' );
2715 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00002716 n = sqlite3Strlen30(z) - 1;
2717 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00002718 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2719 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
danielk1977c572ef72004-05-27 09:28:41 +00002720 break;
2721 }
danielk19775338a5f2005-01-20 13:03:10 +00002722#endif
drh50457892003-09-06 01:10:47 +00002723 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00002724 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2725 assert( pExpr->u.zToken!=0 );
2726 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00002727 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
2728 if( pExpr->u.zToken[1]!=0 ){
drh04e9eea2011-06-01 19:16:06 +00002729 assert( pExpr->u.zToken[0]=='?'
2730 || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
2731 sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
drh895d7472004-08-20 16:02:39 +00002732 }
drh50457892003-09-06 01:10:47 +00002733 break;
2734 }
drh4e0cff62004-11-05 05:10:28 +00002735 case TK_REGISTER: {
drh9de221d2008-01-05 06:51:30 +00002736 inReg = pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00002737 break;
2738 }
drh487e2622005-06-25 18:42:14 +00002739#ifndef SQLITE_OMIT_CAST
2740 case TK_CAST: {
2741 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00002742 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00002743 if( inReg!=target ){
2744 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
2745 inReg = target;
2746 }
drh4169e432014-08-25 20:11:52 +00002747 sqlite3VdbeAddOp2(v, OP_Cast, target,
2748 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc5499be2008-04-01 15:06:33 +00002749 testcase( usedAsColumnCache(pParse, inReg, inReg) );
drhb3843a82008-04-01 12:24:11 +00002750 sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
drh487e2622005-06-25 18:42:14 +00002751 break;
2752 }
2753#endif /* SQLITE_OMIT_CAST */
drhc9b84a12002-06-20 11:36:48 +00002754 case TK_LT:
2755 case TK_LE:
2756 case TK_GT:
2757 case TK_GE:
2758 case TK_NE:
2759 case TK_EQ: {
drhb6da74e2009-12-24 16:00:28 +00002760 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2761 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00002762 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
2763 r1, r2, inReg, SQLITE_STOREP2);
drh7d176102014-02-18 03:07:12 +00002764 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
2765 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
2766 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
2767 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
2768 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
2769 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00002770 testcase( regFree1==0 );
2771 testcase( regFree2==0 );
danielk1977a37cdde2004-05-16 11:15:36 +00002772 break;
drhc9b84a12002-06-20 11:36:48 +00002773 }
drh6a2fe092009-09-23 02:29:36 +00002774 case TK_IS:
2775 case TK_ISNOT: {
2776 testcase( op==TK_IS );
2777 testcase( op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00002778 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2779 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00002780 op = (op==TK_IS) ? TK_EQ : TK_NE;
2781 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
2782 r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00002783 VdbeCoverageIf(v, op==TK_EQ);
2784 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00002785 testcase( regFree1==0 );
2786 testcase( regFree2==0 );
2787 break;
2788 }
drhcce7d172000-05-31 15:34:51 +00002789 case TK_AND:
2790 case TK_OR:
2791 case TK_PLUS:
2792 case TK_STAR:
2793 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00002794 case TK_REM:
2795 case TK_BITAND:
2796 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00002797 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00002798 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00002799 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00002800 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00002801 assert( TK_AND==OP_And ); testcase( op==TK_AND );
2802 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
2803 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
2804 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
2805 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
2806 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
2807 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
2808 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
2809 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
2810 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
2811 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00002812 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2813 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00002814 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00002815 testcase( regFree1==0 );
2816 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00002817 break;
2818 }
drhcce7d172000-05-31 15:34:51 +00002819 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00002820 Expr *pLeft = pExpr->pLeft;
2821 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00002822 if( pLeft->op==TK_INTEGER ){
2823 codeInteger(pParse, pLeft, 1, target);
2824#ifndef SQLITE_OMIT_FLOATING_POINT
2825 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00002826 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2827 codeReal(v, pLeft->u.zToken, 1, target);
drh13573c72010-01-12 17:04:07 +00002828#endif
drh3c84ddf2008-01-09 02:15:38 +00002829 }else{
drh10d1edf2013-11-15 15:52:39 +00002830 tempX.op = TK_INTEGER;
2831 tempX.flags = EP_IntValue|EP_TokenOnly;
2832 tempX.u.iValue = 0;
2833 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00002834 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00002835 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00002836 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00002837 }
drh3c84ddf2008-01-09 02:15:38 +00002838 inReg = target;
2839 break;
drh6e142f52000-06-08 13:36:40 +00002840 }
drhbf4133c2001-10-13 02:59:08 +00002841 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00002842 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00002843 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
2844 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00002845 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2846 testcase( regFree1==0 );
2847 inReg = target;
2848 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00002849 break;
2850 }
2851 case TK_ISNULL:
2852 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00002853 int addr;
drh7d176102014-02-18 03:07:12 +00002854 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
2855 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00002856 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00002857 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00002858 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00002859 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00002860 VdbeCoverageIf(v, op==TK_ISNULL);
2861 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00002862 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00002863 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00002864 break;
drhcce7d172000-05-31 15:34:51 +00002865 }
drh22827922000-06-06 17:27:05 +00002866 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00002867 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00002868 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00002869 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2870 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00002871 }else{
drh9de221d2008-01-05 06:51:30 +00002872 inReg = pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00002873 }
drh22827922000-06-06 17:27:05 +00002874 break;
2875 }
drhcce7d172000-05-31 15:34:51 +00002876 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00002877 ExprList *pFarg; /* List of function arguments */
2878 int nFarg; /* Number of function arguments */
2879 FuncDef *pDef; /* The function definition object */
2880 int nId; /* Length of the function name in bytes */
2881 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00002882 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00002883 int i; /* Loop counter */
2884 u8 enc = ENC(db); /* The text encoding used by this database */
2885 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00002886
danielk19776ab3a2e2009-02-19 14:39:25 +00002887 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00002888 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00002889 pFarg = 0;
2890 }else{
2891 pFarg = pExpr->x.pList;
2892 }
2893 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00002894 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2895 zId = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00002896 nId = sqlite3Strlen30(zId);
drh12ffee82009-04-08 13:51:51 +00002897 pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
drh0c4de2d2014-08-06 00:29:06 +00002898 if( pDef==0 || pDef->xFunc==0 ){
drhfeb306f2009-08-18 16:05:46 +00002899 sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2900 break;
2901 }
drhae6bb952009-11-11 00:24:31 +00002902
2903 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00002904 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00002905 ** arguments past the first non-NULL argument.
2906 */
drhd36e1042013-09-06 13:10:12 +00002907 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhae6bb952009-11-11 00:24:31 +00002908 int endCoalesce = sqlite3VdbeMakeLabel(v);
2909 assert( nFarg>=2 );
2910 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2911 for(i=1; i<nFarg; i++){
2912 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00002913 VdbeCoverage(v);
drhf49f3522009-12-30 14:12:38 +00002914 sqlite3ExprCacheRemove(pParse, target, 1);
drhae6bb952009-11-11 00:24:31 +00002915 sqlite3ExprCachePush(pParse);
2916 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhd2490902014-04-13 19:28:15 +00002917 sqlite3ExprCachePop(pParse);
drhae6bb952009-11-11 00:24:31 +00002918 }
2919 sqlite3VdbeResolveLabel(v, endCoalesce);
2920 break;
2921 }
2922
drhcca9f3d2013-09-06 15:23:29 +00002923 /* The UNLIKELY() function is a no-op. The result is the value
2924 ** of the first argument.
2925 */
2926 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2927 assert( nFarg>=1 );
drh5f02ab02015-06-20 13:18:34 +00002928 inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00002929 break;
2930 }
drhae6bb952009-11-11 00:24:31 +00002931
drhd1a01ed2013-11-21 16:08:52 +00002932 for(i=0; i<nFarg; i++){
2933 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00002934 testcase( i==31 );
2935 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00002936 }
2937 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
2938 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2939 }
2940 }
drh12ffee82009-04-08 13:51:51 +00002941 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00002942 if( constMask ){
2943 r1 = pParse->nMem+1;
2944 pParse->nMem += nFarg;
2945 }else{
2946 r1 = sqlite3GetTempRange(pParse, nFarg);
2947 }
drha748fdc2012-03-28 01:34:47 +00002948
2949 /* For length() and typeof() functions with a column argument,
2950 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2951 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2952 ** loading.
2953 */
drhd36e1042013-09-06 13:10:12 +00002954 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00002955 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00002956 assert( nFarg==1 );
2957 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00002958 exprOp = pFarg->a[0].pExpr->op;
2959 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00002960 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2961 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00002962 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
2963 pFarg->a[0].pExpr->op2 =
2964 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00002965 }
2966 }
2967
drhd7d385d2009-09-03 01:18:00 +00002968 sqlite3ExprCachePush(pParse); /* Ticket 2ea2425d34be */
drh5579d592015-08-26 14:01:41 +00002969 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00002970 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drhd2490902014-04-13 19:28:15 +00002971 sqlite3ExprCachePop(pParse); /* Ticket 2ea2425d34be */
drh892d3172008-01-10 03:46:36 +00002972 }else{
drh12ffee82009-04-08 13:51:51 +00002973 r1 = 0;
drh892d3172008-01-10 03:46:36 +00002974 }
drhb7f6f682006-07-08 17:06:43 +00002975#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00002976 /* Possibly overload the function if the first argument is
2977 ** a virtual table column.
2978 **
2979 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2980 ** second argument, not the first, as the argument to test to
2981 ** see if it is a column in a virtual table. This is done because
2982 ** the left operand of infix functions (the operand we want to
2983 ** control overloading) ends up as the second argument to the
2984 ** function. The expression "A glob B" is equivalent to
2985 ** "glob(B,A). We want to use the A in "A glob B" to test
2986 ** for function overloading. But we use the B term in "glob(B,A)".
2987 */
drh12ffee82009-04-08 13:51:51 +00002988 if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
2989 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
2990 }else if( nFarg>0 ){
2991 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00002992 }
2993#endif
drhd36e1042013-09-06 13:10:12 +00002994 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00002995 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00002996 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00002997 }
drh9c7c9132015-06-26 18:16:52 +00002998 sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
drh66a51672008-01-03 00:01:23 +00002999 (char*)pDef, P4_FUNCDEF);
drh12ffee82009-04-08 13:51:51 +00003000 sqlite3VdbeChangeP5(v, (u8)nFarg);
drhd1a01ed2013-11-21 16:08:52 +00003001 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003002 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003003 }
drhcce7d172000-05-31 15:34:51 +00003004 break;
3005 }
drhfe2093d2005-01-20 22:48:47 +00003006#ifndef SQLITE_OMIT_SUBQUERY
3007 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003008 case TK_SELECT: {
drhc5499be2008-04-01 15:06:33 +00003009 testcase( op==TK_EXISTS );
3010 testcase( op==TK_SELECT );
drh1450bc62009-10-30 13:25:56 +00003011 inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
drh19a775c2000-06-05 18:54:46 +00003012 break;
3013 }
drhfef52082000-06-06 01:50:43 +00003014 case TK_IN: {
drhe3365e62009-11-12 17:52:24 +00003015 int destIfFalse = sqlite3VdbeMakeLabel(v);
3016 int destIfNull = sqlite3VdbeMakeLabel(v);
3017 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3018 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3019 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3020 sqlite3VdbeResolveLabel(v, destIfFalse);
3021 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3022 sqlite3VdbeResolveLabel(v, destIfNull);
drhfef52082000-06-06 01:50:43 +00003023 break;
3024 }
drhe3365e62009-11-12 17:52:24 +00003025#endif /* SQLITE_OMIT_SUBQUERY */
3026
3027
drh2dcef112008-01-12 19:03:48 +00003028 /*
3029 ** x BETWEEN y AND z
3030 **
3031 ** This is equivalent to
3032 **
3033 ** x>=y AND x<=z
3034 **
3035 ** X is stored in pExpr->pLeft.
3036 ** Y is stored in pExpr->pList->a[0].pExpr.
3037 ** Z is stored in pExpr->pList->a[1].pExpr.
3038 */
drhfef52082000-06-06 01:50:43 +00003039 case TK_BETWEEN: {
drhbe5c89a2004-07-26 00:31:09 +00003040 Expr *pLeft = pExpr->pLeft;
danielk19776ab3a2e2009-02-19 14:39:25 +00003041 struct ExprList_item *pLItem = pExpr->x.pList->a;
drhbe5c89a2004-07-26 00:31:09 +00003042 Expr *pRight = pLItem->pExpr;
drh35573352008-01-08 23:54:25 +00003043
drhb6da74e2009-12-24 16:00:28 +00003044 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3045 r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
drhc5499be2008-04-01 15:06:33 +00003046 testcase( regFree1==0 );
3047 testcase( regFree2==0 );
drh2dcef112008-01-12 19:03:48 +00003048 r3 = sqlite3GetTempReg(pParse);
drh678ccce2008-03-31 18:19:54 +00003049 r4 = sqlite3GetTempReg(pParse);
drh35573352008-01-08 23:54:25 +00003050 codeCompare(pParse, pLeft, pRight, OP_Ge,
drh7d176102014-02-18 03:07:12 +00003051 r1, r2, r3, SQLITE_STOREP2); VdbeCoverage(v);
drhbe5c89a2004-07-26 00:31:09 +00003052 pLItem++;
3053 pRight = pLItem->pExpr;
drh2dcef112008-01-12 19:03:48 +00003054 sqlite3ReleaseTempReg(pParse, regFree2);
3055 r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
drhc5499be2008-04-01 15:06:33 +00003056 testcase( regFree2==0 );
drh678ccce2008-03-31 18:19:54 +00003057 codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
drh688852a2014-02-17 22:40:43 +00003058 VdbeCoverage(v);
drh678ccce2008-03-31 18:19:54 +00003059 sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
drh2dcef112008-01-12 19:03:48 +00003060 sqlite3ReleaseTempReg(pParse, r3);
drh678ccce2008-03-31 18:19:54 +00003061 sqlite3ReleaseTempReg(pParse, r4);
drhfef52082000-06-06 01:50:43 +00003062 break;
3063 }
drhae80dde2012-12-06 21:16:43 +00003064 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003065 case TK_UPLUS: {
drh2dcef112008-01-12 19:03:48 +00003066 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drha2e00042002-01-22 03:13:42 +00003067 break;
3068 }
drh2dcef112008-01-12 19:03:48 +00003069
dan165921a2009-08-28 18:53:45 +00003070 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003071 /* If the opcode is TK_TRIGGER, then the expression is a reference
3072 ** to a column in the new.* or old.* pseudo-tables available to
3073 ** trigger programs. In this case Expr.iTable is set to 1 for the
3074 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3075 ** is set to the column of the pseudo-table to read, or to -1 to
3076 ** read the rowid field.
3077 **
3078 ** The expression is implemented using an OP_Param opcode. The p1
3079 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3080 ** to reference another column of the old.* pseudo-table, where
3081 ** i is the index of the column. For a new.rowid reference, p1 is
3082 ** set to (n+1), where n is the number of columns in each pseudo-table.
3083 ** For a reference to any other column in the new.* pseudo-table, p1
3084 ** is set to (n+2+i), where n and i are as defined previously. For
3085 ** example, if the table on which triggers are being fired is
3086 ** declared as:
3087 **
3088 ** CREATE TABLE t1(a, b);
3089 **
3090 ** Then p1 is interpreted as follows:
3091 **
3092 ** p1==0 -> old.rowid p1==3 -> new.rowid
3093 ** p1==1 -> old.a p1==4 -> new.a
3094 ** p1==2 -> old.b p1==5 -> new.b
3095 */
dan2832ad42009-08-31 15:27:27 +00003096 Table *pTab = pExpr->pTab;
dan65a7cd12009-09-01 12:16:01 +00003097 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3098
3099 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3100 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3101 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3102 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3103
3104 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
dan2bd93512009-08-31 08:22:46 +00003105 VdbeComment((v, "%s.%s -> $%d",
3106 (pExpr->iTable ? "new" : "old"),
dan76d462e2009-08-30 11:42:51 +00003107 (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
dan2bd93512009-08-31 08:22:46 +00003108 target
dan165921a2009-08-28 18:53:45 +00003109 ));
dan65a7cd12009-09-01 12:16:01 +00003110
drh44dbca82010-01-13 04:22:20 +00003111#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003112 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003113 ** integer. Use OP_RealAffinity to make sure it is really real.
3114 **
3115 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3116 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003117 if( pExpr->iColumn>=0
3118 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3119 ){
3120 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3121 }
drh44dbca82010-01-13 04:22:20 +00003122#endif
dan165921a2009-08-28 18:53:45 +00003123 break;
3124 }
3125
3126
drh2dcef112008-01-12 19:03:48 +00003127 /*
3128 ** Form A:
3129 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3130 **
3131 ** Form B:
3132 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3133 **
3134 ** Form A is can be transformed into the equivalent form B as follows:
3135 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
3136 ** WHEN x=eN THEN rN ELSE y END
3137 **
3138 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00003139 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3140 ** odd. The Y is also optional. If the number of elements in x.pList
3141 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00003142 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
3143 **
3144 ** The result of the expression is the Ri for the first matching Ei,
3145 ** or if there is no matching Ei, the ELSE term Y, or if there is
3146 ** no ELSE term, NULL.
3147 */
drh33cd4902009-05-30 20:49:20 +00003148 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00003149 int endLabel; /* GOTO label for end of CASE stmt */
3150 int nextCase; /* GOTO label for next WHEN clause */
3151 int nExpr; /* 2x number of WHEN terms */
3152 int i; /* Loop counter */
3153 ExprList *pEList; /* List of WHEN terms */
3154 struct ExprList_item *aListelem; /* Array of WHEN terms */
3155 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00003156 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00003157 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drhceea3322009-04-23 13:22:42 +00003158 VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
drh17a7f8d2002-03-24 13:13:27 +00003159
danielk19776ab3a2e2009-02-19 14:39:25 +00003160 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00003161 assert(pExpr->x.pList->nExpr > 0);
3162 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00003163 aListelem = pEList->a;
3164 nExpr = pEList->nExpr;
drh2dcef112008-01-12 19:03:48 +00003165 endLabel = sqlite3VdbeMakeLabel(v);
3166 if( (pX = pExpr->pLeft)!=0 ){
drh10d1edf2013-11-15 15:52:39 +00003167 tempX = *pX;
drh33cd4902009-05-30 20:49:20 +00003168 testcase( pX->op==TK_COLUMN );
drh10d1edf2013-11-15 15:52:39 +00003169 exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00003170 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003171 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00003172 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00003173 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00003174 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
3175 ** The value in regFree1 might get SCopy-ed into the file result.
3176 ** So make sure that the regFree1 register is not reused for other
3177 ** purposes and possibly overwritten. */
3178 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00003179 }
drhc5cd1242013-09-12 16:50:49 +00003180 for(i=0; i<nExpr-1; i=i+2){
drhceea3322009-04-23 13:22:42 +00003181 sqlite3ExprCachePush(pParse);
drh2dcef112008-01-12 19:03:48 +00003182 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00003183 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00003184 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003185 }else{
drh2dcef112008-01-12 19:03:48 +00003186 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003187 }
drh2dcef112008-01-12 19:03:48 +00003188 nextCase = sqlite3VdbeMakeLabel(v);
drh33cd4902009-05-30 20:49:20 +00003189 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00003190 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00003191 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00003192 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00003193 sqlite3VdbeGoto(v, endLabel);
drhd2490902014-04-13 19:28:15 +00003194 sqlite3ExprCachePop(pParse);
drh2dcef112008-01-12 19:03:48 +00003195 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00003196 }
drhc5cd1242013-09-12 16:50:49 +00003197 if( (nExpr&1)!=0 ){
drhceea3322009-04-23 13:22:42 +00003198 sqlite3ExprCachePush(pParse);
drhc5cd1242013-09-12 16:50:49 +00003199 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drhd2490902014-04-13 19:28:15 +00003200 sqlite3ExprCachePop(pParse);
drh17a7f8d2002-03-24 13:13:27 +00003201 }else{
drh9de221d2008-01-05 06:51:30 +00003202 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00003203 }
danielk1977c1f4a192009-04-28 12:08:15 +00003204 assert( db->mallocFailed || pParse->nErr>0
3205 || pParse->iCacheLevel==iCacheLevel );
drh2dcef112008-01-12 19:03:48 +00003206 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00003207 break;
3208 }
danielk19775338a5f2005-01-20 13:03:10 +00003209#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00003210 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00003211 assert( pExpr->affinity==OE_Rollback
3212 || pExpr->affinity==OE_Abort
3213 || pExpr->affinity==OE_Fail
3214 || pExpr->affinity==OE_Ignore
3215 );
dane0af83a2009-09-08 19:15:01 +00003216 if( !pParse->pTriggerTab ){
3217 sqlite3ErrorMsg(pParse,
3218 "RAISE() may only be used within a trigger-program");
3219 return 0;
3220 }
3221 if( pExpr->affinity==OE_Abort ){
3222 sqlite3MayAbort(pParse);
3223 }
dan165921a2009-08-28 18:53:45 +00003224 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00003225 if( pExpr->affinity==OE_Ignore ){
3226 sqlite3VdbeAddOp4(
3227 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00003228 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00003229 }else{
drh433dccf2013-02-09 15:37:11 +00003230 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00003231 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00003232 }
3233
drhffe07b22005-11-03 00:41:17 +00003234 break;
drh17a7f8d2002-03-24 13:13:27 +00003235 }
danielk19775338a5f2005-01-20 13:03:10 +00003236#endif
drhffe07b22005-11-03 00:41:17 +00003237 }
drh2dcef112008-01-12 19:03:48 +00003238 sqlite3ReleaseTempReg(pParse, regFree1);
3239 sqlite3ReleaseTempReg(pParse, regFree2);
3240 return inReg;
3241}
3242
3243/*
drhd1a01ed2013-11-21 16:08:52 +00003244** Factor out the code of the given expression to initialization time.
3245*/
drhd673cdd2013-11-21 21:23:31 +00003246void sqlite3ExprCodeAtInit(
3247 Parse *pParse, /* Parsing context */
3248 Expr *pExpr, /* The expression to code when the VDBE initializes */
3249 int regDest, /* Store the value in this register */
3250 u8 reusable /* True if this expression is reusable */
3251){
drhd1a01ed2013-11-21 16:08:52 +00003252 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00003253 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00003254 p = pParse->pConstExpr;
3255 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3256 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00003257 if( p ){
3258 struct ExprList_item *pItem = &p->a[p->nExpr-1];
3259 pItem->u.iConstExprReg = regDest;
3260 pItem->reusable = reusable;
3261 }
drhd1a01ed2013-11-21 16:08:52 +00003262 pParse->pConstExpr = p;
3263}
3264
3265/*
drh2dcef112008-01-12 19:03:48 +00003266** Generate code to evaluate an expression and store the results
3267** into a register. Return the register number where the results
3268** are stored.
3269**
3270** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00003271** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00003272** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00003273**
3274** If pExpr is a constant, then this routine might generate this
3275** code to fill the register in the initialization section of the
3276** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00003277*/
3278int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00003279 int r2;
3280 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00003281 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00003282 && pExpr->op!=TK_REGISTER
3283 && sqlite3ExprIsConstantNotJoin(pExpr)
3284 ){
3285 ExprList *p = pParse->pConstExpr;
3286 int i;
3287 *pReg = 0;
3288 if( p ){
drhd673cdd2013-11-21 21:23:31 +00003289 struct ExprList_item *pItem;
3290 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3291 if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3292 return pItem->u.iConstExprReg;
drhf30a9692013-11-15 01:10:18 +00003293 }
3294 }
3295 }
drhf30a9692013-11-15 01:10:18 +00003296 r2 = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00003297 sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
drh2dcef112008-01-12 19:03:48 +00003298 }else{
drhf30a9692013-11-15 01:10:18 +00003299 int r1 = sqlite3GetTempReg(pParse);
3300 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
3301 if( r2==r1 ){
3302 *pReg = r1;
3303 }else{
3304 sqlite3ReleaseTempReg(pParse, r1);
3305 *pReg = 0;
3306 }
drh2dcef112008-01-12 19:03:48 +00003307 }
3308 return r2;
3309}
3310
3311/*
3312** Generate code that will evaluate expression pExpr and store the
3313** results in register target. The results are guaranteed to appear
3314** in register target.
3315*/
drh05a86c52014-02-16 01:55:49 +00003316void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00003317 int inReg;
3318
3319 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00003320 if( pExpr && pExpr->op==TK_REGISTER ){
3321 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3322 }else{
3323 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00003324 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00003325 if( inReg!=target && pParse->pVdbe ){
3326 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
3327 }
drhcce7d172000-05-31 15:34:51 +00003328 }
drhcce7d172000-05-31 15:34:51 +00003329}
3330
3331/*
drh1c75c9d2015-12-21 15:22:13 +00003332** Make a transient copy of expression pExpr and then code it using
3333** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
3334** except that the input expression is guaranteed to be unchanged.
3335*/
3336void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
3337 sqlite3 *db = pParse->db;
3338 pExpr = sqlite3ExprDup(db, pExpr, 0);
3339 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
3340 sqlite3ExprDelete(db, pExpr);
3341}
3342
3343/*
drh05a86c52014-02-16 01:55:49 +00003344** Generate code that will evaluate expression pExpr and store the
3345** results in register target. The results are guaranteed to appear
3346** in register target. If the expression is constant, then this routine
3347** might choose to code the expression at initialization time.
3348*/
3349void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
3350 if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
3351 sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
3352 }else{
3353 sqlite3ExprCode(pParse, pExpr, target);
3354 }
drhcce7d172000-05-31 15:34:51 +00003355}
3356
3357/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003358** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00003359** in register target.
drh25303782004-12-07 15:41:48 +00003360**
drh2dcef112008-01-12 19:03:48 +00003361** Also make a copy of the expression results into another "cache" register
3362** and modify the expression so that the next time it is evaluated,
3363** the result is a copy of the cache register.
3364**
3365** This routine is used for expressions that are used multiple
3366** times. They are evaluated once and the results of the expression
3367** are reused.
drh25303782004-12-07 15:41:48 +00003368*/
drh05a86c52014-02-16 01:55:49 +00003369void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00003370 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00003371 int iMem;
3372
drhde4fcfd2008-01-19 23:50:26 +00003373 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00003374 assert( pExpr->op!=TK_REGISTER );
3375 sqlite3ExprCode(pParse, pExpr, target);
3376 iMem = ++pParse->nMem;
3377 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3378 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00003379}
drh2dcef112008-01-12 19:03:48 +00003380
drh678ccce2008-03-31 18:19:54 +00003381/*
drh268380c2004-02-25 13:47:31 +00003382** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00003383** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00003384**
drh892d3172008-01-10 03:46:36 +00003385** Return the number of elements evaluated.
drhd1a01ed2013-11-21 16:08:52 +00003386**
3387** The SQLITE_ECEL_DUP flag prevents the arguments from being
3388** filled using OP_SCopy. OP_Copy must be used instead.
3389**
3390** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3391** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00003392**
3393** The SQLITE_ECEL_REF flag means that expressions in the list with
3394** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
3395** in registers at srcReg, and so the value can be copied from there.
drh268380c2004-02-25 13:47:31 +00003396*/
danielk19774adee202004-05-08 08:23:19 +00003397int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00003398 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00003399 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00003400 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00003401 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00003402 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00003403){
3404 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00003405 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00003406 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00003407 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00003408 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00003409 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00003410 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00003411 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00003412 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00003413 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00003414 Expr *pExpr = pItem->pExpr;
drh5579d592015-08-26 14:01:41 +00003415 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
3416 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
3417 }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
drhd673cdd2013-11-21 21:23:31 +00003418 sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
drhd1a01ed2013-11-21 16:08:52 +00003419 }else{
3420 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3421 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00003422 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00003423 if( copyOp==OP_Copy
3424 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
3425 && pOp->p1+pOp->p3+1==inReg
3426 && pOp->p2+pOp->p3+1==target+i
3427 ){
3428 pOp->p3++;
3429 }else{
3430 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
3431 }
drhd1a01ed2013-11-21 16:08:52 +00003432 }
drhd1766112008-09-17 00:13:12 +00003433 }
drh268380c2004-02-25 13:47:31 +00003434 }
drhf9b596e2004-05-26 16:54:42 +00003435 return n;
drh268380c2004-02-25 13:47:31 +00003436}
3437
3438/*
drh36c563a2009-11-12 13:32:22 +00003439** Generate code for a BETWEEN operator.
3440**
3441** x BETWEEN y AND z
3442**
3443** The above is equivalent to
3444**
3445** x>=y AND x<=z
3446**
3447** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00003448** elimination of x.
drh36c563a2009-11-12 13:32:22 +00003449*/
3450static void exprCodeBetween(
3451 Parse *pParse, /* Parsing and code generating context */
3452 Expr *pExpr, /* The BETWEEN expression */
3453 int dest, /* Jump here if the jump is taken */
3454 int jumpIfTrue, /* Take the jump if the BETWEEN is true */
3455 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
3456){
3457 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
3458 Expr compLeft; /* The x>=y term */
3459 Expr compRight; /* The x<=z term */
3460 Expr exprX; /* The x subexpression */
3461 int regFree1 = 0; /* Temporary use register */
3462
3463 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3464 exprX = *pExpr->pLeft;
3465 exprAnd.op = TK_AND;
3466 exprAnd.pLeft = &compLeft;
3467 exprAnd.pRight = &compRight;
3468 compLeft.op = TK_GE;
3469 compLeft.pLeft = &exprX;
3470 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
3471 compRight.op = TK_LE;
3472 compRight.pLeft = &exprX;
3473 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drha4c3c872013-09-12 17:29:25 +00003474 exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
drh36c563a2009-11-12 13:32:22 +00003475 if( jumpIfTrue ){
3476 sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
3477 }else{
3478 sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
3479 }
3480 sqlite3ReleaseTempReg(pParse, regFree1);
3481
3482 /* Ensure adequate test coverage */
3483 testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
3484 testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
3485 testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
3486 testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
3487 testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
3488 testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
3489 testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
3490 testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
3491}
3492
3493/*
drhcce7d172000-05-31 15:34:51 +00003494** Generate code for a boolean expression such that a jump is made
3495** to the label "dest" if the expression is true but execution
3496** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00003497**
3498** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00003499** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00003500**
3501** This code depends on the fact that certain token values (ex: TK_EQ)
3502** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3503** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
3504** the make process cause these values to align. Assert()s in the code
3505** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00003506*/
danielk19774adee202004-05-08 08:23:19 +00003507void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00003508 Vdbe *v = pParse->pVdbe;
3509 int op = 0;
drh2dcef112008-01-12 19:03:48 +00003510 int regFree1 = 0;
3511 int regFree2 = 0;
3512 int r1, r2;
3513
drh35573352008-01-08 23:54:25 +00003514 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00003515 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00003516 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00003517 op = pExpr->op;
3518 switch( op ){
drhcce7d172000-05-31 15:34:51 +00003519 case TK_AND: {
danielk19774adee202004-05-08 08:23:19 +00003520 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00003521 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00003522 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00003523 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003524 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3525 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00003526 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003527 break;
3528 }
3529 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00003530 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003531 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00003532 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003533 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00003534 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003535 break;
3536 }
3537 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00003538 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003539 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00003540 break;
3541 }
3542 case TK_LT:
3543 case TK_LE:
3544 case TK_GT:
3545 case TK_GE:
3546 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00003547 case TK_EQ: {
drhc5499be2008-04-01 15:06:33 +00003548 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00003549 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3550 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00003551 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00003552 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00003553 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3554 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3555 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3556 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3557 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3558 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00003559 testcase( regFree1==0 );
3560 testcase( regFree2==0 );
drhcce7d172000-05-31 15:34:51 +00003561 break;
3562 }
drh6a2fe092009-09-23 02:29:36 +00003563 case TK_IS:
3564 case TK_ISNOT: {
3565 testcase( op==TK_IS );
3566 testcase( op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00003567 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3568 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00003569 op = (op==TK_IS) ? TK_EQ : TK_NE;
3570 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
3571 r1, r2, dest, SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00003572 VdbeCoverageIf(v, op==TK_EQ);
3573 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00003574 testcase( regFree1==0 );
3575 testcase( regFree2==0 );
3576 break;
3577 }
drhcce7d172000-05-31 15:34:51 +00003578 case TK_ISNULL:
3579 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00003580 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3581 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00003582 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3583 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00003584 VdbeCoverageIf(v, op==TK_ISNULL);
3585 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00003586 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00003587 break;
3588 }
drhfef52082000-06-06 01:50:43 +00003589 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00003590 testcase( jumpIfNull==0 );
drh36c563a2009-11-12 13:32:22 +00003591 exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00003592 break;
3593 }
drh84e30ca2011-02-10 17:46:14 +00003594#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00003595 case TK_IN: {
3596 int destIfFalse = sqlite3VdbeMakeLabel(v);
3597 int destIfNull = jumpIfNull ? dest : destIfFalse;
3598 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00003599 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00003600 sqlite3VdbeResolveLabel(v, destIfFalse);
3601 break;
3602 }
shanehbb201342011-02-09 19:55:20 +00003603#endif
drhcce7d172000-05-31 15:34:51 +00003604 default: {
drh991a1982014-01-02 17:57:16 +00003605 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00003606 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00003607 }else if( exprAlwaysFalse(pExpr) ){
3608 /* No-op */
3609 }else{
3610 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
3611 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00003612 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00003613 testcase( regFree1==0 );
3614 testcase( jumpIfNull==0 );
3615 }
drhcce7d172000-05-31 15:34:51 +00003616 break;
3617 }
3618 }
drh2dcef112008-01-12 19:03:48 +00003619 sqlite3ReleaseTempReg(pParse, regFree1);
3620 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00003621}
3622
3623/*
drh66b89c82000-11-28 20:47:17 +00003624** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00003625** to the label "dest" if the expression is false but execution
3626** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00003627**
3628** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00003629** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
3630** is 0.
drhcce7d172000-05-31 15:34:51 +00003631*/
danielk19774adee202004-05-08 08:23:19 +00003632void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00003633 Vdbe *v = pParse->pVdbe;
3634 int op = 0;
drh2dcef112008-01-12 19:03:48 +00003635 int regFree1 = 0;
3636 int regFree2 = 0;
3637 int r1, r2;
3638
drh35573352008-01-08 23:54:25 +00003639 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00003640 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00003641 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00003642
3643 /* The value of pExpr->op and op are related as follows:
3644 **
3645 ** pExpr->op op
3646 ** --------- ----------
3647 ** TK_ISNULL OP_NotNull
3648 ** TK_NOTNULL OP_IsNull
3649 ** TK_NE OP_Eq
3650 ** TK_EQ OP_Ne
3651 ** TK_GT OP_Le
3652 ** TK_LE OP_Gt
3653 ** TK_GE OP_Lt
3654 ** TK_LT OP_Ge
3655 **
3656 ** For other values of pExpr->op, op is undefined and unused.
3657 ** The value of TK_ and OP_ constants are arranged such that we
3658 ** can compute the mapping above using the following expression.
3659 ** Assert()s verify that the computation is correct.
3660 */
3661 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3662
3663 /* Verify correct alignment of TK_ and OP_ constants
3664 */
3665 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3666 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3667 assert( pExpr->op!=TK_NE || op==OP_Eq );
3668 assert( pExpr->op!=TK_EQ || op==OP_Ne );
3669 assert( pExpr->op!=TK_LT || op==OP_Ge );
3670 assert( pExpr->op!=TK_LE || op==OP_Gt );
3671 assert( pExpr->op!=TK_GT || op==OP_Le );
3672 assert( pExpr->op!=TK_GE || op==OP_Lt );
3673
drhcce7d172000-05-31 15:34:51 +00003674 switch( pExpr->op ){
3675 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00003676 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003677 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00003678 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003679 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00003680 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003681 break;
3682 }
3683 case TK_OR: {
danielk19774adee202004-05-08 08:23:19 +00003684 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00003685 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00003686 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00003687 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003688 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3689 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00003690 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003691 break;
3692 }
3693 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00003694 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003695 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00003696 break;
3697 }
3698 case TK_LT:
3699 case TK_LE:
3700 case TK_GT:
3701 case TK_GE:
3702 case TK_NE:
3703 case TK_EQ: {
drhc5499be2008-04-01 15:06:33 +00003704 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00003705 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3706 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00003707 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00003708 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00003709 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3710 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3711 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3712 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3713 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3714 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00003715 testcase( regFree1==0 );
3716 testcase( regFree2==0 );
drhcce7d172000-05-31 15:34:51 +00003717 break;
3718 }
drh6a2fe092009-09-23 02:29:36 +00003719 case TK_IS:
3720 case TK_ISNOT: {
drh6d4486a2009-09-23 14:45:05 +00003721 testcase( pExpr->op==TK_IS );
3722 testcase( pExpr->op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00003723 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3724 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00003725 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
3726 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
3727 r1, r2, dest, SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00003728 VdbeCoverageIf(v, op==TK_EQ);
3729 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00003730 testcase( regFree1==0 );
3731 testcase( regFree2==0 );
3732 break;
3733 }
drhcce7d172000-05-31 15:34:51 +00003734 case TK_ISNULL:
3735 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00003736 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3737 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00003738 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
3739 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00003740 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00003741 break;
3742 }
drhfef52082000-06-06 01:50:43 +00003743 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00003744 testcase( jumpIfNull==0 );
drh36c563a2009-11-12 13:32:22 +00003745 exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00003746 break;
3747 }
drh84e30ca2011-02-10 17:46:14 +00003748#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00003749 case TK_IN: {
3750 if( jumpIfNull ){
3751 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3752 }else{
3753 int destIfNull = sqlite3VdbeMakeLabel(v);
3754 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3755 sqlite3VdbeResolveLabel(v, destIfNull);
3756 }
3757 break;
3758 }
shanehbb201342011-02-09 19:55:20 +00003759#endif
drhcce7d172000-05-31 15:34:51 +00003760 default: {
drh991a1982014-01-02 17:57:16 +00003761 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00003762 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00003763 }else if( exprAlwaysTrue(pExpr) ){
3764 /* no-op */
3765 }else{
3766 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
3767 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00003768 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00003769 testcase( regFree1==0 );
3770 testcase( jumpIfNull==0 );
3771 }
drhcce7d172000-05-31 15:34:51 +00003772 break;
3773 }
3774 }
drh2dcef112008-01-12 19:03:48 +00003775 sqlite3ReleaseTempReg(pParse, regFree1);
3776 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00003777}
drh22827922000-06-06 17:27:05 +00003778
3779/*
drh72bc8202015-06-11 13:58:35 +00003780** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
3781** code generation, and that copy is deleted after code generation. This
3782** ensures that the original pExpr is unchanged.
3783*/
3784void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
3785 sqlite3 *db = pParse->db;
3786 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
3787 if( db->mallocFailed==0 ){
3788 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
3789 }
3790 sqlite3ExprDelete(db, pCopy);
3791}
3792
3793
3794/*
drh1d9da702010-01-07 15:17:02 +00003795** Do a deep comparison of two expression trees. Return 0 if the two
3796** expressions are completely identical. Return 1 if they differ only
3797** by a COLLATE operator at the top level. Return 2 if there are differences
3798** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00003799**
drh619a1302013-08-01 13:04:46 +00003800** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3801** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3802**
drh66518ca2013-08-01 15:09:57 +00003803** The pA side might be using TK_REGISTER. If that is the case and pB is
3804** not using TK_REGISTER but is otherwise equivalent, then still return 0.
3805**
drh1d9da702010-01-07 15:17:02 +00003806** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00003807** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00003808** identical, we return 2 just to be safe. So if this routine
3809** returns 2, then you do not really know for certain if the two
3810** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00003811** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00003812** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00003813** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00003814** an incorrect 0 or 1 could lead to a malfunction.
drh22827922000-06-06 17:27:05 +00003815*/
drh619a1302013-08-01 13:04:46 +00003816int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00003817 u32 combinedFlags;
3818 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00003819 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00003820 }
drh10d1edf2013-11-15 15:52:39 +00003821 combinedFlags = pA->flags | pB->flags;
3822 if( combinedFlags & EP_IntValue ){
3823 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
3824 return 0;
3825 }
drh1d9da702010-01-07 15:17:02 +00003826 return 2;
drh22827922000-06-06 17:27:05 +00003827 }
drhc2acc4e2013-11-15 18:15:19 +00003828 if( pA->op!=pB->op ){
drh619a1302013-08-01 13:04:46 +00003829 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00003830 return 1;
3831 }
drh619a1302013-08-01 13:04:46 +00003832 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00003833 return 1;
3834 }
3835 return 2;
3836 }
drh2edc5fd2015-11-24 02:10:52 +00003837 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00003838 if( pA->op==TK_FUNCTION ){
3839 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
3840 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhae80dde2012-12-06 21:16:43 +00003841 return pA->op==TK_COLLATE ? 1 : 2;
drh2646da72005-12-09 20:02:05 +00003842 }
drh22827922000-06-06 17:27:05 +00003843 }
drh10d1edf2013-11-15 15:52:39 +00003844 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh85f8aa72013-11-15 20:06:26 +00003845 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00003846 if( combinedFlags & EP_xIsSelect ) return 2;
3847 if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3848 if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3849 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh7693c422015-04-17 19:41:37 +00003850 if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
drh10d1edf2013-11-15 15:52:39 +00003851 if( pA->iColumn!=pB->iColumn ) return 2;
3852 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00003853 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00003854 }
3855 }
drh1d9da702010-01-07 15:17:02 +00003856 return 0;
drh22827922000-06-06 17:27:05 +00003857}
3858
drh8c6f6662010-04-26 19:17:26 +00003859/*
3860** Compare two ExprList objects. Return 0 if they are identical and
3861** non-zero if they differ in any way.
3862**
drh619a1302013-08-01 13:04:46 +00003863** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3864** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3865**
drh8c6f6662010-04-26 19:17:26 +00003866** This routine might return non-zero for equivalent ExprLists. The
3867** only consequence will be disabled optimizations. But this routine
3868** must never return 0 if the two ExprList objects are different, or
3869** a malfunction will result.
3870**
3871** Two NULL pointers are considered to be the same. But a NULL pointer
3872** always differs from a non-NULL pointer.
3873*/
drh619a1302013-08-01 13:04:46 +00003874int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00003875 int i;
3876 if( pA==0 && pB==0 ) return 0;
3877 if( pA==0 || pB==0 ) return 1;
3878 if( pA->nExpr!=pB->nExpr ) return 1;
3879 for(i=0; i<pA->nExpr; i++){
3880 Expr *pExprA = pA->a[i].pExpr;
3881 Expr *pExprB = pB->a[i].pExpr;
3882 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
drh619a1302013-08-01 13:04:46 +00003883 if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00003884 }
3885 return 0;
3886}
drh13449892005-09-07 21:22:45 +00003887
drh22827922000-06-06 17:27:05 +00003888/*
drh4bd5f732013-07-31 23:22:39 +00003889** Return true if we can prove the pE2 will always be true if pE1 is
3890** true. Return false if we cannot complete the proof or if pE2 might
3891** be false. Examples:
3892**
drh619a1302013-08-01 13:04:46 +00003893** pE1: x==5 pE2: x==5 Result: true
3894** pE1: x>0 pE2: x==5 Result: false
3895** pE1: x=21 pE2: x=21 OR y=43 Result: true
3896** pE1: x!=123 pE2: x IS NOT NULL Result: true
3897** pE1: x!=?1 pE2: x IS NOT NULL Result: true
3898** pE1: x IS NULL pE2: x IS NOT NULL Result: false
3899** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00003900**
3901** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
3902** Expr.iTable<0 then assume a table number given by iTab.
3903**
3904** When in doubt, return false. Returning true might give a performance
3905** improvement. Returning false might cause a performance reduction, but
3906** it will always give the correct answer and is hence always safe.
3907*/
3908int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
drh619a1302013-08-01 13:04:46 +00003909 if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3910 return 1;
3911 }
3912 if( pE2->op==TK_OR
3913 && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3914 || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3915 ){
3916 return 1;
3917 }
3918 if( pE2->op==TK_NOTNULL
3919 && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3920 && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3921 ){
3922 return 1;
3923 }
3924 return 0;
drh4bd5f732013-07-31 23:22:39 +00003925}
3926
3927/*
drh030796d2012-08-23 16:18:10 +00003928** An instance of the following structure is used by the tree walker
3929** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00003930** aggregate function, in order to implement the
3931** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00003932*/
drh030796d2012-08-23 16:18:10 +00003933struct SrcCount {
3934 SrcList *pSrc; /* One particular FROM clause in a nested query */
3935 int nThis; /* Number of references to columns in pSrcList */
3936 int nOther; /* Number of references to columns in other FROM clauses */
3937};
3938
3939/*
3940** Count the number of references to columns.
3941*/
3942static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00003943 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3944 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3945 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
3946 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3947 ** NEVER() will need to be removed. */
3948 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00003949 int i;
drh030796d2012-08-23 16:18:10 +00003950 struct SrcCount *p = pWalker->u.pSrcCount;
3951 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00003952 int nSrc = pSrc ? pSrc->nSrc : 0;
3953 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00003954 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00003955 }
drh655814d2015-01-09 01:27:29 +00003956 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00003957 p->nThis++;
3958 }else{
3959 p->nOther++;
3960 }
drh374fdce2012-04-17 16:38:53 +00003961 }
drh030796d2012-08-23 16:18:10 +00003962 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00003963}
3964
3965/*
drh030796d2012-08-23 16:18:10 +00003966** Determine if any of the arguments to the pExpr Function reference
3967** pSrcList. Return true if they do. Also return true if the function
3968** has no arguments or has only constant arguments. Return false if pExpr
3969** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00003970*/
drh030796d2012-08-23 16:18:10 +00003971int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00003972 Walker w;
drh030796d2012-08-23 16:18:10 +00003973 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00003974 assert( pExpr->op==TK_AGG_FUNCTION );
3975 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00003976 w.xExprCallback = exprSrcCount;
3977 w.u.pSrcCount = &cnt;
3978 cnt.pSrc = pSrcList;
3979 cnt.nThis = 0;
3980 cnt.nOther = 0;
3981 sqlite3WalkExprList(&w, pExpr->x.pList);
3982 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00003983}
3984
3985/*
drh13449892005-09-07 21:22:45 +00003986** Add a new element to the pAggInfo->aCol[] array. Return the index of
3987** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00003988*/
drh17435752007-08-16 04:30:38 +00003989static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00003990 int i;
drhcf643722007-03-27 13:36:37 +00003991 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00003992 db,
drhcf643722007-03-27 13:36:37 +00003993 pInfo->aCol,
3994 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00003995 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00003996 &i
3997 );
drh13449892005-09-07 21:22:45 +00003998 return i;
3999}
4000
4001/*
4002** Add a new element to the pAggInfo->aFunc[] array. Return the index of
4003** the new element. Return a negative number if malloc fails.
4004*/
drh17435752007-08-16 04:30:38 +00004005static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00004006 int i;
drhcf643722007-03-27 13:36:37 +00004007 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00004008 db,
drhcf643722007-03-27 13:36:37 +00004009 pInfo->aFunc,
4010 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00004011 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00004012 &i
4013 );
drh13449892005-09-07 21:22:45 +00004014 return i;
4015}
drh22827922000-06-06 17:27:05 +00004016
4017/*
drh7d10d5a2008-08-20 16:35:10 +00004018** This is the xExprCallback for a tree walker. It is used to
4019** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00004020** for additional information.
drh22827922000-06-06 17:27:05 +00004021*/
drh7d10d5a2008-08-20 16:35:10 +00004022static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00004023 int i;
drh7d10d5a2008-08-20 16:35:10 +00004024 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00004025 Parse *pParse = pNC->pParse;
4026 SrcList *pSrcList = pNC->pSrcList;
drh13449892005-09-07 21:22:45 +00004027 AggInfo *pAggInfo = pNC->pAggInfo;
drh22827922000-06-06 17:27:05 +00004028
drh22827922000-06-06 17:27:05 +00004029 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00004030 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00004031 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00004032 testcase( pExpr->op==TK_AGG_COLUMN );
4033 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00004034 /* Check to see if the column is in one of the tables in the FROM
4035 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00004036 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00004037 struct SrcList_item *pItem = pSrcList->a;
4038 for(i=0; i<pSrcList->nSrc; i++, pItem++){
4039 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00004040 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00004041 if( pExpr->iTable==pItem->iCursor ){
4042 /* If we reach this point, it means that pExpr refers to a table
4043 ** that is in the FROM clause of the aggregate query.
4044 **
4045 ** Make an entry for the column in pAggInfo->aCol[] if there
4046 ** is not an entry there already.
4047 */
drh7f906d62007-03-12 23:48:52 +00004048 int k;
drh13449892005-09-07 21:22:45 +00004049 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00004050 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00004051 if( pCol->iTable==pExpr->iTable &&
4052 pCol->iColumn==pExpr->iColumn ){
4053 break;
4054 }
danielk1977a58fdfb2005-02-08 07:50:40 +00004055 }
danielk19771e536952007-08-16 10:09:01 +00004056 if( (k>=pAggInfo->nColumn)
4057 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
4058 ){
drh7f906d62007-03-12 23:48:52 +00004059 pCol = &pAggInfo->aCol[k];
danielk19770817d0d2007-02-14 09:19:36 +00004060 pCol->pTab = pExpr->pTab;
drh13449892005-09-07 21:22:45 +00004061 pCol->iTable = pExpr->iTable;
4062 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00004063 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00004064 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00004065 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00004066 if( pAggInfo->pGroupBy ){
4067 int j, n;
4068 ExprList *pGB = pAggInfo->pGroupBy;
4069 struct ExprList_item *pTerm = pGB->a;
4070 n = pGB->nExpr;
4071 for(j=0; j<n; j++, pTerm++){
4072 Expr *pE = pTerm->pExpr;
4073 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
4074 pE->iColumn==pExpr->iColumn ){
4075 pCol->iSorterColumn = j;
4076 break;
4077 }
4078 }
4079 }
4080 if( pCol->iSorterColumn<0 ){
4081 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
4082 }
4083 }
4084 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
4085 ** because it was there before or because we just created it).
4086 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
4087 ** pAggInfo->aCol[] entry.
4088 */
drhebb6a652013-09-12 23:42:22 +00004089 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00004090 pExpr->pAggInfo = pAggInfo;
4091 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00004092 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00004093 break;
4094 } /* endif pExpr->iTable==pItem->iCursor */
4095 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00004096 }
drh7d10d5a2008-08-20 16:35:10 +00004097 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00004098 }
4099 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00004100 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00004101 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00004102 ){
drh13449892005-09-07 21:22:45 +00004103 /* Check to see if pExpr is a duplicate of another aggregate
4104 ** function that is already in the pAggInfo structure
4105 */
4106 struct AggInfo_func *pItem = pAggInfo->aFunc;
4107 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh619a1302013-08-01 13:04:46 +00004108 if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00004109 break;
4110 }
drh22827922000-06-06 17:27:05 +00004111 }
drh13449892005-09-07 21:22:45 +00004112 if( i>=pAggInfo->nFunc ){
4113 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
4114 */
danielk197714db2662006-01-09 16:12:04 +00004115 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00004116 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00004117 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00004118 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00004119 pItem = &pAggInfo->aFunc[i];
4120 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00004121 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00004122 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00004123 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh33e619f2009-05-28 01:00:55 +00004124 pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
danielk19776ab3a2e2009-02-19 14:39:25 +00004125 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00004126 if( pExpr->flags & EP_Distinct ){
4127 pItem->iDistinct = pParse->nTab++;
4128 }else{
4129 pItem->iDistinct = -1;
4130 }
drh13449892005-09-07 21:22:45 +00004131 }
danielk1977a58fdfb2005-02-08 07:50:40 +00004132 }
drh13449892005-09-07 21:22:45 +00004133 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
4134 */
drhc5cd1242013-09-12 16:50:49 +00004135 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00004136 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00004137 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00004138 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00004139 return WRC_Prune;
4140 }else{
4141 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00004142 }
drh22827922000-06-06 17:27:05 +00004143 }
4144 }
drh7d10d5a2008-08-20 16:35:10 +00004145 return WRC_Continue;
4146}
4147static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00004148 UNUSED_PARAMETER(pWalker);
4149 UNUSED_PARAMETER(pSelect);
drh374fdce2012-04-17 16:38:53 +00004150 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00004151}
4152
4153/*
drhe8abb4c2012-11-02 18:24:57 +00004154** Analyze the pExpr expression looking for aggregate functions and
4155** for variables that need to be added to AggInfo object that pNC->pAggInfo
4156** points to. Additional entries are made on the AggInfo object as
4157** necessary.
drh626a8792005-01-17 22:08:19 +00004158**
4159** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00004160** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00004161*/
drhd2b3e232008-01-23 14:51:49 +00004162void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00004163 Walker w;
drh374fdce2012-04-17 16:38:53 +00004164 memset(&w, 0, sizeof(w));
drh7d10d5a2008-08-20 16:35:10 +00004165 w.xExprCallback = analyzeAggregate;
4166 w.xSelectCallback = analyzeAggregatesInSelect;
4167 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00004168 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00004169 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00004170}
drh5d9a4af2005-08-30 00:54:01 +00004171
4172/*
4173** Call sqlite3ExprAnalyzeAggregates() for every expression in an
4174** expression list. Return the number of errors.
4175**
4176** If an error is found, the analysis is cut short.
4177*/
drhd2b3e232008-01-23 14:51:49 +00004178void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00004179 struct ExprList_item *pItem;
4180 int i;
drh5d9a4af2005-08-30 00:54:01 +00004181 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00004182 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4183 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00004184 }
4185 }
drh5d9a4af2005-08-30 00:54:01 +00004186}
drh892d3172008-01-10 03:46:36 +00004187
4188/*
drhceea3322009-04-23 13:22:42 +00004189** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00004190*/
4191int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00004192 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00004193 return ++pParse->nMem;
4194 }
danielk19772f425f62008-07-04 09:41:39 +00004195 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00004196}
drhceea3322009-04-23 13:22:42 +00004197
4198/*
4199** Deallocate a register, making available for reuse for some other
4200** purpose.
4201**
4202** If a register is currently being used by the column cache, then
peter.d.reid60ec9142014-09-06 16:39:46 +00004203** the deallocation is deferred until the column cache line that uses
drhceea3322009-04-23 13:22:42 +00004204** the register becomes stale.
4205*/
drh892d3172008-01-10 03:46:36 +00004206void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00004207 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drhceea3322009-04-23 13:22:42 +00004208 int i;
4209 struct yColCache *p;
4210 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4211 if( p->iReg==iReg ){
4212 p->tempReg = 1;
4213 return;
4214 }
4215 }
drh892d3172008-01-10 03:46:36 +00004216 pParse->aTempReg[pParse->nTempReg++] = iReg;
4217 }
4218}
4219
4220/*
4221** Allocate or deallocate a block of nReg consecutive registers
4222*/
4223int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00004224 int i, n;
4225 i = pParse->iRangeReg;
4226 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00004227 if( nReg<=n ){
4228 assert( !usedAsColumnCache(pParse, i, i+n-1) );
drh892d3172008-01-10 03:46:36 +00004229 pParse->iRangeReg += nReg;
4230 pParse->nRangeReg -= nReg;
4231 }else{
4232 i = pParse->nMem+1;
4233 pParse->nMem += nReg;
4234 }
4235 return i;
4236}
4237void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhf49f3522009-12-30 14:12:38 +00004238 sqlite3ExprCacheRemove(pParse, iReg, nReg);
drh892d3172008-01-10 03:46:36 +00004239 if( nReg>pParse->nRangeReg ){
4240 pParse->nRangeReg = nReg;
4241 pParse->iRangeReg = iReg;
4242 }
4243}
drhcdc69552011-12-06 13:24:59 +00004244
4245/*
4246** Mark all temporary registers as being unavailable for reuse.
4247*/
4248void sqlite3ClearTempRegCache(Parse *pParse){
4249 pParse->nTempReg = 0;
4250 pParse->nRangeReg = 0;
4251}