Merge pull request #12691 from mitaclaw/jit-profiling-restoration

JitCache: Software Profiling Restoration

Source/Android/app/src/main/java/org/dolphinemu/dolphinemu/NativeLibrary.java

@@ -385,16 +385,9 @@ public static native void Run(String[] path, boolean riivolution, String savesta
   public static native boolean IsRunningAndUnpaused();
 
   /**
-   * Enables or disables CPU block profiling
-   *
-   * @param enable
-   */
-  public static native void SetProfiling(boolean enable);
-
-  /**
-   * Writes out the block profile results
+   * Writes out the JitBlock Cache log dump
    */
-  public static native void WriteProfileResults();
+  public static native void WriteJitBlockLogDump();
 
   /**
    * Native EGL functions not exposed by Java bindings
@@ -454,6 +447,14 @@ private static void CheckGameMetadataValid()
 
   private static native String GetCurrentTitleDescriptionUnchecked();
 
+  @Keep
+  public static void displayToastMsg(final String text, final boolean long_length)
+  {
+    final int length = long_length ? Toast.LENGTH_LONG : Toast.LENGTH_SHORT;
+    new Handler(Looper.getMainLooper())
+            .post(() -> Toast.makeText(DolphinApplication.getAppContext(), text, length).show());
+  }
+
   @Keep
   public static boolean displayAlertMsg(final String caption, final String text,
           final boolean yesNo, final boolean isWarning, final boolean nonBlocking)
@@ -466,9 +467,7 @@ public static boolean displayAlertMsg(final String caption, final String text,
     // and are allowed to block. As a fallback, we can use toasts.
     if (emulationActivity == null || nonBlocking)
     {
-      new Handler(Looper.getMainLooper()).post(
-              () -> Toast.makeText(DolphinApplication.getAppContext(), text, Toast.LENGTH_LONG)
-                      .show());
+      displayToastMsg(text, true);
     }
     else
     {

Source/Android/app/src/main/java/org/dolphinemu/dolphinemu/features/settings/model/BooleanSetting.kt

@@ -214,6 +214,12 @@ enum class BooleanSetting(
         "JitRegisterCacheOff",
         false
     ),
+    MAIN_DEBUG_JIT_ENABLE_PROFILING(
+        Settings.FILE_DOLPHIN,
+        Settings.SECTION_DEBUG,
+        "JitEnableProfiling",
+        false
+    ),
     MAIN_EMULATE_SKYLANDER_PORTAL(
         Settings.FILE_DOLPHIN,
         Settings.SECTION_EMULATED_USB_DEVICES,

Source/Android/app/src/main/java/org/dolphinemu/dolphinemu/features/settings/ui/SettingsFragmentPresenter.kt

@@ -1978,6 +1978,26 @@ class SettingsFragmentPresenter(
             )
         )
 
+        sl.add(HeaderSetting(context, R.string.debug_jit_profiling_header, 0))
+        sl.add(
+            SwitchSetting(
+                context,
+                BooleanSetting.MAIN_DEBUG_JIT_ENABLE_PROFILING,
+                R.string.debug_jit_enable_block_profiling,
+                0
+           )
+        )
+        sl.add(
+            RunRunnable(
+                context,
+                R.string.debug_jit_write_block_log_dump,
+                0,
+                0,
+                0,
+                true
+            ) { NativeLibrary.WriteJitBlockLogDump() }
+        )
+
         sl.add(HeaderSetting(context, R.string.debug_jit_header, 0))
         sl.add(
             SwitchSetting(

Source/Android/app/src/main/res/values/strings.xml

@@ -406,6 +406,9 @@
     <string name="debug_fastmem">Disable Fastmem</string>
     <string name="debug_fastmem_arena">Disable Fastmem Arena</string>
     <string name="debug_large_entry_points_map">Disable Large Entry Points Map</string>
+    <string name="debug_jit_profiling_header">Jit Profiling</string>
+    <string name="debug_jit_enable_block_profiling">Enable Jit Block Profiling</string>
+    <string name="debug_jit_write_block_log_dump">Write Jit Block Log Dump</string>
     <string name="debug_jit_header">Jit</string>
     <string name="debug_jitoff">Jit Disabled</string>
     <string name="debug_jitloadstoreoff">Jit Load Store Disabled</string>

Source/Android/jni/AndroidCommon/IDCache.cpp

@@ -12,6 +12,7 @@ static JavaVM* s_java_vm;
 static jclass s_string_class;
 
 static jclass s_native_library_class;
+static jmethodID s_display_toast_msg;
 static jmethodID s_display_alert_msg;
 static jmethodID s_update_touch_pointer;
 static jmethodID s_on_title_changed;
@@ -146,6 +147,11 @@ jclass GetNativeLibraryClass()
   return s_native_library_class;
 }
 
+jmethodID GetDisplayToastMsg()
+{
+  return s_display_toast_msg;
+}
+
 jmethodID GetDisplayAlertMsg()
 {
   return s_display_alert_msg;
@@ -528,6 +534,8 @@ JNIEXPORT jint JNI_OnLoad(JavaVM* vm, void* reserved)
 
   const jclass native_library_class = env->FindClass("org/dolphinemu/dolphinemu/NativeLibrary");
   s_native_library_class = reinterpret_cast<jclass>(env->NewGlobalRef(native_library_class));
+  s_display_toast_msg =
+      env->GetStaticMethodID(s_native_library_class, "displayToastMsg", "(Ljava/lang/String;Z)V");
   s_display_alert_msg = env->GetStaticMethodID(s_native_library_class, "displayAlertMsg",
                                                "(Ljava/lang/String;Ljava/lang/String;ZZZ)Z");
   s_update_touch_pointer =

Source/Android/jni/AndroidCommon/IDCache.h

@@ -12,6 +12,7 @@ JNIEnv* GetEnvForThread();
 jclass GetStringClass();
 
 jclass GetNativeLibraryClass();
+jmethodID GetDisplayToastMsg();
 jmethodID GetDisplayAlertMsg();
 jmethodID GetUpdateTouchPointer();
 jmethodID GetOnTitleChanged();

Source/Android/jni/MainAndroid.cpp

@@ -6,6 +6,7 @@
 #include <android/native_window_jni.h>
 #include <cstdio>
 #include <cstdlib>
+#include <fmt/format.h>
 #include <jni.h>
 #include <memory>
 #include <mutex>
@@ -22,6 +23,7 @@
 #include "Common/Event.h"
 #include "Common/FileUtil.h"
 #include "Common/Flag.h"
+#include "Common/IOFile.h"
 #include "Common/IniFile.h"
 #include "Common/Logging/LogManager.h"
 #include "Common/MsgHandler.h"
@@ -42,7 +44,6 @@
 #include "Core/Host.h"
 #include "Core/PowerPC/JitInterface.h"
 #include "Core/PowerPC/PowerPC.h"
-#include "Core/PowerPC/Profiler.h"
 #include "Core/State.h"
 #include "Core/System.h"
 
@@ -404,26 +405,34 @@ JNIEXPORT jint JNICALL Java_org_dolphinemu_dolphinemu_NativeLibrary_GetMaxLogLev
   return static_cast<jint>(Common::Log::MAX_LOGLEVEL);
 }
 
-JNIEXPORT void JNICALL Java_org_dolphinemu_dolphinemu_NativeLibrary_SetProfiling(JNIEnv*, jclass,
-                                                                                 jboolean enable)
+JNIEXPORT void JNICALL Java_org_dolphinemu_dolphinemu_NativeLibrary_WriteJitBlockLogDump(
+    JNIEnv* env, jclass native_library_class)
 {
   HostThreadLock guard;
   auto& system = Core::System::GetInstance();
   auto& jit_interface = system.GetJitInterface();
-  const Core::CPUThreadGuard cpu_guard(system);
-  jit_interface.ClearCache(cpu_guard);
-  jit_interface.SetProfilingState(enable ? JitInterface::ProfilingState::Enabled :
-                                           JitInterface::ProfilingState::Disabled);
-}
-
-JNIEXPORT void JNICALL Java_org_dolphinemu_dolphinemu_NativeLibrary_WriteProfileResults(JNIEnv*,
-                                                                                        jclass)
-{
-  HostThreadLock guard;
-  std::string filename = File::GetUserPath(D_DUMP_IDX) + "Debug/profiler.txt";
-  File::CreateFullPath(filename);
-  auto& jit_interface = Core::System::GetInstance().GetJitInterface();
-  jit_interface.WriteProfileResults(filename);
+  if (jit_interface.GetCore() == nullptr)
+  {
+    env->CallStaticVoidMethod(native_library_class, IDCache::GetDisplayToastMsg(),
+                              ToJString(env, Common::GetStringT("JIT is not active")),
+                              static_cast<jboolean>(false));
+    return;
+  }
+  const std::string filename = fmt::format("{}{}.txt", File::GetUserPath(D_DUMPDEBUG_JITBLOCKS_IDX),
+                                           SConfig::GetInstance().GetGameID());
+  File::IOFile f(filename, "w");
+  if (!f)
+  {
+    env->CallStaticVoidMethod(
+        native_library_class, IDCache::GetDisplayToastMsg(),
+        ToJString(env, Common::FmtFormatT("Failed to open \"{0}\" for writing.", filename)),
+        static_cast<jboolean>(false));
+    return;
+  }
+  jit_interface.JitBlockLogDump(Core::CPUThreadGuard{system}, f.GetHandle());
+  env->CallStaticVoidMethod(native_library_class, IDCache::GetDisplayToastMsg(),
+                            ToJString(env, Common::FmtFormatT("Wrote to \"{0}\".", filename)),
+                            static_cast<jboolean>(false));
 }
 
 // Surface Handling

Source/Core/Common/CMakeLists.txt

@@ -108,8 +108,6 @@ add_library(common
   Network.h
   PcapFile.cpp
   PcapFile.h
-  PerformanceCounter.cpp
-  PerformanceCounter.h
   Profiler.cpp
   Profiler.h
   QoSSession.cpp

Source/Core/Common/CommonPaths.h

@@ -77,6 +77,7 @@
 #define DUMP_SSL_DIR "SSL"
 #define DUMP_DEBUG_DIR "Debug"
 #define DUMP_DEBUG_BRANCHWATCH_DIR "BranchWatch"
+#define DUMP_DEBUG_JITBLOCKS_DIR "JitBlocks"
 #define LOGS_DIR "Logs"
 #define MAIL_LOGS_DIR "Mail"
 #define SHADERS_DIR "Shaders"

Source/Core/Common/FileUtil.cpp

@@ -859,6 +859,8 @@ static void RebuildUserDirectories(unsigned int dir_index)
     s_user_paths[D_DUMPDEBUG_IDX] = s_user_paths[D_DUMP_IDX] + DUMP_DEBUG_DIR DIR_SEP;
     s_user_paths[D_DUMPDEBUG_BRANCHWATCH_IDX] =
         s_user_paths[D_DUMPDEBUG_IDX] + DUMP_DEBUG_BRANCHWATCH_DIR DIR_SEP;
+    s_user_paths[D_DUMPDEBUG_JITBLOCKS_IDX] =
+        s_user_paths[D_DUMPDEBUG_IDX] + DUMP_DEBUG_JITBLOCKS_DIR DIR_SEP;
     s_user_paths[D_LOGS_IDX] = s_user_paths[D_USER_IDX] + LOGS_DIR DIR_SEP;
     s_user_paths[D_MAILLOGS_IDX] = s_user_paths[D_LOGS_IDX] + MAIL_LOGS_DIR DIR_SEP;
     s_user_paths[D_THEMES_IDX] = s_user_paths[D_USER_IDX] + THEMES_DIR DIR_SEP;
@@ -938,6 +940,8 @@ static void RebuildUserDirectories(unsigned int dir_index)
     s_user_paths[D_DUMPDEBUG_IDX] = s_user_paths[D_DUMP_IDX] + DUMP_DEBUG_DIR DIR_SEP;
     s_user_paths[D_DUMPDEBUG_BRANCHWATCH_IDX] =
         s_user_paths[D_DUMPDEBUG_IDX] + DUMP_DEBUG_BRANCHWATCH_DIR DIR_SEP;
+    s_user_paths[D_DUMPDEBUG_JITBLOCKS_IDX] =
+        s_user_paths[D_DUMPDEBUG_IDX] + DUMP_DEBUG_JITBLOCKS_DIR DIR_SEP;
     s_user_paths[F_MEM1DUMP_IDX] = s_user_paths[D_DUMP_IDX] + MEM1_DUMP;
     s_user_paths[F_MEM2DUMP_IDX] = s_user_paths[D_DUMP_IDX] + MEM2_DUMP;
     s_user_paths[F_ARAMDUMP_IDX] = s_user_paths[D_DUMP_IDX] + ARAM_DUMP;

Source/Core/Common/FileUtil.h

@@ -54,6 +54,7 @@ enum
   D_DUMPSSL_IDX,
   D_DUMPDEBUG_IDX,
   D_DUMPDEBUG_BRANCHWATCH_IDX,
+  D_DUMPDEBUG_JITBLOCKS_IDX,
   D_LOAD_IDX,
   D_LOGS_IDX,
   D_MAILLOGS_IDX,

Source/Core/Core/CMakeLists.txt

@@ -523,7 +523,6 @@ add_library(core
   PowerPC/PPCSymbolDB.h
   PowerPC/PPCTables.cpp
   PowerPC/PPCTables.h
-  PowerPC/Profiler.h
   PowerPC/SignatureDB/CSVSignatureDB.cpp
   PowerPC/SignatureDB/CSVSignatureDB.h
   PowerPC/SignatureDB/DSYSignatureDB.cpp

Source/Core/Core/Config/MainSettings.cpp

@@ -509,6 +509,8 @@ const Info<bool> MAIN_DEBUG_JIT_SYSTEM_REGISTERS_OFF{
 const Info<bool> MAIN_DEBUG_JIT_BRANCH_OFF{{System::Main, "Debug", "JitBranchOff"}, false};
 const Info<bool> MAIN_DEBUG_JIT_REGISTER_CACHE_OFF{{System::Main, "Debug", "JitRegisterCacheOff"},
                                                    false};
+const Info<bool> MAIN_DEBUG_JIT_ENABLE_PROFILING{{System::Main, "Debug", "JitEnableProfiling"},
+                                                 false};
 
 // Main.BluetoothPassthrough
 

Source/Core/Core/Config/MainSettings.h

@@ -335,6 +335,7 @@ extern const Info<bool> MAIN_DEBUG_JIT_PAIRED_OFF;
 extern const Info<bool> MAIN_DEBUG_JIT_SYSTEM_REGISTERS_OFF;
 extern const Info<bool> MAIN_DEBUG_JIT_BRANCH_OFF;
 extern const Info<bool> MAIN_DEBUG_JIT_REGISTER_CACHE_OFF;
+extern const Info<bool> MAIN_DEBUG_JIT_ENABLE_PROFILING;
 
 // Main.BluetoothPassthrough
 

Source/Core/Core/PowerPC/CachedInterpreter/CachedInterpreter.cpp

@@ -316,7 +316,7 @@ void CachedInterpreter::Jit(u32 address)
   js.numFloatingPointInst = 0;
   js.curBlock = b;
 
-  b->normalEntry = GetCodePtr();
+  b->normalEntry = b->near_begin = GetCodePtr();
 
   for (u32 i = 0; i < code_block.m_num_instructions; i++)
   {
@@ -382,6 +382,10 @@ void CachedInterpreter::Jit(u32 address)
   }
   m_code.emplace_back();
 
+  b->near_end = GetCodePtr();
+  b->far_begin = nullptr;
+  b->far_end = nullptr;
+
   b->codeSize = static_cast<u32>(GetCodePtr() - b->normalEntry);
   b->originalSize = code_block.m_num_instructions;
 

Source/Core/Core/PowerPC/Gekko.h

@@ -931,6 +931,7 @@ enum CPUEmuFeatureFlags : u32
   FEATURE_FLAG_MSR_DR = 1 << 0,
   FEATURE_FLAG_MSR_IR = 1 << 1,
   FEATURE_FLAG_PERFMON = 1 << 2,
+  FEATURE_FLAG_END_OF_ENUMERATION,
 };
 
 constexpr s32 SignExt16(s16 x)