libosmo-sigtran 2.1.0.164-775d Osmocom SIGTRAN library

ss7_as.h
Go to the documentation of this file.
1#pragma once
2
3#include <stdint.h>
4#include <osmocom/core/linuxlist.h>
5#include <osmocom/core/fsm.h>
6#include <osmocom/core/msgb.h>
7#include <osmocom/core/tdef.h>
8#include <osmocom/netif/stream.h>
9
10#include <osmocom/sigtran/osmo_ss7.h>
11
12#include "ss7_internal.h"
13
14/***********************************************************************
15 * SS7 Application Server
16 ***********************************************************************/
17
18 struct osmo_ss7_instance;
19 struct osmo_ss7_asp;
20 struct osmo_mtp_transfer_param;
21
22 enum osmo_ss7_as_patch_sccp_mode {
23 OSMO_SS7_PATCH_NONE, /* no patching of SCCP */
24 OSMO_SS7_PATCH_BOTH, /* patch both OPC and DPC into SCCP addresses */
25};
26
27 enum ss7_as_ctr {
28 SS7_AS_CTR_RX_MSU_DISCARD,
29 SS7_AS_CTR_RX_MSU_TOTAL,
30 SS7_AS_CTR_RX_MSU_SLS_0,
31 SS7_AS_CTR_RX_MSU_SLS_1,
32 SS7_AS_CTR_RX_MSU_SLS_2,
33 SS7_AS_CTR_RX_MSU_SLS_3,
34 SS7_AS_CTR_RX_MSU_SLS_4,
35 SS7_AS_CTR_RX_MSU_SLS_5,
36 SS7_AS_CTR_RX_MSU_SLS_6,
37 SS7_AS_CTR_RX_MSU_SLS_7,
38 SS7_AS_CTR_RX_MSU_SLS_8,
39 SS7_AS_CTR_RX_MSU_SLS_9,
40 SS7_AS_CTR_RX_MSU_SLS_10,
41 SS7_AS_CTR_RX_MSU_SLS_11,
42 SS7_AS_CTR_RX_MSU_SLS_12,
43 SS7_AS_CTR_RX_MSU_SLS_13,
44 SS7_AS_CTR_RX_MSU_SLS_14,
45 SS7_AS_CTR_RX_MSU_SLS_15,
46 SS7_AS_CTR_TX_MSU_TOTAL,
47 SS7_AS_CTR_TX_MSU_SLS_0,
48 SS7_AS_CTR_TX_MSU_SLS_1,
49 SS7_AS_CTR_TX_MSU_SLS_2,
50 SS7_AS_CTR_TX_MSU_SLS_3,
51 SS7_AS_CTR_TX_MSU_SLS_4,
52 SS7_AS_CTR_TX_MSU_SLS_5,
53 SS7_AS_CTR_TX_MSU_SLS_6,
54 SS7_AS_CTR_TX_MSU_SLS_7,
55 SS7_AS_CTR_TX_MSU_SLS_8,
56 SS7_AS_CTR_TX_MSU_SLS_9,
57 SS7_AS_CTR_TX_MSU_SLS_10,
58 SS7_AS_CTR_TX_MSU_SLS_11,
59 SS7_AS_CTR_TX_MSU_SLS_12,
60 SS7_AS_CTR_TX_MSU_SLS_13,
61 SS7_AS_CTR_TX_MSU_SLS_14,
62 SS7_AS_CTR_TX_MSU_SLS_15,
63};
64
65#define NUM_AS_EXT_SLS 128
66 typedef uint8_t as_ext_sls_t; /* range: 0-127, 7 bit */
67 struct osmo_ss7_as_esls_entry {
68 /* ITU Q.704 4.2.1: "normal signallink link" */
69 struct osmo_ss7_asp *normal_asp;
70 /* ITU Q.704 4.2.1: "alternative signallink link" */
71 struct osmo_ss7_asp *alt_asp;
72};
73
74 struct osmo_ss7_as {
76 struct llist_head list;
77 struct osmo_ss7_instance *inst;
78
80 struct osmo_fsm_inst *fi;
81
83 bool rkm_dyn_allocated;
84
86 bool simple_client_allocated;
87
89 struct rate_ctr_group *ctrg;
90
91 /* ASP loadshare: */
92 struct osmo_ss7_as_esls_entry aesls_table[NUM_AS_EXT_SLS];
93
94 struct {
95 char *name;
96 char *description;
97 enum osmo_ss7_asp_protocol proto;
98 struct osmo_ss7_routing_key routing_key;
99 enum osmo_ss7_as_traffic_mode mode;
100 /* traffic mode was configured by VTY / config file */
101 bool mode_set_by_vty;
102 /* traffic mode was configured by RKM (routing key management) or first ASPAC */
103 bool mode_set_by_peer;
104 uint32_t recovery_timeout_msec;
105 uint8_t qos_class;
106 struct {
107 bool opc_enabled;
108 bool dpc_enabled;
109 uint32_t opc;
110 uint32_t dpc;
111 enum osmo_ss7_as_patch_sccp_mode sccp_mode;
112 } pc_override;
113
114 struct osmo_ss7_asp *asps[16];
115 /* used for load-sharing traffic mode (round robin implementation) */
116 uint8_t last_asp_idx_assigned;
117 uint8_t last_asp_idx_sent;
118
119 struct {
120 /* How many bits from ITU SLS field (starting from least-significant-bit)
121 * to skip for routing decisions.
122 * range 0-3, defaults to 0, which means take all 4 bits. */
123 uint8_t sls_shift;
124 /* Whether to generate a extended-SLS with OPC information, see opc_shift below. */
125 bool opc_sls;
126 /* How many bits from ITU OPC field (starting from least-significant-bit)
127 * to skip for routing decisions (always takes 12 bits).
128 * range 0-2, defaults to 0, which means take least significant 12 bits. */
129 uint8_t opc_shift;
130 } loadshare;
131 } cfg;
132};
133 struct osmo_ss7_as *ss7_as_alloc(struct osmo_ss7_instance *inst, const char *name,
134 enum osmo_ss7_asp_protocol proto);
135 struct osmo_ss7_asp *ss7_as_select_asp(struct osmo_ss7_as *as, const struct osmo_mtp_transfer_param *mtp);
136
137 unsigned int osmo_ss7_as_count_asp(const struct osmo_ss7_as *as);
138 int ss7_as_add_asp(struct osmo_ss7_as *as, struct osmo_ss7_asp *asp);
139 int ss7_as_get_local_role(const struct osmo_ss7_as *as);
140 void ss7_as_loadshare_binding_table_reset(struct osmo_ss7_as *as);
141
142#define LOGPAS(as, subsys, level, fmt, args ...) \
143 _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
osmo_ss7_as_patch_sccp_mode
osmo_ss7_as_patch_sccp_mode
Definition: ss7_as.h:22
OSMO_SS7_PATCH_BOTH
@ OSMO_SS7_PATCH_BOTH
Definition: ss7_as.h:24
OSMO_SS7_PATCH_NONE
@ OSMO_SS7_PATCH_NONE
Definition: ss7_as.h:23
ss7_as_loadshare_binding_table_reset
void ss7_as_loadshare_binding_table_reset(struct osmo_ss7_as *as)
Definition: ss7_as.c:383
as_ext_sls_t
uint8_t as_ext_sls_t
Definition: ss7_as.h:66
ss7_as_get_local_role
int ss7_as_get_local_role(const struct osmo_ss7_as *as)
Definition: ss7_as.c:279
NUM_AS_EXT_SLS
#define NUM_AS_EXT_SLS
Definition: ss7_as.h:65
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:153
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:111
ss7_as_select_asp
struct osmo_ss7_asp * ss7_as_select_asp(struct osmo_ss7_as *as, const struct osmo_mtp_transfer_param *mtp)
Select an AS to transmit a message, according to AS configuration and ASP availability.
Definition: ss7_as.c:520
ss7_as_ctr
ss7_as_ctr
Definition: ss7_as.h:27
SS7_AS_CTR_TX_MSU_SLS_8
@ SS7_AS_CTR_TX_MSU_SLS_8
Definition: ss7_as.h:55
SS7_AS_CTR_TX_MSU_SLS_15
@ SS7_AS_CTR_TX_MSU_SLS_15
Definition: ss7_as.h:62
SS7_AS_CTR_RX_MSU_SLS_10
@ SS7_AS_CTR_RX_MSU_SLS_10
Definition: ss7_as.h:40
SS7_AS_CTR_RX_MSU_TOTAL
@ SS7_AS_CTR_RX_MSU_TOTAL
Definition: ss7_as.h:29
SS7_AS_CTR_TX_MSU_SLS_14
@ SS7_AS_CTR_TX_MSU_SLS_14
Definition: ss7_as.h:61
SS7_AS_CTR_TX_MSU_SLS_7
@ SS7_AS_CTR_TX_MSU_SLS_7
Definition: ss7_as.h:54
SS7_AS_CTR_RX_MSU_SLS_15
@ SS7_AS_CTR_RX_MSU_SLS_15
Definition: ss7_as.h:45
SS7_AS_CTR_RX_MSU_SLS_1
@ SS7_AS_CTR_RX_MSU_SLS_1
Definition: ss7_as.h:31
SS7_AS_CTR_TX_MSU_SLS_5
@ SS7_AS_CTR_TX_MSU_SLS_5
Definition: ss7_as.h:52
SS7_AS_CTR_RX_MSU_SLS_2
@ SS7_AS_CTR_RX_MSU_SLS_2
Definition: ss7_as.h:32
SS7_AS_CTR_TX_MSU_SLS_3
@ SS7_AS_CTR_TX_MSU_SLS_3
Definition: ss7_as.h:50
SS7_AS_CTR_RX_MSU_SLS_5
@ SS7_AS_CTR_RX_MSU_SLS_5
Definition: ss7_as.h:35
SS7_AS_CTR_TX_MSU_SLS_10
@ SS7_AS_CTR_TX_MSU_SLS_10
Definition: ss7_as.h:57
SS7_AS_CTR_RX_MSU_SLS_8
@ SS7_AS_CTR_RX_MSU_SLS_8
Definition: ss7_as.h:38
SS7_AS_CTR_TX_MSU_SLS_12
@ SS7_AS_CTR_TX_MSU_SLS_12
Definition: ss7_as.h:59
SS7_AS_CTR_RX_MSU_SLS_4
@ SS7_AS_CTR_RX_MSU_SLS_4
Definition: ss7_as.h:34
SS7_AS_CTR_TX_MSU_SLS_9
@ SS7_AS_CTR_TX_MSU_SLS_9
Definition: ss7_as.h:56
SS7_AS_CTR_TX_MSU_SLS_2
@ SS7_AS_CTR_TX_MSU_SLS_2
Definition: ss7_as.h:49
SS7_AS_CTR_TX_MSU_SLS_0
@ SS7_AS_CTR_TX_MSU_SLS_0
Definition: ss7_as.h:47
SS7_AS_CTR_TX_MSU_TOTAL
@ SS7_AS_CTR_TX_MSU_TOTAL
Definition: ss7_as.h:46
SS7_AS_CTR_RX_MSU_SLS_7
@ SS7_AS_CTR_RX_MSU_SLS_7
Definition: ss7_as.h:37
SS7_AS_CTR_RX_MSU_DISCARD
@ SS7_AS_CTR_RX_MSU_DISCARD
Definition: ss7_as.h:28
SS7_AS_CTR_TX_MSU_SLS_11
@ SS7_AS_CTR_TX_MSU_SLS_11
Definition: ss7_as.h:58
SS7_AS_CTR_TX_MSU_SLS_6
@ SS7_AS_CTR_TX_MSU_SLS_6
Definition: ss7_as.h:53
SS7_AS_CTR_RX_MSU_SLS_6
@ SS7_AS_CTR_RX_MSU_SLS_6
Definition: ss7_as.h:36
SS7_AS_CTR_RX_MSU_SLS_14
@ SS7_AS_CTR_RX_MSU_SLS_14
Definition: ss7_as.h:44
SS7_AS_CTR_RX_MSU_SLS_9
@ SS7_AS_CTR_RX_MSU_SLS_9
Definition: ss7_as.h:39
SS7_AS_CTR_TX_MSU_SLS_13
@ SS7_AS_CTR_TX_MSU_SLS_13
Definition: ss7_as.h:60
SS7_AS_CTR_RX_MSU_SLS_13
@ SS7_AS_CTR_RX_MSU_SLS_13
Definition: ss7_as.h:43
SS7_AS_CTR_RX_MSU_SLS_12
@ SS7_AS_CTR_RX_MSU_SLS_12
Definition: ss7_as.h:42
SS7_AS_CTR_TX_MSU_SLS_1
@ SS7_AS_CTR_TX_MSU_SLS_1
Definition: ss7_as.h:48
SS7_AS_CTR_RX_MSU_SLS_3
@ SS7_AS_CTR_RX_MSU_SLS_3
Definition: ss7_as.h:33
SS7_AS_CTR_RX_MSU_SLS_11
@ SS7_AS_CTR_RX_MSU_SLS_11
Definition: ss7_as.h:41
SS7_AS_CTR_RX_MSU_SLS_0
@ SS7_AS_CTR_RX_MSU_SLS_0
Definition: ss7_as.h:30
SS7_AS_CTR_TX_MSU_SLS_4
@ SS7_AS_CTR_TX_MSU_SLS_4
Definition: ss7_as.h:51
osmo_ss7_as_count_asp
unsigned int osmo_ss7_as_count_asp(const struct osmo_ss7_as *as)
Determine amount of ASPs associated to an AS.
Definition: ss7_as.c:265
ss7_internal.h
osmo_mtp_transfer_param
Definition: mtp_sap.h:36
osmo_ss7_as_esls_entry
Definition: ss7_as.h:67
osmo_ss7_as_esls_entry::normal_asp
struct osmo_ss7_asp * normal_asp
Definition: ss7_as.h:69
osmo_ss7_as_esls_entry::alt_asp
struct osmo_ss7_asp * alt_asp
Definition: ss7_as.h:71
osmo_ss7_as
Definition: ss7_as.h:74
osmo_ss7_as::routing_key
struct osmo_ss7_routing_key routing_key
Definition: ss7_as.h:98
osmo_ss7_as::opc_shift
uint8_t opc_shift
Definition: ss7_as.h:129
osmo_ss7_as::sls_shift
uint8_t sls_shift
Definition: ss7_as.h:123
osmo_ss7_as::recovery_timeout_msec
uint32_t recovery_timeout_msec
Definition: ss7_as.h:104
osmo_ss7_as::aesls_table
struct osmo_ss7_as_esls_entry aesls_table[NUM_AS_EXT_SLS]
Definition: ss7_as.h:92
osmo_ss7_as::opc_enabled
bool opc_enabled
Definition: ss7_as.h:107
osmo_ss7_as::list
struct llist_head list
entry in 'ref osmo_ss7_instance.as_list
Definition: ss7_as.h:76
osmo_ss7_as::last_asp_idx_assigned
uint8_t last_asp_idx_assigned
Definition: ss7_as.h:116
osmo_ss7_as::description
char * description
Definition: ss7_as.h:96
osmo_ss7_as::rkm_dyn_allocated
bool rkm_dyn_allocated
Were we dynamically allocated by RKM?
Definition: ss7_as.h:83
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:89
osmo_ss7_as::asps
struct osmo_ss7_asp * asps[16]
Definition: ss7_as.h:114
osmo_ss7_as::last_asp_idx_sent
uint8_t last_asp_idx_sent
Definition: ss7_as.h:117
osmo_ss7_as::name
char * name
Definition: ss7_as.h:95
osmo_ss7_as::opc
uint32_t opc
Definition: ss7_as.h:109
osmo_ss7_as::mode_set_by_vty
bool mode_set_by_vty
Definition: ss7_as.h:101
osmo_ss7_as::fi
struct osmo_fsm_inst * fi
AS FSM.
Definition: ss7_as.h:80
osmo_ss7_as::simple_client_allocated
bool simple_client_allocated
Were we allocated by "simple client" support?
Definition: ss7_as.h:86
osmo_ss7_as::dpc
uint32_t dpc
Definition: ss7_as.h:110
osmo_ss7_as::opc_sls
bool opc_sls
Definition: ss7_as.h:125
osmo_ss7_as::mode
enum osmo_ss7_as_traffic_mode mode
Definition: ss7_as.h:99
osmo_ss7_as::proto
enum osmo_ss7_asp_protocol proto
Definition: ss7_as.h:97
osmo_ss7_as::sccp_mode
enum osmo_ss7_as_patch_sccp_mode sccp_mode
Definition: ss7_as.h:111
osmo_ss7_as::inst
struct osmo_ss7_instance * inst
Definition: ss7_as.h:77
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:103
osmo_ss7_as::qos_class
uint8_t qos_class
Definition: ss7_as.h:105
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:108
osmo_ss7_asp
Definition: ss7_asp.h:42
osmo_ss7_instance
Definition: ss7_instance.h:21
osmo_ss7_routing_key
Definition: osmo_ss7.h:142