debug.c File Reference

Debugging support. More...

#include "internal.h"

Include dependency graph for debug.c:

Go to the source code of this file.

Functions
void	tm_msg_enable (const char *codes, int enable)
	Enable or disable messages.
void	tm_msg (const char *format,...)
	Prints messages to tm_msg_file.
void	tm_msg1 (const char *format,...)
	Format additional message data.
void	_tm_assert (const char *expr, const char *file, int lineno)
	Format assertion error.
void	tm_validate_lists ()
	Validate internal lists against bookkeeping stats.
Variables
const char *	tm_color_name []
	Color names.
const char *	tm_struct_name []
	Struct names.
const char *	tm_phase_name []
	Phase names.
FILE *	tm_msg_file = 0
	Debug message file handle.
const char *	tm_msg_prefix = ""
const char *	tm_msg_enable_default
	Default messaages to enable.
int	tm_msg_enable_all = 0
	Enable all messages?
int	_tm_sweep_is_error = 0
	If true and sweep occurs, raise a error.
void	tm_stop ()
	Put a debugger break point here!
void	tm_fatal ()
	Fatal, non-recoverable internal error.
void	tm_abort ()
	Abort after printing stats.
int	_tm_check_sweep_error ()
	Checks for a unexpected node sweep.

---

Detailed Description

Debugging support.

Definition in file debug.c.

---

Function Documentation

int _tm_check_sweep_error

(

)

Checks for a unexpected node sweep.

If a sweep occured at this time, the mark phase created a free tm_node (tm_WHITE) when it should not have.

TM failed to mark all tm_nodes as in-use (tm_GREY, or tm_BLACK).

This can be considered a bug in:

• The write barrier.
• Mutators that failed to use the write barrier.
• Locating nodes for potential pointers.
• Other book-keeping or list management.

OK: A sweep is not considered an error.

OK: Nothing was left unmarked.

ERROR: There were some unmarked (tm_ECRU) tm_nodes.

Print each unmarked node.

Print stats.

Attempt to mark all roots.

Scan all marked nodes.

Was there still unmarked nodes?

Mark all the tm_ECRU nodes tm_BLACK

Start tm_UNMARK phase.

Assert there is no unmarked nodes.

Stop in debugger?

Clear worst alloc time.

Return 1 to signal an error.

Definition at line 343 of file debug.c.

References _tm_node_scan_all(), _tm_phase_init(), _tm_root_scan_all(), tm_type::color_list, tm_data::n, tm_type::n, tm_type::size, tm, tm_assert_test, tm_BLACK, tm_color_name, tm_ECRU, tm_list_LOOP, tm_list_LOOP_END, tm_msg(), tm_node_color, tm_node_set_color(), tm_node_to_block(), tm_node_to_ptr(), tm_print_stats(), tm_ROOT, tm_SCAN, tm_stop(), tm_UNMARK, tm_data::ts_alloc, tm_time_stat::tw, and tm_data::types.

Referenced by _tm_node_sweep_some().

