- gerrit-log - lists.osmocom.org

[M] Change in osmo-ttcn3-hacks[master]: S1GW: Add test case to test release of e-RABs during handover prepera...
by fixeria 13 Sep '25

13 Sep '25

Attention is currently required from: jolly, pespin. fixeria has posted comments on this change by jolly. ( https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094?usp=email ) Change subject: S1GW: Add test case to test release of e-RABs during handover preperation ...................................................................... Patch Set 2: (5 comments) File s1gw/S1GW_ConnHdlr.ttcn: https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094/comment/8539cb30_2d35… : PS2, Line 1210: in ERabIdxList erabs_release := {}) > I vote for stopping adding more "in" churn :D For `ERabIdxList`, yes, we don't really need `in/out`. However we should keep using them for `ERabList`, to let the caller know if the given list is going to be modified or not. https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094/comment/d9b9440a_5010… : PS2, Line 1720: in ERabIdxList erabs_forward, > No more "in" churn please. Why are you so obsessed with this? https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094/comment/af12930b_322f… : PS2, Line 1718: function f_ConnHdlr_handover_cmd(MME_UE_S1AP_ID mme_ue_id, : ENB_UE_S1AP_ID enb_ue_id, : in ERabIdxList erabs_forward, : Nitpick: in the existing API, arguments `mme_ue_id` and `enb_ue_id` usually follow `ERabList`/`ERabIdxList` arguments. For the sake of consistency, I suggest: ```suggestion function f_ConnHdlr_handover_cmd(ERabIdxList erabs_forward, ERabIdxList erabs_release, MME_UE_S1AP_ID mme_ue_id, ENB_UE_S1AP_ID enb_ue_id) ``` File s1gw/S1GW_Tests.ttcn: https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094/comment/702e923f_fce6… : PS2, Line 911: for (var integer i := 0; i < lengthof(erabs_forward); i := i + 1) { I see this logic repeated in several places, so I think it's worth having a function in `S1GW_ConnHdlr` (next to `f_ERabList_find_by_pdu()`): ``` function f_ERabList_compose(ERabIdxList idx_list) runs on ConnHdlr return ERabList { var ERabList erabs; for (var integer i := 0; i < lengthof(idx_list); i := i + 1) { var ERabIdx idx := idx_list[i]; erabs[i] := g_pars.erabs[idx]; } return erabs; } ``` This way here you could do: ``` if (lengthof(erabs_forward) > 0) { var ERabList erabs := f_ERabList_compose(erabs_forward); f_ConnHdlr_erab_release_cmd(erabs, g_pars.mme_ue_id, g_pars.idx); f_ConnHdlr_erab_release_rsp(erabs, g_pars.mme_ue_id, g_pars.idx); } ``` https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094/comment/49ea8775_882e… : PS2, Line 912: tabs vs spaces -- To view, visit https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41094?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: Ic70ba19c0a6e349f63aae124607d075b6d19e779 Gerrit-Change-Number: 41094 Gerrit-PatchSet: 2 Gerrit-Owner: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: Jenkins Builder Gerrit-CC: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-CC: pespin <pespin(a)sysmocom.de> Gerrit-Attention: jolly <andreas(a)eversberg.eu> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Comment-Date: Sat, 13 Sep 2025 08:21:18 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: pespin <pespin(a)sysmocom.de>

1 0

[L] Change in osmo-ttcn3-hacks[master]: Add optonal e-RAB lists to HANDOVER messages
by fixeria 13 Sep '25

13 Sep '25

Attention is currently required from: jolly. fixeria has posted comments on this change by jolly. ( https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41093?usp=email ) Change subject: Add optonal e-RAB lists to HANDOVER messages ...................................................................... Patch Set 2: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/41093?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: I78d2fa8e72bb672674727a01d5c5a9aaf31cab7b Gerrit-Change-Number: 41093 Gerrit-PatchSet: 2 Gerrit-Owner: jolly <andreas(a)eversberg.eu> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de> Gerrit-Attention: jolly <andreas(a)eversberg.eu> Gerrit-Comment-Date: Sat, 13 Sep 2025 07:44:54 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

1 0

[L] Change in ...osmo-s1gw[master]: enb_registry: new module
by fixeria 12 Sep '25

12 Sep '25

fixeria has posted comments on this change by fixeria. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41034?usp=email ) Change subject: enb_registry: new module ...................................................................... Set Ready For Review -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41034?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: I77a5a750ca6342da3a99926a44926b3973ab19c4 Gerrit-Change-Number: 41034 Gerrit-PatchSet: 2 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Comment-Date: Fri, 12 Sep 2025 20:57:25 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: No

1 0

