Mirrors/VILLASnode
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
Code Issues Releases Wiki Activity

Merge branch 'master' into python-client-lab

Browse source
This commit is contained in:
al3xa23 2024-10-22 09:42:35 +02:00 • committed by GitHub
commit 5b38d83c95
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
652 changed files with 46213 additions and 7818 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
.devcontainer/devcontainer.json
View file

@ -1,31 +1,28 @@
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.195.0/containers/cpp
//
// SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
// SPDX-License-Identifier: Apache-2.0
{
"name": "VILLASnode",
"image": "registry.git.rwth-aachen.de/acs/public/villas/node/dev-vscode",
// Uncomment to build the devcontainer locally
// "build": {
// "dockerfile": "../packaging/docker/Dockerfile.fedora",
// "target": "dev-vscode",
// "context": ".."
// },
"remoteUser": "villas",
"runArgs": [
"--privileged",
"--security-opt",
"seccomp=unconfined"
],
"customizations": {
"vscode": {
"extensions": [
"ms-vscode.cpptools-extension-pack",
"llvm-vs-code-extensions.vscode-clangd",
"xaver.clang-format",
"EditorConfig.EditorConfig"
]
}
}
"name": "VILLASnode",
"image": "registry.git.rwth-aachen.de/acs/public/villas/node/dev-vscode",
// Uncomment to build the devcontainer locally
// "build": {
// "dockerfile": "../packaging/docker/Dockerfile.fedora",
// "target": "dev-vscode",
// "context": ".."
// },
"remoteUser": "villas",
"runArgs": [
"--privileged",
"--security-opt",
"seccomp=unconfined"
],
"customizations": {
"vscode": {
"extensions": [
"ms-vscode.cpptools-extension-pack",
"llvm-vs-code-extensions.vscode-clangd",
"xaver.clang-format",
"EditorConfig.EditorConfig"
]
}
}
}

6
.editorconfig
View file

@ -23,9 +23,9 @@ indent_style = space
indent_size = 4
[*.conf]
indent_style = tab
indent_size = 8
indent_style = space
indent_size = 4
[*.nix]
[*.{nix,json}]
indent_style = space
indent_size = 2

34
.envrc
View file

@ -1,36 +1,4 @@
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
export_or_unset()
{
local var=$1
if [ -z "${!var+x}" ]; then
return
fi
if [ -n "$2" ]; then
export $var="$2"
else
unset $var
fi
}
if direnv_version "2.30.0" \
&& has nix \
&& nix show-config experimental-features 2>/dev/null | grep -wqF flakes
then
local oldtmp="$TMP"
local oldtemp="$TEMP"
local oldtmpdir="$TMPDIR"
local oldtempdir="$TEMPDIR"
watch_file ./packaging/nix/*.nix
use flake ./packaging/nix
export_or_unset TMP "$oldtmp"
export_or_unset TEMP "$oldtemp"
export_or_unset TMPDIR "$oldtmpdir"
export_or_unset TEMPDIR "$oldtempdir"
fi
use flake

9
.git-blame-ignore-revs
View file

@ -10,3 +10,12 @@ aa16979fdde7cd377977c38eaee02062c3908515
# Update Steffens mail address
7eec1bb75339c60cefe5e9e558d9394e0cceecb6
# Introduced clang-format in common/
5324b788bdd93b3e142a9f53b931dbfc8c3ed39d
# Make project REUSE compliant in common/
b1e8cd81da9a3e3d27db27d49d265afc53e0ce4d
# Update Steffens mail address in common/
6427fae1e4ca0467e09688d56cec0dcd7d5e600d

14
.gitignore vendored
View file

@ -3,7 +3,6 @@
/build*/
*~
*.swp
.clang_complete
.project
.cproject
@ -12,14 +11,19 @@
.direnv/
.cache/
*.swp
*.pyc
*.a
*.o
*.so
*.user
*.egg-info/
compile_commands.json
python/dist/
python/.eggs/
# YouCompleteMe
.ycm_extra_conf.py
*.pyc
python/.eggs/
go/lib/_obj/
graph.dot

278
.gitlab-ci.yml
View file

@ -14,115 +14,100 @@ variables:
CMAKE_EXTRA_OPTS: "-DCMAKE_BUILD_TYPE=Release -DVILLAS_COMPILE_WARNING_AS_ERROR=ON"
stages:
- prepare
- build
- test
- packaging
- deploy
- latest
- prepare
- build
- test
- packaging
- deploy
- latest
# Stage: prepare
# Build docker image which is used to build & test VILLASnode
prepare:docker:
stage: prepare
image: docker:20.10
before_script:
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
script:
- docker build ${DOCKER_OPTS}
- docker build ${DOCKER_OPTS}
--file ${DOCKER_FILE}
--tag ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
--target ${TARGET} .
- docker push ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
variables:
TARGET: dev
parallel:
matrix:
- DISTRO: [ ubuntu, debian, rocky ]
- DISTRO: fedora
DOCKER_OPTS: --tag ${DOCKER_IMAGE}/dev:${CI_COMMIT_REF_NAME}
- DISTRO: fedora
DOCKER_FILE: packaging/docker/Dockerfile.fedora-minimal
DOCKER_IMAGE_DEV: ${DOCKER_IMAGE}/dev-fedora-minimal
- DISTRO: fedora
TARGET: dev-vscode
DOCKER_IMAGE_DEV: ${DOCKER_IMAGE}/dev-vscode
- DISTRO: [ubuntu, debian, rocky]
- DISTRO: fedora
DOCKER_OPTS: --tag ${DOCKER_IMAGE}/dev:${DOCKER_TAG}
- DISTRO: fedora
DOCKER_FILE: packaging/docker/Dockerfile.fedora-minimal
DOCKER_IMAGE_DEV: ${DOCKER_IMAGE}/dev-fedora-minimal
- DISTRO: fedora
TARGET: dev-vscode
DOCKER_IMAGE_DEV: ${DOCKER_IMAGE}/dev-vscode
tags:
- docker
- docker-image-builder
# Stage: build
build:source:
stage: build
needs: ["prepare:docker"]
image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
script:
- cmake -S . -B build ${CMAKE_OPTS} ${CMAKE_EXTRA_OPTS}
- cmake --build build ${CMAKE_BUILD_OPTS}
- cmake -S . -B build ${CMAKE_OPTS} ${CMAKE_EXTRA_OPTS}
- cmake --build build ${CMAKE_BUILD_OPTS}
artifacts:
expire_in: 1 week
paths:
- build/
- build/
variables:
CMAKE: cmake
parallel:
matrix:
- DISTRO: [ fedora, fedora-minimal, debian, rocky, ubuntu ]
- DISTRO: fedora-minimal
CMAKE_EXTRA_OPTS: -DVILLAS_COMPILE_WARNING_AS_ERROR=ON
-DWITH_API=OFF
-DWITH_CLIENTS=OFF
-DWITH_CONFIG=OFF
-DWITH_DOC=OFF
-DWITH_FPGA=OFF
-DWITH_GRAPHVIZ=OFF
-DWITH_HOOKS=OFF
-DWITH_LUA=OFF
-DWITH_OPENMP=OFF
-DWITH_PLUGINS=OFF
-DWITH_SRC=OFF
-DWITH_TESTS=OFF
-DWITH_TOOLS=OFF
-DWITH_WEB=OFF
-DCMAKE_MODULE_PATH=/usr/local/lib64/cmake
-DCMAKE_PREFIX_PATH=/usr/local
tags:
- docker
- DISTRO: [fedora, fedora-minimal, debian, rocky, ubuntu]
- DISTRO: fedora-minimal
CMAKE_EXTRA_OPTS: -DVILLAS_COMPILE_WARNING_AS_ERROR=ON
-DWITH_API=OFF
-DWITH_CLIENTS=OFF
-DWITH_CONFIG=OFF
-DWITH_DOC=OFF
-DWITH_FPGA=OFF
-DWITH_GRAPHVIZ=OFF
-DWITH_HOOKS=OFF
-DWITH_LUA=OFF
-DWITH_OPENMP=OFF
-DWITH_PLUGINS=OFF
-DWITH_SRC=OFF
-DWITH_TESTS=OFF
-DWITH_TOOLS=OFF
-DWITH_WEB=OFF
-DCMAKE_MODULE_PATH=/usr/local/lib64/cmake
-DCMAKE_PREFIX_PATH=/usr/local
# Stage: test
test:python:
stage: test
script:
- cd python
- /venv/bin/black --check .
- /venv/bin/mypy .
- /venv/bin/flake8 .
- /venv/bin/pytest -v .
- cd python
- /venv/bin/pytest --verbose .
- /venv/bin/black --extend-exclude=".*(\\.pyi|_pb2.py)$" --check .
- /venv/bin/flake8 --extend-exclude="*.pyi,*_pb2.py" .
- /venv/bin/mypy .
image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
tags:
- docker
needs:
- job: "build:source: [fedora]"
test:cppcheck:
stage: test
script:
- cppcheck -j $(nproc)
--max-configs=32
--error-exitcode=1
--quiet
--inline-suppr
--enable=warning,performance,portability,missingInclude
--std=c++11
--suppress=noValidConfiguration
-U '_MSC_VER;_WIN32;_M_ARM'
-U '_MSC_VER;_WIN32;_M_AMD64;_M_X64'
-U '_MSC_FULL_VER;_MSC_VER'
-U '_MSC_BUILD;_MSC_VER'
-I include
-I common/include
src/ lib/ tests/unit/ | tee cppcheck.log
- ./tools/run-cppcheck.sh | tee cppcheck.log
image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
tags:
- docker
needs:
- job: "build:source: [fedora]"
- job: "build:source: [fedora]"
artifacts:
when: on_failure
paths:
@ -133,66 +118,54 @@ test:unit:
stage: test
image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
script:
- cmake -S . -B build ${CMAKE_OPTS}
- cmake --build build ${CMAKE_BUILD_OPTS} --target run-unit-tests
tags:
- docker
- cmake -S . -B build ${CMAKE_OPTS}
- cmake --build build ${CMAKE_BUILD_OPTS} --target run-unit-tests run-unit-tests-common
needs:
- job: "build:source: [fedora]"
artifacts: true
- job: "build:source: [fedora]"
artifacts: true
test:integration:
stage: test
image: ${DOCKER_IMAGE_DEV}:${DOCKER_TAG}
script:
- cmake -S . -B build ${CMAKE_OPTS}
- cmake --build build ${CMAKE_BUILD_OPTS} --target run-integration-tests
- cmake -S . -B build ${CMAKE_OPTS}
- cmake --build build ${CMAKE_BUILD_OPTS} --target run-integration-tests
artifacts:
name: ${CI_PROJECT_NAME}-integration-tests-${CI_BUILD_REF}
when: always
paths:
- build/tests/integration/
- build/tests/integration/
services:
- name: eclipse-mosquitto:2.0
alias: mosquitto
command: [ mosquitto, -c, /mosquitto-no-auth.conf ]
- name: rwthacs/rabbitmq
alias: rabbitmq
- name: redis:6.2
alias: redis
tags:
- docker
- name: eclipse-mosquitto:2.0
alias: mosquitto
command: [mosquitto, -c, /mosquitto-no-auth.conf]
- name: rwthacs/rabbitmq
alias: rabbitmq
- name: redis:6.2
alias: redis
needs:
- job: "build:source: [fedora]"
artifacts: true
- job: "build:source: [fedora]"
artifacts: true
test:reuse:
stage: test
needs: []
image:
name: fsfe/reuse:latest
entrypoint: [""]
tags:
- docker
script:
- reuse lint
- reuse lint
# Stage: packaging
pkg:docker:
stage: packaging
image: docker:20.10
before_script:
- mkdir -p ~/.docker/cli-plugins/
- wget -O ~/.docker/cli-plugins/docker-buildx https://github.com/docker/buildx/releases/download/v0.6.3/buildx-v0.6.3.linux-amd64
- chmod a+x ~/.docker/cli-plugins/docker-buildx
- docker buildx create --use --name cross-platform-build --buildkitd-flags "--allow-insecure-entitlement security.insecure"
- docker buildx inspect --bootstrap cross-platform-build
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
# - docker run --rm --privileged docker.io/aptman/qus -s -- -p
script:
- docker buildx build ${DOCKER_OPTS}
- docker build ${DOCKER_OPTS}
--pull
--allow security.insecure
--output type=docker
--target ${TARGET}
--build-arg ARCH=${ARCH}
--build-arg TRIPLET=${TRIPLET}
@ -200,9 +173,9 @@ pkg:docker:
--platform ${PLATFORM}
--file ${DOCKER_FILE}
--tag ${DOCKER_IMAGE}:${DOCKER_TAG}-${ARCH} .
- docker push ${DOCKER_IMAGE}:${DOCKER_TAG}-${ARCH}
- docker push ${DOCKER_IMAGE}:${DOCKER_TAG}-${ARCH}
tags:
- docker
- docker
variables:
TARGET: app
parallel:
@ -210,17 +183,17 @@ pkg:docker:
- DISTRO: debian
PLATFORM: linux/amd64
ARCH: x86_64
TRIPLET: x86_64-linux-gnu
- DISTRO: debian
PLATFORM: linux/arm/v7
ARCH: armhf
TRIPLET: arm-linux-gnueabihf
DOCKER_FILE: packaging/docker/Dockerfile.debian-multiarch
- DISTRO: debian
PLATFORM: linux/arm64/v8
ARCH: arm64
TRIPLET: aarch64-linux-gnu
DOCKER_FILE: packaging/docker/Dockerfile.debian-multiarch
TRIPLET: x86_64-linux-gnu
# - DISTRO: debian
# PLATFORM: linux/arm/v7
# ARCH: armhf
# TRIPLET: arm-linux-gnueabihf
# DOCKER_FILE: packaging/docker/Dockerfile.debian-multiarch
# - DISTRO: debian
# PLATFORM: linux/arm64/v8
# ARCH: arm64
# TRIPLET: aarch64-linux-gnu
# DOCKER_FILE: packaging/docker/Dockerfile.debian-multiarch
needs: []
@ -228,102 +201,95 @@ pkg:docker:
deploy:docker:
stage: deploy
image: docker:20.10
variables:
DOCKER_CLI_EXPERIMENTAL: enabled
before_script:
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
script:
- docker manifest create ${DOCKER_IMAGE}:${DOCKER_TAG}
${DOCKER_IMAGE}:${DOCKER_TAG}-x86_64
${DOCKER_IMAGE}:${DOCKER_TAG}-arm64
${DOCKER_IMAGE}:${DOCKER_TAG}-armhf
- docker manifest push ${DOCKER_IMAGE}:${DOCKER_TAG}
- docker manifest rm ${DOCKER_IMAGE}:${DOCKER_TAG} || true
- docker manifest create ${DOCKER_IMAGE}:${DOCKER_TAG}
${DOCKER_IMAGE}:${DOCKER_TAG}-x86_64
# ${DOCKER_IMAGE}:${DOCKER_TAG}-arm64
# ${DOCKER_IMAGE}:${DOCKER_TAG}-armhf
- docker manifest push ${DOCKER_IMAGE}:${DOCKER_TAG}
tags:
- docker
- docker
needs:
- job: "pkg:docker: [debian, linux/arm64/v8, arm64, aarch64-linux-gnu, packaging/docker/Dockerfile.debian-multiarch]"
- job: "pkg:docker: [debian, linux/arm/v7, armhf, arm-linux-gnueabihf, packaging/docker/Dockerfile.debian-multiarch]"
- job: "pkg:docker: [debian, linux/amd64, x86_64, x86_64-linux-gnu]"
# - job: "pkg:docker: [debian, linux/arm64/v8, arm64, aarch64-linux-gnu, packaging/docker/Dockerfile.debian-multiarch]"
# - job: "pkg:docker: [debian, linux/arm/v7, armhf, arm-linux-gnueabihf, packaging/docker/Dockerfile.debian-multiarch]"
- job: "pkg:docker: [debian, linux/amd64, x86_64, x86_64-linux-gnu]"
deploy:docker-dev:
stage: deploy
image: docker:20.10
variables:
DOCKER_CLI_EXPERIMENTAL: enabled
before_script:
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
script:
- docker push ${DOCKER_IMAGE}/dev:${DOCKER_TAG}
- docker push ${DOCKER_IMAGE}/dev:${DOCKER_TAG}
tags:
- docker
- docker
needs:
- job: "prepare:docker: [fedora, --tag ${DOCKER_IMAGE}/dev:${CI_COMMIT_REF_NAME}]"
- job: "prepare:docker: [fedora, --tag ${DOCKER_IMAGE}/dev:${DOCKER_TAG}]"
deploy:docker-dev-vscode:
stage: deploy
image: docker:20.10
variables:
DOCKER_CLI_EXPERIMENTAL: enabled
before_script:
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
script:
- docker push ${DOCKER_IMAGE}/dev-vscode:${DOCKER_TAG}
- docker push ${DOCKER_IMAGE}/dev-vscode:${DOCKER_TAG}
tags:
- docker
- docker
needs:
- job: "prepare:docker: [fedora, dev-vscode, ${DOCKER_IMAGE}/dev-vscode]"
- job: "prepare:docker: [fedora, dev-vscode, ${DOCKER_IMAGE}/dev-vscode]"
# Stage: latest
.latest:docker:latest: &deploy_latest_docker
stage: latest
image: docker:20.10
before_script:
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
script:
- docker manifest create ${DOCKER_IMAGE}:latest
${DOCKER_IMAGE}:${DOCKER_TAG}-x86_64
${DOCKER_IMAGE}:${DOCKER_TAG}-arm64
${DOCKER_IMAGE}:${DOCKER_TAG}-armhf
- docker manifest push ${DOCKER_IMAGE}:latest
- docker manifest create ${DOCKER_IMAGE}:latest
${DOCKER_IMAGE}:${DOCKER_TAG}-x86_64
${DOCKER_IMAGE}:${DOCKER_TAG}-arm64
${DOCKER_IMAGE}:${DOCKER_TAG}-armhf
- docker manifest push ${DOCKER_IMAGE}:latest
tags:
- docker
- docker
needs:
- job: deploy:docker
- job: deploy:docker
.latest:docker-dev:latest: &deploy_latest_docker_dev
stage: latest
image: docker:20.10
before_script:
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
- docker login -u ${CI_REGISTRY_USER} -p ${CI_REGISTRY_PASSWORD} ${CI_REGISTRY}
script:
- docker tag ${DOCKER_IMAGE}/dev:${DOCKER_TAG} ${DOCKER_IMAGE}/dev:latest
- docker push ${DOCKER_IMAGE}/dev:latest
- docker tag ${DOCKER_IMAGE}/dev:${DOCKER_TAG} ${DOCKER_IMAGE}/dev:latest
- docker push ${DOCKER_IMAGE}/dev:latest
tags:
- docker
- docker
needs:
- job: deploy:docker-dev
- job: deploy:docker-dev
latest:docker:
<<: *deploy_latest_docker
only:
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
latest:docker-dev:
<<: *deploy_latest_docker_dev
only:
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
latest:docker:manual:
<<: *deploy_latest_docker
when: manual
except:
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
latest:docker-dev:manual:
<<: *deploy_latest_docker_dev
when: manual
except:
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags
- "/^v\\d+(\\.\\d+)+$/" # Only on version tags

15
.gitmodules vendored
View file

@ -1,13 +1,16 @@
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
[submodule "common"]
path = common
url = https://github.com/VILLASframework/common.git
[submodule "fpga"]
path = fpga
url = https://github.com/VILLASframework/fpga.git
[submodule "packaging/live-iso/fedora-kickstarts"]
path = packaging/live-iso/fedora-kickstarts
url = https://pagure.io/fedora-kickstarts.git
[submodule "fpga/thirdparty/libxil"]
path = fpga/thirdparty/libxil
url = https://github.com/VILLASframework/libxil.git
[submodule "fpga/thirdparty/udmabuf"]
path = fpga/thirdparty/udmabuf
url = https://github.com/ikwzm/udmabuf
[submodule "fpga/lib/gpu/gdrcopy"]
path = fpga/gpu/thirdparty/gdrcopy
url = https://github.com/daniel-k/gdrcopy.git

6
.reuse/dep5
View file

@ -3,10 +3,6 @@ Upstream-Name: VILLASnode
Upstream-Contact: Steffen Vogel <post@steffenvogel.de>
Source: https://fein-aachen.org/en/projects/villas-node/
Files: *.vi *.opal *.dft *.sib *.json *.ipynb doc/pictures/* clients/opal/models/send_receive/eonerc_logo.png doc/favicon.png
Copyright: 2018-2023, Institute for Automation of Complex Power Systems, RWTH Aachen University
License: Apache-2.0
Files: clients/rtds/**/*.txt clients/hypersim/*.ecf etc/labs/lab3.pcap packaging/live-iso/files/etc/* packaging/nix/flake.lock tests/valgrind.supp packaging/archlinux/villas-node.install
Files: *.vi *.opal *.dft *.sib *.json *.ipynb *_pb2.py doc/pictures/* doc/favicon.png clients/opal/models/send_receive/eonerc_logo.png clients/rtds/**/*.txt clients/hypersim/*.ecf etc/labs/lab3.pcap packaging/live-iso/files/etc/* flake.lock tests/valgrind.supp packaging/archlinux/villas-node.install
Copyright: 2018-2023, Institute for Automation of Complex Power Systems, RWTH Aachen University
License: Apache-2.0

21
CMakeLists.txt
View file

@ -75,6 +75,7 @@ find_package(RDMACM)
find_package(Etherlab)
find_package(Lua)
find_package(LibDataChannel)
find_package(re)
# Check for tools
find_program(PASTE NAMES paste)
@ -117,13 +118,7 @@ pkg_check_modules(NANOMSG IMPORTED_TARGET nanomsg)
if(NOT NANOMSG_FOUND)
pkg_check_modules(NANOMSG IMPORTED_TARGET libnanomsg>=1.0.0)
endif()
pkg_check_modules(RE IMPORTED_TARGET re>=2.9.0)
if(NOT RE_FOUND)
pkg_check_modules(RE IMPORTED_TARGET libre>=2.9.0)
endif()
if(NOT RE_FOUND)
pkg_check_modules(RE IMPORTED_TARGET re2)
endif()
if (REDISPP_FOUND)
file(READ "${REDISPP_INCLUDEDIR}/sw/redis++/tls.h" CONTENTS)
@ -155,11 +150,11 @@ else()
endif()
FindSymbol(${LWS_LOCATION} lws_extension_callback_pm_deflate LWS_DEFLATE_FOUND)
# Check if VILLASfpga submodule is present
if(EXISTS "${PROJECT_SOURCE_DIR}/fpga/CMakeLists.txt")
set(FOUND_SUBMODULE_FPGA ON)
# Check if submodules for VILLASfpga are present
if(EXISTS "${PROJECT_SOURCE_DIR}/fpga/thirdparty/libxil/CMakeLists.txt")
set(FOUND_FPGA_SUBMODULES ON)
else()
set(FOUND_SUBMODULE_FPGA OFF)
set(FOUND_FPGA_SUBMODULES OFF)
endif()
# Build options
@ -168,7 +163,7 @@ cmake_dependent_option(WITH_DEFAULTS "Defaults for non required build opt
cmake_dependent_option(WITH_API "Build with remote control API" "${WITH_DEFAULTS}" "" OFF)
cmake_dependent_option(WITH_CLIENTS "Build client applications" "${WITH_DEFAULTS}" "TOPLEVEL_PROJECT" OFF)
cmake_dependent_option(WITH_CONFIG "Build with support for libconfig configuration syntax" "${WITH_DEFAULTS}" "LIBCONFIG_FOUND" OFF)
cmake_dependent_option(WITH_FPGA "Build with support for VILLASfpga" "${WITH_DEFAULTS}" "FOUND_SUBMODULE_FPGA" OFF)
cmake_dependent_option(WITH_FPGA "Build with support for VILLASfpga" "${WITH_DEFAULTS}" "FOUND_FPGA_SUBMODULES" OFF)
cmake_dependent_option(WITH_GRAPHVIZ "Build with Graphviz" "${WITH_DEFAULTS}" "CGRAPH_FOUND; GVC_FOUND" OFF)
cmake_dependent_option(WITH_HOOKS "Build with support for processing hook plugins" "${WITH_DEFAULTS}" "" OFF)
cmake_dependent_option(WITH_LUA "Build with Lua" "${WITH_DEFAULTS}" "LUA_FOUND" OFF)
@ -199,7 +194,7 @@ cmake_dependent_option(WITH_NODE_NANOMSG "Build with nanomsg node-type"
cmake_dependent_option(WITH_NODE_NGSI "Build with ngsi node-type" "${WITH_DEFAULTS}" "" OFF)
cmake_dependent_option(WITH_NODE_OPAL "Build with opal node-type" "${WITH_DEFAULTS}" "Opal_FOUND" OFF)
cmake_dependent_option(WITH_NODE_REDIS "Build with redis node-type" "${WITH_DEFAULTS}" "HIREDIS_FOUND; REDISPP_FOUND" OFF)
cmake_dependent_option(WITH_NODE_RTP "Build with rtp node-type" "${WITH_DEFAULTS}" "RE_FOUND" OFF)
cmake_dependent_option(WITH_NODE_RTP "Build with rtp node-type" "${WITH_DEFAULTS}" "re_FOUND" OFF)
cmake_dependent_option(WITH_NODE_SHMEM "Build with shmem node-type" "${WITH_DEFAULTS}" "HAS_SEMAPHORE; HAS_MMAN" OFF)
cmake_dependent_option(WITH_NODE_SIGNAL "Build with signal node-type" "${WITH_DEFAULTS}" "" OFF)
cmake_dependent_option(WITH_NODE_SOCKET "Build with socket node-type" "${WITH_DEFAULTS}" "LIBNL3_ROUTE_FOUND" OFF)

31
CODEOWNERS
View file

@ -13,14 +13,27 @@
# and not the global owner(s) will be requested for a review.
# FPGA
fpga @n-eiling
/lib/nodes/fpga.cpp @n-eiling
/include/villas/nodes/fpga.hpp @n-eiling
fpga @n-eiling
/lib/nodes/fpga.cpp @n-eiling
/include/villas/nodes/fpga.hpp @n-eiling
/tools/hwdef-parse.py @n-eiling
/tools/fpga-* @n-eiling
/fpga @n-eiling
/etc/examples/nodes/fpga.conf @n-eiling
/etc/fpga @n-eiling
/doc/openapi/components/schemas/nodes/fpga.yaml @n-eiling
# PMU
/lib/nodes/libiec61850_goose.cpp @windrad6
/include/villas/nodes/libiec61850_goose.hpp @windrad6
/lib/nodes/uldaq.cpp @windrad6
/include/villas/nodes/uldaq.hpp @windrad6
/lib/dumper.cpp @windrad6
/include/villas/dumper.hpp @windrad6
/lib/nodes/libiec61850_goose.cpp @windrad6
/include/villas/nodes/libiec61850_goose.hpp @windrad6
/lib/nodes/uldaq.cpp @windrad6
/include/villas/nodes/uldaq.hpp @windrad6
/lib/dumper.cpp @windrad6
/include/villas/dumper.hpp @windrad6
# VFIO related files
/common/lib/kernel/pci.cpp @n-eiling
/common/lib/kernel/vfi_*.cpp @n-eiling
/common/include/villas/kernel/devices/* @n-eiling
/common/include/villas/kernel/vfio_*.hpp @n-eiling

146
LICENSES/Apache-2.0.txt
View file

@ -1,73 +1,73 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

11
LICENSES/BSD-3-Clause.txt Normal file
View file

@ -0,0 +1,11 @@
Copyright (c) 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

117
LICENSES/GPL-2.0-or-later.txt Normal file
View file

@ -0,0 +1,117 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.
signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice

232
LICENSES/GPL-3.0-or-later.txt Normal file
View file

@ -0,0 +1,232 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS
0. Definitions.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
1. Source Code.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
7. Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
11. Patents.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.

10
LICENSES/Unlicense.txt Normal file
View file

@ -0,0 +1,10 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <http://unlicense.org/>

18
README.md
View file

@ -31,6 +31,11 @@ VILLASnode is used in distributed- and co-simulation scenarios and developed for
User documentation is available here: <https://villas.fein-aachen.org/docs/>
## Related Projects
- [MIOB](https://github.com/RWTH-ACS/miob)
- [DINO](https://github.com/RWTH-ACS/dino)
## License
This project is released under the terms of the [Apache 2.0 license](LICENSE).
@ -44,6 +49,9 @@ For other licensing options please consult [Prof. Antonello Monti](mailto:amonti
- SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
- SPDX-FileCopyrightText: 2023 OPAL-RT Germany GmbH
- SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
- SPDX-FileCopyrightText: 2018-2023 Steffen Vogel <post@steffenvogel.de>
- SPDX-FileCopyrightText: 2018 Daniel Krebs <dkrebs@eonerc.rwth-aachen.de>
- SPDX-License-Identifier: Apache-2.0
## Contact
@ -51,8 +59,10 @@ For other licensing options please consult [Prof. Antonello Monti](mailto:amonti
[![EONERC ACS Logo](doc/pictures/eonerc_logo.png)](http://www.acs.eonerc.rwth-aachen.de)
- Steffen Vogel <post@steffenvogel.de>
- Marija Stevic <mstevic@eonerc.rwth-aachen.de>
- Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
- Felix Wege <fwege@eonerc.rwth-aachen.de>
- Alexandra Bach <alexandra.bach@eonerc.rwth-aachen.de>
[Institute for Automation of Complex Power Systems (ACS)](http://www.acs.eonerc.rwth-aachen.de)
[EON Energy Research Center (EONERC)](http://www.eonerc.rwth-aachen.de)
[RWTH University Aachen, Germany](http://www.rwth-aachen.de)
[Institute for Automation of Complex Power Systems (ACS)](http://www.acs.eonerc.rwth-aachen.de)
[EON Energy Research Center (EONERC)](http://www.eonerc.rwth-aachen.de)
[RWTH University Aachen, Germany](http://www.rwth-aachen.de)

5
clients/hypersim/README.md
View file

@ -4,11 +4,12 @@ This directory contains a HYPERSIM user code model (UCM) for interfacing the HYP
## Documentation
Detailed information for installation and usage of the UCM is provided in the [user documentation](https://villas.fein-aachen.org/doc/node-client-hypersim.html).
Detailed information for installation and usage of the UCM is provided in the [user documentation](https://villas.fein-aachen.org/docs/node/clients/opal_hypersim).
## Author
## Authors
- Anju Meghwani <meghwani@iitk.ac.in>
- Louis Birkner <louis.birkner@opal-rt.com>
## License

135
clients/hypersim/model/ucm_node.def
View file

@ -109,13 +109,12 @@ UCM_DESCRIPTION = "An interface the VILLASnode gateway"
%% BEGIN DOCUMENTATION -- Enter model's documentation after this line...
Full documentation of this model is available at:
https://villas.fein-aachen.org/doc/node-client-hypersim.html
https://villas.fein-aachen.org/docs/node/clients/opal_hypersim
Author:
## Author
## Authors
- Anju Meghwani <meghwani@iitk.ac.in>
- Louis Birkner <louis.birkner@opal-rt.com>
Anju Meghwani is a Research Establishment Officer at Indian Institute of Kanpur, India and worked in Washington State University, Pullman as visiting scholar in Summer 2018.
During her visit, she developed an interfacing framework for VILLASnode and HYPERSIM.
@ -161,7 +160,7 @@ UI-ASSIST is a joint research project between India and the US.
%% Min : Minimum value allowed.
%% Max : Maximum value allowed.
%% Flags : Ored values of flags definitions or '-'.
%% Available values :
%% Available values :
%% NOT_SIMUL_MOD : Cannot be modified during simulation.
%% Description : Short description of parameter (BETWEEN DOUBLE QUOTES)
%%
@ -193,7 +192,7 @@ UI-ASSIST is a joint research project between India and the US.
%% Fields descriptions:
%%
%% Name : Connector's unique identifier (tag).
%%
%%
%% Units : Signal's units.
%% Text field: use the official SI symbols.
%% Enter a "-" when not used
@ -219,8 +218,23 @@ UI-ASSIST is a joint research project between India and the US.
switchr no int in auto S "Receive Data"
switchs no int in auto S "Send Data"
datain no double in auto I "Data Input"
dataout no double out auto O "Data Output"
datain0 no double in auto I "Data Input 0"
datain1 no double in auto I "Data Input 1"
datain2 no double in auto I "Data Input 2"
datain3 no double in auto I "Data Input 3"
datain4 no double in auto I "Data Input 4"
datain5 no double in auto I "Data Input 5"
datain6 no double in auto I "Data Input 6"
datain7 no double in auto I "Data Input 7"
dataout0 no double out auto O "Data Output 0"
dataout1 no double out auto O "Data Output 1"
dataout2 no double out auto O "Data Output 2"
dataout3 no double out auto O "Data Output 3"
dataout4 no double out auto O "Data Output 4"
dataout5 no double out auto O "Data Output 5"
dataout6 no double out auto O "Data Output 6"
dataout7 no double out auto O "Data Output 7"
%% END CONTROL IOS
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -236,7 +250,7 @@ dataout no double out auto O "Data Output"
%% Fields descriptions:
%%
%% Name : Node's unique identifier.
%%
%%
%% Phases : Number of phases.
%% Text field: Enter a number (1, 3) or
%% 0 for dynamic number of phases.
@ -401,13 +415,13 @@ dataout no double out auto O "Data Output"
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN PREPARATORY INCLUDES PATHS LIST -- Modify the following list...
UCM_PREP_INCLUDES_PATHS =
UCM_PREP_INCLUDES_PATHS =
%% END PREPARATORY INCLUDES PATHS LIST
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
%%
%% 8.5- Required dependency libraries pathnames list.
%%
%%
%% Enter the pathnames of your dependency libraries
%% separated by spaces after "=".
%% Put an "\" at end of line to continue list on next line.
@ -437,7 +451,7 @@ UCM_PREP_INCLUDES_PATHS =
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN PREPARATORY DEPENDANT LIBRARIES LIST -- Modify the following list...
UCM_PREP_DEP_LIBS_PATHNAMES =
UCM_PREP_DEP_LIBS_PATHNAMES =
%% END PREPARATORY DEPENDANT LIBRARIES LIST
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -452,7 +466,7 @@ UCM_PREP_DEP_LIBS_PATHNAMES =
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN PREPARATORY LIBRARIES LIST -- Modify the following list...
UCM_PREP_LIBRARIES =
UCM_PREP_LIBRARIES =
%% END PREPARATORY LIBRARIES LIST
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -527,7 +541,8 @@ UCM_PREP_LIBRARIES =
#define REMOTE_ADR "192.168.1.188"
#define MAX_VALUES 64
#define NO_SEND_DATA 3
#define NO_SEND_DATA 8
#define NO_RECV_DATA 8
/***** User Settings End ******/
@ -630,9 +645,9 @@ struct sockaddr_in rec_addr;
%%
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN SIMULATION INITIALIZATION FUNCTION CODE -- Enter code ->...
int ret;
unsigned int yes = 1;
unsigned int yes = 1;
if ((sockfd = socket(AF_INET, SOCK_DGRAM, 0)) < 0 ) {
perror("socket creation failed");
@ -643,7 +658,7 @@ struct sockaddr_in rec_addr;
perror("socket creation failed");
exit(EXIT_FAILURE);
}
memset(&rec_addr, 0, sizeof(rec_addr));
rec_addr.sin_family = AF_INET; // IPv4
rec_addr.sin_addr.s_addr = htonl(INADDR_ANY);
@ -654,12 +669,12 @@ struct sockaddr_in rec_addr;
send_addr.sin_addr.s_addr = inet_addr(REMOTE_ADR);
send_addr.sin_port = htons(PORT);
if (bind(sockfd, (struct sockaddr*)&rec_addr, sizeof(struct sockaddr_in)) < 0)
if (bind(sockfd, (struct sockaddr*)&rec_addr, sizeof(struct sockaddr_in)) < 0)
fprintf(stdout,"ERROR DETECTED !!! There is a problem in binding");
if (connect(sockfds, (struct sockaddr*)&send_addr, sizeof(struct sockaddr_in)) < 0)
if (connect(sockfds, (struct sockaddr*)&send_addr, sizeof(struct sockaddr_in)) < 0)
fprintf(stdout,"ERROR DETECTED !!! There is a problem in connecting");
#if 0
// Join a multicast group
struct ip_mreq mreq;
@ -687,7 +702,7 @@ struct sockaddr_in rec_addr;
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN BEFORE VOLTAGE CALCULATION CODE -- Enter code ->...
%% END BEFORE VOLTAGE CALCULATION CODE
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
%%
@ -696,9 +711,9 @@ struct sockaddr_in rec_addr;
%%
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN AFTER VOLTAGE CALCULATION -- Enter code ->...
int ret;
/* Receiving data */
char bufr[MSG_LEN(MAX_VALUES)];
struct msg *msgr = (struct msg *) bufr;
@ -706,23 +721,40 @@ struct sockaddr_in rec_addr;
struct sockaddr_in cli_addr;
int cli_addrlen = sizeof(cli_addr);
if (switchr == 1) {
if (switchr == 1) {
memset(&cli_addr, 0, sizeof(cli_addr));
memset((char *) msgr, 0, sizeof(bufr));
ret = recvfrom(sockfd, (char *) msgr, sizeof(bufr), 0, (struct sockaddr *) &cli_addr, &cli_addrlen);
msgr->length = htons(msgr->length);
msgr->sequence = htonl(msgr->sequence);
msgr->ts.sec = htonl(msgr->ts.sec);
msgr->ts.nsec = htonl(msgr->ts.nsec);
msgr->data[0].i = ntohl(msgr->data[0].i);
dataout = (float) msgr->data[0].f;
if (msgr->length >= NO_RECV_DATA) {
msgr->data[0].i = ntohl(msgr->data[0].i);
msgr->data[1].i = ntohl(msgr->data[1].i);
msgr->data[2].i = ntohl(msgr->data[2].i);
msgr->data[3].i = ntohl(msgr->data[3].i);
msgr->data[4].i = ntohl(msgr->data[4].i);
msgr->data[5].i = ntohl(msgr->data[5].i);
msgr->data[6].i = ntohl(msgr->data[6].i);
msgr->data[7].i = ntohl(msgr->data[7].i);
dataout0 = (float) msgr->data[0].f;
dataout1 = (float) msgr->data[1].f;
dataout2 = (float) msgr->data[2].f;
dataout3 = (float) msgr->data[3].f;
dataout4 = (float) msgr->data[4].f;
dataout5 = (float) msgr->data[5].f;
dataout6 = (float) msgr->data[6].f;
dataout7 = (float) msgr->data[7].f;
}
}
/* Sending data */
char buf[MSG_LEN(MAX_VALUES)];
char buf[MSG_LEN(NO_SEND_DATA)];
struct msg *msg = (struct msg *) buf;
struct timespec now;
@ -740,14 +772,29 @@ struct sockaddr_in rec_addr;
msg->ts.sec = now.tv_sec;
msg->ts.nsec = now.tv_nsec;
msg->data[0].f = datain;
msg->data[0].f = datain0;
msg->data[1].f = datain1;
msg->data[2].f = datain2;
msg->data[3].f = datain3;
msg->data[3].f = datain3;
msg->data[4].f = datain4;
msg->data[5].f = datain5;
msg->data[6].f = datain6;
msg->data[0].i = htonl(msg->data[0].i);
msg->data[1].i = htonl(msg->data[1].i);
msg->data[2].i = htonl(msg->data[2].i);
msg->data[3].i = htonl(msg->data[3].i);
msg->data[4].i = htonl(msg->data[4].i);
msg->data[5].i = htonl(msg->data[5].i);
msg->data[6].i = htonl(msg->data[6].i);
msg->data[7].i = htonl(msg->data[7].i);
msg->length = htons(msg->length);
msg->sequence = htonl(msg->sequence);
msg->ts.sec = htonl(msg->ts.sec);
msg->ts.nsec = htonl(msg->ts.nsec);
ret = sendto(sockfds, (char *) msg, MSG_LEN(NO_SEND_DATA), 0, (struct sockaddr *) &send_addr, sizeof(send_addr));
}
@ -761,7 +808,7 @@ struct sockaddr_in rec_addr;
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN SIMULATION INCLUDES PATHS LIST -- Modify the following list...
UCM_SIMULATION_INCLUDES_PATHS =
UCM_SIMULATION_INCLUDES_PATHS =
%% END SIMULATION INCLUDES PATHS LIST
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -776,7 +823,7 @@ UCM_SIMULATION_INCLUDES_PATHS =
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN SIMULATION DEP LIBS LIST -- Modify the following list...
UCM_SIMULATION_DEP_LIBS_PATHNAMES =
UCM_SIMULATION_DEP_LIBS_PATHNAMES =
%% END SIMULATION DEP LIBS LIST
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -788,20 +835,20 @@ UCM_SIMULATION_DEP_LIBS_PATHNAMES =
%%
%% ARCHITECTURE DEPENDANT PATHS: See NOTE in section 8.5
%%
%% UCM_SIMULATION_LIBRARIES_<ARCH>: use for compiler dependant librairies
%% UCM_SIMULATION_LIBRARIES_<ARCH>: use for compiler dependant librairies
%%
%%vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
%% BEGIN SIMULATION LIBRARIES LIST -- Modify the following list...
UCM_SIMULATION_LIBRARIES =
UCM_SIMULATION_LIBRARIES_WINDOWS =
UCM_SIMULATION_LIBRARIES_LINUX_RHEL5_32 =
UCM_SIMULATION_LIBRARIES_LINUX_RHEL6_64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES9_ia64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES10_ia64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES11SP1_x86_64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES11SP3_x86_64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES12SP1_x86_64 =
UCM_SIMULATION_LIBRARIES =
UCM_SIMULATION_LIBRARIES_WINDOWS =
UCM_SIMULATION_LIBRARIES_LINUX_RHEL5_32 =
UCM_SIMULATION_LIBRARIES_LINUX_RHEL6_64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES9_ia64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES10_ia64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES11SP1_x86_64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES11SP3_x86_64 =
UCM_SIMULATION_LIBRARIES_LINUX_SLES12SP1_x86_64 =
%% END SIMULATION LIBRARIES LIST
%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

