/ Hex Artifact Content
Login

Artifact a64e879e4713671b3b2bf1db70efa351d6ac9591:


0000: 2f 2a 0a 2a 2a 20 32 30 30 38 20 4a 61 6e 20 32  /*.** 2008 Jan 2
0010: 32 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 75 74 68  2.**.** The auth
0020: 6f 72 20 64 69 73 63 6c 61 69 6d 73 20 63 6f 70  or disclaims cop
0030: 79 72 69 67 68 74 20 74 6f 20 74 68 69 73 20 73  yright to this s
0040: 6f 75 72 63 65 20 63 6f 64 65 2e 20 20 49 6e 20  ource code.  In 
0050: 70 6c 61 63 65 20 6f 66 0a 2a 2a 20 61 20 6c 65  place of.** a le
0060: 67 61 6c 20 6e 6f 74 69 63 65 2c 20 68 65 72 65  gal notice, here
0070: 20 69 73 20 61 20 62 6c 65 73 73 69 6e 67 3a 0a   is a blessing:.
0080: 2a 2a 0a 2a 2a 20 20 20 20 4d 61 79 20 79 6f 75  **.**    May you
0090: 20 64 6f 20 67 6f 6f 64 20 61 6e 64 20 6e 6f 74   do good and not
00a0: 20 65 76 69 6c 2e 0a 2a 2a 20 20 20 20 4d 61 79   evil..**    May
00b0: 20 79 6f 75 20 66 69 6e 64 20 66 6f 72 67 69 76   you find forgiv
00c0: 65 6e 65 73 73 20 66 6f 72 20 79 6f 75 72 73 65  eness for yourse
00d0: 6c 66 20 61 6e 64 20 66 6f 72 67 69 76 65 20 6f  lf and forgive o
00e0: 74 68 65 72 73 2e 0a 2a 2a 20 20 20 20 4d 61 79  thers..**    May
00f0: 20 79 6f 75 20 73 68 61 72 65 20 66 72 65 65 6c   you share freel
0100: 79 2c 20 6e 65 76 65 72 20 74 61 6b 69 6e 67 20  y, never taking 
0110: 6d 6f 72 65 20 74 68 61 6e 20 79 6f 75 20 67 69  more than you gi
0120: 76 65 2e 0a 2a 2a 0a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ve..**.*********
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: 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 66 69 6c 65  .**.** This file
0180: 20 63 6f 6e 74 61 69 6e 73 20 63 6f 64 65 20 74   contains code t
0190: 6f 20 73 75 70 70 6f 72 74 20 74 68 65 20 63 6f  o support the co
01a0: 6e 63 65 70 74 20 6f 66 20 22 62 65 6e 69 67 6e  ncept of "benign
01b0: 22 20 0a 2a 2a 20 6d 61 6c 6c 6f 63 20 66 61 69  " .** malloc fai
01c0: 6c 75 72 65 73 20 28 77 68 65 6e 20 74 68 65 20  lures (when the 
01d0: 78 4d 61 6c 6c 6f 63 28 29 20 6f 72 20 78 52 65  xMalloc() or xRe
01e0: 61 6c 6c 6f 63 28 29 20 6d 65 74 68 6f 64 20 6f  alloc() method o
01f0: 66 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33  f the.** sqlite3
0200: 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20 73 74 72  _mem_methods str
0210: 75 63 74 75 72 65 20 66 61 69 6c 73 20 74 6f 20  ucture fails to 
0220: 61 6c 6c 6f 63 61 74 65 20 61 20 62 6c 6f 63 6b  allocate a block
0230: 20 6f 66 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61 6e   of memory.** an
0240: 64 20 72 65 74 75 72 6e 73 20 30 29 2e 20 0a 2a  d returns 0). .*
0250: 2a 0a 2a 2a 20 4d 6f 73 74 20 6d 61 6c 6c 6f 63  *.** Most malloc
0260: 20 66 61 69 6c 75 72 65 73 20 61 72 65 20 6e 6f   failures are no
0270: 6e 2d 62 65 6e 69 67 6e 2e 20 41 66 74 65 72 20  n-benign. After 
0280: 74 68 65 79 20 6f 63 63 75 72 2c 20 53 51 4c 69  they occur, SQLi
0290: 74 65 0a 2a 2a 20 61 62 61 6e 64 6f 6e 73 20 74  te.** abandons t
02a0: 68 65 20 63 75 72 72 65 6e 74 20 6f 70 65 72 61  he current opera
02b0: 74 69 6f 6e 20 61 6e 64 20 72 65 74 75 72 6e 73  tion and returns
02c0: 20 61 6e 20 65 72 72 6f 72 20 63 6f 64 65 20 28   an error code (
02d0: 75 73 75 61 6c 6c 79 0a 2a 2a 20 53 51 4c 49 54  usually.** SQLIT
02e0: 45 5f 4e 4f 4d 45 4d 29 20 74 6f 20 74 68 65 20  E_NOMEM) to the 
02f0: 75 73 65 72 2e 20 48 6f 77 65 76 65 72 2c 20 73  user. However, s
0300: 6f 6d 65 74 69 6d 65 73 20 61 20 66 61 75 6c 74  ometimes a fault
0310: 20 69 73 20 6e 6f 74 20 6e 65 63 65 73 73 61 72   is not necessar
0320: 69 6c 79 0a 2a 2a 20 66 61 74 61 6c 2e 20 46 6f  ily.** fatal. Fo
0330: 72 20 65 78 61 6d 70 6c 65 2c 20 69 66 20 61 20  r example, if a 
0340: 6d 61 6c 6c 6f 63 20 66 61 69 6c 73 20 77 68 69  malloc fails whi
0350: 6c 65 20 72 65 73 69 7a 69 6e 67 20 61 20 68 61  le resizing a ha
0360: 73 68 20 74 61 62 6c 65 2c 20 74 68 69 73 20 0a  sh table, this .
0370: 2a 2a 20 69 73 20 63 6f 6d 70 6c 65 74 65 6c 79  ** is completely
0380: 20 72 65 63 6f 76 65 72 61 62 6c 65 20 73 69 6d   recoverable sim
0390: 70 6c 79 20 62 79 20 6e 6f 74 20 63 61 72 72 79  ply by not carry
03a0: 69 6e 67 20 6f 75 74 20 74 68 65 20 72 65 73 69  ing out the resi
03b0: 7a 65 2e 20 54 68 65 20 0a 2a 2a 20 68 61 73 68  ze. The .** hash
03c0: 20 74 61 62 6c 65 20 77 69 6c 6c 20 63 6f 6e 74   table will cont
03d0: 69 6e 75 65 20 74 6f 20 66 75 6e 63 74 69 6f 6e  inue to function
03e0: 20 6e 6f 72 6d 61 6c 6c 79 2e 20 20 53 6f 20 61   normally.  So a
03f0: 20 6d 61 6c 6c 6f 63 20 66 61 69 6c 75 72 65 20   malloc failure 
0400: 0a 2a 2a 20 64 75 72 69 6e 67 20 61 20 68 61 73  .** during a has
0410: 68 20 74 61 62 6c 65 20 72 65 73 69 7a 65 20 69  h table resize i
0420: 73 20 61 20 62 65 6e 69 67 6e 20 66 61 75 6c 74  s a benign fault
0430: 2e 0a 2a 2f 0a 0a 23 69 6e 63 6c 75 64 65 20 22  ..*/..#include "
0440: 73 71 6c 69 74 65 49 6e 74 2e 68 22 0a 0a 23 69  sqliteInt.h"..#i
0450: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49  fndef SQLITE_OMI
0460: 54 5f 42 55 49 4c 54 49 4e 5f 54 45 53 54 0a 0a  T_BUILTIN_TEST..
0470: 2f 2a 0a 2a 2a 20 54 68 65 20 64 65 66 61 75 6c  /*.** The defaul
0480: 74 20 78 42 65 6e 69 67 6e 43 74 72 6c 20 66 75  t xBenignCtrl fu
0490: 6e 63 74 69 6f 6e 20 69 73 20 61 20 6e 6f 2d 6f  nction is a no-o
04a0: 70 0a 2a 2f 0a 73 74 61 74 69 63 20 76 6f 69 64  p.*/.static void
04b0: 20 73 71 6c 69 74 65 33 42 65 6e 69 67 6e 43 74   sqlite3BenignCt
04c0: 72 6c 4e 6f 6f 70 28 69 6e 74 20 65 4f 70 29 7b  rlNoop(int eOp){
04d0: 0a 20 20 28 76 6f 69 64 29 65 4f 70 3b 0a 7d 0a  .  (void)eOp;.}.
04e0: 0a 2f 2a 0a 2a 2a 20 47 6c 6f 62 61 6c 20 76 61  ./*.** Global va
04f0: 72 69 61 62 6c 65 3a 20 20 50 6f 69 6e 74 65 72  riable:  Pointer
0500: 20 74 6f 20 74 68 65 20 62 65 6e 69 67 6e 20 6d   to the benign m
0510: 61 6c 6c 6f 63 20 63 6f 6e 74 72 6f 6c 20 69 6e  alloc control in
0520: 74 65 72 66 61 63 65 2e 0a 2a 2f 0a 73 74 61 74  terface..*/.stat
0530: 69 63 20 76 6f 69 64 20 28 2a 73 71 6c 69 74 65  ic void (*sqlite
0540: 33 78 42 65 6e 69 67 6e 43 74 72 6c 29 28 69 6e  3xBenignCtrl)(in
0550: 74 29 20 3d 20 73 71 6c 69 74 65 33 42 65 6e 69  t) = sqlite3Beni
0560: 67 6e 43 74 72 6c 4e 6f 6f 70 3b 0a 0a 2f 2a 0a  gnCtrlNoop;../*.
0570: 2a 2a 20 52 65 67 69 73 74 65 72 20 61 20 70 6f  ** Register a po
0580: 69 6e 74 65 72 20 74 6f 20 74 68 65 20 62 65 6e  inter to the ben
0590: 69 67 6e 2d 6d 61 6c 6c 6f 63 20 63 6f 6e 74 72  ign-malloc contr
05a0: 6f 6c 20 69 6e 74 65 72 66 61 63 65 20 66 75 6e  ol interface fun
05b0: 63 74 69 6f 6e 2e 0a 2a 2a 20 49 66 20 74 68 65  ction..** If the
05c0: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 4e   argument is a N
05d0: 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20 72 65 67  ULL pointer, reg
05e0: 69 73 74 65 72 20 74 68 65 20 64 65 66 61 75 6c  ister the defaul
05f0: 74 20 6e 6f 2d 6f 70 20 63 6f 6e 74 72 6f 6c 6c  t no-op controll
0600: 65 72 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  er..*/.void sqli
0610: 74 65 33 42 65 6e 69 67 6e 4d 61 6c 6c 6f 63 48  te3BenignMallocH
0620: 6f 6f 6b 73 28 76 6f 69 64 20 28 2a 78 42 65 6e  ooks(void (*xBen
0630: 69 67 6e 43 74 72 6c 29 28 69 6e 74 29 29 7b 0a  ignCtrl)(int)){.
0640: 20 20 73 71 6c 69 74 65 33 78 42 65 6e 69 67 6e    sqlite3xBenign
0650: 43 74 72 6c 20 3d 20 78 42 65 6e 69 67 6e 43 74  Ctrl = xBenignCt
0660: 72 6c 20 3f 20 78 42 65 6e 69 67 6e 43 74 72 6c  rl ? xBenignCtrl
0670: 20 3a 20 73 71 6c 69 74 65 33 42 65 6e 69 67 6e   : sqlite3Benign
0680: 43 74 72 6c 4e 6f 6f 70 3b 0a 7d 0a 0a 2f 2a 0a  CtrlNoop;.}../*.
0690: 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 42 65  ** The sqlite3Be
06a0: 67 69 6e 42 65 6e 69 67 6e 4d 61 6c 6c 6f 63 28  ginBenignMalloc(
06b0: 29 20 61 6e 64 20 73 71 6c 69 74 65 33 45 6e 64  ) and sqlite3End
06c0: 42 65 6e 69 67 6e 4d 61 6c 6c 6f 63 28 29 20 63  BenignMalloc() c
06d0: 61 6c 6c 73 20 62 72 61 63 6b 65 74 0a 2a 2a 20  alls bracket.** 
06e0: 73 65 63 74 69 6f 6e 73 20 6f 66 20 63 6f 64 65  sections of code
06f0: 20 66 6f 72 20 77 68 69 63 68 20 6d 61 6c 6c 6f   for which mallo
0700: 63 20 66 61 69 6c 75 72 65 73 20 61 72 65 20 6e  c failures are n
0710: 6f 6e 2d 66 61 74 61 6c 2e 20 20 0a 2a 2f 0a 76  on-fatal.  .*/.v
0720: 6f 69 64 20 73 71 6c 69 74 65 33 42 65 67 69 6e  oid sqlite3Begin
0730: 42 65 6e 69 67 6e 4d 61 6c 6c 6f 63 28 76 6f 69  BenignMalloc(voi
0740: 64 29 7b 0a 20 20 73 71 6c 69 74 65 33 78 42 65  d){.  sqlite3xBe
0750: 6e 69 67 6e 43 74 72 6c 28 31 29 3b 0a 7d 0a 76  nignCtrl(1);.}.v
0760: 6f 69 64 20 73 71 6c 69 74 65 33 45 6e 64 42 65  oid sqlite3EndBe
0770: 6e 69 67 6e 4d 61 6c 6c 6f 63 28 76 6f 69 64 29  nignMalloc(void)
0780: 7b 0a 20 20 73 71 6c 69 74 65 33 78 42 65 6e 69  {.  sqlite3xBeni
0790: 67 6e 43 74 72 6c 28 30 29 3b 0a 7d 0a 0a 2f 2a  gnCtrl(0);.}../*
07a0: 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 50  .** The sqlite3P
07b0: 72 65 76 69 6f 75 73 42 65 6e 69 67 6e 4d 61 6c  reviousBenignMal
07c0: 6c 6f 63 28 29 20 63 61 6c 6c 20 69 6e 64 69 63  loc() call indic
07d0: 61 74 65 73 20 74 68 61 74 20 74 68 65 20 70 72  ates that the pr
07e0: 65 76 69 6f 75 73 0a 2a 2a 20 6d 61 6c 6c 6f 63  evious.** malloc
07f0: 20 63 61 6c 6c 20 28 77 68 69 63 68 20 6d 75 73   call (which mus
0800: 74 20 68 61 76 65 20 66 61 69 6c 65 64 29 20 77  t have failed) w
0810: 61 73 20 61 20 62 65 6e 69 67 6e 20 66 61 69 6c  as a benign fail
0820: 75 72 65 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c  ure..*/.void sql
0830: 69 74 65 33 50 72 65 76 69 6f 75 73 42 65 6e 69  ite3PreviousBeni
0840: 67 6e 4d 61 6c 6c 6f 63 28 76 6f 69 64 29 7b 0a  gnMalloc(void){.
0850: 20 20 73 71 6c 69 74 65 33 78 42 65 6e 69 67 6e    sqlite3xBenign
0860: 43 74 72 6c 28 32 29 3b 0a 7d 0a 0a 23 65 6e 64  Ctrl(2);.}..#end
0870: 69 66 20 20 20 2f 2a 20 23 69 66 6e 64 65 66 20  if   /* #ifndef 
0880: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 42 55 49 4c  SQLITE_OMIT_BUIL
0890: 54 49 4e 5f 54 45 53 54 20 2a 2f 0a              TIN_TEST */.