GroupBlock.cpp

   1 #include "GroupBlock.h"
   2 #include "BlockParameterGeneric.h"
   3 #include "AbstractInterface.h"
   4 #include "ConnectedInterface.h"
   5 #include "GroupInterface.h"
   6 #include "string.h"
   7 #include <sstream>
   8 #include "Parameters.h"
   9
  10 int GroupBlock::counter = 1;
  11
  12 GroupBlock::GroupBlock(GroupBlock *_parent) throw(Exception) :  AbstractBlock() {
  13
  14   GroupInterface* clk = NULL;
  15   GroupInterface* rst = NULL;
  16
  17   // force topGroup to false if this group has a parent
  18   if (_parent != NULL) {
  19     topGroup = false;
  20     name = QString("sub_group")+"_"+QString::number(counter++);
  21     // creating clk/rst interfaces
  22     clk = new GroupInterface(this,"clk", AbstractInterface::Input, AbstractInterface::Clock);
  23     rst = new GroupInterface(this,"reset", AbstractInterface::Input, AbstractInterface::Reset);
  24     addInterface(clk);
  25     addInterface(rst);
  26   }
  27   else {
  28     topGroup = true;
  29     name = QString("top_group");
  30     // creating external clk/rst interfaces
  31     clk = new GroupInterface(this,"ext_clk", AbstractInterface::Input, AbstractInterface::Clock);
  32     rst = new GroupInterface(this,"ext_reset", AbstractInterface::Input, AbstractInterface::Reset);
  33     addInterface(clk);
  34     addInterface(rst);
  35     // creating clkrstgen block and connecting it to this: done in Dispatcher since this has no access to library
  36   }
  37   parent = _parent;
  38
  39   if (_parent != NULL) {
  40     try {
  41       connectClkReset();
  42     }
  43     catch(Exception e) {
  44       AbstractBlock* source = (AbstractBlock *)(e.getSource());
  45       cerr << qPrintable(source->getName()) << ":" << qPrintable(e.getMessage()) << endl;
  46       throw(e);
  47     }
  48   }
  49
  50 }
  51
  52 GroupBlock::~GroupBlock() {
  53   foreach(AbstractBlock* block, blocks) {
  54     delete block;
  55   }
  56 }
  57
  58 bool GroupBlock::isGroupBlock() {
  59   return true;
  60 }
  61
  62 bool GroupBlock::isTopGroupBlock() {
  63   return topGroup;
  64 }
  65
  66 void GroupBlock::setParent(AbstractBlock *_parent) {
  67   parent = _parent;
  68   if (parent != NULL) {
  69     topGroup = false;
  70   }
  71 }
  72
  73 void GroupBlock::removeAllBlocks() {
  74   foreach(AbstractBlock* block, blocks) {
  75     if (block->isGroupBlock()) {
  76       GroupBlock* group = AB_TO_GRP(block);
  77       group->removeAllBlocks();
  78     }
  79     removeBlock(block);
  80   }
  81 }
  82
  83 void GroupBlock::removeBlock(AbstractBlock* block) {
  84   /* CAUTION: no check is done if the block has connected interface
  85      or not. Thus, they must be deleted elsewhere.
  86   */
  87   blocks.removeAll(block);
  88   delete block;
  89 }
  90
  91 AbstractBlock *GroupBlock::getFunctionalBlockByName(QString name) {
  92   foreach(AbstractBlock* block, blocks) {
  93     if (block->isFunctionalBlock()) {
  94       if (block->getName() == name) return block;
  95     }
  96   }
  97   return NULL;
  98 }
  99
 100 void GroupBlock::parametersValidation(QList<AbstractBlock *> *checkedBlocks, QList<AbstractBlock *> *blocksToConfigure) {
 101
 102   /*
 103   checkedBlocks->append(this);
 104
 105   foreach(BlockParameter* param, params){
 106     if(param->isUserParameter() && !param->isValueSet()){
 107       if(!blocksToConfigure->contains(param->getOwner())){
 108         blocksToConfigure->append(param->getOwner());
 109       }
 110     }
 111   }
 112   foreach(AbstractInterface *inter, outputs){
 113     foreach(AbstractInterface *connectedInter, inter->getConnectedTo()){
 114       if(!checkedBlocks->contains(connectedInter->getOwner())){
 115         connectedInter->getOwner()->parametersValidation(checkedBlocks, blocksToConfigure);
 116       }
 117     }
 118   }
 119   */
 120 }
 121
 122 void GroupBlock::addGenericParameter(QString name, QString type, QString value) {
 123   BlockParameter* param = new BlockParameterGeneric(this, name, type, value);
 124   params.append(param);
 125 }
 126
 127 void GroupBlock::removeGenericParameter(QString name) {
 128   BlockParameter* p = getParameterFromName(name);
 129   if (p != NULL) params.removeAll(p);
 130 }
 131
 132 void GroupBlock::createInputPattern() {
 133   foreach(AbstractInterface* iface, getControlInputs()) {
 134     ConnectedInterface* connIface = AI_TO_CON(iface);
 135     QList<char>* pattern = new QList<char>(*(connIface->getConnectedFrom()->getOutputPattern()));
 136     connIface->setOutputPattern(pattern);
 137   }
 138 }
 139
 140 void GroupBlock::computeAdmittanceDelays() throw(Exception) {
 141   throw(Exception(INVALID_GROUPBLOCK_USE));
 142 }
 143
 144 void GroupBlock::checkInputPatternCompatibility()  throw(Exception){
 145   throw(Exception(INVALID_GROUPBLOCK_USE));
 146 }
 147
 148
 149 void GroupBlock::computeOutputPattern(int nbExec) throw(Exception) {
 150
 151   static QString fctName = "GroupBlock::computeOutputPattern()";
 152 #ifdef DEBUG_FCTNAME
 153   cout << "call to " << qPrintable(fctName) << endl;
 154 #endif
 155
 156   cout << "computing output pattern of group " << qPrintable(name) << endl;
 157
 158   bool canCompute = false;
 159   // get the input pattern on each inputs
 160   createInputPattern();
 161
 162   cout << "Input pattern OK" << endl;
 163   // find blocks that are connected to that inputs and generators
 164   QList<AbstractBlock*> fifo;
 165   foreach(AbstractBlock* block, blocks) {
 166
 167     bool addIt = false;
 168     // if a block is a generator and has control outputs, add it
 169     if (block->isGeneratorBlock()) {
 170       if (block->getControlOutputs().size() > 0) addIt = true;
 171     }
 172     else {
 173       // if the block has all its connected inputs that are connected to an intput of the group, add it too
 174       addIt = true;
 175       foreach(AbstractInterface* iface, block->getControlInputs()) {
 176         //cout << qPrintable(iface->getName()) << " of " << qPrintable(iface->getOwner()->getName()) << " connected to " << endl;
 177         ConnectedInterface* connFrom = ((ConnectedInterface*)iface)->getConnectedFrom();
 178         //cout << qPrintable(connFrom->getName()) << " of " << qPrintable(connFrom->getOwner()->getName()) << endl;
 179
 180         if (connFrom == NULL) {
 181           addIt = false;
 182           break;
 183         }
 184         else if (connFrom->getOwner() != this) {
 185           addIt = false;
 186           break;
 187         }
 188       }
 189     }
 190     if (addIt) {
 191       cout << "adding " << qPrintable(block->getName()) << " to initialize the FIFO" << endl;
 192       block->setTraversalLevel(0); // level 0 = first blocks to be evaluated
 193       fifo.append(block);
 194     }
 195   }
 196
 197   while (!fifo.isEmpty()) {
 198     AbstractBlock* block = fifo.takeFirst();
 199
 200     if (block->getPatternComputed()) continue; // block has already been processed
 201
 202     cout << "computing compat and output for " << qPrintable(block->getName()) << endl;
 203
 204
 205     try {
 206       block->checkInputPatternCompatibility();
 207     }
 208     catch(Exception e) {
 209       cout << qPrintable(block->getName()) << " is not compatible with its input pattern" << endl;
 210       throw(e);
 211     }
 212
 213     try {
 214       block->computeOutputPattern();
 215     }
 216     catch(Exception e) {
 217       cout << "cannot finalize output pattern computation of " << qPrintable(block->getName()) << endl;
 218       throw(e);
 219     }
 220     canCompute = true;
 221     block->setPatternComputed(true);
 222     /* add other blocks connected from block to the fifo but only if
 223        all their connected inputs are connected to blocks that have
 224        a traversalLevel >=0
 225      */
 226     foreach(AbstractInterface* iface, block->getControlOutputs()) {
 227       ConnectedInterface* conn = (ConnectedInterface*)iface;
 228       foreach(ConnectedInterface* connTo, conn->getConnectedTo()) {
 229
 230         AbstractBlock* block1 = connTo->getOwner();
 231         cout << "testing if " << qPrintable(block1->getName()) << " has all connected inputs connected to already processed blocks" << endl;
 232         bool addIt = true;
 233         int maxLevel = 0;
 234
 235         foreach(AbstractInterface* iface, block1->getControlInputs()) {
 236           //cout << qPrintable(iface->getName()) << " of " << qPrintable(iface->getOwner()->getName()) << " connected to " << endl;
 237           ConnectedInterface* connFrom = ((ConnectedInterface*)iface)->getConnectedFrom();
 238           //cout << qPrintable(connFrom->getName()) << " of " << qPrintable(connFrom->getOwner()->getName()) << endl;
 239
 240           if ((connFrom != NULL) && (connFrom->getOwner()->getPatternComputed() == false)) {
 241             addIt = false;
 242             break;
 243           }
 244           else {
 245             if (connFrom->getOwner()->getTraversalLevel() > maxLevel) maxLevel = connFrom->getOwner()->getTraversalLevel();
 246           }
 247         }
 248
 249         if (addIt) {
 250           cout << "adding " << qPrintable(block1->getName()) << " to the FIFO" << endl;
 251           block1->setTraversalLevel(maxLevel+1); // level 0 = first blocks to be evaluated
 252           fifo.append(block1);
 253         }
 254       }
 255     }
 256   }
 257
 258   if (canCompute) {
 259     foreach(AbstractInterface* iface, getControlOutputs()) {
 260       ConnectedInterface* connIface = AI_TO_CON(iface);
 261       QList<char>* pattern = new QList<char>(*(connIface->getConnectedFrom()->getOutputPattern()));
 262       connIface->setOutputPattern(pattern);
 263     }
 264     setPatternComputed(true);
 265   }
 266 }
 267
 268 void GroupBlock::generateVHDL(const QString& path) throw(Exception) {
 269
 270   QString coreFile = "";
 271
 272   coreFile = path;
 273   coreFile.append(Parameters::normalizeName(name));
 274   coreFile.append(".vhd");
 275
 276   QFile vhdlCore(coreFile);
 277
 278   if (!vhdlCore.open(QIODevice::WriteOnly)) {
 279     throw(Exception(VHDLFILE_NOACCESS));
 280   }
 281
 282   QTextStream outCore(&vhdlCore);
 283
 284   try {
 285     generateComments(outCore);
 286     generateLibraries(outCore);
 287     generateEntity(outCore);
 288     generateArchitecture(outCore);
 289   }
 290   catch(Exception err) {
 291     throw(err);
 292   }
 293
 294   vhdlCore.close();
 295 }
 296
 297
 298 void GroupBlock::generateComments(QTextStream& out) throw(Exception) {
 299   out << " -- VHDL generated automatically for " << name << " --" << endl << endl;
 300 }
 301
 302 void GroupBlock::generateLibraries(QTextStream& out) throw(Exception) {
 303
 304   out << "library IEEE;" << endl;
 305   out << "use IEEE.STD_LOGIC_1164.all;" << endl;
 306   out << "use IEEE.numeric_std.all;" << endl;
 307
 308 }
 309
 310 void GroupBlock::generateEntity(QTextStream& out) throw(Exception) {
 311
 312   int i;
 313
 314   out << "entity " << name << " is " << endl;
 315
 316   QList<BlockParameter*> listGenerics = getGenericParameters();
 317   QList<AbstractInterface*> listInputs = getInputs();
 318   QList<AbstractInterface*> listOutputs = getOutputs();
 319   QList<AbstractInterface*> listBidirs = getBidirs();
 320
 321   if (!listGenerics.isEmpty()) {
 322     out << "  generic (" << endl;
 323     for(i=0;i<listGenerics.size()-1;i++) {
 324       out << "    " << listGenerics.at(i)->toVHDL(BlockParameter::Entity, 0) << endl;
 325     }
 326     out << "    " << listGenerics.at(i)->toVHDL(BlockParameter::Entity,BlockParameter::NoComma) << endl;
 327     out << "    );" << endl;
 328   }
 329
 330   out << "  port (" << endl;
 331
 332   // Generation of the clk & rst signals
 333   out << "    -- clk/rst" << endl;
 334   foreach(AbstractInterface* iface, listInputs) {
 335     if(iface->getPurpose() == AbstractInterface::Clock || iface->getPurpose() == AbstractInterface::Reset) {
 336       out << "    " << iface->getName() << " : in std_logic;" << endl;
 337     }
 338   }
 339
 340   int count = 0;
 341   foreach(AbstractInterface* iface, getInterfaces()) {
 342     if((iface->getPurpose() == AbstractInterface::Data)||(iface->getPurpose() == AbstractInterface::Control)) count++;
 343   }
 344   // Generation of the data/control signals
 345
 346   int flag = 0;
 347   bool first = true;
 348
 349   foreach(AbstractInterface* iface, listInputs) {
 350     if(iface->getPurpose() == AbstractInterface::Data) {
 351       if (first) {
 352         out << "    -- input data ports" << endl;
 353         first = false;
 354       }
 355       count--;
 356       if (count == 0) flag = AbstractInterface::NoComma;
 357       out << "    " << iface->toVHDL(AbstractInterface::Entity, flag) << endl;
 358     }
 359   }
 360   first = true;
 361   foreach(AbstractInterface* iface, listInputs) {
 362     if(iface->getPurpose() == AbstractInterface::Control) {
 363       if (first) {
 364         out << "    -- input control ports" << endl;
 365         first = false;
 366       }
 367       count--;
 368       if (count == 0) flag = AbstractInterface::NoComma;
 369       out << "    " << iface->toVHDL(AbstractInterface::Entity, flag) << endl;
 370     }
 371   }
 372   first = true;
 373   foreach(AbstractInterface* iface, listOutputs) {
 374     if(iface->getPurpose() == AbstractInterface::Data) {
 375       if (first) {
 376         out << "    -- output data ports" << endl;
 377         first = false;
 378       }
 379       count--;
 380       if (count == 0) flag = AbstractInterface::NoComma;
 381       out << "    " << iface->toVHDL(AbstractInterface::Entity, flag) << endl;
 382     }
 383   }
 384   first = true;
 385   foreach(AbstractInterface* iface, listOutputs) {
 386     if(iface->getPurpose() == AbstractInterface::Control) {
 387       if (first) {
 388         out << "    -- output control ports" << endl;
 389         first = false;
 390       }
 391       count--;
 392       if (count == 0) flag = AbstractInterface::NoComma;
 393       out << "    " << iface->toVHDL(AbstractInterface::Entity, flag) << endl;
 394     }
 395   }
 396   first = true;
 397   foreach(AbstractInterface* iface, listBidirs) {
 398     if(iface->getPurpose() == AbstractInterface::Data) {
 399       if (first) {
 400         out << "    -- bidirs data ports" << endl;
 401         first = false;
 402       }
 403       count--;
 404       if (count == 0) flag = AbstractInterface::NoComma;
 405       out << "    " << iface->toVHDL(AbstractInterface::Entity, flag) << endl;
 406     }
 407   }
 408   out << "    );" << endl << endl;
 409   out << "end " << name << ";" << endl << endl;
 410
 411 }
 412
 413 void GroupBlock::generateArchitecture(QTextStream& out) throw(Exception) {
 414
 415 }
 416