/**
* @file
*
* @ingroup ScoreSchedulerPriorityAffinitySMP
*
* @brief Deterministic Priority Affinity SMP Scheduler API
*/
/*
* COPYRIGHT (c) 2014.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _RTEMS_SCORE_SCHEDULERPRIORITYAFFINITYSMP_H
#define _RTEMS_SCORE_SCHEDULERPRIORITYAFFINITYSMP_H
#include <rtems/score/scheduler.h>
#include <rtems/score/schedulerpriority.h>
#include <rtems/score/schedulersmp.h>
#include <rtems/score/schedulerprioritysmp.h>
#include <rtems/score/cpuset.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup ScoreSchedulerPriorityAffinitySMP Deterministic Priority Affinity SMP Scheduler
*
* @ingroup ScoreSchedulerPrioritySMP
*
* This is an extension of the Deterministic Priority SMP Scheduler. which
* is an implementation of the global fixed priority scheduler (G-FP).
* It adds thread to core affinity support.
*
* @note This is the first iteration of this scheduler. It currently tracks
* the requested affinity to exercise the Scheduler Framework but it
* does not honor that affinity in assigning threads to cores. This
* will be added in a subsequent revision.
* @{
*/
/**
* @brief Entry points for the Deterministic Priority Affinity SMP Scheduler.
*/
#define SCHEDULER_PRIORITY_AFFINITY_SMP_ENTRY_POINTS \
{ \
_Scheduler_priority_SMP_Initialize, \
_Scheduler_default_Schedule, \
_Scheduler_priority_SMP_Yield, \
_Scheduler_priority_affinity_SMP_Block, \
_Scheduler_priority_affinity_SMP_Unblock, \
_Scheduler_priority_affinity_SMP_Change_priority, \
_Scheduler_priority_affinity_SMP_Ask_for_help, \
_Scheduler_priority_affinity_SMP_Node_initialize, \
_Scheduler_default_Node_destroy, \
_Scheduler_priority_SMP_Update_priority, \
_Scheduler_default_Release_job, \
_Scheduler_default_Tick, \
_Scheduler_SMP_Start_idle, \
_Scheduler_priority_affinity_SMP_Get_affinity, \
_Scheduler_priority_affinity_SMP_Set_affinity \
}
/**
* @brief Initializes per thread scheduler information
*
* This routine allocates @a thread->scheduler.
*
* @param[in] scheduler points to the scheduler specific information.
* @param[in] thread is the thread the scheduler is allocating
* management memory for.
*/
void _Scheduler_priority_affinity_SMP_Node_initialize(
const Scheduler_Control *scheduler,
Thread_Control *thread
);
/**
* @brief SMP Priority Affinity Scheduler Block Operation
*
* This method is the block operation for this scheduler.
*
* @param[in] scheduler is the scheduler instance information
* @param[in] thread is the thread to block
*/
void _Scheduler_priority_affinity_SMP_Block(
const Scheduler_Control *scheduler,
Thread_Control *thread
);
/**
* @brief SMP Priority Affinity Scheduler Unblock Operation
*
* This method is the unblock operation for this scheduler.
*
* @param[in] scheduler is the scheduler instance information
* @param[in] thread is the thread to unblock
*/
Thread_Control *_Scheduler_priority_affinity_SMP_Unblock(
const Scheduler_Control *scheduler,
Thread_Control *thread
);
/**
* @brief Get affinity for the priority affinity SMP scheduler.
*
* @param[in] scheduler The scheduler of the thread.
* @param[in] thread The associated thread.
* @param[in] cpusetsize The size of the cpuset.
* @param[in,out] cpuset The associated affinity set.
*
* @retval 0 Successfully got cpuset
* @retval -1 The cpusetsize is invalid for the system
*/
bool _Scheduler_priority_affinity_SMP_Get_affinity(
const Scheduler_Control *scheduler,
Thread_Control *thread,
size_t cpusetsize,
cpu_set_t *cpuset
);
/**
* @brief Change priority for the priority affinity SMP scheduler.
*
* @param[in] scheduler The scheduler of the thread.
* @param[in] the_thread The associated thread.
* @param[in] new_priority The new priority for the thread.
* @param[in] prepend_it Append or prepend the thread to its priority FIFO.
*/
Thread_Control *_Scheduler_priority_affinity_SMP_Change_priority(
const Scheduler_Control *scheduler,
Thread_Control *the_thread,
Priority_Control new_priority,
bool prepend_it
);
Thread_Control *_Scheduler_priority_affinity_SMP_Ask_for_help(
const Scheduler_Control *scheduler,
Thread_Control *offers_help,
Thread_Control *needs_help
);
/**
* @brief Set affinity for the priority affinity SMP scheduler.
*
* @param[in] scheduler The scheduler of the thread.
* @param[in] thread The associated thread.
* @param[in] cpusetsize The size of the cpuset.
* @param[in] cpuset Affinity new affinity set.
*
* @retval true if successful
* @retval false if unsuccessful
*/
bool _Scheduler_priority_affinity_SMP_Set_affinity(
const Scheduler_Control *scheduler,
Thread_Control *thread,
size_t cpusetsize,
const cpu_set_t *cpuset
);
/**
* @brief Scheduler node specialization for Deterministic Priority Affinity SMP
* schedulers.
*
* This is a per thread structure.
*/
typedef struct {
/**
* @brief SMP priority scheduler node.
*/
Scheduler_priority_SMP_Node Base;
/**
* Structure containing affinity set data and size
*/
CPU_set_Control Affinity;
} Scheduler_priority_affinity_SMP_Node;
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* _RTEMS_SCORE_SCHEDULERPRIORITYAFFINITYSMP_H */
