From 7fc3c153a878a7f8f16df761a90f164c9f090ec9 Mon Sep 17 00:00:00 2001
From: Weining Lu <luweining@loongson.cn>
Date: Wed, 9 Aug 2023 09:54:41 +0800
Subject: [PATCH] [lld][LoongArch] Support the R_LARCH_PCREL20_S2 relocation
 type

`R_LARCH_PCREL20_S2` is a new added relocation type in LoongArch ELF
psABI v2.10 [1] which is not corvered by D138135 except `R_LARCH_64_PCREL`.

A motivation to support `R_LARCH_PCREL20_S2` in lld is to build the
runtime of .NET core (a.k.a `CoreCLR`) in which strict PC-relative
semantics need to be guaranteed [2]. The normal `pcalau12i + addi.d`
approach doesn't work because the code will be copied to other places
with different "page" and offsets. To achieve this, we can use `pcaddi`
with explicit `R_LARCH_PCREL20_S2` reloc to address +-2MB PC-relative
range with 4-bytes aligned.

[1]: https://github.com/loongson/la-abi-specs/releases/tag/v2.10
[2]: https://github.com/dotnet/runtime/blob/release/7.0/src/coreclr/vm/loongarch64/asmhelpers.S#L307

Reviewed By: xen0n, MaskRay

Differential Revision: https://reviews.llvm.org/D156772

(cherry picked from commit 8a31f7ddb8436fa2a8ad754eb51618139cf63415)
---
 lld/ELF/Arch/LoongArch.cpp          |  7 +++++++
 lld/test/ELF/loongarch-pcrel20-s2.s | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 lld/test/ELF/loongarch-pcrel20-s2.s

diff --git a/lld/ELF/Arch/LoongArch.cpp b/lld/ELF/Arch/LoongArch.cpp
index 9dc99e5..04ddb46 100644
--- a/lld/ELF/Arch/LoongArch.cpp
+++ b/lld/ELF/Arch/LoongArch.cpp
@@ -457,6 +457,7 @@ RelExpr LoongArch::getRelExpr(const RelType type, const Symbol &s,
     return R_RISCV_ADD;
   case R_LARCH_32_PCREL:
   case R_LARCH_64_PCREL:
+  case R_LARCH_PCREL20_S2:
     return R_PC;
   case R_LARCH_B16:
   case R_LARCH_B21:
@@ -564,6 +565,12 @@ void LoongArch::relocate(uint8_t *loc, const Relocation &rel,
     write64le(loc, val);
     return;
 
+  case R_LARCH_PCREL20_S2:
+    checkInt(loc, val, 22, rel);
+    checkAlignment(loc, val, 4, rel);
+    write32le(loc, setJ20(read32le(loc), val >> 2));
+    return;
+
   case R_LARCH_B16:
     checkInt(loc, val, 18, rel);
     checkAlignment(loc, val, 4, rel);
diff --git a/lld/test/ELF/loongarch-pcrel20-s2.s b/lld/test/ELF/loongarch-pcrel20-s2.s
new file mode 100644
index 0000000..8a4bafb
--- /dev/null
+++ b/lld/test/ELF/loongarch-pcrel20-s2.s
@@ -0,0 +1,32 @@
+# REQUIRES: loongarch
+
+# RUN: llvm-mc --filetype=obj --triple=loongarch32-unknown-elf %s -o %t.la32.o
+# RUN: llvm-mc --filetype=obj --triple=loongarch64-unknown-elf %s -o %t.la64.o
+
+# RUN: ld.lld %t.la32.o --section-start=.text=0x20000 --section-start=.data=0x20008 -o %t.la32.1
+# RUN: ld.lld %t.la64.o --section-start=.text=0x20000 --section-start=.data=0x20008 -o %t.la64.1
+# RUN: llvm-objdump --no-show-raw-insn -d %t.la32.1 | FileCheck --match-full-lines %s
+# RUN: llvm-objdump --no-show-raw-insn -d %t.la64.1 | FileCheck --match-full-lines %s
+# CHECK: 20000: pcaddi $t0, 2
+
+# RUN: not ld.lld %t.la32.o --section-start=.text=0x20000 --section-start=.data=0x220000 -o /dev/null 2>&1 | \
+# RUN:   FileCheck -DFILE=%t.la32.o --check-prefix=ERROR-RANGE %s
+# RUN: not ld.lld %t.la64.o --section-start=.text=0x20000 --section-start=.data=0x220000 -o /dev/null 2>&1 | \
+# RUN:   FileCheck -DFILE=%t.la64.o --check-prefix=ERROR-RANGE %s
+# ERROR-RANGE: error: [[FILE]]:(.text+0x0): relocation R_LARCH_PCREL20_S2 out of range: 2097152 is not in [-2097152, 2097151]; references section '.data'
+
+# RUN: not ld.lld %t.la32.o --section-start=.text=0x20000 --section-start=.data=0x40001 -o /dev/null 2>&1 | \
+# RUN:   FileCheck -DFILE=%t.la32.o --check-prefix=ERROR-ALIGN %s
+# RUN: not ld.lld %t.la64.o --section-start=.text=0x20000 --section-start=.data=0x40001 -o /dev/null 2>&1 | \
+# RUN:   FileCheck -DFILE=%t.la64.o --check-prefix=ERROR-ALIGN %s
+# ERROR-ALIGN: error: [[FILE]]:(.text+0x0): improper alignment for relocation R_LARCH_PCREL20_S2: 0x20001 is not aligned to 4 bytes
+
+.global _start
+
+_start:
+1:
+  pcaddi $t0, 0
+  .reloc 1b, R_LARCH_PCREL20_S2, .data
+
+.data
+  .word 0
-- 
2.7.4