blob: d0ef81ae59d5bf154955112291a2f1a51f8d4061 [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;
drh5e121a52022-03-10 16:26:00 +0000960 if( p->pWin
961 && p->pPrior==0
962 && ALWAYS((p->selFlags & SF_WinRewrite)==0)
drhfde30432022-03-10 21:04:49 +0000963 && ALWAYS(!IN_RENAME_OBJECT)
drh5e121a52022-03-10 16:26:00 +0000964 ){
dandfa552f2018-06-02 21:04:28 +0000965 Vdbe *v = sqlite3GetVdbe(pParse);
dandfa552f2018-06-02 21:04:28 +0000966 sqlite3 *db = pParse->db;
967 Select *pSub = 0; /* The subquery */
968 SrcList *pSrc = p->pSrc;
969 Expr *pWhere = p->pWhere;
970 ExprList *pGroupBy = p->pGroupBy;
971 Expr *pHaving = p->pHaving;
972 ExprList *pSort = 0;
973
974 ExprList *pSublist = 0; /* Expression list for sub-query */
drh067b92b2020-06-19 15:24:12 +0000975 Window *pMWin = p->pWin; /* Main window object */
dandfa552f2018-06-02 21:04:28 +0000976 Window *pWin; /* Window object iterator */
dan62742fd2019-07-08 12:01:39 +0000977 Table *pTab;
drh89636622020-06-07 17:33:18 +0000978 Walker w;
979
dan553948e2020-03-16 18:52:53 +0000980 u32 selFlags = p->selFlags;
dan62742fd2019-07-08 12:01:39 +0000981
982 pTab = sqlite3DbMallocZero(db, sizeof(Table));
983 if( pTab==0 ){
drh86541862019-12-19 20:37:32 +0000984 return sqlite3ErrorToParser(db, SQLITE_NOMEM);
dan62742fd2019-07-08 12:01:39 +0000985 }
drh89636622020-06-07 17:33:18 +0000986 sqlite3AggInfoPersistWalkerInit(&w, pParse);
987 sqlite3WalkSelect(&w, p);
drh4752bbd2021-05-07 15:46:36 +0000988 if( (p->selFlags & SF_Aggregate)==0 ){
989 w.xExprCallback = disallowAggregatesInOrderByCb;
dan3d691fd2021-05-19 14:49:51 +0000990 w.xSelectCallback = 0;
drh4752bbd2021-05-07 15:46:36 +0000991 sqlite3WalkExprList(&w, p->pOrderBy);
992 }
dandfa552f2018-06-02 21:04:28 +0000993
994 p->pSrc = 0;
995 p->pWhere = 0;
996 p->pGroupBy = 0;
997 p->pHaving = 0;
dan62742fd2019-07-08 12:01:39 +0000998 p->selFlags &= ~SF_Aggregate;
drhba016342019-11-14 13:24:04 +0000999 p->selFlags |= SF_WinRewrite;
dandfa552f2018-06-02 21:04:28 +00001000
danf02cdd32018-06-27 19:48:50 +00001001 /* Create the ORDER BY clause for the sub-select. This is the concatenation
1002 ** of the window PARTITION and ORDER BY clauses. Then, if this makes it
1003 ** redundant, remove the ORDER BY from the parent SELECT. */
dand8d2fb92019-12-27 15:31:47 +00001004 pSort = exprListAppendList(pParse, 0, pMWin->pPartition, 1);
dan08f6de72019-05-10 14:26:32 +00001005 pSort = exprListAppendList(pParse, pSort, pMWin->pOrderBy, 1);
dan0e3c50c2019-08-07 17:45:37 +00001006 if( pSort && p->pOrderBy && p->pOrderBy->nExpr<=pSort->nExpr ){
1007 int nSave = pSort->nExpr;
1008 pSort->nExpr = p->pOrderBy->nExpr;
danf02cdd32018-06-27 19:48:50 +00001009 if( sqlite3ExprListCompare(pSort, p->pOrderBy, -1)==0 ){
1010 sqlite3ExprListDelete(db, p->pOrderBy);
1011 p->pOrderBy = 0;
1012 }
dan0e3c50c2019-08-07 17:45:37 +00001013 pSort->nExpr = nSave;
danf02cdd32018-06-27 19:48:50 +00001014 }
1015
dandfa552f2018-06-02 21:04:28 +00001016 /* Assign a cursor number for the ephemeral table used to buffer rows.
1017 ** The OpenEphemeral instruction is coded later, after it is known how
1018 ** many columns the table will have. */
1019 pMWin->iEphCsr = pParse->nTab++;
dan680f6e82019-03-04 21:07:11 +00001020 pParse->nTab += 3;
dandfa552f2018-06-02 21:04:28 +00001021
dan62742fd2019-07-08 12:01:39 +00001022 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pEList, pTab, &pSublist);
1023 selectWindowRewriteEList(pParse, pMWin, pSrc, p->pOrderBy, pTab, &pSublist);
dandfa552f2018-06-02 21:04:28 +00001024 pMWin->nBufferCol = (pSublist ? pSublist->nExpr : 0);
1025
danf02cdd32018-06-27 19:48:50 +00001026 /* Append the PARTITION BY and ORDER BY expressions to the to the
1027 ** sub-select expression list. They are required to figure out where
1028 ** boundaries for partitions and sets of peer rows lie. */
dan08f6de72019-05-10 14:26:32 +00001029 pSublist = exprListAppendList(pParse, pSublist, pMWin->pPartition, 0);
1030 pSublist = exprListAppendList(pParse, pSublist, pMWin->pOrderBy, 0);
dandfa552f2018-06-02 21:04:28 +00001031
1032 /* Append the arguments passed to each window function to the
1033 ** sub-select expression list. Also allocate two registers for each
1034 ** window function - one for the accumulator, another for interim
1035 ** results. */
1036 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drha4eeccd2021-10-07 17:43:30 +00001037 ExprList *pArgs;
1038 assert( ExprUseXList(pWin->pOwner) );
drh5e121a52022-03-10 16:26:00 +00001039 assert( pWin->pWFunc!=0 );
drha4eeccd2021-10-07 17:43:30 +00001040 pArgs = pWin->pOwner->x.pList;
drh105dcaa2022-03-10 16:01:14 +00001041 if( pWin->pWFunc->funcFlags & SQLITE_FUNC_SUBTYPE ){
dane2ba6df2019-09-07 18:20:43 +00001042 selectWindowRewriteEList(pParse, pMWin, pSrc, pArgs, pTab, &pSublist);
1043 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0);
1044 pWin->bExprArgs = 1;
1045 }else{
1046 pWin->iArgCol = (pSublist ? pSublist->nExpr : 0);
1047 pSublist = exprListAppendList(pParse, pSublist, pArgs, 0);
1048 }
dan8b985602018-06-09 17:43:45 +00001049 if( pWin->pFilter ){
1050 Expr *pFilter = sqlite3ExprDup(db, pWin->pFilter, 0);
1051 pSublist = sqlite3ExprListAppend(pParse, pSublist, pFilter);
1052 }
dandfa552f2018-06-02 21:04:28 +00001053 pWin->regAccum = ++pParse->nMem;
1054 pWin->regResult = ++pParse->nMem;
1055 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
1056 }
1057
dan9c277582018-06-20 09:23:49 +00001058 /* If there is no ORDER BY or PARTITION BY clause, and the window
1059 ** function accepts zero arguments, and there are no other columns
1060 ** selected (e.g. "SELECT row_number() OVER () FROM t1"), it is possible
1061 ** that pSublist is still NULL here. Add a constant expression here to
1062 ** keep everything legal in this case.
1063 */
1064 if( pSublist==0 ){
1065 pSublist = sqlite3ExprListAppend(pParse, 0,
drh5776ee52019-09-23 12:38:10 +00001066 sqlite3Expr(db, TK_INTEGER, "0")
dan9c277582018-06-20 09:23:49 +00001067 );
1068 }
1069
dandfa552f2018-06-02 21:04:28 +00001070 pSub = sqlite3SelectNew(
1071 pParse, pSublist, pSrc, pWhere, pGroupBy, pHaving, pSort, 0, 0
1072 );
drh9216de82020-06-11 00:57:09 +00001073 SELECTTRACE(1,pParse,pSub,
1074 ("New window-function subquery in FROM clause of (%u/%p)\n",
1075 p->selId, p));
drh29c992c2019-01-17 15:40:41 +00001076 p->pSrc = sqlite3SrcListAppend(pParse, 0, 0, 0);
drh82456a62021-09-13 18:16:15 +00001077 assert( pSub!=0 || p->pSrc==0 ); /* Due to db->mallocFailed test inside
1078 ** of sqlite3DbMallocRawNN() called from
1079 ** sqlite3SrcListAppend() */
dandfa552f2018-06-02 21:04:28 +00001080 if( p->pSrc ){
dan62742fd2019-07-08 12:01:39 +00001081 Table *pTab2;
dandfa552f2018-06-02 21:04:28 +00001082 p->pSrc->a[0].pSelect = pSub;
1083 sqlite3SrcListAssignCursors(pParse, p->pSrc);
drhbb301232021-07-15 19:29:43 +00001084 pSub->selFlags |= SF_Expanded|SF_OrderByReqd;
drh96fb16e2019-08-06 14:37:24 +00001085 pTab2 = sqlite3ResultSetOfSelect(pParse, pSub, SQLITE_AFF_NONE);
dan553948e2020-03-16 18:52:53 +00001086 pSub->selFlags |= (selFlags & SF_Aggregate);
dan62742fd2019-07-08 12:01:39 +00001087 if( pTab2==0 ){
drha9ebfe22019-12-25 23:54:21 +00001088 /* Might actually be some other kind of error, but in that case
1089 ** pParse->nErr will be set, so if SQLITE_NOMEM is set, we will get
1090 ** the correct error message regardless. */
dandfa552f2018-06-02 21:04:28 +00001091 rc = SQLITE_NOMEM;
1092 }else{
dan62742fd2019-07-08 12:01:39 +00001093 memcpy(pTab, pTab2, sizeof(Table));
1094 pTab->tabFlags |= TF_Ephemeral;
1095 p->pSrc->a[0].pTab = pTab;
1096 pTab = pTab2;
drhc37577b2020-05-24 03:38:37 +00001097 memset(&w, 0, sizeof(w));
1098 w.xExprCallback = sqlite3WindowExtraAggFuncDepth;
1099 w.xSelectCallback = sqlite3WalkerDepthIncrease;
1100 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
1101 sqlite3WalkSelect(&w, pSub);
dandfa552f2018-06-02 21:04:28 +00001102 }
dan6fde1792018-06-15 19:01:35 +00001103 }else{
1104 sqlite3SelectDelete(db, pSub);
1105 }
1106 if( db->mallocFailed ) rc = SQLITE_NOMEM;
drh6d64b4a2021-11-07 23:33:01 +00001107
1108 /* Defer deleting the temporary table pTab because if an error occurred,
1109 ** there could still be references to that table embedded in the
1110 ** result-set or ORDER BY clause of the SELECT statement p. */
1111 sqlite3ParserAddCleanup(pParse, sqlite3DbFree, pTab);
dandfa552f2018-06-02 21:04:28 +00001112 }
1113
drh1da88b52022-01-24 19:38:56 +00001114 assert( rc==SQLITE_OK || pParse->nErr!=0 );
dandfa552f2018-06-02 21:04:28 +00001115 return rc;
1116}
1117
danc0bb4452018-06-12 20:53:38 +00001118/*
drhe2094572019-07-22 19:01:38 +00001119** Unlink the Window object from the Select to which it is attached,
1120** if it is attached.
1121*/
1122void sqlite3WindowUnlinkFromSelect(Window *p){
1123 if( p->ppThis ){
1124 *p->ppThis = p->pNextWin;
1125 if( p->pNextWin ) p->pNextWin->ppThis = p->ppThis;
1126 p->ppThis = 0;
1127 }
1128}
1129
1130/*
danc0bb4452018-06-12 20:53:38 +00001131** Free the Window object passed as the second argument.
1132*/
dan86fb6e12018-05-16 20:58:07 +00001133void sqlite3WindowDelete(sqlite3 *db, Window *p){
1134 if( p ){
drhe2094572019-07-22 19:01:38 +00001135 sqlite3WindowUnlinkFromSelect(p);
dan86fb6e12018-05-16 20:58:07 +00001136 sqlite3ExprDelete(db, p->pFilter);
1137 sqlite3ExprListDelete(db, p->pPartition);
1138 sqlite3ExprListDelete(db, p->pOrderBy);
1139 sqlite3ExprDelete(db, p->pEnd);
1140 sqlite3ExprDelete(db, p->pStart);
dane3bf6322018-06-08 20:58:27 +00001141 sqlite3DbFree(db, p->zName);
dane7c9ca42019-02-16 17:27:51 +00001142 sqlite3DbFree(db, p->zBase);
dan86fb6e12018-05-16 20:58:07 +00001143 sqlite3DbFree(db, p);
1144 }
1145}
1146
danc0bb4452018-06-12 20:53:38 +00001147/*
1148** Free the linked list of Window objects starting at the second argument.
1149*/
dane3bf6322018-06-08 20:58:27 +00001150void sqlite3WindowListDelete(sqlite3 *db, Window *p){
1151 while( p ){
1152 Window *pNext = p->pNextWin;
1153 sqlite3WindowDelete(db, p);
1154 p = pNext;
1155 }
1156}
1157
danc0bb4452018-06-12 20:53:38 +00001158/*
drhe4984a22018-07-06 17:19:20 +00001159** The argument expression is an PRECEDING or FOLLOWING offset. The
1160** value should be a non-negative integer. If the value is not a
1161** constant, change it to NULL. The fact that it is then a non-negative
1162** integer will be caught later. But it is important not to leave
1163** variable values in the expression tree.
1164*/
1165static Expr *sqlite3WindowOffsetExpr(Parse *pParse, Expr *pExpr){
1166 if( 0==sqlite3ExprIsConstant(pExpr) ){
danfb8ac322019-01-16 12:05:22 +00001167 if( IN_RENAME_OBJECT ) sqlite3RenameExprUnmap(pParse, pExpr);
drhe4984a22018-07-06 17:19:20 +00001168 sqlite3ExprDelete(pParse->db, pExpr);
1169 pExpr = sqlite3ExprAlloc(pParse->db, TK_NULL, 0, 0);
1170 }
1171 return pExpr;
1172}
1173
1174/*
1175** Allocate and return a new Window object describing a Window Definition.
danc0bb4452018-06-12 20:53:38 +00001176*/
dan86fb6e12018-05-16 20:58:07 +00001177Window *sqlite3WindowAlloc(
drhe4984a22018-07-06 17:19:20 +00001178 Parse *pParse, /* Parsing context */
drhfc15f4c2019-03-28 13:03:41 +00001179 int eType, /* Frame type. TK_RANGE, TK_ROWS, TK_GROUPS, or 0 */
drhe4984a22018-07-06 17:19:20 +00001180 int eStart, /* Start type: CURRENT, PRECEDING, FOLLOWING, UNBOUNDED */
1181 Expr *pStart, /* Start window size if TK_PRECEDING or FOLLOWING */
1182 int eEnd, /* End type: CURRENT, FOLLOWING, TK_UNBOUNDED, PRECEDING */
dand35300f2019-03-14 20:53:21 +00001183 Expr *pEnd, /* End window size if TK_FOLLOWING or PRECEDING */
1184 u8 eExclude /* EXCLUDE clause */
dan86fb6e12018-05-16 20:58:07 +00001185){
dan7a606e12018-07-05 18:34:53 +00001186 Window *pWin = 0;
dane7c9ca42019-02-16 17:27:51 +00001187 int bImplicitFrame = 0;
dan7a606e12018-07-05 18:34:53 +00001188
drhe4984a22018-07-06 17:19:20 +00001189 /* Parser assures the following: */
dan6c75b392019-03-08 20:02:52 +00001190 assert( eType==0 || eType==TK_RANGE || eType==TK_ROWS || eType==TK_GROUPS );
drhe4984a22018-07-06 17:19:20 +00001191 assert( eStart==TK_CURRENT || eStart==TK_PRECEDING
1192 || eStart==TK_UNBOUNDED || eStart==TK_FOLLOWING );
1193 assert( eEnd==TK_CURRENT || eEnd==TK_FOLLOWING
1194 || eEnd==TK_UNBOUNDED || eEnd==TK_PRECEDING );
1195 assert( (eStart==TK_PRECEDING || eStart==TK_FOLLOWING)==(pStart!=0) );
1196 assert( (eEnd==TK_FOLLOWING || eEnd==TK_PRECEDING)==(pEnd!=0) );
1197
dane7c9ca42019-02-16 17:27:51 +00001198 if( eType==0 ){
1199 bImplicitFrame = 1;
1200 eType = TK_RANGE;
1201 }
drhe4984a22018-07-06 17:19:20 +00001202
drhe4984a22018-07-06 17:19:20 +00001203 /* Additionally, the
dan5d764ac2018-07-06 14:15:49 +00001204 ** starting boundary type may not occur earlier in the following list than
1205 ** the ending boundary type:
1206 **
1207 ** UNBOUNDED PRECEDING
1208 ** <expr> PRECEDING
1209 ** CURRENT ROW
1210 ** <expr> FOLLOWING
1211 ** UNBOUNDED FOLLOWING
1212 **
1213 ** The parser ensures that "UNBOUNDED PRECEDING" cannot be used as an ending
1214 ** boundary, and than "UNBOUNDED FOLLOWING" cannot be used as a starting
1215 ** frame boundary.
1216 */
drhe4984a22018-07-06 17:19:20 +00001217 if( (eStart==TK_CURRENT && eEnd==TK_PRECEDING)
dan5d764ac2018-07-06 14:15:49 +00001218 || (eStart==TK_FOLLOWING && (eEnd==TK_PRECEDING || eEnd==TK_CURRENT))
1219 ){
dan72b9fdc2019-03-09 20:49:17 +00001220 sqlite3ErrorMsg(pParse, "unsupported frame specification");
drhe4984a22018-07-06 17:19:20 +00001221 goto windowAllocErr;
dan7a606e12018-07-05 18:34:53 +00001222 }
dan86fb6e12018-05-16 20:58:07 +00001223
drhe4984a22018-07-06 17:19:20 +00001224 pWin = (Window*)sqlite3DbMallocZero(pParse->db, sizeof(Window));
1225 if( pWin==0 ) goto windowAllocErr;
drhfc15f4c2019-03-28 13:03:41 +00001226 pWin->eFrmType = eType;
drhe4984a22018-07-06 17:19:20 +00001227 pWin->eStart = eStart;
1228 pWin->eEnd = eEnd;
drh94809082019-04-02 17:45:56 +00001229 if( eExclude==0 && OptimizationDisabled(pParse->db, SQLITE_WindowFunc) ){
dan108e6b22019-03-18 18:55:35 +00001230 eExclude = TK_NO;
1231 }
dand35300f2019-03-14 20:53:21 +00001232 pWin->eExclude = eExclude;
dane7c9ca42019-02-16 17:27:51 +00001233 pWin->bImplicitFrame = bImplicitFrame;
drhe4984a22018-07-06 17:19:20 +00001234 pWin->pEnd = sqlite3WindowOffsetExpr(pParse, pEnd);
1235 pWin->pStart = sqlite3WindowOffsetExpr(pParse, pStart);
dan86fb6e12018-05-16 20:58:07 +00001236 return pWin;
drhe4984a22018-07-06 17:19:20 +00001237
1238windowAllocErr:
1239 sqlite3ExprDelete(pParse->db, pEnd);
1240 sqlite3ExprDelete(pParse->db, pStart);
1241 return 0;
dan86fb6e12018-05-16 20:58:07 +00001242}
1243
danc0bb4452018-06-12 20:53:38 +00001244/*
dane7c9ca42019-02-16 17:27:51 +00001245** Attach PARTITION and ORDER BY clauses pPartition and pOrderBy to window
1246** pWin. Also, if parameter pBase is not NULL, set pWin->zBase to the
1247** equivalent nul-terminated string.
1248*/
1249Window *sqlite3WindowAssemble(
1250 Parse *pParse,
1251 Window *pWin,
1252 ExprList *pPartition,
1253 ExprList *pOrderBy,
1254 Token *pBase
1255){
1256 if( pWin ){
1257 pWin->pPartition = pPartition;
1258 pWin->pOrderBy = pOrderBy;
1259 if( pBase ){
1260 pWin->zBase = sqlite3DbStrNDup(pParse->db, pBase->z, pBase->n);
1261 }
1262 }else{
1263 sqlite3ExprListDelete(pParse->db, pPartition);
1264 sqlite3ExprListDelete(pParse->db, pOrderBy);
1265 }
1266 return pWin;
1267}
1268
1269/*
1270** Window *pWin has just been created from a WINDOW clause. Tokne pBase
1271** is the base window. Earlier windows from the same WINDOW clause are
1272** stored in the linked list starting at pWin->pNextWin. This function
1273** either updates *pWin according to the base specification, or else
1274** leaves an error in pParse.
1275*/
1276void sqlite3WindowChain(Parse *pParse, Window *pWin, Window *pList){
1277 if( pWin->zBase ){
1278 sqlite3 *db = pParse->db;
1279 Window *pExist = windowFind(pParse, pList, pWin->zBase);
1280 if( pExist ){
1281 const char *zErr = 0;
1282 /* Check for errors */
1283 if( pWin->pPartition ){
1284 zErr = "PARTITION clause";
1285 }else if( pExist->pOrderBy && pWin->pOrderBy ){
1286 zErr = "ORDER BY clause";
1287 }else if( pExist->bImplicitFrame==0 ){
1288 zErr = "frame specification";
1289 }
1290 if( zErr ){
1291 sqlite3ErrorMsg(pParse,
1292 "cannot override %s of window: %s", zErr, pWin->zBase
1293 );
1294 }else{
1295 pWin->pPartition = sqlite3ExprListDup(db, pExist->pPartition, 0);
1296 if( pExist->pOrderBy ){
1297 assert( pWin->pOrderBy==0 );
1298 pWin->pOrderBy = sqlite3ExprListDup(db, pExist->pOrderBy, 0);
1299 }
1300 sqlite3DbFree(db, pWin->zBase);
1301 pWin->zBase = 0;
1302 }
1303 }
1304 }
1305}
1306
1307/*
danc0bb4452018-06-12 20:53:38 +00001308** Attach window object pWin to expression p.
1309*/
dan4f9adee2019-07-13 16:22:50 +00001310void sqlite3WindowAttach(Parse *pParse, Expr *p, Window *pWin){
dan86fb6e12018-05-16 20:58:07 +00001311 if( p ){
drheda079c2018-09-20 19:02:15 +00001312 assert( p->op==TK_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00001313 assert( pWin );
1314 p->y.pWin = pWin;
1315 ExprSetProperty(p, EP_WinFunc);
1316 pWin->pOwner = p;
1317 if( (p->flags & EP_Distinct) && pWin->eFrmType!=TK_FILTER ){
1318 sqlite3ErrorMsg(pParse,
1319 "DISTINCT is not supported for window functions"
1320 );
dane33f6e72018-07-06 07:42:42 +00001321 }
dan86fb6e12018-05-16 20:58:07 +00001322 }else{
1323 sqlite3WindowDelete(pParse->db, pWin);
1324 }
1325}
dane2f781b2018-05-17 19:24:08 +00001326
1327/*
dana3fcc002019-08-15 13:53:22 +00001328** Possibly link window pWin into the list at pSel->pWin (window functions
1329** to be processed as part of SELECT statement pSel). The window is linked
1330** in if either (a) there are no other windows already linked to this
1331** SELECT, or (b) the windows already linked use a compatible window frame.
1332*/
1333void sqlite3WindowLink(Select *pSel, Window *pWin){
dan903fdd42021-02-22 20:56:13 +00001334 if( pSel ){
1335 if( 0==pSel->pWin || 0==sqlite3WindowCompare(0, pSel->pWin, pWin, 0) ){
1336 pWin->pNextWin = pSel->pWin;
1337 if( pSel->pWin ){
1338 pSel->pWin->ppThis = &pWin->pNextWin;
1339 }
1340 pSel->pWin = pWin;
1341 pWin->ppThis = &pSel->pWin;
1342 }else{
1343 if( sqlite3ExprListCompare(pWin->pPartition, pSel->pWin->pPartition,-1) ){
1344 pSel->selFlags |= SF_MultiPart;
1345 }
dana3fcc002019-08-15 13:53:22 +00001346 }
dana3fcc002019-08-15 13:53:22 +00001347 }
1348}
1349
1350/*
danfbb6e9f2020-01-09 20:11:29 +00001351** Return 0 if the two window objects are identical, 1 if they are
1352** different, or 2 if it cannot be determined if the objects are identical
1353** or not. Identical window objects can be processed in a single scan.
dane2f781b2018-05-17 19:24:08 +00001354*/
drh1580d502021-09-25 17:07:57 +00001355int sqlite3WindowCompare(
1356 const Parse *pParse,
1357 const Window *p1,
1358 const Window *p2,
1359 int bFilter
1360){
danfbb6e9f2020-01-09 20:11:29 +00001361 int res;
drha2f142d2019-11-23 16:34:40 +00001362 if( NEVER(p1==0) || NEVER(p2==0) ) return 1;
drhfc15f4c2019-03-28 13:03:41 +00001363 if( p1->eFrmType!=p2->eFrmType ) return 1;
dane2f781b2018-05-17 19:24:08 +00001364 if( p1->eStart!=p2->eStart ) return 1;
1365 if( p1->eEnd!=p2->eEnd ) return 1;
dana0f6b832019-03-14 16:36:20 +00001366 if( p1->eExclude!=p2->eExclude ) return 1;
dane2f781b2018-05-17 19:24:08 +00001367 if( sqlite3ExprCompare(pParse, p1->pStart, p2->pStart, -1) ) return 1;
1368 if( sqlite3ExprCompare(pParse, p1->pEnd, p2->pEnd, -1) ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00001369 if( (res = sqlite3ExprListCompare(p1->pPartition, p2->pPartition, -1)) ){
1370 return res;
1371 }
1372 if( (res = sqlite3ExprListCompare(p1->pOrderBy, p2->pOrderBy, -1)) ){
1373 return res;
1374 }
dan4f9adee2019-07-13 16:22:50 +00001375 if( bFilter ){
danfbb6e9f2020-01-09 20:11:29 +00001376 if( (res = sqlite3ExprCompare(pParse, p1->pFilter, p2->pFilter, -1)) ){
1377 return res;
1378 }
dan4f9adee2019-07-13 16:22:50 +00001379 }
dane2f781b2018-05-17 19:24:08 +00001380 return 0;
1381}
1382
dan13078ca2018-06-13 20:29:38 +00001383
1384/*
1385** This is called by code in select.c before it calls sqlite3WhereBegin()
1386** to begin iterating through the sub-query results. It is used to allocate
1387** and initialize registers and cursors used by sqlite3WindowCodeStep().
1388*/
dan4ea562e2020-01-01 20:17:15 +00001389void sqlite3WindowCodeInit(Parse *pParse, Select *pSelect){
1390 int nEphExpr = pSelect->pSrc->a[0].pSelect->pEList->nExpr;
1391 Window *pMWin = pSelect->pWin;
danc9a86682018-05-30 20:44:58 +00001392 Window *pWin;
dan13078ca2018-06-13 20:29:38 +00001393 Vdbe *v = sqlite3GetVdbe(pParse);
danb6f2dea2019-03-13 17:20:27 +00001394
dan4ea562e2020-01-01 20:17:15 +00001395 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pMWin->iEphCsr, nEphExpr);
1396 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+1, pMWin->iEphCsr);
1397 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+2, pMWin->iEphCsr);
1398 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->iEphCsr+3, pMWin->iEphCsr);
1399
danb6f2dea2019-03-13 17:20:27 +00001400 /* Allocate registers to use for PARTITION BY values, if any. Initialize
1401 ** said registers to NULL. */
1402 if( pMWin->pPartition ){
1403 int nExpr = pMWin->pPartition->nExpr;
dan13078ca2018-06-13 20:29:38 +00001404 pMWin->regPart = pParse->nMem+1;
danb6f2dea2019-03-13 17:20:27 +00001405 pParse->nMem += nExpr;
1406 sqlite3VdbeAddOp3(v, OP_Null, 0, pMWin->regPart, pMWin->regPart+nExpr-1);
dan13078ca2018-06-13 20:29:38 +00001407 }
1408
danbf845152019-03-16 10:15:24 +00001409 pMWin->regOne = ++pParse->nMem;
1410 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regOne);
dan680f6e82019-03-04 21:07:11 +00001411
dana0f6b832019-03-14 16:36:20 +00001412 if( pMWin->eExclude ){
1413 pMWin->regStartRowid = ++pParse->nMem;
1414 pMWin->regEndRowid = ++pParse->nMem;
1415 pMWin->csrApp = pParse->nTab++;
1416 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid);
1417 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid);
1418 sqlite3VdbeAddOp2(v, OP_OpenDup, pMWin->csrApp, pMWin->iEphCsr);
1419 return;
1420 }
1421
danc9a86682018-05-30 20:44:58 +00001422 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001423 FuncDef *p = pWin->pWFunc;
danec891fd2018-06-06 20:51:02 +00001424 if( (p->funcFlags & SQLITE_FUNC_MINMAX) && pWin->eStart!=TK_UNBOUNDED ){
dan9a947222018-06-14 19:06:36 +00001425 /* The inline versions of min() and max() require a single ephemeral
1426 ** table and 3 registers. The registers are used as follows:
1427 **
1428 ** regApp+0: slot to copy min()/max() argument to for MakeRecord
1429 ** regApp+1: integer value used to ensure keys are unique
1430 ** regApp+2: output of MakeRecord
1431 */
drha4eeccd2021-10-07 17:43:30 +00001432 ExprList *pList;
1433 KeyInfo *pKeyInfo;
1434 assert( ExprUseXList(pWin->pOwner) );
1435 pList = pWin->pOwner->x.pList;
1436 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pList, 0, 0);
danc9a86682018-05-30 20:44:58 +00001437 pWin->csrApp = pParse->nTab++;
1438 pWin->regApp = pParse->nMem+1;
1439 pParse->nMem += 3;
drh105dcaa2022-03-10 16:01:14 +00001440 if( pKeyInfo && pWin->pWFunc->zName[1]=='i' ){
dan6e118922019-08-12 16:36:38 +00001441 assert( pKeyInfo->aSortFlags[0]==0 );
1442 pKeyInfo->aSortFlags[0] = KEYINFO_ORDER_DESC;
danc9a86682018-05-30 20:44:58 +00001443 }
1444 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pWin->csrApp, 2);
1445 sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
1446 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
1447 }
drh19dc4d42018-07-08 01:02:26 +00001448 else if( p->zName==nth_valueName || p->zName==first_valueName ){
danec891fd2018-06-06 20:51:02 +00001449 /* Allocate two registers at pWin->regApp. These will be used to
1450 ** store the start and end index of the current frame. */
danec891fd2018-06-06 20:51:02 +00001451 pWin->regApp = pParse->nMem+1;
1452 pWin->csrApp = pParse->nTab++;
1453 pParse->nMem += 2;
danec891fd2018-06-06 20:51:02 +00001454 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr);
1455 }
drh19dc4d42018-07-08 01:02:26 +00001456 else if( p->zName==leadName || p->zName==lagName ){
danfe4e25a2018-06-07 20:08:59 +00001457 pWin->csrApp = pParse->nTab++;
1458 sqlite3VdbeAddOp2(v, OP_OpenDup, pWin->csrApp, pMWin->iEphCsr);
1459 }
danc9a86682018-05-30 20:44:58 +00001460 }
1461}
1462
danbb407272019-03-12 18:28:51 +00001463#define WINDOW_STARTING_INT 0
1464#define WINDOW_ENDING_INT 1
1465#define WINDOW_NTH_VALUE_INT 2
1466#define WINDOW_STARTING_NUM 3
1467#define WINDOW_ENDING_NUM 4
1468
dan13078ca2018-06-13 20:29:38 +00001469/*
dana1a7e112018-07-09 13:31:18 +00001470** A "PRECEDING <expr>" (eCond==0) or "FOLLOWING <expr>" (eCond==1) or the
1471** value of the second argument to nth_value() (eCond==2) has just been
1472** evaluated and the result left in register reg. This function generates VM
1473** code to check that the value is a non-negative integer and throws an
1474** exception if it is not.
dan13078ca2018-06-13 20:29:38 +00001475*/
danbb407272019-03-12 18:28:51 +00001476static void windowCheckValue(Parse *pParse, int reg, int eCond){
danc3a20c12018-05-23 20:55:37 +00001477 static const char *azErr[] = {
1478 "frame starting offset must be a non-negative integer",
dana1a7e112018-07-09 13:31:18 +00001479 "frame ending offset must be a non-negative integer",
danbb407272019-03-12 18:28:51 +00001480 "second argument to nth_value must be a positive integer",
1481 "frame starting offset must be a non-negative number",
1482 "frame ending offset must be a non-negative number",
danc3a20c12018-05-23 20:55:37 +00001483 };
danbb407272019-03-12 18:28:51 +00001484 static int aOp[] = { OP_Ge, OP_Ge, OP_Gt, OP_Ge, OP_Ge };
danc3a20c12018-05-23 20:55:37 +00001485 Vdbe *v = sqlite3GetVdbe(pParse);
dan13078ca2018-06-13 20:29:38 +00001486 int regZero = sqlite3GetTempReg(pParse);
danbb407272019-03-12 18:28:51 +00001487 assert( eCond>=0 && eCond<ArraySize(azErr) );
danc3a20c12018-05-23 20:55:37 +00001488 sqlite3VdbeAddOp2(v, OP_Integer, 0, regZero);
dane5166e02019-03-19 11:56:39 +00001489 if( eCond>=WINDOW_STARTING_NUM ){
1490 int regString = sqlite3GetTempReg(pParse);
1491 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC);
1492 sqlite3VdbeAddOp3(v, OP_Ge, regString, sqlite3VdbeCurrentAddr(v)+2, reg);
drh21826f42019-04-01 14:30:30 +00001493 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC|SQLITE_JUMPIFNULL);
drh6f883592019-03-30 20:37:04 +00001494 VdbeCoverage(v);
1495 assert( eCond==3 || eCond==4 );
1496 VdbeCoverageIf(v, eCond==3);
1497 VdbeCoverageIf(v, eCond==4);
dane5166e02019-03-19 11:56:39 +00001498 }else{
1499 sqlite3VdbeAddOp2(v, OP_MustBeInt, reg, sqlite3VdbeCurrentAddr(v)+2);
drh6f883592019-03-30 20:37:04 +00001500 VdbeCoverage(v);
1501 assert( eCond==0 || eCond==1 || eCond==2 );
1502 VdbeCoverageIf(v, eCond==0);
1503 VdbeCoverageIf(v, eCond==1);
1504 VdbeCoverageIf(v, eCond==2);
dane5166e02019-03-19 11:56:39 +00001505 }
dana1a7e112018-07-09 13:31:18 +00001506 sqlite3VdbeAddOp3(v, aOp[eCond], regZero, sqlite3VdbeCurrentAddr(v)+2, reg);
danb03786a2021-03-31 11:31:19 +00001507 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC);
drh21826f42019-04-01 14:30:30 +00001508 VdbeCoverageNeverNullIf(v, eCond==0); /* NULL case captured by */
1509 VdbeCoverageNeverNullIf(v, eCond==1); /* the OP_MustBeInt */
1510 VdbeCoverageNeverNullIf(v, eCond==2);
1511 VdbeCoverageNeverNullIf(v, eCond==3); /* NULL case caught by */
1512 VdbeCoverageNeverNullIf(v, eCond==4); /* the OP_Ge */
drh211a0852019-01-27 02:41:34 +00001513 sqlite3MayAbort(pParse);
danc3a20c12018-05-23 20:55:37 +00001514 sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_ERROR, OE_Abort);
dana1a7e112018-07-09 13:31:18 +00001515 sqlite3VdbeAppendP4(v, (void*)azErr[eCond], P4_STATIC);
dan13078ca2018-06-13 20:29:38 +00001516 sqlite3ReleaseTempReg(pParse, regZero);
danc3a20c12018-05-23 20:55:37 +00001517}
1518
dan13078ca2018-06-13 20:29:38 +00001519/*
1520** Return the number of arguments passed to the window-function associated
1521** with the object passed as the only argument to this function.
1522*/
dan2a11bb22018-06-11 20:50:25 +00001523static int windowArgCount(Window *pWin){
drha4eeccd2021-10-07 17:43:30 +00001524 const ExprList *pList;
1525 assert( ExprUseXList(pWin->pOwner) );
1526 pList = pWin->pOwner->x.pList;
dan2a11bb22018-06-11 20:50:25 +00001527 return (pList ? pList->nExpr : 0);
1528}
1529
danc782a812019-03-15 20:46:19 +00001530typedef struct WindowCodeArg WindowCodeArg;
1531typedef struct WindowCsrAndReg WindowCsrAndReg;
dan1cac1762019-08-30 17:28:55 +00001532
1533/*
1534** See comments above struct WindowCodeArg.
1535*/
danc782a812019-03-15 20:46:19 +00001536struct WindowCsrAndReg {
dan1cac1762019-08-30 17:28:55 +00001537 int csr; /* Cursor number */
1538 int reg; /* First in array of peer values */
danc782a812019-03-15 20:46:19 +00001539};
1540
dan1cac1762019-08-30 17:28:55 +00001541/*
1542** A single instance of this structure is allocated on the stack by
1543** sqlite3WindowCodeStep() and a pointer to it passed to the various helper
1544** routines. This is to reduce the number of arguments required by each
1545** helper function.
1546**
1547** regArg:
1548** Each window function requires an accumulator register (just as an
1549** ordinary aggregate function does). This variable is set to the first
1550** in an array of accumulator registers - one for each window function
1551** in the WindowCodeArg.pMWin list.
1552**
1553** eDelete:
1554** The window functions implementation sometimes caches the input rows
1555** that it processes in a temporary table. If it is not zero, this
1556** variable indicates when rows may be removed from the temp table (in
1557** order to reduce memory requirements - it would always be safe just
1558** to leave them there). Possible values for eDelete are:
1559**
1560** WINDOW_RETURN_ROW:
1561** An input row can be discarded after it is returned to the caller.
1562**
1563** WINDOW_AGGINVERSE:
1564** An input row can be discarded after the window functions xInverse()
1565** callbacks have been invoked in it.
1566**
1567** WINDOW_AGGSTEP:
1568** An input row can be discarded after the window functions xStep()
1569** callbacks have been invoked in it.
1570**
1571** start,current,end
1572** Consider a window-frame similar to the following:
1573**
1574** (ORDER BY a, b GROUPS BETWEEN 2 PRECEDING AND 2 FOLLOWING)
1575**
1576** The windows functions implmentation caches the input rows in a temp
1577** table, sorted by "a, b" (it actually populates the cache lazily, and
1578** aggressively removes rows once they are no longer required, but that's
1579** a mere detail). It keeps three cursors open on the temp table. One
1580** (current) that points to the next row to return to the query engine
1581** once its window function values have been calculated. Another (end)
1582** points to the next row to call the xStep() method of each window function
1583** on (so that it is 2 groups ahead of current). And a third (start) that
1584** points to the next row to call the xInverse() method of each window
1585** function on.
1586**
1587** Each cursor (start, current and end) consists of a VDBE cursor
1588** (WindowCsrAndReg.csr) and an array of registers (starting at
1589** WindowCodeArg.reg) that always contains a copy of the peer values
1590** read from the corresponding cursor.
1591**
1592** Depending on the window-frame in question, all three cursors may not
1593** be required. In this case both WindowCodeArg.csr and reg are set to
1594** 0.
1595*/
danc782a812019-03-15 20:46:19 +00001596struct WindowCodeArg {
dan1cac1762019-08-30 17:28:55 +00001597 Parse *pParse; /* Parse context */
1598 Window *pMWin; /* First in list of functions being processed */
1599 Vdbe *pVdbe; /* VDBE object */
1600 int addrGosub; /* OP_Gosub to this address to return one row */
1601 int regGosub; /* Register used with OP_Gosub(addrGosub) */
1602 int regArg; /* First in array of accumulator registers */
1603 int eDelete; /* See above */
drh113a33c2021-04-24 23:40:05 +00001604 int regRowid;
danc782a812019-03-15 20:46:19 +00001605
1606 WindowCsrAndReg start;
1607 WindowCsrAndReg current;
1608 WindowCsrAndReg end;
1609};
1610
1611/*
danc782a812019-03-15 20:46:19 +00001612** Generate VM code to read the window frames peer values from cursor csr into
1613** an array of registers starting at reg.
1614*/
1615static void windowReadPeerValues(
1616 WindowCodeArg *p,
1617 int csr,
1618 int reg
1619){
1620 Window *pMWin = p->pMWin;
1621 ExprList *pOrderBy = pMWin->pOrderBy;
1622 if( pOrderBy ){
1623 Vdbe *v = sqlite3GetVdbe(p->pParse);
1624 ExprList *pPart = pMWin->pPartition;
1625 int iColOff = pMWin->nBufferCol + (pPart ? pPart->nExpr : 0);
1626 int i;
1627 for(i=0; i<pOrderBy->nExpr; i++){
1628 sqlite3VdbeAddOp3(v, OP_Column, csr, iColOff+i, reg+i);
1629 }
1630 }
1631}
1632
dan13078ca2018-06-13 20:29:38 +00001633/*
dan37d296a2019-09-24 20:20:05 +00001634** Generate VM code to invoke either xStep() (if bInverse is 0) or
1635** xInverse (if bInverse is non-zero) for each window function in the
1636** linked list starting at pMWin. Or, for built-in window functions
1637** that do not use the standard function API, generate the required
1638** inline VM code.
1639**
1640** If argument csr is greater than or equal to 0, then argument reg is
1641** the first register in an array of registers guaranteed to be large
1642** enough to hold the array of arguments for each function. In this case
1643** the arguments are extracted from the current row of csr into the
1644** array of registers before invoking OP_AggStep or OP_AggInverse
1645**
1646** Or, if csr is less than zero, then the array of registers at reg is
1647** already populated with all columns from the current row of the sub-query.
1648**
1649** If argument regPartSize is non-zero, then it is a register containing the
1650** number of rows in the current partition.
1651*/
1652static void windowAggStep(
1653 WindowCodeArg *p,
1654 Window *pMWin, /* Linked list of window functions */
1655 int csr, /* Read arguments from this cursor */
1656 int bInverse, /* True to invoke xInverse instead of xStep */
1657 int reg /* Array of registers */
1658){
1659 Parse *pParse = p->pParse;
1660 Vdbe *v = sqlite3GetVdbe(pParse);
1661 Window *pWin;
1662 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001663 FuncDef *pFunc = pWin->pWFunc;
dan37d296a2019-09-24 20:20:05 +00001664 int regArg;
1665 int nArg = pWin->bExprArgs ? 0 : windowArgCount(pWin);
1666 int i;
1667
1668 assert( bInverse==0 || pWin->eStart!=TK_UNBOUNDED );
1669
drhc5b35ae2019-09-25 02:07:50 +00001670 /* All OVER clauses in the same window function aggregate step must
1671 ** be the same. */
danfbb6e9f2020-01-09 20:11:29 +00001672 assert( pWin==pMWin || sqlite3WindowCompare(pParse,pWin,pMWin,0)!=1 );
drhc5b35ae2019-09-25 02:07:50 +00001673
dan37d296a2019-09-24 20:20:05 +00001674 for(i=0; i<nArg; i++){
1675 if( i!=1 || pFunc->zName!=nth_valueName ){
1676 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+i, reg+i);
1677 }else{
1678 sqlite3VdbeAddOp3(v, OP_Column, pMWin->iEphCsr, pWin->iArgCol+i, reg+i);
1679 }
1680 }
1681 regArg = reg;
1682
1683 if( pMWin->regStartRowid==0
1684 && (pFunc->funcFlags & SQLITE_FUNC_MINMAX)
1685 && (pWin->eStart!=TK_UNBOUNDED)
1686 ){
1687 int addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regArg);
1688 VdbeCoverage(v);
1689 if( bInverse==0 ){
1690 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1, 1);
1691 sqlite3VdbeAddOp2(v, OP_SCopy, regArg, pWin->regApp);
1692 sqlite3VdbeAddOp3(v, OP_MakeRecord, pWin->regApp, 2, pWin->regApp+2);
1693 sqlite3VdbeAddOp2(v, OP_IdxInsert, pWin->csrApp, pWin->regApp+2);
1694 }else{
1695 sqlite3VdbeAddOp4Int(v, OP_SeekGE, pWin->csrApp, 0, regArg, 1);
1696 VdbeCoverageNeverTaken(v);
1697 sqlite3VdbeAddOp1(v, OP_Delete, pWin->csrApp);
1698 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
1699 }
1700 sqlite3VdbeJumpHere(v, addrIsNull);
1701 }else if( pWin->regApp ){
1702 assert( pFunc->zName==nth_valueName
1703 || pFunc->zName==first_valueName
1704 );
1705 assert( bInverse==0 || bInverse==1 );
1706 sqlite3VdbeAddOp2(v, OP_AddImm, pWin->regApp+1-bInverse, 1);
1707 }else if( pFunc->xSFunc!=noopStepFunc ){
1708 int addrIf = 0;
dan37d296a2019-09-24 20:20:05 +00001709 if( pWin->pFilter ){
1710 int regTmp;
drha4eeccd2021-10-07 17:43:30 +00001711 assert( ExprUseXList(pWin->pOwner) );
dan37d296a2019-09-24 20:20:05 +00001712 assert( pWin->bExprArgs || !nArg ||nArg==pWin->pOwner->x.pList->nExpr );
1713 assert( pWin->bExprArgs || nArg ||pWin->pOwner->x.pList==0 );
1714 regTmp = sqlite3GetTempReg(pParse);
1715 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol+nArg,regTmp);
1716 addrIf = sqlite3VdbeAddOp3(v, OP_IfNot, regTmp, 0, 1);
1717 VdbeCoverage(v);
1718 sqlite3ReleaseTempReg(pParse, regTmp);
1719 }
dan37d296a2019-09-24 20:20:05 +00001720
dan37d296a2019-09-24 20:20:05 +00001721 if( pWin->bExprArgs ){
dan5a9fd232021-04-06 18:40:27 +00001722 int iOp = sqlite3VdbeCurrentAddr(v);
1723 int iEnd;
dan37d296a2019-09-24 20:20:05 +00001724
drha4eeccd2021-10-07 17:43:30 +00001725 assert( ExprUseXList(pWin->pOwner) );
dan37d296a2019-09-24 20:20:05 +00001726 nArg = pWin->pOwner->x.pList->nExpr;
1727 regArg = sqlite3GetTempRange(pParse, nArg);
1728 sqlite3ExprCodeExprList(pParse, pWin->pOwner->x.pList, regArg, 0, 0);
1729
dan5a9fd232021-04-06 18:40:27 +00001730 for(iEnd=sqlite3VdbeCurrentAddr(v); iOp<iEnd; iOp++){
1731 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOp);
dan37d296a2019-09-24 20:20:05 +00001732 if( pOp->opcode==OP_Column && pOp->p1==pWin->iEphCsr ){
1733 pOp->p1 = csr;
1734 }
1735 }
1736 }
1737 if( pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
1738 CollSeq *pColl;
1739 assert( nArg>0 );
drha4eeccd2021-10-07 17:43:30 +00001740 assert( ExprUseXList(pWin->pOwner) );
dan37d296a2019-09-24 20:20:05 +00001741 pColl = sqlite3ExprNNCollSeq(pParse, pWin->pOwner->x.pList->a[0].pExpr);
1742 sqlite3VdbeAddOp4(v, OP_CollSeq, 0,0,0, (const char*)pColl, P4_COLLSEQ);
1743 }
1744 sqlite3VdbeAddOp3(v, bInverse? OP_AggInverse : OP_AggStep,
1745 bInverse, regArg, pWin->regAccum);
1746 sqlite3VdbeAppendP4(v, pFunc, P4_FUNCDEF);
1747 sqlite3VdbeChangeP5(v, (u8)nArg);
1748 if( pWin->bExprArgs ){
1749 sqlite3ReleaseTempRange(pParse, regArg, nArg);
1750 }
1751 if( addrIf ) sqlite3VdbeJumpHere(v, addrIf);
dan37d296a2019-09-24 20:20:05 +00001752 }
1753 }
1754}
1755
1756/*
1757** Values that may be passed as the second argument to windowCodeOp().
1758*/
1759#define WINDOW_RETURN_ROW 1
1760#define WINDOW_AGGINVERSE 2
1761#define WINDOW_AGGSTEP 3
1762
1763/*
dana0f6b832019-03-14 16:36:20 +00001764** Generate VM code to invoke either xValue() (bFin==0) or xFinalize()
1765** (bFin==1) for each window function in the linked list starting at
dan13078ca2018-06-13 20:29:38 +00001766** pMWin. Or, for built-in window-functions that do not use the standard
1767** API, generate the equivalent VM code.
1768*/
danc782a812019-03-15 20:46:19 +00001769static void windowAggFinal(WindowCodeArg *p, int bFin){
1770 Parse *pParse = p->pParse;
1771 Window *pMWin = p->pMWin;
dand6f784e2018-05-28 18:30:45 +00001772 Vdbe *v = sqlite3GetVdbe(pParse);
1773 Window *pWin;
1774
1775 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
dana0f6b832019-03-14 16:36:20 +00001776 if( pMWin->regStartRowid==0
drh105dcaa2022-03-10 16:01:14 +00001777 && (pWin->pWFunc->funcFlags & SQLITE_FUNC_MINMAX)
dana0f6b832019-03-14 16:36:20 +00001778 && (pWin->eStart!=TK_UNBOUNDED)
danec891fd2018-06-06 20:51:02 +00001779 ){
dand6f784e2018-05-28 18:30:45 +00001780 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
danc9a86682018-05-30 20:44:58 +00001781 sqlite3VdbeAddOp1(v, OP_Last, pWin->csrApp);
dan01e12292018-06-27 20:24:59 +00001782 VdbeCoverage(v);
danc9a86682018-05-30 20:44:58 +00001783 sqlite3VdbeAddOp3(v, OP_Column, pWin->csrApp, 0, pWin->regResult);
1784 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
danec891fd2018-06-06 20:51:02 +00001785 }else if( pWin->regApp ){
dana0f6b832019-03-14 16:36:20 +00001786 assert( pMWin->regStartRowid==0 );
dand6f784e2018-05-28 18:30:45 +00001787 }else{
dana0f6b832019-03-14 16:36:20 +00001788 int nArg = windowArgCount(pWin);
1789 if( bFin ){
1790 sqlite3VdbeAddOp2(v, OP_AggFinal, pWin->regAccum, nArg);
drh105dcaa2022-03-10 16:01:14 +00001791 sqlite3VdbeAppendP4(v, pWin->pWFunc, P4_FUNCDEF);
danc9a86682018-05-30 20:44:58 +00001792 sqlite3VdbeAddOp2(v, OP_Copy, pWin->regAccum, pWin->regResult);
dan8b985602018-06-09 17:43:45 +00001793 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
danc9a86682018-05-30 20:44:58 +00001794 }else{
dana0f6b832019-03-14 16:36:20 +00001795 sqlite3VdbeAddOp3(v, OP_AggValue,pWin->regAccum,nArg,pWin->regResult);
drh105dcaa2022-03-10 16:01:14 +00001796 sqlite3VdbeAppendP4(v, pWin->pWFunc, P4_FUNCDEF);
danc9a86682018-05-30 20:44:58 +00001797 }
dand6f784e2018-05-28 18:30:45 +00001798 }
1799 }
1800}
1801
dan0525b6f2019-03-18 21:19:40 +00001802/*
1803** Generate code to calculate the current values of all window functions in the
1804** p->pMWin list by doing a full scan of the current window frame. Store the
1805** results in the Window.regResult registers, ready to return the upper
1806** layer.
1807*/
danc782a812019-03-15 20:46:19 +00001808static void windowFullScan(WindowCodeArg *p){
1809 Window *pWin;
1810 Parse *pParse = p->pParse;
1811 Window *pMWin = p->pMWin;
1812 Vdbe *v = p->pVdbe;
1813
1814 int regCRowid = 0; /* Current rowid value */
1815 int regCPeer = 0; /* Current peer values */
1816 int regRowid = 0; /* AggStep rowid value */
1817 int regPeer = 0; /* AggStep peer values */
1818
1819 int nPeer;
1820 int lblNext;
1821 int lblBrk;
1822 int addrNext;
drh55f66b32019-07-16 19:44:32 +00001823 int csr;
danc782a812019-03-15 20:46:19 +00001824
dan37d296a2019-09-24 20:20:05 +00001825 VdbeModuleComment((v, "windowFullScan begin"));
1826
drh55f66b32019-07-16 19:44:32 +00001827 assert( pMWin!=0 );
1828 csr = pMWin->csrApp;
danc782a812019-03-15 20:46:19 +00001829 nPeer = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0);
1830
1831 lblNext = sqlite3VdbeMakeLabel(pParse);
1832 lblBrk = sqlite3VdbeMakeLabel(pParse);
1833
1834 regCRowid = sqlite3GetTempReg(pParse);
1835 regRowid = sqlite3GetTempReg(pParse);
1836 if( nPeer ){
1837 regCPeer = sqlite3GetTempRange(pParse, nPeer);
1838 regPeer = sqlite3GetTempRange(pParse, nPeer);
1839 }
1840
1841 sqlite3VdbeAddOp2(v, OP_Rowid, pMWin->iEphCsr, regCRowid);
1842 windowReadPeerValues(p, pMWin->iEphCsr, regCPeer);
1843
1844 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
1845 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
1846 }
1847
1848 sqlite3VdbeAddOp3(v, OP_SeekGE, csr, lblBrk, pMWin->regStartRowid);
dan1d4b25f2019-03-19 16:49:15 +00001849 VdbeCoverage(v);
danc782a812019-03-15 20:46:19 +00001850 addrNext = sqlite3VdbeCurrentAddr(v);
1851 sqlite3VdbeAddOp2(v, OP_Rowid, csr, regRowid);
1852 sqlite3VdbeAddOp3(v, OP_Gt, pMWin->regEndRowid, lblBrk, regRowid);
dan1d4b25f2019-03-19 16:49:15 +00001853 VdbeCoverageNeverNull(v);
dan108e6b22019-03-18 18:55:35 +00001854
danc782a812019-03-15 20:46:19 +00001855 if( pMWin->eExclude==TK_CURRENT ){
1856 sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, lblNext, regRowid);
drh83c5bb92019-04-01 15:55:38 +00001857 VdbeCoverageNeverNull(v);
danc782a812019-03-15 20:46:19 +00001858 }else if( pMWin->eExclude!=TK_NO ){
1859 int addr;
dan108e6b22019-03-18 18:55:35 +00001860 int addrEq = 0;
dan66033422019-03-19 19:19:53 +00001861 KeyInfo *pKeyInfo = 0;
dan108e6b22019-03-18 18:55:35 +00001862
dan66033422019-03-19 19:19:53 +00001863 if( pMWin->pOrderBy ){
1864 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pMWin->pOrderBy, 0, 0);
danc782a812019-03-15 20:46:19 +00001865 }
dan66033422019-03-19 19:19:53 +00001866 if( pMWin->eExclude==TK_TIES ){
1867 addrEq = sqlite3VdbeAddOp3(v, OP_Eq, regCRowid, 0, regRowid);
drh83c5bb92019-04-01 15:55:38 +00001868 VdbeCoverageNeverNull(v);
dan66033422019-03-19 19:19:53 +00001869 }
1870 if( pKeyInfo ){
1871 windowReadPeerValues(p, csr, regPeer);
1872 sqlite3VdbeAddOp3(v, OP_Compare, regPeer, regCPeer, nPeer);
1873 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
1874 addr = sqlite3VdbeCurrentAddr(v)+1;
1875 sqlite3VdbeAddOp3(v, OP_Jump, addr, lblNext, addr);
1876 VdbeCoverageEqNe(v);
1877 }else{
1878 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblNext);
1879 }
danc782a812019-03-15 20:46:19 +00001880 if( addrEq ) sqlite3VdbeJumpHere(v, addrEq);
1881 }
1882
dan37d296a2019-09-24 20:20:05 +00001883 windowAggStep(p, pMWin, csr, 0, p->regArg);
danc782a812019-03-15 20:46:19 +00001884
1885 sqlite3VdbeResolveLabel(v, lblNext);
1886 sqlite3VdbeAddOp2(v, OP_Next, csr, addrNext);
dan1d4b25f2019-03-19 16:49:15 +00001887 VdbeCoverage(v);
danc782a812019-03-15 20:46:19 +00001888 sqlite3VdbeJumpHere(v, addrNext-1);
1889 sqlite3VdbeJumpHere(v, addrNext+1);
1890 sqlite3ReleaseTempReg(pParse, regRowid);
1891 sqlite3ReleaseTempReg(pParse, regCRowid);
1892 if( nPeer ){
1893 sqlite3ReleaseTempRange(pParse, regPeer, nPeer);
1894 sqlite3ReleaseTempRange(pParse, regCPeer, nPeer);
1895 }
1896
1897 windowAggFinal(p, 1);
dan37d296a2019-09-24 20:20:05 +00001898 VdbeModuleComment((v, "windowFullScan end"));
danc782a812019-03-15 20:46:19 +00001899}
1900
dan13078ca2018-06-13 20:29:38 +00001901/*
dan13078ca2018-06-13 20:29:38 +00001902** Invoke the sub-routine at regGosub (generated by code in select.c) to
1903** return the current row of Window.iEphCsr. If all window functions are
1904** aggregate window functions that use the standard API, a single
1905** OP_Gosub instruction is all that this routine generates. Extra VM code
1906** for per-row processing is only generated for the following built-in window
1907** functions:
1908**
1909** nth_value()
1910** first_value()
1911** lag()
1912** lead()
1913*/
danc782a812019-03-15 20:46:19 +00001914static void windowReturnOneRow(WindowCodeArg *p){
1915 Window *pMWin = p->pMWin;
1916 Vdbe *v = p->pVdbe;
dan7095c002018-06-07 17:45:22 +00001917
danc782a812019-03-15 20:46:19 +00001918 if( pMWin->regStartRowid ){
1919 windowFullScan(p);
1920 }else{
1921 Parse *pParse = p->pParse;
1922 Window *pWin;
1923
1924 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001925 FuncDef *pFunc = pWin->pWFunc;
drha4eeccd2021-10-07 17:43:30 +00001926 assert( ExprUseXList(pWin->pOwner) );
danc782a812019-03-15 20:46:19 +00001927 if( pFunc->zName==nth_valueName
1928 || pFunc->zName==first_valueName
1929 ){
dana0f6b832019-03-14 16:36:20 +00001930 int csr = pWin->csrApp;
danc782a812019-03-15 20:46:19 +00001931 int lbl = sqlite3VdbeMakeLabel(pParse);
1932 int tmpReg = sqlite3GetTempReg(pParse);
1933 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
1934
1935 if( pFunc->zName==nth_valueName ){
1936 sqlite3VdbeAddOp3(v, OP_Column,pMWin->iEphCsr,pWin->iArgCol+1,tmpReg);
1937 windowCheckValue(pParse, tmpReg, 2);
1938 }else{
1939 sqlite3VdbeAddOp2(v, OP_Integer, 1, tmpReg);
1940 }
dana0f6b832019-03-14 16:36:20 +00001941 sqlite3VdbeAddOp3(v, OP_Add, tmpReg, pWin->regApp, tmpReg);
1942 sqlite3VdbeAddOp3(v, OP_Gt, pWin->regApp+1, lbl, tmpReg);
1943 VdbeCoverageNeverNull(v);
1944 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, 0, tmpReg);
1945 VdbeCoverageNeverTaken(v);
1946 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult);
danc782a812019-03-15 20:46:19 +00001947 sqlite3VdbeResolveLabel(v, lbl);
1948 sqlite3ReleaseTempReg(pParse, tmpReg);
dana0f6b832019-03-14 16:36:20 +00001949 }
danc782a812019-03-15 20:46:19 +00001950 else if( pFunc->zName==leadName || pFunc->zName==lagName ){
1951 int nArg = pWin->pOwner->x.pList->nExpr;
1952 int csr = pWin->csrApp;
1953 int lbl = sqlite3VdbeMakeLabel(pParse);
1954 int tmpReg = sqlite3GetTempReg(pParse);
1955 int iEph = pMWin->iEphCsr;
1956
1957 if( nArg<3 ){
1958 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regResult);
1959 }else{
1960 sqlite3VdbeAddOp3(v, OP_Column, iEph,pWin->iArgCol+2,pWin->regResult);
1961 }
1962 sqlite3VdbeAddOp2(v, OP_Rowid, iEph, tmpReg);
1963 if( nArg<2 ){
1964 int val = (pFunc->zName==leadName ? 1 : -1);
1965 sqlite3VdbeAddOp2(v, OP_AddImm, tmpReg, val);
1966 }else{
1967 int op = (pFunc->zName==leadName ? OP_Add : OP_Subtract);
1968 int tmpReg2 = sqlite3GetTempReg(pParse);
1969 sqlite3VdbeAddOp3(v, OP_Column, iEph, pWin->iArgCol+1, tmpReg2);
1970 sqlite3VdbeAddOp3(v, op, tmpReg2, tmpReg, tmpReg);
1971 sqlite3ReleaseTempReg(pParse, tmpReg2);
1972 }
1973
1974 sqlite3VdbeAddOp3(v, OP_SeekRowid, csr, lbl, tmpReg);
1975 VdbeCoverage(v);
1976 sqlite3VdbeAddOp3(v, OP_Column, csr, pWin->iArgCol, pWin->regResult);
1977 sqlite3VdbeResolveLabel(v, lbl);
1978 sqlite3ReleaseTempReg(pParse, tmpReg);
danfe4e25a2018-06-07 20:08:59 +00001979 }
danfe4e25a2018-06-07 20:08:59 +00001980 }
danec891fd2018-06-06 20:51:02 +00001981 }
danc782a812019-03-15 20:46:19 +00001982 sqlite3VdbeAddOp2(v, OP_Gosub, p->regGosub, p->addrGosub);
danec891fd2018-06-06 20:51:02 +00001983}
1984
dan13078ca2018-06-13 20:29:38 +00001985/*
dan54a9ab32018-06-14 14:27:05 +00001986** Generate code to set the accumulator register for each window function
1987** in the linked list passed as the second argument to NULL. And perform
1988** any equivalent initialization required by any built-in window functions
1989** in the list.
1990*/
dan2e605682018-06-07 15:54:26 +00001991static int windowInitAccum(Parse *pParse, Window *pMWin){
1992 Vdbe *v = sqlite3GetVdbe(pParse);
1993 int regArg;
1994 int nArg = 0;
1995 Window *pWin;
1996 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00001997 FuncDef *pFunc = pWin->pWFunc;
dan0a21ea92020-02-29 17:19:42 +00001998 assert( pWin->regAccum );
dan2e605682018-06-07 15:54:26 +00001999 sqlite3VdbeAddOp2(v, OP_Null, 0, pWin->regAccum);
dan2a11bb22018-06-11 20:50:25 +00002000 nArg = MAX(nArg, windowArgCount(pWin));
dan108e6b22019-03-18 18:55:35 +00002001 if( pMWin->regStartRowid==0 ){
dana0f6b832019-03-14 16:36:20 +00002002 if( pFunc->zName==nth_valueName || pFunc->zName==first_valueName ){
2003 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp);
2004 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
2005 }
dan9a947222018-06-14 19:06:36 +00002006
dana0f6b832019-03-14 16:36:20 +00002007 if( (pFunc->funcFlags & SQLITE_FUNC_MINMAX) && pWin->csrApp ){
2008 assert( pWin->eStart!=TK_UNBOUNDED );
2009 sqlite3VdbeAddOp1(v, OP_ResetSorter, pWin->csrApp);
2010 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWin->regApp+1);
2011 }
dan9a947222018-06-14 19:06:36 +00002012 }
dan2e605682018-06-07 15:54:26 +00002013 }
2014 regArg = pParse->nMem+1;
2015 pParse->nMem += nArg;
2016 return regArg;
2017}
2018
danb33487b2019-03-06 17:12:32 +00002019/*
dancc7a8502019-03-11 19:50:54 +00002020** Return true if the current frame should be cached in the ephemeral table,
2021** even if there are no xInverse() calls required.
danb33487b2019-03-06 17:12:32 +00002022*/
dancc7a8502019-03-11 19:50:54 +00002023static int windowCacheFrame(Window *pMWin){
danb33487b2019-03-06 17:12:32 +00002024 Window *pWin;
dana0f6b832019-03-14 16:36:20 +00002025 if( pMWin->regStartRowid ) return 1;
danb33487b2019-03-06 17:12:32 +00002026 for(pWin=pMWin; pWin; pWin=pWin->pNextWin){
drh105dcaa2022-03-10 16:01:14 +00002027 FuncDef *pFunc = pWin->pWFunc;
dancc7a8502019-03-11 19:50:54 +00002028 if( (pFunc->zName==nth_valueName)
danb33487b2019-03-06 17:12:32 +00002029 || (pFunc->zName==first_valueName)
danb560a712019-03-13 15:29:14 +00002030 || (pFunc->zName==leadName)
danb33487b2019-03-06 17:12:32 +00002031 || (pFunc->zName==lagName)
2032 ){
2033 return 1;
2034 }
2035 }
2036 return 0;
2037}
2038
dan6c75b392019-03-08 20:02:52 +00002039/*
2040** regOld and regNew are each the first register in an array of size
2041** pOrderBy->nExpr. This function generates code to compare the two
2042** arrays of registers using the collation sequences and other comparison
2043** parameters specified by pOrderBy.
2044**
2045** If the two arrays are not equal, the contents of regNew is copied to
2046** regOld and control falls through. Otherwise, if the contents of the arrays
2047** are equal, an OP_Goto is executed. The address of the OP_Goto is returned.
2048*/
dan935d9d82019-03-12 15:21:51 +00002049static void windowIfNewPeer(
dan6c75b392019-03-08 20:02:52 +00002050 Parse *pParse,
2051 ExprList *pOrderBy,
2052 int regNew, /* First in array of new values */
dan935d9d82019-03-12 15:21:51 +00002053 int regOld, /* First in array of old values */
2054 int addr /* Jump here */
dan6c75b392019-03-08 20:02:52 +00002055){
2056 Vdbe *v = sqlite3GetVdbe(pParse);
dan6c75b392019-03-08 20:02:52 +00002057 if( pOrderBy ){
2058 int nVal = pOrderBy->nExpr;
2059 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pOrderBy, 0, 0);
2060 sqlite3VdbeAddOp3(v, OP_Compare, regOld, regNew, nVal);
2061 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
dan935d9d82019-03-12 15:21:51 +00002062 sqlite3VdbeAddOp3(v, OP_Jump,
2063 sqlite3VdbeCurrentAddr(v)+1, addr, sqlite3VdbeCurrentAddr(v)+1
dan72b9fdc2019-03-09 20:49:17 +00002064 );
dan6c75b392019-03-08 20:02:52 +00002065 VdbeCoverageEqNe(v);
2066 sqlite3VdbeAddOp3(v, OP_Copy, regNew, regOld, nVal-1);
2067 }else{
dan935d9d82019-03-12 15:21:51 +00002068 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr);
dan6c75b392019-03-08 20:02:52 +00002069 }
dan6c75b392019-03-08 20:02:52 +00002070}
2071
dan72b9fdc2019-03-09 20:49:17 +00002072/*
2073** This function is called as part of generating VM programs for RANGE
dan1e7cb192019-03-16 20:29:54 +00002074** offset PRECEDING/FOLLOWING frame boundaries. Assuming "ASC" order for
dan8b47f522019-08-30 16:14:58 +00002075** the ORDER BY term in the window, and that argument op is OP_Ge, it generates
2076** code equivalent to:
dan72b9fdc2019-03-09 20:49:17 +00002077**
2078** if( csr1.peerVal + regVal >= csr2.peerVal ) goto lbl;
dan1e7cb192019-03-16 20:29:54 +00002079**
dan8b47f522019-08-30 16:14:58 +00002080** The value of parameter op may also be OP_Gt or OP_Le. In these cases the
2081** operator in the above pseudo-code is replaced with ">" or "<=", respectively.
2082**
2083** If the sort-order for the ORDER BY term in the window is DESC, then the
2084** comparison is reversed. Instead of adding regVal to csr1.peerVal, it is
2085** subtracted. And the comparison operator is inverted to - ">=" becomes "<=",
2086** ">" becomes "<", and so on. So, with DESC sort order, if the argument op
2087** is OP_Ge, the generated code is equivalent to:
2088**
2089** if( csr1.peerVal - regVal <= csr2.peerVal ) goto lbl;
2090**
2091** A special type of arithmetic is used such that if csr1.peerVal is not
dan6b6ec402021-04-05 19:05:18 +00002092** a numeric type (real or integer), then the result of the addition
dan8b47f522019-08-30 16:14:58 +00002093** or subtraction is a a copy of csr1.peerVal.
dan72b9fdc2019-03-09 20:49:17 +00002094*/
2095static void windowCodeRangeTest(
2096 WindowCodeArg *p,
dan1cac1762019-08-30 17:28:55 +00002097 int op, /* OP_Ge, OP_Gt, or OP_Le */
2098 int csr1, /* Cursor number for cursor 1 */
2099 int regVal, /* Register containing non-negative number */
2100 int csr2, /* Cursor number for cursor 2 */
2101 int lbl /* Jump destination if condition is true */
dan72b9fdc2019-03-09 20:49:17 +00002102){
2103 Parse *pParse = p->pParse;
2104 Vdbe *v = sqlite3GetVdbe(pParse);
dan1cac1762019-08-30 17:28:55 +00002105 ExprList *pOrderBy = p->pMWin->pOrderBy; /* ORDER BY clause for window */
2106 int reg1 = sqlite3GetTempReg(pParse); /* Reg. for csr1.peerVal+regVal */
2107 int reg2 = sqlite3GetTempReg(pParse); /* Reg. for csr2.peerVal */
2108 int regString = ++pParse->nMem; /* Reg. for constant value '' */
dan8b47f522019-08-30 16:14:58 +00002109 int arith = OP_Add; /* OP_Add or OP_Subtract */
2110 int addrGe; /* Jump destination */
dan6b6ec402021-04-05 19:05:18 +00002111 int addrDone = sqlite3VdbeMakeLabel(pParse); /* Address past OP_Ge */
dan7f8653a2021-03-06 14:46:24 +00002112 CollSeq *pColl;
dan71fddaf2019-03-11 11:12:34 +00002113
dan6b6ec402021-04-05 19:05:18 +00002114 /* Read the peer-value from each cursor into a register */
2115 windowReadPeerValues(p, csr1, reg1);
2116 windowReadPeerValues(p, csr2, reg2);
2117
dan71fddaf2019-03-11 11:12:34 +00002118 assert( op==OP_Ge || op==OP_Gt || op==OP_Le );
danae8e45c2019-08-19 19:59:50 +00002119 assert( pOrderBy && pOrderBy->nExpr==1 );
2120 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_DESC ){
dan71fddaf2019-03-11 11:12:34 +00002121 switch( op ){
2122 case OP_Ge: op = OP_Le; break;
2123 case OP_Gt: op = OP_Lt; break;
2124 default: assert( op==OP_Le ); op = OP_Ge; break;
2125 }
2126 arith = OP_Subtract;
2127 }
2128
dan8b47f522019-08-30 16:14:58 +00002129 VdbeModuleComment((v, "CodeRangeTest: if( R%d %s R%d %s R%d ) goto lbl",
2130 reg1, (arith==OP_Add ? "+" : "-"), regVal,
2131 ((op==OP_Ge) ? ">=" : (op==OP_Le) ? "<=" : (op==OP_Gt) ? ">" : "<"), reg2
2132 ));
2133
dan8b47f522019-08-30 16:14:58 +00002134 /* If the BIGNULL flag is set for the ORDER BY, then it is required to
2135 ** consider NULL values to be larger than all other values, instead of
2136 ** the usual smaller. The VDBE opcodes OP_Ge and so on do not handle this
2137 ** (and adding that capability causes a performance regression), so
2138 ** instead if the BIGNULL flag is set then cases where either reg1 or
2139 ** reg2 are NULL are handled separately in the following block. The code
2140 ** generated is equivalent to:
2141 **
2142 ** if( reg1 IS NULL ){
dan9889ede2019-08-30 19:45:03 +00002143 ** if( op==OP_Ge ) goto lbl;
2144 ** if( op==OP_Gt && reg2 IS NOT NULL ) goto lbl;
dan8b47f522019-08-30 16:14:58 +00002145 ** if( op==OP_Le && reg2 IS NULL ) goto lbl;
2146 ** }else if( reg2 IS NULL ){
2147 ** if( op==OP_Le ) goto lbl;
2148 ** }
2149 **
2150 ** Additionally, if either reg1 or reg2 are NULL but the jump to lbl is
2151 ** not taken, control jumps over the comparison operator coded below this
2152 ** block. */
danae8e45c2019-08-19 19:59:50 +00002153 if( pOrderBy->a[0].sortFlags & KEYINFO_ORDER_BIGNULL ){
dan8b47f522019-08-30 16:14:58 +00002154 /* This block runs if reg1 contains a NULL. */
2155 int addr = sqlite3VdbeAddOp1(v, OP_NotNull, reg1); VdbeCoverage(v);
danae8e45c2019-08-19 19:59:50 +00002156 switch( op ){
dan8b47f522019-08-30 16:14:58 +00002157 case OP_Ge:
2158 sqlite3VdbeAddOp2(v, OP_Goto, 0, lbl);
2159 break;
danf236b212019-08-21 19:58:11 +00002160 case OP_Gt:
drhdb3a32e2019-08-30 18:02:49 +00002161 sqlite3VdbeAddOp2(v, OP_NotNull, reg2, lbl);
2162 VdbeCoverage(v);
danf236b212019-08-21 19:58:11 +00002163 break;
drhdb3a32e2019-08-30 18:02:49 +00002164 case OP_Le:
2165 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl);
2166 VdbeCoverage(v);
danf236b212019-08-21 19:58:11 +00002167 break;
drhdb3a32e2019-08-30 18:02:49 +00002168 default: assert( op==OP_Lt ); /* no-op */ break;
danae8e45c2019-08-19 19:59:50 +00002169 }
dan6b6ec402021-04-05 19:05:18 +00002170 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
dan8b47f522019-08-30 16:14:58 +00002171
2172 /* This block runs if reg1 is not NULL, but reg2 is. */
danae8e45c2019-08-19 19:59:50 +00002173 sqlite3VdbeJumpHere(v, addr);
2174 sqlite3VdbeAddOp2(v, OP_IsNull, reg2, lbl); VdbeCoverage(v);
2175 if( op==OP_Gt || op==OP_Ge ){
dan6b6ec402021-04-05 19:05:18 +00002176 sqlite3VdbeChangeP2(v, -1, addrDone);
danae8e45c2019-08-19 19:59:50 +00002177 }
2178 }
dan8b47f522019-08-30 16:14:58 +00002179
dan6b6ec402021-04-05 19:05:18 +00002180 /* Register reg1 currently contains csr1.peerVal (the peer-value from csr1).
2181 ** This block adds (or subtracts for DESC) the numeric value in regVal
2182 ** from it. Or, if reg1 is not numeric (it is a NULL, a text value or a blob),
2183 ** then leave reg1 as it is. In pseudo-code, this is implemented as:
2184 **
2185 ** if( reg1>='' ) goto addrGe;
2186 ** reg1 = reg1 +/- regVal
2187 ** addrGe:
2188 **
2189 ** Since all strings and blobs are greater-than-or-equal-to an empty string,
2190 ** the add/subtract is skipped for these, as required. If reg1 is a NULL,
2191 ** then the arithmetic is performed, but since adding or subtracting from
2192 ** NULL is always NULL anyway, this case is handled as required too. */
2193 sqlite3VdbeAddOp4(v, OP_String8, 0, regString, 0, "", P4_STATIC);
2194 addrGe = sqlite3VdbeAddOp3(v, OP_Ge, regString, 0, reg1);
2195 VdbeCoverage(v);
2196 if( (op==OP_Ge && arith==OP_Add) || (op==OP_Le && arith==OP_Subtract) ){
2197 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v);
2198 }
2199 sqlite3VdbeAddOp3(v, arith, regVal, reg1, reg1);
2200 sqlite3VdbeJumpHere(v, addrGe);
2201
dan8b47f522019-08-30 16:14:58 +00002202 /* Compare registers reg2 and reg1, taking the jump if required. Note that
2203 ** control skips over this test if the BIGNULL flag is set and either
2204 ** reg1 or reg2 contain a NULL value. */
drh6f883592019-03-30 20:37:04 +00002205 sqlite3VdbeAddOp3(v, op, reg2, lbl, reg1); VdbeCoverage(v);
dan7f8653a2021-03-06 14:46:24 +00002206 pColl = sqlite3ExprNNCollSeq(pParse, pOrderBy->a[0].pExpr);
2207 sqlite3VdbeAppendP4(v, (void*)pColl, P4_COLLSEQ);
danbdabe742019-03-18 16:51:24 +00002208 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
dan6b6ec402021-04-05 19:05:18 +00002209 sqlite3VdbeResolveLabel(v, addrDone);
dan8b47f522019-08-30 16:14:58 +00002210
drh6f883592019-03-30 20:37:04 +00002211 assert( op==OP_Ge || op==OP_Gt || op==OP_Lt || op==OP_Le );
2212 testcase(op==OP_Ge); VdbeCoverageIf(v, op==OP_Ge);
2213 testcase(op==OP_Lt); VdbeCoverageIf(v, op==OP_Lt);
2214 testcase(op==OP_Le); VdbeCoverageIf(v, op==OP_Le);
2215 testcase(op==OP_Gt); VdbeCoverageIf(v, op==OP_Gt);
dan72b9fdc2019-03-09 20:49:17 +00002216 sqlite3ReleaseTempReg(pParse, reg1);
2217 sqlite3ReleaseTempReg(pParse, reg2);
dan8b47f522019-08-30 16:14:58 +00002218
2219 VdbeModuleComment((v, "CodeRangeTest: end"));
dan72b9fdc2019-03-09 20:49:17 +00002220}
2221
dan0525b6f2019-03-18 21:19:40 +00002222/*
2223** Helper function for sqlite3WindowCodeStep(). Each call to this function
2224** generates VM code for a single RETURN_ROW, AGGSTEP or AGGINVERSE
2225** operation. Refer to the header comment for sqlite3WindowCodeStep() for
2226** details.
2227*/
dan00267b82019-03-06 21:04:11 +00002228static int windowCodeOp(
dan0525b6f2019-03-18 21:19:40 +00002229 WindowCodeArg *p, /* Context object */
2230 int op, /* WINDOW_RETURN_ROW, AGGSTEP or AGGINVERSE */
2231 int regCountdown, /* Register for OP_IfPos countdown */
2232 int jumpOnEof /* Jump here if stepped cursor reaches EOF */
dan00267b82019-03-06 21:04:11 +00002233){
dan6c75b392019-03-08 20:02:52 +00002234 int csr, reg;
2235 Parse *pParse = p->pParse;
dan54975cd2019-03-07 20:47:46 +00002236 Window *pMWin = p->pMWin;
dan00267b82019-03-06 21:04:11 +00002237 int ret = 0;
2238 Vdbe *v = p->pVdbe;
dan6c75b392019-03-08 20:02:52 +00002239 int addrContinue = 0;
drhfc15f4c2019-03-28 13:03:41 +00002240 int bPeer = (pMWin->eFrmType!=TK_ROWS);
dan00267b82019-03-06 21:04:11 +00002241
dan72b9fdc2019-03-09 20:49:17 +00002242 int lblDone = sqlite3VdbeMakeLabel(pParse);
2243 int addrNextRange = 0;
2244
dan54975cd2019-03-07 20:47:46 +00002245 /* Special case - WINDOW_AGGINVERSE is always a no-op if the frame
2246 ** starts with UNBOUNDED PRECEDING. */
2247 if( op==WINDOW_AGGINVERSE && pMWin->eStart==TK_UNBOUNDED ){
2248 assert( regCountdown==0 && jumpOnEof==0 );
2249 return 0;
2250 }
2251
dan00267b82019-03-06 21:04:11 +00002252 if( regCountdown>0 ){
drhfc15f4c2019-03-28 13:03:41 +00002253 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00002254 addrNextRange = sqlite3VdbeCurrentAddr(v);
dan0525b6f2019-03-18 21:19:40 +00002255 assert( op==WINDOW_AGGINVERSE || op==WINDOW_AGGSTEP );
2256 if( op==WINDOW_AGGINVERSE ){
2257 if( pMWin->eStart==TK_FOLLOWING ){
dan72b9fdc2019-03-09 20:49:17 +00002258 windowCodeRangeTest(
dan0525b6f2019-03-18 21:19:40 +00002259 p, OP_Le, p->current.csr, regCountdown, p->start.csr, lblDone
dan72b9fdc2019-03-09 20:49:17 +00002260 );
dan0525b6f2019-03-18 21:19:40 +00002261 }else{
2262 windowCodeRangeTest(
2263 p, OP_Ge, p->start.csr, regCountdown, p->current.csr, lblDone
2264 );
dan72b9fdc2019-03-09 20:49:17 +00002265 }
dan0525b6f2019-03-18 21:19:40 +00002266 }else{
2267 windowCodeRangeTest(
2268 p, OP_Gt, p->end.csr, regCountdown, p->current.csr, lblDone
2269 );
dan72b9fdc2019-03-09 20:49:17 +00002270 }
dan72b9fdc2019-03-09 20:49:17 +00002271 }else{
dan37d296a2019-09-24 20:20:05 +00002272 sqlite3VdbeAddOp3(v, OP_IfPos, regCountdown, lblDone, 1);
dan1d4b25f2019-03-19 16:49:15 +00002273 VdbeCoverage(v);
dan72b9fdc2019-03-09 20:49:17 +00002274 }
dan00267b82019-03-06 21:04:11 +00002275 }
2276
dan0525b6f2019-03-18 21:19:40 +00002277 if( op==WINDOW_RETURN_ROW && pMWin->regStartRowid==0 ){
danc782a812019-03-15 20:46:19 +00002278 windowAggFinal(p, 0);
dan6c75b392019-03-08 20:02:52 +00002279 }
2280 addrContinue = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002281
2282 /* If this is a (RANGE BETWEEN a FOLLOWING AND b FOLLOWING) or
2283 ** (RANGE BETWEEN b PRECEDING AND a PRECEDING) frame, ensure the
2284 ** start cursor does not advance past the end cursor within the
drh113a33c2021-04-24 23:40:05 +00002285 ** temporary table. It otherwise might, if (a>b). Also ensure that,
2286 ** if the input cursor is still finding new rows, that the end
2287 ** cursor does not go past it to EOF. */
dane7579a52019-09-25 16:41:44 +00002288 if( pMWin->eStart==pMWin->eEnd && regCountdown
drh113a33c2021-04-24 23:40:05 +00002289 && pMWin->eFrmType==TK_RANGE
dane7579a52019-09-25 16:41:44 +00002290 ){
2291 int regRowid1 = sqlite3GetTempReg(pParse);
2292 int regRowid2 = sqlite3GetTempReg(pParse);
drh113a33c2021-04-24 23:40:05 +00002293 if( op==WINDOW_AGGINVERSE ){
2294 sqlite3VdbeAddOp2(v, OP_Rowid, p->start.csr, regRowid1);
2295 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid2);
2296 sqlite3VdbeAddOp3(v, OP_Ge, regRowid2, lblDone, regRowid1);
2297 VdbeCoverage(v);
2298 }else if( p->regRowid ){
2299 sqlite3VdbeAddOp2(v, OP_Rowid, p->end.csr, regRowid1);
2300 sqlite3VdbeAddOp3(v, OP_Ge, p->regRowid, lblDone, regRowid1);
drh79f313f2021-04-28 15:43:36 +00002301 VdbeCoverageNeverNull(v);
drh113a33c2021-04-24 23:40:05 +00002302 }
dane7579a52019-09-25 16:41:44 +00002303 sqlite3ReleaseTempReg(pParse, regRowid1);
2304 sqlite3ReleaseTempReg(pParse, regRowid2);
2305 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING );
2306 }
2307
dan00267b82019-03-06 21:04:11 +00002308 switch( op ){
2309 case WINDOW_RETURN_ROW:
dan6c75b392019-03-08 20:02:52 +00002310 csr = p->current.csr;
2311 reg = p->current.reg;
danc782a812019-03-15 20:46:19 +00002312 windowReturnOneRow(p);
dan00267b82019-03-06 21:04:11 +00002313 break;
2314
2315 case WINDOW_AGGINVERSE:
dan6c75b392019-03-08 20:02:52 +00002316 csr = p->start.csr;
2317 reg = p->start.reg;
dana0f6b832019-03-14 16:36:20 +00002318 if( pMWin->regStartRowid ){
2319 assert( pMWin->regEndRowid );
2320 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regStartRowid, 1);
2321 }else{
dan37d296a2019-09-24 20:20:05 +00002322 windowAggStep(p, pMWin, csr, 1, p->regArg);
dana0f6b832019-03-14 16:36:20 +00002323 }
dan00267b82019-03-06 21:04:11 +00002324 break;
2325
dan0525b6f2019-03-18 21:19:40 +00002326 default:
2327 assert( op==WINDOW_AGGSTEP );
dan6c75b392019-03-08 20:02:52 +00002328 csr = p->end.csr;
2329 reg = p->end.reg;
dana0f6b832019-03-14 16:36:20 +00002330 if( pMWin->regStartRowid ){
2331 assert( pMWin->regEndRowid );
2332 sqlite3VdbeAddOp2(v, OP_AddImm, pMWin->regEndRowid, 1);
2333 }else{
dan37d296a2019-09-24 20:20:05 +00002334 windowAggStep(p, pMWin, csr, 0, p->regArg);
dana0f6b832019-03-14 16:36:20 +00002335 }
dan00267b82019-03-06 21:04:11 +00002336 break;
2337 }
2338
danb560a712019-03-13 15:29:14 +00002339 if( op==p->eDelete ){
2340 sqlite3VdbeAddOp1(v, OP_Delete, csr);
2341 sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
2342 }
2343
danc8137502019-03-07 19:26:17 +00002344 if( jumpOnEof ){
2345 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+2);
dan1d4b25f2019-03-19 16:49:15 +00002346 VdbeCoverage(v);
danc8137502019-03-07 19:26:17 +00002347 ret = sqlite3VdbeAddOp0(v, OP_Goto);
2348 }else{
dan6c75b392019-03-08 20:02:52 +00002349 sqlite3VdbeAddOp2(v, OP_Next, csr, sqlite3VdbeCurrentAddr(v)+1+bPeer);
dan1d4b25f2019-03-19 16:49:15 +00002350 VdbeCoverage(v);
dan6c75b392019-03-08 20:02:52 +00002351 if( bPeer ){
dan37d296a2019-09-24 20:20:05 +00002352 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblDone);
dan6c75b392019-03-08 20:02:52 +00002353 }
dan00267b82019-03-06 21:04:11 +00002354 }
danc8137502019-03-07 19:26:17 +00002355
dan6c75b392019-03-08 20:02:52 +00002356 if( bPeer ){
dan6c75b392019-03-08 20:02:52 +00002357 int nReg = (pMWin->pOrderBy ? pMWin->pOrderBy->nExpr : 0);
dane7579a52019-09-25 16:41:44 +00002358 int regTmp = (nReg ? sqlite3GetTempRange(pParse, nReg) : 0);
dan6c75b392019-03-08 20:02:52 +00002359 windowReadPeerValues(p, csr, regTmp);
dan935d9d82019-03-12 15:21:51 +00002360 windowIfNewPeer(pParse, pMWin->pOrderBy, regTmp, reg, addrContinue);
dan6c75b392019-03-08 20:02:52 +00002361 sqlite3ReleaseTempRange(pParse, regTmp, nReg);
dan00267b82019-03-06 21:04:11 +00002362 }
dan6c75b392019-03-08 20:02:52 +00002363
dan72b9fdc2019-03-09 20:49:17 +00002364 if( addrNextRange ){
2365 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNextRange);
2366 }
2367 sqlite3VdbeResolveLabel(v, lblDone);
dan00267b82019-03-06 21:04:11 +00002368 return ret;
2369}
2370
dana786e452019-03-11 18:17:04 +00002371
dan00267b82019-03-06 21:04:11 +00002372/*
dana786e452019-03-11 18:17:04 +00002373** Allocate and return a duplicate of the Window object indicated by the
2374** third argument. Set the Window.pOwner field of the new object to
2375** pOwner.
2376*/
2377Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p){
2378 Window *pNew = 0;
2379 if( ALWAYS(p) ){
2380 pNew = sqlite3DbMallocZero(db, sizeof(Window));
2381 if( pNew ){
2382 pNew->zName = sqlite3DbStrDup(db, p->zName);
danb42eb352019-09-16 05:34:08 +00002383 pNew->zBase = sqlite3DbStrDup(db, p->zBase);
dana786e452019-03-11 18:17:04 +00002384 pNew->pFilter = sqlite3ExprDup(db, p->pFilter, 0);
drh105dcaa2022-03-10 16:01:14 +00002385 pNew->pWFunc = p->pWFunc;
dana786e452019-03-11 18:17:04 +00002386 pNew->pPartition = sqlite3ExprListDup(db, p->pPartition, 0);
2387 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, 0);
drhfc15f4c2019-03-28 13:03:41 +00002388 pNew->eFrmType = p->eFrmType;
dana786e452019-03-11 18:17:04 +00002389 pNew->eEnd = p->eEnd;
2390 pNew->eStart = p->eStart;
danc782a812019-03-15 20:46:19 +00002391 pNew->eExclude = p->eExclude;
drhb555b082019-07-19 01:11:27 +00002392 pNew->regResult = p->regResult;
dan0a21ea92020-02-29 17:19:42 +00002393 pNew->regAccum = p->regAccum;
2394 pNew->iArgCol = p->iArgCol;
2395 pNew->iEphCsr = p->iEphCsr;
2396 pNew->bExprArgs = p->bExprArgs;
dana786e452019-03-11 18:17:04 +00002397 pNew->pStart = sqlite3ExprDup(db, p->pStart, 0);
2398 pNew->pEnd = sqlite3ExprDup(db, p->pEnd, 0);
2399 pNew->pOwner = pOwner;
danb42eb352019-09-16 05:34:08 +00002400 pNew->bImplicitFrame = p->bImplicitFrame;
dana786e452019-03-11 18:17:04 +00002401 }
2402 }
2403 return pNew;
2404}
2405
2406/*
2407** Return a copy of the linked list of Window objects passed as the
2408** second argument.
2409*/
2410Window *sqlite3WindowListDup(sqlite3 *db, Window *p){
2411 Window *pWin;
2412 Window *pRet = 0;
2413 Window **pp = &pRet;
2414
2415 for(pWin=p; pWin; pWin=pWin->pNextWin){
2416 *pp = sqlite3WindowDup(db, 0, pWin);
2417 if( *pp==0 ) break;
2418 pp = &((*pp)->pNextWin);
2419 }
2420
2421 return pRet;
2422}
2423
2424/*
dan725b1cf2019-03-26 16:47:17 +00002425** Return true if it can be determined at compile time that expression
2426** pExpr evaluates to a value that, when cast to an integer, is greater
2427** than zero. False otherwise.
2428**
2429** If an OOM error occurs, this function sets the Parse.db.mallocFailed
2430** flag and returns zero.
2431*/
2432static int windowExprGtZero(Parse *pParse, Expr *pExpr){
2433 int ret = 0;
2434 sqlite3 *db = pParse->db;
2435 sqlite3_value *pVal = 0;
2436 sqlite3ValueFromExpr(db, pExpr, db->enc, SQLITE_AFF_NUMERIC, &pVal);
2437 if( pVal && sqlite3_value_int(pVal)>0 ){
2438 ret = 1;
2439 }
2440 sqlite3ValueFree(pVal);
2441 return ret;
2442}
2443
2444/*
dana786e452019-03-11 18:17:04 +00002445** sqlite3WhereBegin() has already been called for the SELECT statement
2446** passed as the second argument when this function is invoked. It generates
2447** code to populate the Window.regResult register for each window function
2448** and invoke the sub-routine at instruction addrGosub once for each row.
2449** sqlite3WhereEnd() is always called before returning.
dan00267b82019-03-06 21:04:11 +00002450**
dana786e452019-03-11 18:17:04 +00002451** This function handles several different types of window frames, which
2452** require slightly different processing. The following pseudo code is
2453** used to implement window frames of the form:
dan00267b82019-03-06 21:04:11 +00002454**
dana786e452019-03-11 18:17:04 +00002455** ROWS BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING
dan00267b82019-03-06 21:04:11 +00002456**
dana786e452019-03-11 18:17:04 +00002457** Other window frame types use variants of the following:
2458**
2459** ... loop started by sqlite3WhereBegin() ...
dan00267b82019-03-06 21:04:11 +00002460** if( new partition ){
2461** Gosub flush
dana786e452019-03-11 18:17:04 +00002462** }
dan00267b82019-03-06 21:04:11 +00002463** Insert new row into eph table.
dana786e452019-03-11 18:17:04 +00002464**
dan00267b82019-03-06 21:04:11 +00002465** if( first row of partition ){
dana786e452019-03-11 18:17:04 +00002466** // Rewind three cursors, all open on the eph table.
2467** Rewind(csrEnd);
2468** Rewind(csrStart);
2469** Rewind(csrCurrent);
2470**
dan00267b82019-03-06 21:04:11 +00002471** regEnd = <expr2> // FOLLOWING expression
2472** regStart = <expr1> // PRECEDING expression
2473** }else{
dana786e452019-03-11 18:17:04 +00002474** // First time this branch is taken, the eph table contains two
2475** // rows. The first row in the partition, which all three cursors
2476** // currently point to, and the following row.
2477** AGGSTEP
dan00267b82019-03-06 21:04:11 +00002478** if( (regEnd--)<=0 ){
dana786e452019-03-11 18:17:04 +00002479** RETURN_ROW
2480** if( (regStart--)<=0 ){
2481** AGGINVERSE
dan00267b82019-03-06 21:04:11 +00002482** }
2483** }
dana786e452019-03-11 18:17:04 +00002484** }
2485** }
dan00267b82019-03-06 21:04:11 +00002486** flush:
dana786e452019-03-11 18:17:04 +00002487** AGGSTEP
2488** while( 1 ){
2489** RETURN ROW
2490** if( csrCurrent is EOF ) break;
2491** if( (regStart--)<=0 ){
2492** AggInverse(csrStart)
2493** Next(csrStart)
dan00267b82019-03-06 21:04:11 +00002494** }
dana786e452019-03-11 18:17:04 +00002495** }
dan00267b82019-03-06 21:04:11 +00002496**
dana786e452019-03-11 18:17:04 +00002497** The pseudo-code above uses the following shorthand:
dan00267b82019-03-06 21:04:11 +00002498**
dana786e452019-03-11 18:17:04 +00002499** AGGSTEP: invoke the aggregate xStep() function for each window function
2500** with arguments read from the current row of cursor csrEnd, then
2501** step cursor csrEnd forward one row (i.e. sqlite3BtreeNext()).
2502**
2503** RETURN_ROW: return a row to the caller based on the contents of the
2504** current row of csrCurrent and the current state of all
2505** aggregates. Then step cursor csrCurrent forward one row.
2506**
2507** AGGINVERSE: invoke the aggregate xInverse() function for each window
2508** functions with arguments read from the current row of cursor
2509** csrStart. Then step csrStart forward one row.
2510**
2511** There are two other ROWS window frames that are handled significantly
2512** differently from the above - "BETWEEN <expr> PRECEDING AND <expr> PRECEDING"
2513** and "BETWEEN <expr> FOLLOWING AND <expr> FOLLOWING". These are special
2514** cases because they change the order in which the three cursors (csrStart,
2515** csrCurrent and csrEnd) iterate through the ephemeral table. Cases that
2516** use UNBOUNDED or CURRENT ROW are much simpler variations on one of these
2517** three.
2518**
2519** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2520**
2521** ... loop started by sqlite3WhereBegin() ...
dan00267b82019-03-06 21:04:11 +00002522** if( new partition ){
2523** Gosub flush
dana786e452019-03-11 18:17:04 +00002524** }
dan00267b82019-03-06 21:04:11 +00002525** Insert new row into eph table.
2526** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002527** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002528** regEnd = <expr2>
2529** regStart = <expr1>
dan00267b82019-03-06 21:04:11 +00002530** }else{
dana786e452019-03-11 18:17:04 +00002531** if( (regEnd--)<=0 ){
2532** AGGSTEP
2533** }
2534** RETURN_ROW
2535** if( (regStart--)<=0 ){
2536** AGGINVERSE
2537** }
2538** }
2539** }
dan00267b82019-03-06 21:04:11 +00002540** flush:
dana786e452019-03-11 18:17:04 +00002541** if( (regEnd--)<=0 ){
2542** AGGSTEP
2543** }
2544** RETURN_ROW
2545**
2546**
2547** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2548**
2549** ... loop started by sqlite3WhereBegin() ...
2550** if( new partition ){
2551** Gosub flush
2552** }
2553** Insert new row into eph table.
2554** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002555** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002556** regEnd = <expr2>
2557** regStart = regEnd - <expr1>
2558** }else{
2559** AGGSTEP
2560** if( (regEnd--)<=0 ){
2561** RETURN_ROW
2562** }
2563** if( (regStart--)<=0 ){
2564** AGGINVERSE
2565** }
2566** }
2567** }
2568** flush:
2569** AGGSTEP
2570** while( 1 ){
2571** if( (regEnd--)<=0 ){
2572** RETURN_ROW
2573** if( eof ) break;
2574** }
2575** if( (regStart--)<=0 ){
2576** AGGINVERSE
2577** if( eof ) break
2578** }
2579** }
2580** while( !eof csrCurrent ){
2581** RETURN_ROW
2582** }
2583**
2584** For the most part, the patterns above are adapted to support UNBOUNDED by
2585** assuming that it is equivalent to "infinity PRECEDING/FOLLOWING" and
2586** CURRENT ROW by assuming that it is equivilent to "0 PRECEDING/FOLLOWING".
2587** This is optimized of course - branches that will never be taken and
2588** conditions that are always true are omitted from the VM code. The only
2589** exceptional case is:
2590**
2591** ROWS BETWEEN <expr1> FOLLOWING AND UNBOUNDED FOLLOWING
2592**
2593** ... loop started by sqlite3WhereBegin() ...
2594** if( new partition ){
2595** Gosub flush
2596** }
2597** Insert new row into eph table.
2598** if( first row of partition ){
dan935d9d82019-03-12 15:21:51 +00002599** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
dana786e452019-03-11 18:17:04 +00002600** regStart = <expr1>
2601** }else{
2602** AGGSTEP
2603** }
2604** }
2605** flush:
2606** AGGSTEP
2607** while( 1 ){
2608** if( (regStart--)<=0 ){
2609** AGGINVERSE
2610** if( eof ) break
2611** }
2612** RETURN_ROW
2613** }
2614** while( !eof csrCurrent ){
2615** RETURN_ROW
2616** }
dan935d9d82019-03-12 15:21:51 +00002617**
2618** Also requiring special handling are the cases:
2619**
2620** ROWS BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2621** ROWS BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2622**
2623** when (expr1 < expr2). This is detected at runtime, not by this function.
2624** To handle this case, the pseudo-code programs depicted above are modified
2625** slightly to be:
2626**
2627** ... loop started by sqlite3WhereBegin() ...
2628** if( new partition ){
2629** Gosub flush
2630** }
2631** Insert new row into eph table.
2632** if( first row of partition ){
2633** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2634** regEnd = <expr2>
2635** regStart = <expr1>
2636** if( regEnd < regStart ){
2637** RETURN_ROW
2638** delete eph table contents
2639** continue
2640** }
2641** ...
2642**
2643** The new "continue" statement in the above jumps to the next iteration
2644** of the outer loop - the one started by sqlite3WhereBegin().
2645**
2646** The various GROUPS cases are implemented using the same patterns as
2647** ROWS. The VM code is modified slightly so that:
2648**
2649** 1. The else branch in the main loop is only taken if the row just
2650** added to the ephemeral table is the start of a new group. In
2651** other words, it becomes:
2652**
2653** ... loop started by sqlite3WhereBegin() ...
2654** if( new partition ){
2655** Gosub flush
2656** }
2657** Insert new row into eph table.
2658** if( first row of partition ){
2659** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2660** regEnd = <expr2>
2661** regStart = <expr1>
2662** }else if( new group ){
2663** ...
2664** }
2665** }
2666**
2667** 2. Instead of processing a single row, each RETURN_ROW, AGGSTEP or
2668** AGGINVERSE step processes the current row of the relevant cursor and
2669** all subsequent rows belonging to the same group.
2670**
2671** RANGE window frames are a little different again. As for GROUPS, the
2672** main loop runs once per group only. And RETURN_ROW, AGGSTEP and AGGINVERSE
2673** deal in groups instead of rows. As for ROWS and GROUPS, there are three
2674** basic cases:
2675**
2676** RANGE BETWEEN <expr1> PRECEDING AND <expr2> FOLLOWING
2677**
2678** ... loop started by sqlite3WhereBegin() ...
2679** if( new partition ){
2680** Gosub flush
2681** }
2682** Insert new row into eph table.
2683** if( first row of partition ){
2684** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2685** regEnd = <expr2>
2686** regStart = <expr1>
2687** }else{
2688** AGGSTEP
2689** while( (csrCurrent.key + regEnd) < csrEnd.key ){
2690** RETURN_ROW
2691** while( csrStart.key + regStart) < csrCurrent.key ){
2692** AGGINVERSE
2693** }
2694** }
2695** }
2696** }
2697** flush:
2698** AGGSTEP
2699** while( 1 ){
2700** RETURN ROW
2701** if( csrCurrent is EOF ) break;
2702** while( csrStart.key + regStart) < csrCurrent.key ){
2703** AGGINVERSE
2704** }
2705** }
2706** }
2707**
2708** In the above notation, "csr.key" means the current value of the ORDER BY
2709** expression (there is only ever 1 for a RANGE that uses an <expr> FOLLOWING
2710** or <expr PRECEDING) read from cursor csr.
2711**
2712** RANGE BETWEEN <expr1> PRECEDING AND <expr2> PRECEDING
2713**
2714** ... loop started by sqlite3WhereBegin() ...
2715** if( new partition ){
2716** Gosub flush
2717** }
2718** Insert new row into eph table.
2719** if( first row of partition ){
2720** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2721** regEnd = <expr2>
2722** regStart = <expr1>
2723** }else{
dan37d296a2019-09-24 20:20:05 +00002724** while( (csrEnd.key + regEnd) <= csrCurrent.key ){
dan935d9d82019-03-12 15:21:51 +00002725** AGGSTEP
2726** }
dan935d9d82019-03-12 15:21:51 +00002727** while( (csrStart.key + regStart) < csrCurrent.key ){
2728** AGGINVERSE
2729** }
dane7579a52019-09-25 16:41:44 +00002730** RETURN_ROW
dan935d9d82019-03-12 15:21:51 +00002731** }
2732** }
2733** flush:
2734** while( (csrEnd.key + regEnd) <= csrCurrent.key ){
2735** AGGSTEP
2736** }
dan3f49c322019-04-03 16:27:44 +00002737** while( (csrStart.key + regStart) < csrCurrent.key ){
2738** AGGINVERSE
2739** }
dane7579a52019-09-25 16:41:44 +00002740** RETURN_ROW
dan935d9d82019-03-12 15:21:51 +00002741**
2742** RANGE BETWEEN <expr1> FOLLOWING AND <expr2> FOLLOWING
2743**
2744** ... loop started by sqlite3WhereBegin() ...
2745** if( new partition ){
2746** Gosub flush
2747** }
2748** Insert new row into eph table.
2749** if( first row of partition ){
2750** Rewind(csrEnd) ; Rewind(csrStart) ; Rewind(csrCurrent)
2751** regEnd = <expr2>
2752** regStart = <expr1>
2753** }else{
2754** AGGSTEP
2755** while( (csrCurrent.key + regEnd) < csrEnd.key ){
2756** while( (csrCurrent.key + regStart) > csrStart.key ){
2757** AGGINVERSE
2758** }
2759** RETURN_ROW
2760** }
2761** }
2762** }
2763** flush:
2764** AGGSTEP
2765** while( 1 ){
2766** while( (csrCurrent.key + regStart) > csrStart.key ){
2767** AGGINVERSE
2768** if( eof ) break "while( 1 )" loop.
2769** }
2770** RETURN_ROW
2771** }
2772** while( !eof csrCurrent ){
2773** RETURN_ROW
2774** }
2775**
danb6f2dea2019-03-13 17:20:27 +00002776** The text above leaves out many details. Refer to the code and comments
2777** below for a more complete picture.
dan00267b82019-03-06 21:04:11 +00002778*/
dana786e452019-03-11 18:17:04 +00002779void sqlite3WindowCodeStep(
dancc7a8502019-03-11 19:50:54 +00002780 Parse *pParse, /* Parse context */
dana786e452019-03-11 18:17:04 +00002781 Select *p, /* Rewritten SELECT statement */
2782 WhereInfo *pWInfo, /* Context returned by sqlite3WhereBegin() */
2783 int regGosub, /* Register for OP_Gosub */
2784 int addrGosub /* OP_Gosub here to return each row */
dan680f6e82019-03-04 21:07:11 +00002785){
2786 Window *pMWin = p->pWin;
dan6c75b392019-03-08 20:02:52 +00002787 ExprList *pOrderBy = pMWin->pOrderBy;
dan680f6e82019-03-04 21:07:11 +00002788 Vdbe *v = sqlite3GetVdbe(pParse);
dana786e452019-03-11 18:17:04 +00002789 int csrWrite; /* Cursor used to write to eph. table */
2790 int csrInput = p->pSrc->a[0].iCursor; /* Cursor of sub-select */
2791 int nInput = p->pSrc->a[0].pTab->nCol; /* Number of cols returned by sub */
2792 int iInput; /* To iterate through sub cols */
danbf845152019-03-16 10:15:24 +00002793 int addrNe; /* Address of OP_Ne */
drhd4a591d2019-03-26 16:21:11 +00002794 int addrGosubFlush = 0; /* Address of OP_Gosub to flush: */
2795 int addrInteger = 0; /* Address of OP_Integer */
dand4461652019-03-13 08:28:51 +00002796 int addrEmpty; /* Address of OP_Rewind in flush: */
dana786e452019-03-11 18:17:04 +00002797 int regNew; /* Array of registers holding new input row */
2798 int regRecord; /* regNew array in record form */
dana786e452019-03-11 18:17:04 +00002799 int regNewPeer = 0; /* Peer values for new row (part of regNew) */
2800 int regPeer = 0; /* Peer values for current row */
dand4461652019-03-13 08:28:51 +00002801 int regFlushPart = 0; /* Register for "Gosub flush_partition" */
dana786e452019-03-11 18:17:04 +00002802 WindowCodeArg s; /* Context object for sub-routines */
dan935d9d82019-03-12 15:21:51 +00002803 int lblWhereEnd; /* Label just before sqlite3WhereEnd() code */
dane7579a52019-09-25 16:41:44 +00002804 int regStart = 0; /* Value of <expr> PRECEDING */
2805 int regEnd = 0; /* Value of <expr> FOLLOWING */
dan680f6e82019-03-04 21:07:11 +00002806
dan72b9fdc2019-03-09 20:49:17 +00002807 assert( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_CURRENT
2808 || pMWin->eStart==TK_FOLLOWING || pMWin->eStart==TK_UNBOUNDED
2809 );
2810 assert( pMWin->eEnd==TK_FOLLOWING || pMWin->eEnd==TK_CURRENT
2811 || pMWin->eEnd==TK_UNBOUNDED || pMWin->eEnd==TK_PRECEDING
2812 );
dan108e6b22019-03-18 18:55:35 +00002813 assert( pMWin->eExclude==0 || pMWin->eExclude==TK_CURRENT
2814 || pMWin->eExclude==TK_GROUP || pMWin->eExclude==TK_TIES
2815 || pMWin->eExclude==TK_NO
2816 );
dan72b9fdc2019-03-09 20:49:17 +00002817
dan935d9d82019-03-12 15:21:51 +00002818 lblWhereEnd = sqlite3VdbeMakeLabel(pParse);
dana786e452019-03-11 18:17:04 +00002819
2820 /* Fill in the context object */
dan00267b82019-03-06 21:04:11 +00002821 memset(&s, 0, sizeof(WindowCodeArg));
2822 s.pParse = pParse;
2823 s.pMWin = pMWin;
2824 s.pVdbe = v;
2825 s.regGosub = regGosub;
2826 s.addrGosub = addrGosub;
dan6c75b392019-03-08 20:02:52 +00002827 s.current.csr = pMWin->iEphCsr;
dana786e452019-03-11 18:17:04 +00002828 csrWrite = s.current.csr+1;
dan6c75b392019-03-08 20:02:52 +00002829 s.start.csr = s.current.csr+2;
2830 s.end.csr = s.current.csr+3;
danb33487b2019-03-06 17:12:32 +00002831
danb560a712019-03-13 15:29:14 +00002832 /* Figure out when rows may be deleted from the ephemeral table. There
2833 ** are four options - they may never be deleted (eDelete==0), they may
2834 ** be deleted as soon as they are no longer part of the window frame
2835 ** (eDelete==WINDOW_AGGINVERSE), they may be deleted as after the row
2836 ** has been returned to the caller (WINDOW_RETURN_ROW), or they may
2837 ** be deleted after they enter the frame (WINDOW_AGGSTEP). */
2838 switch( pMWin->eStart ){
dan725b1cf2019-03-26 16:47:17 +00002839 case TK_FOLLOWING:
drhfc15f4c2019-03-28 13:03:41 +00002840 if( pMWin->eFrmType!=TK_RANGE
2841 && windowExprGtZero(pParse, pMWin->pStart)
2842 ){
dan725b1cf2019-03-26 16:47:17 +00002843 s.eDelete = WINDOW_RETURN_ROW;
danb560a712019-03-13 15:29:14 +00002844 }
danb560a712019-03-13 15:29:14 +00002845 break;
danb560a712019-03-13 15:29:14 +00002846 case TK_UNBOUNDED:
2847 if( windowCacheFrame(pMWin)==0 ){
2848 if( pMWin->eEnd==TK_PRECEDING ){
drhfc15f4c2019-03-28 13:03:41 +00002849 if( pMWin->eFrmType!=TK_RANGE
2850 && windowExprGtZero(pParse, pMWin->pEnd)
2851 ){
dan725b1cf2019-03-26 16:47:17 +00002852 s.eDelete = WINDOW_AGGSTEP;
2853 }
danb560a712019-03-13 15:29:14 +00002854 }else{
2855 s.eDelete = WINDOW_RETURN_ROW;
2856 }
2857 }
2858 break;
2859 default:
2860 s.eDelete = WINDOW_AGGINVERSE;
2861 break;
2862 }
2863
dand4461652019-03-13 08:28:51 +00002864 /* Allocate registers for the array of values from the sub-query, the
2865 ** samve values in record form, and the rowid used to insert said record
2866 ** into the ephemeral table. */
dana786e452019-03-11 18:17:04 +00002867 regNew = pParse->nMem+1;
2868 pParse->nMem += nInput;
2869 regRecord = ++pParse->nMem;
drh113a33c2021-04-24 23:40:05 +00002870 s.regRowid = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002871
dana786e452019-03-11 18:17:04 +00002872 /* If the window frame contains an "<expr> PRECEDING" or "<expr> FOLLOWING"
2873 ** clause, allocate registers to store the results of evaluating each
2874 ** <expr>. */
dan54975cd2019-03-07 20:47:46 +00002875 if( pMWin->eStart==TK_PRECEDING || pMWin->eStart==TK_FOLLOWING ){
dane7579a52019-09-25 16:41:44 +00002876 regStart = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002877 }
2878 if( pMWin->eEnd==TK_PRECEDING || pMWin->eEnd==TK_FOLLOWING ){
dane7579a52019-09-25 16:41:44 +00002879 regEnd = ++pParse->nMem;
dan54975cd2019-03-07 20:47:46 +00002880 }
dan680f6e82019-03-04 21:07:11 +00002881
dan72b9fdc2019-03-09 20:49:17 +00002882 /* If this is not a "ROWS BETWEEN ..." frame, then allocate arrays of
dana786e452019-03-11 18:17:04 +00002883 ** registers to store copies of the ORDER BY expressions (peer values)
2884 ** for the main loop, and for each cursor (start, current and end). */
drhfc15f4c2019-03-28 13:03:41 +00002885 if( pMWin->eFrmType!=TK_ROWS ){
dan6c75b392019-03-08 20:02:52 +00002886 int nPeer = (pOrderBy ? pOrderBy->nExpr : 0);
dana786e452019-03-11 18:17:04 +00002887 regNewPeer = regNew + pMWin->nBufferCol;
dan6c75b392019-03-08 20:02:52 +00002888 if( pMWin->pPartition ) regNewPeer += pMWin->pPartition->nExpr;
dan6c75b392019-03-08 20:02:52 +00002889 regPeer = pParse->nMem+1; pParse->nMem += nPeer;
2890 s.start.reg = pParse->nMem+1; pParse->nMem += nPeer;
2891 s.current.reg = pParse->nMem+1; pParse->nMem += nPeer;
2892 s.end.reg = pParse->nMem+1; pParse->nMem += nPeer;
2893 }
2894
dan680f6e82019-03-04 21:07:11 +00002895 /* Load the column values for the row returned by the sub-select
dana786e452019-03-11 18:17:04 +00002896 ** into an array of registers starting at regNew. Assemble them into
2897 ** a record in register regRecord. */
2898 for(iInput=0; iInput<nInput; iInput++){
2899 sqlite3VdbeAddOp3(v, OP_Column, csrInput, iInput, regNew+iInput);
dan680f6e82019-03-04 21:07:11 +00002900 }
dana786e452019-03-11 18:17:04 +00002901 sqlite3VdbeAddOp3(v, OP_MakeRecord, regNew, nInput, regRecord);
dan680f6e82019-03-04 21:07:11 +00002902
danb33487b2019-03-06 17:12:32 +00002903 /* An input row has just been read into an array of registers starting
dana786e452019-03-11 18:17:04 +00002904 ** at regNew. If the window has a PARTITION clause, this block generates
danb33487b2019-03-06 17:12:32 +00002905 ** VM code to check if the input row is the start of a new partition.
2906 ** If so, it does an OP_Gosub to an address to be filled in later. The
dana786e452019-03-11 18:17:04 +00002907 ** address of the OP_Gosub is stored in local variable addrGosubFlush. */
dan680f6e82019-03-04 21:07:11 +00002908 if( pMWin->pPartition ){
2909 int addr;
2910 ExprList *pPart = pMWin->pPartition;
2911 int nPart = pPart->nExpr;
dana786e452019-03-11 18:17:04 +00002912 int regNewPart = regNew + pMWin->nBufferCol;
dan680f6e82019-03-04 21:07:11 +00002913 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pPart, 0, 0);
2914
dand4461652019-03-13 08:28:51 +00002915 regFlushPart = ++pParse->nMem;
dan680f6e82019-03-04 21:07:11 +00002916 addr = sqlite3VdbeAddOp3(v, OP_Compare, regNewPart, pMWin->regPart, nPart);
2917 sqlite3VdbeAppendP4(v, (void*)pKeyInfo, P4_KEYINFO);
danb33487b2019-03-06 17:12:32 +00002918 sqlite3VdbeAddOp3(v, OP_Jump, addr+2, addr+4, addr+2);
dan680f6e82019-03-04 21:07:11 +00002919 VdbeCoverageEqNe(v);
2920 addrGosubFlush = sqlite3VdbeAddOp1(v, OP_Gosub, regFlushPart);
2921 VdbeComment((v, "call flush_partition"));
danb33487b2019-03-06 17:12:32 +00002922 sqlite3VdbeAddOp3(v, OP_Copy, regNewPart, pMWin->regPart, nPart-1);
dan680f6e82019-03-04 21:07:11 +00002923 }
2924
2925 /* Insert the new row into the ephemeral table */
drh113a33c2021-04-24 23:40:05 +00002926 sqlite3VdbeAddOp2(v, OP_NewRowid, csrWrite, s.regRowid);
2927 sqlite3VdbeAddOp3(v, OP_Insert, csrWrite, regRecord, s.regRowid);
2928 addrNe = sqlite3VdbeAddOp3(v, OP_Ne, pMWin->regOne, 0, s.regRowid);
drh83c5bb92019-04-01 15:55:38 +00002929 VdbeCoverageNeverNull(v);
danb25a2142019-03-05 19:29:36 +00002930
danb33487b2019-03-06 17:12:32 +00002931 /* This block is run for the first row of each partition */
dana786e452019-03-11 18:17:04 +00002932 s.regArg = windowInitAccum(pParse, pMWin);
dan680f6e82019-03-04 21:07:11 +00002933
dane7579a52019-09-25 16:41:44 +00002934 if( regStart ){
2935 sqlite3ExprCode(pParse, pMWin->pStart, regStart);
2936 windowCheckValue(pParse, regStart, 0 + (pMWin->eFrmType==TK_RANGE?3:0));
dan54975cd2019-03-07 20:47:46 +00002937 }
dane7579a52019-09-25 16:41:44 +00002938 if( regEnd ){
2939 sqlite3ExprCode(pParse, pMWin->pEnd, regEnd);
2940 windowCheckValue(pParse, regEnd, 1 + (pMWin->eFrmType==TK_RANGE?3:0));
dan54975cd2019-03-07 20:47:46 +00002941 }
danb25a2142019-03-05 19:29:36 +00002942
dane7579a52019-09-25 16:41:44 +00002943 if( pMWin->eFrmType!=TK_RANGE && pMWin->eStart==pMWin->eEnd && regStart ){
danb25a2142019-03-05 19:29:36 +00002944 int op = ((pMWin->eStart==TK_FOLLOWING) ? OP_Ge : OP_Le);
dane7579a52019-09-25 16:41:44 +00002945 int addrGe = sqlite3VdbeAddOp3(v, op, regStart, 0, regEnd);
drh495ed622019-04-01 16:23:21 +00002946 VdbeCoverageNeverNullIf(v, op==OP_Ge); /* NeverNull because bound <expr> */
2947 VdbeCoverageNeverNullIf(v, op==OP_Le); /* values previously checked */
danc782a812019-03-15 20:46:19 +00002948 windowAggFinal(&s, 0);
dancc7a8502019-03-11 19:50:54 +00002949 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002950 VdbeCoverageNeverTaken(v);
danc782a812019-03-15 20:46:19 +00002951 windowReturnOneRow(&s);
dancc7a8502019-03-11 19:50:54 +00002952 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr);
dan935d9d82019-03-12 15:21:51 +00002953 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd);
danb25a2142019-03-05 19:29:36 +00002954 sqlite3VdbeJumpHere(v, addrGe);
2955 }
dane7579a52019-09-25 16:41:44 +00002956 if( pMWin->eStart==TK_FOLLOWING && pMWin->eFrmType!=TK_RANGE && regEnd ){
dan54975cd2019-03-07 20:47:46 +00002957 assert( pMWin->eEnd==TK_FOLLOWING );
dane7579a52019-09-25 16:41:44 +00002958 sqlite3VdbeAddOp3(v, OP_Subtract, regStart, regEnd, regStart);
danb25a2142019-03-05 19:29:36 +00002959 }
2960
dan54975cd2019-03-07 20:47:46 +00002961 if( pMWin->eStart!=TK_UNBOUNDED ){
dan6c75b392019-03-08 20:02:52 +00002962 sqlite3VdbeAddOp2(v, OP_Rewind, s.start.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002963 VdbeCoverageNeverTaken(v);
dan54975cd2019-03-07 20:47:46 +00002964 }
dan6c75b392019-03-08 20:02:52 +00002965 sqlite3VdbeAddOp2(v, OP_Rewind, s.current.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002966 VdbeCoverageNeverTaken(v);
dan6c75b392019-03-08 20:02:52 +00002967 sqlite3VdbeAddOp2(v, OP_Rewind, s.end.csr, 1);
dan1d4b25f2019-03-19 16:49:15 +00002968 VdbeCoverageNeverTaken(v);
dan6c75b392019-03-08 20:02:52 +00002969 if( regPeer && pOrderBy ){
dancc7a8502019-03-11 19:50:54 +00002970 sqlite3VdbeAddOp3(v, OP_Copy, regNewPeer, regPeer, pOrderBy->nExpr-1);
dan6c75b392019-03-08 20:02:52 +00002971 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.start.reg, pOrderBy->nExpr-1);
2972 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.current.reg, pOrderBy->nExpr-1);
2973 sqlite3VdbeAddOp3(v, OP_Copy, regPeer, s.end.reg, pOrderBy->nExpr-1);
2974 }
danb25a2142019-03-05 19:29:36 +00002975
dan935d9d82019-03-12 15:21:51 +00002976 sqlite3VdbeAddOp2(v, OP_Goto, 0, lblWhereEnd);
dan680f6e82019-03-04 21:07:11 +00002977
danbf845152019-03-16 10:15:24 +00002978 sqlite3VdbeJumpHere(v, addrNe);
dan3f49c322019-04-03 16:27:44 +00002979
2980 /* Beginning of the block executed for the second and subsequent rows. */
dan6c75b392019-03-08 20:02:52 +00002981 if( regPeer ){
dan935d9d82019-03-12 15:21:51 +00002982 windowIfNewPeer(pParse, pOrderBy, regNewPeer, regPeer, lblWhereEnd);
dan6c75b392019-03-08 20:02:52 +00002983 }
danb25a2142019-03-05 19:29:36 +00002984 if( pMWin->eStart==TK_FOLLOWING ){
dan6c75b392019-03-08 20:02:52 +00002985 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
dan54975cd2019-03-07 20:47:46 +00002986 if( pMWin->eEnd!=TK_UNBOUNDED ){
drhfc15f4c2019-03-28 13:03:41 +00002987 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00002988 int lbl = sqlite3VdbeMakeLabel(pParse);
2989 int addrNext = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00002990 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl);
2991 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan72b9fdc2019-03-09 20:49:17 +00002992 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
2993 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrNext);
2994 sqlite3VdbeResolveLabel(v, lbl);
2995 }else{
dane7579a52019-09-25 16:41:44 +00002996 windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 0);
2997 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan72b9fdc2019-03-09 20:49:17 +00002998 }
dan54975cd2019-03-07 20:47:46 +00002999 }
danb25a2142019-03-05 19:29:36 +00003000 }else
3001 if( pMWin->eEnd==TK_PRECEDING ){
dan3f49c322019-04-03 16:27:44 +00003002 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE);
dane7579a52019-09-25 16:41:44 +00003003 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0);
3004 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan6c75b392019-03-08 20:02:52 +00003005 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00003006 if( !bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
danb25a2142019-03-05 19:29:36 +00003007 }else{
mistachkinba9ee092019-03-27 14:58:18 +00003008 int addr = 0;
dan6c75b392019-03-08 20:02:52 +00003009 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
dan54975cd2019-03-07 20:47:46 +00003010 if( pMWin->eEnd!=TK_UNBOUNDED ){
drhfc15f4c2019-03-28 13:03:41 +00003011 if( pMWin->eFrmType==TK_RANGE ){
mistachkinba9ee092019-03-27 14:58:18 +00003012 int lbl = 0;
dan72b9fdc2019-03-09 20:49:17 +00003013 addr = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003014 if( regEnd ){
dan72b9fdc2019-03-09 20:49:17 +00003015 lbl = sqlite3VdbeMakeLabel(pParse);
dane7579a52019-09-25 16:41:44 +00003016 windowCodeRangeTest(&s, OP_Ge, s.current.csr, regEnd, s.end.csr, lbl);
dan72b9fdc2019-03-09 20:49:17 +00003017 }
3018 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00003019 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
3020 if( regEnd ){
dan72b9fdc2019-03-09 20:49:17 +00003021 sqlite3VdbeAddOp2(v, OP_Goto, 0, addr);
3022 sqlite3VdbeResolveLabel(v, lbl);
3023 }
3024 }else{
dane7579a52019-09-25 16:41:44 +00003025 if( regEnd ){
3026 addr = sqlite3VdbeAddOp3(v, OP_IfPos, regEnd, 0, 1);
dan1d4b25f2019-03-19 16:49:15 +00003027 VdbeCoverage(v);
3028 }
dan72b9fdc2019-03-09 20:49:17 +00003029 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
dane7579a52019-09-25 16:41:44 +00003030 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
3031 if( regEnd ) sqlite3VdbeJumpHere(v, addr);
dan72b9fdc2019-03-09 20:49:17 +00003032 }
dan54975cd2019-03-07 20:47:46 +00003033 }
danb25a2142019-03-05 19:29:36 +00003034 }
dan680f6e82019-03-04 21:07:11 +00003035
dan680f6e82019-03-04 21:07:11 +00003036 /* End of the main input loop */
dan935d9d82019-03-12 15:21:51 +00003037 sqlite3VdbeResolveLabel(v, lblWhereEnd);
dancc7a8502019-03-11 19:50:54 +00003038 sqlite3WhereEnd(pWInfo);
dan680f6e82019-03-04 21:07:11 +00003039
3040 /* Fall through */
dancc7a8502019-03-11 19:50:54 +00003041 if( pMWin->pPartition ){
dan680f6e82019-03-04 21:07:11 +00003042 addrInteger = sqlite3VdbeAddOp2(v, OP_Integer, 0, regFlushPart);
3043 sqlite3VdbeJumpHere(v, addrGosubFlush);
3044 }
3045
drh113a33c2021-04-24 23:40:05 +00003046 s.regRowid = 0;
danc8137502019-03-07 19:26:17 +00003047 addrEmpty = sqlite3VdbeAddOp1(v, OP_Rewind, csrWrite);
dan1d4b25f2019-03-19 16:49:15 +00003048 VdbeCoverage(v);
dan00267b82019-03-06 21:04:11 +00003049 if( pMWin->eEnd==TK_PRECEDING ){
dan3f49c322019-04-03 16:27:44 +00003050 int bRPS = (pMWin->eStart==TK_PRECEDING && pMWin->eFrmType==TK_RANGE);
dane7579a52019-09-25 16:41:44 +00003051 windowCodeOp(&s, WINDOW_AGGSTEP, regEnd, 0);
3052 if( bRPS ) windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan6c75b392019-03-08 20:02:52 +00003053 windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 0);
danc8137502019-03-07 19:26:17 +00003054 }else if( pMWin->eStart==TK_FOLLOWING ){
3055 int addrStart;
3056 int addrBreak1;
3057 int addrBreak2;
3058 int addrBreak3;
dan6c75b392019-03-08 20:02:52 +00003059 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
drhfc15f4c2019-03-28 13:03:41 +00003060 if( pMWin->eFrmType==TK_RANGE ){
dan72b9fdc2019-03-09 20:49:17 +00003061 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003062 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1);
dan72b9fdc2019-03-09 20:49:17 +00003063 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
3064 }else
dan54975cd2019-03-07 20:47:46 +00003065 if( pMWin->eEnd==TK_UNBOUNDED ){
3066 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003067 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regStart, 1);
dan6c75b392019-03-08 20:02:52 +00003068 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, 0, 1);
dan54975cd2019-03-07 20:47:46 +00003069 }else{
3070 assert( pMWin->eEnd==TK_FOLLOWING );
3071 addrStart = sqlite3VdbeCurrentAddr(v);
dane7579a52019-09-25 16:41:44 +00003072 addrBreak1 = windowCodeOp(&s, WINDOW_RETURN_ROW, regEnd, 1);
3073 addrBreak2 = windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 1);
dan54975cd2019-03-07 20:47:46 +00003074 }
danc8137502019-03-07 19:26:17 +00003075 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3076 sqlite3VdbeJumpHere(v, addrBreak2);
3077 addrStart = sqlite3VdbeCurrentAddr(v);
dan6c75b392019-03-08 20:02:52 +00003078 addrBreak3 = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
danc8137502019-03-07 19:26:17 +00003079 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3080 sqlite3VdbeJumpHere(v, addrBreak1);
3081 sqlite3VdbeJumpHere(v, addrBreak3);
danb25a2142019-03-05 19:29:36 +00003082 }else{
dan00267b82019-03-06 21:04:11 +00003083 int addrBreak;
danc8137502019-03-07 19:26:17 +00003084 int addrStart;
dan6c75b392019-03-08 20:02:52 +00003085 windowCodeOp(&s, WINDOW_AGGSTEP, 0, 0);
danc8137502019-03-07 19:26:17 +00003086 addrStart = sqlite3VdbeCurrentAddr(v);
dan6c75b392019-03-08 20:02:52 +00003087 addrBreak = windowCodeOp(&s, WINDOW_RETURN_ROW, 0, 1);
dane7579a52019-09-25 16:41:44 +00003088 windowCodeOp(&s, WINDOW_AGGINVERSE, regStart, 0);
dan00267b82019-03-06 21:04:11 +00003089 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrStart);
3090 sqlite3VdbeJumpHere(v, addrBreak);
danb25a2142019-03-05 19:29:36 +00003091 }
danc8137502019-03-07 19:26:17 +00003092 sqlite3VdbeJumpHere(v, addrEmpty);
3093
dan6c75b392019-03-08 20:02:52 +00003094 sqlite3VdbeAddOp1(v, OP_ResetSorter, s.current.csr);
dan680f6e82019-03-04 21:07:11 +00003095 if( pMWin->pPartition ){
dana0f6b832019-03-14 16:36:20 +00003096 if( pMWin->regStartRowid ){
3097 sqlite3VdbeAddOp2(v, OP_Integer, 1, pMWin->regStartRowid);
3098 sqlite3VdbeAddOp2(v, OP_Integer, 0, pMWin->regEndRowid);
3099 }
dan680f6e82019-03-04 21:07:11 +00003100 sqlite3VdbeChangeP1(v, addrInteger, sqlite3VdbeCurrentAddr(v));
3101 sqlite3VdbeAddOp1(v, OP_Return, regFlushPart);
3102 }
3103}
3104
dan67a9b8e2018-06-22 20:51:35 +00003105#endif /* SQLITE_OMIT_WINDOWFUNC */