libosmo-sigtran  1.8.0.22-42ed.202310312026
Osmocom SIGTRAN library
xua_internal.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <osmocom/core/tdef.h>
6 
7 struct osmo_sccp_addr;
8 struct m3ua_data_hdr;
9 
10 int sua_addr_parse_part(struct osmo_sccp_addr *out,
11  const struct xua_msg_part *param);
12 int sua_addr_parse(struct osmo_sccp_addr *out, struct xua_msg *xua, uint16_t iei);
13 
14 int sua_parse_gt(struct osmo_sccp_gt *gt, const uint8_t *data, unsigned int datalen);
15 
16 struct xua_msg *osmo_sccp_to_xua(struct msgb *msg);
17 struct msgb *osmo_sua_to_sccp(struct xua_msg *xua);
18 
19 int sua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg);
20 
21 int sua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
22 void sua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
23  const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *aff_ssn,
24  const uint32_t *smi, const char *info_string, bool available);
25 void sua_tx_snm_congestion(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
26  const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *ssn,
27  const uint8_t cong_level, const char *info_string);
28 void sua_tx_dupu(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
29  uint32_t dpc, uint16_t user, uint16_t cause, const char *info_str);
30 
31 struct osmo_mtp_prim *m3ua_to_xfer_ind(struct xua_msg *xua);
32 int m3ua_hmdc_rx_from_l2(struct osmo_ss7_instance *inst, struct xua_msg *xua);
33 int m3ua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
34 void m3ua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
35  const uint32_t *aff_pc, unsigned int num_aff_pc,
36  const char *info_string, bool available);
37 void m3ua_tx_snm_congestion(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
38  const uint32_t *aff_pc, unsigned int num_aff_pc,
39  const uint32_t *concerned_dpc, const uint8_t *cong_level,
40  const char *info_string);
41 void m3ua_tx_dupu(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
42  uint32_t dpc, uint16_t user, uint16_t cause, const char *info_str);
43 
44 void xua_snm_rx_daud(struct osmo_ss7_asp *asp, struct xua_msg *xua);
45 void xua_snm_rx_duna(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
46 void xua_snm_rx_dava(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
47 void xua_snm_rx_dupu(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
48 void xua_snm_rx_scon(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
49 int m3ua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg);
50 
51 struct msgb *m3ua_msgb_alloc(const char *name);
52 struct xua_msg *m3ua_xfer_from_data(const struct m3ua_data_hdr *data_hdr,
53  const uint8_t *data, unsigned int data_len);
54 struct m3ua_data_hdr *data_hdr_from_m3ua(struct xua_msg *xua);
56  const struct m3ua_data_hdr *mdh);
58  const struct osmo_mtp_transfer_param *param);
59 
60 
61 extern const struct xua_msg_class m3ua_msg_class_mgmt;
62 extern const struct xua_msg_class m3ua_msg_class_snm;
63 extern const struct xua_msg_class m3ua_msg_class_rkm;
64 extern const struct xua_msg_class m3ua_msg_class_aspsm;
65 extern const struct xua_msg_class m3ua_msg_class_asptm;
66 
67 extern const struct value_string m3ua_err_names[];
68 extern const struct value_string m3ua_ntfy_type_names[];
69 extern const struct value_string m3ua_ntfy_stchg_names[];
70 extern const struct value_string m3ua_ntfy_other_names[];
71 
72 struct xua_msg *m3ua_encode_notify(const struct osmo_xlm_prim_notify *npar);
73 int m3ua_decode_notify(struct osmo_xlm_prim_notify *npar, void *ctx,
74  const struct xua_msg *xua);
75 int m3ua_rx_rkm(struct osmo_ss7_asp *asp, struct xua_msg *xua);
77 
79  enum osmo_prim_operation op);
80 
81 void xua_asp_send_xlm_prim(struct osmo_ss7_asp *asp, struct osmo_xlm_prim *prim);
83  enum osmo_xlm_prim_type prim_type,
84  enum osmo_prim_operation op);
85 
86 void xua_snm_pc_available(struct osmo_ss7_as *as, const uint32_t *aff_pc,
87  unsigned int num_aff_pc, const char *info_str, bool available);
88 
90  /* 0 kept unused on purpose since it's handled specially by osmo_fsm */
95  /* This must remain the last item: */
97 };
98 
99 extern const struct osmo_tdef ss7_asp_lm_timer_defaults[SS7_ASP_LM_TIMERS_LEN];
100 
101 extern const struct value_string ss7_asp_lm_timer_names[];
102 static inline const char *ss7_asp_lm_timer_name(enum ss7_asp_lm_timer val)
103 { return get_value_string(ss7_asp_lm_timer_names, val); }
104 
105 extern struct osmo_fsm xua_default_lm_fsm;
106 extern const struct value_string m3ua_rkm_reg_status_vals[];
107 extern const struct value_string m3ua_rkm_dereg_status_vals[];
108 
109 #define CS7_STR "ITU-T Signaling System 7\n"
110 #define PC_STR "Point Code\n"
111 #define INST_STR "An instance of the SS7 stack\n"
112 
113 int xua_as_transmit_msg(struct osmo_ss7_as *as, struct msgb *msg);
114 
115 int xua_find_as_for_asp(struct osmo_ss7_as **as, const struct osmo_ss7_asp *asp,
116  const struct xua_msg_part *rctx_ie);
117 
118 int ipa_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
119 int ipa_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg, uint8_t sls);
120 
121 int osmo_isup_party_parse(char *out_digits, const uint8_t *in,
122  unsigned int in_num_bytes, bool odd);
123 int osmo_sccp_addr_parse(struct osmo_sccp_addr *out,
124  const uint8_t *addr, unsigned int addrlen);
125 int osmo_sccp_addr_encode(struct msgb *msg, const struct osmo_sccp_addr *in);
126 
127 int ss7_asp_rx_unknown(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg);
uint8_t sls
Definition: m3ua.h:5
uint32_t dpc
Definition: m3ua.h:1
uint8_t smi
Definition: sccp_scmg.h:3
osmo_xlm_prim_type
Definition: sigtran_sap.h:13
Definition: m3ua.h:95
Definition: mtp_sap.h:56
Definition: mtp_sap.h:36
Definition: sccp_sap.h:183
Definition: sccp_sap.h:175
Definition: osmo_ss7.h:300
Definition: osmo_ss7.h:390
Definition: osmo_ss7.h:73
Definition: sigtran_sap.h:37
Definition: sigtran_sap.h:66
Definition: xua_msg.h:48
Definition: xua_msg.h:38
Definition: xua_msg.h:31
const struct value_string m3ua_rkm_reg_status_vals[]
Definition: xua_rkm.c:35
const struct value_string m3ua_ntfy_type_names[]
Definition: m3ua.c:80
void xua_snm_rx_scon(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:458
const struct value_string m3ua_err_names[]
Definition: m3ua.c:56
void xua_snm_rx_dupu(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:424
int sua_addr_parse(struct osmo_sccp_addr *out, struct xua_msg *xua, uint16_t iei)
parse SCCP address from given xUA message IE
Definition: sua.c:502
int ipa_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg, uint8_t sls)
process M3UA message received from socket
Definition: ipa.c:298
void m3ua_tx_dupu(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx, uint32_t dpc, uint16_t user, uint16_t cause, const char *info_str)
Transmit SSNM DUPU message indicating user unavailability.
Definition: m3ua.c:911
int xua_find_as_for_asp(struct osmo_ss7_as **as, const struct osmo_ss7_asp *asp, const struct xua_msg_part *rctx_ie)
Find the AS for given ASP + optional routing context IE.
Definition: xua_shared.c:68
void m3ua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx, const uint32_t *aff_pc, unsigned int num_aff_pc, const char *info_string, bool available)
Transmit SSNM DUNA/DAVA message indicating [un]availability of certain point code[s].
Definition: m3ua.c:854
struct msgb * m3ua_msgb_alloc(const char *name)
Definition: m3ua.c:316
void sua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx, const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *aff_ssn, const uint32_t *smi, const char *info_string, bool available)
Transmit SSNM DUNA/DAVA message indicating [un]availability of certain point code[s].
Definition: sua.c:866
int m3ua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua)
Send a given xUA message via a given M3UA Application Server.
Definition: m3ua.c:493
const struct value_string m3ua_ntfy_stchg_names[]
Definition: m3ua.c:86
const struct xua_msg_class m3ua_msg_class_snm
Definition: m3ua.c:176
int m3ua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg)
process M3UA message received from socket
Definition: m3ua.c:691
int osmo_isup_party_parse(char *out_digits, const uint8_t *in, unsigned int in_num_bytes, bool odd)
Parse ISUP style address of BCD digets.
Definition: sccp2sua.c:73
int m3ua_decode_notify(struct osmo_xlm_prim_notify *npar, void *ctx, const struct xua_msg *xua)
Definition: m3ua.c:410
int ipa_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua)
Send a given xUA message via a given IPA "Application Server".
Definition: ipa.c:58
void xua_snm_rx_dava(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:389
void xua_rkm_cleanup_dyn_as_for_asp(struct osmo_ss7_asp *asp)
Definition: xua_rkm.c:587
const struct osmo_tdef ss7_asp_lm_timer_defaults[SS7_ASP_LM_TIMERS_LEN]
Definition: xua_default_lm_fsm.c:83
const struct value_string m3ua_rkm_dereg_status_vals[]
Definition: xua_rkm.c:52
int ss7_asp_rx_unknown(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg)
Definition: osmo_ss7_asp.c:1066
int sua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg)
process SUA message received from socket
Definition: sua.c:677
void mtp_xfer_param_to_m3ua_dh(struct m3ua_data_hdr *mdh, const struct osmo_mtp_transfer_param *param)
Definition: m3ua.c:289
struct osmo_fsm xua_default_lm_fsm
Definition: xua_default_lm_fsm.c:377
void xua_asp_send_xlm_prim(struct osmo_ss7_asp *asp, struct osmo_xlm_prim *prim)
Definition: xua_asp_fsm.c:106
int sua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua)
Send a given xUA message via a given SUA Application Server.
Definition: sua.c:305
void sua_tx_snm_congestion(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx, const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *ssn, const uint8_t cong_level, const char *info_string)
Transmit SSNM SCON message indicating congestion.
Definition: sua.c:890
const struct xua_msg_class m3ua_msg_class_rkm
Definition: m3ua.c:260
int sua_addr_parse_part(struct osmo_sccp_addr *out, const struct xua_msg_part *param)
parse SCCP address from given xUA message part
Definition: sua.c:374
static const char * ss7_asp_lm_timer_name(enum ss7_asp_lm_timer val)
Definition: xua_internal.h:102
struct xua_msg * m3ua_encode_notify(const struct osmo_xlm_prim_notify *npar)
Definition: m3ua.c:381
int m3ua_hmdc_rx_from_l2(struct osmo_ss7_instance *inst, struct xua_msg *xua)
Definition: osmo_ss7_hmrt.c:278
const struct value_string ss7_asp_lm_timer_names[]
Definition: xua_default_lm_fsm.c:96
const struct xua_msg_class m3ua_msg_class_aspsm
Definition: m3ua.c:199
const struct xua_msg_class m3ua_msg_class_asptm
Definition: m3ua.c:212
const struct value_string m3ua_ntfy_other_names[]
Definition: m3ua.c:94
struct xua_msg * m3ua_xfer_from_data(const struct m3ua_data_hdr *data_hdr, const uint8_t *data, unsigned int data_len)
Definition: m3ua.c:324
void xua_snm_pc_available(struct osmo_ss7_as *as, const uint32_t *aff_pc, unsigned int num_aff_pc, const char *info_str, bool available)
Definition: xua_snm.c:169
int m3ua_rx_rkm(struct osmo_ss7_asp *asp, struct xua_msg *xua)
Definition: xua_rkm.c:527
void m3ua_dh_to_xfer_param(struct osmo_mtp_transfer_param *param, const struct m3ua_data_hdr *mdh)
Definition: m3ua.c:301
const struct xua_msg_class m3ua_msg_class_mgmt
Definition: m3ua.c:230
ss7_asp_lm_timer
Definition: xua_internal.h:89
@ SS7_ASP_LM_T_WAIT_ASP_UP
Definition: xua_internal.h:91
@ SS7_ASP_LM_TIMERS_LEN
Definition: xua_internal.h:96
@ SS7_ASP_LM_T_WAIT_NOTIFY
Definition: xua_internal.h:92
@ SS7_ASP_LM_T_WAIT_RK_REG_RESP
Definition: xua_internal.h:94
@ SS7_ASP_LM_T_WAIT_NOTIY_RKM
Definition: xua_internal.h:93
struct osmo_xlm_prim * xua_xlm_prim_alloc(enum osmo_xlm_prim_type prim_type, enum osmo_prim_operation op)
Definition: xua_asp_fsm.c:91
struct xua_msg * osmo_sccp_to_xua(struct msgb *msg)
convert SCCP message to a SUA message
Definition: sccp2sua.c:1667
int osmo_sccp_addr_encode(struct msgb *msg, const struct osmo_sccp_addr *in)
encode a SCCP address from parsed format to wire format
Definition: sccp2sua.c:225
void m3ua_tx_snm_congestion(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx, const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *concerned_dpc, const uint8_t *cong_level, const char *info_string)
Transmit SSNM SCON message indicating congestion.
Definition: m3ua.c:878
int sua_parse_gt(struct osmo_sccp_gt *gt, const uint8_t *data, unsigned int datalen)
Decode SUA Global Title according to RFC3868 Section 3.10.2.3.
Definition: sua.c:337
int osmo_sccp_addr_parse(struct osmo_sccp_addr *out, const uint8_t *addr, unsigned int addrlen)
Parse wire-encoded SCCP address into osmo_sccp_addr.
Definition: sccp2sua.c:119
struct msgb * osmo_sua_to_sccp(struct xua_msg *xua)
convert parsed SUA message to SCCP message
Definition: sccp2sua.c:1781
void xua_asp_send_xlm_prim_simple(struct osmo_ss7_asp *asp, enum osmo_xlm_prim_type prim_type, enum osmo_prim_operation op)
Definition: xua_asp_fsm.c:121
void xua_snm_rx_duna(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:354
struct m3ua_data_hdr * data_hdr_from_m3ua(struct xua_msg *xua)
Definition: m3ua.c:521
void sua_tx_dupu(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx, uint32_t dpc, uint16_t user, uint16_t cause, const char *info_str)
Transmit SSNM DUPU message indicating user unavailability.
Definition: sua.c:917
void xua_snm_rx_daud(struct osmo_ss7_asp *asp, struct xua_msg *xua)
Definition: xua_snm.c:309
int xua_as_transmit_msg(struct osmo_ss7_as *as, struct msgb *msg)
Definition: xua_as_fsm.c:152
struct osmo_mtp_prim * m3ua_to_xfer_ind(struct xua_msg *xua)
Definition: osmo_ss7_hmrt.c:41
uint8_t data[0]
Definition: xua_types.h:5