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