Namespace: go.std.debug.pe

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the debug/pe package.

Package pe implements access to PE (Microsoft Windows Portable Executable) files.

Index

• *COFFSymbol
• *DataDirectory
• *File
• *FileHeader
• *FormatError
• *ImportDirectory
• *OptionalHeader32
• *OptionalHeader64
• *Reloc
• *Section
• *SectionHeader
• *SectionHeader32
• *StringTable
• *Symbol
• COFFSymbol
• COFFSymbolSize
• DataDirectory
• File
• FileHeader
• FormatError
• IMAGE_DIRECTORY_ENTRY_ARCHITECTURE
• IMAGE_DIRECTORY_ENTRY_BASERELOC
• IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT
• IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR
• IMAGE_DIRECTORY_ENTRY_DEBUG
• IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT
• IMAGE_DIRECTORY_ENTRY_EXCEPTION
• IMAGE_DIRECTORY_ENTRY_EXPORT
• IMAGE_DIRECTORY_ENTRY_GLOBALPTR
• IMAGE_DIRECTORY_ENTRY_IAT
• IMAGE_DIRECTORY_ENTRY_IMPORT
• IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG
• IMAGE_DIRECTORY_ENTRY_RESOURCE
• IMAGE_DIRECTORY_ENTRY_SECURITY
• IMAGE_DIRECTORY_ENTRY_TLS
• IMAGE_DLLCHARACTERISTICS_APPCONTAINER
• IMAGE_DLLCHARACTERISTICS_DYNAMIC_BASE
• IMAGE_DLLCHARACTERISTICS_FORCE_INTEGRITY
• IMAGE_DLLCHARACTERISTICS_GUARD_CF
• IMAGE_DLLCHARACTERISTICS_HIGH_ENTROPY_VA
• IMAGE_DLLCHARACTERISTICS_NO_BIND
• IMAGE_DLLCHARACTERISTICS_NO_ISOLATION
• IMAGE_DLLCHARACTERISTICS_NO_SEH
• IMAGE_DLLCHARACTERISTICS_NX_COMPAT
• IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE
• IMAGE_DLLCHARACTERISTICS_WDM_DRIVER
• IMAGE_FILE_32BIT_MACHINE
• IMAGE_FILE_AGGRESIVE_WS_TRIM
• IMAGE_FILE_BYTES_REVERSED_HI
• IMAGE_FILE_BYTES_REVERSED_LO
• IMAGE_FILE_DEBUG_STRIPPED
• IMAGE_FILE_DLL
• IMAGE_FILE_EXECUTABLE_IMAGE
• IMAGE_FILE_LARGE_ADDRESS_AWARE
• IMAGE_FILE_LINE_NUMS_STRIPPED
• IMAGE_FILE_LOCAL_SYMS_STRIPPED
• IMAGE_FILE_MACHINE_AM33
• IMAGE_FILE_MACHINE_AMD64
• IMAGE_FILE_MACHINE_ARM
• IMAGE_FILE_MACHINE_ARM64
• IMAGE_FILE_MACHINE_ARMNT
• IMAGE_FILE_MACHINE_EBC
• IMAGE_FILE_MACHINE_I386
• IMAGE_FILE_MACHINE_IA64
• IMAGE_FILE_MACHINE_M32R
• IMAGE_FILE_MACHINE_MIPS16
• IMAGE_FILE_MACHINE_MIPSFPU
• IMAGE_FILE_MACHINE_MIPSFPU16
• IMAGE_FILE_MACHINE_POWERPC
• IMAGE_FILE_MACHINE_POWERPCFP
• IMAGE_FILE_MACHINE_R4000
• IMAGE_FILE_MACHINE_SH3
• IMAGE_FILE_MACHINE_SH3DSP
• IMAGE_FILE_MACHINE_SH4
• IMAGE_FILE_MACHINE_SH5
• IMAGE_FILE_MACHINE_THUMB
• IMAGE_FILE_MACHINE_UNKNOWN
• IMAGE_FILE_MACHINE_WCEMIPSV2
• IMAGE_FILE_NET_RUN_FROM_SWAP
• IMAGE_FILE_RELOCS_STRIPPED
• IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP
• IMAGE_FILE_SYSTEM
• IMAGE_FILE_UP_SYSTEM_ONLY
• IMAGE_SUBSYSTEM_EFI_APPLICATION
• IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
• IMAGE_SUBSYSTEM_EFI_ROM
• IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
• IMAGE_SUBSYSTEM_NATIVE
• IMAGE_SUBSYSTEM_NATIVE_WINDOWS
• IMAGE_SUBSYSTEM_OS2_CUI
• IMAGE_SUBSYSTEM_POSIX_CUI
• IMAGE_SUBSYSTEM_UNKNOWN
• IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION
• IMAGE_SUBSYSTEM_WINDOWS_CE_GUI
• IMAGE_SUBSYSTEM_WINDOWS_CUI
• IMAGE_SUBSYSTEM_WINDOWS_GUI
• IMAGE_SUBSYSTEM_XBOX
• ImportDirectory
• NewFile
• Open
• OptionalHeader32
• OptionalHeader64
• Reloc
• Section
• SectionHeader
• SectionHeader32
• StringTable
• Symbol
• arrayOfCOFFSymbol
• arrayOfDataDirectory
• arrayOfFile
• arrayOfFileHeader
• arrayOfFormatError
• arrayOfImportDirectory
• arrayOfOptionalHeader32
• arrayOfOptionalHeader64
• arrayOfReloc
• arrayOfSection
• arrayOfSectionHeader
• arrayOfSectionHeader32
• arrayOfStringTable
• arrayOfSymbol

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

