quantum/variable_trace.h

   1 #ifndef VARIABLE_TRACE_H
   2 #define VARIABLE_TRACE_H
   3
   4 // For more information about the variable tracing see the readme.
   5
   6 #include "print.h"
   7
   8 #ifdef NUM_TRACED_VARIABLES
   9
  10 // Start tracing a variable at the memory address addr
  11 // The name can be anything and is used only for reporting
  12 // The size should usually be the same size as the variable you are interested in
  13 #define ADD_TRACED_VARIABLE(name, addr, size) \
  14     add_traced_variable(PSTR(name), (void*)addr, size, PSTR(__FILE__), __LINE__)
  15
  16 // Stop tracing the variable with the given name
  17 #define REMOVE_TRACED_VARIABLE(name) remove_traced_variable(PSTR(name), PSTR(__FILE__), __LINE__)
  18
  19 // Call to get messages when the variable has been changed
  20 #define VERIFY_TRACED_VARIABLES() verify_traced_variables(PSTR(__FILE__), __LINE__)
  21
  22 #else
  23
  24 #define ADD_TRACED_VARIABLE(name, addr, size)
  25 #define REMOVE_TRACED_VARIABLE(name)
  26 #define VERIFY_TRACED_VARIABLES()
  27
  28 #endif
  29
  30 // Don't call directly, use the macros instead
  31 void add_traced_variable(const char* name, void* addr, unsigned size, const char* func, int line);
  32 void remove_traced_variable(const char* name, const char* func, int line);
  33 void verify_traced_variables(const char* func, int line);
  34 #endif