i_kernel.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <functional>
#include <memory>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
#include "contur/core/error.h"
#include "contur/core/types.h"
 
#include "contur/arch/block.h"
#include "contur/process/priority.h"
#include "contur/syscall/syscall_ids.h"
 
namespace contur {
 
    class ISyncPrimitive;
    class ProcessImage;

    struct ProcessConfig
    {
        ProcessId id = INVALID_PID;

        std::string name;

        std::vector<Block> code;

        Priority priority{};

        Tick arrivalTime = 0;
    };

    struct KernelSnapshot
    {
        Tick currentTick = 0;

        std::size_t processCount = 0;

        std::size_t readyCount = 0;

        std::size_t blockedCount = 0;

        ProcessId runningPid = INVALID_PID;

        std::size_t totalVirtualSlots = 0;

        std::size_t freeVirtualSlots = 0;
    };

    using SyscallHandlerFn =
        std::function<Result<RegisterValue>(std::span<const RegisterValue> args, ProcessImage &caller)>;

    class IKernel
    {
        public:
        virtual ~IKernel() = default;

        [[nodiscard]] virtual Result<ProcessId> createProcess(const ProcessConfig &config) = 0;

        [[nodiscard]] virtual Result<void> terminateProcess(ProcessId pid) = 0;

        [[nodiscard]] virtual Result<void> tick(std::size_t tickBudget = 0) = 0;

        [[nodiscard]] virtual Result<void> runForTicks(std::size_t cycles, std::size_t tickBudget = 0) = 0;

        [[nodiscard]] virtual Result<RegisterValue>
        syscall(ProcessId pid, SyscallId id, std::span<const RegisterValue> args) = 0;

        [[nodiscard]] virtual Result<void> registerSyscallHandler(SyscallId id, SyscallHandlerFn handler) = 0;

        [[nodiscard]] virtual Result<void>
        registerSyncPrimitive(const std::string &name, std::unique_ptr<ISyncPrimitive> primitive) = 0;

        [[nodiscard]] virtual Result<void> enterCritical(ProcessId pid, std::string_view primitiveName) = 0;

        [[nodiscard]] virtual Result<void> leaveCritical(ProcessId pid, std::string_view primitiveName) = 0;

        [[nodiscard]] virtual KernelSnapshot snapshot() const = 0;

        [[nodiscard]] virtual Tick now() const noexcept = 0;

        [[nodiscard]] virtual bool hasProcess(ProcessId pid) const noexcept = 0;

        [[nodiscard]] virtual std::size_t processCount() const noexcept = 0;
    };
 
} // namespace contur