masc-ucsc / livehd Goto Github PK

https://github.com/masc-ucsc/lgraph/blob/5dbf3bc5801854df9691767e067f3441b6e935af/core/lgraphbase.hpp#L96

Must search across code for other API cases. Any return and pass of "std::string foo" should be const "std::string &foo" when possible.

Codacy detected an issue:

Message: Function parameter '_function' should be passed by reference.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 76
• Code: void set_function(std::string _function) { function = _function; }

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 77

CodeFactor found an issue: Check exit code directly with e.g. 'if mycmd;', not indirectly with $?.

It's currently on:
test\abc.sh:26

Codacy detected an issue:

Message: Member variable 'Tech_cell::height' is not initialized in the constructor.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 63
• Code: Tech_cell(std::string name, uint16_t id) : cell_name(name), id(id) {}

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 64

Codacy detected an issue:

Message: struct member 'index_bits::bits' is never used.

Occurred on:

• Commit: fef07e3
• File: inou/blif/inou_blif.hpp
• LineNum: 34
• Code: int bits[2];

Currently on:

• Commit: 39380e1
• File: inou/blif/inou_blif.hpp
• LineNum: 34

Codacy detected an issue:

Message: Function parameter 'path' should be passed by reference.

Occurred on:

• Commit: fef07e3
• File: core/lgwirenames.cpp
• LineNum: 3
• Code: LGraph_WireNames::LGraph_WireNames(std::string path, std::string name)

Currently on:

• Commit: 9c6a6d8
• File: core/lgwirenames.cpp
• LineNum: 3

The current pass directory structure has:

cse/
dce/
droute/
fluid/
gvn_pre/
lgopt/
lgopt_dce/
lgopt_fluid/
lgopt_gvn_pre/
vectorize/ 

The lgopt_* only have binaries for the respective passes (lgopt_dce and dce for instance).
We should get rid of the lgopt_ directories, either through the python interface or by using the shared lgopt/ binary.

However, there are test inputs in some of those directories that need to be preserved.
The regression tests also need to be updated to take the new location of the test inputs into account.

Codacy detected an issue:

Message: Uninitialized variable: pObj

Occurred on:

