mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
8472271dae
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>
120 lines
3.1 KiB
C
120 lines
3.1 KiB
C
/** @file
|
|
Tools of clarify the content of the smbios table.
|
|
|
|
Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define STRUCTURE_TYPE_RANDOM (UINT8) 0xFE
|
|
#define STRUCTURE_TYPE_INVALID (UINT8) 0xFF
|
|
|
|
typedef struct {
|
|
UINT16 Index;
|
|
UINT8 Type;
|
|
UINT16 Handle;
|
|
UINT16 Addr; // offset from table head
|
|
UINT16 Length; // total structure length
|
|
} STRUCTURE_STATISTICS;
|
|
|
|
/**
|
|
Query all structures Data from SMBIOS table and Display
|
|
the information to users as required display option.
|
|
|
|
@param[in] QueryType Structure type to view.
|
|
@param[in] QueryHandle Structure handle to view.
|
|
@param[in] Option Display option: none,outline,normal,detail.
|
|
@param[in] RandomView Support for -h parameter.
|
|
|
|
@retval EFI_SUCCESS print is successful.
|
|
@retval EFI_BAD_BUFFER_SIZE structure is out of the range of SMBIOS table.
|
|
**/
|
|
EFI_STATUS
|
|
SMBiosView (
|
|
IN UINT8 QueryType,
|
|
IN UINT16 QueryHandle,
|
|
IN UINT8 Option,
|
|
IN BOOLEAN RandomView
|
|
);
|
|
|
|
/**
|
|
Query all structures Data from SMBIOS table and Display
|
|
the information to users as required display option.
|
|
|
|
@param[in] QueryType Structure type to view.
|
|
@param[in] QueryHandle Structure handle to view.
|
|
@param[in] Option Display option: none,outline,normal,detail.
|
|
@param[in] RandomView Support for -h parameter.
|
|
|
|
@retval EFI_SUCCESS print is successful.
|
|
@retval EFI_BAD_BUFFER_SIZE structure is out of the range of SMBIOS table.
|
|
**/
|
|
EFI_STATUS
|
|
SMBios64View (
|
|
IN UINT8 QueryType,
|
|
IN UINT16 QueryHandle,
|
|
IN UINT8 Option,
|
|
IN BOOLEAN RandomView
|
|
);
|
|
|
|
/**
|
|
Function to initialize the global mStatisticsTable object.
|
|
|
|
@retval EFI_SUCCESS print is successful.
|
|
**/
|
|
EFI_STATUS
|
|
InitSmbiosTableStatistics (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Function to initialize the global mSmbios64BitStatisticsTable object.
|
|
|
|
@retval EFI_SUCCESS print is successful.
|
|
**/
|
|
EFI_STATUS
|
|
InitSmbios64BitTableStatistics (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Function to display the global mStatisticsTable object.
|
|
|
|
@param[in] Option ECHO, NORMAL, or DETAIL control the amount of detail displayed.
|
|
|
|
@retval EFI_SUCCESS print is successful.
|
|
**/
|
|
EFI_STATUS
|
|
DisplayStatisticsTable (
|
|
IN UINT8 Option
|
|
);
|
|
|
|
/**
|
|
Function to display the global mSmbios64BitStatisticsTable object.
|
|
|
|
@param[in] Option ECHO, NORMAL, or DETAIL control the amount of detail displayed.
|
|
|
|
@retval EFI_SUCCESS print is successful.
|
|
**/
|
|
EFI_STATUS
|
|
DisplaySmbios64BitStatisticsTable (
|
|
IN UINT8 Option
|
|
);
|
|
|
|
/**
|
|
function to return a string of the detail level.
|
|
|
|
@param[in] ShowType The detail level whose name is desired in clear text.
|
|
|
|
@return A pointer to a string representing the ShowType (or 'undefined type' if not known).
|
|
**/
|
|
CHAR16 *
|
|
GetShowTypeString (
|
|
UINT8 ShowType
|
|
);
|
|
|
|
extern UINT8 gShowType;
|
|
|
|
extern UINTN mSmbios64BitTableLength;
|