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

[L] Change in ...osmo-s1gw[master]: [REST] Implement EnbList and EnbInfo

by fixeria

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 week, 2 days

1
0
0 0

[S] Change in ...osmo-s1gw[master]: enb_registry: fetch_enb_list/0: return sorted list

by fixeria

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 week, 2 days

1
0
0 0

[L] Change in ...osmo-s1gw[master]: [REST] Implement Pfcp{AssocState,Heartbeat}

by fixeria

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 week, 2 days

1
0
0 0

[M] Change in ...osmo-s1gw[master]: [REST] Integrate Erlang REST Framework

by fixeria

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 week, 2 days

1
0
0 0

[M] Change in ...osmo-s1gw[master]: [REST] Implement MetricsList

by fixeria

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 week, 2 days

1
0
0 0

[M] Change in ...osmo-s1gw[master]: enb_registry: track eNB uptime

by fixeria

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 week, 2 days

1
0
0 0

[M] Change in ...osmo-s1gw[master]: [REST] osmo-s1gw-cli.py skeleton

by fixeria

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 week, 2 days

1
0
0 0

[S] Change in ...osmo-s1gw[master]: [REST] OpenAPI specification skeleton

by fixeria

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 week, 2 days

1
0
0 0

[M] Change in libosmo-sigtran[master]: Propagate rx M3UA SCON -> MTP-STATUS.ind -> N-PCSTATE.ind

by pespin