• Commit: fef07e3
• File: inou/abc/dump_lgraph.cpp
• LineNum: 32
• Code: Abc_NtkForEachNode(pNtk, pObj, k) {

Currently on:

• Commit: 9c6a6d8
• File: inou/abc/dump_lgraph.cpp
• LineNum: 87

Hi Rafael,

I saw this, but I did not want to fix because you are working on it. The idea is to avoid code replication:

Found 6 duplicate lines with fingerprint b53414fc0bea3244708a22d18c9af296 in the following files:
Between lines 256 and 264 in /mada/users/renau/projs/lgraph/core/lgedgeiter.hpp
Between lines 152 and 160 in /mada/users/renau/projs/lgraph/core/lgedgeiter.hpp
Found 6 duplicate lines with fingerprint 82e00c78ebbd6bb2f90f7fcdca435c5e in the following files:
Between lines 886 and 891 in /mada/users/renau/projs/lgraph/core/lgraphbase.cpp
Between lines 849 and 854 in /mada/users/renau/projs/lgraph/core/lgraphbase.cpp
Found 9 duplicate lines with fingerprint 01907d7871adaef31d4f05c1fb573cf1 in the following files:
Between lines 191 and 203 in /mada/users/renau/projs/lgraph/core/lgedgeiter.hpp
Between lines 298 and 310 in /mada/users/renau/projs/lgraph/core/lgedgeiter.hpp

Codacy detected an issue:

Message: Function parameter '_path' should be passed by reference.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 266
• Code: Tech_library(std::string _path) {

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 274

Codacy detected an issue:

Message: Exception should be caught by reference.

Occurred on:

• Commit: fef07e3
• File: cops/live/lglive.cpp
• LineNum: 31
• Code: } catch (std::exception e) {

Currently on:

• Commit: 9c6a6d8
• File: cops/live/lglive.cpp
• LineNum: 31

Codacy detected an issue:

Message: Function parameter 'name' should be passed by reference.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 63
• Code: Tech_cell(std::string name, uint16_t id) : cell_name(name), id(id) {}

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 64

In general, we should change all the
std::string xxx pass to methods to
const std::string &xxx

Codacy detected an issue:

Message: Function parameter 'instance' should be passed by reference.

Occurred on:

• Commit: fef07e3
• File: cops/live/diff_finder.hpp
• LineNum: 28
• Code: Graph_Node(LGraph* module, Index_ID idx, uint32_t bit, std::string instance, Port_ID pid) :

Currently on:

• Commit: 1be7426
• File: cops/live/diff_finder.hpp
• LineNum: 26

Codacy detected an issue:

Message: Tips depend on target shell and yours is unknown. Add a shebang.

Occurred on:

• Commit: fef07e3
• File: test/synth.sh
• LineNum: 1
• Code: ``

Currently on:

• Commit: 9c6a6d8
• File: test/synth.sh
• LineNum: 1

Codacy detected an issue:

Message: Function parameter 'out' should be passed by reference.

Occurred on:

• Commit: fef07e3
• File: core/inou.cpp
• LineNum: 55
• Code: void Inou_trivial::generate(std::vector<const LGraph *> out) {

Currently on:

• Commit: 39380e1
• File: core/inou.cpp
• LineNum: 55

Codacy detected an issue:

Message: Unused import glob

Occurred on:

• Commit: fef07e3
• File: inou/tech/lib_parser.py
• LineNum: 7
• Code: import glob

Currently on:

• Commit: 39380e1
• File: inou/tech/lib_parser.py
• LineNum: 7

Codacy detected an issue:

Message: Class 'Tech_library' has a constructor with 1 argument that is not explicit.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 266
• Code: Tech_library(std::string _path) {

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 274

Codacy detected an issue:

Message: Unused import argparse

Occurred on:

• Commit: fef07e3
• File: inou/tech/timing_parser.py
• LineNum: 6
• Code: import argparse

Currently on:

• Commit: 39380e1
• File: inou/tech/timing_parser.py
• LineNum: 6

Use Node_Internal_Page to keep the file size in the first one. 4K savings :)

Use the clang code coverage compilation (gather stats only for lgraph, no subs)
http://logan.tw/posts/2015/04/28/check-code-coverage-with-clang-and-lcov/

Run the code coverage with Jenkins

Integrate with codecov to upload the generated code coverage to codecov
https://github.com/codecov/example-cpp11-cmake

Codacy detected an issue:

Message: Class 'Inou_trivial' has a constructor with 1 argument that is not explicit.

Occurred on:

• Commit: fef07e3
• File: core/inou.hpp
• LineNum: 32
• Code: Inou_trivial(Options_pack opt) : opack(opt) {}

Currently on:

• Commit: 39380e1
• File: core/inou.hpp
• LineNum: 32

Codacy detected an issue:

Message: Undefined behaviour, pointer arithmetic 'val-1' is out of bounds.

Occurred on:

• Commit: fef07e3
• File: core/tests/iterator_tst.cpp
• LineNum: 59
• Code: RConstPodIterator rend() const { return RConstPodIterator(val-1); }

Currently on:

• Commit: 9c6a6d8
• File: core/tests/iterator_tst.cpp
• LineNum: 59

The code is there for the forward, the backward is NOT. Bogus code.

We use to have a reverse edge method when the graph was unidirectional. The code is all over. We should remove it and make sure that the removed places work fine.

Codacy detected an issue:

Message: Uninitialized variable: pTerm

Occurred on:

• Commit: fef07e3
• File: inou/abc/dump_lgraph.cpp
• LineNum: 130
• Code: Abc_NtkForEachPi(pNtk, pTerm, i) {

Currently on:

• Commit: 9c6a6d8
• File: inou/abc/dump_lgraph.cpp
• LineNum: 29

Codacy detected an issue:

Message: Class 'RConstPodIterator' has a constructor with 1 argument that is not explicit.

Occurred on:

• Commit: fef07e3
• File: core/tests/iterator_tst.cpp
• LineNum: 33
• Code: RConstPodIterator(const DataType *ptr): ptr(ptr){}

Currently on:

• Commit: 39380e1
• File: core/tests/iterator_tst.cpp
• LineNum: 33

Codacy detected an issue:

Message: fprintf format string requires 3 parameters but only 2 are given.

Occurred on:

• Commit: fef07e3
• File: misc/def/defrw/defrw.cpp
• LineNum: 2552
• Code: fprintf(fout, "- MACRO %s THRUPIN %s %s ",

Currently on:

• Commit: 39380e1
• File: misc/def/defrw/defrw.cpp
• LineNum: 2552

Codacy detected an issue:

Message: Return value of function log() is not used.

Occurred on:

• Commit: fef07e3
• File: inou/yosys/out_yosys.cpp
• LineNum: 28
• Code: log("\n");

Currently on:

• Commit: 9c6a6d8
• File: inou/yosys/out_yosys.cpp
• LineNum: 28

Codacy detected an issue:

Message: Memory leak: xl

Occurred on:

• Commit: fef07e3
• File: misc/lef/lefwrite/lefwrite.cpp
• LineNum: 1171
• Code: CHECK_STATUS(status);

Currently on:

• Commit: 39380e1
• File: misc/lef/lefwrite/lefwrite.cpp
• LineNum: 1171

Codacy detected an issue:

Message: Variable 'pObj->pData' is reassigned a value before the old one has been used.

Occurred on:

• Commit: fef07e3
• File: inou/abc/abc_cell.cpp
• LineNum: 173
• Code: pObj->pData = Hop_And((Hop_Man_t *) pAig->pManFunc, Hop_IthVar((Hop_Man_t *) pAig->pManFunc, 0),

Currently on:

• Commit: 39380e1
• File: inou/abc/abc_cell.cpp
• LineNum: 173

Codacy detected an issue:

Message: Assignment of function parameter has no effect outside the function. Did you forget dereferencing it?

Occurred on:

• Commit: fef07e3
• File: core/mmap_allocator.hpp
• LineNum: 138
• Code: p = nullptr;

Currently on:

• Commit: 9c6a6d8
• File: core/mmap_allocator.hpp
• LineNum: 138

It is a problem to copy Graph_Nodes by mistake (edges) get out of graph, and stops working properly.

Difficult bugs to catch.

The solution is to avoid a public constructor for Graph_Node and lgedges

Codacy detected an issue:

Message: Unused import sys

Occurred on:

• Commit: fef07e3
• File: inou/tech/lib_parser.py
• LineNum: 8
• Code: import sys

Currently on:

• Commit: 39380e1
• File: inou/tech/lib_parser.py
• LineNum: 8

graph->flatten(std::vector subs);

This flatten command would flatten to the main graph calling the subgraphs included in list. If list if empty, it flattens (recursively) everything.

Codacy detected an issue:

Message: Statements following return, break, continue, goto or throw will never be executed.

Occurred on:

• Commit: fef07e3
• File: core/lgedge.cpp
• LineNum: 85
• Code: assert(false); // Not found all over

Currently on:

• Commit: 1be7426
• File: core/lgedge.cpp
• LineNum: 83

After nodes are deleted, we want to reuse the space opened for new nodes.

• Keep a list of free nodes using the alignment node space
• Whenever a node is deleted, add the ID in the free node list right before the ID page
• Keep a pointer to the first alignment node with free space in NID 0 to prevent having to search
• When a node is added, check if there are free nodes before allocating extra space

Since we need a binary for our python, we need to create what is called a bdist_wheel in pip

https://packaging.python.org/tutorials/distributing-packages/

The issue is that to create a bdist, we need to use an old linux (centos) which in python world, is called manylinux1

https://www.python.org/dev/peps/pep-0513/

To do so, we should create a centos docker image (see previous link for prebuild image), and compile
the python package (lgraph) inside.

Let's create this as a first step with a simple "hello" in C++ class using the lgraph pip package.

The login is renau
The pip password for lgraph is XXX (send me an email to ask)

Created the docs/Python.md to document how to build python, upload, and use

Current forward/backward does not visit subgraphs. It can be done manually opennning
the subgraph, but not neat.

The idea is to have the same forward/backward/fast iterators but with a non default option of also traversing subgraphs.

(Add a loop detector and raise exception of needed)

Codacy detected an issue:

Message: struct member 'tech_layer_s_::spctb_prl' is never used.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 225
• Code: double spctb_prl; // parallel running length

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 233

Codacy detected an issue:

Message: The scope of the variable 'Command' can be reduced.

Occurred on:

• Commit: fef07e3
• File: inou/abc/dump_aig.cpp
• LineNum: 49
• Code: char Command[1000];

Currently on:

• Commit: 1be7426
• File: inou/abc/dump_aig.cpp
• LineNum: 49

Codacy detected an issue:

Message: The scope of the variable 'pNet' can be reduced.

Occurred on:

• Commit: fef07e3
• File: inou/abc/dump_lgraph.cpp
• LineNum: 326
• Code: Abc_Obj_t *pTerm, *pNet;

Currently on:

• Commit: 9c6a6d8
• File: inou/abc/dump_lgraph.cpp
• LineNum: 421

Codacy detected an issue:

Message: struct member 'tech_layer_s_::horizontal' is never used.

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 217
• Code: bool horizontal;

Currently on:

• Commit: 9c6a6d8
• File: core/tech_library.hpp
• LineNum: 225

CFG just needs type, srcloc

Synth only, does not need place,route....

At graph open, we should populate only if fields are needed. Assertion checking otherwise.

The graph storage should remember fields are load-time. If we force a new field, we may want to use the default contructor. Eg: if we get a synth graph, and add place, we just put 0 for all the placement fields.

Codacy detected an issue:

Message: Uninitialized variable: pLatch

Occurred on:

• Commit: fef07e3
• File: inou/abc/dump_lgraph.cpp
• LineNum: 112
• Code: Abc_NtkForEachLatch(pNtk, pLatch, i) {

Currently on:

• Commit: 1be7426
• File: inou/abc/dump_lgraph.cpp
• LineNum: 112

Codacy detected an issue:

Message: Class 'mmap_allocator' has a constructor with 1 argument that is not explicit.

Occurred on:

• Commit: fef07e3
• File: core/mmap_allocator.hpp
• LineNum: 25
• Code: mmap_allocator(const std::string& filename) : mmap_base(0), file_size(0), mmap_size(0), mmap_capacity(0), mmap_fd(-1), alloc(0), mmap_name(filename) {

Currently on:

• Commit: 9c6a6d8
• File: core/mmap_allocator.hpp
• LineNum: 25

Codacy detected an issue:

Message: Uninitialized struct member: aPin.dir

Occurred on:

• Commit: fef07e3
• File: core/tech_library.hpp
• LineNum: 82
• Code: pins.push_back(aPin);

Currently on:

• Commit: 1be7426
• File: core/tech_library.hpp
• LineNum: 83

The current inou class has "generate" and parses the parameters.

Change to the interface to prepare for python integration. Remove the generate, and replace with an interface similar to the python

lgraph.inou.path = "./lgdb" # lgraph.inou.set_path(const std::string &path)

lgraph.open("xx", [options]) # Raw graph in lgdb path

lgraph.rand.read("graph_name", [some options])
lgraph.rand.xxx = xxx # sets one of the options. in C++ set_xxx(xxx)

lgraph.json.read("file", ["graph_name"])
lgraph.json.write("file", [some options])
lgraph.json.xxx = xx # sets one option like (compressed json or not)

lgraph.pyrope.read() # Not suported in pyrope
lgraph.pyrope.write("file.prp")
lgraph.pyrope.xxx = xx # options like indentation...

The arguments would be processed in the lg*.cpp main file.

The tests for abc runtime are pretty high.
I assume it is the checking, since all other tasks should be pretty fast.

Check if there are options to try to speed up the check.
If we are able to move to yosys for the testing (which include generating verilog) the tests should be faster (they should be roughly the same as for the yosys inou tests).

Codacy detected an issue:

Message: fprintf format string requires 4 parameters but only 2 are given.

Occurred on:

• Commit: fef07e3
• File: inou/sat/lgsat_multibit.cpp
• LineNum: 359
• Code: fprintf(stderr,"lima_node%d:%d -> node%d:%d TSTbck\n"

Currently on:

• Commit: 9c6a6d8
• File: inou/sat/lgsat_multibit.cpp
• LineNum: 359