libosmo-sigtran: src/ss7_as.h Source File

libosmo-sigtran 2.2.1.99-1c6a Osmocom SIGTRAN library

ss7_as.h
Go to the documentation of this file.
1#pragma once
2
3#include "config.h"
4
5#include <stdint.h>
6#include <osmocom/core/linuxlist.h>
7#include <osmocom/core/fsm.h>
8#include <osmocom/core/hashtable.h>
9#include <osmocom/core/msgb.h>
10#include <osmocom/core/tdef.h>
11#include <osmocom/netif/stream.h>
12
13#include <osmocom/sigtran/osmo_ss7.h>
14
15#include "ss7_internal.h"
16#include "xua_msg.h"
17
18/***********************************************************************
19 * SS7 Application Server
20 ***********************************************************************/
21
22struct osmo_ss7_instance;
23struct osmo_ss7_asp;
24struct osmo_mtp_transfer_param;
25struct xua_msg;
26
27 enum osmo_ss7_as_patch_sccp_mode {
28 OSMO_SS7_PATCH_NONE, /* no patching of SCCP */
29 OSMO_SS7_PATCH_BOTH, /* patch both OPC and DPC into SCCP addresses */
30};
31
32 enum ss7_as_ctr {
33 SS7_AS_CTR_RX_MSU_DISCARD,
34 SS7_AS_CTR_RX_MSU_TOTAL,
35 SS7_AS_CTR_RX_MSU_SLS_0,
36 SS7_AS_CTR_RX_MSU_SLS_1,
37 SS7_AS_CTR_RX_MSU_SLS_2,
38 SS7_AS_CTR_RX_MSU_SLS_3,
39 SS7_AS_CTR_RX_MSU_SLS_4,
40 SS7_AS_CTR_RX_MSU_SLS_5,
41 SS7_AS_CTR_RX_MSU_SLS_6,
42 SS7_AS_CTR_RX_MSU_SLS_7,
43 SS7_AS_CTR_RX_MSU_SLS_8,
44 SS7_AS_CTR_RX_MSU_SLS_9,
45 SS7_AS_CTR_RX_MSU_SLS_10,
46 SS7_AS_CTR_RX_MSU_SLS_11,
47 SS7_AS_CTR_RX_MSU_SLS_12,
48 SS7_AS_CTR_RX_MSU_SLS_13,
49 SS7_AS_CTR_RX_MSU_SLS_14,
50 SS7_AS_CTR_RX_MSU_SLS_15,
51 SS7_AS_CTR_TX_MSU_TOTAL,
52 SS7_AS_CTR_TX_MSU_SLS_0,
53 SS7_AS_CTR_TX_MSU_SLS_1,
54 SS7_AS_CTR_TX_MSU_SLS_2,
55 SS7_AS_CTR_TX_MSU_SLS_3,
56 SS7_AS_CTR_TX_MSU_SLS_4,
57 SS7_AS_CTR_TX_MSU_SLS_5,
58 SS7_AS_CTR_TX_MSU_SLS_6,
59 SS7_AS_CTR_TX_MSU_SLS_7,
60 SS7_AS_CTR_TX_MSU_SLS_8,
61 SS7_AS_CTR_TX_MSU_SLS_9,
62 SS7_AS_CTR_TX_MSU_SLS_10,
63 SS7_AS_CTR_TX_MSU_SLS_11,
64 SS7_AS_CTR_TX_MSU_SLS_12,
65 SS7_AS_CTR_TX_MSU_SLS_13,
66 SS7_AS_CTR_TX_MSU_SLS_14,
67 SS7_AS_CTR_TX_MSU_SLS_15,
68#ifdef WITH_TCAP_LOADSHARING
69 SS7_AS_CTR_RX_TCAP_DECODED,
70 SS7_AS_CTR_RX_TCAP_FAILED,
71 SS7_AS_CTR_TCAP_ASP_SELECTED,
72 SS7_AS_CTR_TCAP_ASP_FALLBACK,
73 SS7_AS_CTR_TCAP_ASP_FAILED,
74#endif /* WITH_TCAP_LOADSHARING */
75};
76
77#define NUM_AS_EXT_SLS 128
78 typedef uint8_t as_ext_sls_t; /* range: 0-127, 7 bit */
79 struct osmo_ss7_as_esls_entry {
80 /* ITU Q.704 4.2.1: "normal signallink link" */
81 struct osmo_ss7_asp *normal_asp;
82 /* ITU Q.704 4.2.1: "alternative signallink link" */
83 struct osmo_ss7_asp *alt_asp;
84};
85
86 struct ss7_as_asp_assoc {
87 /* Entry in (struct osmo_ss7_as*)->assoc_asp_list */
88 struct llist_head as_entry;
89 /* Entry in (struct osmo_ss7_asp*)->assoc_as_list */
90 struct llist_head asp_entry;
91 struct osmo_ss7_as *as; /* backpointer */
92 struct osmo_ss7_asp *asp; /* backpointer */
93};
94
95 struct osmo_ss7_as {
97 struct llist_head list;
98 struct osmo_ss7_instance *inst;
99
101 struct osmo_fsm_inst *fi;
102
104 bool rkm_dyn_allocated;
105
107 bool simple_client_allocated;
108
110 struct rate_ctr_group *ctrg;
111
112 /* ASP loadshare: */
113 struct osmo_ss7_as_esls_entry aesls_table[NUM_AS_EXT_SLS];
114
115#ifdef WITH_TCAP_LOADSHARING
116 struct {
117 /* optimisation: true if tid_ranges contains PCs (not only wildcards) */
118 bool contains_pc;
119 /* optimisation: true if tid_ranges contains SSNs (not only wildcards (0)) */
120 bool contains_ssn;
121 DECLARE_HASHTABLE(tid_ranges, 10);
122 /* gargabe collector timer */
123 struct osmo_timer_list gc_timer;
124 /* TODO: the hash tables size might not be optimal */
125 DECLARE_HASHTABLE(trans_track_own, 10);
126 DECLARE_HASHTABLE(trans_track_peer, 10);
127 } tcap;
128#endif /* WITH_TCAP_LOADSHARING */
129
130 /* used for load-sharing traffic mode (round robin implementation) */
131 struct ss7_as_asp_assoc *last_asp_idx_assigned;
132 struct ss7_as_asp_assoc *last_asp_idx_sent;
133
134 struct llist_head assoc_asp_list; /* list of struct ss7_as_asp_assoc */
135 unsigned int num_assoc_asps; /* amount of ss7_as_asp_assoc/ss7_asp in assoc_asp_list */
136
137 struct {
138 char *name;
139 char *description;
140 enum osmo_ss7_asp_protocol proto;
141 struct osmo_ss7_routing_key routing_key;
142 enum osmo_ss7_as_traffic_mode mode;
143 /* traffic mode was configured by VTY / config file */
144 bool mode_set_by_vty;
145 /* traffic mode was configured by RKM (routing key management) or first ASPAC */
146 bool mode_set_by_peer;
147 uint32_t recovery_timeout_msec;
148 uint8_t qos_class;
149 struct {
150 bool opc_enabled;
151 bool dpc_enabled;
152 uint32_t opc;
153 uint32_t dpc;
154 enum osmo_ss7_as_patch_sccp_mode sccp_mode;
155 } pc_override;
156
157 struct {
158 /* How many bits from ITU SLS field (starting from least-significant-bit)
159 * to skip for routing decisions.
160 * range 0-3, defaults to 0, which means take all 4 bits. */
161 uint8_t sls_shift;
162 /* Whether to generate a extended-SLS with OPC information, see opc_shift below. */
163 bool opc_sls;
164 /* How many bits from ITU OPC field (starting from least-significant-bit)
165 * to skip for routing decisions (always takes 12 bits).
166 * range 0-2, defaults to 0, which means take least significant 12 bits. */
167 uint8_t opc_shift;
168#ifdef WITH_TCAP_LOADSHARING
169 /* Should we do load-sharing based on tcap ids? */
170 struct {
171 bool enabled;
172 unsigned int timeout_s;
173 struct ss7_as_asp_assoc *last_asp_idx_sent;
174 } tcap;
175#endif /* WITH_TCAP_LOADSHARING */
176 } loadshare;
177 } cfg;
178};
179struct osmo_ss7_as *ss7_as_alloc(struct osmo_ss7_instance *inst, const char *name,
180 enum osmo_ss7_asp_protocol proto);
181struct osmo_ss7_asp *ss7_as_select_asp(struct osmo_ss7_as *as, const struct xua_msg *xua);
182
183int ss7_as_add_asp(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp);
184int ss7_as_del_asp(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp);
185int ss7_as_get_local_role(const struct osmo_ss7_as *as);
186struct osmo_ss7_asp *ss7_as_find_asp_by_remote_asp_id(const struct osmo_ss7_as *as, uint32_t asp_id,
187 const struct osmo_ss7_asp *excl_asp);
188void ss7_as_loadshare_binding_table_reset(struct osmo_ss7_as *as);
189
190void ss7_as_del_asp_update_llist_round_robin(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp, struct ss7_as_asp_assoc **state);
191#define ss7_as_asp_assoc_llist_round_robin(as, state) \
192 ss7_llist_round_robin(&(as)->assoc_asp_list, (void **)state, struct ss7_as_asp_assoc, as_entry)
193
194#define LOGPAS(as, subsys, level, fmt, args ...) \
195 _LOGSS7((as)->inst, subsys, level, "AS(%s) " fmt, (as)->cfg.name, ## args)
osmo_ss7.h
osmo_ss7_asp_protocol
osmo_ss7_asp_protocol
Definition: osmo_ss7.h:157
osmo_ss7_as_traffic_mode
osmo_ss7_as_traffic_mode
Definition: osmo_ss7.h:183
xua_msg.h
osmo_ss7_as_patch_sccp_mode
osmo_ss7_as_patch_sccp_mode
Definition: ss7_as.h:27
OSMO_SS7_PATCH_BOTH
@ OSMO_SS7_PATCH_BOTH
Definition: ss7_as.h:29
OSMO_SS7_PATCH_NONE
@ OSMO_SS7_PATCH_NONE
Definition: ss7_as.h:28
ss7_as_loadshare_binding_table_reset
void ss7_as_loadshare_binding_table_reset(struct osmo_ss7_as *as)
Definition: ss7_as.c:496
as_ext_sls_t
uint8_t as_ext_sls_t
Definition: ss7_as.h:78
ss7_as_get_local_role
int ss7_as_get_local_role(const struct osmo_ss7_as *as)
Definition: ss7_as.c:406
NUM_AS_EXT_SLS
#define NUM_AS_EXT_SLS
Definition: ss7_as.h:77
ss7_as_add_asp
int ss7_as_add_asp(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp)
Add given ASP to given AS.
Definition: ss7_as.c:206
ss7_as_alloc
struct osmo_ss7_as * ss7_as_alloc(struct osmo_ss7_instance *inst, const char *name, enum osmo_ss7_asp_protocol proto)
Allocate an Application Server.
Definition: ss7_as.c:156
ss7_as_select_asp
struct osmo_ss7_asp * ss7_as_select_asp(struct osmo_ss7_as *as, const struct xua_msg *xua)
Select an AS to transmit a message, according to AS configuration and ASP availability.
Definition: ss7_as.c:632
ss7_as_ctr
ss7_as_ctr
Definition: ss7_as.h:32
SS7_AS_CTR_TX_MSU_SLS_8
@ SS7_AS_CTR_TX_MSU_SLS_8
Definition: ss7_as.h:60
SS7_AS_CTR_TX_MSU_SLS_15
@ SS7_AS_CTR_TX_MSU_SLS_15
Definition: ss7_as.h:67
SS7_AS_CTR_RX_MSU_SLS_10
@ SS7_AS_CTR_RX_MSU_SLS_10
Definition: ss7_as.h:45
SS7_AS_CTR_RX_MSU_TOTAL
@ SS7_AS_CTR_RX_MSU_TOTAL
Definition: ss7_as.h:34
SS7_AS_CTR_TX_MSU_SLS_14
@ SS7_AS_CTR_TX_MSU_SLS_14
Definition: ss7_as.h:66
SS7_AS_CTR_TX_MSU_SLS_7
@ SS7_AS_CTR_TX_MSU_SLS_7
Definition: ss7_as.h:59
SS7_AS_CTR_RX_MSU_SLS_15
@ SS7_AS_CTR_RX_MSU_SLS_15
Definition: ss7_as.h:50
SS7_AS_CTR_RX_MSU_SLS_1
@ SS7_AS_CTR_RX_MSU_SLS_1
Definition: ss7_as.h:36
SS7_AS_CTR_TX_MSU_SLS_5
@ SS7_AS_CTR_TX_MSU_SLS_5
Definition: ss7_as.h:57
SS7_AS_CTR_RX_MSU_SLS_2
@ SS7_AS_CTR_RX_MSU_SLS_2
Definition: ss7_as.h:37
SS7_AS_CTR_TX_MSU_SLS_3
@ SS7_AS_CTR_TX_MSU_SLS_3
Definition: ss7_as.h:55
SS7_AS_CTR_RX_MSU_SLS_5
@ SS7_AS_CTR_RX_MSU_SLS_5
Definition: ss7_as.h:40
SS7_AS_CTR_TX_MSU_SLS_10
@ SS7_AS_CTR_TX_MSU_SLS_10
Definition: ss7_as.h:62
SS7_AS_CTR_RX_MSU_SLS_8
@ SS7_AS_CTR_RX_MSU_SLS_8
Definition: ss7_as.h:43
SS7_AS_CTR_TX_MSU_SLS_12
@ SS7_AS_CTR_TX_MSU_SLS_12
Definition: ss7_as.h:64
SS7_AS_CTR_RX_MSU_SLS_4
@ SS7_AS_CTR_RX_MSU_SLS_4
Definition: ss7_as.h:39
SS7_AS_CTR_TX_MSU_SLS_9
@ SS7_AS_CTR_TX_MSU_SLS_9
Definition: ss7_as.h:61
SS7_AS_CTR_TX_MSU_SLS_2
@ SS7_AS_CTR_TX_MSU_SLS_2
Definition: ss7_as.h:54
SS7_AS_CTR_TX_MSU_SLS_0
@ SS7_AS_CTR_TX_MSU_SLS_0
Definition: ss7_as.h:52
SS7_AS_CTR_TX_MSU_TOTAL
@ SS7_AS_CTR_TX_MSU_TOTAL
Definition: ss7_as.h:51
SS7_AS_CTR_RX_MSU_SLS_7
@ SS7_AS_CTR_RX_MSU_SLS_7
Definition: ss7_as.h:42
SS7_AS_CTR_RX_MSU_DISCARD
@ SS7_AS_CTR_RX_MSU_DISCARD
Definition: ss7_as.h:33
SS7_AS_CTR_TX_MSU_SLS_11
@ SS7_AS_CTR_TX_MSU_SLS_11
Definition: ss7_as.h:63
SS7_AS_CTR_TX_MSU_SLS_6
@ SS7_AS_CTR_TX_MSU_SLS_6
Definition: ss7_as.h:58
SS7_AS_CTR_RX_MSU_SLS_6
@ SS7_AS_CTR_RX_MSU_SLS_6
Definition: ss7_as.h:41
SS7_AS_CTR_RX_MSU_SLS_14
@ SS7_AS_CTR_RX_MSU_SLS_14
Definition: ss7_as.h:49
SS7_AS_CTR_RX_MSU_SLS_9
@ SS7_AS_CTR_RX_MSU_SLS_9
Definition: ss7_as.h:44
SS7_AS_CTR_TX_MSU_SLS_13
@ SS7_AS_CTR_TX_MSU_SLS_13
Definition: ss7_as.h:65
SS7_AS_CTR_RX_MSU_SLS_13
@ SS7_AS_CTR_RX_MSU_SLS_13
Definition: ss7_as.h:48
SS7_AS_CTR_RX_MSU_SLS_12
@ SS7_AS_CTR_RX_MSU_SLS_12
Definition: ss7_as.h:47
SS7_AS_CTR_TX_MSU_SLS_1
@ SS7_AS_CTR_TX_MSU_SLS_1
Definition: ss7_as.h:53
SS7_AS_CTR_RX_MSU_SLS_3
@ SS7_AS_CTR_RX_MSU_SLS_3
Definition: ss7_as.h:38
SS7_AS_CTR_RX_MSU_SLS_11
@ SS7_AS_CTR_RX_MSU_SLS_11
Definition: ss7_as.h:46
SS7_AS_CTR_RX_MSU_SLS_0
@ SS7_AS_CTR_RX_MSU_SLS_0
Definition: ss7_as.h:35
SS7_AS_CTR_TX_MSU_SLS_4
@ SS7_AS_CTR_TX_MSU_SLS_4
Definition: ss7_as.h:56
ss7_as_del_asp_update_llist_round_robin
void ss7_as_del_asp_update_llist_round_robin(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp, struct ss7_as_asp_assoc **state)
Definition: ss7_as.c:267
ss7_as_find_asp_by_remote_asp_id
struct osmo_ss7_asp * ss7_as_find_asp_by_remote_asp_id(const struct osmo_ss7_as *as, uint32_t asp_id, const struct osmo_ss7_asp *excl_asp)
Find ASP with a given announced remote ASP Id.
Definition: ss7_as.c:386
ss7_as_del_asp
int ss7_as_del_asp(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp)
Delete given ASP from given AS.
Definition: ss7_as.c:290
ss7_internal.h
osmo_mtp_transfer_param
Definition: mtp_sap.h:42
osmo_ss7_as_esls_entry
Definition: ss7_as.h:79
osmo_ss7_as_esls_entry::normal_asp
struct osmo_ss7_asp * normal_asp
Definition: ss7_as.h:81
osmo_ss7_as_esls_entry::alt_asp
struct osmo_ss7_asp * alt_asp
Definition: ss7_as.h:83
osmo_ss7_as
Definition: ss7_as.h:95
osmo_ss7_as::last_asp_idx_sent
struct ss7_as_asp_assoc * last_asp_idx_sent
Definition: ss7_as.h:132
osmo_ss7_as::routing_key
struct osmo_ss7_routing_key routing_key
Definition: ss7_as.h:141
osmo_ss7_as::num_assoc_asps
unsigned int num_assoc_asps
Definition: ss7_as.h:135
osmo_ss7_as::opc_shift
uint8_t opc_shift
Definition: ss7_as.h:167
osmo_ss7_as::sls_shift
uint8_t sls_shift
Definition: ss7_as.h:161
osmo_ss7_as::recovery_timeout_msec
uint32_t recovery_timeout_msec
Definition: ss7_as.h:147
osmo_ss7_as::aesls_table
struct osmo_ss7_as_esls_entry aesls_table[NUM_AS_EXT_SLS]
Definition: ss7_as.h:113
osmo_ss7_as::opc_enabled
bool opc_enabled
Definition: ss7_as.h:150
osmo_ss7_as::list
struct llist_head list
entry in 'ref osmo_ss7_instance.as_list
Definition: ss7_as.h:97
osmo_ss7_as::description
char * description
Definition: ss7_as.h:139
osmo_ss7_as::last_asp_idx_assigned
struct ss7_as_asp_assoc * last_asp_idx_assigned
Definition: ss7_as.h:131
osmo_ss7_as::rkm_dyn_allocated
bool rkm_dyn_allocated
Were we dynamically allocated by RKM?
Definition: ss7_as.h:104
osmo_ss7_as::loadshare
struct osmo_ss7_as::@23::@25 loadshare
osmo_ss7_as::ctrg
struct rate_ctr_group * ctrg
Rate Counter Group.
Definition: ss7_as.h:110
osmo_ss7_as::name
char * name
Definition: ss7_as.h:138
osmo_ss7_as::opc
uint32_t opc
Definition: ss7_as.h:152
osmo_ss7_as::mode_set_by_vty
bool mode_set_by_vty
Definition: ss7_as.h:144
osmo_ss7_as::fi
struct osmo_fsm_inst * fi
AS FSM.
Definition: ss7_as.h:101
osmo_ss7_as::simple_client_allocated
bool simple_client_allocated
Were we allocated by "simple client" support?
Definition: ss7_as.h:107
osmo_ss7_as::dpc
uint32_t dpc
Definition: ss7_as.h:153
osmo_ss7_as::opc_sls
bool opc_sls
Definition: ss7_as.h:163
osmo_ss7_as::mode
enum osmo_ss7_as_traffic_mode mode
Definition: ss7_as.h:142
osmo_ss7_as::assoc_asp_list
struct llist_head assoc_asp_list
Definition: ss7_as.h:134
osmo_ss7_as::proto
enum osmo_ss7_asp_protocol proto
Definition: ss7_as.h:140
osmo_ss7_as::sccp_mode
enum osmo_ss7_as_patch_sccp_mode sccp_mode
Definition: ss7_as.h:154
osmo_ss7_as::inst
struct osmo_ss7_instance * inst
Definition: ss7_as.h:98
osmo_ss7_as::cfg
struct osmo_ss7_as::@23 cfg
osmo_ss7_as::mode_set_by_peer
bool mode_set_by_peer
Definition: ss7_as.h:146
osmo_ss7_as::qos_class
uint8_t qos_class
Definition: ss7_as.h:148
osmo_ss7_as::pc_override
struct osmo_ss7_as::@23::@24 pc_override
osmo_ss7_as::dpc_enabled
bool dpc_enabled
Definition: ss7_as.h:151
osmo_ss7_asp
Definition: ss7_asp.h:55
osmo_ss7_instance
Definition: ss7_instance.h:47
osmo_ss7_routing_key
Definition: osmo_ss7.h:142
ss7_as_asp_assoc
Definition: ss7_as.h:86
ss7_as_asp_assoc::as
struct osmo_ss7_as * as
Definition: ss7_as.h:91
ss7_as_asp_assoc::asp_entry
struct llist_head asp_entry
Definition: ss7_as.h:90
ss7_as_asp_assoc::asp
struct osmo_ss7_asp * asp
Definition: ss7_as.h:92
ss7_as_asp_assoc::as_entry
struct llist_head as_entry
Definition: ss7_as.h:88
xua_msg
Definition: xua_msg.h:31