My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

M100_Free_Mem_Chk.cpp 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * M100 Free Memory Watcher
  24. *
  25. * This code watches the free memory block between the bottom of the heap and the top of the stack.
  26. * This memory block is initialized and watched via the M100 command.
  27. *
  28. * M100 I Initializes the free memory block and prints vitals statistics about the area
  29. *
  30. * M100 F Identifies how much of the free memory block remains free and unused. It also
  31. * detects and reports any corruption within the free memory block that may have
  32. * happened due to errant firmware.
  33. *
  34. * M100 D Does a hex display of the free memory block along with a flag for any errant
  35. * data that does not match the expected value.
  36. *
  37. * M100 C x Corrupts x locations within the free memory block. This is useful to check the
  38. * correctness of the M100 F and M100 D commands.
  39. *
  40. * Also, there are two support functions that can be called from a developer's C code.
  41. *
  42. * uint16_t check_for_free_memory_corruption(const char * const ptr);
  43. * void M100_dump_routine(const char * const title, const char *start, const char *end);
  44. *
  45. * Initial version by Roxy-3D
  46. */
  47. #define M100_FREE_MEMORY_DUMPER // Enable for the `M110 D` Dump sub-command
  48. #define M100_FREE_MEMORY_CORRUPTOR // Enable for the `M100 C` Corrupt sub-command
  49. #include "MarlinConfig.h"
  50. #if ENABLED(M100_FREE_MEMORY_WATCHER)
  51. #define TEST_BYTE ((char) 0xE5)
  52. extern char command_queue[BUFSIZE][MAX_CMD_SIZE];
  53. extern char* __brkval;
  54. extern size_t __heap_start, __heap_end, __flp;
  55. extern char __bss_end;
  56. #include "Marlin.h"
  57. #include "hex_print_routines.h"
  58. //
  59. // Utility functions
  60. //
  61. #define END_OF_HEAP() (__brkval ? __brkval : &__bss_end)
  62. int check_for_free_memory_corruption(const char * const title);
  63. // Location of a variable on its stack frame. Returns a value above
  64. // the stack (once the function returns to the caller).
  65. char* top_of_stack() {
  66. char x;
  67. return &x + 1; // x is pulled on return;
  68. }
  69. // Count the number of test bytes at the specified location.
  70. int16_t count_test_bytes(const uint8_t * const ptr) {
  71. for (uint16_t i = 0; i < 32000; i++)
  72. if (((char) ptr[i]) != TEST_BYTE)
  73. return i - 1;
  74. return -1;
  75. }
  76. //
  77. // M100 sub-commands
  78. //
  79. #if ENABLED(M100_FREE_MEMORY_DUMPER)
  80. /**
  81. * M100 D
  82. * Dump the free memory block from __brkval to the stack pointer.
  83. * malloc() eats memory from the start of the block and the stack grows
  84. * up from the bottom of the block. Solid test bytes indicate nothing has
  85. * used that memory yet. There should not be anything but test bytes within
  86. * the block. If so, it may indicate memory corruption due to a bad pointer.
  87. * Unexpected bytes are flagged in the right column.
  88. */
  89. void dump_free_memory(const uint8_t *ptr, const uint8_t *sp) {
  90. //
  91. // Start and end the dump on a nice 16 byte boundary
  92. // (even though the values are not 16-byte aligned).
  93. //
  94. ptr = (uint8_t *)((uint16_t)ptr & 0xFFF0); // Align to 16-byte boundary
  95. sp = (uint8_t *)((uint16_t)sp | 0x000F); // Align sp to the 15th byte (at or above sp)
  96. // Dump command main loop
  97. while (ptr < sp) {
  98. print_hex_word((uint16_t)ptr); // Print the address
  99. SERIAL_CHAR(':');
  100. for (uint8_t i = 0; i < 16; i++) { // and 16 data bytes
  101. if (i == 8) SERIAL_CHAR('-');
  102. print_hex_byte(ptr[i]);
  103. SERIAL_CHAR(' ');
  104. }
  105. safe_delay(25);
  106. SERIAL_CHAR('|'); // Point out non test bytes
  107. for (uint8_t i = 0; i < 16; i++) {
  108. char ccc = (char)ptr[i]; // cast to char before automatically casting to char on assignment, in case the compiler is broken
  109. if (&ptr[i] >= command_queue && &ptr[i] < &command_queue[BUFSIZE][MAX_CMD_SIZE]) { // Print out ASCII in the command buffer area
  110. if (!WITHIN(ccc, ' ', 0x7E)) ccc = ' ';
  111. }
  112. else { // If not in the command buffer area, flag bytes that don't match the test byte
  113. ccc = (ccc == TEST_BYTE) ? ' ' : '?';
  114. }
  115. SERIAL_CHAR(ccc);
  116. }
  117. SERIAL_EOL;
  118. ptr += 16;
  119. safe_delay(25);
  120. idle();
  121. }
  122. }
  123. void M100_dump_routine(const char * const title, const char *start, const char *end) {
  124. SERIAL_ECHOLN(title);
  125. //
  126. // Round the start and end locations to produce full lines of output
  127. //
  128. start = (char*)((uint16_t) start & 0xFFF0);
  129. end = (char*)((uint16_t) end | 0x000F);
  130. dump_free_memory(start, end);
  131. }
  132. #endif // M100_FREE_MEMORY_DUMPER
  133. /**
  134. * M100 F
  135. * Return the number of free bytes in the memory pool,
  136. * with other vital statistics defining the pool.
  137. */
  138. void free_memory_pool_report(const char * const ptr, const uint16_t size) {
  139. int16_t max_cnt = -1;
  140. uint16_t block_cnt = 0;
  141. char *max_addr = NULL;
  142. // Find the longest block of test bytes in the buffer
  143. for (uint16_t i = 0; i < size; i++) {
  144. char * const addr = ptr + i;
  145. if (*addr == TEST_BYTE) {
  146. const uint16_t j = count_test_bytes(addr);
  147. if (j > 8) {
  148. SERIAL_ECHOPAIR("Found ", j);
  149. SERIAL_ECHOLNPAIR(" bytes free at ", hex_address(addr));
  150. if (j > max_cnt) {
  151. max_cnt = j;
  152. max_addr = addr;
  153. }
  154. i += j;
  155. block_cnt++;
  156. }
  157. }
  158. }
  159. if (block_cnt > 1) {
  160. SERIAL_ECHOLNPGM("\nMemory Corruption detected in free memory area.");
  161. SERIAL_ECHOPAIR("\nLargest free block is ", max_cnt);
  162. SERIAL_ECHOLNPAIR(" bytes at ", hex_address(max_addr));
  163. }
  164. SERIAL_ECHOLNPAIR("check_for_free_memory_corruption() = ", check_for_free_memory_corruption("M100 F "));
  165. }
  166. #if ENABLED(M100_FREE_MEMORY_CORRUPTOR)
  167. /**
  168. * M100 C<num>
  169. * Corrupt <num> locations in the free memory pool and report the corrupt addresses.
  170. * This is useful to check the correctness of the M100 D and the M100 F commands.
  171. */
  172. void corrupt_free_memory(char *ptr, const uint16_t size) {
  173. if (code_seen('C')) {
  174. ptr += 8;
  175. const uint16_t near_top = top_of_stack() - ptr - 250, // -250 to avoid interrupt activity that's altered the stack.
  176. j = near_top / (size + 1);
  177. SERIAL_ECHOLNPGM("Corrupting free memory block.\n");
  178. for (uint16_t i = 1; i <= size; i++) {
  179. char * const addr = ptr + i * j;
  180. *addr = i;
  181. SERIAL_ECHOPAIR("\nCorrupting address: ", hex_address(addr));
  182. }
  183. SERIAL_EOL;
  184. }
  185. }
  186. #endif // M100_FREE_MEMORY_CORRUPTOR
  187. /**
  188. * M100 I
  189. * Init memory for the M100 tests. (Automatically applied on the first M100.)
  190. */
  191. void init_free_memory(uint8_t *ptr, int16_t size) {
  192. SERIAL_ECHOLNPGM("Initializing free memory block.\n\n");
  193. size -= 250; // -250 to avoid interrupt activity that's altered the stack.
  194. if (size < 0) {
  195. SERIAL_ECHOLNPGM("Unable to initialize.\n");
  196. return;
  197. }
  198. ptr += 8; // move a few bytes away from the heap just because we don't want
  199. // to be altering memory that close to it.
  200. memset(ptr, TEST_BYTE, size);
  201. SERIAL_ECHO(size);
  202. SERIAL_ECHOLNPGM(" bytes of memory initialized.\n");
  203. for (uint16_t i = 0; i < size; i++) {
  204. if ((char)ptr[i] != TEST_BYTE) {
  205. SERIAL_ECHOPAIR("? address : ", hex_address(ptr + i));
  206. SERIAL_ECHOLNPAIR("=", hex_byte(ptr[i]));
  207. SERIAL_EOL;
  208. }
  209. }
  210. }
  211. /**
  212. * M100: Free Memory Check
  213. */
  214. void gcode_M100() {
  215. SERIAL_ECHOPAIR("\n__brkval : ", hex_address(__brkval));
  216. SERIAL_ECHOPAIR("\n__bss_end : ", hex_address(&__bss_end));
  217. char *ptr = END_OF_HEAP(), *sp = top_of_stack();
  218. SERIAL_ECHOPAIR("\nstart of free space : ", hex_address(ptr));
  219. SERIAL_ECHOLNPAIR("\nStack Pointer : ", hex_address(sp));
  220. // Always init on the first invocation of M100
  221. static bool m100_not_initialized = true;
  222. if (m100_not_initialized || code_seen('I')) {
  223. m100_not_initialized = false;
  224. init_free_memory(ptr, sp - ptr);
  225. }
  226. #if ENABLED(M100_FREE_MEMORY_DUMPER)
  227. if (code_seen('D'))
  228. return dump_free_memory(ptr, sp);
  229. #endif
  230. if (code_seen('F'))
  231. return free_memory_pool_report(ptr, sp - ptr);
  232. #if ENABLED(M100_FREE_MEMORY_CORRUPTOR)
  233. if (code_seen('C'))
  234. return corrupt_free_memory(ptr, code_value_int());
  235. #endif
  236. }
  237. int check_for_free_memory_corruption(const char * const title) {
  238. SERIAL_ECHO(title);
  239. char *ptr = END_OF_HEAP(), *sp = top_of_stack();
  240. int n = sp - ptr;
  241. SERIAL_ECHOPAIR("\nfmc() n=", n);
  242. SERIAL_ECHOPAIR("\n&__brkval: ", hex_address(&__brkval));
  243. SERIAL_ECHOPAIR("=", hex_address(__brkval));
  244. SERIAL_ECHOPAIR("\n__bss_end: ", hex_address(&__bss_end));
  245. SERIAL_ECHOPAIR(" sp=", hex_address(sp));
  246. if (sp < ptr) {
  247. SERIAL_ECHOPGM(" sp < Heap ");
  248. // SET_INPUT_PULLUP(63); // if the developer has a switch wired up to their controller board
  249. // safe_delay(5); // this code can be enabled to pause the display as soon as the
  250. // while ( READ(63)) // malfunction is detected. It is currently defaulting to a switch
  251. // idle(); // being on pin-63 which is unassigend and available on most controller
  252. // safe_delay(20); // boards.
  253. // while ( !READ(63))
  254. // idle();
  255. safe_delay(20);
  256. #ifdef M100_FREE_MEMORY_DUMPER
  257. M100_dump_routine(" Memory corruption detected with sp<Heap\n", (char*)0x1B80, 0x21FF);
  258. #endif
  259. }
  260. // Scan through the range looking for the biggest block of 0xE5's we can find
  261. int block_cnt = 0;
  262. for (int i = 0; i < n; i++) {
  263. if (ptr[i] == TEST_BYTE) {
  264. int16_t j = count_test_bytes(ptr + i);
  265. if (j > 8) {
  266. // SERIAL_ECHOPAIR("Found ", j);
  267. // SERIAL_ECHOLNPAIR(" bytes free at ", hex_address(ptr + i));
  268. i += j;
  269. block_cnt++;
  270. SERIAL_ECHOPAIR(" (", block_cnt);
  271. SERIAL_ECHOPAIR(") found=", j);
  272. SERIAL_ECHOPGM(" ");
  273. }
  274. }
  275. }
  276. SERIAL_ECHOPAIR(" block_found=", block_cnt);
  277. if (block_cnt != 1 || __brkval != 0x0000)
  278. SERIAL_ECHOLNPGM("\nMemory Corruption detected in free memory area.");
  279. if (block_cnt == 0) // Make sure the special case of no free blocks shows up as an
  280. block_cnt = -1; // error to the calling code!
  281. SERIAL_ECHOPGM(" return=");
  282. if (block_cnt == 1) {
  283. SERIAL_CHAR('0'); // if the block_cnt is 1, nothing has broken up the free memory
  284. SERIAL_EOL; // area and it is appropriate to say 'no corruption'.
  285. return 0;
  286. }
  287. SERIAL_ECHOLNPGM("true");
  288. return block_cnt;
  289. }
  290. #endif // M100_FREE_MEMORY_WATCHER