Bump version: 1.8.0.1-535e → 1.8.1

Change-Id: Ib92e6ca89e1406d3707a94063975fe338cf67a9e

.gitignore

@@ -16,6 +16,7 @@ src/osmo-mgw/osmo-mgw
 *.gcda
 *.gcno
 *.pc
+*~
 
 #configure
 aclocal.m4

TODO-RELEASE

@@ -24,5 +24,3 @@
 # If any interfaces have been removed or changed since the last public release, a=0.
 #
 #library		what		description / commit summary line
-osmo-mgw        update osmo-gsm-manuals dependency to > 0.3.0 for vty_cpu_sched.adoc include
-libosmo-mgcp-client     mgcp_response, mgcp_conn_peer   struct size change, breaks ABI

configure.ac

@@ -9,6 +9,8 @@ AC_CONFIG_AUX_DIR([.])
 AM_INIT_AUTOMAKE([dist-bzip2])
 AC_CONFIG_TESTDIR(tests)
 
+CFLAGS="$CFLAGS -std=gnu11"
+
 dnl kernel style compile messages
 m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
 
@@ -47,13 +49,13 @@ AC_SEARCH_LIBS([dlsym], [dl dld], [LIBRARY_DLSYM="$LIBS";LIBS=""])
 AC_SUBST(LIBRARY_DLSYM)
 
 
