| blob | 0f720596165ff1c20950da79ce61d5c94c64e0c5 |
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
44 #include <optional>
54 }
86 }
102 /// The kind of evaluation to perform on values of a particular
103 /// type. Basically, is the code in CGExprScalar, CGExprComplex, or
104 /// CGExprAgg?
105 ///
106 /// TODO: should vectors maybe be split out into their own thing?
108 TEK_Scalar,
109 TEK_Complex,
110 TEK_Aggregate
111 };
113 #define LIST_SANITIZER_CHECKS \
114 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
115 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
116 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
117 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
118 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
119 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
120 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
121 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
122 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
123 SANITIZER_CHECK(InvalidObjCCast, invalid_objc_cast, 0) \
124 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
125 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
126 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
127 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
128 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
129 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
130 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
131 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
132 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
133 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
134 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
135 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
136 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
137 SANITIZER_CHECK(AlignmentAssumption, alignment_assumption, 0) \
138 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
141 #define SANITIZER_CHECK(Enum, Name, Version) Enum,
142 LIST_SANITIZER_CHECKS
143 #undef SANITIZER_CHECK
144 };
146 /// Helper class with most of the code for saving a value for a
147 /// conditional expression cleanup.
151 /// Answer whether the given value needs extra work to be saved.
153 // If it's not an instruction, we don't need to save.
156 // If it's an instruction in the entry block, we don't need to save.
159 }
163 };
165 /// A partial specialization of DominatingValue for llvm::Values that
166 /// might be llvm::Instructions.
171 }
172 };
174 /// A specialization of DominatingValue for Address.
181 CharUnits Alignment;
182 };
186 }
190 }
194 }
195 };
197 /// A specialization of DominatingValue for RValue.
216 // implementations in CGCleanup.cpp
217 };
221 }
224 }
227 }
228 };
230 /// CodeGenFunction - This class organizes the per-function state that is used
231 /// while generating LLVM code.
238 /// A jump destination is an abstract label, branching to which may
239 /// require a jump out through normal cleanups.
251 // This should be used cautiously.
254 }
260 };
265 // For EH/SEH outlined funclets, this field points to parent's CGF
269 LoopInfoStack LoopStack;
270 CGBuilderTy Builder;
272 // Stores variables for which we can't generate correct lifetime markers
273 // because of jumps.
274 VarBypassDetector Bypasses;
276 /// List of recently emitted OMPCanonicalLoops.
277 ///
278 /// Since OMPCanonicalLoops are nested inside other statements (in particular
279 /// CapturedStmt generated by OMPExecutableDirective and non-perfectly nested
280 /// loops), we cannot directly call OMPEmitOMPCanonicalLoop and receive its
281 /// llvm::CanonicalLoopInfo. Instead, we call EmitStmt and any
282 /// OMPEmitOMPCanonicalLoop called by it will add its CanonicalLoopInfo to
283 /// this stack when done. Entering a new loop requires clearing this list; it
284 /// either means we start parsing a new loop nest (in which case the previous
285 /// loop nest goes out of scope) or a second loop in the same level in which
286 /// case it would be ambiguous into which of the two (or more) loops the loop
287 /// nest would extend.
290 /// Number of nested loop to be consumed by the last surrounding
291 /// loop-associated directive.
294 // CodeGen lambda for loops and support for ordered clause
296 JumpDest)>
297 CodeGenLoopTy;
300 CodeGenOrderedTy;
302 // Codegen lambda for loop bounds in worksharing loop constructs
305 CodeGenLoopBoundsTy;
307 // Codegen lambda for loop bounds in dispatch-based loop implementation
310 Address UB)>
311 CodeGenDispatchBoundsTy;
313 /// CGBuilder insert helper. This function is called after an
314 /// instruction is created using Builder.
319 /// CurFuncDecl - Holds the Decl for the current outermost
320 /// non-closure context.
322 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
325 QualType FnRetTy;
328 /// Save Parameter Decl for coroutine.
331 // Holds coroutine data if the current function is a coroutine. We use a
332 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
333 // in this header.
339 };
340 CGCoroInfo CurCoro;
344 }
348 }
350 /// CurGD - The GlobalDecl for the current function being compiled.
351 GlobalDecl CurGD;
353 /// PrologueCleanupDepth - The cleanup depth enclosing all the
354 /// cleanups associated with the parameters.
357 /// ReturnBlock - Unified return block.
358 JumpDest ReturnBlock;
360 /// ReturnValue - The temporary alloca to hold the return
361 /// value. This is invalid iff the function has no return value.
364 /// ReturnValuePointer - The temporary alloca to hold a pointer to sret.
365 /// This is invalid if sret is not in use.
368 /// If a return statement is being visited, this holds the return statment's
369 /// result expression.
372 /// Return true if a label was seen in the current scope.
377 }
379 /// AllocaInsertPoint - This is an instruction in the entry block before which
380 /// we prefer to insert allocas.
384 /// PostAllocaInsertPt - This is a place in the prologue where code can be
385 /// inserted that will be dominated by all the static allocas. This helps
386 /// achieve two things:
387 /// 1. Contiguity of all static allocas (within the prologue) is maintained.
388 /// 2. All other prologue code (which are dominated by static allocas) do
389 /// appear in the source order immediately after all static allocas.
390 ///
391 /// PostAllocaInsertPt will be lazily created when it is *really* required.
395 /// Return PostAllocaInsertPt. If it is not yet created, then insert it
396 /// immediately after AllocaInsertPt.
406 }
409 }
411 /// API for captured statement code generation.
431 }
432 }
439 // Retrieve the value of the context parameter.
442 /// Lookup the captured field decl for a variable.
445 }
452 }
454 /// Emit the captured statement body.
458 }
460 /// Get the name of the capture helper.
463 /// Get the CaptureFields
466 }
469 /// The kind of captured statement being generated.
470 CapturedRegionKind Kind;
472 /// Keep the map between VarDecl and FieldDecl.
475 /// The base address of the captured record, passed in as the first
476 /// argument of the parallel region function.
479 /// Captured 'this' type.
481 };
484 /// RAII for correct setting/restoring of CapturedStmtInfo.
494 }
496 };
498 /// An abstract representation of regular/ObjC call/message targets.
500 /// The function declaration of the callee.
509 }
515 }
520 }
521 };
523 /// Sanitizers enabled for this function.
524 SanitizerSet SanOpts;
526 /// True if CodeGen currently emits code implementing sanitizer checks.
529 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
535 };
537 /// In C++, whether we are code generating a thunk. This controls whether we
538 /// should emit cleanups.
541 /// In ARC, whether we should autorelease the return value.
544 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
545 /// potentially set the return value.
548 GlobalDecl CurSEHParent;
550 /// True if the current function is an outlined SEH helper. This can be a
551 /// finally block or filter expression.
554 /// True if CodeGen currently emits code inside presereved access index
555 /// region.
558 /// True if the current statement has nomerge attribute.
561 /// True if the current statement has noinline attribute.
564 /// True if the current statement has always_inline attribute.
567 // The CallExpr within the current statement that the musttail attribute
568 // applies to. nullptr if there is no 'musttail' on the current statement.
571 /// Returns true if a function must make progress, which means the
572 /// mustprogress attribute can be added.
578 // C++11 and later guarantees that a thread eventually will do one of the
579 // following (C++11 [intro.multithread]p24 and C++17 [intro.progress]p1):
580 // - terminate,
581 // - make a call to a library I/O function,
582 // - perform an access through a volatile glvalue, or
583 // - perform a synchronization operation or an atomic operation.
584 //
585 // Hence each function is 'mustprogress' in C++11 or later.
587 }
589 /// Returns true if a loop must make progress, which means the mustprogress
590 /// attribute can be added. \p HasConstantCond indicates whether the branch
591 /// condition is a known constant.
600 // If the containing function must make progress, loops also must make
601 // progress (as in C++11 and later).
605 // Now apply rules for plain C (see 6.8.5.6 in C11).
606 // Loops with constant conditions do not have to make progress in any C
607 // version.
611 // Loops with non-constant conditions must make progress in C11 and later.
613 }
621 /// A mapping from NRVO variables to the flags used to indicate
622 /// when the NRVO has been applied to this variable.
625 EHScopeStack EHStack;
643 }
644 };
646 /// Header for data within LifetimeExtendedCleanupStack.
648 /// The size of the following cleanup object.
650 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
652 /// Whether this is a conditional cleanup.
658 };
660 /// i32s containing the indexes of the cleanup destinations.
665 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
668 /// The exception slot. All landing pads write the current exception pointer
669 /// into this alloca.
672 /// The selector slot. Under the MandatoryCleanup model, all landing pads
673 /// write the current selector value into this alloca.
676 /// A stack of exception code slots. Entering an __except block pushes a slot
677 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
678 /// a value from the top of the stack.
681 /// Value returned by __exception_info intrinsic.
684 /// Emits a landing pad for the current EH stack.
689 /// Parent loop-based directive for scan directive.
697 /// Manages parent directive for scan directives.
709 }
712 }
713 };
718 }
729 FPOptions OldFPFeatures;
733 };
734 FPOptions CurFPFeatures;
737 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
738 /// rethrows.
741 /// A class controlling the emission of a finally block.
743 /// Where the catchall's edge through the cleanup should go.
744 JumpDest RethrowDest;
746 /// A function to call to enter the catch.
749 /// An i1 variable indicating whether or not the @finally is
750 /// running for an exception.
753 /// An i8* variable into which the exception pointer to rethrow
754 /// has been saved.
762 };
764 /// Returns true inside SEH __try blocks.
767 /// Returns true while emitting a cleanuppad.
770 }
772 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
773 /// current full-expression. Safe against the possibility that
774 /// we're currently inside a conditionally-evaluated expression.
777 // If we're not in a conditional branch, or if none of the
778 // arguments requires saving, then use the unconditional cleanup.
782 // Stash values in a tuple so we can guarantee the order of saves.
789 }
791 /// Queue a cleanup to be pushed after finishing the current full-expression,
792 /// potentially with an active flag.
797 A...);
808 }
828 }
830 /// Set up the last cleanup that was pushed as a conditional
831 /// full-expression cleanup.
834 }
839 /// PushDestructorCleanup - Push a cleanup to call the
840 /// complete-object destructor of an object of the given type at the
841 /// given address. Does nothing if T is not a C++ class type with a
842 /// non-trivial destructor.
845 /// PushDestructorCleanup - Push a cleanup to call the
846 /// complete-object variant of the given destructor on the object at
847 /// the given address.
849 Address Addr);
851 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
852 /// process all branch fixups.
855 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
856 /// The block cannot be reactivated. Pops it if it's the top of the
857 /// stack.
858 ///
859 /// \param DominatingIP - An instruction which is known to
860 /// dominate the current IP (if set) and which lies along
861 /// all paths of execution between the current IP and the
862 /// the point at which the cleanup comes into scope.
866 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
867 /// Cannot be used to resurrect a deactivated cleanup.
868 ///
869 /// \param DominatingIP - An instruction which is known to
870 /// dominate the current IP (if set) and which lies along
871 /// all paths of execution between the current IP and the
872 /// the point at which the cleanup comes into scope.
876 /// Enters a new scope for capturing cleanups, all of which
877 /// will be executed once the scope is exited.
893 /// Enter a new cleanup scope.
896 {
898 LifetimeExtendedCleanupStackSize =
904 }
906 /// Exit this cleanup scope, emitting any accumulated cleanups.
910 }
912 /// Determine whether this scope requires any cleanups.
915 }
917 /// Force the emission of cleanups now, instead of waiting
918 /// until this object is destroyed.
919 /// \param ValuesToReload - A list of values that need to be available at
920 /// the insertion point after cleanup emission. If cleanup emission created
921 /// a shared cleanup block, these value pointers will be rewritten.
922 /// Otherwise, they not will be modified.
927 ValuesToReload);
930 }
931 };
933 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
938 SourceRange Range;
946 /// Enter a new cleanup scope.
952 }
957 }
959 /// Exit this cleanup scope, emitting any accumulated
960 /// cleanups.
965 // If we should perform a cleanup, force them now. Note that
966 // this ends the cleanup scope before rescoping any labels.
970 }
971 }
973 /// Force the emission of cleanups now, instead of waiting
974 /// until this object is destroyed.
981 }
985 }
988 };
992 /// The class used to assign some variables some temporarily addresses.
994 DeclMapTy SavedLocals;
995 DeclMapTy SavedTempAddresses;
1003 };
1005 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
1006 /// function \p CGF.
1007 /// \return true if at least one variable was set already, false otherwise.
1009 Address TempAddr) {
1011 // Only save it once.
1014 // Copy the existing local entry to SavedLocals.
1018 else
1021 // Generate the private entry.
1027 }
1031 }
1033 /// Applies new addresses to the list of the variables.
1034 /// \return true if at least one variable is using new address, false
1035 /// otherwise.
1040 }
1042 /// Restores original addresses of the variables.
1047 }
1048 }
1051 /// Copy all the entries in the source map over the corresponding
1052 /// entries in the destination, which must exist.
1058 }
1063 else
1065 }
1066 }
1067 };
1069 /// The scope used to remap some variables as private in the OpenMP loop body
1070 /// (or other captured region emitted without outlining), and to restore old
1071 /// vars back on exit.
1073 OMPMapVars MappedVars;
1078 /// Enter a new OpenMP private scope.
1081 /// Registers \p LocalVD variable as a private with \p Addr as the address
1082 /// of the corresponding private variable. \p
1083 /// PrivateGen is the address of the generated private variable.
1084 /// \return true if the variable is registered as private, false if it has
1085 /// been privatized already.
1089 }
1091 /// Privatizes local variables previously registered as private.
1092 /// Registration is separate from the actual privatization to allow
1093 /// initializers use values of the original variables, not the private one.
1094 /// This is important, for example, if the private variable is a class
1095 /// variable initialized by a constructor that references other private
1096 /// variables. But at initialization original variables must be used, not
1097 /// private copies.
1098 /// \return true if at least one variable was privatized, false otherwise.
1104 }
1106 /// Exit scope - all the mapped variables are restored.
1110 }
1112 /// Checks if the global variable is captured in current function.
1116 }
1118 /// Restore all mapped variables w/o clean up. This is usefully when we want
1119 /// to reference the original variables but don't want the clean up because
1120 /// that could emit lifetime end too early, causing backend issue #56913.
1122 };
1124 /// Save/restore original map of previously emitted local vars in case when we
1125 /// need to duplicate emission of the same code several times in the same
1126 /// function for OpenMP code.
1129 DeclMapTy SavedMap;
1135 };
1137 /// Takes the old cleanup stack size and emits the cleanup blocks
1138 /// that have been added.
1139 void
1143 /// Takes the old cleanup stack size and emits the cleanup blocks
1144 /// that have been added, then adds all lifetime-extended cleanups from
1145 /// the given position to the stack.
1146 void
1153 /// The given basic block lies in the current EH scope, but may be a
1154 /// target of a potentially scope-crossing jump; get a stable handle
1155 /// to which we can perform this jump later.
1159 NextCleanupDestIndex++);
1160 }
1162 /// The given basic block lies in the current EH scope, but may be a
1163 /// target of a potentially scope-crossing jump; get a stable handle
1164 /// to which we can perform this jump later.
1167 }
1169 /// EmitBranchThroughCleanup - Emit a branch from the current insert
1170 /// block through the normal cleanup handling code (if any) and then
1171 /// on to \arg Dest.
1174 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
1175 /// specified destination obviously has no cleanups to run. 'false' is always
1176 /// a conservatively correct answer for this method.
1179 /// popCatchScope - Pops the catch scope at the top of the EHScope
1180 /// stack, emitting any required code (other than the catch handlers
1181 /// themselves).
1189 /// An object to manage conditionally-evaluated expressions.
1201 }
1207 }
1209 /// Returns a block which will be executed prior to each
1210 /// evaluation of the conditional code.
1213 }
1214 };
1216 /// isInConditionalBranch - Return true if we're currently emitting
1217 /// one branch or the other of a conditional expression.
1225 }
1227 /// An RAII object to record that we're evaluating a statement
1228 /// expression.
1232 /// We have to save the outermost conditional: cleanups in a
1233 /// statement expression aren't conditional just because the
1234 /// StmtExpr is.
1241 }
1246 }
1247 };
1249 /// An object which temporarily prevents a value from being
1250 /// destroyed by aggressive peephole optimizations that assume that
1251 /// all uses of a value have been realized in the IR.
1258 };
1260 /// A non-RAII class containing all the information about a bound
1261 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1262 /// this which makes individual mappings very simple; using this
1263 /// class directly is useful when you have a variable number of
1264 /// opaque values or don't want the RAII functionality for some
1265 /// reason.
1278 // gl-values should be bound as l-values for obvious reasons.
1279 // Records should be bound as l-values because IR generation
1280 // always keeps them in memory. Expressions of function type
1281 // act exactly like l-values but are formally required to be
1282 // r-values in C.
1286 }
1294 }
1302 }
1312 // Work around an extremely aggressive peephole optimization in
1313 // EmitScalarConversion which assumes that all other uses of a
1314 // value are extant.
1318 }
1331 }
1332 }
1333 };
1335 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1338 OpaqueValueMappingData Data;
1343 }
1345 /// Build the opaque value mapping for the given conditional
1346 /// operator if it's the GNU ?: extension. This is a common
1347 /// enough pattern that the convenience operator is really
1348 /// helpful.
1349 ///
1353 // Leave Data empty.
1359 }
1361 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1362 /// expression is set to the expression the OVE represents.
1369 }
1370 }
1374 LValue lvalue)
1376 }
1380 RValue rvalue)
1382 }
1387 }
1391 }
1392 };
1396 /// Used to create unique names for artificial VLA size debug info variables.
1400 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1401 /// calling llvm.stacksave for multiple VLAs in the same scope.
1404 /// IndirectBranch - The first time an indirect goto is seen we create a block
1405 /// with an indirect branch. Every time we see the address of a label taken,
1406 /// we add the label to the indirect goto. Every subsequent indirect goto is
1407 /// codegen'd as a jump to the IndirectBranch's basic block.
1410 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1411 /// decls.
1412 DeclMapTy LocalDeclMap;
1414 // Keep track of the cleanups for callee-destructed parameters pushed to the
1415 // cleanup stack so that they can be deactivated later.
1417 CalleeDestructedParamCleanups;
1419 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1420 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1421 /// parameter.
1423 SizeArguments;
1425 /// Track escaped local variables with auto storage. Used during SEH
1426 /// outlining to produce a call to llvm.localescape.
1429 /// LabelMap - This keeps track of the LLVM basic block for each C label.
1432 // BreakContinueStack - This keeps track of where break and continue
1433 // statements should jump to.
1438 JumpDest BreakBlock;
1439 JumpDest ContinueBlock;
1440 };
1443 /// Handles cancellation exit points in OpenMP-related constructs.
1445 /// Tracks cancellation exit point and join point for cancel-related exit
1446 /// and normal exit.
1450 JumpDest ContBlock)
1453 /// true if the exit block has been emitted already by the special
1454 /// emitExit() call, false if the default codegen is used.
1456 JumpDest ExitBlock;
1457 JumpDest ContBlock;
1458 };
1465 /// Fetches the exit block for the current OpenMP construct.
1467 /// Emits exit block with special codegen procedure specific for the related
1468 /// OpenMP construct + emits code for normal construct cleanup.
1481 }
1483 }
1484 /// Enter the cancel supporting \a Kind construct.
1485 /// \param Kind OpenMP directive that supports cancel constructs.
1486 /// \param HasCancel true, if the construct has inner cancel directive,
1487 /// false otherwise.
1494 }
1495 /// Emits default exit point for the cancel construct (if the special one
1496 /// has not be used) + join point for cancel/normal exits.
1506 }
1511 }
1512 }
1514 }
1515 };
1516 OpenMPCancelExitStack OMPCancelStack;
1518 /// Lower the Likelihood knowledge about the \p Cond via llvm.expect intrin.
1522 CodeGenPGO PGO;
1524 /// Calculate branch weights appropriate for PGO data
1532 /// Increment the profiler's counter for the given statement by \p StepV.
1533 /// If \p StepV is null, the default increment is 1.
1540 }
1542 /// Get the profiler's count for the given statement.
1545 }
1547 /// Set the profiler's current count.
1550 }
1552 /// Get the profiler's current count. This is generally the count for the most
1553 /// recently incremented counter.
1556 }
1560 /// SwitchInsn - This is nearest current switch instruction. It is null if
1561 /// current context is not in a switch.
1563 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1566 /// The likelihood attributes of the SwitchCase.
1569 /// CaseRangeBlock - This block holds if condition check for last case
1570 /// statement range in current switch instruction.
1573 /// OpaqueLValues - Keeps track of the current set of opaque value
1574 /// expressions.
1578 // VLASizeMap - This keeps track of the associated size for each VLA type.
1579 // We track this by the size expression rather than the type itself because
1580 // in certain situations, like a const qualifier applied to an VLA typedef,
1581 // multiple VLA types can share the same size expression.
1582 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1583 // enter/leave scopes.
1586 /// A block containing a single 'unreachable' instruction. Created
1587 /// lazily by getUnreachableBlock().
1590 /// Counts of the number return expressions in the function.
1593 /// Count the number of simple (constant) return expressions in the function.
1596 /// The last regular (non-return) debug location (breakpoint) in the function.
1597 SourceLocation LastStopPoint;
1600 /// Source location information about the default argument or member
1601 /// initializer expression we're evaluating, if any.
1602 CurrentSourceLocExprScope CurSourceLocExprScope;
1606 /// A scope within which we are constructing the fields of an object which
1607 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1608 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1614 }
1617 }
1621 Address OldCXXDefaultInitExprThis;
1622 };
1624 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1625 /// is overridden to be the object under construction.
1634 }
1638 }
1643 CharUnits OldCXXThisAlignment;
1644 SourceLocExprScopeGuard SourceLocScope;
1645 };
1650 };
1652 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1653 /// current loop index is overridden.
1659 }
1662 }
1667 };
1693 }
1707 }
1711 GlobalDecl OldCurGD;
1717 CharUnits OldCXXABIThisAlignment;
1718 CharUnits OldCXXThisAlignment;
1719 Address OldReturnValue;
1720 QualType OldFnRetTy;
1721 CallArgList OldCXXInheritedCtorInitExprArgs;
1722 };
1724 // Helper class for the OpenMP IR Builder. Allows reusability of code used for
1725 // region body, and finalization codegen callbacks. This will class will also
1726 // contain privatization functions used by the privatization call backs
1727 //
1728 // TODO: this is temporary class for things that are being moved out of
1729 // CGOpenMPRuntime, new versions of current CodeGenFunction methods, or
1730 // utility function for use with the OMPBuilder. Once that move to use the
1731 // OMPBuilder is done, everything here will either become part of CodeGenFunc.
1732 // directly, or a new helper class that will contain functions used by both
1733 // this and the OMPBuilder
1743 /// Cleanup action for allocate support.
1752 }
1758 }
1759 };
1761 /// Returns address of the threadprivate variable for the current
1762 /// thread. This Also create any necessary OMP runtime calls.
1763 ///
1764 /// \param VD VarDecl for Threadprivate variable.
1765 /// \param VDAddr Address of the Vardecl
1766 /// \param Loc The location where the barrier directive was encountered
1769 SourceLocation Loc);
1771 /// Gets the OpenMP-specific address of the local variable /p VD.
1774 /// Get the platform-specific name separator.
1775 /// \param Parts different parts of the final name that needs separation
1776 /// \param FirstSeparator First separator used between the initial two
1777 /// parts of the name.
1778 /// \param Separator separator used between all of the rest consecutinve
1779 /// parts of the name
1783 /// Emit the Finalization for an OMP region
1784 /// \param CGF The Codegen function this belongs to
1785 /// \param IP Insertion point for generating the finalization code.
1795 // erase and replace with cleanup branch.
1800 }
1802 /// Emit the body of an OMP region
1803 /// \param CGF The Codegen function this belongs to
1804 /// \param RegionBodyStmt The body statement for the OpenMP region being
1805 /// generated
1806 /// \param AllocaIP Where to insert alloca instructions
1807 /// \param CodeGenIP Where to insert the region code
1808 /// \param RegionName Name to be used for new blocks
1811 InsertPointTy AllocaIP,
1812 InsertPointTy CodeGenIP,
1813 Twine RegionName);
1826 else
1831 }
1833 /// Emit the body of an OMP region that will be outlined in
1834 /// OpenMPIRBuilder::finalize().
1835 /// \param CGF The Codegen function this belongs to
1836 /// \param RegionBodyStmt The body statement for the OpenMP region being
1837 /// generated
1838 /// \param AllocaIP Where to insert alloca instructions
1839 /// \param CodeGenIP Where to insert the region code
1840 /// \param RegionName Name to be used for new blocks
1843 InsertPointTy AllocaIP,
1844 InsertPointTy CodeGenIP,
1845 Twine RegionName);
1847 /// RAII for preserving necessary info during Outlined region body codegen.
1865 }
1870 }
1871 };
1873 /// RAII for preserving necessary info during inlined region body codegen.
1883 // Alloca insertion block should be in the entry block of the containing
1884 // function so it expects an empty AllocaIP in which case will reuse the
1885 // old alloca insertion point, or a new AllocaIP in the same block as
1886 // the old one
1889 "Insertion point should be in the entry block of containing "
1895 // TODO: Remove the call, after making sure the counter is not used by
1896 // the EHStack.
1897 // Since this is an inlined region, it should not modify the
1898 // ReturnBlock, and should reuse the one for the enclosing outlined
1899 // region. So, the JumpDest being return by the function is discarded
1901 }
1904 };
1905 };
1908 /// CXXThisDecl - When generating code for a C++ member function,
1909 /// this will hold the implicit 'this' declaration.
1913 CharUnits CXXABIThisAlignment;
1914 CharUnits CXXThisAlignment;
1916 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1917 /// this expression.
1920 /// The current array initialization index when evaluating an
1921 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1924 /// The values of function arguments to use when evaluating
1925 /// CXXInheritedCtorInitExprs within this context.
1926 CallArgList CXXInheritedCtorInitExprArgs;
1928 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1929 /// destructor, this will hold the implicit argument (e.g. VTT).
1933 /// OutermostConditional - Points to the outermost active
1934 /// conditional control. This is used so that we know if a
1935 /// temporary should be destroyed conditionally.
1938 /// The current lexical scope.
1941 /// The current source location that should be used for exception
1942 /// handling code.
1943 SourceLocation CurEHLocation;
1945 /// BlockByrefInfos - For each __block variable, contains
1946 /// information about the layout of the variable.
1949 /// Used by -fsanitize=nullability-return to determine whether the return
1950 /// value can be checked.
1953 /// Check if -fsanitize=nullability-return instrumentation is required for
1954 /// this function.
1957 }
1959 /// Used to store precise source locations for return statements by the
1960 /// runtime return value checks.
1963 /// Check if the return value of this function requires sanitization.
1970 /// Terminate funclets keyed by parent funclet pad.
1973 /// Largest vector width used in ths function. Will be used to create a
1974 /// function attribute.
1977 /// True if we need emit the life-time markers. This is initially set in
1978 /// the constructor, but could be overwritten to true if this is a coroutine.
1981 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
1982 /// the function metadata.
1995 }
2001 }
2005 /// Returns a pointer to the function's exception object and selector slot,
2006 /// which is assigned in every landing pad.
2010 /// Returns the contents of the function's exception object and selector
2011 /// slots.
2021 }
2023 }
2028 }
2036 }
2038 //===--------------------------------------------------------------------===//
2039 // Cleanups
2040 //===--------------------------------------------------------------------===//
2045 Address arrayEndPointer,
2046 QualType elementType,
2047 CharUnits elementAlignment,
2051 QualType elementType,
2052 CharUnits elementAlignment,
2066 QualType ElementType);
2081 /// Determines whether an EH cleanup is required to destroy a type
2082 /// with the given destruction kind.
2094 }
2096 }
2100 }
2102 //===--------------------------------------------------------------------===//
2103 // Objective-C
2104 //===--------------------------------------------------------------------===//
2110 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
2121 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
2122 /// for the given property.
2129 //===--------------------------------------------------------------------===//
2130 // Block Bits
2131 //===--------------------------------------------------------------------===//
2133 /// Emit block literal.
2134 /// \return an LLVM value which is a pointer to a struct which contains
2135 /// information about the block, including the block invoke function, the
2136 /// captured variables, etc.
2145 /// Check if \p T is a C++ class that has a destructor that can throw.
2163 /// Enter a cleanup to destroy a __block variable. Note that this
2164 /// cleanup should be a no-op if the variable hasn't left the stack
2165 /// yet; if a cleanup is required for the variable itself, that needs
2166 /// to be done externally.
2167 ///
2168 /// \param Kind Cleanup kind.
2169 ///
2170 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
2171 /// structure that will be passed to _Block_object_dispose. When
2172 /// \p LoadBlockVarAddr is true, the address of the field of the block
2173 /// structure that holds the address of the __block structure.
2174 ///
2175 /// \param Flags The flag that will be passed to _Block_object_dispose.
2176 ///
2177 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
2178 /// \p Addr to get the address of the __block structure.
2188 /// BuildBlockByrefAddress - Computes the location of the
2189 /// data in a variable which is declared as __block.
2204 /// Annotate the function with an attribute that disables TSan checking at
2205 /// runtime.
2208 /// Emit code for the start of a function.
2209 /// \param Loc The location to be associated with the function.
2210 /// \param StartLoc The location of the function body.
2212 QualType RetTy,
2234 }
2237 /// Emit the unified return block, trying to avoid its emission when
2238 /// possible.
2239 /// \return The debug location of the user written return statement if the
2240 /// return block is avoided.
2243 /// FinishFunction - Complete IR generation of the current function. It is
2244 /// legal to call this function even if there is no current insertion point.
2255 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
2259 /// Generate a thunk for the given method.
2273 /// Struct with all information about dynamic [sub]class needed to set vptr.
2275 BaseSubobject Base;
2277 CharUnits OffsetFromNearestVBase;
2279 };
2281 /// Initialize the vtable pointer of the given subobject.
2290 CharUnits OffsetFromNearestVBase,
2297 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
2298 /// to by This.
2303 CFITCK_VCall,
2304 CFITCK_NVCall,
2305 CFITCK_DerivedCast,
2306 CFITCK_UnrelatedCast,
2307 CFITCK_ICall,
2308 CFITCK_NVMFCall,
2309 CFITCK_VMFCall,
2310 };
2312 /// Derived is the presumed address of an object of type T after a
2313 /// cast. If T is a polymorphic class type, emit a check that the virtual
2314 /// table for Derived belongs to a class derived from T.
2318 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
2319 /// If vptr CFI is enabled, emit a check that VTable is valid.
2323 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
2324 /// RD using llvm.type.test.
2328 /// If whole-program virtual table optimization is enabled, emit an assumption
2329 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
2330 /// enabled, emit a check that VTable is a member of RD's type identifier.
2334 /// Returns whether we should perform a type checked load when loading a
2335 /// virtual function for virtual calls to members of RD. This is generally
2336 /// true when both vcall CFI and whole-program-vtables are enabled.
2339 /// Emit a type checked load from the given vtable.
2345 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
2346 /// given phase of destruction for a destructor. The end result
2347 /// should call destructors on members and base classes in reverse
2348 /// order of their construction.
2351 /// ShouldInstrumentFunction - Return true if the current function should be
2352 /// instrumented with __cyg_profile_func_* calls
2355 /// ShouldSkipSanitizerInstrumentation - Return true if the current function
2356 /// should not be instrumented with sanitizers.
2359 /// ShouldXRayInstrument - Return true if the current function should be
2360 /// instrumented with XRay nop sleds.
2363 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
2364 /// XRay custom event handling calls.
2367 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
2368 /// XRay typed event handling calls.
2371 /// Return a type hash constant for a function instrumented by
2372 /// -fsanitize=function.
2375 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
2376 /// arguments for the given function. This is also responsible for naming the
2377 /// LLVM function arguments.
2382 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
2383 /// given temporary.
2385 SourceLocation EndLoc);
2387 /// Emit a test that checks if the return value \p RV is nonnull.
2390 /// EmitStartEHSpec - Emit the start of the exception spec.
2393 /// EmitEndEHSpec - Emit the end of the exception spec.
2396 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
2399 /// getTerminateLandingPad - Return a cleanup funclet that just calls
2400 /// terminate.
2403 /// getTerminateHandler - Return a handler (not a landing pad, just
2404 /// a catch handler) that just calls terminate. This is used when
2405 /// a terminate scope encloses a try.
2412 }
2414 /// LoadObjCSelf - Load the value of self. This function is only valid while
2415 /// generating code for an Objective-C method.
2418 /// TypeOfSelfObject - Return type of object that this self represents.
2421 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
2426 }
2430 }
2432 /// createBasicBlock - Create an LLVM basic block.
2437 }
2439 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2440 /// label maps to.
2443 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2444 /// another basic block, simplify it. This assumes that no other code could
2445 /// potentially reference the basic block.
2448 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2449 /// adding a fall-through branch from the current insert block if
2450 /// necessary. It is legal to call this function even if there is no current
2451 /// insertion point.
2452 ///
2453 /// IsFinished - If true, indicates that the caller has finished emitting
2454 /// branches to the given block and does not expect to emit code into it. This
2455 /// means the block can be ignored if it is unreachable.
2458 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2459 /// near its uses, and leave the insertion point in it.
2462 /// EmitBranch - Emit a branch to the specified basic block from the current
2463 /// insert block, taking care to avoid creation of branches from dummy
2464 /// blocks. It is legal to call this function even if there is no current
2465 /// insertion point.
2466 ///
2467 /// This function clears the current insertion point. The caller should follow
2468 /// calls to this function with calls to Emit*Block prior to generation new
2469 /// code.
2472 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2473 /// indicates that the current code being emitted is unreachable.
2476 }
2478 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2479 /// emitted IR has a place to go. Note that by definition, if this function
2480 /// creates a block then that block is unreachable; callers may do better to
2481 /// detect when no insertion point is defined and simply skip IR generation.
2485 }
2487 /// ErrorUnsupported - Print out an error that codegen doesn't support the
2488 /// specified stmt yet.
2491 //===--------------------------------------------------------------------===//
2492 // Helpers
2493 //===--------------------------------------------------------------------===//
2499 }
2502 TBAAAccessInfo TBAAInfo) {
2504 }
2511 }
2513 LValue
2518 }
2528 AlignmentSource Source =
2533 }
2535 /// Load a pointer with type \p PtrTy stored at address \p Ptr.
2536 /// Note that \p PtrTy is the type of the loaded pointer, not the addresses
2537 /// it is loaded from.
2543 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2544 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2545 /// insertion point of the builder. The caller is responsible for setting an
2546 /// appropriate alignment on
2547 /// the alloca.
2548 ///
2549 /// \p ArraySize is the number of array elements to be allocated if it
2550 /// is not nullptr.
2551 ///
2552 /// LangAS::Default is the address space of pointers to local variables and
2553 /// temporaries, as exposed in the source language. In certain
2554 /// configurations, this is not the same as the alloca address space, and a
2555 /// cast is needed to lift the pointer from the alloca AS into
2556 /// LangAS::Default. This can happen when the target uses a restricted
2557 /// address space for the stack but the source language requires
2558 /// LangAS::Default to be a generic address space. The latter condition is
2559 /// common for most programming languages; OpenCL is an exception in that
2560 /// LangAS::Default is the private address space, which naturally maps
2561 /// to the stack.
2562 ///
2563 /// Because the address of a temporary is often exposed to the program in
2564 /// various ways, this function will perform the cast. The original alloca
2565 /// instruction is returned through \p Alloca if it is not nullptr.
2566 ///
2567 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
2568 /// more efficient if the caller knows that the address will not be exposed.
2579 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2580 /// default ABI alignment of the given LLVM type.
2581 ///
2582 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2583 /// any given AST type that happens to have been lowered to the
2584 /// given IR type. This should only ever be used for function-local,
2585 /// IR-driven manipulations like saving and restoring a value. Do
2586 /// not hand this address off to arbitrary IRGen routines, and especially
2587 /// do not pass it as an argument to a function that might expect a
2588 /// properly ABI-aligned value.
2592 /// CreateIRTemp - Create a temporary IR object of the given type, with
2593 /// appropriate alignment. This routine should only be used when an temporary
2594 /// value needs to be stored into an alloca (for example, to avoid explicit
2595 /// PHI construction), but the type is the IR type, not the type appropriate
2596 /// for storing in memory.
2597 ///
2598 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2599 /// ConvertType instead of ConvertTypeForMem.
2602 /// CreateMemTemp - Create a temporary memory object of the given type, with
2603 /// appropriate alignmen and cast it to the default address space. Returns
2604 /// the original alloca instruction by \p Alloca if it is not nullptr.
2610 /// CreateMemTemp - Create a temporary memory object of the given type, with
2611 /// appropriate alignmen without casting it to the default address space.
2616 /// CreateAggTemp - Create a temporary memory object for the given
2617 /// aggregate type.
2626 }
2628 /// Emit a cast to void* in the appropriate address space.
2631 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2632 /// expression and compare the result against zero, returning an Int1Ty value.
2635 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2638 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2639 /// any type. The result is returned as an RValue struct. If this is an
2640 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2641 /// the result should be returned.
2642 ///
2643 /// \param ignoreResult True if the resulting value isn't used.
2648 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2649 // or the value of the expression, depending on how va_list is defined.
2652 /// Emit a "reference" to a __builtin_ms_va_list; this is
2653 /// always the value of the expression, because a __builtin_ms_va_list is a
2654 /// pointer to a char.
2657 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
2658 /// always be accessible even if no aggregate location is provided.
2661 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
2662 /// arbitrary expression into the given memory location.
2668 /// EmitExprAsInit - Emits the code necessary to initialize a
2669 /// location in memory with the given initializer.
2673 /// hasVolatileMember - returns true if aggregate type has a volatile
2674 /// member.
2679 }
2681 }
2683 /// Determine whether a return value slot may overlap some other object.
2685 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2686 // class subobjects. These cases may need to be revisited depending on the
2687 // resolution of the relevant core issue.
2689 }
2691 /// Determine whether a field initialization may overlap some other object.
2694 /// Determine whether a base class initialization may overlap some other
2695 /// object.
2700 /// Emit an aggregate assignment.
2704 }
2709 }
2711 /// EmitAggregateCopy - Emit an aggregate copy.
2712 ///
2713 /// \param isVolatile \c true iff either the source or the destination is
2714 /// volatile.
2715 /// \param MayOverlap Whether the tail padding of the destination might be
2716 /// occupied by some other object. More efficient code can often be
2717 /// generated if not.
2722 /// GetAddrOfLocalVar - Return the address of a local variable.
2728 }
2730 /// Given an opaque value expression, return its LValue mapping if it exists,
2731 /// otherwise create one.
2734 /// Given an opaque value expression, return its RValue mapping if it exists,
2735 /// otherwise create one.
2738 /// Get the index of the current ArrayInitLoopExpr, if any.
2741 /// getAccessedFieldNo - Given an encoded value and a result number, return
2742 /// the input field number being accessed.
2748 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2751 /// EmitNullInitialization - Generate code to set a value of the given type to
2752 /// null, If the type contains data member pointers, they will be initialized
2753 /// to -1 in accordance with the Itanium C++ ABI.
2756 /// Emits a call to an LLVM variable-argument intrinsic, either
2757 /// \c llvm.va_start or \c llvm.va_end.
2758 /// \param ArgValue A reference to the \c va_list as emitted by either
2759 /// \c EmitVAListRef or \c EmitMSVAListRef.
2760 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2761 /// calls \c llvm.va_end.
2764 /// Generate code to get an argument from the passed in pointer
2765 /// and update it accordingly.
2766 /// \param VE The \c VAArgExpr for which to generate code.
2767 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2768 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2769 /// \returns A pointer to the argument.
2770 // FIXME: We should be able to get rid of this method and use the va_arg
2771 // instruction in LLVM instead once it works well enough.
2774 /// emitArrayLength - Compute the length of an array, even if it's a
2775 /// VLA, and drill down to the base element type.
2780 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2781 /// the given variably-modified type and store them in the VLASizeMap.
2782 ///
2783 /// This function can be called with a null (unreachable) insert point.
2788 QualType Type;
2791 };
2793 /// Return the number of elements for a single dimension
2794 /// for the given array type.
2798 /// Returns an LLVM value that corresponds to the size,
2799 /// in non-variably-sized elements, of a variable length array type,
2800 /// plus that largest non-variably-sized element type. Assumes that
2801 /// the type has already been emitted with EmitVariablyModifiedType.
2805 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2806 /// generating code for an C++ member function.
2810 }
2813 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2814 /// virtual bases.
2815 // FIXME: Every place that calls LoadCXXVTT is something
2816 // that needs to be abstracted properly.
2820 }
2822 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
2823 /// complete class to the given direct base.
2824 Address
2832 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2833 /// load of 'this' and returns address of the base class.
2846 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2847 /// base constructor/destructor with virtual bases.
2848 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2849 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2854 CXXCtorType CtorType,
2856 SourceLocation Loc);
2857 // It's important not to confuse this and the previous function. Delegating
2858 // constructors are the C++0x feature. The constructor delegate optimization
2859 // is used to reduce duplication in the base and complete consturctors where
2860 // they are substantially the same.
2864 /// Emit a call to an inheriting constructor (that is, one that invokes a
2865 /// constructor inherited from a base class) by inlining its definition. This
2866 /// is necessary if the ABI does not support forwarding the arguments to the
2867 /// base class constructor (because they're variadic or similar).
2869 CXXCtorType CtorType,
2874 /// Emit a call to a constructor inherited from a base class, passing the
2875 /// current constructor's arguments along unmodified (without even making
2876 /// a copy).
2892 /// Emit assumption load for all bases. Requires to be called only on
2893 /// most-derived class and not under construction of the object.
2896 /// Emit assumption that vptr load == global vtable.
2905 Address ArrayPtr,
2912 Address ArrayPtr,
2921 QualType ThisTy);
2929 Address Ptr);
2953 /// Situations in which we might emit a check for the suitability of a
2954 /// pointer or glvalue. Needs to be kept in sync with ubsan_handlers.cpp in
2955 /// compiler-rt.
2957 /// Checking the operand of a load. Must be suitably sized and aligned.
2958 TCK_Load,
2959 /// Checking the destination of a store. Must be suitably sized and aligned.
2960 TCK_Store,
2961 /// Checking the bound value in a reference binding. Must be suitably sized
2962 /// and aligned, but is not required to refer to an object (until the
2963 /// reference is used), per core issue 453.
2964 TCK_ReferenceBinding,
2965 /// Checking the object expression in a non-static data member access. Must
2966 /// be an object within its lifetime.
2967 TCK_MemberAccess,
2968 /// Checking the 'this' pointer for a call to a non-static member function.
2969 /// Must be an object within its lifetime.
2970 TCK_MemberCall,
2971 /// Checking the 'this' pointer for a constructor call.
2972 TCK_ConstructorCall,
2973 /// Checking the operand of a static_cast to a derived pointer type. Must be
2974 /// null or an object within its lifetime.
2975 TCK_DowncastPointer,
2976 /// Checking the operand of a static_cast to a derived reference type. Must
2977 /// be an object within its lifetime.
2978 TCK_DowncastReference,
2979 /// Checking the operand of a cast to a base object. Must be suitably sized
2980 /// and aligned.
2981 TCK_Upcast,
2982 /// Checking the operand of a cast to a virtual base object. Must be an
2983 /// object within its lifetime.
2984 TCK_UpcastToVirtualBase,
2985 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2986 TCK_NonnullAssign,
2987 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2988 /// null or an object within its lifetime.
2989 TCK_DynamicOperation
2990 };
2992 /// Determine whether the pointer type check \p TCK permits null pointers.
2995 /// Determine whether the pointer type check \p TCK requires a vptr check.
2998 /// Whether any type-checking sanitizers are enabled. If \c false,
2999 /// calls to EmitTypeCheck can be skipped.
3002 /// Emit a check that \p V is the address of storage of the
3003 /// appropriate size and alignment for an object of type \p Type
3004 /// (or if ArraySize is provided, for an array of that bound).
3010 /// Emit a check that \p Base points into an array object, which
3011 /// we can access at index \p Index. \p Accessed should be \c false if we
3012 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
3021 /// Converts Location to a DebugLoc, if debug information is enabled.
3024 /// Get the record field index as represented in debug info.
3028 //===--------------------------------------------------------------------===//
3029 // Declaration Emission
3030 //===--------------------------------------------------------------------===//
3032 /// EmitDecl - Emit a declaration.
3033 ///
3034 /// This function can be called with a null (unreachable) insert point.
3037 /// EmitVarDecl - Emit a local variable declaration.
3038 ///
3039 /// This function can be called with a null (unreachable) insert point.
3048 /// Determine whether the given initializer is trivial in the sense
3049 /// that it requires no code to be generated.
3052 /// EmitAutoVarDecl - Emit an auto variable declaration.
3053 ///
3054 /// This function can be called with a null (unreachable) insert point.
3062 /// The address of the alloca for languages with explicit address space
3063 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
3064 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
3065 /// as a global constant.
3066 Address Addr;
3070 /// True if the variable is a __block variable that is captured by an
3071 /// escaping block.
3074 /// True if the variable is of aggregate type and has a constant
3075 /// initializer.
3078 /// Non-null if we should use lifetime annotations.
3081 /// Address with original alloca instruction. Invalid if the variable was
3082 /// emitted as a global constant.
3083 Address AllocaAddr;
3102 }
3106 }
3108 /// Returns the raw, allocated address, which is not necessarily
3109 /// the address of the object itself. It is casted to default
3110 /// address space for address space agnostic languages.
3113 }
3115 /// Returns the address for the original alloca instruction.
3118 /// Returns the address of the object within this declaration.
3119 /// Note that this does not chase the forwarding pointer for
3120 /// __block decls.
3125 }
3126 };
3133 /// Emits the alloca and debug information for the size expressions for each
3134 /// dimension of an array. It registers the association of its (1-dimensional)
3135 /// QualTypes and size expression's debug node, so that CGDebugInfo can
3136 /// reference this node when creating the DISubrange object to describe the
3137 /// array types.
3154 }
3159 }
3167 }
3172 KnownNonNull);
3173 }
3174 };
3176 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
3179 /// protectFromPeepholes - Protect a value that we're intending to
3180 /// store to the side, but which will probably be used later, from
3181 /// aggressive peepholing optimizations that might delete it.
3182 ///
3183 /// Pass the result to unprotectFromPeepholes to declare that
3184 /// protection is no longer required.
3185 ///
3186 /// There's no particular reason why this shouldn't apply to
3187 /// l-values, it's just that no existing peepholes work on pointers.
3192 SourceLocation Loc,
3193 SourceLocation AssumptionLoc,
3205 SourceLocation AssumptionLoc,
3209 //===--------------------------------------------------------------------===//
3210 // Statement Emission
3211 //===--------------------------------------------------------------------===//
3213 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
3216 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
3217 /// this function even if there is no current insertion point.
3218 ///
3219 /// This function may clear the current insertion point; callers should use
3220 /// EnsureInsertPoint if they wish to subsequently generate code without first
3221 /// calling EmitBlock, EmitBranch, or EmitStmt.
3224 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
3225 /// necessarily require an insertion point or debug information; typically
3226 /// because the statement amounts to a jump or a container of other
3227 /// statements.
3228 ///
3229 /// \return True if the statement was handled.
3236 AggValueSlot AVS =
3239 /// EmitLabel - Emit the block for the given label. It is legal to call this
3240 /// function even if there is no current insertion point.
3311 /// Emit simple code for OpenMP directives in Simd-only mode.
3314 /// Scan the outlined statement for captures from the parent function. For
3315 /// each capture, mark the capture as escaped and emit a call to
3316 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
3320 /// Recovers the address of a local in a parent function. ParentVar is the
3321 /// address of the variable used in the immediate parent function. It can
3322 /// either be an alloca or a call to llvm.localrecover if there are nested
3323 /// outlined functions. ParentFP is the frame pointer of the outermost parent
3324 /// frame.
3326 Address ParentVar,
3332 /// Controls insertion of cancellation exit blocks in worksharing constructs.
3341 }
3343 };
3345 /// Returns calculated size of the specified type.
3352 SourceLocation Loc);
3356 SourceLocation Loc);
3357 /// Perform element by element copying of arrays with type \a
3358 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
3359 /// generated by \a CopyGen.
3360 ///
3361 /// \param DestAddr Address of the destination array.
3362 /// \param SrcAddr Address of the source array.
3363 /// \param OriginalType Type of destination and source arrays.
3364 /// \param CopyGen Copying procedure that copies value of single array element
3365 /// to another single array element.
3369 /// Emit proper copying of data from one variable to another.
3370 ///
3371 /// \param OriginalType Original type of the copied variables.
3372 /// \param DestAddr Destination address.
3373 /// \param SrcAddr Source address.
3374 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
3375 /// type of the base array element).
3376 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
3377 /// the base array element).
3378 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
3379 /// DestVD.
3384 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
3385 /// \a X = \a E \a BO \a E.
3386 ///
3387 /// \param X Value to be updated.
3388 /// \param E Update value.
3389 /// \param BO Binary operation for update operation.
3390 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
3391 /// expression, false otherwise.
3392 /// \param AO Atomic ordering of the generated atomic instructions.
3393 /// \param CommonGen Code generator for complex expressions that cannot be
3394 /// expressed through atomicrmw instruction.
3395 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
3396 /// generated, <false, RValue::get(nullptr)> otherwise.
3411 /// Emit code for copyin clause in \a D directive. The next code is
3412 /// generated at the start of outlined functions for directives:
3413 /// \code
3414 /// threadprivate_var1 = master_threadprivate_var1;
3415 /// operator=(threadprivate_var2, master_threadprivate_var2);
3416 /// ...
3417 /// __kmpc_barrier(&loc, global_tid);
3418 /// \endcode
3419 ///
3420 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3421 /// \returns true if at least one copyin variable is found, false otherwise.
3423 /// Emit initial code for lastprivate variables. If some variable is
3424 /// not also firstprivate, then the default initialization is used. Otherwise
3425 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3426 /// method.
3427 ///
3428 /// \param D Directive that may have 'lastprivate' directives.
3429 /// \param PrivateScope Private scope for capturing lastprivate variables for
3430 /// proper codegen in internal captured statement.
3431 ///
3432 /// \returns true if there is at least one lastprivate variable, false
3433 /// otherwise.
3436 /// Emit final copying of lastprivate values to original variables at
3437 /// the end of the worksharing or simd directive.
3438 ///
3439 /// \param D Directive that has at least one 'lastprivate' directives.
3440 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3441 /// it is the last iteration of the loop code in associated directive, or to
3442 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
3446 /// Emit initial code for linear clauses.
3449 /// Emit final code for linear clauses.
3450 /// \param CondGen Optional conditional code for final part of codegen for
3451 /// linear clause.
3455 /// Emit initial code for reduction variables. Creates reduction copies
3456 /// and initializes them with the values according to OpenMP standard.
3457 ///
3458 /// \param D Directive (possibly) with the 'reduction' clause.
3459 /// \param PrivateScope Private scope for capturing reduction variables for
3460 /// proper codegen in internal captured statement.
3461 ///
3465 /// Emit final update of reduction values to original variables at
3466 /// the end of the directive.
3467 ///
3468 /// \param D Directive that has at least one 'reduction' directives.
3469 /// \param ReductionKind The kind of reduction to perform.
3472 /// Emit initial code for linear variables. Creates private copies
3473 /// and initializes them with the values according to OpenMP standard.
3474 ///
3475 /// \param D Directive (possibly) with the 'linear' clause.
3476 /// \return true if at least one linear variable is found that should be
3477 /// initialized with the value of the original variable, false otherwise.
3483 TaskGenTy;
3501 };
3544 void
3547 void
3554 void
3570 void
3589 /// Emit device code for the target directive.
3591 StringRef ParentName,
3593 static void
3596 /// Emit device code for the target parallel for directive.
3600 /// Emit device code for the target parallel for simd directive.
3604 /// Emit device code for the target teams directive.
3605 static void
3608 /// Emit device code for the target teams distribute directive.
3612 /// Emit device code for the target teams distribute simd directive.
3616 /// Emit device code for the target simd directive.
3618 StringRef ParentName,
3620 /// Emit device code for the target teams distribute parallel for simd
3621 /// directive.
3630 /// Emit the Stmt \p S and return its topmost canonical loop, if any.
3631 /// TODO: The \p Depth paramter is not yet implemented and must be 1. In the
3632 /// future it is meant to be the number of loops expected in the loop nests
3633 /// (usually specified by the "collapse" clause) that are collapsed to a
3634 /// single loop by this function.
3638 /// Emit an OMPCanonicalLoop using the OpenMPIRBuilder.
3641 /// Emit inner loop of the worksharing/simd construct.
3642 ///
3643 /// \param S Directive, for which the inner loop must be emitted.
3644 /// \param RequiresCleanup true, if directive has some associated private
3645 /// variables.
3646 /// \param LoopCond Bollean condition for loop continuation.
3647 /// \param IncExpr Increment expression for loop control variable.
3648 /// \param BodyGen Generator for the inner body of the inner loop.
3649 /// \param PostIncGen Genrator for post-increment code (required for ordered
3650 /// loop directvies).
3658 /// Emit initial code for loop counters of loop-based directives.
3662 /// Helper for the OpenMP loop directives.
3665 /// Emit code for the worksharing loop-based directive.
3666 /// \return true, if this construct has any lastprivate clause, false -
3667 /// otherwise.
3672 /// Emit code for the distribute loop-based directive.
3676 /// Helpers for the OpenMP loop directives.
3682 /// Emits the lvalue for the expression with possibly captured variable.
3686 /// Helpers for blocks.
3689 /// struct with the values to be passed to the OpenMP loop-related functions
3691 /// loop lower bound
3693 /// loop upper bound
3695 /// loop stride
3697 /// isLastIteration argument for runtime functions
3699 /// Chunk value generated by sema
3701 /// EnsureUpperBound
3703 /// IncrementExpression
3705 /// Loop initialization
3707 /// Loop exit condition
3709 /// Update of LB after a whole chunk has been executed
3711 /// Update of UB after a whole chunk has been executed
3722 };
3738 /// Emit code for sections directive.
3743 //===--------------------------------------------------------------------===//
3744 // LValue Expression Emission
3745 //===--------------------------------------------------------------------===//
3747 /// Create a check that a scalar RValue is non-null.
3750 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3753 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3754 /// and issue an ErrorUnsupported style diagnostic (using the
3755 /// provided Name).
3759 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3760 /// an ErrorUnsupported style diagnostic (using the provided Name).
3764 /// EmitLValue - Emit code to compute a designator that specifies the location
3765 /// of the expression.
3766 ///
3767 /// This can return one of two things: a simple address or a bitfield
3768 /// reference. In either case, the LLVM Value* in the LValue structure is
3769 /// guaranteed to be an LLVM pointer type.
3770 ///
3771 /// If this returns a bitfield reference, nothing about the pointee type of
3772 /// the LLVM value is known: For example, it may not be a pointer to an
3773 /// integer.
3774 ///
3775 /// If this returns a normal address, and if the lvalue's C type is fixed
3776 /// size, this method guarantees that the returned pointer type will point to
3777 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3778 /// variable length type, this is not possible.
3779 ///
3787 /// Same as EmitLValue but additionally we generate checking code to
3788 /// guard against undefined behavior. This is only suitable when we know
3789 /// that the address will be used to access the object.
3793 SourceLocation Loc);
3823 /// EmitToMemory - Change a scalar value from its value
3824 /// representation to its in-memory representation.
3827 /// EmitFromMemory - Change a scalar value from its memory
3828 /// representation to its value representation.
3831 /// Check if the scalar \p Value is within the valid range for the given
3832 /// type \p Ty.
3833 ///
3834 /// Returns true if a check is needed (even if the range is unknown).
3836 SourceLocation Loc);
3838 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3839 /// care to appropriately convert from the memory representation to
3840 /// the LLVM value representation.
3842 SourceLocation Loc,
3847 }
3851 TBAAAccessInfo TBAAInfo,
3854 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3855 /// care to appropriately convert from the memory representation to
3856 /// the LLVM value representation. The l-value must be a simple
3857 /// l-value.
3860 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3861 /// care to appropriately convert from the memory representation to
3862 /// the LLVM value representation.
3869 }
3876 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3877 /// care to appropriately convert from the memory representation to
3878 /// the LLVM value representation. The l-value must be a simple
3879 /// l-value. The isInit flag indicates whether this is an initialization.
3880 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3883 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3884 /// this method emits the address of the lvalue, then loads the result as an
3885 /// rvalue, returning the rvalue.
3891 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3892 /// lvalue, where both are guaranteed to the have the same type, and that type
3893 /// is 'Ty'.
3898 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3899 /// as EmitStoreThroughLValue.
3900 ///
3901 /// \param Result [out] - If non-null, this will be set to a Value* for the
3902 /// bit-field contents after the store, appropriate for use as the result of
3903 /// an assignment to the bit-field.
3907 /// Emit an l-value for an assignment (simple or compound) of complex type.
3913 // Note: only available for agg return types
3916 // Note: only available for agg return types
3918 // Note: only available for agg return types
3957 }
3960 }
3964 }
3971 }
3976 }
3977 };
3994 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3995 /// if the Field is a reference, this will return the address of the reference
3996 /// and not the address of the value stored in the reference.
4016 //===--------------------------------------------------------------------===//
4017 // Scalar Expression Emission
4018 //===--------------------------------------------------------------------===//
4020 /// EmitCall - Generate a call of the given function, expecting the given
4021 /// result type, and using the given argument list which specifies both the
4022 /// LLVM arguments and the types they were derived from.
4026 SourceLocation Loc);
4033 }
4074 CXXDtorType Type,
4077 // Return the copy constructor name with the prefix "__copy_constructor_"
4078 // removed.
4080 CharUnits Alignment,
4084 // Return the destructor name with the prefix "__destructor_" removed.
4086 CharUnits Alignment,
4090 // These functions emit calls to the special functions of non-trivial C
4091 // structs.
4100 RValue
4112 ReturnValueSlot ReturnValue);
4115 ReturnValueSlot ReturnValue,
4119 // Compute the object pointer.
4126 ReturnValueSlot ReturnValue);
4130 ReturnValueSlot ReturnValue);
4134 ReturnValueSlot ReturnValue);
4145 /// Emit IR for __builtin_os_log_format.
4148 /// Emit IR for __builtin_is_aligned.
4150 /// Emit IR for __builtin_align_up/__builtin_align_down.
4155 CharUnits BufferAlignment);
4159 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
4160 /// is unhandled by the current target.
4162 ReturnValueSlot ReturnValue);
4169 ReturnValueSlot ReturnValue,
4172 ReturnValueSlot ReturnValue,
4175 ReturnValueSlot ReturnValue,
4178 QualType RTy);
4180 QualType RTy);
4207 /// SVEBuiltinMemEltTy - Returns the memory element type for this memory
4208 /// access builtin. Only required if it can't be inferred from the base
4209 /// pointer operand.
4282 ReturnValueSlot ReturnValue);
4304 /// Retrieves the default cleanup kind for an ARC cleanup.
4305 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
4309 }
4311 // ARC primitives.
4383 /// Emits a reference binding to the passed in expression.
4386 //===--------------------------------------------------------------------===//
4387 // Expression Emission
4388 //===--------------------------------------------------------------------===//
4390 // Expressions are broken into three classes: scalar, complex, aggregate.
4392 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
4393 /// scalar type, returning the result.
4396 /// Emit a conversion from the specified type to the specified destination
4397 /// type, both of which are LLVM scalar types.
4401 /// Emit a conversion from the specified complex type to the specified
4402 /// destination type, where the destination type is an LLVM scalar type.
4404 QualType DstTy,
4405 SourceLocation Loc);
4407 /// EmitAggExpr - Emit the computation of the specified expression
4408 /// of aggregate type. The result is computed into the given slot,
4409 /// which may be null to indicate that the value is not needed.
4412 /// EmitAggExprToLValue - Emit the computation of the specified expression of
4413 /// aggregate type into a temporary LValue.
4416 /// Build all the stores needed to initialize an aggregate at Dest with the
4417 /// value Val.
4420 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
4421 /// make sure it survives garbage collection until this point.
4424 /// EmitComplexExpr - Emit the computation of the specified expression of
4425 /// complex type, returning the result.
4430 /// EmitComplexExprIntoLValue - Emit the given expression of complex
4431 /// type and place its result into the specified l-value.
4434 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
4437 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
4448 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
4449 /// global variable that has already been created for it. If the initializer
4450 /// has a different type than GV does, this may free GV and return a different
4451 /// one. Otherwise it just returns GV.
4456 // Emit an @llvm.invariant.start call for the given memory region.
4459 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
4460 /// variable with global storage.
4472 /// Call atexit() with a function that passes the given argument to
4473 /// the given function.
4477 /// Call atexit() with function dtorStub.
4480 /// Call unatexit() with function dtorStub.
4483 /// Emit code in this function to perform a guarded variable
4484 /// initialization. Guarded initializations are used when it's not
4485 /// possible to prove that an initialization will be done exactly
4486 /// once, e.g. with a static local variable or a static data member
4487 /// of a class template.
4493 /// Emit a branch to select whether or not to perform guarded initialization.
4499 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
4500 /// variables.
4501 void
4506 /// GenerateCXXGlobalCleanUpFunc - Generates code for cleaning up global
4507 /// variables.
4512 DtorsOrStermFinalizers);
4527 //===--------------------------------------------------------------------===//
4528 // Annotations Emission
4529 //===--------------------------------------------------------------------===//
4531 /// Emit an annotation call (intrinsic).
4534 StringRef AnnotationStr,
4535 SourceLocation Location,
4538 /// Emit local annotations for the local variable V, declared by D.
4541 /// Emit field annotations for the given field & value. Returns the
4542 /// annotation result.
4545 //===--------------------------------------------------------------------===//
4546 // Internal Helpers
4547 //===--------------------------------------------------------------------===//
4549 /// ContainsLabel - Return true if the statement contains a label in it. If
4550 /// this statement is not executed normally, it not containing a label means
4551 /// that we can just remove the code.
4554 /// containsBreak - Return true if the statement contains a break out of it.
4555 /// If the statement (recursively) contains a switch or loop with a break
4556 /// inside of it, this is fine.
4559 /// Determine if the given statement might introduce a declaration into the
4560 /// current scope, by being a (possibly-labelled) DeclStmt.
4563 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4564 /// to a constant, or if it does but contains a label, return false. If it
4565 /// constant folds return true and set the boolean result in Result.
4569 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
4570 /// to a constant, or if it does but contains a label, return false. If it
4571 /// constant folds return true and set the folded value.
4575 /// isInstrumentedCondition - Determine whether the given condition is an
4576 /// instrumentable condition (i.e. no "&&" or "||").
4579 /// EmitBranchToCounterBlock - Emit a conditional branch to a new block that
4580 /// increments a profile counter based on the semantics of the given logical
4581 /// operator opcode. This is used to instrument branch condition coverage
4582 /// for logical operators.
4590 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
4591 /// if statement) to the specified blocks. Based on the condition, this might
4592 /// try to simplify the codegen of the conditional based on the branch.
4593 /// TrueCount should be the number of times we expect the condition to
4594 /// evaluate to true based on PGO data.
4599 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
4600 /// nonnull, if \p LHS is marked _Nonnull.
4603 /// An enumeration which makes it easier to specify whether or not an
4604 /// operation is a subtraction.
4607 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
4608 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
4609 /// \p SignedIndices indicates whether any of the GEP indices are signed.
4610 /// \p IsSubtraction indicates whether the expression used to form the GEP
4611 /// is a subtraction.
4616 SourceLocation Loc,
4619 /// Specifies which type of sanitizer check to apply when handling a
4620 /// particular builtin.
4622 BCK_CTZPassedZero,
4623 BCK_CLZPassedZero,
4624 };
4626 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4627 /// enabled, a runtime check specified by \p Kind is also emitted.
4630 /// Emit a description of a type in a format suitable for passing to
4631 /// a runtime sanitizer handler.
4634 /// Convert a value into a format suitable for passing to a runtime
4635 /// sanitizer handler.
4638 /// Emit a description of a source location in a format suitable for
4639 /// passing to a runtime sanitizer handler.
4645 /// Create a basic block that will either trap or call a handler function in
4646 /// the UBSan runtime with the provided arguments, and create a conditional
4647 /// branch to it.
4652 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
4653 /// if Cond if false.
4658 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4659 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4662 /// Create a basic block that will call the trap intrinsic, and emit a
4663 /// conditional branch to it, for the -ftrapv checks.
4666 /// Emit a call to trap or debugtrap and attach function attribute
4667 /// "trap-func-name" if specified.
4670 /// Emit a stub for the cross-DSO CFI check function.
4673 /// Emit a cross-DSO CFI failure handling function.
4676 /// Create a check for a function parameter that may potentially be
4677 /// declared as non-null.
4681 /// EmitCallArg - Emit a single call argument.
4684 /// EmitDelegateCallArg - We are performing a delegate call; that
4685 /// is, the current function is delegating to another one. Produce
4686 /// a r-value suitable for passing the given parameter.
4688 SourceLocation loc);
4690 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4691 /// point operation, expressed as the maximum relative error in ulp.
4694 /// Set the codegen fast-math flags.
4697 // Truncate or extend a boolean vector to the requested number of elements.
4709 DeferredReplacements;
4711 /// Set the address of a local variable.
4715 }
4717 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4718 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4719 ///
4720 /// \param AI - The first function argument of the expansion.
4724 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
4725 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4726 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
4738 SourceLocation Loc);
4740 /// Attempts to statically evaluate the object size of E. If that
4741 /// fails, emits code to figure the size of E out for us. This is
4742 /// pass_object_size aware.
4743 ///
4744 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
4750 /// Emits the size of E, as required by __builtin_object_size. This
4751 /// function is aware of pass_object_size parameters, and will act accordingly
4752 /// if E is a parameter with the pass_object_size attribute.
4759 Address Loc);
4763 ///! No language constraints on evaluation order.
4764 Default,
4765 ///! Language semantics require left-to-right evaluation.
4766 ForceLeftToRight,
4767 ///! Language semantics require right-to-left evaluation.
4768 ForceRightToLeft
4769 };
4771 // Wrapper for function prototype sources. Wraps either a FunctionProtoType or
4772 // an ObjCMethodDecl.
4778 };
4786 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4787 /// emit the value and compute our best estimate of the alignment of the
4788 /// pointee.
4789 ///
4790 /// \param BaseInfo - If non-null, this will be initialized with
4791 /// information about the source of the alignment and the may-alias
4792 /// attribute. Note that this function will conservatively fall back on
4793 /// the type when it doesn't recognize the expression and may-alias will
4794 /// be set to false.
4795 ///
4796 /// One reasonable way to use this information is when there's a language
4797 /// guarantee that the pointer must be aligned to some stricter value, and
4798 /// we're simply trying to ensure that sufficiently obvious uses of under-
4799 /// aligned objects don't get miscompiled; for example, a placement new
4800 /// into the address of a local variable. In such a case, it's quite
4801 /// reasonable to just ignore the returned alignment when it isn't from an
4802 /// explicit source.
4803 Address
4808 /// If \p E references a parameter with pass_object_size info or a constant
4809 /// array size modifier, emit the object size divided by the size of \p EltTy.
4810 /// Otherwise return null.
4818 StringRef Architecture;
4828 };
4830 // Emits the body of a multiversion function's resolver. Assumes that the
4831 // options are already sorted in the proper order, with the 'default' option
4832 // last (if it exists).
4835 void
4838 void
4864 };
4871 // Otherwise, we need an alloca.
4874 Address alloca =
4879 }
4882 saved_type value) {
4883 // If the value says it wasn't saved, trust that it's still dominating.
4886 // Otherwise, it should be an alloca instruction, as set up in save().
4890 }
4894 // Map the LangOption for floating point exception behavior into
4895 // the corresponding enum in the IR.
4900 #endif