src/blfwk/ELFSourceFile.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(_ELFSourceFile_h_)
#define _ELFSourceFile_h_

#include "SourceFile.h"
#include "StELFFile.h"
#include "smart_ptr.h"
#include "DataSource.h"
#include "DataTarget.h"
#include "ELF.h"

namespace blfwk
{
enum elf_toolset_t
{
    kUnknownToolset, 
    kGHSToolset,     
    kGCCToolset,     
    kADSToolset      
};

enum secinfo_clear_t
{
    // Default value for the .secinfo action.
    kSecinfoDefault,

    kSecinfoIgnore,

    kSecinfoROMClear,

    kSecinfoCStartupClear
};

class ELFSourceFile : public SourceFile
{
public:
    ELFSourceFile(const std::string &path);

    virtual ~ELFSourceFile();

    static bool isELFFile(std::istream &stream);


    virtual void open();

    virtual void close();


    virtual bool supportsNamedSections() const { return true; }
    virtual bool supportsNamedSymbols() const { return true; }


    virtual DataSource *createDataSource();

    virtual DataSource *createDataSource(StringMatcher &matcher);

    //         baseAddress
    virtual DataSource *createDataSource(const std::vector<uint32_t> &baseAddress, bool match);


    virtual bool hasEntryPoint();

    virtual uint32_t getEntryPointAddress();


    virtual DataTarget *createDataTargetForSection(const std::string &section);
    virtual DataTarget *createDataTargetForSymbol(const std::string &symbol);


    virtual bool hasSymbol(const std::string &name);

    virtual uint32_t getSymbolValue(const std::string &name);

    virtual unsigned getSymbolSize(const std::string &name);


    StELFFile *getELFFile() { return m_file; }
    bool lookupSymbol(const std::string &name, Elf32_Sym &info);

protected:
    smart_ptr<StELFFile> m_file;     
    elf_toolset_t m_toolset;         
    secinfo_clear_t m_secinfoOption; 

protected:
    elf_toolset_t readToolsetOption();

    secinfo_clear_t readSecinfoClearOption();

protected:
    class ELFDataSource : public DataSource
    {
    public:
        class ProgBitsSegment : public DataSource::Segment
        {
        public:
            ProgBitsSegment(ELFDataSource &source, StELFFile *elf, unsigned index);

            virtual unsigned getData(unsigned offset, unsigned maxBytes, uint8_t *buffer);
            virtual unsigned getLength();

            virtual bool hasNaturalLocation() { return true; }
            virtual uint32_t getBaseAddress();

        protected:
            StELFFile *m_elf;        
            unsigned m_sectionIndex; 
        };

        class NoBitsSegment : public DataSource::PatternSegment
        {
        public:
            NoBitsSegment(ELFDataSource &source, StELFFile *elf, unsigned index);

            virtual unsigned getLength();

            virtual bool hasNaturalLocation() { return true; }
            virtual uint32_t getBaseAddress();

        protected:
            StELFFile *m_elf;        
            unsigned m_sectionIndex; 
        };

    public:
        ELFDataSource(StELFFile *elf)
            : DataSource()
            , m_elf(elf)
        {
        }

        virtual ~ELFDataSource();

        inline void setSecinfoOption(secinfo_clear_t option) { m_secinfoOption = option; }
        void addSection(unsigned sectionIndex);

        virtual unsigned getSegmentCount() { return (unsigned)m_segments.size(); }
        virtual DataSource::Segment *getSegmentAt(unsigned index) { return m_segments[index]; }
    protected:
        StELFFile *m_elf;                
        secinfo_clear_t m_secinfoOption; 

        typedef std::vector<DataSource::Segment *> segment_vector_t; 
        segment_vector_t m_segments;                                 
    };
};

}; // namespace blfwk

#endif // _ELFSourceFile_h_