diff options
-rwxr-xr-x | Debian/Ubuntu 14.04/install-nghdl.sh | 6 | ||||
-rw-r--r-- | Debian/Ubuntu 16.04/ghdl-0.36.tar.xz (renamed from Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz) | bin | 9220896 -> 9220896 bytes | |||
-rwxr-xr-x | Debian/Ubuntu 16.04/install-nghdl.sh (renamed from Debian/Ubuntu 16.04+/install-nghdl.sh) | 6 | ||||
-rw-r--r-- | Debian/Ubuntu 18.04/ghdl-0.36.tar.xz | bin | 0 -> 3866028 bytes | |||
-rwxr-xr-x | Debian/Ubuntu 18.04/install-nghdl.sh | 278 | ||||
-rw-r--r-- | Debian/readme.md | 59 | ||||
-rw-r--r-- | readme.md | 2 |
7 files changed, 332 insertions, 19 deletions
diff --git a/Debian/Ubuntu 14.04/install-nghdl.sh b/Debian/Ubuntu 14.04/install-nghdl.sh index 560b4df..905897f 100755 --- a/Debian/Ubuntu 14.04/install-nghdl.sh +++ b/Debian/Ubuntu 14.04/install-nghdl.sh @@ -81,6 +81,8 @@ function installDependency cd ghdl-0.36/ #Copy compiled ghdl to system path sudo cp bin/* /usr/local/bin/ + #Make it executable + sudo chmod 755 /usr/local/bin/ghdl* if [ $? -ne 0 ]; then echo "Unable to install ghdl-0.36 LLVM (@bin)" echo "Exiting installation..." @@ -158,6 +160,8 @@ function installNgspice echo "Remove earlier installations at /usr/bin/ngspice and try again..." exit 1 else + #Make it executable + sudo chmod 755 /usr/bin/ngspice echo "Added softlink for Ngspice" fi @@ -213,6 +217,8 @@ function createSoftLink echo "Remove earlier installations at /usr/local/bin/nghdl and try again..." exit 1 else + #Make it executable + sudo chmod 755 nghdl echo "Added softlink for NGHDL..............................." fi fi diff --git a/Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz b/Debian/Ubuntu 16.04/ghdl-0.36.tar.xz Binary files differindex 30cd636..30cd636 100644 --- a/Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz +++ b/Debian/Ubuntu 16.04/ghdl-0.36.tar.xz diff --git a/Debian/Ubuntu 16.04+/install-nghdl.sh b/Debian/Ubuntu 16.04/install-nghdl.sh index 221487c..6080018 100755 --- a/Debian/Ubuntu 16.04+/install-nghdl.sh +++ b/Debian/Ubuntu 16.04/install-nghdl.sh @@ -81,6 +81,8 @@ function installDependency cd ghdl-0.36/ #Copy compiled ghdl to system path sudo cp bin/* /usr/local/bin/ + #Make it executable + sudo chmod 755 /usr/local/bin/ghdl* if [ $? -ne 0 ]; then echo "Unable to install ghdl-0.36 LLVM (@bin)" echo "Exiting installation..." @@ -158,6 +160,8 @@ function installNgspice echo "Remove earlier installations at /usr/bin/ngspice and try again..." exit 1 else + #Make it executable + sudo chmod 755 /usr/bin/ngspice echo "Added softlink for Ngspice" fi @@ -213,6 +217,8 @@ function createSoftLink echo "Remove earlier installations at /usr/local/bin/nghdl and try again..." exit 1 else + #Make it executable + sudo chmod 755 nghdl echo "Added softlink for NGHDL..............................." fi fi diff --git a/Debian/Ubuntu 18.04/ghdl-0.36.tar.xz b/Debian/Ubuntu 18.04/ghdl-0.36.tar.xz Binary files differnew file mode 100644 index 0000000..a4a161f --- /dev/null +++ b/Debian/Ubuntu 18.04/ghdl-0.36.tar.xz diff --git a/Debian/Ubuntu 18.04/install-nghdl.sh b/Debian/Ubuntu 18.04/install-nghdl.sh new file mode 100755 index 0000000..b3439ca --- /dev/null +++ b/Debian/Ubuntu 18.04/install-nghdl.sh @@ -0,0 +1,278 @@ +#!/bin/bash +#=============================================================================== +# FILE: install-nghdl.sh +# +# USAGE: ./install-nghdl.sh --install +# or +# ./install-nghdl.sh --uninstall +# +# DESCRIPTION: It is installation script for ngspice and ghdl work (nghdl). +# +# OPTIONS: --- +# REQUIREMENTS: --- +# BUGS: --- +# NOTES: --- +# AUTHOR: Fahim Khan, Rahul Paknikar +# ORGANIZATION: eSim, FOSSEE group at IIT Bombay +# CREATED: Monday 20 January 2020 16:30 +# REVISION: --- +#=============================================================================== + +ngspice="ngspice-nghdl" +ghdl="ghdl-0.36" +config_dir="$HOME/.nghdl" +config_file="config.ini" +src_dir=`pwd` + +#Will be used to take backup of any file +sysdate="$(date)" +timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'` + + +#All functions goes here +function installDependency +{ + + echo "Installing Make..........................................." + sudo apt install -y make + if [ $? -ne 0 ]; then + echo -e "\n\n\"Make\" dependency couldn't be installed.\nKindly resolve above errors and try again." + exit 1 + fi + + echo "Installing GNAT-5........................................." + sudo apt install -y gnat-5 + if [ $? -ne 0 ]; then + echo -e "\n\n\"GNAT\" dependency couldn't be installed.\nKindly resolve above errors and try again." + exit 1 + fi + + echo "Installing Zlib1g-dev....................................." + sudo apt install -y zlib1g-dev + if [ $? -ne 0 ]; then + echo -e "\n\n\"Zlib1g-dev\" dependency couldn't be installed.\nKindly resolve above errors and try again." + exit 1 + fi + + # Specific dependency for canberra-gtk modules + echo "Installing Gtk Canberra modules..........................." + sudo apt install -y libcanberra-gtk-module libcanberra-gtk3-module + if [ $? -ne 0 ]; then + echo -e "\n\n\"canberra-gtk-module\" dependency couldn't be installed.\nKindly resolve above errors and try again." + exit 1 + fi + + # Specific dependency for nvidia graphic cards + echo "Installing graphics dependency for ngspice souce build" + echo "Installing libxaw7........................................" + sudo apt install -y libxaw7 + if [ $? -ne 0 ]; then + echo -e "\n\n\"libxaw7\" dependency couldn't be installed.\nKindly resolve above errors and try again." + exit 1 + fi + + echo "Installing libxaw7-dev...................................." + sudo apt install -y libxaw7-dev + if [ $? -ne 0 ]; then + echo -e "\n\n\"libxaw7-dev\" dependency couldn't be installed.\nKindly resolve above \"apt-get\" errors and try again." + exit 1 + fi + + + echo "Installing GHDL-0.36 LLVM................................." + grep -h "ghdl" /usr/local/bin/ghdl > /dev/null + if [ $? -ne 0 ]; then + tar -xJf ghdl-0.36.tar.xz + if [ "$?" == 0 ]; then + echo "ghdl-0.36 successfully extracted.................." + echo "Changing directory to ghdl-0.36 installation......" + cd ghdl-0.36/ + #Copy compiled ghdl to system path + sudo cp bin/* /usr/local/bin/ + #Make it executable + sudo chmod 755 /usr/local/bin/ghdl* + if [ $? -ne 0 ]; then + echo "Unable to install ghdl-0.36 LLVM (@bin)" + echo "Exiting installation..." + exit 1 + fi + sudo cp include/* /usr/local/include/ + if [ $? -ne 0 ]; then + echo "Unable to install ghdl-0.36 LLVM (@include)" + echo "Exiting installation..." + exit 1 + fi + sudo cp -r lib/* /usr/local/lib/ + if [ $? -ne 0 ]; then + echo "Unable to install ghdl-0.36 LLVM (@lib)" + echo "Exiting installation..." + exit 1 + fi + echo "Removing unused part of ghdl-0.36 LLVM..." + rm -rf ../ghdl-0.36 + echo "GHDL installed successfully......................." + else + echo "Unable to extract ghdl-0.36 LLVM" + echo "Exiting installation" + exit 1 + fi + else + echo "GHDL already exists..." + echo "Leaving ghdl-0.36 LLVM installation" + fi + +} + + +function installNgspice +{ + + echo "Installing Ngspice........................................" + #Checking if ngspice-nghdl directory is already present in Home directory + if [ -d $HOME/$ngspice ];then + echo "$ngspice directory already exists at $HOME" + echo "Leaving Ngspice installation..." + else + #Extracting Ngspice to Home Directory + cd $src_dir + tar -xJf $ngspice.tar.xz -C $HOME + if [ "$?" == 0 ];then + echo "Ngspice extracted sucessfuly to $HOME" + #change to ngspice-nghdl directory + cd $HOME/$ngspice + #Make local install directory + mkdir -p install_dir + #Make release directory for build + mkdir -p release + #Change to release directory + cd release + echo "Configuring Ngspice..." + sleep 2 + ../configure --enable-xspice --disable-debug --prefix=$HOME/$ngspice/install_dir/ --exec-prefix=$HOME/$ngspice/install_dir/ + + #dirty fix for adding patch to ngspice base code + cp $src_dir/src/outitf.c $HOME/$ngspice/src/frontend + + make + make install + if [ "$?" == 0 ];then + echo "Removing previously installed Ngspice (if any)..." + sudo apt-get purge -y ngspice + + echo "Ngspice installed sucessfully................." + echo "Adding softlink for the installed Ngspice....." + + sudo ln -s $HOME/$ngspice/install_dir/bin/ngspice /usr/bin/ngspice + if [ $? -ne 0 ];then + echo "Failed to add Ngspice softlink" + echo "Remove earlier installations at /usr/bin/ngspice and try again..." + exit 1 + else + #Make it executable + sudo chmod 755 /usr/bin/ngspice + echo "Added softlink for Ngspice" + fi + + else + echo "There was some error while installing Ngspice" + fi + + else + echo "Unable to extract Ngspice tar file" + exit 1; + fi + fi + +} + + +function createConfigFile +{ + + #Creating config.ini file and adding configuration information + #Check if config file is present + if [ -d $config_dir ];then + rm $config_dir/$config_file && touch $config_dir/$config_file + else + mkdir $config_dir && touch $config_dir/$config_file + fi + + echo "[NGSPICE]" >> $config_dir/$config_file + echo "NGSPICE_HOME = $HOME/$ngspice" >> $config_dir/$config_file + echo "DIGITAL_MODEL = %(NGSPICE_HOME)s/src/xspice/icm/ghdl" >> $config_dir/$config_file + echo "RELEASE = %(NGSPICE_HOME)s/release" >> $config_dir/$config_file + echo "[SRC]" >> $config_dir/$config_file + echo "SRC_HOME = $src_dir" >> $config_dir/$config_file + echo "LICENSE = %(SRC_HOME)s/LICENSE" >> $config_dir/$config_file + +} + + +function createSoftLink +{ + + ## Creating softlink + cd /usr/local/bin + if [[ -L nghdl ]];then + echo "Symlink was already present" + sudo unlink nghdl + sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl + else + echo "Creating symlink" + sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl + if [ $? -ne 0 ];then + echo "Failed to add NGHDL softlink" + echo "Remove earlier installations at /usr/local/bin/nghdl and try again..." + exit 1 + else + #Make it executable + sudo chmod 755 /usr/bin/nghdl + echo "Added softlink for NGHDL..............................." + fi + fi + cd $pwd + +} + + +##################################################################### +# Script start from here # +##################################################################### + +###Checking if file is passsed as argument to script + +if [ "$#" -eq 1 ];then + option=$1 +else + echo "USAGE : " + echo "./install-nghdl.sh --install" + exit 1; +fi + +##Checking flags +if [ $option == "--install" ];then + + #Calling functions + installDependency + if [ $? -ne 0 ];then + echo -e "\n\n\nERROR: Unable to install required packages. Please check your internet connection.\n\n" + exit 0 + fi + installNgspice + createConfigFile + createSoftLink + +elif [ $option == "--uninstall" ];then + echo "Removing NGHDL....................." + sudo rm -rf $HOME/ngspice-nghdl $HOME/.nghdl /usr/share/kicad/library/eSim_Nghdl.lib /usr/local/bin/nghdl /usr/bin/ngspice + echo "Removing libxaw7-dev..............." + sudo apt purge -y libxaw7-dev + echo "Removing GHDL............." + sudo rm -rf /usr/local/bin/ghdl /usr/local/bin/ghdl1-llvm /usr/local/lib/ghdl /usr/local/lib/libghdlvpi.so /usr/local/include/vpi_user.h + echo "Removing GNAT-5...................." + sudo apt purge -y gnat-5 +else + echo "Please select the proper operation." + echo "--install" + echo "--uninstall" +fi diff --git a/Debian/readme.md b/Debian/readme.md index 8bd5e21..08f1411 100644 --- a/Debian/readme.md +++ b/Debian/readme.md @@ -5,22 +5,26 @@ Debian Installer Documentation It contains all the documenation for installers on Debian (Ubuntu 14.04 and above). -## Separation of Ubuntu 14.04 and Ubuntu 16.04+ installers: -1. Dependency of gnat : - a. Ubuntu 14.04 : gnat (v4.6) - b. Ubuntu 16.04+: gnat-5 (v5.4) -2. Dependency of llvm : +## Differences in Ubuntu 14.04, Ubuntu 16.04 and Ubuntu 18.04 installers: +1. Dependency on gnat : + - Ubuntu 14.04 : gnat (v4.6) + - Ubuntu 16.04+: gnat-5 (v5.4) +2. Dependency on llvm : - Available version on Ubuntu 14.04 : llvm (v3.4) - - Available version on Ubuntu 16.04+ : llvm (v3.4) + - Available version on Ubuntu 16.04 : llvm (v3.5) + - Available version on Ubuntu 18.04 : llvm (v6.0) - Requires llvm version between 3.5 and 3.9 for compilation of GHDL with llvm config +3. Dependency on gcc : + - Ubuntu 14.04 and 16.04 : gcc (v5.4.0) is available without pie (i.e. position-independent executable) + - Ubuntu 18.04 : gcc (v7.4.0) is available with pie enabled as default option. + - Refer [this](https://github.com/ghdl/ghdl/issues/213) Github issue for dependency on gcc GHDL on Ubuntu 18.04 and above. -##GHDL Compilation: -1. Following steps are OS specific and GHDL executables should be generated on that system for distribution on -same OS configuration. -2. For distribution of GHDL on Ubuntu 14.04, directly use the llvm code provided on GHDL's github page. -3. For distribution of GHDL on Ubuntu 16.04 and above, follow the steps: - a. Download source code from GHDL's github page. +## GHDL Compilation: +1. Compilation of GHDL is OS specific and GHDL executables should be generated on that system for distribution on same OS configuration. +2. For distribution of GHDL (v0.36) on Ubuntu 14.04, directly use the llvm executable provided on GHDL's Github page. +3. For distribution of GHDL (v0.36) on Ubuntu 16.04 and above, follow the steps: + a. Download source code (v0.36) from GHDL's Github page. b. Extract the tar file, open a terminal and change directory one-level inside. c. First install gnat dependency as: @@ -28,21 +32,40 @@ same OS configuration. d. Install llvm dependency and verify that version of llvm is between 3.5 and 3.9 - $ sudo apt install llvm + - For Ubuntu 16.04 : - e. To compile GHDL, type following commands: + $ sudo apt install llvm + + - For Ubuntu 18.04 : + + $ sudo apt install llvm-3.9 + + e. Install clang dependency: + + $ sudo apt install clang + + + f. To compile GHDL, type following commands: $ mkdir -p install_dir $ mkdir -p release $ cd release/ - $ ../configure --with-llvm-config --prefix=<absolute_path_to_install_dir> + + - For Ubuntu 16.04 : + + $ ../configure --with-llvm-config --prefix=<absolute_path_to_install_dir> + + - For Ubuntu 18.04 : + + $ ../configure --with-llvm-config=/usr/bin/llvm-config-3.9 --prefix=<absolute_path_to_install_dir> + $ make $ make install f. GHDL executables will be made in install_dir folder which can be used for distribution. - g. Note that target machine should have the same version of gnat as that of the source machine on which - GHDL was compiled. + g. Note that target machine should have the same version of gnat and OS as that of the source machine on which GHDL was compiled. + -##How to package GHDL executable with NGHDL? +## How to package GHDL executable with NGHDL? 1. Rename `install_dir` directory to the `ghdl-<version>` and compress it to `.tar.xz` format. 2. Place this compressed file along with the installer file (`install-nghdl.sh`) in the `nghdl` folder. @@ -4,7 +4,7 @@ NGHDL Installers It contains all the documenation for making installations on various platforms. -##How to package NGHDL with eSim? +## How to package NGHDL with eSim? 1. Add GHDL executable and the corresponding installer for the target OS in the `nghdl` folder. > Note : Instructions on how to generate GHDL executable and distribute it are provided under |