shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

[clang][PP] Add extension to predefine target OS macros (#74676)

Browse Source 
Add an extension feature `define-target-os-macros` that enables clang to
provide definitions of common TARGET_OS_* conditional macros. The
extension is enabled in the Darwin toolchain driver.
This commit is contained in:
Zixu Wang 2023-12-07 17:40:58 -08:00 committed by GitHub
parent c502a81b43
commit 6e1f19168b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 327 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clang/include/clang/Basic/Features.def
View File

@ -89,6 +89,8 @@ FEATURE(blocks, LangOpts.Blocks)
FEATURE(c_thread_safety_attributes, true)
FEATURE(cxx_exceptions, LangOpts.CXXExceptions)
FEATURE(cxx_rtti, LangOpts.RTTI &&LangOpts.RTTIData)
EXTENSION(define_target_os_macros,
PP.getPreprocessorOpts().DefineTargetOSMacros)
FEATURE(enumerator_attributes, true)
FEATURE(nullability, true)
FEATURE(nullability_on_arrays, true)

55
clang/include/clang/Basic/TargetOSMacros.def Normal file
View File

@ -0,0 +1,55 @@
//===--- TargetOSMacros.def - Target OS macros ------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file specifies the predefined TARGET_OS_* conditional macros.
// A target macro `Name` should be defined if `Predicate` evaluates to true.
// The macro expects `const llvm::Triple &Triple` and the class `llvm::Triple`
// to be available for the predicate.
//
//===----------------------------------------------------------------------===//
#ifndef TARGET_OS
#define TARGET_OS(Name, Predicate)
#endif
// Windows targets.
TARGET_OS(TARGET_OS_WIN32, Triple.isOSWindows())
TARGET_OS(TARGET_OS_WINDOWS, Triple.isOSWindows())
// Linux target.
TARGET_OS(TARGET_OS_LINUX, Triple.isOSLinux())
// Unix target.
TARGET_OS(TARGET_OS_UNIX, Triple.isOSNetBSD() ||
Triple.isOSFreeBSD() ||
Triple.isOSOpenBSD() ||
Triple.isOSSolaris())
// Apple (Mac) targets.
TARGET_OS(TARGET_OS_MAC, Triple.isOSDarwin())
TARGET_OS(TARGET_OS_OSX, Triple.isMacOSX())
TARGET_OS(TARGET_OS_IPHONE, Triple.isiOS() || Triple.isTvOS() ||
Triple.isWatchOS())
// Triple::isiOS() also includes tvOS
TARGET_OS(TARGET_OS_IOS, Triple.getOS() == llvm::Triple::IOS)
TARGET_OS(TARGET_OS_TV, Triple.isTvOS())
TARGET_OS(TARGET_OS_WATCH, Triple.isWatchOS())
TARGET_OS(TARGET_OS_DRIVERKIT, Triple.isDriverKit())
TARGET_OS(TARGET_OS_MACCATALYST, Triple.isMacCatalystEnvironment())
TARGET_OS(TARGET_OS_SIMULATOR, Triple.isSimulatorEnvironment())
// Deprecated Apple target conditionals.
TARGET_OS(TARGET_OS_EMBEDDED, (Triple.isiOS() || Triple.isTvOS() \
|| Triple.isWatchOS()) \
&& !Triple.isMacCatalystEnvironment() \
&& !Triple.isSimulatorEnvironment())
TARGET_OS(TARGET_OS_NANO, Triple.isWatchOS())
TARGET_OS(TARGET_IPHONE_SIMULATOR, Triple.isSimulatorEnvironment())
TARGET_OS(TARGET_OS_UIKITFORMAC, Triple.isMacCatalystEnvironment())
#undef TARGET_OS

3
clang/include/clang/Driver/Options.td
View File

@ -1818,6 +1818,9 @@ def fcomment_block_commands : CommaJoined<["-"], "fcomment-block-commands=">, Gr
Visibility<[ClangOption, CC1Option]>,
HelpText<"Treat each comma separated argument in <arg> as a documentation comment block command">,
MetaVarName<"<arg>">, MarshallingInfoStringVector<LangOpts<"CommentOpts.BlockCommandNames">>;
defm define_target_os_macros : OptInCC1FFlag<"define-target-os-macros",
"Enable", "Disable", " predefined target OS macros",
[ClangOption, CC1Option]>;
def fparse_all_comments : Flag<["-"], "fparse-all-comments">, Group<f_clang_Group>,
Visibility<[ClangOption, CC1Option]>,
MarshallingInfoFlag<LangOpts<"CommentOpts.ParseAllComments">>;

3
clang/include/clang/Lex/PreprocessorOptions.h
View File

@ -76,6 +76,9 @@ public:
/// predefines.
bool UsePredefines = true;
/// Indicates whether to predefine target OS macros.
bool DefineTargetOSMacros = false;
/// Whether we should maintain a detailed record of all macro
/// definitions and expansions.
bool DetailedRecord = false;

3
clang/lib/Driver/ToolChains/Clang.cpp
View File

@ -1294,6 +1294,9 @@ void Clang::AddPreprocessingOptions(Compilation &C, const JobAction &JA,
CmdArgs.push_back("-source-date-epoch");
CmdArgs.push_back(Args.MakeArgString(Epoch));
}
Args.addOptInFlag(CmdArgs, options::OPT_fdefine_target_os_macros,
options::OPT_fno_define_target_os_macros);
}
// FIXME: Move to target hook.

