<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 12 (filtered medium)">
<style>
<!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri","sans-serif";
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;}
@page Section1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.Section1
{page:Section1;}
-->
</style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="blue" vlink="purple">
<div class="Section1">
<p class="MsoNormal"><span style="font-family:"Courier New"">Hi,<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">We at Sony have a particularly strong interest in not breaking object file compatibility from release to release. So when a bug exists in release X, which gets fixed in release Y, where that bugfix
is an ABI-breaking change, we generally have to weigh the pluses of fixing the bug against the minuses of breaking our object compatibility goal. The impact of object file incompatibility is quite bad for us, and so we likely are more concerned than most
toolchain providers about this issue. But that said, I would imagine there are others out there that have some concerns along these lines. I'm curious to hear about preferred methods of dealing with this.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">A straightforward solution is for us simply to guard an ABI-breaking bugfix with our PS4-triple. Conceptually:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (TargetIsPS4) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> // old way, with known bug, to retain object compatibility<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> } else {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> // new way, that fixes bug, but breaks object compatibility<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> }<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">But if others are interested in retaining the compatibility, then instead, something like the following may be preferred:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (TargetUsesBuggyApproachX) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> // old way, with known bug, to retain object compatibility<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> } else {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> // new way, that fixes bug, but breaks object compatibility<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> }<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">where the concept of "Target Uses Buggy Approach X" is implemented by, for example, adding another single-bit bitfield to the TargetInfo class, and initializing it appropriately for different targets.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">To be more specific, a current example of an ABI-breaking issue for us is PR22279:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> https://llvm.org/bugs/show_bug.cgi?id=22279<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">As described there, a bugfix in the handling of alignment attributes (and alignas()) for enums causes a change in object layout. For our customers, and hence for us, the fix in proper alignment of
enum types in these cases isn't as important as retaining object compatibility. So we need to suppress that fix. It's easy enough for us to suppress the change by checking whether the target is PS4, but adding a bit to TargetInfo like:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> unsigned IgnoreEnumTypeAlignment : 1;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">seems better. I'm appending a patch on clang below, that shows this approach concretely.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">Or possibly there is some other preferred approach? I'm curious to hear people's opinions.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">Thanks,<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">-Warren<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">--<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">Warren Ristow<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">SN Systems - Sony Computer Entertainment Group<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">diff --git include/clang/Basic/TargetInfo.h include/clang/Basic/TargetInfo.h<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">index fed69a8..7aca509 100644<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">--- include/clang/Basic/TargetInfo.h<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+++ include/clang/Basic/TargetInfo.h<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -84,6 +84,7 @@ protected:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> mutable VersionTuple PlatformMinVersion;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> unsigned HasAlignMac68kSupport : 1;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ unsigned IgnoreEnumTypeAlignment : 1;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> unsigned RealTypeUsesObjCFPRet : 3;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> unsigned ComplexLongDoubleUsesFP2Ret : 1;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -463,6 +464,11 @@ public:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> return HasAlignMac68kSupport;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> }<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ /// \brief Ignore alignment specifier on definitions of enum types<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ bool ignoreEnumTypeAlignment() const {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ return IgnoreEnumTypeAlignment;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ }<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> /// \brief Return the user string for the specified integer type enum.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> ///<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> /// For example, SignedShort -> "short".<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">diff --git lib/AST/ASTContext.cpp lib/AST/ASTContext.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">index fb96301..6a76ef3 100644<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">--- lib/AST/ASTContext.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+++ lib/AST/ASTContext.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -1705,6 +1705,8 @@ TypeInfo ASTContext::getTypeInfoImpl(const Type *T) const {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (const EnumType *ET = dyn_cast<EnumType>(TT)) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> const EnumDecl *ED = ET->getDecl();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ if (getTargetInfo().ignoreEnumTypeAlignment())<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ return getTypeInfo(ED->getIntegerType());<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> TypeInfo Info =<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> getTypeInfo(ED->getIntegerType()->getUnqualifiedDesugaredType());<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (unsigned AttrAlign = ED->getMaxAlignment()) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -1846,7 +1848,8 @@ unsigned ASTContext::getPreferredTypeAlign(const Type *T) const {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (const ComplexType *CT = T->getAs<ComplexType>())<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> T = CT->getElementType().getTypePtr();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (const EnumType *ET = T->getAs<EnumType>())<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">- T = ET->getDecl()->getIntegerType().getTypePtr();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ if (!getTargetInfo().ignoreEnumTypeAlignment())<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ T = ET->getDecl()->getIntegerType().getTypePtr();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (T->isSpecificBuiltinType(BuiltinType::Double) ||<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> T->isSpecificBuiltinType(BuiltinType::LongLong) ||<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> T->isSpecificBuiltinType(BuiltinType::ULongLong))<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">diff --git lib/Basic/TargetInfo.cpp lib/Basic/TargetInfo.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">index 856ad50..99ed923 100644<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">--- lib/Basic/TargetInfo.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+++ lib/Basic/TargetInfo.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -76,6 +76,7 @@ TargetInfo::TargetInfo(const llvm::Triple &T) : TargetOpts(), Triple(T) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> RegParmMax = 0;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> SSERegParmMax = 0;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> HasAlignMac68kSupport = false;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ IgnoreEnumTypeAlignment = false;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> // Default to no types using fpret.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> RealTypeUsesObjCFPRet = 0;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">diff --git lib/Basic/Targets.cpp lib/Basic/Targets.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">index c5bf90f..b93343b 100644<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">--- lib/Basic/Targets.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+++ lib/Basic/Targets.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -580,6 +580,14 @@ public:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> PS4OSTargetInfo(const llvm::Triple &Triple) : OSTargetInfo<Target>(Triple) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> this->WCharType = this->UnsignedShort;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ // On PS4, for object compatibility with compilers prior to the fix of<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ // PR22279, we ignore alignment specifiers on definitions of enum types.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ // For example, in the following fragment, the alignment of 'y' will<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ // be 4, rather than 16:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ // enum Y { val1, val2, val3 } __attribute__((aligned(16)));<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ // Y y;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ IgnoreEnumTypeAlignment = true;<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> this->UserLabelPrefix = "";<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> switch (Triple.getArch()) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">diff --git lib/Sema/SemaDeclAttr.cpp lib/Sema/SemaDeclAttr.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">index b8d0830..3843fcb 100644<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">--- lib/Sema/SemaDeclAttr.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+++ lib/Sema/SemaDeclAttr.cpp<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">@@ -3024,8 +3024,9 @@ void Sema::CheckAlignasUnderalignment(Decl *D) {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> UnderlyingTy = DiagTy = VD->getType();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> } else {<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> UnderlyingTy = DiagTy = Context.getTagDeclType(cast<TagDecl>(D));<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">- if (EnumDecl *ED = dyn_cast<EnumDecl>(D))<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">- UnderlyingTy = ED->getIntegerType();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ if (!Context.getTargetInfo().ignoreEnumTypeAlignment())<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ if (EnumDecl *ED = dyn_cast<EnumDecl>(D))<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New"">+ UnderlyingTy = ED->getIntegerType();<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> }<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> if (DiagTy->isDependentType() || DiagTy->isIncompleteType())<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:"Courier New""> return;<o:p></o:p></span></p>
</div>
</body>
</html>