llvm-project/clang/lib/CodeGen
Nick Desaulniers 2240d72f15 [X86] initial -mfunction-return=thunk-extern support
Adds support for:
* `-mfunction-return=<value>` command line flag, and
* `__attribute__((function_return("<value>")))` function attribute

Where the supported <value>s are:
* keep (disable)
* thunk-extern (enable)

thunk-extern enables clang to change ret instructions into jmps to an
external symbol named __x86_return_thunk, implemented as a new
MachineFunctionPass named "x86-return-thunks", keyed off the new IR
attribute fn_ret_thunk_extern.

The symbol __x86_return_thunk is expected to be provided by the runtime
the compiled code is linked against and is not defined by the compiler.
Enabling this option alone doesn't provide mitigations without
corresponding definitions of __x86_return_thunk!

This new MachineFunctionPass is very similar to "x86-lvi-ret".

The <value>s "thunk" and "thunk-inline" are currently unsupported. It's
not clear yet that they are necessary: whether the thunk pattern they
would emit is beneficial or used anywhere.

Should the <value>s "thunk" and "thunk-inline" become necessary,
x86-return-thunks could probably be merged into x86-retpoline-thunks
which has pre-existing machinery for emitting thunks (which could be
used to implement the <value> "thunk").

Has been found to build+boot with corresponding Linux
kernel patches. This helps the Linux kernel mitigate RETBLEED.
* CVE-2022-23816
* CVE-2022-28693
* CVE-2022-29901

See also:
* "RETBLEED: Arbitrary Speculative Code Execution with Return
Instructions."
* AMD SECURITY NOTICE AMD-SN-1037: AMD CPU Branch Type Confusion
* TECHNICAL GUIDANCE FOR MITIGATING BRANCH TYPE CONFUSION REVISION 1.0
  2022-07-12
* Return Stack Buffer Underflow / Return Stack Buffer Underflow /
  CVE-2022-29901, CVE-2022-28693 / INTEL-SA-00702

SystemZ may eventually want to support "thunk-extern" and "thunk"; both
options are used by the Linux kernel's CONFIG_EXPOLINE.

This functionality has been available in GCC since the 8.1 release, and
was backported to the 7.3 release.

Many thanks for folks that provided discrete review off list due to the
embargoed nature of this hardware vulnerability. Many Bothans died to
bring us this information.

Link: https://www.youtube.com/watch?v=IF6HbCKQHK8
Link: https://github.com/llvm/llvm-project/issues/54404
Link: https://gcc.gnu.org/legacy-ml/gcc-patches/2018-01/msg01197.html
Link: https://www.intel.com/content/www/us/en/developer/articles/technical/software-security-guidance/advisory-guidance/return-stack-buffer-underflow.html
Link: https://arstechnica.com/information-technology/2022/07/intel-and-amd-cpus-vulnerable-to-a-new-speculative-execution-attack/?comments=1
Link: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=ce114c866860aa9eae3f50974efc68241186ba60
Link: https://www.intel.com/content/www/us/en/security-center/advisory/intel-sa-00702.html
Link: https://www.intel.com/content/www/us/en/security-center/advisory/intel-sa-00707.html

Reviewed By: aaron.ballman, craig.topper

