libosmo-sigtran 2.1.0.201-feb1 Osmocom SIGTRAN library

ss7_asp.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_asp_peer.h"
13#include "ss7_internal.h"
14
15/***********************************************************************
16 * SS7 Application Server Processes
17 ***********************************************************************/
18
19 struct osmo_ss7_instance;
20 struct osmo_xua_layer_manager;
21
22 enum ss7_asp_xua_timer {
23 /* 0 kept unused on purpose since it's handled specially by osmo_fsm */
24 SS7_ASP_XUA_T_ACK = 1, /* RFC3868 & RFC4666 timer T(ack) */
25 SS7_ASP_XUA_T_BEAT, /* RFC3868 & RFC4666 timer T(beat) */
26 /* This must remain the last item: */
27 SS7_ASP_XUA_TIMERS_LEN
28};
29 extern const struct value_string ss7_asp_xua_timer_names[];
30 extern const struct osmo_tdef ss7_asp_xua_timer_defaults[SS7_ASP_XUA_TIMERS_LEN];
31/* According to SUA RFC3868 Section 8, M3UA RFC4666 Section 4.3.4.1 */
32#define SS7_ASP_XUA_DEFAULT_T_ACK_SEC 2
33/* According to SUA RFC3868 Section 8 */
34#define SS7_ASP_XUA_DEFAULT_T_BEAT_SEC 30
35
36 enum ss7_asp_ctr {
37 SS7_ASP_CTR_PKT_RX_TOTAL,
38 SS7_ASP_CTR_PKT_RX_UNKNOWN,
39 SS7_ASP_CTR_PKT_RX_NI_MISMATCH,
40 SS7_ASP_CTR_PKT_TX_TOTAL,
41};
42
43 struct osmo_ss7_asp {
45 struct llist_head list;
46 struct osmo_ss7_instance *inst;
47
49 struct osmo_fsm_inst *fi;
50
52 struct osmo_xua_server *xua_server;
53 struct llist_head siblings;
54
56 struct osmo_stream_cli *client;
57 struct osmo_stream_srv *server;
59 char *sock_name;
60
61 /* ASP Identifier for ASP-UP + NTFY, as received by the peer.
62 * (In IPA ASPs it's used internally to hold 4-bit SLS).
63 * FIXME: This should actually be stored in a AS-ASP relation, since it
64 * can be different per AS, see RFC4666 3.5.1
65 * "The optional ASP Identifier parameter contains a unique value that
66 * is locally significant among the ASPs that support an AS".
67 */
68 uint32_t remote_asp_id;
69 bool remote_asp_id_present;
70
71 /* Layer Manager to which we talk */
72 const struct osmo_xua_layer_manager *lm;
73 void *lm_priv;
74
76 bool dyn_allocated;
77
79 bool simple_client_allocated;
80
82 struct rate_ctr_group *ctrg;
83
85 struct msgb *pending_msg;
86
87 /* IPA proto ASP specific fields. */
88 struct {
89 /* Incoming IPA PDUs have no SLS field, hence a potentially
90 * unique one within AS is assigned to this ASP and applied
91 * manually when received. */
92 uint8_t sls:4;
93 bool sls_assigned;
94 } ipa;
95
96 struct {
97 char *name;
98 char *description;
99 enum osmo_ss7_asp_protocol proto;
100 enum osmo_ss7_asp_admin_state adm_state;
101 bool is_server;
102 enum osmo_ss7_asp_role role;
103 bool role_set_by_vty;
104 bool trans_role_set_by_vty;
105 /* Used internally by "asp" node to figure out if "no shutdown"
106 * was done explicitly, in order to avoid automatic asp
107 * reconfiguring/restart at go_parent().
108 * Can be dropped in the future once we make sure everybody uses
109 * "[no] shutdown" explicitly in cfg files. */
110 bool explicit_shutdown_state_by_vty_since_node_enter;
111
112 struct osmo_ss7_asp_peer local;
113 struct osmo_ss7_asp_peer remote;
114 uint8_t qos_class;
115 uint32_t quirks;
116
117 /* Whether to Tx xUA DAUD during ASP activation when in ASP role. */
118 bool daud_act;
119
120 /* T_defs used by the default_lm: */
121 struct osmo_tdef *T_defs_xua;
122
123 /* T_defs used by the default_lm: */
124 struct osmo_tdef *T_defs_lm;
125
126 struct {
127 bool num_ostreams_present;
128 bool max_instreams_present;
129 bool max_attempts_present;
130 bool max_init_timeo_present;
131 uint16_t num_ostreams_value;
132 uint16_t max_instreams_value;
133 uint16_t max_attempts_value;
134 uint16_t max_init_timeo_value; /* ms */
135 } sctp_init;
136
137 struct {
138 bool keepalive_enable;
139 bool keepalive_time_present;
140 bool keepalive_intvl_present;
141 bool keepalive_probes_present;
142 bool user_timeout_present;
143 int keepalive_time_value; /* seconds */
144 int keepalive_intvl_value; /* seconds */
145 int keepalive_probes_value;
146 unsigned int user_timeout_value; /* milliseconds */
147 } tcp;
148
150 int trans_proto;
151 } cfg;
152};
153
154 struct osmo_ss7_asp *ss7_asp_alloc(struct osmo_ss7_instance *inst, const char *name,
155 uint16_t remote_port, uint16_t local_port,
156 int trans_proto, enum osmo_ss7_asp_protocol proto);
157 bool ss7_asp_set_default_peer_hosts(struct osmo_ss7_asp *asp);
158 bool ss7_asp_is_started(const struct osmo_ss7_asp *asp);
159 int ss7_asp_get_fd(const struct osmo_ss7_asp *asp);
160 int ss7_asp_disconnect_stream(struct osmo_ss7_asp *asp);
161
162 int ss7_asp_apply_tcp_pars(const struct osmo_ss7_asp *asp);
163 int ss7_asp_apply_peer_primary_address(const struct osmo_ss7_asp *asp);
164 int ss7_asp_apply_primary_address(const struct osmo_ss7_asp *asp);
165 int ss7_asp_apply_new_local_address(const struct osmo_ss7_asp *asp, unsigned int loc_idx);
166 int ss7_asp_apply_drop_local_address(const struct osmo_ss7_asp *asp, unsigned int loc_idx);
167
168 void ss7_asp_restart_after_reconfigure(struct osmo_ss7_asp *asp);
169 void osmo_ss7_asp_remove_default_lm(struct osmo_ss7_asp *asp);
170
171 unsigned int ss7_asp_get_all_rctx(const struct osmo_ss7_asp *asp, uint32_t *rctx, unsigned int rctx_size,
172 const struct osmo_ss7_as *excl_as);
173 unsigned int ss7_asp_get_all_rctx_be(const struct osmo_ss7_asp *asp, uint32_t *rctx, unsigned int rctx_size,
174 const struct osmo_ss7_as *excl_as);
175
176 int ss7_asp_determine_traf_mode(const struct osmo_ss7_asp *asp);
177
178#define LOGPASP(asp, subsys, level, fmt, args ...) \
179 _LOGSS7((asp)->inst, subsys, level, "ASP(%s) " fmt, (asp)->cfg.name, ## args)
osmo_ss7.h
osmo_ss7_asp_protocol
osmo_ss7_asp_protocol
Definition: osmo_ss7.h:157
osmo_ss7_asp_role
osmo_ss7_asp_role
Definition: osmo_ss7.h:253
osmo_ss7_asp_admin_state
osmo_ss7_asp_admin_state
Definition: osmo_ss7.h:243
ss7_asp_determine_traf_mode
int ss7_asp_determine_traf_mode(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:1574
ss7_asp_is_started
bool ss7_asp_is_started(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:954
osmo_ss7_asp_remove_default_lm
void osmo_ss7_asp_remove_default_lm(struct osmo_ss7_asp *asp)
Definition: xua_default_lm_fsm.c:419
ss7_asp_apply_primary_address
int ss7_asp_apply_primary_address(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:423
ss7_asp_xua_timer
ss7_asp_xua_timer
Definition: ss7_asp.h:22
SS7_ASP_XUA_TIMERS_LEN
@ SS7_ASP_XUA_TIMERS_LEN
Definition: ss7_asp.h:27
SS7_ASP_XUA_T_ACK
@ SS7_ASP_XUA_T_ACK
Definition: ss7_asp.h:24
SS7_ASP_XUA_T_BEAT
@ SS7_ASP_XUA_T_BEAT
Definition: ss7_asp.h:25
ss7_asp_ctr
ss7_asp_ctr
Definition: ss7_asp.h:36
SS7_ASP_CTR_PKT_TX_TOTAL
@ SS7_ASP_CTR_PKT_TX_TOTAL
Definition: ss7_asp.h:40
SS7_ASP_CTR_PKT_RX_NI_MISMATCH
@ SS7_ASP_CTR_PKT_RX_NI_MISMATCH
Definition: ss7_asp.h:39
SS7_ASP_CTR_PKT_RX_UNKNOWN
@ SS7_ASP_CTR_PKT_RX_UNKNOWN
Definition: ss7_asp.h:38
SS7_ASP_CTR_PKT_RX_TOTAL
@ SS7_ASP_CTR_PKT_RX_TOTAL
Definition: ss7_asp.h:37
ss7_asp_restart_after_reconfigure
void ss7_asp_restart_after_reconfigure(struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:1521
ss7_asp_apply_peer_primary_address
int ss7_asp_apply_peer_primary_address(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:381
ss7_asp_get_fd
int ss7_asp_get_fd(const struct osmo_ss7_asp *asp)
Get the fd of a given ASP.
Definition: ss7_asp.c:1508
ss7_asp_disconnect_stream
int ss7_asp_disconnect_stream(struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:843
ss7_asp_xua_timer_defaults
const struct osmo_tdef ss7_asp_xua_timer_defaults[SS7_ASP_XUA_TIMERS_LEN]
Definition: ss7_asp.c:119
ss7_asp_apply_new_local_address
int ss7_asp_apply_new_local_address(const struct osmo_ss7_asp *asp, unsigned int loc_idx)
Definition: ss7_asp.c:337
ss7_asp_apply_tcp_pars
int ss7_asp_apply_tcp_pars(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:328
ss7_asp_get_all_rctx
unsigned int ss7_asp_get_all_rctx(const struct osmo_ss7_asp *asp, uint32_t *rctx, unsigned int rctx_size, const struct osmo_ss7_as *excl_as)
Definition: ss7_asp.c:1563
ss7_asp_apply_drop_local_address
int ss7_asp_apply_drop_local_address(const struct osmo_ss7_asp *asp, unsigned int loc_idx)
Definition: ss7_asp.c:359
ss7_asp_alloc
struct osmo_ss7_asp * ss7_asp_alloc(struct osmo_ss7_instance *inst, const char *name, uint16_t remote_port, uint16_t local_port, int trans_proto, enum osmo_ss7_asp_protocol proto)
Definition: ss7_asp.c:700
ss7_asp_xua_timer_names
const struct value_string ss7_asp_xua_timer_names[]
Definition: ss7_asp.c:128
ss7_asp_get_all_rctx_be
unsigned int ss7_asp_get_all_rctx_be(const struct osmo_ss7_asp *asp, uint32_t *rctx, unsigned int rctx_size, const struct osmo_ss7_as *excl_as)
Definition: ss7_asp.c:1556
ss7_asp_set_default_peer_hosts
bool ss7_asp_set_default_peer_hosts(struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:562
ss7_asp_peer.h
ss7_internal.h
osmo_ss7_as
Definition: ss7_as.h:75
osmo_ss7_asp_peer
Definition: ss7_asp_peer.h:11
osmo_ss7_asp
Definition: ss7_asp.h:43
osmo_ss7_asp::role
enum osmo_ss7_asp_role role
Definition: ss7_asp.h:102
osmo_ss7_asp::sock_name
char * sock_name
pre-formatted human readable local/remote socket name
Definition: ss7_asp.h:59
osmo_ss7_asp::sctp_init
struct osmo_ss7_asp::@27::@28 sctp_init
osmo_ss7_asp::role_set_by_vty
bool role_set_by_vty
Definition: ss7_asp.h:103
osmo_ss7_asp::keepalive_time_value
int keepalive_time_value
Definition: ss7_asp.h:143
osmo_ss7_asp::cfg
struct osmo_ss7_asp::@27 cfg
osmo_ss7_asp::remote
struct osmo_ss7_asp_peer remote
Definition: ss7_asp.h:113
osmo_ss7_asp::max_attempts_present
bool max_attempts_present
Definition: ss7_asp.h:129
osmo_ss7_asp::explicit_shutdown_state_by_vty_since_node_enter
bool explicit_shutdown_state_by_vty_since_node_enter
Definition: ss7_asp.h:110
osmo_ss7_asp::max_instreams_present
bool max_instreams_present
Definition: ss7_asp.h:128
osmo_ss7_asp::T_defs_lm
struct osmo_tdef * T_defs_lm
Definition: ss7_asp.h:124
osmo_ss7_asp::fi
struct osmo_fsm_inst * fi
ASP FSM.
Definition: ss7_asp.h:49
osmo_ss7_asp::max_attempts_value
uint16_t max_attempts_value
Definition: ss7_asp.h:133
osmo_ss7_asp::T_defs_xua
struct osmo_tdef * T_defs_xua
Definition: ss7_asp.h:121
osmo_ss7_asp::max_instreams_value
uint16_t max_instreams_value
Definition: ss7_asp.h:132
osmo_ss7_asp::list
struct llist_head list
entry in osmo_ss7_instance::asp_list
Definition: ss7_asp.h:45
osmo_ss7_asp::sls
uint8_t sls
Definition: ss7_asp.h:92
osmo_ss7_asp::proto
enum osmo_ss7_asp_protocol proto
Definition: ss7_asp.h:99
osmo_ss7_asp::lm_priv
void * lm_priv
Definition: ss7_asp.h:73
osmo_ss7_asp::inst
struct osmo_ss7_instance * inst
Definition: ss7_asp.h:46
osmo_ss7_asp::lm
const struct osmo_xua_layer_manager * lm
Definition: ss7_asp.h:72
osmo_ss7_asp::num_ostreams_present
bool num_ostreams_present
Definition: ss7_asp.h:127
osmo_ss7_asp::remote_asp_id
uint32_t remote_asp_id
Definition: ss7_asp.h:68
osmo_ss7_asp::ipa
struct osmo_ss7_asp::@26 ipa
osmo_ss7_asp::server
struct osmo_stream_srv * server
Definition: ss7_asp.h:57
osmo_ss7_asp::quirks
uint32_t quirks
Definition: ss7_asp.h:115
osmo_ss7_asp::simple_client_allocated
bool simple_client_allocated
Were we allocated by "simple client" support?
Definition: ss7_asp.h:79
osmo_ss7_asp::keepalive_probes_value
int keepalive_probes_value
Definition: ss7_asp.h:145
osmo_ss7_asp::sls_assigned
bool sls_assigned
Definition: ss7_asp.h:93
osmo_ss7_asp::client
struct osmo_stream_cli * client
osmo_stream / libosmo-netif handles
Definition: ss7_asp.h:56
osmo_ss7_asp::trans_role_set_by_vty
bool trans_role_set_by_vty
Definition: ss7_asp.h:104
osmo_ss7_asp::adm_state
enum osmo_ss7_asp_admin_state adm_state
Definition: ss7_asp.h:100
osmo_ss7_asp::xua_server
struct osmo_xua_server * xua_server
osmo_xua_server over which we were established
Definition: ss7_asp.h:52
osmo_ss7_asp::local
struct osmo_ss7_asp_peer local
Definition: ss7_asp.h:112
osmo_ss7_asp::is_server
bool is_server
Definition: ss7_asp.h:101
osmo_ss7_asp::tcp
struct osmo_ss7_asp::@27::@29 tcp
osmo_ss7_asp::keepalive_intvl_value
int keepalive_intvl_value
Definition: ss7_asp.h:144
osmo_ss7_asp::user_timeout_present
bool user_timeout_present
Definition: ss7_asp.h:142
osmo_ss7_asp::user_timeout_value
unsigned int user_timeout_value
Definition: ss7_asp.h:146
osmo_ss7_asp::daud_act
bool daud_act
Definition: ss7_asp.h:118
osmo_ss7_asp::dyn_allocated
bool dyn_allocated
Were we dynamically allocated.
Definition: ss7_asp.h:76
osmo_ss7_asp::max_init_timeo_present
bool max_init_timeo_present
Definition: ss7_asp.h:130
osmo_ss7_asp::name
char * name
Definition: ss7_asp.h:97
osmo_ss7_asp::keepalive_probes_present
bool keepalive_probes_present
Definition: ss7_asp.h:141
osmo_ss7_asp::keepalive_time_present
bool keepalive_time_present
Definition: ss7_asp.h:139
osmo_ss7_asp::keepalive_intvl_present
bool keepalive_intvl_present
Definition: ss7_asp.h:140
osmo_ss7_asp::qos_class
uint8_t qos_class
Definition: ss7_asp.h:114
osmo_ss7_asp::pending_msg
struct msgb * pending_msg
Pending message for non-blocking IPA read.
Definition: ss7_asp.h:85
osmo_ss7_asp::num_ostreams_value
uint16_t num_ostreams_value
Definition: ss7_asp.h:131
osmo_ss7_asp::trans_proto
int trans_proto
The underlaying transport protocol (one of IPPROTO_*)
Definition: ss7_asp.h:150
osmo_ss7_asp::description
char * description
Definition: ss7_asp.h:98
osmo_ss7_asp::keepalive_enable
bool keepalive_enable
Definition: ss7_asp.h:138
osmo_ss7_asp::remote_asp_id_present
bool remote_asp_id_present
Definition: ss7_asp.h:69
osmo_ss7_asp::ctrg
struct rate_ctr_group * ctrg
Rate Counter Group.
Definition: ss7_asp.h:82
osmo_ss7_asp::siblings
struct llist_head siblings
Definition: ss7_asp.h:53
osmo_ss7_asp::max_init_timeo_value
uint16_t max_init_timeo_value
Definition: ss7_asp.h:134
osmo_ss7_instance
Definition: ss7_instance.h:31
osmo_xua_layer_manager
Definition: ss7_xua_srv.h:18
osmo_xua_server
Definition: ss7_xua_srv.h:22