|
# FAQ
|
|
# FAQ
|
|
|
|
**Q:** *I can't install SBT! I've dowloaded it from the [project website](http://www.scala-sbt.org/), but when I run it, the installation fails with incomprehensible error messages!*
|
|
|
|
|
|
|
|
**A:** Make sure you're not using Java JRE/JDK 9; for some reason, SBT fails to install on JRE/JDK 9, use 8 or 7 instead. It also seems to be recommendable to install the Oracle JDK instead of OpenJDK. Not sure why, but performance and stability was much better on our systems (will probably be fixed soon, so it should be safe to ignore this if you don't have any troubles so far). You can check your Java version by running `java -version` in the terminal. If it reports the wrong version, try to fix the `$PATH` and `$JAVA_HOME` environment variables manually and run `java -version` again.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
**Q:** *I've managed to install SBT and all the stuff, but now I ran the unit tests via `sbt test` and all of them fail! What kind of crappy software are you releasing here?!*
|
|
|
|
|
|
|
|
**A:** Chill. Move to the TPC main directory and source the setup script: `. setup.sh`. This will set the `$TPC_HOME` environment variable, which likely caused the issues, try to run `sbt test` again. :-)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
**Q:** *Well, that worked, but now I've found a real bug and I've no idea how to fix it.*
|
|
|
|
|
|
|
|
**A:** Sorry to hear that! Please keep in mind that this is basically a one-man-effort at the moment and there _will_ be bugs. However, ThreadPoolComposer is meant to simplify the annoying, repetitive parts in FPGA research and equip the community with an extensible toolchain that can be used for all kinds of projects. It would be greatly appreciated if you report any bugs in the bugtracker on the [project site](https://git.esa.informatik.tu-darmstadt.de/REPARA/threadpoolcomposer/issues)! Any feedback is also very welcome! If ThreadPoolComposer is useful for you, let us know and consider to contribute directly (see next question).
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
**Q:** *Ok, TPC seems moderately useful, but I've got an idea to make it much better. How do I contribute?*
|
|
|
|
|
|
|
|
**A:** Awesome! You can simply fork the project and then send us a merge request for your patch. Registration is deactivated at our GitLab, but you can send us an email and we'll setup an account for you, if you'd rather like to contribute directly.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
**Q:** *I opened a terminal in the TPC main directory, but none of the TPC scripts (e.g., `tpc`, `itpc`, ...) can be found.*
|
|
**Q:** *I opened a terminal in the TPC main directory, but none of the TPC scripts (e.g., `tpc`, `itpc`, ...) can be found.*
|
|
|
|
|
|
**A:** You need to source `setup.sh` to setup TPC, i.e., go into the directory and `. setup.sh`. Now the scripts should be in the `$PATH` and TPC is ready to use.
|
|
**A:** You need to source `setup.sh` to setup TPC, i.e., go into the directory and `. setup.sh`. Now the scripts should be in the `$PATH` and TPC is ready to use.
|
... | @@ -38,7 +62,7 @@ Stack: |
... | @@ -38,7 +62,7 @@ Stack: |
|
...
|
|
...
|
|
```
|
|
```
|
|
|
|
|
|
**A:** This is a known bug in Vivado cause by a double free; it only occurs on machine that support the `TSX` instruction(s) and have a `glibc` built with `--enable-lock-elision`. If possible, switch to a Xilinx supported version of your operating system. If that is not an option, you can re-build `glibc` without `TSX` lock elision, more details on the bug and the solution [can be found here](https://github.com/MyrtleSoftware/glibc-no-lock-elision). It says "Tested only on Ubuntu 15.10." on the page, but we can confirm it works for Ubunutu 16.04, too.
|
|
**A:** This is a known bug in Vivado caused by a double free; it only occurs on machine that support the `TSX` instruction(s) and have a `glibc` built with `--enable-lock-elision`. If possible, switch to a Xilinx supported version of your operating system. If that is not an option, you can re-build `glibc` without `TSX` lock elision, more details on the bug and the solution [can be found here](https://github.com/MyrtleSoftware/glibc-no-lock-elision). It says "Tested only on Ubuntu 15.10." on the page, but we can confirm it works for Ubunutu 16.04, too.
|
|
|
|
|
|
*Note: After sourcing the Vivado settings scripts, you need to unset the LD_LIBRARY_PATH environment variable to avoid linking errors:* `unset LD_LIBRARY_PATH`
|
|
*Note: After sourcing the Vivado settings scripts, you need to unset the LD_LIBRARY_PATH environment variable to avoid linking errors:* `unset LD_LIBRARY_PATH`
|
|
|
|
|
... | | ... | |