4
clients/matlab/receiver.m
View file

@ -32,9 +32,9 @@ disp('Receiving data');
while i < num_samples
% Wait for connection
% Read data from the socket
[ dat, count ] = fread(t, num_values, 'float32');
data(:,i) = dat;
i = i + 1;
end

2
clients/opal/models/send_receive/Makefile.mk
View file

@ -41,7 +41,7 @@ ifneq ($(RTLAB_ROOT),)
endif
CC_OPTS = -std=c99 -D_GNU_SOURCE -MMD
LD_OPTS =
LD_OPTS =
OBJS = main.o msg.o utils.o socket.o $(INTEL_OBJS)
ifneq ($(PROTOCOL),)

28
clients/opal/models/send_receive/src/main.asv
View file

@ -66,7 +66,7 @@ static void * SendToIPPort(void *arg)
OpalPrint("%s: SendToIPPort: No transimission block for this controller. Stopping thread.\n", PROGNAME);
return NULL;
}
do {
/* This call unblocks when the 'Data Ready' line of a send icon is asserted. */
ret = OpalWaitForAsyncSendRequest(&SendID);
@ -109,7 +109,7 @@ static void * SendToIPPort(void *arg)
msg->data[i].f = (float) mdldata[i];
msg_hton(msg);
len = MSG_LEN(msg->length);
#elif PROTOCOL == GTNET_SKT
uint32_t *imsg = (uint32_t *) msg;
@ -117,7 +117,7 @@ static void * SendToIPPort(void *arg)
msg[i] = (float) mdldata[i];
imsg[i] = htonl(imsg[i]);
}
len = mdldata_size / sizeof(double) * sizeof(float);
#else
#error Unknown protocol
@ -185,12 +185,12 @@ static void * RecvFromIPPort(void *arg)
OpalPrint("%s: Timeout while waiting for data\n", PROGNAME, errno);
if (ret == -1) /* a more serious error, so we print it */
OpalPrint("%s: Error %d while waiting for data\n", PROGNAME, errno);
continue;
}
break;
}
/* Get the number of signals to send back to the model */
OpalGetAsyncRecvIconDataLength(&mdldata_size, RecvID);
cnt = mdldata_size / sizeof(double);
@ -202,18 +202,18 @@ static void * RecvFromIPPort(void *arg)
#if PROTOCOL == VILLAS
msg_ntoh(msg);
ret = msg_verify(msg);
if (ret) {
OpalPrint("%s: Skipping invalid packet\n", PROGNAME);
continue;
}
if (cnt > msg->length) {
OpalPrint("%s: Number of signals for RecvID=%d (%d) exceeds what was received (%d)\n",
PROGNAME, RecvID, cnt, msg->length);
}
for (int i = 0; i < msg->length; i++) {
mdldata[i] = (double) msg->data[i].f;
printf("Data rcvd from VILLAS %f\n", mdldata[i]);
@ -225,7 +225,7 @@ static void * RecvFromIPPort(void *arg)
uint32_t *imsg = (uint32_t *) msg;
for (int i = 0; i < cnt; i++)
imsg[i] = ntohl(imsg[i]);
printf("Protocol GTNET_SKT\n");
for (int i = 0; i < cnt; i++) {
mdldata[i] = (double) msg[i];
@ -259,7 +259,7 @@ int main(int argc, char *argv[])
fputs ("test file to check if main runs", testfile);
fclose (testfile);
}
int ret;
Opal_GenAsyncParam_Ctrl IconCtrlStruct;
@ -293,7 +293,7 @@ int main(int argc, char *argv[])
/* Get IP Controler Parameters (ie: ip address, port number...) and
* initialize the device on the QNX node. */
memset(&IconCtrlStruct, 0, sizeof(IconCtrlStruct));
ret = OpalGetAsyncCtrlParameters(&IconCtrlStruct, sizeof(IconCtrlStruct));
if (ret != EOK) {
OpalPrint("%s: ERROR: Could not get controller parameters (%d).\n", PROGNAME, ret);
@ -311,7 +311,7 @@ int main(int argc, char *argv[])
ret = pthread_create(&tid_send, NULL, SendToIPPort, NULL);
if (ret == -1)
OpalPrint("%s: ERROR: Could not create thread (SendToIPPort), errno %d\n", PROGNAME, errno);
ret = pthread_create(&tid_recv, NULL, RecvFromIPPort, NULL);
if (ret == -1)
OpalPrint("%s: ERROR: Could not create thread (RecvFromIPPort), errno %d\n", PROGNAME, errno);
@ -320,14 +320,14 @@ int main(int argc, char *argv[])
ret = pthread_join(tid_send, NULL);
if (ret != 0)
OpalPrint("%s: ERROR: pthread_join (SendToIPPort), errno %d\n", PROGNAME, ret);
ret = pthread_join(tid_recv, NULL);
if (ret != 0)
OpalPrint("%s: ERROR: pthread_join (RecvFromIPPort), errno %d\n", PROGNAME, ret);
/* Close the ip port and shared memories */
socket_close(&skt, IconCtrlStruct);
OpalCloseAsyncMem (ASYNC_SHMEM_SIZE, ASYNC_SHMEM_NAME);
OpalSystemCtrl_UnRegister(PRINT_SHMEM_NAME);

16
clients/opal/models/send_receive/src/main.c
View file

@ -138,15 +138,15 @@ static void *SendToIPPort(void *arg) {
OpalSetAsyncSendIconError(0, SendID);
/* This next call allows the execution of the "asynchronous" process
* to actually be synchronous with the model. To achieve this, you
* should set the "Sending Mode" in the Async_Send block to
* NEED_REPLY_BEFORE_NEXT_SEND or NEED_REPLY_NOW. This will force
* the model to wait for this process to call this
* OpalAsyncSendRequestDone function before continuing. */
* to actually be synchronous with the model. To achieve this, you
* should set the "Sending Mode" in the Async_Send block to
* NEED_REPLY_BEFORE_NEXT_SEND or NEED_REPLY_NOW. This will force
* the model to wait for this process to call this
* OpalAsyncSendRequestDone function before continuing. */
OpalAsyncSendRequestDone(SendID);
/* Before continuing, we make sure that the real-time model
* has not been stopped. If it has, we quit. */
* has not been stopped. If it has, we quit. */
ModelState = OpalGetAsyncModelState();
} while ((ModelState != STATE_RESET) && (ModelState != STATE_STOP));
@ -271,7 +271,7 @@ static void *RecvFromIPPort(void *arg) {
OpalSetAsyncRecvIconData(mdldata, mdldata_size, RecvID);
/* Before continuing, we make sure that the real-time model
* has not been stopped. If it has, we quit. */
* has not been stopped. If it has, we quit. */
ModelState = OpalGetAsyncModelState();
} while ((ModelState != STATE_RESET) && (ModelState != STATE_STOP));
@ -313,7 +313,7 @@ int main(int argc, char *argv[]) {
AssignProcToCpu0();
/* Get IP Controler Parameters (ie: ip address, port number...) and
* initialize the device on the QNX node. */
* initialize the device on the QNX node. */
memset(&IconCtrlStruct, 0, sizeof(IconCtrlStruct));
ret = OpalGetAsyncCtrlParameters(&IconCtrlStruct, sizeof(IconCtrlStruct));

8
clients/opal/models/send_receive/src/socket.c
View file

@ -153,9 +153,9 @@ int socket_recv(struct socket *s, char *data, int len, double timeout) {
tv.tv_usec = (int)((timeout - tv.tv_sec) * 1000000);
/* Wait for a packet. We use select() to have a timeout. This is
* necessary when reseting the model so we don't wait indefinitely
* and prevent the process from exiting and freeing the port for
* a future instance (model load). */
* necessary when reseting the model so we don't wait indefinitely
* and prevent the process from exiting and freeing the port for
* a future instance (model load). */
ret = select(s->sd + 1, &sd_set, (fd_set *)0, (fd_set *)0, &tv);
switch (ret) {
case -1: // Error
@ -165,7 +165,7 @@ int socket_recv(struct socket *s, char *data, int len, double timeout) {
default:
if (!(FD_ISSET(s->sd, &sd_set))) {
/* We received something, but it's not on "sd". Since sd is the only
* descriptor in the set... */
* descriptor in the set... */
OpalPrint("%s: RecvPacket: God, is that You trying to reach me?\n",
PROGNAME);
return -1;

73
clients/python/client.py
View file

@ -5,52 +5,53 @@
import villas_pb2
import time, socket, errno, sys, os, signal
layer = sys.argv[1] if len(sys.argv) == 2 else 'udp'
layer = sys.argv[1] if len(sys.argv) == 2 else "udp"
if layer not in ['udp', 'unix']:
raise Exception('Unsupported socket type')
if layer not in ["udp", "unix"]:
raise Exception("Unsupported socket type")
if layer == 'unix':
local = '/var/run/villas-node.client.sock'
remote = '/var/run/villas-node.server.sock'
if layer == "unix":
local = "/var/run/villas-node.client.sock"
remote = "/var/run/villas-node.server.sock"
skt = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
skt = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
# Delete stale sockets
if os.path.exists(local):
os.unlink(local)
elif layer == 'udp':
local = ('0.0.0.0', 12001)
remote = ('127.0.0.1', 12000)
# Delete stale sockets
if os.path.exists(local):
os.unlink(local)
elif layer == "udp":
local = ("0.0.0.0", 12001)
remote = ("127.0.0.1", 12000)
skt = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
skt = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
print('Start client...')
print("Start client...")
skt.bind(local)
# Try to connect in case Unix domain socket does not exist yet..
connected = False
while not connected:
try:
skt.connect(remote)
except socket.error as serr:
if serr.errno not in [ errno.ECONNREFUSED, errno.ENOENT ]:
raise serr
print('Not connected. Retrying in 1 sec')
time.sleep(1)
else:
connected = True
try:
skt.connect(remote)
except socket.error as serr:
if serr.errno not in [errno.ECONNREFUSED, errno.ENOENT]:
raise serr
print('Ready. Ctrl-C to quit.')
print("Not connected. Retrying in 1 sec")
time.sleep(1)
else:
connected = True
print("Ready. Ctrl-C to quit.")
msg = villas_pb2.Message()
# Gracefully shutdown
def sighandler(signum, frame):
running = False
running = False
signal.signal(signal.SIGINT, sighandler)
signal.signal(signal.SIGTERM, sighandler)
@ -58,15 +59,15 @@ signal.signal(signal.SIGTERM, sighandler)
running = True
while running:
dgram = skt.recv(1024)
if not dgram:
break
else:
msg.ParseFromString(dgram)
print(msg)
skt.send(msg.SerializeToString())
dgram = skt.recv(1024)
if not dgram:
break
else:
msg.ParseFromString(dgram)
print(msg)
skt.send(msg.SerializeToString())
skt.close()
print('Bye.')
print("Bye.")

28
cmake/FindCriterion.cmake Normal file
View file

@ -0,0 +1,28 @@
# Try to find Criterion
#
# Once done this will define
# CRITERION_FOUND - System has Criterion
# CRITERION_INCLUDE_DIRS - The Criterion include directories
# CRITERION_LIBRARIES - The libraries needed to use Criterion
#
# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
find_package(PkgConfig)
find_path(CRITERION_INCLUDE_DIR criterion/criterion.h
PATH_SUFFIXES criterion)
find_library(CRITERION_LIBRARY NAMES criterion libcriterion)
set(CRITERION_LIBRARIES ${CRITERION_LIBRARY})
set(CRITERION_INCLUDE_DIRS ${CRITERION_INCLUDE_DIR})
include(FindPackageHandleStandardArgs)
# Handle the QUIET and REQUIRED arguments and set CRITERION_FOUND to TRUE
# if all listed variables are TRUE
find_package_handle_standard_args(Criterion DEFAULT_MSG
CRITERION_LIBRARY CRITERION_INCLUDE_DIR)
mark_as_advanced(CRITERION_INCLUDE_DIR CRITERION_LIBRARY)

12
cmake/FindEtherlab.cmake
View file

@ -6,15 +6,15 @@
# SPDX-License-Identifier: Apache-2.0
find_path(ETHERLAB_INCLUDE_DIR
NAMES ecrt.h
PATHS
/opt/etherlab/include
NAMES ecrt.h
PATHS
/opt/etherlab/include
)
find_library(ETHERLAB_LIBRARY
NAMES ethercat
PATHS
/opt/etherlab/lib
NAMES ethercat
PATHS
/opt/etherlab/lib
)
include(FindPackageHandleStandardArgs)

6
cmake/FindIBVerbs.cmake
View file

@ -5,18 +5,18 @@
# SPDX-License-Identifier: Apache-2.0
find_path(IBVERBS_INCLUDE_DIR
NAMES infiniband/verbs.h
NAMES infiniband/verbs.h
)
find_library(IBVERBS_LIBRARY
NAMES ibverbs
NAMES ibverbs
)
include(FindPackageHandleStandardArgs)
# handle the QUIETLY and REQUIRED arguments and set VILLASNODE_FOUND to TRUE
# if all listed variables are TRUE
find_package_handle_standard_args(IBVerbs DEFAULT_MSG
IBVERBS_LIBRARY IBVERBS_INCLUDE_DIR)
IBVERBS_LIBRARY IBVERBS_INCLUDE_DIR)
mark_as_advanced(IBVERBS_INCLUDE_DIR IBVERBS_LIBRARY)

44
cmake/FindOpal.cmake
View file

@ -7,41 +7,41 @@
set(OPAL_PREFIX /usr/opalrt/common)
find_path(OPAL_INCLUDE_DIR
NAMES AsyncApi.h
HINTS
${OPAL_PREFIX}/include_target/
${PROJECT_SOURCE_DIR}/libopal/include/opal/
NAMES AsyncApi.h
HINTS
${OPAL_PREFIX}/include_target/
${PROJECT_SOURCE_DIR}/libopal/include/opal/
)
find_library(OPAL_LIBRARY
NAMES OpalAsyncApiCore
HINTS
${OPAL_PREFIX}/lib/
${PROJECT_SOURCE_DIR}/libopal/
NAMES OpalAsyncApiCore
HINTS
${OPAL_PREFIX}/lib/
${PROJECT_SOURCE_DIR}/libopal/
)
find_library(OPAL_LIBRARY_IRC
NAMES irc
HINTS
${OPAL_PREFIX}/lib/
${PROJECT_SOURCE_DIR}/libopal/
NAMES irc
HINTS
${OPAL_PREFIX}/lib/
${PROJECT_SOURCE_DIR}/libopal/
)
find_library(OPAL_LIBRARY_UTILS
NAMES OpalUtils
HINTS
${OPAL_PREFIX}/lib/redhawk/
${OPAL_PREFIX}/lib/redhawk64/
${PROJECT_SOURCE_DIR}/libopal/
NAMES OpalUtils
HINTS
${OPAL_PREFIX}/lib/redhawk/
${OPAL_PREFIX}/lib/redhawk64/
${PROJECT_SOURCE_DIR}/libopal/
)
find_library(OPAL_LIBRARY_CORE
NAMES OpalCore
HINTS
${OPAL_PREFIX}/lib/redhawk/
${OPAL_PREFIX}/lib/redhawk64/
${PROJECT_SOURCE_DIR}/libopal/
NAMES OpalCore
HINTS
${OPAL_PREFIX}/lib/redhawk/
${OPAL_PREFIX}/lib/redhawk64/
${PROJECT_SOURCE_DIR}/libopal/
)
include(FindPackageHandleStandardArgs)

6
cmake/FindRDMACM.cmake
View file

@ -5,18 +5,18 @@
# SPDX-License-Identifier: Apache-2.0
find_path(RDMACM_INCLUDE_DIR
NAMES rdma/rdma_cma.h
NAMES rdma/rdma_cma.h
)
find_library(RDMACM_LIBRARY
NAMES rdmacm
NAMES rdmacm
)
include(FindPackageHandleStandardArgs)
# handle the QUIETLY and REQUIRED arguments and set VILLASNODE_FOUND to TRUE
# if all listed variables are TRUE
find_package_handle_standard_args(RDMACM DEFAULT_MSG
RDMACM_LIBRARY RDMACM_INCLUDE_DIR)
RDMACM_LIBRARY RDMACM_INCLUDE_DIR)
mark_as_advanced(RDMACM_INCLUDE_DIR RDMACM_LIBRARY)

20
cmake/FindSymbol.cmake
View file

@ -5,16 +5,16 @@
# SPDX-License-Identifier: Apache-2.0
function(FindSymbol LIBRARY SYMBOL FOUND)
find_program(OBJDUMP_EXECUTABLE NAMES objdump)
find_program(OBJDUMP_EXECUTABLE NAMES objdump)
execute_process(
COMMAND /bin/sh -c "${OBJDUMP_EXECUTABLE} -T ${LIBRARY} | grep ${SYMBOL} | wc -l"
OUTPUT_VARIABLE OUTPUT
)
execute_process(
COMMAND /bin/sh -c "${OBJDUMP_EXECUTABLE} -T ${LIBRARY} | grep ${SYMBOL} | wc -l"
OUTPUT_VARIABLE OUTPUT
)
if(OUTPUT GREATER 0)
set(${FOUND} "${SYMBOL}" PARENT_SCOPE)
else()
set(${FOUND} "${SYMBOL}-NOTFOUND" PARENT_SCOPE)
endif()
if(OUTPUT GREATER 0)
set(${FOUND} "${SYMBOL}" PARENT_SCOPE)
else()
set(${FOUND} "${SYMBOL}-NOTFOUND" PARENT_SCOPE)
endif()
endfunction()

105
cmake/GetVersion.cmake Normal file
View file

@ -0,0 +1,105 @@
# CMakeLists.txt.
#
# Author: Steffen Vogel <post@steffenvogel.de>
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
#
# VILLASnode
# This CMake function sets the following variables:
#
# ${PREFIX}_VERSION_STR v0.6.3
# ${PREFIX}_VERSION 0.6.3
# ${PREFIX}_MAJOR_VERSION 0
# ${PREFIX}_MINOR_VERSION 6
# ${PREFIX}_PATCH_VERSION 3
# ${PREFIX}_RELEASE 1.ci_tests_release.20180823git1cd25c2f
# ${PREFIX}_GIT_REV 1cd25c2f
# ${PREFIX}_GIT_BRANCH ci-tests
# ${PREFIX}_GIT_BRANCH_NORM ci_tests
# ${PREFIX}_VARIANT release
# ${PREFIX}_VARIANT_NORM release
# ${PREFIX}_BUILD_ID v0.6.3-1cd25c2f-release
# ${PREFIX}_BUILD_DATE 20180823
function(GetVersion DIR PREFIX)
execute_process(
COMMAND git describe --tags --abbrev=0 --match "v*"
WORKING_DIRECTORY ${DIR}
OUTPUT_VARIABLE VERSION_STR
OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_QUIET
RESULT_VARIABLE RC
)
if(NOT RC EQUAL 0)
set(FOUND_GIT_VERSION OFF PARENT_SCOPE)
message(WARNING
"Failed to retrieve version information from Git. "
"Make sure that the source directory is a Git repo and "
"contains at least one valid tag like 'v0.1.0'"
)
else()
set(FOUND_GIT_VERSION ON PARENT_SCOPE)
string(REGEX REPLACE "^v([0-9]+\\.[0-9]+\\.[0-9]+)$" "\\1" VERSION ${VERSION_STR})
string(REGEX REPLACE "^v([0-9]+)\\.([0-9]+)\\.([0-9]+)$" "\\1" MAJOR_VERSION ${VERSION_STR})
string(REGEX REPLACE "^v([0-9]+)\\.([0-9]+)\\.([0-9]+)$" "\\2" MINOR_VERSION ${VERSION_STR})
string(REGEX REPLACE "^v([0-9]+)\\.([0-9]+)\\.([0-9]+)$" "\\3" PATCH_VERSION ${VERSION_STR})
string(TIMESTAMP BUILD_DATE "%Y%m%d")
if(CMAKE_BUILD_TYPE)
string(TOLOWER "${CMAKE_BUILD_TYPE}" VARIANT)
else()
set(VARIANT "release")
endif()
if(DEFINED ENV{CI})
string(APPEND VARIANT "-ci")
string(SUBSTRING $ENV{CI_COMMIT_SHA} 0 7 GIT_REV)
set(GIT_BRANCH $ENV{CI_COMMIT_REF_NAME})
else()
execute_process(
COMMAND git rev-parse --short=7 HEAD
WORKING_DIRECTORY ${DIR}
OUTPUT_VARIABLE GIT_REV
OUTPUT_STRIP_TRAILING_WHITESPACE
)
execute_process(
COMMAND git rev-parse --abbrev-ref HEAD
WORKING_DIRECTORY ${DIR}
OUTPUT_VARIABLE GIT_BRANCH
OUTPUT_STRIP_TRAILING_WHITESPACE
)
endif()
if(DEFINED ENV{CI_COMMIT_TAG})
set(RELEASE 1)
else()
string(REPLACE "-" "_" GIT_BRANCH_NORM ${GIT_BRANCH})
string(REPLACE "-" "_" VARIANT_NORM ${VARIANT})
set(RELEASE "1.${GIT_BRANCH_NORM}_${VARIANT_NORM}.${BUILD_DATE}git${GIT_REV}")
endif()
set(BUILD_ID "v${MAJOR_VERSION}.${MINOR_VERSION}.${PATCH_VERSION}-${GIT_REV}-${VARIANT}" )
# Return results to parent scope
set(${PREFIX}_VERSION_STR ${VERSION_STR} PARENT_SCOPE)
set(${PREFIX}_VERSION ${VERSION} PARENT_SCOPE)
set(${PREFIX}_MAJOR_VERSION ${MAJOR_VERSION} PARENT_SCOPE)
set(${PREFIX}_MINOR_VERSION ${MINOR_VERSION} PARENT_SCOPE)
set(${PREFIX}_PATCH_VERSION ${PATCH_VERSION} PARENT_SCOPE)
set(${PREFIX}_RELEASE ${RELEASE} PARENT_SCOPE)
set(${PREFIX}_GIT_REV ${GIT_REV} PARENT_SCOPE)
set(${PREFIX}_GIT_BRANCH ${GIT_BRANCH} PARENT_SCOPE)
set(${PREFIX}_GIT_BRANCH_NORM ${GIT_BRANCH_NORM} PARENT_SCOPE)
set(${PREFIX}_VARIANT ${VARIANT} PARENT_SCOPE)
set(${PREFIX}_VARIANT_NORM ${VARIANT_NORM} PARENT_SCOPE)
set(${PREFIX}_BUILD_ID ${BUILD_ID} PARENT_SCOPE)
set(${PREFIX}_BUILD_DATE ${BUILD_DATE} PARENT_SCOPE)
endif()
endfunction(GetVersion)

1
common

@ -1 +0,0 @@
Subproject commit 3a66d8ff657c0824138a03df0aca1b16c88d582a

38
common/CMakeLists.txt Normal file
View file

@ -0,0 +1,38 @@
## CMakeLists.txt
#
# Author: Steffen Vogel <post@steffenvogel.de>
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
include(FindPkgConfig)
include(FeatureSummary)
include(GNUInstallDirs)
# Check packages
find_package(OpenSSL 1.0.0 REQUIRED)
find_package(CURL 7.29 REQUIRED)
find_package(spdlog 1.6.0 REQUIRED)
find_package(fmt 6.0.0 REQUIRED)
find_package(Criterion)
pkg_check_modules(JANSSON IMPORTED_TARGET REQUIRED jansson>=2.7)
pkg_check_modules(LIBCONFIG IMPORTED_TARGET libconfig>=1.4.9)
pkg_check_modules(UUID IMPORTED_TARGET REQUIRED uuid>=2.23)
if(fmt_VERSION VERSION_LESS "9.0.0")
message("Using legacy ostream formatting")
set(FMT_LEGACY_OSTREAM_FORMATTER 1)
endif()
add_subdirectory(lib)
if(WITH_TESTS)
add_subdirectory(tests)
endif()
# Disable any colored log output
option(LOG_COLOR_DISABLE "Disable any colored log output" OFF)
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/include/villas/config.hpp.in
${CMAKE_CURRENT_BINARY_DIR}/include/villas/config.hpp
)

51
common/include/villas/boxes.hpp Normal file
View file

@ -0,0 +1,51 @@
/* Various helper functions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
// The suffixed of the BOX_ macro a constructed by
// combining the following letters in the written order:
// - U for a line facing upwards
// - D for a line facing downwards
// - L for a line facing leftwards
// - R for a line facing rightwards
//
// E.g. a cross can be constructed by combining all line fragments:
// BOX_UDLR
#if 0 // Alternate character set
#define BOX(chr) "\e(0" chr "\e(B"
#define BOX_LR BOX("\x71") // Boxdrawing: ─
#define BOX_UD BOX("\x78") // Boxdrawing: │
#define BOX_UDR BOX("\x74") // Boxdrawing: ├
#define BOX_UDLR BOX("\x6E") // Boxdrawing: ┼
#define BOX_UDL BOX("\x75") // Boxdrawing: ┤
#define BOX_ULR BOX("\x76") // Boxdrawing: ┴
#define BOX_UL BOX("\x6A") // Boxdrawing: ┘
#define BOX_DLR BOX("\x77") // Boxdrawing: ┘
#define BOX_DL BOX("\x6B") // Boxdrawing: ┘
#elif 1 // UTF-8
#define BOX_LR "─" // Boxdrawing: ─
#define BOX_UD "│" // Boxdrawing: │
#define BOX_UDR "├" // Boxdrawing: ├
#define BOX_UDLR "┼" // Boxdrawing: ┼
#define BOX_UDL "┤" // Boxdrawing: ┤
#define BOX_ULR "┴" // Boxdrawing: ┴
#define BOX_UL "┘" // Boxdrawing: ┘
#define BOX_DLR "┬" // Boxdrawing: ┘
#define BOX_DL "┐" // Boxdrawing: ┘
#define BOX_UR "└" // Boxdrawing: └
#else // ASCII
#define BOX_LR "-" // Boxdrawing: ─
#define BOX_UD "|" // Boxdrawing: │
#define BOX_UDR "+" // Boxdrawing: ├
#define BOX_UDLR "+" // Boxdrawing: ┼
#define BOX_UDL "+" // Boxdrawing: ┤
#define BOX_ULR "+" // Boxdrawing: ┴
#define BOX_UL "+" // Boxdrawing: ┘
#define BOX_DLR "+" // Boxdrawing: ┘
#define BOX_DL "+" // Boxdrawing: ┘
#endif

37
common/include/villas/buffer.hpp Normal file
View file

@ -0,0 +1,37 @@
/* A simple buffer for encoding streamed JSON messages.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <vector>
#include <cstdlib>
#include <jansson.h>
namespace villas {
class Buffer : public std::vector<char> {
protected:
static int callback(const char *data, size_t len, void *ctx);
public:
Buffer(const char *buf, size_type len) : std::vector<char>(buf, buf + len) {}
Buffer(size_type count = 0) : std::vector<char>(count, 0) {}
// Encode JSON document /p j and append it to the buffer
int encode(json_t *j, int flags = 0);
// Decode JSON document from the beginning of the buffer
json_t *decode();
void append(const char *data, size_t len) { insert(end(), data, data + len); }
};
} // namespace villas

31
common/include/villas/colors.hpp Normal file
View file

@ -0,0 +1,31 @@
/* Various helper functions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <villas/config.hpp>
// CPP stringification
#define XSTR(x) STR(x)
#define STR(x) #x
// Some color escape codes for pretty log messages
#ifdef LOG_COLOR_DISABLE
#define CLR(clr, str) str
#else
#define CLR(clr, str) "\e[" XSTR(clr) "m" str "\e[0m"
#endif
#define CLR_GRY(str) CLR(30, str) // Print str in gray
#define CLR_RED(str) CLR(31, str) // Print str in red
#define CLR_GRN(str) CLR(32, str) // Print str in green
#define CLR_YEL(str) CLR(33, str) // Print str in yellow
#define CLR_BLU(str) CLR(34, str) // Print str in blue
#define CLR_MAG(str) CLR(35, str) // Print str in magenta
#define CLR_CYN(str) CLR(36, str) // Print str in cyan
#define CLR_WHT(str) CLR(37, str) // Print str in white
#define CLR_BLD(str) CLR(1, str) // Print str in bold

36
common/include/villas/common.hpp Normal file
View file

@ -0,0 +1,36 @@
/* Some common defines, enums and datastructures.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <string>
// Common states for most objects in VILLAScommon (paths, nodes, hooks, plugins)
enum class State {
DESTROYED = 0,
INITIALIZED = 1,
PARSED = 2,
CHECKED = 3,
STARTED = 4,
STOPPED = 5,
PENDING_CONNECT = 6,
CONNECTED = 7,
PAUSED = 8,
STARTING = 9,
STOPPING = 10,
PAUSING = 11,
RESUMING = 12,
PREPARED = 13
};
// Callback to destroy list elements.
//
// @param data A pointer to the data which should be freed.
typedef int (*dtor_cb_t)(void *);
// Convert state enum to human readable string.
std::string stateToString(enum State s);

44
common/include/villas/compat.hpp Normal file
View file

@ -0,0 +1,44 @@
/* Compatability for different library versions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <jansson.h>
#include <villas/config.hpp>
#if JANSSON_VERSION_HEX < 0x020A00
size_t json_dumpb(const json_t *json, char *buffer, size_t size, size_t flags);
int json_dumpfd(const json_t *json, int output, size_t flags);
json_t *json_loadfd(int input, size_t flags, json_error_t *error);
#endif
#if defined(WITH_CONFIG) && (LIBCONFIG_VER_MAJOR <= 1) && \
(LIBCONFIG_VER_MINOR < 5)
#include <libconfig.h>
#define config_setting_lookup config_lookup_from
#endif
#ifdef __MACH__
#include <libkern/OSByteOrder.h>
#define le16toh(x) OSSwapLittleToHostInt16(x)
#define le32toh(x) OSSwapLittleToHostInt32(x)
#define le64toh(x) OSSwapLittleToHostInt64(x)
#define be16toh(x) OSSwapBigToHostInt16(x)
#define be32toh(x) OSSwapBigToHostInt32(x)
#define be64toh(x) OSSwapBigToHostInt64(x)
#define htole16(x) OSSwapHostToLittleInt16(x)
#define htole32(x) OSSwapHostToLittleInt32(x)
#define htole64(x) OSSwapHostToLittleInt64(x)
#define htobe16(x) OSSwapHostToBigInt16(x)
#define htobe32(x) OSSwapHostToBigInt32(x)
#define htobe64(x) OSSwapHostToBigInt64(x)
#endif // __MACH__

52
common/include/villas/config.hpp.in Normal file
View file

@ -0,0 +1,52 @@
/** Compile time configuration
*
* This file contains some compiled-in settings.
* This settings are not part of the configuration file.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*********************************************************************************/
#pragma once
#define PROJECT_VERSION_STR "@CMAKE_PROJECT_VERSION_STR@"
#define PROJECT_VERSION "@CMAKE_PROJECT_VERSION@"
#define PROJECT_MAJOR_VERSION @CMAKE_PROJECT_MAJOR_VERSION@
#define PROJECT_MINOR_VERSION @CMAKE_PROJECT_MINOR_VERSION@
#define PROJECT_PATCH_VERSION @CMAKE_PROJECT_PATCH_VERSION@
#define PROJECT_RELEASE "@CMAKE_PROJECT_RELEASE@"
#define PROJECT_GIT_REV "@CMAKE_PROJECT_GIT_REV@"
#define PROJECT_GIT_BRANCH "@CMAKE_PROJECT_GIT_BRANCH@"
#define PROJECT_GIT_BRANCH_NORM "@CMAKE_PROJECT_GIT_BRANCH_NORM@"
#define PROJECT_VARIANT "@CMAKE_PROJECT_VARIANT@"
#define PROJECT_VARIANT_NORM "@CMAKE_PROJECT_VARIANT_NORM@"
#define PROJECT_BUILD_ID "@CMAKE_PROJECT_BUILD_ID@"
#define PROJECT_BUILD_DATE "@CMAKE_PROJECT_BUILD_DATE@"
#define PROJECT_HOMEPAGE_URL "@CMAKE_PROJECT_HOMEPAGE_URL@"
#define PROJECT_NAME "@CMAKE_PROJECT_DESCRIPTION@"
#define HTTP_USER_AGENT PROJECT_NAME " (" PROJECT_BUILD_ID ")"
// Hard-coded cache line size
#if defined(__x86_64__) || defined(__i386__) || defined(__arm__) || defined(__aarch64__)
#define CACHELINE_SIZE 64
#else
#error "Unsupported architecture"
#endif
// Paths
#define PREFIX "@CMAKE_INSTALL_PREFIX@"
#define PLUGIN_PATH "@CMAKE_INSTALL_PREFIX@/share/villas/node/plugins"
#define SYSFS_PATH "/sys"
#define PROCFS_PATH "/proc"
// Width of log output in characters
#define LOG_WIDTH 80
#define LOG_HEIGHT 25
#cmakedefine LOG_COLOR_DISABLE
// Library Features
#cmakedefine FMT_LEGACY_OSTREAM_FORMATTER

126
common/include/villas/cpuset.hpp Normal file
View file

@ -0,0 +1,126 @@
/* Human readable cpusets.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#ifdef __linux__
#include <cstdint>
#include <sched.h>
#include <villas/exceptions.hpp>
namespace villas {
namespace utils {
class CpuSet {
protected:
cpu_set_t *setp;
unsigned num_cpus;
size_t sz;
public:
CpuSet() : num_cpus(sizeof(uintmax_t) * 8), sz(CPU_ALLOC_SIZE(num_cpus)) {
setp = CPU_ALLOC(num_cpus);
if (!setp)
throw MemoryAllocationError();
zero();
}
// Parses string with list of CPU ranges.
//
// @param str Human readable representation of the set.
CpuSet(const std::string &str);
CpuSet(const char *str);
// Convert integer to cpu_set_t.
//
// @param set An integer number which is used as the mask
CpuSet(uintmax_t set);
// Convert cpu_set_t to an integer. */
operator uintmax_t();
operator const cpu_set_t *() { return setp; }
// Returns human readable representation of the cpuset.
//
// The output format is a list of CPUs with ranges (for example, "0,1,3-9").
operator std::string();
~CpuSet() { CPU_FREE(setp); }
CpuSet(const CpuSet &src) : CpuSet(src.num_cpus) {
memcpy(setp, src.setp, sz);
}
bool empty() const { return count() == 0; }
bool full() const { return count() == num_cpus; }
unsigned count() const { return CPU_COUNT_S(sz, setp); }
void zero() { CPU_ZERO_S(sz, setp); }
size_t size() const { return sz; }
CpuSet operator~() {
CpuSet full = UINTMAX_MAX;
return full ^ *this;
}
bool operator==(const CpuSet &rhs) { return CPU_EQUAL_S(sz, setp, rhs.setp); }
CpuSet &operator&=(const CpuSet &rhs) {
CPU_AND_S(sz, setp, setp, rhs.setp);
return *this;
}
CpuSet &operator|=(const CpuSet &rhs) {
CPU_OR_S(sz, setp, setp, rhs.setp);
return *this;
}
CpuSet &operator^=(const CpuSet &rhs) {
CPU_XOR_S(sz, setp, setp, rhs.setp);
return *this;
}
friend CpuSet operator&(CpuSet lhs, const CpuSet &rhs) {
lhs &= rhs;
return lhs;
}
friend CpuSet operator|(CpuSet lhs, const CpuSet &rhs) {
lhs |= rhs;
return lhs;
}
friend CpuSet operator^(CpuSet lhs, const CpuSet &rhs) {
lhs ^= rhs;
return lhs;
}
bool operator[](size_t cpu) const { return isSet(cpu); }
bool isSet(size_t cpu) const { return CPU_ISSET_S(cpu, sz, setp); }
void clear(size_t cpu) { CPU_CLR_S(cpu, sz, setp); }
void set(size_t cpu) { CPU_SET_S(cpu, sz, setp); }
};
} // namespace utils
} // namespace villas
#endif

32
common/include/villas/dsp/exponential_window.hpp Normal file
View file

@ -0,0 +1,32 @@
/* An exponential window.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <villas/dsp/window.hpp>
namespace villas {
namespace dsp {
template <typename T> class ExponentialWindow {
protected:
T a;
T last;
public:
ExponentialWindow(T _a, T i = 0) : a(a), last(i) {}
T update(T in) {
last = a * in + (1 - a) * last;
return last;
}
};
} // namespace dsp
} // namespace villas

35
common/include/villas/dsp/moving_average_window.hpp Normal file
View file

@ -0,0 +1,35 @@
/* A moving average window.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstddef>
#include <villas/dsp/window.hpp>
namespace villas {
namespace dsp {
template <typename T> class MovingAverageWindow : public Window<T> {
protected:
T state;
public:
MovingAverageWindow(size_t len, T i = 0) : Window<T>(len, i), state(i) {}
T update(T in) {
T out = Window<T>::update(in);
state += in;
state -= out;
return state / (double)Window<T>::getLength();
}
};
} // namespace dsp
} // namespace villas

39
common/include/villas/dsp/pid.hpp Normal file
View file

@ -0,0 +1,39 @@
/* A PID controller.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
namespace villas {
namespace dsp {
class PID {
protected:
double dt;
double max;
double min;
double Kp;
double Kd;
double Ki;
double pre_error;
double integral;
public:
// Kp - proportional gain
// Ki - Integral gain
// Kd - derivative gain
// dt - loop interval time
// max - maximum value of manipulated variable
// min - minimum value of manipulated variable
PID(double _dt, double _max, double _min, double _Kp, double _Kd, double _Ki);
// Returns the manipulated variable given a setpoint and current process value
double calculate(double setpoint, double pv);
};
} // namespace dsp
} // namespace villas

73
common/include/villas/dsp/window.hpp Normal file
View file

@ -0,0 +1,73 @@
/* A sliding/moving window.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <deque>
namespace villas {
namespace dsp {
template <typename T, typename Container = std::deque<T>>
class Window : protected Container {
public:
using iterator = typename Container::iterator;
using size_type = typename Container::size_type;
protected:
virtual T filter(T in, size_type i) const { return in; }
class transform_iterator : public Container::const_iterator {
protected:
const Window *window;
using base_iterator = typename Container::const_iterator;
public:
transform_iterator(const Window<T> *w)
: base_iterator(w->Container::begin()), window(w) {}
T operator*() {
auto i = (*this) - window->begin();
const auto &v = base_iterator::operator*();
return window->filter(v, i);
}
};
public:
Window(size_type l = 0, T i = 0) : Container(l, i) {}
T val(size_type pos) { return this->Container::operator[](pos); }
T update(T in) {
Container::push_back(in);
auto out = (*this)[0];
Container::pop_front();
return out;
}
// Expose a limited number of functions from deque
using Container::end;
using Container::size;
transform_iterator begin() const noexcept { return transform_iterator(this); }
T operator[](size_type i) const noexcept {
auto v = Container::operator[](i);
return filter(v, i);
}
};
} // namespace dsp
} // namespace villas

98
common/include/villas/dsp/window_cosine.hpp Normal file
View file

@ -0,0 +1,98 @@
/* A sliding/moving window using a Cosine weighting.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cmath>
#include <vector>
#include <villas/dsp/window.hpp>
namespace villas {
namespace dsp {
template <
typename T> // a0 = 1.0, double a1 = 0.0, double a2 = 0.0, double a3 = 0.0, double a4 = 0.0>
class CosineWindow : public Window<T> {
public:
using size_type = typename Window<T>::size_type;
protected:
std::vector<T> coefficients;
T correctionFactor;
virtual T filter(T in, size_type i) const { return in * coefficients[i]; }
public:
CosineWindow(double a0, double a1, double a2, double a3, double a4,
size_type len, T i = 0)
: Window<T>(len, i), coefficients(len), correctionFactor(0) {
for (unsigned i = 0; i < len; i++) {
coefficients[i] =
a0 - a1 * cos(2 * M_PI * i / len) + a2 * cos(4 * M_PI * i / len) -
a3 * cos(6 * M_PI * i / len) + a4 * cos(8 * M_PI * i / len);
correctionFactor += coefficients[i];
}
correctionFactor /= len;
}
virtual T getCorrectionFactor() const { return correctionFactor; }
};
// From: https://en.wikipedia.org/wiki/Window_function#Cosine-sum_windows
template <typename T> class RectangularWindow : public CosineWindow<T> {
public:
RectangularWindow(typename Window<T>::size_type len, T i = 0)
: CosineWindow<T>(1, 0., 0., 0., 0., len, i) {}
};
template <typename T> class HannWindow : public CosineWindow<T> {
public:
HannWindow(typename Window<T>::size_type len, T i = 0)
: CosineWindow<T>(0.5, 0.5, 0., 0., 0., len, i) {}
};
template <typename T> class HammingWindow : public CosineWindow<T> {
public:
HammingWindow(typename Window<T>::size_type len, T i = 0)
: CosineWindow<T>(25. / 46, 1 - 25. / 46, 0., 0., 0., len, i) {}
};
template <typename T> class FlattopWindow : public CosineWindow<T> {
public:
FlattopWindow(typename Window<T>::size_type len, T i = 0)
: CosineWindow<T>(0.21557895, 0.41663158, 0.277263158, 0.083578947,
0.006947368, len, i) {}
};
template <typename T> class NuttallWindow : public CosineWindow<T> {
public:
NuttallWindow(typename Window<T>::size_type len, T i = 0)
: CosineWindow<T>(0.355768, 0.487396, 0.144232, 0.012604, 0., len, i) {}
};
template <typename T> class BlackmanWindow : public CosineWindow<T> {
public:
BlackmanWindow(typename Window<T>::size_type len, T i = 0)
: CosineWindow<T>(0.3635819, 0.4891775, 0.1365995, 0.0106411, 0., len,
i) {}
};
} // namespace dsp
} // namespace villas

143
common/include/villas/exceptions.hpp Normal file
View file

@ -0,0 +1,143 @@
/* Common exceptions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cerrno>
#include <sstream>
#include <string>
#include <system_error>
#include <utility>
#include <fmt/core.h>
#include <jansson.h>
#include <villas/config.hpp>
namespace villas {
class SystemError : public std::system_error {
public:
SystemError(const std::string &what)
: std::system_error(errno, std::system_category(), what) {}
template <typename... Args>
SystemError(const std::string &what, Args &&...args)
: SystemError(fmt::format(what, std::forward<Args>(args)...)) {}
};
class RuntimeError : public std::runtime_error {
public:
template <typename... Args>
RuntimeError(const std::string &what, Args &&...args)
: std::runtime_error(fmt::format(what, std::forward<Args>(args)...)) {}
};
class MemoryAllocationError : public RuntimeError {
public:
MemoryAllocationError() : RuntimeError("Failed to allocate memory") {}
};
class JsonError : public std::runtime_error {
protected:
json_error_t error;
public:
template <typename... Args>
JsonError(const json_t *s, const json_error_t &e,
const std::string &what = std::string(), Args &&...args)
: std::runtime_error(
fmt::format("{}: {} in {}:{}:{}",
fmt::format(what, std::forward<Args>(args)...),
error.text, error.source, error.line, error.column)),
error(e) {}
};
class ConfigError : public std::runtime_error {
protected:
// A setting-id referencing the setting.
std::string id;
json_t *setting;
json_error_t error;
char *msg;
std::string getMessage() const {
std::stringstream ss;
ss << std::runtime_error::what() << std::endl;
if (error.position >= 0) {
ss << std::endl;
ss << " " << error.text << " in " << error.source << ":" << error.line
<< ":" << error.column << std::endl;
}
ss << std::endl
<< " Please consult the user documentation for details: " << std::endl;
ss << " " << docUri();
ss << std::endl;
return ss.str();
}
public:
~ConfigError() {
if (msg)
free(msg);
}
template <typename... Args>
ConfigError(json_t *s, const std::string &i,
const std::string &what = "Failed to parse configuration")
: std::runtime_error(what), id(i), setting(s) {
error.position = -1;
msg = strdup(getMessage().c_str());
}
template <typename... Args>
ConfigError(json_t *s, const std::string &i, const std::string &what,
Args &&...args)
: std::runtime_error(fmt::format(what, std::forward<Args>(args)...)),
id(i), setting(s) {
error.position = -1;
msg = strdup(getMessage().c_str());
}
template <typename... Args>
ConfigError(json_t *s, const json_error_t &e, const std::string &i,
const std::string &what = "Failed to parse configuration")
: std::runtime_error(what), id(i), setting(s), error(e) {
msg = strdup(getMessage().c_str());
}
template <typename... Args>
ConfigError(json_t *s, const json_error_t &e, const std::string &i,
const std::string &what, Args &&...args)
: std::runtime_error(fmt::format(what, std::forward<Args>(args)...)),
id(i), setting(s), error(e) {
msg = strdup(getMessage().c_str());
}
std::string docUri() const {
std::string baseUri = "https://villas.fein-aachen.org/doc/jump?";
return baseUri + id;
}
virtual const char *what() const noexcept { return msg; }
};
} // namespace villas

255
common/include/villas/graph/directed.hpp Normal file
View file

@ -0,0 +1,255 @@
/* A directed graph.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <algorithm>
#include <fstream>
#include <list>
#include <map>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <string>
#include <villas/graph/edge.hpp>
#include <villas/graph/vertex.hpp>
#include <villas/log.hpp>
namespace villas {
namespace graph {
template <typename VertexType = Vertex, typename EdgeType = Edge>
class DirectedGraph {
public:
using VertexIdentifier = Vertex::Identifier;
using EdgeIdentifier = Edge::Identifier;
using Path = std::list<EdgeIdentifier>;
DirectedGraph(const std::string &name = "DirectedGraph")
: lastVertexId(0), lastEdgeId(0), logger(Log::get(name)) {}
std::shared_ptr<VertexType> getVertex(VertexIdentifier vertexId) const {
// Cannot use [] operator, because creates non-existing elements
// at() will throw std::out_of_range if element does not exist
return vertices.at(vertexId);
}
template <class UnaryPredicate>
VertexIdentifier findVertex(UnaryPredicate p) {
for (auto &v : vertices) {
auto &vertexId = v.first;
auto &vertex = v.second;
if (p(vertex)) {
return vertexId;
}
}
throw std::out_of_range("vertex not found");
}
std::shared_ptr<EdgeType> getEdge(EdgeIdentifier edgeId) const {
if (edgeId >= lastEdgeId)
throw std::invalid_argument("edge doesn't exist");
// Cannot use [] operator, because creates non-existing elements
// at() will throw std::out_of_range if element does not exist
return edges.at(edgeId);
}
std::size_t getEdgeCount() const { return edges.size(); }
std::size_t getVertexCount() const { return vertices.size(); }
VertexIdentifier addVertex(std::shared_ptr<VertexType> vertex) {
vertex->id = lastVertexId++;
logger->debug("New vertex: {}", vertex->toString());
vertices[vertex->id] = vertex;
return vertex->id;
}
EdgeIdentifier addEdge(std::shared_ptr<EdgeType> edge,
VertexIdentifier fromVertexId,
VertexIdentifier toVertexId) {
// Allocate edge id
edge->id = lastEdgeId++;
// Connect it
edge->from = fromVertexId;
edge->to = toVertexId;
logger->debug("New edge {}: {} -> {}", edge->toString(), edge->from,
edge->to);
// This is a directed graph, so only push edge to starting vertex
getVertex(edge->from)->edges.push_back(edge->id);
// Add new edge to graph
edges[edge->id] = edge;
return edge->id;
}
EdgeIdentifier addDefaultEdge(VertexIdentifier fromVertexId,
VertexIdentifier toVertexId) {
// Create a new edge
std::shared_ptr<EdgeType> edge(new EdgeType);
return addEdge(edge, fromVertexId, toVertexId);
}
void removeEdge(EdgeIdentifier edgeId) {
auto edge = getEdge(edgeId);
auto startVertex = getVertex(edge->from);
// Remove edge only from starting vertex (this is a directed graph)
logger->debug("Remove edge {} from vertex {}", edgeId, edge->from);
startVertex->edges.remove(edgeId);
logger->debug("Remove edge {}", edgeId);
edges.erase(edgeId);
}
void removeVertex(VertexIdentifier vertexId) {
// Delete every edge that start or ends at this vertex
auto it = edges.begin();
while (it != edges.end()) {
auto &edgeId = it->first;
auto &edge = it->second;
bool removeEdge = false;
if (edge->to == vertexId) {
logger->debug("Remove edge {} from vertex {}'s edge list", edgeId,
edge->from);
removeEdge = true;
auto startVertex = getVertex(edge->from);
startVertex->edges.remove(edge->id);
}
if ((edge->from == vertexId) or removeEdge) {
logger->debug("Remove edge {}", edgeId);
// Remove edge from global edge list
it = edges.erase(it);
} else
++it;
}
logger->debug("Remove vertex {}", vertexId);
vertices.erase(vertexId);
lastVertexId--;
}
const std::list<EdgeIdentifier> &
vertexGetEdges(VertexIdentifier vertexId) const {
return getVertex(vertexId)->edges;
}
using check_path_fn = std::function<bool(const Path &)>;
static bool checkPath(const Path &) { return true; }
bool getPath(VertexIdentifier fromVertexId, VertexIdentifier toVertexId,
Path &path, check_path_fn pathCheckFunc = checkPath) {
if (fromVertexId == toVertexId)
// Arrived at the destination
return true;
else {
auto fromVertex = getVertex(fromVertexId);
for (auto &edgeId : fromVertex->edges) {
auto edgeOfFromVertex = getEdge(edgeId);
// Loop detection
bool loop = false;
for (auto &edgeIdInPath : path) {
auto edgeInPath = getEdge(edgeIdInPath);
if (edgeInPath->from == edgeOfFromVertex->to) {
loop = true;
break;
}
}
if (loop) {
logger->debug("Loop detected via edge {}", edgeId);
continue;
}
// Remember the path we're investigating to detect loops
path.push_back(edgeId);
// Recursive, depth-first search
if (getPath(edgeOfFromVertex->to, toVertexId, path, pathCheckFunc) and
pathCheckFunc(path))
// Path found, we're done
return true;
else
// Tear down path that didn't lead to the destination
path.pop_back();
}
}
return false;
}
void dump(const std::string &fileName = "") const {
logger->info("Vertices:");
for (auto &v : vertices) {
auto &vertex = v.second;
// Format connected vertices into a list
std::stringstream ssEdges;
for (auto &edge : vertex->edges) {
ssEdges << getEdge(edge)->to << " ";
}
logger->info(" {} connected to: {}", vertex->toString(), ssEdges.str());
}
std::fstream s(fileName, s.out | s.trunc);
if (s.is_open()) {
s << "digraph memgraph {" << std::endl;
}
logger->info("Edges:");
for (auto &e : edges) {
auto &edge = e.second;
logger->info(" {}: {} -> {}", edge->toString(), edge->from, edge->to);
if (s.is_open()) {
auto from = getVertex(edge->from);
auto to = getVertex(edge->to);
s << std::dec;
s << " \"" << *from << "\" -> \"" << *to << "\""
<< " [label=\"" << *edge << "\"];" << std::endl;
}
}
if (s.is_open()) {
s << "}" << std::endl;
s.close();
}
}
protected:
VertexIdentifier lastVertexId;
EdgeIdentifier lastEdgeId;
std::map<VertexIdentifier, std::shared_ptr<VertexType>> vertices;
std::map<EdgeIdentifier, std::shared_ptr<EdgeType>> edges;
Logger logger;
};
} // namespace graph
} // namespace villas

51
common/include/villas/graph/edge.hpp Normal file
View file

@ -0,0 +1,51 @@
/* A graph edge.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <fmt/ostream.h>
#include <villas/config.hpp>
#include <villas/graph/vertex.hpp>
namespace villas {
namespace graph {
class Edge {
template <typename VertexType, typename EdgeType> friend class DirectedGraph;
public:
using Identifier = std::size_t;
friend std::ostream &operator<<(std::ostream &stream, const Edge &edge) {
return stream << edge.id;
}
bool operator==(const Edge &other) { return this->id == other.id; }
Vertex::Identifier getVertexTo() const { return to; }
Vertex::Identifier getVertexFrom() const { return from; }
std::string toString() {
std::stringstream ss;
ss << *this;
return ss.str();
}
private:
Identifier id;
Vertex::Identifier from;
Vertex::Identifier to;
};
} // namespace graph
} // namespace villas
#ifndef FMT_LEGACY_OSTREAM_FORMATTER
template <>
class fmt::formatter<villas::graph::Edge> : public fmt::ostream_formatter {};
#endif

52
common/include/villas/graph/vertex.hpp Normal file
View file

@ -0,0 +1,52 @@
/* A graph vertex.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <fmt/ostream.h>
#include <list>
#include <sstream>
#include <villas/config.hpp>
namespace villas {
namespace graph {
class Vertex {
template <typename VertexType, typename EdgeType> friend class DirectedGraph;
public:
using Identifier = std::size_t;
Vertex() : id(0) {}
const Identifier &getIdentifier() const { return id; }
friend std::ostream &operator<<(std::ostream &stream, const Vertex &vertex) {
return stream << vertex.id;
}
bool operator==(const Vertex &other) { return this->id == other.id; }
std::string toString() {
std::stringstream ss;
ss << *this;
return ss.str();
}
private:
Identifier id;
// HACK: how to resolve this circular type dependency?
std::list<std::size_t> edges;
};
} // namespace graph
} // namespace villas
#ifndef FMT_LEGACY_OSTREAM_FORMATTER
template <>
class fmt::formatter<villas::graph::Vertex> : public fmt::ostream_formatter {};
#endif

99
common/include/villas/hist.hpp Normal file
View file

@ -0,0 +1,99 @@
/* Histogram class.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <vector>
#include <jansson.h>
#include <villas/log.hpp>
#define HEIGHT (LOG_WIDTH - 55)
#define SEQ 17
namespace villas {
// Histogram structure used to collect statistics.
class Hist {
public:
using cnt_t = uintmax_t;
using idx_t = std::vector<cnt_t>::difference_type;
// Initialize struct Hist with supplied values and allocate memory for buckets.
Hist(int buckets = 0, cnt_t warmup = 0);
// Reset all counters and values back to zero.
void reset();
// Count a value within its corresponding bucket.
void put(double value);
// Calculate the variance of all counted values.
double getVar() const;
// Calculate the mean average of all counted values.
double getMean() const;
// Calculate the standard derivation of all counted values.
double getStddev() const;
// Print all statistical properties of distribution including a graphical plot of the histogram.
void print(Logger logger, bool details, std::string prefix = "") const;
// Print ASCII style plot of histogram.
void plot(Logger logger) const;
// Dump histogram data in Matlab format.
//
// @return The string containing the dump. The caller is responsible to free() the buffer.
char *dump() const;
// Prints Matlab struct containing all infos to file.
int dumpMatlab(FILE *f) const;
// Write the histogram in JSON format to file \p f.
int dumpJson(FILE *f) const;
// Build a libjansson / JSON object of the histogram.
json_t *toJson() const;
double getHigh() const { return high; }
double getLow() const { return low; }
double getHighest() const { return highest; }
double getLowest() const { return lowest; }
double getLast() const { return last; }
cnt_t getTotal() const { return total; }
protected:
double resolution; // The distance between two adjacent buckets.
double high; // The value of the highest bucket.
double low; // The value of the lowest bucket.
double highest; // The highest value observed (may be higher than #high).
double lowest; // The lowest value observed (may be lower than #low).
double last; // The last value which has been put into the buckets.
cnt_t total; // Total number of counted values.
cnt_t warmup; // Number of values which are used during warmup phase.
cnt_t higher; // The number of values which are higher than #high.
cnt_t lower; // The number of values which are lower than #low.
std::vector<cnt_t> data; // Bucket counters.
double _m[2], _s[2]; // Private variables for online variance calculation.
};
} // namespace villas

130
common/include/villas/kernel/devices/pci_device.hpp Normal file
View file

@ -0,0 +1,130 @@
/* Linux PCI helpers.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <fstream>
#include <list>
#include <cstddef>
#include <cstdint>
#include <villas/log.hpp>
namespace villas {
namespace kernel {
namespace devices {
#define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f)
#define PCI_FUNC(devfn) ((devfn) & 0x07)
class Id {
public:
Id(const std::string &str);
Id(int vid = 0, int did = 0, int cc = 0)
: vendor(vid), device(did), class_code(cc) {}
bool operator==(const Id &i);
unsigned int vendor;
unsigned int device;
unsigned int class_code;
};
class Slot {
public:
Slot(const std::string &str);
Slot(int dom = 0, int b = 0, int dev = 0, int fcn = 0)
: domain(dom), bus(b), device(dev), function(fcn) {}
bool operator==(const Slot &s);
unsigned int domain;
unsigned int bus;
unsigned int device;
unsigned int function;
};
struct Region {
int num;
uintptr_t start;
uintptr_t end;
unsigned long long flags;
};
class PciDevice {
public:
PciDevice(Id i, Slot s) : id(i), slot(s), log(Log::get("kernel:pci")) {}
PciDevice(Id i) : id(i), log(Log::get("kernel:pci")) {}
PciDevice(Slot s) : slot(s), log(Log::get("kernel:pci")) {}
bool operator==(const PciDevice &other);
// Get currently loaded driver for device
std::string getDriver() const;
// Bind a new LKM to the PCI device
bool attachDriver(const std::string &driver) const;
// Return the IOMMU group of this PCI device or -1 if the device is not in a group
int getIommuGroup() const;
std::list<Region> getRegions() const;
// Write 32-bit BAR value from to the PCI configuration space
void writeBar(uint32_t addr, unsigned bar = 0);
// If BAR values in config space and in the kernel do not match, rewrite
// the BAR value of the kernel to PCIe config space
void rewriteBar(unsigned bar = 0);
// Read 32-bit BAR value from the PCI configuration space
uint32_t readBar(unsigned bar = 0) const;
// Read 32-bit BAR value from the devices resource file.
// This is what the kernel thinks the BAR should be.
uint32_t readHostBar(unsigned bar = 0) const;
Id id;
Slot slot;
private:
villas::Logger log;
protected:
std::fstream
openSysFs(const std::string &subPath,
std::ios_base::openmode mode = std::ios_base::in |
std::ios_base::out) const;
};
class PciDeviceList : public std::list<std::shared_ptr<PciDevice>> {
private:
// Initialize Linux PCI handle.
//
// This search for all available PCI devices under /sys/bus/pci
PciDeviceList();
PciDeviceList &operator=(const PciDeviceList &);
static PciDeviceList *instance;
public:
static PciDeviceList *getInstance();
PciDeviceList::value_type lookupDevice(const Slot &s);
PciDeviceList::value_type lookupDevice(const Id &i);
PciDeviceList::value_type lookupDevice(const PciDevice &f);
};
} // namespace devices
} // namespace kernel
} // namespace villas

67
common/include/villas/kernel/kernel.hpp Normal file
View file

@ -0,0 +1,67 @@
/* Linux kernel related functions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstddef>
#include <cstdint>
#include <villas/version.hpp>
namespace villas {
namespace kernel {
// Get the version of the kernel
utils::Version getVersion();
// Get number of reserved hugepages
int getNrHugepages();
// Set number of reserved hugepages
int setNrHugepages(int nr);
// Get kernel cmdline parameter
//
// See https://www.kernel.org/doc/Documentation/kernel-parameters.txt
//
// @param param The cmdline parameter to look for
// @param buf The string buffer to which the parameter value will be copied to
// @param len The length of the buffer \p value
// @retval 0 Parameter \p key was found and value was copied to \p value
// @reval <>0 Kernel was not booted with parameter \p key
int getCmdlineParam(const char *param, char *buf, size_t len);
// Checks if a kernel module is loaded
//
// @param module the name of the module
// @retval 0 Module is loaded
// @reval <>0 Module is not loaded
int isModuleLoaded(const char *module);
// Load kernel module via modprobe
int loadModule(const char *module);
// Set parameter of loaded kernel module
int setModuleParam(const char *module, const char *param, const char *value);
// Get cacheline size in bytes
int getCachelineSize();
// Get the size of a standard page in bytes
int getPageSize();
// Get the size of a huge page in bytes
int getHugePageSize();
// Get CPU base frequency
int get_cpu_frequency(uint64_t *freq);
// Set SMP affinity of IRQ
int setIRQAffinity(unsigned irq, uintmax_t aff, uintmax_t *old);
} // namespace kernel
} // namespace villas

34
common/include/villas/kernel/rt.hpp Normal file
View file

@ -0,0 +1,34 @@
/* Linux specific real-time optimizations.
*
* @see: https://wiki.linuxfoundation.org/realtime/documentation/howto/applications/application_base
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <pthread.h>
namespace villas {
namespace kernel {
namespace rt {
void init(int priority, int affinity);
void setProcessAffinity(int affinity);
void setThreadAffinity(pthread_t thread, int affinity);
void setPriority(int priority);
// Checks for realtime (PREEMPT_RT) patched kernel.
//
// See https://rt.wiki.kernel.org
//
// @retval true Kernel is patched.
// @retval false Kernel is not patched.
bool isPreemptible();
} // namespace rt
} // namespace kernel
} // namespace villas

83
common/include/villas/kernel/vfio_container.hpp Normal file
View file

@ -0,0 +1,83 @@
/* Virtual Function IO wrapper around kernel API.
*
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2023 Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2018 Daniel Krebs <github@daniel-krebs.net>
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <list>
#include <memory>
#include <vector>
#include <linux/vfio.h>
#include <sys/mman.h>
#include <villas/kernel/vfio_group.hpp>
namespace villas {
namespace kernel {
namespace vfio {
// Backwards compatability with older kernels
#ifdef VFIO_UPDATE_VADDR
static constexpr size_t EXTENSION_SIZE = VFIO_UPDATE_VADDR + 1;
#elif defined(VFIO_UNMAP_ALL)
static constexpr size_t EXTENSION_SIZE = VFIO_UNMAP_ALL + 1;
#else
static constexpr size_t EXTENSION_SIZE = VFIO_NOIOMMU_IOMMU + 1;
#endif
class Container {
public:
Container(std::vector<std::string> required_modules = {"vfio"});
// No copying allowed because we manage the vfio state in constructor and destructors
Container(Container const &) = delete;
void operator=(Container const &) = delete;
~Container();
void dump();
void attachGroup(std::shared_ptr<Group> group);
std::shared_ptr<Group> getOrAttachGroup(int index);
std::shared_ptr<Device> attachDevice(const std::string &name, int groupIndex);
std::shared_ptr<Device> attachDevice(devices::PciDevice &pdev);
// Map VM to an IOVA, which is accessible by devices in the container
//
// @param virt virtual address of memory
// @param phys IOVA where to map @p virt, -1 to use VFIO internal allocator
// @param length size of memory region in bytes
// @return IOVA address, UINTPTR_MAX on failure
uintptr_t memoryMap(uintptr_t virt, uintptr_t phys, size_t length);
// munmap() a region which has been mapped by vfio_map_region()
bool memoryUnmap(uintptr_t phys, size_t length);
bool isIommuEnabled() const { return this->hasIommu; }
private:
int fd;
int version;
std::array<bool, EXTENSION_SIZE> extensions;
uint64_t iova_next; // Next free IOVA address
bool hasIommu;
// All groups bound to this container
std::list<std::shared_ptr<Group>> groups;
Logger log;
};
} // namespace vfio
} // namespace kernel
} // namespace villas

101
common/include/villas/kernel/vfio_device.hpp Normal file
View file

@ -0,0 +1,101 @@
/* Virtual Function IO wrapper around kernel API.
*
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2023 Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2018 Daniel Krebs <github@daniel-krebs.net>
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <list>
#include <memory>
#include <string>
#include <vector>
#include <linux/vfio.h>
#include <sys/mman.h>
#include <villas/kernel/devices/pci_device.hpp>
#include <villas/log.hpp>
namespace villas {
namespace kernel {
namespace vfio {
class Device {
public:
Device(const std::string &name, int groupFileDescriptor,
const kernel::devices::PciDevice *pci_device = nullptr);
~Device();
// No copying allowed because we manage the vfio state in constructor and destructors
Device(Device const &) = delete;
void operator=(Device const &) = delete;
bool reset();
std::string getName() { return name; };
// Map a device memory region to the application address space (e.g. PCI BARs)
void *regionMap(size_t index);
// munmap() a region which has been mapped by vfio_map_region()
bool regionUnmap(size_t index);
// Get the size of a device memory region
size_t regionGetSize(size_t index);
// Enable memory accesses and bus mastering for PCI device
bool pciEnable();
int pciMsiInit(int efds[32]);
int pciMsiDeinit(int efds[32]);
bool pciMsiFind(int nos[32]);
bool isVfioPciDevice() const;
bool pciHotReset();
int getFileDescriptor() const { return fd; }
std::vector<int> &getEventfdList() { return eventfdList; }
void dump();
bool isAttachedToGroup() const { return attachedToGroup; }
void setAttachedToGroup() { this->attachedToGroup = true; }
int getNumberIrqs() const { return this->info.num_irqs; }
private:
// Name of the device as listed under
// /sys/kernel/iommu_groups/[vfio_group::index]/devices/
std::string name;
// VFIO device file descriptor
int fd;
bool attachedToGroup;
int groupFd;
// Interrupt eventfds
std::vector<int> eventfdList;
struct vfio_device_info info;
std::vector<struct vfio_irq_info> irqs;
std::vector<struct vfio_region_info> regions;
std::vector<void *> mappings;
// libpci handle of the device
const kernel::devices::PciDevice *pci_device;
Logger log;
};
} // namespace vfio
} // namespace kernel
} // namespace villas

76
common/include/villas/kernel/vfio_group.hpp Normal file
View file

@ -0,0 +1,76 @@
/* Virtual Function IO wrapper around kernel API.
*
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2023 Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2018 Daniel Krebs <github@daniel-krebs.net>
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <list>
#include <memory>
#include <vector>
#include <linux/vfio.h>
#include <sys/mman.h>
#include <villas/kernel/vfio_device.hpp>
#include <villas/log.hpp>
namespace villas {
namespace kernel {
namespace vfio {
#define VFIO_PATH "/dev/vfio/"
#define VFIO_DEV VFIO_PATH "vfio"
class Group {
public:
Group(int index, bool iommuEnabled);
~Group();
// No copying allowed because we manage the vfio state in constructor and destructors
Group(Group const &) = delete;
void operator=(Group const &) = delete;
void setAttachedToContainer() { attachedToContainer = true; }
bool isAttachedToContainer() { return attachedToContainer; }
int getFileDescriptor() { return fd; }
int getIndex() { return index; }
std::shared_ptr<Device> attachDevice(std::shared_ptr<Device> device);
std::shared_ptr<Device>
attachDevice(const std::string &name,
const kernel::devices::PciDevice *pci_device = nullptr);
bool checkStatus();
void dump();
private:
// VFIO group file descriptor
int fd;
// Index of the IOMMU group as listed under /sys/kernel/iommu_groups/
int index;
bool attachedToContainer;
// Status of group
struct vfio_group_status status;
// All devices owned by this group
std::list<std::shared_ptr<Device>> devices;
Logger log;
};
} // namespace vfio
} // namespace kernel
} // namespace villas

133
common/include/villas/list.hpp Normal file
View file

@ -0,0 +1,133 @@
/* A generic list implementation.
*
* This is a generic implementation of a list which can store void pointers to
* arbitrary data. The data itself is not stored or managed by the list.
*
* Internally, an array of pointers is used to store the pointers.
* If needed, this array will grow by realloc().
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstring>
#include <pthread.h>
#include <string>
#include <sys/types.h>
#include <villas/common.hpp>
#define LIST_CHUNKSIZE 16
// Static list initialization
#define LIST_INIT_STATIC(l) \
__attribute__((constructor(105))) static void UNIQUE(__ctor)() { \
int ret __attribute__((unused)); \
ret = list_init(l); \
} \
__attribute__((destructor(105))) static void UNIQUE(__dtor)() { \
int ret __attribute__((unused)); \
ret = list_destroy(l, nullptr, false); \
}
#define list_length(list) ((list)->length)
#define list_at_safe(list, index) \
((list)->length > index ? (list)->array[index] : nullptr)
#define list_at(list, index) ((list)->array[index])
#define list_first(list) list_at(list, 0)
#define list_last(list) list_at(list, (list)->length - 1)
namespace villas {
// Callback to search or sort a list.
typedef int (*cmp_cb_t)(const void *, const void *);
// The list data structure.
struct List {
enum State state; // The state of this list.
void **array; // Array of pointers to list elements.
size_t capacity; // Size of list::array in elements.
size_t length; // Number of elements of list::array which are in use.
pthread_mutex_t lock; // A mutex to allow thread-safe accesses.
};
// Initialize a list.
//
// @param l A pointer to the list data structure.
int list_init(struct List *l) __attribute__((warn_unused_result));
// Destroy a list and call destructors for all list elements
//
// @param free free() all list members during when calling list_destroy()
// @param dtor A function pointer to a desctructor which will be called for every list item when the list is destroyed.
// @param l A pointer to the list data structure.
int list_destroy(struct List *l, dtor_cb_t dtor = nullptr, bool free = false)
__attribute__((warn_unused_result));
// Append an element to the end of the list.
void list_push(struct List *l, void *p);
// Clear list.
void list_clear(struct List *l);
// Remove all occurences of a list item.
void list_remove_all(struct List *l, void *p);
int list_remove(struct List *l, size_t idx);
int list_insert(struct List *l, size_t idx, void *p);
// Return the first element of the list for which cmp returns zero.
void *list_search(struct List *l, cmp_cb_t cmp, const void *ctx);
// Returns the number of occurences for which cmp returns zero when called on all list elements.
int list_count(struct List *l, cmp_cb_t cmp, void *ctx);
// Return 0 if list contains pointer p.
int list_contains(struct List *l, void *p);
// Sort the list using the quicksort algorithm of libc.
void list_sort(struct List *l, cmp_cb_t cmp);
// Set single element in list.
int list_set(struct List *l, unsigned index, void *value);
// Return index in list for value.
//
// @retval <0 No list entry matching \p value was found.
// @retval >=0 Entry \p value was found at returned index.
ssize_t list_index(struct List *l, void *value);
// Extend the list to the given length by filling new slots with given value.
void list_extend(struct List *l, size_t len, void *val);
// Remove all elements for which the callback returns a non-zero return code.
void list_filter(struct List *l, dtor_cb_t cb);
// Lookup an element from the list based on a name.
template <typename T>
T *list_lookup_name(struct List *l, const std::string &name) {
return (T *)list_search(
l,
[](const void *a, const void *b) -> int {
auto *e = reinterpret_cast<const T *>(a);
auto *s = reinterpret_cast<const std::string *>(b);
return *s == e->name ? 0 : 1;
},
&name);
}
// Lookup index of list element based on name.
template <typename T>
ssize_t list_lookup_index(struct List *l, const std::string &name) {
auto *f = list_lookup_name<T>(l, name);
return f ? list_index(l, f) : -1;
}
} // namespace villas

98
common/include/villas/log.hpp Normal file
View file

@ -0,0 +1,98 @@
/* Logging.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <list>
#include <string>
#include <spdlog/sinks/dist_sink.h>
#include <spdlog/sinks/stdout_color_sinks.h>
#include <spdlog/spdlog.h>
#include <jansson.h>
namespace villas {
// Forward declarations
using Logger = std::shared_ptr<spdlog::logger>;
class Log {
public:
using Level = spdlog::level::level_enum;
using DefaultSink = std::shared_ptr<spdlog::sinks::stderr_color_sink_mt>;
using DistSink = std::shared_ptr<spdlog::sinks::dist_sink_mt>;
using Formatter = std::shared_ptr<spdlog::pattern_formatter>;
class Expression {
public:
std::string name;
Level level;
Expression(const std::string &n, Level lvl) : name(n), level(lvl) {}
Expression(json_t *json);
};
protected:
DistSink sinks;
DefaultSink sink;
Formatter formatter;
Level level;
std::string pattern; // Logging format.
std::string prefix; // Prefix each line with this string.
std::list<Expression> expressions;
public:
Log(Level level = Level::info);
// Get the real usable log output width which fits into one line.
int getWidth();
void parse(json_t *json);
static Log &getInstance() {
// This will "leak" memory. Because we don't have a complex destructor it's okay
// that this will be cleaned up implicitly on program exit.
static auto log = new Log();
return *log;
};
Logger getNewLogger(const std::string &name);
static Logger get(const std::string &name) {
static auto &log = getInstance();
return log.getNewLogger(name);
}
void setFormatter(const std::string &pattern, const std::string &pfx = "");
void setLevel(Level lvl);
void setLevel(const std::string &lvl);
Level getLevel() const;
std::string getLevelName() const;
void addSink(std::shared_ptr<spdlog::sinks::sink> sink) {
sink->set_formatter(formatter->clone());
sink->set_level(level);
sinks->add_sink(sink);
}
void replaceStdSink(std::shared_ptr<spdlog::sinks::sink> sink) {
sink->set_formatter(formatter->clone());
sink->set_level(level);
sinks->sinks()[0] = sink;
}
};
} // namespace villas

288
common/include/villas/memory.hpp Normal file
View file

@ -0,0 +1,288 @@
/* Memory management.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <string>
#include <unistd.h>
#include <villas/log.hpp>
#include <villas/memory_manager.hpp>
namespace villas {
// Basic memory block backed by an address space in the memory graph
//
// This is a generic representation of a chunk of memory in the system. It can
// reside anywhere and represent different types of memory.
class MemoryBlock {
public:
using deallocator_fn = std::function<void(MemoryBlock *)>;
using Ptr = std::shared_ptr<MemoryBlock>;
using UniquePtr = std::unique_ptr<MemoryBlock, deallocator_fn>;
// cppcheck-suppress passedByValue
MemoryBlock(size_t offset, size_t size,
const MemoryManager::AddressSpaceId &addrSpaceId)
: offset(offset), size(size), addrSpaceId(addrSpaceId) {}
MemoryManager::AddressSpaceId getAddrSpaceId() const { return addrSpaceId; }
size_t getSize() const { return size; }
size_t getOffset() const { return offset; }
protected:
size_t offset; // Offset (or address) inside address space
size_t size; // Size in bytes of this block
MemoryManager::AddressSpaceId addrSpaceId; // Identifier in memory graph
};
// Wrapper for a MemoryBlock to access the underlying memory directly
//
// The underlying memory block has to be accessible for the current process,
// that means it has to be mapped accordingly and registered to the global
// memory graph.
// Furthermore, this wrapper can be owning the memory block when initialized
// with a moved unique pointer. Otherwise, it just stores a reference to the
// memory block and it's the users responsibility to take care that the memory
// block is valid.
template <typename T> class MemoryAccessor {
public:
using Type = T;
// Take ownership of the MemoryBlock
MemoryAccessor(std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> mem)
: translation(MemoryManager::get().getTranslationFromProcess(
mem->getAddrSpaceId())),
memoryBlock(std::move(mem)) {}
// Just act as an accessor, do not take ownership of MemoryBlock
MemoryAccessor(const MemoryBlock &mem)
: translation(MemoryManager::get().getTranslationFromProcess(
mem.getAddrSpaceId())) {}
MemoryAccessor(const MemoryTranslation &translation)
: translation(translation) {}
T &operator*() const {
return *reinterpret_cast<T *>(translation.getLocalAddr(0));
}
T &operator[](size_t idx) const {
const size_t offset = sizeof(T) * idx;
return *reinterpret_cast<T *>(translation.getLocalAddr(offset));
}
T *operator&() const {
return reinterpret_cast<T *>(translation.getLocalAddr(0));
}
T *operator->() const {
return reinterpret_cast<T *>(translation.getLocalAddr(0));
}
const MemoryBlock &getMemoryBlock() const {
if (not memoryBlock)
throw std::bad_alloc();
else
return *memoryBlock;
}
private:
// Cached memory translation for fast access
MemoryTranslation translation;
// Take the unique pointer in case user wants this class to have ownership
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> memoryBlock;
};
// Base memory allocator
//
// Note the usage of CRTP idiom here to access methods of derived allocators.
// The concept is explained here at [1].
//
// [1] https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern
template <typename DerivedAllocator> class BaseAllocator {
public:
// memoryAddrSpaceId: memory that is managed by this allocator
BaseAllocator(MemoryManager::AddressSpaceId memoryAddrSpaceId)
: memoryAddrSpaceId(memoryAddrSpaceId) {
// CRTP
derivedAlloc = static_cast<DerivedAllocator *>(this);
std::string loggerName = fmt::format("memory:", derivedAlloc->getName());
logger = Log::get(loggerName);
// Default deallocation callback
free = [&](MemoryBlock *mem) {
logger->warn("no free callback defined for addr space {}, not freeing",
mem->getAddrSpaceId());
removeMemoryBlock(*mem);
};
}
BaseAllocator(std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> mem)
: BaseAllocator(mem->getAddrSpaceId()) {
// cppcheck-suppress useInitializationList
memoryBlock = std::move(mem);
derivedAlloc = nullptr;
}
virtual std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
allocateBlock(size_t size) = 0;
template <typename T> MemoryAccessor<T> allocate(size_t num) {
if (num == 0) {
// Doesn't make sense to allocate an empty block
logger->error("Trying to allocate empty memory");
throw std::bad_alloc();
}
const size_t size = num * sizeof(T);
auto mem = allocateBlock(size);
// Check if the allocated memory is really accessible by writing to the
// allocated memory and reading back. Exponentially increase offset to
// speed up testing.
MemoryAccessor<volatile uint8_t> byteAccessor(*mem);
size_t idx = 0;
for (int i = 0; idx < mem->getSize(); i++, idx = (1 << i)) {
auto val = static_cast<uint8_t>(i);
byteAccessor[idx] = val;
if (byteAccessor[idx] != val) {
logger->error("Cannot access allocated memory");
throw std::bad_alloc();
}
}
return MemoryAccessor<T>(std::move(mem));
}
protected:
void insertMemoryBlock(const MemoryBlock &mem) {
auto &mm = MemoryManager::get();
mm.createMapping(mem.getOffset(), 0, mem.getSize(), derivedAlloc->getName(),
memoryAddrSpaceId, mem.getAddrSpaceId());
}
void removeMemoryBlock(const MemoryBlock &mem) {
// This will also remove any mapping to and from the memory block
auto &mm = MemoryManager::get();
mm.removeAddressSpace(mem.getAddrSpaceId());
}
MemoryManager::AddressSpaceId getAddrSpaceId() const {
return memoryAddrSpaceId;
}
MemoryBlock::deallocator_fn free;
Logger logger;
// Optional, if allocator should own the memory block
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> memoryBlock;
private:
MemoryManager::AddressSpaceId memoryAddrSpaceId;
DerivedAllocator *derivedAlloc;
};
// Linear memory allocator
//
// This is the simplest kind of allocator. The idea is to keep a pointer at the
// first memory address of your memory chunk and move it every time an
// allocation is done. Due to its simplicity, this allocator doesn't allow
// specific positions of memory to be freed. Usually, all memory is freed
// together.
class LinearAllocator : public BaseAllocator<LinearAllocator> {
public:
LinearAllocator(const MemoryManager::AddressSpaceId &memoryAddrSpaceId,
size_t memorySize, size_t internalOffset = 0);
LinearAllocator(std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> mem)
: LinearAllocator(mem->getAddrSpaceId(), mem->getSize()) {
memoryBlock = std::move(mem);
}
size_t getAvailableMemory() const { return memorySize - nextFreeAddress; }
size_t getSize() const { return memorySize; }
std::string getName() const;
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
allocateBlock(size_t size);
private:
static constexpr size_t alignBytes = sizeof(uintptr_t);
static constexpr size_t alignMask = alignBytes - 1;
size_t getAlignmentPadding(uintptr_t addr) const {
return (alignBytes - (addr & alignMask)) & alignMask;
}
size_t nextFreeAddress; // Next chunk will be allocated here
size_t memorySize; // Total size of managed memory
size_t internalOffset; // Offset in address space (usually 0)
size_t allocationCount; // Number of individual allocations present
};
// Wrapper around mmap() to create villas memory blocks
//
// This class simply wraps around mmap() and munmap() to allocate memory in the
// host memory via the OS.
class HostRam {
public:
class HostRamAllocator : public BaseAllocator<HostRamAllocator> {
public:
HostRamAllocator();
std::string getName() const { return "HostRamAlloc"; }
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
allocateBlock(size_t size);
};
static HostRamAllocator &getAllocator() {
// This will "leak" memory. Because we don't have a complex destructor it's okay
// that this will be cleaned up implicitly on program exit.
static auto allocator = new HostRamAllocator();
return *allocator;
}
};
class HostDmaRam {
public:
class HostDmaRamAllocator : public LinearAllocator {
public:
HostDmaRamAllocator(int num);
virtual ~HostDmaRamAllocator();
std::string getName() const { return getUdmaBufName(num); }
private:
int num;
};
static HostDmaRamAllocator &getAllocator(int num = 0);
private:
static std::map<int, std::unique_ptr<HostDmaRamAllocator>> allocators;
static std::string getUdmaBufName(int num);
static std::string getUdmaBufBasePath(int num);
static size_t getUdmaBufBufSize(int num);
static uintptr_t getUdmaBufPhysAddr(int num);
};
} // namespace villas

238
common/include/villas/memory_manager.hpp Normal file
View file

@ -0,0 +1,238 @@
/* Memory manager.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstdint>
#include <fmt/ostream.h>
#include <map>
#include <stdexcept>
#include <string>
#include <unistd.h>
#include <villas/config.hpp>
#include <villas/graph/directed.hpp>
#include <villas/log.hpp>
namespace villas {
// Translation between a local (master) to a foreign (slave) address space
//
// Memory translations can be chained together using the `+=` operator which is
// used internally by the MemoryManager to compute a translation through
// multiple hops (memory mappings).
class MemoryTranslation {
public:
// MemoryTranslation
// @param src Base address of local address space
// @param dst Base address of foreign address space
// @param size Size of "memory window"
MemoryTranslation(uintptr_t src, uintptr_t dst, size_t size)
: src(src), dst(dst), size(size) {}
uintptr_t getLocalAddr(uintptr_t addrInForeignAddrSpace) const;
uintptr_t getForeignAddr(uintptr_t addrInLocalAddrSpace) const;
size_t getSize() const { return size; }
friend std::ostream &operator<<(std::ostream &stream,
const MemoryTranslation &translation) {
return stream << std::hex << "(src=0x" << translation.src << ", dst=0x"
<< translation.dst << ", size=0x" << translation.size << ")";
}
// Merge two MemoryTranslations together
MemoryTranslation &operator+=(const MemoryTranslation &other);
private:
uintptr_t src; // Base address of local address space
uintptr_t dst; // Base address of foreign address space
size_t size; // Size of "memory window"
};
// Global memory manager to resolve addresses across address spaces
//
// Every entity in the system has to register its (master) address space and
// create mappings to other (slave) address spaces that it can access. A
// directed graph is then constructed which allows to traverse addresses spaces
// through multiple mappings and resolve addresses through this "tunnel" of
// memory mappings.
class MemoryManager {
private:
// This is a singleton, so private constructor ...
MemoryManager()
: memoryGraph("memory:graph"), logger(Log::get("memory:manager")) {
pathCheckFunc = [&](const MemoryGraph::Path &path) {
return this->pathCheck(path);
};
}
// ... and no copying or assigning
MemoryManager(const MemoryManager &) = delete;
MemoryManager &operator=(const MemoryManager &) = delete;
// Custom edge in memory graph representing a memory mapping
//
// A memory mapping maps from one address space into another and can only be
// traversed in the forward direction which reflects the nature of real
// memory mappings.
//
// Implementation Notes:
// The member #src is the address in the "from" address space, where the
// destination address space is mapped. The member #dest is the address in
// the destination address space, where the mapping points to. Often, #dest
// will be zero for mappings to hardware, but consider the example when
// mapping FPGA to application memory:
// The application allocates a block 1kB at address 0x843001000 in its
// address space. The mapping would then have a #dest address of 0x843001000
// and a #size of 1024.
class Mapping : public graph::Edge {
public:
std::string name; // Human-readable name
uintptr_t src; // Base address in "from" address space
uintptr_t dest; // Base address in "to" address space
size_t size; // Size of the mapping
friend std::ostream &operator<<(std::ostream &stream,
const Mapping &mapping) {
return stream << static_cast<const Edge &>(mapping) << " = "
<< mapping.name << std::hex << " (src=0x" << mapping.src
<< ", dest=0x" << mapping.dest << ", size=0x"
<< mapping.size << ")";
}
std::string toString() {
std::stringstream s;
s << *this;
return s.str();
}
};
// Custom vertex in memory graph representing an address space
//
// Since most information in the memory graph is stored in the edges (memory
// mappings), this is just a small extension to the default vertex. It only
// associates an additional string #name for human-readability.
class AddressSpace : public graph::Vertex {
public:
std::string name; // Human-readable name
friend std::ostream &operator<<(std::ostream &stream,
const AddressSpace &addrSpace) {
return stream << static_cast<const Vertex &>(addrSpace) << " = "
<< addrSpace.name;
}
};
// Memory graph with custom edges and vertices for address resolution
using MemoryGraph = graph::DirectedGraph<AddressSpace, Mapping>;
public:
using AddressSpaceId = MemoryGraph::VertexIdentifier;
using MappingId = MemoryGraph::EdgeIdentifier;
struct InvalidTranslation : public std::exception {};
// Get singleton instance
static MemoryManager &get();
MemoryGraph &getGraph() { return memoryGraph; }
void printGraph();
AddressSpaceId getProcessAddressSpace() {
return getOrCreateAddressSpace("process");
}
AddressSpaceId getPciAddressSpace() {
return getOrCreateAddressSpace("pcie");
}
AddressSpaceId
getProcessAddressSpaceMemoryBlock(const std::string &memoryBlock) {
return getOrCreateAddressSpace(
getSlaveAddrSpaceName("process", memoryBlock));
}
AddressSpaceId getOrCreateAddressSpace(std::string name);
void removeAddressSpace(const AddressSpaceId &addrSpaceId) {
memoryGraph.removeVertex(addrSpaceId);
}
// Create a default mapping
MappingId createMapping(uintptr_t src, uintptr_t dest, size_t size,
const std::string &name, AddressSpaceId fromAddrSpace,
AddressSpaceId toAddrSpace);
// Add a mapping
//
// Can be used to derive from Mapping in order to implement custom
// constructor/destructor.
MappingId addMapping(std::shared_ptr<Mapping> mapping,
AddressSpaceId fromAddrSpace,
AddressSpaceId toAddrSpace);
AddressSpaceId findAddressSpace(const std::string &name);
std::list<AddressSpaceId> findPath(const AddressSpaceId &fromAddrSpaceId,
const AddressSpaceId &toAddrSpaceId);
MemoryTranslation getTranslation(const AddressSpaceId &fromAddrSpaceId,
const AddressSpaceId &toAddrSpaceId);
// cppcheck-suppress passedByValue
MemoryTranslation
getTranslationFromProcess(const AddressSpaceId &foreignAddrSpaceId) {
return getTranslation(getProcessAddressSpace(), foreignAddrSpaceId);
}
static std::string getSlaveAddrSpaceName(const std::string &ipInstance,
const std::string &memoryBlock) {
return ipInstance + "/" + memoryBlock;
}
static std::string getMasterAddrSpaceName(const std::string &ipInstance,
const std::string &busInterface) {
return ipInstance + ":" + busInterface;
}
private:
// Convert a Mapping to MemoryTranslation for calculations
static MemoryTranslation getTranslationFromMapping(const Mapping &mapping) {
return MemoryTranslation(mapping.src, mapping.dest, mapping.size);
}
bool pathCheck(const MemoryGraph::Path &path);
// Directed graph that stores address spaces and memory mappings
MemoryGraph memoryGraph;
// Cache mapping of names to address space ids for fast lookup
std::map<std::string, AddressSpaceId> addrSpaceLookup;
// Logger for universal access in this class
Logger logger;
MemoryGraph::check_path_fn pathCheckFunc;
// Static pointer to global instance, because this is a singleton
static MemoryManager *instance;
};
} // namespace villas
#ifndef FMT_LEGACY_OSTREAM_FORMATTER
template <>
class fmt::formatter<villas::MemoryTranslation>
: public fmt::ostream_formatter {};
template <>
class fmt::formatter<villas::MemoryManager::Mapping>
: public fmt::ostream_formatter {};
template <>
class fmt::formatter<villas::MemoryManager::AddressSpaceId>
: public fmt::ostream_formatter {};
#endif

156
common/include/villas/plugin.hpp Normal file
View file

@ -0,0 +1,156 @@
/* Loadable / plugin support.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <fmt/ostream.h>
#include <iostream>
#include <jansson.h>
#include <list>
#include <string>
#include <villas/common.hpp>
#include <villas/config.hpp>
#include <villas/log.hpp>
namespace villas {
namespace plugin {
// Forward declarations
class Plugin;
class Registry;
extern Registry *registry;
template <typename T = Plugin> using List = std::list<T *>;
class SubRegistry {
public:
virtual List<> lookup() = 0;
};
class Registry {
protected:
List<> plugins;
List<SubRegistry> registries;
public:
Logger getLogger() { return Log::get("plugin:registry"); }
void add(Plugin *p) { plugins.push_back(p); }
void addSubRegistry(SubRegistry *sr) { registries.push_back(sr); }
void remove(Plugin *p) { plugins.remove(p); }
// Get all plugins including sub-registries
List<> lookup() {
List<> all;
all.insert(all.end(), plugins.begin(), plugins.end());
for (auto r : registries) {
auto p = r->lookup();
all.insert(all.end(), p.begin(), p.end());
}
return all;
}
// Get all plugins of specific type
template <typename T = Plugin> List<T> lookup() {
List<T> list;
for (Plugin *p : lookup()) {
T *t = dynamic_cast<T *>(p);
if (t)
list.push_back(t);
}
// Sort alphabetically
list.sort(
[](const T *a, const T *b) { return a->getName() < b->getName(); });
return list;
}
// Get all plugins of specific type and name
template <typename T = Plugin> T *lookup(const std::string &name) {
for (T *p : lookup<T>()) {
if (p->getName() != name)
continue;
return p;
}
return nullptr;
}
template <typename T = Plugin> void dump();
};
class Plugin {
friend plugin::Registry;
protected:
Logger logger;
public:
Plugin();
virtual ~Plugin();
// Copying a plugin doesn't make sense, so explicitly deny it
Plugin(Plugin const &) = delete;
void operator=(Plugin const &) = delete;
virtual void dump();
// Get plugin name
virtual std::string getName() const = 0;
// Get plugin type
virtual std::string getType() const = 0;
// Get plugin description
virtual std::string getDescription() const = 0;
virtual Logger getLogger() {
if (!logger) {
auto name = fmt::format("{}:{}", getType(), getName());
logger = Log::get(name);
}
return logger;
}
friend std::ostream &operator<<(std::ostream &os, const class Plugin &p) {
return os << p.getName();
}
};
template <typename T> void Registry::dump() {
getLogger()->info("Available plugins:");
for (Plugin *p : plugins) {
T *t = dynamic_cast<T *>(p);
if (t)
getLogger()->info(" - {}: {}", p->getName(), p->getDescription());
}
}
} // namespace plugin
} // namespace villas
#ifndef FMT_LEGACY_OSTREAM_FORMATTER
template <>
class fmt::formatter<villas::plugin::Plugin> : public fmt::ostream_formatter {};
#endif

92
common/include/villas/popen.hpp Normal file
View file

@ -0,0 +1,92 @@
/* Bi-directional popen.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <signal.h>
#include <ext/stdio_filebuf.h>
#include <istream>
#include <map>
#include <memory>
#include <ostream>
#include <string>
#include <vector>
namespace villas {
namespace utils {
class Popen {
public:
using arg_list = std::vector<std::string>;
using env_map = std::map<std::string, std::string>;
using char_type = char;
using stdio_buf = __gnu_cxx::stdio_filebuf<char_type>;
Popen(const std::string &cmd, const arg_list &args = arg_list(),
const env_map &env = env_map(), const std::string &wd = std::string(),
bool shell = false);
~Popen();
void open();
int close();
void kill(int signal = SIGINT);
int getFdIn() { return fd_in; }
int getFdOut() { return fd_out; }
pid_t getPid() const { return pid; }
protected:
std::string command;
std::string working_dir;
arg_list arguments;
env_map environment;
bool shell;
pid_t pid;
int fd_in, fd_out;
};
class PopenStream : public Popen {
public:
PopenStream(const std::string &cmd, const arg_list &args = arg_list(),
const env_map &env = env_map(),
const std::string &wd = std::string(), bool shell = false);
~PopenStream();
std::istream &cin() { return *(input.stream); }
std::ostream &cout() { return *(output.stream); }
void open();
int close();
protected:
struct {
std::unique_ptr<std::istream> stream;
std::unique_ptr<stdio_buf> buffer;
} input;
struct {
std::unique_ptr<std::ostream> stream;
std::unique_ptr<stdio_buf> buffer;
} output;
};
} // namespace utils
} // namespace villas
template <typename T>
std::istream &operator>>(villas::utils::PopenStream &po, T &value) {
return *(po.input.stream) >> value;
}

69
common/include/villas/table.hpp Normal file
View file

@ -0,0 +1,69 @@
/* Print fancy tables.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <string>
#include <vector>
#include <villas/log.hpp>
namespace villas {
class Table;
class TableColumn {
friend Table;
public:
enum class Alignment { LEFT, RIGHT };
protected:
int _width; // The real width of this column. Calculated by Table::resize().
int width; // Width of the column.
public:
TableColumn(int w, enum Alignment a, const std::string &t,
const std::string &f, const std::string &u = "")
: _width(0), width(w), title(t), format(f), unit(u), align(a) {}
std::string title; // The title as shown in the table header.
std::string format; // The format which is used to print the table rows.
std::string unit; // An optional unit which will be shown in the table header.
enum Alignment align;
int getWidth() const { return _width; }
};
class Table {
protected:
int resize(int w);
int width;
std::vector<TableColumn> columns;
Logger logger;
public:
Table(Logger log, const std::vector<TableColumn> &cols)
: width(-1), columns(cols), logger(log) {}
// Print a table header consisting of \p n columns.
void header();
// Print table rows.
void row(int count, ...);
int getWidth() const { return width; }
};
} // namespace villas

72
common/include/villas/task.hpp Normal file
View file

@ -0,0 +1,72 @@
/* Run tasks periodically.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstdint>
#include <cstdio>
#include <ctime>
// We can choose between two periodic task implementations
//#define PERIODIC_TASK_IMPL NANOSLEEP
#define TIMERFD 1
#define CLOCK_NANOSLEEP 2
#define NANOSLEEP 3
#define RDTSC 4
#if defined(__MACH__)
#define PERIODIC_TASK_IMPL NANOSLEEP
#elif defined(__linux__)
#define PERIODIC_TASK_IMPL TIMERFD
#else
#error "Platform not supported"
#endif
#if PERIODIC_TASK_IMPL == RDTSC
#include <villas/tsc.hpp>
#endif
struct Task {
int clock; // CLOCK_{MONOTONIC,REALTIME}
#if PERIODIC_TASK_IMPL == RDTSC // We use cycle counts in RDTSC mode
uint64_t period;
uint64_t next;
#else
struct timespec period; // The period of periodic invations of this task
struct timespec next; // The timer value for the next invocation
#endif
#if PERIODIC_TASK_IMPL == TIMERFD
int fd; // The timerfd_create(2) file descriptior.
#elif PERIODIC_TASK_IMPL == RDTSC
struct Tsc tsc; // Initialized by tsc_init().
#endif
// Create a new task with the given rate.
Task(int clock = CLOCK_REALTIME);
~Task();
// Wait until task elapsed
//
// @retval 0 An error occured. Maybe the task was stopped.
// @retval >0 The nummer of runs this task already fired.
uint64_t wait();
void setNext(const struct timespec *next);
void setTimeout(double to);
void setRate(double rate);
void stop();
// Returns a poll'able file descriptor which becomes readable when the timer expires.
//
// Note: currently not supported on all platforms.
int getFD() const;
};

47
common/include/villas/terminal.hpp Normal file
View file

@ -0,0 +1,47 @@
/* Terminal handling.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstdio>
#include <signal.h>
#include <sys/ioctl.h>
namespace villas {
class Terminal {
protected:
struct winsize window; // Size of the terminal window.
bool isTty;
static class Terminal *current;
public:
Terminal();
// Signal handler for TIOCGWINSZ
static void resize(int signal, siginfo_t *sinfo, void *ctx);
static int getCols() {
if (!current)
current = new Terminal();
return current->window.ws_col;
}
static int getRows() {
if (!current)
current = new Terminal();
return current->window.ws_row;
}
};
} // namespace villas

36
common/include/villas/timing.hpp Normal file
View file

@ -0,0 +1,36 @@
/* Time related functions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <cstdint>
#include <cstdio>
#include <ctime>
// Compare two timestamps. Return zero if they are equal.
ssize_t time_cmp(const struct timespec *a, const struct timespec *b);
// Get delta between two timespec structs.
struct timespec time_diff(const struct timespec *start,
const struct timespec *end);
// Get sum of two timespec structs.
struct timespec time_add(const struct timespec *start,
const struct timespec *end);
// Return current time as a struct timespec.
struct timespec time_now();
// Return the diffrence off two timestamps as double value in seconds.
double time_delta(const struct timespec *start, const struct timespec *end);
// Convert timespec to double value representing seconds.
double time_to_double(const struct timespec *ts);
// Convert double containing seconds after 1970 to timespec.
struct timespec time_from_double(double secs);

53
common/include/villas/tool.hpp Normal file
View file

@ -0,0 +1,53 @@
/* Common entry point for all villas command line tools.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <villas/colors.hpp>
#include <villas/config.hpp>
#include <villas/exceptions.hpp>
#include <villas/log.hpp>
#include <villas/utils.hpp>
namespace villas {
class Tool {
protected:
Logger logger;
int argc;
char **argv;
std::string name;
static Tool *current_tool;
static void staticHandler(int signal, siginfo_t *sinfo, void *ctx);
virtual void handler(int, siginfo_t *, void *) {}
std::list<int> handlerSignals;
static void printCopyright();
static void printVersion();
public:
Tool(int ac, char *av[], const std::string &name,
const std::list<int> &sigs = {});
virtual int main() { return 0; }
virtual void usage() {}
virtual void parse() {}
virtual int run();
};
} // namespace villas

41
common/include/villas/tsc.hpp Normal file
View file

@ -0,0 +1,41 @@
/* Measure time and sleep with IA-32 time-stamp counter.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#if !(__x86_64__ || __i386__)
#error this header is for x86 only
#endif
#include <cinttypes>
#include <cpuid.h>
#include <x86intrin.h>
#include <villas/kernel/kernel.hpp>
#ifndef bit_TSC
#define bit_TSC (1 << 4)
#endif
#define bit_TSC_INVARIANT (1 << 8)
#define bit_RDTSCP (1 << 27)
struct Tsc {
uint64_t frequency;
bool rdtscp_supported;
bool is_invariant;
};
__attribute__((unused)) static uint64_t tsc_now(struct Tsc *t) {
uint32_t tsc_aux;
return t->rdtscp_supported ? __rdtscp(&tsc_aux) : __rdtsc();
}
int tsc_init(struct Tsc *t) __attribute__((warn_unused_result));
uint64_t tsc_rate_to_cycles(struct Tsc *t, double rate);

223
common/include/villas/utils.hpp Normal file
View file

@ -0,0 +1,223 @@
/* Utilities.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <list>
#include <string>
#include <vector>
#include <cassert>
#include <cstdint>
#include <cstdlib>
#include <sched.h>
#include <signal.h>
#include <sys/types.h>
#include <openssl/sha.h>
#include <villas/config.hpp>
#ifdef __GNUC__
#define LIKELY(x) __builtin_expect((x), 1)
#define UNLIKELY(x) __builtin_expect((x), 0)
#else
#define LIKELY(x) (x)
#define UNLIKELY(x) (x)
#endif
// Check assertion and exit if failed.
#ifndef assert
#define assert(exp) \
do { \
if (!EXPECT(exp, 0)) \
error("Assertion failed: '%s' in %s(), %s:%d", XSTR(exp), __FUNCTION__, \
__BASE_FILE__, __LINE__); \
} while (0)
#endif
// CPP stringification
#define XSTR(x) STR(x)
#define STR(x) #x
#define CONCAT_DETAIL(x, y) x##y
#define CONCAT(x, y) CONCAT_DETAIL(x, y)
#define UNIQUE(x) CONCAT(x, __COUNTER__)
#ifdef ALIGN
#undef ALIGN
#endif
#define ALIGN(x, a) ALIGN_MASK(x, (uintptr_t)(a) - 1)
#define ALIGN_MASK(x, m) (((uintptr_t)(x) + (m)) & ~(m))
#define IS_ALIGNED(x, a) (ALIGN(x, a) == (uintptr_t)x)
#define SWAP(x, y) \
do { \
auto t = x; \
x = y; \
y = t; \
} while (0)
// Round-up integer division
#define CEIL(x, y) (((x) + (y) - 1) / (y))
// Get nearest up-rounded power of 2
#define LOG2_CEIL(x) (1 << (villas::utils::log2i((x) - 1) + 1))
// Check if the number is a power of 2
#define IS_POW2(x) (((x) != 0) && !((x) & ((x) - 1)))
// Calculate the number of elements in an array.
#define ARRAY_LEN(a) (sizeof(a) / sizeof(a)[0])
// Return the bigger value
#ifdef MAX
#undef MAX
#endif
#define MAX(a, b) \
({ \
__typeof__(a) _a = (a); \
__typeof__(b) _b = (b); \
_a > _b ? _a : _b; \
})
// Return the smaller value
#ifdef MIN
#undef MIN
#endif
#define MIN(a, b) \
({ \
__typeof__(a) _a = (a); \
__typeof__(b) _b = (b); \
_a < _b ? _a : _b; \
})
#define MIN3(a, b, c) MIN(MIN((a), (b)), (c))
#ifndef offsetof
#define offsetof(type, member) __builtin_offsetof(type, member)
#endif
#ifndef container_of
#define container_of(ptr, type, member) \
({ \
const typeof(((type *)0)->member) *__mptr = (ptr); \
(type *)((char *)__mptr - offsetof(type, member)); \
})
#endif
#define BITS_PER_LONGLONG (sizeof(long long) * 8)
// Some helper macros
#define BITMASK(h, l) \
(((~0ULL) << (l)) & (~0ULL >> (BITS_PER_LONGLONG - 1 - (h))))
#define BIT(nr) (1UL << (nr))
namespace villas {
namespace utils {
std::vector<std::string> tokenize(std::string s, const std::string &delimiter);
template <typename T> void assertExcept(bool condition, const T &exception) {
if (not condition)
throw exception;
}
// Register a exit callback for program termination: SIGINT, SIGKILL & SIGALRM.
int signalsInit(void (*cb)(int signal, siginfo_t *sinfo, void *ctx),
std::list<int> cbSignals = {},
std::list<int> ignoreSignals = {SIGCHLD})
__attribute__((warn_unused_result));
// Fill buffer with random data.
ssize_t readRandom(char *buf, size_t len);
// Remove ANSI control sequences for colored output.
char *decolor(char *str);
// Normal random variate generator using the Box-Muller method
//
// @param m Mean
// @param s Standard deviation
// @return Normal variate random variable (Gaussian)
double boxMuller(float m, float s);
// Double precission uniform random variable
double randf();
// Concat formatted string to an existing string.
//
// This function uses realloc() to resize the destination.
// Please make sure to only on dynamic allocated destionations!!!
//
// @param dest A pointer to a malloc() allocated memory region
// @param fmt A format string like for printf()
// @param ... Optional parameters like for printf()
// @retval The the new value of the dest buffer.
char *strcatf(char **dest, const char *fmt, ...)
__attribute__((format(printf, 2, 3)));
// Variadic version of strcatf()
char *vstrcatf(char **dest, const char *fmt, va_list va)
__attribute__((format(printf, 2, 0)));
char *strf(const char *fmt, ...);
char *vstrf(const char *fmt, va_list va);
// Allocate and copy memory.
void *memdup(const void *src, size_t bytes);
// Call quit() in the main thread.
void die();
// Get log2 of long long integers
int log2i(long long x);
// Send signal \p sig to main thread.
void killme(int sig);
pid_t spawn(const char *name, char *const argv[]);
// Determines the string length as printed on the screen (ignores escable sequences).
size_t strlenp(const char *str);
// Calculate SHA1 hash of complete file \p f and place it into \p sha1.
//
// @param sha1[out] Must be SHA_DIGEST_LENGTH (20) in size.
// @retval 0 Everything was okay.
int sha1sum(FILE *f, unsigned char *sha1);
// Check if process is running inside a Docker container.
bool isDocker();
// Check if process is running inside a Kubernetes container.
bool isKubernetes();
// Check if process is running inside a containerized environment.
bool isContainer();
// Check if the process is running in a privileged environment (has SYS_ADMIN capability).
bool isPrivileged();
// helper type for std::visit
template <class... Ts> struct overloaded : Ts... {
using Ts::operator()...;
};
// explicit deduction guide (not needed as of C++20)
template <class... Ts> overloaded(Ts...) -> overloaded<Ts...>;
namespace base64 {
using byte = std::uint8_t;
std::string encode(const std::vector<byte> &input);
std::vector<byte> decode(const std::string &input);
} // namespace base64
} // namespace utils
} // namespace villas

37
common/include/villas/uuid.hpp Normal file
View file

@ -0,0 +1,37 @@
/* UUID helpers.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <string>
#include <jansson.h>
#include <uuid/uuid.h>
typedef char uuid_string_t[37];
namespace villas {
namespace uuid {
// Convert a UUID to C++ string
std::string toString(const uuid_t in);
// Generate an UUID by MD5 hashing the provided string
int generateFromString(uuid_t out, const std::string &data,
const std::string &ns = "");
// Generate an UUID by MD5 hashing the provided string
int generateFromString(uuid_t out, const std::string &data, const uuid_t ns);
// Generate an UUID by MD5 hashing the serialized representation of the provided JSON object
void generateFromJson(uuid_t out, json_t *json, const std::string &ns = "");
// Generate an UUID by MD5 hashing the serialized representation of the provided JSON object
int generateFromJson(uuid_t out, json_t *json, const uuid_t ns);
} // namespace uuid
} // namespace villas

42
common/include/villas/version.hpp Normal file
View file

@ -0,0 +1,42 @@
/* Version.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include <string>
namespace villas {
namespace utils {
class Version {
protected:
int components[3];
static int cmp(const Version &lhs, const Version &rhs);
public:
// Parse a dotted version string.
Version(const std::string &s);
Version(int maj, int min = 0, int pat = 0);
inline bool operator==(const Version &rhs) { return cmp(*this, rhs) == 0; }
inline bool operator!=(const Version &rhs) { return cmp(*this, rhs) != 0; }
inline bool operator<(const Version &rhs) { return cmp(*this, rhs) < 0; }
inline bool operator>(const Version &rhs) { return cmp(*this, rhs) > 0; }
inline bool operator<=(const Version &rhs) { return cmp(*this, rhs) <= 0; }
inline bool operator>=(const Version &rhs) { return cmp(*this, rhs) >= 0; }
};
} // namespace utils
} // namespace villas

105
common/lib/CMakeLists.txt Normal file
View file

@ -0,0 +1,105 @@
## CMakeLists.txt
#
# Author: Daniel Krebs <github@daniel-krebs.net>
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
# SPDX-License-Identifier: Apache-2.0
#
# VILLAScommon
add_library(villas-common SHARED
base64.cpp
buffer.cpp
common.cpp
compat.cpp
cpuset.cpp
dsp/pid.cpp
hist.cpp
kernel/kernel.cpp
kernel/rt.cpp
list.cpp
log.cpp
memory_manager.cpp
memory.cpp
plugin.cpp
popen.cpp
table.cpp
task.cpp
terminal.cpp
timing.cpp
tool.cpp
utils.cpp
uuid.cpp
version.cpp
)
if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
target_sources(villas-common PRIVATE tsc.cpp)
endif()
if(CMAKE_SYSTEM_NAME STREQUAL Linux)
target_sources(villas-common PRIVATE
kernel/devices/pci_device.cpp
kernel/vfio_device.cpp
kernel/vfio_group.cpp
kernel/vfio_container.cpp
)
endif()
target_include_directories(villas-common PUBLIC
${OPENSSL_INCLUDE_DIR}
${CURL_INCLUDE_DIRS}
${PROJECT_BINARY_DIR}/common/include
${PROJECT_SOURCE_DIR}/common/include
)
target_link_libraries(villas-common PUBLIC
PkgConfig::JANSSON
PkgConfig::UUID
${OPENSSL_LIBRARIES}
${CURL_LIBRARIES}
${CMAKE_DL_LIBS}
spdlog::spdlog
fmt::fmt
stdc++
)
if(WITH_CONFIG)
target_link_libraries(villas-common PUBLIC
PkgConfig::LIBCONFIG
)
endif()
target_compile_definitions(villas-common PUBLIC
-D__STDC_FORMAT_MACROS -D_GNU_SOURCE
)
set_target_properties(villas-common PROPERTIES
VERSION ${CMAKE_PROJECT_VERSION}
SOVERSION 1
)
install(
TARGETS villas-common
EXPORT VILLASCommonConfig
COMPONENT lib
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
install(
DIRECTORY ${CMAKE_SOURCE_DIR}/common/include/villas/
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/villas
COMPONENT devel
FILES_MATCHING
PATTERN "*.h"
PATTERN "*.hpp"
)
install(
DIRECTORY ${PROJECT_BINARY_DIR}/common/include/villas/
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/villas
COMPONENT devel
FILES_MATCHING
PATTERN "*.h"
PATTERN "*.hpp"
)

121
common/lib/base64.cpp Normal file
View file

@ -0,0 +1,121 @@
/* Base64 encoding/decoding.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cstdint>
#include <stdexcept>
#include <string>
#include <vector>
#include <villas/utils.hpp>
namespace villas {
namespace utils {
namespace base64 {
static const char kEncodeLookup[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
static const char kPadCharacter = '=';
std::string encode(const std::vector<byte> &input) {
std::string encoded;
encoded.reserve(((input.size() / 3) + (input.size() % 3 > 0)) * 4);
std::uint32_t temp{};
auto it = input.begin();
for (std::size_t i = 0; i < input.size() / 3; ++i) {
temp = (*it++) << 16;
temp += (*it++) << 8;
temp += (*it++);
encoded.append(1, kEncodeLookup[(temp & 0x00FC0000) >> 18]);
encoded.append(1, kEncodeLookup[(temp & 0x0003F000) >> 12]);
encoded.append(1, kEncodeLookup[(temp & 0x00000FC0) >> 6]);
encoded.append(1, kEncodeLookup[(temp & 0x0000003F)]);
}
switch (input.size() % 3) {
case 1:
temp = (*it++) << 16;
encoded.append(1, kEncodeLookup[(temp & 0x00FC0000) >> 18]);
encoded.append(1, kEncodeLookup[(temp & 0x0003F000) >> 12]);
encoded.append(2, kPadCharacter);
break;
case 2:
temp = (*it++) << 16;
temp += (*it++) << 8;
encoded.append(1, kEncodeLookup[(temp & 0x00FC0000) >> 18]);
encoded.append(1, kEncodeLookup[(temp & 0x0003F000) >> 12]);
encoded.append(1, kEncodeLookup[(temp & 0x00000FC0) >> 6]);
encoded.append(1, kPadCharacter);
break;
}
return encoded;
}
std::vector<byte> decode(const std::string &input) {
if (input.length() % 4)
throw std::runtime_error("Invalid base64 length!");
std::size_t padding{};
if (input.length()) {
if (input[input.length() - 1] == kPadCharacter)
padding++;
if (input[input.length() - 2] == kPadCharacter)
padding++;
}
std::vector<byte> decoded;
decoded.reserve(((input.length() / 4) * 3) - padding);
std::uint32_t temp{};
auto it = input.begin();
while (it < input.end()) {
for (std::size_t i = 0; i < 4; ++i) {
temp <<= 6;
if (*it >= 0x41 && *it <= 0x5A)
temp |= *it - 0x41;
else if (*it >= 0x61 && *it <= 0x7A)
temp |= *it - 0x47;
else if (*it >= 0x30 && *it <= 0x39)
temp |= *it + 0x04;
else if (*it == 0x2B)
temp |= 0x3E;
else if (*it == 0x2F)
temp |= 0x3F;
else if (*it == kPadCharacter) {
switch (input.end() - it) {
case 1:
decoded.push_back((temp >> 16) & 0x000000FF);
decoded.push_back((temp >> 8) & 0x000000FF);
return decoded;
case 2:
decoded.push_back((temp >> 10) & 0x000000FF);
return decoded;
default:
throw std::runtime_error("Invalid padding in base64!");
}
} else
throw std::runtime_error("Invalid character in base64!");
++it;
}
decoded.push_back((temp >> 16) & 0x000000FF);
decoded.push_back((temp >> 8) & 0x000000FF);
decoded.push_back((temp) & 0x000000FF);
}
return decoded;
}
} // namespace base64
} // namespace utils
} // namespace villas

38
common/lib/buffer.cpp Normal file
View file

@ -0,0 +1,38 @@
/* A simple buffer for encoding streamed JSON messages.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <villas/buffer.hpp>
#include <villas/compat.hpp>
using namespace villas;
json_t *Buffer::decode() {
json_t *j;
json_error_t err;
j = json_loadb(data(), size(), JSON_DISABLE_EOF_CHECK, &err);
if (!j)
return nullptr;
// Remove decoded JSON document from beginning
erase(begin(), begin() + err.position);
return j;
}
int Buffer::encode(json_t *j, int flags) {
return json_dump_callback(j, callback, this, flags);
}
int Buffer::callback(const char *data, size_t len, void *ctx) {
Buffer *b = static_cast<Buffer *>(ctx);
// Append junk of JSON to buffer
b->insert(b->end(), &data[0], &data[len]);
return 0;
}

44
common/lib/common.cpp Normal file
View file

@ -0,0 +1,44 @@
/* Common code.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <villas/common.hpp>
#include <cstdlib>
std::string stateToString(enum State s) {
switch (s) {
case State::DESTROYED:
return "destroyed";
case State::INITIALIZED:
return "initialized";
case State::PARSED:
return "parsed";
case State::CHECKED:
return "checked";
case State::STARTED:
return "running";
case State::STOPPED:
return "stopped";
case State::PENDING_CONNECT:
return "pending-connect";
case State::CONNECTED:
return "connected";
case State::PAUSED:
return "paused";
default:
return "";
}
}

60
common/lib/compat.cpp Normal file
View file

@ -0,0 +1,60 @@
/* Compatability for different library versions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cstring>
#include <jansson.h>
#include <unistd.h>
#include <villas/compat.hpp>
#if JANSSON_VERSION_HEX < 0x020A00
size_t json_dumpb(const json_t *json, char *buffer, size_t size, size_t flags) {
char *str;
size_t len;
str = json_dumps(json, flags);
if (!str)
return 0;
len = strlen(str); // Not \0 terminated
if (buffer && len <= size)
memcpy(buffer, str, len);
free(str);
return len;
}
static size_t json_loadfd_callback(void *buffer, size_t buflen, void *data) {
int *fd = (int *)data;
return (size_t)read(*fd, buffer, buflen);
}
json_t *json_loadfd(int input, size_t flags, json_error_t *error) {
return json_load_callback(json_loadfd_callback, (void *)&input, flags, error);
}
static int json_dumpfd_callback(const char *buffer, size_t size, void *data) {
#ifdef HAVE_UNISTD_H
int *dest = (int *)data;
if (write(*dest, buffer, size) == (ssize_t)size)
return 0;
#else
(void)buffer;
(void)size;
(void)data;
#endif // HAVE_UNISTD_H
return -1;
}
int json_dumpfd(const json_t *json, int output, size_t flags) {
return json_dump_callback(json, json_dumpfd_callback, (void *)&output, flags);
}
#endif // JANSSON_VERSION_HEX < 0x020A00

105
common/lib/cpuset.cpp Normal file
View file

@ -0,0 +1,105 @@
/* Human readable cpusets.
*
* Author: Steffen Vogel <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <villas/cpuset.hpp>
#include <villas/utils.hpp>
using namespace villas::utils;
#ifdef __linux__
CpuSet::CpuSet(uintmax_t iset) : CpuSet() {
zero();
for (size_t i = 0; i < num_cpus; i++) {
if (iset & (1L << i))
set(i);
}
}
CpuSet::CpuSet(const std::string &str) : CpuSet() {
size_t endpos, start, end;
for (auto token : tokenize(str, ",")) {
auto sep = token.find('-');
if (sep == std::string::npos) {
start = std::stoi(token, &endpos);
if (token.begin() + endpos != token.end())
throw std::invalid_argument("Not a valid CPU set");
if (start < num_cpus)
set(start);
} else {
start = std::stoi(token, &endpos);
if (token.begin() + endpos != token.begin() + sep)
throw std::invalid_argument("Not a valid CPU set");
auto token2 = token.substr(endpos + 1);
end = std::stoi(token2, &endpos);
if (token2.begin() + endpos != token2.end())
throw std::invalid_argument("Not a valid CPU set");
for (size_t i = start; i <= end && i < num_cpus; i++)
set(i);
}
}
}
CpuSet::CpuSet(const char *str) : CpuSet(std::string(str)) {}
CpuSet::operator uintmax_t() {
uintmax_t iset = 0;
for (size_t i = 0; i < num_cpus; i++) {
if (isSet(i))
iset |= 1ULL << i;
}
return iset;
}
CpuSet::operator std::string() {
std::stringstream ss;
bool first = true;
for (size_t i = 0; i < num_cpus; i++) {
if (isSet(i)) {
size_t run = 0;
for (size_t j = i + 1; j < num_cpus; j++) {
if (!isSet(j))
break;
run++;
}
if (first)
first = false;
else
ss << ",";
ss << i;
if (run == 1) {
ss << "," << (i + 1);
i++;
} else if (run > 1) {
ss << "-" << (i + run);
i += run;
}
}
}
return ss.str();
}
#endif // __linux__

48
common/lib/dsp/pid.cpp Normal file
View file

@ -0,0 +1,48 @@
/* A PID controller.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cmath>
#include <iostream>
#include <villas/dsp/pid.hpp>
using namespace std;
using namespace villas::dsp;
PID::PID(double _dt, double _max, double _min, double _Kp, double _Kd,
double _Ki)
: dt(_dt), max(_max), min(_min), Kp(_Kp), Kd(_Kd), Ki(_Ki), pre_error(0),
integral(0) {}
double PID::calculate(double setpoint, double pv) {
// Calculate error
double error = setpoint - pv;
// Proportional term
double Pout = Kp * error;
// Integral term
integral += error * dt;
double Iout = Ki * integral;
// Derivative term
double derivative = (error - pre_error) / dt;
double Dout = Kd * derivative;
// Calculate total output
double output = Pout + Iout + Dout;
// Restrict to max/min
if (output > max)
output = max;
else if (output < min)
output = min;
// Save error to previous error
pre_error = error;
return output;
}

231
common/lib/hist.cpp Normal file
View file

@ -0,0 +1,231 @@
/* Histogram class.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <algorithm>
#include <cmath>
#include <villas/config.hpp>
#include <villas/exceptions.hpp>
#include <villas/hist.hpp>
#include <villas/table.hpp>
#include <villas/utils.hpp>
using namespace villas;
using namespace villas::utils;
namespace villas {
Hist::Hist(int buckets, Hist::cnt_t wu)
: resolution(0), high(0), low(0),
highest(std::numeric_limits<double>::min()),
lowest(std::numeric_limits<double>::max()), last(0), total(0), warmup(wu),
higher(0), lower(0), data(buckets, 0), _m{0, 0}, _s{0, 0} {}
void Hist::put(double value) {
last = value;
// Update min/max
if (value > highest)
highest = value;
if (value < lowest)
lowest = value;
if (data.size()) {
if (total < warmup) {
// We are still in warmup phase... Waiting for more samples...
} else if (data.size() && total == warmup && warmup != 0) {
low = getMean() - 3 * getStddev();
high = getMean() + 3 * getStddev();
resolution = (high - low) / data.size();
} else if (data.size() && (total == warmup) && (warmup == 0)) {
// There is no warmup phase
// TODO resolution = ?
} else {
idx_t idx = std::round((value - low) / resolution);
// Check bounds and increment
if (idx >= (idx_t)data.size())
higher++;
else if (idx < 0)
lower++;
else
data[idx]++;
}
}
total++;
// Online / running calculation of variance and mean
// by Donald Knuth’s Art of Computer Programming, Vol 2, page 232, 3rd edition
if (total == 1) {
_m[1] = _m[0] = value;
_s[1] = 0.0;
} else {
_m[0] = _m[1] + (value - _m[1]) / total;
_s[0] = _s[1] + (value - _m[1]) * (value - _m[0]);
// Set up for next iteration
_m[1] = _m[0];
_s[1] = _s[0];
}
}
void Hist::reset() {
total = 0;
higher = 0;
lower = 0;
highest = std::numeric_limits<double>::min();
lowest = std::numeric_limits<double>::max();
for (auto &elm : data)
elm = 0;
}
double Hist::getMean() const {
return total > 0 ? _m[0] : std::numeric_limits<double>::quiet_NaN();
}
double Hist::getVar() const {
return total > 1 ? _s[0] / (total - 1)
: std::numeric_limits<double>::quiet_NaN();
}
double Hist::getStddev() const { return sqrt(getVar()); }
void Hist::print(Logger logger, bool details, std::string prefix) const {
if (total > 0) {
Hist::cnt_t missed = total - higher - lower;
logger->info("{}Counted values: {} ({} between {} and {})", prefix, total,
missed, low, high);
logger->info("{}Highest: {:g}", prefix, highest);
logger->info("{}Lowest: {:g}", prefix, lowest);
logger->info("{}Mu: {:g}", prefix, getMean());
logger->info("{}1/Mu: {:g}", prefix, 1.0 / getMean());
logger->info("{}Variance: {:g}", prefix, getVar());
logger->info("{}Stddev: {:g}", prefix, getStddev());
if (details && total - higher - lower > 0) {
char *buf = dump();
logger->info("{}Matlab: {}", prefix, buf);
free(buf);
plot(logger);
}
} else
logger->info("{}Counted values: {}", prefix, total);
}
void Hist::plot(Logger logger) const {
// Get highest bar
Hist::cnt_t max = *std::max_element(data.begin(), data.end());
std::vector<TableColumn> cols = {
{-9, TableColumn::Alignment::RIGHT, "Value", "%+9.3g"},
{-6, TableColumn::Alignment::RIGHT, "Count", "%6ju"},
{0, TableColumn::Alignment::LEFT, "Plot", "%s", "occurrences"}};
Table table = Table(logger, cols);
// Print plot
table.header();
for (size_t i = 0; i < data.size(); i++) {
double value = low + (i)*resolution;
Hist::cnt_t cnt = data[i];
int bar = cols[2].getWidth() * ((double)cnt / max);
char *buf = strf("%s", "");
for (int i = 0; i < bar; i++)
buf = strcatf(&buf, "\u2588");
table.row(3, value, cnt, buf);
free(buf);
}
}
char *Hist::dump() const {
char *buf = new char[128];
if (!buf)
throw MemoryAllocationError();
memset(buf, 0, 128);
strcatf(&buf, "[ ");
for (auto elm : data)
strcatf(&buf, "%ju ", elm);
strcatf(&buf, "]");
return buf;
}
json_t *Hist::toJson() const {
json_t *json_buckets, *json_hist;
json_hist = json_pack("{ s: f, s: f, s: i }", "low", low, "high", high,
"total", total);
if (total > 0) {
json_object_update(json_hist,
json_pack("{ s: i, s: i, s: f, s: f, s: f, s: f, s: f }",
"higher", higher, "lower", lower, "highest",
highest, "lowest", lowest, "mean", getMean(),
"variance", getVar(), "stddev", getStddev()));
}
if (total - lower - higher > 0) {
json_buckets = json_array();
for (auto elm : data)
json_array_append(json_buckets, json_integer(elm));
json_object_set(json_hist, "buckets", json_buckets);
}
return json_hist;
}
int Hist::dumpJson(FILE *f) const {
json_t *j = Hist::toJson();
int ret = json_dumpf(j, f, 0);
json_decref(j);
return ret;
}
int Hist::dumpMatlab(FILE *f) const {
fprintf(f, "struct(");
fprintf(f, "'low', %f, ", low);
fprintf(f, "'high', %f, ", high);
fprintf(f, "'total', %ju, ", total);
fprintf(f, "'higher', %ju, ", higher);
fprintf(f, "'lower', %ju, ", lower);
fprintf(f, "'highest', %f, ", highest);
fprintf(f, "'lowest', %f, ", lowest);
fprintf(f, "'mean', %f, ", getMean());
fprintf(f, "'variance', %f, ", getVar());
fprintf(f, "'stddev', %f, ", getStddev());
if (total - lower - higher > 0) {
char *buf = dump();
fprintf(f, "'buckets', %s", buf);
free(buf);
} else
fprintf(f, "'buckets', zeros(1, %zu)", data.size());
fprintf(f, ")");
return 0;
}
} // namespace villas

459
common/lib/kernel/devices/pci_device.cpp Normal file
View file

@ -0,0 +1,459 @@
/* Linux PCI helpers.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-License-Identifier: Apache-2.0
*/
#include <cstring>
#include <dirent.h>
#include <fcntl.h>
#include <libgen.h>
#include <linux/limits.h>
#include <linux/pci_regs.h>
#include <sys/stat.h>
#include <unistd.h>
#include <villas/config.hpp>
#include <villas/exceptions.hpp>
#include <villas/kernel/devices/pci_device.hpp>
#include <villas/utils.hpp>
using namespace villas::kernel::devices;
#define PCI_BASE_ADDRESS_N(n) (PCI_BASE_ADDRESS_0 + sizeof(uint32_t) * (n))
PciDeviceList *PciDeviceList::instance = nullptr;
PciDeviceList *PciDeviceList::getInstance() {
if (instance == nullptr) {
instance = new PciDeviceList();
}
return instance;
};
PciDeviceList::PciDeviceList() {
struct dirent *e;
DIR *dp;
FILE *f;
char path[PATH_MAX];
int ret;
snprintf(path, sizeof(path), "%s/bus/pci/devices", SYSFS_PATH);
dp = opendir(path);
if (!dp)
throw SystemError("Failed to detect PCI devices");
while ((e = readdir(dp))) {
// Ignore special entries
if ((strcmp(e->d_name, ".") == 0) || (strcmp(e->d_name, "..") == 0))
continue;
Id id;
Slot slot;
struct {
const char *s;
unsigned int *p;
} map[] = {{"vendor", &id.vendor}, {"device", &id.device}};
// Read vendor & device id
for (int i = 0; i < 2; i++) {
snprintf(path, sizeof(path), "%s/bus/pci/devices/%s/%s", SYSFS_PATH,
e->d_name, map[i].s);
f = fopen(path, "r");
if (!f)
throw SystemError("Failed to open '{}'", path);
ret = fscanf(f, "%x", map[i].p);
if (ret != 1)
throw RuntimeError("Failed to parse {} ID from: {}", map[i].s, path);
fclose(f);
}
// Get slot id
ret = sscanf(e->d_name, "%4x:%2x:%2x.%u", &slot.domain, &slot.bus,
&slot.device, &slot.function);
if (ret != 4)
throw RuntimeError("Failed to parse PCI slot number: {}", e->d_name);
emplace_back(std::make_shared<PciDevice>(id, slot));
}
closedir(dp);
}
PciDeviceList::value_type PciDeviceList::lookupDevice(const Slot &s) {
return *std::find_if(begin(), end(), [s](const PciDeviceList::value_type &d) {
return d->slot == s;
});
}
PciDeviceList::value_type PciDeviceList::lookupDevice(const Id &i) {
return *std::find_if(begin(), end(), [i](const PciDeviceList::value_type &d) {
return d->id == i;
});
}
PciDeviceList::value_type PciDeviceList::lookupDevice(const PciDevice &d) {
auto dev =
std::find_if(begin(), end(),
[d](const PciDeviceList::value_type &e) { return *e == d; });
return dev == end() ? value_type() : *dev;
}
Id::Id(const std::string &str) : vendor(0), device(0), class_code(0) {
char *s, *c, *e;
char *tmp = strdup(str.c_str());
if (!*tmp)
return;
s = strchr(tmp, ':');
if (!s) {
free(tmp);
throw RuntimeError("Failed to parse PCI id: ':' expected", str);
}
*s++ = 0;
if (tmp[0] && strcmp(tmp, "*")) {
long int x = strtol(tmp, &e, 16);
if ((e && *e) || (x < 0 || x > 0xffff)) {
free(tmp);
throw RuntimeError("Failed to parse PCI id: {}: Invalid vendor id", str);
}
vendor = x;
}
c = strchr(s, ':');
if (c)
*c++ = 0;
if (s[0] && strcmp(s, "*")) {
long int x = strtol(s, &e, 16);
if ((e && *e) || (x < 0 || x > 0xffff)) {
free(tmp);
throw RuntimeError("Failed to parse PCI id: {}: Invalid device id", str);
}
device = x;
}
if (c && c[0] && strcmp(s, "*")) {
long int x = strtol(c, &e, 16);
if ((e && *e) || (x < 0 || x > 0xffff)) {
free(tmp);
throw RuntimeError("Failed to parse PCI id: {}: Invalid class code", str);
}
class_code = x;
}
free(tmp);
}
bool Id::operator==(const Id &i) {
if ((i.device != 0 && i.device != device) ||
(i.vendor != 0 && i.vendor != vendor))
return false;
if ((i.class_code != 0) || (i.class_code != class_code))
return false;
return true;
}
Slot::Slot(const std::string &str) : domain(0), bus(0), device(0), function(0) {
char *tmp = strdup(str.c_str());
char *colon = strrchr(tmp, ':');
char *dot = strchr((colon ? colon + 1 : tmp), '.');
char *mid = tmp;
char *e, *buss, *colon2;
if (colon) {
*colon++ = 0;
mid = colon;
colon2 = strchr(tmp, ':');
if (colon2) {
*colon2++ = 0;
buss = colon2;
if (tmp[0] && strcmp(tmp, "*")) {
long int x = strtol(tmp, &e, 16);
if ((e && *e) || (x < 0 || x > 0x7fffffff)) {
free(tmp);
throw RuntimeError("Failed to parse PCI slot: {}: invalid domain",
str);
}
domain = x;
}
} else
buss = tmp;
if (buss[0] && strcmp(buss, "*")) {
long int x = strtol(buss, &e, 16);
if ((e && *e) || (x < 0 || x > 0xff)) {
free(tmp);
throw RuntimeError("Failed to parse PCI slot: {}: invalid bus", str);
}
bus = x;
}
}
if (dot)
*dot++ = 0;
if (mid[0] && strcmp(mid, "*")) {
long int x = strtol(mid, &e, 16);
if ((e && *e) || (x < 0 || x > 0x1f)) {
free(tmp);
throw RuntimeError("Failed to parse PCI slot: {}: invalid slot", str);
}
device = x;
}
if (dot && dot[0] && strcmp(dot, "*")) {
long int x = strtol(dot, &e, 16);
if ((e && *e) || (x < 0 || x > 7)) {
free(tmp);
throw RuntimeError("Failed to parse PCI slot: {}: invalid function", str);
}
function = x;
}
free(tmp);
}
bool Slot::operator==(const Slot &s) {
if ((s.domain != 0 && s.domain != domain) || (s.bus != 0 && s.bus != bus) ||
(s.device != 0 && s.device != device) ||
(s.function != 0 && s.function != function))
return false;
return true;
}
bool PciDevice::operator==(const PciDevice &f) {
return id == f.id && slot == f.slot;
}
std::list<Region> PciDevice::getRegions() const {
FILE *f;
char sysfs[1024];
snprintf(sysfs, sizeof(sysfs),
"%s/bus/pci/devices/%04x:%02x:%02x.%x/resource", SYSFS_PATH,
slot.domain, slot.bus, slot.device, slot.function);
f = fopen(sysfs, "r");
if (!f)
throw SystemError("Failed to open resource mapping {}", sysfs);
std::list<Region> regions;
ssize_t bytesRead;
char *line = nullptr;
size_t len = 0;
int reg_num = 0;
// Cap to 8 regions, just because we don't know how many may exist.
while (reg_num < 8 && (bytesRead = getline(&line, &len, f)) != -1) {
unsigned long long tokens[3];
char *s = line;
for (int i = 0; i < 3; i++) {
char *end;
tokens[i] = strtoull(s, &end, 16);
if (s == end) {
log->debug("Error parsing line {} of {}", reg_num + 1, sysfs);
tokens[0] = tokens[1] = 0; // Mark invalid
break;
}
s = end;
}
free(line);
// Required for getline() to allocate a new buffer on the next iteration.
line = nullptr;
len = 0;
if (tokens[0] != tokens[1]) { // This is a valid region
Region region;
region.num = reg_num;
region.start = tokens[0];
region.end = tokens[1];
region.flags = tokens[2];
regions.push_back(region);
}
reg_num++;
}
fclose(f);
return regions;
}
std::string PciDevice::getDriver() const {
int ret;
char sysfs[1024], syml[1024];
memset(syml, 0, sizeof(syml));
snprintf(sysfs, sizeof(sysfs), "%s/bus/pci/devices/%04x:%02x:%02x.%x/driver",
SYSFS_PATH, slot.domain, slot.bus, slot.device, slot.function);
struct stat st;
ret = stat(sysfs, &st);
if (ret)
return "";
ret = readlink(sysfs, syml, sizeof(syml));
if (ret < 0)
throw SystemError("Failed to follow link: {}", sysfs);
return basename(syml);
}
bool PciDevice::attachDriver(const std::string &driver) const {
FILE *f;
char fn[1024];
// Add new ID to driver
snprintf(fn, sizeof(fn), "%s/bus/pci/drivers/%s/new_id", SYSFS_PATH,
driver.c_str());
f = fopen(fn, "w");
if (!f)
throw SystemError("Failed to add PCI id to {} driver ({})", driver, fn);
log->info("Adding ID to {} module: {:04x} {:04x}", driver, id.vendor,
id.device);
fprintf(f, "%04x %04x", id.vendor, id.device);
fclose(f);
// Bind to driver
snprintf(fn, sizeof(fn), "%s/bus/pci/drivers/%s/bind", SYSFS_PATH,
driver.c_str());
f = fopen(fn, "w");
if (!f)
throw SystemError("Failed to bind PCI device to {} driver ({})", driver,
fn);
log->info("Bind device to {} driver", driver);
fprintf(f, "%04x:%02x:%02x.%x\n", slot.domain, slot.bus, slot.device,
slot.function);
fclose(f);
return true;
}
uint32_t PciDevice::readHostBar(unsigned barNum) const {
auto file = openSysFs("resource", std::ios_base::in);
std::string line;
unsigned i;
for (i = 0; i <= barNum && !file.eof(); i++)
std::getline(file, line);
if (i != barNum && file.eof())
throw RuntimeError("Failed to read resource file");
unsigned long long start, end, flags;
if (std::sscanf(line.c_str(), "%llx %llx %llx", &start, &end, &flags) != 3)
throw SystemError("Failed to parse BAR line");
if (end <= start) {
throw SystemError("Invalid BAR: start={}, end={}", start, end);
}
log->debug("Host BAR: start={:#x}, end={:#x}, size={:#x}, flags={:#x}", start,
end, end - start + 1, flags);
return start;
}
void PciDevice::rewriteBar(unsigned barNum) {
auto hostBar = readHostBar(barNum);
auto configBar = readBar(barNum);
log->debug("Host BAR: {:#x}, configbar: {:#x}", hostBar, configBar);
if (hostBar == configBar) {
log->debug("BAR is already correct");
return;
}
log->debug("BAR is incorrect, rewriting");
writeBar(hostBar, barNum);
}
uint32_t PciDevice::readBar(unsigned barNum) const {
uint32_t addr;
auto file = openSysFs("config", std::ios_base::in);
file.seekg(PCI_BASE_ADDRESS_N(barNum));
file.read(reinterpret_cast<char *>(&addr), sizeof(addr));
return addr;
}
void PciDevice::writeBar(uint32_t addr, unsigned barNum) {
auto file = openSysFs("config", std::ios_base::out);
file.seekp(PCI_BASE_ADDRESS_N(barNum));
file.write(reinterpret_cast<char *>(&addr), sizeof(addr));
}
int PciDevice::getIommuGroup() const {
int ret;
char *group;
// readlink() does not add a null terminator!
char link[1024] = {0};
char sysfs[1024];
snprintf(sysfs, sizeof(sysfs),
"%s/bus/pci/devices/%04x:%02x:%02x.%x/iommu_group", SYSFS_PATH,
slot.domain, slot.bus, slot.device, slot.function);
ret = readlink(sysfs, link, sizeof(link));
if (ret < 0)
return -1;
group = basename(link);
return atoi(group);
}
std::fstream PciDevice::openSysFs(const std::string &subPath,
std::ios_base::openmode mode) const {
std::fstream file;
auto sysFsFilename =
fmt::format("{}/bus/pci/devices/{:04x}:{:02x}:{:02x}.{:x}/{}", SYSFS_PATH,
slot.domain, slot.bus, slot.device, slot.function, subPath);
file.exceptions(std::ifstream::failbit | std::ifstream::badbit);
file.open(sysFsFilename, mode);
return file;
}

333
common/lib/kernel/kernel.cpp Normal file
View file

@ -0,0 +1,333 @@
/* Linux kernel related functions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cinttypes>
#include <cstdio>
#include <cstring>
#include <ctime>
#include <fcntl.h>
#include <sys/utsname.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <villas/config.hpp>
#include <villas/kernel/kernel.hpp>
#include <villas/log.hpp>
#include <villas/utils.hpp>
#include <villas/exceptions.hpp>
#include <villas/kernel/kernel.hpp>
using namespace villas;
using namespace villas::utils;
Version villas::kernel::getVersion() {
struct utsname uts;
if (uname(&uts) < 0)
throw SystemError("Failed to retrieve system identification");
std::string rel = uts.release;
// Remove release part. E.g. 4.9.93-linuxkit-aufs
auto sep = rel.find('-');
auto ver = rel.substr(0, sep - 1);
return Version(ver);
}
int villas::kernel::getCachelineSize() {
#if defined(__linux__) && defined(__x86_64__) && defined(__GLIBC__)
return sysconf(_SC_LEVEL1_ICACHE_LINESIZE);
#elif defined(__MACH__)
// Open the command for reading.
FILE *fp = popen("sysctl -n machdep.cpu.cache.linesize", "r");
if (fp == nullptr)
return -1;
int ret, size;
ret = fscanf(fp, "%d", &size);
pclose(fp);
return ret == 1 ? size : -1;
#else
return CACHELINE_SIZE;
#endif
}
#if defined(__linux__)
int villas::kernel::getPageSize() { return sysconf(_SC_PAGESIZE); }
#else
#error "Unsupported platform"
#endif
// There is no sysconf interface to get the hugepage size
int villas::kernel::getHugePageSize() {
#ifdef __linux__
char *key, *value, *unit, *line = nullptr, *lasts;
int sz = -1;
size_t len = 0;
FILE *f;
f = fopen(PROCFS_PATH "/meminfo", "r");
if (!f)
return -1;
while (getline(&line, &len, f) != -1) {
key = strtok_r(line, ": ", &lasts);
value = strtok_r(nullptr, " ", &lasts);
unit = strtok_r(nullptr, "\n", &lasts);
if (!strcmp(key, "Hugepagesize") && !strcmp(unit, "kB")) {
sz = strtoul(value, nullptr, 10) * 1024;
break;
}
}
free(line);
fclose(f);
return sz;
#elif defined(__x86_64__)
return 1 << 21;
#elif defined(__i386__)
return 1 << 22;
#else
#error "Unsupported architecture"
#endif
}
#ifdef __linux__
int villas::kernel::setModuleParam(const char *module, const char *param,
const char *value) {
FILE *f;
char fn[256];
snprintf(fn, sizeof(fn), "%s/module/%s/parameters/%s", SYSFS_PATH, module,
param);
f = fopen(fn, "w");
if (!f)
throw RuntimeError("Failed set parameter {} for kernel module {} to {}",
module, param, value);
auto logger = Log::get("kernel");
logger->debug("Set parameter {} of kernel module {} to {}", module, param,
value);
fprintf(f, "%s", value);
fclose(f);
return 0;
}
int villas::kernel::loadModule(const char *module) {
int ret;
ret = isModuleLoaded(module);
if (!ret) {
auto logger = Log::get("kernel");
logger->debug("Kernel module {} already loaded...", module);
return 0;
}
pid_t pid = fork();
switch (pid) {
case -1: // Error
return -1;
case 0: // Child
execlp("modprobe", "modprobe", module, (char *)0);
exit(EXIT_FAILURE); // exec() never returns
default:
wait(&ret);
return isModuleLoaded(module);
}
}
int villas::kernel::isModuleLoaded(const char *module) {
FILE *f;
int ret = -1;
char *line = nullptr;
size_t len = 0;
f = fopen(PROCFS_PATH "/modules", "r");
if (!f)
return -1;
while (getline(&line, &len, f) >= 0) {
if (strstr(line, module) == line) {
ret = 0;
break;
}
}
free(line);
fclose(f);
return ret;
}
int villas::kernel::getCmdlineParam(const char *param, char *buf, size_t len) {
int ret;
char cmdline[512], key[128], value[128], *lasts, *tok;
FILE *f = fopen(PROCFS_PATH "/cmdline", "r");
if (!f)
return -1;
if (!fgets(cmdline, sizeof(cmdline), f))
goto out;
tok = strtok_r(cmdline, " \t", &lasts);
do {
ret = sscanf(tok, "%127[^=]=%127s", key, value);
if (ret >= 1) {
auto logger = Log::get("kernel");
if (ret >= 2)
logger->debug("Found kernel param: {}={}", key, value);
else
logger->debug("Found kernel param: {}", key);
if (strcmp(param, key) == 0) {
if (ret >= 2 && buf)
snprintf(buf, len, "%s", value);
return 0; // Found
}
}
} while ((tok = strtok_r(nullptr, " \t", &lasts)));
out:
fclose(f);
return -1; // Not found or error
}
int villas::kernel::getNrHugepages() {
FILE *f;
int nr, ret;
f = fopen(PROCFS_PATH "/sys/vm/nr_hugepages", "r");
if (!f) {
auto logger = Log::get("kernel");
logger->error("Failed to open {}: {}", PROCFS_PATH "/sys/vm/nr_hugepages",
strerror(errno));
return -1;
}
ret = fscanf(f, "%d", &nr);
if (ret != 1)
nr = -1;
fclose(f);
return nr;
}
int villas::kernel::setNrHugepages(int nr) {
FILE *f;
f = fopen(PROCFS_PATH "/sys/vm/nr_hugepages", "w");
if (!f)
return -1;
fprintf(f, "%d\n", nr);
fclose(f);
return 0;
}
int villas::kernel::setIRQAffinity(unsigned irq, uintmax_t aff,
uintmax_t *old) {
char fn[64];
FILE *f;
int ret = 0;
snprintf(fn, sizeof(fn), "/proc/irq/%u/smp_affinity", irq);
f = fopen(fn, "w+");
if (!f)
return -1; // IRQ does not exist
if (old)
ret = fscanf(f, "%jx", old);
fprintf(f, "%jx", aff);
fclose(f);
return ret;
}
int villas::kernel::get_cpu_frequency(uint64_t *freq) {
char *line = nullptr, *sep, *end;
size_t len = 0;
double dfreq;
int ret;
FILE *f;
// Try to get CPU frequency from cpufreq module
f = fopen(SYSFS_PATH "/devices/system/cpu/cpu0/cpufreq/cpuinfo_max_freq",
"r");
if (!f)
goto cpuinfo;
ret = fscanf(f, "%" PRIu64, freq);
fclose(f);
if (ret != 1)
return -1;
// cpufreq reports kHz
*freq = *freq * 1000;
return 0;
cpuinfo:
// Try to read CPU frequency from /proc/cpuinfo
f = fopen(PROCFS_PATH "/cpuinfo", "r");
if (!f)
return -1; // We give up here
ret = -1;
while (getline(&line, &len, f) >= 0) {
if (strstr(line, "cpu MHz") == line) {
ret = 0;
break;
}
}
if (ret)
goto out;
sep = strchr(line, ':');
if (!sep) {
ret = -1;
goto out;
}
dfreq = strtod(sep + 1, &end);
if (end == sep + 1) {
ret = -1;
goto out;
}
// Frequency is given in MHz
*freq = dfreq * 1e6;
out:
fclose(f);
free(line);
return ret;
}
#endif // __linux__

139
common/lib/kernel/rt.cpp Normal file
View file

@ -0,0 +1,139 @@
/* Linux specific real-time optimizations.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <sched.h>
#include <unistd.h>
#include <villas/config.hpp>
#include <villas/cpuset.hpp>
#include <villas/exceptions.hpp>
#include <villas/log.hpp>
#include <villas/utils.hpp>
#include <villas/kernel/kernel.hpp>
#include <villas/kernel/rt.hpp>
#ifdef __linux__
using villas::utils::CpuSet;
#endif // __linux__
namespace villas {
namespace kernel {
namespace rt {
void init(int priority, int affinity) {
Logger logger = Log::get("kernel:rt");
logger->info("Initialize sub-system");
#ifdef __linux__
int is_rt, is_isol;
char isolcpus[255];
// Use FIFO scheduler with real time priority
is_rt = isPreemptible();
if (!is_rt)
logger->warn("We recommend to use an PREEMPT_RT patched kernel!");
if (priority)
setPriority(priority);
else
logger->warn(
"You might want to use the 'priority' setting to increase " PROJECT_NAME
"'s process priority");
if (affinity) {
is_isol = getCmdlineParam("isolcpus", isolcpus, sizeof(isolcpus));
if (is_isol)
logger->warn("You should reserve some cores for " PROJECT_NAME
" (see 'isolcpus')");
else {
CpuSet cset_pin(affinity);
CpuSet cset_isol(isolcpus);
CpuSet cset_non_isol = ~cset_isol & cset_pin;
if (cset_non_isol.count() > 0)
logger->warn("Affinity setting includes cores which are not isolated: "
"affinity={}, isolcpus={}, non_isolated={}",
(std::string)cset_pin, (std::string)cset_isol,
(std::string)cset_non_isol);
}
setProcessAffinity(affinity);
} else
logger->warn(
"You might want to use the 'affinity' setting to pin " PROJECT_NAME
" to dedicate CPU cores");
#else
logger->warn("This platform is not optimized for real-time execution");
(void)affinity;
(void)priority;
#endif // __linux__
}
#ifdef __linux__
void setProcessAffinity(int affinity) {
int ret;
assert(affinity != 0);
Logger logger = Log::get("kernel:rt");
// Pin threads to CPUs by setting the affinity
CpuSet cset_pin(affinity);
ret = sched_setaffinity(0, cset_pin.size(), cset_pin);
if (ret)
throw SystemError("Failed to set CPU affinity of process");
logger->debug("Set affinity to {} {}",
cset_pin.count() == 1 ? "core" : "cores",
(std::string)cset_pin);
}
void setThreadAffinity(pthread_t thread, int affinity) {
int ret;
assert(affinity != 0);
Logger logger = Log::get("kernel:rt");
CpuSet cset_pin(affinity);
ret = pthread_setaffinity_np(thread, cset_pin.size(), cset_pin);
if (ret)
throw SystemError("Failed to set CPU affinity of thread");
logger->debug("Set affinity of thread {} to {} {}", (long unsigned)thread,
cset_pin.count() == 1 ? "core" : "cores",
(std::string)cset_pin);
}
void setPriority(int priority) {
int ret;
struct sched_param param;
param.sched_priority = priority;
Logger logger = Log::get("kernel:rt");
ret = sched_setscheduler(0, SCHED_FIFO, &param);
if (ret)
throw SystemError("Failed to set real time priority");
logger->debug("Task priority set to {}", priority);
}
bool isPreemptible() {
return access(SYSFS_PATH "/kernel/realtime", R_OK) == 0;
}
#endif // __linux__
} // namespace rt
} // namespace kernel
} // namespace villas

312
common/lib/kernel/vfio_container.cpp Normal file
View file

@ -0,0 +1,312 @@
/* Virtual Function IO wrapper around kernel API.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2021 Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2018 Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-License-Identifier: Apache-2.0
*/
#define _DEFAULT_SOURCE
#if defined(__arm__) || defined(__aarch64__)
#define _LARGEFILE64_SOURCE 1
#define _FILE_OFFSET_BITS 64
#endif
#include <algorithm>
#include <array>
#include <limits>
#include <sstream>
#include <string>
#include <cstdlib>
#include <cstring>
#include <cstdint>
#include <fcntl.h>
#include <linux/pci_regs.h>
#include <sys/eventfd.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include <villas/exceptions.hpp>
#include <villas/kernel/kernel.hpp>
#include <villas/kernel/vfio_container.hpp>
#include <villas/log.hpp>
using namespace villas::kernel::vfio;
#ifndef VFIO_NOIOMMU_IOMMU
#define VFIO_NOIOMMU_IOMMU 8
#endif
static std::array<std::string, EXTENSION_SIZE> construct_vfio_extension_str() {
std::array<std::string, EXTENSION_SIZE> ret;
ret[VFIO_TYPE1_IOMMU] = "Type 1";
ret[VFIO_SPAPR_TCE_IOMMU] = "SPAPR TCE";
ret[VFIO_TYPE1v2_IOMMU] = "Type 1 v2";
ret[VFIO_DMA_CC_IOMMU] = "DMA CC";
ret[VFIO_EEH] = "EEH";
ret[VFIO_TYPE1_NESTING_IOMMU] = "Type 1 Nesting";
ret[VFIO_SPAPR_TCE_v2_IOMMU] = "SPAPR TCE v2";
ret[VFIO_NOIOMMU_IOMMU] = "No IOMMU";
// Backwards compatability with older kernels
#ifdef VFIO_UNMAP_ALL
ret[VFIO_UNMAP_ALL] = "Unmap all";
#endif
#ifdef VFIO_UPDATE_VADDR
ret[VFIO_UPDATE_VADDR] = "Update vaddr";
#endif
return ret;
}
static std::array<std::string, EXTENSION_SIZE> VFIO_EXTENSION_STR =
construct_vfio_extension_str();
Container::Container(std::vector<std::string> required_modules)
: fd(-1), version(0), extensions(), iova_next(0), hasIommu(false), groups(),
log(Log::get("kernel:vfio:container")) {
for (auto module : required_modules) {
if (kernel::loadModule(module.c_str()) != 0) {
throw RuntimeError("Kernel module '{}' required but could not be loaded. "
"Please load manually!",
module);
}
}
// Create a VFIO Container
fd = open(VFIO_DEV, O_RDWR);
if (fd < 0)
throw RuntimeError("Failed to open VFIO container");
// Check VFIO API version
version = ioctl(fd, VFIO_GET_API_VERSION);
if (version < 0 || version != VFIO_API_VERSION)
throw RuntimeError("Unknown API version: {}", version);
// Check available VFIO extensions (IOMMU types)
for (unsigned int i = VFIO_TYPE1_IOMMU; i < EXTENSION_SIZE; i++) {
int ret = ioctl(fd, VFIO_CHECK_EXTENSION, i);
extensions[i] = ret != 0;
log->debug("VFIO extension {} is {} ({})", i,
extensions[i] ? "available" : "not available",
VFIO_EXTENSION_STR[i]);
}
if (extensions[VFIO_TYPE1_IOMMU]) {
log->debug("Using VFIO type {} ({})", VFIO_TYPE1_IOMMU,
VFIO_EXTENSION_STR[VFIO_TYPE1_IOMMU]);
hasIommu = true;
} else if (extensions[VFIO_NOIOMMU_IOMMU]) {
log->debug("Using VFIO type {} ({})", VFIO_NOIOMMU_IOMMU,
VFIO_EXTENSION_STR[VFIO_NOIOMMU_IOMMU]);
hasIommu = false;
} else
throw RuntimeError("No supported IOMMU type available");
log->debug("Version: {:#x}", version);
log->debug("IOMMU: {}", hasIommu ? "yes" : "no");
}
Container::~Container() {
// Release memory and close fds
groups.clear();
log->debug("Cleaning up container with fd {}", fd);
// Close container
int ret = close(fd);
if (ret < 0)
log->error("Error closing vfio container fd {}: {}", fd, ret);
}
void Container::attachGroup(std::shared_ptr<Group> group) {
if (group->isAttachedToContainer())
throw RuntimeError("Group is already attached to a container");
// Claim group ownership
int ret = ioctl(group->getFileDescriptor(), VFIO_GROUP_SET_CONTAINER, &fd);
if (ret < 0)
throw SystemError("Failed to attach VFIO group {} to container fd {}",
group->getIndex(), fd);
// Set IOMMU type
int iommu_type = isIommuEnabled() ? VFIO_TYPE1_IOMMU : VFIO_NOIOMMU_IOMMU;
ret = ioctl(fd, VFIO_SET_IOMMU, iommu_type);
if (ret < 0)
throw SystemError("Failed to set IOMMU type of container");
group->setAttachedToContainer();
log->debug("Attached new group {} to VFIO container with fd {}",
group->getIndex(), fd);
// Push to our list
groups.push_back(std::move(group));
}
std::shared_ptr<Group> Container::getOrAttachGroup(int index) {
// Search if group with index already exists
for (auto &group : groups) {
if (group->getIndex() == index)
return group;
}
// Group not yet part of this container, so acquire ownership
auto group = std::make_shared<Group>(index, isIommuEnabled());
attachGroup(group);
return group;
}
void Container::dump() {
log->info("File descriptor: {}", fd);
log->info("Version: {}", version);
// Check available VFIO extensions (IOMMU types)
for (size_t i = 0; i < extensions.size(); i++)
log->debug("VFIO extension {} ({}) is {}", extensions[i],
VFIO_EXTENSION_STR[i],
extensions[i] ? "available" : "not available");
for (auto &group : groups)
group->dump();
}
std::shared_ptr<Device> Container::attachDevice(const std::string &name,
int index) {
auto group = getOrAttachGroup(index);
auto device = group->attachDevice(name);
return device;
}
std::shared_ptr<Device> Container::attachDevice(devices::PciDevice &pdev) {
int ret;
char name[32], iommu_state[4];
static constexpr const char *kernelDriver = "vfio-pci";
// Load PCI bus driver for VFIO
if (kernel::loadModule("vfio_pci"))
throw RuntimeError("Failed to load kernel driver: vfio_pci");
// Bind PCI card to vfio-pci driver if not already bound
if (pdev.getDriver() != kernelDriver) {
log->debug("Bind PCI card to kernel driver '{}'", kernelDriver);
pdev.attachDriver(kernelDriver);
}
try {
pdev.rewriteBar();
} catch (std::exception &e) {
throw RuntimeError(
e.what() +
std::string(
"\nBAR of device is in inconsistent state. Rewriting the BAR "
"failed. Please remove, rescan and reset the device and "
"try again."));
}
// Get IOMMU group of device
int index = isIommuEnabled() ? pdev.getIommuGroup() : 0;
if (index < 0) {
ret = kernel::getCmdlineParam("intel_iommu", iommu_state,
sizeof(iommu_state));
if (ret != 0 || strcmp("on", iommu_state) != 0)
log->warn("Kernel booted without command line parameter "
"'intel_iommu' set to 'on'. Please check documentation "
"(https://villas.fein-aachen.org/doc/fpga-setup.html) "
"for help with troubleshooting.");
throw RuntimeError("Failed to get IOMMU group of device");
}
// VFIO device name consists of PCI BDF
snprintf(name, sizeof(name), "%04x:%02x:%02x.%x", pdev.slot.domain,
pdev.slot.bus, pdev.slot.device, pdev.slot.function);
log->info("Attach to device {} with index {}", std::string(name), index);
auto group = getOrAttachGroup(index);
auto device = group->attachDevice(name, &pdev);
// Check if this is really a vfio-pci device
if (!device->isVfioPciDevice())
throw RuntimeError("Device is not a vfio-pci device");
return device;
}
uintptr_t Container::memoryMap(uintptr_t virt, uintptr_t phys, size_t length) {
int ret;
if (not hasIommu) {
log->error("DMA mapping not supported without IOMMU");
return UINTPTR_MAX;
}
if (length & 0xFFF) {
length += 0x1000;
length &= ~0xFFF;
}
// Super stupid allocator
size_t iovaIncrement = 0;
if (phys == UINTPTR_MAX) {
phys = this->iova_next;
iovaIncrement = length;
}
struct vfio_iommu_type1_dma_map dmaMap;
memset(&dmaMap, 0, sizeof(dmaMap));
dmaMap.argsz = sizeof(dmaMap);
dmaMap.vaddr = virt;
dmaMap.iova = phys;
dmaMap.size = length;
dmaMap.flags = VFIO_DMA_MAP_FLAG_READ | VFIO_DMA_MAP_FLAG_WRITE;
ret = ioctl(this->fd, VFIO_IOMMU_MAP_DMA, &dmaMap);
if (ret) {
log->error("Failed to create DMA mapping: {}", ret);
return UINTPTR_MAX;
}
log->debug("DMA map size={:#x}, iova={:#x}, vaddr={:#x}", dmaMap.size,
dmaMap.iova, dmaMap.vaddr);
// Mapping successful, advance IOVA allocator
this->iova_next += iovaIncrement;
// We intentionally don't return the actual mapped length, the users are
// only guaranteed to have their demanded memory mapped correctly
return dmaMap.iova;
}
bool Container::memoryUnmap(uintptr_t phys, size_t length) {
int ret;
if (not hasIommu)
return true;
struct vfio_iommu_type1_dma_unmap dmaUnmap;
dmaUnmap.argsz = sizeof(struct vfio_iommu_type1_dma_unmap);
dmaUnmap.flags = 0;
dmaUnmap.iova = phys;
dmaUnmap.size = length;
ret = ioctl(this->fd, VFIO_IOMMU_UNMAP_DMA, &dmaUnmap);
if (ret) {
log->error("Failed to unmap DMA mapping");
return false;
}
log->debug("DMA unmap size={:#x}, iova={:#x}", dmaUnmap.size, dmaUnmap.iova);
return true;
}

432
common/lib/kernel/vfio_device.cpp Normal file
View file

@ -0,0 +1,432 @@
/* Virtual Function IO wrapper around kernel API.
*
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2023 Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2018 Daniel Krebs <github@daniel-krebs.net>
* SPDX-License-Identifier: Apache-2.0
*/
#define _DEFAULT_SOURCE
#if defined(__arm__) || defined(__aarch64__)
#define _LARGEFILE64_SOURCE 1
#define _FILE_OFFSET_BITS 64
#endif
#include <algorithm>
#include <limits>
#include <sstream>
#include <string>
#include <fcntl.h>
#include <linux/pci_regs.h>
#include <sys/eventfd.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include <villas/exceptions.hpp>
#include <villas/kernel/vfio_device.hpp>
using namespace villas::kernel::vfio;
static const char *vfio_pci_region_names[] = {
"PCI_BAR0", // VFIO_PCI_BAR0_REGION_INDEX
"PCI_BAR1", // VFIO_PCI_BAR1_REGION_INDEX
"PCI_BAR2", // VFIO_PCI_BAR2_REGION_INDEX
"PCI_BAR3", // VFIO_PCI_BAR3_REGION_INDEX
"PCI_BAR4", // VFIO_PCI_BAR4_REGION_INDEX
"PCI_BAR5", // VFIO_PCI_BAR5_REGION_INDEX
"PCI_ROM", // VFIO_PCI_ROM_REGION_INDEX
"PCI_CONFIG", // VFIO_PCI_CONFIG_REGION_INDEX
"PCI_VGA" // VFIO_PCI_INTX_IRQ_INDEX
};
static const char *vfio_pci_irq_names[] = {
"PCI_INTX", // VFIO_PCI_INTX_IRQ_INDEX
"PCI_MSI", // VFIO_PCI_MSI_IRQ_INDEX
"PCI_MSIX", // VFIO_PCI_MSIX_IRQ_INDEX
"PCI_ERR", // VFIO_PCI_ERR_IRQ_INDEX
"PCI_REQ" // VFIO_PCI_REQ_IRQ_INDEX
};
Device::Device(const std::string &name, int groupFileDescriptor,
const kernel::devices::PciDevice *pci_device)
: name(name), fd(-1), attachedToGroup(false), groupFd(groupFileDescriptor),
info(), irqs(), regions(), mappings(), pci_device(pci_device),
log(Log::get("kernel:vfio:device")) {
if (groupFileDescriptor < 0)
throw RuntimeError("Invalid group file descriptor");
// Open device fd
fd = ioctl(groupFileDescriptor, VFIO_GROUP_GET_DEVICE_FD, name.c_str());
if (fd < 0)
throw RuntimeError("Failed to open VFIO device: {}", name.c_str());
// Get device info
info.argsz = sizeof(info);
int ret = ioctl(fd, VFIO_DEVICE_GET_INFO, &info);
if (ret < 0)
throw RuntimeError("Failed to get VFIO device info for: {}", name);
log->debug("device info: flags: 0x{:x}, num_regions: {}, num_irqs: {}",
info.flags, info.num_regions, info.num_irqs);
// device_info.num_region reports always 9 and includes a VGA region, which is only supported on
// certain device IDs. So for non-VGA devices VFIO_PCI_CONFIG_REGION_INDEX will be the highest
// region index. This is the config space.
info.num_regions = pci_device != 0 ? VFIO_PCI_CONFIG_REGION_INDEX + 1 : 1;
// Reserve slots already so that we can use the []-operator for access
irqs.resize(info.num_irqs);
regions.resize(info.num_regions);
mappings.resize(info.num_regions);
// Get device regions
for (size_t i = 0; i < info.num_regions; i++) {
struct vfio_region_info region;
memset(&region, 0, sizeof(region));
region.argsz = sizeof(region);
region.index = i;
ret = ioctl(fd, VFIO_DEVICE_GET_REGION_INFO, &region);
if (ret < 0)
throw RuntimeError("Failed to get region {} of VFIO device: {}", i, name);
log->debug("region {} info: flags: 0x{:x}, cap_offset: 0x{:x}, size: "
"0x{:x}, offset: 0x{:x}",
region.index, region.flags, region.cap_offset, region.size,
region.offset);
regions[i] = region;
}
// Get device IRQs
for (size_t i = 0; i < info.num_irqs; i++) {
struct vfio_irq_info irq;
memset(&irq, 0, sizeof(irq));
irq.argsz = sizeof(irq);
irq.index = i;
ret = ioctl(fd, VFIO_DEVICE_GET_IRQ_INFO, &irq);
if (ret < 0)
throw RuntimeError("Failed to get IRQ {} of VFIO device: {}", i, name);
log->debug("irq {} info: flags: 0x{:x}, count: {}", irq.index, irq.flags,
irq.count);
irqs[i] = irq;
}
}
Device::~Device() {
log->debug("Cleaning up device {} with fd {}", this->name, this->fd);
for (auto &region : regions) {
regionUnmap(region.index);
}
if (isVfioPciDevice()) {
pciHotReset();
}
reset();
int ret = close(fd);
if (ret != 0) {
log->error("Closing device fd {} failed", fd);
}
}
bool Device::reset() {
log->debug("Resetting device.");
if (this->info.flags & VFIO_DEVICE_FLAGS_RESET)
return ioctl(this->fd, VFIO_DEVICE_RESET) == 0;
else
return false; // Not supported by this device
}
void *Device::regionMap(size_t index) {
struct vfio_region_info *r = &regions[index];
if (!(r->flags & VFIO_REGION_INFO_FLAG_MMAP))
return MAP_FAILED;
int flags = MAP_SHARED;
#if !(defined(__arm__) || defined(__aarch64__))
flags |= MAP_SHARED | MAP_32BIT;
#endif
log->debug("Mapping region {} of size 0x{:x} with flags 0x{:x}", index,
r->size, flags);
mappings[index] =
mmap(nullptr, r->size, PROT_READ | PROT_WRITE, flags, fd, r->offset);
return mappings[index];
}
bool Device::regionUnmap(size_t index) {
int ret;
struct vfio_region_info *r = &regions[index];
if (!mappings[index])
return false; // Was not mapped
log->debug("Unmap region {} from device {}", index, name);
ret = munmap(mappings[index], r->size);
if (ret)
return false;
mappings[index] = nullptr;
return true;
}
size_t Device::regionGetSize(size_t index) {
if (index >= regions.size()) {
log->error("Index out of range: {} >= {}", index, regions.size());
throw std::out_of_range("Index out of range");
}
return regions[index].size;
}
void Device::dump() {
log->info("Device {}: regions={}, irqs={}, flags={}", name, info.num_regions,
info.num_irqs, info.flags);
for (size_t i = 0; i < info.num_regions && i < 8; i++) {
struct vfio_region_info *region = &regions[i];
if (region->size > 0) {
log->info("Region {} {}: size={}, offset={}, flags={}", region->index,
(info.flags & VFIO_DEVICE_FLAGS_PCI) ? vfio_pci_region_names[i]
: "",
region->size, region->offset, region->flags);
}
}
for (size_t i = 0; i < info.num_irqs; i++) {
struct vfio_irq_info *irq = &irqs[i];
if (irq->count > 0) {
log->info("IRQ {} {}: count={}, flags={}", irq->index,
(info.flags & VFIO_DEVICE_FLAGS_PCI) ? vfio_pci_irq_names[i]
: "",
irq->count, irq->flags);
}
}
}
bool Device::pciEnable() {
int ret;
uint32_t reg;
const off64_t offset =
PCI_COMMAND + (static_cast<off64_t>(VFIO_PCI_CONFIG_REGION_INDEX) << 40);
// Check if this is really a vfio-pci device
if (!(this->info.flags & VFIO_DEVICE_FLAGS_PCI))
return false;
ret = pread64(this->fd, &reg, sizeof(reg), offset);
if (ret != sizeof(reg))
return false;
// Enable memory access and PCI bus mastering which is required for DMA
reg |= PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
ret = pwrite64(this->fd, &reg, sizeof(reg), offset);
if (ret != sizeof(reg))
return false;
return true;
}
int Device::pciMsiInit(int efds[]) {
// Check if this is really a vfio-pci device
if (not isVfioPciDevice())
return -1;
const size_t irqCount = irqs[VFIO_PCI_MSI_IRQ_INDEX].count;
const size_t irqSetSize =
sizeof(struct vfio_irq_set) + sizeof(int) * irqCount;
auto *irqSetBuf = new char[irqSetSize];
if (!irqSetBuf)
throw MemoryAllocationError();
auto *irqSet = reinterpret_cast<struct vfio_irq_set *>(irqSetBuf);
irqSet->argsz = irqSetSize;
// DATA_EVENTFD binds the interrupt to the provided eventfd.
// SET_ACTION_TRIGGER enables kernel->userspace signalling.
irqSet->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
irqSet->index = VFIO_PCI_MSI_IRQ_INDEX;
irqSet->start = 0;
irqSet->count = irqCount;
// Now set the new eventfds
for (size_t i = 0; i < irqCount; i++) {
efds[i] = eventfd(0, 0);
if (efds[i] < 0) {
delete[] irqSetBuf;
return -1;
}
eventfdList.push_back(efds[i]);
}
memcpy(irqSet->data, efds, sizeof(int) * irqCount);
if (ioctl(fd, VFIO_DEVICE_SET_IRQS, irqSet) != 0) {
delete[] irqSetBuf;
return -1;
}
delete[] irqSetBuf;
return irqCount;
}
int Device::pciMsiDeinit(int efds[]) {
Log::get("Device")->debug("Deinitializing MSI interrupts for device {}",
name);
// Check if this is really a vfio-pci device
if (not isVfioPciDevice())
return -1;
const size_t irqCount = irqs[VFIO_PCI_MSI_IRQ_INDEX].count;
const size_t irqSetSize =
sizeof(struct vfio_irq_set) + sizeof(int) * irqCount;
auto *irqSetBuf = new char[irqSetSize];
if (!irqSetBuf)
throw MemoryAllocationError();
auto *irqSet = reinterpret_cast<struct vfio_irq_set *>(irqSetBuf);
irqSet->argsz = irqSetSize;
irqSet->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
irqSet->index = VFIO_PCI_MSI_IRQ_INDEX;
irqSet->count = irqCount;
irqSet->start = 0;
for (size_t i = 0; i < irqCount; i++) {
close(efds[i]);
efds[i] = -1;
}
memcpy(irqSet->data, efds, sizeof(int) * irqCount);
if (ioctl(fd, VFIO_DEVICE_SET_IRQS, irqSet) != 0) {
delete[] irqSetBuf;
return -1;
}
delete[] irqSetBuf;
return irqCount;
}
bool Device::pciMsiFind(int nos[]) {
int ret, idx, irq;
char *end, *col, *last, line[1024], name[13];
FILE *f;
f = fopen("/proc/interrupts", "r");
if (!f)
return false;
for (int i = 0; i < 32; i++)
nos[i] = -1;
// For each line in /proc/interrupts
while (fgets(line, sizeof(line), f)) {
col = strtok(line, " ");
// IRQ number is in first column
irq = strtol(col, &end, 10);
if (col == end)
continue;
// Find last column of line
do {
last = col;
} while ((col = strtok(nullptr, " ")));
ret = sscanf(last, "vfio-msi[%d](%12[0-9:])", &idx, name);
if (ret == 2) {
if (strstr(this->name.c_str(), name) == this->name.c_str())
nos[idx] = irq;
}
}
fclose(f);
return true;
}
bool Device::isVfioPciDevice() const {
return info.flags & VFIO_DEVICE_FLAGS_PCI;
}
bool Device::pciHotReset() {
// Check if this is really a vfio-pci device
if (!isVfioPciDevice())
return false;
log->debug("Performing hot reset.");
const size_t reset_info_len = sizeof(struct vfio_pci_hot_reset_info) +
sizeof(struct vfio_pci_dependent_device) * 64;
auto *reset_info_buf = new char[reset_info_len];
if (!reset_info_buf)
throw MemoryAllocationError();
auto *reset_info =
reinterpret_cast<struct vfio_pci_hot_reset_info *>(reset_info_buf);
reset_info->argsz = reset_info_len;
if (ioctl(fd, VFIO_DEVICE_GET_PCI_HOT_RESET_INFO, reset_info) != 0) {
delete[] reset_info_buf;
return false;
}
log->debug("Dependent devices for hot-reset:");
for (size_t i = 0; i < reset_info->count; i++) {
struct vfio_pci_dependent_device *dd = &reset_info->devices[i];
log->debug(" {:04x}:{:02x}:{:02x}.{:01x}: iommu_group={}", dd->segment,
dd->bus, PCI_SLOT(dd->devfn), PCI_FUNC(dd->devfn), dd->group_id);
}
delete[] reset_info_buf;
const size_t reset_len =
sizeof(struct vfio_pci_hot_reset) + sizeof(int32_t) * 1;
auto *reset_buf = new char[reset_len];
if (!reset_buf)
throw MemoryAllocationError();
auto *reset = reinterpret_cast<struct vfio_pci_hot_reset *>(reset_buf);
reset->argsz = reset_len;
reset->count = 1;
reset->group_fds[0] = groupFd;
int ret = ioctl(fd, VFIO_DEVICE_PCI_HOT_RESET, reset);
const bool success = (ret == 0);
delete[] reset_buf;
if (!success) {
log->warn("PCI hot reset failed, maybe no IOMMU available?");
return true;
}
return success;
}

125
common/lib/kernel/vfio_group.cpp Normal file
View file

@ -0,0 +1,125 @@
/* Virtual Function IO wrapper around kernel API.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* Author: Daniel Krebs <github@daniel-krebs.net>
* Author: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-FileCopyrightText: 2014-2021 Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2018 Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
* SPDX-License-Identifier: Apache-2.0
*/
#define _DEFAULT_SOURCE
#if defined(__arm__) || defined(__aarch64__)
#define _LARGEFILE64_SOURCE 1
#define _FILE_OFFSET_BITS 64
#endif
#include <algorithm>
#include <limits>
#include <sstream>
#include <string>
#include <cstdlib>
#include <cstring>
#include <cstdint>
#include <fcntl.h>
#include <linux/pci_regs.h>
#include <sys/eventfd.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include <villas/exceptions.hpp>
#include <villas/kernel/vfio_group.hpp>
using namespace villas::kernel::vfio;
Group::Group(int index, bool iommuEnabled)
: fd(-1), index(index), attachedToContainer(false), status(), devices(),
log(Log::get("kernel:vfio:group")) {
// Open group fd
std::stringstream groupPath;
groupPath << VFIO_PATH << (iommuEnabled ? "" : "noiommu-") << index;
log->debug("path: {}", groupPath.str().c_str());
fd = open(groupPath.str().c_str(), O_RDWR);
if (fd < 0) {
log->error("Failed to open VFIO group {}", index);
throw RuntimeError("Failed to open VFIO group");
}
log->debug("VFIO group {} (fd {}) has path {}", index, fd, groupPath.str());
checkStatus();
}
std::shared_ptr<Device> Group::attachDevice(std::shared_ptr<Device> device) {
if (device->isAttachedToGroup())
throw RuntimeError("Device is already attached to a group");
devices.push_back(device);
device->setAttachedToGroup();
return device;
}
std::shared_ptr<Device>
Group::attachDevice(const std::string &name,
const kernel::devices::PciDevice *pci_device) {
auto device = std::make_shared<Device>(name, fd, pci_device);
return attachDevice(device);
}
bool Group::checkStatus() {
int ret;
// Check group viability and features
status.argsz = sizeof(status);
ret = ioctl(fd, VFIO_GROUP_GET_STATUS, &status);
if (ret < 0) {
log->error("Failed to get VFIO group status");
return false;
}
if (!(status.flags & VFIO_GROUP_FLAGS_VIABLE)) {
log->error(
"VFIO group is not available: bind all devices to the VFIO driver!");
return false;
}
log->debug("VFIO group is {} viable", index);
return true;
}
void Group::dump() {
log->info("VFIO Group {}, viable={}, container={}", index,
(status.flags & VFIO_GROUP_FLAGS_VIABLE) > 0,
(status.flags & VFIO_GROUP_FLAGS_CONTAINER_SET) > 0);
for (auto &device : devices) {
device->dump();
}
}
Group::~Group() {
// Release memory and close fds
devices.clear();
log->debug("Cleaning up group {} with fd {}", index, fd);
if (fd < 0)
log->debug("Destructing group that has not been attached");
else {
log->debug("unsetting group container");
int ret = ioctl(fd, VFIO_GROUP_UNSET_CONTAINER);
if (ret != 0)
log->error("Cannot unset container for group fd {}", fd);
ret = close(fd);
if (ret != 0)
log->error("Cannot close group fd {}", fd);
}
}

265
common/lib/list.cpp Normal file
View file

@ -0,0 +1,265 @@
/* A generic linked list.
*
* Linked lists a used for several data structures in the code.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <algorithm>
#include <array>
#include <cstdlib>
#include <cstring>
#include <villas/list.hpp>
#include <villas/utils.hpp>
using namespace villas;
int villas::list_init(struct List *l) {
pthread_mutex_init(&l->lock, nullptr);
l->length = 0;
l->capacity = 0;
l->array = nullptr;
l->state = State::INITIALIZED;
return 0;
}
int villas::list_destroy(struct List *l, dtor_cb_t destructor, bool release) {
pthread_mutex_lock(&l->lock);
assert(l->state != State::DESTROYED);
for (size_t i = 0; i < list_length(l); i++) {
void *e = list_at(l, i);
if (destructor)
destructor(e);
if (release)
free(e);
}
free(l->array);
l->length = -1;
l->capacity = 0;
l->array = nullptr;
l->state = State::DESTROYED;
pthread_mutex_unlock(&l->lock);
pthread_mutex_destroy(&l->lock);
return 0;
}
void villas::list_push(struct List *l, void *p) {
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
// Resize array if out of capacity
if (l->length >= l->capacity) {
l->capacity += LIST_CHUNKSIZE;
l->array = (void **)realloc(l->array, l->capacity * sizeof(void *));
}
l->array[l->length] = p;
l->length++;
pthread_mutex_unlock(&l->lock);
}
void villas::list_clear(struct List *l) {
pthread_mutex_lock(&l->lock);
l->length = 0;
pthread_mutex_unlock(&l->lock);
}
int villas::list_remove(struct List *l, size_t idx) {
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
if (idx >= l->length)
return -1;
for (size_t i = idx; i < l->length - 1; i++)
l->array[i] = l->array[i + 1];
l->length--;
pthread_mutex_unlock(&l->lock);
return 0;
}
int villas::list_insert(struct List *l, size_t idx, void *p) {
size_t i;
void *t, *o;
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
if (idx >= l->length)
return -1;
// Resize array if out of capacity
if (l->length + 1 > l->capacity) {
l->capacity += LIST_CHUNKSIZE;
l->array = (void **)realloc(l->array, l->capacity * sizeof(void *));
}
o = p;
for (i = idx; i < l->length; i++) {
t = l->array[i];
l->array[i] = o;
o = t;
}
l->array[l->length] = o;
l->length++;
pthread_mutex_unlock(&l->lock);
return 0;
}
void villas::list_remove_all(struct List *l, void *p) {
int removed = 0;
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
for (size_t i = 0; i < list_length(l); i++) {
if (list_at(l, i) == p)
removed++;
else
l->array[i - removed] = list_at(l, i);
}
l->length -= removed;
pthread_mutex_unlock(&l->lock);
}
int villas::list_contains(struct List *l, void *p) {
return list_count(
l, [](const void *a, const void *b) { return a == b ? 0 : 1; }, p);
}
int villas::list_count(struct List *l, cmp_cb_t cmp, void *ctx) {
int c = 0;
void *e;
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
for (size_t i = 0; i < list_length(l); i++) {
e = list_at(l, i);
if (cmp(e, ctx) == 0)
c++;
}
pthread_mutex_unlock(&l->lock);
return c;
}
void *villas::list_search(struct List *l, cmp_cb_t cmp, const void *ctx) {
void *e;
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
for (size_t i = 0; i < list_length(l); i++) {
e = list_at(l, i);
if (cmp(e, ctx) == 0)
goto out;
}
e = nullptr; // Not found
out:
pthread_mutex_unlock(&l->lock);
return e;
}
void villas::list_sort(struct List *l, cmp_cb_t cmp) {
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
auto array = std::vector<void *>(l->array, l->array + l->length);
std::sort(array.begin(), array.end(),
[cmp](void *&a, void *&b) -> bool { return cmp(a, b) < 0; });
std::copy(array.begin(), array.end(), l->array);
pthread_mutex_unlock(&l->lock);
}
int villas::list_set(struct List *l, unsigned index, void *value) {
if (index >= l->length)
return -1;
l->array[index] = value;
return 0;
}
ssize_t villas::list_index(struct List *l, void *p) {
void *e;
ssize_t f;
pthread_mutex_lock(&l->lock);
assert(l->state == State::INITIALIZED);
for (size_t i = 0; i < list_length(l); i++) {
e = list_at(l, i);
if (e == p) {
f = i;
goto found;
}
}
f = -1;
found:
pthread_mutex_unlock(&l->lock);
return f;
}
void villas::list_extend(struct List *l, size_t len, void *val) {
while (list_length(l) < len)
list_push(l, val);
}
void villas::list_filter(struct List *l, dtor_cb_t cb) {
size_t i, j;
pthread_mutex_lock(&l->lock);
for (i = 0, j = 0; i < list_length(l); i++) {
void *e = list_at(l, i);
if (!cb(e))
l->array[j++] = e;
}
l->length = j;
pthread_mutex_unlock(&l->lock);
}

196
common/lib/log.cpp Normal file
View file

@ -0,0 +1,196 @@
/* Logging and debugging routines.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <algorithm>
#include <list>
#include <map>
#include <fnmatch.h>
#include <spdlog/sinks/basic_file_sink.h>
#include <spdlog/sinks/syslog_sink.h>
#include <villas/exceptions.hpp>
#include <villas/log.hpp>
#include <villas/terminal.hpp>
using namespace villas;
static std::map<spdlog::level::level_enum, std::string> levelNames = {
{spdlog::level::trace, "trc"}, {spdlog::level::debug, "dbg"},
{spdlog::level::info, "info"}, {spdlog::level::warn, "warn"},
{spdlog::level::err, "err"}, {spdlog::level::critical, "crit"},
{spdlog::level::off, "off"}};
class CustomLevelFlag : public spdlog::custom_flag_formatter {
public:
void format(const spdlog::details::log_msg &msg, const std::tm &,
spdlog::memory_buf_t &dest) override {
auto lvl = levelNames[msg.level];
auto lvlpad = std::string(padinfo_.width_ - lvl.size(), ' ') + lvl;
dest.append(lvlpad.data(), lvlpad.data() + lvlpad.size());
}
spdlog::details::padding_info get_padding_info() { return padinfo_; }
std::unique_ptr<custom_flag_formatter> clone() const override {
return spdlog::details::make_unique<CustomLevelFlag>();
}
};
Log::Log(Level lvl) : level(lvl), pattern("%H:%M:%S %^%-4t%$ %-16n %v") {
char *p = getenv("VILLAS_LOG_PREFIX");
sinks = std::make_shared<DistSink::element_type>();
setLevel(level);
setFormatter(pattern, p ? p : "");
// Default sink
sink = std::make_shared<spdlog::sinks::stderr_color_sink_mt>();
sinks->add_sink(sink);
}
int Log::getWidth() {
int width = Terminal::getCols() - 50;
if (!prefix.empty())
width -= prefix.length();
return width;
}
Logger Log::getNewLogger(const std::string &name) {
Logger logger = spdlog::get(name);
if (not logger) {
logger = std::make_shared<Logger::element_type>(name, sinks);
logger->set_level(level);
logger->set_formatter(formatter->clone());
for (auto &expr : expressions) {
int flags = 0;
#ifdef FNM_EXTMATCH
// musl-libc doesnt support this flag yet
flags |= FNM_EXTMATCH;
#endif
if (!fnmatch(expr.name.c_str(), name.c_str(), flags))
logger->set_level(expr.level);
}
spdlog::register_logger(logger);
}
return logger;
}
void Log::parse(json_t *json) {
const char *level = nullptr;
const char *path = nullptr;
const char *pattern = nullptr;
int ret, syslog = 0;
json_error_t err;
json_t *json_expressions = nullptr;
ret = json_unpack_ex(json, &err, JSON_STRICT,
"{ s?: s, s?: s, s?: o, s?: b, s?: s }", "level", &level,
"file", &path, "expressions", &json_expressions,
"syslog", &syslog, "pattern", &pattern);
if (ret)
throw ConfigError(json, err, "node-config-logging");
if (level)
setLevel(level);
if (path) {
auto sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>(path);
sinks->add_sink(sink);
}
if (syslog) {
#if SPDLOG_VERSION >= 10400
auto sink = std::make_shared<spdlog::sinks::syslog_sink_mt>(
"villas", LOG_PID, LOG_DAEMON, true);
#else
auto sink = std::make_shared<spdlog::sinks::syslog_sink_mt>(
"villas", LOG_PID, LOG_DAEMON);
#endif
sinks->add_sink(sink);
}
if (json_expressions) {
if (!json_is_array(json_expressions))
throw ConfigError(json_expressions, "node-config-logging-expressions",
"The 'expressions' setting must be a list of objects.");
size_t i;
json_t *json_expression;
// cppcheck-suppress unknownMacro
json_array_foreach(json_expressions, i, json_expression)
expressions.emplace_back(json_expression);
}
}
void Log::setFormatter(const std::string &pat, const std::string &pfx) {
pattern = pat;
prefix = pfx;
formatter = std::make_shared<spdlog::pattern_formatter>(
spdlog::pattern_time_type::utc);
formatter->add_flag<CustomLevelFlag>('t');
formatter->set_pattern(prefix + pattern);
sinks->set_formatter(formatter->clone());
}
void Log::setLevel(Level lvl) {
level = lvl;
sinks->set_level(lvl);
}
void Log::setLevel(const std::string &lvl) {
auto l = SPDLOG_LEVEL_NAMES;
auto it = std::find(l.begin(), l.end(), lvl);
if (it == l.end())
throw RuntimeError("Invalid log level {}", lvl);
setLevel(spdlog::level::from_str(lvl));
}
Log::Level Log::getLevel() const { return level; }
std::string Log::getLevelName() const {
auto sv = spdlog::level::to_string_view(level);
return std::string(sv.data());
}
Log::Expression::Expression(json_t *json) {
int ret;
const char *nme;
const char *lvl;
json_error_t err;
ret = json_unpack_ex(json, &err, JSON_STRICT, "{ s: s, s: s }", "name", &nme,
"level", &lvl);
if (ret)
throw ConfigError(json, err, "node-config-logging-expressions");
level = spdlog::level::from_str(lvl);
name = nme;
}

266
common/lib/memory.cpp Normal file
View file

@ -0,0 +1,266 @@
/* Memory managment.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <sys/mman.h>
#include <fcntl.h>
#include <unistd.h>
#include <fstream>
#include <sstream>
#include <villas/memory.hpp>
namespace villas {
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
HostRam::HostRamAllocator::allocateBlock(size_t size) {
// Align to next bigger page size chunk
if (size & size_t(0xFFF)) {
size += size_t(0x1000);
size &= size_t(~0xFFF);
}
#if defined(__linux__) && !(defined(__arm__) || defined(__aarch64__))
const int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_32BIT;
#else
const int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
#endif
const int mmap_protection = PROT_READ | PROT_WRITE;
const void *addr = mmap(nullptr, size, mmap_protection, mmap_flags, 0, 0);
if (addr == nullptr) {
throw std::bad_alloc();
}
auto &mm = MemoryManager::get();
// Assemble name for this block
std::stringstream name;
name << std::showbase << std::hex << reinterpret_cast<uintptr_t>(addr);
auto blockAddrSpaceId = mm.getProcessAddressSpaceMemoryBlock(name.str());
const auto localAddr = reinterpret_cast<uintptr_t>(addr);
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> mem(
new MemoryBlock(localAddr, size, blockAddrSpaceId), this->free);
insertMemoryBlock(*mem);
return mem;
}
LinearAllocator::LinearAllocator(
const MemoryManager::AddressSpaceId &memoryAddrSpaceId, size_t memorySize,
size_t internalOffset)
: BaseAllocator(memoryAddrSpaceId), nextFreeAddress(0),
memorySize(memorySize), internalOffset(internalOffset),
allocationCount(0) {
// Make sure to start at aligned offset, reduce size in case we need padding
if (const size_t paddingBytes = getAlignmentPadding(internalOffset)) {
assert(paddingBytes < memorySize);
internalOffset += paddingBytes;
memorySize -= paddingBytes;
}
// Deallocation callback
free = [&](MemoryBlock *mem) {
logger->debug(
"Deallocating memory block at local addr {:#x} (addr space {})",
mem->getOffset(), mem->getAddrSpaceId());
removeMemoryBlock(*mem);
allocationCount--;
if (allocationCount == 0) {
logger->debug("All allocations are deallocated now, freeing memory");
// All allocations have been deallocated, free all memory
nextFreeAddress = 0;
}
logger->debug("Available memory: {:#x} bytes", getAvailableMemory());
};
}
std::string LinearAllocator::getName() const {
std::stringstream name;
name << "LinearAlloc" << getAddrSpaceId();
if (internalOffset != 0) {
name << "@0x" << std::hex << internalOffset;
}
return name.str();
}
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
LinearAllocator::allocateBlock(size_t size) {
if (size > getAvailableMemory()) {
throw std::bad_alloc();
}
// Assign address
const uintptr_t localAddr = nextFreeAddress + internalOffset;
// Reserve memory
nextFreeAddress += size;
// Make sure it is aligned
if (const size_t paddingBytes = getAlignmentPadding(nextFreeAddress)) {
nextFreeAddress += paddingBytes;
// If next free address is outside this block due to padding, cap it
nextFreeAddress = std::min(nextFreeAddress, memorySize);
}
auto &mm = MemoryManager::get();
// Assemble name for this block
std::stringstream blockName;
blockName << std::showbase << std::hex << localAddr;
// Create address space
auto addrSpaceName = mm.getSlaveAddrSpaceName(getName(), blockName.str());
auto addrSpaceId = mm.getOrCreateAddressSpace(addrSpaceName);
logger->debug("Allocated {:#x} bytes for {}, {:#x} bytes remaining", size,
addrSpaceId, getAvailableMemory());
std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn> mem(
new MemoryBlock(localAddr, size, addrSpaceId), this->free);
// Mount block into the memory graph
insertMemoryBlock(*mem);
// Increase the allocation count
allocationCount++;
return mem;
}
HostRam::HostRamAllocator::HostRamAllocator()
: BaseAllocator(MemoryManager::get().getProcessAddressSpace()) {
free = [&](MemoryBlock *mem) {
if (::munmap(reinterpret_cast<void *>(mem->getOffset()), mem->getSize()) !=
0) {
logger->warn("munmap() failed for {:#x} of size {:#x}", mem->getOffset(),
mem->getSize());
}
removeMemoryBlock(*mem);
};
}
std::map<int, std::unique_ptr<HostDmaRam::HostDmaRamAllocator>>
HostDmaRam::allocators;
HostDmaRam::HostDmaRamAllocator::HostDmaRamAllocator(int num)
: LinearAllocator(
MemoryManager::get().getOrCreateAddressSpace(getUdmaBufName(num)),
getUdmaBufBufSize(num)),
num(num) {
auto &mm = MemoryManager::get();
logger = Log::get(getName());
if (getSize() == 0) {
logger->error(
"Zero-sized DMA buffer not supported, is the kernel module loaded?");
throw std::bad_alloc();
}
const uintptr_t base = getUdmaBufPhysAddr(num);
mm.createMapping(base, 0, getSize(), getName() + "-PCI",
mm.getPciAddressSpace(), getAddrSpaceId());
const auto bufPath = std::string("/dev/") + getUdmaBufName(num);
const int bufFd = open(bufPath.c_str(), O_RDWR | O_SYNC);
if (bufFd != -1) {
void *buf =
mmap(nullptr, getSize(), PROT_READ | PROT_WRITE, MAP_SHARED, bufFd, 0);
close(bufFd);
if (buf != MAP_FAILED)
mm.createMapping(reinterpret_cast<uintptr_t>(buf), 0, getSize(),
getName() + "-VA", mm.getProcessAddressSpace(),
getAddrSpaceId());
else
logger->warn("Cannot map {}", bufPath);
} else
logger->warn("Cannot open {}", bufPath);
logger->info("Mapped {} of size {} bytes", bufPath, getSize());
}
HostDmaRam::HostDmaRamAllocator::~HostDmaRamAllocator() {
auto &mm = MemoryManager::get();
void *baseVirt;
try {
auto translation = mm.getTranslationFromProcess(getAddrSpaceId());
baseVirt = reinterpret_cast<void *>(translation.getLocalAddr(0));
} catch (const std::out_of_range &) {
// Not mapped, nothing to do
return;
}
logger->debug("Unmapping {}", getName());
// Try to unmap it
if (::munmap(baseVirt, getSize()) != 0) {
logger->warn("munmap() failed for {:p} of size {:#x}", baseVirt, getSize());
}
}
std::string HostDmaRam::getUdmaBufName(int num) {
std::stringstream name;
name << "udmabuf" << num;
return name.str();
}
std::string HostDmaRam::getUdmaBufBasePath(int num) {
std::stringstream path;
path << "/sys/class/udmabuf/udmabuf" << num << "/";
return path.str();
}
size_t HostDmaRam::getUdmaBufBufSize(int num) {
std::fstream s(getUdmaBufBasePath(num) + "size", s.in);
if (s.is_open()) {
std::string line;
if (std::getline(s, line)) {
return std::strtoul(line.c_str(), nullptr, 10);
}
}
return 0;
}
uintptr_t HostDmaRam::getUdmaBufPhysAddr(int num) {
std::fstream s(getUdmaBufBasePath(num) + "phys_addr", s.in);
if (s.is_open()) {
std::string line;
if (std::getline(s, line)) {
return std::strtoul(line.c_str(), nullptr, 16);
}
}
return UINTPTR_MAX;
}
HostDmaRam::HostDmaRamAllocator &HostDmaRam::getAllocator(int num) {
auto &allocator = allocators[num];
if (not allocator) {
allocator = std::make_unique<HostDmaRamAllocator>(num);
}
return *allocator;
}
} // namespace villas

250
common/lib/memory_manager.cpp Normal file
View file

@ -0,0 +1,250 @@
/* Memory managment.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cstdint>
#include <limits>
#include <memory>
#include <villas/exceptions.hpp>
#include <villas/memory_manager.hpp>
#include <villas/utils.hpp>
using namespace villas;
using namespace villas::utils;
namespace villas {
MemoryManager *MemoryManager::instance = nullptr;
MemoryManager &MemoryManager::get() {
if (instance == nullptr) {
instance = new MemoryManager;
if (!instance)
throw MemoryAllocationError();
}
return *instance;
}
MemoryManager::AddressSpaceId
MemoryManager::getOrCreateAddressSpace(std::string name) {
try {
// Try fast lookup
return addrSpaceLookup.at(name);
} catch (const std::out_of_range &) {
// Does not yet exist, create
std::shared_ptr<AddressSpace> addrSpace(new AddressSpace);
addrSpace->name = name;
// Cache it for the next access
addrSpaceLookup[name] = memoryGraph.addVertex(addrSpace);
return addrSpaceLookup[name];
}
}
MemoryManager::MappingId
MemoryManager::createMapping(uintptr_t src, uintptr_t dest, size_t size,
const std::string &name,
MemoryManager::AddressSpaceId fromAddrSpace,
MemoryManager::AddressSpaceId toAddrSpace) {
std::shared_ptr<Mapping> mapping(new Mapping);
mapping->name = name;
mapping->src = src;
mapping->dest = dest;
mapping->size = size;
return addMapping(mapping, fromAddrSpace, toAddrSpace);
}
MemoryManager::MappingId
MemoryManager::addMapping(std::shared_ptr<Mapping> mapping,
MemoryManager::AddressSpaceId fromAddrSpace,
MemoryManager::AddressSpaceId toAddrSpace) {
return memoryGraph.addEdge(mapping, fromAddrSpace, toAddrSpace);
}
MemoryManager::AddressSpaceId
MemoryManager::findAddressSpace(const std::string &name) {
return memoryGraph.findVertex(
[&](const std::shared_ptr<AddressSpace> &v) { return v->name == name; });
}
std::list<MemoryManager::AddressSpaceId>
MemoryManager::findPath(const MemoryManager::AddressSpaceId &fromAddrSpaceId,
const MemoryManager::AddressSpaceId &toAddrSpaceId) {
std::list<AddressSpaceId> path;
auto fromAddrSpace = memoryGraph.getVertex(fromAddrSpaceId);
auto toAddrSpace = memoryGraph.getVertex(toAddrSpaceId);
// Find a path through the memory graph
MemoryGraph::Path pathGraph;
if (not memoryGraph.getPath(fromAddrSpaceId, toAddrSpaceId, pathGraph,
pathCheckFunc)) {
logger->debug("No translation found from ({}) to ({})",
fromAddrSpace->toString(), toAddrSpace->toString());
throw std::out_of_range("no translation found");
}
for (auto &mappingId : pathGraph) {
auto mapping = memoryGraph.getEdge(mappingId);
path.push_back(mapping->getVertexTo());
}
return path;
}
MemoryTranslation MemoryManager::getTranslation(
const MemoryManager::AddressSpaceId &fromAddrSpaceId,
const MemoryManager::AddressSpaceId &toAddrSpaceId) {
// Find a path through the memory graph
MemoryGraph::Path path;
if (not memoryGraph.getPath(fromAddrSpaceId, toAddrSpaceId, path,
pathCheckFunc)) {
auto fromAddrSpace = memoryGraph.getVertex(fromAddrSpaceId);
auto toAddrSpace = memoryGraph.getVertex(toAddrSpaceId);
logger->debug("No translation found from ({}) to ({})",
fromAddrSpace->toString(), toAddrSpace->toString());
throw std::out_of_range("no translation found");
}
// Start with an identity mapping
MemoryTranslation translation(0, 0, SIZE_MAX);
// Iterate through path and merge all mappings into a single translation
for (auto &mappingId : path) {
auto mapping = memoryGraph.getEdge(mappingId);
translation += getTranslationFromMapping(*mapping);
}
return translation;
}
bool MemoryManager::pathCheck(const MemoryGraph::Path &path) {
// Start with an identity mapping
MemoryTranslation translation(0, 0, SIZE_MAX);
// Try to add all mappings together to a common translation. If this fails
// there is a non-overlapping window.
for (auto &mappingId : path) {
auto mapping = memoryGraph.getEdge(mappingId);
try {
translation += getTranslationFromMapping(*mapping);
} catch (const InvalidTranslation &) {
return false;
}
}
return true;
}
uintptr_t
MemoryTranslation::getLocalAddr(uintptr_t addrInForeignAddrSpace) const {
assert(addrInForeignAddrSpace >= dst);
assert(addrInForeignAddrSpace < (dst + size));
return src + addrInForeignAddrSpace - dst;
}
uintptr_t
MemoryTranslation::getForeignAddr(uintptr_t addrInLocalAddrSpace) const {
assert(addrInLocalAddrSpace >= src);
assert(addrInLocalAddrSpace < (src + size));
return dst + addrInLocalAddrSpace - src;
}
MemoryTranslation &
MemoryTranslation::operator+=(const MemoryTranslation &other) {
Logger logger = Log::get("MemoryTranslation");
// Set level to debug to enable debug output
logger->set_level(spdlog::level::info);
const uintptr_t this_dst_high = this->dst + this->size;
const uintptr_t other_src_high = other.src + other.size;
logger->debug("this->src: {:#x}", this->src);
logger->debug("this->dst: {:#x}", this->dst);
logger->debug("this->size: {:#x}", this->size);
logger->debug("other.src: {:#x}", other.src);
logger->debug("other.dst: {:#x}", other.dst);
logger->debug("other.size: {:#x}", other.size);
logger->debug("this_dst_high: {:#x}", this_dst_high);
logger->debug("other_src_high: {:#x}", other_src_high);
// Make sure there is a common memory area
assertExcept(other.src < this_dst_high, MemoryManager::InvalidTranslation());
assertExcept(this->dst < other_src_high, MemoryManager::InvalidTranslation());
const uintptr_t hi = std::max(this_dst_high, other_src_high);
const uintptr_t lo = std::min(this->dst, other.src);
const uintptr_t diff_hi = (this_dst_high > other_src_high)
? (this_dst_high - other_src_high)
: (other_src_high - this_dst_high);
const bool otherSrcIsSmaller = this->dst > other.src;
const uintptr_t diff_lo =
(otherSrcIsSmaller) ? (this->dst - other.src) : (other.src - this->dst);
logger->debug("hi: {:#x}", hi);
logger->debug("lo: {:#x}", lo);
logger->debug("diff_hi: {:#x}", diff_hi);
logger->debug("diff_lo: {:#x}", diff_lo);
// New size of aperture, can only stay or shrink
this->size = (hi - lo) - diff_hi - diff_lo;
// New translation will come out other's destination (by default)
this->dst = other.dst;
// The source stays the same and can only increase with merged translations
//this->src = this->src;
if (otherSrcIsSmaller)
// Other mapping starts at lower addresses, so we actually arrive at
// higher addresses
this->dst += diff_lo;
else
// Other mapping starts at higher addresses than this, so we have to
// increase the start
// NOTE: for addresses equality, this just adds 0
this->src += diff_lo;
logger->debug("result src: {:#x}", this->src);
logger->debug("result dst: {:#x}", this->dst);
logger->debug("result size: {:#x}", this->size);
return *this;
}
void MemoryManager::printGraph() {
auto loggerStatic = logger;
loggerStatic->info("####### Vertices ########");
for (unsigned int i = 0; i < memoryGraph.getVertexCount(); i++) {
auto vertex = memoryGraph.getVertex(i);
loggerStatic->info(std::to_string(i) + ": " + vertex->name);
}
loggerStatic->info("####### Edges ########");
for (unsigned int i = 0; i < memoryGraph.getEdgeCount(); i++) {
auto mapping = memoryGraph.getEdge(i);
loggerStatic->info("From: " + std::to_string(mapping->getVertexFrom()) +
" To: " + std::to_string(mapping->getVertexTo()) +
" ID: " + mapping->toString());
}
}
} // namespace villas

32
common/lib/plugin.cpp Normal file
View file

@ -0,0 +1,32 @@
/* Loadable / plugin support.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <dlfcn.h>
#include <iostream>
#include <new>
#include <string>
#include <type_traits>
#include <villas/plugin.hpp>
using namespace villas::plugin;
Registry *villas::plugin::registry = nullptr;
Plugin::Plugin() {
if (registry == nullptr)
registry = new Registry();
registry->add(this);
}
Plugin::~Plugin() { registry->remove(this); }
void Plugin::dump() {
getLogger()->info("Name: '{}' Description: '{}'", getName(),
getDescription());
}

184
common/lib/popen.cpp Normal file
View file

@ -0,0 +1,184 @@
/* Bi-directional popen.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <dirent.h>
#include <fcntl.h>
#include <paths.h>
#include <signal.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <unistd.h>
#include <cerrno>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <iostream>
#include <fmt/core.h>
#include <villas/exceptions.hpp>
#include <villas/popen.hpp>
#include <villas/utils.hpp>
namespace villas {
namespace utils {
Popen::Popen(const std::string &cmd, const arg_list &args, const env_map &env,
const std::string &wd, bool sh)
: command(cmd), working_dir(wd), arguments(args), environment(env),
shell(sh) {
open();
}
Popen::~Popen() { close(); }
void Popen::kill(int signal) { ::kill(pid, signal); }
void Popen::open() {
std::vector<char *> argv, envp;
const int READ = 0;
const int WRITE = 1;
int ret;
int inpipe[2];
int outpipe[2];
ret = pipe(inpipe);
if (ret)
goto error_out;
ret = pipe(outpipe);
if (ret)
goto clean_inpipe_out;
fd_in = outpipe[READ];
fd_out = inpipe[WRITE];
pid = fork();
if (pid == -1)
goto clean_outpipe_out;
if (pid == 0) {
// Prepare arguments
if (shell) {
argv.push_back((char *)"sh");
argv.push_back((char *)"-c");
argv.push_back((char *)command.c_str());
} else {
for (auto arg : arguments) {
auto s = strdup(arg.c_str());
argv.push_back(s);
}
}
// Prepare environment
for (char **p = environ; *p; p++)
envp.push_back(*p);
for (auto env : environment) {
auto e = fmt::format("{}={}", env.first, env.second);
auto s = strdup(e.c_str());
envp.push_back(s);
}
argv.push_back(nullptr);
envp.push_back(nullptr);
// Redirect IO
::close(outpipe[READ]);
::close(inpipe[WRITE]);
if (inpipe[READ] != STDIN_FILENO) {
dup2(inpipe[READ], STDIN_FILENO);
::close(inpipe[READ]);
}
if (outpipe[WRITE] != STDOUT_FILENO) {
dup2(outpipe[WRITE], STDOUT_FILENO);
::close(outpipe[WRITE]);
}
// Change working directory
if (!working_dir.empty()) {
int ret;
ret = chdir(working_dir.c_str());
if (ret)
exit(127);
}
execvpe(shell ? _PATH_BSHELL : command.c_str(), (char *const *)argv.data(),
(char *const *)envp.data());
exit(127);
}
::close(outpipe[WRITE]);
::close(inpipe[READ]);
return;
clean_outpipe_out:
::close(outpipe[READ]);
::close(outpipe[WRITE]);
clean_inpipe_out:
::close(inpipe[READ]);
::close(inpipe[WRITE]);
error_out:
throw SystemError("Failed to start subprocess");
}
int Popen::close() {
int pstat;
if (pid != -1) {
do {
pid = waitpid(pid, &pstat, 0);
} while (pid == -1 && errno == EINTR);
}
return pid == -1 ? -1 : pstat;
}
PopenStream::PopenStream(const std::string &cmd, const arg_list &args,
const env_map &env, const std::string &wd, bool sh)
: Popen(cmd, args, env, wd, sh) {
open();
}
PopenStream::~PopenStream() { close(); }
void PopenStream::open() {
Popen::open();
input.buffer = std::make_unique<stdio_buf>(fd_in, std::ios_base::in);
output.buffer = std::make_unique<stdio_buf>(fd_out, std::ios_base::out);
input.stream = std::make_unique<std::istream>(input.buffer.get());
output.stream = std::make_unique<std::ostream>(output.buffer.get());
}
int PopenStream::close() {
int ret = Popen::close();
input.stream.reset();
output.stream.reset();
input.buffer.reset();
output.buffer.reset();
return ret;
}
} // namespace utils
} // namespace villas

142
common/lib/table.cpp Normal file
View file

@ -0,0 +1,142 @@
/* Print fancy tables.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cstdlib>
#include <cstring>
#include <villas/boxes.hpp>
#include <villas/colors.hpp>
#include <villas/config.hpp>
#include <villas/log.hpp>
#include <villas/table.hpp>
#include <villas/utils.hpp>
using namespace villas;
using namespace villas::utils;
#if !defined(LOG_COLOR_DISABLE)
#define ANSI_RESET "\e[0m"
#else
#define ANSI_RESET
#endif
int Table::resize(int w) {
int norm, flex, fixed, total;
width = w;
norm = 0;
flex = 0;
fixed = 0;
total = width - columns.size() * 2;
// Normalize width
for (unsigned i = 0; i < columns.size(); i++) {
if (columns[i].width > 0)
norm += columns[i].width;
if (columns[i].width == 0)
flex++;
if (columns[i].width < 0)
fixed += -1 * columns[i].width;
}
for (unsigned i = 0; i < columns.size(); i++) {
if (columns[i].width > 0)
columns[i]._width = columns[i].width * (float)(total - fixed) / norm;
if (columns[i].width == 0)
columns[i]._width = (float)(total - fixed) / flex;
if (columns[i].width < 0)
columns[i]._width = -1 * columns[i].width;
}
return 0;
}
void Table::header() {
if (width != Log::getInstance().getWidth())
resize(Log::getInstance().getWidth());
char *line1 = nullptr;
char *line2 = nullptr;
char *line3 = nullptr;
for (unsigned i = 0; i < columns.size(); i++) {
int w, u;
char *col, *unit;
col = strf(CLR_BLD("%s"), columns[i].title.c_str());
unit = columns[i].unit.size() ? strf(CLR_YEL("%s"), columns[i].unit.c_str())
: strf("");
w = columns[i]._width + strlen(col) - strlenp(col);
u = columns[i]._width + strlen(unit) - strlenp(unit);
if (columns[i].align == TableColumn::Alignment::LEFT) {
strcatf(&line1, " %-*.*s" ANSI_RESET, w, w, col);
strcatf(&line2, " %-*.*s" ANSI_RESET, u, u, unit);
} else {
strcatf(&line1, " %*.*s" ANSI_RESET, w, w, col);
strcatf(&line2, " %*.*s" ANSI_RESET, u, u, unit);
}
for (int j = 0; j < columns[i]._width + 2; j++) {
strcatf(&line3, "%s", BOX_LR);
}
if (i != columns.size() - 1) {
strcatf(&line1, " %s", BOX_UD);
strcatf(&line2, " %s", BOX_UD);
strcatf(&line3, "%s", BOX_UDLR);
}
free(col);
free(unit);
}
logger->info("{}", line1);
logger->info("{}", line2);
logger->info("{}", line3);
free(line1);
free(line2);
free(line3);
}
void Table::row(int count, ...) {
if (width != Log::getInstance().getWidth()) {
resize(Log::getInstance().getWidth());
header();
}
va_list args;
va_start(args, count);
char *line = nullptr;
for (unsigned i = 0; i < columns.size(); ++i) {
char *col = vstrf(columns[i].format.c_str(), args);
int l = strlenp(col);
int r = strlen(col);
int w = columns[i]._width + r - l;
if (columns[i].align == TableColumn::Alignment::LEFT)
strcatf(&line, " %-*.*s " ANSI_RESET, w, w, col);
else
strcatf(&line, " %*.*s " ANSI_RESET, w, w, col);
if (i != columns.size() - 1)
strcatf(&line, BOX_UD);
free(col);
}
va_end(args);
logger->info("{}", line);
free(line);
}

171
common/lib/task.cpp Normal file
View file

@ -0,0 +1,171 @@
/* Run tasks periodically.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <cerrno>
#include <ctime>
#include <unistd.h>
#include <villas/exceptions.hpp>
#include <villas/task.hpp>
#include <villas/timing.hpp>
#include <villas/utils.hpp>
using namespace villas;
#if PERIODIC_TASK_IMPL == TIMERFD
#include <sys/timerfd.h>
#endif // PERIODIC_TASK_IMPL
Task::Task(int clk) : clock(clk) {
#if PERIODIC_TASK_IMPL == TIMERFD
fd = timerfd_create(clock, 0);
if (fd < 0)
throw SystemError("Failed to create timerfd");
#elif PERIODIC_TASK_IMPL == RDTSC
int ret = tsc_init(&tsc);
if (ret)
return ret;
#endif // PERIODIC_TASK_IMPL
}
void Task::setTimeout(double to) {
struct timespec now;
clock_gettime(clock, &now);
struct timespec timeout = time_from_double(to);
struct timespec next = time_add(&now, &timeout);
setNext(&next);
}
void Task::setNext(const struct timespec *nxt) {
#if PERIODIC_TASK_IMPL != RDTSC
next = *nxt;
#if PERIODIC_TASK_IMPL == TIMERFD
int ret;
struct itimerspec its = {.it_interval = (struct timespec){0, 0},
.it_value = next};
ret = timerfd_settime(fd, TFD_TIMER_ABSTIME, &its, nullptr);
if (ret)
throw SystemError("Failed to set timerfd");
#endif // PERIODIC_TASK_IMPL == TIMERFD
#endif // PERIODIC_TASK_IMPL != RDTSC
}
void Task::setRate(double rate) {
#if PERIODIC_TASK_IMPL == RDTSC
period = tsc_rate_to_cycles(&tsc, rate);
next = tsc_now(&tsc) + period;
#else
// A rate of 0 will disarm the timer
period = rate ? time_from_double(1.0 / rate) : (struct timespec){0, 0};
#if PERIODIC_TASK_IMPL == CLOCK_NANOSLEEP || PERIODIC_TASK_IMPL == NANOSLEEP
struct timespec now, next;
clock_gettime(clock, &now);
next = time_add(&now, &period);
return setNext(&next);
#elif PERIODIC_TASK_IMPL == TIMERFD
int ret;
struct itimerspec its = {.it_interval = period, .it_value = period};
ret = timerfd_settime(fd, 0, &its, nullptr);
if (ret)
throw SystemError("Failed to set timerfd");
#endif // PERIODIC_TASK_IMPL
#endif // PERIODIC_TASK_IMPL == RDTSC
}
Task::~Task() {
#if PERIODIC_TASK_IMPL == TIMERFD
close(fd);
#endif
}
uint64_t Task::wait() {
uint64_t runs;
#if PERIODIC_TASK_IMPL == CLOCK_NANOSLEEP || PERIODIC_TASK_IMPL == NANOSLEEP
int ret;
struct timespec now;
ret = clock_gettime(clock, &now);
if (ret)
return ret;
for (runs = 0; time_cmp(&next, &now) < 0; runs++)
next = time_add(&next, &period);
#if PERIODIC_TASK_IMPL == CLOCK_NANOSLEEP
do {
ret = clock_nanosleep(clock, TIMER_ABSTIME, &next, nullptr);
} while (ret == EINTR);
#elif PERIODIC_TASK_IMPL == NANOSLEEP
struct timespec req, rem = time_diff(&now, &next);
do {
req = rem;
ret = nanosleep(&req, &rem);
} while (ret < 0 && errno == EINTR);
#endif
if (ret)
return 0;
ret = clock_gettime(clock, &now);
if (ret)
return ret;
for (; time_cmp(&next, &now) < 0; runs++)
next = time_add(&next, &period);
#elif PERIODIC_TASK_IMPL == TIMERFD
int ret;
ret = read(fd, &runs, sizeof(runs));
if (ret < 0)
return 0;
#elif PERIODIC_TASK_IMPL == RDTSC
uint64_t now;
do {
now = tsc_now(&tsc);
} while (now < next);
for (runs = 0; next < now; runs++)
next += period;
#else
#error "Invalid period task implementation"
#endif
return runs;
}
void Task::stop() {
#if PERIODIC_TASK_IMPL == TIMERFD
int ret;
struct itimerspec its = {.it_interval = (struct timespec){0, 0},
.it_value = (struct timespec){0, 0}};
ret = timerfd_settime(fd, 0, &its, nullptr);
if (ret)
throw SystemError("Failed to disarm timerfd");
#endif // PERIODIC_TASK_IMPL == TIMERFD
}
int Task::getFD() const {
#if PERIODIC_TASK_IMPL == TIMERFD
return fd;
#else
return -1;
#endif
}

70
common/lib/terminal.cpp Normal file
View file

@ -0,0 +1,70 @@
/* Terminal handling.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <unistd.h>
#include <villas/exceptions.hpp>
#include <villas/log.hpp>
#include <villas/terminal.hpp>
using namespace villas;
class Terminal *Terminal::current = nullptr;
Terminal::Terminal() {
int ret;
window.ws_row = 0;
window.ws_col = 0;
isTty = isatty(STDERR_FILENO);
Logger logger = Log::get("terminal");
if (isTty) {
struct sigaction sa_resize;
sa_resize.sa_flags = SA_SIGINFO;
sa_resize.sa_sigaction = resize;
sigemptyset(&sa_resize.sa_mask);
ret = sigaction(SIGWINCH, &sa_resize, nullptr);
if (ret)
throw SystemError("Failed to register signal handler");
// Try to get initial terminal dimensions
ret = ioctl(STDERR_FILENO, TIOCGWINSZ, &window);
if (ret)
logger->warn("Failed to get terminal dimensions");
} else {
logger->info("stderr is not associated with a terminal! Using fallback "
"values for window size...");
}
// Fallback if for some reason we can not determine a prober window size
if (window.ws_col == 0)
window.ws_col = 150;
if (window.ws_row == 0)
window.ws_row = 50;
}
void Terminal::resize(int, siginfo_t *, void *) {
if (!current)
current = new Terminal();
Logger logger = Log::get("terminal");
int ret;
ret = ioctl(STDERR_FILENO, TIOCGWINSZ, &current->window);
if (ret)
throw SystemError("Failed to get terminal dimensions");
logger->debug("New terminal size: {}x{}", current->window.ws_row,
current->window.ws_col);
};

70
common/lib/timing.cpp Normal file
View file

@ -0,0 +1,70 @@
/* Time related functions.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <unistd.h>
#include <villas/timing.hpp>
struct timespec time_now() {
struct timespec ts;
clock_gettime(CLOCK_REALTIME, &ts);
return ts;
}
struct timespec time_add(const struct timespec *start,
const struct timespec *end) {
struct timespec sum = {.tv_sec = end->tv_sec + start->tv_sec,
.tv_nsec = end->tv_nsec + start->tv_nsec};
if (sum.tv_nsec >= 1000000000) {
sum.tv_sec += 1;
sum.tv_nsec -= 1000000000;
}
return sum;
}
struct timespec time_diff(const struct timespec *start,
const struct timespec *end) {
struct timespec diff = {.tv_sec = end->tv_sec - start->tv_sec,
.tv_nsec = end->tv_nsec - start->tv_nsec};
if (diff.tv_nsec < 0) {
diff.tv_sec -= 1;
diff.tv_nsec += 1000000000;
}
return diff;
}
struct timespec time_from_double(double secs) {
struct timespec ts;
ts.tv_sec = secs;
ts.tv_nsec = 1.0e9 * (secs - ts.tv_sec);
return ts;
}
double time_to_double(const struct timespec *ts) {
return ts->tv_sec + ts->tv_nsec * 1e-9;
}
double time_delta(const struct timespec *start, const struct timespec *end) {
struct timespec diff = time_diff(start, end);
return time_to_double(&diff);
}
ssize_t time_cmp(const struct timespec *a, const struct timespec *b) {
ssize_t sd = a->tv_sec - b->tv_sec;
ssize_t nsd = a->tv_nsec - b->tv_nsec;
return sd != 0 ? sd : nsd;
}

67
common/lib/tool.cpp Normal file
View file

@ -0,0 +1,67 @@
/* Common entry point for all villas command line tools.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <iostream>
#include <villas/tool.hpp>
using namespace villas;
void Tool::staticHandler(int signal, siginfo_t *sinfo, void *ctx) {
if (current_tool)
current_tool->handler(signal, sinfo, ctx);
}
void Tool::printCopyright() {
std::cout << PROJECT_NAME " " << CLR_BLU(PROJECT_BUILD_ID)
<< " (built on " CLR_MAG(__DATE__) " " CLR_MAG(__TIME__) ")"
<< std::endl
<< " Copyright 2014-2021, Institute for Automation of Complex "
"Power Systems, RWTH Aachen University"
<< std::endl
<< " Steffen Vogel <post@steffenvogel.de>" << std::endl;
}
void Tool::printVersion() { std::cout << PROJECT_BUILD_ID << std::endl; }
Tool::Tool(int ac, char *av[], const std::string &nme,
const std::list<int> &sigs)
: argc(ac), argv(av), name(nme), handlerSignals(sigs) {
current_tool = this;
logger = Log::get(name);
}
int Tool::run() {
try {
int ret;
logger->info("This is VILLASnode {} (built on {}, {})",
CLR_BLD(CLR_YEL(PROJECT_BUILD_ID)), CLR_BLD(CLR_MAG(__DATE__)),
CLR_BLD(CLR_MAG(__TIME__)));
ret = utils::signalsInit(staticHandler, handlerSignals);
if (ret)
throw RuntimeError("Failed to initialize signal subsystem");
// Parse command line arguments
parse();
// Run tool
ret = main();
logger->info(CLR_GRN("Goodbye!"));
return ret;
} catch (const std::runtime_error &e) {
logger->error("{}", e.what());
return -1;
}
}
Tool *Tool::current_tool = nullptr;

48
common/lib/tsc.cpp Normal file
View file

@ -0,0 +1,48 @@
/* Measure time and sleep with IA-32 time-stamp counter.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <villas/tsc.hpp>
using namespace villas;
int tsc_init(struct Tsc *t) {
uint32_t eax = 0, ebx = 0, ecx = 0, edx = 0;
// Check if TSC is supported
__get_cpuid(0x1, &eax, &ebx, &ecx, &edx);
if (!(edx & bit_TSC))
return -2;
// Check if RDTSCP instruction is supported
__get_cpuid(0x80000001, &eax, &ebx, &ecx, &edx);
t->rdtscp_supported = edx & bit_RDTSCP;
// Check if TSC is invariant
__get_cpuid(0x80000007, &eax, &ebx, &ecx, &edx);
t->is_invariant = edx & bit_TSC_INVARIANT;
// Intel SDM Vol 3, Section 18.7.3:
// Nominal TSC frequency = CPUID.15H.ECX[31:0] * CPUID.15H.EBX[31:0] ) ÷ CPUID.15H.EAX[31:0]
__get_cpuid(0x15, &eax, &ebx, &ecx, &edx);
if (ecx != 0)
t->frequency = ecx * ebx / eax;
else {
int ret;
#ifdef __linux__
ret = kernel::get_cpu_frequency(&t->frequency);
if (ret)
return ret;
#endif
}
return 0;
}
uint64_t tsc_rate_to_cycles(struct Tsc *t, double rate) {
return t->frequency / rate;
}

355
common/lib/utils.cpp Normal file
View file

@ -0,0 +1,355 @@
/* Utilities.
*
* Author: Daniel Krebs <github@daniel-krebs.net>
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <iostream>
#include <string>
#include <vector>
#include <cctype>
#include <cmath>
#include <cstdarg>
#include <cstdint>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <fcntl.h>
#include <pthread.h>
#include <unistd.h>
#include <jansson.h>
#include <openssl/bio.h>
#include <openssl/buffer.h>
#include <openssl/evp.h>
#include <villas/colors.hpp>
#include <villas/config.hpp>
#include <villas/exceptions.hpp>
#include <villas/log.hpp>
#include <villas/utils.hpp>
static pthread_t main_thread;
namespace villas {
namespace utils {
std::vector<std::string> tokenize(std::string s, const std::string &delimiter) {
std::vector<std::string> tokens;
size_t lastPos = 0;
size_t curentPos;
while ((curentPos = s.find(delimiter, lastPos)) != std::string::npos) {
const size_t tokenLength = curentPos - lastPos;
tokens.push_back(s.substr(lastPos, tokenLength));
// Advance in string
lastPos = curentPos + delimiter.length();
}
// Check if there's a last token behind the last delimiter.
if (lastPos != s.length()) {
const size_t lastTokenLength = s.length() - lastPos;
tokens.push_back(s.substr(lastPos, lastTokenLength));
}
return tokens;
}
ssize_t readRandom(char *buf, size_t len) {
int fd;
ssize_t bytes = -1;
fd = open("/dev/urandom", O_RDONLY);
if (fd < 0)
return -1;
while (len) {
bytes = read(fd, buf, len);
if (bytes < 0)
break;
len -= bytes;
buf += bytes;
}
close(fd);
return bytes;
}
// Setup exit handler
int signalsInit(void (*cb)(int signal, siginfo_t *sinfo, void *ctx),
std::list<int> cbSignals, std::list<int> ignoreSignals) {
int ret;
Logger logger = Log::get("signals");
logger->info("Initialize subsystem");
struct sigaction sa_cb;
sa_cb.sa_flags = SA_SIGINFO | SA_NODEFER;
sa_cb.sa_sigaction = cb;
struct sigaction sa_ign;
sa_ign.sa_flags = 0;
sa_ign.sa_handler = SIG_IGN;
main_thread = pthread_self();
sigemptyset(&sa_cb.sa_mask);
sigemptyset(&sa_ign.sa_mask);
cbSignals.insert(cbSignals.begin(),
{SIGINT, SIGTERM, SIGUSR1, SIGUSR2, SIGALRM});
cbSignals.sort();
cbSignals.unique();
for (auto signal : cbSignals) {
ret = sigaction(signal, &sa_cb, nullptr);
if (ret)
return ret;
}
for (auto signal : ignoreSignals) {
ret = sigaction(signal, &sa_ign, nullptr);
if (ret)
return ret;
}
return 0;
}
char *decolor(char *str) {
char *p, *q;
bool inseq = false;
for (p = q = str; *p; p++) {
switch (*p) {
case 0x1b:
if (*(++p) == '[') {
inseq = true;
continue;
}
break;
case 'm':
if (inseq) {
inseq = false;
continue;
}
break;
}
if (!inseq) {
*q = *p;
q++;
}
}
*q = '\0';
return str;
}
void killme(int sig) {
// Send only to main thread in case the ID was initilized by signalsInit()
if (main_thread)
pthread_kill(main_thread, sig);
else
kill(0, sig);
}
double boxMuller(float m, float s) {
double x1, x2, y1;
static double y2;
static int use_last = 0;
if (use_last) { // Use value from previous call
y1 = y2;
use_last = 0;
} else {
double w;
do {
x1 = 2.0 * randf() - 1.0;
x2 = 2.0 * randf() - 1.0;
w = x1 * x1 + x2 * x2;
} while (w >= 1.0);
w = sqrt(-2.0 * log(w) / w);
y1 = x1 * w;
y2 = x2 * w;
use_last = 1;
}
return m + y1 * s;
}
double randf() { return (double)random() / RAND_MAX; }
char *vstrcatf(char **dest, const char *fmt, va_list ap) {
char *tmp;
int n = *dest ? strlen(*dest) : 0;
int i = vasprintf(&tmp, fmt, ap);
*dest = (char *)(realloc(*dest, n + i + 1));
if (*dest != nullptr)
strncpy(*dest + n, tmp, i + 1);
free(tmp);
return *dest;
}
char *strcatf(char **dest, const char *fmt, ...) {
va_list ap;
va_start(ap, fmt);
vstrcatf(dest, fmt, ap);
va_end(ap);
return *dest;
}
char *strf(const char *fmt, ...) {
char *buf = nullptr;
va_list ap;
va_start(ap, fmt);
vstrcatf(&buf, fmt, ap);
va_end(ap);
return buf;
}
char *vstrf(const char *fmt, va_list va) {
char *buf = nullptr;
vstrcatf(&buf, fmt, va);
return buf;
}
void *memdup(const void *src, size_t bytes) {
void *dst = new char[bytes];
if (!dst)
throw MemoryAllocationError();
memcpy(dst, src, bytes);
return dst;
}
pid_t spawn(const char *name, char *const argv[]) {
pid_t pid;
pid = fork();
switch (pid) {
case -1:
return -1;
case 0:
return execvp(name, (char *const *)argv);
}
return pid;
}
size_t strlenp(const char *str) {
size_t sz = 0;
for (const char *d = str; *d; d++) {
const unsigned char *c = (const unsigned char *)d;
if (isprint(*c))
sz++;
else if (c[0] == '\b')
sz--;
else if (c[0] == '\t')
sz += 4; // Tab width == 4
// CSI sequence
else if (c[0] == '\e' && c[1] == '[') {
c += 2;
while (*c && *c != 'm')
c++;
}
// UTF-8
else if (c[0] >= 0xc2 && c[0] <= 0xdf) {
sz++;
c += 1;
} else if (c[0] >= 0xe0 && c[0] <= 0xef) {
sz++;
c += 2;
} else if (c[0] >= 0xf0 && c[0] <= 0xf4) {
sz++;
c += 3;
}
d = (const char *)c;
}
return sz;
}
int log2i(long long x) {
if (x == 0)
return 1;
return sizeof(x) * 8 - __builtin_clzll(x) - 1;
}
int sha1sum(FILE *f, unsigned char *sha1) {
int ret;
char buf[512];
ssize_t bytes;
long seek;
seek = ftell(f);
fseek(f, 0, SEEK_SET);
EVP_MD_CTX *c = EVP_MD_CTX_new();
ret = EVP_DigestInit(c, EVP_sha1());
if (!ret)
return -1;
bytes = fread(buf, 1, 512, f);
while (bytes > 0) {
EVP_DigestUpdate(c, buf, bytes);
bytes = fread(buf, 1, 512, f);
}
EVP_DigestFinal(c, sha1, nullptr);
fseek(f, seek, SEEK_SET);
EVP_MD_CTX_free(c);
return 0;
}
bool isDocker() { return access("/.dockerenv", F_OK) != -1; }
bool isKubernetes() {
return access("/var/run/secrets/kubernetes.io", F_OK) != -1 ||
getenv("KUBERNETES_SERVICE_HOST") != nullptr;
}
bool isContainer() { return isDocker() || isKubernetes(); }
bool isPrivileged() {
// TODO: a cleaner way would be to use libcap here and check for the
// SYS_ADMIN capability.
auto *f = fopen(PROCFS_PATH "/sys/vm/nr_hugepages", "w");
if (!f)
return false;
fclose(f);
return true;
}
} // namespace utils
} // namespace villas

84
common/lib/uuid.cpp Normal file
View file

@ -0,0 +1,84 @@
/* UUID helpers.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <openssl/evp.h>
#include <villas/uuid.hpp>
using namespace villas::uuid;
std::string villas::uuid::toString(const uuid_t in) {
uuid_string_t str;
uuid_unparse_lower(in, str);
return str;
}
int villas::uuid::generateFromString(uuid_t out, const std::string &data,
const std::string &ns) {
int ret;
EVP_MD_CTX *c = EVP_MD_CTX_new();
ret = EVP_DigestInit(c, EVP_md5());
if (!ret)
return -1;
// Namespace
ret = EVP_DigestUpdate(c, (unsigned char *)ns.c_str(), ns.size());
if (!ret)
return -1;
// Data
ret = EVP_DigestUpdate(c, (unsigned char *)data.c_str(), data.size());
if (!ret)
return -1;
ret = EVP_DigestFinal(c, (unsigned char *)out, nullptr);
if (!ret)
return -1;
EVP_MD_CTX_free(c);
return 0;
}
int villas::uuid::generateFromString(uuid_t out, const std::string &data,
const uuid_t ns) {
int ret;
EVP_MD_CTX *c = EVP_MD_CTX_new();
ret = EVP_DigestInit(c, EVP_md5());
if (!ret)
return -1;
// Namespace
ret = EVP_DigestUpdate(c, (unsigned char *)ns, 16);
if (!ret)
return -1;
// Data
ret = EVP_DigestUpdate(c, (unsigned char *)data.c_str(), data.size());
if (!ret)
return -1;
ret = EVP_DigestFinal(c, (unsigned char *)out, nullptr);
if (!ret)
return -1;
EVP_MD_CTX_free(c);
return 0;
}
int villas::uuid::generateFromJson(uuid_t out, json_t *json, const uuid_t ns) {
char *str = json_dumps(json, JSON_COMPACT | JSON_SORT_KEYS);
int ret = generateFromString(out, str, ns);
free(str);
return ret;
}

48
common/lib/version.cpp Normal file
View file

@ -0,0 +1,48 @@
/* Version.
*
* Author: Steffen Vogel <post@steffenvogel.de>
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
* SPDX-License-Identifier: Apache-2.0
*/
#include <stdexcept>
#include <string>
#include <villas/log.hpp>
#include <villas/utils.hpp>
#include <villas/version.hpp>
using namespace villas::utils;
Version::Version(const std::string &str) {
size_t endpos;
auto comp = tokenize(str, ".");
if (comp.size() > 3)
throw std::invalid_argument("Not a valid version string");
for (unsigned i = 0; i < 3; i++) {
if (i < comp.size()) {
components[i] = std::stoi(comp[i], &endpos, 10);
if (comp[i].begin() + endpos != comp[i].end())
throw std::invalid_argument("Not a valid version string");
} else
components[i] = 0;
}
}
Version::Version(int maj, int min, int pat) : components{maj, min, pat} {}
int Version::cmp(const Version &lhs, const Version &rhs) {
int d;
for (int i = 0; i < 3; i++) {
d = lhs.components[i] - rhs.components[i];
if (d)
return d;
}
return 0;
}

Some files were not shown because too many files have changed in this diff Show more