Translation.h

Go to the documentation of this file.

/*
 
        @copyright
 
        <pre>
 
        Copyright 2018 Infineon Technologies AG
 
        This file is part of ETISS tool, see <https://github.com/tum-ei-eda/etiss>.
 
        The initial version of this software has been created with the funding support by the German Federal
        Ministry of Education and Research (BMBF) in the project EffektiV under grant 01IS13022.
 
        Redistribution and use in source and binary forms, with or without modification, are permitted
        provided that the following conditions are met:
 
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and
        the following disclaimer.
 
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
        and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse
        or promote products derived from this software without specific prior written permission.
 
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
        WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
        PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
        DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
        PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
        NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGE.
 
        </pre>
 
        @author Chair of Electronic Design Automation, TUM
 
        @version 0.1
 
*/
 
#ifndef ETISS_INCLUDE_TRANSLATION_H
#define ETISS_INCLUDE_TRANSLATION_H
 
#include "etiss/CPUArch.h"
#include "etiss/CodePart.h"
#include "etiss/Instruction.h"
#include "etiss/JIT.h"
 
#include <memory>
#include <unordered_map>
 
namespace etiss
{
 
typedef etiss::int32 (*ExecBlockCall)(ETISS_CPU *cpu, ETISS_System *system, void **plugin_pointers);
 
class BlockLink
{
  public:
    const etiss::uint64 start;          
    const etiss::uint64 end;            
    BlockLink *next;                    
    BlockLink *branch;                  
    unsigned refcount;                  
    const ExecBlockCall execBlock;      
    bool valid;                         
    const std::shared_ptr<void> jitlib; 
    BlockLink(etiss::uint64 start, etiss::uint64 end, ExecBlockCall execBlock, std::shared_ptr<void> lib);
    ~BlockLink();
    static inline void incrRef(BlockLink *link) { link->refcount++; }
    static inline void decrRef(BlockLink *&link)
    {
        link->refcount--;
        if (unlikely(link->refcount == 0))
        {
            delete link;
        }
        link = 0;
    }
    static inline void updateRef(BlockLink *&link, BlockLink *newValue)
    {
        if (link == newValue)
        {
            return;
        }
        if (likely(link != 0))
        {
            link->refcount--;
            if (unlikely(link->refcount == 0))
            {
                delete link;
            }
        }
        if (likely(newValue != 0))
        {
            incrRef(newValue);
        }
        link = newValue;
    }
};
 
class Translation
{
  private:
    std::shared_ptr<etiss::CPUArch> &archptr_;
    std::shared_ptr<etiss::JIT> &jitptr_;
    etiss::CPUArch *const arch_;
    etiss::JIT *const jit_;
    std::list<std::shared_ptr<etiss::Plugin>> &plugins_;
    ETISS_System &system_;
    ETISS_CPU &cpu_;
    etiss::TranslationPlugin **plugins_array_;
    void **plugins_handle_array_;
    size_t plugins_array_size_;
 
    void (*plugins_initCodeBlock_)(etiss::TranslationPlugin **, CodeBlock &);
    void (*plugins_finalizeCodeBlock_)(etiss::TranslationPlugin **, CodeBlock &);
 
    etiss::instr::ModedInstructionSet *mis_;
 
    std::unordered_map<etiss::uint64, std::list<BlockLink *>> blockmap_;
#if ETISS_TRANSLATOR_STAT
    etiss::uint64 next_count_;
    etiss::uint64 branch_count_;
    etiss::uint64 miss_count_;
#endif
  public:
    Translation(std::shared_ptr<etiss::CPUArch> &arch, std::shared_ptr<etiss::JIT> &jit,
                std::list<std::shared_ptr<etiss::Plugin>> &plugins, ETISS_System &system, ETISS_CPU &cpu);
    ~Translation();
    void **init();
    inline BlockLink *getBlockFast(BlockLink *prev, const etiss::uint64 &instructionindex)
    {
        if (prev != 0)
        {
            BlockLink *bl = prev->next;
            if (instructionindex >= prev->end && bl != 0 && bl->end > instructionindex)
            { // ->next MUST always start immediately after the current block since it is not checked here
                // check if block is invalid
                if (bl->valid)
                {
#if ETISS_TRANSLATOR_STAT
                    next_count_++;
#endif
                    return bl;
                }
                else
                {
                    BlockLink::updateRef(prev->next, 0);
                }
            }
            bl = prev->branch;
            if (bl != 0 && bl->start <= instructionindex && bl->end > instructionindex)
            {
                // check if block is invalid
                if (bl->valid)
                { // check
#if ETISS_TRANSLATOR_STAT
                    branch_count_++;
#endif
                    return bl;
                }
                else
                {
                    BlockLink::updateRef(prev->branch, 0);
                }
            }
        }
#if ETISS_TRANSLATOR_STAT
        miss_count_++;
#endif
        return getBlock(prev, instructionindex);
    }
 
    BlockLink *getBlock(BlockLink *prev, const etiss::uint64 &instructionindex);
 
    etiss::int32 translateBlock(CodeBlock &cb);
 
    void unloadBlocksAll();
 
    void unloadBlocks(etiss::uint64 startindex = 0, etiss::uint64 endindex = ((etiss::uint64)((etiss::int64)-1)));
 
    std::string disasm(uint8_t *buf, unsigned len, int &append);
 
  private:
    const uint64_t id;
    uint64_t tblockcount;
};
 
} // namespace etiss
 
#endif // ETISS_INCLUDE_TRANSLATION_H