Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1 | /* Osmocom Visitor Location Register (VLR): Location Update FSMs */ |
| 2 | |
| 3 | /* (C) 2016 by Harald Welte <laforge@gnumonks.org> |
| 4 | * |
| 5 | * All Rights Reserved |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
| 8 | * it under the terms of the GNU Affero General Public License as published by |
| 9 | * the Free Software Foundation; either version 3 of the License, or |
| 10 | * (at your option) any later version. |
| 11 | * |
| 12 | * This program is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | * GNU Affero General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Affero General Public License |
| 18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | #include <osmocom/core/fsm.h> |
Max | 43b01b0 | 2017-09-15 11:22:30 +0200 | [diff] [blame] | 23 | #include <osmocom/gsm/gsm48.h> |
Neels Hofmeyr | 9084396 | 2017-09-04 15:04:35 +0200 | [diff] [blame] | 24 | #include <osmocom/msc/vlr.h> |
| 25 | #include <osmocom/msc/debug.h> |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 26 | |
| 27 | #include "vlr_core.h" |
| 28 | #include "vlr_auth_fsm.h" |
| 29 | #include "vlr_lu_fsm.h" |
Harald Welte | 0df904d | 2018-12-03 11:00:04 +0100 | [diff] [blame] | 30 | #include "vlr_sgs_fsm.h" |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 31 | |
| 32 | #define S(x) (1 << (x)) |
| 33 | |
| 34 | #define LU_TIMEOUT_LONG 30 |
| 35 | |
| 36 | enum vlr_fsm_result { |
| 37 | VLR_FSM_RESULT_NONE, |
| 38 | VLR_FSM_RESULT_SUCCESS, |
| 39 | VLR_FSM_RESULT_FAILURE, |
| 40 | }; |
| 41 | |
| 42 | |
| 43 | /*********************************************************************** |
| 44 | * Update_HLR_VLR, TS 23.012 Chapter 4.1.2.4 |
| 45 | ***********************************************************************/ |
| 46 | |
| 47 | enum upd_hlr_vlr_state { |
| 48 | UPD_HLR_VLR_S_INIT, |
| 49 | UPD_HLR_VLR_S_WAIT_FOR_DATA, |
| 50 | UPD_HLR_VLR_S_DONE, |
| 51 | }; |
| 52 | |
| 53 | enum upd_hlr_vlr_evt { |
| 54 | UPD_HLR_VLR_E_START, |
| 55 | UPD_HLR_VLR_E_INS_SUB_DATA, |
| 56 | UPD_HLR_VLR_E_ACT_TRACE_MODE, |
| 57 | UPD_HLR_VLR_E_FW_CHECK_SS_IND, |
| 58 | UPD_HLR_VLR_E_UPD_LOC_ACK, |
| 59 | UPD_HLR_VLR_E_UPD_LOC_NACK, |
| 60 | }; |
| 61 | |
| 62 | static const struct value_string upd_hlr_vlr_event_names[] = { |
| 63 | OSMO_VALUE_STRING(UPD_HLR_VLR_E_START), |
| 64 | OSMO_VALUE_STRING(UPD_HLR_VLR_E_INS_SUB_DATA), |
| 65 | OSMO_VALUE_STRING(UPD_HLR_VLR_E_ACT_TRACE_MODE), |
| 66 | OSMO_VALUE_STRING(UPD_HLR_VLR_E_FW_CHECK_SS_IND), |
| 67 | OSMO_VALUE_STRING(UPD_HLR_VLR_E_UPD_LOC_ACK), |
| 68 | OSMO_VALUE_STRING(UPD_HLR_VLR_E_UPD_LOC_NACK), |
| 69 | { 0, NULL } |
| 70 | }; |
| 71 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 72 | static inline struct vlr_subscr *upd_hlr_vlr_fi_priv(struct osmo_fsm_inst *fi); |
| 73 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 74 | static void upd_hlr_vlr_fsm_init(struct osmo_fsm_inst *fi, uint32_t event, |
| 75 | void *data) |
| 76 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 77 | struct vlr_subscr *vsub = upd_hlr_vlr_fi_priv(fi); |
Max | 770fbd2 | 2018-01-24 12:48:33 +0100 | [diff] [blame] | 78 | int rc; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 79 | |
| 80 | OSMO_ASSERT(event == UPD_HLR_VLR_E_START); |
| 81 | |
| 82 | /* Send UpdateLocation to HLR */ |
Philipp Maier | 6038ad4 | 2018-11-13 13:55:09 +0100 | [diff] [blame] | 83 | rc = vlr_subscr_req_lu(vsub); |
Max | 770fbd2 | 2018-01-24 12:48:33 +0100 | [diff] [blame] | 84 | if (rc < 0) |
| 85 | LOGPFSML(fi, LOGL_ERROR, "Failed to send UpdateLocation to HLR\n"); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 86 | osmo_fsm_inst_state_chg(fi, UPD_HLR_VLR_S_WAIT_FOR_DATA, |
| 87 | LU_TIMEOUT_LONG, 0); |
| 88 | } |
| 89 | |
| 90 | static void upd_hlr_vlr_fsm_wait_data(struct osmo_fsm_inst *fi, uint32_t event, |
| 91 | void *data) |
| 92 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 93 | struct vlr_subscr *vsub = upd_hlr_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 94 | |
| 95 | switch (event) { |
| 96 | case UPD_HLR_VLR_E_INS_SUB_DATA: |
| 97 | /* FIXME: Insert_Subscr_Data_VLR */ |
| 98 | break; |
| 99 | case UPD_HLR_VLR_E_ACT_TRACE_MODE: |
| 100 | /* TODO: Activate_Tracing_VLR */ |
| 101 | break; |
| 102 | case UPD_HLR_VLR_E_FW_CHECK_SS_IND: |
| 103 | /* TODO: Forward Check SS Ind to MSC */ |
| 104 | break; |
| 105 | case UPD_HLR_VLR_E_UPD_LOC_ACK: |
| 106 | /* Inside Update_HLR_VLR after UpdateLocationAck */ |
| 107 | vsub->sub_dataconf_by_hlr_ind = true; |
| 108 | vsub->loc_conf_in_hlr_ind = true; |
| 109 | osmo_fsm_inst_state_chg(fi, UPD_HLR_VLR_S_DONE, 0, 0); |
| 110 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); |
| 111 | break; |
| 112 | case UPD_HLR_VLR_E_UPD_LOC_NACK: |
| 113 | /* Inside Update_HLR_VLR after UpdateLocationNack */ |
| 114 | /* TODO: Check_User_Error_In_Serving_Network_Entity */ |
| 115 | vsub->sub_dataconf_by_hlr_ind = false; |
| 116 | vsub->loc_conf_in_hlr_ind = false; |
| 117 | osmo_fsm_inst_state_chg(fi, UPD_HLR_VLR_S_DONE, 0, 0); |
| 118 | /* Data is a pointer to a gsm48_gmm_cause which we |
| 119 | * simply pass through */ |
| 120 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, data); |
| 121 | break; |
| 122 | } |
| 123 | } |
| 124 | |
| 125 | static const struct osmo_fsm_state upd_hlr_vlr_states[] = { |
| 126 | [UPD_HLR_VLR_S_INIT] = { |
| 127 | .in_event_mask = S(UPD_HLR_VLR_E_START), |
| 128 | .out_state_mask = S(UPD_HLR_VLR_S_WAIT_FOR_DATA), |
| 129 | .name = OSMO_STRINGIFY(UPD_HLR_VLR_S_INIT), |
| 130 | .action = upd_hlr_vlr_fsm_init, |
| 131 | }, |
| 132 | [UPD_HLR_VLR_S_WAIT_FOR_DATA] = { |
| 133 | .in_event_mask = S(UPD_HLR_VLR_E_INS_SUB_DATA) | |
| 134 | S(UPD_HLR_VLR_E_ACT_TRACE_MODE) | |
| 135 | S(UPD_HLR_VLR_E_FW_CHECK_SS_IND) | |
| 136 | S(UPD_HLR_VLR_E_UPD_LOC_ACK) | |
| 137 | S(UPD_HLR_VLR_E_UPD_LOC_NACK), |
| 138 | .out_state_mask = S(UPD_HLR_VLR_S_DONE), |
| 139 | .name = OSMO_STRINGIFY(UPD_HLR_VLR_S_WAIT_FOR_DATA), |
| 140 | .action = upd_hlr_vlr_fsm_wait_data, |
| 141 | }, |
| 142 | [UPD_HLR_VLR_S_DONE] = { |
| 143 | .name = OSMO_STRINGIFY(UPD_HLR_VLR_S_DONE), |
| 144 | }, |
| 145 | }; |
| 146 | |
| 147 | static struct osmo_fsm upd_hlr_vlr_fsm = { |
| 148 | .name = "upd_hlr_vlr_fsm", |
| 149 | .states = upd_hlr_vlr_states, |
| 150 | .num_states = ARRAY_SIZE(upd_hlr_vlr_states), |
| 151 | .allstate_event_mask = 0, |
| 152 | .allstate_action = NULL, |
| 153 | .log_subsys = DVLR, |
| 154 | .event_names = upd_hlr_vlr_event_names, |
| 155 | }; |
| 156 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 157 | static inline struct vlr_subscr *upd_hlr_vlr_fi_priv(struct osmo_fsm_inst *fi) |
| 158 | { |
| 159 | OSMO_ASSERT(fi->fsm == &upd_hlr_vlr_fsm); |
| 160 | return (struct vlr_subscr*)fi->priv; |
| 161 | } |
| 162 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 163 | struct osmo_fsm_inst * |
| 164 | upd_hlr_vlr_proc_start(struct osmo_fsm_inst *parent, |
| 165 | struct vlr_subscr *vsub, |
| 166 | uint32_t parent_event) |
| 167 | { |
| 168 | struct osmo_fsm_inst *fi; |
| 169 | |
| 170 | fi = osmo_fsm_inst_alloc_child(&upd_hlr_vlr_fsm, parent, |
| 171 | parent_event); |
| 172 | if (!fi) |
| 173 | return NULL; |
| 174 | |
| 175 | fi->priv = vsub; |
| 176 | osmo_fsm_inst_dispatch(fi, UPD_HLR_VLR_E_START, NULL); |
| 177 | |
| 178 | return fi; |
| 179 | } |
| 180 | |
| 181 | |
| 182 | /*********************************************************************** |
| 183 | * Subscriber_Present_VLR, TS 29.002 Chapter 25.10.1 |
| 184 | ***********************************************************************/ |
| 185 | |
| 186 | enum sub_pres_vlr_state { |
| 187 | SUB_PRES_VLR_S_INIT, |
| 188 | SUB_PRES_VLR_S_WAIT_FOR_HLR, |
| 189 | SUB_PRES_VLR_S_DONE, |
| 190 | }; |
| 191 | |
| 192 | enum sub_pres_vlr_event { |
| 193 | SUB_PRES_VLR_E_START, |
| 194 | SUB_PRES_VLR_E_READY_SM_CNF, |
| 195 | SUB_PRES_VLR_E_READY_SM_ERR, |
| 196 | }; |
| 197 | |
| 198 | static const struct value_string sub_pres_vlr_event_names[] = { |
| 199 | OSMO_VALUE_STRING(SUB_PRES_VLR_E_START), |
| 200 | OSMO_VALUE_STRING(SUB_PRES_VLR_E_READY_SM_CNF), |
| 201 | OSMO_VALUE_STRING(SUB_PRES_VLR_E_READY_SM_ERR), |
| 202 | { 0, NULL } |
| 203 | }; |
| 204 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 205 | static inline struct vlr_subscr *sub_pres_vlr_fi_priv(struct osmo_fsm_inst *fi); |
| 206 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 207 | static void sub_pres_vlr_fsm_init(struct osmo_fsm_inst *fi, uint32_t event, |
| 208 | void *data) |
| 209 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 210 | struct vlr_subscr *vsub = sub_pres_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 211 | OSMO_ASSERT(event == SUB_PRES_VLR_E_START); |
| 212 | |
| 213 | if (!vsub->ms_not_reachable_flag) { |
| 214 | osmo_fsm_inst_state_chg(fi, SUB_PRES_VLR_S_DONE, 0, 0); |
| 215 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); |
| 216 | return; |
| 217 | } |
| 218 | /* FIXME: Send READY_FOR_SM via GSUP */ |
| 219 | osmo_fsm_inst_state_chg(fi, SUB_PRES_VLR_S_WAIT_FOR_HLR, |
| 220 | LU_TIMEOUT_LONG, 0); |
| 221 | } |
| 222 | |
| 223 | static void sub_pres_vlr_fsm_wait_hlr(struct osmo_fsm_inst *fi, uint32_t event, |
| 224 | void *data) |
| 225 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 226 | struct vlr_subscr *vsub = sub_pres_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 227 | |
| 228 | switch (event) { |
| 229 | case SUB_PRES_VLR_E_READY_SM_CNF: |
| 230 | vsub->ms_not_reachable_flag = false; |
| 231 | break; |
| 232 | case SUB_PRES_VLR_E_READY_SM_ERR: |
| 233 | break; |
| 234 | } |
| 235 | osmo_fsm_inst_state_chg(fi, SUB_PRES_VLR_S_DONE, 0, 0); |
| 236 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); |
| 237 | } |
| 238 | |
| 239 | static const struct osmo_fsm_state sub_pres_vlr_states[] = { |
| 240 | [SUB_PRES_VLR_S_INIT] = { |
| 241 | .in_event_mask = S(SUB_PRES_VLR_E_START), |
| 242 | .out_state_mask = S(SUB_PRES_VLR_S_WAIT_FOR_HLR) | |
| 243 | S(SUB_PRES_VLR_S_DONE), |
| 244 | .name = OSMO_STRINGIFY(SUB_PRES_VLR_S_INIT), |
| 245 | .action = sub_pres_vlr_fsm_init, |
| 246 | }, |
| 247 | [SUB_PRES_VLR_S_WAIT_FOR_HLR] = { |
| 248 | .in_event_mask = S(SUB_PRES_VLR_E_READY_SM_CNF) | |
| 249 | S(SUB_PRES_VLR_E_READY_SM_ERR), |
| 250 | .out_state_mask = S(SUB_PRES_VLR_S_DONE), |
| 251 | .name = OSMO_STRINGIFY(SUB_PRES_VLR_S_WAIT_FOR_HLR), |
| 252 | .action = sub_pres_vlr_fsm_wait_hlr, |
| 253 | }, |
| 254 | [SUB_PRES_VLR_S_DONE] = { |
| 255 | .name = OSMO_STRINGIFY(SUB_PRES_VLR_S_DONE), |
| 256 | }, |
| 257 | }; |
| 258 | |
| 259 | static struct osmo_fsm sub_pres_vlr_fsm = { |
| 260 | .name = "sub_pres_vlr_fsm", |
| 261 | .states = sub_pres_vlr_states, |
| 262 | .num_states = ARRAY_SIZE(sub_pres_vlr_states), |
| 263 | .allstate_event_mask = 0, |
| 264 | .allstate_action = NULL, |
| 265 | .log_subsys = DVLR, |
| 266 | .event_names = sub_pres_vlr_event_names, |
| 267 | }; |
| 268 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 269 | static inline struct vlr_subscr *sub_pres_vlr_fi_priv(struct osmo_fsm_inst *fi) |
| 270 | { |
| 271 | OSMO_ASSERT(fi->fsm == &sub_pres_vlr_fsm); |
| 272 | return (struct vlr_subscr*)fi->priv; |
| 273 | } |
| 274 | |
Neels Hofmeyr | 5f1ac6d | 2018-12-11 01:59:25 +0100 | [diff] [blame] | 275 | /* THIS IS CURRENTLY DEAD CODE, SINCE WE NEVER SET vsub->ms_not_reachable_flag = true. |
| 276 | * |
| 277 | * Note that the start event is dispatched right away, so in case the FSM immediately concludes from that |
Neels Hofmeyr | 1a5bcd5 | 2017-11-18 22:19:55 +0100 | [diff] [blame] | 278 | * event, the created FSM struct may no longer be valid as it already deallocated again, and it may |
| 279 | * furthermore already have invoked the parent FSM instance's deallocation as well. Hence, instead of |
| 280 | * returning, store the created FSM instance address in *fi_p before dispatching the event. It is thus |
| 281 | * possible to store the instance's pointer in a parent FSM instance without running danger of using |
| 282 | * already freed memory. */ |
| 283 | void sub_pres_vlr_fsm_start(struct osmo_fsm_inst **fi_p, |
| 284 | struct osmo_fsm_inst *parent, |
| 285 | struct vlr_subscr *vsub, |
| 286 | uint32_t term_event) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 287 | { |
| 288 | struct osmo_fsm_inst *fi; |
| 289 | |
Neels Hofmeyr | 1a5bcd5 | 2017-11-18 22:19:55 +0100 | [diff] [blame] | 290 | OSMO_ASSERT(fi_p); |
| 291 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 292 | fi = osmo_fsm_inst_alloc_child(&sub_pres_vlr_fsm, parent, |
| 293 | term_event); |
Neels Hofmeyr | 1a5bcd5 | 2017-11-18 22:19:55 +0100 | [diff] [blame] | 294 | *fi_p = fi; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 295 | if (!fi) |
Neels Hofmeyr | 1a5bcd5 | 2017-11-18 22:19:55 +0100 | [diff] [blame] | 296 | return; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 297 | |
| 298 | fi->priv = vsub; |
| 299 | osmo_fsm_inst_dispatch(fi, SUB_PRES_VLR_E_START, NULL); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 300 | } |
| 301 | |
| 302 | /*********************************************************************** |
| 303 | * Location_Update_Completion_VLR, TS 23.012 Chapter 4.1.2.3 |
| 304 | ***********************************************************************/ |
| 305 | |
| 306 | enum lu_compl_vlr_state { |
| 307 | LU_COMPL_VLR_S_INIT, |
| 308 | LU_COMPL_VLR_S_WAIT_SUB_PRES, |
| 309 | LU_COMPL_VLR_S_WAIT_IMEI, |
| 310 | LU_COMPL_VLR_S_WAIT_IMEI_TMSI, |
| 311 | LU_COMPL_VLR_S_WAIT_TMSI_CNF, |
| 312 | LU_COMPL_VLR_S_DONE, |
| 313 | }; |
| 314 | |
| 315 | enum lu_compl_vlr_event { |
| 316 | LU_COMPL_VLR_E_START, |
| 317 | LU_COMPL_VLR_E_SUB_PRES_COMPL, |
| 318 | LU_COMPL_VLR_E_IMEI_CHECK_ACK, |
| 319 | LU_COMPL_VLR_E_IMEI_CHECK_NACK, |
| 320 | LU_COMPL_VLR_E_NEW_TMSI_ACK, |
| 321 | }; |
| 322 | |
| 323 | static const struct value_string lu_compl_vlr_event_names[] = { |
| 324 | OSMO_VALUE_STRING(LU_COMPL_VLR_E_START), |
| 325 | OSMO_VALUE_STRING(LU_COMPL_VLR_E_SUB_PRES_COMPL), |
| 326 | OSMO_VALUE_STRING(LU_COMPL_VLR_E_IMEI_CHECK_ACK), |
| 327 | OSMO_VALUE_STRING(LU_COMPL_VLR_E_IMEI_CHECK_NACK), |
| 328 | OSMO_VALUE_STRING(LU_COMPL_VLR_E_NEW_TMSI_ACK), |
| 329 | { 0, NULL } |
| 330 | }; |
| 331 | |
| 332 | struct lu_compl_vlr_priv { |
| 333 | struct vlr_subscr *vsub; |
| 334 | void *msc_conn_ref; |
| 335 | struct osmo_fsm_inst *sub_pres_vlr_fsm; |
| 336 | uint32_t parent_event_success; |
| 337 | uint32_t parent_event_failure; |
| 338 | void *parent_event_data; |
| 339 | enum vlr_fsm_result result; |
| 340 | uint8_t cause; |
| 341 | bool assign_tmsi; |
| 342 | }; |
| 343 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 344 | static inline struct lu_compl_vlr_priv *lu_compl_vlr_fi_priv(struct osmo_fsm_inst *fi); |
| 345 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 346 | static void _vlr_lu_compl_fsm_done(struct osmo_fsm_inst *fi, |
| 347 | enum vlr_fsm_result result, |
| 348 | uint8_t cause) |
| 349 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 350 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 351 | lcvp->result = result; |
| 352 | lcvp->cause = cause; |
| 353 | osmo_fsm_inst_state_chg(fi, LU_COMPL_VLR_S_DONE, 0, 0); |
| 354 | } |
| 355 | |
| 356 | static void vlr_lu_compl_fsm_success(struct osmo_fsm_inst *fi) |
| 357 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 358 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 359 | struct vlr_subscr *vsub = lcvp->vsub; |
| 360 | if (!vsub->lu_complete) { |
| 361 | vsub->lu_complete = true; |
Stefan Sperling | defc3c8 | 2018-05-15 14:48:04 +0200 | [diff] [blame] | 362 | /* Balanced by vlr_subscr_expire() */ |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 363 | vlr_subscr_get(vsub, VSUB_USE_ATTACHED); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 364 | } |
| 365 | _vlr_lu_compl_fsm_done(fi, VLR_FSM_RESULT_SUCCESS, 0); |
Harald Welte | 0df904d | 2018-12-03 11:00:04 +0100 | [diff] [blame] | 366 | vlr_sgs_fsm_update_id(vsub); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 367 | } |
| 368 | |
| 369 | static void vlr_lu_compl_fsm_failure(struct osmo_fsm_inst *fi, uint8_t cause) |
| 370 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 371 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 372 | lcvp->vsub->vlr->ops.tx_lu_rej(lcvp->msc_conn_ref, cause); |
| 373 | _vlr_lu_compl_fsm_done(fi, VLR_FSM_RESULT_FAILURE, cause); |
| 374 | } |
| 375 | |
| 376 | static void vlr_lu_compl_fsm_dispatch_result(struct osmo_fsm_inst *fi, |
| 377 | uint32_t prev_state) |
| 378 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 379 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 380 | if (!fi->proc.parent) { |
| 381 | LOGPFSML(fi, LOGL_ERROR, "No parent FSM\n"); |
| 382 | return; |
| 383 | } |
| 384 | osmo_fsm_inst_dispatch(fi->proc.parent, |
| 385 | (lcvp->result == VLR_FSM_RESULT_SUCCESS) |
| 386 | ? lcvp->parent_event_success |
| 387 | : lcvp->parent_event_failure, |
| 388 | &lcvp->cause); |
| 389 | } |
| 390 | |
| 391 | static void lu_compl_vlr_init(struct osmo_fsm_inst *fi, uint32_t event, |
| 392 | void *data) |
| 393 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 394 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 395 | struct vlr_subscr *vsub = lcvp->vsub; |
| 396 | struct vlr_instance *vlr; |
| 397 | OSMO_ASSERT(vsub); |
| 398 | vlr = vsub->vlr; |
| 399 | OSMO_ASSERT(vlr); |
| 400 | |
| 401 | OSMO_ASSERT(event == LU_COMPL_VLR_E_START); |
| 402 | |
| 403 | /* TODO: National Roaming restrictions? */ |
| 404 | /* TODO: Roaming restriction due to unsupported feature in subscriber |
| 405 | * data? */ |
| 406 | /* TODO: Regional subscription restriction? */ |
| 407 | /* TODO: Administrative restriction of subscribres' access feature? */ |
| 408 | /* TODO: AccessRestrictuionData parameter available? */ |
| 409 | /* TODO: AccessRestrictionData permits RAT? */ |
| 410 | /* Node 1 */ |
| 411 | /* TODO: Autonomous CSG supported in VPLMN and allowed by HPLMN? */ |
| 412 | /* TODO: Hybrid Cel / CSG Cell */ |
| 413 | /* Node 2 */ |
| 414 | vsub->la_allowed = true; |
| 415 | vsub->imsi_detached_flag = false; |
| 416 | /* Start Subscriber_Present_VLR Procedure */ |
| 417 | osmo_fsm_inst_state_chg(fi, LU_COMPL_VLR_S_WAIT_SUB_PRES, |
| 418 | LU_TIMEOUT_LONG, 0); |
| 419 | |
Neels Hofmeyr | aa14bac | 2018-12-11 01:56:11 +0100 | [diff] [blame] | 420 | /* If ms_not_reachable_flag == false, the sub_pres_vlr_fsm will anyway terminate straight away and dispatch |
| 421 | * LU_COMPL_VLR_E_SUB_PRES_COMPL to this fi, so we might as well skip that dance here and save some logging. */ |
| 422 | if (vsub->ms_not_reachable_flag) |
| 423 | sub_pres_vlr_fsm_start(&lcvp->sub_pres_vlr_fsm, fi, vsub, LU_COMPL_VLR_E_SUB_PRES_COMPL); |
| 424 | else |
| 425 | osmo_fsm_inst_dispatch(fi, LU_COMPL_VLR_E_SUB_PRES_COMPL, NULL); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 426 | } |
| 427 | |
| 428 | static void lu_compl_vlr_new_tmsi(struct osmo_fsm_inst *fi) |
| 429 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 430 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 431 | struct vlr_subscr *vsub = lcvp->vsub; |
| 432 | struct vlr_instance *vlr = vsub->vlr; |
| 433 | |
| 434 | LOGPFSM(fi, "%s()\n", __func__); |
| 435 | |
| 436 | if (vlr_subscr_alloc_tmsi(vsub)) { |
| 437 | vlr_lu_compl_fsm_failure(fi, |
| 438 | GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER); |
| 439 | return; |
| 440 | } |
| 441 | |
| 442 | osmo_fsm_inst_state_chg(fi, LU_COMPL_VLR_S_WAIT_TMSI_CNF, |
| 443 | vlr_timer(vlr, 3250), 3250); |
| 444 | |
| 445 | vlr->ops.tx_lu_acc(lcvp->msc_conn_ref, vsub->tmsi_new); |
| 446 | } |
| 447 | |
| 448 | /* After completion of Subscriber_Present_VLR */ |
| 449 | static void lu_compl_vlr_wait_subscr_pres(struct osmo_fsm_inst *fi, |
| 450 | uint32_t event, |
| 451 | void *data) |
| 452 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 453 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 454 | struct vlr_subscr *vsub = lcvp->vsub; |
| 455 | struct vlr_instance *vlr = vsub->vlr; |
| 456 | |
| 457 | OSMO_ASSERT(event == LU_COMPL_VLR_E_SUB_PRES_COMPL); |
| 458 | |
| 459 | lcvp->sub_pres_vlr_fsm = NULL; |
| 460 | |
| 461 | /* TODO: Trace_Subscriber_Activity_VLR */ |
| 462 | |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 463 | /* If imeisv_early is enabled: IMEI already retrieved and checked (vlr_loc_upd_node1_pre), don't do it again. */ |
| 464 | if (vlr->cfg.check_imei_rqd && !vlr->cfg.retrieve_imeisv_early) { |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 465 | /* Check IMEI VLR */ |
| 466 | osmo_fsm_inst_state_chg(fi, |
| 467 | lcvp->assign_tmsi ? |
| 468 | LU_COMPL_VLR_S_WAIT_IMEI_TMSI |
| 469 | : LU_COMPL_VLR_S_WAIT_IMEI, |
| 470 | vlr_timer(vlr, 3270), 3270); |
| 471 | vlr->ops.tx_id_req(lcvp->msc_conn_ref, GSM_MI_TYPE_IMEI); |
| 472 | return; |
| 473 | } |
| 474 | |
| 475 | /* Do we need to allocate a TMSI? */ |
| 476 | if (lcvp->assign_tmsi) { |
| 477 | lu_compl_vlr_new_tmsi(fi); |
| 478 | return; |
| 479 | } |
| 480 | |
| 481 | /* Location Updating Accept */ |
| 482 | vlr->ops.tx_lu_acc(lcvp->msc_conn_ref, GSM_RESERVED_TMSI); |
| 483 | vlr_lu_compl_fsm_success(fi); |
| 484 | } |
| 485 | |
| 486 | /* Waiting for completion of CHECK_IMEI_VLR */ |
| 487 | static void lu_compl_vlr_wait_imei(struct osmo_fsm_inst *fi, uint32_t event, |
| 488 | void *data) |
| 489 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 490 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 491 | struct vlr_subscr *vsub = lcvp->vsub; |
| 492 | struct vlr_instance *vlr = vsub->vlr; |
| 493 | |
| 494 | switch (event) { |
| 495 | case LU_COMPL_VLR_E_IMEI_CHECK_ACK: |
| 496 | if (!vsub->imei[0]) { |
| 497 | /* Abort: Do nothing */ |
| 498 | vlr_lu_compl_fsm_failure(fi, |
| 499 | GSM48_REJECT_PROTOCOL_ERROR); |
| 500 | return; |
| 501 | } |
| 502 | /* Pass */ |
| 503 | break; |
| 504 | |
| 505 | case LU_COMPL_VLR_E_IMEI_CHECK_NACK: |
| 506 | vlr_lu_compl_fsm_failure(fi, GSM48_REJECT_ILLEGAL_ME); |
| 507 | /* FIXME: IMEI Check Fail to VLR Application (Detach IMSI VLR) */ |
| 508 | return; |
| 509 | } |
| 510 | |
| 511 | /* IMEI is available. Allocate TMSI if needed. */ |
| 512 | if (lcvp->assign_tmsi) { |
| 513 | if (fi->state != LU_COMPL_VLR_S_WAIT_IMEI_TMSI) |
| 514 | LOGPFSML(fi, LOGL_ERROR, |
| 515 | "TMSI required, expected to be in state" |
| 516 | " LU_COMPL_VLR_S_WAIT_IMEI_TMSI," |
| 517 | " am in %s instead\n", |
| 518 | osmo_fsm_state_name(fi->fsm, fi->state)); |
| 519 | /* Logged an error, continue anyway. */ |
| 520 | |
| 521 | lu_compl_vlr_new_tmsi(fi); |
| 522 | |
| 523 | /* Wait for TMSI ack */ |
| 524 | return; |
| 525 | } |
| 526 | |
| 527 | /* No TMSI needed, accept now. */ |
| 528 | vlr->ops.tx_lu_acc(lcvp->msc_conn_ref, GSM_RESERVED_TMSI); |
| 529 | vlr_lu_compl_fsm_success(fi); |
| 530 | } |
| 531 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 532 | static inline struct lu_compl_vlr_priv *lu_compl_vlr_fi_priv(struct osmo_fsm_inst *fi); |
| 533 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 534 | /* Waiting for TMSI confirmation */ |
| 535 | static void lu_compl_vlr_wait_tmsi(struct osmo_fsm_inst *fi, uint32_t event, |
| 536 | void *data) |
| 537 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 538 | struct lu_compl_vlr_priv *lcvp = lu_compl_vlr_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 539 | struct vlr_subscr *vsub = lcvp->vsub; |
| 540 | |
| 541 | OSMO_ASSERT(event == LU_COMPL_VLR_E_NEW_TMSI_ACK); |
| 542 | |
| 543 | if (!vsub || vsub->tmsi_new == GSM_RESERVED_TMSI) { |
| 544 | LOGPFSML(fi, LOGL_ERROR, "TMSI Realloc Compl implies that" |
| 545 | " the subscriber has a new TMSI allocated, but" |
| 546 | " the new TMSI is unset.\n"); |
| 547 | vlr_lu_compl_fsm_failure(fi, GSM48_REJECT_NETWORK_FAILURE); |
| 548 | return; |
| 549 | } |
| 550 | |
| 551 | vsub->tmsi = vsub->tmsi_new; |
| 552 | vsub->tmsi_new = GSM_RESERVED_TMSI; |
Neels Hofmeyr | 361e571 | 2019-01-03 02:32:14 +0100 | [diff] [blame] | 553 | vsub->vlr->ops.subscr_update(vsub); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 554 | |
| 555 | vlr_lu_compl_fsm_success(fi); |
| 556 | } |
| 557 | |
| 558 | static const struct osmo_fsm_state lu_compl_vlr_states[] = { |
| 559 | [LU_COMPL_VLR_S_INIT] = { |
| 560 | .in_event_mask = S(LU_COMPL_VLR_E_START), |
| 561 | .out_state_mask = S(LU_COMPL_VLR_S_DONE) | |
Neels Hofmeyr | d50f898 | 2018-12-11 02:24:57 +0100 | [diff] [blame] | 562 | S(LU_COMPL_VLR_S_WAIT_SUB_PRES), |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 563 | .name = OSMO_STRINGIFY(LU_COMPL_VLR_S_INIT), |
| 564 | .action = lu_compl_vlr_init, |
| 565 | }, |
| 566 | [LU_COMPL_VLR_S_WAIT_SUB_PRES] = { |
| 567 | .in_event_mask = S(LU_COMPL_VLR_E_SUB_PRES_COMPL), |
| 568 | .out_state_mask = S(LU_COMPL_VLR_S_WAIT_IMEI) | |
| 569 | S(LU_COMPL_VLR_S_WAIT_IMEI_TMSI) | |
| 570 | S(LU_COMPL_VLR_S_WAIT_TMSI_CNF) | |
| 571 | S(LU_COMPL_VLR_S_DONE), |
| 572 | .name = OSMO_STRINGIFY(LU_COMPL_VLR_S_WAIT_SUB_PRES), |
| 573 | .action = lu_compl_vlr_wait_subscr_pres, |
| 574 | }, |
| 575 | [LU_COMPL_VLR_S_WAIT_IMEI] = { |
| 576 | .in_event_mask = S(LU_COMPL_VLR_E_IMEI_CHECK_ACK) | |
| 577 | S(LU_COMPL_VLR_E_IMEI_CHECK_NACK), |
| 578 | .out_state_mask = S(LU_COMPL_VLR_S_DONE), |
| 579 | .name = OSMO_STRINGIFY(LU_COMPL_VLR_S_WAIT_IMEI), |
| 580 | .action = lu_compl_vlr_wait_imei, |
| 581 | }, |
| 582 | [LU_COMPL_VLR_S_WAIT_IMEI_TMSI] = { |
| 583 | .in_event_mask = S(LU_COMPL_VLR_E_IMEI_CHECK_ACK) | |
| 584 | S(LU_COMPL_VLR_E_IMEI_CHECK_NACK), |
| 585 | .out_state_mask = S(LU_COMPL_VLR_S_DONE) | |
| 586 | S(LU_COMPL_VLR_S_WAIT_TMSI_CNF), |
| 587 | .name = OSMO_STRINGIFY(LU_COMPL_VLR_S_WAIT_IMEI_TMSI), |
| 588 | .action = lu_compl_vlr_wait_imei, |
| 589 | }, |
| 590 | [LU_COMPL_VLR_S_WAIT_TMSI_CNF] = { |
| 591 | .in_event_mask = S(LU_COMPL_VLR_E_NEW_TMSI_ACK), |
| 592 | .out_state_mask = S(LU_COMPL_VLR_S_DONE), |
| 593 | .name = OSMO_STRINGIFY(LU_COMPL_VLR_S_WAIT_TMSI_CNF), |
| 594 | .action = lu_compl_vlr_wait_tmsi, |
| 595 | }, |
| 596 | [LU_COMPL_VLR_S_DONE] = { |
| 597 | .name = OSMO_STRINGIFY(LU_COMPL_VLR_S_DONE), |
| 598 | .onenter = vlr_lu_compl_fsm_dispatch_result, |
| 599 | }, |
| 600 | }; |
| 601 | |
| 602 | static struct osmo_fsm lu_compl_vlr_fsm = { |
| 603 | .name = "lu_compl_vlr_fsm", |
| 604 | .states = lu_compl_vlr_states, |
| 605 | .num_states = ARRAY_SIZE(lu_compl_vlr_states), |
| 606 | .allstate_event_mask = 0, |
| 607 | .allstate_action = NULL, |
| 608 | .log_subsys = DVLR, |
| 609 | .event_names = lu_compl_vlr_event_names, |
| 610 | }; |
| 611 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 612 | static inline struct lu_compl_vlr_priv *lu_compl_vlr_fi_priv(struct osmo_fsm_inst *fi) |
| 613 | { |
| 614 | OSMO_ASSERT(fi->fsm == &lu_compl_vlr_fsm); |
| 615 | return (struct lu_compl_vlr_priv*)fi->priv; |
| 616 | } |
| 617 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 618 | struct osmo_fsm_inst * |
| 619 | lu_compl_vlr_proc_alloc(struct osmo_fsm_inst *parent, |
| 620 | struct vlr_subscr *vsub, |
| 621 | void *msc_conn_ref, |
| 622 | uint32_t parent_event_success, |
| 623 | uint32_t parent_event_failure, |
| 624 | bool assign_tmsi) |
| 625 | { |
| 626 | struct osmo_fsm_inst *fi; |
| 627 | struct lu_compl_vlr_priv *lcvp; |
| 628 | |
| 629 | fi = osmo_fsm_inst_alloc_child(&lu_compl_vlr_fsm, parent, |
| 630 | parent_event_failure); |
| 631 | if (!fi) |
| 632 | return NULL; |
| 633 | |
| 634 | lcvp = talloc_zero(fi, struct lu_compl_vlr_priv); |
| 635 | lcvp->vsub = vsub; |
| 636 | lcvp->msc_conn_ref = msc_conn_ref; |
| 637 | lcvp->parent_event_success = parent_event_success; |
| 638 | lcvp->parent_event_failure = parent_event_failure; |
| 639 | lcvp->assign_tmsi = assign_tmsi; |
| 640 | fi->priv = lcvp; |
| 641 | |
| 642 | return fi; |
| 643 | } |
| 644 | |
| 645 | |
| 646 | /*********************************************************************** |
| 647 | * Update_Location_Area_VLR, TS 23.012 Chapter 4.1.2.1 |
| 648 | ***********************************************************************/ |
| 649 | |
| 650 | static const struct value_string fsm_lu_event_names[] = { |
| 651 | OSMO_VALUE_STRING(VLR_ULA_E_UPDATE_LA), |
| 652 | OSMO_VALUE_STRING(VLR_ULA_E_SEND_ID_ACK), |
| 653 | OSMO_VALUE_STRING(VLR_ULA_E_SEND_ID_NACK), |
| 654 | OSMO_VALUE_STRING(VLR_ULA_E_AUTH_RES), |
| 655 | OSMO_VALUE_STRING(VLR_ULA_E_CIPH_RES), |
| 656 | OSMO_VALUE_STRING(VLR_ULA_E_ID_IMSI), |
| 657 | OSMO_VALUE_STRING(VLR_ULA_E_ID_IMEI), |
| 658 | OSMO_VALUE_STRING(VLR_ULA_E_ID_IMEISV), |
Oliver Smith | 7d05309 | 2018-12-14 17:37:38 +0100 | [diff] [blame] | 659 | OSMO_VALUE_STRING(VLR_ULA_E_HLR_IMEI_ACK), |
| 660 | OSMO_VALUE_STRING(VLR_ULA_E_HLR_IMEI_NACK), |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 661 | OSMO_VALUE_STRING(VLR_ULA_E_HLR_LU_RES), |
| 662 | OSMO_VALUE_STRING(VLR_ULA_E_UPD_HLR_COMPL), |
| 663 | OSMO_VALUE_STRING(VLR_ULA_E_LU_COMPL_SUCCESS), |
| 664 | OSMO_VALUE_STRING(VLR_ULA_E_LU_COMPL_FAILURE), |
| 665 | OSMO_VALUE_STRING(VLR_ULA_E_NEW_TMSI_ACK), |
| 666 | { 0, NULL } |
| 667 | }; |
| 668 | |
| 669 | struct lu_fsm_priv { |
| 670 | struct vlr_instance *vlr; |
| 671 | struct vlr_subscr *vsub; |
| 672 | void *msc_conn_ref; |
| 673 | struct osmo_fsm_inst *upd_hlr_vlr_fsm; |
| 674 | struct osmo_fsm_inst *lu_compl_vlr_fsm; |
| 675 | uint32_t parent_event_success; |
| 676 | uint32_t parent_event_failure; |
| 677 | void *parent_event_data; |
| 678 | enum vlr_fsm_result result; |
| 679 | uint8_t rej_cause; |
| 680 | |
| 681 | enum vlr_lu_type type; |
| 682 | bool lu_by_tmsi; |
| 683 | char imsi[16]; |
| 684 | uint32_t tmsi; |
| 685 | struct osmo_location_area_id old_lai; |
| 686 | struct osmo_location_area_id new_lai; |
| 687 | bool authentication_required; |
Harald Welte | 71c51df | 2017-12-23 18:51:48 +0100 | [diff] [blame] | 688 | bool ciphering_required; |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 689 | uint8_t key_seq; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 690 | bool is_r99; |
| 691 | bool is_utran; |
| 692 | bool assign_tmsi; |
| 693 | }; |
| 694 | |
| 695 | |
| 696 | /* Determine if given location area is served by this VLR */ |
| 697 | static bool lai_in_this_vlr(struct vlr_instance *vlr, |
| 698 | const struct osmo_location_area_id *lai) |
| 699 | { |
| 700 | /* TODO: VLR needs to keep a locally configued list of LAIs */ |
| 701 | return true; |
| 702 | } |
| 703 | |
| 704 | /* Determine if authentication is required */ |
| 705 | static bool is_auth_required(struct lu_fsm_priv *lfp) |
| 706 | { |
| 707 | /* The cases where the authentication procedure should be used |
| 708 | * are defined in 3GPP TS 33.102 */ |
| 709 | /* For now we use a default value passed in to vlr_lu_fsm(). */ |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 710 | return lfp->authentication_required || |
| 711 | (lfp->ciphering_required && !auth_try_reuse_tuple(lfp->vsub, lfp->key_seq)); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 712 | } |
| 713 | |
| 714 | /* Determine if ciphering is required */ |
| 715 | static bool is_ciph_required(struct lu_fsm_priv *lfp) |
| 716 | { |
Harald Welte | 71c51df | 2017-12-23 18:51:48 +0100 | [diff] [blame] | 717 | return lfp->ciphering_required; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 718 | } |
| 719 | |
| 720 | /* Determine if a HLR Update is required */ |
| 721 | static bool hlr_update_needed(struct vlr_subscr *vsub) |
| 722 | { |
| 723 | /* TODO: properly decide this, rather than always assuming we |
| 724 | * need to update the HLR. */ |
| 725 | return true; |
| 726 | } |
| 727 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 728 | static inline struct lu_fsm_priv *lu_fsm_fi_priv(struct osmo_fsm_inst *fi); |
| 729 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 730 | static void lu_fsm_dispatch_result(struct osmo_fsm_inst *fi, |
| 731 | uint32_t prev_state) |
| 732 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 733 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 734 | if (!fi->proc.parent) { |
| 735 | LOGPFSML(fi, LOGL_ERROR, "No parent FSM\n"); |
| 736 | return; |
| 737 | } |
| 738 | osmo_fsm_inst_dispatch(fi->proc.parent, |
| 739 | (lfp->result == VLR_FSM_RESULT_SUCCESS) |
| 740 | ? lfp->parent_event_success |
| 741 | : lfp->parent_event_failure, |
| 742 | lfp->parent_event_data); |
| 743 | } |
| 744 | |
| 745 | static void _lu_fsm_done(struct osmo_fsm_inst *fi, |
| 746 | enum vlr_fsm_result result) |
| 747 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 748 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 749 | lfp->result = result; |
| 750 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_DONE, 0, 0); |
| 751 | } |
| 752 | |
| 753 | static void lu_fsm_success(struct osmo_fsm_inst *fi) |
| 754 | { |
| 755 | _lu_fsm_done(fi, VLR_FSM_RESULT_SUCCESS); |
| 756 | } |
| 757 | |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 758 | static void lu_fsm_failure(struct osmo_fsm_inst *fi, enum gsm48_reject_value rej_cause) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 759 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 760 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 761 | lfp->vlr->ops.tx_lu_rej(lfp->msc_conn_ref, rej_cause ? : GSM48_REJECT_NETWORK_FAILURE); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 762 | _lu_fsm_done(fi, VLR_FSM_RESULT_FAILURE); |
| 763 | } |
| 764 | |
| 765 | static void vlr_loc_upd_start_lu_compl_fsm(struct osmo_fsm_inst *fi) |
| 766 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 767 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 768 | lfp->lu_compl_vlr_fsm = |
| 769 | lu_compl_vlr_proc_alloc(fi, lfp->vsub, lfp->msc_conn_ref, |
| 770 | VLR_ULA_E_LU_COMPL_SUCCESS, |
| 771 | VLR_ULA_E_LU_COMPL_FAILURE, |
| 772 | lfp->assign_tmsi); |
| 773 | |
| 774 | osmo_fsm_inst_dispatch(lfp->lu_compl_vlr_fsm, LU_COMPL_VLR_E_START, NULL); |
| 775 | } |
| 776 | |
| 777 | static void lu_fsm_discard_lu_compl_fsm(struct osmo_fsm_inst *fi) |
| 778 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 779 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 780 | if (!lfp->lu_compl_vlr_fsm) |
| 781 | return; |
| 782 | osmo_fsm_inst_term(lfp->lu_compl_vlr_fsm, OSMO_FSM_TERM_PARENT, NULL); |
| 783 | } |
| 784 | |
| 785 | /* 4.1.2.1 Node 4 */ |
| 786 | static void vlr_loc_upd_node_4(struct osmo_fsm_inst *fi) |
| 787 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 788 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 789 | struct vlr_subscr *vsub = lfp->vsub; |
| 790 | bool hlr_unknown = false; |
| 791 | |
| 792 | LOGPFSM(fi, "%s()\n", __func__); |
| 793 | |
| 794 | if (hlr_unknown) { |
| 795 | /* FIXME: Delete subscriber record */ |
| 796 | /* LU REJ: Roaming not allowed */ |
| 797 | lu_fsm_failure(fi, GSM48_REJECT_ROAMING_NOT_ALLOWED); |
| 798 | } else { |
| 799 | /* Update_HLR_VLR */ |
| 800 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_HLR_UPD, |
| 801 | LU_TIMEOUT_LONG, 0); |
| 802 | lfp->upd_hlr_vlr_fsm = |
| 803 | upd_hlr_vlr_proc_start(fi, vsub, VLR_ULA_E_UPD_HLR_COMPL); |
| 804 | } |
| 805 | } |
| 806 | |
| 807 | /* 4.1.2.1 Node B */ |
| 808 | static void vlr_loc_upd_node_b(struct osmo_fsm_inst *fi) |
| 809 | { |
| 810 | LOGPFSM(fi, "%s()\n", __func__); |
| 811 | |
Neels Hofmeyr | ef9126c | 2017-07-18 15:38:39 +0200 | [diff] [blame] | 812 | /* OsmoHLR does not support PgA, neither stores the IMEISV, so we have no need to update the HLR |
| 813 | * with either. TODO: depend on actual HLR configuration. See 3GPP TS 23.012 Release 14, process |
| 814 | * Update_Location_Area_VLR (ULA_VLR2). */ |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 815 | if (0) { /* IMEISV or PgA to send */ |
| 816 | vlr_loc_upd_node_4(fi); |
| 817 | } else { |
| 818 | /* Location_Update_Completion */ |
| 819 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_LU_COMPL, |
| 820 | LU_TIMEOUT_LONG, 0); |
| 821 | vlr_loc_upd_start_lu_compl_fsm(fi); |
| 822 | } |
| 823 | } |
| 824 | |
| 825 | /* Non-standard: after Ciphering Mode Complete (or no ciph required) */ |
| 826 | static void vlr_loc_upd_post_ciph(struct osmo_fsm_inst *fi) |
| 827 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 828 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 829 | struct vlr_subscr *vsub = lfp->vsub; |
| 830 | |
| 831 | LOGPFSM(fi, "%s()\n", __func__); |
| 832 | |
| 833 | OSMO_ASSERT(vsub); |
| 834 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 835 | if (lfp->is_utran) { |
| 836 | int rc; |
| 837 | rc = lfp->vlr->ops.tx_common_id(lfp->msc_conn_ref); |
| 838 | if (rc) |
| 839 | LOGPFSML(fi, LOGL_ERROR, |
| 840 | "Error while sending Common ID (%d)\n", rc); |
| 841 | } |
| 842 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 843 | vsub->conf_by_radio_contact_ind = true; |
| 844 | /* Update LAI */ |
| 845 | vsub->cgi.lai = lfp->new_lai; |
| 846 | vsub->dormant_ind = false; |
| 847 | vsub->cancel_loc_rx = false; |
| 848 | if (hlr_update_needed(vsub)) { |
| 849 | vlr_loc_upd_node_4(fi); |
| 850 | } else { |
| 851 | /* TODO: ADD Support */ |
| 852 | /* TODO: Node A: PgA Support */ |
| 853 | vlr_loc_upd_node_b(fi); |
| 854 | } |
| 855 | } |
| 856 | |
| 857 | /* 4.1.2.1 after Authentication successful (or no auth rqd) */ |
| 858 | static void vlr_loc_upd_post_auth(struct osmo_fsm_inst *fi) |
| 859 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 860 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 861 | struct vlr_subscr *vsub = lfp->vsub; |
Neels Hofmeyr | 7795a19 | 2018-03-10 00:26:36 +0100 | [diff] [blame] | 862 | bool umts_aka; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 863 | |
| 864 | LOGPFSM(fi, "%s()\n", __func__); |
| 865 | |
| 866 | OSMO_ASSERT(vsub); |
| 867 | |
| 868 | if (!is_ciph_required(lfp)) { |
| 869 | vlr_loc_upd_post_ciph(fi); |
| 870 | return; |
| 871 | } |
| 872 | |
Neels Hofmeyr | 2ef2da5 | 2017-12-18 01:23:42 +0100 | [diff] [blame] | 873 | if (!vsub->last_tuple) { |
| 874 | LOGPFSML(fi, LOGL_ERROR, "No auth tuple available\n"); |
Neels Hofmeyr | d2278ec | 2018-03-02 02:44:05 +0100 | [diff] [blame] | 875 | lu_fsm_failure(fi, GSM48_REJECT_NETWORK_FAILURE); |
Neels Hofmeyr | 2ef2da5 | 2017-12-18 01:23:42 +0100 | [diff] [blame] | 876 | return; |
| 877 | } |
| 878 | |
Neels Hofmeyr | 7795a19 | 2018-03-10 00:26:36 +0100 | [diff] [blame] | 879 | switch (vsub->sec_ctx) { |
| 880 | case VLR_SEC_CTX_GSM: |
| 881 | umts_aka = false; |
| 882 | break; |
| 883 | case VLR_SEC_CTX_UMTS: |
| 884 | umts_aka = true; |
| 885 | break; |
| 886 | default: |
| 887 | LOGPFSML(fi, LOGL_ERROR, "Cannot start ciphering, security context is not established\n"); |
| 888 | lu_fsm_failure(fi, GSM48_REJECT_NETWORK_FAILURE); |
| 889 | return; |
| 890 | } |
| 891 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 892 | if (vlr_set_ciph_mode(vsub->vlr, fi, lfp->msc_conn_ref, |
| 893 | lfp->ciphering_required, |
Neels Hofmeyr | 7795a19 | 2018-03-10 00:26:36 +0100 | [diff] [blame] | 894 | umts_aka, |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 895 | vsub->vlr->cfg.retrieve_imeisv_ciphered)) { |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 896 | LOGPFSML(fi, LOGL_ERROR, |
| 897 | "Failed to send Ciphering Mode Command\n"); |
Neels Hofmeyr | d2278ec | 2018-03-02 02:44:05 +0100 | [diff] [blame] | 898 | lu_fsm_failure(fi, GSM48_REJECT_NETWORK_FAILURE); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 899 | return; |
| 900 | } |
| 901 | |
| 902 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_CIPH, LU_TIMEOUT_LONG, 0); |
| 903 | } |
| 904 | |
| 905 | static void vlr_loc_upd_node1(struct osmo_fsm_inst *fi) |
| 906 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 907 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 908 | struct vlr_subscr *vsub = lfp->vsub; |
| 909 | |
| 910 | LOGPFSM(fi, "%s()\n", __func__); |
| 911 | |
| 912 | OSMO_ASSERT(vsub); |
| 913 | |
| 914 | if (is_auth_required(lfp)) { |
| 915 | /* Authenticate_VLR */ |
| 916 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_AUTH, |
| 917 | LU_TIMEOUT_LONG, 0); |
| 918 | vsub->auth_fsm = auth_fsm_start(lfp->vsub, fi->log_level, |
| 919 | fi, VLR_ULA_E_AUTH_RES, |
| 920 | lfp->is_r99, |
| 921 | lfp->is_utran); |
| 922 | } else { |
| 923 | /* no need for authentication */ |
| 924 | vlr_loc_upd_post_auth(fi); |
| 925 | } |
| 926 | } |
| 927 | |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 928 | static void vlr_loc_upd_node1_pre(struct osmo_fsm_inst *fi) |
| 929 | { |
| 930 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
| 931 | struct vlr_instance *vlr = lfp->vlr; |
| 932 | |
| 933 | LOGPFSM(fi, "%s()\n", __func__); |
| 934 | |
| 935 | if (vlr->cfg.check_imei_rqd && vlr->cfg.retrieve_imeisv_early) { |
| 936 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY, vlr_timer(lfp->vlr, 3270), 3270); |
| 937 | vlr_subscr_tx_req_check_imei(lfp->vsub); |
| 938 | } else { |
| 939 | vlr_loc_upd_node1(fi); |
| 940 | } |
| 941 | } |
| 942 | |
| 943 | /* End of Check_IMEI Procedure. Executed early (before the location update), so we can send the IMEI to the HLR even if |
| 944 | * the MS would be rejected in LU. See the "Configuring the Subscribers Create on Demand Feature" section of the OsmoHLR |
| 945 | * user manual for a detailed explanation of the use case. */ |
| 946 | static void lu_fsm_wait_hlr_check_imei_early(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 947 | { |
| 948 | switch (event) { |
| 949 | case VLR_ULA_E_HLR_IMEI_ACK: |
| 950 | vlr_loc_upd_node1(fi); |
| 951 | break; |
| 952 | case VLR_ULA_E_HLR_IMEI_NACK: |
| 953 | lu_fsm_failure(fi, GSM48_REJECT_ILLEGAL_ME); |
| 954 | break; |
| 955 | default: |
| 956 | OSMO_ASSERT(0); |
| 957 | break; |
| 958 | } |
| 959 | } |
| 960 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 961 | static void vlr_loc_upd_want_imsi(struct osmo_fsm_inst *fi) |
| 962 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 963 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 964 | struct vlr_instance *vlr = lfp->vlr; |
| 965 | |
| 966 | LOGPFSM(fi, "%s()\n", __func__); |
| 967 | |
| 968 | OSMO_ASSERT(lfp->vsub); |
| 969 | |
| 970 | /* Obtain_IMSI_VLR */ |
| 971 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_IMSI, |
| 972 | vlr_timer(vlr, 3270), 3270); |
| 973 | vlr->ops.tx_id_req(lfp->msc_conn_ref, GSM_MI_TYPE_IMSI); |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 974 | /* will continue at vlr_loc_upd_node1_pre() once IMSI arrives */ |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 975 | } |
| 976 | |
| 977 | static int assoc_lfp_with_sub(struct osmo_fsm_inst *fi, struct vlr_subscr *vsub) |
| 978 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 979 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 980 | struct vlr_instance *vlr = lfp->vlr; |
| 981 | |
| 982 | if (vsub->lu_fsm) { |
| 983 | LOGPFSML(fi, LOGL_ERROR, |
| 984 | "A Location Updating process is already pending for" |
| 985 | " this subscriber. Aborting.\n"); |
| 986 | /* Also get rid of the other pending LU attempt? */ |
| 987 | /*lu_fsm_failure(vsub->lu_fsm, GSM48_REJECT_CONGESTION);*/ |
| 988 | lu_fsm_failure(fi, GSM48_REJECT_CONGESTION); |
| 989 | return -EINVAL; |
| 990 | } |
| 991 | vsub->lu_fsm = fi; |
| 992 | vsub->msc_conn_ref = lfp->msc_conn_ref; |
| 993 | /* FIXME: send new LAC to HLR? */ |
Max | 7d41d87 | 2018-12-19 11:48:33 +0100 | [diff] [blame] | 994 | vsub->cgi.lai.lac = lfp->new_lai.lac; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 995 | lfp->vsub = vsub; |
| 996 | /* Tell MSC to associate this subscriber with the given |
| 997 | * connection */ |
Neels Hofmeyr | 1035d90 | 2018-12-28 21:22:32 +0100 | [diff] [blame] | 998 | if (vlr->ops.subscr_assoc(lfp->msc_conn_ref, lfp->vsub)) |
| 999 | lu_fsm_failure(fi, GSM48_REJECT_NETWORK_FAILURE); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1000 | return 0; |
| 1001 | } |
| 1002 | |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1003 | static int _lu_fsm_associate_vsub(struct osmo_fsm_inst *fi) |
| 1004 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1005 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1006 | struct vlr_instance *vlr = lfp->vlr; |
| 1007 | struct vlr_subscr *vsub = NULL; |
| 1008 | |
| 1009 | if (!lfp->imsi[0]) { |
| 1010 | /* TMSI was used */ |
| 1011 | lfp->lu_by_tmsi = true; |
| 1012 | /* TMSI clash: if a different subscriber already has this TMSI, |
| 1013 | * we will find that other subscriber in the VLR. So the IMSIs |
| 1014 | * would mismatch, but we don't know about it. Theoretically, |
| 1015 | * an authentication process would thwart any attempt to use |
| 1016 | * someone else's TMSI. |
| 1017 | * TODO: Otherwise we can ask for the IMSI and verify that it |
| 1018 | * matches the IMSI on record. */ |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1019 | vsub = vlr_subscr_find_or_create_by_tmsi(vlr, lfp->tmsi, __func__, NULL); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1020 | |
| 1021 | if (!vsub) { |
| 1022 | LOGPFSML(fi, LOGL_ERROR, "VLR subscriber allocation failed\n"); |
| 1023 | lu_fsm_failure(fi, GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER); |
| 1024 | return -1; |
| 1025 | } |
| 1026 | |
| 1027 | vsub->sub_dataconf_by_hlr_ind = false; |
| 1028 | if (assoc_lfp_with_sub(fi, vsub)) { |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1029 | vlr_subscr_put(vsub, __func__); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1030 | return -1; /* error, fsm failure invoked in assoc_lfp_with_sub() */ |
| 1031 | } |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1032 | vlr_subscr_put(vsub, __func__); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1033 | } else { |
| 1034 | /* IMSI was used */ |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1035 | vsub = vlr_subscr_find_or_create_by_imsi(vlr, lfp->imsi, __func__, NULL); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1036 | |
| 1037 | if (!vsub) { |
| 1038 | LOGPFSML(fi, LOGL_ERROR, "VLR subscriber allocation failed\n"); |
| 1039 | lu_fsm_failure(fi, GSM48_REJECT_SRV_OPT_TMP_OUT_OF_ORDER); |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1040 | vlr_subscr_put(vsub, __func__); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1041 | return -1; |
| 1042 | } |
| 1043 | |
| 1044 | vsub->sub_dataconf_by_hlr_ind = false; |
| 1045 | if (assoc_lfp_with_sub(fi, vsub)) { |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1046 | vlr_subscr_put(vsub, __func__); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1047 | return -1; /* error, fsm failure invoked in assoc_lfp_with_sub() */ |
| 1048 | } |
Neels Hofmeyr | 7c5346c | 2019-02-19 02:36:35 +0100 | [diff] [blame] | 1049 | vlr_subscr_put(vsub, __func__); |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1050 | } |
| 1051 | return 0; |
| 1052 | } |
| 1053 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1054 | /* 4.1.2.1: Subscriber (via MSC/SGSN) requests location update */ |
| 1055 | static void _start_lu_main(struct osmo_fsm_inst *fi) |
| 1056 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1057 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1058 | struct vlr_instance *vlr = lfp->vlr; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1059 | |
| 1060 | /* TODO: PUESBINE related handling */ |
| 1061 | |
| 1062 | /* Is previous LAI in this VLR? */ |
| 1063 | if (!lai_in_this_vlr(vlr, &lfp->old_lai)) { |
| 1064 | #if 0 |
| 1065 | /* FIXME: check previous VLR, (3) */ |
| 1066 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_PVLR, |
| 1067 | LU_TIMEOUT_LONG, 0); |
| 1068 | return; |
| 1069 | #endif |
| 1070 | LOGPFSML(fi, LOGL_NOTICE, "LAI change from %s," |
| 1071 | " but checking previous VLR not implemented\n", |
Neels Hofmeyr | 379d579 | 2018-02-22 04:04:54 +0100 | [diff] [blame] | 1072 | osmo_lai_name(&lfp->old_lai)); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1073 | } |
| 1074 | |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1075 | /* If this is a TMSI based LU, we may not have the IMSI. Make sure that |
| 1076 | * we know the IMSI, either on record, or request it. */ |
| 1077 | if (!lfp->vsub->imsi[0]) |
| 1078 | vlr_loc_upd_want_imsi(fi); |
| 1079 | else |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1080 | vlr_loc_upd_node1_pre(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1081 | } |
| 1082 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1083 | static void lu_fsm_idle(struct osmo_fsm_inst *fi, uint32_t event, |
| 1084 | void *data) |
| 1085 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1086 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1087 | struct vlr_instance *vlr = lfp->vlr; |
| 1088 | |
| 1089 | OSMO_ASSERT(event == VLR_ULA_E_UPDATE_LA); |
| 1090 | |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1091 | if (_lu_fsm_associate_vsub(fi)) |
| 1092 | return; /* error. FSM already terminated. */ |
| 1093 | |
| 1094 | OSMO_ASSERT(lfp->vsub); |
| 1095 | |
Harald Welte | 0df904d | 2018-12-03 11:00:04 +0100 | [diff] [blame] | 1096 | /* At this point we know for which subscriber the location update is, |
| 1097 | * we now must inform SGs-UE FSM that we received a location update |
| 1098 | * via A, IU or Gs interface. */ |
| 1099 | osmo_fsm_inst_dispatch(lfp->vsub->sgs_fsm, SGS_UE_E_RX_LU_FROM_A_IU_GS, NULL); |
| 1100 | |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1101 | /* See 3GPP TS 23.012, procedure Retrieve_IMEISV_If_Required */ |
| 1102 | if ((!vlr->cfg.retrieve_imeisv_early) |
| 1103 | || (lfp->type == VLR_LU_TYPE_PERIODIC && lfp->vsub->imeisv[0])) { |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1104 | /* R_IMEISV_IR1 passed */ |
| 1105 | _start_lu_main(fi); |
| 1106 | } else { |
| 1107 | vlr->ops.tx_id_req(lfp->msc_conn_ref, GSM_MI_TYPE_IMEISV); |
| 1108 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_IMEISV, |
| 1109 | vlr_timer(vlr, 3270), 3270); |
| 1110 | } |
| 1111 | } |
| 1112 | |
| 1113 | static void lu_fsm_wait_imeisv(struct osmo_fsm_inst *fi, uint32_t event, |
| 1114 | void *data) |
| 1115 | { |
| 1116 | switch (event) { |
| 1117 | case VLR_ULA_E_ID_IMEISV: |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1118 | /* IMEISV was copied in vlr_subscr_rx_id_resp(), and that's |
| 1119 | * where we received this event from. */ |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1120 | _start_lu_main(fi); |
| 1121 | break; |
| 1122 | default: |
Oliver Smith | ffd522e | 2019-05-10 14:39:37 +0200 | [diff] [blame] | 1123 | OSMO_ASSERT(0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1124 | break; |
| 1125 | } |
| 1126 | } |
| 1127 | |
| 1128 | /* Wait for response from Send_Identification to PVLR */ |
| 1129 | static void lu_fsm_wait_pvlr(struct osmo_fsm_inst *fi, uint32_t event, |
| 1130 | void *data) |
| 1131 | { |
| 1132 | switch (event) { |
| 1133 | case VLR_ULA_E_SEND_ID_ACK: |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1134 | vlr_loc_upd_node1_pre(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1135 | break; |
| 1136 | case VLR_ULA_E_SEND_ID_NACK: |
| 1137 | vlr_loc_upd_want_imsi(fi); |
| 1138 | break; |
| 1139 | default: |
Oliver Smith | ffd522e | 2019-05-10 14:39:37 +0200 | [diff] [blame] | 1140 | OSMO_ASSERT(0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1141 | break; |
| 1142 | } |
| 1143 | } |
| 1144 | |
| 1145 | /* Wait for result of Authenticate_VLR procedure */ |
| 1146 | static void lu_fsm_wait_auth(struct osmo_fsm_inst *fi, uint32_t event, |
| 1147 | void *data) |
| 1148 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1149 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 1150 | enum gsm48_reject_value *res = data; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1151 | |
| 1152 | OSMO_ASSERT(event == VLR_ULA_E_AUTH_RES); |
| 1153 | |
| 1154 | lfp->upd_hlr_vlr_fsm = NULL; |
| 1155 | |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 1156 | if (!res || *res) { |
| 1157 | lu_fsm_failure(fi, res? *res : GSM48_REJECT_NETWORK_FAILURE); |
| 1158 | return; |
| 1159 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1160 | |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 1161 | /* Result == Pass */ |
| 1162 | vlr_loc_upd_post_auth(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1163 | } |
| 1164 | |
| 1165 | static void lu_fsm_wait_ciph(struct osmo_fsm_inst *fi, uint32_t event, |
| 1166 | void *data) |
| 1167 | { |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 1168 | enum vlr_ciph_result_cause result = VLR_CIPH_REJECT; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1169 | |
| 1170 | OSMO_ASSERT(event == VLR_ULA_E_CIPH_RES); |
| 1171 | |
| 1172 | if (!data) |
| 1173 | LOGPFSML(fi, LOGL_ERROR, "invalid ciphering result: NULL\n"); |
| 1174 | else |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 1175 | result = *(enum vlr_ciph_result_cause*)data; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1176 | |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 1177 | switch (result) { |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1178 | case VLR_CIPH_COMPL: |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 1179 | vlr_loc_upd_post_ciph(fi); |
| 1180 | return; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1181 | case VLR_CIPH_REJECT: |
| 1182 | LOGPFSM(fi, "ciphering rejected\n"); |
| 1183 | lu_fsm_failure(fi, GSM48_REJECT_INVALID_MANDANTORY_INF); |
| 1184 | return; |
| 1185 | default: |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 1186 | LOGPFSML(fi, LOGL_ERROR, "invalid ciphering result: %d\n", result); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1187 | lu_fsm_failure(fi, GSM48_REJECT_INVALID_MANDANTORY_INF); |
| 1188 | return; |
| 1189 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1190 | } |
| 1191 | |
| 1192 | static void lu_fsm_wait_imsi(struct osmo_fsm_inst *fi, uint32_t event, |
| 1193 | void *data) |
| 1194 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1195 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1196 | struct vlr_subscr *vsub = lfp->vsub; |
| 1197 | char *mi_string = data; |
| 1198 | |
| 1199 | switch (event) { |
| 1200 | case VLR_ULA_E_ID_IMSI: |
| 1201 | vlr_subscr_set_imsi(vsub, mi_string); |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1202 | vlr_loc_upd_node1_pre(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1203 | break; |
| 1204 | default: |
Oliver Smith | ffd522e | 2019-05-10 14:39:37 +0200 | [diff] [blame] | 1205 | OSMO_ASSERT(0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1206 | break; |
| 1207 | } |
| 1208 | } |
| 1209 | |
| 1210 | /* At the end of Update_HLR_VLR */ |
| 1211 | static void lu_fsm_wait_hlr_ul_res(struct osmo_fsm_inst *fi, uint32_t event, |
| 1212 | void *data) |
| 1213 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1214 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1215 | |
| 1216 | switch (event) { |
| 1217 | case VLR_ULA_E_HLR_LU_RES: |
| 1218 | /* pass-through this event to Update_HLR_VLR */ |
| 1219 | if (data == NULL) |
| 1220 | osmo_fsm_inst_dispatch(lfp->upd_hlr_vlr_fsm, UPD_HLR_VLR_E_UPD_LOC_ACK, NULL); |
| 1221 | else |
| 1222 | osmo_fsm_inst_dispatch(lfp->upd_hlr_vlr_fsm, UPD_HLR_VLR_E_UPD_LOC_NACK, data); |
| 1223 | break; |
| 1224 | case VLR_ULA_E_UPD_HLR_COMPL: |
| 1225 | if (data == NULL) { |
| 1226 | /* successful case */ |
| 1227 | osmo_fsm_inst_state_chg(fi, VLR_ULA_S_WAIT_LU_COMPL, |
| 1228 | LU_TIMEOUT_LONG, 0); |
| 1229 | vlr_loc_upd_start_lu_compl_fsm(fi); |
| 1230 | /* continue in MSC ?!? */ |
| 1231 | } else { |
| 1232 | /* unsuccessful case */ |
Neels Hofmeyr | dd2aeba | 2018-10-30 19:47:01 +0100 | [diff] [blame] | 1233 | enum gsm48_reject_value cause = |
| 1234 | *(enum gsm48_reject_value *)data; |
Neels Hofmeyr | ef9126c | 2017-07-18 15:38:39 +0200 | [diff] [blame] | 1235 | /* Ignoring standalone mode for now. */ |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1236 | if (0 /* procedure_error && vlr->cfg.standalone_mode */) { |
| 1237 | osmo_fsm_inst_state_chg(fi, |
| 1238 | VLR_ULA_S_WAIT_LU_COMPL_STANDALONE, |
| 1239 | LU_TIMEOUT_LONG, 0); |
| 1240 | vlr_loc_upd_start_lu_compl_fsm(fi); |
| 1241 | } else { |
| 1242 | lu_fsm_failure(fi, cause); |
| 1243 | } |
| 1244 | } |
| 1245 | break; |
| 1246 | default: |
Oliver Smith | ffd522e | 2019-05-10 14:39:37 +0200 | [diff] [blame] | 1247 | OSMO_ASSERT(0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1248 | break; |
| 1249 | } |
| 1250 | } |
| 1251 | |
| 1252 | /* Wait for end of Location_Update_Completion_VLR */ |
| 1253 | static void lu_fsm_wait_lu_compl(struct osmo_fsm_inst *fi, uint32_t event, |
| 1254 | void *data) |
| 1255 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1256 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1257 | uint8_t cause; |
| 1258 | |
| 1259 | switch (event) { |
| 1260 | case VLR_ULA_E_NEW_TMSI_ACK: |
| 1261 | osmo_fsm_inst_dispatch(lfp->lu_compl_vlr_fsm, |
| 1262 | LU_COMPL_VLR_E_NEW_TMSI_ACK, NULL); |
| 1263 | break; |
| 1264 | case VLR_ULA_E_ID_IMEI: |
Oliver Smith | 7d05309 | 2018-12-14 17:37:38 +0100 | [diff] [blame] | 1265 | /* Got the IMEI from ME, now send it to HLR */ |
| 1266 | vlr_subscr_tx_req_check_imei(lfp->vsub); |
| 1267 | break; |
| 1268 | case VLR_ULA_E_HLR_IMEI_ACK: |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1269 | osmo_fsm_inst_dispatch(lfp->lu_compl_vlr_fsm, |
| 1270 | LU_COMPL_VLR_E_IMEI_CHECK_ACK, NULL); |
| 1271 | break; |
Oliver Smith | 7d05309 | 2018-12-14 17:37:38 +0100 | [diff] [blame] | 1272 | case VLR_ULA_E_HLR_IMEI_NACK: |
| 1273 | osmo_fsm_inst_dispatch(lfp->lu_compl_vlr_fsm, |
| 1274 | LU_COMPL_VLR_E_IMEI_CHECK_NACK, NULL); |
| 1275 | break; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1276 | case VLR_ULA_E_LU_COMPL_SUCCESS: |
| 1277 | lu_fsm_discard_lu_compl_fsm(fi); |
| 1278 | |
| 1279 | /* Update Register */ |
| 1280 | /* TODO: Set_Notification_Type 23.078 */ |
| 1281 | /* TODO: Notify_gsmSCF 23.078 */ |
| 1282 | /* TODO: Authenticated Radio Contact Established -> ARC */ |
Stefan Sperling | 3a74128 | 2018-03-13 21:11:49 +0100 | [diff] [blame] | 1283 | |
| 1284 | if (lfp->type == VLR_LU_TYPE_IMSI_ATTACH) |
| 1285 | lfp->vlr->ops.tx_mm_info(lfp->msc_conn_ref); |
| 1286 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1287 | lu_fsm_success(fi); |
| 1288 | break; |
| 1289 | case VLR_ULA_E_LU_COMPL_FAILURE: |
| 1290 | cause = GSM48_REJECT_NETWORK_FAILURE; |
| 1291 | if (data) |
| 1292 | cause = *(uint8_t*)data; |
| 1293 | lu_fsm_discard_lu_compl_fsm(fi); |
| 1294 | lu_fsm_failure(fi, cause); |
| 1295 | break; |
| 1296 | default: |
Oliver Smith | ffd522e | 2019-05-10 14:39:37 +0200 | [diff] [blame] | 1297 | OSMO_ASSERT(0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1298 | break; |
| 1299 | } |
| 1300 | } |
| 1301 | |
| 1302 | /* Wait for end of Location_Update_Completion_VLR (standalone case) */ |
| 1303 | static void lu_fsm_wait_lu_compl_standalone(struct osmo_fsm_inst *fi, |
| 1304 | uint32_t event, void *data) |
| 1305 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1306 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1307 | struct vlr_subscr *vsub = lfp->vsub; |
| 1308 | uint8_t cause; |
| 1309 | |
| 1310 | switch (event) { |
| 1311 | case VLR_ULA_E_NEW_TMSI_ACK: |
| 1312 | osmo_fsm_inst_dispatch(lfp->lu_compl_vlr_fsm, |
| 1313 | LU_COMPL_VLR_E_NEW_TMSI_ACK, NULL); |
| 1314 | break; |
| 1315 | case VLR_ULA_E_LU_COMPL_SUCCESS: |
| 1316 | lu_fsm_discard_lu_compl_fsm(fi); |
| 1317 | vsub->sub_dataconf_by_hlr_ind = false; |
| 1318 | lu_fsm_success(fi); |
| 1319 | break; |
| 1320 | case VLR_ULA_E_LU_COMPL_FAILURE: |
| 1321 | vsub->sub_dataconf_by_hlr_ind = false; |
| 1322 | cause = GSM48_REJECT_NETWORK_FAILURE; |
| 1323 | if (data) |
| 1324 | cause = *(uint8_t*)data; |
| 1325 | lu_fsm_discard_lu_compl_fsm(fi); |
| 1326 | lu_fsm_failure(fi, cause); |
| 1327 | break; |
| 1328 | default: |
Oliver Smith | ffd522e | 2019-05-10 14:39:37 +0200 | [diff] [blame] | 1329 | OSMO_ASSERT(0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1330 | break; |
| 1331 | } |
| 1332 | } |
| 1333 | |
| 1334 | static const struct osmo_fsm_state vlr_lu_fsm_states[] = { |
| 1335 | [VLR_ULA_S_IDLE] = { |
| 1336 | .in_event_mask = S(VLR_ULA_E_UPDATE_LA), |
| 1337 | .out_state_mask = S(VLR_ULA_S_WAIT_IMEISV) | |
| 1338 | S(VLR_ULA_S_WAIT_PVLR) | |
| 1339 | S(VLR_ULA_S_WAIT_IMSI) | |
| 1340 | S(VLR_ULA_S_WAIT_AUTH) | |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 1341 | S(VLR_ULA_S_WAIT_CIPH) | |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1342 | S(VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY) | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1343 | S(VLR_ULA_S_WAIT_HLR_UPD) | |
| 1344 | S(VLR_ULA_S_DONE), |
| 1345 | .name = OSMO_STRINGIFY(VLR_ULA_S_IDLE), |
| 1346 | .action = lu_fsm_idle, |
| 1347 | }, |
| 1348 | [VLR_ULA_S_WAIT_IMEISV] = { |
| 1349 | .in_event_mask = S(VLR_ULA_E_ID_IMEISV), |
| 1350 | .out_state_mask = S(VLR_ULA_S_WAIT_PVLR) | |
| 1351 | S(VLR_ULA_S_WAIT_IMSI) | |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1352 | S(VLR_ULA_S_WAIT_AUTH) | |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 1353 | S(VLR_ULA_S_WAIT_CIPH) | |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1354 | S(VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY) | |
Neels Hofmeyr | 54a706c | 2017-07-18 15:39:27 +0200 | [diff] [blame] | 1355 | S(VLR_ULA_S_WAIT_HLR_UPD) | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1356 | S(VLR_ULA_S_DONE), |
| 1357 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_IMEISV), |
| 1358 | .action = lu_fsm_wait_imeisv, |
| 1359 | }, |
| 1360 | [VLR_ULA_S_WAIT_PVLR] = { |
| 1361 | .in_event_mask = S(VLR_ULA_E_SEND_ID_ACK) | |
| 1362 | S(VLR_ULA_E_SEND_ID_NACK), |
| 1363 | .out_state_mask = S(VLR_ULA_S_WAIT_IMSI) | |
| 1364 | S(VLR_ULA_S_WAIT_AUTH) | |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 1365 | S(VLR_ULA_S_WAIT_CIPH) | |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1366 | S(VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY) | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1367 | S(VLR_ULA_S_DONE), |
| 1368 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_PVLR), |
| 1369 | .action = lu_fsm_wait_pvlr, |
| 1370 | }, |
| 1371 | [VLR_ULA_S_WAIT_AUTH] = { |
| 1372 | .in_event_mask = S(VLR_ULA_E_AUTH_RES), |
| 1373 | .out_state_mask = S(VLR_ULA_S_WAIT_CIPH) | |
| 1374 | S(VLR_ULA_S_WAIT_LU_COMPL) | |
| 1375 | S(VLR_ULA_S_WAIT_HLR_UPD) | |
| 1376 | S(VLR_ULA_S_DONE), |
| 1377 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_AUTH), |
| 1378 | .action = lu_fsm_wait_auth, |
| 1379 | }, |
| 1380 | [VLR_ULA_S_WAIT_CIPH] = { |
| 1381 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_CIPH), |
| 1382 | .in_event_mask = S(VLR_ULA_E_CIPH_RES), |
| 1383 | .out_state_mask = S(VLR_ULA_S_WAIT_LU_COMPL) | |
| 1384 | S(VLR_ULA_S_WAIT_HLR_UPD) | |
| 1385 | S(VLR_ULA_S_DONE), |
| 1386 | .action = lu_fsm_wait_ciph, |
| 1387 | }, |
| 1388 | [VLR_ULA_S_WAIT_IMSI] = { |
| 1389 | .in_event_mask = S(VLR_ULA_E_ID_IMSI), |
| 1390 | .out_state_mask = S(VLR_ULA_S_WAIT_AUTH) | |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 1391 | S(VLR_ULA_S_WAIT_CIPH) | |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1392 | S(VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY) | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1393 | S(VLR_ULA_S_WAIT_HLR_UPD) | |
| 1394 | S(VLR_ULA_S_DONE), |
| 1395 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_IMSI), |
| 1396 | .action = lu_fsm_wait_imsi, |
| 1397 | }, |
Oliver Smith | cbf2c93 | 2019-05-06 13:09:55 +0200 | [diff] [blame] | 1398 | [VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY] = { |
| 1399 | .in_event_mask = S(VLR_ULA_E_HLR_IMEI_ACK) | |
| 1400 | S(VLR_ULA_E_HLR_IMEI_NACK), |
| 1401 | .out_state_mask = S(VLR_ULA_S_WAIT_AUTH) | |
| 1402 | S(VLR_ULA_S_WAIT_CIPH) | |
| 1403 | S(VLR_ULA_S_WAIT_HLR_UPD) | |
| 1404 | S(VLR_ULA_S_WAIT_LU_COMPL) | |
| 1405 | S(VLR_ULA_S_DONE), |
| 1406 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_HLR_CHECK_IMEI_EARLY), |
| 1407 | .action = lu_fsm_wait_hlr_check_imei_early, |
| 1408 | }, |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1409 | [VLR_ULA_S_WAIT_HLR_UPD] = { |
| 1410 | .in_event_mask = S(VLR_ULA_E_HLR_LU_RES) | |
| 1411 | S(VLR_ULA_E_UPD_HLR_COMPL), |
| 1412 | .out_state_mask = S(VLR_ULA_S_WAIT_LU_COMPL) | |
| 1413 | S(VLR_ULA_S_WAIT_LU_COMPL_STANDALONE) | |
| 1414 | S(VLR_ULA_S_DONE), |
| 1415 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_HLR_UPD), |
| 1416 | .action = lu_fsm_wait_hlr_ul_res, |
| 1417 | }, |
| 1418 | [VLR_ULA_S_WAIT_LU_COMPL] = { |
| 1419 | .in_event_mask = S(VLR_ULA_E_LU_COMPL_SUCCESS) | |
| 1420 | S(VLR_ULA_E_LU_COMPL_FAILURE) | |
| 1421 | S(VLR_ULA_E_NEW_TMSI_ACK) | |
| 1422 | S(VLR_ULA_E_ID_IMEI) | |
Oliver Smith | 7d05309 | 2018-12-14 17:37:38 +0100 | [diff] [blame] | 1423 | S(VLR_ULA_E_ID_IMEISV) | |
| 1424 | S(VLR_ULA_E_HLR_IMEI_ACK) | |
| 1425 | S(VLR_ULA_E_HLR_IMEI_NACK), |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1426 | .out_state_mask = S(VLR_ULA_S_DONE), |
| 1427 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_LU_COMPL), |
| 1428 | .action = lu_fsm_wait_lu_compl, |
| 1429 | }, |
| 1430 | [VLR_ULA_S_WAIT_LU_COMPL_STANDALONE] = { |
| 1431 | .in_event_mask = S(VLR_ULA_E_LU_COMPL_SUCCESS) | |
| 1432 | S(VLR_ULA_E_LU_COMPL_FAILURE) | |
| 1433 | S(VLR_ULA_E_NEW_TMSI_ACK), |
| 1434 | .out_state_mask = S(VLR_ULA_S_DONE), |
| 1435 | .name = OSMO_STRINGIFY(VLR_ULA_S_WAIT_LU_COMPL_STANDALONE), |
| 1436 | .action = lu_fsm_wait_lu_compl_standalone, |
| 1437 | }, |
| 1438 | [VLR_ULA_S_DONE] = { |
| 1439 | .name = OSMO_STRINGIFY(VLR_ULA_S_DONE), |
| 1440 | .onenter = lu_fsm_dispatch_result, |
| 1441 | }, |
| 1442 | }; |
| 1443 | |
| 1444 | static void fsm_lu_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) |
| 1445 | { |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1446 | struct lu_fsm_priv *lfp = lu_fsm_fi_priv(fi); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1447 | struct vlr_subscr *vsub = lfp->vsub; |
| 1448 | |
| 1449 | LOGPFSM(fi, "fsm_lu_cleanup called with cause %s\n", |
| 1450 | osmo_fsm_term_cause_name(cause)); |
| 1451 | if (vsub && vsub->lu_fsm == fi) |
| 1452 | vsub->lu_fsm = NULL; |
| 1453 | } |
| 1454 | |
| 1455 | static struct osmo_fsm vlr_lu_fsm = { |
| 1456 | .name = "vlr_lu_fsm", |
| 1457 | .states = vlr_lu_fsm_states, |
| 1458 | .num_states = ARRAY_SIZE(vlr_lu_fsm_states), |
| 1459 | .allstate_event_mask = 0, |
| 1460 | .allstate_action = NULL, |
| 1461 | .log_subsys = DVLR, |
| 1462 | .event_names = fsm_lu_event_names, |
| 1463 | .cleanup = fsm_lu_cleanup, |
| 1464 | }; |
| 1465 | |
Neels Hofmeyr | c5e0ace | 2018-03-02 03:12:22 +0100 | [diff] [blame] | 1466 | static inline struct lu_fsm_priv *lu_fsm_fi_priv(struct osmo_fsm_inst *fi) |
| 1467 | { |
| 1468 | OSMO_ASSERT(fi->fsm == &vlr_lu_fsm); |
| 1469 | return (struct lu_fsm_priv*)fi->priv; |
| 1470 | } |
| 1471 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1472 | struct osmo_fsm_inst * |
| 1473 | vlr_loc_update(struct osmo_fsm_inst *parent, |
| 1474 | uint32_t parent_event_success, |
| 1475 | uint32_t parent_event_failure, |
| 1476 | void *parent_event_data, |
| 1477 | struct vlr_instance *vlr, void *msc_conn_ref, |
| 1478 | enum vlr_lu_type type, uint32_t tmsi, const char *imsi, |
| 1479 | const struct osmo_location_area_id *old_lai, |
| 1480 | const struct osmo_location_area_id *new_lai, |
| 1481 | bool authentication_required, |
Harald Welte | 71c51df | 2017-12-23 18:51:48 +0100 | [diff] [blame] | 1482 | bool ciphering_required, |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 1483 | uint8_t key_seq, |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1484 | bool is_r99, bool is_utran, |
| 1485 | bool assign_tmsi) |
| 1486 | { |
| 1487 | struct osmo_fsm_inst *fi; |
| 1488 | struct lu_fsm_priv *lfp; |
| 1489 | |
| 1490 | fi = osmo_fsm_inst_alloc_child(&vlr_lu_fsm, parent, parent_event_failure); |
| 1491 | if (!fi) |
| 1492 | return NULL; |
| 1493 | |
| 1494 | lfp = talloc_zero(fi, struct lu_fsm_priv); |
| 1495 | lfp->vlr = vlr; |
| 1496 | lfp->msc_conn_ref = msc_conn_ref; |
| 1497 | lfp->tmsi = tmsi; |
| 1498 | lfp->type = type; |
| 1499 | lfp->old_lai = *old_lai; |
| 1500 | lfp->new_lai = *new_lai; |
| 1501 | lfp->lu_by_tmsi = true; |
| 1502 | lfp->parent_event_success = parent_event_success; |
| 1503 | lfp->parent_event_failure = parent_event_failure; |
| 1504 | lfp->parent_event_data = parent_event_data; |
| 1505 | lfp->authentication_required = authentication_required; |
| 1506 | lfp->ciphering_required = ciphering_required; |
Sylvain Munaut | da9f37e | 2019-03-14 11:02:36 +0100 | [diff] [blame] | 1507 | lfp->key_seq = key_seq; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1508 | lfp->is_r99 = is_r99; |
| 1509 | lfp->is_utran = is_utran; |
| 1510 | lfp->assign_tmsi = assign_tmsi; |
| 1511 | if (imsi) { |
| 1512 | strncpy(lfp->imsi, imsi, sizeof(lfp->imsi)-1); |
| 1513 | lfp->imsi[sizeof(lfp->imsi)-1] = '\0'; |
| 1514 | lfp->lu_by_tmsi = false; |
| 1515 | } |
| 1516 | fi->priv = lfp; |
| 1517 | |
| 1518 | LOGPFSM(fi, "rev=%s net=%s%s%s\n", |
| 1519 | is_r99 ? "R99" : "GSM", |
| 1520 | is_utran ? "UTRAN" : "GERAN", |
| 1521 | (authentication_required || ciphering_required)? |
| 1522 | " Auth" : " (no Auth)", |
| 1523 | (authentication_required || ciphering_required)? |
| 1524 | (ciphering_required? "+Ciph" : " (no Ciph)") |
| 1525 | : ""); |
| 1526 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 1527 | if (is_utran && !authentication_required) |
| 1528 | LOGPFSML(fi, LOGL_ERROR, |
| 1529 | "Authentication off on UTRAN network. Good luck.\n"); |
| 1530 | |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1531 | osmo_fsm_inst_dispatch(fi, VLR_ULA_E_UPDATE_LA, NULL); |
| 1532 | |
| 1533 | return fi; |
| 1534 | } |
| 1535 | |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 1536 | void vlr_loc_update_cancel(struct osmo_fsm_inst *fi, |
| 1537 | enum osmo_fsm_term_cause fsm_cause, |
| 1538 | uint8_t gsm48_cause) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1539 | { |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 1540 | struct lu_fsm_priv *lfp; |
| 1541 | |
| 1542 | OSMO_ASSERT(fi); |
| 1543 | OSMO_ASSERT(fi->fsm == &vlr_lu_fsm); |
| 1544 | |
| 1545 | lfp = fi->priv; |
| 1546 | lfp->rej_cause = gsm48_cause; |
| 1547 | |
| 1548 | if (fi->state != VLR_ULA_S_DONE) |
| 1549 | lu_fsm_failure(fi, gsm48_cause); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1550 | } |
| 1551 | |
| 1552 | void vlr_lu_fsm_init(void) |
| 1553 | { |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 1554 | OSMO_ASSERT(osmo_fsm_register(&vlr_lu_fsm) == 0); |
| 1555 | OSMO_ASSERT(osmo_fsm_register(&upd_hlr_vlr_fsm) == 0); |
| 1556 | OSMO_ASSERT(osmo_fsm_register(&sub_pres_vlr_fsm) == 0); |
| 1557 | OSMO_ASSERT(osmo_fsm_register(&lu_compl_vlr_fsm) == 0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 1558 | } |