You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
e679741305
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
2.2 KiB
C
69 lines
2.2 KiB
C
/*++ @file
|
|
Produce Simple File System abstractions for a directory on your PC using Unix APIs.
|
|
The configuration of what devices to mount or emulate comes from
|
|
environment variables.
|
|
|
|
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
|
|
Portions copyright (c) 2011, Apple Inc. All rights reserved.
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include "PiDxe.h"
|
|
|
|
#include <Guid/FileSystemInfo.h>
|
|
#include <Guid/FileInfo.h>
|
|
#include <Guid/FileSystemVolumeLabelInfo.h>
|
|
|
|
#include <Protocol/EmuIoThunk.h>
|
|
#include <Protocol/SimpleFileSystem.h>
|
|
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/UefiDriverEntryPoint.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
|
|
extern EFI_DRIVER_BINDING_PROTOCOL gEmuSimpleFileSystemDriverBinding;
|
|
extern EFI_COMPONENT_NAME_PROTOCOL gEmuSimpleFileSystemComponentName;
|
|
extern EFI_COMPONENT_NAME2_PROTOCOL gEmuSimpleFileSystemComponentName2;
|
|
|
|
#define EMU_SIMPLE_FILE_SYSTEM_PRIVATE_SIGNATURE SIGNATURE_32 ('E', 'M', 'f', 's')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
EMU_IO_THUNK_PROTOCOL *IoThunk;
|
|
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL SimpleFileSystem;
|
|
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Io;
|
|
EFI_UNICODE_STRING_TABLE *ControllerNameTable;
|
|
} EMU_SIMPLE_FILE_SYSTEM_PRIVATE;
|
|
|
|
#define EMU_SIMPLE_FILE_SYSTEM_PRIVATE_DATA_FROM_THIS(a) \
|
|
CR (a, \
|
|
EMU_SIMPLE_FILE_SYSTEM_PRIVATE, \
|
|
SimpleFileSystem, \
|
|
EMU_SIMPLE_FILE_SYSTEM_PRIVATE_SIGNATURE \
|
|
)
|
|
|
|
#define EMU_EFI_FILE_PRIVATE_SIGNATURE SIGNATURE_32 ('e', 'm', 'f', 's')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
EMU_IO_THUNK_PROTOCOL *IoThunk;
|
|
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *SimpleFileSystem;
|
|
EFI_FILE_PROTOCOL EfiFile;
|
|
EFI_FILE_PROTOCOL *Io;
|
|
} EMU_EFI_FILE_PRIVATE;
|
|
|
|
#define EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS(a) \
|
|
CR (a, \
|
|
EMU_EFI_FILE_PRIVATE, \
|
|
EfiFile, \
|
|
EMU_EFI_FILE_PRIVATE_SIGNATURE \
|
|
)
|