[L] Change in ...osmo-s1gw[master]: [REST] Implement Pfcp{AssocState,Heartbeat}
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41100?usp=email ) Change subject: [REST] Implement Pfcp{AssocState,Heartbeat} ...................................................................... [REST] Implement Pfcp{AssocState,Heartbeat} Change-Id: Idc98952d46d8e224969da343dc29ef323c6ed813 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M priv/openapi.json M src/rest_server.erl 4 files changed, 278 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/00/41100/1 diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index 696e7a2..df079a9 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -32,8 +32,61 @@ schema: $ref: '#/components/schemas/MetricsList' + /pfcp/assoc: + get: + summary: Get the PFCP association state + operationId: PfcpAssocState + responses: + '200': + description: PFCP association state + content: + application/json: + schema: + $ref: '#/components/schemas/PfcpAssocState' + post: + summary: Initiate the PFCP Association Setup procedure + operationId: PfcpAssocSetup + responses: + '200': + $ref: '#/components/responses/OperationResult' + delete: + summary: Initiate the PFCP Association Release procedure + operationId: PfcpAssocRelease + responses: + '200': + $ref: '#/components/responses/OperationResult' + + /pfcp/heartbeat: + post: + summary: Send a PFCP Heartbeat Request to the peer + operationId: PfcpHeartbeat + responses: + '200': + $ref: '#/components/responses/OperationResult' + components: + responses: + OperationResult: + description: Generic operation result response + content: + application/json: + schema: + $ref: '#/components/schemas/OperationResult' + schemas: + OperationResult: + type: object + required: + - success + properties: + success: + type: boolean + description: Indicates whether the operation was successful + message: + type: string + nullable: true + description: Human-readable explanation of the result + MetricsList: type: array items: @@ -53,3 +106,27 @@ type: string value: type: integer + + PfcpAssocState: + type: object + required: + - state + - laddr + - raddr + properties: + state: + type: string + enum: [connecting, connected] + description: Current association state + laddr: + type: string + description: Local (bind) IP address + raddr: + type: string + description: Remote (connect) IP address + lrts: + type: integer + description: Local Recovery TimeStamp + rrts: + type: integer + description: Remote Recovery TimeStamp diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 9888ee9..7b58b37 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -81,11 +81,32 @@ with self.send_get_req('metrics-list', query) as f: return json.load(f) + def pfcp_assoc_state(self) -> RESTResponse: + ''' PfcpAssocState :: Get the PFCP association state ''' + with self.send_get_req('pfcp/assoc') as f: + return json.load(f) + + def pfcp_assoc_setup(self) -> RESTResponse: + ''' PfcpAssocSetup :: Initiate the PFCP Association Setup procedure ''' + with self.send_post_req('pfcp/assoc') as f: + return json.load(f) + + def pfcp_assoc_release(self) -> RESTResponse: + ''' PfcpAssocRelease :: Initiate the PFCP Association Release procedure ''' + with self.send_delete_req('pfcp/assoc') as f: + return json.load(f) + + def pfcp_heartbeat(self) -> RESTResponse: + ''' PfcpHeartbeat :: Send a PFCP Heartbeat Request to the peer ''' + with self.send_post_req('pfcp/heartbeat') as f: + return json.load(f) + class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' CAT_METRICS = 'Metrics commands' + CAT_PFCP = 'PFCP related commands' def __init__(self, argv): super().__init__(allow_cli_args=False, include_py=True) @@ -134,6 +155,37 @@ self.poutput(tabulate.tabulate(map(self.metrics_list_item, data), headers='keys', tablefmt=self.tablefmt)) + @cmd2.with_category(CAT_PFCP) + def do_pfcp_assoc_state(self, opts) -> None: + ''' Get the PFCP association state ''' + data = self.iface.pfcp_assoc_state() + self.poutput('State: {state}\n' + 'Local address: {laddr}\n' + 'Remote address: {raddr}\n' + 'Local Recovery TimeStamp: {lrts}' + .format(**data)) + if 'rrts' in data: + self.poutput('Remote Recovery TimeStamp: {rrts}'.format(**data)) + + @cmd2.with_category(CAT_PFCP) + def do_pfcp_assoc_setup(self, opts) -> None: + ''' Initiate the PFCP Association Setup procedure ''' + raise NotImplementedError + + @cmd2.with_category(CAT_PFCP) + def do_pfcp_assoc_release(self, opts) -> None: + ''' Initiate the PFCP Association Release procedure ''' + raise NotImplementedError + + @cmd2.with_category(CAT_PFCP) + def do_pfcp_heartbeat(self, opts) -> None: + ''' Send a PFCP Heartbeat Request ''' + data = self.iface.pfcp_heartbeat() + if data['success']: + self.poutput('Heartbeat succeeded') + else: + self.perror('Heartbeat failed: {message}'.format(**data)) + ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) diff --git a/priv/openapi.json b/priv/openapi.json index 7323e9a..c55c312 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -49,10 +49,86 @@ } } } + }, + "/pfcp/assoc": { + "get": { + "summary": "Get the PFCP association state", + "operationId": "PfcpAssocState", + "responses": { + "200": { + "description": "PFCP association state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PfcpAssocState" + } + } + } + } + } + }, + "post": { + "summary": "Initiate the PFCP Association Setup procedure", + "operationId": "PfcpAssocSetup", + "responses": { + "200": { + "$ref": "#/components/responses/OperationResult" + } + } + }, + "delete": { + "summary": "Initiate the PFCP Association Release procedure", + "operationId": "PfcpAssocRelease", + "responses": { + "200": { + "$ref": "#/components/responses/OperationResult" + } + } + } + }, + "/pfcp/heartbeat": { + "post": { + "summary": "Send a PFCP Heartbeat Request to the peer", + "operationId": "PfcpHeartbeat", + "responses": { + "200": { + "$ref": "#/components/responses/OperationResult" + } + } + } } }, "components": { + "responses": { + "OperationResult": { + "description": "Generic operation result response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OperationResult" + } + } + } + } + }, "schemas": { + "OperationResult": { + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "description": "Indicates whether the operation was successful" + }, + "message": { + "type": "string", + "nullable": true, + "description": "Human-readable explanation of the result" + } + } + }, "MetricsList": { "type": "array", "items": { @@ -81,6 +157,40 @@ "type": "integer" } } + }, + "PfcpAssocState": { + "type": "object", + "required": [ + "state", + "laddr", + "raddr" + ], + "properties": { + "state": { + "type": "string", + "enum": [ + "connecting", + "connected" + ], + "description": "Current association state" + }, + "laddr": { + "type": "string", + "description": "Local (bind) IP address" + }, + "raddr": { + "type": "string", + "description": "Remote (connect) IP address" + }, + "lrts": { + "type": "integer", + "description": "Local Recovery TimeStamp" + }, + "rrts": { + "type": "integer", + "description": "Remote Recovery TimeStamp" + } + } } } } diff --git a/src/rest_server.erl b/src/rest_server.erl index ee0a7de..d1597a9 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -34,7 +34,9 @@ -module(rest_server). --export([metrics_list/1 +-export([metrics_list/1, + pfcp_assoc_state/1, + pfcp_heartbeat/1 ]). -include_lib("kernel/include/logger.hrl"). @@ -60,6 +62,28 @@ {200, [], L1}. +%% PfcpAssocState :: Get the PFCP association state +pfcp_assoc_state(#{}) -> + Info0 = pfcp_peer:fetch_info(), + Info1 = maps:update_with(laddr, fun inet:ntoa/1, Info0), + 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 + + +%% PfcpHeartbeat :: Send a PFCP Heartbeat Request to the peer +pfcp_heartbeat(#{}) -> + case pfcp_peer:heartbeat_req() of + ok -> + {200, [], rsp_map(#{success => true})}; + {error, Error} -> + {200, [], rsp_map(#{success => false, + message => Error})} + end. + + %% ------------------------------------------------------------------ %% private API %% ------------------------------------------------------------------ @@ -107,4 +131,18 @@ thing_to_list(X) when is_list(X) -> X. +%% Convert the given response map to a format acceptable by the erf +-spec rsp_map(map()) -> map(). +rsp_map(M) -> + Fun = fun(K, V) -> {bval(K), bval(V)} end, + maps:from_list([Fun(K, V) || {K, V} <- maps:to_list(M)]). + + +bval(V) when is_boolean(V) -> V; +bval(V) when is_atom(V) -> atom_to_binary(V); +bval(V) when is_list(V) -> list_to_binary(V); +bval(V) when is_map(V) -> rsp_map(V); +bval(V) -> V. + + %% vim:set ts=4 sw=4 et: -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41100?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: Idc98952d46d8e224969da343dc29ef323c6ed813 Gerrit-Change-Number: 41100 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[S] Change in ...osmo-s1gw[master]: enb_registry: fetch_enb_list/0: return sorted list
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41102?usp=email ) Change subject: enb_registry: fetch_enb_list/0: return sorted list ...................................................................... enb_registry: fetch_enb_list/0: return sorted list Change-Id: I51cc55982dda5f88e967b63433fb7e5be292aca1 --- M src/enb_registry.erl 1 file changed, 9 insertions(+), 4 deletions(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/02/41102/1 diff --git a/src/enb_registry.erl b/src/enb_registry.erl index f2be559..0217836 100644 --- a/src/enb_registry.erl +++ b/src/enb_registry.erl @@ -215,15 +215,15 @@ handle_call(fetch_enb_list, _From, #state{enbs = ENBs} = S) -> - Reply = maps:values(ENBs), - {reply, Reply, S}; + EnbList = lists:sort(fun enb_list_sort/2, maps:values(ENBs)), + {reply, EnbList, S}; handle_call({fetch_enb_list, Filter}, _From, #state{enbs = ENBs} = S) -> Filtered = maps:filter(enb_filter(Filter), ENBs), - Reply = maps:values(Filtered), - {reply, Reply, S}; + EnbList = lists:sort(fun enb_list_sort/2, maps:values(Filtered)), + {reply, EnbList, S}; handle_call(Info, From, S) -> ?LOG_ERROR("unknown ~p() from ~p: ~p", [?FUNCTION_NAME, From, Info]), @@ -315,6 +315,11 @@ EnbInfo. +-spec enb_list_sort(enb_info(), enb_info()) -> boolean(). +enb_list_sort(#{handle := H0}, + #{handle := H1}) -> H0 =< H1. + + -spec enb_filter(enb_filter()) -> fun((enb_handle(), enb_info()) -> boolean()). enb_filter({genb_id_str, GlobalENBId}) -> fun(_, Item) -> enb_filter_by_field({genb_id_str, GlobalENBId}, Item) end; -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41102?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: I51cc55982dda5f88e967b63433fb7e5be292aca1 Gerrit-Change-Number: 41102 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[L] Change in ...osmo-s1gw[master]: [REST] Implement EnbList and EnbInfo
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41101?usp=email ) Change subject: [REST] Implement EnbList and EnbInfo ...................................................................... [REST] Implement EnbList and EnbInfo Change-Id: Iba5a36678cf4bc245e9ae8cecc20ced76dfb7d75 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M priv/openapi.json M src/rest_server.erl 4 files changed, 470 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/01/41101/1 diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index df079a9..24bc2c8 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -64,6 +64,34 @@ '200': $ref: '#/components/responses/OperationResult' + /enb-list: + get: + summary: Get a list of eNB connections + operationId: EnbList + responses: + '200': + description: A list of eNB connections + content: + application/json: + schema: + $ref: '#/components/schemas/EnbList' + + /enb/{EnbId}: + get: + summary: Get information about a specific eNB + operationId: EnbInfo + parameters: + - $ref: '#/components/parameters/EnbId' + responses: + '200': + description: Successful outcome (eNB info) + content: + application/json: + schema: + $ref: '#/components/schemas/EnbItem' + '404': + description: Unsuccessful outcome (eNB not found) + components: responses: OperationResult: @@ -73,6 +101,35 @@ schema: $ref: '#/components/schemas/OperationResult' + parameters: + EnbId: + name: EnbId + in: path + description: eNB identifier (selector) + required: true + schema: + oneOf: + - type: string + pattern: '^handle:[0-9]+$' + description: Unique identifier in the eNB registry + example: handle:42 + - type: string + pattern: '^pid:[0-9]+\.[0-9]+\.[0-9]+$' + description: Process ID + example: pid:0.33.1 + - type: string + pattern: '^genbid:[0-9]{3}-[0-9]{2,3}-[0-9]+$' + description: Global-eNB-ID (MCC-MNC-eNBId) + example: genbid:999-70-1337 + - type: string + pattern: '^(enb|mme)-sctp-aid:[0-9]+$' + description: eNB/MME SCTP association identifier + example: enb-aid:42 + - type: string + pattern: '^enb-conn:[0-9:.]+-[0-9]+$' + description: eNB connection address/port + example: enb-conn:192.168.1.1-34650 + schemas: OperationResult: type: object @@ -87,6 +144,11 @@ nullable: true description: Human-readable explanation of the result + Pid: + type: string + pattern: '^<[0-9]+\.[0-9]+\.[0-9]+>$' + description: Process ID + MetricsList: type: array items: @@ -130,3 +192,59 @@ rrts: type: integer description: Remote Recovery TimeStamp + + EnbList: + type: array + items: + $ref: '#/components/schemas/EnbItem' + + EnbItem: + type: object + required: + - handle + - pid + - state + - uptime + - erab_count + properties: + handle: + type: integer + description: Unique number in the eNB registry + pid: + $ref: '#/components/schemas/Pid' + state: + type: string + enum: [connecting, connected, s1setup] + description: Connection state + uptime: + type: integer + description: Uptime (in seconds) + erab_count: + type: integer + description: Total number of E-RABs + genb_id: + type: string + pattern: '^[0-9]{3}-[0-9]{2,3}-[0-9]+$' + example: 001-01-1337 + description: Global-eNB-ID + enb_saddr: + type: string + description: Source (remote) address of the eNB + mme_daddr: + type: string + description: Destination (remote) address of the MME + enb_sport: + type: integer + description: Source (remote) port of the eNB-S1GW connection + mme_sport: + type: integer + description: Source (local) port of the S1GW-MME connection + mme_dport: + type: integer + description: Destination (remote) port of the S1GW-MME connection + enb_sctp_aid: + type: integer + description: SCTP association identifier of the eNB-S1GW connection + mme_sctp_aid: + type: integer + description: SCTP association identifier of the S1GW-MME connection diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 7b58b37..84036d7 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -101,12 +101,23 @@ with self.send_post_req('pfcp/heartbeat') as f: return json.load(f) + def enb_list(self) -> RESTResponse: + ''' EnbList :: Get a list of eNB connections ''' + with self.send_get_req('enb-list') as f: + return json.load(f) + + def enb_info(self, enb_id: str) -> RESTResponse: + ''' EnbInfo :: Get information about a specific eNB ''' + with self.send_get_req(f'enb/{enb_id}') as f: + return json.load(f) + class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' CAT_METRICS = 'Metrics commands' CAT_PFCP = 'PFCP related commands' + CAT_ENB = 'eNB related commands' def __init__(self, argv): super().__init__(allow_cli_args=False, include_py=True) @@ -186,6 +197,72 @@ else: self.perror('Heartbeat failed: {message}'.format(**data)) + @staticmethod + def enb_list_item(item: dict) -> dict: + enb_addr = lambda item: '{enb_saddr}:{enb_sport} ({enb_sctp_aid})'.format(**item) + mme_addr = lambda item: '{mme_daddr}:{mme_dport} ({mme_sctp_aid})'.format(**item) + return { + 'eNB handle': item.get('handle'), + 'PID': item.get('pid'), + 'Global-eNB-ID': item.get('genb_id', '(unknown)'), + '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, + 'Uptime (s)': item.get('uptime'), + '# E-RABs': item.get('erab_count'), + } + + def enb_list_print(self, items: list[dict]) -> None: + self.poutput(tabulate.tabulate(map(self.enb_list_item, items), + headers='keys', tablefmt='github')) + + @cmd2.with_category(CAT_ENB) + def do_enb_list(self, opts) -> None: + ''' Get a list of eNB connections ''' + data = self.iface.enb_list() + self.enb_list_print(data) + + @staticmethod + def gen_enb_id(opts) -> str: + if opts.handle is not None: + return f'handle:{opts.handle}' + elif opts.pid is not None: + return f'pid:{opts.pid}' + elif opts.genbid is not None: + return f'genbid:{opts.genbid}' + elif opts.enb_sctp_aid is not None: + 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}' + raise ValueError # shall not happen + + enb_id_parser = cmd2.Cmd2ArgumentParser() + enb_id_group = enb_id_parser.add_argument_group('eNB ID') + enb_id_group = enb_id_group.add_mutually_exclusive_group(required=True) + enb_id_group.add_argument('-H', '--handle', + type=int, + help='eNB handle (example: 0)') + enb_id_group.add_argument('-P', '--pid', + type=str, + help='eNB process ID (example: 0.33.1)') + enb_id_group.add_argument('-G', '--genbid', + type=str, + help='Global-eNB-ID (example: 262-42-1337)') + enb_id_group.add_argument('--enb-sctp-aid', + type=int, metavar='AID', + help='eNB association identifier (example: 42)') + enb_id_group.add_argument('--mme-sctp-aid', + type=int, metavar='AID', + help='MME association identifier (example: 42)') + + @cmd2.with_argparser(enb_id_parser) + @cmd2.with_category(CAT_ENB) + def do_enb_info(self, opts) -> None: + ''' Get information about a specific eNB ''' + enb_id = self.gen_enb_id(opts) + data = self.iface.enb_info(enb_id) + self.enb_list_print([data]) + ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) diff --git a/priv/openapi.json b/priv/openapi.json index c55c312..3e8f22e 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -96,6 +96,50 @@ } } } + }, + "/enb-list": { + "get": { + "summary": "Get a list of eNB connections", + "operationId": "EnbList", + "responses": { + "200": { + "description": "A list of eNB connections", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnbList" + } + } + } + } + } + } + }, + "/enb/{EnbId}": { + "get": { + "summary": "Get information about a specific eNB", + "operationId": "EnbInfo", + "parameters": [ + { + "$ref": "#/components/parameters/EnbId" + } + ], + "responses": { + "200": { + "description": "Successful outcome (eNB info)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnbItem" + } + } + } + }, + "404": { + "description": "Unsuccessful outcome (eNB not found)" + } + } + } } }, "components": { @@ -111,6 +155,48 @@ } } }, + "parameters": { + "EnbId": { + "name": "EnbId", + "in": "path", + "description": "eNB identifier (selector)", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "pattern": "^handle:[0-9]+$", + "description": "Unique identifier in the eNB registry", + "example": "handle:42" + }, + { + "type": "string", + "pattern": "^pid:[0-9]+\\.[0-9]+\\.[0-9]+$", + "description": "Process ID", + "example": "pid:0.33.1" + }, + { + "type": "string", + "pattern": "^genbid:[0-9]{3}-[0-9]{2,3}-[0-9]+$", + "description": "Global-eNB-ID (MCC-MNC-eNBId)", + "example": "genbid:999-70-1337" + }, + { + "type": "string", + "pattern": "^(enb|mme)-sctp-aid:[0-9]+$", + "description": "eNB/MME SCTP association identifier", + "example": "enb-aid:42" + }, + { + "type": "string", + "pattern": "^enb-conn:[0-9:.]+-[0-9]+$", + "description": "eNB connection address/port", + "example": "enb-conn:192.168.1.1-34650" + } + ] + } + } + }, "schemas": { "OperationResult": { "type": "object", @@ -129,6 +215,11 @@ } } }, + "Pid": { + "type": "string", + "pattern": "^<[0-9]+\\.[0-9]+\\.[0-9]+>$", + "description": "Process ID" + }, "MetricsList": { "type": "array", "items": { @@ -191,6 +282,82 @@ "description": "Remote Recovery TimeStamp" } } + }, + "EnbList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EnbItem" + } + }, + "EnbItem": { + "type": "object", + "required": [ + "handle", + "pid", + "state", + "uptime", + "erab_count" + ], + "properties": { + "handle": { + "type": "integer", + "description": "Unique number in the eNB registry" + }, + "pid": { + "$ref": "#/components/schemas/Pid" + }, + "state": { + "type": "string", + "enum": [ + "connecting", + "connected", + "s1setup" + ], + "description": "Connection state" + }, + "uptime": { + "type": "integer", + "description": "Uptime (in seconds)" + }, + "erab_count": { + "type": "integer", + "description": "Total number of E-RABs" + }, + "genb_id": { + "type": "string", + "pattern": "^[0-9]{3}-[0-9]{2,3}-[0-9]+$", + "example": "001-01-1337", + "description": "Global-eNB-ID" + }, + "enb_saddr": { + "type": "string", + "description": "Source (remote) address of the eNB" + }, + "mme_daddr": { + "type": "string", + "description": "Destination (remote) address of the MME" + }, + "enb_sport": { + "type": "integer", + "description": "Source (remote) port of the eNB-S1GW connection" + }, + "mme_sport": { + "type": "integer", + "description": "Source (local) port of the S1GW-MME connection" + }, + "mme_dport": { + "type": "integer", + "description": "Destination (remote) port of the S1GW-MME connection" + }, + "enb_sctp_aid": { + "type": "integer", + "description": "SCTP association identifier of the eNB-S1GW connection" + }, + "mme_sctp_aid": { + "type": "integer", + "description": "SCTP association identifier of the S1GW-MME connection" + } + } } } } diff --git a/src/rest_server.erl b/src/rest_server.erl index d1597a9..f546ad9 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -36,7 +36,9 @@ -export([metrics_list/1, pfcp_assoc_state/1, - pfcp_heartbeat/1 + pfcp_heartbeat/1, + enb_list/1, + enb_info/1 ]). -include_lib("kernel/include/logger.hrl"). @@ -84,6 +86,25 @@ end. +%% EnbList :: Get a list of eNB connections +enb_list(#{}) -> + EnbList = enb_registry:fetch_enb_list(), + {200, [], lists:map(fun enb_item/1, EnbList)}. + + +%% EnbInfo :: Get information about a specific eNB +enb_info(#{path_parameters := PP}) -> + [{<< "EnbId" >>, << ID/bytes >>}] = PP, + case fetch_enb_info(ID) of + [EnbInfo | _] -> + {200, [], enb_item(EnbInfo)}; + [] -> + {404, [], undefined}; + error -> + {500, [], undefined} + end. + + %% ------------------------------------------------------------------ %% private API %% ------------------------------------------------------------------ @@ -131,6 +152,92 @@ thing_to_list(X) when is_list(X) -> X. +-spec enb_item(enb_registry:enb_info()) -> map(). +enb_item(EnbInfo) -> + M0 = #{handle => maps:get(handle, EnbInfo), + pid => pid_to_list(maps:get(pid, EnbInfo)), + state => maps:get(state, EnbInfo), + uptime => maps:get(uptime, EnbInfo), + erab_count => 0}, + M1 = enb_item_add_enb_info(M0, EnbInfo), + M2 = enb_item_add_enb_conn_info(M1, EnbInfo), + M3 = enb_item_add_mme_conn_info(M2, EnbInfo), + rsp_map(M3). + + +-spec enb_item_add_enb_info(map(), enb_registry:enb_info()) -> map(). +enb_item_add_enb_info(M0, #{genb_id_str := GlobalENBId}) -> + %% TODO: add enb_id and plmn_id + M0#{genb_id => GlobalENBId}; + +enb_item_add_enb_info(M0, _) -> M0. + + +-spec enb_item_add_enb_conn_info(map(), enb_registry:enb_info()) -> map(). +enb_item_add_enb_conn_info(M0, #{enb_conn_info := ConnInfo}) -> + M0#{enb_saddr => inet:ntoa(maps:get(addr, ConnInfo)), + enb_sport => maps:get(port, ConnInfo), + enb_sctp_aid => maps:get(aid, ConnInfo) + }; + +enb_item_add_enb_conn_info(M0, _) -> M0. + + +-spec enb_item_add_mme_conn_info(map(), enb_registry:enb_info()) -> map(). +enb_item_add_mme_conn_info(M0, #{mme_conn_info := ConnInfo}) -> + Pid = maps:get(handler, ConnInfo), + ERABs = s1ap_proxy:fetch_erab_list(Pid), + M0#{mme_daddr => maps:get(mme_addr, ConnInfo), %% XXX inet:ntoa + mme_dport => maps:get(mme_port, ConnInfo), + %% TODO: mme_sport + mme_sctp_aid => maps:get(mme_aid, ConnInfo), + erab_count => length(ERABs) + }; + +enb_item_add_mme_conn_info(M0, _) -> M0. + + +-spec fetch_enb_info(binary()) -> [enb_registry:enb_info()] | error. +fetch_enb_info(<< "handle:", Val/bytes >>) -> + Handle = binary_to_integer(Val), + case enb_registry:fetch_enb_info(Handle) of + {ok, EnbInfo} -> [EnbInfo]; + error -> [] + end; + +fetch_enb_info(<< "pid:", Val/bytes >>) -> + Pid = parse_pid(Val), + case enb_registry:fetch_enb_info(Pid) of + {ok, EnbInfo} -> [EnbInfo]; + error -> [] + end; + +fetch_enb_info(<< "genbid:", Val/bytes >>) -> + GlobalENBId = binary_to_list(Val), + enb_registry:fetch_enb_list({genb_id_str, GlobalENBId}); + +fetch_enb_info(<< "enb-sctp-aid:", Val/bytes >>) -> + Aid = binary_to_integer(Val), + enb_registry:fetch_enb_list({enb_sctp_aid, Aid}); + +fetch_enb_info(<< "mme-sctp-aid:", Val/bytes >>) -> + Aid = binary_to_integer(Val), + enb_registry:fetch_enb_list({mme_sctp_aid, Aid}); + +%% TODO: '^enb-conn:[0-9:.]+-[0-9]+$' +fetch_enb_info(ID) -> + ?LOG_ERROR("Unhandled eNB ID ~p", [ID]), + error. + + +-spec parse_pid(binary() | list()) -> pid(). +parse_pid(Data) when is_binary(Data) -> + parse_pid(binary_to_list(Data)); + +parse_pid(Data) when is_list(Data) -> + list_to_pid("<" ++ Data ++ ">"). + + %% Convert the given response map to a format acceptable by the erf -spec rsp_map(map()) -> map(). rsp_map(M) -> -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41101?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: Iba5a36678cf4bc245e9ae8cecc20ced76dfb7d75 Gerrit-Change-Number: 41101 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[L] Change in ...osmo-s1gw[master]: [REST] Implement EnbErabList
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41103?usp=email ) Change subject: [REST] Implement EnbErabList ...................................................................... [REST] Implement EnbErabList Change-Id: I846974dd79e737acaac17918d18da55967a9abf2 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M priv/openapi.json M src/rest_server.erl 4 files changed, 275 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/03/41103/1 diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index 24bc2c8..0041274 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -92,6 +92,22 @@ '404': description: Unsuccessful outcome (eNB not found) + /enb/{EnbId}/erab-list: + get: + summary: Get E-RAB list for a specific eNB + operationId: EnbErabList + parameters: + - $ref: '#/components/parameters/EnbId' + responses: + '200': + description: Successful outcome (E-RAB list) + content: + application/json: + schema: + $ref: '#/components/schemas/ErabList' + '404': + description: Unsuccessful outcome (eNB not found) + components: responses: OperationResult: @@ -248,3 +264,62 @@ mme_sctp_aid: type: integer description: SCTP association identifier of the S1GW-MME connection + + ErabList: + type: array + items: + $ref: '#/components/schemas/ErabItem' + + FTEID: + type: object + required: + - teid + - tla + properties: + teid: + type: integer + description: GTP-U TEID + tla: + type: string + description: GTP-U TLA (Transport Layer Address) + + ErabItem: + type: object + required: + - mme_ue_id + - erab_id + - state + - pid + properties: + mme_ue_id: + type: integer + description: MME-UE-S1AP-ID + erab_id: + type: integer + description: E-RAB-ID + state: + type: string + description: E-RAB FSM state + example: erab_wait_release_rsp + pid: + type: string + pattern: '^<[0-9]+\.[0-9]+\.[0-9]+>$' + description: E-RAB FSM process ID + pfcp_lseid: + type: integer + description: PFCP SEID (local) + pfcp_rseid: + type: integer + description: PFCP SEID (remote) + f_teid_u2c: + $ref: '#/components/schemas/FTEID' + description: GTP-U F-TEID for UPF -> Core + f_teid_c2u: + $ref: '#/components/schemas/FTEID' + description: GTP-U F-TEID for UPF <- Core + f_teid_a2u: + $ref: '#/components/schemas/FTEID' + description: GTP-U F-TEID for UPF <- Access + f_teid_u2a: + $ref: '#/components/schemas/FTEID' + description: GTP-U F-TEID for UPF -> Access diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 84036d7..cb77709 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -111,6 +111,11 @@ with self.send_get_req(f'enb/{enb_id}') as f: return json.load(f) + def enb_erab_list(self, enb_id: str) -> RESTResponse: + ''' EnbErabList :: Get E-RAB list for a specific eNB ''' + with self.send_get_req(f'enb/{enb_id}/erab-list') as f: + return json.load(f) + class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' @@ -263,6 +268,35 @@ data = self.iface.enb_info(enb_id) self.enb_list_print([data]) + @staticmethod + def erab_list_item(item: dict) -> dict: + f_teid = lambda params: '0x{teid:08x}@{tla}'.format(**params) + seid = lambda val: f'0x{val:016x}' + return { + 'PID': item.get('pid'), + 'MME-UE-S1AP-ID': item.get('mme_ue_id'), + 'E-RAB-ID': item.get('erab_id'), + 'State': item.get('state'), + 'SEID (local)': seid(item.get('pfcp_lseid')) if 'pfcp_lseid' in item else None, + 'SEID (remote)': seid(item.get('pfcp_rseid')) if 'pfcp_rseid' in item else None, + 'U2C F-TEID': f_teid(item.get('f_teid_u2c')) if 'f_teid_u2c' in item else None, + 'C2U F-TEID': f_teid(item.get('f_teid_c2u')) if 'f_teid_c2u' in item else None, + 'A2U F-TEID': f_teid(item.get('f_teid_a2u')) if 'f_teid_a2u' in item else None, + 'U2A F-TEID': f_teid(item.get('f_teid_u2a')) if 'f_teid_u2a' in item else None, + } + + def erab_list_print(self, items: list[dict]) -> None: + self.poutput(tabulate.tabulate(map(self.erab_list_item, items), + headers='keys', tablefmt='github')) + + @cmd2.with_argparser(enb_id_parser) + @cmd2.with_category(CAT_ENB) + def do_enb_erab_list(self, opts) -> None: + ''' Get E-RAB list for a specific eNB ''' + enb_id = self.gen_enb_id(opts) + data = self.iface.enb_erab_list(enb_id) + self.erab_list_print(data) + ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) diff --git a/priv/openapi.json b/priv/openapi.json index 3e8f22e..07a11b8 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -140,6 +140,32 @@ } } } + }, + "/enb/{EnbId}/erab-list": { + "get": { + "summary": "Get E-RAB list for a specific eNB", + "operationId": "EnbErabList", + "parameters": [ + { + "$ref": "#/components/parameters/EnbId" + } + ], + "responses": { + "200": { + "description": "Successful outcome (E-RAB list)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErabList" + } + } + } + }, + "404": { + "description": "Unsuccessful outcome (eNB not found)" + } + } + } } }, "components": { @@ -358,6 +384,82 @@ "description": "SCTP association identifier of the S1GW-MME connection" } } + }, + "ErabList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ErabItem" + } + }, + "FTEID": { + "type": "object", + "required": [ + "teid", + "tla" + ], + "properties": { + "teid": { + "type": "integer", + "description": "GTP-U TEID" + }, + "tla": { + "type": "string", + "description": "GTP-U TLA (Transport Layer Address)" + } + } + }, + "ErabItem": { + "type": "object", + "required": [ + "mme_ue_id", + "erab_id", + "state", + "pid" + ], + "properties": { + "mme_ue_id": { + "type": "integer", + "description": "MME-UE-S1AP-ID" + }, + "erab_id": { + "type": "integer", + "description": "E-RAB-ID" + }, + "state": { + "type": "string", + "description": "E-RAB FSM state", + "example": "erab_wait_release_rsp" + }, + "pid": { + "type": "string", + "pattern": "^<[0-9]+\\.[0-9]+\\.[0-9]+>$", + "description": "E-RAB FSM process ID" + }, + "pfcp_lseid": { + "type": "integer", + "description": "PFCP SEID (local)" + }, + "pfcp_rseid": { + "type": "integer", + "description": "PFCP SEID (remote)" + }, + "f_teid_u2c": { + "$ref": "#/components/schemas/FTEID", + "description": "GTP-U F-TEID for UPF -> Core" + }, + "f_teid_c2u": { + "$ref": "#/components/schemas/FTEID", + "description": "GTP-U F-TEID for UPF <- Core" + }, + "f_teid_a2u": { + "$ref": "#/components/schemas/FTEID", + "description": "GTP-U F-TEID for UPF <- Access" + }, + "f_teid_u2a": { + "$ref": "#/components/schemas/FTEID", + "description": "GTP-U F-TEID for UPF -> Access" + } + } } } } diff --git a/src/rest_server.erl b/src/rest_server.erl index f546ad9..2f805da 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -38,7 +38,8 @@ pfcp_assoc_state/1, pfcp_heartbeat/1, enb_list/1, - enb_info/1 + enb_info/1, + enb_erab_list/1 ]). -include_lib("kernel/include/logger.hrl"). @@ -105,6 +106,20 @@ end. +%% EnbErabList :: Get E-RAB list for a specific eNB +enb_erab_list(#{path_parameters := PP}) -> + [{<< "EnbId" >>, << ID/bytes >>}] = PP, + case fetch_enb_info(ID) of + [EnbInfo | _] -> + Rsp = fetch_erab_list(EnbInfo), + {200, [], Rsp}; + [] -> + {404, [], undefined}; + error -> + {500, [], undefined} + end. + + %% ------------------------------------------------------------------ %% private API %% ------------------------------------------------------------------ @@ -230,6 +245,54 @@ error. +-spec fetch_erab_list(enb_registry:enb_info()) -> [map()]. +fetch_erab_list(#{mme_conn_info := ConnInfo}) -> + Pid = maps:get(handler, ConnInfo), %% s1ap_proxy process pid + ERABs = s1ap_proxy:fetch_erab_list(Pid), + lists:map(fun erab_list_item/1, ERABs); + +fetch_erab_list(_) -> []. + + +-spec erab_list_item({term(), pid()}) -> map(). +erab_list_item({_, Pid}) -> + %% XXX: E-RAB FSM process might be dead here + Info = erab_fsm:fetch_info(Pid), + {MmeUeId, ErabId} = maps:get(uid, Info), + M0 = #{mme_ue_id => MmeUeId, + erab_id => ErabId, + state => maps:get(state, Info), + pid => pid_to_list(Pid)}, + M1 = erab_list_item_add_seid(Info, M0), + M2 = erab_list_item_add_f_teid(f_teid_u2c, Info, M1), + M3 = erab_list_item_add_f_teid(f_teid_c2u, Info, M2), + M4 = erab_list_item_add_f_teid(f_teid_a2u, Info, M3), + M5 = erab_list_item_add_f_teid(f_teid_u2a, Info, M4), + rsp_map(M5). + + +-spec erab_list_item_add_seid(erab_fsm:erab_info(), map()) -> map(). +erab_list_item_add_seid(Info, M0) -> + %% local SEID is always known/present + M1 = M0#{pfcp_lseid => maps:get(seid_loc, Info)}, + %% remote SEID may or may not be known/present + case maps:find(seid_rem, Info) of + {ok, SEID} -> M1#{pfcp_rseid => SEID}; + error -> M1 + end. + + +-spec erab_list_item_add_f_teid(atom(), erab_fsm:erab_info(), map()) -> map(). +erab_list_item_add_f_teid(Key, Info, M0) -> + case maps:find(Key, Info) of + {ok, {TEID, AddrBin}} -> + Addr = list_to_tuple(binary_to_list(AddrBin)), + M0#{Key => #{teid => TEID, + tla => inet:ntoa(Addr)}}; + error -> M0 + end. + + -spec parse_pid(binary() | list()) -> pid(). parse_pid(Data) when is_binary(Data) -> parse_pid(binary_to_list(Data)); -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41103?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: I846974dd79e737acaac17918d18da55967a9abf2 Gerrit-Change-Number: 41103 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[M] Change in ...osmo-s1gw[master]: [REST] Implement ErabList and ErabInfo
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41104?usp=email ) Change subject: [REST] Implement ErabList and ErabInfo ...................................................................... [REST] Implement ErabList and ErabInfo Change-Id: Ia98498143fd0e38030429171e42a0c4c4887df64 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M priv/openapi.json M src/rest_server.erl 4 files changed, 166 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/04/41104/1 diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index 0041274..adf3e58 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -108,6 +108,34 @@ '404': description: Unsuccessful outcome (eNB not found) + /erab-list: + get: + summary: Get E-RAB list for all eNBs + operationId: ErabList + responses: + '200': + description: A list of E-RABs + content: + application/json: + schema: + $ref: '#/components/schemas/ErabList' + + /erab/{ErabId}: + get: + summary: Get information about a specific E-RAB + operationId: ErabInfo + parameters: + - $ref: '#/components/parameters/ErabId' + responses: + '200': + description: Successful outcome (E-RAB info) + content: + application/json: + schema: + $ref: '#/components/schemas/ErabItem' + '404': + description: Unsuccessful outcome (E-RAB not found) + components: responses: OperationResult: @@ -146,6 +174,18 @@ description: eNB connection address/port example: enb-conn:192.168.1.1-34650 + ErabId: + name: ErabId + in: path + description: E-RAB identifier (selector) + required: true + schema: + oneOf: + - type: string + pattern: '^pid:[0-9]+\.[0-9]+\.[0-9]+$' + description: Process ID + example: pid:0.33.1 + schemas: OperationResult: type: object diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index cb77709..8a65295 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -116,6 +116,16 @@ with self.send_get_req(f'enb/{enb_id}/erab-list') as f: return json.load(f) + def erab_list(self) -> RESTResponse: + ''' ErabList :: Get E-RAB list for all eNBs ''' + with self.send_get_req('erab-list') as f: + return json.load(f) + + def erab_info(self, pid: str) -> RESTResponse: + ''' ErabInfo :: Get information about a specific E-RAB ''' + with self.send_get_req(f'erab/pid:{pid}') as f: + return json.load(f) + class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' @@ -123,6 +133,7 @@ CAT_METRICS = 'Metrics commands' CAT_PFCP = 'PFCP related commands' CAT_ENB = 'eNB related commands' + CAT_ERAB = 'E-RAB related commands' def __init__(self, argv): super().__init__(allow_cli_args=False, include_py=True) @@ -297,6 +308,24 @@ data = self.iface.enb_erab_list(enb_id) self.erab_list_print(data) + @cmd2.with_category(CAT_ERAB) + def do_erab_list(self, opts) -> None: + ''' Get E-RAB list for all eNBs ''' + data = self.iface.erab_list() + self.erab_list_print(data) + + erab_info_parser = cmd2.Cmd2ArgumentParser() + erab_info_parser.add_argument('-P', '--pid', + type=str, required=True, + help='E-RAB process ID (example: 0.33.1)') + + @cmd2.with_argparser(erab_info_parser) + @cmd2.with_category(CAT_ERAB) + def do_erab_info(self, opts) -> None: + ''' Get information about a specific E-RAB ''' + data = self.iface.erab_info(opts.pid) + self.erab_list_print([data]) + ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) diff --git a/priv/openapi.json b/priv/openapi.json index 07a11b8..bfe82a3 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -166,6 +166,50 @@ } } } + }, + "/erab-list": { + "get": { + "summary": "Get E-RAB list for all eNBs", + "operationId": "ErabList", + "responses": { + "200": { + "description": "A list of E-RABs", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErabList" + } + } + } + } + } + } + }, + "/erab/{ErabId}": { + "get": { + "summary": "Get information about a specific E-RAB", + "operationId": "ErabInfo", + "parameters": [ + { + "$ref": "#/components/parameters/ErabId" + } + ], + "responses": { + "200": { + "description": "Successful outcome (E-RAB info)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErabItem" + } + } + } + }, + "404": { + "description": "Unsuccessful outcome (E-RAB not found)" + } + } + } } }, "components": { @@ -221,6 +265,22 @@ } ] } + }, + "ErabId": { + "name": "ErabId", + "in": "path", + "description": "E-RAB identifier (selector)", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "pattern": "^pid:[0-9]+\\.[0-9]+\\.[0-9]+$", + "description": "Process ID", + "example": "pid:0.33.1" + } + ] + } } }, "schemas": { diff --git a/src/rest_server.erl b/src/rest_server.erl index 2f805da..e1333c0 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -39,7 +39,9 @@ pfcp_heartbeat/1, enb_list/1, enb_info/1, - enb_erab_list/1 + enb_erab_list/1, + erab_list/1, + erab_info/1 ]). -include_lib("kernel/include/logger.hrl"). @@ -120,6 +122,24 @@ end. +%% ErabList :: Get E-RAB list for all eNBs +erab_list(#{}) -> + EnbList = enb_registry:fetch_enb_list(), + ErabList = lists:map(fun fetch_erab_list/1, EnbList), + {200, [], lists:flatten(ErabList)}. + + +%% ErabInfo :: Get information about a specific E-RAB +erab_info(#{path_parameters := PP}) -> + [{<< "ErabId" >>, << ID/bytes >>}] = PP, + case fetch_erab_info(ID) of + {ok, ErabInfo} -> + {200, [], ErabInfo}; + error -> + {404, [], undefined} + end. + + %% ------------------------------------------------------------------ %% private API %% ------------------------------------------------------------------ @@ -245,6 +265,22 @@ error. +-spec fetch_erab_info(binary()) -> {ok, erab_fsm:erab_info()} | error. +fetch_erab_info(<< "pid:", Val/bytes >>) -> + Pid = parse_pid(Val), + %% guard against non-existent process IDs + %% TODO: check if the given Pid is actually an erab_fsm + try erab_list_item({pid, Pid}) of + ErabInfo -> {ok, ErabInfo} + catch + exit:{noproc, _} -> error + end; + +fetch_erab_info(ID) -> + ?LOG_ERROR("Unhandled E-RAB ID ~p", [ID]), + error. + + -spec fetch_erab_list(enb_registry:enb_info()) -> [map()]. fetch_erab_list(#{mme_conn_info := ConnInfo}) -> Pid = maps:get(handler, ConnInfo), %% s1ap_proxy process pid -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41104?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: Ia98498143fd0e38030429171e42a0c4c4887df64 Gerrit-Change-Number: 41104 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[M] Change in ...osmo-s1gw[master]: [REST] Implement ErabDelete
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41105?usp=email ) Change subject: [REST] Implement ErabDelete ...................................................................... [REST] Implement ErabDelete Change-Id: I3576814f44d87551fdac6236ddbec6215ba07455 Related: SYS#7066 --- M contrib/openapi.yaml M contrib/osmo-s1gw-cli.py M priv/openapi.json M src/rest_server.erl 4 files changed, 57 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/05/41105/1 diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index adf3e58..75174d2 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -135,6 +135,16 @@ $ref: '#/components/schemas/ErabItem' '404': description: Unsuccessful outcome (E-RAB not found) + delete: + summary: Terminate an E-RAB FSM process + operationId: ErabDelete + parameters: + - $ref: '#/components/parameters/ErabId' + responses: + '200': + description: Successful outcome (E-RAB FSM terminated) + '404': + description: Unsuccessful outcome (E-RAB not found) components: responses: diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 8a65295..c008dad 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -126,6 +126,11 @@ with self.send_get_req(f'erab/pid:{pid}') as f: return json.load(f) + def erab_delete(self, pid: str) -> int: + ''' ErabDelete :: Terminate an E-RAB FSM process ''' + with self.send_delete_req(f'erab/pid:{pid}') as f: + return f.status + class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' @@ -326,6 +331,12 @@ data = self.iface.erab_info(opts.pid) self.erab_list_print([data]) + @cmd2.with_argparser(erab_info_parser) + @cmd2.with_category(CAT_ERAB) + def do_erab_delete(self, opts) -> None: + ''' Terminate an E-RAB FSM process ''' + self.iface.erab_delete(opts.pid) + ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) diff --git a/priv/openapi.json b/priv/openapi.json index bfe82a3..3b77c8a 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -209,6 +209,23 @@ "description": "Unsuccessful outcome (E-RAB not found)" } } + }, + "delete": { + "summary": "Terminate an E-RAB FSM process", + "operationId": "ErabDelete", + "parameters": [ + { + "$ref": "#/components/parameters/ErabId" + } + ], + "responses": { + "200": { + "description": "Successful outcome (E-RAB FSM terminated)" + }, + "404": { + "description": "Unsuccessful outcome (E-RAB not found)" + } + } } } }, diff --git a/src/rest_server.erl b/src/rest_server.erl index e1333c0..6de53a0 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -41,7 +41,8 @@ enb_info/1, enb_erab_list/1, erab_list/1, - erab_info/1 + erab_info/1, + erab_delete/1 ]). -include_lib("kernel/include/logger.hrl"). @@ -140,6 +141,23 @@ end. +%% ErabDelete :: Terminate an E-RAB FSM process +erab_delete(#{path_parameters := PP}) -> + [{<< "ErabId" >>, << ID/bytes >>}] = PP, + case ID of + << "pid:", Val/bytes >> -> + Pid = parse_pid(Val), + try erab_fsm:shutdown(Pid) of + ok -> {200, [], undefined} + catch + exit:{noproc, _} -> {404, [], undefined} + end; + _ -> + ?LOG_ERROR("Unhandled E-RAB ID ~p", [ID]), + {400, [], undefined} + end. + + %% ------------------------------------------------------------------ %% private API %% ------------------------------------------------------------------ -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41105?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: I3576814f44d87551fdac6236ddbec6215ba07455 Gerrit-Change-Number: 41105 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[S] Change in ...osmo-s1gw[master]: [REST] OpenAPI specification skeleton
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41096?usp=email ) Change subject: [REST] OpenAPI specification skeleton ...................................................................... [REST] OpenAPI specification skeleton Change-Id: I84e6ef5cc67cd26b11f7bed8510420e43e18c69b Related: SYS#7066 --- M Makefile A contrib/openapi.yaml A contrib/yaml2json.py M debian/control A priv/openapi.json 5 files changed, 33 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/96/41096/1 diff --git a/Makefile b/Makefile index 6b9267d..ddc3dd5 100644 --- a/Makefile +++ b/Makefile @@ -12,11 +12,14 @@ all: build -GEN_FILES = include/S1AP-*.hrl src/S1AP-*.erl +GEN_FILES = include/S1AP-*.hrl src/S1AP-*.erl priv/openapi.json src/S1AP-%.erl include/S1AP-%.hrl: asn1/S1AP-%.asn rebar3 asn compile +priv/openapi.json: contrib/openapi.yaml + contrib/yaml2json.py $^ > $@ + build: $(GEN_FILES) rebar3 compile diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml new file mode 100644 index 0000000..c7f7ec8 --- /dev/null +++ b/contrib/openapi.yaml @@ -0,0 +1,8 @@ +openapi: 3.0.0 +info: + version: '0.1.0' + title: 'OsmoS1GW REST interface' + +paths: + +components: diff --git a/contrib/yaml2json.py b/contrib/yaml2json.py new file mode 100755 index 0000000..b374f9b --- /dev/null +++ b/contrib/yaml2json.py @@ -0,0 +1,10 @@ +#!/usr/bin/env python3 + +import sys +import yaml +import json + +with open(sys.argv[1], 'r') as f: + data = yaml.safe_load(f) + +json.dump(data, sys.stdout, indent=4) diff --git a/debian/control b/debian/control index b0bb9b4..f7e9258 100644 --- a/debian/control +++ b/debian/control @@ -6,6 +6,8 @@ libnftables-dev, rebar3, pkg-config, + python3:native, + python3-yaml:native, debhelper (>= 10) Standards-Version: 4.5.0 Vcs-Git: https://gitea.osmocom.org/erlang/osmo-s1gw diff --git a/priv/openapi.json b/priv/openapi.json new file mode 100644 index 0000000..25ff62a --- /dev/null +++ b/priv/openapi.json @@ -0,0 +1,9 @@ +{ + "openapi": "3.0.0", + "info": { + "version": "0.1.0", + "title": "OsmoS1GW REST interface" + }, + "paths": null, + "components": null +} \ No newline at end of file -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41096?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: I84e6ef5cc67cd26b11f7bed8510420e43e18c69b Gerrit-Change-Number: 41096 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

2026

2025

2024

2023

2022

gerrit-log