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

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

##
##	Debug Logging (debug_log)
##
## This explains how to enable and use the lockstep feature
##

[-] Enabling this Features:

    See README.debug_hook for the overview of the debug_hook feature.

[-] Debug Logging:

    Description:
    This feature allows you to gather a circular buffer of the last N
    Instructions executed by the simulator.

    The current debug_log contents can be printed at any time by either 
    typing ~l on the legion console or by calling debug_log_print
    from within a debugger (dbx, gdb).

    Format:
         * debug_hook [debug_log]
         *
         * [debug_log]  - we've already parsed this. That's how we got here.
         *
	 * For the moment, there are no more options. We are planning
	 * on adding the ability to set the log_size and also to set
	 * the %pc, instn_cnt for when to turn on logging.

    Examples:
                processor "niagara" {
                        clkfreq 5000000 ;
                        cores 1;
                        vthreads 1;
                        nglobals 4;
                        nwins 8;
                        rstv 0xfff0000020;
                        maxtl 7;
			// debug_log examples:
			debug_hook debug_log;
		}

    Viewing Data:
    The current debug_log contents can be printed at any time by either 
    typing ~l on the legion console or by calling debug_log_print
    from within a debugger (dbx, gdb).

    Modifying Source:
    The source for the coverage feature is contained in
	src/procs/sunsparc/debug/debug_log.c
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_log 1.2 06/10/25 SMI"
	6
	7	##
	8	## Debug Logging (debug_log)
	9	##
	10	## This explains how to enable and use the lockstep feature
	11	##
	12
	13	[-] Enabling this Features:
	14
	15	See README.debug_hook for the overview of the debug_hook feature.
	16
	17	[-] Debug Logging:
	18
	19	Description:
	20	This feature allows you to gather a circular buffer of the last N
	21	Instructions executed by the simulator.
	22
	23	The current debug_log contents can be printed at any time by either
	24	typing ~l on the legion console or by calling debug_log_print
	25	from within a debugger (dbx, gdb).
	26
	27	Format:
	28	* debug_hook [debug_log]
	29	*
	30	* [debug_log] - we've already parsed this. That's how we got here.
	31	*
	32	* For the moment, there are no more options. We are planning
	33	* on adding the ability to set the log_size and also to set
	34	* the %pc, instn_cnt for when to turn on logging.
	35
	36	Examples:
	37	processor "niagara" {
	38	clkfreq 5000000 ;
	39	cores 1;
	40	vthreads 1;
	41	nglobals 4;
	42	nwins 8;
	43	rstv 0xfff0000020;
	44	maxtl 7;
	45	// debug_log examples:
	46	debug_hook debug_log;
	47	}
	48
	49	Viewing Data:
	50	The current debug_log contents can be printed at any time by either
	51	typing ~l on the legion console or by calling debug_log_print
	52	from within a debugger (dbx, gdb).
	53
	54	Modifying Source:
	55	The source for the coverage feature is contained in
	56	src/procs/sunsparc/debug/debug_log.c
	57