MSXCPUInterface.hh

Go to the documentation of this file.

#ifndef MSXCPUINTERFACE_HH
#define MSXCPUINTERFACE_HH

#include "DebugCondition.hh"
#include "SimpleDebuggable.hh"
#include "InfoTopic.hh"
#include "CacheLine.hh"
#include "MSXDevice.hh"
#include "BreakPoint.hh"
#include "WatchPoint.hh"
#include "openmsx.hh"
#include "likely.hh"
#include "ranges.hh"
#include <bitset>
#include <vector>
#include <memory>

namespace openmsx {

class VDPIODelay;
class DummyDevice;
class MSXMotherBoard;
class MSXCPU;
class CliComm;
class BreakPoint;
class CartridgeSlotManager;

struct CompareBreakpoints {
        bool operator()(const BreakPoint& x, const BreakPoint& y) const {
                return x.getAddress() < y.getAddress();
        }
        bool operator()(const BreakPoint& x, word y) const {
                return x.getAddress() < y;
        }
        bool operator()(word x, const BreakPoint& y) const {
                return x < y.getAddress();
        }
};

class MSXCPUInterface
{
public:
        MSXCPUInterface(const MSXCPUInterface&) = delete;
        MSXCPUInterface& operator=(const MSXCPUInterface&) = delete;

        explicit MSXCPUInterface(MSXMotherBoard& motherBoard);
        ~MSXCPUInterface();

        void register_IO_In(byte port, MSXDevice* device);
        void unregister_IO_In(byte port, MSXDevice* device);

        void register_IO_Out(byte port, MSXDevice* device);
        void unregister_IO_Out(byte port, MSXDevice* device);

        bool replace_IO_In (byte port, MSXDevice* oldDevice, MSXDevice* newDevice);
        bool replace_IO_Out(byte port, MSXDevice* oldDevice, MSXDevice* newDevice);

        void registerMemDevice(MSXDevice& device,
                               int ps, int ss, int base, int size);
        void unregisterMemDevice(MSXDevice& device,
                                 int ps, int ss, int base, int size);

        void   registerGlobalWrite(MSXDevice& device, word address);
        void unregisterGlobalWrite(MSXDevice& device, word address);

        void   registerGlobalRead(MSXDevice& device, word address);
        void unregisterGlobalRead(MSXDevice& device, word address);

        void reset();

        inline byte readMem(word address, EmuTime::param time) {
                if (unlikely(disallowReadCache[address >> CacheLine::BITS])) {
                        return readMemSlow(address, time);
                }
                return visibleDevices[address >> 14]->readMem(address, time);
        }

        inline void writeMem(word address, byte value, EmuTime::param time) {
                if (unlikely(disallowWriteCache[address >> CacheLine::BITS])) {
                        writeMemSlow(address, value, time);
                        return;
                }
                visibleDevices[address>>14]->writeMem(address, value, time);
        }

        inline byte readIO(word port, EmuTime::param time) {
                return IO_In[port & 0xFF]->readIO(port, time);
        }

        inline void writeIO(word port, byte value, EmuTime::param time) {
                IO_Out[port & 0xFF]->writeIO(port, value, time);
        }

        inline const byte* getReadCacheLine(word start) const {
                if (unlikely(disallowReadCache[start >> CacheLine::BITS])) {
                        return nullptr;
                }
                return visibleDevices[start >> 14]->getReadCacheLine(start);
        }

        inline byte* getWriteCacheLine(word start) const {
                if (unlikely(disallowWriteCache[start >> CacheLine::BITS])) {
                        return nullptr;
                }
                return visibleDevices[start >> 14]->getWriteCacheLine(start);
        }

        byte readIRQVector();

        /*
         * Should only be used by PPI
         *  TODO: make private / friend
         */
        void setPrimarySlots(byte value);

        byte peekMem(word address, EmuTime::param time) const;
        byte peekSlottedMem(unsigned address, EmuTime::param time) const;
        byte readSlottedMem(unsigned address, EmuTime::param time);
        void writeSlottedMem(unsigned address, byte value,
                             EmuTime::param time);

        void setExpanded(int ps);
        void unsetExpanded(int ps);
        void testUnsetExpanded(int ps, std::vector<MSXDevice*> allowed) const;
        inline bool isExpanded(int ps) const { return expanded[ps] != 0; }
        void changeExpanded(bool newExpanded);

        DummyDevice& getDummyDevice() { return *dummyDevice; }

        static void insertBreakPoint(BreakPoint bp);
        static void removeBreakPoint(const BreakPoint& bp);
        using BreakPoints = std::vector<BreakPoint>;
        static const BreakPoints& getBreakPoints() { return breakPoints; }

