1 /* 2 ** 2018 May 08 3 ** 4 ** The author disclaims copyright to this source code. In place of 5 ** a legal notice, here is a blessing: 6 ** 7 ** May you do good and not evil. 8 ** May you find forgiveness for yourself and forgive others. 9 ** May you share freely, never taking more than you give. 10 ** 11 ************************************************************************* 12 */ 13 #include "sqliteInt.h" 14 15 #ifndef SQLITE_OMIT_WINDOWFUNC 16 17 /* 18 ** SELECT REWRITING 19 ** 20 ** Any SELECT statement that contains one or more window functions in 21 ** either the select list or ORDER BY clause (the only two places window 22 ** functions may be used) is transformed by function sqlite3WindowRewrite() 23 ** in order to support window function processing. For example, with the 24 ** schema: 25 ** 26 ** CREATE TABLE t1(a, b, c, d, e, f, g); 27 ** 28 ** the statement: 29 ** 30 ** SELECT a+1, max(b) OVER (PARTITION BY c ORDER BY d) FROM t1 ORDER BY e; 31 ** 32 ** is transformed to: 33 ** 34 ** SELECT a+1, max(b) OVER (PARTITION BY c ORDER BY d) FROM ( 35 ** SELECT a, e, c, d, b FROM t1 ORDER BY c, d 36 ** ) ORDER BY e; 37 ** 38 ** The flattening optimization is disabled when processing this transformed 39 ** SELECT statement. This allows the implementation of the window function 40 ** (in this case max()) to process rows sorted in order of (c, d), which 41 ** makes things easier for obvious reasons. More generally: 42 ** 43 ** * FROM, WHERE, GROUP BY and HAVING clauses are all moved to 44 ** the sub-query. 45 ** 46 ** * ORDER BY, LIMIT and OFFSET remain part of the parent query. 47 ** 48 ** * Terminals from each of the expression trees that make up the 49 ** select-list and ORDER BY expressions in the parent query are 50 ** selected by the sub-query. For the purposes of the transformation, 51 ** terminals are column references and aggregate functions. 52 ** 53 ** If there is more than one window function in the SELECT that uses 54 ** the same window declaration (the OVER bit), then a single scan may 55 ** be used to process more than one window function. For example: 56 ** 57 ** SELECT max(b) OVER (PARTITION BY c ORDER BY d), 58 ** min(e) OVER (PARTITION BY c ORDER BY d) 59 ** FROM t1; 60 ** 61 ** is transformed in the same way as the example above. However: 62 ** 63 ** SELECT max(b) OVER (PARTITION BY c ORDER BY d), 64 ** min(e) OVER (PARTITION BY a ORDER BY b) 65 ** FROM t1; 66 ** 67 ** Must be transformed to: 68 ** 69 ** SELECT max(b) OVER (PARTITION BY c ORDER BY d) FROM ( 70 ** SELECT e, min(e) OVER (PARTITION BY a ORDER BY b), c, d, b FROM 71 ** SELECT a, e, c, d, b FROM t1 ORDER BY a, b 72 ** ) ORDER BY c, d 73 ** ) ORDER BY e; 74 ** 75 ** so that both min() and max() may process rows in the order defined by 76 ** their respective window declarations. 77 ** 78 ** INTERFACE WITH SELECT.C 79 ** 80 ** When processing the rewritten SELECT statement, code in select.c calls 81 ** sqlite3WhereBegin() to begin iterating through the results of the 82 ** sub-query, which is always implemented as a co-routine. It then calls 83 ** sqlite3WindowCodeStep() to process rows and finish the scan by calling 84 ** sqlite3WhereEnd(). 85 ** 86 ** sqlite3WindowCodeStep() generates VM code so that, for each row returned 87 ** by the sub-query a sub-routine (OP_Gosub) coded by select.c is invoked. 88 ** When the sub-routine is invoked: 89 ** 90 ** * The results of all window-functions for the row are stored 91 ** in the associated Window.regResult registers. 92 ** 93 ** * The required terminal values are stored in the current row of 94 ** temp table Window.iEphCsr. 95 ** 96 ** In some cases, depending on the window frame and the specific window 97 ** functions invoked, sqlite3WindowCodeStep() caches each entire partition 98 ** in a temp table before returning any rows. In other cases it does not. 99 ** This detail is encapsulated within this file, the code generated by 100 ** select.c is the same in either case. 101 ** 102 ** BUILT-IN WINDOW FUNCTIONS 103 ** 104 ** This implementation features the following built-in window functions: 105 ** 106 ** row_number() 107 ** rank() 108 ** dense_rank() 109 ** percent_rank() 110 ** cume_dist() 111 ** ntile(N) 112 ** lead(expr [, offset [, default]]) 113 ** lag(expr [, offset [, default]]) 114 ** first_value(expr) 115 ** last_value(expr) 116 ** nth_value(expr, N) 117 ** 118 ** These are the same built-in window functions supported by Postgres. 119 ** Although the behaviour of aggregate window functions (functions that 120 ** can be used as either aggregates or window funtions) allows them to 121 ** be implemented using an API, built-in window functions are much more 122 ** esoteric. Additionally, some window functions (e.g. nth_value()) 123 ** may only be implemented by caching the entire partition in memory. 124 ** As such, some built-in window functions use the same API as aggregate 125 ** window functions and some are implemented directly using VDBE 126 ** instructions. Additionally, for those functions that use the API, the 127 ** window frame is sometimes modified before the SELECT statement is 128 ** rewritten. For example, regardless of the specified window frame, the 129 ** row_number() function always uses: 130 ** 131 ** ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW 132 ** 133 ** See sqlite3WindowUpdate() for details. 134 ** 135 ** As well as some of the built-in window functions, aggregate window 136 ** functions min() and max() are implemented using VDBE instructions if 137 ** the start of the window frame is declared as anything other than 138 ** UNBOUNDED PRECEDING. 139 */ 140 141 /* 142 ** Implementation of built-in window function row_number(). Assumes that the 143 ** window frame has been coerced to: 144 ** 145 ** ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW 146 */ 147 static void row_numberStepFunc( 148 sqlite3_context *pCtx, 149 int nArg, 150 sqlite3_value **apArg 151 ){ 152 i64 *p = (i64*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 153 if( p ) (*p)++; 154 UNUSED_PARAMETER(nArg); 155 UNUSED_PARAMETER(apArg); 156 } 157 static void row_numberValueFunc(sqlite3_context *pCtx){ 158 i64 *p = (i64*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 159 sqlite3_result_int64(pCtx, (p ? *p : 0)); 160 } 161 162 /* 163 ** Context object type used by rank(), dense_rank(), percent_rank() and 164 ** cume_dist(). 165 */ 166 struct CallCount { 167 i64 nValue; 168 i64 nStep; 169 i64 nTotal; 170 }; 171 172 /* 173 ** Implementation of built-in window function dense_rank(). Assumes that 174 ** the window frame has been set to: 175 ** 176 ** RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW 177 */ 178 static void dense_rankStepFunc( 179 sqlite3_context *pCtx, 180 int nArg, 181 sqlite3_value **apArg 182 ){ 183 struct CallCount *p; 184 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 185 if( p ) p->nStep = 1; 186 UNUSED_PARAMETER(nArg); 187 UNUSED_PARAMETER(apArg); 188 } 189 static void dense_rankValueFunc(sqlite3_context *pCtx){ 190 struct CallCount *p; 191 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 192 if( p ){ 193 if( p->nStep ){ 194 p->nValue++; 195 p->nStep = 0; 196 } 197 sqlite3_result_int64(pCtx, p->nValue); 198 } 199 } 200 201 /* 202 ** Implementation of built-in window function nth_value(). This 203 ** implementation is used in "slow mode" only - when the EXCLUDE clause 204 ** is not set to the default value "NO OTHERS". 205 */ 206 struct NthValueCtx { 207 i64 nStep; 208 sqlite3_value *pValue; 209 }; 210 static void nth_valueStepFunc( 211 sqlite3_context *pCtx, 212 int nArg, 213 sqlite3_value **apArg 214 ){ 215 struct NthValueCtx *p; 216 p = (struct NthValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 217 if( p ){ 218 i64 iVal; 219 switch( sqlite3_value_numeric_type(apArg[1]) ){ 220 case SQLITE_INTEGER: 221 iVal = sqlite3_value_int64(apArg[1]); 222 break; 223 case SQLITE_FLOAT: { 224 double fVal = sqlite3_value_double(apArg[1]); 225 if( ((i64)fVal)!=fVal ) goto error_out; 226 iVal = (i64)fVal; 227 break; 228 } 229 default: 230 goto error_out; 231 } 232 if( iVal<=0 ) goto error_out; 233 234 p->nStep++; 235 if( iVal==p->nStep ){ 236 p->pValue = sqlite3_value_dup(apArg[0]); 237 if( !p->pValue ){ 238 sqlite3_result_error_nomem(pCtx); 239 } 240 } 241 } 242 UNUSED_PARAMETER(nArg); 243 UNUSED_PARAMETER(apArg); 244 return; 245 246 error_out: 247 sqlite3_result_error( 248 pCtx, "second argument to nth_value must be a positive integer", -1 249 ); 250 } 251 static void nth_valueFinalizeFunc(sqlite3_context *pCtx){ 252 struct NthValueCtx *p; 253 p = (struct NthValueCtx*)sqlite3_aggregate_context(pCtx, 0); 254 if( p && p->pValue ){ 255 sqlite3_result_value(pCtx, p->pValue); 256 sqlite3_value_free(p->pValue); 257 p->pValue = 0; 258 } 259 } 260 #define nth_valueInvFunc noopStepFunc 261 #define nth_valueValueFunc noopValueFunc 262 263 static void first_valueStepFunc( 264 sqlite3_context *pCtx, 265 int nArg, 266 sqlite3_value **apArg 267 ){ 268 struct NthValueCtx *p; 269 p = (struct NthValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 270 if( p && p->pValue==0 ){ 271 p->pValue = sqlite3_value_dup(apArg[0]); 272 if( !p->pValue ){ 273 sqlite3_result_error_nomem(pCtx); 274 } 275 } 276 UNUSED_PARAMETER(nArg); 277 UNUSED_PARAMETER(apArg); 278 } 279 static void first_valueFinalizeFunc(sqlite3_context *pCtx){ 280 struct NthValueCtx *p; 281 p = (struct NthValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 282 if( p && p->pValue ){ 283 sqlite3_result_value(pCtx, p->pValue); 284 sqlite3_value_free(p->pValue); 285 p->pValue = 0; 286 } 287 } 288 #define first_valueInvFunc noopStepFunc 289 #define first_valueValueFunc noopValueFunc 290 291 /* 292 ** Implementation of built-in window function rank(). Assumes that 293 ** the window frame has been set to: 294 ** 295 ** RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW 296 */ 297 static void rankStepFunc( 298 sqlite3_context *pCtx, 299 int nArg, 300 sqlite3_value **apArg 301 ){ 302 struct CallCount *p; 303 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 304 if( p ){ 305 p->nStep++; 306 if( p->nValue==0 ){ 307 p->nValue = p->nStep; 308 } 309 } 310 UNUSED_PARAMETER(nArg); 311 UNUSED_PARAMETER(apArg); 312 } 313 static void rankValueFunc(sqlite3_context *pCtx){ 314 struct CallCount *p; 315 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 316 if( p ){ 317 sqlite3_result_int64(pCtx, p->nValue); 318 p->nValue = 0; 319 } 320 } 321 322 /* 323 ** Implementation of built-in window function percent_rank(). Assumes that 324 ** the window frame has been set to: 325 ** 326 ** GROUPS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING 327 */ 328 static void percent_rankStepFunc( 329 sqlite3_context *pCtx, 330 int nArg, 331 sqlite3_value **apArg 332 ){ 333 struct CallCount *p; 334 UNUSED_PARAMETER(nArg); assert( nArg==0 ); 335 UNUSED_PARAMETER(apArg); 336 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 337 if( p ){ 338 p->nTotal++; 339 } 340 } 341 static void percent_rankInvFunc( 342 sqlite3_context *pCtx, 343 int nArg, 344 sqlite3_value **apArg 345 ){ 346 struct CallCount *p; 347 UNUSED_PARAMETER(nArg); assert( nArg==0 ); 348 UNUSED_PARAMETER(apArg); 349 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 350 p->nStep++; 351 } 352 static void percent_rankValueFunc(sqlite3_context *pCtx){ 353 struct CallCount *p; 354 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 355 if( p ){ 356 p->nValue = p->nStep; 357 if( p->nTotal>1 ){ 358 double r = (double)p->nValue / (double)(p->nTotal-1); 359 sqlite3_result_double(pCtx, r); 360 }else{ 361 sqlite3_result_double(pCtx, 0.0); 362 } 363 } 364 } 365 #define percent_rankFinalizeFunc percent_rankValueFunc 366 367 /* 368 ** Implementation of built-in window function cume_dist(). Assumes that 369 ** the window frame has been set to: 370 ** 371 ** GROUPS BETWEEN 1 FOLLOWING AND UNBOUNDED FOLLOWING 372 */ 373 static void cume_distStepFunc( 374 sqlite3_context *pCtx, 375 int nArg, 376 sqlite3_value **apArg 377 ){ 378 struct CallCount *p; 379 UNUSED_PARAMETER(nArg); assert( nArg==0 ); 380 UNUSED_PARAMETER(apArg); 381 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 382 if( p ){ 383 p->nTotal++; 384 } 385 } 386 static void cume_distInvFunc( 387 sqlite3_context *pCtx, 388 int nArg, 389 sqlite3_value **apArg 390 ){ 391 struct CallCount *p; 392 UNUSED_PARAMETER(nArg); assert( nArg==0 ); 393 UNUSED_PARAMETER(apArg); 394 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 395 p->nStep++; 396 } 397 static void cume_distValueFunc(sqlite3_context *pCtx){ 398 struct CallCount *p; 399 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, 0); 400 if( p ){ 401 double r = (double)(p->nStep) / (double)(p->nTotal); 402 sqlite3_result_double(pCtx, r); 403 } 404 } 405 #define cume_distFinalizeFunc cume_distValueFunc 406 407 /* 408 ** Context object for ntile() window function. 409 */ 410 struct NtileCtx { 411 i64 nTotal; /* Total rows in partition */ 412 i64 nParam; /* Parameter passed to ntile(N) */ 413 i64 iRow; /* Current row */ 414 }; 415 416 /* 417 ** Implementation of ntile(). This assumes that the window frame has 418 ** been coerced to: 419 ** 420 ** ROWS CURRENT ROW AND UNBOUNDED FOLLOWING 421 */ 422 static void ntileStepFunc( 423 sqlite3_context *pCtx, 424 int nArg, 425 sqlite3_value **apArg 426 ){ 427 struct NtileCtx *p; 428 assert( nArg==1 ); UNUSED_PARAMETER(nArg); 429 p = (struct NtileCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 430 if( p ){ 431 if( p->nTotal==0 ){ 432 p->nParam = sqlite3_value_int64(apArg[0]); 433 if( p->nParam<=0 ){ 434 sqlite3_result_error( 435 pCtx, "argument of ntile must be a positive integer", -1 436 ); 437 } 438 } 439 p->nTotal++; 440 } 441 } 442 static void ntileInvFunc( 443 sqlite3_context *pCtx, 444 int nArg, 445 sqlite3_value **apArg 446 ){ 447 struct NtileCtx *p; 448 assert( nArg==1 ); UNUSED_PARAMETER(nArg); 449 UNUSED_PARAMETER(apArg); 450 p = (struct NtileCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 451 p->iRow++; 452 } 453 static void ntileValueFunc(sqlite3_context *pCtx){ 454 struct NtileCtx *p; 455 p = (struct NtileCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 456 if( p && p->nParam>0 ){ 457 int nSize = (p->nTotal / p->nParam); 458 if( nSize==0 ){ 459 sqlite3_result_int64(pCtx, p->iRow+1); 460 }else{ 461 i64 nLarge = p->nTotal - p->nParam*nSize; 462 i64 iSmall = nLarge*(nSize+1); 463 i64 iRow = p->iRow; 464 465 assert( (nLarge*(nSize+1) + (p->nParam-nLarge)*nSize)==p->nTotal ); 466 467 if( iRow<iSmall ){ 468 sqlite3_result_int64(pCtx, 1 + iRow/(nSize+1)); 469 }else{ 470 sqlite3_result_int64(pCtx, 1 + nLarge + (iRow-iSmall)/nSize); 471 } 472 } 473 } 474 } 475 #define ntileFinalizeFunc ntileValueFunc 476 477 /* 478 ** Context object for last_value() window function. 479 */ 480 struct LastValueCtx { 481 sqlite3_value *pVal; 482 int nVal; 483 }; 484 485 /* 486 ** Implementation of last_value(). 487 */ 488 static void last_valueStepFunc( 489 sqlite3_context *pCtx, 490 int nArg, 491 sqlite3_value **apArg 492 ){ 493 struct LastValueCtx *p; 494 UNUSED_PARAMETER(nArg); 495 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 496 if( p ){ 497 sqlite3_value_free(p->pVal); 498 p->pVal = sqlite3_value_dup(apArg[0]); 499 if( p->pVal==0 ){ 500 sqlite3_result_error_nomem(pCtx); 501 }else{ 502 p->nVal++; 503 } 504 } 505 } 506 static void last_valueInvFunc( 507 sqlite3_context *pCtx, 508 int nArg, 509 sqlite3_value **apArg 510 ){ 511 struct LastValueCtx *p; 512 UNUSED_PARAMETER(nArg); 513 UNUSED_PARAMETER(apArg); 514 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 515 if( ALWAYS(p) ){ 516 p->nVal--; 517 if( p->nVal==0 ){ 518 sqlite3_value_free(p->pVal); 519 p->pVal = 0; 520 } 521 } 522 } 523 static void last_valueValueFunc(sqlite3_context *pCtx){ 524 struct LastValueCtx *p; 525 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, 0); 526 if( p && p->pVal ){ 527 sqlite3_result_value(pCtx, p->pVal); 528 } 529 } 530 static void last_valueFinalizeFunc(sqlite3_context *pCtx){ 531 struct LastValueCtx *p; 532 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p)); 533 if( p && p->pVal ){ 534 sqlite3_result_value(pCtx, p->pVal); 535 sqlite3_value_free(p->pVal); 536 p->pVal = 0; 537 } 538 } 539 540 /* 541 ** Static names for the built-in window function names. These static 542 ** names are used, rather than string literals, so that FuncDef objects 543 ** can be associated with a particular window function by direct 544 ** comparison of the zName pointer. Example: 545 ** 546 ** if( pFuncDef->zName==row_valueName ){ ... } 547 */ 548 static const char row_numberName[] = "row_number"; 549 static const char dense_rankName[] = "dense_rank"; 550 static const char rankName[] = "rank"; 551 static const char percent_rankName[] = "percent_rank"; 552 static const char cume_distName[] = "cume_dist"; 553 static const char ntileName[] = "ntile"; 554 static const char last_valueName[] = "last_value"; 555 static const char nth_valueName[] = "nth_value"; 556 static const char first_valueName[] = "first_value"; 557 static const char leadName[] = "lead"; 558 static const char lagName[] = "lag"; 559 560 /* 561 ** No-op implementations of xStep() and xFinalize(). Used as place-holders 562 ** for built-in window functions that never call those interfaces. 563 ** 564 ** The noopValueFunc() is called but is expected to do nothing. The 565 ** noopStepFunc() is never called, and so it is marked with NO_TEST to 566 ** let the test coverage routine know not to expect this function to be 567 ** invoked. 568 */ 569 static void noopStepFunc( /*NO_TEST*/ 570 sqlite3_context *p, /*NO_TEST*/ 571 int n, /*NO_TEST*/ 572 sqlite3_value **a /*NO_TEST*/ 573 ){ /*NO_TEST*/ 574 UNUSED_PARAMETER(p); /*NO_TEST*/ 575 UNUSED_PARAMETER(n); /*NO_TEST*/ 576 UNUSED_PARAMETER(a); /*NO_TEST*/ 577 assert(0); /*NO_TEST*/ 578 } /*NO_TEST*/ 579 static void noopValueFunc(sqlite3_context *p){ UNUSED_PARAMETER(p); /*no-op*/ } 580 581 /* Window functions that use all window interfaces: xStep, xFinal, 582 ** xValue, and xInverse */ 583 #define WINDOWFUNCALL(name,nArg,extra) { \ 584 nArg, (SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \ 585 name ## StepFunc, name ## FinalizeFunc, name ## ValueFunc, \ 586 name ## InvFunc, name ## Name, {0} \ 587 } 588 589 /* Window functions that are implemented using bytecode and thus have 590 ** no-op routines for their methods */ 591 #define WINDOWFUNCNOOP(name,nArg,extra) { \ 592 nArg, (SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \ 593 noopStepFunc, noopValueFunc, noopValueFunc, \ 594 noopStepFunc, name ## Name, {0} \ 595 } 596 597 /* Window functions that use all window interfaces: xStep, the 598 ** same routine for xFinalize and xValue and which never call 599 ** xInverse. */ 600 #define WINDOWFUNCX(name,nArg,extra) { \ 601 nArg, (SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \ 602 name ## StepFunc, name ## ValueFunc, name ## ValueFunc, \ 603 noopStepFunc, name ## Name, {0} \ 604 } 605 606 607 /* 608 ** Register those built-in window functions that are not also aggregates. 609 */ 610 void sqlite3WindowFunctions(void){ 611 static FuncDef aWindowFuncs[] = { 612 WINDOWFUNCX(row_number, 0, 0), 613 WINDOWFUNCX(dense_rank, 0, 0), 614 WINDOWFUNCX(rank, 0, 0), 615 WINDOWFUNCALL(percent_rank, 0, 0), 616 WINDOWFUNCALL(cume_dist, 0, 0), 617 WINDOWFUNCALL(ntile, 1, 0), 618 WINDOWFUNCALL(last_value, 1, 0), 619 WINDOWFUNCALL(nth_value, 2, 0), 620 WINDOWFUNCALL(first_value, 1, 0), 621 WINDOWFUNCNOOP(lead, 1, 0), 622 WINDOWFUNCNOOP(lead, 2, 0), 623 WINDOWFUNCNOOP(lead, 3, 0), 624 WINDOWFUNCNOOP(lag, 1, 0), 625 WINDOWFUNCNOOP(lag, 2, 0), 626 WINDOWFUNCNOOP(lag, 3, 0), 627 }; 628 sqlite3InsertBuiltinFuncs(aWindowFuncs, ArraySize(aWindowFuncs)); 629 } 630 631 static Window *windowFind(Parse *pParse, Window *pList, const char *zName){ 632 Window *p; 633 for(p=pList; p; p=p->pNextWin){ 634 if( sqlite3StrICmp(p->zName, zName)==0 ) break; 635 } 636 if( p==0 ){ 637 sqlite3ErrorMsg(pParse, "no such window: %s", zName); 638 } 639 return p; 640 } 641 642 /* 643 ** This function is called immediately after resolving the function name 644 ** for a window function within a SELECT statement. Argument pList is a 645 ** linked list of WINDOW definitions for the current SELECT statement. 646 ** Argument pFunc is the function definition just resolved and pWin 647 ** is the Window object representing the associated OVER clause. This 648 ** function updates the contents of pWin as follows: 649 ** 650 ** * If the OVER clause refered to a named window (as in "max(x) OVER win"), 651 ** search list pList for a matching WINDOW definition, and update pWin 652 ** accordingly. If no such WINDOW clause can be found, leave an error 653 ** in pParse. 654 ** 655 ** * If the function is a built-in window function that requires the 656 ** window to be coerced (see "BUILT-IN WINDOW FUNCTIONS" at the top 657 ** of this file), pWin is updated here. 658 */ 659 void sqlite3WindowUpdate( 660 Parse *pParse, 661 Window *pList, /* List of named windows for this SELECT */ 662 Window *pWin, /* Window frame to update */ 663 FuncDef *pFunc /* Window function definition */ 664 ){ 665 if( pWin->zName && pWin->eFrmType==0 ){ 666 Window *p = windowFind(pParse, pList, pWin->zName); 667 if( p==0 ) return; 668 pWin->pPartition = sqlite3ExprListDup(pParse->db, p->pPartition, 0); 669 pWin->pOrderBy = sqlite3ExprListDup(pParse->db, p->pOrderBy, 0); 670 pWin->pStart = sqlite3ExprDup(pParse->db, p->pStart, 0); 671 pWin->pEnd = sqlite3ExprDup(pParse->db, p->pEnd, 0); 672 pWin->eStart = p->eStart; 673 pWin->eEnd = p->eEnd; 674 pWin->eFrmType = p->eFrmType; 675 pWin->eExclude = p->eExclude; 676 }else{ 677 sqlite3WindowChain(pParse, pWin, pList); 678 } 679 if( (pWin->eFrmType==TK_RANGE) 680 && (pWin->pStart || pWin->pEnd) 681 && (pWin->pOrderBy==0 || pWin->pOrderBy->nExpr!=1) 682 ){ 683 sqlite3ErrorMsg(pParse, 684 "RANGE with offset PRECEDING/FOLLOWING requires one ORDER BY expression" 685 ); 686 }else 687 if( pFunc->funcFlags & SQLITE_FUNC_WINDOW ){ 688 sqlite3 *db = pParse->db; 689 if( pWin->pFilter ){ 690 sqlite3ErrorMsg(pParse, 691 "FILTER clause may only be used with aggregate window functions" 692 ); 693 }else{ 694 struct WindowUpdate { 695 const char *zFunc; 696 int eFrmType; 697 int eStart; 698 int eEnd; 699 } aUp[] = { 700 { row_numberName, TK_ROWS, TK_UNBOUNDED, TK_CURRENT }, 701 { dense_rankName, TK_RANGE, TK_UNBOUNDED, TK_CURRENT }, 702 { rankName, TK_RANGE, TK_UNBOUNDED, TK_CURRENT }, 703 { percent_rankName, TK_GROUPS, TK_CURRENT, TK_UNBOUNDED }, 704 { cume_distName, TK_GROUPS, TK_FOLLOWING, TK_UNBOUNDED }, 705 { ntileName, TK_ROWS, TK_CURRENT, TK_UNBOUNDED }, 706 { leadName, TK_ROWS, TK_UNBOUNDED, TK_UNBOUNDED }, 707 { lagName, TK_ROWS, TK_UNBOUNDED, TK_CURRENT }, 708 }; 709 int i; 710 for(i=0; i<ArraySize(aUp); i++){ 711 if( pFunc->zName==aUp[i].zFunc ){ 712 sqlite3ExprDelete(db, pWin->pStart); 713 sqlite3ExprDelete(db, pWin->pEnd); 714 pWin->pEnd = pWin->pStart = 0; 715 pWin->eFrmType = aUp[i].eFrmType; 716 pWin->eStart = aUp[i].eStart; 717 pWin->eEnd = aUp[i].eEnd; 718 pWin->eExclude = 0; 719 if( pWin->eStart==TK_FOLLOWING ){ 720 pWin->pStart = sqlite3Expr(db, TK_INTEGER, "1"); 721 } 722 break; 723 } 724 } 725 } 726 } 727 pWin->pFunc = pFunc; 728 } 729 730 /* 731 ** Context object passed through sqlite3WalkExprList() to 732 ** selectWindowRewriteExprCb() by selectWindowRewriteEList(). 733 */ 734 typedef struct WindowRewrite WindowRewrite; 735 struct WindowRewrite { 736 Window *pWin; 737 SrcList *pSrc; 738 ExprList *pSub; 739 Table *pTab; 740 Select *pSubSelect; /* Current sub-select, if any */ 741 }; 742 743 /* 744 ** Callback function used by selectWindowRewriteEList(). If necessary, 745 ** this function appends to the output expression-list and updates 746 ** expression (*ppExpr) in place. 747 */ 748 static int selectWindowRewriteExprCb(Walker *pWalker, Expr *pExpr){ 749 struct WindowRewrite *p = pWalker->u.pRewrite; 750 Parse *pParse = pWalker->pParse; 751 assert( p!=0 ); 752 assert( p->pWin!=0 ); 753 754 /* If this function is being called from within a scalar sub-select 755 ** that used by the SELECT statement being processed, only process 756 ** TK_COLUMN expressions that refer to it (the outer SELECT). Do 757 ** not process aggregates or window functions at all, as they belong 758 ** to the scalar sub-select. */ 759 if( p->pSubSelect ){ 760 if( pExpr->op!=TK_COLUMN ){ 761 return WRC_Continue; 762 }else{ 763 int nSrc = p->pSrc->nSrc; 764 int i; 765 for(i=0; i<nSrc; i++){ 766 if( pExpr->iTable==p->pSrc->a[i].iCursor ) break; 767 } 768 if( i==nSrc ) return WRC_Continue; 769 } 770 } 771 772 switch( pExpr->op ){ 773 774 case TK_FUNCTION: 775 if( !ExprHasProperty(pExpr, EP_WinFunc) ){ 776 break; 777 }else{ 778 Window *pWin; 779 for(pWin=p->pWin; pWin; pWin=pWin->pNextWin){ 780 if( pExpr->y.pWin==pWin ){ 781 assert( pWin->pOwner==pExpr ); 782 return WRC_Prune; 783 } 784 } 785 } 786 /* no break */ deliberate_fall_through 787 788 case TK_AGG_FUNCTION: 789 case TK_COLUMN: { 790 int iCol = -1; 791 if( pParse->db->mallocFailed ) return WRC_Abort; 792 if( p->pSub ){ 793 int i; 794 for(i=0; i<p->pSub->nExpr; i++){ 795 if( 0==sqlite3ExprCompare(0, p->pSub->a[i].pExpr, pExpr, -1) ){ 796 iCol = i; 797 break; 798 } 799 } 800 } 801 if( iCol<0 ){ 802 Expr *pDup = sqlite3ExprDup(pParse->db, pExpr, 0); 803 if( pDup && pDup->op==TK_AGG_FUNCTION ) pDup->op = TK_FUNCTION; 804 p->pSub = sqlite3ExprListAppend(pParse, p->pSub, pDup); 805 } 806 if( p->pSub ){ 807 int f = pExpr->flags & EP_Collate; 808 assert( ExprHasProperty(pExpr, EP_Static)==0 ); 809 ExprSetProperty(pExpr, EP_Static); 810 sqlite3ExprDelete(pParse->db, pExpr); 811 ExprClearProperty(pExpr, EP_Static); 812 memset(pExpr, 0, sizeof(Expr)); 813 814 pExpr->op = TK_COLUMN; 815 pExpr->iColumn = (iCol<0 ? p->pSub->nExpr-1: iCol); 816 pExpr->iTable = p->pWin->iEphCsr; 817 pExpr->y.pTab = p->pTab; 818 pExpr->flags = f; 819 } 820 if( pParse->db->mallocFailed ) return WRC_Abort; 821 break; 822 } 823 824 default: /* no-op */ 825 break; 826 } 827 828 return WRC_Continue; 829 } 830 static int selectWindowRewriteSelectCb(Walker *pWalker, Select *pSelect){ 831 struct WindowRewrite *p = pWalker->u.pRewrite; 832 Select *pSave = p->pSubSelect; 833 if( pSave==pSelect ){ 834 return WRC_Continue; 835 }else{ 836 p->pSubSelect = pSelect; 837 sqlite3WalkSelect(pWalker, pSelect); 838 p->pSubSelect = pSave; 839 } 840 return WRC_Prune; 841 } 842 843 844 /* 845 ** Iterate through each expression in expression-list pEList. For each: 846 ** 847 ** * TK_COLUMN, 848 ** * aggregate function, or 849 ** * window function with a Window object that is not a member of the 850 ** Window list passed as the second argument (pWin). 851 ** 852 ** Append the node to output expression-list (*ppSub). And replace it 853 ** with a TK_COLUMN that reads the (N-1)th element of table 854 ** pWin->iEphCsr, where N is the number of elements in (*ppSub) after 855 ** appending the new one. 856 */ 857 static void selectWindowRewriteEList( 858 Parse *pParse, 859 Window *pWin, 860 SrcList *pSrc, 861 ExprList *pEList, /* Rewrite expressions in this list */ 862 Table *pTab, 863 ExprList **ppSub /* IN/OUT: Sub-select expression-list */ 864 ){ 865 Walker sWalker; 866 WindowRewrite sRewrite; 867 868 assert( pWin!=0 ); 869 memset(&sWalker, 0, sizeof(Walker)); 870 memset(&sRewrite, 0, sizeof(WindowRewrite)); 871 872 sRewrite.pSub = *ppSub; 873 sRewrite.pWin = pWin; 874 sRewrite.pSrc = pSrc; 875 sRewrite.pTab = pTab; 876 877 sWalker.pParse = pParse; 878 sWalker.xExprCallback = selectWindowRewriteExprCb; 879 sWalker.xSelectCallback = selectWindowRewriteSelectCb; 880 sWalker.u.pRewrite = &sRewrite; 881 882 (void)sqlite3WalkExprList(&sWalker, pEList); 883 884 *ppSub = sRewrite.pSub; 885 } 886 887 /* 888 ** Append a copy of each expression in expression-list pAppend to 889 ** expression list pList. Return a pointer to the result list. 890 */ 891 static ExprList *exprListAppendList( 892 Parse *pParse, /* Parsing context */ 893 ExprList *pList, /* List to which to append. Might be NULL */ 894 ExprList *pAppend, /* List of values to append. Might be NULL */ 895 int bIntToNull 896 ){ 897 if( pAppend ){ 898 int i; 899 int nInit = pList ? pList->nExpr : 0; 900 for(i=0; i<pAppend->nExpr; i++){ 901 sqlite3 *db = pParse->db; 902 Expr *pDup = sqlite3ExprDup(db, pAppend->a[i].pExpr, 0); 903 assert( pDup==0 || !ExprHasProperty(pDup, EP_MemToken) ); 904 if( db->mallocFailed ){ 905 sqlite3ExprDelete(db, pDup); 906 break; 907 } 908 if( bIntToNull ){ 909 int iDummy; 910 Expr *pSub; 911 pSub = sqlite3ExprSkipCollateAndLikely(pDup); 912 if( sqlite3ExprIsInteger(pSub, &iDummy) ){ 913 pSub->op = TK_NULL; 914 pSub->flags &= ~(EP_IntValue|EP_IsTrue|EP_IsFalse); 915 pSub->u.zToken = 0; 916 } 917 } 918 pList = sqlite3ExprListAppend(pParse, pList, pDup); 919 if( pList ) pList->a[nInit+i].sortFlags = pAppend->a[i].sortFlags; 920 } 921 } 922 return pList; 923 } 924 925 /* 926 ** When rewriting a query, if the new subquery in the FROM clause 927 ** contains TK_AGG_FUNCTION nodes that refer to an outer query, 928 ** then we have to increase the Expr->op2 values of those nodes 929 ** due to the extra subquery layer that was added. 930 ** 931 ** See also the incrAggDepth() routine in resolve.c 932 */ 933 static int sqlite3WindowExtraAggFuncDepth(Walker *pWalker, Expr *pExpr){ 934 if( pExpr->op==TK_AGG_FUNCTION 935 && pExpr->op2>=pWalker->walkerDepth 936 ){ 937 pExpr->op2++; 938 } 939 return WRC_Continue; 940 } 941 942 static int disallowAggregatesInOrderByCb(Walker *pWalker, Expr *pExpr){ 943 if( pExpr->op==TK_AGG_FUNCTION && pExpr->pAggInfo==0 ){ 944 sqlite3ErrorMsg(pWalker->pParse, 945 "misuse of aggregate: %s()", pExpr->u.zToken); 946 } 947 return WRC_Continue; 948 } 949 950 /* 951 ** If the SELECT statement passed as the second argument does not invoke 952 ** any SQL window functions, this function is a no-op. Otherwise, it 953 ** rewrites the SELECT statement so that window function xStep functions 954 ** are invoked in the correct order as described under "SELECT REWRITING" 955 ** at the top of this file. 956 */ 957 int sqlite3WindowRewrite(Parse *pParse, Select *p){ 958 int rc = SQLITE_OK; 959 if( p->pWin && p->pPrior==0 && ALWAYS((p->selFlags & SF_WinRewrite)==0) ){ 960 Vdbe *v = sqlite3GetVdbe(pParse); 961 sqlite3 *db = pParse->db; 962 Select *pSub = 0; /* The subquery */ 963 SrcList *pSrc = p->pSrc; 964 Expr *pWhere = p->pWhere; 965 ExprList *pGroupBy = p->pGroupBy; 966 Expr *pHaving = p->pHaving; 967 ExprList *pSort = 0; 968 969 ExprList *pSublist = 0; /* Expression list for sub-query */ 970 Window *pMWin = p->pWin; /* Main window object */ 971 Window *pWin; /* Window object iterator */ 972 Table *pTab; 973 Walker w; 974 975 u32 selFlags = p->selFlags; 976 977 pTab = sqlite3DbMallocZero(db, sizeof(Table)); 978 if( pTab==0 ){ 979 return sqlite3ErrorToParser(db, SQLITE_NOMEM); 980 } 981 sqlite3AggInfoPersistWalkerInit(&w, pParse); 982 sqlite3WalkSelect(&w, p); 983 if( (p->selFlags & SF_Aggregate)==0 ){ 984 w.xExprCallback = disallowAggregatesInOrderByCb; 985 w.xSelectCallback = 0; 986 sqlite3WalkExprList(&w, p->pOrderBy); 987 } 988 989 p->pSrc = 0; 990 p->pWhere = 0; 991 p->pGroupBy = 0; 992 p->pHaving = 0; 993 p->selFlags &= ~SF_Aggregate; 994 p->selFlags |= SF_WinRewrite; 995 996 /* Create the ORDER BY clause for the sub-select. This is the concatenation 997 ** of the window PARTITION and ORDER BY clauses. Then, if this makes it 998 ** redundant, remove the ORDER BY from the parent SELECT. */ 999 pSort = exprListAppendList(pParse, 0, pMWin->pPartition, 1); 1000 pSort = exprListAppendList(pParse, pSort, pMWin->pOrderBy, 1); 1001 if( pSort && p->pOrderBy && p->pOrderBy->nExpr<=pSort->nExpr ){ 1002 int nSave = pSort->nExpr; 1003 pSort->nExpr = p->pOrderBy->nExpr; 1004 if( sqlite3ExprListCompare(pSort, p->pOrderBy, -1)==0 ){ 1005 sqlite3ExprListDelete(db, p->pOrderBy); 1006 p->pOrderBy = 0; 1007 } 1008 pSort->nExpr = nSave; 1009 } 1010 1011 /* Assign a cursor number for the ephemeral table used to buffer rows. 1012 ** The OpenEphemeral instruction is coded later, after it is known how 1013 ** many columns the table will have. */ 1014 pMWin->iEphCsr = pParse->nTab++; 1015 pParse->nTab += 3; 1016 1017 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pEList, pTab, &pSublist); 1018 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pOrderBy, pTab, &pSublist); 1019 pMWin->nBufferCol = (pSublist ? pSublist->nExpr : 0); 1020 1021 /* Append the PARTITION BY and ORDER BY expressions to the to the 1022 ** sub-select expression list. They are required to figure out where 1023 ** boundaries for partitions and sets of peer rows lie. */ 1024 pSublist = exprListAppendList(pParse, pSublist, pMWin->pPartition, 0); 1025 pSublist = exprListAppendList(pParse, pSublist, pMWin->pOrderBy, 0); 1026 1027 /* Append the arguments passed to each window function to the 1028 ** sub-select expression list. Also allocate two registers for each 1029 ** window function - one for the accumulator, another for interim 1030 ** results. */ 1031 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1032 ExprList *pArgs = pWin->pOwner->x.pList; 1033 if( pWin->pFunc->funcFlags & SQLITE_FUNC_SUBTYPE ){ 1034 selectWindowRewriteEList(pParse, pMWin, pSrc, pArgs, pTab, &pSublist); 1035 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0); 1036 pWin->bExprArgs = 1; 1037 }else{ 1038 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0); 1039 pSublist = exprListAppendList(pParse, pSublist, pArgs, 0); 1040 } 1041 if( pWin->pFilter ){ 1042 Expr *pFilter = sqlite3ExprDup(db, pWin->pFilter, 0); 1043 pSublist = sqlite3ExprListAppend(pParse, pSublist, pFilter); 1044 } 1045 pWin->regAccum = ++pParse->nMem; 1046 pWin->regResult = ++pParse->nMem; 1047 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum); 1048 } 1049 1050 /* If there is no ORDER BY or PARTITION BY clause, and the window 1051 ** function accepts zero arguments, and there are no other columns 1052 ** selected (e.g. "SELECT row_number() OVER () FROM t1"), it is possible 1053 ** that pSublist is still NULL here. Add a constant expression here to 1054 ** keep everything legal in this case. 1055 */ 1056 if( pSublist==0 ){ 1057 pSublist = sqlite3ExprListAppend(pParse, 0, 1058 sqlite3Expr(db, TK_INTEGER, "0") 1059 ); 1060 } 1061 1062 pSub = sqlite3SelectNew( 1063 pParse, pSublist, pSrc, pWhere, pGroupBy, pHaving, pSort, 0, 0 1064 ); 1065 SELECTTRACE(1,pParse,pSub, 1066 ("New window-function subquery in FROM clause of (%u/%p)\n", 1067 p->selId, p)); 1068 p->pSrc = sqlite3SrcListAppend(pParse, 0, 0, 0); 1069 if( p->pSrc ){ 1070 Table *pTab2; 1071 p->pSrc->a[0].pSelect = pSub; 1072 sqlite3SrcListAssignCursors(pParse, p->pSrc); 1073 pSub->selFlags |= SF_Expanded; 1074 pTab2 = sqlite3ResultSetOfSelect(pParse, pSub, SQLITE_AFF_NONE); 1075 pSub->selFlags |= (selFlags & SF_Aggregate); 1076 if( pTab2==0 ){ 1077 /* Might actually be some other kind of error, but in that case 1078 ** pParse->nErr will be set, so if SQLITE_NOMEM is set, we will get 1079 ** the correct error message regardless. */ 1080 rc = SQLITE_NOMEM; 1081 }else{ 1082 memcpy(pTab, pTab2, sizeof(Table)); 1083 pTab->tabFlags |= TF_Ephemeral; 1084 p->pSrc->a[0].pTab = pTab; 1085 pTab = pTab2; 1086 memset(&w, 0, sizeof(w)); 1087 w.xExprCallback = sqlite3WindowExtraAggFuncDepth; 1088 w.xSelectCallback = sqlite3WalkerDepthIncrease; 1089 w.xSelectCallback2 = sqlite3WalkerDepthDecrease; 1090 sqlite3WalkSelect(&w, pSub); 1091 } 1092 }else{ 1093 sqlite3SelectDelete(db, pSub); 1094 } 1095 if( db->mallocFailed ) rc = SQLITE_NOMEM; 1096 sqlite3DbFree(db, pTab); 1097 } 1098 1099 if( rc ){ 1100 if( pParse->nErr==0 ){ 1101 assert( pParse->db->mallocFailed ); 1102 sqlite3ErrorToParser(pParse->db, SQLITE_NOMEM); 1103 } 1104 } 1105 return rc; 1106 } 1107 1108 /* 1109 ** Unlink the Window object from the Select to which it is attached, 1110 ** if it is attached. 1111 */ 1112 void sqlite3WindowUnlinkFromSelect(Window *p){ 1113 if( p->ppThis ){ 1114 *p->ppThis = p->pNextWin; 1115 if( p->pNextWin ) p->pNextWin->ppThis = p->ppThis; 1116 p->ppThis = 0; 1117 } 1118 } 1119 1120 /* 1121 ** Free the Window object passed as the second argument. 1122 */ 1123 void sqlite3WindowDelete(sqlite3 *db, Window *p){ 1124 if( p ){ 1125 sqlite3WindowUnlinkFromSelect(p); 1126 sqlite3ExprDelete(db, p->pFilter); 1127 sqlite3ExprListDelete(db, p->pPartition); 1128 sqlite3ExprListDelete(db, p->pOrderBy); 1129 sqlite3ExprDelete(db, p->pEnd); 1130 sqlite3ExprDelete(db, p->pStart); 1131 sqlite3DbFree(db, p->zName); 1132 sqlite3DbFree(db, p->zBase); 1133 sqlite3DbFree(db, p); 1134 } 1135 } 1136 1137 /* 1138 ** Free the linked list of Window objects starting at the second argument. 1139 */ 1140 void sqlite3WindowListDelete(sqlite3 *db, Window *p){ 1141 while( p ){ 1142 Window *pNext = p->pNextWin; 1143 sqlite3WindowDelete(db, p); 1144 p = pNext; 1145 } 1146 } 1147 1148 /* 1149 ** The argument expression is an PRECEDING or FOLLOWING offset. The 1150 ** value should be a non-negative integer. If the value is not a 1151 ** constant, change it to NULL. The fact that it is then a non-negative 1152 ** integer will be caught later. But it is important not to leave 1153 ** variable values in the expression tree. 1154 */ 1155 static Expr *sqlite3WindowOffsetExpr(Parse *pParse, Expr *pExpr){ 1156 if( 0==sqlite3ExprIsConstant(pExpr) ){ 1157 if( IN_RENAME_OBJECT ) sqlite3RenameExprUnmap(pParse, pExpr); 1158 sqlite3ExprDelete(pParse->db, pExpr); 1159 pExpr = sqlite3ExprAlloc(pParse->db, TK_NULL, 0, 0); 1160 } 1161 return pExpr; 1162 } 1163 1164 /* 1165 ** Allocate and return a new Window object describing a Window Definition. 1166 */ 1167 Window *sqlite3WindowAlloc( 1168 Parse *pParse, /* Parsing context */ 1169 int eType, /* Frame type. TK_RANGE, TK_ROWS, TK_GROUPS, or 0 */ 1170 int eStart, /* Start type: CURRENT, PRECEDING, FOLLOWING, UNBOUNDED */ 1171 Expr *pStart, /* Start window size if TK_PRECEDING or FOLLOWING */ 1172 int eEnd, /* End type: CURRENT, FOLLOWING, TK_UNBOUNDED, PRECEDING */ 1173 Expr *pEnd, /* End window size if TK_FOLLOWING or PRECEDING */ 1174 u8 eExclude /* EXCLUDE clause */ 1175 ){ 1176 Window *pWin = 0; 1177 int bImplicitFrame = 0; 1178 1179 /* Parser assures the following: */ 1180 assert( eType==0 || eType==TK_RANGE || eType==TK_ROWS || eType==TK_GROUPS ); 1181 assert( eStart==TK_CURRENT || eStart==TK_PRECEDING 1182 || eStart==TK_UNBOUNDED || eStart==TK_FOLLOWING ); 1183 assert( eEnd==TK_CURRENT || eEnd==TK_FOLLOWING 1184 || eEnd==TK_UNBOUNDED || eEnd==TK_PRECEDING ); 1185 assert( (eStart==TK_PRECEDING || eStart==TK_FOLLOWING)==(pStart!=0) ); 1186 assert( (eEnd==TK_FOLLOWING || eEnd==TK_PRECEDING)==(pEnd!=0) ); 1187 1188 if( eType==0 ){ 1189 bImplicitFrame = 1; 1190 eType = TK_RANGE; 1191 } 1192 1193 /* Additionally, the 1194 ** starting boundary type may not occur earlier in the following list than 1195 ** the ending boundary type: 1196 ** 1197 ** UNBOUNDED PRECEDING 1198 ** <expr> PRECEDING 1199 ** CURRENT ROW 1200 ** <expr> FOLLOWING 1201 ** UNBOUNDED FOLLOWING 1202 ** 1203 ** The parser ensures that "UNBOUNDED PRECEDING" cannot be used as an ending 1204 ** boundary, and than "UNBOUNDED FOLLOWING" cannot be used as a starting 1205 ** frame boundary. 1206 */ 1207 if( (eStart==TK_CURRENT && eEnd==TK_PRECEDING) 1208 || (eStart==TK_FOLLOWING && (eEnd==TK_PRECEDING || eEnd==TK_CURRENT)) 1209 ){ 1210 sqlite3ErrorMsg(pParse, "unsupported frame specification"); 1211 goto windowAllocErr; 1212 } 1213 1214 pWin = (Window*)sqlite3DbMallocZero(pParse->db, sizeof(Window)); 1215 if( pWin==0 ) goto windowAllocErr; 1216 pWin->eFrmType = eType; 1217 pWin->eStart = eStart; 1218 pWin->eEnd = eEnd; 1219 if( eExclude==0 && OptimizationDisabled(pParse->db, SQLITE_WindowFunc) ){ 1220 eExclude = TK_NO; 1221 } 1222 pWin->eExclude = eExclude; 1223 pWin->bImplicitFrame = bImplicitFrame; 1224 pWin->pEnd = sqlite3WindowOffsetExpr(pParse, pEnd); 1225 pWin->pStart = sqlite3WindowOffsetExpr(pParse, pStart); 1226 return pWin; 1227 1228 windowAllocErr: 1229 sqlite3ExprDelete(pParse->db, pEnd); 1230 sqlite3ExprDelete(pParse->db, pStart); 1231 return 0; 1232 } 1233 1234 /* 1235 ** Attach PARTITION and ORDER BY clauses pPartition and pOrderBy to window 1236 ** pWin. Also, if parameter pBase is not NULL, set pWin->zBase to the 1237 ** equivalent nul-terminated string. 1238 */ 1239 Window *sqlite3WindowAssemble( 1240 Parse *pParse, 1241 Window *pWin, 1242 ExprList *pPartition, 1243 ExprList *pOrderBy, 1244 Token *pBase 1245 ){ 1246 if( pWin ){ 1247 pWin->pPartition = pPartition; 1248 pWin->pOrderBy = pOrderBy; 1249 if( pBase ){ 1250 pWin->zBase = sqlite3DbStrNDup(pParse->db, pBase->z, pBase->n); 1251 } 1252 }else{ 1253 sqlite3ExprListDelete(pParse->db, pPartition); 1254 sqlite3ExprListDelete(pParse->db, pOrderBy); 1255 } 1256 return pWin; 1257 } 1258 1259 /* 1260 ** Window *pWin has just been created from a WINDOW clause. Tokne pBase 1261 ** is the base window. Earlier windows from the same WINDOW clause are 1262 ** stored in the linked list starting at pWin->pNextWin. This function 1263 ** either updates *pWin according to the base specification, or else 1264 ** leaves an error in pParse. 1265 */ 1266 void sqlite3WindowChain(Parse *pParse, Window *pWin, Window *pList){ 1267 if( pWin->zBase ){ 1268 sqlite3 *db = pParse->db; 1269 Window *pExist = windowFind(pParse, pList, pWin->zBase); 1270 if( pExist ){ 1271 const char *zErr = 0; 1272 /* Check for errors */ 1273 if( pWin->pPartition ){ 1274 zErr = "PARTITION clause"; 1275 }else if( pExist->pOrderBy && pWin->pOrderBy ){ 1276 zErr = "ORDER BY clause"; 1277 }else if( pExist->bImplicitFrame==0 ){ 1278 zErr = "frame specification"; 1279 } 1280 if( zErr ){ 1281 sqlite3ErrorMsg(pParse, 1282 "cannot override %s of window: %s", zErr, pWin->zBase 1283 ); 1284 }else{ 1285 pWin->pPartition = sqlite3ExprListDup(db, pExist->pPartition, 0); 1286 if( pExist->pOrderBy ){ 1287 assert( pWin->pOrderBy==0 ); 1288 pWin->pOrderBy = sqlite3ExprListDup(db, pExist->pOrderBy, 0); 1289 } 1290 sqlite3DbFree(db, pWin->zBase); 1291 pWin->zBase = 0; 1292 } 1293 } 1294 } 1295 } 1296 1297 /* 1298 ** Attach window object pWin to expression p. 1299 */ 1300 void sqlite3WindowAttach(Parse *pParse, Expr *p, Window *pWin){ 1301 if( p ){ 1302 assert( p->op==TK_FUNCTION ); 1303 assert( pWin ); 1304 p->y.pWin = pWin; 1305 ExprSetProperty(p, EP_WinFunc); 1306 pWin->pOwner = p; 1307 if( (p->flags & EP_Distinct) && pWin->eFrmType!=TK_FILTER ){ 1308 sqlite3ErrorMsg(pParse, 1309 "DISTINCT is not supported for window functions" 1310 ); 1311 } 1312 }else{ 1313 sqlite3WindowDelete(pParse->db, pWin); 1314 } 1315 } 1316 1317 /* 1318 ** Possibly link window pWin into the list at pSel->pWin (window functions 1319 ** to be processed as part of SELECT statement pSel). The window is linked 1320 ** in if either (a) there are no other windows already linked to this 1321 ** SELECT, or (b) the windows already linked use a compatible window frame. 1322 */ 1323 void sqlite3WindowLink(Select *pSel, Window *pWin){ 1324 if( pSel ){ 1325 if( 0==pSel->pWin || 0==sqlite3WindowCompare(0, pSel->pWin, pWin, 0) ){ 1326 pWin->pNextWin = pSel->pWin; 1327 if( pSel->pWin ){ 1328 pSel->pWin->ppThis = &pWin->pNextWin; 1329 } 1330 pSel->pWin = pWin; 1331 pWin->ppThis = &pSel->pWin; 1332 }else{ 1333 if( sqlite3ExprListCompare(pWin->pPartition, pSel->pWin->pPartition,-1) ){ 1334 pSel->selFlags |= SF_MultiPart; 1335 } 1336 } 1337 } 1338 } 1339 1340 /* 1341 ** Return 0 if the two window objects are identical, 1 if they are 1342 ** different, or 2 if it cannot be determined if the objects are identical 1343 ** or not. Identical window objects can be processed in a single scan. 1344 */ 1345 int sqlite3WindowCompare(Parse *pParse, Window *p1, Window *p2, int bFilter){ 1346 int res; 1347 if( NEVER(p1==0) || NEVER(p2==0) ) return 1; 1348 if( p1->eFrmType!=p2->eFrmType ) return 1; 1349 if( p1->eStart!=p2->eStart ) return 1; 1350 if( p1->eEnd!=p2->eEnd ) return 1; 1351 if( p1->eExclude!=p2->eExclude ) return 1; 1352 if( sqlite3ExprCompare(pParse, p1->pStart, p2->pStart, -1) ) return 1; 1353 if( sqlite3ExprCompare(pParse, p1->pEnd, p2->pEnd, -1) ) return 1; 1354 if( (res = sqlite3ExprListCompare(p1->pPartition, p2->pPartition, -1)) ){ 1355 return res; 1356 } 1357 if( (res = sqlite3ExprListCompare(p1->pOrderBy, p2->pOrderBy, -1)) ){ 1358 return res; 1359 } 1360 if( bFilter ){ 1361 if( (res = sqlite3ExprCompare(pParse, p1->pFilter, p2->pFilter, -1)) ){ 1362 return res; 1363 } 1364 } 1365 return 0; 1366 } 1367 1368 1369 /* 1370 ** This is called by code in select.c before it calls sqlite3WhereBegin() 1371 ** to begin iterating through the sub-query results. It is used to allocate 1372 ** and initialize registers and cursors used by sqlite3WindowCodeStep(). 1373 */ 1374 void sqlite3WindowCodeInit(Parse *pParse, Select *pSelect){ 1375 int nEphExpr = pSelect->pSrc->a[0].pSelect->pEList->nExpr; 1376 Window *pMWin = pSelect->pWin; 1377 Window *pWin; 1378 Vdbe *v = sqlite3GetVdbe(pParse); 1379 1380 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pMWin->iEphCsr, nEphExpr); 1381 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+1, pMWin->iEphCsr); 1382 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+2, pMWin->iEphCsr); 1383 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+3, pMWin->iEphCsr); 1384 1385 /* Allocate registers to use for PARTITION BY values, if any. Initialize 1386 ** said registers to NULL. */ 1387 if( pMWin->pPartition ){ 1388 int nExpr = pMWin->pPartition->nExpr; 1389 pMWin->regPart = pParse->nMem+1; 1390 pParse->nMem += nExpr; 1391 sqlite3VdbeAddOp3(v, OP_Null, 0, pMWin->regPart, pMWin->regPart+nExpr-1); 1392 } 1393 1394 pMWin->regOne = ++pParse->nMem; 1395 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regOne); 1396 1397 if( pMWin->eExclude ){ 1398 pMWin->regStartRowid = ++pParse->nMem; 1399 pMWin->regEndRowid = ++pParse->nMem; 1400 pMWin->csrApp = pParse->nTab++; 1401 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid); 1402 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid); 1403 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->csrApp, pMWin->iEphCsr); 1404 return; 1405 } 1406 1407 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1408 FuncDef *p = pWin->pFunc; 1409 if( (p->funcFlags & SQLITE_FUNC_MINMAX) && pWin->eStart!=TK_UNBOUNDED ){ 1410 /* The inline versions of min() and max() require a single ephemeral 1411 ** table and 3 registers. The registers are used as follows: 1412 ** 1413 ** regApp+0: slot to copy min()/max() argument to for MakeRecord 1414 ** regApp+1: integer value used to ensure keys are unique 1415 ** regApp+2: output of MakeRecord 1416 */ 1417 ExprList *pList = pWin->pOwner->x.pList; 1418 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pList, 0, 0); 1419 pWin->csrApp = pParse->nTab++; 1420 pWin->regApp = pParse->nMem+1; 1421 pParse->nMem += 3; 1422 if( pKeyInfo && pWin->pFunc->zName[1]=='i' ){ 1423 assert( pKeyInfo->aSortFlags[0]==0 ); 1424 pKeyInfo->aSortFlags[0] = KEYINFO_ORDER_DESC; 1425 } 1426 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pWin->csrApp, 2); 1427 sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO); 1428 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1); 1429 } 1430 else if( p->zName==nth_valueName || p->zName==first_valueName ){ 1431 /* Allocate two registers at pWin->regApp. These will be used to 1432 ** store the start and end index of the current frame. */ 1433 pWin->regApp = pParse->nMem+1; 1434 pWin->csrApp = pParse->nTab++; 1435 pParse->nMem += 2; 1436 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr); 1437 } 1438 else if( p->zName==leadName || p->zName==lagName ){ 1439 pWin->csrApp = pParse->nTab++; 1440 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr); 1441 } 1442 } 1443 } 1444 1445 #define WINDOW_STARTING_INT 0 1446 #define WINDOW_ENDING_INT 1 1447 #define WINDOW_NTH_VALUE_INT 2 1448 #define WINDOW_STARTING_NUM 3 1449 #define WINDOW_ENDING_NUM 4 1450 1451 /* 1452 ** A "PRECEDING <expr>" (eCond==0) or "FOLLOWING <expr>" (eCond==1) or the 1453 ** value of the second argument to nth_value() (eCond==2) has just been 1454 ** evaluated and the result left in register reg. This function generates VM 1455 ** code to check that the value is a non-negative integer and throws an 1456 ** exception if it is not. 1457 */ 1458 static void windowCheckValue(Parse *pParse, int reg, int eCond){ 1459 static const char *azErr[] = { 1460 "frame starting offset must be a non-negative integer", 1461 "frame ending offset must be a non-negative integer", 1462 "second argument to nth_value must be a positive integer", 1463 "frame starting offset must be a non-negative number", 1464 "frame ending offset must be a non-negative number", 1465 }; 1466 static int aOp[] = { OP_Ge, OP_Ge, OP_Gt, OP_Ge, OP_Ge }; 1467 Vdbe *v = sqlite3GetVdbe(pParse); 1468 int regZero = sqlite3GetTempReg(pParse); 1469 assert( eCond>=0 && eCond<ArraySize(azErr) ); 1470 sqlite3VdbeAddOp2(v, OP_Integer, 0, regZero); 1471 if( eCond>=WINDOW_STARTING_NUM ){ 1472 int regString = sqlite3GetTempReg(pParse); 1473 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC); 1474 sqlite3VdbeAddOp3(v, OP_Ge, regString, sqlite3VdbeCurrentAddr(v)+2, reg); 1475 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC|SQLITE_JUMPIFNULL); 1476 VdbeCoverage(v); 1477 assert( eCond==3 || eCond==4 ); 1478 VdbeCoverageIf(v, eCond==3); 1479 VdbeCoverageIf(v, eCond==4); 1480 }else{ 1481 sqlite3VdbeAddOp2(v, OP_MustBeInt, reg, sqlite3VdbeCurrentAddr(v)+2); 1482 VdbeCoverage(v); 1483 assert( eCond==0 || eCond==1 || eCond==2 ); 1484 VdbeCoverageIf(v, eCond==0); 1485 VdbeCoverageIf(v, eCond==1); 1486 VdbeCoverageIf(v, eCond==2); 1487 } 1488 sqlite3VdbeAddOp3(v, aOp[eCond], regZero, sqlite3VdbeCurrentAddr(v)+2, reg); 1489 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC); 1490 VdbeCoverageNeverNullIf(v, eCond==0); /* NULL case captured by */ 1491 VdbeCoverageNeverNullIf(v, eCond==1); /* the OP_MustBeInt */ 1492 VdbeCoverageNeverNullIf(v, eCond==2); 1493 VdbeCoverageNeverNullIf(v, eCond==3); /* NULL case caught by */ 1494 VdbeCoverageNeverNullIf(v, eCond==4); /* the OP_Ge */ 1495 sqlite3MayAbort(pParse); 1496 sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_ERROR, OE_Abort); 1497 sqlite3VdbeAppendP4(v, (void*)azErr[eCond], P4_STATIC); 1498 sqlite3ReleaseTempReg(pParse, regZero); 1499 } 1500 1501 /* 1502 ** Return the number of arguments passed to the window-function associated 1503 ** with the object passed as the only argument to this function. 1504 */ 1505 static int windowArgCount(Window *pWin){ 1506 ExprList *pList = pWin->pOwner->x.pList; 1507 return (pList ? pList->nExpr : 0); 1508 } 1509 1510 typedef struct WindowCodeArg WindowCodeArg; 1511 typedef struct WindowCsrAndReg WindowCsrAndReg; 1512 1513 /* 1514 ** See comments above struct WindowCodeArg. 1515 */ 1516 struct WindowCsrAndReg { 1517 int csr; /* Cursor number */ 1518 int reg; /* First in array of peer values */ 1519 }; 1520 1521 /* 1522 ** A single instance of this structure is allocated on the stack by 1523 ** sqlite3WindowCodeStep() and a pointer to it passed to the various helper 1524 ** routines. This is to reduce the number of arguments required by each 1525 ** helper function. 1526 ** 1527 ** regArg: 1528 ** Each window function requires an accumulator register (just as an 1529 ** ordinary aggregate function does). This variable is set to the first 1530 ** in an array of accumulator registers - one for each window function 1531 ** in the WindowCodeArg.pMWin list. 1532 ** 1533 ** eDelete: 1534 ** The window functions implementation sometimes caches the input rows 1535 ** that it processes in a temporary table. If it is not zero, this 1536 ** variable indicates when rows may be removed from the temp table (in 1537 ** order to reduce memory requirements - it would always be safe just 1538 ** to leave them there). Possible values for eDelete are: 1539 ** 1540 ** WINDOW_RETURN_ROW: 1541 ** An input row can be discarded after it is returned to the caller. 1542 ** 1543 ** WINDOW_AGGINVERSE: 1544 ** An input row can be discarded after the window functions xInverse() 1545 ** callbacks have been invoked in it. 1546 ** 1547 ** WINDOW_AGGSTEP: 1548 ** An input row can be discarded after the window functions xStep() 1549 ** callbacks have been invoked in it. 1550 ** 1551 ** start,current,end 1552 ** Consider a window-frame similar to the following: 1553 ** 1554 ** (ORDER BY a, b GROUPS BETWEEN 2 PRECEDING AND 2 FOLLOWING) 1555 ** 1556 ** The windows functions implmentation caches the input rows in a temp 1557 ** table, sorted by "a, b" (it actually populates the cache lazily, and 1558 ** aggressively removes rows once they are no longer required, but that's 1559 ** a mere detail). It keeps three cursors open on the temp table. One 1560 ** (current) that points to the next row to return to the query engine 1561 ** once its window function values have been calculated. Another (end) 1562 ** points to the next row to call the xStep() method of each window function 1563 ** on (so that it is 2 groups ahead of current). And a third (start) that 1564 ** points to the next row to call the xInverse() method of each window 1565 ** function on. 1566 ** 1567 ** Each cursor (start, current and end) consists of a VDBE cursor 1568 ** (WindowCsrAndReg.csr) and an array of registers (starting at 1569 ** WindowCodeArg.reg) that always contains a copy of the peer values 1570 ** read from the corresponding cursor. 1571 ** 1572 ** Depending on the window-frame in question, all three cursors may not 1573 ** be required. In this case both WindowCodeArg.csr and reg are set to 1574 ** 0. 1575 */ 1576 struct WindowCodeArg { 1577 Parse *pParse; /* Parse context */ 1578 Window *pMWin; /* First in list of functions being processed */ 1579 Vdbe *pVdbe; /* VDBE object */ 1580 int addrGosub; /* OP_Gosub to this address to return one row */ 1581 int regGosub; /* Register used with OP_Gosub(addrGosub) */ 1582 int regArg; /* First in array of accumulator registers */ 1583 int eDelete; /* See above */ 1584 int regRowid; 1585 1586 WindowCsrAndReg start; 1587 WindowCsrAndReg current; 1588 WindowCsrAndReg end; 1589 }; 1590 1591 /* 1592 ** Generate VM code to read the window frames peer values from cursor csr into 1593 ** an array of registers starting at reg. 1594 */ 1595 static void windowReadPeerValues( 1596 WindowCodeArg *p, 1597 int csr, 1598 int reg 1599 ){ 1600 Window *pMWin = p->pMWin; 1601 ExprList *pOrderBy = pMWin->pOrderBy; 1602 if( pOrderBy ){ 1603 Vdbe *v = sqlite3GetVdbe(p->pParse); 1604 ExprList *pPart = pMWin->pPartition; 1605 int iColOff = pMWin->nBufferCol + (pPart ? pPart->nExpr : 0); 1606 int i; 1607 for(i=0; i<pOrderBy->nExpr; i++){ 1608 sqlite3VdbeAddOp3(v, OP_Column, csr, iColOff+i, reg+i); 1609 } 1610 } 1611 } 1612 1613 /* 1614 ** Generate VM code to invoke either xStep() (if bInverse is 0) or 1615 ** xInverse (if bInverse is non-zero) for each window function in the 1616 ** linked list starting at pMWin. Or, for built-in window functions 1617 ** that do not use the standard function API, generate the required 1618 ** inline VM code. 1619 ** 1620 ** If argument csr is greater than or equal to 0, then argument reg is 1621 ** the first register in an array of registers guaranteed to be large 1622 ** enough to hold the array of arguments for each function. In this case 1623 ** the arguments are extracted from the current row of csr into the 1624 ** array of registers before invoking OP_AggStep or OP_AggInverse 1625 ** 1626 ** Or, if csr is less than zero, then the array of registers at reg is 1627 ** already populated with all columns from the current row of the sub-query. 1628 ** 1629 ** If argument regPartSize is non-zero, then it is a register containing the 1630 ** number of rows in the current partition. 1631 */ 1632 static void windowAggStep( 1633 WindowCodeArg *p, 1634 Window *pMWin, /* Linked list of window functions */ 1635 int csr, /* Read arguments from this cursor */ 1636 int bInverse, /* True to invoke xInverse instead of xStep */ 1637 int reg /* Array of registers */ 1638 ){ 1639 Parse *pParse = p->pParse; 1640 Vdbe *v = sqlite3GetVdbe(pParse); 1641 Window *pWin; 1642 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1643 FuncDef *pFunc = pWin->pFunc; 1644 int regArg; 1645 int nArg = pWin->bExprArgs ? 0 : windowArgCount(pWin); 1646 int i; 1647 1648 assert( bInverse==0 || pWin->eStart!=TK_UNBOUNDED ); 1649 1650 /* All OVER clauses in the same window function aggregate step must 1651 ** be the same. */ 1652 assert( pWin==pMWin || sqlite3WindowCompare(pParse,pWin,pMWin,0)!=1 ); 1653 1654 for(i=0; i<nArg; i++){ 1655 if( i!=1 || pFunc->zName!=nth_valueName ){ 1656 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+i, reg+i); 1657 }else{ 1658 sqlite3VdbeAddOp3(v, OP_Column, pMWin->iEphCsr, pWin->iArgCol+i, reg+i); 1659 } 1660 } 1661 regArg = reg; 1662 1663 if( pMWin->regStartRowid==0 1664 && (pFunc->funcFlags & SQLITE_FUNC_MINMAX) 1665 && (pWin->eStart!=TK_UNBOUNDED) 1666 ){ 1667 int addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regArg); 1668 VdbeCoverage(v); 1669 if( bInverse==0 ){ 1670 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1, 1); 1671 sqlite3VdbeAddOp2(v, OP_SCopy, regArg, pWin->regApp); 1672 sqlite3VdbeAddOp3(v, OP_MakeRecord, pWin->regApp, 2, pWin->regApp+2); 1673 sqlite3VdbeAddOp2(v, OP_IdxInsert, pWin->csrApp, pWin->regApp+2); 1674 }else{ 1675 sqlite3VdbeAddOp4Int(v, OP_SeekGE, pWin->csrApp, 0, regArg, 1); 1676 VdbeCoverageNeverTaken(v); 1677 sqlite3VdbeAddOp1(v, OP_Delete, pWin->csrApp); 1678 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2); 1679 } 1680 sqlite3VdbeJumpHere(v, addrIsNull); 1681 }else if( pWin->regApp ){ 1682 assert( pFunc->zName==nth_valueName 1683 || pFunc->zName==first_valueName 1684 ); 1685 assert( bInverse==0 || bInverse==1 ); 1686 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1-bInverse, 1); 1687 }else if( pFunc->xSFunc!=noopStepFunc ){ 1688 int addrIf = 0; 1689 if( pWin->pFilter ){ 1690 int regTmp; 1691 assert( pWin->bExprArgs || !nArg ||nArg==pWin->pOwner->x.pList->nExpr ); 1692 assert( pWin->bExprArgs || nArg ||pWin->pOwner->x.pList==0 ); 1693 regTmp = sqlite3GetTempReg(pParse); 1694 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+nArg,regTmp); 1695 addrIf = sqlite3VdbeAddOp3(v, OP_IfNot, regTmp, 0, 1); 1696 VdbeCoverage(v); 1697 sqlite3ReleaseTempReg(pParse, regTmp); 1698 } 1699 1700 if( pWin->bExprArgs ){ 1701 int iOp = sqlite3VdbeCurrentAddr(v); 1702 int iEnd; 1703 1704 nArg = pWin->pOwner->x.pList->nExpr; 1705 regArg = sqlite3GetTempRange(pParse, nArg); 1706 sqlite3ExprCodeExprList(pParse, pWin->pOwner->x.pList, regArg, 0, 0); 1707 1708 for(iEnd=sqlite3VdbeCurrentAddr(v); iOp<iEnd; iOp++){ 1709 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOp); 1710 if( pOp->opcode==OP_Column && pOp->p1==pWin->iEphCsr ){ 1711 pOp->p1 = csr; 1712 } 1713 } 1714 } 1715 if( pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){ 1716 CollSeq *pColl; 1717 assert( nArg>0 ); 1718 pColl = sqlite3ExprNNCollSeq(pParse, pWin->pOwner->x.pList->a[0].pExpr); 1719 sqlite3VdbeAddOp4(v, OP_CollSeq, 0,0,0, (const char*)pColl, P4_COLLSEQ); 1720 } 1721 sqlite3VdbeAddOp3(v, bInverse? OP_AggInverse : OP_AggStep, 1722 bInverse, regArg, pWin->regAccum); 1723 sqlite3VdbeAppendP4(v, pFunc, P4_FUNCDEF); 1724 sqlite3VdbeChangeP5(v, (u8)nArg); 1725 if( pWin->bExprArgs ){ 1726 sqlite3ReleaseTempRange(pParse, regArg, nArg); 1727 } 1728 if( addrIf ) sqlite3VdbeJumpHere(v, addrIf); 1729 } 1730 } 1731 } 1732 1733 /* 1734 ** Values that may be passed as the second argument to windowCodeOp(). 1735 */ 1736 #define WINDOW_RETURN_ROW 1 1737 #define WINDOW_AGGINVERSE 2 1738 #define WINDOW_AGGSTEP 3 1739 1740 /* 1741 ** Generate VM code to invoke either xValue() (bFin==0) or xFinalize() 1742 ** (bFin==1) for each window function in the linked list starting at 1743 ** pMWin. Or, for built-in window-functions that do not use the standard 1744 ** API, generate the equivalent VM code. 1745 */ 1746 static void windowAggFinal(WindowCodeArg *p, int bFin){ 1747 Parse *pParse = p->pParse; 1748 Window *pMWin = p->pMWin; 1749 Vdbe *v = sqlite3GetVdbe(pParse); 1750 Window *pWin; 1751 1752 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1753 if( pMWin->regStartRowid==0 1754 && (pWin->pFunc->funcFlags & SQLITE_FUNC_MINMAX) 1755 && (pWin->eStart!=TK_UNBOUNDED) 1756 ){ 1757 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult); 1758 sqlite3VdbeAddOp1(v, OP_Last, pWin->csrApp); 1759 VdbeCoverage(v); 1760 sqlite3VdbeAddOp3(v, OP_Column, pWin->csrApp, 0, pWin->regResult); 1761 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2); 1762 }else if( pWin->regApp ){ 1763 assert( pMWin->regStartRowid==0 ); 1764 }else{ 1765 int nArg = windowArgCount(pWin); 1766 if( bFin ){ 1767 sqlite3VdbeAddOp2(v, OP_AggFinal, pWin->regAccum, nArg); 1768 sqlite3VdbeAppendP4(v, pWin->pFunc, P4_FUNCDEF); 1769 sqlite3VdbeAddOp2(v, OP_Copy, pWin->regAccum, pWin->regResult); 1770 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum); 1771 }else{ 1772 sqlite3VdbeAddOp3(v, OP_AggValue,pWin->regAccum,nArg,pWin->regResult); 1773 sqlite3VdbeAppendP4(v, pWin->pFunc, P4_FUNCDEF); 1774 } 1775 } 1776 } 1777 } 1778 1779 /* 1780 ** Generate code to calculate the current values of all window functions in the 1781 ** p->pMWin list by doing a full scan of the current window frame. Store the 1782 ** results in the Window.regResult registers, ready to return the upper 1783 ** layer. 1784 */ 1785 static void windowFullScan(WindowCodeArg *p){ 1786 Window *pWin; 1787 Parse *pParse = p->pParse; 1788 Window *pMWin = p->pMWin; 1789 Vdbe *v = p->pVdbe; 1790 1791 int regCRowid = 0; /* Current rowid value */ 1792 int regCPeer = 0; /* Current peer values */ 1793 int regRowid = 0; /* AggStep rowid value */ 1794 int regPeer = 0; /* AggStep peer values */ 1795 1796 int nPeer; 1797 int lblNext; 1798 int lblBrk; 1799 int addrNext; 1800 int csr; 1801 1802 VdbeModuleComment((v, "windowFullScan begin")); 1803 1804 assert( pMWin!=0 ); 1805 csr = pMWin->csrApp; 1806 nPeer = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0); 1807 1808 lblNext = sqlite3VdbeMakeLabel(pParse); 1809 lblBrk = sqlite3VdbeMakeLabel(pParse); 1810 1811 regCRowid = sqlite3GetTempReg(pParse); 1812 regRowid = sqlite3GetTempReg(pParse); 1813 if( nPeer ){ 1814 regCPeer = sqlite3GetTempRange(pParse, nPeer); 1815 regPeer = sqlite3GetTempRange(pParse, nPeer); 1816 } 1817 1818 sqlite3VdbeAddOp2(v, OP_Rowid, pMWin->iEphCsr, regCRowid); 1819 windowReadPeerValues(p, pMWin->iEphCsr, regCPeer); 1820 1821 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1822 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum); 1823 } 1824 1825 sqlite3VdbeAddOp3(v, OP_SeekGE, csr, lblBrk, pMWin->regStartRowid); 1826 VdbeCoverage(v); 1827 addrNext = sqlite3VdbeCurrentAddr(v); 1828 sqlite3VdbeAddOp2(v, OP_Rowid, csr, regRowid); 1829 sqlite3VdbeAddOp3(v, OP_Gt, pMWin->regEndRowid, lblBrk, regRowid); 1830 VdbeCoverageNeverNull(v); 1831 1832 if( pMWin->eExclude==TK_CURRENT ){ 1833 sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, lblNext, regRowid); 1834 VdbeCoverageNeverNull(v); 1835 }else if( pMWin->eExclude!=TK_NO ){ 1836 int addr; 1837 int addrEq = 0; 1838 KeyInfo *pKeyInfo = 0; 1839 1840 if( pMWin->pOrderBy ){ 1841 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pMWin->pOrderBy, 0, 0); 1842 } 1843 if( pMWin->eExclude==TK_TIES ){ 1844 addrEq = sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, 0, regRowid); 1845 VdbeCoverageNeverNull(v); 1846 } 1847 if( pKeyInfo ){ 1848 windowReadPeerValues(p, csr, regPeer); 1849 sqlite3VdbeAddOp3(v, OP_Compare, regPeer, regCPeer, nPeer); 1850 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO); 1851 addr = sqlite3VdbeCurrentAddr(v)+1; 1852 sqlite3VdbeAddOp3(v, OP_Jump, addr, lblNext, addr); 1853 VdbeCoverageEqNe(v); 1854 }else{ 1855 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblNext); 1856 } 1857 if( addrEq ) sqlite3VdbeJumpHere(v, addrEq); 1858 } 1859 1860 windowAggStep(p, pMWin, csr, 0, p->regArg); 1861 1862 sqlite3VdbeResolveLabel(v, lblNext); 1863 sqlite3VdbeAddOp2(v, OP_Next, csr, addrNext); 1864 VdbeCoverage(v); 1865 sqlite3VdbeJumpHere(v, addrNext-1); 1866 sqlite3VdbeJumpHere(v, addrNext+1); 1867 sqlite3ReleaseTempReg(pParse, regRowid); 1868 sqlite3ReleaseTempReg(pParse, regCRowid); 1869 if( nPeer ){ 1870 sqlite3ReleaseTempRange(pParse, regPeer, nPeer); 1871 sqlite3ReleaseTempRange(pParse, regCPeer, nPeer); 1872 } 1873 1874 windowAggFinal(p, 1); 1875 VdbeModuleComment((v, "windowFullScan end")); 1876 } 1877 1878 /* 1879 ** Invoke the sub-routine at regGosub (generated by code in select.c) to 1880 ** return the current row of Window.iEphCsr. If all window functions are 1881 ** aggregate window functions that use the standard API, a single 1882 ** OP_Gosub instruction is all that this routine generates. Extra VM code 1883 ** for per-row processing is only generated for the following built-in window 1884 ** functions: 1885 ** 1886 ** nth_value() 1887 ** first_value() 1888 ** lag() 1889 ** lead() 1890 */ 1891 static void windowReturnOneRow(WindowCodeArg *p){ 1892 Window *pMWin = p->pMWin; 1893 Vdbe *v = p->pVdbe; 1894 1895 if( pMWin->regStartRowid ){ 1896 windowFullScan(p); 1897 }else{ 1898 Parse *pParse = p->pParse; 1899 Window *pWin; 1900 1901 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1902 FuncDef *pFunc = pWin->pFunc; 1903 if( pFunc->zName==nth_valueName 1904 || pFunc->zName==first_valueName 1905 ){ 1906 int csr = pWin->csrApp; 1907 int lbl = sqlite3VdbeMakeLabel(pParse); 1908 int tmpReg = sqlite3GetTempReg(pParse); 1909 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult); 1910 1911 if( pFunc->zName==nth_valueName ){ 1912 sqlite3VdbeAddOp3(v, OP_Column,pMWin->iEphCsr,pWin->iArgCol+1,tmpReg); 1913 windowCheckValue(pParse, tmpReg, 2); 1914 }else{ 1915 sqlite3VdbeAddOp2(v, OP_Integer, 1, tmpReg); 1916 } 1917 sqlite3VdbeAddOp3(v, OP_Add, tmpReg, pWin->regApp, tmpReg); 1918 sqlite3VdbeAddOp3(v, OP_Gt, pWin->regApp+1, lbl, tmpReg); 1919 VdbeCoverageNeverNull(v); 1920 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, 0, tmpReg); 1921 VdbeCoverageNeverTaken(v); 1922 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult); 1923 sqlite3VdbeResolveLabel(v, lbl); 1924 sqlite3ReleaseTempReg(pParse, tmpReg); 1925 } 1926 else if( pFunc->zName==leadName || pFunc->zName==lagName ){ 1927 int nArg = pWin->pOwner->x.pList->nExpr; 1928 int csr = pWin->csrApp; 1929 int lbl = sqlite3VdbeMakeLabel(pParse); 1930 int tmpReg = sqlite3GetTempReg(pParse); 1931 int iEph = pMWin->iEphCsr; 1932 1933 if( nArg<3 ){ 1934 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult); 1935 }else{ 1936 sqlite3VdbeAddOp3(v, OP_Column, iEph,pWin->iArgCol+2,pWin->regResult); 1937 } 1938 sqlite3VdbeAddOp2(v, OP_Rowid, iEph, tmpReg); 1939 if( nArg<2 ){ 1940 int val = (pFunc->zName==leadName ? 1 : -1); 1941 sqlite3VdbeAddOp2(v, OP_AddImm, tmpReg, val); 1942 }else{ 1943 int op = (pFunc->zName==leadName ? OP_Add : OP_Subtract); 1944 int tmpReg2 = sqlite3GetTempReg(pParse); 1945 sqlite3VdbeAddOp3(v, OP_Column, iEph, pWin->iArgCol+1, tmpReg2); 1946 sqlite3VdbeAddOp3(v, op, tmpReg2, tmpReg, tmpReg); 1947 sqlite3ReleaseTempReg(pParse, tmpReg2); 1948 } 1949 1950 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, lbl, tmpReg); 1951 VdbeCoverage(v); 1952 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult); 1953 sqlite3VdbeResolveLabel(v, lbl); 1954 sqlite3ReleaseTempReg(pParse, tmpReg); 1955 } 1956 } 1957 } 1958 sqlite3VdbeAddOp2(v, OP_Gosub, p->regGosub, p->addrGosub); 1959 } 1960 1961 /* 1962 ** Generate code to set the accumulator register for each window function 1963 ** in the linked list passed as the second argument to NULL. And perform 1964 ** any equivalent initialization required by any built-in window functions 1965 ** in the list. 1966 */ 1967 static int windowInitAccum(Parse *pParse, Window *pMWin){ 1968 Vdbe *v = sqlite3GetVdbe(pParse); 1969 int regArg; 1970 int nArg = 0; 1971 Window *pWin; 1972 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 1973 FuncDef *pFunc = pWin->pFunc; 1974 assert( pWin->regAccum ); 1975 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum); 1976 nArg = MAX(nArg, windowArgCount(pWin)); 1977 if( pMWin->regStartRowid==0 ){ 1978 if( pFunc->zName==nth_valueName || pFunc->zName==first_valueName ){ 1979 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp); 1980 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1); 1981 } 1982 1983 if( (pFunc->funcFlags & SQLITE_FUNC_MINMAX) && pWin->csrApp ){ 1984 assert( pWin->eStart!=TK_UNBOUNDED ); 1985 sqlite3VdbeAddOp1(v, OP_ResetSorter, pWin->csrApp); 1986 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1); 1987 } 1988 } 1989 } 1990 regArg = pParse->nMem+1; 1991 pParse->nMem += nArg; 1992 return regArg; 1993 } 1994 1995 /* 1996 ** Return true if the current frame should be cached in the ephemeral table, 1997 ** even if there are no xInverse() calls required. 1998 */ 1999 static int windowCacheFrame(Window *pMWin){ 2000 Window *pWin; 2001 if( pMWin->regStartRowid ) return 1; 2002 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){ 2003 FuncDef *pFunc = pWin->pFunc; 2004 if( (pFunc->zName==nth_valueName) 2005 || (pFunc->zName==first_valueName) 2006 || (pFunc->zName==leadName) 2007 || (pFunc->zName==lagName) 2008 ){ 2009 return 1; 2010 } 2011 } 2012 return 0; 2013 } 2014 2015 /* 2016 ** regOld and regNew are each the first register in an array of size 2017 ** pOrderBy->nExpr. This function generates code to compare the two 2018 ** arrays of registers using the collation sequences and other comparison 2019 ** parameters specified by pOrderBy. 2020 ** 2021 ** If the two arrays are not equal, the contents of regNew is copied to 2022 ** regOld and control falls through. Otherwise, if the contents of the arrays 2023 ** are equal, an OP_Goto is executed. The address of the OP_Goto is returned. 2024 */ 2025 static void windowIfNewPeer( 2026 Parse *pParse, 2027 ExprList *pOrderBy, 2028 int regNew, /* First in array of new values */ 2029 int regOld, /* First in array of old values */ 2030 int addr /* Jump here */ 2031 ){ 2032 Vdbe *v = sqlite3GetVdbe(pParse); 2033 if( pOrderBy ){ 2034 int nVal = pOrderBy->nExpr; 2035 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pOrderBy, 0, 0); 2036 sqlite3VdbeAddOp3(v, OP_Compare, regOld, regNew, nVal); 2037 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO); 2038 sqlite3VdbeAddOp3(v, OP_Jump, 2039 sqlite3VdbeCurrentAddr(v)+1, addr, sqlite3VdbeCurrentAddr(v)+1 2040 ); 2041 VdbeCoverageEqNe(v); 2042 sqlite3VdbeAddOp3(v, OP_Copy, regNew, regOld, nVal-1); 2043 }else{ 2044 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr); 2045 } 2046 } 2047 2048 /* 2049 ** This function is called as part of generating VM programs for RANGE 2050 ** offset PRECEDING/FOLLOWING frame boundaries. Assuming "ASC" order for 2051 ** the ORDER BY term in the window, and that argument op is OP_Ge, it generates 2052 ** code equivalent to: 2053 ** 2054 ** if( csr1.peerVal + regVal >= csr2.peerVal ) goto lbl; 2055 ** 2056 ** The value of parameter op may also be OP_Gt or OP_Le. In these cases the 2057 ** operator in the above pseudo-code is replaced with ">" or "<=", respectively. 2058 ** 2059 ** If the sort-order for the ORDER BY term in the window is DESC, then the 2060 ** comparison is reversed. Instead of adding regVal to csr1.peerVal, it is 2061 ** subtracted. And the comparison operator is inverted to - ">=" becomes "<=", 2062 ** ">" becomes "<", and so on. So, with DESC sort order, if the argument op 2063 ** is OP_Ge, the generated code is equivalent to: 2064 ** 2065 ** if( csr1.peerVal - regVal <= csr2.peerVal ) goto lbl; 2066 ** 2067 ** A special type of arithmetic is used such that if csr1.peerVal is not 2068 ** a numeric type (real or integer), then the result of the addition 2069 ** or subtraction is a a copy of csr1.peerVal. 2070 */ 2071 static void windowCodeRangeTest( 2072 WindowCodeArg *p, 2073 int op, /* OP_Ge, OP_Gt, or OP_Le */ 2074 int csr1, /* Cursor number for cursor 1 */ 2075 int regVal, /* Register containing non-negative number */ 2076 int csr2, /* Cursor number for cursor 2 */ 2077 int lbl /* Jump destination if condition is true */ 2078 ){ 2079 Parse *pParse = p->pParse; 2080 Vdbe *v = sqlite3GetVdbe(pParse); 2081 ExprList *pOrderBy = p->pMWin->pOrderBy; /* ORDER BY clause for window */ 2082 int reg1 = sqlite3GetTempReg(pParse); /* Reg. for csr1.peerVal+regVal */ 2083 int reg2 = sqlite3GetTempReg(pParse); /* Reg. for csr2.peerVal */ 2084 int regString = ++pParse->nMem; /* Reg. for constant value '' */ 2085 int arith = OP_Add; /* OP_Add or OP_Subtract */ 2086 int addrGe; /* Jump destination */ 2087 int addrDone = sqlite3VdbeMakeLabel(pParse); /* Address past OP_Ge */ 2088 CollSeq *pColl; 2089 2090 /* Read the peer-value from each cursor into a register */ 2091 windowReadPeerValues(p, csr1, reg1); 2092 windowReadPeerValues(p, csr2, reg2); 2093 2094 assert( op==OP_Ge || op==OP_Gt || op==OP_Le ); 2095 assert( pOrderBy && pOrderBy->nExpr==1 ); 2096 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_DESC ){ 2097 switch( op ){ 2098 case OP_Ge: op = OP_Le; break; 2099 case OP_Gt: op = OP_Lt; break; 2100 default: assert( op==OP_Le ); op = OP_Ge; break; 2101 } 2102 arith = OP_Subtract; 2103 } 2104 2105 VdbeModuleComment((v, "CodeRangeTest: if( R%d %s R%d %s R%d ) goto lbl", 2106 reg1, (arith==OP_Add ? "+" : "-"), regVal, 2107 ((op==OP_Ge) ? ">=" : (op==OP_Le) ? "<=" : (op==OP_Gt) ? ">" : "<"), reg2 2108 )); 2109 2110 /* If the BIGNULL flag is set for the ORDER BY, then it is required to 2111 ** consider NULL values to be larger than all other values, instead of 2112 ** the usual smaller. The VDBE opcodes OP_Ge and so on do not handle this 2113 ** (and adding that capability causes a performance regression), so 2114 ** instead if the BIGNULL flag is set then cases where either reg1 or 2115 ** reg2 are NULL are handled separately in the following block. The code 2116 ** generated is equivalent to: 2117 ** 2118 ** if( reg1 IS NULL ){ 2119 ** if( op==OP_Ge ) goto lbl; 2120 ** if( op==OP_Gt && reg2 IS NOT NULL ) goto lbl; 2121 ** if( op==OP_Le && reg2 IS NULL ) goto lbl; 2122 ** }else if( reg2 IS NULL ){ 2123 ** if( op==OP_Le ) goto lbl; 2124 ** } 2125 ** 2126 ** Additionally, if either reg1 or reg2 are NULL but the jump to lbl is 2127 ** not taken, control jumps over the comparison operator coded below this 2128 ** block. */ 2129 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_BIGNULL ){ 2130 /* This block runs if reg1 contains a NULL. */ 2131 int addr = sqlite3VdbeAddOp1(v, OP_NotNull, reg1); VdbeCoverage(v); 2132 switch( op ){ 2133 case OP_Ge: 2134 sqlite3VdbeAddOp2(v, OP_Goto, 0, lbl); 2135 break; 2136 case OP_Gt: 2137 sqlite3VdbeAddOp2(v, OP_NotNull, reg2, lbl); 2138 VdbeCoverage(v); 2139 break; 2140 case OP_Le: 2141 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl); 2142 VdbeCoverage(v); 2143 break; 2144 default: assert( op==OP_Lt ); /* no-op */ break; 2145 } 2146 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone); 2147 2148 /* This block runs if reg1 is not NULL, but reg2 is. */ 2149 sqlite3VdbeJumpHere(v, addr); 2150 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl); VdbeCoverage(v); 2151 if( op==OP_Gt || op==OP_Ge ){ 2152 sqlite3VdbeChangeP2(v, -1, addrDone); 2153 } 2154 } 2155 2156 /* Register reg1 currently contains csr1.peerVal (the peer-value from csr1). 2157 ** This block adds (or subtracts for DESC) the numeric value in regVal 2158 ** from it. Or, if reg1 is not numeric (it is a NULL, a text value or a blob), 2159 ** then leave reg1 as it is. In pseudo-code, this is implemented as: 2160 ** 2161 ** if( reg1>='' ) goto addrGe; 2162 ** reg1 = reg1 +/- regVal 2163 ** addrGe: 2164 ** 2165 ** Since all strings and blobs are greater-than-or-equal-to an empty string, 2166 ** the add/subtract is skipped for these, as required. If reg1 is a NULL, 2167 ** then the arithmetic is performed, but since adding or subtracting from 2168 ** NULL is always NULL anyway, this case is handled as required too. */ 2169 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC); 2170 addrGe = sqlite3VdbeAddOp3(v, OP_Ge, regString, 0, reg1); 2171 VdbeCoverage(v); 2172 if( (op==OP_Ge && arith==OP_Add) || (op==OP_Le && arith==OP_Subtract) ){ 2173 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v); 2174 } 2175 sqlite3VdbeAddOp3(v, arith, regVal, reg1, reg1); 2176 sqlite3VdbeJumpHere(v, addrGe); 2177 2178 /* Compare registers reg2 and reg1, taking the jump if required. Note that 2179 ** control skips over this test if the BIGNULL flag is set and either 2180 ** reg1 or reg2 contain a NULL value. */ 2181 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v); 2182 pColl = sqlite3ExprNNCollSeq(pParse, pOrderBy->a[0].pExpr); 2183 sqlite3VdbeAppendP4(v, (void*)pColl, P4_COLLSEQ); 2184 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ); 2185 sqlite3VdbeResolveLabel(v, addrDone); 2186 2187 assert( op==OP_Ge || op==OP_Gt || op==OP_Lt || op==OP_Le ); 2188 testcase(op==OP_Ge); VdbeCoverageIf(v, op==OP_Ge); 2189 testcase(op==OP_Lt); VdbeCoverageIf(v, op==OP_Lt); 2190 testcase(op==OP_Le); VdbeCoverageIf(v, op==OP_Le); 2191 testcase(op==OP_Gt); VdbeCoverageIf(v, op==OP_Gt); 2192 sqlite3ReleaseTempReg(pParse, reg1); 2193 sqlite3ReleaseTempReg(pParse, reg2); 2194 2195 VdbeModuleComment((v, "CodeRangeTest: end")); 2196 } 2197 2198 /* 2199 ** Helper function for sqlite3WindowCodeStep(). Each call to this function 2200 ** generates VM code for a single RETURN_ROW, AGGSTEP or AGGINVERSE 2201 ** operation. Refer to the header comment for sqlite3WindowCodeStep() for 2202 ** details. 2203 */ 2204 static int windowCodeOp( 2205 WindowCodeArg *p, /* Context object */ 2206 int op, /* WINDOW_RETURN_ROW, AGGSTEP or AGGINVERSE */ 2207 int regCountdown, /* Register for OP_IfPos countdown */ 2208 int jumpOnEof /* Jump here if stepped cursor reaches EOF */ 2209 ){ 2210 int csr, reg; 2211 Parse *pParse = p->pParse; 2212 Window *pMWin = p->pMWin; 2213 int ret = 0; 2214 Vdbe *v = p->pVdbe; 2215 int addrContinue = 0; 2216 int bPeer = (pMWin->eFrmType!=TK_ROWS); 2217 2218 int lblDone = sqlite3VdbeMakeLabel(pParse); 2219 int addrNextRange = 0; 2220 2221 /* Special case - WINDOW_AGGINVERSE is always a no-op if the frame 2222 ** starts with UNBOUNDED PRECEDING. */ 2223 if( op==WINDOW_AGGINVERSE && pMWin->eStart==TK_UNBOUNDED ){ 2224 assert( regCountdown==0 && jumpOnEof==0 ); 2225 return 0; 2226 } 2227 2228 if( regCountdown>0 ){ 2229 if( pMWin->eFrmType==TK_RANGE ){ 2230 addrNextRange = sqlite3VdbeCurrentAddr(v); 2231 assert( op==WINDOW_AGGINVERSE || op==WINDOW_AGGSTEP ); 2232 if( op==WINDOW_AGGINVERSE ){ 2233 if( pMWin->eStart==TK_FOLLOWING ){ 2234 windowCodeRangeTest( 2235 p, OP_Le, p->current.csr, regCountdown, p->start.csr, lblDone 2236 ); 2237 }else{ 2238 windowCodeRangeTest( 2239 p, OP_Ge, p->start.csr, regCountdown, p->current.csr, lblDone 2240 ); 2241 } 2242 }else{ 2243 windowCodeRangeTest( 2244 p, OP_Gt, p->end.csr, regCountdown, p->current.csr, lblDone 2245 ); 2246 } 2247 }else{ 2248 sqlite3VdbeAddOp3(v, OP_IfPos, regCountdown, lblDone, 1); 2249 VdbeCoverage(v); 2250 } 2251 } 2252 2253 if( op==WINDOW_RETURN_ROW && pMWin->regStartRowid==0 ){ 2254 windowAggFinal(p, 0); 2255 } 2256 addrContinue = sqlite3VdbeCurrentAddr(v); 2257 2258 /* If this is a (RANGE BETWEEN a FOLLOWING AND b FOLLOWING) or 2259 ** (RANGE BETWEEN b PRECEDING AND a PRECEDING) frame, ensure the 2260 ** start cursor does not advance past the end cursor within the 2261 ** temporary table. It otherwise might, if (a>b). Also ensure that, 2262 ** if the input cursor is still finding new rows, that the end 2263 ** cursor does not go past it to EOF. */ 2264 if( pMWin->eStart==pMWin->eEnd && regCountdown 2265 && pMWin->eFrmType==TK_RANGE 2266 ){ 2267 int regRowid1 = sqlite3GetTempReg(pParse); 2268 int regRowid2 = sqlite3GetTempReg(pParse); 2269 if( op==WINDOW_AGGINVERSE ){ 2270 sqlite3VdbeAddOp2(v, OP_Rowid, p->start.csr, regRowid1); 2271 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid2); 2272 sqlite3VdbeAddOp3(v, OP_Ge, regRowid2, lblDone, regRowid1); 2273 VdbeCoverage(v); 2274 }else if( p->regRowid ){ 2275 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid1); 2276 sqlite3VdbeAddOp3(v, OP_Ge, p->regRowid, lblDone, regRowid1); 2277 VdbeCoverageNeverNull(v); 2278 } 2279 sqlite3ReleaseTempReg(pParse, regRowid1); 2280 sqlite3ReleaseTempReg(pParse, regRowid2); 2281 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING ); 2282 } 2283 2284 switch( op ){ 2285 case WINDOW_RETURN_ROW: 2286 csr = p->current.csr; 2287 reg = p->current.reg; 2288 windowReturnOneRow(p); 2289 break; 2290 2291 case WINDOW_AGGINVERSE: 2292 csr = p->start.csr; 2293 reg = p->start.reg; 2294 if( pMWin->regStartRowid ){ 2295 assert( pMWin->regEndRowid ); 2296 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regStartRowid, 1); 2297 }else{ 2298 windowAggStep(p, pMWin, csr, 1, p->regArg); 2299 } 2300 break; 2301 2302 default: 2303 assert( op==WINDOW_AGGSTEP ); 2304 csr = p->end.csr; 2305 reg = p->end.reg; 2306 if( pMWin->regStartRowid ){ 2307 assert( pMWin->regEndRowid ); 2308 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regEndRowid, 1); 2309 }else{ 2310 windowAggStep(p, pMWin, csr, 0, p->regArg); 2311 } 2312 break; 2313 } 2314 2315 if( op==p->eDelete ){ 2316 sqlite3VdbeAddOp1(v, OP_Delete, csr); 2317 sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION); 2318 } 2319 2320 if( jumpOnEof ){ 2321 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+2); 2322 VdbeCoverage(v); 2323 ret = sqlite3VdbeAddOp0(v, OP_Goto); 2324 }else{ 2325 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+1+bPeer); 2326 VdbeCoverage(v); 2327 if( bPeer ){ 2328 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblDone); 2329 } 2330 } 2331 2332 if( bPeer ){ 2333 int nReg = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0); 2334 int regTmp = (nReg ? sqlite3GetTempRange(pParse, nReg) : 0); 2335 windowReadPeerValues(p, csr, regTmp); 2336 windowIfNewPeer(pParse, pMWin->pOrderBy, regTmp, reg, addrContinue); 2337 sqlite3ReleaseTempRange(pParse, regTmp, nReg); 2338 } 2339 2340 if( addrNextRange ){ 2341 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNextRange); 2342 } 2343 sqlite3VdbeResolveLabel(v, lblDone); 2344 return ret; 2345 } 2346 2347 2348 /* 2349 ** Allocate and return a duplicate of the Window object indicated by the 2350 ** third argument. Set the Window.pOwner field of the new object to 2351 ** pOwner. 2352 */ 2353 Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p){ 2354 Window *pNew = 0; 2355 if( ALWAYS(p) ){ 2356 pNew = sqlite3DbMallocZero(db, sizeof(Window)); 2357 if( pNew ){ 2358 pNew->zName = sqlite3DbStrDup(db, p->zName); 2359 pNew->zBase = sqlite3DbStrDup(db, p->zBase); 2360 pNew->pFilter = sqlite3ExprDup(db, p->pFilter, 0); 2361 pNew->pFunc = p->pFunc; 2362 pNew->pPartition = sqlite3ExprListDup(db, p->pPartition, 0); 2363 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, 0); 2364 pNew->eFrmType = p->eFrmType; 2365 pNew->eEnd = p->eEnd; 2366 pNew->eStart = p->eStart; 2367 pNew->eExclude = p->eExclude; 2368 pNew->regResult = p->regResult; 2369 pNew->regAccum = p->regAccum; 2370 pNew->iArgCol = p->iArgCol; 2371 pNew->iEphCsr = p->iEphCsr; 2372 pNew->bExprArgs = p->bExprArgs; 2373 pNew->pStart = sqlite3ExprDup(db, p->pStart, 0); 2374 pNew->pEnd = sqlite3ExprDup(db, p->pEnd, 0); 2375 pNew->pOwner = pOwner; 2376 pNew->bImplicitFrame = p->bImplicitFrame; 2377 } 2378 } 2379 return pNew; 2380 } 2381 2382 /* 2383 ** Return a copy of the linked list of Window objects passed as the 2384 ** second argument. 2385 */ 2386 Window *sqlite3WindowListDup(sqlite3 *db, Window *p){ 2387 Window *pWin; 2388 Window *pRet = 0; 2389 Window **pp = &pRet; 2390 2391 for(pWin=p; pWin; pWin=pWin->pNextWin){ 2392 *pp = sqlite3WindowDup(db, 0, pWin); 2393 if( *pp==0 ) break; 2394 pp = &((*pp)->pNextWin); 2395 } 2396 2397 return pRet; 2398 } 2399 2400 /* 2401 ** Return true if it can be determined at compile time that expression 2402 ** pExpr evaluates to a value that, when cast to an integer, is greater 2403 ** than zero. False otherwise. 2404 ** 2405 ** If an OOM error occurs, this function sets the Parse.db.mallocFailed 2406 ** flag and returns zero. 2407 */ 2408 static int windowExprGtZero(Parse *pParse, Expr *pExpr){ 2409 int ret = 0; 2410 sqlite3 *db = pParse->db; 2411 sqlite3_value *pVal = 0; 2412 sqlite3ValueFromExpr(db, pExpr, db->enc, SQLITE_AFF_NUMERIC, &pVal); 2413 if( pVal && sqlite3_value_int(pVal)>0 ){ 2414 ret = 1; 2415 } 2416 sqlite3ValueFree(pVal); 2417 return ret; 2418 } 2419 2420 /* 2421 ** sqlite3WhereBegin() has already been called for the SELECT statement 2422 ** passed as the second argument when this function is invoked. It generates 2423 ** code to populate the Window.regResult register for each window function 2424 ** and invoke the sub-routine at instruction addrGosub once for each row. 2425 ** sqlite3WhereEnd() is always called before returning. 2426 ** 2427 ** This function handles several different types of window frames, which 2428 ** require slightly different processing. The following pseudo code is 2429 ** used to implement window frames of the form: 2430 ** 2431 ** ROWS BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING 2432 ** 2433 ** Other window frame types use variants of the following: 2434 ** 2435 ** ... loop started by sqlite3WhereBegin() ... 2436 ** if( new partition ){ 2437 ** Gosub flush 2438 ** } 2439 ** Insert new row into eph table. 2440 ** 2441 ** if( first row of partition ){ 2442 ** // Rewind three cursors, all open on the eph table. 2443 ** Rewind(csrEnd); 2444 ** Rewind(csrStart); 2445 ** Rewind(csrCurrent); 2446 ** 2447 ** regEnd = <expr2> // FOLLOWING expression 2448 ** regStart = <expr1> // PRECEDING expression 2449 ** }else{ 2450 ** // First time this branch is taken, the eph table contains two 2451 ** // rows. The first row in the partition, which all three cursors 2452 ** // currently point to, and the following row. 2453 ** AGGSTEP 2454 ** if( (regEnd--)<=0 ){ 2455 ** RETURN_ROW 2456 ** if( (regStart--)<=0 ){ 2457 ** AGGINVERSE 2458 ** } 2459 ** } 2460 ** } 2461 ** } 2462 ** flush: 2463 ** AGGSTEP 2464 ** while( 1 ){ 2465 ** RETURN ROW 2466 ** if( csrCurrent is EOF ) break; 2467 ** if( (regStart--)<=0 ){ 2468 ** AggInverse(csrStart) 2469 ** Next(csrStart) 2470 ** } 2471 ** } 2472 ** 2473 ** The pseudo-code above uses the following shorthand: 2474 ** 2475 ** AGGSTEP: invoke the aggregate xStep() function for each window function 2476 ** with arguments read from the current row of cursor csrEnd, then 2477 ** step cursor csrEnd forward one row (i.e. sqlite3BtreeNext()). 2478 ** 2479 ** RETURN_ROW: return a row to the caller based on the contents of the 2480 ** current row of csrCurrent and the current state of all 2481 ** aggregates. Then step cursor csrCurrent forward one row. 2482 ** 2483 ** AGGINVERSE: invoke the aggregate xInverse() function for each window 2484 ** functions with arguments read from the current row of cursor 2485 ** csrStart. Then step csrStart forward one row. 2486 ** 2487 ** There are two other ROWS window frames that are handled significantly 2488 ** differently from the above - "BETWEEN <expr> PRECEDING AND <expr> PRECEDING" 2489 ** and "BETWEEN <expr> FOLLOWING AND <expr> FOLLOWING". These are special 2490 ** cases because they change the order in which the three cursors (csrStart, 2491 ** csrCurrent and csrEnd) iterate through the ephemeral table. Cases that 2492 ** use UNBOUNDED or CURRENT ROW are much simpler variations on one of these 2493 ** three. 2494 ** 2495 ** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING 2496 ** 2497 ** ... loop started by sqlite3WhereBegin() ... 2498 ** if( new partition ){ 2499 ** Gosub flush 2500 ** } 2501 ** Insert new row into eph table. 2502 ** if( first row of partition ){ 2503 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2504 ** regEnd = <expr2> 2505 ** regStart = <expr1> 2506 ** }else{ 2507 ** if( (regEnd--)<=0 ){ 2508 ** AGGSTEP 2509 ** } 2510 ** RETURN_ROW 2511 ** if( (regStart--)<=0 ){ 2512 ** AGGINVERSE 2513 ** } 2514 ** } 2515 ** } 2516 ** flush: 2517 ** if( (regEnd--)<=0 ){ 2518 ** AGGSTEP 2519 ** } 2520 ** RETURN_ROW 2521 ** 2522 ** 2523 ** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING 2524 ** 2525 ** ... loop started by sqlite3WhereBegin() ... 2526 ** if( new partition ){ 2527 ** Gosub flush 2528 ** } 2529 ** Insert new row into eph table. 2530 ** if( first row of partition ){ 2531 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2532 ** regEnd = <expr2> 2533 ** regStart = regEnd - <expr1> 2534 ** }else{ 2535 ** AGGSTEP 2536 ** if( (regEnd--)<=0 ){ 2537 ** RETURN_ROW 2538 ** } 2539 ** if( (regStart--)<=0 ){ 2540 ** AGGINVERSE 2541 ** } 2542 ** } 2543 ** } 2544 ** flush: 2545 ** AGGSTEP 2546 ** while( 1 ){ 2547 ** if( (regEnd--)<=0 ){ 2548 ** RETURN_ROW 2549 ** if( eof ) break; 2550 ** } 2551 ** if( (regStart--)<=0 ){ 2552 ** AGGINVERSE 2553 ** if( eof ) break 2554 ** } 2555 ** } 2556 ** while( !eof csrCurrent ){ 2557 ** RETURN_ROW 2558 ** } 2559 ** 2560 ** For the most part, the patterns above are adapted to support UNBOUNDED by 2561 ** assuming that it is equivalent to "infinity PRECEDING/FOLLOWING" and 2562 ** CURRENT ROW by assuming that it is equivilent to "0 PRECEDING/FOLLOWING". 2563 ** This is optimized of course - branches that will never be taken and 2564 ** conditions that are always true are omitted from the VM code. The only 2565 ** exceptional case is: 2566 ** 2567 ** ROWS BETWEEN <expr1> FOLLOWING AND UNBOUNDED FOLLOWING 2568 ** 2569 ** ... loop started by sqlite3WhereBegin() ... 2570 ** if( new partition ){ 2571 ** Gosub flush 2572 ** } 2573 ** Insert new row into eph table. 2574 ** if( first row of partition ){ 2575 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2576 ** regStart = <expr1> 2577 ** }else{ 2578 ** AGGSTEP 2579 ** } 2580 ** } 2581 ** flush: 2582 ** AGGSTEP 2583 ** while( 1 ){ 2584 ** if( (regStart--)<=0 ){ 2585 ** AGGINVERSE 2586 ** if( eof ) break 2587 ** } 2588 ** RETURN_ROW 2589 ** } 2590 ** while( !eof csrCurrent ){ 2591 ** RETURN_ROW 2592 ** } 2593 ** 2594 ** Also requiring special handling are the cases: 2595 ** 2596 ** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING 2597 ** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING 2598 ** 2599 ** when (expr1 < expr2). This is detected at runtime, not by this function. 2600 ** To handle this case, the pseudo-code programs depicted above are modified 2601 ** slightly to be: 2602 ** 2603 ** ... loop started by sqlite3WhereBegin() ... 2604 ** if( new partition ){ 2605 ** Gosub flush 2606 ** } 2607 ** Insert new row into eph table. 2608 ** if( first row of partition ){ 2609 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2610 ** regEnd = <expr2> 2611 ** regStart = <expr1> 2612 ** if( regEnd < regStart ){ 2613 ** RETURN_ROW 2614 ** delete eph table contents 2615 ** continue 2616 ** } 2617 ** ... 2618 ** 2619 ** The new "continue" statement in the above jumps to the next iteration 2620 ** of the outer loop - the one started by sqlite3WhereBegin(). 2621 ** 2622 ** The various GROUPS cases are implemented using the same patterns as 2623 ** ROWS. The VM code is modified slightly so that: 2624 ** 2625 ** 1. The else branch in the main loop is only taken if the row just 2626 ** added to the ephemeral table is the start of a new group. In 2627 ** other words, it becomes: 2628 ** 2629 ** ... loop started by sqlite3WhereBegin() ... 2630 ** if( new partition ){ 2631 ** Gosub flush 2632 ** } 2633 ** Insert new row into eph table. 2634 ** if( first row of partition ){ 2635 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2636 ** regEnd = <expr2> 2637 ** regStart = <expr1> 2638 ** }else if( new group ){ 2639 ** ... 2640 ** } 2641 ** } 2642 ** 2643 ** 2. Instead of processing a single row, each RETURN_ROW, AGGSTEP or 2644 ** AGGINVERSE step processes the current row of the relevant cursor and 2645 ** all subsequent rows belonging to the same group. 2646 ** 2647 ** RANGE window frames are a little different again. As for GROUPS, the 2648 ** main loop runs once per group only. And RETURN_ROW, AGGSTEP and AGGINVERSE 2649 ** deal in groups instead of rows. As for ROWS and GROUPS, there are three 2650 ** basic cases: 2651 ** 2652 ** RANGE BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING 2653 ** 2654 ** ... loop started by sqlite3WhereBegin() ... 2655 ** if( new partition ){ 2656 ** Gosub flush 2657 ** } 2658 ** Insert new row into eph table. 2659 ** if( first row of partition ){ 2660 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2661 ** regEnd = <expr2> 2662 ** regStart = <expr1> 2663 ** }else{ 2664 ** AGGSTEP 2665 ** while( (csrCurrent.key + regEnd) < csrEnd.key ){ 2666 ** RETURN_ROW 2667 ** while( csrStart.key + regStart) < csrCurrent.key ){ 2668 ** AGGINVERSE 2669 ** } 2670 ** } 2671 ** } 2672 ** } 2673 ** flush: 2674 ** AGGSTEP 2675 ** while( 1 ){ 2676 ** RETURN ROW 2677 ** if( csrCurrent is EOF ) break; 2678 ** while( csrStart.key + regStart) < csrCurrent.key ){ 2679 ** AGGINVERSE 2680 ** } 2681 ** } 2682 ** } 2683 ** 2684 ** In the above notation, "csr.key" means the current value of the ORDER BY 2685 ** expression (there is only ever 1 for a RANGE that uses an <expr> FOLLOWING 2686 ** or <expr PRECEDING) read from cursor csr. 2687 ** 2688 ** RANGE BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING 2689 ** 2690 ** ... loop started by sqlite3WhereBegin() ... 2691 ** if( new partition ){ 2692 ** Gosub flush 2693 ** } 2694 ** Insert new row into eph table. 2695 ** if( first row of partition ){ 2696 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2697 ** regEnd = <expr2> 2698 ** regStart = <expr1> 2699 ** }else{ 2700 ** while( (csrEnd.key + regEnd) <= csrCurrent.key ){ 2701 ** AGGSTEP 2702 ** } 2703 ** while( (csrStart.key + regStart) < csrCurrent.key ){ 2704 ** AGGINVERSE 2705 ** } 2706 ** RETURN_ROW 2707 ** } 2708 ** } 2709 ** flush: 2710 ** while( (csrEnd.key + regEnd) <= csrCurrent.key ){ 2711 ** AGGSTEP 2712 ** } 2713 ** while( (csrStart.key + regStart) < csrCurrent.key ){ 2714 ** AGGINVERSE 2715 ** } 2716 ** RETURN_ROW 2717 ** 2718 ** RANGE BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING 2719 ** 2720 ** ... loop started by sqlite3WhereBegin() ... 2721 ** if( new partition ){ 2722 ** Gosub flush 2723 ** } 2724 ** Insert new row into eph table. 2725 ** if( first row of partition ){ 2726 ** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent) 2727 ** regEnd = <expr2> 2728 ** regStart = <expr1> 2729 ** }else{ 2730 ** AGGSTEP 2731 ** while( (csrCurrent.key + regEnd) < csrEnd.key ){ 2732 ** while( (csrCurrent.key + regStart) > csrStart.key ){ 2733 ** AGGINVERSE 2734 ** } 2735 ** RETURN_ROW 2736 ** } 2737 ** } 2738 ** } 2739 ** flush: 2740 ** AGGSTEP 2741 ** while( 1 ){ 2742 ** while( (csrCurrent.key + regStart) > csrStart.key ){ 2743 ** AGGINVERSE 2744 ** if( eof ) break "while( 1 )" loop. 2745 ** } 2746 ** RETURN_ROW 2747 ** } 2748 ** while( !eof csrCurrent ){ 2749 ** RETURN_ROW 2750 ** } 2751 ** 2752 ** The text above leaves out many details. Refer to the code and comments 2753 ** below for a more complete picture. 2754 */ 2755 void sqlite3WindowCodeStep( 2756 Parse *pParse, /* Parse context */ 2757 Select *p, /* Rewritten SELECT statement */ 2758 WhereInfo *pWInfo, /* Context returned by sqlite3WhereBegin() */ 2759 int regGosub, /* Register for OP_Gosub */ 2760 int addrGosub /* OP_Gosub here to return each row */ 2761 ){ 2762 Window *pMWin = p->pWin; 2763 ExprList *pOrderBy = pMWin->pOrderBy; 2764 Vdbe *v = sqlite3GetVdbe(pParse); 2765 int csrWrite; /* Cursor used to write to eph. table */ 2766 int csrInput = p->pSrc->a[0].iCursor; /* Cursor of sub-select */ 2767 int nInput = p->pSrc->a[0].pTab->nCol; /* Number of cols returned by sub */ 2768 int iInput; /* To iterate through sub cols */ 2769 int addrNe; /* Address of OP_Ne */ 2770 int addrGosubFlush = 0; /* Address of OP_Gosub to flush: */ 2771 int addrInteger = 0; /* Address of OP_Integer */ 2772 int addrEmpty; /* Address of OP_Rewind in flush: */ 2773 int regNew; /* Array of registers holding new input row */ 2774 int regRecord; /* regNew array in record form */ 2775 int regNewPeer = 0; /* Peer values for new row (part of regNew) */ 2776 int regPeer = 0; /* Peer values for current row */ 2777 int regFlushPart = 0; /* Register for "Gosub flush_partition" */ 2778 WindowCodeArg s; /* Context object for sub-routines */ 2779 int lblWhereEnd; /* Label just before sqlite3WhereEnd() code */ 2780 int regStart = 0; /* Value of <expr> PRECEDING */ 2781 int regEnd = 0; /* Value of <expr> FOLLOWING */ 2782 2783 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_CURRENT 2784 || pMWin->eStart==TK_FOLLOWING || pMWin->eStart==TK_UNBOUNDED 2785 ); 2786 assert( pMWin->eEnd==TK_FOLLOWING || pMWin->eEnd==TK_CURRENT 2787 || pMWin->eEnd==TK_UNBOUNDED || pMWin->eEnd==TK_PRECEDING 2788 ); 2789 assert( pMWin->eExclude==0 || pMWin->eExclude==TK_CURRENT 2790 || pMWin->eExclude==TK_GROUP || pMWin->eExclude==TK_TIES 2791 || pMWin->eExclude==TK_NO 2792 ); 2793 2794 lblWhereEnd = sqlite3VdbeMakeLabel(pParse); 2795 2796 /* Fill in the context object */ 2797 memset(&s, 0, sizeof(WindowCodeArg)); 2798 s.pParse = pParse; 2799 s.pMWin = pMWin; 2800 s.pVdbe = v; 2801 s.regGosub = regGosub; 2802 s.addrGosub = addrGosub; 2803 s.current.csr = pMWin->iEphCsr; 2804 csrWrite = s.current.csr+1; 2805 s.start.csr = s.current.csr+2; 2806 s.end.csr = s.current.csr+3; 2807 2808 /* Figure out when rows may be deleted from the ephemeral table. There 2809 ** are four options - they may never be deleted (eDelete==0), they may 2810 ** be deleted as soon as they are no longer part of the window frame 2811 ** (eDelete==WINDOW_AGGINVERSE), they may be deleted as after the row 2812 ** has been returned to the caller (WINDOW_RETURN_ROW), or they may 2813 ** be deleted after they enter the frame (WINDOW_AGGSTEP). */ 2814 switch( pMWin->eStart ){ 2815 case TK_FOLLOWING: 2816 if( pMWin->eFrmType!=TK_RANGE 2817 && windowExprGtZero(pParse, pMWin->pStart) 2818 ){ 2819 s.eDelete = WINDOW_RETURN_ROW; 2820 } 2821 break; 2822 case TK_UNBOUNDED: 2823 if( windowCacheFrame(pMWin)==0 ){ 2824 if( pMWin->eEnd==TK_PRECEDING ){ 2825 if( pMWin->eFrmType!=TK_RANGE 2826 && windowExprGtZero(pParse, pMWin->pEnd) 2827 ){ 2828 s.eDelete = WINDOW_AGGSTEP; 2829 } 2830 }else{ 2831 s.eDelete = WINDOW_RETURN_ROW; 2832 } 2833 } 2834 break; 2835 default: 2836 s.eDelete = WINDOW_AGGINVERSE; 2837 break; 2838 } 2839 2840 /* Allocate registers for the array of values from the sub-query, the 2841 ** samve values in record form, and the rowid used to insert said record 2842 ** into the ephemeral table. */ 2843 regNew = pParse->nMem+1; 2844 pParse->nMem += nInput; 2845 regRecord = ++pParse->nMem; 2846 s.regRowid = ++pParse->nMem; 2847 2848 /* If the window frame contains an "<expr> PRECEDING" or "<expr> FOLLOWING" 2849 ** clause, allocate registers to store the results of evaluating each 2850 ** <expr>. */ 2851 if( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING ){ 2852 regStart = ++pParse->nMem; 2853 } 2854 if( pMWin->eEnd==TK_PRECEDING || pMWin->eEnd==TK_FOLLOWING ){ 2855 regEnd = ++pParse->nMem; 2856 } 2857 2858 /* If this is not a "ROWS BETWEEN ..." frame, then allocate arrays of 2859 ** registers to store copies of the ORDER BY expressions (peer values) 2860 ** for the main loop, and for each cursor (start, current and end). */ 2861 if( pMWin->eFrmType!=TK_ROWS ){ 2862 int nPeer = (pOrderBy ? pOrderBy->nExpr : 0); 2863 regNewPeer = regNew + pMWin->nBufferCol; 2864 if( pMWin->pPartition ) regNewPeer += pMWin->pPartition->nExpr; 2865 regPeer = pParse->nMem+1; pParse->nMem += nPeer; 2866 s.start.reg = pParse->nMem+1; pParse->nMem += nPeer; 2867 s.current.reg = pParse->nMem+1; pParse->nMem += nPeer; 2868 s.end.reg = pParse->nMem+1; pParse->nMem += nPeer; 2869 } 2870 2871 /* Load the column values for the row returned by the sub-select 2872 ** into an array of registers starting at regNew. Assemble them into 2873 ** a record in register regRecord. */ 2874 for(iInput=0; iInput<nInput; iInput++){ 2875 sqlite3VdbeAddOp3(v, OP_Column, csrInput, iInput, regNew+iInput); 2876 } 2877 sqlite3VdbeAddOp3(v, OP_MakeRecord, regNew, nInput, regRecord); 2878 2879 /* An input row has just been read into an array of registers starting 2880 ** at regNew. If the window has a PARTITION clause, this block generates 2881 ** VM code to check if the input row is the start of a new partition. 2882 ** If so, it does an OP_Gosub to an address to be filled in later. The 2883 ** address of the OP_Gosub is stored in local variable addrGosubFlush. */ 2884 if( pMWin->pPartition ){ 2885 int addr; 2886 ExprList *pPart = pMWin->pPartition; 2887 int nPart = pPart->nExpr; 2888 int regNewPart = regNew + pMWin->nBufferCol; 2889 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pPart, 0, 0); 2890 2891 regFlushPart = ++pParse->nMem; 2892 addr = sqlite3VdbeAddOp3(v, OP_Compare, regNewPart, pMWin->regPart, nPart); 2893 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO); 2894 sqlite3VdbeAddOp3(v, OP_Jump, addr+2, addr+4, addr+2); 2895 VdbeCoverageEqNe(v); 2896 addrGosubFlush = sqlite3VdbeAddOp1(v, OP_Gosub, regFlushPart); 2897 VdbeComment((v, "call flush_partition")); 2898 sqlite3VdbeAddOp3(v, OP_Copy, regNewPart, pMWin->regPart, nPart-1); 2899 } 2900 2901 /* Insert the new row into the ephemeral table */ 2902 sqlite3VdbeAddOp2(v, OP_NewRowid, csrWrite, s.regRowid); 2903 sqlite3VdbeAddOp3(v, OP_Insert, csrWrite, regRecord, s.regRowid); 2904 addrNe = sqlite3VdbeAddOp3(v, OP_Ne, pMWin->regOne, 0, s.regRowid); 2905 VdbeCoverageNeverNull(v); 2906 2907 /* This block is run for the first row of each partition */ 2908 s.regArg = windowInitAccum(pParse, pMWin); 2909 2910 if( regStart ){ 2911 sqlite3ExprCode(pParse, pMWin->pStart, regStart); 2912 windowCheckValue(pParse, regStart, 0 + (pMWin->eFrmType==TK_RANGE?3:0)); 2913 } 2914 if( regEnd ){ 2915 sqlite3ExprCode(pParse, pMWin->pEnd, regEnd); 2916 windowCheckValue(pParse, regEnd, 1 + (pMWin->eFrmType==TK_RANGE?3:0)); 2917 } 2918 2919 if( pMWin->eFrmType!=TK_RANGE && pMWin->eStart==pMWin->eEnd && regStart ){ 2920 int op = ((pMWin->eStart==TK_FOLLOWING) ? OP_Ge : OP_Le); 2921 int addrGe = sqlite3VdbeAddOp3(v, op, regStart, 0, regEnd); 2922 VdbeCoverageNeverNullIf(v, op==OP_Ge); /* NeverNull because bound <expr> */ 2923 VdbeCoverageNeverNullIf(v, op==OP_Le); /* values previously checked */ 2924 windowAggFinal(&s, 0); 2925 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1); 2926 VdbeCoverageNeverTaken(v); 2927 windowReturnOneRow(&s); 2928 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr); 2929 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd); 2930 sqlite3VdbeJumpHere(v, addrGe); 2931 } 2932 if( pMWin->eStart==TK_FOLLOWING && pMWin->eFrmType!=TK_RANGE && regEnd ){ 2933 assert( pMWin->eEnd==TK_FOLLOWING ); 2934 sqlite3VdbeAddOp3(v, OP_Subtract, regStart, regEnd, regStart); 2935 } 2936 2937 if( pMWin->eStart!=TK_UNBOUNDED ){ 2938 sqlite3VdbeAddOp2(v, OP_Rewind, s.start.csr, 1); 2939 VdbeCoverageNeverTaken(v); 2940 } 2941 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1); 2942 VdbeCoverageNeverTaken(v); 2943 sqlite3VdbeAddOp2(v, OP_Rewind, s.end.csr, 1); 2944 VdbeCoverageNeverTaken(v); 2945 if( regPeer && pOrderBy ){ 2946 sqlite3VdbeAddOp3(v, OP_Copy, regNewPeer, regPeer, pOrderBy->nExpr-1); 2947 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.start.reg, pOrderBy->nExpr-1); 2948 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.current.reg, pOrderBy->nExpr-1); 2949 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.end.reg, pOrderBy->nExpr-1); 2950 } 2951 2952 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd); 2953 2954 sqlite3VdbeJumpHere(v, addrNe); 2955 2956 /* Beginning of the block executed for the second and subsequent rows. */ 2957 if( regPeer ){ 2958 windowIfNewPeer(pParse, pOrderBy, regNewPeer, regPeer, lblWhereEnd); 2959 } 2960 if( pMWin->eStart==TK_FOLLOWING ){ 2961 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0); 2962 if( pMWin->eEnd!=TK_UNBOUNDED ){ 2963 if( pMWin->eFrmType==TK_RANGE ){ 2964 int lbl = sqlite3VdbeMakeLabel(pParse); 2965 int addrNext = sqlite3VdbeCurrentAddr(v); 2966 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl); 2967 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 2968 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0); 2969 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNext); 2970 sqlite3VdbeResolveLabel(v, lbl); 2971 }else{ 2972 windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 0); 2973 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 2974 } 2975 } 2976 }else 2977 if( pMWin->eEnd==TK_PRECEDING ){ 2978 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE); 2979 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0); 2980 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 2981 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0); 2982 if( !bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 2983 }else{ 2984 int addr = 0; 2985 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0); 2986 if( pMWin->eEnd!=TK_UNBOUNDED ){ 2987 if( pMWin->eFrmType==TK_RANGE ){ 2988 int lbl = 0; 2989 addr = sqlite3VdbeCurrentAddr(v); 2990 if( regEnd ){ 2991 lbl = sqlite3VdbeMakeLabel(pParse); 2992 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl); 2993 } 2994 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0); 2995 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 2996 if( regEnd ){ 2997 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr); 2998 sqlite3VdbeResolveLabel(v, lbl); 2999 } 3000 }else{ 3001 if( regEnd ){ 3002 addr = sqlite3VdbeAddOp3(v, OP_IfPos, regEnd, 0, 1); 3003 VdbeCoverage(v); 3004 } 3005 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0); 3006 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 3007 if( regEnd ) sqlite3VdbeJumpHere(v, addr); 3008 } 3009 } 3010 } 3011 3012 /* End of the main input loop */ 3013 sqlite3VdbeResolveLabel(v, lblWhereEnd); 3014 sqlite3WhereEnd(pWInfo); 3015 3016 /* Fall through */ 3017 if( pMWin->pPartition ){ 3018 addrInteger = sqlite3VdbeAddOp2(v, OP_Integer, 0, regFlushPart); 3019 sqlite3VdbeJumpHere(v, addrGosubFlush); 3020 } 3021 3022 s.regRowid = 0; 3023 addrEmpty = sqlite3VdbeAddOp1(v, OP_Rewind, csrWrite); 3024 VdbeCoverage(v); 3025 if( pMWin->eEnd==TK_PRECEDING ){ 3026 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE); 3027 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0); 3028 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 3029 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0); 3030 }else if( pMWin->eStart==TK_FOLLOWING ){ 3031 int addrStart; 3032 int addrBreak1; 3033 int addrBreak2; 3034 int addrBreak3; 3035 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0); 3036 if( pMWin->eFrmType==TK_RANGE ){ 3037 addrStart = sqlite3VdbeCurrentAddr(v); 3038 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1); 3039 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1); 3040 }else 3041 if( pMWin->eEnd==TK_UNBOUNDED ){ 3042 addrStart = sqlite3VdbeCurrentAddr(v); 3043 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regStart, 1); 3044 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, 0, 1); 3045 }else{ 3046 assert( pMWin->eEnd==TK_FOLLOWING ); 3047 addrStart = sqlite3VdbeCurrentAddr(v); 3048 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 1); 3049 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1); 3050 } 3051 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart); 3052 sqlite3VdbeJumpHere(v, addrBreak2); 3053 addrStart = sqlite3VdbeCurrentAddr(v); 3054 addrBreak3 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1); 3055 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart); 3056 sqlite3VdbeJumpHere(v, addrBreak1); 3057 sqlite3VdbeJumpHere(v, addrBreak3); 3058 }else{ 3059 int addrBreak; 3060 int addrStart; 3061 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0); 3062 addrStart = sqlite3VdbeCurrentAddr(v); 3063 addrBreak = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1); 3064 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0); 3065 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart); 3066 sqlite3VdbeJumpHere(v, addrBreak); 3067 } 3068 sqlite3VdbeJumpHere(v, addrEmpty); 3069 3070 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr); 3071 if( pMWin->pPartition ){ 3072 if( pMWin->regStartRowid ){ 3073 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid); 3074 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid); 3075 } 3076 sqlite3VdbeChangeP1(v, addrInteger, sqlite3VdbeCurrentAddr(v)); 3077 sqlite3VdbeAddOp1(v, OP_Return, regFlushPart); 3078 } 3079 } 3080 3081 #endif /* SQLITE_OMIT_WINDOWFUNC */ 3082