Skip to content

Commit

Permalink
[LinkerWrapper] Fix static library symbol resolution
Browse files Browse the repository at this point in the history 
The linker wrapper performs its own very basic symbol resolution for the
purpose of supporting standard static library semantics. We do this here
because the Nvidia `nvlink` wrapper does not support static linking and
we have some offloading specific extensions.

Currently, we always place symbols in the "table" even if they aren't
extracted. This caused the logic to fail when many files were used that
referenced the same undefined variable. This patch changes the pass to
only add the symbols to the global "table" if the file is actually
extracted.

Reviewed By: tra

Differential Revision: https://reviews.llvm.org/D151839
  • Loading branch information
@jhuber6
jhuber6 committed Jun 1, 2023
1 parent 8e58fdd commit a26bd95
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 19 deletions.
7 changes: 7 additions & 0 deletions clang/test/Driver/linker-wrapper-libs.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ int __attribute__((visibility("protected"))) global;
int __attribute__((visibility("hidden"))) weak;
#elif defined(HIDDEN)
int __attribute__((visibility("hidden"))) hidden;
#elif defined(UNDEFINED)
extern int sym;
int baz() { return sym; }
#else
extern int sym;

Expand All @@ -26,7 +29,11 @@ int bar() { return weak; }
//
// RUN: %clang -cc1 %s -triple nvptx64-nvidia-cuda -emit-llvm-bc -DRESOLVES -o %t.nvptx.resolves.bc
// RUN: %clang -cc1 %s -triple amdgcn-amd-amdhsa -emit-llvm-bc -DRESOLVES -o %t.amdgpu.resolves.bc
// RUN: %clang -cc1 %s -triple nvptx64-nvidia-cuda -emit-llvm-bc -DUNDEFINED -o %t.nvptx.undefined.bc
// RUN: %clang -cc1 %s -triple amdgcn-amd-amdhsa -emit-llvm-bc -DUNDEFINED -o %t.amdgpu.undefined.bc
// RUN: clang-offload-packager -o %t-lib.out \
// RUN: --image=file=%t.nvptx.undefined.bc,kind=openmp,triple=nvptx64-nvidia-cuda,arch=sm_70 \
// RUN: --image=file=%t.amdgpu.undefined.bc,kind=openmp,triple=amdgcn-amd-amdhsa,arch=gfx1030 \
// RUN: --image=file=%t.nvptx.resolves.bc,kind=openmp,triple=nvptx64-nvidia-cuda,arch=sm_70 \
// RUN: --image=file=%t.amdgpu.resolves.bc,kind=openmp,triple=amdgcn-amd-amdhsa,arch=gfx1030
// RUN: %clang -cc1 %s -triple x86_64-unknown-linux-gnu -emit-obj -o %t.o -fembed-offload-object=%t-lib.out
Expand Down
56 changes: 37 additions & 19 deletions clang/tools/clang-linker-wrapper/ClangLinkerWrapper.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1163,20 +1163,21 @@ enum Symbol : uint32_t {
/// Scan the symbols from a BitcodeFile \p Buffer and record if we need to
/// extract any symbols from it.
Expected<bool> getSymbolsFromBitcode(MemoryBufferRef Buffer, OffloadKind Kind,
StringSaver &Saver,
bool IsArchive, StringSaver &Saver,
DenseMap<StringRef, Symbol> &Syms) {
Expected<IRSymtabFile> IRSymtabOrErr = readIRSymtab(Buffer);
if (!IRSymtabOrErr)
return IRSymtabOrErr.takeError();

bool ShouldExtract = false;
bool ShouldExtract = !IsArchive;
DenseMap<StringRef, Symbol> TmpSyms;
for (unsigned I = 0; I != IRSymtabOrErr->Mods.size(); ++I) {
for (const auto &Sym : IRSymtabOrErr->TheReader.module_symbols(I)) {
if (Sym.isFormatSpecific() || !Sym.isGlobal())
continue;

bool NewSymbol = Syms.count(Sym.getName()) == 0;
auto &OldSym = Syms[Saver.save(Sym.getName())];
auto OldSym = NewSymbol ? Sym_None : Syms[Sym.getName()];

// We will extract if it defines a currenlty undefined non-weak symbol.
bool ResolvesStrongReference =
Expand All @@ -1192,23 +1193,31 @@ Expected<bool> getSymbolsFromBitcode(MemoryBufferRef Buffer, OffloadKind Kind,

// Update this symbol in the "table" with the new information.
if (OldSym & Sym_Undefined && !Sym.isUndefined())
OldSym = static_cast<Symbol>(OldSym & ~Sym_Undefined);
TmpSyms[Saver.save(Sym.getName())] =
static_cast<Symbol>(OldSym & ~Sym_Undefined);
if (Sym.isUndefined() && NewSymbol)
OldSym = static_cast<Symbol>(OldSym | Sym_Undefined);
TmpSyms[Saver.save(Sym.getName())] =
static_cast<Symbol>(OldSym | Sym_Undefined);
if (Sym.isWeak())
OldSym = static_cast<Symbol>(OldSym | Sym_Weak);
TmpSyms[Saver.save(Sym.getName())] =
static_cast<Symbol>(OldSym | Sym_Weak);
}
}

// If the file gets extracted we update the table with the new symbols.
if (ShouldExtract)
Syms.insert(std::begin(TmpSyms), std::end(TmpSyms));

return ShouldExtract;
}

/// Scan the symbols from an ObjectFile \p Obj and record if we need to extract
/// any symbols from it.
Expected<bool> getSymbolsFromObject(const ObjectFile &Obj, OffloadKind Kind,
StringSaver &Saver,
bool IsArchive, StringSaver &Saver,
DenseMap<StringRef, Symbol> &Syms) {
bool ShouldExtract = false;
bool ShouldExtract = !IsArchive;
DenseMap<StringRef, Symbol> TmpSyms;
for (SymbolRef Sym : Obj.symbols()) {
auto FlagsOrErr = Sym.getFlags();
if (!FlagsOrErr)
Expand All @@ -1223,7 +1232,7 @@ Expected<bool> getSymbolsFromObject(const ObjectFile &Obj, OffloadKind Kind,
return NameOrErr.takeError();

bool NewSymbol = Syms.count(*NameOrErr) == 0;
auto &OldSym = Syms[Saver.save(*NameOrErr)];
auto OldSym = NewSymbol ? Sym_None : Syms[*NameOrErr];

// We will extract if it defines a currenlty undefined non-weak symbol.
bool ResolvesStrongReference = (OldSym & Sym_Undefined) &&
Expand All @@ -1240,12 +1249,19 @@ Expected<bool> getSymbolsFromObject(const ObjectFile &Obj, OffloadKind Kind,

// Update this symbol in the "table" with the new information.
if (OldSym & Sym_Undefined && !(*FlagsOrErr & SymbolRef::SF_Undefined))
OldSym = static_cast<Symbol>(OldSym & ~Sym_Undefined);
TmpSyms[Saver.save(*NameOrErr)] =
static_cast<Symbol>(OldSym & ~Sym_Undefined);
if (*FlagsOrErr & SymbolRef::SF_Undefined && NewSymbol)
OldSym = static_cast<Symbol>(OldSym | Sym_Undefined);
TmpSyms[Saver.save(*NameOrErr)] =
static_cast<Symbol>(OldSym | Sym_Undefined);
if (*FlagsOrErr & SymbolRef::SF_Weak)
OldSym = static_cast<Symbol>(OldSym | Sym_Weak);
TmpSyms[Saver.save(*NameOrErr)] = static_cast<Symbol>(OldSym | Sym_Weak);
}

// If the file gets extracted we update the table with the new symbols.
if (ShouldExtract)
Syms.insert(std::begin(TmpSyms), std::end(TmpSyms));

return ShouldExtract;
}

Expand All @@ -1255,18 +1271,19 @@ Expected<bool> getSymbolsFromObject(const ObjectFile &Obj, OffloadKind Kind,
/// 1) It defines an undefined symbol in a regular object filie.
/// 2) It defines a global symbol without hidden visibility that has not
/// yet been defined.
Expected<bool> getSymbols(StringRef Image, OffloadKind Kind, StringSaver &Saver,
Expected<bool> getSymbols(StringRef Image, OffloadKind Kind, bool IsArchive,
StringSaver &Saver,
DenseMap<StringRef, Symbol> &Syms) {
MemoryBufferRef Buffer = MemoryBufferRef(Image, "");
switch (identify_magic(Image)) {
case file_magic::bitcode:
return getSymbolsFromBitcode(Buffer, Kind, Saver, Syms);
return getSymbolsFromBitcode(Buffer, Kind, IsArchive, Saver, Syms);
case file_magic::elf_relocatable: {
Expected<std::unique_ptr<ObjectFile>> ObjFile =
ObjectFile::createObjectFile(Buffer);
if (!ObjFile)
return ObjFile.takeError();
return getSymbolsFromObject(**ObjFile, Kind, Saver, Syms);
return getSymbolsFromObject(**ObjFile, Kind, IsArchive, Saver, Syms);
}
default:
return false;
Expand Down Expand Up @@ -1341,13 +1358,14 @@ Expected<SmallVector<OffloadFile>> getDeviceInput(const ArgList &Args) {
if (IsArchive && !WholeArchive && !Syms.count(Binary))
continue;

Expected<bool> ExtractOrErr = getSymbols(
Binary.getBinary()->getImage(),
Binary.getBinary()->getOffloadKind(), Saver, Syms[Binary]);
Expected<bool> ExtractOrErr =
getSymbols(Binary.getBinary()->getImage(),
Binary.getBinary()->getOffloadKind(), IsArchive, Saver,
Syms[Binary]);
if (!ExtractOrErr)
return ExtractOrErr.takeError();

Extracted = IsArchive && !WholeArchive && *ExtractOrErr;
Extracted = !WholeArchive && *ExtractOrErr;

if (!IsArchive || WholeArchive || Extracted)
InputFiles.emplace_back(std::move(Binary));
Expand Down

0 comments on commit a26bd95

Please sign in to comment.