blob: a03ea0d656cadc81e535a89ee240d4075d2b9a4b [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) { \
drhf9751072021-10-07 13:40:29 +0000584 nArg, (SQLITE_FUNC_BUILTIN|SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \
dan1c5ed622018-06-05 16:16:17 +0000585 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) { \
drhf9751072021-10-07 13:40:29 +0000592 nArg, (SQLITE_FUNC_BUILTIN|SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \
drh19dc4d42018-07-08 01:02:26 +0000593 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) { \
drhf9751072021-10-07 13:40:29 +0000601 nArg, (SQLITE_FUNC_BUILTIN|SQLITE_UTF8|SQLITE_FUNC_WINDOW|extra), 0, 0, \
drh19dc4d42018-07-08 01:02:26 +0000602 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 }
drh105dcaa2022-03-10 16:01:14 +0000727 pWin->pWFunc = 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;
drhd22ecfd2021-04-06 13:56:46 +0000791 if( pParse->db->mallocFailed ) return WRC_Abort;
dan62be2dc2019-11-23 15:10:28 +0000792 if( p->pSub ){
793 int i;
794 for(i=0; i<p->pSub->nExpr; i++){
795 if( 0==sqlite3ExprCompare(0, p->pSub->a[i].pExpr, pExpr, -1) ){
796 iCol = i;
797 break;
798 }
799 }
800 }
801 if( iCol<0 ){
802 Expr *pDup = sqlite3ExprDup(pParse->db, pExpr, 0);
dan43170432019-12-27 16:25:56 +0000803 if( pDup && pDup->op==TK_AGG_FUNCTION ) pDup->op = TK_FUNCTION;
dan62be2dc2019-11-23 15:10:28 +0000804 p->pSub = sqlite3ExprListAppend(pParse, p->pSub, pDup);
805 }
dandfa552f2018-06-02 21:04:28 +0000806 if( p->pSub ){
dan27da9072020-07-13 15:20:27 +0000807 int f = pExpr->flags & EP_Collate;
dandfa552f2018-06-02 21:04:28 +0000808 assert( ExprHasProperty(pExpr, EP_Static)==0 );
809 ExprSetProperty(pExpr, EP_Static);
810 sqlite3ExprDelete(pParse->db, pExpr);
811 ExprClearProperty(pExpr, EP_Static);
812 memset(pExpr, 0, sizeof(Expr));
813
814 pExpr->op = TK_COLUMN;
dan62be2dc2019-11-23 15:10:28 +0000815 pExpr->iColumn = (iCol<0 ? p->pSub->nExpr-1: iCol);
dandfa552f2018-06-02 21:04:28 +0000816 pExpr->iTable = p->pWin->iEphCsr;
dan62742fd2019-07-08 12:01:39 +0000817 pExpr->y.pTab = p->pTab;
dan27da9072020-07-13 15:20:27 +0000818 pExpr->flags = f;
dandfa552f2018-06-02 21:04:28 +0000819 }
drha2f142d2019-11-23 16:34:40 +0000820 if( pParse->db->mallocFailed ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +0000821 break;
822 }
823
824 default: /* no-op */
825 break;
826 }
827
828 return WRC_Continue;
829}
danc0bb4452018-06-12 20:53:38 +0000830static int selectWindowRewriteSelectCb(Walker *pWalker, Select *pSelect){
danb556f262018-07-10 17:26:12 +0000831 struct WindowRewrite *p = pWalker->u.pRewrite;
832 Select *pSave = p->pSubSelect;
833 if( pSave==pSelect ){
834 return WRC_Continue;
835 }else{
836 p->pSubSelect = pSelect;
837 sqlite3WalkSelect(pWalker, pSelect);
838 p->pSubSelect = pSave;
839 }
danc0bb4452018-06-12 20:53:38 +0000840 return WRC_Prune;
841}
dandfa552f2018-06-02 21:04:28 +0000842
danc0bb4452018-06-12 20:53:38 +0000843
844/*
845** Iterate through each expression in expression-list pEList. For each:
846**
847** * TK_COLUMN,
848** * aggregate function, or
849** * window function with a Window object that is not a member of the
danb556f262018-07-10 17:26:12 +0000850** Window list passed as the second argument (pWin).
danc0bb4452018-06-12 20:53:38 +0000851**
852** Append the node to output expression-list (*ppSub). And replace it
853** with a TK_COLUMN that reads the (N-1)th element of table
854** pWin->iEphCsr, where N is the number of elements in (*ppSub) after
855** appending the new one.
856*/
dan13b08bb2018-06-15 20:46:12 +0000857static void selectWindowRewriteEList(
dandfa552f2018-06-02 21:04:28 +0000858 Parse *pParse,
859 Window *pWin,
danb556f262018-07-10 17:26:12 +0000860 SrcList *pSrc,
dandfa552f2018-06-02 21:04:28 +0000861 ExprList *pEList, /* Rewrite expressions in this list */
dan62742fd2019-07-08 12:01:39 +0000862 Table *pTab,
dandfa552f2018-06-02 21:04:28 +0000863 ExprList **ppSub /* IN/OUT: Sub-select expression-list */
864){
865 Walker sWalker;
866 WindowRewrite sRewrite;
dandfa552f2018-06-02 21:04:28 +0000867
drh55f66b32019-07-16 19:44:32 +0000868 assert( pWin!=0 );
dandfa552f2018-06-02 21:04:28 +0000869 memset(&sWalker, 0, sizeof(Walker));
870 memset(&sRewrite, 0, sizeof(WindowRewrite));
871
872 sRewrite.pSub = *ppSub;
873 sRewrite.pWin = pWin;
danb556f262018-07-10 17:26:12 +0000874 sRewrite.pSrc = pSrc;
dan62742fd2019-07-08 12:01:39 +0000875 sRewrite.pTab = pTab;
dandfa552f2018-06-02 21:04:28 +0000876
877 sWalker.pParse = pParse;
878 sWalker.xExprCallback = selectWindowRewriteExprCb;
879 sWalker.xSelectCallback = selectWindowRewriteSelectCb;
880 sWalker.u.pRewrite = &sRewrite;
881
dan13b08bb2018-06-15 20:46:12 +0000882 (void)sqlite3WalkExprList(&sWalker, pEList);
dandfa552f2018-06-02 21:04:28 +0000883
884 *ppSub = sRewrite.pSub;
dandfa552f2018-06-02 21:04:28 +0000885}
886
danc0bb4452018-06-12 20:53:38 +0000887/*
888** Append a copy of each expression in expression-list pAppend to
889** expression list pList. Return a pointer to the result list.
890*/
dandfa552f2018-06-02 21:04:28 +0000891static ExprList *exprListAppendList(
892 Parse *pParse, /* Parsing context */
893 ExprList *pList, /* List to which to append. Might be NULL */
dan08f6de72019-05-10 14:26:32 +0000894 ExprList *pAppend, /* List of values to append. Might be NULL */
895 int bIntToNull
dandfa552f2018-06-02 21:04:28 +0000896){
897 if( pAppend ){
898 int i;
899 int nInit = pList ? pList->nExpr : 0;
900 for(i=0; i<pAppend->nExpr; i++){
drh57f90182021-04-03 23:30:33 +0000901 sqlite3 *db = pParse->db;
902 Expr *pDup = sqlite3ExprDup(db, pAppend->a[i].pExpr, 0);
drh75e95e12019-12-18 00:05:50 +0000903 assert( pDup==0 || !ExprHasProperty(pDup, EP_MemToken) );
drh4c4a2572021-04-06 12:50:24 +0000904 if( db->mallocFailed ){
905 sqlite3ExprDelete(db, pDup);
906 break;
907 }
908 if( bIntToNull ){
danefa78882020-05-11 10:55:24 +0000909 int iDummy;
910 Expr *pSub;
dana261c022021-06-23 11:12:48 +0000911 pSub = sqlite3ExprSkipCollateAndLikely(pDup);
danefa78882020-05-11 10:55:24 +0000912 if( sqlite3ExprIsInteger(pSub, &iDummy) ){
913 pSub->op = TK_NULL;
914 pSub->flags &= ~(EP_IntValue|EP_IsTrue|EP_IsFalse);
915 pSub->u.zToken = 0;
916 }
dan08f6de72019-05-10 14:26:32 +0000917 }
dandfa552f2018-06-02 21:04:28 +0000918 pList = sqlite3ExprListAppend(pParse, pList, pDup);
dan6e118922019-08-12 16:36:38 +0000919 if( pList ) pList->a[nInit+i].sortFlags = pAppend->a[i].sortFlags;
dandfa552f2018-06-02 21:04:28 +0000920 }
921 }
922 return pList;
923}
924
925/*
drhc37577b2020-05-24 03:38:37 +0000926** When rewriting a query, if the new subquery in the FROM clause
927** contains TK_AGG_FUNCTION nodes that refer to an outer query,
928** then we have to increase the Expr->op2 values of those nodes
929** due to the extra subquery layer that was added.
930**
931** See also the incrAggDepth() routine in resolve.c
932*/
933static int sqlite3WindowExtraAggFuncDepth(Walker *pWalker, Expr *pExpr){
934 if( pExpr->op==TK_AGG_FUNCTION
935 && pExpr->op2>=pWalker->walkerDepth
936 ){
937 pExpr->op2++;
938 }
939 return WRC_Continue;
940}
941
drh4752bbd2021-05-07 15:46:36 +0000942static int disallowAggregatesInOrderByCb(Walker *pWalker, Expr *pExpr){
943 if( pExpr->op==TK_AGG_FUNCTION && pExpr->pAggInfo==0 ){
drhf9751072021-10-07 13:40:29 +0000944 assert( !ExprHasProperty(pExpr, EP_IntValue) );
945 sqlite3ErrorMsg(pWalker->pParse,
drh4752bbd2021-05-07 15:46:36 +0000946 "misuse of aggregate: %s()", pExpr->u.zToken);
947 }
948 return WRC_Continue;
949}
950
drhc37577b2020-05-24 03:38:37 +0000951/*
dandfa552f2018-06-02 21:04:28 +0000952** If the SELECT statement passed as the second argument does not invoke
953** any SQL window functions, this function is a no-op. Otherwise, it
954** rewrites the SELECT statement so that window function xStep functions
danc0bb4452018-06-12 20:53:38 +0000955** are invoked in the correct order as described under "SELECT REWRITING"
956** at the top of this file.
dandfa552f2018-06-02 21:04:28 +0000957*/
958int sqlite3WindowRewrite(Parse *pParse, Select *p){
959 int rc = SQLITE_OK;
drh14c4d422021-05-26 18:46:51 +0000960 if( p->pWin && p->pPrior==0 && ALWAYS((p->selFlags & SF_WinRewrite)==0) ){
dandfa552f2018-06-02 21:04:28 +0000961 Vdbe *v = sqlite3GetVdbe(pParse);
dandfa552f2018-06-02 21:04:28 +0000962 sqlite3 *db = pParse->db;
963 Select *pSub = 0; /* The subquery */
964 SrcList *pSrc = p->pSrc;
965 Expr *pWhere = p->pWhere;
966 ExprList *pGroupBy = p->pGroupBy;
967 Expr *pHaving = p->pHaving;
968 ExprList *pSort = 0;
969
970 ExprList *pSublist = 0; /* Expression list for sub-query */
drh067b92b2020-06-19 15:24:12 +0000971 Window *pMWin = p->pWin; /* Main window object */
dandfa552f2018-06-02 21:04:28 +0000972 Window *pWin; /* Window object iterator */
dan62742fd2019-07-08 12:01:39 +0000973 Table *pTab;
drh89636622020-06-07 17:33:18 +0000974 Walker w;
975
dan553948e2020-03-16 18:52:53 +0000976 u32 selFlags = p->selFlags;
dan62742fd2019-07-08 12:01:39 +0000977
978 pTab = sqlite3DbMallocZero(db, sizeof(Table));
979 if( pTab==0 ){
drh86541862019-12-19 20:37:32 +0000980 return sqlite3ErrorToParser(db, SQLITE_NOMEM);
dan62742fd2019-07-08 12:01:39 +0000981 }
drh89636622020-06-07 17:33:18 +0000982 sqlite3AggInfoPersistWalkerInit(&w, pParse);
983 sqlite3WalkSelect(&w, p);
drh4752bbd2021-05-07 15:46:36 +0000984 if( (p->selFlags & SF_Aggregate)==0 ){
985 w.xExprCallback = disallowAggregatesInOrderByCb;
dan3d691fd2021-05-19 14:49:51 +0000986 w.xSelectCallback = 0;
drh4752bbd2021-05-07 15:46:36 +0000987 sqlite3WalkExprList(&w, p->pOrderBy);
988 }
dandfa552f2018-06-02 21:04:28 +0000989
990 p->pSrc = 0;
991 p->pWhere = 0;
992 p->pGroupBy = 0;
993 p->pHaving = 0;
dan62742fd2019-07-08 12:01:39 +0000994 p->selFlags &= ~SF_Aggregate;
drhba016342019-11-14 13:24:04 +0000995 p->selFlags |= SF_WinRewrite;
dandfa552f2018-06-02 21:04:28 +0000996
danf02cdd32018-06-27 19:48:50 +0000997 /* Create the ORDER BY clause for the sub-select. This is the concatenation
998 ** of the window PARTITION and ORDER BY clauses. Then, if this makes it
999 ** redundant, remove the ORDER BY from the parent SELECT. */
dand8d2fb92019-12-27 15:31:47 +00001000 pSort = exprListAppendList(pParse, 0, pMWin->pPartition, 1);
dan08f6de72019-05-10 14:26:32 +00001001 pSort = exprListAppendList(pParse, pSort, pMWin->pOrderBy, 1);
dan0e3c50c2019-08-07 17:45:37 +00001002 if( pSort && p->pOrderBy && p->pOrderBy->nExpr<=pSort->nExpr ){
1003 int nSave = pSort->nExpr;
1004 pSort->nExpr = p->pOrderBy->nExpr;
danf02cdd32018-06-27 19:48:50 +00001005 if( sqlite3ExprListCompare(pSort, p->pOrderBy, -1)==0 ){
1006 sqlite3ExprListDelete(db, p->pOrderBy);
1007 p->pOrderBy = 0;
1008 }
dan0e3c50c2019-08-07 17:45:37 +00001009 pSort->nExpr = nSave;
danf02cdd32018-06-27 19:48:50 +00001010 }
1011
dandfa552f2018-06-02 21:04:28 +00001012 /* Assign a cursor number for the ephemeral table used to buffer rows.
1013 ** The OpenEphemeral instruction is coded later, after it is known how
1014 ** many columns the table will have. */
1015 pMWin->iEphCsr = pParse->nTab++;
dan680f6e82019-03-04 21:07:11 +00001016 pParse->nTab += 3;
dandfa552f2018-06-02 21:04:28 +00001017
dan62742fd2019-07-08 12:01:39 +00001018 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pEList, pTab, &pSublist);
1019 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pOrderBy, pTab, &pSublist);
dandfa552f2018-06-02 21:04:28 +00001020 pMWin->nBufferCol = (pSublist ? pSublist->nExpr : 0);
1021
danf02cdd32018-06-27 19:48:50 +00001022 /* Append the PARTITION BY and ORDER BY expressions to the to the
1023 ** sub-select expression list. They are required to figure out where
1024 ** boundaries for partitions and sets of peer rows lie. */
dan08f6de72019-05-10 14:26:32 +00001025 pSublist = exprListAppendList(pParse, pSublist, pMWin->pPartition, 0);
1026 pSublist = exprListAppendList(pParse, pSublist, pMWin->pOrderBy, 0);
dandfa552f2018-06-02 21:04:28 +00001027
1028 /* Append the arguments passed to each window function to the
1029 ** sub-select expression list. Also allocate two registers for each
1030 ** window function - one for the accumulator, another for interim
1031 ** results. */
1032 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drha4eeccd2021-10-07 17:43:30 +00001033 ExprList *pArgs;
1034 assert( ExprUseXList(pWin->pOwner) );
1035 pArgs = pWin->pOwner->x.pList;
drh105dcaa2022-03-10 16:01:14 +00001036 if( pWin->pWFunc->funcFlags & SQLITE_FUNC_SUBTYPE ){
dane2ba6df2019-09-07 18:20:43 +00001037 selectWindowRewriteEList(pParse, pMWin, pSrc, pArgs, pTab, &pSublist);
1038 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0);
1039 pWin->bExprArgs = 1;
1040 }else{
1041 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0);
1042 pSublist = exprListAppendList(pParse, pSublist, pArgs, 0);
1043 }
dan8b985602018-06-09 17:43:45 +00001044 if( pWin->pFilter ){
1045 Expr *pFilter = sqlite3ExprDup(db, pWin->pFilter, 0);
1046 pSublist = sqlite3ExprListAppend(pParse, pSublist, pFilter);
1047 }
dandfa552f2018-06-02 21:04:28 +00001048 pWin->regAccum = ++pParse->nMem;
1049 pWin->regResult = ++pParse->nMem;
1050 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
1051 }
1052
dan9c277582018-06-20 09:23:49 +00001053 /* If there is no ORDER BY or PARTITION BY clause, and the window
1054 ** function accepts zero arguments, and there are no other columns
1055 ** selected (e.g. "SELECT row_number() OVER () FROM t1"), it is possible
1056 ** that pSublist is still NULL here. Add a constant expression here to
1057 ** keep everything legal in this case.
1058 */
1059 if( pSublist==0 ){
1060 pSublist = sqlite3ExprListAppend(pParse, 0,
drh5776ee52019-09-23 12:38:10 +00001061 sqlite3Expr(db, TK_INTEGER, "0")
dan9c277582018-06-20 09:23:49 +00001062 );
1063 }
1064
dandfa552f2018-06-02 21:04:28 +00001065 pSub = sqlite3SelectNew(
1066 pParse, pSublist, pSrc, pWhere, pGroupBy, pHaving, pSort, 0, 0
1067 );
drh9216de82020-06-11 00:57:09 +00001068 SELECTTRACE(1,pParse,pSub,
1069 ("New window-function subquery in FROM clause of (%u/%p)\n",
1070 p->selId, p));
drh29c992c2019-01-17 15:40:41 +00001071 p->pSrc = sqlite3SrcListAppend(pParse, 0, 0, 0);
drh82456a62021-09-13 18:16:15 +00001072 assert( pSub!=0 || p->pSrc==0 ); /* Due to db->mallocFailed test inside
1073 ** of sqlite3DbMallocRawNN() called from
1074 ** sqlite3SrcListAppend() */
dandfa552f2018-06-02 21:04:28 +00001075 if( p->pSrc ){
dan62742fd2019-07-08 12:01:39 +00001076 Table *pTab2;
dandfa552f2018-06-02 21:04:28 +00001077 p->pSrc->a[0].pSelect = pSub;
1078 sqlite3SrcListAssignCursors(pParse, p->pSrc);
drhbb301232021-07-15 19:29:43 +00001079 pSub->selFlags |= SF_Expanded|SF_OrderByReqd;
drh96fb16e2019-08-06 14:37:24 +00001080 pTab2 = sqlite3ResultSetOfSelect(pParse, pSub, SQLITE_AFF_NONE);
dan553948e2020-03-16 18:52:53 +00001081 pSub->selFlags |= (selFlags & SF_Aggregate);
dan62742fd2019-07-08 12:01:39 +00001082 if( pTab2==0 ){
drha9ebfe22019-12-25 23:54:21 +00001083 /* Might actually be some other kind of error, but in that case
1084 ** pParse->nErr will be set, so if SQLITE_NOMEM is set, we will get
1085 ** the correct error message regardless. */
dandfa552f2018-06-02 21:04:28 +00001086 rc = SQLITE_NOMEM;
1087 }else{
dan62742fd2019-07-08 12:01:39 +00001088 memcpy(pTab, pTab2, sizeof(Table));
1089 pTab->tabFlags |= TF_Ephemeral;
1090 p->pSrc->a[0].pTab = pTab;
1091 pTab = pTab2;
drhc37577b2020-05-24 03:38:37 +00001092 memset(&w, 0, sizeof(w));
1093 w.xExprCallback = sqlite3WindowExtraAggFuncDepth;
1094 w.xSelectCallback = sqlite3WalkerDepthIncrease;
1095 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
1096 sqlite3WalkSelect(&w, pSub);
dandfa552f2018-06-02 21:04:28 +00001097 }
dan6fde1792018-06-15 19:01:35 +00001098 }else{
1099 sqlite3SelectDelete(db, pSub);
1100 }
1101 if( db->mallocFailed ) rc = SQLITE_NOMEM;
drh6d64b4a2021-11-07 23:33:01 +00001102
1103 /* Defer deleting the temporary table pTab because if an error occurred,
1104 ** there could still be references to that table embedded in the
1105 ** result-set or ORDER BY clause of the SELECT statement p. */
1106 sqlite3ParserAddCleanup(pParse, sqlite3DbFree, pTab);
dandfa552f2018-06-02 21:04:28 +00001107 }
1108
drh1da88b52022-01-24 19:38:56 +00001109 assert( rc==SQLITE_OK || pParse->nErr!=0 );
dandfa552f2018-06-02 21:04:28 +00001110 return rc;
1111}
1112
danc0bb4452018-06-12 20:53:38 +00001113/*
drhe2094572019-07-22 19:01:38 +00001114** Unlink the Window object from the Select to which it is attached,
1115** if it is attached.
1116*/
1117void sqlite3WindowUnlinkFromSelect(Window *p){
1118 if( p->ppThis ){
1119 *p->ppThis = p->pNextWin;
1120 if( p->pNextWin ) p->pNextWin->ppThis = p->ppThis;
1121 p->ppThis = 0;
1122 }
1123}
1124
1125/*
danc0bb4452018-06-12 20:53:38 +00001126** Free the Window object passed as the second argument.
1127*/
dan86fb6e12018-05-16 20:58:07 +00001128void sqlite3WindowDelete(sqlite3 *db, Window *p){
1129 if( p ){
drhe2094572019-07-22 19:01:38 +00001130 sqlite3WindowUnlinkFromSelect(p);
dan86fb6e12018-05-16 20:58:07 +00001131 sqlite3ExprDelete(db, p->pFilter);
1132 sqlite3ExprListDelete(db, p->pPartition);
1133 sqlite3ExprListDelete(db, p->pOrderBy);
1134 sqlite3ExprDelete(db, p->pEnd);
1135 sqlite3ExprDelete(db, p->pStart);
dane3bf6322018-06-08 20:58:27 +00001136 sqlite3DbFree(db, p->zName);
dane7c9ca42019-02-16 17:27:51 +00001137 sqlite3DbFree(db, p->zBase);
dan86fb6e12018-05-16 20:58:07 +00001138 sqlite3DbFree(db, p);
1139 }
1140}
1141
danc0bb4452018-06-12 20:53:38 +00001142/*
1143** Free the linked list of Window objects starting at the second argument.
1144*/
dane3bf6322018-06-08 20:58:27 +00001145void sqlite3WindowListDelete(sqlite3 *db, Window *p){
1146 while( p ){
1147 Window *pNext = p->pNextWin;
1148 sqlite3WindowDelete(db, p);
1149 p = pNext;
1150 }
1151}
1152
danc0bb4452018-06-12 20:53:38 +00001153/*
drhe4984a22018-07-06 17:19:20 +00001154** The argument expression is an PRECEDING or FOLLOWING offset. The
1155** value should be a non-negative integer. If the value is not a
1156** constant, change it to NULL. The fact that it is then a non-negative
1157** integer will be caught later. But it is important not to leave
1158** variable values in the expression tree.
1159*/
1160static Expr *sqlite3WindowOffsetExpr(Parse *pParse, Expr *pExpr){
1161 if( 0==sqlite3ExprIsConstant(pExpr) ){
danfb8ac322019-01-16 12:05:22 +00001162 if( IN_RENAME_OBJECT ) sqlite3RenameExprUnmap(pParse, pExpr);
drhe4984a22018-07-06 17:19:20 +00001163 sqlite3ExprDelete(pParse->db, pExpr);
1164 pExpr = sqlite3ExprAlloc(pParse->db, TK_NULL, 0, 0);
1165 }
1166 return pExpr;
1167}
1168
1169/*
1170** Allocate and return a new Window object describing a Window Definition.
danc0bb4452018-06-12 20:53:38 +00001171*/
dan86fb6e12018-05-16 20:58:07 +00001172Window *sqlite3WindowAlloc(
drhe4984a22018-07-06 17:19:20 +00001173 Parse *pParse, /* Parsing context */
drhfc15f4c2019-03-28 13:03:41 +00001174 int eType, /* Frame type. TK_RANGE, TK_ROWS, TK_GROUPS, or 0 */
drhe4984a22018-07-06 17:19:20 +00001175 int eStart, /* Start type: CURRENT, PRECEDING, FOLLOWING, UNBOUNDED */
1176 Expr *pStart, /* Start window size if TK_PRECEDING or FOLLOWING */
1177 int eEnd, /* End type: CURRENT, FOLLOWING, TK_UNBOUNDED, PRECEDING */
dand35300f2019-03-14 20:53:21 +00001178 Expr *pEnd, /* End window size if TK_FOLLOWING or PRECEDING */
1179 u8 eExclude /* EXCLUDE clause */
dan86fb6e12018-05-16 20:58:07 +00001180){
dan7a606e12018-07-05 18:34:53 +00001181 Window *pWin = 0;
dane7c9ca42019-02-16 17:27:51 +00001182 int bImplicitFrame = 0;
dan7a606e12018-07-05 18:34:53 +00001183
drhe4984a22018-07-06 17:19:20 +00001184 /* Parser assures the following: */
dan6c75b392019-03-08 20:02:52 +00001185 assert( eType==0 || eType==TK_RANGE || eType==TK_ROWS || eType==TK_GROUPS );
drhe4984a22018-07-06 17:19:20 +00001186 assert( eStart==TK_CURRENT || eStart==TK_PRECEDING
1187 || eStart==TK_UNBOUNDED || eStart==TK_FOLLOWING );
1188 assert( eEnd==TK_CURRENT || eEnd==TK_FOLLOWING
1189 || eEnd==TK_UNBOUNDED || eEnd==TK_PRECEDING );
1190 assert( (eStart==TK_PRECEDING || eStart==TK_FOLLOWING)==(pStart!=0) );
1191 assert( (eEnd==TK_FOLLOWING || eEnd==TK_PRECEDING)==(pEnd!=0) );
1192
dane7c9ca42019-02-16 17:27:51 +00001193 if( eType==0 ){
1194 bImplicitFrame = 1;
1195 eType = TK_RANGE;
1196 }
drhe4984a22018-07-06 17:19:20 +00001197
drhe4984a22018-07-06 17:19:20 +00001198 /* Additionally, the
dan5d764ac2018-07-06 14:15:49 +00001199 ** starting boundary type may not occur earlier in the following list than
1200 ** the ending boundary type:
1201 **
1202 ** UNBOUNDED PRECEDING
1203 ** <expr> PRECEDING
1204 ** CURRENT ROW
1205 ** <expr> FOLLOWING
1206 ** UNBOUNDED FOLLOWING
1207 **
1208 ** The parser ensures that "UNBOUNDED PRECEDING" cannot be used as an ending
1209 ** boundary, and than "UNBOUNDED FOLLOWING" cannot be used as a starting
1210 ** frame boundary.
1211 */
drhe4984a22018-07-06 17:19:20 +00001212 if( (eStart==TK_CURRENT && eEnd==TK_PRECEDING)
dan5d764ac2018-07-06 14:15:49 +00001213 || (eStart==TK_FOLLOWING && (eEnd==TK_PRECEDING || eEnd==TK_CURRENT))
1214 ){
dan72b9fdc2019-03-09 20:49:17 +00001215 sqlite3ErrorMsg(pParse, "unsupported frame specification");
drhe4984a22018-07-06 17:19:20 +00001216 goto windowAllocErr;
dan7a606e12018-07-05 18:34:53 +00001217 }
dan86fb6e12018-05-16 20:58:07 +00001218
drhe4984a22018-07-06 17:19:20 +00001219 pWin = (Window*)sqlite3DbMallocZero(pParse->db, sizeof(Window));
1220 if( pWin==0 ) goto windowAllocErr;
drhfc15f4c2019-03-28 13:03:41 +00001221 pWin->eFrmType = eType;
drhe4984a22018-07-06 17:19:20 +00001222 pWin->eStart = eStart;
1223 pWin->eEnd = eEnd;
drh94809082019-04-02 17:45:56 +00001224 if( eExclude==0 && OptimizationDisabled(pParse->db, SQLITE_WindowFunc) ){
dan108e6b22019-03-18 18:55:35 +00001225 eExclude = TK_NO;
1226 }
dand35300f2019-03-14 20:53:21 +00001227 pWin->eExclude = eExclude;
dane7c9ca42019-02-16 17:27:51 +00001228 pWin->bImplicitFrame = bImplicitFrame;
drhe4984a22018-07-06 17:19:20 +00001229 pWin->pEnd = sqlite3WindowOffsetExpr(pParse, pEnd);
1230 pWin->pStart = sqlite3WindowOffsetExpr(pParse, pStart);
dan86fb6e12018-05-16 20:58:07 +00001231 return pWin;
drhe4984a22018-07-06 17:19:20 +00001232
1233windowAllocErr:
1234 sqlite3ExprDelete(pParse->db, pEnd);
1235 sqlite3ExprDelete(pParse->db, pStart);
1236 return 0;
dan86fb6e12018-05-16 20:58:07 +00001237}
1238
danc0bb4452018-06-12 20:53:38 +00001239/*
dane7c9ca42019-02-16 17:27:51 +00001240** Attach PARTITION and ORDER BY clauses pPartition and pOrderBy to window
1241** pWin. Also, if parameter pBase is not NULL, set pWin->zBase to the
1242** equivalent nul-terminated string.
1243*/
1244Window *sqlite3WindowAssemble(
1245 Parse *pParse,
1246 Window *pWin,
1247 ExprList *pPartition,
1248 ExprList *pOrderBy,
1249 Token *pBase
1250){
1251 if( pWin ){
1252 pWin->pPartition = pPartition;
1253 pWin->pOrderBy = pOrderBy;
1254 if( pBase ){
1255 pWin->zBase = sqlite3DbStrNDup(pParse->db, pBase->z, pBase->n);
1256 }
1257 }else{
1258 sqlite3ExprListDelete(pParse->db, pPartition);
1259 sqlite3ExprListDelete(pParse->db, pOrderBy);
1260 }
1261 return pWin;
1262}
1263
1264/*
1265** Window *pWin has just been created from a WINDOW clause. Tokne pBase
1266** is the base window. Earlier windows from the same WINDOW clause are
1267** stored in the linked list starting at pWin->pNextWin. This function
1268** either updates *pWin according to the base specification, or else
1269** leaves an error in pParse.
1270*/
1271void sqlite3WindowChain(Parse *pParse, Window *pWin, Window *pList){
1272 if( pWin->zBase ){
1273 sqlite3 *db = pParse->db;
1274 Window *pExist = windowFind(pParse, pList, pWin->zBase);
1275 if( pExist ){
1276 const char *zErr = 0;
1277 /* Check for errors */
1278 if( pWin->pPartition ){
1279 zErr = "PARTITION clause";
1280 }else if( pExist->pOrderBy && pWin->pOrderBy ){
1281 zErr = "ORDER BY clause";
1282 }else if( pExist->bImplicitFrame==0 ){
1283 zErr = "frame specification";
1284 }
1285 if( zErr ){
1286 sqlite3ErrorMsg(pParse,
1287 "cannot override %s of window: %s", zErr, pWin->zBase
1288 );
1289 }else{
1290 pWin->pPartition = sqlite3ExprListDup(db, pExist->pPartition, 0);
1291 if( pExist->pOrderBy ){
1292 assert( pWin->pOrderBy==0 );
1293 pWin->pOrderBy = sqlite3ExprListDup(db, pExist->pOrderBy, 0);
1294 }
1295 sqlite3DbFree(db, pWin->zBase);
1296 pWin->zBase = 0;
1297 }
1298 }
1299 }
1300}
1301
1302/*
danc0bb4452018-06-12 20:53:38 +00001303** Attach window object pWin to expression p.
1304*/
dan4f9adee2019-07-13 16:22:50 +00001305void sqlite3WindowAttach(Parse *pParse, Expr *p, Window *pWin){
dan86fb6e12018-05-16 20:58:07 +00001306 if( p ){
drheda079c2018-09-20 19:02:15 +00001307 assert( p->op==TK_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00001308 assert( pWin );
1309 p->y.pWin = pWin;
1310 ExprSetProperty(p, EP_WinFunc);
1311 pWin->pOwner = p;
1312 if( (p->flags & EP_Distinct) && pWin->eFrmType!=TK_FILTER ){
1313 sqlite3ErrorMsg(pParse,
1314 "DISTINCT is not supported for window functions"
1315 );
dane33f6e72018-07-06 07:42:42 +00001316 }
dan86fb6e12018-05-16 20:58:07 +00001317 }else{
1318 sqlite3WindowDelete(pParse->db, pWin);
1319 }
1320}
dane2f781b2018-05-17 19:24:08 +00001321
1322/*
dana3fcc002019-08-15 13:53:22 +00001323** Possibly link window pWin into the list at pSel->pWin (window functions
1324** to be processed as part of SELECT statement pSel). The window is linked
1325** in if either (a) there are no other windows already linked to this
1326** SELECT, or (b) the windows already linked use a compatible window frame.
1327*/
1328void sqlite3WindowLink(Select *pSel, Window *pWin){
dan903fdd42021-02-22 20:56:13 +00001329 if( pSel ){
1330 if( 0==pSel->pWin || 0==sqlite3WindowCompare(0, pSel->pWin, pWin, 0) ){
1331 pWin->pNextWin = pSel->pWin;
1332 if( pSel->pWin ){
1333 pSel->pWin->ppThis = &pWin->pNextWin;
1334 }
1335 pSel->pWin = pWin;
1336 pWin->ppThis = &pSel->pWin;
1337 }else{
1338 if( sqlite3ExprListCompare(pWin->pPartition, pSel->pWin->pPartition,-1) ){
1339 pSel->selFlags |= SF_MultiPart;
1340 }
dana3fcc002019-08-15 13:53:22 +00001341 }
dana3fcc002019-08-15 13:53:22 +00001342 }
1343}
1344
1345/*
danfbb6e9f2020-01-09 20:11:29 +00001346** Return 0 if the two window objects are identical, 1 if they are
1347** different, or 2 if it cannot be determined if the objects are identical
1348** or not. Identical window objects can be processed in a single scan.
dane2f781b2018-05-17 19:24:08 +00001349*/
drh1580d502021-09-25 17:07:57 +00001350int sqlite3WindowCompare(
1351 const Parse *pParse,
1352 const Window *p1,
1353 const Window *p2,
1354 int bFilter
1355){
danfbb6e9f2020-01-09 20:11:29 +00001356 int res;
drha2f142d2019-11-23 16:34:40 +00001357 if( NEVER(p1==0) || NEVER(p2==0) ) return 1;
drhfc15f4c2019-03-28 13:03:41 +00001358 if( p1->eFrmType!=p2->eFrmType ) return 1;
dane2f781b2018-05-17 19:24:08 +00001359 if( p1->eStart!=p2->eStart ) return 1;
1360 if( p1->eEnd!=p2->eEnd ) return 1;
dana0f6b832019-03-14 16:36:20 +00001361 if( p1->eExclude!=p2->eExclude ) return 1;
dane2f781b2018-05-17 19:24:08 +00001362 if( sqlite3ExprCompare(pParse, p1->pStart, p2->pStart, -1) ) return 1;
1363 if( sqlite3ExprCompare(pParse, p1->pEnd, p2->pEnd, -1) ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00001364 if( (res = sqlite3ExprListCompare(p1->pPartition, p2->pPartition, -1)) ){
1365 return res;
1366 }
1367 if( (res = sqlite3ExprListCompare(p1->pOrderBy, p2->pOrderBy, -1)) ){
1368 return res;
1369 }
dan4f9adee2019-07-13 16:22:50 +00001370 if( bFilter ){
danfbb6e9f2020-01-09 20:11:29 +00001371 if( (res = sqlite3ExprCompare(pParse, p1->pFilter, p2->pFilter, -1)) ){
1372 return res;
1373 }
dan4f9adee2019-07-13 16:22:50 +00001374 }
dane2f781b2018-05-17 19:24:08 +00001375 return 0;
1376}
1377
dan13078ca2018-06-13 20:29:38 +00001378
1379/*
1380** This is called by code in select.c before it calls sqlite3WhereBegin()
1381** to begin iterating through the sub-query results. It is used to allocate
1382** and initialize registers and cursors used by sqlite3WindowCodeStep().
1383*/
dan4ea562e2020-01-01 20:17:15 +00001384void sqlite3WindowCodeInit(Parse *pParse, Select *pSelect){
1385 int nEphExpr = pSelect->pSrc->a[0].pSelect->pEList->nExpr;
1386 Window *pMWin = pSelect->pWin;
danc9a86682018-05-30 20:44:58 +00001387 Window *pWin;
dan13078ca2018-06-13 20:29:38 +00001388 Vdbe *v = sqlite3GetVdbe(pParse);
danb6f2dea2019-03-13 17:20:27 +00001389
dan4ea562e2020-01-01 20:17:15 +00001390 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pMWin->iEphCsr, nEphExpr);
1391 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+1, pMWin->iEphCsr);
1392 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+2, pMWin->iEphCsr);
1393 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+3, pMWin->iEphCsr);
1394
danb6f2dea2019-03-13 17:20:27 +00001395 /* Allocate registers to use for PARTITION BY values, if any. Initialize
1396 ** said registers to NULL. */
1397 if( pMWin->pPartition ){
1398 int nExpr = pMWin->pPartition->nExpr;
dan13078ca2018-06-13 20:29:38 +00001399 pMWin->regPart = pParse->nMem+1;
danb6f2dea2019-03-13 17:20:27 +00001400 pParse->nMem += nExpr;
1401 sqlite3VdbeAddOp3(v, OP_Null, 0, pMWin->regPart, pMWin->regPart+nExpr-1);
dan13078ca2018-06-13 20:29:38 +00001402 }
1403
danbf845152019-03-16 10:15:24 +00001404 pMWin->regOne = ++pParse->nMem;
1405 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regOne);
dan680f6e82019-03-04 21:07:11 +00001406
dana0f6b832019-03-14 16:36:20 +00001407 if( pMWin->eExclude ){
1408 pMWin->regStartRowid = ++pParse->nMem;
1409 pMWin->regEndRowid = ++pParse->nMem;
1410 pMWin->csrApp = pParse->nTab++;
1411 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid);
1412 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid);
1413 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->csrApp, pMWin->iEphCsr);
1414 return;
1415 }
1416
danc9a86682018-05-30 20:44:58 +00001417 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001418 FuncDef *p = pWin->pWFunc;
danec891fd2018-06-06 20:51:02 +00001419 if( (p->funcFlags & SQLITE_FUNC_MINMAX) && pWin->eStart!=TK_UNBOUNDED ){
dan9a947222018-06-14 19:06:36 +00001420 /* The inline versions of min() and max() require a single ephemeral
1421 ** table and 3 registers. The registers are used as follows:
1422 **
1423 ** regApp+0: slot to copy min()/max() argument to for MakeRecord
1424 ** regApp+1: integer value used to ensure keys are unique
1425 ** regApp+2: output of MakeRecord
1426 */
drha4eeccd2021-10-07 17:43:30 +00001427 ExprList *pList;
1428 KeyInfo *pKeyInfo;
1429 assert( ExprUseXList(pWin->pOwner) );
1430 pList = pWin->pOwner->x.pList;
1431 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pList, 0, 0);
danc9a86682018-05-30 20:44:58 +00001432 pWin->csrApp = pParse->nTab++;
1433 pWin->regApp = pParse->nMem+1;
1434 pParse->nMem += 3;
drh105dcaa2022-03-10 16:01:14 +00001435 if( pKeyInfo && pWin->pWFunc->zName[1]=='i' ){
dan6e118922019-08-12 16:36:38 +00001436 assert( pKeyInfo->aSortFlags[0]==0 );
1437 pKeyInfo->aSortFlags[0] = KEYINFO_ORDER_DESC;
danc9a86682018-05-30 20:44:58 +00001438 }
1439 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pWin->csrApp, 2);
1440 sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
1441 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
1442 }
drh19dc4d42018-07-08 01:02:26 +00001443 else if( p->zName==nth_valueName || p->zName==first_valueName ){
danec891fd2018-06-06 20:51:02 +00001444 /* Allocate two registers at pWin->regApp. These will be used to
1445 ** store the start and end index of the current frame. */
danec891fd2018-06-06 20:51:02 +00001446 pWin->regApp = pParse->nMem+1;
1447 pWin->csrApp = pParse->nTab++;
1448 pParse->nMem += 2;
danec891fd2018-06-06 20:51:02 +00001449 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr);
1450 }
drh19dc4d42018-07-08 01:02:26 +00001451 else if( p->zName==leadName || p->zName==lagName ){
danfe4e25a2018-06-07 20:08:59 +00001452 pWin->csrApp = pParse->nTab++;
1453 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr);
1454 }
danc9a86682018-05-30 20:44:58 +00001455 }
1456}
1457
danbb407272019-03-12 18:28:51 +00001458#define WINDOW_STARTING_INT 0
1459#define WINDOW_ENDING_INT 1
1460#define WINDOW_NTH_VALUE_INT 2
1461#define WINDOW_STARTING_NUM 3
1462#define WINDOW_ENDING_NUM 4
1463
dan13078ca2018-06-13 20:29:38 +00001464/*
dana1a7e112018-07-09 13:31:18 +00001465** A "PRECEDING <expr>" (eCond==0) or "FOLLOWING <expr>" (eCond==1) or the
1466** value of the second argument to nth_value() (eCond==2) has just been
1467** evaluated and the result left in register reg. This function generates VM
1468** code to check that the value is a non-negative integer and throws an
1469** exception if it is not.
dan13078ca2018-06-13 20:29:38 +00001470*/
danbb407272019-03-12 18:28:51 +00001471static void windowCheckValue(Parse *pParse, int reg, int eCond){
danc3a20c12018-05-23 20:55:37 +00001472 static const char *azErr[] = {
1473 "frame starting offset must be a non-negative integer",
dana1a7e112018-07-09 13:31:18 +00001474 "frame ending offset must be a non-negative integer",
danbb407272019-03-12 18:28:51 +00001475 "second argument to nth_value must be a positive integer",
1476 "frame starting offset must be a non-negative number",
1477 "frame ending offset must be a non-negative number",
danc3a20c12018-05-23 20:55:37 +00001478 };
danbb407272019-03-12 18:28:51 +00001479 static int aOp[] = { OP_Ge, OP_Ge, OP_Gt, OP_Ge, OP_Ge };
danc3a20c12018-05-23 20:55:37 +00001480 Vdbe *v = sqlite3GetVdbe(pParse);
dan13078ca2018-06-13 20:29:38 +00001481 int regZero = sqlite3GetTempReg(pParse);
danbb407272019-03-12 18:28:51 +00001482 assert( eCond>=0 && eCond<ArraySize(azErr) );
danc3a20c12018-05-23 20:55:37 +00001483 sqlite3VdbeAddOp2(v, OP_Integer, 0, regZero);
dane5166e02019-03-19 11:56:39 +00001484 if( eCond>=WINDOW_STARTING_NUM ){
1485 int regString = sqlite3GetTempReg(pParse);
1486 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC);
1487 sqlite3VdbeAddOp3(v, OP_Ge, regString, sqlite3VdbeCurrentAddr(v)+2, reg);
drh21826f42019-04-01 14:30:30 +00001488 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC|SQLITE_JUMPIFNULL);
drh6f883592019-03-30 20:37:04 +00001489 VdbeCoverage(v);
1490 assert( eCond==3 || eCond==4 );
1491 VdbeCoverageIf(v, eCond==3);
1492 VdbeCoverageIf(v, eCond==4);
dane5166e02019-03-19 11:56:39 +00001493 }else{
1494 sqlite3VdbeAddOp2(v, OP_MustBeInt, reg, sqlite3VdbeCurrentAddr(v)+2);
drh6f883592019-03-30 20:37:04 +00001495 VdbeCoverage(v);
1496 assert( eCond==0 || eCond==1 || eCond==2 );
1497 VdbeCoverageIf(v, eCond==0);
1498 VdbeCoverageIf(v, eCond==1);
1499 VdbeCoverageIf(v, eCond==2);
dane5166e02019-03-19 11:56:39 +00001500 }
dana1a7e112018-07-09 13:31:18 +00001501 sqlite3VdbeAddOp3(v, aOp[eCond], regZero, sqlite3VdbeCurrentAddr(v)+2, reg);
danb03786a2021-03-31 11:31:19 +00001502 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC);
drh21826f42019-04-01 14:30:30 +00001503 VdbeCoverageNeverNullIf(v, eCond==0); /* NULL case captured by */
1504 VdbeCoverageNeverNullIf(v, eCond==1); /* the OP_MustBeInt */
1505 VdbeCoverageNeverNullIf(v, eCond==2);
1506 VdbeCoverageNeverNullIf(v, eCond==3); /* NULL case caught by */
1507 VdbeCoverageNeverNullIf(v, eCond==4); /* the OP_Ge */
drh211a0852019-01-27 02:41:34 +00001508 sqlite3MayAbort(pParse);
danc3a20c12018-05-23 20:55:37 +00001509 sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_ERROR, OE_Abort);
dana1a7e112018-07-09 13:31:18 +00001510 sqlite3VdbeAppendP4(v, (void*)azErr[eCond], P4_STATIC);
dan13078ca2018-06-13 20:29:38 +00001511 sqlite3ReleaseTempReg(pParse, regZero);
danc3a20c12018-05-23 20:55:37 +00001512}
1513
dan13078ca2018-06-13 20:29:38 +00001514/*
1515** Return the number of arguments passed to the window-function associated
1516** with the object passed as the only argument to this function.
1517*/
dan2a11bb22018-06-11 20:50:25 +00001518static int windowArgCount(Window *pWin){
drha4eeccd2021-10-07 17:43:30 +00001519 const ExprList *pList;
1520 assert( ExprUseXList(pWin->pOwner) );
1521 pList = pWin->pOwner->x.pList;
dan2a11bb22018-06-11 20:50:25 +00001522 return (pList ? pList->nExpr : 0);
1523}
1524
danc782a812019-03-15 20:46:19 +00001525typedef struct WindowCodeArg WindowCodeArg;
1526typedef struct WindowCsrAndReg WindowCsrAndReg;
dan1cac1762019-08-30 17:28:55 +00001527
1528/*
1529** See comments above struct WindowCodeArg.
1530*/
danc782a812019-03-15 20:46:19 +00001531struct WindowCsrAndReg {
dan1cac1762019-08-30 17:28:55 +00001532 int csr; /* Cursor number */
1533 int reg; /* First in array of peer values */
danc782a812019-03-15 20:46:19 +00001534};
1535
dan1cac1762019-08-30 17:28:55 +00001536/*
1537** A single instance of this structure is allocated on the stack by
1538** sqlite3WindowCodeStep() and a pointer to it passed to the various helper
1539** routines. This is to reduce the number of arguments required by each
1540** helper function.
1541**
1542** regArg:
1543** Each window function requires an accumulator register (just as an
1544** ordinary aggregate function does). This variable is set to the first
1545** in an array of accumulator registers - one for each window function
1546** in the WindowCodeArg.pMWin list.
1547**
1548** eDelete:
1549** The window functions implementation sometimes caches the input rows
1550** that it processes in a temporary table. If it is not zero, this
1551** variable indicates when rows may be removed from the temp table (in
1552** order to reduce memory requirements - it would always be safe just
1553** to leave them there). Possible values for eDelete are:
1554**
1555** WINDOW_RETURN_ROW:
1556** An input row can be discarded after it is returned to the caller.
1557**
1558** WINDOW_AGGINVERSE:
1559** An input row can be discarded after the window functions xInverse()
1560** callbacks have been invoked in it.
1561**
1562** WINDOW_AGGSTEP:
1563** An input row can be discarded after the window functions xStep()
1564** callbacks have been invoked in it.
1565**
1566** start,current,end
1567** Consider a window-frame similar to the following:
1568**
1569** (ORDER BY a, b GROUPS BETWEEN 2 PRECEDING AND 2 FOLLOWING)
1570**
1571** The windows functions implmentation caches the input rows in a temp
1572** table, sorted by "a, b" (it actually populates the cache lazily, and
1573** aggressively removes rows once they are no longer required, but that's
1574** a mere detail). It keeps three cursors open on the temp table. One
1575** (current) that points to the next row to return to the query engine
1576** once its window function values have been calculated. Another (end)
1577** points to the next row to call the xStep() method of each window function
1578** on (so that it is 2 groups ahead of current). And a third (start) that
1579** points to the next row to call the xInverse() method of each window
1580** function on.
1581**
1582** Each cursor (start, current and end) consists of a VDBE cursor
1583** (WindowCsrAndReg.csr) and an array of registers (starting at
1584** WindowCodeArg.reg) that always contains a copy of the peer values
1585** read from the corresponding cursor.
1586**
1587** Depending on the window-frame in question, all three cursors may not
1588** be required. In this case both WindowCodeArg.csr and reg are set to
1589** 0.
1590*/
danc782a812019-03-15 20:46:19 +00001591struct WindowCodeArg {
dan1cac1762019-08-30 17:28:55 +00001592 Parse *pParse; /* Parse context */
1593 Window *pMWin; /* First in list of functions being processed */
1594 Vdbe *pVdbe; /* VDBE object */
1595 int addrGosub; /* OP_Gosub to this address to return one row */
1596 int regGosub; /* Register used with OP_Gosub(addrGosub) */
1597 int regArg; /* First in array of accumulator registers */
1598 int eDelete; /* See above */
drh113a33c2021-04-24 23:40:05 +00001599 int regRowid;
danc782a812019-03-15 20:46:19 +00001600
1601 WindowCsrAndReg start;
1602 WindowCsrAndReg current;
1603 WindowCsrAndReg end;
1604};
1605
1606/*
danc782a812019-03-15 20:46:19 +00001607** Generate VM code to read the window frames peer values from cursor csr into
1608** an array of registers starting at reg.
1609*/
1610static void windowReadPeerValues(
1611 WindowCodeArg *p,
1612 int csr,
1613 int reg
1614){
1615 Window *pMWin = p->pMWin;
1616 ExprList *pOrderBy = pMWin->pOrderBy;
1617 if( pOrderBy ){
1618 Vdbe *v = sqlite3GetVdbe(p->pParse);
1619 ExprList *pPart = pMWin->pPartition;
1620 int iColOff = pMWin->nBufferCol + (pPart ? pPart->nExpr : 0);
1621 int i;
1622 for(i=0; i<pOrderBy->nExpr; i++){
1623 sqlite3VdbeAddOp3(v, OP_Column, csr, iColOff+i, reg+i);
1624 }
1625 }
1626}
1627
dan13078ca2018-06-13 20:29:38 +00001628/*
dan37d296a2019-09-24 20:20:05 +00001629** Generate VM code to invoke either xStep() (if bInverse is 0) or
1630** xInverse (if bInverse is non-zero) for each window function in the
1631** linked list starting at pMWin. Or, for built-in window functions
1632** that do not use the standard function API, generate the required
1633** inline VM code.
1634**
1635** If argument csr is greater than or equal to 0, then argument reg is
1636** the first register in an array of registers guaranteed to be large
1637** enough to hold the array of arguments for each function. In this case
1638** the arguments are extracted from the current row of csr into the
1639** array of registers before invoking OP_AggStep or OP_AggInverse
1640**
1641** Or, if csr is less than zero, then the array of registers at reg is
1642** already populated with all columns from the current row of the sub-query.
1643**
1644** If argument regPartSize is non-zero, then it is a register containing the
1645** number of rows in the current partition.
1646*/
1647static void windowAggStep(
1648 WindowCodeArg *p,
1649 Window *pMWin, /* Linked list of window functions */
1650 int csr, /* Read arguments from this cursor */
1651 int bInverse, /* True to invoke xInverse instead of xStep */
1652 int reg /* Array of registers */
1653){
1654 Parse *pParse = p->pParse;
1655 Vdbe *v = sqlite3GetVdbe(pParse);
1656 Window *pWin;
1657 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001658 FuncDef *pFunc = pWin->pWFunc;
dan37d296a2019-09-24 20:20:05 +00001659 int regArg;
1660 int nArg = pWin->bExprArgs ? 0 : windowArgCount(pWin);
1661 int i;
1662
1663 assert( bInverse==0 || pWin->eStart!=TK_UNBOUNDED );
1664
drhc5b35ae2019-09-25 02:07:50 +00001665 /* All OVER clauses in the same window function aggregate step must
1666 ** be the same. */
danfbb6e9f2020-01-09 20:11:29 +00001667 assert( pWin==pMWin || sqlite3WindowCompare(pParse,pWin,pMWin,0)!=1 );
drhc5b35ae2019-09-25 02:07:50 +00001668
dan37d296a2019-09-24 20:20:05 +00001669 for(i=0; i<nArg; i++){
1670 if( i!=1 || pFunc->zName!=nth_valueName ){
1671 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+i, reg+i);
1672 }else{
1673 sqlite3VdbeAddOp3(v, OP_Column, pMWin->iEphCsr, pWin->iArgCol+i, reg+i);
1674 }
1675 }
1676 regArg = reg;
1677
1678 if( pMWin->regStartRowid==0
1679 && (pFunc->funcFlags & SQLITE_FUNC_MINMAX)
1680 && (pWin->eStart!=TK_UNBOUNDED)
1681 ){
1682 int addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regArg);
1683 VdbeCoverage(v);
1684 if( bInverse==0 ){
1685 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1, 1);
1686 sqlite3VdbeAddOp2(v, OP_SCopy, regArg, pWin->regApp);
1687 sqlite3VdbeAddOp3(v, OP_MakeRecord, pWin->regApp, 2, pWin->regApp+2);
1688 sqlite3VdbeAddOp2(v, OP_IdxInsert, pWin->csrApp, pWin->regApp+2);
1689 }else{
1690 sqlite3VdbeAddOp4Int(v, OP_SeekGE, pWin->csrApp, 0, regArg, 1);
1691 VdbeCoverageNeverTaken(v);
1692 sqlite3VdbeAddOp1(v, OP_Delete, pWin->csrApp);
1693 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
1694 }
1695 sqlite3VdbeJumpHere(v, addrIsNull);
1696 }else if( pWin->regApp ){
1697 assert( pFunc->zName==nth_valueName
1698 || pFunc->zName==first_valueName
1699 );
1700 assert( bInverse==0 || bInverse==1 );
1701 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1-bInverse, 1);
1702 }else if( pFunc->xSFunc!=noopStepFunc ){
1703 int addrIf = 0;
dan37d296a2019-09-24 20:20:05 +00001704 if( pWin->pFilter ){
1705 int regTmp;
drha4eeccd2021-10-07 17:43:30 +00001706 assert( ExprUseXList(pWin->pOwner) );
dan37d296a2019-09-24 20:20:05 +00001707 assert( pWin->bExprArgs || !nArg ||nArg==pWin->pOwner->x.pList->nExpr );
1708 assert( pWin->bExprArgs || nArg ||pWin->pOwner->x.pList==0 );
1709 regTmp = sqlite3GetTempReg(pParse);
1710 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+nArg,regTmp);
1711 addrIf = sqlite3VdbeAddOp3(v, OP_IfNot, regTmp, 0, 1);
1712 VdbeCoverage(v);
1713 sqlite3ReleaseTempReg(pParse, regTmp);
1714 }
dan37d296a2019-09-24 20:20:05 +00001715
dan37d296a2019-09-24 20:20:05 +00001716 if( pWin->bExprArgs ){
dan5a9fd232021-04-06 18:40:27 +00001717 int iOp = sqlite3VdbeCurrentAddr(v);
1718 int iEnd;
dan37d296a2019-09-24 20:20:05 +00001719
drha4eeccd2021-10-07 17:43:30 +00001720 assert( ExprUseXList(pWin->pOwner) );
dan37d296a2019-09-24 20:20:05 +00001721 nArg = pWin->pOwner->x.pList->nExpr;
1722 regArg = sqlite3GetTempRange(pParse, nArg);
1723 sqlite3ExprCodeExprList(pParse, pWin->pOwner->x.pList, regArg, 0, 0);
1724
dan5a9fd232021-04-06 18:40:27 +00001725 for(iEnd=sqlite3VdbeCurrentAddr(v); iOp<iEnd; iOp++){
1726 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOp);
dan37d296a2019-09-24 20:20:05 +00001727 if( pOp->opcode==OP_Column && pOp->p1==pWin->iEphCsr ){
1728 pOp->p1 = csr;
1729 }
1730 }
1731 }
1732 if( pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
1733 CollSeq *pColl;
1734 assert( nArg>0 );
drha4eeccd2021-10-07 17:43:30 +00001735 assert( ExprUseXList(pWin->pOwner) );
dan37d296a2019-09-24 20:20:05 +00001736 pColl = sqlite3ExprNNCollSeq(pParse, pWin->pOwner->x.pList->a[0].pExpr);
1737 sqlite3VdbeAddOp4(v, OP_CollSeq, 0,0,0, (const char*)pColl, P4_COLLSEQ);
1738 }
1739 sqlite3VdbeAddOp3(v, bInverse? OP_AggInverse : OP_AggStep,
1740 bInverse, regArg, pWin->regAccum);
1741 sqlite3VdbeAppendP4(v, pFunc, P4_FUNCDEF);
1742 sqlite3VdbeChangeP5(v, (u8)nArg);
1743 if( pWin->bExprArgs ){
1744 sqlite3ReleaseTempRange(pParse, regArg, nArg);
1745 }
1746 if( addrIf ) sqlite3VdbeJumpHere(v, addrIf);
dan37d296a2019-09-24 20:20:05 +00001747 }
1748 }
1749}
1750
1751/*
1752** Values that may be passed as the second argument to windowCodeOp().
1753*/
1754#define WINDOW_RETURN_ROW 1
1755#define WINDOW_AGGINVERSE 2
1756#define WINDOW_AGGSTEP 3
1757
1758/*
dana0f6b832019-03-14 16:36:20 +00001759** Generate VM code to invoke either xValue() (bFin==0) or xFinalize()
1760** (bFin==1) for each window function in the linked list starting at
dan13078ca2018-06-13 20:29:38 +00001761** pMWin. Or, for built-in window-functions that do not use the standard
1762** API, generate the equivalent VM code.
1763*/
danc782a812019-03-15 20:46:19 +00001764static void windowAggFinal(WindowCodeArg *p, int bFin){
1765 Parse *pParse = p->pParse;
1766 Window *pMWin = p->pMWin;
dand6f784e2018-05-28 18:30:45 +00001767 Vdbe *v = sqlite3GetVdbe(pParse);
1768 Window *pWin;
1769
1770 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
dana0f6b832019-03-14 16:36:20 +00001771 if( pMWin->regStartRowid==0
drh105dcaa2022-03-10 16:01:14 +00001772 && (pWin->pWFunc->funcFlags & SQLITE_FUNC_MINMAX)
dana0f6b832019-03-14 16:36:20 +00001773 && (pWin->eStart!=TK_UNBOUNDED)
danec891fd2018-06-06 20:51:02 +00001774 ){
dand6f784e2018-05-28 18:30:45 +00001775 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
danc9a86682018-05-30 20:44:58 +00001776 sqlite3VdbeAddOp1(v, OP_Last, pWin->csrApp);
dan01e12292018-06-27 20:24:59 +00001777 VdbeCoverage(v);
danc9a86682018-05-30 20:44:58 +00001778 sqlite3VdbeAddOp3(v, OP_Column, pWin->csrApp, 0, pWin->regResult);
1779 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
danec891fd2018-06-06 20:51:02 +00001780 }else if( pWin->regApp ){
dana0f6b832019-03-14 16:36:20 +00001781 assert( pMWin->regStartRowid==0 );
dand6f784e2018-05-28 18:30:45 +00001782 }else{
dana0f6b832019-03-14 16:36:20 +00001783 int nArg = windowArgCount(pWin);
1784 if( bFin ){
1785 sqlite3VdbeAddOp2(v, OP_AggFinal, pWin->regAccum, nArg);
drh105dcaa2022-03-10 16:01:14 +00001786 sqlite3VdbeAppendP4(v, pWin->pWFunc, P4_FUNCDEF);
danc9a86682018-05-30 20:44:58 +00001787 sqlite3VdbeAddOp2(v, OP_Copy, pWin->regAccum, pWin->regResult);
dan8b985602018-06-09 17:43:45 +00001788 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
danc9a86682018-05-30 20:44:58 +00001789 }else{
dana0f6b832019-03-14 16:36:20 +00001790 sqlite3VdbeAddOp3(v, OP_AggValue,pWin->regAccum,nArg,pWin->regResult);
drh105dcaa2022-03-10 16:01:14 +00001791 sqlite3VdbeAppendP4(v, pWin->pWFunc, P4_FUNCDEF);
danc9a86682018-05-30 20:44:58 +00001792 }
dand6f784e2018-05-28 18:30:45 +00001793 }
1794 }
1795}
1796
dan0525b6f2019-03-18 21:19:40 +00001797/*
1798** Generate code to calculate the current values of all window functions in the
1799** p->pMWin list by doing a full scan of the current window frame. Store the
1800** results in the Window.regResult registers, ready to return the upper
1801** layer.
1802*/
danc782a812019-03-15 20:46:19 +00001803static void windowFullScan(WindowCodeArg *p){
1804 Window *pWin;
1805 Parse *pParse = p->pParse;
1806 Window *pMWin = p->pMWin;
1807 Vdbe *v = p->pVdbe;
1808
1809 int regCRowid = 0; /* Current rowid value */
1810 int regCPeer = 0; /* Current peer values */
1811 int regRowid = 0; /* AggStep rowid value */
1812 int regPeer = 0; /* AggStep peer values */
1813
1814 int nPeer;
1815 int lblNext;
1816 int lblBrk;
1817 int addrNext;
drh55f66b32019-07-16 19:44:32 +00001818 int csr;
danc782a812019-03-15 20:46:19 +00001819
dan37d296a2019-09-24 20:20:05 +00001820 VdbeModuleComment((v, "windowFullScan begin"));
1821
drh55f66b32019-07-16 19:44:32 +00001822 assert( pMWin!=0 );
1823 csr = pMWin->csrApp;
danc782a812019-03-15 20:46:19 +00001824 nPeer = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0);
1825
1826 lblNext = sqlite3VdbeMakeLabel(pParse);
1827 lblBrk = sqlite3VdbeMakeLabel(pParse);
1828
1829 regCRowid = sqlite3GetTempReg(pParse);
1830 regRowid = sqlite3GetTempReg(pParse);
1831 if( nPeer ){
1832 regCPeer = sqlite3GetTempRange(pParse, nPeer);
1833 regPeer = sqlite3GetTempRange(pParse, nPeer);
1834 }
1835
1836 sqlite3VdbeAddOp2(v, OP_Rowid, pMWin->iEphCsr, regCRowid);
1837 windowReadPeerValues(p, pMWin->iEphCsr, regCPeer);
1838
1839 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
1840 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
1841 }
1842
1843 sqlite3VdbeAddOp3(v, OP_SeekGE, csr, lblBrk, pMWin->regStartRowid);
dan1d4b25f2019-03-19 16:49:15 +00001844 VdbeCoverage(v);
danc782a812019-03-15 20:46:19 +00001845 addrNext = sqlite3VdbeCurrentAddr(v);
1846 sqlite3VdbeAddOp2(v, OP_Rowid, csr, regRowid);
1847 sqlite3VdbeAddOp3(v, OP_Gt, pMWin->regEndRowid, lblBrk, regRowid);
dan1d4b25f2019-03-19 16:49:15 +00001848 VdbeCoverageNeverNull(v);
dan108e6b22019-03-18 18:55:35 +00001849
danc782a812019-03-15 20:46:19 +00001850 if( pMWin->eExclude==TK_CURRENT ){
1851 sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, lblNext, regRowid);
drh83c5bb92019-04-01 15:55:38 +00001852 VdbeCoverageNeverNull(v);
danc782a812019-03-15 20:46:19 +00001853 }else if( pMWin->eExclude!=TK_NO ){
1854 int addr;
dan108e6b22019-03-18 18:55:35 +00001855 int addrEq = 0;
dan66033422019-03-19 19:19:53 +00001856 KeyInfo *pKeyInfo = 0;
dan108e6b22019-03-18 18:55:35 +00001857
dan66033422019-03-19 19:19:53 +00001858 if( pMWin->pOrderBy ){
1859 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pMWin->pOrderBy, 0, 0);
danc782a812019-03-15 20:46:19 +00001860 }
dan66033422019-03-19 19:19:53 +00001861 if( pMWin->eExclude==TK_TIES ){
1862 addrEq = sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, 0, regRowid);
drh83c5bb92019-04-01 15:55:38 +00001863 VdbeCoverageNeverNull(v);
dan66033422019-03-19 19:19:53 +00001864 }
1865 if( pKeyInfo ){
1866 windowReadPeerValues(p, csr, regPeer);
1867 sqlite3VdbeAddOp3(v, OP_Compare, regPeer, regCPeer, nPeer);
1868 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
1869 addr = sqlite3VdbeCurrentAddr(v)+1;
1870 sqlite3VdbeAddOp3(v, OP_Jump, addr, lblNext, addr);
1871 VdbeCoverageEqNe(v);
1872 }else{
1873 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblNext);
1874 }
danc782a812019-03-15 20:46:19 +00001875 if( addrEq ) sqlite3VdbeJumpHere(v, addrEq);
1876 }
1877
dan37d296a2019-09-24 20:20:05 +00001878 windowAggStep(p, pMWin, csr, 0, p->regArg);
danc782a812019-03-15 20:46:19 +00001879
1880 sqlite3VdbeResolveLabel(v, lblNext);
1881 sqlite3VdbeAddOp2(v, OP_Next, csr, addrNext);
dan1d4b25f2019-03-19 16:49:15 +00001882 VdbeCoverage(v);
danc782a812019-03-15 20:46:19 +00001883 sqlite3VdbeJumpHere(v, addrNext-1);
1884 sqlite3VdbeJumpHere(v, addrNext+1);
1885 sqlite3ReleaseTempReg(pParse, regRowid);
1886 sqlite3ReleaseTempReg(pParse, regCRowid);
1887 if( nPeer ){
1888 sqlite3ReleaseTempRange(pParse, regPeer, nPeer);
1889 sqlite3ReleaseTempRange(pParse, regCPeer, nPeer);
1890 }
1891
1892 windowAggFinal(p, 1);
dan37d296a2019-09-24 20:20:05 +00001893 VdbeModuleComment((v, "windowFullScan end"));
danc782a812019-03-15 20:46:19 +00001894}
1895
dan13078ca2018-06-13 20:29:38 +00001896/*
dan13078ca2018-06-13 20:29:38 +00001897** Invoke the sub-routine at regGosub (generated by code in select.c) to
1898** return the current row of Window.iEphCsr. If all window functions are
1899** aggregate window functions that use the standard API, a single
1900** OP_Gosub instruction is all that this routine generates. Extra VM code
1901** for per-row processing is only generated for the following built-in window
1902** functions:
1903**
1904** nth_value()
1905** first_value()
1906** lag()
1907** lead()
1908*/
danc782a812019-03-15 20:46:19 +00001909static void windowReturnOneRow(WindowCodeArg *p){
1910 Window *pMWin = p->pMWin;
1911 Vdbe *v = p->pVdbe;
dan7095c002018-06-07 17:45:22 +00001912
danc782a812019-03-15 20:46:19 +00001913 if( pMWin->regStartRowid ){
1914 windowFullScan(p);
1915 }else{
1916 Parse *pParse = p->pParse;
1917 Window *pWin;
1918
1919 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001920 FuncDef *pFunc = pWin->pWFunc;
drha4eeccd2021-10-07 17:43:30 +00001921 assert( ExprUseXList(pWin->pOwner) );
danc782a812019-03-15 20:46:19 +00001922 if( pFunc->zName==nth_valueName
1923 || pFunc->zName==first_valueName
1924 ){
dana0f6b832019-03-14 16:36:20 +00001925 int csr = pWin->csrApp;
danc782a812019-03-15 20:46:19 +00001926 int lbl = sqlite3VdbeMakeLabel(pParse);
1927 int tmpReg = sqlite3GetTempReg(pParse);
1928 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
1929
1930 if( pFunc->zName==nth_valueName ){
1931 sqlite3VdbeAddOp3(v, OP_Column,pMWin->iEphCsr,pWin->iArgCol+1,tmpReg);
1932 windowCheckValue(pParse, tmpReg, 2);
1933 }else{
1934 sqlite3VdbeAddOp2(v, OP_Integer, 1, tmpReg);
1935 }
dana0f6b832019-03-14 16:36:20 +00001936 sqlite3VdbeAddOp3(v, OP_Add, tmpReg, pWin->regApp, tmpReg);
1937 sqlite3VdbeAddOp3(v, OP_Gt, pWin->regApp+1, lbl, tmpReg);
1938 VdbeCoverageNeverNull(v);
1939 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, 0, tmpReg);
1940 VdbeCoverageNeverTaken(v);
1941 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult);
danc782a812019-03-15 20:46:19 +00001942 sqlite3VdbeResolveLabel(v, lbl);
1943 sqlite3ReleaseTempReg(pParse, tmpReg);
dana0f6b832019-03-14 16:36:20 +00001944 }
danc782a812019-03-15 20:46:19 +00001945 else if( pFunc->zName==leadName || pFunc->zName==lagName ){
1946 int nArg = pWin->pOwner->x.pList->nExpr;
1947 int csr = pWin->csrApp;
1948 int lbl = sqlite3VdbeMakeLabel(pParse);
1949 int tmpReg = sqlite3GetTempReg(pParse);
1950 int iEph = pMWin->iEphCsr;
1951
1952 if( nArg<3 ){
1953 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
1954 }else{
1955 sqlite3VdbeAddOp3(v, OP_Column, iEph,pWin->iArgCol+2,pWin->regResult);
1956 }
1957 sqlite3VdbeAddOp2(v, OP_Rowid, iEph, tmpReg);
1958 if( nArg<2 ){
1959 int val = (pFunc->zName==leadName ? 1 : -1);
1960 sqlite3VdbeAddOp2(v, OP_AddImm, tmpReg, val);
1961 }else{
1962 int op = (pFunc->zName==leadName ? OP_Add : OP_Subtract);
1963 int tmpReg2 = sqlite3GetTempReg(pParse);
1964 sqlite3VdbeAddOp3(v, OP_Column, iEph, pWin->iArgCol+1, tmpReg2);
1965 sqlite3VdbeAddOp3(v, op, tmpReg2, tmpReg, tmpReg);
1966 sqlite3ReleaseTempReg(pParse, tmpReg2);
1967 }
1968
1969 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, lbl, tmpReg);
1970 VdbeCoverage(v);
1971 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult);
1972 sqlite3VdbeResolveLabel(v, lbl);
1973 sqlite3ReleaseTempReg(pParse, tmpReg);
danfe4e25a2018-06-07 20:08:59 +00001974 }
danfe4e25a2018-06-07 20:08:59 +00001975 }
danec891fd2018-06-06 20:51:02 +00001976 }
danc782a812019-03-15 20:46:19 +00001977 sqlite3VdbeAddOp2(v, OP_Gosub, p->regGosub, p->addrGosub);
danec891fd2018-06-06 20:51:02 +00001978}
1979
dan13078ca2018-06-13 20:29:38 +00001980/*
dan54a9ab32018-06-14 14:27:05 +00001981** Generate code to set the accumulator register for each window function
1982** in the linked list passed as the second argument to NULL. And perform
1983** any equivalent initialization required by any built-in window functions
1984** in the list.
1985*/
dan2e605682018-06-07 15:54:26 +00001986static int windowInitAccum(Parse *pParse, Window *pMWin){
1987 Vdbe *v = sqlite3GetVdbe(pParse);
1988 int regArg;
1989 int nArg = 0;
1990 Window *pWin;
1991 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001992 FuncDef *pFunc = pWin->pWFunc;
dan0a21ea92020-02-29 17:19:42 +00001993 assert( pWin->regAccum );
dan2e605682018-06-07 15:54:26 +00001994 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
dan2a11bb22018-06-11 20:50:25 +00001995 nArg = MAX(nArg, windowArgCount(pWin));
dan108e6b22019-03-18 18:55:35 +00001996 if( pMWin->regStartRowid==0 ){
dana0f6b832019-03-14 16:36:20 +00001997 if( pFunc->zName==nth_valueName || pFunc->zName==first_valueName ){
1998 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp);
1999 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
2000 }
dan9a947222018-06-14 19:06:36 +00002001
dana0f6b832019-03-14 16:36:20 +00002002 if( (pFunc->funcFlags & SQLITE_FUNC_MINMAX) && pWin->csrApp ){
2003 assert( pWin->eStart!=TK_UNBOUNDED );
2004 sqlite3VdbeAddOp1(v, OP_ResetSorter, pWin->csrApp);
2005 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
2006 }
dan9a947222018-06-14 19:06:36 +00002007 }
dan2e605682018-06-07 15:54:26 +00002008 }
2009 regArg = pParse->nMem+1;
2010 pParse->nMem += nArg;
2011 return regArg;
2012}
2013
danb33487b2019-03-06 17:12:32 +00002014/*
dancc7a8502019-03-11 19:50:54 +00002015** Return true if the current frame should be cached in the ephemeral table,
2016** even if there are no xInverse() calls required.
danb33487b2019-03-06 17:12:32 +00002017*/
dancc7a8502019-03-11 19:50:54 +00002018static int windowCacheFrame(Window *pMWin){
danb33487b2019-03-06 17:12:32 +00002019 Window *pWin;
dana0f6b832019-03-14 16:36:20 +00002020 if( pMWin->regStartRowid ) return 1;
danb33487b2019-03-06 17:12:32 +00002021 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00002022 FuncDef *pFunc = pWin->pWFunc;
dancc7a8502019-03-11 19:50:54 +00002023 if( (pFunc->zName==nth_valueName)
danb33487b2019-03-06 17:12:32 +00002024 || (pFunc->zName==first_valueName)
danb560a712019-03-13 15:29:14 +00002025 || (pFunc->zName==leadName)
danb33487b2019-03-06 17:12:32 +00002026 || (pFunc->zName==lagName)
2027 ){
2028 return 1;
2029 }
2030 }
2031 return 0;
2032}
2033
dan6c75b392019-03-08 20:02:52 +00002034/*
2035** regOld and regNew are each the first register in an array of size
2036** pOrderBy->nExpr. This function generates code to compare the two
2037** arrays of registers using the collation sequences and other comparison
2038** parameters specified by pOrderBy.
2039**
2040** If the two arrays are not equal, the contents of regNew is copied to
2041** regOld and control falls through. Otherwise, if the contents of the arrays
2042** are equal, an OP_Goto is executed. The address of the OP_Goto is returned.
2043*/
dan935d9d82019-03-12 15:21:51 +00002044static void windowIfNewPeer(
dan6c75b392019-03-08 20:02:52 +00002045 Parse *pParse,
2046 ExprList *pOrderBy,
2047 int regNew, /* First in array of new values */
dan935d9d82019-03-12 15:21:51 +00002048 int regOld, /* First in array of old values */
2049 int addr /* Jump here */
dan6c75b392019-03-08 20:02:52 +00002050){
2051 Vdbe *v = sqlite3GetVdbe(pParse);
dan6c75b392019-03-08 20:02:52 +00002052 if( pOrderBy ){
2053 int nVal = pOrderBy->nExpr;
2054 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pOrderBy, 0, 0);
2055 sqlite3VdbeAddOp3(v, OP_Compare, regOld, regNew, nVal);
2056 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
dan935d9d82019-03-12 15:21:51 +00002057 sqlite3VdbeAddOp3(v, OP_Jump,
2058 sqlite3VdbeCurrentAddr(v)+1, addr, sqlite3VdbeCurrentAddr(v)+1
dan72b9fdc2019-03-09 20:49:17 +00002059 );
dan6c75b392019-03-08 20:02:52 +00002060 VdbeCoverageEqNe(v);
2061 sqlite3VdbeAddOp3(v, OP_Copy, regNew, regOld, nVal-1);
2062 }else{
dan935d9d82019-03-12 15:21:51 +00002063 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr);
dan6c75b392019-03-08 20:02:52 +00002064 }
dan6c75b392019-03-08 20:02:52 +00002065}
2066
dan72b9fdc2019-03-09 20:49:17 +00002067/*
2068** This function is called as part of generating VM programs for RANGE
dan1e7cb192019-03-16 20:29:54 +00002069** offset PRECEDING/FOLLOWING frame boundaries. Assuming "ASC" order for
dan8b47f522019-08-30 16:14:58 +00002070** the ORDER BY term in the window, and that argument op is OP_Ge, it generates
2071** code equivalent to:
dan72b9fdc2019-03-09 20:49:17 +00002072**
2073** if( csr1.peerVal + regVal >= csr2.peerVal ) goto lbl;
dan1e7cb192019-03-16 20:29:54 +00002074**
dan8b47f522019-08-30 16:14:58 +00002075** The value of parameter op may also be OP_Gt or OP_Le. In these cases the
2076** operator in the above pseudo-code is replaced with ">" or "<=", respectively.
2077**
2078** If the sort-order for the ORDER BY term in the window is DESC, then the
2079** comparison is reversed. Instead of adding regVal to csr1.peerVal, it is
2080** subtracted. And the comparison operator is inverted to - ">=" becomes "<=",
2081** ">" becomes "<", and so on. So, with DESC sort order, if the argument op
2082** is OP_Ge, the generated code is equivalent to:
2083**
2084** if( csr1.peerVal - regVal <= csr2.peerVal ) goto lbl;
2085**
2086** A special type of arithmetic is used such that if csr1.peerVal is not
dan6b6ec402021-04-05 19:05:18 +00002087** a numeric type (real or integer), then the result of the addition
dan8b47f522019-08-30 16:14:58 +00002088** or subtraction is a a copy of csr1.peerVal.
dan72b9fdc2019-03-09 20:49:17 +00002089*/
2090static void windowCodeRangeTest(
2091 WindowCodeArg *p,
dan1cac1762019-08-30 17:28:55 +00002092 int op, /* OP_Ge, OP_Gt, or OP_Le */
2093 int csr1, /* Cursor number for cursor 1 */
2094 int regVal, /* Register containing non-negative number */
2095 int csr2, /* Cursor number for cursor 2 */
2096 int lbl /* Jump destination if condition is true */
dan72b9fdc2019-03-09 20:49:17 +00002097){
2098 Parse *pParse = p->pParse;
2099 Vdbe *v = sqlite3GetVdbe(pParse);
dan1cac1762019-08-30 17:28:55 +00002100 ExprList *pOrderBy = p->pMWin->pOrderBy; /* ORDER BY clause for window */
2101 int reg1 = sqlite3GetTempReg(pParse); /* Reg. for csr1.peerVal+regVal */
2102 int reg2 = sqlite3GetTempReg(pParse); /* Reg. for csr2.peerVal */
2103 int regString = ++pParse->nMem; /* Reg. for constant value '' */
dan8b47f522019-08-30 16:14:58 +00002104 int arith = OP_Add; /* OP_Add or OP_Subtract */
2105 int addrGe; /* Jump destination */
dan6b6ec402021-04-05 19:05:18 +00002106 int addrDone = sqlite3VdbeMakeLabel(pParse); /* Address past OP_Ge */
dan7f8653a2021-03-06 14:46:24 +00002107 CollSeq *pColl;
dan71fddaf2019-03-11 11:12:34 +00002108
dan6b6ec402021-04-05 19:05:18 +00002109 /* Read the peer-value from each cursor into a register */
2110 windowReadPeerValues(p, csr1, reg1);
2111 windowReadPeerValues(p, csr2, reg2);
2112
dan71fddaf2019-03-11 11:12:34 +00002113 assert( op==OP_Ge || op==OP_Gt || op==OP_Le );
danae8e45c2019-08-19 19:59:50 +00002114 assert( pOrderBy && pOrderBy->nExpr==1 );
2115 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_DESC ){
dan71fddaf2019-03-11 11:12:34 +00002116 switch( op ){
2117 case OP_Ge: op = OP_Le; break;
2118 case OP_Gt: op = OP_Lt; break;
2119 default: assert( op==OP_Le ); op = OP_Ge; break;
2120 }
2121 arith = OP_Subtract;
2122 }
2123
dan8b47f522019-08-30 16:14:58 +00002124 VdbeModuleComment((v, "CodeRangeTest: if( R%d %s R%d %s R%d ) goto lbl",
2125 reg1, (arith==OP_Add ? "+" : "-"), regVal,
2126 ((op==OP_Ge) ? ">=" : (op==OP_Le) ? "<=" : (op==OP_Gt) ? ">" : "<"), reg2
2127 ));
2128
dan8b47f522019-08-30 16:14:58 +00002129 /* If the BIGNULL flag is set for the ORDER BY, then it is required to
2130 ** consider NULL values to be larger than all other values, instead of
2131 ** the usual smaller. The VDBE opcodes OP_Ge and so on do not handle this
2132 ** (and adding that capability causes a performance regression), so
2133 ** instead if the BIGNULL flag is set then cases where either reg1 or
2134 ** reg2 are NULL are handled separately in the following block. The code
2135 ** generated is equivalent to:
2136 **
2137 ** if( reg1 IS NULL ){
dan9889ede2019-08-30 19:45:03 +00002138 ** if( op==OP_Ge ) goto lbl;
2139 ** if( op==OP_Gt && reg2 IS NOT NULL ) goto lbl;
dan8b47f522019-08-30 16:14:58 +00002140 ** if( op==OP_Le && reg2 IS NULL ) goto lbl;
2141 ** }else if( reg2 IS NULL ){
2142 ** if( op==OP_Le ) goto lbl;
2143 ** }
2144 **
2145 ** Additionally, if either reg1 or reg2 are NULL but the jump to lbl is
2146 ** not taken, control jumps over the comparison operator coded below this
2147 ** block. */
danae8e45c2019-08-19 19:59:50 +00002148 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_BIGNULL ){
dan8b47f522019-08-30 16:14:58 +00002149 /* This block runs if reg1 contains a NULL. */
2150 int addr = sqlite3VdbeAddOp1(v, OP_NotNull, reg1); VdbeCoverage(v);
danae8e45c2019-08-19 19:59:50 +00002151 switch( op ){
dan8b47f522019-08-30 16:14:58 +00002152 case OP_Ge:
2153 sqlite3VdbeAddOp2(v, OP_Goto, 0, lbl);
2154 break;
danf236b212019-08-21 19:58:11 +00002155 case OP_Gt:
drhdb3a32e2019-08-30 18:02:49 +00002156 sqlite3VdbeAddOp2(v, OP_NotNull, reg2, lbl);
2157 VdbeCoverage(v);
danf236b212019-08-21 19:58:11 +00002158 break;
drhdb3a32e2019-08-30 18:02:49 +00002159 case OP_Le:
2160 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl);
2161 VdbeCoverage(v);
danf236b212019-08-21 19:58:11 +00002162 break;
drhdb3a32e2019-08-30 18:02:49 +00002163 default: assert( op==OP_Lt ); /* no-op */ break;
danae8e45c2019-08-19 19:59:50 +00002164 }
dan6b6ec402021-04-05 19:05:18 +00002165 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
dan8b47f522019-08-30 16:14:58 +00002166
2167 /* This block runs if reg1 is not NULL, but reg2 is. */
danae8e45c2019-08-19 19:59:50 +00002168 sqlite3VdbeJumpHere(v, addr);
2169 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl); VdbeCoverage(v);
2170 if( op==OP_Gt || op==OP_Ge ){
dan6b6ec402021-04-05 19:05:18 +00002171 sqlite3VdbeChangeP2(v, -1, addrDone);
danae8e45c2019-08-19 19:59:50 +00002172 }
2173 }
dan8b47f522019-08-30 16:14:58 +00002174
dan6b6ec402021-04-05 19:05:18 +00002175 /* Register reg1 currently contains csr1.peerVal (the peer-value from csr1).
2176 ** This block adds (or subtracts for DESC) the numeric value in regVal
2177 ** from it. Or, if reg1 is not numeric (it is a NULL, a text value or a blob),
2178 ** then leave reg1 as it is. In pseudo-code, this is implemented as:
2179 **
2180 ** if( reg1>='' ) goto addrGe;
2181 ** reg1 = reg1 +/- regVal
2182 ** addrGe:
2183 **
2184 ** Since all strings and blobs are greater-than-or-equal-to an empty string,
2185 ** the add/subtract is skipped for these, as required. If reg1 is a NULL,
2186 ** then the arithmetic is performed, but since adding or subtracting from
2187 ** NULL is always NULL anyway, this case is handled as required too. */
2188 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC);
2189 addrGe = sqlite3VdbeAddOp3(v, OP_Ge, regString, 0, reg1);
2190 VdbeCoverage(v);
2191 if( (op==OP_Ge && arith==OP_Add) || (op==OP_Le && arith==OP_Subtract) ){
2192 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v);
2193 }
2194 sqlite3VdbeAddOp3(v, arith, regVal, reg1, reg1);
2195 sqlite3VdbeJumpHere(v, addrGe);
2196
dan8b47f522019-08-30 16:14:58 +00002197 /* Compare registers reg2 and reg1, taking the jump if required. Note that
2198 ** control skips over this test if the BIGNULL flag is set and either
2199 ** reg1 or reg2 contain a NULL value. */
drh6f883592019-03-30 20:37:04 +00002200 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v);
dan7f8653a2021-03-06 14:46:24 +00002201 pColl = sqlite3ExprNNCollSeq(pParse, pOrderBy->a[0].pExpr);
2202 sqlite3VdbeAppendP4(v, (void*)pColl, P4_COLLSEQ);
danbdabe742019-03-18 16:51:24 +00002203 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
dan6b6ec402021-04-05 19:05:18 +00002204 sqlite3VdbeResolveLabel(v, addrDone);
dan8b47f522019-08-30 16:14:58 +00002205
drh6f883592019-03-30 20:37:04 +00002206 assert( op==OP_Ge || op==OP_Gt || op==OP_Lt || op==OP_Le );
2207 testcase(op==OP_Ge); VdbeCoverageIf(v, op==OP_Ge);
2208 testcase(op==OP_Lt); VdbeCoverageIf(v, op==OP_Lt);
2209 testcase(op==OP_Le); VdbeCoverageIf(v, op==OP_Le);
2210 testcase(op==OP_Gt); VdbeCoverageIf(v, op==OP_Gt);
dan72b9fdc2019-03-09 20:49:17 +00002211 sqlite3ReleaseTempReg(pParse, reg1);
2212 sqlite3ReleaseTempReg(pParse, reg2);
dan8b47f522019-08-30 16:14:58 +00002213
2214 VdbeModuleComment((v, "CodeRangeTest: end"));
dan72b9fdc2019-03-09 20:49:17 +00002215}
2216
dan0525b6f2019-03-18 21:19:40 +00002217/*
2218** Helper function for sqlite3WindowCodeStep(). Each call to this function
2219** generates VM code for a single RETURN_ROW, AGGSTEP or AGGINVERSE
2220** operation. Refer to the header comment for sqlite3WindowCodeStep() for
2221** details.
2222*/
dan00267b82019-03-06 21:04:11 +00002223static int windowCodeOp(
dan0525b6f2019-03-18 21:19:40 +00002224 WindowCodeArg *p, /* Context object */
2225 int op, /* WINDOW_RETURN_ROW, AGGSTEP or AGGINVERSE */
2226 int regCountdown, /* Register for OP_IfPos countdown */
2227 int jumpOnEof /* Jump here if stepped cursor reaches EOF */
dan00267b82019-03-06 21:04:11 +00002228){
dan6c75b392019-03-08 20:02:52 +00002229 int csr, reg;
2230 Parse *pParse = p->pParse;
dan54975cd2019-03-07 20:47:46 +00002231 Window *pMWin = p->pMWin;
dan00267b82019-03-06 21:04:11 +00002232 int ret = 0;
2233 Vdbe *v = p->pVdbe;
dan6c75b392019-03-08 20:02:52 +00002234 int addrContinue = 0;
drhfc15f4c2019-03-28 13:03:41 +00002235 int bPeer = (pMWin->eFrmType!=TK_ROWS);
dan00267b82019-03-06 21:04:11 +00002236
dan72b9fdc2019-03-09 20:49:17 +00002237 int lblDone = sqlite3VdbeMakeLabel(pParse);
2238 int addrNextRange = 0;
2239
dan54975cd2019-03-07 20:47:46 +00002240 /* Special case - WINDOW_AGGINVERSE is always a no-op if the frame
2241 ** starts with UNBOUNDED PRECEDING. */
2242 if( op==WINDOW_AGGINVERSE && pMWin->eStart==TK_UNBOUNDED ){
2243 assert( regCountdown==0 && jumpOnEof==0 );
2244 return 0;
2245 }
2246
dan00267b82019-03-06 21:04:11 +00002247 if( regCountdown>0 ){
drhfc15f4c2019-03-28 13:03:41 +00002248 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00002249 addrNextRange = sqlite3VdbeCurrentAddr(v);
dan0525b6f2019-03-18 21:19:40 +00002250 assert( op==WINDOW_AGGINVERSE || op==WINDOW_AGGSTEP );
2251 if( op==WINDOW_AGGINVERSE ){
2252 if( pMWin->eStart==TK_FOLLOWING ){
dan72b9fdc2019-03-09 20:49:17 +00002253 windowCodeRangeTest(
dan0525b6f2019-03-18 21:19:40 +00002254 p, OP_Le, p->current.csr, regCountdown, p->start.csr, lblDone
dan72b9fdc2019-03-09 20:49:17 +00002255 );
dan0525b6f2019-03-18 21:19:40 +00002256 }else{
2257 windowCodeRangeTest(
2258 p, OP_Ge, p->start.csr, regCountdown, p->current.csr, lblDone
2259 );
dan72b9fdc2019-03-09 20:49:17 +00002260 }
dan0525b6f2019-03-18 21:19:40 +00002261 }else{
2262 windowCodeRangeTest(
2263 p, OP_Gt, p->end.csr, regCountdown, p->current.csr, lblDone
2264 );
dan72b9fdc2019-03-09 20:49:17 +00002265 }
dan72b9fdc2019-03-09 20:49:17 +00002266 }else{
dan37d296a2019-09-24 20:20:05 +00002267 sqlite3VdbeAddOp3(v, OP_IfPos, regCountdown, lblDone, 1);
dan1d4b25f2019-03-19 16:49:15 +00002268 VdbeCoverage(v);
dan72b9fdc2019-03-09 20:49:17 +00002269 }
dan00267b82019-03-06 21:04:11 +00002270 }
2271
dan0525b6f2019-03-18 21:19:40 +00002272 if( op==WINDOW_RETURN_ROW && pMWin->regStartRowid==0 ){
danc782a812019-03-15 20:46:19 +00002273 windowAggFinal(p, 0);
dan6c75b392019-03-08 20:02:52 +00002274 }
2275 addrContinue = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002276
2277 /* If this is a (RANGE BETWEEN a FOLLOWING AND b FOLLOWING) or
2278 ** (RANGE BETWEEN b PRECEDING AND a PRECEDING) frame, ensure the
2279 ** start cursor does not advance past the end cursor within the
drh113a33c2021-04-24 23:40:05 +00002280 ** temporary table. It otherwise might, if (a>b). Also ensure that,
2281 ** if the input cursor is still finding new rows, that the end
2282 ** cursor does not go past it to EOF. */
dane7579a52019-09-25 16:41:44 +00002283 if( pMWin->eStart==pMWin->eEnd && regCountdown
drh113a33c2021-04-24 23:40:05 +00002284 && pMWin->eFrmType==TK_RANGE
dane7579a52019-09-25 16:41:44 +00002285 ){
2286 int regRowid1 = sqlite3GetTempReg(pParse);
2287 int regRowid2 = sqlite3GetTempReg(pParse);
drh113a33c2021-04-24 23:40:05 +00002288 if( op==WINDOW_AGGINVERSE ){
2289 sqlite3VdbeAddOp2(v, OP_Rowid, p->start.csr, regRowid1);
2290 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid2);
2291 sqlite3VdbeAddOp3(v, OP_Ge, regRowid2, lblDone, regRowid1);
2292 VdbeCoverage(v);
2293 }else if( p->regRowid ){
2294 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid1);
2295 sqlite3VdbeAddOp3(v, OP_Ge, p->regRowid, lblDone, regRowid1);
drh79f313f2021-04-28 15:43:36 +00002296 VdbeCoverageNeverNull(v);
drh113a33c2021-04-24 23:40:05 +00002297 }
dane7579a52019-09-25 16:41:44 +00002298 sqlite3ReleaseTempReg(pParse, regRowid1);
2299 sqlite3ReleaseTempReg(pParse, regRowid2);
2300 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING );
2301 }
2302
dan00267b82019-03-06 21:04:11 +00002303 switch( op ){
2304 case WINDOW_RETURN_ROW:
dan6c75b392019-03-08 20:02:52 +00002305 csr = p->current.csr;
2306 reg = p->current.reg;
danc782a812019-03-15 20:46:19 +00002307 windowReturnOneRow(p);
dan00267b82019-03-06 21:04:11 +00002308 break;
2309
2310 case WINDOW_AGGINVERSE:
dan6c75b392019-03-08 20:02:52 +00002311 csr = p->start.csr;
2312 reg = p->start.reg;
dana0f6b832019-03-14 16:36:20 +00002313 if( pMWin->regStartRowid ){
2314 assert( pMWin->regEndRowid );
2315 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regStartRowid, 1);
2316 }else{
dan37d296a2019-09-24 20:20:05 +00002317 windowAggStep(p, pMWin, csr, 1, p->regArg);
dana0f6b832019-03-14 16:36:20 +00002318 }
dan00267b82019-03-06 21:04:11 +00002319 break;
2320
dan0525b6f2019-03-18 21:19:40 +00002321 default:
2322 assert( op==WINDOW_AGGSTEP );
dan6c75b392019-03-08 20:02:52 +00002323 csr = p->end.csr;
2324 reg = p->end.reg;
dana0f6b832019-03-14 16:36:20 +00002325 if( pMWin->regStartRowid ){
2326 assert( pMWin->regEndRowid );
2327 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regEndRowid, 1);
2328 }else{
dan37d296a2019-09-24 20:20:05 +00002329 windowAggStep(p, pMWin, csr, 0, p->regArg);
dana0f6b832019-03-14 16:36:20 +00002330 }
dan00267b82019-03-06 21:04:11 +00002331 break;
2332 }
2333
danb560a712019-03-13 15:29:14 +00002334 if( op==p->eDelete ){
2335 sqlite3VdbeAddOp1(v, OP_Delete, csr);
2336 sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
2337 }
2338
danc8137502019-03-07 19:26:17 +00002339 if( jumpOnEof ){
2340 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+2);
dan1d4b25f2019-03-19 16:49:15 +00002341 VdbeCoverage(v);
danc8137502019-03-07 19:26:17 +00002342 ret = sqlite3VdbeAddOp0(v, OP_Goto);
2343 }else{
dan6c75b392019-03-08 20:02:52 +00002344 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+1+bPeer);
dan1d4b25f2019-03-19 16:49:15 +00002345 VdbeCoverage(v);
dan6c75b392019-03-08 20:02:52 +00002346 if( bPeer ){
dan37d296a2019-09-24 20:20:05 +00002347 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblDone);
dan6c75b392019-03-08 20:02:52 +00002348 }
dan00267b82019-03-06 21:04:11 +00002349 }
danc8137502019-03-07 19:26:17 +00002350
dan6c75b392019-03-08 20:02:52 +00002351 if( bPeer ){
dan6c75b392019-03-08 20:02:52 +00002352 int nReg = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0);
dane7579a52019-09-25 16:41:44 +00002353 int regTmp = (nReg ? sqlite3GetTempRange(pParse, nReg) : 0);
dan6c75b392019-03-08 20:02:52 +00002354 windowReadPeerValues(p, csr, regTmp);
dan935d9d82019-03-12 15:21:51 +00002355 windowIfNewPeer(pParse, pMWin->pOrderBy, regTmp, reg, addrContinue);
dan6c75b392019-03-08 20:02:52 +00002356 sqlite3ReleaseTempRange(pParse, regTmp, nReg);
dan00267b82019-03-06 21:04:11 +00002357 }
dan6c75b392019-03-08 20:02:52 +00002358
dan72b9fdc2019-03-09 20:49:17 +00002359 if( addrNextRange ){
2360 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNextRange);
2361 }
2362 sqlite3VdbeResolveLabel(v, lblDone);
dan00267b82019-03-06 21:04:11 +00002363 return ret;
2364}
2365
dana786e452019-03-11 18:17:04 +00002366
dan00267b82019-03-06 21:04:11 +00002367/*
dana786e452019-03-11 18:17:04 +00002368** Allocate and return a duplicate of the Window object indicated by the
2369** third argument. Set the Window.pOwner field of the new object to
2370** pOwner.
2371*/
2372Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p){
2373 Window *pNew = 0;
2374 if( ALWAYS(p) ){
2375 pNew = sqlite3DbMallocZero(db, sizeof(Window));
2376 if( pNew ){
2377 pNew->zName = sqlite3DbStrDup(db, p->zName);
danb42eb352019-09-16 05:34:08 +00002378 pNew->zBase = sqlite3DbStrDup(db, p->zBase);
dana786e452019-03-11 18:17:04 +00002379 pNew->pFilter = sqlite3ExprDup(db, p->pFilter, 0);
drh105dcaa2022-03-10 16:01:14 +00002380 pNew->pWFunc = p->pWFunc;
dana786e452019-03-11 18:17:04 +00002381 pNew->pPartition = sqlite3ExprListDup(db, p->pPartition, 0);
2382 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, 0);
drhfc15f4c2019-03-28 13:03:41 +00002383 pNew->eFrmType = p->eFrmType;
dana786e452019-03-11 18:17:04 +00002384 pNew->eEnd = p->eEnd;
2385 pNew->eStart = p->eStart;
danc782a812019-03-15 20:46:19 +00002386 pNew->eExclude = p->eExclude;
drhb555b082019-07-19 01:11:27 +00002387 pNew->regResult = p->regResult;
dan0a21ea92020-02-29 17:19:42 +00002388 pNew->regAccum = p->regAccum;
2389 pNew->iArgCol = p->iArgCol;
2390 pNew->iEphCsr = p->iEphCsr;
2391 pNew->bExprArgs = p->bExprArgs;
dana786e452019-03-11 18:17:04 +00002392 pNew->pStart = sqlite3ExprDup(db, p->pStart, 0);
2393 pNew->pEnd = sqlite3ExprDup(db, p->pEnd, 0);
2394 pNew->pOwner = pOwner;
danb42eb352019-09-16 05:34:08 +00002395 pNew->bImplicitFrame = p->bImplicitFrame;
dana786e452019-03-11 18:17:04 +00002396 }
2397 }
2398 return pNew;
2399}
2400
2401/*
2402** Return a copy of the linked list of Window objects passed as the
2403** second argument.
2404*/
2405Window *sqlite3WindowListDup(sqlite3 *db, Window *p){
2406 Window *pWin;
2407 Window *pRet = 0;
2408 Window **pp = &pRet;
2409
2410 for(pWin=p; pWin; pWin=pWin->pNextWin){
2411 *pp = sqlite3WindowDup(db, 0, pWin);
2412 if( *pp==0 ) break;
2413 pp = &((*pp)->pNextWin);
2414 }
2415
2416 return pRet;
2417}
2418
2419/*
dan725b1cf2019-03-26 16:47:17 +00002420** Return true if it can be determined at compile time that expression
2421** pExpr evaluates to a value that, when cast to an integer, is greater
2422** than zero. False otherwise.
2423**
2424** If an OOM error occurs, this function sets the Parse.db.mallocFailed
2425** flag and returns zero.
2426*/
2427static int windowExprGtZero(Parse *pParse, Expr *pExpr){
2428 int ret = 0;
2429 sqlite3 *db = pParse->db;
2430 sqlite3_value *pVal = 0;
2431 sqlite3ValueFromExpr(db, pExpr, db->enc, SQLITE_AFF_NUMERIC, &pVal);
2432 if( pVal && sqlite3_value_int(pVal)>0 ){
2433 ret = 1;
2434 }
2435 sqlite3ValueFree(pVal);
2436 return ret;
2437}
2438
2439/*
dana786e452019-03-11 18:17:04 +00002440** sqlite3WhereBegin() has already been called for the SELECT statement
2441** passed as the second argument when this function is invoked. It generates
2442** code to populate the Window.regResult register for each window function
2443** and invoke the sub-routine at instruction addrGosub once for each row.
2444** sqlite3WhereEnd() is always called before returning.
dan00267b82019-03-06 21:04:11 +00002445**
dana786e452019-03-11 18:17:04 +00002446** This function handles several different types of window frames, which
2447** require slightly different processing. The following pseudo code is
2448** used to implement window frames of the form:
dan00267b82019-03-06 21:04:11 +00002449**
dana786e452019-03-11 18:17:04 +00002450** ROWS BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING
dan00267b82019-03-06 21:04:11 +00002451**
dana786e452019-03-11 18:17:04 +00002452** Other window frame types use variants of the following:
2453**
2454** ... loop started by sqlite3WhereBegin() ...
dan00267b82019-03-06 21:04:11 +00002455** if( new partition ){
2456** Gosub flush
dana786e452019-03-11 18:17:04 +00002457** }
dan00267b82019-03-06 21:04:11 +00002458** Insert new row into eph table.
dana786e452019-03-11 18:17:04 +00002459**
dan00267b82019-03-06 21:04:11 +00002460** if( first row of partition ){
dana786e452019-03-11 18:17:04 +00002461** // Rewind three cursors, all open on the eph table.
2462** Rewind(csrEnd);
2463** Rewind(csrStart);
2464** Rewind(csrCurrent);
2465**
dan00267b82019-03-06 21:04:11 +00002466** regEnd = <expr2> // FOLLOWING expression
2467** regStart = <expr1> // PRECEDING expression
2468** }else{
dana786e452019-03-11 18:17:04 +00002469** // First time this branch is taken, the eph table contains two
2470** // rows. The first row in the partition, which all three cursors
2471** // currently point to, and the following row.
2472** AGGSTEP
dan00267b82019-03-06 21:04:11 +00002473** if( (regEnd--)<=0 ){
dana786e452019-03-11 18:17:04 +00002474** RETURN_ROW
2475** if( (regStart--)<=0 ){
2476** AGGINVERSE
dan00267b82019-03-06 21:04:11 +00002477** }
2478** }
dana786e452019-03-11 18:17:04 +00002479** }
2480** }
dan00267b82019-03-06 21:04:11 +00002481** flush:
dana786e452019-03-11 18:17:04 +00002482** AGGSTEP
2483** while( 1 ){
2484** RETURN ROW
2485** if( csrCurrent is EOF ) break;
2486** if( (regStart--)<=0 ){
2487** AggInverse(csrStart)
2488** Next(csrStart)
dan00267b82019-03-06 21:04:11 +00002489** }
dana786e452019-03-11 18:17:04 +00002490** }
dan00267b82019-03-06 21:04:11 +00002491**
dana786e452019-03-11 18:17:04 +00002492** The pseudo-code above uses the following shorthand:
dan00267b82019-03-06 21:04:11 +00002493**
dana786e452019-03-11 18:17:04 +00002494** AGGSTEP: invoke the aggregate xStep() function for each window function
2495** with arguments read from the current row of cursor csrEnd, then
2496** step cursor csrEnd forward one row (i.e. sqlite3BtreeNext()).
2497**
2498** RETURN_ROW: return a row to the caller based on the contents of the
2499** current row of csrCurrent and the current state of all
2500** aggregates. Then step cursor csrCurrent forward one row.
2501**
2502** AGGINVERSE: invoke the aggregate xInverse() function for each window
2503** functions with arguments read from the current row of cursor
2504** csrStart. Then step csrStart forward one row.
2505**
2506** There are two other ROWS window frames that are handled significantly
2507** differently from the above - "BETWEEN <expr> PRECEDING AND <expr> PRECEDING"
2508** and "BETWEEN <expr> FOLLOWING AND <expr> FOLLOWING". These are special
2509** cases because they change the order in which the three cursors (csrStart,
2510** csrCurrent and csrEnd) iterate through the ephemeral table. Cases that
2511** use UNBOUNDED or CURRENT ROW are much simpler variations on one of these
2512** three.
2513**
2514** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2515**
2516** ... loop started by sqlite3WhereBegin() ...
dan00267b82019-03-06 21:04:11 +00002517** if( new partition ){
2518** Gosub flush
dana786e452019-03-11 18:17:04 +00002519** }
dan00267b82019-03-06 21:04:11 +00002520** Insert new row into eph table.
2521** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002522** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002523** regEnd = <expr2>
2524** regStart = <expr1>
dan00267b82019-03-06 21:04:11 +00002525** }else{
dana786e452019-03-11 18:17:04 +00002526** if( (regEnd--)<=0 ){
2527** AGGSTEP
2528** }
2529** RETURN_ROW
2530** if( (regStart--)<=0 ){
2531** AGGINVERSE
2532** }
2533** }
2534** }
dan00267b82019-03-06 21:04:11 +00002535** flush:
dana786e452019-03-11 18:17:04 +00002536** if( (regEnd--)<=0 ){
2537** AGGSTEP
2538** }
2539** RETURN_ROW
2540**
2541**
2542** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2543**
2544** ... loop started by sqlite3WhereBegin() ...
2545** if( new partition ){
2546** Gosub flush
2547** }
2548** Insert new row into eph table.
2549** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002550** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002551** regEnd = <expr2>
2552** regStart = regEnd - <expr1>
2553** }else{
2554** AGGSTEP
2555** if( (regEnd--)<=0 ){
2556** RETURN_ROW
2557** }
2558** if( (regStart--)<=0 ){
2559** AGGINVERSE
2560** }
2561** }
2562** }
2563** flush:
2564** AGGSTEP
2565** while( 1 ){
2566** if( (regEnd--)<=0 ){
2567** RETURN_ROW
2568** if( eof ) break;
2569** }
2570** if( (regStart--)<=0 ){
2571** AGGINVERSE
2572** if( eof ) break
2573** }
2574** }
2575** while( !eof csrCurrent ){
2576** RETURN_ROW
2577** }
2578**
2579** For the most part, the patterns above are adapted to support UNBOUNDED by
2580** assuming that it is equivalent to "infinity PRECEDING/FOLLOWING" and
2581** CURRENT ROW by assuming that it is equivilent to "0 PRECEDING/FOLLOWING".
2582** This is optimized of course - branches that will never be taken and
2583** conditions that are always true are omitted from the VM code. The only
2584** exceptional case is:
2585**
2586** ROWS BETWEEN <expr1> FOLLOWING AND UNBOUNDED FOLLOWING
2587**
2588** ... loop started by sqlite3WhereBegin() ...
2589** if( new partition ){
2590** Gosub flush
2591** }
2592** Insert new row into eph table.
2593** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002594** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002595** regStart = <expr1>
2596** }else{
2597** AGGSTEP
2598** }
2599** }
2600** flush:
2601** AGGSTEP
2602** while( 1 ){
2603** if( (regStart--)<=0 ){
2604** AGGINVERSE
2605** if( eof ) break
2606** }
2607** RETURN_ROW
2608** }
2609** while( !eof csrCurrent ){
2610** RETURN_ROW
2611** }
dan935d9d82019-03-12 15:21:51 +00002612**
2613** Also requiring special handling are the cases:
2614**
2615** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2616** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2617**
2618** when (expr1 < expr2). This is detected at runtime, not by this function.
2619** To handle this case, the pseudo-code programs depicted above are modified
2620** slightly to be:
2621**
2622** ... loop started by sqlite3WhereBegin() ...
2623** if( new partition ){
2624** Gosub flush
2625** }
2626** Insert new row into eph table.
2627** if( first row of partition ){
2628** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2629** regEnd = <expr2>
2630** regStart = <expr1>
2631** if( regEnd < regStart ){
2632** RETURN_ROW
2633** delete eph table contents
2634** continue
2635** }
2636** ...
2637**
2638** The new "continue" statement in the above jumps to the next iteration
2639** of the outer loop - the one started by sqlite3WhereBegin().
2640**
2641** The various GROUPS cases are implemented using the same patterns as
2642** ROWS. The VM code is modified slightly so that:
2643**
2644** 1. The else branch in the main loop is only taken if the row just
2645** added to the ephemeral table is the start of a new group. In
2646** other words, it becomes:
2647**
2648** ... loop started by sqlite3WhereBegin() ...
2649** if( new partition ){
2650** Gosub flush
2651** }
2652** Insert new row into eph table.
2653** if( first row of partition ){
2654** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2655** regEnd = <expr2>
2656** regStart = <expr1>
2657** }else if( new group ){
2658** ...
2659** }
2660** }
2661**
2662** 2. Instead of processing a single row, each RETURN_ROW, AGGSTEP or
2663** AGGINVERSE step processes the current row of the relevant cursor and
2664** all subsequent rows belonging to the same group.
2665**
2666** RANGE window frames are a little different again. As for GROUPS, the
2667** main loop runs once per group only. And RETURN_ROW, AGGSTEP and AGGINVERSE
2668** deal in groups instead of rows. As for ROWS and GROUPS, there are three
2669** basic cases:
2670**
2671** RANGE BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING
2672**
2673** ... loop started by sqlite3WhereBegin() ...
2674** if( new partition ){
2675** Gosub flush
2676** }
2677** Insert new row into eph table.
2678** if( first row of partition ){
2679** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2680** regEnd = <expr2>
2681** regStart = <expr1>
2682** }else{
2683** AGGSTEP
2684** while( (csrCurrent.key + regEnd) < csrEnd.key ){
2685** RETURN_ROW
2686** while( csrStart.key + regStart) < csrCurrent.key ){
2687** AGGINVERSE
2688** }
2689** }
2690** }
2691** }
2692** flush:
2693** AGGSTEP
2694** while( 1 ){
2695** RETURN ROW
2696** if( csrCurrent is EOF ) break;
2697** while( csrStart.key + regStart) < csrCurrent.key ){
2698** AGGINVERSE
2699** }
2700** }
2701** }
2702**
2703** In the above notation, "csr.key" means the current value of the ORDER BY
2704** expression (there is only ever 1 for a RANGE that uses an <expr> FOLLOWING
2705** or <expr PRECEDING) read from cursor csr.
2706**
2707** RANGE BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2708**
2709** ... loop started by sqlite3WhereBegin() ...
2710** if( new partition ){
2711** Gosub flush
2712** }
2713** Insert new row into eph table.
2714** if( first row of partition ){
2715** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2716** regEnd = <expr2>
2717** regStart = <expr1>
2718** }else{
dan37d296a2019-09-24 20:20:05 +00002719** while( (csrEnd.key + regEnd) <= csrCurrent.key ){
dan935d9d82019-03-12 15:21:51 +00002720** AGGSTEP
2721** }
dan935d9d82019-03-12 15:21:51 +00002722** while( (csrStart.key + regStart) < csrCurrent.key ){
2723** AGGINVERSE
2724** }
dane7579a52019-09-25 16:41:44 +00002725** RETURN_ROW
dan935d9d82019-03-12 15:21:51 +00002726** }
2727** }
2728** flush:
2729** while( (csrEnd.key + regEnd) <= csrCurrent.key ){
2730** AGGSTEP
2731** }
dan3f49c322019-04-03 16:27:44 +00002732** while( (csrStart.key + regStart) < csrCurrent.key ){
2733** AGGINVERSE
2734** }
dane7579a52019-09-25 16:41:44 +00002735** RETURN_ROW
dan935d9d82019-03-12 15:21:51 +00002736**
2737** RANGE BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2738**
2739** ... loop started by sqlite3WhereBegin() ...
2740** if( new partition ){
2741** Gosub flush
2742** }
2743** Insert new row into eph table.
2744** if( first row of partition ){
2745** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2746** regEnd = <expr2>
2747** regStart = <expr1>
2748** }else{
2749** AGGSTEP
2750** while( (csrCurrent.key + regEnd) < csrEnd.key ){
2751** while( (csrCurrent.key + regStart) > csrStart.key ){
2752** AGGINVERSE
2753** }
2754** RETURN_ROW
2755** }
2756** }
2757** }
2758** flush:
2759** AGGSTEP
2760** while( 1 ){
2761** while( (csrCurrent.key + regStart) > csrStart.key ){
2762** AGGINVERSE
2763** if( eof ) break "while( 1 )" loop.
2764** }
2765** RETURN_ROW
2766** }
2767** while( !eof csrCurrent ){
2768** RETURN_ROW
2769** }
2770**
danb6f2dea2019-03-13 17:20:27 +00002771** The text above leaves out many details. Refer to the code and comments
2772** below for a more complete picture.
dan00267b82019-03-06 21:04:11 +00002773*/
dana786e452019-03-11 18:17:04 +00002774void sqlite3WindowCodeStep(
dancc7a8502019-03-11 19:50:54 +00002775 Parse *pParse, /* Parse context */
dana786e452019-03-11 18:17:04 +00002776 Select *p, /* Rewritten SELECT statement */
2777 WhereInfo *pWInfo, /* Context returned by sqlite3WhereBegin() */
2778 int regGosub, /* Register for OP_Gosub */
2779 int addrGosub /* OP_Gosub here to return each row */
dan680f6e82019-03-04 21:07:11 +00002780){
2781 Window *pMWin = p->pWin;
dan6c75b392019-03-08 20:02:52 +00002782 ExprList *pOrderBy = pMWin->pOrderBy;
dan680f6e82019-03-04 21:07:11 +00002783 Vdbe *v = sqlite3GetVdbe(pParse);
dana786e452019-03-11 18:17:04 +00002784 int csrWrite; /* Cursor used to write to eph. table */
2785 int csrInput = p->pSrc->a[0].iCursor; /* Cursor of sub-select */
2786 int nInput = p->pSrc->a[0].pTab->nCol; /* Number of cols returned by sub */
2787 int iInput; /* To iterate through sub cols */
danbf845152019-03-16 10:15:24 +00002788 int addrNe; /* Address of OP_Ne */
drhd4a591d2019-03-26 16:21:11 +00002789 int addrGosubFlush = 0; /* Address of OP_Gosub to flush: */
2790 int addrInteger = 0; /* Address of OP_Integer */
dand4461652019-03-13 08:28:51 +00002791 int addrEmpty; /* Address of OP_Rewind in flush: */
dana786e452019-03-11 18:17:04 +00002792 int regNew; /* Array of registers holding new input row */
2793 int regRecord; /* regNew array in record form */
dana786e452019-03-11 18:17:04 +00002794 int regNewPeer = 0; /* Peer values for new row (part of regNew) */
2795 int regPeer = 0; /* Peer values for current row */
dand4461652019-03-13 08:28:51 +00002796 int regFlushPart = 0; /* Register for "Gosub flush_partition" */
dana786e452019-03-11 18:17:04 +00002797 WindowCodeArg s; /* Context object for sub-routines */
dan935d9d82019-03-12 15:21:51 +00002798 int lblWhereEnd; /* Label just before sqlite3WhereEnd() code */
dane7579a52019-09-25 16:41:44 +00002799 int regStart = 0; /* Value of <expr> PRECEDING */
2800 int regEnd = 0; /* Value of <expr> FOLLOWING */
dan680f6e82019-03-04 21:07:11 +00002801
dan72b9fdc2019-03-09 20:49:17 +00002802 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_CURRENT
2803 || pMWin->eStart==TK_FOLLOWING || pMWin->eStart==TK_UNBOUNDED
2804 );
2805 assert( pMWin->eEnd==TK_FOLLOWING || pMWin->eEnd==TK_CURRENT
2806 || pMWin->eEnd==TK_UNBOUNDED || pMWin->eEnd==TK_PRECEDING
2807 );
dan108e6b22019-03-18 18:55:35 +00002808 assert( pMWin->eExclude==0 || pMWin->eExclude==TK_CURRENT
2809 || pMWin->eExclude==TK_GROUP || pMWin->eExclude==TK_TIES
2810 || pMWin->eExclude==TK_NO
2811 );
dan72b9fdc2019-03-09 20:49:17 +00002812
dan935d9d82019-03-12 15:21:51 +00002813 lblWhereEnd = sqlite3VdbeMakeLabel(pParse);
dana786e452019-03-11 18:17:04 +00002814
2815 /* Fill in the context object */
dan00267b82019-03-06 21:04:11 +00002816 memset(&s, 0, sizeof(WindowCodeArg));
2817 s.pParse = pParse;
2818 s.pMWin = pMWin;
2819 s.pVdbe = v;
2820 s.regGosub = regGosub;
2821 s.addrGosub = addrGosub;
dan6c75b392019-03-08 20:02:52 +00002822 s.current.csr = pMWin->iEphCsr;
dana786e452019-03-11 18:17:04 +00002823 csrWrite = s.current.csr+1;
dan6c75b392019-03-08 20:02:52 +00002824 s.start.csr = s.current.csr+2;
2825 s.end.csr = s.current.csr+3;
danb33487b2019-03-06 17:12:32 +00002826
danb560a712019-03-13 15:29:14 +00002827 /* Figure out when rows may be deleted from the ephemeral table. There
2828 ** are four options - they may never be deleted (eDelete==0), they may
2829 ** be deleted as soon as they are no longer part of the window frame
2830 ** (eDelete==WINDOW_AGGINVERSE), they may be deleted as after the row
2831 ** has been returned to the caller (WINDOW_RETURN_ROW), or they may
2832 ** be deleted after they enter the frame (WINDOW_AGGSTEP). */
2833 switch( pMWin->eStart ){
dan725b1cf2019-03-26 16:47:17 +00002834 case TK_FOLLOWING:
drhfc15f4c2019-03-28 13:03:41 +00002835 if( pMWin->eFrmType!=TK_RANGE
2836 && windowExprGtZero(pParse, pMWin->pStart)
2837 ){
dan725b1cf2019-03-26 16:47:17 +00002838 s.eDelete = WINDOW_RETURN_ROW;
danb560a712019-03-13 15:29:14 +00002839 }
danb560a712019-03-13 15:29:14 +00002840 break;
danb560a712019-03-13 15:29:14 +00002841 case TK_UNBOUNDED:
2842 if( windowCacheFrame(pMWin)==0 ){
2843 if( pMWin->eEnd==TK_PRECEDING ){
drhfc15f4c2019-03-28 13:03:41 +00002844 if( pMWin->eFrmType!=TK_RANGE
2845 && windowExprGtZero(pParse, pMWin->pEnd)
2846 ){
dan725b1cf2019-03-26 16:47:17 +00002847 s.eDelete = WINDOW_AGGSTEP;
2848 }
danb560a712019-03-13 15:29:14 +00002849 }else{
2850 s.eDelete = WINDOW_RETURN_ROW;
2851 }
2852 }
2853 break;
2854 default:
2855 s.eDelete = WINDOW_AGGINVERSE;
2856 break;
2857 }
2858
dand4461652019-03-13 08:28:51 +00002859 /* Allocate registers for the array of values from the sub-query, the
2860 ** samve values in record form, and the rowid used to insert said record
2861 ** into the ephemeral table. */
dana786e452019-03-11 18:17:04 +00002862 regNew = pParse->nMem+1;
2863 pParse->nMem += nInput;
2864 regRecord = ++pParse->nMem;
drh113a33c2021-04-24 23:40:05 +00002865 s.regRowid = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002866
dana786e452019-03-11 18:17:04 +00002867 /* If the window frame contains an "<expr> PRECEDING" or "<expr> FOLLOWING"
2868 ** clause, allocate registers to store the results of evaluating each
2869 ** <expr>. */
dan54975cd2019-03-07 20:47:46 +00002870 if( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING ){
dane7579a52019-09-25 16:41:44 +00002871 regStart = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002872 }
2873 if( pMWin->eEnd==TK_PRECEDING || pMWin->eEnd==TK_FOLLOWING ){
dane7579a52019-09-25 16:41:44 +00002874 regEnd = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002875 }
dan680f6e82019-03-04 21:07:11 +00002876
dan72b9fdc2019-03-09 20:49:17 +00002877 /* If this is not a "ROWS BETWEEN ..." frame, then allocate arrays of
dana786e452019-03-11 18:17:04 +00002878 ** registers to store copies of the ORDER BY expressions (peer values)
2879 ** for the main loop, and for each cursor (start, current and end). */
drhfc15f4c2019-03-28 13:03:41 +00002880 if( pMWin->eFrmType!=TK_ROWS ){
dan6c75b392019-03-08 20:02:52 +00002881 int nPeer = (pOrderBy ? pOrderBy->nExpr : 0);
dana786e452019-03-11 18:17:04 +00002882 regNewPeer = regNew + pMWin->nBufferCol;
dan6c75b392019-03-08 20:02:52 +00002883 if( pMWin->pPartition ) regNewPeer += pMWin->pPartition->nExpr;
dan6c75b392019-03-08 20:02:52 +00002884 regPeer = pParse->nMem+1; pParse->nMem += nPeer;
2885 s.start.reg = pParse->nMem+1; pParse->nMem += nPeer;
2886 s.current.reg = pParse->nMem+1; pParse->nMem += nPeer;
2887 s.end.reg = pParse->nMem+1; pParse->nMem += nPeer;
2888 }
2889
dan680f6e82019-03-04 21:07:11 +00002890 /* Load the column values for the row returned by the sub-select
dana786e452019-03-11 18:17:04 +00002891 ** into an array of registers starting at regNew. Assemble them into
2892 ** a record in register regRecord. */
2893 for(iInput=0; iInput<nInput; iInput++){
2894 sqlite3VdbeAddOp3(v, OP_Column, csrInput, iInput, regNew+iInput);
dan680f6e82019-03-04 21:07:11 +00002895 }
dana786e452019-03-11 18:17:04 +00002896 sqlite3VdbeAddOp3(v, OP_MakeRecord, regNew, nInput, regRecord);
dan680f6e82019-03-04 21:07:11 +00002897
danb33487b2019-03-06 17:12:32 +00002898 /* An input row has just been read into an array of registers starting
dana786e452019-03-11 18:17:04 +00002899 ** at regNew. If the window has a PARTITION clause, this block generates
danb33487b2019-03-06 17:12:32 +00002900 ** VM code to check if the input row is the start of a new partition.
2901 ** If so, it does an OP_Gosub to an address to be filled in later. The
dana786e452019-03-11 18:17:04 +00002902 ** address of the OP_Gosub is stored in local variable addrGosubFlush. */
dan680f6e82019-03-04 21:07:11 +00002903 if( pMWin->pPartition ){
2904 int addr;
2905 ExprList *pPart = pMWin->pPartition;
2906 int nPart = pPart->nExpr;
dana786e452019-03-11 18:17:04 +00002907 int regNewPart = regNew + pMWin->nBufferCol;
dan680f6e82019-03-04 21:07:11 +00002908 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pPart, 0, 0);
2909
dand4461652019-03-13 08:28:51 +00002910 regFlushPart = ++pParse->nMem;
dan680f6e82019-03-04 21:07:11 +00002911 addr = sqlite3VdbeAddOp3(v, OP_Compare, regNewPart, pMWin->regPart, nPart);
2912 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
danb33487b2019-03-06 17:12:32 +00002913 sqlite3VdbeAddOp3(v, OP_Jump, addr+2, addr+4, addr+2);
dan680f6e82019-03-04 21:07:11 +00002914 VdbeCoverageEqNe(v);
2915 addrGosubFlush = sqlite3VdbeAddOp1(v, OP_Gosub, regFlushPart);
2916 VdbeComment((v, "call flush_partition"));
danb33487b2019-03-06 17:12:32 +00002917 sqlite3VdbeAddOp3(v, OP_Copy, regNewPart, pMWin->regPart, nPart-1);
dan680f6e82019-03-04 21:07:11 +00002918 }
2919
2920 /* Insert the new row into the ephemeral table */
drh113a33c2021-04-24 23:40:05 +00002921 sqlite3VdbeAddOp2(v, OP_NewRowid, csrWrite, s.regRowid);
2922 sqlite3VdbeAddOp3(v, OP_Insert, csrWrite, regRecord, s.regRowid);
2923 addrNe = sqlite3VdbeAddOp3(v, OP_Ne, pMWin->regOne, 0, s.regRowid);
drh83c5bb92019-04-01 15:55:38 +00002924 VdbeCoverageNeverNull(v);
danb25a2142019-03-05 19:29:36 +00002925
danb33487b2019-03-06 17:12:32 +00002926 /* This block is run for the first row of each partition */
dana786e452019-03-11 18:17:04 +00002927 s.regArg = windowInitAccum(pParse, pMWin);
dan680f6e82019-03-04 21:07:11 +00002928
dane7579a52019-09-25 16:41:44 +00002929 if( regStart ){
2930 sqlite3ExprCode(pParse, pMWin->pStart, regStart);
2931 windowCheckValue(pParse, regStart, 0 + (pMWin->eFrmType==TK_RANGE?3:0));
dan54975cd2019-03-07 20:47:46 +00002932 }
dane7579a52019-09-25 16:41:44 +00002933 if( regEnd ){
2934 sqlite3ExprCode(pParse, pMWin->pEnd, regEnd);
2935 windowCheckValue(pParse, regEnd, 1 + (pMWin->eFrmType==TK_RANGE?3:0));
dan54975cd2019-03-07 20:47:46 +00002936 }
danb25a2142019-03-05 19:29:36 +00002937
dane7579a52019-09-25 16:41:44 +00002938 if( pMWin->eFrmType!=TK_RANGE && pMWin->eStart==pMWin->eEnd && regStart ){
danb25a2142019-03-05 19:29:36 +00002939 int op = ((pMWin->eStart==TK_FOLLOWING) ? OP_Ge : OP_Le);
dane7579a52019-09-25 16:41:44 +00002940 int addrGe = sqlite3VdbeAddOp3(v, op, regStart, 0, regEnd);
drh495ed622019-04-01 16:23:21 +00002941 VdbeCoverageNeverNullIf(v, op==OP_Ge); /* NeverNull because bound <expr> */
2942 VdbeCoverageNeverNullIf(v, op==OP_Le); /* values previously checked */
danc782a812019-03-15 20:46:19 +00002943 windowAggFinal(&s, 0);
dancc7a8502019-03-11 19:50:54 +00002944 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002945 VdbeCoverageNeverTaken(v);
danc782a812019-03-15 20:46:19 +00002946 windowReturnOneRow(&s);
dancc7a8502019-03-11 19:50:54 +00002947 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr);
dan935d9d82019-03-12 15:21:51 +00002948 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd);
danb25a2142019-03-05 19:29:36 +00002949 sqlite3VdbeJumpHere(v, addrGe);
2950 }
dane7579a52019-09-25 16:41:44 +00002951 if( pMWin->eStart==TK_FOLLOWING && pMWin->eFrmType!=TK_RANGE && regEnd ){
dan54975cd2019-03-07 20:47:46 +00002952 assert( pMWin->eEnd==TK_FOLLOWING );
dane7579a52019-09-25 16:41:44 +00002953 sqlite3VdbeAddOp3(v, OP_Subtract, regStart, regEnd, regStart);
danb25a2142019-03-05 19:29:36 +00002954 }
2955
dan54975cd2019-03-07 20:47:46 +00002956 if( pMWin->eStart!=TK_UNBOUNDED ){
dan6c75b392019-03-08 20:02:52 +00002957 sqlite3VdbeAddOp2(v, OP_Rewind, s.start.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002958 VdbeCoverageNeverTaken(v);
dan54975cd2019-03-07 20:47:46 +00002959 }
dan6c75b392019-03-08 20:02:52 +00002960 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002961 VdbeCoverageNeverTaken(v);
dan6c75b392019-03-08 20:02:52 +00002962 sqlite3VdbeAddOp2(v, OP_Rewind, s.end.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002963 VdbeCoverageNeverTaken(v);
dan6c75b392019-03-08 20:02:52 +00002964 if( regPeer && pOrderBy ){
dancc7a8502019-03-11 19:50:54 +00002965 sqlite3VdbeAddOp3(v, OP_Copy, regNewPeer, regPeer, pOrderBy->nExpr-1);
dan6c75b392019-03-08 20:02:52 +00002966 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.start.reg, pOrderBy->nExpr-1);
2967 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.current.reg, pOrderBy->nExpr-1);
2968 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.end.reg, pOrderBy->nExpr-1);
2969 }
danb25a2142019-03-05 19:29:36 +00002970
dan935d9d82019-03-12 15:21:51 +00002971 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd);
dan680f6e82019-03-04 21:07:11 +00002972
danbf845152019-03-16 10:15:24 +00002973 sqlite3VdbeJumpHere(v, addrNe);
dan3f49c322019-04-03 16:27:44 +00002974
2975 /* Beginning of the block executed for the second and subsequent rows. */
dan6c75b392019-03-08 20:02:52 +00002976 if( regPeer ){
dan935d9d82019-03-12 15:21:51 +00002977 windowIfNewPeer(pParse, pOrderBy, regNewPeer, regPeer, lblWhereEnd);
dan6c75b392019-03-08 20:02:52 +00002978 }
danb25a2142019-03-05 19:29:36 +00002979 if( pMWin->eStart==TK_FOLLOWING ){
dan6c75b392019-03-08 20:02:52 +00002980 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
dan54975cd2019-03-07 20:47:46 +00002981 if( pMWin->eEnd!=TK_UNBOUNDED ){
drhfc15f4c2019-03-28 13:03:41 +00002982 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00002983 int lbl = sqlite3VdbeMakeLabel(pParse);
2984 int addrNext = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002985 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl);
2986 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan72b9fdc2019-03-09 20:49:17 +00002987 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
2988 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNext);
2989 sqlite3VdbeResolveLabel(v, lbl);
2990 }else{
dane7579a52019-09-25 16:41:44 +00002991 windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 0);
2992 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan72b9fdc2019-03-09 20:49:17 +00002993 }
dan54975cd2019-03-07 20:47:46 +00002994 }
danb25a2142019-03-05 19:29:36 +00002995 }else
2996 if( pMWin->eEnd==TK_PRECEDING ){
dan3f49c322019-04-03 16:27:44 +00002997 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE);
dane7579a52019-09-25 16:41:44 +00002998 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0);
2999 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan6c75b392019-03-08 20:02:52 +00003000 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00003001 if( !bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
danb25a2142019-03-05 19:29:36 +00003002 }else{
mistachkinba9ee092019-03-27 14:58:18 +00003003 int addr = 0;
dan6c75b392019-03-08 20:02:52 +00003004 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
dan54975cd2019-03-07 20:47:46 +00003005 if( pMWin->eEnd!=TK_UNBOUNDED ){
drhfc15f4c2019-03-28 13:03:41 +00003006 if( pMWin->eFrmType==TK_RANGE ){
mistachkinba9ee092019-03-27 14:58:18 +00003007 int lbl = 0;
dan72b9fdc2019-03-09 20:49:17 +00003008 addr = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003009 if( regEnd ){
dan72b9fdc2019-03-09 20:49:17 +00003010 lbl = sqlite3VdbeMakeLabel(pParse);
dane7579a52019-09-25 16:41:44 +00003011 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl);
dan72b9fdc2019-03-09 20:49:17 +00003012 }
3013 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00003014 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
3015 if( regEnd ){
dan72b9fdc2019-03-09 20:49:17 +00003016 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr);
3017 sqlite3VdbeResolveLabel(v, lbl);
3018 }
3019 }else{
dane7579a52019-09-25 16:41:44 +00003020 if( regEnd ){
3021 addr = sqlite3VdbeAddOp3(v, OP_IfPos, regEnd, 0, 1);
dan1d4b25f2019-03-19 16:49:15 +00003022 VdbeCoverage(v);
3023 }
dan72b9fdc2019-03-09 20:49:17 +00003024 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00003025 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
3026 if( regEnd ) sqlite3VdbeJumpHere(v, addr);
dan72b9fdc2019-03-09 20:49:17 +00003027 }
dan54975cd2019-03-07 20:47:46 +00003028 }
danb25a2142019-03-05 19:29:36 +00003029 }
dan680f6e82019-03-04 21:07:11 +00003030
dan680f6e82019-03-04 21:07:11 +00003031 /* End of the main input loop */
dan935d9d82019-03-12 15:21:51 +00003032 sqlite3VdbeResolveLabel(v, lblWhereEnd);
dancc7a8502019-03-11 19:50:54 +00003033 sqlite3WhereEnd(pWInfo);
dan680f6e82019-03-04 21:07:11 +00003034
3035 /* Fall through */
dancc7a8502019-03-11 19:50:54 +00003036 if( pMWin->pPartition ){
dan680f6e82019-03-04 21:07:11 +00003037 addrInteger = sqlite3VdbeAddOp2(v, OP_Integer, 0, regFlushPart);
3038 sqlite3VdbeJumpHere(v, addrGosubFlush);
3039 }
3040
drh113a33c2021-04-24 23:40:05 +00003041 s.regRowid = 0;
danc8137502019-03-07 19:26:17 +00003042 addrEmpty = sqlite3VdbeAddOp1(v, OP_Rewind, csrWrite);
dan1d4b25f2019-03-19 16:49:15 +00003043 VdbeCoverage(v);
dan00267b82019-03-06 21:04:11 +00003044 if( pMWin->eEnd==TK_PRECEDING ){
dan3f49c322019-04-03 16:27:44 +00003045 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE);
dane7579a52019-09-25 16:41:44 +00003046 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0);
3047 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan6c75b392019-03-08 20:02:52 +00003048 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
danc8137502019-03-07 19:26:17 +00003049 }else if( pMWin->eStart==TK_FOLLOWING ){
3050 int addrStart;
3051 int addrBreak1;
3052 int addrBreak2;
3053 int addrBreak3;
dan6c75b392019-03-08 20:02:52 +00003054 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
drhfc15f4c2019-03-28 13:03:41 +00003055 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00003056 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003057 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1);
dan72b9fdc2019-03-09 20:49:17 +00003058 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
3059 }else
dan54975cd2019-03-07 20:47:46 +00003060 if( pMWin->eEnd==TK_UNBOUNDED ){
3061 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003062 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regStart, 1);
dan6c75b392019-03-08 20:02:52 +00003063 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, 0, 1);
dan54975cd2019-03-07 20:47:46 +00003064 }else{
3065 assert( pMWin->eEnd==TK_FOLLOWING );
3066 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003067 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 1);
3068 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1);
dan54975cd2019-03-07 20:47:46 +00003069 }
danc8137502019-03-07 19:26:17 +00003070 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3071 sqlite3VdbeJumpHere(v, addrBreak2);
3072 addrStart = sqlite3VdbeCurrentAddr(v);
dan6c75b392019-03-08 20:02:52 +00003073 addrBreak3 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
danc8137502019-03-07 19:26:17 +00003074 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3075 sqlite3VdbeJumpHere(v, addrBreak1);
3076 sqlite3VdbeJumpHere(v, addrBreak3);
danb25a2142019-03-05 19:29:36 +00003077 }else{
dan00267b82019-03-06 21:04:11 +00003078 int addrBreak;
danc8137502019-03-07 19:26:17 +00003079 int addrStart;
dan6c75b392019-03-08 20:02:52 +00003080 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
danc8137502019-03-07 19:26:17 +00003081 addrStart = sqlite3VdbeCurrentAddr(v);
dan6c75b392019-03-08 20:02:52 +00003082 addrBreak = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
dane7579a52019-09-25 16:41:44 +00003083 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan00267b82019-03-06 21:04:11 +00003084 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3085 sqlite3VdbeJumpHere(v, addrBreak);
danb25a2142019-03-05 19:29:36 +00003086 }
danc8137502019-03-07 19:26:17 +00003087 sqlite3VdbeJumpHere(v, addrEmpty);
3088
dan6c75b392019-03-08 20:02:52 +00003089 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr);
dan680f6e82019-03-04 21:07:11 +00003090 if( pMWin->pPartition ){
dana0f6b832019-03-14 16:36:20 +00003091 if( pMWin->regStartRowid ){
3092 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid);
3093 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid);
3094 }
dan680f6e82019-03-04 21:07:11 +00003095 sqlite3VdbeChangeP1(v, addrInteger, sqlite3VdbeCurrentAddr(v));
3096 sqlite3VdbeAddOp1(v, OP_Return, regFlushPart);
3097 }
3098}
3099
dan67a9b8e2018-06-22 20:51:35 +00003100#endif /* SQLITE_OMIT_WINDOWFUNC */