• COFFSymbolSize

  Int v1.0

• IMAGE_DIRECTORY_ENTRY_ARCHITECTURE

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_BASERELOC

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_DEBUG

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_EXCEPTION

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_EXPORT

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_GLOBALPTR

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_IAT

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_IMPORT

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_RESOURCE

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_SECURITY

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DIRECTORY_ENTRY_TLS

  Int v1.0

  IMAGE_DIRECTORY_ENTRY constants
  

• IMAGE_DLLCHARACTERISTICS_APPCONTAINER

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_DYNAMIC_BASE

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_FORCE_INTEGRITY

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_GUARD_CF

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_HIGH_ENTROPY_VA

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_NO_BIND

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_NO_ISOLATION

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_NO_SEH

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_NX_COMPAT

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_DLLCHARACTERISTICS_WDM_DRIVER

  Int v1.0

  OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
  values. These can be combined together.
  

• IMAGE_FILE_32BIT_MACHINE

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_AGGRESIVE_WS_TRIM

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_BYTES_REVERSED_HI

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_BYTES_REVERSED_LO

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_DEBUG_STRIPPED

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_DLL

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_EXECUTABLE_IMAGE

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_LARGE_ADDRESS_AWARE

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_LINE_NUMS_STRIPPED

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_LOCAL_SYMS_STRIPPED

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_MACHINE_AM33

  Int v1.0

• IMAGE_FILE_MACHINE_AMD64

  Int v1.0

• IMAGE_FILE_MACHINE_ARM

  Int v1.0

• IMAGE_FILE_MACHINE_ARM64

  Int v1.0

• IMAGE_FILE_MACHINE_ARMNT

  Int v1.0

• IMAGE_FILE_MACHINE_EBC

  Int v1.0

• IMAGE_FILE_MACHINE_I386

  Int v1.0

• IMAGE_FILE_MACHINE_IA64

  Int v1.0

• IMAGE_FILE_MACHINE_M32R

  Int v1.0

• IMAGE_FILE_MACHINE_MIPS16

  Int v1.0

• IMAGE_FILE_MACHINE_MIPSFPU

  Int v1.0

