[interop][SwiftToCxx] annotate inline thunks with SWIFT_INLINE_THUNK

This macro applies always_inline in addition to inline. It also applies artificial, which lets debugger know that this is an artificial function. The used attribute is added in debug builds to ensure that the symbol is emitted in the binary so that LLDB can invoke it.

Author: hyp

include/swift/PrintAsClang/ClangMacros.def

@@ -224,6 +224,17 @@ CLANG_MACRO_DEFINED("SWIFT_IMPORT_STDLIB_SYMBOL")
 
 CLANG_MACRO_CXX("SWIFT_NOEXCEPT", , "noexcept", )
 
+CLANG_MACRO_BODY("SWIFT_C_INLINE_THUNK", \
+    "# if __has_attribute(always_inline)\n" \
+    "# if __has_attribute(nodebug)\n" \
+    "#  define SWIFT_C_INLINE_THUNK inline __attribute__((always_inline)) __attribute__((nodebug))\n" \
+    "# else\n" \
+    "#  define SWIFT_C_INLINE_THUNK inline __attribute__((always_inline))\n" \
+    "# endif\n" \
+    "# else\n" \
+    "#  define SWIFT_C_INLINE_THUNK inline\n"\
+    "# endif")
+
 #undef CLANG_MACRO
 #undef CLANG_MACRO_BODY
 #undef CLANG_MACRO_DEFINED

lib/PrintAsClang/ClangSyntaxPrinter.cpp

