Changeset 21454 for main/trunk/greenstone2

Timestamp:

2010-01-14T18:46:45+13:00 (14 years ago)

Author:

ak19

Message:

Dr Bainbridge added the useful new method check_system_heap() for Windows which calls _heapchk. It's helpful in detecting memory related errors when these have weird and inexplicable effects and which the debugger cannot help in unravelling.

Location:

main/trunk/greenstone2/common-src/src/lib

Files:

• gsdltools.cpp (modified) (1 diff)
• gsdltools.h (modified) (1 diff)

main/trunk/greenstone2/common-src/src/lib/gsdltools.cpp

@@ -279 +279 @@
   return (i == 0);
 }
+
+
+#if defined(__WIN32__)
+// A very useful function to call to debug mysterious heap memory errors when
+// their cause isn't clear in the Vis Studio debugger. Call it from various 
+// places of the code and narrow down the point at which the heap memory becomes 
+// corrupted. The title param can be the method this function is called from.
+void check_system_heap(char* title)
+{
+  int heapstatus = _heapchk();
+
+  char message[1024];
+
+  switch (heapstatus) {
+  case _HEAPOK:
+    sprintf(message,"%s","OK - heap is fine");
+    break;
+  case _HEAPEMPTY:
+    sprintf(message,"%s","OK - heap is empty");
+    break;
+  case _HEAPBADBEGIN:
+    sprintf(message,"%s","ERROR - bad start of heap");
+    break;
+  case _HEAPBADNODE:
+    sprintf(message,"%s","Error - bad node in heap");
+    break;
+  default:
+    sprintf(message,"%s: %d","Unrecognized heap status",heapstatus);
+  }
+
+  MessageBox (NULL, message, title, MB_OK);
+}
+
+#endif

main/trunk/greenstone2/common-src/src/lib/gsdltools.h

@@ -73 +73 @@
 bool perl_ok (ostream &logout);
 
+#if defined(__WIN32__)
+void check_system_heap(char* title);
+#endif
+
 #endif