pr feedback and unit test fixes

Author: carlpeto

stdlib/public/RuntimeModule/BacktraceJSONFormatter.swift

@@ -16,6 +16,7 @@
 
 import Swift
 
+@_spi(Formatting)
 public struct BacktraceJSONFormatterOptions: OptionSet {
   public let rawValue: Int
 
@@ -28,18 +29,21 @@ public struct BacktraceJSONFormatterOptions: OptionSet {
   public static let sanitize = BacktraceJSONFormatterOptions(rawValue: 1<<2)
   public static let mentionedImages = BacktraceJSONFormatterOptions(rawValue: 1<<3)
   public static let allThreads = BacktraceJSONFormatterOptions(rawValue: 1<<4)
+  public static let images = BacktraceJSONFormatterOptions(rawValue: 1<<5)
 }
 
-extension BacktraceJSONFormatterOptions {
+internal extension BacktraceJSONFormatterOptions {
   // this is not the form we want but will do for now
   // we are going to turn this into an OptionSet or similar
   var showAllRegisters: Bool { contains(.allRegisters) }
   var shouldDemangle: Bool { contains(.demangle) }
   var shouldSanitize: Bool { contains(.sanitize) }
   var showMentionedImages: Bool { contains(.mentionedImages) }
   var showAllThreads: Bool { contains(.allThreads) }
+  var showImages: Bool { contains(.images) }
 }
 
+@_spi(Formatting)
 public protocol BacktraceJSONWriter {
   func write(_ string: String, flush: Bool)
   func writeln(_ string: String, flush: Bool)
@@ -73,7 +77,7 @@ Writer: BacktraceJSONWriter> {
   }
 }
 
-extension BacktraceJSONFormatter {
+internal extension BacktraceJSONFormatter {
   func write(_ string: String, flush: Bool) {
     writer.write(string, flush: flush)
   }
@@ -96,26 +100,16 @@ extension BacktraceJSONFormatter {
   func getFaultAddress() -> String? {
     crashLog.faultAddress
   }
+}
 
-  // settings for the output format
-  func getShouldShowAllThreads() -> Bool {
-    options.showAllThreads
-  }
-
-  func getShouldShowAllRegisters() -> Bool {
-    options.showAllRegisters
-  }
-
-  func getShouldDemangle() -> Bool {
-    options.shouldDemangle
-  }
-
-  func getShouldSanitize() -> Bool {
-    options.shouldDemangle
-  }
-
-  func getShowMentionedImages() -> Bool {
-    options.showMentionedImages
+@_spi(Formatting)
+public extension BacktraceJSONFormatter {
+  mutating func writeCrashLog(now: String) {
+    writePreamble(now: now)
+    writeThreads()
+    writeCapturedMemory()
+    writeImages()
+    writeFooter()
   }
 }
 
@@ -145,9 +139,8 @@ public extension BacktraceJSONFormatter {
   mutating func writeThreads() {
 
     write(#", "threads": [ "#, flush: false)
-    let showAllThreads = getShouldShowAllThreads()
 
-    let threads = crashLog.threads.filter { showAllThreads || $0.crashed }
+    let threads = crashLog.threads.filter { options.showAllThreads || $0.crashed }
 
     var first = true
     for thread in threads {
@@ -162,12 +155,17 @@ public extension BacktraceJSONFormatter {
 
     write(" ]", flush: false)
 
-    if !showAllThreads && crashLog.threads.count > 1 {
+    if !options.showAllThreads && crashLog.threads.count > 1 {
       write(", \"omittedThreads\": \(crashLog.threads.count - 1)", flush: false)
     }
 
-    if let images = crashLog.images, getShowMentionedImages() {
+    // if omittedImages is nil, try to calculate it.
+    if let images = crashLog.images,
+      options.showMentionedImages,
+      self.crashLog.omittedImages == nil {
+
       self.crashLog.omittedImages = images.count - mentionedImages.count
+
     }
   }
 
@@ -176,7 +174,7 @@ public extension BacktraceJSONFormatter {
     if !options.shouldSanitize, let capturedMemory = crashLog.capturedMemory {
       write(#", "capturedMemory": {"#, flush: false)
       var first = true
-      for (address, bytes) in capturedMemory {
+      for (address, bytes) in capturedMemory.sorted(by: <) {
         if first {
           first = false
         } else {
@@ -190,10 +188,10 @@ public extension BacktraceJSONFormatter {
 
   // note: this updates the crash log with the ommitted image count
   func writeImages() {
-    if let images = crashLog.images {
+    if options.showImages, let images = crashLog.images {
       var imagesToWrite = images
 
-      if getShowMentionedImages() {
+      if options.showMentionedImages {
         let mentioned =
           images.enumerated()
             .filter { mentionedImages.contains($0.0) }
@@ -220,11 +218,11 @@ public extension BacktraceJSONFormatter {
   func writeFooter() {
     write(", \"backtraceTime\": \(crashLog.backtraceTime) ", flush: false)
 
-    writeln("}", flush: false)
+    write("}", flush: false)
   }
 }
 
-extension BacktraceJSONFormatter {
+internal extension BacktraceJSONFormatter {
   func writeThreadRegisters(thread: Log.Thread) {
     guard let registers = thread.registers else { return }
 
@@ -264,7 +262,7 @@ extension BacktraceJSONFormatter {
         write(#""crashed": true, "#, flush: false)
       }
 
-      if getShouldShowAllRegisters() || isCrashingThread {
+      if options.showAllRegisters || isCrashingThread {
         write(#""registers": {"#, flush: false)
         writeThreadRegisters(thread: thread)
         write(" }, ", flush: false)
@@ -302,7 +300,7 @@ extension BacktraceJSONFormatter {
                   , "offset": \(frame.offset ?? 0)
                   """, flush: false)
 
-          if getShouldDemangle() {
+          if options.shouldDemangle, let demangledName = frame.demangledName {
             let formattedOffset: String
             if (frame.offset ?? 0) > 0 {
               formattedOffset = " + \(frame.offset!)"
@@ -313,7 +311,7 @@ extension BacktraceJSONFormatter {
             }
 
             write("""
-                    , "description": \"\(escapeJSON(symbol))\(formattedOffset)\"
+                    , "description": \"\(escapeJSON(demangledName))\(formattedOffset)\"
                     """, flush: false)
           }
 
@@ -322,7 +320,7 @@ extension BacktraceJSONFormatter {
           }
 
           if var sourceLocation = frame.sourceLocation {
-            if getShouldSanitize() {
+            if options.shouldSanitize {
               sourceLocation.file = sanitizePath(sourceLocation.file)
             }
             write(#", "sourceLocation": { "#, flush: false)
@@ -343,7 +341,7 @@ extension BacktraceJSONFormatter {
 
       write("}", flush: false)
 
-      if getShowMentionedImages() {
+      if options.showMentionedImages {
         for frame in thread.frames {
           if let imageName = frame.image,
             let imageIndex = crashLog.images?

stdlib/public/RuntimeModule/Context.swift

@@ -985,7 +985,7 @@ extension arm_gprs {
   #endif
 }
 
-extension ARM64Context {
+@_spi(Contexts) extension ARM64Context {
     public static var registerDumpOrder: [String] {
         get {
             let r = (Register.x0 ..< Register.x29).map { "\($0)" }
@@ -994,7 +994,7 @@ extension ARM64Context {
     }
 }
 
-extension ARMContext {
+@_spi(Contexts) extension ARMContext {
     public static var registerDumpOrder: [String] {
         get {
             let r = (Register.r0 ... Register.r10).map { "\($0)" }
@@ -1003,7 +1003,7 @@ extension ARMContext {
     }
 }
 
-extension I386Context {
+@_spi(Contexts) extension I386Context {
     public static var registerDumpOrder: [String] {
         get {
             let r = (Register.eax ... Register.edi).map { "\($0)" }
@@ -1012,7 +1012,7 @@ extension I386Context {
     }
 }
 
-extension X86_64Context {
+@_spi(Contexts) extension X86_64Context {
     public static var registerDumpOrder: [String] {
         get {
             let r = (Register.rax ... Register.r15).map { "\($0)" }