Reimplement CPU Affinity (#4110)

Author: FileEX

Client/core/CClientVariables.cpp

@@ -357,6 +357,7 @@ void CClientVariables::LoadDefaults()
     DEFAULT("discord_rpc_share_data", false);                                         // Consistent Rich Presence data sharing
     DEFAULT("discord_rpc_share_data_firsttime", false);                               // Display the user data sharing consent dialog box - for the first time
     DEFAULT("browser_enable_gpu", true);                                              // Enable GPU in CEF? (allows stuff like WebGL to function)
+    DEFAULT("process_cpu_affinity", false);                                            // Set CPU 0 affinity to improve game performance and fix the known issue in single-threaded games
 
     if (!Exists("locale"))
     {

Client/core/CCore.cpp

@@ -1795,6 +1795,17 @@ void CCore::ApplyCoreInitSettings()
 
         SetApplicationSettingInt("reset-settings-revision", 21486);
     }
+
+    // Set process settings
+    HANDLE currProc = GetCurrentProcess();
+
+    // Process priority
+    int PriorityClassList[] = {NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, HIGH_PRIORITY_CLASS};
+    SetPriorityClass(currProc, PriorityClassList[CVARS_GET_VALUE<int>("process_priority") % 3]);
+
+    // Process CPU affinity
+    if (CVARS_GET_VALUE<bool>("process_cpu_affinity"))
+        SetProcessAffinityMask(currProc, 1 << 0);
 }
 
 //

Client/core/CSettings.cpp

@@ -405,6 +405,12 @@ void CSettings::CreateGUI()
     m_pCheckBoxAllowDiscordRPC->GetPosition(vecTemp, false);
     m_pCheckBoxAllowDiscordRPC->AutoSize(NULL, 20.0f);
 
+    // Enable camera photos getting saved to documents folder
+    m_pPhotoSavingCheckbox = reinterpret_cast<CGUICheckBox*>(pManager->CreateCheckBox(pTabMultiplayer, _("Save photos taken by camera weapon to GTA San Andreas User Files folder"), true));
+    m_pPhotoSavingCheckbox->SetPosition(CVector2D(vecTemp.fX, vecTemp.fY + 20.0f));
+    m_pPhotoSavingCheckbox->GetPosition(vecTemp, false);
+    m_pPhotoSavingCheckbox->AutoSize(NULL, 20.0f);
+
     m_pCheckBoxCustomizedSAFiles = reinterpret_cast<CGUICheckBox*>(pManager->CreateCheckBox(pTabMultiplayer, _("Use customized GTA:SA files"), true));
     m_pCheckBoxCustomizedSAFiles->SetPosition(CVector2D(vecTemp.fX, vecTemp.fY + 20.0f));
     m_pCheckBoxCustomizedSAFiles->GetPosition(vecTemp, false);
@@ -1201,10 +1207,10 @@ void CSettings::CreateGUI()
     m_pCachePathValue->AutoSize();
     vecTemp.fY += fLineHeight;
 
-    // Enable camera photos getting saved to documents folder
-    m_pPhotoSavingCheckbox = reinterpret_cast<CGUICheckBox*>(pManager->CreateCheckBox(pTabAdvanced, _("Save photos taken by camera weapon to GTA San Andreas User Files folder"), true));
-    m_pPhotoSavingCheckbox->SetPosition(CVector2D(vecTemp.fX, vecTemp.fY));
-    m_pPhotoSavingCheckbox->AutoSize(NULL, 20.0f);
+    // Process affinity
+    m_pProcessAffinityCheckbox = reinterpret_cast<CGUICheckBox*>(pManager->CreateCheckBox(pTabAdvanced, _("Set CPU 0 affinity to improve game performance"), true));
+    m_pProcessAffinityCheckbox->SetPosition(CVector2D(vecTemp.fX, vecTemp.fY));
+    m_pProcessAffinityCheckbox->AutoSize(nullptr, 20.0f);
     vecTemp.fY += fLineHeight;
 
     // Auto updater section label
@@ -1306,6 +1312,7 @@ void CSettings::CreateGUI()
     m_pButtonBrowserWhitelistRemove->SetClickHandler(GUI_CALLBACK(&CSettings::OnBrowserWhitelistRemove, this));
     m_pEditBrowserWhitelistAdd->SetActivateHandler(GUI_CALLBACK(&CSettings::OnBrowserWhitelistDomainAddFocused, this));
     m_pEditBrowserWhitelistAdd->SetDeactivateHandler(GUI_CALLBACK(&CSettings::OnBrowserWhitelistDomainAddDefocused, this));
+    m_pProcessAffinityCheckbox->SetClickHandler(GUI_CALLBACK(&CSettings::OnAffinityClick, this));
 
     // Set up the events for advanced description
     m_pPriorityLabel->SetMouseEnterHandler(GUI_CALLBACK(&CSettings::OnShowAdvancedSettingDescription, this));
@@ -1374,6 +1381,9 @@ void CSettings::CreateGUI()
     m_pUpdateAutoInstallCombo->SetMouseEnterHandler(GUI_CALLBACK(&CSettings::OnShowAdvancedSettingDescription, this));
     m_pUpdateAutoInstallCombo->SetMouseLeaveHandler(GUI_CALLBACK(&CSettings::OnHideAdvancedSettingDescription, this));
 
+    m_pProcessAffinityCheckbox->SetMouseEnterHandler(GUI_CALLBACK(&CSettings::OnShowAdvancedSettingDescription, this));
+    m_pProcessAffinityCheckbox->SetMouseLeaveHandler(GUI_CALLBACK(&CSettings::OnHideAdvancedSettingDescription, this));
+
     // Load Chat presets
     LoadChatPresets();
 
