PerProcessorScheduler.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef PERPROCESSORSCHEDULER_H
#define PERPROCESSORSCHEDULER_H

#ifdef THREADS

#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/TimerHandler.h"
#include "pedigree/kernel/process/ConditionVariable.h"
#include "pedigree/kernel/process/Mutex.h"
#include "pedigree/kernel/process/Thread.h"
#include "pedigree/kernel/processor/state_forward.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/List.h"

class SchedulingAlgorithm;
class Spinlock;

class EXPORTED_PUBLIC PerProcessorScheduler : public TimerHandler
{
  public:
    PerProcessorScheduler();

    ~PerProcessorScheduler();

    void initialise(Thread *pThread);

    void schedule(
        Thread::Status nextStatus = Thread::Ready, Thread *pNewThread = 0,
        Spinlock *pLock = 0);

    void checkEventState(uintptr_t userStack);

    void eventHandlerReturned() NORETURN;

    void addThread(
        Thread *pThread, Thread::ThreadStartFunc pStartFunction, void *pParam,
        bool bUsermode, void *pStack);

    void addThread(Thread *pThread, SyscallState &state);

    void killCurrentThread(Spinlock *pLock = 0) NORETURN;

    void sleep(Spinlock *pLock = 0);

    void timer(uint64_t delta, InterruptState &state);

    void removeThread(Thread *pThread);

    void threadStatusChanged(Thread *pThread);

    void setIdle(Thread *pThread);

  private:
    PerProcessorScheduler(const PerProcessorScheduler &);
    PerProcessorScheduler &operator=(const PerProcessorScheduler &);

    static void deleteThreadThenRestoreState(
        Thread *pThread, SchedulerState &newState,
        volatile uintptr_t *pLock = 0) NORETURN;

    static void deleteThread(Thread *pThread);

    SchedulingAlgorithm *m_pSchedulingAlgorithm;

    Mutex m_NewThreadDataLock;
    ConditionVariable m_NewThreadDataCondition;

    List<void *> m_NewThreadData;

    static int processorAddThread(void *instance) NORETURN;

    Thread *m_pIdleThread;

#ifdef ARM_BEAGLE
    size_t m_TickCount;
#endif
};

#endif

#endif