Changeset 295661 in webkit for trunk/Source/JavaScriptCore/tools

Timestamp:

Jun 18, 2022, 9:13:05 PM (3 years ago)

Author:

[email protected]

Message:

Change Integrity audit logging to use OS_LOG_TYPE_ERROR.
​https://bugs.webkit.org/show_bug.cgi?id=241742

Reviewed by Yusuke Suzuki.

On OS(DARWIN), Integrity audit code now uses an OSLogPrintStream to achieve this
logging with type OS_LOG_TYPE_ERROR. On other ports, we just route the logging
to WTF::dataFile() instead.

Also removed VA_ARGS support when !VA_OPT_SUPPORTED. This never worked in the first
place. Ports without VA_OPT_SUPPORTED will have to live with degraded logging.

Added WTFReportBacktraceWithPrefixAndPrintStream and WTFPrintBacktraceWithPrefixAndPrintStream
to support this new Integrity audit logging. Removed the old WTFPrintBacktraceWithPrefix
because it was never used by external clients. It was only used by as an internal support
function by other stack dumper functions.

• Source/JavaScriptCore/tools/Integrity.cpp:

(JSC::Integrity::logFile):
(JSC::Integrity::logF):
(JSC::Integrity::logLnF):
(JSC::Integrity::verifyCell):

• Source/JavaScriptCore/tools/Integrity.h:
• Source/WTF/wtf/Assertions.cpp:
• Source/WTF/wtf/Assertions.h:

Canonical link: ​https://commits.webkit.org/251666@main

Location:

trunk/Source/JavaScriptCore/tools

Files:

• Integrity.cpp (modified) (6 diffs)
• Integrity.h (modified) (6 diffs)

trunk/Source/JavaScriptCore/tools/Integrity.cpp

@@ -35 +35 @@
 #include "Options.h"
 #include "VMInspectorInlines.h"
+#include <wtf/DataLog.h>
+#include <wtf/OSLogPrintStream.h>
 
 namespace JSC {
@@ -41 +43 @@
 namespace IntegrityInternal {
 static constexpr bool verbose = false;
+}
+
+PrintStream& logFile()
+{
+#if OS(DARWIN)
+    static PrintStream* s_file;
+    static std::once_flag once;
+    std::call_once(once, [] {
+        // We want to use OS_LOG_TYPE_ERROR because we want to guarantee that the log makes it into
+        // the file system, and is not potentially stuck in some memory buffer. Integrity audit logs
+        // are used for debugging error states. So, this is an appropriate use of OS_LOG_TYPE_ERROR.
+        s_file = OSLogPrintStream::open("com.apple.JavaScriptCore", "Integrity", OS_LOG_TYPE_ERROR).release();
+    });
+    return *s_file;
+#else
+    return WTF::dataFile();
+#endif
+}
+
+void logF(const char* format, ...)
+{
+    va_list argList;
+    va_start(argList, format);
+    logFile().vprintf(format, argList);
+    va_end(argList);
+}
+
+void logLnF(const char* format, ...)
+{
+    va_list argList;
+    va_start(argList, format);
+    logFile().vprintf(format, argList);
+    va_end(argList);
+    logFile().println();
 }
 
@@ -141 +177 @@
 #define AUDIT_VERIFY(cond, format, ...) do { \
         IA_ASSERT_WITH_ACTION(cond, { \
-            WTFLogAlways("    cell %p", cell); \
+            Integrity::logLnF("    cell %p", cell); \
             if (action == Action::LogAndCrash) \
-                RELEASE_ASSERT((cond), ##__VA_ARGS__); \
+                RELEASE_ASSERT((cond)); \
             else \
                 return false; \
-        }, format, ##__VA_ARGS__); \
+        }); \
     } while (false)
 
@@ -153 +189 @@
 #define AUDIT_VERIFY(cond, format, ...) do { \
         IA_ASSERT_WITH_ACTION(cond, { \
-            WTFLogAlways("    cell %p", cell); \
+            Integrity::logLnF("    cell %p", cell); \
             if (action == Action::LogAndCrash) \
                 RELEASE_ASSERT((cond) __VA_OPT__(,) __VA_ARGS__); \
@@ -291 +327 @@
 {
     bool valid = Analyzer::analyzeCell(cell, Analyzer::Action::LogOnly);
-    WTFLogAlways("Cell %p is %s", cell, valid ? "VALID" : "INVALID");
+    Integrity::logLnF("Cell %p is %s", cell, valid ? "VALID" : "INVALID");
     return valid;
 }
@@ -298 +334 @@
 {
     bool valid = Analyzer::analyzeCell(vm, cell, Analyzer::Action::LogOnly);
-    WTFLogAlways("Cell %p is %s", cell, valid ? "VALID" : "INVALID");
+    Integrity::logLnF("Cell %p is %s", cell, valid ? "VALID" : "INVALID");
     return valid;
 }

trunk/Source/JavaScriptCore/tools/Integrity.h

@@ -49 +49 @@
 typedef struct OpaqueJSValue* JSObjectRef;
 
+namespace WTF {
+class PrintStream;
+}
+
 namespace JSC {
 
@@ -178 +182 @@
 
 #define IA_LOG(assertion, format, ...) do { \
-        WTFLogAlways("Integrity ERROR: %s @ %s:%d\n", #assertion, __FILE__, __LINE__); \
-        WTFLogAlways("    " format, ##__VA_ARGS__); \
+        Integrity::logLnF("ERROR: %s @ %s:%d", #assertion, __FILE__, __LINE__); \
     } while (false)
 
@@ -185 +188 @@
         if (UNLIKELY(!(assertion))) { \
             IA_LOG(assertion, __VA_ARGS__); \
-            WTFReportBacktraceWithPrefix("    "); \
+            WTFReportBacktraceWithPrefixAndPrintStream(Integrity::logFile(), "    "); \
             action; \
         } \
@@ -192 +195 @@
 #define IA_ASSERT(assertion, ...) \
     IA_ASSERT_WITH_ACTION(assertion, { \
-        RELEASE_ASSERT((assertion), ##__VA_ARGS__); \
-    }, ## __VA_ARGS__)
+        RELEASE_ASSERT((assertion)); \
+    })
 
 #else // not (COMPILER(MSVC) || !VA_OPT_SUPPORTED)
 
 #define IA_LOG(assertion, format, ...) do { \
-        WTFLogAlways("Integrity ERROR: %s @ %s:%d\n", #assertion, __FILE__, __LINE__); \
-        WTFLogAlways("    " format __VA_OPT__(,) __VA_ARGS__); \
+        Integrity::logLnF("ERROR: %s @ %s:%d", #assertion, __FILE__, __LINE__); \
+        Integrity::logLnF("    " format __VA_OPT__(,) __VA_ARGS__); \
     } while (false)
 
@@ -205 +208 @@
         if (UNLIKELY(!(assertion))) { \
             IA_LOG(assertion, __VA_ARGS__); \
-            WTFReportBacktraceWithPrefix("    "); \
+            WTFReportBacktraceWithPrefixAndPrintStream(Integrity::logFile(), "    "); \
             action; \
         } \
@@ -217 +220 @@
 #endif // COMPILER(MSVC) || !VA_OPT_SUPPORTED
 
+JS_EXPORT_PRIVATE WTF::PrintStream& logFile();
+JS_EXPORT_PRIVATE void logF(const char* format, ...) WTF_ATTRIBUTE_PRINTF(1, 2);
+JS_EXPORT_PRIVATE void logLnF(const char* format, ...) WTF_ATTRIBUTE_PRINTF(1, 2);
+
 } // namespace Integrity