Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 1 | /* MSC RAN connection implementation */ |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 2 | |
| 3 | /* |
Neels Hofmeyr | dbaab50 | 2018-11-30 00:45:07 +0100 | [diff] [blame] | 4 | * (C) 2016-2018 by sysmocom s.m.f.c. <info@sysmocom.de> |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 5 | * All Rights Reserved |
| 6 | * |
| 7 | * Author: Neels Hofmeyr |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU Affero General Public License as published by |
| 11 | * the Free Software Foundation; either version 3 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU Affero General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU Affero General Public License |
| 20 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 21 | * |
| 22 | */ |
| 23 | |
| 24 | #include <osmocom/core/logging.h> |
| 25 | #include <osmocom/core/fsm.h> |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 26 | #include <osmocom/core/signal.h> |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 27 | |
Neels Hofmeyr | a8945ce | 2018-11-30 00:44:32 +0100 | [diff] [blame] | 28 | #include <osmocom/msc/ran_conn.h> |
Neels Hofmeyr | 9084396 | 2017-09-04 15:04:35 +0200 | [diff] [blame] | 29 | #include <osmocom/msc/vlr.h> |
| 30 | #include <osmocom/msc/debug.h> |
| 31 | #include <osmocom/msc/transaction.h> |
| 32 | #include <osmocom/msc/signal.h> |
| 33 | #include <osmocom/msc/a_iface.h> |
Daniel Willmann | 4e825b6 | 2018-02-15 10:33:26 +0100 | [diff] [blame] | 34 | #include <osmocom/msc/iucs.h> |
Philipp Maier | fbf6610 | 2017-04-09 12:32:51 +0200 | [diff] [blame] | 35 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 36 | #include "../../bscconfig.h" |
| 37 | #ifdef BUILD_IU |
| 38 | #include <osmocom/ranap/iu_client.h> |
| 39 | #else |
| 40 | #include <osmocom/msc/iu_dummy.h> |
| 41 | #endif |
| 42 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 43 | #define RAN_CONN_TIMEOUT 5 /* seconds */ |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 44 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 45 | static const struct value_string ran_conn_fsm_event_names[] = { |
| 46 | OSMO_VALUE_STRING(RAN_CONN_E_COMPLETE_LAYER_3), |
| 47 | OSMO_VALUE_STRING(RAN_CONN_E_CLASSMARK_UPDATE), |
| 48 | OSMO_VALUE_STRING(RAN_CONN_E_ACCEPTED), |
| 49 | OSMO_VALUE_STRING(RAN_CONN_E_COMMUNICATING), |
| 50 | OSMO_VALUE_STRING(RAN_CONN_E_RELEASE_WHEN_UNUSED), |
| 51 | OSMO_VALUE_STRING(RAN_CONN_E_MO_CLOSE), |
| 52 | OSMO_VALUE_STRING(RAN_CONN_E_CN_CLOSE), |
| 53 | OSMO_VALUE_STRING(RAN_CONN_E_UNUSED), |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 54 | { 0, NULL } |
| 55 | }; |
| 56 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 57 | static void update_counters(struct osmo_fsm_inst *fi, bool conn_accepted) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 58 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 59 | struct ran_conn *conn = fi->priv; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 60 | switch (conn->complete_layer3_type) { |
| 61 | case COMPLETE_LAYER3_LU: |
| 62 | rate_ctr_inc(&conn->network->msc_ctrs->ctr[ |
| 63 | conn_accepted ? MSC_CTR_LOC_UPDATE_COMPLETED |
| 64 | : MSC_CTR_LOC_UPDATE_FAILED]); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 65 | break; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 66 | case COMPLETE_LAYER3_CM_SERVICE_REQ: |
| 67 | rate_ctr_inc(&conn->network->msc_ctrs->ctr[ |
| 68 | conn_accepted ? MSC_CTR_CM_SERVICE_REQUEST_ACCEPTED |
| 69 | : MSC_CTR_CM_SERVICE_REQUEST_REJECTED]); |
| 70 | break; |
| 71 | case COMPLETE_LAYER3_PAGING_RESP: |
| 72 | rate_ctr_inc(&conn->network->msc_ctrs->ctr[ |
| 73 | conn_accepted ? MSC_CTR_PAGING_RESP_ACCEPTED |
| 74 | : MSC_CTR_PAGING_RESP_REJECTED]); |
| 75 | break; |
| 76 | default: |
| 77 | break; |
| 78 | } |
| 79 | } |
| 80 | |
| 81 | static void evaluate_acceptance_outcome(struct osmo_fsm_inst *fi, bool conn_accepted) |
| 82 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 83 | struct ran_conn *conn = fi->priv; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 84 | |
| 85 | update_counters(fi, conn_accepted); |
| 86 | |
| 87 | /* Trigger transactions that we paged for */ |
| 88 | if (conn->complete_layer3_type == COMPLETE_LAYER3_PAGING_RESP) { |
| 89 | subscr_paging_dispatch(GSM_HOOK_RR_PAGING, |
| 90 | conn_accepted ? GSM_PAGING_SUCCEEDED : GSM_PAGING_EXPIRED, |
| 91 | NULL, conn, conn->vsub); |
| 92 | } |
| 93 | |
| 94 | if (conn->complete_layer3_type == COMPLETE_LAYER3_CM_SERVICE_REQ |
| 95 | && conn_accepted) { |
| 96 | conn->received_cm_service_request = true; |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 97 | ran_conn_get(conn, RAN_CONN_USE_CM_SERVICE); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | if (conn_accepted) |
| 101 | osmo_signal_dispatch(SS_SUBSCR, S_SUBSCR_ATTACHED, conn->vsub); |
| 102 | } |
| 103 | |
| 104 | static void log_close_event(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 105 | { |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 106 | enum gsm48_reject_value *cause = data; |
| 107 | /* The close event itself is logged by the FSM. We can only add the cause value, if present. */ |
| 108 | if (!cause || !*cause) |
| 109 | return; |
| 110 | LOGPFSML(fi, LOGL_NOTICE, "Close event, cause: %s\n", gsm48_reject_value_name(*cause)); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 111 | } |
| 112 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 113 | static void ran_conn_fsm_new(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 114 | { |
| 115 | switch (event) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 116 | case RAN_CONN_E_COMPLETE_LAYER_3: |
| 117 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_AUTH_CIPH, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 118 | return; |
| 119 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 120 | case RAN_CONN_E_ACCEPTED: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 121 | evaluate_acceptance_outcome(fi, true); |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 122 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_ACCEPTED, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 123 | return; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 124 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 125 | case RAN_CONN_E_MO_CLOSE: |
| 126 | case RAN_CONN_E_CN_CLOSE: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 127 | log_close_event(fi, event, data); |
| 128 | evaluate_acceptance_outcome(fi, false); |
| 129 | /* fall through */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 130 | case RAN_CONN_E_UNUSED: |
| 131 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_RELEASING, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 132 | return; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 133 | |
| 134 | default: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 135 | OSMO_ASSERT(false); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 136 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 137 | } |
| 138 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 139 | static void ran_conn_fsm_auth_ciph(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 140 | { |
| 141 | /* If accepted, transition the state, all other cases mean failure. */ |
| 142 | switch (event) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 143 | case RAN_CONN_E_ACCEPTED: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 144 | evaluate_acceptance_outcome(fi, true); |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 145 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_ACCEPTED, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 146 | return; |
| 147 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 148 | case RAN_CONN_E_UNUSED: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 149 | LOGPFSML(fi, LOGL_DEBUG, "Awaiting results for Auth+Ciph, overruling event %s\n", |
| 150 | osmo_fsm_event_name(fi->fsm, event)); |
| 151 | return; |
| 152 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 153 | case RAN_CONN_E_MO_CLOSE: |
| 154 | case RAN_CONN_E_CN_CLOSE: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 155 | log_close_event(fi, event, data); |
| 156 | evaluate_acceptance_outcome(fi, false); |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 157 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_RELEASING, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 158 | return; |
| 159 | |
| 160 | |
| 161 | default: |
| 162 | OSMO_ASSERT(false); |
| 163 | } |
| 164 | } |
| 165 | |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 166 | int ran_conn_classmark_request_then_cipher_mode_cmd(struct ran_conn *conn, bool umts_aka, |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 167 | bool retrieve_imeisv) |
| 168 | { |
| 169 | int rc; |
| 170 | conn->geran_set_cipher_mode.umts_aka = umts_aka; |
| 171 | conn->geran_set_cipher_mode.retrieve_imeisv = retrieve_imeisv; |
| 172 | |
| 173 | rc = a_iface_tx_classmark_request(conn); |
| 174 | if (rc) { |
| 175 | LOGP(DMM, LOGL_ERROR, "%s: cannot send BSSMAP Classmark Request\n", |
| 176 | vlr_subscr_name(conn->vsub)); |
| 177 | return -EIO; |
| 178 | } |
| 179 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 180 | osmo_fsm_inst_state_chg(conn->fi, RAN_CONN_S_WAIT_CLASSMARK_UPDATE, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 181 | return 0; |
| 182 | } |
| 183 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 184 | static void ran_conn_fsm_wait_classmark_update(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 185 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 186 | struct ran_conn *conn = fi->priv; |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 187 | switch (event) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 188 | case RAN_CONN_E_CLASSMARK_UPDATE: |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 189 | /* Theoretically, this event can be used for requesting Classmark in various situations. |
| 190 | * So far though, the only time we send a Classmark Request is during Ciphering. As soon |
| 191 | * as more such situations arise, we need to add state to indicate what action should |
| 192 | * follow after a Classmark Update is received (e.g. |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 193 | * ran_conn_classmark_request_then_cipher_mode_cmd() sets an enum value to indicate that |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 194 | * Ciphering should continue afterwards). But right now, it is accurate to always |
| 195 | * continue with Ciphering: */ |
| 196 | |
| 197 | /* During Ciphering, we needed Classmark information. The Classmark Update has come in, |
| 198 | * go back into the Set Ciphering Command procedure. */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 199 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_AUTH_CIPH, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 200 | if (ran_conn_geran_set_cipher_mode(conn, conn->geran_set_cipher_mode.umts_aka, |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 201 | conn->geran_set_cipher_mode.retrieve_imeisv)) { |
| 202 | LOGPFSML(fi, LOGL_ERROR, |
| 203 | "Sending Cipher Mode Command failed, aborting attach\n"); |
| 204 | vlr_subscr_cancel_attach_fsm(conn->vsub, OSMO_FSM_TERM_ERROR, |
| 205 | GSM48_REJECT_NETWORK_FAILURE); |
| 206 | } |
| 207 | return; |
| 208 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 209 | case RAN_CONN_E_UNUSED: |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 210 | LOGPFSML(fi, LOGL_DEBUG, "Awaiting results for Auth+Ciph, overruling event %s\n", |
| 211 | osmo_fsm_event_name(fi->fsm, event)); |
| 212 | return; |
| 213 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 214 | case RAN_CONN_E_MO_CLOSE: |
| 215 | case RAN_CONN_E_CN_CLOSE: |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 216 | log_close_event(fi, event, data); |
| 217 | evaluate_acceptance_outcome(fi, false); |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 218 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_RELEASING, RAN_CONN_TIMEOUT, 0); |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 219 | return; |
| 220 | |
| 221 | default: |
| 222 | OSMO_ASSERT(false); |
| 223 | } |
| 224 | } |
| 225 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 226 | static bool ran_conn_fsm_has_active_transactions(struct osmo_fsm_inst *fi) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 227 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 228 | struct ran_conn *conn = fi->priv; |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 229 | struct gsm_trans *trans; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 230 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 231 | if (conn->silent_call) { |
Neels Hofmeyr | e9e2f5c | 2018-03-15 13:26:43 +0100 | [diff] [blame] | 232 | LOGPFSML(fi, LOGL_DEBUG, "%s: silent call still active\n", __func__); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 233 | return true; |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 234 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 235 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 236 | if (conn->received_cm_service_request) { |
Neels Hofmeyr | e9e2f5c | 2018-03-15 13:26:43 +0100 | [diff] [blame] | 237 | LOGPFSML(fi, LOGL_DEBUG, "%s: still awaiting first request after a CM Service Request\n", |
| 238 | __func__); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 239 | return true; |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 240 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 241 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 242 | if (conn->vsub && !llist_empty(&conn->vsub->cs.requests)) { |
| 243 | struct subscr_request *sr; |
| 244 | if (!log_check_level(fi->fsm->log_subsys, LOGL_DEBUG)) { |
| 245 | llist_for_each_entry(sr, &conn->vsub->cs.requests, entry) { |
Neels Hofmeyr | e9e2f5c | 2018-03-15 13:26:43 +0100 | [diff] [blame] | 246 | LOGPFSML(fi, LOGL_DEBUG, "%s: still active: %s\n", |
| 247 | __func__, sr->label); |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 248 | } |
| 249 | } |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 250 | return true; |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 251 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 252 | |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 253 | if ((trans = trans_has_conn(conn))) { |
| 254 | LOGPFSML(fi, LOGL_DEBUG, |
Neels Hofmeyr | e9e2f5c | 2018-03-15 13:26:43 +0100 | [diff] [blame] | 255 | "%s: connection still has active transaction: %s\n", |
| 256 | __func__, gsm48_pdisc_name(trans->protocol)); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 257 | return true; |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 258 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 259 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 260 | return false; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 261 | } |
| 262 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 263 | static void ran_conn_fsm_accepted_enter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 264 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 265 | struct ran_conn *conn = fi->priv; |
Stefan Sperling | defc3c8 | 2018-05-15 14:48:04 +0200 | [diff] [blame] | 266 | |
| 267 | /* Stop Location Update expiry for this subscriber. While the subscriber |
| 268 | * has an open connection the LU expiry timer must remain disabled. |
| 269 | * Otherwise we would kick the subscriber off the network when the timer |
| 270 | * expires e.g. during a long phone call. |
| 271 | * The LU expiry timer will restart once the connection is closed. */ |
| 272 | conn->vsub->expire_lu = VLR_SUBSCRIBER_NO_EXPIRATION; |
| 273 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 274 | if (!ran_conn_fsm_has_active_transactions(fi)) |
| 275 | osmo_fsm_inst_dispatch(fi, RAN_CONN_E_UNUSED, NULL); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 276 | } |
| 277 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 278 | static void ran_conn_fsm_accepted(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 279 | { |
| 280 | switch (event) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 281 | case RAN_CONN_E_COMPLETE_LAYER_3: |
Neels Hofmeyr | 36115c9 | 2018-08-23 15:52:43 +0200 | [diff] [blame] | 282 | /* When Authentication is off, we may already be in the Accepted state when the code |
| 283 | * evaluates the Compl L3. Simply ignore. This just cosmetically mutes the error log |
| 284 | * about the useless event. */ |
| 285 | return; |
| 286 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 287 | case RAN_CONN_E_COMMUNICATING: |
| 288 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_COMMUNICATING, 0, 0); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 289 | return; |
| 290 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 291 | case RAN_CONN_E_MO_CLOSE: |
| 292 | case RAN_CONN_E_CN_CLOSE: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 293 | log_close_event(fi, event, data); |
| 294 | /* fall through */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 295 | case RAN_CONN_E_UNUSED: |
| 296 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_RELEASING, RAN_CONN_TIMEOUT, 0); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 297 | return; |
| 298 | |
| 299 | default: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 300 | OSMO_ASSERT(false); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 301 | } |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 302 | } |
| 303 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 304 | static void ran_conn_fsm_communicating(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 305 | { |
| 306 | switch (event) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 307 | case RAN_CONN_E_COMMUNICATING: |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 308 | /* no-op */ |
| 309 | return; |
| 310 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 311 | case RAN_CONN_E_MO_CLOSE: |
| 312 | case RAN_CONN_E_CN_CLOSE: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 313 | log_close_event(fi, event, data); |
| 314 | /* fall through */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 315 | case RAN_CONN_E_UNUSED: |
| 316 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_RELEASING, RAN_CONN_TIMEOUT, 0); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 317 | return; |
| 318 | |
| 319 | default: |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 320 | OSMO_ASSERT(false); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 321 | } |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 322 | } |
| 323 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 324 | static int ran_conn_fsm_timeout(struct osmo_fsm_inst *fi) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 325 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 326 | struct ran_conn *conn = fi->priv; |
| 327 | if (ran_conn_in_release(conn)) { |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 328 | LOGPFSML(fi, LOGL_ERROR, "Timeout while releasing, discarding right now\n"); |
| 329 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_TIMEOUT, NULL); |
| 330 | } else { |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 331 | enum gsm48_reject_value cause = GSM48_REJECT_CONGESTION; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 332 | osmo_fsm_inst_dispatch(fi, RAN_CONN_E_CN_CLOSE, &cause); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 333 | } |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 334 | return 0; |
| 335 | } |
| 336 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 337 | static void ran_conn_fsm_releasing_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 338 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 339 | struct ran_conn *conn = fi->priv; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 340 | |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 341 | /* Use count for either conn->a.waiting_for_clear_complete or |
| 342 | * conn->iu.waiting_for_release_complete. 'get' it early, so we don't deallocate after tearing |
| 343 | * down active transactions. Safeguard against double-get (though it shouldn't happen). */ |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 344 | if (!ran_conn_used_by(conn, RAN_CONN_USE_RELEASE)) |
| 345 | ran_conn_get(conn, RAN_CONN_USE_RELEASE); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 346 | |
| 347 | /* Cancel pending CM Service Requests */ |
| 348 | if (conn->received_cm_service_request) { |
| 349 | conn->received_cm_service_request = false; |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 350 | ran_conn_put(conn, RAN_CONN_USE_CM_SERVICE); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 351 | } |
| 352 | |
| 353 | /* Cancel all VLR FSMs, if any */ |
Neels Hofmeyr | 1580959 | 2018-04-06 02:57:51 +0200 | [diff] [blame] | 354 | vlr_subscr_cancel_attach_fsm(conn->vsub, OSMO_FSM_TERM_ERROR, GSM48_REJECT_CONGESTION); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 355 | |
Stefan Sperling | defc3c8 | 2018-05-15 14:48:04 +0200 | [diff] [blame] | 356 | if (conn->vsub) { |
| 357 | /* The subscriber has no active connection anymore. |
| 358 | * Restart the periodic Location Update expiry timer for this subscriber. */ |
| 359 | vlr_subscr_enable_expire_lu(conn->vsub); |
| 360 | } |
| 361 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 362 | /* If we're closing in a middle of a trans, we need to clean up */ |
| 363 | trans_conn_closed(conn); |
| 364 | |
| 365 | switch (conn->via_ran) { |
| 366 | case RAN_GERAN_A: |
| 367 | a_iface_tx_clear_cmd(conn); |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 368 | if (conn->a.waiting_for_clear_complete) { |
| 369 | LOGPFSML(fi, LOGL_ERROR, |
| 370 | "Unexpected: conn is already waiting for BSSMAP Clear Complete\n"); |
| 371 | break; |
| 372 | } |
| 373 | conn->a.waiting_for_clear_complete = true; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 374 | break; |
| 375 | case RAN_UTRAN_IU: |
| 376 | ranap_iu_tx_release(conn->iu.ue_ctx, NULL); |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 377 | if (conn->iu.waiting_for_release_complete) { |
| 378 | LOGPFSML(fi, LOGL_ERROR, |
| 379 | "Unexpected: conn is already waiting for Iu Release Complete\n"); |
| 380 | break; |
| 381 | } |
| 382 | conn->iu.waiting_for_release_complete = true; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 383 | break; |
| 384 | default: |
| 385 | LOGP(DMM, LOGL_ERROR, "%s: Unknown RAN type, cannot tx release/clear\n", |
| 386 | vlr_subscr_name(conn->vsub)); |
| 387 | break; |
| 388 | } |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 389 | } |
| 390 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 391 | static void ran_conn_fsm_releasing(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 392 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 393 | OSMO_ASSERT(event == RAN_CONN_E_UNUSED); |
| 394 | osmo_fsm_inst_state_chg(fi, RAN_CONN_S_RELEASED, 0, 0); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 395 | } |
| 396 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 397 | static void ran_conn_fsm_released(struct osmo_fsm_inst *fi, uint32_t prev_state) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 398 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 399 | /* Terminate, deallocate and also deallocate the ran_conn, which is allocated as |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 400 | * a talloc child of fi. Also calls the cleanup function. */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 401 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | #define S(x) (1 << (x)) |
| 405 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 406 | static const struct osmo_fsm_state ran_conn_fsm_states[] = { |
| 407 | [RAN_CONN_S_NEW] = { |
| 408 | .name = OSMO_STRINGIFY(RAN_CONN_S_NEW), |
| 409 | .in_event_mask = S(RAN_CONN_E_COMPLETE_LAYER_3) | |
| 410 | S(RAN_CONN_E_ACCEPTED) | |
| 411 | S(RAN_CONN_E_MO_CLOSE) | |
| 412 | S(RAN_CONN_E_CN_CLOSE) | |
| 413 | S(RAN_CONN_E_UNUSED), |
| 414 | .out_state_mask = S(RAN_CONN_S_AUTH_CIPH) | |
| 415 | S(RAN_CONN_S_ACCEPTED) | |
| 416 | S(RAN_CONN_S_RELEASING), |
| 417 | .action = ran_conn_fsm_new, |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 418 | }, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 419 | [RAN_CONN_S_AUTH_CIPH] = { |
| 420 | .name = OSMO_STRINGIFY(RAN_CONN_S_AUTH_CIPH), |
| 421 | .in_event_mask = S(RAN_CONN_E_ACCEPTED) | |
| 422 | S(RAN_CONN_E_MO_CLOSE) | |
| 423 | S(RAN_CONN_E_CN_CLOSE) | |
| 424 | S(RAN_CONN_E_UNUSED), |
| 425 | .out_state_mask = S(RAN_CONN_S_WAIT_CLASSMARK_UPDATE) | |
| 426 | S(RAN_CONN_S_ACCEPTED) | |
| 427 | S(RAN_CONN_S_RELEASING), |
| 428 | .action = ran_conn_fsm_auth_ciph, |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 429 | }, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 430 | [RAN_CONN_S_WAIT_CLASSMARK_UPDATE] = { |
| 431 | .name = OSMO_STRINGIFY(RAN_CONN_S_WAIT_CLASSMARK_UPDATE), |
| 432 | .in_event_mask = S(RAN_CONN_E_CLASSMARK_UPDATE) | |
| 433 | S(RAN_CONN_E_MO_CLOSE) | |
| 434 | S(RAN_CONN_E_CN_CLOSE) | |
| 435 | S(RAN_CONN_E_UNUSED), |
| 436 | .out_state_mask = S(RAN_CONN_S_AUTH_CIPH) | |
| 437 | S(RAN_CONN_S_RELEASING), |
| 438 | .action = ran_conn_fsm_wait_classmark_update, |
Neels Hofmeyr | 3117b70 | 2018-09-13 03:23:07 +0200 | [diff] [blame] | 439 | }, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 440 | [RAN_CONN_S_ACCEPTED] = { |
| 441 | .name = OSMO_STRINGIFY(RAN_CONN_S_ACCEPTED), |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 442 | /* allow everything to release for any odd behavior */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 443 | .in_event_mask = S(RAN_CONN_E_COMPLETE_LAYER_3) | |
| 444 | S(RAN_CONN_E_COMMUNICATING) | |
| 445 | S(RAN_CONN_E_RELEASE_WHEN_UNUSED) | |
| 446 | S(RAN_CONN_E_ACCEPTED) | |
| 447 | S(RAN_CONN_E_MO_CLOSE) | |
| 448 | S(RAN_CONN_E_CN_CLOSE) | |
| 449 | S(RAN_CONN_E_UNUSED), |
| 450 | .out_state_mask = S(RAN_CONN_S_RELEASING) | |
| 451 | S(RAN_CONN_S_COMMUNICATING), |
| 452 | .onenter = ran_conn_fsm_accepted_enter, |
| 453 | .action = ran_conn_fsm_accepted, |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 454 | }, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 455 | [RAN_CONN_S_COMMUNICATING] = { |
| 456 | .name = OSMO_STRINGIFY(RAN_CONN_S_COMMUNICATING), |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 457 | /* allow everything to release for any odd behavior */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 458 | .in_event_mask = S(RAN_CONN_E_RELEASE_WHEN_UNUSED) | |
| 459 | S(RAN_CONN_E_ACCEPTED) | |
| 460 | S(RAN_CONN_E_COMMUNICATING) | |
| 461 | S(RAN_CONN_E_MO_CLOSE) | |
| 462 | S(RAN_CONN_E_CN_CLOSE) | |
| 463 | S(RAN_CONN_E_UNUSED), |
| 464 | .out_state_mask = S(RAN_CONN_S_RELEASING), |
| 465 | .action = ran_conn_fsm_communicating, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 466 | }, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 467 | [RAN_CONN_S_RELEASING] = { |
| 468 | .name = OSMO_STRINGIFY(RAN_CONN_S_RELEASING), |
| 469 | .in_event_mask = S(RAN_CONN_E_UNUSED), |
| 470 | .out_state_mask = S(RAN_CONN_S_RELEASED), |
| 471 | .onenter = ran_conn_fsm_releasing_onenter, |
| 472 | .action = ran_conn_fsm_releasing, |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 473 | }, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 474 | [RAN_CONN_S_RELEASED] = { |
| 475 | .name = OSMO_STRINGIFY(RAN_CONN_S_RELEASED), |
| 476 | .onenter = ran_conn_fsm_released, |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 477 | }, |
| 478 | }; |
| 479 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 480 | static void ran_conn_fsm_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 481 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 482 | static struct osmo_fsm ran_conn_fsm = { |
| 483 | .name = "RAN_conn", |
| 484 | .states = ran_conn_fsm_states, |
| 485 | .num_states = ARRAY_SIZE(ran_conn_fsm_states), |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 486 | .allstate_event_mask = 0, |
| 487 | .allstate_action = NULL, |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 488 | .log_subsys = DMM, |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 489 | .event_names = ran_conn_fsm_event_names, |
| 490 | .cleanup = ran_conn_fsm_cleanup, |
| 491 | .timer_cb = ran_conn_fsm_timeout, |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 492 | }; |
| 493 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 494 | char *ran_conn_get_conn_id(struct ran_conn *conn) |
Daniel Willmann | 4e825b6 | 2018-02-15 10:33:26 +0100 | [diff] [blame] | 495 | { |
| 496 | char *id; |
| 497 | |
| 498 | switch (conn->via_ran) { |
| 499 | case RAN_GERAN_A: |
| 500 | id = talloc_asprintf(conn, "GERAN_A-%08x", conn->a.conn_id); |
| 501 | break; |
| 502 | case RAN_UTRAN_IU: |
| 503 | id = talloc_asprintf(conn, "UTRAN_IU-%08x", iu_get_conn_id(conn->iu.ue_ctx)); |
| 504 | break; |
| 505 | default: |
| 506 | LOGP(DMM, LOGL_ERROR, "RAN of conn %p unknown!\n", conn); |
| 507 | return NULL; |
| 508 | } |
| 509 | |
| 510 | return id; |
| 511 | } |
| 512 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 513 | /* Tidy up before the FSM deallocates */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 514 | static void ran_conn_fsm_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 515 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 516 | struct ran_conn *conn = fi->priv; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 517 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 518 | if (ran_conn_fsm_has_active_transactions(fi)) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 519 | LOGPFSML(fi, LOGL_ERROR, "Deallocating despite active transactions\n"); |
| 520 | |
| 521 | if (!conn) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 522 | LOGP(DRLL, LOGL_ERROR, "Freeing NULL RAN connection\n"); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 523 | return; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 524 | } |
| 525 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 526 | if (conn->vsub) { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 527 | DEBUGP(DRLL, "%s: Freeing RAN connection\n", vlr_subscr_name(conn->vsub)); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 528 | conn->vsub->lu_fsm = NULL; |
| 529 | conn->vsub->msc_conn_ref = NULL; |
| 530 | vlr_subscr_put(conn->vsub); |
| 531 | conn->vsub = NULL; |
| 532 | } else |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 533 | DEBUGP(DRLL, "Freeing RAN connection with NULL subscriber\n"); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 534 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 535 | llist_del(&conn->entry); |
| 536 | } |
| 537 | |
| 538 | /* Signal success of Complete Layer 3. Allow to keep the conn open for Auth and Ciph. */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 539 | void ran_conn_complete_layer_3(struct ran_conn *conn) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 540 | { |
| 541 | if (!conn) |
| 542 | return; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 543 | osmo_fsm_inst_dispatch(conn->fi, RAN_CONN_E_COMPLETE_LAYER_3, NULL); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 544 | } |
| 545 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 546 | void ran_conn_release_when_unused(struct ran_conn *conn) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 547 | { |
| 548 | if (!conn) |
| 549 | return; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 550 | if (ran_conn_in_release(conn)) { |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 551 | DEBUGP(DMM, "%s: %s: conn already in release (%s)\n", |
| 552 | vlr_subscr_name(conn->vsub), __func__, |
| 553 | osmo_fsm_inst_state_name(conn->fi)); |
| 554 | return; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 555 | } |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 556 | if (conn->fi->state == RAN_CONN_S_NEW) { |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 557 | DEBUGP(DMM, "%s: %s: conn still being established (%s)\n", |
| 558 | vlr_subscr_name(conn->vsub), __func__, |
| 559 | osmo_fsm_inst_state_name(conn->fi)); |
| 560 | return; |
| 561 | } |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 562 | osmo_fsm_inst_dispatch(conn->fi, RAN_CONN_E_RELEASE_WHEN_UNUSED, NULL); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 563 | } |
| 564 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 565 | static void conn_close(struct ran_conn *conn, uint32_t cause, uint32_t event) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 566 | { |
| 567 | if (!conn) { |
| 568 | LOGP(DMM, LOGL_ERROR, "Cannot release NULL connection\n"); |
| 569 | return; |
| 570 | } |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 571 | if (ran_conn_in_release(conn)) { |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 572 | DEBUGP(DMM, "%s(vsub=%s, cause=%u): already in release, ignore.\n", |
| 573 | __func__, vlr_subscr_name(conn->vsub), cause); |
| 574 | return; |
| 575 | } |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 576 | osmo_fsm_inst_dispatch(conn->fi, event, &cause); |
| 577 | } |
| 578 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 579 | void ran_conn_close(struct ran_conn *conn, uint32_t cause) |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 580 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 581 | return conn_close(conn, cause, RAN_CONN_E_CN_CLOSE); |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 582 | } |
| 583 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 584 | void ran_conn_mo_close(struct ran_conn *conn, uint32_t cause) |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 585 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 586 | return conn_close(conn, cause, RAN_CONN_E_MO_CLOSE); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 587 | } |
| 588 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 589 | bool ran_conn_in_release(struct ran_conn *conn) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 590 | { |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 591 | if (!conn || !conn->fi) |
| 592 | return true; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 593 | if (conn->fi->state == RAN_CONN_S_RELEASING) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 594 | return true; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 595 | if (conn->fi->state == RAN_CONN_S_RELEASED) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 596 | return true; |
| 597 | return false; |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 598 | } |
| 599 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 600 | bool ran_conn_is_accepted(const struct ran_conn *conn) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 601 | { |
| 602 | if (!conn) |
| 603 | return false; |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 604 | if (!conn->vsub) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 605 | return false; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 606 | if (!(conn->fi->state == RAN_CONN_S_ACCEPTED |
| 607 | || conn->fi->state == RAN_CONN_S_COMMUNICATING)) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 608 | return false; |
| 609 | return true; |
| 610 | } |
| 611 | |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 612 | /* Indicate that *some* communication is happening with the phone, so that the conn FSM no longer times |
| 613 | * out to release within a few seconds. */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 614 | void ran_conn_communicating(struct ran_conn *conn) |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 615 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 616 | osmo_fsm_inst_dispatch(conn->fi, RAN_CONN_E_COMMUNICATING, NULL); |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 617 | } |
| 618 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 619 | void ran_conn_init(void) |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 620 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 621 | osmo_fsm_register(&ran_conn_fsm); |
Harald Welte | b8b85a1 | 2016-06-17 00:06:42 +0200 | [diff] [blame] | 622 | } |
Neels Hofmeyr | 16c42b5 | 2018-04-02 12:26:16 +0200 | [diff] [blame] | 623 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 624 | /* Allocate a new RAN conn and FSM. |
| 625 | * Deallocation is by ran_conn_put(): when the use count reaches zero, the |
| 626 | * RAN_CONN_E_RELEASE_COMPLETE event is dispatched, the FSM terminates and deallocates both FSM and |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 627 | * conn. As long as the FSM is waiting for responses from the subscriber, it will itself hold a use count |
| 628 | * on the conn. */ |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 629 | struct ran_conn *ran_conn_alloc(struct gsm_network *network, |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 630 | enum ran_type via_ran, uint16_t lac) |
| 631 | { |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 632 | struct ran_conn *conn; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 633 | struct osmo_fsm_inst *fi; |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 634 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 635 | fi = osmo_fsm_inst_alloc(&ran_conn_fsm, network, NULL, LOGL_DEBUG, NULL); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 636 | if (!fi) { |
| 637 | LOGP(DMM, LOGL_ERROR, "Failed to allocate conn FSM\n"); |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 638 | return NULL; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 639 | } |
| 640 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 641 | conn = talloc_zero(fi, struct ran_conn); |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 642 | if (!conn) { |
| 643 | osmo_fsm_inst_free(fi); |
| 644 | return NULL; |
| 645 | } |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 646 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 647 | *conn = (struct ran_conn){ |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 648 | .network = network, |
| 649 | .via_ran = via_ran, |
| 650 | .lac = lac, |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 651 | .fi = fi, |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 652 | }; |
| 653 | |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 654 | fi->priv = conn; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 655 | llist_add_tail(&conn->entry, &network->ran_conns); |
Neels Hofmeyr | 93c7463 | 2018-04-02 23:10:28 +0200 | [diff] [blame] | 656 | return conn; |
| 657 | } |
| 658 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 659 | bool ran_conn_is_establishing_auth_ciph(const struct ran_conn *conn) |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 660 | { |
| 661 | if (!conn) |
| 662 | return false; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 663 | return conn->fi->state == RAN_CONN_S_AUTH_CIPH; |
Neels Hofmeyr | e3d3dc6 | 2018-03-31 00:02:14 +0200 | [diff] [blame] | 664 | } |
| 665 | |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 666 | |
Neels Hofmeyr | 16c42b5 | 2018-04-02 12:26:16 +0200 | [diff] [blame] | 667 | const struct value_string complete_layer3_type_names[] = { |
| 668 | { COMPLETE_LAYER3_NONE, "NONE" }, |
| 669 | { COMPLETE_LAYER3_LU, "LU" }, |
| 670 | { COMPLETE_LAYER3_CM_SERVICE_REQ, "CM_SERVICE_REQ" }, |
| 671 | { COMPLETE_LAYER3_PAGING_RESP, "PAGING_RESP" }, |
| 672 | { 0, NULL } |
| 673 | }; |
| 674 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 675 | void ran_conn_update_id(struct ran_conn *conn, |
Neels Hofmeyr | 16c42b5 | 2018-04-02 12:26:16 +0200 | [diff] [blame] | 676 | enum complete_layer3_type from, const char *id) |
| 677 | { |
| 678 | conn->complete_layer3_type = from; |
Neels Hofmeyr | fe4ba7c | 2018-04-02 23:17:50 +0200 | [diff] [blame] | 679 | osmo_fsm_inst_update_id_f(conn->fi, "%s:%s", complete_layer3_type_name(from), id); |
| 680 | LOGPFSML(conn->fi, LOGL_DEBUG, "Updated ID\n"); |
Neels Hofmeyr | 16c42b5 | 2018-04-02 12:26:16 +0200 | [diff] [blame] | 681 | } |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 682 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 683 | static void rx_close_complete(struct ran_conn *conn, const char *label, bool *flag) |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 684 | { |
| 685 | if (!conn) |
| 686 | return; |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 687 | if (!ran_conn_in_release(conn)) { |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 688 | LOGPFSML(conn->fi, LOGL_ERROR, "Received unexpected %s, discarding right now\n", |
| 689 | label); |
| 690 | trans_conn_closed(conn); |
| 691 | osmo_fsm_inst_term(conn->fi, OSMO_FSM_TERM_ERROR, NULL); |
| 692 | return; |
| 693 | } |
| 694 | if (*flag) { |
| 695 | *flag = false; |
Neels Hofmeyr | 3c20a5e | 2018-11-30 01:08:36 +0100 | [diff] [blame] | 696 | ran_conn_put(conn, RAN_CONN_USE_RELEASE); |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 697 | } |
| 698 | } |
| 699 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 700 | void ran_conn_rx_bssmap_clear_complete(struct ran_conn *conn) |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 701 | { |
| 702 | rx_close_complete(conn, "BSSMAP Clear Complete", &conn->a.waiting_for_clear_complete); |
| 703 | } |
| 704 | |
Neels Hofmeyr | c036b79 | 2018-11-29 22:37:51 +0100 | [diff] [blame] | 705 | void ran_conn_rx_iu_release_complete(struct ran_conn *conn) |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 706 | { |
| 707 | rx_close_complete(conn, "Iu Release Complete", &conn->iu.waiting_for_release_complete); |
| 708 | } |