home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.2 / amidev_cd_12.iso / devcon / milan_1991 / devcon91.3 / debug / watchdog / mungwall.doc < prev    next >
Text File  |  1992-09-01  |  5KB  |  110 lines
  1. 04-Jun-91 Mungwall 36.45 doc.
  2.  
  3. Mungwall munges memory and watches for illegal FreeMem's.
  4. Mungwall is especially useful in combination with Enforcer.
  5. Output is either serial or parallel (mungwall.par).
  6.  
  7. Memory munging:
  8.  
  9.  - Except when Enforcer is running, location 0 is set to $C0DEDBAD, i.e.
  10.    programs referencing location zero will not f.e. find a null string.
  11.  
  12.  - On startup all free memory is munged with $ABADCAFE. If this number
  13.    shows up, someone is referencing memory in the free list.
  14.  
  15.  - Except when MEMF_CLEAR is set, memory is pre-munged on allocation with
  16.    $DEADFOOD. When this is used in an Enforcer report, the caller is
  17.    allocating memory and doesn't initialize it before using it. Note that
  18.    only memory which has a cookie attached will be pre-munged.
  19.  
  20.  - Memory is filled with $DEADBEEF before it is freed, encouraging
  21.    programs reusing free'ed memory to crash.
  22.  
  23. Memory watching:
  24.  
  25. Mungwall places a magic cookie before the memory allocation.
  26. Along with a wall of bytes on either side of the allocation to keep an
  27. eye on the memory just before or after the allocation. If the
  28. memory wall is trashed, mungwall complains and shows the damaged area.
  29. If memory is trashed so bad that the cookie is completely gone, Mungwall
  30. will not consider it a walled memory allocation and lets it go. Changes
  31. are you'll be corrupting the memory list and/or overwriting other memory
  32. allocation and crash soon after that. If a mungwall hit occurs, memory
  33. will not be munged or free'ed, to give you a change to look at what was
  34. written there.
  35.  
  36. Both null pointer FreeMem()'s and null sized Alloc/FreeMem()'s trigger
  37. mungwall. Mungwall also gets upset when a memoryblock is free'ed with a
  38. size different from the one used for allocating the memoryblock, and will
  39. say so. The integrity of the walls will be tested according to the size
  40. specified on allocation time, but will not be free'ed.
  41.  
  42. Pointers passed to FreeMem() will be rejected if they are non-longword
  43. alligned. Thus possible catching bogus pointers otherwise left untouched
  44. by mungwall.
  45.  
  46. Unless a specific task(s) is watched and that task leaves before mungwall
  47. does, mungwall will always lose some memory.
  48.  
  49. NOTES:
  50.  
  51. Other debugging tools which SetFunction() AllocMem() and/or
  52. FreeMem() and JSR to what they think is the old memory routine,
  53. should be run BEFORE mungwall. Mungwall needs to know the returnaddress
  54. of the initial caller. Running other debugging tools after mungwall
  55. will result in false reports about layers.library and invalid
  56. mungwall reports about the caller. The 'scratcher' for example must
  57. be run before mungwall, 'memoration' can be run afterwards, since it
  58. JMP's.
  59.  
  60. When mungwall is being stopped, the walls around the original allocations
  61. which are not free'ed at that point, will never get free'ed, only the block
  62. within. Thus causing memory fragmentation and memoryloss.
  63.  
  64. Memory allocations larger than 3 gigabytes will not be marked by mungwall.
  65.  
  66.  
  67.  
  68. MUNGWAL [UPDATE] [[TASK name][WAIT]] [SNOOP] [NOSNOOP] [NOWAIT] [INFO]
  69.         [PRESIZE n] [POSTSIZE n] [FILLCHAR 0xXX]
  70.  
  71. TASK name   - Watch only the task(s), or all but the task(s) specified
  72.               with 'name'. Multiple tasknames are indicated by placing
  73.               a '|' between the names. If the names are preceeded by an
  74.               exclamation mark, all tasks except the ones indicated are
  75.               tracked. ALL is a reserved name, indicating all tasks
  76.               should be tracked. Default ALL.
  77.  
  78. PRESIZE     - Size of wall before memory allocation in bytes. Minimum 4,
  79.               maximum 64. Default 32.
  80.  
  81. POSTSIZE    - Size of wall after memory allocation in bytes. Minimum 4,
  82.               maximum 64. The actual number of bytes after the allocation
  83.               may vary slightly, since it's upped to the nearest longword.
  84.               Default 32.
  85.  
  86. FILLCHAR n  - Character to build the memory wall with. Can be indicated
  87.               both hexadecimal and decimal. Default 0xBB.
  88.  
  89. SNOOP       - Produce snoop compatible output. No snoop output is given
  90.               for illegal FreeMem's. Default OFF. Layers AllocMem's and
  91.               FreeMem's are never snooped. SNOOP is particulary useful
  92.               in combination with TASK. Snoop output can be filtered
  93.               with 'snoopstrip' to find the origin of memory loss.
  94.  
  95. WAIT        - Halt task causing a hit and wait for Ctrl-C. Make sure you
  96.             - can issue a break to the task. WAIT can be used without
  97.               specifying a specific taskname to watch. Default OFF.
  98.  
  99. INFO        - Show configuration information.
  100.  
  101. UPDATE      - Indicates an already running mungwall task should be up-
  102.               dated with new parameters. Presize, postsize and fillchar
  103.               can never be updated.
  104.  
  105. The following are extra updating parameters.
  106.  
  107. NOSNOOP     - Turn snooping off.
  108.  
  109. NOWAIT      - No longer halt a task in case of an error.
  110.