// SPDX-License-Identifier: GPL-2.0+
/*******************************************************************************
 * QtMips - MIPS 32-bit Architecture Subset Simulator
 *
 * Implemented to support following courses:
 *
 *   B35APO - Computer Architectures
 *   https://cw.fel.cvut.cz/wiki/courses/b35apo
 *
 *   B4M35PAP - Advanced Computer Architectures
 *   https://cw.fel.cvut.cz/wiki/courses/b4m35pap/start
 *
 * Copyright (c) 2017-2019 Karel Koci<cynerd@email.cz>
 * Copyright (c) 2019      Pavel Pisa <pisa@cmp.felk.cvut.cz>
 *
 * Faculty of Electrical Engineering (http://www.fel.cvut.cz)
 * Czech Technical University        (http://www.cvut.cz/)
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 *
 ******************************************************************************/

#ifndef PHYSADDRSPACE_H
#define PHYSADDRSPACE_H

#include <QObject>
#include <QMap>
#include <cstdint>
#include <qtmipsexception.h>
#include "machinedefs.h"
#include "memory.h"

namespace machine {

class PhysAddrSpace : public MemoryAccess {
    Q_OBJECT
public:
    PhysAddrSpace();
    ~PhysAddrSpace();

    bool wword(std::uint32_t address, std::uint32_t value) override;
    std::uint32_t rword(std::uint32_t address, bool debug_access = false) const override;
    virtual std::uint32_t get_change_counter() const override;

    bool insert_range(MemoryAccess *mem_acces, std::uint32_t start_addr, std::uint32_t last_addr, bool move_ownership);
    bool remove_range(MemoryAccess *mem_acces);
    void clean_range(std::uint32_t start_addr, std::uint32_t last_addr);
    enum LocationStatus location_status(std::uint32_t offset) const override;
private slots:
    void range_external_change(const MemoryAccess *mem_access, std::uint32_t start_addr,
                               std::uint32_t last_addr, bool external);
private:
    class RangeDesc {
    public:
         RangeDesc(MemoryAccess *mem_acces, std::uint32_t start_addr, std::uint32_t last_addr, bool owned);
         std::uint32_t start_addr;
         std::uint32_t last_addr;
         MemoryAccess *mem_acces;
         bool owned;
    };
    QMap<std::uint32_t, RangeDesc *> ranges_by_addr;
    QMap<MemoryAccess *, RangeDesc *> ranges_by_access;
    RangeDesc *find_range(std::uint32_t address) const;
    mutable std::uint32_t change_counter;
};

}

#endif // PHYSADDRSPACE_H