source: rtems/cpukit/score/include/rtems/score/schedulersimple.h @ 24934e36

/**
 *  @file  rtems/score/schedulersimple.h
 *
 *  @brief Manipulation of Threads Simple-Priority-Based Ready Queue
 *
 *  This include file contains all the constants and structures associated
 *  with the manipulation of threads on a simple-priority-based ready queue.
 */

/*
 *  Copyright (C) 2011 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_SCHEDULERSIMPLE_H
#define _RTEMS_SCORE_SCHEDULERSIMPLE_H

#include <rtems/score/scheduler.h>
#include <rtems/score/schedulerpriority.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 *  @defgroup ScoreSchedulerSimple Simple Priority Scheduler
 *
 *  @ingroup ScoreScheduler
 */
/**@{*/

/**
 *  Entry points for Scheduler Simple
 */
#define SCHEDULER_SIMPLE_ENTRY_POINTS \
  { \
    _Scheduler_simple_Initialize,         /* initialize entry point */ \
    _Scheduler_simple_Schedule,           /* schedule entry point */ \
    _Scheduler_simple_Yield,              /* yield entry point */ \
    _Scheduler_simple_Block,              /* block entry point */ \
    _Scheduler_simple_Unblock,            /* unblock entry point */ \
    _Scheduler_default_Allocate,          /* allocate entry point */ \
    _Scheduler_default_Free,              /* free entry point */ \
    _Scheduler_default_Update,            /* update entry point */ \
    _Scheduler_simple_Enqueue,            /* enqueue entry point */ \
    _Scheduler_simple_Enqueue_first,      /* enqueue_first entry point */ \
    _Scheduler_simple_Extract,            /* extract entry point */ \
    _Scheduler_priority_Priority_compare, /* compares two priorities */ \
    _Scheduler_default_Release_job,       /* new period of task */ \
    _Scheduler_default_Tick,              /* tick entry point */ \
    _Scheduler_default_Start_idle         /* start idle entry point */ \
  }

/**
 * @brief Simple scheduler control.
 */
typedef struct {
  /**
   * @brief One ready queue for all ready threads.
   */
  Chain_Control Ready;
} Scheduler_simple_Control;

/**
 *  @brief Initialize simple scheduler.
 *
 *  This routine initializes the simple scheduler.
 */
void _Scheduler_simple_Initialize( void );

/**
 *  This routine sets the heir thread to be the next ready thread
 *  on the ready queue by getting the first node in the scheduler
 *  information.
 */
void _Scheduler_simple_Schedule(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Invoked when a thread wishes to voluntarily
 *  transfer control of the processor to another thread in the queue.
 *
 *  This routine is invoked when a thread wishes to voluntarily
 *  transfer control of the processor to another thread in the queue.
 *  It will remove the specified THREAD from the scheduler.informaiton
 *  (where the ready queue is stored) and place it immediately at the
 *  between the last entry of its priority and the next priority thread.
 *  Reset timeslice and yield the processor functions both use this routine,
 *  therefore if reset is true and this is the only thread on the queue then
 *  the timeslice counter is reset.  The heir THREAD will be updated if the
 *  running is also the currently the heir.
 *
 *  @param[in,out] thread The yielding thread.
 */
void _Scheduler_simple_Yield(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Remove a simple-priority-based thread from the queue.
 *
 *  This routine removes @a the_thread from the scheduling decision,
 *  that is, removes it from the ready queue.  It performs
 *  any necessary scheduling operations including the selection of
 *  a new heir thread.
 *
 *  @param[in] the_thread is the thread that is to be blocked
 */
void _Scheduler_simple_Block(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Unblock a simple-priority-based thread.
 *
 *  This routine adds @a the_thread to the scheduling decision,
 *  that is, adds it to the ready queue and
 *  updates any appropriate scheduling variables, for example the heir thread.
 *
 *  @param[in] the_thread is the thread that is to be unblocked
 */
void _Scheduler_simple_Unblock(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Removes a simple-priority-based thread from a simple queue.
 *
 *  This routine removes a specific thread from the specified
 *  simple-based ready queue.
 *
 *  @param[in] the_thread is the thread to be blocked
 */
void _Scheduler_simple_Extract(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Puts simple-priority-based thread onto the ready queue.
 *
 *  This routine puts @a the_thread on to the ready queue.
 *
 *  @param[in] the_thread is the thread to be enqueued
 */
void _Scheduler_simple_Enqueue(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Put simple-priority-based @a the_thread to
 *  the head of the ready queue.
 *
 *  This routine puts @a the_thread to the head of the ready queue.
 *  The thread will be the first thread at its priority level.
 *
 *  @param[in] the_thread is the thread to be blocked
 */
void _Scheduler_simple_Enqueue_first(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  _Scheduler_simple_Ready_queue_enqueue
 *
 *  This routine puts @a the_thread on the ready queue
 *  at the end of its priority group.
 *
 *  @param[in] the_thread - pointer to a thread control block
 */
void _Scheduler_simple_Ready_queue_enqueue(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**
 *  @brief Puts simple-priority-based @a the_thread on to the ready queue
 *  at the beginning of its priority group.
 *
 *  This routine puts @a the_thread on to the ready queue
 *  at the beginning of its priority group.
 *
 *  @param[in] the_thread - pointer to a thread control block
 */
void _Scheduler_simple_Ready_queue_enqueue_first(
  Scheduler_Control *scheduler,
  Thread_Control    *the_thread
);

/**@}*/

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */