[lld][WebAssembly] Allow linker-synthetic symbols to be undefined when building shared libraries #128223

sbc100 · 2025-02-21T19:58:09Z

llvmbot · 2025-02-21T19:58:44Z

@llvm/pr-subscribers-lld

Author: Sam Clegg (sbc100)

Changes

… building shared libraries

Fixes: #103592

Full diff: https://github.com/llvm/llvm-project/pull/128223.diff

3 Files Affected:

(added) lld/test/wasm/shared-synthetic-symbols.s (+69)
(modified) lld/wasm/Driver.cpp (+19-12)
(modified) lld/wasm/Symbols.h (+1-1)

diff --git a/lld/test/wasm/shared-synthetic-symbols.s b/lld/test/wasm/shared-synthetic-symbols.s
new file mode 100644
index 0000000000000..0fd5a9516a94e
--- /dev/null
+++ b/lld/test/wasm/shared-synthetic-symbols.s
@@ -0,0 +1,69 @@
+## Check that synthetic data-layout symbols such as __heap_base and __heap_end
+## can be references from shared libraries and pie executables without
+## generating undefined symbols.
+
+# RUN: llvm-mc -filetype=obj -triple=wasm32-unknown-unknown -o %t.o %s
+# RUN: wasm-ld --experimental-pic -pie -o %t.wasm %t.o
+# RUN: wasm-ld --experimental-pic -shared -o %t.so %t.o
+# RUN: obj2yaml %t.wasm | FileCheck %s
+
+.globl _start
+
+_start:
+  .functype _start () -> ()
+  i32.const __heap_base@GOT
+  drop
+  i32.const __heap_end@GOT
+  drop
+  i32.const __stack_low@GOT
+  drop
+  i32.const __stack_high@GOT
+  drop
+  i32.const __global_base@GOT
+  drop
+  i32.const __data_end@GOT
+  drop
+  end_function
+
+# CHECK:        - Type:            IMPORT
+# CHECK-NEXT:     Imports:
+# CHECK-NEXT:       - Module:          env
+# CHECK-NEXT:         Field:           __memory_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   false
+# CHECK-NEXT:       - Module:          env
+# CHECK-NEXT:         Field:           __table_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   false
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __heap_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __heap_end
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __stack_low
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __stack_high
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __global_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __data_end
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
diff --git a/lld/wasm/Driver.cpp b/lld/wasm/Driver.cpp
index c3a74dde6480e..89b35ef8d671d 100644
--- a/lld/wasm/Driver.cpp
+++ b/lld/wasm/Driver.cpp
@@ -965,6 +965,8 @@ static void createSyntheticSymbols() {
   } else {
     // For non-PIC code
     WasmSym::stackPointer = createGlobalVariable("__stack_pointer", true);
+    WasmSym::definedMemoryBase = symtab->addOptionalDataSymbol("__memory_base");
+    WasmSym::definedTableBase = symtab->addOptionalDataSymbol("__table_base");
     WasmSym::stackPointer->markLive();
   }
 
