Skip to content

Commit

Permalink
doc(vhpidirect/mistakes): add info about size limits
Browse files Browse the repository at this point in the history
  • Loading branch information
umarcor authored and eine committed Apr 30, 2020
1 parent 4999a12 commit 91f2123
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/vhpidirect/mistakes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,12 @@ Common mistakes
subprogram **must** be defined (linked) for elaboration to succeed. This is required even when it is not used in the
design. In context where conditional inclusion of VHPIDIRECT features is required, it is suggested to provide
alternative (dummy) sources for either VHDL packages or C sources (see :ghdlsharp:`793`).

* There are some corner cases when using large variables/signals. When you try to allocate a single object which is too
large, GHDL will complain. That can be fixed with :option:`--max-stack-alloc`. However, when you allocate multiple
objects which are smaller than the limit, but the last one overflows, GHDL will not complain, it will crash instead.
In this case, ``ulimit`` needs to be modified/increased. To remove the limit, set ``ulimit -s unlimited``.
See :ghdlsharp:`1112`.

* The size of objects is supposed to be 4GB. However, users finding the limit might get different constraints, depending
on the backend. See :ghdlsharp:`822`.

0 comments on commit 91f2123

Please sign in to comment.