libosmogb  1.1.0
Osmocom Gb library
gprs_ns.h
Go to the documentation of this file.
1 
3 #pragma once
4 
5 #include <stdint.h>
6 
7 /* Our Implementation */
8 #include <netinet/in.h>
10 #include <osmocom/core/msgb.h>
11 #include <osmocom/core/timer.h>
12 #include <osmocom/core/select.h>
13 #include <osmocom/gprs/gprs_msgb.h>
14 
16 
17 #define NS_TIMERS_COUNT 8
18 #define NS_TIMERS "(tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov)"
19 #define NS_TIMERS_HELP \
20  "(un)blocking Timer (Tns-block) timeout\n" \
21  "(un)blocking Timer (Tns-block) number of retries\n" \
22  "Reset Timer (Tns-reset) timeout\n" \
23  "Reset Timer (Tns-reset) number of retries\n" \
24  "Test Timer (Tns-test) timeout\n" \
25  "Alive Timer (Tns-alive) timeout\n" \
26  "Alive Timer (Tns-alive) number of retries\n" \
27  "SNS Provision Timer (Tsns-prov) timeout\n"
28 
29 /* Educated guess - LLC user payload is 1500 bytes plus possible headers */
30 #define NS_ALLOC_SIZE 3072
31 #define NS_ALLOC_HEADROOM 20
32 
33 enum ns_timeout {
42 };
43 
44 #define NSE_S_BLOCKED 0x0001
45 #define NSE_S_ALIVE 0x0002
46 #define NSE_S_RESET 0x0004
47 
48 #define NS_DESC_B(st) ((st) & NSE_S_BLOCKED ? "BLOCKED" : "UNBLOCKED")
49 #define NS_DESC_A(st) ((st) & NSE_S_ALIVE ? "ALIVE" : "DEAD")
50 #define NS_DESC_R(st) ((st) & NSE_S_RESET ? "RESET" : "UNRESET")
51 
53 enum gprs_ns_ll {
57 };
58 
62 };
63 
65 enum gprs_ns_cs {
71 };
72 
73 struct gprs_nsvc;
75 typedef int gprs_ns_cb_t(enum gprs_ns_evt event, struct gprs_nsvc *nsvc,
76  struct msgb *msg, uint16_t bvci);
77 
79 struct gprs_ns_inst {
82 
85 
89 
91 
93  struct {
94  struct osmo_fd fd;
95  uint32_t local_ip;
96  uint16_t local_port;
97  uint32_t remote_ip;
98  uint16_t remote_port;
99  int dscp;
100  } nsip;
102  struct {
103  struct osmo_fd fd;
104  uint32_t local_ip;
105  unsigned int enabled:1;
106  } frgre;
107 
109 };
110 
112  /* standard timers */
117 };
118 
120 struct gprs_nsvc {
122  struct llist_head list;
124  struct gprs_ns_inst *nsi;
125 
126  uint16_t nsei;
127  uint16_t nsvci;
129  uint32_t state;
130  uint32_t remote_state;
131 
132  struct osmo_timer_list timer;
133  enum nsvc_timer_mode timer_mode;
134  struct timeval timer_started;
136 
137  unsigned int remote_end_is_sgsn:1;
138  unsigned int persistent:1;
139  unsigned int nsvci_is_valid:1;
140 
143 
145  enum gprs_ns_ll ll;
146 
149  union {
150  struct {
151  struct sockaddr_in bts_addr;
152  } ip;
153  struct {
154  struct sockaddr_in bts_addr;
155  } frgre;
156  };
158  uint8_t sig_weight;
160  uint8_t data_weight;
161 };
162 
163 /* Create a new NS protocol instance */
164 struct gprs_ns_inst *gprs_ns_instantiate(gprs_ns_cb_t *cb, void *ctx);
165 
166 /* Close a NS protocol instance */
167 void gprs_ns_close(struct gprs_ns_inst *nsi);
168 
169 /* Close and Destroy a NS protocol instance */
170 void gprs_ns_destroy(struct gprs_ns_inst *nsi);
171 
172 /* Listen for incoming GPRS packets via NS/UDP */
173 int gprs_ns_nsip_listen(struct gprs_ns_inst *nsi);
174 
175 /* Establish a connection (from the BSS) to the SGSN */
177  struct sockaddr_in *dest,
178  uint16_t nsei, uint16_t nsvci);
179 
180 /* Establish a connection (from the BSS) to the SGSN using IP SNS */
181 struct gprs_nsvc *gprs_ns_nsip_connect_sns(struct gprs_ns_inst *nsi, struct sockaddr_in *dest,
182  uint16_t nsei, uint16_t nsvci);
183 
184 struct sockaddr_in;
185 
186 /* main function for higher layers (BSSGP) to send NS messages */
187 int gprs_ns_sendmsg(struct gprs_ns_inst *nsi, struct msgb *msg);
188 
189 int gprs_ns_tx_alive(struct gprs_nsvc *nsvc);
190 int gprs_ns_tx_alive_ack(struct gprs_nsvc *nsvc);
191 int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause);
192 int gprs_ns_tx_block(struct gprs_nsvc *nsvc, uint8_t cause);
193 int gprs_ns_tx_unblock(struct gprs_nsvc *nsvc);
194 
195 /* Listen for incoming GPRS packets via NS/FR/GRE */
196 int gprs_ns_frgre_listen(struct gprs_ns_inst *nsi);
197 
198 struct gprs_nsvc *gprs_nsvc_create(struct gprs_ns_inst *nsi, uint16_t nsvci);
199 struct gprs_nsvc *gprs_nsvc_create2(struct gprs_ns_inst *nsi, uint16_t nsvci,
200  uint8_t sig_weight, uint8_t data_weight);
201 void gprs_nsvc_delete(struct gprs_nsvc *nsvc);
202 struct gprs_nsvc *gprs_nsvc_by_nsei(struct gprs_ns_inst *nsi, uint16_t nsei);
203 struct gprs_nsvc *gprs_nsvc_by_nsvci(struct gprs_ns_inst *nsi, uint16_t nsvci);
204 struct gprs_nsvc *gprs_nsvc_by_rem_addr(struct gprs_ns_inst *nsi, const struct sockaddr_in *sin);
205 
206 /* Initiate a RESET procedure (including timer start, ...)*/
207 int gprs_nsvc_reset(struct gprs_nsvc *nsvc, uint8_t cause);
208 
209 /* Add NS-specific VTY stuff */
210 int gprs_ns_vty_init(struct gprs_ns_inst *nsi);
211 
212 /* Resturn peer info as string (NOTE: the buffer is allocated statically) */
213 const char *gprs_ns_ll_str(const struct gprs_nsvc *nsvc);
214 /* Return peer info in user-supplied buffer */
215 char *gprs_ns_ll_str_buf(char *buf, size_t buf_len, const struct gprs_nsvc *nsvc);
216 char *gprs_ns_ll_str_c(const void *ctx, const struct gprs_nsvc *nsvc);
217 
218 /* Copy the link layer info from other into nsvc */
219 void gprs_ns_ll_copy(struct gprs_nsvc *nsvc, struct gprs_nsvc *other);
220 
221 /* Clear the link layer info (will never match a real link then) */
222 void gprs_ns_ll_clear(struct gprs_nsvc *nsvc);
223 
224 struct msgb *gprs_ns_msgb_alloc(void);
225 
226 enum signal_ns {
230  S_NS_ALIVE_EXP, /* Tns-alive expired more than N times */
231  S_NS_REPLACED, /* nsvc object is replaced (sets old_nsvc) */
232  S_NS_MISMATCH, /* got an unexpected IE (sets msg, pdu_type, ie_type) */
233  S_SNS_CONFIGURED, /* IP-SNS configuration completed */
234 };
235 
236 extern const struct value_string gprs_ns_signal_ns_names[];
237 const char *gprs_ns_cause_str(enum ns_cause cause);
238 
240  struct gprs_nsvc *nsvc;
242  uint8_t cause;
243  uint8_t pdu_type;
244  uint8_t ie_type;
245  struct msgb *msg;
246 };
247 
248 void gprs_ns_set_log_ss(int ss);
249 
250 char *gprs_nsvc_state_append(char *s, struct gprs_nsvc *nsvc);
251 
Definition: gprs_ns.h:232
signal_ns
Definition: gprs_ns.h:226
Definition: gprs_ns.h:230
Definition: gprs_ns.h:113
NS/FR/GRE/IP.
Definition: gprs_ns.h:56
struct msgb * gprs_ns_msgb_alloc(void)
Definition: gprs_ns.c:206
uint32_t remote_ip
Definition: gprs_ns.h:97
uint8_t sig_weight
signalling weight.
Definition: gprs_ns.h:158
Structure representing a single NS-VC.
Definition: gprs_ns.h:120
void gprs_ns_destroy(struct gprs_ns_inst *nsi)
Destroy an entire NS instance.
Definition: gprs_ns.c:1935
int gprs_ns_tx_unblock(struct gprs_nsvc *nsvc)
Transmit a NS-UNBLOCK on a given NS-VC.
Definition: gprs_ns.c:693
unsigned int persistent
Definition: gprs_ns.h:138
uint16_t nsei
Definition: gprs_ns.h:126
struct gprs_ns_inst * nsi
pointer to NS Instance
Definition: gprs_ns.h:124
void gprs_ns_close(struct gprs_ns_inst *nsi)
Definition: gprs_ns.c:1911
NS/UDP/IP.
Definition: gprs_ns.h:54
gprs_ns_cs
Osmocom NS VC create status.
Definition: gprs_ns.h:65
char * gprs_ns_ll_str_c(const void *ctx, const struct gprs_nsvc *nsvc)
Definition: gprs_ns.c:1555
int gprs_ns_sendmsg(struct gprs_ns_inst *nsi, struct msgb *msg)
High-level function for transmitting a NS-UNITDATA messsage.
Definition: gprs_ns.c:1082
uint32_t local_ip
Definition: gprs_ns.h:95
int dscp
Definition: gprs_ns.h:99
Definition: gprs_ns.h:239
struct llist_head gprs_nsvcs
linked lists of all NSVC in this instance
Definition: gprs_ns.h:84
int gprs_ns_tx_block(struct gprs_nsvc *nsvc, uint8_t cause)
Transmit a NS-BLOCK on a tiven NS-VC.
Definition: gprs_ns.c:628
uint16_t remote_port
Definition: gprs_ns.h:98
struct gprs_nsvc * gprs_ns_nsip_connect_sns(struct gprs_ns_inst *nsi, struct sockaddr_in *dest, uint16_t nsei, uint16_t nsvci)
Establish a NS connection (from the BSS) to the SGSN using SNS auto-configuration.
Definition: gprs_ns.c:2162
struct gprs_ns_inst * gprs_ns_instantiate(gprs_ns_cb_t *cb, void *ctx)
Create a new GPRS NS instance.
Definition: gprs_ns.c:1881
int gprs_ns_tx_alive_ack(struct gprs_nsvc *nsvc)
Transmit a NS-ALIVE-ACK on a given NS-VC.
Definition: gprs_ns.c:722
unsigned int nsvci_is_valid
Definition: gprs_ns.h:139
NS/E1.
Definition: gprs_ns.h:55
struct gprs_nsvc * unknown_nsvc
a NSVC object that&#39;s needed to deal with packets for unknown NSVC
Definition: gprs_ns.h:88
gprs_ns_cb_t * cb
callback to the user for incoming UNIT DATA IND
Definition: gprs_ns.h:81
struct gprs_nsvc * gprs_nsvc_create(struct gprs_ns_inst *nsi, uint16_t nsvci)
Old API for creating a NS-VC.
Definition: gprs_ns.c:346
Definition: gprs_ns.h:61
Skipped message.
Definition: gprs_ns.h:69
Definition: gprs_ns.h:115
An instance of the NS protocol stack.
Definition: gprs_ns.h:79
void gprs_ns_set_log_ss(int ss)
Definition: gprs_ns.c:2195
struct msgb * msg
Definition: gprs_ns.h:245
Definition: gprs_ns.h:228
void gprs_nsvc_delete(struct gprs_nsvc *nsvc)
Delete given NS-VC.
Definition: gprs_ns.c:354
const char * gprs_ns_ll_str(const struct gprs_nsvc *nsvc)
Definition: gprs_ns.c:1549
gprs_ns_evt
Osmoco NS events.
Definition: gprs_ns.h:60
struct rate_ctr_group * ctrg
Definition: gprs_ns.h:141
Definition: gprs_ns.h:37
A NSVC object has been found.
Definition: gprs_ns.h:67
int gprs_nsvc_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Initiate a RESET procedure.
Definition: gprs_ns.c:2097
const struct value_string gprs_ns_signal_ns_names[]
Definition: gprs_ns.c:182
uint16_t nsei
Identifiers of a BTS, equal to &#39;struct bssgp_bts_ctx&#39;.
Definition: gprs_msgb.h:80
struct gprs_nsvc * gprs_ns_nsip_connect(struct gprs_ns_inst *nsi, struct sockaddr_in *dest, uint16_t nsei, uint16_t nsvci)
Establish a NS connection (from the BSS) to the SGSN.
Definition: gprs_ns.c:2131
struct gprs_nsvc * nsvc
Definition: gprs_ns.h:240
int gprs_ns_nsip_listen(struct gprs_ns_inst *nsi)
Create a listening socket for GPRS NS/UDP/IP.
Definition: gprs_ns.c:2037
Definition: gprs_ns.h:227
struct gprs_nsvc * gprs_nsvc_by_nsei(struct gprs_ns_inst *nsi, uint16_t nsei)
Lookup struct gprs_nsvc based on NSEI.
Definition: gprs_ns.c:254
Definition: gprs_ns.h:114
uint16_t local_port
Definition: gprs_ns.h:96
uint16_t bvci
Definition: gprs_msgb.h:81
void gprs_ns_ll_clear(struct gprs_nsvc *nsvc)
Definition: gprs_ns.c:1579
Definition: gprs_ns.h:38
nsvc_timer_mode
Definition: gprs_ns.h:111
uint8_t data_weight
signaling weight.
Definition: gprs_ns.h:160
uint16_t timeout[NS_TIMERS_COUNT]
Definition: gprs_ns.h:90
#define NS_TIMERS_COUNT
Definition: gprs_ns.h:17
struct osmo_fd fd
Definition: gprs_ns.h:94
unsigned int enabled
Definition: gprs_ns.h:105
Definition: gprs_ns.h:233
int gprs_ns_cb_t(enum gprs_ns_evt event, struct gprs_nsvc *nsvc, struct msgb *msg, uint16_t bvci)
Osmocom GPRS callback function type.
Definition: gprs_ns.h:75
uint16_t nsvci
end-to-end significance
Definition: gprs_ns.h:127
uint32_t remote_state
Definition: gprs_ns.h:130
uint8_t pdu_type
Definition: gprs_ns.h:243
struct gprs_nsvc * gprs_nsvc_create2(struct gprs_ns_inst *nsi, uint16_t nsvci, uint8_t sig_weight, uint8_t data_weight)
Create a new NS-VC (Virtual Circuit) within given instance.
Definition: gprs_ns.c:311
char * gprs_nsvc_state_append(char *s, struct gprs_nsvc *nsvc)
Append the nsvc state to a talloc string.
Definition: gprs_ns.c:2208
A NSVC object has been created.
Definition: gprs_ns.h:66
Definition: gprs_ns.h:35
Definition: gprs_ns.h:41
Rejected and answered message.
Definition: gprs_ns.h:68
unsigned int remote_end_is_sgsn
Definition: gprs_ns.h:137
uint8_t cause
Definition: gprs_ns.h:242
int alive_retries
Definition: gprs_ns.h:135
ns_cause
NS Cause (TS 08.16, Section 10.3.2, Table 13)
Definition: gsm_08_16.h:73
void gprs_ns_ll_copy(struct gprs_nsvc *nsvc, struct gprs_nsvc *other)
Definition: gprs_ns.c:1563
const char * gprs_ns_cause_str(enum ns_cause cause)
Obtain a human-readable string for NS cause value.
Definition: gprs_ns.c:447
char * gprs_ns_ll_str_buf(char *buf, size_t buf_len, const struct gprs_nsvc *nsvc)
Definition: gprs_ns.c:1528
uint32_t state
uniquely identifies NS-VC at SGSN
Definition: gprs_ns.h:129
struct gprs_nsvc * old_nsvc
Definition: gprs_ns.h:241
struct gprs_nsvc * gprs_nsvc_by_rem_addr(struct gprs_ns_inst *nsi, const struct sockaddr_in *sin)
Lookup NS-VC based on specified remote peer socket addr.
Definition: gprs_ns.c:291
int gprs_ns_frgre_listen(struct gprs_ns_inst *nsi)
Definition: gprs_ns_frgre.c:326
Definition: gprs_ns.h:40
uint8_t ie_type
Definition: gprs_ns.h:244
int gprs_ns_tx_alive(struct gprs_nsvc *nsvc)
Transmit a NS-ALIVE on a given NS-VC.
Definition: gprs_ns.c:709
Definition: gprs_ns.h:34
gprs_ns_ll
Osmocom NS link layer types.
Definition: gprs_ns.h:53
event
GPRS Networks Service (NS) messages on the Gb interface.
Definition: gprs_ns.h:36
struct gprs_ns_inst::@2 nsip
NS-over-IP specific bits.
Definition: gprs_ns.h:39
Definition: gprs_ns.h:229
uint8_t data_weight
Definition: gsm_08_16.h:356
ns_timeout
Definition: gprs_ns.h:33
int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Transmit a NS-RESET on a given NSVC.
Definition: gprs_ns.c:539
struct osmo_fsm_inst * bss_sns_fi
Definition: gprs_ns.h:108
struct osmo_stat_item_group * statg
Definition: gprs_ns.h:142
int gprs_ns_vty_init(struct gprs_ns_inst *nsi)
Definition: gprs_ns_vty.c:611
Definition: gprs_ns.h:231
Failed to process message.
Definition: gprs_ns.h:70
struct gprs_nsvc * gprs_nsvc_by_nsvci(struct gprs_ns_inst *nsi, uint16_t nsvci)
Lookup struct gprs_nsvc based on NSVCI.
Definition: gprs_ns.c:239
Definition: gprs_ns.h:116
uint8_t sig_weight
Definition: gsm_08_16.h:355
struct gprs_ns_inst::@3 frgre
NS-over-FR-over-GRE-over-IP specific bits.