blob: 094a454ab1e11e796db5332cb72190981a9a4732 [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
drh575fad62016-02-05 13:38:36 +0000456 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000457 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000458 if( op!=TK_INTEGER || pToken->z==0
459 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
460 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000461 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000462 }
drhb7916a72009-05-27 10:31:29 +0000463 }
drh575fad62016-02-05 13:38:36 +0000464 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000465 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000466 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000467 pNew->op = (u8)op;
468 pNew->iAgg = -1;
469 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000470 if( nExtra==0 ){
471 pNew->flags |= EP_IntValue;
472 pNew->u.iValue = iValue;
473 }else{
drh33e619f2009-05-28 01:00:55 +0000474 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;
drh244b9d62016-04-11 19:01:08 +0000478 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
479 if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
drh33e619f2009-05-28 01:00:55 +0000480 sqlite3Dequote(pNew->u.zToken);
drh33e619f2009-05-28 01:00:55 +0000481 }
drhb7916a72009-05-27 10:31:29 +0000482 }
483 }
484#if SQLITE_MAX_EXPR_DEPTH>0
485 pNew->nHeight = 1;
486#endif
487 }
drha76b5df2002-02-23 02:32:10 +0000488 return pNew;
489}
490
491/*
drhb7916a72009-05-27 10:31:29 +0000492** Allocate a new expression node from a zero-terminated token that has
493** already been dequoted.
494*/
495Expr *sqlite3Expr(
496 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
497 int op, /* Expression opcode */
498 const char *zToken /* Token argument. Might be NULL */
499){
500 Token x;
501 x.z = zToken;
502 x.n = zToken ? sqlite3Strlen30(zToken) : 0;
503 return sqlite3ExprAlloc(db, op, &x, 0);
504}
505
506/*
507** Attach subtrees pLeft and pRight to the Expr node pRoot.
508**
509** If pRoot==NULL that means that a memory allocation error has occurred.
510** In that case, delete the subtrees pLeft and pRight.
511*/
512void sqlite3ExprAttachSubtrees(
513 sqlite3 *db,
514 Expr *pRoot,
515 Expr *pLeft,
516 Expr *pRight
517){
518 if( pRoot==0 ){
519 assert( db->mallocFailed );
520 sqlite3ExprDelete(db, pLeft);
521 sqlite3ExprDelete(db, pRight);
522 }else{
523 if( pRight ){
524 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000525 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000526 }
527 if( pLeft ){
528 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000529 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000530 }
531 exprSetHeight(pRoot);
532 }
533}
534
535/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000536** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000537**
drhbf664462009-06-19 18:32:54 +0000538** One or both of the subtrees can be NULL. Return a pointer to the new
539** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
540** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000541*/
drh17435752007-08-16 04:30:38 +0000542Expr *sqlite3PExpr(
543 Parse *pParse, /* Parsing context */
544 int op, /* Expression opcode */
545 Expr *pLeft, /* Left operand */
546 Expr *pRight, /* Right operand */
547 const Token *pToken /* Argument token */
548){
drh5fb52ca2012-03-31 02:34:35 +0000549 Expr *p;
drh1167d322015-10-28 20:01:45 +0000550 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000551 /* Take advantage of short-circuit false optimization for AND */
552 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
553 }else{
drh1167d322015-10-28 20:01:45 +0000554 p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
drh5fb52ca2012-03-31 02:34:35 +0000555 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
556 }
dan2b359bd2010-10-28 11:31:23 +0000557 if( p ) {
558 sqlite3ExprCheckHeight(pParse, p->nHeight);
559 }
drh4e0cff62004-11-05 05:10:28 +0000560 return p;
561}
562
563/*
drh08de4f72016-04-11 01:06:47 +0000564** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
565** do a memory allocation failure) then delete the pSelect object.
566*/
567void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
568 if( pExpr ){
569 pExpr->x.pSelect = pSelect;
570 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
571 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
572 }else{
573 assert( pParse->db->mallocFailed );
574 sqlite3SelectDelete(pParse->db, pSelect);
575 }
576}
577
578
579/*
drh991a1982014-01-02 17:57:16 +0000580** If the expression is always either TRUE or FALSE (respectively),
581** then return 1. If one cannot determine the truth value of the
582** expression at compile-time return 0.
583**
584** This is an optimization. If is OK to return 0 here even if
585** the expression really is always false or false (a false negative).
586** But it is a bug to return 1 if the expression might have different
587** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000588**
589** Note that if the expression is part of conditional for a
590** LEFT JOIN, then we cannot determine at compile-time whether or not
591** is it true or false, so always return 0.
592*/
drh991a1982014-01-02 17:57:16 +0000593static int exprAlwaysTrue(Expr *p){
594 int v = 0;
595 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
596 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
597 return v!=0;
598}
drh5fb52ca2012-03-31 02:34:35 +0000599static int exprAlwaysFalse(Expr *p){
600 int v = 0;
601 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
602 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
603 return v==0;
604}
605
606/*
drh91bb0ee2004-09-01 03:06:34 +0000607** Join two expressions using an AND operator. If either expression is
608** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000609**
610** If one side or the other of the AND is known to be false, then instead
611** of returning an AND expression, just return a constant expression with
612** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000613*/
danielk19771e536952007-08-16 10:09:01 +0000614Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000615 if( pLeft==0 ){
616 return pRight;
617 }else if( pRight==0 ){
618 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000619 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
620 sqlite3ExprDelete(db, pLeft);
621 sqlite3ExprDelete(db, pRight);
622 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000623 }else{
drhb7916a72009-05-27 10:31:29 +0000624 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
625 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
626 return pNew;
drha76b5df2002-02-23 02:32:10 +0000627 }
628}
629
630/*
631** Construct a new expression node for a function with multiple
632** arguments.
633*/
drh17435752007-08-16 04:30:38 +0000634Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
drha76b5df2002-02-23 02:32:10 +0000635 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000636 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000637 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000638 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000639 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000640 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000641 return 0;
642 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000643 pNew->x.pList = pList;
644 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000645 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drha76b5df2002-02-23 02:32:10 +0000646 return pNew;
647}
648
649/*
drhfa6bc002004-09-07 16:19:52 +0000650** Assign a variable number to an expression that encodes a wildcard
651** in the original SQL statement.
652**
653** Wildcards consisting of a single "?" are assigned the next sequential
654** variable number.
655**
656** Wildcards of the form "?nnn" are assigned the number "nnn". We make
657** sure "nnn" is not too be to avoid a denial of service attack when
658** the SQL statement comes from an external source.
659**
drh51f49f12009-05-21 20:41:32 +0000660** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000661** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000662** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000663** assigned.
664*/
665void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
drh17435752007-08-16 04:30:38 +0000666 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000667 const char *z;
drh17435752007-08-16 04:30:38 +0000668
drhfa6bc002004-09-07 16:19:52 +0000669 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000670 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000671 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000672 assert( z!=0 );
673 assert( z[0]!=0 );
674 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000675 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000676 assert( z[0]=='?' );
drh8677d302009-11-04 13:17:14 +0000677 pExpr->iColumn = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000678 }else{
drh124c0b42011-06-01 18:15:55 +0000679 ynVar x = 0;
680 u32 n = sqlite3Strlen30(z);
681 if( z[0]=='?' ){
682 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
683 ** use it as the variable number */
684 i64 i;
685 int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
686 pExpr->iColumn = x = (ynVar)i;
687 testcase( i==0 );
688 testcase( i==1 );
689 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
690 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
691 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
692 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
693 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
694 x = 0;
drhfa6bc002004-09-07 16:19:52 +0000695 }
drh124c0b42011-06-01 18:15:55 +0000696 if( i>pParse->nVar ){
697 pParse->nVar = (int)i;
698 }
699 }else{
700 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
701 ** number as the prior appearance of the same name, or if the name
702 ** has never appeared before, reuse the same variable number
703 */
704 ynVar i;
705 for(i=0; i<pParse->nzVar; i++){
drh503a6862013-03-01 01:07:17 +0000706 if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
drh124c0b42011-06-01 18:15:55 +0000707 pExpr->iColumn = x = (ynVar)i+1;
708 break;
709 }
710 }
711 if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000712 }
drh124c0b42011-06-01 18:15:55 +0000713 if( x>0 ){
714 if( x>pParse->nzVar ){
715 char **a;
716 a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
drh4a642b62016-02-05 01:55:27 +0000717 if( a==0 ){
718 assert( db->mallocFailed ); /* Error reported through mallocFailed */
719 return;
720 }
drh124c0b42011-06-01 18:15:55 +0000721 pParse->azVar = a;
722 memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
723 pParse->nzVar = x;
drhfa6bc002004-09-07 16:19:52 +0000724 }
drh124c0b42011-06-01 18:15:55 +0000725 if( z[0]!='?' || pParse->azVar[x-1]==0 ){
726 sqlite3DbFree(db, pParse->azVar[x-1]);
727 pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
drhfa6bc002004-09-07 16:19:52 +0000728 }
729 }
730 }
drhbb4957f2008-03-20 14:03:29 +0000731 if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +0000732 sqlite3ErrorMsg(pParse, "too many SQL variables");
733 }
drhfa6bc002004-09-07 16:19:52 +0000734}
735
736/*
danf6963f92009-11-23 14:39:14 +0000737** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +0000738*/
drh4f0010b2016-04-11 14:49:39 +0000739static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
740 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +0000741 /* Sanity check: Assert that the IntValue is non-negative if it exists */
742 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drhc5cd1242013-09-12 16:50:49 +0000743 if( !ExprHasProperty(p, EP_TokenOnly) ){
744 /* The Expr.x union is never used at the same time as Expr.pRight */
745 assert( p->x.pList==0 || p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +0000746 sqlite3ExprDelete(db, p->pLeft);
747 sqlite3ExprDelete(db, p->pRight);
drhc5cd1242013-09-12 16:50:49 +0000748 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
danielk19776ab3a2e2009-02-19 14:39:25 +0000749 if( ExprHasProperty(p, EP_xIsSelect) ){
750 sqlite3SelectDelete(db, p->x.pSelect);
751 }else{
752 sqlite3ExprListDelete(db, p->x.pList);
753 }
754 }
drh33e619f2009-05-28 01:00:55 +0000755 if( !ExprHasProperty(p, EP_Static) ){
756 sqlite3DbFree(db, p);
757 }
drha2e00042002-01-22 03:13:42 +0000758}
drh4f0010b2016-04-11 14:49:39 +0000759void sqlite3ExprDelete(sqlite3 *db, Expr *p){
760 if( p ) sqlite3ExprDeleteNN(db, p);
761}
drha2e00042002-01-22 03:13:42 +0000762
drhd2687b72005-08-12 22:56:09 +0000763/*
danielk19776ab3a2e2009-02-19 14:39:25 +0000764** Return the number of bytes allocated for the expression structure
765** passed as the first argument. This is always one of EXPR_FULLSIZE,
766** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
767*/
768static int exprStructSize(Expr *p){
769 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +0000770 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
771 return EXPR_FULLSIZE;
772}
773
774/*
drh33e619f2009-05-28 01:00:55 +0000775** The dupedExpr*Size() routines each return the number of bytes required
776** to store a copy of an expression or expression tree. They differ in
777** how much of the tree is measured.
778**
779** dupedExprStructSize() Size of only the Expr structure
780** dupedExprNodeSize() Size of Expr + space for token
781** dupedExprSize() Expr + token + subtree components
782**
783***************************************************************************
784**
785** The dupedExprStructSize() function returns two values OR-ed together:
786** (1) the space required for a copy of the Expr structure only and
787** (2) the EP_xxx flags that indicate what the structure size should be.
788** The return values is always one of:
789**
790** EXPR_FULLSIZE
791** EXPR_REDUCEDSIZE | EP_Reduced
792** EXPR_TOKENONLYSIZE | EP_TokenOnly
793**
794** The size of the structure can be found by masking the return value
795** of this routine with 0xfff. The flags can be found by masking the
796** return value with EP_Reduced|EP_TokenOnly.
797**
798** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
799** (unreduced) Expr objects as they or originally constructed by the parser.
800** During expression analysis, extra information is computed and moved into
801** later parts of teh Expr object and that extra information might get chopped
802** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +0000803** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +0000804** to reduce a pristine expression tree from the parser. The implementation
805** of dupedExprStructSize() contain multiple assert() statements that attempt
806** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +0000807*/
808static int dupedExprStructSize(Expr *p, int flags){
809 int nSize;
drh33e619f2009-05-28 01:00:55 +0000810 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +0000811 assert( EXPR_FULLSIZE<=0xfff );
812 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
drh3c194692016-04-11 16:43:43 +0000813 if( 0==flags ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000814 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +0000815 }else{
drhc5cd1242013-09-12 16:50:49 +0000816 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +0000817 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +0000818 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +0000819 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +0000820 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +0000821 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
822 }else{
drhaecd8022013-09-13 18:15:15 +0000823 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +0000824 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
825 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000826 }
827 return nSize;
828}
829
830/*
drh33e619f2009-05-28 01:00:55 +0000831** This function returns the space in bytes required to store the copy
832** of the Expr structure and a copy of the Expr.u.zToken string (if that
833** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +0000834*/
835static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +0000836 int nByte = dupedExprStructSize(p, flags) & 0xfff;
837 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
838 nByte += sqlite3Strlen30(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +0000839 }
danielk1977bc739712009-03-23 04:33:32 +0000840 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +0000841}
842
843/*
844** Return the number of bytes required to create a duplicate of the
845** expression passed as the first argument. The second argument is a
846** mask containing EXPRDUP_XXX flags.
847**
848** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +0000849** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +0000850**
851** If the EXPRDUP_REDUCE flag is set, then the return value includes
852** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
853** and Expr.pRight variables (but not for any structures pointed to or
854** descended from the Expr.x.pList or Expr.x.pSelect variables).
855*/
856static int dupedExprSize(Expr *p, int flags){
857 int nByte = 0;
858 if( p ){
859 nByte = dupedExprNodeSize(p, flags);
860 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +0000861 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +0000862 }
863 }
864 return nByte;
865}
866
867/*
868** This function is similar to sqlite3ExprDup(), except that if pzBuffer
869** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +0000870** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +0000871** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +0000872** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +0000873** portion of the buffer copied into by this function.
874*/
drh3c194692016-04-11 16:43:43 +0000875static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
876 Expr *pNew; /* Value to return */
877 u8 *zAlloc; /* Memory space from which to build Expr object */
878 u32 staticFlag; /* EP_Static if space not obtained from malloc */
879
drh575fad62016-02-05 13:38:36 +0000880 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +0000881 assert( p );
882 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
883 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +0000884
drh3c194692016-04-11 16:43:43 +0000885 /* Figure out where to write the new Expr structure. */
886 if( pzBuffer ){
887 zAlloc = *pzBuffer;
888 staticFlag = EP_Static;
889 }else{
890 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
891 staticFlag = 0;
892 }
893 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +0000894
drh3c194692016-04-11 16:43:43 +0000895 if( pNew ){
896 /* Set nNewSize to the size allocated for the structure pointed to
897 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
898 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
899 ** by the copy of the p->u.zToken string (if any).
900 */
901 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
902 const int nNewSize = nStructSize & 0xfff;
903 int nToken;
904 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
905 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +0000906 }else{
drh3c194692016-04-11 16:43:43 +0000907 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +0000908 }
drh3c194692016-04-11 16:43:43 +0000909 if( dupFlags ){
910 assert( ExprHasProperty(p, EP_Reduced)==0 );
911 memcpy(zAlloc, p, nNewSize);
912 }else{
913 u32 nSize = (u32)exprStructSize(p);
914 memcpy(zAlloc, p, nSize);
915 if( nSize<EXPR_FULLSIZE ){
916 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
917 }
918 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000919
drh3c194692016-04-11 16:43:43 +0000920 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
921 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
922 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
923 pNew->flags |= staticFlag;
924
925 /* Copy the p->u.zToken string, if any. */
926 if( nToken ){
927 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
928 memcpy(zToken, p->u.zToken, nToken);
929 }
930
931 if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
932 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
933 if( ExprHasProperty(p, EP_xIsSelect) ){
934 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +0000935 }else{
drh3c194692016-04-11 16:43:43 +0000936 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +0000937 }
drh3c194692016-04-11 16:43:43 +0000938 }
939
940 /* Fill in pNew->pLeft and pNew->pRight. */
941 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
942 zAlloc += dupedExprNodeSize(p, dupFlags);
943 if( ExprHasProperty(pNew, EP_Reduced) ){
944 pNew->pLeft = p->pLeft ?
945 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
946 pNew->pRight = p->pRight ?
947 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +0000948 }
drh3c194692016-04-11 16:43:43 +0000949 if( pzBuffer ){
950 *pzBuffer = zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +0000951 }
drh3c194692016-04-11 16:43:43 +0000952 }else{
953 if( !ExprHasProperty(p, EP_TokenOnly) ){
954 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
955 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +0000956 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000957 }
958 }
959 return pNew;
960}
961
962/*
danbfe31e72014-01-15 14:17:31 +0000963** Create and return a deep copy of the object passed as the second
964** argument. If an OOM condition is encountered, NULL is returned
965** and the db->mallocFailed flag set.
966*/
daneede6a52014-01-15 19:42:23 +0000967#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +0000968static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +0000969 With *pRet = 0;
970 if( p ){
971 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
972 pRet = sqlite3DbMallocZero(db, nByte);
973 if( pRet ){
974 int i;
975 pRet->nCte = p->nCte;
976 for(i=0; i<p->nCte; i++){
977 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
978 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
979 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
980 }
981 }
982 }
983 return pRet;
984}
daneede6a52014-01-15 19:42:23 +0000985#else
986# define withDup(x,y) 0
987#endif
dan4e9119d2014-01-13 15:12:23 +0000988
drha76b5df2002-02-23 02:32:10 +0000989/*
drhff78bd22002-02-27 01:47:11 +0000990** The following group of routines make deep copies of expressions,
991** expression lists, ID lists, and select statements. The copies can
992** be deleted (by being passed to their respective ...Delete() routines)
993** without effecting the originals.
994**
danielk19774adee202004-05-08 08:23:19 +0000995** The expression list, ID, and source lists return by sqlite3ExprListDup(),
996** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +0000997** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +0000998**
drhad3cab52002-05-24 02:04:32 +0000999** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001000**
drhb7916a72009-05-27 10:31:29 +00001001** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001002** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1003** truncated version of the usual Expr structure that will be stored as
1004** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001005*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001006Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001007 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001008 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001009}
danielk19776ab3a2e2009-02-19 14:39:25 +00001010ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001011 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001012 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001013 int i;
drh575fad62016-02-05 13:38:36 +00001014 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001015 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001016 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001017 if( pNew==0 ) return 0;
drhd872bb12012-02-02 01:58:08 +00001018 pNew->nExpr = i = p->nExpr;
1019 if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
drh575fad62016-02-05 13:38:36 +00001020 pNew->a = pItem = sqlite3DbMallocRawNN(db, i*sizeof(p->a[0]) );
danielk1977e0048402004-06-15 16:51:01 +00001021 if( pItem==0 ){
drh633e6d52008-07-28 19:34:53 +00001022 sqlite3DbFree(db, pNew);
danielk1977e0048402004-06-15 16:51:01 +00001023 return 0;
1024 }
drh145716b2004-09-24 12:24:06 +00001025 pOldItem = p->a;
1026 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001027 Expr *pOldExpr = pOldItem->pExpr;
drhb5526ea2009-07-16 12:41:05 +00001028 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh17435752007-08-16 04:30:38 +00001029 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001030 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001031 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001032 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001033 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
drhc2acc4e2013-11-15 18:15:19 +00001034 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001035 }
1036 return pNew;
1037}
danielk197793758c82005-01-21 08:13:14 +00001038
1039/*
1040** If cursors, triggers, views and subqueries are all omitted from
1041** the build, then none of the following routines, except for
1042** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1043** called with a NULL argument.
1044*/
danielk19776a67fe82005-02-04 04:07:16 +00001045#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1046 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001047SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001048 SrcList *pNew;
1049 int i;
drh113088e2003-03-20 01:16:58 +00001050 int nByte;
drh575fad62016-02-05 13:38:36 +00001051 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001052 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001053 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001054 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001055 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001056 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001057 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001058 struct SrcList_item *pNewItem = &pNew->a[i];
1059 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001060 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001061 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001062 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1063 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1064 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001065 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001066 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001067 pNewItem->addrFillSub = pOldItem->addrFillSub;
1068 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001069 if( pNewItem->fg.isIndexedBy ){
1070 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1071 }
1072 pNewItem->pIBIndex = pOldItem->pIBIndex;
1073 if( pNewItem->fg.isTabFunc ){
1074 pNewItem->u1.pFuncArg =
1075 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1076 }
drhed8a3bb2005-06-06 21:19:56 +00001077 pTab = pNewItem->pTab = pOldItem->pTab;
1078 if( pTab ){
1079 pTab->nRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001080 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001081 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1082 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001083 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001084 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001085 }
1086 return pNew;
1087}
drh17435752007-08-16 04:30:38 +00001088IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001089 IdList *pNew;
1090 int i;
drh575fad62016-02-05 13:38:36 +00001091 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001092 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001093 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001094 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001095 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001096 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001097 if( pNew->a==0 ){
drh633e6d52008-07-28 19:34:53 +00001098 sqlite3DbFree(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001099 return 0;
1100 }
drh6c535152012-02-02 03:38:30 +00001101 /* Note that because the size of the allocation for p->a[] is not
1102 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1103 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001104 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001105 struct IdList_item *pNewItem = &pNew->a[i];
1106 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001107 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001108 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001109 }
1110 return pNew;
1111}
danielk19776ab3a2e2009-02-19 14:39:25 +00001112Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
drh23b1b372011-12-07 01:55:51 +00001113 Select *pNew, *pPrior;
drh575fad62016-02-05 13:38:36 +00001114 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001115 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001116 pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
drhff78bd22002-02-27 01:47:11 +00001117 if( pNew==0 ) return 0;
drhb7916a72009-05-27 10:31:29 +00001118 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001119 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1120 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1121 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1122 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1123 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
drhff78bd22002-02-27 01:47:11 +00001124 pNew->op = p->op;
drh23b1b372011-12-07 01:55:51 +00001125 pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
1126 if( pPrior ) pPrior->pNext = pNew;
1127 pNew->pNext = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001128 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
1129 pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
drh92b01d52008-06-24 00:32:35 +00001130 pNew->iLimit = 0;
1131 pNew->iOffset = 0;
drh7d10d5a2008-08-20 16:35:10 +00001132 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
drhb9bb7c12006-06-11 23:41:55 +00001133 pNew->addrOpenEphm[0] = -1;
1134 pNew->addrOpenEphm[1] = -1;
drhec2da852014-01-29 01:46:12 +00001135 pNew->nSelectRow = p->nSelectRow;
dan4e9119d2014-01-13 15:12:23 +00001136 pNew->pWith = withDup(db, p->pWith);
drheb9b8842014-09-21 00:27:26 +00001137 sqlite3SelectSetName(pNew, p->zSelName);
drhff78bd22002-02-27 01:47:11 +00001138 return pNew;
1139}
danielk197793758c82005-01-21 08:13:14 +00001140#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001141Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001142 assert( p==0 );
1143 return 0;
1144}
1145#endif
drhff78bd22002-02-27 01:47:11 +00001146
1147
1148/*
drha76b5df2002-02-23 02:32:10 +00001149** Add a new element to the end of an expression list. If pList is
1150** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001151**
1152** If a memory allocation error occurs, the entire list is freed and
1153** NULL is returned. If non-NULL is returned, then it is guaranteed
1154** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001155*/
drh17435752007-08-16 04:30:38 +00001156ExprList *sqlite3ExprListAppend(
1157 Parse *pParse, /* Parsing context */
1158 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001159 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001160){
1161 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001162 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001163 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001164 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001165 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001166 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001167 }
drhc263f7c2016-01-18 13:18:54 +00001168 pList->nExpr = 0;
drh575fad62016-02-05 13:38:36 +00001169 pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
drhd872bb12012-02-02 01:58:08 +00001170 if( pList->a==0 ) goto no_mem;
1171 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001172 struct ExprList_item *a;
drhd872bb12012-02-02 01:58:08 +00001173 assert( pList->nExpr>0 );
1174 a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
danielk1977d5d56522005-03-16 12:15:20 +00001175 if( a==0 ){
1176 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001177 }
danielk1977d5d56522005-03-16 12:15:20 +00001178 pList->a = a;
drha76b5df2002-02-23 02:32:10 +00001179 }
drh4efc4752004-01-16 15:55:37 +00001180 assert( pList->a!=0 );
drhb7916a72009-05-27 10:31:29 +00001181 if( 1 ){
drh4efc4752004-01-16 15:55:37 +00001182 struct ExprList_item *pItem = &pList->a[pList->nExpr++];
1183 memset(pItem, 0, sizeof(*pItem));
danielk1977e94ddc92005-03-21 03:53:38 +00001184 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001185 }
1186 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001187
1188no_mem:
1189 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001190 sqlite3ExprDelete(db, pExpr);
1191 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001192 return 0;
drha76b5df2002-02-23 02:32:10 +00001193}
1194
1195/*
drhbc622bc2015-08-24 15:39:42 +00001196** Set the sort order for the last element on the given ExprList.
1197*/
1198void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1199 if( p==0 ) return;
1200 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1201 assert( p->nExpr>0 );
1202 if( iSortOrder<0 ){
1203 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1204 return;
1205 }
1206 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001207}
1208
1209/*
drhb7916a72009-05-27 10:31:29 +00001210** Set the ExprList.a[].zName element of the most recently added item
1211** on the expression list.
1212**
1213** pList might be NULL following an OOM error. But pName should never be
1214** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1215** is set.
1216*/
1217void sqlite3ExprListSetName(
1218 Parse *pParse, /* Parsing context */
1219 ExprList *pList, /* List to which to add the span. */
1220 Token *pName, /* Name to be added */
1221 int dequote /* True to cause the name to be dequoted */
1222){
1223 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1224 if( pList ){
1225 struct ExprList_item *pItem;
1226 assert( pList->nExpr>0 );
1227 pItem = &pList->a[pList->nExpr-1];
1228 assert( pItem->zName==0 );
1229 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001230 if( dequote ) sqlite3Dequote(pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001231 }
1232}
1233
1234/*
1235** Set the ExprList.a[].zSpan element of the most recently added item
1236** on the expression list.
1237**
1238** pList might be NULL following an OOM error. But pSpan should never be
1239** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1240** is set.
1241*/
1242void sqlite3ExprListSetSpan(
1243 Parse *pParse, /* Parsing context */
1244 ExprList *pList, /* List to which to add the span. */
1245 ExprSpan *pSpan /* The span to be added */
1246){
1247 sqlite3 *db = pParse->db;
1248 assert( pList!=0 || db->mallocFailed!=0 );
1249 if( pList ){
1250 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1251 assert( pList->nExpr>0 );
1252 assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1253 sqlite3DbFree(db, pItem->zSpan);
1254 pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
shanecf697392009-06-01 16:53:09 +00001255 (int)(pSpan->zEnd - pSpan->zStart));
drhb7916a72009-05-27 10:31:29 +00001256 }
1257}
1258
1259/*
danielk19777a15a4b2007-05-08 17:54:43 +00001260** If the expression list pEList contains more than iLimit elements,
1261** leave an error message in pParse.
1262*/
1263void sqlite3ExprListCheckLength(
1264 Parse *pParse,
1265 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001266 const char *zObject
1267){
drhb1a6c3c2008-03-20 16:30:17 +00001268 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001269 testcase( pEList && pEList->nExpr==mx );
1270 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001271 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001272 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1273 }
1274}
1275
1276/*
drha76b5df2002-02-23 02:32:10 +00001277** Delete an entire expression list.
1278*/
drhaffa8552016-04-11 18:25:05 +00001279static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drha76b5df2002-02-23 02:32:10 +00001280 int i;
drhbe5c89a2004-07-26 00:31:09 +00001281 struct ExprList_item *pItem;
drhd872bb12012-02-02 01:58:08 +00001282 assert( pList->a!=0 || pList->nExpr==0 );
drhbe5c89a2004-07-26 00:31:09 +00001283 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
drh633e6d52008-07-28 19:34:53 +00001284 sqlite3ExprDelete(db, pItem->pExpr);
1285 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001286 sqlite3DbFree(db, pItem->zSpan);
drha76b5df2002-02-23 02:32:10 +00001287 }
drh633e6d52008-07-28 19:34:53 +00001288 sqlite3DbFree(db, pList->a);
1289 sqlite3DbFree(db, pList);
drha76b5df2002-02-23 02:32:10 +00001290}
drhaffa8552016-04-11 18:25:05 +00001291void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1292 if( pList ) exprListDeleteNN(db, pList);
1293}
drha76b5df2002-02-23 02:32:10 +00001294
1295/*
drh2308ed32015-02-09 16:09:34 +00001296** Return the bitwise-OR of all Expr.flags fields in the given
1297** ExprList.
drh885a5b02015-02-09 15:21:36 +00001298*/
drh2308ed32015-02-09 16:09:34 +00001299u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001300 int i;
drh2308ed32015-02-09 16:09:34 +00001301 u32 m = 0;
1302 if( pList ){
1303 for(i=0; i<pList->nExpr; i++){
drhd0c73052015-04-19 19:21:19 +00001304 Expr *pExpr = pList->a[i].pExpr;
drhde845c22016-03-17 19:07:52 +00001305 assert( pExpr!=0 );
1306 m |= pExpr->flags;
drh2308ed32015-02-09 16:09:34 +00001307 }
drh885a5b02015-02-09 15:21:36 +00001308 }
drh2308ed32015-02-09 16:09:34 +00001309 return m;
drh885a5b02015-02-09 15:21:36 +00001310}
1311
1312/*
drh059b2d52014-10-24 19:28:09 +00001313** These routines are Walker callbacks used to check expressions to
1314** see if they are "constant" for some definition of constant. The
1315** Walker.eCode value determines the type of "constant" we are looking
1316** for.
drh73b211a2005-01-18 04:00:42 +00001317**
drh7d10d5a2008-08-20 16:35:10 +00001318** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001319**
drh059b2d52014-10-24 19:28:09 +00001320** sqlite3ExprIsConstant() pWalker->eCode==1
1321** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001322** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001323** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001324**
drh059b2d52014-10-24 19:28:09 +00001325** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1326** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001327**
drhfeada2d2014-09-24 13:20:22 +00001328** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001329** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1330** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001331** parameter raises an error for new statements, but is silently converted
1332** to NULL for existing schemas. This allows sqlite_master tables that
1333** contain a bound parameter because they were generated by older versions
1334** of SQLite to be parsed by newer versions of SQLite without raising a
1335** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001336*/
drh7d10d5a2008-08-20 16:35:10 +00001337static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001338
drh059b2d52014-10-24 19:28:09 +00001339 /* If pWalker->eCode is 2 then any term of the expression that comes from
1340 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001341 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001342 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1343 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001344 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001345 }
1346
drh626a8792005-01-17 22:08:19 +00001347 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001348 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001349 ** and either pWalker->eCode==4 or 5 or the function has the
1350 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001351 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001352 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001353 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001354 }else{
1355 pWalker->eCode = 0;
1356 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001357 }
drh626a8792005-01-17 22:08:19 +00001358 case TK_ID:
1359 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001360 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001361 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001362 testcase( pExpr->op==TK_ID );
1363 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001364 testcase( pExpr->op==TK_AGG_FUNCTION );
1365 testcase( pExpr->op==TK_AGG_COLUMN );
drh059b2d52014-10-24 19:28:09 +00001366 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1367 return WRC_Continue;
1368 }else{
1369 pWalker->eCode = 0;
1370 return WRC_Abort;
1371 }
drhfeada2d2014-09-24 13:20:22 +00001372 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001373 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001374 /* Silently convert bound parameters that appear inside of CREATE
1375 ** statements into a NULL when parsing the CREATE statement text out
1376 ** of the sqlite_master table */
1377 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001378 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001379 /* A bound parameter in a CREATE statement that originates from
1380 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001381 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001382 return WRC_Abort;
1383 }
1384 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001385 default:
drhb74b1012009-05-28 21:04:37 +00001386 testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1387 testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
drh7d10d5a2008-08-20 16:35:10 +00001388 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001389 }
1390}
danielk197762c14b32008-11-19 09:05:26 +00001391static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
1392 UNUSED_PARAMETER(NotUsed);
drh059b2d52014-10-24 19:28:09 +00001393 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001394 return WRC_Abort;
1395}
drh059b2d52014-10-24 19:28:09 +00001396static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001397 Walker w;
drhaa87f9a2013-04-25 00:57:10 +00001398 memset(&w, 0, sizeof(w));
drh059b2d52014-10-24 19:28:09 +00001399 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001400 w.xExprCallback = exprNodeIsConstant;
1401 w.xSelectCallback = selectNodeIsConstant;
drh059b2d52014-10-24 19:28:09 +00001402 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001403 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001404 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001405}
drh626a8792005-01-17 22:08:19 +00001406
1407/*
drh059b2d52014-10-24 19:28:09 +00001408** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001409** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001410**
1411** For the purposes of this function, a double-quoted string (ex: "abc")
1412** is considered a variable but a single-quoted string (ex: 'abc') is
1413** a constant.
drhfef52082000-06-06 01:50:43 +00001414*/
danielk19774adee202004-05-08 08:23:19 +00001415int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001416 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001417}
1418
1419/*
drh059b2d52014-10-24 19:28:09 +00001420** Walk an expression tree. Return non-zero if the expression is constant
drh0a168372007-06-08 00:20:47 +00001421** that does no originate from the ON or USING clauses of a join.
1422** Return 0 if it involves variables or function calls or terms from
1423** an ON or USING clause.
1424*/
1425int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001426 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001427}
1428
1429/*
drhfcb9f4f2015-06-01 18:13:16 +00001430** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001431** for any single row of the table with cursor iCur. In other words, the
1432** expression must not refer to any non-deterministic function nor any
1433** table other than iCur.
1434*/
1435int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1436 return exprIsConst(p, 3, iCur);
1437}
1438
1439/*
1440** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001441** or a function call with constant arguments. Return and 0 if there
1442** are any variables.
1443**
1444** For the purposes of this function, a double-quoted string (ex: "abc")
1445** is considered a variable but a single-quoted string (ex: 'abc') is
1446** a constant.
1447*/
drhfeada2d2014-09-24 13:20:22 +00001448int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1449 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00001450 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00001451}
1452
drh5b88bc42013-12-07 23:35:21 +00001453#ifdef SQLITE_ENABLE_CURSOR_HINTS
1454/*
1455** Walk an expression tree. Return 1 if the expression contains a
1456** subquery of some kind. Return 0 if there are no subqueries.
1457*/
1458int sqlite3ExprContainsSubquery(Expr *p){
1459 Walker w;
1460 memset(&w, 0, sizeof(w));
drhbec24762015-08-13 20:07:13 +00001461 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00001462 w.xExprCallback = sqlite3ExprWalkNoop;
1463 w.xSelectCallback = selectNodeIsConstant;
1464 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00001465 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00001466}
1467#endif
1468
drheb55bd22005-06-30 17:04:21 +00001469/*
drh73b211a2005-01-18 04:00:42 +00001470** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00001471** to fit in a 32-bit integer, return 1 and put the value of the integer
1472** in *pValue. If the expression is not an integer or if it is too big
1473** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00001474*/
danielk19774adee202004-05-08 08:23:19 +00001475int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00001476 int rc = 0;
drhcd92e842011-02-17 15:58:20 +00001477
1478 /* If an expression is an integer literal that fits in a signed 32-bit
1479 ** integer, then the EP_IntValue flag will have already been set */
1480 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1481 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1482
drh92b01d52008-06-24 00:32:35 +00001483 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00001484 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00001485 return 1;
1486 }
drhe4de1fe2002-06-02 16:09:01 +00001487 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00001488 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00001489 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00001490 break;
drh4b59ab52002-08-24 18:24:51 +00001491 }
drhe4de1fe2002-06-02 16:09:01 +00001492 case TK_UMINUS: {
1493 int v;
danielk19774adee202004-05-08 08:23:19 +00001494 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00001495 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00001496 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00001497 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00001498 }
1499 break;
1500 }
1501 default: break;
1502 }
drh92b01d52008-06-24 00:32:35 +00001503 return rc;
drhe4de1fe2002-06-02 16:09:01 +00001504}
1505
1506/*
drh039fc322009-11-17 18:31:47 +00001507** Return FALSE if there is no chance that the expression can be NULL.
1508**
1509** If the expression might be NULL or if the expression is too complex
1510** to tell return TRUE.
1511**
1512** This routine is used as an optimization, to skip OP_IsNull opcodes
1513** when we know that a value cannot be NULL. Hence, a false positive
1514** (returning TRUE when in fact the expression can never be NULL) might
1515** be a small performance hit but is otherwise harmless. On the other
1516** hand, a false negative (returning FALSE when the result could be NULL)
1517** will likely result in an incorrect answer. So when in doubt, return
1518** TRUE.
1519*/
1520int sqlite3ExprCanBeNull(const Expr *p){
1521 u8 op;
drhcd7f4572009-11-19 14:48:40 +00001522 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00001523 op = p->op;
1524 if( op==TK_REGISTER ) op = p->op2;
1525 switch( op ){
1526 case TK_INTEGER:
1527 case TK_STRING:
1528 case TK_FLOAT:
1529 case TK_BLOB:
1530 return 0;
drh7248a8b2014-08-04 18:50:54 +00001531 case TK_COLUMN:
1532 assert( p->pTab!=0 );
drh72673a22014-12-04 16:27:17 +00001533 return ExprHasProperty(p, EP_CanBeNull) ||
1534 (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00001535 default:
1536 return 1;
1537 }
1538}
1539
1540/*
1541** Return TRUE if the given expression is a constant which would be
1542** unchanged by OP_Affinity with the affinity given in the second
1543** argument.
1544**
1545** This routine is used to determine if the OP_Affinity operation
1546** can be omitted. When in doubt return FALSE. A false negative
1547** is harmless. A false positive, however, can result in the wrong
1548** answer.
1549*/
1550int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1551 u8 op;
drh05883a32015-06-02 15:32:08 +00001552 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00001553 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00001554 op = p->op;
1555 if( op==TK_REGISTER ) op = p->op2;
1556 switch( op ){
1557 case TK_INTEGER: {
1558 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1559 }
1560 case TK_FLOAT: {
1561 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1562 }
1563 case TK_STRING: {
1564 return aff==SQLITE_AFF_TEXT;
1565 }
1566 case TK_BLOB: {
1567 return 1;
1568 }
drh2f2855b2009-11-18 01:25:26 +00001569 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00001570 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
1571 return p->iColumn<0
1572 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00001573 }
drh039fc322009-11-17 18:31:47 +00001574 default: {
1575 return 0;
1576 }
1577 }
1578}
1579
1580/*
drhc4a3c772001-04-04 11:48:57 +00001581** Return TRUE if the given string is a row-id column name.
1582*/
danielk19774adee202004-05-08 08:23:19 +00001583int sqlite3IsRowid(const char *z){
1584 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
1585 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
1586 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00001587 return 0;
1588}
1589
danielk19779a96b662007-11-29 17:05:18 +00001590/*
drh69c355b2016-03-09 15:34:51 +00001591** pX is the RHS of an IN operator. If pX is a SELECT statement
1592** that can be simplified to a direct table access, then return
1593** a pointer to the SELECT statement. If pX is not a SELECT statement,
1594** or if the SELECT statement needs to be manifested into a transient
1595** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00001596*/
1597#ifndef SQLITE_OMIT_SUBQUERY
drh69c355b2016-03-09 15:34:51 +00001598static Select *isCandidateForInOpt(Expr *pX){
1599 Select *p;
drhb287f4b2008-04-25 00:08:38 +00001600 SrcList *pSrc;
1601 ExprList *pEList;
drh69c355b2016-03-09 15:34:51 +00001602 Expr *pRes;
drhb287f4b2008-04-25 00:08:38 +00001603 Table *pTab;
drh69c355b2016-03-09 15:34:51 +00001604 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
1605 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
1606 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00001607 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00001608 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00001609 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1610 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
1611 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00001612 }
drhb74b1012009-05-28 21:04:37 +00001613 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00001614 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb74b1012009-05-28 21:04:37 +00001615 assert( p->pOffset==0 ); /* No LIMIT means no OFFSET */
drhb287f4b2008-04-25 00:08:38 +00001616 if( p->pWhere ) return 0; /* Has no WHERE clause */
1617 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00001618 assert( pSrc!=0 );
1619 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00001620 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00001621 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00001622 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00001623 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00001624 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
1625 pEList = p->pEList;
1626 if( pEList->nExpr!=1 ) return 0; /* One column in the result set */
drh90730c92016-03-09 15:09:22 +00001627 pRes = pEList->a[0].pExpr;
1628 if( pRes->op!=TK_COLUMN ) return 0; /* Result is a column */
drh69c355b2016-03-09 15:34:51 +00001629 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
1630 return p;
drhb287f4b2008-04-25 00:08:38 +00001631}
1632#endif /* SQLITE_OMIT_SUBQUERY */
1633
1634/*
dan1d8cb212011-12-09 13:24:16 +00001635** Code an OP_Once instruction and allocate space for its flag. Return the
1636** address of the new instruction.
1637*/
1638int sqlite3CodeOnce(Parse *pParse){
1639 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
1640 return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
1641}
1642
1643/*
drh4c259e92014-08-01 21:12:35 +00001644** Generate code that checks the left-most column of index table iCur to see if
1645** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00001646** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
1647** to be set to NULL if iCur contains one or more NULL values.
1648*/
1649static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00001650 int addr1;
drh6be515e2014-08-01 21:00:53 +00001651 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00001652 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00001653 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
1654 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00001655 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00001656 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00001657}
1658
drhbb53ecb2014-08-02 21:03:33 +00001659
1660#ifndef SQLITE_OMIT_SUBQUERY
1661/*
1662** The argument is an IN operator with a list (not a subquery) on the
1663** right-hand side. Return TRUE if that list is constant.
1664*/
1665static int sqlite3InRhsIsConstant(Expr *pIn){
1666 Expr *pLHS;
1667 int res;
1668 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1669 pLHS = pIn->pLeft;
1670 pIn->pLeft = 0;
1671 res = sqlite3ExprIsConstant(pIn);
1672 pIn->pLeft = pLHS;
1673 return res;
1674}
1675#endif
1676
drh6be515e2014-08-01 21:00:53 +00001677/*
danielk19779a96b662007-11-29 17:05:18 +00001678** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00001679** The pX parameter is the expression on the RHS of the IN operator, which
1680** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00001681**
drhd4305ca2012-09-18 17:08:33 +00001682** The job of this routine is to find or create a b-tree object that can
1683** be used either to test for membership in the RHS set or to iterate through
1684** all members of the RHS set, skipping duplicates.
1685**
drh3a856252014-08-01 14:46:57 +00001686** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00001687** and pX->iTable is set to the index of that cursor.
1688**
drhb74b1012009-05-28 21:04:37 +00001689** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00001690**
drh1ccce442013-03-12 20:38:51 +00001691** IN_INDEX_ROWID - The cursor was opened on a database table.
1692** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
1693** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
1694** IN_INDEX_EPH - The cursor was opened on a specially created and
1695** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00001696** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
1697** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00001698**
drhd4305ca2012-09-18 17:08:33 +00001699** An existing b-tree might be used if the RHS expression pX is a simple
1700** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00001701**
1702** SELECT <column> FROM <table>
1703**
drhd4305ca2012-09-18 17:08:33 +00001704** If the RHS of the IN operator is a list or a more complex subquery, then
1705** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00001706** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00001707** existing table.
drhd4305ca2012-09-18 17:08:33 +00001708**
drh3a856252014-08-01 14:46:57 +00001709** The inFlags parameter must contain exactly one of the bits
1710** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP. If inFlags contains
1711** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
1712** fast membership test. When the IN_INDEX_LOOP bit is set, the
1713** IN index will be used to loop over all values of the RHS of the
1714** IN operator.
1715**
1716** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
1717** through the set members) then the b-tree must not contain duplicates.
1718** An epheremal table must be used unless the selected <column> is guaranteed
danielk19779a96b662007-11-29 17:05:18 +00001719** to be unique - either because it is an INTEGER PRIMARY KEY or it
drhb74b1012009-05-28 21:04:37 +00001720** has a UNIQUE constraint or UNIQUE index.
danielk19770cdc0222008-06-26 18:04:03 +00001721**
drh3a856252014-08-01 14:46:57 +00001722** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
1723** for fast set membership tests) then an epheremal table must
danielk19770cdc0222008-06-26 18:04:03 +00001724** be used unless <column> is an INTEGER PRIMARY KEY or an index can
1725** be found with <column> as its left-most column.
1726**
drhbb53ecb2014-08-02 21:03:33 +00001727** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
1728** if the RHS of the IN operator is a list (not a subquery) then this
1729** routine might decide that creating an ephemeral b-tree for membership
1730** testing is too expensive and return IN_INDEX_NOOP. In that case, the
1731** calling routine should implement the IN operator using a sequence
1732** of Eq or Ne comparison operations.
1733**
drhb74b1012009-05-28 21:04:37 +00001734** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00001735** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00001736** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00001737** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00001738** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00001739** to *prRhsHasNull. If there is no chance that the (...) contains a
1740** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00001741**
drhe21a6e12014-08-01 18:00:24 +00001742** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00001743** the value in that register will be NULL if the b-tree contains one or more
1744** NULL values, and it will be some non-NULL value if the b-tree contains no
1745** NULL values.
danielk19779a96b662007-11-29 17:05:18 +00001746*/
danielk1977284f4ac2007-12-10 05:03:46 +00001747#ifndef SQLITE_OMIT_SUBQUERY
drhe21a6e12014-08-01 18:00:24 +00001748int sqlite3FindInIndex(Parse *pParse, Expr *pX, u32 inFlags, int *prRhsHasNull){
drhb74b1012009-05-28 21:04:37 +00001749 Select *p; /* SELECT to the right of IN operator */
1750 int eType = 0; /* Type of RHS table. IN_INDEX_* */
1751 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00001752 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00001753 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00001754
drh1450bc62009-10-30 13:25:56 +00001755 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00001756 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00001757
drhb74b1012009-05-28 21:04:37 +00001758 /* Check to see if an existing table or index can be used to
1759 ** satisfy the query. This is preferable to generating a new
1760 ** ephemeral table.
danielk19779a96b662007-11-29 17:05:18 +00001761 */
drh69c355b2016-03-09 15:34:51 +00001762 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00001763 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00001764 Table *pTab; /* Table <table>. */
1765 Expr *pExpr; /* Expression <column> */
drhbbbdc832013-10-22 18:01:40 +00001766 i16 iCol; /* Index of column <column> */
1767 i16 iDb; /* Database idx for pTab */
drhb07028f2011-10-14 21:49:18 +00001768
drhb07028f2011-10-14 21:49:18 +00001769 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
1770 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1771 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
1772 pTab = p->pSrc->a[0].pTab;
1773 pExpr = p->pEList->a[0].pExpr;
drhbbbdc832013-10-22 18:01:40 +00001774 iCol = (i16)pExpr->iColumn;
danielk1977e1fb65a2009-04-02 17:23:32 +00001775
drhb22f7c82014-02-06 23:56:27 +00001776 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00001777 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1778 sqlite3CodeVerifySchema(pParse, iDb);
1779 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00001780
1781 /* This function is only called from two places. In both cases the vdbe
1782 ** has already been allocated. So assume sqlite3GetVdbe() is always
1783 ** successful here.
1784 */
1785 assert(v);
1786 if( iCol<0 ){
drh7d176102014-02-18 03:07:12 +00001787 int iAddr = sqlite3CodeOnce(pParse);
1788 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00001789
1790 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
1791 eType = IN_INDEX_ROWID;
1792
1793 sqlite3VdbeJumpHere(v, iAddr);
1794 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00001795 Index *pIdx; /* Iterator variable */
1796
drhb74b1012009-05-28 21:04:37 +00001797 /* The collation sequence used by the comparison. If an index is to
danielk19779a96b662007-11-29 17:05:18 +00001798 ** be used in place of a temp-table, it must be ordered according
danielk1977e1fb65a2009-04-02 17:23:32 +00001799 ** to this collation sequence. */
danielk19779a96b662007-11-29 17:05:18 +00001800 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
1801
1802 /* Check that the affinity that will be used to perform the
1803 ** comparison is the same as the affinity of the column. If
1804 ** it is not, it is not possible to use any index.
1805 */
drhdbaee5e2012-09-18 19:29:06 +00001806 int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
danielk19779a96b662007-11-29 17:05:18 +00001807
1808 for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
1809 if( (pIdx->aiColumn[0]==iCol)
drhb74b1012009-05-28 21:04:37 +00001810 && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
drh5f1d1d92014-07-31 22:59:04 +00001811 && (!mustBeUnique || (pIdx->nKeyCol==1 && IsUniqueIndex(pIdx)))
danielk19779a96b662007-11-29 17:05:18 +00001812 ){
drh7d176102014-02-18 03:07:12 +00001813 int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
drh2ec2fb22013-11-06 19:59:23 +00001814 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
1815 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danielk1977207872a2008-01-03 07:54:23 +00001816 VdbeComment((v, "%s", pIdx->zName));
drh1ccce442013-03-12 20:38:51 +00001817 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
1818 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
danielk19779a96b662007-11-29 17:05:18 +00001819
drhe21a6e12014-08-01 18:00:24 +00001820 if( prRhsHasNull && !pTab->aCol[iCol].notNull ){
1821 *prRhsHasNull = ++pParse->nMem;
drh6be515e2014-08-01 21:00:53 +00001822 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
danielk19770cdc0222008-06-26 18:04:03 +00001823 }
drh552fd452014-02-18 01:07:38 +00001824 sqlite3VdbeJumpHere(v, iAddr);
danielk19779a96b662007-11-29 17:05:18 +00001825 }
1826 }
1827 }
1828 }
1829
drhbb53ecb2014-08-02 21:03:33 +00001830 /* If no preexisting index is available for the IN clause
1831 ** and IN_INDEX_NOOP is an allowed reply
1832 ** and the RHS of the IN operator is a list, not a subquery
1833 ** and the RHS is not contant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00001834 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00001835 ** the IN operator so return IN_INDEX_NOOP.
1836 */
1837 if( eType==0
1838 && (inFlags & IN_INDEX_NOOP_OK)
1839 && !ExprHasProperty(pX, EP_xIsSelect)
1840 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
1841 ){
1842 eType = IN_INDEX_NOOP;
1843 }
1844
1845
danielk19779a96b662007-11-29 17:05:18 +00001846 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00001847 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00001848 ** We will have to generate an ephemeral table to do the job.
1849 */
drh8e23daf2013-06-11 13:30:04 +00001850 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00001851 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00001852 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00001853 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00001854 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00001855 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00001856 eType = IN_INDEX_ROWID;
1857 }
drhe21a6e12014-08-01 18:00:24 +00001858 }else if( prRhsHasNull ){
1859 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00001860 }
danielk197741a05b72008-10-02 13:50:55 +00001861 sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
drhcf4d38a2010-07-28 02:53:36 +00001862 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00001863 }else{
1864 pX->iTable = iTab;
1865 }
1866 return eType;
1867}
danielk1977284f4ac2007-12-10 05:03:46 +00001868#endif
drh626a8792005-01-17 22:08:19 +00001869
1870/*
drhd4187c72010-08-30 22:15:45 +00001871** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1872** or IN operators. Examples:
drh626a8792005-01-17 22:08:19 +00001873**
drh9cbe6352005-11-29 03:13:21 +00001874** (SELECT a FROM b) -- subquery
1875** EXISTS (SELECT a FROM b) -- EXISTS subquery
1876** x IN (4,5,11) -- IN operator with list on right-hand side
1877** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00001878**
drh9cbe6352005-11-29 03:13:21 +00001879** The pExpr parameter describes the expression that contains the IN
1880** operator or subquery.
danielk197741a05b72008-10-02 13:50:55 +00001881**
1882** If parameter isRowid is non-zero, then expression pExpr is guaranteed
1883** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
1884** to some integer key column of a table B-Tree. In this case, use an
1885** intkey B-Tree to store the set of IN(...) values instead of the usual
1886** (slower) variable length keys B-Tree.
drhfd773cf2009-05-29 14:39:07 +00001887**
1888** If rMayHaveNull is non-zero, that means that the operation is an IN
1889** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
drh3a856252014-08-01 14:46:57 +00001890** All this routine does is initialize the register given by rMayHaveNull
1891** to NULL. Calling routines will take care of changing this register
1892** value to non-NULL if the RHS is NULL-free.
drh1450bc62009-10-30 13:25:56 +00001893**
1894** For a SELECT or EXISTS operator, return the register that holds the
1895** result. For IN operators or if an error occurs, the return value is 0.
drhcce7d172000-05-31 15:34:51 +00001896*/
drh51522cd2005-01-20 13:36:19 +00001897#ifndef SQLITE_OMIT_SUBQUERY
drh1450bc62009-10-30 13:25:56 +00001898int sqlite3CodeSubselect(
drhfd773cf2009-05-29 14:39:07 +00001899 Parse *pParse, /* Parsing context */
1900 Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
drh6be515e2014-08-01 21:00:53 +00001901 int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
drhfd773cf2009-05-29 14:39:07 +00001902 int isRowid /* If true, LHS of IN operator is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00001903){
drh6be515e2014-08-01 21:00:53 +00001904 int jmpIfDynamic = -1; /* One-time test address */
drh1450bc62009-10-30 13:25:56 +00001905 int rReg = 0; /* Register storing resulting */
danielk1977b3bce662005-01-29 08:32:43 +00001906 Vdbe *v = sqlite3GetVdbe(pParse);
drh1450bc62009-10-30 13:25:56 +00001907 if( NEVER(v==0) ) return 0;
drhceea3322009-04-23 13:22:42 +00001908 sqlite3ExprCachePush(pParse);
danielk1977fc976062007-05-10 10:46:56 +00001909
drh57dbd7b2005-07-08 18:25:26 +00001910 /* This code must be run in its entirety every time it is encountered
1911 ** if any of the following is true:
1912 **
1913 ** * The right-hand side is a correlated subquery
1914 ** * The right-hand side is an expression list containing variables
1915 ** * We are inside a trigger
1916 **
1917 ** If all of the above are false, then we can run this code just once
1918 ** save the results, and reuse the same result on subsequent invocations.
danielk1977b3bce662005-01-29 08:32:43 +00001919 */
drhc5cd1242013-09-12 16:50:49 +00001920 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh6be515e2014-08-01 21:00:53 +00001921 jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00001922 }
1923
dan4a07e3d2010-11-09 14:48:59 +00001924#ifndef SQLITE_OMIT_EXPLAIN
1925 if( pParse->explain==2 ){
drh62aaa6c2015-11-21 17:27:42 +00001926 char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
1927 jmpIfDynamic>=0?"":"CORRELATED ",
1928 pExpr->op==TK_IN?"LIST":"SCALAR",
1929 pParse->iNextSelectId
dan4a07e3d2010-11-09 14:48:59 +00001930 );
1931 sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
1932 }
1933#endif
1934
drhcce7d172000-05-31 15:34:51 +00001935 switch( pExpr->op ){
drhfef52082000-06-06 01:50:43 +00001936 case TK_IN: {
drhd4187c72010-08-30 22:15:45 +00001937 char affinity; /* Affinity of the LHS of the IN */
drhd4187c72010-08-30 22:15:45 +00001938 int addr; /* Address of OP_OpenEphemeral instruction */
1939 Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
drh323df792013-08-05 19:11:29 +00001940 KeyInfo *pKeyInfo = 0; /* Key information */
drhd3d39e92004-05-20 22:16:29 +00001941
danielk197741a05b72008-10-02 13:50:55 +00001942 affinity = sqlite3ExprAffinity(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00001943
1944 /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
drh8cff69d2009-11-12 19:59:44 +00001945 ** expression it is handled the same way. An ephemeral table is
danielk1977e014a832004-05-17 10:48:57 +00001946 ** filled with single-field index keys representing the results
1947 ** from the SELECT or the <exprlist>.
1948 **
1949 ** If the 'x' expression is a column value, or the SELECT...
1950 ** statement returns a column value, then the affinity of that
1951 ** column is used to build the index keys. If both 'x' and the
1952 ** SELECT... statement are columns, then numeric affinity is used
1953 ** if either column has NUMERIC or INTEGER affinity. If neither
1954 ** 'x' nor the SELECT... statement are columns, then numeric affinity
1955 ** is used.
1956 */
1957 pExpr->iTable = pParse->nTab++;
danielk197741a05b72008-10-02 13:50:55 +00001958 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
drhad124322013-10-23 13:30:58 +00001959 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1, 1);
danielk1977e014a832004-05-17 10:48:57 +00001960
danielk19776ab3a2e2009-02-19 14:39:25 +00001961 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhfef52082000-06-06 01:50:43 +00001962 /* Case 1: expr IN (SELECT ...)
1963 **
danielk1977e014a832004-05-17 10:48:57 +00001964 ** Generate code to write the results of the select into the temporary
1965 ** table allocated and opened above.
drhfef52082000-06-06 01:50:43 +00001966 */
drh43870062014-07-31 15:44:44 +00001967 Select *pSelect = pExpr->x.pSelect;
drh1013c932008-01-06 00:25:21 +00001968 SelectDest dest;
drhbe5c89a2004-07-26 00:31:09 +00001969 ExprList *pEList;
drh1013c932008-01-06 00:25:21 +00001970
danielk197741a05b72008-10-02 13:50:55 +00001971 assert( !isRowid );
drh1013c932008-01-06 00:25:21 +00001972 sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
drh2b596da2012-07-23 21:43:19 +00001973 dest.affSdst = (u8)affinity;
danielk1977e014a832004-05-17 10:48:57 +00001974 assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
drh43870062014-07-31 15:44:44 +00001975 pSelect->iLimit = 0;
1976 testcase( pSelect->selFlags & SF_Distinct );
drh812ea832013-08-06 17:24:23 +00001977 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh43870062014-07-31 15:44:44 +00001978 if( sqlite3Select(pParse, pSelect, &dest) ){
drh2ec2fb22013-11-06 19:59:23 +00001979 sqlite3KeyInfoUnref(pKeyInfo);
drh1450bc62009-10-30 13:25:56 +00001980 return 0;
drh94ccde52007-04-13 16:06:32 +00001981 }
drh43870062014-07-31 15:44:44 +00001982 pEList = pSelect->pEList;
drh812ea832013-08-06 17:24:23 +00001983 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
drh3535ec32013-08-06 16:56:44 +00001984 assert( pEList!=0 );
1985 assert( pEList->nExpr>0 );
drh2ec2fb22013-11-06 19:59:23 +00001986 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh3535ec32013-08-06 16:56:44 +00001987 pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1988 pEList->a[0].pExpr);
drha7d2db12010-07-14 20:23:52 +00001989 }else if( ALWAYS(pExpr->x.pList!=0) ){
drhfef52082000-06-06 01:50:43 +00001990 /* Case 2: expr IN (exprlist)
1991 **
drhfd131da2007-08-07 17:13:03 +00001992 ** For each expression, build an index key from the evaluation and
danielk1977e014a832004-05-17 10:48:57 +00001993 ** store it in the temporary table. If <expr> is a column, then use
1994 ** that columns affinity when building index keys. If <expr> is not
1995 ** a column, use numeric affinity.
drhfef52082000-06-06 01:50:43 +00001996 */
danielk1977e014a832004-05-17 10:48:57 +00001997 int i;
danielk19776ab3a2e2009-02-19 14:39:25 +00001998 ExprList *pList = pExpr->x.pList;
drh57dbd7b2005-07-08 18:25:26 +00001999 struct ExprList_item *pItem;
drhecc31802008-06-26 20:06:06 +00002000 int r1, r2, r3;
drh57dbd7b2005-07-08 18:25:26 +00002001
danielk1977e014a832004-05-17 10:48:57 +00002002 if( !affinity ){
drh05883a32015-06-02 15:32:08 +00002003 affinity = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +00002004 }
drh323df792013-08-05 19:11:29 +00002005 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002006 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh323df792013-08-05 19:11:29 +00002007 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2008 }
danielk1977e014a832004-05-17 10:48:57 +00002009
2010 /* Loop through each expression in <exprlist>. */
drh2d401ab2008-01-10 23:50:11 +00002011 r1 = sqlite3GetTempReg(pParse);
2012 r2 = sqlite3GetTempReg(pParse);
drh37e08082014-07-31 20:16:08 +00002013 if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
drh57dbd7b2005-07-08 18:25:26 +00002014 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2015 Expr *pE2 = pItem->pExpr;
drhe05c9292009-10-29 13:48:10 +00002016 int iValToIns;
danielk1977e014a832004-05-17 10:48:57 +00002017
drh57dbd7b2005-07-08 18:25:26 +00002018 /* If the expression is not constant then we will need to
2019 ** disable the test that was generated above that makes sure
2020 ** this code only executes once. Because for a non-constant
2021 ** expression we need to rerun this code each time.
2022 */
drh6be515e2014-08-01 21:00:53 +00002023 if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
2024 sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
2025 jmpIfDynamic = -1;
drh4794b982000-06-06 13:54:14 +00002026 }
danielk1977e014a832004-05-17 10:48:57 +00002027
2028 /* Evaluate the expression and insert it into the temp table */
drhe05c9292009-10-29 13:48:10 +00002029 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2030 sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
danielk197741a05b72008-10-02 13:50:55 +00002031 }else{
drhe05c9292009-10-29 13:48:10 +00002032 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2033 if( isRowid ){
2034 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2035 sqlite3VdbeCurrentAddr(v)+2);
drh688852a2014-02-17 22:40:43 +00002036 VdbeCoverage(v);
drhe05c9292009-10-29 13:48:10 +00002037 sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
2038 }else{
2039 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2040 sqlite3ExprCacheAffinityChange(pParse, r3, 1);
2041 sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2042 }
danielk197741a05b72008-10-02 13:50:55 +00002043 }
drhfef52082000-06-06 01:50:43 +00002044 }
drh2d401ab2008-01-10 23:50:11 +00002045 sqlite3ReleaseTempReg(pParse, r1);
2046 sqlite3ReleaseTempReg(pParse, r2);
drhfef52082000-06-06 01:50:43 +00002047 }
drh323df792013-08-05 19:11:29 +00002048 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002049 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
danielk197741a05b72008-10-02 13:50:55 +00002050 }
danielk1977b3bce662005-01-29 08:32:43 +00002051 break;
drhfef52082000-06-06 01:50:43 +00002052 }
2053
drh51522cd2005-01-20 13:36:19 +00002054 case TK_EXISTS:
drhfd773cf2009-05-29 14:39:07 +00002055 case TK_SELECT:
2056 default: {
drhfd773cf2009-05-29 14:39:07 +00002057 /* If this has to be a scalar SELECT. Generate code to put the
drhfef52082000-06-06 01:50:43 +00002058 ** value of this select in a memory cell and record the number
drhfd773cf2009-05-29 14:39:07 +00002059 ** of the memory cell in iColumn. If this is an EXISTS, write
2060 ** an integer 0 (not exists) or 1 (exists) into a memory cell
2061 ** and record that memory cell in iColumn.
drhfef52082000-06-06 01:50:43 +00002062 */
drhfd773cf2009-05-29 14:39:07 +00002063 Select *pSel; /* SELECT statement to encode */
2064 SelectDest dest; /* How to deal with SELECt result */
drh1398ad32005-01-19 23:24:50 +00002065
shanecf697392009-06-01 16:53:09 +00002066 testcase( pExpr->op==TK_EXISTS );
2067 testcase( pExpr->op==TK_SELECT );
2068 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2069
danielk19776ab3a2e2009-02-19 14:39:25 +00002070 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2071 pSel = pExpr->x.pSelect;
drh1013c932008-01-06 00:25:21 +00002072 sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
drh51522cd2005-01-20 13:36:19 +00002073 if( pExpr->op==TK_SELECT ){
danielk19776c8c8ce2008-01-02 16:27:09 +00002074 dest.eDest = SRT_Mem;
drh53932ce2014-08-29 12:29:39 +00002075 dest.iSdst = dest.iSDParm;
drh2b596da2012-07-23 21:43:19 +00002076 sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002077 VdbeComment((v, "Init subquery result"));
drh51522cd2005-01-20 13:36:19 +00002078 }else{
danielk19776c8c8ce2008-01-02 16:27:09 +00002079 dest.eDest = SRT_Exists;
drh2b596da2012-07-23 21:43:19 +00002080 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002081 VdbeComment((v, "Init EXISTS result"));
drh51522cd2005-01-20 13:36:19 +00002082 }
drh633e6d52008-07-28 19:34:53 +00002083 sqlite3ExprDelete(pParse->db, pSel->pLimit);
drh094430e2010-07-14 18:24:06 +00002084 pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2085 &sqlite3IntTokens[1]);
drh48b5b042010-12-06 18:50:32 +00002086 pSel->iLimit = 0;
drh772460f2015-04-16 14:13:12 +00002087 pSel->selFlags &= ~SF_MultiValue;
drh7d10d5a2008-08-20 16:35:10 +00002088 if( sqlite3Select(pParse, pSel, &dest) ){
drh1450bc62009-10-30 13:25:56 +00002089 return 0;
drh94ccde52007-04-13 16:06:32 +00002090 }
drh2b596da2012-07-23 21:43:19 +00002091 rReg = dest.iSDParm;
drhebb6a652013-09-12 23:42:22 +00002092 ExprSetVVAProperty(pExpr, EP_NoReduce);
danielk1977b3bce662005-01-29 08:32:43 +00002093 break;
drhcce7d172000-05-31 15:34:51 +00002094 }
2095 }
danielk1977b3bce662005-01-29 08:32:43 +00002096
drh6be515e2014-08-01 21:00:53 +00002097 if( rHasNullFlag ){
2098 sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
danielk1977b3bce662005-01-29 08:32:43 +00002099 }
drh6be515e2014-08-01 21:00:53 +00002100
2101 if( jmpIfDynamic>=0 ){
2102 sqlite3VdbeJumpHere(v, jmpIfDynamic);
danielk1977b3bce662005-01-29 08:32:43 +00002103 }
drhd2490902014-04-13 19:28:15 +00002104 sqlite3ExprCachePop(pParse);
danielk1977fc976062007-05-10 10:46:56 +00002105
drh1450bc62009-10-30 13:25:56 +00002106 return rReg;
drhcce7d172000-05-31 15:34:51 +00002107}
drh51522cd2005-01-20 13:36:19 +00002108#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002109
drhe3365e62009-11-12 17:52:24 +00002110#ifndef SQLITE_OMIT_SUBQUERY
2111/*
2112** Generate code for an IN expression.
2113**
2114** x IN (SELECT ...)
2115** x IN (value, value, ...)
2116**
2117** The left-hand side (LHS) is a scalar expression. The right-hand side (RHS)
2118** is an array of zero or more values. The expression is true if the LHS is
2119** contained within the RHS. The value of the expression is unknown (NULL)
2120** if the LHS is NULL or if the LHS is not contained within the RHS and the
2121** RHS contains one or more NULL values.
2122**
drh6be515e2014-08-01 21:00:53 +00002123** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002124** contained within the RHS. If due to NULLs we cannot determine if the LHS
2125** is contained in the RHS then jump to destIfNull. If the LHS is contained
2126** within the RHS then fall through.
2127*/
2128static void sqlite3ExprCodeIN(
2129 Parse *pParse, /* Parsing and code generating context */
2130 Expr *pExpr, /* The IN expression */
2131 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2132 int destIfNull /* Jump here if the results are unknown due to NULLs */
2133){
2134 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
2135 char affinity; /* Comparison affinity to use */
2136 int eType; /* Type of the RHS */
2137 int r1; /* Temporary use register */
2138 Vdbe *v; /* Statement under construction */
2139
2140 /* Compute the RHS. After this step, the table with cursor
2141 ** pExpr->iTable will contains the values that make up the RHS.
2142 */
2143 v = pParse->pVdbe;
2144 assert( v!=0 ); /* OOM detected prior to this routine */
2145 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00002146 eType = sqlite3FindInIndex(pParse, pExpr,
2147 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh3a856252014-08-01 14:46:57 +00002148 destIfFalse==destIfNull ? 0 : &rRhsHasNull);
drhe3365e62009-11-12 17:52:24 +00002149
2150 /* Figure out the affinity to use to create a key from the results
2151 ** of the expression. affinityStr stores a static string suitable for
2152 ** P4 of OP_MakeRecord.
2153 */
2154 affinity = comparisonAffinity(pExpr);
2155
2156 /* Code the LHS, the <expr> from "<expr> IN (...)".
2157 */
2158 sqlite3ExprCachePush(pParse);
2159 r1 = sqlite3GetTempReg(pParse);
2160 sqlite3ExprCode(pParse, pExpr->pLeft, r1);
drhe3365e62009-11-12 17:52:24 +00002161
drhbb53ecb2014-08-02 21:03:33 +00002162 /* If sqlite3FindInIndex() did not find or create an index that is
2163 ** suitable for evaluating the IN operator, then evaluate using a
2164 ** sequence of comparisons.
drh094430e2010-07-14 18:24:06 +00002165 */
drhbb53ecb2014-08-02 21:03:33 +00002166 if( eType==IN_INDEX_NOOP ){
2167 ExprList *pList = pExpr->x.pList;
2168 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2169 int labelOk = sqlite3VdbeMakeLabel(v);
2170 int r2, regToFree;
2171 int regCkNull = 0;
2172 int ii;
2173 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00002174 if( destIfNull!=destIfFalse ){
2175 regCkNull = sqlite3GetTempReg(pParse);
drha9769792014-08-04 16:39:39 +00002176 sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00002177 }
2178 for(ii=0; ii<pList->nExpr; ii++){
2179 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00002180 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00002181 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2182 }
2183 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2184 sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00002185 (void*)pColl, P4_COLLSEQ);
2186 VdbeCoverageIf(v, ii<pList->nExpr-1);
2187 VdbeCoverageIf(v, ii==pList->nExpr-1);
drhbb53ecb2014-08-02 21:03:33 +00002188 sqlite3VdbeChangeP5(v, affinity);
2189 }else{
2190 assert( destIfNull==destIfFalse );
2191 sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2192 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2193 sqlite3VdbeChangeP5(v, affinity | SQLITE_JUMPIFNULL);
2194 }
2195 sqlite3ReleaseTempReg(pParse, regToFree);
2196 }
2197 if( regCkNull ){
2198 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002199 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00002200 }
2201 sqlite3VdbeResolveLabel(v, labelOk);
2202 sqlite3ReleaseTempReg(pParse, regCkNull);
drh094430e2010-07-14 18:24:06 +00002203 }else{
drhbb53ecb2014-08-02 21:03:33 +00002204
2205 /* If the LHS is NULL, then the result is either false or NULL depending
2206 ** on whether the RHS is empty or not, respectively.
drhe3365e62009-11-12 17:52:24 +00002207 */
drh7248a8b2014-08-04 18:50:54 +00002208 if( sqlite3ExprCanBeNull(pExpr->pLeft) ){
2209 if( destIfNull==destIfFalse ){
2210 /* Shortcut for the common case where the false and NULL outcomes are
2211 ** the same. */
2212 sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull); VdbeCoverage(v);
2213 }else{
2214 int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2215 sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2216 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002217 sqlite3VdbeGoto(v, destIfNull);
drh7248a8b2014-08-04 18:50:54 +00002218 sqlite3VdbeJumpHere(v, addr1);
2219 }
drhbb53ecb2014-08-02 21:03:33 +00002220 }
2221
2222 if( eType==IN_INDEX_ROWID ){
2223 /* In this case, the RHS is the ROWID of table b-tree
drhe3365e62009-11-12 17:52:24 +00002224 */
drhbb53ecb2014-08-02 21:03:33 +00002225 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse); VdbeCoverage(v);
2226 sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
drh688852a2014-02-17 22:40:43 +00002227 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00002228 }else{
drhbb53ecb2014-08-02 21:03:33 +00002229 /* In this case, the RHS is an index b-tree.
drhe3365e62009-11-12 17:52:24 +00002230 */
drhbb53ecb2014-08-02 21:03:33 +00002231 sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
2232
2233 /* If the set membership test fails, then the result of the
2234 ** "x IN (...)" expression must be either 0 or NULL. If the set
2235 ** contains no NULL values, then the result is 0. If the set
2236 ** contains one or more NULL values, then the result of the
2237 ** expression is also NULL.
drhe3365e62009-11-12 17:52:24 +00002238 */
drhbb53ecb2014-08-02 21:03:33 +00002239 assert( destIfFalse!=destIfNull || rRhsHasNull==0 );
2240 if( rRhsHasNull==0 ){
2241 /* This branch runs if it is known at compile time that the RHS
2242 ** cannot contain NULL values. This happens as the result
2243 ** of a "NOT NULL" constraint in the database schema.
2244 **
2245 ** Also run this branch if NULL is equivalent to FALSE
2246 ** for this particular IN operator.
2247 */
2248 sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
2249 VdbeCoverage(v);
2250 }else{
2251 /* In this branch, the RHS of the IN might contain a NULL and
2252 ** the presence of a NULL on the RHS makes a difference in the
2253 ** outcome.
2254 */
drh728e0f92015-10-10 14:41:28 +00002255 int addr1;
drhbb53ecb2014-08-02 21:03:33 +00002256
2257 /* First check to see if the LHS is contained in the RHS. If so,
2258 ** then the answer is TRUE the presence of NULLs in the RHS does
2259 ** not matter. If the LHS is not contained in the RHS, then the
2260 ** answer is NULL if the RHS contains NULLs and the answer is
2261 ** FALSE if the RHS is NULL-free.
2262 */
drh728e0f92015-10-10 14:41:28 +00002263 addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
drhbb53ecb2014-08-02 21:03:33 +00002264 VdbeCoverage(v);
2265 sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2266 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002267 sqlite3VdbeGoto(v, destIfFalse);
drh728e0f92015-10-10 14:41:28 +00002268 sqlite3VdbeJumpHere(v, addr1);
drhbb53ecb2014-08-02 21:03:33 +00002269 }
drhe3365e62009-11-12 17:52:24 +00002270 }
drhe3365e62009-11-12 17:52:24 +00002271 }
2272 sqlite3ReleaseTempReg(pParse, r1);
drhd2490902014-04-13 19:28:15 +00002273 sqlite3ExprCachePop(pParse);
drhe3365e62009-11-12 17:52:24 +00002274 VdbeComment((v, "end IN expr"));
2275}
2276#endif /* SQLITE_OMIT_SUBQUERY */
2277
drh13573c72010-01-12 17:04:07 +00002278#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00002279/*
2280** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00002281** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00002282**
2283** The z[] string will probably not be zero-terminated. But the
2284** z[n] character is guaranteed to be something that does not look
2285** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00002286*/
drhb7916a72009-05-27 10:31:29 +00002287static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00002288 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00002289 double value;
drh9339da12010-09-30 00:50:49 +00002290 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00002291 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2292 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00002293 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00002294 }
2295}
drh13573c72010-01-12 17:04:07 +00002296#endif
drh598f1342007-10-23 15:39:45 +00002297
2298
2299/*
drhfec19aa2004-05-19 20:41:03 +00002300** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00002301** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00002302**
shaneh5f1d6b62010-09-30 16:51:25 +00002303** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00002304*/
drh13573c72010-01-12 17:04:07 +00002305static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
2306 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00002307 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002308 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00002309 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00002310 if( negFlag ) i = -i;
2311 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00002312 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00002313 int c;
2314 i64 value;
drhfd773cf2009-05-29 14:39:07 +00002315 const char *z = pExpr->u.zToken;
2316 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00002317 c = sqlite3DecOrHexToI64(z, &value);
shaneh5f1d6b62010-09-30 16:51:25 +00002318 if( c==0 || (c==2 && negFlag) ){
drh158b9cb2011-03-05 20:59:46 +00002319 if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
drh97bae792015-06-05 15:59:57 +00002320 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00002321 }else{
drh13573c72010-01-12 17:04:07 +00002322#ifdef SQLITE_OMIT_FLOATING_POINT
2323 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
2324#else
drh1b7ddc52014-07-23 14:52:05 +00002325#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00002326 if( sqlite3_strnicmp(z,"0x",2)==0 ){
2327 sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
drh1b7ddc52014-07-23 14:52:05 +00002328 }else
2329#endif
2330 {
drh9296c182014-07-23 13:40:49 +00002331 codeReal(v, z, negFlag, iMem);
2332 }
drh13573c72010-01-12 17:04:07 +00002333#endif
danielk1977c9cf9012007-05-30 10:36:47 +00002334 }
drhfec19aa2004-05-19 20:41:03 +00002335 }
2336}
2337
drhbea119c2016-04-11 18:15:37 +00002338#if defined(SQLITE_DEBUG)
2339/*
2340** Verify the consistency of the column cache
2341*/
2342static int cacheIsValid(Parse *pParse){
2343 int i, n;
2344 for(i=n=0; i<SQLITE_N_COLCACHE; i++){
2345 if( pParse->aColCache[i].iReg>0 ) n++;
2346 }
2347 return n==pParse->nColCache;
2348}
2349#endif
2350
drhceea3322009-04-23 13:22:42 +00002351/*
2352** Clear a cache entry.
2353*/
2354static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2355 if( p->tempReg ){
2356 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2357 pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2358 }
2359 p->tempReg = 0;
2360 }
drhbea119c2016-04-11 18:15:37 +00002361 p->iReg = 0;
2362 pParse->nColCache--;
2363 assert( cacheIsValid(pParse) );
drhceea3322009-04-23 13:22:42 +00002364}
2365
2366
2367/*
2368** Record in the column cache that a particular column from a
2369** particular table is stored in a particular register.
2370*/
2371void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2372 int i;
2373 int minLru;
2374 int idxLru;
2375 struct yColCache *p;
2376
dance8f53d2015-01-21 17:00:57 +00002377 /* Unless an error has occurred, register numbers are always positive. */
2378 assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00002379 assert( iCol>=-1 && iCol<32768 ); /* Finite column numbers */
2380
drhb6da74e2009-12-24 16:00:28 +00002381 /* The SQLITE_ColumnCache flag disables the column cache. This is used
2382 ** for testing only - to verify that SQLite always gets the same answer
2383 ** with and without the column cache.
2384 */
drh7e5418e2012-09-27 15:05:54 +00002385 if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
drhb6da74e2009-12-24 16:00:28 +00002386
drh27ee4062009-12-30 01:13:11 +00002387 /* First replace any existing entry.
2388 **
2389 ** Actually, the way the column cache is currently used, we are guaranteed
2390 ** that the object will never already be in cache. Verify this guarantee.
2391 */
2392#ifndef NDEBUG
drhceea3322009-04-23 13:22:42 +00002393 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drh27ee4062009-12-30 01:13:11 +00002394 assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
drhceea3322009-04-23 13:22:42 +00002395 }
drh27ee4062009-12-30 01:13:11 +00002396#endif
drhceea3322009-04-23 13:22:42 +00002397
2398 /* Find an empty slot and replace it */
2399 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2400 if( p->iReg==0 ){
2401 p->iLevel = pParse->iCacheLevel;
2402 p->iTable = iTab;
2403 p->iColumn = iCol;
2404 p->iReg = iReg;
drhceea3322009-04-23 13:22:42 +00002405 p->tempReg = 0;
2406 p->lru = pParse->iCacheCnt++;
drhbea119c2016-04-11 18:15:37 +00002407 pParse->nColCache++;
2408 assert( cacheIsValid(pParse) );
drhceea3322009-04-23 13:22:42 +00002409 return;
2410 }
2411 }
2412
2413 /* Replace the last recently used */
2414 minLru = 0x7fffffff;
2415 idxLru = -1;
2416 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2417 if( p->lru<minLru ){
2418 idxLru = i;
2419 minLru = p->lru;
2420 }
2421 }
drh20411ea2009-05-29 19:00:12 +00002422 if( ALWAYS(idxLru>=0) ){
drhceea3322009-04-23 13:22:42 +00002423 p = &pParse->aColCache[idxLru];
2424 p->iLevel = pParse->iCacheLevel;
2425 p->iTable = iTab;
2426 p->iColumn = iCol;
2427 p->iReg = iReg;
drhceea3322009-04-23 13:22:42 +00002428 p->tempReg = 0;
2429 p->lru = pParse->iCacheCnt++;
drhbea119c2016-04-11 18:15:37 +00002430 assert( cacheIsValid(pParse) );
drhceea3322009-04-23 13:22:42 +00002431 return;
2432 }
2433}
2434
2435/*
drhf49f3522009-12-30 14:12:38 +00002436** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2437** Purge the range of registers from the column cache.
drhceea3322009-04-23 13:22:42 +00002438*/
drhf49f3522009-12-30 14:12:38 +00002439void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
drhceea3322009-04-23 13:22:42 +00002440 struct yColCache *p;
drhbea119c2016-04-11 18:15:37 +00002441 if( iReg<=0 || pParse->nColCache==0 ) return;
2442 p = &pParse->aColCache[SQLITE_N_COLCACHE-1];
2443 while(1){
2444 if( p->iReg >= iReg && p->iReg < iReg+nReg ) cacheEntryClear(pParse, p);
2445 if( p==pParse->aColCache ) break;
2446 p--;
drhceea3322009-04-23 13:22:42 +00002447 }
2448}
2449
2450/*
2451** Remember the current column cache context. Any new entries added
2452** added to the column cache after this call are removed when the
2453** corresponding pop occurs.
2454*/
2455void sqlite3ExprCachePush(Parse *pParse){
2456 pParse->iCacheLevel++;
drh9ac79622013-12-18 15:11:47 +00002457#ifdef SQLITE_DEBUG
2458 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2459 printf("PUSH to %d\n", pParse->iCacheLevel);
2460 }
2461#endif
drhceea3322009-04-23 13:22:42 +00002462}
2463
2464/*
2465** Remove from the column cache any entries that were added since the
drhd2490902014-04-13 19:28:15 +00002466** the previous sqlite3ExprCachePush operation. In other words, restore
2467** the cache to the state it was in prior the most recent Push.
drhceea3322009-04-23 13:22:42 +00002468*/
drhd2490902014-04-13 19:28:15 +00002469void sqlite3ExprCachePop(Parse *pParse){
drhceea3322009-04-23 13:22:42 +00002470 int i;
2471 struct yColCache *p;
drhd2490902014-04-13 19:28:15 +00002472 assert( pParse->iCacheLevel>=1 );
2473 pParse->iCacheLevel--;
drh9ac79622013-12-18 15:11:47 +00002474#ifdef SQLITE_DEBUG
2475 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2476 printf("POP to %d\n", pParse->iCacheLevel);
2477 }
2478#endif
drhceea3322009-04-23 13:22:42 +00002479 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2480 if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2481 cacheEntryClear(pParse, p);
drhceea3322009-04-23 13:22:42 +00002482 }
2483 }
2484}
drh945498f2007-02-24 11:52:52 +00002485
2486/*
drh5cd79232009-05-25 11:46:29 +00002487** When a cached column is reused, make sure that its register is
2488** no longer available as a temp register. ticket #3879: that same
2489** register might be in the cache in multiple places, so be sure to
2490** get them all.
2491*/
2492static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
2493 int i;
2494 struct yColCache *p;
2495 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2496 if( p->iReg==iReg ){
2497 p->tempReg = 0;
2498 }
2499 }
2500}
2501
drh1f9ca2c2015-08-25 16:57:52 +00002502/* Generate code that will load into register regOut a value that is
2503** appropriate for the iIdxCol-th column of index pIdx.
2504*/
2505void sqlite3ExprCodeLoadIndexColumn(
2506 Parse *pParse, /* The parsing context */
2507 Index *pIdx, /* The index whose column is to be loaded */
2508 int iTabCur, /* Cursor pointing to a table row */
2509 int iIdxCol, /* The column of the index to be loaded */
2510 int regOut /* Store the index column value in this register */
2511){
2512 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00002513 if( iTabCol==XN_EXPR ){
2514 assert( pIdx->aColExpr );
2515 assert( pIdx->aColExpr->nExpr>iIdxCol );
2516 pParse->iSelfTab = iTabCur;
drh1c75c9d2015-12-21 15:22:13 +00002517 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh4b92f982015-09-29 17:20:14 +00002518 }else{
drh1f9ca2c2015-08-25 16:57:52 +00002519 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
2520 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00002521 }
drh1f9ca2c2015-08-25 16:57:52 +00002522}
2523
drh5cd79232009-05-25 11:46:29 +00002524/*
drh5c092e82010-05-14 19:24:02 +00002525** Generate code to extract the value of the iCol-th column of a table.
2526*/
2527void sqlite3ExprCodeGetColumnOfTable(
2528 Vdbe *v, /* The VDBE under construction */
2529 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00002530 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00002531 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00002532 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00002533){
2534 if( iCol<0 || iCol==pTab->iPKey ){
2535 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
2536 }else{
2537 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00002538 int x = iCol;
2539 if( !HasRowid(pTab) ){
2540 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2541 }
2542 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00002543 }
2544 if( iCol>=0 ){
2545 sqlite3ColumnDefault(v, pTab, iCol, regOut);
2546 }
2547}
2548
2549/*
drh945498f2007-02-24 11:52:52 +00002550** Generate code that will extract the iColumn-th column from
drhce78bc62015-10-15 19:21:51 +00002551** table pTab and store the column value in a register.
2552**
2553** An effort is made to store the column value in register iReg. This
2554** is not garanteeed for GetColumn() - the result can be stored in
2555** any register. But the result is guaranteed to land in register iReg
2556** for GetColumnToReg().
drhe55cbd72008-03-31 23:48:03 +00002557**
2558** There must be an open cursor to pTab in iTable when this routine
2559** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00002560*/
drhe55cbd72008-03-31 23:48:03 +00002561int sqlite3ExprCodeGetColumn(
2562 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00002563 Table *pTab, /* Description of the table we are reading from */
2564 int iColumn, /* Index of the table column */
2565 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00002566 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00002567 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00002568){
drhe55cbd72008-03-31 23:48:03 +00002569 Vdbe *v = pParse->pVdbe;
2570 int i;
drhda250ea2008-04-01 05:07:14 +00002571 struct yColCache *p;
drhe55cbd72008-03-31 23:48:03 +00002572
drhceea3322009-04-23 13:22:42 +00002573 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
drhb6da74e2009-12-24 16:00:28 +00002574 if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
drhceea3322009-04-23 13:22:42 +00002575 p->lru = pParse->iCacheCnt++;
drh5cd79232009-05-25 11:46:29 +00002576 sqlite3ExprCachePinRegister(pParse, p->iReg);
drhda250ea2008-04-01 05:07:14 +00002577 return p->iReg;
drhe55cbd72008-03-31 23:48:03 +00002578 }
2579 }
2580 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00002581 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00002582 if( p5 ){
2583 sqlite3VdbeChangeP5(v, p5);
2584 }else{
2585 sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2586 }
drhe55cbd72008-03-31 23:48:03 +00002587 return iReg;
2588}
drhce78bc62015-10-15 19:21:51 +00002589void sqlite3ExprCodeGetColumnToReg(
2590 Parse *pParse, /* Parsing and code generating context */
2591 Table *pTab, /* Description of the table we are reading from */
2592 int iColumn, /* Index of the table column */
2593 int iTable, /* The cursor pointing to the table */
2594 int iReg /* Store results here */
2595){
2596 int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
2597 if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
2598}
2599
drhe55cbd72008-03-31 23:48:03 +00002600
2601/*
drhceea3322009-04-23 13:22:42 +00002602** Clear all column cache entries.
drhe55cbd72008-03-31 23:48:03 +00002603*/
drhceea3322009-04-23 13:22:42 +00002604void sqlite3ExprCacheClear(Parse *pParse){
2605 int i;
2606 struct yColCache *p;
2607
drh9ac79622013-12-18 15:11:47 +00002608#if SQLITE_DEBUG
2609 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
2610 printf("CLEAR\n");
2611 }
2612#endif
drhceea3322009-04-23 13:22:42 +00002613 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2614 if( p->iReg ){
2615 cacheEntryClear(pParse, p);
drhe55cbd72008-03-31 23:48:03 +00002616 }
drhe55cbd72008-03-31 23:48:03 +00002617 }
2618}
2619
2620/*
drhda250ea2008-04-01 05:07:14 +00002621** Record the fact that an affinity change has occurred on iCount
2622** registers starting with iStart.
drhe55cbd72008-03-31 23:48:03 +00002623*/
drhda250ea2008-04-01 05:07:14 +00002624void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
drhf49f3522009-12-30 14:12:38 +00002625 sqlite3ExprCacheRemove(pParse, iStart, iCount);
drhe55cbd72008-03-31 23:48:03 +00002626}
2627
2628/*
drhb21e7c72008-06-22 12:37:57 +00002629** Generate code to move content from registers iFrom...iFrom+nReg-1
2630** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
drhe55cbd72008-03-31 23:48:03 +00002631*/
drhb21e7c72008-06-22 12:37:57 +00002632void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00002633 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00002634 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh236241a2014-09-12 17:41:30 +00002635 sqlite3ExprCacheRemove(pParse, iFrom, nReg);
drh945498f2007-02-24 11:52:52 +00002636}
2637
drhf49f3522009-12-30 14:12:38 +00002638#if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
drh92b01d52008-06-24 00:32:35 +00002639/*
drh652fbf52008-04-01 01:42:41 +00002640** Return true if any register in the range iFrom..iTo (inclusive)
2641** is used as part of the column cache.
drhf49f3522009-12-30 14:12:38 +00002642**
2643** This routine is used within assert() and testcase() macros only
2644** and does not appear in a normal build.
drh652fbf52008-04-01 01:42:41 +00002645*/
2646static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2647 int i;
drhceea3322009-04-23 13:22:42 +00002648 struct yColCache *p;
2649 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2650 int r = p->iReg;
drhf49f3522009-12-30 14:12:38 +00002651 if( r>=iFrom && r<=iTo ) return 1; /*NO_TEST*/
drh652fbf52008-04-01 01:42:41 +00002652 }
2653 return 0;
2654}
drhf49f3522009-12-30 14:12:38 +00002655#endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
drh652fbf52008-04-01 01:42:41 +00002656
drhbea119c2016-04-11 18:15:37 +00002657
drh652fbf52008-04-01 01:42:41 +00002658/*
drha4c3c872013-09-12 17:29:25 +00002659** Convert an expression node to a TK_REGISTER
2660*/
2661static void exprToRegister(Expr *p, int iReg){
2662 p->op2 = p->op;
2663 p->op = TK_REGISTER;
2664 p->iTable = iReg;
2665 ExprClearProperty(p, EP_Skip);
2666}
2667
2668/*
drhcce7d172000-05-31 15:34:51 +00002669** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00002670** expression. Attempt to store the results in register "target".
2671** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00002672**
drh8b213892008-08-29 02:14:02 +00002673** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00002674** be stored in target. The result might be stored in some other
2675** register if it is convenient to do so. The calling function
2676** must check the return code and move the results to the desired
2677** register.
drhcce7d172000-05-31 15:34:51 +00002678*/
drh678ccce2008-03-31 18:19:54 +00002679int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00002680 Vdbe *v = pParse->pVdbe; /* The VM under construction */
2681 int op; /* The opcode being coded */
2682 int inReg = target; /* Results stored in register inReg */
2683 int regFree1 = 0; /* If non-zero free this temporary register */
2684 int regFree2 = 0; /* If non-zero free this temporary register */
drh678ccce2008-03-31 18:19:54 +00002685 int r1, r2, r3, r4; /* Various register numbers */
drh20411ea2009-05-29 19:00:12 +00002686 sqlite3 *db = pParse->db; /* The database connection */
drh10d1edf2013-11-15 15:52:39 +00002687 Expr tempX; /* Temporary expression node */
drhffe07b22005-11-03 00:41:17 +00002688
drh9cbf3422008-01-17 16:22:13 +00002689 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00002690 if( v==0 ){
2691 assert( pParse->db->mallocFailed );
2692 return 0;
2693 }
drh389a1ad2008-01-03 23:44:53 +00002694
2695 if( pExpr==0 ){
2696 op = TK_NULL;
2697 }else{
2698 op = pExpr->op;
2699 }
drhf2bc0132004-10-04 13:19:23 +00002700 switch( op ){
drh13449892005-09-07 21:22:45 +00002701 case TK_AGG_COLUMN: {
2702 AggInfo *pAggInfo = pExpr->pAggInfo;
2703 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
2704 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00002705 assert( pCol->iMem>0 );
2706 inReg = pCol->iMem;
drh13449892005-09-07 21:22:45 +00002707 break;
2708 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00002709 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00002710 pCol->iSorterColumn, target);
drh13449892005-09-07 21:22:45 +00002711 break;
2712 }
2713 /* Otherwise, fall thru into the TK_COLUMN case */
2714 }
drh967e8b72000-06-21 13:59:10 +00002715 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00002716 int iTab = pExpr->iTable;
2717 if( iTab<0 ){
2718 if( pParse->ckBase>0 ){
2719 /* Generating CHECK constraints or inserting into partial index */
2720 inReg = pExpr->iColumn + pParse->ckBase;
2721 break;
2722 }else{
drh1f9ca2c2015-08-25 16:57:52 +00002723 /* Coding an expression that is part of an index where column names
2724 ** in the index refer to the table to which the index belongs */
2725 iTab = pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00002726 }
drh22827922000-06-06 17:27:05 +00002727 }
drhb2b9d3d2013-08-01 01:14:43 +00002728 inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2729 pExpr->iColumn, iTab, target,
2730 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00002731 break;
2732 }
2733 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00002734 codeInteger(pParse, pExpr, 0, target);
drhfec19aa2004-05-19 20:41:03 +00002735 break;
2736 }
drh13573c72010-01-12 17:04:07 +00002737#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00002738 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00002739 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2740 codeReal(v, pExpr->u.zToken, 0, target);
drh598f1342007-10-23 15:39:45 +00002741 break;
2742 }
drh13573c72010-01-12 17:04:07 +00002743#endif
drhfec19aa2004-05-19 20:41:03 +00002744 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00002745 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00002746 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhcce7d172000-05-31 15:34:51 +00002747 break;
2748 }
drhf0863fe2005-06-12 21:35:51 +00002749 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00002750 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhf0863fe2005-06-12 21:35:51 +00002751 break;
2752 }
danielk19775338a5f2005-01-20 13:03:10 +00002753#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00002754 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00002755 int n;
2756 const char *z;
drhca48c902008-01-18 14:08:24 +00002757 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00002758 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2759 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
2760 assert( pExpr->u.zToken[1]=='\'' );
2761 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00002762 n = sqlite3Strlen30(z) - 1;
2763 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00002764 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2765 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
danielk1977c572ef72004-05-27 09:28:41 +00002766 break;
2767 }
danielk19775338a5f2005-01-20 13:03:10 +00002768#endif
drh50457892003-09-06 01:10:47 +00002769 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00002770 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2771 assert( pExpr->u.zToken!=0 );
2772 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00002773 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
2774 if( pExpr->u.zToken[1]!=0 ){
drh04e9eea2011-06-01 19:16:06 +00002775 assert( pExpr->u.zToken[0]=='?'
2776 || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
2777 sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
drh895d7472004-08-20 16:02:39 +00002778 }
drh50457892003-09-06 01:10:47 +00002779 break;
2780 }
drh4e0cff62004-11-05 05:10:28 +00002781 case TK_REGISTER: {
drh9de221d2008-01-05 06:51:30 +00002782 inReg = pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00002783 break;
2784 }
drh487e2622005-06-25 18:42:14 +00002785#ifndef SQLITE_OMIT_CAST
2786 case TK_CAST: {
2787 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00002788 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00002789 if( inReg!=target ){
2790 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
2791 inReg = target;
2792 }
drh4169e432014-08-25 20:11:52 +00002793 sqlite3VdbeAddOp2(v, OP_Cast, target,
2794 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc5499be2008-04-01 15:06:33 +00002795 testcase( usedAsColumnCache(pParse, inReg, inReg) );
drhb3843a82008-04-01 12:24:11 +00002796 sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
drh487e2622005-06-25 18:42:14 +00002797 break;
2798 }
2799#endif /* SQLITE_OMIT_CAST */
drhc9b84a12002-06-20 11:36:48 +00002800 case TK_LT:
2801 case TK_LE:
2802 case TK_GT:
2803 case TK_GE:
2804 case TK_NE:
2805 case TK_EQ: {
drhb6da74e2009-12-24 16:00:28 +00002806 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2807 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00002808 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
2809 r1, r2, inReg, SQLITE_STOREP2);
drh7d176102014-02-18 03:07:12 +00002810 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
2811 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
2812 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
2813 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
2814 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
2815 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drhc5499be2008-04-01 15:06:33 +00002816 testcase( regFree1==0 );
2817 testcase( regFree2==0 );
danielk1977a37cdde2004-05-16 11:15:36 +00002818 break;
drhc9b84a12002-06-20 11:36:48 +00002819 }
drh6a2fe092009-09-23 02:29:36 +00002820 case TK_IS:
2821 case TK_ISNOT: {
2822 testcase( op==TK_IS );
2823 testcase( op==TK_ISNOT );
drhb6da74e2009-12-24 16:00:28 +00002824 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2825 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh6a2fe092009-09-23 02:29:36 +00002826 op = (op==TK_IS) ? TK_EQ : TK_NE;
2827 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
2828 r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
drh7d176102014-02-18 03:07:12 +00002829 VdbeCoverageIf(v, op==TK_EQ);
2830 VdbeCoverageIf(v, op==TK_NE);
drh6a2fe092009-09-23 02:29:36 +00002831 testcase( regFree1==0 );
2832 testcase( regFree2==0 );
2833 break;
2834 }
drhcce7d172000-05-31 15:34:51 +00002835 case TK_AND:
2836 case TK_OR:
2837 case TK_PLUS:
2838 case TK_STAR:
2839 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00002840 case TK_REM:
2841 case TK_BITAND:
2842 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00002843 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00002844 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00002845 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00002846 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00002847 assert( TK_AND==OP_And ); testcase( op==TK_AND );
2848 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
2849 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
2850 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
2851 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
2852 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
2853 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
2854 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
2855 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
2856 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
2857 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00002858 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2859 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00002860 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00002861 testcase( regFree1==0 );
2862 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00002863 break;
2864 }
drhcce7d172000-05-31 15:34:51 +00002865 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00002866 Expr *pLeft = pExpr->pLeft;
2867 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00002868 if( pLeft->op==TK_INTEGER ){
2869 codeInteger(pParse, pLeft, 1, target);
2870#ifndef SQLITE_OMIT_FLOATING_POINT
2871 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00002872 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2873 codeReal(v, pLeft->u.zToken, 1, target);
drh13573c72010-01-12 17:04:07 +00002874#endif
drh3c84ddf2008-01-09 02:15:38 +00002875 }else{
drh10d1edf2013-11-15 15:52:39 +00002876 tempX.op = TK_INTEGER;
2877 tempX.flags = EP_IntValue|EP_TokenOnly;
2878 tempX.u.iValue = 0;
2879 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00002880 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00002881 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00002882 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00002883 }
drh3c84ddf2008-01-09 02:15:38 +00002884 inReg = target;
2885 break;
drh6e142f52000-06-08 13:36:40 +00002886 }
drhbf4133c2001-10-13 02:59:08 +00002887 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00002888 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00002889 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
2890 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00002891 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2892 testcase( regFree1==0 );
2893 inReg = target;
2894 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00002895 break;
2896 }
2897 case TK_ISNULL:
2898 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00002899 int addr;
drh7d176102014-02-18 03:07:12 +00002900 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
2901 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00002902 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00002903 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00002904 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00002905 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00002906 VdbeCoverageIf(v, op==TK_ISNULL);
2907 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00002908 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00002909 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00002910 break;
drhcce7d172000-05-31 15:34:51 +00002911 }
drh22827922000-06-06 17:27:05 +00002912 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00002913 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00002914 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00002915 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2916 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00002917 }else{
drh9de221d2008-01-05 06:51:30 +00002918 inReg = pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00002919 }
drh22827922000-06-06 17:27:05 +00002920 break;
2921 }
drhcce7d172000-05-31 15:34:51 +00002922 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00002923 ExprList *pFarg; /* List of function arguments */
2924 int nFarg; /* Number of function arguments */
2925 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00002926 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00002927 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00002928 int i; /* Loop counter */
2929 u8 enc = ENC(db); /* The text encoding used by this database */
2930 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00002931
danielk19776ab3a2e2009-02-19 14:39:25 +00002932 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00002933 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00002934 pFarg = 0;
2935 }else{
2936 pFarg = pExpr->x.pList;
2937 }
2938 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00002939 assert( !ExprHasProperty(pExpr, EP_IntValue) );
2940 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00002941 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drh2d801512016-01-14 22:19:58 +00002942 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00002943 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00002944 break;
2945 }
drhae6bb952009-11-11 00:24:31 +00002946
2947 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00002948 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00002949 ** arguments past the first non-NULL argument.
2950 */
drhd36e1042013-09-06 13:10:12 +00002951 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhae6bb952009-11-11 00:24:31 +00002952 int endCoalesce = sqlite3VdbeMakeLabel(v);
2953 assert( nFarg>=2 );
2954 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2955 for(i=1; i<nFarg; i++){
2956 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00002957 VdbeCoverage(v);
drhf49f3522009-12-30 14:12:38 +00002958 sqlite3ExprCacheRemove(pParse, target, 1);
drhae6bb952009-11-11 00:24:31 +00002959 sqlite3ExprCachePush(pParse);
2960 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhd2490902014-04-13 19:28:15 +00002961 sqlite3ExprCachePop(pParse);
drhae6bb952009-11-11 00:24:31 +00002962 }
2963 sqlite3VdbeResolveLabel(v, endCoalesce);
2964 break;
2965 }
2966
drhcca9f3d2013-09-06 15:23:29 +00002967 /* The UNLIKELY() function is a no-op. The result is the value
2968 ** of the first argument.
2969 */
2970 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2971 assert( nFarg>=1 );
drh5f02ab02015-06-20 13:18:34 +00002972 inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00002973 break;
2974 }
drhae6bb952009-11-11 00:24:31 +00002975
drhd1a01ed2013-11-21 16:08:52 +00002976 for(i=0; i<nFarg; i++){
2977 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00002978 testcase( i==31 );
2979 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00002980 }
2981 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
2982 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2983 }
2984 }
drh12ffee82009-04-08 13:51:51 +00002985 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00002986 if( constMask ){
2987 r1 = pParse->nMem+1;
2988 pParse->nMem += nFarg;
2989 }else{
2990 r1 = sqlite3GetTempRange(pParse, nFarg);
2991 }
drha748fdc2012-03-28 01:34:47 +00002992
2993 /* For length() and typeof() functions with a column argument,
2994 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2995 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2996 ** loading.
2997 */
drhd36e1042013-09-06 13:10:12 +00002998 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00002999 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003000 assert( nFarg==1 );
3001 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003002 exprOp = pFarg->a[0].pExpr->op;
3003 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003004 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3005 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003006 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3007 pFarg->a[0].pExpr->op2 =
3008 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003009 }
3010 }
3011
drhd7d385d2009-09-03 01:18:00 +00003012 sqlite3ExprCachePush(pParse); /* Ticket 2ea2425d34be */
drh5579d592015-08-26 14:01:41 +00003013 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003014 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drhd2490902014-04-13 19:28:15 +00003015 sqlite3ExprCachePop(pParse); /* Ticket 2ea2425d34be */
drh892d3172008-01-10 03:46:36 +00003016 }else{
drh12ffee82009-04-08 13:51:51 +00003017 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003018 }
drhb7f6f682006-07-08 17:06:43 +00003019#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003020 /* Possibly overload the function if the first argument is
3021 ** a virtual table column.
3022 **
3023 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3024 ** second argument, not the first, as the argument to test to
3025 ** see if it is a column in a virtual table. This is done because
3026 ** the left operand of infix functions (the operand we want to
3027 ** control overloading) ends up as the second argument to the
3028 ** function. The expression "A glob B" is equivalent to
3029 ** "glob(B,A). We want to use the A in "A glob B" to test
3030 ** for function overloading. But we use the B term in "glob(B,A)".
3031 */
drh12ffee82009-04-08 13:51:51 +00003032 if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
3033 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3034 }else if( nFarg>0 ){
3035 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003036 }
3037#endif
drhd36e1042013-09-06 13:10:12 +00003038 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003039 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003040 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003041 }
drh9c7c9132015-06-26 18:16:52 +00003042 sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
drh66a51672008-01-03 00:01:23 +00003043 (char*)pDef, P4_FUNCDEF);
drh12ffee82009-04-08 13:51:51 +00003044 sqlite3VdbeChangeP5(v, (u8)nFarg);
drhd1a01ed2013-11-21 16:08:52 +00003045 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003046 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003047 }
drhcce7d172000-05-31 15:34:51 +00003048 break;
3049 }
drhfe2093d2005-01-20 22:48:47 +00003050#ifndef SQLITE_OMIT_SUBQUERY
3051 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003052 case TK_SELECT: {
drhc5499be2008-04-01 15:06:33 +00003053 testcase( op==TK_EXISTS );
3054 testcase( op==TK_SELECT );
drh1450bc62009-10-30 13:25:56 +00003055 inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
drh19a775c2000-06-05 18:54:46 +00003056 break;
3057 }
drhfef52082000-06-06 01:50:43 +00003058 case TK_IN: {
drhe3365e62009-11-12 17:52:24 +00003059 int destIfFalse = sqlite3VdbeMakeLabel(v);
3060 int destIfNull = sqlite3VdbeMakeLabel(v);
3061 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3062 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3063 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3064 sqlite3VdbeResolveLabel(v, destIfFalse);
3065 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3066 sqlite3VdbeResolveLabel(v, destIfNull);
drhfef52082000-06-06 01:50:43 +00003067 break;
3068 }
drhe3365e62009-11-12 17:52:24 +00003069#endif /* SQLITE_OMIT_SUBQUERY */
3070
3071
drh2dcef112008-01-12 19:03:48 +00003072 /*
3073 ** x BETWEEN y AND z
3074 **
3075 ** This is equivalent to
3076 **
3077 ** x>=y AND x<=z
3078 **
3079 ** X is stored in pExpr->pLeft.
3080 ** Y is stored in pExpr->pList->a[0].pExpr.
3081 ** Z is stored in pExpr->pList->a[1].pExpr.
3082 */
drhfef52082000-06-06 01:50:43 +00003083 case TK_BETWEEN: {
drhbe5c89a2004-07-26 00:31:09 +00003084 Expr *pLeft = pExpr->pLeft;
danielk19776ab3a2e2009-02-19 14:39:25 +00003085 struct ExprList_item *pLItem = pExpr->x.pList->a;
drhbe5c89a2004-07-26 00:31:09 +00003086 Expr *pRight = pLItem->pExpr;
drh35573352008-01-08 23:54:25 +00003087
drhb6da74e2009-12-24 16:00:28 +00003088 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3089 r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
drhc5499be2008-04-01 15:06:33 +00003090 testcase( regFree1==0 );
3091 testcase( regFree2==0 );
drh2dcef112008-01-12 19:03:48 +00003092 r3 = sqlite3GetTempReg(pParse);
drh678ccce2008-03-31 18:19:54 +00003093 r4 = sqlite3GetTempReg(pParse);
drh35573352008-01-08 23:54:25 +00003094 codeCompare(pParse, pLeft, pRight, OP_Ge,
drh7d176102014-02-18 03:07:12 +00003095 r1, r2, r3, SQLITE_STOREP2); VdbeCoverage(v);
drhbe5c89a2004-07-26 00:31:09 +00003096 pLItem++;
3097 pRight = pLItem->pExpr;
drh2dcef112008-01-12 19:03:48 +00003098 sqlite3ReleaseTempReg(pParse, regFree2);
3099 r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
drhc5499be2008-04-01 15:06:33 +00003100 testcase( regFree2==0 );
drh678ccce2008-03-31 18:19:54 +00003101 codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
drh688852a2014-02-17 22:40:43 +00003102 VdbeCoverage(v);
drh678ccce2008-03-31 18:19:54 +00003103 sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
drh2dcef112008-01-12 19:03:48 +00003104 sqlite3ReleaseTempReg(pParse, r3);
drh678ccce2008-03-31 18:19:54 +00003105 sqlite3ReleaseTempReg(pParse, r4);
drhfef52082000-06-06 01:50:43 +00003106 break;
3107 }
drh94fa9c42016-02-27 21:16:04 +00003108 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003109 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003110 case TK_UPLUS: {
drh2dcef112008-01-12 19:03:48 +00003111 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drha2e00042002-01-22 03:13:42 +00003112 break;
3113 }
drh2dcef112008-01-12 19:03:48 +00003114
dan165921a2009-08-28 18:53:45 +00003115 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003116 /* If the opcode is TK_TRIGGER, then the expression is a reference
3117 ** to a column in the new.* or old.* pseudo-tables available to
3118 ** trigger programs. In this case Expr.iTable is set to 1 for the
3119 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3120 ** is set to the column of the pseudo-table to read, or to -1 to
3121 ** read the rowid field.
3122 **
3123 ** The expression is implemented using an OP_Param opcode. The p1
3124 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3125 ** to reference another column of the old.* pseudo-table, where
3126 ** i is the index of the column. For a new.rowid reference, p1 is
3127 ** set to (n+1), where n is the number of columns in each pseudo-table.
3128 ** For a reference to any other column in the new.* pseudo-table, p1
3129 ** is set to (n+2+i), where n and i are as defined previously. For
3130 ** example, if the table on which triggers are being fired is
3131 ** declared as:
3132 **
3133 ** CREATE TABLE t1(a, b);
3134 **
3135 ** Then p1 is interpreted as follows:
3136 **
3137 ** p1==0 -> old.rowid p1==3 -> new.rowid
3138 ** p1==1 -> old.a p1==4 -> new.a
3139 ** p1==2 -> old.b p1==5 -> new.b
3140 */
dan2832ad42009-08-31 15:27:27 +00003141 Table *pTab = pExpr->pTab;
dan65a7cd12009-09-01 12:16:01 +00003142 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3143
3144 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3145 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3146 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3147 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3148
3149 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
dan2bd93512009-08-31 08:22:46 +00003150 VdbeComment((v, "%s.%s -> $%d",
3151 (pExpr->iTable ? "new" : "old"),
dan76d462e2009-08-30 11:42:51 +00003152 (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
dan2bd93512009-08-31 08:22:46 +00003153 target
dan165921a2009-08-28 18:53:45 +00003154 ));
dan65a7cd12009-09-01 12:16:01 +00003155
drh44dbca82010-01-13 04:22:20 +00003156#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003157 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003158 ** integer. Use OP_RealAffinity to make sure it is really real.
3159 **
3160 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3161 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003162 if( pExpr->iColumn>=0
3163 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3164 ){
3165 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3166 }
drh44dbca82010-01-13 04:22:20 +00003167#endif
dan165921a2009-08-28 18:53:45 +00003168 break;
3169 }
3170
3171
drh2dcef112008-01-12 19:03:48 +00003172 /*
3173 ** Form A:
3174 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3175 **
3176 ** Form B:
3177 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3178 **
3179 ** Form A is can be transformed into the equivalent form B as follows:
3180 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
3181 ** WHEN x=eN THEN rN ELSE y END
3182 **
3183 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00003184 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3185 ** odd. The Y is also optional. If the number of elements in x.pList
3186 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00003187 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
3188 **
3189 ** The result of the expression is the Ri for the first matching Ei,
3190 ** or if there is no matching Ei, the ELSE term Y, or if there is
3191 ** no ELSE term, NULL.
3192 */
drh33cd4902009-05-30 20:49:20 +00003193 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00003194 int endLabel; /* GOTO label for end of CASE stmt */
3195 int nextCase; /* GOTO label for next WHEN clause */
3196 int nExpr; /* 2x number of WHEN terms */
3197 int i; /* Loop counter */
3198 ExprList *pEList; /* List of WHEN terms */
3199 struct ExprList_item *aListelem; /* Array of WHEN terms */
3200 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00003201 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00003202 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drhceea3322009-04-23 13:22:42 +00003203 VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
drh17a7f8d2002-03-24 13:13:27 +00003204
danielk19776ab3a2e2009-02-19 14:39:25 +00003205 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00003206 assert(pExpr->x.pList->nExpr > 0);
3207 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00003208 aListelem = pEList->a;
3209 nExpr = pEList->nExpr;
drh2dcef112008-01-12 19:03:48 +00003210 endLabel = sqlite3VdbeMakeLabel(v);
3211 if( (pX = pExpr->pLeft)!=0 ){
drh10d1edf2013-11-15 15:52:39 +00003212 tempX = *pX;
drh33cd4902009-05-30 20:49:20 +00003213 testcase( pX->op==TK_COLUMN );
drh10d1edf2013-11-15 15:52:39 +00003214 exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00003215 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003216 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00003217 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00003218 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00003219 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
3220 ** The value in regFree1 might get SCopy-ed into the file result.
3221 ** So make sure that the regFree1 register is not reused for other
3222 ** purposes and possibly overwritten. */
3223 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00003224 }
drhc5cd1242013-09-12 16:50:49 +00003225 for(i=0; i<nExpr-1; i=i+2){
drhceea3322009-04-23 13:22:42 +00003226 sqlite3ExprCachePush(pParse);
drh2dcef112008-01-12 19:03:48 +00003227 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00003228 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00003229 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003230 }else{
drh2dcef112008-01-12 19:03:48 +00003231 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003232 }
drh2dcef112008-01-12 19:03:48 +00003233 nextCase = sqlite3VdbeMakeLabel(v);
drh33cd4902009-05-30 20:49:20 +00003234 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00003235 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00003236 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00003237 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00003238 sqlite3VdbeGoto(v, endLabel);
drhd2490902014-04-13 19:28:15 +00003239 sqlite3ExprCachePop(pParse);
drh2dcef112008-01-12 19:03:48 +00003240 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00003241 }
drhc5cd1242013-09-12 16:50:49 +00003242 if( (nExpr&1)!=0 ){
drhceea3322009-04-23 13:22:42 +00003243 sqlite3ExprCachePush(pParse);
drhc5cd1242013-09-12 16:50:49 +00003244 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drhd2490902014-04-13 19:28:15 +00003245 sqlite3ExprCachePop(pParse);
drh17a7f8d2002-03-24 13:13:27 +00003246 }else{
drh9de221d2008-01-05 06:51:30 +00003247 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00003248 }
danielk1977c1f4a192009-04-28 12:08:15 +00003249 assert( db->mallocFailed || pParse->nErr>0
3250 || pParse->iCacheLevel==iCacheLevel );
drh2dcef112008-01-12 19:03:48 +00003251 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00003252 break;
3253 }
danielk19775338a5f2005-01-20 13:03:10 +00003254#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00003255 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00003256 assert( pExpr->affinity==OE_Rollback
3257 || pExpr->affinity==OE_Abort
3258 || pExpr->affinity==OE_Fail
3259 || pExpr->affinity==OE_Ignore
3260 );
dane0af83a2009-09-08 19:15:01 +00003261 if( !pParse->pTriggerTab ){
3262 sqlite3ErrorMsg(pParse,
3263 "RAISE() may only be used within a trigger-program");
3264 return 0;
3265 }
3266 if( pExpr->affinity==OE_Abort ){
3267 sqlite3MayAbort(pParse);
3268 }
dan165921a2009-08-28 18:53:45 +00003269 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00003270 if( pExpr->affinity==OE_Ignore ){
3271 sqlite3VdbeAddOp4(
3272 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00003273 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00003274 }else{
drh433dccf2013-02-09 15:37:11 +00003275 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00003276 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00003277 }
3278
drhffe07b22005-11-03 00:41:17 +00003279 break;
drh17a7f8d2002-03-24 13:13:27 +00003280 }
danielk19775338a5f2005-01-20 13:03:10 +00003281#endif
drhffe07b22005-11-03 00:41:17 +00003282 }
drh2dcef112008-01-12 19:03:48 +00003283 sqlite3ReleaseTempReg(pParse, regFree1);
3284 sqlite3ReleaseTempReg(pParse, regFree2);
3285 return inReg;
3286}
3287
3288/*
drhd1a01ed2013-11-21 16:08:52 +00003289** Factor out the code of the given expression to initialization time.
3290*/
drhd673cdd2013-11-21 21:23:31 +00003291void sqlite3ExprCodeAtInit(
3292 Parse *pParse, /* Parsing context */
3293 Expr *pExpr, /* The expression to code when the VDBE initializes */
3294 int regDest, /* Store the value in this register */
3295 u8 reusable /* True if this expression is reusable */
3296){
drhd1a01ed2013-11-21 16:08:52 +00003297 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00003298 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00003299 p = pParse->pConstExpr;
3300 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3301 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00003302 if( p ){
3303 struct ExprList_item *pItem = &p->a[p->nExpr-1];
3304 pItem->u.iConstExprReg = regDest;
3305 pItem->reusable = reusable;
3306 }
drhd1a01ed2013-11-21 16:08:52 +00003307 pParse->pConstExpr = p;
3308}
3309
3310/*
drh2dcef112008-01-12 19:03:48 +00003311** Generate code to evaluate an expression and store the results
3312** into a register. Return the register number where the results
3313** are stored.
3314**
3315** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00003316** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00003317** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00003318**
3319** If pExpr is a constant, then this routine might generate this
3320** code to fill the register in the initialization section of the
3321** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00003322*/
3323int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00003324 int r2;
3325 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00003326 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00003327 && pExpr->op!=TK_REGISTER
3328 && sqlite3ExprIsConstantNotJoin(pExpr)
3329 ){
3330 ExprList *p = pParse->pConstExpr;
3331 int i;
3332 *pReg = 0;
3333 if( p ){
drhd673cdd2013-11-21 21:23:31 +00003334 struct ExprList_item *pItem;
3335 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3336 if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3337 return pItem->u.iConstExprReg;
drhf30a9692013-11-15 01:10:18 +00003338 }
3339 }
3340 }
drhf30a9692013-11-15 01:10:18 +00003341 r2 = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00003342 sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
drh2dcef112008-01-12 19:03:48 +00003343 }else{
drhf30a9692013-11-15 01:10:18 +00003344 int r1 = sqlite3GetTempReg(pParse);
3345 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
3346 if( r2==r1 ){
3347 *pReg = r1;
3348 }else{
3349 sqlite3ReleaseTempReg(pParse, r1);
3350 *pReg = 0;
3351 }
drh2dcef112008-01-12 19:03:48 +00003352 }
3353 return r2;
3354}
3355
3356/*
3357** Generate code that will evaluate expression pExpr and store the
3358** results in register target. The results are guaranteed to appear
3359** in register target.
3360*/
drh05a86c52014-02-16 01:55:49 +00003361void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00003362 int inReg;
3363
3364 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00003365 if( pExpr && pExpr->op==TK_REGISTER ){
3366 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3367 }else{
3368 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00003369 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00003370 if( inReg!=target && pParse->pVdbe ){
3371 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
3372 }
drhcce7d172000-05-31 15:34:51 +00003373 }
drhcce7d172000-05-31 15:34:51 +00003374}
3375
3376/*
drh1c75c9d2015-12-21 15:22:13 +00003377** Make a transient copy of expression pExpr and then code it using
3378** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
3379** except that the input expression is guaranteed to be unchanged.
3380*/
3381void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
3382 sqlite3 *db = pParse->db;
3383 pExpr = sqlite3ExprDup(db, pExpr, 0);
3384 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
3385 sqlite3ExprDelete(db, pExpr);
3386}
3387
3388/*
drh05a86c52014-02-16 01:55:49 +00003389** Generate code that will evaluate expression pExpr and store the
3390** results in register target. The results are guaranteed to appear
3391** in register target. If the expression is constant, then this routine
3392** might choose to code the expression at initialization time.
3393*/
3394void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
3395 if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
3396 sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
3397 }else{
3398 sqlite3ExprCode(pParse, pExpr, target);
3399 }
drhcce7d172000-05-31 15:34:51 +00003400}
3401
3402/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003403** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00003404** in register target.
drh25303782004-12-07 15:41:48 +00003405**
drh2dcef112008-01-12 19:03:48 +00003406** Also make a copy of the expression results into another "cache" register
3407** and modify the expression so that the next time it is evaluated,
3408** the result is a copy of the cache register.
3409**
3410** This routine is used for expressions that are used multiple
3411** times. They are evaluated once and the results of the expression
3412** are reused.
drh25303782004-12-07 15:41:48 +00003413*/
drh05a86c52014-02-16 01:55:49 +00003414void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00003415 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00003416 int iMem;
3417
drhde4fcfd2008-01-19 23:50:26 +00003418 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00003419 assert( pExpr->op!=TK_REGISTER );
3420 sqlite3ExprCode(pParse, pExpr, target);
3421 iMem = ++pParse->nMem;
3422 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3423 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00003424}
drh2dcef112008-01-12 19:03:48 +00003425
drh678ccce2008-03-31 18:19:54 +00003426/*
drh268380c2004-02-25 13:47:31 +00003427** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00003428** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00003429**
drh892d3172008-01-10 03:46:36 +00003430** Return the number of elements evaluated.
drhd1a01ed2013-11-21 16:08:52 +00003431**
3432** The SQLITE_ECEL_DUP flag prevents the arguments from being
3433** filled using OP_SCopy. OP_Copy must be used instead.
3434**
3435** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3436** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00003437**
3438** The SQLITE_ECEL_REF flag means that expressions in the list with
3439** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
3440** in registers at srcReg, and so the value can be copied from there.
drh268380c2004-02-25 13:47:31 +00003441*/
danielk19774adee202004-05-08 08:23:19 +00003442int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00003443 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00003444 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00003445 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00003446 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00003447 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00003448){
3449 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00003450 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00003451 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00003452 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00003453 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00003454 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00003455 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00003456 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00003457 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00003458 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00003459 Expr *pExpr = pItem->pExpr;
drh5579d592015-08-26 14:01:41 +00003460 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
3461 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
3462 }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
drhd673cdd2013-11-21 21:23:31 +00003463 sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
drhd1a01ed2013-11-21 16:08:52 +00003464 }else{
3465 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3466 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00003467 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00003468 if( copyOp==OP_Copy
3469 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
3470 && pOp->p1+pOp->p3+1==inReg
3471 && pOp->p2+pOp->p3+1==target+i
3472 ){
3473 pOp->p3++;
3474 }else{
3475 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
3476 }
drhd1a01ed2013-11-21 16:08:52 +00003477 }
drhd1766112008-09-17 00:13:12 +00003478 }
drh268380c2004-02-25 13:47:31 +00003479 }
drhf9b596e2004-05-26 16:54:42 +00003480 return n;
drh268380c2004-02-25 13:47:31 +00003481}
3482
3483/*
drh36c563a2009-11-12 13:32:22 +00003484** Generate code for a BETWEEN operator.
3485**
3486** x BETWEEN y AND z
3487**
3488** The above is equivalent to
3489**
3490** x>=y AND x<=z
3491**
3492** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00003493** elimination of x.
drh36c563a2009-11-12 13:32:22 +00003494*/
3495static void exprCodeBetween(
3496 Parse *pParse, /* Parsing and code generating context */
3497 Expr *pExpr, /* The BETWEEN expression */
3498 int dest, /* Jump here if the jump is taken */
3499 int jumpIfTrue, /* Take the jump if the BETWEEN is true */
3500 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
3501){
3502 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
3503 Expr compLeft; /* The x>=y term */
3504 Expr compRight; /* The x<=z term */
3505 Expr exprX; /* The x subexpression */
3506 int regFree1 = 0; /* Temporary use register */
3507
3508 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3509 exprX = *pExpr->pLeft;
3510 exprAnd.op = TK_AND;
3511 exprAnd.pLeft = &compLeft;
3512 exprAnd.pRight = &compRight;
3513 compLeft.op = TK_GE;
3514 compLeft.pLeft = &exprX;
3515 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
3516 compRight.op = TK_LE;
3517 compRight.pLeft = &exprX;
3518 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drha4c3c872013-09-12 17:29:25 +00003519 exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
drh36c563a2009-11-12 13:32:22 +00003520 if( jumpIfTrue ){
3521 sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
3522 }else{
3523 sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
3524 }
3525 sqlite3ReleaseTempReg(pParse, regFree1);
3526
3527 /* Ensure adequate test coverage */
3528 testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
3529 testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
3530 testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
3531 testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
3532 testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
3533 testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
3534 testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
3535 testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
3536}
3537
3538/*
drhcce7d172000-05-31 15:34:51 +00003539** Generate code for a boolean expression such that a jump is made
3540** to the label "dest" if the expression is true but execution
3541** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00003542**
3543** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00003544** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00003545**
3546** This code depends on the fact that certain token values (ex: TK_EQ)
3547** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3548** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
3549** the make process cause these values to align. Assert()s in the code
3550** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00003551*/
danielk19774adee202004-05-08 08:23:19 +00003552void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00003553 Vdbe *v = pParse->pVdbe;
3554 int op = 0;
drh2dcef112008-01-12 19:03:48 +00003555 int regFree1 = 0;
3556 int regFree2 = 0;
3557 int r1, r2;
3558
drh35573352008-01-08 23:54:25 +00003559 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00003560 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00003561 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00003562 op = pExpr->op;
3563 switch( op ){
drhcce7d172000-05-31 15:34:51 +00003564 case TK_AND: {
danielk19774adee202004-05-08 08:23:19 +00003565 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00003566 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00003567 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00003568 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003569 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3570 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00003571 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003572 break;
3573 }
3574 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00003575 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003576 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00003577 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003578 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00003579 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003580 break;
3581 }
3582 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00003583 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003584 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00003585 break;
3586 }
drhde845c22016-03-17 19:07:52 +00003587 case TK_IS:
3588 case TK_ISNOT:
3589 testcase( op==TK_IS );
3590 testcase( op==TK_ISNOT );
3591 op = (op==TK_IS) ? TK_EQ : TK_NE;
3592 jumpIfNull = SQLITE_NULLEQ;
3593 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00003594 case TK_LT:
3595 case TK_LE:
3596 case TK_GT:
3597 case TK_GE:
3598 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00003599 case TK_EQ: {
drhc5499be2008-04-01 15:06:33 +00003600 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00003601 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3602 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00003603 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00003604 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00003605 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3606 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3607 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3608 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00003609 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
3610 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
3611 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
3612 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
3613 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
3614 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00003615 testcase( regFree1==0 );
3616 testcase( regFree2==0 );
3617 break;
3618 }
drhcce7d172000-05-31 15:34:51 +00003619 case TK_ISNULL:
3620 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00003621 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3622 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00003623 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3624 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00003625 VdbeCoverageIf(v, op==TK_ISNULL);
3626 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00003627 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00003628 break;
3629 }
drhfef52082000-06-06 01:50:43 +00003630 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00003631 testcase( jumpIfNull==0 );
drh36c563a2009-11-12 13:32:22 +00003632 exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00003633 break;
3634 }
drh84e30ca2011-02-10 17:46:14 +00003635#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00003636 case TK_IN: {
3637 int destIfFalse = sqlite3VdbeMakeLabel(v);
3638 int destIfNull = jumpIfNull ? dest : destIfFalse;
3639 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00003640 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00003641 sqlite3VdbeResolveLabel(v, destIfFalse);
3642 break;
3643 }
shanehbb201342011-02-09 19:55:20 +00003644#endif
drhcce7d172000-05-31 15:34:51 +00003645 default: {
drh991a1982014-01-02 17:57:16 +00003646 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00003647 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00003648 }else if( exprAlwaysFalse(pExpr) ){
3649 /* No-op */
3650 }else{
3651 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
3652 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00003653 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00003654 testcase( regFree1==0 );
3655 testcase( jumpIfNull==0 );
3656 }
drhcce7d172000-05-31 15:34:51 +00003657 break;
3658 }
3659 }
drh2dcef112008-01-12 19:03:48 +00003660 sqlite3ReleaseTempReg(pParse, regFree1);
3661 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00003662}
3663
3664/*
drh66b89c82000-11-28 20:47:17 +00003665** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00003666** to the label "dest" if the expression is false but execution
3667** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00003668**
3669** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00003670** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
3671** is 0.
drhcce7d172000-05-31 15:34:51 +00003672*/
danielk19774adee202004-05-08 08:23:19 +00003673void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00003674 Vdbe *v = pParse->pVdbe;
3675 int op = 0;
drh2dcef112008-01-12 19:03:48 +00003676 int regFree1 = 0;
3677 int regFree2 = 0;
3678 int r1, r2;
3679
drh35573352008-01-08 23:54:25 +00003680 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00003681 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00003682 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00003683
3684 /* The value of pExpr->op and op are related as follows:
3685 **
3686 ** pExpr->op op
3687 ** --------- ----------
3688 ** TK_ISNULL OP_NotNull
3689 ** TK_NOTNULL OP_IsNull
3690 ** TK_NE OP_Eq
3691 ** TK_EQ OP_Ne
3692 ** TK_GT OP_Le
3693 ** TK_LE OP_Gt
3694 ** TK_GE OP_Lt
3695 ** TK_LT OP_Ge
3696 **
3697 ** For other values of pExpr->op, op is undefined and unused.
3698 ** The value of TK_ and OP_ constants are arranged such that we
3699 ** can compute the mapping above using the following expression.
3700 ** Assert()s verify that the computation is correct.
3701 */
3702 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3703
3704 /* Verify correct alignment of TK_ and OP_ constants
3705 */
3706 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3707 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3708 assert( pExpr->op!=TK_NE || op==OP_Eq );
3709 assert( pExpr->op!=TK_EQ || op==OP_Ne );
3710 assert( pExpr->op!=TK_LT || op==OP_Ge );
3711 assert( pExpr->op!=TK_LE || op==OP_Gt );
3712 assert( pExpr->op!=TK_GT || op==OP_Le );
3713 assert( pExpr->op!=TK_GE || op==OP_Lt );
3714
drhcce7d172000-05-31 15:34:51 +00003715 switch( pExpr->op ){
3716 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00003717 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003718 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00003719 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003720 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00003721 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003722 break;
3723 }
3724 case TK_OR: {
danielk19774adee202004-05-08 08:23:19 +00003725 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00003726 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00003727 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00003728 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00003729 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3730 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00003731 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00003732 break;
3733 }
3734 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00003735 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00003736 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00003737 break;
3738 }
drhde845c22016-03-17 19:07:52 +00003739 case TK_IS:
3740 case TK_ISNOT:
3741 testcase( pExpr->op==TK_IS );
3742 testcase( pExpr->op==TK_ISNOT );
3743 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
3744 jumpIfNull = SQLITE_NULLEQ;
3745 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00003746 case TK_LT:
3747 case TK_LE:
3748 case TK_GT:
3749 case TK_GE:
3750 case TK_NE:
3751 case TK_EQ: {
drhc5499be2008-04-01 15:06:33 +00003752 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00003753 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3754 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00003755 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00003756 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00003757 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3758 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3759 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3760 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00003761 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
3762 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
3763 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
3764 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
3765 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
3766 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00003767 testcase( regFree1==0 );
3768 testcase( regFree2==0 );
3769 break;
3770 }
drhcce7d172000-05-31 15:34:51 +00003771 case TK_ISNULL:
3772 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00003773 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3774 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00003775 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
3776 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00003777 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00003778 break;
3779 }
drhfef52082000-06-06 01:50:43 +00003780 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00003781 testcase( jumpIfNull==0 );
drh36c563a2009-11-12 13:32:22 +00003782 exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00003783 break;
3784 }
drh84e30ca2011-02-10 17:46:14 +00003785#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00003786 case TK_IN: {
3787 if( jumpIfNull ){
3788 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3789 }else{
3790 int destIfNull = sqlite3VdbeMakeLabel(v);
3791 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3792 sqlite3VdbeResolveLabel(v, destIfNull);
3793 }
3794 break;
3795 }
shanehbb201342011-02-09 19:55:20 +00003796#endif
drhcce7d172000-05-31 15:34:51 +00003797 default: {
drh991a1982014-01-02 17:57:16 +00003798 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00003799 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00003800 }else if( exprAlwaysTrue(pExpr) ){
3801 /* no-op */
3802 }else{
3803 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
3804 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00003805 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00003806 testcase( regFree1==0 );
3807 testcase( jumpIfNull==0 );
3808 }
drhcce7d172000-05-31 15:34:51 +00003809 break;
3810 }
3811 }
drh2dcef112008-01-12 19:03:48 +00003812 sqlite3ReleaseTempReg(pParse, regFree1);
3813 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00003814}
drh22827922000-06-06 17:27:05 +00003815
3816/*
drh72bc8202015-06-11 13:58:35 +00003817** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
3818** code generation, and that copy is deleted after code generation. This
3819** ensures that the original pExpr is unchanged.
3820*/
3821void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
3822 sqlite3 *db = pParse->db;
3823 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
3824 if( db->mallocFailed==0 ){
3825 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
3826 }
3827 sqlite3ExprDelete(db, pCopy);
3828}
3829
3830
3831/*
drh1d9da702010-01-07 15:17:02 +00003832** Do a deep comparison of two expression trees. Return 0 if the two
3833** expressions are completely identical. Return 1 if they differ only
3834** by a COLLATE operator at the top level. Return 2 if there are differences
3835** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00003836**
drh619a1302013-08-01 13:04:46 +00003837** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3838** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3839**
drh66518ca2013-08-01 15:09:57 +00003840** The pA side might be using TK_REGISTER. If that is the case and pB is
3841** not using TK_REGISTER but is otherwise equivalent, then still return 0.
3842**
drh1d9da702010-01-07 15:17:02 +00003843** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00003844** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00003845** identical, we return 2 just to be safe. So if this routine
3846** returns 2, then you do not really know for certain if the two
3847** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00003848** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00003849** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00003850** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00003851** an incorrect 0 or 1 could lead to a malfunction.
drh22827922000-06-06 17:27:05 +00003852*/
drh619a1302013-08-01 13:04:46 +00003853int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00003854 u32 combinedFlags;
3855 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00003856 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00003857 }
drh10d1edf2013-11-15 15:52:39 +00003858 combinedFlags = pA->flags | pB->flags;
3859 if( combinedFlags & EP_IntValue ){
3860 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
3861 return 0;
3862 }
drh1d9da702010-01-07 15:17:02 +00003863 return 2;
drh22827922000-06-06 17:27:05 +00003864 }
drhc2acc4e2013-11-15 18:15:19 +00003865 if( pA->op!=pB->op ){
drh619a1302013-08-01 13:04:46 +00003866 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00003867 return 1;
3868 }
drh619a1302013-08-01 13:04:46 +00003869 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00003870 return 1;
3871 }
3872 return 2;
3873 }
drh2edc5fd2015-11-24 02:10:52 +00003874 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00003875 if( pA->op==TK_FUNCTION ){
3876 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
3877 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhae80dde2012-12-06 21:16:43 +00003878 return pA->op==TK_COLLATE ? 1 : 2;
drh2646da72005-12-09 20:02:05 +00003879 }
drh22827922000-06-06 17:27:05 +00003880 }
drh10d1edf2013-11-15 15:52:39 +00003881 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh85f8aa72013-11-15 20:06:26 +00003882 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00003883 if( combinedFlags & EP_xIsSelect ) return 2;
3884 if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3885 if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3886 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh7693c422015-04-17 19:41:37 +00003887 if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
drh10d1edf2013-11-15 15:52:39 +00003888 if( pA->iColumn!=pB->iColumn ) return 2;
3889 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00003890 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00003891 }
3892 }
drh1d9da702010-01-07 15:17:02 +00003893 return 0;
drh22827922000-06-06 17:27:05 +00003894}
3895
drh8c6f6662010-04-26 19:17:26 +00003896/*
3897** Compare two ExprList objects. Return 0 if they are identical and
3898** non-zero if they differ in any way.
3899**
drh619a1302013-08-01 13:04:46 +00003900** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3901** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3902**
drh8c6f6662010-04-26 19:17:26 +00003903** This routine might return non-zero for equivalent ExprLists. The
3904** only consequence will be disabled optimizations. But this routine
3905** must never return 0 if the two ExprList objects are different, or
3906** a malfunction will result.
3907**
3908** Two NULL pointers are considered to be the same. But a NULL pointer
3909** always differs from a non-NULL pointer.
3910*/
drh619a1302013-08-01 13:04:46 +00003911int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00003912 int i;
3913 if( pA==0 && pB==0 ) return 0;
3914 if( pA==0 || pB==0 ) return 1;
3915 if( pA->nExpr!=pB->nExpr ) return 1;
3916 for(i=0; i<pA->nExpr; i++){
3917 Expr *pExprA = pA->a[i].pExpr;
3918 Expr *pExprB = pB->a[i].pExpr;
3919 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
drh619a1302013-08-01 13:04:46 +00003920 if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00003921 }
3922 return 0;
3923}
drh13449892005-09-07 21:22:45 +00003924
drh22827922000-06-06 17:27:05 +00003925/*
drh4bd5f732013-07-31 23:22:39 +00003926** Return true if we can prove the pE2 will always be true if pE1 is
3927** true. Return false if we cannot complete the proof or if pE2 might
3928** be false. Examples:
3929**
drh619a1302013-08-01 13:04:46 +00003930** pE1: x==5 pE2: x==5 Result: true
3931** pE1: x>0 pE2: x==5 Result: false
3932** pE1: x=21 pE2: x=21 OR y=43 Result: true
3933** pE1: x!=123 pE2: x IS NOT NULL Result: true
3934** pE1: x!=?1 pE2: x IS NOT NULL Result: true
3935** pE1: x IS NULL pE2: x IS NOT NULL Result: false
3936** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00003937**
3938** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
3939** Expr.iTable<0 then assume a table number given by iTab.
3940**
3941** When in doubt, return false. Returning true might give a performance
3942** improvement. Returning false might cause a performance reduction, but
3943** it will always give the correct answer and is hence always safe.
3944*/
3945int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
drh619a1302013-08-01 13:04:46 +00003946 if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3947 return 1;
3948 }
3949 if( pE2->op==TK_OR
3950 && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3951 || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3952 ){
3953 return 1;
3954 }
3955 if( pE2->op==TK_NOTNULL
3956 && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3957 && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3958 ){
3959 return 1;
3960 }
3961 return 0;
drh4bd5f732013-07-31 23:22:39 +00003962}
3963
3964/*
drh030796d2012-08-23 16:18:10 +00003965** An instance of the following structure is used by the tree walker
3966** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00003967** aggregate function, in order to implement the
3968** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00003969*/
drh030796d2012-08-23 16:18:10 +00003970struct SrcCount {
3971 SrcList *pSrc; /* One particular FROM clause in a nested query */
3972 int nThis; /* Number of references to columns in pSrcList */
3973 int nOther; /* Number of references to columns in other FROM clauses */
3974};
3975
3976/*
3977** Count the number of references to columns.
3978*/
3979static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00003980 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3981 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3982 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
3983 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3984 ** NEVER() will need to be removed. */
3985 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00003986 int i;
drh030796d2012-08-23 16:18:10 +00003987 struct SrcCount *p = pWalker->u.pSrcCount;
3988 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00003989 int nSrc = pSrc ? pSrc->nSrc : 0;
3990 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00003991 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00003992 }
drh655814d2015-01-09 01:27:29 +00003993 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00003994 p->nThis++;
3995 }else{
3996 p->nOther++;
3997 }
drh374fdce2012-04-17 16:38:53 +00003998 }
drh030796d2012-08-23 16:18:10 +00003999 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00004000}
4001
4002/*
drh030796d2012-08-23 16:18:10 +00004003** Determine if any of the arguments to the pExpr Function reference
4004** pSrcList. Return true if they do. Also return true if the function
4005** has no arguments or has only constant arguments. Return false if pExpr
4006** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00004007*/
drh030796d2012-08-23 16:18:10 +00004008int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00004009 Walker w;
drh030796d2012-08-23 16:18:10 +00004010 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00004011 assert( pExpr->op==TK_AGG_FUNCTION );
4012 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00004013 w.xExprCallback = exprSrcCount;
4014 w.u.pSrcCount = &cnt;
4015 cnt.pSrc = pSrcList;
4016 cnt.nThis = 0;
4017 cnt.nOther = 0;
4018 sqlite3WalkExprList(&w, pExpr->x.pList);
4019 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00004020}
4021
4022/*
drh13449892005-09-07 21:22:45 +00004023** Add a new element to the pAggInfo->aCol[] array. Return the index of
4024** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00004025*/
drh17435752007-08-16 04:30:38 +00004026static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00004027 int i;
drhcf643722007-03-27 13:36:37 +00004028 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00004029 db,
drhcf643722007-03-27 13:36:37 +00004030 pInfo->aCol,
4031 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00004032 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00004033 &i
4034 );
drh13449892005-09-07 21:22:45 +00004035 return i;
4036}
4037
4038/*
4039** Add a new element to the pAggInfo->aFunc[] array. Return the index of
4040** the new element. Return a negative number if malloc fails.
4041*/
drh17435752007-08-16 04:30:38 +00004042static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00004043 int i;
drhcf643722007-03-27 13:36:37 +00004044 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00004045 db,
drhcf643722007-03-27 13:36:37 +00004046 pInfo->aFunc,
4047 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00004048 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00004049 &i
4050 );
drh13449892005-09-07 21:22:45 +00004051 return i;
4052}
drh22827922000-06-06 17:27:05 +00004053
4054/*
drh7d10d5a2008-08-20 16:35:10 +00004055** This is the xExprCallback for a tree walker. It is used to
4056** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00004057** for additional information.
drh22827922000-06-06 17:27:05 +00004058*/
drh7d10d5a2008-08-20 16:35:10 +00004059static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00004060 int i;
drh7d10d5a2008-08-20 16:35:10 +00004061 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00004062 Parse *pParse = pNC->pParse;
4063 SrcList *pSrcList = pNC->pSrcList;
drh13449892005-09-07 21:22:45 +00004064 AggInfo *pAggInfo = pNC->pAggInfo;
drh22827922000-06-06 17:27:05 +00004065
drh22827922000-06-06 17:27:05 +00004066 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00004067 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00004068 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00004069 testcase( pExpr->op==TK_AGG_COLUMN );
4070 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00004071 /* Check to see if the column is in one of the tables in the FROM
4072 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00004073 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00004074 struct SrcList_item *pItem = pSrcList->a;
4075 for(i=0; i<pSrcList->nSrc; i++, pItem++){
4076 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00004077 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00004078 if( pExpr->iTable==pItem->iCursor ){
4079 /* If we reach this point, it means that pExpr refers to a table
4080 ** that is in the FROM clause of the aggregate query.
4081 **
4082 ** Make an entry for the column in pAggInfo->aCol[] if there
4083 ** is not an entry there already.
4084 */
drh7f906d62007-03-12 23:48:52 +00004085 int k;
drh13449892005-09-07 21:22:45 +00004086 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00004087 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00004088 if( pCol->iTable==pExpr->iTable &&
4089 pCol->iColumn==pExpr->iColumn ){
4090 break;
4091 }
danielk1977a58fdfb2005-02-08 07:50:40 +00004092 }
danielk19771e536952007-08-16 10:09:01 +00004093 if( (k>=pAggInfo->nColumn)
4094 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
4095 ){
drh7f906d62007-03-12 23:48:52 +00004096 pCol = &pAggInfo->aCol[k];
danielk19770817d0d2007-02-14 09:19:36 +00004097 pCol->pTab = pExpr->pTab;
drh13449892005-09-07 21:22:45 +00004098 pCol->iTable = pExpr->iTable;
4099 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00004100 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00004101 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00004102 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00004103 if( pAggInfo->pGroupBy ){
4104 int j, n;
4105 ExprList *pGB = pAggInfo->pGroupBy;
4106 struct ExprList_item *pTerm = pGB->a;
4107 n = pGB->nExpr;
4108 for(j=0; j<n; j++, pTerm++){
4109 Expr *pE = pTerm->pExpr;
4110 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
4111 pE->iColumn==pExpr->iColumn ){
4112 pCol->iSorterColumn = j;
4113 break;
4114 }
4115 }
4116 }
4117 if( pCol->iSorterColumn<0 ){
4118 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
4119 }
4120 }
4121 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
4122 ** because it was there before or because we just created it).
4123 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
4124 ** pAggInfo->aCol[] entry.
4125 */
drhebb6a652013-09-12 23:42:22 +00004126 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00004127 pExpr->pAggInfo = pAggInfo;
4128 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00004129 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00004130 break;
4131 } /* endif pExpr->iTable==pItem->iCursor */
4132 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00004133 }
drh7d10d5a2008-08-20 16:35:10 +00004134 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00004135 }
4136 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00004137 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00004138 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00004139 ){
drh13449892005-09-07 21:22:45 +00004140 /* Check to see if pExpr is a duplicate of another aggregate
4141 ** function that is already in the pAggInfo structure
4142 */
4143 struct AggInfo_func *pItem = pAggInfo->aFunc;
4144 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh619a1302013-08-01 13:04:46 +00004145 if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00004146 break;
4147 }
drh22827922000-06-06 17:27:05 +00004148 }
drh13449892005-09-07 21:22:45 +00004149 if( i>=pAggInfo->nFunc ){
4150 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
4151 */
danielk197714db2662006-01-09 16:12:04 +00004152 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00004153 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00004154 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00004155 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00004156 pItem = &pAggInfo->aFunc[i];
4157 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00004158 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00004159 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00004160 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00004161 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00004162 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00004163 if( pExpr->flags & EP_Distinct ){
4164 pItem->iDistinct = pParse->nTab++;
4165 }else{
4166 pItem->iDistinct = -1;
4167 }
drh13449892005-09-07 21:22:45 +00004168 }
danielk1977a58fdfb2005-02-08 07:50:40 +00004169 }
drh13449892005-09-07 21:22:45 +00004170 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
4171 */
drhc5cd1242013-09-12 16:50:49 +00004172 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00004173 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00004174 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00004175 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00004176 return WRC_Prune;
4177 }else{
4178 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00004179 }
drh22827922000-06-06 17:27:05 +00004180 }
4181 }
drh7d10d5a2008-08-20 16:35:10 +00004182 return WRC_Continue;
4183}
4184static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00004185 UNUSED_PARAMETER(pWalker);
4186 UNUSED_PARAMETER(pSelect);
drh374fdce2012-04-17 16:38:53 +00004187 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00004188}
4189
4190/*
drhe8abb4c2012-11-02 18:24:57 +00004191** Analyze the pExpr expression looking for aggregate functions and
4192** for variables that need to be added to AggInfo object that pNC->pAggInfo
4193** points to. Additional entries are made on the AggInfo object as
4194** necessary.
drh626a8792005-01-17 22:08:19 +00004195**
4196** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00004197** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00004198*/
drhd2b3e232008-01-23 14:51:49 +00004199void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00004200 Walker w;
drh374fdce2012-04-17 16:38:53 +00004201 memset(&w, 0, sizeof(w));
drh7d10d5a2008-08-20 16:35:10 +00004202 w.xExprCallback = analyzeAggregate;
4203 w.xSelectCallback = analyzeAggregatesInSelect;
4204 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00004205 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00004206 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00004207}
drh5d9a4af2005-08-30 00:54:01 +00004208
4209/*
4210** Call sqlite3ExprAnalyzeAggregates() for every expression in an
4211** expression list. Return the number of errors.
4212**
4213** If an error is found, the analysis is cut short.
4214*/
drhd2b3e232008-01-23 14:51:49 +00004215void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00004216 struct ExprList_item *pItem;
4217 int i;
drh5d9a4af2005-08-30 00:54:01 +00004218 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00004219 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4220 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00004221 }
4222 }
drh5d9a4af2005-08-30 00:54:01 +00004223}
drh892d3172008-01-10 03:46:36 +00004224
4225/*
drhceea3322009-04-23 13:22:42 +00004226** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00004227*/
4228int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00004229 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00004230 return ++pParse->nMem;
4231 }
danielk19772f425f62008-07-04 09:41:39 +00004232 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00004233}
drhceea3322009-04-23 13:22:42 +00004234
4235/*
4236** Deallocate a register, making available for reuse for some other
4237** purpose.
4238**
4239** If a register is currently being used by the column cache, then
peter.d.reid60ec9142014-09-06 16:39:46 +00004240** the deallocation is deferred until the column cache line that uses
drhceea3322009-04-23 13:22:42 +00004241** the register becomes stale.
4242*/
drh892d3172008-01-10 03:46:36 +00004243void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00004244 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drhceea3322009-04-23 13:22:42 +00004245 int i;
4246 struct yColCache *p;
4247 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4248 if( p->iReg==iReg ){
4249 p->tempReg = 1;
4250 return;
4251 }
4252 }
drh892d3172008-01-10 03:46:36 +00004253 pParse->aTempReg[pParse->nTempReg++] = iReg;
4254 }
4255}
4256
4257/*
4258** Allocate or deallocate a block of nReg consecutive registers
4259*/
4260int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00004261 int i, n;
4262 i = pParse->iRangeReg;
4263 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00004264 if( nReg<=n ){
4265 assert( !usedAsColumnCache(pParse, i, i+n-1) );
drh892d3172008-01-10 03:46:36 +00004266 pParse->iRangeReg += nReg;
4267 pParse->nRangeReg -= nReg;
4268 }else{
4269 i = pParse->nMem+1;
4270 pParse->nMem += nReg;
4271 }
4272 return i;
4273}
4274void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhf49f3522009-12-30 14:12:38 +00004275 sqlite3ExprCacheRemove(pParse, iReg, nReg);
drh892d3172008-01-10 03:46:36 +00004276 if( nReg>pParse->nRangeReg ){
4277 pParse->nRangeReg = nReg;
4278 pParse->iRangeReg = iReg;
4279 }
4280}
drhcdc69552011-12-06 13:24:59 +00004281
4282/*
4283** Mark all temporary registers as being unavailable for reuse.
4284*/
4285void sqlite3ClearTempRegCache(Parse *pParse){
4286 pParse->nTempReg = 0;
4287 pParse->nRangeReg = 0;
4288}
drhbb9b5f22016-03-19 00:35:02 +00004289
4290/*
4291** Validate that no temporary register falls within the range of
4292** iFirst..iLast, inclusive. This routine is only call from within assert()
4293** statements.
4294*/
4295#ifdef SQLITE_DEBUG
4296int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
4297 int i;
4298 if( pParse->nRangeReg>0
4299 && pParse->iRangeReg+pParse->nRangeReg<iLast
4300 && pParse->iRangeReg>=iFirst
4301 ){
4302 return 0;
4303 }
4304 for(i=0; i<pParse->nTempReg; i++){
4305 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
4306 return 0;
4307 }
4308 }
4309 return 1;
4310}
4311#endif /* SQLITE_DEBUG */