[ELF] - Linkerscript: implemented output section [address] attribute.

[grimar]

Summary

Output section description in SECTIONS looks like that:

section [address] [(type)] :
...
{
...
}

Patch implements support of address atribute.

[davide]

Do you have examples of linker scripts using this feature? I wasn't able to find any.

[emaste]

@davide we have them in FreeBSD's kernel linker script (for debug data) but they're all addr 0, e.g.:

/* DWARF debug sections.
   Symbols in the DWARF debugging sections are relative to the beginning
   of the section so we begin them at 0.  */
/* DWARF 1 */
.debug          0 : { *(.debug) }
.line           0 : { *(.line) }

[davide]

In D22689#493261, @emaste wrote:

@davide we have them in FreeBSD's kernel linker script (for debug data) but they're all addr 0, e.g.:

/* DWARF debug sections.
   Symbols in the DWARF debugging sections are relative to the beginning
   of the section so we begin them at 0.  */
/* DWARF 1 */
.debug          0 : { *(.debug) }
.line           0 : { *(.line) }

OK, fine.

[grimar]

In D22689#493163, @davide wrote:

Do you have examples of linker scripts using this feature? I wasn't able to find any.

.lrodata   ALIGN(CONSTANT (MAXPAGESIZE)) + (. & (CONSTANT (MAXPAGESIZE) - 1)) :
{
...
}

https://svnweb.freebsd.org/base/head/sys/conf/ldscript.amd64?revision=284870&view=markup#l176

[grimar]

I mean that "ALIGN(CONSTANT (MAXPAGESIZE)) + (. & (CONSTANT (MAXPAGESIZE) - 1))" is [address] here.

[ruiu]

LGTM

ELF/LinkerScript.cpp

830

Please add a comment.

// Read an address expression.
// https://sourceware.org/binutils/docs/ld/Output-Section-Address.html#Output-Section-Address

