-
Notifications
You must be signed in to change notification settings - Fork 379
/
vdbeaux.c
3863 lines (3664 loc) · 99.8 KB
/
vdbeaux.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2010-2017, Tarantool AUTHORS, please see AUTHORS file.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* 1. Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This file contains code used for creating, destroying, and populating
* a VDBE (or an "sqlite3_stmt" as it is known to the outside world.)
*/
#include "fiber.h"
#include "coll.h"
#include "box/session.h"
#include "box/schema.h"
#include "box/tuple_format.h"
#include "box/txn.h"
#include "msgpuck/msgpuck.h"
#include "sqliteInt.h"
#include "vdbeInt.h"
#include "tarantoolInt.h"
/*
* Create a new virtual database engine.
*/
Vdbe *
sqlite3VdbeCreate(Parse * pParse)
{
sqlite3 *db = pParse->db;
Vdbe *p;
p = sqlite3DbMallocRawNN(db, sizeof(Vdbe));
if (p == 0)
return 0;
memset(p, 0, sizeof(Vdbe));
p->db = db;
stailq_create(&p->autoinc_id_list);
if (db->pVdbe) {
db->pVdbe->pPrev = p;
}
p->pNext = db->pVdbe;
p->pPrev = 0;
db->pVdbe = p;
p->magic = VDBE_MAGIC_INIT;
p->pParse = pParse;
p->schema_ver = box_schema_version();
assert(pParse->aLabel == 0);
assert(pParse->nLabel == 0);
assert(pParse->nOpAlloc == 0);
assert(pParse->szOpAlloc == 0);
return p;
}
struct sql_txn *
sql_alloc_txn(struct Vdbe *v)
{
struct sql_txn *txn = region_alloc_object(&fiber()->gc,
struct sql_txn);
if (txn == NULL) {
diag_set(OutOfMemory, sizeof(struct sql_txn), "region",
"struct sql_txn");
return NULL;
}
txn->vdbe = v;
txn->pSavepoint = NULL;
txn->fk_deferred_count = 0;
return txn;
}
int
sql_vdbe_prepare(struct Vdbe *vdbe)
{
assert(vdbe != NULL);
struct txn *txn = in_txn();
vdbe->auto_commit = txn == NULL;
if (txn != NULL) {
/*
* If transaction has been started in Lua, then
* sql_txn is NULL. On the other hand, it is not
* critical, since in Lua it is impossible to
* check FK violations, at least now.
*/
if (txn->psql_txn == NULL) {
txn->psql_txn = sql_alloc_txn(vdbe);
if (txn->psql_txn == NULL)
return -1;
}
}
return 0;
}
/*
* Change the error string stored in Vdbe.zErrMsg
*/
void
sqlite3VdbeError(Vdbe * p, const char *zFormat, ...)
{
va_list ap;
sqlite3DbFree(p->db, p->zErrMsg);
va_start(ap, zFormat);
p->zErrMsg = sqlite3VMPrintf(p->db, zFormat, ap);
va_end(ap);
}
/*
* Remember the SQL string for a prepared statement.
*/
void
sqlite3VdbeSetSql(Vdbe * p, const char *z, int n, int isPrepareV2)
{
assert(isPrepareV2 == 1 || isPrepareV2 == 0);
if (p == 0)
return;
#if defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_ENABLE_SQLLOG)
if (!isPrepareV2)
return;
#endif
assert(p->zSql == 0);
p->zSql = sqlite3DbStrNDup(p->db, z, n);
p->isPrepareV2 = (u8) isPrepareV2;
}
/*
* Swap all content between two VDBE structures.
*/
void
sqlite3VdbeSwap(Vdbe * pA, Vdbe * pB)
{
Vdbe tmp, *pTmp;
char *zTmp;
assert(pA->db == pB->db);
tmp = *pA;
*pA = *pB;
*pB = tmp;
pTmp = pA->pNext;
pA->pNext = pB->pNext;
pB->pNext = pTmp;
pTmp = pA->pPrev;
pA->pPrev = pB->pPrev;
pB->pPrev = pTmp;
zTmp = pA->zSql;
pA->zSql = pB->zSql;
pB->zSql = zTmp;
pB->isPrepareV2 = pA->isPrepareV2;
}
/*
* Resize the Vdbe.aOp array so that it is at least nOp elements larger
* than its current size. nOp is guaranteed to be less than or equal
* to 1024/sizeof(Op).
*
* If an out-of-memory error occurs while resizing the array, return
* SQLITE_NOMEM. In this case Vdbe.aOp and Parse.nOpAlloc remain
* unchanged (this is so that any opcodes already allocated can be
* correctly deallocated along with the rest of the Vdbe).
*/
static int
growOpArray(Vdbe * v, int nOp)
{
VdbeOp *pNew;
Parse *p = v->pParse;
/* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
* more frequent reallocs and hence provide more opportunities for
* simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
* during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
* by the minimum* amount required until the size reaches 512. Normal
* operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
* size of the op array or add 1KB of space, whichever is smaller.
*/
#ifdef SQLITE_TEST_REALLOC_STRESS
int nNew = (p->nOpAlloc >= 512 ? p->nOpAlloc * 2 : p->nOpAlloc + nOp);
#else
int nNew = (p->nOpAlloc ? p->nOpAlloc * 2 : (int)(1024 / sizeof(Op)));
UNUSED_PARAMETER(nOp);
#endif
assert((unsigned)nOp <= (1024 / sizeof(Op)));
assert(nNew >= (p->nOpAlloc + nOp));
pNew = sqlite3DbRealloc(p->db, v->aOp, nNew * sizeof(Op));
if (pNew) {
p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
p->nOpAlloc = p->szOpAlloc / sizeof(Op);
v->aOp = pNew;
}
return (pNew ? SQLITE_OK : SQLITE_NOMEM_BKPT);
}
#ifdef SQLITE_DEBUG
/* This routine is just a convenient place to set a breakpoint that will
* fire after each opcode is inserted and displayed using
* "PRAGMA vdbe_addoptrace=on".
*/
static void
test_addop_breakpoint(void)
{
static int n = 0;
n++;
}
#endif
/*
* Add a new instruction to the list of instructions current in the
* VDBE. Return the address of the new instruction.
*
* Parameters:
*
* p Pointer to the VDBE
*
* op The opcode for this instruction
*
* p1, p2, p3 Operands
*
* Use the sqlite3VdbeResolveLabel() function to fix an address and
* the sqlite3VdbeChangeP4() function to change the value of the P4
* operand.
*/
static SQLITE_NOINLINE int
growOp3(Vdbe * p, int op, int p1, int p2, int p3)
{
assert(p->pParse->nOpAlloc <= p->nOp);
if (growOpArray(p, 1))
return 1;
assert(p->pParse->nOpAlloc > p->nOp);
return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
}
int
sqlite3VdbeAddOp3(Vdbe * p, int op, int p1, int p2, int p3)
{
int i;
VdbeOp *pOp;
struct session MAYBE_UNUSED *user_session;
user_session = current_session();
i = p->nOp;
assert(p->magic == VDBE_MAGIC_INIT);
assert(op >= 0 && op < 0xff);
if (p->pParse->nOpAlloc <= i) {
return growOp3(p, op, p1, p2, p3);
}
p->nOp++;
pOp = &p->aOp[i];
pOp->opcode = (u8) op;
pOp->p5 = 0;
pOp->p1 = p1;
pOp->p2 = p2;
pOp->p3 = p3;
pOp->p4.p = 0;
pOp->p4type = P4_NOTUSED;
#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
pOp->zComment = 0;
#endif
#ifdef SQLITE_DEBUG
if (user_session->sql_flags & SQLITE_VdbeAddopTrace) {
int jj, kk;
Parse *pParse = p->pParse;
for (jj = kk = 0; jj < pParse->nColCache; jj++) {
struct yColCache *x = pParse->aColCache + jj;
printf(" r[%d]={%d:%d}", x->iReg, x->iTable,
x->iColumn);
kk++;
}
if (kk)
printf("\n");
sqlite3VdbePrintOp(0, i, &p->aOp[i]);
test_addop_breakpoint();
}
#endif
#ifdef VDBE_PROFILE
pOp->cycles = 0;
pOp->cnt = 0;
#endif
#ifdef SQLITE_VDBE_COVERAGE
pOp->iSrcLine = 0;
#endif
return i;
}
int
sqlite3VdbeAddOp0(Vdbe * p, int op)
{
return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
}
int
sqlite3VdbeAddOp1(Vdbe * p, int op, int p1)
{
return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
}
int
sqlite3VdbeAddOp2(Vdbe * p, int op, int p1, int p2)
{
return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
}
/* Generate code for an unconditional jump to instruction iDest
*/
int
sqlite3VdbeGoto(Vdbe * p, int iDest)
{
return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
}
/* Generate code to cause the string zStr to be loaded into
* register iDest
*/
int
sqlite3VdbeLoadString(Vdbe * p, int iDest, const char *zStr)
{
return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
}
/*
* Generate code that initializes multiple registers to string or integer
* constants. The registers begin with iDest and increase consecutively.
* One register is initialized for each character in zTypes[]. For each
* "s" character in zTypes[], the register is a string if the argument is
* not NULL, or OP_Null if the value is a null pointer. For each "i" character
* in zTypes[], the register is initialized to an integer.
*/
void
sqlite3VdbeMultiLoad(Vdbe * p, int iDest, const char *zTypes, ...)
{
va_list ap;
int i;
char c;
va_start(ap, zTypes);
for (i = 0; (c = zTypes[i]) != 0; i++) {
if (c == 's') {
const char *z = va_arg(ap, const char *);
sqlite3VdbeAddOp4(p, z == 0 ? OP_Null : OP_String8, 0,
iDest++, 0, z, 0);
} else {
assert(c == 'i');
sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int),
iDest++);
}
}
va_end(ap);
}
/*
* Add an opcode that includes the p4 value as a pointer.
*/
int
sqlite3VdbeAddOp4(Vdbe * p, /* Add the opcode to this VM */
int op, /* The new opcode */
int p1, /* The P1 operand */
int p2, /* The P2 operand */
int p3, /* The P3 operand */
const char *zP4, /* The P4 operand */
int p4type) /* P4 operand type */
{
int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
sqlite3VdbeChangeP4(p, addr, zP4, p4type);
return addr;
}
/*
* Add an opcode that includes the p4 value with a P4_INT64 or
* P4_REAL type.
*/
int
sqlite3VdbeAddOp4Dup8(Vdbe * p, /* Add the opcode to this VM */
int op, /* The new opcode */
int p1, /* The P1 operand */
int p2, /* The P2 operand */
int p3, /* The P3 operand */
const u8 * zP4, /* The P4 operand */
int p4type /* P4 operand type */
)
{
char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
if (p4copy)
memcpy(p4copy, zP4, 8);
return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
}
/*
* Add an opcode that includes the p4 value as an integer.
*/
int
sqlite3VdbeAddOp4Int(Vdbe * p, /* Add the opcode to this VM */
int op, /* The new opcode */
int p1, /* The P1 operand */
int p2, /* The P2 operand */
int p3, /* The P3 operand */
int p4) /* The P4 operand as an integer */
{
int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
if (p->db->mallocFailed == 0) {
VdbeOp *pOp = &p->aOp[addr];
pOp->p4type = P4_INT32;
pOp->p4.i = p4;
}
return addr;
}
/* Insert the end of a co-routine
*/
void
sqlite3VdbeEndCoroutine(Vdbe * v, int regYield)
{
sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
/* Clear the temporary register cache, thereby ensuring that each
* co-routine has its own independent set of registers, because co-routines
* might expect their registers to be preserved across an OP_Yield, and
* that could cause problems if two or more co-routines are using the same
* temporary register.
*/
v->pParse->nTempReg = 0;
v->pParse->nRangeReg = 0;
}
/*
* Create a new symbolic label for an instruction that has yet to be
* coded. The symbolic label is really just a negative number. The
* label can be used as the P2 value of an operation. Later, when
* the label is resolved to a specific address, the VDBE will scan
* through its operation list and change all values of P2 which match
* the label into the resolved address.
*
* The VDBE knows that a P2 value is a label because labels are
* always negative and P2 values are suppose to be non-negative.
* Hence, a negative P2 value is a label that has yet to be resolved.
*
* Zero is returned if a malloc() fails.
*/
int
sqlite3VdbeMakeLabel(Vdbe * v)
{
Parse *p = v->pParse;
int i = p->nLabel++;
assert(v->magic == VDBE_MAGIC_INIT);
if ((i & (i - 1)) == 0) {
p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
(i * 2 +
1) * sizeof(p->aLabel[0]));
}
if (p->aLabel) {
p->aLabel[i] = -1;
}
return ADDR(i);
}
/*
* Resolve label "x" to be the address of the next instruction to
* be inserted. The parameter "x" must have been obtained from
* a prior call to sqlite3VdbeMakeLabel().
*/
void
sqlite3VdbeResolveLabel(Vdbe * v, int x)
{
Parse *p = v->pParse;
int j = ADDR(x);
assert(v->magic == VDBE_MAGIC_INIT);
assert(j < p->nLabel);
assert(j >= 0);
if (p->aLabel) {
p->aLabel[j] = v->nOp;
}
}
/*
* Mark the VDBE as one that can only be run one time.
*/
void
sqlite3VdbeRunOnlyOnce(Vdbe * p)
{
p->runOnlyOnce = 1;
}
#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
/*
* The following type and function are used to iterate through all opcodes
* in a Vdbe main program and each of the sub-programs (triggers) it may
* invoke directly or indirectly. It should be used as follows:
*
* Op *pOp;
* VdbeOpIter sIter;
*
* memset(&sIter, 0, sizeof(sIter));
* sIter.v = v; // v is of type Vdbe*
* while( (pOp = opIterNext(&sIter)) ){
* // Do something with pOp
* }
* sqlite3DbFree(v->db, sIter.apSub);
*
*/
typedef struct VdbeOpIter VdbeOpIter;
struct VdbeOpIter {
Vdbe *v; /* Vdbe to iterate through the opcodes of */
SubProgram **apSub; /* Array of subprograms */
int nSub; /* Number of entries in apSub */
int iAddr; /* Address of next instruction to return */
int iSub; /* 0 = main program, 1 = first sub-program etc. */
};
static Op *
opIterNext(VdbeOpIter * p)
{
Vdbe *v = p->v;
Op *pRet = 0;
Op *aOp;
int nOp;
if (p->iSub <= p->nSub) {
if (p->iSub == 0) {
aOp = v->aOp;
nOp = v->nOp;
} else {
aOp = p->apSub[p->iSub - 1]->aOp;
nOp = p->apSub[p->iSub - 1]->nOp;
}
assert(p->iAddr < nOp);
pRet = &aOp[p->iAddr];
p->iAddr++;
if (p->iAddr == nOp) {
p->iSub++;
p->iAddr = 0;
}
if (pRet->p4type == P4_SUBPROGRAM) {
int nByte = (p->nSub + 1) * sizeof(SubProgram *);
int j;
for (j = 0; j < p->nSub; j++) {
if (p->apSub[j] == pRet->p4.pProgram)
break;
}
if (j == p->nSub) {
p->apSub =
sqlite3DbReallocOrFree(v->db, p->apSub,
nByte);
if (!p->apSub) {
pRet = 0;
} else {
p->apSub[p->nSub++] = pRet->p4.pProgram;
}
}
}
}
return pRet;
}
/*
* Check if the program stored in the VM associated with pParse may
* throw an ABORT exception (causing the statement, but not entire transaction
* to be rolled back). This condition is true if the main program or any
* sub-programs contains any of the following:
*
* * OP_Halt with P1=SQLITE_CONSTRAINT and P2=ON_CONFLICT_ACTION_ABORT.
* * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=ON_CONFLICT_ACTION_ABORT.
* * OP_FkCounter with P2==0 (immediate foreign key constraint)
*
* Then check that the value of Parse.mayAbort is true if an
* ABORT may be thrown, or false otherwise. Return true if it does
* match, or false otherwise. This function is intended to be used as
* part of an assert statement in the compiler. Similar to:
*
* assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
*/
int
sqlite3VdbeAssertMayAbort(Vdbe * v, int mayAbort)
{
int hasAbort = 0;
int hasFkCounter = 0;
Op *pOp;
VdbeOpIter sIter;
memset(&sIter, 0, sizeof(sIter));
sIter.v = v;
while ((pOp = opIterNext(&sIter)) != 0) {
int opcode = pOp->opcode;
if ((opcode == OP_Halt || opcode == OP_HaltIfNull) &&
(pOp->p1 & 0xff) == SQLITE_CONSTRAINT &&
pOp->p2 == ON_CONFLICT_ACTION_ABORT){
hasAbort = 1;
break;
}
if (opcode == OP_FkCounter && pOp->p1 == 0 && pOp->p2 == 1) {
hasFkCounter = 1;
}
}
sqlite3DbFree(v->db, sIter.apSub);
/* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
* If malloc failed, then the while() loop above may not have iterated
* through all opcodes and hasAbort may be set incorrectly. Return
* true for this case to prevent the assert() in the callers frame
* from failing.
*/
return (v->db->mallocFailed || hasAbort == mayAbort || hasFkCounter);
}
#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
/*
* This routine is called after all opcodes have been inserted. It loops
* through all the opcodes and fixes up some details.
*
* (1) For each jump instruction with a negative P2 value (a label)
* resolve the P2 value to an actual address.
*
* (2) Compute the maximum number of arguments used by any SQL function
* and store that value in *pMaxFuncArgs.
*
* (3) Initialize the p4.xAdvance pointer on opcodes that use it.
*
* (4) Reclaim the memory allocated for storing labels.
*
* This routine will only function correctly if the mkopcodeh.sh generator
* script numbers the opcodes correctly. Changes to this routine must be
* coordinated with changes to mkopcodeh.sh.
*/
static void
resolveP2Values(Vdbe * p, int *pMaxFuncArgs)
{
int nMaxArgs = *pMaxFuncArgs;
Op *pOp;
Parse *pParse = p->pParse;
int *aLabel = pParse->aLabel;
pOp = &p->aOp[p->nOp - 1];
while (1) {
/* Only JUMP opcodes and the short list of special opcodes in the switch
* below need to be considered. The mkopcodeh.sh generator script groups
* all these opcodes together near the front of the opcode list. Skip
* any opcode that does not need processing by virtual of the fact that
* it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
*/
if (pOp->opcode <= SQLITE_MX_JUMP_OPCODE) {
/* NOTE: Be sure to update mkopcodeh.sh when adding or removing
* cases from this switch!
*/
switch (pOp->opcode) {
case OP_Next:
case OP_NextIfOpen:
case OP_SorterNext:{
pOp->p4.xAdvance = sqlite3CursorNext;
pOp->p4type = P4_ADVANCE;
break;
}
case OP_Prev:
case OP_PrevIfOpen:{
pOp->p4.xAdvance = sqlite3CursorPrevious;
pOp->p4type = P4_ADVANCE;
break;
}
}
if ((sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP) !=
0 && pOp->p2 < 0) {
assert(ADDR(pOp->p2) < pParse->nLabel);
pOp->p2 = aLabel[ADDR(pOp->p2)];
}
}
if (pOp == p->aOp)
break;
pOp--;
}
sqlite3DbFree(p->db, pParse->aLabel);
pParse->aLabel = 0;
pParse->nLabel = 0;
*pMaxFuncArgs = nMaxArgs;
}
/*
* Return the address of the next instruction to be inserted.
*/
int
sqlite3VdbeCurrentAddr(Vdbe * p)
{
assert(p->magic == VDBE_MAGIC_INIT);
return p->nOp;
}
/*
* Verify that the VM passed as the only argument does not contain
* an OP_ResultRow opcode. Fail an assert() if it does. This is used
* by code in pragma.c to ensure that the implementation of certain
* pragmas comports with the flags specified in the mkpragmatab.tcl
* script.
*/
#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
void
sqlite3VdbeVerifyNoResultRow(Vdbe * p)
{
int i;
for (i = 0; i < p->nOp; i++) {
assert(p->aOp[i].opcode != OP_ResultRow);
}
}
#endif
/*
* This function returns a pointer to the array of opcodes associated with
* the Vdbe passed as the first argument. It is the callers responsibility
* to arrange for the returned array to be eventually freed using the
* vdbeFreeOpArray() function.
*
* Before returning, *pnOp is set to the number of entries in the returned
* array. Also, *pnMaxArg is set to the larger of its current value and
* the number of entries in the Vdbe.apArg[] array required to execute the
* returned program.
*/
VdbeOp *
sqlite3VdbeTakeOpArray(Vdbe * p, int *pnOp, int *pnMaxArg)
{
VdbeOp *aOp = p->aOp;
assert(aOp && !p->db->mallocFailed);
resolveP2Values(p, pnMaxArg);
*pnOp = p->nOp;
p->aOp = 0;
return aOp;
}
#if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
/*
* Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
*/
void
sqlite3VdbeScanStatus(Vdbe * p, /* VM to add scanstatus() to */
int addrExplain, /* Address of OP_Explain (or 0) */
int addrLoop, /* Address of loop counter */
int addrVisit, /* Address of rows visited counter */
LogEst nEst, /* Estimated number of output rows */
const char *zName) /* Name of table or index being scanned */
{
int nByte = (p->nScan + 1) * sizeof(ScanStatus);
ScanStatus *aNew;
aNew = (ScanStatus *) sqlite3DbRealloc(p->db, p->aScan, nByte);
if (aNew) {
ScanStatus *pNew = &aNew[p->nScan++];
pNew->addrExplain = addrExplain;
pNew->addrLoop = addrLoop;
pNew->addrVisit = addrVisit;
pNew->nEst = nEst;
pNew->zName = sqlite3DbStrDup(p->db, zName);
p->aScan = aNew;
}
}
#endif
/*
* Change the value of the opcode, or P1, P2, P3, or P5 operands
* for a specific instruction.
*/
void
sqlite3VdbeChangeOpcode(Vdbe * p, u32 addr, u8 iNewOpcode)
{
sqlite3VdbeGetOp(p, addr)->opcode = iNewOpcode;
}
void
sqlite3VdbeChangeP1(Vdbe * p, u32 addr, int val)
{
sqlite3VdbeGetOp(p, addr)->p1 = val;
}
void
sqlite3VdbeChangeP2(Vdbe * p, u32 addr, int val)
{
sqlite3VdbeGetOp(p, addr)->p2 = val;
}
void
sqlite3VdbeChangeP3(Vdbe * p, u32 addr, int val)
{
sqlite3VdbeGetOp(p, addr)->p3 = val;
}
void
sqlite3VdbeChangeP5(Vdbe * p, int p5)
{
assert(p->nOp > 0 || p->db->mallocFailed);
if (p->nOp > 0)
p->aOp[p->nOp - 1].p5 = p5;
}
/*
* Change the P2 operand of instruction addr so that it points to
* the address of the next instruction to be coded.
*/
void
sqlite3VdbeJumpHere(Vdbe * p, int addr)
{
sqlite3VdbeChangeP2(p, addr, p->nOp);
}
/*
* If the input FuncDef structure is ephemeral, then free it. If
* the FuncDef is not ephermal, then do nothing.
*/
static void
freeEphemeralFunction(sqlite3 * db, FuncDef * pDef)
{
if ((pDef->funcFlags & SQLITE_FUNC_EPHEM) != 0) {
sqlite3DbFree(db, pDef);
}
}
static void vdbeFreeOpArray(sqlite3 *, Op *, int);
/*
* Delete a P4 value if necessary.
*/
static SQLITE_NOINLINE void
freeP4Mem(sqlite3 * db, Mem * p)
{
if (p->szMalloc)
sqlite3DbFree(db, p->zMalloc);
sqlite3DbFree(db, p);
}
static SQLITE_NOINLINE void
freeP4FuncCtx(sqlite3 * db, sqlite3_context * p)
{
freeEphemeralFunction(db, p->pFunc);
sqlite3DbFree(db, p);
}
static void
freeP4(sqlite3 * db, int p4type, void *p4)
{
assert(db);
switch (p4type) {
case P4_FUNCCTX:{
freeP4FuncCtx(db, (sqlite3_context *) p4);
break;
}
case P4_REAL:
case P4_INT64:
case P4_DYNAMIC:
case P4_INTARRAY:{
sqlite3DbFree(db, p4);
break;
}
case P4_KEYINFO:
sql_key_info_unref(p4);
break;
case P4_FUNCDEF:{
freeEphemeralFunction(db, (FuncDef *) p4);
break;
}
case P4_MEM:{
if (db->pnBytesFreed == 0) {
sqlite3ValueFree((sqlite3_value *) p4);
} else {
freeP4Mem(db, (Mem *) p4);
}
break;
}
}
}
/*
* Free the space allocated for aOp and any p4 values allocated for the
* opcodes contained within. If aOp is not NULL it is assumed to contain
* nOp entries.
*/
static void
vdbeFreeOpArray(sqlite3 * db, Op * aOp, int nOp)
{
if (aOp) {
Op *pOp;
for (pOp = aOp; pOp < &aOp[nOp]; pOp++) {
if (pOp->p4type)
freeP4(db, pOp->p4type, pOp->p4.p);
#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
sqlite3DbFree(db, pOp->zComment);
#endif
}
}
sqlite3DbFree(db, aOp);
}
/*
* Link the SubProgram object passed as the second argument into the linked
* list at Vdbe.pSubProgram. This list is used to delete all sub-program
* objects when the VM is no longer required.
*/
void
sqlite3VdbeLinkSubProgram(Vdbe * pVdbe, SubProgram * p)
{
p->pNext = pVdbe->pProgram;
pVdbe->pProgram = p;
}
/*
* Change the opcode at addr into OP_Noop
*/
int
sqlite3VdbeChangeToNoop(Vdbe * p, int addr)
{
VdbeOp *pOp;
if (p->db->mallocFailed)
return 0;
assert(addr >= 0 && addr < p->nOp);
pOp = &p->aOp[addr];
freeP4(p->db, pOp->p4type, pOp->p4.p);
pOp->p4type = P4_NOTUSED;
pOp->p4.z = 0;
pOp->opcode = OP_Noop;
return 1;
}
/*
* If the last opcode is "op" and it is not a jump destination,
* then remove it. Return true if and only if an opcode was removed.
*/
int
sqlite3VdbeDeletePriorOpcode(Vdbe * p, u8 op)
{
if (p->nOp > 0 && p->aOp[p->nOp - 1].opcode == op) {
return sqlite3VdbeChangeToNoop(p, p->nOp - 1);
} else {
return 0;
}
}
/*
* Change the value of the P4 operand for a specific instruction.
*
* If n>=0 then the P4 operand is dynamic, meaning that a copy of
* the string is made into memory obtained from sqlite3_malloc().
* A value of n==0 means copy bytes of zP4 up to and including the
* first null byte. If n>0 then copy n+1 bytes of zP4.
*
* Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
* to a string or structure that is guaranteed to exist for the lifetime of
* the Vdbe. In these cases we can just copy the pointer.
*
* If addr<0 then change P4 on the most recently inserted instruction.
*/
static void SQLITE_NOINLINE
vdbeChangeP4Full(Vdbe * p, Op * pOp, const char *zP4, int n)
{
if (pOp->p4type) {
freeP4(p->db, pOp->p4type, pOp->p4.p);
pOp->p4type = 0;
pOp->p4.p = 0;
}
if (n < 0) {
sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
} else {
if (n == 0)
n = sqlite3Strlen30(zP4);
pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
pOp->p4type = P4_DYNAMIC;
}
}
void
sqlite3VdbeChangeP4(Vdbe * p, int addr, const char *zP4, int n)
{
Op *pOp;
sqlite3 *db;
assert(p != 0);
db = p->db;
assert(p->magic == VDBE_MAGIC_INIT);
assert(p->aOp != 0 || db->mallocFailed);
if (db->mallocFailed) {
freeP4(db, n, (void *)*(char **)&zP4);
return;
}
assert(p->nOp > 0);
assert(addr < p->nOp);
if (addr < 0) {
addr = p->nOp - 1;