You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08: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>
28 lines
885 B
C
28 lines
885 B
C
/** @file
|
|
Exception definitions.
|
|
|
|
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define DEBUG_EXCEPT_DIVIDE_ERROR 0
|
|
#define DEBUG_EXCEPT_DEBUG 1
|
|
#define DEBUG_EXCEPT_NMI 2
|
|
#define DEBUG_EXCEPT_BREAKPOINT 3
|
|
#define DEBUG_EXCEPT_OVERFLOW 4
|
|
#define DEBUG_EXCEPT_BOUND 5
|
|
#define DEBUG_EXCEPT_INVALID_OPCODE 6
|
|
#define DEBUG_EXCEPT_DOUBLE_FAULT 8
|
|
#define DEBUG_EXCEPT_INVALID_TSS 10
|
|
#define DEBUG_EXCEPT_SEG_NOT_PRESENT 11
|
|
#define DEBUG_EXCEPT_STACK_FAULT 12
|
|
#define DEBUG_EXCEPT_GP_FAULT 13
|
|
#define DEBUG_EXCEPT_PAGE_FAULT 14
|
|
#define DEBUG_EXCEPT_FP_ERROR 16
|
|
#define DEBUG_EXCEPT_ALIGNMENT_CHECK 17
|
|
#define DEBUG_EXCEPT_MACHINE_CHECK 18
|
|
#define DEBUG_EXCEPT_SIMD 19
|