Merge remote-tracking branch 'origin/main' into rebranch

Author: swift-ci

include/swift/AST/SemanticAttrs.def

@@ -75,6 +75,7 @@ SEMANTICS_ATTR(OPTIMIZE_SIL_SPECIALIZE_GENERIC_SIZE_NEVER,
 SEMANTICS_ATTR(OPTIMIZE_SIL_SPECIALIZE_OWNED2GUARANTEE_NEVER,
           "optimize.sil.specialize.owned2guarantee.never")
 
+SEMANTICS_ATTR(OSLOG_MESSAGE_TYPE, "oslog.message.type")
 SEMANTICS_ATTR(OSLOG_MESSAGE_INIT_INTERPOLATION, "oslog.message.init_interpolation")
 SEMANTICS_ATTR(OSLOG_MESSAGE_INIT_STRING_LITERAL, "oslog.message.init_stringliteral")
 SEMANTICS_ATTR(OSLOG_REQUIRES_CONSTANT_ARGUMENTS, "oslog.requires_constant_arguments")

include/swift/SILOptimizer/PassManager/Passes.def

@@ -308,6 +308,8 @@ PASS(Outliner, "outliner",
      "Function Outlining Optimization")
 PASS(OwnershipModelEliminator, "ownership-model-eliminator",
      "Eliminate Ownership Annotation of SIL")
+PASS(ModulePrinter, "module-printer",
+     "Print the module")
 PASS(NestedSemanticFunctionCheck, "nested-semantic-function-check",
      "Diagnose improperly nested '@_semantics' functions")
 PASS(NonTransparentFunctionOwnershipModelEliminator,

lib/SILOptimizer/Mandatory/OSLogOptimization.cpp

@@ -1510,8 +1510,8 @@ static ApplyInst *getAsOSLogMessageInit(SILInstruction *inst) {
 }
 
 /// Return true iff the SIL function \c fun is a method of the \c OSLogMessage
-/// type.
-bool isMethodOfOSLogMessage(SILFunction &fun) {
+/// type or a type that has the @_semantics("oslog.message.type") annotation.
+static bool isMethodOfOSLogMessage(SILFunction &fun) {
   DeclContext *declContext = fun.getDeclContext();
   if (!declContext)
     return false;
@@ -1527,7 +1527,8 @@ bool isMethodOfOSLogMessage(SILFunction &fun) {
   NominalTypeDecl *typeDecl = parentContext->getSelfNominalTypeDecl();
   if (!typeDecl)
     return false;
-  return typeDecl->getName() == fun.getASTContext().Id_OSLogMessage;
+  return typeDecl->getName() == fun.getASTContext().Id_OSLogMessage
+    || typeDecl->hasSemanticsAttr(semantics::OSLOG_MESSAGE_TYPE);
 }
 
 class OSLogOptimization : public SILFunctionTransform {

lib/SILOptimizer/PassManager/PassPipeline.cpp

@@ -43,10 +43,14 @@ static llvm::cl::opt<bool>
     SILViewCFG("sil-view-cfg", llvm::cl::init(false),
                llvm::cl::desc("Enable the sil cfg viewer pass"));
 
-static llvm::cl::opt<bool> SILViewGuaranteedCFG(
-    "sil-view-guaranteed-cfg", llvm::cl::init(false),
+static llvm::cl::opt<bool> SILViewCanonicalCFG(
+    "sil-view-canonical-cfg", llvm::cl::init(false),
     llvm::cl::desc("Enable the sil cfg viewer pass after diagnostics"));
 
+static llvm::cl::opt<bool> SILPrintCanonicalModule(
+    "sil-print-canonical-module", llvm::cl::init(false),
+    llvm::cl::desc("Print the textual SIL module after diagnostics"));
+
 static llvm::cl::opt<bool> SILViewSILGenCFG(
     "sil-view-silgen-cfg", llvm::cl::init(false),
     llvm::cl::desc("Enable the sil cfg viewer pass before diagnostics"));
@@ -64,6 +68,12 @@ static void addCFGPrinterPipeline(SILPassPipelinePlan &P, StringRef Name) {
   P.addCFGPrinter();
 }
 
+static void addModulePrinterPipeline(SILPassPipelinePlan &plan,
+                                     StringRef name) {
+  plan.startPipeline(name);
+  plan.addModulePrinter();
+}
+
 static void addMandatoryDebugSerialization(SILPassPipelinePlan &P) {
   P.startPipeline("Mandatory Debug Serialization");
   P.addOwnershipModelEliminator();
@@ -187,8 +197,11 @@ SILPassPipelinePlan::getDiagnosticPassPipeline(const SILOptions &Options) {
   // Otherwise run the rest of diagnostics.
   addMandatoryDiagnosticOptPipeline(P);
 
-  if (SILViewGuaranteedCFG) {
-    addCFGPrinterPipeline(P, "SIL View Guaranteed CFG");
+  if (SILViewCanonicalCFG) {
+    addCFGPrinterPipeline(P, "SIL View Canonical CFG");
+  }
+  if (SILPrintCanonicalModule) {
+    addModulePrinterPipeline(P, "SIL Print Canonical Module");
   }
   return P;
 }

lib/SILOptimizer/UtilityPasses/CMakeLists.txt

@@ -25,6 +25,7 @@ target_sources(swiftSILOptimizer PRIVATE
   LoopInfoPrinter.cpp
   LoopRegionPrinter.cpp
   MemBehaviorDumper.cpp
+  ModulePrinter.cpp
   RCIdentityDumper.cpp
   SerializeSILPass.cpp
   SILDebugInfoGenerator.cpp

lib/SILOptimizer/UtilityPasses/ModulePrinter.cpp

@@ -0,0 +1,38 @@
+//===--- ModulePrinter.cpp - Module printer pass --------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2021 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
+//
+//===----------------------------------------------------------------------===//
+//
+// A utility module pass to print the module as textual SIL.
+//
+//===----------------------------------------------------------------------===//
+
+#include "swift/SIL/SILPrintContext.h"
+#include "swift/SILOptimizer/PassManager/Passes.h"
+#include "swift/SILOptimizer/PassManager/Transforms.h"
+
+using namespace swift;
+
+namespace {
+
+class SILModulePrinter : public SILModuleTransform {
+
+  /// The entry point.
+  void run() override {
+    auto *module = getModule();
+    SILPrintContext context(llvm::outs(), /*Verbose*/ true, /*SortedSIL*/ true,
+                            /*PrintFullConvention*/ true);
+    module->print(context);
+  }
+};
+
+} // end anonymous namespace
+
+SILTransform *swift::createModulePrinter() { return new SILModulePrinter(); }

lib/Sema/ConstantnessSemaDiagnostics.cpp

@@ -284,7 +284,8 @@ static void diagnoseError(Expr *errorExpr, const ASTContext &astContext,
   }
   // If this is OSLogMessage, it should be a string-interpolation literal.
   Identifier declName = nominalDecl->getName();
-  if (declName == astContext.Id_OSLogMessage) {
+  if (declName == astContext.Id_OSLogMessage ||
+      nominalDecl->hasSemanticsAttr(semantics::OSLOG_MESSAGE_TYPE)) {
     diags.diagnose(errorLoc, diag::oslog_message_must_be_string_interpolation);
     return;
   }

stdlib/private/OSLog/OSLogTestHelper.swift

@@ -121,7 +121,7 @@ internal func _os_log_impl_test(
 /// on the special case of animation begin signposts.
 @_transparent
 public func _osSignpostAnimationBeginTestHelper(
-  _ format: AnimationFormatString.OSLogMessage,
+  _ format: AnimationFormatString.MyLogMessage,
   _ arguments: CVarArg...
 ) {
   _animationBeginSignpostHelper(formatStringPointer: format.formatStringPointer,
@@ -149,7 +149,8 @@ public enum AnimationFormatString {
   }
 
   @frozen
-  public struct OSLogMessage : ExpressibleByStringLiteral {
+  @_semantics("oslog.message.type")
+  public struct MyLogMessage : ExpressibleByStringLiteral {
     @usableFromInline
     var formatStringPointer: UnsafePointer<CChar>