//===--- IRGenMangler.h - mangling of IRGen symbols -------------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_IRGEN_IRGENMANGLER_H
#define SWIFT_IRGEN_IRGENMANGLER_H

#include "IRGenModule.h"
#include "swift/AST/ASTMangler.h"
#include "swift/AST/AutoDiff.h"
#include "swift/AST/ProtocolAssociations.h"
#include "swift/IRGen/ValueWitness.h"
#include "llvm/Support/SaveAndRestore.h"

namespace swift {

class ProtocolConformance;
class NormalProtocolConformance;

namespace irgen {

enum class MangledTypeRefRole;

/// A mangling string that includes embedded symbolic references.
struct SymbolicMangling {
  std::string String;
  std::vector<std::pair<Mangle::ASTMangler::SymbolicReferent, unsigned>>
    SymbolicReferences;
  
  unsigned runtimeSizeInBytes() const {
    return String.size();
  }
};

/// The mangler for all kind of symbols produced in IRGen.
class IRGenMangler : public Mangle::ASTMangler {
public:
  IRGenMangler() { }

  std::string mangleDispatchThunk(const FuncDecl *func) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(func));
    beginMangling();
    appendEntity(func);
    appendOperator("Tj");
    return finalize();
  }

  std::string mangleDerivativeDispatchThunk(
      const AbstractFunctionDecl *func,
      AutoDiffDerivativeFunctionIdentifier *derivativeId) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(func));
    beginManglingWithAutoDiffOriginalFunction(func);
    auto kind = Demangle::getAutoDiffFunctionKind(derivativeId->getKind());
    auto *resultIndices =
      autodiff::getFunctionSemanticResultIndices(func,
                                                 derivativeId->getParameterIndices());
    AutoDiffConfig config(
        derivativeId->getParameterIndices(),
        resultIndices,
        derivativeId->getDerivativeGenericSignature());
    appendAutoDiffFunctionParts("TJ", kind, config);
    appendOperator("Tj");
    return finalize();
  }

  std::string mangleConstructorDispatchThunk(const ConstructorDecl *ctor,
                                             bool isAllocating) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(ctor));
    beginMangling();
    appendConstructorEntity(ctor, isAllocating);
    appendOperator("Tj");
    return finalize();
  }

  std::string mangleMethodDescriptor(const FuncDecl *func) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(func));
    beginMangling();
    appendEntity(func);
    appendOperator("Tq");
    return finalize();
  }

  std::string mangleDerivativeMethodDescriptor(
      const AbstractFunctionDecl *func,
      AutoDiffDerivativeFunctionIdentifier *derivativeId) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(func));
    beginManglingWithAutoDiffOriginalFunction(func);
    auto kind = Demangle::getAutoDiffFunctionKind(derivativeId->getKind());
    auto *resultIndices =
      autodiff::getFunctionSemanticResultIndices(func,
                                                 derivativeId->getParameterIndices());
    AutoDiffConfig config(
        derivativeId->getParameterIndices(),
        resultIndices,
        derivativeId->getDerivativeGenericSignature());
    appendAutoDiffFunctionParts("TJ", kind, config);
    appendOperator("Tq");
    return finalize();
  }

  std::string mangleConstructorMethodDescriptor(const ConstructorDecl *ctor,
                                                bool isAllocating) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(ctor));
    beginMangling();
    appendConstructorEntity(ctor, isAllocating);
    appendOperator("Tq");
    return finalize();
  }

  std::string mangleMethodLookupFunction(const ClassDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Mu");
  }

  std::string mangleValueWitness(Type type, ValueWitness witness);

  std::string mangleValueWitnessTable(Type type) {
    const char * const witnessTableOp = "WV";
    if (type->isAnyObject()) {
      // Special-case for AnyObject, whose witness table is under the old name
      // Builtin.UnknownObject, even though we don't use that as a Type anymore.
      beginMangling();
      appendOperator("BO");
      appendOperator(witnessTableOp);
      return finalize();
    }
    return mangleTypeSymbol(type, witnessTableOp);
  }

  std::string mangleTypeMetadataAccessFunction(Type type) {
    return mangleTypeSymbol(type, "Ma");
  }

  std::string
  mangleCanonicalSpecializedGenericTypeMetadataAccessFunction(Type type) {
    return mangleTypeSymbol(type, "Mb");
  }

  std::string mangleTypeMetadataLazyCacheVariable(Type type) {
    return mangleTypeSymbol(type, "ML");
  }

  std::string mangleTypeMetadataDemanglingCacheVariable(Type type) {
    return mangleTypeSymbol(type, "MD");
  }

  std::string mangleTypeFullMetadataFull(Type type) {
    return mangleTypeSymbol(type, "Mf");
  }

  std::string mangleTypeMetadataFull(Type type) {
    return mangleTypeSymbol(type, "N");
  }

  std::string mangleNoncanonicalTypeMetadata(Type type) {
    return mangleTypeSymbol(type, "MN");
  }

  std::string mangleCanonicalPrespecializedGenericTypeCachingOnceToken(
      const NominalTypeDecl *decl) {
    return mangleNominalTypeSymbol(decl, "Mz");
  }

  std::string mangleNoncanonicalSpecializedGenericTypeMetadataCache(Type type) {
    return mangleTypeSymbol(type, "MJ");
  }

  std::string mangleTypeMetadataPattern(const NominalTypeDecl *decl) {
    return mangleNominalTypeSymbol(decl, "MP");
  }

  std::string mangleClassMetaClass(const ClassDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Mm");
  }

  std::string mangleSpecializedGenericClassMetaClass(const CanType theType) {
    return mangleTypeSymbol(theType, "MM");
  }

  std::string mangleObjCMetadataUpdateFunction(const ClassDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "MU");
  }

  std::string mangleObjCResilientClassStub(const ClassDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Ms");
  }

  std::string mangleFullObjCResilientClassStub(const ClassDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Mt");
  }

  std::string mangleClassMetadataBaseOffset(const ClassDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Mo");
  }

  std::string mangleNominalTypeDescriptor(const NominalTypeDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Mn");
  }

  std::string mangleNominalTypeDescriptorRecord(const NominalTypeDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Hn");
  }
  
  std::string mangleOpaqueTypeDescriptorAccessor(const OpaqueTypeDecl *decl) {
    beginMangling();
    appendOpaqueDeclName(decl);
    appendOperator("Mg");
    return finalize();
  }

  std::string
  mangleOpaqueTypeDescriptorAccessorImpl(const OpaqueTypeDecl *decl) {
    beginMangling();
    appendOpaqueDeclName(decl);
    appendOperator("Mh");
    return finalize();
  }

  std::string
  mangleOpaqueTypeDescriptorAccessorKey(const OpaqueTypeDecl *decl) {
    beginMangling();
    appendOpaqueDeclName(decl);
    appendOperator("Mj");
    return finalize();
  }

  std::string
  mangleOpaqueTypeDescriptorAccessorVar(const OpaqueTypeDecl *decl) {
    beginMangling();
    appendOpaqueDeclName(decl);
    appendOperator("Mk");
    return finalize();
  }

  std::string mangleTypeMetadataInstantiationCache(const NominalTypeDecl *Decl){
    return mangleNominalTypeSymbol(Decl, "MI");
  }

  std::string mangleTypeMetadataInstantiationFunction(
                                                  const NominalTypeDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Mi");
  }

  std::string mangleTypeMetadataSingletonInitializationCache(
                                                  const NominalTypeDecl *Decl) {
    return mangleNominalTypeSymbol(Decl, "Ml");
  }

  std::string mangleTypeMetadataCompletionFunction(const NominalTypeDecl *Decl){
    return mangleNominalTypeSymbol(Decl, "Mr");
  }
  
  std::string mangleModuleDescriptor(const ModuleDecl *Decl) {
    beginMangling();
    BaseEntitySignature base(Decl);
    appendContext(Decl, base, Decl->getAlternateModuleName());
    appendOperator("MXM");
    return finalize();
  }
  
  std::string mangleExtensionDescriptor(const ExtensionDecl *Decl) {
    beginMangling();
    BaseEntitySignature base(Decl);
    appendContext(Decl, base, Decl->getAlternateModuleName());
    appendOperator("MXE");
    return finalize();
  }
  
  void appendAnonymousDescriptorName(PointerUnion<DeclContext*, VarDecl*> Name){
    if (auto DC = Name.dyn_cast<DeclContext *>()) {
      BaseEntitySignature nullBase(nullptr);
      return appendContext(DC, nullBase, StringRef());
    }
    if (auto VD = Name.dyn_cast<VarDecl *>()) {
      return appendEntity(VD);
    }
    llvm_unreachable("unknown kind");
  }
  
  std::string mangleAnonymousDescriptorName(
                                    PointerUnion<DeclContext*, VarDecl*> Name) {
    beginMangling();
    appendAnonymousDescriptorName(Name);
    return finalize();
  }
  
  std::string mangleAnonymousDescriptor(
                                    PointerUnion<DeclContext*, VarDecl*> Name) {
    beginMangling();
    appendAnonymousDescriptorName(Name);
    appendOperator("MXX");
    return finalize();
  }

  std::string mangleBareProtocol(const ProtocolDecl *Decl) {
    beginMangling();
    appendAnyGenericType(Decl);
    return finalize();
  }

  std::string mangleProtocolDescriptor(const ProtocolDecl *Decl) {
    beginMangling();
    appendProtocolName(Decl);
    appendOperator("Mp");
    return finalize();
  }

  std::string mangleProtocolDescriptorRecord(const ProtocolDecl *Decl) {
    beginMangling();
    appendProtocolName(Decl);
    appendOperator("Hr");
    return finalize();
  }

  std::string mangleProtocolRequirementsBaseDescriptor(
                                                    const ProtocolDecl *Decl) {
    beginMangling();
    appendProtocolName(Decl);
    appendOperator("TL");
    return finalize();
  }

  std::string mangleAssociatedTypeDescriptor(
                                         const AssociatedTypeDecl *assocType) {
    // Don't optimize away the protocol name, because we need it to distinguish
    // among the type descriptors of different protocols.
    llvm::SaveAndRestore<bool> optimizeProtocolNames(OptimizeProtocolNames,
                                                     false);

    beginMangling();
    bool isAssocTypeAtDepth = false;
    (void)appendAssocType(
        assocType->getDeclaredInterfaceType()->castTo<DependentMemberType>(),
        nullptr,
        isAssocTypeAtDepth);
    appendOperator("Tl");
    return finalize();
  }

  std::string mangleAssociatedConformanceDescriptor(
      const ProtocolDecl *proto,
      CanType subject,
      const ProtocolDecl *requirement) {
    beginMangling();
    appendAnyGenericType(proto);
    if (isa<GenericTypeParamType>(subject)) {
      appendType(subject, nullptr);
    } else {
      bool isFirstAssociatedTypeIdentifier = true;
      appendAssociatedTypePath(subject, isFirstAssociatedTypeIdentifier);
    }
    appendProtocolName(requirement);
    appendOperator("Tn");
    return finalize();
  }

  std::string mangleBaseConformanceDescriptor(
      const ProtocolDecl *proto,
      const ProtocolDecl *requirement) {
    beginMangling();
    appendAnyGenericType(proto);
    appendProtocolName(requirement);
    appendOperator("Tb");
    return finalize();
  }

  std::string mangleDefaultAssociatedConformanceAccessor(
      const ProtocolDecl *proto,
      CanType subject,
      const ProtocolDecl *requirement) {
    beginMangling();
    appendAnyGenericType(proto);
    bool isFirstAssociatedTypeIdentifier = true;
    appendAssociatedTypePath(subject, isFirstAssociatedTypeIdentifier);
    appendProtocolName(requirement);
    appendOperator("TN");
    return finalize();
  }

  std::string mangleProtocolConformanceDescriptor(
                                    const RootProtocolConformance *conformance);
  std::string mangleProtocolConformanceDescriptorRecord(
                                    const RootProtocolConformance *conformance);
  std::string mangleProtocolConformanceInstantiationCache(
                                    const RootProtocolConformance *conformance);

  std::string manglePropertyDescriptor(const AbstractStorageDecl *storage) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(storage));
    beginMangling();
    appendEntity(storage);
    appendOperator("MV");
    return finalize();
  }

  std::string mangleFieldOffset(const ValueDecl *Decl) {
    llvm::SaveAndRestore X(AllowInverses, inversesAllowed(Decl));
    beginMangling();
    appendEntity(Decl);
    appendOperator("Wvd");
    return finalize();
  }

  std::string mangleEnumCase(const ValueDecl *Decl) {
    beginMangling();
    appendEntity(Decl);
    appendOperator("WC");
    return finalize();
  }

  std::string mangleProtocolWitnessTablePattern(const ProtocolConformance *C) {
    return mangleConformanceSymbol(Type(), C, "Wp");
  }

  std::string mangleGenericProtocolWitnessTableInstantiationFunction(
                                                const ProtocolConformance *C) {
    return mangleConformanceSymbol(Type(), C, "WI");
  }

  std::string mangleProtocolWitnessTableLazyAccessFunction(Type type,
                                                const ProtocolConformance *C) {
    return mangleConformanceSymbol(type, C, "Wl");
  }

  std::string mangleProtocolWitnessTableLazyCacheVariable(Type type,
                                                const ProtocolConformance *C) {
    return mangleConformanceSymbol(type, C, "WL");
  }

  std::string
  mangleAssociatedTypeAccessFunctionDiscriminator(AssociatedType association) {
    beginMangling();
    appendAnyGenericType(association.getSourceProtocol());
    appendIdentifier(association.getAssociation()->getNameStr());
    return finalize();
  }

  std::string mangleAssociatedTypeWitnessTableAccessFunctionDiscriminator(
                                           const AssociatedConformance &conf) {
    beginMangling();
    appendAnyGenericType(conf.getSourceProtocol());
    bool isFirstAssociatedTypeIdentifier = true;
    appendAssociatedTypePath(conf.getAssociation(),
                             isFirstAssociatedTypeIdentifier);
    appendAnyGenericType(conf.getAssociatedRequirement());
    return finalize();
  }

  std::string mangleAssociatedTypeWitnessTableAccessFunction(
                                      const ProtocolConformance *Conformance,
                                      CanType AssociatedType,
                                      const ProtocolDecl *Proto) {
    beginMangling();
    appendProtocolConformance(Conformance);

    bool isFirstAssociatedTypeIdentifier = true;
    appendAssociatedTypePath(AssociatedType, isFirstAssociatedTypeIdentifier);
    appendAnyGenericType(Proto);
    appendOperator("WT");
    return finalize();
  }

  std::string mangleBaseWitnessTableAccessFunction(
                                      const ProtocolConformance *Conformance,
                                      const ProtocolDecl *BaseProto) {
    beginMangling();
    appendProtocolConformance(Conformance);
    appendAnyGenericType(BaseProto);
    appendOperator("Wb");
    return finalize();
  }

  void appendAssociatedTypePath(CanType associatedType, bool &isFirst) {
    if (auto memberType = dyn_cast<DependentMemberType>(associatedType)) {
      appendAssociatedTypePath(memberType.getBase(), isFirst);
      appendAssociatedTypeName(memberType, nullptr);
      appendListSeparator(isFirst);
    } else {
      assert(isa<GenericTypeParamType>(associatedType));
    }
  }

  void appendExtendedExistentialTypeShape(CanGenericSignature genSig,
                                          CanType shapeType);
  void appendExtendedExistentialTypeShapeSymbol(CanGenericSignature genSig,
                                                CanType shapeType,
                                                bool isUnique);

  /// Mangle the symbol name for an extended existential type shape.
  std::string mangleExtendedExistentialTypeShapeSymbol(
                                                CanGenericSignature genSig,
                                                CanType shapeType,
                                                bool isUnique);

  std::string mangleCoroutineContinuationPrototype(CanSILFunctionType type) {
    return mangleTypeSymbol(type, "TC");
  }

  std::string mangleReflectionBuiltinDescriptor(Type type) {
    const char * const reflectionDescriptorOp = "MB";
    if (type->isAnyObject()) {
      // Special-case for AnyObject, whose reflection descriptor is under the
      // old name Builtin.UnknownObject, even though we don't use that as a Type
      // anymore.
      beginMangling();
      appendOperator("BO");
      appendOperator(reflectionDescriptorOp);
      return finalize();
    }
    return mangleTypeSymbol(type, reflectionDescriptorOp);
  }

  std::string mangleReflectionFieldDescriptor(Type type) {
    return mangleTypeSymbol(type, "MF");
  }

  std::string mangleReflectionAssociatedTypeDescriptor(
                                                 const ProtocolConformance *C) {
    return mangleConformanceSymbol(Type(), C, "MA");
  }

  std::string mangleOutlinedCopyFunction(CanType ty,
                                         CanGenericSignature sig) {
    beginMangling();
    appendType(ty, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator("WOy");
    return finalize();
  }
  std::string mangleOutlinedConsumeFunction(CanType ty,
                                            CanGenericSignature sig) {
    beginMangling();
    appendType(ty, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator("WOe");
    return finalize();
  }

  std::string mangleOutlinedRetainFunction(CanType t,
                                           CanGenericSignature sig) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator("WOr");
    return finalize();
  }
  std::string mangleOutlinedReleaseFunction(CanType t,
                                            CanGenericSignature sig) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator("WOs");
    return finalize();
  }

  std::string mangleOutlinedInitializeWithTakeFunction(CanType t,
                                                       CanGenericSignature sig,
                                                       bool noValueWitness) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator(noValueWitness ? "WOB" : "WOb");
    return finalize();
  }
  std::string mangleOutlinedInitializeWithCopyFunction(CanType t,
                                                       CanGenericSignature sig,
                                                       bool noValueWitness) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator(noValueWitness ? "WOC" : "WOc");
    return finalize();
  }
  std::string mangleOutlinedAssignWithTakeFunction(CanType t,
                                                   CanGenericSignature sig,
                                                   bool noValueWitness) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator(noValueWitness ? "WOD" : "WOd");
    return finalize();
  }
  std::string mangleOutlinedAssignWithCopyFunction(CanType t,
                                                   CanGenericSignature sig,
                                                   bool noValueWitness) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator(noValueWitness ? "WOF" : "WOf");
    return finalize();
  }
  std::string mangleOutlinedDestroyFunction(CanType t,
                                            CanGenericSignature sig,
                                            bool noValueWitness) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator(noValueWitness ? "WOH" : "WOh");
    return finalize();
  }

  std::string mangleOutlinedEnumTagStoreFunction(CanType t,
                                                 CanGenericSignature sig,
                                                 unsigned enumCaseNum) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperatorParam("WOi", Index(enumCaseNum));
    return finalize();
  }

  std::string mangleOutlinedEnumProjectDataForLoadFunction(CanType t,
                                                 CanGenericSignature sig,
                                                 unsigned enumCaseNum) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperatorParam("WOj", Index(enumCaseNum));
    return finalize();
  }

  std::string mangleOutlinedEnumGetTag(CanType t, CanGenericSignature sig) {
    beginMangling();
    appendType(t, sig);
    if (sig)
      appendGenericSignature(sig);
    appendOperator("WOg");
    return finalize();

  }

  std::string manglePartialApplyForwarder(StringRef FuncName);
  
  std::string mangleTypeForForeignMetadataUniquing(Type type) {
    return mangleTypeWithoutPrefix(type);
  }

  void configureForSymbolicMangling() {
    OptimizeProtocolNames = false;
    UseObjCRuntimeNames = true;
  }

  SymbolicMangling mangleTypeForFlatUniqueTypeRef(CanGenericSignature sig,
                                                  CanType ty);

  SymbolicMangling mangleTypeForReflection(IRGenModule &IGM,
                                           CanGenericSignature genericSig,
                                           CanType Ty);

  std::string mangleTypeForLLVMTypeName(CanType Ty);

  std::string mangleProtocolForLLVMTypeName(ProtocolCompositionType *type);

  std::string mangleSymbolNameForSymbolicMangling(
                                              const SymbolicMangling &mangling,
                                              MangledTypeRefRole role);

  std::string mangleSymbolNameForAssociatedConformanceWitness(
                                  const NormalProtocolConformance *conformance,
                                  CanType associatedType,
                                  const ProtocolDecl *proto);

  std::string mangleSymbolNameForMangledMetadataAccessorString(
                                           const char *kind,
                                           CanGenericSignature genericSig,
                                           CanType type);

  std::string mangleSymbolNameForMangledConformanceAccessorString(
                                           const char *kind,
                                           CanGenericSignature genericSig,
                                           CanType type,
                                           ProtocolConformanceRef conformance);

  std::string mangleSymbolNameForMangledGetEnumTagForLayoutString(CanType type);

  std::string
  mangleSymbolNameForUnderlyingTypeAccessorString(OpaqueTypeDecl *opaque,
                                                  unsigned index);

  std::string mangleSymbolNameForUnderlyingWitnessTableAccessorString(
      OpaqueTypeDecl *opaque, const Requirement &req, ProtocolDecl *protocol);

  std::string mangleSymbolNameForGenericEnvironment(
                                                CanGenericSignature genericSig);

protected:
  SymbolicMangling
  withSymbolicReferences(IRGenModule &IGM,
                         llvm::function_ref<void ()> body);

  std::string mangleTypeSymbol(Type type, const char *Op) {
    beginMangling();
    appendType(type, nullptr);
    appendOperator(Op);
    return finalize();
  }

  std::string mangleNominalTypeSymbol(const NominalTypeDecl *Decl,
                                      const char *Op) {
    beginMangling();
    appendAnyGenericType(Decl);
    appendOperator(Op);
    return finalize();
  }

  std::string mangleConformanceSymbol(Type type,
                                      const ProtocolConformance *Conformance,
                                      const char *Op);
};

/// Determines if the minimum deployment target's runtime demangler will not
/// understand the mangled name for the given type.
/// \returns true iff the target's runtime does not understand the mangled name.
bool mangledNameIsUnknownToDeployTarget(IRGenModule &IGM, CanType type);

} // end namespace irgen
} // end namespace swift

#endif