Skip to content

Commit

Permalink
Update README.rst with instructions for server mode
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoeilers authored Oct 13, 2024
1 parent 878823e commit 311429f
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,27 @@ The following command line options are available::
To see all possible command line options, invoke ``nagini`` without arguments.


Server Mode / Faster Verification Mode
======================================

Nagini has to do a significant amount of work on startup, and has to start a JVM to run Viper.
To avoid some of that startup work and speed up Viper's runtime, Nagini has a server mode.
To use it,

1. Start a Nagini server::

nagini --server <otherArgs> dummyFile.py
Note that all required arguments, including ``JAVA_HOME`` and other potentially required
environment variables, have to be set here. The dummy file does not need to exist, it is
never read, but some file name has to be supplied.

2. Wait a few seconds to allow the server to start up

3. While the server is running, run a client to instruct the server to verify a specific file::

nagini_client path/to/file.py

Alternative Viper Versions
==========================

Expand Down

0 comments on commit 311429f

Please sign in to comment.