ExecutableFormat.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBEXEC_EXECUTABLEFORMAT_H
#define __LIBEXEC_EXECUTABLEFORMAT_H
#ifndef __ASSEMBLER__
 
#include <Memory.h>
#include <Types.h>
 
typedef Address EntryPoint;
 
class ExecutableFormat;
 
typedef ExecutableFormat * FormatDetector(u8 *image, Size size);
 
class ExecutableFormat
{
  public:
 
    typedef struct Region
    {
        Address virt;
        Address dataOffset;
        Size dataSize;
        Size memorySize;
        Memory::Access access;
    }
    Region;
 
    enum Result
    {
        Success,
        NotFound,
        InvalidFormat,
        OutOfMemory
    };
 
  public:
 
    ExecutableFormat(const u8 *image, const Size size);
 
    virtual ~ExecutableFormat();
 
    virtual Result regions(Region *regions, Size *count) const = 0;
 
    virtual Result entry(Address *entry) const = 0;
 
    static Result find(const u8 *image, const Size size, ExecutableFormat **fmt);
 
  protected:
 
    const u8 *m_image;
 
    const Size m_size;
};
 
#endif /* __ASSEMBLER__ */
#endif /* __LIBEXEC_EXECUTABLEFORMAT_H */