Add new 'osmo_ss7' SS7 core code with M3UA, ASP/AS FSM, ...

This is what aims to be a rather complete/proper implementation of the
SIGTRAN + SS7 protocol suite.  It has proper abstraction between the
layers with primitives, finite state machines for things like the AS and
ASP state machines, support for point code routing, etc.

What's not implemented at this point:
* re-integration of pre-existing SUA (pending)
* actual MTP2 and physical E1/T1 link support
* different trafic modes like broadcast/fail-over/load-balance

Change-Id: I375eb80f01acc013094851d91d1d3333ebc12bc7

6 files changed, 416 insertions, 1 deletions

diff --git a/tests/Makefile.am b/tests/Makefile.am
index 6e9b807..9c251fe 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = sccp mtp m2ua sigtran
+SUBDIRS = sccp mtp m2ua sigtran ss7
 
 # The `:;' works around a Bash 3.2 bug when the output is not writeable.
 $(srcdir)/package.m4: $(top_srcdir)/configure.ac
diff --git a/tests/ss7/Makefile.am b/tests/ss7/Makefile.am
new file mode 100644
index 0000000..bc81915
--- /dev/null
+++ b/tests/ss7/Makefile.am
@@ -0,0 +1,12 @@
+AM_CPPFLAGS = $(all_includes) -I$(top_srcdir)/include -Wall
+AM_CFLAGS=-Wall $(LIBOSMOCORE_CFLAGS)
+
+AM_LDFLAGS = -static
+LDADD = $(top_builddir)/src/libosmo-sigtran.la \
+	$(LIBOSMOCORE_LIBS) $(LIBOSMONETIF_LIBS) $(LIBSCTP_LIBS)
+
+EXTRA_DIST = ss7_test.ok ss7_test.err
+
+noinst_PROGRAMS = ss7_test
+
+ss7_test_SOURCES = ss7_test.c
diff --git a/tests/ss7/ss7_test.c b/tests/ss7/ss7_test.c
new file mode 100644
index 0000000..24eabc9
--- /dev/null
+++ b/tests/ss7/ss7_test.c
@@ -0,0 +1,321 @@
+#include "../src/xua_internal.h"
+#include "../src/xua_asp_fsm.h"
+
+#include <osmocom/sigtran/osmo_ss7.h>
+#include <osmocom/sigtran/protocol/m3ua.h>
+
+#include <osmocom/core/utils.h>
+#include <osmocom/core/msgb.h>
+#include <osmocom/core/logging.h>
+#include <osmocom/core/application.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdbool.h>
+#include <errno.h>
+
+static struct osmo_ss7_instance *s7i;
+
+static void test_pc_transcode(uint32_t pc)
+{
+	const char *pc_str = osmo_ss7_pointcode_print(s7i, pc);
+	uint32_t pc_reenc = osmo_ss7_pointcode_parse(s7i, pc_str);
+
+	printf("%s(%u) -> %s -> %u\n", __func__, pc, pc_str, pc_reenc);
+	OSMO_ASSERT(pc == pc_reenc);
+}
+
+static void test_pc_defaults(void)
+{
+	/* ensure the default point code format settings apply */
+	OSMO_ASSERT(s7i->cfg.pc_fmt.component_len[0] == 3);
+	OSMO_ASSERT(s7i->cfg.pc_fmt.component_len[1] == 8);
+	OSMO_ASSERT(s7i->cfg.pc_fmt.component_len[2] == 3);
+	OSMO_ASSERT(s7i->cfg.pc_fmt.delimiter = '.');
+}
+
+static void parse_print_mask(const char *in)
+{
+	uint32_t mask = osmo_ss7_pointcode_parse_mask_or_len(s7i, in);
+	const char *pc_str = osmo_ss7_pointcode_print(s7i, mask);
+	printf("mask %s => %u (0x%x) %s\n", in, mask, mask, pc_str);
+}
+
+static void test_pc_parser_itu(void)
+{
+	/* ITU Style */
+	printf("Testing ITU-style point code format\n");
+	osmo_ss7_instance_set_pc_fmt(s7i, 3, 8, 3);
+	test_pc_transcode(0);
+	test_pc_transcode(1);
+	test_pc_transcode(1 << 3);
+	test_pc_transcode(1 << (3+8));
+	test_pc_transcode(7 << (3+8));
+	test_pc_transcode(100);
+	test_pc_transcode(2342);
+	test_pc_transcode((1 << 14)-1);
+
+	parse_print_mask("/1");
+	parse_print_mask("7.0.0");
+	parse_print_mask("/14");
+}
+
+static void test_pc_parser_ansi(void)
+{
+	/* ANSI Style */
+	printf("Testing ANSI-style point code format\n");
+	osmo_ss7_instance_set_pc_fmt(s7i, 8, 8, 8);
+	s7i->cfg.pc_fmt.delimiter = '-';
+	test_pc_transcode(0);
+	test_pc_transcode(1);
+	test_pc_transcode(1 << 8);
+	test_pc_transcode(1 << 16);
+	test_pc_transcode(1 << (3+8));
+	test_pc_transcode((1 << 24)-1);
+	test_pc_transcode(100);
+	test_pc_transcode(2342);
+
+	parse_print_mask("/1");
+	parse_print_mask("/16");
+	parse_print_mask("/24");
+
+	/* re-set to default (ITU) */
+	osmo_ss7_instance_set_pc_fmt(s7i, 3, 8, 3);
+	s7i->cfg.pc_fmt.delimiter = '.';
+}
+
+static int test_user_prim_cb(struct osmo_prim_hdr *oph, void *priv)
+{
+	OSMO_ASSERT(priv == (void *) 0x1234);
+
+	return 23;
+}
+
+static void test_user(void)
+{
+	struct osmo_ss7_user user, user2;
+	struct osmo_mtp_prim omp = {
+		.oph = {
+			.sap = MTP_SAP_USER,
+			.primitive = OSMO_MTP_PRIM_TRANSFER,
+			.operation = PRIM_OP_INDICATION,
+		},
+		.u.transfer = {
+			.sio = 1,
+		},
+	};
+
+	printf("Testing SS7 user\n");
+
+	user.name = "testuser";
+	user.priv = (void *) 0x1234;
+	user.prim_cb = test_user_prim_cb;
+
+	/* registration */
+	OSMO_ASSERT(osmo_ss7_user_register(s7i, 1, &user) == 0);
+	OSMO_ASSERT(osmo_ss7_user_register(s7i, 1, NULL) == -EBUSY);
+	OSMO_ASSERT(osmo_ss7_user_register(s7i, 255, NULL) == -EINVAL);
+
+	/* primitive delivery */
+	OSMO_ASSERT(osmo_ss7_mtp_to_user(s7i, &omp) == 23);
+
+	/* cleanup */
+	OSMO_ASSERT(osmo_ss7_user_unregister(s7i, 255, NULL) == -EINVAL);
+	OSMO_ASSERT(osmo_ss7_user_unregister(s7i, 10, NULL) == -ENODEV);
+	OSMO_ASSERT(osmo_ss7_user_unregister(s7i, 1, &user2) == -EINVAL);
+	OSMO_ASSERT(osmo_ss7_user_unregister(s7i, 1, &user) == 0);
+
+	/* primitive delivery should fail now */
+	OSMO_ASSERT(osmo_ss7_mtp_to_user(s7i, &omp) == -ENODEV);
+
+	/* wrong primitive delivery should also fail */
+	omp.oph.primitive = OSMO_MTP_PRIM_PAUSE;
+	OSMO_ASSERT(osmo_ss7_mtp_to_user(s7i, &omp) == -EINVAL);
+}
+
+static void test_route(void)
+{
+	struct osmo_ss7_route_table *rtbl;
+	struct osmo_ss7_linkset *lset_a, *lset_b;
+	struct osmo_ss7_route *rt, *rt12, *rtdef;
+
+	printf("Testing SS7 routing\n");
+
+	/* creation / destruction */
+	OSMO_ASSERT(osmo_ss7_route_table_find(s7i, "foobar") == NULL);
+	rtbl = osmo_ss7_route_table_find_or_create(s7i, "foobar");
+	OSMO_ASSERT(rtbl);
+	OSMO_ASSERT(osmo_ss7_route_table_find_or_create(s7i, "foobar") == rtbl);
+	osmo_ss7_route_table_destroy(rtbl);
+	OSMO_ASSERT(osmo_ss7_route_table_find(s7i, "foobar") == NULL);
+
+	/* we now work with system route table */
+	rtbl = osmo_ss7_route_table_find(s7i, "system");
+	OSMO_ASSERT(rtbl && rtbl == s7i->rtable_system);
+
+	lset_a = osmo_ss7_linkset_find_or_create(s7i, "a", 100);
+	OSMO_ASSERT(lset_a);
+	lset_b = osmo_ss7_linkset_find_or_create(s7i, "b", 200);
+	OSMO_ASSERT(lset_b);
+
+	/* route with full mask */
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 12) == NULL);
+	rt = osmo_ss7_route_create(rtbl, 12, 0xffff, "a");
+	OSMO_ASSERT(rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 12) == rt);
+	osmo_ss7_route_destroy(rt);
+
+	/* route with partial mask */
+	rt = osmo_ss7_route_create(rtbl, 8, 0xfff8, "a");
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 8) == rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 9) == rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 12) == rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 15) == rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 16) == NULL);
+	/* insert more specific route for 12, must have higher priority
+	 * than existing one */
+	rt12 = osmo_ss7_route_create(rtbl, 12, 0xffff, "b");
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 12) == rt12);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 15) == rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 16) == NULL);
+	/* add a default route, which should have lowest precedence */
+	rtdef = osmo_ss7_route_create(rtbl, 0, 0, "a");
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 12) == rt12);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 15) == rt);
+	OSMO_ASSERT(osmo_ss7_route_find_dpc(rtbl, 16) == rtdef);
+
+	osmo_ss7_route_destroy(rtdef);
+	osmo_ss7_route_destroy(rt12);
+	osmo_ss7_route_destroy(rt);
+
+	osmo_ss7_linkset_destroy(lset_a);
+	osmo_ss7_linkset_destroy(lset_b);
+}
+
+static void test_linkset(void)
+{
+	struct osmo_ss7_linkset *lset_a, *lset_b;
+	struct osmo_ss7_link *l_a1, *l_a2;
+
+	printf("Testing SS7 linkset/link\n");
+
+	OSMO_ASSERT(osmo_ss7_linkset_find_by_name(s7i, "a") == NULL);
+	OSMO_ASSERT(osmo_ss7_linkset_find_by_name(s7i, "b") == NULL);
+
+	lset_a = osmo_ss7_linkset_find_or_create(s7i, "a", 100);
+	OSMO_ASSERT(lset_a);
+	OSMO_ASSERT(osmo_ss7_linkset_find_by_name(s7i, "a") == lset_a);
+
+	lset_b = osmo_ss7_linkset_find_or_create(s7i, "b", 200);
+	OSMO_ASSERT(lset_b);
+	OSMO_ASSERT(osmo_ss7_linkset_find_by_name(s7i, "b") == lset_b);
+
+	l_a1 = osmo_ss7_link_find_or_create(lset_a, 1);
+	OSMO_ASSERT(l_a1);
+	l_a2 = osmo_ss7_link_find_or_create(lset_a, 2);
+	OSMO_ASSERT(l_a2);
+
+	/* ID too high */
+	OSMO_ASSERT(osmo_ss7_link_find_or_create(lset_a, 1000) == NULL);
+	/* already exists */
+	OSMO_ASSERT(osmo_ss7_link_find_or_create(lset_a, 1) == l_a1);
+
+	osmo_ss7_link_destroy(l_a1);
+	osmo_ss7_link_destroy(l_a2);
+
+	osmo_ss7_linkset_destroy(lset_a);
+	osmo_ss7_linkset_destroy(lset_b);
+}
+
+static void test_as(void)
+{
+	struct osmo_ss7_as *as;
+	struct osmo_ss7_asp *asp;
+
+	OSMO_ASSERT(osmo_ss7_as_find_by_name(s7i, "as1") == NULL);
+	as = osmo_ss7_as_find_or_create(s7i, "as1", OSMO_SS7_ASP_PROT_M3UA);
+	OSMO_ASSERT(osmo_ss7_as_find_by_name(s7i, "as1") == as);
+	OSMO_ASSERT(osmo_ss7_as_find_by_rctx(s7i, 2342) == NULL);
+	as->cfg.routing_key.context = 2342;
+	OSMO_ASSERT(osmo_ss7_as_find_by_rctx(s7i, 2342) == as);
+	OSMO_ASSERT(osmo_ss7_as_add_asp(as, "asp1") == -ENODEV);
+
+	asp = osmo_ss7_asp_find_or_create(s7i, "asp1", 0, M3UA_PORT, OSMO_SS7_ASP_PROT_M3UA);
+	OSMO_ASSERT(asp);
+
+	OSMO_ASSERT(osmo_ss7_as_has_asp(as, asp) == false);
+	OSMO_ASSERT(osmo_ss7_as_add_asp(as, "asp1") == 0);
+
+	osmo_ss7_asp_restart(asp);
+
+	/* ask FSM to send ASP-UP.req */
+	osmo_fsm_inst_dispatch(asp->fi, XUA_ASP_E_M_ASP_UP_REQ, NULL);
+	osmo_fsm_inst_dispatch(asp->fi, XUA_ASP_E_ASPSM_ASPUP_ACK, NULL);
+	osmo_fsm_inst_dispatch(asp->fi, XUA_ASP_E_ASPTM_ASPAC_ACK, NULL);
+
+	OSMO_ASSERT(osmo_ss7_as_del_asp(as, "asp1") == 0);
+	OSMO_ASSERT(osmo_ss7_as_del_asp(as, "asp2") == -ENODEV);
+	OSMO_ASSERT(osmo_ss7_as_del_asp(as, "asp1") == -EINVAL);
+
+	osmo_ss7_asp_destroy(asp);
+	osmo_ss7_as_destroy(as);
+	OSMO_ASSERT(osmo_ss7_as_find_by_name(s7i, "as1") == NULL);
+}
+
+/***********************************************************************
+ * Initialization
+ ***********************************************************************/
+
+static const struct log_info_cat log_info_cat[] = {
+};
+
+static const struct log_info log_info = {
+	.cat = log_info_cat,
+	.num_cat = ARRAY_SIZE(log_info_cat),
+};
+
+static void init_logging(void)
+{
+	const int log_cats[] = { DLSS7, DLSUA, DLM3UA, DLSCCP, DLINP };
+	unsigned int i;
+
+	osmo_init_logging(&log_info);
+
+	log_set_print_filename(osmo_stderr_target, 0);
+
+	for (i = 0; i < ARRAY_SIZE(log_cats); i++)
+		log_set_category_filter(osmo_stderr_target, log_cats[i], 1, LOGL_DEBUG);
+}
+
+int main(int argc, char **argv)
+{
+	init_logging();
+	osmo_fsm_log_addr(false);
+
+	/* init */
+	osmo_ss7_init();
+	s7i = osmo_ss7_instance_find_or_create(NULL, 0);
+	OSMO_ASSERT(osmo_ss7_instance_find(0) == s7i);
+	OSMO_ASSERT(osmo_ss7_instance_find(23) == NULL);
+
+	/* test osmo_ss7_pc_is_local() */
+	s7i->cfg.primary_pc = 55;
+	OSMO_ASSERT(osmo_ss7_pc_is_local(s7i, 55) == true);
+	OSMO_ASSERT(osmo_ss7_pc_is_local(s7i, 23) == false);
+
+	/* further tests */
+	test_pc_defaults();
+	test_pc_parser_itu();
+	test_pc_parser_ansi();
+	test_user();
+	test_route();
+	test_linkset();
+	test_as();
+
+	/* destroy */
+	osmo_ss7_instance_destroy(s7i);
+	OSMO_ASSERT(osmo_ss7_instance_find(0) == NULL);
+
+	exit(0);
+}
diff --git a/tests/ss7/ss7_test.err b/tests/ss7/ss7_test.err
new file mode 100644
index 0000000..8823d1c
--- /dev/null
+++ b/tests/ss7/ss7_test.err
@@ -0,0 +1,49 @@
+0: Creating SS7 Instance
+0: Creating Route Table system
+0: Point Code Format 8-8-8 is longer than 14 bits, odd?
+registering user=testuser for SI 1 with priv 0x1234
+delivering MTP-TRANSFER.ind to user testuser, priv=0x1234
+No MTP-User for SI 1
+Unsupported Primitive
+0: Creating Route Table foobar
+0: Creating Linkset a
+0: Creating Linkset b
+0: Destroying Linkset a
+0: Destroying Linkset b
+0: Creating Linkset a
+0: Creating Linkset b
+0: Creating Link a:1
+0: Creating Link a:2
+0: Destroying Link a:1
+0: Destroying Link a:2
+0: Destroying Linkset a
+0: Destroying Linkset b
+0: Creating AS as1
+XUA_AS(as1){AS_DOWN}: Allocated
+0: Adding ASP asp1 to AS as1
+0: Restarting ASP asp1
+unable to connect/bind socket: (null):0: Connection refused
+connection closed
+retrying in 5 seconds...
+0: Unable to open stream client for ASP asp1
+XUA_ASP(asp1){ASP_DOWN}: Allocated
+XUA_ASP(asp1){ASP_DOWN}: Received Event M-ASP_UP.req
+XUA_ASP(asp1){ASP_DOWN}: Received Event ASPSM-ASP_UP_ACK
+XUA_ASP(asp1){ASP_DOWN}: T(ack) stopped
+XUA_ASP(asp1){ASP_DOWN}: state_chg to ASP_INACTIVE
+XUA_ASP(asp1){ASP_INACTIVE}: Received Event M-ASP_ACTIVE.req
+XUA_ASP(asp1){ASP_INACTIVE}: Received Event ASPTM-ASP_AC_ACK
+XUA_ASP(asp1){ASP_INACTIVE}: T(ack) stopped
+XUA_ASP(asp1){ASP_INACTIVE}: state_chg to ASP_ACTIVE
+0: Removing ASP asp1 from AS as1
+0: Removing ASP asp1 from AS as1
+0: Destroying ASP asp1
+XUA_ASP(asp1){ASP_ACTIVE}: Terminating (cause = OSMO_FSM_TERM_REQUEST)
+XUA_ASP(asp1){ASP_ACTIVE}: Freeing instance
+XUA_ASP(asp1){ASP_ACTIVE}: Deallocated
+0: Destroying AS as1
+XUA_AS(as1){AS_DOWN}: Terminating (cause = OSMO_FSM_TERM_REQUEST)
+XUA_AS(as1){AS_DOWN}: Freeing instance
+XUA_AS(as1){AS_DOWN}: Deallocated
+0: Destroying SS7 Instance
+
\ No newline at end of file
diff --git a/tests/ss7/ss7_test.ok b/tests/ss7/ss7_test.ok
new file mode 100644
index 0000000..8aea63d
--- /dev/null
+++ b/tests/ss7/ss7_test.ok
@@ -0,0 +1,27 @@
+Testing ITU-style point code format
+test_pc_transcode(0) -> 0.0.0 -> 0
+test_pc_transcode(1) -> 0.0.1 -> 1
+test_pc_transcode(8) -> 0.1.0 -> 8
+test_pc_transcode(2048) -> 1.0.0 -> 2048
+test_pc_transcode(14336) -> 7.0.0 -> 14336
+test_pc_transcode(100) -> 0.12.4 -> 100
+test_pc_transcode(2342) -> 1.36.6 -> 2342
+test_pc_transcode(16383) -> 7.255.7 -> 16383
+mask /1 => 8192 (0x2000) 4.0.0
+mask 7.0.0 => 14336 (0x3800) 7.0.0
+mask /14 => 16383 (0x3fff) 7.255.7
+Testing ANSI-style point code format
+test_pc_transcode(0) -> 0-0-0 -> 0
+test_pc_transcode(1) -> 0-0-1 -> 1
+test_pc_transcode(256) -> 0-1-0 -> 256
+test_pc_transcode(65536) -> 1-0-0 -> 65536
+test_pc_transcode(2048) -> 0-8-0 -> 2048
+test_pc_transcode(16777215) -> 255-255-255 -> 16777215
+test_pc_transcode(100) -> 0-0-100 -> 100
+test_pc_transcode(2342) -> 0-9-38 -> 2342
+mask /1 => 8388608 (0x800000) 128-0-0
+mask /16 => 16776960 (0xffff00) 255-255-0
+mask /24 => 16777215 (0xffffff) 255-255-255
+Testing SS7 user
+Testing SS7 routing
+Testing SS7 linkset/link
diff --git a/tests/testsuite.at b/tests/testsuite.at
index 8907ffa..171f488 100644
--- a/tests/testsuite.at
+++ b/tests/testsuite.at
@@ -18,3 +18,9 @@ AT_KEYWORDS([sccp])
 cat $abs_srcdir/sccp/sccp_test.ok > expout
 AT_CHECK([$abs_top_builddir/tests/sccp/sccp_test], [], [expout], [ignore])
 AT_CLEANUP
+
+AT_SETUP([ss7])
+AT_KEYWORDS([ss7])
+cat $abs_srcdir/ss7/ss7_test.ok > expout
+AT_CHECK([$abs_top_builddir/tests/ss7/ss7_test], [], [expout], [ignore])
+AT_CLEANUP