M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

doc: Add kernel invariant detection description 

Signed-off-by: Adam Chatterley <aschatterley@phys.au.dk>
This commit is contained in:
Adam Chatterley 2024-09-09 14:26:28 +02:00 committed by Sébastien Bourdeauducq
parent 03606f4d7e
commit 6f70d629cf
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/manual/compiler.rst
View File

@ -253,3 +253,7 @@ In the synthetic example above, the compiler will be able to detect that the res
for _ in range(100):
delay_mu(precomputed_delay_mu)
self.worker.work()
Kernel invariants are defined for every object by the ``kernel_invariants`` atttribute, which is a set containing the names of every invariant attribute of this object.
At compile time it is possible to automatically detect attributes that are never altered in a kernel, and thus may be good candidates for inclusion into ``kernel_invariants``. This is done by specifying ``report_invariants=True`` when initializing the core device driver (in the dashboard you can do this using the "Override device arguments" option).