swift-mirror/lib/Basic/Mangler.cpp

//===--- Mangler.cpp - Base class for Swift name mangling -----------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#include "swift/Basic/Mangler.h"
#include "swift/Basic/Assertions.h"
#include "swift/Basic/PrettyStackTrace.h"
#include "swift/Demangling/Demangler.h"
#include "swift/Demangling/ManglingMacros.h"
#include "swift/Demangling/Punycode.h"
#include "swift/Parse/Lexer.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/Support/CommandLine.h"
#include <algorithm>

using namespace swift;
using namespace Mangle;

#ifndef NDEBUG

llvm::cl::opt<bool> PrintSwiftManglingStats(
    "print-swift-mangling-stats", llvm::cl::init(false),
    llvm::cl::desc("Print statistics about Swift symbol mangling"));

namespace {

static int mergedSubsts = 0;
static int numLargeSubsts = 0;

struct OpStatEntry {
  OpStatEntry() : num(0), size(0) { }
  
  int num;
  int size;
};

static llvm::StringMap<OpStatEntry> OpStats;

} // end anonymous namespace

void Mangler::recordOpStatImpl(StringRef op, size_t OldPos) {
  if (PrintSwiftManglingStats) {
    OpStatEntry &E = OpStats[op];
    ++E.num;
    E.size += Storage.size() - OldPos;
  }
}

#endif // NDEBUG

void Mangle::printManglingStats() {
#ifndef NDEBUG
  if (!PrintSwiftManglingStats)
    return;

  llvm::outs() << "Mangling operator stats:\n";

  using MapEntry = llvm::StringMapEntry<OpStatEntry>;
  std::vector<const MapEntry *> SortedOpStats;
  for (const MapEntry &ME : OpStats) {
    SortedOpStats.push_back(&ME);
  }
  std::sort(SortedOpStats.begin(), SortedOpStats.end(),
    [](const MapEntry *LHS, const MapEntry *RHS) {
      return LHS->getKey() < RHS->getKey();
    });

  for (const MapEntry *E : SortedOpStats) {
    llvm::outs() << "  " << E->getKey() << ": num = " << E->getValue().num
                 << ", size = " << E->getValue().size << '\n';
  }
  llvm::outs() << "  merged substitutions: " << mergedSubsts << "\n"
                  "  large substitutions: " << numLargeSubsts << "\n";
#endif
}

void Mangler::beginManglingWithoutPrefix() {
  Storage.clear();
  Substitutions.clear();
  StringSubstitutions.clear();
  NextSubstitutionIndex = 0;
  Words.clear();
  SubstMerging.clear();
}

void Mangler::beginMangling() {
  beginManglingWithoutPrefix();

  switch (Flavor) {
  case ManglingFlavor::Default:
    Buffer << MANGLING_PREFIX_STR;
    break;
  case ManglingFlavor::Embedded:
    Buffer << MANGLING_PREFIX_EMBEDDED_STR;
    break;
  }
}

/// Finish the mangling of the symbol and return the mangled name.
std::string Mangler::finalize() {
  assert(Storage.size() && "Mangling an empty name");
  std::string result = Storage.str().str();
  Storage.clear();

#ifndef NDEBUG
  switch (Flavor) {
  case ManglingFlavor::Default:
    if (StringRef(result).starts_with(MANGLING_PREFIX_STR))
      verify(result, Flavor);
    break;
  case ManglingFlavor::Embedded:
    if (StringRef(result).starts_with(MANGLING_PREFIX_EMBEDDED_STR))
      verify(result, Flavor);
    break;
  }
#endif

  return result;
}

/// Finish the mangling of the symbol and write the mangled name into
/// \p stream.
void Mangler::finalize(llvm::raw_ostream &stream) {
  std::string result = finalize();
  stream.write(result.data(), result.size());
}

LLVM_ATTRIBUTE_UNUSED
static bool treeContains(Demangle::NodePointer Nd, Demangle::Node::Kind Kind) {
  if (Nd->getKind() == Kind)
    return true;

  for (auto Child : *Nd) {
    if (treeContains(Child, Kind))
      return true;
  }
  return false;
}

