BinaryEncoding.hh

Go to the documentation of this file.

/*
  Copyright (c) 2002-2014 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 BinaryEncoding.hh
 *
 * Declaration of BinaryEncoding class.
 *
 * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
 * @author Pekka Jääskeläinen 2014
 * @note rating: red
 */
 
#ifndef TTA_BINARY_ENCODING_HH
#define TTA_BINARY_ENCODING_HH
 
#include "Serializable.hh"
#include "InstructionField.hh"
#include "TCEString.hh"
 
#include <vector>
#include <map>
 
class MoveSlot;
class ImmediateSlotField;
class SocketCodeTable;
class ImmediateControlField;
class LImmDstRegisterField;
class InstructionFormat;
 
/**
 * BinaryEncoding is the root class in the object model of the binary
 * encoding map.
 *
 * An instance of this class is sufficient to access all the
 * information pertaining a binary encoding map, so an object can be
 * passed to clients whenever a full description of the encoding map
 * is required. BinaryEncoding is mostly a specialized container of
 * objects of other classes.
 */
class BinaryEncoding : public InstructionField {
public:
    enum Position {
        LEFT,
        RIGHT
    };
 
    BinaryEncoding();
    BinaryEncoding(const ObjectState* state);
 
    virtual ~BinaryEncoding();
 
    int moveSlotCount() const;
    MoveSlot& moveSlot(int index) const;
    bool hasMoveSlot(const std::string& name) const;
    MoveSlot& moveSlot(const std::string& name) const;
    void addMoveSlot(MoveSlot& slot);
    void removeMoveSlot(MoveSlot& slot);
 
    int immediateSlotCount() const;
    ImmediateSlotField& immediateSlot(int index) const;
    bool hasImmediateSlot(const std::string& name) const;
    ImmediateSlotField& immediateSlot(const std::string& name) const;
    void addImmediateSlot(ImmediateSlotField& slot);
    void removeImmediateSlot(ImmediateSlotField& slot);
 
    bool hasImmediateControlField() const;
    ImmediateControlField& immediateControlField() const;
    void setImmediateControlField(ImmediateControlField& field);
    void unsetImmediateControlField();
 
    int longImmDstRegisterFieldCount() const;
    LImmDstRegisterField& longImmDstRegisterField(int index) const;
    LImmDstRegisterField& longImmDstRegisterField(
        const std::string& iTemp, const std::string& dstUnit) const;
    void addLongImmDstRegisterField(LImmDstRegisterField& field);
    void removeLongImmDstRegisterField(LImmDstRegisterField& field);
 
    int instructionFormatCount() const;
    bool hasInstructionFormat(const std::string& name) const;
    InstructionFormat& instructionFormat(int index) const;
    InstructionFormat* instructionFormat(const std::string& name) const;
    void addInstructionFormat(InstructionFormat& format);
    void removeInstructionFormat(InstructionFormat& format);
 
    int socketCodeTableCount() const;
    SocketCodeTable& socketCodeTable(int index) const;
    SocketCodeTable& socketCodeTable(const std::string& name) const;
    void addSocketCodeTable(SocketCodeTable& table);
    void removeSocketCodeTable(SocketCodeTable& table);
    int longestTemplateExtraBits() const;
    
    // methods inherited from InstructionField
    virtual int childFieldCount() const;
    virtual InstructionField& childField(int position) const;
    virtual int width(const TCEString& templateName) const;
    virtual int width() const;
 
    void setTemplateExtraBits(const TCEString& templateName, int bitCount);
    int templateExtraBits(const TCEString& templateName) const;
 
    // methods inherited from Serializable interface
    virtual void loadState(const ObjectState* state);
    virtual ObjectState* saveState() const;
 
    /// ObjectState name for binary encoding.
    static const std::string OSNAME_BEM;
    static const std::string OSNAME_FU_OPCODE;
    static const std::string OSNAME_TEMPLATE_EXTRA_BITS;
    static const std::string OSNAME_TEMPLATE_EXTRA_BIT_COUNT;
    static const std::string OSNAME_TEMPLATE_NAME;
 
private:
    /// Container type for MoveSlots.
    typedef std::vector<MoveSlot*> MoveSlotContainer;
    /// Container type for ImmediateSlotFields.
    typedef std::vector<ImmediateSlotField*> ImmediateSlotContainer;
    /// Container type for SocketCodeTables.
    typedef std::vector<SocketCodeTable*> SocketCodeTableContainer;
    /// Container type for LImmDstRegisterFields.
    typedef std::vector<LImmDstRegisterField*> LImmDstRegisterFieldContainer;
    /// Container type for InstructionFormats.
    typedef std::vector<InstructionFormat*> InstructionFormatContainer;
    /// Template extra bit count container.
    typedef std::map<TCEString, int> TemplateExtraBitCountMap;
 
    bool hasSocketCodeTable(const std::string& name) const;
    void deleteMoveSlots();
    void deleteImmediateSlots();
    void deleteLongImmDstRegisterFields();
    void deleteSocketCodes();
    void deleteInstructionFormats();
 
    /// A container for instruction formats.
    InstructionFormatContainer instructionFormats_;
    /// A container for move slots.
    MoveSlotContainer moveSlots_;
    /// A container for immediate slots.
    ImmediateSlotContainer immediateSlots_;
    /// A container for socket code tables.
    SocketCodeTableContainer socketCodes_;
    /// The immediate control field.
    ImmediateControlField* immediateField_;
    /// A container for long immediate register fields.
    LImmDstRegisterFieldContainer longImmDstRegFields_;
    /// Extra (padding) bits per instruction template.
    TemplateExtraBitCountMap extraTemplateBits_;
};
 
#endif