src/blfwk/StELFFile.h

/*
 * Copyright (c) 2013-14, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. 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.
 */
#if !defined(_StELFFile_h_)
#define _StELFFile_h_

#include "blfwk/stdafx.h"
#include <string>
#include <vector>
#include <map>
#include <iostream>
#include <stdexcept>
#include "blfwk/ELF.h"

typedef enum
{
    eARMVariant = 1, 
    eGHSVariant,     
    eGCCVariant      
} ELFVariant_t;

typedef enum
{
    eUnknownSymbol,
    eARMSymbol,
    eThumbSymbol,
    eDataSymbol
} ARMSymbolType_t;

class StELFFile
{
public:
    typedef std::vector<Elf32_Shdr>::const_iterator const_section_iterator;
    typedef std::vector<Elf32_Phdr>::const_iterator const_segment_iterator;

public:
    StELFFile(std::istream &inStream);

    virtual ~StELFFile();


    virtual ELFVariant_t ELFVariant() { return m_elfVariant; }
    virtual void setELFVariant(ELFVariant_t variant) { m_elfVariant = variant; }


    virtual void setName(const std::string &inName) { m_name = inName; }
    virtual std::string getName() const { return m_name; }


    inline const Elf32_Ehdr &getFileHeader() const { return m_header; }


    inline unsigned getSectionCount() const { return static_cast<unsigned>(m_sectionHeaders.size()); }
    const Elf32_Shdr &getSectionAtIndex(unsigned inIndex) const;

    inline const_section_iterator getSectionBegin() const { return m_sectionHeaders.begin(); }
    inline const_section_iterator getSectionEnd() const { return m_sectionHeaders.end(); }
    unsigned getIndexOfSectionWithName(const std::string &inName);

    uint8_t *getSectionDataAtIndex(unsigned inIndex);

    uint8_t *getSectionData(const_section_iterator inSection);


    inline unsigned getSegmentCount() const { return static_cast<unsigned>(m_programHeaders.size()); }
    const Elf32_Phdr &getSegmentAtIndex(unsigned inIndex) const;

    inline const_segment_iterator getSegmentBegin() const { return m_programHeaders.begin(); }
    inline const_segment_iterator getSegmentEnd() const { return m_programHeaders.end(); }
    uint8_t *getSegmentDataAtIndex(unsigned inIndex);

    uint8_t *getSegmentData(const_segment_iterator inSegment);


    std::string getSectionNameAtIndex(unsigned inIndex);

    std::string getStringAtIndex(unsigned inStringTableSectionIndex, unsigned inStringIndex);


    unsigned getSymbolCount();

    const Elf32_Sym &getSymbolAtIndex(unsigned inIndex);

    unsigned getSymbolNameStringTableIndex() const;

    std::string getSymbolName(const Elf32_Sym &inSymbol);

    unsigned getIndexOfSymbolAtAddress(uint32_t symbolAddress, bool strict = true);

    ARMSymbolType_t getTypeOfSymbolAtIndex(unsigned symbolIndex);


    void dumpSections();
    void dumpSymbolTable();

protected:
    std::istream &m_stream;                   
    ELFVariant_t m_elfVariant;                
    std::string m_name;                       
    Elf32_Ehdr m_header;                      
    std::vector<Elf32_Shdr> m_sectionHeaders; 
    std::vector<Elf32_Phdr> m_programHeaders; 
    unsigned m_symbolTableIndex;              

    struct SectionDataInfo
    {
        uint8_t *m_data; 
        unsigned m_size; 
        bool m_swapped;  
    };
    typedef std::map<unsigned, SectionDataInfo> SectionDataMap;
    SectionDataMap m_sectionDataCache; 

    SectionDataInfo &getCachedSectionData(unsigned inSectionIndex);

    void readFileHeaders();

    uint8_t *readSectionData(const Elf32_Shdr &inHeader);
    uint8_t *readSegmentData(const Elf32_Phdr &inHeader);

    void byteSwapSymbolTable(const Elf32_Shdr &header, SectionDataInfo &info);
};

class StELFFileException : public std::runtime_error
{
public:
    StELFFileException(const std::string &inMessage)
        : std::runtime_error(inMessage)
    {
    }
};

#endif // _StELFFile_h_