libosmo-sigtran  1.9.0.4-dc82
Osmocom SIGTRAN library
sccp_internal.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <osmocom/core/fsm.h>
4 #include <osmocom/core/prim.h>
5 #include <osmocom/core/linuxlist.h>
6 #include <osmocom/core/linuxrbtree.h>
7 #include <osmocom/core/tdef.h>
11 
12 #define SCCP_STR "Signalling Connection Control Part\n"
13 
14 /* Appendix C.4 of Q.714 */
16  /* 0 kept unused on purpose since it's handled specially by osmo_fsm */
26  /* This must remain the last item: */
28 };
29 
30 extern const struct osmo_tdef osmo_sccp_timer_defaults[OSMO_SCCP_TIMERS_LEN];
31 
32 extern const struct value_string osmo_sccp_timer_names[];
33 static inline const char *osmo_sccp_timer_name(enum osmo_sccp_timer val)
34 { return get_value_string(osmo_sccp_timer_names, val); }
35 
36 /* an instance of the SCCP stack */
38  /* entry in global list of ss7 instances */
39  struct llist_head list;
40  /* rbtree root of 'struct sccp_connection' in this instance */
41  struct rb_root connections;
42  /* list of SCCP users in this instance */
43  struct llist_head users;
44  /* routing context to be used in all outbound messages */
45  uint32_t route_ctx;
46  /* next connection ID to allocate */
47  uint32_t next_id;
49  void *priv;
50 
52 
53  struct osmo_tdef *tdefs;
54 
56 };
57 
60  struct llist_head list;
64  char *name;
65 
67  uint16_t ssn;
68  uint32_t pc;
69 
70  /* set if we are a server */
71  struct llist_head links;
72 
73  /* user call-back function in case of incoming primitives */
74  osmo_prim_cb prim_cb;
75  void *priv;
76 
77  /* Application Server FSM Instance */
78  struct osmo_fsm_inst *as_fi;
79 };
80 
81 extern int DSCCP;
82 
83 struct xua_msg;
84 
85 struct osmo_sccp_user *
86 sccp_user_find(struct osmo_sccp_instance *inst, uint16_t ssn, uint32_t pc);
87 
88 /* Message from SCOC -> SCRC */
90  struct xua_msg *xua);
91 
92 /* Message from SCLC -> SCRC */
93 int sccp_scrc_rx_sclc_msg(struct osmo_sccp_instance *inst, struct xua_msg *xua);
94 
95 /* Message from MTP (SUA) -> SCRC */
97  struct xua_msg *xua);
98 
99 /* Message from SCRC -> SCOC */
101  struct xua_msg *xua);
103  struct xua_msg *xua, uint32_t cause);
104 
106 
107 /* Message from SCRC -> SCLC */
109  struct xua_msg *xua);
111  struct xua_msg *xua, uint32_t cause);
112 
113 int sccp_user_prim_up(struct osmo_sccp_user *scut, struct osmo_scu_prim *prim);
114 
115 /* SCU -> SCLC */
116 int sccp_sclc_user_sap_down(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph);
117 int sccp_sclc_user_sap_down_nofree(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph);
118 
119 struct msgb *sccp_msgb_alloc(const char *name);
120 
121 extern struct osmo_fsm sccp_scoc_fsm;
122 
123 void sccp_scoc_show_connections(struct vty *vty, struct osmo_sccp_instance *inst);
124 
125 void osmo_sccp_vty_write_cs7_node(struct vty *vty, const char *indent, struct osmo_sccp_instance *inst);
126 
127 /* Local Broadcast (LBCS) */
129  const struct osmo_scu_pcstate_param *pcstate);
131  const struct osmo_scu_state_param *state);
132 
133 /* SCCP Management (SCMG) */
134 void sccp_scmg_rx_ssn_allowed(struct osmo_sccp_instance *inst, uint32_t dpc, uint32_t ssn, uint32_t smi);
135 void sccp_scmg_rx_ssn_prohibited(struct osmo_sccp_instance *inst, uint32_t dpc, uint32_t ssn, uint32_t smi);
136 void sccp_scmg_rx_mtp_pause(struct osmo_sccp_instance *inst, uint32_t dpc);
137 void sccp_scmg_rx_mtp_resume(struct osmo_sccp_instance *inst, uint32_t dpc);
138 void sccp_scmg_rx_mtp_status(struct osmo_sccp_instance *inst, uint32_t dpc, enum mtp_unavail_cause cause);
139 int sccp_scmg_init(struct osmo_sccp_instance *inst);
uint32_t dpc
Definition: m3ua.h:560
void * priv
Definition: sccp_internal.h:75
Definition: sccp_internal.h:24
void sccp_lbcs_local_bcast_pcstate(struct osmo_sccp_instance *inst, const struct osmo_scu_pcstate_param *pcstate)
Definition: sccp_lbcs.c:39
void sccp_scmg_rx_ssn_prohibited(struct osmo_sccp_instance *inst, uint32_t dpc, uint32_t ssn, uint32_t smi)
Definition: sccp_scmg.c:58
Definition: sccp_internal.h:18
char * name
human-readable name of this user
Definition: sccp_internal.h:64
struct msgb * sccp_msgb_alloc(const char *name)
Definition: sua.c:64
Definition: sccp_internal.h:17
uint32_t route_ctx
Definition: sccp_internal.h:45
Definition: sccp_internal.h:21
uint16_t ssn
SSN and/or point code to which we are bound.
Definition: sccp_internal.h:67
Definition: sccp_internal.h:37
struct osmo_fsm sccp_scoc_fsm
Definition: sccp_scoc.c:1450
Definition: sccp_sap.h:273
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:174
uint32_t max_optional_data
Definition: sccp_internal.h:55
osmo_prim_cb prim_cb
Definition: sccp_internal.h:74
int DSCCP
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
Definition: osmo_ss7.h:124
void * priv
Definition: sccp_internal.h:49
struct llist_head users
Definition: sccp_internal.h:43
uint8_t smi
Definition: sccp_scmg.h:41
void sccp_scmg_rx_mtp_status(struct osmo_sccp_instance *inst, uint32_t dpc, enum mtp_unavail_cause cause)
Definition: sccp_scmg.c:125
Definition: sccp_internal.h:19
struct osmo_sccp_instance * inst
pointer back to SCCP instance
Definition: sccp_internal.h:62
struct osmo_ss7_user ss7_user
Definition: sccp_internal.h:51
mtp_unavail_cause
Definition: mtp.h:28
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:1782
const struct value_string osmo_sccp_timer_names[]
Definition: sccp_scoc.c:263
void sccp_scoc_flush_connections(struct osmo_sccp_instance *inst)
Definition: sccp_scoc.c:1948
void osmo_sccp_vty_write_cs7_node(struct vty *vty, const char *indent, struct osmo_sccp_instance *inst)
Definition: sccp_vty.c:253
Definition: sccp_sap.h:266
Definition: sccp_internal.h:58
static const char * osmo_sccp_timer_name(enum osmo_sccp_timer val)
Definition: sccp_internal.h:33
Definition: sccp_internal.h:23
struct osmo_ss7_instance * ss7
Definition: sccp_internal.h:48
struct osmo_tdef * tdefs
Definition: sccp_internal.h:53
Definition: sccp_internal.h:22
int sccp_scrc_rx_sclc_msg(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Definition: sccp_scrc.c:418
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
void sccp_scmg_rx_ssn_allowed(struct osmo_sccp_instance *inst, uint32_t dpc, uint32_t ssn, uint32_t smi)
Definition: sccp_scmg.c:40
void sccp_scmg_rx_mtp_resume(struct osmo_sccp_instance *inst, uint32_t dpc)
brief MTP -> SNM (MTP-RESUME.ind) - ability of providing the MTP service Q.714 5.2.3
Definition: sccp_scmg.c:102
Definition: sccp_internal.h:20
int scrc_rx_mtp_xfer_ind_xua(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Definition: sccp_scrc.c:465
uint32_t next_id
Definition: sccp_internal.h:47
int sccp_scrc_rx_scoc_conn_msg(struct osmo_sccp_instance *inst, struct xua_msg *xua)
Definition: sccp_scrc.c:396
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:1537
Definition: sccp_sap.h:258
void sccp_lbcs_local_bcast_state(struct osmo_sccp_instance *inst, const struct osmo_scu_state_param *state)
Definition: sccp_lbcs.c:55
Definition: xua_msg.h:31
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:52
Definition: sccp_internal.h:27
Definition: osmo_ss7.h:73
int sccp_sclc_rx_from_scrc(struct osmo_sccp_instance *inst, struct xua_msg *xua)
SCRC -> SCLC (connectionless message)
Definition: sccp_sclc.c:256
void sccp_scmg_rx_mtp_pause(struct osmo_sccp_instance *inst, uint32_t dpc)
brief MTP -> SNM (MTP-PAUSE.ind) - inability to providing MTP service Q.714 5.2.2 ...
Definition: sccp_scmg.c:79
uint32_t pc
Definition: sccp_internal.h:68
struct rb_root connections
Definition: sccp_internal.h:41
struct osmo_fsm_inst * as_fi
Definition: sccp_internal.h:78
struct llist_head list
Definition: sccp_internal.h:39
Definition: sccp_internal.h:25
osmo_sccp_timer
Definition: sccp_internal.h:15
const struct osmo_tdef osmo_sccp_timer_defaults[OSMO_SCCP_TIMERS_LEN]
Definition: sccp_scoc.c:239
void sccp_scoc_show_connections(struct vty *vty, struct osmo_sccp_instance *inst)
Definition: sccp_scoc.c:1985
int sccp_scmg_init(struct osmo_sccp_instance *inst)
Definition: sccp_scmg.c:311
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