-PKG_CHECK_MODULES(LIBOSMOCORE, libosmocore >= 1.4.0)
-PKG_CHECK_MODULES(LIBOSMOGSM, libosmogsm >= 1.4.0)
-PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 1.4.0)
-PKG_CHECK_MODULES(LIBOSMOVTY, libosmovty >= 1.4.0)
-PKG_CHECK_MODULES(LIBOSMONETIF, libosmo-netif >= 0.6.0)
-PKG_CHECK_MODULES(LIBOSMOABIS, libosmoabis >= 1.0.0)
-PKG_CHECK_MODULES(LIBOSMOTRAU, libosmotrau >= 1.0.0)
+PKG_CHECK_MODULES(LIBOSMOCORE, libosmocore >= 1.5.0)
+PKG_CHECK_MODULES(LIBOSMOGSM, libosmogsm >= 1.5.0)
+PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 1.5.0)
+PKG_CHECK_MODULES(LIBOSMOVTY, libosmovty >= 1.5.0)
+PKG_CHECK_MODULES(LIBOSMONETIF, libosmo-netif >= 1.1.0)
+PKG_CHECK_MODULES(LIBOSMOABIS, libosmoabis >= 1.1.0)
+PKG_CHECK_MODULES(LIBOSMOTRAU, libosmotrau >= 1.1.0)
 
 AC_ARG_ENABLE(sanitize,
 	[AS_HELP_STRING(

contrib/jenkins.sh

@@ -36,7 +36,6 @@ osmo-build-dep.sh libosmo-netif
 # Additional configure options and depends
 CONFIG=""
 if [ "$WITH_MANUALS" = "1" ]; then
-	osmo-build-dep.sh osmo-gsm-manuals
 	CONFIG="--enable-manuals"
 fi
 
@@ -56,12 +55,12 @@ LD_LIBRARY_PATH="$inst/lib" $MAKE check \
   || cat-testlogs.sh
 LD_LIBRARY_PATH="$inst/lib" \
   DISTCHECK_CONFIGURE_FLAGS="--enable-vty-tests --enable-external-tests $CONFIG" \
-  $MAKE distcheck \
+  $MAKE $PARALLEL_MAKE distcheck \
   || cat-testlogs.sh
 
 if [ "$WITH_MANUALS" = "1" ] && [ "$PUBLISH" = "1" ]; then
 	make -C "$base/doc/manuals" publish
 fi
 
-$MAKE maintainer-clean
+$MAKE $PARALLEL_MAKE maintainer-clean
 osmo-clean-workspace.sh

contrib/osmo-mgw.spec.in

@@ -29,30 +29,30 @@ BuildRequires:  pkgconfig >= 0.20
 %if 0%{?suse_version}
 BuildRequires:  systemd-rpm-macros
 %endif
-BuildRequires:  pkgconfig(libosmo-netif) >= 0.6.0
-BuildRequires:  pkgconfig(libosmocore) >= 1.0.0
-BuildRequires:  pkgconfig(libosmoctrl) >= 1.1.0
-BuildRequires:  pkgconfig(libosmogsm) >= 1.0.0
-BuildRequires:  pkgconfig(libosmovty) >= 1.0.0
-BuildRequires:  pkgconfig(libosmocoding) >= 1.0.0
-BuildRequires:  pkgconfig(libosmoabis) >= 1.0.0
-BuildRequires:  pkgconfig(libosmotrau) >= 1.0.0
+BuildRequires:  pkgconfig(libosmo-netif) >= 1.1.0
+BuildRequires:  pkgconfig(libosmocore) >= 1.5.0
+BuildRequires:  pkgconfig(libosmoctrl) >= 1.5.0
+BuildRequires:  pkgconfig(libosmogsm) >= 1.5.0
+BuildRequires:  pkgconfig(libosmovty) >= 1.5.0
+BuildRequires:  pkgconfig(libosmocoding) >= 1.5.0
+BuildRequires:  pkgconfig(libosmoabis) >= 1.1.0
+BuildRequires:  pkgconfig(libosmotrau) >= 1.1.0
 %{?systemd_requires}
 
 %description
 OsmoMGW is Osmocom's Media Gateway for 2G and 3G circuit-switched mobile networks.
 
-%package -n libosmo-mgcp-client6
+%package -n libosmo-mgcp-client8
 Summary:        Osmocom's Media Gateway Control Protocol client library
 Group:          System/Libraries
 
-%description -n libosmo-mgcp-client6
+%description -n libosmo-mgcp-client8
 Osmocom's Media Gateway Control Protocol client library.
 
 %package -n libosmo-mgcp-client-devel
 Summary:        Development files for Osmocom's Media Gateway Control Protocol client library
 Group:          Development/Libraries/C and C++
-Requires:       libosmo-mgcp-client6 = %{version}
+Requires:       libosmo-mgcp-client8 = %{version}
 
 %description -n libosmo-mgcp-client-devel
 Osmocom's Media Gateway Control Protocol client librarary.
@@ -90,8 +90,8 @@ find %{buildroot} -type f -name "*.la" -delete -print
 %check
 make %{?_smp_mflags} check || (find . -name testsuite.log -exec cat {} +)
 
-%post   -n libosmo-mgcp-client6 -p /sbin/ldconfig
-%postun -n libosmo-mgcp-client6 -p /sbin/ldconfig
+%post   -n libosmo-mgcp-client8 -p /sbin/ldconfig
+%postun -n libosmo-mgcp-client8 -p /sbin/ldconfig
 
 %if 0%{?suse_version}
 %preun
@@ -119,8 +119,8 @@ make %{?_smp_mflags} check || (find . -name testsuite.log -exec cat {} +)
 %dir %{_sysconfdir}/osmocom
 %config(noreplace) %{_sysconfdir}/osmocom/osmo-mgw.cfg
 
-%files -n libosmo-mgcp-client6
-%{_libdir}/libosmo-mgcp-client.so.6*
+%files -n libosmo-mgcp-client8
+%{_libdir}/libosmo-mgcp-client.so.8*
 
 %files -n libosmo-mgcp-client-devel
 %{_libdir}/libosmo-mgcp-client.so

debian/changelog

@@ -1,3 +1,169 @@
+osmo-mgw (1.8.1) unstable; urgency=medium
+
+  * attempt to fix RPM spec file after recent soversion bump
+
+ -- Harald Welte <laforge@osmocom.org>  Wed, 24 Feb 2021 10:56:17 +0100
+
+osmo-mgw (1.8.0) unstable; urgency=medium
+
+  [ Harald Welte ]
+  * Fix number of endpoints of default trunk
+  * Add CTRL interface to osmo-mgw
+  * Update per-trunk global packet/byte counters in real-time
+  * remove accidential TODO-RELEASE entry
+  * mgcp_protocol: Avoid code duplication between virtual + other trunks
+  * osmo-mgw.spec.in: Use %config(noreplace) to retain current config file
+  * mgcp_client_init(): consider "talloc returns NULL" case
+  * mgcp_client_pending_add(): Consider "talloc returns NULL" case
+  * libosmo-mgcp-client: fix memleak in case if no response is received
+  * debian/control + SPEC: Add missing build dependency to libosmo-abis
+  * osmo-mgw.spec.in: Fix dependency to libosmoabis
+  * osmo-mgw.spec.in: Add missing dependency to libosmotrau
+  * Add example osmo-mgw configuration file for Abis/E1
+  * use osmo_fd_setup() whenever applicable
+
+  [ Neels Hofmeyr ]
+  * fix vty dump_trunk: start from zero, do not omit first CONN
+  * allow larger MGCP client wqueue: 10 -> 1024
+  * add osmo-mgw --vty-ref-xml: dump VTY ref XML to stdout
+  * manuals: generate vty reference xml at build time
+  * refactor: use msgb to receive, pass and send RTP packets
+  * change timer T2427001 to X2427
+
+  [ Philipp Maier ]
+  * doc: do not bind osmo-mgw to random ip-address
+  * cosmetic: remove excess newlines
+  * mgcp: remove unused callback pointer
+  * mgcp: find better locations for LOGPCONN and LOGPENDP
+  * vty: fix unreachable code (error msg on trunk alloc fail)
+  * mgcp_vty: fix indentation
+  * osmo-mgw: rename struct mgcp_trunk_config and symbol tcfg
+  * mgcp_vty: fix indentation in VTY config write
+  * osmo-mgw: refactor endpoint and trunk handling
+  * mgcp_trunk: remove audio_name and audio_payload
+  * ratectr: move rate counter definitions into mgcp_ratectr.h
+  * cosmetic: fix doxygen
+  * cosmetic: fix doxygen
+  * cosmetic: fix doxygen for mgcp_cleanup_rtp_bridge_cb()
+  * trunk: get rid of virt_trunk pointer
+  * cosmetic: remove excess space
+  * endp: move endpoint name generation into mgcp_endp.c
+  * endp: add name generator function for E1 endpoints
+  * mgcp_client: add docstring for mgcp_client_rtpbridge_wildcard()
+  * mgcp_trunk: fix docstring for mgcp_trunk_alloc()
+  * mgcp_osmux: remove unused define constants
+  * mgcp_trunk: move enum mgcp_trunk_type to mgcp_trunk.h
+  * mgcp_trunk: use enum type for trunk type variable
+  * trunk: parse E1 trunk number
+  * endp: add typeset for e1-endpoints
+  * mgcp_conn: move struct mgcp_conn mgcp_conn.h
+  * mgcp_internal: remove forward declaration struct mgcp_endpoint_type
+  * endp: add E1 endpoint interlocking
+  * endp: require domain name also for E1 endpoints
+  * mgcp_trunk: pick trunk by number and type
+  * mgcp_client: add function to generate e1-endpoint names
+  * mgcp_endp: use define constant to define max number of E1 subslots
+  * mgcp_endp.c: cosmetic: fix sourcecode formatting
+  * mgcp_trunk: remove double check
+  * mgcp_test: do not access endpoint array elements directly
+  * mgcp_vty: fix endpoint number configuration
+  * mgcp_test: remove trunk2 from unit-test
+  * mgcp_trunk: use talloc_zero_array instead of _talloc_zero_array
+  * mgcp_protocol: remove unused variable
+  * mgcp_e1: finish E1 support, add E1 support from libosmoabis
+  * get rid of mgcp_internal.h
+  * mgcp_ratectr: fix comments in header file
+  * mgcp_e1: use return value of e1inp_line_update()
+  * mgcp_protocol: log when endpoint is unavailable
+  * cosmetic: add missing new-line
+  * mgcp_trunk: drop "trunk 0" limitation
+  * mgcp_e1: make E1 ts initalization more debugable
+  * mgcp_e1: remove unused struct member trunk->e1.line
+  * mgcp_endp: use NUM_E1_TS from e1_input.h
+  * mgcp_trunk: increase default number of virtual endpoints
+  * cosmetic: mgcp_client_fsm: change error message.
+  * mgcp_vty: remove remains of loopback functionality
+  * mgcp_vty: deprecate bind early command
+  * mgcp_e1: do not expose function  mgcp_e1_init()
+  * mgcp_vty: add user attributes to configuration commands
+  * overview: update section limitations.
+  * overview: fix graph "OsmoMGW used with OsmoBSC"
+  * overview: fix graph "OsmoMGW used with OsmoMSC"
+  * overview: add graph to show E1 integration
+  * configuration: remove hint towards trunk 0 limit
+  * configuration: drop note about lackin E1 support
+  * configuration: add note that changes to trunks need a restart
+  * mgcp_vty: fix config write for trunk 0
+  * mgcp_vty: add missing VTY commands for E1 trunks
+  * mgcp_trunk: get rid of magic numbers for E1 slots
+  * configuration: add section about E1 trunks
+  * usermanual: add chapter about mgcp endpoints
+  * mgcp_client: get rid of magic numbers for E1 slots
+
+  [ Eric ]
+  * tests: dlopen does not imply availability of dlsym..
+  * configure.ac: fix libtool issue with clang and sanitizer
+
+  [ Alexander Chemeris ]
+  * vty: Prepend VTY output of counters for better visual separation.
+  * counters: Implement more useful counters.
+  * mgcp_network: Fix a typo in the comment bahviour -> behaviour
+  * rtp_bridge: Demote a chatty ERROR log message to DEBUG level.
+
+  [ Pau Espin Pedrol ]
+  * Use OSMO_FD_* instead of deprecated BSC_FD_*
+  * Support setting rt-prio and cpu-affinity mask through VTY
+  * cosmetic: Rename main talloc ctx
+  * mgcp-client: Support IPv6 in osmo_mgcpc_ep_ci_get_crcx_info_to_sockaddr() implementation
+  * mgcp-client: Fix trailing whitespace in mgcp_client_fsm.h
+  * mgcp_client: Use INET6_ADDRSTRLEN to store addresses in str format
+  * mgcp_client: Allow submitting and parsing IPv6 addr in SDP
+  * mgcp_client: Allow setting IPv6 addresses
+  * mgcp_client: Make MGCP_CLIENT_LOCAL_ADDR_DEFAULT IPv6 compatible
+  * mgcp_client: Support validating IPv6 addresses in CRCX and MDCX commands
+  * mgcp_client: Deprecate unused IPv4-only API
+  * mgcp_client: copy back Connection Information from MDCX ACK
+  * mgw: Fix mgcp_rtp_end field description comment
+  * mgw: Initial IPv6 support
+  * mgw: Introduce VTY cmd 'rtp bind-ip-v6' command
+  * mgw: Find and store RTP conn local_addr once during CRCX handling
+  * mgw: Announce and rebind new local address if change required during MDCX
+  * mgw: osmux: Avoid sending packets on recvonly connection
+  * mgw: Release endpoint after last conn times out
+  * mgw: osmux: Fix conn watchdog timeout not updated
+  * mgw: Don't be case-sensitive when parsing X-Osmo-IGN param
+  * cosmetic: Fix typo in comment
+  * mgw: Avoid logging notice message each time we receive nt param in LCO
+  * mgw: Fix return value documentation for API mgcp_verify_call_id
+  * cosmetic: Fix typo in comment
+  * contrib/jenkins: Enable parallel make in make distcheck
+  * .gitignore: Ignore new autofoo tmp files
+  * tests: Replace deprecated API log_set_print_filename
+
+  [ Oliver Smith ]
+  * contrib: import RPM spec
+  * contrib: integrate RPM spec
+  * Makefile.am: EXTRA_DIST: debian, contrib/*.spec.in
+  * contrib/jenkins: don't build osmo-gsm-manuals
+  * configure.ac: set -std=gnu11
+
+  [ Vadim Yanitskiy ]
+  * libosmo-mgcp-client: fix use-after-free in mgcp_client_tx()
+  * libosmo-mgcp-client: fix use-after-free in mgcp_msg_gen()
+  * libosmo-mgcp: fix unsigned compared against 0 in mgcp_trunk_by_name()
+  * libosmo-mgcp: fix unused extra argument to printf() in add_fmtp()
+  * libosmo-mgcp: always check result of msgb_printf() in add_fmtp()
+  * libosmo-mgcp-client: mgcp_client_tx(): return rc on error
+  * debian/control: change maintainer to the Osmocom team / mailing list
+  * vty: use install_lib_element() and install_lib_element_ve()
+  * main: add --vty-ref-mode, use vty_dump_xml_ref_mode()
+  * fixup mgcp_trunk: increase default number of virtual endpoints
+
+  [ Alexander Couzens ]
+  * configure.ac: require libosmoabis + libosmotrau >= 1.0.0
+
+ -- Pau Espin Pedrol <pespin@sysmocom.de>  Tue, 23 Feb 2021 18:28:45 +0100
+
 osmo-mgw (1.7.0) unstable; urgency=medium
 
   [ Neels Hofmeyr ]

debian/control

@@ -6,10 +6,10 @@ Build-Depends: debhelper (>=9),
                dh-autoreconf,
                pkg-config,
                autotools-dev,
-               libosmocore-dev (>= 1.4.0),
-               libosmo-netif-dev,
-               libosmo-abis-dev,
-               osmo-gsm-manuals-dev
+               libosmocore-dev (>= 1.5.0),
+               libosmo-netif-dev (>= 1.1.0),
+               libosmo-abis-dev (>= 1.1.0),
+               osmo-gsm-manuals-dev (>= 1.1.0)
 Standards-Version: 3.9.8
 Vcs-Git: git://git.osmocom.org/osmo-mgw.git
 Vcs-Browser: https://git.osmocom.org/osmo-mgw/
@@ -21,7 +21,7 @@ Multi-Arch: foreign
 Depends: ${misc:Depends}, ${shlibs:Depends}
 Description: OsmoMGW: Osmocom's Media Gateway for 2G and 3G circuit-switched mobile networks
 
-Package: libosmo-mgcp-client6
+Package: libosmo-mgcp-client8
 Section: libs
 Architecture: any
 Multi-Arch: same
@@ -33,7 +33,7 @@ Package: libosmo-mgcp-client-dev
 Section: libdevel
 Architecture: any
 Multi-Arch: same
-Depends: libosmo-mgcp-client6 (= ${binary:Version}), ${misc:Depends}
+Depends: libosmo-mgcp-client8 (= ${binary:Version}), ${misc:Depends}
 Description: libosmo-mgcp-client: Osmocom's Media Gateway Control Protocol client utilities
 
 Package: osmo-mgw-doc

doc/examples/osmo-mgw/osmo-mgw-abis_e1.cfg

@@ -13,7 +13,7 @@ mgcp
   bind port 2427
   sdp audio payload number 98
   sdp audio payload name GSM
-  number endpoints 31
+  number endpoints 512
   loop 0
   force-realloc 1
   rtcp-omit

doc/examples/osmo-mgw/osmo-mgw.cfg

@@ -10,7 +10,7 @@ mgcp
   bind port 2427
   sdp audio payload number 98
   sdp audio payload name GSM
-  number endpoints 31
+  number endpoints 512
   loop 0
   force-realloc 1
   rtcp-omit

doc/manuals/chapters/configuration.adoc

@@ -23,14 +23,13 @@ OsmoMGW(config-mgcp)# local ip 127.0.0.1
 
 === Configuring the trunk
 
-The first trunk (trunk 0) is considered a virtual trunk in OsmoMGW. All
+The first trunk is considered a virtual trunk in OsmoMGW. All
 endpoints of type "rtpbridge" are routed here. The virtual trunk is configured
 in the config-mgcp context.
 
 All other trunks are configured in the config-mgcp-trunk context, but the
-commands used are identical. Right now trunks are considered only for ds/e1
-type endpoints which are not yet implemented. Don't use trunks other than the
-"virtual" trunk 0.
+commands used are identical. Right now trunks are considered only for "ds/e1"
+type endpoints.
 
 .Example: MGCP trunk configuration
 ----
@@ -54,4 +53,72 @@ OsmoMGW(config-mgcp)# rtp-patch timestamp <3>
 <2> Hide SSRC changes
 <3> Ensure RTP timestamp is aligned with frame duration
 
+NOTE: Changes to trunks that affect resource allocation, such as newly created
+trunks or a change of the number of available endpoints, require a full restart
+of osmo-mgw!
 
+=== E1 trunk considerations
+
+While the RTP bridge trunks are natively based on IP no special considerations
+are required during setup. E1 trunks are mapped on a physical E1 line, which has
+to be configured as shown below.
+
+.Example: E1 line setup
+----
+OsmoMGW(config-e1_input)# e1_line 0 driver dahdi <1>
+OsmoMGW(config-e1_input)# e1_line 0 port 2 <2>
+----
+<1> Name of the libosmo-abis driver implementation ("dahdi")
+<2> Port number of the physical E1 port to use (2)
+
+In osmo-mgw the e1_input node is used to configure the physical E1 line. The
+line number will be used internally to identify the configured E1 line. The
+port number is the physical E1 connector (sometimes called 'span') at the E1
+hardware. Per trunk an individual E1 line will be needed. Beware that the E1
+driver may also need configuration settings that are not discussed here.
+
+.Example: E1 trunk setup
+----
+OsmoMGW(config-mgcp)# trunk 0 <1>
+OsmoMGW(config-mgcp-trunk)# line 0 <2>
+----
+<1> Creation of a trunk (0)
+<2> Reference to the E1 line to use (0)
+
+The E1 trunk is created along with a number, typically starting at 0, but if
+required any number from 0-64 is allowed. The E1 trunk configuration concerning
+the IP related aspects is nearly identical to the configuration of the virtual
+trunk. However, it is important that the user assigns one of the E1 line numbers
+that were configured under the e1_input node.
+
+.Example: A typical configuration with one E1 trunk
+----
+e1_input
+ e1_line 0 driver dahdi
+ e1_line 0 port 2
+mgcp
+ bind ip 127.0.0.1
+ rtp net-range 6000 6011
+ rtp net-bind-ip 192.168.100.130
+ rtp ip-probing
+ rtp ip-tos 184
+ no rtp keep-alive
+ bind port 2428
+ number endpoints 30
+ loop 0
+ force-realloc 1
+ osmux off
+ rtp-patch rfc5993hr
+ trunk 0
+  rtp keep-alive once
+  no rtp keep-alive
+  line 0
+----
+
+NOTE: One E1 trunk always covers a whole E1 line. All subslots (I.640) will be mapped
+to individual MGCP endpoints. As long as the endpoints remain unused the
+underlying E1 timeslot is not used.
+
+NOTE: The E1 trunk implementation also works with T1 lines, however since T1 has
+24 instead of 31 usable timeslots only the endpoints that fall into that 1-24 timeslot
+range will be useable.

doc/manuals/chapters/mgcp_endpoints.adoc

@@ -0,0 +1,94 @@
+== MGCP Endpoints
+
+MGCP organizes the switching resources in so called endpoints. Each endpoint is
+referenced by its unique identifier. While RFC 3435 specifies a naming scheme, the
+actual identifier naming is subject to the implementation and configuration.
+
+=== RTP proxy / RTP bridge endpoints
+
+OsmoMGW implements a freely configurable number of `rtpbridge` endpoints. Those
+endpoints are able to host two connections at a time to model the functionality
+of a tandem switch.
+
+RTP bridge endpoint identifiers are referenced by the string `rtpbridge/`, a
+hexadecimal number without leading zeros and a domain name (configurable).
+
+----
+rtpbridge/<number>@<domain>
+----
+
+.Example: List of virtual endpoints
+----
+rtpbridge/1@mgw
+rtpbridge/2@mgw
+rtpbridge/3@mgw
+rtpbridge/4@mgw
+rtpbridge/5@mgw
+rtpbridge/6@mgw
+rtpbridge/7@mgw
+rtpbridge/8@mgw
+rtpbridge/9@mgw
+rtpbridge/a@mgw
+rtpbridge/b@mgw
+rtpbridge/c@mgw
+rtpbridge/d@mgw
+rtpbridge/e@mgw
+rtpbridge/f@mgw
+rtpbridge/10@mgw
+----
+
+=== E1/T1 endpoints
+
+OsmoMGW supports E1 subslot multiplexing as specified by I.460. All possible
+subslot combinations are mapped on individual endpoints. The endpoint names
+are prefixed with `ds/e1-` followed by the trunk number and the E1 timeslot.
+The subslot is defined by a bit rate and a bit offset.
+
+----
+ds/e1-<trunk>/s-<timeslot>/su<bitrate>-<bitoffset>@<domain>
+----
+
+.Example: List of endpoints on E1 trunk 0 at E1 timeslot 2
+----
+ds/e1-0/s-2/su64-0@mgw
+ds/e1-0/s-2/su32-0@mgw
+ds/e1-0/s-2/su32-4@mgw
+ds/e1-0/s-2/su16-0@mgw
+ds/e1-0/s-2/su16-2@mgw
+ds/e1-0/s-2/su16-4@mgw
+ds/e1-0/s-2/su16-6@mgw
+ds/e1-0/s-2/su8-0@mgw
+ds/e1-0/s-2/su8-1@mgw
+ds/e1-0/s-2/su8-2@mgw
+ds/e1-0/s-2/su8-3@mgw
+ds/e1-0/s-2/su8-4@mgw
+ds/e1-0/s-2/su8-5@mgw
+ds/e1-0/s-2/su8-6@mgw
+ds/e1-0/s-2/su8-7@mgw
+----
+
+When creating connections on endpoints that reside in one E1 timeslot the call
+agent must make sure that no overlapping endpoints are used. It is for example
+not possible to use `ds/e1-0/s-2/su16-2@mgw` and `ds/e1-0/s-2/su8-3@mgw` at the
+same time because they overlap.
+
+.Subslot overlapping
+[options="header"]
+|===
+| Bit offset  4+| Subslots
+| 0 | 8k .2+| 16k .4+| 32k .8+| 64k
+| 1 | 8k
+| 2 | 8k .2+| 16k
+| 3 | 8k
+| 4 | 8k .2+| 16k .4+| 32k
+| 5 | 8k
+| 6 | 8k .2+| 16k
+| 7 | 8k
+|===
+
+NOTE: The current implementation (December 2020) only implements TRAU frame
+encoding/decoding for 16K and 8K subslots. Endpoints with other bitrates are
+not yet useable.
+
+NOTE: the VTY command "show mgcp" can be used to get a list of all available
+endpoints (including identifiers)

doc/manuals/chapters/overview.adoc

@@ -21,10 +21,10 @@ Protocol.
 digraph G {
     rankdir = LR;
     OsmoBTS -> OsmoBSC [label="Abis/IP"];
-    OsmoBSC -> OsmoMSC [label="3GPP AoIP"];
+    OsmoBSC -> "core-network" [label="3GPP AoIP"];
     OsmoBSC -> OsmoMGW [label="MGCP"];
     OsmoBTS -> OsmoMGW [label="RTP",dir=both];
-    OsmoMGW -> OsmoMSC [label="RTP",dir=both];
+    OsmoMGW -> "core-network" [label="RTP",dir=both];
     {rank=same OsmoBSC OsmoMGW}
     OsmoMGW [color=red];
 }
@@ -36,10 +36,9 @@ digraph G {
 ----
 digraph G {
     rankdir = LR;
-    BTS -> BSC [label="Abis"];
-    BSC -> OsmoMSC [label="3GPP AoIP"];
+    "2G BSS" -> OsmoMSC [label="3GPP AoIP"];
     OsmoMSC -> OsmoMGW [label="MGCP"];
-    BSC -> OsmoMGW [label="RTP",dir=both];
+    "2G BSS" -> OsmoMGW [label="RTP",dir=both];
     OsmoMSC -> OsmoSIP [label="MNCC"];
     OsmoSIP -> PBX [label="SIP Trunk"];
     OsmoMGW -> PBX [label="RTP",dir=both];
@@ -53,6 +52,22 @@ digraph G {
 }
 ----
 
+[[fig-bsc]]
+.Integration of legacy E1 BTS in AoIP network
+[graphviz]
+----
+digraph G {
+    rankdir = LR;
+    BTS -> OsmoBSC [label="Abis/E1"];
+    OsmoBSC -> "core-network" [label="3GPP AoIP"];
+    OsmoBSC -> OsmoMGW [label="MGCP"];
+    BTS -> OsmoMGW [label="TRAU/E1",dir=both];
+    OsmoMGW -> "core-network" [label="RTP",dir=both];
+    {rank=same OsmoBSC OsmoMGW}
+    OsmoMGW [color=red];
+}
+----
+
 === Software Components
 
 OsmoMGW contains a variety of different software components, which we’ll
@@ -77,14 +92,14 @@ Transcoding is currently not supported in OsmoMGW.
 
 === Limitations
 
-Osmux is not yet supported in OsmoMGW.
-
-At the moment (July 2018), OsmoMGW only implements RTP proxy / RTP bridge
-type endpoints, to each of which two RTP connections can be established.
-We are planning to add endpoint types for:
+At the moment (November 2020), OsmoMGW implements RTP proxy / RTP bridge
+type endpoints and E1/T1 16k/8k sub-slots with TRAU frames for classic BTS
+support. To the RTP proxy / RTP bridge endpoints two RTP connections can
+be established, which then work as a tandem. E1/T1 endpoints support one
+RTP connection at a time that is associated with a sub-slot on an E1 line.
+We are planning to add further endpoint types for:
 
 - classic E1/T1 timeslots (64kBps alaw/ulaw)
-- classic E1/T1 16k sub-slots with TRAU frames for classic BTS support
 - announcement/playout end-points
 - conference endpoints
 

doc/manuals/osmomgw-usermanual.adoc

@@ -18,6 +18,8 @@ include::./common/chapters/logging.adoc[]
 
 include::{srcdir}/chapters/configuration.adoc[]
 
+include::{srcdir}/chapters/mgcp_endpoints.adoc[]
+
 include::{srcdir}/chapters/mgcp_extensions.adoc[]
 
 include::./common/chapters/osmux/osmux.adoc[]

include/osmocom/mgcp/mgcp_trunk.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <osmocom/gsm/i460_mux.h>
+#include <osmocom/abis/e1_input.h>
 
 #define LOGPTRUNK(trunk, cat, level, fmt, args...) \
 LOGP(cat, level, "trunk:%u " fmt, \
@@ -59,8 +60,11 @@ struct mgcp_trunk {
 		/* E1 specific */
 		struct {
 			unsigned int vty_line_nr;
-			bool ts_in_use[31];
-			struct osmo_i460_timeslot i460_ts[31];
+			bool ts_in_use[NUM_E1_TS-1];
+			struct osmo_i460_timeslot i460_ts[NUM_E1_TS-1];
+			/* Note: on an E1 line TS 0 is devoted to framing and
+			 * alignment and therefore only NUM_E1_TS-1 timeslots
+			 * are available for traffic. */
 		} e1;
 	};
 };

src/libosmo-mgcp-client/Makefile.am

@@ -9,6 +9,7 @@ AM_CFLAGS = \
 	-Wall \
 	$(LIBOSMOCORE_CFLAGS) \
 	$(LIBOSMOVTY_CFLAGS) \
+	$(LIBOSMOABIS_CFLAGS) \
 	$(COVERAGE_CFLAGS) \
 	$(NULL)
 
@@ -20,7 +21,7 @@ AM_LDFLAGS = \
 
 # This is not at all related to the release version, but a range of supported
 # API versions. Read TODO_RELEASE in the source tree's root!
-MGCP_CLIENT_LIBVERSION=7:0:1
+MGCP_CLIENT_LIBVERSION=8:0:0
 
 lib_LTLIBRARIES = \
 	libosmo-mgcp-client.la \

src/libosmo-mgcp-client/mgcp_client.c

@@ -30,6 +30,8 @@
 #include <osmocom/mgcp_client/mgcp_client.h>
 #include <osmocom/mgcp_client/mgcp_client_internal.h>
 
+#include <osmocom/abis/e1_input.h>
+
 #include <netinet/in.h>
 #include <arpa/inet.h>
 
@@ -832,6 +834,11 @@ int mgcp_client_connect(struct mgcp_client *mgcp)
 	}
 
 	wq = &mgcp->wq;
