Upstream
/
CloverBootloader
mirror of https://github.com/CloverHackyColor/CloverBootloader.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
CloverBootloader/Library/OcAfterBootCompatLib/BootCompatInternal.h

527 lines
15 KiB
C
Raw Blame History

/** @file
Copyright (C) 2019, vit9696. All rights reserved.
All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef BOOT_COMPAT_INTERNAL_H
#define BOOT_COMPAT_INTERNAL_H
#include <Uefi.h>
#include <IndustryStandard/AppleBootArgs.h>
#include <Library/OcAfterBootCompatLib.h>
#include <Library/OcBootManagementLib.h>
#include <Library/OcDebugLogLib.h>
#include <Library/OcMemoryLib.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/OcFirmwareRuntime.h>
#if defined(MDE_CPU_X64)
#include "X64/ContextSwitch.h"
#elif defined(MDE_CPU_IA32)
#include <Ia32/ContextSwitch.h>
#else
#error "Unsupported architecture!"
#endif
//
// The kernel is normally allocated at base 0x100000 + slide address.
//
// For slide=0x1~0x7F the kernel is allocated from
// 0x100000 + 0x200000 till 0x100000 + 0xFE00000.
//
// For slide = 0x80~0xFF on Sandy Bridge or Ivy Bridge CPUs from
// 0x100000 + 0x20200000 till 0x100000? + 0x30000000??.
//
// For slide = 0x80~0xFF on Other CPUs from
// 0x100000 + 0x10000000 till 0x100000 + 0x1FE00000.
//
/**
Maximum number of supported runtime reloc protection areas.
Currently hardocded for simplicity.
**/
#define RT_RELOC_PROTECT_MAX_NUM ((UINTN) 64)
/**
Runtime descriptor number to virtualise.
Currently hardocded for simplicity.
**/
#define RT_DESC_ENTRY_NUM ((UINTN) 64)
/**
Kernel __HIB segment virtual address.
**/
#define KERNEL_HIB_VADDR ((UINTN) (0xFFFFFF8000100000ULL & MAX_UINTN))
/**
Kernel __TEXT segment virtual address.
**/
#define KERNEL_TEXT_VADDR ((UINTN) (0xFFFFFF8000200000ULL & MAX_UINTN))
/**
Kernel physical base address.
**/
#define KERNEL_BASE_PADDR (KERNEL_TEXT_VADDR - KERNEL_HIB_VADDR)
/**
Slide offset per slide entry
**/
#define SLIDE_GRANULARITY ((UINTN) SIZE_2MB)
/**
Total possible number of KASLR slide offsets.
**/
#define TOTAL_SLIDE_NUM ((UINTN) 0x100)
/**
Slide errate number to skip range from.
**/
#define SLIDE_ERRATA_NUM ((UINTN) 0x80)
/**
Sandy/Ivy skip slide range for Intel HD graphics.
**/
#define SLIDE_ERRATA_SKIP_RANGE ((UINTN) 0x10200000)
/**
Assume the kernel is roughly 128 MBs.
**/
#define ESTIMATED_KERNEL_SIZE ((UINTN) SIZE_128MB)
/**
Preserved relocation entry.
**/
typedef struct RT_RELOC_PROTECT_INFO_ {
///
/// Physical address of descriptor start.
///
EFI_PHYSICAL_ADDRESS PhysicalStart;
///
/// Physical address of descriptor end.
///
EFI_PHYSICAL_ADDRESS PhysicalEnd;
///
/// Descriptor original memory type.
///
EFI_MEMORY_TYPE Type;
} RT_RELOC_PROTECT_INFO;
/**
Preserved relocation entry list.
**/
typedef struct RT_RELOC_PROTECT_DATA_ {
///
/// Number of currently used methods in the table.
///
UINTN NumEntries;
///
/// Reloc entries fitted.
///
RT_RELOC_PROTECT_INFO RelocInfo[RT_RELOC_PROTECT_MAX_NUM];
} RT_RELOC_PROTECT_DATA;
/**
UEFI Boot & Runtime Services original pointers.
**/
typedef struct UEFI_SERVICES_POINTERS_ {
///
/// Original page allocator. We override it to obtain
/// the location macOS kernel and hibernation images.
///
EFI_ALLOCATE_PAGES AllocatePages;
///
/// Original page deallocator. We override it to fix memory
/// attributes table as it is updated after page dealloc.
///
EFI_FREE_PAGES FreePages;
///
/// Original memory map function. We override it to make
/// memory map shrinking and CSM region protection.
///
EFI_GET_MEMORY_MAP GetMemoryMap;
///
/// Original pool allocator. We override it to fix memory
/// attributes table as it is updated after pool alloc.
///
EFI_ALLOCATE_POOL AllocatePool;
///
/// Original pool deallocator. We override it to fix memory
/// attributes table as it is updated after pool dealloc.
///
EFI_FREE_POOL FreePool;
///
/// Original exit boot services function. We override it
/// to ensure we always succeed exiting boot services.
///
EFI_EXIT_BOOT_SERVICES ExitBootServices;
///
/// Image starting routine. We override to catch boot.efi
/// loading and enable the rest of functions.
///
EFI_IMAGE_START StartImage;
///
/// Original get variable function. We override it to alter
/// boot.efi boot arguments for custom KASLR slide.
///
EFI_GET_VARIABLE GetVariable;
///
/// Original virtual address mapping function. We override
/// it to perform runtime area protection to prevent boot.efi
/// defragmentation and setup virtual memory for firmwares
/// accessing it after exit boot services.
///
EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;
} UEFI_SERVICES_POINTERS;
/**
UEFI services override internal state.
**/
typedef struct SERVICES_OVERRIDE_STATE_ {
///
/// GetVariable arrival event.
///
EFI_EVENT GetVariableEvent;
///
/// Firmware runtime protocol instance.
///
OC_FIRMWARE_RUNTIME_PROTOCOL *FwRuntime;
///
/// Minimum address allocated by AlocatePages.
///
EFI_PHYSICAL_ADDRESS MinAllocatedAddr;
///
/// Apple hibernate image address allocated by AlocatePages.
///
EFI_PHYSICAL_ADDRESS HibernateImageAddress;
///
/// Last descriptor size obtained from GetMemoryMap.
///
UINTN MemoryMapDescriptorSize;
///
/// Amount of nested boot.efi detected.
///
UINTN AppleBootNestedCount;
///
/// TRUE if we are doing boot.efi hibernate wake.
///
BOOLEAN AppleHibernateWake;
///
/// TRUE if we are using custom KASLR slide (via boot arg).
///
BOOLEAN AppleCustomSlide;
///
/// TRUE if we are done reporting MMIO cleanup.
///
BOOLEAN ReportedMmio;
///
/// TRUE if we are waiting for performance memory allocation.
///
BOOLEAN AwaitingPerfAlloc;
} SERVICES_OVERRIDE_STATE;
/**
Apple kernel support internal state..
**/
typedef struct KERNEL_SUPPORT_STATE_ {
///
/// Assembly support internal state.
///
ASM_SUPPORT_STATE AsmState;
///
/// Kernel jump trampoline.
///
ASM_KERNEL_JUMP KernelJump;
///
/// Original kernel memory.
///
UINT8 KernelOrg[sizeof (ASM_KERNEL_JUMP)];
///
/// Custom kernel UEFI System Table.
///
EFI_PHYSICAL_ADDRESS SysTableRtArea;
///
/// Custom kernel UEFI System Table size in bytes.
///
UINTN SysTableRtAreaSize;
///
/// Physical configuration table location.
///
EFI_CONFIGURATION_TABLE *ConfigurationTable;
///
/// Virtual memory mapper context.
///
OC_VMEM_CONTEXT VmContext;
///
/// Virtual memory map containing partial memory map with runtime areas only.
/// Actual number of entries may be less than RT_DESC_ENTRY_NUM due to DescriptorSize
/// being potentially bigger than sizeof (EFI_MEMORY_DESCRIPTOR).
///
EFI_MEMORY_DESCRIPTOR VmMap[RT_DESC_ENTRY_NUM];
///
/// Virtual memory map size in bytes.
///
UINTN VmMapSize;
///
/// Virtual memory map descriptor size in bytes.
///
UINTN VmMapDescSize;
} KERNEL_SUPPORT_STATE;
/**
Apple booter KASLR slide support internal state.
**/
typedef struct SLIDE_SUPPORT_STATE_ {
///
/// Memory map analysis status determining slide usage.
///
BOOLEAN HasMemoryMapAnalysis;
///
/// TRUE if we are running on Intel Sandy or Ivy bridge.
///
BOOLEAN HasSandyOrIvy;
///
/// TRUE if CsrActiveConfig was set.
///
BOOLEAN HasCsrActiveConfig;
///
/// TRUE if BootArgs was set.
///
BOOLEAN HasBootArgs;
///
/// Read or assumed csr-arctive-config variable value.
///
UINT32 CsrActiveConfig;
///
/// Max slide value provided.
///
UINT8 ProvideMaxSlide;
///
/// Valid slides to choose from when using custom slide.
///
UINT8 ValidSlides[TOTAL_SLIDE_NUM];
///
/// Number of entries in ValidSlides.
///
UINT32 ValidSlideCount;
///
/// Apple kernel boot arguments read from boot-args variable and then
/// modified with an additional slide parameter in case custom slide is used.
///
CHAR8 BootArgs[BOOT_LINE_LENGTH];
///
/// BootArgs data size.
///
UINTN BootArgsSize;
///
/// Estimated size for kernel itself, device tree, memory map, and rt pages.
///
UINTN EstimatedKernelArea;
} SLIDE_SUPPORT_STATE;
/**
Apple Boot Compatibility context.
**/
typedef struct BOOT_COMPAT_CONTEXT_ {
///
/// Apple Coot Compatibility settings.
///
OC_ABC_SETTINGS Settings;
///
/// Runtime relocations.
///
RT_RELOC_PROTECT_DATA RtReloc;
///
/// UEFI Boot & Runtime Services original pointers.
///
UEFI_SERVICES_POINTERS ServicePtrs;
///
/// UEFI services override internal state.
///
SERVICES_OVERRIDE_STATE ServiceState;
///
/// Apple kernel support internal state.
///
KERNEL_SUPPORT_STATE KernelState;
///
/// Apple booter KASLR slide support internal state.
///
SLIDE_SUPPORT_STATE SlideSupport;
} BOOT_COMPAT_CONTEXT;
/**
Obtain Apple Boot Compatibility context. This function must only
be called from wrapped services, where passing context arguments
is not possible.
@retval Apple Boot Compatibility context (not null).
**/
BOOT_COMPAT_CONTEXT *
GetBootCompatContext (
VOID
);
/**
Install UEFI services overrides as necessary.
@param[in,out] BootCompat Boot compatibility context.
**/
VOID
InstallServiceOverrides (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat
);
/**
Prepare virtual memory management environment for later usage.
@param[in,out] BootCompat Boot compatibility context.
**/
VOID
AppleMapPrepareMemoryPool (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat
);
/**
Prepare environment for Apple UEFI bootloader. See more details inside.
@param[in,out] BootCompat Boot compatibility context.
@param[in,out] LoadedImage UEFI loaded image protocol instance.
@param[in] GetMemoryMap Unmodified GetMemoryMap pointer, optional.
**/
VOID
AppleMapPrepareBooterState (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat,
IN OUT EFI_LOADED_IMAGE *LoadedImage,
IN EFI_GET_MEMORY_MAP GetMemoryMap OPTIONAL
);
/**
Save UEFI environment state in implementation specific way.
@param[in,out] AsmState Assembly state to update, can be preserved.
@param[out] KernelJump Kernel jump trampoline to fill.
**/
VOID
AppleMapPlatformSaveState (
IN OUT ASM_SUPPORT_STATE *AsmState,
OUT ASM_KERNEL_JUMP *KernelJump
);
/**
Patch kernel entry point with KernelJump to later land in AppleMapPrepareKernelState.
@param[in,out] BootCompat Boot compatibility context.
@param[in] ImageAddress Kernel or hibernation image address.
@param[in] AppleHibernateWake TRUE when ImageAddress points to hibernation image.
**/
VOID
AppleMapPrepareKernelJump (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat,
IN UINTN ImageAddress,
IN BOOLEAN AppleHibernateWake
);
/**
Prepare memory state and perform virtual address translation.
@param[in,out] BootCompat Boot compatibility context.
@param[in] MemoryMapSize SetVirtualAddresses memory map size argument.
@param[in] DescriptorSize SetVirtualAddresses descriptor size argument.
@param[in] DescriptorVersion SetVirtualAddresses descriptor version argument.
@param[in] MemoryMap SetVirtualAddresses memory map argument.
**/
EFI_STATUS
AppleMapPrepareMemState (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat,
IN UINTN MemoryMapSize,
IN UINTN DescriptorSize,
IN UINT32 DescriptorVersion,
IN EFI_MEMORY_DESCRIPTOR *MemoryMap
);
/**
Prepare environment for Apple kernel bootloader in boot or wake cases.
This callback arrives when boot.efi jumps to kernel.
@param[in] Args Case-specific kernel argument handle.
@param[in] ModeX64 Debug flag about kernel context type, TRUE when X64.
@retval Args must be returned with the necessary modifications if any.
**/
UINTN
EFIAPI
AppleMapPrepareKernelState (
IN UINTN Args,
IN BOOLEAN ModeX64
);
/**
Patch boot.efi to support random and passed slide values in safe mode.
@param[in,out] ImageBase Apple booter image base.
@param[in] ImageSize Apple booter image size.
**/
VOID
AppleSlideUnlockForSafeMode (
IN OUT UINT8 *ImageBase,
IN UINTN ImageSize
);
/**
Primary custom KASLR support handler. This gets called on every
UEFI RuntimeServices GetVariable call and thus is useful to
perform KASLR slide injection through boot-args.
@param[in,out] BootCompat Boot compatibility context.
@param[in] GetVariable Original UEFI GetVariable service.
@param[in] GetMemoryMap Unmodified GetMemoryMap pointer, optional.
@param[in] FilterMap GetMemoryMap result filter, optional.
@param[in] FilterMapContext FilterMap context, optional.
@param[in] VariableName GetVariable variable name argument.
@param[in] VendorGuid GetVariable vendor GUID argument.
@param[out] Attributes GetVariable attributes argument.
@param[in,out] DataSize GetVariable data size argument.
@param[out] Data GetVariable data argument.
@retval GetVariable status code.
**/
EFI_STATUS
AppleSlideGetVariable (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat,
IN EFI_GET_VARIABLE GetVariable,
IN EFI_GET_MEMORY_MAP GetMemoryMap OPTIONAL,
IN OC_MEMORY_FILTER FilterMap OPTIONAL,
IN VOID *FilterMapContext OPTIONAL,
IN CHAR16 *VariableName,
IN EFI_GUID *VendorGuid,
OUT UINT32 *Attributes OPTIONAL,
IN OUT UINTN *DataSize,
OUT VOID *Data
);
/**
Ensures that the original csr-active-config is passed to the kernel,
and removes customised slide value for security reasons.
@param[in,out] BootCompat Boot compatibility context.
@param[in,out] BootArgs Apple kernel boot arguments.
**/
VOID
AppleSlideRestore (
IN OUT BOOT_COMPAT_CONTEXT *BootCompat,
IN OUT OC_BOOT_ARGUMENTS *BootArgs
);
#endif // BOOT_COMPAT_INTERNAL_H
Reference in New Issue View Git Blame Copy Permalink