You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123 lines
3.6 KiB
C++

// vim: set noet ts=4 sw=4:
/*! \file
*
* \brief \ref Scheduler to manage the \ref Thread "threads"
*/
#pragma once
#include "../types.h"
#include "dispatcher.h"
#include "idlethread.h"
#include "thread.h"
/*! \brief The scheduler plans the threads' execution order and, from this,
* selects the next thread to be running.
* \ingroup thread
*
* The scheduler manages the ready queue (a private \ref Queue object),
* that is the list of threads that are ready to execute. The scheduler
* arranges threads in a FIFO order, that is, when a thread is set ready, it
* will be appended to the end of the queue, while threads to be executed are
* taken from the front of the queue.
*/
class Scheduler {
/*! \brief Helper to retrieve next Thread
* \return pointer of next thread
*/
Thread* getNext();
public:
Scheduler();
/*! \brief a Dispatcher object, providing the low level context switching
* routines.
*/
Dispatcher dispatcher;
/*! \brief Start scheduling
*
* This method starts the scheduling by removing the first thread from
* the ready queue and activating it. \MPStuBS needs to call this method
* once for every CPU core to dispatch the first thread.
*
* \todo(14) Implement Method
*/
void schedule();
/*! \brief Include a thread in scheduling decisions.
*
* This method will register a thread for scheduling. It will be appended
* to the ready queue and dispatched once its time has come.
* \param that \ref Thread to be scheduled
*
* \todo(14) Implement Method
*/
void ready(Thread* that);
/*! \brief (Self-)termination of the calling thread.
*
* This method can be used by a thread to exit itself. The calling
* thread will not be appended to the ready queue; a reschedule will be
* issued.
*
* \todo(14) Implement Method
*/
void exit();
/*! \brief Kills the passed thread
*
* This method is used to kill the \ref Thread `that`.
* For \OOStuBS, it is sufficient to remove `that` from the ready queue
* and, thereby, exclude the thread from scheduling.
* For \MPStuBS, a simple removal is not sufficient, as the thread might
* currently be running on another CPU core. In this case, the thread needs
* to be marked as *dying* (a flag checked by resume prior to enqueuing
* into the ready queue)
*/
/*!
* Note: The thread should be able to kill itself.
*
* \todo(14) Implement Method
*
* \todo(15) Adapt method (for MPStuBS)
*/
void kill(Thread* that);
/*! \brief Issue a thread change
*
* This method issues the change of the currently active thread without
* requiring the calling thread to be aware of the other threads.
* Scheduling decisions, i.e. which thread will be run next, are made by
* the scheduler itself with the knowledge of the currently ready threads.
* The currently active thread is appended to the end of the queue; the
* first thread in the queue will be activated (to implement the FIFO
* policy).
*
* \todo(14) Implement Method
*/
void resume(bool ready = true);
/*! \brief return the active thread from the dispatcher
*/
Thread* active() { return dispatcher.active(); }
/// \copydoc Dispatcher::isActive
bool isActive(const Thread* thread, unsigned int* cpu = nullptr);
/*! \brief Checks whether the ready queue is empty.
*
* \todo(16) Implement Method
*/
bool isEmpty() const;
/*! \brief Set the idle thread for the executing CPU
* \param[in] that the idle thread to use for the executing CPU
*
* \todo(16) Implement Method
*/
void setIdle(IdleThread* that);
};