sccp_internal.h
Go to the documentation of this file.
#pragma once
#include <osmocom/core/fsm.h>
#include <osmocom/core/prim.h>
#include <osmocom/sigtran/sccp_sap.h>
#include <osmocom/sigtran/osmo_ss7.h>
#define SCCP_STR "Signalling Connection Control Part\n"
/* Appendix C.4 of Q.714 */
enum osmo_sccp_timer {
OSMO_SCCP_TIMER_CONN_EST,
OSMO_SCCP_TIMER_IAS,
OSMO_SCCP_TIMER_IAR,
OSMO_SCCP_TIMER_REL,
OSMO_SCCP_TIMER_REPEAT_REL,
OSMO_SCCP_TIMER_INT,
OSMO_SCCP_TIMER_GUARD,
OSMO_SCCP_TIMER_RESET,
OSMO_SCCP_TIMER_REASSEMBLY,
/* This must remain the last item: */
OSMO_SCCP_TIMERS_COUNT
};
struct osmo_sccp_timer_val {
uint32_t s;
uint32_t us;
};
extern const struct osmo_sccp_timer_val osmo_sccp_timer_defaults[];
extern const struct value_string osmo_sccp_timer_names[];
static inline const char *osmo_sccp_timer_name(enum osmo_sccp_timer val)
{ return get_value_string(osmo_sccp_timer_names, val); }
extern const struct value_string osmo_sccp_timer_descriptions[];
static inline const char *osmo_sccp_timer_description(enum osmo_sccp_timer val)
{ return get_value_string(osmo_sccp_timer_descriptions, val); }
/* an instance of the SCCP stack */
struct osmo_sccp_instance {
/* entry in global list of ss7 instances */
struct llist_head list;
/* list of 'struct sccp_connection' in this instance */
struct llist_head connections;
/* list of SCCP users in this instance */
struct llist_head users;
/* routing context to be used in all outbound messages */
uint32_t route_ctx;
/* next connection ID to allocate */
uint32_t next_id;
struct osmo_ss7_instance *ss7;
void *priv;
struct osmo_ss7_user ss7_user;
struct osmo_sccp_timer_val timers[OSMO_SCCP_TIMERS_COUNT];
};
struct osmo_sccp_user {
struct llist_head list;
struct osmo_sccp_instance *inst;
char *name;
uint16_t ssn;
uint32_t pc;
/* set if we are a server */
struct llist_head links;
/* user call-back function in case of incoming primitives */
osmo_prim_cb prim_cb;
void *priv;
/* Application Server FSM Instance */
struct osmo_fsm_inst *as_fi;
};
extern int DSCCP;
struct xua_msg;
struct osmo_sccp_user *
sccp_user_find(struct osmo_sccp_instance *inst, uint16_t ssn, uint32_t pc);
/* Message from SCOC -> SCRC */
int sccp_scrc_rx_scoc_conn_msg(struct osmo_sccp_instance *inst,
struct xua_msg *xua);
/* Message from SCLC -> SCRC */
int sccp_scrc_rx_sclc_msg(struct osmo_sccp_instance *inst, struct xua_msg *xua);
/* Message from MTP (SUA) -> SCRC */
int scrc_rx_mtp_xfer_ind_xua(struct osmo_sccp_instance *inst,
struct xua_msg *xua);
/* Message from SCRC -> SCOC */
void sccp_scoc_rx_from_scrc(struct osmo_sccp_instance *inst,
struct xua_msg *xua);
void sccp_scoc_rx_scrc_rout_fail(struct osmo_sccp_instance *inst,
struct xua_msg *xua, uint32_t cause);
void sccp_scoc_flush_connections(struct osmo_sccp_instance *inst);
/* Message from SCRC -> SCLC */
int sccp_sclc_rx_from_scrc(struct osmo_sccp_instance *inst,
struct xua_msg *xua);
void sccp_sclc_rx_scrc_rout_fail(struct osmo_sccp_instance *inst,
struct xua_msg *xua, uint32_t cause);
int sccp_user_prim_up(struct osmo_sccp_user *scut, struct osmo_scu_prim *prim);
/* SCU -> SCLC */
int sccp_sclc_user_sap_down(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph);
int sccp_sclc_user_sap_down_nofree(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph);
struct msgb *sccp_msgb_alloc(const char *name);
extern struct osmo_fsm sccp_scoc_fsm;
void sccp_scoc_show_connections(struct vty *vty, struct osmo_sccp_instance *inst);
const struct osmo_sccp_timer_val *osmo_sccp_timer_get(const struct osmo_sccp_instance *inst,
enum osmo_sccp_timer timer,
bool default_if_unset);
void osmo_sccp_vty_write_cs7_node(struct vty *vty, const char *indent, struct osmo_sccp_instance *inst);
osmo_ss7.h
osmo_sccp_vty_write_cs7_node
void osmo_sccp_vty_write_cs7_node(struct vty *vty, const char *indent, struct osmo_sccp_instance *inst)
Definition: sccp_vty.c:227
sccp_sclc_rx_scrc_rout_fail
void sccp_sclc_rx_scrc_rout_fail(struct osmo_sccp_instance *inst, struct xua_msg *xua, uint32_t cause)
SCRC -> SCLC (Routing Failure.
Definition: sccp_sclc.c:332
sccp_scrc_rx_scoc_conn_msg
int sccp_scrc_rx_scoc_conn_msg(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Definition: sccp_scrc.c:396
osmo_sccp_timer
osmo_sccp_timer
Definition: sccp_internal.h:11
OSMO_SCCP_TIMER_REPEAT_REL
@ OSMO_SCCP_TIMER_REPEAT_REL
Definition: sccp_internal.h:16
OSMO_SCCP_TIMER_INT
@ OSMO_SCCP_TIMER_INT
Definition: sccp_internal.h:17
OSMO_SCCP_TIMERS_COUNT
@ OSMO_SCCP_TIMERS_COUNT
Definition: sccp_internal.h:22
OSMO_SCCP_TIMER_GUARD
@ OSMO_SCCP_TIMER_GUARD
Definition: sccp_internal.h:18
OSMO_SCCP_TIMER_REASSEMBLY
@ OSMO_SCCP_TIMER_REASSEMBLY
Definition: sccp_internal.h:20
OSMO_SCCP_TIMER_REL
@ OSMO_SCCP_TIMER_REL
Definition: sccp_internal.h:15
OSMO_SCCP_TIMER_IAS
@ OSMO_SCCP_TIMER_IAS
Definition: sccp_internal.h:13
OSMO_SCCP_TIMER_CONN_EST
@ OSMO_SCCP_TIMER_CONN_EST
Definition: sccp_internal.h:12
OSMO_SCCP_TIMER_RESET
@ OSMO_SCCP_TIMER_RESET
Definition: sccp_internal.h:19
OSMO_SCCP_TIMER_IAR
@ OSMO_SCCP_TIMER_IAR
Definition: sccp_internal.h:14
sccp_user_find
struct osmo_sccp_user * sccp_user_find(struct osmo_sccp_instance *inst, uint16_t ssn, uint32_t pc)
Find a SCCP User registered for given PC+SSN or SSN only First search all users with a valid PC for a...
Definition: sccp_user.c:50
scrc_rx_mtp_xfer_ind_xua
int scrc_rx_mtp_xfer_ind_xua(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Definition: sccp_scrc.c:445
sccp_sclc_user_sap_down
int sccp_sclc_user_sap_down(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph)
Main entrance function for primitives from SCCP User.
Definition: sccp_sclc.c:147
sccp_sclc_user_sap_down_nofree
int sccp_sclc_user_sap_down_nofree(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph)
Main entrance function for primitives from SCCP User.
Definition: sccp_sclc.c:123
DSCCP
int DSCCP
osmo_sccp_timer_name
static const char * osmo_sccp_timer_name(enum osmo_sccp_timer val)
Definition: sccp_internal.h:33
sccp_scoc_rx_from_scrc
void sccp_scoc_rx_from_scrc(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Main entrance function for primitives from the SCRC (Routing Control)
Definition: sccp_scoc.c:1620
sccp_sclc_rx_from_scrc
int sccp_sclc_rx_from_scrc(struct osmo_sccp_instance *inst, struct xua_msg *xua)
SCRC -> SCLC (connectionless message)
Definition: sccp_sclc.c:256
sccp_scrc_rx_sclc_msg
int sccp_scrc_rx_sclc_msg(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Definition: sccp_scrc.c:418
sccp_scoc_rx_scrc_rout_fail
void sccp_scoc_rx_scrc_rout_fail(struct osmo_sccp_instance *inst, struct xua_msg *xua, uint32_t cause)
SCOC: Receive SCRC Routing Failure.
Definition: sccp_scoc.c:1376
osmo_sccp_timer_get
const struct osmo_sccp_timer_val * osmo_sccp_timer_get(const struct osmo_sccp_instance *inst, enum osmo_sccp_timer timer, bool default_if_unset)
Definition: sccp_scoc.c:297
sccp_scoc_show_connections
void sccp_scoc_show_connections(struct vty *vty, struct osmo_sccp_instance *inst)
Definition: sccp_scoc.c:1821
osmo_sccp_timer_description
static const char * osmo_sccp_timer_description(enum osmo_sccp_timer val)
Definition: sccp_internal.h:37
sccp_scoc_flush_connections
void sccp_scoc_flush_connections(struct osmo_sccp_instance *inst)
Definition: sccp_scoc.c:1786
sccp_user_prim_up
int sccp_user_prim_up(struct osmo_sccp_user *scut, struct osmo_scu_prim *prim)
Send a SCCP User SAP Primitive up to the User.
Definition: sccp_user.c:172
sccp_scoc_fsm
struct osmo_fsm sccp_scoc_fsm
Definition: sccp_scoc.c:1289
osmo_sccp_timer_descriptions
const struct value_string osmo_sccp_timer_descriptions[]
Definition: sccp_scoc.c:248
osmo_sccp_timer_names
const struct value_string osmo_sccp_timer_names[]
Definition: sccp_scoc.c:233
osmo_sccp_timer_defaults
const struct osmo_sccp_timer_val osmo_sccp_timer_defaults[]
Definition: sccp_scoc.c:278
sccp_msgb_alloc
struct msgb * sccp_msgb_alloc(const char *name)
Definition: sua.c:63
sccp_sap.h
osmo_sccp_instance
Definition: sccp_internal.h:41
osmo_sccp_instance::next_id
uint32_t next_id
Definition: sccp_internal.h:51
osmo_sccp_instance::connections
struct llist_head connections
Definition: sccp_internal.h:45
osmo_sccp_instance::route_ctx
uint32_t route_ctx
Definition: sccp_internal.h:49
osmo_sccp_instance::ss7
struct osmo_ss7_instance * ss7
Definition: sccp_internal.h:52
osmo_sccp_instance::list
struct llist_head list
Definition: sccp_internal.h:43
osmo_sccp_instance::timers
struct osmo_sccp_timer_val timers[OSMO_SCCP_TIMERS_COUNT]
Definition: sccp_internal.h:57
osmo_sccp_instance::priv
void * priv
Definition: sccp_internal.h:53
osmo_sccp_instance::ss7_user
struct osmo_ss7_user ss7_user
Definition: sccp_internal.h:55
osmo_sccp_instance::users
struct llist_head users
Definition: sccp_internal.h:47
osmo_sccp_timer_val
Definition: sccp_internal.h:25
osmo_sccp_timer_val::us
uint32_t us
Definition: sccp_internal.h:27
osmo_sccp_timer_val::s
uint32_t s
Definition: sccp_internal.h:26
osmo_sccp_user
Definition: sccp_internal.h:60
osmo_sccp_user::as_fi
struct osmo_fsm_inst * as_fi
Definition: sccp_internal.h:80
osmo_sccp_user::inst
struct osmo_sccp_instance * inst
pointer back to SCCP instance
Definition: sccp_internal.h:64
osmo_sccp_user::pc
uint32_t pc
Definition: sccp_internal.h:70
osmo_sccp_user::links
struct llist_head links
Definition: sccp_internal.h:73
osmo_sccp_user::priv
void * priv
Definition: sccp_internal.h:77
osmo_sccp_user::ssn
uint16_t ssn
SSN and/or point code to which we are bound.
Definition: sccp_internal.h:69
osmo_sccp_user::name
char * name
human-readable name of this user
Definition: sccp_internal.h:66
osmo_sccp_user::prim_cb
osmo_prim_cb prim_cb
Definition: sccp_internal.h:76
osmo_sccp_user::list
struct llist_head list
entry in list of sccp users of osmo_sccp_instance
Definition: sccp_internal.h:62
osmo_scu_prim
Definition: sccp_sap.h:225
osmo_ss7_instance
Definition: osmo_ss7.h:71
osmo_ss7_user
Definition: osmo_ss7.h:121
xua_msg
Definition: xua_msg.h:31