[M] Change in osmo-ttcn3-hacks[master]: gbproxy: sync configs with docker-playground
by osmith
osmith has submitted this change. ( https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/40239?usp=email )
Change subject: gbproxy: sync configs with docker-playground
......................................................................
gbproxy: sync configs with docker-playground
Change-Id: Ibef7e870c5c90d1cc861c89904950b1ac68dc9b2
---
M gbproxy/GBProxy_Tests.cfg
M gbproxy/osmo-gbproxy.cfg
2 files changed, 84 insertions(+), 6 deletions(-)
Approvals:
Jenkins Builder: Verified
fixeria: Looks good to me, but someone else must approve
pespin: Looks good to me, approved
laforge: Looks good to me, but someone else must approve
diff --git a/gbproxy/GBProxy_Tests.cfg b/gbproxy/GBProxy_Tests.cfg
index d610e40..40af557 100644
--- a/gbproxy/GBProxy_Tests.cfg
+++ b/gbproxy/GBProxy_Tests.cfg
@@ -12,13 +12,89 @@
*.GBPVTY.CTRL_HOSTNAME := "127.0.0.1"
[MODULE_PARAMETERS]
+GBProxy_Tests.mp_gbproxy_ip := "127.0.0.1"
GBProxy_Tests.mp_nsconfig_sgsn := {
{
- handle_sns := true
+ handle_sns := true,
+ nsvc := {
+ {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }, {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }
+ }
}, {
- handle_sns := true
+ handle_sns := true,
+ nsvc := {
+ {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }, {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }
+ }
}
-
+}
+GBProxy_Tests.mp_nsconfig_pcu := {
+ {
+ handle_sns := true,
+ nsvc := {
+ {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_udp_port := 24000,
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }
+ }
+ }, {
+ handle_sns := true,
+ nsvc := {
+ {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_udp_port := 24000,
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }
+ }
+ }, {
+ handle_sns := true,
+ nsvc := {
+ {
+ provider := {
+ ip := {
+ local_ip := "127.0.0.10",
+ remote_udp_port := 24000,
+ remote_ip := "127.0.0.1"
+ }
+ }
+ }
+ }
+ }
}
[MAIN_CONTROLLER]
diff --git a/gbproxy/osmo-gbproxy.cfg b/gbproxy/osmo-gbproxy.cfg
index 0fc9fc2..ee888f4 100644
--- a/gbproxy/osmo-gbproxy.cfg
+++ b/gbproxy/osmo-gbproxy.cfg
@@ -18,6 +18,9 @@
logging level gprs debug
line vty
no login
+ bind 127.0.0.1
+ctrl
+ bind 127.0.0.1
!
gbproxy
nri bitlen 5
@@ -30,15 +33,14 @@
ns
bind udp sgsn-side
listen 127.0.0.1 23000
- accept-ipaccess
nse 101
ip-sns-bind sgsn-side
ip-sns-remote 127.0.0.10 7777
nse 102
ip-sns-bind sgsn-side
- ip-sns-remote 127.0.0.11 8888
+ ip-sns-remote 127.0.0.10 8888
bind udp bss-side
- listen 127.0.0.2 23000
+ listen 127.0.0.1 24000
accept-dynamic-ip-sns
ip-sns-default bind bss-side
timer tns-block 3
--
To view, visit https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/40239?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: osmo-ttcn3-hacks
Gerrit-Branch: master
Gerrit-Change-Id: Ibef7e870c5c90d1cc861c89904950b1ac68dc9b2
Gerrit-Change-Number: 40239
Gerrit-PatchSet: 1
Gerrit-Owner: osmith <osmith(a)sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: osmith <osmith(a)sysmocom.de>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
2 months
- 1
- 0
[M] Change in ...osmo-epdg[master]: Add required conversions for IPv6 support
by clufn
clufn has uploaded this change for review. ( https://gerrit.osmocom.org/c/erlang/osmo-epdg/+/40255?usp=email )
Change subject: Add required conversions for IPv6 support
......................................................................
Add required conversions for IPv6 support
Change-Id: I2426e0dcee3ca92075b845f6b21a175a3d047c08
---
M src/conv.erl
1 file changed, 45 insertions(+), 17 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-epdg refs/changes/55/40255/1
diff --git a/src/conv.erl b/src/conv.erl
index d45c41d..0be6877 100644
--- a/src/conv.erl
+++ b/src/conv.erl
@@ -39,10 +39,14 @@
-include_lib("conv.hrl").
-export([ip_to_bin/1, bin_to_ip/1]).
+-export([remove_prefix/1]).
+-export([add_prefix/1]).
+-export([get_6_from_bin/1]).
-export([cause_gtp2gsup/1]).
-export([dia_rc_success/1, dia_rc_to_gsup_cause/1]).
-export([gtp2_paa_to_epdg_eua/1, epdg_eua_to_gsup_pdp_address/1]).
-export([nai_to_imsi/1]).
+-export([get_v4v6/2]).
% ergw_aaa/src/ergw_aaa_3gpp_dict.erl
% under GPLv2+
@@ -62,6 +66,23 @@
bin_to_ip({_, _, _, _, _, _, _, _} = IP) ->
IP.
+remove_prefix(<<A:8, Rest/binary>>) when is_binary(Rest) ->
+ Rest.
+
+add_prefix(<<A:8, B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8>>) ->
+ <<8, A:8, B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8>>.
+
+get_6_from_bin(<<A:8, B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8>>) ->
+ {A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P}.
+
+get_v4v6(<<A:8, B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8>> , <<Q:8, R:8, S:8, T:8>>) ->
+ <<8, A:8, B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8, Q:8, R:8, S:8, T:8>>.
+
+get_4_from_v4v6(<<A:136, Rest/binary>>) when is_binary(Rest) ->
+ Rest.
+get_6_from_v4v6(<<A:8, B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8, Q:8, Rest/binary>>) ->
+ <<B:8, C:8, D:8, E:8, F:8, G:8, H:8, I:8, J:8, K:8, L:8, M:8, N:8, O:8, P:8, Q:8>>.
+
-spec cause_gtp2gsup(integer()) -> integer().
cause_gtp2gsup(?GTP2_CAUSE_REQUEST_ACCEPTED) -> 0;
@@ -79,18 +100,18 @@
-define(DIA_VENDOR_3GPP, 10415).
% transient (only in Experimental-Result-Code)
--define(DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE, 4181).
--define(DIAMETER_ERROR_CAMEL_SUBSCRIPTION_PRESENT, 4182).
+-define(DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE, 4181).
+-define(DIAMETER_ERROR_CAMEL_SUBSCRIPTION_PRESENT, 4182).
% permanent (only in Experimental-Result-Code)
--define(DIAMETER_ERROR_USER_UNKNOWN, 5001).
--define(DIAMETER_AUTHORIZATION_REJECTED, 5003).
--define(DIAMETER_ERROR_ROAMING_NOT_ALLOWED, 5004).
--define(DIAMETER_MISSING_AVP, 5005).
--define(DIAMETER_UNABLE_TO_COMPLY, 5012).
--define(DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION, 5420).
--define(DIAMETER_ERROR_RAT_NOT_ALLOWED, 5421).
--define(DIAMETER_ERROR_EQUIPMENT_UNKNOWN, 5422).
--define(DIAMETER_ERROR_UNKOWN_SERVING_NODE, 5423).
+-define(DIAMETER_ERROR_USER_UNKNOWN, 5001).
+-define(DIAMETER_AUTHORIZATION_REJECTED, 5003).
+-define(DIAMETER_ERROR_ROAMING_NOT_ALLOWED, 5004).
+-define(DIAMETER_MISSING_AVP, 5005).
+-define(DIAMETER_UNABLE_TO_COMPLY, 5012).
+-define(DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION, 5420).
+-define(DIAMETER_ERROR_RAT_NOT_ALLOWED, 5421).
+-define(DIAMETER_ERROR_EQUIPMENT_UNKNOWN, 5422).
+-define(DIAMETER_ERROR_UNKOWN_SERVING_NODE, 5423).
dia_rc_success(#epdg_dia_rc{result_code = 2001}) -> ok;
dia_rc_success(#epdg_dia_rc{result_code = 2002}) -> ok;
@@ -112,19 +133,26 @@
ipv4 = Addr};
gtp2_paa_to_epdg_eua(#v2_pdn_address_allocation{type = ipv6, address = Addr}) ->
#epdg_eua{type_nr = ?GTP_PDP_ADDR_TYPE_NR_IPv6,
- ipv6 = Addr}.
-%TODO: IPv4v6
+ ipv6 = remove_prefix(Addr)};
+gtp2_paa_to_epdg_eua(#v2_pdn_address_allocation{type = ipv4v6, address = Addr}) ->
+ #epdg_eua{type_nr = ?GTP_PDP_ADDR_TYPE_NR_IPv4v6,
+ ipv4 = get_4_from_v4v6(Addr),
+ ipv6 = get_6_from_v4v6(Addr)}.
epdg_eua_to_gsup_pdp_address(#epdg_eua{type_nr = ?GTP_PDP_ADDR_TYPE_NR_IPv4, ipv4 = Addr}) ->
#{pdp_type_org => 1,
- pdp_type_nr => ?GTP_PDP_ADDR_TYPE_NR_IPv4,
- address => #{ ipv4 => Addr}};
+ pdp_type_nr => ?GTP_PDP_ADDR_TYPE_NR_IPv4,
+ address => #{ ipv4 => Addr}};
epdg_eua_to_gsup_pdp_address(#epdg_eua{type_nr = ?GTP_PDP_ADDR_TYPE_NR_IPv6, ipv6 = Addr}) ->
#{pdp_type_org => 1,
pdp_type_nr => ?GTP_PDP_ADDR_TYPE_NR_IPv6,
- address => #{ ipv6 => Addr}}.
-%TODO: IPv4v6
+ address => #{ ipv6 => Addr}};
+
+epdg_eua_to_gsup_pdp_address(#epdg_eua{type_nr = ?GTP_PDP_ADDR_TYPE_NR_IPv4v6, ipv4 = Addr4, ipv6 = Addr6}) ->
+#{pdp_type_org => 1,
+ pdp_type_nr => ?GTP_PDP_ADDR_TYPE_NR_IPv4v6,
+ address => #{ ipv4 => Addr, ipv6 => Addr6}}.
% 3GPP TS 23.003 clause 19
% Input: "<IMSI>@nai.epc.mnc<MNC>.mcc<MCC>.3gppnetwork.org"
--
To view, visit https://gerrit.osmocom.org/c/erlang/osmo-epdg/+/40255?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-epdg
Gerrit-Branch: master
Gerrit-Change-Id: I2426e0dcee3ca92075b845f6b21a175a3d047c08
Gerrit-Change-Number: 40255
Gerrit-PatchSet: 1
Gerrit-Owner: clufn <callumfarrbennett(a)yahoo.com>
2 months
- 1
- 0
[XL] Change in osmo-hnbgw[master]: Split hnb_context,hnb_persistent,umts_cell_id to their own files
by pespin
Attention is currently required from: pespin.
Hello Jenkins Builder,
I'd like you to reexamine a change. Please visit
https://gerrit.osmocom.org/c/osmo-hnbgw/+/40254?usp=email
to look at the new patch set (#2).
The following approvals got outdated and were removed:
Verified-1 by Jenkins Builder
Change subject: Split hnb_context,hnb_persistent,umts_cell_id to their own files
......................................................................
Split hnb_context,hnb_persistent,umts_cell_id to their own files
It's really disturbing having to cope with all HNB related code while
for instance focusing on CN side of things.
Properly split the HNB related code to its own files so it can be left
out easily when needed, or stuff found more easily when required.
It also makes it easier to extend it later.
umts_cell_id is split to its own module since it's needed both in
hnb_context and hnb_persitent, and it's really independent of everything
else in the code.
Change-Id: I4ff65d14f94d99a57316c2483c92244078bb5dd9
---
M include/osmocom/hnbgw/Makefile.am
M include/osmocom/hnbgw/context_map.h
A include/osmocom/hnbgw/hnb.h
A include/osmocom/hnbgw/hnb_persistent.h
M include/osmocom/hnbgw/hnbgw.h
M include/osmocom/hnbgw/hnbgw_hnbap.h
M include/osmocom/hnbgw/hnbgw_rua.h
A include/osmocom/hnbgw/umts_cell_id.h
M src/osmo-hnbgw/Makefile.am
M src/osmo-hnbgw/context_map.c
M src/osmo-hnbgw/context_map_rua.c
M src/osmo-hnbgw/context_map_sccp.c
A src/osmo-hnbgw/hnb.c
A src/osmo-hnbgw/hnb_persistent.c
M src/osmo-hnbgw/hnbgw.c
M src/osmo-hnbgw/hnbgw_hnbap.c
M src/osmo-hnbgw/hnbgw_ranap.c
M src/osmo-hnbgw/hnbgw_rua.c
M src/osmo-hnbgw/hnbgw_vty.c
M src/osmo-hnbgw/kpi_dtap.c
M src/osmo-hnbgw/kpi_ranap.c
M src/osmo-hnbgw/nft_kpi.c
M src/osmo-hnbgw/osmo_hnbgw_main.c
A src/osmo-hnbgw/umts_cell_id.c
M tests/ranap_rab_ass/ranap_rab_ass_test.c
M tests/umts_cell_id/umts_cell_id_test.c
26 files changed, 1,224 insertions(+), 1,006 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-hnbgw refs/changes/54/40254/2
--
To view, visit https://gerrit.osmocom.org/c/osmo-hnbgw/+/40254?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: newpatchset
Gerrit-Project: osmo-hnbgw
Gerrit-Branch: master
Gerrit-Change-Id: I4ff65d14f94d99a57316c2483c92244078bb5dd9
Gerrit-Change-Number: 40254
Gerrit-PatchSet: 2
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Attention: pespin <pespin(a)sysmocom.de>
2 months
- 1
- 0
[L] Change in osmo-hnbgw[master]: Move hnbgw_cnlink to cnlink.h and hnbgw_cnpool to hnbgw_cn.h
by pespin
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-hnbgw/+/40253?usp=email )
Change subject: Move hnbgw_cnlink to cnlink.h and hnbgw_cnpool to hnbgw_cn.h
......................................................................
Move hnbgw_cnlink to cnlink.h and hnbgw_cnpool to hnbgw_cn.h
Simplify mastodontic hnbgw.h and properly split per object/entity.
We actually have that in C files (cnlink.c and hnbgw_cn.c), so do the
same here.
This makes it easier to spot where stuff is, and extend it later (like
adding stats, etc.).
Change-Id: I75988112cff6c8c17d2bdb166a0934934c523dfc
---
M include/osmocom/hnbgw/Makefile.am
A include/osmocom/hnbgw/cnlink.h
M include/osmocom/hnbgw/hnbgw.h
M include/osmocom/hnbgw/hnbgw_cn.h
4 files changed, 175 insertions(+), 157 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-hnbgw refs/changes/53/40253/1
diff --git a/include/osmocom/hnbgw/Makefile.am b/include/osmocom/hnbgw/Makefile.am
index d3fbb07..ebc26ce 100644
--- a/include/osmocom/hnbgw/Makefile.am
+++ b/include/osmocom/hnbgw/Makefile.am
@@ -1,4 +1,5 @@
noinst_HEADERS = \
+ cnlink.h \
context_map.h \
hnbgw.h \
hnbgw_cn.h \
diff --git a/include/osmocom/hnbgw/cnlink.h b/include/osmocom/hnbgw/cnlink.h
new file mode 100644
index 0000000..9495041
--- /dev/null
+++ b/include/osmocom/hnbgw/cnlink.h
@@ -0,0 +1,122 @@
+#pragma once
+
+#include <stdbool.h>
+
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/gsm/gsm48.h>
+
+#include <osmocom/sigtran/sccp_sap.h>
+
+#include <osmocom/ranap/ranap_ies_defs.h>
+
+#include <osmocom/hnbgw/hnbgw_sccp.h>
+
+struct hnbgw_cnpool;
+
+struct hnbgw_cnlink *cnlink_alloc(struct hnbgw_cnpool *cnpool, int nr);
+
+void hnbgw_cnlink_drop_sccp(struct hnbgw_cnlink *cnlink);
+
+bool cnlink_is_conn_ready(const struct hnbgw_cnlink *cnlink);
+void cnlink_rx_reset_cmd(struct hnbgw_cnlink *cnlink);
+void cnlink_rx_reset_ack(struct hnbgw_cnlink *cnlink);
+void cnlink_resend_reset(struct hnbgw_cnlink *cnlink);
+void cnlink_set_disconnected(struct hnbgw_cnlink *cnlink);
+
+const char *cnlink_paging_add_ranap(struct hnbgw_cnlink *cnlink, const RANAP_PagingIEs_t *paging_ies);
+struct hnbgw_cnlink *cnlink_find_by_paging_mi(struct hnbgw_cnpool *cnpool, const struct osmo_mobile_identity *mi);
+
+enum hnbgw_cnlink_ctr {
+ /* TODO: basic counters completely missing
+ * ...
+ */
+ CNLINK_CTR_RANAP_RX_UDT_RESET,
+ CNLINK_CTR_RANAP_RX_UDT_RESET_ACK,
+ CNLINK_CTR_RANAP_RX_UDT_PAGING,
+ CNLINK_CTR_RANAP_RX_UDT_UNKNOWN,
+ CNLINK_CTR_RANAP_RX_UDT_UNSUPPORTED,
+ CNLINK_CTR_RANAP_RX_UDT_OVERLOAD_IND,
+ CNLINK_CTR_RANAP_RX_UDT_ERROR_IND,
+
+ CNLINK_CTR_RANAP_TX_UDT_RESET,
+ CNLINK_CTR_RANAP_TX_UDT_RESET_ACK,
+
+ /* SCCP Counters: */
+ CNLINK_CTR_SCCP_N_UNITDATA_REQ,
+ CNLINK_CTR_SCCP_N_UNITDATA_IND,
+ CNLINK_CTR_SCCP_N_CONNECT_REQ,
+ CNLINK_CTR_SCCP_N_CONNECT_CNF,
+ CNLINK_CTR_SCCP_N_DATA_REQ,
+ CNLINK_CTR_SCCP_N_DATA_IND,
+ CNLINK_CTR_SCCP_N_DISCONNECT_REQ,
+ CNLINK_CTR_SCCP_N_DISCONNECT_IND,
+ CNLINK_CTR_SCCP_N_PCSTATE_IND,
+ CNLINK_CTR_SCCP_RLSD_CN_ORIGIN,
+
+ /* Counters related to link selection from a CN pool. */
+ CNLINK_CTR_CNPOOL_SUBSCR_NEW,
+ CNLINK_CTR_CNPOOL_SUBSCR_REATTACH,
+ CNLINK_CTR_CNPOOL_SUBSCR_KNOWN,
+ CNLINK_CTR_CNPOOL_SUBSCR_PAGED,
+ CNLINK_CTR_CNPOOL_SUBSCR_ATTACH_LOST,
+ CNLINK_CTR_CNPOOL_EMERG_FORWARDED,
+};
+
+/* User provided configuration for struct hnbgw_cnlink. */
+struct hnbgw_cnlink_cfg {
+ /* cs7 address book entry to indicate both the remote point-code of the peer, as well as which cs7 instance to
+ * use. */
+ char *remote_addr_name;
+
+ struct osmo_nri_ranges *nri_ranges;
+};
+
+/* A CN peer, like 'msc 0' or 'sgsn 23' */
+struct hnbgw_cnlink {
+ struct llist_head entry;
+
+ /* backpointer to CS or PS CN pool. */
+ struct hnbgw_cnpool *pool;
+
+ struct osmo_fsm_inst *fi;
+
+ int nr;
+
+ struct hnbgw_cnlink_cfg vty;
+ struct hnbgw_cnlink_cfg use;
+
+ /* To print in logging/VTY */
+ char *name;
+
+ /* Copy of the address book entry use.remote_addr_name. */
+ struct osmo_sccp_addr remote_addr;
+
+ /* The SCCP instance for the cs7 instance indicated by remote_addr_name. (Multiple hnbgw_cnlinks may use the
+ * same hnbgw_sccp_user -- there is exactly one hnbgw_sccp_user per configured cs7 instance.) */
+ struct hnbgw_sccp_user *hnbgw_sccp_user;
+
+ /* linked list of hnbgw_context_map */
+ struct llist_head map_list;
+
+ bool allow_attach;
+ bool allow_emerg;
+ struct llist_head paging;
+
+ struct rate_ctr_group *ctrs;
+};
+
+static inline struct osmo_sccp_instance *cnlink_sccp(const struct hnbgw_cnlink *cnlink)
+{
+ if (!cnlink)
+ return NULL;
+ if (!cnlink->hnbgw_sccp_user)
+ return NULL;
+ if (!cnlink->hnbgw_sccp_user->ss7)
+ return NULL;
+ return osmo_ss7_get_sccp(cnlink->hnbgw_sccp_user->ss7);
+}
+
+#define LOG_CNLINK(CNLINK, SUBSYS, LEVEL, FMT, ARGS...) \
+ LOGP(SUBSYS, LEVEL, "(%s) " FMT, (CNLINK) ? (CNLINK)->name : "null", ##ARGS)
+
+#define CNLINK_CTR_INC(cnlink, x) rate_ctr_inc2((cnlink)->ctrs, x)
diff --git a/include/osmocom/hnbgw/hnbgw.h b/include/osmocom/hnbgw/hnbgw.h
index 3995294..b253d7f 100644
--- a/include/osmocom/hnbgw/hnbgw.h
+++ b/include/osmocom/hnbgw/hnbgw.h
@@ -19,7 +19,8 @@
#include <osmocom/mgcp_client/mgcp_client_pool.h>
#include <osmocom/hnbgw/nft_kpi.h>
-#include <osmocom/hnbgw/hnbgw_sccp.h>
+#include <osmocom/hnbgw/cnlink.h>
+#include <osmocom/hnbgw/hnbgw_cn.h>
#define STORE_UPTIME_INTERVAL 10 /* seconds */
#define HNB_STORE_RAB_DURATIONS_INTERVAL 1 /* seconds */
@@ -202,93 +203,6 @@
struct hnbgw_context_map;
-/* User provided configuration for struct hnbgw_cnpool. */
-struct hnbgw_cnpool_cfg {
- uint8_t nri_bitlen;
- struct osmo_nri_ranges *null_nri_ranges;
-};
-
-/* User provided configuration for struct hnbgw_cnlink. */
-struct hnbgw_cnlink_cfg {
- /* cs7 address book entry to indicate both the remote point-code of the peer, as well as which cs7 instance to
- * use. */
- char *remote_addr_name;
-
- struct osmo_nri_ranges *nri_ranges;
-};
-
-/* Collection of CN peers to distribute UE connections across. MSCs for DOMAIN_CS, SGSNs for DOMAIN_PS. */
-struct hnbgw_cnpool {
- RANAP_CN_DomainIndicator_t domain;
-
- /* CN pool string used in VTY config and logging, "iucs" or "iups". */
- const char *pool_name;
- /* CN peer string used in VTY config and logging, "msc" or "sgsn". */
- const char *peer_name;
- /* What we use as the remote MSC/SGSN point-code if the user does not configure any address. */
- uint32_t default_remote_pc;
-
- struct hnbgw_cnpool_cfg vty;
- struct hnbgw_cnpool_cfg use;
-
- /* List of struct hnbgw_cnlink */
- struct llist_head cnlinks;
-
- unsigned int round_robin_next_nr;
- /* Emergency calls potentially select a different set of MSCs, so to not mess up the normal round-robin
- * behavior, emergency calls need a separate round-robin counter. */
- unsigned int round_robin_next_emerg_nr;
-
- /* rate counter group that child hnbgw_cnlinks should use (points to msc_ctrg_desc or sgsn_ctrg_desc) */
- const struct rate_ctr_group_desc *cnlink_ctrg_desc;
-
- /* Running counters for this pool */
- struct rate_ctr_group *ctrs;
-};
-
-#define CNPOOL_CTR_INC(cnpool, x) rate_ctr_inc2((cnpool)->ctrs, x)
-
-/* A CN peer, like 'msc 0' or 'sgsn 23' */
-struct hnbgw_cnlink {
- struct llist_head entry;
-
- /* backpointer to CS or PS CN pool. */
- struct hnbgw_cnpool *pool;
-
- struct osmo_fsm_inst *fi;
-
- int nr;
-
- struct hnbgw_cnlink_cfg vty;
- struct hnbgw_cnlink_cfg use;
-
- /* To print in logging/VTY */
- char *name;
-
- /* Copy of the address book entry use.remote_addr_name. */
- struct osmo_sccp_addr remote_addr;
-
- /* The SCCP instance for the cs7 instance indicated by remote_addr_name. (Multiple hnbgw_cnlinks may use the
- * same hnbgw_sccp_user -- there is exactly one hnbgw_sccp_user per configured cs7 instance.) */
- struct hnbgw_sccp_user *hnbgw_sccp_user;
-
- /* linked list of hnbgw_context_map */
- struct llist_head map_list;
-
- bool allow_attach;
- bool allow_emerg;
- struct llist_head paging;
-
- struct rate_ctr_group *ctrs;
-};
-
-#define LOG_CNLINK(CNLINK, SUBSYS, LEVEL, FMT, ARGS...) \
- LOGP(SUBSYS, LEVEL, "(%s) " FMT, (CNLINK) ? (CNLINK)->name : "null", ##ARGS)
-
-#define CNLINK_CTR_INC(cnlink, x) rate_ctr_inc2((cnlink)->ctrs, x)
-
-struct hnbgw_cnlink *cnlink_get_nr(struct hnbgw_cnpool *cnpool, int nr, bool create_if_missing);
-
static inline bool cnlink_is_cs(const struct hnbgw_cnlink *cnlink)
{
return cnlink && cnlink->pool->domain == DOMAIN_CS;
@@ -299,17 +213,6 @@
return cnlink && cnlink->pool->domain == DOMAIN_PS;
}
-static inline struct osmo_sccp_instance *cnlink_sccp(const struct hnbgw_cnlink *cnlink)
-{
- if (!cnlink)
- return NULL;
- if (!cnlink->hnbgw_sccp_user)
- return NULL;
- if (!cnlink->hnbgw_sccp_user->ss7)
- return NULL;
- return osmo_ss7_get_sccp(cnlink->hnbgw_sccp_user->ss7);
-}
-
/* The lifecycle of the hnb_context object is the same as its conn */
struct hnb_context {
/*! Entry in HNB-global list of HNB */
diff --git a/include/osmocom/hnbgw/hnbgw_cn.h b/include/osmocom/hnbgw/hnbgw_cn.h
index fc33e5b..d6098b4 100644
--- a/include/osmocom/hnbgw/hnbgw_cn.h
+++ b/include/osmocom/hnbgw/hnbgw_cn.h
@@ -1,31 +1,13 @@
#pragma once
+#include <stdint.h>
#include <osmocom/core/rate_ctr.h>
-#include <osmocom/gsm/gsm48.h>
-#include <osmocom/ranap/ranap_ies_defs.h>
+#include <osmocom/sigtran/sccp_sap.h>
-#include <osmocom/hnbgw/hnbgw.h>
+#include <osmocom/ranap/RANAP_CN-DomainIndicator.h>
-struct hnbgw_cnlink *cnlink_alloc(struct hnbgw_cnpool *cnpool, int nr);
-struct hnbgw_cnlink *hnbgw_cnlink_select(struct hnbgw_context_map *map);
-
-void hnbgw_cnpool_start(struct hnbgw_cnpool *cnpool);
-void hnbgw_cnpool_apply_cfg(struct hnbgw_cnpool *cnpool);
-void hnbgw_cnpool_cnlinks_start_or_restart(struct hnbgw_cnpool *cnpool);
-int hnbgw_cnlink_start_or_restart(struct hnbgw_cnlink *cnlink);
-void hnbgw_cnlink_drop_sccp(struct hnbgw_cnlink *cnlink);
-
-char *cnlink_sccp_addr_to_str(struct hnbgw_cnlink *cnlink, const struct osmo_sccp_addr *addr);
-
-bool cnlink_is_conn_ready(const struct hnbgw_cnlink *cnlink);
-void cnlink_rx_reset_cmd(struct hnbgw_cnlink *cnlink);
-void cnlink_rx_reset_ack(struct hnbgw_cnlink *cnlink);
-void cnlink_resend_reset(struct hnbgw_cnlink *cnlink);
-void cnlink_set_disconnected(struct hnbgw_cnlink *cnlink);
-
-const char *cnlink_paging_add_ranap(struct hnbgw_cnlink *cnlink, const RANAP_PagingIEs_t *paging_ies);
-struct hnbgw_cnlink *cnlink_find_by_paging_mi(struct hnbgw_cnpool *cnpool, const struct osmo_mobile_identity *mi);
+struct hnbgw_context_map;
enum hnbgw_cnpool_ctr {
/* TODO: basic counters completely missing
@@ -37,45 +19,55 @@
CNPOOL_CTR_EMERG_FORWARDED,
CNPOOL_CTR_EMERG_LOST,
};
+#define CNPOOL_CTR_INC(cnpool, x) rate_ctr_inc2((cnpool)->ctrs, x)
+
+/* User provided configuration for struct hnbgw_cnpool. */
+struct hnbgw_cnpool_cfg {
+ uint8_t nri_bitlen;
+ struct osmo_nri_ranges *null_nri_ranges;
+};
+
+/* Collection of CN peers to distribute UE connections across. MSCs for DOMAIN_CS, SGSNs for DOMAIN_PS. */
+struct hnbgw_cnpool {
+ RANAP_CN_DomainIndicator_t domain;
+
+ /* CN pool string used in VTY config and logging, "iucs" or "iups". */
+ const char *pool_name;
+ /* CN peer string used in VTY config and logging, "msc" or "sgsn". */
+ const char *peer_name;
+ /* What we use as the remote MSC/SGSN point-code if the user does not configure any address. */
+ uint32_t default_remote_pc;
+
+ struct hnbgw_cnpool_cfg vty;
+ struct hnbgw_cnpool_cfg use;
+
+ /* List of struct hnbgw_cnlink */
+ struct llist_head cnlinks;
+
+ unsigned int round_robin_next_nr;
+ /* Emergency calls potentially select a different set of MSCs, so to not mess up the normal round-robin
+ * behavior, emergency calls need a separate round-robin counter. */
+ unsigned int round_robin_next_emerg_nr;
+
+ /* rate counter group that child hnbgw_cnlinks should use (points to msc_ctrg_desc or sgsn_ctrg_desc) */
+ const struct rate_ctr_group_desc *cnlink_ctrg_desc;
+
+ /* Running counters for this pool */
+ struct rate_ctr_group *ctrs;
+};
extern const struct rate_ctr_group_desc iucs_ctrg_desc;
extern const struct rate_ctr_group_desc iups_ctrg_desc;
-enum hnbgw_cnlink_ctr {
- /* TODO: basic counters completely missing
- * ...
- */
- CNLINK_CTR_RANAP_RX_UDT_RESET,
- CNLINK_CTR_RANAP_RX_UDT_RESET_ACK,
- CNLINK_CTR_RANAP_RX_UDT_PAGING,
- CNLINK_CTR_RANAP_RX_UDT_UNKNOWN,
- CNLINK_CTR_RANAP_RX_UDT_UNSUPPORTED,
- CNLINK_CTR_RANAP_RX_UDT_OVERLOAD_IND,
- CNLINK_CTR_RANAP_RX_UDT_ERROR_IND,
-
- CNLINK_CTR_RANAP_TX_UDT_RESET,
- CNLINK_CTR_RANAP_TX_UDT_RESET_ACK,
-
- /* SCCP Counters: */
- CNLINK_CTR_SCCP_N_UNITDATA_REQ,
- CNLINK_CTR_SCCP_N_UNITDATA_IND,
- CNLINK_CTR_SCCP_N_CONNECT_REQ,
- CNLINK_CTR_SCCP_N_CONNECT_CNF,
- CNLINK_CTR_SCCP_N_DATA_REQ,
- CNLINK_CTR_SCCP_N_DATA_IND,
- CNLINK_CTR_SCCP_N_DISCONNECT_REQ,
- CNLINK_CTR_SCCP_N_DISCONNECT_IND,
- CNLINK_CTR_SCCP_N_PCSTATE_IND,
- CNLINK_CTR_SCCP_RLSD_CN_ORIGIN,
-
- /* Counters related to link selection from a CN pool. */
- CNLINK_CTR_CNPOOL_SUBSCR_NEW,
- CNLINK_CTR_CNPOOL_SUBSCR_REATTACH,
- CNLINK_CTR_CNPOOL_SUBSCR_KNOWN,
- CNLINK_CTR_CNPOOL_SUBSCR_PAGED,
- CNLINK_CTR_CNPOOL_SUBSCR_ATTACH_LOST,
- CNLINK_CTR_CNPOOL_EMERG_FORWARDED,
-};
-
extern const struct rate_ctr_group_desc msc_ctrg_desc;
extern const struct rate_ctr_group_desc sgsn_ctrg_desc;
+
+struct hnbgw_cnlink *hnbgw_cnlink_select(struct hnbgw_context_map *map);
+
+void hnbgw_cnpool_start(struct hnbgw_cnpool *cnpool);
+void hnbgw_cnpool_cnlinks_start_or_restart(struct hnbgw_cnpool *cnpool);
+struct hnbgw_cnlink *cnlink_get_nr(struct hnbgw_cnpool *cnpool, int nr, bool create_if_missing);
+void hnbgw_cnpool_apply_cfg(struct hnbgw_cnpool *cnpool);
+
+int hnbgw_cnlink_start_or_restart(struct hnbgw_cnlink *cnlink);
+char *cnlink_sccp_addr_to_str(struct hnbgw_cnlink *cnlink, const struct osmo_sccp_addr *addr);
--
To view, visit https://gerrit.osmocom.org/c/osmo-hnbgw/+/40253?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: newchange
Gerrit-Project: osmo-hnbgw
Gerrit-Branch: master
Gerrit-Change-Id: I75988112cff6c8c17d2bdb166a0934934c523dfc
Gerrit-Change-Number: 40253
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
2 months
- 1
- 0
[XL] Change in osmo-hnbgw[master]: Split hnb_context,hnb_persistent,umts_cell_id to their own files
by pespin
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-hnbgw/+/40254?usp=email )
Change subject: Split hnb_context,hnb_persistent,umts_cell_id to their own files
......................................................................
Split hnb_context,hnb_persistent,umts_cell_id to their own files
It's really disturbing having to cope with all HNB related code while
for instance focusing on CN side of things.
Properly split the HNB related code to its own files so it can be left
out easily when needed, or stuff found more easily when required.
It also makes it easier to extend it later.
umts_cell_id is split to its own module since it's needed both in
hnb_context and hnb_persitent, and it's really independent of everything
else in the code.
Change-Id: I4ff65d14f94d99a57316c2483c92244078bb5dd9
---
M include/osmocom/hnbgw/Makefile.am
M include/osmocom/hnbgw/context_map.h
A include/osmocom/hnbgw/hnb.h
A include/osmocom/hnbgw/hnb_persistent.h
M include/osmocom/hnbgw/hnbgw.h
M include/osmocom/hnbgw/hnbgw_hnbap.h
M include/osmocom/hnbgw/hnbgw_rua.h
A include/osmocom/hnbgw/umts_cell_id.h
M src/osmo-hnbgw/Makefile.am
M src/osmo-hnbgw/context_map.c
M src/osmo-hnbgw/context_map_rua.c
M src/osmo-hnbgw/context_map_sccp.c
A src/osmo-hnbgw/hnb.c
A src/osmo-hnbgw/hnb_persistent.c
M src/osmo-hnbgw/hnbgw.c
M src/osmo-hnbgw/hnbgw_hnbap.c
M src/osmo-hnbgw/hnbgw_ranap.c
M src/osmo-hnbgw/hnbgw_rua.c
M src/osmo-hnbgw/hnbgw_vty.c
M src/osmo-hnbgw/kpi_dtap.c
M src/osmo-hnbgw/kpi_ranap.c
M src/osmo-hnbgw/nft_kpi.c
M src/osmo-hnbgw/osmo_hnbgw_main.c
A src/osmo-hnbgw/umts_cell_id.c
M tests/ranap_rab_ass/ranap_rab_ass_test.c
M tests/umts_cell_id/umts_cell_id_test.c
26 files changed, 1,223 insertions(+), 1,006 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-hnbgw refs/changes/54/40254/1
diff --git a/include/osmocom/hnbgw/Makefile.am b/include/osmocom/hnbgw/Makefile.am
index ebc26ce..854be5b 100644
--- a/include/osmocom/hnbgw/Makefile.am
+++ b/include/osmocom/hnbgw/Makefile.am
@@ -1,6 +1,8 @@
noinst_HEADERS = \
cnlink.h \
context_map.h \
+ hnb.h \
+ hnb_persistent.h \
hnbgw.h \
hnbgw_cn.h \
hnbgw_hnbap.h \
diff --git a/include/osmocom/hnbgw/context_map.h b/include/osmocom/hnbgw/context_map.h
index 80b7e2b..a885f5b 100644
--- a/include/osmocom/hnbgw/context_map.h
+++ b/include/osmocom/hnbgw/context_map.h
@@ -3,6 +3,7 @@
#include <stdint.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/utils.h>
+#include <osmocom/hnbgw/hnb.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/gsm/gsm48.h>
diff --git a/include/osmocom/hnbgw/hnb.h b/include/osmocom/hnbgw/hnb.h
new file mode 100644
index 0000000..9c210e6
--- /dev/null
+++ b/include/osmocom/hnbgw/hnb.h
@@ -0,0 +1,76 @@
+#pragma once
+
+#include <osmocom/core/select.h>
+#include <osmocom/core/linuxlist.h>
+#include <osmocom/core/hashtable.h>
+#include <osmocom/core/write_queue.h>
+#include <osmocom/core/timer.h>
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/core/sockaddr_str.h>
+#include <osmocom/gsm/gsm23003.h>
+#include <osmocom/sigtran/osmo_ss7.h>
+#include <osmocom/ctrl/control_if.h>
+#include <osmocom/ranap/RANAP_CN-DomainIndicator.h>
+
+#define DEBUG
+#include <osmocom/core/logging.h>
+
+#include <osmocom/netif/stream.h>
+
+#include <osmocom/mgcp_client/mgcp_client.h>
+#include <osmocom/mgcp_client/mgcp_client_pool.h>
+
+#include <osmocom/hnbgw/umts_cell_id.h>
+#include <osmocom/hnbgw/nft_kpi.h>
+#include <osmocom/hnbgw/cnlink.h>
+#include <osmocom/hnbgw/hnbgw_cn.h>
+
+#define HNB_STORE_RAB_DURATIONS_INTERVAL 1 /* seconds */
+
+#define LOGHNB(HNB_CTX, ss, lvl, fmt, args ...) \
+ LOGP(ss, lvl, "(%s) " fmt, hnb_context_name(HNB_CTX), ## args)
+
+enum hnb_ctrl_node {
+ CTRL_NODE_HNB = _LAST_CTRL_NODE,
+ _LAST_CTRL_NODE_HNB
+};
+
+/* The lifecycle of the hnb_context object is the same as its conn */
+struct hnb_context {
+ /*! Entry in HNB-global list of HNB */
+ struct llist_head list;
+ /*! SCTP socket + write queue for Iuh to this specific HNB */
+ struct osmo_stream_srv *conn;
+ /*! copied from HNB-Identity-Info IE */
+ char identity_info[256];
+ /*! copied from Cell Identity IE */
+ struct umts_cell_id id;
+
+ /*! SCTP stream ID for HNBAP */
+ uint16_t hnbap_stream;
+ /*! SCTP stream ID for RUA */
+ uint16_t rua_stream;
+
+ /*! True if a HNB-REGISTER-REQ from this HNB has been accepted. */
+ bool hnb_registered;
+
+ /* linked list of hnbgw_context_map */
+ struct llist_head map_list;
+
+ /*! pointer to the associated hnb persistent state. Always present after HNB-Register */
+ struct hnb_persistent *persistent;
+};
+
+
+int hnbgw_rua_accept_cb(struct osmo_stream_srv_link *srv, int fd);
+int hnb_ctrl_cmds_install(void);
+int hnb_ctrl_node_lookup(void *data, vector vline, int *node_type, void **node_data, int *i);
+
+struct hnb_context *hnb_context_by_identity_info(const char *identity_info);
+const char *hnb_context_name(struct hnb_context *ctx);
+
+void hnb_context_release(struct hnb_context *ctx);
+void hnb_context_release_ue_state(struct hnb_context *ctx);
+
+unsigned long long hnb_get_updowntime(const struct hnb_context *ctx);
+void hnb_store_rab_durations(struct hnb_context *hnb);
diff --git a/include/osmocom/hnbgw/hnb_persistent.h b/include/osmocom/hnbgw/hnb_persistent.h
new file mode 100644
index 0000000..c4379de
--- /dev/null
+++ b/include/osmocom/hnbgw/hnb_persistent.h
@@ -0,0 +1,181 @@
+#pragma once
+
+#include <osmocom/core/select.h>
+#include <osmocom/core/linuxlist.h>
+#include <osmocom/core/hashtable.h>
+#include <osmocom/core/write_queue.h>
+#include <osmocom/core/timer.h>
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/core/sockaddr_str.h>
+#include <osmocom/gsm/gsm23003.h>
+#include <osmocom/sigtran/osmo_ss7.h>
+#include <osmocom/ctrl/control_if.h>
+#include <osmocom/ranap/RANAP_CN-DomainIndicator.h>
+
+#define DEBUG
+#include <osmocom/core/logging.h>
+
+#include <osmocom/mgcp_client/mgcp_client.h>
+#include <osmocom/mgcp_client/mgcp_client_pool.h>
+
+#include <osmocom/hnbgw/umts_cell_id.h>
+#include <osmocom/hnbgw/nft_kpi.h>
+#include <osmocom/hnbgw/cnlink.h>
+#include <osmocom/hnbgw/hnbgw_cn.h>
+
+#define LOG_HNBP(HNBP, lvl, fmt, args...) \
+ LOGP(DHNB, lvl, "(%s) " fmt, \
+ (HNBP) ? \
+ (((HNBP)->id_str && *(HNBP)->id_str) ? (HNBP)->id_str : "no-cell-id") \
+ : "null", ## args)
+
+
+enum hnb_rate_ctr {
+ HNB_CTR_IUH_ESTABLISHED,
+ HNB_CTR_RANAP_PS_ERR_IND_UL,
+ HNB_CTR_RANAP_CS_ERR_IND_UL,
+ HNB_CTR_RANAP_PS_RESET_REQ_UL,
+ HNB_CTR_RANAP_CS_RESET_REQ_UL,
+
+ HNB_CTR_RANAP_PS_RAB_ACT_REQ,
+ HNB_CTR_RANAP_CS_RAB_ACT_REQ,
+
+ HNB_CTR_RANAP_PS_RAB_ACT_CNF,
+ HNB_CTR_RANAP_CS_RAB_ACT_CNF,
+
+ HNB_CTR_RANAP_PS_RAB_ACT_FAIL,
+ HNB_CTR_RANAP_CS_RAB_ACT_FAIL,
+
+ HNB_CTR_RANAP_PS_RAB_MOD_REQ,
+ HNB_CTR_RANAP_CS_RAB_MOD_REQ,
+
+ HNB_CTR_RANAP_PS_RAB_MOD_CNF,
+ HNB_CTR_RANAP_CS_RAB_MOD_CNF,
+
+ HNB_CTR_RANAP_PS_RAB_MOD_FAIL,
+ HNB_CTR_RANAP_CS_RAB_MOD_FAIL,
+
+ HNB_CTR_RANAP_PS_RAB_REL_REQ,
+ HNB_CTR_RANAP_CS_RAB_REL_REQ,
+ HNB_CTR_RANAP_PS_RAB_REL_REQ_ABNORMAL,
+ HNB_CTR_RANAP_CS_RAB_REL_REQ_ABNORMAL,
+
+ HNB_CTR_RANAP_PS_RAB_REL_CNF,
+ HNB_CTR_RANAP_CS_RAB_REL_CNF,
+
+ HNB_CTR_RANAP_PS_RAB_REL_FAIL,
+ HNB_CTR_RANAP_CS_RAB_REL_FAIL,
+
+ HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT,
+ HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT,
+ HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT_ABNORMAL,
+ HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT_ABNORMAL,
+
+ HNB_CTR_RUA_ERR_IND,
+
+ HNB_CTR_RUA_PS_CONNECT_UL,
+ HNB_CTR_RUA_CS_CONNECT_UL,
+
+ HNB_CTR_RUA_PS_DISCONNECT_UL,
+ HNB_CTR_RUA_CS_DISCONNECT_UL,
+ HNB_CTR_RUA_PS_DISCONNECT_DL,
+ HNB_CTR_RUA_CS_DISCONNECT_DL,
+
+ HNB_CTR_RUA_PS_DT_UL,
+ HNB_CTR_RUA_CS_DT_UL,
+ HNB_CTR_RUA_PS_DT_DL,
+ HNB_CTR_RUA_CS_DT_DL,
+
+ HNB_CTR_RUA_UDT_UL,
+ HNB_CTR_RUA_UDT_DL,
+
+ HNB_CTR_PS_PAGING_ATTEMPTED,
+ HNB_CTR_CS_PAGING_ATTEMPTED,
+
+ HNB_CTR_RAB_ACTIVE_MILLISECONDS_TOTAL,
+
+ HNB_CTR_DTAP_CS_LU_REQ,
+ HNB_CTR_DTAP_CS_LU_ACC,
+ HNB_CTR_DTAP_CS_LU_REJ,
+
+ HNB_CTR_DTAP_PS_ATT_REQ,
+ HNB_CTR_DTAP_PS_ATT_ACK,
+ HNB_CTR_DTAP_PS_ATT_REJ,
+
+ HNB_CTR_DTAP_PS_RAU_REQ,
+ HNB_CTR_DTAP_PS_RAU_ACK,
+ HNB_CTR_DTAP_PS_RAU_REJ,
+
+ HNB_CTR_GTPU_PACKETS_UL,
+ HNB_CTR_GTPU_TOTAL_BYTES_UL,
+ HNB_CTR_GTPU_UE_BYTES_UL,
+ HNB_CTR_GTPU_PACKETS_DL,
+ HNB_CTR_GTPU_TOTAL_BYTES_DL,
+ HNB_CTR_GTPU_UE_BYTES_DL,
+};
+
+enum hnb_stat {
+ HNB_STAT_UPTIME_SECONDS,
+};
+
+#define HNBP_CTR(hnbp, x) rate_ctr_group_get_ctr((hnbp)->ctrs, x)
+#define HNBP_CTR_INC(hnbp, x) rate_ctr_inc(HNBP_CTR(hnbp, x))
+#define HNBP_CTR_ADD(hnbp, x, y) rate_ctr_add2((hnbp)->ctrs, x, y)
+
+#define HNBP_STAT(hbp, x) osmo_stat_item_group_get_item((hnbp)->statg, x)
+#define HNBP_STAT_SET(hnbp, x, val) osmo_stat_item_set(HNBP_STAT(hnbp, x), val)
+
+/* persistent data for one HNB. This continues to exist even as conn / hnb_context is deleted on disconnect */
+struct hnb_persistent {
+ /*! Entry in HNBGW-global list of hnb_persistent */
+ struct llist_head list;
+ /*! Entry in hash table g_hnbgw->hnb_persistent_by_id. */
+ struct hlist_node node_by_id;
+ /*! back-pointer to hnb_context. Can be NULL if no context at this point */
+ struct hnb_context *ctx;
+
+ /*! unique cell identity; copied from HNB REGISTER REQ */
+ struct umts_cell_id id;
+ /*! stringified version of the cell identiy above (for printing/naming) */
+ const char *id_str;
+
+ /*! copied from HNB-Identity-Info IE */
+ time_t updowntime;
+
+ struct rate_ctr_group *ctrs;
+ struct osmo_stat_item_group *statg;
+
+ /* State that the main thread needs in order to know what was requested from the nft worker threads and what
+ * still needs to be requested. */
+ struct {
+ /* Whether a persistent named counter was added in nftables for this cell id. */
+ bool persistent_counter_added;
+
+ /* The last hNodeB GTP-U address we asked the nft maintenance thread to set up.
+ * osmo_sockaddr_str_is_nonzero(addr_remote) == false when no rules were added yet, and when
+ * we asked the nft maintenance thread to remove the rules for this hNodeB because it has
+ * disconnected. */
+ struct osmo_sockaddr_str addr_remote;
+
+ /* the nft handles needed to clean up the UL and DL rules when the hNodeB disconnects,
+ * and the last seen counter value gotten from nft. */
+ struct {
+ struct nft_kpi_handle h;
+ struct nft_kpi_val v;
+ } ul;
+ struct {
+ struct nft_kpi_handle h;
+ struct nft_kpi_val v;
+ } dl;
+ } nft_kpi;
+
+ struct osmo_timer_list disconnected_timeout;
+};
+
+struct hnb_persistent *hnb_persistent_alloc(const struct umts_cell_id *id);
+struct hnb_persistent *hnb_persistent_find_by_id(const struct umts_cell_id *id);
+void hnb_persistent_registered(struct hnb_persistent *hnbp);
+void hnb_persistent_deregistered(struct hnb_persistent *hnbp);
+void hnb_persistent_free(struct hnb_persistent *hnbp);
+
+unsigned long long hnbp_get_updowntime(const struct hnb_persistent *hnbp);
diff --git a/include/osmocom/hnbgw/hnbgw.h b/include/osmocom/hnbgw/hnbgw.h
index b253d7f..eb9c61c 100644
--- a/include/osmocom/hnbgw/hnbgw.h
+++ b/include/osmocom/hnbgw/hnbgw.h
@@ -23,7 +23,6 @@
#include <osmocom/hnbgw/hnbgw_cn.h>
#define STORE_UPTIME_INTERVAL 10 /* seconds */
-#define HNB_STORE_RAB_DURATIONS_INTERVAL 1 /* seconds */
enum {
DMAIN,
@@ -39,15 +38,6 @@
extern const struct log_info hnbgw_log_info;
extern struct vty_app_info hnbgw_vty_info;
-#define LOGHNB(HNB_CTX, ss, lvl, fmt, args ...) \
- LOGP(ss, lvl, "(%s) " fmt, hnb_context_name(HNB_CTX), ## args)
-
-#define LOG_HNBP(HNBP, lvl, fmt, args...) \
- LOGP(DHNB, lvl, "(%s) " fmt, \
- (HNBP) ? \
- (((HNBP)->id_str && *(HNBP)->id_str) ? (HNBP)->id_str : "no-cell-id") \
- : "null", ## args)
-
#define DOMAIN_CS RANAP_CN_DomainIndicator_cs_domain
#define DOMAIN_PS RANAP_CN_DomainIndicator_ps_domain
@@ -57,11 +47,6 @@
return get_value_string(ranap_domain_names, domain);
}
-enum hnb_ctrl_node {
- CTRL_NODE_HNB = _LAST_CTRL_NODE,
- _LAST_CTRL_NODE_HNB
-};
-
#define HNBGW_LOCAL_IP_DEFAULT "0.0.0.0"
/* TODO: CS and PS now both connect to OsmoSTP, i.e. that's always going to be the same address. Drop the
* duplicity. */
@@ -84,123 +69,6 @@
#define IUH_MSGB_SIZE 2048
-enum hnb_rate_ctr {
- HNB_CTR_IUH_ESTABLISHED,
- HNB_CTR_RANAP_PS_ERR_IND_UL,
- HNB_CTR_RANAP_CS_ERR_IND_UL,
- HNB_CTR_RANAP_PS_RESET_REQ_UL,
- HNB_CTR_RANAP_CS_RESET_REQ_UL,
-
- HNB_CTR_RANAP_PS_RAB_ACT_REQ,
- HNB_CTR_RANAP_CS_RAB_ACT_REQ,
-
- HNB_CTR_RANAP_PS_RAB_ACT_CNF,
- HNB_CTR_RANAP_CS_RAB_ACT_CNF,
-
- HNB_CTR_RANAP_PS_RAB_ACT_FAIL,
- HNB_CTR_RANAP_CS_RAB_ACT_FAIL,
-
- HNB_CTR_RANAP_PS_RAB_MOD_REQ,
- HNB_CTR_RANAP_CS_RAB_MOD_REQ,
-
- HNB_CTR_RANAP_PS_RAB_MOD_CNF,
- HNB_CTR_RANAP_CS_RAB_MOD_CNF,
-
- HNB_CTR_RANAP_PS_RAB_MOD_FAIL,
- HNB_CTR_RANAP_CS_RAB_MOD_FAIL,
-
- HNB_CTR_RANAP_PS_RAB_REL_REQ,
- HNB_CTR_RANAP_CS_RAB_REL_REQ,
- HNB_CTR_RANAP_PS_RAB_REL_REQ_ABNORMAL,
- HNB_CTR_RANAP_CS_RAB_REL_REQ_ABNORMAL,
-
- HNB_CTR_RANAP_PS_RAB_REL_CNF,
- HNB_CTR_RANAP_CS_RAB_REL_CNF,
-
- HNB_CTR_RANAP_PS_RAB_REL_FAIL,
- HNB_CTR_RANAP_CS_RAB_REL_FAIL,
-
- HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT,
- HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT,
- HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT_ABNORMAL,
- HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT_ABNORMAL,
-
- HNB_CTR_RUA_ERR_IND,
-
- HNB_CTR_RUA_PS_CONNECT_UL,
- HNB_CTR_RUA_CS_CONNECT_UL,
-
- HNB_CTR_RUA_PS_DISCONNECT_UL,
- HNB_CTR_RUA_CS_DISCONNECT_UL,
- HNB_CTR_RUA_PS_DISCONNECT_DL,
- HNB_CTR_RUA_CS_DISCONNECT_DL,
-
- HNB_CTR_RUA_PS_DT_UL,
- HNB_CTR_RUA_CS_DT_UL,
- HNB_CTR_RUA_PS_DT_DL,
- HNB_CTR_RUA_CS_DT_DL,
-
- HNB_CTR_RUA_UDT_UL,
- HNB_CTR_RUA_UDT_DL,
-
- HNB_CTR_PS_PAGING_ATTEMPTED,
- HNB_CTR_CS_PAGING_ATTEMPTED,
-
- HNB_CTR_RAB_ACTIVE_MILLISECONDS_TOTAL,
-
- HNB_CTR_DTAP_CS_LU_REQ,
- HNB_CTR_DTAP_CS_LU_ACC,
- HNB_CTR_DTAP_CS_LU_REJ,
-
- HNB_CTR_DTAP_PS_ATT_REQ,
- HNB_CTR_DTAP_PS_ATT_ACK,
- HNB_CTR_DTAP_PS_ATT_REJ,
-
- HNB_CTR_DTAP_PS_RAU_REQ,
- HNB_CTR_DTAP_PS_RAU_ACK,
- HNB_CTR_DTAP_PS_RAU_REJ,
-
- HNB_CTR_GTPU_PACKETS_UL,
- HNB_CTR_GTPU_TOTAL_BYTES_UL,
- HNB_CTR_GTPU_UE_BYTES_UL,
- HNB_CTR_GTPU_PACKETS_DL,
- HNB_CTR_GTPU_TOTAL_BYTES_DL,
- HNB_CTR_GTPU_UE_BYTES_DL,
-};
-
-enum hnb_stat {
- HNB_STAT_UPTIME_SECONDS,
-};
-
-struct umts_cell_id {
- struct osmo_plmn_id plmn; /*!< Mobile Country Code and Mobile Network Code (000-00 to 999-999) */
- uint16_t lac; /*!< Locaton Area Code (1-65534) */
- uint8_t rac; /*!< Routing Area Code (0-255) */
- uint16_t sac; /*!< Service Area Code */
- uint32_t cid; /*!< Cell ID */
-};
-int umts_cell_id_to_str_buf(char *buf, size_t buflen, const struct umts_cell_id *ucid);
-char *umts_cell_id_to_str_c(void *ctx, const struct umts_cell_id *ucid);
-const char *umts_cell_id_to_str(const struct umts_cell_id *ucid);
-int umts_cell_id_from_str(struct umts_cell_id *ucid, const char *instr);
-uint32_t umts_cell_id_hash(const struct umts_cell_id *ucid);
-
-/*! are both given umts_cell_id euqal? */
-static inline bool umts_cell_id_equal(const struct umts_cell_id *a, const struct umts_cell_id *b)
-{
- if (osmo_plmn_cmp(&a->plmn, &b->plmn))
- return false;
- if (a->lac != b->lac)
- return false;
- if (a->rac != b->rac)
- return false;
- if (a->sac != b->sac)
- return false;
- if (a->cid != b->cid)
- return false;
- return true;
-}
-
struct hnbgw_context_map;
static inline bool cnlink_is_cs(const struct hnbgw_cnlink *cnlink)
@@ -213,86 +81,6 @@
return cnlink && cnlink->pool->domain == DOMAIN_PS;
}
-/* The lifecycle of the hnb_context object is the same as its conn */
-struct hnb_context {
- /*! Entry in HNB-global list of HNB */
- struct llist_head list;
- /*! SCTP socket + write queue for Iuh to this specific HNB */
- struct osmo_stream_srv *conn;
- /*! copied from HNB-Identity-Info IE */
- char identity_info[256];
- /*! copied from Cell Identity IE */
- struct umts_cell_id id;
-
- /*! SCTP stream ID for HNBAP */
- uint16_t hnbap_stream;
- /*! SCTP stream ID for RUA */
- uint16_t rua_stream;
-
- /*! True if a HNB-REGISTER-REQ from this HNB has been accepted. */
- bool hnb_registered;
-
- /* linked list of hnbgw_context_map */
- struct llist_head map_list;
-
- /*! pointer to the associated hnb persistent state. Always present after HNB-Register */
- struct hnb_persistent *persistent;
-};
-
-#define HNBP_CTR(hnbp, x) rate_ctr_group_get_ctr((hnbp)->ctrs, x)
-#define HNBP_CTR_INC(hnbp, x) rate_ctr_inc(HNBP_CTR(hnbp, x))
-#define HNBP_CTR_ADD(hnbp, x, y) rate_ctr_add2((hnbp)->ctrs, x, y)
-
-#define HNBP_STAT(hbp, x) osmo_stat_item_group_get_item((hnbp)->statg, x)
-#define HNBP_STAT_SET(hnbp, x, val) osmo_stat_item_set(HNBP_STAT(hnbp, x), val)
-
-/* persistent data for one HNB. This continues to exist even as conn / hnb_context is deleted on disconnect */
-struct hnb_persistent {
- /*! Entry in HNBGW-global list of hnb_persistent */
- struct llist_head list;
- /*! Entry in hash table g_hnbgw->hnb_persistent_by_id. */
- struct hlist_node node_by_id;
- /*! back-pointer to hnb_context. Can be NULL if no context at this point */
- struct hnb_context *ctx;
-
- /*! unique cell identity; copied from HNB REGISTER REQ */
- struct umts_cell_id id;
- /*! stringified version of the cell identiy above (for printing/naming) */
- const char *id_str;
-
- /*! copied from HNB-Identity-Info IE */
- time_t updowntime;
-
- struct rate_ctr_group *ctrs;
- struct osmo_stat_item_group *statg;
-
- /* State that the main thread needs in order to know what was requested from the nft worker threads and what
- * still needs to be requested. */
- struct {
- /* Whether a persistent named counter was added in nftables for this cell id. */
- bool persistent_counter_added;
-
- /* The last hNodeB GTP-U address we asked the nft maintenance thread to set up.
- * osmo_sockaddr_str_is_nonzero(addr_remote) == false when no rules were added yet, and when
- * we asked the nft maintenance thread to remove the rules for this hNodeB because it has
- * disconnected. */
- struct osmo_sockaddr_str addr_remote;
-
- /* the nft handles needed to clean up the UL and DL rules when the hNodeB disconnects,
- * and the last seen counter value gotten from nft. */
- struct {
- struct nft_kpi_handle h;
- struct nft_kpi_val v;
- } ul;
- struct {
- struct nft_kpi_handle h;
- struct nft_kpi_val v;
- } dl;
- } nft_kpi;
-
- struct osmo_timer_list disconnected_timeout;
-};
-
struct hnbgw {
struct {
const char *iuh_local_ip;
@@ -375,22 +163,8 @@
void g_hnbgw_alloc(void *ctx);
int hnbgw_rua_accept_cb(struct osmo_stream_srv_link *srv, int fd);
-int hnb_ctrl_cmds_install(void);
-int hnb_ctrl_node_lookup(void *data, vector vline, int *node_type, void **node_data, int *i);
int hnbgw_mgw_setup(void);
-struct hnb_context *hnb_context_by_identity_info(const char *identity_info);
-const char *hnb_context_name(struct hnb_context *ctx);
-
-void hnb_context_release(struct hnb_context *ctx);
-void hnb_context_release_ue_state(struct hnb_context *ctx);
-
-struct hnb_persistent *hnb_persistent_alloc(const struct umts_cell_id *id);
-struct hnb_persistent *hnb_persistent_find_by_id(const struct umts_cell_id *id);
-void hnb_persistent_registered(struct hnb_persistent *hnbp);
-void hnb_persistent_deregistered(struct hnb_persistent *hnbp);
-void hnb_persistent_free(struct hnb_persistent *hnbp);
-
void hnbgw_vty_init(void);
int hnbgw_vty_go_parent(struct vty *vty);
@@ -408,6 +182,4 @@
int hnbgw_peek_l3_ul(struct hnbgw_context_map *map, struct msgb *ranap_msg);
-unsigned long long hnb_get_updowntime(const struct hnb_context *ctx);
-
uint32_t get_next_ue_ctx_id(void);
diff --git a/include/osmocom/hnbgw/hnbgw_hnbap.h b/include/osmocom/hnbgw/hnbgw_hnbap.h
index 2f0c5b4..a78657e 100644
--- a/include/osmocom/hnbgw/hnbgw_hnbap.h
+++ b/include/osmocom/hnbgw/hnbgw_hnbap.h
@@ -3,5 +3,7 @@
#include <osmocom/hnbgw/hnbgw.h>
+struct hnb_context;
+
int hnbgw_hnbap_rx(struct hnb_context *hnb, struct msgb *msg);
int hnbgw_hnbap_init(void);
diff --git a/include/osmocom/hnbgw/hnbgw_rua.h b/include/osmocom/hnbgw/hnbgw_rua.h
index 2b74be9..583756d 100644
--- a/include/osmocom/hnbgw/hnbgw_rua.h
+++ b/include/osmocom/hnbgw/hnbgw_rua.h
@@ -4,6 +4,8 @@
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/rua/RUA_Cause.h>
+struct hnb_context;
+
int hnbgw_rua_rx(struct hnb_context *hnb, struct msgb *msg);
int rua_tx_udt(struct hnb_context *hnb, const uint8_t *data, unsigned int len);
diff --git a/include/osmocom/hnbgw/umts_cell_id.h b/include/osmocom/hnbgw/umts_cell_id.h
new file mode 100644
index 0000000..5bab1fc
--- /dev/null
+++ b/include/osmocom/hnbgw/umts_cell_id.h
@@ -0,0 +1,34 @@
+#pragma once
+
+#include <stdint.h>
+#include <unistd.h>
+#include <osmocom/gsm/gsm23003.h>
+
+struct umts_cell_id {
+ struct osmo_plmn_id plmn; /*!< Mobile Country Code and Mobile Network Code (000-00 to 999-999) */
+ uint16_t lac; /*!< Locaton Area Code (1-65534) */
+ uint8_t rac; /*!< Routing Area Code (0-255) */
+ uint16_t sac; /*!< Service Area Code */
+ uint32_t cid; /*!< Cell ID */
+};
+int umts_cell_id_to_str_buf(char *buf, size_t buflen, const struct umts_cell_id *ucid);
+char *umts_cell_id_to_str_c(void *ctx, const struct umts_cell_id *ucid);
+const char *umts_cell_id_to_str(const struct umts_cell_id *ucid);
+int umts_cell_id_from_str(struct umts_cell_id *ucid, const char *instr);
+uint32_t umts_cell_id_hash(const struct umts_cell_id *ucid);
+
+/*! are both given umts_cell_id euqal? */
+static inline bool umts_cell_id_equal(const struct umts_cell_id *a, const struct umts_cell_id *b)
+{
+ if (osmo_plmn_cmp(&a->plmn, &b->plmn))
+ return false;
+ if (a->lac != b->lac)
+ return false;
+ if (a->rac != b->rac)
+ return false;
+ if (a->sac != b->sac)
+ return false;
+ if (a->cid != b->cid)
+ return false;
+ return true;
+}
diff --git a/src/osmo-hnbgw/Makefile.am b/src/osmo-hnbgw/Makefile.am
index df2bb23..c0798a7 100644
--- a/src/osmo-hnbgw/Makefile.am
+++ b/src/osmo-hnbgw/Makefile.am
@@ -32,6 +32,8 @@
$(NULL)
libhnbgw_la_SOURCES = \
+ hnb.c \
+ hnb_persistent.c \
hnbgw.c \
hnbgw_hnbap.c \
hnbgw_l3.c \
@@ -50,6 +52,7 @@
kpi_dtap.c \
kpi_ranap.c \
tdefs.c \
+ umts_cell_id.c \
nft_kpi.c \
$(NULL)
diff --git a/src/osmo-hnbgw/context_map.c b/src/osmo-hnbgw/context_map.c
index 5a6d79b..cc68ec6 100644
--- a/src/osmo-hnbgw/context_map.c
+++ b/src/osmo-hnbgw/context_map.c
@@ -30,6 +30,7 @@
#include <osmocom/sigtran/sccp_helpers.h>
+#include <osmocom/hnbgw/hnb.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
#include <osmocom/hnbgw/context_map.h>
#include <osmocom/hnbgw/mgw_fsm.h>
diff --git a/src/osmo-hnbgw/context_map_rua.c b/src/osmo-hnbgw/context_map_rua.c
index e84ce65..6315985 100644
--- a/src/osmo-hnbgw/context_map_rua.c
+++ b/src/osmo-hnbgw/context_map_rua.c
@@ -24,6 +24,7 @@
#include <osmocom/core/utils.h>
#include <osmocom/core/fsm.h>
+#include <osmocom/hnbgw/hnb.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/context_map.h>
#include <osmocom/hnbgw/tdefs.h>
diff --git a/src/osmo-hnbgw/context_map_sccp.c b/src/osmo-hnbgw/context_map_sccp.c
index 5b5e77f..f060ad9 100644
--- a/src/osmo-hnbgw/context_map_sccp.c
+++ b/src/osmo-hnbgw/context_map_sccp.c
@@ -27,6 +27,7 @@
#include <osmocom/sigtran/sccp_helpers.h>
+#include <osmocom/hnbgw/hnb.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
#include <osmocom/hnbgw/context_map.h>
#include <osmocom/hnbgw/hnbgw_ranap.h>
diff --git a/src/osmo-hnbgw/hnb.c b/src/osmo-hnbgw/hnb.c
new file mode 100644
index 0000000..9938092
--- /dev/null
+++ b/src/osmo-hnbgw/hnb.c
@@ -0,0 +1,401 @@
+/* HNB related code */
+
+/* (C) 2015,2024 by Harald Welte <laforge(a)gnumonks.org>
+ * (C) 2016-2025 by sysmocom s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved
+ *
+ * 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 Affero 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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "config.h"
+
+#include <inttypes.h>
+
+#include <netinet/in.h>
+#include <netinet/sctp.h>
+
+#include <osmocom/core/stats.h>
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/core/stat_item.h>
+
+#include <osmocom/gsm/gsm23236.h>
+
+#include <osmocom/netif/stream.h>
+
+#include <osmocom/hnbgw/umts_cell_id.h>
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
+#include <osmocom/hnbgw/hnbgw.h>
+#include <osmocom/hnbgw/hnbgw_hnbap.h>
+#include <osmocom/hnbgw/hnbgw_rua.h>
+#include <osmocom/hnbgw/tdefs.h>
+#include <osmocom/hnbgw/context_map.h>
+#include <osmocom/hnbgw/mgw_fsm.h>
+
+/* update the active RAB duration rate_ctr for given HNB */
+void hnb_store_rab_durations(struct hnb_context *hnb)
+{
+ struct hnbgw_context_map *map;
+ struct timespec now;
+ uint64_t elapsed_cs_rab_ms = 0;
+
+ osmo_clock_gettime(CLOCK_MONOTONIC, &now);
+
+ /* iterate over all context_maps (subscribers) */
+ llist_for_each_entry(map, &hnb->map_list, hnb_list) {
+ /* skip any PS maps, we care about CS RABs only here */
+ if (map->is_ps)
+ continue;
+ elapsed_cs_rab_ms += mgw_fsm_get_elapsed_ms(map, &now);
+ }
+
+ /* Export to rate countes. */
+ rate_ctr_add(HNBP_CTR(hnb->persistent, HNB_CTR_RAB_ACTIVE_MILLISECONDS_TOTAL), elapsed_cs_rab_ms);
+}
+
+/***********************************************************************
+ * HNB Context
+ ***********************************************************************/
+
+/* look-up HNB context by id. Used from CTRL */
+static struct hnb_context *hnb_context_by_id(uint32_t cid)
+{
+ struct hnb_context *hnb;
+
+ llist_for_each_entry(hnb, &g_hnbgw->hnb_list, list) {
+ if (hnb->id.cid == cid)
+ return hnb;
+ }
+
+ return NULL;
+}
+
+/* look-up HNB context by identity_info. Used from VTY */
+struct hnb_context *hnb_context_by_identity_info(const char *identity_info)
+{
+ struct hnb_context *hnb;
+
+ llist_for_each_entry(hnb, &g_hnbgw->hnb_list, list) {
+ if (strcmp(identity_info, hnb->identity_info) == 0)
+ return hnb;
+ }
+
+ return NULL;
+}
+
+static int hnb_read_cb(struct osmo_stream_srv *conn);
+static int hnb_closed_cb(struct osmo_stream_srv *conn);
+
+static struct hnb_context *hnb_context_alloc(struct osmo_stream_srv_link *link, int new_fd)
+{
+ struct hnb_context *ctx;
+
+ ctx = talloc_zero(g_hnbgw, struct hnb_context);
+ if (!ctx)
+ return NULL;
+ INIT_LLIST_HEAD(&ctx->map_list);
+
+ ctx->conn = osmo_stream_srv_create(g_hnbgw, link, new_fd, hnb_read_cb, hnb_closed_cb, ctx);
+ if (!ctx->conn) {
+ LOGP(DMAIN, LOGL_INFO, "error while creating connection\n");
+ talloc_free(ctx);
+ return NULL;
+ }
+
+ llist_add_tail(&ctx->list, &g_hnbgw->hnb_list);
+ return ctx;
+}
+
+const char *hnb_context_name(struct hnb_context *ctx)
+{
+ char *result;
+ if (!ctx)
+ return "NULL";
+
+ if (ctx->conn) {
+ char hostbuf_r[INET6_ADDRSTRLEN];
+ char portbuf_r[6];
+ int fd = osmo_stream_srv_get_ofd(ctx->conn)->fd;
+
+ /* get remote addr */
+ if (osmo_sock_get_ip_and_port(fd, hostbuf_r, sizeof(hostbuf_r), portbuf_r, sizeof(portbuf_r), false) == 0)
+ result = talloc_asprintf(OTC_SELECT, "%s:%s", hostbuf_r, portbuf_r);
+ else
+ result = "?";
+ } else {
+ result = "disconnected";
+ }
+
+ if (g_hnbgw->config.log_prefix_hnb_id)
+ result = talloc_asprintf(OTC_SELECT, "%s %s", result, ctx->identity_info);
+ else
+ result = talloc_asprintf(OTC_SELECT, "%s %s", result, umts_cell_id_to_str(&ctx->id));
+ return result;
+}
+
+void hnb_context_release_ue_state(struct hnb_context *ctx)
+{
+ struct hnbgw_context_map *map, *map2;
+
+ /* deactivate all context maps */
+ llist_for_each_entry_safe(map, map2, &ctx->map_list, hnb_list) {
+ context_map_hnb_released(map);
+ /* hnbgw_context_map will remove itself from lists when it is ready. */
+ }
+}
+
+void hnb_context_release(struct hnb_context *ctx)
+{
+ struct hnbgw_context_map *map;
+
+ LOGHNB(ctx, DMAIN, LOGL_INFO, "Releasing HNB context\n");
+
+ if (ctx->persistent) {
+ struct timespec tp;
+ int rc;
+ rc = osmo_clock_gettime(CLOCK_MONOTONIC, &tp);
+ ctx->persistent->updowntime = (rc < 0) ? 0 : tp.tv_sec;
+ }
+
+ /* remove from the list of HNB contexts */
+ llist_del(&ctx->list);
+
+ hnb_context_release_ue_state(ctx);
+
+ if (ctx->conn) { /* we own a conn, we must free it: */
+ LOGHNB(ctx, DMAIN, LOGL_INFO, "Closing HNB SCTP connection %s\n",
+ osmo_sock_get_name2(osmo_stream_srv_get_ofd(ctx->conn)->fd));
+ /* Avoid our closed_cb calling hnb_context_release() again: */
+ osmo_stream_srv_set_data(ctx->conn, NULL);
+ osmo_stream_srv_destroy(ctx->conn);
+ } /* else: we are called from closed_cb, so conn is being freed separately */
+
+ /* hnbgw_context_map are still listed in ctx->map_list, but we are freeing ctx. Remove all entries from the
+ * list, but keep the hnbgw_context_map around for graceful release. They are also listed under
+ * hnbgw_cnlink->map_list, and will remove themselves when ready. */
+ while ((map = llist_first_entry_or_null(&ctx->map_list, struct hnbgw_context_map, hnb_list))) {
+ llist_del(&map->hnb_list);
+ map->hnb_ctx = NULL;
+ }
+
+ /* remove back reference from hnb_persistent to context */
+ if (ctx->persistent)
+ hnb_persistent_deregistered(ctx->persistent);
+
+ talloc_free(ctx);
+}
+
+unsigned long long hnb_get_updowntime(const struct hnb_context *ctx)
+{
+ if (!ctx->persistent)
+ return 0;
+ return hnbp_get_updowntime(ctx->persistent);
+}
+
+/***********************************************************************
+ * SCTP Socket / stream handling
+ ***********************************************************************/
+
+static int hnb_read_cb(struct osmo_stream_srv *conn)
+{
+ struct hnb_context *hnb = osmo_stream_srv_get_data(conn);
+ struct osmo_fd *ofd = osmo_stream_srv_get_ofd(conn);
+ struct msgb *msg = msgb_alloc(IUH_MSGB_SIZE, "Iuh rx");
+ int rc;
+
+ if (!msg)
+ return -ENOMEM;
+
+ OSMO_ASSERT(hnb);
+ /* we store a reference to the HomeNodeB in the msg->dest for the
+ * benefit of various downstream processing functions */
+ msg->dst = hnb;
+
+ rc = osmo_stream_srv_recv(conn, msg);
+ /* Notification received */
+ if (msgb_sctp_msg_flags(msg) & OSMO_STREAM_SCTP_MSG_FLAGS_NOTIFICATION) {
+ union sctp_notification *notif = (union sctp_notification *)msgb_data(msg);
+ rc = 0;
+ switch (notif->sn_header.sn_type) {
+ case SCTP_ASSOC_CHANGE:
+ switch (notif->sn_assoc_change.sac_state) {
+ case SCTP_COMM_LOST:
+ LOGHNB(hnb, DMAIN, LOGL_NOTICE,
+ "sctp_recvmsg(%s) = SCTP_COMM_LOST, closing conn\n",
+ osmo_sock_get_name2(ofd->fd));
+ osmo_stream_srv_destroy(conn);
+ rc = -EBADF;
+ break;
+ case SCTP_RESTART:
+ LOGHNB(hnb, DMAIN, LOGL_NOTICE, "HNB SCTP conn RESTARTed, marking as HNBAP-unregistered\n");
+ hnb->hnb_registered = false;
+ hnb_context_release_ue_state(hnb);
+ /* The tx queue may be quite full after an SCTP RESTART: (SYS#6113)
+ * The link may have been flaky (a possible reason for the peer restarting the conn) and
+ * hence the kernel socket Tx queue may be full (no ACKs coming back) and our own userspace
+ * queue may contain plenty of oldish messages to be sent. Since the HNB will re-register after
+ * this, we simply drop all those old messages: */
+ osmo_stream_srv_clear_tx_queue(conn);
+ break;
+ }
+ break;
+ case SCTP_SHUTDOWN_EVENT:
+ LOGHNB(hnb, DMAIN, LOGL_NOTICE,
+ "sctp_recvmsg(%s) = SCTP_SHUTDOWN_EVENT, closing conn\n",
+ osmo_sock_get_name2(ofd->fd));
+ osmo_stream_srv_destroy(conn);
+ rc = -EBADF;
+ break;
+ }
+ goto out;
+ } else if (rc == -EAGAIN) {
+ /* Older versions of osmo_stream_srv_recv() not supporting
+ * msgb_sctp_msg_flags() may still return -EAGAIN when an sctp
+ * notification is received. */
+ rc = 0;
+ goto out;
+ } else if (rc < 0) {
+ LOGHNB(hnb, DMAIN, LOGL_ERROR, "Error during sctp_recvmsg(%s)\n",
+ osmo_sock_get_name2(ofd->fd));
+ osmo_stream_srv_destroy(conn);
+ rc = -EBADF;
+ goto out;
+ } else if (rc == 0) {
+ LOGHNB(hnb, DMAIN, LOGL_NOTICE, "Connection closed sctp_recvmsg(%s) = 0\n",
+ osmo_sock_get_name2(ofd->fd));
+ osmo_stream_srv_destroy(conn);
+ rc = -EBADF;
+ goto out;
+ } else {
+ msgb_put(msg, rc);
+ }
+
+ switch (msgb_sctp_ppid(msg)) {
+ case IUH_PPI_HNBAP:
+ hnb->hnbap_stream = msgb_sctp_stream(msg);
+ rc = hnbgw_hnbap_rx(hnb, msg);
+ break;
+ case IUH_PPI_RUA:
+ if (!hnb->hnb_registered) {
+ LOGHNB(hnb, DMAIN, LOGL_NOTICE, "Discarding RUA as HNB is not registered\n");
+ goto out;
+ }
+ hnb->rua_stream = msgb_sctp_stream(msg);
+ rc = hnbgw_rua_rx(hnb, msg);
+ break;
+ case IUH_PPI_SABP:
+ case IUH_PPI_RNA:
+ case IUH_PPI_PUA:
+ LOGHNB(hnb, DMAIN, LOGL_ERROR, "Unimplemented SCTP PPID=%lu received\n", msgb_sctp_ppid(msg));
+ rc = 0;
+ break;
+ default:
+ LOGHNB(hnb, DMAIN, LOGL_ERROR, "Unknown SCTP PPID=%lu received\n", msgb_sctp_ppid(msg));
+ rc = 0;
+ break;
+ }
+
+out:
+ msgb_free(msg);
+ return rc;
+}
+
+static int hnb_closed_cb(struct osmo_stream_srv *conn)
+{
+ struct hnb_context *hnb = osmo_stream_srv_get_data(conn);
+ if (!hnb)
+ return 0; /* hnb_context is being freed, nothing do be done */
+
+ /* hnb: conn became broken, let's release the associated hnb.
+ * conn object is being freed after closed_cb(), so unassign it from hnb
+ * if available to avoid it freeing it again: */
+ hnb->conn = NULL;
+ hnb_context_release(hnb);
+
+ return 0;
+}
+
+/*! call-back when the listen FD has something to read */
+int hnbgw_rua_accept_cb(struct osmo_stream_srv_link *srv, int fd)
+{
+ struct hnb_context *ctx;
+
+ LOGP(DMAIN, LOGL_INFO, "New HNB SCTP connection %s\n",
+ osmo_sock_get_name2(fd));
+
+ ctx = hnb_context_alloc(srv, fd);
+ if (!ctx)
+ return -ENOMEM;
+
+ return 0;
+}
+
+CTRL_CMD_DEFINE_RO(hnb_info, "info");
+static int get_hnb_info(struct ctrl_cmd *cmd, void *data)
+{
+ struct hnb_context *hnb = data;
+
+ cmd->reply = talloc_strdup(cmd, hnb->identity_info);
+
+ return CTRL_CMD_REPLY;
+}
+
+CTRL_CMD_DEFINE_RO(hnbs, "num-hnb");
+static int get_hnbs(struct ctrl_cmd *cmd, void *data)
+{
+ cmd->reply = talloc_asprintf(cmd, "%u", llist_count(&g_hnbgw->hnb_list));
+
+ return CTRL_CMD_REPLY;
+}
+
+int hnb_ctrl_cmds_install(void)
+{
+ int rc = 0;
+
+ rc |= ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_hnbs);
+ rc |= ctrl_cmd_install(CTRL_NODE_HNB, &cmd_hnb_info);
+
+ return rc;
+}
+
+int hnb_ctrl_node_lookup(void *data, vector vline, int *node_type, void **node_data, int *i)
+{
+ const char *token = vector_slot(vline, *i);
+ struct hnb_context *hnb;
+ long num;
+
+ switch (*node_type) {
+ case CTRL_NODE_ROOT:
+ if (strcmp(token, "hnb") != 0)
+ return 0;
+
+ (*i)++;
+
+ if (!ctrl_parse_get_num(vline, *i, &num))
+ return -ERANGE;
+
+ hnb = hnb_context_by_id(num);
+ if (!hnb)
+ return -ENODEV;
+
+ *node_data = hnb;
+ *node_type = CTRL_NODE_HNB;
+ break;
+ default:
+ return 0;
+ }
+
+ return 1;
+}
diff --git a/src/osmo-hnbgw/hnb_persistent.c b/src/osmo-hnbgw/hnb_persistent.c
new file mode 100644
index 0000000..bcd6c4b
--- /dev/null
+++ b/src/osmo-hnbgw/hnb_persistent.c
@@ -0,0 +1,379 @@
+/* HNB persistent related code */
+
+/* (C) 2015,2024 by Harald Welte <laforge(a)gnumonks.org>
+ * (C) 2016-2025 by sysmocom s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved
+ *
+ * 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 Affero 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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "config.h"
+
+#include <inttypes.h>
+
+#include <netinet/in.h>
+#include <netinet/sctp.h>
+
+#include <osmocom/core/stats.h>
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/core/stat_item.h>
+#include <osmocom/core/jhash.h>
+
+#include <osmocom/gsm/gsm23236.h>
+
+#include <osmocom/netif/stream.h>
+
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
+#include <osmocom/hnbgw/hnbgw.h>
+#include <osmocom/hnbgw/tdefs.h>
+
+/***********************************************************************
+ * HNB Persistent Data
+ ***********************************************************************/
+
+const struct rate_ctr_desc hnb_ctr_description[] = {
+ [HNB_CTR_IUH_ESTABLISHED] = {
+ "iuh:established", "Number of times Iuh link was established" },
+
+ [HNB_CTR_RANAP_PS_ERR_IND_UL] = {
+ "ranap:ps:error_ind:ul", "Received ERROR Indications in Uplink (PS Domain)" },
+ [HNB_CTR_RANAP_CS_ERR_IND_UL] = {
+ "ranap:cs:error_ind:ul", "Received ERROR Indications in Uplink (PS Domain)" },
+
+ [HNB_CTR_RANAP_PS_RESET_REQ_UL] = {
+ "ranap:ps:reset_req:ul", "Received RESET Requests in Uplink (PS Domain)" },
+ [HNB_CTR_RANAP_CS_RESET_REQ_UL] = {
+ "ranap:cs:reset_req:ul", "Received RESET Requests in Uplink (CS Domain)" },
+
+
+ [HNB_CTR_RANAP_PS_RAB_ACT_REQ] = {
+ "ranap:ps:rab_act:req", "PS RAB Activations requested" },
+ [HNB_CTR_RANAP_CS_RAB_ACT_REQ] = {
+ "ranap:cs:rab_act:req", "CS RAB Activations requested" },
+
+ [HNB_CTR_RANAP_PS_RAB_ACT_CNF] = {
+ "ranap:ps:rab_act:cnf", "PS RAB Activations confirmed" },
+ [HNB_CTR_RANAP_CS_RAB_ACT_CNF] = {
+ "ranap:cs:rab_act:cnf", "CS RAB Activations confirmed" },
+
+ [HNB_CTR_RANAP_PS_RAB_ACT_FAIL] = {
+ "ranap:ps:rab_act:fail", "PS RAB Activations failed" },
+ [HNB_CTR_RANAP_CS_RAB_ACT_FAIL] = {
+ "ranap:cs:rab_act:fail", "CS RAB Activations failed" },
+
+
+ [HNB_CTR_RANAP_PS_RAB_MOD_REQ] = {
+ "ranap:ps:rab_mod:req", "PS RAB Modifications requested" },
+ [HNB_CTR_RANAP_CS_RAB_MOD_REQ] = {
+ "ranap:cs:rab_mod:req", "CS RAB Modifications requested" },
+
+ [HNB_CTR_RANAP_PS_RAB_MOD_CNF] = {
+ "ranap:ps:rab_mod:cnf", "PS RAB Modifications confirmed" },
+ [HNB_CTR_RANAP_CS_RAB_MOD_CNF] = {
+ "ranap:cs:rab_mod:cnf", "CS RAB Modifications confirmed" },
+
+ [HNB_CTR_RANAP_PS_RAB_MOD_FAIL] = {
+ "ranap:ps:rab_mod:fail", "PS RAB Modifications failed" },
+ [HNB_CTR_RANAP_CS_RAB_MOD_FAIL] = {
+ "ranap:cs:rab_mod:fail", "CS RAB Modifications failed" },
+
+ [HNB_CTR_RANAP_PS_RAB_REL_REQ] = {
+ "ranap:ps:rab_rel:req:normal", "PS RAB Release requested (by CN), normal" },
+ [HNB_CTR_RANAP_CS_RAB_REL_REQ] = {
+ "ranap:cs:rab_rel:req:normal", "CS RAB Release requested (by CN), normal" },
+ [HNB_CTR_RANAP_PS_RAB_REL_REQ_ABNORMAL] = {
+ "ranap:ps:rab_rel:req:abnormal", "PS RAB Release requested (by CN), abnormal" },
+ [HNB_CTR_RANAP_CS_RAB_REL_REQ_ABNORMAL] = {
+ "ranap:cs:rab_rel:req:abnormal", "CS RAB Release requested (by CN), abnormal" },
+
+ [HNB_CTR_RANAP_PS_RAB_REL_CNF] = {
+ "ranap:ps:rab_rel:cnf", "PS RAB Release confirmed" },
+ [HNB_CTR_RANAP_CS_RAB_REL_CNF] = {
+ "ranap:cs:rab_rel:cnf", "CS RAB Release confirmed" },
+
+ [HNB_CTR_RANAP_PS_RAB_REL_FAIL] = {
+ "ranap:ps:rab_rel:fail", "PS RAB Release failed" },
+ [HNB_CTR_RANAP_CS_RAB_REL_FAIL] = {
+ "ranap:cs:rab_rel:fail", "CS RAB Release failed" },
+
+ [HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT] = {
+ "ranap:ps:rab_rel:implicit:normal", "PS RAB Release implicit (during Iu Release), normal" },
+ [HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT] = {
+ "ranap:cs:rab_rel:implicit:normal", "CS RAB Release implicit (during Iu Release), normal" },
+ [HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT_ABNORMAL] = {
+ "ranap:ps:rab_rel:implicit:abnormal", "PS RAB Release implicit (during Iu Release), abnormal" },
+ [HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT_ABNORMAL] = {
+ "ranap:cs:rab_rel:implicit:abnormal", "CS RAB Release implicit (during Iu Release), abnormal" },
+
+ [HNB_CTR_RUA_ERR_IND] = {
+ "rua:error_ind", "Received RUA Error Indications" },
+
+ [HNB_CTR_RUA_PS_CONNECT_UL] = {
+ "rua:ps:connect:ul", "Received RUA Connect requests (PS Domain)" },
+ [HNB_CTR_RUA_CS_CONNECT_UL] = {
+ "rua:cs:connect:ul", "Received RUA Connect requests (CS Domain)" },
+
+ [HNB_CTR_RUA_PS_DISCONNECT_UL] = {
+ "rua:ps:disconnect:ul", "Received RUA Disconnect requests in uplink (PS Domain)" },
+ [HNB_CTR_RUA_CS_DISCONNECT_UL] = {
+ "rua:cs:disconnect:ul", "Received RUA Disconnect requests in uplink (CS Domain)" },
+ [HNB_CTR_RUA_PS_DISCONNECT_DL] = {
+ "rua:ps:disconnect:dl", "Transmitted RUA Disconnect requests in downlink (PS Domain)" },
+ [HNB_CTR_RUA_CS_DISCONNECT_DL] = {
+ "rua:cs:disconnect:dl", "Transmitted RUA Disconnect requests in downlink (CS Domain)" },
+
+ [HNB_CTR_RUA_PS_DT_UL] = {
+ "rua:ps:direct_transfer:ul", "Received RUA DirectTransfer in uplink (PS Domain)" },
+ [HNB_CTR_RUA_CS_DT_UL] = {
+ "rua:cs:direct_transfer:ul", "Received RUA DirectTransfer in uplink (CS Domain)" },
+ [HNB_CTR_RUA_PS_DT_DL] = {
+ "rua:ps:direct_transfer:dl", "Transmitted RUA DirectTransfer in downlink (PS Domain)" },
+ [HNB_CTR_RUA_CS_DT_DL] = {
+ "rua:cs:direct_transfer:dl", "Transmitted RUA DirectTransfer in downlink (CS Domain)" },
+
+ [HNB_CTR_RUA_UDT_UL] = {
+ "rua:unit_data:ul", "Received RUA UnitData (UDT) in uplink" },
+ [HNB_CTR_RUA_UDT_DL] = {
+ "rua:unit_data:dl", "Transmitted RUA UnitData (UDT) in downlink" },
+
+ [HNB_CTR_PS_PAGING_ATTEMPTED] = {
+ "paging:ps:attempted", "Transmitted PS Paging requests" },
+ [HNB_CTR_CS_PAGING_ATTEMPTED] = {
+ "paging:cs:attempted", "Transmitted CS Paging requests" },
+
+ [HNB_CTR_RAB_ACTIVE_MILLISECONDS_TOTAL] = {
+ "rab:cs:active_milliseconds:total", "Cumulative number of milliseconds of CS RAB activity" },
+
+ [HNB_CTR_DTAP_CS_LU_REQ] = { "dtap:cs:location_update:req", "CS Location Update Requests" },
+ [HNB_CTR_DTAP_CS_LU_ACC] = { "dtap:cs:location_update:accept", "CS Location Update Accepts" },
+ [HNB_CTR_DTAP_CS_LU_REJ] = { "dtap:cs:location_update:reject", "CS Location Update Rejects" },
+
+ [HNB_CTR_DTAP_PS_ATT_REQ] = { "dtap:ps:attach:req", "PS Attach Requests" },
+ [HNB_CTR_DTAP_PS_ATT_ACK] = { "dtap:ps:attach:accept", "PS Attach Accepts" },
+ [HNB_CTR_DTAP_PS_ATT_REJ] = { "dtap:ps:attach:reject", "PS Attach Rejects" },
+
+ [HNB_CTR_DTAP_PS_RAU_REQ] = { "dtap:ps:routing_area_update:req", "PS Routing Area Update Requests" },
+ [HNB_CTR_DTAP_PS_RAU_ACK] = { "dtap:ps:routing_area_update:accept", "PS Routing Area Update Accepts" },
+ [HNB_CTR_DTAP_PS_RAU_REJ] = { "dtap:ps:routing_area_update:reject", "PS Routing Area Update Rejects" },
+
+ [HNB_CTR_GTPU_PACKETS_UL] = {
+ "gtpu:packets:ul",
+ "Count of GTP-U packets received from the HNB",
+ },
+ [HNB_CTR_GTPU_TOTAL_BYTES_UL] = {
+ "gtpu:total_bytes:ul",
+ "Count of total GTP-U bytes received from the HNB, including the GTP-U/UDP/IP headers",
+ },
+ [HNB_CTR_GTPU_UE_BYTES_UL] = {
+ "gtpu:ue_bytes:ul",
+ "Assuming an IP header length of 20 bytes, GTP-U bytes received from the HNB, excluding the GTP-U/UDP/IP headers",
+ },
+ [HNB_CTR_GTPU_PACKETS_DL] = {
+ "gtpu:packets:dl",
+ "Count of GTP-U packets sent to the HNB",
+ },
+ [HNB_CTR_GTPU_TOTAL_BYTES_DL] = {
+ "gtpu:total_bytes:dl",
+ "Count of total GTP-U bytes sent to the HNB, including the GTP-U/UDP/IP headers",
+ },
+ [HNB_CTR_GTPU_UE_BYTES_DL] = {
+ "gtpu:ue_bytes:dl",
+ "Assuming an IP header length of 20 bytes, GTP-U bytes sent to the HNB, excluding the GTP-U/UDP/IP headers",
+ },
+
+};
+
+const struct rate_ctr_group_desc hnb_ctrg_desc = {
+ "hnb",
+ "hNodeB",
+ OSMO_STATS_CLASS_GLOBAL,
+ ARRAY_SIZE(hnb_ctr_description),
+ hnb_ctr_description,
+};
+
+const struct osmo_stat_item_desc hnb_stat_desc[] = {
+ [HNB_STAT_UPTIME_SECONDS] = { "uptime:seconds", "Seconds of uptime", "s", 60, 0 },
+};
+
+const struct osmo_stat_item_group_desc hnb_statg_desc = {
+ .group_name_prefix = "hnb",
+ .group_description = "hNodeB",
+ .class_id = OSMO_STATS_CLASS_GLOBAL,
+ .num_items = ARRAY_SIZE(hnb_stat_desc),
+ .item_desc = hnb_stat_desc,
+};
+
+static void hnb_persistent_disconnected_timeout_cb(void *data)
+{
+ hnb_persistent_free(data);
+}
+
+static void hnb_persistent_disconnected_timeout_schedule(struct hnb_persistent *hnbp)
+{
+ unsigned long period_s = osmo_tdef_get(hnbgw_T_defs, -35, OSMO_TDEF_S, 60*60*24*7);
+ if (period_s < 1) {
+ LOG_HNBP(hnbp, LOGL_INFO,
+ "timer X35 is zero, not setting a disconnected timeout for this hnb-persistent instance.\n");
+ return;
+ }
+ /* It is fine if the timer is already active, osmo_timer_del() is done implicitly by the osmo_timer API. */
+ osmo_timer_setup(&hnbp->disconnected_timeout, hnb_persistent_disconnected_timeout_cb, hnbp);
+ osmo_timer_schedule(&hnbp->disconnected_timeout, period_s, 0);
+}
+
+struct hnb_persistent *hnb_persistent_alloc(const struct umts_cell_id *id)
+{
+ struct hnb_persistent *hnbp = talloc_zero(g_hnbgw, struct hnb_persistent);
+ if (!hnbp)
+ return NULL;
+
+ hnbp->id = *id;
+ hnbp->id_str = talloc_strdup(hnbp, umts_cell_id_to_str(id));
+ hnbp->ctrs = rate_ctr_group_alloc(hnbp, &hnb_ctrg_desc, 0);
+ if (!hnbp->ctrs)
+ goto out_free;
+ rate_ctr_group_set_name(hnbp->ctrs, hnbp->id_str);
+ hnbp->statg = osmo_stat_item_group_alloc(hnbp, &hnb_statg_desc, 0);
+ if (!hnbp->statg)
+ goto out_free_ctrs;
+ osmo_stat_item_group_set_name(hnbp->statg, hnbp->id_str);
+
+ llist_add(&hnbp->list, &g_hnbgw->hnb_persistent_list);
+ hash_add(g_hnbgw->hnb_persistent_by_id, &hnbp->node_by_id, umts_cell_id_hash(&hnbp->id));
+
+ if (g_hnbgw->nft_kpi.active)
+ nft_kpi_hnb_persistent_add(hnbp);
+
+ /* Normally the disconnected timer runs only when the hNodeB is not currently connected on Iuh. This here is paranoia:
+ * In case we have to HNBAP HNB Register Reject, the disconnected timer should be active on this unused hnbp.
+ * On success, hnb_persistent_registered() will stop the disconnected timer directly after this. */
+ hnb_persistent_disconnected_timeout_schedule(hnbp);
+
+ return hnbp;
+
+out_free_ctrs:
+ rate_ctr_group_free(hnbp->ctrs);
+out_free:
+ talloc_free(hnbp);
+ return NULL;
+}
+
+struct hnb_persistent *hnb_persistent_find_by_id(const struct umts_cell_id *id)
+{
+ struct hnb_persistent *hnbp;
+ uint32_t id_hash = umts_cell_id_hash(id);
+ hash_for_each_possible(g_hnbgw->hnb_persistent_by_id, hnbp, node_by_id, id_hash) {
+ if (umts_cell_id_equal(&hnbp->id, id))
+ return hnbp;
+ }
+ return NULL;
+}
+
+/* Read the peer's remote IP address from the Iuh conn's fd, and set up GTP-U counters for that remote address. */
+static void hnb_persistent_update_remote_addr(struct hnb_persistent *hnbp)
+{
+ socklen_t socklen;
+ struct osmo_sockaddr osa;
+ struct osmo_sockaddr_str remote_str;
+ int fd;
+
+ fd = osmo_stream_srv_get_fd(hnbp->ctx->conn);
+ if (fd < 0) {
+ LOG_HNBP(hnbp, LOGL_ERROR, "no active socket fd, cannot set up traffic counters\n");
+ return;
+ }
+
+ socklen = sizeof(struct osmo_sockaddr);
+ if (getpeername(fd, &osa.u.sa, &socklen)) {
+ LOG_HNBP(hnbp, LOGL_ERROR, "cannot read remote address, cannot set up traffic counters\n");
+ return;
+ }
+ if (osmo_sockaddr_str_from_osa(&remote_str, &osa)) {
+ LOG_HNBP(hnbp, LOGL_ERROR, "cannot parse remote address, cannot set up traffic counters\n");
+ return;
+ }
+
+ /* We got the remote address from the Iuh link (RUA), and now we are blatantly assuming that the hNodeB has its
+ * GTP endpoint on the same IP address, just with UDP port 2152 (the fixed GTP port as per 3GPP spec). */
+ remote_str.port = 2152;
+
+ if (nft_kpi_hnb_start(hnbp, &remote_str))
+ LOG_HNBP(hnbp, LOGL_ERROR, "failed to set up traffic counters\n");
+}
+
+/* Whenever HNBAP registers a HNB, hnbgw_hnbap.c calls this function to let the hnb_persistent update its state to the
+ * (new) remote address being active. When calling this function, a hnbp->ctx should be present, with an active
+ * osmo_stream_srv conn. */
+void hnb_persistent_registered(struct hnb_persistent *hnbp)
+{
+ if (!hnbp->ctx) {
+ LOG_HNBP(hnbp, LOGL_ERROR, "hnb_persistent_registered() invoked, but there is no hnb_ctx\n");
+ return;
+ }
+
+ /* The hNodeB is now connected, i.e. not disconnected. */
+ osmo_timer_del(&hnbp->disconnected_timeout);
+
+ /* start counting traffic */
+ if (g_hnbgw->nft_kpi.active)
+ hnb_persistent_update_remote_addr(hnbp);
+}
+
+/* Whenever a HNB is regarded as no longer registered (HNBAP HNB De-Register, or the Iuh link drops), this function is
+ * called to to let the hnb_persistent update its state to the hNodeB being disconnected. Clear the ctx->persistent and
+ * hnbp->ctx relations; do not delete the hnb_persistent instance. */
+void hnb_persistent_deregistered(struct hnb_persistent *hnbp)
+{
+ /* clear out cross references of hnb_context and hnb_persistent */
+ if (hnbp->ctx) {
+ if (hnbp->ctx->persistent == hnbp)
+ hnbp->ctx->persistent = NULL;
+ hnbp->ctx = NULL;
+ }
+
+ /* stop counting traffic */
+ nft_kpi_hnb_stop(hnbp);
+
+ /* The hNodeB is now disconnected. Clear out hnb_persistent when the disconnected timeout has passed. */
+ hnb_persistent_disconnected_timeout_schedule(hnbp);
+}
+
+void hnb_persistent_free(struct hnb_persistent *hnbp)
+{
+ /* FIXME: check if in use? */
+ osmo_timer_del(&hnbp->disconnected_timeout);
+ nft_kpi_hnb_stop(hnbp);
+ nft_kpi_hnb_persistent_remove(hnbp);
+ osmo_stat_item_group_free(hnbp->statg);
+ rate_ctr_group_free(hnbp->ctrs);
+ llist_del(&hnbp->list);
+ hash_del(&hnbp->node_by_id);
+ talloc_free(hnbp);
+}
+
+/* return the amount of time the HNB is up (hnbp->ctx != NULL) or down (hnbp->ctx == NULL) */
+unsigned long long hnbp_get_updowntime(const struct hnb_persistent *hnbp)
+{
+ struct timespec tp;
+
+ if (!hnbp->updowntime)
+ return 0;
+
+ if (osmo_clock_gettime(CLOCK_MONOTONIC, &tp) != 0)
+ return 0;
+
+ return difftime(tp.tv_sec, hnbp->updowntime);
+}
diff --git a/src/osmo-hnbgw/hnbgw.c b/src/osmo-hnbgw/hnbgw.c
index c5ee2c1..c46ddad 100644
--- a/src/osmo-hnbgw/hnbgw.c
+++ b/src/osmo-hnbgw/hnbgw.c
@@ -1,7 +1,7 @@
/* kitchen sink for OsmoHNBGW implementation */
/* (C) 2015,2024 by Harald Welte <laforge(a)gnumonks.org>
- * (C) 2016-2023 by sysmocom s.f.m.c. GmbH <info(a)sysmocom.de>
+ * (C) 2016-2025 by sysmocom s.f.m.c. GmbH <info(a)sysmocom.de>
* All Rights Reserved
*
* This program is free software; you can redistribute it and/or modify
@@ -40,6 +40,8 @@
#include <osmocom/pfcp/pfcp_proto.h>
#endif
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/hnbgw_hnbap.h>
#include <osmocom/hnbgw/hnbgw_rua.h>
@@ -56,25 +58,17 @@
{}
};
-/* update the active RAB duration rate_ctr for given HNB */
-static void hnb_store_rab_durations(struct hnb_context *hnb)
+
+/* timer call-back: Update the HNB_STAT_UPTIME_SECONDS stat item of each hnb_persistent */
+static void hnbgw_store_hnb_uptime(void *data)
{
- struct hnbgw_context_map *map;
- struct timespec now;
- uint64_t elapsed_cs_rab_ms = 0;
+ struct hnb_persistent *hnbp;
- osmo_clock_gettime(CLOCK_MONOTONIC, &now);
-
- /* iterate over all context_maps (subscribers) */
- llist_for_each_entry(map, &hnb->map_list, hnb_list) {
- /* skip any PS maps, we care about CS RABs only here */
- if (map->is_ps)
- continue;
- elapsed_cs_rab_ms += mgw_fsm_get_elapsed_ms(map, &now);
+ llist_for_each_entry(hnbp, &g_hnbgw->hnb_persistent_list, list) {
+ HNBP_STAT_SET(hnbp, HNB_STAT_UPTIME_SECONDS, hnbp->ctx != NULL ? hnbp_get_updowntime(hnbp) : 0);
}
- /* Export to rate countes. */
- rate_ctr_add(HNBP_CTR(hnb->persistent, HNB_CTR_RAB_ACTIVE_MILLISECONDS_TOTAL), elapsed_cs_rab_ms);
+ osmo_timer_schedule(&g_hnbgw->store_uptime_timer, STORE_UPTIME_INTERVAL, 0);
}
static void hnbgw_store_hnb_rab_durations(void *data)
@@ -91,7 +85,6 @@
osmo_timer_schedule(&g_hnbgw->hnb_store_rab_durations_timer, HNB_STORE_RAB_DURATIONS_INTERVAL, 0);
}
-
/***********************************************************************
* UE Context
***********************************************************************/
@@ -101,764 +94,6 @@
return g_hnbgw->next_ue_ctx_id++;
}
-/***********************************************************************
- * HNB Context
- ***********************************************************************/
-
-/* look-up HNB context by id. Used from CTRL */
-static struct hnb_context *hnb_context_by_id(uint32_t cid)
-{
- struct hnb_context *hnb;
-
- llist_for_each_entry(hnb, &g_hnbgw->hnb_list, list) {
- if (hnb->id.cid == cid)
- return hnb;
- }
-
- return NULL;
-}
-
-/* look-up HNB context by identity_info. Used from VTY */
-struct hnb_context *hnb_context_by_identity_info(const char *identity_info)
-{
- struct hnb_context *hnb;
-
- llist_for_each_entry(hnb, &g_hnbgw->hnb_list, list) {
- if (strcmp(identity_info, hnb->identity_info) == 0)
- return hnb;
- }
-
- return NULL;
-}
-
-static int hnb_read_cb(struct osmo_stream_srv *conn);
-static int hnb_closed_cb(struct osmo_stream_srv *conn);
-
-static struct hnb_context *hnb_context_alloc(struct osmo_stream_srv_link *link, int new_fd)
-{
- struct hnb_context *ctx;
-
- ctx = talloc_zero(g_hnbgw, struct hnb_context);
- if (!ctx)
- return NULL;
- INIT_LLIST_HEAD(&ctx->map_list);
-
- ctx->conn = osmo_stream_srv_create(g_hnbgw, link, new_fd, hnb_read_cb, hnb_closed_cb, ctx);
- if (!ctx->conn) {
- LOGP(DMAIN, LOGL_INFO, "error while creating connection\n");
- talloc_free(ctx);
- return NULL;
- }
-
- llist_add_tail(&ctx->list, &g_hnbgw->hnb_list);
- return ctx;
-}
-
-int umts_cell_id_to_str_buf(char *buf, size_t buflen, const struct umts_cell_id *ucid)
-{
- struct osmo_strbuf sb = { .buf = buf, .len = buflen };
- OSMO_STRBUF_APPEND_NOLEN(sb, osmo_plmn_name_buf, &ucid->plmn);
- OSMO_STRBUF_PRINTF(sb, "-L%u-R%u-S%u-C%u", ucid->lac, ucid->rac, ucid->sac, ucid->cid);
- return sb.chars_needed;
-}
-
-char *umts_cell_id_to_str_c(void *ctx, const struct umts_cell_id *ucid)
-{
- OSMO_NAME_C_IMPL(ctx, 64, "ERROR", umts_cell_id_to_str_buf, ucid)
-}
-
-const char *umts_cell_id_to_str(const struct umts_cell_id *ucid)
-{
- return umts_cell_id_to_str_c(OTC_SELECT, ucid);
-}
-
-/* Useful to index a hash table by struct umts_cell_id. */
-uint32_t umts_cell_id_hash(const struct umts_cell_id *ucid)
-{
- return osmo_jhash(ucid, sizeof(*ucid), 0x423423);
-}
-
-/* parse a string representation of an umts_cell_id into its decoded representation */
-int umts_cell_id_from_str(struct umts_cell_id *ucid, const char *instr)
-{
- int rc;
- char buf[4];
- const char *pos = instr;
- const char *end;
-
- /* We want to use struct umts_cell_id as hashtable key. If it ever happens to contain any padding bytes, make
- * sure everything is deterministically zero. */
- memset(ucid, 0, sizeof(*ucid));
-
- /* read MCC */
- end = strchr(pos, '-');
- if (!end || end <= pos || (end - pos) >= sizeof(buf))
- return -EINVAL;
- osmo_strlcpy(buf, pos, end - pos + 1);
- if (osmo_mcc_from_str(buf, &ucid->plmn.mcc))
- return -EINVAL;
- pos = end + 1;
-
- /* read MNC -- here the number of leading zeros matters. */
- end = strchr(pos, '-');
- if (!end || end == pos || (end - pos) >= sizeof(buf))
- return -EINVAL;
- osmo_strlcpy(buf, pos, end - pos + 1);
- if (osmo_mnc_from_str(buf, &ucid->plmn.mnc, &ucid->plmn.mnc_3_digits))
- return -EINVAL;
- pos = end + 1;
-
- /* parse the rest, where leading zeros do not matter */
- rc = sscanf(pos, "L%" SCNu16 "-R%" SCNu8 "-S%" SCNu16 "-C%" SCNu32 "",
- &ucid->lac, &ucid->rac, &ucid->sac, &ucid->cid);
- if (rc < 0)
- return -errno;
-
- if (rc != 4)
- return -EINVAL;
-
- if (ucid->lac == 0 || ucid->lac == 0xffff)
- return -EINVAL;
-
- /* CellIdentity in the ASN.1 syntax is a bit-string of 28 bits length */
- if (ucid->cid >= (1 << 28))
- return -EINVAL;
-
- return 0;
-}
-
-const char *hnb_context_name(struct hnb_context *ctx)
-{
- char *result;
- if (!ctx)
- return "NULL";
-
- if (ctx->conn) {
- char hostbuf_r[INET6_ADDRSTRLEN];
- char portbuf_r[6];
- int fd = osmo_stream_srv_get_ofd(ctx->conn)->fd;
-
- /* get remote addr */
- if (osmo_sock_get_ip_and_port(fd, hostbuf_r, sizeof(hostbuf_r), portbuf_r, sizeof(portbuf_r), false) == 0)
- result = talloc_asprintf(OTC_SELECT, "%s:%s", hostbuf_r, portbuf_r);
- else
- result = "?";
- } else {
- result = "disconnected";
- }
-
- if (g_hnbgw->config.log_prefix_hnb_id)
- result = talloc_asprintf(OTC_SELECT, "%s %s", result, ctx->identity_info);
- else
- result = talloc_asprintf(OTC_SELECT, "%s %s", result, umts_cell_id_to_str(&ctx->id));
- return result;
-}
-
-void hnb_context_release_ue_state(struct hnb_context *ctx)
-{
- struct hnbgw_context_map *map, *map2;
-
- /* deactivate all context maps */
- llist_for_each_entry_safe(map, map2, &ctx->map_list, hnb_list) {
- context_map_hnb_released(map);
- /* hnbgw_context_map will remove itself from lists when it is ready. */
- }
-}
-
-void hnb_context_release(struct hnb_context *ctx)
-{
- struct hnbgw_context_map *map;
-
- LOGHNB(ctx, DMAIN, LOGL_INFO, "Releasing HNB context\n");
-
- if (ctx->persistent) {
- struct timespec tp;
- int rc;
- rc = osmo_clock_gettime(CLOCK_MONOTONIC, &tp);
- ctx->persistent->updowntime = (rc < 0) ? 0 : tp.tv_sec;
- }
-
- /* remove from the list of HNB contexts */
- llist_del(&ctx->list);
-
- hnb_context_release_ue_state(ctx);
-
- if (ctx->conn) { /* we own a conn, we must free it: */
- LOGHNB(ctx, DMAIN, LOGL_INFO, "Closing HNB SCTP connection %s\n",
- osmo_sock_get_name2(osmo_stream_srv_get_ofd(ctx->conn)->fd));
- /* Avoid our closed_cb calling hnb_context_release() again: */
- osmo_stream_srv_set_data(ctx->conn, NULL);
- osmo_stream_srv_destroy(ctx->conn);
- } /* else: we are called from closed_cb, so conn is being freed separately */
-
- /* hnbgw_context_map are still listed in ctx->map_list, but we are freeing ctx. Remove all entries from the
- * list, but keep the hnbgw_context_map around for graceful release. They are also listed under
- * hnbgw_cnlink->map_list, and will remove themselves when ready. */
- while ((map = llist_first_entry_or_null(&ctx->map_list, struct hnbgw_context_map, hnb_list))) {
- llist_del(&map->hnb_list);
- map->hnb_ctx = NULL;
- }
-
- /* remove back reference from hnb_persistent to context */
- if (ctx->persistent)
- hnb_persistent_deregistered(ctx->persistent);
-
- talloc_free(ctx);
-}
-
-/***********************************************************************
- * HNB Persistent Data
- ***********************************************************************/
-
-const struct rate_ctr_desc hnb_ctr_description[] = {
- [HNB_CTR_IUH_ESTABLISHED] = {
- "iuh:established", "Number of times Iuh link was established" },
-
- [HNB_CTR_RANAP_PS_ERR_IND_UL] = {
- "ranap:ps:error_ind:ul", "Received ERROR Indications in Uplink (PS Domain)" },
- [HNB_CTR_RANAP_CS_ERR_IND_UL] = {
- "ranap:cs:error_ind:ul", "Received ERROR Indications in Uplink (PS Domain)" },
-
- [HNB_CTR_RANAP_PS_RESET_REQ_UL] = {
- "ranap:ps:reset_req:ul", "Received RESET Requests in Uplink (PS Domain)" },
- [HNB_CTR_RANAP_CS_RESET_REQ_UL] = {
- "ranap:cs:reset_req:ul", "Received RESET Requests in Uplink (CS Domain)" },
-
-
- [HNB_CTR_RANAP_PS_RAB_ACT_REQ] = {
- "ranap:ps:rab_act:req", "PS RAB Activations requested" },
- [HNB_CTR_RANAP_CS_RAB_ACT_REQ] = {
- "ranap:cs:rab_act:req", "CS RAB Activations requested" },
-
- [HNB_CTR_RANAP_PS_RAB_ACT_CNF] = {
- "ranap:ps:rab_act:cnf", "PS RAB Activations confirmed" },
- [HNB_CTR_RANAP_CS_RAB_ACT_CNF] = {
- "ranap:cs:rab_act:cnf", "CS RAB Activations confirmed" },
-
- [HNB_CTR_RANAP_PS_RAB_ACT_FAIL] = {
- "ranap:ps:rab_act:fail", "PS RAB Activations failed" },
- [HNB_CTR_RANAP_CS_RAB_ACT_FAIL] = {
- "ranap:cs:rab_act:fail", "CS RAB Activations failed" },
-
-
- [HNB_CTR_RANAP_PS_RAB_MOD_REQ] = {
- "ranap:ps:rab_mod:req", "PS RAB Modifications requested" },
- [HNB_CTR_RANAP_CS_RAB_MOD_REQ] = {
- "ranap:cs:rab_mod:req", "CS RAB Modifications requested" },
-
- [HNB_CTR_RANAP_PS_RAB_MOD_CNF] = {
- "ranap:ps:rab_mod:cnf", "PS RAB Modifications confirmed" },
- [HNB_CTR_RANAP_CS_RAB_MOD_CNF] = {
- "ranap:cs:rab_mod:cnf", "CS RAB Modifications confirmed" },
-
- [HNB_CTR_RANAP_PS_RAB_MOD_FAIL] = {
- "ranap:ps:rab_mod:fail", "PS RAB Modifications failed" },
- [HNB_CTR_RANAP_CS_RAB_MOD_FAIL] = {
- "ranap:cs:rab_mod:fail", "CS RAB Modifications failed" },
-
- [HNB_CTR_RANAP_PS_RAB_REL_REQ] = {
- "ranap:ps:rab_rel:req:normal", "PS RAB Release requested (by CN), normal" },
- [HNB_CTR_RANAP_CS_RAB_REL_REQ] = {
- "ranap:cs:rab_rel:req:normal", "CS RAB Release requested (by CN), normal" },
- [HNB_CTR_RANAP_PS_RAB_REL_REQ_ABNORMAL] = {
- "ranap:ps:rab_rel:req:abnormal", "PS RAB Release requested (by CN), abnormal" },
- [HNB_CTR_RANAP_CS_RAB_REL_REQ_ABNORMAL] = {
- "ranap:cs:rab_rel:req:abnormal", "CS RAB Release requested (by CN), abnormal" },
-
- [HNB_CTR_RANAP_PS_RAB_REL_CNF] = {
- "ranap:ps:rab_rel:cnf", "PS RAB Release confirmed" },
- [HNB_CTR_RANAP_CS_RAB_REL_CNF] = {
- "ranap:cs:rab_rel:cnf", "CS RAB Release confirmed" },
-
- [HNB_CTR_RANAP_PS_RAB_REL_FAIL] = {
- "ranap:ps:rab_rel:fail", "PS RAB Release failed" },
- [HNB_CTR_RANAP_CS_RAB_REL_FAIL] = {
- "ranap:cs:rab_rel:fail", "CS RAB Release failed" },
-
- [HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT] = {
- "ranap:ps:rab_rel:implicit:normal", "PS RAB Release implicit (during Iu Release), normal" },
- [HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT] = {
- "ranap:cs:rab_rel:implicit:normal", "CS RAB Release implicit (during Iu Release), normal" },
- [HNB_CTR_RANAP_PS_RAB_REL_IMPLICIT_ABNORMAL] = {
- "ranap:ps:rab_rel:implicit:abnormal", "PS RAB Release implicit (during Iu Release), abnormal" },
- [HNB_CTR_RANAP_CS_RAB_REL_IMPLICIT_ABNORMAL] = {
- "ranap:cs:rab_rel:implicit:abnormal", "CS RAB Release implicit (during Iu Release), abnormal" },
-
- [HNB_CTR_RUA_ERR_IND] = {
- "rua:error_ind", "Received RUA Error Indications" },
-
- [HNB_CTR_RUA_PS_CONNECT_UL] = {
- "rua:ps:connect:ul", "Received RUA Connect requests (PS Domain)" },
- [HNB_CTR_RUA_CS_CONNECT_UL] = {
- "rua:cs:connect:ul", "Received RUA Connect requests (CS Domain)" },
-
- [HNB_CTR_RUA_PS_DISCONNECT_UL] = {
- "rua:ps:disconnect:ul", "Received RUA Disconnect requests in uplink (PS Domain)" },
- [HNB_CTR_RUA_CS_DISCONNECT_UL] = {
- "rua:cs:disconnect:ul", "Received RUA Disconnect requests in uplink (CS Domain)" },
- [HNB_CTR_RUA_PS_DISCONNECT_DL] = {
- "rua:ps:disconnect:dl", "Transmitted RUA Disconnect requests in downlink (PS Domain)" },
- [HNB_CTR_RUA_CS_DISCONNECT_DL] = {
- "rua:cs:disconnect:dl", "Transmitted RUA Disconnect requests in downlink (CS Domain)" },
-
- [HNB_CTR_RUA_PS_DT_UL] = {
- "rua:ps:direct_transfer:ul", "Received RUA DirectTransfer in uplink (PS Domain)" },
- [HNB_CTR_RUA_CS_DT_UL] = {
- "rua:cs:direct_transfer:ul", "Received RUA DirectTransfer in uplink (CS Domain)" },
- [HNB_CTR_RUA_PS_DT_DL] = {
- "rua:ps:direct_transfer:dl", "Transmitted RUA DirectTransfer in downlink (PS Domain)" },
- [HNB_CTR_RUA_CS_DT_DL] = {
- "rua:cs:direct_transfer:dl", "Transmitted RUA DirectTransfer in downlink (CS Domain)" },
-
- [HNB_CTR_RUA_UDT_UL] = {
- "rua:unit_data:ul", "Received RUA UnitData (UDT) in uplink" },
- [HNB_CTR_RUA_UDT_DL] = {
- "rua:unit_data:dl", "Transmitted RUA UnitData (UDT) in downlink" },
-
- [HNB_CTR_PS_PAGING_ATTEMPTED] = {
- "paging:ps:attempted", "Transmitted PS Paging requests" },
- [HNB_CTR_CS_PAGING_ATTEMPTED] = {
- "paging:cs:attempted", "Transmitted CS Paging requests" },
-
- [HNB_CTR_RAB_ACTIVE_MILLISECONDS_TOTAL] = {
- "rab:cs:active_milliseconds:total", "Cumulative number of milliseconds of CS RAB activity" },
-
- [HNB_CTR_DTAP_CS_LU_REQ] = { "dtap:cs:location_update:req", "CS Location Update Requests" },
- [HNB_CTR_DTAP_CS_LU_ACC] = { "dtap:cs:location_update:accept", "CS Location Update Accepts" },
- [HNB_CTR_DTAP_CS_LU_REJ] = { "dtap:cs:location_update:reject", "CS Location Update Rejects" },
-
- [HNB_CTR_DTAP_PS_ATT_REQ] = { "dtap:ps:attach:req", "PS Attach Requests" },
- [HNB_CTR_DTAP_PS_ATT_ACK] = { "dtap:ps:attach:accept", "PS Attach Accepts" },
- [HNB_CTR_DTAP_PS_ATT_REJ] = { "dtap:ps:attach:reject", "PS Attach Rejects" },
-
- [HNB_CTR_DTAP_PS_RAU_REQ] = { "dtap:ps:routing_area_update:req", "PS Routing Area Update Requests" },
- [HNB_CTR_DTAP_PS_RAU_ACK] = { "dtap:ps:routing_area_update:accept", "PS Routing Area Update Accepts" },
- [HNB_CTR_DTAP_PS_RAU_REJ] = { "dtap:ps:routing_area_update:reject", "PS Routing Area Update Rejects" },
-
- [HNB_CTR_GTPU_PACKETS_UL] = {
- "gtpu:packets:ul",
- "Count of GTP-U packets received from the HNB",
- },
- [HNB_CTR_GTPU_TOTAL_BYTES_UL] = {
- "gtpu:total_bytes:ul",
- "Count of total GTP-U bytes received from the HNB, including the GTP-U/UDP/IP headers",
- },
- [HNB_CTR_GTPU_UE_BYTES_UL] = {
- "gtpu:ue_bytes:ul",
- "Assuming an IP header length of 20 bytes, GTP-U bytes received from the HNB, excluding the GTP-U/UDP/IP headers",
- },
- [HNB_CTR_GTPU_PACKETS_DL] = {
- "gtpu:packets:dl",
- "Count of GTP-U packets sent to the HNB",
- },
- [HNB_CTR_GTPU_TOTAL_BYTES_DL] = {
- "gtpu:total_bytes:dl",
- "Count of total GTP-U bytes sent to the HNB, including the GTP-U/UDP/IP headers",
- },
- [HNB_CTR_GTPU_UE_BYTES_DL] = {
- "gtpu:ue_bytes:dl",
- "Assuming an IP header length of 20 bytes, GTP-U bytes sent to the HNB, excluding the GTP-U/UDP/IP headers",
- },
-
-};
-
-const struct rate_ctr_group_desc hnb_ctrg_desc = {
- "hnb",
- "hNodeB",
- OSMO_STATS_CLASS_GLOBAL,
- ARRAY_SIZE(hnb_ctr_description),
- hnb_ctr_description,
-};
-
-const struct osmo_stat_item_desc hnb_stat_desc[] = {
- [HNB_STAT_UPTIME_SECONDS] = { "uptime:seconds", "Seconds of uptime", "s", 60, 0 },
-};
-
-const struct osmo_stat_item_group_desc hnb_statg_desc = {
- .group_name_prefix = "hnb",
- .group_description = "hNodeB",
- .class_id = OSMO_STATS_CLASS_GLOBAL,
- .num_items = ARRAY_SIZE(hnb_stat_desc),
- .item_desc = hnb_stat_desc,
-};
-
-static void hnb_persistent_disconnected_timeout_cb(void *data)
-{
- hnb_persistent_free(data);
-}
-
-static void hnb_persistent_disconnected_timeout_schedule(struct hnb_persistent *hnbp)
-{
- unsigned long period_s = osmo_tdef_get(hnbgw_T_defs, -35, OSMO_TDEF_S, 60*60*24*7);
- if (period_s < 1) {
- LOG_HNBP(hnbp, LOGL_INFO,
- "timer X35 is zero, not setting a disconnected timeout for this hnb-persistent instance.\n");
- return;
- }
- /* It is fine if the timer is already active, osmo_timer_del() is done implicitly by the osmo_timer API. */
- osmo_timer_setup(&hnbp->disconnected_timeout, hnb_persistent_disconnected_timeout_cb, hnbp);
- osmo_timer_schedule(&hnbp->disconnected_timeout, period_s, 0);
-}
-
-struct hnb_persistent *hnb_persistent_alloc(const struct umts_cell_id *id)
-{
- struct hnb_persistent *hnbp = talloc_zero(g_hnbgw, struct hnb_persistent);
- if (!hnbp)
- return NULL;
-
- hnbp->id = *id;
- hnbp->id_str = talloc_strdup(hnbp, umts_cell_id_to_str(id));
- hnbp->ctrs = rate_ctr_group_alloc(hnbp, &hnb_ctrg_desc, 0);
- if (!hnbp->ctrs)
- goto out_free;
- rate_ctr_group_set_name(hnbp->ctrs, hnbp->id_str);
- hnbp->statg = osmo_stat_item_group_alloc(hnbp, &hnb_statg_desc, 0);
- if (!hnbp->statg)
- goto out_free_ctrs;
- osmo_stat_item_group_set_name(hnbp->statg, hnbp->id_str);
-
- llist_add(&hnbp->list, &g_hnbgw->hnb_persistent_list);
- hash_add(g_hnbgw->hnb_persistent_by_id, &hnbp->node_by_id, umts_cell_id_hash(&hnbp->id));
-
- if (g_hnbgw->nft_kpi.active)
- nft_kpi_hnb_persistent_add(hnbp);
-
- /* Normally the disconnected timer runs only when the hNodeB is not currently connected on Iuh. This here is paranoia:
- * In case we have to HNBAP HNB Register Reject, the disconnected timer should be active on this unused hnbp.
- * On success, hnb_persistent_registered() will stop the disconnected timer directly after this. */
- hnb_persistent_disconnected_timeout_schedule(hnbp);
-
- return hnbp;
-
-out_free_ctrs:
- rate_ctr_group_free(hnbp->ctrs);
-out_free:
- talloc_free(hnbp);
- return NULL;
-}
-
-struct hnb_persistent *hnb_persistent_find_by_id(const struct umts_cell_id *id)
-{
- struct hnb_persistent *hnbp;
- uint32_t id_hash = umts_cell_id_hash(id);
- hash_for_each_possible (g_hnbgw->hnb_persistent_by_id, hnbp, node_by_id, id_hash) {
- if (umts_cell_id_equal(&hnbp->id, id))
- return hnbp;
- }
- return NULL;
-}
-
-/* Read the peer's remote IP address from the Iuh conn's fd, and set up GTP-U counters for that remote address. */
-static void hnb_persistent_update_remote_addr(struct hnb_persistent *hnbp)
-{
- socklen_t socklen;
- struct osmo_sockaddr osa;
- struct osmo_sockaddr_str remote_str;
- int fd;
-
- fd = osmo_stream_srv_get_fd(hnbp->ctx->conn);
- if (fd < 0) {
- LOG_HNBP(hnbp, LOGL_ERROR, "no active socket fd, cannot set up traffic counters\n");
- return;
- }
-
- socklen = sizeof(struct osmo_sockaddr);
- if (getpeername(fd, &osa.u.sa, &socklen)) {
- LOG_HNBP(hnbp, LOGL_ERROR, "cannot read remote address, cannot set up traffic counters\n");
- return;
- }
- if (osmo_sockaddr_str_from_osa(&remote_str, &osa)) {
- LOG_HNBP(hnbp, LOGL_ERROR, "cannot parse remote address, cannot set up traffic counters\n");
- return;
- }
-
- /* We got the remote address from the Iuh link (RUA), and now we are blatantly assuming that the hNodeB has its
- * GTP endpoint on the same IP address, just with UDP port 2152 (the fixed GTP port as per 3GPP spec). */
- remote_str.port = 2152;
-
- if (nft_kpi_hnb_start(hnbp, &remote_str))
- LOG_HNBP(hnbp, LOGL_ERROR, "failed to set up traffic counters\n");
-}
-
-/* Whenever HNBAP registers a HNB, hnbgw_hnbap.c calls this function to let the hnb_persistent update its state to the
- * (new) remote address being active. When calling this function, a hnbp->ctx should be present, with an active
- * osmo_stream_srv conn. */
-void hnb_persistent_registered(struct hnb_persistent *hnbp)
-{
- if (!hnbp->ctx) {
- LOG_HNBP(hnbp, LOGL_ERROR, "hnb_persistent_registered() invoked, but there is no hnb_ctx\n");
- return;
- }
-
- /* The hNodeB is now connected, i.e. not disconnected. */
- osmo_timer_del(&hnbp->disconnected_timeout);
-
- /* start counting traffic */
- if (g_hnbgw->nft_kpi.active)
- hnb_persistent_update_remote_addr(hnbp);
-}
-
-/* Whenever a HNB is regarded as no longer registered (HNBAP HNB De-Register, or the Iuh link drops), this function is
- * called to to let the hnb_persistent update its state to the hNodeB being disconnected. Clear the ctx->persistent and
- * hnbp->ctx relations; do not delete the hnb_persistent instance. */
-void hnb_persistent_deregistered(struct hnb_persistent *hnbp)
-{
- /* clear out cross references of hnb_context and hnb_persistent */
- if (hnbp->ctx) {
- if (hnbp->ctx->persistent == hnbp)
- hnbp->ctx->persistent = NULL;
- hnbp->ctx = NULL;
- }
-
- /* stop counting traffic */
- nft_kpi_hnb_stop(hnbp);
-
- /* The hNodeB is now disconnected. Clear out hnb_persistent when the disconnected timeout has passed. */
- hnb_persistent_disconnected_timeout_schedule(hnbp);
-}
-
-void hnb_persistent_free(struct hnb_persistent *hnbp)
-{
- /* FIXME: check if in use? */
- osmo_timer_del(&hnbp->disconnected_timeout);
- nft_kpi_hnb_stop(hnbp);
- nft_kpi_hnb_persistent_remove(hnbp);
- osmo_stat_item_group_free(hnbp->statg);
- rate_ctr_group_free(hnbp->ctrs);
- llist_del(&hnbp->list);
- hash_del(&hnbp->node_by_id);
- talloc_free(hnbp);
-}
-
-/* return the amount of time the HNB is up (hnbp->ctx != NULL) or down (hnbp->ctx == NULL) */
-static unsigned long long hnbp_get_updowntime(const struct hnb_persistent *hnbp)
-{
- struct timespec tp;
-
- if (!hnbp->updowntime)
- return 0;
-
- if (osmo_clock_gettime(CLOCK_MONOTONIC, &tp) != 0)
- return 0;
-
- return difftime(tp.tv_sec, hnbp->updowntime);
-}
-
-unsigned long long hnb_get_updowntime(const struct hnb_context *ctx)
-{
- if (!ctx->persistent)
- return 0;
- return hnbp_get_updowntime(ctx->persistent);
-}
-
-/* timer call-back: Update the HNB_STAT_UPTIME_SECONDS stat item of each hnb_persistent */
-static void hnbgw_store_hnb_uptime(void *data)
-{
- struct hnb_persistent *hnbp;
-
- llist_for_each_entry(hnbp, &g_hnbgw->hnb_persistent_list, list) {
- HNBP_STAT_SET(hnbp, HNB_STAT_UPTIME_SECONDS, hnbp->ctx != NULL ? hnbp_get_updowntime(hnbp) : 0);
- }
-
- osmo_timer_schedule(&g_hnbgw->store_uptime_timer, STORE_UPTIME_INTERVAL, 0);
-}
-
-/***********************************************************************
- * SCTP Socket / stream handling
- ***********************************************************************/
-
-static int hnb_read_cb(struct osmo_stream_srv *conn)
-{
- struct hnb_context *hnb = osmo_stream_srv_get_data(conn);
- struct osmo_fd *ofd = osmo_stream_srv_get_ofd(conn);
- struct msgb *msg = msgb_alloc(IUH_MSGB_SIZE, "Iuh rx");
- int rc;
-
- if (!msg)
- return -ENOMEM;
-
- OSMO_ASSERT(hnb);
- /* we store a reference to the HomeNodeB in the msg->dest for the
- * benefit of various downstream processing functions */
- msg->dst = hnb;
-
- rc = osmo_stream_srv_recv(conn, msg);
- /* Notification received */
- if (msgb_sctp_msg_flags(msg) & OSMO_STREAM_SCTP_MSG_FLAGS_NOTIFICATION) {
- union sctp_notification *notif = (union sctp_notification *)msgb_data(msg);
- rc = 0;
- switch (notif->sn_header.sn_type) {
- case SCTP_ASSOC_CHANGE:
- switch (notif->sn_assoc_change.sac_state) {
- case SCTP_COMM_LOST:
- LOGHNB(hnb, DMAIN, LOGL_NOTICE,
- "sctp_recvmsg(%s) = SCTP_COMM_LOST, closing conn\n",
- osmo_sock_get_name2(ofd->fd));
- osmo_stream_srv_destroy(conn);
- rc = -EBADF;
- break;
- case SCTP_RESTART:
- LOGHNB(hnb, DMAIN, LOGL_NOTICE, "HNB SCTP conn RESTARTed, marking as HNBAP-unregistered\n");
- hnb->hnb_registered = false;
- hnb_context_release_ue_state(hnb);
- /* The tx queue may be quite full after an SCTP RESTART: (SYS#6113)
- * The link may have been flaky (a possible reason for the peer restarting the conn) and
- * hence the kernel socket Tx queue may be full (no ACKs coming back) and our own userspace
- * queue may contain plenty of oldish messages to be sent. Since the HNB will re-register after
- * this, we simply drop all those old messages: */
- osmo_stream_srv_clear_tx_queue(conn);
- break;
- }
- break;
- case SCTP_SHUTDOWN_EVENT:
- LOGHNB(hnb, DMAIN, LOGL_NOTICE,
- "sctp_recvmsg(%s) = SCTP_SHUTDOWN_EVENT, closing conn\n",
- osmo_sock_get_name2(ofd->fd));
- osmo_stream_srv_destroy(conn);
- rc = -EBADF;
- break;
- }
- goto out;
- } else if (rc == -EAGAIN) {
- /* Older versions of osmo_stream_srv_recv() not supporting
- * msgb_sctp_msg_flags() may still return -EAGAIN when an sctp
- * notification is received. */
- rc = 0;
- goto out;
- } else if (rc < 0) {
- LOGHNB(hnb, DMAIN, LOGL_ERROR, "Error during sctp_recvmsg(%s)\n",
- osmo_sock_get_name2(ofd->fd));
- osmo_stream_srv_destroy(conn);
- rc = -EBADF;
- goto out;
- } else if (rc == 0) {
- LOGHNB(hnb, DMAIN, LOGL_NOTICE, "Connection closed sctp_recvmsg(%s) = 0\n",
- osmo_sock_get_name2(ofd->fd));
- osmo_stream_srv_destroy(conn);
- rc = -EBADF;
- goto out;
- } else {
- msgb_put(msg, rc);
- }
-
- switch (msgb_sctp_ppid(msg)) {
- case IUH_PPI_HNBAP:
- hnb->hnbap_stream = msgb_sctp_stream(msg);
- rc = hnbgw_hnbap_rx(hnb, msg);
- break;
- case IUH_PPI_RUA:
- if (!hnb->hnb_registered) {
- LOGHNB(hnb, DMAIN, LOGL_NOTICE, "Discarding RUA as HNB is not registered\n");
- goto out;
- }
- hnb->rua_stream = msgb_sctp_stream(msg);
- rc = hnbgw_rua_rx(hnb, msg);
- break;
- case IUH_PPI_SABP:
- case IUH_PPI_RNA:
- case IUH_PPI_PUA:
- LOGHNB(hnb, DMAIN, LOGL_ERROR, "Unimplemented SCTP PPID=%lu received\n", msgb_sctp_ppid(msg));
- rc = 0;
- break;
- default:
- LOGHNB(hnb, DMAIN, LOGL_ERROR, "Unknown SCTP PPID=%lu received\n", msgb_sctp_ppid(msg));
- rc = 0;
- break;
- }
-
-out:
- msgb_free(msg);
- return rc;
-}
-
-static int hnb_closed_cb(struct osmo_stream_srv *conn)
-{
- struct hnb_context *hnb = osmo_stream_srv_get_data(conn);
- if (!hnb)
- return 0; /* hnb_context is being freed, nothing do be done */
-
- /* hnb: conn became broken, let's release the associated hnb.
- * conn object is being freed after closed_cb(), so unassign it from hnb
- * if available to avoid it freeing it again: */
- hnb->conn = NULL;
- hnb_context_release(hnb);
-
- return 0;
-}
-
-/*! call-back when the listen FD has something to read */
-int hnbgw_rua_accept_cb(struct osmo_stream_srv_link *srv, int fd)
-{
- struct hnb_context *ctx;
-
- LOGP(DMAIN, LOGL_INFO, "New HNB SCTP connection %s\n",
- osmo_sock_get_name2(fd));
-
- ctx = hnb_context_alloc(srv, fd);
- if (!ctx)
- return -ENOMEM;
-
- return 0;
-}
-
-CTRL_CMD_DEFINE_RO(hnb_info, "info");
-static int get_hnb_info(struct ctrl_cmd *cmd, void *data)
-{
- struct hnb_context *hnb = data;
-
- cmd->reply = talloc_strdup(cmd, hnb->identity_info);
-
- return CTRL_CMD_REPLY;
-}
-
-CTRL_CMD_DEFINE_RO(hnbs, "num-hnb");
-static int get_hnbs(struct ctrl_cmd *cmd, void *data)
-{
- cmd->reply = talloc_asprintf(cmd, "%u", llist_count(&g_hnbgw->hnb_list));
-
- return CTRL_CMD_REPLY;
-}
-
-int hnb_ctrl_cmds_install(void)
-{
- int rc = 0;
-
- rc |= ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_hnbs);
- rc |= ctrl_cmd_install(CTRL_NODE_HNB, &cmd_hnb_info);
-
- return rc;
-}
-
-int hnb_ctrl_node_lookup(void *data, vector vline, int *node_type, void **node_data, int *i)
-{
- const char *token = vector_slot(vline, *i);
- struct hnb_context *hnb;
- long num;
-
- switch (*node_type) {
- case CTRL_NODE_ROOT:
- if (strcmp(token, "hnb") != 0)
- return 0;
-
- (*i)++;
-
- if (!ctrl_parse_get_num(vline, *i, &num))
- return -ERANGE;
-
- hnb = hnb_context_by_id(num);
- if (!hnb)
- return -ENODEV;
-
- *node_data = hnb;
- *node_type = CTRL_NODE_HNB;
- break;
- default:
- return 0;
- }
-
- return 1;
-}
-
int hnbgw_mgw_setup(void)
{
struct mgcp_client *mgcp_client_single;
diff --git a/src/osmo-hnbgw/hnbgw_hnbap.c b/src/osmo-hnbgw/hnbgw_hnbap.c
index 5874457..b291513 100644
--- a/src/osmo-hnbgw/hnbgw_hnbap.c
+++ b/src/osmo-hnbgw/hnbgw_hnbap.c
@@ -33,6 +33,8 @@
#include <osmocom/hnbap/hnbap_common.h>
#include <osmocom/ranap/iu_helpers.h>
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbap/hnbap_ies_defs.h>
diff --git a/src/osmo-hnbgw/hnbgw_ranap.c b/src/osmo-hnbgw/hnbgw_ranap.c
index 6dc1f06..efa46d4 100644
--- a/src/osmo-hnbgw/hnbgw_ranap.c
+++ b/src/osmo-hnbgw/hnbgw_ranap.c
@@ -39,6 +39,8 @@
#include <osmocom/pfcp/pfcp_cp_peer.h>
#endif
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/hnbgw_rua.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
diff --git a/src/osmo-hnbgw/hnbgw_rua.c b/src/osmo-hnbgw/hnbgw_rua.c
index 7a51c8d..40e65f4 100644
--- a/src/osmo-hnbgw/hnbgw_rua.c
+++ b/src/osmo-hnbgw/hnbgw_rua.c
@@ -33,6 +33,8 @@
#include "asn1helpers.h"
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
#include <osmocom/hnbgw/hnbgw_ranap.h>
#include <osmocom/rua/rua_common.h>
diff --git a/src/osmo-hnbgw/hnbgw_vty.c b/src/osmo-hnbgw/hnbgw_vty.c
index d99a998..e2c3d8f 100644
--- a/src/osmo-hnbgw/hnbgw_vty.c
+++ b/src/osmo-hnbgw/hnbgw_vty.c
@@ -31,6 +31,8 @@
#include <osmocom/hnbgw/vty.h>
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
#include <osmocom/hnbgw/context_map.h>
diff --git a/src/osmo-hnbgw/kpi_dtap.c b/src/osmo-hnbgw/kpi_dtap.c
index 8d47208..36c9c91 100644
--- a/src/osmo-hnbgw/kpi_dtap.c
+++ b/src/osmo-hnbgw/kpi_dtap.c
@@ -26,6 +26,7 @@
#include <osmocom/gsm/protocol/gsm_04_08.h>
#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/context_map.h>
#include <osmocom/hnbgw/kpi.h>
diff --git a/src/osmo-hnbgw/kpi_ranap.c b/src/osmo-hnbgw/kpi_ranap.c
index 3f2c1b3..c1c77bf 100644
--- a/src/osmo-hnbgw/kpi_ranap.c
+++ b/src/osmo-hnbgw/kpi_ranap.c
@@ -24,6 +24,7 @@
#include <osmocom/ranap/ranap_common_ran.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
#include <osmocom/hnbgw/context_map.h>
#include <osmocom/hnbgw/kpi.h>
diff --git a/src/osmo-hnbgw/nft_kpi.c b/src/osmo-hnbgw/nft_kpi.c
index 9dd8608..f8671fc 100644
--- a/src/osmo-hnbgw/nft_kpi.c
+++ b/src/osmo-hnbgw/nft_kpi.c
@@ -19,8 +19,10 @@
#include <osmocom/core/logging.h>
#include <osmocom/core/it_q.h>
+#include <osmocom/hnbgw/hnb_persistent.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/nft_kpi.h>
+#include <osmocom/hnbgw/umts_cell_id.h>
#include "config.h"
diff --git a/src/osmo-hnbgw/osmo_hnbgw_main.c b/src/osmo-hnbgw/osmo_hnbgw_main.c
index 2034490..845002f 100644
--- a/src/osmo-hnbgw/osmo_hnbgw_main.c
+++ b/src/osmo-hnbgw/osmo_hnbgw_main.c
@@ -45,6 +45,7 @@
#include <osmocom/ranap/ranap_common.h>
+#include <osmocom/hnbgw/hnb.h>
#include <osmocom/hnbgw/hnbgw.h>
#include <osmocom/hnbgw/hnbgw_cn.h>
#include <osmocom/hnbgw/hnbgw_pfcp.h>
diff --git a/src/osmo-hnbgw/umts_cell_id.c b/src/osmo-hnbgw/umts_cell_id.c
new file mode 100644
index 0000000..2e2af2d
--- /dev/null
+++ b/src/osmo-hnbgw/umts_cell_id.c
@@ -0,0 +1,107 @@
+/* UMTS Cell ID */
+
+/* (C) 2015,2024 by Harald Welte <laforge(a)gnumonks.org>
+ * (C) 2016-2025 by sysmocom s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved
+ *
+ * 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 Affero 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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+ #include "config.h"
+
+#include <unistd.h>
+#include <errno.h>
+#include <inttypes.h>
+
+#include <osmocom/core/talloc.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/jhash.h>
+
+#include <osmocom/gsm/gsm23003.h>
+
+#include <osmocom/hnbgw/umts_cell_id.h>
+
+int umts_cell_id_to_str_buf(char *buf, size_t buflen, const struct umts_cell_id *ucid)
+{
+ struct osmo_strbuf sb = { .buf = buf, .len = buflen };
+ OSMO_STRBUF_APPEND_NOLEN(sb, osmo_plmn_name_buf, &ucid->plmn);
+ OSMO_STRBUF_PRINTF(sb, "-L%u-R%u-S%u-C%u", ucid->lac, ucid->rac, ucid->sac, ucid->cid);
+ return sb.chars_needed;
+}
+
+char *umts_cell_id_to_str_c(void *ctx, const struct umts_cell_id *ucid)
+{
+ OSMO_NAME_C_IMPL(ctx, 64, "ERROR", umts_cell_id_to_str_buf, ucid)
+}
+
+const char *umts_cell_id_to_str(const struct umts_cell_id *ucid)
+{
+ return umts_cell_id_to_str_c(OTC_SELECT, ucid);
+}
+
+/* Useful to index a hash table by struct umts_cell_id. */
+uint32_t umts_cell_id_hash(const struct umts_cell_id *ucid)
+{
+ return osmo_jhash(ucid, sizeof(*ucid), 0x423423);
+}
+
+/* parse a string representation of an umts_cell_id into its decoded representation */
+int umts_cell_id_from_str(struct umts_cell_id *ucid, const char *instr)
+{
+ int rc;
+ char buf[4];
+ const char *pos = instr;
+ const char *end;
+
+ /* We want to use struct umts_cell_id as hashtable key. If it ever happens to contain any padding bytes, make
+ * sure everything is deterministically zero. */
+ memset(ucid, 0, sizeof(*ucid));
+
+ /* read MCC */
+ end = strchr(pos, '-');
+ if (!end || end <= pos || (end - pos) >= sizeof(buf))
+ return -EINVAL;
+ osmo_strlcpy(buf, pos, end - pos + 1);
+ if (osmo_mcc_from_str(buf, &ucid->plmn.mcc))
+ return -EINVAL;
+ pos = end + 1;
+
+ /* read MNC -- here the number of leading zeros matters. */
+ end = strchr(pos, '-');
+ if (!end || end == pos || (end - pos) >= sizeof(buf))
+ return -EINVAL;
+ osmo_strlcpy(buf, pos, end - pos + 1);
+ if (osmo_mnc_from_str(buf, &ucid->plmn.mnc, &ucid->plmn.mnc_3_digits))
+ return -EINVAL;
+ pos = end + 1;
+
+ /* parse the rest, where leading zeros do not matter */
+ rc = sscanf(pos, "L%" SCNu16 "-R%" SCNu8 "-S%" SCNu16 "-C%" SCNu32 "",
+ &ucid->lac, &ucid->rac, &ucid->sac, &ucid->cid);
+ if (rc < 0)
+ return -errno;
+
+ if (rc != 4)
+ return -EINVAL;
+
+ if (ucid->lac == 0 || ucid->lac == 0xffff)
+ return -EINVAL;
+
+ /* CellIdentity in the ASN.1 syntax is a bit-string of 28 bits length */
+ if (ucid->cid >= (1 << 28))
+ return -EINVAL;
+
+ return 0;
+}
diff --git a/tests/ranap_rab_ass/ranap_rab_ass_test.c b/tests/ranap_rab_ass/ranap_rab_ass_test.c
index 76a3430..a656776 100644
--- a/tests/ranap_rab_ass/ranap_rab_ass_test.c
+++ b/tests/ranap_rab_ass/ranap_rab_ass_test.c
@@ -24,15 +24,18 @@
#include <osmocom/core/utils.h>
#include <osmocom/core/socket.h>
#include <osmocom/core/sockaddr_str.h>
-#include <osmocom/hnbgw/hnbgw.h>
+
#include <osmocom/ranap/ranap_ies_defs.h>
#include <osmocom/ranap/iu_helpers.h>
-#include <osmocom/hnbgw/ranap_rab_ass.h>
#include <osmocom/ranap/ranap_common.h>
#include <osmocom/ranap/ranap_common_cn.h>
#include <osmocom/ranap/ranap_common_ran.h>
+#include <osmocom/hnbgw/hnb.h>
+#include <osmocom/hnbgw/hnbgw.h>
+#include <osmocom/hnbgw/ranap_rab_ass.h>
+
static void *msgb_ctx;
extern void *talloc_asn1_ctx;
diff --git a/tests/umts_cell_id/umts_cell_id_test.c b/tests/umts_cell_id/umts_cell_id_test.c
index 18c176a..0dbdd84 100644
--- a/tests/umts_cell_id/umts_cell_id_test.c
+++ b/tests/umts_cell_id/umts_cell_id_test.c
@@ -1,6 +1,9 @@
#include <stdio.h>
+#include <errno.h>
-#include <osmocom/hnbgw/hnbgw.h>
+#include <osmocom/core/utils.h>
+
+#include <osmocom/hnbgw/umts_cell_id.h>
struct test {
const char *id_str;
--
To view, visit https://gerrit.osmocom.org/c/osmo-hnbgw/+/40254?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: newchange
Gerrit-Project: osmo-hnbgw
Gerrit-Branch: master
Gerrit-Change-Id: I4ff65d14f94d99a57316c2483c92244078bb5dd9
Gerrit-Change-Number: 40254
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
2 months
- 1
- 0
[S] Change in osmo-hnbgw[master]: sccp: Introduce UL-related cnlink rate counters
by pespin
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-hnbgw/+/40252?usp=email )
Change subject: sccp: Introduce UL-related cnlink rate counters
......................................................................
sccp: Introduce UL-related cnlink rate counters
Change-Id: I1878fcc8c265dc4d457332e16556d3ece769ea3e
---
M include/osmocom/hnbgw/hnbgw_cn.h
M src/osmo-hnbgw/cnlink.c
M src/osmo-hnbgw/context_map_sccp.c
M src/osmo-hnbgw/hnbgw_cn.c
4 files changed, 24 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-hnbgw refs/changes/52/40252/1
diff --git a/include/osmocom/hnbgw/hnbgw_cn.h b/include/osmocom/hnbgw/hnbgw_cn.h
index 917cc07..fc33e5b 100644
--- a/include/osmocom/hnbgw/hnbgw_cn.h
+++ b/include/osmocom/hnbgw/hnbgw_cn.h
@@ -57,9 +57,13 @@
CNLINK_CTR_RANAP_TX_UDT_RESET_ACK,
/* SCCP Counters: */
+ CNLINK_CTR_SCCP_N_UNITDATA_REQ,
CNLINK_CTR_SCCP_N_UNITDATA_IND,
+ CNLINK_CTR_SCCP_N_CONNECT_REQ,
CNLINK_CTR_SCCP_N_CONNECT_CNF,
+ CNLINK_CTR_SCCP_N_DATA_REQ,
CNLINK_CTR_SCCP_N_DATA_IND,
+ CNLINK_CTR_SCCP_N_DISCONNECT_REQ,
CNLINK_CTR_SCCP_N_DISCONNECT_IND,
CNLINK_CTR_SCCP_N_PCSTATE_IND,
CNLINK_CTR_SCCP_RLSD_CN_ORIGIN,
diff --git a/src/osmo-hnbgw/cnlink.c b/src/osmo-hnbgw/cnlink.c
index 477bd68..46f53d7 100644
--- a/src/osmo-hnbgw/cnlink.c
+++ b/src/osmo-hnbgw/cnlink.c
@@ -140,6 +140,7 @@
static int hnbgw_cnlink_tx_sccp_unitdata_req(struct hnbgw_cnlink *cnlink, struct msgb *msg)
{
+ CNLINK_CTR_INC(cnlink, CNLINK_CTR_SCCP_N_UNITDATA_REQ);
return hnbgw_sccp_user_tx_unitdata_req(cnlink->hnbgw_sccp_user,
&cnlink->remote_addr,
msg);
diff --git a/src/osmo-hnbgw/context_map_sccp.c b/src/osmo-hnbgw/context_map_sccp.c
index 3c97789..5b5e77f 100644
--- a/src/osmo-hnbgw/context_map_sccp.c
+++ b/src/osmo-hnbgw/context_map_sccp.c
@@ -128,6 +128,7 @@
ranap_msg = hnbgw_ranap_msg_alloc("SCCP-CR-empty");
}
+ CNLINK_CTR_INC(map->cnlink, CNLINK_CTR_SCCP_N_CONNECT_REQ);
return hnbgw_sccp_user_tx_connect_req(map->cnlink->hnbgw_sccp_user,
&map->cnlink->remote_addr,
map->scu_conn_id,
@@ -146,6 +147,7 @@
return -1;
}
+ CNLINK_CTR_INC(map->cnlink, CNLINK_CTR_SCCP_N_DATA_REQ);
return hnbgw_sccp_user_tx_data_req(map->cnlink->hnbgw_sccp_user,
map->scu_conn_id,
ranap_msg);
@@ -160,6 +162,7 @@
return -1;
}
+ CNLINK_CTR_INC(map->cnlink, CNLINK_CTR_SCCP_N_DISCONNECT_REQ);
return hnbgw_sccp_user_tx_disconnect_req(map->cnlink->hnbgw_sccp_user,
map->scu_conn_id);
}
diff --git a/src/osmo-hnbgw/hnbgw_cn.c b/src/osmo-hnbgw/hnbgw_cn.c
index 8a7f88e..121c77f 100644
--- a/src/osmo-hnbgw/hnbgw_cn.c
+++ b/src/osmo-hnbgw/hnbgw_cn.c
@@ -462,18 +462,34 @@
},
/* SCCP Counters: */
+ [CNLINK_CTR_SCCP_N_UNITDATA_REQ] = {
+ "sccp:n_unit_data:req",
+ "Submit SCCP N-UNITDATA.req (UL)"
+ },
[CNLINK_CTR_SCCP_N_UNITDATA_IND] = {
"sccp:n_unit_data:ind",
"Received SCCP N-UNITDATA.ind (DL)"
},
+ [CNLINK_CTR_SCCP_N_CONNECT_REQ] = {
+ "sccp:n_connect:req",
+ "Submit SCCP N-CONNECT.req (UL SCCP CR)"
+ },
[CNLINK_CTR_SCCP_N_CONNECT_CNF] = {
"sccp:n_connect:cnf",
"Received SCCP N-CONNECT.cnf (DL SCCP CC)"
},
+ [CNLINK_CTR_SCCP_N_DATA_REQ] = {
+ "sccp:n_data:req",
+ "SUBMIT SCCP N-DATA.req (UL)"
+ },
[CNLINK_CTR_SCCP_N_DATA_IND] = {
"sccp:n_data:ind",
"Received SCCP N-DATA.ind (DL)"
},
+ [CNLINK_CTR_SCCP_N_DISCONNECT_REQ] = {
+ "sccp:n_disconnect:req",
+ "Submit SCCP N-DISCONNECT.req (UL SCCP RLC)"
+ },
[CNLINK_CTR_SCCP_N_DISCONNECT_IND] = {
"sccp:n_disconnect:ind",
"Received SCCP N-DISCONNECT.ind (DL SCCP RLSD)"
--
To view, visit https://gerrit.osmocom.org/c/osmo-hnbgw/+/40252?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: newchange
Gerrit-Project: osmo-hnbgw
Gerrit-Branch: master
Gerrit-Change-Id: I1878fcc8c265dc4d457332e16556d3ece769ea3e
Gerrit-Change-Number: 40252
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
2 months
- 1
- 0
[M] Change in osmo-hnbgw[master]: sccp: Unify path submitting N-*.req
by pespin
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-hnbgw/+/40251?usp=email )
Change subject: sccp: Unify path submitting N-*.req
......................................................................
sccp: Unify path submitting N-*.req
This allows having clearer code paths and adding rate counters.
Change-Id: I37b414cf769a16b7c7f596df3bb91a6a91a06298
---
M include/osmocom/hnbgw/hnbgw_sccp.h
M src/osmo-hnbgw/cnlink.c
M src/osmo-hnbgw/context_map_sccp.c
M src/osmo-hnbgw/hnbgw_sccp.c
4 files changed, 113 insertions(+), 35 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-hnbgw refs/changes/51/40251/1
diff --git a/include/osmocom/hnbgw/hnbgw_sccp.h b/include/osmocom/hnbgw/hnbgw_sccp.h
index fbb84f4..d207348 100644
--- a/include/osmocom/hnbgw/hnbgw_sccp.h
+++ b/include/osmocom/hnbgw/hnbgw_sccp.h
@@ -1,9 +1,12 @@
/* SCCP, ITU Q.711 - Q.714 */
#pragma once
+#include <stdint.h>
+
#include <osmocom/core/hashtable.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/prim.h>
+#include <osmocom/core/msgb.h>
#include <osmocom/core/use_count.h>
#include <osmocom/sigtran/sccp_sap.h>
@@ -46,3 +49,11 @@
OSMO_ASSERT(osmo_use_count_get_put(&(hsu)->use_count, use, -1) == 0)
struct hnbgw_sccp_user *hnbgw_sccp_user_alloc(int ss7_inst_id);
+
+int hnbgw_sccp_user_tx_unitdata_req(struct hnbgw_sccp_user *hsu, const struct osmo_sccp_addr *called_addr,
+ struct msgb *ranap_msg);
+int hnbgw_sccp_user_tx_connect_req(struct hnbgw_sccp_user *hsu, const struct osmo_sccp_addr *called_addr,
+ uint32_t scu_conn_id, struct msgb *ranap_msg);
+int hnbgw_sccp_user_tx_data_req(struct hnbgw_sccp_user *hsu, uint32_t scu_conn_id,
+ struct msgb *ranap_msg);
+int hnbgw_sccp_user_tx_disconnect_req(struct hnbgw_sccp_user *hsu, uint32_t scu_conn_id);
diff --git a/src/osmo-hnbgw/cnlink.c b/src/osmo-hnbgw/cnlink.c
index 137012a..477bd68 100644
--- a/src/osmo-hnbgw/cnlink.c
+++ b/src/osmo-hnbgw/cnlink.c
@@ -138,6 +138,13 @@
context_map_cnlink_lost(map);
}
+static int hnbgw_cnlink_tx_sccp_unitdata_req(struct hnbgw_cnlink *cnlink, struct msgb *msg)
+{
+ return hnbgw_sccp_user_tx_unitdata_req(cnlink->hnbgw_sccp_user,
+ &cnlink->remote_addr,
+ msg);
+}
+
static void tx_reset(struct hnbgw_cnlink *cnlink)
{
struct msgb *msg;
@@ -192,10 +199,7 @@
msg = ranap_new_msg_reset2(cnlink->pool->domain, &cause, use_grnc_id);
CNLINK_CTR_INC(cnlink, CNLINK_CTR_RANAP_TX_UDT_RESET);
- osmo_sccp_tx_unitdata_msg(cnlink->hnbgw_sccp_user->sccp_user,
- &cnlink->hnbgw_sccp_user->local_addr,
- &cnlink->remote_addr,
- msg);
+ hnbgw_cnlink_tx_sccp_unitdata_req(cnlink, msg);
}
static void tx_reset_ack(struct hnbgw_cnlink *cnlink)
@@ -243,10 +247,7 @@
msg = ranap_new_msg_reset_ack(cnlink->pool->domain, use_grnc_id);
CNLINK_CTR_INC(cnlink, CNLINK_CTR_RANAP_TX_UDT_RESET_ACK);
- osmo_sccp_tx_unitdata_msg(cnlink->hnbgw_sccp_user->sccp_user,
- &cnlink->hnbgw_sccp_user->local_addr,
- &cnlink->remote_addr,
- msg);
+ hnbgw_cnlink_tx_sccp_unitdata_req(cnlink, msg);
}
static void cnlink_disc_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
diff --git a/src/osmo-hnbgw/context_map_sccp.c b/src/osmo-hnbgw/context_map_sccp.c
index f0bbe1b..3c97789 100644
--- a/src/osmo-hnbgw/context_map_sccp.c
+++ b/src/osmo-hnbgw/context_map_sccp.c
@@ -117,10 +117,8 @@
static int tx_sccp_cr(struct osmo_fsm_inst *fi, struct msgb *ranap_msg)
{
struct hnbgw_context_map *map = fi->priv;
- struct osmo_scu_prim *prim;
- int rc;
- if (!map->cnlink || !map->cnlink->hnbgw_sccp_user) {
+ if (!map->cnlink) {
LOGPFSML(fi, LOGL_ERROR, "Failed to send SCCP Connection Request: no CN link\n");
return -1;
}
@@ -130,53 +128,40 @@
ranap_msg = hnbgw_ranap_msg_alloc("SCCP-CR-empty");
}
- prim = (struct osmo_scu_prim *)msgb_push(ranap_msg, sizeof(*prim));
- osmo_prim_init(&prim->oph, SCCP_SAP_USER, OSMO_SCU_PRIM_N_CONNECT, PRIM_OP_REQUEST, ranap_msg);
- prim->u.connect.called_addr = map->cnlink->remote_addr;
- prim->u.connect.calling_addr = map->cnlink->hnbgw_sccp_user->local_addr;
- prim->u.connect.sccp_class = 2;
- prim->u.connect.conn_id = map->scu_conn_id;
-
- rc = osmo_sccp_user_sap_down_nofree(map->cnlink->hnbgw_sccp_user->sccp_user, &prim->oph);
- if (rc)
- LOGPFSML(fi, LOGL_ERROR, "Failed to send SCCP Connection Request to CN\n");
- return rc;
+ return hnbgw_sccp_user_tx_connect_req(map->cnlink->hnbgw_sccp_user,
+ &map->cnlink->remote_addr,
+ map->scu_conn_id,
+ ranap_msg);
}
static int tx_sccp_df1(struct osmo_fsm_inst *fi, struct msgb *ranap_msg)
{
struct hnbgw_context_map *map = fi->priv;
- struct osmo_scu_prim *prim;
- int rc;
if (!msg_has_l2_data(ranap_msg))
return 0;
- if (!map->cnlink || !map->cnlink->hnbgw_sccp_user) {
+ if (!map->cnlink) {
LOGPFSML(fi, LOGL_ERROR, "Failed to send SCCP Data Form 1: no CN link\n");
return -1;
}
- prim = (struct osmo_scu_prim *)msgb_push(ranap_msg, sizeof(*prim));
- osmo_prim_init(&prim->oph, SCCP_SAP_USER, OSMO_SCU_PRIM_N_DATA, PRIM_OP_REQUEST, ranap_msg);
- prim->u.data.conn_id = map->scu_conn_id;
-
- rc = osmo_sccp_user_sap_down_nofree(map->cnlink->hnbgw_sccp_user->sccp_user, &prim->oph);
- if (rc)
- LOGPFSML(fi, LOGL_ERROR, "Failed to send SCCP Data Form 1 to CN\n");
- return rc;
+ return hnbgw_sccp_user_tx_data_req(map->cnlink->hnbgw_sccp_user,
+ map->scu_conn_id,
+ ranap_msg);
}
static int tx_sccp_rlsd(struct osmo_fsm_inst *fi)
{
struct hnbgw_context_map *map = fi->priv;
- if (!map->cnlink || !map->cnlink->hnbgw_sccp_user) {
+ if (!map->cnlink) {
LOGPFSML(fi, LOGL_ERROR, "Failed to send SCCP RLSD: no CN link\n");
return -1;
}
- return osmo_sccp_tx_disconn(map->cnlink->hnbgw_sccp_user->sccp_user, map->scu_conn_id, NULL, 0);
+ return hnbgw_sccp_user_tx_disconnect_req(map->cnlink->hnbgw_sccp_user,
+ map->scu_conn_id);
}
static int handle_rx_sccp(struct osmo_fsm_inst *fi, struct msgb *ranap_msg)
diff --git a/src/osmo-hnbgw/hnbgw_sccp.c b/src/osmo-hnbgw/hnbgw_sccp.c
index 999ebde..4699b2f 100644
--- a/src/osmo-hnbgw/hnbgw_sccp.c
+++ b/src/osmo-hnbgw/hnbgw_sccp.c
@@ -340,6 +340,87 @@
return rc;
}
+/***********************************************************************
+ * Submit primitives to SCCP User SAP
+ ***********************************************************************/
+
+int hnbgw_sccp_user_tx_unitdata_req(struct hnbgw_sccp_user *hsu, const struct osmo_sccp_addr *called_addr, struct msgb *ranap_msg)
+{
+ if (!hsu) {
+ LOGP(DCN, LOGL_ERROR, "Failed to send SCCP N-UNITDATA.req: no SCCP User\n");
+ return -1;
+ }
+ OSMO_ASSERT(called_addr);
+ return osmo_sccp_tx_unitdata_msg(hsu->sccp_user,
+ &hsu->local_addr,
+ called_addr,
+ ranap_msg);
+}
+
+int hnbgw_sccp_user_tx_connect_req(struct hnbgw_sccp_user *hsu, const struct osmo_sccp_addr *called_addr, uint32_t scu_conn_id, struct msgb *ranap_msg)
+{
+ struct osmo_scu_prim *prim;
+ int rc;
+
+ if (!hsu) {
+ LOGP(DCN, LOGL_ERROR, "Failed to send SCCP N-CONNECT.req(%u): no SCCP User\n", scu_conn_id);
+ return -1;
+ }
+
+ OSMO_ASSERT(called_addr);
+
+ prim = (struct osmo_scu_prim *)msgb_push(ranap_msg, sizeof(*prim));
+ osmo_prim_init(&prim->oph, SCCP_SAP_USER, OSMO_SCU_PRIM_N_CONNECT, PRIM_OP_REQUEST, ranap_msg);
+ prim->u.connect.called_addr = *called_addr;
+ prim->u.connect.calling_addr = hsu->local_addr;
+ prim->u.connect.sccp_class = 2;
+ prim->u.connect.conn_id = scu_conn_id;
+
+ rc = osmo_sccp_user_sap_down_nofree(hsu->sccp_user, &prim->oph);
+ if (rc)
+ LOG_HSU(hsu, DCN, LOGL_ERROR, "Failed to send SCCP Connection Request to CN\n");
+ return rc;
+}
+
+int hnbgw_sccp_user_tx_data_req(struct hnbgw_sccp_user *hsu, uint32_t scu_conn_id, struct msgb *ranap_msg)
+{
+ struct osmo_scu_prim *prim;
+ int rc;
+
+ if (!hsu) {
+ LOGP(DCN, LOGL_ERROR, "Failed to send SCCP N-DATA.req(%u): no SCCP User\n", scu_conn_id);
+ return -1;
+ }
+
+ prim = (struct osmo_scu_prim *)msgb_push(ranap_msg, sizeof(*prim));
+ osmo_prim_init(&prim->oph, SCCP_SAP_USER, OSMO_SCU_PRIM_N_DATA, PRIM_OP_REQUEST, ranap_msg);
+ prim->u.data.conn_id = scu_conn_id;
+
+ rc = osmo_sccp_user_sap_down_nofree(hsu->sccp_user, &prim->oph);
+ if (rc)
+ LOG_HSU(hsu, DCN, LOGL_ERROR, "Failed to send SCCP N-DATA.req(%u)\n", scu_conn_id);
+ return rc;
+}
+
+int hnbgw_sccp_user_tx_disconnect_req(struct hnbgw_sccp_user *hsu, uint32_t scu_conn_id)
+{
+ int rc;
+
+ if (!hsu) {
+ LOGP(DCN, LOGL_ERROR, "Failed to send SCCP N-DISCONNECT.req(%u): no SCCP User\n", scu_conn_id);
+ return -1;
+ }
+
+ rc = osmo_sccp_tx_disconn(hsu->sccp_user, scu_conn_id, NULL, 0);
+ if (rc)
+ LOG_HSU(hsu, DCN, LOGL_ERROR, "Failed to send SCCP N-DISCONNECT.req(%u)\n", scu_conn_id);
+ return rc;
+}
+
+/***********************************************************************
+ * struct hnbgw_sccp_user lifecycle:
+ ***********************************************************************/
+
static int hnbgw_sccp_user_use_cb(struct osmo_use_count_entry *e, int32_t old_use_count, const char *file, int line)
{
struct hnbgw_sccp_user *hsu = e->use_count->talloc_object;
--
To view, visit https://gerrit.osmocom.org/c/osmo-hnbgw/+/40251?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: newchange
Gerrit-Project: osmo-hnbgw
Gerrit-Branch: master
Gerrit-Change-Id: I37b414cf769a16b7c7f596df3bb91a6a91a06298
Gerrit-Change-Number: 40251
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
2 months
- 1
- 0
[M] Change in osmo-ttcn3-hacks[master]: gbproxy: sync configs with docker-playground
by fixeria
Attention is currently required from: osmith.
fixeria has posted comments on this change by osmith. ( https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/40239?usp=email )
Change subject: gbproxy: sync configs with docker-playground
......................................................................
Patch Set 1: Code-Review+1
--
To view, visit https://gerrit.osmocom.org/c/osmo-ttcn3-hacks/+/40239?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: osmo-ttcn3-hacks
Gerrit-Branch: master
Gerrit-Change-Id: Ibef7e870c5c90d1cc861c89904950b1ac68dc9b2
Gerrit-Change-Number: 40239
Gerrit-PatchSet: 1
Gerrit-Owner: osmith <osmith(a)sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-Attention: osmith <osmith(a)sysmocom.de>
Gerrit-Comment-Date: Wed, 07 May 2025 18:24:36 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
2 months
- 1
- 0
[L] Change in pysim[master]: Get rid of [now] superfluous HexAdapter
by fixeria
Attention is currently required from: dexter, laforge.
fixeria has posted comments on this change by laforge. ( https://gerrit.osmocom.org/c/pysim/+/40237?usp=email )
Change subject: Get rid of [now] superfluous HexAdapter
......................................................................
Patch Set 4: Code-Review+1
--
To view, visit https://gerrit.osmocom.org/c/pysim/+/40237?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: pysim
Gerrit-Branch: master
Gerrit-Change-Id: I9c77e420c314f5e74458628dc4e767eab6d97123
Gerrit-Change-Number: 40237
Gerrit-PatchSet: 4
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de>
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Attention: laforge <laforge(a)osmocom.org>
Gerrit-Attention: dexter <pmaier(a)sysmocom.de>
Gerrit-Comment-Date: Wed, 07 May 2025 18:19:35 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
2 months
- 1
- 0
[M] Change in pysim[master]: docs: Better python doc-strings for better pySim.esim manual
by laforge
laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/40236?usp=email )
Change subject: docs: Better python doc-strings for better pySim.esim manual
......................................................................
docs: Better python doc-strings for better pySim.esim manual
Change-Id: I7be6264c665a2a25105681bb5e72d0f6715bbef8
---
M pySim/esim/__init__.py
M pySim/esim/bsp.py
M pySim/esim/es8p.py
M pySim/esim/rsp.py
M pySim/esim/saip/__init__.py
M pySim/esim/saip/oid.py
M pySim/esim/saip/personalization.py
M pySim/esim/saip/templates.py
M pySim/esim/saip/validation.py
M pySim/esim/x509_cert.py
10 files changed, 87 insertions(+), 50 deletions(-)
Approvals:
laforge: Looks good to me, approved
fixeria: Looks good to me, but someone else must approve
Jenkins Builder: Verified
diff --git a/pySim/esim/__init__.py b/pySim/esim/__init__.py
index 29e2bf4..35b733e 100644
--- a/pySim/esim/__init__.py
+++ b/pySim/esim/__init__.py
@@ -61,8 +61,8 @@
return asn1tools.compile_string(asn_txt, codec=codec)
-# SGP.22 section 4.1 Activation Code
class ActivationCode:
+ """SGP.22 section 4.1 Activation Code"""
def __init__(self, hostname:str, token:str, oid: Optional[str] = None, cc_required: Optional[bool] = False):
if '$' in hostname:
raise ValueError('$ sign not permitted in hostname')
@@ -78,6 +78,7 @@
@staticmethod
def decode_str(ac: str) -> dict:
+ """decode an activation code from its string representation."""
if ac[0] != '1':
raise ValueError("Unsupported AC_Format '%s'!" % ac[0])
ac_elements = ac.split('$')
diff --git a/pySim/esim/bsp.py b/pySim/esim/bsp.py
index 862502f..fb4c0b3 100644
--- a/pySim/esim/bsp.py
+++ b/pySim/esim/bsp.py
@@ -1,11 +1,9 @@
-# Early proof-of-concept implementation of
-# GSMA eSIM RSP (Remote SIM Provisioning BSP (BPP Protection Protocol),
-# where BPP is the Bound Profile Package. So the full expansion is the
-# "GSMA eSIM Remote SIM Provisioning Bound Profile Packate Protection Protocol"
-#
-# Originally (SGP.22 v2.x) this was called SCP03t, but it has since been
-# renamed to BSP.
-#
+"""Implementation of GSMA eSIM RSP (Remote SIM Provisioning BSP (BPP Protection Protocol),
+where BPP is the Bound Profile Package. So the full expansion is the
+"GSMA eSIM Remote SIM Provisioning Bound Profile Packate Protection Protocol"
+
+Originally (SGP.22 v2.x) this was called SCP03t, but it has since been renamed to BSP."""
+
# (C) 2023 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
@@ -45,6 +43,7 @@
MAX_SEGMENT_SIZE = 1020
class BspAlgo(abc.ABC):
+ """Base class representing a cryptographic algorithm within the BSP (BPP Security Protocol)."""
blocksize: int
def _get_padding(self, in_len: int, multiple: int, padding: int = 0) -> bytes:
@@ -62,6 +61,7 @@
return self.__class__.__name__
class BspAlgoCrypt(BspAlgo, abc.ABC):
+ """Base class representing an encryption/decryption algorithm within the BSP (BPP Security Protocol)."""
def __init__(self, s_enc: bytes):
self.s_enc = s_enc
@@ -93,6 +93,7 @@
"""Actual implementation, to be implemented by derived class."""
class BspAlgoCryptAES128(BspAlgoCrypt):
+ """AES-CBC-128 implementation of the BPP Security Protocol for GSMA SGP.22 eSIM."""
name = 'AES-CBC-128'
blocksize = 16
@@ -133,6 +134,7 @@
class BspAlgoMac(BspAlgo, abc.ABC):
+ """Base class representing a message authentication code algorithm within the BSP (BPP Security Protocol)."""
l_mac = 0 # must be overridden by derived class
def __init__(self, s_mac: bytes, initial_mac_chaining_value: bytes):
@@ -167,6 +169,7 @@
"""To be implemented by algorithm specific derived class."""
class BspAlgoMacAES128(BspAlgoMac):
+ """AES-CMAC-128 implementation of the BPP Security Protocol for GSMA SGP.22 eSIM."""
name = 'AES-CMAC-128'
l_mac = 8
diff --git a/pySim/esim/es8p.py b/pySim/esim/es8p.py
index dd0c4bc..8bd7e14 100644
--- a/pySim/esim/es8p.py
+++ b/pySim/esim/es8p.py
@@ -1,6 +1,5 @@
-# Implementation of GSMA eSIM RSP (Remote SIM Provisioning) ES8+
-# as per SGP22 v3.0 Section 5.5
-#
+"""Implementation of GSMA eSIM RSP (Remote SIM Provisioning) ES8+ as per SGP22 v3.0 Section 5.5"""
+
# (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
diff --git a/pySim/esim/rsp.py b/pySim/esim/rsp.py
index 4b189e1..3dccf2d 100644
--- a/pySim/esim/rsp.py
+++ b/pySim/esim/rsp.py
@@ -1,6 +1,5 @@
-# Implementation of GSMA eSIM RSP (Remote SIM Provisioning)
-# as per SGP22 v3.0
-#
+"""Implementation of GSMA eSIM RSP (Remote SIM Provisioning) as per SGP22 v3.0"""
+
# (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
diff --git a/pySim/esim/saip/__init__.py b/pySim/esim/saip/__init__.py
index 21f44ef..305a373 100644
--- a/pySim/esim/saip/__init__.py
+++ b/pySim/esim/saip/__init__.py
@@ -1,5 +1,5 @@
-# Implementation of SimAlliance/TCA Interoperable Profile handling
-#
+"""Implementation of SimAlliance/TCA Interoperable Profile handling"""
+
# (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
@@ -45,7 +45,7 @@
logger = logging.getLogger(__name__)
class Naa:
- """A class defining a Network Access Application (NAA)."""
+ """A class defining a Network Access Application (NAA)"""
name = None
# AID prefix, as used for ADF and EF.DIR
aid = None
@@ -61,6 +61,7 @@
return 'adf-' + cls.mandatory_services[0]
class NaaCsim(Naa):
+ """A class representing the CSIM (CDMA) Network Access Application (NAA)"""
name = "csim"
aid = h2b("")
mandatory_services = ["csim"]
@@ -68,6 +69,7 @@
templates = [oid.ADF_CSIM_by_default, oid.ADF_CSIMopt_not_by_default]
class NaaUsim(Naa):
+ """A class representing the USIM Network Access Application (NAA)"""
name = "usim"
aid = h2b("a0000000871002")
mandatory_services = ["usim"]
@@ -80,6 +82,7 @@
adf = ADF_USIM()
class NaaIsim(Naa):
+ """A class representing the ISIM Network Access Application (NAA)"""
name = "isim"
aid = h2b("a0000000871004")
mandatory_services = ["isim"]
@@ -750,6 +753,7 @@
class ProfileElementMF(FsProfileElement):
+ """Class representing the ProfileElement for the MF (Master File)"""
type = 'mf'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -763,6 +767,7 @@
# TODO: resize EF.DIR?
class ProfileElementPuk(ProfileElement):
+ """Class representing the ProfileElement for a PUK (PIN Unblocking Code)"""
type = 'pukCodes'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -793,6 +798,7 @@
class ProfileElementPin(ProfileElement):
+ """Class representing the ProfileElement for a PIN (Personal Identification Number)"""
type = 'pinCodes'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -829,6 +835,7 @@
class ProfileElementTelecom(FsProfileElement):
+ """Class representing the ProfileElement for DF.TELECOM"""
type = 'telecom'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -841,6 +848,7 @@
self.decoded[fname] = []
class ProfileElementCD(FsProfileElement):
+ """Class representing the ProfileElement for DF.CD"""
type = 'cd'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -853,6 +861,7 @@
self.decoded[fname] = []
class ProfileElementPhonebook(FsProfileElement):
+ """Class representing the ProfileElement for DF.PHONEBOOK"""
type = 'phonebook'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -865,6 +874,7 @@
self.decoded[fname] = []
class ProfileElementGsmAccess(FsProfileElement):
+ """Class representing the ProfileElement for ADF.USIM/DF.GSM-ACCESS"""
type = 'gsm-access'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -877,6 +887,7 @@
self.decoded[fname] = []
class ProfileElementDf5GS(FsProfileElement):
+ """Class representing the ProfileElement for ADF.USIM/DF.5GS"""
type = 'df-5gs'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -889,6 +900,7 @@
self.decoded[fname] = []
class ProfileElementEAP(FsProfileElement):
+ """Class representing the ProfileElement for DF.EAP"""
type = 'eap'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -901,6 +913,7 @@
self.decoded[fname] = []
class ProfileElementDfSAIP(FsProfileElement):
+ """Class representing the ProfileElement for DF.SAIP"""
type = 'df-saip'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -913,6 +926,7 @@
self.decoded[fname] = []
class ProfileElementDfSNPN(FsProfileElement):
+ """Class representing the ProfileElement for DF.SNPN"""
type = 'df-snpn'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -925,6 +939,7 @@
self.decoded[fname] = []
class ProfileElementDf5GProSe(FsProfileElement):
+ """Class representing the ProfileElement for DF.5GProSe"""
type = 'df-5gprose'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -1218,6 +1233,7 @@
class ProfileElementRFM(ProfileElement):
+ """Class representing the ProfileElement for RFM (Remote File Management)."""
type = 'rfm'
def __init__(self, decoded: Optional[dict] = None,
@@ -1243,6 +1259,7 @@
}
class ProfileElementUSIM(FsProfileElement):
+ """Class representing the ProfileElement for ADF.USIM Mandatory Files"""
type = 'usim'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -1265,6 +1282,7 @@
return dec_imsi(b2h(f.body))
class ProfileElementOptUSIM(FsProfileElement):
+ """Class representing the ProfileElement for ADF.USIM Optional Files"""
type = 'opt-usim'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -1275,6 +1293,7 @@
self.decoded['templateID'] = str(oid.ADF_USIMopt_not_by_default_v2)
class ProfileElementISIM(FsProfileElement):
+ """Class representing the ProfileElement for ADF.ISIM Mandatory Files"""
type = 'isim'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -1291,6 +1310,7 @@
return b2h(self.decoded['adf-isim'][0][1]['dfName'])
class ProfileElementOptISIM(FsProfileElement):
+ """Class representing the ProfileElement for ADF.ISIM Optional Files"""
type = 'opt-isim'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
@@ -1302,6 +1322,7 @@
class ProfileElementAKA(ProfileElement):
+ """Class representing the ProfileElement for Authentication and Key Agreement (AKA)."""
type = 'akaParameter'
# TODO: RES size for USIM test algorithm can be set to 32, 64 or 128 bits. This value was
# previously limited to 128 bits. Recommendation: Avoid using RES size 32 or 64 in Profiles
@@ -1381,6 +1402,7 @@
})
class ProfileElementHeader(ProfileElement):
+ """Class representing the ProfileElement for the Header of the PE-Sequence."""
type = 'header'
def __init__(self, decoded: Optional[dict] = None,
ver_major: Optional[int] = 2, ver_minor: Optional[int] = 3,
@@ -1421,6 +1443,7 @@
raise ValueError("service not in eUICC-Mandatory-services list, cannot remove")
class ProfileElementEnd(ProfileElement):
+ """Class representing the ProfileElement for the End of the PE-Sequence."""
type = 'end'
def __init__(self, decoded: Optional[dict] = None, **kwargs):
super().__init__(decoded, **kwargs)
diff --git a/pySim/esim/saip/oid.py b/pySim/esim/saip/oid.py
index 02ef23b..a9c23e2 100644
--- a/pySim/esim/saip/oid.py
+++ b/pySim/esim/saip/oid.py
@@ -1,5 +1,5 @@
-# Implementation of SimAlliance/TCA Interoperable Profile OIDs
-#
+"""Implementation of SimAlliance/TCA Interoperable Profile OIDs"""
+
# (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
diff --git a/pySim/esim/saip/personalization.py b/pySim/esim/saip/personalization.py
index cd23944..053ea0c 100644
--- a/pySim/esim/saip/personalization.py
+++ b/pySim/esim/saip/personalization.py
@@ -1,5 +1,5 @@
-# Implementation of SimAlliance/TCA Interoperable Profile handling
-#
+"""Implementation of Personalization of eSIM profiles in SimAlliance/TCA Interoperable Profile."""
+
# (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
diff --git a/pySim/esim/saip/templates.py b/pySim/esim/saip/templates.py
index 3ec0b9b..2c0a8f0 100644
--- a/pySim/esim/saip/templates.py
+++ b/pySim/esim/saip/templates.py
@@ -1,5 +1,5 @@
-# Implementation of SimAlliance/TCA Interoperable Profile Template handling
-#
+"""Implementation of SimAlliance/TCA Interoperable Profile Templates."""
+
# (C) 2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
@@ -224,8 +224,8 @@
# below are transcribed template definitions from "ANNEX A (Normative): File Structure Templates Definition"
# of "Profile interoperability specification V3.3.1 Final" (unless other version explicitly specified).
-# Section 9.2
class FilesAtMF(ProfileTemplate):
+ """Files at MF as per Section 9.2"""
created_by_default = True
oid = OID.MF
files = [
@@ -238,8 +238,8 @@
]
-# Section 9.3
class FilesCD(ProfileTemplate):
+ """Files at DF.CD as per Section 9.3"""
created_by_default = False
oid = OID.DF_CD
files = [
@@ -287,8 +287,8 @@
for i in range(0x98, 0xa0):
df_pb_files.append(FileTemplate(0x4f00+i, 'EF.CCP1', 'LF', None, None, 5, None, 'FF...FF', False, ['nb_rec','size','sfi'], ppath=[0x5f3a]))
-# Section 9.4 v2.3.1
class FilesTelecom(ProfileTemplate):
+ """Files at DF.TELECOM as per Section 9.4 v2.3.1"""
created_by_default = False
oid = OID.DF_TELECOM
base_path = Path('MF')
@@ -328,8 +328,8 @@
]
-# Section 9.4
class FilesTelecomV2(ProfileTemplate):
+ """Files at DF.TELECOM as per Section 9.4"""
created_by_default = False
oid = OID.DF_TELECOM_v2
base_path = Path('MF')
@@ -379,8 +379,8 @@
]
-# Section 9.5.1 v2.3.1
class FilesUsimMandatory(ProfileTemplate):
+ """Mandatory Files at ADF.USIM as per Section 9.5.1 v2.3.1"""
created_by_default = True
oid = OID.ADF_USIM_by_default
files = [
@@ -410,8 +410,8 @@
FileTemplate(0x6fe4, 'EF.EPSNSC', 'LF', 1, 80, 5, 0x18, 'FF...FF', False, ass_serv=[85], high_update=True),
]
-# Section 9.5.1
class FilesUsimMandatoryV2(ProfileTemplate):
+ """Mandatory Files at ADF.USIM as per Section 9.5.1"""
created_by_default = True
oid = OID.ADF_USIM_by_default_v2
files = [
@@ -442,8 +442,8 @@
]
-# Section 9.5.2 v2.3.1
class FilesUsimOptional(ProfileTemplate):
+ """Optional Files at ADF.USIM as per Section 9.5.2 v2.3.1"""
created_by_default = False
optional = True
oid = OID.ADF_USIMopt_not_by_default
@@ -529,6 +529,7 @@
# Section 9.5.2
class FilesUsimOptionalV2(ProfileTemplate):
+ """Optional Files at ADF.USIM as per Section 9.5.2"""
created_by_default = False
optional = True
oid = OID.ADF_USIMopt_not_by_default_v2
@@ -622,8 +623,8 @@
FileTemplate(0x6ffd, 'EF.MudMidCfgdata','BT', None, None,2, None, None, True, ['size'], ass_serv=[134]),
]
-# Section 9.5.2.3 v3.3.1
class FilesUsimOptionalV3(ProfileTemplate):
+ """Optional Files at ADF.USIM as per Section 9.5.2.3 v3.3.1"""
created_by_default = False
optional = True
oid = OID.ADF_USIMopt_not_by_default_v3
@@ -633,16 +634,16 @@
FileTemplate(0x6f01, 'EF.eAKA', 'TR', None, 1, 3, None, None, True, ['size'], ass_serv=[134]),
]
-# Section 9.5.3
class FilesUsimDfPhonebook(ProfileTemplate):
+ """DF.PHONEBOOK Files at ADF.USIM as per Section 9.5.3"""
created_by_default = False
oid = OID.DF_PHONEBOOK_ADF_USIM
base_path = Path('ADF.USIM')
files = df_pb_files
-# Section 9.5.4
class FilesUsimDfGsmAccess(ProfileTemplate):
+ """DF.GSM-ACCESS Files at ADF.USIM as per Section 9.5.4"""
created_by_default = False
oid = OID.DF_GSM_ACCESS_ADF_USIM
base_path = Path('ADF.USIM')
@@ -656,8 +657,8 @@
]
-# Section 9.5.11 v2.3.1
class FilesUsimDf5GS(ProfileTemplate):
+ """DF.5GS Files at ADF.USIM as per Section 9.5.11 v2.3.1"""
created_by_default = False
oid = OID.DF_5GS
base_path = Path('ADF.USIM')
@@ -677,8 +678,8 @@
]
-# Section 9.5.11.2
class FilesUsimDf5GSv2(ProfileTemplate):
+ """DF.5GS Files at ADF.USIM as per Section 9.5.11.2"""
created_by_default = False
oid = OID.DF_5GS_v2
base_path = Path('ADF.USIM')
@@ -700,8 +701,8 @@
]
-# Section 9.5.11.3
class FilesUsimDf5GSv3(ProfileTemplate):
+ """DF.5GS Files at ADF.USIM as per Section 9.5.11.3"""
created_by_default = False
oid = OID.DF_5GS_v3
base_path = Path('ADF.USIM')
@@ -724,8 +725,8 @@
FileTemplate(0x4f0c, 'EF.TN3GPPSNN', 'TR', None, 1, 2, 0x0c, '00', False, ass_serv=[135]),
]
-# Section 9.5.11.4
class FilesUsimDf5GSv4(ProfileTemplate):
+ """DF.5GS Files at ADF.USIM as per Section 9.5.11.4"""
created_by_default = False
oid = OID.DF_5GS_v4
base_path = Path('ADF.USIM')
@@ -756,8 +757,8 @@
]
-# Section 9.5.12
class FilesUsimDfSaip(ProfileTemplate):
+ """DF.SAIP Files at ADF.USIM as per Section 9.5.12"""
created_by_default = False
oid = OID.DF_SAIP
base_path = Path('ADF.USIM')
@@ -767,8 +768,8 @@
FileTemplate(0x4f01, 'EF.SUCICalcInfo','TR', None, None, 3, None, 'FF...FF', False, ['size'], ass_serv=[125], pe_name='ef-suci-calc-info-usim'),
]
-# Section 9.5.13
class FilesDfSnpn(ProfileTemplate):
+ """DF.SNPN Files at ADF.USIM as per Section 9.5.13"""
created_by_default = False
oid = OID.DF_SNPN
base_path = Path('ADF.USIM')
@@ -778,8 +779,8 @@
FileTemplate(0x4f01, 'EF.PWS_SNPN', 'TR', None, 1, 10, None, None, True, ass_serv=[143]),
]
-# Section 9.5.14
class FilesDf5GProSe(ProfileTemplate):
+ """DF.ProSe Files at ADF.USIM as per Section 9.5.14"""
created_by_default = False
oid = OID.DF_5GProSe
base_path = Path('ADF.USIM')
@@ -794,8 +795,8 @@
FileTemplate(0x4f06, 'EF.5G_PROSE_UIR', 'TR', None, 32, 2, 0x06, None, True, ass_serv=[139,1005]),
]
-# Section 9.6.1
class FilesIsimMandatory(ProfileTemplate):
+ """Mandatory Files at ADF.ISIM as per Section 9.6.1"""
created_by_default = True
oid = OID.ADF_ISIM_by_default
files = [
@@ -809,8 +810,8 @@
]
-# Section 9.6.2 v2.3.1
class FilesIsimOptional(ProfileTemplate):
+ """Optional Files at ADF.ISIM as per Section 9.6.2 of v2.3.1"""
created_by_default = False
optional = True
oid = OID.ADF_ISIMopt_not_by_default
@@ -829,8 +830,8 @@
]
-# Section 9.6.2
class FilesIsimOptionalv2(ProfileTemplate):
+ """Optional Files at ADF.ISIM as per Section 9.6.2"""
created_by_default = False
optional = True
oid = OID.ADF_ISIMopt_not_by_default_v2
@@ -857,8 +858,8 @@
# TODO: CSIM
-# Section 9.8
class FilesEap(ProfileTemplate):
+ """Files at DF.EAP as per Section 9.8"""
created_by_default = False
oid = OID.DF_EAP
files = [
diff --git a/pySim/esim/saip/validation.py b/pySim/esim/saip/validation.py
index c253b7a..c115554 100644
--- a/pySim/esim/saip/validation.py
+++ b/pySim/esim/saip/validation.py
@@ -1,5 +1,5 @@
-# Implementation of SimAlliance/TCA Interoperable Profile handling
-#
+"""Implementation of SimAlliance/TCA Interoperable Profile validation."""
+
# (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
@@ -19,16 +19,21 @@
from pySim.esim.saip import *
class ProfileError(Exception):
+ """Raised when a ProfileConstraintChecker finds an error in a file [structure]."""
pass
class ProfileConstraintChecker:
+ """Base class of a constraint checker for a ProfileElementSequence."""
def check(self, pes: ProfileElementSequence):
+ """Execute all the check_* methods of the ProfileConstraintChecker against the given
+ ProfileElementSequence"""
for name in dir(self):
if name.startswith('check_'):
method = getattr(self, name)
method(pes)
class CheckBasicStructure(ProfileConstraintChecker):
+ """ProfileConstraintChecker for the basic profile structure constraints."""
def _is_after_if_exists(self, pes: ProfileElementSequence, opt:str, after:str):
opt_pe = pes.get_pe_for_type(opt)
if opt_pe:
@@ -38,6 +43,7 @@
# FIXME: check order
def check_start_and_end(self, pes: ProfileElementSequence):
+ """Check for mandatory header and end ProfileElements at the right position."""
if pes.pe_list[0].type != 'header':
raise ProfileError('first element is not header')
if pes.pe_list[1].type != 'mf':
@@ -47,6 +53,7 @@
raise ProfileError('last element is not end')
def check_number_of_occurrence(self, pes: ProfileElementSequence):
+ """Check The number of occurrence of various ProfileElements."""
# check for invalid number of occurrences
if len(pes.get_pes_for_type('header')) != 1:
raise ProfileError('multiple ProfileHeader')
@@ -60,6 +67,7 @@
raise ProfileError('multiple PE-%s' % tn.upper())
def check_optional_ordering(self, pes: ProfileElementSequence):
+ """Check the ordering of optional PEs following the respective mandatory ones."""
# ordering and required depenencies
self._is_after_if_exists(pes,'opt-usim', 'usim')
self._is_after_if_exists(pes,'opt-isim', 'isim')
@@ -104,17 +112,21 @@
FileChoiceList = List[Tuple]
class FileError(ProfileError):
+ """Raised when a FileConstraintChecker finds an error in a file [structure]."""
pass
class FileConstraintChecker:
def check(self, l: FileChoiceList):
+ """Execute all the check_* methods of the FileConstraintChecker against the given FileChoiceList"""
for name in dir(self):
if name.startswith('check_'):
method = getattr(self, name)
method(l)
class FileCheckBasicStructure(FileConstraintChecker):
+ """Validator for the basic structure of a decoded file."""
def check_seqence(self, l: FileChoiceList):
+ """Check the sequence/ordering."""
by_type = {}
for k, v in l:
if k in by_type:
diff --git a/pySim/esim/x509_cert.py b/pySim/esim/x509_cert.py
index e951de7..c8a0386 100644
--- a/pySim/esim/x509_cert.py
+++ b/pySim/esim/x509_cert.py
@@ -1,6 +1,5 @@
-# Implementation of X.509 certificate handling in GSMA eSIM
-# as per SGP22 v3.0
-#
+"""Implementation of X.509 certificate handling in GSMA eSIM as per SGP22 v3.0"""
+
# (C) 2024 by Harald Welte <laforge(a)osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
--
To view, visit https://gerrit.osmocom.org/c/pysim/+/40236?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: pysim
Gerrit-Branch: master
Gerrit-Change-Id: I7be6264c665a2a25105681bb5e72d0f6715bbef8
Gerrit-Change-Number: 40236
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de>
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
2 months
- 1
- 0