September 2025 - gerrit-log - lists.osmocom.org

[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

[M] Change in ...osmo-s1gw[master]: [REST] osmo-s1gw-cli.py skeleton
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41097?usp=email ) Change subject: [REST] osmo-s1gw-cli.py skeleton ...................................................................... [REST] osmo-s1gw-cli.py skeleton This is an interactive shell based on Python's cmd2 library, providing an alternative to the traditional VTY interface used in many Osmocom projects. It communicates with the main process via the REST interface. Currently there's only one command fetching the OpenAPI specification. More commands will be introduced in follow-up commits. Change-Id: I05600f2fa6d213b9cee28871761231722ff5b876 Related: SYS#7066 --- M Makefile A contrib/osmo-s1gw-cli.py M debian/control A debian/osmo-s1gw-cli.install A debian/osmo-s1gw.install 5 files changed, 137 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/97/41097/1 diff --git a/Makefile b/Makefile index ddc3dd5..76d9f7e 100644 --- a/Makefile +++ b/Makefile @@ -51,6 +51,8 @@ cp -r $(REBAR_BASE_DIR)/default/rel/osmo-s1gw $(DESTDIR)$(LIBDIR)/ install -Dm0755 contrib/osmo-s1gw.sh \ $(DESTDIR)$(BINDIR)/osmo-s1gw + install -Dm0755 contrib/osmo-s1gw-cli.py \ + $(DESTDIR)$(BINDIR)/osmo-s1gw-cli install -Dm0644 config/sys.config \ $(DESTDIR)$(CONFDIR)/osmo-s1gw.config install -Dm0644 contrib/systemd/osmo-s1gw.service \ diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py new file mode 100755 index 0000000..7d13b08 --- /dev/null +++ b/contrib/osmo-s1gw-cli.py @@ -0,0 +1,118 @@ +#!/usr/bin/env python3 + +# Copyright (C) 2025 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> +# Author: Vadim Yanitskiy <vyanitskiy(a)sysmocom.de> +# +# All Rights Reserved +# +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 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 General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +import logging +import argparse +import cmd2 +import sys + +import tabulate +import urllib.request +import http.client +import json + +# local logger for this module +log = logging.getLogger(__name__) + + +class RestIface: + ''' REST interface for OsmoS1GW ''' + + HTTPResponse = http.client.HTTPResponse + RESTResponse = dict | list[dict] + + def __init__(self, host: str, port: int): + self.url = f'http://{host}:{port}' + + def send_req(self, method: str, + path: str = '', + data: dict = {}) -> HTTPResponse: + ''' Send an HTTP request to the given endpoint (path) ''' + req = urllib.request.Request(f'{self.url}/{path}', method=method) + req.add_header("Accept", "application/json") + if data: + req.add_header("Content-Type", "application/json") + req.data = json.dumps(data).encode("utf-8") + log.debug(f'HTTP {req.method} {req.full_url}') + return urllib.request.urlopen(req) + + def send_get_req(self, path: str, query: dict = {}) -> HTTPResponse: + ''' Send an HTTP GET request to the given endpoint (path) ''' + if query: + path += '?' + urllib.parse.urlencode(query) + return self.send_req('GET', path) + + def send_post_req(self, path: str, data: dict = {}) -> HTTPResponse: + ''' Send an HTTP POST request to the given endpoint (path) ''' + return self.send_req('POST', path, data) + + def send_delete_req(self, path: str, data: dict = {}) -> HTTPResponse: + ''' Send an HTTP DELETE request to the given endpoint (path) ''' + return self.send_req('DELETE', path, data) + + def fetch_spec(self) -> RESTResponse: + with self.send_get_req('swagger/spec.json') as f: + return json.load(f) + + +class OsmoS1GWCli(cmd2.Cmd): + DESC = 'Interactive CLI for OsmoS1GW' + + def __init__(self, argv): + super().__init__(allow_cli_args=False, include_py=True) + + if argv.verbose > 0: + logging.root.setLevel(logging.DEBUG) + self.debug = True + + self.intro = cmd2.style('Welcome to %s!' % self.DESC, fg=cmd2.Fg.RED) + self.default_category = 'Built-in commands' + self.prompt = 'OsmoS1GW# ' + + self.tablefmt = 'github' # default table format for tabulate + self.add_settable(cmd2.Settable('tablefmt', str, 'Table format for tabulate', self, + choices=tabulate.tabulate_formats)) + + self.iface = RestIface(argv.HOST, argv.port) + + def do_fetch_openapi_spec(self, opts): + ''' Fetch the OpenAPI specification (JSON) ''' + spec = self.iface.fetch_spec() + self.poutput(json.dumps(spec, indent=4)) + + +ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) + +ap.add_argument('-v', '--verbose', action='count', default=0, + help='print debug logging') +ap.add_argument('-p', '--port', metavar='PORT', type=int, default=8080, + help='OsmoS1GW REST port (default: %(default)s)') +ap.add_argument('HOST', type=str, nargs='?', default='localhost', + help='OsmoS1GW REST host/address (default: %(default)s)') + +logging.basicConfig( + format='\r[%(levelname)s] %(filename)s:%(lineno)d %(message)s', level=logging.INFO) + +if __name__ == '__main__': + argv = ap.parse_args() + app = OsmoS1GWCli(argv) + sys.exit(app.cmdloop()) diff --git a/debian/control b/debian/control index f7e9258..7d7192f 100644 --- a/debian/control +++ b/debian/control @@ -23,3 +23,15 @@ This can be used on the S1 interface between eNB and MME/CN, and acts as separation between the eNB-facing IP network and the CN-facing IP network, which may be separate without routing in between. + +Package: osmo-s1gw-cli +Architecture: any +Section: utils +Depends: ${misc:Depends}, + ${python3:Depends}, + python3-cmd2, + python3-tabulate +Description: Interactive CLI for the Osmocom S1 gateway + This is an interactive shell for the Osmocom S1 gateway, providing + an alternative to the traditional VTY interface used in many Osmocom + projects. It communicates with OsmoS1GW via the REST interface. diff --git a/debian/osmo-s1gw-cli.install b/debian/osmo-s1gw-cli.install new file mode 100644 index 0000000..037a640 --- /dev/null +++ b/debian/osmo-s1gw-cli.install @@ -0,0 +1 @@ +usr/bin/osmo-s1gw-cli diff --git a/debian/osmo-s1gw.install b/debian/osmo-s1gw.install new file mode 100644 index 0000000..b52efe2 --- /dev/null +++ b/debian/osmo-s1gw.install @@ -0,0 +1,4 @@ +usr/bin/osmo-s1gw +usr/lib/osmo-s1gw +etc/osmocom/osmo-s1gw.config +lib/systemd/system/osmo-s1gw.service -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41097?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: I05600f2fa6d213b9cee28871761231722ff5b876 Gerrit-Change-Number: 41097 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[M] Change in ...osmo-s1gw[master]: enb_registry: track eNB uptime
by fixeria 12 Sep '25

12 Sep '25

Attention is currently required from: fixeria, jolly. Hello Jenkins Builder, jolly, I'd like you to reexamine a change. Please visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41035?usp=email to look at the new patch set (#2). The following approvals got outdated and were removed: Code-Review+1 by jolly, Verified+1 by Jenkins Builder Change subject: enb_registry: track eNB uptime ...................................................................... enb_registry: track eNB uptime Now that we have the global eNB registry, it makes more sense to perform uptime tracking there instead of spawning a separate enb_uptime process for each eNB connection. Change-Id: I94fd06e559ae52d4d9c8b22e618e48dff718b53c Related: SYS#7594, SYS#7066 --- M src/enb_registry.erl D src/enb_uptime.erl M src/s1ap_proxy.erl 3 files changed, 59 insertions(+), 109 deletions(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/35/41035/2 -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41035?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newpatchset Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: I94fd06e559ae52d4d9c8b22e618e48dff718b53c Gerrit-Change-Number: 41035 Gerrit-PatchSet: 2 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-CC: pespin <pespin(a)sysmocom.de> Gerrit-Attention: jolly <andreas(a)eversberg.eu> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de>

1 0

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

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41099?usp=email ) Change subject: [REST] Implement MetricsList ...................................................................... [REST] Implement MetricsList Change-Id: I43114aa8f5f8a388dd6a436f83ad1ee97f1d2ab1 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, 221 insertions(+), 3 deletions(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/99/41099/1 diff --git a/contrib/openapi.yaml b/contrib/openapi.yaml index c7f7ec8..696e7a2 100644 --- a/contrib/openapi.yaml +++ b/contrib/openapi.yaml @@ -4,5 +4,52 @@ title: 'OsmoS1GW REST interface' paths: + /metrics-list: + get: + summary: Get a list of metrics + operationId: MetricsList + parameters: + - name: type + in: query + description: Metric type + required: false + schema: + type: string + enum: [all, counter, gauge] + default: all + - name: path + in: query + description: Metrics path + required: false + schema: + type: string + example: s1ap.proxy + responses: + '200': + description: A list of metrics + content: + application/json: + schema: + $ref: '#/components/schemas/MetricsList' components: + schemas: + MetricsList: + type: array + items: + $ref: '#/components/schemas/MetricsItem' + + MetricsItem: + type: object + required: + - type + - name + - value + properties: + type: + type: string + enum: [counter, gauge] + name: + type: string + value: + type: integer diff --git a/contrib/osmo-s1gw-cli.py b/contrib/osmo-s1gw-cli.py index 7d13b08..9888ee9 100755 --- a/contrib/osmo-s1gw-cli.py +++ b/contrib/osmo-s1gw-cli.py @@ -73,10 +73,20 @@ with self.send_get_req('swagger/spec.json') as f: return json.load(f) + def metrics_list(self, type: str = 'all', path: str = '') -> RESTResponse: + ''' MetricsList :: Get a list of metrics ''' + query = {'type' : type} + if path: + query['path'] = path + with self.send_get_req('metrics-list', query) as f: + return json.load(f) + class OsmoS1GWCli(cmd2.Cmd): DESC = 'Interactive CLI for OsmoS1GW' + CAT_METRICS = 'Metrics commands' + def __init__(self, argv): super().__init__(allow_cli_args=False, include_py=True) @@ -99,6 +109,31 @@ spec = self.iface.fetch_spec() self.poutput(json.dumps(spec, indent=4)) + @staticmethod + def metrics_list_item(item: dict) -> dict: + return { + 'Name': item.get('name'), + 'Type': item.get('type'), + 'Value': item.get('value'), + } + + metrics_list_parser = cmd2.Cmd2ArgumentParser() + metrics_list_parser.add_argument('-t', '--type', + type=str, default='all', + choices=('all', 'counter', 'gauge'), + help='Metric type (default: %(default)s)') + metrics_list_parser.add_argument('PATH', + type=str, default='', nargs='?', + help='Metric path') + + @cmd2.with_argparser(metrics_list_parser) + @cmd2.with_category(CAT_METRICS) + def do_metrics_list(self, opts) -> None: + ''' Get a list of metrics ''' + data = self.iface.metrics_list(opts.type, opts.PATH) + self.poutput(tabulate.tabulate(map(self.metrics_list_item, data), + headers='keys', tablefmt=self.tablefmt)) + ap = argparse.ArgumentParser(prog='osmo-s1gw-cli', description=OsmoS1GWCli.DESC) diff --git a/priv/openapi.json b/priv/openapi.json index 25ff62a..7323e9a 100644 --- a/priv/openapi.json +++ b/priv/openapi.json @@ -4,6 +4,84 @@ "version": "0.1.0", "title": "OsmoS1GW REST interface" }, - "paths": null, - "components": null + "paths": { + "/metrics-list": { + "get": { + "summary": "Get a list of metrics", + "operationId": "MetricsList", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Metric type", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "counter", + "gauge" + ], + "default": "all" + } + }, + { + "name": "path", + "in": "query", + "description": "Metrics path", + "required": false, + "schema": { + "type": "string", + "example": "s1ap.proxy" + } + } + ], + "responses": { + "200": { + "description": "A list of metrics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetricsList" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "MetricsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MetricsItem" + } + }, + "MetricsItem": { + "type": "object", + "required": [ + "type", + "name", + "value" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "counter", + "gauge" + ] + }, + "name": { + "type": "string" + }, + "value": { + "type": "integer" + } + } + } + } + } } \ No newline at end of file diff --git a/src/rest_server.erl b/src/rest_server.erl index c4e0373..ee0a7de 100644 --- a/src/rest_server.erl +++ b/src/rest_server.erl @@ -34,19 +34,77 @@ -module(rest_server). --export([]). +-export([metrics_list/1 + ]). -include_lib("kernel/include/logger.hrl"). +-include("s1gw_metrics.hrl"). + %% ------------------------------------------------------------------ %% public API %% ------------------------------------------------------------------ +%% MetricsList :: Get a list of metrics +metrics_list(#{query_parameters := QP}) -> + L0 = case proplists:get_value(<< "type" >>, QP, << "all" >>) of + << "counter" >> -> metric_list([ctr]); + << "gauge" >> -> metric_list([gauge]); + << "all" >> -> metric_list([]) + end, + L1 = case proplists:get_value(<< "path" >>, QP) of + undefined -> L0; + Path -> lists:filter(fun(M) -> metric_filter_path(M, Path) end, L0) + end, + {200, [], L1}. + %% ------------------------------------------------------------------ %% private API %% ------------------------------------------------------------------ +-spec metric_list(list()) -> [map()]. +metric_list(Path) -> + L = exometer:get_values(Path), + lists:map(fun metric_item/1, L). + + +-spec metric_item({Name, Props}) -> map() + when Name :: s1gw_metrics:metric(), + Props :: proplists:proplist(). +metric_item({Name, Props}) -> + Value = proplists:get_value(value, Props), + #{<< "type" >> => metric_type(Name), + << "name" >> => metric_name(Name), + << "value" >> => Value}. + + +-spec metric_type(s1gw_metrics:metric()) -> binary(). +metric_type([ctr | _]) -> << "counter" >>; +metric_type([gauge | _]) -> << "gauge" >>. + + +-spec metric_filter_path(map(), binary()) -> boolean(). +metric_filter_path(#{<< "name" >> := Name}, Path) -> + Len = erlang:min(byte_size(Name), byte_size(Path)), + binary:part(Name, 0, Len) =:= Path. + + +-spec metric_name(s1gw_metrics:metric()) -> binary(). +metric_name([_Type | P0]) -> + %% turn each list member into a string + P1 = lists:map(fun thing_to_list/1, P0), + %% put the dot-separator in between + P2 = string:join(P1, "."), + list_to_binary(P2). + + +%% stolen from exometer_report_statsd.git +thing_to_list(X) when is_atom(X) -> atom_to_list(X); +thing_to_list(X) when is_integer(X) -> integer_to_list(X); +thing_to_list(X) when is_binary(X) -> X; +thing_to_list(X) when is_list(X) -> X. + %% vim:set ts=4 sw=4 et: -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41099?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: I43114aa8f5f8a388dd6a436f83ad1ee97f1d2ab1 Gerrit-Change-Number: 41099 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[M] Change in ...osmo-s1gw[master]: [REST] Integrate Erlang REST Framework
by fixeria 12 Sep '25

12 Sep '25

fixeria has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41098?usp=email ) Change subject: [REST] Integrate Erlang REST Framework ...................................................................... [REST] Integrate Erlang REST Framework Change-Id: I20ad3208b8cd4f5483992e3bf22af30ff62b0311 Related: SYS#7066 --- M config/sys.config M rebar.config M rebar.lock M src/osmo_s1gw.app.src M src/osmo_s1gw.erl M src/osmo_s1gw_sup.erl A src/rest_server.erl 7 files changed, 106 insertions(+), 4 deletions(-) git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-s1gw refs/changes/98/41098/1 diff --git a/config/sys.config b/config/sys.config index 4e5a80c..5184ebb 100644 --- a/config/sys.config +++ b/config/sys.config @@ -25,7 +25,9 @@ %% {gtpu_kpi_table_name, "osmo-s1gw"}, %% the NFT table name to be used by this process %% {gtpu_kpi_ul_addr, s1ap}, %% GTP-U UL address: s1ap | sctp (default: learn from S1AP) %% {gtpu_kpi_dl_addr, s1ap}, %% GTP-U DL address: s1ap | sctp (default: learn from S1AP) -%% {gtpu_kpi_interval, 3000} %% counter reporting interval (ms) +%% {gtpu_kpi_interval, 3000}, %% counter reporting interval (ms) +%% {rest_srv_port, 8080}, %% REST server port (default: 8080) +%% {rest_srv_swagger_ui, true} %% REST Swagger UI (default: true) ]}, %% ================================================================================ %% kernel config diff --git a/rebar.config b/rebar.config index de8b023..d729401 100644 --- a/rebar.config +++ b/rebar.config @@ -16,7 +16,9 @@ {exometer_core, {git, "https://github.com/Feuerlabs/exometer_core.git", {branch, "master"}}}, {exometer_report_statsd, - {git, "https://github.com/osmocom/exometer_report_statsd.git", {branch, "counters"}}} + {git, "https://github.com/osmocom/exometer_report_statsd.git", {branch, "counters"}}}, + {erf, + {git, "https://github.com/nomasystems/erf.git", {tag, "0.1.2"}}} ]}. %% test deps diff --git a/rebar.lock b/rebar.lock index 647bca0..1efe90b 100644 --- a/rebar.lock +++ b/rebar.lock @@ -1,9 +1,17 @@ {"1.2.0", [{<<"cut">>,{pkg,<<"cut">>,<<"1.0.3">>},1}, + {<<"elli">>, + {git,"https://github.com/elli-lib/elli.git", + {ref,"3ec352293ef493c142767127f4113c85541c32cc"}}, + 1}, {<<"enftables">>, {git,"https://gitea.osmocom.org/erlang/enftables.git", {ref,"8b9b4acd624b9d0d3a58d725f11afa96d31fe5d7"}}, 0}, + {<<"erf">>, + {git,"https://github.com/nomasystems/erf.git", + {ref,"0dac504f9988d3b96154c1e80b8af3defb772b58"}}, + 0}, {<<"exometer_core">>, {git,"https://github.com/Feuerlabs/exometer_core.git", {ref,"fc744c45bbe5de2ab0ee550e2667f93f7abbb618"}}, @@ -25,6 +33,18 @@ {git,"https://gitea.osmocom.org/erlang/logger_gsmtap.git", {ref,"5194badde912a8179f2a818155ee2b01f9e6377e"}}, 0}, + {<<"ncalendar">>, + {git,"https://github.com/nomasystems/ncalendar.git", + {ref,"aa5615f6723585e45e82fa5524cb976cdfe3d7f7"}}, + 2}, + {<<"ndto">>, + {git,"https://github.com/nomasystems/ndto.git", + {ref,"295281b72ea4ac85e7c4d5ca42337c68b1aac137"}}, + 1}, + {<<"njson">>, + {git,"https://github.com/nomasystems/njson.git", + {ref,"94c586b92a7e24c403089cdbe2994b7e7c87b9cc"}}, + 1}, {<<"parse_trans">>,{pkg,<<"parse_trans">>,<<"3.4.1">>},1}, {<<"pfcplib">>, {git,"https://github.com/travelping/pfcplib.git", diff --git a/src/osmo_s1gw.app.src b/src/osmo_s1gw.app.src index 13240dd..2885cc6 100644 --- a/src/osmo_s1gw.app.src +++ b/src/osmo_s1gw.app.src @@ -12,7 +12,8 @@ pfcplib, enftables, exometer_core, - exometer_report_statsd + exometer_report_statsd, + erf ]}, {modules, []}, {mod, {osmo_s1gw_app, []}}, diff --git a/src/osmo_s1gw.erl b/src/osmo_s1gw.erl index d5f9efd..e90d927 100644 --- a/src/osmo_s1gw.erl +++ b/src/osmo_s1gw.erl @@ -35,6 +35,7 @@ -module(osmo_s1gw). -export([get_env/2, + get_priv/1, main/1]). -define(ENV_APP_NAME, osmo_s1gw). @@ -52,6 +53,14 @@ application:get_env(?ENV_APP_NAME, Param, Default). +-spec get_priv(Name) -> Path + when Name :: file:filename_all(), + Path :: file:filename_all(). +get_priv(Name) -> + PrivDir = code:priv_dir(?ENV_APP_NAME), + filename:join(PrivDir, Name). + + main(_Args) -> application:ensure_all_started(?MODULE), timer:sleep(infinity). diff --git a/src/osmo_s1gw_sup.erl b/src/osmo_s1gw_sup.erl index 934f040..1616fe5 100644 --- a/src/osmo_s1gw_sup.erl +++ b/src/osmo_s1gw_sup.erl @@ -53,6 +53,8 @@ -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 @@ -87,9 +89,14 @@ 5000, worker, [gtpu_kpi]}, + RestServer = {rest_server, {erf, start_link, [rest_server_cfg()]}, + permanent, + 5000, + worker, + [erf]}, s1gw_metrics:init(), - {ok, {{one_for_one, 5, 10}, [EnbRegistry, SctpServer, PfcpPeer, GtpuKpi]}}. + {ok, {{one_for_one, 5, 10}, [EnbRegistry, SctpServer, PfcpPeer, GtpuKpi, RestServer]}}. %% ------------------------------------------------------------------ @@ -126,4 +133,13 @@ table_name => 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 rest_server_cfg() -> erf:conf(). +rest_server_cfg() -> + #{callback => rest_server, + spec_path => list_to_binary(osmo_s1gw:get_priv("openapi.json")), + 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)}. + + %% vim:set ts=4 sw=4 et: diff --git a/src/rest_server.erl b/src/rest_server.erl new file mode 100644 index 0000000..c4e0373 --- /dev/null +++ b/src/rest_server.erl @@ -0,0 +1,52 @@ +%% Copyright (C) 2025 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. + +-module(rest_server). + +-export([]). + +-include_lib("kernel/include/logger.hrl"). + + +%% ------------------------------------------------------------------ +%% public API +%% ------------------------------------------------------------------ + + +%% ------------------------------------------------------------------ +%% private API +%% ------------------------------------------------------------------ + + +%% vim:set ts=4 sw=4 et: -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/41098?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: I20ad3208b8cd4f5483992e3bf22af30ff62b0311 Gerrit-Change-Number: 41098 Gerrit-PatchSet: 1 Gerrit-Owner: fixeria <vyanitskiy(a)sysmocom.de>

1 0

[S] Change in libosmo-sigtran[master]: m3ua: Fix memleak in m3ua_rx_snm_sg() and some paths of m3ua_rx_snm()
by pespin 12 Sep '25

12 Sep '25

pespin has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-sigtran/+/41090?usp=email ) Change subject: m3ua: Fix memleak in m3ua_rx_snm_sg() and some paths of m3ua_rx_snm() ...................................................................... m3ua: Fix memleak in m3ua_rx_snm_sg() and some paths of m3ua_rx_snm() Own and free the xua msg in the main m3ua_rx_snm*() as done for other message types. Change-Id: Iab795da63e65d9539a44c985d9ca85aa76d203c6 --- M src/m3ua.c 1 file changed, 23 insertions(+), 11 deletions(-) Approvals: Jenkins Builder: Verified pespin: Looks good to me, approved diff --git a/src/m3ua.c b/src/m3ua.c index 7d3945c..4af17a9 100644 --- a/src/m3ua.c +++ b/src/m3ua.c @@ -1005,7 +1005,7 @@ } /* received SNM message on ASP side - * This function takes ownership of xua msg passed to it. */ + * xua is owned by parent call m3ua_rx_snm() */ static int m3ua_rx_snm_asp(struct osmo_ss7_asp *asp, struct xua_msg *xua) { struct osmo_ss7_as *as = NULL; @@ -1014,7 +1014,7 @@ rc = xua_find_as_for_asp(&as, asp, rctx_ie); if (rc) - goto ret_free; + return rc; /* report those up the stack so both other ASPs and local SCCP users can be notified */ switch (xua->hdr.msg_type) { @@ -1051,12 +1051,11 @@ rc = M3UA_ERR_UNSUPP_MSG_TYPE; } -ret_free: - xua_msg_free(xua); return rc; } -/* received SNM message on SG side */ +/* received SNM message on SG side + * xua is owned by parent call m3ua_rx_snm() */ static int m3ua_rx_snm_sg(struct osmo_ss7_asp *asp, struct xua_msg *xua) { switch (xua->hdr.msg_type) { @@ -1070,9 +1069,12 @@ return 0; } +/* received SNM message + * This function takes ownership of xua msg passed to it. */ static int m3ua_rx_snm(struct osmo_ss7_asp *asp, struct xua_msg *xua) { struct xua_msg_part *na_ie = xua_msg_find_tag(xua, M3UA_IEI_NET_APPEAR); + int rc; /* SNM only permitted in ACTIVE state */ if (asp->fi->state != XUA_ASP_S_ACTIVE) { @@ -1083,7 +1085,8 @@ } else { LOGPASP(asp, DLM3UA, LOGL_ERROR, "Rx M3UA SNM not permitted " "while ASP in state %s\n", osmo_fsm_inst_state_name(asp->fi)); - return M3UA_ERR_UNEXPECTED_MSG; + rc = M3UA_ERR_UNEXPECTED_MSG; + goto ret_free; } } @@ -1095,16 +1098,25 @@ "Unsupported 'Network Appearance' IE '0x%08x' in message type '%s', sending 'Error'.\n", na, get_value_string(m3ua_xfer_msgt_names, xua->hdr.msg_type)); if (na_ie->len != 4) - return M3UA_ERR_PARAM_FIELD_ERR; - return M3UA_ERR_INVAL_NET_APPEAR; + rc = M3UA_ERR_PARAM_FIELD_ERR; + else + rc = M3UA_ERR_INVAL_NET_APPEAR; + goto ret_free; } switch (asp->cfg.role) { case OSMO_SS7_ASP_ROLE_SG: - return m3ua_rx_snm_sg(asp, xua); + rc = m3ua_rx_snm_sg(asp, xua); + break; case OSMO_SS7_ASP_ROLE_ASP: - return m3ua_rx_snm_asp(asp, xua); + rc = m3ua_rx_snm_asp(asp, xua); + break; default: - return M3UA_ERR_UNSUPP_MSG_CLASS; + rc = M3UA_ERR_UNSUPP_MSG_CLASS; + break; } + +ret_free: + xua_msg_free(xua); + return rc; } -- To view, visit https://gerrit.osmocom.org/c/libosmo-sigtran/+/41090?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: libosmo-sigtran Gerrit-Branch: master Gerrit-Change-Id: Iab795da63e65d9539a44c985d9ca85aa76d203c6 Gerrit-Change-Number: 41090 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: daniel <dwillmann(a)sysmocom.de> Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 0

2026

2025

2024

2023

2022

gerrit-log September 2025