        void setWatchPoint(const std::shared_ptr<WatchPoint>& watchPoint);
        void removeWatchPoint(std::shared_ptr<WatchPoint> watchPoint);
        // note: must be shared_ptr (not unique_ptr), see WatchIO::doReadCallback()
        using WatchPoints = std::vector<std::shared_ptr<WatchPoint>>;
        const WatchPoints& getWatchPoints() const { return watchPoints; }

        static void setCondition(DebugCondition cond);
        static void removeCondition(const DebugCondition& cond);
        using Conditions = std::vector<DebugCondition>;
        static const Conditions& getConditions() { return conditions; }

        static bool isBreaked() { return breaked; }
        void doBreak();
        void doStep();
        void doContinue();

        // breakpoint methods used by CPUCore
        static bool anyBreakPoints()
        {
                return !breakPoints.empty() || !conditions.empty();
        }
        static bool checkBreakPoints(unsigned pc, MSXMotherBoard& motherBoard)
        {
                auto range = ranges::equal_range(breakPoints, pc, CompareBreakpoints());
                if (conditions.empty() && (range.first == range.second)) {
                        return false;
                }

                // slow path non-inlined
                checkBreakPoints(range, motherBoard);
                return isBreaked();
        }

        // cleanup global variables
        static void cleanup();

        // In fast-forward mode, breakpoints, watchpoints and conditions should
        // not trigger.
        void setFastForward(bool fastForward_) { fastForward = fastForward_; }
        bool isFastForward() const { return fastForward; }

        template<typename Archive>
        void serialize(Archive& ar, unsigned version);

private:
        byte readMemSlow(word address, EmuTime::param time);
        void writeMemSlow(word address, byte value, EmuTime::param time);

        MSXDevice*& getDevicePtr(byte port, bool isIn);

        void register_IO  (int port, bool isIn,
                           MSXDevice*& devicePtr, MSXDevice* device);
        void unregister_IO(MSXDevice*& devicePtr, MSXDevice* device);
        void testRegisterSlot(MSXDevice& device,
                              int ps, int ss, int base, int size);
        void registerSlot(MSXDevice& device,
                          int ps, int ss, int base, int size);
        void unregisterSlot(MSXDevice& device,
                            int ps, int ss, int base, int size);


        static void checkBreakPoints(std::pair<BreakPoints::const_iterator,
                                               BreakPoints::const_iterator> range,
                                     MSXMotherBoard& motherBoard);
        static void removeBreakPoint(unsigned id);
        static void removeCondition(unsigned id);

        void removeAllWatchPoints();
        void registerIOWatch  (WatchPoint& watchPoint, MSXDevice** devices);
        void unregisterIOWatch(WatchPoint& watchPoint, MSXDevice** devices);
        void updateMemWatch(WatchPoint::Type type);
        void executeMemWatch(WatchPoint::Type type, unsigned address,
                             unsigned value = ~0u);

        struct MemoryDebug final : SimpleDebuggable {
                explicit MemoryDebug(MSXMotherBoard& motherBoard);
                byte read(unsigned address, EmuTime::param time) override;
                void write(unsigned address, byte value, EmuTime::param time) override;
        } memoryDebug;

        struct SlottedMemoryDebug final : SimpleDebuggable {
                explicit SlottedMemoryDebug(MSXMotherBoard& motherBoard);
                byte read(unsigned address, EmuTime::param time) override;
                void write(unsigned address, byte value, EmuTime::param time) override;
        } slottedMemoryDebug;

        struct IODebug final : SimpleDebuggable {
                explicit IODebug(MSXMotherBoard& motherBoard);
                byte read(unsigned address, EmuTime::param time) override;
                void write(unsigned address, byte value, EmuTime::param time) override;
        } ioDebug;

        struct SlotInfo final : InfoTopic {
                explicit SlotInfo(InfoCommand& machineInfoCommand);
                void execute(span<const TclObject> tokens,
                             TclObject& result) const override;
                std::string help(const std::vector<std::string>& tokens) const override;
        } slotInfo;

        struct SubSlottedInfo final : InfoTopic {
                explicit SubSlottedInfo(InfoCommand& machineInfoCommand);
                void execute(span<const TclObject> tokens,
                             TclObject& result) const override;
                std::string help(const std::vector<std::string>& tokens) const override;
        } subSlottedInfo;

        struct ExternalSlotInfo final : InfoTopic {
                explicit ExternalSlotInfo(InfoCommand& machineInfoCommand);
                void execute(span<const TclObject> tokens,
                             TclObject& result) const override;
                std::string help(const std::vector<std::string>& tokens) const override;
        } externalSlotInfo;