ELF/LinkerScript.h

 // and ONLY_IF_RW respectively.
 enum ConstraintKind { NoConstraint, ReadOnly, ReadWrite };
 
 struct OutputSectionCommand : BaseCommand {
   OutputSectionCommand(StringRef Name)
       : BaseCommand(OutputSectionKind), Name(Name) {}
   static bool classof(const BaseCommand *C);
   StringRef Name;
+  std::vector<StringRef> AddrExpr;
   std::vector<std::unique_ptr<BaseCommand>> Commands;
   std::vector<StringRef> Phdrs;
   std::vector<uint8_t> Filler;
   ConstraintKind Constraint = NoConstraint;
 };
 
 struct InputSectionDescription : BaseCommand {
   InputSectionDescription() : BaseCommand(InputSectionKind) {}

ELF/LinkerScript.cpp

for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
     // Find all the sections with required name. There can be more than
     // one section with such name, if the alignment, flags or type
     // attribute differs.
     auto *Cmd = cast<OutputSectionCommand>(Base.get());
     for (OutputSectionBase<ELFT> *Sec : Sections) {
       if (Sec->getName() != Cmd->Name)
         continue;
 
+      if (!Cmd->AddrExpr.empty())
+        Dot = evalExpr(Cmd->AddrExpr, Dot);
+
       if ((Sec->getFlags() & SHF_TLS) && Sec->getType() == SHT_NOBITS) {
         uintX_t TVA = Dot + ThreadBssOffset;
         TVA = alignTo(TVA, Sec->getAlignment());
         Sec->setVA(TVA);
         ThreadBssOffset = TVA - Dot + Sec->getSize();
         continue;
       }
 
if (Expr.empty())
     error("error in location counter expression");
   else
     Opt.Commands.push_back(llvm::make_unique<SymbolAssignment>(".", Expr));
 }
 
 void ScriptParser::readOutputSectionDescription(StringRef OutSec) {
   OutputSectionCommand *Cmd = new OutputSectionCommand(OutSec);
   Opt.Commands.emplace_back(Cmd);
+
+  if (peek() != ":")
+    Cmd->AddrExpr = readSectionsCommandExpr();
+
   expect(":");
 
   // Parse constraints.
   if (skip("ONLY_IF_RO"))
     Cmd->Constraint = ReadOnly;
   if (skip("ONLY_IF_RW"))
     Cmd->Constraint = ReadWrite;
   expect("{");
if (Expr.empty()) {
     return static_cast<SymbolAssignment *>(Opt.Commands.back().get());
   }
   return nullptr;
 }
 
 // This function reads balanced expression until semicolon is seen.
 std::vector<StringRef> ScriptParser::readSectionsCommandExpr() {
   int Braces = 0;
+  int Ternary = 0;
   std::vector<StringRef> Expr;
   while (!Error) {
     StringRef Tok = peek();
 
+    if (Tok == "?")
+      ++Ternary;
+    else if (Tok == ":")
+      if (--Ternary < 0)
+        break;
+
     if (Tok == "(")
       Braces++;
     else if (Tok == ")")
       if (--Braces < 0)
         break;
 
     next();
     if (Tok == ";")

test/ELF/linkerscript-diagnostic.s

 # REQUIRES: x86
 # RUN: llvm-mc -filetype=obj -triple=x86_64-unknown-linux %s -o %t
 
 ## Take some valid script with multiline comments
 ## and check it actually works:
 # RUN: echo "SECTIONS {" > %t.script
 # RUN: echo ".text : { *(.text) }" >> %t.script
 # RUN: echo ".keep : { *(.keep) } /*" >> %t.script
 # RUN: echo "comment line 1" >> %t.script
 # RUN: echo "comment line 2 */" >> %t.script
 # RUN: echo ".temp : { *(.temp) } }" >> %t.script
 # RUN: ld.lld -shared %t -o %t1 --script %t.script
 
-## Change ":" to "+" at line 2, check that error
+## Add 'a' at line 2, check that error
 ## message starts from correct line number:
 # RUN: echo "SECTIONS {" > %t.script
-# RUN: echo ".text + { *(.text) }" >> %t.script
+# RUN: echo ".text : {a *(.text) }" >> %t.script
 # RUN: echo ".keep : { *(.keep) } /*" >> %t.script
 # RUN: echo "comment line 1" >> %t.script
 # RUN: echo "comment line 2 */" >> %t.script
 # RUN: echo ".temp : { *(.temp) } }" >> %t.script
 # RUN: not ld.lld -shared %t -o %t1 --script %t.script 2>&1 | FileCheck -check-prefix=ERR1 %s
 # ERR1: line 2:
 
-## Change ":" to "+" at line 3 now, check correct error line number:
+## Add 'a' at line 3 now, check correct error line number:
 # RUN: echo "SECTIONS {" > %t.script
 # RUN: echo ".text : { *(.text) }" >> %t.script
-# RUN: echo ".keep + { *(.keep) } /*" >> %t.script
+# RUN: echo ".keep : {a *(.keep) } /*" >> %t.script
 # RUN: echo "comment line 1" >> %t.script
 # RUN: echo "comment line 2 */" >> %t.script
 # RUN: echo ".temp : { *(.temp) } }" >> %t.script
 # RUN: not ld.lld -shared %t -o %t1 --script %t.script 2>&1 | FileCheck -check-prefix=ERR2 %s
 # ERR2: line 3:
 
-## Change ":" to "+" at line 6, after multiline comment,
+## Add 'a' at line 6, after multiline comment,
 ## check correct error line number:
 # RUN: echo "SECTIONS {" > %t.script
 # RUN: echo ".text : { *(.text) }" >> %t.script
 # RUN: echo ".keep : { *(.keep) } /*" >> %t.script
 # RUN: echo "comment line 1" >> %t.script
 # RUN: echo "comment line 2 */" >> %t.script
-# RUN: echo ".temp + { *(.temp) } }" >> %t.script
+# RUN: echo ".temp : {a *(.temp) } }" >> %t.script
 # RUN: not ld.lld -shared %t -o %t1 --script %t.script 2>&1 | FileCheck -check-prefix=ERR5 %s
 # ERR5: line 6:
 
 ## Check that text of lines and pointer to 'bad' token are working ok.
 # RUN: echo "UNKNOWN_TAG {" > %t.script
 # RUN: echo ".text : { *(.text) }" >> %t.script
 # RUN: echo ".keep : { *(.keep) }" >> %t.script
 # RUN: echo ".temp : { *(.temp) } }" >> %t.script
 # RUN: not ld.lld -shared %t -o %t1 --script %t.script > %t.log 2>&1
 # RUN: FileCheck -check-prefix=ERR6 %s < %t.log
 # ERR6:      line 1:
 # ERR6-NEXT: UNKNOWN_TAG {
 # RUN: grep '^^' %t.log
 
 ## One more check that text of lines and pointer to 'bad' token are working ok.
 # RUN: echo "SECTIONS {" > %t.script
 # RUN: echo ".text : { *(.text) }" >> %t.script
 # RUN: echo ".keep : { *(.keep) }" >> %t.script
-# RUN: echo "boom .temp : { *(.temp) } }" >> %t.script
+# RUN: echo ".temp : { *'.temp) } }" >> %t.script
 # RUN: not ld.lld -shared %t -o %t1 --script %t.script > %t.log 2>&1
 # RUN: FileCheck -check-prefix=ERR7 %s < %t.log
-# ERR7:      line 4: : expected, but got .temp
-# ERR7-NEXT: boom .temp : { *(.temp) } }
-# RUN: grep '^     ^' %t.log
+# ERR7:      line 4: ( expected, but got '
+# ERR7-NEXT: .temp : { *'.temp) } }
+# RUN: grep '^           ^' %t.log

test/ELF/linkerscript-locationcounter.s

 # BRACKETERR: unexpected EOF
 
 ## Missing opening bracket.
 # RUN: echo "SECTIONS { \
 # RUN:  . = 0x10000 + 0x1000 + 0x1000) * 0x2; \
 # RUN: }" > %t.script
 # RUN: not ld.lld %t --script %t.script -o %t2 2>&1 | \
 # RUN:  FileCheck --check-prefix=BRACKETERR2 %s
-# BRACKETERR2: expected, but got *
+# BRACKETERR2: expected, but got }
 
 ## Empty expression.
 # RUN: echo "SECTIONS { \
 # RUN:  . = ; \
 # RUN: }" > %t.script
 # RUN: not ld.lld %t --script %t.script -o %t2 2>&1 | \
 # RUN:  FileCheck --check-prefix=ERREXPR %s
 # ERREXPR: error in location counter expression

test/ELF/linkerscript-outsections-addr.s

+# REQUIRES: x86
+# RUN: llvm-mc -filetype=obj -triple=x86_64-unknown-linux %s -o %t
+# RUN: echo "SECTIONS {                 \
+# RUN:   .aaa 0x2000 :                  \
+# RUN:   {                              \
+# RUN:    *(.aaa)                       \
+# RUN:   }                              \
+# RUN:   .bbb 0x1 ? 0x3000 : 0x4000 :   \
+# RUN:   {                              \
+# RUN:    *(.bbb)                       \
+# RUN:   }                              \
+# RUN:   .ccc ALIGN(CONSTANT (MAXPAGESIZE)) + (. & (CONSTANT (MAXPAGESIZE) - 1)) : \
+# RUN:   {                              \
+# RUN:    *(.ccc)                       \
+# RUN:   }                              \
+# RUN:   .ddd 0x5001 :                  \
+# RUN:   {                              \
+# RUN:    *(.ddd)                       \
+# RUN:   }                              \
+# RUN: }" > %t.script
+# RUN: ld.lld %t --script %t.script -o %tout
+# RUN: llvm-readobj -s %tout | FileCheck %s
+
+## Check:
+## 1) Simple constant as address.
+## 2) That something that contains ":" character, like ternary
+##    operator works as expression.
+## 3) That complex expressions work.
+## 4) That section alignment still applied to explicitly specified address.
+
+#CHECK:Sections [
+#CHECK:  Section {
+#CHECK:    Index: 0
+#CHECK:    Name:
+#CHECK:    Type: SHT_NULL
+#CHECK:    Flags [
+#CHECK:    ]
+#CHECK:    Address: 0x0
+#CHECK:    Offset: 0x0
+#CHECK:    Size: 0
+#CHECK:    Link: 0
+#CHECK:    Info: 0
+#CHECK:    AddressAlignment: 0
+#CHECK:    EntrySize: 0
+#CHECK:  }
+#CHECK:  Section {
+#CHECK:    Index: 1
+#CHECK:    Name: .aaa
+#CHECK:    Type: SHT_PROGBITS
+#CHECK:    Flags [
+#CHECK:      SHF_ALLOC
+#CHECK:    ]
+#CHECK:    Address: 0x2000
+#CHECK:    Offset: 0x1000
+#CHECK:    Size: 8
+#CHECK:    Link: 0
+#CHECK:    Info: 0
+#CHECK:    AddressAlignment: 1
+#CHECK:    EntrySize: 0
+#CHECK:  }
+#CHECK:  Section {
+#CHECK:    Index: 2
+#CHECK:    Name: .bbb
+#CHECK:    Type: SHT_PROGBITS
+#CHECK:    Flags [
+#CHECK:      SHF_ALLOC
+#CHECK:    ]
+#CHECK:    Address: 0x3000
+#CHECK:    Offset: 0x2000
+#CHECK:    Size: 8
+#CHECK:    Link: 0
+#CHECK:    Info: 0
+#CHECK:    AddressAlignment: 1
+#CHECK:    EntrySize: 0
+#CHECK:  }
+#CHECK:  Section {
+#CHECK:    Index: 3
+#CHECK:    Name: .ccc
+#CHECK:    Type: SHT_PROGBITS
+#CHECK:    Flags [
+#CHECK:      SHF_ALLOC
+#CHECK:    ]
+#CHECK:    Address: 0x4008
+#CHECK:    Offset: 0x2008
+#CHECK:    Size: 8
+#CHECK:    Link: 0
+#CHECK:    Info: 0
+#CHECK:    AddressAlignment: 1
+#CHECK:    EntrySize: 0
+#CHECK:  }
+#CHECK:  Section {
+#CHECK:    Index: 4
+#CHECK:    Name: .ddd
+#CHECK:    Type: SHT_PROGBITS
+#CHECK:    Flags [
+#CHECK:      SHF_ALLOC
+#CHECK:    ]
+#CHECK:    Address: 0x5010
+#CHECK:    Offset: 0x2010
+#CHECK:    Size: 8
+#CHECK:    Link: 0
+#CHECK:    Info: 0
+#CHECK:    AddressAlignment: 16
+#CHECK:    EntrySize: 0
+#CHECK:  }
+  
+.globl _start
+_start:
+nop
+
+.section .aaa, "a"
+.quad 0
+
+.section .bbb, "a"
+.quad 0
+
+.section .ccc, "a"
+.quad 0
+
+.section .ddd, "a"
+.align 16
+.quad 0