drc_engine.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <memory>
#include <mutex>
#include <shared_mutex>
#include <vector>
#include <unordered_map>
 
#include <kiid.h>
#include <layer_ids.h>
#include <units_provider.h>
#include <lset.h>
#include <drc/drc_rule.h>
 

struct DRC_OWN_CLEARANCE_CACHE_KEY
{
    KIID         m_uuid;
    PCB_LAYER_ID m_layer;
 
    bool operator==( const DRC_OWN_CLEARANCE_CACHE_KEY& aOther ) const
    {
        return m_uuid == aOther.m_uuid && m_layer == aOther.m_layer;
    }
};
 
 
namespace std
{
    template <>
    struct hash<DRC_OWN_CLEARANCE_CACHE_KEY>
    {
        std::size_t operator()( const DRC_OWN_CLEARANCE_CACHE_KEY& aKey ) const
        {
            std::size_t seed = 0xa82de1c0;
            seed ^= std::hash<KIID>{}( aKey.m_uuid ) + 0x9e3779b9 + ( seed << 6 ) + ( seed >> 2 );
            seed ^= std::hash<int>{}( static_cast<int>( aKey.m_layer ) ) + 0x9e3779b9
                    + ( seed << 6 ) + ( seed >> 2 );
            return seed;
        }
    };
}
 
 
class BOARD_COMMIT;
class BOARD_DESIGN_SETTINGS;
class DRC_TEST_PROVIDER;
class DRC_TEST_PROVIDER_CREEPAGE;
class PCB_EDIT_FRAME;
class DS_PROXY_VIEW_ITEM;
class BOARD_ITEM;
class BOARD;
class PCB_MARKER;
class NETCLASS;
class NETLIST;
class NETINFO_ITEM;
class ZONE;
class PROGRESS_REPORTER;
class REPORTER;
class wxFileName;
 
namespace KIGFX
{
    class VIEW_OVERLAY;
};
 
void drcPrintDebugMessage( int level, const wxString& msg, const char *function, int line );
 
#define drc_dbg(level, fmt, ...) \
    drcPrintDebugMessage( level, wxString::Format( fmt, __VA_ARGS__ ), __FUNCTION__, __LINE__ );
 
class DRC_RULE_CONDITION;
class DRC_ITEM;
class DRC_RULE;
class DRC_CONSTRAINT;
 
 
typedef std::function<void( const std::shared_ptr<DRC_ITEM>& aItem,
                            const VECTOR2I& aPos, int aLayer,
                            const std::function<void( PCB_MARKER* )>& aPathGenerator )> DRC_VIOLATION_HANDLER;
 

struct DRC_CLEARANCE_BATCH
{
    int clearance = 0;
    int holeClearance = 0;
    int holeToHole = 0;
    int edgeClearance = 0;
    int physicalClearance = 0;
};
 

class DRC_ENGINE : public UNITS_PROVIDER
{
    // They need to change / restore the violation handler
    friend class DRC_TEST_PROVIDER_CREEPAGE;
 
public:
    DRC_ENGINE( BOARD* aBoard = nullptr, BOARD_DESIGN_SETTINGS* aSettings = nullptr );
    virtual ~DRC_ENGINE();
 
    // We own several lists of raw pointers.  Don't let the compiler fill in copy c'tors that
    // will only land us in trouble.
    DRC_ENGINE( const DRC_ENGINE& ) = delete;
    DRC_ENGINE& operator=( const DRC_ENGINE& ) = delete;
 
    void SetBoard( BOARD* aBoard ) { m_board = aBoard; }
    BOARD* GetBoard() const { return m_board; }
 
    void SetDesignSettings( BOARD_DESIGN_SETTINGS* aSettings ) { m_designSettings = aSettings; }
    BOARD_DESIGN_SETTINGS* GetDesignSettings() const { return m_designSettings; }
 
    void SetSchematicNetlist( NETLIST* aNetlist ) { m_schematicNetlist = aNetlist; }
    NETLIST* GetSchematicNetlist() const { return m_schematicNetlist; }
 
    void SetDrawingSheet( DS_PROXY_VIEW_ITEM* aDrawingSheet ) { m_drawingSheet = aDrawingSheet; }
    DS_PROXY_VIEW_ITEM* GetDrawingSheet() const { return m_drawingSheet; }
 