        struct IOInfo : InfoTopic {
                IOInfo(InfoCommand& machineInfoCommand, const char* name);
                void helper(span<const TclObject> tokens,
                            TclObject& result, MSXDevice** devices) const;
                std::string help(const std::vector<std::string>& tokens) const override;
        protected:
                ~IOInfo() = default;
        };
        struct IInfo final : IOInfo {
                explicit IInfo(InfoCommand& machineInfoCommand)
                        : IOInfo(machineInfoCommand, "input_port") {}
                void execute(span<const TclObject> tokens,
                             TclObject& result) const override;
        } inputPortInfo;
        struct OInfo final : IOInfo {
                explicit OInfo(InfoCommand& machineInfoCommand)
                        : IOInfo(machineInfoCommand, "output_port") {}
                void execute(span<const TclObject> tokens,
                             TclObject& result) const override;
        } outputPortInfo;

        void updateVisible(int page);
        inline void updateVisible(int page, int ps, int ss);
        void setSubSlot(byte primSlot, byte value);

        std::unique_ptr<DummyDevice> dummyDevice;
        MSXCPU& msxcpu;
        CliComm& cliComm;
        MSXMotherBoard& motherBoard;

        std::unique_ptr<VDPIODelay> delayDevice; // can be nullptr

        byte disallowReadCache [CacheLine::NUM];
        byte disallowWriteCache[CacheLine::NUM];
        std::bitset<CacheLine::SIZE> readWatchSet [CacheLine::NUM];
        std::bitset<CacheLine::SIZE> writeWatchSet[CacheLine::NUM];

        struct GlobalRwInfo {
                MSXDevice* device;
                word addr;
                bool operator==(const GlobalRwInfo& rhs) const {
                        return (device == rhs.device) &&
                               (addr   == rhs.addr);
                }
        };
        std::vector<GlobalRwInfo> globalReads;
        std::vector<GlobalRwInfo> globalWrites;

        MSXDevice* IO_In [256];
        MSXDevice* IO_Out[256];
        MSXDevice* slotLayout[4][4][4];
        MSXDevice* visibleDevices[4];
        byte subSlotRegister[4];
        byte primarySlotState[4];
        byte secondarySlotState[4];
        byte initialPrimarySlots;
        unsigned expanded[4];

        bool fastForward; // no need to serialize

        //  All CPUs (Z80 and R800) of all MSX machines share this state.
        static inline BreakPoints breakPoints; // sorted on address
        WatchPoints watchPoints; // ordered in creation order,  TODO must also be static
        static inline Conditions conditions; // ordered in creation order
        static inline bool breaked = false;
};


// Compile-Time Interval (half-open).
//   TODO possibly move this to utils/
template<unsigned BEGIN, unsigned END = BEGIN + 1>
struct CT_Interval
{
        unsigned begin() const { return BEGIN; } // inclusive
        unsigned end()   const { return END; }   // exclusive
};

// Execute an 'action' for every element in the given interval(s).
template<typename ACTION, typename CT_INTERVAL>
inline void foreach_ct_interval(ACTION action, CT_INTERVAL interval)
{
        for (auto i = interval.begin(); i != interval.end(); ++i) {
                action(i);
        }
}
template<typename ACTION, typename CT_INTERVAL, typename... CT_INTERVALS>
inline void foreach_ct_interval(ACTION action, CT_INTERVAL front, CT_INTERVALS... tail)
{
        foreach_ct_interval(action, front);
        foreach_ct_interval(action, tail...);
}


template<typename MSXDEVICE, typename... CT_INTERVALS>
struct GlobalRWHelper
{
        template<typename ACTION>
        void execute(ACTION action)
        {
                auto& dev = static_cast<MSXDEVICE&>(*this);
                auto& cpu = dev.getCPUInterface();
                foreach_ct_interval(
                        [&](unsigned addr) { action(cpu, dev, addr); },
                        CT_INTERVALS()...);
        }
};

template<typename MSXDEVICE, typename... CT_INTERVALS>
struct GlobalWriteClient : GlobalRWHelper<MSXDEVICE, CT_INTERVALS...>
{
        GlobalWriteClient()
        {
                this->execute([](MSXCPUInterface& cpu, MSXDevice& dev, unsigned addr) {
                        cpu.registerGlobalWrite(dev, addr);
                });
        }

        ~GlobalWriteClient()
        {
                this->execute([](MSXCPUInterface& cpu, MSXDevice& dev, unsigned addr) {
                        cpu.unregisterGlobalWrite(dev, addr);
                });
        }
};

template<typename MSXDEVICE, typename... CT_INTERVALS>
struct GlobalReadClient : GlobalRWHelper<MSXDEVICE, CT_INTERVALS...>
{
        GlobalReadClient()
        {
                this->execute([](MSXCPUInterface& cpu, MSXDevice& dev, unsigned addr) {
                        cpu.registerGlobalRead(dev, addr);
                });
        }

        ~GlobalReadClient()
        {
                this->execute([](MSXCPUInterface& cpu, MSXDevice& dev, unsigned addr) {
                        cpu.unregisterGlobalRead(dev, addr);
                });
        }
};

} // namespace openmsx

#endif