audk/BaseTools/ImageTool/ImageTool.h

/** @file
  Copyright (c) 2021, Marvin Häuser. All rights reserved.
  Copyright (c) 2022, Mikhail Krichanov. All rights reserved.
  SPDX-License-Identifier: BSD-3-Clause
**/

#ifndef IMAGE_TOOL_H
#define IMAGE_TOOL_H

#include <stdbool.h>
#include <errno.h>
#include <assert.h>

#include <IndustryStandard/PeImage2.h>
#include <IndustryStandard/UeImage.h>
#include <Library/PeCoffLib2.h>
#include <Library/UeImageLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/BaseOverflowLib.h>
#include <Library/MemoryAllocationLib.h>
#include <UserFile.h>
#include "../../UefiPayloadPkg/PayloadLoaderPeim/ElfLib/ElfCommon.h"

#undef ELF_R_TYPE
#undef ELF_R_SYM

#ifdef EFI_TARGET32
#include "../../UefiPayloadPkg/PayloadLoaderPeim/ElfLib/Elf32.h"

#define EFI_IMAGE_NT_HEADERS             EFI_IMAGE_NT_HEADERS32
#define EFI_IMAGE_NT_OPTIONAL_HDR_MAGIC  EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
#define EFI_IMAGE_FILE_MACHINE           EFI_IMAGE_FILE_32BIT_MACHINE
#define ELFCLASS                         ELFCLASS32
#define Elf_Ehdr                         Elf32_Ehdr
#define Elf_Shdr                         Elf32_Shdr
#define Elf_Sym                          Elf32_Sym
#define Elf_Rel                          Elf32_Rel
#define Elf_Rela                         Elf32_Rela
#define Elf_Size                         Elf32_Size
#define Elf_Addr                         Elf32_Addr
#define ELF_R_TYPE                       ELF32_R_TYPE
#define ELF_R_SYM                        ELF32_R_SYM

#elif defined(EFI_TARGET64)
#include "../../UefiPayloadPkg/PayloadLoaderPeim/ElfLib/Elf64.h"

#define EFI_IMAGE_NT_HEADERS             EFI_IMAGE_NT_HEADERS64
#define EFI_IMAGE_NT_OPTIONAL_HDR_MAGIC  EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
#define EFI_IMAGE_FILE_MACHINE           0
#define ELFCLASS                         ELFCLASS64
#define Elf_Ehdr                         Elf64_Ehdr
#define Elf_Shdr                         Elf64_Shdr
#define Elf_Sym                          Elf64_Sym
#define Elf_Rel                          Elf64_Rel
#define Elf_Rela                         Elf64_Rela
#define Elf_Size                         Elf64_Size
#define Elf_Addr                         Elf64_Addr
#define ELF_R_TYPE                       ELF64_R_TYPE
#define ELF_R_SYM                        ELF64_R_SYM
#endif

#define ELF_HII_SECTION_NAME ".hii"
#define MAX_PE_ALIGNMENT     0x10000

#define raise() assert(false)

typedef struct {
  EFI_IMAGE_DEBUG_DIRECTORY_ENTRY     Dir;
  EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY Nb10;
  char                                Name[];
} DebugData;

#define PAGE(x)     ((x) & ~4095U)
#define PAGE_OFF(x) ((x) & 4095U)

typedef struct {
  uint64_t BaseAddress;
  uint32_t EntryPointAddress;
  uint16_t Machine;
  uint16_t Subsystem;
  bool     IsXip;
} image_tool_header_info_t;

typedef enum {
  ToolImageSectionTypeCode,
  ToolImageSectionTypeInitialisedData,
  ToolImageSectionTypeUninitialisedData
} image_tool_type_t;

typedef struct {
  char     *Name;
  uint8_t  *Data;
  uint32_t DataSize;
  uint64_t ImageAddress;
  uint32_t ImageSize;
  bool     Read;
  bool     Write;
  bool     Execute;
  image_tool_type_t Type;
} image_tool_segment_t;

typedef struct {
  uint32_t             SegmentAlignment;
  uint32_t             NumSegments;
  image_tool_segment_t *Segments;
} image_tool_segment_info_t;

typedef struct {
  uint8_t  Type;
  uint32_t Target;
} image_tool_reloc_t;

typedef struct {
  uint32_t           NumRelocs;
  bool               RelocsStripped;
  image_tool_reloc_t *Relocs;
} image_tool_reloc_info_t;

typedef struct {
  char     *SymbolsPath;
  uint32_t SymbolsPathLen;
} image_tool_debug_info_t;

typedef struct {
  uint32_t DebugDirAddress;
  uint32_t DebugDirSize;
} image_tool_pe_datadir_info_t;

typedef struct {
  void     *Data;
  uint32_t DataSize;
} image_tool_hii_info_t;

typedef struct {
  image_tool_header_info_t  HeaderInfo;
  image_tool_segment_info_t SegmentInfo;
  image_tool_reloc_info_t   RelocInfo;
  image_tool_hii_info_t     HiiInfo;
  image_tool_debug_info_t   DebugInfo;
} image_tool_image_info_t;

void
ToolImageDestruct (
  image_tool_image_info_t *Image
  );

bool
ImageConvertToXip (
  image_tool_image_info_t *Image
  );

void *
ToolImageEmitUe (
  const image_tool_image_info_t *Image,
  uint32_t                      *FileSize
  );

bool
ToolContextConstructPe (
  OUT image_tool_image_info_t *Image,
  IN  const void              *File,
  IN  size_t                  FileSize,
  IN  const char              *ModuleType OPTIONAL
  );

bool
CheckToolImage (
  image_tool_image_info_t *Image
  );

void *
ToolImageEmitPe (
  const image_tool_image_info_t *Image,
  uint32_t                      *FileSize
  );

RETURN_STATUS
ScanElf (
  IN const char *ElfName,
  IN const char *ModuleType
  );

RETURN_STATUS
ConstructHii (
  IN  const char *FileNames[],
  IN  UINT32     NumOfFiles,
  IN  GUID       *HiiGuid,
  OUT void       **Hii,
  OUT UINT32     *HiiSize,
  IN  BOOLEAN    IsElf
  );

#endif // IMAGE_TOOL_H