March 2026 - gerrit-log - lists.osmocom.org

[S] Change in ...osmo-s1gw[master]: enb_{proxy,registry}: signal MME conn info on SCTP comm_up
by fixeria 20 Mar '26

20 Mar '26

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42445?usp=email ) Change subject: enb_{proxy,registry}: signal MME conn info on SCTP comm_up ...................................................................... enb_{proxy,registry}: signal MME conn info on SCTP comm_up Previously, mme_aid/mme_saddr/mme_sport were only signalled to the enb_registry once the S1 Setup procedure completed. This meant the REST API could not show MME connection details for eNBs stuck in wait_s1setup_rsp state (e.g. due to a slow or retrying MME). Add notify_mme_comm_up/2, called at SCTP comm_up, which stores the full conn_info (including mme_aid, mme_saddr, mme_sport) in the registry as soon as the SCTP connection is established. notify_mme_connected/2 is simplified to notify_mme_connected/1: it now only flips the state to 'connected', since conn_info is already stored. Change-Id: Iea9ba4fdf961e6cd262edc154884a2eee3d95355 Related: SYS#7066 --- M src/enb_proxy.erl M src/enb_registry.erl 2 files changed, 22 insertions(+), 11 deletions(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/45/42445/1 diff --git a/src/enb_proxy.erl b/src/enb_proxy.erl index 17296bd..6a7254e 100644 --- a/src/enb_proxy.erl +++ b/src/enb_proxy.erl @@ -251,12 +251,14 @@ {ok, {MmeLAddr, MmeLPort}} = inet:sockname(Socket), ?LOG_NOTICE("MME ~p: connection (id=~p, ~p:~p) established", [MmeName, Aid, MmeAddr, MmePort]), + NewS = S#state{mme_aid = Aid, + mme_saddr = MmeLAddr, + mme_sport = MmeLPort}, %% send the S1 SETUP REQUEST PDU to the MME - sctp_send_from_enb(S#state.s1setup_req, - S#state{mme_aid = Aid}), - {next_state, wait_s1setup_rsp, S#state{mme_aid = Aid, - mme_saddr = MmeLAddr, - mme_sport = MmeLPort}}; + sctp_send_from_enb(S#state.s1setup_req, NewS), + %% surface MME connection details before S1 Setup completes + enb_registry:notify_mme_comm_up(S#state.enb_handle, conn_info(NewS)), + {next_state, wait_s1setup_rsp, NewS}; _ -> ?LOG_NOTICE("MME ~p: connection establishment failed: ~p", [MmeName, ConnState]), @@ -352,7 +354,7 @@ %% CONNECTED state connected(enter, OldState, S) -> ?LOG_INFO("State change: ~p -> ~p", [OldState, ?FUNCTION_NAME]), - enb_registry:notify_mme_connected(S#state.enb_handle, conn_info(S)), + enb_registry:notify_mme_connected(S#state.enb_handle), {keep_state, S}; %% Handle an eNB -> MME data forwarding request (forward) diff --git a/src/enb_registry.erl b/src/enb_registry.erl index 0ad20ba..2bf6e47 100644 --- a/src/enb_registry.erl +++ b/src/enb_registry.erl @@ -46,8 +46,9 @@ notify_enb_connected/2, notify_genb_id/2, notify_mme_connecting/2, + notify_mme_comm_up/2, notify_mme_wait_rsp/1, - notify_mme_connected/2, + notify_mme_connected/1, fetch_enb_info/1, fetch_enb_list/0, fetch_enb_list/1, @@ -132,7 +133,15 @@ %% MME connection attempt in progress; stores selected MME info, clears any stale mme_conn_info -spec notify_mme_connecting(enb_handle(), mme_registry:mme_info()) -> ok. notify_mme_connecting(Handle, MmeInfo) -> - enb_update(Handle, [{state, connecting}, {mme_info, MmeInfo}, {mme_conn_info, undefined}]). + enb_update(Handle, [{state, connecting}, + {mme_info, MmeInfo}, + {mme_conn_info, undefined}]). + + +%% MME SCTP comm_up; connection details (aid, saddr, sport) are now known +-spec notify_mme_comm_up(enb_handle(), enb_proxy:conn_info()) -> ok. +notify_mme_comm_up(Handle, ConnInfo) -> + enb_update(Handle, [{mme_conn_info, ConnInfo}]). %% MME SCTP link established; S1 SETUP REQUEST forwarded, awaiting response @@ -142,9 +151,9 @@ %% S1 SETUP complete; eNB is fully operational --spec notify_mme_connected(enb_handle(), enb_proxy:conn_info()) -> ok. -notify_mme_connected(Handle, ConnInfo) -> - enb_update(Handle, [{state, connected}, {mme_conn_info, ConnInfo}]). +-spec notify_mme_connected(enb_handle()) -> ok. +notify_mme_connected(Handle) -> + enb_update(Handle, [{state, connected}]). -spec fetch_enb_info(enb_handle() | pid()) -> {ok, enb_info()} | error. -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42445?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: Iea9ba4fdf961e6cd262edc154884a2eee3d95355 Gerrit-Change-Number: 42445 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[XS] Change in osmo-ttcn3-hacks[master]: eIM_Tests: align RSP version number in HTTP header
by fixeria 20 Mar '26

20 Mar '26

Attention is currently required from: dexter. fixeria has posted comments on this change by dexter. ( https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/42434?usp=email ) Change subject: eIM_Tests: align RSP version number in HTTP header ...................................................................... Patch Set 1: Code-Review+1 -- To view, visit https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/42434?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: osmo-ttcn3-hacks Gerrit-Branch: master Gerrit-Change-Id: I125c3b13697c71d35788e54b7d88a9f943bb7a71 Gerrit-Change-Number: 42434 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Thu, 19 Mar 2026 19:26:36 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

[M] Change in pysim[master]: transport: change APDU format paradigm
by fixeria 20 Mar '26

20 Mar '26

