mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
7835e5802a
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>
94 lines
2.4 KiB
C
94 lines
2.4 KiB
C
/** @file
|
|
Root include file of C runtime library to support building the third-party
|
|
libfdt library.
|
|
|
|
Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>
|
|
Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Base.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
|
|
typedef UINT8 uint8_t;
|
|
typedef UINT16 uint16_t;
|
|
typedef INT32 int32_t;
|
|
typedef UINT32 uint32_t;
|
|
typedef UINT64 uint64_t;
|
|
typedef UINTN uintptr_t;
|
|
typedef UINTN size_t;
|
|
|
|
#if defined __STDC_VERSION__ && __STDC_VERSION__ > 201710L
|
|
/* bool, true and false are keywords. */
|
|
#else
|
|
typedef BOOLEAN bool;
|
|
#define true (1 == 1)
|
|
#define false (1 == 0)
|
|
#endif
|
|
|
|
//
|
|
// Definitions for global constants used by libfdt library routines
|
|
//
|
|
#define INT_MAX 0x7FFFFFFF /* Maximum (signed) int value */
|
|
#define INT32_MAX 0x7FFFFFFF /* Maximum (signed) int32 value */
|
|
#define UINT32_MAX 0xFFFFFFFF /* Maximum unsigned int32 value */
|
|
|
|
//
|
|
// Function prototypes of libfdt Library routines
|
|
//
|
|
void *
|
|
memset (
|
|
void *,
|
|
int,
|
|
size_t
|
|
);
|
|
|
|
int
|
|
memcmp (
|
|
const void *,
|
|
const void *,
|
|
size_t
|
|
);
|
|
|
|
char *
|
|
strchr (
|
|
const char *,
|
|
int
|
|
);
|
|
|
|
char *
|
|
fdt_strrchr (
|
|
const char *,
|
|
int
|
|
);
|
|
|
|
unsigned long
|
|
fdt_strtoul (
|
|
const char *,
|
|
char **,
|
|
int
|
|
);
|
|
|
|
char *
|
|
strcpy (
|
|
char *strDest,
|
|
const char *strSource
|
|
);
|
|
|
|
//
|
|
// Macros that directly map functions to BaseLib, BaseMemoryLib, and DebugLib functions
|
|
//
|
|
#define memcpy(dest, source, count) CopyMem(dest,source, (UINTN)(count))
|
|
#define memset(dest, ch, count) SetMem(dest, (UINTN)(count),(UINT8)(ch))
|
|
#define memchr(buf, ch, count) ScanMem8(buf, (UINTN)(count),(UINT8)ch)
|
|
#define memcmp(buf1, buf2, count) (int)(CompareMem(buf1, buf2, (UINTN)(count)))
|
|
#define memmove(dest, source, count) CopyMem(dest, source, (UINTN)(count))
|
|
#define strlen(str) (size_t)(AsciiStrLen(str))
|
|
#define strnlen(str, count) (size_t)(AsciiStrnLenS(str, count))
|
|
#define strchr(str, ch) ScanMem8(str, AsciiStrSize (str), (UINT8)ch)
|
|
#define strrchr(str, ch) fdt_strrchr(str, ch)
|
|
#define strtoul(ptr, end_ptr, base) fdt_strtoul(ptr, end_ptr, base)
|