TCL_MEM_DEBUG.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:4k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '" 
  2. '" Copyright (c) 1992-1999 Karl Lehenbauer and Mark Diekhans.
  3. '" Copyright (c) 2000 by Scriptics Corporation.
  4. '" All rights reserved.
  5. '" 
  6. '" RCS: @(#) $Id: TCL_MEM_DEBUG.3,v 1.6 2002/11/15 15:34:17 dkf Exp $
  7. '" 
  8. .so man.macros
  9. .TH TCL_MEM_DEBUG 3 8.1 Tcl "Tcl Library Procedures"
  10. .BS
  11. .SH NAME
  12. TCL_MEM_DEBUG - Compile-time flag to enable Tcl memory debugging.
  13. .BE
  14. .SH DESCRIPTION
  15. When Tcl is compiled with fBTCL_MEM_DEBUGfR defined, a powerful set
  16. of memory debugging aids are included in the compiled binary.  This
  17. includes C and Tcl functions which can aid with debugging
  18. memory leaks, memory allocation overruns, and other memory related
  19. errors.
  20. .SH "ENABLING MEMORY DEBUGGING"
  21. .PP
  22. To enable memory debugging, Tcl should be recompiled from scratch with
  23. fBTCL_MEM_DEBUGfR defined.  This will also compile in a non-stub
  24. version of fBTcl_InitMemoryfR to add the fBmemoryfR command to Tcl.
  25. .PP
  26. fBTCL_MEM_DEBUGfR must be either left defined for all modules or undefined
  27. for all modules that are going to be linked together.  If they are not, link
  28. errors will occur, with either fBTclDbCkfreefR and fBTcl_DbCkallocfR or
  29. fBTcl_CkallocfR and fBTcl_CkfreefR being undefined.
  30. .PP
  31. Once memory debugging support has been compiled into Tcl, the C
  32. functions fBTcl_ValidateAllMemoryfR, and fBTcl_DumpActiveMemoryfR,
  33. and the Tcl fBmemoryfR command can be used to validate and examine
  34. memory usage.
  35. .SH "GUARD ZONES"
  36. .PP
  37. When memory debugging is enabled, whenever a call to fBckallocfR is
  38. made, slightly more memory than requested is allocated so the memory debugging
  39. code can keep track of the allocated memory, and eight-byte ``guard
  40. zones'' are placed in front of and behind the space that will be
  41. returned to the caller.  (The sizes of the guard zones are defined by the
  42. C #define fBLOW_GUARD_SIZEfR and #define fBHIGH_GUARD_SIZEfR
  43. in the file fIgeneric/tclCkalloc.cfR -- it can
  44. be extended if you suspect large overwrite problems, at some cost in
  45. performance.)  A known pattern is written into the guard zones and, on
  46. a call to fBckfreefR, the guard zones of the space being freed are
  47. checked to see if either zone has been modified in any way.  If one
  48. has been, the guard bytes and their new contents are identified, and a
  49. ``low guard failed'' or ``high guard failed'' message is issued.  The
  50. ``guard failed'' message includes the address of the memory packet and
  51. the file name and line number of the code that called fBckfreefR.
  52. This allows you to detect the common sorts of one-off problems, where
  53. not enough space was allocated to contain the data written, for
  54. example.
  55. .SH "DEBUGGING DIFFICULT MEMORY CORRUPTION PROBLEMS"
  56. .PP
  57. Normally, Tcl compiled with memory debugging enabled will make it easy
  58. to isolate a corruption problem.  Turning on memory validation with
  59. the memory command can help isolate difficult problems.  If you
  60. suspect (or know) that corruption is occurring before the Tcl
  61. interpreter comes up far enough for you to issue commands, you can set
  62. fBMEM_VALIDATEfR define, recompile tclCkalloc.c and rebuild Tcl.
  63. This will enable memory validation from the first call to
  64. fBckallocfR, again, at a large performance impact.
  65. .PP
  66. If you are desperate and validating memory on every call to
  67. fBckallocfR and fBckfreefR isn't enough, you can explicitly call
  68. fBTcl_ValidateAllMemoryfR directly at any point.  It takes a fIchar
  69. *fR and an fIintfR which are normally the filename and line number
  70. of the caller, but they can actually be anything you want.  Remember
  71. to remove the calls after you find the problem.
  72. .SH "SEE ALSO"
  73. ckalloc, memory, Tcl_ValidateAllMemory, Tcl_DumpActiveMemory
  74. .SH KEYWORDS
  75. memory, debug