mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
de527ff606
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>
175 lines
4.2 KiB
C
175 lines
4.2 KiB
C
/** @file
|
|
*
|
|
* Copyright (c) 2016, Hisilicon Limited. All rights reserved.
|
|
* Copyright (c) 2016-2019, Linaro Limited. All rights reserved.
|
|
* Copyright (c) 2021, Ampere Computing LLC. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
*
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi/UefiBaseType.h>
|
|
|
|
//
|
|
// Convenience macros to obtain a build date
|
|
//
|
|
// These macros should work for any compiler that follows ISO/IEC 9899,
|
|
// in which case __DATE__ is defined as a "Mmm dd yyyy" 11 chars string,
|
|
// but add an explicit filter for compilers that have been validated.
|
|
//
|
|
#if (defined (__GNUC__) || defined (_MSC_VER) || defined (__clang__))
|
|
#define TIME_BUILD_YEAR (__DATE__[7] == '?' ? 1900\
|
|
: (((__DATE__[7] - '0') * 1000 ) \
|
|
+ (__DATE__[8] - '0') * 100 \
|
|
+ (__DATE__[9] - '0') * 10 \
|
|
+ __DATE__[10] - '0'))
|
|
#define TIME_BUILD_MONTH ( __DATE__ [2] == '?' ? 1 \
|
|
: __DATE__ [2] == 'n' ? ( \
|
|
__DATE__ [1] == 'a' ? 1 : 6) \
|
|
: __DATE__ [2] == 'b' ? 2 \
|
|
: __DATE__ [2] == 'r' ? ( \
|
|
__DATE__ [0] == 'M' ? 3 : 4) \
|
|
: __DATE__ [2] == 'y' ? 5 \
|
|
: __DATE__ [2] == 'l' ? 7 \
|
|
: __DATE__ [2] == 'g' ? 8 \
|
|
: __DATE__ [2] == 'p' ? 9 \
|
|
: __DATE__ [2] == 't' ? 10 \
|
|
: __DATE__ [2] == 'v' ? 11 \
|
|
: 12)
|
|
#define TIME_BUILD_DAY ( __DATE__[4] == '?' ? 1 \
|
|
: ((__DATE__[4] == ' ' ? 0 : \
|
|
((__DATE__[4] - '0') * 10)) \
|
|
+ __DATE__[5] - '0'))
|
|
#endif
|
|
|
|
// Define EPOCH (1970-JANUARY-01) in the Julian Date representation
|
|
#define EPOCH_JULIAN_DATE 2440588
|
|
|
|
// Seconds per unit
|
|
#define SEC_PER_MIN ((UINTN) 60)
|
|
#define SEC_PER_HOUR ((UINTN) 3600)
|
|
#define SEC_PER_DAY ((UINTN) 86400)
|
|
|
|
/**
|
|
Check if it is a leap year.
|
|
|
|
@param Time The UEFI time to be checked.
|
|
|
|
@retval TRUE It is a leap year.
|
|
@retval FALSE It is NOT a leap year.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsLeapYear (
|
|
IN EFI_TIME *Time
|
|
);
|
|
|
|
/**
|
|
Check if the day in the UEFI time is valid.
|
|
|
|
@param Time The UEFI time to be checked.
|
|
|
|
@retval TRUE Valid.
|
|
@retval FALSE Invalid.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsDayValid (
|
|
IN EFI_TIME *Time
|
|
);
|
|
|
|
/**
|
|
Check if the time zone is valid.
|
|
Valid values are between -1440 and 1440 or 2047 (EFI_UNSPECIFIED_TIMEZONE).
|
|
|
|
@param TimeZone The time zone to be checked.
|
|
|
|
@retval TRUE Valid.
|
|
@retval FALSE Invalid.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsValidTimeZone (
|
|
IN INT16 TimeZone
|
|
);
|
|
|
|
/**
|
|
Check if the daylight is valid.
|
|
Valid values are:
|
|
0 : Time is not affected.
|
|
1 : Time is affected, and has not been adjusted for daylight savings.
|
|
3 : Time is affected, and has been adjusted for daylight savings.
|
|
All other values are invalid.
|
|
|
|
@param Daylight The daylight to be checked.
|
|
|
|
@retval TRUE Valid.
|
|
@retval FALSE Invalid.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsValidDaylight (
|
|
IN INT8 Daylight
|
|
);
|
|
|
|
/**
|
|
Check if the UEFI time is valid.
|
|
|
|
@param Time The UEFI time to be checked.
|
|
|
|
@retval TRUE Valid.
|
|
@retval FALSE Invalid.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsTimeValid (
|
|
IN EFI_TIME *Time
|
|
);
|
|
|
|
/**
|
|
Converts Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC) to EFI_TIME.
|
|
|
|
@param EpochSeconds Epoch seconds.
|
|
@param Time The time converted to UEFI format.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
EpochToEfiTime (
|
|
IN UINTN EpochSeconds,
|
|
OUT EFI_TIME *Time
|
|
);
|
|
|
|
/**
|
|
Converts EFI_TIME to Epoch seconds (elapsed since 1970 JANUARY 01, 00:00:00 UTC).
|
|
|
|
@param Time The UEFI time to be converted.
|
|
|
|
@return Number of seconds.
|
|
|
|
**/
|
|
UINTN
|
|
EFIAPI
|
|
EfiTimeToEpoch (
|
|
IN EFI_TIME *Time
|
|
);
|
|
|
|
/**
|
|
Get the day of the week from the UEFI time.
|
|
|
|
@param Time The UEFI time to be calculated.
|
|
|
|
@return The day of the week: Sunday=0, Monday=1, ... Saturday=6
|
|
|
|
**/
|
|
UINTN
|
|
EfiTimeToWday (
|
|
IN EFI_TIME *Time
|
|
);
|