Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 1 | /*! \file gprs_ns2_internal.h */ |
| 2 | |
| 3 | #pragma once |
| 4 | |
| 5 | #include <stdbool.h> |
| 6 | #include <stdint.h> |
| 7 | |
| 8 | #include <osmocom/gprs/protocol/gsm_08_16.h> |
| 9 | #include <osmocom/gprs/gprs_ns2.h> |
| 10 | |
| 11 | struct osmo_fsm_inst; |
| 12 | struct tlv_parsed; |
| 13 | struct vty; |
| 14 | |
| 15 | struct gprs_ns2_vc_driver; |
| 16 | struct gprs_ns2_vc_bind; |
| 17 | |
| 18 | |
| 19 | |
| 20 | #define NS_TIMERS_COUNT 8 |
| 21 | #define NS_TIMERS "(tns-block|tns-block-retries|tns-reset|tns-reset-retries|tns-test|tns-alive|tns-alive-retries|tsns-prov)" |
| 22 | #define NS_TIMERS_HELP \ |
| 23 | "(un)blocking Timer (Tns-block) timeout\n" \ |
| 24 | "(un)blocking Timer (Tns-block) number of retries\n" \ |
| 25 | "Reset Timer (Tns-reset) timeout\n" \ |
| 26 | "Reset Timer (Tns-reset) number of retries\n" \ |
| 27 | "Test Timer (Tns-test) timeout\n" \ |
| 28 | "Alive Timer (Tns-alive) timeout\n" \ |
| 29 | "Alive Timer (Tns-alive) number of retries\n" \ |
| 30 | "SNS Provision Timer (Tsns-prov) timeout\n" |
| 31 | |
| 32 | /* Educated guess - LLC user payload is 1500 bytes plus possible headers */ |
| 33 | #define NS_ALLOC_SIZE 3072 |
| 34 | #define NS_ALLOC_HEADROOM 20 |
| 35 | |
| 36 | enum ns2_timeout { |
| 37 | NS_TOUT_TNS_BLOCK, |
| 38 | NS_TOUT_TNS_BLOCK_RETRIES, |
| 39 | NS_TOUT_TNS_RESET, |
| 40 | NS_TOUT_TNS_RESET_RETRIES, |
| 41 | NS_TOUT_TNS_TEST, |
| 42 | NS_TOUT_TNS_ALIVE, |
| 43 | NS_TOUT_TNS_ALIVE_RETRIES, |
| 44 | NS_TOUT_TSNS_PROV, |
| 45 | }; |
| 46 | |
| 47 | enum nsvc_timer_mode { |
| 48 | /* standard timers */ |
| 49 | NSVC_TIMER_TNS_TEST, |
| 50 | NSVC_TIMER_TNS_ALIVE, |
| 51 | NSVC_TIMER_TNS_RESET, |
| 52 | _NSVC_TIMER_NR, |
| 53 | }; |
| 54 | |
| 55 | enum ns_stat { |
| 56 | NS_STAT_ALIVE_DELAY, |
| 57 | }; |
| 58 | |
| 59 | /*! Osmocom NS link layer types */ |
| 60 | enum gprs_ns_ll { |
| 61 | GPRS_NS_LL_UDP, /*!< NS/UDP/IP */ |
| 62 | GPRS_NS_LL_E1, /*!< NS/E1 */ |
| 63 | GPRS_NS_LL_FR_GRE, /*!< NS/FR/GRE/IP */ |
| 64 | }; |
| 65 | |
| 66 | /*! Osmocom NS2 VC create status */ |
| 67 | enum gprs_ns2_cs { |
| 68 | GPRS_NS2_CS_CREATED, /*!< A NSVC object has been created */ |
| 69 | GPRS_NS2_CS_FOUND, /*!< A NSVC object has been found */ |
| 70 | GPRS_NS2_CS_REJECTED, /*!< Rejected and answered message */ |
| 71 | GPRS_NS2_CS_SKIPPED, /*!< Skipped message */ |
| 72 | GPRS_NS2_CS_ERROR, /*!< Failed to process message */ |
| 73 | }; |
| 74 | |
| 75 | |
| 76 | #define NSE_S_BLOCKED 0x0001 |
| 77 | #define NSE_S_ALIVE 0x0002 |
| 78 | #define NSE_S_RESET 0x0004 |
| 79 | |
| 80 | #define NS_DESC_B(st) ((st) & NSE_S_BLOCKED ? "BLOCKED" : "UNBLOCKED") |
| 81 | #define NS_DESC_A(st) ((st) & NSE_S_ALIVE ? "ALIVE" : "DEAD") |
| 82 | #define NS_DESC_R(st) ((st) & NSE_S_RESET ? "RESET" : "UNRESET") |
| 83 | |
| 84 | /*! An instance of the NS protocol stack */ |
| 85 | struct gprs_ns2_inst { |
| 86 | /*! callback to the user for incoming UNIT DATA IND */ |
| 87 | osmo_prim_cb cb; |
| 88 | |
| 89 | /*! callback data */ |
| 90 | void *cb_data; |
| 91 | |
| 92 | /*! linked lists of all NSVC binds (e.g. IPv4 bind, but could be also E1 */ |
| 93 | struct llist_head binding; |
| 94 | |
| 95 | /*! linked lists of all NSVC in this instance */ |
| 96 | struct llist_head nse; |
| 97 | |
| 98 | /*! create dynamic NSE on receiving packages */ |
| 99 | bool create_nse; |
| 100 | |
| 101 | uint16_t timeout[NS_TIMERS_COUNT]; |
| 102 | |
| 103 | /*! workaround for rate counter until rate counter accepts char str as index */ |
| 104 | uint32_t rate_ctr_idx; |
| 105 | }; |
| 106 | |
| 107 | /*! Structure repesenting a NSE. The BSS/PCU will only have a single NSE, while SGSN has one for each BSS/PCU */ |
| 108 | struct gprs_ns2_nse { |
| 109 | uint16_t nsei; |
| 110 | |
| 111 | /*! entry back to ns2_inst */ |
| 112 | struct gprs_ns2_inst *nsi; |
| 113 | |
| 114 | /*! llist entry for gprs_ns2_inst */ |
| 115 | struct llist_head list; |
| 116 | |
| 117 | /*! llist head to hold all nsvc */ |
| 118 | struct llist_head nsvc; |
| 119 | |
| 120 | /*! true if this NSE was created by VTY or pcu socket) */ |
| 121 | bool persistent; |
| 122 | |
Alexander Couzens | da0a285 | 2020-10-01 23:24:07 +0200 | [diff] [blame] | 123 | /*! true if this NSE wasn't yet alive at all. |
| 124 | * Will be true after the first status ind with NS_AFF_CAUSE_RECOVERY */ |
| 125 | bool first; |
| 126 | |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 127 | /*! true if this NSE has at least one alive VC */ |
| 128 | bool alive; |
| 129 | |
| 130 | struct osmo_fsm_inst *bss_sns_fi; |
| 131 | }; |
| 132 | |
| 133 | /*! Structure representing a single NS-VC */ |
| 134 | struct gprs_ns2_vc { |
| 135 | /*! list of NS-VCs within NSE */ |
| 136 | struct llist_head list; |
| 137 | |
| 138 | /*! list of NS-VCs within bind, bind is the owner! */ |
| 139 | struct llist_head blist; |
| 140 | |
| 141 | /*! pointer to NS Instance */ |
| 142 | struct gprs_ns2_nse *nse; |
| 143 | |
| 144 | /*! pointer to NS VL bind. bind own the memory of this instance */ |
| 145 | struct gprs_ns2_vc_bind *bind; |
| 146 | |
| 147 | /*! true if this NS was created by VTY or pcu socket) */ |
| 148 | bool persistent; |
| 149 | |
| 150 | /*! uniquely identifies NS-VC if VC contains nsvci */ |
| 151 | uint16_t nsvci; |
| 152 | |
| 153 | /*! signalling weight. 0 = don't use for signalling (BVCI == 0)*/ |
| 154 | uint8_t sig_weight; |
| 155 | |
| 156 | /*! signaling weight. 0 = don't use for user data (BVCI != 0) */ |
| 157 | uint8_t data_weight; |
| 158 | |
| 159 | /*! can be used by the bind/driver of the virtual circuit. e.g. ipv4/ipv6/frgre/e1 */ |
| 160 | void *priv; |
| 161 | |
| 162 | bool nsvci_is_valid; |
| 163 | bool sns_only; |
| 164 | |
| 165 | struct rate_ctr_group *ctrg; |
| 166 | struct osmo_stat_item_group *statg; |
| 167 | |
| 168 | /*! which link-layer are we based on? */ |
| 169 | enum gprs_ns_ll ll; |
| 170 | enum gprs_ns2_vc_mode mode; |
| 171 | |
| 172 | struct osmo_fsm_inst *fi; |
| 173 | }; |
| 174 | |
| 175 | /*! Structure repesenting a bind instance. E.g. IPv4 listen port. */ |
| 176 | struct gprs_ns2_vc_bind { |
| 177 | /*! list entry in nsi */ |
| 178 | struct llist_head list; |
| 179 | /*! list of all VC */ |
| 180 | struct llist_head nsvc; |
| 181 | /*! driver private structure */ |
| 182 | void *priv; |
| 183 | /*! a pointer back to the nsi */ |
| 184 | struct gprs_ns2_inst *nsi; |
| 185 | struct gprs_ns2_vc_driver *driver; |
| 186 | |
| 187 | /*! if VCs use reset/block/unblock method. IP shall not use this */ |
| 188 | enum gprs_ns2_vc_mode vc_mode; |
| 189 | |
| 190 | /*! send a msg over a VC */ |
| 191 | int (*send_vc)(struct gprs_ns2_vc *nsvc, struct msgb *msg); |
| 192 | |
| 193 | /*! free the vc priv data */ |
| 194 | void (*free_vc)(struct gprs_ns2_vc *nsvc); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 195 | |
Alexander Couzens | 22f3471 | 2020-10-02 02:34:39 +0200 | [diff] [blame] | 196 | /*! allow to show information for the vty */ |
| 197 | void (*dump_vty)(const struct gprs_ns2_vc_bind *bind, |
| 198 | struct vty *vty, bool stats); |
| 199 | }; |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 200 | |
| 201 | struct gprs_ns2_vc_driver { |
| 202 | const char *name; |
| 203 | void *priv; |
| 204 | void (*free_bind)(struct gprs_ns2_vc_bind *driver); |
| 205 | }; |
| 206 | |
| 207 | enum gprs_ns2_cs ns2_create_vc(struct gprs_ns2_vc_bind *bind, |
| 208 | struct msgb *msg, |
| 209 | const char *logname, |
| 210 | struct msgb **reject, |
| 211 | struct gprs_ns2_vc **success); |
| 212 | |
Alexander Couzens | ffd49d0 | 2020-09-24 00:47:17 +0200 | [diff] [blame] | 213 | int ns2_recv_vc(struct gprs_ns2_vc *nsvc, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 214 | struct msgb *msg); |
| 215 | |
| 216 | struct gprs_ns2_vc *ns2_vc_alloc(struct gprs_ns2_vc_bind *bind, |
| 217 | struct gprs_ns2_nse *nse, |
| 218 | bool initiater); |
| 219 | |
| 220 | struct msgb *gprs_ns2_msgb_alloc(void); |
| 221 | |
| 222 | void gprs_ns2_sns_dump_vty(struct vty *vty, const struct gprs_ns2_nse *nse, bool stats); |
Alexander Couzens | bf95f0f | 2020-10-01 22:56:03 +0200 | [diff] [blame] | 223 | void ns2_prim_status_ind(struct gprs_ns2_nse *nse, |
| 224 | uint16_t bvci, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 225 | enum gprs_ns2_affecting_cause cause); |
| 226 | void ns2_nse_notify_alive(struct gprs_ns2_vc *nsvc, bool alive); |
| 227 | |
| 228 | /* message */ |
| 229 | int gprs_ns2_validate(struct gprs_ns2_vc *nsvc, |
| 230 | uint8_t pdu_type, |
| 231 | struct msgb *msg, |
| 232 | struct tlv_parsed *tp, |
| 233 | uint8_t *cause); |
| 234 | |
| 235 | /* SNS messages */ |
| 236 | int ns2_tx_sns_ack(struct gprs_ns2_vc *nsvc, uint8_t trans_id, uint8_t *cause, |
| 237 | const struct gprs_ns_ie_ip4_elem *ip4_elems, |
| 238 | unsigned int num_ip4_elems, |
| 239 | const struct gprs_ns_ie_ip6_elem *ip6_elems, |
| 240 | unsigned int num_ip6_elems); |
| 241 | int ns2_tx_sns_config(struct gprs_ns2_vc *nsvc, bool end_flag, |
| 242 | const struct gprs_ns_ie_ip4_elem *ip4_elems, |
| 243 | unsigned int num_ip4_elems, |
| 244 | const struct gprs_ns_ie_ip6_elem *ip6_elems, |
| 245 | unsigned int num_ip6_elems); |
| 246 | int ns2_tx_sns_config_ack(struct gprs_ns2_vc *nsvc, uint8_t *cause); |
| 247 | int ns2_tx_sns_size(struct gprs_ns2_vc *nsvc, bool reset_flag, uint16_t max_nr_nsvc, |
| 248 | int ip4_ep_nr, int ip6_ep_nr); |
| 249 | int ns2_tx_sns_size_ack(struct gprs_ns2_vc *nsvc, uint8_t *cause); |
| 250 | |
| 251 | /* transmit message over a VC */ |
| 252 | int ns2_tx_block(struct gprs_ns2_vc *nsvc, uint8_t cause); |
| 253 | int ns2_tx_block_ack(struct gprs_ns2_vc *nsvc); |
| 254 | |
| 255 | int ns2_tx_reset(struct gprs_ns2_vc *nsvc, uint8_t cause); |
| 256 | int ns2_tx_reset_ack(struct gprs_ns2_vc *nsvc); |
| 257 | |
| 258 | int ns2_tx_unblock(struct gprs_ns2_vc *nsvc); |
| 259 | int ns2_tx_unblock_ack(struct gprs_ns2_vc *nsvc); |
| 260 | |
| 261 | int ns2_tx_alive(struct gprs_ns2_vc *nsvc); |
| 262 | int ns2_tx_alive_ack(struct gprs_ns2_vc *nsvc); |
| 263 | |
| 264 | int ns2_tx_unit_data(struct gprs_ns2_vc *nsvc, |
| 265 | uint16_t bvci, uint8_t sducontrol, |
| 266 | struct msgb *msg); |
| 267 | |
| 268 | int ns2_tx_status(struct gprs_ns2_vc *nsvc, uint8_t cause, |
| 269 | uint16_t bvci, struct msgb *orig_msg); |
| 270 | |
| 271 | /* driver */ |
| 272 | struct gprs_ns2_vc *gprs_ns2_ip_bind_connect(struct gprs_ns2_vc_bind *bind, |
| 273 | struct gprs_ns2_nse *nse, |
| 274 | struct osmo_sockaddr *remote); |
| 275 | |
| 276 | /* sns */ |
| 277 | int gprs_ns2_sns_rx(struct gprs_ns2_vc *nsvc, struct msgb *msg, struct tlv_parsed *tp); |
| 278 | struct osmo_fsm_inst *ns2_sns_bss_fsm_alloc(struct gprs_ns2_nse *nse, |
| 279 | const char *id); |
| 280 | int ns2_sns_bss_fsm_start(struct gprs_ns2_nse *nse, struct gprs_ns2_vc *nsvc, |
| 281 | struct osmo_sockaddr *remote); |
| 282 | void ns2_sns_free_nsvc(struct gprs_ns2_vc *nsvc); |
| 283 | |
| 284 | /* vc */ |
| 285 | struct osmo_fsm_inst *gprs_ns2_vc_fsm_alloc(struct gprs_ns2_vc *nsvc, |
| 286 | const char *id, bool initiate); |
| 287 | int gprs_ns2_vc_fsm_start(struct gprs_ns2_vc *nsvc); |
| 288 | int gprs_ns2_vc_rx(struct gprs_ns2_vc *nsvc, struct msgb *msg, struct tlv_parsed *tp); |
| 289 | int gprs_ns2_vc_is_alive(struct gprs_ns2_vc *nsvc); |
| 290 | int gprs_ns2_vc_is_unblocked(struct gprs_ns2_vc *nsvc); |
| 291 | |
| 292 | /* vty.c */ |
| 293 | void ns2_vty_bind_apply(struct gprs_ns2_vc_bind *bind); |
| 294 | |
| 295 | /* nse */ |
| 296 | void ns2_nse_notify_unblocked(struct gprs_ns2_vc *nsvc, bool unblocked); |