• IMAGE_FILE_MACHINE_MIPSFPU16

  Int v1.0

• IMAGE_FILE_MACHINE_POWERPC

  Int v1.0

• IMAGE_FILE_MACHINE_POWERPCFP

  Int v1.0

• IMAGE_FILE_MACHINE_R4000

  Int v1.0

• IMAGE_FILE_MACHINE_SH3

  Int v1.0

• IMAGE_FILE_MACHINE_SH3DSP

  Int v1.0

• IMAGE_FILE_MACHINE_SH4

  Int v1.0

• IMAGE_FILE_MACHINE_SH5

  Int v1.0

• IMAGE_FILE_MACHINE_THUMB

  Int v1.0

• IMAGE_FILE_MACHINE_UNKNOWN

  Int v1.0

• IMAGE_FILE_MACHINE_WCEMIPSV2

  Int v1.0

• IMAGE_FILE_NET_RUN_FROM_SWAP

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_RELOCS_STRIPPED

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_SYSTEM

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_FILE_UP_SYSTEM_ONLY

  Int v1.0

  Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.
  

• IMAGE_SUBSYSTEM_EFI_APPLICATION

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_EFI_ROM

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_NATIVE

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_NATIVE_WINDOWS

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_OS2_CUI

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_POSIX_CUI

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_UNKNOWN

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_WINDOWS_CE_GUI

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_WINDOWS_CUI

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_WINDOWS_GUI

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

• IMAGE_SUBSYSTEM_XBOX

  Int v1.0

  OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.
  

Variables

(None.)

Functions, Macros, and Special Forms

• NewFile

  Function v1.0

  (NewFile r)
  

  NewFile creates a new File for accessing a PE binary in an underlying reader.
  
  Go input arguments: (r io.ReaderAt)
  
  Go returns: (*File, error)
  
  Joker input arguments: [^go.std.io/ReaderAt r]
  
  Joker returns: [^*File, ^Error]

• Open

  Function v1.0

  (Open name)
  

  Open opens the named file using os.Open and prepares it for use as a PE binary.
  
  Go input arguments: (name string)
  
  Go returns: (*File, error)
  
  Joker input arguments: [^String name]
  
  Joker returns: [^*File, ^Error]

Types

• *COFFSymbol

  Concrete Type v1.0

  COFFSymbol represents single COFF symbol table record.
  

• FullName

  Receiver for *COFFSymbol v1.0

  ([st])
  

  FullName finds real name of symbol sym. Normally name is stored
  in sym.Name, but if it is longer then 8 characters, it is stored
  in COFF string table st instead.
  

• *DataDirectory

  Concrete Type v1.0

• *File

  Concrete Type v1.0

  A File represents an open PE file.
  

• Close

  Receiver for *File v1.0

  ([])
  

  Close closes the File.
  If the File was created using NewFile directly instead of Open,
  Close has no effect.
  

• DWARF

  Receiver for *File v1.0

  ([])
  

• ImportedLibraries

  Receiver for *File v1.0

  ([])
  

  ImportedLibraries returns the names of all libraries
  referred to by the binary f that are expected to be
  linked with the binary at dynamic link time.
  

• ImportedSymbols

  Receiver for *File v1.0

  ([])
  

  ImportedSymbols returns the names of all symbols
  referred to by the binary f that are expected to be
  satisfied by other libraries at dynamic load time.
  It does not return weak symbols.
  

• Section

  Receiver for *File v1.0

  ([name])
  

  Section returns the first section with the given name, or nil if no such
  section exists.
  

• *FileHeader

  Concrete Type v1.0

• *FormatError

  Concrete Type v1.0

  FormatError is unused.
  The type is retained for compatibility.
  

• Error

  Receiver for *FormatError v1.0

  ([])
  

• *ImportDirectory

  Concrete Type v1.0

• *OptionalHeader32

  Concrete Type v1.0

