diff options
Diffstat (limited to 'TAO/orbsvcs/orbsvcs/Runtime_Scheduler.h')
| -rw-r--r-- | TAO/orbsvcs/orbsvcs/Runtime_Scheduler.h | 282 |
1 files changed, 109 insertions, 173 deletions
diff --git a/TAO/orbsvcs/orbsvcs/Runtime_Scheduler.h b/TAO/orbsvcs/orbsvcs/Runtime_Scheduler.h index 0bb5f45c2d7..f380b06f0e3 100644 --- a/TAO/orbsvcs/orbsvcs/Runtime_Scheduler.h +++ b/TAO/orbsvcs/orbsvcs/Runtime_Scheduler.h @@ -1,19 +1,15 @@ // -*- C++ -*- -// -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// orbsvcs -// -// = FILENAME -// Runtime_Scheduler.h -// -// = AUTHOR -// Chris Gill <cdgill@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Runtime_Scheduler.h + * + * $Id$ + * + * @author Chris Gill <cdgill@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_RUNTIME_SCHEDULER_H #define ACE_RUNTIME_SCHEDULER_H @@ -25,40 +21,40 @@ TAO_BEGIN_VERSIONED_NAMESPACE_DECL +/** + * @class ACE_Runtime_Scheduler + * + * @brief A fast and simple servant for RtecScheduler::Scheduler based on + * precomputed schedules. + * + * This class offers the services of the scheduler, but based on + * precomputed and precompiled information. This results in a + * highly optimized execution after the configuration runs. + */ class TAO_RTSched_Export ACE_Runtime_Scheduler : public POA_RtecScheduler::Scheduler { - // = TITLE - // A fast and simple servant for RtecScheduler::Scheduler based on - // precomputed schedules. - // - // = DESCRIPTION - // This class offers the services of the scheduler, but based on - // precomputed and precompiled information. This results in a - // highly optimized execution after the configuration runs. public: + /// Constructor. Initialize the data from the POD_RT_Info array. ACE_Runtime_Scheduler (int config_count, ACE_Scheduler_Factory::POD_Config_Info config_info[], int entry_count, ACE_Scheduler_Factory::POD_RT_Info rt_info[]); - // Constructor. Initialize the data from the POD_RT_Info array. - virtual RtecScheduler::handle_t create (const char * entry_point) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::DUPLICATE_NAME)); - // Create an RT_Info. In the config run scheduler this actually constructs - // a new RT_Info. Here, we just return its handle, or an error value if - // it's not present. + /** + * Create an RT_Info. In the config run scheduler this actually constructs + * a new RT_Info. Here, we just return its handle, or an error value if + * it's not present. + */ + virtual RtecScheduler::handle_t create (const char * entry_point); - virtual RtecScheduler::handle_t lookup (const char * entry_point) - ACE_THROW_SPEC((CORBA::SystemException)); - // Lookup a handle for an RT_Info, and return its handle, or an error - // value if it's not present. + /// Lookup a handle for an RT_Info, and return its handle, or an error + /// value if it's not present. + virtual RtecScheduler::handle_t lookup (const char * entry_point); - virtual RtecScheduler::RT_Info* get (RtecScheduler::handle_t handle) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // Return a pointer to the RT_Info corresponding to the passed handle. + /// Return a pointer to the RT_Info corresponding to the passed handle. + virtual RtecScheduler::RT_Info* get (RtecScheduler::handle_t handle); + /// Set characteristics of the RT_Info corresponding to the passed handle. virtual void set (::RtecScheduler::handle_t handle, ::RtecScheduler::Criticality_t criticality, ::RtecScheduler::Time time, @@ -68,11 +64,9 @@ public: ::RtecScheduler::Importance_t importance, ::RtecScheduler::Quantum_t quantum, ::RtecScheduler::Threads_t threads, - ::RtecScheduler::Info_Type_t info_type) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // Set characteristics of the RT_Info corresponding to the passed handle. + ::RtecScheduler::Info_Type_t info_type); + /// Reset characteristics of the RT_Info corresponding to the passed handle. virtual void reset (RtecScheduler::handle_t handle, RtecScheduler::Criticality_t criticality, RtecScheduler::Time time, @@ -82,181 +76,123 @@ public: RtecScheduler::Importance_t importance, RtecScheduler::Quantum_t quantum, RtecScheduler::Threads_t threads, - RtecScheduler::Info_Type_t info_type) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // Reset characteristics of the RT_Info corresponding to the passed handle. - - virtual void set_seq (const RtecScheduler::RT_Info_Set& infos) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK, - RtecScheduler::INTERNAL, - RtecScheduler::SYNCHRONIZATION_FAILURE)); - // Set characteristics of the RT_Infos corresponding to the passed handles. - // Tuples are added in the case of existing and/or multiple definitions. - - virtual void replace_seq (const RtecScheduler::RT_Info_Set& infos) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK, - RtecScheduler::INTERNAL, - RtecScheduler::SYNCHRONIZATION_FAILURE)); - // Replace characteristics of the RT_Infos corresponding to the - // passed handles. - - virtual void reset_seq (const RtecScheduler::RT_Info_Set& infos) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK, - RtecScheduler::INTERNAL, - RtecScheduler::SYNCHRONIZATION_FAILURE)); - // Reset characteristics of the RT_Infos corresponding to the passed handles. - // Tuples are replaced in the case of existing and/or multiple definitions. + RtecScheduler::Info_Type_t info_type); + + /// Set characteristics of the RT_Infos corresponding to the passed handles. + /// Tuples are added in the case of existing and/or multiple definitions. + virtual void set_seq (const RtecScheduler::RT_Info_Set& infos); + /// Replace characteristics of the RT_Infos corresponding to the + /// passed handles. + virtual void replace_seq (const RtecScheduler::RT_Info_Set& infos); + + /// Reset characteristics of the RT_Infos corresponding to the passed handles. + /// Tuples are replaced in the case of existing and/or multiple definitions. + virtual void reset_seq (const RtecScheduler::RT_Info_Set& infos); + + /// Returns the priority and subpriority values assigned to an RT_Info, + /// based on its handle. virtual void priority (RtecScheduler::handle_t handle, RtecScheduler::OS_Priority& o_priority, RtecScheduler::Preemption_Subpriority_t& p_subpriority, - RtecScheduler::Preemption_Priority_t& p_priority) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK, - RtecScheduler::NOT_SCHEDULED)); - // Returns the priority and subpriority values assigned to an RT_Info, - // based on its handle. + RtecScheduler::Preemption_Priority_t& p_priority); + /// Returns the priority and subpriority values assigned to an RT_Info, + /// based on its entry point name. virtual void entry_point_priority (const char * entry_point, RtecScheduler::OS_Priority& o_priority, RtecScheduler::Preemption_Subpriority_t& p_subpriority, - RtecScheduler::Preemption_Priority_t& p_priority) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK, - RtecScheduler::NOT_SCHEDULED)); - // Returns the priority and subpriority values assigned to an RT_Info, - // based on its entry point name. + RtecScheduler::Preemption_Priority_t& p_priority); + /// In the config run scheduler, this method registers a dependency between + /// two RT_Infos. In the run time scheduler, this is a no-op. virtual void add_dependency (RtecScheduler::handle_t handle, RtecScheduler::handle_t dependency, CORBA::Long number_of_calls, - RtecScheduler::Dependency_Type_t dependency_type) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // In the config run scheduler, this method registers a dependency between - // two RT_Infos. In the run time scheduler, this is a no-op. + RtecScheduler::Dependency_Type_t dependency_type); + /// In the reconfig scheduler, this method removes a dependency between + /// two RT_Infos. In the run time scheduler, this is a no-op. virtual void remove_dependency (RtecScheduler::handle_t handle, RtecScheduler::handle_t dependency, CORBA::Long number_of_calls, - RtecScheduler::Dependency_Type_t dependency_type) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // In the reconfig scheduler, this method removes a dependency between - // two RT_Infos. In the run time scheduler, this is a no-op. + RtecScheduler::Dependency_Type_t dependency_type); + /// In the reconfig scheduler, this method (re)enabes a dependency between + /// two RT_Infos. In the run time scheduler, this is a no-op. virtual void set_dependency_enable_state (RtecScheduler::handle_t handle, RtecScheduler::handle_t dependency, CORBA::Long number_of_calls, RtecScheduler::Dependency_Type_t dependency_type, - RtecScheduler::Dependency_Enabled_Type_t enabled) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // In the reconfig scheduler, this method (re)enabes a dependency between - // two RT_Infos. In the run time scheduler, this is a no-op. + RtecScheduler::Dependency_Enabled_Type_t enabled); + /// In the reconfig scheduler, enables or disables an RT_Info. + /// In the run time scheduler, this is a no-op. virtual void set_rt_info_enable_state (RtecScheduler::handle_t handle, - RtecScheduler::RT_Info_Enabled_Type_t enabled) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UNKNOWN_TASK)); - // In the reconfig scheduler, enables or disables an RT_Info. - // In the run time scheduler, this is a no-op. - - virtual void set_dependency_enable_state_seq (const RtecScheduler::Dependency_Set & dependencies) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::SYNCHRONIZATION_FAILURE, - RtecScheduler::UNKNOWN_TASK)); - // This method sets the enable state of a sequence of dependencies. - - virtual void set_rt_info_enable_state_seq (const RtecScheduler::RT_Info_Enable_State_Pair_Set & pair_set) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::SYNCHRONIZATION_FAILURE, - RtecScheduler::UNKNOWN_TASK)); - // This method enables or disables a sequence of RT_Infos. + RtecScheduler::RT_Info_Enabled_Type_t enabled); + + /// This method sets the enable state of a sequence of dependencies. + virtual void set_dependency_enable_state_seq (const RtecScheduler::Dependency_Set & dependencies); + /// This method enables or disables a sequence of RT_Infos. + virtual void set_rt_info_enable_state_seq (const RtecScheduler::RT_Info_Enable_State_Pair_Set & pair_set); + + /** + * In the config run scheduler, this method causes scheduling information + * to be computed for all registered RT_Infos. In the run time scheduler, + * this is a no-op. + */ virtual void compute_scheduling (CORBA::Long minimum_priority, CORBA::Long maximum_priority, RtecScheduler::RT_Info_Set_out infos, RtecScheduler::Dependency_Set_out deps, RtecScheduler::Config_Info_Set_out configs, - RtecScheduler::Scheduling_Anomaly_Set_out anomalies) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UTILIZATION_BOUND_EXCEEDED, - RtecScheduler::INSUFFICIENT_THREAD_PRIORITY_LEVELS, - RtecScheduler::TASK_COUNT_MISMATCH)); - // In the config run scheduler, this method causes scheduling information - // to be computed for all registered RT_Infos. In the run time scheduler, - // this is a no-op. + RtecScheduler::Scheduling_Anomaly_Set_out anomalies); + /// Recomputes the scheduling priorities, etc. virtual void recompute_scheduling (CORBA::Long minimum_priority, CORBA::Long maximum_priority, - RtecScheduler::Scheduling_Anomaly_Set_out anomalies) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::UTILIZATION_BOUND_EXCEEDED, - RtecScheduler::SYNCHRONIZATION_FAILURE, - RtecScheduler::INSUFFICIENT_THREAD_PRIORITY_LEVELS, - RtecScheduler::TASK_COUNT_MISMATCH, - RtecScheduler::INTERNAL, - RtecScheduler::DUPLICATE_NAME)); - // Recomputes the scheduling priorities, etc. - - virtual void get_rt_info_set (RtecScheduler::RT_Info_Set_out infos) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::SYNCHRONIZATION_FAILURE, - RtecScheduler::INTERNAL)); - // Returns the set of rt_infos, with their assigned priorities (as - // of the last schedule re-computation). - - virtual void get_dependency_set (RtecScheduler::Dependency_Set_out dependencies) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::SYNCHRONIZATION_FAILURE, - RtecScheduler::INTERNAL)); - // Returns the set of rt_infos, with their assigned priorities (as - // of the last schedule re-computation). - - virtual void get_config_info_set (RtecScheduler::Config_Info_Set_out configs) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::SYNCHRONIZATION_FAILURE, - RtecScheduler::INTERNAL)); - // Returns the set of config_infos, describing the appropriate - // number, types, and priority levels for the dispatching lanes. + RtecScheduler::Scheduling_Anomaly_Set_out anomalies); + + /// Returns the set of rt_infos, with their assigned priorities (as + /// of the last schedule re-computation). + virtual void get_rt_info_set (RtecScheduler::RT_Info_Set_out infos); + + /// Returns the set of rt_infos, with their assigned priorities (as + /// of the last schedule re-computation). + virtual void get_dependency_set (RtecScheduler::Dependency_Set_out dependencies); + /// Returns the set of config_infos, describing the appropriate + /// number, types, and priority levels for the dispatching lanes. + virtual void get_config_info_set (RtecScheduler::Config_Info_Set_out configs); + + /// Provides the thread priority and queue type for the given priority level. virtual void dispatch_configuration (RtecScheduler::Preemption_Priority_t p_priority, RtecScheduler::OS_Priority& o_priority, - RtecScheduler::Dispatching_Type_t & d_type) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::NOT_SCHEDULED, - RtecScheduler::UNKNOWN_PRIORITY_LEVEL)); - // Provides the thread priority and queue type for the given priority level. - - virtual RtecScheduler::Preemption_Priority_t last_scheduled_priority (void) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::NOT_SCHEDULED)); - // Returns the last priority number assigned to an operation in the - // schedule. The number returned is one less than the total number - // of scheduled priorities. All scheduled priorities range from 0 - // to the number returned, inclusive. - - virtual void get_config_infos (RtecScheduler::Config_Info_Set_out configs) - ACE_THROW_SPEC ((CORBA::SystemException, - RtecScheduler::NOT_SCHEDULED)); + RtecScheduler::Dispatching_Type_t & d_type); + + /** + * Returns the last priority number assigned to an operation in the + * schedule. The number returned is one less than the total number + * of scheduled priorities. All scheduled priorities range from 0 + * to the number returned, inclusive. + */ + virtual RtecScheduler::Preemption_Priority_t last_scheduled_priority (void); + + virtual void get_config_infos (RtecScheduler::Config_Info_Set_out configs); private: + /// The number of elements in the config array. int config_count_; - // The number of elements in the config array. + /// The array of precomputed queue configuration structures. ACE_Scheduler_Factory::POD_Config_Info* config_info_; - // The array of precomputed queue configuration structures. + /// The number of elements in the RT_Info array. int entry_count_; - // The number of elements in the RT_Info array. + /// The array of precomputed RT_Info structures. ACE_Scheduler_Factory::POD_RT_Info* rt_info_; - // The array of precomputed RT_Info structures. }; TAO_END_VERSIONED_NAMESPACE_DECL |