@@ -194,9 +194,7 @@ void ClangSyntaxPrinter::printSwiftImplQualifier() const {
 }
 
 void ClangSyntaxPrinter::printInlineForThunk() const {
-  // FIXME: make a macro and add 'nodebug', and
-  // migrate all other 'inline' uses.
-  os << "inline __attribute__((always_inline)) ";
+  os << "SWIFT_INLINE_THUNK ";
 }
 
 void ClangSyntaxPrinter::printNullability(

lib/PrintAsClang/DeclAndTypePrinter.cpp

@@ -434,11 +434,15 @@ class DeclAndTypePrinter::Implementation
       ClangSyntaxPrinter(nameOS).printIdentifier(caseName);
       name[0] = std::toupper(name[0]);
 
-      os << "  inline bool is" << name << "() const;\n";
+      os << "  ";
+      ClangSyntaxPrinter(os).printInlineForThunk();
+      os << "bool is" << name << "() const;\n";
 
       outOfLineSyntaxPrinter
           .printNominalTypeOutsideMemberDeclTemplateSpecifiers(ED);
-      outOfLineOS << "  inline bool ";
+      outOfLineOS << "  ";
+      ClangSyntaxPrinter(outOfLineOS).printInlineForThunk();
+      outOfLineOS << " bool ";
       outOfLineSyntaxPrinter.printNominalTypeQualifier(
           ED, /*moduleContext=*/ED->getModuleContext());
       outOfLineOS << "is" << name << "() const {\n";
@@ -469,10 +473,14 @@ class DeclAndTypePrinter::Implementation
           /*NeedsReturnTypes=*/true,
           [&](auto &types) {
             // Printing function name and return type
-            os << "  inline " << types[paramType] << " get" << name;
+            os << "  ";
+            ClangSyntaxPrinter(os).printInlineForThunk();
+            os << types[paramType] << " get" << name;
             outOfLineSyntaxPrinter
                 .printNominalTypeOutsideMemberDeclTemplateSpecifiers(ED);
-            outOfLineOS << "  inline " << types[paramType] << ' ';
+            outOfLineOS << "  ";
+            ClangSyntaxPrinter(outOfLineOS).printInlineForThunk();
+            outOfLineOS << types[paramType] << ' ';
             outOfLineSyntaxPrinter.printNominalTypeQualifier(
                 ED, /*moduleContext=*/ED->getModuleContext());
             outOfLineOS << "get" << name;
@@ -550,7 +558,9 @@ class DeclAndTypePrinter::Implementation
                                elementInfo) {
       os << "  inline const static struct _impl_" << caseName << " {  "
          << "// impl struct for case " << caseName << '\n';
-      os << "    inline constexpr operator cases() const {\n";
+      os << "    ";
+      syntaxPrinter.printInlineForThunk();
+      os << "constexpr operator cases() const {\n";
       os << "      return cases::";
       syntaxPrinter.printIdentifier(caseName);
       os << ";\n";
@@ -579,14 +589,15 @@ class DeclAndTypePrinter::Implementation
             [&](auto &types) {
               const auto *ED = elementDecl->getParentEnum();
               // Printing function name and return type
-              os << "    inline ";
+              os << "    SWIFT_INLINE_THUNK "; // TODO
               syntaxPrinter.printNominalTypeReference(ED,
                                                       ED->getModuleContext());
               os << " operator()";
 
               outOfLineSyntaxPrinter
                   .printNominalTypeOutsideMemberDeclTemplateSpecifiers(ED);
-              outOfLineOS << "  inline ";
+              outOfLineOS << "  ";
+              outOfLineSyntaxPrinter.printInlineForThunk();
               outOfLineSyntaxPrinter.printNominalTypeReference(
                   ED, ED->getModuleContext());
               outOfLineOS << ' ';
@@ -794,7 +805,9 @@ class DeclAndTypePrinter::Implementation
       os << "#pragma clang diagnostic pop\n";
 
       // Printing operator cases()
-      os << "  inline operator cases() const {\n";
+      os << "  ";
+      ClangSyntaxPrinter(os).printInlineForThunk();
+      os << "operator cases() const {\n";
       if (ED->isResilient()) {
         if (!elementTagMapping.empty()) {
           os << "    auto tag = _getEnumTag();\n";

lib/PrintAsClang/PrintClangClassType.cpp

@@ -70,7 +70,8 @@ void ClangClassTypePrinter::printClassTypeDecl(
   os << "  using " << baseClassName << "::operator=;\n";
   bodyPrinter();
   os << "protected:\n";
-  os << "  inline ";
+  os << "  ";
+  printer.printInlineForThunk();
   printer.printBaseName(typeDecl);
   os << "(void * _Nonnull ptr) noexcept : " << baseClassName << "(ptr) {}\n";
   os << "private:\n";
@@ -86,7 +87,8 @@ void ClangClassTypePrinter::printClassTypeDecl(
         printCxxImplClassName(os, typeDecl);
         os << " {\n";
         os << "public:\n";
-        os << "static inline ";
+        os << "static ";
+        printer.printInlineForThunk();
         printer.printBaseName(typeDecl);
         os << " makeRetained(void * _Nonnull ptr) noexcept { return ";
         printer.printBaseName(typeDecl);

lib/PrintAsClang/PrintClangFunction.cpp

@@ -610,9 +610,10 @@ static void printDirectReturnOrParamCType(
     minimalStubName.consume_front(stubTypeName);
     if (isResultType) {
       // Emit a stub that returns a value directly from swiftcc function.
-      os << "static inline void swift_interop_returnDirect_" << minimalStubName;
+      os << "static SWIFT_C_INLINE_THUNK void swift_interop_returnDirect_"
+         << minimalStubName;
       os << "(char * _Nonnull result, struct " << stubName << " value";
-      os << ") __attribute__((always_inline)) {\n";
+      os << ") {\n";
       for (size_t i = 0; i < fields.size(); ++i) {
         os << "  memcpy(result + " << fields[i].first.getQuantity() << ", "
            << "&value._" << (i + 1) << ", "
@@ -621,9 +622,9 @@ static void printDirectReturnOrParamCType(
     } else {
       // Emit a stub that is used to pass value type directly to swiftcc
       // function.
-      os << "static inline struct " << stubName << " swift_interop_passDirect_"
-         << minimalStubName;
-      os << "(const char * _Nonnull value) __attribute__((always_inline)) {\n";
+      os << "static SWIFT_C_INLINE_THUNK struct " << stubName
+         << " swift_interop_passDirect_" << minimalStubName;
+      os << "(const char * _Nonnull value) {\n";
       os << "  struct " << stubName << " result;\n";
       for (size_t i = 0; i < fields.size(); ++i) {
         os << "  memcpy(&result._" << (i + 1) << ", value + "
@@ -710,7 +711,7 @@ ClangRepresentation DeclAndTypeClangFunctionPrinter::printFunctionSignature(
     os << "static ";
   }
   if (modifiers.isInline)
-    os << "inline ";
+    ClangSyntaxPrinter(os).printInlineForThunk();
 
   ClangRepresentation resultingRepresentation =
       ClangRepresentation::representable;

lib/PrintAsClang/PrintClangValueType.cpp

@@ -117,20 +117,21 @@ static void addCppExtensionsToStdlibType(const NominalTypeDecl *typeDecl,
                    "uint32_t _3;\n"
                    "#endif\n"
                    "};\n";
-    cPrologueOS << "static inline struct swift_interop_stub_Swift_String "
-                   "swift_interop_passDirect_Swift_String(const char * "
-                   "_Nonnull value) {\n"
-                   "struct swift_interop_stub_Swift_String result;\n"
-                   "#if UINTPTR_MAX == 0xFFFFFFFFFFFFFFFFu\n"
-                   "memcpy(&result._1, value, 8);\n"
-                   "memcpy(&result._2, value + 8, 8);\n"
-                   "#elif UINTPTR_MAX == 0xFFFFFFFF\n"
-                   "memcpy(&result._1, value, 4);\n"
-                   "memcpy(&result._2, value + 4, 4);\n"
-                   "memcpy(&result._3, value + 8, 4);\n"
-                   "#endif\n"
-                   "return result;\n"
-                   "}\n";
+    cPrologueOS
+        << "static SWIFT_INLINE_THUNK struct swift_interop_stub_Swift_String "
+           "swift_interop_passDirect_Swift_String(const char * "
+           "_Nonnull value) {\n"
+           "struct swift_interop_stub_Swift_String result;\n"
+           "#if UINTPTR_MAX == 0xFFFFFFFFFFFFFFFFu\n"
+           "memcpy(&result._1, value, 8);\n"
+           "memcpy(&result._2, value + 8, 8);\n"
+           "#elif UINTPTR_MAX == 0xFFFFFFFF\n"
+           "memcpy(&result._1, value, 4);\n"
+           "memcpy(&result._2, value + 4, 4);\n"
+           "memcpy(&result._3, value + 8, 4);\n"
+           "#endif\n"
+           "return result;\n"
+           "}\n";
     cPrologueOS << "SWIFT_EXTERN void *_Nonnull "
                    "$sSS10FoundationE19_bridgeToObjectiveCSo8NSStringCyF(swift_interop_stub_"
                    "Swift_String) SWIFT_NOEXCEPT SWIFT_CALL;\n";
@@ -272,15 +273,18 @@ void ClangValueTypePrinter::printValueTypeDecl(
         *genericSignature);
 
   // Print out the destructor.
-  os << "  inline ~";
+  os << "  ";
+  printer.printInlineForThunk();
+  os << '~';
   printer.printBaseName(typeDecl);
   os << "() {\n";
   ClangValueTypePrinter::printValueWitnessTableAccessAsVariable(
       os, typeMetadataFuncName, typeMetadataFuncGenericParams);
   os << "    vwTable->destroy(_getOpaquePointer(), metadata._0);\n";
   os << "  }\n";
 
-  os << "  inline ";
+  os << "  ";
+  printer.printInlineForThunk();
   printer.printBaseName(typeDecl);
   os << "(const ";
   printer.printBaseName(typeDecl);
@@ -298,7 +302,8 @@ void ClangValueTypePrinter::printValueTypeDecl(
   os << "  }\n";
 
   // FIXME: implement the move constructor.
-  os << "  [[noreturn]] inline ";
+  os << "  [[noreturn]] ";
+  printer.printInlineForThunk();
   printer.printBaseName(typeDecl);
   os << "(";
   printer.printBaseName(typeDecl);
@@ -311,7 +316,8 @@ void ClangValueTypePrinter::printValueTypeDecl(
   os << "private:\n";
 
   // Print out private default constructor.
-  os << "  inline ";
+  os << "  ";
+  printer.printInlineForThunk();
   printer.printBaseName(typeDecl);
   // FIXME: make noexcept.
   if (isOpaqueLayout) {
@@ -324,7 +330,8 @@ void ClangValueTypePrinter::printValueTypeDecl(
   }
   // Print out '_make' function which returns an unitialized instance for
   // passing to Swift.
-  os << "  static inline ";
+  os << "  static ";
+  printer.printInlineForThunk();
   printer.printBaseName(typeDecl);
   os << " _make() {";
   if (isOpaqueLayout) {
@@ -340,30 +347,40 @@ void ClangValueTypePrinter::printValueTypeDecl(
     os << "(); }\n";
   }
   // Print out the private accessors to the underlying Swift value storage.
-  os << "  inline const char * _Nonnull _getOpaquePointer() const { return "
+  os << "  ";
+  printer.printInlineForThunk();
+  os << "const char * _Nonnull _getOpaquePointer() const { return "
         "_storage";
   if (isOpaqueLayout)
     os << ".getOpaquePointer()";
   os << "; }\n";
-  os << "  inline char * _Nonnull _getOpaquePointer() { return _storage";
+  os << "  ";
+  printer.printInlineForThunk();
+  os << "char * _Nonnull _getOpaquePointer() { return _storage";
   if (isOpaqueLayout)
     os << ".getOpaquePointer()";
   os << "; }\n";
   os << "\n";
   // Print out helper function for enums
   if (isa<EnumDecl>(typeDecl)) {
-    os << "  inline char * _Nonnull _destructiveProjectEnumData() {\n";
+    os << "  ";
+    printer.printInlineForThunk();
+    os << "char * _Nonnull _destructiveProjectEnumData() {\n";
     printEnumVWTableVariable();
     os << "    enumVWTable->destructiveProjectEnumData(_getOpaquePointer(), "
           "metadata._0);\n";
     os << "    return _getOpaquePointer();\n";
     os << "  }\n";
-    os << "  inline void _destructiveInjectEnumTag(unsigned tag) {\n";
+    os << "  ";
+    printer.printInlineForThunk();
+    os << "void _destructiveInjectEnumTag(unsigned tag) {\n";
     printEnumVWTableVariable();
     os << "    enumVWTable->destructiveInjectEnumTag(_getOpaquePointer(), tag, "
           "metadata._0);\n";
     os << "  }\n";
-    os << "  inline unsigned _getEnumTag() const {\n";
+    os << "  ";
+    printer.printInlineForThunk();
+    os << "unsigned _getEnumTag() const {\n";
     printEnumVWTableVariable();
     os << "    return enumVWTable->getEnumTag(_getOpaquePointer(), "
           "metadata._0);\n";
@@ -399,18 +416,23 @@ void ClangValueTypePrinter::printValueTypeDecl(
           ClangSyntaxPrinter(os).printGenericSignatureInnerStaticAsserts(
               *genericSignature);
 
-        os << "  static inline char * _Nonnull getOpaquePointer(";
+        os << "  static ";
+        ClangSyntaxPrinter(os).printInlineForThunk();
+        os << "char * _Nonnull getOpaquePointer(";
         printCxxTypeName(os, typeDecl, moduleContext);
         printGenericParamRefs(os);
         os << " &object) { return object._getOpaquePointer(); }\n";
 
-        os << "  static inline const char * _Nonnull getOpaquePointer(const ";
+        os << "  static ";
+        ClangSyntaxPrinter(os).printInlineForThunk();
+        os << "const char * _Nonnull getOpaquePointer(const ";
         printCxxTypeName(os, typeDecl, moduleContext);
         printGenericParamRefs(os);
         os << " &object) { return object._getOpaquePointer(); }\n";
 
         os << "  template<class T>\n";
-        os << "  static inline ";
+        os << "  static ";
+        ClangSyntaxPrinter(os).printInlineForThunk();
         printCxxTypeName(os, typeDecl, moduleContext);
         printGenericParamRefs(os);
         os << " returnNewValue(T callable) {\n";
@@ -422,7 +444,9 @@ void ClangValueTypePrinter::printValueTypeDecl(
         os << "    return result;\n";
         os << "  }\n";
         // Print out helper function for initializeWithTake
-        os << "  static inline void initializeWithTake(char * _Nonnull "
+        os << "  static ";
+        ClangSyntaxPrinter(os).printInlineForThunk();
+        os << "void initializeWithTake(char * _Nonnull "
               "destStorage, char * _Nonnull srcStorage) {\n";
         ClangValueTypePrinter::printValueWitnessTableAccessAsVariable(
             os, typeMetadataFuncName, typeMetadataFuncGenericParams);
@@ -565,7 +589,9 @@ void ClangValueTypePrinter::printTypeGenericTraits(
                                       /*moduleContext=*/nullptr);
   }
   os << "> {\n";
-  os << "  static inline void * _Nonnull getTypeMetadata() {\n";
+  os << "  static ";
+  ClangSyntaxPrinter(os).printInlineForThunk();
+  os << "void * _Nonnull getTypeMetadata() {\n";
   os << "    return ";
   if (!typeDecl->hasClangNode()) {
     printer.printBaseName(typeDecl->getModuleContext());

lib/PrintAsClang/PrintSwiftToClangCoreScaffold.cpp

@@ -186,7 +186,9 @@ void printPrimitiveGenericTypeTraits(raw_ostream &os, ASTContext &astContext,
        << typeInfo.name << "> = true;\n\n";
 
     os << "template<>\nstruct TypeMetadataTrait<" << typeInfo.name << "> {\n"
-       << "  static inline void * _Nonnull getTypeMetadata() {\n"
+       << "  static ";
+    ClangSyntaxPrinter(os).printInlineForThunk();
+    os << "void * _Nonnull getTypeMetadata() {\n"
        << "    return &" << cxx_synthesis::getCxxImplNamespaceName()
        << "::" << typeMetadataVarName << ";\n"
        << "  }\n};\n\n";