VTY: add osmo_tdef introspection and configuration commands

This change introduces several new VTY commands letting the user
a possibility to introspect and reconfigure some of the existing
timers implemented using libosmocore's osmo_tdef API.

At the moment this covers the following timers:

  - MGW specific timers:
    - X1 - MGCP response timeout,
    - X2 - RTP stream establishing timeout,

  - RAN specific timers (same names for GERAN and UTRAN):
    - X1 - Authentication and Ciphering timeout,
    - X2 - RAN connection release sanity timeout,
    - X3 - Handover procedure timeout.

The following commands are introduced:

  - 'enable' node:
    - show timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN]

  - 'config-msc' node:
    - timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN] [(<0-2147483647>|default)]

Both MNCC and SCCP related timer definitions are empty at the
moment. Achieved by using osmo_tdef_group API of libosmovty.

Change-Id: I6024c104b6101666c8aa1108a043910eb75db9a5
Related: OS#4368

5 files changed, 67 insertions, 0 deletions

diff --git a/doc/manuals/vty/msc_vty_reference.xml b/doc/manuals/vty/msc_vty_reference.xml
index 7fba1a9ec..36cbf77a9 100644
--- a/doc/manuals/vty/msc_vty_reference.xml
+++ b/doc/manuals/vty/msc_vty_reference.xml
@@ -576,6 +576,19 @@
         <param name='&lt;0-65535&gt;' doc='CI' />
       </params>
     </command>
+    <command id='show timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN]'>
+      <params>
+        <param name='show' doc='Show running system information' />
+        <param name='timer' doc='Show timers' />
+        <param name='[mgw]' doc='MGW (Media Gateway) interface' />
+        <param name='[mncc]' doc='MNCC (Mobile Network Call Control) interface' />
+        <param name='[sccp]' doc='SCCP (Signalling Connection Control Part)' />
+        <param name='[geran]' doc='GERAN (GSM EDGE Radio Access Network)' />
+        <param name='[utran]' doc='UTRAN (UMTS Terrestrial Radio Access Network)' />
+        <param name='[sgs]' doc='SGs interface towards MME' />
+        <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format &apos;1234&apos; or &apos;T1234&apos; or &apos;t1234&apos;; Osmocom-specific timer number of the format: &apos;X1234&apos; or &apos;x1234&apos;.' />
+      </params>
+    </command>
     <command id='show fsm NAME'>
       <params>
         <param name='show' doc='Show running system information' />
@@ -1392,6 +1405,19 @@
         <param name='&lt;0-65535&gt;' doc='CI' />
       </params>
     </command>
+    <command id='show timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN]'>
+      <params>
+        <param name='show' doc='Show running system information' />
+        <param name='timer' doc='Show timers' />
+        <param name='[mgw]' doc='MGW (Media Gateway) interface' />
+        <param name='[mncc]' doc='MNCC (Mobile Network Call Control) interface' />
+        <param name='[sccp]' doc='SCCP (Signalling Connection Control Part)' />
+        <param name='[geran]' doc='GERAN (GSM EDGE Radio Access Network)' />
+        <param name='[utran]' doc='UTRAN (UMTS Terrestrial Radio Access Network)' />
+        <param name='[sgs]' doc='SGs interface towards MME' />
+        <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format &apos;1234&apos; or &apos;T1234&apos; or &apos;t1234&apos;; Osmocom-specific timer number of the format: &apos;X1234&apos; or &apos;x1234&apos;.' />
+      </params>
+    </command>
     <command id='show fsm NAME'>
       <params>
         <param name='show' doc='Show running system information' />
@@ -2910,6 +2936,20 @@
         <param name='RAN_PC_OR_MSC_IPA_NAME' doc='Point code or MSC IPA name value' />
       </params>
     </command>
+    <command id='timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN] [(&lt;0-2147483647&gt;|default)]'>
+      <params>
+        <param name='timer' doc='Configure or show timers' />
+        <param name='[mgw]' doc='MGW (Media Gateway) interface' />
+        <param name='[mncc]' doc='MNCC (Mobile Network Call Control) interface' />
+        <param name='[sccp]' doc='SCCP (Signalling Connection Control Part)' />
+        <param name='[geran]' doc='GERAN (GSM EDGE Radio Access Network)' />
+        <param name='[utran]' doc='UTRAN (UMTS Terrestrial Radio Access Network)' />
+        <param name='[sgs]' doc='SGs interface towards MME' />
+        <param name='[TNNNN]' doc='T- or X-timer-number -- 3GPP compliant timer number of the format &apos;1234&apos; or &apos;T1234&apos; or &apos;t1234&apos;; Osmocom-specific timer number of the format: &apos;X1234&apos; or &apos;x1234&apos;.' />
+        <param name='[&lt;0-2147483647&gt;]' doc='New timer value' />
+        <param name='[default]' doc='Set to default timer value' />
+      </params>
+    </command>
     <command id='mgw local-ip A.B.C.D'>
       <params>
         <param name='mgw' doc='Configure MGCP connection to Media Gateway' />
