Fix DRC slowdown due to UI yields

Fixes https://gitlab.com/kicad/code/kicad/-/issues/17434


(cherry picked from commit fd501b4bc8)
This commit is contained in:
Marek Roszko 2024-03-29 23:31:51 -04:00 committed by Mark Roszko
parent 857219d70d
commit b9a6f47929
2 changed files with 20 additions and 3 deletions

View File

@ -73,7 +73,8 @@ DIALOG_DRC::DIALOG_DRC( PCB_EDIT_FRAME* aEditorFrame, wxWindow* aParent ) :
m_markersTreeModel( nullptr ), m_markersTreeModel( nullptr ),
m_unconnectedTreeModel( nullptr ), m_unconnectedTreeModel( nullptr ),
m_fpWarningsTreeModel( nullptr ), m_fpWarningsTreeModel( nullptr ),
m_severities( RPT_SEVERITY_ERROR | RPT_SEVERITY_WARNING ) m_severities( RPT_SEVERITY_ERROR | RPT_SEVERITY_WARNING ),
m_lastUpdateUi( std::chrono::steady_clock::now() )
{ {
SetName( DIALOG_DRC_WINDOW_NAME ); // Set a window name to be able to find it SetName( DIALOG_DRC_WINDOW_NAME ); // Set a window name to be able to find it
@ -209,8 +210,20 @@ bool DIALOG_DRC::updateUI()
{ {
double cur = alg::clamp( 0.0, (double) m_progress.load() / m_maxProgress, 1.0 ); double cur = alg::clamp( 0.0, (double) m_progress.load() / m_maxProgress, 1.0 );
m_gauge->SetValue( KiROUND( cur * 1000.0 ) ); int newValue = KiROUND( cur * 1000.0 );
Pgm().App().SafeYieldFor( this, wxEVT_CATEGORY_NATIVE_EVENTS ); m_gauge->SetValue( newValue );
// There is significant overhead on at least Windows when updateUi is called constantly thousands of times
// in the drc process and safeyieldfor is called each time.
// Gate the yield to a limited rate which still allows the UI to function without slowing down the main thread
// which is also running DRC
std::chrono::steady_clock::time_point now = std::chrono::steady_clock::now();
if( std::chrono::duration_cast<std::chrono::milliseconds>( now - m_lastUpdateUi ).count()
> 100 )
{
Pgm().App().SafeYieldFor( this, wxEVT_CATEGORY_NATIVE_EVENTS );
m_lastUpdateUi = now;
}
return !m_cancelled; return !m_cancelled;
} }

View File

@ -27,6 +27,7 @@
#ifndef _DIALOG_DRC_H_ #ifndef _DIALOG_DRC_H_
#define _DIALOG_DRC_H_ #define _DIALOG_DRC_H_
#include <chrono>
#include <wx/htmllbox.h> #include <wx/htmllbox.h>
#include <rc_item.h> #include <rc_item.h>
#include <pcb_marker.h> #include <pcb_marker.h>
@ -127,6 +128,9 @@ private:
RC_TREE_MODEL* m_fpWarningsTreeModel; // wx reference-counted ptr RC_TREE_MODEL* m_fpWarningsTreeModel; // wx reference-counted ptr
int m_severities; // A mask of SEVERITY flags int m_severities; // A mask of SEVERITY flags
/// Used to slow down the rate of yields in updateUi()
std::chrono::steady_clock::time_point m_lastUpdateUi;
}; };
#endif // _DIALOG_DRC_H_ #endif // _DIALOG_DRC_H_