<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=utf-8">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
        {font-family:Wingdings;
        panose-1:5 0 0 0 0 0 0 0 0 0;}
@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;}
span.EmailStyle19
        {mso-style-type:personal-reply;
        font-family:"Calibri",sans-serif;
        color:windowtext;}
.MsoChpDefault
        {mso-style-type:export-only;
        font-size:10.0pt;}
@page WordSection1
        {size:8.5in 11.0in;
        margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
        {page:WordSection1;}
/* List Definitions */
@list l0
        {mso-list-id:344136967;
        mso-list-template-ids:-1624994252;}
@list l0:level1
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:.5in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Symbol;}
@list l0:level2
        {mso-level-number-format:bullet;
        mso-level-text:o;
        mso-level-tab-stop:1.0in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:"Courier New";
        mso-bidi-font-family:"Times New Roman";}
@list l0:level3
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:1.5in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l0:level4
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:2.0in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l0:level5
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:2.5in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l0:level6
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:3.0in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l0:level7
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:3.5in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l0:level8
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:4.0in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l0:level9
        {mso-level-number-format:bullet;
        mso-level-text:;
        mso-level-tab-stop:4.5in;
        mso-level-number-position:left;
        text-indent:-.25in;
        mso-ansi-font-size:10.0pt;
        font-family:Wingdings;}
@list l1
        {mso-list-id:741173917;
        mso-list-type:hybrid;
        mso-list-template-ids:-2116648864 67698703 67698713 67698715 67698703 67698713 67698715 67698703 67698713 67698715;}
@list l1:level1
        {mso-level-tab-stop:none;
        mso-level-number-position:left;
        text-indent:-.25in;}
@list l1:level2
        {mso-level-number-format:alpha-lower;
        mso-level-tab-stop:none;
        mso-level-number-position:left;
        text-indent:-.25in;}
@list l1:level3
        {mso-level-number-format:roman-lower;
        mso-level-tab-stop:none;
        mso-level-number-position:right;
        text-indent:-9.0pt;}
@list l1:level4
        {mso-level-tab-stop:none;
        mso-level-number-position:left;
        text-indent:-.25in;}
@list l1:level5
        {mso-level-number-format:alpha-lower;
        mso-level-tab-stop:none;
        mso-level-number-position:left;
        text-indent:-.25in;}
@list l1:level6
        {mso-level-number-format:roman-lower;
        mso-level-tab-stop:none;
        mso-level-number-position:right;
        text-indent:-9.0pt;}
@list l1:level7
        {mso-level-tab-stop:none;
        mso-level-number-position:left;
        text-indent:-.25in;}
@list l1:level8
        {mso-level-number-format:alpha-lower;
        mso-level-tab-stop:none;
        mso-level-number-position:left;
        text-indent:-.25in;}
@list l1:level9
        {mso-level-number-format:roman-lower;
        mso-level-tab-stop:none;
        mso-level-number-position:right;
        text-indent:-9.0pt;}
ol
        {margin-bottom:0in;}
ul
        {margin-bottom:0in;}
--></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="WordSection1">
<p class="MsoNormal">Changing the length of a sequence of assembly instructions will break someone’s code at some point.  The length of a sequence of instructions is known, in general, and people will write code to take advantage of that. For example, I’ve
 seen assembly code using something like Duff’s device, except that instead of using a jump table, it just computed the destination as “base+n*caselength”.  Given that, I don’t think it’s reasonable to hide this mechanism from user control.
<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">We definitely should not have any undocumented or unpredictable behavior in the assembler.  The actual instruction bytes matter.  That said, I’m not sure there’s a strong line between “automagic” and “explicit”, as long as the rules are
 documented.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">-Eli<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<div style="border:none;border-left:solid blue 1.5pt;padding:0in 0in 0in 4.0pt">
<div>
<div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b>From:</b> llvm-dev <llvm-dev-bounces@lists.llvm.org> <b>On Behalf Of
</b>Philip Reames via llvm-dev<br>
<b>Sent:</b> Tuesday, March 24, 2020 3:55 PM<br>
<b>To:</b> llvm-dev <llvm-dev@lists.llvm.org><br>
<b>Cc:</b> Luo, Yuanke <yuanke.luo@intel.com>; Zhang, Annita <annita.zhang@intel.com>; Craig Topper <craig.topper@intel.com><br>
<b>Subject:</b> [EXT] [llvm-dev] Status of Intel JCC Mitigations and Next Steps<o:p></o:p></p>
</div>
</div>
<p class="MsoNormal"><o:p> </o:p></p>
<p>TLDR - We have a choice to make about assembler support, and a disagreement about how to move forward.  Community input needed.<o:p></o:p></p>
<p><o:p> </o:p></p>
<p>Background<o:p></o:p></p>
<p>Intel has a hardware bug in Skylake and later whose mitigation requires padding of branches to avoid performance degradation.  Background here:
<a href="https://www.intel.com/content/dam/support/us/en/documents/processors/mitigations-jump-conditional-code-erratum.pdf">
https://www.intel.com/content/dam/support/us/en/documents/processors/mitigations-jump-conditional-code-erratum.pdf</a><o:p></o:p></p>
<p>We now have in tree support for alignment of such branches via nop padding, and limited support for padding existing instructions with either prefixes or larger immediate values.  This has survived several days of dedicated testing and appears to be reasonably
 robust.  The padding support applies both to branch alignment for the mitigation, but also normal align directives. 
