coriolis/katana/src/Session.cpp

// -*- mode: C++; explicit-buffer-name: "Session.cpp<katana>" -*-
//
// This file is part of the Coriolis Software.
// Copyright (c) UPMC 2008-2016, All Rights Reserved
//
// +-----------------------------------------------------------------+
// |                   C O R I O L I S                               |
// |      K i t e  -  D e t a i l e d   R o u t e r                  |
// |                                                                 |
// |  Author      :                    Jean-Paul CHAPUT              |
// |  E-mail      :       Jean-Paul.Chaput@asim.lip6.fr              |
// | =============================================================== |
// |  C++ Module  :       "./Session.cpp"                            |
// +-----------------------------------------------------------------+


#include "hurricane/Bug.h"
#include "hurricane/Point.h"
#include "hurricane/Error.h"
#include "katana/Session.h"
#include "katana/Track.h"
#include "katana/TrackElement.h"
#include "katana/KatanaEngine.h"


namespace {

  using namespace Katana;


  const char* reopenSession = "Katana::Session::_open(): Session already open for %s (internal error).";


} // Anonymous namespace.


namespace Katana {

  using std::cerr;
  using std::endl;
  using Hurricane::tab;
  using Hurricane::Error;
  using Hurricane::Bug;
  using Hurricane::Point;


// -------------------------------------------------------------------
// Class  :  "Session".

  Session::Session ( KatanaEngine* katana )
    : Super(katana)
    , _insertEvents()
    , _removeEvents()
    , _sortEvents  ()
  { }


  void  Session::_postCreate ()
  { Super::_postCreate(); }


  Session::~Session ()
  { }


  void  Session::_preDestroy ()
  {
    Super::_preDestroy();
    _isEmpty();
  }


  Session* Session::_open ( KatanaEngine* katana )
  {
    cdebug_log(159,0) << "Katana::Session::_open()" << endl;

    Session* session = Session::get();
    if (session) {
      if (session->_getKatanaEngine() != katana)
        throw Error( reopenSession, getString(session->getKatanaEngine()).c_str() );

      return session;
    }

    session = new Session ( katana );
    session->_postCreate();

    return session;
  }


  Session* Session::get ( const char* message )
  { return dynamic_cast<Session*>( Super::get(message) ); }


  Configuration* Session::getConfiguration ()
  { return Session::getKatanaEngine()->getConfiguration(); }


  TrackElement* Session::lookup ( Segment* segment )
  { return Session::get("Session::lookup(Segment*)")->_getKatanaEngine()->_lookup(segment); }


  TrackElement* Session::lookup ( AutoSegment* segment )
  { return Session::get("lookup(AutoSegment*)")->_getKatanaEngine()->_lookup ( segment ); }


  void  Session::setInterrupt ( bool state )
  { Session::get("setInterrupt()")->_getKatanaEngine()->setInterrupt(state); }


  KatanaEngine* Session::_getKatanaEngine ()
  { return static_cast<KatanaEngine*>(_anabatic); }


  Net* Session::_getBlockageNet ()
  { return _getKatanaEngine()->getBlockageNet(); };


  NegociateWindow* Session::_getNegociateWindow ()
  { return _getKatanaEngine()->getNegociateWindow(); };


  unsigned int  Session::_getRipupCost ()
  { return _getKatanaEngine()->getRipupCost(); };


  Anabatic::GCell* Session::_getGCellUnder ( DbU::Unit x, DbU::Unit y )
  { return _getKatanaEngine()->getGCellUnder(Point(x,y)); };


  void  Session::_doRemovalEvents ()
  {
    set<Track*> packTracks;

    for ( size_t i=0 ; i<_removeEvents.size() ; ++i ) {
      if (not _removeEvents[i]._segment->getTrack()) continue;

      packTracks.insert( _removeEvents[i]._segment->getTrack() );
      _removeEvents[i]._segment->detach();
    }
    _removeEvents.clear();

    for ( set<Track*>::iterator it=packTracks.begin() ; it != packTracks.end() ; ++it )
      (*it)->doRemoval();
  }


