libosmo-sigtran  2.1.0.189-f95eb5.202511201800
Osmocom SIGTRAN library
xua_internal.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <unistd.h>
4 #include <stdint.h>
5 
6 #include <osmocom/core/tdef.h>
8 #include "xua_msg.h"
9 
10 #define M3UA_MSG_SIZE 2048
11 #define M3UA_MSG_HEADROOM 512
12 
13 struct osmo_sccp_addr;
14 struct m3ua_data_hdr;
15 
16 int sua_addr_parse_part(struct osmo_sccp_addr *out,
17  const struct xua_msg_part *param);
18 int sua_addr_parse(struct osmo_sccp_addr *out, struct xua_msg *xua, uint16_t iei);
19 
20 int sua_parse_gt(struct osmo_sccp_gt *gt, const uint8_t *data, unsigned int datalen);
21 
22 struct xua_msg *osmo_sccp_to_xua(const struct msgb *msg);
23 struct msgb *osmo_sua_to_sccp(const struct xua_msg *xua);
24 
25 int sua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg);
26 
27 int sua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
28 void sua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
29  const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *aff_ssn,
30  const uint32_t *smi, const char *info_string, bool available);
31 void sua_tx_snm_congestion(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
32  const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *ssn,
33  const uint8_t cong_level, const char *info_string);
34 void sua_tx_snm_daud(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
35  const uint32_t *aff_pc, unsigned int num_aff_pc, const uint32_t *aff_ssn,
36  const uint32_t *smi, const char *info_string);
37 void sua_tx_dupu(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
38  uint32_t dpc, uint16_t user, uint16_t cause, const char *info_str);
39 
40 int m3ua_hmdc_rx_from_l2(struct osmo_ss7_instance *inst, struct xua_msg *xua);
41 struct msgb *m3ua_to_msg(struct xua_msg *xua);
42 int m3ua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
43 void m3ua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
44  const uint32_t *aff_pc, unsigned int num_aff_pc,
45  const char *info_string, bool available);
46 void m3ua_tx_snm_congestion(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
47  const uint32_t *aff_pc, unsigned int num_aff_pc,
48  const uint32_t *concerned_dpc, const uint8_t *cong_level,
49  const char *info_string);
50 void m3ua_tx_snm_daud(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
51  const uint32_t *aff_pc, unsigned int num_aff_pc, const char *info_string);
52 void m3ua_tx_dupu(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
53  uint32_t dpc, uint16_t user, uint16_t cause, const char *info_str);
54 
55 void xua_tx_snm_available(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
56  const uint32_t *aff_pc, unsigned int num_aff_pc,
57  const char *info_str, bool available);
58 
59 void xua_snm_rx_daud(struct osmo_ss7_asp *asp, struct xua_msg *xua);
60 void xua_snm_rx_duna(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
61 void xua_snm_rx_dava(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
62 void xua_snm_rx_dupu(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
63 void xua_snm_rx_scon(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua);
64 int m3ua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg);
65 
66 struct msgb *m3ua_msgb_alloc(const char *name);
67 struct xua_msg *m3ua_xfer_from_data(const struct m3ua_data_hdr *data_hdr,
68  const uint8_t *data, unsigned int data_len);
69 struct m3ua_data_hdr *data_hdr_from_m3ua(const struct xua_msg *xua);
71  const struct m3ua_data_hdr *mdh);
73  const struct osmo_mtp_transfer_param *param);
75  const struct osmo_mtp_transfer_param *param,
76  uint8_t *user_data, size_t user_data_len);
77 
78 
79 extern const struct xua_msg_class m3ua_msg_class_mgmt;
80 extern const struct xua_msg_class m3ua_msg_class_snm;
81 extern const struct xua_msg_class m3ua_msg_class_rkm;
82 extern const struct xua_msg_class m3ua_msg_class_aspsm;
83 extern const struct xua_msg_class m3ua_msg_class_asptm;
84 
85 extern const struct value_string m3ua_err_names[];
86 extern const struct value_string m3ua_ntfy_type_names[];
87 extern const struct value_string m3ua_ntfy_stchg_names[];
88 extern const struct value_string m3ua_ntfy_other_names[];
89 const char *m3ua_ntfy_info_name(uint16_t ntfy_status_type, uint16_t ntfy_status_info);
90 
91 struct xua_msg *m3ua_encode_notify(const struct osmo_xlm_prim_notify *npar);
92 int m3ua_decode_notify(struct osmo_xlm_prim_notify *npar, void *ctx,
93  const struct xua_msg *xua);
94 int m3ua_rx_rkm(struct osmo_ss7_asp *asp, struct xua_msg *xua);
96 
98  enum osmo_prim_operation op);
99 
100 void xua_asp_send_xlm_prim(struct osmo_ss7_asp *asp, struct osmo_xlm_prim *prim);
102  enum osmo_xlm_prim_type prim_type,
103  enum osmo_prim_operation op);
104 
105 void xua_snm_pc_available(struct osmo_ss7_as *as, const uint32_t *aff_pc,
106  unsigned int num_aff_pc, const char *info_str, bool available);
107 
108 void xua_tx_snm_daud(struct osmo_ss7_asp *asp, const uint32_t *rctx, unsigned int num_rctx,
109  const uint32_t *aff_pc, unsigned int num_aff_pc, const char *info_str);
110 
112  /* 0 kept unused on purpose since it's handled specially by osmo_fsm */
117  /* This must remain the last item: */
119 };
120 
121 extern const struct osmo_tdef ss7_asp_lm_timer_defaults[SS7_ASP_LM_TIMERS_LEN];
122 
123 extern const struct value_string ss7_asp_lm_timer_names[];
124 static inline const char *ss7_asp_lm_timer_name(enum ss7_asp_lm_timer val)
125 { return get_value_string(ss7_asp_lm_timer_names, val); }
126 
127 extern struct osmo_fsm xua_default_lm_fsm;
128 extern const struct value_string m3ua_rkm_reg_status_vals[];
129 extern const struct value_string m3ua_rkm_dereg_status_vals[];
130 
131 int xua_as_transmit_msg(struct osmo_ss7_as *as, struct xua_msg *xua);
132 
133 int xua_find_as_for_asp(struct osmo_ss7_as **as, const struct osmo_ss7_asp *asp,
134  const struct xua_msg_part *rctx_ie);
135 
136 struct msgb *ipa_gen_ping(void);
137 struct msgb *ipa_to_msg(struct xua_msg *xua);
138 int ipa_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
139 int ipa_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg, uint8_t sls);
140 struct osmo_ss7_as *ipa_find_as_for_asp(struct osmo_ss7_asp *asp);
141 
142 int osmo_isup_party_parse(char *out_digits, const uint8_t *in,
143  unsigned int in_num_bytes, bool odd);
144 int osmo_sccp_addr_parse(struct osmo_sccp_addr *out,
145  const uint8_t *addr, unsigned int addrlen);
146 int osmo_sccp_addr_encode(struct msgb *msg, const struct osmo_sccp_addr *in);
147 
148 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:42
Definition: sccp_sap.h:183
Definition: sccp_sap.h:175
Definition: ss7_as.h:75
Definition: ss7_asp.h:43
Definition: ss7_instance.h:31
Definition: sigtran_sap.h:37
Definition: sigtran_sap.h:67
Definition: xua_msg.h:49
Definition: xua_msg.h:39
Definition: xua_msg.h:31
const struct value_string m3ua_rkm_reg_status_vals[]
Definition: xua_rkm.c:40
const struct value_string m3ua_ntfy_type_names[]
Definition: m3ua.c:82
void xua_snm_rx_scon(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:591
void sua_tx_snm_daud(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)
Transmit SSNM DAUD message requesting [un]availability status of certain point code[s].
Definition: sua.c:925
const struct value_string m3ua_err_names[]
Definition: m3ua.c:58
void xua_snm_rx_dupu(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:557
int xua_as_transmit_msg(struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_as_fsm.c:191
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:507
int ipa_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg, uint8_t sls)
process M3UA message received from socket
Definition: ipa.c:331
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:1013
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:71
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:943
struct msgb * m3ua_msgb_alloc(const char *name)
Definition: m3ua.c:328
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:873
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:550
struct m3ua_data_hdr * data_hdr_from_m3ua(const struct xua_msg *xua)
Definition: m3ua.c:573
const struct value_string m3ua_ntfy_stchg_names[]
Definition: m3ua.c:88
struct msgb * ipa_gen_ping(void)
Definition: ipa.c:56
const struct xua_msg_class m3ua_msg_class_snm
Definition: m3ua.c:191
int m3ua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg)
process M3UA message received from socket
Definition: m3ua.c:785
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
struct msgb * ipa_to_msg(struct xua_msg *xua)
Definition: ipa.c:69
int m3ua_decode_notify(struct osmo_xlm_prim_notify *npar, void *ctx, const struct xua_msg *xua)
Definition: m3ua.c:446
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:115
void xua_snm_rx_dava(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:522
void xua_rkm_cleanup_dyn_as_for_asp(struct osmo_ss7_asp *asp)
Definition: xua_rkm.c:635
const struct osmo_tdef ss7_asp_lm_timer_defaults[SS7_ASP_LM_TIMERS_LEN]
Definition: xua_default_lm_fsm.c:86
const struct value_string m3ua_rkm_dereg_status_vals[]
Definition: xua_rkm.c:57
int ss7_asp_rx_unknown(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg)
Definition: ss7_asp.c:1447
int sua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg)
process SUA message received from socket
Definition: sua.c:686
struct osmo_ss7_as * ipa_find_as_for_asp(struct osmo_ss7_asp *asp)
Definition: ipa.c:155
void mtp_xfer_param_to_m3ua_dh(struct m3ua_data_hdr *mdh, const struct osmo_mtp_transfer_param *param)
Definition: m3ua.c:304
struct osmo_fsm xua_default_lm_fsm
Definition: xua_default_lm_fsm.c:383
void xua_asp_send_xlm_prim(struct osmo_ss7_asp *asp, struct osmo_xlm_prim *prim)
Definition: xua_asp_fsm.c:116
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:311
struct msgb * m3ua_to_msg(struct xua_msg *xua)
Definition: m3ua.c:505
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:897
const struct xua_msg_class m3ua_msg_class_rkm
Definition: m3ua.c:275
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:375
static const char * ss7_asp_lm_timer_name(enum ss7_asp_lm_timer val)
Definition: xua_internal.h:124
struct xua_msg * m3ua_encode_notify(const struct osmo_xlm_prim_notify *npar)
Definition: m3ua.c:414
int m3ua_hmdc_rx_from_l2(struct osmo_ss7_instance *inst, struct xua_msg *xua)
Definition: ss7_hmrt.c:218
const char * m3ua_ntfy_info_name(uint16_t ntfy_status_type, uint16_t ntfy_status_info)
Definition: m3ua.c:103
struct xua_msg * osmo_sccp_to_xua(const struct msgb *msg)
convert SCCP message to a SUA message
Definition: sccp2sua.c:1667
struct msgb * osmo_sua_to_sccp(const struct xua_msg *xua)
convert parsed SUA message to SCCP message
Definition: sccp2sua.c:1781
const struct value_string ss7_asp_lm_timer_names[]
Definition: xua_default_lm_fsm.c:99
int hmrt_mtp_xfer_request_l4_to_l3(struct osmo_ss7_instance *inst, const struct osmo_mtp_transfer_param *param, uint8_t *user_data, size_t user_data_len)
Definition: ss7_hmrt.c:233
const struct xua_msg_class m3ua_msg_class_aspsm
Definition: m3ua.c:214
const struct xua_msg_class m3ua_msg_class_asptm
Definition: m3ua.c:227
const struct value_string m3ua_ntfy_other_names[]
Definition: m3ua.c:96
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:336
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:223
int m3ua_rx_rkm(struct osmo_ss7_asp *asp, struct xua_msg *xua)
Definition: xua_rkm.c:573
void m3ua_tx_snm_daud(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)
Transmit SSNM DAUD message requesting [un]availability status of certain point code[s].
Definition: m3ua.c:998
void m3ua_dh_to_xfer_param(struct osmo_mtp_transfer_param *param, const struct m3ua_data_hdr *mdh)
Definition: m3ua.c:316
void xua_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_str, bool available)
Definition: xua_snm.c:71
const struct xua_msg_class m3ua_msg_class_mgmt
Definition: m3ua.c:245
ss7_asp_lm_timer
Definition: xua_internal.h:111
@ SS7_ASP_LM_T_WAIT_ASP_UP
Definition: xua_internal.h:113
@ SS7_ASP_LM_TIMERS_LEN
Definition: xua_internal.h:118
@ SS7_ASP_LM_T_WAIT_NOTIFY
Definition: xua_internal.h:114
@ SS7_ASP_LM_T_WAIT_RK_REG_RESP
Definition: xua_internal.h:116
@ SS7_ASP_LM_T_WAIT_NOTIY_RKM
Definition: xua_internal.h:115
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:101
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:966
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:338
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
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:131
void xua_snm_rx_duna(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as, struct xua_msg *xua)
Definition: xua_snm.c:487
void xua_tx_snm_daud(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_str)
Definition: xua_snm.c:87
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:941
void xua_snm_rx_daud(struct osmo_ss7_asp *asp, struct xua_msg *xua)
Definition: xua_snm.c:408
uint8_t data[0]
Definition: xua_types.h:5