blob: 5b134d666116bcc2858d982706ccd96646ce0607 [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 );
drh40aced52016-01-22 17:48:09 +000088 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +000089 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +000090}
91
92/*
drh0b8d2552015-09-05 22:36:07 +000093** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +000094** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +000095*/
96Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha4c3c872013-09-12 17:29:25 +000097 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
98 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +000099 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
100 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000101 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000102 pExpr = pExpr->x.pList->a[0].pExpr;
103 }else{
drh0b8d2552015-09-05 22:36:07 +0000104 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000105 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000106 }
drha4c3c872013-09-12 17:29:25 +0000107 }
drh0a8a4062012-12-07 18:38:16 +0000108 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000109}
110
111/*
drhae80dde2012-12-06 21:16:43 +0000112** Return the collation sequence for the expression pExpr. If
113** there is no defined collating sequence, return NULL.
114**
115** The collating sequence might be determined by a COLLATE operator
116** or by the presence of a column with a defined collating sequence.
117** COLLATE operators take first precedence. Left operands take
118** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000119*/
danielk19777cedc8d2004-06-10 10:50:08 +0000120CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000121 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000122 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000123 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000124 while( p ){
drhae80dde2012-12-06 21:16:43 +0000125 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000126 if( p->flags & EP_Generic ) break;
drhae80dde2012-12-06 21:16:43 +0000127 if( op==TK_CAST || op==TK_UPLUS ){
128 p = p->pLeft;
129 continue;
130 }
dan36e78302013-08-21 12:04:32 +0000131 if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
drh6fdd3d82013-05-15 17:47:12 +0000132 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
drhae80dde2012-12-06 21:16:43 +0000133 break;
134 }
drha58d4a92015-01-27 13:17:05 +0000135 if( (op==TK_AGG_COLUMN || op==TK_COLUMN
drhae80dde2012-12-06 21:16:43 +0000136 || op==TK_REGISTER || op==TK_TRIGGER)
drha58d4a92015-01-27 13:17:05 +0000137 && p->pTab!=0
drhae80dde2012-12-06 21:16:43 +0000138 ){
drh7d10d5a2008-08-20 16:35:10 +0000139 /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
140 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000141 int j = p->iColumn;
142 if( j>=0 ){
drhae80dde2012-12-06 21:16:43 +0000143 const char *zColl = p->pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000144 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000145 }
146 break;
danielk19770202b292004-06-09 09:55:16 +0000147 }
drhae80dde2012-12-06 21:16:43 +0000148 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000149 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000150 p = p->pLeft;
151 }else{
drh2308ed32015-02-09 16:09:34 +0000152 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000153 /* The Expr.x union is never used at the same time as Expr.pRight */
154 assert( p->x.pList==0 || p->pRight==0 );
155 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
156 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
157 ** least one EP_Collate. Thus the following two ALWAYS. */
158 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000159 int i;
drh6728cd92015-02-09 18:28:03 +0000160 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000161 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
162 pNext = p->x.pList->a[i].pExpr;
163 break;
164 }
165 }
166 }
167 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000168 }
169 }else{
drh7d10d5a2008-08-20 16:35:10 +0000170 break;
171 }
danielk19770202b292004-06-09 09:55:16 +0000172 }
danielk19777cedc8d2004-06-10 10:50:08 +0000173 if( sqlite3CheckCollSeq(pParse, pColl) ){
174 pColl = 0;
175 }
176 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000177}
178
179/*
drh626a8792005-01-17 22:08:19 +0000180** pExpr is an operand of a comparison operator. aff2 is the
181** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000182** type affinity that should be used for the comparison operator.
183*/
danielk1977e014a832004-05-17 10:48:57 +0000184char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000185 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000186 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000187 /* Both sides of the comparison are columns. If one has numeric
188 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000189 */
drh8a512562005-11-14 22:29:05 +0000190 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000191 return SQLITE_AFF_NUMERIC;
192 }else{
drh05883a32015-06-02 15:32:08 +0000193 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000194 }
195 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000196 /* Neither side of the comparison is a column. Compare the
197 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000198 */
drh05883a32015-06-02 15:32:08 +0000199 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000200 }else{
201 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000202 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000203 return (aff1 + aff2);
204 }
205}
206
drh53db1452004-05-20 13:54:53 +0000207/*
208** pExpr is a comparison operator. Return the type affinity that should
209** be applied to both operands prior to doing the comparison.
210*/
danielk1977e014a832004-05-17 10:48:57 +0000211static char comparisonAffinity(Expr *pExpr){
212 char aff;
213 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
214 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000215 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000216 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000217 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000218 if( pExpr->pRight ){
219 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000220 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
221 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
222 }else if( !aff ){
drh05883a32015-06-02 15:32:08 +0000223 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000224 }
225 return aff;
226}
227
228/*
229** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
230** idx_affinity is the affinity of an indexed column. Return true
231** if the index with affinity idx_affinity may be used to implement
232** the comparison in pExpr.
233*/
234int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
235 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000236 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000237 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000238 return 1;
239 case SQLITE_AFF_TEXT:
240 return idx_affinity==SQLITE_AFF_TEXT;
241 default:
242 return sqlite3IsNumericAffinity(idx_affinity);
243 }
danielk1977e014a832004-05-17 10:48:57 +0000244}
245
danielk1977a37cdde2004-05-16 11:15:36 +0000246/*
drh35573352008-01-08 23:54:25 +0000247** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000248** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000249*/
drh35573352008-01-08 23:54:25 +0000250static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
251 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000252 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000253 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000254}
255
drha2e00042002-01-22 03:13:42 +0000256/*
danielk19770202b292004-06-09 09:55:16 +0000257** Return a pointer to the collation sequence that should be used by
258** a binary comparison operator comparing pLeft and pRight.
259**
260** If the left hand expression has a collating sequence type, then it is
261** used. Otherwise the collation sequence for the right hand expression
262** is used, or the default (BINARY) if neither expression has a collating
263** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000264**
265** Argument pRight (but not pLeft) may be a null pointer. In this case,
266** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000267*/
drh0a0e1312007-08-07 17:04:59 +0000268CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000269 Parse *pParse,
270 Expr *pLeft,
271 Expr *pRight
272){
drhec41dda2007-02-07 13:09:45 +0000273 CollSeq *pColl;
274 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000275 if( pLeft->flags & EP_Collate ){
276 pColl = sqlite3ExprCollSeq(pParse, pLeft);
277 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
278 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000279 }else{
280 pColl = sqlite3ExprCollSeq(pParse, pLeft);
281 if( !pColl ){
282 pColl = sqlite3ExprCollSeq(pParse, pRight);
283 }
danielk19770202b292004-06-09 09:55:16 +0000284 }
285 return pColl;
286}
287
288/*
drhbe5c89a2004-07-26 00:31:09 +0000289** Generate code for a comparison operator.
290*/
291static int codeCompare(
292 Parse *pParse, /* The parsing (and code generating) context */
293 Expr *pLeft, /* The left operand */
294 Expr *pRight, /* The right operand */
295 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000296 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000297 int dest, /* Jump here if true. */
298 int jumpIfNull /* If true, jump if either operand is NULL */
299){
drh35573352008-01-08 23:54:25 +0000300 int p5;
301 int addr;
302 CollSeq *p4;
303
304 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
305 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
306 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
307 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000308 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000309 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000310}
311
danielk19774b5255a2008-06-05 16:47:39 +0000312#if SQLITE_MAX_EXPR_DEPTH>0
313/*
314** Check that argument nHeight is less than or equal to the maximum
315** expression depth allowed. If it is not, leave an error message in
316** pParse.
317*/
drh7d10d5a2008-08-20 16:35:10 +0000318int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000319 int rc = SQLITE_OK;
320 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
321 if( nHeight>mxHeight ){
322 sqlite3ErrorMsg(pParse,
323 "Expression tree is too large (maximum depth %d)", mxHeight
324 );
325 rc = SQLITE_ERROR;
326 }
327 return rc;
328}
329
330/* The following three functions, heightOfExpr(), heightOfExprList()
331** and heightOfSelect(), are used to determine the maximum height
332** of any expression tree referenced by the structure passed as the
333** first argument.
334**
335** If this maximum height is greater than the current value pointed
336** to by pnHeight, the second parameter, then set *pnHeight to that
337** value.
338*/
339static void heightOfExpr(Expr *p, int *pnHeight){
340 if( p ){
341 if( p->nHeight>*pnHeight ){
342 *pnHeight = p->nHeight;
343 }
344 }
345}
346static void heightOfExprList(ExprList *p, int *pnHeight){
347 if( p ){
348 int i;
349 for(i=0; i<p->nExpr; i++){
350 heightOfExpr(p->a[i].pExpr, pnHeight);
351 }
352 }
353}
354static void heightOfSelect(Select *p, int *pnHeight){
355 if( p ){
356 heightOfExpr(p->pWhere, pnHeight);
357 heightOfExpr(p->pHaving, pnHeight);
358 heightOfExpr(p->pLimit, pnHeight);
359 heightOfExpr(p->pOffset, pnHeight);
360 heightOfExprList(p->pEList, pnHeight);
361 heightOfExprList(p->pGroupBy, pnHeight);
362 heightOfExprList(p->pOrderBy, pnHeight);
363 heightOfSelect(p->pPrior, pnHeight);
364 }
365}
366
367/*
368** Set the Expr.nHeight variable in the structure passed as an
369** argument. An expression with no children, Expr.pList or
370** Expr.pSelect member has a height of 1. Any other expression
371** has a height equal to the maximum height of any other
372** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000373**
374** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
375** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000376*/
377static void exprSetHeight(Expr *p){
378 int nHeight = 0;
379 heightOfExpr(p->pLeft, &nHeight);
380 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000381 if( ExprHasProperty(p, EP_xIsSelect) ){
382 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000383 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000384 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000385 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000386 }
danielk19774b5255a2008-06-05 16:47:39 +0000387 p->nHeight = nHeight + 1;
388}
389
390/*
391** Set the Expr.nHeight variable using the exprSetHeight() function. If
392** the height is greater than the maximum allowed expression depth,
393** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000394**
395** Also propagate all EP_Propagate flags from the Expr.x.pList into
396** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000397*/
drh2308ed32015-02-09 16:09:34 +0000398void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000399 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000400 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000401 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000402}
403
404/*
405** Return the maximum height of any expression tree referenced
406** by the select statement passed as an argument.
407*/
408int sqlite3SelectExprHeight(Select *p){
409 int nHeight = 0;
410 heightOfSelect(p, &nHeight);
411 return nHeight;
412}
drh2308ed32015-02-09 16:09:34 +0000413#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
414/*
415** Propagate all EP_Propagate flags from the Expr.x.pList into
416** Expr.flags.
417*/
418void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
419 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
420 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
421 }
422}
423#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000424#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
425
drhbe5c89a2004-07-26 00:31:09 +0000426/*
drhb7916a72009-05-27 10:31:29 +0000427** This routine is the core allocator for Expr nodes.
428**
drha76b5df2002-02-23 02:32:10 +0000429** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000430** for this node and for the pToken argument is a single allocation
431** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000432** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000433**
434** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000435** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000436** parameter is ignored if pToken is NULL or if the token does not
437** appear to be quoted. If the quotes were of the form "..." (double-quotes)
438** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000439**
440** Special case: If op==TK_INTEGER and pToken points to a string that
441** can be translated into a 32-bit integer, then the token is not
442** stored in u.zToken. Instead, the integer values is written
443** into u.iValue and the EP_IntValue flag is set. No extra storage
444** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000445*/
drhb7916a72009-05-27 10:31:29 +0000446Expr *sqlite3ExprAlloc(
danielk1977a1644fd2007-08-29 12:31:25 +0000447 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
drh17435752007-08-16 04:30:38 +0000448 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000449 const Token *pToken, /* Token argument. Might be NULL */
450 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000451){
drha76b5df2002-02-23 02:32:10 +0000452 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000453 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000454 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000455
drhb7916a72009-05-27 10:31:29 +0000456 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000457 if( op!=TK_INTEGER || pToken->z==0
458 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
459 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000460 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000461 }
drhb7916a72009-05-27 10:31:29 +0000462 }
drhca3862d2016-01-08 12:46:39 +0000463 pNew = sqlite3DbMallocRaw(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000464 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000465 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000466 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]));
drh4a642b62016-02-05 01:55:27 +0000702 if( a==0 ){
703 assert( db->mallocFailed ); /* Error reported through mallocFailed */
704 return;
705 }
drh124c0b42011-06-01 18:15:55 +0000706 pParse->azVar = a;
707 memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
708 pParse->nzVar = x;
drhfa6bc002004-09-07 16:19:52 +0000709 }
drh124c0b42011-06-01 18:15:55 +0000710 if( z[0]!='?' || pParse->azVar[x-1]==0 ){
711 sqlite3DbFree(db, pParse->azVar[x-1]);
712 pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
drhfa6bc002004-09-07 16:19:52 +0000713 }
714 }
715 }
drhbb4957f2008-03-20 14:03:29 +0000716 if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +0000717 sqlite3ErrorMsg(pParse, "too many SQL variables");
718 }
drhfa6bc002004-09-07 16:19:52 +0000719}
720
721/*
danf6963f92009-11-23 14:39:14 +0000722** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +0000723*/
danf6963f92009-11-23 14:39:14 +0000724void sqlite3ExprDelete(sqlite3 *db, Expr *p){
725 if( p==0 ) return;
drhd50ffc42011-03-08 02:38:28 +0000726 /* Sanity check: Assert that the IntValue is non-negative if it exists */
727 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drhc5cd1242013-09-12 16:50:49 +0000728 if( !ExprHasProperty(p, EP_TokenOnly) ){
729 /* The Expr.x union is never used at the same time as Expr.pRight */
730 assert( p->x.pList==0 || p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +0000731 sqlite3ExprDelete(db, p->pLeft);
732 sqlite3ExprDelete(db, p->pRight);
drhc5cd1242013-09-12 16:50:49 +0000733 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
danielk19776ab3a2e2009-02-19 14:39:25 +0000734 if( ExprHasProperty(p, EP_xIsSelect) ){
735 sqlite3SelectDelete(db, p->x.pSelect);
736 }else{
737 sqlite3ExprListDelete(db, p->x.pList);
738 }
739 }
drh33e619f2009-05-28 01:00:55 +0000740 if( !ExprHasProperty(p, EP_Static) ){
741 sqlite3DbFree(db, p);
742 }
drha2e00042002-01-22 03:13:42 +0000743}
744
drhd2687b72005-08-12 22:56:09 +0000745/*
danielk19776ab3a2e2009-02-19 14:39:25 +0000746** Return the number of bytes allocated for the expression structure
747** passed as the first argument. This is always one of EXPR_FULLSIZE,
748** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
749*/
750static int exprStructSize(Expr *p){
751 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +0000752 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
753 return EXPR_FULLSIZE;
754}
755
756/*
drh33e619f2009-05-28 01:00:55 +0000757** The dupedExpr*Size() routines each return the number of bytes required
758** to store a copy of an expression or expression tree. They differ in
759** how much of the tree is measured.
760**
761** dupedExprStructSize() Size of only the Expr structure
762** dupedExprNodeSize() Size of Expr + space for token
763** dupedExprSize() Expr + token + subtree components
764**
765***************************************************************************
766**
767** The dupedExprStructSize() function returns two values OR-ed together:
768** (1) the space required for a copy of the Expr structure only and
769** (2) the EP_xxx flags that indicate what the structure size should be.
770** The return values is always one of:
771**
772** EXPR_FULLSIZE
773** EXPR_REDUCEDSIZE | EP_Reduced
774** EXPR_TOKENONLYSIZE | EP_TokenOnly
775**
776** The size of the structure can be found by masking the return value
777** of this routine with 0xfff. The flags can be found by masking the
778** return value with EP_Reduced|EP_TokenOnly.
779**
780** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
781** (unreduced) Expr objects as they or originally constructed by the parser.
782** During expression analysis, extra information is computed and moved into
783** later parts of teh Expr object and that extra information might get chopped
784** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +0000785** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +0000786** to reduce a pristine expression tree from the parser. The implementation
787** of dupedExprStructSize() contain multiple assert() statements that attempt
788** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +0000789*/
790static int dupedExprStructSize(Expr *p, int flags){
791 int nSize;
drh33e619f2009-05-28 01:00:55 +0000792 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +0000793 assert( EXPR_FULLSIZE<=0xfff );
794 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +0000795 if( 0==(flags&EXPRDUP_REDUCE) ){
796 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +0000797 }else{
drhc5cd1242013-09-12 16:50:49 +0000798 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +0000799 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +0000800 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +0000801 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +0000802 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +0000803 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
804 }else{
drhaecd8022013-09-13 18:15:15 +0000805 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +0000806 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
807 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000808 }
809 return nSize;
810}
811
812/*
drh33e619f2009-05-28 01:00:55 +0000813** This function returns the space in bytes required to store the copy
814** of the Expr structure and a copy of the Expr.u.zToken string (if that
815** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +0000816*/
817static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +0000818 int nByte = dupedExprStructSize(p, flags) & 0xfff;
819 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
820 nByte += sqlite3Strlen30(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +0000821 }
danielk1977bc739712009-03-23 04:33:32 +0000822 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +0000823}
824
825/*
826** Return the number of bytes required to create a duplicate of the
827** expression passed as the first argument. The second argument is a
828** mask containing EXPRDUP_XXX flags.
829**
830** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +0000831** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +0000832**
833** If the EXPRDUP_REDUCE flag is set, then the return value includes
834** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
835** and Expr.pRight variables (but not for any structures pointed to or
836** descended from the Expr.x.pList or Expr.x.pSelect variables).
837*/
838static int dupedExprSize(Expr *p, int flags){
839 int nByte = 0;
840 if( p ){
841 nByte = dupedExprNodeSize(p, flags);
842 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +0000843 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +0000844 }
845 }
846 return nByte;
847}
848
849/*
850** This function is similar to sqlite3ExprDup(), except that if pzBuffer
851** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +0000852** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +0000853** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +0000854** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +0000855** portion of the buffer copied into by this function.
856*/
857static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
858 Expr *pNew = 0; /* Value to return */
drh72ea29d2015-12-08 16:58:45 +0000859 assert( flags==0 || flags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +0000860 if( p ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000861 const int isReduced = (flags&EXPRDUP_REDUCE);
862 u8 *zAlloc;
drh33e619f2009-05-28 01:00:55 +0000863 u32 staticFlag = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +0000864
865 assert( pzBuffer==0 || isReduced );
866
867 /* Figure out where to write the new Expr structure. */
868 if( pzBuffer ){
869 zAlloc = *pzBuffer;
drh33e619f2009-05-28 01:00:55 +0000870 staticFlag = EP_Static;
danielk19776ab3a2e2009-02-19 14:39:25 +0000871 }else{
872 zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
873 }
874 pNew = (Expr *)zAlloc;
875
876 if( pNew ){
877 /* Set nNewSize to the size allocated for the structure pointed to
878 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
879 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
drh33e619f2009-05-28 01:00:55 +0000880 ** by the copy of the p->u.zToken string (if any).
danielk19776ab3a2e2009-02-19 14:39:25 +0000881 */
drh33e619f2009-05-28 01:00:55 +0000882 const unsigned nStructSize = dupedExprStructSize(p, flags);
883 const int nNewSize = nStructSize & 0xfff;
884 int nToken;
885 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
886 nToken = sqlite3Strlen30(p->u.zToken) + 1;
887 }else{
888 nToken = 0;
889 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000890 if( isReduced ){
891 assert( ExprHasProperty(p, EP_Reduced)==0 );
892 memcpy(zAlloc, p, nNewSize);
893 }else{
dan3e6a1412015-12-23 16:42:27 +0000894 u32 nSize = (u32)exprStructSize(p);
danielk19776ab3a2e2009-02-19 14:39:25 +0000895 memcpy(zAlloc, p, nSize);
drh72ea29d2015-12-08 16:58:45 +0000896 if( nSize<EXPR_FULLSIZE ){
897 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
898 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000899 }
900
drh33e619f2009-05-28 01:00:55 +0000901 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
drhc5cd1242013-09-12 16:50:49 +0000902 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
drh33e619f2009-05-28 01:00:55 +0000903 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
904 pNew->flags |= staticFlag;
danielk19776ab3a2e2009-02-19 14:39:25 +0000905
drh33e619f2009-05-28 01:00:55 +0000906 /* Copy the p->u.zToken string, if any. */
danielk19776ab3a2e2009-02-19 14:39:25 +0000907 if( nToken ){
drh33e619f2009-05-28 01:00:55 +0000908 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
909 memcpy(zToken, p->u.zToken, nToken);
danielk19776ab3a2e2009-02-19 14:39:25 +0000910 }
911
912 if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000913 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
914 if( ExprHasProperty(p, EP_xIsSelect) ){
915 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
916 }else{
917 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
918 }
919 }
920
921 /* Fill in pNew->pLeft and pNew->pRight. */
drhc5cd1242013-09-12 16:50:49 +0000922 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000923 zAlloc += dupedExprNodeSize(p, flags);
924 if( ExprHasProperty(pNew, EP_Reduced) ){
925 pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
926 pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
927 }
928 if( pzBuffer ){
929 *pzBuffer = zAlloc;
930 }
drhb7916a72009-05-27 10:31:29 +0000931 }else{
drhc5cd1242013-09-12 16:50:49 +0000932 if( !ExprHasProperty(p, EP_TokenOnly) ){
drhb7916a72009-05-27 10:31:29 +0000933 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
934 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
935 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000936 }
drhb7916a72009-05-27 10:31:29 +0000937
danielk19776ab3a2e2009-02-19 14:39:25 +0000938 }
939 }
940 return pNew;
941}
942
943/*
danbfe31e72014-01-15 14:17:31 +0000944** Create and return a deep copy of the object passed as the second
945** argument. If an OOM condition is encountered, NULL is returned
946** and the db->mallocFailed flag set.
947*/
daneede6a52014-01-15 19:42:23 +0000948#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +0000949static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +0000950 With *pRet = 0;
951 if( p ){
952 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
953 pRet = sqlite3DbMallocZero(db, nByte);
954 if( pRet ){
955 int i;
956 pRet->nCte = p->nCte;
957 for(i=0; i<p->nCte; i++){
958 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
959 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
960 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
961 }
962 }
963 }
964 return pRet;
965}
daneede6a52014-01-15 19:42:23 +0000966#else
967# define withDup(x,y) 0
968#endif
dan4e9119d2014-01-13 15:12:23 +0000969
drha76b5df2002-02-23 02:32:10 +0000970/*
drhff78bd22002-02-27 01:47:11 +0000971** The following group of routines make deep copies of expressions,
972** expression lists, ID lists, and select statements. The copies can
973** be deleted (by being passed to their respective ...Delete() routines)
974** without effecting the originals.
975**
danielk19774adee202004-05-08 08:23:19 +0000976** The expression list, ID, and source lists return by sqlite3ExprListDup(),
977** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +0000978** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +0000979**
drhad3cab52002-05-24 02:04:32 +0000980** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +0000981**
drhb7916a72009-05-27 10:31:29 +0000982** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +0000983** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
984** truncated version of the usual Expr structure that will be stored as
985** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +0000986*/
danielk19776ab3a2e2009-02-19 14:39:25 +0000987Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +0000988 assert( flags==0 || flags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +0000989 return exprDup(db, p, flags, 0);
drhff78bd22002-02-27 01:47:11 +0000990}
danielk19776ab3a2e2009-02-19 14:39:25 +0000991ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +0000992 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +0000993 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +0000994 int i;
995 if( p==0 ) return 0;
drh17435752007-08-16 04:30:38 +0000996 pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +0000997 if( pNew==0 ) return 0;
drhd872bb12012-02-02 01:58:08 +0000998 pNew->nExpr = i = p->nExpr;
999 if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
1000 pNew->a = pItem = sqlite3DbMallocRaw(db, i*sizeof(p->a[0]) );
danielk1977e0048402004-06-15 16:51:01 +00001001 if( pItem==0 ){
drh633e6d52008-07-28 19:34:53 +00001002 sqlite3DbFree(db, pNew);
danielk1977e0048402004-06-15 16:51:01 +00001003 return 0;
1004 }
drh145716b2004-09-24 12:24:06 +00001005 pOldItem = p->a;
1006 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001007 Expr *pOldExpr = pOldItem->pExpr;
drhb5526ea2009-07-16 12:41:05 +00001008 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh17435752007-08-16 04:30:38 +00001009 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001010 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001011 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001012 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001013 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
drhc2acc4e2013-11-15 18:15:19 +00001014 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001015 }
1016 return pNew;
1017}
danielk197793758c82005-01-21 08:13:14 +00001018
1019/*
1020** If cursors, triggers, views and subqueries are all omitted from
1021** the build, then none of the following routines, except for
1022** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1023** called with a NULL argument.
1024*/
danielk19776a67fe82005-02-04 04:07:16 +00001025#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1026 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001027SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001028 SrcList *pNew;
1029 int i;
drh113088e2003-03-20 01:16:58 +00001030 int nByte;
drhad3cab52002-05-24 02:04:32 +00001031 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001032 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh17435752007-08-16 04:30:38 +00001033 pNew = sqlite3DbMallocRaw(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001034 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001035 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001036 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001037 struct SrcList_item *pNewItem = &pNew->a[i];
1038 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001039 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001040 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001041 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1042 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1043 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001044 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001045 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001046 pNewItem->addrFillSub = pOldItem->addrFillSub;
1047 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001048 if( pNewItem->fg.isIndexedBy ){
1049 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1050 }
1051 pNewItem->pIBIndex = pOldItem->pIBIndex;
1052 if( pNewItem->fg.isTabFunc ){
1053 pNewItem->u1.pFuncArg =
1054 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1055 }
drhed8a3bb2005-06-06 21:19:56 +00001056 pTab = pNewItem->pTab = pOldItem->pTab;
1057 if( pTab ){
1058 pTab->nRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001059 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001060 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1061 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001062 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001063 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001064 }
1065 return pNew;
1066}
drh17435752007-08-16 04:30:38 +00001067IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001068 IdList *pNew;
1069 int i;
1070 if( p==0 ) return 0;
drh17435752007-08-16 04:30:38 +00001071 pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001072 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001073 pNew->nId = p->nId;
drh17435752007-08-16 04:30:38 +00001074 pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001075 if( pNew->a==0 ){
drh633e6d52008-07-28 19:34:53 +00001076 sqlite3DbFree(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001077 return 0;
1078 }
drh6c535152012-02-02 03:38:30 +00001079 /* Note that because the size of the allocation for p->a[] is not
1080 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1081 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001082 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001083 struct IdList_item *pNewItem = &pNew->a[i];
1084 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001085 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001086 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001087 }
1088 return pNew;
1089}
danielk19776ab3a2e2009-02-19 14:39:25 +00001090Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
drh23b1b372011-12-07 01:55:51 +00001091 Select *pNew, *pPrior;
drhff78bd22002-02-27 01:47:11 +00001092 if( p==0 ) return 0;
drh17435752007-08-16 04:30:38 +00001093 pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
drhff78bd22002-02-27 01:47:11 +00001094 if( pNew==0 ) return 0;
drhb7916a72009-05-27 10:31:29 +00001095 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001096 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1097 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1098 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1099 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1100 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
drhff78bd22002-02-27 01:47:11 +00001101 pNew->op = p->op;
drh23b1b372011-12-07 01:55:51 +00001102 pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
1103 if( pPrior ) pPrior->pNext = pNew;
1104 pNew->pNext = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001105 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
1106 pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
drh92b01d52008-06-24 00:32:35 +00001107 pNew->iLimit = 0;
1108 pNew->iOffset = 0;
drh7d10d5a2008-08-20 16:35:10 +00001109 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
drhb9bb7c12006-06-11 23:41:55 +00001110 pNew->addrOpenEphm[0] = -1;
1111 pNew->addrOpenEphm[1] = -1;
drhec2da852014-01-29 01:46:12 +00001112 pNew->nSelectRow = p->nSelectRow;
dan4e9119d2014-01-13 15:12:23 +00001113 pNew->pWith = withDup(db, p->pWith);
drheb9b8842014-09-21 00:27:26 +00001114 sqlite3SelectSetName(pNew, p->zSelName);
drhff78bd22002-02-27 01:47:11 +00001115 return pNew;
1116}
danielk197793758c82005-01-21 08:13:14 +00001117#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001118Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001119 assert( p==0 );
1120 return 0;
1121}
1122#endif
drhff78bd22002-02-27 01:47:11 +00001123
1124
1125/*
drha76b5df2002-02-23 02:32:10 +00001126** Add a new element to the end of an expression list. If pList is
1127** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001128**
1129** If a memory allocation error occurs, the entire list is freed and
1130** NULL is returned. If non-NULL is returned, then it is guaranteed
1131** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001132*/
drh17435752007-08-16 04:30:38 +00001133ExprList *sqlite3ExprListAppend(
1134 Parse *pParse, /* Parsing context */
1135 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001136 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001137){
1138 sqlite3 *db = pParse->db;
drha76b5df2002-02-23 02:32:10 +00001139 if( pList==0 ){
drhc263f7c2016-01-18 13:18:54 +00001140 pList = sqlite3DbMallocRaw(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001141 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001142 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001143 }
drhc263f7c2016-01-18 13:18:54 +00001144 pList->nExpr = 0;
drhd872bb12012-02-02 01:58:08 +00001145 pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1146 if( pList->a==0 ) goto no_mem;
1147 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001148 struct ExprList_item *a;
drhd872bb12012-02-02 01:58:08 +00001149 assert( pList->nExpr>0 );
1150 a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
danielk1977d5d56522005-03-16 12:15:20 +00001151 if( a==0 ){
1152 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001153 }
danielk1977d5d56522005-03-16 12:15:20 +00001154 pList->a = a;
drha76b5df2002-02-23 02:32:10 +00001155 }
drh4efc4752004-01-16 15:55:37 +00001156 assert( pList->a!=0 );
drhb7916a72009-05-27 10:31:29 +00001157 if( 1 ){
drh4efc4752004-01-16 15:55:37 +00001158 struct ExprList_item *pItem = &pList->a[pList->nExpr++];
1159 memset(pItem, 0, sizeof(*pItem));
danielk1977e94ddc92005-03-21 03:53:38 +00001160 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001161 }
1162 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001163
1164no_mem:
1165 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001166 sqlite3ExprDelete(db, pExpr);
1167 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001168 return 0;
drha76b5df2002-02-23 02:32:10 +00001169}
1170
1171/*
drhbc622bc2015-08-24 15:39:42 +00001172** Set the sort order for the last element on the given ExprList.
1173*/
1174void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1175 if( p==0 ) return;
1176 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1177 assert( p->nExpr>0 );
1178 if( iSortOrder<0 ){
1179 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1180 return;
1181 }
1182 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001183}
1184
1185/*
drhb7916a72009-05-27 10:31:29 +00001186** Set the ExprList.a[].zName element of the most recently added item
1187** on the expression list.
1188**
1189** pList might be NULL following an OOM error. But pName should never be
1190** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1191** is set.
1192*/
1193void sqlite3ExprListSetName(
1194 Parse *pParse, /* Parsing context */
1195 ExprList *pList, /* List to which to add the span. */
1196 Token *pName, /* Name to be added */
1197 int dequote /* True to cause the name to be dequoted */
1198){
1199 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1200 if( pList ){
1201 struct ExprList_item *pItem;
1202 assert( pList->nExpr>0 );
1203 pItem = &pList->a[pList->nExpr-1];
1204 assert( pItem->zName==0 );
1205 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1206 if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1207 }
1208}
1209
1210/*
1211** Set the ExprList.a[].zSpan element of the most recently added item
1212** on the expression list.
1213**
1214** pList might be NULL following an OOM error. But pSpan should never be
1215** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1216** is set.
1217*/
1218void sqlite3ExprListSetSpan(
1219 Parse *pParse, /* Parsing context */
1220 ExprList *pList, /* List to which to add the span. */
1221 ExprSpan *pSpan /* The span to be added */
1222){
1223 sqlite3 *db = pParse->db;
1224 assert( pList!=0 || db->mallocFailed!=0 );
1225 if( pList ){
1226 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1227 assert( pList->nExpr>0 );
1228 assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1229 sqlite3DbFree(db, pItem->zSpan);
1230 pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
shanecf697392009-06-01 16:53:09 +00001231 (int)(pSpan->zEnd - pSpan->zStart));
drhb7916a72009-05-27 10:31:29 +00001232 }
1233}
1234
1235/*
danielk19777a15a4b2007-05-08 17:54:43 +00001236** If the expression list pEList contains more than iLimit elements,
1237** leave an error message in pParse.
1238*/
1239void sqlite3ExprListCheckLength(
1240 Parse *pParse,
1241 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001242 const char *zObject
1243){
drhb1a6c3c2008-03-20 16:30:17 +00001244 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001245 testcase( pEList && pEList->nExpr==mx );
1246 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001247 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001248 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1249 }
1250}
1251
1252/*
drha76b5df2002-02-23 02:32:10 +00001253** Delete an entire expression list.
1254*/
drh633e6d52008-07-28 19:34:53 +00001255void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
drha76b5df2002-02-23 02:32:10 +00001256 int i;
drhbe5c89a2004-07-26 00:31:09 +00001257 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001258 if( pList==0 ) return;
drhd872bb12012-02-02 01:58:08 +00001259 assert( pList->a!=0 || pList->nExpr==0 );
drhbe5c89a2004-07-26 00:31:09 +00001260 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
drh633e6d52008-07-28 19:34:53 +00001261 sqlite3ExprDelete(db, pItem->pExpr);
1262 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001263 sqlite3DbFree(db, pItem->zSpan);
drha76b5df2002-02-23 02:32:10 +00001264 }
drh633e6d52008-07-28 19:34:53 +00001265 sqlite3DbFree(db, pList->a);
1266 sqlite3DbFree(db, pList);
drha76b5df2002-02-23 02:32:10 +00001267}
1268
1269/*
drh2308ed32015-02-09 16:09:34 +00001270** Return the bitwise-OR of all Expr.flags fields in the given
1271** ExprList.
drh885a5b02015-02-09 15:21:36 +00001272*/
drh2308ed32015-02-09 16:09:34 +00001273u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001274 int i;
drh2308ed32015-02-09 16:09:34 +00001275 u32 m = 0;
1276 if( pList ){
1277 for(i=0; i<pList->nExpr; i++){
drhd0c73052015-04-19 19:21:19 +00001278 Expr *pExpr = pList->a[i].pExpr;
drh0a969312015-05-05 16:57:52 +00001279 if( ALWAYS(pExpr) ) m |= pExpr->flags;
drh2308ed32015-02-09 16:09:34 +00001280 }
drh885a5b02015-02-09 15:21:36 +00001281 }
drh2308ed32015-02-09 16:09:34 +00001282 return m;
drh885a5b02015-02-09 15:21:36 +00001283}
1284
1285/*
drh059b2d52014-10-24 19:28:09 +00001286** These routines are Walker callbacks used to check expressions to
1287** see if they are "constant" for some definition of constant. The
1288** Walker.eCode value determines the type of "constant" we are looking
1289** for.
drh73b211a2005-01-18 04:00:42 +00001290**
drh7d10d5a2008-08-20 16:35:10 +00001291** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001292**
drh059b2d52014-10-24 19:28:09 +00001293** sqlite3ExprIsConstant() pWalker->eCode==1
1294** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001295** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001296** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001297**
drh059b2d52014-10-24 19:28:09 +00001298** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1299** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001300**
drhfeada2d2014-09-24 13:20:22 +00001301** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001302** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1303** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001304** parameter raises an error for new statements, but is silently converted
1305** to NULL for existing schemas. This allows sqlite_master tables that
1306** contain a bound parameter because they were generated by older versions
1307** of SQLite to be parsed by newer versions of SQLite without raising a
1308** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001309*/
drh7d10d5a2008-08-20 16:35:10 +00001310static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001311
drh059b2d52014-10-24 19:28:09 +00001312 /* If pWalker->eCode is 2 then any term of the expression that comes from
1313 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001314 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001315 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1316 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001317 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001318 }
1319
drh626a8792005-01-17 22:08:19 +00001320 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001321 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001322 ** and either pWalker->eCode==4 or 5 or the function has the
1323 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001324 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001325 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001326 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001327 }else{
1328 pWalker->eCode = 0;
1329 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001330 }
drh626a8792005-01-17 22:08:19 +00001331 case TK_ID:
1332 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001333 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001334 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001335 testcase( pExpr->op==TK_ID );
1336 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001337 testcase( pExpr->op==TK_AGG_FUNCTION );
1338 testcase( pExpr->op==TK_AGG_COLUMN );
drh059b2d52014-10-24 19:28:09 +00001339 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1340 return WRC_Continue;
1341 }else{
1342 pWalker->eCode = 0;
1343 return WRC_Abort;
1344 }
drhfeada2d2014-09-24 13:20:22 +00001345 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001346 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001347 /* Silently convert bound parameters that appear inside of CREATE
1348 ** statements into a NULL when parsing the CREATE statement text out
1349 ** of the sqlite_master table */
1350 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001351 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001352 /* A bound parameter in a CREATE statement that originates from
1353 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001354 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001355 return WRC_Abort;
1356 }
1357 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001358 default:
drhb74b1012009-05-28 21:04:37 +00001359 testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1360 testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
drh7d10d5a2008-08-20 16:35:10 +00001361 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001362 }
1363}
danielk197762c14b32008-11-19 09:05:26 +00001364static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
1365 UNUSED_PARAMETER(NotUsed);
drh059b2d52014-10-24 19:28:09 +00001366 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001367 return WRC_Abort;
1368}
drh059b2d52014-10-24 19:28:09 +00001369static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001370 Walker w;
drhaa87f9a2013-04-25 00:57:10 +00001371 memset(&w, 0, sizeof(w));
drh059b2d52014-10-24 19:28:09 +00001372 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001373 w.xExprCallback = exprNodeIsConstant;
1374 w.xSelectCallback = selectNodeIsConstant;
drh059b2d52014-10-24 19:28:09 +00001375 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001376 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001377 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001378}
drh626a8792005-01-17 22:08:19 +00001379
1380/*
drh059b2d52014-10-24 19:28:09 +00001381** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001382** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001383**
1384** For the purposes of this function, a double-quoted string (ex: "abc")
1385** is considered a variable but a single-quoted string (ex: 'abc') is
1386** a constant.
drhfef52082000-06-06 01:50:43 +00001387*/
danielk19774adee202004-05-08 08:23:19 +00001388int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001389 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001390}
1391
1392/*
drh059b2d52014-10-24 19:28:09 +00001393** Walk an expression tree. Return non-zero if the expression is constant
drh0a168372007-06-08 00:20:47 +00001394** that does no originate from the ON or USING clauses of a join.
1395** Return 0 if it involves variables or function calls or terms from
1396** an ON or USING clause.
1397*/
1398int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001399 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001400}
1401
1402/*
drhfcb9f4f2015-06-01 18:13:16 +00001403** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001404** for any single row of the table with cursor iCur. In other words, the
1405** expression must not refer to any non-deterministic function nor any
1406** table other than iCur.
1407*/
1408int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1409 return exprIsConst(p, 3, iCur);
1410}
1411
1412/*
1413** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001414** or a function call with constant arguments. Return and 0 if there
1415** are any variables.
1416**
1417** For the purposes of this function, a double-quoted string (ex: "abc")
1418** is considered a variable but a single-quoted string (ex: 'abc') is
1419** a constant.
1420*/
drhfeada2d2014-09-24 13:20:22 +00001421int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1422 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00001423 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00001424}
1425
drh5b88bc42013-12-07 23:35:21 +00001426#ifdef SQLITE_ENABLE_CURSOR_HINTS
1427/*
1428** Walk an expression tree. Return 1 if the expression contains a
1429** subquery of some kind. Return 0 if there are no subqueries.
1430*/
1431int sqlite3ExprContainsSubquery(Expr *p){
1432 Walker w;
1433 memset(&w, 0, sizeof(w));
drhbec24762015-08-13 20:07:13 +00001434 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00001435 w.xExprCallback = sqlite3ExprWalkNoop;
1436 w.xSelectCallback = selectNodeIsConstant;
1437 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00001438 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00001439}
1440#endif
1441
drheb55bd22005-06-30 17:04:21 +00001442/*
drh73b211a2005-01-18 04:00:42 +00001443** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00001444** to fit in a 32-bit integer, return 1 and put the value of the integer
1445** in *pValue. If the expression is not an integer or if it is too big
1446** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00001447*/
danielk19774adee202004-05-08 08:23:19 +00001448int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00001449 int rc = 0;
drhcd92e842011-02-17 15:58:20 +00001450
1451 /* If an expression is an integer literal that fits in a signed 32-bit
1452 ** integer, then the EP_IntValue flag will have already been set */
1453 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1454 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1455
drh92b01d52008-06-24 00:32:35 +00001456 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00001457 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00001458 return 1;
1459 }
drhe4de1fe2002-06-02 16:09:01 +00001460 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00001461 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00001462 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00001463 break;
drh4b59ab52002-08-24 18:24:51 +00001464 }
drhe4de1fe2002-06-02 16:09:01 +00001465 case TK_UMINUS: {
1466 int v;
danielk19774adee202004-05-08 08:23:19 +00001467 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00001468 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00001469 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00001470 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00001471 }
1472 break;
1473 }
1474 default: break;
1475 }
drh92b01d52008-06-24 00:32:35 +00001476 return rc;
drhe4de1fe2002-06-02 16:09:01 +00001477}
1478
1479/*
drh039fc322009-11-17 18:31:47 +00001480** Return FALSE if there is no chance that the expression can be NULL.
1481**
1482** If the expression might be NULL or if the expression is too complex
1483** to tell return TRUE.
1484**
1485** This routine is used as an optimization, to skip OP_IsNull opcodes
1486** when we know that a value cannot be NULL. Hence, a false positive
1487** (returning TRUE when in fact the expression can never be NULL) might
1488** be a small performance hit but is otherwise harmless. On the other
1489** hand, a false negative (returning FALSE when the result could be NULL)
1490** will likely result in an incorrect answer. So when in doubt, return
1491** TRUE.
1492*/
1493int sqlite3ExprCanBeNull(const Expr *p){
1494 u8 op;
drhcd7f4572009-11-19 14:48:40 +00001495 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00001496 op = p->op;
1497 if( op==TK_REGISTER ) op = p->op2;
1498 switch( op ){
1499 case TK_INTEGER:
1500 case TK_STRING:
1501 case TK_FLOAT:
1502 case TK_BLOB:
1503 return 0;
drh7248a8b2014-08-04 18:50:54 +00001504 case TK_COLUMN:
1505 assert( p->pTab!=0 );
drh72673a22014-12-04 16:27:17 +00001506 return ExprHasProperty(p, EP_CanBeNull) ||
1507 (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00001508 default:
1509 return 1;
1510 }
1511}
1512
1513/*
1514** Return TRUE if the given expression is a constant which would be
1515** unchanged by OP_Affinity with the affinity given in the second
1516** argument.
1517**
1518** This routine is used to determine if the OP_Affinity operation
1519** can be omitted. When in doubt return FALSE. A false negative
1520** is harmless. A false positive, however, can result in the wrong
1521** answer.
1522*/
1523int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1524 u8 op;
drh05883a32015-06-02 15:32:08 +00001525 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00001526 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00001527 op = p->op;
1528 if( op==TK_REGISTER ) op = p->op2;
1529 switch( op ){
1530 case TK_INTEGER: {
1531 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1532 }
1533 case TK_FLOAT: {
1534 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1535 }
1536 case TK_STRING: {
1537 return aff==SQLITE_AFF_TEXT;
1538 }
1539 case TK_BLOB: {
1540 return 1;
1541 }
drh2f2855b2009-11-18 01:25:26 +00001542 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00001543 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
1544 return p->iColumn<0
1545 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00001546 }
drh039fc322009-11-17 18:31:47 +00001547 default: {
1548 return 0;
1549 }
1550 }
1551}
1552
1553/*
drhc4a3c772001-04-04 11:48:57 +00001554** Return TRUE if the given string is a row-id column name.
1555*/
danielk19774adee202004-05-08 08:23:19 +00001556int sqlite3IsRowid(const char *z){
1557 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
1558 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
1559 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00001560 return 0;
1561}
1562
danielk19779a96b662007-11-29 17:05:18 +00001563/*
drhb74b1012009-05-28 21:04:37 +00001564** Return true if we are able to the IN operator optimization on a
1565** query of the form
drhb287f4b2008-04-25 00:08:38 +00001566**
drhb74b1012009-05-28 21:04:37 +00001567** x IN (SELECT ...)
drhb287f4b2008-04-25 00:08:38 +00001568**
drhb74b1012009-05-28 21:04:37 +00001569** Where the SELECT... clause is as specified by the parameter to this
1570** routine.
1571**
1572** The Select object passed in has already been preprocessed and no
1573** errors have been found.
drhb287f4b2008-04-25 00:08:38 +00001574*/
1575#ifndef SQLITE_OMIT_SUBQUERY
1576static int isCandidateForInOpt(Select *p){
1577 SrcList *pSrc;
1578 ExprList *pEList;
1579 Table *pTab;
drhb287f4b2008-04-25 00:08:38 +00001580 if( p==0 ) return 0; /* right-hand side of IN is SELECT */
1581 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00001582 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00001583 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1584 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
1585 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00001586 }
drhb74b1012009-05-28 21:04:37 +00001587 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00001588 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb74b1012009-05-28 21:04:37 +00001589 assert( p->pOffset==0 ); /* No LIMIT means no OFFSET */
drhb287f4b2008-04-25 00:08:38 +00001590 if( p->pWhere ) return 0; /* Has no WHERE clause */
1591 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00001592 assert( pSrc!=0 );
1593 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00001594 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00001595 pTab = pSrc->a[0].pTab;
drhb74b1012009-05-28 21:04:37 +00001596 if( NEVER(pTab==0) ) return 0;
1597 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00001598 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
1599 pEList = p->pEList;
1600 if( pEList->nExpr!=1 ) return 0; /* One column in the result set */
1601 if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1602 return 1;
1603}
1604#endif /* SQLITE_OMIT_SUBQUERY */
1605
1606/*
dan1d8cb212011-12-09 13:24:16 +00001607** Code an OP_Once instruction and allocate space for its flag. Return the
1608** address of the new instruction.
1609*/
1610int sqlite3CodeOnce(Parse *pParse){
1611 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
1612 return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
1613}
1614
1615/*
drh4c259e92014-08-01 21:12:35 +00001616** Generate code that checks the left-most column of index table iCur to see if
1617** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00001618** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
1619** to be set to NULL if iCur contains one or more NULL values.
1620*/
1621static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00001622 int addr1;
drh6be515e2014-08-01 21:00:53 +00001623 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00001624 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00001625 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
1626 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00001627 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00001628 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00001629}
1630
drhbb53ecb2014-08-02 21:03:33 +00001631
1632#ifndef SQLITE_OMIT_SUBQUERY
1633/*
1634** The argument is an IN operator with a list (not a subquery) on the
1635** right-hand side. Return TRUE if that list is constant.
1636*/
1637static int sqlite3InRhsIsConstant(Expr *pIn){
1638 Expr *pLHS;
1639 int res;
1640 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1641 pLHS = pIn->pLeft;
1642 pIn->pLeft = 0;
1643 res = sqlite3ExprIsConstant(pIn);
1644 pIn->pLeft = pLHS;
1645 return res;
1646}
1647#endif
1648
drh6be515e2014-08-01 21:00:53 +00001649/*
danielk19779a96b662007-11-29 17:05:18 +00001650** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00001651** The pX parameter is the expression on the RHS of the IN operator, which
1652** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00001653**
drhd4305ca2012-09-18 17:08:33 +00001654** The job of this routine is to find or create a b-tree object that can
1655** be used either to test for membership in the RHS set or to iterate through
1656** all members of the RHS set, skipping duplicates.
1657**
drh3a856252014-08-01 14:46:57 +00001658** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00001659** and pX->iTable is set to the index of that cursor.
1660**
drhb74b1012009-05-28 21:04:37 +00001661** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00001662**
drh1ccce442013-03-12 20:38:51 +00001663** IN_INDEX_ROWID - The cursor was opened on a database table.
1664** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
1665** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
1666** IN_INDEX_EPH - The cursor was opened on a specially created and
1667** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00001668** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
1669** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00001670**
drhd4305ca2012-09-18 17:08:33 +00001671** An existing b-tree might be used if the RHS expression pX is a simple
1672** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00001673**
1674** SELECT <column> FROM <table>
1675**
drhd4305ca2012-09-18 17:08:33 +00001676** If the RHS of the IN operator is a list or a more complex subquery, then
1677** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00001678** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00001679** existing table.
drhd4305ca2012-09-18 17:08:33 +00001680**
drh3a856252014-08-01 14:46:57 +00001681** The inFlags parameter must contain exactly one of the bits
1682** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP. If inFlags contains
1683** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
1684** fast membership test. When the IN_INDEX_LOOP bit is set, the
1685** IN index will be used to loop over all values of the RHS of the
1686** IN operator.
1687**
1688** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
1689** through the set members) then the b-tree must not contain duplicates.
1690** An epheremal table must be used unless the selected <column> is guaranteed
danielk19779a96b662007-11-29 17:05:18 +00001691** to be unique - either because it is an INTEGER PRIMARY KEY or it
drhb74b1012009-05-28 21:04:37 +00001692** has a UNIQUE constraint or UNIQUE index.
danielk19770cdc0222008-06-26 18:04:03 +00001693**
drh3a856252014-08-01 14:46:57 +00001694** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
1695** for fast set membership tests) then an epheremal table must
danielk19770cdc0222008-06-26 18:04:03 +00001696** be used unless <column> is an INTEGER PRIMARY KEY or an index can
1697** be found with <column> as its left-most column.
1698**
drhbb53ecb2014-08-02 21:03:33 +00001699** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
1700** if the RHS of the IN operator is a list (not a subquery) then this
1701** routine might decide that creating an ephemeral b-tree for membership
1702** testing is too expensive and return IN_INDEX_NOOP. In that case, the
1703** calling routine should implement the IN operator using a sequence
1704** of Eq or Ne comparison operations.
1705**
drhb74b1012009-05-28 21:04:37 +00001706** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00001707** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00001708** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00001709** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00001710** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00001711** to *prRhsHasNull. If there is no chance that the (...) contains a
1712** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00001713**
drhe21a6e12014-08-01 18:00:24 +00001714** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00001715** the value in that register will be NULL if the b-tree contains one or more
1716** NULL values, and it will be some non-NULL value if the b-tree contains no
1717** NULL values.
danielk19779a96b662007-11-29 17:05:18 +00001718*/
danielk1977284f4ac2007-12-10 05:03:46 +00001719#ifndef SQLITE_OMIT_SUBQUERY
drhe21a6e12014-08-01 18:00:24 +00001720int sqlite3FindInIndex(Parse *pParse, Expr *pX, u32 inFlags, int *prRhsHasNull){
drhb74b1012009-05-28 21:04:37 +00001721 Select *p; /* SELECT to the right of IN operator */
1722 int eType = 0; /* Type of RHS table. IN_INDEX_* */
1723 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00001724 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00001725 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00001726
drh1450bc62009-10-30 13:25:56 +00001727 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00001728 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00001729
drhb74b1012009-05-28 21:04:37 +00001730 /* Check to see if an existing table or index can be used to
1731 ** satisfy the query. This is preferable to generating a new
1732 ** ephemeral table.
danielk19779a96b662007-11-29 17:05:18 +00001733 */
danielk19776ab3a2e2009-02-19 14:39:25 +00001734 p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
drh311efc72015-04-15 04:20:58 +00001735 if( pParse->nErr==0 && isCandidateForInOpt(p) ){
danielk1977e1fb65a2009-04-02 17:23:32 +00001736 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00001737 Table *pTab; /* Table <table>. */
1738 Expr *pExpr; /* Expression <column> */
drhbbbdc832013-10-22 18:01:40 +00001739 i16 iCol; /* Index of column <column> */
1740 i16 iDb; /* Database idx for pTab */
drhb07028f2011-10-14 21:49:18 +00001741
1742 assert( p ); /* Because of isCandidateForInOpt(p) */
1743 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
1744 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1745 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
1746 pTab = p->pSrc->a[0].pTab;
1747 pExpr = p->pEList->a[0].pExpr;
drhbbbdc832013-10-22 18:01:40 +00001748 iCol = (i16)pExpr->iColumn;
danielk1977e1fb65a2009-04-02 17:23:32 +00001749
drhb22f7c82014-02-06 23:56:27 +00001750 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00001751 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1752 sqlite3CodeVerifySchema(pParse, iDb);
1753 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00001754
1755 /* This function is only called from two places. In both cases the vdbe
1756 ** has already been allocated. So assume sqlite3GetVdbe() is always
1757 ** successful here.
1758 */
1759 assert(v);
1760 if( iCol<0 ){
drh7d176102014-02-18 03:07:12 +00001761 int iAddr = sqlite3CodeOnce(pParse);
1762 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00001763
1764 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
1765 eType = IN_INDEX_ROWID;
1766
1767 sqlite3VdbeJumpHere(v, iAddr);
1768 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00001769 Index *pIdx; /* Iterator variable */
1770
drhb74b1012009-05-28 21:04:37 +00001771 /* The collation sequence used by the comparison. If an index is to
danielk19779a96b662007-11-29 17:05:18 +00001772 ** be used in place of a temp-table, it must be ordered according
danielk1977e1fb65a2009-04-02 17:23:32 +00001773 ** to this collation sequence. */
danielk19779a96b662007-11-29 17:05:18 +00001774 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
1775
1776 /* Check that the affinity that will be used to perform the
1777 ** comparison is the same as the affinity of the column. If
1778 ** it is not, it is not possible to use any index.
1779 */
drhdbaee5e2012-09-18 19:29:06 +00001780 int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
danielk19779a96b662007-11-29 17:05:18 +00001781
1782 for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
1783 if( (pIdx->aiColumn[0]==iCol)
drhb74b1012009-05-28 21:04:37 +00001784 && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
drh5f1d1d92014-07-31 22:59:04 +00001785 && (!mustBeUnique || (pIdx->nKeyCol==1 && IsUniqueIndex(pIdx)))
danielk19779a96b662007-11-29 17:05:18 +00001786 ){
drh7d176102014-02-18 03:07:12 +00001787 int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
drh2ec2fb22013-11-06 19:59:23 +00001788 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
1789 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danielk1977207872a2008-01-03 07:54:23 +00001790 VdbeComment((v, "%s", pIdx->zName));
drh1ccce442013-03-12 20:38:51 +00001791 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
1792 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
danielk19779a96b662007-11-29 17:05:18 +00001793
drhe21a6e12014-08-01 18:00:24 +00001794 if( prRhsHasNull && !pTab->aCol[iCol].notNull ){
1795 *prRhsHasNull = ++pParse->nMem;
drh6be515e2014-08-01 21:00:53 +00001796 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
danielk19770cdc0222008-06-26 18:04:03 +00001797 }
drh552fd452014-02-18 01:07:38 +00001798 sqlite3VdbeJumpHere(v, iAddr);
danielk19779a96b662007-11-29 17:05:18 +00001799 }
1800 }
1801 }
1802 }
1803
drhbb53ecb2014-08-02 21:03:33 +00001804 /* If no preexisting index is available for the IN clause
1805 ** and IN_INDEX_NOOP is an allowed reply
1806 ** and the RHS of the IN operator is a list, not a subquery
1807 ** and the RHS is not contant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00001808 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00001809 ** the IN operator so return IN_INDEX_NOOP.
1810 */
1811 if( eType==0
1812 && (inFlags & IN_INDEX_NOOP_OK)
1813 && !ExprHasProperty(pX, EP_xIsSelect)
1814 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
1815 ){
1816 eType = IN_INDEX_NOOP;
1817 }
1818
1819
danielk19779a96b662007-11-29 17:05:18 +00001820 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00001821 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00001822 ** We will have to generate an ephemeral table to do the job.
1823 */
drh8e23daf2013-06-11 13:30:04 +00001824 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00001825 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00001826 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00001827 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00001828 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00001829 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00001830 eType = IN_INDEX_ROWID;
1831 }
drhe21a6e12014-08-01 18:00:24 +00001832 }else if( prRhsHasNull ){
1833 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00001834 }
danielk197741a05b72008-10-02 13:50:55 +00001835 sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
drhcf4d38a2010-07-28 02:53:36 +00001836 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00001837 }else{
1838 pX->iTable = iTab;
1839 }
1840 return eType;
1841}
danielk1977284f4ac2007-12-10 05:03:46 +00001842#endif
drh626a8792005-01-17 22:08:19 +00001843
1844/*
drhd4187c72010-08-30 22:15:45 +00001845** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1846** or IN operators. Examples:
drh626a8792005-01-17 22:08:19 +00001847**
drh9cbe6352005-11-29 03:13:21 +00001848** (SELECT a FROM b) -- subquery
1849** EXISTS (SELECT a FROM b) -- EXISTS subquery
1850** x IN (4,5,11) -- IN operator with list on right-hand side
1851** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00001852**
drh9cbe6352005-11-29 03:13:21 +00001853** The pExpr parameter describes the expression that contains the IN
1854** operator or subquery.
danielk197741a05b72008-10-02 13:50:55 +00001855**
1856** If parameter isRowid is non-zero, then expression pExpr is guaranteed
1857** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
1858** to some integer key column of a table B-Tree. In this case, use an
1859** intkey B-Tree to store the set of IN(...) values instead of the usual
1860** (slower) variable length keys B-Tree.
drhfd773cf2009-05-29 14:39:07 +00001861**
1862** If rMayHaveNull is non-zero, that means that the operation is an IN
1863** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
drh3a856252014-08-01 14:46:57 +00001864** All this routine does is initialize the register given by rMayHaveNull
1865** to NULL. Calling routines will take care of changing this register
1866** value to non-NULL if the RHS is NULL-free.
drh1450bc62009-10-30 13:25:56 +00001867**
1868** For a SELECT or EXISTS operator, return the register that holds the
1869** result. For IN operators or if an error occurs, the return value is 0.
drhcce7d172000-05-31 15:34:51 +00001870*/
drh51522cd2005-01-20 13:36:19 +00001871#ifndef SQLITE_OMIT_SUBQUERY
drh1450bc62009-10-30 13:25:56 +00001872int sqlite3CodeSubselect(
drhfd773cf2009-05-29 14:39:07 +00001873 Parse *pParse, /* Parsing context */
1874 Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
drh6be515e2014-08-01 21:00:53 +00001875 int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
drhfd773cf2009-05-29 14:39:07 +00001876 int isRowid /* If true, LHS of IN operator is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00001877){
drh6be515e2014-08-01 21:00:53 +00001878 int jmpIfDynamic = -1; /* One-time test address */
drh1450bc62009-10-30 13:25:56 +00001879 int rReg = 0; /* Register storing resulting */
danielk1977b3bce662005-01-29 08:32:43 +00001880 Vdbe *v = sqlite3GetVdbe(pParse);
drh1450bc62009-10-30 13:25:56 +00001881 if( NEVER(v==0) ) return 0;
drhceea3322009-04-23 13:22:42 +00001882 sqlite3ExprCachePush(pParse);
danielk1977fc976062007-05-10 10:46:56 +00001883
drh57dbd7b2005-07-08 18:25:26 +00001884 /* This code must be run in its entirety every time it is encountered
1885 ** if any of the following is true:
1886 **
1887 ** * The right-hand side is a correlated subquery
1888 ** * The right-hand side is an expression list containing variables
1889 ** * We are inside a trigger
1890 **
1891 ** If all of the above are false, then we can run this code just once
1892 ** save the results, and reuse the same result on subsequent invocations.
danielk1977b3bce662005-01-29 08:32:43 +00001893 */
drhc5cd1242013-09-12 16:50:49 +00001894 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh6be515e2014-08-01 21:00:53 +00001895 jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00001896 }
1897
dan4a07e3d2010-11-09 14:48:59 +00001898#ifndef SQLITE_OMIT_EXPLAIN
1899 if( pParse->explain==2 ){
drh62aaa6c2015-11-21 17:27:42 +00001900 char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
1901 jmpIfDynamic>=0?"":"CORRELATED ",
1902 pExpr->op==TK_IN?"LIST":"SCALAR",
1903 pParse->iNextSelectId
dan4a07e3d2010-11-09 14:48:59 +00001904 );
1905 sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
1906 }
1907#endif
1908
drhcce7d172000-05-31 15:34:51 +00001909 switch( pExpr->op ){
drhfef52082000-06-06 01:50:43 +00001910 case TK_IN: {
drhd4187c72010-08-30 22:15:45 +00001911 char affinity; /* Affinity of the LHS of the IN */
drhd4187c72010-08-30 22:15:45 +00001912 int addr; /* Address of OP_OpenEphemeral instruction */
1913 Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
drh323df792013-08-05 19:11:29 +00001914 KeyInfo *pKeyInfo = 0; /* Key information */
drhd3d39e92004-05-20 22:16:29 +00001915
danielk197741a05b72008-10-02 13:50:55 +00001916 affinity = sqlite3ExprAffinity(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00001917
1918 /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
drh8cff69d2009-11-12 19:59:44 +00001919 ** expression it is handled the same way. An ephemeral table is
danielk1977e014a832004-05-17 10:48:57 +00001920 ** filled with single-field index keys representing the results
1921 ** from the SELECT or the <exprlist>.
1922 **
1923 ** If the 'x' expression is a column value, or the SELECT...
1924 ** statement returns a column value, then the affinity of that
1925 ** column is used to build the index keys. If both 'x' and the
1926 ** SELECT... statement are columns, then numeric affinity is used
1927 ** if either column has NUMERIC or INTEGER affinity. If neither
1928 ** 'x' nor the SELECT... statement are columns, then numeric affinity
1929 ** is used.
1930 */
1931 pExpr->iTable = pParse->nTab++;
danielk197741a05b72008-10-02 13:50:55 +00001932 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
drhad124322013-10-23 13:30:58 +00001933 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1, 1);
danielk1977e014a832004-05-17 10:48:57 +00001934
danielk19776ab3a2e2009-02-19 14:39:25 +00001935 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhfef52082000-06-06 01:50:43 +00001936 /* Case 1: expr IN (SELECT ...)
1937 **
danielk1977e014a832004-05-17 10:48:57 +00001938 ** Generate code to write the results of the select into the temporary
1939 ** table allocated and opened above.
drhfef52082000-06-06 01:50:43 +00001940 */
drh43870062014-07-31 15:44:44 +00001941 Select *pSelect = pExpr->x.pSelect;
drh1013c932008-01-06 00:25:21 +00001942 SelectDest dest;
drhbe5c89a2004-07-26 00:31:09 +00001943 ExprList *pEList;
drh1013c932008-01-06 00:25:21 +00001944
danielk197741a05b72008-10-02 13:50:55 +00001945 assert( !isRowid );
drh1013c932008-01-06 00:25:21 +00001946 sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
drh2b596da2012-07-23 21:43:19 +00001947 dest.affSdst = (u8)affinity;
danielk1977e014a832004-05-17 10:48:57 +00001948 assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
drh43870062014-07-31 15:44:44 +00001949 pSelect->iLimit = 0;
1950 testcase( pSelect->selFlags & SF_Distinct );
drh812ea832013-08-06 17:24:23 +00001951 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh43870062014-07-31 15:44:44 +00001952 if( sqlite3Select(pParse, pSelect, &dest) ){
drh2ec2fb22013-11-06 19:59:23 +00001953 sqlite3KeyInfoUnref(pKeyInfo);
drh1450bc62009-10-30 13:25:56 +00001954 return 0;
drh94ccde52007-04-13 16:06:32 +00001955 }
drh43870062014-07-31 15:44:44 +00001956 pEList = pSelect->pEList;
drh812ea832013-08-06 17:24:23 +00001957 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
drh3535ec32013-08-06 16:56:44 +00001958 assert( pEList!=0 );
1959 assert( pEList->nExpr>0 );
drh2ec2fb22013-11-06 19:59:23 +00001960 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh3535ec32013-08-06 16:56:44 +00001961 pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1962 pEList->a[0].pExpr);
drha7d2db12010-07-14 20:23:52 +00001963 }else if( ALWAYS(pExpr->x.pList!=0) ){
drhfef52082000-06-06 01:50:43 +00001964 /* Case 2: expr IN (exprlist)
1965 **
drhfd131da2007-08-07 17:13:03 +00001966 ** For each expression, build an index key from the evaluation and
danielk1977e014a832004-05-17 10:48:57 +00001967 ** store it in the temporary table. If <expr> is a column, then use
1968 ** that columns affinity when building index keys. If <expr> is not
1969 ** a column, use numeric affinity.
drhfef52082000-06-06 01:50:43 +00001970 */
danielk1977e014a832004-05-17 10:48:57 +00001971 int i;
danielk19776ab3a2e2009-02-19 14:39:25 +00001972 ExprList *pList = pExpr->x.pList;
drh57dbd7b2005-07-08 18:25:26 +00001973 struct ExprList_item *pItem;
drhecc31802008-06-26 20:06:06 +00001974 int r1, r2, r3;
drh57dbd7b2005-07-08 18:25:26 +00001975
danielk1977e014a832004-05-17 10:48:57 +00001976 if( !affinity ){
drh05883a32015-06-02 15:32:08 +00001977 affinity = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +00001978 }
drh323df792013-08-05 19:11:29 +00001979 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00001980 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh323df792013-08-05 19:11:29 +00001981 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1982 }
danielk1977e014a832004-05-17 10:48:57 +00001983
1984 /* Loop through each expression in <exprlist>. */
drh2d401ab2008-01-10 23:50:11 +00001985 r1 = sqlite3GetTempReg(pParse);
1986 r2 = sqlite3GetTempReg(pParse);
drh37e08082014-07-31 20:16:08 +00001987 if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
drh57dbd7b2005-07-08 18:25:26 +00001988 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
1989 Expr *pE2 = pItem->pExpr;
drhe05c9292009-10-29 13:48:10 +00001990 int iValToIns;
danielk1977e014a832004-05-17 10:48:57 +00001991
drh57dbd7b2005-07-08 18:25:26 +00001992 /* If the expression is not constant then we will need to
1993 ** disable the test that was generated above that makes sure
1994 ** this code only executes once. Because for a non-constant
1995 ** expression we need to rerun this code each time.
1996 */
drh6be515e2014-08-01 21:00:53 +00001997 if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
1998 sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
1999 jmpIfDynamic = -1;
drh4794b982000-06-06 13:54:14 +00002000 }
danielk1977e014a832004-05-17 10:48:57 +00002001
2002 /* Evaluate the expression and insert it into the temp table */
drhe05c9292009-10-29 13:48:10 +00002003 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2004 sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
danielk197741a05b72008-10-02 13:50:55 +00002005 }else{
drhe05c9292009-10-29 13:48:10 +00002006 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2007 if( isRowid ){
2008 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2009 sqlite3VdbeCurrentAddr(v)+2);
drh688852a2014-02-17 22:40:43 +00002010 VdbeCoverage(v);
drhe05c9292009-10-29 13:48:10 +00002011 sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
2012 }else{
2013 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2014 sqlite3ExprCacheAffinityChange(pParse, r3, 1);
2015 sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2016 }
danielk197741a05b72008-10-02 13:50:55 +00002017 }
drhfef52082000-06-06 01:50:43 +00002018 }
drh2d401ab2008-01-10 23:50:11 +00002019 sqlite3ReleaseTempReg(pParse, r1);
2020 sqlite3ReleaseTempReg(pParse, r2);
drhfef52082000-06-06 01:50:43 +00002021 }
drh323df792013-08-05 19:11:29 +00002022 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002023 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
danielk197741a05b72008-10-02 13:50:55 +00002024 }
danielk1977b3bce662005-01-29 08:32:43 +00002025 break;
drhfef52082000-06-06 01:50:43 +00002026 }
2027
drh51522cd2005-01-20 13:36:19 +00002028 case TK_EXISTS:
drhfd773cf2009-05-29 14:39:07 +00002029 case TK_SELECT:
2030 default: {
drhfd773cf2009-05-29 14:39:07 +00002031 /* If this has to be a scalar SELECT. Generate code to put the
drhfef52082000-06-06 01:50:43 +00002032 ** value of this select in a memory cell and record the number
drhfd773cf2009-05-29 14:39:07 +00002033 ** of the memory cell in iColumn. If this is an EXISTS, write
2034 ** an integer 0 (not exists) or 1 (exists) into a memory cell
2035 ** and record that memory cell in iColumn.
drhfef52082000-06-06 01:50:43 +00002036 */
drhfd773cf2009-05-29 14:39:07 +00002037 Select *pSel; /* SELECT statement to encode */
2038 SelectDest dest; /* How to deal with SELECt result */
drh1398ad32005-01-19 23:24:50 +00002039
shanecf697392009-06-01 16:53:09 +00002040 testcase( pExpr->op==TK_EXISTS );
2041 testcase( pExpr->op==TK_SELECT );
2042 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2043
danielk19776ab3a2e2009-02-19 14:39:25 +00002044 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2045 pSel = pExpr->x.pSelect;
drh1013c932008-01-06 00:25:21 +00002046 sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
drh51522cd2005-01-20 13:36:19 +00002047 if( pExpr->op==TK_SELECT ){
danielk19776c8c8ce2008-01-02 16:27:09 +00002048 dest.eDest = SRT_Mem;
drh53932ce2014-08-29 12:29:39 +00002049 dest.iSdst = dest.iSDParm;
drh2b596da2012-07-23 21:43:19 +00002050 sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002051 VdbeComment((v, "Init subquery result"));
drh51522cd2005-01-20 13:36:19 +00002052 }else{
danielk19776c8c8ce2008-01-02 16:27:09 +00002053 dest.eDest = SRT_Exists;
drh2b596da2012-07-23 21:43:19 +00002054 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002055 VdbeComment((v, "Init EXISTS result"));
drh51522cd2005-01-20 13:36:19 +00002056 }
drh633e6d52008-07-28 19:34:53 +00002057 sqlite3ExprDelete(pParse->db, pSel->pLimit);
drh094430e2010-07-14 18:24:06 +00002058 pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2059 &sqlite3IntTokens[1]);
drh48b5b042010-12-06 18:50:32 +00002060 pSel->iLimit = 0;
drh772460f2015-04-16 14:13:12 +00002061 pSel->selFlags &= ~SF_MultiValue;
drh7d10d5a2008-08-20 16:35:10 +00002062 if( sqlite3Select(pParse, pSel, &dest) ){
drh1450bc62009-10-30 13:25:56 +00002063 return 0;
drh94ccde52007-04-13 16:06:32 +00002064 }
drh2b596da2012-07-23 21:43:19 +00002065 rReg = dest.iSDParm;
drhebb6a652013-09-12 23:42:22 +00002066 ExprSetVVAProperty(pExpr, EP_NoReduce);
danielk1977b3bce662005-01-29 08:32:43 +00002067 break;
drhcce7d172000-05-31 15:34:51 +00002068 }
2069 }
danielk1977b3bce662005-01-29 08:32:43 +00002070
drh6be515e2014-08-01 21:00:53 +00002071 if( rHasNullFlag ){
2072 sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
danielk1977b3bce662005-01-29 08:32:43 +00002073 }
drh6be515e2014-08-01 21:00:53 +00002074
2075 if( jmpIfDynamic>=0 ){
2076 sqlite3VdbeJumpHere(v, jmpIfDynamic);
danielk1977b3bce662005-01-29 08:32:43 +00002077 }
drhd2490902014-04-13 19:28:15 +00002078 sqlite3ExprCachePop(pParse);
danielk1977fc976062007-05-10 10:46:56 +00002079
drh1450bc62009-10-30 13:25:56 +00002080 return rReg;
drhcce7d172000-05-31 15:34:51 +00002081}
drh51522cd2005-01-20 13:36:19 +00002082#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002083
drhe3365e62009-11-12 17:52:24 +00002084#ifndef SQLITE_OMIT_SUBQUERY
2085/*
2086** Generate code for an IN expression.
2087**
2088** x IN (SELECT ...)
2089** x IN (value, value, ...)
2090**
2091** The left-hand side (LHS) is a scalar expression. The right-hand side (RHS)
2092** is an array of zero or more values. The expression is true if the LHS is
2093** contained within the RHS. The value of the expression is unknown (NULL)
2094** if the LHS is NULL or if the LHS is not contained within the RHS and the
2095** RHS contains one or more NULL values.
2096**
drh6be515e2014-08-01 21:00:53 +00002097** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002098** contained within the RHS. If due to NULLs we cannot determine if the LHS
2099** is contained in the RHS then jump to destIfNull. If the LHS is contained
2100** within the RHS then fall through.
2101*/
2102static void sqlite3ExprCodeIN(
2103 Parse *pParse, /* Parsing and code generating context */
2104 Expr *pExpr, /* The IN expression */
2105 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2106 int destIfNull /* Jump here if the results are unknown due to NULLs */
2107){
2108 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
2109 char affinity; /* Comparison affinity to use */
2110 int eType; /* Type of the RHS */
2111 int r1; /* Temporary use register */
2112 Vdbe *v; /* Statement under construction */
2113
2114 /* Compute the RHS. After this step, the table with cursor
2115 ** pExpr->iTable will contains the values that make up the RHS.
2116 */
2117 v = pParse->pVdbe;
2118 assert( v!=0 ); /* OOM detected prior to this routine */
2119 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00002120 eType = sqlite3FindInIndex(pParse, pExpr,
2121 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh3a856252014-08-01 14:46:57 +00002122 destIfFalse==destIfNull ? 0 : &rRhsHasNull);
drhe3365e62009-11-12 17:52:24 +00002123
2124 /* Figure out the affinity to use to create a key from the results
2125 ** of the expression. affinityStr stores a static string suitable for
2126 ** P4 of OP_MakeRecord.
2127 */
2128 affinity = comparisonAffinity(pExpr);
2129
2130 /* Code the LHS, the <expr> from "<expr> IN (...)".
2131 */
2132 sqlite3ExprCachePush(pParse);
2133 r1 = sqlite3GetTempReg(pParse);
2134 sqlite3ExprCode(pParse, pExpr->pLeft, r1);
drhe3365e62009-11-12 17:52:24 +00002135
drhbb53ecb2014-08-02 21:03:33 +00002136 /* If sqlite3FindInIndex() did not find or create an index that is
2137 ** suitable for evaluating the IN operator, then evaluate using a
2138 ** sequence of comparisons.
drh094430e2010-07-14 18:24:06 +00002139 */
drhbb53ecb2014-08-02 21:03:33 +00002140 if( eType==IN_INDEX_NOOP ){
2141 ExprList *pList = pExpr->x.pList;
2142 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2143 int labelOk = sqlite3VdbeMakeLabel(v);
2144 int r2, regToFree;
2145 int regCkNull = 0;
2146 int ii;
2147 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00002148 if( destIfNull!=destIfFalse ){
2149 regCkNull = sqlite3GetTempReg(pParse);
drha9769792014-08-04 16:39:39 +00002150 sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00002151 }
2152 for(ii=0; ii<pList->nExpr; ii++){
2153 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00002154 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00002155 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2156 }
2157 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2158 sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00002159 (void*)pColl, P4_COLLSEQ);
2160 VdbeCoverageIf(v, ii<pList->nExpr-1);
2161 VdbeCoverageIf(v, ii==pList->nExpr-1);
drhbb53ecb2014-08-02 21:03:33 +00002162 sqlite3VdbeChangeP5(v, affinity);
2163 }else{
2164 assert( destIfNull==destIfFalse );
2165 sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2166 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2167 sqlite3VdbeChangeP5(v, affinity | SQLITE_JUMPIFNULL);
2168 }
2169 sqlite3ReleaseTempReg(pParse, regToFree);
2170 }
2171 if( regCkNull ){
2172 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002173 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00002174 }
2175 sqlite3VdbeResolveLabel(v, labelOk);
2176 sqlite3ReleaseTempReg(pParse, regCkNull);
drh094430e2010-07-14 18:24:06 +00002177 }else{
drhbb53ecb2014-08-02 21:03:33 +00002178
2179 /* If the LHS is NULL, then the result is either false or NULL depending
2180 ** on whether the RHS is empty or not, respectively.
drhe3365e62009-11-12 17:52:24 +00002181 */
drh7248a8b2014-08-04 18:50:54 +00002182 if( sqlite3ExprCanBeNull(pExpr->pLeft) ){
2183 if( destIfNull==destIfFalse ){
2184 /* Shortcut for the common case where the false and NULL outcomes are
2185 ** the same. */
2186 sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull); VdbeCoverage(v);
2187 }else{
2188 int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2189 sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2190 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002191 sqlite3VdbeGoto(v, destIfNull);
drh7248a8b2014-08-04 18:50:54 +00002192 sqlite3VdbeJumpHere(v, addr1);
2193 }
drhbb53ecb2014-08-02 21:03:33 +00002194 }
2195
2196 if( eType==IN_INDEX_ROWID ){
2197 /* In this case, the RHS is the ROWID of table b-tree
drhe3365e62009-11-12 17:52:24 +00002198 */
drhbb53ecb2014-08-02 21:03:33 +00002199 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse); VdbeCoverage(v);
2200 sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
drh688852a2014-02-17 22:40:43 +00002201 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00002202 }else{
drhbb53ecb2014-08-02 21:03:33 +00002203 /* In this case, the RHS is an index b-tree.
drhe3365e62009-11-12 17:52:24 +00002204 */
drhbb53ecb2014-08-02 21:03:33 +00002205 sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
2206
2207 /* If the set membership test fails, then the result of the
2208 ** "x IN (...)" expression must be either 0 or NULL. If the set
2209 ** contains no NULL values, then the result is 0. If the set
2210 ** contains one or more NULL values, then the result of the
2211 ** expression is also NULL.
drhe3365e62009-11-12 17:52:24 +00002212 */
drhbb53ecb2014-08-02 21:03:33 +00002213 assert( destIfFalse!=destIfNull || rRhsHasNull==0 );
2214 if( rRhsHasNull==0 ){
2215 /* This branch runs if it is known at compile time that the RHS
2216 ** cannot contain NULL values. This happens as the result
2217 ** of a "NOT NULL" constraint in the database schema.
2218 **
2219 ** Also run this branch if NULL is equivalent to FALSE
2220 ** for this particular IN operator.
2221 */
2222 sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
2223 VdbeCoverage(v);
2224 }else{
2225 /* In this branch, the RHS of the IN might contain a NULL and
2226 ** the presence of a NULL on the RHS makes a difference in the
2227 ** outcome.
2228 */
drh728e0f92015-10-10 14:41:28 +00002229 int addr1;
drhbb53ecb2014-08-02 21:03:33 +00002230
2231 /* First check to see if the LHS is contained in the RHS. If so,
2232 ** then the answer is TRUE the presence of NULLs in the RHS does
2233 ** not matter. If the LHS is not contained in the RHS, then the
2234 ** answer is NULL if the RHS contains NULLs and the answer is
2235 ** FALSE if the RHS is NULL-free.
2236 */
drh728e0f92015-10-10 14:41:28 +00002237 addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
drhbb53ecb2014-08-02 21:03:33 +00002238 VdbeCoverage(v);
2239 sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2240 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002241 sqlite3VdbeGoto(v, destIfFalse);
drh728e0f92015-10-10 14:41:28 +00002242 sqlite3VdbeJumpHere(v, addr1);
drhbb53ecb2014-08-02 21:03:33 +00002243 }
drhe3365e62009-11-12 17:52:24 +00002244 }
drhe3365e62009-11-12 17:52:24 +00002245 }
2246 sqlite3ReleaseTempReg(pParse, r1);
drhd2490902014-04-13 19:28:15 +00002247 sqlite3ExprCachePop(pParse);
drhe3365e62009-11-12 17:52:24 +00002248 VdbeComment((v, "end IN expr"));
2249}
2250#endif /* SQLITE_OMIT_SUBQUERY */
2251
drh13573c72010-01-12 17:04:07 +00002252#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00002253/*
2254** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00002255** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00002256**
2257** The z[] string will probably not be zero-terminated. But the
2258** z[n] character is guaranteed to be something that does not look
2259** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00002260*/
drhb7916a72009-05-27 10:31:29 +00002261static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00002262 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00002263 double value;
drh9339da12010-09-30 00:50:49 +00002264 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00002265 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2266 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00002267 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00002268 }
2269}
drh13573c72010-01-12 17:04:07 +00002270#endif
drh598f1342007-10-23 15:39:45 +00002271
2272
2273/*
drhfec19aa2004-05-19 20:41:03 +00002274** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00002275** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00002276**
shaneh5f1d6b62010-09-30 16:51:25 +00002277** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00002278*/
drh13573c72010-01-12 17:04:07 +00002279static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
2280 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00002281 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002282 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00002283 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00002284 if( negFlag ) i = -i;
2285 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00002286 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00002287 int c;
2288 i64 value;
drhfd773cf2009-05-29 14:39:07 +00002289 const char *z = pExpr->u.zToken;
2290 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00002291 c = sqlite3DecOrHexToI64(z, &value);
shaneh5f1d6b62010-09-30 16:51:25 +00002292 if( c==0 || (c==2 && negFlag) ){
drh158b9cb2011-03-05 20:59:46 +00002293 if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
drh97bae792015-06-05 15:59:57 +00002294 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00002295 }else{
drh13573c72010-01-12 17:04:07 +00002296#ifdef SQLITE_OMIT_FLOATING_POINT
2297 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
2298#else
drh1b7ddc52014-07-23 14:52:05 +00002299#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00002300 if( sqlite3_strnicmp(z,"0x",2)==0 ){
2301 sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
drh1b7ddc52014-07-23 14:52:05 +00002302 }else
2303#endif
2304 {
drh9296c182014-07-23 13:40:49 +00002305 codeReal(v, z, negFlag, iMem);
2306 }
drh13573c72010-01-12 17:04:07 +00002307#endif
danielk1977c9cf9012007-05-30 10:36:47 +00002308 }
drhfec19aa2004-05-19 20:41:03 +00002309 }
2310}
2311
drhceea3322009-04-23 13:22:42 +00002312/*
2313** Clear a cache entry.
2314*/
2315static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2316 if( p->tempReg ){
2317 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2318 pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2319 }
2320 p->tempReg = 0;
2321 }
2322}
2323
2324
2325/*
2326** Record in the column cache that a particular column from a
2327** particular table is stored in a particular register.
2328*/
2329void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2330 int i;
2331 int minLru;
2332 int idxLru;
2333 struct yColCache *p;
2334
dance8f53d2015-01-21 17:00:57 +00002335 /* Unless an error has occurred, register numbers are always positive. */
2336 assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00002337 assert( iCol>=-1 && iCol<32768 ); /* Finite column numbers */
2338
drhb6da74e2009-12-24 16:00:28 +00002339 /* The SQLITE_ColumnCache flag disables the column cache. This is used
2340 ** for testing only - to verify that SQLite always gets the same answer
2341 ** with and without the column cache.
2342 */
drh7e5418e2012-09-27 15:05:54 +00002343 if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
drhb6da74e2009-12-24 16:00:28 +00002344
drh27ee4062009-12-30 01:13:11 +00002345 /* First replace any existing entry.
2346 **
2347 ** Actually, the way the column cache is currently used, we are guaranteed
2348 ** that the object will never already be in cache. Verify this guarantee.
2349 */
2350#ifndef NDEBUG
drhceea3322009-04-23 13:22:42 +00002351 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drh27ee4062009-12-30 01:13:11 +00002352 assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
drhceea3322009-04-23 13:22:42 +00002353 }
drh27ee4062009-12-30 01:13:11 +00002354#endif
drhceea3322009-04-23 13:22:42 +00002355
2356 /* Find an empty slot and replace it */
2357 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2358 if( p->iReg==0 ){
2359 p->iLevel = pParse->iCacheLevel;
2360 p->iTable = iTab;
2361 p->iColumn = iCol;
2362 p->iReg = iReg;
drhceea3322009-04-23 13:22:42 +00002363 p->tempReg = 0;
2364 p->lru = pParse->iCacheCnt++;
2365 return;
2366 }
2367 }
2368
2369 /* Replace the last recently used */
2370 minLru = 0x7fffffff;
2371 idxLru = -1;
2372 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2373 if( p->lru<minLru ){
2374 idxLru = i;
2375 minLru = p->lru;
2376 }
2377 }
drh20411ea2009-05-29 19:00:12 +00002378 if( ALWAYS(idxLru>=0) ){
drhceea3322009-04-23 13:22:42 +00002379 p = &pParse->aColCache[idxLru];
2380 p->iLevel = pParse->iCacheLevel;
2381 p->iTable = iTab;
2382 p->iColumn = iCol;
2383 p->iReg = iReg;
drhceea3322009-04-23 13:22:42 +00002384 p->tempReg = 0;
2385 p->lru = pParse->iCacheCnt++;
2386 return;
2387 }
2388}
2389
2390/*
drhf49f3522009-12-30 14:12:38 +00002391** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2392** Purge the range of registers from the column cache.
drhceea3322009-04-23 13:22:42 +00002393*/
drhf49f3522009-12-30 14:12:38 +00002394void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
drhceea3322009-04-23 13:22:42 +00002395 int i;
drhf49f3522009-12-30 14:12:38 +00002396 int iLast = iReg + nReg - 1;
drhceea3322009-04-23 13:22:42 +00002397 struct yColCache *p;
2398 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drhf49f3522009-12-30 14:12:38 +00002399 int r = p->iReg;
2400 if( r>=iReg && r<=iLast ){
drhceea3322009-04-23 13:22:42 +00002401 cacheEntryClear(pParse, p);
2402 p->iReg = 0;
2403 }
2404 }
2405}
2406
2407/*
2408** Remember the current column cache context. Any new entries added
2409** added to the column cache after this call are removed when the
2410** corresponding pop occurs.
2411*/
2412void sqlite3ExprCachePush(Parse *pParse){
2413 pParse->iCacheLevel++;
drh9ac79622013-12-18 15:11:47 +00002414#ifdef SQLITE_DEBUG
2415 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2416 printf("PUSH to %d\n", pParse->iCacheLevel);
2417 }
2418#endif
drhceea3322009-04-23 13:22:42 +00002419}
2420
2421/*
2422** Remove from the column cache any entries that were added since the
drhd2490902014-04-13 19:28:15 +00002423** the previous sqlite3ExprCachePush operation. In other words, restore
2424** the cache to the state it was in prior the most recent Push.
drhceea3322009-04-23 13:22:42 +00002425*/
drhd2490902014-04-13 19:28:15 +00002426void sqlite3ExprCachePop(Parse *pParse){
drhceea3322009-04-23 13:22:42 +00002427 int i;
2428 struct yColCache *p;
drhd2490902014-04-13 19:28:15 +00002429 assert( pParse->iCacheLevel>=1 );
2430 pParse->iCacheLevel--;
drh9ac79622013-12-18 15:11:47 +00002431#ifdef SQLITE_DEBUG
2432 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2433 printf("POP to %d\n", pParse->iCacheLevel);
2434 }
2435#endif
drhceea3322009-04-23 13:22:42 +00002436 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2437 if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2438 cacheEntryClear(pParse, p);
2439 p->iReg = 0;
2440 }
2441 }
2442}
drh945498f2007-02-24 11:52:52 +00002443
2444/*
drh5cd79232009-05-25 11:46:29 +00002445** When a cached column is reused, make sure that its register is
2446** no longer available as a temp register. ticket #3879: that same
2447** register might be in the cache in multiple places, so be sure to
2448** get them all.
2449*/
2450static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
2451 int i;
2452 struct yColCache *p;
2453 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2454 if( p->iReg==iReg ){
2455 p->tempReg = 0;
2456 }
2457 }
2458}
2459
drh1f9ca2c2015-08-25 16:57:52 +00002460/* Generate code that will load into register regOut a value that is
2461** appropriate for the iIdxCol-th column of index pIdx.
2462*/
2463void sqlite3ExprCodeLoadIndexColumn(
2464 Parse *pParse, /* The parsing context */
2465 Index *pIdx, /* The index whose column is to be loaded */
2466 int iTabCur, /* Cursor pointing to a table row */
2467 int iIdxCol, /* The column of the index to be loaded */
2468 int regOut /* Store the index column value in this register */
2469){
2470 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00002471 if( iTabCol==XN_EXPR ){
2472 assert( pIdx->aColExpr );
2473 assert( pIdx->aColExpr->nExpr>iIdxCol );
2474 pParse->iSelfTab = iTabCur;
drh1c75c9d2015-12-21 15:22:13 +00002475 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh4b92f982015-09-29 17:20:14 +00002476 }else{
drh1f9ca2c2015-08-25 16:57:52 +00002477 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
2478 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00002479 }
drh1f9ca2c2015-08-25 16:57:52 +00002480}
2481
drh5cd79232009-05-25 11:46:29 +00002482/*
drh5c092e82010-05-14 19:24:02 +00002483** Generate code to extract the value of the iCol-th column of a table.
2484*/
2485void sqlite3ExprCodeGetColumnOfTable(
2486 Vdbe *v, /* The VDBE under construction */
2487 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00002488 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00002489 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00002490 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00002491){
2492 if( iCol<0 || iCol==pTab->iPKey ){
2493 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
2494 }else{
2495 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00002496 int x = iCol;
2497 if( !HasRowid(pTab) ){
2498 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2499 }
2500 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00002501 }
2502 if( iCol>=0 ){
2503 sqlite3ColumnDefault(v, pTab, iCol, regOut);
2504 }
2505}
2506
2507/*
drh945498f2007-02-24 11:52:52 +00002508** Generate code that will extract the iColumn-th column from
drhce78bc62015-10-15 19:21:51 +00002509** table pTab and store the column value in a register.
2510**
2511** An effort is made to store the column value in register iReg. This
2512** is not garanteeed for GetColumn() - the result can be stored in
2513** any register. But the result is guaranteed to land in register iReg
2514** for GetColumnToReg().
drhe55cbd72008-03-31 23:48:03 +00002515**
2516** There must be an open cursor to pTab in iTable when this routine
2517** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00002518*/
drhe55cbd72008-03-31 23:48:03 +00002519int sqlite3ExprCodeGetColumn(
2520 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00002521 Table *pTab, /* Description of the table we are reading from */
2522 int iColumn, /* Index of the table column */
2523 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00002524 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00002525 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00002526){
drhe55cbd72008-03-31 23:48:03 +00002527 Vdbe *v = pParse->pVdbe;
2528 int i;
drhda250ea2008-04-01 05:07:14 +00002529 struct yColCache *p;
drhe55cbd72008-03-31 23:48:03 +00002530
drhceea3322009-04-23 13:22:42 +00002531 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drhb6da74e2009-12-24 16:00:28 +00002532 if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
drhceea3322009-04-23 13:22:42 +00002533 p->lru = pParse->iCacheCnt++;
drh5cd79232009-05-25 11:46:29 +00002534 sqlite3ExprCachePinRegister(pParse, p->iReg);
drhda250ea2008-04-01 05:07:14 +00002535 return p->iReg;
drhe55cbd72008-03-31 23:48:03 +00002536 }
2537 }
2538 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00002539 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00002540 if( p5 ){
2541 sqlite3VdbeChangeP5(v, p5);
2542 }else{
2543 sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2544 }
drhe55cbd72008-03-31 23:48:03 +00002545 return iReg;
2546}
drhce78bc62015-10-15 19:21:51 +00002547void sqlite3ExprCodeGetColumnToReg(
2548 Parse *pParse, /* Parsing and code generating context */
2549 Table *pTab, /* Description of the table we are reading from */
2550 int iColumn, /* Index of the table column */
2551 int iTable, /* The cursor pointing to the table */
2552 int iReg /* Store results here */
2553){
2554 int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
2555 if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
2556}
2557
drhe55cbd72008-03-31 23:48:03 +00002558
2559/*
drhceea3322009-04-23 13:22:42 +00002560** Clear all column cache entries.
drhe55cbd72008-03-31 23:48:03 +00002561*/
drhceea3322009-04-23 13:22:42 +00002562void sqlite3ExprCacheClear(Parse *pParse){
2563 int i;
2564 struct yColCache *p;
2565
drh9ac79622013-12-18 15:11:47 +00002566#if SQLITE_DEBUG
2567 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2568 printf("CLEAR\n");
2569 }
2570#endif
drhceea3322009-04-23 13:22:42 +00002571 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2572 if( p->iReg ){
2573 cacheEntryClear(pParse, p);
2574 p->iReg = 0;
drhe55cbd72008-03-31 23:48:03 +00002575 }
drhe55cbd72008-03-31 23:48:03 +00002576 }
2577}
2578
2579/*
drhda250ea2008-04-01 05:07:14 +00002580** Record the fact that an affinity change has occurred on iCount
2581** registers starting with iStart.
drhe55cbd72008-03-31 23:48:03 +00002582*/
drhda250ea2008-04-01 05:07:14 +00002583void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
drhf49f3522009-12-30 14:12:38 +00002584 sqlite3ExprCacheRemove(pParse, iStart, iCount);
drhe55cbd72008-03-31 23:48:03 +00002585}
2586
2587/*
drhb21e7c72008-06-22 12:37:57 +00002588** Generate code to move content from registers iFrom...iFrom+nReg-1
2589** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
drhe55cbd72008-03-31 23:48:03 +00002590*/
drhb21e7c72008-06-22 12:37:57 +00002591void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00002592 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00002593 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh236241a2014-09-12 17:41:30 +00002594 sqlite3ExprCacheRemove(pParse, iFrom, nReg);
drh945498f2007-02-24 11:52:52 +00002595}
2596
drhf49f3522009-12-30 14:12:38 +00002597#if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
drh92b01d52008-06-24 00:32:35 +00002598/*
drh652fbf52008-04-01 01:42:41 +00002599** Return true if any register in the range iFrom..iTo (inclusive)
2600** is used as part of the column cache.
drhf49f3522009-12-30 14:12:38 +00002601**
2602** This routine is used within assert() and testcase() macros only
2603** and does not appear in a normal build.
drh652fbf52008-04-01 01:42:41 +00002604*/
2605static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2606 int i;
drhceea3322009-04-23 13:22:42 +00002607 struct yColCache *p;
2608 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2609 int r = p->iReg;
drhf49f3522009-12-30 14:12:38 +00002610 if( r>=iFrom && r<=iTo ) return 1; /*NO_TEST*/
drh652fbf52008-04-01 01:42:41 +00002611 }
2612 return 0;
2613}
drhf49f3522009-12-30 14:12:38 +00002614#endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
drh652fbf52008-04-01 01:42:41 +00002615
2616/*
drha4c3c872013-09-12 17:29:25 +00002617** Convert an expression node to a TK_REGISTER
2618*/
2619static void exprToRegister(Expr *p, int iReg){
2620 p->op2 = p->op;
2621 p->op = TK_REGISTER;
2622 p->iTable = iReg;
2623 ExprClearProperty(p, EP_Skip);
2624}
2625
2626/*
drhcce7d172000-05-31 15:34:51 +00002627** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00002628** expression. Attempt to store the results in register "target".
2629** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00002630**
drh8b213892008-08-29 02:14:02 +00002631** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00002632** be stored in target. The result might be stored in some other
2633** register if it is convenient to do so. The calling function
2634** must check the return code and move the results to the desired
2635** register.
drhcce7d172000-05-31 15:34:51 +00002636*/
drh678ccce2008-03-31 18:19:54 +00002637int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00002638 Vdbe *v = pParse->pVdbe; /* The VM under construction */
2639 int op; /* The opcode being coded */
2640 int inReg = target; /* Results stored in register inReg */
2641 int regFree1 = 0; /* If non-zero free this temporary register */
2642 int regFree2 = 0; /* If non-zero free this temporary register */
drh678ccce2008-03-31 18:19:54 +00002643 int r1, r2, r3, r4; /* Various register numbers */
drh20411ea2009-05-29 19:00:12 +00002644 sqlite3 *db = pParse->db; /* The database connection */
drh10d1edf2013-11-15 15:52:39 +00002645 Expr tempX; /* Temporary expression node */
drhffe07b22005-11-03 00:41:17 +00002646
drh9cbf3422008-01-17 16:22:13 +00002647 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00002648 if( v==0 ){
2649 assert( pParse->db->mallocFailed );
2650 return 0;
2651 }
drh389a1ad2008-01-03 23:44:53 +00002652
2653 if( pExpr==0 ){
2654 op = TK_NULL;
2655 }else{
2656 op = pExpr->op;
2657 }
drhf2bc0132004-10-04 13:19:23 +00002658 switch( op ){
drh13449892005-09-07 21:22:45 +00002659 case TK_AGG_COLUMN: {
2660 AggInfo *pAggInfo = pExpr->pAggInfo;
2661 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
2662 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00002663 assert( pCol->iMem>0 );
2664 inReg = pCol->iMem;
drh13449892005-09-07 21:22:45 +00002665 break;
2666 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00002667 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00002668 pCol->iSorterColumn, target);
drh13449892005-09-07 21:22:45 +00002669 break;
2670 }
2671 /* Otherwise, fall thru into the TK_COLUMN case */
2672 }
drh967e8b72000-06-21 13:59:10 +00002673 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00002674 int iTab = pExpr->iTable;
2675 if( iTab<0 ){
2676 if( pParse->ckBase>0 ){
2677 /* Generating CHECK constraints or inserting into partial index */
2678 inReg = pExpr->iColumn + pParse->ckBase;
2679 break;
2680 }else{
drh1f9ca2c2015-08-25 16:57:52 +00002681 /* Coding an expression that is part of an index where column names
2682 ** in the index refer to the table to which the index belongs */
2683 iTab = pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00002684 }
drh22827922000-06-06 17:27:05 +00002685 }
drhb2b9d3d2013-08-01 01:14:43 +00002686 inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2687 pExpr->iColumn, iTab, target,
2688 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00002689 break;
2690 }
2691 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00002692 codeInteger(pParse, pExpr, 0, target);
drhfec19aa2004-05-19 20:41:03 +00002693 break;
2694 }
drh13573c72010-01-12 17:04:07 +00002695#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00002696 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00002697 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2698 codeReal(v, pExpr->u.zToken, 0, target);
drh598f1342007-10-23 15:39:45 +00002699 break;
2700 }
drh13573c72010-01-12 17:04:07 +00002701#endif
drhfec19aa2004-05-19 20:41:03 +00002702 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00002703 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00002704 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhcce7d172000-05-31 15:34:51 +00002705 break;
2706 }
drhf0863fe2005-06-12 21:35:51 +00002707 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00002708 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhf0863fe2005-06-12 21:35:51 +00002709 break;
2710 }
danielk19775338a5f2005-01-20 13:03:10 +00002711#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00002712 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00002713 int n;
2714 const char *z;
drhca48c902008-01-18 14:08:24 +00002715 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00002716 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2717 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
2718 assert( pExpr->u.zToken[1]=='\'' );
2719 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00002720 n = sqlite3Strlen30(z) - 1;
2721 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00002722 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2723 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
danielk1977c572ef72004-05-27 09:28:41 +00002724 break;
2725 }
danielk19775338a5f2005-01-20 13:03:10 +00002726#endif
drh50457892003-09-06 01:10:47 +00002727 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00002728 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2729 assert( pExpr->u.zToken!=0 );
2730 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00002731 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
2732 if( pExpr->u.zToken[1]!=0 ){
drh04e9eea2011-06-01 19:16:06 +00002733 assert( pExpr->u.zToken[0]=='?'
2734 || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
2735 sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
drh895d7472004-08-20 16:02:39 +00002736 }
drh50457892003-09-06 01:10:47 +00002737 break;
2738 }
drh4e0cff62004-11-05 05:10:28 +00002739 case TK_REGISTER: {
drh9de221d2008-01-05 06:51:30 +00002740 inReg = pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00002741 break;
2742 }
drh487e2622005-06-25 18:42:14 +00002743#ifndef SQLITE_OMIT_CAST
2744 case TK_CAST: {
2745 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00002746 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00002747 if( inReg!=target ){
2748 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
2749 inReg = target;
2750 }
drh4169e432014-08-25 20:11:52 +00002751 sqlite3VdbeAddOp2(v, OP_Cast, target,
2752 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc5499be2008-04-01 15:06:33 +00002753 testcase( usedAsColumnCache(pParse, inReg, inReg) );
drhb3843a82008-04-01 12:24:11 +00002754 sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
drh487e2622005-06-25 18:42:14 +00002755 break;
2756 }
2757#endif /* SQLITE_OMIT_CAST */
drhc9b84a12002-06-20 11:36:48 +00002758 case TK_LT:
2759 case TK_LE:
2760 case TK_GT:
2761 case TK_GE:
2762 case TK_NE:
2763 case TK_EQ: {
drhb6da74e2009-12-24 16:00:28 +00002764 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2765 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00002766 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
2767 r1, r2, inReg, SQLITE_STOREP2);
drh7d176102014-02-18 03:07:12 +00002768 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
2769 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
2770 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
2771 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
2772 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
2773 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00002774 testcase( regFree1==0 );
2775 testcase( regFree2==0 );
danielk1977a37cdde2004-05-16 11:15:36 +00002776 break;
drhc9b84a12002-06-20 11:36:48 +00002777 }
drh6a2fe092009-09-23 02:29:36 +00002778 case TK_IS:
2779 case TK_ISNOT: {
2780 testcase( op==TK_IS );
2781 testcase( op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00002782 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2783 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00002784 op = (op==TK_IS) ? TK_EQ : TK_NE;
2785 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
2786 r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00002787 VdbeCoverageIf(v, op==TK_EQ);
2788 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00002789 testcase( regFree1==0 );
2790 testcase( regFree2==0 );
2791 break;
2792 }
drhcce7d172000-05-31 15:34:51 +00002793 case TK_AND:
2794 case TK_OR:
2795 case TK_PLUS:
2796 case TK_STAR:
2797 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00002798 case TK_REM:
2799 case TK_BITAND:
2800 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00002801 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00002802 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00002803 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00002804 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00002805 assert( TK_AND==OP_And ); testcase( op==TK_AND );
2806 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
2807 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
2808 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
2809 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
2810 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
2811 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
2812 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
2813 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
2814 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
2815 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00002816 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2817 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00002818 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00002819 testcase( regFree1==0 );
2820 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00002821 break;
2822 }
drhcce7d172000-05-31 15:34:51 +00002823 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00002824 Expr *pLeft = pExpr->pLeft;
2825 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00002826 if( pLeft->op==TK_INTEGER ){
2827 codeInteger(pParse, pLeft, 1, target);
2828#ifndef SQLITE_OMIT_FLOATING_POINT
2829 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00002830 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2831 codeReal(v, pLeft->u.zToken, 1, target);
drh13573c72010-01-12 17:04:07 +00002832#endif
drh3c84ddf2008-01-09 02:15:38 +00002833 }else{
drh10d1edf2013-11-15 15:52:39 +00002834 tempX.op = TK_INTEGER;
2835 tempX.flags = EP_IntValue|EP_TokenOnly;
2836 tempX.u.iValue = 0;
2837 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00002838 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00002839 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00002840 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00002841 }
drh3c84ddf2008-01-09 02:15:38 +00002842 inReg = target;
2843 break;
drh6e142f52000-06-08 13:36:40 +00002844 }
drhbf4133c2001-10-13 02:59:08 +00002845 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00002846 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00002847 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
2848 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00002849 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2850 testcase( regFree1==0 );
2851 inReg = target;
2852 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00002853 break;
2854 }
2855 case TK_ISNULL:
2856 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00002857 int addr;
drh7d176102014-02-18 03:07:12 +00002858 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
2859 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00002860 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00002861 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00002862 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00002863 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00002864 VdbeCoverageIf(v, op==TK_ISNULL);
2865 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00002866 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00002867 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00002868 break;
drhcce7d172000-05-31 15:34:51 +00002869 }
drh22827922000-06-06 17:27:05 +00002870 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00002871 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00002872 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00002873 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2874 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00002875 }else{
drh9de221d2008-01-05 06:51:30 +00002876 inReg = pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00002877 }
drh22827922000-06-06 17:27:05 +00002878 break;
2879 }
drhcce7d172000-05-31 15:34:51 +00002880 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00002881 ExprList *pFarg; /* List of function arguments */
2882 int nFarg; /* Number of function arguments */
2883 FuncDef *pDef; /* The function definition object */
2884 int nId; /* Length of the function name in bytes */
2885 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00002886 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00002887 int i; /* Loop counter */
2888 u8 enc = ENC(db); /* The text encoding used by this database */
2889 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00002890
danielk19776ab3a2e2009-02-19 14:39:25 +00002891 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00002892 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00002893 pFarg = 0;
2894 }else{
2895 pFarg = pExpr->x.pList;
2896 }
2897 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00002898 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2899 zId = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00002900 nId = sqlite3Strlen30(zId);
drh12ffee82009-04-08 13:51:51 +00002901 pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
drh2d801512016-01-14 22:19:58 +00002902 if( pDef==0 || pDef->xFinalize!=0 ){
drhfeb306f2009-08-18 16:05:46 +00002903 sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2904 break;
2905 }
drhae6bb952009-11-11 00:24:31 +00002906
2907 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00002908 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00002909 ** arguments past the first non-NULL argument.
2910 */
drhd36e1042013-09-06 13:10:12 +00002911 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhae6bb952009-11-11 00:24:31 +00002912 int endCoalesce = sqlite3VdbeMakeLabel(v);
2913 assert( nFarg>=2 );
2914 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2915 for(i=1; i<nFarg; i++){
2916 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00002917 VdbeCoverage(v);
drhf49f3522009-12-30 14:12:38 +00002918 sqlite3ExprCacheRemove(pParse, target, 1);
drhae6bb952009-11-11 00:24:31 +00002919 sqlite3ExprCachePush(pParse);
2920 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhd2490902014-04-13 19:28:15 +00002921 sqlite3ExprCachePop(pParse);
drhae6bb952009-11-11 00:24:31 +00002922 }
2923 sqlite3VdbeResolveLabel(v, endCoalesce);
2924 break;
2925 }
2926
drhcca9f3d2013-09-06 15:23:29 +00002927 /* The UNLIKELY() function is a no-op. The result is the value
2928 ** of the first argument.
2929 */
2930 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2931 assert( nFarg>=1 );
drh5f02ab02015-06-20 13:18:34 +00002932 inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00002933 break;
2934 }
drhae6bb952009-11-11 00:24:31 +00002935
drhd1a01ed2013-11-21 16:08:52 +00002936 for(i=0; i<nFarg; i++){
2937 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00002938 testcase( i==31 );
2939 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00002940 }
2941 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
2942 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2943 }
2944 }
drh12ffee82009-04-08 13:51:51 +00002945 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00002946 if( constMask ){
2947 r1 = pParse->nMem+1;
2948 pParse->nMem += nFarg;
2949 }else{
2950 r1 = sqlite3GetTempRange(pParse, nFarg);
2951 }
drha748fdc2012-03-28 01:34:47 +00002952
2953 /* For length() and typeof() functions with a column argument,
2954 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2955 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2956 ** loading.
2957 */
drhd36e1042013-09-06 13:10:12 +00002958 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00002959 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00002960 assert( nFarg==1 );
2961 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00002962 exprOp = pFarg->a[0].pExpr->op;
2963 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00002964 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2965 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00002966 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
2967 pFarg->a[0].pExpr->op2 =
2968 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00002969 }
2970 }
2971
drhd7d385d2009-09-03 01:18:00 +00002972 sqlite3ExprCachePush(pParse); /* Ticket 2ea2425d34be */
drh5579d592015-08-26 14:01:41 +00002973 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00002974 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drhd2490902014-04-13 19:28:15 +00002975 sqlite3ExprCachePop(pParse); /* Ticket 2ea2425d34be */
drh892d3172008-01-10 03:46:36 +00002976 }else{
drh12ffee82009-04-08 13:51:51 +00002977 r1 = 0;
drh892d3172008-01-10 03:46:36 +00002978 }
drhb7f6f682006-07-08 17:06:43 +00002979#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00002980 /* Possibly overload the function if the first argument is
2981 ** a virtual table column.
2982 **
2983 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2984 ** second argument, not the first, as the argument to test to
2985 ** see if it is a column in a virtual table. This is done because
2986 ** the left operand of infix functions (the operand we want to
2987 ** control overloading) ends up as the second argument to the
2988 ** function. The expression "A glob B" is equivalent to
2989 ** "glob(B,A). We want to use the A in "A glob B" to test
2990 ** for function overloading. But we use the B term in "glob(B,A)".
2991 */
drh12ffee82009-04-08 13:51:51 +00002992 if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
2993 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
2994 }else if( nFarg>0 ){
2995 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00002996 }
2997#endif
drhd36e1042013-09-06 13:10:12 +00002998 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00002999 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003000 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003001 }
drh9c7c9132015-06-26 18:16:52 +00003002 sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
drh66a51672008-01-03 00:01:23 +00003003 (char*)pDef, P4_FUNCDEF);
drh12ffee82009-04-08 13:51:51 +00003004 sqlite3VdbeChangeP5(v, (u8)nFarg);
drhd1a01ed2013-11-21 16:08:52 +00003005 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003006 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003007 }
drhcce7d172000-05-31 15:34:51 +00003008 break;
3009 }
drhfe2093d2005-01-20 22:48:47 +00003010#ifndef SQLITE_OMIT_SUBQUERY
3011 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003012 case TK_SELECT: {
drhc5499be2008-04-01 15:06:33 +00003013 testcase( op==TK_EXISTS );
3014 testcase( op==TK_SELECT );
drh1450bc62009-10-30 13:25:56 +00003015 inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
drh19a775c2000-06-05 18:54:46 +00003016 break;
3017 }
drhfef52082000-06-06 01:50:43 +00003018 case TK_IN: {
drhe3365e62009-11-12 17:52:24 +00003019 int destIfFalse = sqlite3VdbeMakeLabel(v);
3020 int destIfNull = sqlite3VdbeMakeLabel(v);
3021 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3022 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3023 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3024 sqlite3VdbeResolveLabel(v, destIfFalse);
3025 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3026 sqlite3VdbeResolveLabel(v, destIfNull);
drhfef52082000-06-06 01:50:43 +00003027 break;
3028 }
drhe3365e62009-11-12 17:52:24 +00003029#endif /* SQLITE_OMIT_SUBQUERY */
3030
3031
drh2dcef112008-01-12 19:03:48 +00003032 /*
3033 ** x BETWEEN y AND z
3034 **
3035 ** This is equivalent to
3036 **
3037 ** x>=y AND x<=z
3038 **
3039 ** X is stored in pExpr->pLeft.
3040 ** Y is stored in pExpr->pList->a[0].pExpr.
3041 ** Z is stored in pExpr->pList->a[1].pExpr.
3042 */
drhfef52082000-06-06 01:50:43 +00003043 case TK_BETWEEN: {
drhbe5c89a2004-07-26 00:31:09 +00003044 Expr *pLeft = pExpr->pLeft;
danielk19776ab3a2e2009-02-19 14:39:25 +00003045 struct ExprList_item *pLItem = pExpr->x.pList->a;
drhbe5c89a2004-07-26 00:31:09 +00003046 Expr *pRight = pLItem->pExpr;
drh35573352008-01-08 23:54:25 +00003047
drhb6da74e2009-12-24 16:00:28 +00003048 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3049 r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
drhc5499be2008-04-01 15:06:33 +00003050 testcase( regFree1==0 );
3051 testcase( regFree2==0 );
drh2dcef112008-01-12 19:03:48 +00003052 r3 = sqlite3GetTempReg(pParse);
drh678ccce2008-03-31 18:19:54 +00003053 r4 = sqlite3GetTempReg(pParse);
drh35573352008-01-08 23:54:25 +00003054 codeCompare(pParse, pLeft, pRight, OP_Ge,
drh7d176102014-02-18 03:07:12 +00003055 r1, r2, r3, SQLITE_STOREP2); VdbeCoverage(v);
drhbe5c89a2004-07-26 00:31:09 +00003056 pLItem++;
3057 pRight = pLItem->pExpr;
drh2dcef112008-01-12 19:03:48 +00003058 sqlite3ReleaseTempReg(pParse, regFree2);
3059 r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
drhc5499be2008-04-01 15:06:33 +00003060 testcase( regFree2==0 );
drh678ccce2008-03-31 18:19:54 +00003061 codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
drh688852a2014-02-17 22:40:43 +00003062 VdbeCoverage(v);
drh678ccce2008-03-31 18:19:54 +00003063 sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
drh2dcef112008-01-12 19:03:48 +00003064 sqlite3ReleaseTempReg(pParse, r3);
drh678ccce2008-03-31 18:19:54 +00003065 sqlite3ReleaseTempReg(pParse, r4);
drhfef52082000-06-06 01:50:43 +00003066 break;
3067 }
drhae80dde2012-12-06 21:16:43 +00003068 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003069 case TK_UPLUS: {
drh2dcef112008-01-12 19:03:48 +00003070 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drha2e00042002-01-22 03:13:42 +00003071 break;
3072 }
drh2dcef112008-01-12 19:03:48 +00003073
dan165921a2009-08-28 18:53:45 +00003074 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003075 /* If the opcode is TK_TRIGGER, then the expression is a reference
3076 ** to a column in the new.* or old.* pseudo-tables available to
3077 ** trigger programs. In this case Expr.iTable is set to 1 for the
3078 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3079 ** is set to the column of the pseudo-table to read, or to -1 to
3080 ** read the rowid field.
3081 **
3082 ** The expression is implemented using an OP_Param opcode. The p1
3083 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3084 ** to reference another column of the old.* pseudo-table, where
3085 ** i is the index of the column. For a new.rowid reference, p1 is
3086 ** set to (n+1), where n is the number of columns in each pseudo-table.
3087 ** For a reference to any other column in the new.* pseudo-table, p1
3088 ** is set to (n+2+i), where n and i are as defined previously. For
3089 ** example, if the table on which triggers are being fired is
3090 ** declared as:
3091 **
3092 ** CREATE TABLE t1(a, b);
3093 **
3094 ** Then p1 is interpreted as follows:
3095 **
3096 ** p1==0 -> old.rowid p1==3 -> new.rowid
3097 ** p1==1 -> old.a p1==4 -> new.a
3098 ** p1==2 -> old.b p1==5 -> new.b
3099 */
dan2832ad42009-08-31 15:27:27 +00003100 Table *pTab = pExpr->pTab;
dan65a7cd12009-09-01 12:16:01 +00003101 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3102
3103 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3104 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3105 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3106 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3107
3108 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
dan2bd93512009-08-31 08:22:46 +00003109 VdbeComment((v, "%s.%s -> $%d",
3110 (pExpr->iTable ? "new" : "old"),
dan76d462e2009-08-30 11:42:51 +00003111 (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
dan2bd93512009-08-31 08:22:46 +00003112 target
dan165921a2009-08-28 18:53:45 +00003113 ));
dan65a7cd12009-09-01 12:16:01 +00003114
drh44dbca82010-01-13 04:22:20 +00003115#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003116 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003117 ** integer. Use OP_RealAffinity to make sure it is really real.
3118 **
3119 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3120 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003121 if( pExpr->iColumn>=0
3122 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3123 ){
3124 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3125 }
drh44dbca82010-01-13 04:22:20 +00003126#endif
dan165921a2009-08-28 18:53:45 +00003127 break;
3128 }
3129
3130
drh2dcef112008-01-12 19:03:48 +00003131 /*
3132 ** Form A:
3133 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3134 **
3135 ** Form B:
3136 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3137 **
3138 ** Form A is can be transformed into the equivalent form B as follows:
3139 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
3140 ** WHEN x=eN THEN rN ELSE y END
3141 **
3142 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00003143 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3144 ** odd. The Y is also optional. If the number of elements in x.pList
3145 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00003146 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
3147 **
3148 ** The result of the expression is the Ri for the first matching Ei,
3149 ** or if there is no matching Ei, the ELSE term Y, or if there is
3150 ** no ELSE term, NULL.
3151 */
drh33cd4902009-05-30 20:49:20 +00003152 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00003153 int endLabel; /* GOTO label for end of CASE stmt */
3154 int nextCase; /* GOTO label for next WHEN clause */
3155 int nExpr; /* 2x number of WHEN terms */
3156 int i; /* Loop counter */
3157 ExprList *pEList; /* List of WHEN terms */
3158 struct ExprList_item *aListelem; /* Array of WHEN terms */
3159 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00003160 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00003161 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drhceea3322009-04-23 13:22:42 +00003162 VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
drh17a7f8d2002-03-24 13:13:27 +00003163
danielk19776ab3a2e2009-02-19 14:39:25 +00003164 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00003165 assert(pExpr->x.pList->nExpr > 0);
3166 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00003167 aListelem = pEList->a;
3168 nExpr = pEList->nExpr;
drh2dcef112008-01-12 19:03:48 +00003169 endLabel = sqlite3VdbeMakeLabel(v);
3170 if( (pX = pExpr->pLeft)!=0 ){
drh10d1edf2013-11-15 15:52:39 +00003171 tempX = *pX;
drh33cd4902009-05-30 20:49:20 +00003172 testcase( pX->op==TK_COLUMN );
drh10d1edf2013-11-15 15:52:39 +00003173 exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00003174 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003175 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00003176 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00003177 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00003178 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
3179 ** The value in regFree1 might get SCopy-ed into the file result.
3180 ** So make sure that the regFree1 register is not reused for other
3181 ** purposes and possibly overwritten. */
3182 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00003183 }
drhc5cd1242013-09-12 16:50:49 +00003184 for(i=0; i<nExpr-1; i=i+2){
drhceea3322009-04-23 13:22:42 +00003185 sqlite3ExprCachePush(pParse);
drh2dcef112008-01-12 19:03:48 +00003186 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00003187 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00003188 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003189 }else{
drh2dcef112008-01-12 19:03:48 +00003190 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003191 }
drh2dcef112008-01-12 19:03:48 +00003192 nextCase = sqlite3VdbeMakeLabel(v);
drh33cd4902009-05-30 20:49:20 +00003193 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00003194 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00003195 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00003196 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00003197 sqlite3VdbeGoto(v, endLabel);
drhd2490902014-04-13 19:28:15 +00003198 sqlite3ExprCachePop(pParse);
drh2dcef112008-01-12 19:03:48 +00003199 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00003200 }
drhc5cd1242013-09-12 16:50:49 +00003201 if( (nExpr&1)!=0 ){
drhceea3322009-04-23 13:22:42 +00003202 sqlite3ExprCachePush(pParse);
drhc5cd1242013-09-12 16:50:49 +00003203 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drhd2490902014-04-13 19:28:15 +00003204 sqlite3ExprCachePop(pParse);
drh17a7f8d2002-03-24 13:13:27 +00003205 }else{
drh9de221d2008-01-05 06:51:30 +00003206 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00003207 }
danielk1977c1f4a192009-04-28 12:08:15 +00003208 assert( db->mallocFailed || pParse->nErr>0
3209 || pParse->iCacheLevel==iCacheLevel );
drh2dcef112008-01-12 19:03:48 +00003210 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00003211 break;
3212 }
danielk19775338a5f2005-01-20 13:03:10 +00003213#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00003214 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00003215 assert( pExpr->affinity==OE_Rollback
3216 || pExpr->affinity==OE_Abort
3217 || pExpr->affinity==OE_Fail
3218 || pExpr->affinity==OE_Ignore
3219 );
dane0af83a2009-09-08 19:15:01 +00003220 if( !pParse->pTriggerTab ){
3221 sqlite3ErrorMsg(pParse,
3222 "RAISE() may only be used within a trigger-program");
3223 return 0;
3224 }
3225 if( pExpr->affinity==OE_Abort ){
3226 sqlite3MayAbort(pParse);
3227 }
dan165921a2009-08-28 18:53:45 +00003228 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00003229 if( pExpr->affinity==OE_Ignore ){
3230 sqlite3VdbeAddOp4(
3231 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00003232 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00003233 }else{
drh433dccf2013-02-09 15:37:11 +00003234 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00003235 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00003236 }
3237
drhffe07b22005-11-03 00:41:17 +00003238 break;
drh17a7f8d2002-03-24 13:13:27 +00003239 }
danielk19775338a5f2005-01-20 13:03:10 +00003240#endif
drhffe07b22005-11-03 00:41:17 +00003241 }
drh2dcef112008-01-12 19:03:48 +00003242 sqlite3ReleaseTempReg(pParse, regFree1);
3243 sqlite3ReleaseTempReg(pParse, regFree2);
3244 return inReg;
3245}
3246
3247/*
drhd1a01ed2013-11-21 16:08:52 +00003248** Factor out the code of the given expression to initialization time.
3249*/
drhd673cdd2013-11-21 21:23:31 +00003250void sqlite3ExprCodeAtInit(
3251 Parse *pParse, /* Parsing context */
3252 Expr *pExpr, /* The expression to code when the VDBE initializes */
3253 int regDest, /* Store the value in this register */
3254 u8 reusable /* True if this expression is reusable */
3255){
drhd1a01ed2013-11-21 16:08:52 +00003256 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00003257 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00003258 p = pParse->pConstExpr;
3259 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3260 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00003261 if( p ){
3262 struct ExprList_item *pItem = &p->a[p->nExpr-1];
3263 pItem->u.iConstExprReg = regDest;
3264 pItem->reusable = reusable;
3265 }
drhd1a01ed2013-11-21 16:08:52 +00003266 pParse->pConstExpr = p;
3267}
3268
3269/*
drh2dcef112008-01-12 19:03:48 +00003270** Generate code to evaluate an expression and store the results
3271** into a register. Return the register number where the results
3272** are stored.
3273**
3274** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00003275** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00003276** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00003277**
3278** If pExpr is a constant, then this routine might generate this
3279** code to fill the register in the initialization section of the
3280** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00003281*/
3282int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00003283 int r2;
3284 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00003285 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00003286 && pExpr->op!=TK_REGISTER
3287 && sqlite3ExprIsConstantNotJoin(pExpr)
3288 ){
3289 ExprList *p = pParse->pConstExpr;
3290 int i;
3291 *pReg = 0;
3292 if( p ){
drhd673cdd2013-11-21 21:23:31 +00003293 struct ExprList_item *pItem;
3294 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3295 if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3296 return pItem->u.iConstExprReg;
drhf30a9692013-11-15 01:10:18 +00003297 }
3298 }
3299 }
drhf30a9692013-11-15 01:10:18 +00003300 r2 = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00003301 sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
drh2dcef112008-01-12 19:03:48 +00003302 }else{
drhf30a9692013-11-15 01:10:18 +00003303 int r1 = sqlite3GetTempReg(pParse);
3304 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
3305 if( r2==r1 ){
3306 *pReg = r1;
3307 }else{
3308 sqlite3ReleaseTempReg(pParse, r1);
3309 *pReg = 0;
3310 }
drh2dcef112008-01-12 19:03:48 +00003311 }
3312 return r2;
3313}
3314
3315/*
3316** Generate code that will evaluate expression pExpr and store the
3317** results in register target. The results are guaranteed to appear
3318** in register target.
3319*/
drh05a86c52014-02-16 01:55:49 +00003320void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00003321 int inReg;
3322
3323 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00003324 if( pExpr && pExpr->op==TK_REGISTER ){
3325 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3326 }else{
3327 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00003328 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00003329 if( inReg!=target && pParse->pVdbe ){
3330 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
3331 }
drhcce7d172000-05-31 15:34:51 +00003332 }
drhcce7d172000-05-31 15:34:51 +00003333}
3334
3335/*
drh1c75c9d2015-12-21 15:22:13 +00003336** Make a transient copy of expression pExpr and then code it using
3337** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
3338** except that the input expression is guaranteed to be unchanged.
3339*/
3340void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
3341 sqlite3 *db = pParse->db;
3342 pExpr = sqlite3ExprDup(db, pExpr, 0);
3343 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
3344 sqlite3ExprDelete(db, pExpr);
3345}
3346
3347/*
drh05a86c52014-02-16 01:55:49 +00003348** Generate code that will evaluate expression pExpr and store the
3349** results in register target. The results are guaranteed to appear
3350** in register target. If the expression is constant, then this routine
3351** might choose to code the expression at initialization time.
3352*/
3353void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
3354 if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
3355 sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
3356 }else{
3357 sqlite3ExprCode(pParse, pExpr, target);
3358 }
drhcce7d172000-05-31 15:34:51 +00003359}
3360
3361/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003362** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00003363** in register target.
drh25303782004-12-07 15:41:48 +00003364**
drh2dcef112008-01-12 19:03:48 +00003365** Also make a copy of the expression results into another "cache" register
3366** and modify the expression so that the next time it is evaluated,
3367** the result is a copy of the cache register.
3368**
3369** This routine is used for expressions that are used multiple
3370** times. They are evaluated once and the results of the expression
3371** are reused.
drh25303782004-12-07 15:41:48 +00003372*/
drh05a86c52014-02-16 01:55:49 +00003373void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00003374 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00003375 int iMem;
3376
drhde4fcfd2008-01-19 23:50:26 +00003377 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00003378 assert( pExpr->op!=TK_REGISTER );
3379 sqlite3ExprCode(pParse, pExpr, target);
3380 iMem = ++pParse->nMem;
3381 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3382 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00003383}
drh2dcef112008-01-12 19:03:48 +00003384
drh678ccce2008-03-31 18:19:54 +00003385/*
drh268380c2004-02-25 13:47:31 +00003386** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00003387** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00003388**
drh892d3172008-01-10 03:46:36 +00003389** Return the number of elements evaluated.
drhd1a01ed2013-11-21 16:08:52 +00003390**
3391** The SQLITE_ECEL_DUP flag prevents the arguments from being
3392** filled using OP_SCopy. OP_Copy must be used instead.
3393**
3394** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3395** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00003396**
3397** The SQLITE_ECEL_REF flag means that expressions in the list with
3398** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
3399** in registers at srcReg, and so the value can be copied from there.
drh268380c2004-02-25 13:47:31 +00003400*/
danielk19774adee202004-05-08 08:23:19 +00003401int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00003402 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00003403 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00003404 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00003405 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00003406 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00003407){
3408 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00003409 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00003410 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00003411 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00003412 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00003413 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00003414 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00003415 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00003416 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00003417 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00003418 Expr *pExpr = pItem->pExpr;
drh5579d592015-08-26 14:01:41 +00003419 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
3420 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
3421 }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
drhd673cdd2013-11-21 21:23:31 +00003422 sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
drhd1a01ed2013-11-21 16:08:52 +00003423 }else{
3424 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3425 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00003426 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00003427 if( copyOp==OP_Copy
3428 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
3429 && pOp->p1+pOp->p3+1==inReg
3430 && pOp->p2+pOp->p3+1==target+i
3431 ){
3432 pOp->p3++;
3433 }else{
3434 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
3435 }
drhd1a01ed2013-11-21 16:08:52 +00003436 }
drhd1766112008-09-17 00:13:12 +00003437 }
drh268380c2004-02-25 13:47:31 +00003438 }
drhf9b596e2004-05-26 16:54:42 +00003439 return n;
drh268380c2004-02-25 13:47:31 +00003440}
3441
3442/*
drh36c563a2009-11-12 13:32:22 +00003443** Generate code for a BETWEEN operator.
3444**
3445** x BETWEEN y AND z
3446**
3447** The above is equivalent to
3448**
3449** x>=y AND x<=z
3450**
3451** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00003452** elimination of x.
drh36c563a2009-11-12 13:32:22 +00003453*/
3454static void exprCodeBetween(
3455 Parse *pParse, /* Parsing and code generating context */
3456 Expr *pExpr, /* The BETWEEN expression */
3457 int dest, /* Jump here if the jump is taken */
3458 int jumpIfTrue, /* Take the jump if the BETWEEN is true */
3459 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
3460){
3461 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
3462 Expr compLeft; /* The x>=y term */
3463 Expr compRight; /* The x<=z term */
3464 Expr exprX; /* The x subexpression */
3465 int regFree1 = 0; /* Temporary use register */
3466
3467 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3468 exprX = *pExpr->pLeft;
3469 exprAnd.op = TK_AND;
3470 exprAnd.pLeft = &compLeft;
3471 exprAnd.pRight = &compRight;
3472 compLeft.op = TK_GE;
3473 compLeft.pLeft = &exprX;
3474 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
3475 compRight.op = TK_LE;
3476 compRight.pLeft = &exprX;
3477 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drha4c3c872013-09-12 17:29:25 +00003478 exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
drh36c563a2009-11-12 13:32:22 +00003479 if( jumpIfTrue ){
3480 sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
3481 }else{
3482 sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
3483 }
3484 sqlite3ReleaseTempReg(pParse, regFree1);
3485
3486 /* Ensure adequate test coverage */
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 testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
3492 testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
3493 testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
3494 testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
3495}
3496
3497/*
drhcce7d172000-05-31 15:34:51 +00003498** Generate code for a boolean expression such that a jump is made
3499** to the label "dest" if the expression is true but execution
3500** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00003501**
3502** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00003503** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00003504**
3505** This code depends on the fact that certain token values (ex: TK_EQ)
3506** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3507** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
3508** the make process cause these values to align. Assert()s in the code
3509** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00003510*/
danielk19774adee202004-05-08 08:23:19 +00003511void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00003512 Vdbe *v = pParse->pVdbe;
3513 int op = 0;
drh2dcef112008-01-12 19:03:48 +00003514 int regFree1 = 0;
3515 int regFree2 = 0;
3516 int r1, r2;
3517
drh35573352008-01-08 23:54:25 +00003518 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00003519 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00003520 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00003521 op = pExpr->op;
3522 switch( op ){
drhcce7d172000-05-31 15:34:51 +00003523 case TK_AND: {
danielk19774adee202004-05-08 08:23:19 +00003524 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00003525 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00003526 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00003527 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003528 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3529 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00003530 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003531 break;
3532 }
3533 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00003534 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003535 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00003536 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003537 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00003538 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003539 break;
3540 }
3541 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00003542 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003543 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00003544 break;
3545 }
3546 case TK_LT:
3547 case TK_LE:
3548 case TK_GT:
3549 case TK_GE:
3550 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00003551 case TK_EQ: {
drhc5499be2008-04-01 15:06:33 +00003552 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00003553 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3554 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00003555 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00003556 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00003557 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3558 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3559 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3560 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3561 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3562 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00003563 testcase( regFree1==0 );
3564 testcase( regFree2==0 );
drhcce7d172000-05-31 15:34:51 +00003565 break;
3566 }
drh6a2fe092009-09-23 02:29:36 +00003567 case TK_IS:
3568 case TK_ISNOT: {
3569 testcase( op==TK_IS );
3570 testcase( op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00003571 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3572 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00003573 op = (op==TK_IS) ? TK_EQ : TK_NE;
3574 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
3575 r1, r2, dest, SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00003576 VdbeCoverageIf(v, op==TK_EQ);
3577 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00003578 testcase( regFree1==0 );
3579 testcase( regFree2==0 );
3580 break;
3581 }
drhcce7d172000-05-31 15:34:51 +00003582 case TK_ISNULL:
3583 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00003584 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3585 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00003586 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3587 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00003588 VdbeCoverageIf(v, op==TK_ISNULL);
3589 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00003590 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00003591 break;
3592 }
drhfef52082000-06-06 01:50:43 +00003593 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00003594 testcase( jumpIfNull==0 );
drh36c563a2009-11-12 13:32:22 +00003595 exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00003596 break;
3597 }
drh84e30ca2011-02-10 17:46:14 +00003598#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00003599 case TK_IN: {
3600 int destIfFalse = sqlite3VdbeMakeLabel(v);
3601 int destIfNull = jumpIfNull ? dest : destIfFalse;
3602 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00003603 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00003604 sqlite3VdbeResolveLabel(v, destIfFalse);
3605 break;
3606 }
shanehbb201342011-02-09 19:55:20 +00003607#endif
drhcce7d172000-05-31 15:34:51 +00003608 default: {
drh991a1982014-01-02 17:57:16 +00003609 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00003610 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00003611 }else if( exprAlwaysFalse(pExpr) ){
3612 /* No-op */
3613 }else{
3614 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
3615 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00003616 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00003617 testcase( regFree1==0 );
3618 testcase( jumpIfNull==0 );
3619 }
drhcce7d172000-05-31 15:34:51 +00003620 break;
3621 }
3622 }
drh2dcef112008-01-12 19:03:48 +00003623 sqlite3ReleaseTempReg(pParse, regFree1);
3624 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00003625}
3626
3627/*
drh66b89c82000-11-28 20:47:17 +00003628** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00003629** to the label "dest" if the expression is false but execution
3630** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00003631**
3632** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00003633** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
3634** is 0.
drhcce7d172000-05-31 15:34:51 +00003635*/
danielk19774adee202004-05-08 08:23:19 +00003636void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00003637 Vdbe *v = pParse->pVdbe;
3638 int op = 0;
drh2dcef112008-01-12 19:03:48 +00003639 int regFree1 = 0;
3640 int regFree2 = 0;
3641 int r1, r2;
3642
drh35573352008-01-08 23:54:25 +00003643 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00003644 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00003645 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00003646
3647 /* The value of pExpr->op and op are related as follows:
3648 **
3649 ** pExpr->op op
3650 ** --------- ----------
3651 ** TK_ISNULL OP_NotNull
3652 ** TK_NOTNULL OP_IsNull
3653 ** TK_NE OP_Eq
3654 ** TK_EQ OP_Ne
3655 ** TK_GT OP_Le
3656 ** TK_LE OP_Gt
3657 ** TK_GE OP_Lt
3658 ** TK_LT OP_Ge
3659 **
3660 ** For other values of pExpr->op, op is undefined and unused.
3661 ** The value of TK_ and OP_ constants are arranged such that we
3662 ** can compute the mapping above using the following expression.
3663 ** Assert()s verify that the computation is correct.
3664 */
3665 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3666
3667 /* Verify correct alignment of TK_ and OP_ constants
3668 */
3669 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3670 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3671 assert( pExpr->op!=TK_NE || op==OP_Eq );
3672 assert( pExpr->op!=TK_EQ || op==OP_Ne );
3673 assert( pExpr->op!=TK_LT || op==OP_Ge );
3674 assert( pExpr->op!=TK_LE || op==OP_Gt );
3675 assert( pExpr->op!=TK_GT || op==OP_Le );
3676 assert( pExpr->op!=TK_GE || op==OP_Lt );
3677
drhcce7d172000-05-31 15:34:51 +00003678 switch( pExpr->op ){
3679 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00003680 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003681 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00003682 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003683 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00003684 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003685 break;
3686 }
3687 case TK_OR: {
danielk19774adee202004-05-08 08:23:19 +00003688 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00003689 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00003690 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00003691 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003692 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3693 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00003694 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003695 break;
3696 }
3697 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00003698 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003699 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00003700 break;
3701 }
3702 case TK_LT:
3703 case TK_LE:
3704 case TK_GT:
3705 case TK_GE:
3706 case TK_NE:
3707 case TK_EQ: {
drhc5499be2008-04-01 15:06:33 +00003708 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00003709 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3710 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00003711 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00003712 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00003713 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3714 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3715 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3716 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3717 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3718 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00003719 testcase( regFree1==0 );
3720 testcase( regFree2==0 );
drhcce7d172000-05-31 15:34:51 +00003721 break;
3722 }
drh6a2fe092009-09-23 02:29:36 +00003723 case TK_IS:
3724 case TK_ISNOT: {
drh6d4486a2009-09-23 14:45:05 +00003725 testcase( pExpr->op==TK_IS );
3726 testcase( pExpr->op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00003727 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3728 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00003729 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
3730 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
3731 r1, r2, dest, SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00003732 VdbeCoverageIf(v, op==TK_EQ);
3733 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00003734 testcase( regFree1==0 );
3735 testcase( regFree2==0 );
3736 break;
3737 }
drhcce7d172000-05-31 15:34:51 +00003738 case TK_ISNULL:
3739 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00003740 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3741 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00003742 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
3743 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00003744 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00003745 break;
3746 }
drhfef52082000-06-06 01:50:43 +00003747 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00003748 testcase( jumpIfNull==0 );
drh36c563a2009-11-12 13:32:22 +00003749 exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00003750 break;
3751 }
drh84e30ca2011-02-10 17:46:14 +00003752#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00003753 case TK_IN: {
3754 if( jumpIfNull ){
3755 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3756 }else{
3757 int destIfNull = sqlite3VdbeMakeLabel(v);
3758 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3759 sqlite3VdbeResolveLabel(v, destIfNull);
3760 }
3761 break;
3762 }
shanehbb201342011-02-09 19:55:20 +00003763#endif
drhcce7d172000-05-31 15:34:51 +00003764 default: {
drh991a1982014-01-02 17:57:16 +00003765 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00003766 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00003767 }else if( exprAlwaysTrue(pExpr) ){
3768 /* no-op */
3769 }else{
3770 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
3771 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00003772 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00003773 testcase( regFree1==0 );
3774 testcase( jumpIfNull==0 );
3775 }
drhcce7d172000-05-31 15:34:51 +00003776 break;
3777 }
3778 }
drh2dcef112008-01-12 19:03:48 +00003779 sqlite3ReleaseTempReg(pParse, regFree1);
3780 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00003781}
drh22827922000-06-06 17:27:05 +00003782
3783/*
drh72bc8202015-06-11 13:58:35 +00003784** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
3785** code generation, and that copy is deleted after code generation. This
3786** ensures that the original pExpr is unchanged.
3787*/
3788void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
3789 sqlite3 *db = pParse->db;
3790 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
3791 if( db->mallocFailed==0 ){
3792 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
3793 }
3794 sqlite3ExprDelete(db, pCopy);
3795}
3796
3797
3798/*
drh1d9da702010-01-07 15:17:02 +00003799** Do a deep comparison of two expression trees. Return 0 if the two
3800** expressions are completely identical. Return 1 if they differ only
3801** by a COLLATE operator at the top level. Return 2 if there are differences
3802** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00003803**
drh619a1302013-08-01 13:04:46 +00003804** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3805** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3806**
drh66518ca2013-08-01 15:09:57 +00003807** The pA side might be using TK_REGISTER. If that is the case and pB is
3808** not using TK_REGISTER but is otherwise equivalent, then still return 0.
3809**
drh1d9da702010-01-07 15:17:02 +00003810** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00003811** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00003812** identical, we return 2 just to be safe. So if this routine
3813** returns 2, then you do not really know for certain if the two
3814** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00003815** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00003816** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00003817** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00003818** an incorrect 0 or 1 could lead to a malfunction.
drh22827922000-06-06 17:27:05 +00003819*/
drh619a1302013-08-01 13:04:46 +00003820int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00003821 u32 combinedFlags;
3822 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00003823 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00003824 }
drh10d1edf2013-11-15 15:52:39 +00003825 combinedFlags = pA->flags | pB->flags;
3826 if( combinedFlags & EP_IntValue ){
3827 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
3828 return 0;
3829 }
drh1d9da702010-01-07 15:17:02 +00003830 return 2;
drh22827922000-06-06 17:27:05 +00003831 }
drhc2acc4e2013-11-15 18:15:19 +00003832 if( pA->op!=pB->op ){
drh619a1302013-08-01 13:04:46 +00003833 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00003834 return 1;
3835 }
drh619a1302013-08-01 13:04:46 +00003836 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00003837 return 1;
3838 }
3839 return 2;
3840 }
drh2edc5fd2015-11-24 02:10:52 +00003841 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00003842 if( pA->op==TK_FUNCTION ){
3843 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
3844 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhae80dde2012-12-06 21:16:43 +00003845 return pA->op==TK_COLLATE ? 1 : 2;
drh2646da72005-12-09 20:02:05 +00003846 }
drh22827922000-06-06 17:27:05 +00003847 }
drh10d1edf2013-11-15 15:52:39 +00003848 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh85f8aa72013-11-15 20:06:26 +00003849 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00003850 if( combinedFlags & EP_xIsSelect ) return 2;
3851 if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3852 if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3853 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh7693c422015-04-17 19:41:37 +00003854 if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
drh10d1edf2013-11-15 15:52:39 +00003855 if( pA->iColumn!=pB->iColumn ) return 2;
3856 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00003857 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00003858 }
3859 }
drh1d9da702010-01-07 15:17:02 +00003860 return 0;
drh22827922000-06-06 17:27:05 +00003861}
3862
drh8c6f6662010-04-26 19:17:26 +00003863/*
3864** Compare two ExprList objects. Return 0 if they are identical and
3865** non-zero if they differ in any way.
3866**
drh619a1302013-08-01 13:04:46 +00003867** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3868** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3869**
drh8c6f6662010-04-26 19:17:26 +00003870** This routine might return non-zero for equivalent ExprLists. The
3871** only consequence will be disabled optimizations. But this routine
3872** must never return 0 if the two ExprList objects are different, or
3873** a malfunction will result.
3874**
3875** Two NULL pointers are considered to be the same. But a NULL pointer
3876** always differs from a non-NULL pointer.
3877*/
drh619a1302013-08-01 13:04:46 +00003878int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00003879 int i;
3880 if( pA==0 && pB==0 ) return 0;
3881 if( pA==0 || pB==0 ) return 1;
3882 if( pA->nExpr!=pB->nExpr ) return 1;
3883 for(i=0; i<pA->nExpr; i++){
3884 Expr *pExprA = pA->a[i].pExpr;
3885 Expr *pExprB = pB->a[i].pExpr;
3886 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
drh619a1302013-08-01 13:04:46 +00003887 if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00003888 }
3889 return 0;
3890}
drh13449892005-09-07 21:22:45 +00003891
drh22827922000-06-06 17:27:05 +00003892/*
drh4bd5f732013-07-31 23:22:39 +00003893** Return true if we can prove the pE2 will always be true if pE1 is
3894** true. Return false if we cannot complete the proof or if pE2 might
3895** be false. Examples:
3896**
drh619a1302013-08-01 13:04:46 +00003897** pE1: x==5 pE2: x==5 Result: true
3898** pE1: x>0 pE2: x==5 Result: false
3899** pE1: x=21 pE2: x=21 OR y=43 Result: true
3900** pE1: x!=123 pE2: x IS NOT NULL Result: true
3901** pE1: x!=?1 pE2: x IS NOT NULL Result: true
3902** pE1: x IS NULL pE2: x IS NOT NULL Result: false
3903** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00003904**
3905** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
3906** Expr.iTable<0 then assume a table number given by iTab.
3907**
3908** When in doubt, return false. Returning true might give a performance
3909** improvement. Returning false might cause a performance reduction, but
3910** it will always give the correct answer and is hence always safe.
3911*/
3912int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
drh619a1302013-08-01 13:04:46 +00003913 if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3914 return 1;
3915 }
3916 if( pE2->op==TK_OR
3917 && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3918 || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3919 ){
3920 return 1;
3921 }
3922 if( pE2->op==TK_NOTNULL
3923 && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3924 && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3925 ){
3926 return 1;
3927 }
3928 return 0;
drh4bd5f732013-07-31 23:22:39 +00003929}
3930
3931/*
drh030796d2012-08-23 16:18:10 +00003932** An instance of the following structure is used by the tree walker
3933** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00003934** aggregate function, in order to implement the
3935** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00003936*/
drh030796d2012-08-23 16:18:10 +00003937struct SrcCount {
3938 SrcList *pSrc; /* One particular FROM clause in a nested query */
3939 int nThis; /* Number of references to columns in pSrcList */
3940 int nOther; /* Number of references to columns in other FROM clauses */
3941};
3942
3943/*
3944** Count the number of references to columns.
3945*/
3946static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00003947 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3948 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3949 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
3950 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3951 ** NEVER() will need to be removed. */
3952 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00003953 int i;
drh030796d2012-08-23 16:18:10 +00003954 struct SrcCount *p = pWalker->u.pSrcCount;
3955 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00003956 int nSrc = pSrc ? pSrc->nSrc : 0;
3957 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00003958 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00003959 }
drh655814d2015-01-09 01:27:29 +00003960 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00003961 p->nThis++;
3962 }else{
3963 p->nOther++;
3964 }
drh374fdce2012-04-17 16:38:53 +00003965 }
drh030796d2012-08-23 16:18:10 +00003966 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00003967}
3968
3969/*
drh030796d2012-08-23 16:18:10 +00003970** Determine if any of the arguments to the pExpr Function reference
3971** pSrcList. Return true if they do. Also return true if the function
3972** has no arguments or has only constant arguments. Return false if pExpr
3973** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00003974*/
drh030796d2012-08-23 16:18:10 +00003975int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00003976 Walker w;
drh030796d2012-08-23 16:18:10 +00003977 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00003978 assert( pExpr->op==TK_AGG_FUNCTION );
3979 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00003980 w.xExprCallback = exprSrcCount;
3981 w.u.pSrcCount = &cnt;
3982 cnt.pSrc = pSrcList;
3983 cnt.nThis = 0;
3984 cnt.nOther = 0;
3985 sqlite3WalkExprList(&w, pExpr->x.pList);
3986 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00003987}
3988
3989/*
drh13449892005-09-07 21:22:45 +00003990** Add a new element to the pAggInfo->aCol[] array. Return the index of
3991** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00003992*/
drh17435752007-08-16 04:30:38 +00003993static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00003994 int i;
drhcf643722007-03-27 13:36:37 +00003995 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00003996 db,
drhcf643722007-03-27 13:36:37 +00003997 pInfo->aCol,
3998 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00003999 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00004000 &i
4001 );
drh13449892005-09-07 21:22:45 +00004002 return i;
4003}
4004
4005/*
4006** Add a new element to the pAggInfo->aFunc[] array. Return the index of
4007** the new element. Return a negative number if malloc fails.
4008*/
drh17435752007-08-16 04:30:38 +00004009static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00004010 int i;
drhcf643722007-03-27 13:36:37 +00004011 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00004012 db,
drhcf643722007-03-27 13:36:37 +00004013 pInfo->aFunc,
4014 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00004015 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00004016 &i
4017 );
drh13449892005-09-07 21:22:45 +00004018 return i;
4019}
drh22827922000-06-06 17:27:05 +00004020
4021/*
drh7d10d5a2008-08-20 16:35:10 +00004022** This is the xExprCallback for a tree walker. It is used to
4023** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00004024** for additional information.
drh22827922000-06-06 17:27:05 +00004025*/
drh7d10d5a2008-08-20 16:35:10 +00004026static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00004027 int i;
drh7d10d5a2008-08-20 16:35:10 +00004028 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00004029 Parse *pParse = pNC->pParse;
4030 SrcList *pSrcList = pNC->pSrcList;
drh13449892005-09-07 21:22:45 +00004031 AggInfo *pAggInfo = pNC->pAggInfo;
drh22827922000-06-06 17:27:05 +00004032
drh22827922000-06-06 17:27:05 +00004033 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00004034 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00004035 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00004036 testcase( pExpr->op==TK_AGG_COLUMN );
4037 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00004038 /* Check to see if the column is in one of the tables in the FROM
4039 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00004040 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00004041 struct SrcList_item *pItem = pSrcList->a;
4042 for(i=0; i<pSrcList->nSrc; i++, pItem++){
4043 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00004044 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00004045 if( pExpr->iTable==pItem->iCursor ){
4046 /* If we reach this point, it means that pExpr refers to a table
4047 ** that is in the FROM clause of the aggregate query.
4048 **
4049 ** Make an entry for the column in pAggInfo->aCol[] if there
4050 ** is not an entry there already.
4051 */
drh7f906d62007-03-12 23:48:52 +00004052 int k;
drh13449892005-09-07 21:22:45 +00004053 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00004054 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00004055 if( pCol->iTable==pExpr->iTable &&
4056 pCol->iColumn==pExpr->iColumn ){
4057 break;
4058 }
danielk1977a58fdfb2005-02-08 07:50:40 +00004059 }
danielk19771e536952007-08-16 10:09:01 +00004060 if( (k>=pAggInfo->nColumn)
4061 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
4062 ){
drh7f906d62007-03-12 23:48:52 +00004063 pCol = &pAggInfo->aCol[k];
danielk19770817d0d2007-02-14 09:19:36 +00004064 pCol->pTab = pExpr->pTab;
drh13449892005-09-07 21:22:45 +00004065 pCol->iTable = pExpr->iTable;
4066 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00004067 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00004068 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00004069 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00004070 if( pAggInfo->pGroupBy ){
4071 int j, n;
4072 ExprList *pGB = pAggInfo->pGroupBy;
4073 struct ExprList_item *pTerm = pGB->a;
4074 n = pGB->nExpr;
4075 for(j=0; j<n; j++, pTerm++){
4076 Expr *pE = pTerm->pExpr;
4077 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
4078 pE->iColumn==pExpr->iColumn ){
4079 pCol->iSorterColumn = j;
4080 break;
4081 }
4082 }
4083 }
4084 if( pCol->iSorterColumn<0 ){
4085 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
4086 }
4087 }
4088 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
4089 ** because it was there before or because we just created it).
4090 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
4091 ** pAggInfo->aCol[] entry.
4092 */
drhebb6a652013-09-12 23:42:22 +00004093 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00004094 pExpr->pAggInfo = pAggInfo;
4095 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00004096 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00004097 break;
4098 } /* endif pExpr->iTable==pItem->iCursor */
4099 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00004100 }
drh7d10d5a2008-08-20 16:35:10 +00004101 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00004102 }
4103 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00004104 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00004105 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00004106 ){
drh13449892005-09-07 21:22:45 +00004107 /* Check to see if pExpr is a duplicate of another aggregate
4108 ** function that is already in the pAggInfo structure
4109 */
4110 struct AggInfo_func *pItem = pAggInfo->aFunc;
4111 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh619a1302013-08-01 13:04:46 +00004112 if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00004113 break;
4114 }
drh22827922000-06-06 17:27:05 +00004115 }
drh13449892005-09-07 21:22:45 +00004116 if( i>=pAggInfo->nFunc ){
4117 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
4118 */
danielk197714db2662006-01-09 16:12:04 +00004119 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00004120 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00004121 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00004122 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00004123 pItem = &pAggInfo->aFunc[i];
4124 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00004125 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00004126 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00004127 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh33e619f2009-05-28 01:00:55 +00004128 pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
danielk19776ab3a2e2009-02-19 14:39:25 +00004129 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00004130 if( pExpr->flags & EP_Distinct ){
4131 pItem->iDistinct = pParse->nTab++;
4132 }else{
4133 pItem->iDistinct = -1;
4134 }
drh13449892005-09-07 21:22:45 +00004135 }
danielk1977a58fdfb2005-02-08 07:50:40 +00004136 }
drh13449892005-09-07 21:22:45 +00004137 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
4138 */
drhc5cd1242013-09-12 16:50:49 +00004139 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00004140 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00004141 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00004142 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00004143 return WRC_Prune;
4144 }else{
4145 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00004146 }
drh22827922000-06-06 17:27:05 +00004147 }
4148 }
drh7d10d5a2008-08-20 16:35:10 +00004149 return WRC_Continue;
4150}
4151static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00004152 UNUSED_PARAMETER(pWalker);
4153 UNUSED_PARAMETER(pSelect);
drh374fdce2012-04-17 16:38:53 +00004154 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00004155}
4156
4157/*
drhe8abb4c2012-11-02 18:24:57 +00004158** Analyze the pExpr expression looking for aggregate functions and
4159** for variables that need to be added to AggInfo object that pNC->pAggInfo
4160** points to. Additional entries are made on the AggInfo object as
4161** necessary.
drh626a8792005-01-17 22:08:19 +00004162**
4163** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00004164** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00004165*/
drhd2b3e232008-01-23 14:51:49 +00004166void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00004167 Walker w;
drh374fdce2012-04-17 16:38:53 +00004168 memset(&w, 0, sizeof(w));
drh7d10d5a2008-08-20 16:35:10 +00004169 w.xExprCallback = analyzeAggregate;
4170 w.xSelectCallback = analyzeAggregatesInSelect;
4171 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00004172 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00004173 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00004174}
drh5d9a4af2005-08-30 00:54:01 +00004175
4176/*
4177** Call sqlite3ExprAnalyzeAggregates() for every expression in an
4178** expression list. Return the number of errors.
4179**
4180** If an error is found, the analysis is cut short.
4181*/
drhd2b3e232008-01-23 14:51:49 +00004182void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00004183 struct ExprList_item *pItem;
4184 int i;
drh5d9a4af2005-08-30 00:54:01 +00004185 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00004186 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4187 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00004188 }
4189 }
drh5d9a4af2005-08-30 00:54:01 +00004190}
drh892d3172008-01-10 03:46:36 +00004191
4192/*
drhceea3322009-04-23 13:22:42 +00004193** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00004194*/
4195int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00004196 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00004197 return ++pParse->nMem;
4198 }
danielk19772f425f62008-07-04 09:41:39 +00004199 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00004200}
drhceea3322009-04-23 13:22:42 +00004201
4202/*
4203** Deallocate a register, making available for reuse for some other
4204** purpose.
4205**
4206** If a register is currently being used by the column cache, then
peter.d.reid60ec9142014-09-06 16:39:46 +00004207** the deallocation is deferred until the column cache line that uses
drhceea3322009-04-23 13:22:42 +00004208** the register becomes stale.
4209*/
drh892d3172008-01-10 03:46:36 +00004210void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00004211 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drhceea3322009-04-23 13:22:42 +00004212 int i;
4213 struct yColCache *p;
4214 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4215 if( p->iReg==iReg ){
4216 p->tempReg = 1;
4217 return;
4218 }
4219 }
drh892d3172008-01-10 03:46:36 +00004220 pParse->aTempReg[pParse->nTempReg++] = iReg;
4221 }
4222}
4223
4224/*
4225** Allocate or deallocate a block of nReg consecutive registers
4226*/
4227int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00004228 int i, n;
4229 i = pParse->iRangeReg;
4230 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00004231 if( nReg<=n ){
4232 assert( !usedAsColumnCache(pParse, i, i+n-1) );
drh892d3172008-01-10 03:46:36 +00004233 pParse->iRangeReg += nReg;
4234 pParse->nRangeReg -= nReg;
4235 }else{
4236 i = pParse->nMem+1;
4237 pParse->nMem += nReg;
4238 }
4239 return i;
4240}
4241void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhf49f3522009-12-30 14:12:38 +00004242 sqlite3ExprCacheRemove(pParse, iReg, nReg);
drh892d3172008-01-10 03:46:36 +00004243 if( nReg>pParse->nRangeReg ){
4244 pParse->nRangeReg = nReg;
4245 pParse->iRangeReg = iReg;
4246 }
4247}
drhcdc69552011-12-06 13:24:59 +00004248
4249/*
4250** Mark all temporary registers as being unavailable for reuse.
4251*/
4252void sqlite3ClearTempRegCache(Parse *pParse){
4253 pParse->nTempReg = 0;
4254 pParse->nRangeReg = 0;
4255}