drc_test_provider_matched_length.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004-2023 KiCad Developers.
 *
 * 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 3 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 <http://www.gnu.org/licenses/>.
 */
 
#include <common.h>
#include <board.h>
#include <board_design_settings.h>
#include <pad.h>
#include <pcb_track.h>
 
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <drc/drc_test_provider.h>
#include <drc/drc_length_report.h>
 
#include <connectivity/connectivity_data.h>
#include <connectivity/from_to_cache.h>
 
 
/*
 Single-ended matched length + skew + via count test.
 Errors generated:
 - DRCE_LENGTH_OUT_OF_RANGE
 - DRCE_SKEW_OUT_OF_RANGE
 - DRCE_TOO_MANY_VIAS
 Todo: arc support
*/
 
class DRC_TEST_PROVIDER_MATCHED_LENGTH : public DRC_TEST_PROVIDER
{
public:
 DRC_TEST_PROVIDER_MATCHED_LENGTH () :
 m_board( nullptr )
 {
 }
 
 virtual ~DRC_TEST_PROVIDER_MATCHED_LENGTH()
 {
 }
 
 virtual bool Run() override;
 
 virtual const wxString GetName() const override
 {
 return wxT( "length" );
 };
 
 virtual const wxString GetDescription() const override
 {
 return wxT( "Tests matched track lengths." );
 }
 
private:
 
 bool runInternal( bool aDelayReportMode = false );
 
 using CONNECTION = DRC_LENGTH_REPORT::ENTRY;
 
 void checkLengths( const DRC_CONSTRAINT& aConstraint,
 const std::vector<CONNECTION>& aMatchedConnections );
 void checkSkews( const DRC_CONSTRAINT& aConstraint,
 const std::vector<CONNECTION>& aMatchedConnections );
 void checkViaCounts( const DRC_CONSTRAINT& aConstraint,
 const std::vector<CONNECTION>& aMatchedConnections );
 
private:
 BOARD* m_board;
 DRC_LENGTH_REPORT m_report;
};
 
void DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths( const DRC_CONSTRAINT& aConstraint,
 const std::vector<CONNECTION>& aMatchedConnections )
{
 for( const DRC_LENGTH_REPORT::ENTRY& ent : aMatchedConnections )
 {
 bool minViolation = false;
 bool maxViolation = false;
 int minLen = 0;
 int maxLen = 0;
 
 if( aConstraint.GetValue().HasMin() && ent.total < aConstraint.GetValue().Min() )
 {
 minViolation = true;
 minLen = aConstraint.GetValue().Min();
 }
 else if( aConstraint.GetValue().HasMax() && ent.total > aConstraint.GetValue().Max() )
 {
 maxViolation = true;
 maxLen = aConstraint.GetValue().Max();
 }
 
 if( ( minViolation || maxViolation ) )
 {
 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_LENGTH_OUT_OF_RANGE );
 wxString msg;
 
 if( minViolation )
 {
 msg = formatMsg( _( "(%s min length %s; actual %s)" ),
 aConstraint.GetName(),
 minLen,
 ent.total );
 }
 else if( maxViolation )
 {
 msg = formatMsg( _( "(%s max length %s; actual %s)" ),
 aConstraint.GetName(),
 maxLen,
 ent.total );
 }
 
 drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
 
 for( auto offendingTrack : ent.items )
 drcItem->AddItem( offendingTrack );
 
 drcItem->SetViolatingRule( aConstraint.GetParentRule() );
 
 reportViolation( drcItem, ( *ent.items.begin() )->GetPosition(),
 ( *ent.items.begin() )->GetLayer() );
 }
 }
}
 
void DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews( const DRC_CONSTRAINT& aConstraint,
 const std::vector<CONNECTION>& aMatchedConnections )
{
 double avgLength = 0;
 
 for( const DRC_LENGTH_REPORT::ENTRY& ent : aMatchedConnections )
 avgLength += ent.total;
 
 avgLength /= (double) aMatchedConnections.size();
 
 for( const auto& ent : aMatchedConnections )
 {
 int skew = KiROUND( ent.total - avgLength );
 bool fail_min = false;
 bool fail_max = false;
 
 if( aConstraint.GetValue().HasMax() && abs( skew ) > aConstraint.GetValue().Max() )
 fail_max = true;
 else if( aConstraint.GetValue().HasMin() && abs( skew ) < aConstraint.GetValue().Min() )
 fail_min = true;
 
 if( fail_min || fail_max )
 {
 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_SKEW_OUT_OF_RANGE );
 wxString msg;
 
 if( fail_min )
 {
 msg.Printf( _( "(%s min skew %s; actual %s; average net length %s; actual %s)" ),
 aConstraint.GetName(),
 MessageTextFromValue( aConstraint.GetValue().Min() ),
 MessageTextFromValue( skew ),
 MessageTextFromValue( avgLength ),
 MessageTextFromValue( ent.total ) );
 }
 else
 {
 msg.Printf( _( "(%s max skew %s; actual %s; average net length %s; actual %s)" ),
 aConstraint.GetName(),
 MessageTextFromValue( aConstraint.GetValue().Max() ),
 MessageTextFromValue( skew ),
 MessageTextFromValue( avgLength ),
 MessageTextFromValue( ent.total ) );
 }
 
 drcItem->SetErrorMessage( drcItem->GetErrorText() + " " + msg );
 
 for( BOARD_CONNECTED_ITEM* offendingTrack : ent.items )
 drcItem->SetItems( offendingTrack );
 
 drcItem->SetViolatingRule( aConstraint.GetParentRule() );
 
 reportViolation( drcItem, ( *ent.items.begin() )->GetPosition(),
 ( *ent.items.begin() )->GetLayer() );
 }
 }
}
 
 
void DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts( const DRC_CONSTRAINT& aConstraint,
 const std::vector<CONNECTION>& aMatchedConnections )
{
 for( const auto& ent : aMatchedConnections )
 {
 std::shared_ptr<DRC_ITEM> drcItem = nullptr;
 
 if( aConstraint.GetValue().HasMax() && ent.viaCount > aConstraint.GetValue().Max() )
 {
 drcItem = DRC_ITEM::Create( DRCE_VIA_COUNT_OUT_OF_RANGE );
 wxString msg = wxString::Format( _( "(%s max count %d; actual %d)" ),
 aConstraint.GetName(),
 aConstraint.GetValue().Max(),
 ent.viaCount );
 
 drcItem->SetErrorMessage( _( "Too many vias on a connection" ) + wxS( " " ) + msg );
 }
 else if( aConstraint.GetValue().HasMin() && ent.viaCount < aConstraint.GetValue().Min() )
 {
 drcItem = DRC_ITEM::Create( DRCE_VIA_COUNT_OUT_OF_RANGE );
 wxString msg = wxString::Format( _( "(%s min count %d; actual %d)" ),
 aConstraint.GetName(),
 aConstraint.GetValue().Min(),
 ent.viaCount );
 
 drcItem->SetErrorMessage( _( "Too few vias on a connection" ) + wxS( " " ) + msg );
 }
 
 if( drcItem )
 {
 for( auto offendingTrack : ent.items )
 drcItem->SetItems( offendingTrack );
 
 drcItem->SetViolatingRule( aConstraint.GetParentRule() );
 
 reportViolation( drcItem, ( *ent.items.begin() )->GetPosition(),
 ( *ent.items.begin() )->GetLayer() );
 }
 }
}
 
 
bool DRC_TEST_PROVIDER_MATCHED_LENGTH::Run()
{
 return runInternal( false );
}
 
 
bool DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal( bool aDelayReportMode )
{
 m_board = m_drcEngine->GetBoard();
 m_report.Clear();
 
 if( !aDelayReportMode )
 {
 if( !reportPhase( _( "Gathering length-constrained connections..." ) ) )
 return false;
 }
 
 std::map<DRC_RULE*, std::set<BOARD_CONNECTED_ITEM*> > itemSets;
 
 std::shared_ptr<FROM_TO_CACHE> ftCache = m_board->GetConnectivity()->GetFromToCache();
 
 ftCache->Rebuild( m_board );
 
 const size_t progressDelta = 100;
 size_t count = 0;
 size_t ii = 0;
 
 forEachGeometryItem( { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T }, LSET::AllCuMask(),
 [&]( BOARD_ITEM *item ) -> bool
 {
 count++;
 return true;
 } );
 
 forEachGeometryItem( { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T }, LSET::AllCuMask(),
 [&]( BOARD_ITEM *item ) -> bool
 {
 if( !reportProgress( ii++, count, progressDelta ) )
 return false;
 
 const DRC_CONSTRAINT_T constraintsToCheck[] = {
 LENGTH_CONSTRAINT,
 SKEW_CONSTRAINT,
 VIA_COUNT_CONSTRAINT,
 };
 
 for( int i = 0; i < 3; i++ )
 {
 auto constraint = m_drcEngine->EvalRules( constraintsToCheck[i], item, nullptr,
 item->GetLayer() );
 
 if( constraint.IsNull() )
 continue;
 
 auto citem = static_cast<BOARD_CONNECTED_ITEM*>( item );
 
 itemSets[ constraint.GetParentRule() ].insert( citem );
 }
 
 return true;
 } );
 
 std::map< DRC_RULE*, std::vector<CONNECTION> > matches;
 
 for( const std::pair< DRC_RULE* const, std::set<BOARD_CONNECTED_ITEM*> >& it : itemSets )
 {
 std::map<int, std::set<BOARD_CONNECTED_ITEM*> > netMap;
 
 for( BOARD_CONNECTED_ITEM* citem : it.second )
 netMap[ citem->GetNetCode() ].insert( citem );
 
 for( const std::pair< const int, std::set<BOARD_CONNECTED_ITEM*> >& nitem : netMap )
 {
 CONNECTION ent;
 ent.items = nitem.second;
 ent.netcode = nitem.first;
 ent.netname = m_board->GetNetInfo().GetNetItem( ent.netcode )->GetNetname();
 
 ent.viaCount = 0;
 ent.totalRoute = 0;
 ent.totalVia = 0;
 ent.totalPadToDie = 0;
 ent.fromItem = nullptr;
 ent.toItem = nullptr;
 
 for( BOARD_CONNECTED_ITEM* citem : nitem.second )
 {
 if( citem->Type() == PCB_VIA_T )
 {
 const BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
 const BOARD_STACKUP& stackup = bds.GetStackupDescriptor();
 
 ent.viaCount++;
 
 if( bds.m_UseHeightForLengthCalcs )
 {
 const PCB_VIA* v = static_cast<PCB_VIA*>( citem );
 PCB_LAYER_ID topmost;
 PCB_LAYER_ID bottommost;
 
 v->GetOutermostConnectedLayers( &topmost, &bottommost );
 
 if( topmost != UNDEFINED_LAYER && topmost != bottommost )
 ent.totalVia += stackup.GetLayerDistance( topmost, bottommost );
 }
 }
 else if( citem->Type() == PCB_TRACE_T )
 {
 ent.totalRoute += static_cast<PCB_TRACK*>( citem )->GetLength();
 }
 else if ( citem->Type() == PCB_ARC_T )
 {
 ent.totalRoute += static_cast<PCB_ARC*>( citem )->GetLength();
 }
 else if( citem->Type() == PCB_PAD_T )
 {
 ent.totalPadToDie += static_cast<PAD*>( citem )->GetPadToDieLength();
 }
 }
 
 ent.total = ent.totalRoute + ent.totalVia + ent.totalPadToDie;
 ent.matchingRule = it.first;
 
 // fixme: doesn't seem to work ;-)
 auto ftPath = ftCache->QueryFromToPath( ent.items );
 
 if( ftPath )
 {
 ent.from = ftPath->fromName;
 ent.to = ftPath->toName;
 }
 else
 {
 ent.from = ent.to = _( "<unconstrained>" );
 }
 
 m_report.Add( ent );
 matches[ it.first ].push_back(ent);
 }
 }
 
 if( !aDelayReportMode )
 {
 if( !reportPhase( _( "Checking length constraints..." ) ) )
 return false;
 
 ii = 0;
 count = matches.size();
 
 for( std::pair< DRC_RULE* const, std::vector<CONNECTION> > it : matches )
 {
 DRC_RULE *rule = it.first;
 auto& matchedConnections = it.second;
 
 if( !reportProgress( ii++, count, progressDelta ) )
 return false;
 
 std::sort( matchedConnections.begin(), matchedConnections.end(),
 [] ( const CONNECTION&a, const CONNECTION&b ) -> int
 {
 return a.netname < b.netname;
 } );
 
 reportAux( wxString::Format( wxT( "Length-constrained traces for rule '%s':" ),
 it.first->m_Name ) );
 
 for( const DRC_LENGTH_REPORT::ENTRY& ent : matchedConnections )
 {
 reportAux(wxString::Format( wxT( " - net: %s, from: %s, to: %s, "
 "%d matching items, "
 "total: %s (tracks: %s, vias: %s, pad-to-die: %s), "
 "vias: %d" ),
 ent.netname,
 ent.from,
 ent.to,
 (int) ent.items.size(),
 MessageTextFromValue( ent.total ),
 MessageTextFromValue( ent.totalRoute ),
 MessageTextFromValue( ent.totalVia ),
 MessageTextFromValue( ent.totalPadToDie ),
 ent.viaCount ) );
 }
 
 
 std::optional<DRC_CONSTRAINT> lengthConstraint = rule->FindConstraint( LENGTH_CONSTRAINT );
 
 if( lengthConstraint && lengthConstraint->GetSeverity() != RPT_SEVERITY_IGNORE )
 checkLengths( *lengthConstraint, matchedConnections );
 
 std::optional<DRC_CONSTRAINT> skewConstraint = rule->FindConstraint( SKEW_CONSTRAINT );
 
 if( skewConstraint && skewConstraint->GetSeverity() != RPT_SEVERITY_IGNORE )
 checkSkews( *skewConstraint, matchedConnections );
 
 std::optional<DRC_CONSTRAINT> viaCountConstraint = rule->FindConstraint( VIA_COUNT_CONSTRAINT );
 
 if( viaCountConstraint && viaCountConstraint->GetSeverity() != RPT_SEVERITY_IGNORE )
 checkViaCounts( *viaCountConstraint, matchedConnections );
 }
 
 reportRuleStatistics();
 }
 
 return !m_drcEngine->IsCancelled();
}
 
 
namespace detail
{
 static DRC_REGISTER_TEST_PROVIDER<DRC_TEST_PROVIDER_MATCHED_LENGTH> dummy;
}