Improved installation & bugfixes in prga.py

.gitignore

@@ -1,6 +1,10 @@
 docs/build
 docs/.eggs
 
+.python-version
+local
+pyenv
+
 examples/fpga/*/*/*
 !examples/fpga/*/*/build.py
 !examples/fpga/*/*/Makefile

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "prga.py"]
 	path = prga.py
 	url = https://github.com/PrincetonUniversity/prga.py.git
+[submodule "vtr"]
+	path = vtr
+	url = https://github.com/verilog-to-routing/vtr-verilog-to-routing.git
+[submodule "yosys"]
+	path = yosys
+	url = https://github.com/YosysHQ/yosys.git

docs/source/intro.rst

@@ -13,19 +13,23 @@ Tools
 
 PRGA is dependent on the following third-party tools:
 
-* `Verilog-to-Routing <https://verilogtorouting.org/>`_
-* `Yosys <http://www.clifford.at/yosys/>`_
 * `Icarus Verilog <http://iverilog.icarus.com/>`_ or `Synopsys VCS
   <https://www.synopsys.com/verification/simulation/vcs.html>`_
 
-Python
-^^^^^^
+Installation
+------------
 
-PRGA works with Python 2.7.x and Python 3.7.x. However, Python 2.x will reach
-its end of life on `January 1st, 2020
-<https://www.python.org/doc/sunset-python-2/>`_ , so we recommend using Python
-3.7.x if possible.
+PRGA includes `Yosys <http://www.clifford.at/yosys/>`_ and `VTR
+<http://www.clifford.at/yosys/>`_ as submodules, 
+uses `pyenv <https://github.com/pyenv/pyenv>`_ and `pipenv
+<https://github.com/pypa/pipenv>`_ to manage Python interpretter and
+dependecies, and simplifies the installation with one single bash script that
+does not require root access:
 
+.. code-block:: bash
+
+    cd /path/to/prga/
+    ./envscr/install
 
 Examples
 --------
@@ -39,7 +43,7 @@ To build an FPGA, run the following commands:
 .. code-block:: bash
 
     cd /path/to/prga/                           # cd to the root 
-    source envscr/settings.sh                   # set up the environment
+    ./envscr/activate                           # activate the virtual environment
     cd examples/fpga/tiny/k4_N2_8x8             # choose one FPGA building example
     make                                        # build the FPGA!
 
@@ -49,6 +53,6 @@ following commands:
 .. code-block:: bash
 
     cd /path/to/prga/                           # cd to the root 
-    source envscr/settings.sh                   # set up the environment
+    ./envscr/activate                           # activate the virtual environment
     cd examples/target/bcd2bin/tiny_k4_N2_8x8   # choose one design and one FPGA
     make                                        # run all the way to verification

envscr/69a8e95.patch

