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

Artifact 7f586cb6d6b57764e5aac1f87107d6a95ddce24c:


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 39 34 20 32 30  vdbe.h,v 1.94 20
0290: 30 35 2f 30 33 2f 32 33 20 30 31 3a 34 38 3a 34  05/03/23 01:48:4
02a0: 38 20 64 72 68 20 45 78 70 20 24 0a 2a 2f 0a 23  8 drh Exp $.*/.#
02b0: 69 66 6e 64 65 66 20 5f 53 51 4c 49 54 45 5f 56  ifndef _SQLITE_V
02c0: 44 42 45 5f 48 5f 0a 23 64 65 66 69 6e 65 20 5f  DBE_H_.#define _
02d0: 53 51 4c 49 54 45 5f 56 44 42 45 5f 48 5f 0a 23  SQLITE_VDBE_H_.#
02e0: 69 6e 63 6c 75 64 65 20 3c 73 74 64 69 6f 2e 68  include <stdio.h
02f0: 3e 0a 0a 2f 2a 0a 2a 2a 20 41 20 73 69 6e 67 6c  >../*.** A singl
0300: 65 20 56 44 42 45 20 69 73 20 61 6e 20 6f 70 61  e VDBE is an opa
0310: 71 75 65 20 73 74 72 75 63 74 75 72 65 20 6e 61  que structure na
0320: 6d 65 64 20 22 56 64 62 65 22 2e 20 20 4f 6e 6c  med "Vdbe".  Onl
0330: 79 20 72 6f 75 74 69 6e 65 73 0a 2a 2a 20 69 6e  y routines.** in
0340: 20 74 68 65 20 73 6f 75 72 63 65 20 66 69 6c 65   the source file
0350: 20 73 71 6c 69 74 65 56 64 62 65 2e 63 20 61 72   sqliteVdbe.c ar
0360: 65 20 61 6c 6c 6f 77 65 64 20 74 6f 20 73 65 65  e allowed to see
0370: 20 74 68 65 20 69 6e 73 69 64 65 73 0a 2a 2a 20   the insides.** 
0380: 6f 66 20 74 68 69 73 20 73 74 72 75 63 74 75 72  of this structur
0390: 65 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74  e..*/.typedef st
03a0: 72 75 63 74 20 56 64 62 65 20 56 64 62 65 3b 0a  ruct Vdbe Vdbe;.
03b0: 0a 2f 2a 0a 2a 2a 20 41 20 73 69 6e 67 6c 65 20  ./*.** A single 
03c0: 69 6e 73 74 72 75 63 74 69 6f 6e 20 6f 66 20 74  instruction of t
03d0: 68 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69  he virtual machi
03e0: 6e 65 20 68 61 73 20 61 6e 20 6f 70 63 6f 64 65  ne has an opcode
03f0: 0a 2a 2a 20 61 6e 64 20 61 73 20 6d 61 6e 79 20  .** and as many 
0400: 61 73 20 74 68 72 65 65 20 6f 70 65 72 61 6e 64  as three operand
0410: 73 2e 20 20 54 68 65 20 69 6e 73 74 72 75 63 74  s.  The instruct
0420: 69 6f 6e 20 69 73 20 72 65 63 6f 72 64 65 64 0a  ion is recorded.
0430: 2a 2a 20 61 73 20 61 6e 20 69 6e 73 74 61 6e 63  ** as an instanc
0440: 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69  e of the followi
0450: 6e 67 20 73 74 72 75 63 74 75 72 65 3a 0a 2a 2f  ng structure:.*/
0460: 0a 73 74 72 75 63 74 20 56 64 62 65 4f 70 20 7b  .struct VdbeOp {
0470: 0a 20 20 75 38 20 6f 70 63 6f 64 65 3b 20 20 20  .  u8 opcode;   
0480: 20 20 20 20 20 20 20 2f 2a 20 57 68 61 74 20 6f         /* What o
0490: 70 65 72 61 74 69 6f 6e 20 74 6f 20 70 65 72 66  peration to perf
04a0: 6f 72 6d 20 2a 2f 0a 20 20 69 6e 74 20 70 31 3b  orm */.  int p1;
04b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
04c0: 46 69 72 73 74 20 6f 70 65 72 61 6e 64 20 2a 2f  First operand */
04d0: 0a 20 20 69 6e 74 20 70 32 3b 20 20 20 20 20 20  .  int p2;      
04e0: 20 20 20 20 20 20 20 2f 2a 20 53 65 63 6f 6e 64         /* Second
04f0: 20 70 61 72 61 6d 65 74 65 72 20 28 6f 66 74 65   parameter (ofte
0500: 6e 20 74 68 65 20 6a 75 6d 70 20 64 65 73 74 69  n the jump desti
0510: 6e 61 74 69 6f 6e 29 20 2a 2f 0a 20 20 63 68 61  nation) */.  cha
0520: 72 20 2a 70 33 3b 20 20 20 20 20 20 20 20 20 20  r *p3;          
0530: 20 2f 2a 20 54 68 69 72 64 20 70 61 72 61 6d 65   /* Third parame
0540: 74 65 72 20 2a 2f 0a 20 20 69 6e 74 20 70 33 74  ter */.  int p3t
0550: 79 70 65 3b 20 20 20 20 20 20 20 20 20 2f 2a 20  ype;         /* 
0560: 50 33 5f 53 54 41 54 49 43 2c 20 50 33 5f 44 59  P3_STATIC, P3_DY
0570: 4e 41 4d 49 43 20 6f 72 20 50 33 5f 50 4f 49 4e  NAMIC or P3_POIN
0580: 54 45 52 20 2a 2f 0a 23 69 66 64 65 66 20 56 44  TER */.#ifdef VD
0590: 42 45 5f 50 52 4f 46 49 4c 45 0a 20 20 69 6e 74  BE_PROFILE.  int
05a0: 20 63 6e 74 3b 20 20 20 20 20 20 20 20 20 20 20   cnt;           
05b0: 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20 74 69   /* Number of ti
05c0: 6d 65 73 20 74 68 69 73 20 69 6e 73 74 72 75 63  mes this instruc
05d0: 74 69 6f 6e 20 77 61 73 20 65 78 65 63 75 74 65  tion was execute
05e0: 64 20 2a 2f 0a 20 20 6c 6f 6e 67 20 6c 6f 6e 67  d */.  long long
05f0: 20 63 79 63 6c 65 73 3b 20 20 20 2f 2a 20 54 6f   cycles;   /* To
0600: 74 61 6c 20 74 69 6d 65 20 73 70 65 6e 64 20 65  tal time spend e
0610: 78 65 63 75 74 69 6e 67 20 74 68 69 73 20 69 6e  xecuting this in
0620: 73 74 72 75 63 74 69 6f 6e 20 2a 2f 0a 23 65 6e  struction */.#en
0630: 64 69 66 0a 7d 3b 0a 74 79 70 65 64 65 66 20 73  dif.};.typedef s
0640: 74 72 75 63 74 20 56 64 62 65 4f 70 20 56 64 62  truct VdbeOp Vdb
0650: 65 4f 70 3b 0a 0a 2f 2a 0a 2a 2a 20 41 20 73 6d  eOp;../*.** A sm
0660: 61 6c 6c 65 72 20 76 65 72 73 69 6f 6e 20 6f 66  aller version of
0670: 20 56 64 62 65 4f 70 20 75 73 65 64 20 66 6f 72   VdbeOp used for
0680: 20 74 68 65 20 56 64 62 65 41 64 64 4f 70 4c 69   the VdbeAddOpLi
0690: 73 74 28 29 20 66 75 6e 63 74 69 6f 6e 20 62 65  st() function be
06a0: 63 61 75 73 65 0a 2a 2a 20 69 74 20 74 61 6b 65  cause.** it take
06b0: 73 20 75 70 20 6c 65 73 73 20 73 70 61 63 65 2e  s up less space.
06c0: 0a 2a 2f 0a 73 74 72 75 63 74 20 56 64 62 65 4f  .*/.struct VdbeO
06d0: 70 4c 69 73 74 20 7b 0a 20 20 75 38 20 6f 70 63  pList {.  u8 opc
06e0: 6f 64 65 3b 20 20 20 20 20 20 20 20 20 20 2f 2a  ode;          /*
06f0: 20 57 68 61 74 20 6f 70 65 72 61 74 69 6f 6e 20   What operation 
0700: 74 6f 20 70 65 72 66 6f 72 6d 20 2a 2f 0a 20 20  to perform */.  
0710: 73 69 67 6e 65 64 20 63 68 61 72 20 70 31 3b 20  signed char p1; 
0720: 20 20 20 20 2f 2a 20 46 69 72 73 74 20 6f 70 65      /* First ope
0730: 72 61 6e 64 20 2a 2f 0a 20 20 73 68 6f 72 74 20  rand */.  short 
0740: 69 6e 74 20 70 32 3b 20 20 20 20 20 20 20 2f 2a  int p2;       /*
0750: 20 53 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   Second paramete
0760: 72 20 28 6f 66 74 65 6e 20 74 68 65 20 6a 75 6d  r (often the jum
0770: 70 20 64 65 73 74 69 6e 61 74 69 6f 6e 29 20 2a  p destination) *
0780: 2f 0a 20 20 63 68 61 72 20 2a 70 33 3b 20 20 20  /.  char *p3;   
0790: 20 20 20 20 20 20 20 20 2f 2a 20 54 68 69 72 64          /* Third
07a0: 20 70 61 72 61 6d 65 74 65 72 20 2a 2f 0a 7d 3b   parameter */.};
07b0: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
07c0: 56 64 62 65 4f 70 4c 69 73 74 20 56 64 62 65 4f  VdbeOpList VdbeO
07d0: 70 4c 69 73 74 3b 0a 0a 2f 2a 0a 2a 2a 20 41 6c  pList;../*.** Al
07e0: 6c 6f 77 65 64 20 76 61 6c 75 65 73 20 6f 66 20  lowed values of 
07f0: 56 64 62 65 4f 70 2e 70 33 74 79 70 65 0a 2a 2f  VdbeOp.p3type.*/
0800: 0a 23 64 65 66 69 6e 65 20 50 33 5f 4e 4f 54 55  .#define P3_NOTU
0810: 53 45 44 20 20 20 20 30 20 20 20 2f 2a 20 54 68  SED    0   /* Th
0820: 65 20 50 33 20 70 61 72 61 6d 65 74 65 72 20 69  e P3 parameter i
0830: 73 20 6e 6f 74 20 75 73 65 64 20 2a 2f 0a 23 64  s not used */.#d
0840: 65 66 69 6e 65 20 50 33 5f 44 59 4e 41 4d 49 43  efine P3_DYNAMIC
0850: 20 20 28 2d 31 29 20 20 2f 2a 20 50 6f 69 6e 74    (-1)  /* Point
0860: 65 72 20 74 6f 20 61 20 73 74 72 69 6e 67 20 6f  er to a string o
0870: 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 73 71 6c  btained from sql
0880: 69 74 65 4d 61 6c 6c 6f 63 28 29 20 2a 2f 0a 23  iteMalloc() */.#
0890: 64 65 66 69 6e 65 20 50 33 5f 53 54 41 54 49 43  define P3_STATIC
08a0: 20 20 20 28 2d 32 29 20 20 2f 2a 20 50 6f 69 6e     (-2)  /* Poin
08b0: 74 65 72 20 74 6f 20 61 20 73 74 61 74 69 63 20  ter to a static 
08c0: 73 74 72 69 6e 67 20 2a 2f 0a 23 64 65 66 69 6e  string */.#defin
08d0: 65 20 50 33 5f 50 4f 49 4e 54 45 52 20 20 28 2d  e P3_POINTER  (-
08e0: 33 29 20 20 2f 2a 20 50 33 20 69 73 20 61 20 70  3)  /* P3 is a p
08f0: 6f 69 6e 74 65 72 20 74 6f 20 73 6f 6d 65 20 73  ointer to some s
0900: 74 72 75 63 74 75 72 65 20 6f 72 20 6f 62 6a 65  tructure or obje
0910: 63 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33  ct */.#define P3
0920: 5f 43 4f 4c 4c 53 45 51 20 20 28 2d 34 29 20 20  _COLLSEQ  (-4)  
0930: 2f 2a 20 50 33 20 69 73 20 61 20 70 6f 69 6e 74  /* P3 is a point
0940: 65 72 20 74 6f 20 61 20 43 6f 6c 6c 53 65 71 20  er to a CollSeq 
0950: 73 74 72 75 63 74 75 72 65 20 2a 2f 0a 23 64 65  structure */.#de
0960: 66 69 6e 65 20 50 33 5f 46 55 4e 43 44 45 46 20  fine P3_FUNCDEF 
0970: 20 28 2d 35 29 20 20 2f 2a 20 50 33 20 69 73 20   (-5)  /* P3 is 
0980: 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 46  a pointer to a F
0990: 75 6e 63 44 65 66 20 73 74 72 75 63 74 75 72 65  uncDef structure
09a0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33 5f 4b   */.#define P3_K
09b0: 45 59 49 4e 46 4f 20 20 28 2d 36 29 20 20 2f 2a  EYINFO  (-6)  /*
09c0: 20 50 33 20 69 73 20 61 20 70 6f 69 6e 74 65 72   P3 is a pointer
09d0: 20 74 6f 20 61 20 4b 65 79 49 6e 66 6f 20 73 74   to a KeyInfo st
09e0: 72 75 63 74 75 72 65 20 2a 2f 0a 23 64 65 66 69  ructure */.#defi
09f0: 6e 65 20 50 33 5f 56 44 42 45 46 55 4e 43 20 28  ne P3_VDBEFUNC (
0a00: 2d 37 29 20 20 2f 2a 20 50 33 20 69 73 20 61 20  -7)  /* P3 is a 
0a10: 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 56 64 62  pointer to a Vdb
0a20: 65 46 75 6e 63 20 73 74 72 75 63 74 75 72 65 20  eFunc structure 
0a30: 2a 2f 0a 23 64 65 66 69 6e 65 20 50 33 5f 4d 45  */.#define P3_ME
0a40: 4d 20 20 20 20 20 20 28 2d 38 29 20 20 2f 2a 20  M      (-8)  /* 
0a50: 50 33 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20  P3 is a pointer 
0a60: 74 6f 20 61 20 4d 65 6d 2a 20 20 20 20 73 74 72  to a Mem*    str
0a70: 75 63 74 75 72 65 20 2a 2f 0a 0a 2f 2a 20 57 68  ucture */../* Wh
0a80: 65 6e 20 61 64 64 69 6e 67 20 61 20 50 33 20 61  en adding a P3 a
0a90: 72 67 75 6d 65 6e 74 20 75 73 69 6e 67 20 50 33  rgument using P3
0aa0: 5f 4b 45 59 49 4e 46 4f 2c 20 61 20 63 6f 70 79  _KEYINFO, a copy
0ab0: 20 6f 66 20 74 68 65 20 4b 65 79 49 6e 66 6f 20   of the KeyInfo 
0ac0: 73 74 72 75 63 74 75 72 65 0a 2a 2a 20 69 73 20  structure.** is 
0ad0: 6d 61 64 65 2e 20 20 54 68 61 74 20 63 6f 70 79  made.  That copy
0ae0: 20 69 73 20 66 72 65 65 64 20 77 68 65 6e 20 74   is freed when t
0af0: 68 65 20 56 64 62 65 20 69 73 20 66 69 6e 61 6c  he Vdbe is final
0b00: 69 7a 65 64 2e 20 20 42 75 74 20 69 66 20 74 68  ized.  But if th
0b10: 65 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20 69 73  e.** argument is
0b20: 20 50 33 5f 4b 45 59 49 4e 46 4f 5f 48 41 4e 44   P3_KEYINFO_HAND
0b30: 4f 46 46 2c 20 74 68 65 20 70 61 73 73 65 64 20  OFF, the passed 
0b40: 69 6e 20 70 6f 69 6e 74 65 72 20 69 73 20 75 73  in pointer is us
0b50: 65 64 2e 20 20 49 74 20 73 74 69 6c 6c 0a 2a 2a  ed.  It still.**
0b60: 20 67 65 74 73 20 66 72 65 65 64 20 77 68 65 6e   gets freed when
0b70: 20 74 68 65 20 56 64 62 65 20 69 73 20 66 69 6e   the Vdbe is fin
0b80: 61 6c 69 7a 65 64 20 73 6f 20 69 74 20 73 74 69  alized so it sti
0b90: 6c 6c 20 73 68 6f 75 6c 64 20 62 65 20 6f 62 74  ll should be obt
0ba0: 61 69 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 61 20  ained.** from a 
0bb0: 73 69 6e 67 6c 65 20 73 71 6c 69 74 65 4d 61 6c  single sqliteMal
0bc0: 6c 6f 63 28 29 2e 20 20 42 75 74 20 6e 6f 20 63  loc().  But no c
0bd0: 6f 70 79 20 69 73 20 6d 61 64 65 20 61 6e 64 20  opy is made and 
0be0: 74 68 65 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20 66  the calling.** f
0bf0: 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20 2a  unction should *
0c00: 6e 6f 74 2a 20 74 72 79 20 74 6f 20 66 72 65 65  not* try to free
0c10: 20 74 68 65 20 4b 65 79 49 6e 66 6f 2e 0a 2a 2f   the KeyInfo..*/
0c20: 0a 23 64 65 66 69 6e 65 20 50 33 5f 4b 45 59 49  .#define P3_KEYI
0c30: 4e 46 4f 5f 48 41 4e 44 4f 46 46 20 28 2d 39 29  NFO_HANDOFF (-9)
0c40: 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 66 6f 6c 6c  ../*.** The foll
0c50: 6f 77 69 6e 67 20 6d 61 63 72 6f 20 63 6f 6e 76  owing macro conv
0c60: 65 72 74 73 20 61 20 72 65 6c 61 74 69 76 65 20  erts a relative 
0c70: 61 64 64 72 65 73 73 20 69 6e 20 74 68 65 20 70  address in the p
0c80: 32 20 66 69 65 6c 64 0a 2a 2a 20 6f 66 20 61 20  2 field.** of a 
0c90: 56 64 62 65 4f 70 20 73 74 72 75 63 74 75 72 65  VdbeOp structure
0ca0: 20 69 6e 74 6f 20 61 20 6e 65 67 61 74 69 76 65   into a negative
0cb0: 20 6e 75 6d 62 65 72 20 73 6f 20 74 68 61 74 20   number so that 
0cc0: 0a 2a 2a 20 73 71 6c 69 74 65 33 56 64 62 65 41  .** sqlite3VdbeA
0cd0: 64 64 4f 70 4c 69 73 74 28 29 20 6b 6e 6f 77 73  ddOpList() knows
0ce0: 20 74 68 61 74 20 74 68 65 20 61 64 64 72 65 73   that the addres
0cf0: 73 20 69 73 20 72 65 6c 61 74 69 76 65 2e 20 20  s is relative.  
0d00: 43 61 6c 6c 69 6e 67 0a 2a 2a 20 74 68 65 20 6d  Calling.** the m
0d10: 61 63 72 6f 20 61 67 61 69 6e 20 72 65 73 74 6f  acro again resto
0d20: 72 65 73 20 74 68 65 20 61 64 64 72 65 73 73 2e  res the address.
0d30: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 41 44 44 52  .*/.#define ADDR
0d40: 28 58 29 20 20 28 2d 31 2d 28 58 29 29 0a 0a 2f  (X)  (-1-(X))../
0d50: 2a 0a 2a 2a 20 54 68 65 20 6d 61 6b 65 66 69 6c  *.** The makefil
0d60: 65 20 73 63 61 6e 73 20 74 68 65 20 76 64 62 65  e scans the vdbe
0d70: 2e 63 20 73 6f 75 72 63 65 20 66 69 6c 65 20 61  .c source file a
0d80: 6e 64 20 63 72 65 61 74 65 73 20 74 68 65 20 22  nd creates the "
0d90: 6f 70 63 6f 64 65 73 2e 68 22 0a 2a 2a 20 68 65  opcodes.h".** he
0da0: 61 64 65 72 20 66 69 6c 65 20 74 68 61 74 20 64  ader file that d
0db0: 65 66 69 6e 65 73 20 61 20 6e 75 6d 62 65 72 20  efines a number 
0dc0: 66 6f 72 20 65 61 63 68 20 6f 70 63 6f 64 65 20  for each opcode 
0dd0: 75 73 65 64 20 62 79 20 74 68 65 20 56 44 42 45  used by the VDBE
0de0: 2e 0a 2a 2f 0a 23 69 6e 63 6c 75 64 65 20 22 6f  ..*/.#include "o
0df0: 70 63 6f 64 65 73 2e 68 22 0a 0a 2f 2a 0a 2a 2a  pcodes.h"../*.**
0e00: 20 50 72 6f 74 6f 74 79 70 65 73 20 66 6f 72 20   Prototypes for 
0e10: 74 68 65 20 56 44 42 45 20 69 6e 74 65 72 66 61  the VDBE interfa
0e20: 63 65 2e 20 20 53 65 65 20 63 6f 6d 6d 65 6e 74  ce.  See comment
0e30: 73 20 6f 6e 20 74 68 65 20 69 6d 70 6c 65 6d 65  s on the impleme
0e40: 6e 74 61 74 69 6f 6e 0a 2a 2a 20 66 6f 72 20 61  ntation.** for a
0e50: 20 64 65 73 63 72 69 70 74 69 6f 6e 20 6f 66 20   description of 
0e60: 77 68 61 74 20 65 61 63 68 20 6f 66 20 74 68 65  what each of the
0e70: 73 65 20 72 6f 75 74 69 6e 65 73 20 64 6f 65 73  se routines does
0e80: 2e 0a 2a 2f 0a 56 64 62 65 20 2a 73 71 6c 69 74  ..*/.Vdbe *sqlit
0e90: 65 33 56 64 62 65 43 72 65 61 74 65 28 73 71 6c  e3VdbeCreate(sql
0ea0: 69 74 65 33 2a 29 3b 0a 76 6f 69 64 20 73 71 6c  ite3*);.void sql
0eb0: 69 74 65 33 56 64 62 65 43 72 65 61 74 65 43 61  ite3VdbeCreateCa
0ec0: 6c 6c 62 61 63 6b 28 56 64 62 65 2a 2c 20 69 6e  llback(Vdbe*, in
0ed0: 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  t*);.int sqlite3
0ee0: 56 64 62 65 41 64 64 4f 70 28 56 64 62 65 2a 2c  VdbeAddOp(Vdbe*,
0ef0: 69 6e 74 2c 69 6e 74 2c 69 6e 74 29 3b 0a 69 6e  int,int,int);.in
0f00: 74 20 73 71 6c 69 74 65 33 56 64 62 65 4f 70 33  t sqlite3VdbeOp3
0f10: 28 56 64 62 65 2a 2c 69 6e 74 2c 69 6e 74 2c 69  (Vdbe*,int,int,i
0f20: 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  nt,const char *z
0f30: 50 33 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  P3,int);.int sql
0f40: 69 74 65 33 56 64 62 65 41 64 64 4f 70 4c 69 73  ite3VdbeAddOpLis
0f50: 74 28 56 64 62 65 2a 2c 20 69 6e 74 20 6e 4f 70  t(Vdbe*, int nOp
0f60: 2c 20 56 64 62 65 4f 70 4c 69 73 74 20 63 6f 6e  , VdbeOpList con
0f70: 73 74 20 2a 61 4f 70 29 3b 0a 76 6f 69 64 20 73  st *aOp);.void s
0f80: 71 6c 69 74 65 33 56 64 62 65 43 68 61 6e 67 65  qlite3VdbeChange
0f90: 50 31 28 56 64 62 65 2a 2c 20 69 6e 74 20 61 64  P1(Vdbe*, int ad
0fa0: 64 72 2c 20 69 6e 74 20 50 31 29 3b 0a 76 6f 69  dr, int P1);.voi
0fb0: 64 20 73 71 6c 69 74 65 33 56 64 62 65 43 68 61  d sqlite3VdbeCha
0fc0: 6e 67 65 50 32 28 56 64 62 65 2a 2c 20 69 6e 74  ngeP2(Vdbe*, int
0fd0: 20 61 64 64 72 2c 20 69 6e 74 20 50 32 29 3b 0a   addr, int P2);.
0fe0: 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62 65  void sqlite3Vdbe
0ff0: 43 68 61 6e 67 65 50 33 28 56 64 62 65 2a 2c 20  ChangeP3(Vdbe*, 
1000: 69 6e 74 20 61 64 64 72 2c 20 63 6f 6e 73 74 20  int addr, const 
1010: 63 68 61 72 20 2a 7a 50 31 2c 20 69 6e 74 20 4e  char *zP1, int N
1020: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56  );.void sqlite3V
1030: 64 62 65 44 65 71 75 6f 74 65 50 33 28 56 64 62  dbeDequoteP3(Vdb
1040: 65 2a 2c 20 69 6e 74 20 61 64 64 72 29 3b 0a 69  e*, int addr);.i
1050: 6e 74 20 73 71 6c 69 74 65 33 56 64 62 65 46 69  nt sqlite3VdbeFi
1060: 6e 64 4f 70 28 56 64 62 65 2a 2c 20 69 6e 74 2c  ndOp(Vdbe*, int,
1070: 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 56 64 62 65   int, int);.Vdbe
1080: 4f 70 20 2a 73 71 6c 69 74 65 33 56 64 62 65 47  Op *sqlite3VdbeG
1090: 65 74 4f 70 28 56 64 62 65 2a 2c 20 69 6e 74 29  etOp(Vdbe*, int)
10a0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62  ;.int sqlite3Vdb
10b0: 65 4d 61 6b 65 4c 61 62 65 6c 28 56 64 62 65 2a  eMakeLabel(Vdbe*
10c0: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56  );.void sqlite3V
10d0: 64 62 65 44 65 6c 65 74 65 28 56 64 62 65 2a 29  dbeDelete(Vdbe*)
10e0: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64  ;.void sqlite3Vd
10f0: 62 65 4d 61 6b 65 52 65 61 64 79 28 56 64 62 65  beMakeReady(Vdbe
1100: 2a 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74 2c 69 6e  *,int,int,int,in
1110: 74 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69  t,int);.int sqli
1120: 74 65 33 56 64 62 65 46 69 6e 61 6c 69 7a 65 28  te3VdbeFinalize(
1130: 56 64 62 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c  Vdbe*);.void sql
1140: 69 74 65 33 56 64 62 65 52 65 73 6f 6c 76 65 4c  ite3VdbeResolveL
1150: 61 62 65 6c 28 56 64 62 65 2a 2c 20 69 6e 74 29  abel(Vdbe*, int)
1160: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62  ;.int sqlite3Vdb
1170: 65 43 75 72 72 65 6e 74 41 64 64 72 28 56 64 62  eCurrentAddr(Vdb
1180: 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65  e*);.void sqlite
1190: 33 56 64 62 65 54 72 61 63 65 28 56 64 62 65 2a  3VdbeTrace(Vdbe*
11a0: 2c 46 49 4c 45 2a 29 3b 0a 69 6e 74 20 73 71 6c  ,FILE*);.int sql
11b0: 69 74 65 33 56 64 62 65 52 65 73 65 74 28 56 64  ite3VdbeReset(Vd
11c0: 62 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  be*);.int sqlite
11d0: 56 64 62 65 53 65 74 56 61 72 69 61 62 6c 65 73  VdbeSetVariables
11e0: 28 56 64 62 65 2a 2c 69 6e 74 2c 63 6f 6e 73 74  (Vdbe*,int,const
11f0: 20 63 68 61 72 2a 2a 29 3b 0a 76 6f 69 64 20 73   char**);.void s
1200: 71 6c 69 74 65 33 56 64 62 65 53 65 74 4e 75 6d  qlite3VdbeSetNum
1210: 43 6f 6c 73 28 56 64 62 65 2a 2c 69 6e 74 29 3b  Cols(Vdbe*,int);
1220: 0a 69 6e 74 20 73 71 6c 69 74 65 33 56 64 62 65  .int sqlite3Vdbe
1230: 53 65 74 43 6f 6c 4e 61 6d 65 28 56 64 62 65 2a  SetColName(Vdbe*
1240: 2c 20 69 6e 74 2c 20 63 6f 6e 73 74 20 63 68 61  , int, const cha
1250: 72 20 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20  r *, int);.void 
1260: 73 71 6c 69 74 65 33 56 64 62 65 43 6f 75 6e 74  sqlite3VdbeCount
1270: 43 68 61 6e 67 65 73 28 56 64 62 65 2a 29 3b 0a  Changes(Vdbe*);.
1280: 73 71 6c 69 74 65 33 20 2a 73 71 6c 69 74 65 33  sqlite3 *sqlite3
1290: 56 64 62 65 44 62 28 56 64 62 65 2a 29 3b 0a 0a  VdbeDb(Vdbe*);..
12a0: 23 69 66 6e 64 65 66 20 4e 44 45 42 55 47 0a 20  #ifndef NDEBUG. 
12b0: 20 76 6f 69 64 20 73 71 6c 69 74 65 33 56 64 62   void sqlite3Vdb
12c0: 65 43 6f 6d 6d 65 6e 74 28 56 64 62 65 2a 2c 20  eComment(Vdbe*, 
12d0: 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 2e 2e 2e  const char*, ...
12e0: 29 3b 0a 23 20 64 65 66 69 6e 65 20 56 64 62 65  );.# define Vdbe
12f0: 43 6f 6d 6d 65 6e 74 28 58 29 20 20 73 71 6c 69  Comment(X)  sqli
1300: 74 65 33 56 64 62 65 43 6f 6d 6d 65 6e 74 20 58  te3VdbeComment X
1310: 0a 23 65 6c 73 65 0a 23 20 64 65 66 69 6e 65 20  .#else.# define 
1320: 56 64 62 65 43 6f 6d 6d 65 6e 74 28 58 29 0a 23  VdbeComment(X).#
1330: 65 6e 64 69 66 0a 0a 23 65 6e 64 69 66 0a        endif..#endif.