Attention is currently required from: daniel, dexter, laforge, neels. fixeria has posted comments on this change by dexter. ( https://gerrit.osmocom.org/c/pysim/+/42441?usp=email ) Change subject: transport: change APDU format paradigm ...................................................................... Patch Set 1: (1 comment) File pySim/commands.py: https://gerrit.osmocom.org/c/pysim/+/42441/comment/9c6e719a_072c902c?usp=em… : PS1, Line 93: Args: You're missing to update API docs here and below (new parameter). -- To view, visit https://gerrit.osmocom.org/c/pysim/+/42441?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I9a531a825def318b28bf58291d811cf119003fab Gerrit-Change-Number: 42441 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: daniel <dwillmann(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-CC: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: neels <nhofmeyr(a)sysmocom.de> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: daniel <dwillmann(a)sysmocom.de> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Thu, 19 Mar 2026 19:25:37 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No

1 0

[L] Change in pysim[master]: docs/put_key: add tutorial that explains how to manage global platfor...
by fixeria 20 Mar '26

20 Mar '26

Attention is currently required from: daniel, dexter, laforge, neels. fixeria has posted comments on this change by dexter. ( https://gerrit.osmocom.org/c/pysim/+/42353?usp=email ) Change subject: docs/put_key: add tutorial that explains how to manage global platform keys ...................................................................... Patch Set 4: (7 comments) File docs/put_key-tutorial.rst: https://gerrit.osmocom.org/c/pysim/+/42353/comment/9a08cf9e_2c3d4711?usp=em… : PS4, Line 16: It It's https://gerrit.osmocom.org/c/pysim/+/42353/comment/7ceaf48a_a1171787?usp=em… : PS4, Line 39: exists [two domains] exist https://gerrit.osmocom.org/c/pysim/+/42353/comment/e1e6bc27_6b31c18e?usp=em… : PS4, Line 46: there will there will be https://gerrit.osmocom.org/c/pysim/+/42353/comment/f176888e_78814630?usp=em… : PS4, Line 67: we simply have `pySim-shell` : into making the GlobalPlatform related commands available something is not right here, do you mean "we simply force pySim-shell"? https://gerrit.osmocom.org/c/pysim/+/42353/comment/580b829a_2579c42a?usp=em… : PS4, Line 91: Along with the card we have received the following keyset: Maybe add an extra warning/clarification here that each card has its own unique keyset, and the given example values are not valid for other cards? https://gerrit.osmocom.org/c/pysim/+/42353/comment/3640903d_6550ce3e?usp=em… : PS4, Line 108: establish_scp02 Don't we need to specify `--key-ver 122` here? https://gerrit.osmocom.org/c/pysim/+/42353/comment/078ef73b_2442bb88?usp=em… : PS4, Line 440: That different schemes are possible shows the second example Looks like the halves of this sentence are swapped. How about: "the second example shows that different ]]ъu are possible"? -- To view, visit https://gerrit.osmocom.org/c/pysim/+/42353?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I163dfedca3df572cb8442e9a4a280e6c5b00327e Gerrit-Change-Number: 42353 Gerrit-PatchSet: 4 Gerrit-Owner: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: daniel <dwillmann(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-CC: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: neels <nhofmeyr(a)sysmocom.de> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: daniel <dwillmann(a)sysmocom.de> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Thu, 19 Mar 2026 19:19:44 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No

1 0

[L] Change in osmo-trx[master]: transceiver: add optional WebSDR device support
by Timur Davydov 20 Mar '26

20 Mar '26

Attention is currently required from: Hoernchen, fixeria, laforge, pespin. Timur Davydov has posted comments on this change by Timur Davydov. ( https://gerrit.osmocom.org/c/osmo-trx/+/42411?usp=email ) Change subject: transceiver: add optional WebSDR device support ...................................................................... Patch Set 10: (1 comment) File Transceiver52M/Transceiver.cpp: https://gerrit.osmocom.org/c/osmo-trx/+/42411/comment/709001f7_55929b8f?usp… : PS10, Line 1132: msgLen = read(mDataSockets[chan], buffer, sizeof(buffer)); > You should instead properly split read/write from/to sockets into its own method. Could you please clarify if I understood you correctly? Do you mean that the socket read/write operations should be split into separate methods, and then overridden in the WebSDR subclass so that, instead of operating on sockets, they would operate on some intermediate buffers? That approach should work, and architecturally it would probably look cleaner. My concern is that in the WebSDR case this would require placing the data into an intermediate buffer before calling method, as example driveTxPriorityQueue, and then reading it back here, which introduces an extra copy and may negatively affect performance. Is that the direction you had in mind? -- To view, visit https://gerrit.osmocom.org/c/osmo-trx/+/42411?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: osmo-trx Gerrit-Branch: master Gerrit-Change-Id: Ia0d340c323c2eea28fbe82601ba0af7cfbd68f6d Gerrit-Change-Number: 42411 Gerrit-PatchSet: 10 Gerrit-Owner: Timur Davydov <dtv.comp(a)gmail.com> Gerrit-Reviewer: Hoernchen <ewild(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-CC: pespin <pespin(a)sysmocom.de> Gerrit-Attention: Hoernchen <ewild(a)sysmocom.de> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Thu, 19 Mar 2026 19:19:00 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: pespin <pespin(a)sysmocom.de>

1 0

[S] Change in osmo-ci[master]: jobs: add build/manuals JOB_TYPEs for osmo-s1gw
by fixeria 20 Mar '26

20 Mar '26

Attention is currently required from: osmith, pespin. fixeria has posted comments on this change by fixeria. ( https://gerrit.osmocom.org/c/osmo-ci/+/42370?usp=email ) Change subject: jobs: add build/manuals JOB_TYPEs for osmo-s1gw ...................................................................... Patch Set 1: (1 comment) This change is ready for review. Patchset: PS1: > Because `I54f0774575534519a2c40e0588f136c8a5e706f8` is not merged yet. Not it's merged, unsetting the WIP flag. -- To view, visit https://gerrit.osmocom.org/c/osmo-ci/+/42370?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: osmo-ci Gerrit-Branch: master Gerrit-Change-Id: Id62d806a648c8f3480cb4f162adf65f77c552848 Gerrit-Change-Number: 42370 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-Attention: osmith <osmith(a)sysmocom.de> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Comment-Date: Thu, 19 Mar 2026 18:42:51 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: osmith <osmith(a)sysmocom.de> Comment-In-Reply-To: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[S] Change in ...osmo-s1gw[master]: [REST] EnbItem: expose name of the selected MME
by fixeria 20 Mar '26

20 Mar '26

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42431?usp=email ) ( 1 is the latest approved patch-set. No files were changed between the latest approved patch-set and the submitted one. )Change subject: [REST] EnbItem: expose name of the selected MME ...................................................................... [REST] EnbItem: expose name of the selected MME For each eNB connection, include the name of the MME that was selected from the pool. Update the OpenAPI spec, CLI (enb_list/enb_info tables), and user manual accordingly. Change-Id: I4839275efa5d3545e84d684ad1b8b989214ef76a Related: SYS#7066, SYS#7052 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M doc/manuals/chapters/cli.adoc M doc/manuals/chapters/rest.adoc M priv/openapi.json M src/rest_server.erl 6 files changed, 18 insertions(+), 6 deletions(-) Approvals: Jenkins Builder: Verified osmith: Looks good to me, but someone else must approve pespin: Looks good to me, approved diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index d07dd21..55448f4 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -438,6 +438,9 @@ mme_sctp_aid: type: integer description: SCTP association identifier of the S1GW-MME connection + mme_name: + type: string + description: Human-readable identifier of the selected MME Config: type: object diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 52d0897..3878708 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -406,6 +406,7 @@ 'State': item.get('state'), 'eNB addr:port (aid)': enb_addr(item) if 'enb_saddr' in item else None, 'MME addr:port (aid)': mme_addr(item) if 'mme_daddr' in item else None, + 'MME name': item.get('mme_name'), 'Uptime (s)': item.get('uptime'), '# E-RABs': item.get('erab_count'), } diff --git a/doc/manuals/chapters/cli.adoc b/doc/manuals/chapters/cli.adoc index 2a4951e..f24016b 100644 --- a/doc/manuals/chapters/cli.adoc +++ b/doc/manuals/chapters/cli.adoc @@ -285,11 +285,11 @@ ---- OsmoS1GW# enb_list -| handle | PID | Global-eNB-ID | State | eNB addr:port (aid) | MME addr:port (aid) | Uptime | E-RABs | -|----------|-----------|---------------|-----------|-------------------------|-------------------------|----------|----------| -| 0 | <0.699.0> | 001-01-0 | connected | 127.0.1.10:56767 (5706) | 127.0.2.10:36412 (5707) | 418 | 0 | -| 1 | <0.701.0> | 001-01-1 | connected | 127.0.1.10:54140 (5710) | 127.0.2.10:36412 (5711) | 33 | 3 | -| 2 | <0.703.0> | 001-01-2 | connected | 127.0.1.10:34076 (5714) | 127.0.2.10:36412 (5715) | 3600 | 20 | +| handle | PID | Global-eNB-ID | State | eNB addr:port (aid) | MME addr:port (aid) | MME name | Uptime | E-RABs | +|----------|-----------|---------------|-----------|-------------------------|-------------------------|----------|----------|----------| +| 0 | <0.699.0> | 001-01-0 | connected | 127.0.1.10:56767 (5706) | 127.0.2.10:36412 (5707) | mme0 | 418 | 0 | +| 1 | <0.701.0> | 001-01-1 | connected | 127.0.1.10:54140 (5710) | 127.0.2.10:36412 (5711) | mme0 | 33 | 3 | +| 2 | <0.703.0> | 001-01-2 | connected | 127.0.1.10:34076 (5714) | 127.0.2.10:36412 (5715) | mme0 | 3600 | 20 | ---- ==== `enb_info` @@ -323,6 +323,7 @@ | State | connected | | eNB addr:port (aid) | 127.0.1.10:57362 (5734) | | MME addr:port (aid) | 127.0.2.10:36412 (5745) | +| MME name | mme0 | | Uptime (s) | 521 | | # E-RABs | 99 | ---- diff --git a/doc/manuals/chapters/rest.adoc b/doc/manuals/chapters/rest.adoc index c907ece..7c1383b 100644 --- a/doc/manuals/chapters/rest.adoc +++ b/doc/manuals/chapters/rest.adoc @@ -258,6 +258,7 @@ "enb_saddr": "192.168.1.10", "enb_sport": 56767, "enb_sctp_aid": 5706, + "mme_name": "mme0", "mme_daddr": "192.168.2.10", "mme_dport": 36412, "mme_sport": 34500, @@ -276,6 +277,7 @@ `wait_s1setup_rsp`, or `connected`. `enb_saddr` / `enb_sport`:: Source address and port of the eNB's SCTP connection. `enb_sctp_aid`:: SCTP association ID of the eNB-S1GW connection. +`mme_name`:: Name of the selected MME (from the MME pool). `mme_daddr` / `mme_dport`:: Destination address and port of the MME. `mme_sport`:: Local source port of the S1GW-MME SCTP connection. `mme_sctp_aid`:: SCTP association ID of the S1GW-MME connection. diff --git a/priv/openapi.json b/priv/openapi.json index cab9fc0..59c9676 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -645,6 +645,10 @@ "mme_sctp_aid": { "type": "integer", "description": "SCTP association identifier of the S1GW-MME connection" + }, + "mme_name": { + "type": "string", + "description": "Human-readable identifier of the selected MME" } } }, diff --git a/src/rest_server.erl b/src/rest_server.erl index 76c575d..3b14b86 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -471,7 +471,8 @@ -spec enb_item_add_mme_info(map(), enb_registry:enb_info()) -> map(). enb_item_add_mme_info(M0, #{mme_info := MmeInfo}) -> - M0#{mme_daddr => inet:ntoa(maps:get(raddr, MmeInfo)), + M0#{mme_name => maps:get(name, MmeInfo), + mme_daddr => inet:ntoa(maps:get(raddr, MmeInfo)), mme_dport => maps:get(rport, MmeInfo) }; -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42431?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: I4839275efa5d3545e84d684ad1b8b989214ef76a Gerrit-Change-Number: 42431 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 0

[M] Change in ...osmo-s1gw[master]: [REST] Implement PfcpAssoc{Setup,Release}
by fixeria 20 Mar '26

20 Mar '26

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42430?usp=email ) ( 1 is the latest approved patch-set. No files were changed between the latest approved patch-set and the submitted one. )Change subject: [REST] Implement PfcpAssoc{Setup,Release} ...................................................................... [REST] Implement PfcpAssoc{Setup,Release} Change-Id: I2e24544563e4c4d23bb3d8a4a7b5434191b482d8 Related: SYS#7066 --- M contrib/osmo-s1gw-cli.py M doc/manuals/chapters/cli.adoc M src/pfcp_peer.erl M src/rest_server.erl 4 files changed, 65 insertions(+), 4 deletions(-) Approvals: osmith: Looks good to me, but someone else must approve pespin: Looks good to me, approved Jenkins Builder: Verified diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 51a9c4f..52d0897 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -250,12 +250,16 @@ @cmd2.with_category(CAT_PFCP) def do_pfcp_assoc_setup(self, opts) -> None: ''' Initiate the PFCP Association Setup procedure ''' - raise NotImplementedError + data = self.iface.pfcp_assoc_setup() + if not data['success']: + self.perror('PFCP Association Setup request failed: {message}'.format(**data)) @cmd2.with_category(CAT_PFCP) def do_pfcp_assoc_release(self, opts) -> None: ''' Initiate the PFCP Association Release procedure ''' - raise NotImplementedError + data = self.iface.pfcp_assoc_release() + if not data['success']: + self.perror('PFCP Association Release request failed: {message}'.format(**data)) @cmd2.with_category(CAT_PFCP) def do_pfcp_heartbeat(self, opts) -> None: diff --git a/doc/manuals/chapters/cli.adoc b/doc/manuals/chapters/cli.adoc index 279c445..2a4951e 100644 --- a/doc/manuals/chapters/cli.adoc +++ b/doc/manuals/chapters/cli.adoc @@ -155,6 +155,14 @@ | Remote Recovery TimeStamp | 3965211123 | ---- +==== `pfcp_assoc_setup` + +Initiate the PFCP Association Setup procedure. + +==== `pfcp_assoc_release` + +Initiate the PFCP Association Release procedure. + ==== `pfcp_heartbeat` Send a PFCP Heartbeat Request to the UPF and display the result. diff --git a/src/pfcp_peer.erl b/src/pfcp_peer.erl index 6308f50..aee679a 100644 --- a/src/pfcp_peer.erl +++ b/src/pfcp_peer.erl @@ -42,6 +42,8 @@ code_change/4, terminate/3]). -export([start_link/2, + assoc_setup/0, + assoc_release/0, seid_alloc/0, heartbeat_req/0, heartbeat_req/1, @@ -115,6 +117,18 @@ []). +%% Initiate the PFCP Association Setup procedure +-spec assoc_setup() -> ok | {error, term()}. +assoc_setup() -> + gen_statem:call(?MODULE, ?FUNCTION_NAME). + + +%% Initiate the PFCP Association Release procedure +-spec assoc_release() -> ok | {error, term()}. +assoc_release() -> + gen_statem:call(?MODULE, ?FUNCTION_NAME). + + %% Request to allocate a unique SEID -spec seid_alloc() -> {ok, pfcp_seid()} | {error, term()}. @@ -240,6 +254,13 @@ {keep_state, S0} end; +connecting({call, From}, assoc_setup, S) -> + %% Force retransmission of the PFCP Association Setup Request + {repeat_state, S, [{reply, From, ok}]}; + +connecting({call, From}, assoc_release, _S) -> + {keep_state_and_data, [{reply, From, {error, not_connected}}]}; + connecting(Event, EventData, S) -> handle_event(?FUNCTION_NAME, Event, EventData, S). @@ -288,6 +309,14 @@ {keep_state, S0} end; +connected({call, From}, assoc_setup, _S) -> + {keep_state_and_data, [{reply, From, {error, already_connected}}]}; + +connected({call, From}, assoc_release, S) -> + send_assoc_release(S), + {next_state, connecting, S#peer_state{rem_rts = undefined}, + [{reply, From, ok}]}; + %% Catch-all handler for this state connected(Event, EventData, S) -> handle_event(?FUNCTION_NAME, Event, EventData, S). diff --git a/src/rest_server.erl b/src/rest_server.erl index 0beaaca..76c575d 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -37,6 +37,8 @@ -export([config_read/1, metrics_list/1, pfcp_assoc_state/1, + pfcp_assoc_setup/1, + pfcp_assoc_release/1, pfcp_heartbeat/1, mme_list/1, mme_add/1, @@ -97,8 +99,26 @@ Info2 = maps:update_with(raddr, fun inet:ntoa/1, Info1), {200, [], rsp_map(Info2)}. -%% TODO: PfcpAssocSetup :: Initiate the PFCP Association Setup procedure -%% TODO: PfcpAssocRelease :: Initiate the PFCP Association Release procedure +%% PfcpAssocSetup :: Initiate the PFCP Association Setup procedure +pfcp_assoc_setup(#{}) -> + case pfcp_peer:assoc_setup() of + ok -> + {200, [], rsp_map(#{success => true})}; + {error, Error} -> + {200, [], rsp_map(#{success => false, + message => Error})} + end. + + +%% PfcpAssocRelease :: Initiate the PFCP Association Release procedure +pfcp_assoc_release(#{}) -> + case pfcp_peer:assoc_release() of + ok -> + {200, [], rsp_map(#{success => true})}; + {error, Error} -> + {200, [], rsp_map(#{success => false, + message => Error})} + end. %% PfcpHeartbeat :: Send a PFCP Heartbeat Request to the peer -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42430?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: I2e24544563e4c4d23bb3d8a4a7b5434191b482d8 Gerrit-Change-Number: 42430 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 0

[L] Change in ...osmo-s1gw[master]: [REST] Add GET /config endpoint (ConfigRead)
by fixeria 20 Mar '26

20 Mar '26

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42416?usp=email ) ( 3 is the latest approved patch-set. No files were changed between the latest approved patch-set and the submitted one. )Change subject: [REST] Add GET /config endpoint (ConfigRead) ...................................................................... [REST] Add GET /config endpoint (ConfigRead) This endpoint returns the effective runtime configuration that OsmoS1GW is currently using, with all defaults applied. This reflects the values read via `osmo_s1gw:get_env/2` at startup. Change-Id: Ic6c9562a541e4a0728257538887537aac6b99b97 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M doc/manuals/chapters/cli.adoc M doc/manuals/chapters/rest.adoc A include/osmo_s1gw.hrl M priv/openapi.json M src/osmo_s1gw_sup.erl M src/rest_server.erl 8 files changed, 472 insertions(+), 13 deletions(-) Approvals: pespin: Looks good to me, approved osmith: Looks good to me, but someone else must approve Jenkins Builder: Verified diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index 6ab1346..c50ccce 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -66,6 +66,18 @@ '200': $ref: '#/components/responses/OperationResult' + /config: + get: + summary: Get the current runtime configuration + operationId: ConfigRead + responses: + '200': + description: Current runtime configuration + content: + application/json: + schema: + $ref: '#/components/schemas/Config' + /mme-list: get: summary: Get a list of registered MMEs @@ -427,6 +439,96 @@ type: integer description: SCTP association identifier of the S1GW-MME connection + Config: + type: object + properties: + sctp_server: + $ref: '#/components/schemas/SctpServerCfg' + sctp_client: + $ref: '#/components/schemas/SctpClientCfg' + pfcp: + $ref: '#/components/schemas/PfcpCfg' + gtpu_kpi: + $ref: '#/components/schemas/GtpuKpiCfg' + rest: + $ref: '#/components/schemas/RestCfg' + + SctpSockOptsCfg: + type: object + properties: + sctp_nodelay: + type: boolean + description: Disable/enable SCTP Nagle algorithm + recbuf: + type: integer + description: Receive buffer size (bytes) + sndbuf: + type: integer + description: Send buffer size (bytes) + + SctpServerCfg: + type: object + properties: + laddr: + type: string + description: Local (bind) IP address for eNB-facing SCTP server + lport: + type: integer + description: Local (bind) port for eNB-facing SCTP server + sockopts: + $ref: '#/components/schemas/SctpSockOptsCfg' + + SctpClientCfg: + description: > + Legacy/deprecated section kept for backwards compatibility. + MME pool entries are managed via the /mme-list endpoint. + type: object + properties: + laddr: + type: string + description: Local (bind) IP address for MME-facing SCTP connections + raddr: + type: string + description: Default remote (MME) IP address + rport: + type: integer + description: Default remote (MME) port + sockopts: + $ref: '#/components/schemas/SctpSockOptsCfg' + + PfcpCfg: + type: object + properties: + laddr: + type: string + description: Local IP address for PFCP communication + raddr: + type: string + description: Remote IP address of the UPF (PFCP peer) + + GtpuKpiCfg: + type: object + properties: + enable: + type: boolean + description: Whether GTP-U KPI reporting is enabled + table_name: + type: string + description: nftables table name for GTP-U KPI counters + interval: + type: integer + description: KPI polling interval in milliseconds + + RestCfg: + type: object + properties: + port: + type: integer + description: REST server listen port + swagger_ui: + type: boolean + description: Whether the Swagger UI is enabled + ErabList: type: array items: diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 265c5fc..5c37bdc 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -69,6 +69,11 @@ ''' Send an HTTP DELETE request to the given endpoint (path) ''' return self.send_req('DELETE', path, data) + def config_read(self) -> RESTResponse: + ''' ConfigRead :: Get the current runtime configuration ''' + with self.send_get_req('config') as f: + return json.load(f) + def fetch_spec(self) -> RESTResponse: ''' Fetch the OpenAPI specification (JSON) ''' with self.send_get_req('swagger/spec.json') as f: @@ -161,6 +166,7 @@ class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' + CAT_CONFIG = 'Configuration commands' CAT_METRICS = 'Metrics commands' CAT_PFCP = 'PFCP related commands' CAT_MME = 'MME related commands' @@ -184,6 +190,17 @@ self.iface = RestIface(argv.HOST, argv.port) + @cmd2.with_category(CAT_CONFIG) + def do_config_show(self, opts) -> None: + ''' Show the current runtime configuration ''' + data = self.iface.config_read() + for section, params in data.items(): + self.poutput(f'\n[{section}]') + table = [[k, v] for k, v in params.items()] + self.poutput(tabulate.tabulate(table, + headers=['Parameter', 'Value'], + tablefmt=self.tablefmt)) + def do_fetch_openapi_spec(self, opts): ''' Fetch the OpenAPI specification (JSON), dump as text ''' spec = self.iface.fetch_spec() diff --git a/doc/manuals/chapters/cli.adoc b/doc/manuals/chapters/cli.adoc index f9d9f50..418cd4b 100644 --- a/doc/manuals/chapters/cli.adoc +++ b/doc/manuals/chapters/cli.adoc @@ -53,6 +53,50 @@ [[cli_commands]] === Commands +==== `config_show` + +Display the effective runtime configuration (see <<rest_config>>). + +Example: + +---- +OsmoS1GW# config_show + +[gtpu_kpi] +| Parameter | Value | +|-------------|-----------| +| enable | False | +| interval | 3000 | +| table_name | osmo-s1gw | + +[pfcp] +| Parameter | Value | +|-------------|------------| +| laddr | 127.0.3.1 | +| raddr | 127.0.3.10 | + +[rest] +| Parameter | Value | +|-------------|---------| +| port | 8080 | +| swagger_ui | True | + +[sctp_client] +| Parameter | Value | +|-------------|----------------------------------------------------------| +| laddr | 127.0.2.1 | +| raddr | 127.0.2.10 | +| rport | 36412 | +| sockopts | {'recbuf': 65536, 'sctp_nodelay': True, 'sndbuf': 65536} | + +[sctp_server] +| Parameter | Value | +|-------------|----------------------------------------------------------| +| laddr | 127.0.1.1 | +| lport | 36412 | +| sockopts | {'recbuf': 65536, 'sctp_nodelay': True, 'sndbuf': 65536} | +---- + ==== `fetch_openapi_spec` Fetch the OpenAPI specification (JSON) from the server and display it. diff --git a/doc/manuals/chapters/rest.adoc b/doc/manuals/chapters/rest.adoc index e74acc2..c907ece 100644 --- a/doc/manuals/chapters/rest.adoc +++ b/doc/manuals/chapters/rest.adoc @@ -51,6 +51,72 @@ | Process ID | `pid:<x>.<y>.<z>` | `pid:0.33.1` |=== +[[rest_config]] +=== Configuration + +==== `GET /config` — Runtime Configuration + +Returns the effective runtime configuration that OsmoS1GW is currently +using, with all defaults applied. This reflects the values read via +`osmo_s1gw:get_env/2` at startup, which may differ from the raw +`sys.config` if legacy environment variables were merged in. + +Response (HTTP 200): + +---- +{ + "sctp_server": { + "laddr": "127.0.1.1", + "lport": 36412, + "sockopts": {"recbuf": 65536, "sndbuf": 65536, "sctp_nodelay": true} + }, + "sctp_client": { + "laddr": "127.0.2.1", + "raddr": "127.0.2.10", + "rport": 36412, + "sockopts": {"recbuf": 65536, "sndbuf": 65536, "sctp_nodelay": true} + }, + "pfcp": { + "laddr": "127.0.1.1", + "raddr": "127.0.1.2" + }, + "gtpu_kpi": { + "enable": false, + "table_name": "osmo-s1gw", + "interval": 3000 + }, + "rest": { + "port": 8080, + "swagger_ui": true + } +} +---- + +`sctp_server`:: Configuration of the eNB-facing SCTP server. + `laddr`::: Local bind address. + `lport`::: Local bind port. + `sockopts`::: Effective SCTP socket options, including defaults. + +`sctp_client`:: Legacy/deprecated section reflecting the MME-facing SCTP + client defaults. MME pool entries are managed via <<rest_mme>>. + `laddr`::: Local bind address. + `raddr`::: Default remote (MME) address. + `rport`::: Default remote (MME) port. + `sockopts`::: Effective SCTP socket options, including defaults. + +`pfcp`:: + `laddr`::: Local PFCP bind address. + `raddr`::: Remote UPF (PFCP peer) address. + +`gtpu_kpi`:: + `enable`::: Whether GTP-U KPI reporting via nftables counters is active. + `table_name`::: nftables table name used for GTP-U KPI counters. + `interval`::: KPI polling interval in milliseconds. + +`rest`:: + `port`::: REST server listen port. + `swagger_ui`::: Whether the Swagger UI endpoint is enabled. + [[rest_metrics]] === Metrics diff --git a/include/osmo_s1gw.hrl b/include/osmo_s1gw.hrl new file mode 100644 index 0000000..91bd2e6 --- /dev/null +++ b/include/osmo_s1gw.hrl @@ -0,0 +1,50 @@ +%% Copyright (C) 2026 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> +%% Author: Vadim Yanitskiy <vyanitskiy(a)sysmocom.de> +%% +%% All Rights Reserved +%% +%% SPDX-License-Identifier: AGPL-3.0-or-later +%% +%% This program is free software; you can redistribute it and/or modify +%% it under the terms of the GNU Affero General Public License as +%% published by the Free Software Foundation; either version 3 of the +%% License, or (at your option) any later version. +%% +%% This program is distributed in the hope that it will be useful, +%% but WITHOUT ANY WARRANTY; without even the implied warranty of +%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%% GNU General Public License for more details. +%% +%% You should have received a copy of the GNU Affero General Public License +%% along with this program. If not, see <https://www.gnu.org/licenses/>. +%% +%% Additional Permission under GNU AGPL version 3 section 7: +%% +%% If you modify this Program, or any covered work, by linking or +%% combining it with runtime libraries of Erlang/OTP as released by +%% Ericsson on https://www.erlang.org (or a modified version of these +%% libraries), containing parts covered by the terms of the Erlang Public +%% License (https://www.erlang.org/EPLICENSE), the licensors of this +%% Program grant you additional permission to convey the resulting work +%% without the need to license the runtime libraries of Erlang/OTP under +%% the GNU Affero General Public License. Corresponding Source for a +%% non-source form of such a combination shall include the source code +%% for the parts of the runtime libraries of Erlang/OTP used as well as +%% that of the covered work. + +%% Default values for application environment parameters (osmo_s1gw:get_env/2) + +-define(ENV_DEFAULT_S1GW_BIND_ADDR, "127.0.1.1"). +-define(ENV_DEFAULT_S1GW_BIND_PORT, 36412). +-define(ENV_DEFAULT_MME_LOC_ADDR, "127.0.2.1"). +-define(ENV_DEFAULT_MME_REM_ADDR, "127.0.2.10"). +-define(ENV_DEFAULT_MME_REM_PORT, 36412). +-define(ENV_DEFAULT_PFCP_LOC_ADDR, "127.0.1.1"). +-define(ENV_DEFAULT_PFCP_REM_ADDR, "127.0.1.2"). +-define(ENV_DEFAULT_GTPU_KPI_ENABLE, false). +-define(ENV_DEFAULT_GTPU_KPI_TABLE_NAME, "osmo-s1gw"). +-define(ENV_DEFAULT_GTPU_KPI_INTERVAL, 3000). +-define(ENV_DEFAULT_REST_SRV_PORT, 8080). +-define(ENV_DEFAULT_REST_SRV_SWAGGER_UI, true). + +%% vim:set ts=4 sw=4 et: diff --git a/priv/openapi.json b/priv/openapi.json index 87aafac..8289c02 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -100,6 +100,24 @@ } } }, + "/config": { + "get": { + "summary": "Get the current runtime configuration", + "operationId": "ConfigRead", + "responses": { + "200": { + "description": "Current runtime configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Config" + } + } + } + } + } + } + }, "/mme-list": { "get": { "summary": "Get a list of registered MMEs", @@ -630,6 +648,123 @@ } } }, + "Config": { + "type": "object", + "properties": { + "sctp_server": { + "$ref": "#/components/schemas/SctpServerCfg" + }, + "sctp_client": { + "$ref": "#/components/schemas/SctpClientCfg" + }, + "pfcp": { + "$ref": "#/components/schemas/PfcpCfg" + }, + "gtpu_kpi": { + "$ref": "#/components/schemas/GtpuKpiCfg" + }, + "rest": { + "$ref": "#/components/schemas/RestCfg" + } + } + }, + "SctpSockOptsCfg": { + "type": "object", + "properties": { + "sctp_nodelay": { + "type": "boolean", + "description": "Disable/enable SCTP Nagle algorithm" + }, + "recbuf": { + "type": "integer", + "description": "Receive buffer size (bytes)" + }, + "sndbuf": { + "type": "integer", + "description": "Send buffer size (bytes)" + } + } + }, + "SctpServerCfg": { + "type": "object", + "properties": { + "laddr": { + "type": "string", + "description": "Local (bind) IP address for eNB-facing SCTP server" + }, + "lport": { + "type": "integer", + "description": "Local (bind) port for eNB-facing SCTP server" + }, + "sockopts": { + "$ref": "#/components/schemas/SctpSockOptsCfg" + } + } + }, + "SctpClientCfg": { + "description": "Legacy/deprecated section kept for backwards compatibility. MME pool entries are managed via the /mme-list endpoint.\n", + "type": "object", + "properties": { + "laddr": { + "type": "string", + "description": "Local (bind) IP address for MME-facing SCTP connections" + }, + "raddr": { + "type": "string", + "description": "Default remote (MME) IP address" + }, + "rport": { + "type": "integer", + "description": "Default remote (MME) port" + }, + "sockopts": { + "$ref": "#/components/schemas/SctpSockOptsCfg" + } + } + }, + "PfcpCfg": { + "type": "object", + "properties": { + "laddr": { + "type": "string", + "description": "Local IP address for PFCP communication" + }, + "raddr": { + "type": "string", + "description": "Remote IP address of the UPF (PFCP peer)" + } + } + }, + "GtpuKpiCfg": { + "type": "object", + "properties": { + "enable": { + "type": "boolean", + "description": "Whether GTP-U KPI reporting is enabled" + }, + "table_name": { + "type": "string", + "description": "nftables table name for GTP-U KPI counters" + }, + "interval": { + "type": "integer", + "description": "KPI polling interval in milliseconds" + } + } + }, + "RestCfg": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "description": "REST server listen port" + }, + "swagger_ui": { + "type": "boolean", + "description": "Whether the Swagger UI is enabled" + } + } + }, "ErabList": { "type": "array", "items": { diff --git a/src/osmo_s1gw_sup.erl b/src/osmo_s1gw_sup.erl index 447dfc4..06174b2 100644 --- a/src/osmo_s1gw_sup.erl +++ b/src/osmo_s1gw_sup.erl @@ -38,21 +38,10 @@ -export([init/1, start_link/0]). +-include("osmo_s1gw.hrl"). -include("s1ap.hrl"). -define(SERVER, ?MODULE). --define(ENV_DEFAULT_S1GW_BIND_ADDR, "127.0.1.1"). --define(ENV_DEFAULT_S1GW_BIND_PORT, ?S1AP_PORT). --define(ENV_DEFAULT_MME_LOC_ADDR, "127.0.2.1"). --define(ENV_DEFAULT_MME_REM_ADDR, "127.0.2.10"). --define(ENV_DEFAULT_MME_REM_PORT, ?S1AP_PORT). --define(ENV_DEFAULT_PFCP_LOC_ADDR, "127.0.1.1"). --define(ENV_DEFAULT_PFCP_REM_ADDR, "127.0.1.2"). --define(ENV_DEFAULT_GTPU_KPI_ENABLE, false). --define(ENV_DEFAULT_GTPU_KPI_TABLE_NAME, "osmo-s1gw"). --define(ENV_DEFAULT_GTPU_KPI_INTERVAL, 3000). --define(ENV_DEFAULT_REST_SRV_PORT, 8080). --define(ENV_DEFAULT_REST_SRV_SWAGGER_UI, true). %% ------------------------------------------------------------------ %% supervisor API diff --git a/src/rest_server.erl b/src/rest_server.erl index e515445..550da3e 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -34,7 +34,8 @@ -module(rest_server). --export([metrics_list/1, +-export([config_read/1, + metrics_list/1, pfcp_assoc_state/1, pfcp_heartbeat/1, mme_list/1, @@ -52,6 +53,7 @@ -include_lib("kernel/include/logger.hrl"). +-include("osmo_s1gw.hrl"). -include("s1gw_metrics.hrl"). @@ -59,6 +61,17 @@ %% public API %% ------------------------------------------------------------------ +%% ConfigRead :: Get the current runtime configuration +config_read(#{}) -> + {200, [], #{ + <<"sctp_server">> => config_sctp_server(), + <<"sctp_client">> => config_sctp_client(), + <<"pfcp">> => config_pfcp(), + <<"gtpu_kpi">> => config_gtpu_kpi(), + <<"rest">> => config_rest() + }}. + + %% MetricsList :: Get a list of metrics metrics_list(#{query_parameters := QP}) -> L0 = case proplists:get_value(<< "type" >>, QP, << "all" >>) of @@ -221,6 +234,49 @@ %% private API %% ------------------------------------------------------------------ +-spec config_sctp_server() -> map(). +config_sctp_server() -> + Cfg = osmo_s1gw:get_env(sctp_server, #{}), + SockOptsCfg = maps:get(sockopts, Cfg, #{}), + #{<<"laddr">> => bval(maps:get(laddr, Cfg, ?ENV_DEFAULT_S1GW_BIND_ADDR)), + <<"lport">> => maps:get(lport, Cfg, ?ENV_DEFAULT_S1GW_BIND_PORT), + <<"sockopts">> => sockopts_to_map(sctp_common:gen_sockopts(SockOptsCfg))}. + + +-spec config_sctp_client() -> map(). +config_sctp_client() -> + Cfg = osmo_s1gw:get_env(sctp_client, #{}), + SockOpts = maps:get(sockopts, Cfg, []), + #{<<"laddr">> => bval(maps:get(laddr, Cfg, ?ENV_DEFAULT_MME_LOC_ADDR)), + <<"raddr">> => bval(maps:get(raddr, Cfg, ?ENV_DEFAULT_MME_REM_ADDR)), + <<"rport">> => maps:get(rport, Cfg, ?ENV_DEFAULT_MME_REM_PORT), + <<"sockopts">> => sockopts_to_map(SockOpts)}. + + +-spec config_pfcp() -> map(). +config_pfcp() -> + #{<<"laddr">> => bval(osmo_s1gw:get_env(pfcp_loc_addr, ?ENV_DEFAULT_PFCP_LOC_ADDR)), + <<"raddr">> => bval(osmo_s1gw:get_env(pfcp_rem_addr, ?ENV_DEFAULT_PFCP_REM_ADDR))}. + + +-spec config_gtpu_kpi() -> map(). +config_gtpu_kpi() -> + #{<<"enable">> => osmo_s1gw:get_env(gtpu_kpi_enable, ?ENV_DEFAULT_GTPU_KPI_ENABLE), + <<"table_name">> => bval(osmo_s1gw:get_env(gtpu_kpi_table_name, ?ENV_DEFAULT_GTPU_KPI_TABLE_NAME)), + <<"interval">> => osmo_s1gw:get_env(gtpu_kpi_interval, ?ENV_DEFAULT_GTPU_KPI_INTERVAL)}. + + +-spec config_rest() -> map(). +config_rest() -> + #{<<"port">> => osmo_s1gw:get_env(rest_srv_port, ?ENV_DEFAULT_REST_SRV_PORT), + <<"swagger_ui">> => osmo_s1gw:get_env(rest_srv_swagger_ui, ?ENV_DEFAULT_REST_SRV_SWAGGER_UI)}. + + +-spec sockopts_to_map([gen_sctp:option()]) -> map(). +sockopts_to_map(SockOpts) -> + maps:from_list([{atom_to_binary(K), V} || {K, V} <- SockOpts]). + + -spec metric_list(list()) -> [map()]. metric_list(Path) -> L = exometer:get_values(Path), -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42416?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: Ic6c9562a541e4a0728257538887537aac6b99b97 Gerrit-Change-Number: 42416 Gerrit-PatchSet: 4 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 0

[M] Change in ...osmo-s1gw[master]: [REST] Implement eNB/MME selection by addr-port
by fixeria 20 Mar '26

20 Mar '26

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42429?usp=email ) Change subject: [REST] Implement eNB/MME selection by addr-port ...................................................................... [REST] Implement eNB/MME selection by addr-port Add support for selecting an MME or eNB by remote address and port in the REST API and CLI. The selector format is `addr:IP:PORT` for MMEs and `enb-conn:IP:PORT` for eNBs, where IP can be an IPv4 or IPv6 address. The colon is used as the address/port separator. Change-Id: If02c8de1e1b7214bba868eee35233a79d0704dc5 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M doc/manuals/chapters/cli.adoc M priv/openapi.json M src/rest_server.erl 5 files changed, 99 insertions(+), 33 deletions(-) Approvals: Jenkins Builder: Verified fixeria: Looks good to me, approved pespin: Looks good to me, but someone else must approve diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index c50ccce..d07dd21 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -244,9 +244,9 @@ description: MME name example: mme0 - type: string - pattern: '^addr:[0-9a-f:.]+-[0-9]+$' + pattern: '^addr:[0-9a-f:.]+:[0-9]+$' description: MME remote address/port - example: addr:192.168.1.1-36412 + example: addr:192.168.1.1:36412 EnbId: name: EnbId @@ -272,9 +272,9 @@ description: eNB/MME SCTP association identifier example: enb-aid:42 - type: string - pattern: '^enb-conn:[0-9a-f:.]+-[0-9]+$' + pattern: '^enb-conn:[0-9a-f:.]+:[0-9]+$' description: eNB connection address/port - example: enb-conn:192.168.1.1-34650 + example: enb-conn:192.168.1.1:34650 ErabId: name: ErabId diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 5c37bdc..51a9c4f 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -117,14 +117,14 @@ with self.send_post_req('mme-list', mme_info) as f: return f.status - def mme_info(self, name: str) -> RESTResponse: + def mme_info(self, mme_id: str) -> RESTResponse: ''' MmeInfo :: Get information about a specific MME ''' - with self.send_get_req(f'mme/name:{name}') as f: + with self.send_get_req(f'mme/{mme_id}') as f: return json.load(f) - def mme_delete(self, name: str) -> int: - ''' MmeInfo :: Get information about a specific MME ''' - with self.send_delete_req(f'mme/name:{name}') as f: + def mme_delete(self, mme_id: str) -> int: + ''' MmeDelete :: Delete an MME from the pool ''' + with self.send_delete_req(f'mme/{mme_id}') as f: return f.status def enb_list(self) -> RESTResponse: @@ -349,6 +349,18 @@ self.iface.mme_add(mme_info) @staticmethod + def gen_mme_id(opts) -> str: + ''' Generate the MmeId parameter value (for URL) ''' + if opts.name is not None: + return f'name:{opts.name}' + elif opts.addr is not None: + addr, _, port = opts.addr.rpartition(':') + if addr and port.isdigit(): + return f'addr:{opts.addr}' + return f'addr:{opts.addr}:36412' + raise ValueError # shall not happen + + @staticmethod def add_mme_id_group(parser): ''' Add argparse group for the MmeId parameter ''' mme_id_group = parser.add_argument_group('MME ID') @@ -356,7 +368,10 @@ mme_id_group.add_argument('-N', '--name', type=str, help='MME name (example: mme0)') - # TODO: address/port + mme_id_group.add_argument('-a', '--addr', + type=str, metavar='ADDR[:PORT]', + help='MME address with optional port (default: 36412), ' + 'e.g. 192.168.1.1 or 192.168.1.1:36412') return mme_id_group mme_info_parser = cmd2.Cmd2ArgumentParser() @@ -366,14 +381,14 @@ @cmd2.with_category(CAT_MME) def do_mme_info(self, opts) -> None: ''' Get information about a specific MME ''' - data = self.iface.mme_info(opts.name) + data = self.iface.mme_info(self.gen_mme_id(opts)) self.mme_info_print(data) @cmd2.with_argparser(mme_info_parser) @cmd2.with_category(CAT_MME) def do_mme_delete(self, opts) -> None: ''' Delete an MME from the pool ''' - self.iface.mme_delete(opts.name) + self.iface.mme_delete(self.gen_mme_id(opts)) @staticmethod def enb_list_item(item: dict) -> dict: @@ -429,6 +444,8 @@ return f'enb-sctp-aid:{opts.enb_sctp_aid}' elif opts.mme_sctp_aid is not None: return f'mme-sctp-aid:{opts.mme_sctp_aid}' + elif opts.enb_conn is not None: + return f'enb-conn:{opts.enb_conn}' raise ValueError # shall not happen @staticmethod @@ -451,6 +468,9 @@ enb_id_group.add_argument('--mme-sctp-aid', type=int, metavar='AID', help='MME association identifier (example: 42)') + enb_id_group.add_argument('--enb-conn', + type=str, metavar='ADDR:PORT', + help='eNB connection address/port (example: 192.168.1.1:34650)') return enb_id_group enb_info_parser = cmd2.Cmd2ArgumentParser() diff --git a/doc/manuals/chapters/cli.adoc b/doc/manuals/chapters/cli.adoc index 418cd4b..279c445 100644 --- a/doc/manuals/chapters/cli.adoc +++ b/doc/manuals/chapters/cli.adoc @@ -218,13 +218,15 @@ ==== `mme_info` -Show configuration details for a specific MME, selected by name. +Show configuration details for a specific MME. ---- -Usage: mme_info [-h] -N NAME +Usage: mme_info [-h] (-N NAME | -a ADDR[:PORT]) MME ID: - -N, --name NAME MME name (example: mme0) + -N, --name NAME MME name (example: mme0) + -a, --addr ADDR[:PORT] MME address with optional port (default: 36412), + e.g. 192.168.1.1 or 192.168.1.1:36412 ---- Example: @@ -241,13 +243,15 @@ ==== `mme_delete` -Remove an MME from the pool, selected by name. +Remove an MME from the pool. ---- -Usage: mme_delete [-h] -N NAME +Usage: mme_delete [-h] (-N NAME | -a ADDR[:PORT]) MME ID: - -N, --name NAME MME name (example: mme0) + -N, --name NAME MME name (example: mme0) + -a, --addr ADDR[:PORT] MME address with optional port (default: 36412), + e.g. 192.168.1.1 or 192.168.1.1:36412 ---- Example: @@ -287,14 +291,16 @@ ---- Usage: enb_info [-h] (-H HANDLE | -P PID | -G GENBID | - --enb-sctp-aid AID | --mme-sctp-aid AID) + --enb-sctp-aid AID | --mme-sctp-aid AID | + --enb-conn ADDR:PORT) eNB ID: - -H, --handle HANDLE eNB handle (example: 0) - -P, --pid PID eNB process ID (example: 0.33.1) - -G, --genbid GENBID Global-eNB-ID (example: 262-42-1337) - --enb-sctp-aid AID eNB SCTP association identifier - --mme-sctp-aid AID MME SCTP association identifier + -H, --handle HANDLE eNB handle (example: 0) + -P, --pid PID eNB process ID (example: 0.33.1) + -G, --genbid GENBID Global-eNB-ID (example: 262-42-1337) + --enb-sctp-aid AID eNB SCTP association identifier + --mme-sctp-aid AID MME SCTP association identifier + --enb-conn ADDR:PORT eNB connection address/port (example: 192.168.1.1:34650) ---- Example: selecting by handle. @@ -315,8 +321,8 @@ ==== `enb_delete` -Force-disconnect an eNB, terminating its SCTP connection. The same -selectors as `enb_info` are accepted. +Force-disconnect an eNB, terminating its SCTP connection. Accepts the +same selectors as `enb_info`. ==== `enb_erab_list` @@ -326,7 +332,8 @@ Usage: enb_erab_list [-h] [-f] [-S {pid,state,mme_ue_id,erab_id}] [--reverse] (-H HANDLE | -P PID | -G GENBID | - --enb-sctp-aid AID | --mme-sctp-aid AID) + --enb-sctp-aid AID | --mme-sctp-aid AID | + --enb-conn ADDR:PORT) optional arguments: -f, --full Print full table including PFCP and GTP-U F-TEID columns diff --git a/priv/openapi.json b/priv/openapi.json index 8289c02..cab9fc0 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -379,9 +379,9 @@ }, { "type": "string", - "pattern": "^addr:[0-9a-f:.]+-[0-9]+$", + "pattern": "^addr:[0-9a-f:.]+:[0-9]+$", "description": "MME remote address/port", - "example": "addr:192.168.1.1-36412" + "example": "addr:192.168.1.1:36412" } ] } @@ -419,9 +419,9 @@ }, { "type": "string", - "pattern": "^enb-conn:[0-9a-f:.]+-[0-9]+$", + "pattern": "^enb-conn:[0-9a-f:.]+:[0-9]+$", "description": "eNB connection address/port", - "example": "enb-conn:192.168.1.1-34650" + "example": "enb-conn:192.168.1.1:34650" } ] } diff --git a/src/rest_server.erl b/src/rest_server.erl index 550da3e..0beaaca 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -272,6 +272,25 @@ <<"swagger_ui">> => osmo_s1gw:get_env(rest_srv_swagger_ui, ?ENV_DEFAULT_REST_SRV_SWAGGER_UI)}. +%% parse address/port from a string like "192.168.1.1:36412" +-spec parse_addr_port(Data) -> {ok, {Addr, Port}} | error + when Data :: binary() | string(), + Addr :: inet:ip_address(), + Port :: inet:port_number(). +parse_addr_port(Data) when is_binary(Data) -> + parse_addr_port(binary_to_list(Data)); + +parse_addr_port(Data) when is_list(Data) -> + case string:split(Data, ":", trailing) of + [AddrStr, PortStr] -> + case {inet:parse_address(AddrStr), string:to_integer(PortStr)} of + {{ok, Addr}, {Port, []}} -> {ok, {Addr, Port}}; + _ -> error + end; + _ -> error + end. + + -spec sockopts_to_map([gen_sctp:option()]) -> map(). sockopts_to_map(SockOpts) -> maps:from_list([{atom_to_binary(K), V} || {K, V} <- SockOpts]). @@ -368,7 +387,19 @@ MmeName = binary_to_list(Val), mme_registry:fetch_mme_info(MmeName); -%% TODO: '^addr:[0-9a-f:.]+-[0-9]+$' +fetch_mme_info(<< "addr:", Val/bytes >>) -> + case parse_addr_port(Val) of + {ok, {Addr, Port}} -> + Fun = fun(#{raddr := R, rport := P}) -> R =:= Addr andalso P =:= Port end, + case lists:filter(Fun, mme_registry:fetch_mme_list()) of + [MmeInfo | _] -> {ok, MmeInfo}; + [] -> error + end; + error -> + ?LOG_ERROR("Failed to parse MME addr:port from ~p", [Val]), + error + end; + fetch_mme_info(ID) -> ?LOG_ERROR("Unhandled MME ID ~p", [ID]), error. @@ -454,7 +485,15 @@ Aid = binary_to_integer(Val), enb_registry:fetch_enb_list({mme_sctp_aid, Aid}); -%% TODO: '^enb-conn:[0-9:.]+-[0-9]+$' +fetch_enb_info(<< "enb-conn:", Val/bytes >>) -> + case parse_addr_port(Val) of + {ok, AddrPort} -> + enb_registry:fetch_enb_list({enb_addr_port, AddrPort}); + error -> + ?LOG_ERROR("Failed to parse eNB addr:port from ~p", [Val]), + error + end; + fetch_enb_info(ID) -> ?LOG_ERROR("Unhandled eNB ID ~p", [ID]), error. -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42429?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: If02c8de1e1b7214bba868eee35233a79d0704dc5 Gerrit-Change-Number: 42429 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 0

2026

2025

2024

2023

2022

gerrit-log March 2026