Differential Revision: https://reviews.llvm.org/D129572
2022-07-12 09:17:54 -07:00
..
ABIInfo.h [ARM] Fix how size-0 bitfields affect homogeneous aggregates. 2022-06-10 11:27:24 +01:00
Address.h [CGOpenMPRuntime] Remove uses of deprecated Address constructor 2022-03-23 12:40:44 +01:00
BackendUtil.cpp [Debugify] Port verify-debuginfo-preserve to NewPM 2022-07-06 17:07:20 +02:00
CGAtomic.cpp [NFC][Clang][OpaquePtr] Remove the call to Address::deprecated in 2022-03-02 08:58:00 -08:00
CGBlocks.cpp [CGBlocks] Don't assume presence of bitcast 2022-03-23 15:39:39 +01:00
CGBlocks.h [CodeGen] Treat ObjC `__unsafe_unretained` and class types as trivial 2022-01-11 11:18:24 -08:00
CGBuilder.h [clang] Add support for __builtin_memset_inline 2022-06-10 13:13:59 +00:00
CGBuiltin.cpp [AMDGPU] Add WMMA clang builtins 2022-07-01 08:55:25 +02:00
CGCUDANV.cpp [HIP] Generate offloading entries for HIP with the new driver. 2022-07-11 15:49:21 -04:00
CGCUDARuntime.cpp
CGCUDARuntime.h [CUDA] Create offloading entries when using the new driver 2022-05-11 07:30:21 -04:00
CGCXX.cpp [OpaquePtr] Remove uses of CGF.Builder.CreateConstInBoundsGEP1_64() without type 2021-07-17 17:07:46 +02:00
CGCXXABI.cpp [clang] CGCXXABI::EmitLoadOfMemberFunctionPointer - use castAs<> instead of getAs<> to avoid dereference of nullptr 2022-02-17 13:18:23 +00:00
CGCXXABI.h [clang] Remove Address::deprecated() in CGCXXABI.h 2022-02-17 14:23:02 -08:00
CGCall.cpp [NFC] Add a TODO comment to apply nounwind attribute in all GPU modes. 2022-07-06 06:20:09 -07:00
CGCall.h [clang] Remove some getPointerElementType() uses 2022-01-25 12:09:06 +01:00
CGClass.cpp Revert "Don't use Optional::hasValue (NFC)" 2022-06-25 11:56:50 -07:00
CGCleanup.cpp [NFC][Alignment] Use MaybeAlign in CGCleanup/CGExpr 2022-06-14 10:56:36 +00:00
CGCleanup.h [clang] Remove unused forward declarations (NFC) 2022-01-08 11:56:40 -08:00
CGCoroutine.cpp [FPEnv] Allow CompoundStmt to keep FP options 2022-07-03 17:06:26 +07:00
CGDebugInfo.cpp Revert "DebugInfo: Fully integrate ctor type homing into 'limited' debug info" 2022-06-24 17:07:47 +00:00
CGDebugInfo.h Reland "[dwarf] Emit a DIGlobalVariable for constant strings." 2022-05-18 13:56:45 -07:00
CGDecl.cpp [NFC][CodeGen] Rename method 2022-06-07 14:08:42 -07:00
CGDeclCXX.cpp Revert "[C++20][Modules] Build module static initializers per P1874R1." 2022-07-11 19:50:31 +01:00
CGException.cpp [CodeGen] Remove some uses of deprecated Address constructor 2022-03-18 11:01:25 +01:00
CGExpr.cpp Revert "[clang] Introduce -fstrict-flex-arrays=<n> for stricter handling of flexible arrays" 2022-06-27 14:03:09 -07:00
CGExprAgg.cpp [NFC][Clang][OpaquePtr] Move away from deprecated Address constructor in VisitArrayInitLoopExpr 2022-01-27 14:44:53 -08:00
CGExprCXX.cpp [CodeGen] Use ABI alignment for C++ new expressions 2022-05-10 16:02:23 +01:00
CGExprComplex.cpp [Matrix] Implement C-style explicit type conversions for matrix types. 2021-04-10 11:48:41 +01:00
CGExprConstant.cpp Fix miscompile with [[no_unique_address]] struct fields. 2022-06-29 13:08:40 -07:00
CGExprScalar.cpp [IR] Move vector.insert/vector.extract out of experimental namespace 2022-06-27 10:48:45 +00:00
CGGPUBuiltin.cpp [OpenMP] Lower printf to __llvm_omp_vprintf 2021-11-10 15:30:56 +00:00
CGHLSLRuntime.cpp [clang] Don't use Optional::getValue (NFC) 2022-06-20 22:59:26 -07:00
CGHLSLRuntime.h [HLSL][clang][Driver] Support validator version command line option. 2022-04-29 16:48:08 -07:00
CGLoopInfo.cpp
CGLoopInfo.h
CGNonTrivialStruct.cpp Use llvm::append_range instead of push_back loops where applicable. NFCI. 2022-03-18 01:25:34 +01:00
CGObjC.cpp [clang] Don't use Optional::getValue (NFC) 2022-06-20 22:59:26 -07:00
CGObjCGNU.cpp [clang][CodeGen] NFCI: Use FileEntryRef 2022-04-15 15:16:17 +02:00
CGObjCMac.cpp [CodeGen] Fix -Wswitch after D116462 2022-04-19 17:33:15 -07:00
CGObjCRuntime.cpp [NFC][Clang][OpaquePtr] Remove calls to Address::deprecated in a couple 2022-03-11 09:30:31 -08:00
CGObjCRuntime.h Fix a variety of bugs with nil-receiver checks when targeting 2021-10-08 05:44:06 -04:00
CGOpenCLRuntime.cpp [CodeGen] Avoid pointer element type access for blocks 2022-03-17 16:56:31 +01:00
CGOpenCLRuntime.h [CodeGen] Avoid pointer element type access for blocks 2022-03-17 16:56:31 +01:00
CGOpenMPRuntime.cpp [OpenMP] Add loop tripcount argument to kernel launch and remove push function 2022-07-08 14:44:16 -04:00
CGOpenMPRuntime.h [OpenMP] Add loop tripcount argument to kernel launch and remove push function 2022-07-08 14:44:16 -04:00
CGOpenMPRuntimeGPU.cpp [clang] Don't use Optional::getValue (NFC) 2022-06-20 22:59:26 -07:00
CGOpenMPRuntimeGPU.h [OpenMP][FIX] Pass the num_threads value directly to parallel_51 2021-12-09 16:30:29 -05:00
CGRecordLayout.h [Clang] Add helper method to determine if a nonvirtual base has an entry in the LLVM struct 2022-03-25 16:32:12 -04:00
CGRecordLayoutBuilder.cpp [clang] Fix bugprone argument comments (NFC) 2022-01-09 00:19:49 -08:00
CGStmt.cpp [OpenMP] Initial parsing and semantic support for 'parallel masked taskloop simd' construct 2022-07-01 08:57:15 -07:00
CGStmtOpenMP.cpp [OMPIRBuilder] Add support for simdlen clause 2022-07-11 13:29:06 -04:00
CGVTT.cpp [clang codegen] Add dso_local/hidden/etc. markings to VTT declarations 2022-06-24 09:58:31 -07:00
CGVTables.cpp [clang] Don't emit type test/assume for virtual classes that should never participate in WPD 2022-06-16 09:38:14 -07:00
CGVTables.h
CGValue.h [CodeGen] Store element type in RValue 2021-12-17 09:05:59 +01:00
CMakeLists.txt [HLSL][clang][Driver] Support validator version command line option. 2022-04-29 16:48:08 -07:00
CodeGenABITypes.cpp
CodeGenAction.cpp [Clang] Always set opaque pointers mode 2022-05-31 15:43:05 +02:00
CodeGenFunction.cpp [X86] initial -mfunction-return=thunk-extern support 2022-07-12 09:17:54 -07:00
CodeGenFunction.h [ubsan] Using metadata instead of prologue data for function sanitizer 2022-06-27 12:09:13 -07:00
CodeGenModule.cpp [X86] Support -mstack-protector-guard-symbol 2022-07-12 10:17:00 +08:00
CodeGenModule.h Revert "[C++20][Modules] Build module static initializers per P1874R1." 2022-07-11 19:50:31 +01:00
CodeGenPGO.cpp Remove unneeded cl::ZeroOrMore for cl::opt/cl::list options 2022-06-05 00:31:44 -07:00
CodeGenPGO.h [PGO] Don't reference functions unless value profiling is enabled 2021-05-20 11:09:24 -07:00
CodeGenTBAA.cpp [tbaa] Handle base classes in struct tbaa 2022-07-06 14:37:59 +02:00
CodeGenTBAA.h [clang] Remove unused forward declarations (NFC) 2022-01-08 11:56:40 -08:00
CodeGenTypeCache.h Fix __attribute__((annotate("")) with non-zero globals AS 2021-08-26 10:09:40 +01:00
CodeGenTypes.cpp [Clang] Allow "ext_vector_type" applied to Booleans 2022-03-16 11:10:32 +01:00
CodeGenTypes.h [clang] Properly cache member pointer LLVM types 2022-02-08 13:22:24 -08:00
ConstantEmitter.h
ConstantInitBuilder.cpp [clang][CodeGen] Switch a few placeholders from UndefValue to PoisonValue 2022-06-12 19:07:59 +01:00
CoverageMappingGen.cpp Don't use Optional::hasValue (NFC) 2022-06-20 20:05:16 -07:00
CoverageMappingGen.h [Clang][CoverageMapping] Fix compile time explosions by adjusting only appropriated skipped ranges 2022-06-08 23:13:39 -07:00
EHScopeStack.h [Windows SEH]: HARDWARE EXCEPTION HANDLING (MSVC -EHa) - Part 1 2021-05-17 22:42:17 -07:00
ItaniumCXXABI.cpp [ConstExpr] Don't create insertvalue expressions 2022-07-01 09:23:28 +02:00
MacroPPCallbacks.cpp [clang][lex] NFCI: Use FileEntryRef in PPCallbacks::InclusionDirective() 2022-04-14 10:46:12 +02:00
MacroPPCallbacks.h [clang][lex] NFCI: Use FileEntryRef in PPCallbacks::InclusionDirective() 2022-04-14 10:46:12 +02:00
MicrosoftCXXABI.cpp Reland [clang][AIX] add option mdefault-visibility-export-mapping 2022-06-13 13:43:46 -04:00
ModuleBuilder.cpp Reland "[CodeGen] Keep track info of lazy-emitted symbols in ModuleBuilder" 2022-06-18 20:27:21 +08:00
ObjectFilePCHContainerOperations.cpp [gmodules] Skip CXXDeductionGuideDecls when visiting FunctionDecls in 2022-06-06 19:12:26 -07:00
PatternInit.cpp
PatternInit.h
README.txt
SanitizerMetadata.cpp Update DynInit generation for ASan globals. 2022-07-11 12:23:37 -07:00
SanitizerMetadata.h Delete 'llvm.asan.globals' for global metadata. 2022-06-27 14:40:40 -07:00
SwiftCallingConv.cpp
TargetInfo.cpp [clang] Don't use Optional::getValue (NFC) 2022-06-20 22:59:26 -07:00
TargetInfo.h [CodeGen] Avoid pointer element type access for blocks 2022-03-17 16:56:31 +01:00
VarBypassDetector.cpp
VarBypassDetector.h Use {DenseSet,SmallPtrSet}::contains (NFC) 2021-10-29 20:26:07 -07:00

README.txt

IRgen optimization opportunities.

//===---------------------------------------------------------------------===//

The common pattern of
--
short x; // or char, etc
(x == 10)
--
generates an zext/sext of x which can easily be avoided.

//===---------------------------------------------------------------------===//

Bitfields accesses can be shifted to simplify masking and sign
extension. For example, if the bitfield width is 8 and it is
appropriately aligned then is is a lot shorter to just load the char
directly.

//===---------------------------------------------------------------------===//

It may be worth avoiding creation of alloca's for formal arguments
for the common situation where the argument is never written to or has
its address taken. The idea would be to begin generating code by using
the argument directly and if its address is taken or it is stored to
then generate the alloca and patch up the existing code.

In theory, the same optimization could be a win for block local
variables as long as the declaration dominates all statements in the
block.

NOTE: The main case we care about this for is for -O0 -g compile time
performance, and in that scenario we will need to emit the alloca
anyway currently to emit proper debug info. So this is blocked by
being able to emit debug information which refers to an LLVM
temporary, not an alloca.

//===---------------------------------------------------------------------===//

We should try and avoid generating basic blocks which only contain
jumps. At -O0, this penalizes us all the way from IRgen (malloc &
instruction overhead), all the way down through code generation and
assembly time.

On 176.gcc:expr.ll, it looks like over 12% of basic blocks are just
direct branches!

//===---------------------------------------------------------------------===//