[OpenSPARC-T2-SAM] / legion / docs / readmes / README.debug_hook

/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */
#pragma ident	"@(#)README.debug_hook	1.3	06/10/25 SMI"

##
## Legion now provides a debug_hook feature to enable the following
## functionality:
##	Coverage Analysis (coverage)	see README.coverage
##	Instruction Tracing (trace)	see README.trace
##	Debug Logging (debug_log)	see README.debug_log
##					- replaces the DEBUG_LOG feature)
##	Lockstep Simulation (lockstep)	see README.lockstep
##
## This file provides an overview of these features

[-] Enabling these Features:

    - Selecting the feature from the config file
      In your legion config file, you need to then add a 'debug_hook' directive
      at the end of your 'processor' directive (before the '}' ).
      The 'debug_hook' directive calls out which of the above features to
      enable (NOTE: only one feature can be enabled at a time). The format of
      the 'debug_hook' directive is different for each feature. See each README
      above for specific details.

    - Running with these features
      Once you start legion, the appropriate debug_hook() function will be
      called *before* each instn is executed. This can significantly slow down
      your simulation run.

    - Viewing status while running using ~l
      Each of these features provides some form of output. See each README for
      specific details on what the output is or how to view it. Once in
      debug_hook mode, you can type '~l' on the dumbserial console window
      and this will give you access to the 'dump' routine of the
      currently enabled feature the details of which vary for each debug_hook
      feature.

    - More information:
      See README.coverage README.trace README.debug_log README.lockstep
Commit	Line	Data
920dae64 AT	1	/*
	2	* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
	3	* Use is subject to license terms.
	4	*/
	5	#pragma ident "@(#)README.debug_hook 1.3 06/10/25 SMI"
	6
	7	##
	8	## Legion now provides a debug_hook feature to enable the following
	9	## functionality:
	10	## Coverage Analysis (coverage) see README.coverage
	11	## Instruction Tracing (trace) see README.trace
	12	## Debug Logging (debug_log) see README.debug_log
	13	## - replaces the DEBUG_LOG feature)
	14	## Lockstep Simulation (lockstep) see README.lockstep
	15	##
	16	## This file provides an overview of these features
	17
	18	[-] Enabling these Features:
	19
	20	- Selecting the feature from the config file
	21	In your legion config file, you need to then add a 'debug_hook' directive
	22	at the end of your 'processor' directive (before the '}' ).
	23	The 'debug_hook' directive calls out which of the above features to
	24	enable (NOTE: only one feature can be enabled at a time). The format of
	25	the 'debug_hook' directive is different for each feature. See each README
	26	above for specific details.
	27
	28	- Running with these features
	29	Once you start legion, the appropriate debug_hook() function will be
	30	called before each instn is executed. This can significantly slow down
	31	your simulation run.
	32
	33	- Viewing status while running using ~l
	34	Each of these features provides some form of output. See each README for
	35	specific details on what the output is or how to view it. Once in
	36	debug_hook mode, you can type '~l' on the dumbserial console window
	37	and this will give you access to the 'dump' routine of the
	38	currently enabled feature the details of which vary for each debug_hook
	39	feature.
	40
	41	- More information:
	42	See README.coverage README.trace README.debug_log README.lockstep