4
clang/lib/Driver/ToolChains/Darwin.cpp
View File

@ -2916,6 +2916,10 @@ void Darwin::addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
// to fix the same problem with C++ headers, and is generally fragile.
if (!sdkSupportsBuiltinModules(TargetPlatform, SDKInfo))
CC1Args.push_back("-fbuiltin-headers-in-system-modules");
if (!DriverArgs.hasArgNoClaim(options::OPT_fdefine_target_os_macros,
options::OPT_fno_define_target_os_macros))
CC1Args.push_back("-fdefine-target-os-macros");
}
void Darwin::addClangCC1ASTargetOptions(

7
clang/lib/Frontend/CompilerInvocation.cpp
View File

@ -4365,6 +4365,9 @@ static void GeneratePreprocessorArgs(const PreprocessorOptions &Opts,
if (Opts.SourceDateEpoch)
GenerateArg(Consumer, OPT_source_date_epoch, Twine(*Opts.SourceDateEpoch));
if (Opts.DefineTargetOSMacros)
GenerateArg(Consumer, OPT_fdefine_target_os_macros);
// Don't handle LexEditorPlaceholders. It is implied by the action that is
// generated elsewhere.
}
@ -4463,6 +4466,10 @@ static bool ParsePreprocessorArgs(PreprocessorOptions &Opts, ArgList &Args,
if (isStrictlyPreprocessorAction(Action))
Opts.LexEditorPlaceholders = false;
Opts.DefineTargetOSMacros =
Args.hasFlag(OPT_fdefine_target_os_macros,
OPT_fno_define_target_os_macros, Opts.DefineTargetOSMacros);
return Diags.getNumErrors() == NumErrorsBefore;
}

9
clang/lib/Frontend/InitPreprocessor.cpp
View File

@ -1351,6 +1351,15 @@ static void InitializePredefinedMacros(const TargetInfo &TI,
if (TI.getTriple().isOSBinFormatELF())
Builder.defineMacro("__ELF__");
// Target OS macro definitions.
if (PPOpts.DefineTargetOSMacros) {
const llvm::Triple &Triple = TI.getTriple();
#define TARGET_OS(Name, Predicate) \
Builder.defineMacro(#Name, (Predicate) ? "1" : "0");
#include "clang/Basic/TargetOSMacros.def"
#undef TARGET_OS
}
// Get other target #defines.
TI.getTargetDefines(LangOpts, Builder);
}

241
clang/test/Driver/fdefine-target-os-macros.c Normal file
View File

@ -0,0 +1,241 @@
// RUN: %clang -### --target=arm64-apple-darwin %s 2>&1 | FileCheck %s --check-prefix=DARWIN-DEFAULT
// DARWIN-DEFAULT: "-fdefine-target-os-macros"
// RUN: %clang -### --target=arm-none-linux-gnu %s 2>&1 | FileCheck %s --check-prefix=NON-DARWIN-DEFAULT
// RUN: %clang -### --target=x86_64-pc-win32 %s 2>&1 | FileCheck %s --check-prefix=NON-DARWIN-DEFAULT
// NON-DARWIN-DEFAULT-NOT: "-fdefine-target-os-macros"
// RUN: %clang -dM -E --target=arm64-apple-macos %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=1 \
// RUN: -DIPHONE=0 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-ios %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=1 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=1 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-ios-macabi %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=1 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=1 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-ios-simulator %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=1 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=1 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-tvos %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=0 \
// RUN: -DTV=1 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=1 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-tvos-simulator %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=0 \
// RUN: -DTV=1 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=1 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-watchos %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=1 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=1 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-watchos-simulator %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=1 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=1 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=1 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=arm64-apple-driverkit %s 2>&1 \
// RUN: | FileCheck %s -DMAC=1 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=0 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=1 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=x86_64-pc-linux-gnu \
// RUN: -fdefine-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s -DMAC=0 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=0 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=1 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=x86_64-pc-win32 \
// RUN: -fdefine-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s -DMAC=0 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=0 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=1 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=x86_64-pc-windows-gnu \
// RUN: -fdefine-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s -DMAC=0 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=0 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=1 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=0
// RUN: %clang -dM -E --target=sparc-none-solaris \
// RUN: -fdefine-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s -DMAC=0 \
// RUN: -DOSX=0 \
// RUN: -DIPHONE=0 \
// RUN: -DIOS=0 \
// RUN: -DTV=0 \
// RUN: -DWATCH=0 \
// RUN: -DDRIVERKIT=0 \
// RUN: -DMACCATALYST=0 \
// RUN: -DEMBEDDED=0 \
// RUN: -DSIMULATOR=0 \
// RUN: -DWINDOWS=0 \
// RUN: -DLINUX=0 \
// RUN: -DUNIX=1
// RUN: %clang -dM -E --target=arm64-apple-macos \
// RUN: -fno-define-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s --check-prefix=NEG
// RUN: %clang -dM -E --target=arm64-apple-macos \
// RUN: -fdefine-target-os-macros \
// RUN: -fno-define-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s --check-prefix=NEG
// RUN: %clang -dM -E --target=x86_64-pc-windows \
// RUN: -fdefine-target-os-macros \
// RUN: -fno-define-target-os-macros %s 2>&1 \
// RUN: | FileCheck %s --check-prefix=NEG
// NEG-NOT: #define TARGET_OS_
// CHECK-DAG: #define TARGET_OS_MAC [[MAC]]
// CHECK-DAG: #define TARGET_OS_OSX [[OSX]]
// CHECK-DAG: #define TARGET_OS_IPHONE [[IPHONE]]
// CHECK-DAG: #define TARGET_OS_IOS [[IOS]]
// CHECK-DAG: #define TARGET_OS_TV [[TV]]
// CHECK-DAG: #define TARGET_OS_WATCH [[WATCH]]
// CHECK-DAG: #define TARGET_OS_DRIVERKIT [[DRIVERKIT]]
// CHECK-DAG: #define TARGET_OS_MACCATALYST [[MACCATALYST]]
// CHECK-DAG: #define TARGET_OS_SIMULATOR [[SIMULATOR]]
// Deprecated
// CHECK-DAG: #define TARGET_OS_EMBEDDED [[EMBEDDED]]
// CHECK-DAG: #define TARGET_OS_NANO [[WATCH]]
// CHECK-DAG: #define TARGET_IPHONE_SIMULATOR [[SIMULATOR]]
// CHECK-DAG: #define TARGET_OS_UIKITFORMAC [[MACCATALYST]]
// Non-darwin OSes
// CHECK-DAG: #define TARGET_OS_WIN32 [[WINDOWS]]
// CHECK-DAG: #define TARGET_OS_WINDOWS [[WINDOWS]]
// CHECK-DAG: #define TARGET_OS_LINUX [[LINUX]]
// CHECK-DAG: #define TARGET_OS_UNIX [[UNIX]]