config.h

Section: PARSEC Hooks Instrumentation API (3)
Updated: 16 Jan 2009
Index Return to Main Contents
 

NAME

config.h - The configuration file for PARSEC Hooks Instrumentation API.  

SYNOPSIS


 

Defines


#define _PARSEC_HOOKS_CONFIG_H 1

#define ENABLE_TIMING 1
Measure execution time of Region-of-Interest.
#define ENABLE_SIMICS_MAGIC 0
Execute SIMICS magic instruction at beginning and end of Region-of-Interest.
#define HOOKS_PREFIX '[HOOKS]'
Prefix for all output.
#define HOOKS_VERSION '1.1'
Version number of this implementation of the PARSEC hooks.  

Detailed Description

The configuration file for PARSEC Hooks Instrumentation API.

This file serves as a central point to enable or disable functionality of the hooks library functions. To enable functionality simply define the corresponding macro to be 1 and 0 otherwise.

The Hooks API is specified in file hooks.h and the functionality is implemented in file hooks.c.  

Define Documentation

 

#define _PARSEC_HOOKS_CONFIG_H 1

Guard macro to prevent multiple inclusions.  

#define ENABLE_SIMICS_MAGIC 0

Execute SIMICS magic instruction at beginning and end of Region-of-Interest.

If this macro is defined to 1 a `magic instruction' recognized by the Simics simulator is inserted at the beginning and end of the Region-of-Interest. It can be used to interrupt simulation at these locations. To use this feature you need to make sure that the correct Simics header file is included in file config.h

This functionality is disabled by default.  

#define ENABLE_TIMING 1

Measure execution time of Region-of-Interest.

If this macro is defined to 1 code is added to the hook functions to measure the execution time of the Region-of-Interest. Measuring execution time of the whole program is inaccurate because it includes the initialization and shutdown phase.

This functionality is enabled by default.  

#define HOOKS_PREFIX '[HOOKS]'

Prefix for all output.

This macro defines the prefix to use for all output generated by the hooks library. A descriptive prefix makes it easier to distinguish hooks library output from program output at runtime.

By default the string '[HOOKS]' is used.  

#define HOOKS_VERSION '1.1'

Version number of this implementation of the PARSEC hooks.

This macro defines a version string which is part of the output that is printed by the hooks library at the beginning of program execution if the PARSEC workload was compiled with hook support enabled. A unique version string makes it easier to distinguish which version of the hooks library the program has been linked to.  

AUTHOR

Written by Christian Bienia.

Generated automatically by Doxygen for PARSEC Hooks Instrumentation API from the source code.  

COPYRIGHT

Copyright (c) 2006-2009 Princeton University  

SEE ALSO

parsec(7), hooks(7)


 

Index

NAME
SYNOPSIS
Defines
Detailed Description
Define Documentation
#define _PARSEC_HOOKS_CONFIG_H 1
#define ENABLE_SIMICS_MAGIC 0
#define ENABLE_TIMING 1
#define HOOKS_PREFIX '[HOOKS]'
#define HOOKS_VERSION '1.1'
AUTHOR
COPYRIGHT
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 04:41:54 GMT, February 24, 2009