29#include "llvm/IR/Constants.h"
30#include "llvm/IR/Function.h"
31#include "llvm/IR/GlobalVariable.h"
32#include "llvm/IR/Instruction.h"
33#include "llvm/IR/IntrinsicInst.h"
34#include "llvm/IR/Intrinsics.h"
43class AggExprEmitter :
public StmtVisitor<AggExprEmitter> {
49 AggValueSlot EnsureSlot(QualType
T) {
54 void EnsureDest(QualType
T) {
66 void withReturnValueSlot(
const Expr *E,
67 llvm::function_ref<RValue(ReturnValueSlot)> Fn);
69 void DoZeroInitPadding(uint64_t &PaddingStart, uint64_t PaddingEnd,
70 const FieldDecl *NextField);
73 AggExprEmitter(CodeGenFunction &cgf, AggValueSlot Dest,
bool IsResultUnused)
74 : CGF(cgf), Builder(CGF.Builder), Dest(Dest),
75 IsResultUnused(IsResultUnused) {}
84 void EmitAggLoadOfLValue(
const Expr *E);
88 void EmitFinalDestCopy(QualType
type,
const LValue &src,
91 void EmitFinalDestCopy(QualType
type, RValue src);
92 void EmitCopy(QualType
type,
const AggValueSlot &dest,
93 const AggValueSlot &src);
95 void EmitArrayInit(Address DestPtr, llvm::ArrayType *AType, QualType ArrayQTy,
96 Expr *ExprToVisit, ArrayRef<Expr *> Args,
99 void EmitComparisonResult(
const Expr *E,
100 const ComparisonCategoryInfo &CmpInfo,
101 llvm::Value *ResultValue);
104 if (CGF.
getLangOpts().getGC() && TypeRequiresGCollection(
T))
109 bool TypeRequiresGCollection(QualType
T);
115 void Visit(Expr *E) {
116 ApplyDebugLocation DL(CGF, E);
117 StmtVisitor<AggExprEmitter>::Visit(E);
120 void VisitStmt(Stmt *S) { CGF.
ErrorUnsupported(S,
"aggregate expression"); }
121 void VisitParenExpr(ParenExpr *PE) { Visit(PE->
getSubExpr()); }
122 void VisitGenericSelectionExpr(GenericSelectionExpr *GE) {
123 Visit(
GE->getResultExpr());
125 void VisitCoawaitExpr(CoawaitExpr *E) {
128 void VisitCoyieldExpr(CoyieldExpr *E) {
131 void VisitUnaryCoawait(UnaryOperator *E) { Visit(E->
getSubExpr()); }
132 void VisitUnaryExtension(UnaryOperator *E) { Visit(E->
getSubExpr()); }
133 void VisitSubstNonTypeTemplateParmExpr(SubstNonTypeTemplateParmExpr *E) {
137 void VisitConstantExpr(ConstantExpr *E) {
140 if (llvm::Value *
Result = ConstantEmitter(CGF).tryEmitConstantExpr(E)) {
143 llvm::TypeSize::getFixed(
153 void VisitDeclRefExpr(DeclRefExpr *E) { EmitAggLoadOfLValue(E); }
154 void VisitMemberExpr(MemberExpr *ME) { EmitAggLoadOfLValue(ME); }
155 void VisitUnaryDeref(UnaryOperator *E) { EmitAggLoadOfLValue(E); }
156 void VisitStringLiteral(StringLiteral *E) { EmitAggLoadOfLValue(E); }
157 void VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
158 void VisitArraySubscriptExpr(ArraySubscriptExpr *E) {
159 EmitAggLoadOfLValue(E);
161 void VisitPredefinedExpr(
const PredefinedExpr *E) { EmitAggLoadOfLValue(E); }
165 void VisitCallExpr(
const CallExpr *E);
166 void VisitStmtExpr(
const StmtExpr *E);
167 void VisitBinaryOperator(
const BinaryOperator *BO);
168 void VisitPointerToDataMemberBinaryOperator(
const BinaryOperator *BO);
169 void VisitBinAssign(
const BinaryOperator *E);
170 void VisitBinComma(
const BinaryOperator *E);
171 void VisitBinCmp(
const BinaryOperator *E);
172 void VisitTypeTraitExpr(
const TypeTraitExpr *E);
173 void VisitCXXRewrittenBinaryOperator(CXXRewrittenBinaryOperator *E) {
177 void VisitObjCMessageExpr(ObjCMessageExpr *E);
178 void VisitObjCIvarRefExpr(ObjCIvarRefExpr *E) { EmitAggLoadOfLValue(E); }
180 void VisitDesignatedInitUpdateExpr(DesignatedInitUpdateExpr *E);
181 void VisitAbstractConditionalOperator(
const AbstractConditionalOperator *CO);
182 void VisitChooseExpr(
const ChooseExpr *CE);
183 void VisitInitListExpr(InitListExpr *E);
184 void VisitCXXParenListOrInitListExpr(Expr *ExprToVisit, ArrayRef<Expr *> Args,
185 FieldDecl *InitializedFieldInUnion,
187 void VisitArrayInitLoopExpr(
const ArrayInitLoopExpr *E,
188 llvm::Value *outerBegin =
nullptr);
189 void VisitImplicitValueInitExpr(ImplicitValueInitExpr *E);
190 void VisitNoInitExpr(NoInitExpr *E) {}
191 void VisitCXXDefaultArgExpr(CXXDefaultArgExpr *DAE) {
192 CodeGenFunction::CXXDefaultArgExprScope Scope(CGF, DAE);
195 void VisitCXXDefaultInitExpr(CXXDefaultInitExpr *DIE) {
196 CodeGenFunction::CXXDefaultInitExprScope Scope(CGF, DIE);
199 void VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E);
200 void VisitCXXConstructExpr(
const CXXConstructExpr *E);
201 void VisitCXXInheritedCtorInitExpr(
const CXXInheritedCtorInitExpr *E);
203 void VisitCXXStdInitializerListExpr(CXXStdInitializerListExpr *E);
204 void VisitExprWithCleanups(ExprWithCleanups *E);
205 void VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
206 void VisitCXXTypeidExpr(CXXTypeidExpr *E) { EmitAggLoadOfLValue(E); }
207 void VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *E);
208 void VisitOpaqueValueExpr(OpaqueValueExpr *E);
210 void VisitPseudoObjectExpr(PseudoObjectExpr *E) {
213 return EmitFinalDestCopy(E->
getType(), LV);
216 AggValueSlot Slot = EnsureSlot(E->
getType());
217 bool NeedsDestruction =
220 if (NeedsDestruction)
223 if (NeedsDestruction)
228 void VisitVAArgExpr(VAArgExpr *E);
229 void VisitCXXParenListInitExpr(CXXParenListInitExpr *E);
230 void VisitCXXParenListOrInitListExpr(Expr *ExprToVisit, ArrayRef<Expr *> Args,
233 void EmitInitializationToLValue(Expr *E, LValue Address);
234 void EmitNullInitializationToLValue(LValue Address);
237 void VisitAtomicExpr(AtomicExpr *E) {
239 EmitFinalDestCopy(E->
getType(), Res);
241 void VisitPackIndexingExpr(PackIndexingExpr *E) {
254void AggExprEmitter::EmitAggLoadOfLValue(
const Expr *E) {
267 EmitFinalDestCopy(E->
getType(), LV);
271bool AggExprEmitter::TypeRequiresGCollection(QualType
T) {
287void AggExprEmitter::withReturnValueSlot(
288 const Expr *E, llvm::function_ref<RValue(ReturnValueSlot)> EmitCall) {
290 bool RequiresDestruction =
306 bool CanAggregateCopy =
311 : RetTy.isTriviallyCopyableType(CGF.getContext());
312 bool DestASMismatch = !Dest.
isIgnored() && CanAggregateCopy &&
315 ->stripPointerCasts()
317 ->getPointerAddressSpace() != SRetAS;
319 (RequiresDestruction && Dest.
isIgnored()) || DestASMismatch;
323 EHScopeStack::stable_iterator LifetimeEndBlock;
324 llvm::IntrinsicInst *LifetimeStartInst =
nullptr;
327 if (RetAddr.isValid() && RetAddr.getAddressSpace() != SRetAS) {
328 llvm::Type *SRetPtrTy =
330 RetAddr = RetAddr.withPointer(
332 RetAddr.isKnownNonNull());
339 assert(LifetimeStartInst->getIntrinsicID() ==
340 llvm::Intrinsic::lifetime_start &&
341 "Last insertion wasn't a lifetime.start?");
350 EmitCall(ReturnValueSlot(RetAddr, Dest.
isVolatile(), IsResultUnused,
358 EmitFinalDestCopy(E->
getType(), Src);
360 if (!RequiresDestruction && LifetimeStartInst) {
370void AggExprEmitter::EmitFinalDestCopy(QualType
type, RValue src) {
371 assert(src.
isAggregate() &&
"value must be aggregate value!");
377void AggExprEmitter::EmitFinalDestCopy(
378 QualType
type,
const LValue &src,
412 EmitCopy(
type, Dest, srcAgg);
419void AggExprEmitter::EmitCopy(QualType
type,
const AggValueSlot &dest,
420 const AggValueSlot &src) {
440void AggExprEmitter::VisitCXXStdInitializerListExpr(
441 CXXStdInitializerListExpr *E) {
446 assert(
Array.isSimple() &&
"initializer_list array not a simple lvalue");
449 const ConstantArrayType *ArrayType =
451 assert(ArrayType &&
"std::initializer_list constructed from non-array");
455 assert(Field !=
Record->field_end() &&
458 "Expected std::initializer_list first field to be const E *");
461 AggValueSlot Dest = EnsureSlot(E->
getType());
467 assert(Field !=
Record->field_end() &&
468 "Expected std::initializer_list to have two fields");
470 llvm::Value *
Size = Builder.getInt(ArrayType->
getSize());
478 assert(
Field->getType()->isPointerType() &&
481 "Expected std::initializer_list second field to be const E *");
482 llvm::Value *
Zero = llvm::ConstantInt::get(CGF.
PtrDiffTy, 0);
483 llvm::Value *IdxEnd[] = {
Zero,
Size};
484 llvm::Value *ArrayEnd = Builder.CreateInBoundsGEP(
490 assert(++Field ==
Record->field_end() &&
491 "Expected std::initializer_list to only have two fields");
508 SrcTy = VT->getElementType();
509 assert(StoreList.size() <= VT->getNumElements() &&
510 "Cannot perform HLSL flat cast when vector source \
511 object has less elements than flattened destination \
515 for (
unsigned I = 0, Size = StoreList.size(); I < Size; I++) {
516 LValue DestLVal = StoreList[I];
536 assert(StoreList.size() <= LoadList.size() &&
537 "Cannot perform HLSL elementwise cast when flattened source object \
538 has less elements than flattened destination object.");
541 for (
unsigned I = 0, E = StoreList.size(); I < E; I++) {
542 LValue DestLVal = StoreList[I];
543 LValue SrcLVal = LoadList[I];
545 assert(RVal.
isScalar() &&
"All flattened source values should be scalars");
548 DestLVal.getType(), Loc);
555void AggExprEmitter::EmitArrayInit(Address DestPtr, llvm::ArrayType *AType,
556 QualType ArrayQTy, Expr *ExprToVisit,
557 ArrayRef<Expr *> Args, Expr *ArrayFiller) {
558 uint64_t NumInitElements = Args.size();
560 uint64_t NumArrayElements = AType->getNumElements();
561 for (
const auto *
Init : Args) {
562 if (
const auto *Embed = dyn_cast<EmbedExpr>(
Init->IgnoreParenImpCasts())) {
563 NumInitElements += Embed->getDataElementCount() - 1;
564 if (NumInitElements > NumArrayElements) {
565 NumInitElements = NumArrayElements;
571 assert(NumInitElements <= NumArrayElements);
573 QualType elementType =
576 CharUnits elementAlign =
583 if (NumInitElements * elementSize.
getQuantity() > 16 &&
585 CodeGen::CodeGenModule &CGM = CGF.
CGM;
586 ConstantEmitter Emitter(CGF);
591 if (llvm::Constant *
C =
592 Emitter.tryEmitForInitializer(ExprToVisit, AS, GVArrayQTy)) {
593 auto GV =
new llvm::GlobalVariable(
595 true, llvm::GlobalValue::PrivateLinkage,
C,
597 nullptr, llvm::GlobalVariable::NotThreadLocal,
599 Emitter.finalize(GV);
602 Address GVAddr(GV, GV->getValueType(), Align);
603 EmitFinalDestCopy(ArrayQTy, CGF.
MakeAddrLValue(GVAddr, GVArrayQTy));
613 CodeGenFunction::CleanupDeactivationScope deactivation(CGF);
617 CodeGenFunction::AllocaTrackerRAII allocaTracker(CGF);
622 llvm::Instruction *dominatingIP =
623 Builder.CreateFlagLoad(llvm::ConstantInt::getNullValue(CGF.
Int8PtrTy));
625 "arrayinit.endOfInit");
626 Builder.CreateStore(begin, endOfInit);
631 .AddAuxAllocas(allocaTracker.Take());
637 llvm::Value *one = llvm::ConstantInt::get(CGF.
SizeTy, 1);
640 llvm::Value *element = begin;
641 if (ArrayIndex > 0) {
643 element = Builder.CreateStructuredGEP(
644 AType, begin, llvm::ConstantInt::get(CGF.
SizeTy, ArrayIndex),
645 "arrayinit.element");
647 element = Builder.CreateInBoundsGEP(
648 llvmElementType, begin,
649 llvm::ConstantInt::get(CGF.
SizeTy, ArrayIndex),
650 "arrayinit.element");
656 Builder.CreateStore(element, endOfInit);
660 Address(element, llvmElementType, elementAlign), elementType);
661 EmitInitializationToLValue(
Init, elementLV);
665 unsigned ArrayIndex = 0;
667 for (uint64_t i = 0; i != NumInitElements; ++i) {
668 if (ArrayIndex >= NumInitElements)
670 if (
auto *EmbedS = dyn_cast<EmbedExpr>(Args[i]->IgnoreParenImpCasts())) {
671 EmbedS->doForEachDataElement(Emit, ArrayIndex);
673 Emit(Args[i], ArrayIndex);
684 if (NumInitElements != NumArrayElements &&
685 !(Dest.
isZeroed() && hasTrivialFiller &&
692 llvm::Value *element = begin;
693 if (NumInitElements) {
694 element = Builder.CreateInBoundsGEP(
695 llvmElementType, element,
696 llvm::ConstantInt::get(CGF.
SizeTy, NumInitElements),
699 Builder.CreateStore(element, endOfInit);
703 llvm::Value *end = Builder.CreateInBoundsGEP(
704 llvmElementType, begin,
705 llvm::ConstantInt::get(CGF.
SizeTy, NumArrayElements),
"arrayinit.end");
707 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
712 llvm::PHINode *currentElement =
713 Builder.CreatePHI(element->getType(), 2,
"arrayinit.cur");
714 currentElement->addIncoming(element, entryBB);
726 CodeGenFunction::RunCleanupsScope CleanupsScope(CGF);
728 Address(currentElement, llvmElementType, elementAlign), elementType);
730 EmitInitializationToLValue(ArrayFiller, elementLV);
732 EmitNullInitializationToLValue(elementLV);
736 llvm::Value *nextElement = Builder.CreateInBoundsGEP(
737 llvmElementType, currentElement, one,
"arrayinit.next");
741 Builder.CreateStore(nextElement, endOfInit);
745 Builder.CreateICmpEQ(nextElement, end,
"arrayinit.done");
747 Builder.CreateCondBr(done, endBB, bodyBB);
748 currentElement->addIncoming(nextElement, Builder.GetInsertBlock());
761void AggExprEmitter::VisitMaterializeTemporaryExpr(
762 MaterializeTemporaryExpr *E) {
766void AggExprEmitter::VisitOpaqueValueExpr(OpaqueValueExpr *e) {
774void AggExprEmitter::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
778 EmitAggLoadOfLValue(E);
782 AggValueSlot Slot = EnsureSlot(E->
getType());
803 if (
auto castE = dyn_cast<CastExpr>(op)) {
804 if (castE->getCastKind() ==
kind)
805 return castE->getSubExpr();
810void AggExprEmitter::VisitCastExpr(
CastExpr *E) {
811 if (
const auto *ECE = dyn_cast<ExplicitCastExpr>(E))
846 case CK_LValueToRValueBitCast: {
854 Address SourceAddress = SourceLV.getAddress().withElementType(CGF.
Int8Ty);
856 llvm::Value *SizeVal = llvm::ConstantInt::get(
859 Builder.CreateMemCpy(DestAddress, SourceAddress, SizeVal);
863 case CK_DerivedToBase: {
865 "Derived/Base casts in EmitAggExpr are only supported in HLSL");
876 AggValueSlot DestBaseSlot = Dest;
877 Dest = DerivedTmpSlot;
896 EmitCopy(E->
getType(), DestBaseSlot, SrcBaseSlot);
901 case CK_BaseToDerived:
902 case CK_UncheckedDerivedToBase: {
903 llvm_unreachable(
"cannot perform hierarchy conversion in EmitAggExpr: "
904 "should have been unpacked before we got here");
907 case CK_NonAtomicToAtomic:
908 case CK_AtomicToNonAtomic: {
909 bool isToAtomic = (E->
getCastKind() == CK_NonAtomicToAtomic);
913 QualType valueType = E->
getType();
919 valueType,
atomicType->castAs<AtomicType>()->getValueType()));
928 (isToAtomic ? CK_AtomicToNonAtomic : CK_NonAtomicToAtomic);
935 "peephole significantly changed types?");
942 AggValueSlot valueDest = Dest;
965 AggValueSlot atomicSlot =
971 return EmitFinalDestCopy(valueType, rvalue);
973 case CK_AddressSpaceConversion:
976 case CK_LValueToRValue:
997 case CK_HLSLArrayRValue:
1004 case CK_HLSLAggregateSplatCast: {
1006 QualType SrcTy = Src->
getType();
1012 "RHS of HLSL splat cast must be a scalar.");
1017 case CK_HLSLElementwiseCast: {
1019 QualType SrcTy = Src->
getType();
1027 "HLSL Elementwise cast doesn't handle splatting.");
1031 "Can't perform HLSL Aggregate cast on a complex type.");
1039 case CK_UserDefinedConversion:
1040 case CK_ConstructorConversion:
1043 "Implicit cast types must be compatible");
1047 case CK_LValueBitCast:
1048 llvm_unreachable(
"should not be emitting lvalue bitcast as rvalue");
1052 case CK_ArrayToPointerDecay:
1053 case CK_FunctionToPointerDecay:
1054 case CK_NullToPointer:
1055 case CK_NullToMemberPointer:
1056 case CK_BaseToDerivedMemberPointer:
1057 case CK_DerivedToBaseMemberPointer:
1058 case CK_MemberPointerToBoolean:
1059 case CK_ReinterpretMemberPointer:
1060 case CK_IntegralToPointer:
1061 case CK_PointerToIntegral:
1062 case CK_PointerToBoolean:
1064 case CK_VectorSplat:
1065 case CK_IntegralCast:
1066 case CK_BooleanToSignedIntegral:
1067 case CK_IntegralToBoolean:
1068 case CK_IntegralToFloating:
1069 case CK_FloatingToIntegral:
1070 case CK_FloatingToBoolean:
1071 case CK_FloatingCast:
1072 case CK_CPointerToObjCPointerCast:
1073 case CK_BlockPointerToObjCPointerCast:
1074 case CK_AnyPointerToBlockPointerCast:
1075 case CK_ObjCObjectLValueCast:
1076 case CK_FloatingRealToComplex:
1077 case CK_FloatingComplexToReal:
1078 case CK_FloatingComplexToBoolean:
1079 case CK_FloatingComplexCast:
1080 case CK_FloatingComplexToIntegralComplex:
1081 case CK_IntegralRealToComplex:
1082 case CK_IntegralComplexToReal:
1083 case CK_IntegralComplexToBoolean:
1084 case CK_IntegralComplexCast:
1085 case CK_IntegralComplexToFloatingComplex:
1086 case CK_ARCProduceObject:
1087 case CK_ARCConsumeObject:
1088 case CK_ARCReclaimReturnedObject:
1089 case CK_ARCExtendBlockObject:
1090 case CK_CopyAndAutoreleaseBlockObject:
1091 case CK_BuiltinFnToFnPtr:
1092 case CK_ZeroToOCLOpaqueType:
1094 case CK_HLSLVectorTruncation:
1095 case CK_HLSLMatrixTruncation:
1096 case CK_IntToOCLSampler:
1097 case CK_FloatingToFixedPoint:
1098 case CK_FixedPointToFloating:
1099 case CK_FixedPointCast:
1100 case CK_FixedPointToBoolean:
1101 case CK_FixedPointToIntegral:
1102 case CK_IntegralToFixedPoint:
1103 llvm_unreachable(
"cast kind invalid for aggregate types");
1107void AggExprEmitter::VisitCallExpr(
const CallExpr *E) {
1109 EmitAggLoadOfLValue(E);
1113 withReturnValueSlot(
1114 E, [&](ReturnValueSlot Slot) {
return CGF.
EmitCallExpr(E, Slot); });
1117void AggExprEmitter::VisitObjCMessageExpr(ObjCMessageExpr *E) {
1118 withReturnValueSlot(E, [&](ReturnValueSlot Slot) {
1123void AggExprEmitter::VisitBinComma(
const BinaryOperator *E) {
1128void AggExprEmitter::VisitStmtExpr(
const StmtExpr *E) {
1129 CodeGenFunction::StmtExprEvaluation eval(CGF);
1142 const char *NameSuffix =
"") {
1145 ArgTy = CT->getElementType();
1149 "member pointers may only be compared for equality");
1151 CGF, LHS, RHS, MPT,
false);
1155 struct CmpInstInfo {
1157 llvm::CmpInst::Predicate FCmp;
1158 llvm::CmpInst::Predicate SCmp;
1159 llvm::CmpInst::Predicate UCmp;
1161 CmpInstInfo InstInfo = [&]() -> CmpInstInfo {
1162 using FI = llvm::FCmpInst;
1163 using II = llvm::ICmpInst;
1166 return {
"cmp.lt", FI::FCMP_OLT, II::ICMP_SLT, II::ICMP_ULT};
1168 return {
"cmp.gt", FI::FCMP_OGT, II::ICMP_SGT, II::ICMP_UGT};
1170 return {
"cmp.eq", FI::FCMP_OEQ, II::ICMP_EQ, II::ICMP_EQ};
1172 llvm_unreachable(
"Unrecognised CompareKind enum");
1176 return Builder.CreateFCmp(InstInfo.FCmp, LHS, RHS,
1177 llvm::Twine(InstInfo.Name) + NameSuffix);
1181 return Builder.CreateICmp(Inst, LHS, RHS,
1182 llvm::Twine(InstInfo.Name) + NameSuffix);
1185 llvm_unreachable(
"unsupported aggregate binary expression should have "
1186 "already been handled");
1189void AggExprEmitter::EmitComparisonResult(
const Expr *E,
1190 const ComparisonCategoryInfo &CmpInfo,
1191 llvm::Value *ResultValue) {
1204void AggExprEmitter::VisitBinCmp(
const BinaryOperator *E) {
1205 using llvm::BasicBlock;
1206 using llvm::PHINode;
1210 const ComparisonCategoryInfo &CmpInfo =
1213 "cannot copy non-trivially copyable aggregate");
1225 auto EmitOperand = [&](Expr *E) -> std::pair<Value *, Value *> {
1234 auto LHSValues = EmitOperand(E->
getLHS()),
1235 RHSValues = EmitOperand(E->
getRHS());
1239 K, IsComplex ?
".r" :
"");
1244 RHSValues.second, K,
".i");
1245 return Builder.CreateAnd(
Cmp, CmpImag,
"and.eq");
1247 auto EmitCmpRes = [&](
const ComparisonCategoryInfo::ValueInfo *VInfo) {
1248 return Builder.getInt(VInfo->getIntValue());
1256 Builder.CreateSelect(EmitCmp(
CK_Less), EmitCmpRes(CmpInfo.
getLess()),
1258 Select = Builder.CreateSelect(EmitCmp(
CK_Equal),
1260 SelectOne,
"sel.eq");
1262 Value *SelectEq = Builder.CreateSelect(
1267 SelectEq,
"sel.gt");
1268 Select = Builder.CreateSelect(
1269 EmitCmp(
CK_Less), EmitCmpRes(CmpInfo.
getLess()), SelectGT,
"sel.lt");
1272 EmitComparisonResult(E, CmpInfo, Select);
1275void AggExprEmitter::VisitTypeTraitExpr(
const TypeTraitExpr *E) {
1277 "expected a strong_ordering type trait with a stored value");
1279 const ComparisonCategoryInfo &CmpInfo =
1283 llvm::Value *ResultValue =
1286 EmitComparisonResult(E, CmpInfo, ResultValue);
1289void AggExprEmitter::VisitBinaryOperator(
const BinaryOperator *E) {
1291 VisitPointerToDataMemberBinaryOperator(E);
1296void AggExprEmitter::VisitPointerToDataMemberBinaryOperator(
1297 const BinaryOperator *E) {
1299 EmitFinalDestCopy(E->
getType(), LV);
1302void AggExprEmitter::VisitBinAssign(
const BinaryOperator *E) {
1308 "Invalid assignment");
1324 if (LHS.getType()->isAtomicType() ||
1343 if (LHS.getType()->isAtomicType() ||
1362 EmitFinalDestCopy(E->
getType(), LHS);
1370void AggExprEmitter::VisitAbstractConditionalOperator(
1371 const AbstractConditionalOperator *E) {
1377 CodeGenFunction::OpaqueValueMapping binding(CGF, E);
1379 CodeGenFunction::ConditionalEvaluation eval(CGF);
1385 bool destructNonTrivialCStruct =
1386 !isExternallyDestructed &&
1388 isExternallyDestructed |= destructNonTrivialCStruct;
1397 assert(CGF.
HaveInsertPoint() &&
"expression evaluation ended with no IP!");
1398 CGF.
Builder.CreateBr(ContBlock);
1412 if (destructNonTrivialCStruct)
1419void AggExprEmitter::VisitChooseExpr(
const ChooseExpr *CE) {
1423void AggExprEmitter::VisitVAArgExpr(VAArgExpr *VE) {
1434void AggExprEmitter::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E) {
1446 if (!wasExternallyDestructed)
1450void AggExprEmitter::VisitCXXConstructExpr(
const CXXConstructExpr *E) {
1451 AggValueSlot Slot = EnsureSlot(E->
getType());
1455void AggExprEmitter::VisitCXXInheritedCtorInitExpr(
1456 const CXXInheritedCtorInitExpr *E) {
1457 AggValueSlot Slot = EnsureSlot(E->
getType());
1463void AggExprEmitter::VisitLambdaExpr(
LambdaExpr *E) {
1464 AggValueSlot Slot = EnsureSlot(E->
getType());
1469 CodeGenFunction::CleanupDeactivationScope scope(CGF);
1474 i != e; ++i, ++CurField) {
1477 if (CurField->hasCapturedVLAType()) {
1482 EmitInitializationToLValue(*i, LV);
1486 CurField->getType().isDestructedType()) {
1487 assert(LV.isSimple());
1490 CurField->getType(),
1496void AggExprEmitter::VisitExprWithCleanups(ExprWithCleanups *E) {
1497 CodeGenFunction::RunCleanupsScope cleanups(CGF);
1501void AggExprEmitter::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1503 AggValueSlot Slot = EnsureSlot(
T);
1507void AggExprEmitter::VisitImplicitValueInitExpr(ImplicitValueInitExpr *E) {
1509 AggValueSlot Slot = EnsureSlot(
T);
1520 case CK_UserDefinedConversion:
1521 case CK_ConstructorConversion:
1527 case CK_BooleanToSignedIntegral:
1528 case CK_FloatingCast:
1529 case CK_FloatingComplexCast:
1530 case CK_FloatingComplexToBoolean:
1531 case CK_FloatingComplexToIntegralComplex:
1532 case CK_FloatingComplexToReal:
1533 case CK_FloatingRealToComplex:
1534 case CK_FloatingToBoolean:
1535 case CK_FloatingToIntegral:
1536 case CK_IntegralCast:
1537 case CK_IntegralComplexCast:
1538 case CK_IntegralComplexToBoolean:
1539 case CK_IntegralComplexToFloatingComplex:
1540 case CK_IntegralComplexToReal:
1541 case CK_IntegralRealToComplex:
1542 case CK_IntegralToBoolean:
1543 case CK_IntegralToFloating:
1545 case CK_IntegralToPointer:
1546 case CK_PointerToIntegral:
1548 case CK_VectorSplat:
1550 case CK_NonAtomicToAtomic:
1551 case CK_AtomicToNonAtomic:
1552 case CK_HLSLVectorTruncation:
1553 case CK_HLSLMatrixTruncation:
1554 case CK_HLSLElementwiseCast:
1555 case CK_HLSLAggregateSplatCast:
1558 case CK_BaseToDerivedMemberPointer:
1559 case CK_DerivedToBaseMemberPointer:
1560 case CK_MemberPointerToBoolean:
1561 case CK_NullToMemberPointer:
1562 case CK_ReinterpretMemberPointer:
1566 case CK_AnyPointerToBlockPointerCast:
1567 case CK_BlockPointerToObjCPointerCast:
1568 case CK_CPointerToObjCPointerCast:
1569 case CK_ObjCObjectLValueCast:
1570 case CK_IntToOCLSampler:
1571 case CK_ZeroToOCLOpaqueType:
1575 case CK_FixedPointCast:
1576 case CK_FixedPointToBoolean:
1577 case CK_FixedPointToFloating:
1578 case CK_FixedPointToIntegral:
1579 case CK_FloatingToFixedPoint:
1580 case CK_IntegralToFixedPoint:
1584 case CK_AddressSpaceConversion:
1585 case CK_BaseToDerived:
1586 case CK_DerivedToBase:
1588 case CK_NullToPointer:
1589 case CK_PointerToBoolean:
1594 case CK_ARCConsumeObject:
1595 case CK_ARCExtendBlockObject:
1596 case CK_ARCProduceObject:
1597 case CK_ARCReclaimReturnedObject:
1598 case CK_CopyAndAutoreleaseBlockObject:
1599 case CK_ArrayToPointerDecay:
1600 case CK_FunctionToPointerDecay:
1601 case CK_BuiltinFnToFnPtr:
1603 case CK_LValueBitCast:
1604 case CK_LValueToRValue:
1605 case CK_LValueToRValueBitCast:
1606 case CK_UncheckedDerivedToBase:
1607 case CK_HLSLArrayRValue:
1610 llvm_unreachable(
"Unhandled clang::CastKind enum");
1618 while (
auto *CE = dyn_cast<CastExpr>(E)) {
1626 return IL->getValue() == 0;
1629 return FL->getValue().isPosZero();
1635 if (
const CastExpr *ICE = dyn_cast<CastExpr>(E))
1636 return ICE->getCastKind() == CK_NullToPointer &&
1641 return CL->getValue() == 0;
1647void AggExprEmitter::EmitInitializationToLValue(Expr *E, LValue LV) {
1648 QualType
type = LV.getType();
1655 return EmitNullInitializationToLValue(LV);
1659 }
else if (
type->isReferenceType()) {
1667void AggExprEmitter::EmitNullInitializationToLValue(LValue lv) {
1668 QualType
type = lv.getType();
1680 if (lv.isBitField()) {
1683 assert(lv.isSimple());
1694void AggExprEmitter::VisitCXXParenListInitExpr(CXXParenListInitExpr *E) {
1700void AggExprEmitter::VisitInitListExpr(InitListExpr *E) {
1707 VisitCXXParenListOrInitListExpr(
1711void AggExprEmitter::VisitCXXParenListOrInitListExpr(
1712 Expr *ExprToVisit, ArrayRef<Expr *> InitExprs,
1713 FieldDecl *InitializedFieldInUnion, Expr *ArrayFiller) {
1720 if (llvm::Constant *
C =
1721 CGF.
CGM.EmitConstantExpr(ExprToVisit, ExprToVisit->
getType(), &CGF)) {
1722 llvm::GlobalVariable* GV =
1723 new llvm::GlobalVariable(CGF.
CGM.
getModule(),
C->getType(),
true,
1724 llvm::GlobalValue::InternalLinkage,
C,
"");
1725 EmitFinalDestCopy(ExprToVisit->
getType(),
1743 AggValueSlot Dest = EnsureSlot(ExprToVisit->
getType());
1751 InitExprs, ArrayFiller);
1757 assert(InitExprs.size() == 0 &&
1758 "you can only use an empty initializer with VLAs");
1764 "Only support structs/unions here!");
1770 unsigned NumInitElements = InitExprs.size();
1775 CodeGenFunction::CleanupDeactivationScope DeactivateCleanups(CGF);
1777 unsigned curInitIndex = 0;
1780 if (
auto *CXXRD = dyn_cast<CXXRecordDecl>(record)) {
1781 assert(NumInitElements >= CXXRD->getNumBases() &&
1782 "missing initializer for base class");
1783 for (
auto &Base : CXXRD->bases()) {
1784 assert(!
Base.isVirtual() &&
"should not see vbases here");
1785 auto *BaseRD =
Base.getType()->getAsCXXRecordDecl();
1793 CGF.
EmitAggExpr(InitExprs[curInitIndex++], AggSlot);
1796 Base.getType().isDestructedType())
1802 CodeGenFunction::FieldConstructionScope FCS(CGF, Dest.
getAddress());
1804 const bool ZeroInitPadding =
1810 if (!InitializedFieldInUnion) {
1816 for (
const auto *Field : record->
fields())
1818 (
Field->isUnnamedBitField() ||
Field->isAnonymousStructOrUnion()) &&
1819 "Only unnamed bitfields or anonymous class allowed");
1825 FieldDecl *
Field = InitializedFieldInUnion;
1828 if (NumInitElements) {
1830 EmitInitializationToLValue(InitExprs[0], FieldLoc);
1831 if (ZeroInitPadding) {
1835 DoZeroInitPadding(FieldSize, TotalSize,
nullptr);
1839 if (ZeroInitPadding)
1840 EmitNullInitializationToLValue(DestLV);
1842 EmitNullInitializationToLValue(FieldLoc);
1852 for (
const auto *field : record->
fields()) {
1854 if (field->getType()->isIncompleteArrayType())
1858 if (field->isUnnamedBitField())
1864 if (curInitIndex == NumInitElements && Dest.
isZeroed() &&
1868 if (ZeroInitPadding)
1869 DoZeroInitPadding(PaddingStart,
1876 if (curInitIndex < NumInitElements) {
1878 EmitInitializationToLValue(InitExprs[curInitIndex++], LV);
1881 EmitNullInitializationToLValue(LV);
1888 field->getType().isDestructedType()) {
1889 assert(LV.isSimple());
1897 if (ZeroInitPadding) {
1900 DoZeroInitPadding(PaddingStart, TotalSize,
nullptr);
1904void AggExprEmitter::DoZeroInitPadding(uint64_t &PaddingStart,
1905 uint64_t PaddingEnd,
1906 const FieldDecl *NextField) {
1914 llvm::Constant *SizeVal = Builder.getInt64((End - Start).getQuantity());
1918 if (NextField !=
nullptr && NextField->
isBitField()) {
1921 const CGRecordLayout &RL =
1925 if (StorageStart + Info.
StorageSize > PaddingStart) {
1926 if (StorageStart > PaddingStart)
1927 InitBytes(PaddingStart, StorageStart);
1940 if (PaddingStart < PaddingEnd)
1941 InitBytes(PaddingStart, PaddingEnd);
1942 if (NextField !=
nullptr)
1947void AggExprEmitter::VisitArrayInitLoopExpr(
const ArrayInitLoopExpr *E,
1948 llvm::Value *outerBegin) {
1950 CodeGenFunction::OpaqueValueMapping binding(CGF, E->
getCommonExpr());
1959 llvm::Value *zero = llvm::ConstantInt::get(CGF.
SizeTy, 0);
1960 llvm::Value *indices[] = {zero, zero};
1961 llvm::Value *begin = Builder.CreateInBoundsGEP(destPtr.
getElementType(),
1963 indices,
"arrayinit.begin");
1969 ArrayInitLoopExpr *InnerLoop = dyn_cast<ArrayInitLoopExpr>(E->
getSubExpr());
1971 QualType elementType =
1974 CharUnits elementAlign =
1978 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1983 llvm::PHINode *index =
1984 Builder.CreatePHI(zero->getType(), 2,
"arrayinit.index");
1985 index->addIncoming(zero, entryBB);
1986 llvm::Value *element =
1987 Builder.CreateInBoundsGEP(llvmElementType, begin, index);
1994 EHScopeStack::stable_iterator
cleanup;
1996 if (outerBegin->getType() != element->getType())
1997 outerBegin = Builder.CreateBitCast(outerBegin, element->getType());
2010 CodeGenFunction::RunCleanupsScope CleanupsScope(CGF);
2011 CodeGenFunction::ArrayInitLoopExprScope Scope(CGF, index);
2013 Address(element, llvmElementType, elementAlign), elementType);
2021 AggExprEmitter(CGF, elementSlot,
false)
2022 .VisitArrayInitLoopExpr(InnerLoop, outerBegin);
2024 EmitInitializationToLValue(E->
getSubExpr(), elementLV);
2028 llvm::Value *nextIndex = Builder.CreateNUWAdd(
2029 index, llvm::ConstantInt::get(CGF.
SizeTy, 1),
"arrayinit.next");
2030 index->addIncoming(nextIndex, Builder.GetInsertBlock());
2033 llvm::Value *done = Builder.CreateICmpEQ(
2034 nextIndex, llvm::ConstantInt::get(CGF.
SizeTy, numElements),
2037 Builder.CreateCondBr(done, endBB, bodyBB);
2049void AggExprEmitter::VisitDesignatedInitUpdateExpr(
2050 DesignatedInitUpdateExpr *E) {
2051 AggValueSlot Dest = EnsureSlot(E->
getType());
2054 EmitInitializationToLValue(E->
getBase(), DestLV);
2066 if (
auto *MTE = dyn_cast<MaterializeTemporaryExpr>(E))
2067 E = MTE->getSubExpr();
2078 ILE = dyn_cast<InitListExpr>(ILE->
getInit(0));
2086 if (!RT->isUnionType()) {
2090 unsigned ILEElement = 0;
2091 if (
auto *CXXRD = dyn_cast<CXXRecordDecl>(SD))
2092 while (ILEElement != CXXRD->getNumBases())
2095 for (
const auto *Field : SD->
fields()) {
2098 if (Field->getType()->isIncompleteArrayType() ||
2101 if (Field->isUnnamedBitField())
2107 if (Field->getType()->isReferenceType())
2114 return NumNonZeroBytes;
2120 for (
unsigned i = 0, e = ILE->
getNumInits(); i != e; ++i)
2122 return NumNonZeroBytes;
2153 if (NumNonZeroBytes * 4 > Size)
2157 llvm::Constant *SizeVal = CGF.
Builder.getInt64(Size.getQuantity());
2172 "Invalid aggregate expression to emit");
2174 "slot has bits but no address");
2179 AggExprEmitter(*
this, Slot, Slot.
isIgnored()).Visit(
const_cast<Expr *
>(E));
2196 return AggExprEmitter(*
this, Dest, Dest.
isIgnored())
2197 .EmitFinalDestCopy(
Type, Src, SrcKind);
2240 getContext().getASTRecordLayout(BaseRD).getSize() <=
2258 assert((
Record->hasTrivialCopyConstructorForCall() ||
2259 Record->hasTrivialCopyAssignment() ||
2260 Record->hasTrivialMoveConstructorForCall() ||
2261 Record->hasTrivialMoveAssignment() ||
Record->isUnion() ||
2264 "Trying to aggregate-copy a type without a trivial copy/move "
2265 "constructor or assignment operator");
2274 if (
getTargetHooks().emitCUDADeviceBuiltinSurfaceDeviceCopy(*
this, Dest,
2278 if (
getTargetHooks().emitCUDADeviceBuiltinTextureDeviceCopy(*
this, Dest,
2285 "copies of aggregates in hlsl_constant address space should be "
2286 "handled earlier by the HLSL runtime");
2308 llvm::Value *SizeVal =
nullptr;
2311 if (
auto *VAT = dyn_cast_or_null<VariableArrayType>(
2317 SizeVal =
Builder.CreateNUWMul(
2346 if (
Record->hasObjectMember()) {
2347 CGM.getObjCRuntime().EmitGCMemmoveCollectable(*
this, DestPtr, SrcPtr,
2353 if (
const auto *
Record = BaseType->getAsRecordDecl()) {
2354 if (
Record->hasObjectMember()) {
2355 CGM.getObjCRuntime().EmitGCMemmoveCollectable(*
this, DestPtr, SrcPtr,
2362 auto *Inst =
Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, isVolatile);
2369 if (llvm::MDNode *TBAAStructTag =
CGM.getTBAAStructInfo(Ty))
2370 Inst->setMetadata(llvm::LLVMContext::MD_tbaa_struct, TBAAStructTag);
2372 if (
CGM.getCodeGenOpts().NewStructPathTBAA) {
2375 CGM.DecorateInstructionWithTBAA(Inst, TBAAInfo);
Defines the clang::ASTContext interface.
static CharUnits GetNumNonZeroBytesInInit(const Expr *E, CodeGenFunction &CGF)
GetNumNonZeroBytesInInit - Get an approximate count of the number of non-zero bytes that will be stor...
static Expr * findPeephole(Expr *op, CastKind kind, const ASTContext &ctx)
Attempt to look through various unimportant expressions to find a cast of the given kind.
static bool isSimpleZero(const Expr *E, CodeGenFunction &CGF)
isSimpleZero - If emitting this value will obviously just cause a store of zero to memory,...
static llvm::Value * EmitCompare(CGBuilderTy &Builder, CodeGenFunction &CGF, const BinaryOperator *E, llvm::Value *LHS, llvm::Value *RHS, CompareKind Kind, const char *NameSuffix="")
static void EmitHLSLElementwiseCast(CodeGenFunction &CGF, LValue DestVal, LValue SrcVal, SourceLocation Loc)
static bool castPreservesZero(const CastExpr *CE)
Determine whether the given cast kind is known to always convert values with all zero bits in their v...
static void CheckAggExprForMemSetUse(AggValueSlot &Slot, const Expr *E, CodeGenFunction &CGF)
CheckAggExprForMemSetUse - If the initializer is large and has a lot of zeros in it,...
static void EmitHLSLScalarElementwiseAndSplatCasts(CodeGenFunction &CGF, LValue DestVal, llvm::Value *SrcVal, QualType SrcTy, SourceLocation Loc)
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate....
Defines the C++ template declaration subclasses.
Result
Implement __builtin_bit_cast and related operations.
llvm::MachO::Record Record
*collection of selector each with an associated kind and an ordered *collection of selectors A selector has a kind
static bool isVector(QualType QT, QualType ElementType)
This helper function returns true if QT is a vector type that has element type ElementType.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
const ConstantArrayType * getAsConstantArrayType(QualType T) const
CharUnits getTypeAlignInChars(QualType T) const
Return the ABI-specified alignment of a (complete) type T, in characters.
const ASTRecordLayout & getASTRecordLayout(const RecordDecl *D) const
Get or compute information about the layout of the specified record (struct/union/class) D,...
QualType getBaseElementType(const ArrayType *VAT) const
Return the innermost element type of an array type.
ComparisonCategories CompCategories
Types and expressions required to build C++2a three-way comparisons using operator<=>,...
QualType removeAddrSpaceQualType(QualType T) const
Remove any existing address space on the type and returns the type with qualifiers intact (or that's ...
int64_t toBits(CharUnits CharSize) const
Convert a size in characters to a size in bits.
const ArrayType * getAsArrayType(QualType T) const
Type Query functions.
uint64_t getTypeSize(QualType T) const
Return the size of the specified (complete) type T, in bits.
CharUnits getTypeSizeInChars(QualType T) const
Return the size of the specified (complete) type T, in characters.
static bool hasSameType(QualType T1, QualType T2)
Determine whether the given types T1 and T2 are equivalent.
QualType getSizeType() const
Return the unique type for "size_t" (C99 7.17), defined in <stddef.h>.
CharUnits toCharUnitsFromBits(int64_t BitSize) const
Convert a size in bits to a size in characters.
QualType getAddrSpaceQualType(QualType T, LangAS AddressSpace) const
Return the uniqued reference to the type for an address space qualified type with the specified type ...
unsigned getTargetAddressSpace(LangAS AS) const
static bool hasSameUnqualifiedType(QualType T1, QualType T2)
Determine whether the given types are equivalent after cvr-qualifiers have been removed.
ASTRecordLayout - This class contains layout information for one RecordDecl, which is a struct/union/...
uint64_t getFieldOffset(unsigned FieldNo) const
getFieldOffset - Get the offset of the given field index, in bits.
CharUnits getBaseClassOffset(const CXXRecordDecl *Base) const
getBaseClassOffset - Get the offset, in chars, for the given base class.
CharUnits getNonVirtualSize() const
getNonVirtualSize - Get the non-virtual size (in chars) of an object, which is the size of the object...
Expr * getCond() const
getCond - Return the expression representing the condition for the ?
Expr * getTrueExpr() const
getTrueExpr - Return the subexpression representing the value of the expression if the condition eval...
Expr * getFalseExpr() const
getFalseExpr - Return the subexpression representing the value of the expression if the condition eva...
llvm::APInt getArraySize() const
OpaqueValueExpr * getCommonExpr() const
Get the common subexpression shared by all initializations (the source array).
Expr * getSubExpr() const
Get the initializer to use for each array element.
QualType getElementType() const
A builtin binary operation expression such as "x + y" or "x <= y".
CXXTemporary * getTemporary()
const Expr * getSubExpr() const
Expr * getExpr()
Get the initialization expression that will be used.
bool constructsVBase() const
Determine whether this constructor is actually constructing a base class (rather than a complete obje...
CXXConstructorDecl * getConstructor() const
Get the constructor that this expression will call.
bool inheritedFromVBase() const
Determine whether the inherited constructor is inherited from a virtual base of the object we constru...
MutableArrayRef< Expr * > getInitExprs()
FieldDecl * getInitializedFieldInUnion()
Represents a C++ struct/union/class.
bool hasTrivialMoveAssignment() const
Determine whether this class has a trivial move assignment operator (C++11 [class....
bool isTriviallyCopyable() const
Determine whether this class is considered trivially copyable per (C++11 [class]p6).
bool hasTrivialMoveConstructor() const
Determine whether this class has a trivial move constructor (C++11 [class.copy]p12)
bool hasTrivialCopyConstructor() const
Determine whether this class has a trivial copy constructor (C++ [class.copy]p6, C++11 [class....
bool hasTrivialCopyAssignment() const
Determine whether this class has a trivial copy assignment operator (C++ [class.copy]p11,...
bool hasUserDeclaredConstructor() const
Determine whether this class has any user-declared constructors.
bool isEmpty() const
Determine whether this is an empty class in the sense of (C++11 [meta.unary.prop]).
Expr * getSemanticForm()
Get an equivalent semantic form for this expression.
QualType getCallReturnType(const ASTContext &Ctx) const
getCallReturnType - Get the return type of the call expr.
CastExpr - Base class for type casts, including both implicit casts (ImplicitCastExpr) and explicit c...
path_iterator path_begin()
CastKind getCastKind() const
This is an opaque type for sizes expressed in character units.
bool isZero() const
Test whether the quantity equals zero.
llvm::Align getAsAlign() const
Returns Quantity as a valid llvm::Align, Beware llvm::Align assumes power of two 8-bit bytes.
QuantityType getQuantity() const
Get the raw integer representation of this quantity.
CharUnits alignmentOfArrayElement(CharUnits elementSize) const
Given that this is the alignment of the first element of an array, return the minimum alignment of an...
static CharUnits fromQuantity(QuantityType Quantity)
Construct a CharUnits quantity from a raw integer type.
static CharUnits Zero()
Construct a CharUnits quantity of zero.
Expr * getChosenSubExpr() const
getChosenSubExpr - Return the subexpression chosen according to the condition.
Like RawAddress, an abstract representation of an aligned address, but the pointer contained in this ...
llvm::Value * getBasePointer() const
llvm::Value * emitRawPointer(CodeGenFunction &CGF) const
Return the pointer contained in this class after authenticating it and adding offset to it if necessa...
CharUnits getAlignment() const
llvm::Type * getElementType() const
Return the type of the values stored in this address.
Address withElementType(llvm::Type *ElemTy) const
Return address with different element type, but same pointer and alignment.
void setVolatile(bool flag)
static AggValueSlot ignored()
ignored - Returns an aggregate value slot indicating that the aggregate value is being ignored.
Address getAddress() const
CharUnits getPreferredSize(ASTContext &Ctx, QualType Type) const
Get the preferred size to use when storing a value to this slot.
NeedsGCBarriers_t requiresGCollection() const
void setExternallyDestructed(bool destructed=true)
void setZeroed(bool V=true)
IsZeroed_t isZeroed() const
Qualifiers getQualifiers() const
static AggValueSlot forLValue(const LValue &LV, IsDestructed_t isDestructed, NeedsGCBarriers_t needsGC, IsAliased_t isAliased, Overlap_t mayOverlap, IsZeroed_t isZeroed=IsNotZeroed, IsSanitizerChecked_t isChecked=IsNotSanitizerChecked)
IsAliased_t isPotentiallyAliased() const
static AggValueSlot forAddr(Address addr, Qualifiers quals, IsDestructed_t isDestructed, NeedsGCBarriers_t needsGC, IsAliased_t isAliased, Overlap_t mayOverlap, IsZeroed_t isZeroed=IsNotZeroed, IsSanitizerChecked_t isChecked=IsNotSanitizerChecked)
forAddr - Make a slot for an aggregate value.
IsDestructed_t isExternallyDestructed() const
Overlap_t mayOverlap() const
llvm::Value * emitRawPointer(CodeGenFunction &CGF) const
llvm::CallInst * CreateMemSet(Address Dest, llvm::Value *Value, llvm::Value *Size, bool IsVolatile=false)
Address CreateStructGEP(Address Addr, unsigned Index, const llvm::Twine &Name="")
virtual llvm::Value * EmitMemberPointerComparison(CodeGenFunction &CGF, llvm::Value *L, llvm::Value *R, const MemberPointerType *MPT, bool Inequality)
Emit a comparison between two member pointers. Returns an i1.
bool emitBufferCopy(CodeGenFunction &CGF, const Expr *E, const LValue &SrcLV, AggValueSlot &DestSlot)
bool emitGlobalResourceArray(CodeGenFunction &CGF, const Expr *E, AggValueSlot &DestSlot)
void emitInitListOpaqueValues(CodeGenFunction &CGF, InitListExpr *E)
virtual void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF, Address DestPtr, Address SrcPtr, llvm::Value *Size)=0
const CGBitFieldInfo & getBitFieldInfo(const FieldDecl *FD) const
Return the BitFieldInfo that corresponds to the field FD.
CodeGenFunction - This class organizes the per-function state that is used while generating LLVM code...
void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock, llvm::BasicBlock *FalseBlock, uint64_t TrueCount, Stmt::Likelihood LH=Stmt::LH_None, const Expr *ConditionalOp=nullptr, const VarDecl *ConditionalDecl=nullptr)
EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g.
RValue EmitObjCMessageExpr(const ObjCMessageExpr *E, ReturnValueSlot Return=ReturnValueSlot())
void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest)
AggValueSlot::Overlap_t getOverlapForFieldInit(const FieldDecl *FD)
Determine whether a field initialization may overlap some other object.
llvm::Value * performAddrSpaceCast(llvm::Value *Src, llvm::Type *DestTy)
@ UseSkipPath
Skip (false)
void callCStructMoveConstructor(LValue Dst, LValue Src)
void EmitNullInitialization(Address DestPtr, QualType Ty)
EmitNullInitialization - Generate code to set a value of the given type to null, If the type contains...
static bool hasScalarEvaluationKind(QualType T)
llvm::Type * ConvertType(QualType T)
void EmitAggFinalDestCopy(QualType Type, AggValueSlot Dest, const LValue &Src, ExprValueKind SrcKind)
EmitAggFinalDestCopy - Emit copy of the specified aggregate into destination address.
Address GetAddressOfBaseClass(Address Value, const CXXRecordDecl *Derived, CastExpr::path_const_iterator PathBegin, CastExpr::path_const_iterator PathEnd, bool NullCheckValue, SourceLocation Loc)
GetAddressOfBaseClass - This function will add the necessary delta to the load of 'this' and returns ...
void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin, llvm::Value *arrayEnd, QualType elementType, CharUnits elementAlignment, Destroyer *destroyer)
pushRegularPartialArrayCleanup - Push an EH cleanup to destroy already-constructed elements of the gi...
void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint=true)
SmallVector< llvm::ConvergenceControlInst *, 4 > ConvergenceTokenStack
Stack to track the controlled convergence tokens.
void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, llvm::Value **Result=nullptr)
EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints as EmitStoreThroughLValue.
bool hasVolatileMember(QualType T)
hasVolatileMember - returns true if aggregate type has a volatile member.
llvm::SmallVector< DeferredDeactivateCleanup > DeferredDeactivationCleanupStack
RValue EmitVAArg(VAArgExpr *VE, Address &VAListAddr, AggValueSlot Slot=AggValueSlot::ignored())
Generate code to get an argument from the passed in pointer and update it accordingly.
RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e, AggValueSlot slot=AggValueSlot::ignored())
llvm::BasicBlock * createBasicBlock(const Twine &name="", llvm::Function *parent=nullptr, llvm::BasicBlock *before=nullptr)
createBasicBlock - Create an LLVM basic block.
void addInstToCurrentSourceAtom(llvm::Instruction *KeyInstruction, llvm::Value *Backup)
See CGDebugInfo::addInstToCurrentSourceAtom.
AggValueSlot::Overlap_t getOverlapForBaseInit(const CXXRecordDecl *RD, const CXXRecordDecl *BaseRD, bool IsVirtual)
Determine whether a base class initialization may overlap some other object.
const LangOptions & getLangOpts() const
RValue EmitReferenceBindingToExpr(const Expr *E)
Emits a reference binding to the passed in expression.
LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E)
void pushDestroy(QualType::DestructionKind dtorKind, Address addr, QualType type)
pushDestroy - Push the standard destructor for the given type as at least a normal cleanup.
@ TCK_Store
Checking the destination of a store. Must be suitably sized and aligned.
@ TCK_Load
Checking the operand of a load. Must be suitably sized and aligned.
void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin, Address arrayEndPointer, QualType elementType, CharUnits elementAlignment, Destroyer *destroyer)
pushIrregularPartialArrayCleanup - Push a NormalAndEHCleanup to destroy already-constructed elements ...
Destroyer * getDestroyer(QualType::DestructionKind destructionKind)
LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e)
void CreateCoercedStore(llvm::Value *Src, QualType SrcFETy, Address Dst, llvm::TypeSize DstSize, bool DstIsVolatile)
Create a store to.
llvm::ConvergenceControlInst * emitConvergenceLoopToken(llvm::BasicBlock *BB)
void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy, AggValueSlot::Overlap_t MayOverlap, bool isVolatile=false)
EmitAggregateCopy - Emit an aggregate copy.
const TargetInfo & getTarget() const
void EmitIgnoredExpr(const Expr *E)
EmitIgnoredExpr - Emit an expression in a context which ignores the result.
RValue EmitCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue=ReturnValueSlot(), llvm::CallBase **CallOrInvoke=nullptr)
RValue EmitLoadOfLValue(LValue V, SourceLocation Loc)
EmitLoadOfLValue - Given an expression that represents a value lvalue, this method emits the address ...
void pushDestroyAndDeferDeactivation(QualType::DestructionKind dtorKind, Address addr, QualType type)
void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup, llvm::Instruction *DominatingIP)
DeactivateCleanupBlock - Deactivates the given cleanup block.
void callCStructCopyAssignmentOperator(LValue Dst, LValue Src)
void pushFullExprCleanup(CleanupKind kind, As... A)
pushFullExprCleanup - Push a cleanup to be run at the end of the current full-expression.
LValue EmitAggExprToLValue(const Expr *E)
EmitAggExprToLValue - Emit the computation of the specified expression of aggregate type into a tempo...
RValue EmitCoyieldExpr(const CoyieldExpr &E, AggValueSlot aggSlot=AggValueSlot::ignored(), bool ignoreResult=false)
AggValueSlot CreateAggTemp(QualType T, const Twine &Name="tmp", RawAddress *Alloca=nullptr)
CreateAggTemp - Create a temporary memory object for the given aggregate type.
llvm::Value * emitArrayLength(const ArrayType *arrayType, QualType &baseType, Address &addr)
emitArrayLength - Compute the length of an array, even if it's a VLA, and drill down to the base elem...
void callCStructCopyConstructor(LValue Dst, LValue Src)
bool HaveInsertPoint() const
HaveInsertPoint - True if an insertion point is defined.
RValue EmitAtomicLoad(LValue LV, SourceLocation SL, AggValueSlot Slot=AggValueSlot::ignored())
CGDebugInfo * getDebugInfo()
llvm::Value * getTypeSize(QualType Ty)
Returns calculated size of the specified type.
bool EmitLifetimeStart(llvm::Value *Addr)
Emit a lifetime.begin marker if some criteria are satisfied.
LValue EmitLValueForFieldInitialization(LValue Base, const FieldDecl *Field)
EmitLValueForFieldInitialization - Like EmitLValueForField, except that if the Field is a reference,...
Address GetAddressOfDirectBaseInCompleteClass(Address Value, const CXXRecordDecl *Derived, const CXXRecordDecl *Base, bool BaseIsVirtual)
GetAddressOfBaseOfCompleteClass - Convert the given pointer to a complete class to the given direct b...
llvm::AllocaInst * CreateTempAlloca(llvm::Type *Ty, const Twine &Name="tmp", llvm::Value *ArraySize=nullptr)
CreateTempAlloca - This creates an alloca and inserts it into the entry block if ArraySize is nullptr...
LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e)
Given an opaque value expression, return its LValue mapping if it exists, otherwise create one.
const TargetCodeGenInfo & getTargetHooks() const
void EmitLifetimeEnd(llvm::Value *Addr)
RawAddress CreateMemTempWithoutCast(QualType T, const Twine &Name="tmp")
CreateMemTemp - Create a temporary memory object of the given type, with appropriate alignmen without...
void callCStructMoveAssignmentOperator(LValue Dst, LValue Src)
ASTContext & getContext() const
void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false)
EmitStoreThroughLValue - Store the specified rvalue into the specified lvalue, where both are guarant...
void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr, QualType type, Destroyer *destroyer, bool useEHCleanupForArray)
Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast=false, AggValueSlot AVS=AggValueSlot::ignored())
EmitCompoundStmt - Emit a compound statement {..} node.
RValue EmitAnyExpr(const Expr *E, AggValueSlot aggSlot=AggValueSlot::ignored(), bool ignoreResult=false)
EmitAnyExpr - Emit code to compute the specified expression which can have any type.
bool needsEHCleanup(QualType::DestructionKind kind)
Determines whether an EH cleanup is required to destroy a type with the given destruction kind.
llvm::Type * ConvertTypeForMem(QualType T)
RValue EmitAtomicExpr(AtomicExpr *E)
void emitPFPPostCopyUpdates(Address DestPtr, Address SrcPtr, QualType Ty)
Copy all PFP fields from SrcPtr to DestPtr while updating signatures, assuming that DestPtr was alrea...
CodeGenTypes & getTypes() const
void FlattenAccessAndTypeLValue(LValue LVal, SmallVectorImpl< LValue > &AccessList)
RValue EmitCoawaitExpr(const CoawaitExpr &E, AggValueSlot aggSlot=AggValueSlot::ignored(), bool ignoreResult=false)
void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType, Address Ptr)
Emits all the code to cause the given temporary to be cleaned up.
bool LValueIsSuitableForInlineAtomic(LValue Src)
An LValue is a candidate for having its loads and stores be made atomic if we are operating under /vo...
LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK)
Same as EmitLValue but additionally we generate checking code to guard against undefined behavior.
void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D, bool ForVirtualBase, Address This, bool InheritedFromVBase, const CXXInheritedCtorInitExpr *E)
Emit a call to a constructor inherited from a base class, passing the current constructor's arguments...
void EmitInitializationToLValue(const Expr *E, LValue LV, AggValueSlot::IsZeroed_t IsZeroed=AggValueSlot::IsNotZeroed)
EmitInitializationToLValue - Emit an initializer to an LValue.
void EmitAggExpr(const Expr *E, AggValueSlot AS)
EmitAggExpr - Emit the computation of the specified expression of aggregate type.
static bool hasAggregateEvaluationKind(QualType T)
LValue MakeAddrLValue(Address Addr, QualType T, AlignmentSource Source=AlignmentSource::Type)
void EmitLambdaVLACapture(const VariableArrayType *VAT, LValue LV)
void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit)
uint64_t getProfileCount(const Stmt *S)
Get the profiler's count for the given statement.
void ErrorUnsupported(const Stmt *S, const char *Type)
ErrorUnsupported - Print out an error that codegen doesn't support the specified stmt yet.
LValue EmitLValue(const Expr *E, KnownNonNull_t IsKnownNonNull=NotKnownNonNull)
EmitLValue - Emit code to compute a designator that specifies the location of the expression.
llvm::LLVMContext & getLLVMContext()
void incrementProfileCounter(const Stmt *S, llvm::Value *StepV=nullptr)
Increment the profiler's counter for the given statement by StepV.
llvm::Value * EmitScalarConversion(llvm::Value *Src, QualType SrcTy, QualType DstTy, SourceLocation Loc)
Emit a conversion from the specified type to the specified destination type, both of which are LLVM s...
void EmitStoreOfScalar(llvm::Value *Value, Address Addr, bool Volatile, QualType Ty, AlignmentSource Source=AlignmentSource::Type, bool isInit=false, bool isNontemporal=false)
EmitStoreOfScalar - Store a scalar value to an address, taking care to appropriately convert from the...
llvm::Value * EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE)
void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false)
EmitBlock - Emit the given block.
void EmitExplicitCastExprType(const ExplicitCastExpr *E, CodeGenFunction *CGF=nullptr)
Emit type info if type of an expression is a variably modified type.
CGHLSLRuntime & getHLSLRuntime()
Return a reference to the configured HLSL runtime.
llvm::Module & getModule() const
bool isPaddedAtomicType(QualType type)
void ErrorUnsupported(const Stmt *S, const char *Type)
Print out an error that codegen doesn't support the specified stmt yet.
bool shouldEmitConvergenceTokens() const
CGCXXABI & getCXXABI() const
ASTContext & getContext() const
const TargetCodeGenInfo & getTargetCodeGenInfo()
bool shouldZeroInitPadding() const
CGObjCRuntime & getObjCRuntime()
Return a reference to the configured Objective-C runtime.
llvm::Constant * EmitNullConstant(QualType T)
Return the result of value-initializing the given type, i.e.
LangAS GetGlobalConstantAddressSpace() const
Return the AST address space of constant literal, which is used to emit the constant literal as globa...
bool isPointerZeroInitializable(QualType T)
Check if the pointer type can be zero-initialized (in the C++ sense) with an LLVM zeroinitializer.
const CGRecordLayout & getCGRecordLayout(const RecordDecl *)
getCGRecordLayout - Return record layout info for the given record decl.
bool isZeroInitializable(QualType T)
IsZeroInitializable - Return whether a type can be zero-initialized (in the C++ sense) with an LLVM z...
stable_iterator stable_begin() const
Create a stable reference to the top of the EH stack.
iterator find(stable_iterator save) const
Turn a stable reference to a scope depth into a unstable pointer to the EH stack.
LValue - This represents an lvalue references.
Address getAddress() const
TBAAAccessInfo getTBAAInfo() const
RValue - This trivial value class is used to represent the result of an expression that is evaluated.
llvm::Value * getAggregatePointer(QualType PointeeType, CodeGenFunction &CGF) const
static RValue get(llvm::Value *V)
static RValue getAggregate(Address addr, bool isVolatile=false)
Convert an Address to an RValue.
Address getAggregateAddress() const
getAggregateAddr() - Return the Value* of the address of the aggregate.
llvm::Value * getScalarVal() const
getScalarVal() - Return the Value* of this scalar value.
std::pair< llvm::Value *, llvm::Value * > getComplexVal() const
getComplexVal - Return the real/imag components of this complex value.
virtual LangAS getSRetAddrSpace(const CXXRecordDecl *RD) const
Get the address space for an indirect (sret) return of the given type.
const ComparisonCategoryInfo & getInfoForType(QualType Ty) const
Return the comparison category information as specified by getCategoryForType(Ty).
bool isPartial() const
True iff the comparison is not totally ordered.
const ValueInfo * getLess() const
const ValueInfo * getUnordered() const
const CXXRecordDecl * Record
The declaration for the comparison category type from the standard library.
const ValueInfo * getValueInfo(ComparisonCategoryResult ValueKind) const
const ValueInfo * getGreater() const
const ValueInfo * getEqualOrEquiv() const
Complex values, per C99 6.2.5p11.
const Expr * getInitializer() const
llvm::APInt getSize() const
Return the constant array size as an APInt.
InitListExpr * getUpdater() const
This represents one expression.
Expr * IgnoreParenNoopCasts(const ASTContext &Ctx) LLVM_READONLY
Skip past any parentheses and casts which do not change the value (including ptr->int casts of the sa...
Expr * IgnoreParens() LLVM_READONLY
Skip past any parentheses which might surround this expression until reaching a fixed point.
bool HasSideEffects(const ASTContext &Ctx, bool IncludePossibleEffects=true) const
HasSideEffects - This routine returns true for all those expressions which have any effect other than...
SourceLocation getExprLoc() const LLVM_READONLY
getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic exp...
Represents a member of a struct/union/class.
bool isBitField() const
Determines whether this field is a bitfield.
unsigned getFieldIndex() const
Returns the index of this field within its record, as appropriate for passing to ASTRecordLayout::get...
const RecordDecl * getParent() const
Returns the parent of this field declaration, which is the struct in which this field is defined.
const Expr * getSubExpr() const
Describes an C or C++ initializer list.
bool isTransparent() const
Is this a transparent initializer list (that is, an InitListExpr that is purely syntactic,...
FieldDecl * getInitializedFieldInUnion()
If this initializes a union, specifies which field in the union to initialize.
unsigned getNumInits() const
bool hadArrayRangeDesignator() const
Expr * getArrayFiller()
If this initializer list initializes an array with more elements than there are initializers in the l...
const Expr * getInit(unsigned Init) const
ArrayRef< Expr * > inits() const
capture_init_iterator capture_init_end()
Retrieve the iterator pointing one past the last initialization argument for this lambda expression.
Expr *const * const_capture_init_iterator
Const iterator that walks over the capture initialization arguments.
capture_init_iterator capture_init_begin()
Retrieve the first initialization argument for this lambda expression (which initializes the first ca...
CXXRecordDecl * getLambdaClass() const
Retrieve the class that corresponds to the lambda.
Expr * getSubExpr() const
Retrieve the temporary-generating subexpression whose value will be materialized into a glvalue.
A pointer to member type per C++ 8.3.3 - Pointers to members.
Expr * getSourceExpr() const
The source expression of an opaque value expression is the expression which originally generated the ...
Expr * getSelectedExpr() const
const Expr * getSubExpr() const
A (possibly-)qualified type.
bool isVolatileQualified() const
Determine whether this type is volatile-qualified.
bool isTriviallyCopyableType(const ASTContext &Context) const
Return true if this is a trivially copyable type (C++0x [basic.types]p9)
LangAS getAddressSpace() const
Return the address space of this type.
Qualifiers getQualifiers() const
Retrieve the set of qualifiers applied to this type.
DestructionKind isDestructedType() const
Returns a nonzero value if objects of this type require non-trivial work to clean up after.
@ PCK_Struct
The type is a struct containing a field whose type is neither PCK_Trivial nor PCK_VolatileTrivial.
Represents a struct/union/class.
bool hasObjectMember() const
field_range fields() const
specific_decl_iterator< FieldDecl > field_iterator
RecordDecl * getDefinitionOrSelf() const
field_iterator field_begin() const
Encodes a location in the source.
CompoundStmt * getSubStmt()
StmtVisitor - This class implements a simple visitor for Stmt subclasses.
Expr * getReplacement() const
uint64_t getPointerWidth(LangAS AddrSpace) const
Return the width of pointers on this target, for the specified address space.
bool isStoredAsComparisonResult() const
const APValue & getAPValue() const
CXXRecordDecl * getAsCXXRecordDecl() const
Retrieves the CXXRecordDecl that this type refers to, either because the type is a RecordType or beca...
bool isConstantArrayType() const
RecordDecl * getAsRecordDecl() const
Retrieves the RecordDecl this type refers to.
CXXRecordDecl * castAsCXXRecordDecl() const
bool isPointerType() const
bool isReferenceType() const
bool isScalarType() const
bool isVariableArrayType() const
bool isCUDADeviceBuiltinSurfaceType() const
Check if the type is the CUDA device builtin surface type.
bool isIntegralOrEnumerationType() const
Determine whether this type is an integral or enumeration type.
RecordDecl * castAsRecordDecl() const
bool isAnyComplexType() const
bool hasSignedIntegerRepresentation() const
Determine whether this type has an signed integer representation of some sort, e.g....
bool isMemberPointerType() const
bool isCUDADeviceBuiltinTextureType() const
Check if the type is the CUDA device builtin texture type.
bool hasFloatingRepresentation() const
Determine whether this type has a floating-point representation of some sort, e.g....
bool isVectorType() const
bool isRealFloatingType() const
Floating point categories.
const T * getAsCanonical() const
If this type is canonically the specified type, return its canonical type cast to that specified type...
const T * getAs() const
Member-template getAs<specific type>'.
bool isNullPtrType() const
bool isRecordType() const
bool isHLSLResourceRecordArray() const
Expr * getSubExpr() const
Represents a GCC generic vector type.
bool isTrivialFiller(const Expr *E)
Check whether E is a trivial array filler, that is, one that is equivalent to zero-initialization.
bool isBlockVarRef(const Expr *E)
Check whether the value of E is possibly a reference to or into a __block variable.
@ Type
The l-value was considered opaque, so the alignment was determined from a type.
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
const AstTypeMatcher< AtomicType > atomicType
@ Address
A pointer to a ValueDecl.
bool GE(InterpState &S, CodePtr OpPC)
Top level wrappers for InstallAPI frontend operations.
bool isa(CodeGen::Address addr)
if(T->getSizeExpr()) TRY_TO(TraverseStmt(const_cast< Expr * >(T -> getSizeExpr())))
ComparisonCategoryResult
An enumeration representing the possible results of a three-way comparison.
@ Result
The result type of a method or function.
const FunctionProtoType * T
LangAS
Defines the address space values used by the address space qualifier of QualType.
CastKind
CastKind - The kind of operation required for a conversion.
U cast(CodeGen::Address addr)
CharUnits StorageOffset
The offset of the bitfield storage from the start of the struct.
unsigned StorageSize
The storage size in bits which should be used when accessing this bitfield.
llvm::IntegerType * Int8Ty
i8, i16, i32, and i64
llvm::IntegerType * CharTy
char
llvm::IntegerType * SizeTy
llvm::PointerType * Int8PtrTy
llvm::IntegerType * PtrDiffTy
CharUnits getPointerAlign() const
llvm::APSInt getIntValue() const
Get the constant integer value used by this variable to represent the comparison category result type...