Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 1 | /*! \file gprs_ns2.h */ |
| 2 | |
| 3 | |
| 4 | #pragma once |
| 5 | |
| 6 | #include <stdint.h> |
| 7 | #include <netinet/in.h> |
| 8 | |
| 9 | #include <osmocom/core/prim.h> |
Alexander Couzens | b3b837c | 2020-10-27 15:12:25 +0100 | [diff] [blame] | 10 | #include <osmocom/gprs/protocol/gsm_08_16.h> |
Alexander Couzens | 841817e | 2020-11-19 00:41:29 +0100 | [diff] [blame] | 11 | #include <osmocom/gprs/frame_relay.h> |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 12 | |
| 13 | struct osmo_sockaddr; |
Alexander Couzens | 1fac6f7 | 2020-10-01 19:08:38 +0200 | [diff] [blame] | 14 | struct osmo_sockaddr_str; |
Alexander Couzens | 841817e | 2020-11-19 00:41:29 +0100 | [diff] [blame] | 15 | struct osmo_fr_network; |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 16 | |
| 17 | struct gprs_ns2_inst; |
| 18 | struct gprs_ns2_nse; |
| 19 | struct gprs_ns2_vc; |
| 20 | struct gprs_ns2_vc_bind; |
| 21 | struct gprs_ns2_vc_driver; |
| 22 | struct gprs_ns_ie_ip4_elem; |
| 23 | struct gprs_ns_ie_ip6_elem; |
| 24 | |
| 25 | enum gprs_ns2_vc_mode { |
Harald Welte | fa2d66c | 2020-10-17 13:09:34 +0200 | [diff] [blame] | 26 | /*! The VC will use RESET/BLOCK/UNBLOCK to start the connection and do ALIVE/ACK. |
| 27 | * This is what is needed for Frame Relay transport, and if you use a R97/R99 Gb |
| 28 | * interface over an IP transport (never standardized by 3GPP) */ |
| 29 | NS2_VC_MODE_BLOCKRESET, |
| 30 | /*! The VC will only use ALIVE/ACK (no RESET/BLOCK/UNBLOCK), which is for Gb-IP |
| 31 | * interface compliant to 3GPP Rel=4 or later. */ |
| 32 | NS2_VC_MODE_ALIVE, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 33 | }; |
| 34 | |
Alexander Couzens | 24a14ac | 2020-11-19 02:34:49 +0100 | [diff] [blame] | 35 | /*! Osmocom NS link layer types */ |
| 36 | enum gprs_ns2_ll { |
| 37 | GPRS_NS2_LL_UDP, /*!< NS/UDP/IP */ |
Alexander Couzens | 24a14ac | 2020-11-19 02:34:49 +0100 | [diff] [blame] | 38 | GPRS_NS2_LL_FR, /*!< NS/FR */ |
| 39 | GPRS_NS2_LL_FR_GRE, /*!< NS/FR/GRE/IP */ |
| 40 | }; |
| 41 | |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 42 | /*! Osmocom NS primitives according to 48.016 5.2 Service primitves */ |
| 43 | enum gprs_ns2_prim { |
| 44 | PRIM_NS_UNIT_DATA, |
| 45 | PRIM_NS_CONGESTION, |
| 46 | PRIM_NS_STATUS, |
| 47 | }; |
| 48 | |
Alexander Couzens | 0ab028c | 2020-11-04 02:41:44 +0100 | [diff] [blame] | 49 | extern const struct value_string gprs_ns2_prim_strs[]; |
Harald Welte | a24e7ee | 2020-11-29 17:38:48 +0100 | [diff] [blame] | 50 | extern const struct value_string gprs_ns2_lltype_strs[]; |
Alexander Couzens | 2498f1d | 2020-10-27 01:09:01 +0100 | [diff] [blame] | 51 | |
| 52 | /*! Obtain a human-readable string for NS primitives */ |
| 53 | static inline const char *gprs_ns2_prim_str(enum gprs_ns2_prim val) |
Alexander Couzens | 0ab028c | 2020-11-04 02:41:44 +0100 | [diff] [blame] | 54 | { return get_value_string(gprs_ns2_prim_strs, val); } |
Alexander Couzens | 2498f1d | 2020-10-27 01:09:01 +0100 | [diff] [blame] | 55 | |
Harald Welte | a24e7ee | 2020-11-29 17:38:48 +0100 | [diff] [blame] | 56 | /*! Obtain a human-readable string for NS link-layer type */ |
| 57 | static inline const char *gprs_ns2_lltype_str(enum gprs_ns2_ll val) |
| 58 | { return get_value_string(gprs_ns2_lltype_strs, val); } |
| 59 | |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 60 | /*! Osmocom NS primitives according to 48.016 5.2.2.4 Service primitves */ |
| 61 | enum gprs_ns2_congestion_cause { |
| 62 | NS_CONG_CAUSE_BACKWARD_BEGIN, |
| 63 | NS_CONG_CAUSE_BACKWARD_END, |
| 64 | NS_CONG_CAUSE_FORWARD_BEGIN, |
| 65 | NS_CONG_CAUSE_FORWARD_END, |
| 66 | }; |
| 67 | |
| 68 | /*! Osmocom NS primitives according to 48.016 5.2.2.6 Service primitves */ |
| 69 | enum gprs_ns2_affecting_cause { |
| 70 | NS_AFF_CAUSE_VC_FAILURE, |
| 71 | NS_AFF_CAUSE_VC_RECOVERY, |
| 72 | NS_AFF_CAUSE_FAILURE, |
| 73 | NS_AFF_CAUSE_RECOVERY, |
| 74 | /* osmocom own causes */ |
| 75 | NS_AFF_CAUSE_SNS_CONFIGURED, |
| 76 | NS_AFF_CAUSE_SNS_FAILURE, |
| 77 | }; |
| 78 | |
Alexander Couzens | 2498f1d | 2020-10-27 01:09:01 +0100 | [diff] [blame] | 79 | extern const struct value_string gprs_ns2_aff_cause_prim_strs[]; |
| 80 | |
| 81 | /*! Obtain a human-readable string for NS affective cause in primitives */ |
| 82 | static inline const char *gprs_ns2_aff_cause_prim_str(enum gprs_ns2_affecting_cause val) |
| 83 | { return get_value_string(gprs_ns2_aff_cause_prim_strs, val); } |
| 84 | |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 85 | /*! Osmocom NS primitives according to 48.016 5.2.2.7 Service primitves */ |
| 86 | enum gprs_ns2_change_ip_endpoint { |
| 87 | NS_ENDPOINT_NO_CHANGE, |
| 88 | NS_ENDPOINT_REQUEST_CHANGE, |
| 89 | NS_ENDPOINT_CONFIRM_CHANGE, |
| 90 | }; |
| 91 | |
Alexander Couzens | b3b837c | 2020-10-27 15:12:25 +0100 | [diff] [blame] | 92 | extern const struct value_string gprs_ns2_cause_strs[]; |
| 93 | |
| 94 | /*! Obtain a human-readable string for NS primitives */ |
| 95 | static inline const char *gprs_ns2_cause_str(enum ns_cause val) |
| 96 | { return get_value_string(gprs_ns2_cause_strs, val); } |
| 97 | |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 98 | struct osmo_gprs_ns2_prim { |
| 99 | struct osmo_prim_hdr oph; |
| 100 | |
| 101 | uint16_t nsei; |
| 102 | uint16_t bvci; |
| 103 | |
| 104 | union { |
| 105 | struct { |
| 106 | enum gprs_ns2_change_ip_endpoint change; |
Alexander Couzens | fc3dd1f | 2020-11-19 00:41:47 +0100 | [diff] [blame] | 107 | uint32_t link_selector; |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 108 | /* TODO: implement resource distribution |
| 109 | * add place holder for the link selector */ |
| 110 | long long _resource_distribution_placeholder1; |
| 111 | long long _resource_distribution_placeholder2; |
| 112 | long long _resource_distribution_placeholder3; |
| 113 | } unitdata; |
| 114 | struct { |
| 115 | enum gprs_ns2_congestion_cause cause; |
| 116 | } congestion; |
| 117 | struct { |
| 118 | enum gprs_ns2_affecting_cause cause; |
Daniel Willmann | 15c09a8 | 2020-11-03 23:05:43 +0100 | [diff] [blame] | 119 | char *nsvc; |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 120 | /* 48.016 5.2.2.6 transfer capability */ |
| 121 | int transfer; |
Alexander Couzens | da0a285 | 2020-10-01 23:24:07 +0200 | [diff] [blame] | 122 | /* osmocom specific */ |
| 123 | /* Persistent NSE/NSVC are configured by vty */ |
| 124 | bool persistent; |
| 125 | /* Only true on the first time it's available. |
| 126 | * Allow the BSSGP layer to reset persistent NSE */ |
| 127 | bool first; |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 128 | } status; |
| 129 | } u; |
| 130 | }; |
| 131 | |
| 132 | /* instance */ |
| 133 | struct gprs_ns2_inst *gprs_ns2_instantiate(void *ctx, osmo_prim_cb cb, void *cb_data); |
| 134 | void gprs_ns2_free(struct gprs_ns2_inst *inst); |
| 135 | int gprs_ns2_dynamic_create_nse(struct gprs_ns2_inst *nsi, bool create_nse); |
| 136 | |
| 137 | /* Entrypoint for primitives from the NS USER */ |
| 138 | int gprs_ns2_recv_prim(struct gprs_ns2_inst *nsi, struct osmo_prim_hdr *oph); |
| 139 | |
Alexander Couzens | 6cb5d5f | 2020-10-11 23:23:31 +0200 | [diff] [blame] | 140 | /*! a callback to iterate over all NSVC */ |
| 141 | typedef int (*gprs_ns2_foreach_nsvc_cb)(struct gprs_ns2_vc *nsvc, void *ctx); |
| 142 | |
| 143 | int gprs_ns2_nse_foreach_nsvc(struct gprs_ns2_nse *nse, |
| 144 | gprs_ns2_foreach_nsvc_cb cb, void *cb_data); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 145 | struct gprs_ns2_nse *gprs_ns2_nse_by_nsei(struct gprs_ns2_inst *nsi, uint16_t nsei); |
Alexander Couzens | aac9016 | 2020-11-19 02:44:04 +0100 | [diff] [blame] | 146 | struct gprs_ns2_nse *gprs_ns2_create_nse(struct gprs_ns2_inst *nsi, uint16_t nsei, |
| 147 | enum gprs_ns2_ll linklayer); |
Alexander Couzens | 05e7f7d | 2020-10-11 19:51:46 +0200 | [diff] [blame] | 148 | uint16_t gprs_ns2_nse_nsei(struct gprs_ns2_nse *nse); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 149 | void gprs_ns2_free_nse(struct gprs_ns2_nse *nse); |
Alexander Couzens | 4b6c8af | 2020-10-11 20:15:25 +0200 | [diff] [blame] | 150 | void gprs_ns2_free_nses(struct gprs_ns2_inst *nsi); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 151 | |
| 152 | /* create vc */ |
| 153 | void gprs_ns2_free_nsvc(struct gprs_ns2_vc *nsvc); |
| 154 | struct gprs_ns2_vc *gprs_ns2_nsvc_by_nsvci(struct gprs_ns2_inst *nsi, uint16_t nsvci); |
| 155 | |
| 156 | /* IP VL driver */ |
| 157 | int gprs_ns2_ip_bind(struct gprs_ns2_inst *nsi, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 158 | const struct osmo_sockaddr *local, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 159 | int dscp, |
| 160 | struct gprs_ns2_vc_bind **result); |
Alexander Couzens | 4f60845 | 2020-10-11 18:41:24 +0200 | [diff] [blame] | 161 | struct gprs_ns2_vc_bind *gprs_ns2_ip_bind_by_sockaddr(struct gprs_ns2_inst *nsi, |
| 162 | const struct osmo_sockaddr *sockaddr); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 163 | void gprs_ns2_bind_set_mode(struct gprs_ns2_vc_bind *bind, enum gprs_ns2_vc_mode mode); |
| 164 | |
Alexander Couzens | 841817e | 2020-11-19 00:41:29 +0100 | [diff] [blame] | 165 | /* FR VL driver */ |
| 166 | struct gprs_ns2_vc_bind *gprs_ns2_fr_bind_by_netif( |
| 167 | struct gprs_ns2_inst *nsi, |
| 168 | const char *netif); |
| 169 | const char *gprs_ns2_fr_bind_netif(struct gprs_ns2_vc_bind *bind); |
| 170 | int gprs_ns2_fr_bind(struct gprs_ns2_inst *nsi, |
| 171 | const char *netif, |
| 172 | struct osmo_fr_network *fr_network, |
| 173 | enum osmo_fr_role fr_role, |
| 174 | struct gprs_ns2_vc_bind **result); |
| 175 | int gprs_ns2_is_fr_bind(struct gprs_ns2_vc_bind *bind); |
| 176 | struct gprs_ns2_vc *gprs_ns2_fr_nsvc_by_dlci(struct gprs_ns2_vc_bind *bind, uint16_t dlci); |
| 177 | struct gprs_ns2_vc *gprs_ns2_fr_connect(struct gprs_ns2_vc_bind *bind, |
| 178 | uint16_t nsei, |
| 179 | uint16_t nsvci, |
| 180 | uint16_t dlci); |
| 181 | |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 182 | /* create a VC connection */ |
| 183 | struct gprs_ns2_vc *gprs_ns2_ip_connect(struct gprs_ns2_vc_bind *bind, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 184 | const struct osmo_sockaddr *remote, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 185 | struct gprs_ns2_nse *nse, |
| 186 | uint16_t nsvci); |
| 187 | |
| 188 | struct gprs_ns2_vc *gprs_ns2_ip_connect2(struct gprs_ns2_vc_bind *bind, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 189 | const struct osmo_sockaddr *remote, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 190 | uint16_t nsei, |
| 191 | uint16_t nsvci); |
| 192 | struct gprs_ns2_vc *gprs_ns2_ip_connect_inactive(struct gprs_ns2_vc_bind *bind, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 193 | const struct osmo_sockaddr *remote, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 194 | struct gprs_ns2_nse *nse, |
| 195 | uint16_t nsvci); |
| 196 | |
| 197 | void gprs_ns2_free_bind(struct gprs_ns2_vc_bind *bind); |
Alexander Couzens | 896fcd5 | 2020-10-11 19:52:36 +0200 | [diff] [blame] | 198 | void gprs_ns2_free_binds(struct gprs_ns2_inst *nsi); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 199 | |
| 200 | /* create a VC SNS connection */ |
| 201 | int gprs_ns2_ip_connect_sns(struct gprs_ns2_vc_bind *bind, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 202 | const struct osmo_sockaddr *remote, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 203 | uint16_t nsei); |
Alexander Couzens | 125298f | 2020-10-11 21:22:42 +0200 | [diff] [blame] | 204 | const struct osmo_sockaddr *gprs_ns2_nse_sns_remote(struct gprs_ns2_nse *nse); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 205 | |
Alexander Couzens | d33512b | 2020-10-11 21:42:11 +0200 | [diff] [blame] | 206 | const struct osmo_sockaddr *gprs_ns2_ip_vc_remote(const struct gprs_ns2_vc *nsvc); |
Alexander Couzens | 979f5f5 | 2020-10-11 21:01:48 +0200 | [diff] [blame] | 207 | const struct osmo_sockaddr *gprs_ns2_ip_vc_local(const struct gprs_ns2_vc *nsvc); |
Alexander Couzens | d420ea9 | 2020-10-12 01:11:05 +0200 | [diff] [blame] | 208 | bool gprs_ns2_ip_vc_equal(const struct gprs_ns2_vc *nsvc, |
| 209 | const struct osmo_sockaddr *local, |
| 210 | const struct osmo_sockaddr *remote, |
| 211 | uint16_t nsvci); |
Alexander Couzens | 9a4cf27 | 2020-10-11 20:48:04 +0200 | [diff] [blame] | 212 | const struct osmo_sockaddr *gprs_ns2_ip_bind_sockaddr(struct gprs_ns2_vc_bind *bind); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 213 | int gprs_ns2_is_ip_bind(struct gprs_ns2_vc_bind *bind); |
| 214 | int gprs_ns2_ip_bind_set_dscp(struct gprs_ns2_vc_bind *bind, int dscp); |
Alexander Couzens | 38b19e8 | 2020-09-23 23:56:37 +0200 | [diff] [blame] | 215 | struct gprs_ns2_vc *gprs_ns2_nsvc_by_sockaddr_bind( |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 216 | struct gprs_ns2_vc_bind *bind, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 217 | const struct osmo_sockaddr *saddr); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 218 | |
| 219 | int gprs_ns2_frgre_bind(struct gprs_ns2_inst *nsi, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 220 | const struct osmo_sockaddr *local, |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 221 | int dscp, |
| 222 | struct gprs_ns2_vc_bind **result); |
| 223 | int gprs_ns2_is_frgre_bind(struct gprs_ns2_vc_bind *bind); |
Alexander Couzens | 841817e | 2020-11-19 00:41:29 +0100 | [diff] [blame] | 224 | uint16_t gprs_ns2_fr_nsvc_dlci(struct gprs_ns2_vc *nsvc); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 225 | |
Alexander Couzens | 38b19e8 | 2020-09-23 23:56:37 +0200 | [diff] [blame] | 226 | struct gprs_ns2_vc *gprs_ns2_nsvc_by_sockaddr_nse( |
| 227 | struct gprs_ns2_nse *nse, |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 228 | const struct osmo_sockaddr *sockaddr); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 229 | void gprs_ns2_start_alive_all_nsvcs(struct gprs_ns2_nse *nse); |
Daniel Willmann | f128654 | 2020-11-03 23:03:33 +0100 | [diff] [blame] | 230 | |
| 231 | /* VC information */ |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 232 | const char *gprs_ns2_ll_str(struct gprs_ns2_vc *nsvc); |
| 233 | char *gprs_ns2_ll_str_buf(char *buf, size_t buf_len, struct gprs_ns2_vc *nsvc); |
| 234 | char *gprs_ns2_ll_str_c(const void *ctx, struct gprs_ns2_vc *nsvc); |
Daniel Willmann | f128654 | 2020-11-03 23:03:33 +0100 | [diff] [blame] | 235 | const char *gprs_ns2_nsvc_state_name(struct gprs_ns2_vc *nsvc); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 236 | |
| 237 | /* vty */ |
Vadim Yanitskiy | a07f25e | 2020-10-09 21:47:01 +0700 | [diff] [blame] | 238 | int gprs_ns2_vty_init(struct gprs_ns2_inst *nsi, |
| 239 | const struct osmo_sockaddr_str *default_bind); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 240 | int gprs_ns2_vty_create(); |
Daniel Willmann | 4fb27a8 | 2020-09-25 15:39:46 +0200 | [diff] [blame] | 241 | void gprs_ns2_vty_force_vc_mode(bool force, enum gprs_ns2_vc_mode mode, const char *reason); |
Alexander Couzens | 6a16149 | 2020-07-12 13:45:50 +0200 | [diff] [blame] | 242 | |
| 243 | |
| 244 | /*! @} */ |