LXR 6.1/​cpukit/​include/​rtems/​score/​scheduleredf.h	Source navigation Diff markup Identifier search General search
	Version: 6.1 Revert   Change

File indexing completed on 2025-05-11 08:24:13

 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
  * @file
  *
  * @ingroup RTEMSScoreSchedulerEDF
  *
  * @brief This header file provides interfaces of the
  *   @ref RTEMSScoreSchedulerEDF which are used by the implementation and the
  *   @ref RTEMSImplApplConfig.
  */
 
 /*
  *  Copryight (c) 2011 Petr Benes.
  *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef _RTEMS_SCORE_SCHEDULEREDF_H
 #define _RTEMS_SCORE_SCHEDULEREDF_H
 
 #include <rtems/score/priority.h>
 #include <rtems/score/scheduler.h>
 #include <rtems/score/schedulerpriority.h>
 #include <rtems/score/rbtree.h>
 
 #include <limits.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
  * @defgroup RTEMSScoreSchedulerEDF EDF Scheduler
  *
  * @ingroup RTEMSScoreScheduler
  *
  * @brief This group contains the EDF Scheduler implementation.
  *
  * @{
  */
 
 /*
  * Actually the EDF scheduler supports a maximum priority of
  * 0x7fffffffffffffff, but the user API is limited to uint32_t or int for
  * thread priorities.  Ignore ILP64 targets for now.
  */
 #define SCHEDULER_EDF_MAXIMUM_PRIORITY INT_MAX
 
 /**
  *  Entry points for the Earliest Deadline First Scheduler.
  */
 #define SCHEDULER_EDF_ENTRY_POINTS \
   { \
     _Scheduler_EDF_Initialize,       /* initialize entry point */ \
     _Scheduler_EDF_Schedule,         /* schedule entry point */ \
     _Scheduler_EDF_Yield,            /* yield entry point */ \
     _Scheduler_EDF_Block,            /* block entry point */ \
     _Scheduler_EDF_Unblock,          /* unblock entry point */ \
     _Scheduler_EDF_Update_priority,  /* update priority entry point */ \
     _Scheduler_EDF_Map_priority,     /* map priority entry point */ \
     _Scheduler_EDF_Unmap_priority,   /* unmap priority entry point */ \
     SCHEDULER_DEFAULT_SMP_OPERATIONS \
     _Scheduler_EDF_Node_initialize,  /* node initialize entry point */ \
     _Scheduler_default_Node_destroy, /* node destroy entry point */ \
     _Scheduler_EDF_Release_job,      /* new period of task */ \
     _Scheduler_EDF_Cancel_job,       /* cancel period of task */ \
     _Scheduler_default_Start_idle    /* start idle entry point */ \
     SCHEDULER_DEFAULT_SET_AFFINITY_OPERATION \
   }
 
 typedef struct {
   /**
    * @brief Basic scheduler context.
    */
   Scheduler_Context Base;
 
   /**
    * Top of the ready queue.
    */
   RBTree_Control Ready;
 } Scheduler_EDF_Context;
 
 /**
  * @brief Scheduler node specialization for EDF schedulers.
  */
 typedef struct {
   /**
    * @brief Basic scheduler node.
    */
   Scheduler_Node Base;
 
   /**
    * Rbtree node related to this thread.
    */
   RBTree_Node Node;
 
   /**
    * @brief The thread priority currently used for this scheduler instance.
    */
   Priority_Control priority;
 } Scheduler_EDF_Node;
 
 /**
  * @brief Initializes EDF scheduler.
  *
  * This routine initializes the EDF scheduler.
  *
  * @param[in, out] scheduler The scheduler instance.
  */
 void _Scheduler_EDF_Initialize( const Scheduler_Control *scheduler );
 
 /**
  * @brief Removes the blocking thread from the ready queue and schedules is only
  *      again if the thread is executing or the heir thread.
  *
  * @param[in, out] scheduler The scheduler for the operation.
  * @param the_thread The thread to operate upon.
  * @param[in, out] node The scheduler node for this thread.
  */
 void _Scheduler_EDF_Block(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread,
   Scheduler_Node          *node
 );
 
 /**
  * @brief Sets the heir thread to be the next ready thread
  * in the rbtree ready queue.
  *
  * This kernel routine sets the heir thread to be the next ready thread
  * in the rbtree ready queue.
  *
  * @param[in, out] scheduler The scheduler instance.
  * @param the_thread The thread being scheduled.
  */
 void _Scheduler_EDF_Schedule(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread
 );
 
 /**
  * @brief Initializes an EDF specific scheduler node of @a the_thread.
  *
  * @param scheduler The scheduler instance.
  * @param node The node being initialized.
  * @param the_thread The thread of the node.
  * @param priority The thread priority.
  */
 void _Scheduler_EDF_Node_initialize(
   const Scheduler_Control *scheduler,
   Scheduler_Node          *node,
   Thread_Control          *the_thread,
   Priority_Control         priority
 );
 
 /**
  * @brief Performs an unblocking of the thread.
  *
  * @param[in, out] scheduler The scheduler instance.
  * @param the_thread The unblocking thread.  May be set as new heir.
  * @param[in, out] node The scheduler node for the thread.
  */
 void _Scheduler_EDF_Unblock(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread,
   Scheduler_Node          *node
 );
 
 /**
  * @brief Updates the priority of the scheduler node.
  *
  * @param scheduler The scheduler instance.
  * @param the_thread The thread for the operation.
  * @param[in, out] node The priority node to update the priority of.
  */
 void _Scheduler_EDF_Update_priority(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread,
   Scheduler_Node          *node
 );
 
 /**
  * @brief Gets the mapped priority map of the priority control.
  *
  * @param scheduler Not used in this operation.
  * @param priority The priority control to get the priority map of.
  *
  * @return The mapped priority map of @a priority.
  */
 Priority_Control _Scheduler_EDF_Map_priority(
   const Scheduler_Control *scheduler,
   Priority_Control         priority
 );
 
 /**
  * @brief Gets the unmapped priority map of the priority control.
  *
  * @param scheduler Not used in this operation.
  * @param priority The priority control to get the priority map of.
  *
  * @return The unmapped priority map of @a priority.
  */
 Priority_Control _Scheduler_EDF_Unmap_priority(
   const Scheduler_Control *scheduler,
   Priority_Control         priority
 );
 
 /**
  * @brief Executes a thread yield for the thread.
  *
  * @param[in, out] scheduler The scheduler instance.
  * @param the_thread The thread that performs the yield.
  * @param[in, out] node The scheduler node for this thread.
  */
 void _Scheduler_EDF_Yield(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread,
   Scheduler_Node          *node
 );
 
 /**
  * @brief Releases a EDF job.
  *
  * @param scheduler The scheduler instance
  * @param the_thread The thread
  * @param[in, out] priority_node The priority node for the operation.
  * @param deadline The deadline for the job.
  * @param[in, out] queue_context The thread queue context.
  */
 void _Scheduler_EDF_Release_job(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread,
   Priority_Node           *priority_node,
   uint64_t                 deadline,
   Thread_queue_Context    *queue_context
 );
 
 /**
  * @brief Cancels a job and removes the thread from the queue context.
  *
  * @param scheduler The scheduler instance.
  * @param the_thread The thread for the operation.
  * @param[in, out] priority_node The corresponding priority node.
  * @param[in, out] queue_context The thread queue context.
  */
 void _Scheduler_EDF_Cancel_job(
   const Scheduler_Control *scheduler,
   Thread_Control          *the_thread,
   Priority_Node           *priority_node,
   Thread_queue_Context    *queue_context
 );
 
 #ifdef __cplusplus
 }
 #endif
 
 /** @} */
 
 #endif
 /* end of include file */

This page was automatically generated by the 2.3.7 LXR engine. The LXR team