| blob | 60e6841e1b3d695f08c1e97138f02e7225ce9252 |
1 //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This is the internal per-function state used for llvm translation.
10 //
11 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
14 #define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
46 #include <optional>
56 }
88 }
104 /// The kind of evaluation to perform on values of a particular
105 /// type. Basically, is the code in CGExprScalar, CGExprComplex, or
106 /// CGExprAgg?
107 ///
108 /// TODO: should vectors maybe be split out into their own thing?
110 TEK_Scalar,
111 TEK_Complex,
112 TEK_Aggregate
113 };
115 #define LIST_SANITIZER_CHECKS \
116 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
117 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
118 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
119 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
120 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
121 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
122 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
123 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
124 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
125 SANITIZER_CHECK(InvalidObjCCast, invalid_objc_cast, 0) \
126 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
127 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
128 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
129 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
130 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
131 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
132 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
133 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
134 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
135 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
136 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
137 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
138 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
139 SANITIZER_CHECK(AlignmentAssumption, alignment_assumption, 0) \
140 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0) \
141 SANITIZER_CHECK(BoundsSafety, bounds_safety, 0)
144 #define SANITIZER_CHECK(Enum, Name, Version) Enum,
145 LIST_SANITIZER_CHECKS
146 #undef SANITIZER_CHECK
147 };
149 /// Helper class with most of the code for saving a value for a
150 /// conditional expression cleanup.
154 /// Answer whether the given value needs extra work to be saved.
159 // If it's not an instruction, we don't need to save.
162 // If it's an instruction in the entry block, we don't need to save.
165 }
169 };
171 /// A partial specialization of DominatingValue for llvm::Values that
172 /// might be llvm::Instructions.
177 }
178 };
180 /// A specialization of DominatingValue for Address.
187 CharUnits Alignment;
190 };
197 }
202 }
207 }
208 };
210 /// A specialization of DominatingValue for RValue.
221 };
240 // implementations in CGCleanup.cpp
241 };
245 }
248 }
251 }
252 };
254 /// CodeGenFunction - This class organizes the per-function state that is used
255 /// while generating LLVM code.
262 /// A jump destination is an abstract label, branching to which may
263 /// require a jump out through normal cleanups.
275 // This should be used cautiously.
278 }
284 };
289 // For EH/SEH outlined funclets, this field points to parent's CGF
293 LoopInfoStack LoopStack;
294 CGBuilderTy Builder;
296 // Stores variables for which we can't generate correct lifetime markers
297 // because of jumps.
298 VarBypassDetector Bypasses;
300 /// List of recently emitted OMPCanonicalLoops.
301 ///
302 /// Since OMPCanonicalLoops are nested inside other statements (in particular
303 /// CapturedStmt generated by OMPExecutableDirective and non-perfectly nested
304 /// loops), we cannot directly call OMPEmitOMPCanonicalLoop and receive its
305 /// llvm::CanonicalLoopInfo. Instead, we call EmitStmt and any
306 /// OMPEmitOMPCanonicalLoop called by it will add its CanonicalLoopInfo to
307 /// this stack when done. Entering a new loop requires clearing this list; it
308 /// either means we start parsing a new loop nest (in which case the previous
309 /// loop nest goes out of scope) or a second loop in the same level in which
310 /// case it would be ambiguous into which of the two (or more) loops the loop
311 /// nest would extend.
314 /// Stack to track the Logical Operator recursion nest for MC/DC.
317 /// Stack to track the controlled convergence tokens.
320 /// Number of nested loop to be consumed by the last surrounding
321 /// loop-associated directive.
324 // CodeGen lambda for loops and support for ordered clause
326 JumpDest)>
327 CodeGenLoopTy;
330 CodeGenOrderedTy;
332 // Codegen lambda for loop bounds in worksharing loop constructs
335 CodeGenLoopBoundsTy;
337 // Codegen lambda for loop bounds in dispatch-based loop implementation
340 Address UB)>
341 CodeGenDispatchBoundsTy;
343 /// CGBuilder insert helper. This function is called after an
344 /// instruction is created using Builder.
348 /// CurFuncDecl - Holds the Decl for the current outermost
349 /// non-closure context.
351 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
354 QualType FnRetTy;
357 /// Save Parameter Decl for coroutine.
360 // Holds coroutine data if the current function is a coroutine. We use a
361 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
362 // in this header.
368 };
369 CGCoroInfo CurCoro;
373 }
377 }
379 // Holds FramePtr for await_suspend wrapper generation,
380 // so that __builtin_coro_frame call can be lowered
381 // directly to value of its second argument
384 };
385 AwaitSuspendWrapperInfo CurAwaitSuspendWrapper;
387 // Generates wrapper function for `llvm.coro.await.suspend.*` intrinisics.
388 // It encapsulates SuspendExpr in a function, to separate it's body
389 // from the main coroutine to avoid miscompilations. Intrinisic
390 // is lowered to this function call in CoroSplit pass
391 // Function signature is:
392 // <type> __await_suspend_wrapper_<name>(ptr %awaiter, ptr %hdl)
393 // where type is one of (void, i1, ptr)
398 /// CurGD - The GlobalDecl for the current function being compiled.
399 GlobalDecl CurGD;
401 /// PrologueCleanupDepth - The cleanup depth enclosing all the
402 /// cleanups associated with the parameters.
405 /// ReturnBlock - Unified return block.
406 JumpDest ReturnBlock;
408 /// ReturnValue - The temporary alloca to hold the return
409 /// value. This is invalid iff the function has no return value.
412 /// ReturnValuePointer - The temporary alloca to hold a pointer to sret.
413 /// This is invalid if sret is not in use.
416 /// If a return statement is being visited, this holds the return statment's
417 /// result expression.
420 /// Return true if a label was seen in the current scope.
425 }
427 /// AllocaInsertPoint - This is an instruction in the entry block before which
428 /// we prefer to insert allocas.
432 /// PostAllocaInsertPt - This is a place in the prologue where code can be
433 /// inserted that will be dominated by all the static allocas. This helps
434 /// achieve two things:
435 /// 1. Contiguity of all static allocas (within the prologue) is maintained.
436 /// 2. All other prologue code (which are dominated by static allocas) do
437 /// appear in the source order immediately after all static allocas.
438 ///
439 /// PostAllocaInsertPt will be lazily created when it is *really* required.
443 /// Return PostAllocaInsertPt. If it is not yet created, then insert it
444 /// immediately after AllocaInsertPt.
454 }
457 }
459 /// API for captured statement code generation.
479 }
480 }
487 // Retrieve the value of the context parameter.
490 /// Lookup the captured field decl for a variable.
493 }
500 }
502 /// Emit the captured statement body.
506 }
508 /// Get the name of the capture helper.
511 /// Get the CaptureFields
514 }
517 /// The kind of captured statement being generated.
518 CapturedRegionKind Kind;
520 /// Keep the map between VarDecl and FieldDecl.
523 /// The base address of the captured record, passed in as the first
524 /// argument of the parallel region function.
527 /// Captured 'this' type.
529 };
532 /// RAII for correct setting/restoring of CapturedStmtInfo.
542 }
544 };
546 /// An abstract representation of regular/ObjC call/message targets.
548 /// The function declaration of the callee.
557 }
563 }
568 }
569 };
571 /// Sanitizers enabled for this function.
572 SanitizerSet SanOpts;
574 /// True if CodeGen currently emits code implementing sanitizer checks.
577 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
583 };
585 /// In C++, whether we are code generating a thunk. This controls whether we
586 /// should emit cleanups.
589 /// In ARC, whether we should autorelease the return value.
592 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
593 /// potentially set the return value.
596 GlobalDecl CurSEHParent;
598 /// True if the current function is an outlined SEH helper. This can be a
599 /// finally block or filter expression.
602 /// True if CodeGen currently emits code inside presereved access index
603 /// region.
606 /// True if the current statement has nomerge attribute.
609 /// True if the current statement has noinline attribute.
612 /// True if the current statement has always_inline attribute.
615 // The CallExpr within the current statement that the musttail attribute
616 // applies to. nullptr if there is no 'musttail' on the current statement.
619 /// Returns true if a function must make progress, which means the
620 /// mustprogress attribute can be added.
626 // C++11 and later guarantees that a thread eventually will do one of the
627 // following (C++11 [intro.multithread]p24 and C++17 [intro.progress]p1):
628 // - terminate,
629 // - make a call to a library I/O function,
630 // - perform an access through a volatile glvalue, or
631 // - perform a synchronization operation or an atomic operation.
632 //
633 // Hence each function is 'mustprogress' in C++11 or later.
635 }
637 /// Returns true if a loop must make progress, which means the mustprogress
638 /// attribute can be added. \p HasConstantCond indicates whether the branch
639 /// condition is a known constant.
648 /// A mapping from NRVO variables to the flags used to indicate
649 /// when the NRVO has been applied to this variable.
652 EHScopeStack EHStack;
655 // A stack of cleanups which were added to EHStack but have to be deactivated
656 // later before being popped or emitted. These are usually deactivated on
657 // exiting a `CleanupDeactivationScope` scope. For instance, after a
658 // full-expr.
659 //
660 // These are specially useful for correctly emitting cleanups while
661 // encountering branches out of expression (through stmt-expr or coroutine
662 // suspensions).
666 };
669 // Enters a new scope for capturing cleanups which are deferred to be
670 // deactivated, all of which will be deactivated once the scope is exited.
687 }
690 }
696 }
697 };
715 }
716 };
718 /// Header for data within LifetimeExtendedCleanupStack.
720 /// The size of the following cleanup object.
722 /// The kind of cleanup to push.
725 /// Whether this is a conditional cleanup.
732 };
734 /// i32s containing the indexes of the cleanup destinations.
739 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
742 /// The exception slot. All landing pads write the current exception pointer
743 /// into this alloca.
746 /// The selector slot. Under the MandatoryCleanup model, all landing pads
747 /// write the current selector value into this alloca.
750 /// A stack of exception code slots. Entering an __except block pushes a slot
751 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
752 /// a value from the top of the stack.
755 /// Value returned by __exception_info intrinsic.
758 /// Emits a landing pad for the current EH stack.
763 /// Parent loop-based directive for scan directive.
771 /// Manages parent directive for scan directives.
783 }
786 }
787 };
792 }
803 FPOptions OldFPFeatures;
807 };
808 FPOptions CurFPFeatures;
811 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
812 /// rethrows.
815 /// A class controlling the emission of a finally block.
817 /// Where the catchall's edge through the cleanup should go.
818 JumpDest RethrowDest;
820 /// A function to call to enter the catch.
823 /// An i1 variable indicating whether or not the @finally is
824 /// running for an exception.
827 /// An i8* variable into which the exception pointer to rethrow
828 /// has been saved.
836 };
838 /// Returns true inside SEH __try blocks.
841 /// Returns true while emitting a cleanuppad.
844 }
846 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
847 /// current full-expression. Safe against the possibility that
848 /// we're currently inside a conditionally-evaluated expression.
851 // If we're not in a conditional branch, or if none of the
852 // arguments requires saving, then use the unconditional cleanup.
856 // Stash values in a tuple so we can guarantee the order of saves.
863 }
865 /// Queue a cleanup to be pushed after finishing the current full-expression,
866 /// potentially with an active flag.
882 }
902 }
904 // Push a cleanup onto EHStack and deactivate it later. It is usually
905 // deactivated when exiting a `CleanupDeactivationScope` (for example: after a
906 // full expression).
909 // Placeholder dominating IP for this cleanup.
915 }
917 /// Set up the last cleanup that was pushed as a conditional
918 /// full-expression cleanup.
921 }
926 /// PushDestructorCleanup - Push a cleanup to call the
927 /// complete-object destructor of an object of the given type at the
928 /// given address. Does nothing if T is not a C++ class type with a
929 /// non-trivial destructor.
932 /// PushDestructorCleanup - Push a cleanup to call the
933 /// complete-object variant of the given destructor on the object at
934 /// the given address.
936 Address Addr);
938 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
939 /// process all branch fixups.
943 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
944 /// The block cannot be reactivated. Pops it if it's the top of the
945 /// stack.
946 ///
947 /// \param DominatingIP - An instruction which is known to
948 /// dominate the current IP (if set) and which lies along
949 /// all paths of execution between the current IP and the
950 /// the point at which the cleanup comes into scope.
954 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
955 /// Cannot be used to resurrect a deactivated cleanup.
956 ///
957 /// \param DominatingIP - An instruction which is known to
958 /// dominate the current IP (if set) and which lies along
959 /// all paths of execution between the current IP and the
960 /// the point at which the cleanup comes into scope.
964 /// Enters a new scope for capturing cleanups, all of which
965 /// will be executed once the scope is exited.
969 CleanupDeactivationScope DeactivateCleanups;
982 /// Enter a new cleanup scope.
986 LifetimeExtendedCleanupStackSize =
992 }
994 /// Exit this cleanup scope, emitting any accumulated cleanups.
998 }
1000 /// Determine whether this scope requires any cleanups.
1003 }
1005 /// Force the emission of cleanups now, instead of waiting
1006 /// until this object is destroyed.
1007 /// \param ValuesToReload - A list of values that need to be available at
1008 /// the insertion point after cleanup emission. If cleanup emission created
1009 /// a shared cleanup block, these value pointers will be rewritten.
1010 /// Otherwise, they not will be modified.
1016 ValuesToReload);
1019 }
1020 };
1022 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
1027 SourceRange Range;
1035 /// Enter a new cleanup scope.
1041 }
1046 }
1048 /// Exit this cleanup scope, emitting any accumulated
1049 /// cleanups.
1054 // If we should perform a cleanup, force them now. Note that
1055 // this ends the cleanup scope before rescoping any labels.
1059 }
1060 }
1062 /// Force the emission of cleanups now, instead of waiting
1063 /// until this object is destroyed.
1070 }
1074 }
1077 };
1081 /// The class used to assign some variables some temporarily addresses.
1083 DeclMapTy SavedLocals;
1084 DeclMapTy SavedTempAddresses;
1092 };
1094 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
1095 /// function \p CGF.
1096 /// \return true if at least one variable was set already, false otherwise.
1098 Address TempAddr) {
1100 // Only save it once.
1103 // Copy the existing local entry to SavedLocals.
1107 else
1110 // Generate the private entry.
1116 }
1120 }
1122 /// Applies new addresses to the list of the variables.
1123 /// \return true if at least one variable is using new address, false
1124 /// otherwise.
1129 }
1131 /// Restores original addresses of the variables.
1136 }
1137 }
1140 /// Copy all the entries in the source map over the corresponding
1141 /// entries in the destination, which must exist.
1147 }
1152 else
1154 }
1155 }
1156 };
1158 /// The scope used to remap some variables as private in the OpenMP loop body
1159 /// (or other captured region emitted without outlining), and to restore old
1160 /// vars back on exit.
1162 OMPMapVars MappedVars;
1167 /// Enter a new OpenMP private scope.
1170 /// Registers \p LocalVD variable as a private with \p Addr as the address
1171 /// of the corresponding private variable. \p
1172 /// PrivateGen is the address of the generated private variable.
1173 /// \return true if the variable is registered as private, false if it has
1174 /// been privatized already.
1178 }
1180 /// Privatizes local variables previously registered as private.
1181 /// Registration is separate from the actual privatization to allow
1182 /// initializers use values of the original variables, not the private one.
1183 /// This is important, for example, if the private variable is a class
1184 /// variable initialized by a constructor that references other private
1185 /// variables. But at initialization original variables must be used, not
1186 /// private copies.
1187 /// \return true if at least one variable was privatized, false otherwise.
1193 }
1195 /// Exit scope - all the mapped variables are restored.
1199 }
1201 /// Checks if the global variable is captured in current function.
1205 }
1207 /// Restore all mapped variables w/o clean up. This is usefully when we want
1208 /// to reference the original variables but don't want the clean up because
1209 /// that could emit lifetime end too early, causing backend issue #56913.
1211 };
1213 /// Save/restore original map of previously emitted local vars in case when we
1214 /// need to duplicate emission of the same code several times in the same
1215 /// function for OpenMP code.
1218 DeclMapTy SavedMap;
1224 };
1226 /// Takes the old cleanup stack size and emits the cleanup blocks
1227 /// that have been added.
1228 void
1232 /// Takes the old cleanup stack size and emits the cleanup blocks
1233 /// that have been added, then adds all lifetime-extended cleanups from
1234 /// the given position to the stack.
1235 void
1242 /// The given basic block lies in the current EH scope, but may be a
1243 /// target of a potentially scope-crossing jump; get a stable handle
1244 /// to which we can perform this jump later.
1248 NextCleanupDestIndex++);
1249 }
1251 /// The given basic block lies in the current EH scope, but may be a
1252 /// target of a potentially scope-crossing jump; get a stable handle
1253 /// to which we can perform this jump later.
1256 }
1258 /// EmitBranchThroughCleanup - Emit a branch from the current insert
1259 /// block through the normal cleanup handling code (if any) and then
1260 /// on to \arg Dest.
1263 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
1264 /// specified destination obviously has no cleanups to run. 'false' is always
1265 /// a conservatively correct answer for this method.
1268 /// popCatchScope - Pops the catch scope at the top of the EHScope
1269 /// stack, emitting any required code (other than the catch handlers
1270 /// themselves).
1278 /// An object to manage conditionally-evaluated expressions.
1290 }
1296 }
1298 /// Returns a block which will be executed prior to each
1299 /// evaluation of the conditional code.
1302 }
1303 };
1305 /// isInConditionalBranch - Return true if we're currently emitting
1306 /// one branch or the other of a conditional expression.
1316 }
1318 /// An RAII object to record that we're evaluating a statement
1319 /// expression.
1323 /// We have to save the outermost conditional: cleanups in a
1324 /// statement expression aren't conditional just because the
1325 /// StmtExpr is.
1332 }
1337 }
1338 };
1340 /// An object which temporarily prevents a value from being
1341 /// destroyed by aggressive peephole optimizations that assume that
1342 /// all uses of a value have been realized in the IR.
1349 };
1351 /// A non-RAII class containing all the information about a bound
1352 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1353 /// this which makes individual mappings very simple; using this
1354 /// class directly is useful when you have a variable number of
1355 /// opaque values or don't want the RAII functionality for some
1356 /// reason.
1369 // gl-values should be bound as l-values for obvious reasons.
1370 // Records should be bound as l-values because IR generation
1371 // always keeps them in memory. Expressions of function type
1372 // act exactly like l-values but are formally required to be
1373 // r-values in C.
1377 }
1385 }
1393 }
1403 // Work around an extremely aggressive peephole optimization in
1404 // EmitScalarConversion which assumes that all other uses of a
1405 // value are extant.
1409 }
1422 }
1423 }
1424 };
1426 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1429 OpaqueValueMappingData Data;
1434 }
1436 /// Build the opaque value mapping for the given conditional
1437 /// operator if it's the GNU ?: extension. This is a common
1438 /// enough pattern that the convenience operator is really
1439 /// helpful.
1440 ///
1444 // Leave Data empty.
1450 }
1452 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1453 /// expression is set to the expression the OVE represents.
1460 }
1461 }
1465 LValue lvalue)
1467 }
1471 RValue rvalue)
1473 }
1478 }
1482 }
1483 };
1487 /// Used to create unique names for artificial VLA size debug info variables.
1491 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1492 /// calling llvm.stacksave for multiple VLAs in the same scope.
1495 /// IndirectBranch - The first time an indirect goto is seen we create a block
1496 /// with an indirect branch. Every time we see the address of a label taken,
1497 /// we add the label to the indirect goto. Every subsequent indirect goto is
1498 /// codegen'd as a jump to the IndirectBranch's basic block.
1501 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1502 /// decls.
1503 DeclMapTy LocalDeclMap;
1505 // Keep track of the cleanups for callee-destructed parameters pushed to the
1506 // cleanup stack so that they can be deactivated later.
1508 CalleeDestructedParamCleanups;
1510 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1511 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1512 /// parameter.
1514 SizeArguments;
1516 /// Track escaped local variables with auto storage. Used during SEH
1517 /// outlining to produce a call to llvm.localescape.
1520 /// LabelMap - This keeps track of the LLVM basic block for each C label.
1523 // BreakContinueStack - This keeps track of where break and continue
1524 // statements should jump to.
1529 JumpDest BreakBlock;
1530 JumpDest ContinueBlock;
1531 };
1534 /// Handles cancellation exit points in OpenMP-related constructs.
1536 /// Tracks cancellation exit point and join point for cancel-related exit
1537 /// and normal exit.
1541 JumpDest ContBlock)
1544 /// true if the exit block has been emitted already by the special
1545 /// emitExit() call, false if the default codegen is used.
1547 JumpDest ExitBlock;
1548 JumpDest ContBlock;
1549 };
1556 /// Fetches the exit block for the current OpenMP construct.
1558 /// Emits exit block with special codegen procedure specific for the related
1559 /// OpenMP construct + emits code for normal construct cleanup.
1572 }
1574 }
1575 /// Enter the cancel supporting \a Kind construct.
1576 /// \param Kind OpenMP directive that supports cancel constructs.
1577 /// \param HasCancel true, if the construct has inner cancel directive,
1578 /// false otherwise.
1585 }
1586 /// Emits default exit point for the cancel construct (if the special one
1587 /// has not be used) + join point for cancel/normal exits.
1597 }
1602 }
1603 }
1605 }
1606 };
1607 OpenMPCancelExitStack OMPCancelStack;
1609 /// Lower the Likelihood knowledge about the \p Cond via llvm.expect intrin.
1613 CodeGenPGO PGO;
1615 /// Bitmap used by MC/DC to track condition outcomes of a boolean expression.
1618 /// Calculate branch weights appropriate for PGO data
1626 /// Increment the profiler's counter for the given statement by \p StepV.
1627 /// If \p StepV is null, the default increment is 1.
1634 }
1636 }
1642 }
1644 /// Allocate a temp value on the stack that MCDC can use to track condition
1645 /// results.
1649 MCDCCondBitmapAddr =
1651 }
1652 }
1657 }
1659 /// Zero-init the MCDC temp value.
1664 }
1665 }
1667 /// Increment the profiler's counter for the given expression by \p StepV.
1668 /// If \p StepV is null, the default increment is 1.
1673 }
1674 }
1676 /// Update the MCDC temp value with the condition's evaluated result.
1681 }
1682 }
1684 /// Get the profiler's count for the given statement.
1687 }
1689 /// Set the profiler's current count.
1692 }
1694 /// Get the profiler's current count. This is generally the count for the most
1695 /// recently incremented counter.
1698 }
1702 /// SwitchInsn - This is nearest current switch instruction. It is null if
1703 /// current context is not in a switch.
1705 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1708 /// The likelihood attributes of the SwitchCase.
1711 /// CaseRangeBlock - This block holds if condition check for last case
1712 /// statement range in current switch instruction.
1715 /// OpaqueLValues - Keeps track of the current set of opaque value
1716 /// expressions.
1720 // VLASizeMap - This keeps track of the associated size for each VLA type.
1721 // We track this by the size expression rather than the type itself because
1722 // in certain situations, like a const qualifier applied to an VLA typedef,
1723 // multiple VLA types can share the same size expression.
1724 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1725 // enter/leave scopes.
1728 /// A block containing a single 'unreachable' instruction. Created
1729 /// lazily by getUnreachableBlock().
1732 /// Counts of the number return expressions in the function.
1735 /// Count the number of simple (constant) return expressions in the function.
1738 /// The last regular (non-return) debug location (breakpoint) in the function.
1739 SourceLocation LastStopPoint;
1742 /// Source location information about the default argument or member
1743 /// initializer expression we're evaluating, if any.
1744 CurrentSourceLocExprScope CurSourceLocExprScope;
1748 /// A scope within which we are constructing the fields of an object which
1749 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1750 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1756 }
1759 }
1763 Address OldCXXDefaultInitExprThis;
1764 };
1766 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1767 /// is overridden to be the object under construction.
1776 }
1780 }
1785 CharUnits OldCXXThisAlignment;
1786 SourceLocExprScopeGuard SourceLocScope;
1787 };
1792 };
1794 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1795 /// current loop index is overridden.
1801 }
1804 }
1809 };
1835 }
1849 }
1853 GlobalDecl OldCurGD;
1859 CharUnits OldCXXABIThisAlignment;
1860 CharUnits OldCXXThisAlignment;
1861 Address OldReturnValue;
1862 QualType OldFnRetTy;
1863 CallArgList OldCXXInheritedCtorInitExprArgs;
1864 };
1866 // Helper class for the OpenMP IR Builder. Allows reusability of code used for
1867 // region body, and finalization codegen callbacks. This will class will also
1868 // contain privatization functions used by the privatization call backs
1869 //
1870 // TODO: this is temporary class for things that are being moved out of
1871 // CGOpenMPRuntime, new versions of current CodeGenFunction methods, or
1872 // utility function for use with the OMPBuilder. Once that move to use the
1873 // OMPBuilder is done, everything here will either become part of CodeGenFunc.
1874 // directly, or a new helper class that will contain functions used by both
1875 // this and the OMPBuilder
1885 /// Cleanup action for allocate support.
1894 }
1900 }
1901 };
1903 /// Returns address of the threadprivate variable for the current
1904 /// thread. This Also create any necessary OMP runtime calls.
1905 ///
1906 /// \param VD VarDecl for Threadprivate variable.
1907 /// \param VDAddr Address of the Vardecl
1908 /// \param Loc The location where the barrier directive was encountered
1911 SourceLocation Loc);
1913 /// Gets the OpenMP-specific address of the local variable /p VD.
1916 /// Get the platform-specific name separator.
1917 /// \param Parts different parts of the final name that needs separation
1918 /// \param FirstSeparator First separator used between the initial two
1919 /// parts of the name.
1920 /// \param Separator separator used between all of the rest consecutinve
1921 /// parts of the name
1925 /// Emit the Finalization for an OMP region
1926 /// \param CGF The Codegen function this belongs to
1927 /// \param IP Insertion point for generating the finalization code.
1937 // erase and replace with cleanup branch.
1942 }
1944 /// Emit the body of an OMP region
1945 /// \param CGF The Codegen function this belongs to
1946 /// \param RegionBodyStmt The body statement for the OpenMP region being
1947 /// generated
1948 /// \param AllocaIP Where to insert alloca instructions
1949 /// \param CodeGenIP Where to insert the region code
1950 /// \param RegionName Name to be used for new blocks
1953 InsertPointTy AllocaIP,
1954 InsertPointTy CodeGenIP,
1955 Twine RegionName);
1968 else
1973 }
1975 /// Emit the body of an OMP region that will be outlined in
1976 /// OpenMPIRBuilder::finalize().
1977 /// \param CGF The Codegen function this belongs to
1978 /// \param RegionBodyStmt The body statement for the OpenMP region being
1979 /// generated
1980 /// \param AllocaIP Where to insert alloca instructions
1981 /// \param CodeGenIP Where to insert the region code
1982 /// \param RegionName Name to be used for new blocks
1985 InsertPointTy AllocaIP,
1986 InsertPointTy CodeGenIP,
1987 Twine RegionName);
1989 /// RAII for preserving necessary info during Outlined region body codegen.
2007 }
2012 }
2013 };
2015 /// RAII for preserving necessary info during inlined region body codegen.
2025 // Alloca insertion block should be in the entry block of the containing
2026 // function so it expects an empty AllocaIP in which case will reuse the
2027 // old alloca insertion point, or a new AllocaIP in the same block as
2028 // the old one
2031 "Insertion point should be in the entry block of containing "
2037 // TODO: Remove the call, after making sure the counter is not used by
2038 // the EHStack.
2039 // Since this is an inlined region, it should not modify the
2040 // ReturnBlock, and should reuse the one for the enclosing outlined
2041 // region. So, the JumpDest being return by the function is discarded
2043 }
2046 };
2047 };
2050 /// CXXThisDecl - When generating code for a C++ member function,
2051 /// this will hold the implicit 'this' declaration.
2055 CharUnits CXXABIThisAlignment;
2056 CharUnits CXXThisAlignment;
2058 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
2059 /// this expression.
2062 /// The current array initialization index when evaluating an
2063 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
2066 /// The values of function arguments to use when evaluating
2067 /// CXXInheritedCtorInitExprs within this context.
2068 CallArgList CXXInheritedCtorInitExprArgs;
2070 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
2071 /// destructor, this will hold the implicit argument (e.g. VTT).
2075 /// OutermostConditional - Points to the outermost active
2076 /// conditional control. This is used so that we know if a
2077 /// temporary should be destroyed conditionally.
2080 /// The current lexical scope.
2083 /// The current source location that should be used for exception
2084 /// handling code.
2085 SourceLocation CurEHLocation;
2087 /// BlockByrefInfos - For each __block variable, contains
2088 /// information about the layout of the variable.
2091 /// Used by -fsanitize=nullability-return to determine whether the return
2092 /// value can be checked.
2095 /// Check if -fsanitize=nullability-return instrumentation is required for
2096 /// this function.
2099 }
2101 /// Used to store precise source locations for return statements by the
2102 /// runtime return value checks.
2105 /// Check if the return value of this function requires sanitization.
2115 /// Terminate funclets keyed by parent funclet pad.
2118 /// Largest vector width used in ths function. Will be used to create a
2119 /// function attribute.
2122 /// True if we need emit the life-time markers. This is initially set in
2123 /// the constructor, but could be overwritten to true if this is a coroutine.
2126 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
2127 /// the function metadata.
2140 }
2146 }
2150 /// Returns a pointer to the function's exception object and selector slot,
2151 /// which is assigned in every landing pad.
2155 /// Returns the contents of the function's exception object and selector
2156 /// slots.
2166 }
2168 }
2173 }
2181 }
2183 //===--------------------------------------------------------------------===//
2184 // Cleanups
2185 //===--------------------------------------------------------------------===//
2190 Address arrayEndPointer,
2191 QualType elementType,
2192 CharUnits elementAlignment,
2196 QualType elementType,
2197 CharUnits elementAlignment,
2216 QualType ElementType);
2233 /// Determines whether an EH cleanup is required to destroy a type
2234 /// with the given destruction kind.
2246 }
2248 }
2252 }
2254 //===--------------------------------------------------------------------===//
2255 // Objective-C
2256 //===--------------------------------------------------------------------===//
2262 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
2273 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
2274 /// for the given property.
2281 //===--------------------------------------------------------------------===//
2282 // Block Bits
2283 //===--------------------------------------------------------------------===//
2285 /// Emit block literal.
2286 /// \return an LLVM value which is a pointer to a struct which contains
2287 /// information about the block, including the block invoke function, the
2288 /// captured variables, etc.
2297 /// Check if \p T is a C++ class that has a destructor that can throw.
2315 /// Enter a cleanup to destroy a __block variable. Note that this
2316 /// cleanup should be a no-op if the variable hasn't left the stack
2317 /// yet; if a cleanup is required for the variable itself, that needs
2318 /// to be done externally.
2319 ///
2320 /// \param Kind Cleanup kind.
2321 ///
2322 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
2323 /// structure that will be passed to _Block_object_dispose. When
2324 /// \p LoadBlockVarAddr is true, the address of the field of the block
2325 /// structure that holds the address of the __block structure.
2326 ///
2327 /// \param Flags The flag that will be passed to _Block_object_dispose.
2328 ///
2329 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
2330 /// \p Addr to get the address of the __block structure.
2340 /// BuildBlockByrefAddress - Computes the location of the
2341 /// data in a variable which is declared as __block.
2356 /// Annotate the function with an attribute that disables TSan checking at
2357 /// runtime.
2360 /// Emit code for the start of a function.
2361 /// \param Loc The location to be associated with the function.
2362 /// \param StartLoc The location of the function body.
2364 QualType RetTy,
2393 }
2396 /// Emit the unified return block, trying to avoid its emission when
2397 /// possible.
2398 /// \return The debug location of the user written return statement if the
2399 /// return block is avoided.
2402 /// FinishFunction - Complete IR generation of the current function. It is
2403 /// legal to call this function even if there is no current insertion point.
2414 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
2418 /// Generate a thunk for the given method.
2432 /// Struct with all information about dynamic [sub]class needed to set vptr.
2434 BaseSubobject Base;
2436 CharUnits OffsetFromNearestVBase;
2438 };
2440 /// Initialize the vtable pointer of the given subobject.
2449 CharUnits OffsetFromNearestVBase,
2456 // VTableTrapMode - whether we guarantee that loading the
2457 // vtable is guaranteed to trap on authentication failure,
2458 // even if the resulting vtable pointer is unused.
2460 Authenticate,
2461 MustTrap,
2462 UnsafeUbsanStrip // Should only be used for Vptr UBSan check
2463 };
2464 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
2465 /// to by This.
2472 CFITCK_VCall,
2473 CFITCK_NVCall,
2474 CFITCK_DerivedCast,
2475 CFITCK_UnrelatedCast,
2476 CFITCK_ICall,
2477 CFITCK_NVMFCall,
2478 CFITCK_VMFCall,
2479 };
2481 /// Derived is the presumed address of an object of type T after a
2482 /// cast. If T is a polymorphic class type, emit a check that the virtual
2483 /// table for Derived belongs to a class derived from T.
2487 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
2488 /// If vptr CFI is enabled, emit a check that VTable is valid.
2492 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
2493 /// RD using llvm.type.test.
2497 /// If whole-program virtual table optimization is enabled, emit an assumption
2498 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
2499 /// enabled, emit a check that VTable is a member of RD's type identifier.
2503 /// Returns whether we should perform a type checked load when loading a
2504 /// virtual function for virtual calls to members of RD. This is generally
2505 /// true when both vcall CFI and whole-program-vtables are enabled.
2508 /// Emit a type checked load from the given vtable.
2514 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
2515 /// given phase of destruction for a destructor. The end result
2516 /// should call destructors on members and base classes in reverse
2517 /// order of their construction.
2520 /// ShouldInstrumentFunction - Return true if the current function should be
2521 /// instrumented with __cyg_profile_func_* calls
2524 /// ShouldSkipSanitizerInstrumentation - Return true if the current function
2525 /// should not be instrumented with sanitizers.
2528 /// ShouldXRayInstrument - Return true if the current function should be
2529 /// instrumented with XRay nop sleds.
2532 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
2533 /// XRay custom event handling calls.
2536 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
2537 /// XRay typed event handling calls.
2540 /// Return a type hash constant for a function instrumented by
2541 /// -fsanitize=function.
2544 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
2545 /// arguments for the given function. This is also responsible for naming the
2546 /// LLVM function arguments.
2551 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
2552 /// given temporary.
2554 SourceLocation EndLoc);
2556 /// Emit a test that checks if the return value \p RV is nonnull.
2559 /// EmitStartEHSpec - Emit the start of the exception spec.
2562 /// EmitEndEHSpec - Emit the end of the exception spec.
2565 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
2568 /// getTerminateLandingPad - Return a cleanup funclet that just calls
2569 /// terminate.
2572 /// getTerminateHandler - Return a handler (not a landing pad, just
2573 /// a catch handler) that just calls terminate. This is used when
2574 /// a terminate scope encloses a try.
2583 }
2585 /// LoadObjCSelf - Load the value of self. This function is only valid while
2586 /// generating code for an Objective-C method.
2589 /// TypeOfSelfObject - Return type of object that this self represents.
2592 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
2597 }
2601 }
2603 /// createBasicBlock - Create an LLVM basic block.
2608 }
2610 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2611 /// label maps to.
2614 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2615 /// another basic block, simplify it. This assumes that no other code could
2616 /// potentially reference the basic block.
2619 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2620 /// adding a fall-through branch from the current insert block if
2621 /// necessary. It is legal to call this function even if there is no current
2622 /// insertion point.
2623 ///
2624 /// IsFinished - If true, indicates that the caller has finished emitting
2625 /// branches to the given block and does not expect to emit code into it. This
2626 /// means the block can be ignored if it is unreachable.
2629 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2630 /// near its uses, and leave the insertion point in it.
2633 /// EmitBranch - Emit a branch to the specified basic block from the current
2634 /// insert block, taking care to avoid creation of branches from dummy
2635 /// blocks. It is legal to call this function even if there is no current
2636 /// insertion point.
2637 ///
2638 /// This function clears the current insertion point. The caller should follow
2639 /// calls to this function with calls to Emit*Block prior to generation new
2640 /// code.
2643 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2644 /// indicates that the current code being emitted is unreachable.
2647 }
2649 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2650 /// emitted IR has a place to go. Note that by definition, if this function
2651 /// creates a block then that block is unreachable; callers may do better to
2652 /// detect when no insertion point is defined and simply skip IR generation.
2656 }
2658 /// ErrorUnsupported - Print out an error that codegen doesn't support the
2659 /// specified stmt yet.
2662 //===--------------------------------------------------------------------===//
2663 // Helpers
2664 //===--------------------------------------------------------------------===//
2670 QualType MergedType) {
2678 }
2680 /// Construct an address with the natural alignment of T. If a pointer to T
2681 /// is expected to be signed, the pointer passed to this function must have
2682 /// been signed, and the returned Address will have the pointer authentication
2683 /// information needed to authenticate the signed pointer.
2690 Alignment =
2694 IsKnownNonNull);
2695 }
2701 }
2704 TBAAAccessInfo TBAAInfo) {
2706 }
2712 }
2714 /// Same as MakeAddrLValue above except that the pointer is known to be
2715 /// unsigned.
2721 }
2723 LValue
2728 }
2730 /// Given a value of type T* that may not be to a complete object, construct
2731 /// an l-value with the natural pointee alignment of T.
2734 LValue
2738 /// Same as MakeNaturalAlignPointeeAddrLValue except that the pointer is known
2739 /// to be unsigned.
2749 AlignmentSource Source =
2754 }
2756 /// Load a pointer with type \p PtrTy stored at address \p Ptr.
2757 /// Note that \p PtrTy is the type of the loaded pointer, not the addresses
2758 /// it is loaded from.
2771 };
2775 // Captures all the allocas created during the scope of its RAII object.
2780 }
2788 AllocaTracker Tracker;
2789 };
2791 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2792 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2793 /// insertion point of the builder. The caller is responsible for setting an
2794 /// appropriate alignment on
2795 /// the alloca.
2796 ///
2797 /// \p ArraySize is the number of array elements to be allocated if it
2798 /// is not nullptr.
2799 ///
2800 /// LangAS::Default is the address space of pointers to local variables and
2801 /// temporaries, as exposed in the source language. In certain
2802 /// configurations, this is not the same as the alloca address space, and a
2803 /// cast is needed to lift the pointer from the alloca AS into
2804 /// LangAS::Default. This can happen when the target uses a restricted
2805 /// address space for the stack but the source language requires
2806 /// LangAS::Default to be a generic address space. The latter condition is
2807 /// common for most programming languages; OpenCL is an exception in that
2808 /// LangAS::Default is the private address space, which naturally maps
2809 /// to the stack.
2810 ///
2811 /// Because the address of a temporary is often exposed to the program in
2812 /// various ways, this function will perform the cast. The original alloca
2813 /// instruction is returned through \p Alloca if it is not nullptr.
2814 ///
2815 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
2816 /// more efficient if the caller knows that the address will not be exposed.
2827 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2828 /// default ABI alignment of the given LLVM type.
2829 ///
2830 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2831 /// any given AST type that happens to have been lowered to the
2832 /// given IR type. This should only ever be used for function-local,
2833 /// IR-driven manipulations like saving and restoring a value. Do
2834 /// not hand this address off to arbitrary IRGen routines, and especially
2835 /// do not pass it as an argument to a function that might expect a
2836 /// properly ABI-aligned value.
2840 /// CreateIRTemp - Create a temporary IR object of the given type, with
2841 /// appropriate alignment. This routine should only be used when an temporary
2842 /// value needs to be stored into an alloca (for example, to avoid explicit
2843 /// PHI construction), but the type is the IR type, not the type appropriate
2844 /// for storing in memory.
2845 ///
2846 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2847 /// ConvertType instead of ConvertTypeForMem.
2850 /// CreateMemTemp - Create a temporary memory object of the given type, with
2851 /// appropriate alignmen and cast it to the default address space. Returns
2852 /// the original alloca instruction by \p Alloca if it is not nullptr.
2859 /// CreateMemTemp - Create a temporary memory object of the given type, with
2860 /// appropriate alignmen without casting it to the default address space.
2865 /// CreateAggTemp - Create a temporary memory object for the given
2866 /// aggregate type.
2873 }
2875 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2876 /// expression and compare the result against zero, returning an Int1Ty value.
2879 /// Retrieve the implicit cast expression of the rhs in a binary operator
2880 /// expression by passing pointers to Value and QualType
2881 /// This is used for implicit bitfield conversion checks, which
2882 /// must compare with the value before potential truncation.
2887 /// Emit a check that an [implicit] conversion of a bitfield. It is not UB,
2888 /// so we use the value after conversion.
2892 SourceLocation Loc);
2894 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2897 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2898 /// any type. The result is returned as an RValue struct. If this is an
2899 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2900 /// the result should be returned.
2901 ///
2902 /// \param ignoreResult True if the resulting value isn't used.
2907 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2908 // or the value of the expression, depending on how va_list is defined.
2911 /// Emit a "reference" to a __builtin_ms_va_list; this is
2912 /// always the value of the expression, because a __builtin_ms_va_list is a
2913 /// pointer to a char.
2916 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
2917 /// always be accessible even if no aggregate location is provided.
2920 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
2921 /// arbitrary expression into the given memory location.
2927 /// EmitExprAsInit - Emits the code necessary to initialize a
2928 /// location in memory with the given initializer.
2932 /// hasVolatileMember - returns true if aggregate type has a volatile
2933 /// member.
2938 }
2940 }
2942 /// Determine whether a return value slot may overlap some other object.
2944 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2945 // class subobjects. These cases may need to be revisited depending on the
2946 // resolution of the relevant core issue.
2948 }
2950 /// Determine whether a field initialization may overlap some other object.
2953 /// Determine whether a base class initialization may overlap some other
2954 /// object.
2959 /// Emit an aggregate assignment.
2963 }
2968 }
2970 /// EmitAggregateCopy - Emit an aggregate copy.
2971 ///
2972 /// \param isVolatile \c true iff either the source or the destination is
2973 /// volatile.
2974 /// \param MayOverlap Whether the tail padding of the destination might be
2975 /// occupied by some other object. More efficient code can often be
2976 /// generated if not.
2981 /// GetAddrOfLocalVar - Return the address of a local variable.
2987 }
2989 /// Given an opaque value expression, return its LValue mapping if it exists,
2990 /// otherwise create one.
2993 /// Given an opaque value expression, return its RValue mapping if it exists,
2994 /// otherwise create one.
2997 /// Get the index of the current ArrayInitLoopExpr, if any.
3000 /// getAccessedFieldNo - Given an encoded value and a result number, return
3001 /// the input field number being accessed.
3007 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
3010 /// EmitNullInitialization - Generate code to set a value of the given type to
3011 /// null, If the type contains data member pointers, they will be initialized
3012 /// to -1 in accordance with the Itanium C++ ABI.
3015 /// Emits a call to an LLVM variable-argument intrinsic, either
3016 /// \c llvm.va_start or \c llvm.va_end.
3017 /// \param ArgValue A reference to the \c va_list as emitted by either
3018 /// \c EmitVAListRef or \c EmitMSVAListRef.
3019 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
3020 /// calls \c llvm.va_end.
3023 /// Generate code to get an argument from the passed in pointer
3024 /// and update it accordingly.
3025 /// \param VE The \c VAArgExpr for which to generate code.
3026 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
3027 /// either \c EmitVAListRef or \c EmitMSVAListRef.
3028 /// \returns A pointer to the argument.
3029 // FIXME: We should be able to get rid of this method and use the va_arg
3030 // instruction in LLVM instead once it works well enough.
3034 /// emitArrayLength - Compute the length of an array, even if it's a
3035 /// VLA, and drill down to the base element type.
3040 /// EmitVLASize - Capture all the sizes for the VLA expressions in
3041 /// the given variably-modified type and store them in the VLASizeMap.
3042 ///
3043 /// This function can be called with a null (unreachable) insert point.
3048 QualType Type;
3051 };
3053 /// Return the number of elements for a single dimension
3054 /// for the given array type.
3058 /// Returns an LLVM value that corresponds to the size,
3059 /// in non-variably-sized elements, of a variable length array type,
3060 /// plus that largest non-variably-sized element type. Assumes that
3061 /// the type has already been emitted with EmitVariablyModifiedType.
3065 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
3066 /// generating code for an C++ member function.
3070 }
3073 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
3074 /// virtual bases.
3075 // FIXME: Every place that calls LoadCXXVTT is something
3076 // that needs to be abstracted properly.
3080 }
3082 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
3083 /// complete class to the given direct base.
3084 Address
3092 /// GetAddressOfBaseClass - This function will add the necessary delta to the
3093 /// load of 'this' and returns address of the base class.
3106 /// GetVTTParameter - Return the VTT parameter that should be passed to a
3107 /// base constructor/destructor with virtual bases.
3108 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
3109 /// to ItaniumCXXABI.cpp together with all the references to VTT.
3114 CXXCtorType CtorType,
3116 SourceLocation Loc);
3117 // It's important not to confuse this and the previous function. Delegating
3118 // constructors are the C++0x feature. The constructor delegate optimization
3119 // is used to reduce duplication in the base and complete consturctors where
3120 // they are substantially the same.
3124 /// Emit a call to an inheriting constructor (that is, one that invokes a
3125 /// constructor inherited from a base class) by inlining its definition. This
3126 /// is necessary if the ABI does not support forwarding the arguments to the
3127 /// base class constructor (because they're variadic or similar).
3129 CXXCtorType CtorType,
3134 /// Emit a call to a constructor inherited from a base class, passing the
3135 /// current constructor's arguments along unmodified (without even making
3136 /// a copy).
3152 /// Emit assumption load for all bases. Requires to be called only on
3153 /// most-derived class and not under construction of the object.
3156 /// Emit assumption that vptr load == global vtable.
3165 Address ArrayPtr,
3172 Address ArrayPtr,
3181 QualType ThisTy);
3189 Address Ptr);
3213 /// Situations in which we might emit a check for the suitability of a
3214 /// pointer or glvalue. Needs to be kept in sync with ubsan_handlers.cpp in
3215 /// compiler-rt.
3217 /// Checking the operand of a load. Must be suitably sized and aligned.
3218 TCK_Load,
3219 /// Checking the destination of a store. Must be suitably sized and aligned.
3220 TCK_Store,
3221 /// Checking the bound value in a reference binding. Must be suitably sized
3222 /// and aligned, but is not required to refer to an object (until the
3223 /// reference is used), per core issue 453.
3224 TCK_ReferenceBinding,
3225 /// Checking the object expression in a non-static data member access. Must
3226 /// be an object within its lifetime.
3227 TCK_MemberAccess,
3228 /// Checking the 'this' pointer for a call to a non-static member function.
3229 /// Must be an object within its lifetime.
3230 TCK_MemberCall,
3231 /// Checking the 'this' pointer for a constructor call.
3232 TCK_ConstructorCall,
3233 /// Checking the operand of a static_cast to a derived pointer type. Must be
3234 /// null or an object within its lifetime.
3235 TCK_DowncastPointer,
3236 /// Checking the operand of a static_cast to a derived reference type. Must
3237 /// be an object within its lifetime.
3238 TCK_DowncastReference,
3239 /// Checking the operand of a cast to a base object. Must be suitably sized
3240 /// and aligned.
3241 TCK_Upcast,
3242 /// Checking the operand of a cast to a virtual base object. Must be an
3243 /// object within its lifetime.
3244 TCK_UpcastToVirtualBase,
3245 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
3246 TCK_NonnullAssign,
3247 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
3248 /// null or an object within its lifetime.
3249 TCK_DynamicOperation
3250 };
3252 /// Determine whether the pointer type check \p TCK permits null pointers.
3255 /// Determine whether the pointer type check \p TCK requires a vptr check.
3258 /// Whether any type-checking sanitizers are enabled. If \c false,
3259 /// calls to EmitTypeCheck can be skipped.
3269 }
3279 }
3281 /// Emit a check that \p V is the address of storage of the
3282 /// appropriate size and alignment for an object of type \p Type
3283 /// (or if ArraySize is provided, for an array of that bound).
3289 /// Emit a check that \p Base points into an array object, which
3290 /// we can access at index \p Index. \p Accessed should be \c false if we
3291 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
3298 // Find a struct's flexible array member and get its offset. It may be
3299 // embedded inside multiple sub-structs, but must still be the last field.
3305 /// Find the FieldDecl specified in a FAM's "counted_by" attribute. Returns
3306 /// \p nullptr if either the attribute or the field doesn't exist.
3309 /// Build an expression accessing the "counted_by" field.
3319 /// Converts Location to a DebugLoc, if debug information is enabled.
3322 /// Get the record field index as represented in debug info.
3326 //===--------------------------------------------------------------------===//
3327 // Declaration Emission
3328 //===--------------------------------------------------------------------===//
3330 /// EmitDecl - Emit a declaration.
3331 ///
3332 /// This function can be called with a null (unreachable) insert point.
3335 /// EmitVarDecl - Emit a local variable declaration.
3336 ///
3337 /// This function can be called with a null (unreachable) insert point.
3346 /// Determine whether the given initializer is trivial in the sense
3347 /// that it requires no code to be generated.
3350 /// EmitAutoVarDecl - Emit an auto variable declaration.
3351 ///
3352 /// This function can be called with a null (unreachable) insert point.
3360 /// The address of the alloca for languages with explicit address space
3361 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
3362 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
3363 /// as a global constant.
3364 Address Addr;
3368 /// True if the variable is a __block variable that is captured by an
3369 /// escaping block.
3372 /// True if the variable is of aggregate type and has a constant
3373 /// initializer.
3376 /// Non-null if we should use lifetime annotations.
3379 /// Address with original alloca instruction. Invalid if the variable was
3380 /// emitted as a global constant.
3381 RawAddress AllocaAddr;
3400 }
3404 }
3406 /// Returns the raw, allocated address, which is not necessarily
3407 /// the address of the object itself. It is casted to default
3408 /// address space for address space agnostic languages.
3411 }
3413 /// Returns the address for the original alloca instruction.
3416 /// Returns the address of the object within this declaration.
3417 /// Note that this does not chase the forwarding pointer for
3418 /// __block decls.
3423 }
3424 };
3431 /// Emits the alloca and debug information for the size expressions for each
3432 /// dimension of an array. It registers the association of its (1-dimensional)
3433 /// QualTypes and size expression's debug node, so that CGDebugInfo can
3434 /// reference this node when creating the DISubrange object to describe the
3435 /// array types.
3445 Address Addr;
3447 };
3457 }
3461 }
3469 }
3474 }
3479 }
3480 };
3482 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
3485 /// protectFromPeepholes - Protect a value that we're intending to
3486 /// store to the side, but which will probably be used later, from
3487 /// aggressive peepholing optimizations that might delete it.
3488 ///
3489 /// Pass the result to unprotectFromPeepholes to declare that
3490 /// protection is no longer required.
3491 ///
3492 /// There's no particular reason why this shouldn't apply to
3493 /// l-values, it's just that no existing peepholes work on pointers.
3498 SourceLocation Loc,
3499 SourceLocation AssumptionLoc,
3511 SourceLocation AssumptionLoc,
3515 //===--------------------------------------------------------------------===//
3516 // Statement Emission
3517 //===--------------------------------------------------------------------===//
3519 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
3522 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
3523 /// this function even if there is no current insertion point.
3524 ///
3525 /// This function may clear the current insertion point; callers should use
3526 /// EnsureInsertPoint if they wish to subsequently generate code without first
3527 /// calling EmitBlock, EmitBranch, or EmitStmt.
3530 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
3531 /// necessarily require an insertion point or debug information; typically
3532 /// because the statement amounts to a jump or a container of other
3533 /// statements.
3534 ///
3535 /// \return True if the statement was handled.
3542 AggValueSlot AVS =
3545 /// EmitLabel - Emit the block for the given label. It is legal to call this
3546 /// function even if there is no current insertion point.
3617 /// Emit simple code for OpenMP directives in Simd-only mode.
3620 /// Scan the outlined statement for captures from the parent function. For
3621 /// each capture, mark the capture as escaped and emit a call to
3622 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
3626 /// Recovers the address of a local in a parent function. ParentVar is the
3627 /// address of the variable used in the immediate parent function. It can
3628 /// either be an alloca or a call to llvm.localrecover if there are nested
3629 /// outlined functions. ParentFP is the frame pointer of the outermost parent
3630 /// frame.
3632 Address ParentVar,
3638 /// Controls insertion of cancellation exit blocks in worksharing constructs.
3647 }
3649 };
3651 /// Returns calculated size of the specified type.
3658 SourceLocation Loc);
3662 SourceLocation Loc);
3663 /// Perform element by element copying of arrays with type \a
3664 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
3665 /// generated by \a CopyGen.
3666 ///
3667 /// \param DestAddr Address of the destination array.
3668 /// \param SrcAddr Address of the source array.
3669 /// \param OriginalType Type of destination and source arrays.
3670 /// \param CopyGen Copying procedure that copies value of single array element
3671 /// to another single array element.
3675 /// Emit proper copying of data from one variable to another.
3676 ///
3677 /// \param OriginalType Original type of the copied variables.
3678 /// \param DestAddr Destination address.
3679 /// \param SrcAddr Source address.
3680 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
3681 /// type of the base array element).
3682 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
3683 /// the base array element).
3684 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
3685 /// DestVD.
3690 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
3691 /// \a X = \a E \a BO \a E.
3692 ///
3693 /// \param X Value to be updated.
3694 /// \param E Update value.
3695 /// \param BO Binary operation for update operation.
3696 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
3697 /// expression, false otherwise.
3698 /// \param AO Atomic ordering of the generated atomic instructions.
3699 /// \param CommonGen Code generator for complex expressions that cannot be
3700 /// expressed through atomicrmw instruction.
3701 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
3702 /// generated, <false, RValue::get(nullptr)> otherwise.
3714 CaptureDeviceAddrMap);
3718 CaptureDeviceAddrMap);
3719 /// Emit code for copyin clause in \a D directive. The next code is
3720 /// generated at the start of outlined functions for directives:
3721 /// \code
3722 /// threadprivate_var1 = master_threadprivate_var1;
3723 /// operator=(threadprivate_var2, master_threadprivate_var2);
3724 /// ...
3725 /// __kmpc_barrier(&loc, global_tid);
3726 /// \endcode
3727 ///
3728 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3729 /// \returns true if at least one copyin variable is found, false otherwise.
3731 /// Emit initial code for lastprivate variables. If some variable is
3732 /// not also firstprivate, then the default initialization is used. Otherwise
3733 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3734 /// method.
3735 ///
3736 /// \param D Directive that may have 'lastprivate' directives.
3737 /// \param PrivateScope Private scope for capturing lastprivate variables for
3738 /// proper codegen in internal captured statement.
3739 ///
3740 /// \returns true if there is at least one lastprivate variable, false
3741 /// otherwise.
3744 /// Emit final copying of lastprivate values to original variables at
3745 /// the end of the worksharing or simd directive.
3746 ///
3747 /// \param D Directive that has at least one 'lastprivate' directives.
3748 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3749 /// it is the last iteration of the loop code in associated directive, or to
3750 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
3754 /// Emit initial code for linear clauses.
3757 /// Emit final code for linear clauses.
3758 /// \param CondGen Optional conditional code for final part of codegen for
3759 /// linear clause.
3763 /// Emit initial code for reduction variables. Creates reduction copies
3764 /// and initializes them with the values according to OpenMP standard.
3765 ///
3766 /// \param D Directive (possibly) with the 'reduction' clause.
3767 /// \param PrivateScope Private scope for capturing reduction variables for
3768 /// proper codegen in internal captured statement.
3769 ///
3773 /// Emit final update of reduction values to original variables at
3774 /// the end of the directive.
3775 ///
3776 /// \param D Directive that has at least one 'reduction' directives.
3777 /// \param ReductionKind The kind of reduction to perform.
3780 /// Emit initial code for linear variables. Creates private copies
3781 /// and initializes them with the values according to OpenMP standard.
3782 ///
3783 /// \param D Directive (possibly) with the 'linear' clause.
3784 /// \return true if at least one linear variable is found that should be
3785 /// initialized with the value of the original variable, false otherwise.
3791 TaskGenTy;
3809 };
3854 void
3857 void
3864 void
3880 void
3905 /// Emit device code for the target directive.
3907 StringRef ParentName,
3909 static void
3912 /// Emit device code for the target parallel for directive.
3916 /// Emit device code for the target parallel for simd directive.
3920 /// Emit device code for the target teams directive.
3921 static void
3924 /// Emit device code for the target teams distribute directive.
3928 /// Emit device code for the target teams distribute simd directive.
3932 /// Emit device code for the target simd directive.
3934 StringRef ParentName,
3936 /// Emit device code for the target teams distribute parallel for simd
3937 /// directive.
3942 /// Emit device code for the target teams loop directive.
3947 /// Emit device code for the target parallel loop directive.
3956 /// Emit the Stmt \p S and return its topmost canonical loop, if any.
3957 /// TODO: The \p Depth paramter is not yet implemented and must be 1. In the
3958 /// future it is meant to be the number of loops expected in the loop nests
3959 /// (usually specified by the "collapse" clause) that are collapsed to a
3960 /// single loop by this function.
3964 /// Emit an OMPCanonicalLoop using the OpenMPIRBuilder.
3967 /// Emit inner loop of the worksharing/simd construct.
3968 ///
3969 /// \param S Directive, for which the inner loop must be emitted.
3970 /// \param RequiresCleanup true, if directive has some associated private
3971 /// variables.
3972 /// \param LoopCond Bollean condition for loop continuation.
3973 /// \param IncExpr Increment expression for loop control variable.
3974 /// \param BodyGen Generator for the inner body of the inner loop.
3975 /// \param PostIncGen Genrator for post-increment code (required for ordered
3976 /// loop directvies).
3984 /// Emit initial code for loop counters of loop-based directives.
3988 /// Helper for the OpenMP loop directives.
3991 /// Emit code for the worksharing loop-based directive.
3992 /// \return true, if this construct has any lastprivate clause, false -
3993 /// otherwise.
3998 /// Emit code for the distribute loop-based directive.
4002 /// Helpers for the OpenMP loop directives.
4008 /// Emits the lvalue for the expression with possibly captured variable.
4012 /// Helpers for blocks.
4015 /// struct with the values to be passed to the OpenMP loop-related functions
4017 /// loop lower bound
4019 /// loop upper bound
4021 /// loop stride
4023 /// isLastIteration argument for runtime functions
4025 /// Chunk value generated by sema
4027 /// EnsureUpperBound
4029 /// IncrementExpression
4031 /// Loop initialization
4033 /// Loop exit condition
4035 /// Update of LB after a whole chunk has been executed
4037 /// Update of UB after a whole chunk has been executed
4039 /// Distinguish between the for distribute and sections
4050 };
4066 /// Emit code for sections directive.
4070 //===--------------------------------------------------------------------===//
4071 // OpenACC Emission
4072 //===--------------------------------------------------------------------===//
4074 // TODO OpenACC: Implement this. It is currently implemented as a 'no-op',
4075 // simply emitting its structured block, but in the future we will implement
4076 // some sort of IR.
4078 }
4081 // TODO OpenACC: Implement this. It is currently implemented as a 'no-op',
4082 // simply emitting its loop, but in the future we will implement
4083 // some sort of IR.
4085 }
4087 //===--------------------------------------------------------------------===//
4088 // LValue Expression Emission
4089 //===--------------------------------------------------------------------===//
4091 /// Create a check that a scalar RValue is non-null.
4094 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
4097 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
4098 /// and issue an ErrorUnsupported style diagnostic (using the
4099 /// provided Name).
4103 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
4104 /// an ErrorUnsupported style diagnostic (using the provided Name).
4108 /// EmitLValue - Emit code to compute a designator that specifies the location
4109 /// of the expression.
4110 ///
4111 /// This can return one of two things: a simple address or a bitfield
4112 /// reference. In either case, the LLVM Value* in the LValue structure is
4113 /// guaranteed to be an LLVM pointer type.
4114 ///
4115 /// If this returns a bitfield reference, nothing about the pointee type of
4116 /// the LLVM value is known: For example, it may not be a pointer to an
4117 /// integer.
4118 ///
4119 /// If this returns a normal address, and if the lvalue's C type is fixed
4120 /// size, this method guarantees that the returned pointer type will point to
4121 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
4122 /// variable length type, this is not possible.
4123 ///
4131 /// Same as EmitLValue but additionally we generate checking code to
4132 /// guard against undefined behavior. This is only suitable when we know
4133 /// that the address will be used to access the object.
4137 SourceLocation Loc);
4167 /// EmitToMemory - Change a scalar value from its value
4168 /// representation to its in-memory representation.
4171 /// EmitFromMemory - Change a scalar value from its memory
4172 /// representation to its value representation.
4175 /// Check if the scalar \p Value is within the valid range for the given
4176 /// type \p Ty.
4177 ///
4178 /// Returns true if a check is needed (even if the range is unknown).
4180 SourceLocation Loc);
4182 /// EmitLoadOfScalar - Load a scalar value from an address, taking
4183 /// care to appropriately convert from the memory representation to
4184 /// the LLVM value representation.
4186 SourceLocation Loc,
4191 }
4195 TBAAAccessInfo TBAAInfo,
4198 /// EmitLoadOfScalar - Load a scalar value from an address, taking
4199 /// care to appropriately convert from the memory representation to
4200 /// the LLVM value representation. The l-value must be a simple
4201 /// l-value.
4204 /// EmitStoreOfScalar - Store a scalar value to an address, taking
4205 /// care to appropriately convert from the memory representation to
4206 /// the LLVM value representation.
4213 }
4220 /// EmitStoreOfScalar - Store a scalar value to an address, taking
4221 /// care to appropriately convert from the memory representation to
4222 /// the LLVM value representation. The l-value must be a simple
4223 /// l-value. The isInit flag indicates whether this is an initialization.
4224 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
4227 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
4228 /// this method emits the address of the lvalue, then loads the result as an
4229 /// rvalue, returning the rvalue.
4235 /// Like EmitLoadOfLValue but also handles complex and aggregate types.
4238 SourceLocation Loc = {});
4240 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
4241 /// lvalue, where both are guaranteed to the have the same type, and that type
4242 /// is 'Ty'.
4247 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
4248 /// as EmitStoreThroughLValue.
4249 ///
4250 /// \param Result [out] - If non-null, this will be set to a Value* for the
4251 /// bit-field contents after the store, appropriate for use as the result of
4252 /// an assignment to the bit-field.
4256 /// Emit an l-value for an assignment (simple or compound) of complex type.
4262 // Note: only available for agg return types
4265 // Note: only available for agg return types
4267 // Note: only available for agg return types
4306 }
4309 }
4313 }
4320 }
4325 }
4326 };
4345 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
4346 /// if the Field is a reference, this will return the address of the reference
4347 /// and not the address of the value stored in the reference.
4367 //===--------------------------------------------------------------------===//
4368 // Scalar Expression Emission
4369 //===--------------------------------------------------------------------===//
4371 /// EmitCall - Generate a call of the given function, expecting the given
4372 /// result type, and using the given argument list which specifies both the
4373 /// LLVM arguments and the types they were derived from.
4377 SourceLocation Loc,
4385 }
4429 CXXDtorType Type,
4434 /// Create the discriminator from the storage address and the entity hash.
4439 GlobalDecl SchemaDecl,
4440 QualType SchemaType);
4463 QualType DestType);
4469 }
4471 // Return the copy constructor name with the prefix "__copy_constructor_"
4472 // removed.
4474 CharUnits Alignment,
4478 // Return the destructor name with the prefix "__destructor_" removed.
4480 CharUnits Alignment,
4484 // These functions emit calls to the special functions of non-trivial C
4485 // structs.
4494 RValue
4506 ReturnValueSlot ReturnValue);
4509 ReturnValueSlot ReturnValue,
4513 // Compute the object pointer.
4520 ReturnValueSlot ReturnValue);
4524 ReturnValueSlot ReturnValue);
4528 ReturnValueSlot ReturnValue);
4539 /// Emit IR for __builtin_os_log_format.
4542 /// Emit IR for __builtin_is_aligned.
4544 /// Emit IR for __builtin_align_up/__builtin_align_down.
4549 CharUnits BufferAlignment);
4553 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
4554 /// is unhandled by the current target.
4556 ReturnValueSlot ReturnValue);
4563 ReturnValueSlot ReturnValue,
4566 ReturnValueSlot ReturnValue,
4569 ReturnValueSlot ReturnValue,
4572 QualType RTy);
4574 QualType RTy);
4601 /// SVEBuiltinMemEltTy - Returns the memory element type for this memory
4602 /// access builtin. Only required if it can't be inferred from the base
4603 /// pointer operand.
4654 /// FormSVEBuiltinResult - Returns the struct of scalable vectors as a wider
4655 /// vector. It extracts the scalable vector from the struct and inserts into
4656 /// the wider vector. This avoids the error when allocating space in llvm
4657 /// for struct of scalable vectors if a function returns struct.
4677 SVETypeFlags TypeFlags);
4698 ReturnValueSlot ReturnValue);
4722 /// Retrieves the default cleanup kind for an ARC cleanup.
4723 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
4727 }
4729 // ARC primitives.
4801 /// Emits a reference binding to the passed in expression.
4804 //===--------------------------------------------------------------------===//
4805 // Expression Emission
4806 //===--------------------------------------------------------------------===//
4808 // Expressions are broken into three classes: scalar, complex, aggregate.
4810 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
4811 /// scalar type, returning the result.
4814 /// Emit a conversion from the specified type to the specified destination
4815 /// type, both of which are LLVM scalar types.
4819 /// Emit a conversion from the specified complex type to the specified
4820 /// destination type, where the destination type is an LLVM scalar type.
4822 QualType DstTy,
4823 SourceLocation Loc);
4825 /// EmitAggExpr - Emit the computation of the specified expression
4826 /// of aggregate type. The result is computed into the given slot,
4827 /// which may be null to indicate that the value is not needed.
4830 /// EmitAggExprToLValue - Emit the computation of the specified expression of
4831 /// aggregate type into a temporary LValue.
4836 /// EmitAggFinalDestCopy - Emit copy of the specified aggregate into
4837 /// destination address.
4839 ExprValueKind SrcKind);
4841 /// Create a store to \arg DstPtr from \arg Src, truncating the stored value
4842 /// to at most \arg DstSize bytes.
4846 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
4847 /// make sure it survives garbage collection until this point.
4850 /// EmitComplexExpr - Emit the computation of the specified expression of
4851 /// complex type, returning the result.
4856 /// EmitComplexExprIntoLValue - Emit the given expression of complex
4857 /// type and place its result into the specified l-value.
4860 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
4863 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
4874 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
4875 /// global variable that has already been created for it. If the initializer
4876 /// has a different type than GV does, this may free GV and return a different
4877 /// one. Otherwise it just returns GV.
4882 // Emit an @llvm.invariant.start call for the given memory region.
4885 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
4886 /// variable with global storage.
4898 /// Call atexit() with a function that passes the given argument to
4899 /// the given function.
4903 /// Registers the dtor using 'llvm.global_dtors' for platforms that do not
4904 /// support an 'atexit()' function.
4908 /// Call atexit() with function dtorStub.
4911 /// Call unatexit() with function dtorStub.
4914 /// Emit code in this function to perform a guarded variable
4915 /// initialization. Guarded initializations are used when it's not
4916 /// possible to prove that an initialization will be done exactly
4917 /// once, e.g. with a static local variable or a static data member
4918 /// of a class template.
4924 /// Emit a branch to select whether or not to perform guarded initialization.
4930 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
4931 /// variables.
4932 void
4937 /// GenerateCXXGlobalCleanUpFunc - Generates code for cleaning up global
4938 /// variables.
4943 DtorsOrStermFinalizers);
4958 //===--------------------------------------------------------------------===//
4959 // Annotations Emission
4960 //===--------------------------------------------------------------------===//
4962 /// Emit an annotation call (intrinsic).
4965 StringRef AnnotationStr,
4966 SourceLocation Location,
4969 /// Emit local annotations for the local variable V, declared by D.
4972 /// Emit field annotations for the given field & value. Returns the
4973 /// annotation result.
4976 //===--------------------------------------------------------------------===//
4977 // Internal Helpers
4978 //===--------------------------------------------------------------------===//
4980 /// ContainsLabel - Return true if the statement contains a label in it. If
4981 /// this statement is not executed normally, it not containing a label means
4982 /// that we can just remove the code.
4985 /// containsBreak - Return true if the statement contains a break out of it.
4986 /// If the statement (recursively) contains a switch or loop with a break
4987 /// inside of it, this is fine.
4990 /// Determine if the given statement might introduce a declaration into the
4991 /// current scope, by being a (possibly-labelled) DeclStmt.
4994 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4995 /// to a constant, or if it does but contains a label, return false. If it
4996 /// constant folds return true and set the boolean result in Result.
5000 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
5001 /// to a constant, or if it does but contains a label, return false. If it
5002 /// constant folds return true and set the folded value.
5006 /// Ignore parentheses and logical-NOT to track conditions consistently.
5009 /// isInstrumentedCondition - Determine whether the given condition is an
5010 /// instrumentable condition (i.e. no "&&" or "||").
5013 /// EmitBranchToCounterBlock - Emit a conditional branch to a new block that
5014 /// increments a profile counter based on the semantics of the given logical
5015 /// operator opcode. This is used to instrument branch condition coverage
5016 /// for logical operators.
5024 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
5025 /// if statement) to the specified blocks. Based on the condition, this might
5026 /// try to simplify the codegen of the conditional based on the branch.
5027 /// TrueCount should be the number of times we expect the condition to
5028 /// evaluate to true based on PGO data.
5034 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
5035 /// nonnull, if \p LHS is marked _Nonnull.
5038 /// An enumeration which makes it easier to specify whether or not an
5039 /// operation is a subtraction.
5042 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
5043 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
5044 /// \p SignedIndices indicates whether any of the GEP indices are signed.
5045 /// \p IsSubtraction indicates whether the expression used to form the GEP
5046 /// is a subtraction.
5051 SourceLocation Loc,
5059 /// Specifies which type of sanitizer check to apply when handling a
5060 /// particular builtin.
5062 BCK_CTZPassedZero,
5063 BCK_CLZPassedZero,
5064 };
5066 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
5067 /// enabled, a runtime check specified by \p Kind is also emitted.
5070 /// Emit a description of a type in a format suitable for passing to
5071 /// a runtime sanitizer handler.
5074 /// Convert a value into a format suitable for passing to a runtime
5075 /// sanitizer handler.
5078 /// Emit a description of a source location in a format suitable for
5079 /// passing to a runtime sanitizer handler.
5085 /// Create a basic block that will either trap or call a handler function in
5086 /// the UBSan runtime with the provided arguments, and create a conditional
5087 /// branch to it.
5092 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
5093 /// if Cond if false.
5098 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
5099 /// checking is enabled. Otherwise, just emit an unreachable instruction.
5102 /// Create a basic block that will call the trap intrinsic, and emit a
5103 /// conditional branch to it, for the -ftrapv checks.
5106 /// Emit a call to trap or debugtrap and attach function attribute
5107 /// "trap-func-name" if specified.
5110 /// Emit a stub for the cross-DSO CFI check function.
5113 /// Emit a cross-DSO CFI failure handling function.
5116 /// Create a check for a function parameter that may potentially be
5117 /// declared as non-null.
5125 /// EmitCallArg - Emit a single call argument.
5128 /// EmitDelegateCallArg - We are performing a delegate call; that
5129 /// is, the current function is delegating to another one. Produce
5130 /// a r-value suitable for passing the given parameter.
5132 SourceLocation loc);
5134 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
5135 /// point operation, expressed as the maximum relative error in ulp.
5138 /// Set the minimum required accuracy of the given sqrt operation
5139 /// based on CodeGenOpts.
5142 /// Set the minimum required accuracy of the given sqrt operation based on
5143 /// CodeGenOpts.
5146 /// Set the codegen fast-math flags.
5149 // Truncate or extend a boolean vector to the requested number of elements.
5153 // Adds a convergence_ctrl token to |Input| and emits the required parent
5154 // convergence instructions.
5159 }
5162 // Emits a convergence_loop instruction for the given |BB|, with |ParentToken|
5163 // as it's parent convergence instr.
5166 // Adds a convergence_ctrl token with |ParentToken| as parent convergence
5167 // instr to the call |Input|.
5170 // Find the convergence_entry instruction |F|, or emits ones if none exists.
5171 // Returns the convergence instruction.
5173 // Find the convergence_loop instruction for the loop defined by |LI|, or
5174 // emits one if none exists. Returns the convergence instruction.
5184 DeferredReplacements;
5186 /// Set the address of a local variable.
5190 }
5192 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
5193 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
5194 ///
5195 /// \param AI - The first function argument of the expansion.
5199 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
5200 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
5201 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
5213 SourceLocation Loc);
5215 /// Attempts to statically evaluate the object size of E. If that
5216 /// fails, emits code to figure the size of E out for us. This is
5217 /// pass_object_size aware.
5218 ///
5219 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
5225 /// Emits the size of E, as required by __builtin_object_size. This
5226 /// function is aware of pass_object_size parameters, and will act accordingly
5227 /// if E is a parameter with the pass_object_size attribute.
5237 Address Loc);
5241 ///! No language constraints on evaluation order.
5242 Default,
5243 ///! Language semantics require left-to-right evaluation.
5244 ForceLeftToRight,
5245 ///! Language semantics require right-to-left evaluation.
5246 ForceRightToLeft
5247 };
5249 // Wrapper for function prototype sources. Wraps either a FunctionProtoType or
5250 // an ObjCMethodDecl.
5256 };
5264 /// EmitPointerWithAlignment - Given an expression with a pointer type,
5265 /// emit the value and compute our best estimate of the alignment of the
5266 /// pointee.
5267 ///
5268 /// \param BaseInfo - If non-null, this will be initialized with
5269 /// information about the source of the alignment and the may-alias
5270 /// attribute. Note that this function will conservatively fall back on
5271 /// the type when it doesn't recognize the expression and may-alias will
5272 /// be set to false.
5273 ///
5274 /// One reasonable way to use this information is when there's a language
5275 /// guarantee that the pointer must be aligned to some stricter value, and
5276 /// we're simply trying to ensure that sufficiently obvious uses of under-
5277 /// aligned objects don't get miscompiled; for example, a placement new
5278 /// into the address of a local variable. In such a case, it's quite
5279 /// reasonable to just ignore the returned alignment when it isn't from an
5280 /// explicit source.
5281 Address
5286 /// If \p E references a parameter with pass_object_size info or a constant
5287 /// array size modifier, emit the object size divided by the size of \p EltTy.
5288 /// Otherwise return null.
5296 StringRef Architecture;
5306 };
5308 // Emits the body of a multiversion function's resolver. Assumes that the
5309 // options are already sorted in the proper order, with the 'default' option
5310 // last (if it exists).
5313 void
5316 void
5343 };
5349 // Otherwise, we need an alloca.
5352 Address alloca =
5357 }
5360 saved_type value) {
5361 // If the value says it wasn't saved, trust that it's still dominating.
5364 // Otherwise, it should be an alloca instruction, as set up in save().
5368 }
5372 // Map the LangOption for floating point exception behavior into
5373 // the corresponding enum in the IR.
5378 #endif