    void SetDebugOverlay( std::shared_ptr<KIGFX::VIEW_OVERLAY> aOverlay )
    {
        m_debugOverlay = aOverlay;
    }
 
    std::shared_ptr<KIGFX::VIEW_OVERLAY> GetDebugOverlay() const { return m_debugOverlay; }

    void SetViolationHandler( DRC_VIOLATION_HANDLER aHandler )
    {
        m_violationHandler = std::move( aHandler );
    }
 
    void ClearViolationHandler()
    {
        m_violationHandler = DRC_VIOLATION_HANDLER();
    }

    void SetProgressReporter( PROGRESS_REPORTER* aProgRep ) { m_progressReporter = aProgRep; }
    PROGRESS_REPORTER* GetProgressReporter() const { return m_progressReporter; }
 
    /*
     * Set an optional reporter for rule parse/compile/run-time errors and log-level progress
     * information.
     *
     * Note: if no log reporter is installed rule parse/compile/run-time errors are returned
     * via a thrown PARSE_ERROR exception.
     */
    void SetLogReporter( REPORTER* aReporter ) { m_logReporter = aReporter; }

    void InitEngine( const wxFileName& aRulePath );
 
    void InitEngine( const std::shared_ptr<DRC_RULE>& rule );

    void RunTests( EDA_UNITS aUnits, bool aReportAllTrackErrors, bool aTestFootprints,
                   BOARD_COMMIT* aCommit = nullptr );
 
    bool IsErrorLimitExceeded( int error_code );
 
    DRC_CONSTRAINT EvalRules( DRC_CONSTRAINT_T aConstraintType, const BOARD_ITEM* a,
                              const BOARD_ITEM* b, PCB_LAYER_ID aLayer,
                              REPORTER* aReporter = nullptr );
 
    DRC_CONSTRAINT EvalZoneConnection( const BOARD_ITEM* a, const BOARD_ITEM* b,
                                       PCB_LAYER_ID aLayer, REPORTER* aReporter = nullptr );

    DRC_CLEARANCE_BATCH EvalClearanceBatch( const BOARD_ITEM* a, const BOARD_ITEM* b,
                                            PCB_LAYER_ID aLayer );

    int GetCachedOwnClearance( const BOARD_ITEM* aItem, PCB_LAYER_ID aLayer,
                               wxString* aSource = nullptr );

    void InvalidateClearanceCache( const KIID& aUuid );

    void ClearClearanceCache();

    void InitializeClearanceCache();
 
    void ProcessAssertions( const BOARD_ITEM* a,
                            std::function<void( const DRC_CONSTRAINT* )> aFailureHandler,
                            REPORTER* aReporter = nullptr );
 
    bool HasRulesForConstraintType( DRC_CONSTRAINT_T constraintID );
 
    bool HasGeometryDependentRules() const { return m_hasGeometryDependentRules; }
 
    bool GetReportAllTrackErrors() const { return m_reportAllTrackErrors; }
    bool GetTestFootprints() const { return m_testFootprints; }
 
    bool RulesValid() { return m_rulesValid; }
 
    void ReportViolation( const std::shared_ptr<DRC_ITEM>& aItem, const VECTOR2I& aPos,
                          int aMarkerLayer, const std::function<void( PCB_MARKER* )>& aPathGenerator = {} );
 
    bool KeepRefreshing( bool aWait = false );
    void AdvanceProgress();
    void SetMaxProgress( int aSize );
    bool ReportProgress( double aProgress );
    bool ReportPhase( const wxString& aMessage );
    bool IsCancelled() const;
 
    REPORTER* GetLogReporter() const { return m_logReporter; }
 
    bool QueryWorstConstraint( DRC_CONSTRAINT_T aRuleId, DRC_CONSTRAINT& aConstraint, bool aUnconditionalOnly = false );
    bool HasUserDefinedPhysicalConstraint();
    std::set<int> QueryDistinctConstraints( DRC_CONSTRAINT_T aConstraintId );
 
    std::vector<DRC_TEST_PROVIDER*> GetTestProviders() const { return m_testProviders; };
 
