Agent build steps (GNU/Linux only)
Last revision: 2021-08-31
Requirements
Guile library version 3.0.7 or higher is required. Guile lib may require other dependencies in particular libunistring-dev and libgc-deb packages.
Guile can be provided by the distro if available, or built locally. Note that Guile v3.0.7 is quite recent and most likely not yet provided by most linux distributions. If the required version is available on your distro, just install it using your distro's package manager. Development packages must be installed as well.
Build Guile library
To build Guile locally, you first need to enable it when building contrib, then recompile contrib:
cd daemon/contribu/native
../bootstrap --enable-guile
make list
make fetch
make -j
Compile
To compile the agent, one has to enable it while configuring the daemon. At this stage, Guile must be already available.
cd daemon
./configure --enable-agent # other options can be added if needed such as --enable-debug
cd test/agent
make check
Running the agent
The agent expects a Scheme file has its first parameter. This scheme file will be interpreted by Guile. In the script, you can control the agent.
Usage:
./agent ./examples/passive-agent.scm
Guile bindings
In order for Guile to control the agent, bindings have to be added to the global
environment where the configuration file is being interpreted. This is done in
main.cpp in the function install_scheme_primitive(). All scheme bindings
should have the prefix agent: to be clear that the procedure is one that
control the agent.
When a binding is called from Guile, the arguments passed are Scheme objects of
type SCM. This is an opaque type that is generic. In order to be clear on
what the underlying type needed by the primitive procedure is, one should add the
suffix of the type at the end.
For example, my_primitive_procedure() expects that some_variable_str
will be of type string. This is enforced by using an assertion:
static SCM my_primitive_procedure(SCM some_variable_str)
{
AGENT_ASSERT(scm_is_string(some_variable_str), "`some_variable_str` must be of type string");
...
}
Here is another example where my_second_primitive() expects that
some_variable_vector_or_str to be of type string or vector:
static SCM my_second_primitive(SCM some_variable_vector_or_str)
{
AGENT_ASSERT(scm_is_string(some_variable_vector_or_str) ||
scm_is_simple_vector(some_variable_vector_or_str),
"`scm_some_variable_vector_or_str` must either be of type vector or string");
...
}
Writing scenarios
See examples/