path: root/doc
diff options
authorPau Espin Pedrol <pespin@sysmocom.de>2017-11-02 17:57:58 +0100
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-28 17:15:34 +0100
commit21f2b8f1298b120f13af10dc6fec0d905b6ba9ee (patch)
treed57bf82c68e770e63ca3db9ce96c66365e37566b /doc
parentdfdb7033c3192ecfe42b113126907cbb68e9c704 (diff)
OsmoGSMTester: Add state_dir section
Diffstat (limited to 'doc')
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/manuals/chapters/config.adoc b/doc/manuals/chapters/config.adoc
index def9843..7e250e0 100644
--- a/doc/manuals/chapters/config.adoc
+++ b/doc/manuals/chapters/config.adoc
@@ -54,10 +54,32 @@ suites_dir: '/usr/local/src/osmo-gsm-tester/suites'
scenarios_dir: './scenarios'
+==== 'state_dir'
+It contains global or system-wide state for osmo-gsm-tester. In a typical state
+dir you can find the following files:
+ Contains last used msisdn number, which is automatically increased every
+ time osmo-gsm-tester needs to assign a new subscriber in a test.
+ Lock file used to implement a mutual exclusion zone around the
+ 'reserved_resources.state' file.
+ File containing a set of reserved resources by any number of
+ osmo-gsm-tester instances. Each osmo-gsm-tester instance is responsible
+ to clear its resources from the list once it is done using them and are
+ no longer reserved.
If you would like to set up several separate configurations (not typical), note
that the 'state_dir' is used to reserve resources, which only works when all
configurations that share resources also use the same 'state_dir'.
+This way, several concurrent users of osmo-gsm-tester (ie. several
+osmo-gsm-tester processes running in parallel) can run without interfering with
+each other (e.g. using same ARFCN, same IP or same ofono modem path).
==== 'suites_dir'