@@ -0,0 +1,12 @@
+diff --git a/utils/fasm/src/fasm.cpp b/utils/fasm/src/fasm.cpp
+index ee7c7cd..ca81beb 100644
+--- a/utils/fasm/src/fasm.cpp
++++ b/utils/fasm/src/fasm.cpp
+@@ -603,6 +603,7 @@ void FasmWriterVisitor::walk_routing() {
+
+     for(const auto &trace : route_ctx.trace) {
+       t_trace *head = trace.head;
++      if (!head) continue;
+       t_rt_node* root = traceback_to_route_tree(head);
+       walk_route_tree(root);
+       free_route_tree(root);

envscr/activate

@@ -0,0 +1,46 @@
+function err() {
+    >&2 echo -e "\033[0;31m[ERROR]\033[0m" $@
+    exit 1
+}
+
+function info() {
+    echo -e "\033[0;34m[INFO]\033[0m" $@
+}
+
+if [ ! -z "${VIRTUAL_ENV}" ]; then
+    err "Already in a Python virtualenv"
+fi
+
+CWD=${PWD}
+OLD_PATH=$PATH
+cd "$( dirname "${BASH_SOURCE[0]}" )"/..    # move to PRGA_ROOT
+
+# choose the correct binaries
+info "Setting \$PATH"
+export PATH=${PWD}/local/bin:$PATH
+
+# activate pyenv
+if command -v pyenv 2>&1 >/dev/null; then
+    info "Active 'pyenv' found. Skipping installation/activation of 'pyenv'"
+else
+    info "Activating 'pyenv'"
+    export PYENV_ROOT=${PWD}/pyenv
+    export PATH=${PYENV_ROOT}/bin:$PATH
+    eval "$( pyenv init - )"
+    info "'pyenv' activated"
+fi
+
+# activate virtual env
+cd prga.py
+info "Entering virtual environment ..."
+PIPENV_VENV_IN_PROJECT=1 pipenv shell cd ${CWD}
+info "Leaving virtual environment ..."
+
+# roll back to the old state
+info "Reverting \$PATH"
+export PATH=$OLD_PATH
+cd $CWD
+
+info "Thanks for using PRGA. We look forward to your next use :)"
+
+# vim: set ft=sh:

envscr/install

@@ -0,0 +1,144 @@
+#!/usr/bin/env bash
+
+# Choose your desired compiler
+COMP=gcc
+MAKE_JOBCOUNT=8
+PYTHON_VERSION=3.7.2
+
+# Do not modify below this line
+CWD=${PWD}
+cd "$( dirname "${BASH_SOURCE[0]}" )"/..    # move to PRGA_ROOT
+
+trap "cd ${CWD}" EXIT
+trap "cd ${CWD}" SIGINT
+
+function err() {
+    >&2 echo -e "\033[0;31m[ERROR]\033[0m" $@
+    exit 1
+}
+
+function info() {
+    echo -e "\033[0;34m[INFO]\033[0m" $@
+}
+
+# find git
+GIT=$( command -v git 2>/dev/null )
+if [ -z "${GIT}" ]; then
+    err "'git' not found"
+fi
+info "Using 'git': ${GIT}"
+
+# find make
+MAKE=$( command -v make 2>/dev/null )
+if [ -z "${MAKE}" ]; then
+    err "'make' not found"
+fi
+info "Using 'make': ${MAKE}"
+
+# find cmake
+CMAKE=$( command -v cmake3 2>/dev/null )
+if [ -z "${CMAKE}" ]; then
+    CMAKE=$( command -v cmake 2>/dev/null )
+    if [ -z "${CMAKE}" ]; then
+        err "'cmake' not found"
+    elif [[ $( ${CMAKE} --version | cut -d " " -f 3 ) != "3"* ]]; then
+        err "CMake 3.x is required to build VPR"
+    fi
+fi
+info "Using 'cmake': ${CMAKE}"
+
+if [ -z "${COMP}" ]; then
+    COMP=gcc
+fi
+
+if [ -z "${MAKE_JOBCOUNT}" ]; then
+    MAKE_JOBCOUNT=8
+fi
+
+# find C compiler
+CC=$( command -v ${COMP} 2>/dev/null )
+if [ -z "${CC}" ]; then
+    err "'${COMP}' not found"
+fi
+info "Using '${COMP}': ${CC}"
+
+# find or install pyenv
+if command -v pyenv 2>&1 >/dev/null; then
+    info "Active 'pyenv' found. Skipping installation/activation of 'pyenv'"
+else
+    if [ ! -f pyenv/bin/pyenv ]; then
+        info "'pyenv' not found. Installing 'pyenv' locally to ${PWD}/pyenv"
+        ${GIT} clone https://github.com/pyenv/pyenv.git || exit 1
+        info "'pyenv' installed locally to ${PWD}/pyenv"
+    else
+        info "Locally-installed 'pyenv' found. Skipping installation of 'pyenv'"
+    fi
+
+    info "Activating locally-installed 'pyenv'"
+    export PYENV_ROOT=${PWD}/pyenv
+    export PATH=${PYENV_ROOT}/bin:$PATH
+    eval "$( pyenv init - )"
+    info "'pyenv' activated"
+fi
+
+# install the desired python if it's not installed already
+if [ -z "${PYTHON_VERSION}" ]; then
+    PYTHON_VERSION=3.7.2
+fi
+info "Installing Python ${PYTHON_VERSION} with 'pyenv'"
+pyenv install -s ${PYTHON_VERSION} || exit 1
+info "Python ${PYTHON_VERSION} installed with 'pyenv'"
+pyenv local ${PYTHON_VERSION} || exit 1
+if [[ $( python --version | cut -d " " -f 2 ) != "${PYTHON_VERSION}" ]]; then
+    err "'pyenv' is not choosing the correct Python version"
+fi
+info "Python ${PYTHON_VERSION} chosen as the local version"
+
+# install pipenv
+if [ -z "$( pip show pipenv 2>&1 >/dev/null )" ]; then
+    info "'pipenv' already installed. Skipping installation of 'pipenv'"
+else
+    info "Installing 'pipenv'"
+    pip install pipenv || exit 1
+    info "'pipenv' installed"
+fi
+
+# check out submodules
+info "Checking out submodules"
+${GIT} submodule update --init --recursive || exit 1
+
+mkdir -p local
+
+# build VTR
+info "Building VTR"
+cd vtr
+${GIT} apply ../envscr/69a8e95.patch 2>&1 >/dev/null
+${MAKE} -j${MAKE_JOBCOUNT} CMAKE=${CMAKE} || exit 1
+cd ..
+info "VTR built successfully"
+
+# build yosys
+info "Building Yosys"
+cd yosys
+${MAKE} -j${MAKE_JOBCOUNT} CONFIG=${COMP} || exit 1
+${MAKE} install CONFIG=${COMP} PREFIX=${PWD}/../local || exit 1
+cd ..
+info "Yosys built successfully"
+
+# link all binaries
+info "Linking binaries to ${PWD}/local/bin"
+cd local/bin
+ln -s -f ../../vtr/vpr/vpr vpr
+ln -s -f ../../vtr/build/utils/fasm/genfasm genfasm
+cd ../..
+
+# build a virtualenv for prga.py
+info "Creating a virtual environment for prga.py"
+cd prga.py
+PIPENV_VENV_IN_PROJECT=1 pipenv --python ${PYTHON_VERSION} install -e . || exit 1
+cd ..
+info "Virtual environment created for prga.py"
+
+info "Installation finished successfully"
+
+# vim: set ft=sh: