Skip to content

Commit

Permalink
[WebAssembly] Relax signature checking for undefined functions that a…
Browse files Browse the repository at this point in the history
…re not called directly

When function signatures don't match and the undefined function is not
called directly (i.e. only has its address taken) we don't issue a
warning or create a runtime thunk for the undefined function.

Instead in this case we simply use the defined version of the function.
This is possible since checking signatures of dynamic calls happens
at runtime so any invalid usage will still result in a runtime error.

This is needed to allow C++ programs to link without generating
warnings.  Its not uncommon in C++ for vtables to be populated by
function address whee the signature of the function is not known in the
compilation unit.  In this case clang declares the method as void(void)
and relies on the vtable caller casting the data back to the correct
signature.

Fixes: https://bugs.llvm.org/show_bug.cgi?id=40412

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

llvm-svn: 361678
  • Loading branch information
sbc100 committed May 24, 2019
1 parent bede937 commit 59f959f
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 21 deletions.
19 changes: 19 additions & 0 deletions lld/test/wasm/signature-mismatch-unknown.ll
@@ -0,0 +1,19 @@
; RUN: llc -filetype=obj %p/Inputs/ret32.ll -o %t.ret32.o
; RUN: llc -filetype=obj %s -o %t.main.o
; RUN: wasm-ld --fatal-warnings -o %t.wasm %t.ret32.o %t.main.o
; RUN: wasm-ld --fatal-warnings -o %t.wasm %t.main.o %t.ret32.o

target triple = "wasm32-unknown-unknown"

; Function declartion with incorrect signature.
declare dso_local void @ret32()

; Simply taking the address of the function should *not* generate the
; the signature mismatch warning.
@ptr = dso_local global i8* bitcast (void ()* @ret32 to i8*), align 8

define hidden void @_start() local_unnamed_addr {
%addr = load i32 ()*, i32 ()** bitcast (i8** @ptr to i32 ()**), align 8
call i32 %addr()
ret void
}
2 changes: 1 addition & 1 deletion lld/wasm/Driver.cpp
Expand Up @@ -550,7 +550,7 @@ struct WrappedSymbol {
};

static Symbol *addUndefined(StringRef Name) {
return Symtab->addUndefinedFunction(Name, "", "", 0, nullptr, nullptr);
return Symtab->addUndefinedFunction(Name, "", "", 0, nullptr, nullptr, false);
}

// Handles -wrap option.
Expand Down
34 changes: 22 additions & 12 deletions lld/wasm/InputFiles.cpp
Expand Up @@ -271,21 +271,28 @@ void ObjFile::parse(bool IgnoreComdats) {
}
}

// Find the code and data sections. Wasm objects can have at most one code
// and one data section.
uint32_t SectionIndex = 0;
SymbolIsCalledDirectly.resize(WasmObj->getNumberOfSymbols(), false);
for (const SectionRef &Sec : WasmObj->sections()) {
const WasmSection &Section = WasmObj->getWasmSection(Sec);
// Wasm objects can have at most one code and one data section.
if (Section.Type == WASM_SEC_CODE) {
assert(!CodeSection);
CodeSection = &Section;
} else if (Section.Type == WASM_SEC_DATA) {
assert(!DataSection);
DataSection = &Section;
} else if (Section.Type == WASM_SEC_CUSTOM) {
CustomSections.emplace_back(make<InputSection>(Section, this));
CustomSections.back()->setRelocations(Section.Relocations);
CustomSectionsByIndex[SectionIndex] = CustomSections.back();
}
SectionIndex++;
// Scans relocations to dermine determine if a function symbol is called
// directly
for (const WasmRelocation &Reloc : Section.Relocations)
if (Reloc.Type == R_WASM_FUNCTION_INDEX_LEB)
SymbolIsCalledDirectly[Reloc.Index] = true;
}

TypeMap.resize(getWasmObj()->types().size());
Expand Down Expand Up @@ -326,10 +333,16 @@ void ObjFile::parse(bool IgnoreComdats) {
Symbols.reserve(WasmObj->getNumberOfSymbols());
for (const SymbolRef &Sym : WasmObj->symbols()) {
const WasmSymbol &WasmSym = WasmObj->getWasmSymbol(Sym.getRawDataRefImpl());
if (Symbol *Sym = createDefined(WasmSym))
Symbols.push_back(Sym);
else
Symbols.push_back(createUndefined(WasmSym));
if (WasmSym.isDefined()) {
// createDefined may fail if the symbol is comdat excluded in which case
// we fall back to creating an undefined symbol
if (Symbol *D = createDefined(WasmSym)) {
Symbols.push_back(D);
continue;
}
}
size_t Idx = Symbols.size();
Symbols.push_back(createUndefined(WasmSym, SymbolIsCalledDirectly[Idx]));
}
}

Expand Down Expand Up @@ -361,9 +374,6 @@ DataSymbol *ObjFile::getDataSymbol(uint32_t Index) const {
}