pespin has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-sigtran/+/41092?usp=email ) Change subject: Propagate rx M3UA SCON -> MTP-STATUS.ind -> N-PCSTATE.ind ...................................................................... Propagate rx M3UA SCON -> MTP-STATUS.ind -> N-PCSTATE.ind Change-Id: I82541612c039b1cc0191cb44d2eecdcbb07fae96 --- M include/osmocom/sigtran/protocol/mtp.h M src/sccp_internal.h M src/sccp_scmg.c M src/xua_snm.c 4 files changed, 74 insertions(+), 17 deletions(-) Approvals: Jenkins Builder: Verified pespin: Looks good to me, approved diff --git a/include/osmocom/sigtran/protocol/mtp.h b/include/osmocom/sigtran/protocol/mtp.h index 2f0c7ac..4542289 100644 --- a/include/osmocom/sigtran/protocol/mtp.h +++ b/include/osmocom/sigtran/protocol/mtp.h @@ -24,11 +24,19 @@ extern const struct value_string mtp_si_vals[]; -/* Chapter 15.17.5 of Q.705 */ +/* Chapter 15.17.5 of Q.704 */ enum mtp_unavail_cause { MTP_UNAVAIL_C_UNKNOWN = 0x0, MTP_UNAVAIL_C_UNEQUIP_REM_USER = 0x1, MTP_UNAVAIL_C_INACC_REM_USER = 0x2, + /* This field is not explicitly listed in Q.704 15.17.5, but it is + * expicitly described as one of four options in: + * Q.701 "TABLE 1" and 8.4 + * Q.704 2.4.2 + * Q.711 "Table 18" and 7.2.4 + * Q.714 "Figure D.4" + */ + MTP_UNAVAIL_C_CONGESTED = 0x3, /* reserved */ }; diff --git a/src/sccp_internal.h b/src/sccp_internal.h index 045e49b..5b1b94d 100644 --- a/src/sccp_internal.h +++ b/src/sccp_internal.h @@ -80,5 +80,5 @@ void sccp_scmg_rx_ssn_prohibited(struct osmo_sccp_instance *inst, uint32_t dpc, uint32_t ssn, uint32_t smi); void sccp_scmg_rx_mtp_pause(struct osmo_sccp_instance *inst, uint32_t dpc); void sccp_scmg_rx_mtp_resume(struct osmo_sccp_instance *inst, uint32_t dpc); -void sccp_scmg_rx_mtp_status(struct osmo_sccp_instance *inst, uint32_t dpc, enum mtp_unavail_cause cause); +void sccp_scmg_rx_mtp_status(struct osmo_sccp_instance *inst, uint32_t dpc, enum mtp_unavail_cause cause, uint8_t cong_level); int sccp_scmg_init(struct osmo_sccp_instance *inst); diff --git a/src/sccp_scmg.c b/src/sccp_scmg.c index 2ffedce..a0f9e1c 100644 --- a/src/sccp_scmg.c +++ b/src/sccp_scmg.c @@ -125,7 +125,8 @@ * [this would require us to track SSNs at each PC, which we don't] */ } -void sccp_scmg_rx_mtp_status(struct osmo_sccp_instance *inst, uint32_t dpc, enum mtp_unavail_cause cause) +/* ITU-T Q.701 8.4, ITU-T Q.711 7.2.4 */ +void sccp_scmg_rx_mtp_status(struct osmo_sccp_instance *inst, uint32_t dpc, enum mtp_unavail_cause cause, uint8_t cong_level) { struct osmo_scu_pcstate_param pcstate; /* 1) Informs the translation function to update the translation tables. */ @@ -142,20 +143,35 @@ case MTP_UNAVAIL_C_UNKNOWN: case MTP_UNAVAIL_C_UNEQUIP_REM_USER: case MTP_UNAVAIL_C_INACC_REM_USER: + /* 4) local broadcast of "user-out-of-service" for each SSN at that dest + * [this would require us to track SSNs at each PC, which we don't] */ + + /* 6) local broadcast of "remote SCCP unavailable" */ + pcstate = (struct osmo_scu_pcstate_param) { + .affected_pc = dpc, + /* cong_level/RIL doesn't apply here: */ + .restricted_importance_level = 0, + .sp_status = OSMO_SCCP_SP_S_ACCESSIBLE, + .remote_sccp_status = OSMO_SCCP_REM_SCCP_S_UNAVAILABLE_UNKNOWN, + }; + sccp_lbcs_local_bcast_pcstate(inst, &pcstate); + break; + case MTP_UNAVAIL_C_CONGESTED: + /* ITU-T Q.714 5.2.4 Signalling point congested + * ITU-T Q.714 5.2.8 Inter- and Intra- SCCP management congestion reports procedure + * ITU-T Q.714 5.3.6.6 Restricted importance level reporting + * ITU-T Q.714 Figure D.4 + * ITU-T Q.715 9.5 Coordination of congestion control measures between SCCP and other MTP users */ + pcstate = (struct osmo_scu_pcstate_param) { + .affected_pc = dpc, + .restricted_importance_level = cong_level, + .sp_status = OSMO_SCCP_SP_S_CONGESTED, + .remote_sccp_status = (cong_level == 0) ? OSMO_SCCP_REM_SCCP_S_AVAILABLE : + OSMO_SCCP_REM_SCCP_S_CONGESTED, + }; + sccp_lbcs_local_bcast_pcstate(inst, &pcstate); break; } - - /* 4) local broadcast of "user-out-of-service" for each SSN at that dest - * [this would require us to track SSNs at each PC, which we don't] */ - - /* 6) local broadcast of "remote SCCP unavailable" */ - pcstate = (struct osmo_scu_pcstate_param) { - .affected_pc = dpc, - .restricted_importance_level = 0, - .sp_status = OSMO_SCCP_SP_S_ACCESSIBLE, - .remote_sccp_status = OSMO_SCCP_REM_SCCP_S_UNAVAILABLE_UNKNOWN, - }; - sccp_lbcs_local_bcast_pcstate(inst, &pcstate); } const struct value_string sccp_scmg_msgt_names[] = { diff --git a/src/xua_snm.c b/src/xua_snm.c index 344cc63..fd2ef24 100644 --- a/src/xua_snm.c +++ b/src/xua_snm.c @@ -309,7 +309,7 @@ /* Translate to MTP-STATUS.ind towards SCCP (will create N-PCSTATE.ind to SCU) */ if (s7i->sccp && user == MTP_SI_SCCP) - sccp_scmg_rx_mtp_status(s7i->sccp, dpc, cause); + sccp_scmg_rx_mtp_status(s7i->sccp, dpc, cause, 0); /* inform remote ASPs via DUPU */ llist_for_each_entry(asp, &s7i->asp_list, list) { @@ -331,6 +331,34 @@ } } +/* ITU Q.701 8.4 "The level value is included if national options with congestion priorities or multiple signalling link states +without congestion priorities as in Recommendation Q.704 are implemented" */ +static void xua_snm_scon_to_sccp(struct osmo_sccp_instance *sccp, + const uint32_t *aff_pc, unsigned int num_aff_pc, + uint8_t cong_level) +{ + int i; + + for (i = 0; i < num_aff_pc; i++) { + /* 32bit "Affected Point Code" consists of a 7-bit mask followed by 14/16/24-bit SS7 PC, + * see RFC 4666 3.4.1 */ + uint32_t _aff_pc = ntohl(aff_pc[i]); + uint32_t pc = _aff_pc & 0xffffff; + uint8_t mask = _aff_pc >> 24; + + if (!mask) { + sccp_scmg_rx_mtp_status(sccp, pc, MTP_UNAVAIL_C_CONGESTED, cong_level); + } else { + /* we have to send one MTP primitive for each individual point + * code within that mask */ + uint32_t maskbits = (1 << mask) - 1; + uint32_t fullpc; + for (fullpc = (pc & ~maskbits); fullpc <= (pc | maskbits); fullpc++) + sccp_scmg_rx_mtp_status(sccp, fullpc, MTP_UNAVAIL_C_CONGESTED, cong_level); + } + } +} + static void xua_snm_scon(struct osmo_ss7_as *as, const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *concerned_dpc, const uint8_t *cong_level, const char *info_string) { @@ -339,7 +367,12 @@ uint32_t rctx[OSMO_SS7_MAX_RCTX_COUNT]; unsigned int num_rctx; - /* TODO: Translate to MTP-STATUS.ind towards SCCP (will create N-PCSTATE.ind to SCU) */ + /* TODO: Change Congested level/state of related routes, + * see ITU Q.704 3.8.4 "Congestion status of signalling route sets" */ + + /* Translate to MTP-STATUS.ind towards SCCP (will create N-PCSTATE.ind to SCU) */ + if (s7i->sccp) + xua_snm_scon_to_sccp(s7i->sccp, aff_pc, num_aff_pc, cong_level ? *cong_level : 0); /* RFC4666 1.4.6: "When an SG receives a congestion message (SCON) from an ASP and the SG * determines that an SPMC is now encountering congestion, it MAY trigger SS7 MTP3 Transfer -- To view, visit https://gerrit.osmocom.org/c/libosmo-sigtran/+/41092?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: I82541612c039b1cc0191cb44d2eecdcbb07fae96 Gerrit-Change-Number: 41092 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 week, 2 days

1
0
0 0

[S] Change in libosmo-sigtran[master]: m3ua: Forward SCON messages in SG role

by pespin

pespin has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-sigtran/+/41091?usp=email ) Change subject: m3ua: Forward SCON messages in SG role ...................................................................... m3ua: Forward SCON messages in SG role The rx handler for SG role was missing to call the already existing code to propagate state of congestion state towards ASP peers. Spec references to the feature are added in place in the code. Change-Id: Ic68345688d39f5430c30e156b94b1501d77e388c --- M src/m3ua.c M src/xua_snm.c 2 files changed, 25 insertions(+), 4 deletions(-) Approvals: pespin: Looks good to me, approved Jenkins Builder: Verified diff --git a/src/m3ua.c b/src/m3ua.c index 4af17a9..8c30775 100644 --- a/src/m3ua.c +++ b/src/m3ua.c @@ -1058,15 +1058,32 @@ * xua is owned by parent call m3ua_rx_snm() */ static int m3ua_rx_snm_sg(struct osmo_ss7_asp *asp, struct xua_msg *xua) { + struct osmo_ss7_as *as = NULL; + struct xua_msg_part *rctx_ie; + int rc = 0; + switch (xua->hdr.msg_type) { - case M3UA_SNM_DAUD: /* Audit: ASP inquires about availability of Point Codes */ + case M3UA_SNM_SCON: + /* RFC4666 1.4.6: "The M3UA layer at an ASP or IPSP MAY indicate local congestion + * to an M3UA peer with an SCON message." + * RFC4666 3.4.4: The SCON message MAY also be sent from the M3UA layer of an ASP + * to an M3UA peer, indicating that the congestion level of the M3UA layer or the + * ASP has changed.*/ + rctx_ie = xua_msg_find_tag(xua, M3UA_IEI_ROUTE_CTX); + rc = xua_find_as_for_asp(&as, asp, rctx_ie); + if (rc) + return rc; + xua_snm_rx_scon(asp, as, xua); + break; + case M3UA_SNM_DAUD: + /* Audit: ASP inquires about availability of Point Codes */ xua_snm_rx_daud(asp, xua); break; default: return M3UA_ERR_UNSUPP_MSG_TYPE; } - return 0; + return rc; } /* received SNM message diff --git a/src/xua_snm.c b/src/xua_snm.c index eda03c9..344cc63 100644 --- a/src/xua_snm.c +++ b/src/xua_snm.c @@ -339,9 +339,13 @@ uint32_t rctx[OSMO_SS7_MAX_RCTX_COUNT]; unsigned int num_rctx; - /* TODO: How to translate to MTP and towards SCCP (create N-PCSTATE.ind to SCU) */ + /* TODO: Translate to MTP-STATUS.ind towards SCCP (will create N-PCSTATE.ind to SCU) */ - /* inform remote ASPs via SCON */ + /* RFC4666 1.4.6: "When an SG receives a congestion message (SCON) from an ASP and the SG + * determines that an SPMC is now encountering congestion, it MAY trigger SS7 MTP3 Transfer + * Controlled management messages to concerned SS7 destinations according to congestion + * procedures of the relevant MTP3 standard." + * ie. inform remote ASPs via SCON: */ llist_for_each_entry(asp, &s7i->asp_list, list) { /* SSNM is only permitted for ASPs in ACTIVE state */ if (!osmo_ss7_asp_active(asp)) -- To view, visit https://gerrit.osmocom.org/c/libosmo-sigtran/+/41091?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: Ic68345688d39f5430c30e156b94b1501d77e388c Gerrit-Change-Number: 41091 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>

1 week, 2 days

1
0
0 0

2025

2024

2023

2022

gerrit-log September 2025