initial osmocom boilerplate source tree

Related: SYS#5599 Depends: I0a46b147ec6a76d909df28136cfd2b764b2c75ea (libosmocore) Change-Id: I4352dd8738a1a9de6ba2fc250ee8eef69c65ff1e
2025-11-02 13:03:35 +00:00 · 2021-11-23 14:18:44 +01:00
parent 275e4cd2ac
commit 103b69d99c
43 changed files with 1567 additions and 0 deletions
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -0,0 +1,4 @@
+SUBDIRS = \
+	examples \
+	manuals \
+	$(NULL)
--- a/doc/examples/Makefile.am
+++ b/doc/examples/Makefile.am
@@ -0,0 +1,30 @@
+OSMOCONF_FILES = \
+	osmo-upf/osmo-upf.cfg
+
+osmoconfdir = $(sysconfdir)/osmocom
+osmoconf_DATA = $(OSMOCONF_FILES)
+
+EXTRA_DIST = $(OSMOCONF_FILES)
+
+CFG_FILES = find $(srcdir) -name '*.cfg*' | sed -e 's,^$(srcdir),,'
+
+dist-hook:
+	for f in $$($(CFG_FILES)); do \
+	        j="$(distdir)/$$f" && \
+	        mkdir -p "$$(dirname $$j)" && \
+	        $(INSTALL_DATA) $(srcdir)/$$f $$j; \
+	done
+
+install-data-hook:
+	for f in $$($(CFG_FILES)); do \
+	        j="$(DESTDIR)$(docdir)/examples/$$f" && \
+	        mkdir -p "$$(dirname $$j)" && \
+	        $(INSTALL_DATA) $(srcdir)/$$f $$j; \
+	done
+
+uninstall-hook:
+	@$(PRE_UNINSTALL)
+	for f in $$($(CFG_FILES)); do \
+	        j="$(DESTDIR)$(docdir)/examples/$$f" && \
+	        $(RM) $$j; \
+	done
--- a/doc/examples/osmo-upf/osmo-upf.cfg
+++ b/doc/examples/osmo-upf/osmo-upf.cfg
@@ -0,0 +1,9 @@
+log stderr
+ logging filter all 1
+ logging color 1
+ logging print level 1
+ logging print category 1
+ logging print category-hex 0
+ logging print file basename last
+ logging print extended-timestamp 1
+ logging level set-all notice
--- a/doc/manuals/Makefile.am
+++ b/doc/manuals/Makefile.am
@@ -0,0 +1,25 @@
+EXTRA_DIST = \
+    osmoupf-usermanual.adoc \
+    osmoupf-usermanual-docinfo.xml \
+    osmoupf-vty-reference.xml \
+    chapters \
+    regen_doc.sh \
+    vty
+
+if BUILD_MANUALS
+  ASCIIDOC = osmoupf-usermanual.adoc
+  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
+  osmoupf-usermanual.pdf: $(srcdir)/chapters/*.adoc
+
+  VTY_REFERENCE = osmoupf-vty-reference.xml
+
+  BUILT_REFERENCE_XML = $(builddir)/vty/upf_vty_reference.xml
+  $(builddir)/vty/upf_vty_reference.xml: $(top_builddir)/src/osmo-upf/osmo-upf
+	mkdir -p $(builddir)/vty
+	$(top_builddir)/src/osmo-upf/osmo-upf --vty-ref-xml > $@
+
+  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
+
+  OSMO_REPOSITORY = osmo-upf
+  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
+endif
--- a/doc/manuals/chapters/overview.adoc
+++ b/doc/manuals/chapters/overview.adoc
@@ -0,0 +1,24 @@
+OsmoUPF
+
+[[overview]]
+== Overview
+
+This manual should help you getting started with OsmoUPF. It will cover
+aspects of configuring and running OsmoUPF.
+
+[[intro_overview]]
+=== About OsmoUPF
+
+OsmoUPF is the Osmocom implementation of a User Plane Function for 2G, 3G, 4G
+and 5G mobile network packet switched user data management. It implements:
+
+- A Packet Forwarding Control Protocol (PFCP) entity to manage the GTP user
+  plane of mobile subscribers.
+- GTP forwarding as well as encapsulation/decapsulation of user traffic, using
+  the Linux mainline kernel GTP module.
+
+The aim is to provide:
+
+- 1000 modifications of tunnel state per second (add/remove/modify),
+- 4-8 Gbps throughput,
+- 100-125k concurrent GTP tunnels.
--- a/doc/manuals/osmoupf-usermanual-docinfo.xml
+++ b/doc/manuals/osmoupf-usermanual-docinfo.xml
@@ -0,0 +1,47 @@
+<revhistory>
+  <revision>
+    <revnumber>1</revnumber>
+    <date>December 2021</date>
+    <authorinitials>NJH</authorinitials>
+    <revremark>
+      Initial OsmoUPF manual
+    </revremark>
+  </revision>
+</revhistory>
+
+<authorgroup>
+  <author>
+    <firstname>Neels Janosch</firstname>
+    <surname>Hofmeyr</surname>
+    <email>nhofmeyr@sysmocom.de</email>
+    <authorinitials>NJH</authorinitials>
+    <affiliation>
+      <shortaffil>sysmocom</shortaffil>
+      <orgname>sysmocom - s.f.m.c. GmbH</orgname>
+      <jobtitle>Software Developer</jobtitle>
+    </affiliation>
+  </author>
+</authorgroup>
+
+<copyright>
+  <year>2021-2022</year>
+  <holder>sysmocom - s.f.m.c. GmbH</holder>
+</copyright>
+
+<legalnotice>
+  <para>
+	Permission is granted to copy, distribute and/or modify this
+	document under the terms of the GNU Free Documentation License,
+	Version 1.3 or any later version published by the Free Software
+	Foundation; with the Invariant Sections being just 'Foreword',
+	'Acknowledgements' and 'Preface', with no Front-Cover Texts,
+	and no Back-Cover Texts.  A copy of the license is included in
+	the section entitled "GNU Free Documentation License".
+  </para>
+  <para>
+	The Asciidoc source code of this manual can be found at
+	<ulink url="http://git.osmocom.org/osmo-gsm-manuals/">
+		http://git.osmocom.org/osmo-gsm-manuals/
+	</ulink>
+  </para>
+</legalnotice>
--- a/doc/manuals/osmoupf-usermanual.adoc
+++ b/doc/manuals/osmoupf-usermanual.adoc
@@ -0,0 +1,28 @@
+:gfdl-enabled:
+:program-name: OsmoUPF
+
+OsmoUPF User Manual
+===================
+Neels Janosch Hofmeyr <nhofmeyr@sysmocom.de>
+
+include::./common/chapters/preface.adoc[]
+
+include::{srcdir}/chapters/overview.adoc[]
+
+include::./common/chapters/vty.adoc[]
+
+include::./common/chapters/logging.adoc[]
+
+include::./common/chapters/counters-overview.adoc[]
+
+include::./common/chapters/control_if.adoc[]
+
+include::./common/chapters/vty_cpu_sched.adoc[]
+
+include::./common/chapters/port_numbers.adoc[]
+
+include::./common/chapters/bibliography.adoc[]
+
+include::./common/chapters/glossary.adoc[]
+
+include::./common/chapters/gfdl.adoc[]
--- a/doc/manuals/osmoupf-vty-reference.xml
+++ b/doc/manuals/osmoupf-vty-reference.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ex:ts=2:sw=42sts=2:et
+  -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
+-->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"
+"http://docbook.org/xml/5.0/dtd/docbook.dtd" [
+<!ENTITY chapter-vty      SYSTEM      "./common/chapters/vty.xml" >
+<!ENTITY sections-vty     SYSTEM      "generated/docbook_vty.xml"  >
+]>
+
+<book>
+  <info>
+    <revhistory>
+        <revision>
+            <revnumber>v1</revnumber>
+            <date>30th November 2021</date>
+            <authorinitials>NJH</authorinitials>
+            <revremark>Initial</revremark>
+        </revision>
+    </revhistory>
+
+    <title>OsmoUPF VTY Reference</title>
+
+    <copyright>
+      <year>2021-2022</year>
+    </copyright>
+
+    <legalnotice>
+      <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved.
+      </para>
+    </legalnotice>
+  </info>
+
+  <!-- Main chapters-->
+  &chapter-vty;
+</book>
--- a/doc/manuals/regen_doc.sh
+++ b/doc/manuals/regen_doc.sh
@@ -0,0 +1,17 @@
+#!/bin/sh -x
+
+if [ -z "$DOCKER_PLAYGROUND" ]; then
+	echo "You need to set DOCKER_PLAYGROUND"
+	exit 1
+fi
+
+SCRIPT=$(realpath "$0")
+MANUAL_DIR=$(dirname "$SCRIPT")
+
+COMMIT=${COMMIT:-$(git log -1 --format=format:%H)}
+
+cd "$DOCKER_PLAYGROUND/scripts" || exit 1
+
+OSMO_UPF_BRANCH=$COMMIT ./regen_doc.sh osmo-upf 4273 \
+	"$MANUAL_DIR/chapters/counters_generated.adoc" \
+	"$MANUAL_DIR/vty/upf_vty_reference.xml"
--- a/doc/manuals/vty/upf_vty_additions.xml
+++ b/doc/manuals/vty/upf_vty_additions.xml
@@ -0,0 +1,2 @@
+<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
+</vtydoc>