CPUArch.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
//
// This file is part of ETISS. It is licensed under the BSD 3-Clause License; you may not use this file except in
// compliance with the License. You should have received a copy of the license along with this project. If not, see the
// LICENSE file.
#ifndef ETISS_INCLUDE_CPUARCH_H_
#define ETISS_INCLUDE_CPUARCH_H_
 
#include <map>
#include <set>
#include <string>
 
#include "etiss/Misc.h"
#include "etiss/IntegratedLibrary/gdb/GDBCore.h"
#include "etiss/Plugin.h"
 
namespace etiss
{
 
class CPUArchRegListenerInterface
{
  public:
    virtual ~CPUArchRegListenerInterface();
 
    virtual const std::set<std::string> &getListenerSupportedRegisters() = 0;
 
  public:
    static void signalChangedRegisterValue(ETISS_CPU *cpu, const char *registerName);
};
 
class CPUArchCPUManipulation
{
  public:
    virtual ~CPUArchCPUManipulation();
 
    virtual std::shared_ptr<etiss::VirtualStruct> getVirtualStruct(ETISS_CPU *cpu) = 0;
};
 
class CPUArchDefaultPlugins
{
  public:
    virtual ~CPUArchDefaultPlugins() {}
    virtual etiss::Plugin *newTimer(ETISS_CPU *cpu);
    virtual void deleteTimer(etiss::Plugin *timer);
};
 
class CPUArch : public CPUArchRegListenerInterface,
                public CPUArchCPUManipulation,
                public CPUArchDefaultPlugins,
                public TranslationPlugin
{
    friend class LibraryInterface;
 
  public:
    CPUArch(std::string archname);
    virtual ~CPUArch();
 
    std::string getArchName() const;
 
    inline std::string getName() const { return getArchName(); }
    virtual ETISS_CPU *newCPU() = 0;
    virtual void resetCPU(ETISS_CPU *cpu, etiss::uint64 *startpointer) = 0;
    virtual void deleteCPU(ETISS_CPU *) = 0;
    virtual unsigned getMaximumInstructionSizeInBytes() = 0;
    virtual unsigned getMaximumInstructionsPerMetaInstruction();
    virtual unsigned getInstructionSizeInBytes() = 0;
    virtual unsigned getSuperInstructionCount();
    virtual std::string getBlockGlobalCode();
    virtual bool unlikelyInstruction(etiss::uint8 *instr, unsigned length, bool &ismetainstruction);
    virtual const std::set<std::string> &getHeaders() const = 0;
    virtual etiss::int32 handleException(etiss::int32 code, ETISS_CPU *cpu);
    virtual etiss::InterruptVector *createInterruptVector(ETISS_CPU *cpu);
    virtual void deleteInterruptVector(etiss::InterruptVector *vec, ETISS_CPU *cpu);
 
    virtual etiss::InterruptEnable *createInterruptEnable(ETISS_CPU *cpu);
    virtual void deleteInterruptEnable(etiss::InterruptEnable *en, ETISS_CPU *cpu);
 
    virtual etiss::plugin::gdb::GDBCore &getGDBCore();
    virtual std::string getIncludePath();
    virtual void finalizeInstrSet(etiss::instr::ModedInstructionSet &) const;
    virtual void compensateEndianess(ETISS_CPU *cpu, etiss::instr::BitArray &ba) const;
 
    virtual etiss::mm::MMU *newMMU(ETISS_CPU *cpu) { return nullptr; }
 
  protected:
    virtual std::string _getPluginName() const;
 
  private:
    etiss::plugin::gdb::GDBCore gdbcore_;
    std::string archname_;
};
 
} // namespace etiss
 
#endif