-
Notifications
You must be signed in to change notification settings - Fork 12.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CLANG] Full support of complex multiplication and division. #81514
Changes from 15 commits
13fd739
eb9a35c
d3c4f78
4aa0925
fcd5665
2ddba9a
e62c462
f635f94
1d61aa6
148b6ce
5aa2711
ba9a8da
9098908
52181c7
a9449de
e20741e
0d97b9b
bc3fa4f
ec6296f
3117dbd
0a08598
a558d31
dec045b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1039,30 +1039,35 @@ defm offload_uniform_block : BoolFOption<"offload-uniform-block", | |
NegFlag<SetFalse, [], [ClangOption, CC1Option], "Don't assume">, | ||
BothFlags<[], [ClangOption], " that kernels are launched with uniform block sizes (default true for CUDA/HIP and false otherwise)">>; | ||
|
||
def fcx_limited_range : Joined<["-"], "fcx-limited-range">, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't realize these had made it into the 18.0 release when I suggested that we could remove them. We would need at least one release where they are marked as deprecated, but since they are standard gcc options, maybe it makes sense to just keep them and have them alias to the new option as: -fcx-limited-range --> -fcomplex-arithmetic=basic There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The problem with aliasing is that the user would be allowed to write something like this: This warning is a bit mis-leading and doesn't reflect the option used in the command line. Not sure this can be corrected. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry. I meant "aliasing" in the non-technical sense of "having the same meaning." How that gets implemented is another matter. I think the driver could translate them to the same cc1 option. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes there is a way of doing that:
That still produces the misleading warning for: -fcx-limited-range -fcomplex-arithmetic=improved There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What I meant to suggest is that you can leave the driver-level options as if they were independent, but when we process them in RenderFloatingPointOptions, -fcx-limited-range and -fcomplex-arithmetic=basic (for example), would add the same cc1 option. Since the warning is generated from the RenderFloatingPointOptions we should be able to make that report the expected output. |
||
def fcomplex_arithmetic_EQ : Joined<["-"], "fcomplex-arithmetic=">, Group<f_Group>, | ||
Visibility<[ClangOption, CC1Option]>, | ||
Values<"full,improved,promoted,basic">, NormalizedValuesScope<"LangOptions">, | ||
NormalizedValues<["CX_Full", "CX_Improved", "CX_Promoted", "CX_Basic"]>; | ||
|
||
def complex_range_EQ : Joined<["-"], "complex-range=">, Group<f_Group>, | ||
Visibility<[CC1Option]>, | ||
Values<"full,improved,promoted,basic">, NormalizedValuesScope<"LangOptions">, | ||
NormalizedValues<["CX_Full", "CX_Improved", "CX_Promoted", "CX_Basic"]>, | ||
MarshallingInfoEnum<LangOpts<"ComplexRange">, "CX_Full">; | ||
|
||
def fcx_limited_range : Flag<["-"], "fcx-limited-range">, | ||
Group<f_Group>, Visibility<[ClangOption, CC1Option]>, | ||
HelpText<"Basic algebraic expansions of complex arithmetic operations " | ||
"involving are enabled.">; | ||
|
||
def fno_cx_limited_range : Joined<["-"], "fno-cx-limited-range">, | ||
def fno_cx_limited_range : Flag<["-"], "fno-cx-limited-range">, | ||
Group<f_Group>, Visibility<[ClangOption, CC1Option]>, | ||
HelpText<"Basic algebraic expansions of complex arithmetic operations " | ||
"involving are disabled.">; | ||
|
||
def fcx_fortran_rules : Joined<["-"], "fcx-fortran-rules">, | ||
def fcx_fortran_rules : Flag<["-"], "fcx-fortran-rules">, | ||
Group<f_Group>, Visibility<[ClangOption, CC1Option]>, | ||
HelpText<"Range reduction is enabled for complex arithmetic operations.">; | ||
|
||
def fno_cx_fortran_rules : Joined<["-"], "fno-cx-fortran-rules">, | ||
def fno_cx_fortran_rules : Flag<["-"], "fno-cx-fortran-rules">, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, just set the needed |
||
Group<f_Group>, Visibility<[ClangOption, CC1Option]>, | ||
HelpText<"Range reduction is disabled for complex arithmetic operations.">; | ||
|
||
def complex_range_EQ : Joined<["-"], "complex-range=">, Group<f_Group>, | ||
Visibility<[CC1Option]>, | ||
Values<"full,limited,fortran">, NormalizedValuesScope<"LangOptions">, | ||
NormalizedValues<["CX_Full", "CX_Limited", "CX_Fortran"]>, | ||
MarshallingInfoEnum<LangOpts<"ComplexRange">, "CX_Full">; | ||
|
||
// OpenCL-only Options | ||
def cl_opt_disable : Flag<["-"], "cl-opt-disable">, Group<opencl_Group>, | ||
Visibility<[ClangOption, CC1Option]>, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -283,9 +283,46 @@ class ComplexExprEmitter | |
ComplexPairTy EmitComplexBinOpLibCall(StringRef LibCallName, | ||
const BinOpInfo &Op); | ||
|
||
QualType getPromotionType(QualType Ty) { | ||
QualType HigherPrecisionTypeForComplexArithmetic(QualType ElementType, | ||
bool IsDivOpCode) { | ||
const TargetInfo &TI = CGF.getContext().getTargetInfo(); | ||
const LangOptions Opts = CGF.getLangOpts(); | ||
if (const auto *BT = dyn_cast<BuiltinType>(ElementType)) { | ||
switch (BT->getKind()) { | ||
case BuiltinType::Kind::Float16: { | ||
if (TI.hasFloat16Type() && !TI.hasLegalHalfType()) | ||
return CGF.getContext().getComplexType(CGF.getContext().FloatTy); | ||
break; | ||
} | ||
case BuiltinType::Kind::BFloat16: { | ||
if (TI.hasBFloat16Type() && !TI.hasFullBFloat16Type()) | ||
return CGF.getContext().getComplexType(CGF.getContext().FloatTy); | ||
break; | ||
} | ||
case BuiltinType::Kind::Float: | ||
return CGF.getContext().getComplexType(CGF.getContext().DoubleTy); | ||
break; | ||
case BuiltinType::Kind::Double: { | ||
if (TI.hasLongDoubleType()) | ||
return CGF.getContext().getComplexType(CGF.getContext().LongDoubleTy); | ||
return CGF.getContext().getComplexType(CGF.getContext().DoubleTy); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure it's a good idea to return a specific type here if it's not known to actually be higher precision? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, we need to check the sizes. If we "promote" from a 64-bit double to a 64-bit long double, we'll probably end up with something that gets optimized directly to the cx-limited-range ("basic") implementation. This can also be an issue for float. For example, AVR targets use a 32-bit type for both float and double. |
||
break; | ||
} | ||
default: | ||
return QualType(); | ||
} | ||
} | ||
return QualType(); | ||
} | ||
|
||
QualType getPromotionType(QualType Ty, bool IsDivOpCode = false) { | ||
if (auto *CT = Ty->getAs<ComplexType>()) { | ||
QualType ElementType = CT->getElementType(); | ||
if (IsDivOpCode && ElementType->isFloatingType() && | ||
CGF.getLangOpts().getComplexRange() == | ||
LangOptions::ComplexRangeKind::CX_Promoted) | ||
return HigherPrecisionTypeForComplexArithmetic(ElementType, | ||
IsDivOpCode); | ||
if (ElementType.UseExcessPrecision(CGF.getContext())) | ||
return CGF.getContext().getComplexType(CGF.getContext().FloatTy); | ||
} | ||
|
@@ -296,11 +333,12 @@ class ComplexExprEmitter | |
|
||
#define HANDLEBINOP(OP) \ | ||
ComplexPairTy VisitBin##OP(const BinaryOperator *E) { \ | ||
QualType promotionTy = getPromotionType(E->getType()); \ | ||
QualType promotionTy = getPromotionType( \ | ||
E->getType(), \ | ||
(E->getOpcode() == BinaryOperatorKind::BO_Div) ? true : false); \ | ||
ComplexPairTy result = EmitBin##OP(EmitBinOps(E, promotionTy)); \ | ||
if (!promotionTy.isNull()) \ | ||
result = \ | ||
CGF.EmitUnPromotedValue(result, E->getType()); \ | ||
result = CGF.EmitUnPromotedValue(result, E->getType()); \ | ||
return result; \ | ||
} | ||
|
||
|
@@ -790,8 +828,10 @@ ComplexPairTy ComplexExprEmitter::EmitBinMul(const BinOpInfo &Op) { | |
ResR = Builder.CreateFSub(AC, BD, "mul_r"); | ||
ResI = Builder.CreateFAdd(AD, BC, "mul_i"); | ||
|
||
if (Op.FPFeatures.getComplexRange() == LangOptions::CX_Limited || | ||
Op.FPFeatures.getComplexRange() == LangOptions::CX_Fortran) | ||
if (Op.FPFeatures.getComplexRange() == LangOptions::CX_Basic || | ||
Op.FPFeatures.getComplexRange() == LangOptions::CX_Improved || | ||
Op.FPFeatures.getComplexRange() == LangOptions::CX_Promoted || | ||
CGF.getLangOpts().NoHonorInfs || CGF.getLangOpts().NoHonorNaNs) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure NoHonorInfs or NoHonorNaNs should be checked here. Given that we have explicit control for complex arithmetic behavior, maybe that should take precedence. That seems to be the way gcc handles it: https://godbolt.org/z/1oGo7jznz There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This code is in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh, sorry, for some reason I thought this was invoking the special handling for division. I think the for honor NaNs and infinities still isn't necessary because we'll emit the comparison with the fast-math flags set and the backend will optimize it away, which is what happens today: https://godbolt.org/z/e8EnKodj6 |
||
return ComplexPairTy(ResR, ResI); | ||
|
||
// Emit the test for the real part becoming NaN and create a branch to | ||
|
@@ -982,13 +1022,18 @@ ComplexPairTy ComplexExprEmitter::EmitBinDiv(const BinOpInfo &Op) { | |
llvm::Value *OrigLHSi = LHSi; | ||
if (!LHSi) | ||
LHSi = llvm::Constant::getNullValue(RHSi->getType()); | ||
if (Op.FPFeatures.getComplexRange() == LangOptions::CX_Fortran) | ||
QualType ComplexElementTy = Op.Ty->castAs<ComplexType>()->getElementType(); | ||
const BuiltinType *BT = ComplexElementTy->getAs<BuiltinType>(); | ||
if (Op.FPFeatures.getComplexRange() == LangOptions::CX_Improved || | ||
(Op.FPFeatures.getComplexRange() == LangOptions::CX_Promoted && | ||
BT->getKind() == BuiltinType::Kind::LongDouble)) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This isn't going to do the right thing for |
||
return EmitRangeReductionDiv(LHSr, LHSi, RHSr, RHSi); | ||
else if (Op.FPFeatures.getComplexRange() == LangOptions::CX_Limited) | ||
else if (Op.FPFeatures.getComplexRange() == LangOptions::CX_Basic || | ||
Op.FPFeatures.getComplexRange() == LangOptions::CX_Promoted) | ||
return EmitAlgebraicDiv(LHSr, LHSi, RHSr, RHSi); | ||
else if (!CGF.getLangOpts().FastMath || | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we should remove the fast-math check here. The driver handling of fast-math sets the complex arithmetic option. This check has always been problematic because disabling just one component of fast-math (such as enabling signed zeros) causes this to be false. |
||
// '-ffast-math' is used in the command line but followed by an | ||
// '-fno-cx-limited-range'. | ||
// '-fno-cx-limited-range' or '-fcomplex-arithmetic=full'. | ||
Op.FPFeatures.getComplexRange() == LangOptions::CX_Full) { | ||
LHSi = OrigLHSi; | ||
// If we have a complex operand on the RHS and FastMath is not allowed, we | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This documentation doesn't make it clear what happens if there is no higher-precision datatype available and you use
promoted
format. And I'm somewhat uncomfortable with the idea that usingpromoted
keeps you from being able to choose what happens in that case.(In general,
promoted
is scary to me for anything larger than afloat
becauselong double
is just such a cursed type and I'm not sure it's a good idea to convertdouble
computations tolong double
).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intention here was that if the target doesn't support a higher precision type, we will do what we would have done with "improved". Some targets don't even support a 64-bit floating-point type, so the way we apply this needs to be generalized. Should we issue a warning if the user specifies "promoted" but we can't promote?
Zahira and I talked about this offline, and my suggestion was that if LongDoubleSize is greater than DoubleSize, we can promote double to long double, but if it isn't we will use the Smith algorithm (i.e. "improved"). Windows on x86-64 is the really ugly case here, because the target hardware supports an 80-bit floating-point type, but by default the operating system configures the x87 layer to perform calculations as if it were a 64-bit type.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My understanding of the x87 precision control field is that it only affects the number of used bits in the significand, but still retains the full exponent range, so even with PC set to 53-bit precision, you would still get sufficient range to avoid overflow in a complex division, albeit the result might be rounded slightly differently.