xua_internal.h

Go to the documentation of this file.

#pragma once
 
#include <unistd.h>
#include <stdint.h>
 
#include <osmocom/core/tdef.h>
#include <osmocom/sigtran/osmo_ss7.h>
#include <osmocom/sigtran/sigtran_sap.h>
#include "xua_msg.h"
 
#define M3UA_MSG_SIZE 2048
#define M3UA_MSG_HEADROOM 512
 
struct osmo_sccp_addr;
struct m3ua_data_hdr;
struct ss7_mtp3_rtlabel;
 
int sua_addr_parse_part(struct osmo_sccp_addr *out,
                        const struct xua_msg_part *param);
int sua_addr_parse(struct osmo_sccp_addr *out, struct xua_msg *xua, uint16_t iei);
 
int sua_parse_gt(struct osmo_sccp_gt *gt, const uint8_t *data, unsigned int datalen);
 
struct xua_msg *osmo_sccp_to_xua(const struct msgb *msg);
struct msgb *osmo_sua_to_sccp(const struct xua_msg *xua);
 
int sua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg);
 
int sua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
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);
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);
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);
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);
 
struct xua_msg *sua_encode_dupu(const uint32_t *rctx, unsigned int num_rctx,
                                uint32_t dpc, uint16_t user, uint16_t cause,
                                const char *info_string);
 
struct xua_msg *sua_gen_cldr(const struct xua_msg *xua_in, uint32_t route_ctx, uint32_t ret_cause);
 
struct msgb *m3ua_to_msg(struct xua_msg *xua);
int m3ua_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
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);
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);
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);
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);
 
struct xua_msg *m3ua_encode_duna(const uint32_t *rctx, unsigned int num_rctx,
                                 const uint32_t *aff_pc, unsigned int num_aff_pc,
                                 const char *info_string);
struct xua_msg *m3ua_encode_dupu(const uint32_t *rctx, unsigned int num_rctx,
                                 uint32_t dpc, uint16_t user, uint16_t cause,
                                 const char *info_string);
 
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);
 
void xua_snm_rx_daud(struct osmo_ss7_asp *asp, const struct xua_msg *xua);
void xua_snm_rx_duna(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as[], unsigned int as_count, const struct xua_msg *xua);
void xua_snm_rx_dava(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as[], unsigned int as_count, const struct xua_msg *xua);
void xua_snm_rx_dupu(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as[], unsigned int as_count, const struct xua_msg *xua);
void xua_snm_rx_scon(struct osmo_ss7_asp *asp, struct osmo_ss7_as *as[], unsigned int as_count, const struct xua_msg *xua);
int m3ua_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg);
 
struct msgb *m3ua_msgb_alloc(const char *name);
struct xua_msg *m3ua_xfer_from_data(const struct m3ua_data_hdr *data_hdr,
                                    const uint8_t *data, unsigned int data_len);
struct m3ua_data_hdr *data_hdr_from_m3ua(const struct xua_msg *xua);
void m3ua_dh_to_mtp3_rtlabel(struct ss7_mtp3_rtlabel *rtlb,
                             const struct m3ua_data_hdr *mdh);
void mtp3_rtlabel_to_m3ua_dh(struct m3ua_data_hdr *mdh,
                             const struct ss7_mtp3_rtlabel *rtlb);
 
 
extern const struct xua_msg_class m3ua_msg_class_mgmt;
extern const struct xua_msg_class m3ua_msg_class_snm;
extern const struct xua_msg_class m3ua_msg_class_rkm;
extern const struct xua_msg_class m3ua_msg_class_aspsm;
extern const struct xua_msg_class m3ua_msg_class_asptm;
extern const struct xua_msg_part_class m3ua_rkm_reg_req_routing_key_ies[];
extern const struct xua_msg_part_class m3ua_rkm_reg_rsp_registration_result_ies[];
extern const struct xua_msg_part_class m3ua_rkm_dereg_rsp_deregistration_result_ies[];
 