{
  tm_type *t;
  tm_node *n;

  /*! OK: A sweep is not considered an error. */
  if ( ! _tm_sweep_is_error ) {
    return 0;
  }

  /*! OK: Nothing was left unmarked. */
  if ( ! tm.n[tm_ECRU] ) {
    return 0;
  }

  /*! ERROR: There were some unmarked (tm_ECRU) tm_nodes. */
  tm_msg("Fatal %lu dead nodes; there should be no sweeping.\n", tm.n[tm_ECRU]);
  tm_stop();
  // tm_validate_lists();
  
  /*! Print each unmarked node. */
  tm_list_LOOP(&tm.types, t);
  {
    tm_list_LOOP(&t->color_list[tm_ECRU], n);
    {
      tm_assert_test(tm_node_color(n) == tm_ECRU);
      tm_msg("Fatal node %p color %s size %lu should not be sweeped!\n", 
             (void*) n, 
             tm_color_name[tm_node_color(n)], 
             (unsigned long) t->size);
      {
        void ** vpa = tm_node_to_ptr(n);
        tm_msg("Fatal cons (%d, %p)\n", ((long) vpa[0]) >> 2, vpa[1]);
      }
    }
    tm_list_LOOP_END;
  }
  tm_list_LOOP_END;
  
  /*! Print stats. */
  tm_print_stats();
  
  /*! Attempt to mark all roots. */
  _tm_phase_init(tm_ROOT);
  _tm_root_scan_all();
  
  /*! Scan all marked nodes. */
  _tm_phase_init(tm_SCAN);
  _tm_node_scan_all();
  
  /*! Was there still unmarked nodes? */
  if ( tm.n[tm_ECRU] ) {
    tm_msg("Fatal after root mark: still missing %lu references.\n",
           (unsigned long) tm.n[tm_ECRU]);
  } else {
    tm_msg("Fatal after root mark: OK, missing references found!\n");
  }
  
  /*! Mark all the tm_ECRU nodes tm_BLACK */
  tm_list_LOOP(&tm.types, t);
  {
    tm_list_LOOP(&t->color_list[tm_ECRU], n);
    {
      tm_node_set_color(n, tm_node_to_block(n), tm_BLACK);
    }
    tm_list_LOOP_END;
  }
  tm_list_LOOP_END;
  
  /*! Start tm_UNMARK phase. */
  _tm_phase_init(tm_UNMARK);
  
  /*! Assert there is no unmarked nodes. */
  tm_assert_test(tm.n[tm_ECRU] == 0);
  
  /*! Stop in debugger? */
  tm_stop();
  
  /*! Clear worst alloc time. */
  memset(&tm.ts_alloc.tw, 0, sizeof(tm.ts_alloc.tw));
  
  /*! Return 1 to signal an error. */
  return 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tm_abort

(

)

Abort after printing stats.

Definition at line 194 of file debug.c.

References tm_data::inited, tm, tm_fatal(), and tm_print_stats().

Referenced by _tm_alloc_type_inner(), _tm_node_mark(), _tm_os_alloc_(), _tm_print_utilization(), tm_node_iterator_next(), tm_root_subtract(), and tm_write_barrier_node().

{
  static int in_abort; /* THREAD? */

  ++ in_abort;

  if ( in_abort == 1 && tm.inited ) {
    tm_print_stats();
  }

  -- in_abort;

  tm_fatal();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tm_fatal

(

)

Fatal, non-recoverable internal error.

Definition at line 182 of file debug.c.

References tm_msg(), and tm_stop().

Referenced by _tm_phase_init(), and tm_abort().

{
  tm_msg("Fatal Aborting!\n");

  tm_stop();

  abort();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tm_stop

(

)

Put a debugger break point here!

Definition at line 175 of file debug.c.

Referenced by _tm_alloc_type_inner(), _tm_check_sweep_error(), _tm_phase_init(), and tm_fatal().

{
}

Here is the caller graph for this function:

---

Variable Documentation

int _tm_sweep_is_error = 0

If true and sweep occurs, raise a error.

Definition at line 326 of file debug.c.

Referenced by _tm_gc_full_type_inner().

const char* tm_color_name[]

Initial value:

 {
  "WHITE", 
  "ECRU",  
  "GREY",  
  "BLACK", 

  "TOTAL", 

  "b",     
  "n",     
  "u",     
  "p",     

  "O",     
  "o",     
  "P",     
  "p",     
  0
}

Color names.

Definition at line 10 of file debug.c.

Referenced by _tm_check_sweep_error(), _tm_print_utilization(), tm_node_iterator_next(), tm_print_block_stats(), and tm_print_color_transition_stats().

const char* tm_phase_name[]

Initial value:

 {
  "ALLOC",  
  "UNMARK", 
  "ROOTS",  
  "SCAN",   
  "SWEEP",  
  "Total",  
}

Phase names.

Definition at line 40 of file debug.c.

Referenced by _tm_phase_init(), tm_init(), and tm_print_phase_transition_stats().

const char* tm_struct_name[]

Initial value:

 {
  "FREE_BLOCK",
  "LIVE_BLOCK",
  "FREE_TYPE",
  "LIVE_TYPE",
  0
}

Struct names.

Definition at line 31 of file debug.c.