src/tracecut.h File Reference
The public interface for InterAspect tracecuts, an extension to the InterAspect framework. More...
Go to the source code of this file.
Defines | |
#define | TC_MAX_ID_SIZE 255 |
Enumerations | |
enum | tc_error { TC_SUCCESS, TC_BAD_CONTEXT, TC_INVAL, TC_DUPLICATE, TC_BAD_ID, TC_BAD_RETURN_BINDING, TC_NOENT, TC_NOMEM } |
Functions | |
enum tc_error | tc_error_code (struct tc_tracecut *tc) |
void | tc_reset_error (struct tc_tracecut *tc) |
enum tc_error | tc_add_param (struct tc_tracecut *tc, const char *name, const struct aop_type *type) |
enum tc_error | tc_add_call_symbol (struct tc_tracecut *tc, const char *name, const char *func_name, enum aop_insert_location location) |
enum tc_error | tc_bind_to_call_param (struct tc_tracecut *tc, const char *param_name, const char *symbol_name, int call_param_index) |
enum tc_error | tc_bind_to_return_value (struct tc_tracecut *tc, const char *param_name, const char *symbol_name) |
enum tc_error | tc_declare_call_symbol (struct tc_tracecut *tc, const char *name, const char *declaration, enum aop_insert_location location) |
enum tc_error | tc_add_rule (struct tc_tracecut *tc, const char *specification) |
struct tc_tracecut * | tc_create_tracecut (void) |
void | tc_free_tracecut (struct tc_tracecut *tc) |
void | tc_insert_tracecut_init_advice (struct aop_joinpoint *jp) |
void | tc_set_main_function (const char *func_name) |
void | tc_register_tracecut_pass (void) |
Detailed Description
The public interface for InterAspect tracecuts, an extension to the InterAspect framework.
A tracecut can track sequences of events on a program object (or a set of program objects) using regular expressions.
Though included in the InterAspect distribution, the tracecut extension only uses InterAspect's external API, making it a good example of how to use the API.
All tracecut functions have a tc_
prefix.
Define Documentation
#define TC_MAX_ID_SIZE 255 |
Maximum size for a symbol and param names.
Enumeration Type Documentation
enum tc_error |
Possible error return values for tracecut functions.
- Enumerator:
TC_SUCCESS No error: the function succeeded.
TC_BAD_CONTEXT Function was called from an inappropriate context. Most tracecut functions should be called from your aop_main() function.
TC_INVAL An input to the function was invalid.
TC_DUPLICATE Attempt to create a duplicate name.
TC_BAD_ID Attempt to name a symbol of param with a bad identifier. (Identifiers must only contain letters, numbers and the underscore character, with no spaces. Identifiers are case sensitive.)
TC_BAD_RETURN_BINDING Attempt to bind the return value of a call symbol that has a location of AOP_INSERT_BEFORE.
TC_NOENT Attempt to reference a name that does not exist.
TC_NOMEM Function could not allocate enough memory.
