AddressSpace.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2010 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file AddressSpace.hh
 *
 * Declaration of AddressSpace class.
 *
 * @author Lasse Laasonen 2003 (lasse.laasonen-no.spam-tut.fi)
 * @author Pekka Jääskeläinen 2010
 * @note reviewed 10 Jun 2004 by vpj, am, tr, ll
 * @note rating: red
 */
 
#ifndef TTA_ADDRESS_SPACE_HH
#define TTA_ADDRESS_SPACE_HH
 
#include <string>
#include <set>
 
#include "MachinePart.hh"
#include "BaseType.hh"
 
namespace TTAMachine {
 
class Machine;
 
/**
 * Represents an address space in the machine.
 */
class AddressSpace : public Component {
public:
    AddressSpace(
        const std::string& name, int width, ULongWord minAddress,
        ULongWord maxAddress, Machine& owner);
    AddressSpace(const ObjectState* state, Machine& owner);
    virtual ~AddressSpace();
 
    virtual int width() const;
    virtual ULongWord start() const;
    virtual ULongWord end() const;
 
    virtual void setName(const std::string& name);
    virtual void setWidth(int width);
    virtual void setAddressBounds(ULongWord start, ULongWord end);
 
    virtual void addNumericalId(unsigned id);
    virtual bool hasNumericalId(unsigned id) const;
    std::set<unsigned> numericalIds() const;
    bool setNumericalIds(const std::set<unsigned>& ids);
    virtual void setShared(bool shared) { shared_ = shared; }
    virtual bool isShared() const { return shared_; }
 
    virtual void setMachine(Machine& mach);
    virtual void unsetMachine();
 
    virtual ObjectState* saveState() const;
    virtual void loadState(const ObjectState* state);
 
    bool operator==(const AddressSpace& other) const;
    bool operator!=(const AddressSpace& other) const;
 
    /// ObjectState name for AddressSpace.
    static const std::string OSNAME_ADDRESS_SPACE;
    /// ObjectState attribute key for the bit width.
    static const std::string OSKEY_WIDTH;
    /// ObjectState attribute key for minimum address.
    static const std::string OSKEY_MIN_ADDRESS;
    /// ObjectState attribute key for maximum address.
    static const std::string OSKEY_MAX_ADDRESS;
    static const std::string OSKEY_SHARED_MEMORY;
    static const std::string OSKEY_NUMERICAL_ID;
 
private:
    typedef std::set<unsigned> IDSet;
    /// Bit width of the minimum addressable word.
    int width_;
    /// Lowest address in the address space.
    ULongWord minAddress_;
    /// Highest address in the address space.
    ULongWord maxAddress_;
    /// The numerical ids mapped to this address space.
    IDSet numericalIds_;
    /// True in case this address space maps to a memory that is shared
    /// across all the cores in the multicore.
    bool shared_;
    
};
}
 
#endif