Введение

Настоящий документ содержит руководство по установке программного продукта vBSC (Virtual Base Station Controller), предоставленного для экспертной оценки. Продукт реализует функции управления базовыми станциями и поддержки протокольных стеков GSM и UMTS в едином исполняемом файле.

Основные функциональные возможности:

Управление стеками GSM и UMTS

Поддержка протоколов GTP-C (UDP), SCCP, RANAP

Управление через REST API (порт 8181) и консольный интерфейс

Конфигурирование через текстовый файл vBSC.conf

Ведение цветного лога в консоли и файла журнала

Программное обеспечение распространяется в исходных кодах под открытой лицензией. Актуальная версия исходного кода хранится в системе контроля версий Git.

1. Системные требования

1.1 Общие положения

Программное обеспечение является кроссплатформенным и может быть установлено на различные операционные системы семейства UNIX, а также на Windows. Рекомендуется использование серверных операционных систем, оптимизированных для работы с сетевыми приложениями.

1.2 Аппаратные требования

Минимальные требования (для тестовых и ознакомительных целей):

Процессор: 4 ядра x86-64

Оперативная память: 8 ГБ

Дисковое пространство: 1 ГБ

Рекомендуемые требования (для лабораторных сред):

Процессор: 8-16 ядер Intel Xeon (или аналогичный серверный процессор)

Оперативная память: 48-64 ГБ

Дисковое пространство: 10 ГБ (для хранения логов и дампов состояния)

Сетевой интерфейс: 10 Гбит/с и более

1.3 Поддерживаемые операционные системы

Серверные ОС:

Ubuntu Server 20.04 LTS / 22.04 LTS и более поздние

Debian 11 / 12

Astra Linux

Rocky Linux 8 / 9

FreeBSD 13.x и новее

Десктопные ОС (для разработки и тестирования):

Ubuntu Desktop 20.04 / 22.04 и более поздние

Windows 10/11 (сборка через Visual Studio 2022)

1.4 Программные зависимости

Для сборки из исходного кода необходимы:

Компилятор с поддержкой C++17 (GCC 9.4+, Clang 12+, MSVC 19.30+)

Система сборки CMake 3.16 или новее

Утилита make

Git (для получения исходного кода)

1.5 Требования к настройке ядра

Для обеспечения стабильной работы при высоких нагрузках рекомендуется выполнить настройку параметров ядра.

Параметры сетевого стека:

net.core.rmem_max = 134217728

net.core.wmem_max = 134217728

net.ipv4.tcp_rmem = 4096 87380 134217728

net.ipv4.tcp_wmem = 4096 65536 134217728

net.core.netdev_max_backlog = 5000

2. Установка из скомпилированного файла

2.1 Получение исполняемого файла

Скомпилированная версия программного обеспечения доступна для операционной системы Ubuntu 20.04 LTS (x86-64) и Windows 10/11. Исполняемый файл может быть предоставлен отдельно. После получения файла необходимо установить права на его выполнение (Linux):

chmod +x vBSC_node

2.2 Проверка целостности

Для проверки целостности полученного файла рекомендуется сверить контрольную сумму SHA256, значение которой предоставляется вместе с дистрибутивом.

sha256sum vBSC_node

2.3 Установка исполняемого файла

Для установки программы в системную директорию (Linux) выполните:

sudo cp vBSC_node /usr/local/bin/

После установки проверьте доступность программы:

which vBSC_node

Для Windows установка заключается в размещении исполняемого файла в рабочей директории.

3. Сборка из исходного кода

3.1 Подготовка системы

Перед началом сборки необходимо установить требуемые пакеты (Linux):

sudo apt update

sudo apt install -y git cmake build-essential

Для Windows используется Visual Studio 2022 с компонентами разработки на C++.

3.2 Получение исходного кода

Исходный код доступен в системе контроля версий Git. Адрес репозитория необходимо уточнить у ответственного за распространение программного обеспечения.

После получения адреса репозитория выполните клонирование:

git clone <адрес_репозитория>

cd vBSC

3.3 Настройка параметров сборки

Создайте отдельную директорию для сборки и выполните конфигурацию проекта:

mkdir build

cd build

cmake ..