Symbol *ObjFile::createDefined(const WasmSymbol &Sym) {
if (!Sym.isDefined())
return nullptr;

StringRef Name = Sym.Info.Name;
uint32_t Flags = Sym.Info.Flags;

Expand Down Expand Up @@ -417,15 +427,15 @@ Symbol *ObjFile::createDefined(const WasmSymbol &Sym) {
llvm_unreachable("unknown symbol kind");
}

Symbol *ObjFile::createUndefined(const WasmSymbol &Sym) {
Symbol *ObjFile::createUndefined(const WasmSymbol &Sym, bool IsCalledDirectly) {
StringRef Name = Sym.Info.Name;
uint32_t Flags = Sym.Info.Flags;

switch (Sym.Info.Kind) {
case WASM_SYMBOL_TYPE_FUNCTION:
return Symtab->addUndefinedFunction(Name, Sym.Info.ImportName,
Sym.Info.ImportModule, Flags, this,
Sym.Signature);
Sym.Signature, IsCalledDirectly);
case WASM_SYMBOL_TYPE_DATA:
return Symtab->addUndefinedData(Name, Flags, this);
case WASM_SYMBOL_TYPE_GLOBAL:
Expand Down Expand Up @@ -499,7 +509,7 @@ static Symbol *createBitcodeSymbol(const std::vector<bool> &KeptComdats,
if (ObjSym.isUndefined() || ExcludedByComdat) {
if (ObjSym.isExecutable())
return Symtab->addUndefinedFunction(Name, Name, DefaultModule, Flags, &F,
nullptr);
nullptr, true);
return Symtab->addUndefinedData(Name, Flags, &F);
}

Expand Down
9 changes: 8 additions & 1 deletion lld/wasm/InputFiles.h
Expand Up @@ -69,6 +69,13 @@ class InputFile {

// List of all symbols referenced or defined by this file.
std::vector<Symbol *> Symbols;
// Bool for each symbol, true if called directly. This allows us to implement
// a weaker form of signature checking where undefined functions that are not
// called directly (i.e. only address taken) don't have to match the defined
// function's signature. We cannot do this for directly called functions
// because those signatures are checked at validation times.
// See https://bugs.llvm.org/show_bug.cgi?id=40412
std::vector<bool> SymbolIsCalledDirectly;

private:
const Kind FileKind;
Expand Down Expand Up @@ -138,7 +145,7 @@ class ObjFile : public InputFile {

private:
Symbol *createDefined(const WasmSymbol &Sym);
Symbol *createUndefined(const WasmSymbol &Sym);
Symbol *createUndefined(const WasmSymbol &Sym, bool IsCalledDirectly);

bool isExcludedByComdat(InputChunk *Chunk) const;

Expand Down
13 changes: 9 additions & 4 deletions lld/wasm/SymbolTable.cpp
Expand Up @@ -286,7 +286,11 @@ Symbol *SymbolTable::addDefinedFunction(StringRef Name, uint32_t Flags,
return S;
}

if (Function && !signatureMatches(ExistingFunction, &Function->Signature)) {
bool CheckSig = true;
if (auto UD = dyn_cast<UndefinedFunction>(ExistingFunction))
CheckSig = UD->IsCalledDirectly;

if (CheckSig && Function && !signatureMatches(ExistingFunction, &Function->Signature)) {
Symbol* Variant;
if (getFunctionVariant(S, &Function->Signature, File, &Variant))
// New variant, always replace
Expand Down Expand Up @@ -384,7 +388,8 @@ Symbol *SymbolTable::addDefinedEvent(StringRef Name, uint32_t Flags,
Symbol *SymbolTable::addUndefinedFunction(StringRef Name, StringRef ImportName,
StringRef ImportModule,
uint32_t Flags, InputFile *File,
const WasmSignature *Sig) {
const WasmSignature *Sig,
bool IsCalledDirectly) {
LLVM_DEBUG(dbgs() << "addUndefinedFunction: " << Name <<
" [" << (Sig ? toString(*Sig) : "none") << "]\n");

Expand All @@ -396,7 +401,7 @@ Symbol *SymbolTable::addUndefinedFunction(StringRef Name, StringRef ImportName,

auto Replace = [&]() {
replaceSymbol<UndefinedFunction>(S, Name, ImportName, ImportModule, Flags,
File, Sig);
File, Sig, IsCalledDirectly);
};

if (WasInserted)
Expand All @@ -409,7 +414,7 @@ Symbol *SymbolTable::addUndefinedFunction(StringRef Name, StringRef ImportName,
reportTypeError(S, File, WASM_SYMBOL_TYPE_FUNCTION);
return S;
}
if (!signatureMatches(ExistingFunction, Sig))
if (IsCalledDirectly && !signatureMatches(ExistingFunction, Sig))
if (getFunctionVariant(S, Sig, File, &S))
Replace();
}
Expand Down
3 changes: 2 additions & 1 deletion lld/wasm/SymbolTable.h
Expand Up @@ -63,7 +63,8 @@ class SymbolTable {

Symbol *addUndefinedFunction(StringRef Name, StringRef ImportName,
StringRef ImportModule, uint32_t Flags,
InputFile *File, const WasmSignature *Signature);
InputFile *File, const WasmSignature *Signature,
bool IsCalledDirectly);
Symbol *addUndefinedData(StringRef Name, uint32_t Flags, InputFile *File);
Symbol *addUndefinedGlobal(StringRef Name, StringRef ImportName,
StringRef ImportModule, uint32_t Flags,
Expand Down
6 changes: 4 additions & 2 deletions lld/wasm/Symbols.h
Expand Up @@ -194,16 +194,18 @@ class UndefinedFunction : public FunctionSymbol {
UndefinedFunction(StringRef Name, StringRef ImportName,
StringRef ImportModule, uint32_t Flags,
InputFile *File = nullptr,
const WasmSignature *Type = nullptr)
const WasmSignature *Type = nullptr,
bool IsCalledDirectly = true)
: FunctionSymbol(Name, UndefinedFunctionKind, Flags, File, Type),
ImportName(ImportName), ImportModule(ImportModule) {}
ImportName(ImportName), ImportModule(ImportModule), IsCalledDirectly(IsCalledDirectly) {}

static bool classof(const Symbol *S) {
return S->kind() == UndefinedFunctionKind;
}

StringRef ImportName;
StringRef ImportModule;
bool IsCalledDirectly;
};

// Section symbols for output sections are different from those for input
Expand Down

0 comments on commit 59f959f

Please sign in to comment.