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>
108 lines
2.4 KiB
C
108 lines
2.4 KiB
C
/** @file
|
|
Functions declarations to make Xen hypercalls.
|
|
|
|
Copyright (C) 2014, Citrix Ltd.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
To call when the gEfiXenInfoGuid HOB became available after the library init
|
|
function has already been executed.
|
|
|
|
This allow to make hypercall in the PEIM stage.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
XenHypercallLibInit (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Check if the Xen Hypercall library is able to make calls to the Xen
|
|
hypervisor.
|
|
|
|
Client code should call further functions in this library only if, and after,
|
|
this function returns TRUE.
|
|
|
|
@retval TRUE Hypercalls are available.
|
|
@retval FALSE Hypercalls are not available.
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
XenHypercallIsAvailable (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function will put the two arguments in the right place (registers) and
|
|
invoke the hypercall identified by HypercallID.
|
|
|
|
@param HypercallID The symbolic ID of the hypercall to be invoked
|
|
@param Arg1 First argument.
|
|
@param Arg2 Second argument.
|
|
|
|
@return Return 0 if success otherwise it return an errno.
|
|
**/
|
|
INTN
|
|
EFIAPI
|
|
XenHypercall2 (
|
|
IN UINTN HypercallID,
|
|
IN OUT INTN Arg1,
|
|
IN OUT INTN Arg2
|
|
);
|
|
|
|
/**
|
|
Return the value of the HVM parameter Index.
|
|
|
|
@param Index The parameter to get, e.g. HVM_PARAM_STORE_EVTCHN.
|
|
|
|
@return The value of the asked parameter or 0 in case of error.
|
|
**/
|
|
UINT64
|
|
EFIAPI
|
|
XenHypercallHvmGetParam (
|
|
UINT32 Index
|
|
);
|
|
|
|
/**
|
|
Hypercall to do different operation on the memory.
|
|
|
|
@param Operation The operation number, e.g. XENMEM_add_to_physmap.
|
|
@param Arguments The arguments associated to the operation.
|
|
|
|
@return Return the return value from the hypercall, 0 in case of success
|
|
otherwise, an error code.
|
|
**/
|
|
INTN
|
|
EFIAPI
|
|
XenHypercallMemoryOp (
|
|
IN UINTN Operation,
|
|
IN OUT VOID *Arguments
|
|
);
|
|
|
|
/**
|
|
Do an operation on the event channels.
|
|
|
|
@param Operation The operation number, e.g. EVTCHNOP_send.
|
|
@param Arguments The argument associated to the operation.
|
|
|
|
@return Return the return value from the hypercall, 0 in case of success
|
|
otherwise, an error code.
|
|
**/
|
|
INTN
|
|
EFIAPI
|
|
XenHypercallEventChannelOp (
|
|
IN INTN Operation,
|
|
IN OUT VOID *Arguments
|
|
);
|
|
|
|
INTN
|
|
EFIAPI
|
|
XenHypercallSchedOp (
|
|
IN INTN Operation,
|
|
IN OUT VOID *Arguments
|
|
);
|