diff --git a/include/osmocom/msc/msc_common.h b/include/osmocom/msc/msc_common.h
index 78337f764..bd85722cd 100644
--- a/include/osmocom/msc/msc_common.h
+++ b/include/osmocom/msc/msc_common.h
@@ -1,5 +1,7 @@
 #pragma once
 
+#include <osmocom/core/tdef.h>
+
 #include <osmocom/gsm/protocol/gsm_04_08.h>
 #include <osmocom/gsm/gsm0808.h>
 
@@ -7,6 +9,8 @@ struct msgb;
 struct gsm_network;
 struct vlr_subscr;
 
+extern struct osmo_tdef_group msc_tdef_group[];
+
 #define MSC_HLR_REMOTE_IP_DEFAULT "127.0.0.1"
 #define MSC_HLR_REMOTE_PORT_DEFAULT OSMO_GSUP_PORT
 
diff --git a/src/libmsc/msc_net_init.c b/src/libmsc/msc_net_init.c
index 91b6165bd..ffb8a3ba4 100644
--- a/src/libmsc/msc_net_init.c
+++ b/src/libmsc/msc_net_init.c
@@ -31,10 +31,25 @@
 #include <osmocom/msc/gsm_04_11_gsup.h>
 #include <osmocom/msc/gsm_09_11.h>
 
+/* TODO: would be great to have all timer declarations in one place */
+#include <osmocom/msc/ran_infra.h>
+#include <osmocom/msc/sccp_ran.h>
+#include <osmocom/msc/call_leg.h>
+
 struct osmo_tdef mncc_tdefs[] = {
 	{}
 };
 
+struct osmo_tdef_group msc_tdef_group[] = {
+	{ .name = "mgw", .tdefs = g_mgw_tdefs, .desc = "MGW (Media Gateway) interface" },
+	{ .name = "mncc", .tdefs = mncc_tdefs, .desc = "MNCC (Mobile Network Call Control) interface" },
+	{ .name = "sccp", .tdefs = g_sccp_tdefs, .desc = "SCCP (Signalling Connection Control Part)" },
+	{ .name = "geran", .tdefs = msc_tdefs_geran, .desc = "GERAN (GSM EDGE Radio Access Network)" },
+	{ .name = "utran", .tdefs = msc_tdefs_utran, .desc = "UTRAN (UMTS Terrestrial Radio Access Network)" },
+	{ .name = "sgs", .tdefs = msc_tdefs_sgs, .desc = "SGs interface towards MME" },
+	{ /* terminator */ }
+};
+
 #include <osmocom/core/stat_item.h>
 
 struct gsm_network *gsm_network_init(void *ctx, mncc_recv_cb_t mncc_recv)
diff --git a/src/libmsc/msc_vty.c b/src/libmsc/msc_vty.c
index 90cfc9daa..53d44dc7d 100644
--- a/src/libmsc/msc_vty.c
+++ b/src/libmsc/msc_vty.c
@@ -36,6 +36,7 @@
 
 #include <osmocom/sigtran/sccp_helpers.h>
 
+#include <osmocom/vty/tdef_vty.h>
 #include <osmocom/vty/command.h>
 #include <osmocom/vty/logging.h>
 #include <osmocom/vty/misc.h>
@@ -716,6 +717,9 @@ static int config_write_msc(struct vty *vty)
 
 	neighbor_ident_vty_write(vty);
 
+	/* Timer introspection commands (generic osmo_tdef API) */
+	osmo_tdef_vty_groups_write(vty, " ");
+
 	return CMD_SUCCESS;
 }
 
@@ -2002,6 +2006,9 @@ void msc_vty_init(struct gsm_network *msc_network)
 
 	neighbor_ident_vty_init(msc_network);
 
+	/* Timer configuration commands (generic osmo_tdef API) */
+	osmo_tdef_vty_groups_init(MSC_NODE, msc_tdef_group);
+
 	mgcp_client_vty_init(msc_network, MSC_NODE, &msc_network->mgw.conf);
 #ifdef BUILD_IU
 	ranap_iu_vty_init(MSC_NODE, (enum ranap_nsap_addr_enc*)&msc_network->iu.rab_assign_addr_enc);
diff --git a/tests/test_nodes.vty b/tests/test_nodes.vty
index a4e0e15db..2c2ce1b84 100644
--- a/tests/test_nodes.vty
+++ b/tests/test_nodes.vty
@@ -69,6 +69,7 @@ OsmoMSC(config-msc)# list
   neighbor (a|iu) lac-ci <0-65535> <0-65535> (ran-pc|msc-ipa-name) RAN_PC_OR_MSC_IPA_NAME
   neighbor (a|iu) cgi <0-999> <0-999> <0-65535> <0-65535> (ran-pc|msc-ipa-name) RAN_PC_OR_MSC_IPA_NAME
   no neighbor (a|iu) (ran-pc|msc-ipa-name) RAN_PC_OR_MSC_IPA_NAME
+  timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN] [(<0-2147483647>|default)]
   mgw local-ip A.B.C.D
   mgw local-port <0-65535>
   mgw remote-ip A.B.C.D