extern const struct xua_msg_part_class m3ua_ntfy_req_ies[];
extern const struct xua_msg_part_class m3ua_asp_inact_ies[];
extern const struct xua_msg_part_class m3ua_asp_act_ack_ies[];
extern const struct xua_msg_part_class m3ua_asp_inact_ack_ies[];
 
extern const struct value_string m3ua_snm_msgt_names[];
extern const struct value_string m3ua_mgmt_msgt_names[];
extern const struct value_string m3ua_asptm_msgt_names[];
extern const struct value_string m3ua_err_names[];
extern const struct value_string m3ua_ntfy_type_names[];
extern const struct value_string m3ua_ntfy_stchg_names[];
extern const struct value_string m3ua_ntfy_other_names[];
const char *m3ua_ntfy_info_name(uint16_t ntfy_status_type, uint16_t ntfy_status_info);
 
struct xua_msg *m3ua_encode_notify(const struct osmo_xlm_prim_notify *npar);
int m3ua_decode_notify(struct osmo_xlm_prim_notify *npar, void *ctx,
                        const struct xua_msg *xua);
int m3ua_rx_rkm(struct osmo_ss7_asp *asp, struct xua_msg *xua);
 
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);
 
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);
 
enum ss7_asp_lm_timer {
        /* 0 kept unused on purpose since it's handled specially by osmo_fsm */
        SS7_ASP_LM_T_WAIT_ASP_UP = 1,
        SS7_ASP_LM_T_WAIT_NOTIFY,
        SS7_ASP_LM_T_WAIT_NOTIY_RKM,
        SS7_ASP_LM_T_WAIT_RK_REG_RESP,
        /* This must remain the last item: */
        SS7_ASP_LM_TIMERS_LEN
};
 
extern const struct osmo_tdef ss7_asp_lm_timer_defaults[SS7_ASP_LM_TIMERS_LEN];
 
extern const struct value_string ss7_asp_lm_timer_names[];
static inline const char *ss7_asp_lm_timer_name(enum ss7_asp_lm_timer val)
{ return get_value_string(ss7_asp_lm_timer_names, val); }
 
extern struct osmo_fsm xua_default_lm_fsm;
extern const struct value_string m3ua_rkm_reg_status_vals[];
extern const struct value_string m3ua_rkm_dereg_status_vals[];
extern const struct value_string m3ua_rkm_msgt_names[];
 
int xua_as_transmit_msg(struct osmo_ss7_as *as, struct xua_msg *xua);
 
int xua_find_as_for_asp(struct osmo_ss7_as **as, const struct osmo_ss7_asp *asp,
                        const struct xua_msg_part *rctx_ie);
int xua_find_multiple_as_for_asp(struct osmo_ss7_as **as_array,
                                 unsigned int *as_array_count,
                                 unsigned int as_array_len,
                                 const struct osmo_ss7_asp *asp,
                                 const struct xua_msg_part *rctx_ie);
 
struct msgb *ipa_gen_ping(void);
struct msgb *ipa_to_msg(struct xua_msg *xua);
int ipa_tx_xua_as(struct osmo_ss7_as *as, struct xua_msg *xua);
int ipa_rx_msg(struct osmo_ss7_asp *asp, struct msgb *msg, uint8_t sls);
 
int osmo_isup_party_parse(char *out_digits, size_t out_digits_size,
                          const uint8_t *in, unsigned int in_num_bytes, bool odd);
int osmo_sccp_addr_parse(struct osmo_sccp_addr *out,
                        const uint8_t *addr, unsigned int addrlen);
int osmo_sccp_addr_encode(struct msgb *msg, const struct osmo_sccp_addr *in);
 
int ss7_asp_rx_unknown(struct osmo_ss7_asp *asp, int ppid_mux, struct msgb *msg);
 
void xua_rkm_send_reg_req(struct osmo_ss7_asp *asp,
                          const struct osmo_ss7_routing_key *rkey,
                          enum osmo_ss7_as_traffic_mode traf_mode);
void xua_rkm_send_dereg_req(struct osmo_ss7_asp *asp, uint32_t route_ctx);