From c44dcefd1691d6ddd6725929d2be06f12a1167cb Mon Sep 17 00:00:00 2001 From: Robert Schmidt <robert.schmidt@openairinterface.org> Date: Fri, 16 Jun 2023 19:39:22 +0200 Subject: [PATCH] Document environment variables used by OAI programs --- doc/README.md | 1 + doc/environment-variables.md | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 doc/environment-variables.md diff --git a/doc/README.md b/doc/README.md index 6abca52f0b4..25696d8237a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -20,6 +20,7 @@ - [GET_SOURCES.md](./GET_SOURCES.md): how to download the sources - [BUILD.md](./BUILD.md): how to build the sources - [clang-format.md](./clang-format.md): how to format the code +- [environment-variables.md](./environment-variables.md): the environment variables used by OAI There is some general information in the [OpenAirInterface Gitlab Wiki](https://gitlab.eurecom.fr/oai/openairinterface5g/-/wikis/home) diff --git a/doc/environment-variables.md b/doc/environment-variables.md new file mode 100644 index 00000000000..5b2ae520304 --- /dev/null +++ b/doc/environment-variables.md @@ -0,0 +1,21 @@ +# Environment variables + +OAI uses/supports a number of environment variables, documented in the following: + +- `NFAPI_TRACE_LEVEL`: set the nfapi custom logging framework's log level; can be one of `error`, `warn`, `note`, `info`, `debug` +- `NR_AWGN_RESULTS_DIR`: directory containing BLER curves for L2simulator channel modelling in SISO case +- `NR_MIMO2x2_AWGN_RESULTS_DIR`: directory containing BLER curves for L2simulator channel modelling in 2x2 MIMO case +- `NVRAM_DIR`: directory to read/write NVRAM data in (5G) `nvram` tool; if not defined, will use `PWD` (working directory) +- `OAI_CONFIGMODULE`: can be used to pass the configuration file instead of `-O` +- `OPENAIR_DIR`: should point to the root directory of OpenAirInterface; some code relies on this to get a filename, e.g., BLER curves for L2sim channel emulation +- `RFSIMULATOR`: the RFsimulator's work mode, can be either `server` (for server mode) or a valid IP address (for client mode) +- `USIM_DIR`: directory to read/write USIM data in (4G) `usim` tool; if not defined, will use `PWD` (working directory) +- `gdbStacks`: if defined when hitting an assertion (`DevAssert()`, `AssertFatal()`, ...), OAI will load `gdb` and provide a backtrace for every thread +- `threadPoolMeasurements`: path to a file to store thread pool debugging information, see the [thread pool documentation](..common/utils/threadPool/thread-pool.md) + +Furthermore, these variables appear in code that is not maintained and maybe not even compiled anywhere: +- `HOST`: alternative host to connect to, for CLI, if neither `REMADDR` nor `SSH_CLIENT` are defined +- `REMADDR`: host to connect to, for CLI client +- `SSH_CLIENT`: alternative host to connect to, for CLI, if `REMADDR` is not defined +- `USER`: user name in the command-line interface +- `rftestInputFile`: input file for the `calibration_test` tool -- GitLab