[ARM] Uses "Sun Style" syntax for section switching

[jcai19]

Summary

Support "Sun Style" syntax for section switching ("#alloc,#write" etc).
https://bugs.llvm.org/show_bug.cgi?id=43759

[peter.smith]

I can see that this would allow "Sun Style" syntax for section switching that seems to be permitted for the Arm target. The question is why, and why just Arm? Looking at the GNU as code it looks like:

• This syntax was supported for Solaris, it only has tests for Solaris
• The syntax isn't gated by target, but it doesn't work on any target that uses # as the comment character (x86), it fails with a cryptic error message, this suggests it works on Arm and AArch64 by accident rather than by intention.
• The comment in MCAsmInfo.h states "instead of the normal ELF syntax", looking at the implementation it seems like both can be used at once as there isn't a parsing difference, however this might not be by design.

/// This is true if this target uses "Sun Style" syntax for section switching
/// ("#alloc,#write" etc) instead of the normal ELF syntax (,"a,w") in
/// .section directives.  Defaults to false.
bool SunStyleELFSectionSwitchSyntax = false;

So at the moment, I'm not convinced that doing this just for Arm and leaving the existing comment in MCAsmInfo.h in place is the right thing to do. If this is being done to be compatible with GNU, and for a good reason, then it should work on all targets that it works in GNU as and not just Arm.

[jcai19]

This comment was removed by jcai19.

[jcai19]

Update comments.

[jcai19]

In D69296#1717731, @peter.smith wrote:

I can see that this would allow "Sun Style" syntax for section switching that seems to be permitted for the Arm target. The question is why, and why just Arm? Looking at the GNU as code it looks like:

• This syntax was supported for Solaris, it only has tests for Solaris
• The syntax isn't gated by target, but it doesn't work on any target that uses # as the comment character (x86), it fails with a cryptic error message, this suggests it works on Arm and AArch64 by accident rather than by intention.
• The comment in MCAsmInfo.h states "instead of the normal ELF syntax", looking at the implementation it seems like both can be used at once as there isn't a parsing difference, however this might not be by design.

I agree, and it seems GNU assembler supports both on arm so I have updated the comments on MCAsmInfo.h.

/// This is true if this target uses "Sun Style" syntax for section switching
/// ("#alloc,#write" etc) instead of the normal ELF syntax (,"a,w") in
/// .section directives.  Defaults to false.
bool SunStyleELFSectionSwitchSyntax = false;

So at the moment, I'm not convinced that doing this just for Arm and leaving the existing comment in MCAsmInfo.h in place is the right thing to do. If this is being done to be compatible with GNU, and for a good reason, then it should work on all targets that it works in GNU as and not just Arm.

