gerrit-log

gerrit-log@lists.osmocom.org

1 participants
87669 discussions

Change in osmo-upf[master]: implement GTP tunnel mapping via netfilter
by neels 19 Jul '22

19 Jul '22

Attention is currently required from: laforge, pespin. neels has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28309 ) Change subject: implement GTP tunnel mapping via netfilter ...................................................................... Patch Set 5: (1 comment) Patchset: PS5: > Agreeing with pau you misunderstand. Of course the VTY tests are not doing anything related to administrative parmissions. It is osmo-upf preparing the nftables feature *upon startup*. Whenever osmo-upf starts, it opens the nftables socket and creates an empty table. So even before the VTY tests begin, the premission error happens. I've tried to discuss this already in my previous comments, maybe it was not clear enough. I wrote before already: we can skip opening the nftables socket until it is actually needed. But i would prefer osmo-upf to complain about permission problems directly upon startup. -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28309 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ic0d319eb4f98cd51a5999c804c4203ab0bdda650 Gerrit-Change-Number: 28309 Gerrit-PatchSet: 5 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-CC: laforge <laforge(a)osmocom.org> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Comment-Date: Tue, 19 Jul 2022 12:23:20 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: neels <nhofmeyr(a)sysmocom.de> Comment-In-Reply-To: laforge <laforge(a)osmocom.org> Comment-In-Reply-To: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: comment

1 0

Change in libosmocore[master]: fsm: add unit tests verifying state timeout s/ms accuracy
by fixeria 19 Jul '22

19 Jul '22

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/28648 ) Change subject: fsm: add unit tests verifying state timeout s/ms accuracy ...................................................................... fsm: add unit tests verifying state timeout s/ms accuracy This change adds test_state_chg_Ts() and test_state_chg_Tms() checking state timeout s/ms accuracy when using osmo_fsm_inst_state_chg() and osmo_fsm_inst_state_chg_ms() calls, respectively. test_state_chg_Tms() demonstrates that osmo_fsm_inst_state_chg_ms() is not working as expected: the timeout fires earlier than expected. Change-Id: I5a35730a8448292b075aefafed897353678250f9 Related: OS#5622 --- M tests/fsm/fsm_test.c M tests/fsm/fsm_test.err 2 files changed, 100 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, but someone else must approve pespin: Looks good to me, approved diff --git a/tests/fsm/fsm_test.c b/tests/fsm/fsm_test.c index 2cfdacd..ec31dd2 100644 --- a/tests/fsm/fsm_test.c +++ b/tests/fsm/fsm_test.c @@ -386,6 +386,76 @@ fprintf(stderr, "--- %s() done\n", __func__); } +/* Test setting a state timeout with second granularity */ +static void test_state_chg_Ts(void) +{ + struct osmo_fsm_inst *fi; + + fprintf(stderr, "\n--- %s()\n", __func__); + + fsm.timer_cb = &timer_cb; + timeout_fired = -1; + fake_time_start(); + + fi = osmo_fsm_inst_alloc(&fsm, g_ctx, NULL, LOGL_DEBUG, NULL); + OSMO_ASSERT(fi); + + osmo_fsm_inst_state_chg(fi, ST_ONE, 8, 4242); + OSMO_ASSERT(timeout_fired == -1); + + fake_time_passes(3, 0); /* +3s */ + OSMO_ASSERT(timeout_fired == -1); + + fake_time_passes(2, 500000); /* +2.5s */ + OSMO_ASSERT(timeout_fired == -1); + + fake_time_passes(2, 500000); /* +2.5s */ + OSMO_ASSERT(timeout_fired == 4242); + + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REQUEST, NULL); + + fprintf(stderr, "--- %s() done\n", __func__); +} + +/* Test setting a state timeout with millisecond granularity */ +static void test_state_chg_Tms(void) +{ + struct osmo_fsm_inst *fi; + + fprintf(stderr, "\n--- %s()\n", __func__); + + fsm.timer_cb = &timer_cb; + timeout_fired = -1; + fake_time_start(); + + fi = osmo_fsm_inst_alloc(&fsm, g_ctx, NULL, LOGL_DEBUG, NULL); + OSMO_ASSERT(fi); + + osmo_fsm_inst_state_chg_ms(fi, ST_ONE, 1337, 4242); /* 1s 337ms */ + OSMO_ASSERT(timeout_fired == -1); + + fake_time_passes(0, 500000); /* +500ms, 500ms total */ + OSMO_ASSERT(timeout_fired == -1); + + fake_time_passes(0, 250000); /* +250ms, 750ms total */ + OSMO_ASSERT(timeout_fired == -1); + + fake_time_passes(0, 350000); /* +350ms, 1s 100ms total */ + /* OSMO_ASSERT(timeout_fired == -1); */ + + /* FIXME: the timeout expires here, earlier than expected */ + + fake_time_passes(0, 200000); /* +200ms, 1s 300ms total */ + /* OSMO_ASSERT(timeout_fired == -1); */ + + fake_time_passes(0, 37000); /* +37ms, 1s 337ms total */ + /* OSMO_ASSERT(timeout_fired == 4242); */ + + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REQUEST, NULL); + + fprintf(stderr, "--- %s() done\n", __func__); +} + static const struct log_info_cat default_categories[] = { [DMAIN] = { .name = "DMAIN", @@ -434,6 +504,8 @@ test_id_api(); test_state_chg_keep_timer(); test_state_chg_T(); + test_state_chg_Ts(); + test_state_chg_Tms(); osmo_fsm_unregister(&fsm); exit(0); diff --git a/tests/fsm/fsm_test.err b/tests/fsm/fsm_test.err index 4cc5ca4..f140d2e 100644 --- a/tests/fsm/fsm_test.err +++ b/tests/fsm/fsm_test.err @@ -116,3 +116,31 @@ Test_FSM{TWO}: Freeing instance Test_FSM{TWO}: Deallocated --- test_state_chg_T() done + +--- test_state_chg_Ts() +Total time passed: 0.000000 s +Test_FSM{NULL}: Allocated +Test_FSM{NULL}: State change to ONE (T4242, 8s) +Total time passed: 3.000000 s +Total time passed: 5.500000 s +Total time passed: 8.000000 s +Test_FSM{ONE}: Timeout of T4242 +Test_FSM{ONE}: Terminating (cause = OSMO_FSM_TERM_REQUEST) +Test_FSM{ONE}: Freeing instance +Test_FSM{ONE}: Deallocated +--- test_state_chg_Ts() done + +--- test_state_chg_Tms() +Total time passed: 0.000000 s +Test_FSM{NULL}: Allocated +Test_FSM{NULL}: State change to ONE (T4242, 1337ms) +Total time passed: 0.500000 s +Total time passed: 0.750000 s +Total time passed: 1.100000 s +Test_FSM{ONE}: Timeout of T4242 +Total time passed: 1.300000 s +Total time passed: 1.337000 s +Test_FSM{ONE}: Terminating (cause = OSMO_FSM_TERM_REQUEST) +Test_FSM{ONE}: Freeing instance +Test_FSM{ONE}: Deallocated +--- test_state_chg_Tms() done -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/28648 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: I5a35730a8448292b075aefafed897353678250f9 Gerrit-Change-Number: 28648 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in libosmocore[master]: fsm: fix state_chg(): pass microseconds to osmo_timer_schedule()
by fixeria 19 Jul '22

19 Jul '22

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/libosmocore/+/28649 ) Change subject: fsm: fix state_chg(): pass microseconds to osmo_timer_schedule() ...................................................................... fsm: fix state_chg(): pass microseconds to osmo_timer_schedule() As was demonstrated in [1], osmo_fsm_inst_state_chg_ms() is broken. The problem is in state_chg(): this function is passing *milli*seconds to osmo_timer_schedule(), while it expects *micro*seconds. Change-Id: Ib0b6c3bdb56e4279df9e5ba7db16841645c452aa Related: [1] I5a35730a8448292b075aefafed897353678250f9 Fixes: I35b330e460e80bb67376c77e997e464439ac5397 Fixes: OS#5622 --- M src/fsm.c M tests/fsm/fsm_test.c M tests/fsm/fsm_test.err 3 files changed, 9 insertions(+), 8 deletions(-) Approvals: Jenkins Builder: Verified pespin: Looks good to me, but someone else must approve dexter: Looks good to me, approved diff --git a/src/fsm.c b/src/fsm.c index 8b0b27b..b51c5cb 100644 --- a/src/fsm.c +++ b/src/fsm.c @@ -685,8 +685,11 @@ if (!keep_timer || (keep_timer && !osmo_timer_pending(&fi->timer))) { fi->T = T; - if (timeout_ms) - osmo_timer_schedule(&fi->timer, timeout_ms / 1000, timeout_ms % 1000); + if (timeout_ms) { + osmo_timer_schedule(&fi->timer, + /* seconds */ (timeout_ms / 1000), + /* microseconds */ (timeout_ms % 1000) * 1000); + } } /* Call 'onenter' last, user might terminate FSM from there */ diff --git a/tests/fsm/fsm_test.c b/tests/fsm/fsm_test.c index ec31dd2..6fa0ae7 100644 --- a/tests/fsm/fsm_test.c +++ b/tests/fsm/fsm_test.c @@ -441,15 +441,13 @@ OSMO_ASSERT(timeout_fired == -1); fake_time_passes(0, 350000); /* +350ms, 1s 100ms total */ - /* OSMO_ASSERT(timeout_fired == -1); */ - - /* FIXME: the timeout expires here, earlier than expected */ + OSMO_ASSERT(timeout_fired == -1); fake_time_passes(0, 200000); /* +200ms, 1s 300ms total */ - /* OSMO_ASSERT(timeout_fired == -1); */ + OSMO_ASSERT(timeout_fired == -1); fake_time_passes(0, 37000); /* +37ms, 1s 337ms total */ - /* OSMO_ASSERT(timeout_fired == 4242); */ + OSMO_ASSERT(timeout_fired == 4242); osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REQUEST, NULL); diff --git a/tests/fsm/fsm_test.err b/tests/fsm/fsm_test.err index f140d2e..51bf5da 100644 --- a/tests/fsm/fsm_test.err +++ b/tests/fsm/fsm_test.err @@ -137,9 +137,9 @@ Total time passed: 0.500000 s Total time passed: 0.750000 s Total time passed: 1.100000 s -Test_FSM{ONE}: Timeout of T4242 Total time passed: 1.300000 s Total time passed: 1.337000 s +Test_FSM{ONE}: Timeout of T4242 Test_FSM{ONE}: Terminating (cause = OSMO_FSM_TERM_REQUEST) Test_FSM{ONE}: Freeing instance Test_FSM{ONE}: Deallocated -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/28649 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ib0b6c3bdb56e4279df9e5ba7db16841645c452aa Gerrit-Change-Number: 28649 Gerrit-PatchSet: 2 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in libosmocore[master]: fsm: fix state_chg(): pass microseconds to osmo_timer_schedule()
by dexter 19 Jul '22

19 Jul '22

Attention is currently required from: laforge, fixeria. dexter has posted comments on this change. ( https://gerrit.osmocom.org/c/libosmocore/+/28649 ) Change subject: fsm: fix state_chg(): pass microseconds to osmo_timer_schedule() ...................................................................... Patch Set 2: Code-Review+2 (1 comment) Patchset: PS2: I believe this is correct: in libosmocore there is also code that uses the function like in this patch: src/gb/gprs_bssgp.c:osmo_timer_schedule(&fc->timer, msecs / 1000, (msecs % 1000) * 1000); -- To view, visit https://gerrit.osmocom.org/c/libosmocore/+/28649 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Change-Id: Ib0b6c3bdb56e4279df9e5ba7db16841645c452aa Gerrit-Change-Number: 28649 Gerrit-PatchSet: 2 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 19 Jul 2022 12:20:00 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 0

Change in osmo-upf[master]: add netfilter deps: libnftnl, libnftables
by neels 19 Jul '22

19 Jul '22

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28387 ) Change subject: add netfilter deps: libnftnl, libnftables ...................................................................... add netfilter deps: libnftnl, libnftables Will be used by subsequent patch to implement GTP tunnel mapping via netfilter. Related: SYS#5599 Change-Id: Ia8be861fe1303e82e57fe83a50cfa4ff0280db02 --- M configure.ac M contrib/jenkins.sh M src/osmo-upf/Makefile.am 3 files changed, 32 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified pespin: Looks good to me, but someone else must approve laforge: Looks good to me, approved diff --git a/configure.ac b/configure.ac index 119aa6c..fea27c6 100644 --- a/configure.ac +++ b/configure.ac @@ -45,6 +45,8 @@ PKG_CHECK_MODULES(LIBOSMOGTLV, libosmo-gtlv >= 0.1.0) PKG_CHECK_MODULES(LIBOSMOPFCP, libosmo-pfcp >= 0.1.0) PKG_CHECK_MODULES(LIBGTPNL, libgtpnl >= 1.2.0) +PKG_CHECK_MODULES(LIBNFTNL, libnftnl >= 1.2.1) +PKG_CHECK_MODULES(LIBNFTABLES, libnftables >= 1.0.2) dnl checks for header files AC_HEADER_STDC diff --git a/contrib/jenkins.sh b/contrib/jenkins.sh index 253d0b8..beb74dc 100755 --- a/contrib/jenkins.sh +++ b/contrib/jenkins.sh @@ -33,6 +33,30 @@ osmo-build-dep.sh libosmo-pfcp osmo-build-dep.sh libgtpnl +# build libnftnl and libnftables from git.netfilter.org +build_from_netfilter() { +### TODO: enable osmo-build-dep.sh to build from git.netfilter.org URL? + project="$1" + set +x + echo + echo + echo + echo " =============================== $project ===============================" + echo + set -x + if [ -d "./$project" ]; then + rm -rf "./$project" + fi + git clone "git://git.netfilter.org/$project" "$project" + cd "$project" + autoreconf --install --force + ./configure --prefix="$inst/stow/$project" --without-cli --disable-man-doc + $MAKE install + STOW_DIR="$inst/stow" stow --restow $project +} +build_from_netfilter libnftnl +build_from_netfilter nftables + # Additional configure options and depends CONFIG="" if [ "$WITH_MANUALS" = "1" ]; then diff --git a/src/osmo-upf/Makefile.am b/src/osmo-upf/Makefile.am index d8aa5a0..37a8543 100644 --- a/src/osmo-upf/Makefile.am +++ b/src/osmo-upf/Makefile.am @@ -13,11 +13,15 @@ $(LIBOSMOGTLV_CFLAGS) \ $(LIBOSMOPFCP_CFLAGS) \ $(LIBGTPNL_CFLAGS) \ + $(LIBNFTNL_CFLAGS) \ + $(LIBNFTABLES_CFLAGS) \ $(COVERAGE_CFLAGS) \ $(NULL) AM_LDFLAGS = \ $(LIBGTPNL_LDFLAGS) \ + $(LIBNFTNL_LDFLAGS) \ + $(LIBNFTABLES_LDFLAGS) \ $(COVERAGE_LDFLAGS) \ $(NULL) @@ -43,5 +47,7 @@ $(LIBOSMOGTLV_LIBS) \ $(LIBOSMOPFCP_LIBS) \ $(LIBGTPNL_LIBS) \ + $(LIBNFTNL_LIBS) \ + $(LIBNFTABLES_LIBS) \ $(COVERAGE_LDFLAGS) \ $(NULL) -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28387 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ia8be861fe1303e82e57fe83a50cfa4ff0280db02 Gerrit-Change-Number: 28387 Gerrit-PatchSet: 3 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in osmo-upf[master]: add osmo-upf
by neels 19 Jul '22

19 Jul '22

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28308 ) Change subject: add osmo-upf ...................................................................... add osmo-upf Related: SYS#5599 Change-Id: I745bcbde6859004c41ddbfd2558036bf9a2d1de2 --- A doc/examples/osmo-upf/osmo-upf-create-dev.cfg M doc/examples/osmo-upf/osmo-upf.cfg M include/osmocom/upf/Makefile.am A include/osmocom/upf/up_endpoint.h A include/osmocom/upf/up_gtp_action.h A include/osmocom/upf/up_peer.h A include/osmocom/upf/up_session.h A include/osmocom/upf/up_session_to_gtp.c M include/osmocom/upf/upf.h A include/osmocom/upf/upf_gtp.h A include/osmocom/upf/upf_nft.h M src/osmo-upf/Makefile.am M src/osmo-upf/osmo_upf_main.c A src/osmo-upf/up_endpoint.c A src/osmo-upf/up_gtp_action.c A src/osmo-upf/up_peer.c A src/osmo-upf/up_peer_fsm.c A src/osmo-upf/up_session.c M src/osmo-upf/upf.c A src/osmo-upf/upf_gtp.c A src/osmo-upf/upf_vty.c M tests/upf.vty 22 files changed, 4,054 insertions(+), 3 deletions(-) Approvals: Jenkins Builder: Verified neels: Looks good to me, approved diff --git a/doc/examples/osmo-upf/osmo-upf-create-dev.cfg b/doc/examples/osmo-upf/osmo-upf-create-dev.cfg new file mode 100644 index 0000000..54ca643 --- /dev/null +++ b/doc/examples/osmo-upf/osmo-upf-create-dev.cfg @@ -0,0 +1,16 @@ +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 info +#logging level set-all debug + +timer pfcp x24 5000 +pfcp + local-addr 127.0.0.1 +gtp + dev create apn23 diff --git a/doc/examples/osmo-upf/osmo-upf.cfg b/doc/examples/osmo-upf/osmo-upf.cfg index 8a2a407..0f241a5 100644 --- a/doc/examples/osmo-upf/osmo-upf.cfg +++ b/doc/examples/osmo-upf/osmo-upf.cfg @@ -6,4 +6,10 @@ logging print category-hex 0 logging print file basename last logging print extended-timestamp 1 + logging level set-all debug logging level set-all notice + logging level set-all info + +timer pfcp x24 5000 +pfcp + local-addr 127.0.0.1 diff --git a/include/osmocom/upf/Makefile.am b/include/osmocom/upf/Makefile.am index 2608e8f..333132c 100644 --- a/include/osmocom/upf/Makefile.am +++ b/include/osmocom/upf/Makefile.am @@ -1,3 +1,9 @@ noinst_HEADERS = \ + up_endpoint.h \ + up_peer.h \ + up_session.h \ upf.h \ + upf_gtp.h \ + upf_nft.h \ + up_gtp_action.h \ $(NULL) diff --git a/include/osmocom/upf/up_endpoint.h b/include/osmocom/upf/up_endpoint.h new file mode 100644 index 0000000..3bb14ec --- /dev/null +++ b/include/osmocom/upf/up_endpoint.h @@ -0,0 +1,48 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <osmocom/core/linuxlist.h> + +struct osmo_pfcp_msg; +struct osmo_pfcp_endpoint; +struct osmo_sockaddr; + +#define UP_USE_MSG_RX "msg-rx" +#define UP_USE_MSG_TX "msg-tx" + +struct up_endpoint { + struct osmo_pfcp_endpoint *pfcp_ep; + + struct llist_head peers; + + uint64_t next_seid_state; + uint32_t next_teid_state; +}; + +struct up_endpoint *up_endpoint_init(void *ctx, const struct osmo_sockaddr *local_addr); +void up_endpoint_free(struct up_endpoint **ep); + +uint64_t up_endpoint_next_seid(struct up_endpoint *ep); +uint32_t up_endpoint_next_teid(struct up_endpoint *ep); diff --git a/include/osmocom/upf/up_gtp_action.h b/include/osmocom/upf/up_gtp_action.h new file mode 100644 index 0000000..1907ed1 --- /dev/null +++ b/include/osmocom/upf/up_gtp_action.h @@ -0,0 +1,73 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <stdint.h> + +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/socket.h> +#include <osmocom/core/fsm.h> + +#include <osmocom/upf/up_session.h> +#include <osmocom/upf/upf_gtp.h> +#include <osmocom/upf/upf_nft.h> + +#define LOG_UP_GTP_ACTION(A, LEVEL, FMT, ARGS...) \ + LOGP(DGTP, LEVEL, "%s: " FMT, up_gtp_action_to_str_c(OTC_SELECT, A), ##ARGS) + +struct up_session; + +enum up_gtp_action_kind { + UP_GTP_DROP, + UP_GTP_U_ENDECAPS, + UP_GTP_U_TUNMAP, +}; + +struct up_gtp_action { + struct llist_head entry; + struct up_session *session; + + uint16_t pdr_core; + uint16_t pdr_access; + + enum up_gtp_action_kind kind; + union { + /* En-/De-capsulate GTP: add/remove a GTP header and forward the GTP payload from/to plain IP. */ + struct upf_gtp_tun_desc endecaps; + + /* Tunnel-map GTP: translate from one TEID to another and forward */ + struct upf_nft_tunmap_desc tunmap; + }; + + /* volatile loop variable to match up wanted and actually present GTP actions */ + void *handle; +}; + +int up_gtp_action_cmp(const struct up_gtp_action *a, const struct up_gtp_action *b); + +int up_gtp_action_enable(struct up_gtp_action *a); +int up_gtp_action_disable(struct up_gtp_action *a); + +int up_gtp_action_to_str_buf(char *buf, size_t buflen, const struct up_gtp_action *a); +char *up_gtp_action_to_str_c(void *ctx, const struct up_gtp_action *a); diff --git a/include/osmocom/upf/up_peer.h b/include/osmocom/upf/up_peer.h new file mode 100644 index 0000000..0c168cf --- /dev/null +++ b/include/osmocom/upf/up_peer.h @@ -0,0 +1,78 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/hashtable.h> +#include <osmocom/core/socket.h> +#include <osmocom/core/use_count.h> + +#include <osmocom/pfcp/pfcp_msg.h> + +enum up_peer_event { + UP_PEER_EV_RX_ASSOC_SETUP_REQ, + UP_PEER_EV_RX_ASSOC_UPD_REQ, + UP_PEER_EV_RX_ASSOC_REL_REQ, + UP_PEER_EV_RX_SESSION_EST_REQ, + UP_PEER_EV_HEARTBEAT_FAILURE, + UP_PEER_EV_USE_COUNT_ZERO, + UP_PEER_EV_SESSION_TERM, +}; + +struct up_peer { + struct llist_head entry; + + struct osmo_fsm_inst *fi; + struct up_endpoint *up_endpoint; + + /* peer's remote address */ + struct osmo_sockaddr remote_addr; + struct osmo_pfcp_ie_node_id remote_node_id; + uint32_t remote_recovery_timestamp; + + struct osmo_pfcp_ie_up_function_features local_up_features; + struct osmo_pfcp_ie_cp_function_features peer_cp_features; + + uint32_t next_seq_nr; + + struct osmo_fsm_inst *heartbeat_fi; + + struct osmo_use_count use_count; + struct osmo_use_count_entry use_count_buf[5]; + + DECLARE_HASHTABLE(sessions_by_up_seid, 6); + DECLARE_HASHTABLE(sessions_by_cp_seid, 6); +}; + +struct up_peer *up_peer_find_or_add(struct up_endpoint *up_ep, const struct osmo_sockaddr *remote_addr); +struct up_peer *up_peer_find(struct up_endpoint *up_ep, const struct osmo_sockaddr *remote_addr); + +void up_peer_set_msg_ctx(struct up_peer *peer, struct osmo_pfcp_msg *m); + +char *up_peer_remote_addr_str(struct up_peer *peer); + +struct osmo_pfcp_msg *up_peer_init_tx(struct up_peer *peer, struct osmo_pfcp_msg *in_reply_to, + enum osmo_pfcp_message_type message_type); + +void up_peer_free(struct up_peer *peer); diff --git a/include/osmocom/upf/up_session.h b/include/osmocom/upf/up_session.h new file mode 100644 index 0000000..5b514a7 --- /dev/null +++ b/include/osmocom/upf/up_session.h @@ -0,0 +1,117 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <stdint.h> + +#include <osmocom/core/hashtable.h> +#include <osmocom/core/use_count.h> + +#include <osmocom/pfcp/pfcp_msg.h> + +struct osmo_fsm_inst; +struct osmo_pfcp_msg; +struct up_peer; + +enum up_session_fsm_event { + UP_SESSION_EV_RX_SESSION_EST_REQ, + UP_SESSION_EV_RX_SESSION_MOD_REQ, + UP_SESSION_EV_RX_SESSION_DEL_REQ, + UP_SESSION_EV_USE_COUNT_ZERO, +}; + +enum up_session_kind { + UP_SESSION_DROP, + UP_SESSION_GTP_U_ENDECAPS, + UP_SESSION_GTP_U_FORW, +}; + +struct up_session { + struct hlist_node node_by_up_seid; + struct hlist_node node_by_cp_seid; + + struct osmo_fsm_inst *fi; + struct up_peer *up_peer; + + struct osmo_pfcp_ie_f_seid cp_f_seid; + uint64_t up_seid; + + struct osmo_use_count use_count; + struct osmo_use_count_entry use_count_buf[8]; + + struct llist_head pdrs; + struct llist_head fars; + struct llist_head chosen_f_teids; + + struct llist_head active_gtp_actions; +}; + +struct up_session *up_session_find_or_add(struct up_peer *peer, const struct osmo_pfcp_ie_f_seid *cp_f_seid, + const struct osmo_pfcp_ie_f_seid *up_f_seid); +struct up_session *up_session_find_by_up_seid(struct up_peer *peer, uint64_t up_seid); +struct up_session *up_session_find_by_cp_f_seid(struct up_peer *peer, const struct osmo_pfcp_ie_f_seid *cp_f_seid); +struct up_session *up_session_find_by_local_teid(struct up_peer *peer, uint32_t teid); + +void up_session_set_msg_ctx(struct up_session *session, struct osmo_pfcp_msg *m); + +char *up_session_gtp_status(struct up_session *session); +bool up_session_is_active(struct up_session *session); +bool up_session_is_fully_active(struct up_session *session, int *active_p, int *inactive_p); + +int up_session_discard(struct up_session *session); + +int up_session_to_str_buf(char *buf, size_t buflen, struct up_session *session); +char *up_session_to_str_c(void *ctx, struct up_session *session); + +struct pdr { + struct llist_head entry; + struct up_session *session; + + struct osmo_pfcp_ie_create_pdr desc; + struct osmo_pfcp_ie_f_teid *local_f_teid; + struct osmo_pfcp_ie_f_teid _local_f_teid_buf; + + struct far *far; + + bool rx_decaps; + bool forw_encaps; + bool forw_to_core; + bool forw_from_core; + + struct pdr *reverse_pdr; + bool active; + + char *inactive_reason; +}; + +int pdr_to_str_buf(char *buf, size_t buflen, const struct pdr *pdr); +char *pdr_to_str_c(void *ctx, const struct pdr *pdr); + +struct far { + struct llist_head entry; + struct up_session *session; + + struct osmo_pfcp_ie_create_far desc; + bool active; +}; diff --git a/include/osmocom/upf/up_session_to_gtp.c b/include/osmocom/upf/up_session_to_gtp.c new file mode 100644 index 0000000..161ba80 --- /dev/null +++ b/include/osmocom/upf/up_session_to_gtp.c @@ -0,0 +1,23 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + diff --git a/include/osmocom/upf/upf.h b/include/osmocom/upf/upf.h index c3c7849..b8065dd 100644 --- a/include/osmocom/upf/upf.h +++ b/include/osmocom/upf/upf.h @@ -24,12 +24,78 @@ #pragma once +#include <osmocom/core/tdef.h> +#include <osmocom/core/socket.h> +#include <osmocom/core/select.h> +#include <osmocom/core/linuxlist.h> + +struct osmo_tdef; struct ctrl_handle; +struct upf_gtp_dev; + +#define UPF_PFCP_LISTEN_DEFAULT "0.0.0.0" + +extern struct osmo_tdef_group g_upf_tdef_groups[]; + +struct pfcp_vty_cfg { + char *local_addr; + uint16_t local_port; +}; + +struct gtp_vty_cfg_dev { + struct llist_head entry; + + /* If true, osmo-upf creates the GTP device on startup. If false, the GTP device was created by the user, and we + * just plug into it. */ + bool create; + + /* GTP device name as shown by 'ip link', e.g. 'apn0' */ + char *dev_name; + + /* Which address the GTP device should listen on. + * When create == true, the GTP kernel module is created to listen on this address. + * Also used to listen for GTP ECHO requests using libgtp. */ + char *local_addr; +}; + +struct gtp_vty_cfg { + /* list of struct gtp_vty_cfg_dev, GTP devices as in the config file. The actual GTP devices in use are in + * g_upf->gtp.devs. */ + struct llist_head devs; +}; + struct g_upf { struct ctrl_handle *ctrl; + + struct { + struct pfcp_vty_cfg vty_cfg; + struct up_endpoint *ep; + } pfcp; + struct { + /* GTP devices as in osmo-upf.cfg */ + struct gtp_vty_cfg vty_cfg; + + /* GTP devices actually in use, list of struct upf_gtp_dev. */ + struct llist_head devs; + + struct mnl_socket *nl; + int32_t genl_id; + } gtp; }; extern struct g_upf *g_upf; +enum upf_log_subsys { + DREF, + DPEER, + DSESSION, + DGTP, +}; + void g_upf_alloc(void *ctx); +void upf_vty_init(); +int upf_pfcp_listen(); + +int upf_gtp_devs_open(); +void upf_gtp_devs_close(); diff --git a/include/osmocom/upf/upf_gtp.h b/include/osmocom/upf/upf_gtp.h new file mode 100644 index 0000000..a67c850 --- /dev/null +++ b/include/osmocom/upf/upf_gtp.h @@ -0,0 +1,85 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/select.h> +#include <osmocom/core/logging.h> + +#define LOG_GTP_DEV(DEV, LEVEL, FMT, ARGS...) \ + LOGP(DGTP, LEVEL, "%s: " FMT, upf_gtp_dev_to_str_c(OTC_SELECT, (DEV)), ##ARGS) + +#define PORT_GTP0_C 3386 +#define PORT_GTP0_U 3386 + +#define PORT_GTP1_C 2123 +#define PORT_GTP1_U 2152 + +struct upf_gtp_dev { + struct llist_head entry; + + /* If true, osmo-upf created this GTP device on startup and will destroy it on program exit. If false, the user + * has created the device and osmo-upf will not destroy it. */ + bool created; + + char *name; + struct { + bool enabled; + struct osmo_sockaddr local_addr; + struct osmo_fd ofd; + } gtpv0; + struct { + struct osmo_sockaddr local_addr; + struct osmo_fd ofd; + } gtpv1; + bool sgsn_mode; + + uint32_t ifidx; + + struct llist_head tunnels; +}; + +struct upf_gtp_tun_desc { + uint32_t local_teid; + uint32_t remote_teid; + struct osmo_sockaddr ue_addr; + struct osmo_sockaddr gtp_remote_addr; +}; + +int upf_gtp_tun_desc_cmp(const struct upf_gtp_tun_desc *a, const struct upf_gtp_tun_desc *b); + +int upf_gtp_genl_open(); +void upf_gtp_genl_close(); + +int upf_gtp_dev_open(const char *name, bool create_gtp_dev, const char *local_addr, bool listen_for_gtpv0, + bool sgsn_mode); +struct upf_gtp_dev *upf_gtp_dev_find_by_name(const char *name); +struct upf_gtp_dev *upf_gtp_dev_first(); + +int upf_gtp_dev_tunnel_add(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *t); +bool upf_gtp_dev_is_tunnel_active(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *t); +int upf_gtp_dev_tunnel_del(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *t); + +int upf_gtp_dev_to_str_buf(char *buf, size_t buflen, const struct upf_gtp_dev *dev); +char *upf_gtp_dev_to_str_c(void *ctx, const struct upf_gtp_dev *dev); diff --git a/include/osmocom/upf/upf_nft.h b/include/osmocom/upf/upf_nft.h new file mode 100644 index 0000000..569eadb --- /dev/null +++ b/include/osmocom/upf/upf_nft.h @@ -0,0 +1,48 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <stdint.h> + +#include <osmocom/core/socket.h> + +struct upf_nft_tunmap_desc { + struct { + struct osmo_sockaddr gtp_remote_addr; + uint32_t local_teid; + uint32_t remote_teid; + } access; + struct { + struct osmo_sockaddr gtp_remote_addr; + uint32_t local_teid; + uint32_t remote_teid; + } core; + uint32_t id; +}; + +int upf_nft_init(); +int upf_nft_free(); + +int upf_nft_tunmap_create(struct upf_nft_tunmap_desc *tunmap); +int upf_nft_tunmap_delete(struct upf_nft_tunmap_desc *tunmap); diff --git a/src/osmo-upf/Makefile.am b/src/osmo-upf/Makefile.am index ec04fc7..d8aa5a0 100644 --- a/src/osmo-upf/Makefile.am +++ b/src/osmo-upf/Makefile.am @@ -1,6 +1,7 @@ AM_CPPFLAGS = \ $(all_includes) \ -I$(top_srcdir)/include \ + -I$(top_builddir)/include \ -I$(top_builddir) \ $(NULL) @@ -9,10 +10,14 @@ $(LIBOSMOCORE_CFLAGS) \ $(LIBOSMOVTY_CFLAGS) \ $(LIBOSMOCTRL_CFLAGS) \ + $(LIBOSMOGTLV_CFLAGS) \ + $(LIBOSMOPFCP_CFLAGS) \ + $(LIBGTPNL_CFLAGS) \ $(COVERAGE_CFLAGS) \ $(NULL) AM_LDFLAGS = \ + $(LIBGTPNL_LDFLAGS) \ $(COVERAGE_LDFLAGS) \ $(NULL) @@ -22,12 +27,21 @@ osmo_upf_SOURCES = \ osmo_upf_main.c \ + up_endpoint.c \ + up_gtp_action.c \ + up_peer.c \ + up_session.c \ upf.c \ + upf_gtp.c \ + upf_vty.c \ $(NULL) osmo_upf_LDADD = \ $(LIBOSMOCORE_LIBS) \ $(LIBOSMOVTY_LIBS) \ $(LIBOSMOCTRL_LIBS) \ + $(LIBOSMOGTLV_LIBS) \ + $(LIBOSMOPFCP_LIBS) \ + $(LIBGTPNL_LIBS) \ $(COVERAGE_LDFLAGS) \ $(NULL) diff --git a/src/osmo-upf/osmo_upf_main.c b/src/osmo-upf/osmo_upf_main.c index f81eab1..302d957 100644 --- a/src/osmo-upf/osmo_upf_main.c +++ b/src/osmo-upf/osmo_upf_main.c @@ -34,11 +34,16 @@ #include <osmocom/vty/cpu_sched_vty.h> #include <osmocom/vty/telnet_interface.h> #include <osmocom/vty/ports.h> +#include <osmocom/vty/tdef_vty.h> #include <osmocom/ctrl/control_if.h> #include <osmocom/ctrl/control_vty.h> #include <osmocom/ctrl/ports.h> +#include <osmocom/pfcp/pfcp_endpoint.h> + #include <osmocom/upf/upf.h> +#include <osmocom/upf/up_endpoint.h> +#include <osmocom/upf/upf_gtp.h> #define _GNU_SOURCE #include <getopt.h> @@ -48,6 +53,7 @@ #include <signal.h> #include <stdio.h> +#include <string.h> extern void *tall_vty_ctx; @@ -207,6 +213,30 @@ }; static const struct log_info_cat upf_default_categories[] = { + [DREF] = { + .name = "DREF", + .description = "Reference Counting", + .enabled = 0, .loglevel = LOGL_NOTICE, + .color = OSMO_LOGCOLOR_DARKGREY, + }, + [DPEER] = { + .name = "DPEER", + .description = "PFCP peer association", + .enabled = 0, .loglevel = LOGL_NOTICE, + .color = OSMO_LOGCOLOR_YELLOW, + }, + [DSESSION] = { + .name = "DSESSION", + .description = "PFCP sessions", + .enabled = 0, .loglevel = LOGL_NOTICE, + .color = OSMO_LOGCOLOR_BLUE, + }, + [DGTP] = { + .name = "DGTP", + .description = "GTP tunneling", + .enabled = 0, .loglevel = LOGL_NOTICE, + .color = OSMO_LOGCOLOR_PURPLE, + }, }; const struct log_info log_info = { @@ -217,19 +247,27 @@ int main(int argc, char **argv) { int rc; + void *tall_infra_ctx; /* Track the use of talloc NULL memory contexts */ talloc_enable_null_tracking(); osmo_fsm_set_dealloc_ctx(OTC_SELECT); - tall_upf_ctx = talloc_named_const(NULL, 1, "osmo-upf"); + tall_infra_ctx = talloc_named_const(NULL, 1, "osmo-upf"); + tall_upf_ctx = talloc_named_const(tall_infra_ctx, 1, "osmo-upf-main"); upf_vty_app_info.tall_ctx = tall_upf_ctx; msgb_talloc_ctx_init(tall_upf_ctx, 0); osmo_signal_talloc_ctx_init(tall_upf_ctx); - osmo_init_logging2(tall_upf_ctx, &log_info); + osmo_init_logging2(tall_infra_ctx, &log_info); + log_set_print_category_hex(osmo_stderr_target, 0); + log_set_print_category(osmo_stderr_target, 1); + log_set_print_level(osmo_stderr_target, 1); + log_set_print_filename2(osmo_stderr_target, LOG_FILENAME_BASENAME); + log_set_print_filename_pos(osmo_stderr_target, LOG_FILENAME_POS_LINE_END); + log_set_print_extended_timestamp(osmo_stderr_target, 1); osmo_fsm_log_timeouts(true); osmo_fsm_log_addr(true); @@ -246,6 +284,9 @@ osmo_talloc_vty_add_cmds(); osmo_cpu_sched_vty_init(tall_upf_ctx); + upf_vty_init(); + osmo_tdef_vty_groups_init(CONFIG_NODE, g_upf_tdef_groups); + /* Parse options */ handle_options(argc, argv); @@ -283,6 +324,15 @@ } } + if (upf_gtp_genl_open()) + return -1; + + if (upf_gtp_devs_open()) + return -1; + + if (upf_pfcp_listen()) + return -1; + do { log_reset_context(); osmo_select_main_ctx(0); @@ -301,12 +351,20 @@ } } while (!osmo_select_shutdown_done()); - log_fini(); + up_endpoint_free(&g_upf->pfcp.ep); + upf_gtp_devs_close(); + + upf_gtp_genl_close(); /* Report the heap state of talloc contexts, then free, so both ASAN and Valgrind are happy... */ talloc_report_full(tall_upf_ctx, stderr); talloc_free(tall_upf_ctx); + log_fini(); + + talloc_report_full(tall_infra_ctx, stderr); + talloc_free(tall_infra_ctx); + talloc_report_full(tall_vty_ctx, stderr); talloc_free(tall_vty_ctx); diff --git a/src/osmo-upf/up_endpoint.c b/src/osmo-upf/up_endpoint.c new file mode 100644 index 0000000..b33e112 --- /dev/null +++ b/src/osmo-upf/up_endpoint.c @@ -0,0 +1,322 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <osmocom/pfcp/pfcp_endpoint.h> +#include <osmocom/pfcp/pfcp_msg.h> + +#include <osmocom/upf/up_endpoint.h> +#include <osmocom/upf/up_peer.h> +#include <osmocom/upf/up_session.h> + +static void up_endpoint_set_msg_ctx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m, struct osmo_pfcp_msg *req) +{ + struct up_endpoint *up_ep = ep->priv; + struct up_peer *peer; + + /* If this is a response to an earlier request, just take the msg context from the request message. */ + if (req) { + if (!m->ctx.peer_fi && req->ctx.peer_fi) + up_peer_set_msg_ctx(req->ctx.peer_fi->priv, m); + if (!m->ctx.session_fi && req->ctx.session_fi) + up_session_set_msg_ctx(req->ctx.peer_fi->priv, m); + } + + /* From the remote address, find the matching peer instance */ + if (!m->ctx.peer_fi) { + peer = up_peer_find(up_ep, &m->remote_addr); + if (peer) { + up_peer_set_msg_ctx(peer, m); + } + } else { + peer = m->ctx.peer_fi->priv; + } + + /* Find a session, if the header is parsed yet and contains a SEID */ + if (peer && !m->ctx.session_fi && m->h.seid_present) { + struct up_session *session; + session = up_session_find_by_up_seid(peer, m->h.seid); + if (session) { + up_session_set_msg_ctx(session, m); + } + } +} + +static void up_ep_rx_not_impl_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m, + enum osmo_pfcp_message_type resp_msgt, + const struct osmo_pfcp_ie_node_id *node_id, enum osmo_pfcp_cause cause) +{ + struct osmo_pfcp_msg *tx; + enum osmo_pfcp_cause *tx_cause; + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "message type not implemented\n"); + tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, &up_ep->pfcp_ep->cfg.local_node_id, m, resp_msgt); + tx_cause = osmo_pfcp_msg_cause(tx); + if (tx_cause) + *tx_cause = cause; + osmo_pfcp_endpoint_tx(up_ep->pfcp_ep, tx); +} + +static void up_ep_rx_pfd_mgmt_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + up_ep_rx_not_impl_req(up_ep, m, OSMO_PFCP_MSGT_PFD_MGMT_RESP, NULL, OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED); +} + +static void up_ep_rx_assoc_setup_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + struct up_peer *peer = m->ctx.peer_fi ? m->ctx.peer_fi->priv : NULL; + if (!peer) { + peer = up_peer_find_or_add(up_ep, &m->remote_addr); + OSMO_ASSERT(peer); + } + osmo_fsm_inst_dispatch(peer->fi, UP_PEER_EV_RX_ASSOC_SETUP_REQ, (void *)m); +} + +static void up_ep_rx_assoc_upd_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + if (!m->ctx.peer_fi) { + struct osmo_pfcp_msg *tx; + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Peer is not associated, cannot update association\n"); + tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, &up_ep->pfcp_ep->cfg.local_node_id, m, OSMO_PFCP_MSGT_ASSOC_UPDATE_RESP); + /* FIXME set node_id, cause */ + osmo_pfcp_endpoint_tx(up_ep->pfcp_ep, tx); + return; + } + osmo_fsm_inst_dispatch(m->ctx.peer_fi, UP_PEER_EV_RX_ASSOC_UPD_REQ, (void *)m); +} + +static void up_ep_rx_assoc_rel_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + if (!m->ctx.peer_fi) { + struct osmo_pfcp_msg *tx; + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Peer is not associated. Sending ACK response anyway\n"); + tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, &up_ep->pfcp_ep->cfg.local_node_id, m, OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP); + /* FIXME set node_id, cause */ + osmo_pfcp_endpoint_tx(up_ep->pfcp_ep, tx); + return; + } + osmo_fsm_inst_dispatch(m->ctx.peer_fi, UP_PEER_EV_RX_ASSOC_REL_REQ, (void *)m); +} + +static void up_ep_rx_node_report_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + up_ep_rx_not_impl_req(up_ep, m, OSMO_PFCP_MSGT_NODE_REPORT_RESP, NULL /* FIXME? */, + OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED); +} + +static void up_ep_rx_session_set_del_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + up_ep_rx_not_impl_req(up_ep, m, OSMO_PFCP_MSGT_SESSION_SET_DEL_RESP, + &up_ep->pfcp_ep->cfg.local_node_id, OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED); +} + +static void up_ep_rx_session_est_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + if (!m->ctx.peer_fi) { + struct osmo_pfcp_msg *tx; + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Peer is not associated, cannot establish session\n"); + tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, &up_ep->pfcp_ep->cfg.local_node_id, m, OSMO_PFCP_MSGT_SESSION_EST_RESP); + tx->ies.session_est_resp.cause = OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC; + osmo_pfcp_endpoint_tx(up_ep->pfcp_ep, tx); + return; + } + osmo_fsm_inst_dispatch(m->ctx.peer_fi, UP_PEER_EV_RX_SESSION_EST_REQ, (void *)m); +} + +static void up_ep_rx_session_mod_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + if (!m->ctx.session_fi) { + /* Session not found. */ + struct osmo_pfcp_msg *tx; + tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, &up_ep->pfcp_ep->cfg.local_node_id, m, + OSMO_PFCP_MSGT_SESSION_MOD_RESP); + if (!m->ctx.peer_fi) { + /* Not even the peer is associated. */ + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Peer is not associated, cannot modify session\n"); + tx->ies.session_mod_resp.cause = OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC; + } else { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, + "No established session with SEID=0x%"PRIx64", cannot modify\n", + m->h.seid); + tx->ies.session_mod_resp.cause = OSMO_PFCP_CAUSE_SESSION_CTX_NOT_FOUND; + } + osmo_pfcp_endpoint_tx(up_ep->pfcp_ep, tx); + return; + } + osmo_fsm_inst_dispatch(m->ctx.session_fi, UP_SESSION_EV_RX_SESSION_MOD_REQ, (void *)m); +} + +static void up_ep_rx_session_del_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + if (!m->ctx.session_fi) { + /* Session not found. */ + struct osmo_pfcp_msg *tx; + tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, &up_ep->pfcp_ep->cfg.local_node_id, m, OSMO_PFCP_MSGT_SESSION_DEL_RESP); + if (!m->ctx.peer_fi) { + /* Not even the peer is associated. */ + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Peer is not associated, cannot delete session\n"); + tx->ies.session_del_resp.cause = OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC; + } else { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, + "No established session with SEID=0x%"PRIx64", cannot delete\n", + m->h.seid); + tx->ies.session_del_resp.cause = OSMO_PFCP_CAUSE_SESSION_CTX_NOT_FOUND; + } + osmo_pfcp_endpoint_tx(up_ep->pfcp_ep, tx); + return; + } + osmo_fsm_inst_dispatch(m->ctx.session_fi, UP_SESSION_EV_RX_SESSION_DEL_REQ, (void *)m); +} + +static void up_ep_rx_session_rep_req(struct up_endpoint *up_ep, const struct osmo_pfcp_msg *m) +{ + up_ep_rx_not_impl_req(up_ep, m, OSMO_PFCP_MSGT_SESSION_REP_RESP, NULL, OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED); +} + +static void up_endpoint_rx_cb(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m, struct osmo_pfcp_msg *req) +{ + struct up_endpoint *up_ep = ep->priv; + + switch (m->h.message_type) { + case OSMO_PFCP_MSGT_PFD_MGMT_REQ: + up_ep_rx_pfd_mgmt_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_ASSOC_SETUP_REQ: + up_ep_rx_assoc_setup_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_ASSOC_UPDATE_REQ: + up_ep_rx_assoc_upd_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_ASSOC_RELEASE_REQ: + up_ep_rx_assoc_rel_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_NODE_REPORT_REQ: + up_ep_rx_node_report_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_SESSION_SET_DEL_REQ: + up_ep_rx_session_set_del_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_SESSION_EST_REQ: + up_ep_rx_session_est_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_SESSION_MOD_REQ: + up_ep_rx_session_mod_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_SESSION_DEL_REQ: + up_ep_rx_session_del_req(up_ep, m); + return; + case OSMO_PFCP_MSGT_SESSION_REP_REQ: + up_ep_rx_session_rep_req(up_ep, m); + return; + default: + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Unknown message type\n"); + return; + } +} + +struct up_endpoint *up_endpoint_init(void *ctx, const struct osmo_sockaddr *local_addr) +{ + int rc; + struct up_endpoint *up_ep; + up_ep = talloc_zero(ctx, struct up_endpoint); + INIT_LLIST_HEAD(&up_ep->peers); + + up_ep->pfcp_ep = osmo_pfcp_endpoint_create(up_ep, up_ep); + up_ep->pfcp_ep->cfg.local_addr = *local_addr; + + up_ep->pfcp_ep->set_msg_ctx = up_endpoint_set_msg_ctx; + up_ep->pfcp_ep->rx_msg = up_endpoint_rx_cb; + + osmo_pfcp_ie_node_id_from_osmo_sockaddr(&up_ep->pfcp_ep->cfg.local_node_id, local_addr); + + rc = osmo_pfcp_endpoint_bind(up_ep->pfcp_ep); + if (rc) { + talloc_free(up_ep); + return NULL; + } + return up_ep; +} + +static struct up_session *up_endpoint_find_session(struct up_endpoint *ep, uint64_t up_seid) +{ + struct up_peer *peer; + llist_for_each_entry(peer, &ep->peers, entry) { + struct up_session *session = up_session_find_by_up_seid(peer, up_seid); + if (session) + return session; + } + return NULL; +} + +static struct up_session *up_endpoint_find_session_by_local_teid(struct up_endpoint *ep, uint32_t teid) +{ + struct up_peer *peer; + llist_for_each_entry(peer, &ep->peers, entry) { + struct up_session *session = up_session_find_by_local_teid(peer, teid); + if (session) + return session; + } + return NULL; +} + +uint64_t up_endpoint_next_seid(struct up_endpoint *ep) +{ + uint64_t sanity; + for (sanity = 2342; sanity; sanity--) { + uint64_t next_seid = osmo_pfcp_next_seid(&ep->next_seid_state); + if (up_endpoint_find_session(ep, next_seid)) + continue; + return next_seid; + } + return 0; +} + +static uint32_t up_endpoint_inc_teid(struct up_endpoint *ep) +{ + ep->next_teid_state++; + if (!ep->next_teid_state) + ep->next_teid_state++; + return ep->next_teid_state; +} + +uint32_t up_endpoint_next_teid(struct up_endpoint *ep) +{ + uint32_t sanity; + for (sanity = 2342; sanity; sanity--) { + uint32_t next_teid = up_endpoint_inc_teid(ep); + if (up_endpoint_find_session_by_local_teid(ep, next_teid)) + continue; + return next_teid; + } + return 0; +} + +void up_endpoint_free(struct up_endpoint **_ep) +{ + struct up_peer *peer; + struct up_endpoint *ep = *_ep; + + while ((peer = llist_first_entry_or_null(&ep->peers, struct up_peer, entry))) + up_peer_free(peer); + + osmo_pfcp_endpoint_free(&ep->pfcp_ep); + *_ep = NULL; +} diff --git a/src/osmo-upf/up_gtp_action.c b/src/osmo-upf/up_gtp_action.c new file mode 100644 index 0000000..47aa3ac --- /dev/null +++ b/src/osmo-upf/up_gtp_action.c @@ -0,0 +1,162 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <errno.h> +#include <string.h> + +#include <osmocom/core/utils.h> + +#include <osmocom/upf/upf.h> +#include <osmocom/upf/up_gtp_action.h> +#include <osmocom/upf/up_peer.h> +#include <osmocom/upf/up_session.h> + +int up_gtp_action_cmp(const struct up_gtp_action *a, const struct up_gtp_action *b) +{ + int cmp; + if (a == b) + return 0; + if (!a) + return -1; + if (!b) + return 1; + +#define CMP_MEMB(MEMB) OSMO_CMP(a->MEMB, b->MEMB) + + if ((cmp = CMP_MEMB(kind))) + return cmp; + + switch (a->kind) { + case UP_GTP_U_ENDECAPS: + if ((cmp = CMP_MEMB(endecaps.local_teid))) + return cmp; + if ((cmp = CMP_MEMB(endecaps.remote_teid))) + return cmp; + cmp = osmo_sockaddr_cmp(&a->endecaps.gtp_remote_addr, &b->endecaps.gtp_remote_addr); + if (cmp) + return cmp; + cmp = osmo_sockaddr_cmp(&a->endecaps.ue_addr, &b->endecaps.ue_addr); + if (cmp) + return cmp; + break; + + case UP_GTP_U_TUNMAP: + if ((cmp = CMP_MEMB(tunmap.access.local_teid))) + return cmp; + if ((cmp = CMP_MEMB(tunmap.access.remote_teid))) + return cmp; + if ((cmp = CMP_MEMB(tunmap.core.local_teid))) + return cmp; + if ((cmp = CMP_MEMB(tunmap.core.remote_teid))) + return cmp; + break; + default: + break; + } + return 0; +} + +static int up_gtp_action_enable_disable(struct up_gtp_action *a, bool enable) +{ + struct upf_gtp_dev *gtp_dev; + int rc; + + switch (a->kind) { + case UP_GTP_U_ENDECAPS: + /* use the first available GTP device. + * TODO: select by interface name? + */ + gtp_dev = upf_gtp_dev_first(); + if (!gtp_dev) { + LOG_UP_GTP_ACTION(a, LOGL_ERROR, "No GTP device open, cannot %s\n", enable ? "enable" : "disable"); + return -EIO; + } + + if (enable) + rc = upf_gtp_dev_tunnel_add(gtp_dev, &a->endecaps); + else + rc = upf_gtp_dev_tunnel_del(gtp_dev, &a->endecaps); + if (rc) { + LOG_UP_GTP_ACTION(a, LOGL_ERROR, "Failed to %s GTP tunnel: %d %s\n", + enable ? "enable" : "disable", rc, strerror(-rc)); + return rc; + } + LOG_UP_GTP_ACTION(a, LOGL_NOTICE, "%s GTP tunnel\n", enable ? "Enabled" : "Disabled"); + return 0; + case UP_GTP_U_TUNMAP: + LOG_UP_GTP_ACTION(a, LOGL_ERROR, "TEID translation not yet implemented\n"); + return -ENOTSUP; + default: + LOG_UP_GTP_ACTION(a, LOGL_ERROR, "Invalid action\n"); + return -ENOTSUP; + } +} + +int up_gtp_action_enable(struct up_gtp_action *a) +{ + return up_gtp_action_enable_disable(a, true); +} + +int up_gtp_action_disable(struct up_gtp_action *a) +{ + return up_gtp_action_enable_disable(a, false); +} + +int up_gtp_action_to_str_buf(char *buf, size_t buflen, const struct up_gtp_action *a) +{ + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + switch (a->kind) { + case UP_GTP_U_ENDECAPS: + OSMO_STRBUF_PRINTF(sb, "GTP:endecaps GTP-access:"); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &a->endecaps.gtp_remote_addr); + OSMO_STRBUF_PRINTF(sb, " TEID-r:0x%"PRIx32" TEID-l:0x%"PRIx32" IP-core:", + a->endecaps.remote_teid, a->endecaps.local_teid); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &a->endecaps.ue_addr); + break; + case UP_GTP_U_TUNMAP: + OSMO_STRBUF_PRINTF(sb, "GTP:tunmap GTP-access:"); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &a->tunmap.access.gtp_remote_addr); + OSMO_STRBUF_PRINTF(sb, " TEID-access-r:0x%"PRIx32" TEID-access-l:0x%"PRIx32" GTP-core:", + a->tunmap.access.remote_teid, a->tunmap.access.local_teid); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &a->tunmap.core.gtp_remote_addr); + OSMO_STRBUF_PRINTF(sb, " TEID-core-r:0x%"PRIx32" TEID-core-l:0x%"PRIx32, + a->tunmap.core.remote_teid, a->tunmap.core.local_teid); + break; + case UP_GTP_DROP: + OSMO_STRBUF_PRINTF(sb, "GTP:drop"); + break; + default: + OSMO_STRBUF_PRINTF(sb, "GTP:?"); + break; + } + if (a->session) + OSMO_STRBUF_PRINTF(sb, " PFCP-peer:%s SEID-l:0x%"PRIx64" PDR:%d,%d", + up_peer_remote_addr_str(a->session->up_peer), + a->session->up_seid, a->pdr_core, a->pdr_access); + return sb.chars_needed; +} + +char *up_gtp_action_to_str_c(void *ctx, const struct up_gtp_action *a) +{ + OSMO_NAME_C_IMPL(ctx, 128, "ERROR", up_gtp_action_to_str_buf, a) +} diff --git a/src/osmo-upf/up_peer.c b/src/osmo-upf/up_peer.c new file mode 100644 index 0000000..d0d7dbd --- /dev/null +++ b/src/osmo-upf/up_peer.c @@ -0,0 +1,545 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <errno.h> + +#include <osmocom/core/fsm.h> +#include <osmocom/core/logging.h> +#include <osmocom/core/tdef.h> +#include <osmocom/core/utils.h> + +#include <osmocom/pfcp/pfcp_msg.h> +#include <osmocom/pfcp/pfcp_endpoint.h> + +#include <osmocom/upf/upf.h> +#include <osmocom/upf/up_peer.h> +#include <osmocom/upf/up_endpoint.h> +#include <osmocom/upf/up_session.h> + +enum up_peer_fsm_state { + UP_PEER_ST_NOT_ASSOCIATED, + UP_PEER_ST_ASSOCIATED, + UP_PEER_ST_GRACEFUL_RELEASE, + UP_PEER_ST_WAIT_USE_COUNT, +}; + +static const struct value_string up_peer_fsm_event_names[] = { + OSMO_VALUE_STRING(UP_PEER_EV_RX_ASSOC_SETUP_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_RX_ASSOC_UPD_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_RX_ASSOC_REL_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_RX_SESSION_EST_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_HEARTBEAT_FAILURE), + OSMO_VALUE_STRING(UP_PEER_EV_USE_COUNT_ZERO), + OSMO_VALUE_STRING(UP_PEER_EV_SESSION_TERM), + {} +}; + +static struct osmo_fsm up_peer_fsm; + +static const struct osmo_tdef_state_timeout up_peer_fsm_timeouts[32] = { + [UP_PEER_ST_GRACEFUL_RELEASE] = { .T = -21 }, +}; + +/* Transition to a state, using the T timer defined in up_peer_fsm_timeouts. + * Assumes local variable fi exists. */ +#define up_peer_fsm_state_chg(state) \ + osmo_tdef_fsm_inst_state_chg(fi, state, \ + up_peer_fsm_timeouts, \ + osmo_pfcp_tdefs, \ + 5) + +static int up_peer_use_cb(struct osmo_use_count_entry *e, int32_t old_use_count, const char *file, int line) +{ + struct up_peer *peer = e->use_count->talloc_object; + int32_t total; + int level; + + if (!e->use) + return -EINVAL; + + total = osmo_use_count_total(&peer->use_count); + + if (total == 0 + || (total == 1 && old_use_count == 0 && e->count == 1)) + level = LOGL_INFO; + else + level = LOGL_DEBUG; + + LOGPFSMSLSRC(peer->fi, DREF, level, file, line, + "%s %s: now used by %s\n", + (e->count - old_use_count) > 0 ? "+" : "-", e->use, + osmo_use_count_to_str_c(OTC_SELECT, &peer->use_count)); + + if (e->count < 0) + return -ERANGE; + + if (total == 0) + osmo_fsm_inst_dispatch(peer->fi, UP_PEER_EV_USE_COUNT_ZERO, NULL); + return 0; +} + +char *up_peer_remote_addr_str(struct up_peer *peer) +{ + struct osmo_sockaddr remote_addr = peer->remote_addr; + + /* Zero the port, it is not interesting information. The port for PFCP is defined fixed, and there is no use + * printing it in the logs */ + osmo_sockaddr_set_port(&remote_addr.u.sa, 0); + + return osmo_sockaddr_to_str_c(OTC_SELECT, &remote_addr); +} + +static void up_peer_update_id(struct up_peer *peer) +{ + osmo_fsm_inst_update_id_f_sanitize(peer->fi, '-', "%s", up_peer_remote_addr_str(peer)); + LOGPFSML(peer->fi, LOGL_DEBUG, "Updated id\n"); +} + +static struct up_peer *up_peer_add(struct up_endpoint *up_endpoint, const struct osmo_sockaddr *remote_addr) +{ + struct up_peer *peer; + + struct osmo_fsm_inst *fi = osmo_fsm_inst_alloc(&up_peer_fsm, up_endpoint, NULL, LOGL_DEBUG, NULL); + OSMO_ASSERT(fi); + + peer = talloc(fi, struct up_peer); + OSMO_ASSERT(peer); + fi->priv = peer; + + *peer = (struct up_peer) { + .fi = fi, + .up_endpoint = up_endpoint, + .remote_addr = *remote_addr, + .heartbeat_fi = NULL /* FIXME */, + .use_count = { + .talloc_object = peer, + .use_cb = up_peer_use_cb, + }, + }; + osmo_use_count_make_static_entries(&peer->use_count, peer->use_count_buf, ARRAY_SIZE(peer->use_count_buf)); + hash_init(peer->sessions_by_up_seid); + hash_init(peer->sessions_by_cp_seid); + + osmo_pfcp_bits_set(peer->local_up_features.bits, OSMO_PFCP_UP_FEAT_BUNDL, true); + osmo_pfcp_bits_set(peer->local_up_features.bits, OSMO_PFCP_UP_FEAT_RTTL, true); + osmo_pfcp_bits_set(peer->local_up_features.bits, OSMO_PFCP_UP_FEAT_FTUP, true); + + up_peer_update_id(peer); + + llist_add(&peer->entry, &up_endpoint->peers); + return peer; +} + +struct up_peer *up_peer_find(struct up_endpoint *up_endpoint, const struct osmo_sockaddr *remote_addr) +{ + struct up_peer *peer; + llist_for_each_entry(peer, &up_endpoint->peers, entry) { + if (osmo_sockaddr_cmp(&peer->remote_addr, remote_addr)) + continue; + return peer; + } + return NULL; +} + +struct up_peer *up_peer_find_or_add(struct up_endpoint *up_endpoint, const struct osmo_sockaddr *remote_addr) +{ + struct up_peer *peer = up_peer_find(up_endpoint, remote_addr); + if (peer) + return peer; + return up_peer_add(up_endpoint, remote_addr); +} + +int up_peer_tx(struct up_peer *peer, struct osmo_pfcp_msg *m) +{ + return osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, m); +} + +static int up_peer_fsm_timer_cb(struct osmo_fsm_inst *fi) +{ + //struct up_peer *peer = fi->priv; + /* Return 1 to terminate FSM instance, 0 to keep running */ + return 1; +} + +void up_peer_set_msg_ctx(struct up_peer *peer, struct osmo_pfcp_msg *m) +{ + OSMO_ASSERT(!m->ctx.peer_fi); + + m->ctx.peer_fi = peer->fi; + m->ctx.peer_use_count = &peer->use_count; + m->ctx.peer_use_token = (m->rx ? UP_USE_MSG_RX : UP_USE_MSG_TX); + osmo_use_count_get_put(m->ctx.peer_use_count, m->ctx.peer_use_token, 1); +} + +struct osmo_pfcp_msg *up_peer_init_tx(struct up_peer *peer, struct osmo_pfcp_msg *in_reply_to, + enum osmo_pfcp_message_type message_type) +{ + struct osmo_pfcp_msg *tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, &peer->remote_addr, + &peer->up_endpoint->pfcp_ep->cfg.local_node_id, + in_reply_to, message_type); + up_peer_set_msg_ctx(peer, tx); + return tx; +} + +static int up_peer_tx_assoc_setup_resp(struct up_peer *peer, struct osmo_pfcp_msg *m, enum osmo_pfcp_cause cause) +{ + struct osmo_pfcp_msg *resp; + + resp = up_peer_init_tx(peer, m, OSMO_PFCP_MSGT_ASSOC_SETUP_RESP); + + resp->ies.assoc_setup_resp = (struct osmo_pfcp_msg_assoc_setup_resp) { + .cause = cause, + .recovery_time_stamp = g_upf->pfcp.ep->pfcp_ep->recovery_time_stamp, + .up_function_features_present = true, + .up_function_features = peer->local_up_features, + }; + resp->ies.assoc_setup_resp.recovery_time_stamp = g_upf->pfcp.ep->pfcp_ep->recovery_time_stamp; + + if (osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, resp)) { + OSMO_LOG_PFCP_MSG(resp, LOGL_ERROR, "Error sending response, cannot associate with peer\n"); + return -EIO; + } + return 0; +} + +static int up_peer_tx_assoc_rel_resp(struct up_peer *peer, struct osmo_pfcp_msg *m, enum osmo_pfcp_cause cause) +{ + struct osmo_pfcp_msg *resp; + + resp = up_peer_init_tx(peer, m, OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP); + + resp->ies.assoc_release_resp = (struct osmo_pfcp_msg_assoc_release_resp) { + .cause = cause, + }; + + if (osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, resp)) { + OSMO_LOG_PFCP_MSG(resp, LOGL_ERROR, "Error sending response\n"); + return -EIO; + } + return 0; +} + +static void up_peer_clear_sessions(struct up_peer *peer) +{ + struct up_session *session; + int bkt; + struct hlist_node *tmp; + int count = 0; + hash_for_each_safe(peer->sessions_by_up_seid, bkt, tmp, session, node_by_up_seid) { + count += up_session_discard(session); + } + if (count) + LOGPFSML(peer->fi, LOGL_NOTICE, "terminated %d sessions\n", count); +} + +static void up_peer_rx_assoc_setup_req(struct up_peer *peer, struct osmo_pfcp_msg *m) +{ + struct osmo_fsm_inst *fi = peer->fi; + enum osmo_pfcp_cause cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED; + + if (fi->state == UP_PEER_ST_ASSOCIATED) { + /* Retransmissions of the ACK response happen in pfcp_endpoint.c. So if we get this, it is a genuine + * duplicate association setup request. We could reject it. But why. Just "replace" with the new + * association. Continue. */ + /* If the peer has restarted, it has forgotten about all sessions. */ + if (peer->remote_recovery_timestamp != m->ies.assoc_setup_req.recovery_time_stamp) { + LOGPFSML(fi, LOGL_NOTICE, "another Association Setup Request, with different Recovery Timestamp." + " Clearing sessions, sending ACK.\n"); + up_peer_clear_sessions(peer); + } else { + LOGPFSML(fi, LOGL_NOTICE, "another Association Setup Request, with same Recovery Timestamp." + " Keeping sessions, sending ACK.\n"); + } + } else if (up_peer_fsm_state_chg(UP_PEER_ST_ASSOCIATED)) { + /* Not allowed to transition to ST_ASSOCIATED */ + cause = OSMO_PFCP_CAUSE_REQUEST_REJECTED; + } else { + /* Successfully transitioned to ST_ASSOCIATED */ + peer->remote_recovery_timestamp = m->ies.assoc_setup_req.recovery_time_stamp; + peer->remote_node_id = m->ies.assoc_setup_req.node_id; + if (m->ies.assoc_setup_req.cp_function_features_present) + peer->peer_cp_features = m->ies.assoc_setup_req.cp_function_features; + } + + if (up_peer_tx_assoc_setup_resp(peer, m, cause) + || cause != OSMO_PFCP_CAUSE_REQUEST_ACCEPTED) + up_peer_fsm_state_chg(UP_PEER_ST_WAIT_USE_COUNT); + + LOGPFSML(fi, LOGL_NOTICE, "Peer associated, Node-Id=%s. Local UP features: [%s]; Peer CP features: [%s]\n", + osmo_pfcp_ie_node_id_to_str_c(OTC_SELECT, &peer->remote_node_id), + osmo_pfcp_bits_to_str_c(OTC_SELECT, peer->local_up_features.bits, osmo_pfcp_up_feature_strs), + osmo_pfcp_bits_to_str_c(OTC_SELECT, peer->peer_cp_features.bits, osmo_pfcp_cp_feature_strs)); +} + +static void up_peer_rx_assoc_rel_req(struct up_peer *peer, struct osmo_pfcp_msg *m) +{ + struct osmo_fsm_inst *fi = peer->fi; + up_peer_tx_assoc_rel_resp(peer, m, OSMO_PFCP_CAUSE_REQUEST_ACCEPTED); + up_peer_fsm_state_chg(UP_PEER_ST_WAIT_USE_COUNT); +} + +static void up_peer_rx_session_est_req(struct up_peer *peer, struct osmo_pfcp_msg *m) +{ + enum osmo_pfcp_cause cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED; + struct osmo_pfcp_msg *resp; + struct up_session *session = up_session_find_or_add(peer, &m->ies.session_est_req.cp_f_seid, NULL); + + if (!session) { + cause = OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE; + goto nack_response; + } + + up_session_set_msg_ctx(session, m); + + if (osmo_fsm_inst_dispatch(session->fi, UP_SESSION_EV_RX_SESSION_EST_REQ, m)) { + cause = OSMO_PFCP_CAUSE_REQUEST_REJECTED; + goto nack_response; + } + return; + +nack_response: + resp = up_peer_init_tx(peer, m, OSMO_PFCP_MSGT_SESSION_EST_RESP); + resp->h.seid = m->ies.session_est_req.cp_f_seid.seid; + resp->h.seid_present = true; + resp->ies.session_est_resp = (struct osmo_pfcp_msg_session_est_resp){ + .cause = cause, + }; + osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, resp); +} + +static void up_peer_not_associated_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct up_peer *peer = fi->priv; + + switch (event) { + + case UP_PEER_EV_RX_ASSOC_SETUP_REQ: + up_peer_rx_assoc_setup_req(peer, data); + break; + + case UP_PEER_EV_USE_COUNT_ZERO: + /* Not associated and no pending messages. discard peer. */ + up_peer_fsm_state_chg(UP_PEER_ST_WAIT_USE_COUNT); + return; + + default: + OSMO_ASSERT(false); + } +} + +static void up_peer_associated_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct up_peer *peer = fi->priv; + + switch (event) { + + case UP_PEER_EV_RX_ASSOC_SETUP_REQ: + up_peer_rx_assoc_setup_req(peer, data); + break; + + case UP_PEER_EV_RX_ASSOC_UPD_REQ: + // FIXME + break; + + case UP_PEER_EV_RX_SESSION_EST_REQ: + up_peer_rx_session_est_req(peer, data); + break; + + case UP_PEER_EV_HEARTBEAT_FAILURE: + // FIXME + break; + + case UP_PEER_EV_USE_COUNT_ZERO: + /* Stay associated. */ + return; + + default: + OSMO_ASSERT(false); + } +} + +static void up_peer_associated_onleave(struct osmo_fsm_inst *fi, uint32_t next_state) +{ + struct up_peer *peer = fi->priv; + if (next_state != UP_PEER_ST_ASSOCIATED) + LOGPFSML(fi, LOGL_NOTICE, "Peer %s released\n", + osmo_pfcp_ie_node_id_to_str_c(OTC_SELECT, &peer->remote_node_id)); +} + +static void up_peer_graceful_release_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + //struct up_peer *peer = fi->priv; + // FIXME +} + +static void up_peer_graceful_release_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct up_peer *peer = fi->priv; + + switch (event) { + + case UP_PEER_EV_HEARTBEAT_FAILURE: + up_peer_fsm_state_chg(UP_PEER_ST_WAIT_USE_COUNT); + break; + + case UP_PEER_EV_USE_COUNT_ZERO: + /* When there are still sessions, stay around. */ + if (!hash_empty(peer->sessions_by_up_seid)) + return; + up_peer_fsm_state_chg(UP_PEER_ST_WAIT_USE_COUNT); + return; + + default: + OSMO_ASSERT(false); + } +} + +static void up_peer_wait_use_count_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct up_peer *peer = fi->priv; + up_peer_clear_sessions(peer); + if (!osmo_use_count_total(&peer->use_count)) + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); +} + +static void up_peer_wait_use_count_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct up_peer *peer = fi->priv; + switch (event) { + + case UP_PEER_EV_USE_COUNT_ZERO: + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); + return; + + case UP_PEER_EV_RX_ASSOC_SETUP_REQ: + up_peer_rx_assoc_setup_req(peer, data); + break; + + default: + OSMO_ASSERT(false); + } +} + +#define S(x) (1 << (x)) + +static const struct osmo_fsm_state up_peer_fsm_states[] = { + [UP_PEER_ST_NOT_ASSOCIATED] = { + .name = "NOT_ASSOCIATED", + .in_event_mask = 0 + | S(UP_PEER_EV_RX_ASSOC_SETUP_REQ) + | S(UP_PEER_EV_USE_COUNT_ZERO) + , + .out_state_mask = 0 + | S(UP_PEER_ST_ASSOCIATED) + | S(UP_PEER_ST_WAIT_USE_COUNT) + , + .action = up_peer_not_associated_action, + }, + [UP_PEER_ST_ASSOCIATED] = { + .name = "ASSOCIATED", + .in_event_mask = 0 + | S(UP_PEER_EV_RX_ASSOC_SETUP_REQ) + | S(UP_PEER_EV_RX_ASSOC_UPD_REQ) + | S(UP_PEER_EV_RX_SESSION_EST_REQ) + | S(UP_PEER_EV_HEARTBEAT_FAILURE) + | S(UP_PEER_EV_USE_COUNT_ZERO) + , + .out_state_mask = 0 + | S(UP_PEER_ST_ASSOCIATED) + | S(UP_PEER_ST_GRACEFUL_RELEASE) + | S(UP_PEER_ST_WAIT_USE_COUNT) + , + .action = up_peer_associated_action, + .onleave = up_peer_associated_onleave, + }, + [UP_PEER_ST_GRACEFUL_RELEASE] = { + .name = "GRACEFUL_RELEASE", + .in_event_mask = 0 + | S(UP_PEER_EV_HEARTBEAT_FAILURE) + | S(UP_PEER_EV_USE_COUNT_ZERO) + , + .out_state_mask = 0 + | S(UP_PEER_ST_WAIT_USE_COUNT) + , + .onenter = up_peer_graceful_release_onenter, + .action = up_peer_graceful_release_action, + }, + [UP_PEER_ST_WAIT_USE_COUNT] = { + .name = "WAIT_USE_COUNT", + .in_event_mask = 0 + | S(UP_PEER_EV_USE_COUNT_ZERO) + | S(UP_PEER_EV_RX_ASSOC_SETUP_REQ) + , + .out_state_mask = 0 + | S(UP_PEER_ST_ASSOCIATED) + , + .onenter = up_peer_wait_use_count_onenter, + .action = up_peer_wait_use_count_action, + }, +}; + +void up_peer_fsm_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) +{ + struct up_peer *peer = fi->priv; + LOGPFSML(fi, LOGL_NOTICE, "Peer removed\n"); + llist_del(&peer->entry); +} + +static void up_peer_allstate_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + switch (event) { + case UP_PEER_EV_SESSION_TERM: + /* ignore */ + return; + case UP_PEER_EV_RX_ASSOC_REL_REQ: + up_peer_rx_assoc_rel_req(fi->priv, data); + return; + default: + OSMO_ASSERT(false); + } +} + +static struct osmo_fsm up_peer_fsm = { + .name = "up_peer", + .log_subsys = DPEER, + .states = up_peer_fsm_states, + .num_states = ARRAY_SIZE(up_peer_fsm_states), + .event_names = up_peer_fsm_event_names, + .timer_cb = up_peer_fsm_timer_cb, + .cleanup = up_peer_fsm_cleanup, + .allstate_event_mask = 0 + | S(UP_PEER_EV_RX_ASSOC_REL_REQ) + | S(UP_PEER_EV_SESSION_TERM) + , + .allstate_action = up_peer_allstate_action, +}; + +static __attribute__((constructor)) void up_peer_fsm_register(void) +{ + OSMO_ASSERT(osmo_fsm_register(&up_peer_fsm) == 0); +} + +void up_peer_free(struct up_peer *peer) +{ + osmo_fsm_inst_term(peer->fi, OSMO_FSM_TERM_REGULAR, NULL); +} diff --git a/src/osmo-upf/up_peer_fsm.c b/src/osmo-upf/up_peer_fsm.c new file mode 100644 index 0000000..ec37c0b --- /dev/null +++ b/src/osmo-upf/up_peer_fsm.c @@ -0,0 +1,196 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <osmocom/core/utils.h> +#include <osmocom/core/fsm.h> + +#include <osmocom/upf/up_peer.h> + +enum up_peer_fsm_state { + UP_PEER_ST_NOT_ASSOCIATED, + UP_PEER_ST_ASSOCIATED, + UP_PEER_ST_GRACEFUL_RELEASE, +}; + +static const struct value_string up_peer_fsm_event_names[] = { + OSMO_VALUE_STRING(UP_PEER_EV_RX_ASSOC_SETUP_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_RX_ASSOC_UPD_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_RX_SESSION_EST_REQ), + OSMO_VALUE_STRING(UP_PEER_EV_HEARTBEAT_FAILURE), + {} +}; + +static struct osmo_fsm up_peer_fsm; + +static const struct osmo_tdef_state_timeout up_peer_fsm_timeouts[32] = { + [UP_PEER_ST_GRACEFUL_RELEASE] = { .T = -21 }, +}; + +/* Transition to a state, using the T timer defined in up_peer_fsm_timeouts. + * Assumes local variable fi exists. */ +#define up_peer_fsm_state_chg(state) \ + osmo_tdef_fsm_inst_state_chg(fi, state, \ + up_peer_fsm_timeouts, \ + g_upf_tdefs, \ + 5) + +struct up_peer *up_peer_alloc(struct osmo_fsm_inst *parent_fi, uint32_t parent_event_term) +{ + struct up_peer *up_peer; + + struct osmo_fsm_inst *fi = osmo_fsm_inst_alloc_child(&up_peer_fsm, parent_fi, parent_event_term); + OSMO_ASSERT(fi); + + up_peer = talloc(fi, struct up_peer); + OSMO_ASSERT(up_peer); + fi->priv = up_peer; + *up_peer = (struct up_peer){ + .fi = fi, + }; + + return up_peer; +} + +static int up_peer_fsm_timer_cb(struct osmo_fsm_inst *fi) +{ + //struct up_peer *up_peer = fi->priv; + /* Return 1 to terminate FSM instance, 0 to keep running */ + return 1; +} + +static void up_peer_not_associated_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + //struct up_peer *up_peer = fi->priv; + + switch (event) { + + case UP_PEER_EV_RX_ASSOC_SETUP_REQ: + // FIXME + break; + + default: + OSMO_ASSERT(false); + } +} + +static void up_peer_associated_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + //struct up_peer *up_peer = fi->priv; + // FIXME +} + +static void up_peer_associated_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + //struct up_peer *up_peer = fi->priv; + + switch (event) { + + case UP_PEER_EV_RX_ASSOC_UPD_REQ: + // FIXME + break; + + case UP_PEER_EV_RX_SESSION_EST_REQ: + // FIXME + break; + + case UP_PEER_EV_HEARTBEAT_FAILURE: + // FIXME + break; + + default: + OSMO_ASSERT(false); + } +} + +static void up_peer_graceful_release_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + //struct up_peer *up_peer = fi->priv; + // FIXME +} + +static void up_peer_graceful_release_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + //struct up_peer *up_peer = fi->priv; + + switch (event) { + + case UP_PEER_EV_HEARTBEAT_FAILURE: + // FIXME + break; + + default: + OSMO_ASSERT(false); + } +} + +#define S(x) (1 << (x)) + +static const struct osmo_fsm_state up_peer_fsm_states[] = { + [UP_PEER_ST_NOT_ASSOCIATED] = { + .name = "not_associated", + .in_event_mask = 0 + | S(UP_PEER_EV_RX_ASSOC_SETUP_REQ) + , + .out_state_mask = 0 + | S(UP_PEER_ST_ASSOCIATED) + , + .action = up_peer_not_associated_action, + }, + [UP_PEER_ST_ASSOCIATED] = { + .name = "associated", + .in_event_mask = 0 + | S(UP_PEER_EV_RX_ASSOC_UPD_REQ) + | S(UP_PEER_EV_RX_SESSION_EST_REQ) + | S(UP_PEER_EV_HEARTBEAT_FAILURE) + , + .out_state_mask = 0 + | S(UP_PEER_ST_GRACEFUL_RELEASE) + , + .onenter = up_peer_associated_onenter, + .action = up_peer_associated_action, + }, + [UP_PEER_ST_GRACEFUL_RELEASE] = { + .name = "graceful_release", + .in_event_mask = 0 + | S(UP_PEER_EV_HEARTBEAT_FAILURE) + , + .out_state_mask = 0 + , + .onenter = up_peer_graceful_release_onenter, + .action = up_peer_graceful_release_action, + }, +}; + +static struct osmo_fsm up_peer_fsm = { + .name = "up_peer", + .states = up_peer_fsm_states, + .num_states = ARRAY_SIZE(up_peer_fsm_states), + .log_subsys = DSESSION, + .event_names = up_peer_fsm_event_names, + .timer_cb = up_peer_fsm_timer_cb, +}; + +static __attribute__((constructor)) void up_peer_fsm_register(void) +{ + OSMO_ASSERT(osmo_fsm_register(&up_peer_fsm) == 0); +} diff --git a/src/osmo-upf/up_session.c b/src/osmo-upf/up_session.c new file mode 100644 index 0000000..1cb65d7 --- /dev/null +++ b/src/osmo-upf/up_session.c @@ -0,0 +1,1358 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <errno.h> + +#include <osmocom/core/utils.h> +#include <osmocom/core/fsm.h> + +#include <osmocom/pfcp/pfcp_msg.h> +#include <osmocom/pfcp/pfcp_endpoint.h> + +#include <osmocom/upf/upf.h> +#include <osmocom/upf/up_endpoint.h> +#include <osmocom/upf/up_peer.h> +#include <osmocom/upf/up_session.h> +#include <osmocom/upf/up_gtp_action.h> + +static enum osmo_pfcp_cause up_session_setup_gtp(struct up_session *session); + +void up_session_set_msg_ctx(struct up_session *session, struct osmo_pfcp_msg *m) +{ + if (!m->ctx.peer_fi) + up_peer_set_msg_ctx(session->up_peer, m); + + OSMO_ASSERT(!m->ctx.session_fi); + + m->ctx.session_fi = session->fi; + m->ctx.session_use_count = &session->use_count; + m->ctx.session_use_token = (m->rx ? UP_USE_MSG_RX : UP_USE_MSG_TX); + osmo_use_count_get_put(m->ctx.session_use_count, m->ctx.session_use_token, 1); +} + +enum up_session_fsm_state { + UP_SESSION_ST_INIT, + UP_SESSION_ST_ESTABLISHED, + UP_SESSION_ST_WAIT_USE_COUNT, +}; + +static const struct value_string up_session_fsm_event_names[] = { + OSMO_VALUE_STRING(UP_SESSION_EV_RX_SESSION_EST_REQ), + OSMO_VALUE_STRING(UP_SESSION_EV_RX_SESSION_MOD_REQ), + OSMO_VALUE_STRING(UP_SESSION_EV_RX_SESSION_DEL_REQ), + OSMO_VALUE_STRING(UP_SESSION_EV_USE_COUNT_ZERO), + {} +}; + +static struct osmo_fsm up_session_fsm; + +static const struct osmo_tdef_state_timeout up_session_fsm_timeouts[32] = { + [UP_SESSION_ST_INIT] = { .T = 0 }, + [UP_SESSION_ST_ESTABLISHED] = { .T = 0 }, + [UP_SESSION_ST_WAIT_USE_COUNT] = { .T = 0 }, +}; + +/* Transition to a state, using the T timer defined in up_session_fsm_timeouts. + * Assumes local variable fi exists. */ +#define up_session_fsm_state_chg(STATE) do { \ + if (fi->state != STATE) \ + osmo_tdef_fsm_inst_state_chg(fi, STATE, \ + up_session_fsm_timeouts, \ + osmo_pfcp_tdefs, \ + 5); \ + } while (0) + +static int up_session_fsm_timer_cb(struct osmo_fsm_inst *fi) +{ + /* Return 1 to terminate FSM instance, 0 to keep running */ + return 1; +} + +struct osmo_pfcp_msg *up_session_init_tx(struct up_session *session, struct osmo_pfcp_msg *in_reply_to, + enum osmo_pfcp_message_type message_type) +{ + struct osmo_pfcp_msg *tx = up_peer_init_tx(session->up_peer, in_reply_to, message_type); + tx->h.seid = session->cp_f_seid.seid; + tx->h.seid_present = true; + up_session_set_msg_ctx(session, tx); + return tx; +} + +struct chosen_f_teid { + struct llist_head entry; + uint8_t choose_id; + struct osmo_pfcp_ie_f_teid f_teid; +}; + +struct chosen_f_teid *chosen_f_teid_find(struct llist_head *list, uint8_t choose_id) +{ + struct chosen_f_teid *chosen; + llist_for_each_entry(chosen, list, entry) { + if (chosen->choose_id == choose_id) + return chosen; + } + return NULL; +} + +/* Choose an F-TEID (when the peer has sent CHOOSE = 1). + * If the peer also sent a CHOOSE_ID, then remember this F-TEID choice under the given ID, and re-use that choice when + * the same ID re-appears. The chosen IDs are saved in session->chosen_f_teids. */ +static enum osmo_pfcp_cause up_session_choose_f_teid(struct up_session *session, struct osmo_pfcp_ie_f_teid *dst, + bool choose_id_present, uint8_t choose_id) +{ + struct up_endpoint *up_ep = session->up_peer->up_endpoint; + struct chosen_f_teid *chosen = NULL; + + if (choose_id_present) + chosen = chosen_f_teid_find(&session->chosen_f_teids, choose_id); + if (chosen) { + /* Re-use a previous F-TEID */ + *dst = chosen->f_teid; + } else { + /* Choose a new F-TEID */ + *dst = (struct osmo_pfcp_ie_f_teid){ + .fixed = { + .teid = up_endpoint_next_teid(up_ep), + }, + }; + if (dst->fixed.teid == 0) { + LOGPFSML(session->fi, LOGL_ERROR, "Failed to allocate an unused TEID\n"); + return OSMO_PFCP_CAUSE_PFCP_ENTITY_IN_CONGESTION; + } + LOGPFSML(session->fi, LOGL_INFO, "Allocated new local TEID 0x%x\n", dst->fixed.teid); + + if (osmo_pfcp_ip_addrs_set(&dst->fixed.ip_addr, &up_ep->pfcp_ep->cfg.local_addr)) { + LOGPFSML(session->fi, LOGL_ERROR, "Invalid local address in pfcp_endpoint cfg\n"); + return OSMO_PFCP_CAUSE_PFCP_ENTITY_IN_CONGESTION; + } + /* Save this choice */ + if (choose_id_present) { + chosen = talloc(session, struct chosen_f_teid); + *chosen = (struct chosen_f_teid){ + .f_teid = *dst, + .choose_id = choose_id, + }; + llist_add_tail(&chosen->entry, &session->chosen_f_teids); + } + } + return OSMO_PFCP_CAUSE_REQUEST_ACCEPTED; +} + +static struct far *far_create(struct up_session *session, + const struct osmo_pfcp_ie_create_far *create_far) +{ + struct far *far = talloc(session, struct far); + *far = (struct far){ + .session = session, + .desc = *create_far, + }; + llist_add_tail(&far->entry, &session->fars); + + return far; +} + +static struct far *far_find(struct up_session *session, uint32_t far_id) +{ + struct far *far; + llist_for_each_entry(far, &session->fars, entry) { + if (far->desc.far_id == far_id) + return far; + } + return NULL; +} + +static void far_upd(struct far *far, const struct osmo_pfcp_ie_upd_far *upd) +{ + if (upd->apply_action_present) + far->desc.apply_action = upd->apply_action; + if (upd->upd_forw_params_present) { + const struct osmo_pfcp_ie_upd_forw_params *u = &upd->upd_forw_params; + struct osmo_pfcp_ie_forw_params *p = &far->desc.forw_params; + if (u->destination_iface_present) + p->destination_iface = u->destination_iface; + if (u->network_inst_present) { + p->network_inst = p->network_inst; + p->network_inst_present = true; + } + if (u->outer_header_creation_present) { + p->outer_header_creation = p->outer_header_creation; + p->outer_header_creation_present = true; + } + if (u->linked_te_id_present) { + p->linked_te_id = p->linked_te_id; + p->linked_te_id_present = true; + } + if (u->destination_iface_type_present) { + p->destination_iface_type = p->destination_iface_type; + p->destination_iface_type_present = true; + } + } +} + +struct pdr; +static void pdr_classify(struct pdr *pdr); + +static void far_del(struct far *far) +{ + struct pdr *pdr; + llist_for_each_entry(pdr, &far->session->pdrs, entry) { + if (pdr->far == far) { + pdr->far = NULL; + pdr_classify(pdr); + } + } + + llist_del(&far->entry); + talloc_free(far); +} + +static int far_to_str_buf(char *buf, size_t len, const struct far *far) +{ + struct osmo_strbuf sb = { .buf = buf, .len = len }; + const struct osmo_pfcp_ie_create_far *f = &far->desc; + + OSMO_STRBUF_PRINTF(sb, "FAR-%u{", f->far_id); + OSMO_STRBUF_APPEND(sb, osmo_pfcp_bits_to_str_buf, f->apply_action.bits, osmo_pfcp_apply_action_strs); + if (f->forw_params_present) { + OSMO_STRBUF_PRINTF(sb, " dst:%s", osmo_pfcp_dest_iface_str(f->forw_params.destination_iface)); + if (f->forw_params.outer_header_creation_present) { + OSMO_STRBUF_PRINTF(sb, " encaps-"); + OSMO_STRBUF_APPEND(sb, osmo_pfcp_bits_to_str_buf, + f->forw_params.outer_header_creation.desc_bits, + osmo_pfcp_outer_header_creation_strs); + if (f->forw_params.outer_header_creation.teid_present) + OSMO_STRBUF_PRINTF(sb, " TEID-0x%x", f->forw_params.outer_header_creation.teid); + } + } + OSMO_STRBUF_PRINTF(sb, "}"); + return sb.chars_needed; +} + +#if 0 +static char *far_to_str_c(void *ctx, const struct far *far) +{ + OSMO_NAME_C_IMPL(ctx, 64, "ERROR", far_to_str_buf, far) +} +#endif + +int pdr_to_str_buf(char *buf, size_t buflen, const struct pdr *pdr) +{ + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + const struct osmo_pfcp_ie_create_pdr *d = &pdr->desc; + + OSMO_STRBUF_PRINTF(sb, "PDR-%u{src:%s", d->pdr_id, osmo_pfcp_source_iface_str(d->pdi.source_iface)); + if (pdr->desc.pdi.ue_ip_address_present) { + if (pdr->desc.pdi.ue_ip_address.ip_addr.v4_present) { + OSMO_STRBUF_PRINTF(sb, " %s", + pdr->desc.pdi.ue_ip_address.ip_is_destination ? "dst:" : "src:"); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &pdr->desc.pdi.ue_ip_address.ip_addr.v4); + } + if (pdr->desc.pdi.ue_ip_address.ip_addr.v6_present) { + OSMO_STRBUF_PRINTF(sb, " "); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &pdr->desc.pdi.ue_ip_address.ip_addr.v6); + } + } + if (pdr->local_f_teid) { + OSMO_STRBUF_PRINTF(sb, " "); + OSMO_STRBUF_APPEND(sb, osmo_pfcp_ie_f_teid_to_str_buf, pdr->local_f_teid); + } + if (d->outer_header_removal_present) + OSMO_STRBUF_PRINTF(sb, " decaps-%s", + osmo_pfcp_outer_header_removal_desc_str(d->outer_header_removal.desc)); + OSMO_STRBUF_PRINTF(sb, "}"); + + if (pdr->far) { + OSMO_STRBUF_PRINTF(sb, " --> "); + OSMO_STRBUF_APPEND(sb, far_to_str_buf, pdr->far); + } + + return sb.chars_needed; +} + +char *pdr_to_str_c(void *ctx, const struct pdr *pdr) +{ + OSMO_NAME_C_IMPL(ctx, 128, "ERROR", pdr_to_str_buf, pdr) +} + +static struct pdr *pdr_find(struct up_session *session, uint16_t pdr_id) +{ + struct pdr *pdr; + llist_for_each_entry(pdr, &session->pdrs, entry) { + if (pdr->desc.pdr_id == pdr_id) + return pdr; + } + return NULL; +} + +static void pdr_del(struct pdr *pdr) +{ + llist_del(&pdr->entry); + talloc_free(pdr); +} + +static void pdr_set_far(struct pdr *pdr, struct far *far) +{ + pdr->far = far; +} + +static struct pdr *pdr_create(struct up_session *session, + const struct osmo_pfcp_ie_create_pdr *create_pdr, + enum osmo_pfcp_cause *cause, + bool *offending_ie_present, + enum osmo_pfcp_iei *offending_ie, + struct osmo_pfcp_ie_created_pdr created_pdr[], + unsigned int *created_pdr_count, + size_t created_pdr_maxcount) +{ + struct pdr *pdr = NULL; + + /* Is there still room in the response for 'Created PDR' IEs? */ + if (*created_pdr_count >= created_pdr_maxcount) { + *cause = OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE; + goto nack_resp; + } + + pdr = talloc(session, struct pdr); + *pdr = (struct pdr){ + .session = session, + .desc = *create_pdr, + }; + llist_add_tail(&pdr->entry, &session->pdrs); + + if (pdr->desc.far_id_present) { + struct far *far = far_find(session, pdr->desc.far_id); + if (!far) { + LOGPFSML(session->fi, LOGL_ERROR, "PDR-%u requests FAR-%u, but there is no such FAR\n", + pdr->desc.pdr_id, pdr->desc.far_id); + *cause = OSMO_PFCP_CAUSE_REQUEST_REJECTED; + *offending_ie_present = true; + *offending_ie = OSMO_PFCP_IEI_FAR_ID; + goto nack_resp; + } + pdr_set_far(pdr, far); + } else if (pdr->desc.activate_predefined_rules_present) { + LOGPFSML(session->fi, LOGL_ERROR, + "Predefined Rules feature not implemented: PDR-%u requests predefined rule '%s'\n", + pdr->desc.pdr_id, pdr->desc.activate_predefined_rules.str); + *cause = OSMO_PFCP_CAUSE_RULE_CREATION_MOD_FAILURE; + *offending_ie_present = true; + *offending_ie = OSMO_PFCP_IEI_ACTIVATE_PREDEFINED_RULES; + goto nack_resp; + } else { + LOGPFSML(session->fi, LOGL_ERROR, "No FAR defined for PDR-%u\n", pdr->desc.pdr_id); + *cause = OSMO_PFCP_CAUSE_CONDITIONAL_IE_MISSING; + *offending_ie_present = true; + *offending_ie = OSMO_PFCP_IEI_FAR_ID; + goto nack_resp; + } + + /* Figure out the TEID and IP address for this PDR */ + if (pdr->desc.pdi.local_f_teid_present) { + if (pdr->desc.pdi.local_f_teid.choose_flag) { + /* CHOOSE = 1: we need to pick our own local F-TEID */ + struct osmo_pfcp_ie_f_teid local_f_teid; + *cause = up_session_choose_f_teid(session, &local_f_teid, + pdr->desc.pdi.local_f_teid.choose.choose_id_present, + pdr->desc.pdi.local_f_teid.choose.choose_id); + if (*cause != OSMO_PFCP_CAUSE_REQUEST_ACCEPTED) { + *offending_ie = OSMO_PFCP_IEI_F_TEID; + *offending_ie_present = true; + goto nack_resp; + } + pdr->_local_f_teid_buf = local_f_teid; + pdr->local_f_teid = &pdr->_local_f_teid_buf; + } else { + /* CHOOSE = 0: just use the provided TEID and IP addr */ + pdr->local_f_teid = &pdr->desc.pdi.local_f_teid; + if (!(pdr->local_f_teid->fixed.ip_addr.v4_present + || pdr->local_f_teid->fixed.ip_addr.v6_present)) { + LOGPFSML(session->fi, LOGL_ERROR, + "peer requested to choose an F-TEID, but neither IPv4 nor IPv6 is selected" + " in the incoming Create PDR IE for PDR-%u.\n", + pdr->desc.pdr_id); + *cause = OSMO_PFCP_CAUSE_RULE_CREATION_MOD_FAILURE; + *offending_ie = OSMO_PFCP_IEI_F_TEID; + *offending_ie_present = true; + goto nack_resp; + } + } + } + + if (pdr->local_f_teid) { + created_pdr[*created_pdr_count] = (struct osmo_pfcp_ie_created_pdr){ + .pdr_id = pdr->desc.pdr_id, + .local_f_teid_present = true, + .local_f_teid = *pdr->local_f_teid, + }; + } else { + created_pdr[*created_pdr_count] = (struct osmo_pfcp_ie_created_pdr){ + .pdr_id = pdr->desc.pdr_id, + }; + } + (*created_pdr_count)++; + + LOGPFSML(session->fi, LOGL_INFO, "New %s\n", pdr_to_str_c(OTC_SELECT, pdr)); + + return pdr; + +nack_resp: + if (pdr) + pdr_del(pdr); + if (!*offending_ie_present) { + *offending_ie = OSMO_PFCP_IEI_CREATE_PDR; + *offending_ie_present = true; + } + return NULL; +} + +static struct pdr *pdr_upd(struct pdr *pdr, + const struct osmo_pfcp_ie_upd_pdr *update_pdr, + enum osmo_pfcp_cause *cause, + bool *offending_ie_present, + enum osmo_pfcp_iei *offending_ie, + struct osmo_pfcp_ie_updated_pdr updated_pdr[], + unsigned int *updated_pdr_count, + size_t updated_pdr_maxcount) +{ + struct up_session *session = pdr->session; + + /* Is there still room in the response for 'Updated PDR' IEs? */ + if (*updated_pdr_count >= updated_pdr_maxcount) { + *cause = OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE; + goto nack_resp; + } + + if (update_pdr->outer_header_removal_present) { + pdr->desc.outer_header_removal = update_pdr->outer_header_removal; + pdr->desc.outer_header_removal_present = true; + } + if (update_pdr->pdi_present) + pdr->desc.pdi = update_pdr->pdi; + + if (update_pdr->far_id_present) { + struct far *far = far_find(session, update_pdr->far_id); + if (!far) { + LOGPFSML(session->fi, LOGL_ERROR, "PDR-%u requests FAR-%u, but there is no such FAR\n", + pdr->desc.pdr_id, pdr->desc.far_id); + *cause = OSMO_PFCP_CAUSE_REQUEST_REJECTED; + *offending_ie_present = true; + *offending_ie = OSMO_PFCP_IEI_FAR_ID; + goto nack_resp; + } + pdr_set_far(pdr, far); + } + + if (pdr->local_f_teid) { + updated_pdr[*updated_pdr_count] = (struct osmo_pfcp_ie_updated_pdr){ + .pdr_id = pdr->desc.pdr_id, + .local_f_teid_present = true, + .local_f_teid = *pdr->local_f_teid, + }; + } else { + updated_pdr[*updated_pdr_count] = (struct osmo_pfcp_ie_updated_pdr){ + .pdr_id = pdr->desc.pdr_id, + }; + } + (*updated_pdr_count)++; + + pdr_classify(pdr); + LOGPFSML(session->fi, LOGL_INFO, "Updated %s\n", pdr_to_str_c(OTC_SELECT, pdr)); + + return pdr; + +nack_resp: + if (pdr) + pdr_del(pdr); + if (!*offending_ie_present) { + *offending_ie = OSMO_PFCP_IEI_UPD_PDR; + *offending_ie_present = true; + } + return NULL; +} + +char *up_session_gtp_status(struct up_session *session) +{ + struct pdr *pdr; + struct far *far; + int active_pdrs = 0; + int total_pdrs = 0; + int active_fars = 0; + int total_fars = 0; + + llist_for_each_entry(pdr, &session->pdrs, entry) { + if (pdr->active) + active_pdrs++; + total_pdrs++; + } + + llist_for_each_entry(far, &session->fars, entry) { + if (far->active) + active_fars++; + total_fars++; + } + + return talloc_asprintf(OTC_SELECT, "PDR-active:%d/%d FAR-active:%d/%d GTP-active:%u", + active_pdrs, total_pdrs, active_fars, total_fars, + llist_count(&session->active_gtp_actions)); +} + +static void up_session_est(struct up_session *session, struct osmo_pfcp_msg *m) +{ + struct osmo_fsm_inst *fi = session->fi; + struct up_peer *peer = session->up_peer; + struct osmo_pfcp_msg_session_est_req *req = &m->ies.session_est_req; + struct osmo_pfcp_msg_session_est_resp *resp; + struct osmo_pfcp_msg *tx; + int i; + int rc; + + tx = up_session_init_tx(session, m, OSMO_PFCP_MSGT_SESSION_EST_RESP); + resp = &tx->ies.session_est_resp; + + for (i = 0; i < req->create_far_count; i++) { + struct far *far = far_create(session, &req->create_far[i]); + if (!far) + goto nack_response; + } + + for (i = 0; i < req->create_pdr_count; i++) { + struct pdr *pdr = pdr_create(session, &req->create_pdr[i], + &resp->cause, + &resp->offending_ie_present, &resp->offending_ie, + resp->created_pdr, &resp->created_pdr_count, + ARRAY_SIZE(resp->created_pdr)); + if (!pdr) + goto nack_response; + } + + resp->cause = up_session_setup_gtp(session); + if (resp->cause != OSMO_PFCP_CAUSE_REQUEST_ACCEPTED) + goto nack_response; + + /* Success, send ACK */ + osmo_pfcp_ie_f_seid_set(&resp->up_f_seid, session->up_seid, &peer->up_endpoint->pfcp_ep->cfg.local_addr); + resp->up_f_seid_present = true; + + rc = osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, tx); + if (rc) + up_session_fsm_state_chg(UP_SESSION_ST_WAIT_USE_COUNT); + up_session_fsm_state_chg(UP_SESSION_ST_ESTABLISHED); + return; + +nack_response: + resp->created_pdr_count = 0; + osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, tx); + up_session_fsm_state_chg(UP_SESSION_ST_WAIT_USE_COUNT); +} + +static void up_session_mod(struct up_session *session, struct osmo_pfcp_msg *m) +{ + struct osmo_fsm_inst *fi = session->fi; + struct up_peer *peer = session->up_peer; + struct osmo_pfcp_msg_session_mod_req *req = &m->ies.session_mod_req; + struct osmo_pfcp_msg_session_mod_resp *resp; + struct osmo_pfcp_msg *tx; + int i; + + tx = up_session_init_tx(session, m, OSMO_PFCP_MSGT_SESSION_MOD_RESP); + resp = &tx->ies.session_mod_resp; + + for (i = 0; i < req->remove_far_count; i++) { + uint32_t far_id = req->remove_far[i].far_id; + struct far *far = far_find(session, far_id); + if (!far) { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Cannot remove, does not exist: FAR-%u\n", far_id); + continue; + } + far_del(far); + } + + for (i = 0; i < req->remove_pdr_count; i++) { + uint16_t pdr_id = req->remove_pdr[i].pdr_id; + struct pdr *pdr = pdr_find(session, pdr_id); + if (!pdr) { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Cannot remove, does not exist: PDR-%u\n", pdr_id); + continue; + } + pdr_del(pdr); + } + + for (i = 0; i < req->create_far_count; i++) { + struct far *far = far_create(session, &req->create_far[i]); + if (!far) + goto nack_response; + } + + for (i = 0; i < req->create_pdr_count; i++) { + struct pdr *pdr = pdr_create(session, &req->create_pdr[i], + &resp->cause, + &resp->offending_ie_present, &resp->offending_ie, + resp->created_pdr, &resp->created_pdr_count, + ARRAY_SIZE(resp->created_pdr)); + if (!pdr) + goto nack_response; + } + + for (i = 0; i < req->upd_far_count; i++) { + uint32_t far_id = req->upd_far[i].far_id; + struct far *far = far_find(session, req->upd_far[i].far_id); + if (!far) { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Cannot update, does not exist: FAR-%u\n", far_id); + goto nack_response; + } + far_upd(far, &req->upd_far[i]); + } + + for (i = 0; i < req->upd_pdr_count; i++) { + uint16_t pdr_id = req->upd_pdr[i].pdr_id; + struct pdr *pdr = pdr_find(session, req->upd_pdr[i].pdr_id); + if (!pdr) { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "Cannot update, does not exist: PDR-%u\n", pdr_id); + goto nack_response; + } + pdr_upd(pdr, &req->upd_pdr[i], + &resp->cause, + &resp->offending_ie_present, &resp->offending_ie, + resp->updated_pdr, &resp->updated_pdr_count, + ARRAY_SIZE(resp->updated_pdr)); + } + + resp->cause = up_session_setup_gtp(session); + if (resp->cause != OSMO_PFCP_CAUSE_REQUEST_ACCEPTED) + goto nack_response; + + /* Success, send ACK */ + if (osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, tx)) + up_session_fsm_state_chg(UP_SESSION_ST_WAIT_USE_COUNT); + + LOGPFSML(fi, LOGL_NOTICE, "Session modified: %s\n", up_session_gtp_status(session)); + return; + +nack_response: + resp->created_pdr_count = 0; + osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, tx); + up_session_fsm_state_chg(UP_SESSION_ST_WAIT_USE_COUNT); +} + +static void up_session_del(struct up_session *session, struct osmo_pfcp_msg *m) +{ + struct osmo_fsm_inst *fi = session->fi; + struct up_peer *peer = session->up_peer; + struct osmo_pfcp_msg *tx; + + tx = up_session_init_tx(session, m, OSMO_PFCP_MSGT_SESSION_DEL_RESP); + tx->ies.session_del_resp = (struct osmo_pfcp_msg_session_del_resp){ + .cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED + }; + osmo_pfcp_endpoint_tx(peer->up_endpoint->pfcp_ep, tx); + up_session_fsm_state_chg(UP_SESSION_ST_WAIT_USE_COUNT); +} + +static void up_session_init_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct up_session *up_session = fi->priv; + + switch (event) { + + case UP_SESSION_EV_RX_SESSION_EST_REQ: + up_session_est(up_session, data); + break; + + case UP_SESSION_EV_RX_SESSION_DEL_REQ: + up_session_del(up_session, data); + break; + + case UP_SESSION_EV_USE_COUNT_ZERO: + /* ignore */ + break; + + default: + OSMO_ASSERT(false); + } +} + +static void up_session_established_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct up_session *session = fi->priv; + LOGPFSML(fi, LOGL_NOTICE, "Session established: %s %s\n", up_session_to_str_c(OTC_SELECT, session), + up_session_gtp_status(session)); +} + +static void up_session_established_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct up_session *up_session = fi->priv; + + switch (event) { + + case UP_SESSION_EV_RX_SESSION_MOD_REQ: + up_session_mod(up_session, data); + break; + + case UP_SESSION_EV_RX_SESSION_DEL_REQ: + up_session_del(up_session, data); + break; + + case UP_SESSION_EV_USE_COUNT_ZERO: + /* ignore */ + break; + + default: + OSMO_ASSERT(false); + } +} + +static void up_session_established_onleave(struct osmo_fsm_inst *fi, uint32_t next_state) +{ + struct up_session *session = fi->priv; + struct up_gtp_action *a; + LOGPFSML(fi, LOGL_NOTICE, "Session releasing: %s %s\n", up_session_to_str_c(OTC_SELECT, session), up_session_gtp_status(session)); + + /* Shut down all active GTP rules */ + while ((a = llist_first_entry_or_null(&session->active_gtp_actions, struct up_gtp_action, entry))) { + up_gtp_action_disable(a); + llist_del(&a->entry); + talloc_free(a); + } +} + + +static void up_session_clear_pdr_far(struct up_session *session); +static void drop_gtp_actions(struct up_session *session); + +int up_session_discard(struct up_session *session) +{ + struct osmo_fsm_inst *fi = session->fi; + if (fi->state == UP_SESSION_ST_WAIT_USE_COUNT) + return 0; + up_session_fsm_state_chg(UP_SESSION_ST_WAIT_USE_COUNT); + return 1; +} + +static void up_session_wait_use_count_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + struct up_session *session = fi->priv; + + drop_gtp_actions(session); + up_session_clear_pdr_far(session); + + if (!osmo_use_count_total(&session->use_count)) + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); +} + +static void up_session_wait_use_count_action(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + switch (event) { + + case UP_SESSION_EV_USE_COUNT_ZERO: + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); + return; + + default: + OSMO_ASSERT(false); + } +} + +static void up_session_clear_pdr_far(struct up_session *session) +{ + struct pdr *pdr; + struct far *far; + while ((pdr = llist_first_entry_or_null(&session->pdrs, struct pdr, entry))) + pdr_del(pdr); + while ((far = llist_first_entry_or_null(&session->fars, struct far, entry))) + far_del(far); +} + +static void drop_gtp_actions(struct up_session *session); + +static void up_session_fsm_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) +{ + struct up_session *session = fi->priv; + + drop_gtp_actions(session); + + up_session_clear_pdr_far(session); + + hash_del(&session->node_by_up_seid); + hash_del(&session->node_by_cp_seid); +} + +#define S(x) (1 << (x)) + +static const struct osmo_fsm_state up_session_fsm_states[] = { + [UP_SESSION_ST_INIT] = { + .name = "INIT", + .in_event_mask = 0 + | S(UP_SESSION_EV_RX_SESSION_EST_REQ) + | S(UP_SESSION_EV_RX_SESSION_DEL_REQ) + | S(UP_SESSION_EV_USE_COUNT_ZERO) + , + .out_state_mask = 0 + | S(UP_SESSION_ST_ESTABLISHED) + | S(UP_SESSION_ST_WAIT_USE_COUNT) + , + .action = up_session_init_action, + }, + [UP_SESSION_ST_ESTABLISHED] = { + .name = "ESTABLISHED", + .in_event_mask = 0 + | S(UP_SESSION_EV_RX_SESSION_MOD_REQ) + | S(UP_SESSION_EV_RX_SESSION_DEL_REQ) + | S(UP_SESSION_EV_USE_COUNT_ZERO) + , + .out_state_mask = 0 + | S(UP_SESSION_ST_WAIT_USE_COUNT) + , + .onenter = up_session_established_onenter, + .action = up_session_established_action, + .onleave = up_session_established_onleave, + }, + [UP_SESSION_ST_WAIT_USE_COUNT] = { + .name = "WAIT_USE_COUNT", + .in_event_mask = 0 + | S(UP_SESSION_EV_USE_COUNT_ZERO) + , + .onenter = up_session_wait_use_count_onenter, + .action = up_session_wait_use_count_action, + }, +}; + +static struct osmo_fsm up_session_fsm = { + .name = "up_session", + .states = up_session_fsm_states, + .num_states = ARRAY_SIZE(up_session_fsm_states), + .log_subsys = DSESSION, + .event_names = up_session_fsm_event_names, + .timer_cb = up_session_fsm_timer_cb, + .cleanup = up_session_fsm_cleanup, +}; + +static __attribute__((constructor)) void up_session_fsm_register(void) +{ + OSMO_ASSERT(osmo_fsm_register(&up_session_fsm) == 0); +} + +static int up_session_use_cb(struct osmo_use_count_entry *e, int32_t old_use_count, const char *file, int line) +{ + struct up_session *session = e->use_count->talloc_object; + int32_t total; + int level; + + if (!e->use) + return -EINVAL; + + total = osmo_use_count_total(&session->use_count); + + if (total == 0 + || (total == 1 && old_use_count == 0 && e->count == 1)) + level = LOGL_INFO; + else + level = LOGL_DEBUG; + + LOGPFSMSLSRC(session->fi, DREF, level, file, line, + "%s %s: now used by %s\n", + (e->count - old_use_count) > 0 ? "+" : "-", e->use, + osmo_use_count_to_str_c(OTC_SELECT, &session->use_count)); + + if (e->count < 0) + return -ERANGE; + + if (total == 0) + osmo_fsm_inst_dispatch(session->fi, UP_SESSION_EV_USE_COUNT_ZERO, NULL); + return 0; +} + +static void up_session_update_id(struct up_session *session) +{ + osmo_fsm_inst_update_id_f_sanitize(session->fi, '-', "%s-0x%" PRIx64, + up_peer_remote_addr_str(session->up_peer), + session->up_seid); + LOGPFSML(session->fi, LOGL_DEBUG, "Updated id\n"); +} + +static inline uint64_t up_session_key(uint64_t cp_seid, uint64_t up_seid) +{ + return cp_seid + up_seid; +} + +static struct up_session *up_session_add(struct up_peer *peer, const struct osmo_pfcp_ie_f_seid *cp_f_seid) +{ + struct up_session *session; + uint64_t up_seid = up_endpoint_next_seid(peer->up_endpoint); + + if (!up_seid) + return NULL; + + struct osmo_fsm_inst *fi = osmo_fsm_inst_alloc_child(&up_session_fsm, peer->fi, UP_PEER_EV_SESSION_TERM); + OSMO_ASSERT(fi); + + session = talloc(fi, struct up_session); + OSMO_ASSERT(session); + fi->priv = session; + + *session = (struct up_session) { + .fi = fi, + .up_peer = peer, + .cp_f_seid = *cp_f_seid, + .up_seid = up_seid, + .use_count = { + .talloc_object = session, + .use_cb = up_session_use_cb, + }, + }; + INIT_LLIST_HEAD(&session->pdrs); + INIT_LLIST_HEAD(&session->fars); + INIT_LLIST_HEAD(&session->chosen_f_teids); + INIT_LLIST_HEAD(&session->active_gtp_actions); + osmo_use_count_make_static_entries(&session->use_count, session->use_count_buf, ARRAY_SIZE(session->use_count_buf)); + LOGPFSML(session->fi, LOGL_INFO, "Allocated new UP-SEID: 0x%" PRIx64 "\n", session->up_seid); + up_session_update_id(session); + + hash_add(peer->sessions_by_up_seid, &session->node_by_up_seid, session->up_seid); + hash_add(peer->sessions_by_cp_seid, &session->node_by_cp_seid, session->cp_f_seid.seid); + return session; +} + +struct up_session *up_session_find_or_add(struct up_peer *peer, const struct osmo_pfcp_ie_f_seid *cp_f_seid, + const struct osmo_pfcp_ie_f_seid *up_f_seid) +{ + struct up_session *session; + if (cp_f_seid) + session = up_session_find_by_cp_f_seid(peer, cp_f_seid); + else if (up_f_seid) + session = up_session_find_by_up_seid(peer, up_f_seid->seid); + else + return NULL; + if (session) + return session; + + return up_session_add(peer, cp_f_seid); +} + +struct up_session *up_session_find_by_up_seid(struct up_peer *peer, uint64_t up_seid) +{ + struct up_session *session; + hash_for_each_possible(peer->sessions_by_up_seid, session, node_by_up_seid, up_seid) { + if (up_seid == session->up_seid) + return session; + } + return NULL; +} + +struct up_session *up_session_find_by_cp_f_seid(struct up_peer *peer, const struct osmo_pfcp_ie_f_seid *cp_f_seid) +{ + struct up_session *session; + hash_for_each_possible(peer->sessions_by_cp_seid, session, node_by_cp_seid, cp_f_seid->seid) { + if (osmo_pfcp_ie_f_seid_cmp(&session->cp_f_seid, cp_f_seid) == 0) + return session; + } + return NULL; +} + +struct up_session *up_session_find_by_local_teid(struct up_peer *peer, uint32_t teid) +{ + struct up_session *session; + int bkt; + hash_for_each(peer->sessions_by_up_seid, bkt, session, node_by_up_seid) { + struct pdr *pdr; + llist_for_each_entry(pdr, &session->pdrs, entry) { + if (!pdr->local_f_teid) + continue; + if (pdr->local_f_teid->fixed.teid == teid) + return session; + } + } + return NULL; +} + +static bool action_is_forw(const struct osmo_pfcp_ie_apply_action *aa) +{ + return osmo_pfcp_bits_get(aa->bits, OSMO_PFCP_APPLY_ACTION_FORW) + && !osmo_pfcp_bits_get(aa->bits, OSMO_PFCP_APPLY_ACTION_DROP); +} + +static void pdr_classify(struct pdr *pdr) +{ + pdr->rx_decaps = false; + pdr->forw_encaps = false; + pdr->forw_to_core = false; + pdr->forw_from_core = false; + if (!pdr->far) + return; + + pdr->rx_decaps = (pdr->desc.outer_header_removal_present + && pdr->desc.outer_header_removal.desc == OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4); + pdr->forw_encaps = (pdr->far->desc.forw_params_present + && pdr->far->desc.forw_params.outer_header_creation_present); + + if (!action_is_forw(&pdr->far->desc.apply_action)) + return; + + pdr->forw_to_core = (pdr->desc.pdi.source_iface == OSMO_PFCP_SOURCE_IFACE_ACCESS + && pdr->far->desc.forw_params.destination_iface == OSMO_PFCP_DEST_IFACE_CORE); + + pdr->forw_from_core = (pdr->desc.pdi.source_iface == OSMO_PFCP_SOURCE_IFACE_CORE + && pdr->far->desc.forw_params.destination_iface == OSMO_PFCP_DEST_IFACE_ACCESS); +} + +void pdr_reverse_set(struct pdr *a, struct pdr *b) +{ + if (a) + a->reverse_pdr = b; + if (b) + b->reverse_pdr = a; +} + +void pdr_reverse_unset(struct pdr *pdr) +{ + if (!pdr->reverse_pdr) + return; + pdr->reverse_pdr->reverse_pdr = NULL; + pdr->reverse_pdr = NULL; +} + +static void log_inactive_pdr_set(struct pdr *pdr, const char *desc, const struct pdr *pdr_to_str) +{ + struct pdr *rpdr = pdr->reverse_pdr; + pdr_to_str = pdr_to_str ? : pdr; + osmo_talloc_replace_string_fmt(pdr, &pdr->inactive_reason, "%s (in PDR-%u %s)", desc, + pdr_to_str->desc.pdr_id, + osmo_pfcp_source_iface_str(pdr_to_str->desc.pdi.source_iface)); + if (rpdr) + osmo_talloc_replace_string_fmt(rpdr, &rpdr->inactive_reason, "%s (in PDR-%u %s)", desc, + pdr_to_str->desc.pdr_id, + osmo_pfcp_source_iface_str(pdr_to_str->desc.pdi.source_iface)); + if (rpdr) + LOGPFSML(pdr->session->fi, LOGL_INFO, "Inactive set: PDR-%u + PDR-%u: %s: %s\n", + pdr->desc.pdr_id, rpdr->desc.pdr_id, desc, pdr_to_str_c(OTC_SELECT, pdr_to_str)); + else + LOGPFSML(pdr->session->fi, LOGL_INFO, "Inactive: PDR-%u: %s: %s\n", + pdr->desc.pdr_id, desc, pdr_to_str_c(OTC_SELECT, pdr_to_str)); +} + +/* A GTP tunnel on Access side, plain IP on Core side. + * The given PDR must have an outer-header-removal and a local F-TEID. + * Its reverse-PDR must have a UE address flagged as "Destination" IP addr. + * Its reverse-PDR's FAR must have an outer-header creation with a remote TEID. + */ +static void add_gtp_action_endecaps(void *ctx, struct llist_head *dst, struct pdr *pdr) +{ + struct up_session *session = pdr->session; + struct up_gtp_action *a; + struct pdr *rpdr; + struct far *rfar; + struct osmo_pfcp_ie_forw_params *rfar_forw; + + OSMO_ASSERT(pdr->far); + OSMO_ASSERT(pdr->reverse_pdr); + OSMO_ASSERT(pdr->reverse_pdr->far); + + /* To decaps, we need to have a local TEID assigned for which to receive GTP packets. */ + if (!pdr->local_f_teid || pdr->local_f_teid->choose_flag) { + log_inactive_pdr_set(pdr, "missing local TEID", pdr); + return; + } + + /* To encaps, we need to have a remote TEID assigned to send out in GTP packets, and we need to know where to + * send GTP to. */ + rpdr = pdr->reverse_pdr; + rfar = rpdr->far; + rfar_forw = &rfar->desc.forw_params; + if (!rfar->desc.forw_params_present) { + log_inactive_pdr_set(pdr, "missing FAR Forwarding Parameters", rpdr); + return; + } + if (!rfar_forw->outer_header_creation_present) { + log_inactive_pdr_set(pdr, "missing FAR Outer Header Creation", rpdr); + return; + } + if (!rfar_forw->outer_header_creation.teid_present) { + log_inactive_pdr_set(pdr, "missing TEID in FAR Outer Header Creation", rpdr); + return; + } + if (!rfar_forw->outer_header_creation.ip_addr.v4_present) { + log_inactive_pdr_set(pdr, "missing IPv4 in FAR Outer Header Creation", rpdr); + return; + } + + /* To receive packets to be encapsulated, we need to know the assigned IP address for the UE, which receives the + * IP packets that should be placed into GTP. */ + if (!rpdr->desc.pdi.ue_ip_address_present) { + log_inactive_pdr_set(pdr, "missing UE IP Address in PDI", rpdr); + return; + } + if (!rpdr->desc.pdi.ue_ip_address.ip_addr.v4_present) { + log_inactive_pdr_set(pdr, "UE IP Address in PDI is not IPv4", rpdr); + return; + } + if (!rpdr->desc.pdi.ue_ip_address.ip_is_destination) { + log_inactive_pdr_set(pdr, "UE IP Address in PDI is not flagged as destination", rpdr); + return; + } + + pdr->active = true; + pdr->far->active = true; + rpdr->active = true; + rpdr->far->active = true; + LOGPFSML(session->fi, LOGL_DEBUG, "Active PDR set: %s\n", pdr_to_str_c(OTC_SELECT, pdr)); + LOGPFSML(session->fi, LOGL_DEBUG, "Active PDR set: + %s\n", pdr_to_str_c(OTC_SELECT, rpdr)); + + talloc_free(pdr->inactive_reason); + pdr->inactive_reason = NULL; + talloc_free(rpdr->inactive_reason); + rpdr->inactive_reason = NULL; + + a = talloc(ctx, struct up_gtp_action); + OSMO_ASSERT(a); + *a = (struct up_gtp_action){ + .session = session, + .pdr_core = pdr->desc.pdr_id, + .pdr_access = rpdr->desc.pdr_id, + .kind = UP_GTP_U_ENDECAPS, + .endecaps = { + .local_teid = pdr->local_f_teid->fixed.teid, + .remote_teid = rfar_forw->outer_header_creation.teid, + .gtp_remote_addr = rfar_forw->outer_header_creation.ip_addr.v4, + .ue_addr = rpdr->desc.pdi.ue_ip_address.ip_addr.v4, + }, + }; + + llist_add_tail(&a->entry, dst); +} + +static void add_gtp_action_forw(void *ctx, struct llist_head *dst, struct pdr *pdr) +{ + /* TODO implement GTP forwarding with TEID translation */ +} + +/* Analyse all PDRs and FARs and find configurations that match either a GTP encaps/decaps or a GTP forward rule. Add to + * list dst, containing struct up_gtp_action instances allocated from ctx. */ +static enum osmo_pfcp_cause find_gtp_actions(void *ctx, struct llist_head *dst, struct up_session *session) +{ + struct far *far; + struct pdr *pdr; + + llist_for_each_entry(far, &session->fars, entry) { + far->active = false; + } + + llist_for_each_entry(pdr, &session->pdrs, entry) { + pdr->reverse_pdr = NULL; + pdr_classify(pdr); + pdr->active = false; + } + + llist_for_each_entry(pdr, &session->pdrs, entry) { + struct pdr *other; + + /* Already paired up in an earlier iteration? */ + if (pdr->reverse_pdr) + continue; + + /* In this outer loop, only follow the forw_to_core directed PDRs, in the inner loop find the matching + * forw_from_core PDR. */ + if (!pdr->forw_to_core) + continue; + + /* If a required TEID is not known, we cannot pair this PDR up */ + if (pdr->rx_decaps && !pdr->local_f_teid) + continue; + + /* Try to find a matching PDR+FAR that points in the reverse direction. */ + llist_for_each_entry(other, &session->pdrs, entry) { + /* Already paired up in an earlier iteration? */ + if (other->reverse_pdr) + continue; + + /* Looking for a PDR facing the other way */ + if (!other->forw_from_core) + continue; + /* GTP header-ness must match, in reverse. */ + if (pdr->rx_decaps != other->forw_encaps + || pdr->forw_encaps != other->rx_decaps) + continue; + + /* TEID: when adding a GTP header, we only know the remote side TEID sent out. + * When removing a GTP header, we only know the local TEID that the remote side sends here. + * So can't match up TEIDs. */ + + /* Just match these up, simply based on direction and encaps/decaps match */ + pdr_reverse_set(pdr, other); + } + } + + /* Iterate again to create the GTP actions (and debug log what is going on) */ + llist_for_each_entry(pdr, &session->pdrs, entry) { + if (!pdr->reverse_pdr) { + LOGPFSML(session->fi, LOGL_INFO, "Inactive PDR: no matching reverse PDR for: %s\n", pdr_to_str_c(OTC_SELECT, pdr)); + continue; + } + + /* Iterate in direction to-Core, where pdr->reverse_pdr will be the from-Core counterpart. */ + if (!pdr->forw_to_core) + continue; + + if (pdr->rx_decaps && !pdr->forw_encaps) + add_gtp_action_endecaps(ctx, dst, pdr); + else if (pdr->rx_decaps && pdr->forw_encaps) + add_gtp_action_forw(ctx, dst, pdr); + else { + /* log the details of both PDRs in two separate log lines */ + log_inactive_pdr_set(pdr, "not implemented", pdr); + log_inactive_pdr_set(pdr, "not implemented", pdr->reverse_pdr); + } + + } + + return OSMO_PFCP_CAUSE_REQUEST_ACCEPTED; +} + +static enum osmo_pfcp_cause setup_gtp_actions(struct up_session *session, struct llist_head *want) +{ + struct up_gtp_action *a, *a_safe; + struct up_gtp_action *w, *w_safe; + + LOGPFSML(session->fi, LOGL_DEBUG, "GTP actions: %u previously active; want active: %u\n", + llist_count(&session->active_gtp_actions), llist_count(want)); + + llist_for_each_entry(w, want, entry) { + LOGPFSML(session->fi, LOGL_DEBUG, "want: %s\n", up_gtp_action_to_str_c(OTC_SELECT, w)); + w->handle = NULL; + } + + /* Match up the wanted GTP tunnels with the already active ones */ + llist_for_each_entry(a, &session->active_gtp_actions, entry) { + LOGPFSML(session->fi, LOGL_DEBUG, "active: %s\n", up_gtp_action_to_str_c(OTC_SELECT, a)); + a->handle = NULL; + llist_for_each_entry(w, want, entry) { + /* Already matched up? */ + if (w->handle) + continue; + if (up_gtp_action_cmp(a, w)) + continue; + /* Found a match, mark. */ + a->handle = w; + w->handle = a; + } + } + + /* At this point, all matching entries in session->active_gtp_actions and the 'want' list have a handle != NULL. + * If handle == NULL in active_gtp_actions, it means it has no match in the wanted list and is to be torn down. + * If handle == NULL in 'want', it means it has no match in the active list and should be created. */ + + /* Shut down all active GTP rules that no longer appear in the session setup. */ + llist_for_each_entry_safe(a, a_safe, &session->active_gtp_actions, entry) { + if (a->handle) + continue; + + LOGPFSML(session->fi, LOGL_DEBUG, "disabling: %s\n", up_gtp_action_to_str_c(OTC_SELECT, a)); + up_gtp_action_disable(a); + llist_del(&a->entry); + talloc_free(a); + } + + /* Set up all GTP tunnels requested in the session setup, but not active yet */ + llist_for_each_entry_safe(w, w_safe, want, entry) { + if (w->handle) + continue; + + LOGPFSML(session->fi, LOGL_DEBUG, "enabling: %s\n", up_gtp_action_to_str_c(OTC_SELECT, w)); + + /* If enabling fails, don't add to the active list. Error logging is done in up_gtp_action_enable(). */ + if (up_gtp_action_enable(w)) + continue; + + /* Successfully activated, move the entry from 'want' to 'active_gtp_actions' */ + llist_del(&w->entry); + talloc_steal(session, w); + llist_add_tail(&w->entry, &session->active_gtp_actions); + } + + return OSMO_PFCP_CAUSE_REQUEST_ACCEPTED; +} + +static void drop_gtp_actions(struct up_session *session) +{ + struct llist_head empty; + INIT_LLIST_HEAD(&empty); + setup_gtp_actions(session, &empty); +} + +/* Check whether the Packet Detection and Forwarding Action Rules amount to an encaps/decaps of GTP or a GTP forwarding, + * or none of the two. */ +static enum osmo_pfcp_cause up_session_setup_gtp(struct up_session *session) +{ + enum osmo_pfcp_cause cause; + struct llist_head want_gtp_actions; + INIT_LLIST_HEAD(&want_gtp_actions); + cause = find_gtp_actions(OTC_SELECT, &want_gtp_actions, session); + if (cause != OSMO_PFCP_CAUSE_REQUEST_ACCEPTED) + return cause; + cause = setup_gtp_actions(session, &want_gtp_actions); + return cause; +} + +bool up_session_is_active(struct up_session *session) +{ + return session && (session->fi->state == UP_SESSION_ST_ESTABLISHED) && !llist_empty(&session->active_gtp_actions); +} + +bool up_session_is_fully_active(struct up_session *session, int *active_p, int *inactive_p) +{ + struct pdr *pdr; + int inactive = 0; + int active = 0; + llist_for_each_entry(pdr, &session->pdrs, entry) { + if (pdr->active) + active++; + else + inactive++; + } + if (!up_session_is_active(session)) { + inactive += active; + active = 0; + } + if (active_p) + *active_p = active; + if (inactive_p) + *inactive_p = inactive; + return active && !inactive; +} + +int up_session_to_str_buf(char *buf, size_t buflen, struct up_session *session) +{ + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + if (!session) { + OSMO_STRBUF_PRINTF(sb, "session=null"); + return sb.chars_needed; + } + OSMO_STRBUF_PRINTF(sb, "peer:%s SEID-r:0x%"PRIx64" SEID-l:0x%"PRIx64" state:%s", + up_peer_remote_addr_str(session->up_peer), + session->cp_f_seid.seid, session->up_seid, + osmo_fsm_inst_state_name(session->fi)); + return sb.chars_needed; +} + +char *up_session_to_str_c(void *ctx, struct up_session *session) +{ + OSMO_NAME_C_IMPL(ctx, 128, "ERROR", up_session_to_str_buf, session) +} diff --git a/src/osmo-upf/upf.c b/src/osmo-upf/upf.c index 6463e32..936307f 100644 --- a/src/osmo-upf/upf.c +++ b/src/osmo-upf/upf.c @@ -23,13 +23,69 @@ #include <osmocom/core/utils.h> #include <osmocom/core/talloc.h> +#include <osmocom/core/sockaddr_str.h> + +#include <osmocom/pfcp/pfcp_endpoint.h> #include <osmocom/upf/upf.h> +#include <osmocom/upf/up_endpoint.h> +#include <osmocom/upf/upf_gtp.h> struct g_upf *g_upf = NULL; +struct osmo_tdef_group g_upf_tdef_groups[] = { + { "pfcp", "PFCP endpoint timers", osmo_pfcp_tdefs, }, + {} +}; + void g_upf_alloc(void *ctx) { OSMO_ASSERT(g_upf == NULL); g_upf = talloc_zero(ctx, struct g_upf); + + *g_upf = (struct g_upf){ + .pfcp = { + .vty_cfg = { + .local_addr = talloc_strdup(g_upf, UPF_PFCP_LISTEN_DEFAULT), + .local_port = OSMO_PFCP_PORT, + }, + }, + }; + + INIT_LLIST_HEAD(&g_upf->gtp.vty_cfg.devs); + INIT_LLIST_HEAD(&g_upf->gtp.devs); +} + +int upf_pfcp_listen() +{ + struct osmo_sockaddr_str local_addr_str; + struct osmo_sockaddr local_addr; + + OSMO_ASSERT(g_upf); + OSMO_ASSERT(g_upf->pfcp.ep == NULL); + + /* Translate address string from VTY config to osmo_sockaddr: first read into osmo_sockaddr_str, then write to + * osmo_sockaddr. */ + osmo_sockaddr_str_from_str(&local_addr_str, g_upf->pfcp.vty_cfg.local_addr, g_upf->pfcp.vty_cfg.local_port); + osmo_sockaddr_str_to_sockaddr(&local_addr_str, &local_addr.u.sas); + LOGP(DLPFCP, LOGL_NOTICE, "PFCP: Listening on %s\n", osmo_sockaddr_to_str_c(OTC_SELECT, &local_addr)); + + g_upf->pfcp.ep = up_endpoint_init(g_upf, &local_addr); + if (!g_upf->pfcp.ep) { + fprintf(stderr, "Failed to allocate PFCP endpoint.\n"); + return -1; + } + return 0; +} + +int upf_gtp_devs_open() +{ + struct gtp_vty_cfg *c = &g_upf->gtp.vty_cfg; + struct gtp_vty_cfg_dev *d; + + llist_for_each_entry(d, &c->devs, entry) { + if (upf_gtp_dev_open(d->dev_name, d->create, d->local_addr, false, false)) + return -1; + } + return 0; } diff --git a/src/osmo-upf/upf_gtp.c b/src/osmo-upf/upf_gtp.c new file mode 100644 index 0000000..e3435a9 --- /dev/null +++ b/src/osmo-upf/upf_gtp.c @@ -0,0 +1,457 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <stdbool.h> +#include <errno.h> +#include <string.h> +#include <net/if.h> +#include <linux/gtp.h> + +#include <libgtpnl/gtpnl.h> +#include <libgtpnl/gtp.h> + +#include <osmocom/core/socket.h> +#include <osmocom/core/logging.h> +#include <osmocom/core/sockaddr_str.h> + +#include <osmocom/upf/upf.h> +#include <osmocom/upf/upf_gtp.h> + +#define LOG_GTP_TUN(TUN, LEVEL, FMT, ARGS...) \ + LOGP(DGTP, LEVEL, "%s: " FMT, upf_gtp_tun_to_str_c(OTC_SELECT, (TUN)), ##ARGS) + +int upf_gtp_dev_to_str_buf(char *buf, size_t buflen, const struct upf_gtp_dev *dev) +{ + uint16_t v0_port; + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + OSMO_STRBUF_PRINTF(sb, "%s", dev->name ? : "null"); + if (dev->name && dev->ifidx) + OSMO_STRBUF_PRINTF(sb, " [%u]", dev->ifidx); + if (dev->sgsn_mode) + OSMO_STRBUF_PRINTF(sb, " (SGSN)"); + OSMO_STRBUF_PRINTF(sb, " "); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &dev->gtpv1.local_addr); + v0_port = osmo_sockaddr_port(&dev->gtpv0.local_addr.u.sa); + if (dev->gtpv0.enabled && v0_port) + OSMO_STRBUF_PRINTF(sb, "/%u", v0_port); + return sb.chars_needed; +} + +char *upf_gtp_dev_to_str_c(void *ctx, const struct upf_gtp_dev *dev) +{ + OSMO_NAME_C_IMPL(ctx, 64, "ERROR", upf_gtp_dev_to_str_buf, dev) +} + +struct upf_gtp_dev *upf_gtp_dev_find_by_name(const char *name) +{ + struct upf_gtp_dev *dev; + llist_for_each_entry(dev, &g_upf->gtp.devs, entry) { + if (!strcmp(name, dev->name)) + return dev; + } + return NULL; +} + +struct upf_gtp_dev *upf_gtp_dev_first() +{ + return llist_first_entry_or_null(&g_upf->gtp.devs, struct upf_gtp_dev, entry); +} + +/* Tell the kernel to remove the GTP device. Called implicitly by talloc_free() (see upf_gtp_dev_destruct()). */ +static int upf_gtp_dev_delete(struct upf_gtp_dev *dev) +{ + int rc; + if (!dev->name) + return 0; + rc = gtp_dev_destroy(dev->name); + if (rc < 0) { + LOG_GTP_DEV(dev, LOGL_ERROR, "Error while deleting device: %s\n", strerror(errno)); + return rc; + } + LOG_GTP_DEV(dev, LOGL_NOTICE, "Deleted GTP device\n"); + dev->name = NULL; + return 0; +} + +static int upf_gtp_dev_destruct(struct upf_gtp_dev *dev); + +static struct upf_gtp_dev *upf_gtp_dev_alloc(const char *name, const char *local_addr) +{ + struct upf_gtp_dev *dev = upf_gtp_dev_find_by_name(name); + struct osmo_sockaddr_str addr_conv; + local_addr = local_addr ? : "0.0.0.0"; + if (dev) { + LOG_GTP_DEV(dev, LOGL_ERROR, "Device already exists. Cannot create %s %s\n", name, local_addr); + return NULL; + } + dev = talloc(g_upf, struct upf_gtp_dev); + *dev = (struct upf_gtp_dev){ + .name = talloc_strdup(dev, name), + .gtpv0.ofd.fd = -1, + .gtpv1.ofd.fd = -1, + }; + INIT_LLIST_HEAD(&dev->tunnels); + + osmo_sockaddr_str_from_str(&addr_conv, local_addr, PORT_GTP0_U); + + osmo_sockaddr_str_to_sockaddr(&addr_conv, &dev->gtpv0.local_addr.u.sas); + + addr_conv.port = PORT_GTP1_U; + osmo_sockaddr_str_to_sockaddr(&addr_conv, &dev->gtpv1.local_addr.u.sas); + + /* Need to add to list before setting up the destructor. A talloc_free() does automagically remove from the + * list. */ + llist_add(&dev->entry, &g_upf->gtp.devs); + + talloc_set_destructor(dev, upf_gtp_dev_destruct); + + return dev; +} + +static int dev_resolve_ifidx(struct upf_gtp_dev *dev) +{ + int rc; + + dev->ifidx = if_nametoindex(dev->name); + if (dev->ifidx == 0) { + LOG_GTP_DEV(dev, LOGL_ERROR, "No such device: '%s'\n", dev->name); + talloc_free(dev); + return -EIO; + } + /* Let's try something to see if talking to the device works. */ + errno = 0; + rc = gtp_list_tunnel(g_upf->gtp.genl_id, g_upf->gtp.nl); + if (errno) + rc = -errno; + else if (rc) + rc = -EINVAL; + if (rc) { + LOG_GTP_DEV(dev, LOGL_ERROR, "Failed to open GTP device: %s\n", strerror(-rc)); + talloc_free(dev); + return rc; + } + + LOG_GTP_DEV(dev, LOGL_NOTICE, "GTP device ready (ifidx=%u)\n", dev->ifidx); + return 0; +} + +int upf_gtp_dev_open(const char *name, bool create_gtp_dev, const char *local_addr, bool listen_for_gtpv0, bool sgsn_mode) +{ + struct osmo_sockaddr any = { + .u.sin = { + .sin_family = AF_INET, + .sin_port = 0, + .sin_addr = { + .s_addr = INADDR_ANY, + }, + }, + }; + int rc; + struct upf_gtp_dev *dev = upf_gtp_dev_alloc(name, local_addr); + if (!dev) + return -EIO; + + dev->sgsn_mode = sgsn_mode; + + if (listen_for_gtpv0) { + rc = osmo_sock_init_osa_ofd(&dev->gtpv0.ofd, SOCK_DGRAM, 0, &dev->gtpv0.local_addr, &any, + OSMO_SOCK_F_BIND); + if (rc < 0) { + LOG_GTP_DEV(dev, LOGL_ERROR, "Cannot bind GTPv0 on %s (rc=%d)\n", + osmo_sockaddr_to_str_c(OTC_SELECT, &dev->gtpv0.local_addr), rc); + talloc_free(dev); + return -EIO; + } + dev->gtpv0.enabled = true; + LOG_GTP_DEV(dev, LOGL_DEBUG, "GTPv0 bound\n"); + } + + /* GTPv1 */ + rc = osmo_sock_init_osa_ofd(&dev->gtpv1.ofd, SOCK_DGRAM, 0, &dev->gtpv1.local_addr, &any, + OSMO_SOCK_F_BIND); + if (rc < 0) { + LOG_GTP_DEV(dev, LOGL_ERROR, "Cannot bind GTPv1 (rc=%d)\n", rc); + talloc_free(dev); + return -EIO; + } + LOG_GTP_DEV(dev, LOGL_DEBUG, "GTPv1 bound\n"); + + if (create_gtp_dev) { + int gtp0_fd = listen_for_gtpv0 ? dev->gtpv0.ofd.fd : -1; + int gtp1_fd = dev->gtpv1.ofd.fd; + if (dev->sgsn_mode) + rc = gtp_dev_create_sgsn(-1, dev->name, gtp0_fd, gtp1_fd); + else + rc = gtp_dev_create(-1, dev->name, gtp0_fd, gtp1_fd); + if (rc < 0) { + LOG_GTP_DEV(dev, LOGL_ERROR, "Cannot create GTP device: rc=%d\n", rc); + /* name = NULL: signal to the destructor that it does not need to delete the device */ + dev->name = NULL; + talloc_free(dev); + return -EIO; + } + + LOG_GTP_DEV(dev, LOGL_NOTICE, "created GTP device\n"); + dev->created = true; + } + + rc = dev_resolve_ifidx(dev); + if (rc) { + talloc_free(dev); + return -EIO; + } + + return 0; +} + +void upf_gtp_devs_close() +{ + struct upf_gtp_dev *dev; + while ((dev = llist_first_entry_or_null(&g_upf->gtp.devs, struct upf_gtp_dev, entry))) + talloc_free(dev); +} + +void upf_gtp_genl_close() +{ + if (!g_upf->gtp.nl) + return; + genl_socket_close(g_upf->gtp.nl); + g_upf->gtp.nl = NULL; + g_upf->gtp.genl_id = -1; + + LOGP(DGTP, LOGL_NOTICE, "Closed mnl_socket\n"); +} + +/* Open an MNL socket which allows to create and remove GTP devices (requires CAP_NET_ADMIN). */ +int upf_gtp_genl_open() +{ + if (g_upf->gtp.nl && g_upf->gtp.genl_id >= 0) + return 0; + + if (g_upf->gtp.nl) + upf_gtp_genl_close(); + + g_upf->gtp.nl = genl_socket_open(); + if (!g_upf->gtp.nl) { + LOGP(DGTP, LOGL_ERROR, "Cannot open mnl_socket: %s\n", strerror(errno)); + return -EIO; + } + + g_upf->gtp.genl_id = genl_lookup_family(g_upf->gtp.nl, "gtp"); + if (g_upf->gtp.genl_id < 0) { + LOGP(DGTP, LOGL_ERROR, "genl family 'gtp' not found\n"); + return -ENOTSUP; + } + + LOGP(DGTP, LOGL_NOTICE, "Opened mnl_socket\n"); + return 0; +} + +struct upf_gtp_tun { + struct llist_head entry; + + struct upf_gtp_dev *dev; + struct upf_gtp_tun_desc desc; + bool active; +}; + +static int upf_gtp_tun_to_str_buf(char *buf, size_t buflen, const struct upf_gtp_tun *tun) +{ + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + OSMO_STRBUF_PRINTF(sb, "%s:tun{TEID=l:0x%x,r:0x%x UE=", tun->dev->name, tun->desc.local_teid, + tun->desc.remote_teid); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &tun->desc.ue_addr); + OSMO_STRBUF_PRINTF(sb, " GTP-dst="); + OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &tun->desc.gtp_remote_addr); + OSMO_STRBUF_PRINTF(sb, "}"); + return sb.chars_needed; +} + +static char *upf_gtp_tun_to_str_c(void *ctx, const struct upf_gtp_tun *tun) +{ + OSMO_NAME_C_IMPL(ctx, 64, "ERROR", upf_gtp_tun_to_str_buf, tun) +} + +static int upf_gtp_tun_deactivate(struct upf_gtp_tun *tun); + +static int upf_gtp_tun_destruct(struct upf_gtp_tun *tun) +{ + if (tun->active) + upf_gtp_tun_deactivate(tun); + llist_del(&tun->entry); + return 0; +} + +static struct upf_gtp_tun *upf_gtp_tun_alloc(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *desc) +{ + struct upf_gtp_tun *tun = talloc(dev, struct upf_gtp_tun); + OSMO_ASSERT(tun); + *tun = (struct upf_gtp_tun){ + .dev = dev, + .desc = *desc, + }; + llist_add(&tun->entry, &dev->tunnels); + talloc_set_destructor(tun, upf_gtp_tun_destruct); + return tun; +} + +static struct gtp_tunnel *upf_gtp_tun_to_gtp_tunnel(struct upf_gtp_tun *tun) +{ + struct gtp_tunnel *t; + + if (tun->desc.ue_addr.u.sas.ss_family != AF_INET || tun->desc.gtp_remote_addr.u.sas.ss_family != AF_INET) { + LOG_GTP_TUN(tun, LOGL_ERROR, "Only capabale of IPv4\n"); + return NULL; + } + + t = gtp_tunnel_alloc(); + OSMO_ASSERT(t); + gtp_tunnel_set_ifidx(t, tun->dev->ifidx); + gtp_tunnel_set_version(t, GTP_V1); + gtp_tunnel_set_i_tei(t, tun->desc.local_teid); + gtp_tunnel_set_o_tei(t, tun->desc.remote_teid); + gtp_tunnel_set_ms_ip4(t, &tun->desc.ue_addr.u.sin.sin_addr); + gtp_tunnel_set_sgsn_ip4(t, &tun->desc.gtp_remote_addr.u.sin.sin_addr); + return t; +} + +int upf_gtp_tun_activate(struct upf_gtp_tun *tun) +{ + int rc; + struct gtp_tunnel *t; + + if (tun->active) + return -EALREADY; + + t = upf_gtp_tun_to_gtp_tunnel(tun); + if (!t) + return -ENOTSUP; + + errno = 0; + rc = gtp_add_tunnel(g_upf->gtp.genl_id, g_upf->gtp.nl, t); + if (errno) { + rc = -errno; + } else if (rc) { + rc = -EINVAL; + } else { + tun->active = true; + } + + gtp_tunnel_free(t); + return rc; +} + +static struct upf_gtp_tun *upf_gtp_dev_tunnel_find(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *tun_desc) +{ + struct upf_gtp_tun *tun; + llist_for_each_entry(tun, &dev->tunnels, entry) { + if (upf_gtp_tun_desc_cmp(tun_desc, &tun->desc)) + continue; + return tun; + } + return NULL; +} + +int upf_gtp_dev_tunnel_add(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *tun_desc) +{ + struct upf_gtp_tun *tun; + tun = upf_gtp_dev_tunnel_find(dev, tun_desc); + if (!tun) + tun = upf_gtp_tun_alloc(dev, tun_desc); + if (tun->active) + return 0; + return upf_gtp_tun_activate(tun); +} + +int upf_gtp_dev_tunnel_del(struct upf_gtp_dev *dev, const struct upf_gtp_tun_desc *tun_desc) +{ + struct upf_gtp_tun *tun; + int rc; + tun = upf_gtp_dev_tunnel_find(dev, tun_desc); + if (!tun) + return 0; + if (tun->active) { + rc = upf_gtp_tun_deactivate(tun); + if (rc) + return rc; + } + talloc_free(tun); + return 0; +} + +static int upf_gtp_tun_deactivate(struct upf_gtp_tun *tun) +{ + int rc; + struct gtp_tunnel *t; + + if (!tun->active) { + LOG_GTP_TUN(tun, LOGL_ERROR, "Cannot deactivate, not active\n"); + return -EINVAL; + } + + t = upf_gtp_tun_to_gtp_tunnel(tun); + if (!t) + return -EINVAL; + + rc = gtp_del_tunnel(g_upf->gtp.genl_id, g_upf->gtp.nl, t); + if (rc) + LOG_GTP_TUN(tun, LOGL_ERROR, "Failed to delete tunnel: %d %s\n", rc, strerror(rc)); + else + tun->active = false; + + gtp_tunnel_free(t); + return rc; +} + +static int upf_gtp_dev_destruct(struct upf_gtp_dev *dev) +{ + struct upf_gtp_tun *t; + /* Destruct and clean up all active tunnels before deleting the device */ + while ((t = llist_first_entry_or_null(&dev->tunnels, struct upf_gtp_tun, entry))) + talloc_free(t); + llist_del(&dev->entry); + osmo_fd_close(&dev->gtpv0.ofd); + osmo_fd_close(&dev->gtpv1.ofd); + if (dev->created) + upf_gtp_dev_delete(dev); + return 0; +} + +int upf_gtp_tun_desc_cmp(const struct upf_gtp_tun_desc *a, const struct upf_gtp_tun_desc *b) +{ + int r; + + if (a == b) + return 0; + if (!a) + return -1; + if (!b) + return 1; + +#define CMP_MEMB(MEMB) OSMO_CMP(a->MEMB, b->MEMB) + if ((r = CMP_MEMB(local_teid))) + return r; + if ((r = CMP_MEMB(remote_teid))) + return r; + return osmo_sockaddr_cmp(&a->gtp_remote_addr, &b->gtp_remote_addr); +} diff --git a/src/osmo-upf/upf_vty.c b/src/osmo-upf/upf_vty.c new file mode 100644 index 0000000..73d86d1 --- /dev/null +++ b/src/osmo-upf/upf_vty.c @@ -0,0 +1,286 @@ +/* OsmoUpf interface to quagga VTY */ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <osmocom/core/sockaddr_str.h> +#include <osmocom/core/socket.h> + +#include <osmocom/pfcp/pfcp_endpoint.h> +#include <osmocom/pfcp/pfcp_msg.h> + +#include <osmocom/vty/vty.h> +#include <osmocom/vty/command.h> + +#include <osmocom/upf/upf.h> +#include <osmocom/upf/upf_gtp.h> +#include <osmocom/upf/up_endpoint.h> +#include <osmocom/upf/up_peer.h> +#include <osmocom/upf/up_session.h> +#include <osmocom/upf/up_gtp_action.h> + +enum upf_vty_node { + PFCP_NODE = _LAST_OSMOVTY_NODE + 1, + GTP_NODE, +}; + +static struct cmd_node cfg_pfcp_node = { + PFCP_NODE, + "%s(config-pfcp)# ", + 1, +}; + +#define pfcp_vty (g_upf->pfcp.vty_cfg) +#define gtp_vty (g_upf->gtp.vty_cfg) + +DEFUN(cfg_pfcp, cfg_pfcp_cmd, + "pfcp", + "Enter the PFCP configuration node\n") +{ + vty->node = PFCP_NODE; + return CMD_SUCCESS; +} + +static int config_write_pfcp(struct vty *vty) +{ + vty_out(vty, "pfcp%s", VTY_NEWLINE); + if (strcmp(UPF_PFCP_LISTEN_DEFAULT, pfcp_vty.local_addr)) + vty_out(vty, " local-addr %s%s", pfcp_vty.local_addr, VTY_NEWLINE); + return CMD_SUCCESS; +} + +DEFUN(cfg_pfcp_local_addr, cfg_pfcp_local_addr_cmd, + "local-addr IP_ADDR", + "Set the local IP address to bind on for PFCP\n" + "IP address\n") +{ + osmo_talloc_replace_string(g_upf, &pfcp_vty.local_addr, argv[0]); + return CMD_SUCCESS; +} + +static struct cmd_node cfg_gtp_node = { + GTP_NODE, + "%s(config-gtp)# ", + 1, +}; + +DEFUN(cfg_gtp, cfg_gtp_cmd, + "gtp", + "Enter the GTP configuration node\n") +{ + vty->node = GTP_NODE; + return CMD_SUCCESS; +} + +static int config_write_gtp(struct vty *vty) +{ + struct gtp_vty_cfg_dev *d; + vty_out(vty, "gtp%s", VTY_NEWLINE); + + llist_for_each_entry(d, &gtp_vty.devs, entry) { + if (d->create) { + vty_out(vty, " dev create %s", d->dev_name); + if (d->local_addr) + vty_out(vty, " %s", d->local_addr); + vty_out(vty, "%s", VTY_NEWLINE); + } else { + vty_out(vty, " dev use %s%s", d->dev_name, VTY_NEWLINE); + } + } + return CMD_SUCCESS; +} + +#define DEV_STR "Configure the GTP device to use for encaps/decaps.\n" + +DEFUN(cfg_gtp_dev_create, cfg_gtp_dev_create_cmd, + "dev create DEVNAME [LISTEN_ADDR]", + DEV_STR + "create a new GTP device. Will listen on GTPv1 port " OSMO_STRINGIFY_VAL(PORT_GTP1_U) + " and GTPv0 port " OSMO_STRINGIFY_VAL(PORT_GTP0_U) " on the specified interface, or on ANY if LISTEN_ADDR is" + " omitted.\n" + "device name, e.g. 'apn0'\n" + "IPv4 or IPv6 address to listen on, omit for ANY\n") +{ + struct gtp_vty_cfg_dev *d = talloc_zero(g_upf, struct gtp_vty_cfg_dev); + d->create = true; + d->dev_name = talloc_strdup(d, argv[0]); + if (argc > 1) + d->local_addr = talloc_strdup(d, argv[1]); + llist_add(&d->entry, &gtp_vty.devs); + vty_out(vty, "Added GTP device %s (create new)%s", d->dev_name, VTY_NEWLINE); + return CMD_SUCCESS; +} + +DEFUN(cfg_gtp_dev_use, cfg_gtp_dev_use_cmd, + "dev use DEVNAME", + DEV_STR + "use an existing GTP device, e.g. created by 'gtp-link'\n" + "device name, e.g. 'apn0'\n") +{ + struct gtp_vty_cfg_dev *d = talloc_zero(g_upf, struct gtp_vty_cfg_dev); + d->create = false; + d->dev_name = talloc_strdup(d, argv[0]); + llist_add(&d->entry, &gtp_vty.devs); + vty_out(vty, "Added GTP device %s (use existing)%s", d->dev_name, VTY_NEWLINE); + return CMD_SUCCESS; +} + +DEFUN(cfg_gtp_dev_del, cfg_gtp_dev_del_cmd, + "dev delete DEVNAME", + DEV_STR + "Remove a GTP device from the configuration, and delete the device if it was created here.\n" + "device name, e.g. 'apn0'\n") +{ + const char *dev_name = argv[0]; + struct gtp_vty_cfg_dev *d; + struct upf_gtp_dev *dev; + + /* remove from VTY cfg */ + llist_for_each_entry(d, &gtp_vty.devs, entry) { + if (strcmp(d->dev_name, dev_name)) + continue; + llist_del(&d->entry); + break; + } + + /* close device (and possibly delete from system, via talloc destructor) */ + dev = upf_gtp_dev_find_by_name(dev_name); + if (dev) + talloc_free(dev); + return CMD_SUCCESS; +} + +DEFUN(show_pdr, show_pdr_cmd, + "show pdr", + SHOW_STR + "List all sessions' PDR and FAR status\n") +{ + struct up_peer *peer; + int active_count = 0; + int inactive_count = 0; + llist_for_each_entry(peer, &g_upf->pfcp.ep->peers, entry) { + struct up_session *session; + int bkt; + hash_for_each(peer->sessions_by_up_seid, bkt, session, node_by_up_seid) { + struct pdr *pdr; + llist_for_each_entry(pdr, &session->pdrs, entry) { + if (!pdr->active) { + vty_out(vty, "%s: inactive: %s%s%s%s", + session->fi->id, pdr_to_str_c(OTC_SELECT, pdr), + pdr->inactive_reason ? ": " : "", + pdr->inactive_reason ? : "", + VTY_NEWLINE); + inactive_count++; + } else { + vty_out(vty, "%s: active: %s%s", + session->fi->id, pdr_to_str_c(OTC_SELECT, pdr), + VTY_NEWLINE); + active_count++; + } + } + } + } + vty_out(vty, "(%d of %d active)%s", active_count, active_count + inactive_count, VTY_NEWLINE); + return CMD_SUCCESS; +} + +DEFUN(show_gtp, show_gtp_cmd, + "show gtp", + SHOW_STR + "Active GTP tunnels and forwardings\n") +{ + struct up_peer *peer; + int count = 0; + + if (!upf_gtp_dev_first()) { + vty_out(vty, "No GTP device open%s", VTY_NEWLINE); + return CMD_SUCCESS; + } + + llist_for_each_entry(peer, &g_upf->pfcp.ep->peers, entry) { + struct up_session *session; + int bkt; + hash_for_each(peer->sessions_by_up_seid, bkt, session, node_by_up_seid) { + struct up_gtp_action *a; + llist_for_each_entry(a, &session->active_gtp_actions, entry) { + vty_out(vty, "%s%s", up_gtp_action_to_str_c(OTC_SELECT, a), VTY_NEWLINE); + count++; + } + } + } + vty_out(vty, "(%d active)%s", count, VTY_NEWLINE); + return CMD_SUCCESS; +} + +DEFUN(show_session, show_session_cmd, + "show session", + SHOW_STR + "PFCP Session status\n") +{ + struct up_peer *peer; + int inactive_count = 0; + int active_count = 0; + int fully_active_count = 0; + + llist_for_each_entry(peer, &g_upf->pfcp.ep->peers, entry) { + struct up_session *session; + int bkt; + hash_for_each(peer->sessions_by_up_seid, bkt, session, node_by_up_seid) { + vty_out(vty, "%s %s%s", + up_session_to_str_c(OTC_SELECT, session), + up_session_gtp_status(session), VTY_NEWLINE); + if (up_session_is_active(session)) { + if (up_session_is_fully_active(session, NULL, NULL)) + fully_active_count++; + else + active_count++; + } else { + inactive_count++; + } + } + } + vty_out(vty, "(%d fully-active + %d partially active + %d inactive)%s", + fully_active_count, active_count, inactive_count, VTY_NEWLINE); + return CMD_SUCCESS; +} + +void upf_vty_init() +{ + OSMO_ASSERT(g_upf != NULL); + + install_element_ve(&show_pdr_cmd); + install_element_ve(&show_gtp_cmd); + install_element_ve(&show_session_cmd); + + install_node(&cfg_pfcp_node, config_write_pfcp); + install_element(CONFIG_NODE, &cfg_pfcp_cmd); + + install_element(PFCP_NODE, &cfg_pfcp_local_addr_cmd); + + install_node(&cfg_gtp_node, config_write_gtp); + install_element(CONFIG_NODE, &cfg_gtp_cmd); + + install_element(GTP_NODE, &cfg_gtp_dev_create_cmd); + install_element(GTP_NODE, &cfg_gtp_dev_use_cmd); + install_element(GTP_NODE, &cfg_gtp_dev_del_cmd); +} + diff --git a/tests/upf.vty b/tests/upf.vty index 02ea1af..107909b 100644 --- a/tests/upf.vty +++ b/tests/upf.vty @@ -2,3 +2,34 @@ OsmoUPF# configure terminal OsmoUPF(config)# show running-config ... + +OsmoUPF(config)# pfcp +OsmoUPF(config-pfcp)# list +... + local-addr IP_ADDR +OsmoUPF(config-pfcp)# local-addr? + local-addr Set the local IP address to bind on for PFCP +OsmoUPF(config-pfcp)# local-addr ? + IP_ADDR IP address +OsmoUPF(config-pfcp)# exit + +OsmoUPF(config)# gtp +OsmoUPF(config-gtp)# list +... + dev create DEVNAME [LISTEN_ADDR] + dev use DEVNAME + dev delete DEVNAME + +OsmoUPF(config-gtp)# dev? + dev Configure the GTP device to use for encaps/decaps. +OsmoUPF(config-gtp)# dev ? + create create a new GTP device. Will listen on GTPv1 port 2152 and GTPv0 port 3386 on the specified interface, or on ANY if LISTEN_ADDR is omitted. + use use an existing GTP device, e.g. created by 'gtp-link' + delete Remove a GTP device from the configuration, and delete the device if it was created here. +OsmoUPF(config-gtp)# dev create ? + DEVNAME device name, e.g. 'apn0' +OsmoUPF(config-gtp)# dev create foo ? + [LISTEN_ADDR] IPv4 or IPv6 address to listen on, omit for ANY +OsmoUPF(config-gtp)# dev delete ? + DEVNAME device name, e.g. 'apn0' +OsmoUPF(config-gtp)# exit -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28308 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I745bcbde6859004c41ddbfd2558036bf9a2d1de2 Gerrit-Change-Number: 28308 Gerrit-PatchSet: 4 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in osmo-upf[master]: add libgtpnl dependency
by neels 19 Jul '22

19 Jul '22

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28307 ) Change subject: add libgtpnl dependency ...................................................................... add libgtpnl dependency Related: SYS#5599 Change-Id: I9928be6f62f5a89d98bdac63428f7a046c95c855 --- M configure.ac M contrib/jenkins.sh M contrib/osmo-upf.spec.in M debian/control 4 files changed, 4 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified neels: Looks good to me, approved diff --git a/configure.ac b/configure.ac index fe41cc9..119aa6c 100644 --- a/configure.ac +++ b/configure.ac @@ -44,6 +44,7 @@ PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 1.5.0) PKG_CHECK_MODULES(LIBOSMOGTLV, libosmo-gtlv >= 0.1.0) PKG_CHECK_MODULES(LIBOSMOPFCP, libosmo-pfcp >= 0.1.0) +PKG_CHECK_MODULES(LIBGTPNL, libgtpnl >= 1.2.0) dnl checks for header files AC_HEADER_STDC diff --git a/contrib/jenkins.sh b/contrib/jenkins.sh index 0b5c457..253d0b8 100755 --- a/contrib/jenkins.sh +++ b/contrib/jenkins.sh @@ -31,6 +31,7 @@ osmo-build-dep.sh libosmocore "" --disable-doxygen osmo-build-dep.sh libosmo-pfcp +osmo-build-dep.sh libgtpnl # Additional configure options and depends CONFIG="" diff --git a/contrib/osmo-upf.spec.in b/contrib/osmo-upf.spec.in index 3ae6ac4..78e8aae 100644 --- a/contrib/osmo-upf.spec.in +++ b/contrib/osmo-upf.spec.in @@ -32,6 +32,7 @@ %if 0%{?suse_version} BuildRequires: systemd-rpm-macros %endif +BuildRequires: pkgconfig(libgtpnl) >= 1.2.0 BuildRequires: pkgconfig(libosmocore) >= 1.6.0 BuildRequires: pkgconfig(libosmoctrl) >= 1.6.0 BuildRequires: pkgconfig(libosmovty) >= 1.6.0 diff --git a/debian/control b/debian/control index 04b8224..cabcd19 100644 --- a/debian/control +++ b/debian/control @@ -12,6 +12,7 @@ pkg-config, python3-minimal, libtalloc-dev, + libgtpnl-dev (>= 1.2.0), libosmocore-dev (>= 1.6.0), osmo-gsm-manuals-dev (>= 1.2.0) Standards-Version: 3.9.8 null-- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28307 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I9928be6f62f5a89d98bdac63428f7a046c95c855 Gerrit-Change-Number: 28307 Gerrit-PatchSet: 2 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in osmo-upf[master]: move libosmo-gtlv to libosmo-pfcp.git
by neels 19 Jul '22

19 Jul '22

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28287 ) Change subject: move libosmo-gtlv to libosmo-pfcp.git ...................................................................... move libosmo-gtlv to libosmo-pfcp.git Related: SYS#5599 Change-Id: Id72cdf94da60d4b6d09d0044c74e672c4412c15d --- M configure.ac M contrib/jenkins.sh M include/osmocom/Makefile.am D include/osmocom/gtlv/Makefile.am D include/osmocom/gtlv/gtlv.h D include/osmocom/gtlv/gtlv_dec_enc.h D include/osmocom/gtlv/gtlv_gen.h M include/osmocom/pfcp/Makefile.am M src/Makefile.am D src/libosmo-gtlv/Makefile.am D src/libosmo-gtlv/gtlv.c D src/libosmo-gtlv/gtlv_dec_enc.c D src/libosmo-gtlv/gtlv_gen.c M src/libosmo-pfcp/Makefile.am M tests/Makefile.am D tests/libosmo-gtlv/Makefile.am D tests/libosmo-gtlv/gtlv_dec_enc_test.c D tests/libosmo-gtlv/gtlv_dec_enc_test.ok D tests/libosmo-gtlv/gtlv_test.c D tests/libosmo-gtlv/gtlv_test.ok D tests/libosmo-gtlv/test_gtlv_gen/Makefile.am D tests/libosmo-gtlv/test_gtlv_gen/gen__myproto_ies_auto.c D tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.c D tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.ok D tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.c D tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.h D tests/libosmo-gtlv/test_tliv/Makefile.am D tests/libosmo-gtlv/test_tliv/gen__myproto_ies_auto.c D tests/libosmo-gtlv/test_tliv/myproto_ies_custom.c D tests/libosmo-gtlv/test_tliv/myproto_ies_custom.h D tests/libosmo-gtlv/test_tliv/tliv_test.c D tests/libosmo-gtlv/test_tliv/tliv_test.ok M tests/libosmo-pfcp/Makefile.am M tests/testsuite.at 34 files changed, 8 insertions(+), 4,769 deletions(-) Approvals: pespin: Looks good to me, but someone else must approve laforge: Looks good to me, approved Jenkins Builder: Verified diff --git a/configure.ac b/configure.ac index 1b2cdea..9ee5011 100644 --- a/configure.ac +++ b/configure.ac @@ -42,6 +42,7 @@ PKG_CHECK_MODULES(LIBOSMOCORE, libosmocore >= 1.5.0) PKG_CHECK_MODULES(LIBOSMOVTY, libosmovty >= 1.5.0) PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 1.5.0) +PKG_CHECK_MODULES(LIBOSMOGTLV, libosmo-gtlv >= 0.1.0) dnl checks for header files AC_HEADER_STDC @@ -197,18 +198,13 @@ AC_OUTPUT( include/Makefile include/osmocom/Makefile - include/osmocom/gtlv/Makefile include/osmocom/pfcp/Makefile include/osmocom/upf/Makefile src/Makefile - src/libosmo-gtlv/Makefile src/libosmo-pfcp/Makefile src/osmo-upf/Makefile tests/Makefile tests/atlocal - tests/libosmo-gtlv/Makefile - tests/libosmo-gtlv/test_gtlv_gen/Makefile - tests/libosmo-gtlv/test_tliv/Makefile tests/libosmo-pfcp/Makefile doc/Makefile doc/examples/Makefile diff --git a/contrib/jenkins.sh b/contrib/jenkins.sh index 05ff623..0b5c457 100755 --- a/contrib/jenkins.sh +++ b/contrib/jenkins.sh @@ -30,6 +30,7 @@ export PATH="$inst/bin:$PATH" osmo-build-dep.sh libosmocore "" --disable-doxygen +osmo-build-dep.sh libosmo-pfcp # Additional configure options and depends CONFIG="" diff --git a/include/osmocom/Makefile.am b/include/osmocom/Makefile.am index 9ed7a41..5a1276e 100644 --- a/include/osmocom/Makefile.am +++ b/include/osmocom/Makefile.am @@ -1,5 +1,4 @@ SUBDIRS = \ - gtlv \ pfcp \ upf \ $(NULL) diff --git a/include/osmocom/gtlv/Makefile.am b/include/osmocom/gtlv/Makefile.am deleted file mode 100644 index fc0cff2..0000000 --- a/include/osmocom/gtlv/Makefile.am +++ /dev/null @@ -1,7 +0,0 @@ -tlv_HEADERS = \ - gtlv.h \ - gtlv_dec_enc.h \ - gtlv_gen.h \ - $(NULL) - -tlvdir = $(includedir)/osmocom/gtlv diff --git a/include/osmocom/gtlv/gtlv.h b/include/osmocom/gtlv/gtlv.h deleted file mode 100644 index d800f71..0000000 --- a/include/osmocom/gtlv/gtlv.h +++ /dev/null @@ -1,157 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <stdint.h> -#include <stdio.h> -#include <stdbool.h> - -struct msgb; -struct osmo_gtlv_load; -struct osmo_gtlv_put; -struct value_string; - -struct osmo_gtlv_tag_inst { - unsigned int tag; - bool instance_present; - unsigned int instance; -}; - -int osmo_gtlv_tag_inst_cmp(const struct osmo_gtlv_tag_inst *a, const struct osmo_gtlv_tag_inst *b); - -int osmo_gtlv_tag_inst_to_str_buf(char *buf, size_t buflen, const struct osmo_gtlv_tag_inst *ti, - const struct value_string *tag_names); -char *osmo_gtlv_tag_inst_to_str_c(void *ctx, const struct osmo_gtlv_tag_inst *ti, - const struct value_string *tag_names); - -/*! TL configuration for osmo_gtlv_load*() and osmo_gtlv_put*(). Depending on these implementations provided by the caller, - * osmo_gtlv can load any sizes of tag and length fields (that don't surpass the value range of unsigned int and size_t, - * respectively), as well as TV (fixed-length) or TvLV (variable-sized length). - * - * See osmo_t8l8v_cfg and osmo_t16l16v_cfg, ready implementations for plain 8bit and 16bit TLV protocols. - * - * libosmo-pfcp serves as example for using this entire TLV API, uncluding de/encoding to structs and generating parts - * of the TLV parsing code based on message definitions. It uses osmo_t16l16v_cfg. - */ -struct osmo_gtlv_cfg { - /*! The length in bytes of the shortest possible TL header (e.g. 4 for T16L16V, or 1 for 8bit tags where TV IEs - * without a length exist). A src_data_len passed to store_tl() below is guaranteed to be >= this value. If at - * any point there is remaining message data smaller than this value, a parsing error is returned. - */ - size_t tl_min_size; - - /*! Read one TL from the start of src_data. - * \param gtlv Return the T (tag) value read from src_data in gtlv->tag. - * Return the L (length) value read from src_data in gtlv->len. - * Return the I (instance) value read from src_data in gtlv->len; ignore if there is no I. - * Return the position just after the TL in gtlv->*val. If there is V data, point at the start of the - * V data in src_data. If there is no V data, point at the byte just after the TL part in src_data. - * \param src_data Part of raw message being decoded. - * \param src_data_len Remaining message data length at src_data. - * \return 0 on success, negative on error. - */ - int (*load_tl)(struct osmo_gtlv_load *gtlv, const uint8_t *src_data, size_t src_data_len); - - /*! Write a TL to dst_data, and return the size of the TL written. - * This is also invoked by osmo_gtlv_put_update_tl() to overwrite a previous TL header. If the TL part's size - * can be different than the first time (e.g. due to a large L value in a TvLV protocol), an implementation can - * use the 'gtlv' arg to figure out how to memmove the message data: - * When invoked by osmo_gtlv_put_tl(), dst_data == gtlv->dst->tail and dst_data_avail == msgb_tailroom(). - * When invoked by osmo_gtlv_put_update_tl(), dst_data < gtlv->dst->tail, dst_data points at the start of the - * TL section written earlier by osmo_gtlv_put_tl() and dst_data_avail == the size of the TL written earlier. - * - * \param dst_data Write TL data to the start of this buffer. - * \param dst_data_avail Remaining available space in dst_data. - * \param tag The T value to store in dst_data. - * \param instance The I value to store in dst_data (if this tag is a TLIV); ignore when not a TLIV. - * \param len The L value to store in dst_data. - * \param gtlv Backpointer to the osmo_gtlv_put struct, including gtlv->dst, the underlying msgb. - * \return the size of the TL part in bytes on success, -EINVAL if tag is invalid, -EMSGSIZE if len is too large - * or dst_data_avail is too small for the TL. - */ - int (*store_tl)(uint8_t *dst_data, size_t dst_data_avail, const struct osmo_gtlv_tag_inst *ti, size_t len, - struct osmo_gtlv_put *gtlv); -}; - -/*! Configuration that allows parsing an 8bit tag and 8bit length TLV. */ -extern const struct osmo_gtlv_cfg osmo_t8l8v_cfg; - -/*! Configuration that allows parsing a 16bit tag and 16bit length TLV (see for example PFCP). */ -extern const struct osmo_gtlv_cfg osmo_t16l16v_cfg; - -/*! State for loading a TLV structure from raw data. */ -struct osmo_gtlv_load { - /*! Caller-defined context pointer available for use by load_tl() and store_tl() implementations. */ - void *priv; - - /*! Definition of tag and length sizes (by function pointers). */ - const struct osmo_gtlv_cfg *cfg; - - /*! Overall message buffer being parsed. */ - struct { - const uint8_t *data; - size_t len; - } src; - - /*! Return value from last invocation of osmo_gtlv_load_next*(): tag value of parsed IE. */ - struct osmo_gtlv_tag_inst ti; - /*! Return value from last invocation of osmo_gtlv_load_next*(): Start of the IE's payload data (after tag and - * length). If the end of the src buffer is reached, val == NULL. If a TLV contained no value part, len == 0, - * but this still points just after the TL. */ - const uint8_t *val; - /*! Return value from last invocation of osmo_gtlv_load_next*(): Length of the IE's payload data (without tag and - * length) */ - size_t len; -}; - -/* Start or restart the gtlv from the first IE in the overall TLV data. */ -static inline void osmo_gtlv_load_start(struct osmo_gtlv_load *gtlv) -{ - gtlv->val = NULL; -} - -int osmo_gtlv_load_next(struct osmo_gtlv_load *gtlv); -int osmo_gtlv_load_peek_tag(const struct osmo_gtlv_load *gtlv, struct osmo_gtlv_tag_inst *ti); -int osmo_gtlv_load_next_by_tag(struct osmo_gtlv_load *gtlv, unsigned int tag); -int osmo_gtlv_load_next_by_tag_inst(struct osmo_gtlv_load *gtlv, const struct osmo_gtlv_tag_inst *ti); - -/* State for storing a TLV structure into a msgb. */ -struct osmo_gtlv_put { - /*! Caller-defined context pointer available for use by load_tl() and store_tl() implementations. */ - void *priv; - - /* Definition of tag and length sizes (by function pointers). */ - const struct osmo_gtlv_cfg *cfg; - - /* msgb to append new TL to */ - struct msgb *dst; - /* What was the last TL written and where are its TL and V */ - struct osmo_gtlv_tag_inst last_ti; - uint8_t *last_tl; - uint8_t *last_val; -}; - -int osmo_gtlv_put_tl(struct osmo_gtlv_put *gtlv, unsigned int tag, size_t len); -int osmo_gtlv_put_tli(struct osmo_gtlv_put *gtlv, const struct osmo_gtlv_tag_inst *ti, size_t len); -int osmo_gtlv_put_update_tl(struct osmo_gtlv_put *gtlv); diff --git a/include/osmocom/gtlv/gtlv_dec_enc.h b/include/osmocom/gtlv/gtlv_dec_enc.h deleted file mode 100644 index 132239f..0000000 --- a/include/osmocom/gtlv/gtlv_dec_enc.h +++ /dev/null @@ -1,201 +0,0 @@ -/* Decode and encode the value parts of a TLV structure */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <stdbool.h> - -#include <osmocom/gtlv/gtlv.h> - -struct value_string; - -/* User defined function to decode a single TLV value part. See struct osmo_gtlv_coding. - * \param decoded_struct Pointer to the root struct, as context information, e.g. for logging. - * \param decode_to Pointer to the struct member, write the decoded value here. - * \param gtlv TLV loader, pointing at a gtlv->val of gtlv->len bytes. - * \return 0 on success, nonzero on error, e.g. -EINVAL if the gtlv->val is invalid. - */ -typedef int (*osmo_gtlv_dec_func)(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv); - -/* User defined function to encode a single TLV value part. See struct osmo_gtlv_coding. - * \param gtlv TLV writer, pointing at a gtlv->dst to msgb_put() data in. - * \param decoded_struct Pointer to the root struct, as context information, e.g. for logging. - * \param encode_from Pointer to the struct member, obtain the value to encode from here. - * \return 0 on success, nonzero on error, e.g. -EINVAL if encode_from has an un-encodable value. - */ -typedef int (*osmo_gtlv_enc_func)(struct osmo_gtlv_put *gtlv, const void *decoded_struct, const void *encode_from); - -/* Optional user defined function to convert a decoded IE struct (the Value part stored as C struct) to string. See - * struct osmo_gtlv_coding. - * \param buf Return string in this buffer. - * \param buflen Size of buf. - * \param str_of Pointer to the struct member described by an osmo_gtlv_coding, obtain the value to encode from here. - * \return number of characters that would be written if the buffer is large enough, like snprintf(). - */ -typedef int (*osmo_gtlv_enc_to_str_func)(char *buf, size_t buflen, const void *str_of); - -/* Whether TLV structures nested inside the value data of an outer IE should be parsed in the same order. */ -enum osmo_gtlv_coding_nested_ies_ordered { - /*! When stepping into nested IEs, keep the same ordering requirement as the outer IE. */ - OSMO_GTLV_NESTED_IES_ORDERING_SAME = 0, - /*! Require IEs in a PDU to appear exactly in the order defined by osmo_gtlv_coding arrays. Causes a parsing - * failure if the TLVs appear in a different order. Does much less iterating looking for matching tags when - * decoding (faster). */ - OSMO_GTLV_NESTED_IES_ORDERED, - /*! Do not require IEs to be in the defined order in decoded PDUs. When encoding a TLV, IEs will always be - * encoded in the order they are defined. This has an effect on decoding only. */ - OSMO_GTLV_NESTED_IES_UNORDERED, -}; - -#define OSMO_ARRAY_PITCH(arr) ((char *)(&(arr)[1]) - (char *)(arr)) -#define OSMO_MEMB_ARRAY_PITCH(obj_type, arr_memb) OSMO_ARRAY_PITCH(((obj_type *)0)->arr_memb) - -/*! Definition of how to decode/encode a IE to/from a struct. - * Kept in lists describing TLV structures, and nestable. - * - * Instance lists of this can be composed manually, or auto-generated using gtlv_gen.c. Auto-generating has the benefit - * that the decoded structs to match the IEs are also generated at the same time and thus always match the message - * definitions. For an example, see tests/libosmo-gtlv/test_gtlv_gen/. */ -struct osmo_gtlv_coding { - /*! the IEI discriminator, and optional instance number */ - struct osmo_gtlv_tag_inst ti; - - /*! Decoding function callback. Invoked for each defined and present IE encountered in the message. - * Return 0 on success, negative on failure. */ - osmo_gtlv_dec_func dec_func; - /*! Encoding function callback. Invoked for each defined and present IE encountered in the message. - * Return 0 on success, negative on failure. */ - osmo_gtlv_enc_func enc_func; - - /*! Means to output the decoded value to a human readable string, optional. */ - osmo_gtlv_enc_to_str_func enc_to_str_func; - - /*! offsetof(decoded_struct_type, member_var): how far into the base struct you find a specific field for decoded - * value. For example, memb_ofs = offsetof(struct foo_msg, ies.bar_response.cause). - * When decoding, the decoded value is written here, when encoding it is read from here. */ - unsigned int memb_ofs; - /*! For repeated IEs (.has_count = true), the array pitch / the offset to add to get to the next array index. */ - unsigned int memb_array_pitch; - - /*! True for optional/conditional IEs. */ - bool has_presence_flag; - /* For optional/conditional IEs (has_presence_flag = true), the offset of the bool foo_present flag, - * For example, if there are - * - * struct foo_msg { - * struct baz baz; - * bool baz_present; - * }; - * - * then set - * memb_ofs = offsetof(struct foo_msg, baz); - * has_presence_flag = true; - * presence_flag_ofs = offsetof(struct foo_msg, baz_present); - */ - unsigned int presence_flag_ofs; - - /*! True for repeated IEs, for array members: - * - * struct foo_msg { - * struct moo moo[10]; - * unsigned int moo_count; - * }; - * - * memb_ofs = offsetof(struct foo_msg, moo); - * has_count = true; - * count_ofs = offsetof(struct foo_msg, moo_count); - * count_max = 10; - */ - bool has_count; - /*! For repeated IEs, the offset of the unsigned int foo_count indicator of how many array indexes are - * in use. See has_count. */ - unsigned int count_ofs; - /*! Maximum array size for member_var[]. See has_count. */ - unsigned int count_max; - /*! If nonzero, it is an error when less than this amount of the repeated IE have been decoded. */ - unsigned int count_mandatory; - - /*! For nested TLVs: if this IE's value part is itself a separate TLV structure, point this at the list of IE - * coding definitions for the inner IEs. - * In this example, the nested IEs decode/encode to different sub structs depending on the tag value. - * - * struct bar { - * int aaa; - * int bbb; - * }; - * - * struct foo_msg { - * struct bar bar; - * struct bar other_bar; - * }; - * - * struct osmo_gtlv_coding bar_nested_ies[] = { - * { FOO_IEI_AAA, .memb_ofs = offsetof(struct bar, aaa), }, - * { FOO_IEI_BBB, .memb_ofs = offsetof(struct bar, bbb), }, - * {} - * }; - * - * struct osmo_gtlv_coding foo_msg_ies[] = { - * { FOO_IEI_GOO, .memb_ofs = offsetof(struct foo_msg, bar), .nested_ies = bar_nested_ies, }, - * { FOO_IEI_OTHER_GOO, .memb_ofs = offsetof(struct foo_msg, other_bar), .nested_ies = bar_nested_ies, }, - * {} - * }; - */ - const struct osmo_gtlv_coding *nested_ies; - - /*! If the nested TLV has a different tag/length size than the outer TLV structure, provide a different config - * here. If they are the same, just keep this NULL. */ - const struct osmo_gtlv_cfg *nested_ies_cfg; - - /*! When stepping into nested IEs, what is the ordering requirement for the nested TLV structure? */ - enum osmo_gtlv_coding_nested_ies_ordered nested_ies_ordered; -}; - - -/*! User defined hook for error logging during TLV and value decoding. - * \param decoded_struct Pointer to the base struct describing this message, for context. - * \param file Source file of where the error occurred. - * \param line Source file line of where the error occurred. - * \param fmt Error message string format. - * \param ... Error message string args. - */ -typedef void (*osmo_gtlv_err_cb)(void *data, void *decoded_struct, const char *file, int line, const char *fmt, ...); - -int osmo_gtlvs_decode(void *decoded_struct, unsigned int obj_ofs, struct osmo_gtlv_load *gtlv, bool tlv_ordered, - const struct osmo_gtlv_coding *ie_coding, - osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs); - -int osmo_gtlvs_encode(struct osmo_gtlv_put *gtlv, const void *decoded_struct, unsigned int obj_ofs, - const struct osmo_gtlv_coding *ie_coding, - osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs); - -int osmo_gtlvs_encode_to_str_buf(char *buf, size_t buflen, const void *decoded_struct, unsigned int obj_ofs, - const struct osmo_gtlv_coding *ie_coding, const struct value_string *iei_strs); -char *osmo_gtlvs_encode_to_str_c(void *ctx, const void *decoded_struct, unsigned int obj_ofs, - const struct osmo_gtlv_coding *ie_coding, const struct value_string *iei_strs); - -static inline bool osmo_gtlv_coding_end(const struct osmo_gtlv_coding *iec) -{ - return iec->dec_func == NULL && iec->enc_func == NULL && iec->nested_ies == NULL; -} diff --git a/include/osmocom/gtlv/gtlv_gen.h b/include/osmocom/gtlv/gtlv_gen.h deleted file mode 100644 index 71cec92..0000000 --- a/include/osmocom/gtlv/gtlv_gen.h +++ /dev/null @@ -1,176 +0,0 @@ -/* Write h and c source files for TLV protocol definitions, based on very sparse TLV definitions. - * For a usage example see tests/libosmo-gtlv/test_gtlv_gen/. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <stdbool.h> - -struct osmo_gtlv_gen_ie; - -/* O means optional, M means mandatory. - * If all of the IE struct, tag name and functions can be derived from the name, just pass osmo_gtlv_gen_ie_auto as - * TLV_GEN_IE. */ -#define OSMO_GTLV_GEN_O(TLV_GEN_IE, MEMB_NAME) { MEMB_NAME, .optional = true, .ie = &(TLV_GEN_IE) } -#define OSMO_GTLV_GEN_M(TLV_GEN_IE, MEMB_NAME) { MEMB_NAME, .ie = &(TLV_GEN_IE) } -#define OSMO_GTLV_GEN_O_MULTI(MAX, TLV_GEN_IE, MEMB_NAME) { MEMB_NAME, .multi = MAX, .ie = &(TLV_GEN_IE) } -#define OSMO_GTLV_GEN_M_MULTI(MAX, MAND_COUNT, TLV_GEN_IE, MEMB_NAME) \ - { MEMB_NAME, .multi = MAX, .multi_mandatory = MAND_COUNT, .ie = &(TLV_GEN_IE) } -#define OSMO_GTLV_GEN_O_INST(INSTANCE, TLV_GEN_IE, MEMB_NAME) { MEMB_NAME, .optional = true, .instance = INSTANCE, .ie = &TLV_GEN_IE } -#define OSMO_GTLV_GEN_M_INST(INSTANCE, TLV_GEN_IE, MEMB_NAME) { MEMB_NAME, .instance = INSTANCE, .ie = &(TLV_GEN_IE) } - -#define OSMO_GTLV_GEN_NO_INSTANCE INT_MAX - -/*! osmo_gtlv_gen_ie with all members == NULL, so that all are derived from the member name. */ -extern const struct osmo_gtlv_gen_ie osmo_gtlv_gen_ie_auto; - -/*! Modifier for Mandatory/Optional/Multiple around an osmo_gtlv_gen_ie. */ -struct osmo_gtlv_gen_ie_o { - /*! The C name of the member in a decoded struct, to be of the type defined by .ie. - * All parts of .ie, if NULL, are derived from this name. - * - * For example, simply this - * - * struct osmo_gtlv_gen_ie_o foo[] = { - * OSMO_GTLV_GEN_O("bar", NULL), - * }; - * - * Generates - * - * struct myproto_msg_foo { - * struct myproto_ie_bar bar; - * } - * - * and an osmo_gtlv_coding entry of - * - * { MYPROTO_IEI_BAR, - * .memb_ofs = offsetof(struct myproto_msg_foo, bar), - * .dec_func = myproto_dec_bar, - * .enc_func = myproto_enc_bar, - * .enc_to_str_func = myproto_enc_to_str_bar, - * } - * - * See also osmo_gtlv_gen_cfg.add_enc_to_str. - */ - const char *name; - - /*! Whether to add a bool foo_present, and to skip encoding/decoding if false. - * Only useful for non-multi IEs (compare OSMO_GTLV_GEN_O_MULTI() vs OSMO_GTLV_GEN_M_MULTI()). */ - bool optional; - - /*! If non-NULL, the member is an array: foo[123] with an unsigned int foo_count. - * Set to the maximum number of array elements; for foo[123] set .multi = 123. */ - unsigned int multi; - /*! Number of mandatory occurences of the IE, only has an effect if .multi > 0. */ - unsigned int multi_mandatory; - - /* If any, the instance nr to match, in C that yields an unsigned int. - * e.g. "1" or "MYPROTO_FOO_INST_ONE". */ - const char *instance; - - /*! IE decoding / encoding instructions. If NULL, the entire IE definition is derived from .name. - * 'MYPROTO_IEI_NAME', 'myproto_dec_name()', 'myproto_enc_name()', 'myproto_enc_to_str_name()'. - * Your myproto_ies_custom.h needs to define an enum value MYPROTO_IEI_NAME and*/ - const struct osmo_gtlv_gen_ie *ie; -}; - -/*! Define decoding and encoding of a single IE, i.e. one full TLV. */ -struct osmo_gtlv_gen_ie { - /*! like "uint32_t" or "struct foo". - * If NULL, use "struct myproto_ie_<name>" instead, where <name> comes from the osmo_gtlv_gen_ie_o. - * When there are nested IEs, the struct definition is auto-generated, deriving the struct members from the - * nested_ies list. - * When there are no nested IEs, the type needs to be defined manually by a myproto_ies_custom.h. */ - const char *decoded_type; - - /*! C name of this tag value, e.g. "foo" to use tag "MYPROTO_IEI_FOO". - * If NULL, take "MYPROTO_IEI_"+upper(memb_name) instead, where memb_name comes from the osmo_gtlv_gen_ie_o. - * decoded_type and/or dec_enc may be derived from this, if they are NULL. */ - const char *tag_name; - - /*! Name suffix of the dec/enc functions. "foo" -> myproto_dec_foo(), myproto_enc_foo(), - * myproto_enc_to_str_foo(). - * These functions need to be implemented manually in a myproto_ies_custom.c. - * When osmo_gtlv_gen_cfg.add_enc_to_str is false, the myproto_enc_to_str_foo() is not required. */ - const char *dec_enc; - - /*! List of inner IEs terminated by {}. If non-NULL, this is a "Grouped IE" with an inner TLV structure inside - * this IE's V part. */ - const struct osmo_gtlv_gen_ie_o *nested_ies; - - /*! To place a spec comment in the generated code. */ - const char *spec_ref; -}; - -/*! General TLV decoding and encoding definitions applying to all IEs (and nested IEs). */ -struct osmo_gtlv_gen_cfg { - /*! Name of the protocol for use in C type or function names, like "myproto". */ - const char *proto_name; - - /*! When placing comments to spec references, prefix with this. For example, "3GPP TS 12.345 ". */ - const char *spec_ref_prefix; - - /*! The type to pass a message discriminator as, like 'enum myproto_message_types' */ - const char *message_type_enum; - /*! To reference a message type discriminator like MYPROTO_MSGT_FOO, this would be "MYPROTO_MSGT_". */ - const char *message_type_prefix; - - /*! Type to use to represent tag IEI in decoded form. - * For example "enum foo_msg_iei". */ - const char *tag_enum; - /*! The tag IEI enum value is uppercase(tag_prefix + (iedef->tag_name or iedef->name)). - * For example, with tag_prefix = "OSMO_FOO_IEI_", we would generate code like - * enum osmo_foo_iei tag = OSMO_FOO_IEI_BAR; */ - const char *tag_prefix; - - /*! When an osmo_gtlv_gen_ie provides no decoded_type string, it is derived from .name and this prefix is - * added. For example, with decoded_type_prefix = "struct foo_ie_", the decoded_type defaults to - * struct foo_ie_bar for an IE definition with name = "bar". */ - const char *decoded_type_prefix; - - /*! To include user defined headers, set to something like "#include <osmocom/foo/foo_tlv_devs.h". This is put at - * the head of the generated .h file. */ - const char *h_header; - - /*! To include user defined headers, set to something like "#include <osmocom/foo/foo_msg.h". This is put at - * the head of the generated .c file. */ - const char *c_header; - - /*! Array of message IE definitions, indexed by message type. */ - const struct osmo_gtlv_gen_msg *msg_defs; - - /*! Whether to add to_str functions. When true, every automatically derived IE (that has no nested IEs) needs to - * have a myproto_enc_to_str_foo() defined by a myproto_ies_custom.c. When false, osmo_gtlvs_encode_to_str_buf() - * will print '?' instead of the IE contents. */ - bool add_enc_to_str; -}; - -/*! For generating the outer union that composes a protocol's PDU variants, an entry of the list of message names and - * IEs in each message. */ -struct osmo_gtlv_gen_msg { - const char *name; - const struct osmo_gtlv_gen_ie_o *ies; -}; - -int osmo_gtlv_gen_main(const struct osmo_gtlv_gen_cfg *cfg, int argc, const char **argv); diff --git a/include/osmocom/pfcp/Makefile.am b/include/osmocom/pfcp/Makefile.am index 5d2db19..a9bdeab 100644 --- a/include/osmocom/pfcp/Makefile.am +++ b/include/osmocom/pfcp/Makefile.am @@ -17,9 +17,6 @@ pfcp_ies_auto.h \ $(NULL) -pfcp_ies_auto.h: $(top_srcdir)/src/libosmo-pfcp/gen__pfcp_ies_auto.c \ - $(top_srcdir)/src/libosmo-gtlv/gtlv_gen.c \ - $(top_srcdir)/include/osmocom/gtlv/gtlv_gen.h - $(MAKE) -C $(top_builddir)/src/libosmo-gtlv +pfcp_ies_auto.h: $(top_srcdir)/src/libosmo-pfcp/gen__pfcp_ies_auto.c $(MAKE) -C $(top_builddir)/src/libosmo-pfcp gen__pfcp_ies_auto $(top_builddir)/src/libosmo-pfcp/gen__pfcp_ies_auto h > $(builddir)/pfcp_ies_auto.h diff --git a/src/Makefile.am b/src/Makefile.am index 34cf082..78c8adb 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,5 +1,4 @@ SUBDIRS = \ - libosmo-gtlv \ libosmo-pfcp \ osmo-upf \ $(NULL) diff --git a/src/libosmo-gtlv/Makefile.am b/src/libosmo-gtlv/Makefile.am deleted file mode 100644 index 248ff67..0000000 --- a/src/libosmo-gtlv/Makefile.am +++ /dev/null @@ -1,27 +0,0 @@ -AM_CPPFLAGS = \ - $(all_includes) \ - -I$(top_srcdir)/include \ - -I$(top_builddir) \ - -I$(builddir) \ - $(NULL) - -AM_CFLAGS = \ - -Wall \ - $(LIBOSMOCORE_CFLAGS) \ - $(COVERAGE_CFLAGS) \ - $(NULL) - -AM_LDFLAGS = \ - $(LIBOSMOCORE_LIBS) \ - $(COVERAGE_LDFLAGS) \ - $(NULL) - -noinst_LIBRARIES = \ - libosmo-gtlv.a \ - $(NULL) - -libosmo_gtlv_a_SOURCES = \ - gtlv.c \ - gtlv_dec_enc.c \ - gtlv_gen.c \ - $(NULL) diff --git a/src/libosmo-gtlv/gtlv.c b/src/libosmo-gtlv/gtlv.c deleted file mode 100644 index 9bdbe75..0000000 --- a/src/libosmo-gtlv/gtlv.c +++ /dev/null @@ -1,342 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> - -#include <osmocom/core/bits.h> -#include <osmocom/core/msgb.h> -#include <osmocom/gtlv/gtlv.h> - -int osmo_gtlv_tag_inst_cmp(const struct osmo_gtlv_tag_inst *a, const struct osmo_gtlv_tag_inst *b) -{ - int cmp; - if (a == b) - return 0; - if (!a) - return -1; - if (!b) - return 1; - cmp = OSMO_CMP(a->tag, b->tag); - if (cmp) - return cmp; - cmp = OSMO_CMP(a->instance_present ? 1 : 0, b->instance_present ? 1 : 0); - if (cmp) - return cmp; - if (a->instance_present) - return OSMO_CMP(a->instance, b->instance); - return 0; -} - -int osmo_gtlv_tag_inst_to_str_buf(char *buf, size_t buflen, const struct osmo_gtlv_tag_inst *ti, - const struct value_string *tag_names) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - if (!tag_names) - OSMO_STRBUF_PRINTF(sb, "%u", ti->tag); - else - OSMO_STRBUF_PRINTF(sb, "%s", get_value_string(tag_names, ti->tag)); - if (ti->instance_present) - OSMO_STRBUF_PRINTF(sb, "[%u]", ti->instance); - return sb.chars_needed; -} - -char *osmo_gtlv_tag_inst_to_str_c(void *ctx, const struct osmo_gtlv_tag_inst *ti, - const struct value_string *tag_names) -{ - OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_gtlv_tag_inst_to_str_buf, ti, tag_names) -} - -static int next_tl_valid(const struct osmo_gtlv_load *gtlv, const uint8_t **ie_start_p, size_t *buflen_left_p) -{ - const uint8_t *ie_start; - size_t buflen_left; - - /* Start of next IE, or first IE for first invocation. */ - if (!gtlv->val) - ie_start = gtlv->src.data; - else - ie_start = gtlv->val + gtlv->len; - - /* Sanity */ - if (ie_start < gtlv->src.data || ie_start > gtlv->src.data + gtlv->src.len) - return -ENOSPC; - - buflen_left = gtlv->src.len - (ie_start - gtlv->src.data); - - /* Too short for parsing an IE? Check also against integer overflow. */ - if (buflen_left && ((buflen_left < gtlv->cfg->tl_min_size) || (buflen_left > gtlv->src.len))) - return -EBADMSG; - - *ie_start_p = ie_start; - *buflen_left_p = buflen_left; - return 0; -} - -/* Return a TLV IE from a message buffer. - * - * Return the first or next TLV data found in the data buffer, based on the state of the gtlv parameter. - * When gtlv->val is NULL, return the first IE in the data buffer. - * Otherwise assume that gtlv points at a valid IE in the data structure, and return the subsequent IE. - * - * Usage example: - * - * struct osmo_gtlv gtlv = { - * .cfg = osmo_t16l16v_cfg, - * .src = { .data = msgb_l3(msg), .len = msgb_l3len(msg) }, - * }; - * for (;;) { - * if (osmo_gtlv_next(&gtlv)) { - * printf("Error\n"); - * break; - * } - * if (!gtlv.val) { - * printf("End\n"); - * break; - * } - * printf("Tag %u: %zu octets: %s\n", gtlv.tag, gtlv.len, osmo_hexdump(gtlv.val, gtlv.len)); - * } - * - * \param[inout] gtlv Buffer to return the IE data, and state for TLV parsing position. gtlv->msg should indicate the - * overall message buffer. The other gtlv members should be zero initialized before the first call, and - * remain unchanged between invocations of this function. - * \returns 0 on success, negative on TLV parsing error. The IE data is returned in gtlv->tag, gtlv->len and gtlv->val; - * gtlv->val == NULL if no more IEs remain in the buffer. - */ -int osmo_gtlv_load_next(struct osmo_gtlv_load *gtlv) -{ - const uint8_t *ie_start; - const uint8_t *ie_end; - size_t buflen_left; - int rc; - - rc = next_tl_valid(gtlv, &ie_start, &buflen_left); - if (rc) - return rc; - - /* No more IEs? */ - if (!buflen_left) { - gtlv->val = NULL; - return 0; - } - - /* Locate next IE */ - OSMO_ASSERT(gtlv->cfg->load_tl); - gtlv->ti = (struct osmo_gtlv_tag_inst){}; - rc = gtlv->cfg->load_tl(gtlv, ie_start, buflen_left); - if (rc) - return rc; - - /* Sanity */ - ie_end = gtlv->val + gtlv->len; - if (ie_end < gtlv->src.data || ie_end > gtlv->src.data + gtlv->src.len) - return -EBADMSG; - - return 0; -} - -/* Return the tag of the IE that osmo_gtlv_next() would yield, do not change the gtlv state. - * - * \param[in] gtlv state for TLV parsing position; is not modified. - * \param[out] tag the tag number on success, if NULL don't return the tag. - * \param[out] instance the instance number or OSMO_GTLV_NO_INSTANCE if there is no instance value, - * if NULL don't return the instance value. - * \returns 0 on success, negative on TLV parsing error, -ENOENT when no more tags follow. - */ -int osmo_gtlv_load_peek_tag(const struct osmo_gtlv_load *gtlv, struct osmo_gtlv_tag_inst *ti) -{ - const uint8_t *ie_start; - size_t buflen_left; - int rc; - /* Guard against modification by load_tl(). */ - struct osmo_gtlv_load mtlv = *gtlv; - mtlv.ti = (struct osmo_gtlv_tag_inst){}; - - rc = next_tl_valid(&mtlv, &ie_start, &buflen_left); - if (rc) - return rc; - - if (!buflen_left) - return -ENOENT; - - /* Return next IE tag*/ - OSMO_ASSERT(mtlv.cfg->load_tl); - rc = gtlv->cfg->load_tl(&mtlv, ie_start, buflen_left); - if (rc) - return -EBADMSG; - if (ti) - *ti = mtlv.ti; - return 0; -} - -/* Same as osmo_gtlv_load_next(), but skip any IEs until the given tag is reached. Change the gtlv state only when success - * is returned. - * \param[out] gtlv Return the next IE's TLV info. - * \param[in] tag Tag value to match. - * \param[in] instance Instance value to match; For IEs that have no instance value (no TLIV), pass - * OSMO_GTLV_NO_INSTANCE. - * \return 0 when the tag is found. Return -ENOENT when no such tag follows and keep the gtlv unchanged. */ -int osmo_gtlv_load_next_by_tag(struct osmo_gtlv_load *gtlv, unsigned int tag) -{ - struct osmo_gtlv_tag_inst ti = { .tag = tag }; - return osmo_gtlv_load_next_by_tag_inst(gtlv, &ti); -} - -int osmo_gtlv_load_next_by_tag_inst(struct osmo_gtlv_load *gtlv, const struct osmo_gtlv_tag_inst *ti) -{ - struct osmo_gtlv_load work = *gtlv; - for (;;) { - int rc = osmo_gtlv_load_next(&work); - if (rc) - return rc; - if (!work.val) - return -ENOENT; - if (!osmo_gtlv_tag_inst_cmp(&work.ti, ti)) { - *gtlv = work; - return 0; - } - } -} - -/* Put tag header and length at the end of the msgb, according to gtlv->cfg->store_tl(). - * If the length is not known yet, it can be passed as 0 at first, and osmo_gtlv_put_update_tl() can determine the - * resulting length after the value part was put into the msgb. - * - * Usage example: - * - * struct msgb *msg = msgb_alloc(1024, "foo"), - * struct osmo_gtlv_put gtlv = { - * .cfg = osmo_t16l16v_cfg, - * .dst = msg, - * } - * - * osmo_gtlv_put_tl(gtlv, 23, 0); // tag 23, length 0 = not known yet - * - * msgb_put(msg, 42); - * ... - * msgb_put(msg, 42); - * ... - * msgb_put(msg, 42); - * - * osmo_gtlv_put_update_tl(gtlv); - * - * Return 0 on success, -EINVAL if the tag value is invalid, -EMSGSIZE if len is too large. - */ -int osmo_gtlv_put_tl(struct osmo_gtlv_put *gtlv, unsigned int tag, size_t len) -{ - struct osmo_gtlv_tag_inst ti = { .tag = tag }; - return osmo_gtlv_put_tli(gtlv, &ti, len); -} - -/* Put tag header, instance value and length at the end of the msgb, according to gtlv->cfg->store_tl(). - * This is the same as osmo_gtlv_put_tl(), only osmo_gtlv_put_tl() passes instance = 0. - */ -int osmo_gtlv_put_tli(struct osmo_gtlv_put *gtlv, const struct osmo_gtlv_tag_inst *ti, size_t len) -{ - int rc; - uint8_t *last_tl; - OSMO_ASSERT(gtlv->cfg->store_tl); - last_tl = gtlv->dst->tail; - rc = gtlv->cfg->store_tl(gtlv->dst->tail, msgb_tailroom(gtlv->dst), ti, len, gtlv); - if (rc < 0) - return rc; - if (rc > 0) - msgb_put(gtlv->dst, rc); - gtlv->last_ti = *ti; - gtlv->last_tl = last_tl; - gtlv->last_val = gtlv->dst->tail; - return 0; -} - -/* Update the length of the last put IE header (last call to osmo_gtlv_put_tl()) to match with the current - * gtlv->dst->tail. - * Return 0 on success, -EMSGSIZE if the amount of data written since osmo_gtlv_put_tl() is too large. - */ -int osmo_gtlv_put_update_tl(struct osmo_gtlv_put *gtlv) -{ - size_t len = gtlv->dst->tail - gtlv->last_val; - int rc = gtlv->cfg->store_tl(gtlv->last_tl, gtlv->last_val - gtlv->last_tl, &gtlv->last_ti, len, gtlv); - if (rc < 0) - return rc; - /* In case the TL has changed in size, hopefully the implementation has moved the msgb data. Make sure last_val - * points at the right place now. */ - gtlv->last_val = gtlv->last_tl + rc; - return 0; -} - -static int t8l8v_load_tl(struct osmo_gtlv_load *gtlv, const uint8_t *src_data, size_t src_data_len) -{ - /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 2. */ - gtlv->ti.tag = src_data[0]; - gtlv->len = src_data[1]; - gtlv->val = src_data + 2; - return 0; -} - -static int t8l8v_store_tl(uint8_t *dst_data, size_t dst_data_avail, const struct osmo_gtlv_tag_inst *ti, size_t len, - struct osmo_gtlv_put *gtlv) -{ - if (ti->tag > UINT8_MAX) - return -EINVAL; - if (len > UINT8_MAX) - return -EMSGSIZE; - if (dst_data_avail < 2) - return -ENOSPC; - dst_data[0] = ti->tag; - dst_data[1] = len; - return 2; -} - -const struct osmo_gtlv_cfg osmo_t8l8v_cfg = { - .tl_min_size = 2, - .load_tl = t8l8v_load_tl, - .store_tl = t8l8v_store_tl, -}; - -static int t16l16v_load_tl(struct osmo_gtlv_load *gtlv, const uint8_t *src_data, size_t src_data_len) -{ - /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 4. */ - gtlv->ti.tag = osmo_load16be(src_data); - gtlv->len = osmo_load16be(src_data + 2); - gtlv->val = src_data + 4; - return 0; -} - -static int t16l16v_store_tl(uint8_t *dst_data, size_t dst_data_avail, const struct osmo_gtlv_tag_inst *ti, size_t len, - struct osmo_gtlv_put *gtlv) -{ - if (ti->tag > UINT16_MAX) - return -EINVAL; - if (len > UINT16_MAX) - return -EMSGSIZE; - if (dst_data_avail < 4) - return -ENOSPC; - osmo_store16be(ti->tag, dst_data); - osmo_store16be(len, dst_data + 2); - return 4; -} - -const struct osmo_gtlv_cfg osmo_t16l16v_cfg = { - .tl_min_size = 4, - .load_tl = t16l16v_load_tl, - .store_tl = t16l16v_store_tl, -}; diff --git a/src/libosmo-gtlv/gtlv_dec_enc.c b/src/libosmo-gtlv/gtlv_dec_enc.c deleted file mode 100644 index 2e5509a..0000000 --- a/src/libosmo-gtlv/gtlv_dec_enc.c +++ /dev/null @@ -1,530 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> -#include <string.h> - -#include <osmocom/core/utils.h> - -#include <osmocom/gtlv/gtlv_dec_enc.h> - -/* Reverse offsetof(): return the address of the struct member for a given osmo_gtlv_msg and member ofs_foo value. */ -#define MEMB(M, MEMB_OFS) ((void *)((char *)(M) + (MEMB_OFS))) - -#define RETURN_ERROR(RC, TAG_INST, FMT, ARGS...) \ - do {\ - if (err_cb) { \ - if ((TAG_INST).instance_present) \ - err_cb(err_cb_data, (void *)decoded_struct, __FILE__, __LINE__, \ - "tag 0x%x = %s instance %u: " FMT " (%d: %s)\n", \ - (TAG_INST).tag, get_value_string(iei_strs, (TAG_INST).tag), \ - (TAG_INST).instance, ##ARGS, \ - RC, strerror((RC) > 0 ? (RC) : -(RC))); \ - else \ - err_cb(err_cb_data, (void *)decoded_struct, __FILE__, __LINE__, \ - "tag 0x%x = %s: " FMT " (%d: %s)\n", \ - (TAG_INST).tag, get_value_string(iei_strs, (TAG_INST).tag), ##ARGS, \ - RC, strerror((RC) > 0 ? (RC) : -(RC))); \ - } \ - return RC; \ - } while (0) - - -/*! Decode a TLV structure from raw data to a decoded struct, for unordered TLV IEs. - * How to decode IE values and where to place them in the decoded struct, is defined by ie_coding, an array terminated - * by a '{}' entry. - * The IEs may appear in any ordering in the TLV data. - * For unordered decoding, only IEs with has_presence_flag == true or has_count == true may repeat. Other IE definitions - * cause the last read TLV to overwrite all previous decodings, all into the first occurrence in ie_coding. - * \param[out] decoded_struct Pointer to the struct to write parsed IE data to. - * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct. - * \param[in] gtlv TLV data to parse, as given in gtlv->msg.*. Must be ready for osmo_gtlv_load_start(). - * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding. - * \param[in] err_cb Function to call to report an error message, or NULL. - * \param[in] err_cb_data Caller supplied context to pass to the err_cb as 'data' argument. - * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. - * \return 0 on success, negative on error. - */ -static int osmo_gtlvs_decode_unordered(void *decoded_struct, unsigned int obj_ofs, struct osmo_gtlv_load *gtlv, - const struct osmo_gtlv_coding *ie_coding, - osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs) -{ - void *obj = MEMB(decoded_struct, obj_ofs); - const struct osmo_gtlv_coding *iec; - unsigned int *multi_count_p; - - /* To check for presence of mandatory IEs, need to keep a flag stack of seen ie_coding entries. This array has - * to have at least the nr of entries that the ie_coding array has. Let's allow up to this many ie_coding - * entries to avoid dynamic allocation. Seems like enough. */ - bool seen_ie_coding_entries[4096] = {}; - bool *seen_p; -#define CHECK_SEEN(IEC) do { \ - unsigned int ie_coding_idx = (IEC) - ie_coding; \ - if (ie_coding_idx >= ARRAY_SIZE(seen_ie_coding_entries)) \ - RETURN_ERROR(-ENOTSUP, gtlv->ti, \ - "Too many IE definitions for decoding an unordered TLV structure"); \ - seen_p = &seen_ie_coding_entries[ie_coding_idx]; \ - } while (0) - - - osmo_gtlv_load_start(gtlv); - - /* IEs are allowed to come in any order. So traverse the TLV structure once, and find an IE parser for each (if - * any). */ - for (;;) { - int rc; - bool *presence_flag_p; - unsigned int memb_next_array_idx; - unsigned int memb_ofs; - unsigned int ie_max_allowed_count; - - rc = osmo_gtlv_load_next(gtlv); - if (rc) - RETURN_ERROR(rc, gtlv->ti, "Decoding IEs failed on or after this tag"); - if (!gtlv->val) { - /* End of the TLV structure */ - break; - } - - /* ie_max_allowed_count counts how often the same IEI may appear in a message until all struct members - * that can store them are filled up. */ - ie_max_allowed_count = 0; - - do { - /* Find the IE coding for this tag */ - for (iec = ie_coding; - !osmo_gtlv_coding_end(iec) && osmo_gtlv_tag_inst_cmp(&iec->ti, &gtlv->ti); - iec++); - /* No such IE coding found. */ - if (osmo_gtlv_coding_end(iec)) - break; - - /* Keep track how often this tag can occur */ - ie_max_allowed_count += iec->has_count ? iec->count_max : 1; - - /* Was this iec instance already decoded? Then skip to the next one, if any. */ - presence_flag_p = iec->has_presence_flag ? MEMB(obj, iec->presence_flag_ofs) : NULL; - multi_count_p = iec->has_count ? MEMB(obj, iec->count_ofs) : NULL; - if ((presence_flag_p && *presence_flag_p) - || (multi_count_p && *multi_count_p >= iec->count_max)) - continue; - /* For IEs with a presence flag or a multi count, the decoded struct provides the information - * whether the IE has already been decoded. Do the same for mandatory IEs, using local state in - * seen_ie_coding_entries[]. */ - CHECK_SEEN(iec); - if (*seen_p) - continue; - } while (0); - if (osmo_gtlv_coding_end(iec)) { - if (ie_max_allowed_count) { - /* There have been IE definitions for this IEI, but all slots to decode it are already - * filled. */ - RETURN_ERROR(-ENOTSUP, gtlv->ti, "Only %u instances of this IE are supported per message", - ie_max_allowed_count); - } - /* No such IE defined in ie_coding, just skip the TLV. */ - continue; - } - - /* If this is a repeated IE, decode into the correct array index memb[idx], - * next idx == (*multi_count_p). We've already guaranteed above that *multi_count_p < count_max. */ - memb_next_array_idx = multi_count_p ? *multi_count_p : 0; - memb_ofs = iec->memb_ofs + memb_next_array_idx * iec->memb_array_pitch; - - /* Decode IE value part */ - if (iec->nested_ies) { - /* A nested IE: the value part of this TLV is in turn a TLV structure. Decode the inner - * IEs. */ - struct osmo_gtlv_load inner_tlv = { - .cfg = iec->nested_ies_cfg ? : gtlv->cfg, - .src = { - .data = gtlv->val, - .len = gtlv->len, - } - }; - bool ordered; - switch (iec->nested_ies_ordered) { - case OSMO_GTLV_NESTED_IES_ORDERED: - ordered = true; - break; - case OSMO_GTLV_NESTED_IES_ORDERING_SAME: - case OSMO_GTLV_NESTED_IES_UNORDERED: - ordered = false; - break; - default: - OSMO_ASSERT(0); - } - rc = osmo_gtlvs_decode(decoded_struct, obj_ofs + memb_ofs, &inner_tlv, ordered, iec->nested_ies, - err_cb, err_cb_data, iei_strs); - if (rc) - RETURN_ERROR(rc, gtlv->ti, "Error while decoding TLV structure nested inside this IE"); - } else { - /* Normal IE, decode the specific IE data. */ - if (!iec->dec_func) - RETURN_ERROR(-EIO, gtlv->ti, "IE definition lacks a dec_func()"); - rc = iec->dec_func(decoded_struct, MEMB(obj, memb_ofs), gtlv); - if (rc) - RETURN_ERROR(rc, gtlv->ti, "Error while decoding this IE"); - } - - if (multi_count_p) { - /* A repeated IE, record that we've added one entry. This increments the foo_count value in the - * decoded osmo_gtlv_msg.ies.*. - * For example, multi_count_p points at osmo_gtlv_msg_session_est_req.create_pdr_count, - * and memb_ofs points at osmo_gtlv_msg_session_est_req.create_pdr. */ - (*multi_count_p)++; - } - if (presence_flag_p) { - *presence_flag_p = true; - } - CHECK_SEEN(iec); - *seen_p = true; - } - - /* Check presence of mandatory IEs */ - for (iec = ie_coding; !osmo_gtlv_coding_end(iec); iec++) { - if (iec->has_presence_flag) - continue; - multi_count_p = iec->has_count ? MEMB(obj, iec->count_ofs) : NULL; - if (multi_count_p) { - if (*multi_count_p < iec->count_mandatory) - RETURN_ERROR(-EINVAL, iec->ti, "%u instances of this IE are mandatory, got %u", - iec->count_mandatory, *multi_count_p); - continue; - } - /* Neither an optional nor a multi member, hence it must be mandatory. */ - CHECK_SEEN(iec); - if (!*seen_p) - RETURN_ERROR(-EINVAL, iec->ti, "Missing mandatory IE"); - } - return 0; -} - -/*! Decode a TLV structure from raw data to a decoded struct, for ordered TLV IEs. - * How to decode IE values and where to place them in the decoded struct, is defined by ie_coding, an array terminated - * by a '{}' entry. - * The IEs in the TLV structure must appear in the same order as they are defined in ie_coding. - * cause the last read TLV to overwrite all previous decodings, all into the first occurrence in ie_coding. - * \param[out] decoded_struct Pointer to the struct to write parsed IE data to. - * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct. - * \param[in] gtlv TLV data to parse, as given in gtlv->msg.*. Must be ready for osmo_gtlv_load_start(). - * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding. - * \param[in] err_cb Function to call to report an error message, or NULL. - * \param[in] err_cb_data Caller supplied context to pass to the err_cb as 'data' argument. - * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. - * \return 0 on success, negative on error. - */ -static int osmo_gtlvs_decode_ordered(void *decoded_struct, unsigned int obj_ofs, struct osmo_gtlv_load *gtlv, - const struct osmo_gtlv_coding *ie_coding, - osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs) -{ - void *obj = MEMB(decoded_struct, obj_ofs); - - osmo_gtlv_load_start(gtlv); - - for (; !osmo_gtlv_coding_end(ie_coding); ie_coding++) { - int rc; - bool *presence_flag = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL; - unsigned int *multi_count = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL; - struct osmo_gtlv_tag_inst peek_ti; - - rc = osmo_gtlv_load_next_by_tag_inst(gtlv, &ie_coding->ti); - switch (rc) { - case 0: - break; - case -ENOENT: - if (!presence_flag && (!multi_count || *multi_count < ie_coding->count_mandatory)) - RETURN_ERROR(rc, ie_coding->ti, "Missing mandatory IE"); - if (presence_flag) - *presence_flag = false; - continue; - default: - RETURN_ERROR(rc, ie_coding->ti, "Error in TLV structure"); - } - - for (;;) { - /* If this is a repeated IE, decode into the correct array index memb[idx], - * next idx == (*multi_count) */ - unsigned int memb_next_array_idx = multi_count ? *multi_count : 0; - unsigned int memb_ofs = ie_coding->memb_ofs + memb_next_array_idx * ie_coding->memb_array_pitch; - - if (multi_count && memb_next_array_idx >= ie_coding->count_max) - RETURN_ERROR(-ENOTSUP, ie_coding->ti, "Only %u instances of this IE are supported per message", - ie_coding->count_max); - - /* Decode IE value part */ - if (ie_coding->nested_ies) { - /* A nested IE: the value part of this TLV is in turn a TLV structure. Decode the inner - * IEs. */ - struct osmo_gtlv_load inner_tlv = { - .cfg = ie_coding->nested_ies_cfg ? : gtlv->cfg, - .src = { - .data = gtlv->val, - .len = gtlv->len, - } - }; - bool ordered; - switch (ie_coding->nested_ies_ordered) { - case OSMO_GTLV_NESTED_IES_ORDERING_SAME: - case OSMO_GTLV_NESTED_IES_ORDERED: - ordered = true; - break; - case OSMO_GTLV_NESTED_IES_UNORDERED: - ordered = false; - break; - default: - OSMO_ASSERT(0); - } - rc = osmo_gtlvs_decode(decoded_struct, obj_ofs + memb_ofs, &inner_tlv, ordered, - ie_coding->nested_ies, err_cb, err_cb_data, iei_strs); - if (rc) - RETURN_ERROR(rc, ie_coding->ti, - "Error while decoding TLV structure nested inside this IE"); - } else { - /* Normal IE, decode the specific IE data. */ - if (!ie_coding->dec_func) - RETURN_ERROR(-EIO, ie_coding->ti, "IE definition lacks a dec_func()"); - rc = ie_coding->dec_func(decoded_struct, MEMB(obj, memb_ofs), gtlv); - if (rc) - RETURN_ERROR(rc, ie_coding->ti, "Error while decoding this IE"); - } - - if (presence_flag) - *presence_flag = true; - - if (!multi_count) { - /* Not a repeated IE. */ - break; - } - - /* A repeated IE, record that we've added one entry. This increments the foo_count value in the - * decoded osmo_pfcp_msg.ies.*. - * For example, multi_count points at osmo_pfcp_msg_session_est_req.create_pdr_count, - * and memb_ofs points at osmo_pfcp_msg_session_est_req.create_pdr. */ - (*multi_count)++; - - /* Does another one of these IEs follow? */ - if (osmo_gtlv_load_peek_tag(gtlv, &peek_ti) - || osmo_gtlv_tag_inst_cmp(&peek_ti, &gtlv->ti)) { - /* Next tag is a different IE, end the repetition. */ - break; - } - - /* continue, parsing the next repetition of this tag. */ - rc = osmo_gtlv_load_next(gtlv); - if (rc) - return rc; - } - /* continue parsing the next tag. */ - } - return 0; -} - -/*! Decode an entire TLV message from raw data to decoded struct. - * How to decode IE values and where to put them in the decoded struct is defined by ie_coding, an array terminated by - * a '{}' entry. - * \param[out] decoded_struct Pointer to the struct to write parsed IE data to. - * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct. - * \param[in] gtlv TLV data to parse, as given in gtlv->msg.*. Must be ready for osmo_gtlv_load_start(). - * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding. - * \param[in] err_cb Function to call to report an error message, or NULL. - * \param[in] err_cb_data Caller supplied context to pass to the err_cb as 'data' argument. - * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. - * \return 0 on success, negative on error. - */ -int osmo_gtlvs_decode(void *decoded_struct, unsigned int obj_ofs, struct osmo_gtlv_load *gtlv, bool tlv_ordered, - const struct osmo_gtlv_coding *ie_coding, - osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs) -{ - if (!ie_coding) - return -ENOTSUP; - if (tlv_ordered) - return osmo_gtlvs_decode_ordered(decoded_struct, obj_ofs, gtlv, ie_coding, err_cb, err_cb_data, iei_strs); - else - return osmo_gtlvs_decode_unordered(decoded_struct, obj_ofs, gtlv, ie_coding, err_cb, err_cb_data, - iei_strs); -} - -/*! Encode a TLV structure from decoded struct to raw data. - * How to encode IE values and where to read them in the decoded struct is defined by ie_coding, an array terminated by - * a '{}' entry. - * The IEs will be encoded in the order they appear in ie_coding. - * \param[out] gtlv Write data using this TLV definition to gtlv->dst. - * \param[in] decoded_struct C struct data to encode. - * \param[in] obj_ofs Nesting offset, pass as 0. - * \param[in] ie_coding A {} terminated list of IEI tags to encode (if present) and instructions for encoding. - * \param[in] err_cb Function to call to report an error message, or NULL. - * \param[in] err_cb_data Caller supplied context to pass to the err_cb as 'data' argument. - * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. - * \return 0 on success, negative on error. - */ -int osmo_gtlvs_encode(struct osmo_gtlv_put *gtlv, const void *decoded_struct, unsigned int obj_ofs, - const struct osmo_gtlv_coding *ie_coding, - osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs) -{ - void *obj = MEMB(decoded_struct, obj_ofs); - - if (!ie_coding) - return -ENOTSUP; - - for (; !osmo_gtlv_coding_end(ie_coding); ie_coding++) { - int rc; - bool *presence_flag_p = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL; - unsigned int *multi_count_p = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL; - unsigned int n; - unsigned int i; - - if (presence_flag_p && !*presence_flag_p) - continue; - - if (multi_count_p) { - n = *multi_count_p; - if (!ie_coding->memb_array_pitch) - RETURN_ERROR(-EFAULT, ie_coding->ti, - "Error in protocol definition: The ie_coding lacks a memb_array_pitch" - " value, cannot be used as multi-IE\n"); - } else { - n = 1; - } - - for (i = 0; i < n; i++) { - unsigned int memb_ofs; - - osmo_gtlv_put_tli(gtlv, &ie_coding->ti, 0); - - /* If this is a repeated IE, encode from the correct array index */ - if (multi_count_p && i >= ie_coding->count_max) - RETURN_ERROR(-ENOTSUP, ie_coding->ti, - "Only %u instances of this IE are supported per message", ie_coding->count_max); - memb_ofs = ie_coding->memb_ofs + i * ie_coding->memb_array_pitch; - - if (ie_coding->nested_ies) { - struct osmo_gtlv_put nested_tlv = { - .cfg = ie_coding->nested_ies_cfg ? : gtlv->cfg, - .dst = gtlv->dst, - }; - rc = osmo_gtlvs_encode(&nested_tlv, decoded_struct, obj_ofs + memb_ofs, - ie_coding->nested_ies, err_cb, err_cb_data, iei_strs); - if (rc) - RETURN_ERROR(rc, ie_coding->ti, - "Error while encoding TLV structure nested inside this IE"); - } else { - rc = ie_coding->enc_func(gtlv, decoded_struct, MEMB(obj, memb_ofs)); - if (rc) - RETURN_ERROR(rc, ie_coding->ti, "Error while encoding this IE"); - } - - osmo_gtlv_put_update_tl(gtlv); - } - } - return 0; -} - -/*! Compose a human readable string describing a decoded struct. - * How to encode IE values and where to read them in the decoded struct is defined by ie_coding, an array terminated by - * a '{}' entry. - * The IEs will be encoded in the order they appear in ie_coding. - * \param[out] buf Return the string in this buffer. - * \param[in] buflen Size of buf. - * \param[in] decoded_struct C struct data to encode. - * \param[in] obj_ofs Nesting offset, pass as 0. - * \param[in] ie_coding A {} terminated list of IEI tags to encode (if present) and instructions for encoding. - * \param[in] iei_strs value_string array to give IEI names in tag headers, or NULL. - * \return number of characters that would be written if the buffer is large enough, like snprintf(). - */ -int osmo_gtlvs_encode_to_str_buf(char *buf, size_t buflen, const void *decoded_struct, unsigned int obj_ofs, - const struct osmo_gtlv_coding *ie_coding, const struct value_string *iei_strs) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - - void *obj = MEMB(decoded_struct, obj_ofs); - - if (!ie_coding) - return -ENOTSUP; - - for (; !osmo_gtlv_coding_end(ie_coding); ie_coding++) { - bool *presence_flag_p = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL; - unsigned int *multi_count_p = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL; - unsigned int n; - unsigned int i; - - if (presence_flag_p && !*presence_flag_p) - continue; - - if (multi_count_p) { - n = *multi_count_p; - } else { - n = 1; - } - - if (!n) - continue; - - OSMO_STRBUF_PRINTF(sb, " '%s'=", get_value_string(iei_strs, ie_coding->ti.tag)); - if (multi_count_p) - OSMO_STRBUF_PRINTF(sb, "{ "); - - for (i = 0; i < n; i++) { - unsigned int memb_ofs; - - /* If this is a repeated IE, encode from the correct array index */ - if (multi_count_p && i >= ie_coding->count_max) - return -ENOTSUP; - if (i > 0) - OSMO_STRBUF_PRINTF(sb, ", "); - - memb_ofs = ie_coding->memb_ofs + i * ie_coding->memb_array_pitch; - - if (ie_coding->nested_ies) { - OSMO_STRBUF_PRINTF(sb, "{"); - OSMO_STRBUF_APPEND(sb, osmo_gtlvs_encode_to_str_buf, decoded_struct, obj_ofs + memb_ofs, - ie_coding->nested_ies, iei_strs); - OSMO_STRBUF_PRINTF(sb, " }"); - } else { - if (ie_coding->enc_to_str_func) - OSMO_STRBUF_APPEND(sb, ie_coding->enc_to_str_func, MEMB(obj, memb_ofs)); - else - OSMO_STRBUF_PRINTF(sb, "(enc_to_str_func==NULL)"); - } - } - - if (multi_count_p) - OSMO_STRBUF_PRINTF(sb, " }"); - } - return sb.chars_needed; -} - -/*! Compose a human readable string describing a decoded struct. - * Like osmo_gtlvs_encode_to_str_buf() but returns a talloc allocated string. - * \param[in] ctx talloc context to allocate from, e.g. OTC_SELECT. - * \param[in] decoded_struct C struct data to encode. - * \param[in] obj_ofs Nesting offset, pass as 0. - * \param[in] ie_coding A {} terminated list of IEI tags to encode (if present) and instructions for encoding. - * \param[in] iei_strs value_string array to give IEI names in tag headers, or NULL. - * \return human readable string. - */ -char *osmo_gtlvs_encode_to_str_c(void *ctx, const void *decoded_struct, unsigned int obj_ofs, - const struct osmo_gtlv_coding *ie_coding, const struct value_string *iei_strs) -{ - OSMO_NAME_C_IMPL(ctx, 256, "ERROR", osmo_gtlvs_encode_to_str_buf, decoded_struct, obj_ofs, ie_coding, iei_strs) -} diff --git a/src/libosmo-gtlv/gtlv_gen.c b/src/libosmo-gtlv/gtlv_gen.c deleted file mode 100644 index fd3fbd9..0000000 --- a/src/libosmo-gtlv/gtlv_gen.c +++ /dev/null @@ -1,420 +0,0 @@ -/* Write h and c source files for TLV protocol definitions, based on very sparse TLV definitions. - * For a usage example see tests/libosmo-gtlv/test_gtlv_gen/. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <string.h> - -#include <osmocom/core/linuxlist.h> -#include <osmocom/core/talloc.h> -#include <osmocom/core/utils.h> - -#include <osmocom/gtlv/gtlv_gen.h> - -static const struct osmo_gtlv_gen_cfg *g_cfg = NULL; - -const struct osmo_gtlv_gen_ie osmo_gtlv_gen_ie_auto = {}; - -/* Helps avoid redundant definitions of the same type. */ -struct seen_entry { - struct llist_head entry; - char str[256]; - const void *from_def; -}; -static LLIST_HEAD(seen_list); - -static bool seen(const char *str, const void *from_def) -{ - struct seen_entry *s; - llist_for_each_entry(s, &seen_list, entry) { - if (!strcmp(s->str, str)) { - if (from_def != s->from_def) { - fprintf(stderr, "ERROR: %s: multiple definitions use the same name: '%s'\n", - g_cfg->proto_name, str); - exit(1); - } - return true; - } - } - s = talloc_zero(NULL, struct seen_entry); - OSMO_STRLCPY_ARRAY(s->str, str); - s->from_def = from_def; - llist_add(&s->entry, &seen_list); - return false; -} -static void clear_seen() -{ - struct seen_entry *s; - while ((s = llist_first_entry_or_null(&seen_list, struct seen_entry, entry))) { - llist_del(&s->entry); - talloc_free(s); - } -} - -/* Return "struct foo_ie_bar" from g_cfg->decoded_type_prefix and ie. */ -static inline const char *decoded_type(const struct osmo_gtlv_gen_ie_o *ie_o) -{ - static char b[255]; - const struct osmo_gtlv_gen_ie *ie = ie_o->ie; - const char *tag_name; - if (ie && ie->decoded_type) - return ie->decoded_type; - /* "struct foo_ie_" + "bar" = struct foo_ie_bar*/ - tag_name = ie ? ie->tag_name : NULL; - snprintf(b, sizeof(b), "%s%s", g_cfg->decoded_type_prefix, tag_name ? : ie_o->name); - return b; -} - -/* --- .h file --- */ - -/* Write a listing of struct members like - * bool foo_present; - * int foo; - * struct myproto_ie_bar bar; - * struct abc abc[10]; - * int abc_count; - */ -static void write_ie_members(const struct osmo_gtlv_gen_ie_o ies[]) -{ - const struct osmo_gtlv_gen_ie_o *ie_o; - for (ie_o = ies; ie_o->ie; ie_o++) { - if (ie_o->optional) - printf("\tbool %s_present;\n", ie_o->name); - printf("\t%s %s", decoded_type(ie_o), ie_o->name); - if (ie_o->multi) { - printf("[%u];\n", ie_o->multi); - printf("\tunsigned int %s_count", ie_o->name); - } - printf(";\n"); - } -} - -/* Traverse nesting levels in the message definitions and generate the structs for all as needed. */ -static void write_ie_auto_structs(const struct osmo_gtlv_gen_ie_o ies[]) -{ - const struct osmo_gtlv_gen_ie_o *ie_o; - if (!ies) - return; - for (ie_o = ies; ie_o->ie; ie_o++) { - const struct osmo_gtlv_gen_ie *ie = ie_o->ie; - if (!ie || !ie->nested_ies) - continue; - /* Recurse to write inner layers first, so that they can be referenced in outer layers. */ - write_ie_auto_structs(ie->nested_ies); - - /* Various IE definitions can use the same underlying type. Only generate each type once. */ - if (seen(decoded_type(ie_o), NULL)) - continue; - - /* Print: - * - * \* spec ref *\ - * struct myproto_ie_goo { - * bool foo_present; - * int foo; - * struct myproto_ie_bar bar; - * struct abc abc[10]; - * int abc_count; - * }; - */ - printf("\n"); - if (ie->spec_ref) - printf("/* %s%s */\n", g_cfg->spec_ref_prefix, ie->spec_ref); - printf("%s {\n", decoded_type(ie_o)); - write_ie_members(ie->nested_ies); - printf("};\n"); - } -} - -/* Write all auto-generated structs, starting with the outer message definitions and nesting into all contained IE - * definitions. */ -static void write_auto_structs() -{ - const struct osmo_gtlv_gen_msg *gen_msg; - clear_seen(); - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - write_ie_auto_structs(gen_msg->ies); - } -} - -/* Write the struct definitions for each message, i.e. for each entry in the outer PDU's message union, as well as the - * union itself. - * - * struct myproto_msg_foo { - * ... - * }: - * struct myproto_msg_goo { - * ... - * }; - * union myproto_ies { - * myproto_msg_foo foo; - * myproto_msg_goo goo; - * }; - */ -static void write_msg_union() -{ - const struct osmo_gtlv_gen_msg *gen_msg; - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - /* "struct foo_msg" + "_%s" { * - * struct foo_msg_goo_request { ... }; */ - printf("\nstruct %s_msg_%s {\n", - g_cfg->proto_name, - gen_msg->name); - write_ie_members(gen_msg->ies); - printf("};\n"); - } - - printf("\nunion %s_ies {\n", g_cfg->proto_name); - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - printf("\tstruct %s_msg_%s %s;\n", g_cfg->proto_name, - gen_msg->name, gen_msg->name); - } - printf("};\n"); -} - -/* Write the C header, myproto_ies_auto.h */ -static void write_h() -{ - printf("/* THIS FILE IS GENERATED FROM %s */\n", __FILE__); - printf("#include <stdint.h>\n"); - printf("#include <osmocom/gtlv/gtlv_dec_enc.h>\n"); - if (g_cfg->h_header) - printf("\n%s\n", g_cfg->h_header); - write_auto_structs(); - write_msg_union(); - printf("\nconst struct osmo_gtlv_coding *%s_get_msg_coding(%s message_type);\n", - g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); - printf("\n" - "int %s_ies_decode(union %s_ies *dst, struct osmo_gtlv_load *gtlv, bool tlv_ordered,\n" - " %s message_type, osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs);\n", - g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); - printf("\n" - "int %s_ies_encode(struct osmo_gtlv_put *gtlv, const union %s_ies *src,\n" - " %s message_type, osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs);\n", - g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); - printf("\n" - "int %s_ies_encode_to_str(char *buf, size_t buflen, const union %s_ies *src,\n" - " %s message_type, const struct value_string *iei_strs);\n", - g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); -} - -/* --- .c file --- */ - -/* Write a listing of: - * extern int myproto_dec_foo(...); - * extern int myproto_enc_foo(...); - */ -static void write_extern_dec_enc(const struct osmo_gtlv_gen_ie_o *ies) -{ - const struct osmo_gtlv_gen_ie_o *ie_o; - for (ie_o = ies; ie_o->ie; ie_o++) { - const struct osmo_gtlv_gen_ie *ie = ie_o->ie; - const char *dec_enc = ie_o->name; - if (ie) - dec_enc = ie->dec_enc ? : (ie->tag_name ? : ie_o->name); - if (ie && ie->nested_ies) { - write_extern_dec_enc(ie->nested_ies); - continue; - } - if (seen(dec_enc, NULL)) - continue; - printf("extern int %s_dec_%s(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv);\n", - g_cfg->proto_name, dec_enc); - printf("extern int %s_enc_%s(struct osmo_gtlv_put *gtlv, const void *decoded_struct, const void *encode_from);\n", - g_cfg->proto_name, dec_enc); - if (g_cfg->add_enc_to_str) - printf("extern int %s_enc_to_str_%s(char *buf, size_t buflen, const void *encode_from);\n", - g_cfg->proto_name, dec_enc); - } -} - -/* For a nested IE, write the struct osmo_gtlv_coding array of the inner IEs. - * { { MYPROTO_IEI_BAR }, - * .memb_ofs = offsetof(struct myproto_foo, bar), - * .dec_func = myproto_dec_bar, - * .enc_func = myproto_enc_bar, - * }, - */ -static void write_ies_array(const char *indent, const struct osmo_gtlv_gen_ie_o *ies, const char *obj_type, const char *substruct) -{ -#define printi(FMT, ARGS...) printf("%s" FMT, indent, ##ARGS) - - const struct osmo_gtlv_gen_ie_o *ie_o; - for (ie_o = ies; ie_o->ie; ie_o++) { - const struct osmo_gtlv_gen_ie *ie = ie_o->ie; - const char *tag_name = (ie && ie->tag_name) ? ie->tag_name : ie_o->name; - printi("{ { %s%s", g_cfg->tag_prefix, osmo_str_toupper(tag_name)); - if (ie_o->instance) - printf(", true, %s", ie_o->instance); - printf(" },\n"); - printi(" .memb_ofs = offsetof(%s, %s%s),\n", obj_type, substruct, ie_o->name); - if (ie->nested_ies) { - printi(" .nested_ies = ies_in_%s,\n", tag_name); - } else { - const char *dec_enc = ie->dec_enc ? : (ie->tag_name ? : ie_o->name); - printi(" .dec_func = %s_dec_%s,\n", g_cfg->proto_name, dec_enc); - printi(" .enc_func = %s_enc_%s,\n", g_cfg->proto_name, dec_enc); - if (g_cfg->add_enc_to_str) - printi(" .enc_to_str_func = %s_enc_to_str_%s,\n", g_cfg->proto_name, dec_enc); - } - if (ie_o->multi) { - printi(" .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(%s, %s%s),\n", - obj_type, substruct, ie_o->name); - printi(" .has_count = true, .count_max = %u,\n", ie_o->multi); - printi(" .count_mandatory = %u,\n", ie_o->multi_mandatory); - printi(" .count_ofs = offsetof(%s, %s%s_count),\n", obj_type, substruct, ie_o->name); - } - if (ie_o->optional) { - printi(" .has_presence_flag = true,\n"); - printi(" .presence_flag_ofs = offsetof(%s, %s%s_present),\n", obj_type, substruct, ie_o->name); - } - printi("},\n"); - } -} - -/* For a nested IE, write the struct osmo_gtlv_coding array of the inner IEs. - * static const struct osmo_gtlv_coding ies_in_foo[] = { - * { {MYPROTO_IEI_BAR}, - * .memb_ofs = offsetof(struct myproto_foo, bar), - * .dec_func = myproto_dec_bar, - * .enc_func = myproto_enc_bar, - * }, - * ... - * }; - */ -static void write_nested_ies_array(const struct osmo_gtlv_gen_ie_o *ies) -{ - const char *indent = "\t"; - const struct osmo_gtlv_gen_ie_o *ie_o; - for (ie_o = ies; ie_o->ie; ie_o++) { - const struct osmo_gtlv_gen_ie *ie = ie_o->ie; - if (!ie || !ie->nested_ies) - continue; - write_nested_ies_array(ie->nested_ies); - - const char *ies_in_name = ie->tag_name ? : ie_o->name; - if (seen(ies_in_name, ie)) - continue; - - printf("\nstatic const struct osmo_gtlv_coding ies_in_%s[] = {\n", ies_in_name); - write_ies_array(indent, ie->nested_ies, decoded_type(ie_o), ""); - printi("{}\n"); - printf("};\n"); - } -} - -/* Write the bulk of the C code: on the basis of the list of messages (g_cfg->msg_defs), write all dec/enc function - * declarations, all IEs arrays as well as the list of message types, first triggering to write the C code for any inner - * layers. */ -static void write_c() -{ - const struct osmo_gtlv_gen_msg *gen_msg; - - printf("/* THIS FILE IS GENERATED FROM %s */\n", __FILE__); - printf("#include <stddef.h>\n"); - printf("#include <errno.h>\n"); - printf("#include <osmocom/core/utils.h>\n"); - printf("#include <osmocom/gtlv/gtlv.h>\n"); - printf("#include <osmocom/gtlv/gtlv_dec_enc.h>\n"); - printf("#include <osmocom/gtlv/gtlv_gen.h>\n"); - if (g_cfg->c_header) - printf("\n%s\n", g_cfg->c_header); - - printf("\n"); - clear_seen(); - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - write_extern_dec_enc(gen_msg->ies); - } - - clear_seen(); - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - write_nested_ies_array(gen_msg->ies); - } - - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - char *obj_type = talloc_asprintf(NULL, "union %s_ies", g_cfg->proto_name); - char *substruct = talloc_asprintf(NULL, "%s.", gen_msg->name); - printf("\nstatic const struct osmo_gtlv_coding ies_in_msg_%s[] = {\n", gen_msg->name); - write_ies_array("\t", gen_msg->ies, obj_type, substruct); - printf("\t{}\n};\n"); - talloc_free(substruct); - talloc_free(obj_type); - } - printf("\nstatic const struct osmo_gtlv_coding *msg_defs[] = {\n"); - for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { - printf("\t[%s%s] = ies_in_msg_%s,\n", g_cfg->message_type_prefix, osmo_str_toupper(gen_msg->name), gen_msg->name); - } - printf("};\n"); - - /* print this code snippet into the .c file, because only there can we do ARRAY_SIZE(foo_msg_coding). */ - printf("\n" - "const struct osmo_gtlv_coding *%s_get_msg_coding(%s message_type)\n" - "{\n" - " if (message_type >= ARRAY_SIZE(msg_defs))\n" - " return NULL;\n" - " return msg_defs[message_type];\n" - "}\n", - g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); - - printf("\n" - "int %s_ies_decode(union %s_ies *dst, struct osmo_gtlv_load *gtlv, bool tlv_ordered,\n" - " %s message_type,\n" - " osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs)\n" - "{\n" - " return osmo_gtlvs_decode(dst, 0, gtlv, tlv_ordered, %s_get_msg_coding(message_type), err_cb, err_cb_data, iei_strs);\n" - "}\n", - g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name); - printf("\n" - "int %s_ies_encode(struct osmo_gtlv_put *gtlv, const union %s_ies *src,\n" - " %s message_type, osmo_gtlv_err_cb err_cb, void *err_cb_data, const struct value_string *iei_strs)\n" - "{\n" - " return osmo_gtlvs_encode(gtlv, src, 0, %s_get_msg_coding(message_type), err_cb, err_cb_data, iei_strs);\n" - "}\n", - g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name); - printf("\n" - "int %s_ies_encode_to_str(char *buf, size_t buflen, const union %s_ies *src,\n" - " %s message_type, const struct value_string *iei_strs)\n" - "{\n" - " return osmo_gtlvs_encode_to_str_buf(buf, buflen, src, 0, %s_get_msg_coding(message_type), iei_strs);\n" - "}\n", - g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name); -} - -/* Call this from your main(). */ -int osmo_gtlv_gen_main(const struct osmo_gtlv_gen_cfg *cfg, int argc, const char **argv) -{ - if (argc < 2) - return 1; - - g_cfg = cfg; - - if (strcmp(argv[1], "h") == 0) - write_h(); - else if (strcmp(argv[1], "c") == 0) - write_c(); - else - return 1; - - clear_seen(); - return 0; -} diff --git a/src/libosmo-pfcp/Makefile.am b/src/libosmo-pfcp/Makefile.am index db81648..eb8c78f 100644 --- a/src/libosmo-pfcp/Makefile.am +++ b/src/libosmo-pfcp/Makefile.am @@ -9,12 +9,14 @@ AM_CFLAGS = \ -Wall \ $(LIBOSMOCORE_CFLAGS) \ + $(LIBOSMOGTLV_CFLAGS) \ $(LIBOSMOVTY_CFLAGS) \ $(COVERAGE_CFLAGS) \ $(NULL) AM_LDFLAGS = \ $(LIBOSMOCORE_LIBS) \ + $(LIBOSMOGTLV_LIBS) \ $(LIBOSMOVTY_LIBS) \ $(COVERAGE_LDFLAGS) \ $(NULL) @@ -40,10 +42,7 @@ pfcp_ies_auto.c \ $(NULL) -pfcp_ies_auto.c: $(srcdir)/gen__pfcp_ies_auto.c \ - $(top_srcdir)/src/libosmo-gtlv/gtlv_gen.c \ - $(top_srcdir)/include/osmocom/gtlv/gtlv_gen.h - $(MAKE) -C $(top_builddir)/src/libosmo-gtlv +pfcp_ies_auto.c: $(srcdir)/gen__pfcp_ies_auto.c $(MAKE) gen__pfcp_ies_auto $(builddir)/gen__pfcp_ies_auto c > $(builddir)/pfcp_ies_auto.c @@ -54,9 +53,3 @@ gen__pfcp_ies_auto_SOURCES = \ gen__pfcp_ies_auto.c \ $(NULL) - -gen__pfcp_ies_auto_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(COVERAGE_LDFLAGS) \ - $(NULL) diff --git a/tests/Makefile.am b/tests/Makefile.am index 01ef6b4..fad7e6c 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -1,5 +1,4 @@ SUBDIRS = \ - libosmo-gtlv \ libosmo-pfcp \ $(NULL) diff --git a/tests/libosmo-gtlv/Makefile.am b/tests/libosmo-gtlv/Makefile.am deleted file mode 100644 index 45d6ec2..0000000 --- a/tests/libosmo-gtlv/Makefile.am +++ /dev/null @@ -1,49 +0,0 @@ -SUBDIRS = \ - test_gtlv_gen \ - test_tliv \ - $(NULL) - -AM_CPPFLAGS = \ - $(all_includes) \ - -I$(top_srcdir)/include \ - $(NULL) - -AM_CFLAGS = \ - -Wall \ - $(LIBOSMOCORE_CFLAGS) \ - $(NULL) - -noinst_PROGRAMS = \ - gtlv_test \ - gtlv_dec_enc_test \ - $(NULL) - -EXTRA_DIST = \ - gtlv_test.ok \ - gtlv_dec_enc_test.ok \ - $(NULL) - -gtlv_test_SOURCES = \ - gtlv_test.c \ - $(NULL) - -gtlv_test_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(NULL) - -gtlv_dec_enc_test_SOURCES = \ - gtlv_dec_enc_test.c \ - $(NULL) - -gtlv_dec_enc_test_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(NULL) - -.PHONY: update_exp -update_exp: - $(builddir)/gtlv_test >$(srcdir)/gtlv_test.ok - $(builddir)/gtlv_dec_enc_test >$(srcdir)/gtlv_dec_enc_test.ok - $(MAKE) -C test_gtlv_gen update_exp - $(MAKE) -C test_tliv update_exp diff --git a/tests/libosmo-gtlv/gtlv_dec_enc_test.c b/tests/libosmo-gtlv/gtlv_dec_enc_test.c deleted file mode 100644 index e02a2e5..0000000 --- a/tests/libosmo-gtlv/gtlv_dec_enc_test.c +++ /dev/null @@ -1,422 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdio.h> -#include <errno.h> -#include <assert.h> - -#include <osmocom/core/application.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/msgb.h> - -#include <osmocom/gtlv/gtlv_dec_enc.h> - -void *ctx; - -enum tags { - TAG_FOO = 1, - TAG_BAR, - TAG_BAZ, - TAG_REPEAT_INT, - TAG_REPEAT_STRUCT, - TAG_NEST, -}; - -const struct value_string tag_names[] = { - { TAG_FOO, "FOO" }, - { TAG_BAR, "BAR" }, - { TAG_BAZ, "BAZ" }, - { TAG_REPEAT_INT, "REPEAT_INT" }, - { TAG_REPEAT_STRUCT, "REPEAT_STRUCT" }, - { TAG_NEST, "NEST" }, - {} -}; - -struct bar { - char str[23]; -}; - -struct baz { - int v_int; - bool v_bool; -}; - -enum repeat_enum { - R_A, - R_B, - R_C, -}; - -const struct value_string repeat_enum_names[] = { - OSMO_VALUE_STRING(R_A), - OSMO_VALUE_STRING(R_B), - OSMO_VALUE_STRING(R_C), - {} -}; - -struct repeat { - int v_int; - bool v_bool; - enum repeat_enum v_enum; -}; - -struct nested_inner_msg { - int foo; - struct bar bar; - struct baz baz; -}; - -struct decoded_msg { - int foo; - struct bar bar; - - bool baz_present; - struct baz baz; - - unsigned int repeat_int_count; - int repeat_int[32]; - - unsigned int repeat_struct_count; - struct repeat repeat_struct[32]; - - bool nest_present; - struct nested_inner_msg nest; -}; - -int dec_u16(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - int *foo = decode_to; - if (gtlv->len != 2) - return -EINVAL; - *foo = osmo_load16be(gtlv->val); - return 0; -} - -int enc_u16(struct osmo_gtlv_put *gtlv, const void *decoded_struct, const void *encode_from) -{ - const int *foo = encode_from; - if (*foo > INT16_MAX) - return -EINVAL; - msgb_put_u16(gtlv->dst, *foo); - return 0; -} - -int enc_to_str_u16(char *buf, size_t buflen, const void *encode_from) -{ - const int *foo = encode_from; - return snprintf(buf, buflen, "%d", *foo); -} - -int dec_bar(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct bar *bar = decode_to; - if (gtlv->len > sizeof(bar->str) - 1) - return -EINVAL; - osmo_strlcpy(bar->str, (const char *)gtlv->val, OSMO_MIN(gtlv->len + 1, sizeof(bar->str))); - return 0; -} - -int enc_bar(struct osmo_gtlv_put *gtlv, const void *decoded_struct, const void *encode_from) -{ - const struct bar *bar = encode_from; - int len = strnlen(bar->str, sizeof(bar->str)); - memcpy(msgb_put(gtlv->dst, len), bar, len); - return 0; -} - -int enc_to_str_bar(char *buf, size_t buflen, const void *encode_from) -{ - const struct bar *bar = encode_from; - return osmo_quote_str_buf3(buf, buflen, bar->str, -1); -} - -int dec_baz(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct baz *baz = decode_to; - uint16_t l; - if (gtlv->len != 2) - return -EINVAL; - l = osmo_load16be(gtlv->val); - baz->v_int = l & 0x7fff; - baz->v_bool = (l & 0x8000) ? true : false; - return 0; -} - -int enc_baz(struct osmo_gtlv_put *gtlv, const void *decoded_struct, const void *encode_from) -{ - const struct baz *baz = encode_from; - if (baz->v_int > 0x7fff) - return -EINVAL; - msgb_put_u16(gtlv->dst, (baz->v_bool ? 0x8000 : 0) + (baz->v_int & 0x7fff)); - return 0; -} - -int enc_to_str_baz(char *buf, size_t buflen, const void *encode_from) -{ - const struct baz *baz = encode_from; - return snprintf(buf, buflen, "{%d,%s}", baz->v_int, baz->v_bool ? "true" : "false"); -} - -int dec_repeat_struct(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct repeat *repeat_struct = decode_to; - if (gtlv->len != 3) - return -EINVAL; - repeat_struct->v_int = osmo_load16be(gtlv->val); - repeat_struct->v_bool = gtlv->val[2] & 0x80; - repeat_struct->v_enum = gtlv->val[2] & 0x7f; - return 0; -} - -int enc_repeat_struct(struct osmo_gtlv_put *gtlv, const void *decoded_struct, const void *encode_from) -{ - const struct repeat *repeat_struct = encode_from; - msgb_put_u16(gtlv->dst, repeat_struct->v_int); - msgb_put_u8(gtlv->dst, (repeat_struct->v_bool ? 0x80 : 0) + (repeat_struct->v_enum & 0x7f)); - return 0; -} - -int enc_to_str_repeat_struct(char *buf, size_t buflen, const void *encode_from) -{ - const struct repeat *repeat_struct = encode_from; - return snprintf(buf, buflen, "{%d,%s,%s}", repeat_struct->v_int, repeat_struct->v_bool ? "true" : "false", - get_value_string(repeat_enum_names, repeat_struct->v_enum)); -} - -struct osmo_gtlv_coding nested_inner_msg_ies[] = { - { - .ti = { TAG_FOO }, - .dec_func = dec_u16, - .enc_func = enc_u16, - .enc_to_str_func = enc_to_str_u16, - .memb_ofs = offsetof(struct nested_inner_msg, foo), - }, - { - .ti = { TAG_BAR }, - .dec_func = dec_bar, - .enc_func = enc_bar, - .enc_to_str_func = enc_to_str_bar, - .memb_ofs = offsetof(struct nested_inner_msg, bar), - }, - { - .ti = { TAG_BAZ }, - .dec_func = dec_baz, - .enc_func = enc_baz, - .enc_to_str_func = enc_to_str_baz, - .memb_ofs = offsetof(struct nested_inner_msg, baz), - }, - {} -}; - -struct osmo_gtlv_coding msg_ie_coding[] = { - { - .ti = { TAG_FOO }, - .dec_func = dec_u16, - .enc_func = enc_u16, - .enc_to_str_func = enc_to_str_u16, - .memb_ofs = offsetof(struct decoded_msg, foo), - }, - { - .ti = { TAG_BAR }, - .dec_func = dec_bar, - .enc_func = enc_bar, - .enc_to_str_func = enc_to_str_bar, - .memb_ofs = offsetof(struct decoded_msg, bar), - }, - { - .ti = { TAG_BAZ }, - .dec_func = dec_baz, - .enc_func = enc_baz, - .enc_to_str_func = enc_to_str_baz, - .memb_ofs = offsetof(struct decoded_msg, baz), - .has_presence_flag = true, - .presence_flag_ofs = offsetof(struct decoded_msg, baz_present), - }, - { - .ti = { TAG_REPEAT_INT }, - .dec_func = dec_u16, - .enc_func = enc_u16, - .enc_to_str_func = enc_to_str_u16, - .memb_ofs = offsetof(struct decoded_msg, repeat_int), - .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(struct decoded_msg, repeat_int), - .has_count = true, - .count_ofs = offsetof(struct decoded_msg, repeat_int_count), - .count_max = ARRAY_SIZE(((struct decoded_msg *)0)->repeat_int), - }, - { - .ti = { TAG_REPEAT_STRUCT }, - .dec_func = dec_repeat_struct, - .enc_func = enc_repeat_struct, - .enc_to_str_func = enc_to_str_repeat_struct, - .memb_ofs = offsetof(struct decoded_msg, repeat_struct), - .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(struct decoded_msg, repeat_struct), - .has_count = true, - .count_ofs = offsetof(struct decoded_msg, repeat_struct_count), - .count_max = ARRAY_SIZE(((struct decoded_msg *)0)->repeat_struct), - }, - { - .ti = { TAG_NEST }, - .memb_ofs = offsetof(struct decoded_msg, nest), - .nested_ies = nested_inner_msg_ies, - .has_presence_flag = true, - .presence_flag_ofs = offsetof(struct decoded_msg, nest_present), - }, - {} -}; - -char *decoded_msg_to_str(const struct decoded_msg *m) -{ - return osmo_gtlvs_encode_to_str_c(ctx, m, 0, msg_ie_coding, tag_names); -} - - -const struct decoded_msg enc_dec_tests[] = { - { - .foo = 23, - .bar = { "twentythree" }, - }, - { - .foo = 23, - .bar = { "twentythree" }, - - .baz_present = true, - .baz = { - .v_int = 2323, - .v_bool = true, - }, - }, - { - .foo = 23, - .bar = { "twentythree" }, - - .baz_present = true, - .baz = { - .v_int = 2323, - .v_bool = true, - }, - - .repeat_int_count = 3, - .repeat_int = { 1, 2, 0x7fff }, - }, - { - .foo = 23, - .bar = { "twentythree" }, - - .baz_present = true, - .baz = { - .v_int = 2323, - .v_bool = true, - }, - - .repeat_int_count = 3, - .repeat_int = { 1, 2, 0x7fff }, - - .repeat_struct_count = 2, - .repeat_struct = { - { - .v_int = 1001, - .v_bool = true, - .v_enum = R_A, - }, - { - .v_int = 1002, - .v_bool = false, - .v_enum = R_B, - }, - }, - - .nest_present = true, - .nest = { - .foo = 42, - .bar = { "fortytwo" }, - .baz = { - .v_int = 4242, - .v_bool = false, - }, - }, - }, -}; - -static int verify_err_cb_data; - -void err_cb(void *data, void *decoded_struct, const char *file, int line, const char *fmt, ...) -{ - assert(data == &verify_err_cb_data); - va_list args; - va_start(args, fmt); - //printf("ERR: %s:%d ", file, line); - printf("ERR: "); - vprintf(fmt, args); - va_end(args); -} - -void test_enc_dec(const char *label, const struct osmo_gtlv_cfg *cfg, bool ordered) -{ - int i; - for (i = 0; i < ARRAY_SIZE(enc_dec_tests); i++) { - int rc; - const struct decoded_msg *orig = &enc_dec_tests[i]; - struct decoded_msg parsed = {}; - struct osmo_gtlv_load load; - struct osmo_gtlv_put put; - - printf("\n=== start %s %s[%d]\n", label, __func__, i); - printf("encoded: %s\n", decoded_msg_to_str(orig)); - - put = (struct osmo_gtlv_put){ - .cfg = cfg, - .dst = msgb_alloc(1024, __func__), - }; - rc = osmo_gtlvs_encode(&put, (void *)orig, 0, msg_ie_coding, err_cb, &verify_err_cb_data, tag_names); - printf("osmo_gtlvs_encode() rc = %d\n", rc); - printf("%s.\n", osmo_hexdump(put.dst->data, put.dst->len)); - - load = (struct osmo_gtlv_load){ - .cfg = cfg, - .src = { put.dst->data, put.dst->len }, - }; - rc = osmo_gtlvs_decode(&parsed, 0, &load, ordered, msg_ie_coding, err_cb, &verify_err_cb_data, tag_names); - printf("osmo_gtlvs_decode() rc = %d\n", rc); - printf("decoded: %s\n", decoded_msg_to_str(&parsed)); - if (strcmp(decoded_msg_to_str(orig), decoded_msg_to_str(&parsed))) { - printf(" ERROR: parsed != orig\n"); - exit(1); - } - printf("=== end %s %s[%d]\n", label, __func__, i); - } -} - -int main() -{ - ctx = talloc_named_const(NULL, 0, "gtlv_test"); - msgb_talloc_ctx_init(ctx, 0); - - test_enc_dec("t8l8v ordered", &osmo_t8l8v_cfg, true); - test_enc_dec("t8l8v unordered", &osmo_t8l8v_cfg, false); - - test_enc_dec("t16l16v ordered", &osmo_t16l16v_cfg, true); - test_enc_dec("t16l16v unordered", &osmo_t16l16v_cfg, false); - - talloc_free(ctx); - return 0; -} diff --git a/tests/libosmo-gtlv/gtlv_dec_enc_test.ok b/tests/libosmo-gtlv/gtlv_dec_enc_test.ok deleted file mode 100644 index bd6df52..0000000 --- a/tests/libosmo-gtlv/gtlv_dec_enc_test.ok +++ /dev/null @@ -1,128 +0,0 @@ - -=== start t8l8v ordered test_enc_dec[0] -encoded: 'FOO'=23 'BAR'="twentythree" -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" -=== end t8l8v ordered test_enc_dec[0] - -=== start t8l8v ordered test_enc_dec[1] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -=== end t8l8v ordered test_enc_dec[1] - -=== start t8l8v ordered test_enc_dec[2] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -=== end t8l8v ordered test_enc_dec[2] - -=== start t8l8v ordered test_enc_dec[3] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -=== end t8l8v ordered test_enc_dec[3] - -=== start t8l8v unordered test_enc_dec[0] -encoded: 'FOO'=23 'BAR'="twentythree" -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" -=== end t8l8v unordered test_enc_dec[0] - -=== start t8l8v unordered test_enc_dec[1] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -=== end t8l8v unordered test_enc_dec[1] - -=== start t8l8v unordered test_enc_dec[2] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -=== end t8l8v unordered test_enc_dec[2] - -=== start t8l8v unordered test_enc_dec[3] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -osmo_gtlvs_encode() rc = 0 -01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -=== end t8l8v unordered test_enc_dec[3] - -=== start t16l16v ordered test_enc_dec[0] -encoded: 'FOO'=23 'BAR'="twentythree" -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" -=== end t16l16v ordered test_enc_dec[0] - -=== start t16l16v ordered test_enc_dec[1] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -=== end t16l16v ordered test_enc_dec[1] - -=== start t16l16v ordered test_enc_dec[2] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -=== end t16l16v ordered test_enc_dec[2] - -=== start t16l16v ordered test_enc_dec[3] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -=== end t16l16v ordered test_enc_dec[3] - -=== start t16l16v unordered test_enc_dec[0] -encoded: 'FOO'=23 'BAR'="twentythree" -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" -=== end t16l16v unordered test_enc_dec[0] - -=== start t16l16v unordered test_enc_dec[1] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} -=== end t16l16v unordered test_enc_dec[1] - -=== start t16l16v unordered test_enc_dec[2] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } -=== end t16l16v unordered test_enc_dec[2] - -=== start t16l16v unordered test_enc_dec[3] -encoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -osmo_gtlvs_encode() rc = 0 -00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . -osmo_gtlvs_decode() rc = 0 -decoded: 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } -=== end t16l16v unordered test_enc_dec[3] diff --git a/tests/libosmo-gtlv/gtlv_test.c b/tests/libosmo-gtlv/gtlv_test.c deleted file mode 100644 index 8023699..0000000 --- a/tests/libosmo-gtlv/gtlv_test.c +++ /dev/null @@ -1,629 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdio.h> -#include <errno.h> - -#include <osmocom/core/application.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/msgb.h> - -#include <osmocom/gtlv/gtlv.h> - -void *ctx; - -struct ie { - struct osmo_gtlv_tag_inst ti; - const char *val; -}; - -/* write all IEs to a msgb */ -struct msgb *test_tlv_enc(const struct osmo_gtlv_cfg *cfg, const struct ie *ies) -{ - const struct ie *ie; - struct osmo_gtlv_put gtlv = { - .cfg = cfg, - .dst = msgb_alloc(1024, __func__), - }; - - for (ie = ies; ie->val; ie++) { - /* put header without knowing length yet */ - OSMO_ASSERT(osmo_gtlv_put_tli(&gtlv, &ie->ti, 0) == 0); - /* put value data, as much as desired */ - msgb_put(gtlv.dst, osmo_hexparse(ie->val, gtlv.dst->tail, msgb_tailroom(gtlv.dst))); - /* update header len from amount of written data */ - OSMO_ASSERT(osmo_gtlv_put_update_tl(&gtlv) == 0); - } - - printf("- encoded: %s.\n", osmo_hexdump(gtlv.dst->data, gtlv.dst->len)); - return gtlv.dst; -} - -/* read all IEs from the msgb, and verify that it matches the given list of IEs */ -void test_tlv_dec(const struct osmo_gtlv_cfg *cfg, const struct ie *ies, struct msgb *msg) -{ - const struct ie *ie; - struct osmo_gtlv_load gtlv = { - .cfg = cfg, - .src = { msg->data, msg->len }, - }; - - printf("- decoding:\n"); - osmo_gtlv_load_start(&gtlv); - - for (ie = ies; ie->val; ie++) { - int rc = osmo_gtlv_load_next(&gtlv); - if (rc) { - printf(" ERROR loading TLV structure: osmo_gtlv_load_next() rc = %d\n", rc); - exit(1); - } - /* end of TLV structure? */ - if (!gtlv.val) - break; - printf(" T=%s L=%zu", osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL), gtlv.len); - printf(" v=%s\n", osmo_hexdump_nospc(gtlv.val, gtlv.len)); - if (gtlv.ti.tag != ie->ti.tag) { - printf(" ERROR loading TLV structure: expected tag %u, got tag %u\n", ie->ti.tag, gtlv.ti.tag); - exit(1); - } - if (strcmp(ie->val, osmo_hexdump_nospc(gtlv.val, gtlv.len))) { - printf(" ERROR loading TLV structure: expected val %s, got val %s\n", ie->val, - osmo_hexdump_nospc(gtlv.val, gtlv.len)); - exit(1); - } - } -} - -void test_tlv_peek(const struct osmo_gtlv_cfg *cfg, const struct ie *ies, struct msgb *msg) -{ - const struct ie *ie; - struct osmo_gtlv_load gtlv = { - .cfg = cfg, - .src = { msg->data, msg->len }, - }; - - printf("- peeking:\n"); - osmo_gtlv_load_start(&gtlv); - - ie = ies; - while (1) { - int rc; - struct osmo_gtlv_tag_inst next_tag; - rc = osmo_gtlv_load_peek_tag(&gtlv, &next_tag); - if (rc == -ENOENT) { - printf(" peek rc=-ENOENT\n"); - } else { - printf(" peek T=%s", osmo_gtlv_tag_inst_to_str_c(ctx, &next_tag, NULL)); - printf("\n"); - } - - if (ie->val && osmo_gtlv_tag_inst_cmp(&next_tag, &ie->ti)) { - printf(" ERROR peeking tag: expected tag %s, got tag %s\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL), - osmo_gtlv_tag_inst_to_str_c(ctx, &next_tag, NULL)); - exit(1); - } - if (!ie->val && rc != -ENOENT) { - printf(" ERROR peeking tag: expected -ENOENT, got rc=%d, tag %s\n", rc, - osmo_gtlv_tag_inst_to_str_c(ctx, &next_tag, NULL)); - exit(1); - } - - if (rc == -ENOENT) - break; - - /* go to the next TLV */ - rc = osmo_gtlv_load_next(&gtlv); - if (rc) { - printf(" ERROR loading TLV structure: osmo_gtlv_load_next() rc = %d\n", rc); - exit(1); - } - if (ie->val) - ie++; - } -} - -/* Decode TLV in random order, each time searching for a tag in the raw data */ -void test_tlv_dec_by_tag(const struct osmo_gtlv_cfg *cfg, const struct ie *ies, struct msgb *msg) -{ - const struct ie *last_ie; - const struct ie *ie; - int rc; - struct osmo_gtlv_load gtlv = { - .cfg = cfg, - .src = { msg->data, msg->len }, - }; - - printf("- decoding in reverse order:\n"); - - last_ie = ies; - while (last_ie->val) last_ie++; - last_ie--; - - for (ie = last_ie; ie >= ies; ie--) { - /* each time, look from the beginning */ - osmo_gtlv_load_start(&gtlv); - rc = osmo_gtlv_load_next_by_tag_inst(&gtlv, &ie->ti); - if (rc) { - printf(" ERROR loading TLV structure: osmo_gtlv_load_next_by_tag_inst(%s) rc = %d\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL), rc); - exit(1); - } - if (!gtlv.val) { - printf(" ERROR loading TLV structure: osmo_gtlv_load_next_by_tag_inst(%s) returned NULL val\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL)); - exit(1); - } - if (osmo_gtlv_tag_inst_cmp(&gtlv.ti, &ie->ti)) { - printf(" ERROR loading TLV structure: expected tag %s, got tag %s\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL), - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL)); - exit(1); - } - if (strcmp(ie->val, osmo_hexdump_nospc(gtlv.val, gtlv.len))) { - while (1) { - printf(" (mismatch: T=%s L=%zu v=%s, checking for another occurrence of T=%s)\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL), - gtlv.len, - osmo_hexdump_nospc(gtlv.val, gtlv.len), - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL)); - - rc = osmo_gtlv_load_next_by_tag_inst(&gtlv, &ie->ti); - if (rc || !gtlv.val) { - printf(" ERROR val not found\n"); - exit(1); - } - if (strcmp(ie->val, osmo_hexdump_nospc(gtlv.val, gtlv.len)) == 0) { - break; - } - } - } - printf(" T=%s L=%zu v=%s\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL), - gtlv.len, osmo_hexdump_nospc(gtlv.val, gtlv.len)); - } - - printf("- decoding every second tag:\n"); - - osmo_gtlv_load_start(&gtlv); - for (ie = ies; ie->val; ie++) { - /* skip one tag */ - ie++; - if (!ie->val) - break; - - rc = osmo_gtlv_load_next_by_tag_inst(&gtlv, &ie->ti); - if (rc) { - printf(" ERROR loading TLV structure: osmo_gtlv_load_next_by_tag_inst(%s) rc = %d\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL), rc); - exit(1); - } - if (!gtlv.val) { - printf(" ERROR loading TLV structure: osmo_gtlv_load_next_by_tag_inst(%s) returned NULL val\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL)); - exit(1); - } - if (osmo_gtlv_tag_inst_cmp(&gtlv.ti, &ie->ti)) { - printf(" ERROR loading TLV structure: expected tag %s, got tag %s\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL), - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL)); - exit(1); - } - if (strcmp(ie->val, osmo_hexdump_nospc(gtlv.val, gtlv.len))) { - while (1) { - printf(" (mismatch: T=%s L=%zu v=%s, checking for another occurrence of T=%s)\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL), - gtlv.len, - osmo_hexdump_nospc(gtlv.val, gtlv.len), - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL)); - - rc = osmo_gtlv_load_next_by_tag_inst(&gtlv, &ie->ti); - if (rc || !gtlv.val) { - printf(" ERROR val not found\n"); - exit(1); - } - if (strcmp(ie->val, osmo_hexdump_nospc(gtlv.val, gtlv.len)) == 0) { - break; - } - } - } - printf(" T=%s L=%zu v=%s\n", - osmo_gtlv_tag_inst_to_str_c(ctx, &gtlv.ti, NULL), - gtlv.len, osmo_hexdump_nospc(gtlv.val, gtlv.len)); - } - - printf("- enforcing order: without restart, a past tag is not parsed again:\n"); - /* Try to read the first tag, expect that it isn't found because we're already halfway in the message data */ - ie = ies; - rc = osmo_gtlv_load_next_by_tag_inst(&gtlv, &ie->ti); - printf(" osmo_gtlv_load_next_by_tag_inst(%s) rc=", osmo_gtlv_tag_inst_to_str_c(ctx, &ie->ti, NULL)); - if (rc == -ENOENT) { - printf("-ENOENT\n"); - } else { - printf("%d\n", rc); - printf(" ERROR: expected -ENOENT\n"); - exit(1); - } -} - -void test_tlv(const char *label, struct ie *tests[], size_t tests_len, const struct osmo_gtlv_cfg *cfg) -{ - int i; - for (i = 0; i < tests_len; i++) { - const struct ie *ies = tests[i]; - struct msgb *msg; - printf("\n=== start: %s[%d]\n", label, i); - - msg = test_tlv_enc(cfg, ies); - test_tlv_dec(cfg, ies, msg); - test_tlv_peek(cfg, ies, msg); - test_tlv_dec_by_tag(cfg, ies, msg); - - msgb_free(msg); - - printf("=== end: %s[%d]\n", label, i); - } -} - -struct ie t8l8v_test1[] = { - /* smallest T */ - { {}, "2342" }, - /* largest T */ - { {255}, "2342" }, - - /* smallest V (no V data) */ - { {1}, "" }, - /* largest V, 255 bytes is the largest that an 8bit size length can express. */ - { {123}, "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" - }, - - /* arbitrary test data */ - { {101}, "11" }, - { {102}, "2222" }, - { {103}, "333333" }, - {} -}; - -struct ie t8l8v_test_multi[] = { - { {42}, "42" }, - { {2}, "0101" }, - { {2}, "2222" }, - { {3}, "11" }, - { {3}, "2222" }, - { {3}, "333333" }, - { {23}, "23" }, - { {42}, "666f72747974776f" }, - { {23}, "7477656e74797468726565" }, - {} -}; - -struct ie *t8l8v_tests[] = { - t8l8v_test1, - t8l8v_test_multi, -}; - -void test_t8l8v() -{ - test_tlv(__func__, t8l8v_tests, ARRAY_SIZE(t8l8v_tests), &osmo_t8l8v_cfg); -} - -struct ie t16l16v_test1[] = { - /* smallest T */ - { {}, "2342" }, - /* largest T */ - { {65535}, "2342" }, - - /* smallest V (no V data) */ - { {1}, "" }, - /* 256 bytes is one more than an 8bit size length can express. */ - { {123}, "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - }, - - /* arbitrary test data */ - { {1001}, "11" }, - { {1002}, "2222" }, - { {1003}, "333333" }, - {} -}; - -struct ie t16l16v_test_multi[] = { - { {1042}, "42" }, - { {102}, "0101" }, - { {102}, "2222" }, - { {103}, "11" }, - { {103}, "2222" }, - { {103}, "333333" }, - { {1023}, "23" }, - { {1042}, "666f72747974776f" }, - { {1023}, "7477656e74797468726565" }, - {} -}; - -struct ie *t16l16v_tests[] = { - t16l16v_test1, - t16l16v_test_multi, -}; - -void test_t16l16v() -{ - test_tlv(__func__, t16l16v_tests, ARRAY_SIZE(t16l16v_tests), &osmo_t16l16v_cfg); -} - -struct ie txlxv_test1[] = { - /* smallest T */ - { {}, "2342" }, - /* largest T that still fits in one encoded octet (highest bit serves as flag) */ - { {0x7f}, "2342" }, - /* smallest T that needs two octets to be encoded (first octet = 0x80 flag + 0, second octet = 0x1) */ - { {0x80}, "2342" }, - /* largest T that can be encoded in 16bit - one flag bit. */ - { {0x7fff}, "2342" }, - - /* smallest V (no V data) */ - { {1}, "" }, - /* 256 bytes is one more than an 8bit size length can express. */ - { {123}, "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - "0000000000000000000000000000000000000000000000000000000000000000" - }, - - /* arbitrary test data */ - { {1002}, "2222" }, - { {1003}, "333333" }, - {} -}; - -struct ie txlxv_test_multi[] = { - { {1042}, "42" }, - { {1002}, "0101" }, - { {1002}, "2222" }, - { {103}, "11" }, - { {103}, "2222" }, - { {103}, "333333" }, - { {1023}, "23" }, - { {1042}, "666f72747974776f" }, - { {1023}, "7477656e74797468726565" }, - {} -}; - -struct ie *txlxv_tests[] = { - txlxv_test1, - txlxv_test_multi, -}; - -/* Example of defining a variable TL, where size of T and L depend on the actual tag and length values: load. */ -int txlxv_load_tl(struct osmo_gtlv_load *gtlv, const uint8_t *src_data, size_t src_data_len) -{ - const uint8_t *pos = src_data; - const uint8_t *end = src_data + src_data_len; - if (pos[0] & 0x80) { - if (pos + 2 > end) - return -EINVAL; - gtlv->ti.tag = (((int)pos[1]) << 7) + (pos[0] & 0x7f); - pos += 2; - } else { - gtlv->ti.tag = pos[0]; - pos++; - } - - switch (gtlv->ti.tag) { - case 1002: - /* fixed-length IE */ - gtlv->len = 2; - break; - case 123: - /* 16bit length IE */ - if (pos + 2 > end) - return -EINVAL; - gtlv->len = osmo_load16be(pos); - pos += 2; - break; - default: - /* 8bit length IE */ - if (pos + 1 > end) - return -EINVAL; - gtlv->len = *pos; - pos++; - break; - } - gtlv->val = pos; - return 0; -} - -/* Example of defining a variable TL, where size of T and L depend on the actual tag and length values: store. */ -int txlxv_store_tl(uint8_t *dst_data, size_t dst_data_avail, const struct osmo_gtlv_tag_inst *ti, size_t len, - struct osmo_gtlv_put *gtlv) -{ - uint8_t *pos = dst_data; - uint8_t *end = dst_data + dst_data_avail; - unsigned int tag = ti->tag; - if (tag < 0x80) { - if (pos + 1 > end) - return -ENOSPC; - pos[0] = tag; - pos++; - } else { - if (pos + 2 > end) - return -ENOSPC; - pos[0] = 0x80 + (tag & 0x7f); - pos[1] = tag >> 7; - pos += 2; - } - - switch (tag) { - case 1002: - /* fixed-length IE, write no len */ - break; - case 123: - /* 16bit length IE */ - if (len > UINT16_MAX) - return -ERANGE; - if (pos + 2 > end) - return -ENOSPC; - osmo_store16be(len, pos); - pos += 2; - break; - default: - /* 8bit length IE */ - if (len > UINT8_MAX) - return -ERANGE; - if (pos + 1 > end) - return -ENOSPC; - pos[0] = len; - pos++; - break; - } - return pos - dst_data; -} - -const struct osmo_gtlv_cfg txlxv_cfg = { - .tl_min_size = 1, - .load_tl = txlxv_load_tl, - .store_tl = txlxv_store_tl, -}; - -void test_txlxv() -{ - test_tlv(__func__, txlxv_tests, ARRAY_SIZE(txlxv_tests), &txlxv_cfg); -} - -/* Example of defining a TLI, with an instance indicator */ -static int tliv_load_tl(struct osmo_gtlv_load *gtlv, const uint8_t *src_data, size_t src_data_len) -{ - /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 2. */ - gtlv->ti.tag = src_data[0]; - gtlv->len = src_data[1]; - - switch (gtlv->ti.tag) { - /* All tags that are TLIV go here */ - case 5: - case 7: - case 9: - if (src_data_len < 3) - return -ENOSPC; - gtlv->ti.instance_present = true; - gtlv->ti.instance = src_data[2]; - gtlv->val = src_data + 3; - return 0; - default: - gtlv->val = src_data + 2; - return 0; - } -} - -static int tliv_store_tl(uint8_t *dst_data, size_t dst_data_avail, const struct osmo_gtlv_tag_inst *ti, size_t len, - struct osmo_gtlv_put *gtlv) -{ - if (ti->tag > UINT8_MAX) - return -EINVAL; - if (len > UINT8_MAX) - return -EMSGSIZE; - if (dst_data_avail < 2) - return -ENOSPC; - - dst_data[0] = ti->tag; - dst_data[1] = len; - - switch (ti->tag) { - /* All tags that are TLIV go here */ - case 5: - case 7: - case 9: - if (dst_data_avail < 3) - return -ENOSPC; - if (!ti->instance_present) - return -EINVAL; - if (ti->instance > UINT8_MAX) - return -EINVAL; - dst_data[2] = ti->instance; - return 3; - default: - return 2; - } -} - -const struct osmo_gtlv_cfg osmo_tliv_cfg = { - .tl_min_size = 2, - .load_tl = tliv_load_tl, - .store_tl = tliv_store_tl, -}; - -struct ie tliv_test1[] = { - /* TLV */ - { {1}, "0002" }, - /* TLIV */ - { {5, true, 1}, "0017" }, - /* TLIV */ - { {5, true, 2}, "0018" }, - /* TLIV */ - { {5, true, 3}, "0019" }, - /* TLV */ - { {6}, "001a" }, - /* TLIV */ - { {7, true, 1}, "001b" }, - /* TLIV */ - { {9, true, 1}, "001c" }, - {} -}; - -struct ie *tliv_tests[] = { - tliv_test1, -}; - -void test_tliv() -{ - test_tlv(__func__, tliv_tests, ARRAY_SIZE(tliv_tests), &osmo_tliv_cfg); -} - -int main() -{ - ctx = talloc_named_const(NULL, 0, "gtlv_test"); - msgb_talloc_ctx_init(ctx, 0); - - test_t8l8v(); - test_t16l16v(); - test_txlxv(); - test_tliv(); - - talloc_free(ctx); - return 0; -} diff --git a/tests/libosmo-gtlv/gtlv_test.ok b/tests/libosmo-gtlv/gtlv_test.ok deleted file mode 100644 index edc6ff3..0000000 --- a/tests/libosmo-gtlv/gtlv_test.ok +++ /dev/null @@ -1,291 +0,0 @@ - -=== start: test_t8l8v[0] -- encoded: 00 02 23 42 ff 02 23 42 01 00 7b ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 65 01 11 66 02 22 22 67 03 33 33 33 . -- decoding: - T=0 L=2 v=2342 - T=255 L=2 v=2342 - T=1 L=0 v= - T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff - T=101 L=1 v=11 - T=102 L=2 v=2222 - T=103 L=3 v=333333 -- peeking: - peek T=0 - peek T=255 - peek T=1 - peek T=123 - peek T=101 - peek T=102 - peek T=103 - peek rc=-ENOENT -- decoding in reverse order: - T=103 L=3 v=333333 - T=102 L=2 v=2222 - T=101 L=1 v=11 - T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff - T=1 L=0 v= - T=255 L=2 v=2342 - T=0 L=2 v=2342 -- decoding every second tag: - T=255 L=2 v=2342 - T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff - T=102 L=2 v=2222 -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(0) rc=-ENOENT -=== end: test_t8l8v[0] - -=== start: test_t8l8v[1] -- encoded: 2a 01 42 02 02 01 01 02 02 22 22 03 01 11 03 02 22 22 03 03 33 33 33 17 01 23 2a 08 66 6f 72 74 79 74 77 6f 17 0b 74 77 65 6e 74 79 74 68 72 65 65 . -- decoding: - T=42 L=1 v=42 - T=2 L=2 v=0101 - T=2 L=2 v=2222 - T=3 L=1 v=11 - T=3 L=2 v=2222 - T=3 L=3 v=333333 - T=23 L=1 v=23 - T=42 L=8 v=666f72747974776f - T=23 L=11 v=7477656e74797468726565 -- peeking: - peek T=42 - peek T=2 - peek T=2 - peek T=3 - peek T=3 - peek T=3 - peek T=23 - peek T=42 - peek T=23 - peek rc=-ENOENT -- decoding in reverse order: - (mismatch: T=23 L=1 v=23, checking for another occurrence of T=23) - T=23 L=11 v=7477656e74797468726565 - (mismatch: T=42 L=1 v=42, checking for another occurrence of T=42) - T=42 L=8 v=666f72747974776f - T=23 L=1 v=23 - (mismatch: T=3 L=1 v=11, checking for another occurrence of T=3) - (mismatch: T=3 L=2 v=2222, checking for another occurrence of T=3) - T=3 L=3 v=333333 - (mismatch: T=3 L=1 v=11, checking for another occurrence of T=3) - T=3 L=2 v=2222 - T=3 L=1 v=11 - (mismatch: T=2 L=2 v=0101, checking for another occurrence of T=2) - T=2 L=2 v=2222 - T=2 L=2 v=0101 - T=42 L=1 v=42 -- decoding every second tag: - T=2 L=2 v=0101 - T=3 L=1 v=11 - (mismatch: T=3 L=2 v=2222, checking for another occurrence of T=3) - T=3 L=3 v=333333 - T=42 L=8 v=666f72747974776f -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(42) rc=-ENOENT -=== end: test_t8l8v[1] - -=== start: test_t16l16v[0] -- encoded: 00 00 00 02 23 42 ff ff 00 02 23 42 00 01 00 00 00 7b 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 03 e9 00 01 11 03 ea 00 02 22 22 03 eb 00 03 33 33 33 . -- decoding: - T=0 L=2 v=2342 - T=65535 L=2 v=2342 - T=1 L=0 v= - T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 - T=1001 L=1 v=11 - T=1002 L=2 v=2222 - T=1003 L=3 v=333333 -- peeking: - peek T=0 - peek T=65535 - peek T=1 - peek T=123 - peek T=1001 - peek T=1002 - peek T=1003 - peek rc=-ENOENT -- decoding in reverse order: - T=1003 L=3 v=333333 - T=1002 L=2 v=2222 - T=1001 L=1 v=11 - T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 - T=1 L=0 v= - T=65535 L=2 v=2342 - T=0 L=2 v=2342 -- decoding every second tag: - T=65535 L=2 v=2342 - T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 - T=1002 L=2 v=2222 -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(0) rc=-ENOENT -=== end: test_t16l16v[0] - -=== start: test_t16l16v[1] -- encoded: 04 12 00 01 42 00 66 00 02 01 01 00 66 00 02 22 22 00 67 00 01 11 00 67 00 02 22 22 00 67 00 03 33 33 33 03 ff 00 01 23 04 12 00 08 66 6f 72 74 79 74 77 6f 03 ff 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . -- decoding: - T=1042 L=1 v=42 - T=102 L=2 v=0101 - T=102 L=2 v=2222 - T=103 L=1 v=11 - T=103 L=2 v=2222 - T=103 L=3 v=333333 - T=1023 L=1 v=23 - T=1042 L=8 v=666f72747974776f - T=1023 L=11 v=7477656e74797468726565 -- peeking: - peek T=1042 - peek T=102 - peek T=102 - peek T=103 - peek T=103 - peek T=103 - peek T=1023 - peek T=1042 - peek T=1023 - peek rc=-ENOENT -- decoding in reverse order: - (mismatch: T=1023 L=1 v=23, checking for another occurrence of T=1023) - T=1023 L=11 v=7477656e74797468726565 - (mismatch: T=1042 L=1 v=42, checking for another occurrence of T=1042) - T=1042 L=8 v=666f72747974776f - T=1023 L=1 v=23 - (mismatch: T=103 L=1 v=11, checking for another occurrence of T=103) - (mismatch: T=103 L=2 v=2222, checking for another occurrence of T=103) - T=103 L=3 v=333333 - (mismatch: T=103 L=1 v=11, checking for another occurrence of T=103) - T=103 L=2 v=2222 - T=103 L=1 v=11 - (mismatch: T=102 L=2 v=0101, checking for another occurrence of T=102) - T=102 L=2 v=2222 - T=102 L=2 v=0101 - T=1042 L=1 v=42 -- decoding every second tag: - T=102 L=2 v=0101 - T=103 L=1 v=11 - (mismatch: T=103 L=2 v=2222, checking for another occurrence of T=103) - T=103 L=3 v=333333 - T=1042 L=8 v=666f72747974776f -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(1042) rc=-ENOENT -=== end: test_t16l16v[1] - -=== start: test_txlxv[0] -- encoded: 00 02 23 42 7f 02 23 42 80 01 02 23 42 ff ff 02 23 42 01 00 7b 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ea 07 22 22 eb 07 03 33 33 33 . -- decoding: - T=0 L=2 v=2342 - T=127 L=2 v=2342 - T=128 L=2 v=2342 - T=32767 L=2 v=2342 - T=1 L=0 v= - T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 - T=1002 L=2 v=2222 - T=1003 L=3 v=333333 -- peeking: - peek T=0 - peek T=127 - peek T=128 - peek T=32767 - peek T=1 - peek T=123 - peek T=1002 - peek T=1003 - peek rc=-ENOENT -- decoding in reverse order: - T=1003 L=3 v=333333 - T=1002 L=2 v=2222 - T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 - T=1 L=0 v= - T=32767 L=2 v=2342 - T=128 L=2 v=2342 - T=127 L=2 v=2342 - T=0 L=2 v=2342 -- decoding every second tag: - T=127 L=2 v=2342 - T=32767 L=2 v=2342 - T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 - T=1003 L=3 v=333333 -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(0) rc=-ENOENT -=== end: test_txlxv[0] - -=== start: test_txlxv[1] -- encoded: 92 08 01 42 ea 07 01 01 ea 07 22 22 67 01 11 67 02 22 22 67 03 33 33 33 ff 07 01 23 92 08 08 66 6f 72 74 79 74 77 6f ff 07 0b 74 77 65 6e 74 79 74 68 72 65 65 . -- decoding: - T=1042 L=1 v=42 - T=1002 L=2 v=0101 - T=1002 L=2 v=2222 - T=103 L=1 v=11 - T=103 L=2 v=2222 - T=103 L=3 v=333333 - T=1023 L=1 v=23 - T=1042 L=8 v=666f72747974776f - T=1023 L=11 v=7477656e74797468726565 -- peeking: - peek T=1042 - peek T=1002 - peek T=1002 - peek T=103 - peek T=103 - peek T=103 - peek T=1023 - peek T=1042 - peek T=1023 - peek rc=-ENOENT -- decoding in reverse order: - (mismatch: T=1023 L=1 v=23, checking for another occurrence of T=1023) - T=1023 L=11 v=7477656e74797468726565 - (mismatch: T=1042 L=1 v=42, checking for another occurrence of T=1042) - T=1042 L=8 v=666f72747974776f - T=1023 L=1 v=23 - (mismatch: T=103 L=1 v=11, checking for another occurrence of T=103) - (mismatch: T=103 L=2 v=2222, checking for another occurrence of T=103) - T=103 L=3 v=333333 - (mismatch: T=103 L=1 v=11, checking for another occurrence of T=103) - T=103 L=2 v=2222 - T=103 L=1 v=11 - (mismatch: T=1002 L=2 v=0101, checking for another occurrence of T=1002) - T=1002 L=2 v=2222 - T=1002 L=2 v=0101 - T=1042 L=1 v=42 -- decoding every second tag: - T=1002 L=2 v=0101 - T=103 L=1 v=11 - (mismatch: T=103 L=2 v=2222, checking for another occurrence of T=103) - T=103 L=3 v=333333 - T=1042 L=8 v=666f72747974776f -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(1042) rc=-ENOENT -=== end: test_txlxv[1] - -=== start: test_tliv[0] -- encoded: 01 02 00 02 05 02 01 00 17 05 02 02 00 18 05 02 03 00 19 06 02 00 1a 07 02 01 00 1b 09 02 01 00 1c . -- decoding: - T=1 L=2 v=0002 - T=5[1] L=2 v=0017 - T=5[2] L=2 v=0018 - T=5[3] L=2 v=0019 - T=6 L=2 v=001a - T=7[1] L=2 v=001b - T=9[1] L=2 v=001c -- peeking: - peek T=1 - peek T=5[1] - peek T=5[2] - peek T=5[3] - peek T=6 - peek T=7[1] - peek T=9[1] - peek rc=-ENOENT -- decoding in reverse order: - T=9[1] L=2 v=001c - T=7[1] L=2 v=001b - T=6 L=2 v=001a - T=5[3] L=2 v=0019 - T=5[2] L=2 v=0018 - T=5[1] L=2 v=0017 - T=1 L=2 v=0002 -- decoding every second tag: - T=5[1] L=2 v=0017 - T=5[3] L=2 v=0019 - T=7[1] L=2 v=001b -- enforcing order: without restart, a past tag is not parsed again: - osmo_gtlv_load_next_by_tag_inst(1) rc=-ENOENT -=== end: test_tliv[0] diff --git a/tests/libosmo-gtlv/test_gtlv_gen/Makefile.am b/tests/libosmo-gtlv/test_gtlv_gen/Makefile.am deleted file mode 100644 index 0d27292..0000000 --- a/tests/libosmo-gtlv/test_gtlv_gen/Makefile.am +++ /dev/null @@ -1,60 +0,0 @@ -AM_CPPFLAGS = \ - $(all_includes) \ - -I$(top_srcdir)/include \ - -I$(bulddir) \ - $(NULL) - -AM_CFLAGS = \ - -Wall \ - $(LIBOSMOCORE_CFLAGS) \ - $(NULL) - -noinst_PROGRAMS = \ - gen__myproto_ies_auto \ - gtlv_gen_test \ - $(NULL) - -EXTRA_DIST = \ - myproto_ies_custom.h \ - gtlv_gen_test.ok \ - $(NULL) - -BUILT_SOURCES = \ - myproto_ies_auto.h \ - myproto_ies_auto.c \ - $(NULL) - -CLEANFILES = \ - myproto_ies_auto.h \ - myproto_ies_auto.c \ - $(NULL) - -gen__myproto_ies_auto_SOURCES = \ - gen__myproto_ies_auto.c \ - myproto_ies_custom.c \ - $(NULL) - -gen__myproto_ies_auto_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(NULL) - -myproto_ies_auto.h: $(builddir)/gen__myproto_ies_auto - $(builddir)/gen__myproto_ies_auto h > $(builddir)/myproto_ies_auto.h -myproto_ies_auto.c: $(builddir)/gen__myproto_ies_auto - $(builddir)/gen__myproto_ies_auto c > $(builddir)/myproto_ies_auto.c - -gtlv_gen_test_SOURCES = \ - gtlv_gen_test.c \ - myproto_ies_custom.c \ - myproto_ies_auto.c \ - $(NULL) - -gtlv_gen_test_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(NULL) - -.PHONY: update_exp -update_exp: - $(builddir)/gtlv_gen_test >$(srcdir)/gtlv_gen_test.ok diff --git a/tests/libosmo-gtlv/test_gtlv_gen/gen__myproto_ies_auto.c b/tests/libosmo-gtlv/test_gtlv_gen/gen__myproto_ies_auto.c deleted file mode 100644 index 75d657d..0000000 --- a/tests/libosmo-gtlv/test_gtlv_gen/gen__myproto_ies_auto.c +++ /dev/null @@ -1,114 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdbool.h> -#include <stdio.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/linuxlist.h> -#include <osmocom/core/talloc.h> -#include <osmocom/gtlv/gtlv_gen.h> - -#define O OSMO_GTLV_GEN_O -#define M OSMO_GTLV_GEN_M -#define O_MULTI OSMO_GTLV_GEN_O_MULTI -#define M_MULTI OSMO_GTLV_GEN_M_MULTI - -#define ALL_FROM_NAME osmo_gtlv_gen_ie_auto - -/* An IE where the type is not a 'struct myproto_ie_${name}'. */ -static const struct osmo_gtlv_gen_ie number = { - .decoded_type = "int", /* add 'int foo;' to the struct */ - .dec_enc = "u16", /* use myproto_dec_u16() and myproto_enc_u16() for the TLV value part */ - .spec_ref = "an int coded as uint16_t", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_moo_nest[] = { - /* Mandatory member xxx.foo of the type defined in 'number' above. */ - M(number, "foo"), - /* Mandatory member xxx.bar of type 'struct myproto_ie_bar', using myproto_ie_dec_bar(), myproto_ie_enc_bar(), - * myproto_ie_enc_to_str_bar(), all defined in myproto_ies_custom.h/c. */ - M(ALL_FROM_NAME, "bar"), - M(ALL_FROM_NAME, "baz"), - {} -}; - -static const struct osmo_gtlv_gen_ie huge_number = { - .decoded_type = "uint64_t", - .dec_enc = "u64", -}; - -static const struct osmo_gtlv_gen_ie moo_nest = { - .tag_name = "moo_nest", - .nested_ies = ies_in_moo_nest, -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_goo_nest[] = { - O(huge_number, "val"), - M(moo_nest, "nest"), - {} -}; - -static const struct osmo_gtlv_gen_ie goo_nest = { - .tag_name = "goo_nest", - .nested_ies = ies_in_goo_nest, -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_moo_msg[] = { - M(number, "foo"), - M(ALL_FROM_NAME, "bar"), - O(ALL_FROM_NAME, "baz"), - O_MULTI(32, number, "repeat_int"), - O_MULTI(32, ALL_FROM_NAME, "repeat_struct"), - O(moo_nest, "nest"), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_goo_msg[] = { - M(number, "foo"), - O(ALL_FROM_NAME, "bar"), - O_MULTI(8, goo_nest, "nest"), - {} -}; - -static const struct osmo_gtlv_gen_msg msg_defs[] = { - { "moo", ies_in_moo_msg }, - { "goo", ies_in_goo_msg }, - {} -}; - -int main(int argc, const char **argv) -{ - struct osmo_gtlv_gen_cfg cfg = { - .proto_name = "myproto", - .message_type_enum = "enum myproto_msg_type", - .message_type_prefix = "MYPROTO_MSGT_", - .tag_enum = "enum myproto_iei", - .tag_prefix = "MYPROTO_IEI_", - .decoded_type_prefix = "struct myproto_ie_", - .h_header = "#include \"myproto_ies_custom.h\"", - .c_header = "#include <myproto_ies_auto.h>", - .msg_defs = msg_defs, - .add_enc_to_str = true, - }; - return osmo_gtlv_gen_main(&cfg, argc, argv); -} diff --git a/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.c b/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.c deleted file mode 100644 index ef5372c..0000000 --- a/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.c +++ /dev/null @@ -1,261 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdio.h> -#include <errno.h> - -#include <osmocom/core/application.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/msgb.h> - -#include <osmocom/gtlv/gtlv.h> - -#include <myproto_ies_auto.h> - -struct myproto_msg { - enum myproto_msg_type type; - union myproto_ies ies; -}; - -static void err_cb(void *data, void *decoded_struct, const char *file, int line, const char *fmt, ...) -{ - va_list args; - va_start(args, fmt); - //printf("ERR: %s:%d ", file, line); - printf("ERR: "); - vprintf(fmt, args); - va_end(args); -} - -static int myproto_msg_enc(struct msgb *dst, const struct myproto_msg *msg, const struct osmo_gtlv_cfg *cfg) -{ - struct osmo_gtlv_put gtlv = { - .cfg = cfg, - .dst = dst, - }; - - msgb_put_u8(gtlv.dst, msg->type); - return myproto_ies_encode(&gtlv, (void *)&msg->ies, msg->type, err_cb, NULL, myproto_iei_names); -} - -static int myproto_msg_dec(struct myproto_msg *msg, const uint8_t *data, size_t data_len, - const struct osmo_gtlv_cfg *cfg, bool ordered) -{ - struct osmo_gtlv_load gtlv; - if (data_len < 1) - return -EINVAL; - msg->type = data[0]; - gtlv = (struct osmo_gtlv_load){ - .cfg = cfg, - .src = { data + 1, data_len - 1 }, - }; - return myproto_ies_decode(&msg->ies, &gtlv, ordered, msg->type, err_cb, NULL, myproto_iei_names); -} - -void *ctx; - -struct myproto_msg tests[] = { - { - MYPROTO_MSGT_MOO, - { - .moo = { - .foo = 23, - .bar = { "twentythree" }, - }, - }, - }, - { - MYPROTO_MSGT_MOO, - { - .moo = { - .foo = 23, - .bar = { "twentythree" }, - - .baz_present = true, - .baz = { - .v_int = 2323, - .v_bool = true, - }, - }, - }, - }, - { - MYPROTO_MSGT_MOO, - { - .moo = { - .foo = 23, - .bar = { "twentythree" }, - - .baz_present = true, - .baz = { - .v_int = 2323, - .v_bool = true, - }, - - .repeat_int_count = 3, - .repeat_int = { 1, 2, 0x7fff }, - }, - }, - }, - { - MYPROTO_MSGT_MOO, - { - .moo = { - .foo = 23, - .bar = { "twentythree" }, - - .baz_present = true, - .baz = { - .v_int = 2323, - .v_bool = true, - }, - - .repeat_int_count = 3, - .repeat_int = { 1, 2, 0x7fff }, - - .repeat_struct_count = 2, - .repeat_struct = { - { - .v_int = 1001, - .v_bool = true, - .v_enum = R_A, - }, - { - .v_int = 1002, - .v_bool = false, - .v_enum = R_B, - }, - }, - - .nest_present = true, - .nest = { - .foo = 42, - .bar = { "fortytwo" }, - .baz = { - .v_int = 4242, - .v_bool = false, - }, - }, - }, - }, - }, - { - MYPROTO_MSGT_GOO, - { - .goo = { - .foo = 17, - - .bar_present = true, - .bar = { "gooei" }, - - .nest_count = 2, - .nest = { - { - .val_present = true, - .val = 0x0123456789abcdef, - .nest = { - .foo = 11, - .bar = { "eleven" }, - .baz = { - .v_int = 1111, - .v_bool = true, - }, - }, - }, - { - .val_present = false, - .nest = { - .foo = 12, - .bar = { "twelve" }, - .baz = { - .v_int = 1212, - .v_bool = false, - }, - }, - }, - }, - }, - }, - }, -}; - -int myproto_msg_to_str_buf(char *buf, size_t buflen, const struct myproto_msg *m) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_PRINTF(sb, "%s={", get_value_string(myproto_msg_type_names, m->type)); - OSMO_STRBUF_APPEND(sb, osmo_gtlvs_encode_to_str_buf, &m->ies, 0, myproto_get_msg_coding(m->type), - myproto_iei_names); - OSMO_STRBUF_PRINTF(sb, " }"); - return sb.chars_needed; - -} - -char *myproto_msg_to_str(const struct myproto_msg *m) -{ - OSMO_NAME_C_IMPL(ctx, 256, "ERROR", myproto_msg_to_str_buf, m) -} - -void test_enc_dec(const char *label, const struct osmo_gtlv_cfg *cfg, bool ordered) -{ - int i; - for (i = 0; i < ARRAY_SIZE(tests); i++) { - int rc; - const struct myproto_msg *orig = &tests[i]; - struct myproto_msg parsed = {}; - struct msgb *msg; - - printf("\n=== start %s %s[%d]\n", label, __func__, i); - printf("encoded: %s\n", myproto_msg_to_str(orig)); - - msg = msgb_alloc(1024, __func__); - rc = myproto_msg_enc(msg, orig, cfg); - printf("myproto_msg_enc() rc = %d\n", rc); - printf("%s.\n", osmo_hexdump(msg->data, msg->len)); - - rc = myproto_msg_dec(&parsed, msg->data, msg->len, cfg, ordered); - printf("myproto_msg_dec() rc = %d\n", rc); - printf("decoded: %s\n", myproto_msg_to_str(&parsed)); - if (strcmp(myproto_msg_to_str(orig), myproto_msg_to_str(&parsed))) { - printf(" ERROR: parsed != orig\n"); - exit(1); - } - - msgb_free(msg); - printf("=== end %s %s[%d]\n", label, __func__, i); - } -} - -int main() -{ - ctx = talloc_named_const(NULL, 0, "test_gen_tlv"); - msgb_talloc_ctx_init(ctx, 0); - - test_enc_dec("t8l8v ordered", &osmo_t8l8v_cfg, true); - test_enc_dec("t8l8v unordered", &osmo_t8l8v_cfg, false); - - test_enc_dec("t16l16v ordered", &osmo_t16l16v_cfg, true); - test_enc_dec("t16l16v unordered", &osmo_t16l16v_cfg, false); - - talloc_free(ctx); - return 0; -} diff --git a/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.ok b/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.ok deleted file mode 100644 index e178831..0000000 --- a/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.ok +++ /dev/null @@ -1,160 +0,0 @@ - -=== start t8l8v ordered test_enc_dec[0] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -=== end t8l8v ordered test_enc_dec[0] - -=== start t8l8v ordered test_enc_dec[1] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -=== end t8l8v ordered test_enc_dec[1] - -=== start t8l8v ordered test_enc_dec[2] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -=== end t8l8v ordered test_enc_dec[2] - -=== start t8l8v ordered test_enc_dec[3] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -=== end t8l8v ordered test_enc_dec[3] - -=== start t8l8v ordered test_enc_dec[4] -encoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -myproto_msg_enc() rc = 0 -07 01 02 00 11 02 05 67 6f 6f 65 69 08 1c 07 08 01 23 45 67 89 ab cd ef 06 10 01 02 00 0b 02 06 65 6c 65 76 65 6e 03 02 84 57 08 12 06 10 01 02 00 0c 02 06 74 77 65 6c 76 65 03 02 04 bc . -myproto_msg_dec() rc = 0 -decoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -=== end t8l8v ordered test_enc_dec[4] - -=== start t8l8v unordered test_enc_dec[0] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -=== end t8l8v unordered test_enc_dec[0] - -=== start t8l8v unordered test_enc_dec[1] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -=== end t8l8v unordered test_enc_dec[1] - -=== start t8l8v unordered test_enc_dec[2] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -=== end t8l8v unordered test_enc_dec[2] - -=== start t8l8v unordered test_enc_dec[3] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -myproto_msg_enc() rc = 0 -01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -=== end t8l8v unordered test_enc_dec[3] - -=== start t8l8v unordered test_enc_dec[4] -encoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -myproto_msg_enc() rc = 0 -07 01 02 00 11 02 05 67 6f 6f 65 69 08 1c 07 08 01 23 45 67 89 ab cd ef 06 10 01 02 00 0b 02 06 65 6c 65 76 65 6e 03 02 84 57 08 12 06 10 01 02 00 0c 02 06 74 77 65 6c 76 65 03 02 04 bc . -myproto_msg_dec() rc = 0 -decoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -=== end t8l8v unordered test_enc_dec[4] - -=== start t16l16v ordered test_enc_dec[0] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -=== end t16l16v ordered test_enc_dec[0] - -=== start t16l16v ordered test_enc_dec[1] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -=== end t16l16v ordered test_enc_dec[1] - -=== start t16l16v ordered test_enc_dec[2] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -=== end t16l16v ordered test_enc_dec[2] - -=== start t16l16v ordered test_enc_dec[3] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -=== end t16l16v ordered test_enc_dec[3] - -=== start t16l16v ordered test_enc_dec[4] -encoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -myproto_msg_enc() rc = 0 -07 00 01 00 02 00 11 00 02 00 05 67 6f 6f 65 69 00 08 00 26 00 07 00 08 01 23 45 67 89 ab cd ef 00 06 00 16 00 01 00 02 00 0b 00 02 00 06 65 6c 65 76 65 6e 00 03 00 02 84 57 00 08 00 1a 00 06 00 16 00 01 00 02 00 0c 00 02 00 06 74 77 65 6c 76 65 00 03 00 02 04 bc . -myproto_msg_dec() rc = 0 -decoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -=== end t16l16v ordered test_enc_dec[4] - -=== start t16l16v unordered test_enc_dec[0] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" } -=== end t16l16v unordered test_enc_dec[0] - -=== start t16l16v unordered test_enc_dec[1] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} } -=== end t16l16v unordered test_enc_dec[1] - -=== start t16l16v unordered test_enc_dec[2] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } } -=== end t16l16v unordered test_enc_dec[2] - -=== start t16l16v unordered test_enc_dec[3] -encoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -myproto_msg_enc() rc = 0 -01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'FOO'=23 'BAR'="twentythree" 'BAZ'={2323,true} 'REPEAT_INT'={ 1, 2, 32767 } 'REPEAT_STRUCT'={ {1001,true,R_A}, {1002,false,R_B} } 'MOO_NEST'={ 'FOO'=42 'BAR'="fortytwo" 'BAZ'={4242,false} } } -=== end t16l16v unordered test_enc_dec[3] - -=== start t16l16v unordered test_enc_dec[4] -encoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -myproto_msg_enc() rc = 0 -07 00 01 00 02 00 11 00 02 00 05 67 6f 6f 65 69 00 08 00 26 00 07 00 08 01 23 45 67 89 ab cd ef 00 06 00 16 00 01 00 02 00 0b 00 02 00 06 65 6c 65 76 65 6e 00 03 00 02 84 57 00 08 00 1a 00 06 00 16 00 01 00 02 00 0c 00 02 00 06 74 77 65 6c 76 65 00 03 00 02 04 bc . -myproto_msg_dec() rc = 0 -decoded: GOO={ 'FOO'=17 'BAR'="gooei" 'GOO_NEST'={ { 'VAL'=0x123456789abcdef 'MOO_NEST'={ 'FOO'=11 'BAR'="eleven" 'BAZ'={1111,true} } }, { 'MOO_NEST'={ 'FOO'=12 'BAR'="twelve" 'BAZ'={1212,false} } } } } -=== end t16l16v unordered test_enc_dec[4] diff --git a/tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.c b/tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.c deleted file mode 100644 index 8548165..0000000 --- a/tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.c +++ /dev/null @@ -1,180 +0,0 @@ -/* Example for defining custom IES for gtlv_gen. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> -#include <inttypes.h> - -#include <osmocom/core/bits.h> -#include <osmocom/core/msgb.h> -#include <osmocom/gtlv/gtlv.h> - -#include <myproto_ies_custom.h> - -int myproto_dec_u16(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - int *foo = decode_to; - if (gtlv->len != 2) - return -EINVAL; - *foo = osmo_load16be(gtlv->val); - return 0; -} - -int myproto_enc_u16(struct osmo_gtlv_put *gtlv, void *decoded_struct, void *encode_from) -{ - int *foo = encode_from; - if (*foo > INT16_MAX) - return -EINVAL; - msgb_put_u16(gtlv->dst, *foo); - return 0; -} - -int myproto_enc_to_str_u16(char *buf, size_t buflen, void *encode_from) -{ - int *foo = encode_from; - return snprintf(buf, buflen, "%d", *foo); -} - -int myproto_dec_u64(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - uint64_t *val = decode_to; - if (gtlv->len != sizeof(uint64_t)) - return -EINVAL; - *val = osmo_load64be(gtlv->val); - return 0; -} - -int myproto_enc_u64(struct osmo_gtlv_put *gtlv, void *decoded_struct, void *encode_from) -{ - uint64_t *val = encode_from; - osmo_store64be(*val, msgb_put(gtlv->dst, sizeof(*val))); - return 0; -} - -int myproto_enc_to_str_u64(char *buf, size_t buflen, void *encode_from) -{ - uint64_t *val = encode_from; - return snprintf(buf, buflen, "0x%"PRIx64, *val); -} - -int myproto_dec_bar(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct myproto_ie_bar *bar = decode_to; - if (gtlv->len > sizeof(bar->str) - 1) - return -EINVAL; - osmo_strlcpy(bar->str, (const char *)gtlv->val, OSMO_MIN(gtlv->len + 1, sizeof(bar->str))); - return 0; -} - -int myproto_enc_bar(struct osmo_gtlv_put *gtlv, void *decoded_struct, void *encode_from) -{ - struct myproto_ie_bar *bar = encode_from; - int len = strnlen(bar->str, sizeof(bar->str)); - memcpy(msgb_put(gtlv->dst, len), bar, len); - return 0; -} - -int myproto_enc_to_str_bar(char *buf, size_t buflen, void *encode_from) -{ - struct myproto_ie_bar *bar = encode_from; - return osmo_quote_str_buf3(buf, buflen, bar->str, -1); -} - -int myproto_dec_baz(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct myproto_ie_baz *baz = decode_to; - uint16_t l; - if (gtlv->len != 2) - return -EINVAL; - l = osmo_load16be(gtlv->val); - baz->v_int = l & 0x7fff; - baz->v_bool = (l & 0x8000) ? true : false; - return 0; -} - -int myproto_enc_baz(struct osmo_gtlv_put *gtlv, void *decoded_struct, void *encode_from) -{ - struct myproto_ie_baz *baz = encode_from; - if (baz->v_int > 0x7fff) - return -EINVAL; - msgb_put_u16(gtlv->dst, (baz->v_bool ? 0x8000 : 0) + (baz->v_int & 0x7fff)); - return 0; -} - -int myproto_enc_to_str_baz(char *buf, size_t buflen, void *encode_from) -{ - struct myproto_ie_baz *baz = encode_from; - return snprintf(buf, buflen, "{%d,%s}", baz->v_int, baz->v_bool ? "true" : "false"); -} - -int myproto_dec_repeat_struct(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct myproto_ie_repeat_struct *repeat_struct = decode_to; - if (gtlv->len != 3) - return -EINVAL; - repeat_struct->v_int = osmo_load16be(gtlv->val); - repeat_struct->v_bool = gtlv->val[2] & 0x80; - repeat_struct->v_enum = gtlv->val[2] & 0x7f; - return 0; -} - -int myproto_enc_repeat_struct(struct osmo_gtlv_put *gtlv, void *decoded_struct, void *encode_from) -{ - struct myproto_ie_repeat_struct *repeat_struct = encode_from; - msgb_put_u16(gtlv->dst, repeat_struct->v_int); - msgb_put_u8(gtlv->dst, (repeat_struct->v_bool ? 0x80 : 0) + (repeat_struct->v_enum & 0x7f)); - return 0; -} - -int myproto_enc_to_str_repeat_struct(char *buf, size_t buflen, void *encode_from) -{ - struct myproto_ie_repeat_struct *repeat_struct = encode_from; - return snprintf(buf, buflen, "{%d,%s,%s}", - repeat_struct->v_int, repeat_struct->v_bool ? "true" : "false", - get_value_string(myproto_repeat_enum_names, repeat_struct->v_enum)); -} - -const struct value_string myproto_msg_type_names[] = { - { MYPROTO_MSGT_MOO, "MOO" }, - { MYPROTO_MSGT_GOO, "GOO" }, - {} -}; - -const struct value_string myproto_iei_names[] = { - { MYPROTO_IEI_FOO, "FOO" }, - { MYPROTO_IEI_BAR, "BAR" }, - { MYPROTO_IEI_BAZ, "BAZ" }, - { MYPROTO_IEI_REPEAT_INT, "REPEAT_INT" }, - { MYPROTO_IEI_REPEAT_STRUCT, "REPEAT_STRUCT" }, - { MYPROTO_IEI_MOO_NEST, "MOO_NEST" }, - { MYPROTO_IEI_VAL, "VAL" }, - { MYPROTO_IEI_GOO_NEST, "GOO_NEST" }, - {} -}; - -const struct value_string myproto_repeat_enum_names[] = { - OSMO_VALUE_STRING(R_A), - OSMO_VALUE_STRING(R_B), - OSMO_VALUE_STRING(R_C), - {} -}; diff --git a/tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.h b/tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.h deleted file mode 100644 index 56039af..0000000 --- a/tests/libosmo-gtlv/test_gtlv_gen/myproto_ies_custom.h +++ /dev/null @@ -1,70 +0,0 @@ -/* Definitions for decoded message IEs, to be used by the auto-generated myproto_ies_auto.c. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <osmocom/core/utils.h> - -enum myproto_msg_type { - MYPROTO_MSGT_MOO = 1, - MYPROTO_MSGT_GOO = 7, -}; - -extern const struct value_string myproto_msg_type_names[]; - -enum myproto_iei { - MYPROTO_IEI_FOO = 1, - MYPROTO_IEI_BAR, - MYPROTO_IEI_BAZ, - MYPROTO_IEI_REPEAT_INT, - MYPROTO_IEI_REPEAT_STRUCT, - MYPROTO_IEI_MOO_NEST, - MYPROTO_IEI_VAL, - MYPROTO_IEI_GOO_NEST, -}; - -extern const struct value_string myproto_iei_names[]; - -struct myproto_ie_bar { - char str[23]; -}; - -struct myproto_ie_baz { - int v_int; - bool v_bool; -}; - -enum myproto_repeat_enum { - R_A, - R_B, - R_C, -}; - -extern const struct value_string myproto_repeat_enum_names[]; - -struct myproto_ie_repeat_struct { - int v_int; - bool v_bool; - enum myproto_repeat_enum v_enum; -}; diff --git a/tests/libosmo-gtlv/test_tliv/Makefile.am b/tests/libosmo-gtlv/test_tliv/Makefile.am deleted file mode 100644 index eb95e12..0000000 --- a/tests/libosmo-gtlv/test_tliv/Makefile.am +++ /dev/null @@ -1,60 +0,0 @@ -AM_CPPFLAGS = \ - $(all_includes) \ - -I$(top_srcdir)/include \ - -I$(bulddir) \ - $(NULL) - -AM_CFLAGS = \ - -Wall \ - $(LIBOSMOCORE_CFLAGS) \ - $(NULL) - -noinst_PROGRAMS = \ - gen__myproto_ies_auto \ - tliv_test \ - $(NULL) - -EXTRA_DIST = \ - myproto_ies_custom.h \ - tliv_test.ok \ - $(NULL) - -BUILT_SOURCES = \ - myproto_ies_auto.h \ - myproto_ies_auto.c \ - $(NULL) - -CLEANFILES = \ - myproto_ies_auto.h \ - myproto_ies_auto.c \ - $(NULL) - -gen__myproto_ies_auto_SOURCES = \ - gen__myproto_ies_auto.c \ - myproto_ies_custom.c \ - $(NULL) - -gen__myproto_ies_auto_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(NULL) - -myproto_ies_auto.h: $(builddir)/gen__myproto_ies_auto - $(builddir)/gen__myproto_ies_auto h > $(builddir)/myproto_ies_auto.h -myproto_ies_auto.c: $(builddir)/gen__myproto_ies_auto - $(builddir)/gen__myproto_ies_auto c > $(builddir)/myproto_ies_auto.c - -tliv_test_SOURCES = \ - tliv_test.c \ - myproto_ies_custom.c \ - myproto_ies_auto.c \ - $(NULL) - -tliv_test_LDADD = \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ - $(LIBOSMOCORE_LIBS) \ - $(NULL) - -.PHONY: update_exp -update_exp: - $(builddir)/tliv_test >$(srcdir)/tliv_test.ok diff --git a/tests/libosmo-gtlv/test_tliv/gen__myproto_ies_auto.c b/tests/libosmo-gtlv/test_tliv/gen__myproto_ies_auto.c deleted file mode 100644 index 21e70d9..0000000 --- a/tests/libosmo-gtlv/test_tliv/gen__myproto_ies_auto.c +++ /dev/null @@ -1,71 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdbool.h> -#include <stdio.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/linuxlist.h> -#include <osmocom/core/talloc.h> -#include <osmocom/gtlv/gtlv_gen.h> - -#define O OSMO_GTLV_GEN_O -#define M OSMO_GTLV_GEN_M -#define O_MULTI OSMO_GTLV_GEN_O_MULTI -#define M_MULTI OSMO_GTLV_GEN_M_MULTI -#define O_INST OSMO_GTLV_GEN_O_INST -#define M_INST OSMO_GTLV_GEN_M_INST - -#define AUTO osmo_gtlv_gen_ie_auto - -static const struct osmo_gtlv_gen_ie bar = { - .tag_name = "bar", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_moo_msg[] = { - M_INST("MYPROTO_IEI_BAR_ALPHA", bar, "bar_alpha"), - O_INST("MYPROTO_IEI_BAR_BETA", bar, "bar_beta"), - M_INST("MYPROTO_IEI_BAR_GAMMA", bar, "bar_gamma"), - {} -}; - -static const struct osmo_gtlv_gen_msg msg_defs[] = { - { "moo", ies_in_moo_msg }, - {} -}; - -int main(int argc, const char **argv) -{ - struct osmo_gtlv_gen_cfg cfg = { - .proto_name = "myproto", - .message_type_enum = "enum myproto_msg_type", - .message_type_prefix = "MYPROTO_MSGT_", - .tag_enum = "enum myproto_iei", - .tag_prefix = "MYPROTO_IEI_", - .decoded_type_prefix = "struct myproto_ie_", - .h_header = "#include \"myproto_ies_custom.h\"", - .c_header = "#include <myproto_ies_auto.h>", - .msg_defs = msg_defs, - .add_enc_to_str = true, - }; - return osmo_gtlv_gen_main(&cfg, argc, argv); -} diff --git a/tests/libosmo-gtlv/test_tliv/myproto_ies_custom.c b/tests/libosmo-gtlv/test_tliv/myproto_ies_custom.c deleted file mode 100644 index 54164ce..0000000 --- a/tests/libosmo-gtlv/test_tliv/myproto_ies_custom.c +++ /dev/null @@ -1,68 +0,0 @@ -/* Example for defining custom IES for gtlv_gen. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> -#include <inttypes.h> - -#include <osmocom/core/bits.h> -#include <osmocom/core/msgb.h> -#include <osmocom/gtlv/gtlv.h> - -#include <myproto_ies_custom.h> - -int myproto_dec_bar(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *gtlv) -{ - struct myproto_ie_bar *bar = decode_to; - if (gtlv->len < 2) - return -EINVAL; - *bar = (struct myproto_ie_bar){ - .a = gtlv->val[0], - .b = (gtlv->val[1] == 1), - }; - return 0; -} - -int myproto_enc_bar(struct osmo_gtlv_put *gtlv, void *decoded_struct, void *encode_from) -{ - struct myproto_ie_bar *bar = encode_from; - msgb_put_u8(gtlv->dst, bar->a); - msgb_put_u8(gtlv->dst, bar->b ? 1 : 0); - return 0; -} - -int myproto_enc_to_str_bar(char *buf, size_t buflen, void *encode_from) -{ - struct myproto_ie_bar *bar = encode_from; - return snprintf(buf, buflen, "%d,%s", bar->a, bar->b ? "true" : "false"); -} - -const struct value_string myproto_msg_type_names[] = { - { MYPROTO_MSGT_MOO, "MOO" }, - {} -}; - -const struct value_string myproto_iei_names[] = { - { MYPROTO_IEI_BAR, "BAR" }, - {} -}; diff --git a/tests/libosmo-gtlv/test_tliv/myproto_ies_custom.h b/tests/libosmo-gtlv/test_tliv/myproto_ies_custom.h deleted file mode 100644 index 64e06ff..0000000 --- a/tests/libosmo-gtlv/test_tliv/myproto_ies_custom.h +++ /dev/null @@ -1,50 +0,0 @@ -/* Definitions for decoded message IEs, to be used by the auto-generated myproto_ies_auto.c. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <osmocom/core/utils.h> - -enum myproto_msg_type { - MYPROTO_MSGT_MOO = 1, -}; - -extern const struct value_string myproto_msg_type_names[]; - -enum myproto_iei { - MYPROTO_IEI_BAR = 1, -}; - -enum myproto_iei_bar_inst { - MYPROTO_IEI_BAR_ALPHA = 2, - MYPROTO_IEI_BAR_BETA = 3, - MYPROTO_IEI_BAR_GAMMA = 5, -}; - -extern const struct value_string myproto_iei_names[]; - -struct myproto_ie_bar { - int a; - bool b; -}; diff --git a/tests/libosmo-gtlv/test_tliv/tliv_test.c b/tests/libosmo-gtlv/test_tliv/tliv_test.c deleted file mode 100644 index fd4e310..0000000 --- a/tests/libosmo-gtlv/test_tliv/tliv_test.c +++ /dev/null @@ -1,217 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdio.h> -#include <errno.h> - -#include <osmocom/core/application.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/msgb.h> - -#include <osmocom/gtlv/gtlv.h> - -#include <myproto_ies_auto.h> - -struct myproto_msg { - enum myproto_msg_type type; - union myproto_ies ies; -}; - -static void err_cb(void *data, void *decoded_struct, const char *file, int line, const char *fmt, ...) -{ - va_list args; - va_start(args, fmt); - //printf("ERR: %s:%d ", file, line); - printf("ERR: "); - vprintf(fmt, args); - va_end(args); -} - -static int myproto_msg_enc(struct msgb *dst, const struct myproto_msg *msg, const struct osmo_gtlv_cfg *cfg) -{ - struct osmo_gtlv_put gtlv = { - .cfg = cfg, - .dst = dst, - }; - - msgb_put_u8(gtlv.dst, msg->type); - return myproto_ies_encode(&gtlv, (void *)&msg->ies, msg->type, err_cb, NULL, myproto_iei_names); -} - -static int myproto_msg_dec(struct myproto_msg *msg, const uint8_t *data, size_t data_len, - const struct osmo_gtlv_cfg *cfg, bool ordered) -{ - struct osmo_gtlv_load gtlv; - if (data_len < 1) - return -EINVAL; - msg->type = data[0]; - gtlv = (struct osmo_gtlv_load){ - .cfg = cfg, - .src = { data + 1, data_len - 1 }, - }; - return myproto_ies_decode(&msg->ies, &gtlv, ordered, msg->type, err_cb, NULL, myproto_iei_names); -} - -void *ctx; - -struct myproto_msg tests[] = { - { - MYPROTO_MSGT_MOO, - { - .moo = { - .bar_alpha = { 23, true }, - .bar_gamma = { 42, false }, - }, - }, - }, - { - MYPROTO_MSGT_MOO, - { - .moo = { - .bar_alpha = { 11, true }, - .bar_beta_present = true, - .bar_beta = { 22, false }, - .bar_gamma = { 33, true }, - }, - }, - }, -}; - -int myproto_msg_to_str_buf(char *buf, size_t buflen, const struct myproto_msg *m) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_PRINTF(sb, "%s={", get_value_string(myproto_msg_type_names, m->type)); - OSMO_STRBUF_APPEND(sb, osmo_gtlvs_encode_to_str_buf, &m->ies, 0, myproto_get_msg_coding(m->type), - myproto_iei_names); - OSMO_STRBUF_PRINTF(sb, " }"); - return sb.chars_needed; - -} - -char *myproto_msg_to_str(const struct myproto_msg *m) -{ - OSMO_NAME_C_IMPL(ctx, 256, "ERROR", myproto_msg_to_str_buf, m) -} - -void test_enc_dec(const char *label, const struct osmo_gtlv_cfg *cfg, bool ordered) -{ - int i; - for (i = 0; i < ARRAY_SIZE(tests); i++) { - int rc; - const struct myproto_msg *orig = &tests[i]; - struct myproto_msg parsed = {}; - struct msgb *msg; - - printf("\n=== start %s %s[%d]\n", label, __func__, i); - printf("encoded: %s\n", myproto_msg_to_str(orig)); - - msg = msgb_alloc(1024, __func__); - rc = myproto_msg_enc(msg, orig, cfg); - printf("myproto_msg_enc() rc = %d\n", rc); - printf("%s.\n", osmo_hexdump(msg->data, msg->len)); - - rc = myproto_msg_dec(&parsed, msg->data, msg->len, cfg, ordered); - printf("myproto_msg_dec() rc = %d\n", rc); - printf("decoded: %s\n", myproto_msg_to_str(&parsed)); - if (strcmp(myproto_msg_to_str(orig), myproto_msg_to_str(&parsed))) { - printf(" ERROR: parsed != orig\n"); - exit(1); - } - - msgb_free(msg); - printf("=== end %s %s[%d]\n", label, __func__, i); - } -} - -/* Example of defining a TLI, with an instance indicator */ -static int tliv_load_tl(struct osmo_gtlv_load *gtlv, const uint8_t *src_data, size_t src_data_len) -{ - /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 2. */ - gtlv->ti.tag = src_data[0]; - gtlv->len = src_data[1]; - - switch (gtlv->ti.tag) { - /* All tags that are TLIV go here */ - case MYPROTO_IEI_BAR: - if (src_data_len < 3) - return -ENOSPC; - gtlv->ti.instance_present = true; - gtlv->ti.instance = src_data[2]; - gtlv->val = src_data + 3; - /* In this example, the I is part of the len */ - gtlv->len--; - return 0; - default: - gtlv->val = src_data + 2; - return 0; - } -} - -static int tliv_store_tl(uint8_t *dst_data, size_t dst_data_avail, const struct osmo_gtlv_tag_inst *ti, size_t len, - struct osmo_gtlv_put *gtlv) -{ - if (ti->tag > UINT8_MAX) - return -EINVAL; - if (len > UINT8_MAX) - return -EMSGSIZE; - if (dst_data_avail < 2) - return -ENOSPC; - - dst_data[0] = ti->tag; - - switch (ti->tag) { - /* All tags that are TLIV go here */ - case MYPROTO_IEI_BAR: - if (dst_data_avail < 3) - return -ENOSPC; - if (!ti->instance_present) - return -EINVAL; - if (ti->instance > UINT8_MAX) - return -EINVAL; - /* here, I is part of the len in L; the passed len reflects only the value, so add 1 for I */ - dst_data[1] = len + 1; - dst_data[2] = ti->instance; - return 3; - default: - dst_data[1] = len; - return 2; - } -} - -const struct osmo_gtlv_cfg osmo_tliv_cfg = { - .tl_min_size = 2, - .load_tl = tliv_load_tl, - .store_tl = tliv_store_tl, -}; - -int main() -{ - ctx = talloc_named_const(NULL, 0, "test_gen_tlv"); - msgb_talloc_ctx_init(ctx, 0); - - test_enc_dec("tliv ordered", &osmo_tliv_cfg, true); - test_enc_dec("tliv unordered", &osmo_tliv_cfg, false); - - talloc_free(ctx); - return 0; -} diff --git a/tests/libosmo-gtlv/test_tliv/tliv_test.ok b/tests/libosmo-gtlv/test_tliv/tliv_test.ok deleted file mode 100644 index 184ffa6..0000000 --- a/tests/libosmo-gtlv/test_tliv/tliv_test.ok +++ /dev/null @@ -1,32 +0,0 @@ - -=== start tliv ordered test_enc_dec[0] -encoded: MOO={ 'BAR'=23,true 'BAR'=42,false } -myproto_msg_enc() rc = 0 -01 01 03 02 17 01 01 03 05 2a 00 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'BAR'=23,true 'BAR'=42,false } -=== end tliv ordered test_enc_dec[0] - -=== start tliv ordered test_enc_dec[1] -encoded: MOO={ 'BAR'=11,true 'BAR'=22,false 'BAR'=33,true } -myproto_msg_enc() rc = 0 -01 01 03 02 0b 01 01 03 03 16 00 01 03 05 21 01 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'BAR'=11,true 'BAR'=22,false 'BAR'=33,true } -=== end tliv ordered test_enc_dec[1] - -=== start tliv unordered test_enc_dec[0] -encoded: MOO={ 'BAR'=23,true 'BAR'=42,false } -myproto_msg_enc() rc = 0 -01 01 03 02 17 01 01 03 05 2a 00 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'BAR'=23,true 'BAR'=42,false } -=== end tliv unordered test_enc_dec[0] - -=== start tliv unordered test_enc_dec[1] -encoded: MOO={ 'BAR'=11,true 'BAR'=22,false 'BAR'=33,true } -myproto_msg_enc() rc = 0 -01 01 03 02 0b 01 01 03 03 16 00 01 03 05 21 01 . -myproto_msg_dec() rc = 0 -decoded: MOO={ 'BAR'=11,true 'BAR'=22,false 'BAR'=33,true } -=== end tliv unordered test_enc_dec[1] diff --git a/tests/libosmo-pfcp/Makefile.am b/tests/libosmo-pfcp/Makefile.am index fda143f..eba3aa4 100644 --- a/tests/libosmo-pfcp/Makefile.am +++ b/tests/libosmo-pfcp/Makefile.am @@ -7,6 +7,7 @@ AM_CFLAGS = \ -Wall \ $(LIBOSMOCORE_CFLAGS) \ + $(LIBOSMOGTLV_CFLAGS) \ $(NULL) noinst_PROGRAMS = \ @@ -23,8 +24,8 @@ pfcp_test_LDADD = \ $(top_builddir)/src/libosmo-pfcp/libosmo-pfcp.a \ - $(top_builddir)/src/libosmo-gtlv/libosmo-gtlv.a \ $(LIBOSMOCORE_LIBS) \ + $(LIBOSMOGTLV_LIBS) \ $(NULL) .PHONY: update_exp diff --git a/tests/testsuite.at b/tests/testsuite.at index a365f0e..352fba9 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -1,30 +1,6 @@ AT_INIT AT_BANNER([Regression tests.]) -AT_SETUP([gtlv]) -AT_KEYWORDS([gtlv]) -cat $abs_srcdir/libosmo-gtlv/gtlv_test.ok > expout -AT_CHECK([$abs_top_builddir/tests/libosmo-gtlv/gtlv_test], [], [expout], [ignore]) -AT_CLEANUP - -AT_SETUP([gtlv_dec_enc]) -AT_KEYWORDS([gtlv_dec_enc]) -cat $abs_srcdir/libosmo-gtlv/gtlv_dec_enc_test.ok > expout -AT_CHECK([$abs_top_builddir/tests/libosmo-gtlv/gtlv_dec_enc_test], [], [expout], [ignore]) -AT_CLEANUP - -AT_SETUP([gtlv_gen]) -AT_KEYWORDS([gtlv_gen]) -cat $abs_srcdir/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test.ok > expout -AT_CHECK([$abs_top_builddir/tests/libosmo-gtlv/test_gtlv_gen/gtlv_gen_test], [], [expout], [ignore]) -AT_CLEANUP - -AT_SETUP([tliv]) -AT_KEYWORDS([tliv]) -cat $abs_srcdir/libosmo-gtlv/test_tliv/tliv_test.ok > expout -AT_CHECK([$abs_top_builddir/tests/libosmo-gtlv/test_tliv/tliv_test], [], [expout], [ignore]) -AT_CLEANUP - AT_SETUP([pfcp]) AT_KEYWORDS([pfcp]) cat $abs_srcdir/libosmo-pfcp/pfcp_test.ok > expout null-- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28287 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Id72cdf94da60d4b6d09d0044c74e672c4412c15d Gerrit-Change-Number: 28287 Gerrit-PatchSet: 2 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in osmo-upf[master]: move libosmo-pfcp to libosmo-pfcp.git
by neels 19 Jul '22

19 Jul '22

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28306 ) Change subject: move libosmo-pfcp to libosmo-pfcp.git ...................................................................... move libosmo-pfcp to libosmo-pfcp.git The first user of this is osmo-hnbgw, to implement GTP mapping via a UPF. Related: SYS#5895 Change-Id: I1464cdd846b00707b0abba9126aa5bb784b7caf1 --- M configure.ac M include/osmocom/Makefile.am D include/osmocom/pfcp/Makefile.am D include/osmocom/pfcp/pfcp_endpoint.h D include/osmocom/pfcp/pfcp_ies_custom.h D include/osmocom/pfcp/pfcp_msg.h D include/osmocom/pfcp/pfcp_proto.h D include/osmocom/pfcp/pfcp_strs.h M src/Makefile.am D src/libosmo-pfcp/Makefile.am D src/libosmo-pfcp/gen__pfcp_ies_auto.c D src/libosmo-pfcp/pfcp_endpoint.c D src/libosmo-pfcp/pfcp_ies_custom.c D src/libosmo-pfcp/pfcp_msg.c D src/libosmo-pfcp/pfcp_strs.c M tests/Makefile.am D tests/libosmo-pfcp/Makefile.am D tests/libosmo-pfcp/pfcp_test.c D tests/libosmo-pfcp/pfcp_test.ok M tests/testsuite.at 20 files changed, 1 insertion(+), 4,755 deletions(-) Approvals: pespin: Looks good to me, but someone else must approve laforge: Looks good to me, approved Jenkins Builder: Verified diff --git a/configure.ac b/configure.ac index 9ee5011..fe41cc9 100644 --- a/configure.ac +++ b/configure.ac @@ -43,6 +43,7 @@ PKG_CHECK_MODULES(LIBOSMOVTY, libosmovty >= 1.5.0) PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 1.5.0) PKG_CHECK_MODULES(LIBOSMOGTLV, libosmo-gtlv >= 0.1.0) +PKG_CHECK_MODULES(LIBOSMOPFCP, libosmo-pfcp >= 0.1.0) dnl checks for header files AC_HEADER_STDC @@ -198,14 +199,11 @@ AC_OUTPUT( include/Makefile include/osmocom/Makefile - include/osmocom/pfcp/Makefile include/osmocom/upf/Makefile src/Makefile - src/libosmo-pfcp/Makefile src/osmo-upf/Makefile tests/Makefile tests/atlocal - tests/libosmo-pfcp/Makefile doc/Makefile doc/examples/Makefile doc/manuals/Makefile diff --git a/include/osmocom/Makefile.am b/include/osmocom/Makefile.am index 5a1276e..3f929f1 100644 --- a/include/osmocom/Makefile.am +++ b/include/osmocom/Makefile.am @@ -1,4 +1,3 @@ SUBDIRS = \ - pfcp \ upf \ $(NULL) diff --git a/include/osmocom/pfcp/Makefile.am b/include/osmocom/pfcp/Makefile.am deleted file mode 100644 index a9bdeab..0000000 --- a/include/osmocom/pfcp/Makefile.am +++ /dev/null @@ -1,22 +0,0 @@ -pfcp_HEADERS = \ - pfcp_endpoint.h \ - pfcp_ies_custom.h \ - pfcp_ies_auto.h \ - pfcp_msg.h \ - pfcp_proto.h \ - pfcp_strs.h \ - $(NULL) - -pfcpdir = $(includedir)/osmocom/pfcp - -BUILT_SOURCES = \ - pfcp_ies_auto.h \ - $(NULL) - -CLEANFILES = \ - pfcp_ies_auto.h \ - $(NULL) - -pfcp_ies_auto.h: $(top_srcdir)/src/libosmo-pfcp/gen__pfcp_ies_auto.c - $(MAKE) -C $(top_builddir)/src/libosmo-pfcp gen__pfcp_ies_auto - $(top_builddir)/src/libosmo-pfcp/gen__pfcp_ies_auto h > $(builddir)/pfcp_ies_auto.h diff --git a/include/osmocom/pfcp/pfcp_endpoint.h b/include/osmocom/pfcp/pfcp_endpoint.h deleted file mode 100644 index acc878e..0000000 --- a/include/osmocom/pfcp/pfcp_endpoint.h +++ /dev/null @@ -1,107 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <osmocom/core/socket.h> -#include <osmocom/core/select.h> -#include <osmocom/core/tdef.h> - -#include <osmocom/pfcp/pfcp_msg.h> - -struct osmo_pfcp_endpoint; -struct osmo_fsm_inst; - -#define OSMO_PFCP_TIMER_HEARTBEAT_REQ -19 -#define OSMO_PFCP_TIMER_HEARTBEAT_RESP -20 -#define OSMO_PFCP_TIMER_GRACEFUL_REL -21 -#define OSMO_PFCP_TIMER_T1 -22 -#define OSMO_PFCP_TIMER_N1 -23 -#define OSMO_PFCP_TIMER_KEEP_RESP -24 -#define OSMO_PFCP_TIMER_ASSOC_RETRY -26 - -extern struct osmo_tdef osmo_pfcp_tdefs[]; - -/* Ownership of m remains with the caller / m will be deallocated by the caller. - * \param ep The PFCP endpoint that received and decoded the message. - * \param m The message that was received. - * \param req If m is a PFCP Response to an earlier Request, req is that request message. Otherwise req is NULL. - */ -typedef void (*osmo_pfcp_endpoint_cb)(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m, - struct osmo_pfcp_msg *req); - -/* Send/receive PFCP messages to/from remote PFCP endpoints. */ -struct osmo_pfcp_endpoint { - struct { - /* Local address */ - struct osmo_sockaddr local_addr; - /* Local PFCP Node ID, as sent in outgoing messages' Node ID IE */ - struct osmo_pfcp_ie_node_id local_node_id; - - /* Timer definitions to use, if any. See t1_ms, keep_resp_ms. Use osmo_pfcp_tdefs by default. It is - * convenient to add osmo_pfcp_tdefs as one of your program's osmo_tdef_group entries and call - * osmo_tdef_vty_init() to expose PFCP timers on the VTY. */ - const struct osmo_tdef *tdefs; - } cfg; - - /* PFCP socket */ - struct osmo_fd pfcp_fd; - - /* The time at which this endpoint last restarted, as seconds since unix epoch. */ - uint32_t recovery_time_stamp; - - /* State for determining the next sequence number for transmitting a request message */ - uint32_t seq_nr_state; - - /* This function is called just after decoding and before handling the message. - * This function may set ctx.peer_fi and ctx.session_fi, used for logging context during message decoding. - * The caller may also use these fi pointers to reduce lookup iterations in rx_msg(). - */ - osmo_pfcp_endpoint_cb set_msg_ctx; - - /* Callback to receive single incoming PFCP messages from a remote peer, already decoded. */ - osmo_pfcp_endpoint_cb rx_msg; - - /* application-private data */ - void *priv; - - /* All transmitted PFCP Request messages, list of osmo_pfcp_queue_entry. - * For a transmitted Request message, wait for a matching Response from a remote peer; if none arrives, - * retransmit (see n1 and t1_ms). */ - struct llist_head sent_requests; - /* All transmitted PFCP Response messages, list of osmo_pfcp_queue_entry. - * For a transmitted Response message, keep it in the queue for a fixed amount of time. If the peer retransmits - * the original Request, do not dispatch the Request, but respond with the queued message directly. */ - struct llist_head sent_responses; -}; - -struct osmo_pfcp_endpoint *osmo_pfcp_endpoint_create(void *ctx, void *priv); -int osmo_pfcp_endpoint_bind(struct osmo_pfcp_endpoint *ep); -void osmo_pfcp_endpoint_close(struct osmo_pfcp_endpoint *ep); -void osmo_pfcp_endpoint_free(struct osmo_pfcp_endpoint **ep); - -int osmo_pfcp_endpoint_tx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m); -int osmo_pfcp_endpoint_tx_data(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m); -int osmo_pfcp_endpoint_tx_heartbeat_req(struct osmo_pfcp_endpoint *ep, const struct osmo_sockaddr *remote_addr); - -void osmo_pfcp_endpoint_invalidate_ctx(struct osmo_pfcp_endpoint *ep, struct osmo_fsm_inst *deleted_fi); diff --git a/include/osmocom/pfcp/pfcp_ies_custom.h b/include/osmocom/pfcp/pfcp_ies_custom.h deleted file mode 100644 index 08e62d1..0000000 --- a/include/osmocom/pfcp/pfcp_ies_custom.h +++ /dev/null @@ -1,166 +0,0 @@ -/* Definitions for decoded PFCP IEs, to be used by the auto-generated pfcp_ies_auto.c. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <osmocom/core/socket.h> - -#include <osmocom/pfcp/pfcp_proto.h> - -/* Common pattern used in various PFCP IEs. */ -struct osmo_pfcp_ip_addrs { - bool v4_present; - struct osmo_sockaddr v4; - bool v6_present; - struct osmo_sockaddr v6; -}; - -int osmo_pfcp_ip_addrs_set(struct osmo_pfcp_ip_addrs *dst, const struct osmo_sockaddr *addr); - -/* 3GPP TS 29.244 8.2.38, IETF RFC 1035 3.1 */ -struct osmo_pfcp_ie_node_id { - enum osmo_pfcp_node_id_type type; - union { - struct osmo_sockaddr ip; - /* Fully qualified domain name in "dot" notation ("host.example.com") */ - char fqdn[254]; - }; -}; - -int osmo_pfcp_ie_node_id_to_str_buf(char *buf, size_t buflen, const struct osmo_pfcp_ie_node_id *node_id); -char *osmo_pfcp_ie_node_id_to_str_c(void *ctx, const struct osmo_pfcp_ie_node_id *node_id); - -bool osmo_pfcp_bits_get(const uint8_t *bits, unsigned int bitpos); -void osmo_pfcp_bits_set(uint8_t *bits, unsigned int bitpos, bool val); -int osmo_pfcp_bits_to_str_buf(char *buf, size_t buflen, const uint8_t *bits, const struct value_string *bit_strs); -char *osmo_pfcp_bits_to_str_c(void *ctx, const uint8_t *bits, const struct value_string *bit_str); - -/* 3GPP TS 29.244 8.2.25 - * Usage: - * struct osmo_pfcp_ie_up_function_features x; - * osmo_pfcp_bits_set(x.bits, OSMO_PFCP_UP_FEAT_BUNDL, true); - * if (osmo_pfcp_bits_get(x.bits, OSMO_PFCP_UP_FEAT_BUNDL)) - * foo(); - * printf("%s\n", osmo_pfcp_bits_to_str_c(x.bits, osmo_pfcp_up_feature_strs)); - */ -struct osmo_pfcp_ie_up_function_features { - uint8_t bits[6]; -}; - -/* 3GPP TS 29.244 8.2.58 - * struct osmo_pfcp_ie_cp_function_features x; - * osmo_pfcp_bits_set(x.bits, OSMO_PFCP_CP_FEAT_BUNDL, true); - * if (osmo_pfcp_bits_get(x.bits, OSMO_PFCP_CP_FEAT_BUNDL)) - * foo(); - * printf("%s\n", osmo_pfcp_bits_to_str_c(x.bits, osmo_pfcp_cp_feature_strs)); - */ -struct osmo_pfcp_ie_cp_function_features { - uint8_t bits[1]; -}; - -/* 3GPP TS 29.244 8.2.37 */ -struct osmo_pfcp_ie_f_seid { - uint64_t seid; - struct osmo_pfcp_ip_addrs ip_addr; -}; - -void osmo_pfcp_ie_f_seid_set(struct osmo_pfcp_ie_f_seid *f_seid, uint64_t seid, - const struct osmo_sockaddr *remote_addr); - -/* 3GPP TS 29.244 8.3.2 */ -struct osmo_pfcp_ie_f_teid { - bool choose_flag; - union { - struct { - uint32_t teid; - struct osmo_pfcp_ip_addrs ip_addr; - } fixed; - struct { - bool ipv4_addr; - bool ipv6_addr; - bool choose_id_present; - uint8_t choose_id; - } choose; - }; -}; - -/* 3GPP TS 29.244 8.2.62 */ -struct osmo_pfcp_ie_ue_ip_address { - bool chv6; - bool chv4; - bool ip_is_destination; - struct osmo_pfcp_ip_addrs ip_addr; - bool ipv6_prefix_delegation_bits_present; - uint8_t ipv6_prefix_delegation_bits; - bool ipv6_prefix_length_present; - uint8_t ipv6_prefix_length; -}; - -/* 3GPP TS 29.244 8.2.26. - * Usage: - * struct osmo_pfcp_ie_apply_action x; - * osmo_pfcp_bits_set(x.bits, OSMO_PFCP_APPLY_ACTION_FORW, true); - * if (osmo_pfcp_bits_get(x.bits, OSMO_PFCP_APPLY_ACTION_FORW)) - * foo(); - * printf("%s\n", osmo_pfcp_bits_to_str_c(x.bits, osmo_pfcp_apply_action_strs)); - */ -struct osmo_pfcp_ie_apply_action { - uint8_t bits[2]; -}; - -struct osmo_pfcp_ie_network_inst { - /* A domain name may have up to 253 characters; plus nul. */ - char str[253+1]; -}; - -struct osmo_pfcp_ie_activate_predefined_rules { - char str[256]; -}; - -/* 3GPP TS 29.244 8.2.56 */ -struct osmo_pfcp_ie_outer_header_creation { - /* desc_bits Usage: - * osmo_pfcp_bits_set(x.desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4, true); - * if (osmo_pfcp_bits_get(x.desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4)) - * foo(); - * printf("%s\n", osmo_pfcp_bits_to_str_c(x.desc_bits, osmo_pfcp_outer_header_creation_strs)); - */ - uint8_t desc_bits[2]; - bool teid_present; - uint32_t teid; - struct osmo_pfcp_ip_addrs ip_addr; - bool port_number_present; - uint16_t port_number; - bool c_tag_present; - uint32_t c_tag; - bool s_tag_present; - uint32_t s_tag; -}; - -/* 3GPP TS 29.244 8.2.64. */ -struct osmo_pfcp_ie_outer_header_removal { - enum osmo_pfcp_outer_header_removal_desc desc; - bool gtp_u_extension_header_del_present; - uint8_t gtp_u_extension_header_del_bits[1]; -}; diff --git a/include/osmocom/pfcp/pfcp_msg.h b/include/osmocom/pfcp/pfcp_msg.h deleted file mode 100644 index 2833408..0000000 --- a/include/osmocom/pfcp/pfcp_msg.h +++ /dev/null @@ -1,200 +0,0 @@ -/* PFCP message encoding and decoding */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <stdint.h> -#include <stdbool.h> -#include <inttypes.h> - -#include <osmocom/core/socket.h> -#include <osmocom/core/msgb.h> -#include <osmocom/core/fsm.h> - -#include <osmocom/pfcp/pfcp_proto.h> -#include <osmocom/pfcp/pfcp_ies_auto.h> -#include <osmocom/pfcp/pfcp_strs.h> - -struct msgb; -struct osmo_t16l16v_ie; -struct osmo_pfcp_msg; - -#define OSMO_PFCP_MSGB_ALLOC_SIZE 2048 - -#define OSMO_LOG_PFCP_MSG_SRC(M, LEVEL, file, line, FMT, ARGS...) do { \ - struct osmo_fsm_inst *_fi = (M) ? ((M)->ctx.session_fi ?: (M)->ctx.peer_fi) : NULL; \ - enum osmo_pfcp_cause *cause = osmo_pfcp_msg_cause(M); \ - if ((M)->h.seid_present) { \ - LOGPFSMSLSRC(_fi, DLPFCP, LEVEL, file, line, \ - "%s%s PFCP seq-%u SEID-0x%"PRIx64" %s%s%s: " FMT, \ - _fi ? "" : osmo_sockaddr_to_str_c(OTC_SELECT, &(M)->remote_addr), \ - (M)->rx ? "-rx->" : "<-tx-", (M)->h.sequence_nr, \ - (M)->h.seid, \ - osmo_pfcp_message_type_str((M)->h.message_type), cause ? ": " : "", \ - cause ? osmo_pfcp_cause_str(*cause) : "", ##ARGS); \ - } else { \ - LOGPFSMSLSRC(_fi, DLPFCP, LEVEL, file, line, \ - "%s%s PFCP seq-%u %s%s%s: " FMT, \ - _fi ? "" : osmo_sockaddr_to_str_c(OTC_SELECT, &(M)->remote_addr), \ - (M)->rx ? "-rx->" : "<-tx-", (M)->h.sequence_nr, \ - osmo_pfcp_message_type_str((M)->h.message_type), cause ? ": " : "", \ - cause ? osmo_pfcp_cause_str(*cause) : "", ##ARGS); \ - } \ - } while (0) - -#define OSMO_LOG_PFCP_MSG(M, LEVEL, FMT, ARGS...) \ - OSMO_LOG_PFCP_MSG_SRC(M, LEVEL, __FILE__, __LINE__, FMT, ##ARGS) - -struct osmo_pfcp_header_parsed { - uint8_t version; - enum osmo_pfcp_message_type message_type; - uint32_t sequence_nr; - bool priority_present; - uint8_t priority; - bool seid_present; - uint64_t seid; -}; - -/* For PFCP requests, notify when a PFCP response has arrived, or when the PFCP response timed out. - * When rx_resp == NULL, receiving a response timed out or the response could not be decoded. - * On error, errmsg may convey a human readable error message. - * Return 1 to also pass rx_resp to osmo_pfcp_endpoint->rx_msg(), return 0 to mark rx_resp handled and not pass it to - * rx_msg() (to save lookup iterations). Return negative on error, rx_resp is dropped. - * Find in req the original osmo_pfcp_msg instance; in req->ctx.priv, arbitrary user data may be passed. - * For example: - * - * static int on_foo_resp(struct osmo_pfcp_msg *req, struct osmo_pfcp_msg *rx_resp, const char *errmsg) - * { - * struct something *obj = req->ctx.priv; - * if (!rx_resp) { - * handle_error(); - * return 0; - * } - * handle_response(obj, rx_resp); - * return 0; - * } - * - * int do_request(struct something *obj) - * { - * struct osmo_pfcp_msg *req; - * req = osmo_pfcp_msg_alloc_tx(pfcp_ep, &upf_addr, &pfcp_ep->cfg.local_node_id, NULL, OSMO_PFCP_MSGT_FOO); - * req->h.seid_present = true; - * req->h.seid = remote_seid; - * req->ies.foo... = ...; - * req->ctx.on_resp = on_foo_resp; - * req->ctx.priv = obj; - * return osmo_pfcp_endpoint_tx(pfcp_ep, req); - * } - */ -typedef int (*osmo_pfcp_resp_cb)(struct osmo_pfcp_msg *req, struct osmo_pfcp_msg *rx_resp, const char *errmsg); - -struct osmo_pfcp_msg { - /* Peer's remote address. Received from this peer, or should be sent to this peer. */ - struct osmo_sockaddr remote_addr; - /* True when this message was received from a remote; false when this message is going to be sent. */ - bool rx; - /* True when this message is a Response message type; false if Request. This is set by - * osmo_pfcp_msg_decode() for received messages, and by osmo_pfcp_msg_alloc_tx */ - bool is_response; - - struct osmo_pfcp_header_parsed h; - - int ofs_cause; - int ofs_node_id; - - /* The union of decoded IEs from all supported PFCP message types. The union and its structure is defined in - * pfcp_ies_auto.h, which is generated by gen__pfcp_ies_auto.c. - */ - union osmo_pfcp_ies ies; - - /* Context information about this message, used for logging */ - struct { - /* Peer FSM instance that this message is received from / sent to. This can be set in the - * osmo_pfcp_endpoint->set_msg_ctx() implementation, up to the caller. If present, this is used for - * logging context, and can also be used by the caller to reduce lookup iterations. */ - struct osmo_fsm_inst *peer_fi; - struct osmo_use_count *peer_use_count; - const char *peer_use_token; - - /* Session FSM instance that this message is received from / sent to. This can be set in the - * osmo_pfcp_endpoint->set_msg_ctx() implementation, up to the caller. If present, this is used for - * logging context, and can also be used by the caller to reduce lookup iterations. */ - struct osmo_fsm_inst *session_fi; - struct osmo_use_count *session_use_count; - const char *session_use_token; - - osmo_pfcp_resp_cb resp_cb; - void *priv; - } ctx; - - /* When a message gets encoded, the encoded packet is cached here for possible retransmissions. */ - struct msgb *encoded; -}; - -/* Given a &osmo_pfcp_msg->ies pointer, return the &osmo_pfcp_msg. - * In the TLV API, only the 'ies' union is passed around as argument. This macro is useful in error callbacks to obtain - * the related osmo_pfcp_msg and thus the logging context pointers (ctx.peer_fi and ctx.session_fi). */ -#define OSMO_PFCP_MSG_FOR_IES(IES_P) ((struct osmo_pfcp_msg *)((char *)IES_P - offsetof(struct osmo_pfcp_msg, ies))) - -bool osmo_pfcp_msgtype_is_response(enum osmo_pfcp_message_type message_type); - -int osmo_pfcp_ie_f_teid_to_str_buf(char *buf, size_t len, const struct osmo_pfcp_ie_f_teid *ft); -char *osmo_pfcp_ie_f_teid_to_str_c(void *ctx, const struct osmo_pfcp_ie_f_teid *ft); - -int osmo_pfcp_msg_encode(struct msgb *msg, const struct osmo_pfcp_msg *pfcp_msg); - -int osmo_pfcp_msg_decode_header(struct osmo_gtlv_load *tlv, struct osmo_pfcp_msg *m, - const struct msgb *msg); -int osmo_pfcp_msg_decode_tlv(struct osmo_pfcp_msg *m, struct osmo_gtlv_load *tlv); - -struct osmo_pfcp_msg *osmo_pfcp_msg_alloc_rx(void *ctx, const struct osmo_sockaddr *remote_addr); -struct osmo_pfcp_msg *osmo_pfcp_msg_alloc_tx(void *ctx, const struct osmo_sockaddr *remote_addr, - const struct osmo_pfcp_ie_node_id *local_node_id, - const struct osmo_pfcp_msg *in_reply_to, - enum osmo_pfcp_message_type msg_type); - -void osmo_pfcp_msg_invalidate_ctx(struct osmo_pfcp_msg *m, struct osmo_fsm_inst *deleted_fi); - -void osmo_pfcp_msg_free(struct osmo_pfcp_msg *m); - -uint32_t osmo_pfcp_next_seq_nr(uint32_t *next_seq_nr_state); -uint64_t osmo_pfcp_next_seid(uint64_t *next_seid_state); - -int osmo_pfcp_ie_node_id_from_osmo_sockaddr(struct osmo_pfcp_ie_node_id *node_id, const struct osmo_sockaddr *os); -int osmo_pfcp_ie_node_id_to_osmo_sockaddr(const struct osmo_pfcp_ie_node_id *node_id, struct osmo_sockaddr *os); - -#define OSMO_PFCP_MSG_MEMB(M, OFS) ((OFS) <= 0 ? NULL : (void *)((uint8_t *)(M) + OFS)) - -static inline enum osmo_pfcp_cause *osmo_pfcp_msg_cause(const struct osmo_pfcp_msg *m) -{ - return OSMO_PFCP_MSG_MEMB(m, m->ofs_cause); -} - -static inline struct osmo_pfcp_ie_node_id *osmo_pfcp_msg_node_id(const struct osmo_pfcp_msg *m) -{ - return OSMO_PFCP_MSG_MEMB(m, m->ofs_node_id); -} - -int osmo_pfcp_msg_to_str_buf(char *buf, size_t buflen, const struct osmo_pfcp_msg *m); -char *osmo_pfcp_msg_to_str_c(void *ctx, const struct osmo_pfcp_msg *m); diff --git a/include/osmocom/pfcp/pfcp_proto.h b/include/osmocom/pfcp/pfcp_proto.h deleted file mode 100644 index d387b1b..0000000 --- a/include/osmocom/pfcp/pfcp_proto.h +++ /dev/null @@ -1,528 +0,0 @@ -/* 3GPP TS 29.244: Packet Forwarding Control Protocol */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#define OSMO_PFCP_PORT 8805 - -/* Section 7.3 / Table 7.3-1 */ -enum osmo_pfcp_message_type { - OSMO_PFCP_MSGT_NONE = 0, - - /* Node related messages */ - OSMO_PFCP_MSGT_HEARTBEAT_REQ = 1, - OSMO_PFCP_MSGT_HEARTBEAT_RESP = 2, - OSMO_PFCP_MSGT_PFD_MGMT_REQ = 3, - OSMO_PFCP_MSGT_PFD_MGMT_RESP = 4, - OSMO_PFCP_MSGT_ASSOC_SETUP_REQ = 5, - OSMO_PFCP_MSGT_ASSOC_SETUP_RESP = 6, - OSMO_PFCP_MSGT_ASSOC_UPDATE_REQ = 7, - OSMO_PFCP_MSGT_ASSOC_UPDATE_RESP = 8, - OSMO_PFCP_MSGT_ASSOC_RELEASE_REQ = 9, - OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP = 10, - OSMO_PFCP_MSGT_VERSION_NOT_SUPP_RESP = 11, - OSMO_PFCP_MSGT_NODE_REPORT_REQ = 12, - OSMO_PFCP_MSGT_NODE_REPORT_RESP = 13, - OSMO_PFCP_MSGT_SESSION_SET_DEL_REQ = 14, - OSMO_PFCP_MSGT_SESSION_SET_DEL_RESP = 15, - - /* Session related messages */ - OSMO_PFCP_MSGT_SESSION_EST_REQ = 50, - OSMO_PFCP_MSGT_SESSION_EST_RESP = 51, - OSMO_PFCP_MSGT_SESSION_MOD_REQ = 52, - OSMO_PFCP_MSGT_SESSION_MOD_RESP = 53, - OSMO_PFCP_MSGT_SESSION_DEL_REQ = 54, - OSMO_PFCP_MSGT_SESSION_DEL_RESP = 55, - OSMO_PFCP_MSGT_SESSION_REP_REQ = 56, - OSMO_PFCP_MSGT_SESSION_REP_RESP = 57, -}; - -/* Section 8.1.2 / Table 8.1.2-1 */ -enum osmo_pfcp_iei { - OSMO_PFCP_INVALID_IEI = 0, - OSMO_PFCP_IEI_CREATE_PDR = 1, - OSMO_PFCP_IEI_PDI = 2, - OSMO_PFCP_IEI_CREATE_FAR = 3, - OSMO_PFCP_IEI_FORW_PARAMS = 4, - OSMO_PFCP_IEI_DUPL_PARAMS = 5, - OSMO_PFCP_IEI_CREATE_URR = 6, - OSMO_PFCP_IEI_CREATE_QER = 7, - OSMO_PFCP_IEI_CREATED_PDR = 8, - OSMO_PFCP_IEI_UPD_PDR = 9, - OSMO_PFCP_IEI_UPD_FAR = 10, - OSMO_PFCP_IEI_UPD_FORW_PARAMS = 11, - OSMO_PFCP_IEI_UPD_BAR_SESS_REP_RESP = 12, - OSMO_PFCP_IEI_UPD_URR = 13, - OSMO_PFCP_IEI_UPD_QER = 14, - OSMO_PFCP_IEI_REMOVE_PDR = 15, - OSMO_PFCP_IEI_REMOVE_FAR = 16, - OSMO_PFCP_IEI_REMOVE_URR = 17, - OSMO_PFCP_IEI_REMOVE_QER = 18, - OSMO_PFCP_IEI_CAUSE = 19, - OSMO_PFCP_IEI_SOURCE_IFACE = 20, - OSMO_PFCP_IEI_F_TEID = 21, - OSMO_PFCP_IEI_NETWORK_INST = 22, - OSMO_PFCP_IEI_SDF_FILTER = 23, - OSMO_PFCP_IEI_APPLICATION_ID = 24, - OSMO_PFCP_IEI_GATE_STATUS = 25, - OSMO_PFCP_IEI_MBR = 26, - OSMO_PFCP_IEI_GBR = 27, - OSMO_PFCP_IEI_QER_CORRELATION_ID = 28, - OSMO_PFCP_IEI_PRECEDENCE = 29, - OSMO_PFCP_IEI_TRANSPORT_LEVEL_MARKING = 30, - OSMO_PFCP_IEI_VOLUME_THRESH = 31, - OSMO_PFCP_IEI_TIME_THRESH = 32, - OSMO_PFCP_IEI_MONITORING_TIME = 33, - OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_THRESH = 34, - OSMO_PFCP_IEI_SUBSEQUENT_TIME_THRESH = 35, - OSMO_PFCP_IEI_INACT_DETECTION_TIME = 36, - OSMO_PFCP_IEI_REPORTING_TRIGGERS = 37, - OSMO_PFCP_IEI_REDIRECT_INFO = 38, - OSMO_PFCP_IEI_REP_TYPE = 39, - OSMO_PFCP_IEI_OFFENDING_IE = 40, - OSMO_PFCP_IEI_FORW_POLICY = 41, - OSMO_PFCP_IEI_DESTINATION_IFACE = 42, - OSMO_PFCP_IEI_UP_FUNCTION_FEATURES = 43, - OSMO_PFCP_IEI_APPLY_ACTION = 44, - OSMO_PFCP_IEI_DL_DATA_SERVICE_INFO = 45, - OSMO_PFCP_IEI_DL_DATA_NOTIFICATION_DELAY = 46, - OSMO_PFCP_IEI_DL_BUFF_DURATION = 47, - OSMO_PFCP_IEI_DL_BUFF_SUGGESTED_PACKET_COUNT = 48, - OSMO_PFCP_IEI_PFCPSMREQ_FLAGS = 49, - OSMO_PFCP_IEI_PFCPSRRSP_FLAGS = 50, - OSMO_PFCP_IEI_LOAD_CTRL_INFO = 51, - OSMO_PFCP_IEI_SEQUENCE_NUMBER = 52, - OSMO_PFCP_IEI_METRIC = 53, - OSMO_PFCP_IEI_OVERLOAD_CTRL_INFO = 54, - OSMO_PFCP_IEI_TIMER = 55, - OSMO_PFCP_IEI_PDR_ID = 56, - OSMO_PFCP_IEI_F_SEID = 57, - OSMO_PFCP_IEI_APPLICATION_IDS_PFDS = 58, - OSMO_PFCP_IEI_PFD_CONTEXT = 59, - OSMO_PFCP_IEI_NODE_ID = 60, - OSMO_PFCP_IEI_PFD_CONTENTS = 61, - OSMO_PFCP_IEI_MEAS_METHOD = 62, - OSMO_PFCP_IEI_USAGE_REP_TRIGGER = 63, - OSMO_PFCP_IEI_MEAS_PERIOD = 64, - OSMO_PFCP_IEI_FQ_CSID = 65, - OSMO_PFCP_IEI_VOLUME_MEAS = 66, - OSMO_PFCP_IEI_DURATION_MEAS = 67, - OSMO_PFCP_IEI_APPLICATION_DETECTION_INFO = 68, - OSMO_PFCP_IEI_TIME_OF_FIRST_PACKET = 69, - OSMO_PFCP_IEI_TIME_OF_LAST_PACKET = 70, - OSMO_PFCP_IEI_QUOTA_HOLDING_TIME = 71, - OSMO_PFCP_IEI_DROPPED_DL_TRAFFIC_THRESH = 72, - OSMO_PFCP_IEI_VOLUME_QUOTA = 73, - OSMO_PFCP_IEI_TIME_QUOTA = 74, - OSMO_PFCP_IEI_START_TIME = 75, - OSMO_PFCP_IEI_END_TIME = 76, - OSMO_PFCP_IEI_QUERY_URR = 77, - OSMO_PFCP_IEI_USAGE_REP_SESS_MOD_RESP = 78, - OSMO_PFCP_IEI_USAGE_REP_SESS_DEL_RESP = 79, - OSMO_PFCP_IEI_USAGE_REP_SESS_REP_REQ = 80, - OSMO_PFCP_IEI_URR_ID = 81, - OSMO_PFCP_IEI_LINKED_URR_ID = 82, - OSMO_PFCP_IEI_DL_DATA_REP = 83, - OSMO_PFCP_IEI_OUTER_HEADER_CREATION = 84, - OSMO_PFCP_IEI_CREATE_BAR = 85, - OSMO_PFCP_IEI_UPD_BAR_SESS_MOD_REQ = 86, - OSMO_PFCP_IEI_REMOVE_BAR = 87, - OSMO_PFCP_IEI_BAR_ID = 88, - OSMO_PFCP_IEI_CP_FUNCTION_FEATURES = 89, - OSMO_PFCP_IEI_USAGE_INFO = 90, - OSMO_PFCP_IEI_APPLICATION_INST_ID = 91, - OSMO_PFCP_IEI_FLOW_INFO = 92, - OSMO_PFCP_IEI_UE_IP_ADDRESS = 93, - OSMO_PFCP_IEI_PACKET_RATE = 94, - OSMO_PFCP_IEI_OUTER_HEADER_REMOVAL = 95, - OSMO_PFCP_IEI_RECOVERY_TIME_STAMP = 96, - OSMO_PFCP_IEI_DL_FLOW_LEVEL_MARKING = 97, - OSMO_PFCP_IEI_HEADER_ENRICHMENT = 98, - OSMO_PFCP_IEI_ERROR_IND_REP = 99, - OSMO_PFCP_IEI_MEAS_INFO = 100, - OSMO_PFCP_IEI_NODE_REP_TYPE = 101, - OSMO_PFCP_IEI_USER_PLANE_PATH_FAILURE_REP = 102, - OSMO_PFCP_IEI_REMOTE_GTP_U_PEER = 103, - OSMO_PFCP_IEI_UR_SEQN = 104, - OSMO_PFCP_IEI_UPD_DUPL_PARAMS = 105, - OSMO_PFCP_IEI_ACTIVATE_PREDEFINED_RULES = 106, - OSMO_PFCP_IEI_DEACTIVATE_PREDEFINED_RULES = 107, - OSMO_PFCP_IEI_FAR_ID = 108, - OSMO_PFCP_IEI_QER_ID = 109, - OSMO_PFCP_IEI_OCI_FLAGS = 110, - OSMO_PFCP_IEI_PFCP_ASSOC_RELEASE_REQ = 111, - OSMO_PFCP_IEI_GRACEFUL_RELEASE_PERIOD = 112, - OSMO_PFCP_IEI_PDN_TYPE = 113, - OSMO_PFCP_IEI_FAILED_RULE_ID = 114, - OSMO_PFCP_IEI_TIME_QUOTA_MECHANISM = 115, - OSMO_PFCP_IEI_RESERVED = 116, - OSMO_PFCP_IEI_USER_PLANE_INACT_TIMER = 117, - OSMO_PFCP_IEI_AGGREGATED_URRS = 118, - OSMO_PFCP_IEI_MULTIPLIER = 119, - OSMO_PFCP_IEI_AGGREGATED_URR_ID = 120, - OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_QUOTA = 121, - OSMO_PFCP_IEI_SUBSEQUENT_TIME_QUOTA = 122, - OSMO_PFCP_IEI_RQI = 123, - OSMO_PFCP_IEI_QFI = 124, - OSMO_PFCP_IEI_QUERY_URR_REFERENCE = 125, - OSMO_PFCP_IEI_ADDITIONAL_USAGE_REPS_INFO = 126, - OSMO_PFCP_IEI_CREATE_TRAFFIC_ENDPOINT = 127, - OSMO_PFCP_IEI_CREATED_TRAFFIC_ENDPOINT = 128, - OSMO_PFCP_IEI_UPD_TRAFFIC_ENDPOINT = 129, - OSMO_PFCP_IEI_REMOVE_TRAFFIC_ENDPOINT = 130, - OSMO_PFCP_IEI_TRAFFIC_ENDPOINT_ID = 131, - OSMO_PFCP_IEI_ETHERNET_PACKET_FILTER = 132, - OSMO_PFCP_IEI_MAC_ADDRESS = 133, - OSMO_PFCP_IEI_C_TAG = 134, - OSMO_PFCP_IEI_S_TAG = 135, - OSMO_PFCP_IEI_ETHERTYPE = 136, - OSMO_PFCP_IEI_PROXYING = 137, - OSMO_PFCP_IEI_ETHERNET_FILTER_ID = 138, - OSMO_PFCP_IEI_ETHERNET_FILTER_PROPERTIES = 139, - OSMO_PFCP_IEI_SUGGESTED_BUFF_PACKETS_COUNT = 140, - OSMO_PFCP_IEI_USER_ID = 141, - OSMO_PFCP_IEI_ETHERNET_PDU_SESS_INFO = 142, - OSMO_PFCP_IEI_ETHERNET_TRAFFIC_INFO = 143, - OSMO_PFCP_IEI_MAC_ADDRS_DETECTED = 144, - OSMO_PFCP_IEI_MAC_ADDRS_REMOVED = 145, - OSMO_PFCP_IEI_ETHERNET_INACT_TIMER = 146, - OSMO_PFCP_IEI_ADDITIONAL_MONITORING_TIME = 147, - OSMO_PFCP_IEI_EVENT_QUOTA = 148, - OSMO_PFCP_IEI_EVENT_THRESH = 149, - OSMO_PFCP_IEI_SUBSEQUENT_EVENT_QUOTA = 150, - OSMO_PFCP_IEI_SUBSEQUENT_EVENT_THRESH = 151, - OSMO_PFCP_IEI_TRACE_INFO = 152, - OSMO_PFCP_IEI_FRAMED_ROUTE = 153, - OSMO_PFCP_IEI_FRAMED_ROUTING = 154, - OSMO_PFCP_IEI_FRAMED_IPV6_ROUTE = 155, - OSMO_PFCP_IEI_TIME_STAMP = 156, - OSMO_PFCP_IEI_AVERAGING_WINDOW = 157, - OSMO_PFCP_IEI_PAGING_POLICY_INDICATOR = 158, - OSMO_PFCP_IEI_APN_DNN = 159, - OSMO_PFCP_IEI_3GPP_IFACE_TYPE = 160, - OSMO_PFCP_IEI_PFCPSRREQ_FLAGS = 161, - OSMO_PFCP_IEI_PFCPAUREQ_FLAGS = 162, - OSMO_PFCP_IEI_ACTIVATION_TIME = 163, - OSMO_PFCP_IEI_DEACTIVATION_TIME = 164, - OSMO_PFCP_IEI_CREATE_MAR = 165, - OSMO_PFCP_IEI_3GPP_ACCESS_FORW_ACTION_INFO = 166, - OSMO_PFCP_IEI_NON_3GPP_ACCESS_FORW_ACTION_INFO = 167, - OSMO_PFCP_IEI_REMOVE_MAR = 168, - OSMO_PFCP_IEI_UPD_MAR = 169, - OSMO_PFCP_IEI_MAR_ID = 170, - OSMO_PFCP_IEI_STEERING_FUNCTIONALITY = 171, - OSMO_PFCP_IEI_STEERING_MODE = 172, - OSMO_PFCP_IEI_WEIGHT = 173, - OSMO_PFCP_IEI_PRIORITY = 174, - OSMO_PFCP_IEI_UPD_3GPP_ACCESS_FORW_ACTION_INFO = 175, - OSMO_PFCP_IEI_UPD_NON_3GPP_ACCESS_FORW_ACTION_INFO = 176, - OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_IDENTITY = 177, - OSMO_PFCP_IEI_ALTERNATIVE_SMF_IP_ADDRESS = 178, - OSMO_PFCP_IEI_PACKET_REPLICATION_AND_DETECTION_CARRY_ON_INFO = 179, - OSMO_PFCP_IEI_SMF_SET_ID = 180, - OSMO_PFCP_IEI_QUOTA_VALIDITY_TIME = 181, - OSMO_PFCP_IEI_NUMBER_OF_REPS = 182, - OSMO_PFCP_IEI_PFCP_SESS_RETENTION_INFO_IN_ASSOC_SETUP_REQ = 183, - OSMO_PFCP_IEI_PFCPASRSP_FLAGS = 184, - OSMO_PFCP_IEI_CP_ENTITY_IP_ADDRESS = 185, - OSMO_PFCP_IEI_PFCPSEREQ_FLAGS = 186, - OSMO_PFCP_IEI_USER_PLANE_PATH_RECOVERY_REP = 187, - OSMO_PFCP_IEI_IP_MULTICAST_ADDR_INFO_IN_SESS_EST_REQ = 188, - OSMO_PFCP_IEI_JOIN_IP_MULTICAST_INFO_IE_IN_USAGE_REP = 189, - OSMO_PFCP_IEI_LEAVE_IP_MULTICAST_INFO_IE_IN_USAGE_REP = 190, - OSMO_PFCP_IEI_IP_MULTICAST_ADDRESS = 191, - OSMO_PFCP_IEI_SOURCE_IP_ADDRESS = 192, - OSMO_PFCP_IEI_PACKET_RATE_STATUS = 193, - OSMO_PFCP_IEI_CREATE_BRIDGE_INFO_FOR_TSC = 194, - OSMO_PFCP_IEI_CREATED_BRIDGE_INFO_FOR_TSC = 195, - OSMO_PFCP_IEI_DS_TT_PORT_NUMBER = 196, - OSMO_PFCP_IEI_NW_TT_PORT_NUMBER = 197, - OSMO_PFCP_IEI_TSN_BRIDGE_ID = 198, - OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_REQ = 199, - OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_RESP = 200, - OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_REP_REQ = 201, - OSMO_PFCP_IEI_PORT_MGMT_INFO_CONTAINER = 202, - OSMO_PFCP_IEI_CLOCK_DRIFT_CTRL_INFO = 203, - OSMO_PFCP_IEI_REQUESTED_CLOCK_DRIFT_INFO = 204, - OSMO_PFCP_IEI_CLOCK_DRIFT_REP = 205, - OSMO_PFCP_IEI_TSN_TIME_DOMAIN_NUMBER = 206, - OSMO_PFCP_IEI_TIME_OFFSET_THRESH = 207, - OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_THRESH = 208, - OSMO_PFCP_IEI_TIME_OFFSET_MEAS = 209, - OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_MEAS = 210, - OSMO_PFCP_IEI_REMOVE_SRR = 211, - OSMO_PFCP_IEI_CREATE_SRR = 212, - OSMO_PFCP_IEI_UPD_SRR = 213, - OSMO_PFCP_IEI_SESS_REP = 214, - OSMO_PFCP_IEI_SRR_ID = 215, - OSMO_PFCP_IEI_ACCESS_AVAIL_CTRL_INFO = 216, - OSMO_PFCP_IEI_REQUESTED_ACCESS_AVAIL_INFO = 217, - OSMO_PFCP_IEI_ACCESS_AVAIL_REP = 218, - OSMO_PFCP_IEI_ACCESS_AVAIL_INFO = 219, - OSMO_PFCP_IEI_PROVIDE_ATSSS_CTRL_INFO = 220, - OSMO_PFCP_IEI_ATSSS_CTRL_PARAMS = 221, - OSMO_PFCP_IEI_MPTCP_CTRL_INFO = 222, - OSMO_PFCP_IEI_ATSSS_LL_CTRL_INFO = 223, - OSMO_PFCP_IEI_PMF_CTRL_INFO = 224, - OSMO_PFCP_IEI_MPTCP_PARAMS = 225, - OSMO_PFCP_IEI_ATSSS_LL_PARAMS = 226, - OSMO_PFCP_IEI_PMF_PARAMS = 227, - OSMO_PFCP_IEI_MPTCP_ADDRESS_INFO = 228, - OSMO_PFCP_IEI_UE_LINK_SPECIFIC_IP_ADDRESS = 229, - OSMO_PFCP_IEI_PMF_ADDRESS_INFO = 230, - OSMO_PFCP_IEI_ATSSS_LL_INFO = 231, - OSMO_PFCP_IEI_DATA_NETWORK_ACCESS_IDENTIFIER = 232, - OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_INFO = 233, - OSMO_PFCP_IEI_AVERAGE_PACKET_DELAY = 234, - OSMO_PFCP_IEI_MIN_PACKET_DELAY = 235, - OSMO_PFCP_IEI_MAX_PACKET_DELAY = 236, - OSMO_PFCP_IEI_QOS_REP_TRIGGER = 237, - OSMO_PFCP_IEI_GTP_U_PATH_QOS_CTRL_INFO = 238, - OSMO_PFCP_IEI_GTP_U_PATH_QOS_REP_NODE_REP_REQ = 239, - OSMO_PFCP_IEI_QOS_INFO_IN_GTP_U_PATH_QOS_REP = 240, - OSMO_PFCP_IEI_GTP_U_PATH_IFACE_TYPE = 241, - OSMO_PFCP_IEI_QOS_MONITORING_PER_QOS_FLOW_CTRL_INFO = 242, - OSMO_PFCP_IEI_REQUESTED_QOS_MONITORING = 243, - OSMO_PFCP_IEI_REPORTING_FREQUENCY = 244, - OSMO_PFCP_IEI_PACKET_DELAY_THRESHOLDS = 245, - OSMO_PFCP_IEI_MIN_WAIT_TIME = 246, - OSMO_PFCP_IEI_QOS_MONITORING_REP = 247, - OSMO_PFCP_IEI_QOS_MONITORING_MEAS = 248, - OSMO_PFCP_IEI_MT_EDT_CTRL_INFO = 249, - OSMO_PFCP_IEI_DL_DATA_PACKETS_SIZE = 250, - OSMO_PFCP_IEI_QER_CTRL_INDICATIONS = 251, - OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP = 252, - OSMO_PFCP_IEI_NF_INST_ID = 253, - OSMO_PFCP_IEI_ETHERNET_CONTEXT_INFO = 254, - OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_PARAMS = 255, - OSMO_PFCP_IEI_UPDATED_PDR = 256, - OSMO_PFCP_IEI_S_NSSAI = 257, - OSMO_PFCP_IEI_IP_VERSION = 258, - OSMO_PFCP_IEI_PFCPASREQ_FLAGS = 259, - OSMO_PFCP_IEI_DATA_STATUS = 260, - OSMO_PFCP_IEI_PROVIDE_RDS_CONF_INFO = 261, - OSMO_PFCP_IEI_RDS_CONF_INFO = 262, - OSMO_PFCP_IEI_QUERY_PACKET_RATE_STATUS_IE_IN_SESS_MOD_REQ = 263, - OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP_IE_IN_SESS_MOD_RESP = 264, - OSMO_PFCP_IEI_MPTCP_APPLICABLE_IND = 265, - OSMO_PFCP_IEI_BRIDGE_MGMT_INFO_CONTAINER = 266, - OSMO_PFCP_IEI_UE_IP_ADDRESS_USAGE_INFO = 267, - OSMO_PFCP_IEI_NUMBER_OF_UE_IP_ADDRS = 268, - OSMO_PFCP_IEI_VALIDITY_TIMER = 269, - OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_FORW_PARAMS = 270, - OSMO_PFCP_IEI_TRANSPORT_DELAY_REPORTING = 271, -}; - -/* Section 8.2.1 / Table 8.2.1-1 */ -enum osmo_pfcp_cause { - OSMO_PFCP_CAUSE_RESERVED = 0, - OSMO_PFCP_CAUSE_REQUEST_ACCEPTED = 1, - OSMO_PFCP_CAUSE_MORE_USAGE_REPORT_TO_SEND = 2, - OSMO_PFCP_CAUSE_REQUEST_REJECTED = 64, - OSMO_PFCP_CAUSE_SESSION_CTX_NOT_FOUND = 65, - OSMO_PFCP_CAUSE_MANDATORY_IE_MISSING = 66, - OSMO_PFCP_CAUSE_CONDITIONAL_IE_MISSING = 67, - OSMO_PFCP_CAUSE_INVALID_LENGTH = 68, - OSMO_PFCP_CAUSE_MANDATORY_IE_INCORRECT = 69, - OSMO_PFCP_CAUSE_INVALID_FORW_POLICY = 70, - OSMO_PFCP_CAUSE_INVALID_F_TEID_ALLOC_OPTION = 71, - OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC = 72, - OSMO_PFCP_CAUSE_RULE_CREATION_MOD_FAILURE = 73, - OSMO_PFCP_CAUSE_PFCP_ENTITY_IN_CONGESTION = 74, - OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE = 75, - OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED = 76, - OSMO_PFCP_CAUSE_SYSTEM_FAILURE = 77, - OSMO_PFCP_CAUSE_REDIRECTION_REQUESTED = 78, - OSMO_PFCP_CAUSE_ALL_DYNAMIC_ADDRESSES_ARE_OCCUPIED = 79, -}; - -/* Section 8.2.38 */ -enum osmo_pfcp_node_id_type { - OSMO_PFCP_NODE_ID_T_IPV4 = 0, - OSMO_PFCP_NODE_ID_T_IPV6 = 1, - OSMO_PFCP_NODE_ID_T_FQDN = 2, -}; - -enum osmo_pfcp_3gpp_iface_type { - OSMO_PFCP_3GPP_IFACE_TYPE_S1_U = 0, - OSMO_PFCP_3GPP_IFACE_TYPE_S5_S8_U = 1, - OSMO_PFCP_3GPP_IFACE_TYPE_S4_U = 2, - OSMO_PFCP_3GPP_IFACE_TYPE_S11_U = 3, - OSMO_PFCP_3GPP_IFACE_TYPE_S12_U = 4, - OSMO_PFCP_3GPP_IFACE_TYPE_GN_GP_U = 5, - OSMO_PFCP_3GPP_IFACE_TYPE_S2A_U = 6, - OSMO_PFCP_3GPP_IFACE_TYPE_S2B_U = 7, - OSMO_PFCP_3GPP_IFACE_TYPE_ENODEB_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING = 8, - OSMO_PFCP_3GPP_IFACE_TYPE_ENODEB_GTP_U_INTERFACE_FOR_UL_DATA_FORWARDING = 9, - OSMO_PFCP_3GPP_IFACE_TYPE_SGW_UPF_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING = 10, - OSMO_PFCP_3GPP_IFACE_TYPE_N3_3GPP_ACCESS = 11, - OSMO_PFCP_3GPP_IFACE_TYPE_N3_TRUSTED_NON_3GPP_ACCESS = 12, - OSMO_PFCP_3GPP_IFACE_TYPE_N3_UNTRUSTED_NON_3GPP_ACCESS = 13, - OSMO_PFCP_3GPP_IFACE_TYPE_N3_FOR_DATA_FORWARDING = 14, - OSMO_PFCP_3GPP_IFACE_TYPE_N9 = 15, - OSMO_PFCP_3GPP_IFACE_TYPE_SGI = 16, - OSMO_PFCP_3GPP_IFACE_TYPE_N6 = 17, - OSMO_PFCP_3GPP_IFACE_TYPE_N19 = 18, - OSMO_PFCP_3GPP_IFACE_TYPE_S8_U = 19, - OSMO_PFCP_3GPP_IFACE_TYPE_GP_U = 20, -}; - -enum osmo_pfcp_source_iface { - OSMO_PFCP_SOURCE_IFACE_ACCESS = 0, - OSMO_PFCP_SOURCE_IFACE_CORE = 1, - OSMO_PFCP_SOURCE_IFACE_SGI_LAN_N6_LAN = 2, - OSMO_PFCP_SOURCE_IFACE_CP_FUNCTION = 3, - OSMO_PFCP_SOURCE_IFACE_5G_VN_INTERNAL = 4, -}; - -enum osmo_pfcp_dest_iface { - OSMO_PFCP_DEST_IFACE_ACCESS = 0, - OSMO_PFCP_DEST_IFACE_CORE = 1, - OSMO_PFCP_DEST_IFACE_SGI_LAN_N6_LAN = 2, - OSMO_PFCP_DEST_IFACE_CP_FUNCTION = 3, - OSMO_PFCP_DEST_IFACE_LI_FUNCTION = 4, - OSMO_PFCP_DEST_IFACE_5G_VN_INTERNAL = 5, -}; - -/* The enum values correspond to the bit index in the supported features bitmask in the PFCP UP Function Features IE. - * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; - * 7 means first octet last bit, "Octet 5 Bit 8"; - * 8 means second octet first bit, "Octet 6 Bit 1"; - * and so on. - * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). - */ -enum osmo_pfcp_up_feature { - OSMO_PFCP_UP_FEAT_BUCP = 0, - OSMO_PFCP_UP_FEAT_DDND, - OSMO_PFCP_UP_FEAT_DLBD, - OSMO_PFCP_UP_FEAT_TRST, - OSMO_PFCP_UP_FEAT_FTUP, - OSMO_PFCP_UP_FEAT_PFDM, - OSMO_PFCP_UP_FEAT_HEEU, - OSMO_PFCP_UP_FEAT_TREU, - OSMO_PFCP_UP_FEAT_EMPU, - OSMO_PFCP_UP_FEAT_PDIU, - OSMO_PFCP_UP_FEAT_UDBC, - OSMO_PFCP_UP_FEAT_QUOAC, - OSMO_PFCP_UP_FEAT_TRACE, - OSMO_PFCP_UP_FEAT_FRRT, - OSMO_PFCP_UP_FEAT_PFDE, - OSMO_PFCP_UP_FEAT_EPFAR, - OSMO_PFCP_UP_FEAT_DPDRA, - OSMO_PFCP_UP_FEAT_ADPDP, - OSMO_PFCP_UP_FEAT_UEIP, - OSMO_PFCP_UP_FEAT_SSET, - OSMO_PFCP_UP_FEAT_MNOP, - OSMO_PFCP_UP_FEAT_MTE, - OSMO_PFCP_UP_FEAT_BUNDL, - OSMO_PFCP_UP_FEAT_GCOM, - OSMO_PFCP_UP_FEAT_MPAS, - OSMO_PFCP_UP_FEAT_RTTL, - OSMO_PFCP_UP_FEAT_VTIME, - OSMO_PFCP_UP_FEAT_NORP, - OSMO_PFCP_UP_FEAT_IP6PL, - OSMO_PFCP_UP_FEAT_TSCU, - OSMO_PFCP_UP_FEAT_MPTCP, - OSMO_PFCP_UP_FEAT_ATSSSLL, - OSMO_PFCP_UP_FEAT_QFQM, - OSMO_PFCP_UP_FEAT_GPQM, - OSMO_PFCP_UP_FEAT_MTEDT, - OSMO_PFCP_UP_FEAT_CIOT, - OSMO_PFCP_UP_FEAT_ETHAR, - OSMO_PFCP_UP_FEAT_DDDS, - OSMO_PFCP_UP_FEAT_RDS, - OSMO_PFCP_UP_FEAT_RTTWP, -}; - -/* The enum values correspond to the bit index in the supported features bitmask in the PFCP CP Function Features IE. - * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; - * 7 means first octet last bit, "Octet 5 Bit 8"; - * 8 means second octet first bit, "Octet 6 Bit 1"; - * and so on. - * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). - */ -enum osmo_pfcp_cp_feature { - OSMO_PFCP_CP_FEAT_LOAD = 0, - OSMO_PFCP_CP_FEAT_OVRL, - OSMO_PFCP_CP_FEAT_EPFAR, - OSMO_PFCP_CP_FEAT_SSET, - OSMO_PFCP_CP_FEAT_BUNDL, - OSMO_PFCP_CP_FEAT_MPAS, - OSMO_PFCP_CP_FEAT_ARDR, - OSMO_PFCP_CP_FEAT_UIAUR, -}; - -/* The enum values correspond to the bit index in the PFCP Apply Action IE. - * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; - * 7 means first octet last bit, "Octet 5 Bit 8"; - * 8 means second octet first bit, "Octet 6 Bit 1"; - * and so on. - * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). - */ -enum osmo_pfcp_apply_action { - OSMO_PFCP_APPLY_ACTION_DROP = 0, - OSMO_PFCP_APPLY_ACTION_FORW, - OSMO_PFCP_APPLY_ACTION_BUFF, - OSMO_PFCP_APPLY_ACTION_NOCP, - OSMO_PFCP_APPLY_ACTION_DUPL, - OSMO_PFCP_APPLY_ACTION_IPMA, - OSMO_PFCP_APPLY_ACTION_IPMD, - OSMO_PFCP_APPLY_ACTION_DFRT, - OSMO_PFCP_APPLY_ACTION_EDRT, - OSMO_PFCP_APPLY_ACTION_BDPN, - OSMO_PFCP_APPLY_ACTION_DDPN, -}; - -/* The enum values correspond to the bit index in the description bitmask in the PFCP Outer Header Creation IE. - * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; - * 7 means first octet last bit, "Octet 5 Bit 8"; - * 8 means second octet first bit, "Octet 6 Bit 1"; - * and so on. - * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). - */ -enum osmo_pfcp_outer_header_creation { - OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4 = 0, - OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6, - OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4, - OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6, - OSMO_PFCP_OUTER_HEADER_CREATION_IPV4, - OSMO_PFCP_OUTER_HEADER_CREATION_IPV6, - OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG, - OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG, - OSMO_PFCP_OUTER_HEADER_CREATION_N19_INDICATION, - OSMO_PFCP_OUTER_HEADER_CREATION_N6_INDICATION, -}; - -/* 3GPP TS 29.244 8.2.64 */ -enum osmo_pfcp_outer_header_removal_desc { - OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4 = 0, - OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV6 = 1, - OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV4 = 2, - OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV6 = 3, - OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV4 = 4, - OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV6 = 5, - OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IP = 6, - OSMO_PFCP_OUTER_HEADER_REMOVAL_VLAN_S_TAG = 7, - OSMO_PFCP_OUTER_HEADER_REMOVAL_S_TAG_AND_C_TAG = 8, -}; diff --git a/include/osmocom/pfcp/pfcp_strs.h b/include/osmocom/pfcp/pfcp_strs.h deleted file mode 100644 index d0b106a..0000000 --- a/include/osmocom/pfcp/pfcp_strs.h +++ /dev/null @@ -1,94 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#pragma once - -#include <osmocom/core/utils.h> - -#include <osmocom/pfcp/pfcp_proto.h> - -extern const struct value_string osmo_pfcp_message_type_strs[]; -static inline const char *osmo_pfcp_message_type_str(enum osmo_pfcp_message_type val) -{ - return get_value_string(osmo_pfcp_message_type_strs, val); -} - -extern const struct value_string osmo_pfcp_iei_strs[]; -static inline const char *osmo_pfcp_iei_str(enum osmo_pfcp_iei val) -{ - return get_value_string(osmo_pfcp_iei_strs, val); -} - -extern const struct value_string osmo_pfcp_cause_strs[]; -static inline const char *osmo_pfcp_cause_str(enum osmo_pfcp_cause val) -{ - return get_value_string(osmo_pfcp_cause_strs, val); -} - -extern const struct value_string osmo_pfcp_up_feature_strs[]; -static inline const char *osmo_pfcp_up_feature_str(enum osmo_pfcp_up_feature val) -{ - return get_value_string(osmo_pfcp_up_feature_strs, val); -} - -extern const struct value_string osmo_pfcp_cp_feature_strs[]; -static inline const char *osmo_pfcp_cp_feature_str(enum osmo_pfcp_cp_feature val) -{ - return get_value_string(osmo_pfcp_cp_feature_strs, val); -} - -extern const struct value_string osmo_pfcp_apply_action_strs[]; -static inline const char *osmo_pfcp_apply_action_str(enum osmo_pfcp_apply_action val) -{ - return get_value_string(osmo_pfcp_apply_action_strs, val); -} - -extern const struct value_string osmo_pfcp_outer_header_creation_strs[]; -static inline const char *osmo_pfcp_outer_header_creation_str(enum osmo_pfcp_outer_header_creation val) -{ - return get_value_string(osmo_pfcp_outer_header_creation_strs, val); -} - -extern const struct value_string osmo_pfcp_outer_header_removal_desc_strs[]; -static inline const char *osmo_pfcp_outer_header_removal_desc_str(enum osmo_pfcp_outer_header_removal_desc val) -{ - return get_value_string(osmo_pfcp_outer_header_removal_desc_strs, val); -} - -extern const struct value_string osmo_pfcp_source_iface_strs[]; -static inline const char *osmo_pfcp_source_iface_str(enum osmo_pfcp_source_iface val) -{ - return get_value_string(osmo_pfcp_source_iface_strs, val); -} - -extern const struct value_string osmo_pfcp_dest_iface_strs[]; -static inline const char *osmo_pfcp_dest_iface_str(enum osmo_pfcp_dest_iface val) -{ - return get_value_string(osmo_pfcp_dest_iface_strs, val); -} - -extern const struct value_string osmo_pfcp_3gpp_iface_type_strs[]; -static inline const char *osmo_pfcp_3gpp_iface_type_str(enum osmo_pfcp_3gpp_iface_type val) -{ - return get_value_string(osmo_pfcp_3gpp_iface_type_strs, val); -} diff --git a/src/Makefile.am b/src/Makefile.am index 78c8adb..a8ba763 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,4 +1,3 @@ SUBDIRS = \ - libosmo-pfcp \ osmo-upf \ $(NULL) diff --git a/src/libosmo-pfcp/Makefile.am b/src/libosmo-pfcp/Makefile.am deleted file mode 100644 index eb8c78f..0000000 --- a/src/libosmo-pfcp/Makefile.am +++ /dev/null @@ -1,55 +0,0 @@ -AM_CPPFLAGS = \ - $(all_includes) \ - -I$(top_srcdir)/include \ - -I$(top_builddir)/include \ - -I$(top_builddir) \ - -I$(builddir) \ - $(NULL) - -AM_CFLAGS = \ - -Wall \ - $(LIBOSMOCORE_CFLAGS) \ - $(LIBOSMOGTLV_CFLAGS) \ - $(LIBOSMOVTY_CFLAGS) \ - $(COVERAGE_CFLAGS) \ - $(NULL) - -AM_LDFLAGS = \ - $(LIBOSMOCORE_LIBS) \ - $(LIBOSMOGTLV_LIBS) \ - $(LIBOSMOVTY_LIBS) \ - $(COVERAGE_LDFLAGS) \ - $(NULL) - -noinst_LIBRARIES = \ - libosmo-pfcp.a \ - $(NULL) - -libosmo_pfcp_a_SOURCES = \ - pfcp_endpoint.c \ - pfcp_ies_custom.c \ - pfcp_msg.c \ - pfcp_strs.c \ - \ - pfcp_ies_auto.c \ - $(NULL) - -BUILT_SOURCES = \ - pfcp_ies_auto.c \ - $(NULL) - -CLEANFILES = \ - pfcp_ies_auto.c \ - $(NULL) - -pfcp_ies_auto.c: $(srcdir)/gen__pfcp_ies_auto.c - $(MAKE) gen__pfcp_ies_auto - $(builddir)/gen__pfcp_ies_auto c > $(builddir)/pfcp_ies_auto.c - -noinst_PROGRAMS = \ - gen__pfcp_ies_auto \ - $(NULL) - -gen__pfcp_ies_auto_SOURCES = \ - gen__pfcp_ies_auto.c \ - $(NULL) diff --git a/src/libosmo-pfcp/gen__pfcp_ies_auto.c b/src/libosmo-pfcp/gen__pfcp_ies_auto.c deleted file mode 100644 index 0dfb43c..0000000 --- a/src/libosmo-pfcp/gen__pfcp_ies_auto.c +++ /dev/null @@ -1,365 +0,0 @@ -/* Tool to generate C source code of structs and IE arrays for de- and encoding PFCP messages. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdbool.h> -#include <stdio.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/linuxlist.h> -#include <osmocom/core/talloc.h> -#include <osmocom/gtlv/gtlv_gen.h> - -#define O OSMO_GTLV_GEN_O -#define M OSMO_GTLV_GEN_M -#define O_MULTI OSMO_GTLV_GEN_O_MULTI -#define M_MULTI OSMO_GTLV_GEN_M_MULTI -#define ALL_FROM_NAME osmo_gtlv_gen_ie_auto - -#define Ms(MEMB_NAME) M(MEMB_NAME, #MEMB_NAME) -#define Os(MEMB_NAME) O(MEMB_NAME, #MEMB_NAME) -#define O_MULTIs(N, MEMB_NAME) O_MULTI(N, MEMB_NAME, #MEMB_NAME) -#define M_MULTIs(N, M, MEMB_NAME) M_MULTI(N, M, MEMB_NAME, #MEMB_NAME) - -static const struct osmo_gtlv_gen_ie recovery_time_stamp = { - "uint32_t", - .dec_enc = "32be", - .spec_ref = "7.4.2", -}; - -static const struct osmo_gtlv_gen_ie cause = { - "enum osmo_pfcp_cause", - .spec_ref = "8.2.1", -}; - -static const struct osmo_gtlv_gen_ie offending_ie = { - .decoded_type = "enum osmo_pfcp_iei", - .spec_ref = "8.2.22", -}; - -static const struct osmo_gtlv_gen_ie f_seid = { - .tag_name = "f_seid", - .spec_ref = "8.2.37", -}; - -static const struct osmo_gtlv_gen_ie pdr_id = { - .decoded_type = "uint16_t", - .dec_enc = "16be", - .spec_ref = "8.2.36", -}; - -static const struct osmo_gtlv_gen_ie precedence = { - .decoded_type = "uint32_t", - .dec_enc = "32be", - .spec_ref = "8.2.11", -}; - -static const struct osmo_gtlv_gen_ie source_iface = { - .decoded_type = "enum osmo_pfcp_source_iface", - .spec_ref = "8.2.2", -}; - -static const struct osmo_gtlv_gen_ie f_teid = { - .tag_name = "f_teid", - .spec_ref = "8.2.3", -}; - -static const struct osmo_gtlv_gen_ie traffic_endpoint_id = { - .tag_name = "traffic_endpoint_id", - .decoded_type = "uint8_t", - .dec_enc = "8", - .spec_ref = "8.2.92", -}; - -static const struct osmo_gtlv_gen_ie iface_type = { - .decoded_type = "enum osmo_pfcp_3gpp_iface_type", - .tag_name = "3gpp_iface_type", - .spec_ref = "8.2.118", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_pdi[] = { - Ms(source_iface), - O(f_teid, "local_f_teid"), - O(ALL_FROM_NAME, "ue_ip_address"), - Os(traffic_endpoint_id), - O(iface_type, "source_iface_type"), - {} -}; - -static const struct osmo_gtlv_gen_ie pdi = { - .nested_ies = ies_in_pdi, - .spec_ref = "7.5.2.2-2", -}; - -static const struct osmo_gtlv_gen_ie far_id = { - .decoded_type = "uint32_t", - .dec_enc = "32be", - .spec_ref = "8.2.74", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_create_pdr[] = { - Ms(pdr_id), - Ms(precedence), - Ms(pdi), - O(ALL_FROM_NAME, "outer_header_removal"), - Os(far_id), - O(ALL_FROM_NAME, "activate_predefined_rules"), - {} -}; - -static const struct osmo_gtlv_gen_ie create_pdr = { - .nested_ies = ies_in_create_pdr, - .spec_ref = "7.5.2.2", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_created_pdr[] = { - Ms(pdr_id), - O(f_teid, "local_f_teid"), - {} -}; - -static const struct osmo_gtlv_gen_ie created_pdr = { - .nested_ies = ies_in_created_pdr, - .spec_ref = "7.5.3.2", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_upd_pdr[] = { - Ms(pdr_id), - O(ALL_FROM_NAME, "outer_header_removal"), - Os(pdi), - Os(far_id), - O(ALL_FROM_NAME, "activate_predefined_rules"), - {} -}; - -static const struct osmo_gtlv_gen_ie upd_pdr = { - .nested_ies = ies_in_upd_pdr, - .spec_ref = "7.5.4.2", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_updated_pdr[] = { - Ms(pdr_id), - O(f_teid, "local_f_teid"), - {} -}; - -static const struct osmo_gtlv_gen_ie updated_pdr = { - .nested_ies = ies_in_updated_pdr, - .spec_ref = "7.5.9.3", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_remove_pdr[] = { - Ms(pdr_id), - {} -}; - -static const struct osmo_gtlv_gen_ie remove_pdr = { - .nested_ies = ies_in_remove_pdr, - .spec_ref = "7.5.4.6", -}; - -static const struct osmo_gtlv_gen_ie destination_iface = { - .decoded_type = "enum osmo_pfcp_dest_iface", - .dec_enc = "dest_iface", - .spec_ref = "8.2.24", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_forw_params[] = { - Ms(destination_iface), - O(ALL_FROM_NAME, "network_inst"), - O(ALL_FROM_NAME, "outer_header_creation"), - O(traffic_endpoint_id, "linked_te_id"), - O(iface_type, "destination_iface_type"), - {} -}; - -static const struct osmo_gtlv_gen_ie forw_params = { - .nested_ies = ies_in_forw_params, - .spec_ref = "7.5.2.3-2", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_upd_forw_params[] = { - Os(destination_iface), - O(ALL_FROM_NAME, "network_inst"), - O(ALL_FROM_NAME, "outer_header_creation"), - O(traffic_endpoint_id, "linked_te_id"), - O(iface_type, "destination_iface_type"), - {} -}; - -static const struct osmo_gtlv_gen_ie upd_forw_params = { - .nested_ies = ies_in_upd_forw_params, - .spec_ref = "7.5.4.3-2", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_create_far[] = { - Ms(far_id), - M(ALL_FROM_NAME, "apply_action"), - Os(forw_params), - {} -}; - -static const struct osmo_gtlv_gen_ie create_far = { - .nested_ies = ies_in_create_far, - .spec_ref = "7.5.2.3", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_remove_far[] = { - Ms(far_id), - {} -}; - -static const struct osmo_gtlv_gen_ie remove_far = { - .nested_ies = ies_in_remove_far, - .spec_ref = "7.5.4.6", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_upd_far[] = { - Ms(far_id), - O(ALL_FROM_NAME, "apply_action"), - Os(upd_forw_params), - {} -}; - -static const struct osmo_gtlv_gen_ie upd_far = { - .nested_ies = ies_in_upd_far, - .spec_ref = "7.5.4.3", -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_heartbeat_req[] = { - Ms(recovery_time_stamp), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_heartbeat_resp[] = { - Ms(recovery_time_stamp), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_assoc_setup_req[] = { - M(ALL_FROM_NAME, "node_id"), - Ms(recovery_time_stamp), - O(ALL_FROM_NAME, "up_function_features"), - O(ALL_FROM_NAME, "cp_function_features"), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_assoc_setup_resp[] = { - M(ALL_FROM_NAME, "node_id"), - Ms(cause), - Ms(recovery_time_stamp), - O(ALL_FROM_NAME, "up_function_features"), - O(ALL_FROM_NAME, "cp_function_features"), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_assoc_release_req[] = { - M(ALL_FROM_NAME, "node_id"), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_assoc_release_resp[] = { - M(ALL_FROM_NAME, "node_id"), - Ms(cause), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_session_est_req[] = { - M(ALL_FROM_NAME, "node_id"), - O(f_seid, "cp_f_seid"), - M_MULTIs(32, 1, create_pdr), - M_MULTI(32, 1, create_far, "create_far"), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_session_est_resp[] = { - M(ALL_FROM_NAME, "node_id"), - Ms(cause), - Os(offending_ie), - O(f_seid, "up_f_seid"), - O_MULTIs(32, created_pdr), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_session_mod_req[] = { - O(f_seid, "cp_f_seid"), - O_MULTIs(32, remove_pdr), - O_MULTIs(32, remove_far), - O_MULTIs(32, create_pdr), - O_MULTIs(32, create_far), - O_MULTIs(32, upd_pdr), - O_MULTIs(32, upd_far), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_session_mod_resp[] = { - Ms(cause), - Os(offending_ie), - O_MULTIs(32, created_pdr), - O_MULTIs(32, updated_pdr), - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_session_del_req[] = { - /* no IEs */ - {} -}; - -static const struct osmo_gtlv_gen_ie_o ies_in_msg_session_del_resp[] = { - Ms(cause), - {} -}; - -#define MSG(NAME) { #NAME, ies_in_msg_##NAME } -static const struct osmo_gtlv_gen_msg pfcp_msg_defs[] = { - MSG(heartbeat_req), - MSG(heartbeat_resp), - MSG(assoc_setup_req), - MSG(assoc_setup_resp), - MSG(assoc_release_req), - MSG(assoc_release_resp), - MSG(session_est_req), - MSG(session_est_resp), - MSG(session_mod_req), - MSG(session_mod_resp), - MSG(session_del_req), - MSG(session_del_resp), - {} -}; - -int main(int argc, const char **argv) -{ - struct osmo_gtlv_gen_cfg cfg = { - .proto_name = "osmo_pfcp", - .spec_ref_prefix = "3GPP TS 29.244 ", - .message_type_enum = "enum osmo_pfcp_message_type", - .message_type_prefix = "OSMO_PFCP_MSGT_", - .tag_enum = "enum osmo_pfcp_iei", - .tag_prefix = "OSMO_PFCP_IEI_", - .decoded_type_prefix = "struct osmo_pfcp_ie_", - .h_header = "#include <osmocom/pfcp/pfcp_ies_custom.h>", - .c_header = "#include <osmocom/pfcp/pfcp_ies_auto.h>", - .msg_defs = pfcp_msg_defs, - .add_enc_to_str = true, - }; - return osmo_gtlv_gen_main(&cfg, argc, argv); -} diff --git a/src/libosmo-pfcp/pfcp_endpoint.c b/src/libosmo-pfcp/pfcp_endpoint.c deleted file mode 100644 index 83b7c1a..0000000 --- a/src/libosmo-pfcp/pfcp_endpoint.c +++ /dev/null @@ -1,473 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> -#include <unistd.h> -#include <time.h> - -#include <osmocom/core/talloc.h> -#include <osmocom/core/timer.h> -#include <osmocom/core/tdef.h> - -#include <osmocom/pfcp/pfcp_endpoint.h> -#include <osmocom/pfcp/pfcp_msg.h> - -/*! Entry of pfcp_endpoint message queue of PFCP messages, for re-transsions. */ -struct osmo_pfcp_queue_entry { - /* entry in per-peer list of messages waiting for a response */ - struct llist_head entry; - /* back-pointer */ - struct osmo_pfcp_endpoint *ep; - /* message we have transmitted */ - struct osmo_pfcp_msg *m; - /* T1 timer: How long to wait for response before retransmitting */ - struct osmo_timer_list t1; - /* N1: number of pending re-transmissions */ - unsigned int n1_remaining; -}; - -/* Find a matching osmo_pfcp_queue_entry for given rx_hdr. - * A returned osmo_pfcp_queue_entry is guaranteed to be a Response if rx is a Request, and vice versa. */ -static struct osmo_pfcp_queue_entry * -osmo_pfcp_queue_find(struct llist_head *queue, const struct osmo_pfcp_msg *rx) -{ - struct osmo_pfcp_queue_entry *qe; - /* It's important to match only a Request to a Response and vice versa, because the remote peer makes its own - * sequence_nr. There could be a collision of sequence_nr. But as long as all Requests look for a Response and - * vice versa, the sequence_nr scopes don't overlap. */ - llist_for_each_entry(qe, queue, entry) { - if (qe->m->is_response != rx->is_response - && qe->m->h.sequence_nr == rx->h.sequence_nr) - return qe; - } - return NULL; -} - -/* clean up and deallocate the given osmo_pfcp_queue_entry */ -static void osmo_pfcp_queue_del(struct osmo_pfcp_queue_entry *qe) -{ - /* see also the talloc destructor: osmo_pfcp_queue_destructor() */ - talloc_free(qe); -} - -static int osmo_pfcp_queue_destructor(struct osmo_pfcp_queue_entry *qe) -{ - osmo_timer_del(&qe->t1); - llist_del(&qe->entry); - return 0; -} - -struct osmo_tdef osmo_pfcp_tdefs[] = { - { .T = OSMO_PFCP_MSGT_HEARTBEAT_REQ, .default_val = 15, .unit = OSMO_TDEF_S, - .desc = "PFCP Heartbeat Request period, how long to wait between issuing requests" - }, - { .T = OSMO_PFCP_MSGT_HEARTBEAT_RESP, .default_val = 15, .unit = OSMO_TDEF_S, - .desc = "PFCP Heartbeat Response timeout, the time after which to regard a non-responding peer as disconnected" - }, - { .T = OSMO_PFCP_TIMER_GRACEFUL_REL, .default_val = 15, .unit = OSMO_TDEF_S, - .desc = "PFCP peer graceful shutdown timeout, how long to keep the peer's state after a peer requested" - " graceful shutdown" - }, - { .T = OSMO_PFCP_TIMER_T1, .default_val = 3000, .unit = OSMO_TDEF_MS, - .desc = "PFCP request timeout, how long after a missing response to retransmit a PFCP request" - }, - { .T = OSMO_PFCP_TIMER_N1, .default_val = 3, .unit = OSMO_TDEF_CUSTOM, - .desc = "Number of PFCP request retransmission attempts" - }, - { .T = OSMO_PFCP_TIMER_KEEP_RESP, .default_val = 10000, .unit = OSMO_TDEF_MS, - .desc = "PFCP response timeout, how long to keep a response, in case its same request is retransmitted by the peer" - }, - { .T = OSMO_PFCP_TIMER_ASSOC_RETRY, .default_val = 15, .unit = OSMO_TDEF_S, - .desc = "Idle time between attempts of PFCP Association Setup (CPF)" - }, - {} -}; - -struct osmo_pfcp_endpoint *osmo_pfcp_endpoint_create(void *ctx, void *priv) -{ - struct osmo_pfcp_endpoint *ep = talloc_zero(ctx, struct osmo_pfcp_endpoint); - uint32_t unix_time; - if (!ep) - return NULL; - - INIT_LLIST_HEAD(&ep->sent_requests); - INIT_LLIST_HEAD(&ep->sent_responses); - - ep->cfg.tdefs = osmo_pfcp_tdefs; - ep->priv = priv; - ep->pfcp_fd.fd = -1; - - /* time() returns seconds since 1970 (UNIX epoch), but the recovery_time_stamp is coded in the NTP format, which is - * seconds since 1900, the NTP era 0. 2208988800L is the offset between UNIX epoch and NTP era 0. - * TODO: what happens when we enter NTP era 1? Is it sufficient to integer-wrap? */ - unix_time = time(NULL); - ep->recovery_time_stamp = unix_time + 2208988800L; - LOGP(DLPFCP, LOGL_NOTICE, "PFCP endpoint: recovery timestamp = 0x%08x (%u seconds since UNIX epoch," - " which is %u seconds since NTP era 0; IETF RFC 5905)\n", - ep->recovery_time_stamp, unix_time, ep->recovery_time_stamp); - - return ep; -} - -static unsigned int ep_n1(struct osmo_pfcp_endpoint *ep) -{ - return osmo_tdef_get(ep->cfg.tdefs, OSMO_PFCP_TIMER_N1, OSMO_TDEF_CUSTOM, -1); -} - -static unsigned int ep_t1(struct osmo_pfcp_endpoint *ep) -{ - return osmo_tdef_get(ep->cfg.tdefs, OSMO_PFCP_TIMER_T1, OSMO_TDEF_MS, -1); -} - -static unsigned int ep_keep_resp(struct osmo_pfcp_endpoint *ep) -{ - return osmo_tdef_get(ep->cfg.tdefs, OSMO_PFCP_TIMER_KEEP_RESP, OSMO_TDEF_MS, -1); -} - -static int osmo_pfcp_endpoint_tx_data_no_logging(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m); - -/* Return true to keep the message in the queue, false for dropping from the queue. */ -static bool pfcp_queue_retrans(struct osmo_pfcp_queue_entry *qe) -{ - struct osmo_pfcp_endpoint *endpoint = qe->ep; - unsigned int t1_ms = ep_t1(endpoint); - struct osmo_pfcp_msg *m = qe->m; - int rc; - - /* re-transmit */ - if (qe->n1_remaining) - qe->n1_remaining--; - OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "re-sending (%u attempts remaining)\n", qe->n1_remaining); - - rc = osmo_pfcp_endpoint_tx_data_no_logging(endpoint, m); - /* If encoding failed, it cannot ever succeed. Drop the queue entry. */ - if (rc) - return false; - /* if no more attempts remaining, drop from queue */ - if (!qe->n1_remaining) - return false; - /* re-schedule timer, keep in queue */ - osmo_timer_schedule(&qe->t1, t1_ms/1000, t1_ms%1000); - return true; -} - -/* T1 for a given queue entry has expired */ -static void pfcp_queue_timer_cb(void *data) -{ - struct osmo_pfcp_queue_entry *qe = data; - bool keep; - - if (qe->m->is_response) { - /* The response has waited in the queue for any retransmissions of its initiating request. Now that time - * has passed and the response can be dropped from the queue. */ - keep = false; - } else { - /* The request is still here, which means it has not received a response from the remote side. - * Retransmit the request. */ - keep = pfcp_queue_retrans(qe); - } - - if (keep) - return; - /* Drop the queue entry. No more retransmissions. */ - if (!qe->m->is_response && qe->m->ctx.resp_cb) - qe->m->ctx.resp_cb(qe->m, NULL, "PFCP retransmissions elapsed, no response received"); - osmo_pfcp_queue_del(qe); -} - -/* Directly encode and transmit the message, without storing in the retrans_queue. */ -static int osmo_pfcp_endpoint_tx_data_no_logging(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) -{ - int rc; - - if (!m->encoded) { - /* Allocate msgb as child of the message m, so that when m gets deallocated at the end of - * retransmission queueing, the msgb gets deallocated with it. */ - m->encoded = msgb_alloc_c(m, OSMO_PFCP_MSGB_ALLOC_SIZE, "PFCP-tx"); - OSMO_ASSERT(m->encoded); - rc = osmo_pfcp_msg_encode(m->encoded, m); - if (rc) { - msgb_free(m->encoded); - m->encoded = NULL; - return rc; - } - } - - rc = sendto(ep->pfcp_fd.fd, msgb_data(m->encoded), msgb_length(m->encoded), 0, - (struct sockaddr *)&m->remote_addr, sizeof(m->remote_addr)); - if (rc != msgb_length(m->encoded)) { - OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "sendto() failed: rc = %d != length %u\n", - rc, msgb_length(m->encoded)); - return -EIO; - } - return 0; -} - -int osmo_pfcp_endpoint_tx_data(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) -{ - OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "sending\n"); - return osmo_pfcp_endpoint_tx_data_no_logging(ep, m); -} - -int osmo_pfcp_endpoint_tx_heartbeat_req(struct osmo_pfcp_endpoint *ep, const struct osmo_sockaddr *remote_addr) -{ - struct osmo_pfcp_msg *tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, remote_addr, NULL, NULL, - OSMO_PFCP_MSGT_HEARTBEAT_REQ); - tx->ies.heartbeat_req.recovery_time_stamp = ep->recovery_time_stamp; - tx->h.sequence_nr = osmo_pfcp_next_seq_nr(&ep->seq_nr_state); - return osmo_pfcp_endpoint_tx_data(ep, tx); -} - -/* add a given msgb to the queue of per-peer messages waiting for a response */ -static int osmo_pfcp_endpoint_retrans_queue_add(struct osmo_pfcp_endpoint *endpoint, struct osmo_pfcp_msg *m) -{ - struct osmo_pfcp_queue_entry *qe; - unsigned int n1 = ep_n1(endpoint); - unsigned int t1_ms = ep_t1(endpoint); - unsigned int keep_resp_ms = ep_keep_resp(endpoint); - unsigned int timeout = m->is_response ? keep_resp_ms : t1_ms; - - LOGP(DLPFCP, LOGL_DEBUG, "retransmit unanswered Requests %u x %ums; keep sent Responses for %ums\n", - n1, t1_ms, keep_resp_ms); - /* If there are no retransmissions or no timeout, it makes no sense to add to the queue. */ - if (!n1 || !t1_ms) { - if (!m->is_response && m->ctx.resp_cb) - m->ctx.resp_cb(m, NULL, "PFCP timeout is zero, cannot wait for a response"); - return 0; - } - - qe = talloc(endpoint, struct osmo_pfcp_queue_entry); - OSMO_ASSERT(qe); - *qe = (struct osmo_pfcp_queue_entry){ - .ep = endpoint, - .m = m, - .n1_remaining = m->is_response ? 0 : n1, - }; - talloc_steal(qe, m); - - /* Slight optimization: Add sent requests to the start of the list: we will usually receive a response shortly - * after sending a request, removing that entry from the queue quickly. - * Add sent responses to the end of the list: they will rarely be retransmitted at all. */ - if (m->is_response) - llist_add_tail(&qe->entry, &endpoint->sent_responses); - else - llist_add_tail(&qe->entry, &endpoint->sent_requests); - talloc_set_destructor(qe, osmo_pfcp_queue_destructor); - - osmo_timer_setup(&qe->t1, pfcp_queue_timer_cb, qe); - osmo_timer_schedule(&qe->t1, timeout/1000, timeout%1000); - return 0; -} - -/* Transmit a PFCP message. - * Store the message in the local message queue for possible retransmissions. - * On success, return zero, and pass ownership of m to ep. ep deallocates m when all retransmissions are done / a reply - * has been received. - * On error, return nonzero, and immediately deallocate m. */ -int osmo_pfcp_endpoint_tx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) -{ - struct osmo_pfcp_ie_node_id *node_id; - int rc; - if (!m->is_response) - m->h.sequence_nr = osmo_pfcp_next_seq_nr(&ep->seq_nr_state); - node_id = osmo_pfcp_msg_node_id(m); - if (node_id) - *node_id = ep->cfg.local_node_id; - - rc = osmo_pfcp_endpoint_tx_data(ep, m); - if (rc) { - if (!m->is_response && m->ctx.resp_cb) - m->ctx.resp_cb(m, NULL, "Failed to transmit request"); - osmo_pfcp_msg_free(m); - return rc; - } - osmo_pfcp_endpoint_retrans_queue_add(ep, m); - return 0; -} - -static void osmo_pfcp_endpoint_handle_rx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) -{ - bool dispatch_rx = true; - struct osmo_pfcp_queue_entry *prev_msg; - struct osmo_pfcp_msg *req; - - if (m->h.message_type == OSMO_PFCP_MSGT_HEARTBEAT_REQ) { - /* Directly answer with a Heartbeat Response. */ - struct osmo_pfcp_msg *resp = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, NULL, m, OSMO_PFCP_MSGT_HEARTBEAT_RESP); - resp->ies.heartbeat_resp.recovery_time_stamp = ep->recovery_time_stamp; - osmo_pfcp_endpoint_tx_data(ep, resp); - /* Still also dispatch the Rx event to the peer. */ - } - - /* If this is receiving a response, search for matching sent request that is now completed. - * If this is receiving a request, search for a matching sent response that can be retransmitted. - * A match is found by sequence_nr. */ - prev_msg = osmo_pfcp_queue_find(m->is_response ? &ep->sent_requests : &ep->sent_responses, m); - - if (prev_msg && !m->is_response) { - /* m is a request, and we have already sent a response to this same request earlier. Retransmit the same - * response, and don't dispatch the msg rx. Keep our response queued in case the request is - * retransmitted yet another time. */ - - /* Populate message context to point at peer and session, if applicable. - * With that context applied, log message rx. */ - if (ep->set_msg_ctx) - ep->set_msg_ctx(ep, m, NULL); - OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "received retransmission of earlier request\n"); - - /* Also log on the earlier PFCP msg that it is resent */ - OSMO_LOG_PFCP_MSG(prev_msg->m, LOGL_INFO, "re-sending cached response\n"); - osmo_pfcp_endpoint_tx_data_no_logging(ep, prev_msg->m); - return; - } - - req = NULL; - if (prev_msg && m->is_response) { - /* m is a response to the earlier request prev_msg->m. The request is now ACKed and can be dropped from - * the retransmission queue: see 'if (req)' below. */ - req = prev_msg->m; - } - - /* Populate message context to point at peer and session, if applicable. - * With that context applied, log message rx. */ - if (ep->set_msg_ctx) - ep->set_msg_ctx(ep, m, req); - OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "received\n"); - - if (req && req->ctx.resp_cb) { - int rc = req->ctx.resp_cb(req, m, NULL); - /* Only dispatch the response to rx_msg() when resp_cb() asks for it with rc == 1 (or when there is no - * resp_cb()). */ - if (rc != 1) { - dispatch_rx = false; - OSMO_LOG_PFCP_MSG(m, LOGL_DEBUG, - "response handled by m->resp_cb(), not dispatching to rx_msg()\n"); - } - } - - if (dispatch_rx) - ep->rx_msg(ep, m, req); - if (req) - osmo_pfcp_queue_del(prev_msg); -} - -/* call-back for PFCP socket file descriptor */ -static int osmo_pfcp_fd_cb(struct osmo_fd *ofd, unsigned int what) -{ - int rc; - struct osmo_pfcp_endpoint *ep = ofd->data; - - if (what & OSMO_FD_READ) { - struct osmo_sockaddr remote; - socklen_t remote_len = sizeof(remote); - struct msgb *msg = msgb_alloc_c(OTC_SELECT, OSMO_PFCP_MSGB_ALLOC_SIZE, "PFCP-rx"); - if (!msg) - return -ENOMEM; - - msg->l3h = msg->tail; - rc = recvfrom(ofd->fd, msg->tail, msgb_tailroom(msg), 0, (struct sockaddr *)&remote, &remote_len); - if (rc <= 0) - return -EIO; - msgb_put(msg, rc); - - OSMO_ASSERT(ep->rx_msg); - - /* This may be a bundle of PFCP messages. Parse and receive each message received, by shifting l4h - * through the message bundle. */ - msg->l4h = msg->l3h; - while (msgb_l4len(msg)) { - struct osmo_gtlv_load tlv; - struct osmo_pfcp_msg *m = osmo_pfcp_msg_alloc_rx(OTC_SELECT, &remote); - m->encoded = msg; - - rc = osmo_pfcp_msg_decode_header(&tlv, m, msg); - if (rc < 0) - break; - msg->l4h += rc; - - rc = osmo_pfcp_msg_decode_tlv(m, &tlv); - /* If errors occurred, they have already been logged on DLPFCP. */ - if (rc == 0) - osmo_pfcp_endpoint_handle_rx(ep, m); - osmo_pfcp_msg_free(m); - } - msgb_free(msg); - } - return 0; -} - -/*! bind a PFCP endpoint to its configured address (ep->cfg.local_addr). - * \return 0 on success, negative on error. */ -int osmo_pfcp_endpoint_bind(struct osmo_pfcp_endpoint *ep) -{ - int rc; - /* close the existing socket, if any */ - osmo_pfcp_endpoint_close(ep); - - if (!ep->rx_msg) { - LOGP(DLPFCP, LOGL_ERROR, "missing rx_msg cb at osmo_pfcp_endpoint\n"); - return -EINVAL; - } - - /* create the new socket, binding to configured local address */ - ep->pfcp_fd.cb = osmo_pfcp_fd_cb; - ep->pfcp_fd.data = ep; - rc = osmo_sock_init_osa_ofd(&ep->pfcp_fd, SOCK_DGRAM, IPPROTO_UDP, &ep->cfg.local_addr, NULL, OSMO_SOCK_F_BIND); - if (rc < 0) - return rc; - return 0; -} - -void osmo_pfcp_endpoint_close(struct osmo_pfcp_endpoint *ep) -{ - struct osmo_pfcp_queue_entry *qe; - while ((qe = llist_first_entry_or_null(&ep->sent_requests, struct osmo_pfcp_queue_entry, entry))) - osmo_pfcp_queue_del(qe); - while ((qe = llist_first_entry_or_null(&ep->sent_responses, struct osmo_pfcp_queue_entry, entry))) - osmo_pfcp_queue_del(qe); - - if (ep->pfcp_fd.fd != -1) { - osmo_fd_unregister(&ep->pfcp_fd); - close(ep->pfcp_fd.fd); - ep->pfcp_fd.fd = -1; - } -} - -void osmo_pfcp_endpoint_free(struct osmo_pfcp_endpoint **ep) -{ - if (!*ep) - return; - osmo_pfcp_endpoint_close(*ep); - talloc_free(*ep); - *ep = NULL; -} - -/* Call osmo_pfcp_msg_invalidate_ctx(deleted_fi) on all queued osmo_pfcp_msg instances in the retrans_queue. */ -void osmo_pfcp_endpoint_invalidate_ctx(struct osmo_pfcp_endpoint *ep, struct osmo_fsm_inst *deleted_fi) -{ - struct osmo_pfcp_queue_entry *qe; - llist_for_each_entry(qe, &ep->sent_requests, entry) - osmo_pfcp_msg_invalidate_ctx(qe->m, deleted_fi); - llist_for_each_entry(qe, &ep->sent_responses, entry) - osmo_pfcp_msg_invalidate_ctx(qe->m, deleted_fi); -} diff --git a/src/libosmo-pfcp/pfcp_ies_custom.c b/src/libosmo-pfcp/pfcp_ies_custom.c deleted file mode 100644 index 3b3769a..0000000 --- a/src/libosmo-pfcp/pfcp_ies_custom.c +++ /dev/null @@ -1,999 +0,0 @@ -/* Decoded PFCP IEs, to be used by the auto-generated pfcp_ies_auto.c. */ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> -#include <inttypes.h> - -#include <osmocom/core/socket.h> -#include <osmocom/core/logging.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/msgb.h> - -#include <osmocom/gtlv/gtlv.h> - -#include <osmocom/pfcp/pfcp_ies_custom.h> -#include <osmocom/pfcp/pfcp_strs.h> -#include <osmocom/pfcp/pfcp_msg.h> - -/* Assumes presence of local variable osmo_pfcp_msg *m. m->log_ctx may be NULL. */ -#define RETURN_ERROR(RC, FMT, ARGS...) \ - do {\ - OSMO_ASSERT(decoded_struct); \ - OSMO_LOG_PFCP_MSG(OSMO_PFCP_MSG_FOR_IES(decoded_struct), LOGL_ERROR, FMT " (%d: %s)\n", ##ARGS, RC, \ - strerror((RC) > 0 ? (RC) : -(RC))); \ - return RC; \ - } while (0) - -/* Assumes presence of local variable osmo_gtlv_load *tlv. Usage: - * ENSURE_LENGTH_IS_EXACTLY(2); - */ -#define ENSURE_LENGTH_IS_EXACTLY(VAL) \ - do { \ - if (!(tlv->len == VAL)) \ - RETURN_ERROR(-EINVAL, "IE has length = %zu, expected length == " #VAL, tlv->len); \ - } while (0) - -/* Assumes presence of local variable osmo_gtlv_load *tlv. Usage: - * ENSURE_LENGTH_IS_AT_LEAST(1); - */ -#define ENSURE_LENGTH_IS_AT_LEAST(VAL) \ - do { \ - if (!(tlv->len >= VAL)) \ - RETURN_ERROR(-EINVAL, "IE has length = %zu, expected length >= " #VAL, tlv->len); \ - } while (0) - -/* Assumes presence of local variable osmo_gtlv_load *tlv. Usage: - * const uint8_t *pos = tlv->val; - * ENSURE_REMAINING_LENGTH_IS_AT_LEAST("first part", pos, 23); - * <parse first part> - * pos += 23; - * ENSURE_REMAINING_LENGTH_IS_AT_LEAST("very long part", pos, 235); - * <parse very long part> - * pos += 235; - */ -#define ENSURE_REMAINING_LENGTH_IS_AT_LEAST(NAME, POS, MIN_VAL) \ - do { \ - if (!((tlv->len - ((POS) - tlv->val)) >= MIN_VAL)) \ - RETURN_ERROR(-EINVAL, \ - "at value octet %d: %zu octets remaining, but " #NAME " requires length >= " #MIN_VAL, \ - (int)((POS) - tlv->val), \ - tlv->len - ((POS) - tlv->val)); \ - } while (0) - -void osmo_pfcp_ie_f_seid_set(struct osmo_pfcp_ie_f_seid *f_seid, uint64_t seid, const struct osmo_sockaddr *remote_addr) -{ - *f_seid = (struct osmo_pfcp_ie_f_seid) { - .seid = seid, - }; - osmo_pfcp_ip_addrs_set(&f_seid->ip_addr, remote_addr); -} - -int osmo_pfcp_dec_cause(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - enum osmo_pfcp_cause *cause = decode_to; - ENSURE_LENGTH_IS_EXACTLY(1); - *cause = *tlv->val; - return 0; -} - -int osmo_pfcp_enc_cause(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const enum osmo_pfcp_cause *cause = encode_from; - msgb_put_u8(tlv->dst, *cause); - return 0; -} - -int osmo_pfcp_enc_to_str_cause(char *buf, size_t buflen, const void *encode_from) -{ - const enum osmo_pfcp_cause *cause = encode_from; - return snprintf(buf, buflen, "%s", osmo_pfcp_cause_str(*cause)); -} - -int osmo_pfcp_dec_offending_ie(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - enum osmo_pfcp_iei *offending_ie = decode_to; - ENSURE_LENGTH_IS_EXACTLY(2); - *offending_ie = osmo_load16be(tlv->val); - return 0; -} - -int osmo_pfcp_enc_offending_ie(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const enum osmo_pfcp_iei *offending_ie = encode_from; - msgb_put_u16(tlv->dst, *offending_ie); - return 0; -} - -int osmo_pfcp_enc_to_str_offending_ie(char *buf, size_t buflen, const void *encode_from) -{ - const enum osmo_pfcp_iei *offending_ie = encode_from; - return snprintf(buf, buflen, "%s", osmo_pfcp_iei_str(*offending_ie)); -} - -int osmo_pfcp_dec_8(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - uint8_t *u8 = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(1); - *u8 = tlv->val[0]; - return 0; -} - -int osmo_pfcp_enc_8(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const uint8_t *u8 = encode_from; - msgb_put_u8(tlv->dst, *u8); - return 0; -} - -int osmo_pfcp_enc_to_str_8(char *buf, size_t buflen, const void *encode_from) -{ - const uint8_t *u8 = encode_from; - return snprintf(buf, buflen, "%u", *u8); -} - -int osmo_pfcp_dec_16be(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - uint16_t *u16 = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(2); - *u16 = osmo_load16be(tlv->val); - return 0; -} - -int osmo_pfcp_enc_16be(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const uint16_t *u16 = encode_from; - msgb_put_u16(tlv->dst, *u16); - return 0; -} - -int osmo_pfcp_enc_to_str_16be(char *buf, size_t buflen, const void *encode_from) -{ - const uint16_t *u16 = encode_from; - return snprintf(buf, buflen, "%u", *u16); -} - -int osmo_pfcp_dec_32be(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - uint32_t *u32 = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(4); - *u32 = osmo_load32be(tlv->val); - return 0; -} - -int osmo_pfcp_enc_32be(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const uint32_t *u32 = encode_from; - msgb_put_u32(tlv->dst, *u32); - return 0; -} - -int osmo_pfcp_enc_to_str_32be(char *buf, size_t buflen, const void *encode_from) -{ - const uint32_t *u32 = encode_from; - return snprintf(buf, buflen, "%u", *u32); -} - -int osmo_pfcp_dec_3gpp_iface_type(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - enum osmo_pfcp_3gpp_iface_type *_3gpp_iface_type = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(1); - *_3gpp_iface_type = tlv->val[0] & 0x3f; - return 0; -} - -int osmo_pfcp_enc_3gpp_iface_type(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const enum osmo_pfcp_3gpp_iface_type *_3gpp_iface_type = encode_from; - msgb_put_u8(tlv->dst, (uint8_t)(*_3gpp_iface_type) & 0x3f); - return 0; -} - -int osmo_pfcp_enc_to_str_3gpp_iface_type(char *buf, size_t buflen, const void *encode_from) -{ - const enum osmo_pfcp_3gpp_iface_type *_3gpp_iface_type = encode_from; - return snprintf(buf, buflen, "%s", osmo_pfcp_3gpp_iface_type_str(*_3gpp_iface_type)); -} - -int osmo_pfcp_dec_source_iface(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - enum osmo_pfcp_source_iface *source_iface = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(1); - *source_iface = tlv->val[0] & 0xf; - return 0; -} - -int osmo_pfcp_enc_source_iface(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const enum osmo_pfcp_source_iface *source_iface = encode_from; - msgb_put_u8(tlv->dst, (uint8_t)(*source_iface) & 0xf); - return 0; -} - -int osmo_pfcp_enc_to_str_source_iface(char *buf, size_t buflen, const void *encode_from) -{ - const enum osmo_pfcp_source_iface *source_iface = encode_from; - return snprintf(buf, buflen, "%s", osmo_pfcp_source_iface_str(*source_iface)); -} - -int osmo_pfcp_dec_dest_iface(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - enum osmo_pfcp_dest_iface *dest_interface = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(1); - *dest_interface = tlv->val[0] & 0xf; - return 0; -} - -int osmo_pfcp_enc_dest_iface(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const enum osmo_pfcp_dest_iface *dest_interface = encode_from; - msgb_put_u8(tlv->dst, (uint8_t)(*dest_interface) & 0xf); - return 0; -} - -int osmo_pfcp_enc_to_str_dest_iface(char *buf, size_t buflen, const void *encode_from) -{ - const enum osmo_pfcp_dest_iface *dest_iface = encode_from; - return snprintf(buf, buflen, "%s", osmo_pfcp_dest_iface_str(*dest_iface)); -} - -int osmo_pfcp_dec_node_id(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_node_id *node_id = decode_to; - const void *ip; - unsigned int ip_len; - unsigned int want_len; - ENSURE_LENGTH_IS_AT_LEAST(1); - node_id->type = *(uint8_t *)tlv->val; - ip = &tlv->val[1]; - ip_len = tlv->len - 1; - - switch (node_id->type) { - case OSMO_PFCP_NODE_ID_T_IPV4: - want_len = sizeof(node_id->ip.u.sin.sin_addr); - if (ip_len != want_len) - RETURN_ERROR(-EINVAL, "Node ID: wrong IPv4 address value length %u, expected %u", - ip_len, want_len); - osmo_sockaddr_from_octets(&node_id->ip, ip, ip_len); - break; - case OSMO_PFCP_NODE_ID_T_IPV6: - want_len = sizeof(node_id->ip.u.sin6.sin6_addr); - if (ip_len != want_len) - RETURN_ERROR(-EINVAL, "Node ID: wrong IPv6 address value length %u, expected %u", - ip_len, want_len); - osmo_sockaddr_from_octets(&node_id->ip, ip, ip_len); - break; - case OSMO_PFCP_NODE_ID_T_FQDN: - /* Copy and add a trailing nul */ - OSMO_STRLCPY_ARRAY(node_id->fqdn, ip); - break; - default: - RETURN_ERROR(-EINVAL, "Invalid Node ID Type: %d", node_id->type); - } - return 0; -} - -int osmo_pfcp_enc_node_id(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - unsigned int l; - const struct osmo_pfcp_ie_node_id *node_id = encode_from; - msgb_put_u8(tlv->dst, node_id->type); - switch (node_id->type) { - case OSMO_PFCP_NODE_ID_T_IPV4: - l = sizeof(node_id->ip.u.sin.sin_addr); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &node_id->ip); - break; - case OSMO_PFCP_NODE_ID_T_IPV6: - l = sizeof(node_id->ip.u.sin6.sin6_addr); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &node_id->ip); - break; - case OSMO_PFCP_NODE_ID_T_FQDN: - l = strnlen(node_id->fqdn, sizeof(node_id->fqdn)); - /* Copy without trailing nul */ - memcpy((char *)msgb_put(tlv->dst, l), node_id->fqdn, l); - break; - default: - RETURN_ERROR(-EINVAL, "Invalid Node ID Type: %d", node_id->type); - } - return 0; -} - -int osmo_pfcp_ie_node_id_to_str_buf(char *buf, size_t buflen, const struct osmo_pfcp_ie_node_id *node_id) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - - switch (node_id->type) { - case OSMO_PFCP_NODE_ID_T_IPV4: - OSMO_STRBUF_PRINTF(sb, "v4:"); - break; - case OSMO_PFCP_NODE_ID_T_IPV6: - OSMO_STRBUF_PRINTF(sb, "v6:"); - break; - case OSMO_PFCP_NODE_ID_T_FQDN: - OSMO_STRBUF_PRINTF(sb, "fqdn:"); - OSMO_STRBUF_APPEND(sb, osmo_quote_str_buf3, - node_id->fqdn, strnlen(node_id->fqdn, sizeof(node_id->fqdn))); - return sb.chars_needed; - default: - OSMO_STRBUF_PRINTF(sb, "unknown-node-id-type-%u", node_id->type); - return sb.chars_needed; - } - - OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &node_id->ip); - return sb.chars_needed; -} - -char *osmo_pfcp_ie_node_id_to_str_c(void *ctx, const struct osmo_pfcp_ie_node_id *node_id) -{ - OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_pfcp_ie_node_id_to_str_buf, node_id) -} - -int osmo_pfcp_enc_to_str_node_id(char *buf, size_t buflen, const void *encode_from) -{ - return osmo_pfcp_ie_node_id_to_str_buf(buf, buflen, encode_from); -} - -bool osmo_pfcp_bits_get(const uint8_t *bits, unsigned int bitpos) -{ - unsigned int bytenum = bitpos / 8; - unsigned int bitmask = 1 << (bitpos % 8); - - return (bool)(bits[bytenum] & bitmask); -} - -void osmo_pfcp_bits_set(uint8_t *bits, unsigned int bitpos, bool val) -{ - unsigned int bytenum = bitpos / 8; - unsigned int bitmask = 1 << (bitpos % 8); - - if (val) - bits[bytenum] |= bitmask; - else - bits[bytenum] &= ~bitmask; -} - -int osmo_pfcp_bits_to_str_buf(char *buf, size_t buflen, const uint8_t *bits, const struct value_string *bit_strs) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_PRINTF(sb, "("); - for (; bit_strs->str; bit_strs++) { - if (osmo_pfcp_bits_get(bits, bit_strs->value)) { - OSMO_STRBUF_PRINTF(sb, " %s", bit_strs->str); - } - } - OSMO_STRBUF_PRINTF(sb, " )"); - return sb.chars_needed; -} - -char *osmo_pfcp_bits_to_str_c(void *ctx, const uint8_t *bits, const struct value_string *bit_str) -{ - OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_pfcp_bits_to_str_buf, bits, bit_str) -} - -int osmo_pfcp_dec_up_function_features(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_up_function_features *up_function_features = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(6); - memcpy(up_function_features->bits, tlv->val, 6); - return 0; -} - -int osmo_pfcp_enc_up_function_features(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_up_function_features *up_function_features = encode_from; - memcpy(msgb_put(tlv->dst, 6), up_function_features->bits, 6); - return 0; -} - -int osmo_pfcp_enc_to_str_up_function_features(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_up_function_features *up_function_features = encode_from; - return osmo_pfcp_bits_to_str_buf(buf, buflen, up_function_features->bits, osmo_pfcp_up_feature_strs); -} - -int osmo_pfcp_dec_cp_function_features(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_cp_function_features *cp_function_features = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(sizeof(cp_function_features->bits)); - memcpy(cp_function_features->bits, tlv->val, sizeof(cp_function_features->bits)); - return 0; -} - -int osmo_pfcp_enc_cp_function_features(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_cp_function_features *cp_function_features = encode_from; - memcpy(msgb_put(tlv->dst, sizeof(cp_function_features->bits)), - cp_function_features->bits, sizeof(cp_function_features->bits)); - return 0; -} - -int osmo_pfcp_enc_to_str_cp_function_features(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_cp_function_features *cp_function_features = encode_from; - return osmo_pfcp_bits_to_str_buf(buf, buflen, cp_function_features->bits, osmo_pfcp_cp_feature_strs); -} - -int osmo_pfcp_dec_f_seid(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_f_seid *f_seid = decode_to; - uint8_t flags; - uint8_t pos; - unsigned int l; - /* flags and 8 octet seid */ - ENSURE_LENGTH_IS_AT_LEAST(9); - flags = tlv->val[0]; - f_seid->ip_addr.v6_present = flags & 1; - f_seid->ip_addr.v4_present = flags & 2; - f_seid->seid = osmo_load64be(&tlv->val[1]); - pos = 9; - if (f_seid->ip_addr.v4_present) { - l = sizeof(f_seid->ip_addr.v4.u.sin.sin_addr); - if (pos + l > tlv->len) - RETURN_ERROR(-EINVAL, "F-SEID IE is too short for the IPv4 address: %zu", tlv->len); - osmo_sockaddr_from_octets(&f_seid->ip_addr.v4, &tlv->val[pos], l); - pos += l; - } - if (f_seid->ip_addr.v6_present) { - l = sizeof(f_seid->ip_addr.v4.u.sin6.sin6_addr); - if (pos + l > tlv->len) - RETURN_ERROR(-EINVAL, "F-SEID IE is too short for the IPv6 address: %zu", tlv->len); - osmo_sockaddr_from_octets(&f_seid->ip_addr.v6, &tlv->val[pos], l); - pos += l; - } - return 0; -} - -int osmo_pfcp_enc_f_seid(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_f_seid *f_seid = encode_from; - unsigned int l; - uint8_t flags = (f_seid->ip_addr.v6_present ? 1 : 0) + (f_seid->ip_addr.v4_present ? 2 : 0); - /* flags and 8 octet seid */ - msgb_put_u8(tlv->dst, flags); - osmo_store64be(f_seid->seid, msgb_put(tlv->dst, 8)); - - if (f_seid->ip_addr.v4_present) { - if (f_seid->ip_addr.v4.u.sin.sin_family != AF_INET) - RETURN_ERROR(-EINVAL, - "f_seid IE indicates IPv4 address, but there is no ipv4_addr"); - l = sizeof(f_seid->ip_addr.v4.u.sin.sin_addr); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &f_seid->ip_addr.v4); - } - if (f_seid->ip_addr.v6_present) { - if (f_seid->ip_addr.v6.u.sin6.sin6_family != AF_INET6) - RETURN_ERROR(-EINVAL, - "f_seid IE indicates IPv6 address, but there is no ipv6_addr"); - l = sizeof(f_seid->ip_addr.v6.u.sin6.sin6_addr); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &f_seid->ip_addr.v6); - } - return 0; -} - -static int ip_addrs_to_str_buf(char *buf, size_t buflen, const struct osmo_pfcp_ip_addrs *addrs) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - if (addrs->v4_present) { - OSMO_STRBUF_PRINTF(sb, ",v4:"); - OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &addrs->v4); - } - if (addrs->v6_present) { - OSMO_STRBUF_PRINTF(sb, ",v6:"); - OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_buf2, &addrs->v6); - } - return sb.chars_needed; -} - -int osmo_pfcp_enc_to_str_f_seid(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_f_seid *f_seid = encode_from; - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_PRINTF(sb, "0x%"PRIx64, f_seid->seid); - OSMO_STRBUF_APPEND(sb, ip_addrs_to_str_buf, &f_seid->ip_addr); - return sb.chars_needed; -} - -int osmo_pfcp_dec_f_teid(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_f_teid *f_teid = decode_to; - uint8_t flags; - const uint8_t *pos; - - *f_teid = (struct osmo_pfcp_ie_f_teid){}; - - pos = tlv->val; - - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("flags", pos, 1); - flags = *pos; - pos++; - f_teid->choose_flag = flags & 4; - - if (!f_teid->choose_flag) { - /* A fixed TEID and address are provided */ - f_teid->fixed.ip_addr.v4_present = flags & 1; - f_teid->fixed.ip_addr.v6_present = flags & 2; - - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("TEID", pos, 4); - f_teid->fixed.teid = osmo_load32be(pos); - pos += 4; - - if (f_teid->fixed.ip_addr.v4_present) { - osmo_static_assert(sizeof(f_teid->fixed.ip_addr.v4.u.sin.sin_addr) == 4, sin_addr_size_is_4); - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv4 address", pos, 4); - osmo_sockaddr_from_octets(&f_teid->fixed.ip_addr.v4, pos, 4); - pos += 4; - } - if (f_teid->fixed.ip_addr.v6_present) { - osmo_static_assert(sizeof(f_teid->fixed.ip_addr.v6.u.sin6.sin6_addr) == 16, sin6_addr_size_is_16); - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv6 address", pos, 16); - osmo_sockaddr_from_octets(&f_teid->fixed.ip_addr.v6, pos, 16); - pos += 16; - } - } else { - /* CH flag is 1, choose an F-TEID. */ - f_teid->choose.ipv4_addr = flags & 1; - f_teid->choose.ipv6_addr = flags & 2; - f_teid->choose.choose_id_present = flags & 8; - - if (f_teid->choose.choose_id_present) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("CHOOSE ID", pos, 1); - f_teid->choose.choose_id = *pos; - pos++; - } - } - return 0; -} - -int osmo_pfcp_enc_f_teid(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_f_teid *f_teid = encode_from; - uint8_t flags; - - flags = (f_teid->choose_flag ? 4 : 0); - - if (!f_teid->choose_flag) { - /* A fixed TEID and address are provided */ - flags |= (f_teid->fixed.ip_addr.v4_present ? 1 : 0) - + (f_teid->fixed.ip_addr.v6_present ? 2 : 0); - - msgb_put_u8(tlv->dst, flags); - msgb_put_u32(tlv->dst, f_teid->fixed.teid); - - if (f_teid->fixed.ip_addr.v4_present) { - if (f_teid->fixed.ip_addr.v4.u.sin.sin_family != AF_INET) - RETURN_ERROR(-EINVAL, - "f_teid IE indicates IPv4 address, but there is no ipv4_addr" - " (sin_family = %d != AF_INET)", f_teid->fixed.ip_addr.v4.u.sin.sin_family); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, 4), 4, &f_teid->fixed.ip_addr.v4); - } - if (f_teid->fixed.ip_addr.v6_present) { - if (f_teid->fixed.ip_addr.v6.u.sin6.sin6_family != AF_INET6) - RETURN_ERROR(-EINVAL, - "f_teid IE indicates IPv6 address, but there is no ipv6_addr" - " (sin6_family = %d != AF_INET6)", f_teid->fixed.ip_addr.v6.u.sin6.sin6_family); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, 16), 16, &f_teid->fixed.ip_addr.v6); - } - } else { - flags |= (f_teid->choose.ipv4_addr ? 1 : 0) - + (f_teid->choose.ipv6_addr ? 2 : 0) - + (f_teid->choose.choose_id_present ? 8 : 0); - msgb_put_u8(tlv->dst, flags); - if (f_teid->choose.choose_id_present) - msgb_put_u8(tlv->dst, f_teid->choose.choose_id); - } - return 0; -} - -int osmo_pfcp_ie_f_teid_to_str_buf(char *buf, size_t buflen, const struct osmo_pfcp_ie_f_teid *ft) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - if (ft->choose_flag) { - OSMO_STRBUF_PRINTF(sb, "CHOOSE"); - if (ft->choose.ipv4_addr) - OSMO_STRBUF_PRINTF(sb, "-v4"); - if (ft->choose.ipv6_addr) - OSMO_STRBUF_PRINTF(sb, "-v6"); - if (ft->choose.choose_id_present) - OSMO_STRBUF_PRINTF(sb, "-id%u", ft->choose.choose_id); - } else { - OSMO_STRBUF_PRINTF(sb, "TEID-0x%x", ft->fixed.teid); - OSMO_STRBUF_APPEND(sb, ip_addrs_to_str_buf, &ft->fixed.ip_addr); - } - return sb.chars_needed; -} - -char *osmo_pfcp_ie_f_teid_to_str_c(void *ctx, const struct osmo_pfcp_ie_f_teid *ft) -{ - OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_pfcp_ie_f_teid_to_str_buf, ft) -} - -int osmo_pfcp_enc_to_str_f_teid(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_f_teid *f_teid = encode_from; - return osmo_pfcp_ie_f_teid_to_str_buf(buf, buflen, f_teid); -} - -int osmo_pfcp_dec_apply_action(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_apply_action *apply_action = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(1); - *apply_action = (struct osmo_pfcp_ie_apply_action){}; - memcpy(apply_action->bits, tlv->val, OSMO_MIN(tlv->len, sizeof(apply_action->bits))); - return 0; -} - -int osmo_pfcp_enc_apply_action(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_apply_action *apply_action = encode_from; - memcpy(msgb_put(tlv->dst, sizeof(apply_action->bits)), - apply_action->bits, sizeof(apply_action->bits)); - return 0; -} - -int osmo_pfcp_enc_to_str_apply_action(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_apply_action *apply_action = encode_from; - return osmo_pfcp_bits_to_str_buf(buf, buflen, apply_action->bits, osmo_pfcp_apply_action_strs); -} - -int osmo_pfcp_dec_network_inst(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_network_inst *network_inst = decode_to; - osmo_strlcpy(network_inst->str, (const char *)tlv->val, OSMO_MIN(sizeof(network_inst->str), tlv->len+1)); - return 0; -} - -int osmo_pfcp_enc_network_inst(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_network_inst *network_inst = encode_from; - unsigned int l = strlen(network_inst->str); - if (l) - memcpy(msgb_put(tlv->dst, l), network_inst->str, l); - return 0; -} - -int osmo_pfcp_enc_to_str_network_inst(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_network_inst *network_inst = encode_from; - return osmo_quote_str_buf3(buf, buflen, network_inst->str, - strnlen(network_inst->str, sizeof(network_inst->str))); -} - -int osmo_pfcp_dec_outer_header_creation(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_outer_header_creation *ohc = decode_to; - const uint8_t *pos; - bool gtp_u_udp_ipv4; - bool gtp_u_udp_ipv6; - bool udp_ipv4; - bool udp_ipv6; - bool ipv4; - bool ipv6; - bool c_tag; - bool s_tag; - - *ohc = (struct osmo_pfcp_ie_outer_header_creation){}; - - ENSURE_LENGTH_IS_AT_LEAST(2); - - memcpy(ohc->desc_bits, tlv->val, 2); - - gtp_u_udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4); - udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4); - ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV4); - gtp_u_udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6); - udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6); - ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV6); - c_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG); - s_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG); - - pos = tlv->val + 2; - if (gtp_u_udp_ipv4 || gtp_u_udp_ipv6) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("TEID", pos, 4); - ohc->teid_present = true; - ohc->teid = osmo_load32be(pos); - pos += 4; - } - if (gtp_u_udp_ipv4 || udp_ipv4 || ipv4) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv4 address", pos, 4); - ohc->ip_addr.v4_present = true; - osmo_sockaddr_from_octets(&ohc->ip_addr.v4, pos, 4); - pos += 4; - } - if (gtp_u_udp_ipv6 || udp_ipv6 || ipv6) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv6 address", pos, 16); - ohc->ip_addr.v6_present = true; - osmo_sockaddr_from_octets(&ohc->ip_addr.v6, pos, 16); - pos += 16; - } - if (udp_ipv4 || udp_ipv6) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("UDP port number", pos, 2); - ohc->port_number_present = true; - ohc->port_number = osmo_load16be(pos); - pos += 2; - } - if (c_tag) { - ohc->c_tag_present = true; - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("C-TAG", pos, 3); - ohc->c_tag_present = true; - ohc->c_tag = osmo_load32be_ext_2(pos, 3); - pos += 3; - } - if (s_tag) { - ohc->s_tag_present = true; - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("S-TAG", pos, 3); - ohc->s_tag_present = true; - ohc->s_tag = osmo_load32be_ext_2(pos, 3); - pos += 3; - } - - return 0; -} - -int osmo_pfcp_enc_outer_header_creation(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_outer_header_creation *ohc = encode_from; - bool gtp_u_udp_ipv4; - bool gtp_u_udp_ipv6; - bool udp_ipv4; - bool udp_ipv6; - bool ipv4; - bool ipv6; - bool c_tag; - bool s_tag; - - memcpy(msgb_put(tlv->dst, sizeof(ohc->desc_bits)), ohc->desc_bits, sizeof(ohc->desc_bits)); - - gtp_u_udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4); - udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4); - ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV4); - gtp_u_udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6); - udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6); - ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV6); - c_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG); - s_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG); - - if ((gtp_u_udp_ipv4 || gtp_u_udp_ipv6) != (ohc->teid_present)) - RETURN_ERROR(-EINVAL, "teid_present = %s does not match the description bits 0x%02x\n", - ohc->teid_present ? "true" : "false", - ohc->desc_bits[0]); - if (ohc->teid_present) - msgb_put_u32(tlv->dst, ohc->teid); - - if ((gtp_u_udp_ipv4 || udp_ipv4 || ipv4) != ohc->ip_addr.v4_present) - RETURN_ERROR(-EINVAL, "ipv4_addr_present = %s does not match the description bits 0x%02x\n", - ohc->ip_addr.v4_present ? "true" : "false", - ohc->desc_bits[0]); - if (ohc->ip_addr.v4_present) - osmo_sockaddr_to_octets(msgb_put(tlv->dst, 4), 4, &ohc->ip_addr.v4); - - if ((gtp_u_udp_ipv6 || udp_ipv6 || ipv6) != ohc->ip_addr.v6_present) - RETURN_ERROR(-EINVAL, "ipv6_addr_present = %s does not match the description bits 0x%02x\n", - ohc->ip_addr.v6_present ? "true" : "false", - ohc->desc_bits[0]); - if (ohc->ip_addr.v6_present) - osmo_sockaddr_to_octets(msgb_put(tlv->dst, 16), 16, &ohc->ip_addr.v6); - - if ((udp_ipv4 || udp_ipv6) != ohc->port_number_present) - RETURN_ERROR(-EINVAL, "port_number_present = %s does not match the description bits 0x%02x\n", - ohc->port_number_present ? "true" : "false", - ohc->desc_bits[0]); - if (ohc->port_number_present) - msgb_put_u16(tlv->dst, ohc->port_number); - - if (c_tag != ohc->c_tag_present) - RETURN_ERROR(-EINVAL, "c_tag_present = %s does not match the description bits 0x%02x%02x\n", - ohc->c_tag_present ? "true" : "false", - ohc->desc_bits[1], ohc->desc_bits[0]); - if (ohc->c_tag_present) - osmo_store32be_ext(ohc->c_tag, msgb_put(tlv->dst, 3), 3); - - if (s_tag != ohc->s_tag_present) - RETURN_ERROR(-EINVAL, "s_tag_present = %s does not match the description bits 0x%02x%02x\n", - ohc->s_tag_present ? "true" : "false", - ohc->desc_bits[1], ohc->desc_bits[0]); - if (ohc->s_tag_present) - osmo_store32be_ext(ohc->s_tag, msgb_put(tlv->dst, 3), 3); - - return 0; -} - -int osmo_pfcp_enc_to_str_outer_header_creation(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_outer_header_creation *ohc = encode_from; - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_APPEND(sb, osmo_pfcp_bits_to_str_buf, ohc->desc_bits, osmo_pfcp_outer_header_creation_strs); - if (ohc->teid_present) - OSMO_STRBUF_PRINTF(sb, ",TEID:0x%x", ohc->teid); - OSMO_STRBUF_APPEND(sb, ip_addrs_to_str_buf, &ohc->ip_addr); - if (ohc->port_number_present) - OSMO_STRBUF_PRINTF(sb, ",port:%u", ohc->port_number); - if (ohc->c_tag_present) - OSMO_STRBUF_PRINTF(sb, ",c-tag:%u", ohc->c_tag); - if (ohc->s_tag_present) - OSMO_STRBUF_PRINTF(sb, ",s-tag:%u", ohc->s_tag); - return sb.chars_needed; -} - -int osmo_pfcp_dec_activate_predefined_rules(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_activate_predefined_rules *activate_predefined_rules = decode_to; - osmo_strlcpy(activate_predefined_rules->str, (const char *)tlv->val, OSMO_MIN(sizeof(activate_predefined_rules->str), tlv->len+1)); - return 0; -} - -int osmo_pfcp_enc_activate_predefined_rules(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_activate_predefined_rules *activate_predefined_rules = encode_from; - unsigned int l = strlen(activate_predefined_rules->str); - if (l) - memcpy(msgb_put(tlv->dst, l), activate_predefined_rules->str, l); - return 0; -} - -int osmo_pfcp_enc_to_str_activate_predefined_rules(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_activate_predefined_rules *activate_predefined_rules = encode_from; - return osmo_quote_str_buf3(buf, buflen, activate_predefined_rules->str, - strnlen(activate_predefined_rules->str, sizeof(activate_predefined_rules->str))); -} - -int osmo_pfcp_dec_outer_header_removal(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_outer_header_removal *outer_header_removal = decode_to; - ENSURE_LENGTH_IS_AT_LEAST(1); - outer_header_removal->desc = tlv->val[0]; - - if (tlv->len > 1) { - outer_header_removal->gtp_u_extension_header_del_present = true; - memcpy(outer_header_removal->gtp_u_extension_header_del_bits, &tlv->val[1], - sizeof(outer_header_removal->gtp_u_extension_header_del_bits)); - } - return 0; -} - -int osmo_pfcp_enc_outer_header_removal(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_outer_header_removal *outer_header_removal = encode_from; - msgb_put_u8(tlv->dst, outer_header_removal->desc); - if (outer_header_removal->gtp_u_extension_header_del_present) { - memcpy(msgb_put(tlv->dst, sizeof(outer_header_removal->gtp_u_extension_header_del_bits)), - outer_header_removal->gtp_u_extension_header_del_bits, - sizeof(outer_header_removal->gtp_u_extension_header_del_bits)); - } - return 0; -} - -int osmo_pfcp_enc_to_str_outer_header_removal(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_outer_header_removal *outer_header_removal = encode_from; - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_PRINTF(sb, "%s", osmo_pfcp_outer_header_removal_desc_str(outer_header_removal->desc)); - if (outer_header_removal->gtp_u_extension_header_del_present) - OSMO_STRBUF_PRINTF(sb, ",ext-hdr-del:0x%x", outer_header_removal->gtp_u_extension_header_del_bits[0]); - return sb.chars_needed; -} - -int osmo_pfcp_dec_ue_ip_address(void *decoded_struct, void *decode_to, const struct osmo_gtlv_load *tlv) -{ - struct osmo_pfcp_ie_ue_ip_address *ue_ip_address = decode_to; - const uint8_t *pos; - uint8_t flags; - - pos = tlv->val; - - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("flags", pos, 1); - flags = *pos; - pos++; - - ue_ip_address->ipv6_prefix_length_present = flags & (1 << 6); - ue_ip_address->chv6 = flags & (1 << 5); - ue_ip_address->chv4 = flags & (1 << 4); - ue_ip_address->ipv6_prefix_delegation_bits_present = flags & (1 << 3); - ue_ip_address->ip_is_destination = flags & (1 << 2); - ue_ip_address->ip_addr.v4_present = flags & (1 << 1); - ue_ip_address->ip_addr.v6_present = flags & (1 << 0); - - if (ue_ip_address->ip_addr.v4_present) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv4 address", pos, 4); - osmo_sockaddr_from_octets(&ue_ip_address->ip_addr.v4, pos, 4); - pos += 4; - } - if (ue_ip_address->ip_addr.v6_present) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv6 address", pos, 16); - osmo_sockaddr_from_octets(&ue_ip_address->ip_addr.v6, pos, 16); - pos += 16; - } - - if (ue_ip_address->ipv6_prefix_delegation_bits_present) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv6 prefix delegation bits", pos, 1); - ue_ip_address->ipv6_prefix_delegation_bits = *pos; - pos++; - } - if (ue_ip_address->ipv6_prefix_length_present) { - ENSURE_REMAINING_LENGTH_IS_AT_LEAST("IPv6 prefix length", pos, 1); - ue_ip_address->ipv6_prefix_length = *pos; - pos++; - } - - return 0; -} - -int osmo_pfcp_enc_ue_ip_address(struct osmo_gtlv_put *tlv, const void *decoded_struct, const void *encode_from) -{ - const struct osmo_pfcp_ie_ue_ip_address *ue_ip_address = encode_from; - unsigned int l; - uint8_t flags; - - flags = 0 - | (ue_ip_address->ipv6_prefix_length_present ? (1 << 6) : 0) - | (ue_ip_address->chv6 ? (1 << 5) : 0) - | (ue_ip_address->chv4 ? (1 << 4) : 0) - | (ue_ip_address->ipv6_prefix_delegation_bits_present ? (1 << 3) : 0) - | (ue_ip_address->ip_is_destination ? (1 << 2) : 0) - | (ue_ip_address->ip_addr.v4_present ? (1 << 1) : 0) - | (ue_ip_address->ip_addr.v6_present ? (1 << 0) : 0) - ; - - msgb_put_u8(tlv->dst, flags); - - if (ue_ip_address->ip_addr.v4_present) { - if (ue_ip_address->ip_addr.v4.u.sin.sin_family != AF_INET) - RETURN_ERROR(-EINVAL, - "ue_ip_address IE indicates IPv4 address, but there is no ipv4_addr"); - l = sizeof(ue_ip_address->ip_addr.v4.u.sin.sin_addr); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &ue_ip_address->ip_addr.v4); - } - if (ue_ip_address->ip_addr.v6_present) { - if (ue_ip_address->ip_addr.v6.u.sin6.sin6_family != AF_INET6) - RETURN_ERROR(-EINVAL, - "ue_ip_address IE indicates IPv6 address, but there is no ipv6_addr"); - l = sizeof(ue_ip_address->ip_addr.v6.u.sin6.sin6_addr); - osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &ue_ip_address->ip_addr.v6); - } - - if (ue_ip_address->ipv6_prefix_delegation_bits_present) - msgb_put_u8(tlv->dst, ue_ip_address->ipv6_prefix_delegation_bits); - - if (ue_ip_address->ipv6_prefix_length_present) - msgb_put_u8(tlv->dst, ue_ip_address->ipv6_prefix_length); - - return 0; -} - -int osmo_pfcp_enc_to_str_ue_ip_address(char *buf, size_t buflen, const void *encode_from) -{ - const struct osmo_pfcp_ie_ue_ip_address *uia = encode_from; - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - if (uia->chv4) - OSMO_STRBUF_PRINTF(sb, "chv4"); - if (uia->chv6) - OSMO_STRBUF_PRINTF(sb, "%schv4", sb.pos ? "," : ""); - if (uia->ip_is_destination) - OSMO_STRBUF_PRINTF(sb, "%sdst", sb.pos ? "," : ""); - OSMO_STRBUF_APPEND(sb, ip_addrs_to_str_buf, &uia->ip_addr); - if (uia->ipv6_prefix_delegation_bits_present) - OSMO_STRBUF_PRINTF(sb, ",ipv6-prefix-deleg:%x", uia->ipv6_prefix_delegation_bits); - if (uia->ipv6_prefix_length_present) - OSMO_STRBUF_PRINTF(sb, ",ipv6-prefix-len:%u", uia->ipv6_prefix_length); - return sb.chars_needed; -} diff --git a/src/libosmo-pfcp/pfcp_msg.c b/src/libosmo-pfcp/pfcp_msg.c deleted file mode 100644 index 9d65efc..0000000 --- a/src/libosmo-pfcp/pfcp_msg.c +++ /dev/null @@ -1,540 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <errno.h> -#include <string.h> - -#include <osmocom/core/endian.h> -#include <osmocom/core/logging.h> -#include <osmocom/core/fsm.h> -#include <osmocom/core/use_count.h> -#include <osmocom/core/bitvec.h> - -#include <osmocom/pfcp/pfcp_msg.h> -#include <osmocom/gtlv/gtlv_dec_enc.h> - -/* Assumes presence of local variable osmo_pfcp_msg *m. m->log_ctx may be NULL. */ -#define RETURN_ERROR(RC, FMT, ARGS...) \ - do {\ - OSMO_ASSERT(m); \ - OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, FMT " (%d: %s)\n", ##ARGS, RC, strerror((RC) > 0 ? (RC) : -(RC))); \ - return RC; \ - } while (0) - -bool osmo_pfcp_msgtype_is_response(enum osmo_pfcp_message_type message_type) -{ - switch (message_type) { - case OSMO_PFCP_MSGT_HEARTBEAT_RESP: - case OSMO_PFCP_MSGT_PFD_MGMT_RESP: - case OSMO_PFCP_MSGT_ASSOC_SETUP_RESP: - case OSMO_PFCP_MSGT_ASSOC_UPDATE_RESP: - case OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP: - case OSMO_PFCP_MSGT_VERSION_NOT_SUPP_RESP: - case OSMO_PFCP_MSGT_NODE_REPORT_RESP: - case OSMO_PFCP_MSGT_SESSION_SET_DEL_RESP: - case OSMO_PFCP_MSGT_SESSION_EST_RESP: - case OSMO_PFCP_MSGT_SESSION_MOD_RESP: - case OSMO_PFCP_MSGT_SESSION_DEL_RESP: - case OSMO_PFCP_MSGT_SESSION_REP_RESP: - return true; - default: - return false; - } -} - -struct osmo_pfcp_header_common { -#if OSMO_IS_LITTLE_ENDIAN - uint8_t seid_present:1, - message_priority_present:1, - follow_on:1, - spare:2, - version:3; - uint8_t message_type; - uint16_t message_length; -#elif OSMO_IS_BIG_ENDIAN -/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ - uint8_t version:3, spare:2, follow_on:1, message_priority_present:1, seid_present:1; - uint8_t message_type; - uint16_t message_length; -#endif -} __attribute__ ((packed)); - -struct osmo_pfcp_header_no_seid { - struct osmo_pfcp_header_common c; - uint8_t sequence_nr[3]; - uint8_t spare; -} __attribute__ ((packed)); - -struct osmo_pfcp_header_seid { -#if OSMO_IS_LITTLE_ENDIAN - struct osmo_pfcp_header_common c; - uint64_t session_endpoint_identifier; - uint8_t sequence_nr[3]; - uint8_t message_priority:4, - spare:4; -#elif OSMO_IS_BIG_ENDIAN -/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ - struct osmo_pfcp_header_common c; - uint64_t session_endpoint_identifier; - uint8_t sequence_nr[3]; - uint8_t spare:4, message_priority:4; -#endif -} __attribute__ ((packed)); - -int osmo_pfcp_ie_node_id_from_osmo_sockaddr(struct osmo_pfcp_ie_node_id *node_id, const struct osmo_sockaddr *os) -{ - switch (os->u.sa.sa_family) { - case AF_INET: - node_id->type = OSMO_PFCP_NODE_ID_T_IPV4; - break; - case AF_INET6: - node_id->type = OSMO_PFCP_NODE_ID_T_IPV6; - break; - default: - return -ENOTSUP; - } - node_id->ip = *os; - return 0; -} - -int osmo_pfcp_ie_node_id_to_osmo_sockaddr(const struct osmo_pfcp_ie_node_id *node_id, struct osmo_sockaddr *os) -{ - switch (node_id->type) { - case OSMO_PFCP_NODE_ID_T_IPV4: - if (os->u.sa.sa_family != AF_INET) - return -EINVAL; - break; - case OSMO_PFCP_NODE_ID_T_IPV6: - if (os->u.sa.sa_family != AF_INET6) - return -EINVAL; - break; - default: - return -ENOTSUP; - } - *os = node_id->ip; - return 0; -} - -static int pfcp_header_set_message_length(struct osmo_pfcp_header_common *c, unsigned int header_and_payload_len) -{ - if (header_and_payload_len < sizeof(struct osmo_pfcp_header_common)) - return -EINVAL; - if (header_and_payload_len - sizeof(struct osmo_pfcp_header_common) > UINT16_MAX) - return -EMSGSIZE; - osmo_store16be(header_and_payload_len - sizeof(struct osmo_pfcp_header_common), - &c->message_length); - return 0; -} - -static unsigned int pfcp_header_get_message_length(const struct osmo_pfcp_header_common *c) -{ - unsigned int len = osmo_load16be(&c->message_length); - return len + sizeof(struct osmo_pfcp_header_common); -} - -/*! Encode and append the given PFCP header to a msgb. - * \param[out] msg message buffer to which to push the header. - * \param[in] to-be-encoded representation of PFCP header. */ -static int enc_pfcp_header(struct msgb *msg, const struct osmo_pfcp_msg *m) -{ - const struct osmo_pfcp_header_parsed *parsed = &m->h; - struct osmo_pfcp_header_seid *h_seid; - struct osmo_pfcp_header_no_seid *h_no_seid; - struct osmo_pfcp_header_common *c; - int rc; - - if (!parsed->seid_present) { - h_no_seid = (struct osmo_pfcp_header_no_seid *)msgb_put(msg, sizeof(struct osmo_pfcp_header_no_seid)); - c = &h_no_seid->c; - } else { - h_seid = (struct osmo_pfcp_header_seid *)msgb_put(msg, sizeof(struct osmo_pfcp_header_seid)); - c = &h_seid->c; - } - - *c = (struct osmo_pfcp_header_common){ - .version = parsed->version, - .message_priority_present = (parsed->priority_present ? 1 : 0), - .seid_present = (parsed->seid_present ? 1 : 0), - .message_type = parsed->message_type, - }; - - /* Put a preliminary length reflecting only the header, until it is updated later in osmo_pfcp_msg_encode(). */ - rc = pfcp_header_set_message_length(c, parsed->seid_present ? sizeof(struct osmo_pfcp_header_seid) - : sizeof(struct osmo_pfcp_header_no_seid)); - if (rc) - RETURN_ERROR(rc, "Problem with PFCP message length"); - - if (!parsed->seid_present) { - osmo_store32be_ext(parsed->sequence_nr, h_no_seid->sequence_nr, 3); - if (parsed->priority_present) - RETURN_ERROR(-EINVAL, "Message Priority can only be present when the SEID is also present"); - } else { - osmo_store64be(parsed->seid, &h_seid->session_endpoint_identifier); - osmo_store32be_ext(parsed->sequence_nr, h_seid->sequence_nr, 3); - if (parsed->priority_present) - h_seid->message_priority = parsed->priority; - } - - return 0; -} - -static void osmo_pfcp_msg_set_memb_ofs(struct osmo_pfcp_msg *m) -{ - const struct osmo_gtlv_coding *mc = osmo_pfcp_get_msg_coding(m->h.message_type); - m->ofs_cause = 0; - m->ofs_node_id = 0; - if (!mc) - return; - for (; !osmo_gtlv_coding_end(mc) && (m->ofs_cause == 0 || m->ofs_node_id == 0); mc++) { - if (mc->ti.tag == OSMO_PFCP_IEI_CAUSE) - m->ofs_cause = offsetof(struct osmo_pfcp_msg, ies) + mc->memb_ofs; - if (mc->ti.tag == OSMO_PFCP_IEI_NODE_ID) - m->ofs_node_id = offsetof(struct osmo_pfcp_msg, ies) + mc->memb_ofs; - } -}; - -/*! Decode a single PFCP message's header. - * - * If msg->l4h is non-NULL, decode at msgb_l4(msg). If l4h is NULL, decode at msgb_l3(msg). - * In case of bundled PFCP messages, decode only one message and return the offset to the next message in the buffer. - * Hence, to decode a message bundle, increment msg->l4h until all messages are decoded: - * - * msg->l4h = msg->l3h; - * while (msgb_l4len(msg)) { - * struct osmo_pfcp_msg m; - * struct osmo_gtlv_load tlv; - * int rc; - * rc = osmo_pfcp_msg_decode_header(&tlv, &m, msg); - * if (rc < 0) - * error(); - * msg->l4h += rc; - * - * if (osmo_pfcp_msg_decode_tlv(&m, &tlv)) - * error(); - * handle(&m); - * } - * - * \param[out] tlv Return TLV start pointer and length in tlv->src.*. - * \param[inout] m Place the decoded data in m->h; use m->ctx.* as logging context. - * \param[in] msg PFCP data to parse, possibly containing a PFCP message bundle. - * \return total single PFCP message length (<= data_len) on success, negative on error. - */ -int osmo_pfcp_msg_decode_header(struct osmo_gtlv_load *tlv, struct osmo_pfcp_msg *m, - const struct msgb *msg) -{ - struct osmo_pfcp_header_parsed *parsed = &m->h; - const uint8_t *pfcp_msg_data; - unsigned int pfcp_msg_data_len; - unsigned int header_len; - unsigned int message_length; - const struct osmo_pfcp_header_common *c; - - if (msg->l4h) { - pfcp_msg_data = msgb_l4(msg); - pfcp_msg_data_len = msgb_l4len(msg); - } else { - pfcp_msg_data = msgb_l3(msg); - pfcp_msg_data_len = msgb_l3len(msg); - } - - if (!pfcp_msg_data || !pfcp_msg_data_len) - RETURN_ERROR(-EINVAL, "No Layer 3 data in this message buffer"); - - if (pfcp_msg_data_len < sizeof(struct osmo_pfcp_header_common)) - RETURN_ERROR(-EINVAL, "Message too short for PFCP header: %u", pfcp_msg_data_len); - - c = (void *)pfcp_msg_data; - - header_len = (c->seid_present ? sizeof(struct osmo_pfcp_header_seid) : sizeof(struct osmo_pfcp_header_no_seid)); - if (pfcp_msg_data_len < header_len) - RETURN_ERROR(-EINVAL, "Message too short for PFCP header: %u", pfcp_msg_data_len); - - *parsed = (struct osmo_pfcp_header_parsed){ - .version = c->version, - .priority_present = (bool)c->message_priority_present, - .seid_present = (bool)c->seid_present, - .message_type = c->message_type, - }; - - m->is_response = osmo_pfcp_msgtype_is_response(parsed->message_type); - osmo_pfcp_msg_set_memb_ofs(m); - - message_length = pfcp_header_get_message_length(c); - if (message_length > pfcp_msg_data_len) - RETURN_ERROR(-EMSGSIZE, - "The header's indicated total message length %u is larger than the received data %u", - message_length, pfcp_msg_data_len); - - /* T16L16V payload data and len */ - *tlv = (struct osmo_gtlv_load){ - .cfg = &osmo_t16l16v_cfg, - .src = { - .data = pfcp_msg_data + header_len, - .len = message_length - header_len, - }, - }; - - if (c->follow_on) { - /* Another PFCP message should follow */ - if (pfcp_msg_data_len - message_length < sizeof(struct osmo_pfcp_header_common)) - OSMO_LOG_PFCP_MSG(m, LOGL_INFO, - "PFCP message indicates more messages should follow in the bundle," - " but remaining size %u is too short", pfcp_msg_data_len - message_length); - } else { - /* No more PFCP message should follow in the bundle */ - if (pfcp_msg_data_len > message_length) - OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "Surplus data after PFCP message: %u", - pfcp_msg_data_len - message_length); - } - - if (!parsed->seid_present) { - const struct osmo_pfcp_header_no_seid *h_no_seid = (void *)pfcp_msg_data; - parsed->sequence_nr = osmo_load32be_ext_2(h_no_seid->sequence_nr, 3); - if (parsed->priority_present) - RETURN_ERROR(-EINVAL, "Message Priority can only be present when the SEID is also present"); - } else { - const struct osmo_pfcp_header_seid *h_seid = (void *)pfcp_msg_data; - parsed->seid = osmo_load64be(&h_seid->session_endpoint_identifier); - parsed->sequence_nr = osmo_load32be_ext_2(h_seid->sequence_nr, 3); - if (parsed->priority_present) - parsed->priority = h_seid->message_priority; - } - - return message_length; -} - -void osmo_pfcp_msg_err_cb(void *data, void *decoded_struct, const char *file, int line, const char *fmt, ...) -{ - va_list ap; - if (log_check_level(DLPFCP, LOGL_ERROR)) { - char *errmsg; - - va_start(ap, fmt); - errmsg = talloc_vasprintf(OTC_SELECT, fmt, ap); - va_end(ap); - OSMO_LOG_PFCP_MSG_SRC((struct osmo_pfcp_msg *)data, LOGL_ERROR, file, line, "%s", errmsg); - } -} - -int osmo_pfcp_msg_decode_tlv(struct osmo_pfcp_msg *m, struct osmo_gtlv_load *tlv) -{ - return osmo_pfcp_ies_decode(&m->ies, tlv, false, m->h.message_type, osmo_pfcp_msg_err_cb, m, osmo_pfcp_iei_strs); -} - -static int osmo_pfcp_msg_encode_tlv(struct msgb *msg, const struct osmo_pfcp_msg *m) -{ - struct osmo_gtlv_put tlv = { - .cfg = &osmo_t16l16v_cfg, - .dst = msg, - }; - return osmo_pfcp_ies_encode(&tlv, &m->ies, m->h.message_type, osmo_pfcp_msg_err_cb, (void *)m, osmo_pfcp_iei_strs); -} - -/* Append the encoded PFCP message to the message buffer. - * - * If msg->l3h is NULL, point it at the start of the encoded message. - * Always point msg->l4h at the start of the newly encoded message. - * Hence, in a message bundle, msg->l3h always points at the first PFCP message, while msg->l4h always points at the - * last PFCP message. - * - * When adding a PFCP message to a bundle, set the Follow On (FO) flag of the previously last message to 1, and of the - * newly encoded, now last message as 0. - * - * To log errors to a specific osmo_fsm_inst, point m->log_ctx to that instance before calling this function. Otherwise - * set log_ctx = NULL. - * - * \return 0 on success, negative on error. */ -int osmo_pfcp_msg_encode(struct msgb *msg, const struct osmo_pfcp_msg *m) -{ - struct osmo_pfcp_header_common *c; - int rc; - - /* Forming a bundle? If yes, set the Follow On flag of the currently last message to 1 */ - if (msg->l4h && msgb_l4len(msg)) { - c = msgb_l4(msg); - c->follow_on = 1; - } - /* Make sure l3h points at the first PFCP message in a message bundle */ - if (!msg->l3h) - msg->l3h = msg->tail; - /* Make sure l4h points at the last PFCP message in a message bundle */ - msg->l4h = msg->tail; - c = (void *)msg->tail; - - rc = enc_pfcp_header(msg, m); - if (rc) - return rc; - - rc = osmo_pfcp_msg_encode_tlv(msg, m); - if (rc) - return rc; - - /* Update the header's message_length */ - rc = pfcp_header_set_message_length(c, msgb_l4len(msg)); - if (rc) - RETURN_ERROR(rc, "Problem with PFCP message length"); - return 0; -} - -static int osmo_pfcp_msg_destructor(struct osmo_pfcp_msg *m); - -static struct osmo_pfcp_msg *_osmo_pfcp_msg_alloc(void *ctx, const struct osmo_sockaddr *remote_addr) -{ - struct osmo_pfcp_msg *m = talloc(ctx, struct osmo_pfcp_msg); - *m = (struct osmo_pfcp_msg){ - .remote_addr = *remote_addr, - .h = { - .version = 1, - }, - }; - talloc_set_destructor(m, osmo_pfcp_msg_destructor); - return m; -} - -struct osmo_pfcp_msg *osmo_pfcp_msg_alloc_rx(void *ctx, const struct osmo_sockaddr *remote_addr) -{ - struct osmo_pfcp_msg *rx = _osmo_pfcp_msg_alloc(ctx, remote_addr); - rx->rx = true; - return rx; -} - -struct osmo_pfcp_msg *osmo_pfcp_msg_alloc_tx(void *ctx, const struct osmo_sockaddr *remote_addr, - const struct osmo_pfcp_ie_node_id *node_id, - const struct osmo_pfcp_msg *in_reply_to, - enum osmo_pfcp_message_type msg_type) -{ - struct osmo_pfcp_msg *tx; - if (!remote_addr && in_reply_to) - remote_addr = &in_reply_to->remote_addr; - OSMO_ASSERT(remote_addr); - tx = _osmo_pfcp_msg_alloc(ctx, remote_addr); - tx->is_response = osmo_pfcp_msgtype_is_response(msg_type); - tx->h.message_type = msg_type; - if (in_reply_to) - tx->h.sequence_nr = in_reply_to->h.sequence_nr; - osmo_pfcp_msg_set_memb_ofs(tx); - - /* Write the local node id data to the correct tx->ies.* member. */ - if (node_id) { - struct osmo_pfcp_ie_node_id *tx_node_id = osmo_pfcp_msg_node_id(tx); - if (tx_node_id) - *tx_node_id = *node_id; - } - return tx; -} - -static int osmo_pfcp_msg_destructor(struct osmo_pfcp_msg *m) -{ - OSMO_LOG_PFCP_MSG(m, LOGL_DEBUG, "discarding\n"); - if (m->ctx.session_use_count) - osmo_use_count_get_put(m->ctx.session_use_count, m->ctx.session_use_token, -1); - m->ctx.session_fi = NULL; - m->ctx.session_use_count = NULL; - m->ctx.session_use_token = NULL; - - if (m->ctx.peer_use_count) - osmo_use_count_get_put(m->ctx.peer_use_count, m->ctx.peer_use_token, -1); - m->ctx.peer_fi = NULL; - m->ctx.peer_use_count = NULL; - m->ctx.peer_use_token = NULL; - return 0; -} - -void osmo_pfcp_msg_free(struct osmo_pfcp_msg *m) -{ - if (!m) - return; - talloc_free(m); -} - -uint32_t osmo_pfcp_next_seq_nr(uint32_t *next_seq_nr_state) -{ - (*next_seq_nr_state)++; - (*next_seq_nr_state) &= 0xffffff; - /* Avoid seq == 0, so that it doesn't look like the value is missing. */ - if (!(*next_seq_nr_state)) - (*next_seq_nr_state)++; - return *next_seq_nr_state; -} - -uint64_t osmo_pfcp_next_seid(uint64_t *next_seid_state) -{ - (*next_seid_state)++; - /* Avoid SEID == 0, which is sent in Session Establishment Request before a remote SEID is known. */ - if (!*next_seid_state) - (*next_seid_state)++; - return *next_seid_state; -} - -int osmo_pfcp_ip_addrs_set(struct osmo_pfcp_ip_addrs *dst, const struct osmo_sockaddr *addr) -{ - switch (addr->u.sas.ss_family) { - case AF_INET: - dst->v4_present = true; - dst->v4 = *addr; - return 0; - case AF_INET6: - dst->v6_present = true; - dst->v6 = *addr; - return 0; - default: - return -ENOTSUP; - } -} - -/* If a osmo_fsm_inst placed in m->ctx deallocates before the osmo_pfcp_msg, call this function, to make sure to avoid - * use after free. Alternatively use m->ctx.*_use_count to make sure the FSM inst does not deallocate before the - * osmo_pfcp_msg is discarded from the resend queue. */ -void osmo_pfcp_msg_invalidate_ctx(struct osmo_pfcp_msg *m, struct osmo_fsm_inst *deleted_fi) -{ - if (m->ctx.session_fi == deleted_fi) { - m->ctx.session_fi = NULL; - m->ctx.session_use_count = NULL; - m->ctx.session_use_token = NULL; - } - if (m->ctx.peer_fi == deleted_fi) { - m->ctx.peer_fi = NULL; - m->ctx.peer_use_count = NULL; - m->ctx.peer_use_token = NULL; - } -} - -int osmo_pfcp_msg_to_str_buf(char *buf, size_t buflen, const struct osmo_pfcp_msg *m) -{ - struct osmo_strbuf sb = { .buf = buf, .len = buflen }; - OSMO_STRBUF_PRINTF(sb, "PFCPv%u %s hdr={seq=%u", m->h.version, osmo_pfcp_message_type_str(m->h.message_type), - m->h.sequence_nr); - if (m->h.priority_present) - OSMO_STRBUF_PRINTF(sb, " prio=%u", m->h.priority); - if (m->h.seid_present) - OSMO_STRBUF_PRINTF(sb, " SEID=0x%"PRIx64, m->h.seid); - OSMO_STRBUF_PRINTF(sb, "} ies={"); - OSMO_STRBUF_APPEND(sb, osmo_pfcp_ies_encode_to_str, &m->ies, m->h.message_type, osmo_pfcp_iei_strs); - OSMO_STRBUF_PRINTF(sb, " }"); - return sb.chars_needed; -} - -char *osmo_pfcp_msg_to_str_c(void *ctx, const struct osmo_pfcp_msg *m) -{ - OSMO_NAME_C_IMPL(ctx, 256, "ERROR", osmo_pfcp_msg_to_str_buf, m) -} diff --git a/src/libosmo-pfcp/pfcp_strs.c b/src/libosmo-pfcp/pfcp_strs.c deleted file mode 100644 index bd53aa0..0000000 --- a/src/libosmo-pfcp/pfcp_strs.c +++ /dev/null @@ -1,492 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <osmocom/pfcp/pfcp_strs.h> - -const struct value_string osmo_pfcp_message_type_strs[] = { - { OSMO_PFCP_MSGT_HEARTBEAT_REQ, "HEARTBEAT_REQ" }, - { OSMO_PFCP_MSGT_HEARTBEAT_RESP, "HEARTBEAT_RESP" }, - { OSMO_PFCP_MSGT_PFD_MGMT_REQ, "PFD_MGMT_REQ" }, - { OSMO_PFCP_MSGT_PFD_MGMT_RESP, "PFD_MGMT_RESP" }, - { OSMO_PFCP_MSGT_ASSOC_SETUP_REQ, "ASSOC_SETUP_REQ" }, - { OSMO_PFCP_MSGT_ASSOC_SETUP_RESP, "ASSOC_SETUP_RESP" }, - { OSMO_PFCP_MSGT_ASSOC_UPDATE_REQ, "ASSOC_UPDATE_REQ" }, - { OSMO_PFCP_MSGT_ASSOC_UPDATE_RESP, "ASSOC_UPDATE_RESP" }, - { OSMO_PFCP_MSGT_ASSOC_RELEASE_REQ, "ASSOC_RELEASE_REQ" }, - { OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP, "ASSOC_RELEASE_RESP" }, - { OSMO_PFCP_MSGT_VERSION_NOT_SUPP_RESP, "VERSION_NOT_SUPP_RESP" }, - { OSMO_PFCP_MSGT_NODE_REPORT_REQ, "NODE_REPORT_REQ" }, - { OSMO_PFCP_MSGT_NODE_REPORT_RESP, "NODE_REPORT_RESP" }, - { OSMO_PFCP_MSGT_SESSION_SET_DEL_REQ, "SESSION_SET_DEL_REQ" }, - { OSMO_PFCP_MSGT_SESSION_SET_DEL_RESP, "SESSION_SET_DEL_RESP" }, - { OSMO_PFCP_MSGT_SESSION_EST_REQ, "SESSION_EST_REQ" }, - { OSMO_PFCP_MSGT_SESSION_EST_RESP, "SESSION_EST_RESP" }, - { OSMO_PFCP_MSGT_SESSION_MOD_REQ, "SESSION_MOD_REQ" }, - { OSMO_PFCP_MSGT_SESSION_MOD_RESP, "SESSION_MOD_RESP" }, - { OSMO_PFCP_MSGT_SESSION_DEL_REQ, "SESSION_DEL_REQ" }, - { OSMO_PFCP_MSGT_SESSION_DEL_RESP, "SESSION_DEL_RESP" }, - { OSMO_PFCP_MSGT_SESSION_REP_REQ, "SESSION_REP_REQ" }, - { OSMO_PFCP_MSGT_SESSION_REP_RESP, "SESSION_REP_RESP" }, - { 0 } -}; - -const struct value_string osmo_pfcp_iei_strs[] = { - { OSMO_PFCP_IEI_CREATE_PDR, "Create PDR" }, - { OSMO_PFCP_IEI_PDI, "PDI" }, - { OSMO_PFCP_IEI_CREATE_FAR, "Create FAR" }, - { OSMO_PFCP_IEI_FORW_PARAMS, "Forwarding Parameters" }, - { OSMO_PFCP_IEI_DUPL_PARAMS, "Duplicating Parameters" }, - { OSMO_PFCP_IEI_CREATE_URR, "Create URR" }, - { OSMO_PFCP_IEI_CREATE_QER, "Create QER" }, - { OSMO_PFCP_IEI_CREATED_PDR, "Created PDR" }, - { OSMO_PFCP_IEI_UPD_PDR, "Update PDR" }, - { OSMO_PFCP_IEI_UPD_FAR, "Update FAR" }, - { OSMO_PFCP_IEI_UPD_FORW_PARAMS, "Update Forwarding Parameters" }, - { OSMO_PFCP_IEI_UPD_BAR_SESS_REP_RESP, "Update BAR (PFCP Session Report Response)" }, - { OSMO_PFCP_IEI_UPD_URR, "Update URR" }, - { OSMO_PFCP_IEI_UPD_QER, "Update QER" }, - { OSMO_PFCP_IEI_REMOVE_PDR, "Remove PDR" }, - { OSMO_PFCP_IEI_REMOVE_FAR, "Remove FAR" }, - { OSMO_PFCP_IEI_REMOVE_URR, "Remove URR" }, - { OSMO_PFCP_IEI_REMOVE_QER, "Remove QER" }, - { OSMO_PFCP_IEI_CAUSE, "Cause" }, - { OSMO_PFCP_IEI_SOURCE_IFACE, "Source Interface" }, - { OSMO_PFCP_IEI_F_TEID, "F-TEID" }, - { OSMO_PFCP_IEI_NETWORK_INST, "Network Instance" }, - { OSMO_PFCP_IEI_SDF_FILTER, "SDF Filter" }, - { OSMO_PFCP_IEI_APPLICATION_ID, "Application ID" }, - { OSMO_PFCP_IEI_GATE_STATUS, "Gate Status" }, - { OSMO_PFCP_IEI_MBR, "MBR" }, - { OSMO_PFCP_IEI_GBR, "GBR" }, - { OSMO_PFCP_IEI_QER_CORRELATION_ID, "QER Correlation ID" }, - { OSMO_PFCP_IEI_PRECEDENCE, "Precedence" }, - { OSMO_PFCP_IEI_TRANSPORT_LEVEL_MARKING, "Transport Level Marking" }, - { OSMO_PFCP_IEI_VOLUME_THRESH, "Volume Threshold" }, - { OSMO_PFCP_IEI_TIME_THRESH, "Time Threshold" }, - { OSMO_PFCP_IEI_MONITORING_TIME, "Monitoring Time" }, - { OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_THRESH, "Subsequent Volume Threshold" }, - { OSMO_PFCP_IEI_SUBSEQUENT_TIME_THRESH, "Subsequent Time Threshold" }, - { OSMO_PFCP_IEI_INACT_DETECTION_TIME, "Inactivity Detection Time" }, - { OSMO_PFCP_IEI_REPORTING_TRIGGERS, "Reporting Triggers" }, - { OSMO_PFCP_IEI_REDIRECT_INFO, "Redirect Information" }, - { OSMO_PFCP_IEI_REP_TYPE, "Report Type" }, - { OSMO_PFCP_IEI_OFFENDING_IE, "Offending IE" }, - { OSMO_PFCP_IEI_FORW_POLICY, "Forwarding Policy" }, - { OSMO_PFCP_IEI_DESTINATION_IFACE, "Destination Interface" }, - { OSMO_PFCP_IEI_UP_FUNCTION_FEATURES, "UP Function Features" }, - { OSMO_PFCP_IEI_APPLY_ACTION, "Apply Action" }, - { OSMO_PFCP_IEI_DL_DATA_SERVICE_INFO, "Downlink Data Service Information" }, - { OSMO_PFCP_IEI_DL_DATA_NOTIFICATION_DELAY, "Downlink Data Notification Delay" }, - { OSMO_PFCP_IEI_DL_BUFF_DURATION, "DL Buffering Duration" }, - { OSMO_PFCP_IEI_DL_BUFF_SUGGESTED_PACKET_COUNT, "DL Buffering Suggested Packet Count" }, - { OSMO_PFCP_IEI_PFCPSMREQ_FLAGS, "PFCPSMReq-Flags" }, - { OSMO_PFCP_IEI_PFCPSRRSP_FLAGS, "PFCPSRRsp-Flags" }, - { OSMO_PFCP_IEI_LOAD_CTRL_INFO, "Load Control Information" }, - { OSMO_PFCP_IEI_SEQUENCE_NUMBER, "Sequence Number" }, - { OSMO_PFCP_IEI_METRIC, "Metric" }, - { OSMO_PFCP_IEI_OVERLOAD_CTRL_INFO, "Overload Control Information" }, - { OSMO_PFCP_IEI_TIMER, "Timer" }, - { OSMO_PFCP_IEI_PDR_ID, "PDR ID" }, - { OSMO_PFCP_IEI_F_SEID, "F-SEID" }, - { OSMO_PFCP_IEI_APPLICATION_IDS_PFDS, "Application ID's PFDs" }, - { OSMO_PFCP_IEI_PFD_CONTEXT, "PFD context" }, - { OSMO_PFCP_IEI_NODE_ID, "Node ID" }, - { OSMO_PFCP_IEI_PFD_CONTENTS, "PFD contents" }, - { OSMO_PFCP_IEI_MEAS_METHOD, "Measurement Method" }, - { OSMO_PFCP_IEI_USAGE_REP_TRIGGER, "Usage Report Trigger" }, - { OSMO_PFCP_IEI_MEAS_PERIOD, "Measurement Period" }, - { OSMO_PFCP_IEI_FQ_CSID, "FQ-CSID" }, - { OSMO_PFCP_IEI_VOLUME_MEAS, "Volume Measurement" }, - { OSMO_PFCP_IEI_DURATION_MEAS, "Duration Measurement" }, - { OSMO_PFCP_IEI_APPLICATION_DETECTION_INFO, "Application Detection Information" }, - { OSMO_PFCP_IEI_TIME_OF_FIRST_PACKET, "Time of First Packet" }, - { OSMO_PFCP_IEI_TIME_OF_LAST_PACKET, "Time of Last Packet" }, - { OSMO_PFCP_IEI_QUOTA_HOLDING_TIME, "Quota Holding Time" }, - { OSMO_PFCP_IEI_DROPPED_DL_TRAFFIC_THRESH, "Dropped DL Traffic Threshold" }, - { OSMO_PFCP_IEI_VOLUME_QUOTA, "Volume Quota" }, - { OSMO_PFCP_IEI_TIME_QUOTA, "Time Quota" }, - { OSMO_PFCP_IEI_START_TIME, "Start Time" }, - { OSMO_PFCP_IEI_END_TIME, "End Time" }, - { OSMO_PFCP_IEI_QUERY_URR, "Query URR" }, - { OSMO_PFCP_IEI_USAGE_REP_SESS_MOD_RESP, "Usage Report (Session Modification Response)" }, - { OSMO_PFCP_IEI_USAGE_REP_SESS_DEL_RESP, "Usage Report (Session Deletion Response)" }, - { OSMO_PFCP_IEI_USAGE_REP_SESS_REP_REQ, "Usage Report (Session Report Request)" }, - { OSMO_PFCP_IEI_URR_ID, "URR ID" }, - { OSMO_PFCP_IEI_LINKED_URR_ID, "Linked URR ID" }, - { OSMO_PFCP_IEI_DL_DATA_REP, "Downlink Data Report" }, - { OSMO_PFCP_IEI_OUTER_HEADER_CREATION, "Outer Header Creation" }, - { OSMO_PFCP_IEI_CREATE_BAR, "Create BAR" }, - { OSMO_PFCP_IEI_UPD_BAR_SESS_MOD_REQ, "Update BAR (Session Modification Request)" }, - { OSMO_PFCP_IEI_REMOVE_BAR, "Remove BAR" }, - { OSMO_PFCP_IEI_BAR_ID, "BAR ID" }, - { OSMO_PFCP_IEI_CP_FUNCTION_FEATURES, "CP Function Features" }, - { OSMO_PFCP_IEI_USAGE_INFO, "Usage Information" }, - { OSMO_PFCP_IEI_APPLICATION_INST_ID, "Application Instance ID" }, - { OSMO_PFCP_IEI_FLOW_INFO, "Flow Information" }, - { OSMO_PFCP_IEI_UE_IP_ADDRESS, "UE IP Address" }, - { OSMO_PFCP_IEI_PACKET_RATE, "Packet Rate" }, - { OSMO_PFCP_IEI_OUTER_HEADER_REMOVAL, "Outer Header Removal" }, - { OSMO_PFCP_IEI_RECOVERY_TIME_STAMP, "Recovery Time Stamp" }, - { OSMO_PFCP_IEI_DL_FLOW_LEVEL_MARKING, "DL Flow Level Marking" }, - { OSMO_PFCP_IEI_HEADER_ENRICHMENT, "Header Enrichment" }, - { OSMO_PFCP_IEI_ERROR_IND_REP, "Error Indication Report" }, - { OSMO_PFCP_IEI_MEAS_INFO, "Measurement Information" }, - { OSMO_PFCP_IEI_NODE_REP_TYPE, "Node Report Type" }, - { OSMO_PFCP_IEI_USER_PLANE_PATH_FAILURE_REP, "User Plane Path Failure Report" }, - { OSMO_PFCP_IEI_REMOTE_GTP_U_PEER, "Remote GTP-U Peer" }, - { OSMO_PFCP_IEI_UR_SEQN, "UR-SEQN" }, - { OSMO_PFCP_IEI_UPD_DUPL_PARAMS, "Update Duplicating Parameters" }, - { OSMO_PFCP_IEI_ACTIVATE_PREDEFINED_RULES, "Activate Predefined Rules" }, - { OSMO_PFCP_IEI_DEACTIVATE_PREDEFINED_RULES, "Deactivate Predefined Rules" }, - { OSMO_PFCP_IEI_FAR_ID, "FAR ID" }, - { OSMO_PFCP_IEI_QER_ID, "QER ID" }, - { OSMO_PFCP_IEI_OCI_FLAGS, "OCI Flags" }, - { OSMO_PFCP_IEI_PFCP_ASSOC_RELEASE_REQ, "PFCP Association Release Request" }, - { OSMO_PFCP_IEI_GRACEFUL_RELEASE_PERIOD, "Graceful Release Period" }, - { OSMO_PFCP_IEI_PDN_TYPE, "PDN Type" }, - { OSMO_PFCP_IEI_FAILED_RULE_ID, "Failed Rule ID" }, - { OSMO_PFCP_IEI_TIME_QUOTA_MECHANISM, "Time Quota Mechanism" }, - { OSMO_PFCP_IEI_RESERVED, "Reserved" }, - { OSMO_PFCP_IEI_USER_PLANE_INACT_TIMER, "User Plane Inactivity Timer" }, - { OSMO_PFCP_IEI_AGGREGATED_URRS, "Aggregated URRs" }, - { OSMO_PFCP_IEI_MULTIPLIER, "Multiplier" }, - { OSMO_PFCP_IEI_AGGREGATED_URR_ID, "Aggregated URR ID" }, - { OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_QUOTA, "Subsequent Volume Quota" }, - { OSMO_PFCP_IEI_SUBSEQUENT_TIME_QUOTA, "Subsequent Time Quota" }, - { OSMO_PFCP_IEI_RQI, "RQI" }, - { OSMO_PFCP_IEI_QFI, "QFI" }, - { OSMO_PFCP_IEI_QUERY_URR_REFERENCE, "Query URR Reference" }, - { OSMO_PFCP_IEI_ADDITIONAL_USAGE_REPS_INFO, "Additional Usage Reports Information" }, - { OSMO_PFCP_IEI_CREATE_TRAFFIC_ENDPOINT, "Create Traffic Endpoint" }, - { OSMO_PFCP_IEI_CREATED_TRAFFIC_ENDPOINT, "Created Traffic Endpoint" }, - { OSMO_PFCP_IEI_UPD_TRAFFIC_ENDPOINT, "Update Traffic Endpoint" }, - { OSMO_PFCP_IEI_REMOVE_TRAFFIC_ENDPOINT, "Remove Traffic Endpoint" }, - { OSMO_PFCP_IEI_TRAFFIC_ENDPOINT_ID, "Traffic Endpoint ID" }, - { OSMO_PFCP_IEI_ETHERNET_PACKET_FILTER, "Ethernet Packet Filter" }, - { OSMO_PFCP_IEI_MAC_ADDRESS, "MAC address" }, - { OSMO_PFCP_IEI_C_TAG, "C-TAG" }, - { OSMO_PFCP_IEI_S_TAG, "S-TAG" }, - { OSMO_PFCP_IEI_ETHERTYPE, "Ethertype" }, - { OSMO_PFCP_IEI_PROXYING, "Proxying" }, - { OSMO_PFCP_IEI_ETHERNET_FILTER_ID, "Ethernet Filter ID" }, - { OSMO_PFCP_IEI_ETHERNET_FILTER_PROPERTIES, "Ethernet Filter Properties" }, - { OSMO_PFCP_IEI_SUGGESTED_BUFF_PACKETS_COUNT, "Suggested Buffering Packets Count" }, - { OSMO_PFCP_IEI_USER_ID, "User ID" }, - { OSMO_PFCP_IEI_ETHERNET_PDU_SESS_INFO, "Ethernet PDU Session Information" }, - { OSMO_PFCP_IEI_ETHERNET_TRAFFIC_INFO, "Ethernet Traffic Information" }, - { OSMO_PFCP_IEI_MAC_ADDRS_DETECTED, "MAC Addresses Detected" }, - { OSMO_PFCP_IEI_MAC_ADDRS_REMOVED, "MAC Addresses Removed" }, - { OSMO_PFCP_IEI_ETHERNET_INACT_TIMER, "Ethernet Inactivity Timer" }, - { OSMO_PFCP_IEI_ADDITIONAL_MONITORING_TIME, "Additional Monitoring Time" }, - { OSMO_PFCP_IEI_EVENT_QUOTA, "Event Quota" }, - { OSMO_PFCP_IEI_EVENT_THRESH, "Event Threshold" }, - { OSMO_PFCP_IEI_SUBSEQUENT_EVENT_QUOTA, "Subsequent Event Quota" }, - { OSMO_PFCP_IEI_SUBSEQUENT_EVENT_THRESH, "Subsequent Event Threshold" }, - { OSMO_PFCP_IEI_TRACE_INFO, "Trace Information" }, - { OSMO_PFCP_IEI_FRAMED_ROUTE, "Framed-Route" }, - { OSMO_PFCP_IEI_FRAMED_ROUTING, "Framed-Routing" }, - { OSMO_PFCP_IEI_FRAMED_IPV6_ROUTE, "Framed-IPv6-Route" }, - { OSMO_PFCP_IEI_TIME_STAMP, "Time Stamp" }, - { OSMO_PFCP_IEI_AVERAGING_WINDOW, "Averaging Window" }, - { OSMO_PFCP_IEI_PAGING_POLICY_INDICATOR, "Paging Policy Indicator" }, - { OSMO_PFCP_IEI_APN_DNN, "APN/DNN" }, - { OSMO_PFCP_IEI_3GPP_IFACE_TYPE, "3GPP Interface Type" }, - { OSMO_PFCP_IEI_PFCPSRREQ_FLAGS, "PFCPSRReq-Flags" }, - { OSMO_PFCP_IEI_PFCPAUREQ_FLAGS, "PFCPAUReq-Flags" }, - { OSMO_PFCP_IEI_ACTIVATION_TIME, "Activation Time" }, - { OSMO_PFCP_IEI_DEACTIVATION_TIME, "Deactivation Time" }, - { OSMO_PFCP_IEI_CREATE_MAR, "Create MAR" }, - { OSMO_PFCP_IEI_3GPP_ACCESS_FORW_ACTION_INFO, "3GPP Access Forwarding Action Information" }, - { OSMO_PFCP_IEI_NON_3GPP_ACCESS_FORW_ACTION_INFO, "Non-3GPP Access Forwarding Action Information" }, - { OSMO_PFCP_IEI_REMOVE_MAR, "Remove MAR" }, - { OSMO_PFCP_IEI_UPD_MAR, "Update MAR" }, - { OSMO_PFCP_IEI_MAR_ID, "MAR ID" }, - { OSMO_PFCP_IEI_STEERING_FUNCTIONALITY, "Steering Functionality" }, - { OSMO_PFCP_IEI_STEERING_MODE, "Steering Mode" }, - { OSMO_PFCP_IEI_WEIGHT, "Weight" }, - { OSMO_PFCP_IEI_PRIORITY, "Priority" }, - { OSMO_PFCP_IEI_UPD_3GPP_ACCESS_FORW_ACTION_INFO, "Update 3GPP Access Forwarding Action Information" }, - { OSMO_PFCP_IEI_UPD_NON_3GPP_ACCESS_FORW_ACTION_INFO, "Update Non 3GPP Access Forwarding Action Information" }, - { OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_IDENTITY, "UE IP address Pool Identity" }, - { OSMO_PFCP_IEI_ALTERNATIVE_SMF_IP_ADDRESS, "Alternative SMF IP Address" }, - { OSMO_PFCP_IEI_PACKET_REPLICATION_AND_DETECTION_CARRY_ON_INFO, "Packet Replication and Detection Carry-On Information" }, - { OSMO_PFCP_IEI_SMF_SET_ID, "SMF Set ID" }, - { OSMO_PFCP_IEI_QUOTA_VALIDITY_TIME, "Quota Validity Time" }, - { OSMO_PFCP_IEI_NUMBER_OF_REPS, "Number of Reports" }, - { OSMO_PFCP_IEI_PFCP_SESS_RETENTION_INFO_IN_ASSOC_SETUP_REQ, "PFCP Session Retention Information (within PFCP Association Setup Request)" }, - { OSMO_PFCP_IEI_PFCPASRSP_FLAGS, "PFCPASRsp-Flags" }, - { OSMO_PFCP_IEI_CP_ENTITY_IP_ADDRESS, "CP PFCP Entity IP Address" }, - { OSMO_PFCP_IEI_PFCPSEREQ_FLAGS, "PFCPSEReq-Flags" }, - { OSMO_PFCP_IEI_USER_PLANE_PATH_RECOVERY_REP, "User Plane Path Recovery Report" }, - { OSMO_PFCP_IEI_IP_MULTICAST_ADDR_INFO_IN_SESS_EST_REQ, "IP Multicast Addressing Info within PFCP Session Establishment Request" }, - { OSMO_PFCP_IEI_JOIN_IP_MULTICAST_INFO_IE_IN_USAGE_REP, "Join IP Multicast Information IE within Usage Report" }, - { OSMO_PFCP_IEI_LEAVE_IP_MULTICAST_INFO_IE_IN_USAGE_REP, "Leave IP Multicast Information IE within Usage Report" }, - { OSMO_PFCP_IEI_IP_MULTICAST_ADDRESS, "IP Multicast Address" }, - { OSMO_PFCP_IEI_SOURCE_IP_ADDRESS, "Source IP Address" }, - { OSMO_PFCP_IEI_PACKET_RATE_STATUS, "Packet Rate Status" }, - { OSMO_PFCP_IEI_CREATE_BRIDGE_INFO_FOR_TSC, "Create Bridge Info for TSC" }, - { OSMO_PFCP_IEI_CREATED_BRIDGE_INFO_FOR_TSC, "Created Bridge Info for TSC" }, - { OSMO_PFCP_IEI_DS_TT_PORT_NUMBER, "DS-TT Port Number" }, - { OSMO_PFCP_IEI_NW_TT_PORT_NUMBER, "NW-TT Port Number" }, - { OSMO_PFCP_IEI_TSN_BRIDGE_ID, "TSN Bridge ID" }, - { OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_REQ, "TSC Management Information IE within PFCP Session Modification Request" }, - { OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_RESP, "TSC Management Information IE within PFCP Session Modification Response" }, - { OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_REP_REQ, "TSC Management Information IE within PFCP Session Report Request" }, - { OSMO_PFCP_IEI_PORT_MGMT_INFO_CONTAINER, "Port Management Information Container" }, - { OSMO_PFCP_IEI_CLOCK_DRIFT_CTRL_INFO, "Clock Drift Control Information" }, - { OSMO_PFCP_IEI_REQUESTED_CLOCK_DRIFT_INFO, "Requested Clock Drift Information" }, - { OSMO_PFCP_IEI_CLOCK_DRIFT_REP, "Clock Drift Report" }, - { OSMO_PFCP_IEI_TSN_TIME_DOMAIN_NUMBER, "TSN Time Domain Number" }, - { OSMO_PFCP_IEI_TIME_OFFSET_THRESH, "Time Offset Threshold" }, - { OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_THRESH, "Cumulative rateRatio Threshold" }, - { OSMO_PFCP_IEI_TIME_OFFSET_MEAS, "Time Offset Measurement" }, - { OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_MEAS, "Cumulative rateRatio Measurement" }, - { OSMO_PFCP_IEI_REMOVE_SRR, "Remove SRR" }, - { OSMO_PFCP_IEI_CREATE_SRR, "Create SRR" }, - { OSMO_PFCP_IEI_UPD_SRR, "Update SRR" }, - { OSMO_PFCP_IEI_SESS_REP, "Session Report" }, - { OSMO_PFCP_IEI_SRR_ID, "SRR ID" }, - { OSMO_PFCP_IEI_ACCESS_AVAIL_CTRL_INFO, "Access Availability Control Information" }, - { OSMO_PFCP_IEI_REQUESTED_ACCESS_AVAIL_INFO, "Requested Access Availability Information" }, - { OSMO_PFCP_IEI_ACCESS_AVAIL_REP, "Access Availability Report" }, - { OSMO_PFCP_IEI_ACCESS_AVAIL_INFO, "Access Availability Information" }, - { OSMO_PFCP_IEI_PROVIDE_ATSSS_CTRL_INFO, "Provide ATSSS Control Information" }, - { OSMO_PFCP_IEI_ATSSS_CTRL_PARAMS, "ATSSS Control Parameters" }, - { OSMO_PFCP_IEI_MPTCP_CTRL_INFO, "MPTCP Control Information" }, - { OSMO_PFCP_IEI_ATSSS_LL_CTRL_INFO, "ATSSS-LL Control Information" }, - { OSMO_PFCP_IEI_PMF_CTRL_INFO, "PMF Control Information" }, - { OSMO_PFCP_IEI_MPTCP_PARAMS, "MPTCP Parameters" }, - { OSMO_PFCP_IEI_ATSSS_LL_PARAMS, "ATSSS-LL Parameters" }, - { OSMO_PFCP_IEI_PMF_PARAMS, "PMF Parameters" }, - { OSMO_PFCP_IEI_MPTCP_ADDRESS_INFO, "MPTCP Address Information" }, - { OSMO_PFCP_IEI_UE_LINK_SPECIFIC_IP_ADDRESS, "UE Link-Specific IP Address" }, - { OSMO_PFCP_IEI_PMF_ADDRESS_INFO, "PMF Address Information" }, - { OSMO_PFCP_IEI_ATSSS_LL_INFO, "ATSSS-LL Information" }, - { OSMO_PFCP_IEI_DATA_NETWORK_ACCESS_IDENTIFIER, "Data Network Access Identifier" }, - { OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_INFO, "UE IP address Pool Information" }, - { OSMO_PFCP_IEI_AVERAGE_PACKET_DELAY, "Average Packet Delay" }, - { OSMO_PFCP_IEI_MIN_PACKET_DELAY, "Minimum Packet Delay" }, - { OSMO_PFCP_IEI_MAX_PACKET_DELAY, "Maximum Packet Delay" }, - { OSMO_PFCP_IEI_QOS_REP_TRIGGER, "QoS Report Trigger" }, - { OSMO_PFCP_IEI_GTP_U_PATH_QOS_CTRL_INFO, "GTP-U Path QoS Control Information" }, - { OSMO_PFCP_IEI_GTP_U_PATH_QOS_REP_NODE_REP_REQ, "GTP-U Path QoS Report (PFCP Node Report Request)" }, - { OSMO_PFCP_IEI_QOS_INFO_IN_GTP_U_PATH_QOS_REP, "QoS Information in GTP-U Path QoS Report" }, - { OSMO_PFCP_IEI_GTP_U_PATH_IFACE_TYPE, "GTP-U Path Interface Type" }, - { OSMO_PFCP_IEI_QOS_MONITORING_PER_QOS_FLOW_CTRL_INFO, "QoS Monitoring per QoS flow Control Information" }, - { OSMO_PFCP_IEI_REQUESTED_QOS_MONITORING, "Requested QoS Monitoring" }, - { OSMO_PFCP_IEI_REPORTING_FREQUENCY, "Reporting Frequency" }, - { OSMO_PFCP_IEI_PACKET_DELAY_THRESHOLDS, "Packet Delay Thresholds" }, - { OSMO_PFCP_IEI_MIN_WAIT_TIME, "Minimum Wait Time" }, - { OSMO_PFCP_IEI_QOS_MONITORING_REP, "QoS Monitoring Report" }, - { OSMO_PFCP_IEI_QOS_MONITORING_MEAS, "QoS Monitoring Measurement" }, - { OSMO_PFCP_IEI_MT_EDT_CTRL_INFO, "MT-EDT Control Information" }, - { OSMO_PFCP_IEI_DL_DATA_PACKETS_SIZE, "DL Data Packets Size" }, - { OSMO_PFCP_IEI_QER_CTRL_INDICATIONS, "QER Control Indications" }, - { OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP, "Packet Rate Status Report" }, - { OSMO_PFCP_IEI_NF_INST_ID, "NF Instance ID" }, - { OSMO_PFCP_IEI_ETHERNET_CONTEXT_INFO, "Ethernet Context Information" }, - { OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_PARAMS, "Redundant Transmission Parameters" }, - { OSMO_PFCP_IEI_UPDATED_PDR, "Updated PDR" }, - { OSMO_PFCP_IEI_S_NSSAI, "S-NSSAI" }, - { OSMO_PFCP_IEI_IP_VERSION, "IP version" }, - { OSMO_PFCP_IEI_PFCPASREQ_FLAGS, "PFCPASReq-Flags" }, - { OSMO_PFCP_IEI_DATA_STATUS, "Data Status" }, - { OSMO_PFCP_IEI_PROVIDE_RDS_CONF_INFO, "Provide RDS configuration information" }, - { OSMO_PFCP_IEI_RDS_CONF_INFO, "RDS configuration information" }, - { OSMO_PFCP_IEI_QUERY_PACKET_RATE_STATUS_IE_IN_SESS_MOD_REQ, "Query Packet Rate Status IE within PFCP Session Modification Request" }, - { OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP_IE_IN_SESS_MOD_RESP, "Packet Rate Status Report IE within PFCP Session Modification Response" }, - { OSMO_PFCP_IEI_MPTCP_APPLICABLE_IND, "MPTCP Applicable Indication" }, - { OSMO_PFCP_IEI_BRIDGE_MGMT_INFO_CONTAINER, "Bridge Management Information Container" }, - { OSMO_PFCP_IEI_UE_IP_ADDRESS_USAGE_INFO, "UE IP Address Usage Information" }, - { OSMO_PFCP_IEI_NUMBER_OF_UE_IP_ADDRS, "Number of UE IP Addresses" }, - { OSMO_PFCP_IEI_VALIDITY_TIMER, "Validity Timer" }, - { OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_FORW_PARAMS, "Redundant Transmission Forwarding Parameters" }, - { OSMO_PFCP_IEI_TRANSPORT_DELAY_REPORTING, "Transport Delay Reporting" }, - { 0 } -}; - -const struct value_string osmo_pfcp_cause_strs[] = { - { OSMO_PFCP_CAUSE_RESERVED, "0" }, - { OSMO_PFCP_CAUSE_REQUEST_ACCEPTED, "Request accepted (success)" }, - { OSMO_PFCP_CAUSE_MORE_USAGE_REPORT_TO_SEND, "More Usage Report to send" }, - { OSMO_PFCP_CAUSE_REQUEST_REJECTED, "Request rejected (reason not specified)" }, - { OSMO_PFCP_CAUSE_SESSION_CTX_NOT_FOUND, "Session context not found" }, - { OSMO_PFCP_CAUSE_MANDATORY_IE_MISSING, "Mandatory IE missing" }, - { OSMO_PFCP_CAUSE_CONDITIONAL_IE_MISSING, "Conditional IE missing" }, - { OSMO_PFCP_CAUSE_INVALID_LENGTH, "Invalid length" }, - { OSMO_PFCP_CAUSE_MANDATORY_IE_INCORRECT, "Mandatory IE incorrect" }, - { OSMO_PFCP_CAUSE_INVALID_FORW_POLICY, "Invalid Forwarding Policy" }, - { OSMO_PFCP_CAUSE_INVALID_F_TEID_ALLOC_OPTION, "Invalid F-TEID allocation option" }, - { OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC, "No established PFCP Association" }, - { OSMO_PFCP_CAUSE_RULE_CREATION_MOD_FAILURE, "Rule creation/modification Failure" }, - { OSMO_PFCP_CAUSE_PFCP_ENTITY_IN_CONGESTION, "PFCP entity in congestion" }, - { OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE, "No resources available" }, - { OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED, "Service not supported" }, - { OSMO_PFCP_CAUSE_SYSTEM_FAILURE, "System failure" }, - { OSMO_PFCP_CAUSE_REDIRECTION_REQUESTED, "Redirection Requested" }, - { OSMO_PFCP_CAUSE_ALL_DYNAMIC_ADDRESSES_ARE_OCCUPIED, "All dynamic addresses are occupied" }, - { 0 } -}; - -const struct value_string osmo_pfcp_up_feature_strs[] = { - { OSMO_PFCP_UP_FEAT_BUCP, "BUCP" }, - { OSMO_PFCP_UP_FEAT_DDND, "DDND" }, - { OSMO_PFCP_UP_FEAT_DLBD, "DLBD" }, - { OSMO_PFCP_UP_FEAT_TRST, "TRST" }, - { OSMO_PFCP_UP_FEAT_FTUP, "FTUP" }, - { OSMO_PFCP_UP_FEAT_PFDM, "PFDM" }, - { OSMO_PFCP_UP_FEAT_HEEU, "HEEU" }, - { OSMO_PFCP_UP_FEAT_TREU, "TREU" }, - { OSMO_PFCP_UP_FEAT_EMPU, "EMPU" }, - { OSMO_PFCP_UP_FEAT_PDIU, "PDIU" }, - { OSMO_PFCP_UP_FEAT_UDBC, "UDBC" }, - { OSMO_PFCP_UP_FEAT_QUOAC, "QUOAC" }, - { OSMO_PFCP_UP_FEAT_TRACE, "TRACE" }, - { OSMO_PFCP_UP_FEAT_FRRT, "FRRT" }, - { OSMO_PFCP_UP_FEAT_PFDE, "PFDE" }, - { OSMO_PFCP_UP_FEAT_EPFAR, "EPFAR" }, - { OSMO_PFCP_UP_FEAT_DPDRA, "DPDRA" }, - { OSMO_PFCP_UP_FEAT_ADPDP, "ADPDP" }, - { OSMO_PFCP_UP_FEAT_UEIP, "UEIP" }, - { OSMO_PFCP_UP_FEAT_SSET, "SSET" }, - { OSMO_PFCP_UP_FEAT_MNOP, "MNOP" }, - { OSMO_PFCP_UP_FEAT_MTE, "MTE" }, - { OSMO_PFCP_UP_FEAT_BUNDL, "BUNDL" }, - { OSMO_PFCP_UP_FEAT_GCOM, "GCOM" }, - { OSMO_PFCP_UP_FEAT_MPAS, "MPAS" }, - { OSMO_PFCP_UP_FEAT_RTTL, "RTTL" }, - { OSMO_PFCP_UP_FEAT_VTIME, "VTIME" }, - { OSMO_PFCP_UP_FEAT_NORP, "NORP" }, - { OSMO_PFCP_UP_FEAT_IP6PL, "IP6PL" }, - { OSMO_PFCP_UP_FEAT_TSCU, "TSCU" }, - { OSMO_PFCP_UP_FEAT_MPTCP, "MPTCP" }, - { OSMO_PFCP_UP_FEAT_ATSSSLL, "ATSSSLL" }, - { OSMO_PFCP_UP_FEAT_QFQM, "QFQM" }, - { OSMO_PFCP_UP_FEAT_GPQM, "GPQM" }, - { OSMO_PFCP_UP_FEAT_MTEDT, "MTEDT" }, - { OSMO_PFCP_UP_FEAT_CIOT, "CIOT" }, - { OSMO_PFCP_UP_FEAT_ETHAR, "ETHAR" }, - { OSMO_PFCP_UP_FEAT_DDDS, "DDDS" }, - { OSMO_PFCP_UP_FEAT_RDS, "RDS" }, - { OSMO_PFCP_UP_FEAT_RTTWP, "RTTWP" }, - {} -}; - - -const struct value_string osmo_pfcp_cp_feature_strs[] = { - { OSMO_PFCP_CP_FEAT_LOAD, "LOAD" }, - { OSMO_PFCP_CP_FEAT_OVRL, "OVRL" }, - { OSMO_PFCP_CP_FEAT_EPFAR, "EPFAR" }, - { OSMO_PFCP_CP_FEAT_SSET, "SSET" }, - { OSMO_PFCP_CP_FEAT_BUNDL, "BUNDL" }, - { OSMO_PFCP_CP_FEAT_MPAS, "MPAS" }, - { OSMO_PFCP_CP_FEAT_ARDR, "ARDR" }, - { OSMO_PFCP_CP_FEAT_UIAUR, "UIAUR" }, - {} -}; - -const struct value_string osmo_pfcp_apply_action_strs[] = { - { OSMO_PFCP_APPLY_ACTION_DROP, "DROP" }, - { OSMO_PFCP_APPLY_ACTION_FORW, "FORW" }, - { OSMO_PFCP_APPLY_ACTION_BUFF, "BUFF" }, - { OSMO_PFCP_APPLY_ACTION_NOCP, "NOCP" }, - { OSMO_PFCP_APPLY_ACTION_DUPL, "DUPL" }, - { OSMO_PFCP_APPLY_ACTION_IPMA, "IPMA" }, - { OSMO_PFCP_APPLY_ACTION_IPMD, "IPMD" }, - { OSMO_PFCP_APPLY_ACTION_DFRT, "DFRT" }, - { OSMO_PFCP_APPLY_ACTION_EDRT, "EDRT" }, - { OSMO_PFCP_APPLY_ACTION_BDPN, "BDPN" }, - { OSMO_PFCP_APPLY_ACTION_DDPN, "DDPN" }, - {} -}; - -const struct value_string osmo_pfcp_outer_header_creation_strs[] = { - { OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4, "GTP_U_UDP_IPV4" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6, "GTP_U_UDP_IPV6" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4, "UDP_IPV4" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6, "UDP_IPV6" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_IPV4, "IPV4" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_IPV6, "IPV6" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG, "C_TAG" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG, "S_TAG" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_N19_INDICATION, "N19_INDICATION" }, - { OSMO_PFCP_OUTER_HEADER_CREATION_N6_INDICATION, "N6_INDICATION" }, - {} -}; - -const struct value_string osmo_pfcp_outer_header_removal_desc_strs[] = { - { OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4, "GTP_U_UDP_IPV4" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV6, "GTP_U_UDP_IPV6" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV4, "UDP_IPV4" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV6, "UDP_IPV6" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV4, "IPV4" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV6, "IPV6" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IP, "GTP_U_UDP_IP" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_VLAN_S_TAG, "VLAN_S_TAG" }, - { OSMO_PFCP_OUTER_HEADER_REMOVAL_S_TAG_AND_C_TAG, "S_TAG_AND_C_TAG" }, - {} -}; - -const struct value_string osmo_pfcp_source_iface_strs[] = { - { OSMO_PFCP_SOURCE_IFACE_ACCESS, "Access" }, - { OSMO_PFCP_SOURCE_IFACE_CORE, "Core" }, - { OSMO_PFCP_SOURCE_IFACE_SGI_LAN_N6_LAN, "SGi-LAN/N6-LAN" }, - { OSMO_PFCP_SOURCE_IFACE_CP_FUNCTION, "CP-function" }, - { OSMO_PFCP_SOURCE_IFACE_5G_VN_INTERNAL, "5G-VN-Internal" }, - {} -}; - -const struct value_string osmo_pfcp_dest_iface_strs[] = { - { OSMO_PFCP_DEST_IFACE_ACCESS, "Access" }, - { OSMO_PFCP_DEST_IFACE_CORE, "Core" }, - { OSMO_PFCP_DEST_IFACE_SGI_LAN_N6_LAN, "SGi-LAN/N6-LAN" }, - { OSMO_PFCP_DEST_IFACE_CP_FUNCTION, "CP-function" }, - { OSMO_PFCP_DEST_IFACE_LI_FUNCTION, "LI-function" }, - { OSMO_PFCP_DEST_IFACE_5G_VN_INTERNAL, "5G-VN-Internal" }, - {} -}; - -const struct value_string osmo_pfcp_3gpp_iface_type_strs[] = { - { OSMO_PFCP_3GPP_IFACE_TYPE_S1_U, "S1_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S5_S8_U, "S5_S8_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S4_U, "S4_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S11_U, "S11_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S12_U, "S12_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_GN_GP_U, "GN_GP_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S2A_U, "S2A_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S2B_U, "S2B_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_ENODEB_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING, "ENODEB_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_ENODEB_GTP_U_INTERFACE_FOR_UL_DATA_FORWARDING, "ENODEB_GTP_U_INTERFACE_FOR_UL_DATA_FORWARDING" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_SGW_UPF_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING, "SGW_UPF_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N3_3GPP_ACCESS, "N3_3GPP_ACCESS" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N3_TRUSTED_NON_3GPP_ACCESS, "N3_TRUSTED_NON_3GPP_ACCESS" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N3_UNTRUSTED_NON_3GPP_ACCESS, "N3_UNTRUSTED_NON_3GPP_ACCESS" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N3_FOR_DATA_FORWARDING, "N3_FOR_DATA_FORWARDING" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N9, "N9" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_SGI, "SGI" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N6, "N6" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_N19, "N19" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_S8_U, "S8_U" }, - { OSMO_PFCP_3GPP_IFACE_TYPE_GP_U, "GP_U" }, - {} -}; diff --git a/tests/Makefile.am b/tests/Makefile.am index fad7e6c..66510f0 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -1,7 +1,3 @@ -SUBDIRS = \ - libosmo-pfcp \ - $(NULL) - # The `:;' works around a Bash 3.2 bug when the output is not writeable. $(srcdir)/package.m4: $(top_srcdir)/configure.ac :;{ \ diff --git a/tests/libosmo-pfcp/Makefile.am b/tests/libosmo-pfcp/Makefile.am deleted file mode 100644 index eba3aa4..0000000 --- a/tests/libosmo-pfcp/Makefile.am +++ /dev/null @@ -1,33 +0,0 @@ -AM_CPPFLAGS = \ - $(all_includes) \ - -I$(top_srcdir)/include \ - -I$(top_builddir)/include \ - $(NULL) - -AM_CFLAGS = \ - -Wall \ - $(LIBOSMOCORE_CFLAGS) \ - $(LIBOSMOGTLV_CFLAGS) \ - $(NULL) - -noinst_PROGRAMS = \ - pfcp_test \ - $(NULL) - -EXTRA_DIST = \ - pfcp_test.ok \ - $(NULL) - -pfcp_test_SOURCES = \ - pfcp_test.c \ - $(NULL) - -pfcp_test_LDADD = \ - $(top_builddir)/src/libosmo-pfcp/libosmo-pfcp.a \ - $(LIBOSMOCORE_LIBS) \ - $(LIBOSMOGTLV_LIBS) \ - $(NULL) - -.PHONY: update_exp -update_exp: - $(builddir)/pfcp_test >$(srcdir)/pfcp_test.ok diff --git a/tests/libosmo-pfcp/pfcp_test.c b/tests/libosmo-pfcp/pfcp_test.c deleted file mode 100644 index 189622e..0000000 --- a/tests/libosmo-pfcp/pfcp_test.c +++ /dev/null @@ -1,512 +0,0 @@ -/* - * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> - * All Rights Reserved. - * - * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> - * - * SPDX-License-Identifier: GPL-2.0+ - * - * 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, see <http://www.gnu.org/licenses/>. - * - */ - -#include <stdio.h> -#include <errno.h> - -#include <osmocom/core/application.h> -#include <osmocom/core/utils.h> -#include <osmocom/core/msgb.h> - -#include <osmocom/pfcp/pfcp_msg.h> - -void *ctx; - -/* struct osmo_sockaddr */ -#define v4_ue { \ - .u.sin = { \ - .sin_family = AF_INET, \ - .sin_addr = { 0x1700a8c0 }, \ - } \ -} - -/* struct osmo_sockaddr */ -#define v4_gtp { \ - .u.sin = { \ - .sin_family = AF_INET, \ - .sin_addr = { 0x0708090a }, \ - } \ -} - -/* struct osmo_pfcp_ie_f_teid */ -#define f_teid_access_local { \ - .choose_flag = true, \ - .choose = { \ - .ipv4_addr = true, \ - }, \ -} - -/* struct osmo_pfcp_ie_f_teid */ -#define f_teid_created { \ - .fixed = { \ - .teid = 1234, \ - .ip_addr = { \ - .v4_present = true, \ - .v4 = v4_gtp, \ - }, \ - }, \ -} - -/* struct osmo_pfcp_ie_outer_header_creation */ -#define ohc_access { \ - .desc_bits = { 0x01 }, \ - .teid_present = true, \ - .teid = 0xabcdef, \ - .ip_addr = { \ - .v4_present = true, \ - .v4 = v4_gtp, \ - }, \ -} - -/* struct osmo_pfcp_ie_apply_action */ -#define aa_forw { \ - .bits = { 0x02 }, \ -} - -/* struct osmo_pfcp_ie_f_seid */ -#define f_seid { \ - .seid = 0x1234567890abcdef, \ - .ip_addr = { \ - .v4_present = true, \ - .v4 = v4_gtp, \ - }, \ -} - -struct osmo_pfcp_msg tests[] = { - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_HEARTBEAT_REQ, - .sequence_nr = 1, - }, - .ies.heartbeat_req = { - .recovery_time_stamp = 1234, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_HEARTBEAT_RESP, - .sequence_nr = 2, - }, - .ies.heartbeat_resp = { - .recovery_time_stamp = 5678, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_ASSOC_SETUP_REQ, - .sequence_nr = 3, - }, - .ies.assoc_setup_req = { - .node_id = { - .type = OSMO_PFCP_NODE_ID_T_IPV4, - .ip.u.sin = { - .sin_family = AF_INET, - .sin_addr = { 0x01020304 }, - }, - }, - .recovery_time_stamp = 0x2b2b2b2b, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_ASSOC_SETUP_RESP, - .sequence_nr = 4, - }, - .ies.assoc_setup_resp = { - .node_id = { - .type = OSMO_PFCP_NODE_ID_T_FQDN, - .fqdn = "example.com", - }, - .cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED, - .recovery_time_stamp = 0x2b2b2b2b, - .up_function_features_present = true, - .up_function_features.bits = { 1, 2 }, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_ASSOC_RELEASE_REQ, - .sequence_nr = 5, - }, - .ies.assoc_release_req = { - .node_id = { - .type = OSMO_PFCP_NODE_ID_T_IPV6, - .ip.u.sin6 = { - .sin6_family = AF_INET6, - .sin6_addr = {{{ 1, 2, 3, 4 }}}, - }, - }, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP, - .sequence_nr = 6, - }, - .ies.assoc_release_resp = { - .node_id = { - .type = OSMO_PFCP_NODE_ID_T_IPV4, - .ip.u.sin = { - .sin_family = AF_INET, - .sin_addr = { 0x01020304 }, - }, - }, - .cause = OSMO_PFCP_CAUSE_REQUEST_REJECTED, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_EST_REQ, - .sequence_nr = 7, - .seid_present = true, - .seid = 0, - }, - .ies.session_est_req = { - .node_id = { - .type = OSMO_PFCP_NODE_ID_T_IPV4, - .ip.u.sin = { - .sin_family = AF_INET, - .sin_addr = { 0x0100007f }, - }, - }, - .cp_f_seid_present = true, - .cp_f_seid = f_seid, - .create_pdr_count = 2, - .create_pdr = { - { - .pdr_id = 1, - .precedence = 255, - .pdi = { - .source_iface = OSMO_PFCP_SOURCE_IFACE_CORE, - .ue_ip_address_present = true, - .ue_ip_address = { - .ip_is_destination = true, - .ip_addr = { - .v4_present = true, - .v4 = v4_ue, - }, - }, - }, - .far_id_present = true, - .far_id = 1, - }, - { - .pdr_id = 2, - .precedence = 255, - .pdi = { - .source_iface = OSMO_PFCP_SOURCE_IFACE_ACCESS, - .local_f_teid_present = true, - .local_f_teid = f_teid_access_local, - }, - .outer_header_removal_present = true, - .outer_header_removal = { - .desc = OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4, - }, - .far_id_present = true, - .far_id = 2, - }, - }, - .create_far_count = 2, - .create_far = { - { - .far_id = 1, - .forw_params_present = true, - .forw_params = { - .destination_iface = OSMO_PFCP_DEST_IFACE_ACCESS, - .outer_header_creation_present = true, - .outer_header_creation = ohc_access, - }, - .apply_action = aa_forw, - }, - { - .far_id = 2, - .forw_params_present = true, - .forw_params = { - .destination_iface = OSMO_PFCP_DEST_IFACE_CORE, - }, - .apply_action = aa_forw, - }, - }, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_EST_RESP, - .sequence_nr = 8, - .seid_present = true, - .seid = 0x0123456789abcdef, - }, - .ies.session_est_resp = { - .node_id = { - .type = OSMO_PFCP_NODE_ID_T_IPV4, - .ip.u.sin = { - .sin_family = AF_INET, - .sin_addr = { 0x0200007f }, - }, - }, - .cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED, - .up_f_seid_present = true, - .up_f_seid = f_seid, - .created_pdr_count = 2, - .created_pdr = { - { - .pdr_id = 1, - }, - { - .pdr_id = 2, - .local_f_teid_present = true, - .local_f_teid = f_teid_created, - }, - }, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_MOD_REQ, - .sequence_nr = 9, - .seid_present = true, - .seid = 0, - }, - .ies.session_mod_req = { - .remove_pdr_count = 1, - .remove_pdr = { - { - .pdr_id = 1, - }, - }, - .remove_far_count = 1, - .remove_far = { - { - .far_id = 1, - }, - }, - .create_pdr_count = 1, - .create_pdr = { - { - .pdr_id = 3, - .precedence = 255, - .pdi = { - .source_iface = OSMO_PFCP_SOURCE_IFACE_ACCESS, - .local_f_teid_present = true, - .local_f_teid = f_teid_access_local, - }, - .outer_header_removal_present = true, - .outer_header_removal = { - .desc = OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4, - }, - .far_id_present = true, - .far_id = 3, - }, - }, - .create_far_count = 1, - .create_far = { - { - .far_id = 3, - .forw_params_present = true, - .forw_params = { - .destination_iface = OSMO_PFCP_DEST_IFACE_ACCESS, - .outer_header_creation_present = true, - .outer_header_creation = ohc_access, - }, - .apply_action = aa_forw, - }, - }, - .upd_pdr_count = 1, - .upd_pdr = { - { - .pdr_id = 1, - .pdi = { - .source_iface = OSMO_PFCP_SOURCE_IFACE_ACCESS, - .local_f_teid_present = true, - .local_f_teid = f_teid_access_local, - }, - .outer_header_removal_present = true, - .outer_header_removal = { - .desc = OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4, - }, - .far_id_present = true, - .far_id = 1, - }, - }, - .upd_far_count = 1, - .upd_far = { - { - .far_id = 1, - .upd_forw_params_present = true, - .upd_forw_params = { - .destination_iface = OSMO_PFCP_DEST_IFACE_CORE, - .network_inst_present = true, - .network_inst = { - .str = "internet", - }, - }, - .apply_action = aa_forw, - }, - }, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_MOD_RESP, - .sequence_nr = 10, - .seid_present = true, - .seid = 0x0123456789abcdef, - }, - .ies.session_mod_resp = { - .cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED, - .created_pdr_count = 1, - .created_pdr = { - { - .pdr_id = 3, - .local_f_teid_present = true, - .local_f_teid = f_teid_created, - }, - }, - .updated_pdr_count = 1, - .updated_pdr = { - { - .pdr_id = 1, - .local_f_teid_present = true, - .local_f_teid = f_teid_created, - }, - }, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_MOD_RESP, - .sequence_nr = 11, - .seid_present = true, - .seid = 0x0123456789abcdef, - }, - .ies.session_mod_resp = { - .cause = OSMO_PFCP_CAUSE_MANDATORY_IE_MISSING, - .offending_ie_present = true, - .offending_ie = OSMO_PFCP_IEI_APPLY_ACTION, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_DEL_REQ, - .sequence_nr = 12, - .seid_present = true, - .seid = 0x0123456789abcdef, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_DEL_RESP, - .sequence_nr = 13, - .seid_present = true, - .seid = 0x0123456789abcdef, - }, - .ies.session_del_resp = { - .cause = OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC, - }, - }, - { - .h = { - .version = 1, - .message_type = OSMO_PFCP_MSGT_SESSION_DEL_RESP, - .sequence_nr = 13, - .seid_present = true, - .seid = 0x0123456789abcdef, - }, - .ies.session_del_resp = { - .cause = OSMO_PFCP_CAUSE_REQUEST_ACCEPTED, - }, - }, -}; - -void test_enc_dec() -{ - int i; - for (i = 0; i < ARRAY_SIZE(tests); i++) { - void *loop_ctx = talloc_named_const(ctx, 0, "loop"); - int rc; - const struct osmo_pfcp_msg *orig = &tests[i]; - struct osmo_pfcp_msg parsed = {}; - struct msgb *msg; - struct osmo_gtlv_load tlv; - - printf("\n=== start %s[%d]\n", __func__, i); - printf("encoding: %s\n", osmo_pfcp_message_type_str(orig->h.message_type)); - printf("%s\n", osmo_pfcp_msg_to_str_c(loop_ctx, orig)); - msg = msgb_alloc(1024, __func__); - rc = osmo_pfcp_msg_encode(msg, orig); - printf("osmo_pfcp_msg_encode() rc = %d\n", rc); - printf("%s.\n", osmo_hexdump(msg->data, msg->len)); - - rc = osmo_pfcp_msg_decode_header(&tlv, &parsed, msg); - printf("osmo_pfcp_msg_decode_header() rc = %d\n", rc); - if (rc != msgb_length(msg)) { - printf("ERROR: expected rc = %d\n", msgb_length(msg)); - exit(1); - } else { - printf("rc == msgb_length()\n"); - } - - rc = osmo_pfcp_msg_decode_tlv(&parsed, &tlv); - printf("osmo_pfcp_msg_decode_tlv() rc = %d\n", rc); - - if (strcmp(osmo_pfcp_msg_to_str_c(loop_ctx, orig), - osmo_pfcp_msg_to_str_c(loop_ctx, &parsed))) { - printf(" ERROR: parsed != orig\n"); - printf(" orig: %s\n", - osmo_pfcp_msg_to_str_c(loop_ctx, orig)); - printf(" parsed: %s\n", - osmo_pfcp_msg_to_str_c(loop_ctx, &parsed)); - exit(1); - } else { - printf("parsed == orig\n"); - } - - msgb_free(msg); - printf("=== end %s[%d]\n", __func__, i); - talloc_free(loop_ctx); - } -} - -int main() -{ - ctx = talloc_named_const(NULL, 0, "pfcp_test"); - msgb_talloc_ctx_init(ctx, 0); - - test_enc_dec(); - - talloc_free(ctx); - return 0; -} diff --git a/tests/libosmo-pfcp/pfcp_test.ok b/tests/libosmo-pfcp/pfcp_test.ok deleted file mode 100644 index 2b8cc1a..0000000 --- a/tests/libosmo-pfcp/pfcp_test.ok +++ /dev/null @@ -1,154 +0,0 @@ - -=== start test_enc_dec[0] -encoding: HEARTBEAT_REQ -PFCPv1 HEARTBEAT_REQ hdr={seq=1} ies={ 'Recovery Time Stamp'=1234 } -osmo_pfcp_msg_encode() rc = 0 -20 01 00 0c 00 00 01 00 00 60 00 04 00 00 04 d2 . -osmo_pfcp_msg_decode_header() rc = 16 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[0] - -=== start test_enc_dec[1] -encoding: HEARTBEAT_RESP -PFCPv1 HEARTBEAT_RESP hdr={seq=2} ies={ 'Recovery Time Stamp'=5678 } -osmo_pfcp_msg_encode() rc = 0 -20 02 00 0c 00 00 02 00 00 60 00 04 00 00 16 2e . -osmo_pfcp_msg_decode_header() rc = 16 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[1] - -=== start test_enc_dec[2] -encoding: ASSOC_SETUP_REQ -PFCPv1 ASSOC_SETUP_REQ hdr={seq=3} ies={ 'Node ID'=v4:4.3.2.1 'Recovery Time Stamp'=724249387 } -osmo_pfcp_msg_encode() rc = 0 -20 05 00 15 00 00 03 00 00 3c 00 05 00 04 03 02 01 00 60 00 04 2b 2b 2b 2b . -osmo_pfcp_msg_decode_header() rc = 25 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[2] - -=== start test_enc_dec[3] -encoding: ASSOC_SETUP_RESP -PFCPv1 ASSOC_SETUP_RESP hdr={seq=4} ies={ 'Node ID'=fqdn:"example.com" 'Cause'=Request accepted (success) 'Recovery Time Stamp'=724249387 'UP Function Features'=( BUCP PDIU ) } -osmo_pfcp_msg_encode() rc = 0 -20 06 00 2b 00 00 04 00 00 3c 00 0c 02 65 78 61 6d 70 6c 65 2e 63 6f 6d 00 13 00 01 01 00 60 00 04 2b 2b 2b 2b 00 2b 00 06 01 02 00 00 00 00 . -osmo_pfcp_msg_decode_header() rc = 47 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[3] - -=== start test_enc_dec[4] -encoding: ASSOC_RELEASE_REQ -PFCPv1 ASSOC_RELEASE_REQ hdr={seq=5} ies={ 'Node ID'=v6:[102:304::] } -osmo_pfcp_msg_encode() rc = 0 -20 09 00 19 00 00 05 00 00 3c 00 11 01 01 02 03 04 00 00 00 00 00 00 00 00 00 00 00 00 . -osmo_pfcp_msg_decode_header() rc = 29 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[4] - -=== start test_enc_dec[5] -encoding: ASSOC_RELEASE_RESP -PFCPv1 ASSOC_RELEASE_RESP hdr={seq=6} ies={ 'Node ID'=v4:4.3.2.1 'Cause'=Request rejected (reason not specified) } -osmo_pfcp_msg_encode() rc = 0 -20 0a 00 12 00 00 06 00 00 3c 00 05 00 04 03 02 01 00 13 00 01 40 . -osmo_pfcp_msg_decode_header() rc = 22 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[5] - -=== start test_enc_dec[6] -encoding: SESSION_EST_REQ -PFCPv1 SESSION_EST_REQ hdr={seq=7 SEID=0x0} ies={ 'Node ID'=v4:127.0.0.1 'F-SEID'=0x1234567890abcdef,v4:10.9.8.7 'Create PDR'={ { 'PDR ID'=1 'Precedence'=255 'PDI'={ 'Source Interface'=Core 'UE IP Address'=,dst,v4:192.168.0.23 } 'FAR ID'=1 }, { 'PDR ID'=2 'Precedence'=255 'PDI'={ 'Source Interface'=Access 'F-TEID'=CHOOSE-v4 } 'Outer Header Removal'=GTP_U_UDP_IPV4 'FAR ID'=2 } } 'Create FAR'={ { 'FAR ID'=1 'Apply Action'=( FORW ) 'Forwarding Parameters'={ 'Destination Interface'=Access 'Outer Header Creation'=( GTP_U_UDP_IPV4 ),TEID:0xabcdef,v4:10.9.8.7 } }, { 'FAR ID'=2 'Apply Action'=( FORW ) 'Forwarding Parameters'={ 'Destination Interface'=Core } } } } -osmo_pfcp_msg_encode() rc = 0 -21 32 00 c3 00 00 00 00 00 00 00 00 00 00 07 00 00 3c 00 05 00 7f 00 00 01 00 39 00 0d 02 12 34 56 78 90 ab cd ef 0a 09 08 07 00 01 00 28 00 38 00 02 00 01 00 1d 00 04 00 00 00 ff 00 02 00 0e 00 14 00 01 01 00 5d 00 05 06 c0 a8 00 17 00 6c 00 04 00 00 00 01 00 01 00 29 00 38 00 02 00 02 00 1d 00 04 00 00 00 ff 00 02 00 0a 00 14 00 01 00 00 15 00 01 05 00 5f 00 01 00 00 6c 00 04 00 00 00 02 00 03 00 25 00 6c 00 04 00 00 00 01 00 2c 00 02 02 00 00 04 00 13 00 2a 00 01 00 00 54 00 0a 01 00 00 ab cd ef 0a 09 08 07 00 03 00 17 00 6c 00 04 00 00 00 02 00 2c 00 02 02 00 00 04 00 05 00 2a 00 01 01 . -osmo_pfcp_msg_decode_header() rc = 199 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[6] - -=== start test_enc_dec[7] -encoding: SESSION_EST_RESP -PFCPv1 SESSION_EST_RESP hdr={seq=8 SEID=0x123456789abcdef} ies={ 'Node ID'=v4:127.0.0.2 'Cause'=Request accepted (success) 'F-SEID'=0x1234567890abcdef,v4:10.9.8.7 'Created PDR'={ { 'PDR ID'=1 }, { 'PDR ID'=2 'F-TEID'=TEID-0x4d2,v4:10.9.8.7 } } } -osmo_pfcp_msg_encode() rc = 0 -21 33 00 4c 01 23 45 67 89 ab cd ef 00 00 08 00 00 3c 00 05 00 7f 00 00 02 00 13 00 01 01 00 39 00 0d 02 12 34 56 78 90 ab cd ef 0a 09 08 07 00 08 00 06 00 38 00 02 00 01 00 08 00 13 00 38 00 02 00 02 00 15 00 09 01 00 00 04 d2 0a 09 08 07 . -osmo_pfcp_msg_decode_header() rc = 80 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[7] - -=== start test_enc_dec[8] -encoding: SESSION_MOD_REQ -PFCPv1 SESSION_MOD_REQ hdr={seq=9 SEID=0x0} ies={ 'Remove PDR'={ { 'PDR ID'=1 } } 'Remove FAR'={ { 'FAR ID'=1 } } 'Create PDR'={ { 'PDR ID'=3 'Precedence'=255 'PDI'={ 'Source Interface'=Access 'F-TEID'=CHOOSE-v4 } 'Outer Header Removal'=GTP_U_UDP_IPV4 'FAR ID'=3 } } 'Create FAR'={ { 'FAR ID'=3 'Apply Action'=( FORW ) 'Forwarding Parameters'={ 'Destination Interface'=Access 'Outer Header Creation'=( GTP_U_UDP_IPV4 ),TEID:0xabcdef,v4:10.9.8.7 } } } 'Update PDR'={ { 'PDR ID'=1 'Outer Header Removal'=GTP_U_UDP_IPV4 'FAR ID'=1 } } 'Update FAR'={ { 'FAR ID'=1 'Update Forwarding Parameters'={ 'Network Instance'="internet" } } } } -osmo_pfcp_msg_encode() rc = 0 -21 34 00 ab 00 00 00 00 00 00 00 00 00 00 09 00 00 0f 00 06 00 38 00 02 00 01 00 10 00 08 00 6c 00 04 00 00 00 01 00 01 00 29 00 38 00 02 00 03 00 1d 00 04 00 00 00 ff 00 02 00 0a 00 14 00 01 00 00 15 00 01 05 00 5f 00 01 00 00 6c 00 04 00 00 00 03 00 03 00 25 00 6c 00 04 00 00 00 03 00 2c 00 02 02 00 00 04 00 13 00 2a 00 01 00 00 54 00 0a 01 00 00 ab cd ef 0a 09 08 07 00 09 00 13 00 38 00 02 00 01 00 5f 00 01 00 00 6c 00 04 00 00 00 01 00 0a 00 18 00 6c 00 04 00 00 00 01 00 0b 00 0c 00 16 00 08 69 6e 74 65 72 6e 65 74 . -osmo_pfcp_msg_decode_header() rc = 175 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[8] - -=== start test_enc_dec[9] -encoding: SESSION_MOD_RESP -PFCPv1 SESSION_MOD_RESP hdr={seq=10 SEID=0x123456789abcdef} ies={ 'Cause'=Request accepted (success) 'Created PDR'={ { 'PDR ID'=3 'F-TEID'=TEID-0x4d2,v4:10.9.8.7 } } 'Updated PDR'={ { 'PDR ID'=1 'F-TEID'=TEID-0x4d2,v4:10.9.8.7 } } } -osmo_pfcp_msg_encode() rc = 0 -21 35 00 3f 01 23 45 67 89 ab cd ef 00 00 0a 00 00 13 00 01 01 00 08 00 13 00 38 00 02 00 03 00 15 00 09 01 00 00 04 d2 0a 09 08 07 01 00 00 13 00 38 00 02 00 01 00 15 00 09 01 00 00 04 d2 0a 09 08 07 . -osmo_pfcp_msg_decode_header() rc = 67 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[9] - -=== start test_enc_dec[10] -encoding: SESSION_MOD_RESP -PFCPv1 SESSION_MOD_RESP hdr={seq=11 SEID=0x123456789abcdef} ies={ 'Cause'=Mandatory IE missing 'Offending IE'=Apply Action } -osmo_pfcp_msg_encode() rc = 0 -21 35 00 17 01 23 45 67 89 ab cd ef 00 00 0b 00 00 13 00 01 42 00 28 00 02 00 2c . -osmo_pfcp_msg_decode_header() rc = 27 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[10] - -=== start test_enc_dec[11] -encoding: SESSION_DEL_REQ -PFCPv1 SESSION_DEL_REQ hdr={seq=12 SEID=0x123456789abcdef} ies={ } -osmo_pfcp_msg_encode() rc = 0 -21 36 00 0c 01 23 45 67 89 ab cd ef 00 00 0c 00 . -osmo_pfcp_msg_decode_header() rc = 16 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[11] - -=== start test_enc_dec[12] -encoding: SESSION_DEL_RESP -PFCPv1 SESSION_DEL_RESP hdr={seq=13 SEID=0x123456789abcdef} ies={ 'Cause'=No established PFCP Association } -osmo_pfcp_msg_encode() rc = 0 -21 37 00 11 01 23 45 67 89 ab cd ef 00 00 0d 00 00 13 00 01 48 . -osmo_pfcp_msg_decode_header() rc = 21 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[12] - -=== start test_enc_dec[13] -encoding: SESSION_DEL_RESP -PFCPv1 SESSION_DEL_RESP hdr={seq=13 SEID=0x123456789abcdef} ies={ 'Cause'=Request accepted (success) } -osmo_pfcp_msg_encode() rc = 0 -21 37 00 11 01 23 45 67 89 ab cd ef 00 00 0d 00 00 13 00 01 01 . -osmo_pfcp_msg_decode_header() rc = 21 -rc == msgb_length() -osmo_pfcp_msg_decode_tlv() rc = 0 -parsed == orig -=== end test_enc_dec[13] diff --git a/tests/testsuite.at b/tests/testsuite.at index 352fba9..09a77c3 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -1,8 +1,2 @@ AT_INIT AT_BANNER([Regression tests.]) - -AT_SETUP([pfcp]) -AT_KEYWORDS([pfcp]) -cat $abs_srcdir/libosmo-pfcp/pfcp_test.ok > expout -AT_CHECK([$abs_top_builddir/tests/libosmo-pfcp/pfcp_test], [], [expout], [ignore]) -AT_CLEANUP null-- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28306 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I1464cdd846b00707b0abba9126aa5bb784b7caf1 Gerrit-Change-Number: 28306 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Change in osmo-upf[master]: add pfcp_endpoint
by neels 19 Jul '22

19 Jul '22

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-upf/+/28244 ) Change subject: add pfcp_endpoint ...................................................................... add pfcp_endpoint Related: SYS#5599 Change-Id: Ic8d42e201b63064a71b40ca45a5a40e29941e8ac --- M include/osmocom/pfcp/Makefile.am A include/osmocom/pfcp/pfcp_endpoint.h M include/osmocom/pfcp/pfcp_msg.h M src/libosmo-pfcp/Makefile.am A src/libosmo-pfcp/pfcp_endpoint.c 5 files changed, 585 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, but someone else must approve diff --git a/include/osmocom/pfcp/Makefile.am b/include/osmocom/pfcp/Makefile.am index 7bd5ea3..5d2db19 100644 --- a/include/osmocom/pfcp/Makefile.am +++ b/include/osmocom/pfcp/Makefile.am @@ -1,4 +1,5 @@ pfcp_HEADERS = \ + pfcp_endpoint.h \ pfcp_ies_custom.h \ pfcp_ies_auto.h \ pfcp_msg.h \ diff --git a/include/osmocom/pfcp/pfcp_endpoint.h b/include/osmocom/pfcp/pfcp_endpoint.h new file mode 100644 index 0000000..acc878e --- /dev/null +++ b/include/osmocom/pfcp/pfcp_endpoint.h @@ -0,0 +1,107 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#pragma once + +#include <osmocom/core/socket.h> +#include <osmocom/core/select.h> +#include <osmocom/core/tdef.h> + +#include <osmocom/pfcp/pfcp_msg.h> + +struct osmo_pfcp_endpoint; +struct osmo_fsm_inst; + +#define OSMO_PFCP_TIMER_HEARTBEAT_REQ -19 +#define OSMO_PFCP_TIMER_HEARTBEAT_RESP -20 +#define OSMO_PFCP_TIMER_GRACEFUL_REL -21 +#define OSMO_PFCP_TIMER_T1 -22 +#define OSMO_PFCP_TIMER_N1 -23 +#define OSMO_PFCP_TIMER_KEEP_RESP -24 +#define OSMO_PFCP_TIMER_ASSOC_RETRY -26 + +extern struct osmo_tdef osmo_pfcp_tdefs[]; + +/* Ownership of m remains with the caller / m will be deallocated by the caller. + * \param ep The PFCP endpoint that received and decoded the message. + * \param m The message that was received. + * \param req If m is a PFCP Response to an earlier Request, req is that request message. Otherwise req is NULL. + */ +typedef void (*osmo_pfcp_endpoint_cb)(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m, + struct osmo_pfcp_msg *req); + +/* Send/receive PFCP messages to/from remote PFCP endpoints. */ +struct osmo_pfcp_endpoint { + struct { + /* Local address */ + struct osmo_sockaddr local_addr; + /* Local PFCP Node ID, as sent in outgoing messages' Node ID IE */ + struct osmo_pfcp_ie_node_id local_node_id; + + /* Timer definitions to use, if any. See t1_ms, keep_resp_ms. Use osmo_pfcp_tdefs by default. It is + * convenient to add osmo_pfcp_tdefs as one of your program's osmo_tdef_group entries and call + * osmo_tdef_vty_init() to expose PFCP timers on the VTY. */ + const struct osmo_tdef *tdefs; + } cfg; + + /* PFCP socket */ + struct osmo_fd pfcp_fd; + + /* The time at which this endpoint last restarted, as seconds since unix epoch. */ + uint32_t recovery_time_stamp; + + /* State for determining the next sequence number for transmitting a request message */ + uint32_t seq_nr_state; + + /* This function is called just after decoding and before handling the message. + * This function may set ctx.peer_fi and ctx.session_fi, used for logging context during message decoding. + * The caller may also use these fi pointers to reduce lookup iterations in rx_msg(). + */ + osmo_pfcp_endpoint_cb set_msg_ctx; + + /* Callback to receive single incoming PFCP messages from a remote peer, already decoded. */ + osmo_pfcp_endpoint_cb rx_msg; + + /* application-private data */ + void *priv; + + /* All transmitted PFCP Request messages, list of osmo_pfcp_queue_entry. + * For a transmitted Request message, wait for a matching Response from a remote peer; if none arrives, + * retransmit (see n1 and t1_ms). */ + struct llist_head sent_requests; + /* All transmitted PFCP Response messages, list of osmo_pfcp_queue_entry. + * For a transmitted Response message, keep it in the queue for a fixed amount of time. If the peer retransmits + * the original Request, do not dispatch the Request, but respond with the queued message directly. */ + struct llist_head sent_responses; +}; + +struct osmo_pfcp_endpoint *osmo_pfcp_endpoint_create(void *ctx, void *priv); +int osmo_pfcp_endpoint_bind(struct osmo_pfcp_endpoint *ep); +void osmo_pfcp_endpoint_close(struct osmo_pfcp_endpoint *ep); +void osmo_pfcp_endpoint_free(struct osmo_pfcp_endpoint **ep); + +int osmo_pfcp_endpoint_tx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m); +int osmo_pfcp_endpoint_tx_data(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m); +int osmo_pfcp_endpoint_tx_heartbeat_req(struct osmo_pfcp_endpoint *ep, const struct osmo_sockaddr *remote_addr); + +void osmo_pfcp_endpoint_invalidate_ctx(struct osmo_pfcp_endpoint *ep, struct osmo_fsm_inst *deleted_fi); diff --git a/include/osmocom/pfcp/pfcp_msg.h b/include/osmocom/pfcp/pfcp_msg.h index 949800e..2833408 100644 --- a/include/osmocom/pfcp/pfcp_msg.h +++ b/include/osmocom/pfcp/pfcp_msg.h @@ -147,6 +147,9 @@ osmo_pfcp_resp_cb resp_cb; void *priv; } ctx; + + /* When a message gets encoded, the encoded packet is cached here for possible retransmissions. */ + struct msgb *encoded; }; /* Given a &osmo_pfcp_msg->ies pointer, return the &osmo_pfcp_msg. diff --git a/src/libosmo-pfcp/Makefile.am b/src/libosmo-pfcp/Makefile.am index c8accb9..db81648 100644 --- a/src/libosmo-pfcp/Makefile.am +++ b/src/libosmo-pfcp/Makefile.am @@ -24,6 +24,7 @@ $(NULL) libosmo_pfcp_a_SOURCES = \ + pfcp_endpoint.c \ pfcp_ies_custom.c \ pfcp_msg.c \ pfcp_strs.c \ diff --git a/src/libosmo-pfcp/pfcp_endpoint.c b/src/libosmo-pfcp/pfcp_endpoint.c new file mode 100644 index 0000000..83b7c1a --- /dev/null +++ b/src/libosmo-pfcp/pfcp_endpoint.c @@ -0,0 +1,473 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * 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, see <http://www.gnu.org/licenses/>. + * + */ + +#include <errno.h> +#include <unistd.h> +#include <time.h> + +#include <osmocom/core/talloc.h> +#include <osmocom/core/timer.h> +#include <osmocom/core/tdef.h> + +#include <osmocom/pfcp/pfcp_endpoint.h> +#include <osmocom/pfcp/pfcp_msg.h> + +/*! Entry of pfcp_endpoint message queue of PFCP messages, for re-transsions. */ +struct osmo_pfcp_queue_entry { + /* entry in per-peer list of messages waiting for a response */ + struct llist_head entry; + /* back-pointer */ + struct osmo_pfcp_endpoint *ep; + /* message we have transmitted */ + struct osmo_pfcp_msg *m; + /* T1 timer: How long to wait for response before retransmitting */ + struct osmo_timer_list t1; + /* N1: number of pending re-transmissions */ + unsigned int n1_remaining; +}; + +/* Find a matching osmo_pfcp_queue_entry for given rx_hdr. + * A returned osmo_pfcp_queue_entry is guaranteed to be a Response if rx is a Request, and vice versa. */ +static struct osmo_pfcp_queue_entry * +osmo_pfcp_queue_find(struct llist_head *queue, const struct osmo_pfcp_msg *rx) +{ + struct osmo_pfcp_queue_entry *qe; + /* It's important to match only a Request to a Response and vice versa, because the remote peer makes its own + * sequence_nr. There could be a collision of sequence_nr. But as long as all Requests look for a Response and + * vice versa, the sequence_nr scopes don't overlap. */ + llist_for_each_entry(qe, queue, entry) { + if (qe->m->is_response != rx->is_response + && qe->m->h.sequence_nr == rx->h.sequence_nr) + return qe; + } + return NULL; +} + +/* clean up and deallocate the given osmo_pfcp_queue_entry */ +static void osmo_pfcp_queue_del(struct osmo_pfcp_queue_entry *qe) +{ + /* see also the talloc destructor: osmo_pfcp_queue_destructor() */ + talloc_free(qe); +} + +static int osmo_pfcp_queue_destructor(struct osmo_pfcp_queue_entry *qe) +{ + osmo_timer_del(&qe->t1); + llist_del(&qe->entry); + return 0; +} + +struct osmo_tdef osmo_pfcp_tdefs[] = { + { .T = OSMO_PFCP_MSGT_HEARTBEAT_REQ, .default_val = 15, .unit = OSMO_TDEF_S, + .desc = "PFCP Heartbeat Request period, how long to wait between issuing requests" + }, + { .T = OSMO_PFCP_MSGT_HEARTBEAT_RESP, .default_val = 15, .unit = OSMO_TDEF_S, + .desc = "PFCP Heartbeat Response timeout, the time after which to regard a non-responding peer as disconnected" + }, + { .T = OSMO_PFCP_TIMER_GRACEFUL_REL, .default_val = 15, .unit = OSMO_TDEF_S, + .desc = "PFCP peer graceful shutdown timeout, how long to keep the peer's state after a peer requested" + " graceful shutdown" + }, + { .T = OSMO_PFCP_TIMER_T1, .default_val = 3000, .unit = OSMO_TDEF_MS, + .desc = "PFCP request timeout, how long after a missing response to retransmit a PFCP request" + }, + { .T = OSMO_PFCP_TIMER_N1, .default_val = 3, .unit = OSMO_TDEF_CUSTOM, + .desc = "Number of PFCP request retransmission attempts" + }, + { .T = OSMO_PFCP_TIMER_KEEP_RESP, .default_val = 10000, .unit = OSMO_TDEF_MS, + .desc = "PFCP response timeout, how long to keep a response, in case its same request is retransmitted by the peer" + }, + { .T = OSMO_PFCP_TIMER_ASSOC_RETRY, .default_val = 15, .unit = OSMO_TDEF_S, + .desc = "Idle time between attempts of PFCP Association Setup (CPF)" + }, + {} +}; + +struct osmo_pfcp_endpoint *osmo_pfcp_endpoint_create(void *ctx, void *priv) +{ + struct osmo_pfcp_endpoint *ep = talloc_zero(ctx, struct osmo_pfcp_endpoint); + uint32_t unix_time; + if (!ep) + return NULL; + + INIT_LLIST_HEAD(&ep->sent_requests); + INIT_LLIST_HEAD(&ep->sent_responses); + + ep->cfg.tdefs = osmo_pfcp_tdefs; + ep->priv = priv; + ep->pfcp_fd.fd = -1; + + /* time() returns seconds since 1970 (UNIX epoch), but the recovery_time_stamp is coded in the NTP format, which is + * seconds since 1900, the NTP era 0. 2208988800L is the offset between UNIX epoch and NTP era 0. + * TODO: what happens when we enter NTP era 1? Is it sufficient to integer-wrap? */ + unix_time = time(NULL); + ep->recovery_time_stamp = unix_time + 2208988800L; + LOGP(DLPFCP, LOGL_NOTICE, "PFCP endpoint: recovery timestamp = 0x%08x (%u seconds since UNIX epoch," + " which is %u seconds since NTP era 0; IETF RFC 5905)\n", + ep->recovery_time_stamp, unix_time, ep->recovery_time_stamp); + + return ep; +} + +static unsigned int ep_n1(struct osmo_pfcp_endpoint *ep) +{ + return osmo_tdef_get(ep->cfg.tdefs, OSMO_PFCP_TIMER_N1, OSMO_TDEF_CUSTOM, -1); +} + +static unsigned int ep_t1(struct osmo_pfcp_endpoint *ep) +{ + return osmo_tdef_get(ep->cfg.tdefs, OSMO_PFCP_TIMER_T1, OSMO_TDEF_MS, -1); +} + +static unsigned int ep_keep_resp(struct osmo_pfcp_endpoint *ep) +{ + return osmo_tdef_get(ep->cfg.tdefs, OSMO_PFCP_TIMER_KEEP_RESP, OSMO_TDEF_MS, -1); +} + +static int osmo_pfcp_endpoint_tx_data_no_logging(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m); + +/* Return true to keep the message in the queue, false for dropping from the queue. */ +static bool pfcp_queue_retrans(struct osmo_pfcp_queue_entry *qe) +{ + struct osmo_pfcp_endpoint *endpoint = qe->ep; + unsigned int t1_ms = ep_t1(endpoint); + struct osmo_pfcp_msg *m = qe->m; + int rc; + + /* re-transmit */ + if (qe->n1_remaining) + qe->n1_remaining--; + OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "re-sending (%u attempts remaining)\n", qe->n1_remaining); + + rc = osmo_pfcp_endpoint_tx_data_no_logging(endpoint, m); + /* If encoding failed, it cannot ever succeed. Drop the queue entry. */ + if (rc) + return false; + /* if no more attempts remaining, drop from queue */ + if (!qe->n1_remaining) + return false; + /* re-schedule timer, keep in queue */ + osmo_timer_schedule(&qe->t1, t1_ms/1000, t1_ms%1000); + return true; +} + +/* T1 for a given queue entry has expired */ +static void pfcp_queue_timer_cb(void *data) +{ + struct osmo_pfcp_queue_entry *qe = data; + bool keep; + + if (qe->m->is_response) { + /* The response has waited in the queue for any retransmissions of its initiating request. Now that time + * has passed and the response can be dropped from the queue. */ + keep = false; + } else { + /* The request is still here, which means it has not received a response from the remote side. + * Retransmit the request. */ + keep = pfcp_queue_retrans(qe); + } + + if (keep) + return; + /* Drop the queue entry. No more retransmissions. */ + if (!qe->m->is_response && qe->m->ctx.resp_cb) + qe->m->ctx.resp_cb(qe->m, NULL, "PFCP retransmissions elapsed, no response received"); + osmo_pfcp_queue_del(qe); +} + +/* Directly encode and transmit the message, without storing in the retrans_queue. */ +static int osmo_pfcp_endpoint_tx_data_no_logging(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) +{ + int rc; + + if (!m->encoded) { + /* Allocate msgb as child of the message m, so that when m gets deallocated at the end of + * retransmission queueing, the msgb gets deallocated with it. */ + m->encoded = msgb_alloc_c(m, OSMO_PFCP_MSGB_ALLOC_SIZE, "PFCP-tx"); + OSMO_ASSERT(m->encoded); + rc = osmo_pfcp_msg_encode(m->encoded, m); + if (rc) { + msgb_free(m->encoded); + m->encoded = NULL; + return rc; + } + } + + rc = sendto(ep->pfcp_fd.fd, msgb_data(m->encoded), msgb_length(m->encoded), 0, + (struct sockaddr *)&m->remote_addr, sizeof(m->remote_addr)); + if (rc != msgb_length(m->encoded)) { + OSMO_LOG_PFCP_MSG(m, LOGL_ERROR, "sendto() failed: rc = %d != length %u\n", + rc, msgb_length(m->encoded)); + return -EIO; + } + return 0; +} + +int osmo_pfcp_endpoint_tx_data(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) +{ + OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "sending\n"); + return osmo_pfcp_endpoint_tx_data_no_logging(ep, m); +} + +int osmo_pfcp_endpoint_tx_heartbeat_req(struct osmo_pfcp_endpoint *ep, const struct osmo_sockaddr *remote_addr) +{ + struct osmo_pfcp_msg *tx = osmo_pfcp_msg_alloc_tx(OTC_SELECT, remote_addr, NULL, NULL, + OSMO_PFCP_MSGT_HEARTBEAT_REQ); + tx->ies.heartbeat_req.recovery_time_stamp = ep->recovery_time_stamp; + tx->h.sequence_nr = osmo_pfcp_next_seq_nr(&ep->seq_nr_state); + return osmo_pfcp_endpoint_tx_data(ep, tx); +} + +/* add a given msgb to the queue of per-peer messages waiting for a response */ +static int osmo_pfcp_endpoint_retrans_queue_add(struct osmo_pfcp_endpoint *endpoint, struct osmo_pfcp_msg *m) +{ + struct osmo_pfcp_queue_entry *qe; + unsigned int n1 = ep_n1(endpoint); + unsigned int t1_ms = ep_t1(endpoint); + unsigned int keep_resp_ms = ep_keep_resp(endpoint); + unsigned int timeout = m->is_response ? keep_resp_ms : t1_ms; + + LOGP(DLPFCP, LOGL_DEBUG, "retransmit unanswered Requests %u x %ums; keep sent Responses for %ums\n", + n1, t1_ms, keep_resp_ms); + /* If there are no retransmissions or no timeout, it makes no sense to add to the queue. */ + if (!n1 || !t1_ms) { + if (!m->is_response && m->ctx.resp_cb) + m->ctx.resp_cb(m, NULL, "PFCP timeout is zero, cannot wait for a response"); + return 0; + } + + qe = talloc(endpoint, struct osmo_pfcp_queue_entry); + OSMO_ASSERT(qe); + *qe = (struct osmo_pfcp_queue_entry){ + .ep = endpoint, + .m = m, + .n1_remaining = m->is_response ? 0 : n1, + }; + talloc_steal(qe, m); + + /* Slight optimization: Add sent requests to the start of the list: we will usually receive a response shortly + * after sending a request, removing that entry from the queue quickly. + * Add sent responses to the end of the list: they will rarely be retransmitted at all. */ + if (m->is_response) + llist_add_tail(&qe->entry, &endpoint->sent_responses); + else + llist_add_tail(&qe->entry, &endpoint->sent_requests); + talloc_set_destructor(qe, osmo_pfcp_queue_destructor); + + osmo_timer_setup(&qe->t1, pfcp_queue_timer_cb, qe); + osmo_timer_schedule(&qe->t1, timeout/1000, timeout%1000); + return 0; +} + +/* Transmit a PFCP message. + * Store the message in the local message queue for possible retransmissions. + * On success, return zero, and pass ownership of m to ep. ep deallocates m when all retransmissions are done / a reply + * has been received. + * On error, return nonzero, and immediately deallocate m. */ +int osmo_pfcp_endpoint_tx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) +{ + struct osmo_pfcp_ie_node_id *node_id; + int rc; + if (!m->is_response) + m->h.sequence_nr = osmo_pfcp_next_seq_nr(&ep->seq_nr_state); + node_id = osmo_pfcp_msg_node_id(m); + if (node_id) + *node_id = ep->cfg.local_node_id; + + rc = osmo_pfcp_endpoint_tx_data(ep, m); + if (rc) { + if (!m->is_response && m->ctx.resp_cb) + m->ctx.resp_cb(m, NULL, "Failed to transmit request"); + osmo_pfcp_msg_free(m); + return rc; + } + osmo_pfcp_endpoint_retrans_queue_add(ep, m); + return 0; +} + +static void osmo_pfcp_endpoint_handle_rx(struct osmo_pfcp_endpoint *ep, struct osmo_pfcp_msg *m) +{ + bool dispatch_rx = true; + struct osmo_pfcp_queue_entry *prev_msg; + struct osmo_pfcp_msg *req; + + if (m->h.message_type == OSMO_PFCP_MSGT_HEARTBEAT_REQ) { + /* Directly answer with a Heartbeat Response. */ + struct osmo_pfcp_msg *resp = osmo_pfcp_msg_alloc_tx(OTC_SELECT, NULL, NULL, m, OSMO_PFCP_MSGT_HEARTBEAT_RESP); + resp->ies.heartbeat_resp.recovery_time_stamp = ep->recovery_time_stamp; + osmo_pfcp_endpoint_tx_data(ep, resp); + /* Still also dispatch the Rx event to the peer. */ + } + + /* If this is receiving a response, search for matching sent request that is now completed. + * If this is receiving a request, search for a matching sent response that can be retransmitted. + * A match is found by sequence_nr. */ + prev_msg = osmo_pfcp_queue_find(m->is_response ? &ep->sent_requests : &ep->sent_responses, m); + + if (prev_msg && !m->is_response) { + /* m is a request, and we have already sent a response to this same request earlier. Retransmit the same + * response, and don't dispatch the msg rx. Keep our response queued in case the request is + * retransmitted yet another time. */ + + /* Populate message context to point at peer and session, if applicable. + * With that context applied, log message rx. */ + if (ep->set_msg_ctx) + ep->set_msg_ctx(ep, m, NULL); + OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "received retransmission of earlier request\n"); + + /* Also log on the earlier PFCP msg that it is resent */ + OSMO_LOG_PFCP_MSG(prev_msg->m, LOGL_INFO, "re-sending cached response\n"); + osmo_pfcp_endpoint_tx_data_no_logging(ep, prev_msg->m); + return; + } + + req = NULL; + if (prev_msg && m->is_response) { + /* m is a response to the earlier request prev_msg->m. The request is now ACKed and can be dropped from + * the retransmission queue: see 'if (req)' below. */ + req = prev_msg->m; + } + + /* Populate message context to point at peer and session, if applicable. + * With that context applied, log message rx. */ + if (ep->set_msg_ctx) + ep->set_msg_ctx(ep, m, req); + OSMO_LOG_PFCP_MSG(m, LOGL_INFO, "received\n"); + + if (req && req->ctx.resp_cb) { + int rc = req->ctx.resp_cb(req, m, NULL); + /* Only dispatch the response to rx_msg() when resp_cb() asks for it with rc == 1 (or when there is no + * resp_cb()). */ + if (rc != 1) { + dispatch_rx = false; + OSMO_LOG_PFCP_MSG(m, LOGL_DEBUG, + "response handled by m->resp_cb(), not dispatching to rx_msg()\n"); + } + } + + if (dispatch_rx) + ep->rx_msg(ep, m, req); + if (req) + osmo_pfcp_queue_del(prev_msg); +} + +/* call-back for PFCP socket file descriptor */ +static int osmo_pfcp_fd_cb(struct osmo_fd *ofd, unsigned int what) +{ + int rc; + struct osmo_pfcp_endpoint *ep = ofd->data; + + if (what & OSMO_FD_READ) { + struct osmo_sockaddr remote; + socklen_t remote_len = sizeof(remote); + struct msgb *msg = msgb_alloc_c(OTC_SELECT, OSMO_PFCP_MSGB_ALLOC_SIZE, "PFCP-rx"); + if (!msg) + return -ENOMEM; + + msg->l3h = msg->tail; + rc = recvfrom(ofd->fd, msg->tail, msgb_tailroom(msg), 0, (struct sockaddr *)&remote, &remote_len); + if (rc <= 0) + return -EIO; + msgb_put(msg, rc); + + OSMO_ASSERT(ep->rx_msg); + + /* This may be a bundle of PFCP messages. Parse and receive each message received, by shifting l4h + * through the message bundle. */ + msg->l4h = msg->l3h; + while (msgb_l4len(msg)) { + struct osmo_gtlv_load tlv; + struct osmo_pfcp_msg *m = osmo_pfcp_msg_alloc_rx(OTC_SELECT, &remote); + m->encoded = msg; + + rc = osmo_pfcp_msg_decode_header(&tlv, m, msg); + if (rc < 0) + break; + msg->l4h += rc; + + rc = osmo_pfcp_msg_decode_tlv(m, &tlv); + /* If errors occurred, they have already been logged on DLPFCP. */ + if (rc == 0) + osmo_pfcp_endpoint_handle_rx(ep, m); + osmo_pfcp_msg_free(m); + } + msgb_free(msg); + } + return 0; +} + +/*! bind a PFCP endpoint to its configured address (ep->cfg.local_addr). + * \return 0 on success, negative on error. */ +int osmo_pfcp_endpoint_bind(struct osmo_pfcp_endpoint *ep) +{ + int rc; + /* close the existing socket, if any */ + osmo_pfcp_endpoint_close(ep); + + if (!ep->rx_msg) { + LOGP(DLPFCP, LOGL_ERROR, "missing rx_msg cb at osmo_pfcp_endpoint\n"); + return -EINVAL; + } + + /* create the new socket, binding to configured local address */ + ep->pfcp_fd.cb = osmo_pfcp_fd_cb; + ep->pfcp_fd.data = ep; + rc = osmo_sock_init_osa_ofd(&ep->pfcp_fd, SOCK_DGRAM, IPPROTO_UDP, &ep->cfg.local_addr, NULL, OSMO_SOCK_F_BIND); + if (rc < 0) + return rc; + return 0; +} + +void osmo_pfcp_endpoint_close(struct osmo_pfcp_endpoint *ep) +{ + struct osmo_pfcp_queue_entry *qe; + while ((qe = llist_first_entry_or_null(&ep->sent_requests, struct osmo_pfcp_queue_entry, entry))) + osmo_pfcp_queue_del(qe); + while ((qe = llist_first_entry_or_null(&ep->sent_responses, struct osmo_pfcp_queue_entry, entry))) + osmo_pfcp_queue_del(qe); + + if (ep->pfcp_fd.fd != -1) { + osmo_fd_unregister(&ep->pfcp_fd); + close(ep->pfcp_fd.fd); + ep->pfcp_fd.fd = -1; + } +} + +void osmo_pfcp_endpoint_free(struct osmo_pfcp_endpoint **ep) +{ + if (!*ep) + return; + osmo_pfcp_endpoint_close(*ep); + talloc_free(*ep); + *ep = NULL; +} + +/* Call osmo_pfcp_msg_invalidate_ctx(deleted_fi) on all queued osmo_pfcp_msg instances in the retrans_queue. */ +void osmo_pfcp_endpoint_invalidate_ctx(struct osmo_pfcp_endpoint *ep, struct osmo_fsm_inst *deleted_fi) +{ + struct osmo_pfcp_queue_entry *qe; + llist_for_each_entry(qe, &ep->sent_requests, entry) + osmo_pfcp_msg_invalidate_ctx(qe->m, deleted_fi); + llist_for_each_entry(qe, &ep->sent_responses, entry) + osmo_pfcp_msg_invalidate_ctx(qe->m, deleted_fi); +} null-- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/28244 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ic8d42e201b63064a71b40ca45a5a40e29941e8ac Gerrit-Change-Number: 28244 Gerrit-PatchSet: 4 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-CC: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: merged

1 0

Jump to page:

2026

2025

2024

2023

2022

gerrit-log