mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
5f2142819f
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.
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>
69 lines
1.7 KiB
C
69 lines
1.7 KiB
C
/** @file
|
|
PE/Coff Extra Action library instances, it will report image debug info.
|
|
|
|
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Base.h>
|
|
#include <Library/PeCoffExtraActionLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/IoLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
|
|
#include <ImageDebugSupport.h>
|
|
|
|
#define DEBUG_LOAD_IMAGE_METHOD_IO_HW_BREAKPOINT 1
|
|
#define DEBUG_LOAD_IMAGE_METHOD_SOFT_INT3 2
|
|
|
|
#define IO_HW_BREAKPOINT_VECTOR_NUM 1
|
|
#define SOFT_INT_VECTOR_NUM 3
|
|
|
|
extern UINTN AsmInterruptHandle;
|
|
|
|
/**
|
|
Read IDT entry to check if IDT entries are setup by Debug Agent.
|
|
|
|
@param[in] IdtDescriptor Pointer to IDT Descriptor.
|
|
@param[in] InterruptType Interrupt type.
|
|
|
|
@retval TRUE IDT entries were setup by Debug Agent.
|
|
@retval FALSE IDT entries were not setup by Debug Agent.
|
|
|
|
**/
|
|
BOOLEAN
|
|
CheckDebugAgentHandler (
|
|
IN IA32_DESCRIPTOR *IdtDescriptor,
|
|
IN UINTN InterruptType
|
|
);
|
|
|
|
/**
|
|
Save IDT entry for INT1 and update it.
|
|
|
|
@param[in] IdtDescriptor Pointer to IDT Descriptor.
|
|
@param[out] SavedIdtEntry Original IDT entry returned.
|
|
|
|
**/
|
|
VOID
|
|
SaveAndUpdateIdtEntry1 (
|
|
IN IA32_DESCRIPTOR *IdtDescriptor,
|
|
OUT IA32_IDT_GATE_DESCRIPTOR *SavedIdtEntry
|
|
);
|
|
|
|
/**
|
|
Restore IDT entry for INT1.
|
|
|
|
@param[in] IdtDescriptor Pointer to IDT Descriptor.
|
|
@param[in] RestoredIdtEntry IDT entry to be restored.
|
|
|
|
**/
|
|
VOID
|
|
RestoreIdtEntry1 (
|
|
IN IA32_DESCRIPTOR *IdtDescriptor,
|
|
IN IA32_IDT_GATE_DESCRIPTOR *RestoredIdtEntry
|
|
);
|