This is part of the effort to build Linux kernel with integrated assembler for 32-bit Arm (https://github.com/ClangBuiltLinux/linux/issues/744). Some assembly files are written with this syntax in the kernel, e.g. https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/arch/arm/mm/proc-v7.S?h=v5.4-rc4. I only ran into this issue on Arm so far and by grepping for #alloc I only found such syntax used for arm, sparc (SunStyleELFSectionSwitchSyntax already set to true), m68k and nds32 use such syntax. I am not sure if anyone is actually building m68k or nds32 with integrated assembler so that is why I only tried to turn it on for Arm.

[peter.smith]

Thanks for the context. I managed to find: https://lists.gt.net/linux/kernel/352032?do=post_view_threaded which asked about the difference in section syntax used in the kernel. The view at the time 2003 was that the forms where equivalent but there wasn't a firm preference. I've found a few other instances in other projects, although I've not got a large corpus of code to search through, the one's I've found are: Xen and CMSIS for low level driver code.

I think that this qualifies the use of the Solaris form as rare, but not insubstantial. On that basis I'm inclined to approve, does anyone else have any strong counter arguments?

llvm/include/llvm/MC/MCAsmInfo.h

224

nit: I'd use "alongside" rather than "along" here.

llvm/lib/Target/ARM/MCTargetDesc/ARMMCAsmInfo.cpp

78

nit: one blank line would match the style of the rest of the file.

80

Although SunStyleELFSectionSwitchSyntax comes under the section Data Emission Directives, I think that is a mistake in MCAsmInfo, as a Data Emission Directive is something like .word.

I suggest a comment like:
// The GNU assembler supports Sun style section switching for Arm targets, and it is used in projects like the Linux kernel.

[jcai19]

Update comments.

[peter.smith]

Thanks for the update. Looks good to me. Please can you apply the formatting change to the comment (80 columns) prior to commit.

llvm/lib/Target/ARM/MCTargetDesc/ARMMCAsmInfo.cpp

79

Can you break this comment into two lines so that it doesn't go over 80 columns? (https://llvm.org/docs/CodingStandards.html#source-code-width)

[MaskRay]

llvm/lib/Target/ARM/MCTargetDesc/ARMMCAsmInfo.cpp

79

@jcai19 You can run git diff -U0 --no-color 'HEAD^' | ~/llvm-project/clang/tools/clang-format/clang-format-diff.py -i -p1 to format the comment.

[nickdesaulniers]

llvm/lib/Target/ARM/MCTargetDesc/ARMMCAsmInfo.cpp

79

Or in vim:

shift+v to highlight visual lines of comments, then gqgq to rewrap lines. May require set cc=80.

[jcai19]

Formatted.

[jcai19]

llvm/lib/Target/ARM/MCTargetDesc/ARMMCAsmInfo.cpp

79

Thanks all for the comments.

[jcai19]

Update commit message.

[thakis]

This breaks tests everywhere, see eg http://45.33.8.238/linux/2607/step_6.txt

Please take a look and revert if it takes a while to fix.

And please always watch http://lab.llvm.org:8011/console for a bit after landing.

[jcai19]

In D69296#1721844, @thakis wrote:

This breaks tests everywhere, see eg http://45.33.8.238/linux/2607/step_6.txt

Please take a look and revert if it takes a while to fix.

And please always watch http://lab.llvm.org:8011/console for a bit after landing.

Sorry about the breakage. I have reverted the commit. Will reland once I fix it.

[thakis]

Sorry about the breakage. I have reverted the commit. Will reland once I fix it.

Thanks much for the revert!

Going forward, when reverting things, please say in the revert commit message _why_ you're reverting (e.g. "breaks bots, see original review", or "breaks CodeGen/cfstring3.c on most bots", or similar) :)

[jcai19]

In D69296#1721893, @thakis wrote:

Sorry about the breakage. I have reverted the commit. Will reland once I fix it.

Thanks much for the revert!

Going forward, when reverting things, please say in the revert commit message _why_ you're reverting (e.g. "breaks bots, see original review", or "breaks CodeGen/cfstring3.c on most bots", or similar) :)

Sounds good.

[jcai19]

Right now once we toggle SunStyleELFSectionSwitchSyntax on an architecture, all the section switching assembly is emitted on sun-style syntax, which is the reason why some test cases fail as they assume the regular syntax. To deal with this issue, I introduced a new variable that would allow the architecture to parse sun-style assembly while not emitting it.

[jcai19]

@nickdesaulniers Maybe we should fix kernel instead? The fix will be cleaner that way.

[jcai19]

Add a test case.

[jcai19]

Accidentally uploaded a patch for different issue. Fixed it.

[MaskRay]

The original patch looks fine because the SunStyleELFSectionSwitchSyntax functionality is already there. Now we start to add IsCompatibleWithSunStyleELFSectionSwitchSyntax... Have we communicated the Solaris assembler's .section syntax problem to the Linux community?

[nickdesaulniers]

In D69296#1725741, @MaskRay wrote:

The original patch looks fine because the SunStyleELFSectionSwitchSyntax functionality is already there. Now we start to add IsCompatibleWithSunStyleELFSectionSwitchSyntax... Have we communicated the Solaris assembler's .section syntax problem to the Linux community?

https://github.com/ClangBuiltLinux/linux/issues/744#issuecomment-547633348

[jcai19]

Linux has been patched by to use normal section switching syntax https://lkml.org/lkml/2019/10/30/807. Abandon this LLVM patch as we should be fine without it.

[nickdesaulniers]

In D69296#1727454, @jcai19 wrote:

Linux has been patched by to use normal section switching syntax https://lkml.org/lkml/2019/10/30/807. Abandon this LLVM patch as we should be fine without it.

s/has been patched/has had a patch posted for review but not yet accepted or merged/

[MaskRay]

In D69296#1727454, @jcai19 wrote:

Linux has been patched by to use normal section switching syntax https://lkml.org/lkml/2019/10/30/807. Abandon this LLVM patch as we should be fine without it.

From my viewpoint of reducing maintenance burden, thanks! I am not clear about the Linux kernel development model but I think we cannot say "Linux has been patched" yet because the patch sent by nickdesaulniers has not been merged into the mainline kernel :) (Though I think it is promising.)

llvm/include/llvm/MC/MCAsmInfo.h

