blob: ada66d2ef057411e217983bd5c2fd03b6441320d [file] [log] [blame]
Harald Welteae026692017-12-09 01:03:01 +01001module BSSAP_Adapter {
Harald Welte28d943e2017-11-25 15:00:50 +01002
Harald Welteae026692017-12-09 01:03:01 +01003/* This module implements a 'dumb' BSSAP adapter. It creates the M3UA and SCCP components and stacks a BSSAP
4 * codec port on top. As a result, it provides the ability to transceive SCCP-User-SAP primitives with
5 * deoded BSSAP payload. Use this if you want to have full control about what you transmit or receive,
6 * without any automatisms in place. Allows you to refuse connections or other abnormal behavior. */
Harald Welte28d943e2017-11-25 15:00:50 +01007
Harald Welteae026692017-12-09 01:03:01 +01008import from General_Types all;
9import from Osmocom_Types all;
10
11import from M3UA_Types all;
12import from M3UA_Emulation all;
13import from MTP3asp_Types all;
14import from MTP3asp_PortType all;
Harald Welte28d943e2017-11-25 15:00:50 +010015
Harald Welte7ef51aa2018-04-16 19:16:01 +020016import from IPA_Emulation all;
17
Harald Welte28d943e2017-11-25 15:00:50 +010018import from SCCP_Types all;
19import from SCCPasp_Types all;
20import from SCCP_Emulation all;
Stefan Sperlingc307e682018-06-14 15:15:46 +020021import from SCCP_Templates all;
Harald Welte28d943e2017-11-25 15:00:50 +010022
Harald Welteae026692017-12-09 01:03:01 +010023import from SCTPasp_Types all;
24import from SCTPasp_PortType all;
Harald Welte28d943e2017-11-25 15:00:50 +010025
Harald Welteae026692017-12-09 01:03:01 +010026import from BSSAP_CodecPort all;
Harald Welte28d943e2017-11-25 15:00:50 +010027import from BSSMAP_Templates all;
Harald Welte624f9632017-12-16 19:26:04 +010028import from BSSMAP_Emulation all;
29
Harald Weltea4ca4462018-02-09 00:17:14 +010030type record BSSAP_Adapter {
Harald Welte28d943e2017-11-25 15:00:50 +010031 /* component references */
Harald Welte2e32e432018-05-24 20:00:00 +020032 M3UA_CT vc_M3UA, /* only in 3GPP AoIP */
33 IPA_Emulation_CT vc_IPA, /* only in SCCPlite */
34 IPA_EventWaiter_CT vc_WAIT, /* only in SCCPlite */
Harald Weltea4ca4462018-02-09 00:17:14 +010035 SCCP_CT vc_SCCP,
Harald Welteae026692017-12-09 01:03:01 +010036
Harald Weltea4ca4462018-02-09 00:17:14 +010037 MSC_SCCP_MTP3_parameters sccp_pars,
38 SCCP_PAR_Address sccp_addr_own,
39 SCCP_PAR_Address sccp_addr_peer,
Harald Welte624f9632017-12-16 19:26:04 +010040
41 /* handler mode */
Harald Weltea4ca4462018-02-09 00:17:14 +010042 BSSMAP_Emulation_CT vc_BSSMAP
Harald Welte28d943e2017-11-25 15:00:50 +010043}
44
Harald Welte7ef51aa2018-04-16 19:16:01 +020045type enumerated BSSAP_Transport {
46 BSSAP_TRANSPORT_AoIP, /* 3GPP AoIP: SCCP over M3UA over SCTP */
47 BSSAP_TRANSPORT_SCCPlite_SERVER, /* SCCPlite: SCCP over IPA over TCP */
48 BSSAP_TRANSPORT_SCCPlite_CLIENT /* SCCPlite: SCCP over IPA over TCP */
49};
50
Harald Weltea4ca4462018-02-09 00:17:14 +010051type record BSSAP_Configuration {
Harald Welte7ef51aa2018-04-16 19:16:01 +020052 BSSAP_Transport transport,
Harald Weltea4ca4462018-02-09 00:17:14 +010053 charstring sccp_service_type,
54 SCTP_Association_Address sctp_addr,
55 integer own_pc,
56 integer own_ssn,
57 integer peer_pc,
58 integer peer_ssn,
Philipp Maier75932982018-03-27 14:52:35 +020059 octetstring sio,
60 integer rctx
Harald Weltea4ca4462018-02-09 00:17:14 +010061};
Harald Welte28d943e2017-11-25 15:00:50 +010062
Harald Weltea4ca4462018-02-09 00:17:14 +010063private function init_pars(inout BSSAP_Adapter ba, in BSSAP_Configuration cfg) {
64 ba.sccp_pars := {
Harald Welteae026692017-12-09 01:03:01 +010065 sio := {
Harald Weltea4ca4462018-02-09 00:17:14 +010066 ni := substr(oct2bit(cfg.sio),0,2),
67 prio := substr(oct2bit(cfg.sio),2,2),
68 si := substr(oct2bit(cfg.sio),4,4)
Harald Welteae026692017-12-09 01:03:01 +010069 },
Harald Weltea4ca4462018-02-09 00:17:14 +010070 opc := cfg.own_pc,
71 dpc := cfg.peer_pc,
Harald Welteae026692017-12-09 01:03:01 +010072 sls := 0,
Harald Weltea4ca4462018-02-09 00:17:14 +010073 sccp_serviceType := cfg.sccp_service_type,
74 ssn := cfg.own_ssn
Harald Welteae026692017-12-09 01:03:01 +010075 };
Harald Weltea4ca4462018-02-09 00:17:14 +010076 ba.sccp_addr_own := valueof(ts_SccpAddr_PC_SSN(cfg.own_pc, cfg.own_ssn, cfg.sio, cfg.sccp_service_type));
77 ba.sccp_addr_peer := valueof(ts_SccpAddr_PC_SSN(cfg.peer_pc, cfg.peer_ssn, cfg.sio, cfg.sccp_service_type));
Harald Welteae026692017-12-09 01:03:01 +010078}
79
80
Harald Weltea4ca4462018-02-09 00:17:14 +010081function f_bssap_init(inout BSSAP_Adapter ba, in BSSAP_Configuration cfg, charstring id,
82 template BssmapOps ops) {
83 init_pars(ba, cfg);
84 ops.sccp_addr_local := ba.sccp_addr_own;
85 ops.sccp_addr_peer := ba.sccp_addr_peer;
Harald Welteae026692017-12-09 01:03:01 +010086
Harald Welte28d943e2017-11-25 15:00:50 +010087 /* create components */
Harald Weltea4ca4462018-02-09 00:17:14 +010088 ba.vc_SCCP := SCCP_CT.create(id & "-SCCP");
Harald Welte67089ee2018-01-17 22:19:03 +010089 if (isvalue(ops)) {
Harald Weltea4ca4462018-02-09 00:17:14 +010090 ba.vc_BSSMAP := BSSMAP_Emulation_CT.create(id & "-BSSMAP");
Harald Welte624f9632017-12-16 19:26:04 +010091 }
Harald Welte7ef51aa2018-04-16 19:16:01 +020092 select (cfg.transport) {
93 case (BSSAP_TRANSPORT_AoIP) {
94 ba.vc_M3UA := M3UA_CT.create(id & "-M3UA");
95 map(ba.vc_M3UA:SCTP_PORT, system:sctp);
96 /* connect MTP3 service provider (M3UA) to lower side of SCCP */
97 connect(ba.vc_M3UA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT);
98 ba.vc_M3UA.start(f_M3UA_Emulation(cfg.sctp_addr, cfg.rctx));
99 }
100 case (BSSAP_TRANSPORT_SCCPlite_SERVER) {
101 ba.vc_IPA := IPA_Emulation_CT.create(id & "-IPA");
102 map(ba.vc_IPA:IPA_PORT, system:IPA_CODEC_PT);
103 /* connect MTP3 service provider (IPA) to lower side of SCCP */
104 connect(ba.vc_IPA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT);
Harald Welte2e32e432018-05-24 20:00:00 +0200105 /* connect waiter to general IPA port (for ASP_IPA_Event) */
106 ba.vc_WAIT := IPA_EventWaiter_CT.create(id & "-IPA-WAIT");
107 connect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT);
108 ba.vc_WAIT.start(IPA_Emulation.waiter_main());
Harald Welte7ef51aa2018-04-16 19:16:01 +0200109 ba.vc_IPA.start(IPA_Emulation.main_server(cfg.sctp_addr.local_ip_addr,
110 cfg.sctp_addr.local_sctp_port));
Harald Welte2e32e432018-05-24 20:00:00 +0200111 /* wait until we received an IPA CCM ID_ACK */
112 ba.vc_WAIT.done;
113 disconnect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT);
Harald Welte7ef51aa2018-04-16 19:16:01 +0200114 }
115 case (BSSAP_TRANSPORT_SCCPlite_CLIENT) {
116 ba.vc_IPA := IPA_Emulation_CT.create(id & "-IPA");
117 map(ba.vc_IPA:IPA_PORT, system:IPA_CODEC_PT);
118 /* connect MTP3 service provider (IPA) to lower side of SCCP */
119 connect(ba.vc_IPA:MTP3_SP_PORT, ba.vc_SCCP:MTP3_SCCP_PORT);
Harald Welte2e32e432018-05-24 20:00:00 +0200120 /* connect waiter to general IPA port (for ASP_IPA_Event) */
121 ba.vc_WAIT := IPA_EventWaiter_CT.create(id & "-IPA-WAIT");
122 connect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT);
123 ba.vc_WAIT.start(IPA_Emulation.waiter_main());
Harald Welte7ef51aa2018-04-16 19:16:01 +0200124 ba.vc_IPA.start(IPA_Emulation.main_client(cfg.sctp_addr.remote_ip_addr,
125 cfg.sctp_addr.remote_sctp_port,
126 cfg.sctp_addr.local_ip_addr,
127 cfg.sctp_addr.local_sctp_port));
Harald Welte2e32e432018-05-24 20:00:00 +0200128 /* wait until we received an IPA CCM ID_ACK */
129 ba.vc_WAIT.done;
130 disconnect(ba.vc_IPA:IPA_SP_PORT, ba.vc_WAIT:IPA_SP_PORT);
Harald Welte7ef51aa2018-04-16 19:16:01 +0200131 }
132 case else {
133 setverdict(fail, "Unsuppored BSSAP_Transport");
Daniel Willmanne4ff5372018-07-05 17:35:03 +0200134 mtc.stop;
Harald Welte7ef51aa2018-04-16 19:16:01 +0200135 }
136 }
Harald Welte28d943e2017-11-25 15:00:50 +0100137
Harald Welte67089ee2018-01-17 22:19:03 +0100138 if (isvalue(ops)) {
Harald Welteb0ec4ee2018-01-21 13:53:17 +0100139 timer T := 5.0;
140 T.start;
Harald Weltea4ca4462018-02-09 00:17:14 +0100141 //T.timeout;
142 log("Connecting BSSMAP Emulation to SCCP_SP_PORT and starting emulation");
Harald Welte710ec212018-05-27 15:07:32 +0200143 /* connect BSSNAP component to upper side of SCCP */
Harald Weltea4ca4462018-02-09 00:17:14 +0100144 connect(ba.vc_BSSMAP:BSSAP, ba.vc_SCCP:SCCP_SP_PORT);
Harald Welte42399182018-05-27 15:07:14 +0200145 if (cfg.transport == BSSAP_TRANSPORT_SCCPlite_SERVER or
146 cfg.transport == BSSAP_TRANSPORT_SCCPlite_CLIENT) {
147 /* connect IPA MGCP port with BSSMAP MGCP port */
148 connect(ba.vc_IPA:IPA_MGCP_PORT, ba.vc_BSSMAP:MGCP);
149 }
Harald Welteb0ec4ee2018-01-21 13:53:17 +0100150 /* start the BSSMAP emulation */
Harald Weltea4ca4462018-02-09 00:17:14 +0100151 ba.vc_BSSMAP.start(BSSMAP_Emulation.main(valueof(ops), ""));
Harald Welteae026692017-12-09 01:03:01 +0100152 }
Harald Welte2e32e432018-05-24 20:00:00 +0200153
Harald Welte2e32e432018-05-24 20:00:00 +0200154
Harald Welteae026692017-12-09 01:03:01 +0100155}
156
Harald Welted5833a82018-05-27 16:52:56 +0200157function f_bssap_start(inout BSSAP_Adapter ba) {
158 ba.vc_SCCP.start(SCCPStart(ba.sccp_pars));
159}
160
Harald Welteae026692017-12-09 01:03:01 +0100161
Harald Welte28d943e2017-11-25 15:00:50 +0100162}