libosmo-sigtran  2.1.0.190-7669.202511211800
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 
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;
21 
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: */
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 
41 };
42 
43 struct osmo_ss7_asp {
45  struct llist_head list;
47 
49  struct osmo_fsm_inst *fi;
50 
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;
70 
71  /* Layer Manager to which we talk */
72  const struct osmo_xua_layer_manager *lm;
73  void *lm_priv;
74 
77 
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;
94  } ipa;
95 
96  struct {
97  char *name;
98  char *description;
101  bool is_server;
102  enum osmo_ss7_asp_role role;
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. */
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 {
134  uint16_t max_init_timeo_value; /* ms */
136 
137  struct {
143  int keepalive_time_value; /* seconds */
144  int keepalive_intvl_value; /* seconds */
146  unsigned int user_timeout_value; /* milliseconds */
147  } tcp;
148 
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,
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 
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 
177 
178 #define LOGPASP(asp, subsys, level, fmt, args ...) \
179  _LOGSS7((asp)->inst, subsys, level, "ASP(%s) " fmt, (asp)->cfg.name, ## args)
osmo_ss7_asp_protocol
Definition: osmo_ss7.h:157
osmo_ss7_asp_role
Definition: osmo_ss7.h:253
osmo_ss7_asp_admin_state
Definition: osmo_ss7.h:243
int ss7_asp_determine_traf_mode(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:1578
bool ss7_asp_is_started(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:959
void osmo_ss7_asp_remove_default_lm(struct osmo_ss7_asp *asp)
Definition: xua_default_lm_fsm.c:419
int ss7_asp_apply_primary_address(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:423
ss7_asp_xua_timer
Definition: ss7_asp.h:22
@ SS7_ASP_XUA_TIMERS_LEN
Definition: ss7_asp.h:27
@ SS7_ASP_XUA_T_ACK
Definition: ss7_asp.h:24
@ SS7_ASP_XUA_T_BEAT
Definition: ss7_asp.h:25
ss7_asp_ctr
Definition: ss7_asp.h:36
@ SS7_ASP_CTR_PKT_TX_TOTAL
Definition: ss7_asp.h:40
@ SS7_ASP_CTR_PKT_RX_NI_MISMATCH
Definition: ss7_asp.h:39
@ SS7_ASP_CTR_PKT_RX_UNKNOWN
Definition: ss7_asp.h:38
@ SS7_ASP_CTR_PKT_RX_TOTAL
Definition: ss7_asp.h:37
void ss7_asp_restart_after_reconfigure(struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:1525
int ss7_asp_apply_peer_primary_address(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:381
int ss7_asp_get_fd(const struct osmo_ss7_asp *asp)
Get the fd of a given ASP.
Definition: ss7_asp.c:1512
int ss7_asp_disconnect_stream(struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:848
const struct osmo_tdef ss7_asp_xua_timer_defaults[SS7_ASP_XUA_TIMERS_LEN]
Definition: ss7_asp.c:119
int ss7_asp_apply_new_local_address(const struct osmo_ss7_asp *asp, unsigned int loc_idx)
Definition: ss7_asp.c:337
int ss7_asp_apply_tcp_pars(const struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:328
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:1567
int ss7_asp_apply_drop_local_address(const struct osmo_ss7_asp *asp, unsigned int loc_idx)
Definition: ss7_asp.c:359
const struct value_string ss7_asp_xua_timer_names[]
Definition: ss7_asp.c:128
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:1560
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
bool ss7_asp_set_default_peer_hosts(struct osmo_ss7_asp *asp)
Definition: ss7_asp.c:562
Definition: ss7_as.h:75
Definition: ss7_asp_peer.h:11
Definition: ss7_asp.h:43
enum osmo_ss7_asp_role role
Definition: ss7_asp.h:102
char * sock_name
pre-formatted human readable local/remote socket name
Definition: ss7_asp.h:59
struct osmo_ss7_asp::@27::@28 sctp_init
bool role_set_by_vty
Definition: ss7_asp.h:103
int keepalive_time_value
Definition: ss7_asp.h:143
struct osmo_ss7_asp::@27 cfg
struct osmo_ss7_asp_peer remote
Definition: ss7_asp.h:113
bool max_attempts_present
Definition: ss7_asp.h:129
bool explicit_shutdown_state_by_vty_since_node_enter
Definition: ss7_asp.h:110
bool max_instreams_present
Definition: ss7_asp.h:128
struct osmo_tdef * T_defs_lm
Definition: ss7_asp.h:124
struct osmo_fsm_inst * fi
ASP FSM.
Definition: ss7_asp.h:49
uint16_t max_attempts_value
Definition: ss7_asp.h:133
struct osmo_tdef * T_defs_xua
Definition: ss7_asp.h:121
uint16_t max_instreams_value
Definition: ss7_asp.h:132
struct llist_head list
entry in osmo_ss7_instance::asp_list
Definition: ss7_asp.h:45
uint8_t sls
Definition: ss7_asp.h:92
enum osmo_ss7_asp_protocol proto
Definition: ss7_asp.h:99
void * lm_priv
Definition: ss7_asp.h:73
struct osmo_ss7_instance * inst
Definition: ss7_asp.h:46
const struct osmo_xua_layer_manager * lm
Definition: ss7_asp.h:72
bool num_ostreams_present
Definition: ss7_asp.h:127
uint32_t remote_asp_id
Definition: ss7_asp.h:68
struct osmo_ss7_asp::@26 ipa
struct osmo_stream_srv * server
Definition: ss7_asp.h:57
uint32_t quirks
Definition: ss7_asp.h:115
bool simple_client_allocated
Were we allocated by "simple client" support?
Definition: ss7_asp.h:79
int keepalive_probes_value
Definition: ss7_asp.h:145
bool sls_assigned
Definition: ss7_asp.h:93
struct osmo_stream_cli * client
osmo_stream / libosmo-netif handles
Definition: ss7_asp.h:56
bool trans_role_set_by_vty
Definition: ss7_asp.h:104
enum osmo_ss7_asp_admin_state adm_state
Definition: ss7_asp.h:100
struct osmo_xua_server * xua_server
osmo_xua_server over which we were established
Definition: ss7_asp.h:52
struct osmo_ss7_asp_peer local
Definition: ss7_asp.h:112
bool is_server
Definition: ss7_asp.h:101
struct osmo_ss7_asp::@27::@29 tcp
int keepalive_intvl_value
Definition: ss7_asp.h:144
bool user_timeout_present
Definition: ss7_asp.h:142
unsigned int user_timeout_value
Definition: ss7_asp.h:146
bool daud_act
Definition: ss7_asp.h:118
bool dyn_allocated
Were we dynamically allocated.
Definition: ss7_asp.h:76
bool max_init_timeo_present
Definition: ss7_asp.h:130
char * name
Definition: ss7_asp.h:97
bool keepalive_probes_present
Definition: ss7_asp.h:141
bool keepalive_time_present
Definition: ss7_asp.h:139
bool keepalive_intvl_present
Definition: ss7_asp.h:140
uint8_t qos_class
Definition: ss7_asp.h:114
struct msgb * pending_msg
Pending message for non-blocking IPA read.
Definition: ss7_asp.h:85
uint16_t num_ostreams_value
Definition: ss7_asp.h:131
int trans_proto
The underlaying transport protocol (one of IPPROTO_*)
Definition: ss7_asp.h:150
char * description
Definition: ss7_asp.h:98
bool keepalive_enable
Definition: ss7_asp.h:138
bool remote_asp_id_present
Definition: ss7_asp.h:69
struct rate_ctr_group * ctrg
Rate Counter Group.
Definition: ss7_asp.h:82
struct llist_head siblings
Definition: ss7_asp.h:53
uint16_t max_init_timeo_value
Definition: ss7_asp.h:134
Definition: ss7_instance.h:31
Definition: ss7_xua_srv.h:18
Definition: ss7_xua_srv.h:22