+	osmo_wqueue_init(wq, 1024);
+	wq->read_cb = mgcp_do_read;
+	wq->write_cb = mgcp_do_write;
+
+	osmo_fd_setup(&wq->bfd, -1, OSMO_FD_READ, osmo_wqueue_bfd_cb, mgcp, 0);
 
 	rc = init_socket(mgcp);
 	if (rc < 0) {
@@ -842,11 +849,6 @@ int mgcp_client_connect(struct mgcp_client *mgcp)
 		goto error_close_fd;
 	}
 
-	osmo_wqueue_init(wq, 1024);
-	wq->bfd.when = OSMO_FD_READ;
-	wq->bfd.data = mgcp;
-	wq->read_cb = mgcp_do_read;
-	wq->write_cb = mgcp_do_write;
 
 	LOGP(DLMGCP, LOGL_INFO, "MGCP GW connection: %s\n", osmo_sock_get_name2(wq->bfd.fd));
 
@@ -957,7 +959,7 @@ const char *mgcp_client_e1_epname(void *ctx, const struct mgcp_client *mgcp, uin
 
 	/* An E1 line has a maximum of 32 timeslots, while the first (ts=0) is
 	 * reserverd for framing and alignment, so we can not use it here. */
-	if (ts == 0 || ts > 31) {
+	if (ts == 0 || ts > NUM_E1_TS-1) {
 		LOGP(DLMGCP, LOGL_ERROR,
 		     "Cannot compose MGCP e1-endpoint name (%s), E1-timeslot number (%u) is invalid!\n", epname, ts);
 		talloc_free(epname);

src/libosmo-mgcp/mgcp_network.c

@@ -1577,7 +1577,6 @@ static int bind_rtp(struct mgcp_config *cfg, const char *source_addr,
 	mgcp_set_ip_tos(rtp_end->rtp.fd, cfg->endp_dscp);
 	mgcp_set_ip_tos(rtp_end->rtcp.fd, cfg->endp_dscp);
 
-	rtp_end->rtp.when = OSMO_FD_READ;
 	if (osmo_fd_register(&rtp_end->rtp) != 0) {
 		LOGPENDP(endp, DRTP, LOGL_ERROR,
 			 "failed to register RTP port %d\n",
@@ -1585,7 +1584,6 @@ static int bind_rtp(struct mgcp_config *cfg, const char *source_addr,
 		goto cleanup2;
 	}
 
-	rtp_end->rtcp.when = OSMO_FD_READ;
 	if (osmo_fd_register(&rtp_end->rtcp) != 0) {
 		LOGPENDP(endp, DRTP, LOGL_ERROR,
 			 "failed to register RTCP port %d\n",
@@ -1634,10 +1632,8 @@ int mgcp_bind_net_rtp_port(struct mgcp_endpoint *endp, int rtp_port,
 	}
 
 	end->local_port = rtp_port;
-	end->rtp.cb = rtp_data_net;
-	end->rtp.data = conn;
-	end->rtcp.data = conn;
-	end->rtcp.cb = rtp_data_net;
+	osmo_fd_setup(&end->rtp, -1, OSMO_FD_READ, rtp_data_net, conn, 0);
+	osmo_fd_setup(&end->rtcp, -1, OSMO_FD_READ, rtp_data_net, conn, 0);
 
 	return bind_rtp(endp->cfg, conn->end.local_addr, end, endp);
 }

src/libosmo-mgcp/mgcp_osmux.c

@@ -416,8 +416,7 @@ int osmux_init(int role, struct mgcp_config *cfg)
 {
 	int ret;
 
-	osmux_fd.cb = osmux_read_fd_cb;
-	osmux_fd.data = cfg;
+	osmo_fd_setup(&osmux_fd, -1, OSMO_FD_READ, osmux_read_fd_cb, cfg, 0);
 
 	ret = mgcp_create_bind(cfg->osmux_addr, &osmux_fd, cfg->osmux_port);
 	if (ret < 0) {
@@ -426,7 +425,6 @@ int osmux_init(int role, struct mgcp_config *cfg)
 		return ret;
 	}
 	mgcp_set_ip_tos(osmux_fd.fd, cfg->endp_dscp);
-	osmux_fd.when |= OSMO_FD_READ;
 
 	ret = osmo_fd_register(&osmux_fd);
 	if (ret < 0) {

src/libosmo-mgcp/mgcp_vty.c

@@ -958,7 +958,8 @@ static int config_write_trunk(struct vty *vty)
 		   config of trunk 0 here. The configuration for the virtual
 		   trunk is written by config_write_mgcp(). */
 
-		if (trunk->trunk_nr == MGCP_VIRT_TRUNK_ID)
+		if (trunk->trunk_type == MGCP_TRUNK_VIRTUAL
+		    && trunk->trunk_nr == MGCP_VIRT_TRUNK_ID)
 			continue;
 
 		vty_out(vty, " trunk %d%s", trunk->trunk_nr, VTY_NEWLINE);
@@ -1055,6 +1056,32 @@ DEFUN_DEPRECATED(cfg_trunk_loop,
 	return CMD_SUCCESS;
 }
 
+DEFUN_USRATTR(cfg_trunk_force_realloc,
+	      cfg_trunk_force_realloc_cmd,
+	      X(MGW_CMD_ATTR_NEWCONN),
+	      "force-realloc (0|1)",
+	      "Force endpoint reallocation when the endpoint is still seized\n"
+	      "Don't force reallocation\n" "force reallocation\n")
+{
+	struct mgcp_trunk *trunk = vty->index;
+	OSMO_ASSERT(trunk);
+	trunk->force_realloc = atoi(argv[0]);
+	return CMD_SUCCESS;
+}
+
+DEFUN_ATTR(cfg_trunk_rtp_accept_all,
+	   cfg_trunk_rtp_accept_all_cmd,
+	   "rtp-accept-all (0|1)",
+	   "Accept all RTP packets, even when the originating IP/Port does not match\n"
+	   "enable filter\n" "disable filter\n",
+	   CMD_ATTR_IMMEDIATE)
+{
+	struct mgcp_trunk *trunk = vty->index;
+	OSMO_ASSERT(trunk);
+	trunk->rtp_accept_all = atoi(argv[0]);
+	return CMD_SUCCESS;
+}
+
 DEFUN_USRATTR(cfg_trunk_sdp_payload_send_ptime,
 	      cfg_trunk_sdp_payload_send_ptime_cmd,
 	      X(MGW_CMD_ATTR_NEWCONN),
@@ -1646,6 +1673,8 @@ int mgcp_vty_init(void)
 	install_element(TRUNK_NODE, &cfg_trunk_payload_number_cmd_old);
 	install_element(TRUNK_NODE, &cfg_trunk_payload_name_cmd_old);
 	install_element(TRUNK_NODE, &cfg_trunk_loop_cmd);
+	install_element(TRUNK_NODE, &cfg_trunk_force_realloc_cmd);
+	install_element(TRUNK_NODE, &cfg_trunk_rtp_accept_all_cmd);
 	install_element(TRUNK_NODE, &cfg_trunk_omit_rtcp_cmd);
 	install_element(TRUNK_NODE, &cfg_trunk_no_omit_rtcp_cmd);
 	install_element(TRUNK_NODE, &cfg_trunk_patch_rtp_ssrc_cmd);

src/osmo-mgw/mgw_main.c

@@ -97,13 +97,41 @@ void *tall_mgw_ctx = NULL;
 
 static void print_help()
 {
-	printf("Some useful help...\n");
+	printf("Some useful options:\n");
 	printf(" -h --help is printing this text.\n");
 	printf(" -c --config-file filename The config file to use.\n");
 	printf(" -s --disable-color\n");
 	printf(" -D --daemonize Fork the process into a background daemon\n");
 	printf(" -V --version Print the version number\n");
-	printf(" --vty-ref-xml Generate the VTY reference XML output and exit.\n");
+
+	printf("\nVTY reference generation:\n");
+	printf("    --vty-ref-mode MODE		VTY reference generation mode (e.g. 'expert').\n");
+	printf("    --vty-ref-xml		Generate the VTY reference XML output and exit.\n");
+}
+
+static void handle_long_options(const char *prog_name, const int long_option)
+{
+	static int vty_ref_mode = VTY_REF_GEN_MODE_DEFAULT;
+
+	switch (long_option) {
+	case 1:
+		vty_ref_mode = get_string_value(vty_ref_gen_mode_names, optarg);
+		if (vty_ref_mode < 0) {
+			fprintf(stderr, "%s: Unknown VTY reference generation "
+				"mode '%s'\n", prog_name, optarg);
+			exit(2);
+		}
+		break;
+	case 2:
+		fprintf(stderr, "Generating the VTY reference in mode '%s' (%s)\n",
+			get_value_string(vty_ref_gen_mode_names, vty_ref_mode),
+			get_value_string(vty_ref_gen_mode_desc, vty_ref_mode));
+		vty_dump_xml_ref_mode(stdout, (enum vty_ref_gen_mode) vty_ref_mode);
+		exit(0);
+	default:
+		fprintf(stderr, "%s: error parsing cmdline options\n", prog_name);
+		exit(2);
+	}
 }
 
 static void handle_options(int argc, char **argv)
@@ -117,7 +145,8 @@ static void handle_options(int argc, char **argv)
 			{"daemonize", 0, 0, 'D'},
 			{"version", 0, 0, 'V'},
 			{"disable-color", 0, 0, 's'},
-			{"vty-ref-xml", 0, &long_option, 1},
+			{"vty-ref-mode", 1, &long_option, 1},
+			{"vty-ref-xml", 0, &long_option, 2},
 			{0, 0, 0, 0},
 		};
 
@@ -132,14 +161,8 @@ static void handle_options(int argc, char **argv)
 			exit(0);
 			break;
 		case 0:
-			switch (long_option) {
-			case 1:
-				vty_dump_xml_ref(stdout);
-				exit(0);
-			default:
-				fprintf(stderr, "error parsing cmdline options\n");
-				exit(2);
-			}
+			handle_long_options(argv[0], long_option);
+			break;
 		case 'c':
 			config_file = talloc_strdup(tall_mgw_ctx, optarg);
 			break;

tests/mgcp_client/mgcp_client_test.c

@@ -689,9 +689,10 @@ int main(int argc, char **argv)
 	ctx = talloc_named_const(NULL, 1, "mgcp_client_test");
 	msgb_talloc_ctx_init(ctx, 0);
 	osmo_init_logging2(ctx, &log_info);
-	log_set_print_filename(osmo_stderr_target, 0);
+	log_set_print_filename2(osmo_stderr_target, LOG_FILENAME_NONE);
 	log_set_print_timestamp(osmo_stderr_target, 0);
 	log_set_use_color(osmo_stderr_target, 0);
+	log_set_print_category_hex(osmo_stderr_target, 0);
 	log_set_print_category(osmo_stderr_target, 1);
 
 	log_set_category_filter(osmo_stderr_target, DLMGCP, 1, LOGL_DEBUG);