diff options
Diffstat (limited to 'ace/Timer/Timeprobe_T.h')
-rw-r--r-- | ace/Timer/Timeprobe_T.h | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/ace/Timer/Timeprobe_T.h b/ace/Timer/Timeprobe_T.h new file mode 100644 index 00000000000..52740f6456f --- /dev/null +++ b/ace/Timer/Timeprobe_T.h @@ -0,0 +1,188 @@ +/* -*- C++ -*- */ + +//============================================================================= +/** + * @file Timeprobe_T.h + * + * $Id$ + * + * @author Irfan Pyarali + */ +//============================================================================= + + +#ifndef ACE_TIMEPROBE_T_H +#define ACE_TIMEPROBE_T_H +#include "ace/pre.h" + +#include "ace/OS.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +#if defined (ACE_COMPILE_TIMEPROBES) + +#include "ace/Unbounded_Set.h" + +/** + * @class ACE_Timeprobe + * + * @brief This class is used to instrument code. This is accomplished + * by inserting time probes at different location in the code. + * ACE_Timeprobe then measures the time difference between two + * time probes. + * + * This class provides a lightweight implementation for + * measuring the time required to execute code between two time + * probes. When a time probe executes, it records the time, the + * id of the calling thread, and an event description. The + * event description can either be an unsigned long or a string + * (char *). If string are used, care must be taken cause only + * pointer copies are done and the string data is *not* copied. + * The recorded time probes can then be printed by calling + * <print_times>. If you have used unsigned longs as event + * descriptions in any of your time probes, you must have + * provided an event description table that maps the unsigned + * longs to readable strings. This map is a simple array of + * strings, and the event number is used as the index into the + * array when looking for the event description. If you have + * only used strings for the event description, this map is not + * necessary. + * Multiple maps can also be used to chunk up the time probes. + * Each one can be added by calling <event_descriptions>. + * Different tables are used internally by consulting the + * minimum_id for each table. It is up to the user to make sure + * that multiple tables do not share the same event id range. + */ +template <class ACE_LOCK> +class ACE_Timeprobe +{ +public: + + /// Self + typedef ACE_Timeprobe<ACE_LOCK> + SELF; + + /// We can hold multiple event description tables. + typedef ACE_Unbounded_Set<ACE_Event_Descriptions> + EVENT_DESCRIPTIONS; + + /// Create Timeprobes with <size> slots + ACE_Timeprobe (u_long size = ACE_DEFAULT_TIMEPROBE_TABLE_SIZE); + + /// Destructor. + ~ACE_Timeprobe (void); + + /// Record a time. <event> is used to describe this time probe. + void timeprobe (u_long event); + + /// Record a time. <id> is used to describe this time probe. + void timeprobe (const char *id); + + /// Record event descriptions. + int event_descriptions (const char **descriptions, + u_long minimum_id); + + /// Print the time probes. + void print_times (void); + + /// Print the time probes. + void print_absolute_times (void); + + /// Reset the slots. All old time probes will be lost. + void reset (void); + + ACE_Timeprobe (const ACE_Timeprobe<ACE_LOCK> &); + // Not implemented (stupid MSVC won't let it be protected). + + // = (Somewhat private) Accessors + + /// Event Descriptions + ACE_Unbounded_Set<ACE_Event_Descriptions> &event_descriptions (void); + + /// Sorted Event Descriptions. + ACE_Unbounded_Set<ACE_Event_Descriptions> &sorted_event_descriptions (void); + + /// VME slot address. + u_int *current_slot_vme_address (void); + + /// Find description of event <i> + const char *find_description_i (u_long i); + + /// Sort event descriptions + void sort_event_descriptions_i (void); + + /// Time probe slots + ACE_timeprobe_t *timeprobes (void); + + /// Synchronization variable. + ACE_LOCK &lock (void); + + /// Max size of timestamp table + u_long max_size (void); + + /// Current size of timestamp table + u_long current_size (void); + +protected: + + /// Event Descriptions + EVENT_DESCRIPTIONS event_descriptions_; + + /// Sorted Event Descriptions. + EVENT_DESCRIPTIONS sorted_event_descriptions_; + + /// Added sections below here to make compatible with the VMETRO + /// board test. + u_int *current_slot_vme_address_; + + /// Time probe slots + ACE_timeprobe_t *timeprobes_; + + /// Synchronization variable. + ACE_LOCK lock_; + + /// Max size of timestamp table + u_long max_size_; + + /// Current size of timestamp table + u_long current_size_; +}; + +/** + * @class ACE_Function_Timeprobe + * + * @brief Auto pointer like time probes. It will record <event> on + * construction and <event + 1> on destruction. + */ +template <class Timeprobe> +class ACE_Function_Timeprobe +{ +public: + /// Constructor. + ACE_Function_Timeprobe (Timeprobe &timeprobe, + u_long event); + + /// Destructor. + ~ACE_Function_Timeprobe (void); + +protected: + /// Reference to timeprobe. + Timeprobe &timeprobe_; + + /// Event. + u_long event_; +}; + +#if defined (ACE_TEMPLATES_REQUIRE_SOURCE) +#include "ace/Timeprobe_T.cpp" +#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */ + +#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA) +#pragma implementation ("Timeprobe_T.cpp") +#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */ + +#endif /* ACE_COMPILE_TIMEPROBES */ +#include "ace/post.h" +#endif /* ACE_TIMEPROBE_T_H */ |