Files
clang-p2996/llvm/lib/Target/NVPTX/NVPTXAssignValidGlobalNames.cpp
Artem Belevich 020fa86897 [NVPTX] mangle symbols in debug info to conform to PTX restrictions. (#113216)
Until now debug info was printing the symbols names as-is and that
resulted in invalid PTX when the symbols contained characters that are
invalid for PTX. E.g. `__PRETTY_FUNCTION.something`

Debug info is somewhat disconnected from the symbols themselves, so the
regular "NVPTXAssignValidGlobalNames" pass can't easily fix them.

As the "plan B" this patch catches printout of debug symbols and fixes
them, as needed. One gotcha is that the same code path is used to print
the names of debug info sections. Those section names do start with a
'.debug'. The dot in those names is nominally illegal in PTX, but the
debug section names with a dot are accepted as a special case. The
downside of this change is that if someone ever has a `.debug*` symbol
that needs to be referred to from the debug info, that label will be
passed through as-is, and will still produce broken PTX output. If/when
we run into a case where we need it to work, we could consider only
passing through specific debug section names, or add a mechanism
allowing us to tell section names apart from regular symbols.

Fixes #58491
2024-10-22 13:01:40 -07:00

71 lines
2.3 KiB
C++

//===-- NVPTXAssignValidGlobalNames.cpp - Assign valid names to globals ---===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Clean up the names of global variables in the module to not contain symbols
// that are invalid in PTX.
//
// Currently NVPTX, like other backends, relies on generic symbol name
// sanitizing done by MC. However, the ptxas assembler is more stringent and
// disallows some additional characters in symbol names. This pass makes sure
// such names do not reach MC at all.
//
//===----------------------------------------------------------------------===//
#include "NVPTX.h"
#include "NVPTXUtilities.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/IR/Module.h"
using namespace llvm;
namespace {
/// NVPTXAssignValidGlobalNames
class NVPTXAssignValidGlobalNames : public ModulePass {
public:
static char ID;
NVPTXAssignValidGlobalNames() : ModulePass(ID) {}
bool runOnModule(Module &M) override;
};
} // namespace
char NVPTXAssignValidGlobalNames::ID = 0;
namespace llvm {
void initializeNVPTXAssignValidGlobalNamesPass(PassRegistry &);
}
INITIALIZE_PASS(NVPTXAssignValidGlobalNames, "nvptx-assign-valid-global-names",
"Assign valid PTX names to globals", false, false)
bool NVPTXAssignValidGlobalNames::runOnModule(Module &M) {
for (GlobalVariable &GV : M.globals()) {
// We are only allowed to rename local symbols.
if (GV.hasLocalLinkage()) {
// setName doesn't do extra work if the name does not change.
// Note: this does not create collisions - if setName is asked to set the
// name to something that already exists, it adds a proper postfix to
// avoid collisions.
GV.setName(NVPTX::getValidPTXIdentifier(GV.getName()));
}
}
// Do the same for local functions.
for (Function &F : M.functions())
if (F.hasLocalLinkage())
F.setName(NVPTX::getValidPTXIdentifier(F.getName()));
return true;
}
ModulePass *llvm::createNVPTXAssignValidGlobalNamesPass() {
return new NVPTXAssignValidGlobalNames();
}