• *OptionalHeader64

  Concrete Type v1.0

• *Reloc

  Concrete Type v1.0

  Reloc represents a PE COFF relocation.
  Each section contains its own relocation list.
  

• *Section

  Concrete Type v1.0

  Section provides access to PE COFF section.
  

• Data

  Receiver for *Section v1.0

  ([])
  

  Data reads and returns the contents of the PE section s.
  

• Open

  Receiver for *Section v1.0

  ([])
  

  Open returns a new ReadSeeker reading the PE section s.
  

• *SectionHeader

  Concrete Type v1.0

  SectionHeader is similar to SectionHeader32 with Name
  field replaced by Go string.
  

• *SectionHeader32

  Concrete Type v1.0

  SectionHeader32 represents real PE COFF section header.
  

• *StringTable

  Concrete Type v1.0

  StringTable is a COFF string table.
  

• *Symbol

  Concrete Type v1.0

  Symbol is similar to COFFSymbol with Name field replaced
  by Go string. Symbol also does not have NumberOfAuxSymbols.
  

• COFFSymbol

  Concrete Type v1.0

  COFFSymbol represents single COFF symbol table record.
  

• DataDirectory

  Concrete Type v1.0

• File

  Concrete Type v1.0

  A File represents an open PE file.
  

• FileHeader

  Concrete Type v1.0

• FormatError

  Concrete Type v1.0

  FormatError is unused.
  The type is retained for compatibility.
  

• ImportDirectory

  Concrete Type v1.0

• OptionalHeader32

  Concrete Type v1.0

• OptionalHeader64

  Concrete Type v1.0

• Reloc

  Concrete Type v1.0

  Reloc represents a PE COFF relocation.
  Each section contains its own relocation list.
  

• Section

  Concrete Type v1.0

  Section provides access to PE COFF section.
  

• SectionHeader

  Concrete Type v1.0

  SectionHeader is similar to SectionHeader32 with Name
  field replaced by Go string.
  

• SectionHeader32

  Concrete Type v1.0

  SectionHeader32 represents real PE COFF section header.
  

• StringTable

  Concrete Type v1.0

  StringTable is a COFF string table.
  

• String

  Receiver for StringTable v1.0

  ([start])
  

  String extracts string from COFF string table st at offset start.
  

• Symbol

  Concrete Type v1.0

  Symbol is similar to COFFSymbol with Name field replaced
  by Go string. Symbol also does not have NumberOfAuxSymbols.
  

• arrayOfCOFFSymbol

  Concrete Type v1.0

  COFFSymbol represents single COFF symbol table record.
  

• arrayOfDataDirectory

  Concrete Type v1.0

• arrayOfFile

  Concrete Type v1.0

  A File represents an open PE file.
  

• arrayOfFileHeader

  Concrete Type v1.0

• arrayOfFormatError

  Concrete Type v1.0

  FormatError is unused.
  The type is retained for compatibility.
  

• arrayOfImportDirectory

  Concrete Type v1.0

• arrayOfOptionalHeader32

  Concrete Type v1.0

• arrayOfOptionalHeader64

  Concrete Type v1.0

• arrayOfReloc

  Concrete Type v1.0

  Reloc represents a PE COFF relocation.
  Each section contains its own relocation list.
  

• arrayOfSection

  Concrete Type v1.0

  Section provides access to PE COFF section.
  

• arrayOfSectionHeader

  Concrete Type v1.0

  SectionHeader is similar to SectionHeader32 with Name
  field replaced by Go string.
  

• arrayOfSectionHeader32

  Concrete Type v1.0

  SectionHeader32 represents real PE COFF section header.
  

• arrayOfStringTable

  Concrete Type v1.0

  StringTable is a COFF string table.
  

• arrayOfSymbol

  Concrete Type v1.0

  Symbol is similar to COFFSymbol with Name field replaced
  by Go string. Symbol also does not have NumberOfAuxSymbols.