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