libosmo-sigtran  0.10.0
Osmocom SIGTRAN library
sccp_sap.h
Go to the documentation of this file.
1 #pragma once
2 
3 /* SCCP User SAP description */
4 
5 /* (C) 2015-2017 by Harald Welte <laforge@gnumonks.org>
6  * All Rights Reserved
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program. If not, see <http://www.gnu.org/licenses/>.
20  *
21  */
22 
23 #include <stdint.h>
24 #include <osmocom/core/prim.h>
26 
27 #include <netinet/in.h>
28 
29 /* detailed coding of primitives at the SAP_SCCP_USER */
30 
33  /* connection oriented, 6.1.1 */
40  /* connectionless, 6.2.2 */
43  /* management */
47 };
48 
49 #define OSMO_SCCP_ADDR_T_GT 0x0001 /* global title */
50 #define OSMO_SCCP_ADDR_T_PC 0x0002 /* signalling point code */
51 #define OSMO_SCCP_ADDR_T_SSN 0x0004 /* subsystem number */
52 #define OSMO_SCCP_ADDR_T_IPv4 0x0008
53 #define OSMO_SCCP_ADDR_T_IPv6 0x0010
54 
55 /* Q.713 3.4.1 + RFC 3868 3.10.2.3 */
61 };
62 
63 extern const struct value_string osmo_sccp_routing_ind_names[];
64 static inline const char *osmo_sccp_routing_ind_name(enum osmo_sccp_routing_ind val)
65 { return get_value_string(osmo_sccp_routing_ind_names, val); }
66 
67 
68 /* Q.713 3.4.1 + RFC 3868 3.10.2.3 */
75 };
76 
77 extern const struct value_string osmo_sccp_gti_names[];
78 static inline const char *osmo_sccp_gti_name(enum osmo_sccp_gti val)
79 { return get_value_string(osmo_sccp_gti_names, val); }
80 
81 /* RFC 3868 3.10.2.3 */
92 };
93 
94 /* Q.713 3.4.2.3.1 + RFC 3868 3.10.2.3 */
101  /* 5.. 255: Spare */
102 };
103 
104 /* Q.713 3.4.2.2 */
106  /* globally standardised for GSM/UMTS: 1-31 */
116  /* Q.713 */
121  /* national network SSN for wihin and between GSM/UMTS: 129-150 */
130  /* national network SSN within GSM/UMTS: 32-128 + 151-254 */
137 };
138 
139 extern const struct value_string osmo_sccp_ssn_names[];
140 static inline const char *osmo_sccp_ssn_name(enum osmo_sccp_ssn val)
141 { return get_value_string(osmo_sccp_ssn_names, val); }
142 
143 struct osmo_sccp_gt {
144  uint8_t gti;
145  uint8_t tt;
146  uint32_t npi;
147  uint32_t nai;
148  char digits[32];
149 };
150 
152  uint32_t presence;
154  struct osmo_sccp_gt gt;
155  uint32_t pc;
156  uint32_t ssn;
157  union {
158  struct in_addr v4;
159  struct in6_addr v6;
160  } ip;
161  /* we don't do hostnames */
162 };
163 
164 /* OSMO_SCU_PRIM_N_CONNECT */
166  struct osmo_sccp_addr called_addr;
167  struct osmo_sccp_addr calling_addr;
168  struct osmo_sccp_addr responding_addr;
169  //struct osmo_sccp_qos_pars qos_pars;
170  uint32_t sccp_class;
171  uint32_t importance;
172  uint32_t conn_id;
173  /* user data */
174 };
175 
176 /* OSMO_SCU_PRIM_N_DATA / OSMO_SCU_PRIM_N_EXPEDITED_DATA */
178  uint32_t conn_id;
179  uint32_t importance;
180  /* user data */
181 };
182 
187 };
188 
189 /* OSMO_SCU_PRIM_N_DISCONNECT */
191  enum osmo_sccp_originator originator;
192  struct osmo_sccp_addr responding_addr;
193  uint32_t cause;
194  uint32_t conn_id;
195  uint32_t importance;
196  /* user data */
197 };
198 
199 /* OSMO_SCU_PRIM_N_RESET */
201  enum osmo_sccp_originator originator;
202  uint32_t cause;
203  uint32_t conn_id;
204 };
205 
206 /* OSMO_SCU_PRIM_N_UNITDATA */
208  struct osmo_sccp_addr called_addr;
209  struct osmo_sccp_addr calling_addr;
211  uint32_t return_option;
212  uint32_t importance;
213  /* user data */
214 };
215 
216 /* OSMO_SCU_PRIM_N_NOTICE */
218  struct osmo_sccp_addr called_addr;
219  struct osmo_sccp_addr calling_addr;
220  uint32_t cause;
221  uint32_t importance;
222  /* user data */
223 };
224 
226  struct osmo_prim_hdr oph;
227  union {
228  struct osmo_scu_connect_param connect;
230  struct osmo_scu_disconn_param disconnect;
231  struct osmo_scu_reset_param reset;
232  struct osmo_scu_unitdata_param unitdata;
233  struct osmo_scu_notice_param notice;
234  } u;
235 };
236 
237 #define msgb_scu_prim(msg) ((struct osmo_scu_prim *)(msg)->l1h)
238 
239 char *osmo_scu_prim_name(struct osmo_prim_hdr *oph);
240 
241 struct osmo_ss7_instance;
242 struct osmo_sccp_instance;
243 struct osmo_sccp_user;
244 
245 void osmo_sccp_vty_init(void);
246 
247 struct osmo_sccp_instance *
251 struct osmo_sccp_instance *osmo_sccp_get_sccp(const struct osmo_sccp_user *scu);
252 
253 void osmo_sccp_user_unbind(struct osmo_sccp_user *scu);
254 void osmo_sccp_user_set_priv(struct osmo_sccp_user *scu, void *priv);
255 void *osmo_sccp_user_get_priv(struct osmo_sccp_user *scu);
256 
257 struct osmo_sccp_user *
259  osmo_prim_cb prim_cb, uint16_t ssn, uint32_t pc);
260 
261 struct osmo_sccp_user *
262 osmo_sccp_user_bind(struct osmo_sccp_instance *inst, const char *name,
263  osmo_prim_cb prim_cb, uint16_t ssn);
264 
265 int osmo_sccp_user_sap_down(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph);
266 
267 struct osmo_ss7_instance *
268 osmo_sccp_addr_by_name(struct osmo_sccp_addr *dest_addr,
269  const char *name);
270 
271 const char *osmo_sccp_name_by_addr(const struct osmo_sccp_addr *addr);
272 
273 void osmo_sccp_local_addr_by_instance(struct osmo_sccp_addr *dest_addr,
274  const struct osmo_sccp_instance *inst,
275  uint32_t ssn);
276 
277 bool osmo_sccp_check_addr(struct osmo_sccp_addr *addr, uint32_t presence);
278 
279 const char *osmo_sccp_user_name(struct osmo_sccp_user *scu);
Definition: sccp_sap.h:41
Definition: sccp_sap.h:84
Definition: sccp_sap.h:45
Definition: sccp_sap.h:135
Definition: sccp_sap.h:42
Definition: sccp_sap.h:74
Definition: sccp_sap.h:57
Definition: sccp_sap.h:115
uint32_t return_option
Definition: sccp_sap.h:211
void osmo_sccp_user_unbind(struct osmo_sccp_user *scu)
Unbind a given SCCP user.
Definition: sccp_user.c:129
Definition: sccp_sap.h:118
Definition: sccp_sap.h:83
uint32_t conn_id
Definition: sccp_sap.h:178
struct osmo_sccp_instance * osmo_sccp_instance_create(struct osmo_ss7_instance *ss7, void *priv)
create a SCCP Instance and register it as user with SS7 inst
Definition: sccp_user.c:194
int osmo_sccp_user_sap_down(struct osmo_sccp_user *scu, struct osmo_prim_hdr *oph)
Main entrance function for primitives from SCCP User.
Definition: sccp_scoc.c:1605
Definition: sccp_sap.h:165
Definition: sccp_sap.h:44
Definition: sccp_sap.h:112
Definition: sccp_sap.h:99
Definition: sccp_sap.h:207
Definition: sccp_sap.h:46
Definition: sccp_sap.h:128
uint32_t presence
Definition: sccp_sap.h:152
char * name
human-readable name of this user
Definition: sccp_internal.h:32
Definition: sccp_sap.h:124
Definition: sccp_sap.h:113
static const char * osmo_sccp_gti_name(enum osmo_sccp_gti val)
Definition: sccp_sap.h:78
Definition: sccp_sap.h:90
Definition: sccp_sap.h:131
uint32_t conn_id
Definition: sccp_sap.h:172
osmo_scu_prim_type
SCCP-User primitives as per Q.711.
Definition: sccp_sap.h:32
Definition: sccp_sap.h:119
bool osmo_sccp_check_addr(struct osmo_sccp_addr *addr, uint32_t presence)
check whether a given SCCP-Address is consistent.
Definition: sccp_user.c:258
static const char * osmo_sccp_ssn_name(enum osmo_sccp_ssn val)
Definition: sccp_sap.h:140
void osmo_sccp_local_addr_by_instance(struct osmo_sccp_addr *dest_addr, const struct osmo_sccp_instance *inst, uint32_t ssn)
derive a basic local SCCP-Address from a given SCCP instance.
Definition: sccp_user.c:238
uint16_t ssn
SSN and/or point code to which we are bound.
Definition: sccp_internal.h:35
Definition: sccp_internal.h:9
Definition: sccp_sap.h:225
Definition: sccp_sap.h:107
uint32_t pc
Definition: sccp_sap.h:155
Definition: sccp_sap.h:59
uint32_t cause
Definition: sccp_sap.h:220
Definition: sccp_sap.h:96
osmo_prim_cb prim_cb
Definition: sccp_internal.h:42
struct osmo_sccp_user * osmo_sccp_user_bind_pc(struct osmo_sccp_instance *inst, const char *name, osmo_prim_cb prim_cb, uint16_t ssn, uint32_t pc)
Bind a given SCCP User to a given SSN+PC.
Definition: sccp_user.c:108
uint32_t importance
Definition: sccp_sap.h:221
void * priv
Definition: sccp_internal.h:21
osmo_sccp_gti
Definition: sccp_sap.h:69
Definition: sccp_sap.h:100
Definition: sccp_sap.h:122
Definition: sccp_sap.h:86
Definition: sccp_sap.h:36
uint32_t importance
Definition: sccp_sap.h:179
Definition: sccp_sap.h:184
uint8_t gti
Definition: sccp_sap.h:144
Definition: sccp_sap.h:186
Definition: sccp_sap.h:98
struct osmo_sccp_instance * inst
pointer back to SCCP instance
Definition: sccp_internal.h:30
Definition: sccp_sap.h:123
osmo_sccp_originator
Definition: sccp_sap.h:183
uint32_t conn_id
Definition: sccp_sap.h:203
void osmo_sccp_user_set_priv(struct osmo_sccp_user *scu, void *priv)
Definition: sccp_user.c:139
const char * osmo_sccp_name_by_addr(const struct osmo_sccp_addr *addr)
Reverse lookup the lookup-name of a specified SCCP address.
Definition: osmo_ss7_vty.c:1099
void osmo_sccp_vty_init(void)
Definition: sccp_vty.c:146
struct osmo_ss7_instance * osmo_sccp_get_ss7(const struct osmo_sccp_instance *sccp)
get the SS7 instance that is related to the given SCCP instance
Definition: sccp_user.c:645
uint32_t nai
Definition: sccp_sap.h:147
osmo_sccp_ssn
Definition: sccp_sap.h:105
uint32_t npi
Definition: sccp_sap.h:146
Definition: sccp_sap.h:87
Definition: sccp_sap.h:109
Definition: sccp_sap.h:110
uint32_t conn_id
Definition: sccp_sap.h:194
Definition: sccp_sap.h:114
Definition: sccp_sap.h:34
Definition: sccp_sap.h:126
const struct value_string osmo_sccp_ssn_names[]
Definition: sccp_sap.c:108
Definition: sccp_internal.h:26
Definition: sccp_sap.h:125
struct osmo_sccp_instance * osmo_sccp_get_sccp(const struct osmo_sccp_user *scu)
get the SCCP instance that is related to the given sccp user
Definition: sccp_user.c:655
struct osmo_ss7_instance * ss7
Definition: sccp_internal.h:20
Definition: sccp_sap.h:88
Definition: sccp_sap.h:127
Definition: sccp_sap.h:133
Definition: sccp_sap.h:117
char digits[32]
Definition: sccp_sap.h:148
Definition: sccp_sap.h:97
Definition: sccp_sap.h:111
osmo_sccp_routing_ind
Definition: sccp_sap.h:56
const struct value_string osmo_sccp_gti_names[]
Definition: sccp_sap.c:99
char * name
Definition: osmo_ss7.h:93
void osmo_sccp_instance_destroy(struct osmo_sccp_instance *inst)
Definition: sccp_user.c:219
Definition: sccp_sap.h:71
const char * osmo_sccp_user_name(struct osmo_sccp_user *scu)
Compose a human readable string to describe the SCCP user&#39;s connection.
Definition: sccp_user.c:301
uint32_t importance
Definition: sccp_sap.h:195
Definition: sccp_sap.h:120
struct osmo_sccp_user * osmo_sccp_user_bind(struct osmo_sccp_instance *inst, const char *name, osmo_prim_cb prim_cb, uint16_t ssn)
Bind a given SCCP User to a given SSN (at any PC)
Definition: sccp_user.c:120
Definition: sccp_sap.h:185
Definition: sccp_sap.h:151
osmo_sccp_nai
Definition: sccp_sap.h:95
Definition: sccp_sap.h:143
Definition: sccp_sap.h:73
Definition: sccp_sap.h:39
struct osmo_ss7_instance * osmo_sccp_addr_by_name(struct osmo_sccp_addr *dest_addr, const char *name)
Lookup an SCCP address from the addressbook by its name.
Definition: osmo_ss7_vty.c:1081
uint32_t cause
Definition: sccp_sap.h:193
Definition: sccp_sap.h:217
struct osmo_sccp_instance * sccp
Definition: osmo_ss7.h:89
const struct value_string osmo_sccp_routing_ind_names[]
Definition: sccp_sap.c:91
Definition: sccp_sap.h:85
Definition: sccp_sap.h:60
char * osmo_scu_prim_name(struct osmo_prim_hdr *oph)
Definition: sccp_sap.c:46
uint8_t data[0]
Definition: xua_types.h:72
static const char * osmo_sccp_routing_ind_name(enum osmo_sccp_routing_ind val)
Definition: sccp_sap.h:64
Definition: osmo_ss7.h:70
Definition: sccp_sap.h:58
uint32_t importance
Definition: sccp_sap.h:212
uint32_t cause
Definition: sccp_sap.h:202
Definition: sccp_sap.h:136
osmo_sccp_npi
Definition: sccp_sap.h:82
Definition: sccp_sap.h:129
Definition: sccp_sap.h:190
uint32_t pc
Definition: sccp_internal.h:36
Definition: sccp_sap.h:35
Definition: sccp_sap.h:37
void * osmo_sccp_user_get_priv(struct osmo_sccp_user *scu)
Definition: sccp_user.c:144
Definition: sccp_sap.h:134
uint32_t sccp_class
Definition: sccp_sap.h:170
Definition: sccp_sap.h:89
Definition: sccp_sap.h:177
Definition: sccp_sap.h:70
Definition: sccp_sap.h:200
uint32_t importance
Definition: sccp_sap.h:171
Definition: sccp_sap.h:108
uint32_t ssn
Definition: sccp_sap.h:156
uint32_t in_sequence_control
Definition: sccp_sap.h:210
Definition: sccp_sap.h:132
Definition: sccp_sap.h:91
Definition: sccp_sap.h:38
Definition: sccp_sap.h:72
uint8_t tt
Definition: sccp_sap.h:145