My Marlin configs for Fabrikator Mini and CTC i3 Pro B
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.

M100_Free_Mem_Chk.cpp 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  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 "gcode.h"
  58. #include "hex_print_routines.h"
  59. //
  60. // Utility functions
  61. //
  62. #define END_OF_HEAP() (__brkval ? __brkval : &__bss_end)
  63. int check_for_free_memory_corruption(const char * const title);
  64. // Location of a variable on its stack frame. Returns a value above
  65. // the stack (once the function returns to the caller).
  66. char* top_of_stack() {
  67. char x;
  68. return &x + 1; // x is pulled on return;
  69. }
  70. // Count the number of test bytes at the specified location.
  71. int16_t count_test_bytes(const char * const ptr) {
  72. for (uint16_t i = 0; i < 32000; i++)
  73. if (((char) ptr[i]) != TEST_BYTE)
  74. return i - 1;
  75. return -1;
  76. }
  77. //
  78. // M100 sub-commands
  79. //
  80. #if ENABLED(M100_FREE_MEMORY_DUMPER)
  81. /**
  82. * M100 D
  83. * Dump the free memory block from __brkval to the stack pointer.
  84. * malloc() eats memory from the start of the block and the stack grows
  85. * up from the bottom of the block. Solid test bytes indicate nothing has
  86. * used that memory yet. There should not be anything but test bytes within
  87. * the block. If so, it may indicate memory corruption due to a bad pointer.
  88. * Unexpected bytes are flagged in the right column.
  89. */
  90. void dump_free_memory(const char *ptr, const char *sp) {
  91. //
  92. // Start and end the dump on a nice 16 byte boundary
  93. // (even though the values are not 16-byte aligned).
  94. //
  95. ptr = (char *)((uint16_t)ptr & 0xFFF0); // Align to 16-byte boundary
  96. sp = (char *)((uint16_t)sp | 0x000F); // Align sp to the 15th byte (at or above sp)
  97. // Dump command main loop
  98. while (ptr < sp) {
  99. print_hex_word((uint16_t)ptr); // Print the address
  100. SERIAL_CHAR(':');
  101. for (uint8_t i = 0; i < 16; i++) { // and 16 data bytes
  102. if (i == 8) SERIAL_CHAR('-');
  103. print_hex_byte(ptr[i]);
  104. SERIAL_CHAR(' ');
  105. }
  106. safe_delay(25);
  107. SERIAL_CHAR('|'); // Point out non test bytes
  108. for (uint8_t i = 0; i < 16; i++) {
  109. char ccc = (char)ptr[i]; // cast to char before automatically casting to char on assignment, in case the compiler is broken
  110. if (&ptr[i] >= (const char*)command_queue && &ptr[i] < (const char*)(command_queue + sizeof(command_queue))) { // Print out ASCII in the command buffer area
  111. if (!WITHIN(ccc, ' ', 0x7E)) ccc = ' ';
  112. }
  113. else { // If not in the command buffer area, flag bytes that don't match the test byte
  114. ccc = (ccc == TEST_BYTE) ? ' ' : '?';
  115. }
  116. SERIAL_CHAR(ccc);
  117. }
  118. SERIAL_EOL();
  119. ptr += 16;
  120. safe_delay(25);
  121. idle();
  122. }
  123. }
  124. void M100_dump_routine(const char * const title, const char *start, const char *end) {
  125. SERIAL_ECHOLN(title);
  126. //
  127. // Round the start and end locations to produce full lines of output
  128. //
  129. start = (char*)((uint16_t) start & 0xFFF0);
  130. end = (char*)((uint16_t) end | 0x000F);
  131. dump_free_memory(start, end);
  132. }
  133. #endif // M100_FREE_MEMORY_DUMPER
  134. /**
  135. * M100 F
  136. * Return the number of free bytes in the memory pool,
  137. * with other vital statistics defining the pool.
  138. */
  139. void free_memory_pool_report(char * const ptr, const int16_t size) {
  140. int16_t max_cnt = -1, block_cnt = 0;
  141. char *max_addr = NULL;
  142. // Find the longest block of test bytes in the buffer
  143. for (int16_t i = 0; i < size; i++) {
  144. char *addr = ptr + i;
  145. if (*addr == TEST_BYTE) {
  146. const int16_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. ptr += 8;
  174. const uint16_t near_top = top_of_stack() - ptr - 250, // -250 to avoid interrupt activity that's altered the stack.
  175. j = near_top / (size + 1);
  176. SERIAL_ECHOLNPGM("Corrupting free memory block.\n");
  177. for (uint16_t i = 1; i <= size; i++) {
  178. char * const addr = ptr + i * j;
  179. *addr = i;
  180. SERIAL_ECHOPAIR("\nCorrupting address: ", hex_address(addr));
  181. }
  182. SERIAL_EOL();
  183. }
  184. #endif // M100_FREE_MEMORY_CORRUPTOR
  185. /**
  186. * M100 I
  187. * Init memory for the M100 tests. (Automatically applied on the first M100.)
  188. */
  189. void init_free_memory(char *ptr, int16_t size) {
  190. SERIAL_ECHOLNPGM("Initializing free memory block.\n\n");
  191. size -= 250; // -250 to avoid interrupt activity that's altered the stack.
  192. if (size < 0) {
  193. SERIAL_ECHOLNPGM("Unable to initialize.\n");
  194. return;
  195. }
  196. ptr += 8; // move a few bytes away from the heap just because we don't want
  197. // to be altering memory that close to it.
  198. memset(ptr, TEST_BYTE, size);
  199. SERIAL_ECHO(size);
  200. SERIAL_ECHOLNPGM(" bytes of memory initialized.\n");
  201. for (int16_t i = 0; i < size; i++) {
  202. if (ptr[i] != TEST_BYTE) {
  203. SERIAL_ECHOPAIR("? address : ", hex_address(ptr + i));
  204. SERIAL_ECHOLNPAIR("=", hex_byte(ptr[i]));
  205. SERIAL_EOL();
  206. }
  207. }
  208. }
  209. /**
  210. * M100: Free Memory Check
  211. */
  212. void gcode_M100() {
  213. SERIAL_ECHOPAIR("\n__brkval : ", hex_address(__brkval));
  214. SERIAL_ECHOPAIR("\n__bss_end : ", hex_address(&__bss_end));
  215. char *ptr = END_OF_HEAP(), *sp = top_of_stack();
  216. SERIAL_ECHOPAIR("\nstart of free space : ", hex_address(ptr));
  217. SERIAL_ECHOLNPAIR("\nStack Pointer : ", hex_address(sp));
  218. // Always init on the first invocation of M100
  219. static bool m100_not_initialized = true;
  220. if (m100_not_initialized || parser.seen('I')) {
  221. m100_not_initialized = false;
  222. init_free_memory(ptr, sp - ptr);
  223. }
  224. #if ENABLED(M100_FREE_MEMORY_DUMPER)
  225. if (parser.seen('D'))
  226. return dump_free_memory(ptr, sp);
  227. #endif
  228. if (parser.seen('F'))
  229. return free_memory_pool_report(ptr, sp - ptr);
  230. #if ENABLED(M100_FREE_MEMORY_CORRUPTOR)
  231. if (parser.seen('C'))
  232. return corrupt_free_memory(ptr, parser.value_int());
  233. #endif
  234. }
  235. int check_for_free_memory_corruption(const char * const title) {
  236. SERIAL_ECHO(title);
  237. char *ptr = END_OF_HEAP(), *sp = top_of_stack();
  238. int n = sp - ptr;
  239. SERIAL_ECHOPAIR("\nfmc() n=", n);
  240. SERIAL_ECHOPAIR("\n&__brkval: ", hex_address(&__brkval));
  241. SERIAL_ECHOPAIR("=", hex_address(__brkval));
  242. SERIAL_ECHOPAIR("\n__bss_end: ", hex_address(&__bss_end));
  243. SERIAL_ECHOPAIR(" sp=", hex_address(sp));
  244. if (sp < ptr) {
  245. SERIAL_ECHOPGM(" sp < Heap ");
  246. // SET_INPUT_PULLUP(63); // if the developer has a switch wired up to their controller board
  247. // safe_delay(5); // this code can be enabled to pause the display as soon as the
  248. // while ( READ(63)) // malfunction is detected. It is currently defaulting to a switch
  249. // idle(); // being on pin-63 which is unassigend and available on most controller
  250. // safe_delay(20); // boards.
  251. // while ( !READ(63))
  252. // idle();
  253. safe_delay(20);
  254. #ifdef M100_FREE_MEMORY_DUMPER
  255. M100_dump_routine(" Memory corruption detected with sp<Heap\n", (char*)0x1B80, (char*)0x21FF);
  256. #endif
  257. }
  258. // Scan through the range looking for the biggest block of 0xE5's we can find
  259. int block_cnt = 0;
  260. for (int i = 0; i < n; i++) {
  261. if (ptr[i] == TEST_BYTE) {
  262. int16_t j = count_test_bytes(ptr + i);
  263. if (j > 8) {
  264. // SERIAL_ECHOPAIR("Found ", j);
  265. // SERIAL_ECHOLNPAIR(" bytes free at ", hex_address(ptr + i));
  266. i += j;
  267. block_cnt++;
  268. SERIAL_ECHOPAIR(" (", block_cnt);
  269. SERIAL_ECHOPAIR(") found=", j);
  270. SERIAL_ECHOPGM(" ");
  271. }
  272. }
  273. }
  274. SERIAL_ECHOPAIR(" block_found=", block_cnt);
  275. if (block_cnt != 1 || __brkval != 0x0000)
  276. SERIAL_ECHOLNPGM("\nMemory Corruption detected in free memory area.");
  277. if (block_cnt == 0) // Make sure the special case of no free blocks shows up as an
  278. block_cnt = -1; // error to the calling code!
  279. SERIAL_ECHOPGM(" return=");
  280. if (block_cnt == 1) {
  281. SERIAL_CHAR('0'); // if the block_cnt is 1, nothing has broken up the free memory
  282. SERIAL_EOL(); // area and it is appropriate to say 'no corruption'.
  283. return 0;
  284. }
  285. SERIAL_ECHOLNPGM("true");
  286. return block_cnt;
  287. }
  288. #endif // M100_FREE_MEMORY_WATCHER