При необходимости можно изменить стандартные параметры сборки. Например, для установки префикса инсталляции:

cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local

Для Windows:

cmake -S . -B build

3.4 Компиляция

Выполните компиляцию проекта, используя все доступные ядра процессора:

make -j$(nproc)

В результате успешной компиляции в директории build будет создан исполняемый файл vBSC_node.

Для Windows:

cmake --build build --config Release

Исполняемый файл: build\Release\vBSC_node.exe

3.5 Проверка сборки

Для проверки корректности сборки запустите полученный исполняемый файл:

./vBSC_node

Программа должна запуститься и вывести информационный баннер. Для остановки нажмите Ctrl+C.

4. Установка и настройка

4.1 Установка программы

Для установки скомпилированной программы в системную директорию выполните из директории build:

sudo make install

По умолчанию программа будет установлена в /usr/local/bin/vBSC_node. Если при конфигурации был указан другой префикс, программа будет установлена в соответствующую директорию.

4.2 Добавление в переменную окружения PATH

Если при установке был выбран нестандартный каталог, добавьте его в переменную окружения PATH. Для этого отредактируйте файл ~/.bashrc или ~/.profile, добавив строку:

export PATH=$PATH:/путь/к/каталогу/с/программой

После редактирования примените изменения:

source ~/.bashrc

4.3 Проверка установки

Убедитесь, что программа доступна для запуска из любой директории:

vBSC_node --help

Программа поддерживает аргументы командной строки: путь к конфигурационному файлу и опционально тип стека (gsm, umts). При отсутствии аргументов запускаются оба стека одновременно.

5. Запуск в Docker-контейнере

5.1 Подготовка Docker-образа

Для запуска программы в контейнерной среде создайте Dockerfile. В директории с исходным кодом создайте файл Dockerfile со следующим содержимым:

FROM ubuntu:20.04

RUN apt-get update && apt-get install -y && rm -rf /var/lib/apt/lists/*

COPY build/vBSC_node /usr/local/bin/vBSC_node

RUN chmod +x /usr/local/bin/vBSC_node

EXPOSE 2123/udp 8181/tcp

WORKDIR /var/vBSC

VOLUME ["/var/vBSC/logs"]

CMD ["vBSC_node", "vBSC.conf"]

5.2 Сборка Docker-образа

Выполните сборку образа, указав тег:

docker build -t vBSC:latest .

5.3 Запуск контейнера

Для запуска контейнера выполните:

docker run -it --rm -p 2123:2123/udp -p 8181:8181/tcp -v (pwd)/logs:/var/vBSC/logs−v(pwd)/logs:/var/vBSC/logs−v(pwd)/vBSC.conf:/var/vBSC/vBSC.conf vBSC:latest

Параметры запуска:

it — интерактивный режим с псевдо-TTY

rm — удаление контейнера после остановки

p — проброс портов на хост-машину

v — монтирование директории для хранения логов и файла конфигурации

5.4 Управление контейнером

Для остановки программы нажмите Ctrl+C, после чего контейнер завершит работу. Для запуска контейнера в фоновом режиме используйте флаг -d:

docker run -d --name vBSC -p 2123:2123/udp -p 8181:8181/tcp vBSC:latest

В фоновом режиме консоль управления недоступна. Для подключения к запущенному контейнеру используйте:

docker attach vBSC

Приложение А. Файлы конфигурации

А.1 Файл vBSC.conf

Файл конфигурации vBSC.conf содержит следующие секции и параметры:

[gsm]

cell_id = 1

arfcn = 60

tx_power_dbm = 43.0

bsic = 10

lac = 1000

mcc = 250

mnc = 1

bsc_addr =

bsc_port = 3002

[umts]

cell_id = 2

uarfcn = 10700

tx_power_dbm = 43.0

psc = 64

lac = 1000

rac = 1

rnc_addr =

rnc_port = 25412

[logging]

level = INFO

log_file = vBSC.log

А.2 Расположение файлов конфигурации

По умолчанию программа ожидает файл конфигурации vBSC.conf в рабочей директории, из которой запущен исполняемый файл. При необходимости путь к файлу конфигурации может быть указан как первый аргумент командной строки:

vBSC_node /путь/к/vBSC.conf