blob: 33e905e53fb8982f93eb54e93858c394ad76f5f0 [file] [log] [blame]
dan86fb6e12018-05-16 20:58:07 +00001/*
dan26522d12018-06-11 18:16:51 +00002** 2018 May 08
dan86fb6e12018-05-16 20:58:07 +00003**
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
dan67a9b8e2018-06-22 20:51:35 +000015#ifndef SQLITE_OMIT_WINDOWFUNC
16
dandfa552f2018-06-02 21:04:28 +000017/*
dan73925692018-06-12 18:40:17 +000018** 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.
danc0bb4452018-06-12 20:53:38 +0000134**
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.
dan73925692018-06-12 18:40:17 +0000139*/
140
141/*
dandfa552f2018-06-02 21:04:28 +0000142** 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*/
147static 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));
drh5d6374f2018-07-10 23:31:17 +0000153 if( p ) (*p)++;
drhc7bf5712018-07-09 22:49:01 +0000154 UNUSED_PARAMETER(nArg);
155 UNUSED_PARAMETER(apArg);
dandfa552f2018-06-02 21:04:28 +0000156}
dandfa552f2018-06-02 21:04:28 +0000157static 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/*
dan2a11bb22018-06-11 20:50:25 +0000163** Context object type used by rank(), dense_rank(), percent_rank() and
164** cume_dist().
dandfa552f2018-06-02 21:04:28 +0000165*/
166struct CallCount {
167 i64 nValue;
168 i64 nStep;
169 i64 nTotal;
170};
171
172/*
dan9c277582018-06-20 09:23:49 +0000173** 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
dandfa552f2018-06-02 21:04:28 +0000177*/
178static 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));
drh5d6374f2018-07-10 23:31:17 +0000185 if( p ) p->nStep = 1;
drhc7bf5712018-07-09 22:49:01 +0000186 UNUSED_PARAMETER(nArg);
187 UNUSED_PARAMETER(apArg);
dandfa552f2018-06-02 21:04:28 +0000188}
dandfa552f2018-06-02 21:04:28 +0000189static 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/*
dana0f6b832019-03-14 16:36:20 +0000202** 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*/
206struct NthValueCtx {
207 i64 nStep;
208 sqlite3_value *pValue;
209};
210static 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 ){
dan108e6b22019-03-18 18:55:35 +0000218 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
dana0f6b832019-03-14 16:36:20 +0000234 p->nStep++;
235 if( iVal==p->nStep ){
236 p->pValue = sqlite3_value_dup(apArg[0]);
dan108e6b22019-03-18 18:55:35 +0000237 if( !p->pValue ){
238 sqlite3_result_error_nomem(pCtx);
239 }
dana0f6b832019-03-14 16:36:20 +0000240 }
241 }
242 UNUSED_PARAMETER(nArg);
243 UNUSED_PARAMETER(apArg);
dan108e6b22019-03-18 18:55:35 +0000244 return;
245
246 error_out:
247 sqlite3_result_error(
248 pCtx, "second argument to nth_value must be a positive integer", -1
249 );
dana0f6b832019-03-14 16:36:20 +0000250}
dana0f6b832019-03-14 16:36:20 +0000251static void nth_valueFinalizeFunc(sqlite3_context *pCtx){
252 struct NthValueCtx *p;
dan0525b6f2019-03-18 21:19:40 +0000253 p = (struct NthValueCtx*)sqlite3_aggregate_context(pCtx, 0);
dana0f6b832019-03-14 16:36:20 +0000254 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
dan0525b6f2019-03-18 21:19:40 +0000261#define nth_valueValueFunc noopValueFunc
dana0f6b832019-03-14 16:36:20 +0000262
danc782a812019-03-15 20:46:19 +0000263static 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]);
dan108e6b22019-03-18 18:55:35 +0000272 if( !p->pValue ){
273 sqlite3_result_error_nomem(pCtx);
274 }
danc782a812019-03-15 20:46:19 +0000275 }
276 UNUSED_PARAMETER(nArg);
277 UNUSED_PARAMETER(apArg);
278}
danc782a812019-03-15 20:46:19 +0000279static 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
dan0525b6f2019-03-18 21:19:40 +0000289#define first_valueValueFunc noopValueFunc
danc782a812019-03-15 20:46:19 +0000290
dana0f6b832019-03-14 16:36:20 +0000291/*
dan9c277582018-06-20 09:23:49 +0000292** 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
dandfa552f2018-06-02 21:04:28 +0000296*/
297static 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));
drh5d6374f2018-07-10 23:31:17 +0000304 if( p ){
dandfa552f2018-06-02 21:04:28 +0000305 p->nStep++;
306 if( p->nValue==0 ){
307 p->nValue = p->nStep;
308 }
309 }
drhc7bf5712018-07-09 22:49:01 +0000310 UNUSED_PARAMETER(nArg);
311 UNUSED_PARAMETER(apArg);
dandfa552f2018-06-02 21:04:28 +0000312}
dandfa552f2018-06-02 21:04:28 +0000313static 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/*
dan9c277582018-06-20 09:23:49 +0000323** Implementation of built-in window function percent_rank(). Assumes that
324** the window frame has been set to:
325**
dancc7a8502019-03-11 19:50:54 +0000326** GROUPS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING
dandfa552f2018-06-02 21:04:28 +0000327*/
328static void percent_rankStepFunc(
329 sqlite3_context *pCtx,
330 int nArg,
331 sqlite3_value **apArg
332){
333 struct CallCount *p;
dancc7a8502019-03-11 19:50:54 +0000334 UNUSED_PARAMETER(nArg); assert( nArg==0 );
drhd4a591d2019-03-26 16:21:11 +0000335 UNUSED_PARAMETER(apArg);
dandfa552f2018-06-02 21:04:28 +0000336 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p));
drh5d6374f2018-07-10 23:31:17 +0000337 if( p ){
dancc7a8502019-03-11 19:50:54 +0000338 p->nTotal++;
dandfa552f2018-06-02 21:04:28 +0000339 }
340}
dancc7a8502019-03-11 19:50:54 +0000341static 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 );
drhd4a591d2019-03-26 16:21:11 +0000348 UNUSED_PARAMETER(apArg);
dancc7a8502019-03-11 19:50:54 +0000349 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p));
350 p->nStep++;
351}
dandfa552f2018-06-02 21:04:28 +0000352static void percent_rankValueFunc(sqlite3_context *pCtx){
353 struct CallCount *p;
354 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p));
355 if( p ){
dancc7a8502019-03-11 19:50:54 +0000356 p->nValue = p->nStep;
dandfa552f2018-06-02 21:04:28 +0000357 if( p->nTotal>1 ){
dancc7a8502019-03-11 19:50:54 +0000358 double r = (double)p->nValue / (double)(p->nTotal-1);
dandfa552f2018-06-02 21:04:28 +0000359 sqlite3_result_double(pCtx, r);
360 }else{
danb7306f62018-06-21 19:20:39 +0000361 sqlite3_result_double(pCtx, 0.0);
dandfa552f2018-06-02 21:04:28 +0000362 }
dandfa552f2018-06-02 21:04:28 +0000363 }
364}
dancc7a8502019-03-11 19:50:54 +0000365#define percent_rankFinalizeFunc percent_rankValueFunc
dandfa552f2018-06-02 21:04:28 +0000366
dan9c277582018-06-20 09:23:49 +0000367/*
368** Implementation of built-in window function cume_dist(). Assumes that
369** the window frame has been set to:
370**
dancc7a8502019-03-11 19:50:54 +0000371** GROUPS BETWEEN 1 FOLLOWING AND UNBOUNDED FOLLOWING
dan9c277582018-06-20 09:23:49 +0000372*/
danf1abe362018-06-04 08:22:09 +0000373static void cume_distStepFunc(
374 sqlite3_context *pCtx,
375 int nArg,
376 sqlite3_value **apArg
377){
378 struct CallCount *p;
dancc7a8502019-03-11 19:50:54 +0000379 UNUSED_PARAMETER(nArg); assert( nArg==0 );
drhd4a591d2019-03-26 16:21:11 +0000380 UNUSED_PARAMETER(apArg);
danf1abe362018-06-04 08:22:09 +0000381 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p));
drh5d6374f2018-07-10 23:31:17 +0000382 if( p ){
dancc7a8502019-03-11 19:50:54 +0000383 p->nTotal++;
danf1abe362018-06-04 08:22:09 +0000384 }
385}
dancc7a8502019-03-11 19:50:54 +0000386static 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 );
drhd4a591d2019-03-26 16:21:11 +0000393 UNUSED_PARAMETER(apArg);
dancc7a8502019-03-11 19:50:54 +0000394 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, sizeof(*p));
395 p->nStep++;
396}
danf1abe362018-06-04 08:22:09 +0000397static void cume_distValueFunc(sqlite3_context *pCtx){
398 struct CallCount *p;
dan0525b6f2019-03-18 21:19:40 +0000399 p = (struct CallCount*)sqlite3_aggregate_context(pCtx, 0);
400 if( p ){
danf1abe362018-06-04 08:22:09 +0000401 double r = (double)(p->nStep) / (double)(p->nTotal);
402 sqlite3_result_double(pCtx, r);
403 }
404}
dancc7a8502019-03-11 19:50:54 +0000405#define cume_distFinalizeFunc cume_distValueFunc
danf1abe362018-06-04 08:22:09 +0000406
dan2a11bb22018-06-11 20:50:25 +0000407/*
408** Context object for ntile() window function.
409*/
dan6bc5c9e2018-06-04 18:55:11 +0000410struct 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**
dancc7a8502019-03-11 19:50:54 +0000420** ROWS CURRENT ROW AND UNBOUNDED FOLLOWING
dan6bc5c9e2018-06-04 18:55:11 +0000421*/
422static void ntileStepFunc(
423 sqlite3_context *pCtx,
424 int nArg,
425 sqlite3_value **apArg
426){
427 struct NtileCtx *p;
dancc7a8502019-03-11 19:50:54 +0000428 assert( nArg==1 ); UNUSED_PARAMETER(nArg);
dan6bc5c9e2018-06-04 18:55:11 +0000429 p = (struct NtileCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p));
drh5d6374f2018-07-10 23:31:17 +0000430 if( p ){
dan6bc5c9e2018-06-04 18:55:11 +0000431 if( p->nTotal==0 ){
432 p->nParam = sqlite3_value_int64(apArg[0]);
dan6bc5c9e2018-06-04 18:55:11 +0000433 if( p->nParam<=0 ){
434 sqlite3_result_error(
435 pCtx, "argument of ntile must be a positive integer", -1
436 );
437 }
438 }
dancc7a8502019-03-11 19:50:54 +0000439 p->nTotal++;
dan6bc5c9e2018-06-04 18:55:11 +0000440 }
441}
dancc7a8502019-03-11 19:50:54 +0000442static 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);
drhd4a591d2019-03-26 16:21:11 +0000449 UNUSED_PARAMETER(apArg);
dancc7a8502019-03-11 19:50:54 +0000450 p = (struct NtileCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p));
451 p->iRow++;
452}
dan6bc5c9e2018-06-04 18:55:11 +0000453static 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 ){
dancc7a8502019-03-11 19:50:54 +0000459 sqlite3_result_int64(pCtx, p->iRow+1);
dan6bc5c9e2018-06-04 18:55:11 +0000460 }else{
461 i64 nLarge = p->nTotal - p->nParam*nSize;
462 i64 iSmall = nLarge*(nSize+1);
dancc7a8502019-03-11 19:50:54 +0000463 i64 iRow = p->iRow;
dan6bc5c9e2018-06-04 18:55:11 +0000464
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}
dancc7a8502019-03-11 19:50:54 +0000475#define ntileFinalizeFunc ntileValueFunc
dan6bc5c9e2018-06-04 18:55:11 +0000476
dan2a11bb22018-06-11 20:50:25 +0000477/*
478** Context object for last_value() window function.
479*/
dan1c5ed622018-06-05 16:16:17 +0000480struct LastValueCtx {
481 sqlite3_value *pVal;
482 int nVal;
483};
484
485/*
486** Implementation of last_value().
487*/
488static void last_valueStepFunc(
489 sqlite3_context *pCtx,
490 int nArg,
491 sqlite3_value **apArg
492){
493 struct LastValueCtx *p;
drhc7bf5712018-07-09 22:49:01 +0000494 UNUSED_PARAMETER(nArg);
dan9c277582018-06-20 09:23:49 +0000495 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p));
dan1c5ed622018-06-05 16:16:17 +0000496 if( p ){
497 sqlite3_value_free(p->pVal);
498 p->pVal = sqlite3_value_dup(apArg[0]);
dan6fde1792018-06-15 19:01:35 +0000499 if( p->pVal==0 ){
500 sqlite3_result_error_nomem(pCtx);
501 }else{
502 p->nVal++;
503 }
dan1c5ed622018-06-05 16:16:17 +0000504 }
505}
dan2a11bb22018-06-11 20:50:25 +0000506static void last_valueInvFunc(
dan1c5ed622018-06-05 16:16:17 +0000507 sqlite3_context *pCtx,
508 int nArg,
509 sqlite3_value **apArg
510){
511 struct LastValueCtx *p;
drhc7bf5712018-07-09 22:49:01 +0000512 UNUSED_PARAMETER(nArg);
513 UNUSED_PARAMETER(apArg);
dan9c277582018-06-20 09:23:49 +0000514 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p));
515 if( ALWAYS(p) ){
dan1c5ed622018-06-05 16:16:17 +0000516 p->nVal--;
517 if( p->nVal==0 ){
518 sqlite3_value_free(p->pVal);
519 p->pVal = 0;
520 }
521 }
522}
523static void last_valueValueFunc(sqlite3_context *pCtx){
524 struct LastValueCtx *p;
dan0525b6f2019-03-18 21:19:40 +0000525 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, 0);
dan1c5ed622018-06-05 16:16:17 +0000526 if( p && p->pVal ){
527 sqlite3_result_value(pCtx, p->pVal);
528 }
529}
530static void last_valueFinalizeFunc(sqlite3_context *pCtx){
531 struct LastValueCtx *p;
dan9c277582018-06-20 09:23:49 +0000532 p = (struct LastValueCtx*)sqlite3_aggregate_context(pCtx, sizeof(*p));
dan1c5ed622018-06-05 16:16:17 +0000533 if( p && p->pVal ){
534 sqlite3_result_value(pCtx, p->pVal);
535 sqlite3_value_free(p->pVal);
536 p->pVal = 0;
537 }
538}
539
dan2a11bb22018-06-11 20:50:25 +0000540/*
drh19dc4d42018-07-08 01:02:26 +0000541** 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 ){ ... }
dan2a11bb22018-06-11 20:50:25 +0000547*/
drh19dc4d42018-07-08 01:02:26 +0000548static const char row_numberName[] = "row_number";
549static const char dense_rankName[] = "dense_rank";
550static const char rankName[] = "rank";
551static const char percent_rankName[] = "percent_rank";
552static const char cume_distName[] = "cume_dist";
553static const char ntileName[] = "ntile";
554static const char last_valueName[] = "last_value";
555static const char nth_valueName[] = "nth_value";
556static const char first_valueName[] = "first_value";
557static const char leadName[] = "lead";
558static const char lagName[] = "lag";
danfe4e25a2018-06-07 20:08:59 +0000559
drh19dc4d42018-07-08 01:02:26 +0000560/*
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*/
569static void noopStepFunc( /*NO_TEST*/
570 sqlite3_context *p, /*NO_TEST*/
571 int n, /*NO_TEST*/
572 sqlite3_value **a /*NO_TEST*/
573){ /*NO_TEST*/
drhc7bf5712018-07-09 22:49:01 +0000574 UNUSED_PARAMETER(p); /*NO_TEST*/
575 UNUSED_PARAMETER(n); /*NO_TEST*/
576 UNUSED_PARAMETER(a); /*NO_TEST*/
drh19dc4d42018-07-08 01:02:26 +0000577 assert(0); /*NO_TEST*/
578} /*NO_TEST*/
drhc7bf5712018-07-09 22:49:01 +0000579static void noopValueFunc(sqlite3_context *p){ UNUSED_PARAMETER(p); /*no-op*/ }
dandfa552f2018-06-02 21:04:28 +0000580
drh19dc4d42018-07-08 01:02:26 +0000581/* Window functions that use all window interfaces: xStep, xFinal,
582** xValue, and xInverse */
583#define WINDOWFUNCALL(name,nArg,extra) { \
dan1c5ed622018-06-05 16:16:17 +0000584 nArg, (SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \
585 name ## StepFunc, name ## FinalizeFunc, name ## ValueFunc, \
drhc7bf5712018-07-09 22:49:01 +0000586 name ## InvFunc, name ## Name, {0} \
dan1c5ed622018-06-05 16:16:17 +0000587}
588
drh19dc4d42018-07-08 01:02:26 +0000589/* 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, \
drhc7bf5712018-07-09 22:49:01 +0000594 noopStepFunc, name ## Name, {0} \
drh19dc4d42018-07-08 01:02:26 +0000595}
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, \
drhc7bf5712018-07-09 22:49:01 +0000603 noopStepFunc, name ## Name, {0} \
drh19dc4d42018-07-08 01:02:26 +0000604}
605
606
dandfa552f2018-06-02 21:04:28 +0000607/*
608** Register those built-in window functions that are not also aggregates.
609*/
610void sqlite3WindowFunctions(void){
611 static FuncDef aWindowFuncs[] = {
drh19dc4d42018-07-08 01:02:26 +0000612 WINDOWFUNCX(row_number, 0, 0),
613 WINDOWFUNCX(dense_rank, 0, 0),
614 WINDOWFUNCX(rank, 0, 0),
dancc7a8502019-03-11 19:50:54 +0000615 WINDOWFUNCALL(percent_rank, 0, 0),
616 WINDOWFUNCALL(cume_dist, 0, 0),
617 WINDOWFUNCALL(ntile, 1, 0),
drh19dc4d42018-07-08 01:02:26 +0000618 WINDOWFUNCALL(last_value, 1, 0),
dana0f6b832019-03-14 16:36:20 +0000619 WINDOWFUNCALL(nth_value, 2, 0),
danc782a812019-03-15 20:46:19 +0000620 WINDOWFUNCALL(first_value, 1, 0),
drh19dc4d42018-07-08 01:02:26 +0000621 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),
dandfa552f2018-06-02 21:04:28 +0000627 };
628 sqlite3InsertBuiltinFuncs(aWindowFuncs, ArraySize(aWindowFuncs));
629}
630
dane7c9ca42019-02-16 17:27:51 +0000631static 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
danc0bb4452018-06-12 20:53:38 +0000642/*
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*/
dane3bf6322018-06-08 20:58:27 +0000659void sqlite3WindowUpdate(
660 Parse *pParse,
danc0bb4452018-06-12 20:53:38 +0000661 Window *pList, /* List of named windows for this SELECT */
662 Window *pWin, /* Window frame to update */
663 FuncDef *pFunc /* Window function definition */
dane3bf6322018-06-08 20:58:27 +0000664){
drhfc15f4c2019-03-28 13:03:41 +0000665 if( pWin->zName && pWin->eFrmType==0 ){
dane7c9ca42019-02-16 17:27:51 +0000666 Window *p = windowFind(pParse, pList, pWin->zName);
667 if( p==0 ) return;
dane3bf6322018-06-08 20:58:27 +0000668 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;
drhfc15f4c2019-03-28 13:03:41 +0000674 pWin->eFrmType = p->eFrmType;
danc782a812019-03-15 20:46:19 +0000675 pWin->eExclude = p->eExclude;
dane7c9ca42019-02-16 17:27:51 +0000676 }else{
677 sqlite3WindowChain(pParse, pWin, pList);
dane3bf6322018-06-08 20:58:27 +0000678 }
drhfc15f4c2019-03-28 13:03:41 +0000679 if( (pWin->eFrmType==TK_RANGE)
dan72b9fdc2019-03-09 20:49:17 +0000680 && (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
dandfa552f2018-06-02 21:04:28 +0000687 if( pFunc->funcFlags & SQLITE_FUNC_WINDOW ){
688 sqlite3 *db = pParse->db;
dan8b985602018-06-09 17:43:45 +0000689 if( pWin->pFilter ){
690 sqlite3ErrorMsg(pParse,
691 "FILTER clause may only be used with aggregate window functions"
692 );
dancc7a8502019-03-11 19:50:54 +0000693 }else{
694 struct WindowUpdate {
695 const char *zFunc;
drhfc15f4c2019-03-28 13:03:41 +0000696 int eFrmType;
dancc7a8502019-03-11 19:50:54 +0000697 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 },
danb560a712019-03-13 15:29:14 +0000707 { lagName, TK_ROWS, TK_UNBOUNDED, TK_CURRENT },
dancc7a8502019-03-11 19:50:54 +0000708 };
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;
drhfc15f4c2019-03-28 13:03:41 +0000715 pWin->eFrmType = aUp[i].eFrmType;
dancc7a8502019-03-11 19:50:54 +0000716 pWin->eStart = aUp[i].eStart;
717 pWin->eEnd = aUp[i].eEnd;
dana0f6b832019-03-14 16:36:20 +0000718 pWin->eExclude = 0;
dancc7a8502019-03-11 19:50:54 +0000719 if( pWin->eStart==TK_FOLLOWING ){
720 pWin->pStart = sqlite3Expr(db, TK_INTEGER, "1");
721 }
722 break;
723 }
724 }
dandfa552f2018-06-02 21:04:28 +0000725 }
726 }
dan2a11bb22018-06-11 20:50:25 +0000727 pWin->pFunc = pFunc;
dandfa552f2018-06-02 21:04:28 +0000728}
729
danc0bb4452018-06-12 20:53:38 +0000730/*
731** Context object passed through sqlite3WalkExprList() to
732** selectWindowRewriteExprCb() by selectWindowRewriteEList().
733*/
dandfa552f2018-06-02 21:04:28 +0000734typedef struct WindowRewrite WindowRewrite;
735struct WindowRewrite {
736 Window *pWin;
danb556f262018-07-10 17:26:12 +0000737 SrcList *pSrc;
dandfa552f2018-06-02 21:04:28 +0000738 ExprList *pSub;
dan62742fd2019-07-08 12:01:39 +0000739 Table *pTab;
danb556f262018-07-10 17:26:12 +0000740 Select *pSubSelect; /* Current sub-select, if any */
dandfa552f2018-06-02 21:04:28 +0000741};
742
danc0bb4452018-06-12 20:53:38 +0000743/*
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*/
dandfa552f2018-06-02 21:04:28 +0000748static int selectWindowRewriteExprCb(Walker *pWalker, Expr *pExpr){
749 struct WindowRewrite *p = pWalker->u.pRewrite;
750 Parse *pParse = pWalker->pParse;
drh55f66b32019-07-16 19:44:32 +0000751 assert( p!=0 );
752 assert( p->pWin!=0 );
dandfa552f2018-06-02 21:04:28 +0000753
danb556f262018-07-10 17:26:12 +0000754 /* 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
dandfa552f2018-06-02 21:04:28 +0000772 switch( pExpr->op ){
773
774 case TK_FUNCTION:
drheda079c2018-09-20 19:02:15 +0000775 if( !ExprHasProperty(pExpr, EP_WinFunc) ){
dandfa552f2018-06-02 21:04:28 +0000776 break;
777 }else{
778 Window *pWin;
779 for(pWin=p->pWin; pWin; pWin=pWin->pNextWin){
drheda079c2018-09-20 19:02:15 +0000780 if( pExpr->y.pWin==pWin ){
dan2a11bb22018-06-11 20:50:25 +0000781 assert( pWin->pOwner==pExpr );
dandfa552f2018-06-02 21:04:28 +0000782 return WRC_Prune;
783 }
784 }
785 }
drh08b92082020-08-10 14:18:00 +0000786 /* no break */ deliberate_fall_through
dandfa552f2018-06-02 21:04:28 +0000787
dan73925692018-06-12 18:40:17 +0000788 case TK_AGG_FUNCTION:
dandfa552f2018-06-02 21:04:28 +0000789 case TK_COLUMN: {
dan62be2dc2019-11-23 15:10:28 +0000790 int iCol = -1;
791 if( p->pSub ){
792 int i;
793 for(i=0; i<p->pSub->nExpr; i++){
794 if( 0==sqlite3ExprCompare(0, p->pSub->a[i].pExpr, pExpr, -1) ){
795 iCol = i;
796 break;
797 }
798 }
799 }
800 if( iCol<0 ){
801 Expr *pDup = sqlite3ExprDup(pParse->db, pExpr, 0);
dan43170432019-12-27 16:25:56 +0000802 if( pDup && pDup->op==TK_AGG_FUNCTION ) pDup->op = TK_FUNCTION;
dan62be2dc2019-11-23 15:10:28 +0000803 p->pSub = sqlite3ExprListAppend(pParse, p->pSub, pDup);
804 }
dandfa552f2018-06-02 21:04:28 +0000805 if( p->pSub ){
dan27da9072020-07-13 15:20:27 +0000806 int f = pExpr->flags & EP_Collate;
dandfa552f2018-06-02 21:04:28 +0000807 assert( ExprHasProperty(pExpr, EP_Static)==0 );
808 ExprSetProperty(pExpr, EP_Static);
809 sqlite3ExprDelete(pParse->db, pExpr);
810 ExprClearProperty(pExpr, EP_Static);
811 memset(pExpr, 0, sizeof(Expr));
812
813 pExpr->op = TK_COLUMN;
dan62be2dc2019-11-23 15:10:28 +0000814 pExpr->iColumn = (iCol<0 ? p->pSub->nExpr-1: iCol);
dandfa552f2018-06-02 21:04:28 +0000815 pExpr->iTable = p->pWin->iEphCsr;
dan62742fd2019-07-08 12:01:39 +0000816 pExpr->y.pTab = p->pTab;
dan27da9072020-07-13 15:20:27 +0000817 pExpr->flags = f;
dandfa552f2018-06-02 21:04:28 +0000818 }
drha2f142d2019-11-23 16:34:40 +0000819 if( pParse->db->mallocFailed ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +0000820 break;
821 }
822
823 default: /* no-op */
824 break;
825 }
826
827 return WRC_Continue;
828}
danc0bb4452018-06-12 20:53:38 +0000829static int selectWindowRewriteSelectCb(Walker *pWalker, Select *pSelect){
danb556f262018-07-10 17:26:12 +0000830 struct WindowRewrite *p = pWalker->u.pRewrite;
831 Select *pSave = p->pSubSelect;
832 if( pSave==pSelect ){
833 return WRC_Continue;
834 }else{
835 p->pSubSelect = pSelect;
836 sqlite3WalkSelect(pWalker, pSelect);
837 p->pSubSelect = pSave;
838 }
danc0bb4452018-06-12 20:53:38 +0000839 return WRC_Prune;
840}
dandfa552f2018-06-02 21:04:28 +0000841
danc0bb4452018-06-12 20:53:38 +0000842
843/*
844** Iterate through each expression in expression-list pEList. For each:
845**
846** * TK_COLUMN,
847** * aggregate function, or
848** * window function with a Window object that is not a member of the
danb556f262018-07-10 17:26:12 +0000849** Window list passed as the second argument (pWin).
danc0bb4452018-06-12 20:53:38 +0000850**
851** Append the node to output expression-list (*ppSub). And replace it
852** with a TK_COLUMN that reads the (N-1)th element of table
853** pWin->iEphCsr, where N is the number of elements in (*ppSub) after
854** appending the new one.
855*/
dan13b08bb2018-06-15 20:46:12 +0000856static void selectWindowRewriteEList(
dandfa552f2018-06-02 21:04:28 +0000857 Parse *pParse,
858 Window *pWin,
danb556f262018-07-10 17:26:12 +0000859 SrcList *pSrc,
dandfa552f2018-06-02 21:04:28 +0000860 ExprList *pEList, /* Rewrite expressions in this list */
dan62742fd2019-07-08 12:01:39 +0000861 Table *pTab,
dandfa552f2018-06-02 21:04:28 +0000862 ExprList **ppSub /* IN/OUT: Sub-select expression-list */
863){
864 Walker sWalker;
865 WindowRewrite sRewrite;
dandfa552f2018-06-02 21:04:28 +0000866
drh55f66b32019-07-16 19:44:32 +0000867 assert( pWin!=0 );
dandfa552f2018-06-02 21:04:28 +0000868 memset(&sWalker, 0, sizeof(Walker));
869 memset(&sRewrite, 0, sizeof(WindowRewrite));
870
871 sRewrite.pSub = *ppSub;
872 sRewrite.pWin = pWin;
danb556f262018-07-10 17:26:12 +0000873 sRewrite.pSrc = pSrc;
dan62742fd2019-07-08 12:01:39 +0000874 sRewrite.pTab = pTab;
dandfa552f2018-06-02 21:04:28 +0000875
876 sWalker.pParse = pParse;
877 sWalker.xExprCallback = selectWindowRewriteExprCb;
878 sWalker.xSelectCallback = selectWindowRewriteSelectCb;
879 sWalker.u.pRewrite = &sRewrite;
880
dan13b08bb2018-06-15 20:46:12 +0000881 (void)sqlite3WalkExprList(&sWalker, pEList);
dandfa552f2018-06-02 21:04:28 +0000882
883 *ppSub = sRewrite.pSub;
dandfa552f2018-06-02 21:04:28 +0000884}
885
danc0bb4452018-06-12 20:53:38 +0000886/*
887** Append a copy of each expression in expression-list pAppend to
888** expression list pList. Return a pointer to the result list.
889*/
dandfa552f2018-06-02 21:04:28 +0000890static ExprList *exprListAppendList(
891 Parse *pParse, /* Parsing context */
892 ExprList *pList, /* List to which to append. Might be NULL */
dan08f6de72019-05-10 14:26:32 +0000893 ExprList *pAppend, /* List of values to append. Might be NULL */
894 int bIntToNull
dandfa552f2018-06-02 21:04:28 +0000895){
896 if( pAppend ){
897 int i;
898 int nInit = pList ? pList->nExpr : 0;
899 for(i=0; i<pAppend->nExpr; i++){
900 Expr *pDup = sqlite3ExprDup(pParse->db, pAppend->a[i].pExpr, 0);
drh75e95e12019-12-18 00:05:50 +0000901 assert( pDup==0 || !ExprHasProperty(pDup, EP_MemToken) );
danefa78882020-05-11 10:55:24 +0000902 if( bIntToNull && pDup ){
903 int iDummy;
904 Expr *pSub;
905 for(pSub=pDup; ExprHasProperty(pSub, EP_Skip); pSub=pSub->pLeft){
906 assert( pSub );
907 }
908 if( sqlite3ExprIsInteger(pSub, &iDummy) ){
909 pSub->op = TK_NULL;
910 pSub->flags &= ~(EP_IntValue|EP_IsTrue|EP_IsFalse);
911 pSub->u.zToken = 0;
912 }
dan08f6de72019-05-10 14:26:32 +0000913 }
dandfa552f2018-06-02 21:04:28 +0000914 pList = sqlite3ExprListAppend(pParse, pList, pDup);
dan6e118922019-08-12 16:36:38 +0000915 if( pList ) pList->a[nInit+i].sortFlags = pAppend->a[i].sortFlags;
dandfa552f2018-06-02 21:04:28 +0000916 }
917 }
918 return pList;
919}
920
921/*
drhc37577b2020-05-24 03:38:37 +0000922** When rewriting a query, if the new subquery in the FROM clause
923** contains TK_AGG_FUNCTION nodes that refer to an outer query,
924** then we have to increase the Expr->op2 values of those nodes
925** due to the extra subquery layer that was added.
926**
927** See also the incrAggDepth() routine in resolve.c
928*/
929static int sqlite3WindowExtraAggFuncDepth(Walker *pWalker, Expr *pExpr){
930 if( pExpr->op==TK_AGG_FUNCTION
931 && pExpr->op2>=pWalker->walkerDepth
932 ){
933 pExpr->op2++;
934 }
935 return WRC_Continue;
936}
937
938/*
dandfa552f2018-06-02 21:04:28 +0000939** If the SELECT statement passed as the second argument does not invoke
940** any SQL window functions, this function is a no-op. Otherwise, it
941** rewrites the SELECT statement so that window function xStep functions
danc0bb4452018-06-12 20:53:38 +0000942** are invoked in the correct order as described under "SELECT REWRITING"
943** at the top of this file.
dandfa552f2018-06-02 21:04:28 +0000944*/
945int sqlite3WindowRewrite(Parse *pParse, Select *p){
946 int rc = SQLITE_OK;
drhba016342019-11-14 13:24:04 +0000947 if( p->pWin && p->pPrior==0 && (p->selFlags & SF_WinRewrite)==0 ){
dandfa552f2018-06-02 21:04:28 +0000948 Vdbe *v = sqlite3GetVdbe(pParse);
dandfa552f2018-06-02 21:04:28 +0000949 sqlite3 *db = pParse->db;
950 Select *pSub = 0; /* The subquery */
951 SrcList *pSrc = p->pSrc;
952 Expr *pWhere = p->pWhere;
953 ExprList *pGroupBy = p->pGroupBy;
954 Expr *pHaving = p->pHaving;
955 ExprList *pSort = 0;
956
957 ExprList *pSublist = 0; /* Expression list for sub-query */
drh067b92b2020-06-19 15:24:12 +0000958 Window *pMWin = p->pWin; /* Main window object */
dandfa552f2018-06-02 21:04:28 +0000959 Window *pWin; /* Window object iterator */
dan62742fd2019-07-08 12:01:39 +0000960 Table *pTab;
drh89636622020-06-07 17:33:18 +0000961 Walker w;
962
dan553948e2020-03-16 18:52:53 +0000963 u32 selFlags = p->selFlags;
dan62742fd2019-07-08 12:01:39 +0000964
965 pTab = sqlite3DbMallocZero(db, sizeof(Table));
966 if( pTab==0 ){
drh86541862019-12-19 20:37:32 +0000967 return sqlite3ErrorToParser(db, SQLITE_NOMEM);
dan62742fd2019-07-08 12:01:39 +0000968 }
drh89636622020-06-07 17:33:18 +0000969 sqlite3AggInfoPersistWalkerInit(&w, pParse);
970 sqlite3WalkSelect(&w, p);
dandfa552f2018-06-02 21:04:28 +0000971
972 p->pSrc = 0;
973 p->pWhere = 0;
974 p->pGroupBy = 0;
975 p->pHaving = 0;
dan62742fd2019-07-08 12:01:39 +0000976 p->selFlags &= ~SF_Aggregate;
drhba016342019-11-14 13:24:04 +0000977 p->selFlags |= SF_WinRewrite;
dandfa552f2018-06-02 21:04:28 +0000978
danf02cdd32018-06-27 19:48:50 +0000979 /* Create the ORDER BY clause for the sub-select. This is the concatenation
980 ** of the window PARTITION and ORDER BY clauses. Then, if this makes it
981 ** redundant, remove the ORDER BY from the parent SELECT. */
dand8d2fb92019-12-27 15:31:47 +0000982 pSort = exprListAppendList(pParse, 0, pMWin->pPartition, 1);
dan08f6de72019-05-10 14:26:32 +0000983 pSort = exprListAppendList(pParse, pSort, pMWin->pOrderBy, 1);
dan0e3c50c2019-08-07 17:45:37 +0000984 if( pSort && p->pOrderBy && p->pOrderBy->nExpr<=pSort->nExpr ){
985 int nSave = pSort->nExpr;
986 pSort->nExpr = p->pOrderBy->nExpr;
danf02cdd32018-06-27 19:48:50 +0000987 if( sqlite3ExprListCompare(pSort, p->pOrderBy, -1)==0 ){
988 sqlite3ExprListDelete(db, p->pOrderBy);
989 p->pOrderBy = 0;
990 }
dan0e3c50c2019-08-07 17:45:37 +0000991 pSort->nExpr = nSave;
danf02cdd32018-06-27 19:48:50 +0000992 }
993
dandfa552f2018-06-02 21:04:28 +0000994 /* Assign a cursor number for the ephemeral table used to buffer rows.
995 ** The OpenEphemeral instruction is coded later, after it is known how
996 ** many columns the table will have. */
997 pMWin->iEphCsr = pParse->nTab++;
dan680f6e82019-03-04 21:07:11 +0000998 pParse->nTab += 3;
dandfa552f2018-06-02 21:04:28 +0000999
dan62742fd2019-07-08 12:01:39 +00001000 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pEList, pTab, &pSublist);
1001 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pOrderBy, pTab, &pSublist);
dandfa552f2018-06-02 21:04:28 +00001002 pMWin->nBufferCol = (pSublist ? pSublist->nExpr : 0);
1003
danf02cdd32018-06-27 19:48:50 +00001004 /* Append the PARTITION BY and ORDER BY expressions to the to the
1005 ** sub-select expression list. They are required to figure out where
1006 ** boundaries for partitions and sets of peer rows lie. */
dan08f6de72019-05-10 14:26:32 +00001007 pSublist = exprListAppendList(pParse, pSublist, pMWin->pPartition, 0);
1008 pSublist = exprListAppendList(pParse, pSublist, pMWin->pOrderBy, 0);
dandfa552f2018-06-02 21:04:28 +00001009
1010 /* Append the arguments passed to each window function to the
1011 ** sub-select expression list. Also allocate two registers for each
1012 ** window function - one for the accumulator, another for interim
1013 ** results. */
1014 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
dane2ba6df2019-09-07 18:20:43 +00001015 ExprList *pArgs = pWin->pOwner->x.pList;
dan01a3b6b2019-09-13 17:05:48 +00001016 if( pWin->pFunc->funcFlags & SQLITE_FUNC_SUBTYPE ){
dane2ba6df2019-09-07 18:20:43 +00001017 selectWindowRewriteEList(pParse, pMWin, pSrc, pArgs, pTab, &pSublist);
1018 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0);
1019 pWin->bExprArgs = 1;
1020 }else{
1021 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0);
1022 pSublist = exprListAppendList(pParse, pSublist, pArgs, 0);
1023 }
dan8b985602018-06-09 17:43:45 +00001024 if( pWin->pFilter ){
1025 Expr *pFilter = sqlite3ExprDup(db, pWin->pFilter, 0);
1026 pSublist = sqlite3ExprListAppend(pParse, pSublist, pFilter);
1027 }
dandfa552f2018-06-02 21:04:28 +00001028 pWin->regAccum = ++pParse->nMem;
1029 pWin->regResult = ++pParse->nMem;
1030 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
1031 }
1032
dan9c277582018-06-20 09:23:49 +00001033 /* If there is no ORDER BY or PARTITION BY clause, and the window
1034 ** function accepts zero arguments, and there are no other columns
1035 ** selected (e.g. "SELECT row_number() OVER () FROM t1"), it is possible
1036 ** that pSublist is still NULL here. Add a constant expression here to
1037 ** keep everything legal in this case.
1038 */
1039 if( pSublist==0 ){
1040 pSublist = sqlite3ExprListAppend(pParse, 0,
drh5776ee52019-09-23 12:38:10 +00001041 sqlite3Expr(db, TK_INTEGER, "0")
dan9c277582018-06-20 09:23:49 +00001042 );
1043 }
1044
dandfa552f2018-06-02 21:04:28 +00001045 pSub = sqlite3SelectNew(
1046 pParse, pSublist, pSrc, pWhere, pGroupBy, pHaving, pSort, 0, 0
1047 );
drh9216de82020-06-11 00:57:09 +00001048 SELECTTRACE(1,pParse,pSub,
1049 ("New window-function subquery in FROM clause of (%u/%p)\n",
1050 p->selId, p));
drh29c992c2019-01-17 15:40:41 +00001051 p->pSrc = sqlite3SrcListAppend(pParse, 0, 0, 0);
dandfa552f2018-06-02 21:04:28 +00001052 if( p->pSrc ){
dan62742fd2019-07-08 12:01:39 +00001053 Table *pTab2;
dandfa552f2018-06-02 21:04:28 +00001054 p->pSrc->a[0].pSelect = pSub;
1055 sqlite3SrcListAssignCursors(pParse, p->pSrc);
dan62742fd2019-07-08 12:01:39 +00001056 pSub->selFlags |= SF_Expanded;
drh96fb16e2019-08-06 14:37:24 +00001057 pTab2 = sqlite3ResultSetOfSelect(pParse, pSub, SQLITE_AFF_NONE);
dan553948e2020-03-16 18:52:53 +00001058 pSub->selFlags |= (selFlags & SF_Aggregate);
dan62742fd2019-07-08 12:01:39 +00001059 if( pTab2==0 ){
drha9ebfe22019-12-25 23:54:21 +00001060 /* Might actually be some other kind of error, but in that case
1061 ** pParse->nErr will be set, so if SQLITE_NOMEM is set, we will get
1062 ** the correct error message regardless. */
dandfa552f2018-06-02 21:04:28 +00001063 rc = SQLITE_NOMEM;
1064 }else{
dan62742fd2019-07-08 12:01:39 +00001065 memcpy(pTab, pTab2, sizeof(Table));
1066 pTab->tabFlags |= TF_Ephemeral;
1067 p->pSrc->a[0].pTab = pTab;
1068 pTab = pTab2;
drhc37577b2020-05-24 03:38:37 +00001069 memset(&w, 0, sizeof(w));
1070 w.xExprCallback = sqlite3WindowExtraAggFuncDepth;
1071 w.xSelectCallback = sqlite3WalkerDepthIncrease;
1072 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
1073 sqlite3WalkSelect(&w, pSub);
dandfa552f2018-06-02 21:04:28 +00001074 }
dan6fde1792018-06-15 19:01:35 +00001075 }else{
1076 sqlite3SelectDelete(db, pSub);
1077 }
1078 if( db->mallocFailed ) rc = SQLITE_NOMEM;
dan62742fd2019-07-08 12:01:39 +00001079 sqlite3DbFree(db, pTab);
dandfa552f2018-06-02 21:04:28 +00001080 }
1081
drha9ebfe22019-12-25 23:54:21 +00001082 if( rc ){
1083 if( pParse->nErr==0 ){
1084 assert( pParse->db->mallocFailed );
1085 sqlite3ErrorToParser(pParse->db, SQLITE_NOMEM);
1086 }
drh86541862019-12-19 20:37:32 +00001087 }
dandfa552f2018-06-02 21:04:28 +00001088 return rc;
1089}
1090
danc0bb4452018-06-12 20:53:38 +00001091/*
drhe2094572019-07-22 19:01:38 +00001092** Unlink the Window object from the Select to which it is attached,
1093** if it is attached.
1094*/
1095void sqlite3WindowUnlinkFromSelect(Window *p){
1096 if( p->ppThis ){
1097 *p->ppThis = p->pNextWin;
1098 if( p->pNextWin ) p->pNextWin->ppThis = p->ppThis;
1099 p->ppThis = 0;
1100 }
1101}
1102
1103/*
danc0bb4452018-06-12 20:53:38 +00001104** Free the Window object passed as the second argument.
1105*/
dan86fb6e12018-05-16 20:58:07 +00001106void sqlite3WindowDelete(sqlite3 *db, Window *p){
1107 if( p ){
drhe2094572019-07-22 19:01:38 +00001108 sqlite3WindowUnlinkFromSelect(p);
dan86fb6e12018-05-16 20:58:07 +00001109 sqlite3ExprDelete(db, p->pFilter);
1110 sqlite3ExprListDelete(db, p->pPartition);
1111 sqlite3ExprListDelete(db, p->pOrderBy);
1112 sqlite3ExprDelete(db, p->pEnd);
1113 sqlite3ExprDelete(db, p->pStart);
dane3bf6322018-06-08 20:58:27 +00001114 sqlite3DbFree(db, p->zName);
dane7c9ca42019-02-16 17:27:51 +00001115 sqlite3DbFree(db, p->zBase);
dan86fb6e12018-05-16 20:58:07 +00001116 sqlite3DbFree(db, p);
1117 }
1118}
1119
danc0bb4452018-06-12 20:53:38 +00001120/*
1121** Free the linked list of Window objects starting at the second argument.
1122*/
dane3bf6322018-06-08 20:58:27 +00001123void sqlite3WindowListDelete(sqlite3 *db, Window *p){
1124 while( p ){
1125 Window *pNext = p->pNextWin;
1126 sqlite3WindowDelete(db, p);
1127 p = pNext;
1128 }
1129}
1130
danc0bb4452018-06-12 20:53:38 +00001131/*
drhe4984a22018-07-06 17:19:20 +00001132** The argument expression is an PRECEDING or FOLLOWING offset. The
1133** value should be a non-negative integer. If the value is not a
1134** constant, change it to NULL. The fact that it is then a non-negative
1135** integer will be caught later. But it is important not to leave
1136** variable values in the expression tree.
1137*/
1138static Expr *sqlite3WindowOffsetExpr(Parse *pParse, Expr *pExpr){
1139 if( 0==sqlite3ExprIsConstant(pExpr) ){
danfb8ac322019-01-16 12:05:22 +00001140 if( IN_RENAME_OBJECT ) sqlite3RenameExprUnmap(pParse, pExpr);
drhe4984a22018-07-06 17:19:20 +00001141 sqlite3ExprDelete(pParse->db, pExpr);
1142 pExpr = sqlite3ExprAlloc(pParse->db, TK_NULL, 0, 0);
1143 }
1144 return pExpr;
1145}
1146
1147/*
1148** Allocate and return a new Window object describing a Window Definition.
danc0bb4452018-06-12 20:53:38 +00001149*/
dan86fb6e12018-05-16 20:58:07 +00001150Window *sqlite3WindowAlloc(
drhe4984a22018-07-06 17:19:20 +00001151 Parse *pParse, /* Parsing context */
drhfc15f4c2019-03-28 13:03:41 +00001152 int eType, /* Frame type. TK_RANGE, TK_ROWS, TK_GROUPS, or 0 */
drhe4984a22018-07-06 17:19:20 +00001153 int eStart, /* Start type: CURRENT, PRECEDING, FOLLOWING, UNBOUNDED */
1154 Expr *pStart, /* Start window size if TK_PRECEDING or FOLLOWING */
1155 int eEnd, /* End type: CURRENT, FOLLOWING, TK_UNBOUNDED, PRECEDING */
dand35300f2019-03-14 20:53:21 +00001156 Expr *pEnd, /* End window size if TK_FOLLOWING or PRECEDING */
1157 u8 eExclude /* EXCLUDE clause */
dan86fb6e12018-05-16 20:58:07 +00001158){
dan7a606e12018-07-05 18:34:53 +00001159 Window *pWin = 0;
dane7c9ca42019-02-16 17:27:51 +00001160 int bImplicitFrame = 0;
dan7a606e12018-07-05 18:34:53 +00001161
drhe4984a22018-07-06 17:19:20 +00001162 /* Parser assures the following: */
dan6c75b392019-03-08 20:02:52 +00001163 assert( eType==0 || eType==TK_RANGE || eType==TK_ROWS || eType==TK_GROUPS );
drhe4984a22018-07-06 17:19:20 +00001164 assert( eStart==TK_CURRENT || eStart==TK_PRECEDING
1165 || eStart==TK_UNBOUNDED || eStart==TK_FOLLOWING );
1166 assert( eEnd==TK_CURRENT || eEnd==TK_FOLLOWING
1167 || eEnd==TK_UNBOUNDED || eEnd==TK_PRECEDING );
1168 assert( (eStart==TK_PRECEDING || eStart==TK_FOLLOWING)==(pStart!=0) );
1169 assert( (eEnd==TK_FOLLOWING || eEnd==TK_PRECEDING)==(pEnd!=0) );
1170
dane7c9ca42019-02-16 17:27:51 +00001171 if( eType==0 ){
1172 bImplicitFrame = 1;
1173 eType = TK_RANGE;
1174 }
drhe4984a22018-07-06 17:19:20 +00001175
drhe4984a22018-07-06 17:19:20 +00001176 /* Additionally, the
dan5d764ac2018-07-06 14:15:49 +00001177 ** starting boundary type may not occur earlier in the following list than
1178 ** the ending boundary type:
1179 **
1180 ** UNBOUNDED PRECEDING
1181 ** <expr> PRECEDING
1182 ** CURRENT ROW
1183 ** <expr> FOLLOWING
1184 ** UNBOUNDED FOLLOWING
1185 **
1186 ** The parser ensures that "UNBOUNDED PRECEDING" cannot be used as an ending
1187 ** boundary, and than "UNBOUNDED FOLLOWING" cannot be used as a starting
1188 ** frame boundary.
1189 */
drhe4984a22018-07-06 17:19:20 +00001190 if( (eStart==TK_CURRENT && eEnd==TK_PRECEDING)
dan5d764ac2018-07-06 14:15:49 +00001191 || (eStart==TK_FOLLOWING && (eEnd==TK_PRECEDING || eEnd==TK_CURRENT))
1192 ){
dan72b9fdc2019-03-09 20:49:17 +00001193 sqlite3ErrorMsg(pParse, "unsupported frame specification");
drhe4984a22018-07-06 17:19:20 +00001194 goto windowAllocErr;
dan7a606e12018-07-05 18:34:53 +00001195 }
dan86fb6e12018-05-16 20:58:07 +00001196
drhe4984a22018-07-06 17:19:20 +00001197 pWin = (Window*)sqlite3DbMallocZero(pParse->db, sizeof(Window));
1198 if( pWin==0 ) goto windowAllocErr;
drhfc15f4c2019-03-28 13:03:41 +00001199 pWin->eFrmType = eType;
drhe4984a22018-07-06 17:19:20 +00001200 pWin->eStart = eStart;
1201 pWin->eEnd = eEnd;
drh94809082019-04-02 17:45:56 +00001202 if( eExclude==0 && OptimizationDisabled(pParse->db, SQLITE_WindowFunc) ){
dan108e6b22019-03-18 18:55:35 +00001203 eExclude = TK_NO;
1204 }
dand35300f2019-03-14 20:53:21 +00001205 pWin->eExclude = eExclude;
dane7c9ca42019-02-16 17:27:51 +00001206 pWin->bImplicitFrame = bImplicitFrame;
drhe4984a22018-07-06 17:19:20 +00001207 pWin->pEnd = sqlite3WindowOffsetExpr(pParse, pEnd);
1208 pWin->pStart = sqlite3WindowOffsetExpr(pParse, pStart);
dan86fb6e12018-05-16 20:58:07 +00001209 return pWin;
drhe4984a22018-07-06 17:19:20 +00001210
1211windowAllocErr:
1212 sqlite3ExprDelete(pParse->db, pEnd);
1213 sqlite3ExprDelete(pParse->db, pStart);
1214 return 0;
dan86fb6e12018-05-16 20:58:07 +00001215}
1216
danc0bb4452018-06-12 20:53:38 +00001217/*
dane7c9ca42019-02-16 17:27:51 +00001218** Attach PARTITION and ORDER BY clauses pPartition and pOrderBy to window
1219** pWin. Also, if parameter pBase is not NULL, set pWin->zBase to the
1220** equivalent nul-terminated string.
1221*/
1222Window *sqlite3WindowAssemble(
1223 Parse *pParse,
1224 Window *pWin,
1225 ExprList *pPartition,
1226 ExprList *pOrderBy,
1227 Token *pBase
1228){
1229 if( pWin ){
1230 pWin->pPartition = pPartition;
1231 pWin->pOrderBy = pOrderBy;
1232 if( pBase ){
1233 pWin->zBase = sqlite3DbStrNDup(pParse->db, pBase->z, pBase->n);
1234 }
1235 }else{
1236 sqlite3ExprListDelete(pParse->db, pPartition);
1237 sqlite3ExprListDelete(pParse->db, pOrderBy);
1238 }
1239 return pWin;
1240}
1241
1242/*
1243** Window *pWin has just been created from a WINDOW clause. Tokne pBase
1244** is the base window. Earlier windows from the same WINDOW clause are
1245** stored in the linked list starting at pWin->pNextWin. This function
1246** either updates *pWin according to the base specification, or else
1247** leaves an error in pParse.
1248*/
1249void sqlite3WindowChain(Parse *pParse, Window *pWin, Window *pList){
1250 if( pWin->zBase ){
1251 sqlite3 *db = pParse->db;
1252 Window *pExist = windowFind(pParse, pList, pWin->zBase);
1253 if( pExist ){
1254 const char *zErr = 0;
1255 /* Check for errors */
1256 if( pWin->pPartition ){
1257 zErr = "PARTITION clause";
1258 }else if( pExist->pOrderBy && pWin->pOrderBy ){
1259 zErr = "ORDER BY clause";
1260 }else if( pExist->bImplicitFrame==0 ){
1261 zErr = "frame specification";
1262 }
1263 if( zErr ){
1264 sqlite3ErrorMsg(pParse,
1265 "cannot override %s of window: %s", zErr, pWin->zBase
1266 );
1267 }else{
1268 pWin->pPartition = sqlite3ExprListDup(db, pExist->pPartition, 0);
1269 if( pExist->pOrderBy ){
1270 assert( pWin->pOrderBy==0 );
1271 pWin->pOrderBy = sqlite3ExprListDup(db, pExist->pOrderBy, 0);
1272 }
1273 sqlite3DbFree(db, pWin->zBase);
1274 pWin->zBase = 0;
1275 }
1276 }
1277 }
1278}
1279
1280/*
danc0bb4452018-06-12 20:53:38 +00001281** Attach window object pWin to expression p.
1282*/
dan4f9adee2019-07-13 16:22:50 +00001283void sqlite3WindowAttach(Parse *pParse, Expr *p, Window *pWin){
dan86fb6e12018-05-16 20:58:07 +00001284 if( p ){
drheda079c2018-09-20 19:02:15 +00001285 assert( p->op==TK_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00001286 assert( pWin );
1287 p->y.pWin = pWin;
1288 ExprSetProperty(p, EP_WinFunc);
1289 pWin->pOwner = p;
1290 if( (p->flags & EP_Distinct) && pWin->eFrmType!=TK_FILTER ){
1291 sqlite3ErrorMsg(pParse,
1292 "DISTINCT is not supported for window functions"
1293 );
dane33f6e72018-07-06 07:42:42 +00001294 }
dan86fb6e12018-05-16 20:58:07 +00001295 }else{
1296 sqlite3WindowDelete(pParse->db, pWin);
1297 }
1298}
dane2f781b2018-05-17 19:24:08 +00001299
1300/*
dana3fcc002019-08-15 13:53:22 +00001301** Possibly link window pWin into the list at pSel->pWin (window functions
1302** to be processed as part of SELECT statement pSel). The window is linked
1303** in if either (a) there are no other windows already linked to this
1304** SELECT, or (b) the windows already linked use a compatible window frame.
1305*/
1306void sqlite3WindowLink(Select *pSel, Window *pWin){
dan903fdd42021-02-22 20:56:13 +00001307 if( pSel ){
1308 if( 0==pSel->pWin || 0==sqlite3WindowCompare(0, pSel->pWin, pWin, 0) ){
1309 pWin->pNextWin = pSel->pWin;
1310 if( pSel->pWin ){
1311 pSel->pWin->ppThis = &pWin->pNextWin;
1312 }
1313 pSel->pWin = pWin;
1314 pWin->ppThis = &pSel->pWin;
1315 }else{
1316 if( sqlite3ExprListCompare(pWin->pPartition, pSel->pWin->pPartition,-1) ){
1317 pSel->selFlags |= SF_MultiPart;
1318 }
dana3fcc002019-08-15 13:53:22 +00001319 }
dana3fcc002019-08-15 13:53:22 +00001320 }
1321}
1322
1323/*
danfbb6e9f2020-01-09 20:11:29 +00001324** Return 0 if the two window objects are identical, 1 if they are
1325** different, or 2 if it cannot be determined if the objects are identical
1326** or not. Identical window objects can be processed in a single scan.
dane2f781b2018-05-17 19:24:08 +00001327*/
dan4f9adee2019-07-13 16:22:50 +00001328int sqlite3WindowCompare(Parse *pParse, Window *p1, Window *p2, int bFilter){
danfbb6e9f2020-01-09 20:11:29 +00001329 int res;
drha2f142d2019-11-23 16:34:40 +00001330 if( NEVER(p1==0) || NEVER(p2==0) ) return 1;
drhfc15f4c2019-03-28 13:03:41 +00001331 if( p1->eFrmType!=p2->eFrmType ) return 1;
dane2f781b2018-05-17 19:24:08 +00001332 if( p1->eStart!=p2->eStart ) return 1;
1333 if( p1->eEnd!=p2->eEnd ) return 1;
dana0f6b832019-03-14 16:36:20 +00001334 if( p1->eExclude!=p2->eExclude ) return 1;
dane2f781b2018-05-17 19:24:08 +00001335 if( sqlite3ExprCompare(pParse, p1->pStart, p2->pStart, -1) ) return 1;
1336 if( sqlite3ExprCompare(pParse, p1->pEnd, p2->pEnd, -1) ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00001337 if( (res = sqlite3ExprListCompare(p1->pPartition, p2->pPartition, -1)) ){
1338 return res;
1339 }
1340 if( (res = sqlite3ExprListCompare(p1->pOrderBy, p2->pOrderBy, -1)) ){
1341 return res;
1342 }
dan4f9adee2019-07-13 16:22:50 +00001343 if( bFilter ){
danfbb6e9f2020-01-09 20:11:29 +00001344 if( (res = sqlite3ExprCompare(pParse, p1->pFilter, p2->pFilter, -1)) ){
1345 return res;
1346 }
dan4f9adee2019-07-13 16:22:50 +00001347 }
dane2f781b2018-05-17 19:24:08 +00001348 return 0;
1349}
1350
dan13078ca2018-06-13 20:29:38 +00001351
1352/*
1353** This is called by code in select.c before it calls sqlite3WhereBegin()
1354** to begin iterating through the sub-query results. It is used to allocate
1355** and initialize registers and cursors used by sqlite3WindowCodeStep().
1356*/
dan4ea562e2020-01-01 20:17:15 +00001357void sqlite3WindowCodeInit(Parse *pParse, Select *pSelect){
1358 int nEphExpr = pSelect->pSrc->a[0].pSelect->pEList->nExpr;
1359 Window *pMWin = pSelect->pWin;
danc9a86682018-05-30 20:44:58 +00001360 Window *pWin;
dan13078ca2018-06-13 20:29:38 +00001361 Vdbe *v = sqlite3GetVdbe(pParse);
danb6f2dea2019-03-13 17:20:27 +00001362
dan4ea562e2020-01-01 20:17:15 +00001363 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pMWin->iEphCsr, nEphExpr);
1364 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+1, pMWin->iEphCsr);
1365 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+2, pMWin->iEphCsr);
1366 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+3, pMWin->iEphCsr);
1367
danb6f2dea2019-03-13 17:20:27 +00001368 /* Allocate registers to use for PARTITION BY values, if any. Initialize
1369 ** said registers to NULL. */
1370 if( pMWin->pPartition ){
1371 int nExpr = pMWin->pPartition->nExpr;
dan13078ca2018-06-13 20:29:38 +00001372 pMWin->regPart = pParse->nMem+1;
danb6f2dea2019-03-13 17:20:27 +00001373 pParse->nMem += nExpr;
1374 sqlite3VdbeAddOp3(v, OP_Null, 0, pMWin->regPart, pMWin->regPart+nExpr-1);
dan13078ca2018-06-13 20:29:38 +00001375 }
1376
danbf845152019-03-16 10:15:24 +00001377 pMWin->regOne = ++pParse->nMem;
1378 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regOne);
dan680f6e82019-03-04 21:07:11 +00001379
dana0f6b832019-03-14 16:36:20 +00001380 if( pMWin->eExclude ){
1381 pMWin->regStartRowid = ++pParse->nMem;
1382 pMWin->regEndRowid = ++pParse->nMem;
1383 pMWin->csrApp = pParse->nTab++;
1384 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid);
1385 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid);
1386 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->csrApp, pMWin->iEphCsr);
1387 return;
1388 }
1389
danc9a86682018-05-30 20:44:58 +00001390 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
danec891fd2018-06-06 20:51:02 +00001391 FuncDef *p = pWin->pFunc;
1392 if( (p->funcFlags & SQLITE_FUNC_MINMAX) && pWin->eStart!=TK_UNBOUNDED ){
dan9a947222018-06-14 19:06:36 +00001393 /* The inline versions of min() and max() require a single ephemeral
1394 ** table and 3 registers. The registers are used as follows:
1395 **
1396 ** regApp+0: slot to copy min()/max() argument to for MakeRecord
1397 ** regApp+1: integer value used to ensure keys are unique
1398 ** regApp+2: output of MakeRecord
1399 */
danc9a86682018-05-30 20:44:58 +00001400 ExprList *pList = pWin->pOwner->x.pList;
1401 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pList, 0, 0);
danc9a86682018-05-30 20:44:58 +00001402 pWin->csrApp = pParse->nTab++;
1403 pWin->regApp = pParse->nMem+1;
1404 pParse->nMem += 3;
1405 if( pKeyInfo && pWin->pFunc->zName[1]=='i' ){
dan6e118922019-08-12 16:36:38 +00001406 assert( pKeyInfo->aSortFlags[0]==0 );
1407 pKeyInfo->aSortFlags[0] = KEYINFO_ORDER_DESC;
danc9a86682018-05-30 20:44:58 +00001408 }
1409 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pWin->csrApp, 2);
1410 sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
1411 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
1412 }
drh19dc4d42018-07-08 01:02:26 +00001413 else if( p->zName==nth_valueName || p->zName==first_valueName ){
danec891fd2018-06-06 20:51:02 +00001414 /* Allocate two registers at pWin->regApp. These will be used to
1415 ** store the start and end index of the current frame. */
danec891fd2018-06-06 20:51:02 +00001416 pWin->regApp = pParse->nMem+1;
1417 pWin->csrApp = pParse->nTab++;
1418 pParse->nMem += 2;
danec891fd2018-06-06 20:51:02 +00001419 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr);
1420 }
drh19dc4d42018-07-08 01:02:26 +00001421 else if( p->zName==leadName || p->zName==lagName ){
danfe4e25a2018-06-07 20:08:59 +00001422 pWin->csrApp = pParse->nTab++;
1423 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr);
1424 }
danc9a86682018-05-30 20:44:58 +00001425 }
1426}
1427
danbb407272019-03-12 18:28:51 +00001428#define WINDOW_STARTING_INT 0
1429#define WINDOW_ENDING_INT 1
1430#define WINDOW_NTH_VALUE_INT 2
1431#define WINDOW_STARTING_NUM 3
1432#define WINDOW_ENDING_NUM 4
1433
dan13078ca2018-06-13 20:29:38 +00001434/*
dana1a7e112018-07-09 13:31:18 +00001435** A "PRECEDING <expr>" (eCond==0) or "FOLLOWING <expr>" (eCond==1) or the
1436** value of the second argument to nth_value() (eCond==2) has just been
1437** evaluated and the result left in register reg. This function generates VM
1438** code to check that the value is a non-negative integer and throws an
1439** exception if it is not.
dan13078ca2018-06-13 20:29:38 +00001440*/
danbb407272019-03-12 18:28:51 +00001441static void windowCheckValue(Parse *pParse, int reg, int eCond){
danc3a20c12018-05-23 20:55:37 +00001442 static const char *azErr[] = {
1443 "frame starting offset must be a non-negative integer",
dana1a7e112018-07-09 13:31:18 +00001444 "frame ending offset must be a non-negative integer",
danbb407272019-03-12 18:28:51 +00001445 "second argument to nth_value must be a positive integer",
1446 "frame starting offset must be a non-negative number",
1447 "frame ending offset must be a non-negative number",
danc3a20c12018-05-23 20:55:37 +00001448 };
danbb407272019-03-12 18:28:51 +00001449 static int aOp[] = { OP_Ge, OP_Ge, OP_Gt, OP_Ge, OP_Ge };
danc3a20c12018-05-23 20:55:37 +00001450 Vdbe *v = sqlite3GetVdbe(pParse);
dan13078ca2018-06-13 20:29:38 +00001451 int regZero = sqlite3GetTempReg(pParse);
danbb407272019-03-12 18:28:51 +00001452 assert( eCond>=0 && eCond<ArraySize(azErr) );
danc3a20c12018-05-23 20:55:37 +00001453 sqlite3VdbeAddOp2(v, OP_Integer, 0, regZero);
dane5166e02019-03-19 11:56:39 +00001454 if( eCond>=WINDOW_STARTING_NUM ){
1455 int regString = sqlite3GetTempReg(pParse);
1456 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC);
1457 sqlite3VdbeAddOp3(v, OP_Ge, regString, sqlite3VdbeCurrentAddr(v)+2, reg);
drh21826f42019-04-01 14:30:30 +00001458 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC|SQLITE_JUMPIFNULL);
drh6f883592019-03-30 20:37:04 +00001459 VdbeCoverage(v);
1460 assert( eCond==3 || eCond==4 );
1461 VdbeCoverageIf(v, eCond==3);
1462 VdbeCoverageIf(v, eCond==4);
dane5166e02019-03-19 11:56:39 +00001463 }else{
1464 sqlite3VdbeAddOp2(v, OP_MustBeInt, reg, sqlite3VdbeCurrentAddr(v)+2);
drh6f883592019-03-30 20:37:04 +00001465 VdbeCoverage(v);
1466 assert( eCond==0 || eCond==1 || eCond==2 );
1467 VdbeCoverageIf(v, eCond==0);
1468 VdbeCoverageIf(v, eCond==1);
1469 VdbeCoverageIf(v, eCond==2);
dane5166e02019-03-19 11:56:39 +00001470 }
dana1a7e112018-07-09 13:31:18 +00001471 sqlite3VdbeAddOp3(v, aOp[eCond], regZero, sqlite3VdbeCurrentAddr(v)+2, reg);
danb03786a2021-03-31 11:31:19 +00001472 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC);
drh21826f42019-04-01 14:30:30 +00001473 VdbeCoverageNeverNullIf(v, eCond==0); /* NULL case captured by */
1474 VdbeCoverageNeverNullIf(v, eCond==1); /* the OP_MustBeInt */
1475 VdbeCoverageNeverNullIf(v, eCond==2);
1476 VdbeCoverageNeverNullIf(v, eCond==3); /* NULL case caught by */
1477 VdbeCoverageNeverNullIf(v, eCond==4); /* the OP_Ge */
drh211a0852019-01-27 02:41:34 +00001478 sqlite3MayAbort(pParse);
danc3a20c12018-05-23 20:55:37 +00001479 sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_ERROR, OE_Abort);
dana1a7e112018-07-09 13:31:18 +00001480 sqlite3VdbeAppendP4(v, (void*)azErr[eCond], P4_STATIC);
dan13078ca2018-06-13 20:29:38 +00001481 sqlite3ReleaseTempReg(pParse, regZero);
danc3a20c12018-05-23 20:55:37 +00001482}
1483
dan13078ca2018-06-13 20:29:38 +00001484/*
1485** Return the number of arguments passed to the window-function associated
1486** with the object passed as the only argument to this function.
1487*/
dan2a11bb22018-06-11 20:50:25 +00001488static int windowArgCount(Window *pWin){
1489 ExprList *pList = pWin->pOwner->x.pList;
1490 return (pList ? pList->nExpr : 0);
1491}
1492
danc782a812019-03-15 20:46:19 +00001493typedef struct WindowCodeArg WindowCodeArg;
1494typedef struct WindowCsrAndReg WindowCsrAndReg;
dan1cac1762019-08-30 17:28:55 +00001495
1496/*
1497** See comments above struct WindowCodeArg.
1498*/
danc782a812019-03-15 20:46:19 +00001499struct WindowCsrAndReg {
dan1cac1762019-08-30 17:28:55 +00001500 int csr; /* Cursor number */
1501 int reg; /* First in array of peer values */
danc782a812019-03-15 20:46:19 +00001502};
1503
dan1cac1762019-08-30 17:28:55 +00001504/*
1505** A single instance of this structure is allocated on the stack by
1506** sqlite3WindowCodeStep() and a pointer to it passed to the various helper
1507** routines. This is to reduce the number of arguments required by each
1508** helper function.
1509**
1510** regArg:
1511** Each window function requires an accumulator register (just as an
1512** ordinary aggregate function does). This variable is set to the first
1513** in an array of accumulator registers - one for each window function
1514** in the WindowCodeArg.pMWin list.
1515**
1516** eDelete:
1517** The window functions implementation sometimes caches the input rows
1518** that it processes in a temporary table. If it is not zero, this
1519** variable indicates when rows may be removed from the temp table (in
1520** order to reduce memory requirements - it would always be safe just
1521** to leave them there). Possible values for eDelete are:
1522**
1523** WINDOW_RETURN_ROW:
1524** An input row can be discarded after it is returned to the caller.
1525**
1526** WINDOW_AGGINVERSE:
1527** An input row can be discarded after the window functions xInverse()
1528** callbacks have been invoked in it.
1529**
1530** WINDOW_AGGSTEP:
1531** An input row can be discarded after the window functions xStep()
1532** callbacks have been invoked in it.
1533**
1534** start,current,end
1535** Consider a window-frame similar to the following:
1536**
1537** (ORDER BY a, b GROUPS BETWEEN 2 PRECEDING AND 2 FOLLOWING)
1538**
1539** The windows functions implmentation caches the input rows in a temp
1540** table, sorted by "a, b" (it actually populates the cache lazily, and
1541** aggressively removes rows once they are no longer required, but that's
1542** a mere detail). It keeps three cursors open on the temp table. One
1543** (current) that points to the next row to return to the query engine
1544** once its window function values have been calculated. Another (end)
1545** points to the next row to call the xStep() method of each window function
1546** on (so that it is 2 groups ahead of current). And a third (start) that
1547** points to the next row to call the xInverse() method of each window
1548** function on.
1549**
1550** Each cursor (start, current and end) consists of a VDBE cursor
1551** (WindowCsrAndReg.csr) and an array of registers (starting at
1552** WindowCodeArg.reg) that always contains a copy of the peer values
1553** read from the corresponding cursor.
1554**
1555** Depending on the window-frame in question, all three cursors may not
1556** be required. In this case both WindowCodeArg.csr and reg are set to
1557** 0.
1558*/
danc782a812019-03-15 20:46:19 +00001559struct WindowCodeArg {
dan1cac1762019-08-30 17:28:55 +00001560 Parse *pParse; /* Parse context */
1561 Window *pMWin; /* First in list of functions being processed */
1562 Vdbe *pVdbe; /* VDBE object */
1563 int addrGosub; /* OP_Gosub to this address to return one row */
1564 int regGosub; /* Register used with OP_Gosub(addrGosub) */
1565 int regArg; /* First in array of accumulator registers */
1566 int eDelete; /* See above */
danc782a812019-03-15 20:46:19 +00001567
1568 WindowCsrAndReg start;
1569 WindowCsrAndReg current;
1570 WindowCsrAndReg end;
1571};
1572
1573/*
danc782a812019-03-15 20:46:19 +00001574** Generate VM code to read the window frames peer values from cursor csr into
1575** an array of registers starting at reg.
1576*/
1577static void windowReadPeerValues(
1578 WindowCodeArg *p,
1579 int csr,
1580 int reg
1581){
1582 Window *pMWin = p->pMWin;
1583 ExprList *pOrderBy = pMWin->pOrderBy;
1584 if( pOrderBy ){
1585 Vdbe *v = sqlite3GetVdbe(p->pParse);
1586 ExprList *pPart = pMWin->pPartition;
1587 int iColOff = pMWin->nBufferCol + (pPart ? pPart->nExpr : 0);
1588 int i;
1589 for(i=0; i<pOrderBy->nExpr; i++){
1590 sqlite3VdbeAddOp3(v, OP_Column, csr, iColOff+i, reg+i);
1591 }
1592 }
1593}
1594
dan13078ca2018-06-13 20:29:38 +00001595/*
dan37d296a2019-09-24 20:20:05 +00001596** Generate VM code to invoke either xStep() (if bInverse is 0) or
1597** xInverse (if bInverse is non-zero) for each window function in the
1598** linked list starting at pMWin. Or, for built-in window functions
1599** that do not use the standard function API, generate the required
1600** inline VM code.
1601**
1602** If argument csr is greater than or equal to 0, then argument reg is
1603** the first register in an array of registers guaranteed to be large
1604** enough to hold the array of arguments for each function. In this case
1605** the arguments are extracted from the current row of csr into the
1606** array of registers before invoking OP_AggStep or OP_AggInverse
1607**
1608** Or, if csr is less than zero, then the array of registers at reg is
1609** already populated with all columns from the current row of the sub-query.
1610**
1611** If argument regPartSize is non-zero, then it is a register containing the
1612** number of rows in the current partition.
1613*/
1614static void windowAggStep(
1615 WindowCodeArg *p,
1616 Window *pMWin, /* Linked list of window functions */
1617 int csr, /* Read arguments from this cursor */
1618 int bInverse, /* True to invoke xInverse instead of xStep */
1619 int reg /* Array of registers */
1620){
1621 Parse *pParse = p->pParse;
1622 Vdbe *v = sqlite3GetVdbe(pParse);
1623 Window *pWin;
1624 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
1625 FuncDef *pFunc = pWin->pFunc;
1626 int regArg;
1627 int nArg = pWin->bExprArgs ? 0 : windowArgCount(pWin);
1628 int i;
1629
1630 assert( bInverse==0 || pWin->eStart!=TK_UNBOUNDED );
1631
drhc5b35ae2019-09-25 02:07:50 +00001632 /* All OVER clauses in the same window function aggregate step must
1633 ** be the same. */
danfbb6e9f2020-01-09 20:11:29 +00001634 assert( pWin==pMWin || sqlite3WindowCompare(pParse,pWin,pMWin,0)!=1 );
drhc5b35ae2019-09-25 02:07:50 +00001635
dan37d296a2019-09-24 20:20:05 +00001636 for(i=0; i<nArg; i++){
1637 if( i!=1 || pFunc->zName!=nth_valueName ){
1638 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+i, reg+i);
1639 }else{
1640 sqlite3VdbeAddOp3(v, OP_Column, pMWin->iEphCsr, pWin->iArgCol+i, reg+i);
1641 }
1642 }
1643 regArg = reg;
1644
1645 if( pMWin->regStartRowid==0
1646 && (pFunc->funcFlags & SQLITE_FUNC_MINMAX)
1647 && (pWin->eStart!=TK_UNBOUNDED)
1648 ){
1649 int addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regArg);
1650 VdbeCoverage(v);
1651 if( bInverse==0 ){
1652 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1, 1);
1653 sqlite3VdbeAddOp2(v, OP_SCopy, regArg, pWin->regApp);
1654 sqlite3VdbeAddOp3(v, OP_MakeRecord, pWin->regApp, 2, pWin->regApp+2);
1655 sqlite3VdbeAddOp2(v, OP_IdxInsert, pWin->csrApp, pWin->regApp+2);
1656 }else{
1657 sqlite3VdbeAddOp4Int(v, OP_SeekGE, pWin->csrApp, 0, regArg, 1);
1658 VdbeCoverageNeverTaken(v);
1659 sqlite3VdbeAddOp1(v, OP_Delete, pWin->csrApp);
1660 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
1661 }
1662 sqlite3VdbeJumpHere(v, addrIsNull);
1663 }else if( pWin->regApp ){
1664 assert( pFunc->zName==nth_valueName
1665 || pFunc->zName==first_valueName
1666 );
1667 assert( bInverse==0 || bInverse==1 );
1668 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1-bInverse, 1);
1669 }else if( pFunc->xSFunc!=noopStepFunc ){
1670 int addrIf = 0;
dan37d296a2019-09-24 20:20:05 +00001671 if( pWin->pFilter ){
1672 int regTmp;
1673 assert( pWin->bExprArgs || !nArg ||nArg==pWin->pOwner->x.pList->nExpr );
1674 assert( pWin->bExprArgs || nArg ||pWin->pOwner->x.pList==0 );
1675 regTmp = sqlite3GetTempReg(pParse);
1676 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+nArg,regTmp);
1677 addrIf = sqlite3VdbeAddOp3(v, OP_IfNot, regTmp, 0, 1);
1678 VdbeCoverage(v);
1679 sqlite3ReleaseTempReg(pParse, regTmp);
1680 }
dan37d296a2019-09-24 20:20:05 +00001681
dan37d296a2019-09-24 20:20:05 +00001682 if( pWin->bExprArgs ){
1683 int iStart = sqlite3VdbeCurrentAddr(v);
1684 VdbeOp *pOp, *pEnd;
1685
1686 nArg = pWin->pOwner->x.pList->nExpr;
1687 regArg = sqlite3GetTempRange(pParse, nArg);
1688 sqlite3ExprCodeExprList(pParse, pWin->pOwner->x.pList, regArg, 0, 0);
1689
1690 pEnd = sqlite3VdbeGetOp(v, -1);
1691 for(pOp=sqlite3VdbeGetOp(v, iStart); pOp<=pEnd; pOp++){
1692 if( pOp->opcode==OP_Column && pOp->p1==pWin->iEphCsr ){
1693 pOp->p1 = csr;
1694 }
1695 }
1696 }
1697 if( pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
1698 CollSeq *pColl;
1699 assert( nArg>0 );
1700 pColl = sqlite3ExprNNCollSeq(pParse, pWin->pOwner->x.pList->a[0].pExpr);
1701 sqlite3VdbeAddOp4(v, OP_CollSeq, 0,0,0, (const char*)pColl, P4_COLLSEQ);
1702 }
1703 sqlite3VdbeAddOp3(v, bInverse? OP_AggInverse : OP_AggStep,
1704 bInverse, regArg, pWin->regAccum);
1705 sqlite3VdbeAppendP4(v, pFunc, P4_FUNCDEF);
1706 sqlite3VdbeChangeP5(v, (u8)nArg);
1707 if( pWin->bExprArgs ){
1708 sqlite3ReleaseTempRange(pParse, regArg, nArg);
1709 }
1710 if( addrIf ) sqlite3VdbeJumpHere(v, addrIf);
dan37d296a2019-09-24 20:20:05 +00001711 }
1712 }
1713}
1714
1715/*
1716** Values that may be passed as the second argument to windowCodeOp().
1717*/
1718#define WINDOW_RETURN_ROW 1
1719#define WINDOW_AGGINVERSE 2
1720#define WINDOW_AGGSTEP 3
1721
1722/*
dana0f6b832019-03-14 16:36:20 +00001723** Generate VM code to invoke either xValue() (bFin==0) or xFinalize()
1724** (bFin==1) for each window function in the linked list starting at
dan13078ca2018-06-13 20:29:38 +00001725** pMWin. Or, for built-in window-functions that do not use the standard
1726** API, generate the equivalent VM code.
1727*/
danc782a812019-03-15 20:46:19 +00001728static void windowAggFinal(WindowCodeArg *p, int bFin){
1729 Parse *pParse = p->pParse;
1730 Window *pMWin = p->pMWin;
dand6f784e2018-05-28 18:30:45 +00001731 Vdbe *v = sqlite3GetVdbe(pParse);
1732 Window *pWin;
1733
1734 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
dana0f6b832019-03-14 16:36:20 +00001735 if( pMWin->regStartRowid==0
1736 && (pWin->pFunc->funcFlags & SQLITE_FUNC_MINMAX)
1737 && (pWin->eStart!=TK_UNBOUNDED)
danec891fd2018-06-06 20:51:02 +00001738 ){
dand6f784e2018-05-28 18:30:45 +00001739 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
danc9a86682018-05-30 20:44:58 +00001740 sqlite3VdbeAddOp1(v, OP_Last, pWin->csrApp);
dan01e12292018-06-27 20:24:59 +00001741 VdbeCoverage(v);
danc9a86682018-05-30 20:44:58 +00001742 sqlite3VdbeAddOp3(v, OP_Column, pWin->csrApp, 0, pWin->regResult);
1743 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
danec891fd2018-06-06 20:51:02 +00001744 }else if( pWin->regApp ){
dana0f6b832019-03-14 16:36:20 +00001745 assert( pMWin->regStartRowid==0 );
dand6f784e2018-05-28 18:30:45 +00001746 }else{
dana0f6b832019-03-14 16:36:20 +00001747 int nArg = windowArgCount(pWin);
1748 if( bFin ){
1749 sqlite3VdbeAddOp2(v, OP_AggFinal, pWin->regAccum, nArg);
drh8f26da62018-07-05 21:22:57 +00001750 sqlite3VdbeAppendP4(v, pWin->pFunc, P4_FUNCDEF);
danc9a86682018-05-30 20:44:58 +00001751 sqlite3VdbeAddOp2(v, OP_Copy, pWin->regAccum, pWin->regResult);
dan8b985602018-06-09 17:43:45 +00001752 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
danc9a86682018-05-30 20:44:58 +00001753 }else{
dana0f6b832019-03-14 16:36:20 +00001754 sqlite3VdbeAddOp3(v, OP_AggValue,pWin->regAccum,nArg,pWin->regResult);
drh8f26da62018-07-05 21:22:57 +00001755 sqlite3VdbeAppendP4(v, pWin->pFunc, P4_FUNCDEF);
danc9a86682018-05-30 20:44:58 +00001756 }
dand6f784e2018-05-28 18:30:45 +00001757 }
1758 }
1759}
1760
dan0525b6f2019-03-18 21:19:40 +00001761/*
1762** Generate code to calculate the current values of all window functions in the
1763** p->pMWin list by doing a full scan of the current window frame. Store the
1764** results in the Window.regResult registers, ready to return the upper
1765** layer.
1766*/
danc782a812019-03-15 20:46:19 +00001767static void windowFullScan(WindowCodeArg *p){
1768 Window *pWin;
1769 Parse *pParse = p->pParse;
1770 Window *pMWin = p->pMWin;
1771 Vdbe *v = p->pVdbe;
1772
1773 int regCRowid = 0; /* Current rowid value */
1774 int regCPeer = 0; /* Current peer values */
1775 int regRowid = 0; /* AggStep rowid value */
1776 int regPeer = 0; /* AggStep peer values */
1777
1778 int nPeer;
1779 int lblNext;
1780 int lblBrk;
1781 int addrNext;
drh55f66b32019-07-16 19:44:32 +00001782 int csr;
danc782a812019-03-15 20:46:19 +00001783
dan37d296a2019-09-24 20:20:05 +00001784 VdbeModuleComment((v, "windowFullScan begin"));
1785
drh55f66b32019-07-16 19:44:32 +00001786 assert( pMWin!=0 );
1787 csr = pMWin->csrApp;
danc782a812019-03-15 20:46:19 +00001788 nPeer = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0);
1789
1790 lblNext = sqlite3VdbeMakeLabel(pParse);
1791 lblBrk = sqlite3VdbeMakeLabel(pParse);
1792
1793 regCRowid = sqlite3GetTempReg(pParse);
1794 regRowid = sqlite3GetTempReg(pParse);
1795 if( nPeer ){
1796 regCPeer = sqlite3GetTempRange(pParse, nPeer);
1797 regPeer = sqlite3GetTempRange(pParse, nPeer);
1798 }
1799
1800 sqlite3VdbeAddOp2(v, OP_Rowid, pMWin->iEphCsr, regCRowid);
1801 windowReadPeerValues(p, pMWin->iEphCsr, regCPeer);
1802
1803 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
1804 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
1805 }
1806
1807 sqlite3VdbeAddOp3(v, OP_SeekGE, csr, lblBrk, pMWin->regStartRowid);
dan1d4b25f2019-03-19 16:49:15 +00001808 VdbeCoverage(v);
danc782a812019-03-15 20:46:19 +00001809 addrNext = sqlite3VdbeCurrentAddr(v);
1810 sqlite3VdbeAddOp2(v, OP_Rowid, csr, regRowid);
1811 sqlite3VdbeAddOp3(v, OP_Gt, pMWin->regEndRowid, lblBrk, regRowid);
dan1d4b25f2019-03-19 16:49:15 +00001812 VdbeCoverageNeverNull(v);
dan108e6b22019-03-18 18:55:35 +00001813
danc782a812019-03-15 20:46:19 +00001814 if( pMWin->eExclude==TK_CURRENT ){
1815 sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, lblNext, regRowid);
drh83c5bb92019-04-01 15:55:38 +00001816 VdbeCoverageNeverNull(v);
danc782a812019-03-15 20:46:19 +00001817 }else if( pMWin->eExclude!=TK_NO ){
1818 int addr;
dan108e6b22019-03-18 18:55:35 +00001819 int addrEq = 0;
dan66033422019-03-19 19:19:53 +00001820 KeyInfo *pKeyInfo = 0;
dan108e6b22019-03-18 18:55:35 +00001821
dan66033422019-03-19 19:19:53 +00001822 if( pMWin->pOrderBy ){
1823 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pMWin->pOrderBy, 0, 0);
danc782a812019-03-15 20:46:19 +00001824 }
dan66033422019-03-19 19:19:53 +00001825 if( pMWin->eExclude==TK_TIES ){
1826 addrEq = sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, 0, regRowid);
drh83c5bb92019-04-01 15:55:38 +00001827 VdbeCoverageNeverNull(v);
dan66033422019-03-19 19:19:53 +00001828 }
1829 if( pKeyInfo ){
1830 windowReadPeerValues(p, csr, regPeer);
1831 sqlite3VdbeAddOp3(v, OP_Compare, regPeer, regCPeer, nPeer);
1832 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
1833 addr = sqlite3VdbeCurrentAddr(v)+1;
1834 sqlite3VdbeAddOp3(v, OP_Jump, addr, lblNext, addr);
1835 VdbeCoverageEqNe(v);
1836 }else{
1837 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblNext);
1838 }
danc782a812019-03-15 20:46:19 +00001839 if( addrEq ) sqlite3VdbeJumpHere(v, addrEq);
1840 }
1841
dan37d296a2019-09-24 20:20:05 +00001842 windowAggStep(p, pMWin, csr, 0, p->regArg);
danc782a812019-03-15 20:46:19 +00001843
1844 sqlite3VdbeResolveLabel(v, lblNext);
1845 sqlite3VdbeAddOp2(v, OP_Next, csr, addrNext);
dan1d4b25f2019-03-19 16:49:15 +00001846 VdbeCoverage(v);
danc782a812019-03-15 20:46:19 +00001847 sqlite3VdbeJumpHere(v, addrNext-1);
1848 sqlite3VdbeJumpHere(v, addrNext+1);
1849 sqlite3ReleaseTempReg(pParse, regRowid);
1850 sqlite3ReleaseTempReg(pParse, regCRowid);
1851 if( nPeer ){
1852 sqlite3ReleaseTempRange(pParse, regPeer, nPeer);
1853 sqlite3ReleaseTempRange(pParse, regCPeer, nPeer);
1854 }
1855
1856 windowAggFinal(p, 1);
dan37d296a2019-09-24 20:20:05 +00001857 VdbeModuleComment((v, "windowFullScan end"));
danc782a812019-03-15 20:46:19 +00001858}
1859
dan13078ca2018-06-13 20:29:38 +00001860/*
dan13078ca2018-06-13 20:29:38 +00001861** Invoke the sub-routine at regGosub (generated by code in select.c) to
1862** return the current row of Window.iEphCsr. If all window functions are
1863** aggregate window functions that use the standard API, a single
1864** OP_Gosub instruction is all that this routine generates. Extra VM code
1865** for per-row processing is only generated for the following built-in window
1866** functions:
1867**
1868** nth_value()
1869** first_value()
1870** lag()
1871** lead()
1872*/
danc782a812019-03-15 20:46:19 +00001873static void windowReturnOneRow(WindowCodeArg *p){
1874 Window *pMWin = p->pMWin;
1875 Vdbe *v = p->pVdbe;
dan7095c002018-06-07 17:45:22 +00001876
danc782a812019-03-15 20:46:19 +00001877 if( pMWin->regStartRowid ){
1878 windowFullScan(p);
1879 }else{
1880 Parse *pParse = p->pParse;
1881 Window *pWin;
1882
1883 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
1884 FuncDef *pFunc = pWin->pFunc;
1885 if( pFunc->zName==nth_valueName
1886 || pFunc->zName==first_valueName
1887 ){
dana0f6b832019-03-14 16:36:20 +00001888 int csr = pWin->csrApp;
danc782a812019-03-15 20:46:19 +00001889 int lbl = sqlite3VdbeMakeLabel(pParse);
1890 int tmpReg = sqlite3GetTempReg(pParse);
1891 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
1892
1893 if( pFunc->zName==nth_valueName ){
1894 sqlite3VdbeAddOp3(v, OP_Column,pMWin->iEphCsr,pWin->iArgCol+1,tmpReg);
1895 windowCheckValue(pParse, tmpReg, 2);
1896 }else{
1897 sqlite3VdbeAddOp2(v, OP_Integer, 1, tmpReg);
1898 }
dana0f6b832019-03-14 16:36:20 +00001899 sqlite3VdbeAddOp3(v, OP_Add, tmpReg, pWin->regApp, tmpReg);
1900 sqlite3VdbeAddOp3(v, OP_Gt, pWin->regApp+1, lbl, tmpReg);
1901 VdbeCoverageNeverNull(v);
1902 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, 0, tmpReg);
1903 VdbeCoverageNeverTaken(v);
1904 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult);
danc782a812019-03-15 20:46:19 +00001905 sqlite3VdbeResolveLabel(v, lbl);
1906 sqlite3ReleaseTempReg(pParse, tmpReg);
dana0f6b832019-03-14 16:36:20 +00001907 }
danc782a812019-03-15 20:46:19 +00001908 else if( pFunc->zName==leadName || pFunc->zName==lagName ){
1909 int nArg = pWin->pOwner->x.pList->nExpr;
1910 int csr = pWin->csrApp;
1911 int lbl = sqlite3VdbeMakeLabel(pParse);
1912 int tmpReg = sqlite3GetTempReg(pParse);
1913 int iEph = pMWin->iEphCsr;
1914
1915 if( nArg<3 ){
1916 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
1917 }else{
1918 sqlite3VdbeAddOp3(v, OP_Column, iEph,pWin->iArgCol+2,pWin->regResult);
1919 }
1920 sqlite3VdbeAddOp2(v, OP_Rowid, iEph, tmpReg);
1921 if( nArg<2 ){
1922 int val = (pFunc->zName==leadName ? 1 : -1);
1923 sqlite3VdbeAddOp2(v, OP_AddImm, tmpReg, val);
1924 }else{
1925 int op = (pFunc->zName==leadName ? OP_Add : OP_Subtract);
1926 int tmpReg2 = sqlite3GetTempReg(pParse);
1927 sqlite3VdbeAddOp3(v, OP_Column, iEph, pWin->iArgCol+1, tmpReg2);
1928 sqlite3VdbeAddOp3(v, op, tmpReg2, tmpReg, tmpReg);
1929 sqlite3ReleaseTempReg(pParse, tmpReg2);
1930 }
1931
1932 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, lbl, tmpReg);
1933 VdbeCoverage(v);
1934 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult);
1935 sqlite3VdbeResolveLabel(v, lbl);
1936 sqlite3ReleaseTempReg(pParse, tmpReg);
danfe4e25a2018-06-07 20:08:59 +00001937 }
danfe4e25a2018-06-07 20:08:59 +00001938 }
danec891fd2018-06-06 20:51:02 +00001939 }
danc782a812019-03-15 20:46:19 +00001940 sqlite3VdbeAddOp2(v, OP_Gosub, p->regGosub, p->addrGosub);
danec891fd2018-06-06 20:51:02 +00001941}
1942
dan13078ca2018-06-13 20:29:38 +00001943/*
dan54a9ab32018-06-14 14:27:05 +00001944** Generate code to set the accumulator register for each window function
1945** in the linked list passed as the second argument to NULL. And perform
1946** any equivalent initialization required by any built-in window functions
1947** in the list.
1948*/
dan2e605682018-06-07 15:54:26 +00001949static int windowInitAccum(Parse *pParse, Window *pMWin){
1950 Vdbe *v = sqlite3GetVdbe(pParse);
1951 int regArg;
1952 int nArg = 0;
1953 Window *pWin;
1954 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
dan9a947222018-06-14 19:06:36 +00001955 FuncDef *pFunc = pWin->pFunc;
dan0a21ea92020-02-29 17:19:42 +00001956 assert( pWin->regAccum );
dan2e605682018-06-07 15:54:26 +00001957 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
dan2a11bb22018-06-11 20:50:25 +00001958 nArg = MAX(nArg, windowArgCount(pWin));
dan108e6b22019-03-18 18:55:35 +00001959 if( pMWin->regStartRowid==0 ){
dana0f6b832019-03-14 16:36:20 +00001960 if( pFunc->zName==nth_valueName || pFunc->zName==first_valueName ){
1961 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp);
1962 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
1963 }
dan9a947222018-06-14 19:06:36 +00001964
dana0f6b832019-03-14 16:36:20 +00001965 if( (pFunc->funcFlags & SQLITE_FUNC_MINMAX) && pWin->csrApp ){
1966 assert( pWin->eStart!=TK_UNBOUNDED );
1967 sqlite3VdbeAddOp1(v, OP_ResetSorter, pWin->csrApp);
1968 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
1969 }
dan9a947222018-06-14 19:06:36 +00001970 }
dan2e605682018-06-07 15:54:26 +00001971 }
1972 regArg = pParse->nMem+1;
1973 pParse->nMem += nArg;
1974 return regArg;
1975}
1976
danb33487b2019-03-06 17:12:32 +00001977/*
dancc7a8502019-03-11 19:50:54 +00001978** Return true if the current frame should be cached in the ephemeral table,
1979** even if there are no xInverse() calls required.
danb33487b2019-03-06 17:12:32 +00001980*/
dancc7a8502019-03-11 19:50:54 +00001981static int windowCacheFrame(Window *pMWin){
danb33487b2019-03-06 17:12:32 +00001982 Window *pWin;
dana0f6b832019-03-14 16:36:20 +00001983 if( pMWin->regStartRowid ) return 1;
danb33487b2019-03-06 17:12:32 +00001984 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
1985 FuncDef *pFunc = pWin->pFunc;
dancc7a8502019-03-11 19:50:54 +00001986 if( (pFunc->zName==nth_valueName)
danb33487b2019-03-06 17:12:32 +00001987 || (pFunc->zName==first_valueName)
danb560a712019-03-13 15:29:14 +00001988 || (pFunc->zName==leadName)
danb33487b2019-03-06 17:12:32 +00001989 || (pFunc->zName==lagName)
1990 ){
1991 return 1;
1992 }
1993 }
1994 return 0;
1995}
1996
dan6c75b392019-03-08 20:02:52 +00001997/*
1998** regOld and regNew are each the first register in an array of size
1999** pOrderBy->nExpr. This function generates code to compare the two
2000** arrays of registers using the collation sequences and other comparison
2001** parameters specified by pOrderBy.
2002**
2003** If the two arrays are not equal, the contents of regNew is copied to
2004** regOld and control falls through. Otherwise, if the contents of the arrays
2005** are equal, an OP_Goto is executed. The address of the OP_Goto is returned.
2006*/
dan935d9d82019-03-12 15:21:51 +00002007static void windowIfNewPeer(
dan6c75b392019-03-08 20:02:52 +00002008 Parse *pParse,
2009 ExprList *pOrderBy,
2010 int regNew, /* First in array of new values */
dan935d9d82019-03-12 15:21:51 +00002011 int regOld, /* First in array of old values */
2012 int addr /* Jump here */
dan6c75b392019-03-08 20:02:52 +00002013){
2014 Vdbe *v = sqlite3GetVdbe(pParse);
dan6c75b392019-03-08 20:02:52 +00002015 if( pOrderBy ){
2016 int nVal = pOrderBy->nExpr;
2017 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pOrderBy, 0, 0);
2018 sqlite3VdbeAddOp3(v, OP_Compare, regOld, regNew, nVal);
2019 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
dan935d9d82019-03-12 15:21:51 +00002020 sqlite3VdbeAddOp3(v, OP_Jump,
2021 sqlite3VdbeCurrentAddr(v)+1, addr, sqlite3VdbeCurrentAddr(v)+1
dan72b9fdc2019-03-09 20:49:17 +00002022 );
dan6c75b392019-03-08 20:02:52 +00002023 VdbeCoverageEqNe(v);
2024 sqlite3VdbeAddOp3(v, OP_Copy, regNew, regOld, nVal-1);
2025 }else{
dan935d9d82019-03-12 15:21:51 +00002026 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr);
dan6c75b392019-03-08 20:02:52 +00002027 }
dan6c75b392019-03-08 20:02:52 +00002028}
2029
dan72b9fdc2019-03-09 20:49:17 +00002030/*
2031** This function is called as part of generating VM programs for RANGE
dan1e7cb192019-03-16 20:29:54 +00002032** offset PRECEDING/FOLLOWING frame boundaries. Assuming "ASC" order for
dan8b47f522019-08-30 16:14:58 +00002033** the ORDER BY term in the window, and that argument op is OP_Ge, it generates
2034** code equivalent to:
dan72b9fdc2019-03-09 20:49:17 +00002035**
2036** if( csr1.peerVal + regVal >= csr2.peerVal ) goto lbl;
dan1e7cb192019-03-16 20:29:54 +00002037**
dan8b47f522019-08-30 16:14:58 +00002038** The value of parameter op may also be OP_Gt or OP_Le. In these cases the
2039** operator in the above pseudo-code is replaced with ">" or "<=", respectively.
2040**
2041** If the sort-order for the ORDER BY term in the window is DESC, then the
2042** comparison is reversed. Instead of adding regVal to csr1.peerVal, it is
2043** subtracted. And the comparison operator is inverted to - ">=" becomes "<=",
2044** ">" becomes "<", and so on. So, with DESC sort order, if the argument op
2045** is OP_Ge, the generated code is equivalent to:
2046**
2047** if( csr1.peerVal - regVal <= csr2.peerVal ) goto lbl;
2048**
2049** A special type of arithmetic is used such that if csr1.peerVal is not
2050** a numeric type (real or integer), then the result of the addition addition
2051** or subtraction is a a copy of csr1.peerVal.
dan72b9fdc2019-03-09 20:49:17 +00002052*/
2053static void windowCodeRangeTest(
2054 WindowCodeArg *p,
dan1cac1762019-08-30 17:28:55 +00002055 int op, /* OP_Ge, OP_Gt, or OP_Le */
2056 int csr1, /* Cursor number for cursor 1 */
2057 int regVal, /* Register containing non-negative number */
2058 int csr2, /* Cursor number for cursor 2 */
2059 int lbl /* Jump destination if condition is true */
dan72b9fdc2019-03-09 20:49:17 +00002060){
2061 Parse *pParse = p->pParse;
2062 Vdbe *v = sqlite3GetVdbe(pParse);
dan1cac1762019-08-30 17:28:55 +00002063 ExprList *pOrderBy = p->pMWin->pOrderBy; /* ORDER BY clause for window */
2064 int reg1 = sqlite3GetTempReg(pParse); /* Reg. for csr1.peerVal+regVal */
2065 int reg2 = sqlite3GetTempReg(pParse); /* Reg. for csr2.peerVal */
2066 int regString = ++pParse->nMem; /* Reg. for constant value '' */
dan8b47f522019-08-30 16:14:58 +00002067 int arith = OP_Add; /* OP_Add or OP_Subtract */
2068 int addrGe; /* Jump destination */
dan7f8653a2021-03-06 14:46:24 +00002069 CollSeq *pColl;
dan71fddaf2019-03-11 11:12:34 +00002070
2071 assert( op==OP_Ge || op==OP_Gt || op==OP_Le );
danae8e45c2019-08-19 19:59:50 +00002072 assert( pOrderBy && pOrderBy->nExpr==1 );
2073 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_DESC ){
dan71fddaf2019-03-11 11:12:34 +00002074 switch( op ){
2075 case OP_Ge: op = OP_Le; break;
2076 case OP_Gt: op = OP_Lt; break;
2077 default: assert( op==OP_Le ); op = OP_Ge; break;
2078 }
2079 arith = OP_Subtract;
2080 }
2081
dan8b47f522019-08-30 16:14:58 +00002082 /* Read the peer-value from each cursor into a register */
dan72b9fdc2019-03-09 20:49:17 +00002083 windowReadPeerValues(p, csr1, reg1);
2084 windowReadPeerValues(p, csr2, reg2);
dan1e7cb192019-03-16 20:29:54 +00002085
dan8b47f522019-08-30 16:14:58 +00002086 VdbeModuleComment((v, "CodeRangeTest: if( R%d %s R%d %s R%d ) goto lbl",
2087 reg1, (arith==OP_Add ? "+" : "-"), regVal,
2088 ((op==OP_Ge) ? ">=" : (op==OP_Le) ? "<=" : (op==OP_Gt) ? ">" : "<"), reg2
2089 ));
2090
2091 /* Register reg1 currently contains csr1.peerVal (the peer-value from csr1).
2092 ** This block adds (or subtracts for DESC) the numeric value in regVal
2093 ** from it. Or, if reg1 is not numeric (it is a NULL, a text value or a blob),
2094 ** then leave reg1 as it is. In pseudo-code, this is implemented as:
2095 **
2096 ** if( reg1>='' ) goto addrGe;
2097 ** reg1 = reg1 +/- regVal
2098 ** addrGe:
2099 **
2100 ** Since all strings and blobs are greater-than-or-equal-to an empty string,
2101 ** the add/subtract is skipped for these, as required. If reg1 is a NULL,
2102 ** then the arithmetic is performed, but since adding or subtracting from
2103 ** NULL is always NULL anyway, this case is handled as required too. */
dan1e7cb192019-03-16 20:29:54 +00002104 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC);
2105 addrGe = sqlite3VdbeAddOp3(v, OP_Ge, regString, 0, reg1);
dan1d4b25f2019-03-19 16:49:15 +00002106 VdbeCoverage(v);
dan71fddaf2019-03-11 11:12:34 +00002107 sqlite3VdbeAddOp3(v, arith, regVal, reg1, reg1);
dan1e7cb192019-03-16 20:29:54 +00002108 sqlite3VdbeJumpHere(v, addrGe);
dan8b47f522019-08-30 16:14:58 +00002109
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 ){
dan9889ede2019-08-30 19:45:03 +00002119 ** if( op==OP_Ge ) goto lbl;
2120 ** if( op==OP_Gt && reg2 IS NOT NULL ) goto lbl;
dan8b47f522019-08-30 16:14:58 +00002121 ** 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. */
danae8e45c2019-08-19 19:59:50 +00002129 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_BIGNULL ){
dan8b47f522019-08-30 16:14:58 +00002130 /* This block runs if reg1 contains a NULL. */
2131 int addr = sqlite3VdbeAddOp1(v, OP_NotNull, reg1); VdbeCoverage(v);
danae8e45c2019-08-19 19:59:50 +00002132 switch( op ){
dan8b47f522019-08-30 16:14:58 +00002133 case OP_Ge:
2134 sqlite3VdbeAddOp2(v, OP_Goto, 0, lbl);
2135 break;
danf236b212019-08-21 19:58:11 +00002136 case OP_Gt:
drhdb3a32e2019-08-30 18:02:49 +00002137 sqlite3VdbeAddOp2(v, OP_NotNull, reg2, lbl);
2138 VdbeCoverage(v);
danf236b212019-08-21 19:58:11 +00002139 break;
drhdb3a32e2019-08-30 18:02:49 +00002140 case OP_Le:
2141 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl);
2142 VdbeCoverage(v);
danf236b212019-08-21 19:58:11 +00002143 break;
drhdb3a32e2019-08-30 18:02:49 +00002144 default: assert( op==OP_Lt ); /* no-op */ break;
danae8e45c2019-08-19 19:59:50 +00002145 }
dan8b47f522019-08-30 16:14:58 +00002146 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+3);
2147
2148 /* This block runs if reg1 is not NULL, but reg2 is. */
danae8e45c2019-08-19 19:59:50 +00002149 sqlite3VdbeJumpHere(v, addr);
2150 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl); VdbeCoverage(v);
2151 if( op==OP_Gt || op==OP_Ge ){
2152 sqlite3VdbeChangeP2(v, -1, sqlite3VdbeCurrentAddr(v)+1);
2153 }
2154 }
dan8b47f522019-08-30 16:14:58 +00002155
2156 /* Compare registers reg2 and reg1, taking the jump if required. Note that
2157 ** control skips over this test if the BIGNULL flag is set and either
2158 ** reg1 or reg2 contain a NULL value. */
drh6f883592019-03-30 20:37:04 +00002159 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v);
dan7f8653a2021-03-06 14:46:24 +00002160 pColl = sqlite3ExprNNCollSeq(pParse, pOrderBy->a[0].pExpr);
2161 sqlite3VdbeAppendP4(v, (void*)pColl, P4_COLLSEQ);
danbdabe742019-03-18 16:51:24 +00002162 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
dan8b47f522019-08-30 16:14:58 +00002163
drh6f883592019-03-30 20:37:04 +00002164 assert( op==OP_Ge || op==OP_Gt || op==OP_Lt || op==OP_Le );
2165 testcase(op==OP_Ge); VdbeCoverageIf(v, op==OP_Ge);
2166 testcase(op==OP_Lt); VdbeCoverageIf(v, op==OP_Lt);
2167 testcase(op==OP_Le); VdbeCoverageIf(v, op==OP_Le);
2168 testcase(op==OP_Gt); VdbeCoverageIf(v, op==OP_Gt);
dan72b9fdc2019-03-09 20:49:17 +00002169 sqlite3ReleaseTempReg(pParse, reg1);
2170 sqlite3ReleaseTempReg(pParse, reg2);
dan8b47f522019-08-30 16:14:58 +00002171
2172 VdbeModuleComment((v, "CodeRangeTest: end"));
dan72b9fdc2019-03-09 20:49:17 +00002173}
2174
dan0525b6f2019-03-18 21:19:40 +00002175/*
2176** Helper function for sqlite3WindowCodeStep(). Each call to this function
2177** generates VM code for a single RETURN_ROW, AGGSTEP or AGGINVERSE
2178** operation. Refer to the header comment for sqlite3WindowCodeStep() for
2179** details.
2180*/
dan00267b82019-03-06 21:04:11 +00002181static int windowCodeOp(
dan0525b6f2019-03-18 21:19:40 +00002182 WindowCodeArg *p, /* Context object */
2183 int op, /* WINDOW_RETURN_ROW, AGGSTEP or AGGINVERSE */
2184 int regCountdown, /* Register for OP_IfPos countdown */
2185 int jumpOnEof /* Jump here if stepped cursor reaches EOF */
dan00267b82019-03-06 21:04:11 +00002186){
dan6c75b392019-03-08 20:02:52 +00002187 int csr, reg;
2188 Parse *pParse = p->pParse;
dan54975cd2019-03-07 20:47:46 +00002189 Window *pMWin = p->pMWin;
dan00267b82019-03-06 21:04:11 +00002190 int ret = 0;
2191 Vdbe *v = p->pVdbe;
dan6c75b392019-03-08 20:02:52 +00002192 int addrContinue = 0;
drhfc15f4c2019-03-28 13:03:41 +00002193 int bPeer = (pMWin->eFrmType!=TK_ROWS);
dan00267b82019-03-06 21:04:11 +00002194
dan72b9fdc2019-03-09 20:49:17 +00002195 int lblDone = sqlite3VdbeMakeLabel(pParse);
2196 int addrNextRange = 0;
2197
dan54975cd2019-03-07 20:47:46 +00002198 /* Special case - WINDOW_AGGINVERSE is always a no-op if the frame
2199 ** starts with UNBOUNDED PRECEDING. */
2200 if( op==WINDOW_AGGINVERSE && pMWin->eStart==TK_UNBOUNDED ){
2201 assert( regCountdown==0 && jumpOnEof==0 );
2202 return 0;
2203 }
2204
dan00267b82019-03-06 21:04:11 +00002205 if( regCountdown>0 ){
drhfc15f4c2019-03-28 13:03:41 +00002206 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00002207 addrNextRange = sqlite3VdbeCurrentAddr(v);
dan0525b6f2019-03-18 21:19:40 +00002208 assert( op==WINDOW_AGGINVERSE || op==WINDOW_AGGSTEP );
2209 if( op==WINDOW_AGGINVERSE ){
2210 if( pMWin->eStart==TK_FOLLOWING ){
dan72b9fdc2019-03-09 20:49:17 +00002211 windowCodeRangeTest(
dan0525b6f2019-03-18 21:19:40 +00002212 p, OP_Le, p->current.csr, regCountdown, p->start.csr, lblDone
dan72b9fdc2019-03-09 20:49:17 +00002213 );
dan0525b6f2019-03-18 21:19:40 +00002214 }else{
2215 windowCodeRangeTest(
2216 p, OP_Ge, p->start.csr, regCountdown, p->current.csr, lblDone
2217 );
dan72b9fdc2019-03-09 20:49:17 +00002218 }
dan0525b6f2019-03-18 21:19:40 +00002219 }else{
2220 windowCodeRangeTest(
2221 p, OP_Gt, p->end.csr, regCountdown, p->current.csr, lblDone
2222 );
dan72b9fdc2019-03-09 20:49:17 +00002223 }
dan72b9fdc2019-03-09 20:49:17 +00002224 }else{
dan37d296a2019-09-24 20:20:05 +00002225 sqlite3VdbeAddOp3(v, OP_IfPos, regCountdown, lblDone, 1);
dan1d4b25f2019-03-19 16:49:15 +00002226 VdbeCoverage(v);
dan72b9fdc2019-03-09 20:49:17 +00002227 }
dan00267b82019-03-06 21:04:11 +00002228 }
2229
dan0525b6f2019-03-18 21:19:40 +00002230 if( op==WINDOW_RETURN_ROW && pMWin->regStartRowid==0 ){
danc782a812019-03-15 20:46:19 +00002231 windowAggFinal(p, 0);
dan6c75b392019-03-08 20:02:52 +00002232 }
2233 addrContinue = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002234
2235 /* If this is a (RANGE BETWEEN a FOLLOWING AND b FOLLOWING) or
2236 ** (RANGE BETWEEN b PRECEDING AND a PRECEDING) frame, ensure the
2237 ** start cursor does not advance past the end cursor within the
2238 ** temporary table. It otherwise might, if (a>b). */
2239 if( pMWin->eStart==pMWin->eEnd && regCountdown
2240 && pMWin->eFrmType==TK_RANGE && op==WINDOW_AGGINVERSE
2241 ){
2242 int regRowid1 = sqlite3GetTempReg(pParse);
2243 int regRowid2 = sqlite3GetTempReg(pParse);
2244 sqlite3VdbeAddOp2(v, OP_Rowid, p->start.csr, regRowid1);
2245 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid2);
2246 sqlite3VdbeAddOp3(v, OP_Ge, regRowid2, lblDone, regRowid1);
drhb19131a2019-09-25 18:44:49 +00002247 VdbeCoverage(v);
dane7579a52019-09-25 16:41:44 +00002248 sqlite3ReleaseTempReg(pParse, regRowid1);
2249 sqlite3ReleaseTempReg(pParse, regRowid2);
2250 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING );
2251 }
2252
dan00267b82019-03-06 21:04:11 +00002253 switch( op ){
2254 case WINDOW_RETURN_ROW:
dan6c75b392019-03-08 20:02:52 +00002255 csr = p->current.csr;
2256 reg = p->current.reg;
danc782a812019-03-15 20:46:19 +00002257 windowReturnOneRow(p);
dan00267b82019-03-06 21:04:11 +00002258 break;
2259
2260 case WINDOW_AGGINVERSE:
dan6c75b392019-03-08 20:02:52 +00002261 csr = p->start.csr;
2262 reg = p->start.reg;
dana0f6b832019-03-14 16:36:20 +00002263 if( pMWin->regStartRowid ){
2264 assert( pMWin->regEndRowid );
2265 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regStartRowid, 1);
2266 }else{
dan37d296a2019-09-24 20:20:05 +00002267 windowAggStep(p, pMWin, csr, 1, p->regArg);
dana0f6b832019-03-14 16:36:20 +00002268 }
dan00267b82019-03-06 21:04:11 +00002269 break;
2270
dan0525b6f2019-03-18 21:19:40 +00002271 default:
2272 assert( op==WINDOW_AGGSTEP );
dan6c75b392019-03-08 20:02:52 +00002273 csr = p->end.csr;
2274 reg = p->end.reg;
dana0f6b832019-03-14 16:36:20 +00002275 if( pMWin->regStartRowid ){
2276 assert( pMWin->regEndRowid );
2277 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regEndRowid, 1);
2278 }else{
dan37d296a2019-09-24 20:20:05 +00002279 windowAggStep(p, pMWin, csr, 0, p->regArg);
dana0f6b832019-03-14 16:36:20 +00002280 }
dan00267b82019-03-06 21:04:11 +00002281 break;
2282 }
2283
danb560a712019-03-13 15:29:14 +00002284 if( op==p->eDelete ){
2285 sqlite3VdbeAddOp1(v, OP_Delete, csr);
2286 sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
2287 }
2288
danc8137502019-03-07 19:26:17 +00002289 if( jumpOnEof ){
2290 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+2);
dan1d4b25f2019-03-19 16:49:15 +00002291 VdbeCoverage(v);
danc8137502019-03-07 19:26:17 +00002292 ret = sqlite3VdbeAddOp0(v, OP_Goto);
2293 }else{
dan6c75b392019-03-08 20:02:52 +00002294 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+1+bPeer);
dan1d4b25f2019-03-19 16:49:15 +00002295 VdbeCoverage(v);
dan6c75b392019-03-08 20:02:52 +00002296 if( bPeer ){
dan37d296a2019-09-24 20:20:05 +00002297 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblDone);
dan6c75b392019-03-08 20:02:52 +00002298 }
dan00267b82019-03-06 21:04:11 +00002299 }
danc8137502019-03-07 19:26:17 +00002300
dan6c75b392019-03-08 20:02:52 +00002301 if( bPeer ){
dan6c75b392019-03-08 20:02:52 +00002302 int nReg = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0);
dane7579a52019-09-25 16:41:44 +00002303 int regTmp = (nReg ? sqlite3GetTempRange(pParse, nReg) : 0);
dan6c75b392019-03-08 20:02:52 +00002304 windowReadPeerValues(p, csr, regTmp);
dan935d9d82019-03-12 15:21:51 +00002305 windowIfNewPeer(pParse, pMWin->pOrderBy, regTmp, reg, addrContinue);
dan6c75b392019-03-08 20:02:52 +00002306 sqlite3ReleaseTempRange(pParse, regTmp, nReg);
dan00267b82019-03-06 21:04:11 +00002307 }
dan6c75b392019-03-08 20:02:52 +00002308
dan72b9fdc2019-03-09 20:49:17 +00002309 if( addrNextRange ){
2310 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNextRange);
2311 }
2312 sqlite3VdbeResolveLabel(v, lblDone);
dan00267b82019-03-06 21:04:11 +00002313 return ret;
2314}
2315
dana786e452019-03-11 18:17:04 +00002316
dan00267b82019-03-06 21:04:11 +00002317/*
dana786e452019-03-11 18:17:04 +00002318** Allocate and return a duplicate of the Window object indicated by the
2319** third argument. Set the Window.pOwner field of the new object to
2320** pOwner.
2321*/
2322Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p){
2323 Window *pNew = 0;
2324 if( ALWAYS(p) ){
2325 pNew = sqlite3DbMallocZero(db, sizeof(Window));
2326 if( pNew ){
2327 pNew->zName = sqlite3DbStrDup(db, p->zName);
danb42eb352019-09-16 05:34:08 +00002328 pNew->zBase = sqlite3DbStrDup(db, p->zBase);
dana786e452019-03-11 18:17:04 +00002329 pNew->pFilter = sqlite3ExprDup(db, p->pFilter, 0);
2330 pNew->pFunc = p->pFunc;
2331 pNew->pPartition = sqlite3ExprListDup(db, p->pPartition, 0);
2332 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, 0);
drhfc15f4c2019-03-28 13:03:41 +00002333 pNew->eFrmType = p->eFrmType;
dana786e452019-03-11 18:17:04 +00002334 pNew->eEnd = p->eEnd;
2335 pNew->eStart = p->eStart;
danc782a812019-03-15 20:46:19 +00002336 pNew->eExclude = p->eExclude;
drhb555b082019-07-19 01:11:27 +00002337 pNew->regResult = p->regResult;
dan0a21ea92020-02-29 17:19:42 +00002338 pNew->regAccum = p->regAccum;
2339 pNew->iArgCol = p->iArgCol;
2340 pNew->iEphCsr = p->iEphCsr;
2341 pNew->bExprArgs = p->bExprArgs;
dana786e452019-03-11 18:17:04 +00002342 pNew->pStart = sqlite3ExprDup(db, p->pStart, 0);
2343 pNew->pEnd = sqlite3ExprDup(db, p->pEnd, 0);
2344 pNew->pOwner = pOwner;
danb42eb352019-09-16 05:34:08 +00002345 pNew->bImplicitFrame = p->bImplicitFrame;
dana786e452019-03-11 18:17:04 +00002346 }
2347 }
2348 return pNew;
2349}
2350
2351/*
2352** Return a copy of the linked list of Window objects passed as the
2353** second argument.
2354*/
2355Window *sqlite3WindowListDup(sqlite3 *db, Window *p){
2356 Window *pWin;
2357 Window *pRet = 0;
2358 Window **pp = &pRet;
2359
2360 for(pWin=p; pWin; pWin=pWin->pNextWin){
2361 *pp = sqlite3WindowDup(db, 0, pWin);
2362 if( *pp==0 ) break;
2363 pp = &((*pp)->pNextWin);
2364 }
2365
2366 return pRet;
2367}
2368
2369/*
dan725b1cf2019-03-26 16:47:17 +00002370** Return true if it can be determined at compile time that expression
2371** pExpr evaluates to a value that, when cast to an integer, is greater
2372** than zero. False otherwise.
2373**
2374** If an OOM error occurs, this function sets the Parse.db.mallocFailed
2375** flag and returns zero.
2376*/
2377static int windowExprGtZero(Parse *pParse, Expr *pExpr){
2378 int ret = 0;
2379 sqlite3 *db = pParse->db;
2380 sqlite3_value *pVal = 0;
2381 sqlite3ValueFromExpr(db, pExpr, db->enc, SQLITE_AFF_NUMERIC, &pVal);
2382 if( pVal && sqlite3_value_int(pVal)>0 ){
2383 ret = 1;
2384 }
2385 sqlite3ValueFree(pVal);
2386 return ret;
2387}
2388
2389/*
dana786e452019-03-11 18:17:04 +00002390** sqlite3WhereBegin() has already been called for the SELECT statement
2391** passed as the second argument when this function is invoked. It generates
2392** code to populate the Window.regResult register for each window function
2393** and invoke the sub-routine at instruction addrGosub once for each row.
2394** sqlite3WhereEnd() is always called before returning.
dan00267b82019-03-06 21:04:11 +00002395**
dana786e452019-03-11 18:17:04 +00002396** This function handles several different types of window frames, which
2397** require slightly different processing. The following pseudo code is
2398** used to implement window frames of the form:
dan00267b82019-03-06 21:04:11 +00002399**
dana786e452019-03-11 18:17:04 +00002400** ROWS BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING
dan00267b82019-03-06 21:04:11 +00002401**
dana786e452019-03-11 18:17:04 +00002402** Other window frame types use variants of the following:
2403**
2404** ... loop started by sqlite3WhereBegin() ...
dan00267b82019-03-06 21:04:11 +00002405** if( new partition ){
2406** Gosub flush
dana786e452019-03-11 18:17:04 +00002407** }
dan00267b82019-03-06 21:04:11 +00002408** Insert new row into eph table.
dana786e452019-03-11 18:17:04 +00002409**
dan00267b82019-03-06 21:04:11 +00002410** if( first row of partition ){
dana786e452019-03-11 18:17:04 +00002411** // Rewind three cursors, all open on the eph table.
2412** Rewind(csrEnd);
2413** Rewind(csrStart);
2414** Rewind(csrCurrent);
2415**
dan00267b82019-03-06 21:04:11 +00002416** regEnd = <expr2> // FOLLOWING expression
2417** regStart = <expr1> // PRECEDING expression
2418** }else{
dana786e452019-03-11 18:17:04 +00002419** // First time this branch is taken, the eph table contains two
2420** // rows. The first row in the partition, which all three cursors
2421** // currently point to, and the following row.
2422** AGGSTEP
dan00267b82019-03-06 21:04:11 +00002423** if( (regEnd--)<=0 ){
dana786e452019-03-11 18:17:04 +00002424** RETURN_ROW
2425** if( (regStart--)<=0 ){
2426** AGGINVERSE
dan00267b82019-03-06 21:04:11 +00002427** }
2428** }
dana786e452019-03-11 18:17:04 +00002429** }
2430** }
dan00267b82019-03-06 21:04:11 +00002431** flush:
dana786e452019-03-11 18:17:04 +00002432** AGGSTEP
2433** while( 1 ){
2434** RETURN ROW
2435** if( csrCurrent is EOF ) break;
2436** if( (regStart--)<=0 ){
2437** AggInverse(csrStart)
2438** Next(csrStart)
dan00267b82019-03-06 21:04:11 +00002439** }
dana786e452019-03-11 18:17:04 +00002440** }
dan00267b82019-03-06 21:04:11 +00002441**
dana786e452019-03-11 18:17:04 +00002442** The pseudo-code above uses the following shorthand:
dan00267b82019-03-06 21:04:11 +00002443**
dana786e452019-03-11 18:17:04 +00002444** AGGSTEP: invoke the aggregate xStep() function for each window function
2445** with arguments read from the current row of cursor csrEnd, then
2446** step cursor csrEnd forward one row (i.e. sqlite3BtreeNext()).
2447**
2448** RETURN_ROW: return a row to the caller based on the contents of the
2449** current row of csrCurrent and the current state of all
2450** aggregates. Then step cursor csrCurrent forward one row.
2451**
2452** AGGINVERSE: invoke the aggregate xInverse() function for each window
2453** functions with arguments read from the current row of cursor
2454** csrStart. Then step csrStart forward one row.
2455**
2456** There are two other ROWS window frames that are handled significantly
2457** differently from the above - "BETWEEN <expr> PRECEDING AND <expr> PRECEDING"
2458** and "BETWEEN <expr> FOLLOWING AND <expr> FOLLOWING". These are special
2459** cases because they change the order in which the three cursors (csrStart,
2460** csrCurrent and csrEnd) iterate through the ephemeral table. Cases that
2461** use UNBOUNDED or CURRENT ROW are much simpler variations on one of these
2462** three.
2463**
2464** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2465**
2466** ... loop started by sqlite3WhereBegin() ...
dan00267b82019-03-06 21:04:11 +00002467** if( new partition ){
2468** Gosub flush
dana786e452019-03-11 18:17:04 +00002469** }
dan00267b82019-03-06 21:04:11 +00002470** Insert new row into eph table.
2471** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002472** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002473** regEnd = <expr2>
2474** regStart = <expr1>
dan00267b82019-03-06 21:04:11 +00002475** }else{
dana786e452019-03-11 18:17:04 +00002476** if( (regEnd--)<=0 ){
2477** AGGSTEP
2478** }
2479** RETURN_ROW
2480** if( (regStart--)<=0 ){
2481** AGGINVERSE
2482** }
2483** }
2484** }
dan00267b82019-03-06 21:04:11 +00002485** flush:
dana786e452019-03-11 18:17:04 +00002486** if( (regEnd--)<=0 ){
2487** AGGSTEP
2488** }
2489** RETURN_ROW
2490**
2491**
2492** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2493**
2494** ... loop started by sqlite3WhereBegin() ...
2495** if( new partition ){
2496** Gosub flush
2497** }
2498** Insert new row into eph table.
2499** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002500** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002501** regEnd = <expr2>
2502** regStart = regEnd - <expr1>
2503** }else{
2504** AGGSTEP
2505** if( (regEnd--)<=0 ){
2506** RETURN_ROW
2507** }
2508** if( (regStart--)<=0 ){
2509** AGGINVERSE
2510** }
2511** }
2512** }
2513** flush:
2514** AGGSTEP
2515** while( 1 ){
2516** if( (regEnd--)<=0 ){
2517** RETURN_ROW
2518** if( eof ) break;
2519** }
2520** if( (regStart--)<=0 ){
2521** AGGINVERSE
2522** if( eof ) break
2523** }
2524** }
2525** while( !eof csrCurrent ){
2526** RETURN_ROW
2527** }
2528**
2529** For the most part, the patterns above are adapted to support UNBOUNDED by
2530** assuming that it is equivalent to "infinity PRECEDING/FOLLOWING" and
2531** CURRENT ROW by assuming that it is equivilent to "0 PRECEDING/FOLLOWING".
2532** This is optimized of course - branches that will never be taken and
2533** conditions that are always true are omitted from the VM code. The only
2534** exceptional case is:
2535**
2536** ROWS BETWEEN <expr1> FOLLOWING AND UNBOUNDED FOLLOWING
2537**
2538** ... loop started by sqlite3WhereBegin() ...
2539** if( new partition ){
2540** Gosub flush
2541** }
2542** Insert new row into eph table.
2543** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002544** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002545** regStart = <expr1>
2546** }else{
2547** AGGSTEP
2548** }
2549** }
2550** flush:
2551** AGGSTEP
2552** while( 1 ){
2553** if( (regStart--)<=0 ){
2554** AGGINVERSE
2555** if( eof ) break
2556** }
2557** RETURN_ROW
2558** }
2559** while( !eof csrCurrent ){
2560** RETURN_ROW
2561** }
dan935d9d82019-03-12 15:21:51 +00002562**
2563** Also requiring special handling are the cases:
2564**
2565** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2566** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2567**
2568** when (expr1 < expr2). This is detected at runtime, not by this function.
2569** To handle this case, the pseudo-code programs depicted above are modified
2570** slightly to be:
2571**
2572** ... loop started by sqlite3WhereBegin() ...
2573** if( new partition ){
2574** Gosub flush
2575** }
2576** Insert new row into eph table.
2577** if( first row of partition ){
2578** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2579** regEnd = <expr2>
2580** regStart = <expr1>
2581** if( regEnd < regStart ){
2582** RETURN_ROW
2583** delete eph table contents
2584** continue
2585** }
2586** ...
2587**
2588** The new "continue" statement in the above jumps to the next iteration
2589** of the outer loop - the one started by sqlite3WhereBegin().
2590**
2591** The various GROUPS cases are implemented using the same patterns as
2592** ROWS. The VM code is modified slightly so that:
2593**
2594** 1. The else branch in the main loop is only taken if the row just
2595** added to the ephemeral table is the start of a new group. In
2596** other words, it becomes:
2597**
2598** ... loop started by sqlite3WhereBegin() ...
2599** if( new partition ){
2600** Gosub flush
2601** }
2602** Insert new row into eph table.
2603** if( first row of partition ){
2604** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2605** regEnd = <expr2>
2606** regStart = <expr1>
2607** }else if( new group ){
2608** ...
2609** }
2610** }
2611**
2612** 2. Instead of processing a single row, each RETURN_ROW, AGGSTEP or
2613** AGGINVERSE step processes the current row of the relevant cursor and
2614** all subsequent rows belonging to the same group.
2615**
2616** RANGE window frames are a little different again. As for GROUPS, the
2617** main loop runs once per group only. And RETURN_ROW, AGGSTEP and AGGINVERSE
2618** deal in groups instead of rows. As for ROWS and GROUPS, there are three
2619** basic cases:
2620**
2621** RANGE BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING
2622**
2623** ... loop started by sqlite3WhereBegin() ...
2624** if( new partition ){
2625** Gosub flush
2626** }
2627** Insert new row into eph table.
2628** if( first row of partition ){
2629** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2630** regEnd = <expr2>
2631** regStart = <expr1>
2632** }else{
2633** AGGSTEP
2634** while( (csrCurrent.key + regEnd) < csrEnd.key ){
2635** RETURN_ROW
2636** while( csrStart.key + regStart) < csrCurrent.key ){
2637** AGGINVERSE
2638** }
2639** }
2640** }
2641** }
2642** flush:
2643** AGGSTEP
2644** while( 1 ){
2645** RETURN ROW
2646** if( csrCurrent is EOF ) break;
2647** while( csrStart.key + regStart) < csrCurrent.key ){
2648** AGGINVERSE
2649** }
2650** }
2651** }
2652**
2653** In the above notation, "csr.key" means the current value of the ORDER BY
2654** expression (there is only ever 1 for a RANGE that uses an <expr> FOLLOWING
2655** or <expr PRECEDING) read from cursor csr.
2656**
2657** RANGE BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2658**
2659** ... loop started by sqlite3WhereBegin() ...
2660** if( new partition ){
2661** Gosub flush
2662** }
2663** Insert new row into eph table.
2664** if( first row of partition ){
2665** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2666** regEnd = <expr2>
2667** regStart = <expr1>
2668** }else{
dan37d296a2019-09-24 20:20:05 +00002669** while( (csrEnd.key + regEnd) <= csrCurrent.key ){
dan935d9d82019-03-12 15:21:51 +00002670** AGGSTEP
2671** }
dan935d9d82019-03-12 15:21:51 +00002672** while( (csrStart.key + regStart) < csrCurrent.key ){
2673** AGGINVERSE
2674** }
dane7579a52019-09-25 16:41:44 +00002675** RETURN_ROW
dan935d9d82019-03-12 15:21:51 +00002676** }
2677** }
2678** flush:
2679** while( (csrEnd.key + regEnd) <= csrCurrent.key ){
2680** AGGSTEP
2681** }
dan3f49c322019-04-03 16:27:44 +00002682** while( (csrStart.key + regStart) < csrCurrent.key ){
2683** AGGINVERSE
2684** }
dane7579a52019-09-25 16:41:44 +00002685** RETURN_ROW
dan935d9d82019-03-12 15:21:51 +00002686**
2687** RANGE BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2688**
2689** ... loop started by sqlite3WhereBegin() ...
2690** if( new partition ){
2691** Gosub flush
2692** }
2693** Insert new row into eph table.
2694** if( first row of partition ){
2695** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2696** regEnd = <expr2>
2697** regStart = <expr1>
2698** }else{
2699** AGGSTEP
2700** while( (csrCurrent.key + regEnd) < csrEnd.key ){
2701** while( (csrCurrent.key + regStart) > csrStart.key ){
2702** AGGINVERSE
2703** }
2704** RETURN_ROW
2705** }
2706** }
2707** }
2708** flush:
2709** AGGSTEP
2710** while( 1 ){
2711** while( (csrCurrent.key + regStart) > csrStart.key ){
2712** AGGINVERSE
2713** if( eof ) break "while( 1 )" loop.
2714** }
2715** RETURN_ROW
2716** }
2717** while( !eof csrCurrent ){
2718** RETURN_ROW
2719** }
2720**
danb6f2dea2019-03-13 17:20:27 +00002721** The text above leaves out many details. Refer to the code and comments
2722** below for a more complete picture.
dan00267b82019-03-06 21:04:11 +00002723*/
dana786e452019-03-11 18:17:04 +00002724void sqlite3WindowCodeStep(
dancc7a8502019-03-11 19:50:54 +00002725 Parse *pParse, /* Parse context */
dana786e452019-03-11 18:17:04 +00002726 Select *p, /* Rewritten SELECT statement */
2727 WhereInfo *pWInfo, /* Context returned by sqlite3WhereBegin() */
2728 int regGosub, /* Register for OP_Gosub */
2729 int addrGosub /* OP_Gosub here to return each row */
dan680f6e82019-03-04 21:07:11 +00002730){
2731 Window *pMWin = p->pWin;
dan6c75b392019-03-08 20:02:52 +00002732 ExprList *pOrderBy = pMWin->pOrderBy;
dan680f6e82019-03-04 21:07:11 +00002733 Vdbe *v = sqlite3GetVdbe(pParse);
dana786e452019-03-11 18:17:04 +00002734 int csrWrite; /* Cursor used to write to eph. table */
2735 int csrInput = p->pSrc->a[0].iCursor; /* Cursor of sub-select */
2736 int nInput = p->pSrc->a[0].pTab->nCol; /* Number of cols returned by sub */
2737 int iInput; /* To iterate through sub cols */
danbf845152019-03-16 10:15:24 +00002738 int addrNe; /* Address of OP_Ne */
drhd4a591d2019-03-26 16:21:11 +00002739 int addrGosubFlush = 0; /* Address of OP_Gosub to flush: */
2740 int addrInteger = 0; /* Address of OP_Integer */
dand4461652019-03-13 08:28:51 +00002741 int addrEmpty; /* Address of OP_Rewind in flush: */
dana786e452019-03-11 18:17:04 +00002742 int regNew; /* Array of registers holding new input row */
2743 int regRecord; /* regNew array in record form */
2744 int regRowid; /* Rowid for regRecord in eph table */
2745 int regNewPeer = 0; /* Peer values for new row (part of regNew) */
2746 int regPeer = 0; /* Peer values for current row */
dand4461652019-03-13 08:28:51 +00002747 int regFlushPart = 0; /* Register for "Gosub flush_partition" */
dana786e452019-03-11 18:17:04 +00002748 WindowCodeArg s; /* Context object for sub-routines */
dan935d9d82019-03-12 15:21:51 +00002749 int lblWhereEnd; /* Label just before sqlite3WhereEnd() code */
dane7579a52019-09-25 16:41:44 +00002750 int regStart = 0; /* Value of <expr> PRECEDING */
2751 int regEnd = 0; /* Value of <expr> FOLLOWING */
dan680f6e82019-03-04 21:07:11 +00002752
dan72b9fdc2019-03-09 20:49:17 +00002753 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_CURRENT
2754 || pMWin->eStart==TK_FOLLOWING || pMWin->eStart==TK_UNBOUNDED
2755 );
2756 assert( pMWin->eEnd==TK_FOLLOWING || pMWin->eEnd==TK_CURRENT
2757 || pMWin->eEnd==TK_UNBOUNDED || pMWin->eEnd==TK_PRECEDING
2758 );
dan108e6b22019-03-18 18:55:35 +00002759 assert( pMWin->eExclude==0 || pMWin->eExclude==TK_CURRENT
2760 || pMWin->eExclude==TK_GROUP || pMWin->eExclude==TK_TIES
2761 || pMWin->eExclude==TK_NO
2762 );
dan72b9fdc2019-03-09 20:49:17 +00002763
dan935d9d82019-03-12 15:21:51 +00002764 lblWhereEnd = sqlite3VdbeMakeLabel(pParse);
dana786e452019-03-11 18:17:04 +00002765
2766 /* Fill in the context object */
dan00267b82019-03-06 21:04:11 +00002767 memset(&s, 0, sizeof(WindowCodeArg));
2768 s.pParse = pParse;
2769 s.pMWin = pMWin;
2770 s.pVdbe = v;
2771 s.regGosub = regGosub;
2772 s.addrGosub = addrGosub;
dan6c75b392019-03-08 20:02:52 +00002773 s.current.csr = pMWin->iEphCsr;
dana786e452019-03-11 18:17:04 +00002774 csrWrite = s.current.csr+1;
dan6c75b392019-03-08 20:02:52 +00002775 s.start.csr = s.current.csr+2;
2776 s.end.csr = s.current.csr+3;
danb33487b2019-03-06 17:12:32 +00002777
danb560a712019-03-13 15:29:14 +00002778 /* Figure out when rows may be deleted from the ephemeral table. There
2779 ** are four options - they may never be deleted (eDelete==0), they may
2780 ** be deleted as soon as they are no longer part of the window frame
2781 ** (eDelete==WINDOW_AGGINVERSE), they may be deleted as after the row
2782 ** has been returned to the caller (WINDOW_RETURN_ROW), or they may
2783 ** be deleted after they enter the frame (WINDOW_AGGSTEP). */
2784 switch( pMWin->eStart ){
dan725b1cf2019-03-26 16:47:17 +00002785 case TK_FOLLOWING:
drhfc15f4c2019-03-28 13:03:41 +00002786 if( pMWin->eFrmType!=TK_RANGE
2787 && windowExprGtZero(pParse, pMWin->pStart)
2788 ){
dan725b1cf2019-03-26 16:47:17 +00002789 s.eDelete = WINDOW_RETURN_ROW;
danb560a712019-03-13 15:29:14 +00002790 }
danb560a712019-03-13 15:29:14 +00002791 break;
danb560a712019-03-13 15:29:14 +00002792 case TK_UNBOUNDED:
2793 if( windowCacheFrame(pMWin)==0 ){
2794 if( pMWin->eEnd==TK_PRECEDING ){
drhfc15f4c2019-03-28 13:03:41 +00002795 if( pMWin->eFrmType!=TK_RANGE
2796 && windowExprGtZero(pParse, pMWin->pEnd)
2797 ){
dan725b1cf2019-03-26 16:47:17 +00002798 s.eDelete = WINDOW_AGGSTEP;
2799 }
danb560a712019-03-13 15:29:14 +00002800 }else{
2801 s.eDelete = WINDOW_RETURN_ROW;
2802 }
2803 }
2804 break;
2805 default:
2806 s.eDelete = WINDOW_AGGINVERSE;
2807 break;
2808 }
2809
dand4461652019-03-13 08:28:51 +00002810 /* Allocate registers for the array of values from the sub-query, the
2811 ** samve values in record form, and the rowid used to insert said record
2812 ** into the ephemeral table. */
dana786e452019-03-11 18:17:04 +00002813 regNew = pParse->nMem+1;
2814 pParse->nMem += nInput;
2815 regRecord = ++pParse->nMem;
2816 regRowid = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002817
dana786e452019-03-11 18:17:04 +00002818 /* If the window frame contains an "<expr> PRECEDING" or "<expr> FOLLOWING"
2819 ** clause, allocate registers to store the results of evaluating each
2820 ** <expr>. */
dan54975cd2019-03-07 20:47:46 +00002821 if( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING ){
dane7579a52019-09-25 16:41:44 +00002822 regStart = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002823 }
2824 if( pMWin->eEnd==TK_PRECEDING || pMWin->eEnd==TK_FOLLOWING ){
dane7579a52019-09-25 16:41:44 +00002825 regEnd = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002826 }
dan680f6e82019-03-04 21:07:11 +00002827
dan72b9fdc2019-03-09 20:49:17 +00002828 /* If this is not a "ROWS BETWEEN ..." frame, then allocate arrays of
dana786e452019-03-11 18:17:04 +00002829 ** registers to store copies of the ORDER BY expressions (peer values)
2830 ** for the main loop, and for each cursor (start, current and end). */
drhfc15f4c2019-03-28 13:03:41 +00002831 if( pMWin->eFrmType!=TK_ROWS ){
dan6c75b392019-03-08 20:02:52 +00002832 int nPeer = (pOrderBy ? pOrderBy->nExpr : 0);
dana786e452019-03-11 18:17:04 +00002833 regNewPeer = regNew + pMWin->nBufferCol;
dan6c75b392019-03-08 20:02:52 +00002834 if( pMWin->pPartition ) regNewPeer += pMWin->pPartition->nExpr;
dan6c75b392019-03-08 20:02:52 +00002835 regPeer = pParse->nMem+1; pParse->nMem += nPeer;
2836 s.start.reg = pParse->nMem+1; pParse->nMem += nPeer;
2837 s.current.reg = pParse->nMem+1; pParse->nMem += nPeer;
2838 s.end.reg = pParse->nMem+1; pParse->nMem += nPeer;
2839 }
2840
dan680f6e82019-03-04 21:07:11 +00002841 /* Load the column values for the row returned by the sub-select
dana786e452019-03-11 18:17:04 +00002842 ** into an array of registers starting at regNew. Assemble them into
2843 ** a record in register regRecord. */
2844 for(iInput=0; iInput<nInput; iInput++){
2845 sqlite3VdbeAddOp3(v, OP_Column, csrInput, iInput, regNew+iInput);
dan680f6e82019-03-04 21:07:11 +00002846 }
dana786e452019-03-11 18:17:04 +00002847 sqlite3VdbeAddOp3(v, OP_MakeRecord, regNew, nInput, regRecord);
dan680f6e82019-03-04 21:07:11 +00002848
danb33487b2019-03-06 17:12:32 +00002849 /* An input row has just been read into an array of registers starting
dana786e452019-03-11 18:17:04 +00002850 ** at regNew. If the window has a PARTITION clause, this block generates
danb33487b2019-03-06 17:12:32 +00002851 ** VM code to check if the input row is the start of a new partition.
2852 ** If so, it does an OP_Gosub to an address to be filled in later. The
dana786e452019-03-11 18:17:04 +00002853 ** address of the OP_Gosub is stored in local variable addrGosubFlush. */
dan680f6e82019-03-04 21:07:11 +00002854 if( pMWin->pPartition ){
2855 int addr;
2856 ExprList *pPart = pMWin->pPartition;
2857 int nPart = pPart->nExpr;
dana786e452019-03-11 18:17:04 +00002858 int regNewPart = regNew + pMWin->nBufferCol;
dan680f6e82019-03-04 21:07:11 +00002859 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pPart, 0, 0);
2860
dand4461652019-03-13 08:28:51 +00002861 regFlushPart = ++pParse->nMem;
dan680f6e82019-03-04 21:07:11 +00002862 addr = sqlite3VdbeAddOp3(v, OP_Compare, regNewPart, pMWin->regPart, nPart);
2863 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
danb33487b2019-03-06 17:12:32 +00002864 sqlite3VdbeAddOp3(v, OP_Jump, addr+2, addr+4, addr+2);
dan680f6e82019-03-04 21:07:11 +00002865 VdbeCoverageEqNe(v);
2866 addrGosubFlush = sqlite3VdbeAddOp1(v, OP_Gosub, regFlushPart);
2867 VdbeComment((v, "call flush_partition"));
danb33487b2019-03-06 17:12:32 +00002868 sqlite3VdbeAddOp3(v, OP_Copy, regNewPart, pMWin->regPart, nPart-1);
dan680f6e82019-03-04 21:07:11 +00002869 }
2870
2871 /* Insert the new row into the ephemeral table */
2872 sqlite3VdbeAddOp2(v, OP_NewRowid, csrWrite, regRowid);
2873 sqlite3VdbeAddOp3(v, OP_Insert, csrWrite, regRecord, regRowid);
danbf845152019-03-16 10:15:24 +00002874 addrNe = sqlite3VdbeAddOp3(v, OP_Ne, pMWin->regOne, 0, regRowid);
drh83c5bb92019-04-01 15:55:38 +00002875 VdbeCoverageNeverNull(v);
danb25a2142019-03-05 19:29:36 +00002876
danb33487b2019-03-06 17:12:32 +00002877 /* This block is run for the first row of each partition */
dana786e452019-03-11 18:17:04 +00002878 s.regArg = windowInitAccum(pParse, pMWin);
dan680f6e82019-03-04 21:07:11 +00002879
dane7579a52019-09-25 16:41:44 +00002880 if( regStart ){
2881 sqlite3ExprCode(pParse, pMWin->pStart, regStart);
2882 windowCheckValue(pParse, regStart, 0 + (pMWin->eFrmType==TK_RANGE?3:0));
dan54975cd2019-03-07 20:47:46 +00002883 }
dane7579a52019-09-25 16:41:44 +00002884 if( regEnd ){
2885 sqlite3ExprCode(pParse, pMWin->pEnd, regEnd);
2886 windowCheckValue(pParse, regEnd, 1 + (pMWin->eFrmType==TK_RANGE?3:0));
dan54975cd2019-03-07 20:47:46 +00002887 }
danb25a2142019-03-05 19:29:36 +00002888
dane7579a52019-09-25 16:41:44 +00002889 if( pMWin->eFrmType!=TK_RANGE && pMWin->eStart==pMWin->eEnd && regStart ){
danb25a2142019-03-05 19:29:36 +00002890 int op = ((pMWin->eStart==TK_FOLLOWING) ? OP_Ge : OP_Le);
dane7579a52019-09-25 16:41:44 +00002891 int addrGe = sqlite3VdbeAddOp3(v, op, regStart, 0, regEnd);
drh495ed622019-04-01 16:23:21 +00002892 VdbeCoverageNeverNullIf(v, op==OP_Ge); /* NeverNull because bound <expr> */
2893 VdbeCoverageNeverNullIf(v, op==OP_Le); /* values previously checked */
danc782a812019-03-15 20:46:19 +00002894 windowAggFinal(&s, 0);
dancc7a8502019-03-11 19:50:54 +00002895 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002896 VdbeCoverageNeverTaken(v);
danc782a812019-03-15 20:46:19 +00002897 windowReturnOneRow(&s);
dancc7a8502019-03-11 19:50:54 +00002898 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr);
dan935d9d82019-03-12 15:21:51 +00002899 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd);
danb25a2142019-03-05 19:29:36 +00002900 sqlite3VdbeJumpHere(v, addrGe);
2901 }
dane7579a52019-09-25 16:41:44 +00002902 if( pMWin->eStart==TK_FOLLOWING && pMWin->eFrmType!=TK_RANGE && regEnd ){
dan54975cd2019-03-07 20:47:46 +00002903 assert( pMWin->eEnd==TK_FOLLOWING );
dane7579a52019-09-25 16:41:44 +00002904 sqlite3VdbeAddOp3(v, OP_Subtract, regStart, regEnd, regStart);
danb25a2142019-03-05 19:29:36 +00002905 }
2906
dan54975cd2019-03-07 20:47:46 +00002907 if( pMWin->eStart!=TK_UNBOUNDED ){
dan6c75b392019-03-08 20:02:52 +00002908 sqlite3VdbeAddOp2(v, OP_Rewind, s.start.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002909 VdbeCoverageNeverTaken(v);
dan54975cd2019-03-07 20:47:46 +00002910 }
dan6c75b392019-03-08 20:02:52 +00002911 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002912 VdbeCoverageNeverTaken(v);
dan6c75b392019-03-08 20:02:52 +00002913 sqlite3VdbeAddOp2(v, OP_Rewind, s.end.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002914 VdbeCoverageNeverTaken(v);
dan6c75b392019-03-08 20:02:52 +00002915 if( regPeer && pOrderBy ){
dancc7a8502019-03-11 19:50:54 +00002916 sqlite3VdbeAddOp3(v, OP_Copy, regNewPeer, regPeer, pOrderBy->nExpr-1);
dan6c75b392019-03-08 20:02:52 +00002917 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.start.reg, pOrderBy->nExpr-1);
2918 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.current.reg, pOrderBy->nExpr-1);
2919 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.end.reg, pOrderBy->nExpr-1);
2920 }
danb25a2142019-03-05 19:29:36 +00002921
dan935d9d82019-03-12 15:21:51 +00002922 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd);
dan680f6e82019-03-04 21:07:11 +00002923
danbf845152019-03-16 10:15:24 +00002924 sqlite3VdbeJumpHere(v, addrNe);
dan3f49c322019-04-03 16:27:44 +00002925
2926 /* Beginning of the block executed for the second and subsequent rows. */
dan6c75b392019-03-08 20:02:52 +00002927 if( regPeer ){
dan935d9d82019-03-12 15:21:51 +00002928 windowIfNewPeer(pParse, pOrderBy, regNewPeer, regPeer, lblWhereEnd);
dan6c75b392019-03-08 20:02:52 +00002929 }
danb25a2142019-03-05 19:29:36 +00002930 if( pMWin->eStart==TK_FOLLOWING ){
dan6c75b392019-03-08 20:02:52 +00002931 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
dan54975cd2019-03-07 20:47:46 +00002932 if( pMWin->eEnd!=TK_UNBOUNDED ){
drhfc15f4c2019-03-28 13:03:41 +00002933 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00002934 int lbl = sqlite3VdbeMakeLabel(pParse);
2935 int addrNext = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002936 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl);
2937 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan72b9fdc2019-03-09 20:49:17 +00002938 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
2939 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNext);
2940 sqlite3VdbeResolveLabel(v, lbl);
2941 }else{
dane7579a52019-09-25 16:41:44 +00002942 windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 0);
2943 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan72b9fdc2019-03-09 20:49:17 +00002944 }
dan54975cd2019-03-07 20:47:46 +00002945 }
danb25a2142019-03-05 19:29:36 +00002946 }else
2947 if( pMWin->eEnd==TK_PRECEDING ){
dan3f49c322019-04-03 16:27:44 +00002948 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE);
dane7579a52019-09-25 16:41:44 +00002949 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0);
2950 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan6c75b392019-03-08 20:02:52 +00002951 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00002952 if( !bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
danb25a2142019-03-05 19:29:36 +00002953 }else{
mistachkinba9ee092019-03-27 14:58:18 +00002954 int addr = 0;
dan6c75b392019-03-08 20:02:52 +00002955 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
dan54975cd2019-03-07 20:47:46 +00002956 if( pMWin->eEnd!=TK_UNBOUNDED ){
drhfc15f4c2019-03-28 13:03:41 +00002957 if( pMWin->eFrmType==TK_RANGE ){
mistachkinba9ee092019-03-27 14:58:18 +00002958 int lbl = 0;
dan72b9fdc2019-03-09 20:49:17 +00002959 addr = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002960 if( regEnd ){
dan72b9fdc2019-03-09 20:49:17 +00002961 lbl = sqlite3VdbeMakeLabel(pParse);
dane7579a52019-09-25 16:41:44 +00002962 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl);
dan72b9fdc2019-03-09 20:49:17 +00002963 }
2964 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00002965 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
2966 if( regEnd ){
dan72b9fdc2019-03-09 20:49:17 +00002967 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr);
2968 sqlite3VdbeResolveLabel(v, lbl);
2969 }
2970 }else{
dane7579a52019-09-25 16:41:44 +00002971 if( regEnd ){
2972 addr = sqlite3VdbeAddOp3(v, OP_IfPos, regEnd, 0, 1);
dan1d4b25f2019-03-19 16:49:15 +00002973 VdbeCoverage(v);
2974 }
dan72b9fdc2019-03-09 20:49:17 +00002975 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00002976 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
2977 if( regEnd ) sqlite3VdbeJumpHere(v, addr);
dan72b9fdc2019-03-09 20:49:17 +00002978 }
dan54975cd2019-03-07 20:47:46 +00002979 }
danb25a2142019-03-05 19:29:36 +00002980 }
dan680f6e82019-03-04 21:07:11 +00002981
dan680f6e82019-03-04 21:07:11 +00002982 /* End of the main input loop */
dan935d9d82019-03-12 15:21:51 +00002983 sqlite3VdbeResolveLabel(v, lblWhereEnd);
dancc7a8502019-03-11 19:50:54 +00002984 sqlite3WhereEnd(pWInfo);
dan680f6e82019-03-04 21:07:11 +00002985
2986 /* Fall through */
dancc7a8502019-03-11 19:50:54 +00002987 if( pMWin->pPartition ){
dan680f6e82019-03-04 21:07:11 +00002988 addrInteger = sqlite3VdbeAddOp2(v, OP_Integer, 0, regFlushPart);
2989 sqlite3VdbeJumpHere(v, addrGosubFlush);
2990 }
2991
danc8137502019-03-07 19:26:17 +00002992 addrEmpty = sqlite3VdbeAddOp1(v, OP_Rewind, csrWrite);
dan1d4b25f2019-03-19 16:49:15 +00002993 VdbeCoverage(v);
dan00267b82019-03-06 21:04:11 +00002994 if( pMWin->eEnd==TK_PRECEDING ){
dan3f49c322019-04-03 16:27:44 +00002995 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE);
dane7579a52019-09-25 16:41:44 +00002996 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0);
2997 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan6c75b392019-03-08 20:02:52 +00002998 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
danc8137502019-03-07 19:26:17 +00002999 }else if( pMWin->eStart==TK_FOLLOWING ){
3000 int addrStart;
3001 int addrBreak1;
3002 int addrBreak2;
3003 int addrBreak3;
dan6c75b392019-03-08 20:02:52 +00003004 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
drhfc15f4c2019-03-28 13:03:41 +00003005 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00003006 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003007 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1);
dan72b9fdc2019-03-09 20:49:17 +00003008 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
3009 }else
dan54975cd2019-03-07 20:47:46 +00003010 if( pMWin->eEnd==TK_UNBOUNDED ){
3011 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003012 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regStart, 1);
dan6c75b392019-03-08 20:02:52 +00003013 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, 0, 1);
dan54975cd2019-03-07 20:47:46 +00003014 }else{
3015 assert( pMWin->eEnd==TK_FOLLOWING );
3016 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003017 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 1);
3018 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1);
dan54975cd2019-03-07 20:47:46 +00003019 }
danc8137502019-03-07 19:26:17 +00003020 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3021 sqlite3VdbeJumpHere(v, addrBreak2);
3022 addrStart = sqlite3VdbeCurrentAddr(v);
dan6c75b392019-03-08 20:02:52 +00003023 addrBreak3 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
danc8137502019-03-07 19:26:17 +00003024 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3025 sqlite3VdbeJumpHere(v, addrBreak1);
3026 sqlite3VdbeJumpHere(v, addrBreak3);
danb25a2142019-03-05 19:29:36 +00003027 }else{
dan00267b82019-03-06 21:04:11 +00003028 int addrBreak;
danc8137502019-03-07 19:26:17 +00003029 int addrStart;
dan6c75b392019-03-08 20:02:52 +00003030 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
danc8137502019-03-07 19:26:17 +00003031 addrStart = sqlite3VdbeCurrentAddr(v);
dan6c75b392019-03-08 20:02:52 +00003032 addrBreak = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
dane7579a52019-09-25 16:41:44 +00003033 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan00267b82019-03-06 21:04:11 +00003034 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3035 sqlite3VdbeJumpHere(v, addrBreak);
danb25a2142019-03-05 19:29:36 +00003036 }
danc8137502019-03-07 19:26:17 +00003037 sqlite3VdbeJumpHere(v, addrEmpty);
3038
dan6c75b392019-03-08 20:02:52 +00003039 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr);
dan680f6e82019-03-04 21:07:11 +00003040 if( pMWin->pPartition ){
dana0f6b832019-03-14 16:36:20 +00003041 if( pMWin->regStartRowid ){
3042 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid);
3043 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid);
3044 }
dan680f6e82019-03-04 21:07:11 +00003045 sqlite3VdbeChangeP1(v, addrInteger, sqlite3VdbeCurrentAddr(v));
3046 sqlite3VdbeAddOp1(v, OP_Return, regFlushPart);
3047 }
3048}
3049
dan67a9b8e2018-06-22 20:51:35 +00003050#endif /* SQLITE_OMIT_WINDOWFUNC */