ProgramWriter.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 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 ProgramWriter.hh
 *
 * Declaration of ProgramWriter class.
 *
 * @author Mikael Lepistö 2005 (tmlepist-no.spam-cs.tut.fi)
 * @note rating: yellow
 */
 
#ifndef TTA_PROGRAM_WRITER_HH
#define TTA_PROGRAM_WRITER_HH
 
#include <map>
 
#include "BaseType.hh"
#include "MoveElement.hh"
#include "Binary.hh"
#include "Address.hh"
 
namespace TPEF {
    class Binary;
    class CodeSection;
    class RelocSection;
    class SymbolSection;
    class ResourceSection;
    class ResourceElement;
    class Section;
    class ASpaceElement;
    class SectionElement;
}
 
namespace TTAMachine {
    class Machine;
    class Bus;
    class RegisterFile;
    class ImmediateUnit;
    class FunctionUnit;
    class Port;
    class HWOperation;
    class MachinePart;
    class AddressSpace;
}
 
namespace TTAProgram {
 
class Program;
class Terminal;
 
/**
 * Returns requested Machine parts as a TPEF resources.
 *
 * Also adds new resources to resource section if resource is not
 * already there.
 *
 * NOTE: If resource section is modified externally, cache should be cleared.
 *
 */
class TPEFResourceUpdater {
public:
    TPEFResourceUpdater(
        TTAMachine::Machine& mach,
        TPEF::ResourceSection& resources);
 
    void clearCache();
 
    TPEF::ResourceElement& bus(const TTAMachine::Bus& bus);
    TPEF::ResourceElement& functionUnitPort(const TTAMachine::Port& port);
    TPEF::ResourceElement& operand(
        const TTAMachine::HWOperation& oper,
        int operandIndex);
    TPEF::ResourceElement& functionUnit(const TTAMachine::FunctionUnit& fu);
    TPEF::ResourceElement& registerFile(const TTAMachine::RegisterFile& rf);
    TPEF::ResourceElement& immediateUnit(
        const TTAMachine::ImmediateUnit& immUnit);
 
private:
    void initCache();
 
    /// The model of the target processor architecture.
    TTAMachine::Machine& mach_;
    /// The TPEF input section that contains all machine resource entries.
    TPEF::ResourceSection& resources_;
    
    // Key type for caching ResourceElements for machine components.
    // For example (HWOperation, index) pair
    typedef std::pair<const TTAMachine::MachinePart*, int> CacheKey;
    /// Mapping from parts of the target processor model to TPEF machine
    /// resource entries.
    typedef std::map<CacheKey, TPEF::ResourceElement*> ResourceCache;
 
    /// Aggregate of all mappings between machine resource entries and
    /// target processor parts (machine parts).
    ResourceCache cache_;
 
    /// Last TPEF bus id that was generated.
    HalfWord lastBusId_;
    /// Last TPEF unit port id that was generated.
    HalfWord lastUnitPortId_;
    /// Last TPEF function unit id that was generated.
    HalfWord lastFunctionUnitId_;
    /// Last TPEF register file id that was generated.
    HalfWord lastRegisterFileId_;
    /// Last TPEF immediate unit id that was generated.
    HalfWord lastImmediateUnitId_;
};
 
/**
 * Writes new TPEF out of POM and original TPEF.
 *
 * Writer creates creates whole new code section, code relocation section,
 * resource section and symbol section for code symbols. Data sections,
 * uninitialized data sections and data to data relocations are also copied
 * from original TPEF.
 *
 * Client of POM has to write data to code relocations and all sections
 * that client wants to preserve from original TPEF.
 */
class ProgramWriter {
public:
    ProgramWriter(const Program& prog);
 
    TPEF::Binary* createBinary() const;
 
    static TPEF::Binary* createBinary(const Program& prog);
 
private:
    /**
     * TPEF resource id:s for getting corresponding resource elements.
     */
    struct ResourceID {
        TPEF::MoveElement::FieldType type; ///< RF, UNIT or IMM.
        HalfWord unit; ///< Unit id.
        HalfWord index; ///< Operand or register file index.
    };
    
    /**
     * Info about relocation of immediate or data chunk.
     */
    struct RelocInfo {
        RelocInfo(
            TPEF::Section* aSrcSect, TPEF::SectionElement* aSrcElem, 
            const Address& aDstAddress, int bitWidth) : 
            srcSect(aSrcSect), srcElem(aSrcElem),
            destination(aDstAddress), bits(bitWidth) {
        }
        
        /// Location section.
        TPEF::Section* srcSect;
        /// Location element.
        TPEF::SectionElement* srcElem;
        /// Destination address.
        Address destination;
        /// Relocation width.
        int bits;      
    };
 
    void createCodeSection(
        TPEF::CodeSection* code,
        TPEFResourceUpdater& updater) const;
 
    void createDataSections(TPEF::Binary* bin, bool littleEndian) const;
 
    void createRelocSections(TPEF::Binary* bin) const;
 
    TPEF::Section& findSection(TPEF::Binary& bin, Address address) const;
 
    ResourceID terminalResource(
        const Terminal& term,
        TPEFResourceUpdater& updater) const;
 
    TPEF::Binary::FileType resolveFileType(
        TPEF::ResourceSection& resources) const;
    
    TPEF::ASpaceElement& createASpaceElement(
        const TTAMachine::AddressSpace& addressSpace, 
        TPEF::Binary& bin) const;
 
    
    /// Program that is written to TPEF.
    const Program& prog_;
    /// Created TPEF binary.
    //    const TPEF::Binary& tpef_;
 
    /// Map that contains created address spaces
    mutable std::map<const TTAMachine::AddressSpace*, 
                     TPEF::ASpaceElement*> aSpaceMap_;
 
    mutable std::vector<RelocInfo> relocInfos_;
    
    /// Default widt that is used as address width of relocations of immediate
    /// elements. This should be fixed by checking width from bus or template.
    static const HalfWord IMMEDIATE_ADDRESS_WIDTH;
 
    /// Maximum width for short immediates
    static const int MAX_SIMM_WIDTH;
};
 
}
 
#endif