<o:p></o:p></p>
<p>The original patches proposed a somewhat different approach than we've ended up taking - primarily because of memory overhead concerns.  However, there was also a deeper disagreement on the original review threads (D70157 and others) which was never settled,
 and we seem to be at a point where this needs attention.  In short, the question is how assembler support should be handled.<o:p></o:p></p>
<p><o:p> </o:p></p>
<p>The Choice<o:p></o:p></p>
<p>The problematic use case comes when assembling user provided .s files.  (Instead of the more restricted output of the compiler.)  Our basic choice is do we want to force a new directive syntax (and thus a source code change to use the new feature), or attempt
 to automatically infer where it's safe to insert padding?<o:p></o:p></p>
<p>The options as I see them:<o:p></o:p></p>
<ul type="disc">
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;mso-list:l0 level1 lfo1">
Assembler directives w/explicit opt in - In this model, assembler input is assumed to only enable padding in regions where it is safe to do so.<o:p></o:p></li><li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;mso-list:l0 level1 lfo1">
Automagic assembler - In this model, the assembler is responsible for inferring where it is legal to pad without breaking user expectations. 
<o:p></o:p></li></ul>
<p>(I'll stop and disclaim that I'm strongly in favor of the former.  I've tried to describe the pros/cons of each, but my perspective is definitely biased.)<o:p></o:p></p>
<p>The difference between the two is a huge amount of complexity, and a very fundamental correctness risk.  The basic problem is that assemblers have to handle unconstrained inputs, and IMO, the semantics of assembler as used in practice is so under specified
 that it's really hard to infer semantics in any useful way.  As a couple of examples, is the fault behavior of an instruction well defined?  Is the label near an instruction used by the signal handler?  Is that data byte just before an instruction actually
 decoded as part of the instruction?<o:p></o:p></p>
<p>The benefit of the later option is that existing assembly files can be used without modification.  This is a huge advantage in terms of ease of mitigation for existing code bases.  It's also the approach the original patch sets for GCC took. 
<o:p></o:p></p>
<p>In the original review thread(s), I had taken the position that we should reject the automagic assembler based on the correctness concerns mentioned.  I had thought the consensus in the review was clearly in that direction as well, but this has recently
 come up again.  Given that, I wanted to open it to a wider audience.<o:p></o:p></p>
<p><o:p> </o:p></p>
<p>Why am I pushing for a decision now?<o:p></o:p></p>
<p>There are two major reasons.  First, there have recently been a couple of patches posted and landed (D76176, and D76052) building towards the automagic assembler variant.  And second, I've started getting review comments (<a href="https://reviews.llvm.org/D76398#1930383">https://reviews.llvm.org/D76398#1930383</a>)
 which block forward progress on generalized padding support assuming the automagic interpretation.  Implementing the automatic assembler variant for prefix and immediate padding adds substantial complexity and I would very much like not to bother with if I
 don't have to.<o:p></o:p></p>
<p><o:p> </o:p></p>
<p>Current implementation details<o:p></o:p></p>
<p>We have support in the integrated assembler only for autopadding suppression.  This allows a LLVM based compiler to effectively apply padding selectively.  In particular, we've instrumented lowering from MI to MC (X86MCInstLowering.cpp) to selectively disable
 padding around constructs which are thought to be problematic.  We do not have an agreed upon syntax for this in assembler; the code that got checked in is modeled closely around the last seriously discussed variant (see below).  This support is able to use
 all of the padding variants: nop, prefix, and immediate.<o:p></o:p></p>
<p>We also have limited support in the assembler for not inserting nops between fragments where doing so would break known idioms.  The list of such idioms is, IMO, ad hoc.  This assembler support does not include prefix or immediate padding. 
<o:p></o:p></p>
<p><o:p> </o:p></p>
<p>Philip<o:p></o:p></p>
<p>p.s. For those interested, here's roughly what the last round of assembler syntax I remember being discussed looked like.<o:p></o:p></p>
<p>.autopadding<br>
.noautopadding<o:p></o:p></p>
<p>These two directives would respectively enable and disable automatic padding of instructions within the region defined.  It's presumed to be legal to insert nops between instructions, modify encodings, or otherwise adjust offsets of instruction boundaries
 within the region to achieve target specific desired alignments.  Similarly, it's presumed not to be legal to change relative offsets outside an explicitly enabled region.  (Except for existing cases - e.g. relaxation of branches, etc...)<o:p></o:p></p>
<p>The assembler would provide a command line flag which conceptually wrapped the whole file in a pair of enable/disable directives. 
<o:p></o:p></p>
<p>We'd previously discussed a variant with push/pop semantics and more fine grained control over alignment requests, but I believe we decided that was overkill in the end.  (I walked away with that impression based on the integrated assembler work at least.)<o:p></o:p></p>
<p><o:p> </o:p></p>
</div>
</div>
</body>
</html>