@@ -3228,6 +3238,22 @@ void CSettings::LoadData()
     CVARS_GET("photosaving", bVar);
     m_pPhotoSavingCheckbox->SetSelected(bVar);
 
+    // Process CPU Affinity
+    CVARS_GET("process_cpu_affinity", bVar);
+    m_pProcessAffinityCheckbox->SetSelected(bVar);
+
+    DWORD_PTR affinityMask = 0;
+    if (bVar)
+        affinityMask = 1 << 0; // CPU 0 only
+    else
+    {
+        SYSTEM_INFO sysInfo;
+        GetSystemInfo(&sysInfo);
+
+        affinityMask = (1 << sysInfo.dwNumberOfProcessors) - 1; // All cores (default)
+    }
+    SetProcessAffinityMask(GetCurrentProcess(), affinityMask);
+
     // Update build type
     CVARS_GET("update_build_type", iVar);
     if (iVar == 0 || iVar == 1)
@@ -3624,6 +3650,22 @@ void CSettings::SaveData()
     CVARS_SET("photosaving", photoSaving);
     CScreenShot::SetPhotoSavingInsideDocuments(photoSaving);
 
+    // Process CPU Affinity
+    bool cpuAffinity = m_pProcessAffinityCheckbox->GetSelected();
+    CVARS_SET("process_cpu_affinity", cpuAffinity);
+
+    DWORD_PTR affinityMask = 0;
+    if (cpuAffinity)
+        affinityMask = 1 << 0;  // CPU 0 only
+    else
+    {
+        SYSTEM_INFO sysInfo;
+        GetSystemInfo(&sysInfo);
+
+        affinityMask = (1 << sysInfo.dwNumberOfProcessors) - 1; // All cores (default)
+    }
+    SetProcessAffinityMask(GetCurrentProcess(), affinityMask);
+
     // Debug setting
     if (CGUIListItem* pSelected = m_pDebugSettingCombo->GetSelectedItem())
     {
@@ -4711,6 +4753,44 @@ static void DPIAwareQuestionCallBack(void* userdata, unsigned int uiButton)
     }
 }
 
+static void CPUAffinityQuestionCallBack(void* userdata, unsigned int button)
+{
+    CCore::GetSingleton().GetLocalGUI()->GetMainMenu()->GetQuestionWindow()->Reset();
+
+    if (button == 0)
+    {
+        auto const checkBox = reinterpret_cast<CGUICheckBox*>(userdata);
+        checkBox->SetSelected(false);
+    }
+}
+
+bool CSettings::OnAffinityClick(CGUIElement* pElement)
+{
+    static bool shownWarning = false;
+
+    if (m_pProcessAffinityCheckbox->GetSelected() && !shownWarning)
+    {
+        shownWarning = true;
+
+        std::string message = std::string(
+            _("Enabling this setting may improve game performance, but on some processors, it may worsen it.\n"
+              "We have observed issues with AMD Ryzen processors featuring 3D V-Cache.\n"
+              "The exact list of affected processors is unknown.\n"
+              "\nAre you sure you  want to enable this option?"));
+
+        CQuestionBox* pQuestionBox = CCore::GetSingleton().GetLocalGUI()->GetMainMenu()->GetQuestionWindow();
+        pQuestionBox->Reset();
+        pQuestionBox->SetTitle(_("EXPERIMENTAL FEATURE"));
+        pQuestionBox->SetMessage(message);
+        pQuestionBox->SetButton(0, _("No"));
+        pQuestionBox->SetButton(1, _("Yes"));
+        pQuestionBox->SetCallback(CPUAffinityQuestionCallBack, m_pProcessAffinityCheckbox);
+        pQuestionBox->Show();
+    }
+
+    return true;
+}
+
 bool CSettings::OnBrowserBlacklistAdd(CGUIElement* pElement)
 {
     SString strDomain = m_pEditBrowserBlacklistAdd->GetText();
@@ -4874,6 +4954,8 @@ bool CSettings::OnShowAdvancedSettingDescription(CGUIElement* pElement)
         strText = std::string(_("16-bit color:")) + " " + std::string(_("Enable 16 bit color modes - Requires MTA restart"));
     else if (pCheckBox && pCheckBox == m_pWin8MouseCheckBox)
         strText = std::string(_("Mouse fix:")) + " " + std::string(_("Mouse movement fix - May need PC restart"));
+    else if (pCheckBox && pCheckBox == m_pProcessAffinityCheckbox)
+        strText = std::string(_("CPU affinity:")) + " " + std::string(_("Experimental feature - It may improve performance or worsen it."));
 
     if (strText != "")
         m_pAdvancedSettingDescriptionLabel->SetText(strText.c_str());

Client/core/CSettings.h

@@ -216,6 +216,7 @@ class CSettings
     CGUICheckBox*  m_pWin8ColorCheckBox;
     CGUICheckBox*  m_pWin8MouseCheckBox;
     CGUICheckBox*  m_pPhotoSavingCheckbox;
+    CGUICheckBox*  m_pProcessAffinityCheckbox;
     CGUILabel*     m_pUpdateBuildTypeLabel;
     CGUIComboBox*  m_pUpdateBuildTypeCombo;
     CGUILabel*     m_pUpdateAutoInstallLabel;
@@ -406,6 +407,7 @@ class CSettings
     bool OnShowAdvancedSettingDescription(CGUIElement* pElement);
     bool OnHideAdvancedSettingDescription(CGUIElement* pElement);
     bool OnTabChanged(CGUIElement* pElement);
+    bool OnAffinityClick(CGUIElement* pElement);
     void ReloadBrowserLists();
 
 private: