[PATCH] D124433: [ELF] Prevent LTO stripping of wrapped script-referenced symbols

[Shoaib Meenai via Phabricator via llvm-commits]

smeenai created this revision.
smeenai added a reviewer: MaskRay.
Herald added subscribers: ormris, StephenFan, steven_wu, hiraditya, arichardson, inglorion, emaste.
Herald added a project: All.
smeenai requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

After 1af25a986069f2ae8c724133fa8649bb795a7925 <https://reviews.llvm.org/rG1af25a986069f2ae8c724133fa8649bb795a7925>, we stop unconditionally
retaining wrapped symbols, which means that LTO's summary-based global
dead stripping can eliminate them even if they'll be referenced by a
linker script after the wrapping is performed. Mark symbols referenced
in linker scripts as `referenced` in addition to `isUsedInRegularObj` in
order for the wrapping logic to correctly set `referencedAfterWrap` and
prevent LTO from eliminating them.

An alternative would have been to change the `referencedAfterWrap` logic
to look at `isUsedInRegularObj` in addition to `referenced`, but
`isUsedInRegularObj` is also set in other places (e.g. for the entry
symbol), and it's not clear that we want `referencedAfterWrap` to take
all those places into account, so it seemed better to keep that logic
as-is and instead set `referenced` for linker script-referenced symbols.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D124433

Files:
  lld/ELF/Driver.cpp
  lld/test/ELF/lto/wrap-script-referenced.ll


Index: lld/test/ELF/lto/wrap-script-referenced.ll
===================================================================
--- /dev/null
+++ lld/test/ELF/lto/wrap-script-referenced.ll
@@ -0,0 +1,46 @@
+;; Verify that the target of a wrap is kept by LTO's summary-based global dead
+;; stripping if the original symbol is referenced by a linker script or --defsym
+
+; REQUIRES: x86
+; RUN: rm -rf %t && split-file %s %t
+
+;; We need a module summary to trigger summary-based global stripping
+; RUN: opt -module-summary -o %t/foo.bc %t/foo.ll
+; RUN: echo 'alias = __real_foo;' > %t/alias.ld
+; RUN: ld.lld -shared -o %t/libalias_foo.so %t/foo.bc %t/alias.ld --wrap foo
+; RUN: llvm-readelf --syms %t/libalias_foo.so | FileCheck --check-prefix=FOO %s
+
+; FOO:     Symbol table '.symtab' contains
+; FOO-DAG: [[#]]: [[#%.16x,FOO_VAL:]] 1 FUNC    LOCAL  HIDDEN      6 foo
+; FOO-DAG: [[#]]: [[#%.16x,FOO_VAL]]  0 FUNC    GLOBAL DEFAULT     6 alias
+
+; RUN: opt -module-summary -o %t/wrap_foo.bc %t/wrap_foo.ll
+; RUN: ld.lld -shared -o %t/libalias_wrap_foo.so %t/wrap_foo.bc --wrap foo --defsym=alias=foo
+; RUN: llvm-readelf --syms %t/libalias_wrap_foo.so | FileCheck --check-prefix=WRAP-FOO %s
+
+; WRAP-FOO:     Symbol table '.symtab' contains
+; WRAP-FOO-DAG: [[#]]: [[#%.16x,WRAP_FOO_VAL:]] 1 FUNC    LOCAL  HIDDEN      5 __wrap_foo
+; WRAP-FOO-DAG: [[#]]: [[#%.16x,WRAP_FOO_VAL]]  0 FUNC    GLOBAL DEFAULT     5 alias
+
+;--- foo.ll
+target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-unknown-linux-gnu"
+define hidden void @foo() {
+  ret void
+}
+
+;; We need a live root to trigger summary-based global stripping
+define dso_local void @bar() {
+  ret void
+}
+
+;--- wrap_foo.ll
+target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-unknown-linux-gnu"
+define hidden void @__wrap_foo() {
+  ret void
+}
+
+define dso_local void @bar() {
+  ret void
+}
Index: lld/ELF/Driver.cpp
===================================================================
--- lld/ELF/Driver.cpp
+++ lld/ELF/Driver.cpp
@@ -2463,8 +2463,11 @@
 
   // Some symbols (such as __ehdr_start) are defined lazily only when there
   // are undefined symbols for them, so we add these to trigger that logic.
-  for (StringRef name : script->referencedSymbols)
-    addUnusedUndefined(name)->isUsedInRegularObj = true;
+  for (StringRef name : script->referencedSymbols) {
+    Symbol *sym = addUnusedUndefined(name);
+    sym->isUsedInRegularObj = true;
+    sym->referenced = true;
+  }
 
   // Prevent LTO from removing any definition referenced by -u.
   for (StringRef name : config->undefined)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D124433.425122.patch
Type: text/x-patch
Size: 2700 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220426/10f9a521/attachment.bin>