apps/elftosb/common/DataSource.h

/*
 * File:    DataSource.h
 *
 * Copyright (c) Freescale Semiconductor, Inc. All rights reserved.
 * See included license file for license details.
 */
#if !defined(_DataSource_h_)
#define _DataSource_h_

#include <vector>
#include "Value.h"
#include "smart_ptr.h"
#include "StExecutableImage.h"

namespace elftosb
{
// Forward declaration
class DataTarget;

class DataSource
{
public:
    class Segment
    {
    public:
        Segment(DataSource &source)
            : m_source(source)
        {
        }

        virtual ~Segment() {}
        virtual unsigned getData(unsigned offset, unsigned maxBytes, uint8_t *buffer) = 0;

        virtual unsigned getLength() = 0;

        virtual bool hasNaturalLocation() = 0;

        virtual uint32_t getBaseAddress() { return 0; }
    protected:
        DataSource &m_source; 
    };

    class PatternSegment : public Segment
    {
    public:
        PatternSegment(DataSource &source);

        PatternSegment(DataSource &source, const SizedIntegerValue &pattern);

        PatternSegment(DataSource &source, uint8_t pattern);

        PatternSegment(DataSource &source, uint16_t pattern);

        PatternSegment(DataSource &source, uint32_t pattern);


        virtual bool hasNaturalLocation() { return false; }
        virtual unsigned getData(unsigned offset, unsigned maxBytes, uint8_t *buffer);

        virtual unsigned getLength();


        inline void setPattern(const SizedIntegerValue &newPattern) { m_pattern = newPattern; }
        inline SizedIntegerValue &getPattern() { return m_pattern; }
        PatternSegment &operator=(const SizedIntegerValue &value)
        {
            m_pattern = value;
            return *this;
        }

    protected:
        SizedIntegerValue m_pattern; 
    };

public:
    DataSource()
        : m_target(0)
    {
    }

    virtual ~DataSource() {}

    inline void setTarget(DataTarget *target) { m_target = target; }
    inline DataTarget *getTarget() const { return m_target; }


    virtual unsigned getSegmentCount() = 0;

    virtual Segment *getSegmentAt(unsigned index) = 0;

protected:
    DataTarget *m_target; 
};

class PatternSource : public DataSource, public DataSource::PatternSegment
{
public:
    PatternSource();

    PatternSource(const SizedIntegerValue &value);

    virtual unsigned getSegmentCount() { return 1; }
    virtual DataSource::Segment *getSegmentAt(unsigned index) { return this; }
    PatternSource &operator=(const SizedIntegerValue &value)
    {
        setPattern(value);
        return *this;
    }
};

class UnmappedDataSource : public DataSource, public DataSource::Segment
{
public:
    UnmappedDataSource();

    UnmappedDataSource(const uint8_t *data, unsigned length);

    void setData(const uint8_t *data, unsigned length);

    virtual unsigned getSegmentCount() { return 1; }
    virtual DataSource::Segment *getSegmentAt(unsigned index) { return this; }

    virtual bool hasNaturalLocation() { return false; }
    virtual unsigned getData(unsigned offset, unsigned maxBytes, uint8_t *buffer);

    virtual unsigned getLength() { return m_length; }

protected:
    smart_array_ptr<uint8_t> m_data; 
    unsigned m_length;               
};

class MemoryImageDataSource : public DataSource
{
public:
    MemoryImageDataSource(StExecutableImage *image);

    virtual ~MemoryImageDataSource();

    virtual unsigned getSegmentCount();

    virtual DataSource::Segment *getSegmentAt(unsigned index);

protected:
    class TextSegment : public DataSource::Segment
    {
    public:
        TextSegment(MemoryImageDataSource &source, StExecutableImage *image, 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:
        StExecutableImage *m_image; 
        unsigned m_index;           
    };

    class FillSegment : public DataSource::PatternSegment
    {
    public:
        FillSegment(MemoryImageDataSource &source, StExecutableImage *image, unsigned index);

        virtual unsigned getLength();

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

    protected:
        StExecutableImage *m_image; 
        unsigned m_index;           
    };

protected:
    StExecutableImage *m_image; 

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

}; // namespace elftosb

#endif // _DataSource_h_