protected:
   /// If non-null, directives that are used to emit a word/dword which should
   /// be relocated as a 32/64-bit DTP/TP-relative offset, e.g. .dtprelword/
   /// .dtpreldword/.tprelword/.tpreldword on Mips.
   const char *DTPRel32Directive = nullptr;
   const char *DTPRel64Directive = nullptr;
   const char *TPRel32Directive = nullptr;
   const char *TPRel64Directive = nullptr;
 
+  /// This is true if this target is compatible with "Sun Style" syntax for
+  /// section switching
+  /// ("#alloc,#write" etc) alongside the normal ELF syntax (,"a,w") in
+  /// .section directives.  Defaults to false.
+  bool IsCompatibleWithSunStyleELFSectionSwitchSyntax = false;
+
   /// This is true if this target uses "Sun Style" syntax for section switching
   /// ("#alloc,#write" etc) instead of the normal ELF syntax (,"a,w") in
   /// .section directives.  Defaults to false.
   bool SunStyleELFSectionSwitchSyntax = false;
 
   /// This is true if this target uses ELF '.section' directive before the
   /// '.bss' one. It's used for PPC/Linux which doesn't support the '.bss'
   /// directive only.  Defaults to false.
   bool UsesELFSectionDirectiveForBSS = false;
 
public:
   /// returns false => .section .text,#alloc,#execinstr
   /// returns true  => .text
   virtual bool shouldOmitSectionDirective(StringRef SectionName) const;
 
   bool usesSunStyleELFSectionSwitchSyntax() const {
     return SunStyleELFSectionSwitchSyntax;
   }
 
+  bool supportsSunStyleELFSectionSwitchSyntax() const {
+    return SunStyleELFSectionSwitchSyntax ||
+           IsCompatibleWithSunStyleELFSectionSwitchSyntax;
+  }
+
   bool usesELFSectionDirectiveForBSS() const {
     return UsesELFSectionDirectiveForBSS;
   }
 
   bool needsDwarfSectionOffsetDirective() const {
     return NeedsDwarfSectionOffsetDirective;
   }
 

llvm/lib/MC/MCParser/ELFAsmParser.cpp

if (IsPush && getLexer().isNot(AsmToken::String)) {
       if (getLexer().isNot(AsmToken::Comma))
         goto EndStmt;
       Lex();
     }
 
     unsigned extraFlags;
 
     if (getLexer().isNot(AsmToken::String)) {
-      if (!getContext().getAsmInfo()->usesSunStyleELFSectionSwitchSyntax()
-          || getLexer().isNot(AsmToken::Hash))
+      if (!getContext()
+               .getAsmInfo()
+               ->supportsSunStyleELFSectionSwitchSyntax() ||
+          getLexer().isNot(AsmToken::Hash))
         return TokError("expected string in directive");
       extraFlags = parseSunStyleSectionFlags();
     } else {
       StringRef FlagsStr = getTok().getStringContents();
       Lex();
       extraFlags = parseSectionFlags(FlagsStr, &UseLastGroup);
     }
 

llvm/lib/Target/ARM/MCTargetDesc/ARMMCAsmInfo.cpp

default:
     ExceptionsType = ExceptionHandling::ARM;
     break;
   }
 
   // foo(plt) instead of foo@plt
   UseParensForSymbolVariant = true;
 
   UseIntegratedAssembler = true;
+
+  // The GNU assembler supports Sun style section switching for Arm targets, and
+  // it is used in projects like the Linux kernel.
+  IsCompatibleWithSunStyleELFSectionSwitchSyntax = true;
 }
 
 void ARMELFMCAsmInfo::setUseIntegratedAssembler(bool Value) {
   UseIntegratedAssembler = Value;
   if (!UseIntegratedAssembler) {
     // gas doesn't handle VFP register names in cfi directives,
     // so don't use register names with external assembler.
     // See https://sourceware.org/bugzilla/show_bug.cgi?id=16694

llvm/test/MC/AsmParser/gas-compl-sun-elf.s

+@ RUN: llvm-mc -filetype=obj -triple arm-linux-gnu %s -o - | llvm-readelf --sections | FileCheck %s
+
+@ CHECK: .f1              PROGBITS        00000000 000034 000000 00   A  0   0  1
+.section ".f1", #alloc
+
+@ CHECK: .f2              PROGBITS        00000000 000034 000000 00   W  0   0  1
+.section ".f2", #write
+
+@ CHECK: .f3              PROGBITS        00000000 000034 000000 00   A  0   0  1
+.section ".f3", "a"
+
+@ CHECK: .f4              PROGBITS        00000000 000034 000000 00   W  0   0  1
+.section ".f4", "w"