/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact f20886fba4a15d816014c52e652b5a9f30bf0be3:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 35 0a 2a 2a 0a 2a 2a 20 54 68  mber 15.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 0a 2a 2a 20 48 65 61 64 65 72  ******.** Header
0180: 20 66 69 6c 65 20 66 6f 72 20 74 68 65 20 56 69   file for the Vi
0190: 72 74 75 61 6c 20 44 61 74 61 42 61 73 65 20 45  rtual DataBase E
01a0: 6e 67 69 6e 65 20 28 56 44 42 45 29 0a 2a 2a 0a  ngine (VDBE).**.
01b0: 2a 2a 20 54 68 69 73 20 68 65 61 64 65 72 20 64  ** This header d
01c0: 65 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65 72  efines the inter
01d0: 66 61 63 65 20 74 6f 20 74 68 65 20 76 69 72 74  face to the virt
01e0: 75 61 6c 20 64 61 74 61 62 61 73 65 20 65 6e 67  ual database eng
01f0: 69 6e 65 0a 2a 2a 20 6f 72 20 56 44 42 45 2e 20  ine.** or VDBE. 
0200: 20 54 68 65 20 56 44 42 45 20 69 6d 70 6c 65 6d   The VDBE implem
0210: 65 6e 74 73 20 61 6e 20 61 62 73 74 72 61 63 74  ents an abstract
0220: 20 6d 61 63 68 69 6e 65 20 74 68 61 74 20 72 75   machine that ru
0230: 6e 73 20 61 0a 2a 2a 20 73 69 6d 70 6c 65 20 70  ns a.** simple p
0240: 72 6f 67 72 61 6d 20 74 6f 20 61 63 63 65 73 73  rogram to access
0250: 20 61 6e 64 20 6d 6f 64 69 66 79 20 74 68 65 20   and modify the 
0260: 75 6e 64 65 72 6c 79 69 6e 67 20 64 61 74 61 62  underlying datab
0270: 61 73 65 2e 0a 2a 2a 0a 2a 2a 20 24 49 64 3a 20  ase..**.** $Id: 
0280: 76 64 62 65 2e 68 2c 76 20 31 2e 31 30 37 20 32  vdbe.h,v 1.107 2
0290: 30 30 37 2f 30 31 2f 30 38 20 32 31 3a 30 37 3a  007/01/08 21:07:
02a0: 31 38 20 64 72 68 20 45 78 70 20 24 0a 2a 2f 0a  18 drh Exp $.*/.
02b0: 23 69 66 6e 64 65 66 20 5f 53 51 4c 49 54 45 5f  #ifndef _SQLITE_
02c0: 56 44 42 45 5f 48 5f 0a 23 64 65 66 69 6e 65 20  VDBE_H_.#define 
02d0: 5f 53 51 4c 49 54 45 5f 56 44 42 45 5f 48 5f 0a  _SQLITE_VDBE_H_.
02e0: 23 69 6e 63 6c 75 64 65 20 3c 73 74 64 69 6f 2e  #include <stdio.
02f0: 68 3e 0a 0a 2f 2a 0a 2a 2a 20 41 20 73 69 6e 67  h>../*.** A sing
0300: 6c 65 20 56 44 42 45 20 69 73 20 61 6e 20 6f 70  le VDBE is an op
0310: 61 71 75 65 20 73 74 72 75 63 74 75 72 65 20 6e  aque structure n
0320: 61 6d 65 64 20 22 56 64 62 65 22 2e 20 20 4f 6e  amed "Vdbe".  On
0330: 6c 79 20 72 6f 75 74 69 6e 65 73 0a 2a 2a 20 69  ly routines.** i
0340: 6e 20 74 68 65 20 73 6f 75 72 63 65 20 66 69 6c  n the source fil
0350: 65 20 73 71 6c 69 74 65 56 64 62 65 2e 63 20 61  e sqliteVdbe.c a
0360: 72 65 20 61 6c 6c 6f 77 65 64 20 74 6f 20 73 65  re allowed to se
0370: 65 20 74 68 65 20 69 6e 73 69 64 65 73 0a 2a 2a  e the insides.**
0380: 20 6f 66 20 74 68 69 73 20 73 74 72 75 63 74 75   of this structu
0390: 72 65 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73  re..*/.typedef s
03a0: 74 72 75 63 74 20 56 64 62 65 20 56 64 62 65 3b  truct Vdbe Vdbe;
03b0: 0a 0a 2f 2a 0a 2a 2a 20 41 20 73 69 6e 67 6c 65  ../*.** A single
03c0: 20 69 6e 73 74 72 75 63 74 69 6f 6e 20 6f 66 20   instruction of 
03d0: 74 68 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68  the virtual mach
03e0: 69 6e 65 20 68 61 73 20 61 6e 20 6f 70 63 6f 64  ine has an opcod
03f0: 65 0a 2a 2a 20 61 6e 64 20 61 73 20 6d 61 6e 79  e.** and as many
0400: 20 61 73 20 74 68 72 65 65 20 6f 70 65 72 61 6e   as three operan
0410: 64 73 2e 20 20 54 68 65 20 69 6e 73 74 72 75 63  ds.  The instruc
0420: 74 69 6f 6e 20 69 73 20 72 65 63 6f 72 64 65 64  tion is recorded
0430: 0a 2a 2a 20 61 73 20 61 6e 20 69 6e 73 74 61 6e  .** as an instan
0440: 63 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77  ce of the follow
0450: 69 6e 67 20 73 74 72 75 63 74 75 72 65 3a 0a 2a  ing structure:.*
0460: 2f 0a 73 74 72 75 63 74 20 56 64 62 65 4f 70 20  /.struct VdbeOp 
0470: 7b 0a 20 20 75 38 20 6f 70 63 6f 64 65 3b 20 20  {.  u8 opcode;  
0480: 20 20 20 20 20 20 20 20 2f 2a 20 57 68 61 74 20          /* What 
0490: 6f 70 65 72 61 74 69 6f 6e 20 74 6f 20 70 65 72  operation to per
04a0: 66 6f 72 6d 20 2a 2f 0a 20 20 69 6e 74 20 70 31  form */.  int p1
04b0: 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a  ;             /*
04c0: 20 46 69 72 73 74 20 6f 70 65 72 61 6e 64 20 2a   First operand *
04d0: 2f 0a 20 20 69 6e 74 20 70 32 3b 20 20 20 20 20  /.  int p2;     
04e0: 20 20 20 20 20 20 20 20 2f 2a 20 53 65 63 6f 6e          /* Secon
04f0: 64 20 70 61 72 61 6d 65 74 65 72 20 28 6f 66 74  d parameter (oft
0500: 65 6e 20 74 68 65 20 6a 75 6d 70 20 64 65 73 74  en the jump dest
0510: 69 6e 61 74 69 6f 6e 29 20 2a 2f 0a 20 20 63 68  ination) */.  ch
0520: 61 72 20 2a 70 33 3b 20 20 20 20 20 20 20 20 20  ar *p3;         
0530: 20 20 2f 2a 20 54 68 69 72 64 20 70 61 72 61 6d    /* Third param
0540: 65 74 65 72 20 2a 2f 0a 20 20 69 6e 74 20 70 33  eter */.  int p3
0550: 74 79 70 65 3b 20 20 20 20 20 20 20 20 20 2f 2a  type;         /*
0560: 20 4f 6e 65 20 6f 66 20 74 68 65 20 50 33 5f 78   One of the P3_x
0570: 78 78 20 63 6f 6e 73 74 61 6e 74 73 20 64 65 66  xx constants def
0580: 69 6e 65 64 20 62 65 6c 6f 77 20 2a 2f 0a 23 69  ined below */.#i
0590: 66 64 65 66 20 56 44 42 45 5f 50 52 4f 46 49 4c  fdef VDBE_PROFIL
05a0: 45 0a 20 20 69 6e 74 20 63 6e 74 3b 20 20 20 20  E.  int cnt;    
05b0: 20 20 20 20 20 20 20 20 2f 2a 20 4e 75 6d 62 65          /* Numbe
05c0: 72 20 6f 66 20 74 69 6d 65 73 20 74 68 69 73 20  r of times this 
05d0: 69 6e 73 74 72 75 63 74 69 6f 6e 20 77 61 73 20  instruction was 
05e0: 65 78 65 63 75 74 65 64 20 2a 2f 0a 20 20 6c 6f  executed */.  lo
05f0: 6e 67 20 6c 6f 6e 67 20 63 79 63 6c 65 73 3b 20  ng long cycles; 
0600: 20 20 2f 2a 20 54 6f 74 61 6c 20 74 69 6d 65 20    /* Total time 
0610: 73 70 65 6e 64 20 65 78 65 63 75 74 69 6e 67 20  spend executing 
0620: 74 68 69 73 20 69 6e 73 74 72 75 63 74 69 6f 6e  this instruction
0630: 20 2a 2f 0a 23 65 6e 64 69 66 0a 7d 3b 0a 74 79   */.#endif.};.ty
0640: 70 65 64 65 66 20 73 74 72 75 63 74 20 56 64 62  pedef struct Vdb
0650: 65 4f 70 20 56 64 62 65 4f 70 3b 0a 0a 2f 2a 0a  eOp VdbeOp;../*.
0660: 2a 2a 20 41 20 73 6d 61 6c 6c 65 72 20 76 65 72  ** A smaller ver
0670: 73 69 6f 6e 20 6f 66 20 56 64 62 65 4f 70 20 75  sion of VdbeOp u
0680: 73 65 64 20 66 6f 72 20 74 68 65 20 56 64 62 65  sed for the Vdbe
0690: 41 64 64 4f 70 4c 69 73 74 28 29 20 66 75 6e 63  AddOpList() func
06a0: 74 69 6f 6e 20 62 65 63 61 75 73 65 0a 2a 2a 20  tion because.** 
06b0: 69 74 20 74 61 6b 65 73 20 75 70 20 6c 65 73 73  it takes up less
06c0: 20 73 70 61 63 65 2e 0a 2a 2f 0a 73 74 72 75 63   space..*/.struc
06d0: 74 20 56 64 62 65 4f 70 4c 69 73 74 20 7b 0a 20  t VdbeOpList {. 
06e0: 20 75 38 20 6f 70 63 6f 64 65 3b 20 20 20 20 20   u8 opcode;     
06f0: 20 20 20 20 20 2f 2a 20 57 68 61 74 20 6f 70 65       /* What ope
0700: 72 61 74 69 6f 6e 20 74 6f 20 70 65 72 66 6f 72  ration to perfor
0710: 6d 20 2a 2f 0a 20 20 73 69 67 6e 65 64 20 63 68  m */.  signed ch
0720: 61 72 20 70 31 3b 20 20 20 20 20 2f 2a 20 46 69  ar p1;     /* Fi
0730: 72 73 74 20 6f 70 65 72 61 6e 64 20 2a 2f 0a 20  rst operand */. 
0740: 20 73 68 6f 72 74 20 69 6e 74 20 70 32 3b 20 20   short int p2;  
0750: 20 20 20 20 20 2f 2a 20 53 65 63 6f 6e 64 20 70       /* Second p
0760: 61 72 61 6d 65 74 65 72 20 28 6f 66 74 65 6e 20  arameter (often 
0770: 74 68 65 20 6a 75 6d 70 20 64 65 73 74 69 6e 61  the jump destina
0780: 74 69 6f 6e 29 20 2a 2f 0a 20 20 63 68 61 72 20  tion) */.  char 
0790: 2a 70 33 3b 20 20 20 20 20 20 20 20 20 20 20 2f  *p3;           /
07a0: 2a 20 54 68 69 72 64 20 70 61 72 61 6d 65 74 65  * Third paramete
07b0: 72 20 2a 2f 0a 7d 3b 0a 74 79 70 65 64 65 66 20  r */.};.typedef 
07c0: 73 74 72 75 63 74 20 56 64 62 65 4f 70 4c 69 73  struct VdbeOpLis
07d0: 74 20 56 64 62 65 4f 70 4c 69 73 74 3b 0a 0a 2f  t VdbeOpList;../
07e0: 2a 0a 2a 2a 20 41 6c 6c 6f 77 65 64 20 76 61 6c  *.** Allowed val
07f0: 75 65 73 20 6f 66 20 56 64 62 65 4f 70 2e 70 33  ues of VdbeOp.p3
0800: 74 79 70 65 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  type.*/.#define 
0810: 50 33 5f 4e 4f 54 55 53 45 44 20 20 20 20 30 20  P3_NOTUSED    0 
0820: 20 20 2f 2a 20 54 68 65 20 50 33 20 70 61 72 61    /* The P3 para
0830: 6d 65 74 65 72 20 69 73 20 6e 6f 74 20 75 73 65  meter is not use
0840: 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33 5f  d */.#define P3_
0850: 44 59 4e 41 4d 49 43 20 20 28 2d 31 29 20 20 2f  DYNAMIC  (-1)  /
0860: 2a 20 50 6f 69 6e 74 65 72 20 74 6f 20 61 20 73  * Pointer to a s
0870: 74 72 69 6e 67 20 6f 62 74 61 69 6e 65 64 20 66  tring obtained f
0880: 72 6f 6d 20 73 71 6c 69 74 65 4d 61 6c 6c 6f 63  rom sqliteMalloc
0890: 28 29 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33  () */.#define P3
08a0: 5f 53 54 41 54 49 43 20 20 20 28 2d 32 29 20 20  _STATIC   (-2)  
08b0: 2f 2a 20 50 6f 69 6e 74 65 72 20 74 6f 20 61 20  /* Pointer to a 
08c0: 73 74 61 74 69 63 20 73 74 72 69 6e 67 20 2a 2f  static string */
08d0: 0a 23 64 65 66 69 6e 65 20 50 33 5f 43 4f 4c 4c  .#define P3_COLL
08e0: 53 45 51 20 20 28 2d 34 29 20 20 2f 2a 20 50 33  SEQ  (-4)  /* P3
08f0: 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f   is a pointer to
0900: 20 61 20 43 6f 6c 6c 53 65 71 20 73 74 72 75 63   a CollSeq struc
0910: 74 75 72 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  ture */.#define 
0920: 50 33 5f 46 55 4e 43 44 45 46 20 20 28 2d 35 29  P3_FUNCDEF  (-5)
0930: 20 20 2f 2a 20 50 33 20 69 73 20 61 20 70 6f 69    /* P3 is a poi
0940: 6e 74 65 72 20 74 6f 20 61 20 46 75 6e 63 44 65  nter to a FuncDe
0950: 66 20 73 74 72 75 63 74 75 72 65 20 2a 2f 0a 23  f structure */.#
0960: 64 65 66 69 6e 65 20 50 33 5f 4b 45 59 49 4e 46  define P3_KEYINF
0970: 4f 20 20 28 2d 36 29 20 20 2f 2a 20 50 33 20 69  O  (-6)  /* P3 i
0980: 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  s a pointer to a
0990: 20 4b 65 79 49 6e 66 6f 20 73 74 72 75 63 74 75   KeyInfo structu
09a0: 72 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33  re */.#define P3
09b0: 5f 56 44 42 45 46 55 4e 43 20 28 2d 37 29 20 20  _VDBEFUNC (-7)  
09c0: 2f 2a 20 50 33 20 69 73 20 61 20 70 6f 69 6e 74  /* P3 is a point
09d0: 65 72 20 74 6f 20 61 20 56 64 62 65 46 75 6e 63  er to a VdbeFunc
09e0: 20 73 74 72 75 63 74 75 72 65 20 2a 2f 0a 23 64   structure */.#d
09f0: 65 66 69 6e 65 20 50 33 5f 4d 45 4d 20 20 20 20  efine P3_MEM    
0a00: 20 20 28 2d 38 29 20 20 2f 2a 20 50 33 20 69 73    (-8)  /* P3 is
0a10: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
0a20: 4d 65 6d 2a 20 20 20 20 73 74 72 75 63 74 75 72  Mem*    structur
0a30: 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33 5f  e */.#define P3_
0a40: 54 52 41 4e 53 49 45 4e 54 20 28 2d 39 29 20 2f  TRANSIENT (-9) /
0a50: 2a 20 50 33 20 69 73 20 61 20 70 6f 69 6e 74 65  * P3 is a pointe
0a60: 72 20 74 6f 20 61 20 74 72 61 6e 73 69 65 6e 74  r to a transient
0a70: 20 73 74 72 69 6e 67 20 2a 2f 0a 23 64 65 66 69   string */.#defi
0a80: 6e 65 20 50 33 5f 56 54 41 42 20 20 20 20 20 28  ne P3_VTAB     (
0a90: 2d 31 30 29 20 2f 2a 20 50 33 20 69 73 20 61 20  -10) /* P3 is a 
0aa0: 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 73 71  pointer to an sq
0ab0: 6c 69 74 65 33 5f 76 74 61 62 20 73 74 72 75 63  lite3_vtab struc
0ac0: 74 75 72 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  ture */.#define 
0ad0: 50 33 5f 4d 50 52 49 4e 54 46 20 20 28 2d 31 31  P3_MPRINTF  (-11
0ae0: 29 20 2f 2a 20 50 33 20 69 73 20 61 20 73 74 72  ) /* P3 is a str
0af0: 69 6e 67 20 6f 62 74 61 69 6e 65 64 20 66 72 6f  ing obtained fro
0b00: 6d 20 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e 74  m sqlite3_mprint
0b10: 66 28 29 20 2a 2f 0a 0a 2f 2a 20 57 68 65 6e 20  f() */../* When 
0b20: 61 64 64 69 6e 67 20 61 20 50 33 20 61 72 67 75  adding a P3 argu
0b30: 6d 65 6e 74 20 75 73 69 6e 67 20 50 33 5f 4b 45  ment using P3_KE
0b40: 59 49 4e 46 4f 2c 20 61 20 63 6f 70 79 20 6f 66  YINFO, a copy of
0b50: 20 74 68 65 20 4b 65 79 49 6e 66 6f 20 73 74 72   the KeyInfo str
0b60: 75 63 74 75 72 65 0a 2a 2a 20 69 73 20 6d 61 64  ucture.** is mad
0b70: 65 2e 20 20 54 68 61 74 20 63 6f 70 79 20 69 73  e.  That copy is
0b80: 20 66 72 65 65 64 20 77 68 65 6e 20 74 68 65 20   freed when the 
0b90: 56 64 62 65 20 69 73 20 66 69 6e 61 6c 69 7a 65  Vdbe is finalize
0ba0: 64 2e 20 20 42 75 74 20 69 66 20 74 68 65 0a 2a  d.  But if the.*
0bb0: 2a 20 61 72 67 75 6d 65 6e 74 20 69 73 20 50 33  * argument is P3
0bc0: 5f 4b 45 59 49 4e 46 4f 5f 48 41 4e 44 4f 46 46  _KEYINFO_HANDOFF
0bd0: 2c 20 74 68 65 20 70 61 73 73 65 64 20 69 6e 20  , the passed in 
0be0: 70 6f 69 6e 74 65 72 20 69 73 20 75 73 65 64 2e  pointer is used.
0bf0: 20 20 49 74 20 73 74 69 6c 6c 0a 2a 2a 20 67 65    It still.** ge
0c00: 74 73 20 66 72 65 65 64 20 77 68 65 6e 20 74 68  ts freed when th
0c10: 65 20 56 64 62 65 20 69 73 20 66 69 6e 61 6c 69  e Vdbe is finali
0c20: 7a 65 64 20 73 6f 20 69 74 20 73 74 69 6c 6c 20  zed so it still 
0c30: 73 68 6f 75 6c 64 20 62 65 20 6f 62 74 61 69 6e  should be obtain
0c40: 65 64 0a 2a 2a 20 66 72 6f 6d 20 61 20 73 69 6e  ed.** from a sin
0c50: 67 6c 65 20 73 71 6c 69 74 65 4d 61 6c 6c 6f 63  gle sqliteMalloc
0c60: 28 29 2e 20 20 42 75 74 20 6e 6f 20 63 6f 70 79  ().  But no copy
0c70: 20 69 73 20 6d 61 64 65 20 61 6e 64 20 74 68 65   is made and the
0c80: 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20 66 75 6e 63   calling.** func
0c90: 74 69 6f 6e 20 73 68 6f 75 6c 64 20 2a 6e 6f 74  tion should *not
0ca0: 2a 20 74 72 79 20 74 6f 20 66 72 65 65 20 74 68  * try to free th
0cb0: 65 20 4b 65 79 49 6e 66 6f 2e 0a 2a 2f 0a 23 64  e KeyInfo..*/.#d
0cc0: 65 66 69 6e 65 20 50 33 5f 4b 45 59 49 4e 46 4f  efine P3_KEYINFO
0cd0: 5f 48 41 4e 44 4f 46 46 20 28 2d 39 29 0a 0a 2f  _HANDOFF (-9)../
0ce0: 2a 0a 2a 2a 20 54 68 65 20 56 64 62 65 2e 61 43  *.** The Vdbe.aC
0cf0: 6f 6c 4e 61 6d 65 20 61 72 72 61 79 20 63 6f 6e  olName array con
0d00: 74 61 69 6e 73 20 35 6e 20 4d 65 6d 20 73 74 72  tains 5n Mem str
0d10: 75 63 74 75 72 65 73 2c 20 77 68 65 72 65 20 6e  uctures, where n
0d20: 20 69 73 20 74 68 65 20 0a 2a 2a 20 6e 75 6d 62   is the .** numb
0d30: 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 6f 66  er of columns of
0d40: 20 64 61 74 61 20 72 65 74 75 72 6e 65 64 20 62   data returned b
0d50: 79 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 2e  y the statement.
0d60: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 43 4f 4c 4e  .*/.#define COLN
0d70: 41 4d 45 5f 4e 41 4d 45 20 20 20 20 20 30 0a 23  AME_NAME     0.#
0d80: 64 65 66 69 6e 65 20 43 4f 4c 4e 41 4d 45 5f 44  define COLNAME_D
0d90: 45 43 4c 54 59 50 45 20 31 0a 23 64 65 66 69 6e  ECLTYPE 1.#defin
0da0: 65 20 43 4f 4c 4e 41 4d 45 5f 44 41 54 41 42 41  e COLNAME_DATABA
0db0: 53 45 20 32 0a 23 64 65 66 69 6e 65 20 43 4f 4c  SE 2.#define COL
0dc0: 4e 41 4d 45 5f 54 41 42 4c 45 20 20 20 20 33 0a  NAME_TABLE    3.
0dd0: 23 64 65 66 69 6e 65 20 43 4f 4c 4e 41 4d 45 5f  #define COLNAME_
0de0: 43 4f 4c 55 4d 4e 20 20 20 34 0a 23 64 65 66 69  COLUMN   4.#defi
0df0: 6e 65 20 43 4f 4c 4e 41 4d 45 5f 4e 20 20 20 20  ne COLNAME_N    
0e00: 20 20 20 20 35 20 20 20 20 20 20 2f 2a 20 4e 75      5      /* Nu
0e10: 6d 62 65 72 20 6f 66 20 43 4f 4c 4e 41 4d 45 5f  mber of COLNAME_
0e20: 78 78 78 20 73 79 6d 62 6f 6c 73 20 2a 2f 0a 0a  xxx symbols */..
0e30: 2f 2a 0a 2a 2a 20 54 68 65 20 66 6f 6c 6c 6f 77  /*.** The follow
0e40: 69 6e 67 20 6d 61 63 72 6f 20 63 6f 6e 76 65 72  ing macro conver
0e50: 74 73 20 61 20 72 65 6c 61 74 69 76 65 20 61 64  ts a relative ad
0e60: 64 72 65 73 73 20 69 6e 20 74 68 65 20 70 32 20  dress in the p2 
0e70: 66 69 65 6c 64 0a 2a 2a 20 6f 66 20 61 20 56 64  field.** of a Vd
0e80: 62 65 4f 70 20 73 74 72 75 63 74 75 72 65 20 69  beOp structure i
0e90: 6e 74 6f 20 61 20 6e 65 67 61 74 69 76 65 20 6e  nto a negative n
0ea0: 75 6d 62 65 72 20 73 6f 20 74 68 61 74 20 0a 2a  umber so that .*
0eb0: 2a 20 73 71 6c 69 74 65 33 56 64 62 65 41 64 64  * sqlite3VdbeAdd
0ec0: 4f 70 4c 69 73 74 28 29 20 6b 6e 6f 77 73 20 74  OpList() knows t
0ed0: 68 61 74 20 74 68 65 20 61 64 64 72 65 73 73 20  hat the address 
0ee0: 69 73 20 72 65 6c 61 74 69 76 65 2e 20 20 43 61  is relative.  Ca
0ef0: 6c 6c 69 6e 67 0a 2a 2a 20 74 68 65 20 6d 61 63  lling.** the mac
0f00: 72 6f 20 61 67 61 69 6e 20 72 65 73 74 6f 72 65  ro again restore
0f10: 73 20 74 68 65 20 61 64 64 72 65 73 73 2e 0a 2a  s the address..*
0f20: 2f 0a 23 64 65 66 69 6e 65 20 41 44 44 52 28 58  /.#define ADDR(X
0f30: 29 20 20 28 2d 31 2d 28 58 29 29 0a 0a 2f 2a 0a  )  (-1-(X))../*.
0f40: 2a 2a 20 54 68 65 20 6d 61 6b 65 66 69 6c 65 20  ** The makefile 
0f50: 73 63 61 6e 73 20 74 68 65 20 76 64 62 65 2e 63  scans the vdbe.c
0f60: 20 73 6f 75 72 63 65 20 66 69 6c 65 20 61 6e 64   source file and
0f70: 20 63 72 65 61 74 65 73 20 74 68 65 20 22 6f 70   creates the "op
0f80: 63 6f 64 65 73 2e 68 22 0a 2a 2a 20 68 65 61 64  codes.h".** head
0f90: 65 72 20 66 69 6c 65 20 74 68 61 74 20 64 65 66  er file that def
0fa0: 69 6e 65 73 20 61 20 6e 75 6d 62 65 72 20 66 6f  ines a number fo
0fb0: 72 20 65 61 63 68 20 6f 70 63 6f 64 65 20 75 73  r each opcode us
0fc0: 65 64 20 62 79 20 74 68 65 20 56 44 42 45 2e 0a  ed by the VDBE..
0fd0: 2a 2f 0a 23 69 6e 63 6c 75 64 65 20 22 6f 70 63  */.#include "opc
0fe0: 6f 64 65 73 2e 68 22 0a 0a 2f 2a 0a 2a 2a 20 50  odes.h"../*.** P
0ff0: 72 6f 74 6f 74 79 70 65 73 20 66 6f 72 20 74 68  rototypes for th
1000: 65 20 56 44 42 45 20 69 6e 74 65 72 66 61 63 65  e VDBE interface
1010: 2e 20 20 53 65 65 20 63 6f 6d 6d 65 6e 74 73 20  .  See comments 
1020: 6f 6e 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74  on the implement
1030: 61 74 69 6f 6e 0a 2a 2a 20 66 6f 72 20 61 20 64  ation.** for a d
1040: 65 73 63 72 69 70 74 69 6f 6e 20 6f 66 20 77 68  escription of wh
1050: 61 74 20 65 61 63 68 20 6f 66 20 74 68 65 73 65  at each of these
1060: 20 72 6f 75 74 69 6e 65 73 20 64 6f 65 73 2e 0a   routines does..
1070: 2a 2f 0a 56 64 62 65 20 2a 73 71 6c 69 74 65 33  */.Vdbe *sqlite3
1080: 56 64 62 65 43 72 65 61 74 65 28 73 71 6c 69 74  VdbeCreate(sqlit
1090: 65 33 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  e3*);.void sqlit
10a0: 65 33 56 64 62 65 43 72 65 61 74 65 43 61 6c 6c  e3VdbeCreateCall
10b0: 62 61 63 6b 28 56 64 62 65 2a 2c 20 69 6e 74 2a  back(Vdbe*, int*
10c0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64  );.int sqlite3Vd
10d0: 62 65 41 64 64 4f 70 28 56 64 62 65 2a 2c 69 6e  beAddOp(Vdbe*,in
10e0: 74 2c 69 6e 74 2c 69 6e 74 29 3b 0a 69 6e 74 20  t,int,int);.int 
10f0: 73 71 6c 69 74 65 33 56 64 62 65 4f 70 33 28 56  sqlite3VdbeOp3(V
1100: 64 62 65 2a 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74  dbe*,int,int,int
1110: 2c 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 33  ,const char *zP3
1120: 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ,int);.int sqlit
1130: 65 33 56 64 62 65 41 64 64 4f 70 4c 69 73 74 28  e3VdbeAddOpList(
1140: 56 64 62 65 2a 2c 20 69 6e 74 20 6e 4f 70 2c 20  Vdbe*, int nOp, 
1150: 56 64 62 65 4f 70 4c 69 73 74 20 63 6f 6e 73 74  VdbeOpList const
1160: 20 2a 61 4f 70 29 3b 0a 76 6f 69 64 20 73 71 6c   *aOp);.void sql
1170: 69 74 65 33 56 64 62 65 43 68 61 6e 67 65 50 31  ite3VdbeChangeP1
1180: 28 56 64 62 65 2a 2c 20 69 6e 74 20 61 64 64 72  (Vdbe*, int addr
1190: 2c 20 69 6e 74 20 50 31 29 3b 0a 76 6f 69 64 20  , int P1);.void 
11a0: 73 71 6c 69 74 65 33 56 64 62 65 43 68 61 6e 67  sqlite3VdbeChang
11b0: 65 50 32 28 56 64 62 65 2a 2c 20 69 6e 74 20 61  eP2(Vdbe*, int a
11c0: 64 64 72 2c 20 69 6e 74 20 50 32 29 3b 0a 76 6f  ddr, int P2);.vo
11d0: 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 4a 75  id sqlite3VdbeJu
11e0: 6d 70 48 65 72 65 28 56 64 62 65 2a 2c 20 69 6e  mpHere(Vdbe*, in
11f0: 74 20 61 64 64 72 29 3b 0a 76 6f 69 64 20 73 71  t addr);.void sq
1200: 6c 69 74 65 33 56 64 62 65 43 68 61 6e 67 65 54  lite3VdbeChangeT
1210: 6f 4e 6f 6f 70 28 56 64 62 65 2a 2c 20 69 6e 74  oNoop(Vdbe*, int
1220: 20 61 64 64 72 2c 20 69 6e 74 20 4e 29 3b 0a 76   addr, int N);.v
1230: 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62 65 43  oid sqlite3VdbeC
1240: 68 61 6e 67 65 50 33 28 56 64 62 65 2a 2c 20 69  hangeP3(Vdbe*, i
1250: 6e 74 20 61 64 64 72 2c 20 63 6f 6e 73 74 20 63  nt addr, const c
1260: 68 61 72 20 2a 7a 50 31 2c 20 69 6e 74 20 4e 29  har *zP1, int N)
1270: 3b 0a 56 64 62 65 4f 70 20 2a 73 71 6c 69 74 65  ;.VdbeOp *sqlite
1280: 33 56 64 62 65 47 65 74 4f 70 28 56 64 62 65 2a  3VdbeGetOp(Vdbe*
1290: 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69  , int);.int sqli
12a0: 74 65 33 56 64 62 65 4d 61 6b 65 4c 61 62 65 6c  te3VdbeMakeLabel
12b0: 28 56 64 62 65 2a 29 3b 0a 76 6f 69 64 20 73 71  (Vdbe*);.void sq
12c0: 6c 69 74 65 33 56 64 62 65 44 65 6c 65 74 65 28  lite3VdbeDelete(
12d0: 56 64 62 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c  Vdbe*);.void sql
12e0: 69 74 65 33 56 64 62 65 4d 61 6b 65 52 65 61 64  ite3VdbeMakeRead
12f0: 79 28 56 64 62 65 2a 2c 69 6e 74 2c 69 6e 74 2c  y(Vdbe*,int,int,
1300: 69 6e 74 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  int,int);.int sq
1310: 6c 69 74 65 33 56 64 62 65 46 69 6e 61 6c 69 7a  lite3VdbeFinaliz
1320: 65 28 56 64 62 65 2a 29 3b 0a 76 6f 69 64 20 73  e(Vdbe*);.void s
1330: 71 6c 69 74 65 33 56 64 62 65 52 65 73 6f 6c 76  qlite3VdbeResolv
1340: 65 4c 61 62 65 6c 28 56 64 62 65 2a 2c 20 69 6e  eLabel(Vdbe*, in
1350: 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56  t);.int sqlite3V
1360: 64 62 65 43 75 72 72 65 6e 74 41 64 64 72 28 56  dbeCurrentAddr(V
1370: 64 62 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69  dbe*);.void sqli
1380: 74 65 33 56 64 62 65 54 72 61 63 65 28 56 64 62  te3VdbeTrace(Vdb
1390: 65 2a 2c 46 49 4c 45 2a 29 3b 0a 69 6e 74 20 73  e*,FILE*);.int s
13a0: 71 6c 69 74 65 33 56 64 62 65 52 65 73 65 74 28  qlite3VdbeReset(
13b0: 56 64 62 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  Vdbe*);.int sqli
13c0: 74 65 56 64 62 65 53 65 74 56 61 72 69 61 62 6c  teVdbeSetVariabl
13d0: 65 73 28 56 64 62 65 2a 2c 69 6e 74 2c 63 6f 6e  es(Vdbe*,int,con
13e0: 73 74 20 63 68 61 72 2a 2a 29 3b 0a 76 6f 69 64  st char**);.void
13f0: 20 73 71 6c 69 74 65 33 56 64 62 65 53 65 74 4e   sqlite3VdbeSetN
1400: 75 6d 43 6f 6c 73 28 56 64 62 65 2a 2c 69 6e 74  umCols(Vdbe*,int
1410: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64  );.int sqlite3Vd
1420: 62 65 53 65 74 43 6f 6c 4e 61 6d 65 28 56 64 62  beSetColName(Vdb
1430: 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 2c 20 63 6f  e*, int, int, co
1440: 6e 73 74 20 63 68 61 72 20 2a 2c 20 69 6e 74 29  nst char *, int)
1450: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64  ;.void sqlite3Vd
1460: 62 65 43 6f 75 6e 74 43 68 61 6e 67 65 73 28 56  beCountChanges(V
1470: 64 62 65 2a 29 3b 0a 73 71 6c 69 74 65 33 20 2a  dbe*);.sqlite3 *
1480: 73 71 6c 69 74 65 33 56 64 62 65 44 62 28 56 64  sqlite3VdbeDb(Vd
1490: 62 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  be*);.void sqlit
14a0: 65 33 56 64 62 65 53 65 74 53 71 6c 28 56 64 62  e3VdbeSetSql(Vdb
14b0: 65 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  e*, const char *
14c0: 7a 2c 20 69 6e 74 20 6e 29 3b 0a 63 6f 6e 73 74  z, int n);.const
14d0: 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 56 64   char *sqlite3Vd
14e0: 62 65 47 65 74 53 71 6c 28 56 64 62 65 2a 29 3b  beGetSql(Vdbe*);
14f0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62  .void sqlite3Vdb
1500: 65 53 77 61 70 28 56 64 62 65 2a 2c 56 64 62 65  eSwap(Vdbe*,Vdbe
1510: 2a 29 3b 0a 0a 23 69 66 6e 64 65 66 20 4e 44 45  *);..#ifndef NDE
1520: 42 55 47 0a 20 20 76 6f 69 64 20 73 71 6c 69 74  BUG.  void sqlit
1530: 65 33 56 64 62 65 43 6f 6d 6d 65 6e 74 28 56 64  e3VdbeComment(Vd
1540: 62 65 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 2a  be*, const char*
1550: 2c 20 2e 2e 2e 29 3b 0a 23 20 64 65 66 69 6e 65  , ...);.# define
1560: 20 56 64 62 65 43 6f 6d 6d 65 6e 74 28 58 29 20   VdbeComment(X) 
1570: 20 73 71 6c 69 74 65 33 56 64 62 65 43 6f 6d 6d   sqlite3VdbeComm
1580: 65 6e 74 20 58 0a 23 65 6c 73 65 0a 23 20 64 65  ent X.#else.# de
1590: 66 69 6e 65 20 56 64 62 65 43 6f 6d 6d 65 6e 74  fine VdbeComment
15a0: 28 58 29 0a 23 65 6e 64 69 66 0a 0a 23 65 6e 64  (X).#endif..#end
15b0: 69 66 0a                                         if.