void Mangler::verify(StringRef nameStr, ManglingFlavor Flavor) {
  SmallString<128> buffer;
  if (!nameStr.starts_with(MANGLING_PREFIX_STR) &&
      !nameStr.starts_with(MANGLING_PREFIX_EMBEDDED_STR) &&
      !nameStr.starts_with("_Tt") &&
      !nameStr.starts_with("_S")) {
    // This list is the set of prefixes recognized by Demangler::demangleSymbol.
    // It should be kept in sync.
    assert(StringRef(MANGLING_PREFIX_STR) != "_S" && "redundant check");

    switch (Flavor) {
    case ManglingFlavor::Default:
      buffer += MANGLING_PREFIX_STR;
      break;
    case ManglingFlavor::Embedded:
      buffer += MANGLING_PREFIX_EMBEDDED_STR;
      break;
    }

    buffer += nameStr;
    nameStr = buffer.str();
  }

  Demangler Dem;
  NodePointer Root = Dem.demangleSymbol(nameStr);
  if (!Root || treeContains(Root, Node::Kind::Suffix)) {
    ABORT([&](auto &out) {
      out << "Can't demangle: " << nameStr;
    });
  }
  auto mangling = mangleNode(Root, Flavor);
  if (!mangling.isSuccess()) {
    ABORT([&](auto &out) {
      out << "Can't remangle: " << nameStr;
    });
  }
  std::string Remangled = mangling.result();
  if (Remangled == nameStr)
    return;

  ABORT([&](auto &out) {
    out << "Remangling failed:\n";
    out << "original     = " << nameStr << "\n";
    out << "remangled    = " << Remangled;
  });
}

void Mangler::appendIdentifier(StringRef ident, bool allowRawIdentifiers) {
  auto Iter = StringSubstitutions.find(ident);
  if (Iter != StringSubstitutions.end())
    return mangleSubstitution(Iter->second);

  size_t OldPos = Storage.size();
  addSubstitution(ident);

  if (allowRawIdentifiers && Lexer::identifierMustAlwaysBeEscaped(ident)) {
    llvm::SmallString<256> escaped;
    appendRawIdentifierForRuntime(ident, escaped);
    mangleIdentifier(*this, escaped);
  } else {
    mangleIdentifier(*this, ident);
  }

  recordOpStat("<identifier>", OldPos);
}

void Mangler::appendRawIdentifierForRuntime(
    StringRef ident, llvm::SmallVectorImpl<char> &buffer) {
  // SE-0451: Raw identifiers retain their backticks as part of their
  // mangling. Additionally, the runtime has historically used spaces
  // (U+0020) as delimiters in some metadata (e.g., tuple element labels
  // and protocol associated type names). If one of these names is a raw
  // identifier, it may also contain U+0020. To address this in a
  // backwards-compatible fashion, we replace any occurrences of U+0020 in
  // the name with U+00A0 (UTF-8: 0xC2 0xA0), since U+00A0 is not permitted
  // in raw identifiers.
  buffer.push_back('`');
  for (auto ch : ident) {
    if (ch == ' ') {
      buffer.push_back(0xc2);
      buffer.push_back(0xa0);
    } else {
      buffer.push_back(ch);
    }
  }
  buffer.push_back('`');
}

void Mangler::dump() const {
  // FIXME: const_casting because llvm::raw_svector_ostream::str() is
  // incorrectly not marked const.
  llvm::errs() << const_cast<Mangler*>(this)->Buffer.str() << '\n';
}

bool Mangler::tryMangleSubstitution(const void *ptr) {
  auto ir = Substitutions.find(ptr);
  if (ir == Substitutions.end())
    return false;

  mangleSubstitution(ir->second);
  return true;
}

void Mangler::mangleSubstitution(unsigned Idx) {
  if (Idx >= 26) {
#ifndef NDEBUG
    ++numLargeSubsts;
#endif
    return appendOperator("A", Index(Idx - 26));
  }

  char SubstChar = Idx + 'A';
  StringRef Subst(&SubstChar, 1);
  if (SubstMerging.tryMergeSubst(*this, Subst, /*isStandardSubst*/ false)) {
#ifndef NDEBUG
    ++mergedSubsts;
#endif
  } else {
    appendOperator("A", Subst);
  }
}