@@ -986,18 +988,23 @@ static void createOptionalSymbols() {
 
   WasmSym::dsoHandle = symtab->addOptionalDataSymbol("__dso_handle");
 
-  if (!ctx.arg.shared)
-    WasmSym::dataEnd = symtab->addOptionalDataSymbol("__data_end");
-
-  if (!ctx.isPic) {
-    WasmSym::stackLow = symtab->addOptionalDataSymbol("__stack_low");
-    WasmSym::stackHigh = symtab->addOptionalDataSymbol("__stack_high");
-    WasmSym::globalBase = symtab->addOptionalDataSymbol("__global_base");
-    WasmSym::heapBase = symtab->addOptionalDataSymbol("__heap_base");
-    WasmSym::heapEnd = symtab->addOptionalDataSymbol("__heap_end");
-    WasmSym::definedMemoryBase = symtab->addOptionalDataSymbol("__memory_base");
-    WasmSym::definedTableBase = symtab->addOptionalDataSymbol("__table_base");
-  }
+  auto addDataLayoutSymbol = [&](StringRef s) -> DefinedData* {
+    // Data layout symbols are either defined by the lld, or (in the case
+    // of PIC code) defined by the dynamic linker / embedder.
+    if (ctx.isPic) {
+      ctx.arg.allowUndefinedSymbols.insert(s);
+      return nullptr;
+    } else {
+      return symtab->addOptionalDataSymbol(s);
+    }
+  };
+
+  WasmSym::dataEnd = addDataLayoutSymbol("__data_end");
+  WasmSym::stackLow = addDataLayoutSymbol("__stack_low");
+  WasmSym::stackHigh = addDataLayoutSymbol("__stack_high");
+  WasmSym::globalBase = addDataLayoutSymbol("__global_base");
+  WasmSym::heapBase = addDataLayoutSymbol("__heap_base");
+  WasmSym::heapEnd = addDataLayoutSymbol("__heap_end");
 
   // For non-shared memory programs we still need to define __tls_base since we
   // allow object files built with TLS to be linked into single threaded
diff --git a/lld/wasm/Symbols.h b/lld/wasm/Symbols.h
index b409fffc50a6c..4ccb95aa486a1 100644
--- a/lld/wasm/Symbols.h
+++ b/lld/wasm/Symbols.h
@@ -560,7 +560,7 @@ struct WasmSym {
   // Symbol whose value is the size of the TLS block.
   static GlobalSymbol *tlsSize;
 
-  // __tls_size
+  // __tls_align
   // Symbol whose value is the alignment of the TLS block.
   static GlobalSymbol *tlsAlign;

llvmbot · 2025-02-21T19:58:45Z

@llvm/pr-subscribers-lld-wasm

Author: Sam Clegg (sbc100)

Changes

… building shared libraries

Fixes: #103592

Full diff: https://github.com/llvm/llvm-project/pull/128223.diff

3 Files Affected:

(added) lld/test/wasm/shared-synthetic-symbols.s (+69)
(modified) lld/wasm/Driver.cpp (+19-12)
(modified) lld/wasm/Symbols.h (+1-1)

diff --git a/lld/test/wasm/shared-synthetic-symbols.s b/lld/test/wasm/shared-synthetic-symbols.s
new file mode 100644
index 0000000000000..0fd5a9516a94e
--- /dev/null
+++ b/lld/test/wasm/shared-synthetic-symbols.s
@@ -0,0 +1,69 @@
+## Check that synthetic data-layout symbols such as __heap_base and __heap_end
+## can be references from shared libraries and pie executables without
+## generating undefined symbols.
+
+# RUN: llvm-mc -filetype=obj -triple=wasm32-unknown-unknown -o %t.o %s
+# RUN: wasm-ld --experimental-pic -pie -o %t.wasm %t.o
+# RUN: wasm-ld --experimental-pic -shared -o %t.so %t.o
+# RUN: obj2yaml %t.wasm | FileCheck %s
+
+.globl _start
+
+_start:
+  .functype _start () -> ()
+  i32.const __heap_base@GOT
+  drop
+  i32.const __heap_end@GOT
+  drop
+  i32.const __stack_low@GOT
+  drop
+  i32.const __stack_high@GOT
+  drop
+  i32.const __global_base@GOT
+  drop
+  i32.const __data_end@GOT
+  drop
+  end_function
+
+# CHECK:        - Type:            IMPORT
+# CHECK-NEXT:     Imports:
+# CHECK-NEXT:       - Module:          env
+# CHECK-NEXT:         Field:           __memory_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   false
+# CHECK-NEXT:       - Module:          env
+# CHECK-NEXT:         Field:           __table_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   false
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __heap_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __heap_end
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __stack_low
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __stack_high
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __global_base
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
+# CHECK-NEXT:       - Module:          GOT.mem
+# CHECK-NEXT:         Field:           __data_end
+# CHECK-NEXT:         Kind:            GLOBAL
+# CHECK-NEXT:         GlobalType:      I32
+# CHECK-NEXT:         GlobalMutable:   true
diff --git a/lld/wasm/Driver.cpp b/lld/wasm/Driver.cpp
index c3a74dde6480e..89b35ef8d671d 100644
--- a/lld/wasm/Driver.cpp
+++ b/lld/wasm/Driver.cpp
@@ -965,6 +965,8 @@ static void createSyntheticSymbols() {
   } else {
     // For non-PIC code
     WasmSym::stackPointer = createGlobalVariable("__stack_pointer", true);
+    WasmSym::definedMemoryBase = symtab->addOptionalDataSymbol("__memory_base");
+    WasmSym::definedTableBase = symtab->addOptionalDataSymbol("__table_base");
     WasmSym::stackPointer->markLive();
   }
 
@@ -986,18 +988,23 @@ static void createOptionalSymbols() {
 
   WasmSym::dsoHandle = symtab->addOptionalDataSymbol("__dso_handle");
 
-  if (!ctx.arg.shared)
-    WasmSym::dataEnd = symtab->addOptionalDataSymbol("__data_end");
-
-  if (!ctx.isPic) {
-    WasmSym::stackLow = symtab->addOptionalDataSymbol("__stack_low");
-    WasmSym::stackHigh = symtab->addOptionalDataSymbol("__stack_high");
-    WasmSym::globalBase = symtab->addOptionalDataSymbol("__global_base");
-    WasmSym::heapBase = symtab->addOptionalDataSymbol("__heap_base");
-    WasmSym::heapEnd = symtab->addOptionalDataSymbol("__heap_end");
-    WasmSym::definedMemoryBase = symtab->addOptionalDataSymbol("__memory_base");
-    WasmSym::definedTableBase = symtab->addOptionalDataSymbol("__table_base");
-  }
+  auto addDataLayoutSymbol = [&](StringRef s) -> DefinedData* {
+    // Data layout symbols are either defined by the lld, or (in the case
+    // of PIC code) defined by the dynamic linker / embedder.
+    if (ctx.isPic) {
+      ctx.arg.allowUndefinedSymbols.insert(s);
+      return nullptr;
+    } else {
+      return symtab->addOptionalDataSymbol(s);
+    }
+  };
+
+  WasmSym::dataEnd = addDataLayoutSymbol("__data_end");
+  WasmSym::stackLow = addDataLayoutSymbol("__stack_low");
+  WasmSym::stackHigh = addDataLayoutSymbol("__stack_high");
+  WasmSym::globalBase = addDataLayoutSymbol("__global_base");
+  WasmSym::heapBase = addDataLayoutSymbol("__heap_base");
+  WasmSym::heapEnd = addDataLayoutSymbol("__heap_end");
 
   // For non-shared memory programs we still need to define __tls_base since we
   // allow object files built with TLS to be linked into single threaded
diff --git a/lld/wasm/Symbols.h b/lld/wasm/Symbols.h
index b409fffc50a6c..4ccb95aa486a1 100644
--- a/lld/wasm/Symbols.h
+++ b/lld/wasm/Symbols.h
@@ -560,7 +560,7 @@ struct WasmSym {
   // Symbol whose value is the size of the TLS block.
   static GlobalSymbol *tlsSize;
 
-  // __tls_size
+  // __tls_align
   // Symbol whose value is the alignment of the TLS block.
   static GlobalSymbol *tlsAlign;

github-actions · 2025-02-21T20:01:27Z

✅ With the latest revision this PR passed the C/C++ code formatter.

… building shared libraries Fixes: llvm#103592

dschuff · 2025-02-24T20:34:57Z

lld/wasm/Driver.cpp

-    WasmSym::definedTableBase = symtab->addOptionalDataSymbol("__table_base");
-  }
+  auto addDataLayoutSymbol = [&](StringRef s) -> DefinedData * {
+    // Data layout symbols are either defined by the lld, or (in the case


Suggested change

// Data layout symbols are either defined by the lld, or (in the case

// Data layout symbols are either defined by lld, or (in the case

llvmbot added lld lld:wasm labels Feb 21, 2025

sbc100 changed the title ~~[lld][WebAssembly] Allow linker-synthetic symbols to be undefine when…~~ [lld][WebAssembly] Allow linker-synthetic symbols to be undefine when building shared libraries Feb 21, 2025

sbc100 force-pushed the shared_libary_data_layout_symbols branch from 721563e to 712bd72 Compare February 21, 2025 20:03

sbc100 mentioned this pull request Feb 21, 2025

[WebAssembly][lld] excessive undefined symbol errors when building a shared library #103592

Open

sbc100 requested review from dschuff and brendandahl February 21, 2025 20:03

sbc100 changed the title ~~[lld][WebAssembly] Allow linker-synthetic symbols to be undefine when building shared libraries~~ [lld][WebAssembly] Allow linker-synthetic symbols to be undefined when building shared libraries Feb 21, 2025

sbc100 force-pushed the shared_libary_data_layout_symbols branch from 712bd72 to aea7b09 Compare February 21, 2025 20:05

[lld][WebAssembly] Allow linker-synthetic symbols to be undefine when…

46ebbc2

… building shared libraries Fixes: llvm#103592

sbc100 force-pushed the shared_libary_data_layout_symbols branch from aea7b09 to 46ebbc2 Compare February 21, 2025 20:12

dschuff approved these changes Feb 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[lld][WebAssembly] Allow linker-synthetic symbols to be undefined when building shared libraries #128223

[lld][WebAssembly] Allow linker-synthetic symbols to be undefined when building shared libraries #128223

sbc100 commented Feb 21, 2025 •

edited

Loading

llvmbot commented Feb 21, 2025

llvmbot commented Feb 21, 2025

github-actions bot commented Feb 21, 2025 •

edited

Loading

dschuff Feb 24, 2025

	// Data layout symbols are either defined by the lld, or (in the case
	// Data layout symbols are either defined by lld, or (in the case

[lld][WebAssembly] Allow linker-synthetic symbols to be undefined when building shared libraries #128223

Are you sure you want to change the base?

[lld][WebAssembly] Allow linker-synthetic symbols to be undefined when building shared libraries #128223

Conversation

sbc100 commented Feb 21, 2025 • edited Loading

llvmbot commented Feb 21, 2025

llvmbot commented Feb 21, 2025

github-actions bot commented Feb 21, 2025 • edited Loading

dschuff Feb 24, 2025

Choose a reason for hiding this comment

sbc100 commented Feb 21, 2025 •

edited

Loading

github-actions bot commented Feb 21, 2025 •

edited

Loading