Mangling.h

Go to the documentation of this file.

//===------ Mangling.h -- Name Mangling Utilities for ORC -------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Name mangling utilities for ORC.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_EXECUTIONENGINE_ORC_MANGLING_H
#define LLVM_EXECUTIONENGINE_ORC_MANGLING_H
 
#include "llvm/ExecutionEngine/Orc/Core.h"
#include "llvm/ExecutionEngine/Orc/Shared/Mangler.h"
#include "llvm/ExecutionEngine/Orc/ThreadSafeModule.h"
#include "llvm/IR/Module.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/TargetParser/Triple.h"
 
namespace llvm::orc {
 
/// Mangles symbol names then uniques them in the context of an
/// ExecutionSession.
class MangleAndInterner {
public:
  using ManglingMode = Mangler::Mode;
 
  MangleAndInterner(ExecutionSession &ES, Mangler M)
      : ES(ES), M(std::move(M)) {}
  MangleAndInterner(ExecutionSession &ES, ManglingMode Mode)
      : ES(ES), M(Mode) {}
  MangleAndInterner(ExecutionSession &ES, StringRef ABIName = "")
      : ES(ES), M(ES.getTargetTriple(), ABIName) {}
  MangleAndInterner(ExecutionSession &ES, const DataLayout &DL)
      : ES(ES), M(DL.getStringRepresentation()) {}
 
  const Mangler &mangler() const { return M; }
 
  SymbolStringPtr operator()(const SymbolNameSpec &NameSpec) {
    return M.withMangledNameDo(
        [this](StringRef MangledName) { return ES.intern(MangledName); },
        NameSpec);
  }
 
  SymbolStringPtr operator()(StringRef Name) {
    return (*this)(SymbolNameSpec(Name, SymbolNameKind::IR));
  }
 
private:
  ExecutionSession &ES;
  Mangler M;
};
 
/// Maps IR global values to their linker symbol names / flags.
///
/// This utility can be used when adding new IR globals in the JIT.
class IRSymbolMapper {
public:
  struct ManglingOptions {
    bool EmulatedTLS = false;
  };
 
  using SymbolNameToDefinitionMap = std::map<SymbolStringPtr, GlobalValue *>;
 
  /// Add mangled symbols for the given GlobalValues to SymbolFlags.
  /// If a SymbolToDefinitionMap pointer is supplied then it will be populated
  /// with Name-to-GlobalValue* mappings. Note that this mapping is not
  /// necessarily one-to-one: thread-local GlobalValues, for example, may
  /// produce more than one symbol, in which case the map will contain duplicate
  /// values.
  LLVM_ABI static void
  add(ExecutionSession &ES, const ManglingOptions &MO,
      ArrayRef<GlobalValue *> GVs, SymbolFlagsMap &SymbolFlags,
      SymbolNameToDefinitionMap *SymbolToDefinition = nullptr);
};
 
} // namespace llvm::orc
 
#endif // LLVM_EXECUTIONENGINE_ORC_MANGLING_H