Process.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __KERNEL_PROCESS_H
#define __KERNEL_PROCESS_H
 
#include <Types.h>
#include <Macros.h>
#include <List.h>
#include <MemoryMap.h>
#include <Timer.h>
#include "ProcessShares.h"
 
struct Message;
class MemoryContext;
class MemoryChannel;
struct ProcessEvent;
class ProcessManager;
class Scheduler;
 
class Process
{
  friend class ProcessManager;
  friend class Scheduler;
 
  public:
 
    enum Result
    {
        Success,
        InvalidArgument,
        MemoryMapError,
        OutOfMemory,
        WakeupPending
    };
 
    enum State
    {
        Ready,
        Sleeping,
        Waiting,
        Stopped
    };
 
  public:
 
    Process(ProcessID id, Address entry, bool privileged, const MemoryMap &map);
 
    virtual ~Process();
 
    ProcessID getID() const;
 
    ProcessID getParent() const;
 
    ProcessID getWait() const;
 
    uint getWaitResult() const;
 
    ProcessShares & getShares();
 
    State getState() const;
 
    MemoryContext * getMemoryContext();
 
    bool isPrivileged() const;
 
    bool operator == (Process *proc);
 
  protected:
 
    virtual Result initialize();
 
    virtual void reset(const Address entry) = 0;
 
    virtual void execute(Process *previous) = 0;
 
    Result wakeup();
 
    Result sleep(const Timer::Info *timer, bool ignoreWakeups);
 
    Result wait(ProcessID id);
 
    virtual Result join(const uint result);
 
    Result stop();
 
    Result resume();
 
    Result raiseEvent(const struct ProcessEvent *event);
 
    const Timer::Info & getSleepTimer() const;
 
    void setParent(ProcessID id);
 
  protected:
 
    const ProcessID m_id;
 
    ProcessID m_parent;
 
    State m_state;
 
    ProcessID m_waitId;
 
    uint m_waitResult;
 
    bool m_privileged;
 
    Address m_entry;
 
    MemoryMap m_map;
 
    MemoryContext *m_memoryContext;
 
    Size m_wakeups;
 
    Timer::Info m_sleepTimer;
 
    ProcessShares m_shares;
 
    MemoryChannel *m_kernelChannel;
};
 
#endif /* __KERNEL_PROCESS_H */