    DRC_TEST_PROVIDER* GetTestProvider( const wxString& name ) const;

    std::vector<BOARD_ITEM*> GetItemsMatchingCondition( const wxString& aExpression,
                                                        DRC_CONSTRAINT_T aConstraint = ASSERTION_CONSTRAINT,
                                                        REPORTER* aReporter = nullptr );
 
    std::vector<BOARD_ITEM*> GetItemsMatchingRule( const std::shared_ptr<DRC_RULE>& aRule,
                                                   REPORTER*                        aReporter = nullptr );
 
    static bool IsNetADiffPair( BOARD* aBoard, const NETINFO_ITEM* aNet, int& aNetP, int& aNetN );

    static int MatchDpSuffix( const wxString& aNetName, wxString& aComplementNet,
                              wxString& aBaseDpName );

    bool IsNetTieExclusion( int aTrackNetCode, PCB_LAYER_ID aTrackLayer,
                            const VECTOR2I& aCollisionPos, BOARD_ITEM* aCollidingItem );
 
private:
    void addRule( std::shared_ptr<DRC_RULE>& rule )
    {
        m_rules.push_back(rule);
    }

    void loadRules( const wxFileName& aPath );
 
    void compileRules();
 
    struct DRC_ENGINE_CONSTRAINT
    {
        LSET                       layerTest;
        DRC_RULE_CONDITION*        condition;
        std::shared_ptr<DRC_RULE>  parentRule;
        DRC_CONSTRAINT             constraint;
 
        // Pre-resolved zone pointer for implicit keepout disallow rules. Allows the fast
        // path in processConstraint to skip UUID parsing and expression evaluation by
        // doing a direct bounding box pre-filter against the keepout zone.
        ZONE*                      implicitKeepoutZone = nullptr;
    };
 
    void loadImplicitRules();
    std::shared_ptr<DRC_RULE> createImplicitRule( const wxString& name, DRC_IMPLICIT_SOURCE aImplicitSource );
 
protected:
    BOARD_DESIGN_SETTINGS*     m_designSettings;
    BOARD*                     m_board;
    DS_PROXY_VIEW_ITEM*        m_drawingSheet;
    NETLIST*                   m_schematicNetlist;
 
    std::vector<std::shared_ptr<DRC_RULE>>  m_rules;
    bool                                    m_rulesValid;
    std::vector<DRC_TEST_PROVIDER*>         m_testProviders;
 
    std::vector<int>           m_errorLimits;
    mutable std::mutex         m_errorLimitsMutex;
    bool                       m_reportAllTrackErrors;
    bool                       m_testFootprints;
 
    // constraint -> rule -> provider
    std::map<DRC_CONSTRAINT_T, std::vector<DRC_ENGINE_CONSTRAINT*>*> m_constraintMap;
 
    DRC_VIOLATION_HANDLER      m_violationHandler;
    REPORTER*                  m_logReporter;
    PROGRESS_REPORTER*         m_progressReporter;
 
    std::shared_ptr<KIGFX::VIEW_OVERLAY> m_debugOverlay;
 
    // Cache for GetOwnClearance lookups to improve rendering performance.
    // Key is (UUID, layer), value is clearance in internal units.
    // Protected by m_clearanceCacheMutex for thread-safe access during rendering.
    std::unordered_map<DRC_OWN_CLEARANCE_CACHE_KEY, int> m_ownClearanceCache;
 
    // Netclass name -> clearance mapping for fast lookup in EvalRules.
    // Only written during InitEngine(), read during DRC and rendering.
    // Protected by m_clearanceCacheMutex for thread-safe access.
    std::unordered_map<wxString, int> m_netclassClearances;
 
    // Mutex protecting clearance caches for thread-safe access.
    // Uses shared_mutex for reader-writer pattern (many concurrent reads, exclusive writes).
    mutable std::shared_mutex m_clearanceCacheMutex;
    bool m_hasExplicitClearanceRules = false;
    bool m_hasGeometryDependentRules = false;
    bool m_hasDiffPairClearanceOverrides = false;
    std::map<DRC_CONSTRAINT_T, std::vector<DRC_ENGINE_CONSTRAINT*>> m_explicitConstraints;
};