mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
a536e5d699
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Note: Headers taken directly from external projects, such as those
in OvmfPkg/Include/IndustryStandard/Xen/ were not modified since they
may be periodically re-synced and do not follow other edk2 coding
stadards.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
191 lines
4.9 KiB
C
191 lines
4.9 KiB
C
/** @file
|
|
Load/boot UEFI Linux.
|
|
|
|
Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
Verifies that the kernel setup image is valid and supported.
|
|
The kernel setup image should be checked before using other library
|
|
routines which take the kernel setup as an input.
|
|
|
|
@param[in] KernelSetup - The kernel setup image
|
|
@param[in] KernelSetupSize - The kernel setup size
|
|
|
|
@retval EFI_SUCCESS - The Linux kernel setup is valid and supported
|
|
@retval EFI_INVALID_PARAMETER - KernelSetup was NULL
|
|
@retval EFI_UNSUPPORTED - The Linux kernel is not supported
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
LoadLinuxCheckKernelSetup (
|
|
IN VOID *KernelSetup,
|
|
IN UINTN KernelSetupSize
|
|
);
|
|
|
|
/**
|
|
Gets the initial runtime size of the Linux kernel image by examining
|
|
the kernel setup image.
|
|
|
|
@param[in] KernelSetup - The kernel setup image
|
|
@param[in] KernelSize - The kernel size on disk.
|
|
|
|
@retval 0 An error occurred
|
|
@retval !0 The initial size required by the kernel to
|
|
begin execution.
|
|
|
|
**/
|
|
UINTN
|
|
EFIAPI
|
|
LoadLinuxGetKernelSize (
|
|
IN VOID *KernelSetup,
|
|
IN UINTN KernelSize
|
|
);
|
|
|
|
/**
|
|
Loads and boots UEFI Linux.
|
|
|
|
Note: If successful, then this routine will not return
|
|
|
|
@param[in] Kernel - The main kernel image
|
|
@param[in,out] KernelSetup - The kernel setup image
|
|
|
|
@retval EFI_NOT_FOUND - The Linux kernel was not found
|
|
@retval EFI_INVALID_PARAMETER - Kernel or KernelSetup was NULL
|
|
@retval EFI_UNSUPPORTED - The Linux kernel version is not supported
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
LoadLinux (
|
|
IN VOID *Kernel,
|
|
IN OUT VOID *KernelSetup
|
|
);
|
|
|
|
/**
|
|
Allocates pages for the kernel setup image.
|
|
|
|
@param[in] Pages - The number of pages
|
|
|
|
@retval NULL - Unable to allocate pages
|
|
@retval !NULL - The address of the pages allocated
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
LoadLinuxAllocateKernelSetupPages (
|
|
IN UINTN Pages
|
|
);
|
|
|
|
/**
|
|
Clears the uninitialised space before and after the struct setup_header
|
|
in the kernel setup image. The kernel requires that these be zeroed
|
|
unless explicitly initialised, so this function should be called after
|
|
the setup_header has been copied in from a bzImage, before setting up
|
|
anything else.
|
|
|
|
@param[in] KernelSetup - The kernel setup image
|
|
|
|
@retval EFI_SUCCESS - The Linux kernel setup was successfully initialized
|
|
@retval EFI_INVALID_PARAMETER - KernelSetup was NULL
|
|
@retval EFI_UNSUPPORTED - The Linux kernel is not supported
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
LoadLinuxInitializeKernelSetup (
|
|
IN VOID *KernelSetup
|
|
);
|
|
|
|
/**
|
|
Allocates pages for the kernel.
|
|
|
|
@param[in] KernelSetup - The kernel setup image
|
|
@param[in] Pages - The number of pages. (It is recommended to use the
|
|
size returned from LoadLinuxGetKernelSize.)
|
|
|
|
@retval NULL - Unable to allocate pages
|
|
@retval !NULL - The address of the pages allocated
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
LoadLinuxAllocateKernelPages (
|
|
IN VOID *KernelSetup,
|
|
IN UINTN Pages
|
|
);
|
|
|
|
/**
|
|
Allocates pages for the kernel command line.
|
|
|
|
@param[in] Pages - The number of pages.
|
|
|
|
@retval NULL - Unable to allocate pages
|
|
@retval !NULL - The address of the pages allocated
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
LoadLinuxAllocateCommandLinePages (
|
|
IN UINTN Pages
|
|
);
|
|
|
|
/**
|
|
Allocates pages for the initrd image.
|
|
|
|
@param[in,out] KernelSetup - The kernel setup image
|
|
@param[in] Pages - The number of pages.
|
|
|
|
@retval NULL - Unable to allocate pages
|
|
@retval !NULL - The address of the pages allocated
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
LoadLinuxAllocateInitrdPages (
|
|
IN VOID *KernelSetup,
|
|
IN UINTN Pages
|
|
);
|
|
|
|
/**
|
|
Sets the kernel command line parameter within the setup image.
|
|
|
|
@param[in,out] KernelSetup - The kernel setup image
|
|
@param[in] CommandLine - The kernel command line
|
|
|
|
@retval EFI_SUCCESS - The Linux kernel setup is valid and supported
|
|
@retval EFI_INVALID_PARAMETER - KernelSetup was NULL
|
|
@retval EFI_UNSUPPORTED - The Linux kernel is not supported
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
LoadLinuxSetCommandLine (
|
|
IN OUT VOID *KernelSetup,
|
|
IN CHAR8 *CommandLine
|
|
);
|
|
|
|
/**
|
|
Sets the kernel initial ram disk pointer within the setup image.
|
|
|
|
@param[in,out] KernelSetup - The kernel setup image
|
|
@param[in] Initrd - Pointer to the initial ram disk
|
|
@param[in] InitrdSize - The initial ram disk image size
|
|
|
|
@retval EFI_SUCCESS - The Linux kernel setup is valid and supported
|
|
@retval EFI_INVALID_PARAMETER - KernelSetup was NULL
|
|
@retval EFI_UNSUPPORTED - The Linux kernel is not supported
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
LoadLinuxSetInitrd (
|
|
IN OUT VOID *KernelSetup,
|
|
IN VOID *Initrd,
|
|
IN UINTN InitrdSize
|
|
);
|