  size_t  Session::_revalidate ()
  {
    cdebug_log(159,1) << "Katana::Session::_revalidate()" << endl;

    _doRemovalEvents();

    for ( size_t i=0 ; i<_insertEvents.size() ; ++i ) {
      if (_insertEvents[i]._segment) {
        _insertEvents[i]._track->insert( _insertEvents[i]._segment );
      }
      if (_insertEvents[i]._marker) _insertEvents[i]._track->insert( _insertEvents[i]._marker );
    }
    _insertEvents.clear();

  // Check if to be destroyeds are not associateds with TrackSegments.
    const set<AutoSegment*>&          destroyeds = getDestroyeds();
    set<AutoSegment*>::const_iterator idestroyed = destroyeds.begin();
    for ( ; idestroyed != destroyeds.end() ; ++idestroyed ) {
      if (lookup(*idestroyed)) {
        cdebug_tabw(155,-1);
        throw Error( "Destroyed AutoSegment is associated with a TrackSegment\n"
                     "        (%s)"
                   , getString(*idestroyed).c_str());
      }
    }
    
    size_t count = Super::_revalidate();

    Interval                    span;
    const vector<AutoSegment*>& revalidateds     = getRevalidateds();
  //const set<Net*>&            netsModificateds = getNetsModificateds();

    for ( size_t i=0 ; i<revalidateds.size() ; ++i ) {
      if (not revalidateds[i]->isCanonical()) continue;
      
    //Net*          currentNet   = NULL;
      TrackElement* trackSegment = lookup( revalidateds[i] );

      if (trackSegment and trackSegment->isInvalidated()) {
        trackSegment->revalidate();
      }
    }
    _doglegReset();

# if defined(CHECK_DATABASE)
    unsigned int overlaps = 0;
# endif
    for ( Track* track : _sortEvents ) {
      track->doReorder();
# if defined(CHECK_DATABASE)
      track->check( overlaps, "Session::_revalidate() - track sorting." );
# endif
    }

# if defined(CHECK_DATABASE)
    for ( set<Track*>::iterator it=packTracks.begin() ; it != packTracks.end() ; ++it )
      (*it)->check( overlaps, "Session::_revalidate() - on packed track." );

    for ( size_t i=0 ; i<revalidateds.size() ; ++i ) {
      revalidateds[i]->check();
    }

  //_getKatanaEngine()->_showOverlap ();
# endif

    _sortEvents.clear();

#if THIS_IS_DISABLED
    if (not faileds.empty()) {
      set<TrackElement*>::iterator ifailed = faileds.begin();
      Anabatic::GCellVector gcells;
      for ( ; ifailed != faileds.end() ; ++ifailed ) {
        (*ifailed)->getGCells ( gcells );
        (*ifailed)->makeDogLeg( gcells[0] );
      }

      count += _revalidate();
    }
#endif

  // Looking for reduced/raised segments.
    for ( size_t i=0 ; i<revalidateds.size() ; ++i ) {
      if (revalidateds[i]->canReduce()) {
        revalidateds[i]->reduce();
        TrackElement* trackSegment = lookup( revalidateds[i] );
        if (trackSegment and trackSegment->getTrack()) _addRemoveEvent( trackSegment );
        cdebug_log(159,0) << "Session: reduce:" << revalidateds[i] << endl;
      }
      if (revalidateds[i]->mustRaise()) {
        revalidateds[i]->raise();
        lookup( revalidateds[i] )->reschedule( 0 );
        cdebug_log(159,0) << "Session: raise:" << revalidateds[i] << endl;
      }
    }

    _doRemovalEvents();

    cdebug_tabw(159,-1);
    return count;
  }


  bool  Session::_isEmpty () const
  {
    if ( not _insertEvents.empty() or not _removeEvents.empty() or not _sortEvents.empty() ) {
      cerr << Bug( "Session::_isEmpty() failed :\n"
                   "       %u inserts, %u removes and %u sort events remains."
                 , _insertEvents.size()
                 , _removeEvents.size()
                 , _sortEvents  .size() ) << endl;
      if (not _sortEvents.empty()) {
        cerr << "      Remaining sort events on Tracks:" << endl;
        for ( Track* track : _sortEvents ) {
          cerr << "      | " << track << endl;
        }
      }
      return false;
    }

    return true;
  }


  void  Session::_addInsertEvent ( TrackMarker* marker, Track* track )
  {
    _insertEvents.push_back( Event(marker,track) );
    _addSortEvent( track, true );
  }


  void  Session::_addInsertEvent ( TrackElement* segment, Track* track )
  {
    cdebug_log(159,0) <<  "addInsertEvent() " << segment
                << "\n               @" << track << endl;

    if ( segment->getTrack() != NULL ) {
      cerr << Bug("Session::addInsertEvent(): Segment already in Track."
                 "\n      %s."
                 "\n      to %s."
                 ,getString(segment).c_str()
                 ,getString(track).c_str()
                 ) << endl;
      return;
    }

    _insertEvents.push_back( Event(segment,track) );
    _addSortEvent( track, true );
  }


  void  Session::_addRemoveEvent ( TrackElement* segment )
  {
    if (not segment->getTrack()) {
      cerr << Bug( " Katana::Session::addRemoveEvent() : %s is not in any Track."
                 , getString(segment).c_str() ) << endl;
      return;
    }

    cdebug_log(159,0) << "Ripup: @" << DbU::getValueString(segment->getAxis()) << " " << segment << endl;
    _removeEvents.push_back( Event(segment,segment->getTrack()) );
    _addSortEvent( segment->getTrack(), true );
  }


  void  Session::_addMoveEvent ( TrackElement* segment, Track* track )
  {
    if (not segment->getTrack()) {
      cerr << Bug( " Katana::Session::addMoveEvent() : %s is not yet in a track."
                 , getString(segment).c_str() ) << endl;
    } else {
      _addRemoveEvent( segment );
    }

    _addInsertEvent( segment, track );
  }


  void  Session::_addSortEvent ( Track* track, bool forced )
  {
    if (not track ) {
      cerr << Bug( " Katana::Session::addSortEvent() : no Track to sort." ) << endl;
      return;
    }
    if (forced) track->invalidate();
    _sortEvents.insert( track );
  }


  string  Session::_getTypeName () const
  { return "Katana::Session"; }


  Record* Session::_getRecord () const
  {
    Record* record = Session::_getRecord ();
    record->add( getSlot( "_sortEvents"  , &_sortEvents ) );
                                     
    return record;
  }


} // Katana namespace.